@classytic/mongokit 3.38.1 → 3.39.0

package/dist/core-62oo3N1C.d.mts

@@ -1,50 +0,0 @@
-import { Document, Model, PopulateOptions, Types } from "mongoose";
-//#region src/types/core.d.ts
-/**
- * Core query/document primitives shared across every mongokit module —
- * sort/select/populate/filter specs and the mongoose-facing aliases.
- *
- * Also the home of the `softRequired` Mongoose declaration merge (this file
- * is loaded by every module, so the augmentation is always in the program).
- */
-/**
- * Global declaration merge: adds `softRequired` to Mongoose's SchemaTypeOptions
- * so consumers can annotate paths type-safely without importing anything.
- *
- * A path with `softRequired: true` keeps its DB-level `required: true`
- * invariant but is excluded from the auto-generated CRUD body `required[]`
- * array (see buildCrudSchemasFromModel).
- */
-declare module 'mongoose' {
-  interface SchemaTypeOptions<T, EnforcedDocType = any, THydratedDocumentType = HydratedDocument<EnforcedDocType>> {
-    /** mongokit: omit from auto-generated CRUD body `required` array. */
-    softRequired?: boolean;
-  }
-}
-/** Read Preference Type for replica sets */
-type ReadPreferenceType = 'primary' | 'primaryPreferred' | 'secondary' | 'secondaryPreferred' | 'nearest' | (string & {});
-/** Re-export mongoose ObjectId */
-type ObjectId = Types.ObjectId;
-/** Generic document type */
-type AnyDocument = Document & Record<string, unknown>;
-/** Generic model type */
-type AnyModel = Model<AnyDocument>;
-/** Sort direction */
-type SortDirection = 1 | -1;
-/** Sort specification for MongoDB queries */
-type SortSpec = Record<string, SortDirection>;
-/** Populate specification */
-type PopulateSpec = string | string[] | PopulateOptions | PopulateOptions[];
-/**
- * Select specification. `readonly string[]` widens the legacy `string[]`
- * form to also accept the immutable variant repo-core's contract uses
- * (`LookupPopulateOptions.select: readonly string[] | Record<string, 0
- * | 1>`), so `Repository<TDoc>` assigns to `StandardRepo<TDoc>` without
- * TS2322 on the `select` field. Any existing mutable-array caller stays
- * compatible — `string[]` is assignable to `readonly string[]`.
- */
-type SelectSpec = string | readonly string[] | Record<string, 0 | 1>;
-/** Filter query type for MongoDB queries (compatible with Mongoose 8 & 9) */
-type FilterQuery<_T = unknown> = Record<string, unknown>;
-//#endregion
-export { PopulateSpec as a, SortDirection as c, ObjectId as i, SortSpec as l, AnyModel as n, ReadPreferenceType as o, FilterQuery as r, SelectSpec as s, AnyDocument as t };

package/dist/pagination-jSUdrACK.d.mts

@@ -1,158 +0,0 @@
-import { a as PopulateSpec, i as ObjectId, l as SortSpec, o as ReadPreferenceType, r as FilterQuery, s as SelectSpec, t as AnyDocument } from "./core-62oo3N1C.mjs";
-import { PipelineStage } from "mongoose";
-//#region src/types/pagination.d.ts
-/** Pagination configuration */
-interface PaginationConfig {
-  /** Default number of documents per page (default: 10) */
-  defaultLimit?: number;
-  /** Maximum allowed limit (default: 100) */
-  maxLimit?: number;
-  /** Maximum allowed page number (default: 10000) */
-  maxPage?: number;
-  /** Page number that triggers performance warning (default: 100) */
-  deepPageThreshold?: number;
-  /** Cursor version for forward compatibility (default: 1) */
-  cursorVersion?: number;
-  /**
-   * Minimum cursor version accepted. Bump alongside `cursorVersion` when a
-   * breaking format change ships so stale client cursors are rejected with a
-   * clear error instead of silently paginating from the wrong position.
-   * Default: 1 (accept any cursor <= cursorVersion).
-   */
-  minCursorVersion?: number;
-  /**
-   * Allowlist of primary sort fields for keyset pagination. When set, any
-   * `getAll({ sort })` whose primary (non-_id) field is not in this list
-   * throws at validation time.
-   *
-   * Use this to lock down keyset pagination to fields that are structurally
-   * guaranteed non-null in your schema — keyset sort across null/non-null
-   * boundaries is lossy (MongoDB's `$lt/$gt` semantics leave a gap at the
-   * type boundary, so not every doc is reachable).
-   *
-   * `_id` is always allowed regardless of this list.
-   * Undefined (default) = no allowlist, any sort field accepted.
-   */
-  strictKeysetSortFields?: string[];
-  /** Use estimatedDocumentCount for faster counts on large collections */
-  useEstimatedCount?: boolean;
-}
-/** MongoDB collation options for locale-aware string comparison */
-interface CollationOptions {
-  locale: string;
-  caseLevel?: boolean;
-  caseFirst?: 'upper' | 'lower' | 'off';
-  strength?: 1 | 2 | 3 | 4 | 5;
-  numericOrdering?: boolean;
-  alternate?: 'non-ignorable' | 'shifted';
-  maxVariable?: 'punct' | 'space';
-  backwards?: boolean;
-}
-/** Base pagination options */
-interface BasePaginationOptions {
-  /** Pagination mode (explicit override) */
-  mode?: 'offset' | 'keyset';
-  /** MongoDB query filters */
-  filters?: FilterQuery<AnyDocument>;
-  /** Sort specification */
-  sort?: SortSpec;
-  /** Number of documents per page */
-  limit?: number;
-  /** Fields to select */
-  select?: SelectSpec;
-  /** Fields to populate */
-  populate?: PopulateSpec;
-  /** Return plain JavaScript objects */
-  lean?: boolean;
-  /** MongoDB session for transactions */
-  session?: unknown;
-  /** Query hint (index name or document) */
-  hint?: string | Record<string, 1 | -1>;
-  /** Maximum execution time in milliseconds */
-  maxTimeMS?: number;
-  /** Read preference for replica sets (e.g. 'secondaryPreferred') */
-  readPreference?: ReadPreferenceType;
-  /** Collation for locale-aware string comparison and case-insensitive sorting */
-  collation?: CollationOptions;
-}
-/** Offset pagination options */
-interface OffsetPaginationOptions extends BasePaginationOptions {
-  /** Page number (1-indexed) */
-  page?: number;
-  /** Count strategy for filtered queries (default: 'exact') */
-  countStrategy?: 'exact' | 'estimated' | 'none';
-  /**
-   * Optional alternate filter used for the count query only. The primary
-   * `filters` is still used for `.find()`. Lets callers (Repository) run a
-   * sort-only query like `$near` for results while counting with a
-   * count-compatible rewrite (e.g. `$geoWithin: $centerSphere`) that
-   * returns the same document set but works with `countDocuments`.
-   */
-  countFilters?: FilterQuery<AnyDocument>;
-}
-/** Keyset (cursor) pagination options */
-interface KeysetPaginationOptions extends BasePaginationOptions {
-  /** Cursor token for next page */
-  after?: string;
-  /** Sort is required for keyset pagination */
-  sort: SortSpec;
-}
-/** Aggregate pagination options */
-interface AggregatePaginationOptions {
-  /** Aggregation pipeline stages */
-  pipeline?: PipelineStage[];
-  /** Page number (1-indexed) */
-  page?: number;
-  /** Number of documents per page */
-  limit?: number;
-  /** MongoDB session for transactions */
-  session?: unknown;
-  /** Query hint (index name or document) for aggregation */
-  hint?: string | Record<string, 1 | -1>;
-  /** Maximum execution time in milliseconds */
-  maxTimeMS?: number;
-  /** Count strategy (default: 'exact' via $facet).
-   * 'estimated' is accepted but treated as 'exact' in aggregation context
-   * since estimatedDocumentCount is not available inside pipelines. */
-  countStrategy?: 'exact' | 'estimated' | 'none';
-  /** Pagination mode (reserved for API consistency) */
-  mode?: 'offset';
-  /** Read preference for replica sets (e.g. 'secondaryPreferred') */
-  readPreference?: ReadPreferenceType;
-}
-/** Value type identifier for cursor serialization */
-type ValueType = 'date' | 'objectid' | 'boolean' | 'number' | 'string' | 'null' | 'unknown';
-/** Cursor payload */
-interface CursorPayload {
-  /** Primary sort field value (legacy single-field) */
-  v: string | number | boolean | null;
-  /** Value type identifier (legacy single-field) */
-  t: ValueType;
-  /** Document ID */
-  id: string;
-  /** ID type identifier */
-  idType: ValueType;
-  /** Sort specification */
-  sort: SortSpec;
-  /** Cursor version */
-  ver: number;
-  /** Compound sort field values (multi-field keyset) */
-  vals?: Record<string, string | number | boolean | null>;
-  /** Compound sort value types */
-  types?: Record<string, ValueType>;
-}
-/** Decoded cursor */
-interface DecodedCursor {
-  /** Primary sort field value (rehydrated) — legacy compat */
-  value: unknown;
-  /** Document ID (rehydrated) */
-  id: ObjectId | string;
-  /** Sort specification */
-  sort: SortSpec;
-  /** Cursor version */
-  version: number;
-  /** All sort field values (rehydrated) — for compound sort */
-  values?: Record<string, unknown>;
-}
-//#endregion
-export { DecodedCursor as a, PaginationConfig as c, CursorPayload as i, ValueType as l, BasePaginationOptions as n, KeysetPaginationOptions as o, CollationOptions as r, OffsetPaginationOptions as s, AggregatePaginationOptions as t };