@nxgt/mongo 0.2.0 → 0.3.1

package/dist/repository/types.d.ts

@@ -1,147 +0,0 @@
-import type { ClientSession, Collection, Db, Filter, Sort, UpdateFilter } from 'mongodb';
-import type { DocumentOf, FieldOf, IdOf, NewDocumentOf, ReadDocumentOf } from '../definition/define-collection';
-import type { CursorPage, Page, PageOptions } from '../pagination/page';
-import type { SyncOptions, SyncReport } from '../sync/sync-collection';
-export type OrderDirection = 'asc' | 'desc';
-export interface ReadOptions {
-    /** Include soft-deleted documents. Ignored without a `deletedAt` field. */
-    withDeleted?: boolean;
-}
-export interface FindFirstOptions<Def> extends ReadOptions {
-    sort?: Sort;
-    projection?: Record<FieldOf<Def>, 0 | 1> | Record<string, unknown>;
-}
-export interface FindManyOptions<Def> extends FindFirstOptions<Def> {
-    filter?: Filter<DocumentOf<Def>>;
-    limit?: number;
-    skip?: number;
-}
-export interface PaginateOptions<Def> extends PageOptions, ReadOptions {
-    filter?: Filter<DocumentOf<Def>>;
-    /** Default `{ _id: 1 }`, so that pages are stable. */
-    sort?: Sort;
-}
-export interface CursorPaginateOptions<Def> extends ReadOptions {
-    /** The `nextCursor` of the previous page. Omit it for the first page. */
-    after?: string | null | undefined;
-    /** Documents per page. Default `20`, at most `maxPageSize`. */
-    limit?: number;
-    filter?: Filter<DocumentOf<Def>>;
-    /**
-     * The field to page along. Default `_id`. Any other is followed by `_id`,
-     * which breaks its ties, and must be set on every document.
-     */
-    orderBy?: FieldOf<Def>;
-    /** Default `'asc'`. */
-    direction?: OrderDirection;
-}
-/**
- * What an update writes: the document's own fields, checked against the
- * schema, or MongoDB's operators for anything they cannot say.
- *
- * The driver's `UpdateFilter` is intersected with `Document`, so it accepts
- * any key whatsoever; a plain patch is what gets checked.
- */
-export type Patch<Def> = Partial<DocumentOf<Def>> | (UpdateFilter<DocumentOf<Def>> & {
-    [K in keyof DocumentOf<Def>]?: never;
-} & {
-    id?: never;
-});
-export interface UpdateOptions {
-    /**
-     * Only update the document while its `version` is still this one. When it
-     * is not, nothing is written and `OptimisticLockError` is thrown with the
-     * version the document has now.
-     */
-    expectedVersion?: number;
-}
-export interface RepositoryOptions {
-    /**
-     * Soft delete through the `deletedAt` field. Default: on when the schema
-     * has one. `false` makes `delete` a real delete.
-     */
-    softDelete?: boolean;
-    /**
-     * Set `updatedAt` on every update that does not set it. Default: on when
-     * the schema has the field.
-     */
-    touchUpdatedAt?: boolean;
-    /**
-     * Raise `version` by one on every update. Default: on when the schema has
-     * the field. `expectedVersion` needs it.
-     */
-    optimisticLock?: boolean;
-    /**
-     * Check documents against the schema before writing them, which is also
-     * what fills their defaults. Default `'parse'`. `'off'` sends them as they
-     * are — and then nothing fills `_id`, `createdAt` or `version`.
-     */
-    validate?: 'parse' | 'off';
-    /** The largest `pageSize` or `limit` a page may ask for. Default `100`. */
-    maxPageSize?: number;
-    /** The session every operation runs in. `with(session)` is how it is set. */
-    session?: ClientSession;
-    /** Who is writing, stamped into `createdBy`, `updatedBy` and `deletedBy`. */
-    actor?: unknown;
-}
-/**
- * A repository over one collection: typed reads and writes by `_id` or by
- * filter, pagination, soft delete, optimistic locking, audit stamps, and
- * MongoDB errors turned into this package's.
- */
-export interface Repository<Def> {
-    readonly definition: Def;
-    readonly db: Db;
-    /** The driver's collection, for anything this does not wrap. */
-    readonly collection: Collection<DocumentOf<Def> & Document>;
-    /** The session every operation of this repository runs in, if any. */
-    readonly session: ClientSession | undefined;
-    /**
-     * The same repository, bound to a session. MongoDB has no ambient
-     * session: without this, an operation inside a transaction runs outside
-     * it.
-     */
-    with(session: ClientSession | undefined): Repository<Def>;
-    /** The same repository, stamping this actor into the `*By` fields. */
-    as(actor: unknown): Repository<Def>;
-    /** Creates the collection, its validator and its indexes. See `syncCollection`. */
-    sync(options?: SyncOptions): Promise<SyncReport>;
-    /** The document with this `_id`, or `undefined`. */
-    findById(id: IdOf<Def>, options?: ReadOptions): Promise<ReadDocumentOf<Def> | undefined>;
-    /** The document with this `_id`. Throws `NotFoundError`. */
-    getById(id: IdOf<Def>, options?: ReadOptions): Promise<ReadDocumentOf<Def>>;
-    /** The first document that matches, or `undefined`. */
-    findFirst(filter?: Filter<DocumentOf<Def>>, options?: FindFirstOptions<Def>): Promise<ReadDocumentOf<Def> | undefined>;
-    /** Every document that matches. */
-    findMany(options?: FindManyOptions<Def>): Promise<ReadDocumentOf<Def>[]>;
-    /** Checks the document against the schema, fills its defaults, inserts it. */
-    create(values: NewDocumentOf<Def>): Promise<ReadDocumentOf<Def>>;
-    /** The same, in one insert. `[]` sends nothing. */
-    createMany(values: readonly NewDocumentOf<Def>[]): Promise<ReadDocumentOf<Def>[]>;
-    /** Updates the document with this `_id` and returns it. Throws `NotFoundError`. */
-    update(id: IdOf<Def>, patch: Patch<Def>, options?: UpdateOptions): Promise<ReadDocumentOf<Def>>;
-    /** Updates every document that matches, and returns how many changed. */
-    updateMany(filter: Filter<DocumentOf<Def>>, patch: Patch<Def>): Promise<number>;
-    /**
-     * Deletes the document with this `_id` and returns it: a soft delete on a
-     * collection with `deletedAt`. Throws `NotFoundError`.
-     */
-    delete(id: IdOf<Def>): Promise<ReadDocumentOf<Def>>;
-    /** Deletes every document that matches, and returns how many. */
-    deleteMany(filter: Filter<DocumentOf<Def>>): Promise<number>;
-    /** A real delete, of a live or a soft-deleted document. */
-    hardDelete(id: IdOf<Def>): Promise<ReadDocumentOf<Def>>;
-    /** A real delete of every document that matches, soft-deleted ones included. */
-    hardDeleteMany(filter: Filter<DocumentOf<Def>>): Promise<number>;
-    /** Clears `deletedAt` and returns the document. Throws `NotFoundError`. */
-    restore(id: IdOf<Def>): Promise<ReadDocumentOf<Def>>;
-    /** How many documents match. */
-    count(filter?: Filter<DocumentOf<Def>>, options?: ReadOptions): Promise<number>;
-    /** Whether any document matches. */
-    exists(filter: Filter<DocumentOf<Def>>, options?: ReadOptions): Promise<boolean>;
-    /** One page of the documents that match, and how many there are. */
-    paginate(options?: PaginateOptions<Def>): Promise<Page<ReadDocumentOf<Def>>>;
-    /** One page of the documents that match, after a cursor. */
-    paginateByCursor(options?: CursorPaginateOptions<Def>): Promise<CursorPage<ReadDocumentOf<Def>>>;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/repository/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/repository/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,aAAa,EACb,UAAU,EACV,EAAE,EACF,MAAM,EACN,IAAI,EACJ,YAAY,EACZ,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EACX,UAAU,EACV,OAAO,EACP,IAAI,EACJ,aAAa,EACb,cAAc,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAEvE,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5C,MAAM,WAAW,WAAW;IAC3B,2EAA2E;IAC3E,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB,CAAC,GAAG,CAAE,SAAQ,WAAW;IACzD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnE;AAED,MAAM,WAAW,eAAe,CAAC,GAAG,CAAE,SAAQ,gBAAgB,CAAC,GAAG,CAAC;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe,CAAC,GAAG,CAAE,SAAQ,WAAW,EAAE,WAAW;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,sDAAsD;IACtD,IAAI,CAAC,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB,CAAC,GAAG,CAAE,SAAQ,WAAW;IAC9D,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACvB,uBAAuB;IACvB,SAAS,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,CAAC,GAAG,IAClB,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAKxB,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG;KAChC,CAAC,IAAI,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK;CACnC,GAAG;IAIJ,EAAE,CAAC,EAAE,KAAK,CAAC;CACV,CAAC,CAAC;AAEN,MAAM,WAAW,aAAa;IAC7B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAC3B,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6EAA6E;IAC7E,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,6EAA6E;IAC7E,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU,CAAC,GAAG;IAC9B,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;IACzB,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;IAChB,gEAAgE;IAChE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC5D,sEAAsE;IACtE,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,CAAC;IAE5C;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IAC1D,sEAAsE;IACtE,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IACpC,mFAAmF;IACnF,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEjD,oDAAoD;IACpD,QAAQ,CACP,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,EACb,OAAO,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;IAC5C,4DAA4D;IAC5D,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5E,uDAAuD;IACvD,SAAS,CACR,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAChC,OAAO,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,GAC7B,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;IAC5C,mCAAmC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAEzE,8EAA8E;IAC9E,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IACjE,mDAAmD;IACnD,UAAU,CACT,MAAM,EAAE,SAAS,aAAa,CAAC,GAAG,CAAC,EAAE,GACnC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClC,mFAAmF;IACnF,MAAM,CACL,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,EACb,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EACjB,OAAO,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,yEAAyE;IACzE,UAAU,CACT,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAC/B,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GACf,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IACpD,iEAAiE;IACjE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,2DAA2D;IAC3D,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,gFAAgF;IAChF,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACjE,2EAA2E;IAC3E,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IAErD,gCAAgC;IAChC,KAAK,CACJ,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAChC,OAAO,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB,oCAAoC;IACpC,MAAM,CACL,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAC/B,OAAO,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,oEAAoE;IACpE,QAAQ,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7E,4DAA4D;IAC5D,gBAAgB,CACf,OAAO,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,GAClC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC5C"}