enginemongo

type BaseCRUD[T any, ID comparable] struct {
	Collection *mongo.Collection

	r3.DefaultsManager

	Meta   StructMeta
	Config r3.Config
	Raw    *BaseRaw[T, ID]
}

type BaseRaw[T any, ID any] struct {
	Collection *mongo.Collection
	Meta       StructMeta
}

type PreparedListQuery struct {
	// Filter is the combined BSON filter document.
	Filter bson.D

	// Sort is the BSON sort document.
	Sort bson.D

	// Projection is the BSON projection document (field selection).
	Projection bson.D

	// IsPaginated indicates whether offset-based pagination is active.
	IsPaginated bool

	// Limit and Offset (skip) are set when IsPaginated is true.
	Limit  int64
	Offset int64

	// IsCursorPaginated indicates whether cursor/keyset pagination is active.
	// When true, CursorFilter contains the keyset filter and CursorLimit
	// contains the LIMIT. No skip or count query should be used.
	IsCursorPaginated bool

	// CursorFilter is the keyset filter (may be empty for the first page).
	CursorFilter bson.D

	// CursorLimit is the maximum number of results for cursor pagination.
	CursorLimit int64

	// Query is the merged r3.Query (defaults + user args) for access to
	// Preloads, IncludeTrashed, and other fields.
	Query r3.Query
}

type RelationKind = r3tag.RelationKind

type RelationMeta struct {
	FieldName  string       // Go struct field name (matched against PreloadSpec.Name)
	FieldIndex int          // struct field index for reflection-based assignment
	Kind       RelationKind // has-many or belongs-to
	FKField    string       // foreign key field name (BSON field name on the "many" side)
	TargetMeta StructMeta   // metadata for the related entity type
	TargetType reflect.Type // reflect.Type of the target entity (element type, not slice/ptr)
}

type StructMeta struct {
	CollectionName string   // e.g. "cities"
	Fields         []string // BSON field names in order, e.g. ["_id", "name", "country_name", ...]
	FieldIndices   []int    // corresponding struct field indices for each BSON field
	IDField        string   // primary key BSON field name (defaults to "_id")
	IDFieldIdx     int      // index into Fields/FieldIndices for the ID entry

	// SoftDeleteField is the BSON field name used for soft-delete (e.g. "deleted_at").
	// Empty string means soft-delete is not enabled.
	SoftDeleteField string

	// SoftDeleteZero is the zero value of the soft-delete field when it is a
	// non-pointer type. A live (never-deleted) record stores this zero value
	// rather than null — a non-pointer time.Time persists as the zero BSON Date,
	// not as null — so the "not deleted" filter must match it as well as null.
	// Nil when the field is a pointer (live records store null) or when
	// soft-delete is disabled.
	SoftDeleteZero any

	// Relations holds metadata about related entities.
	Relations []RelationMeta
}