@nxgt/shared-mongo 1.0.0

package/dist/migrations/migrate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrate.d.ts","sourceRoot":"","sources":["../../src/migrations/migrate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAItE,MAAM,WAAW,cAAc;IAC9B,4EAA4E;IAC5E,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,0EAA0E;IAC1E,EAAE,CAAC,EAAE,YAAY,CAAC;IAClB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,kFAAkF;IAClF,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1B;AAgBD;;;;;GAKG;AACH,wBAAsB,OAAO,CAC5B,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,YAAS,EACrD,OAAO,EAAE,cAAc,GACrB,OAAO,CAAC,IAAI,CAAC,CAyBf;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,EAC1C,OAAO,EAAE,cAAc,EACvB,EAAE,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,GACzC,OAAO,CAAC,CAAC,CAAC,CAYZ"}

package/dist/migrations/migration.model.d.ts

@@ -0,0 +1,7 @@
+import type { HydratedDocument, Model } from 'mongoose';
+import type { MigrationRecord } from './migration.types';
+export type MigrationDocument = HydratedDocument<MigrationRecord>;
+type MigrationModel = Model<MigrationDocument>;
+export declare const MigrationModel: MigrationModel;
+export {};
+//# sourceMappingURL=migration.model.d.ts.map

package/dist/migrations/migration.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.model.d.ts","sourceRoot":"","sources":["../../src/migrations/migration.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAExD,OAAO,KAAK,EAAE,eAAe,EAAmB,MAAM,mBAAmB,CAAC;AAE1E,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,eAAe,CAAC,CAAC;AAElE,KAAK,cAAc,GAAG,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAqC/C,eAAO,MAAM,cAAc,gBAG1B,CAAC"}

package/dist/migrations/migration.runner.d.ts

@@ -0,0 +1,47 @@
+import type { MigrationListEntry, MigrationRunnerOptions, RunDownOptions, RunUpOptions } from './migration.types';
+/**
+ * `MigrationRunner` manages the full lifecycle of database migrations:
+ *
+ * - `up()`     — run all pending migrations, or a specific one by name
+ * - `down()`   — rollback the last batch, or a specific migration by name
+ * - `list()`   — return every known migration with its current status
+ * - `create()` — generate a new migration file
+ *
+ * A `Mutex` ensures that concurrent invocations within the same process are
+ * serialised; for multi-process safety you should use an external lock
+ * (e.g. a MongoDB distributed lock) in front of the runner.
+ */
+export declare class MigrationRunner {
+    private readonly migrationsDir;
+    private readonly connection;
+    constructor(options: MigrationRunnerOptions);
+    /**
+     * Run all pending migrations in ascending timestamp order.
+     */
+    up(options?: RunUpOptions): Promise<void>;
+    /**
+     * Rollback the last batch of migrations in descending timestamp order.
+     */
+    down(options?: RunDownOptions): Promise<void>;
+    /**
+     * Creates a new migration file.
+     */
+    create(options: {
+        name: string;
+    }): Promise<string>;
+    /**
+     * Returns every migration file found in `migrationsDir` combined with its
+     * persisted status from the database.
+     */
+    list(): Promise<MigrationListEntry[]>;
+    private runPendingUp;
+    private runSpecificUp;
+    private executeMigrationUp;
+    private runLastBatchDown;
+    private runSpecificDown;
+    private executeMigrationDown;
+    private fetchExecutedNames;
+    private fetchLastBatch;
+    private nextBatchNumber;
+}
+//# sourceMappingURL=migration.runner.d.ts.map

package/dist/migrations/migration.runner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.runner.d.ts","sourceRoot":"","sources":["../../src/migrations/migration.runner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEX,kBAAkB,EAClB,sBAAsB,EACtB,cAAc,EACd,YAAY,EACZ,MAAM,mBAAmB,CAAC;AAa3B;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe;IAC3B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuC;gBAEtD,OAAO,EAAE,sBAAsB;IAO3C;;OAEG;IACG,EAAE,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAY/C;;OAEG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAYnD;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IASxD;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;YA2B7B,YAAY;YA2BZ,aAAa;YAmBb,kBAAkB;YAyDlB,gBAAgB;YAgChB,eAAe;YAoBf,oBAAoB;YAoCpB,kBAAkB;YAOlB,cAAc;YASd,eAAe;CAI7B"}

package/dist/migrations/migration.types.d.ts

@@ -0,0 +1,48 @@
+import type { ClientSession, Connection } from 'mongoose';
+export interface MigrationDefinition {
+    /** Kebab-case filename without extension, e.g. `20260421120000-add-user-indexes` */
+    name: string;
+    /** Absolute path to the migration file */
+    filePath: string;
+    up(db: Connection, session?: ClientSession): Promise<void>;
+    down?(db: Connection, session?: ClientSession): Promise<void>;
+}
+export type MigrationStatus = 'up' | 'failed';
+export interface MigrationRecord {
+    /** Kebab-case filename without extension */
+    name: string;
+    /** Incremented each time `up()` is called; migrations in the same run share a batch number */
+    batch: number;
+    status: MigrationStatus;
+    executedAt: Date;
+    /** Execution time in milliseconds */
+    duration: number;
+    /** Present only when `status` is `failed` */
+    error?: string;
+}
+export interface MigrationRunnerOptions {
+    /** Absolute path to the directory that contains migration files */
+    migrationsDir: string;
+    /** An already-connected Mongoose connection */
+    connection: Connection;
+}
+export interface RunUpOptions {
+    /** When provided, only this migration is executed (by name, regardless of prior status) */
+    name?: string;
+    /** When true, only logs what would happen without executing anything */
+    dryRun?: boolean;
+}
+export interface RunDownOptions {
+    /** When provided, only this specific migration is rolled back */
+    name?: string;
+    /** When true, only logs what would happen without executing anything */
+    dryRun?: boolean;
+}
+export type MigrationListStatus = 'pending' | MigrationStatus;
+export interface MigrationListEntry {
+    name: string;
+    status: MigrationListStatus;
+    batch?: number;
+    executedAt?: Date;
+}
+//# sourceMappingURL=migration.types.d.ts.map

package/dist/migrations/migration.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.types.d.ts","sourceRoot":"","sources":["../../src/migrations/migration.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAI1D,MAAM,WAAW,mBAAmB;IACnC,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,IAAI,CAAC,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAID,MAAM,MAAM,eAAe,GAAG,IAAI,GAAG,QAAQ,CAAC;AAE9C,MAAM,WAAW,eAAe;IAC/B,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,8FAA8F;IAC9F,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,eAAe,CAAC;IACxB,UAAU,EAAE,IAAI,CAAC;IACjB,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAID,MAAM,WAAW,sBAAsB;IACtC,mEAAmE;IACnE,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,UAAU,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC5B,2FAA2F;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC9B,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAID,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,eAAe,CAAC;AAE9D,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,mBAAmB,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,IAAI,CAAC;CAClB"}

package/dist/migrations/migration.utils.d.ts

@@ -0,0 +1,40 @@
+import { type Logger } from '@nxgt/shared-logging';
+import type { MigrationDefinition } from './migration.types';
+export declare const logger: Logger;
+export declare function isMigrationFile(filename: string): boolean;
+/**
+ * Extracts the migration name (filename without extension).
+ * e.g. `20260421120000-add-user-indexes.ts` → `20260421120000-add-user-indexes`
+ */
+export declare function migrationName(filename: string): string;
+/**
+ * Extracts the timestamp prefix from a migration name.
+ * e.g. `20260421120000-add-user-indexes` → `20260421120000`
+ * e.g. `123-abc` → `123`
+ */
+export declare function migrationTimestamp(name: string): string;
+/**
+ * Sorts migration definitions in ascending timestamp order (oldest first).
+ * Numerical comparison of the prefix.
+ */
+export declare function sortMigrationsAsc(migrations: MigrationDefinition[]): MigrationDefinition[];
+/**
+ * Sorts migration definitions in descending timestamp order (newest first).
+ */
+export declare function sortMigrationsDesc(migrations: MigrationDefinition[]): MigrationDefinition[];
+/**
+ * Creates a new migration file with a 14-digit timestamp prefix and a boilerplate template.
+ */
+export declare function createMigrationFile(migrationsDir: string, description: string): Promise<string>;
+/**
+ * Reads all valid migration files from `migrationsDir`, dynamically imports
+ * each one, and returns an array of `MigrationDefinition` objects sorted in
+ * ascending timestamp order (ready for `up()`).
+ *
+ * Only files matching the `<14-digit-timestamp>-<kebab-description>.ts` pattern
+ * are considered. All other files (helpers, fixtures, etc.) are silently skipped.
+ *
+ * @throws {Error} If a migration file does not export an `up` function.
+ */
+export declare function loadMigrationFiles(migrationsDir: string): Promise<MigrationDefinition[]>;
+//# sourceMappingURL=migration.utils.d.ts.map

package/dist/migrations/migration.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.utils.d.ts","sourceRoot":"","sources":["../../src/migrations/migration.utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,KAAK,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,eAAO,MAAM,MAAM,EAAE,MAA6C,CAAC;AAgBnE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEvD;AAID;;;GAGG;AACH,wBAAgB,iBAAiB,CAChC,UAAU,EAAE,mBAAmB,EAAE,GAC/B,mBAAmB,EAAE,CAQvB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CACjC,UAAU,EAAE,mBAAmB,EAAE,GAC/B,mBAAmB,EAAE,CAQvB;AAID;;GAEG;AACH,wBAAsB,mBAAmB,CACxC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,CAqCjB;AAID;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CACvC,aAAa,EAAE,MAAM,GACnB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAiChC"}

package/dist/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './pagination';
+export * from './postal-address.model';
+//# sourceMappingURL=index.d.ts.map

package/dist/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC"}

package/dist/models/pagination.d.ts

@@ -0,0 +1,34 @@
+export interface SimplePaginationOptions {
+    limit?: number | null;
+    skip?: number | null;
+    filter?: object | null;
+}
+export interface PaginationOptions {
+    first?: number | null;
+    last?: number | null;
+    before?: string | null;
+    after?: string | null;
+    filter?: object | null;
+    extraFilter?: any | null;
+}
+export interface NestedPaginationOptions {
+    first?: number | null;
+    last?: number | null;
+    before?: string | null;
+    after?: string | null;
+}
+export interface IPageInfo {
+    startCursor?: string | null;
+    endCursor?: string | null;
+    hasNextPage: boolean;
+}
+export interface IEdge<T> {
+    node: T;
+    cursor: string;
+}
+export interface IConnection<T> {
+    edges: IEdge<T>[];
+    pageInfo: IPageInfo;
+    totalCount: number;
+}
+//# sourceMappingURL=pagination.d.ts.map

package/dist/models/pagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../src/models/pagination.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACvC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACvC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,KAAK,CAAC,CAAC;IACvB,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW,CAAC,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAClB,QAAQ,EAAE,SAAS,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACnB"}

package/dist/models/postal-address.model.d.ts

@@ -0,0 +1,64 @@
+import { Schema } from 'mongoose';
+export type PostalAddress = {
+    street?: string;
+    locality?: string;
+    region?: string;
+    postalCode?: string;
+    country?: string;
+};
+export declare const PostalAddressSchema: Schema<PostalAddress, import("mongoose").Model<PostalAddress, any, any, any, any, any, PostalAddress>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, PostalAddress, import("mongoose").Document<unknown, {}, PostalAddress, {
+    id: string;
+}, import("mongoose").DefaultSchemaOptions> & Omit<PostalAddress & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}, "id"> & import("mongoose").HydratedDocumentOverrides<{
+    id: string;
+}>, {
+    street?: import("mongoose").SchemaDefinitionProperty<string | undefined, PostalAddress, import("mongoose").Document<unknown, {}, PostalAddress, {
+        id: string;
+    }, import("mongoose").DefaultSchemaOptions> & Omit<PostalAddress & {
+        _id: import("mongoose").Types.ObjectId;
+    } & {
+        __v: number;
+    }, "id"> & import("mongoose").HydratedDocumentOverrides<{
+        id: string;
+    }>> | undefined;
+    locality?: import("mongoose").SchemaDefinitionProperty<string | undefined, PostalAddress, import("mongoose").Document<unknown, {}, PostalAddress, {
+        id: string;
+    }, import("mongoose").DefaultSchemaOptions> & Omit<PostalAddress & {
+        _id: import("mongoose").Types.ObjectId;
+    } & {
+        __v: number;
+    }, "id"> & import("mongoose").HydratedDocumentOverrides<{
+        id: string;
+    }>> | undefined;
+    region?: import("mongoose").SchemaDefinitionProperty<string | undefined, PostalAddress, import("mongoose").Document<unknown, {}, PostalAddress, {
+        id: string;
+    }, import("mongoose").DefaultSchemaOptions> & Omit<PostalAddress & {
+        _id: import("mongoose").Types.ObjectId;
+    } & {
+        __v: number;
+    }, "id"> & import("mongoose").HydratedDocumentOverrides<{
+        id: string;
+    }>> | undefined;
+    postalCode?: import("mongoose").SchemaDefinitionProperty<string | undefined, PostalAddress, import("mongoose").Document<unknown, {}, PostalAddress, {
+        id: string;
+    }, import("mongoose").DefaultSchemaOptions> & Omit<PostalAddress & {
+        _id: import("mongoose").Types.ObjectId;
+    } & {
+        __v: number;
+    }, "id"> & import("mongoose").HydratedDocumentOverrides<{
+        id: string;
+    }>> | undefined;
+    country?: import("mongoose").SchemaDefinitionProperty<string | undefined, PostalAddress, import("mongoose").Document<unknown, {}, PostalAddress, {
+        id: string;
+    }, import("mongoose").DefaultSchemaOptions> & Omit<PostalAddress & {
+        _id: import("mongoose").Types.ObjectId;
+    } & {
+        __v: number;
+    }, "id"> & import("mongoose").HydratedDocumentOverrides<{
+        id: string;
+    }>> | undefined;
+}, PostalAddress>;
+//# sourceMappingURL=postal-address.model.d.ts.map

package/dist/models/postal-address.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postal-address.model.d.ts","sourceRoot":"","sources":["../../src/models/postal-address.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,MAAM,MAAM,aAAa,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAS/B,CAAC"}

package/dist/mongoose.d.ts

@@ -0,0 +1,3 @@
+import mongoose from 'mongoose';
+export { mongoose };
+//# sourceMappingURL=mongoose.d.ts.map

package/dist/mongoose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongoose.d.ts","sourceRoot":"","sources":["../src/mongoose.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/plugins/consts.d.ts

@@ -0,0 +1,6 @@
+export declare const PLUGIN_OPTIONS: {
+    autopopulate: {
+        maxDepth: number;
+    };
+};
+//# sourceMappingURL=consts.d.ts.map

package/dist/plugins/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../src/plugins/consts.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;CAE1B,CAAC"}

package/dist/plugins/errors.d.ts

@@ -0,0 +1,3 @@
+import type { Schema } from 'mongoose';
+export declare const errors: (schema: Schema) => void;
+//# sourceMappingURL=errors.d.ts.map

package/dist/plugins/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/plugins/errors.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,eAAO,MAAM,MAAM,GAAI,QAAQ,MAAM,SA8BpC,CAAC"}

package/dist/plugins/index.d.ts

@@ -0,0 +1,15 @@
+import type { Schema } from 'mongoose';
+import autopopulate from 'mongoose-autopopulate';
+import leanVirtuals from 'mongoose-lean-virtuals';
+import { shared } from './shared';
+export declare const MONGOOSE_PLUGINS: {
+    shared: typeof shared;
+    errors: (schema: Schema) => void;
+    pagination: (schema: Schema) => void;
+    leanVirtuals: typeof leanVirtuals;
+    autopopulate: typeof autopopulate;
+};
+export declare function applyPlugins(schema: Schema, plugins: any[]): void;
+export * from './consts';
+export * from './pagination/types';
+//# sourceMappingURL=index.d.ts.map

package/dist/plugins/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,OAAO,YAAY,MAAM,wBAAwB,CAAC;AAGlD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,eAAO,MAAM,gBAAgB;;;;;;CAM5B,CAAC;AAEF,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,QAI1D;AAED,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC"}

package/dist/plugins/pagination/index.d.ts

@@ -0,0 +1,4 @@
+import type { Schema } from 'mongoose';
+export declare const pagination: (schema: Schema) => void;
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/plugins/pagination/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/pagination/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,eAAO,MAAM,UAAU,GAAI,QAAQ,MAAM,SAExC,CAAC;AACF,cAAc,SAAS,CAAC"}

package/dist/plugins/pagination/types.d.ts

@@ -0,0 +1,61 @@
+import type { PopulateOptions } from 'mongoose';
+/**
+ * Offset pagination — page and size.
+ *
+ * The cursor/Relay shapes live in `../../models/pagination.ts` and own the
+ * plain names (`PaginationOptions`, `NestedPaginationOptions`), because that is
+ * what `Model.paginate` answers and what every consumer of it passes. These
+ * carry the `Offset` prefix so both can be exported from one package; they had
+ * the plain names in sellix-monorepo, where nothing called them.
+ */
+export declare class OffsetPaginationOptions {
+    filter?: object;
+    sort?: object;
+    page?: number;
+    size?: number;
+}
+export declare class NestedOffsetPaginationOptions {
+    page?: number;
+    size?: number;
+}
+export interface OffsetPageInfo {
+    page: number;
+    size: number;
+    totalPages: number;
+    nbOfElements: number;
+    totalElements: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+}
+export interface IPaginatedType<T> {
+    data: T[];
+    metadata: OffsetPageInfo;
+}
+export type PaginateOffsetOptions = OffsetPaginationOptions & {
+    deleted?: 'Deleted' | 'WidthDeleted';
+} & {
+    populate?: string | PopulateOptions | (string | PopulateOptions)[];
+};
+export declare class CursorPaginationOptions {
+    filter?: object;
+    first?: number;
+    last?: number;
+    after?: string;
+    before?: string;
+}
+export interface CursorPageInfo {
+    startCursor: string | null;
+    endCursor: string | null;
+    hasNextPage: boolean;
+    totalElements: number;
+}
+export interface ICursorPaginatedType<T> {
+    data: T[];
+    metadata: CursorPageInfo;
+}
+export type CursorPaginateOptions = CursorPaginationOptions & {
+    deleted?: 'Deleted' | 'WidthDeleted';
+} & {
+    populate?: string | PopulateOptions | (string | PopulateOptions)[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/plugins/pagination/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/plugins/pagination/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD;;;;;;;;GAQG;AACH,qBAAa,uBAAuB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,qBAAa,6BAA6B;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,cAAc,CAAC,CAAC;IAChC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,QAAQ,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,GAAG;IAC7D,OAAO,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC;CACrC,GAAG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,eAAe,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC;CACnE,CAAC;AAEF,qBAAa,uBAAuB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,QAAQ,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,GAAG;IAC7D,OAAO,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC;CACrC,GAAG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,eAAe,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC;CACnE,CAAC"}

package/dist/plugins/pagination/utils.d.ts

@@ -0,0 +1,24 @@
+import type { HydratedDocument, Schema } from 'mongoose';
+import type { IConnection, PaginationOptions } from '../../models/pagination';
+/**
+ * Both repositories put a `paginate` static on every schema, and they meant
+ * different things by it: sellix-monorepo answered `{data, metadata}` from a
+ * page and a size, nxgt-federation answered a Relay `{edges, pageInfo,
+ * totalCount}` from a cursor.
+ *
+ * `paginate` keeps federation's meaning because federation calls it from
+ * dozens of services and sellix-monorepo called it from none — its offset
+ * variants were dead code there. They survive under explicit names rather than
+ * being deleted, since a cursor connection cannot express "page 7 of 12".
+ *
+ *   paginate            cursor, Relay connection
+ *   paginateList        cursor, over a list already in memory
+ *   paginateOffset      page/size, {data, metadata}
+ *   paginateListOffset  page/size, over a list already in memory
+ *   cursorPaginate      cursor, {data, metadata} — sellix's third shape
+ */
+export declare function applyPagination(schema: Schema): void;
+export declare function paginateListData<T extends HydratedDocument<{
+    id: string;
+}>>(list: T[], options: PaginationOptions): IConnection<T>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/plugins/pagination/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/plugins/pagination/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAY,gBAAgB,EAAe,MAAM,EAAE,MAAM,UAAU,CAAC;AAChF,OAAO,KAAK,EACX,WAAW,EAGX,iBAAiB,EACjB,MAAM,yBAAyB,CAAC;AASjC;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,QAwM7C;AAuBD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,gBAAgB,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC,EAC1E,IAAI,EAAE,CAAC,EAAE,EACT,OAAO,EAAE,iBAAiB,GACxB,WAAW,CAAC,CAAC,CAAC,CA4ChB"}

package/dist/plugins/shared/index.d.ts

@@ -0,0 +1,3 @@
+import type { Schema } from 'mongoose';
+export declare function shared(schema: Schema): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/plugins/shared/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/shared/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,QAEpC"}

package/dist/plugins/shared/shared.d.ts

@@ -0,0 +1,3 @@
+import type { Schema } from 'mongoose';
+export declare function applySharedOperations(schema: Schema): void;
+//# sourceMappingURL=shared.d.ts.map

package/dist/plugins/shared/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/plugins/shared/shared.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,QAyEnD"}

package/dist/plugins/soft-delete/index.d.ts

@@ -0,0 +1,3 @@
+import type { Schema } from 'mongoose';
+export declare function softDelete(schema: Schema): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/plugins/soft-delete/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/soft-delete/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,QAGxC"}

package/dist/plugins/soft-delete/soft-delete.d.ts

@@ -0,0 +1,3 @@
+import { type Schema } from 'mongoose';
+export declare function applySoftDeleteOperations(schema: Schema): void;
+//# sourceMappingURL=soft-delete.d.ts.map

package/dist/plugins/soft-delete/soft-delete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"soft-delete.d.ts","sourceRoot":"","sources":["../../../src/plugins/soft-delete/soft-delete.ts"],"names":[],"mappings":"AACA,OAAO,EAAS,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,QAqHvD"}

package/dist/services/crud.service.d.ts

@@ -0,0 +1,88 @@
+import type { Principal } from '@nxgt/shared';
+import type { Mutex } from 'async-mutex';
+import type { HydratedDocument, Model, QueryFilter } from 'mongoose';
+type InferDocType<D extends HydratedDocument<any>> = D extends HydratedDocument<infer T> ? T : D;
+export declare abstract class MongoCrudService<D extends HydratedDocument<any>, CInput = any, UInput = any> {
+    readonly principal?: (Principal | null) | undefined;
+    protected abstract model: Model<D>;
+    /**
+     * Additional models to watch in the change stream (e.g. child models
+     * that are cascade-deleted alongside the parent).
+     */
+    protected extraModels: Model<any>[];
+    protected abstract mutex: Mutex;
+    constructor(principal?: (Principal | null) | undefined);
+    protected get changesOptions(): {
+        models: (Model<any, {}, {}, {}, any, any, any> | Model<D, {}, {}, {}, import("mongoose").IfAny<D, any, import("mongoose").Document<unknown, {}, D, {}, import("mongoose").DefaultSchemaOptions> & import("mongoose").Require_id<D> & {
+            __v: number;
+        } & import("mongoose").AddDefaultId<D, {}, import("mongoose").DefaultSchemaOptions>>, any, D>)[];
+        author: string;
+        mutex: Mutex;
+    };
+    find(filter?: QueryFilter<D>): Promise<D[]>;
+    /**
+     * Fetches one document by id.
+     *
+     * Overriding this to point at another model is fine — that is what the
+     * hierarchical services do, and `update()` reads through
+     * `findWritableById()` precisely so a read-only view can be used here.
+     * Overriding it to reshape the result is not: `create()` returns what
+     * this hands back, so anything but a hydrated document breaks writes on
+     * that service. Strip or map fields at the serialization boundary
+     * instead.
+     */
+    findById(id: string): Promise<D>;
+    create(input: CInput): Promise<D>;
+    /**
+     * The document `update()` mutates and saves.
+     *
+     * Deliberately not `findById()`: a service is free to point that at a
+     * *view* (`HierarchicalDirectoryModel`, `HierarchicalTypologyModel`) to
+     * get materialised `ancestors`, and Mongo refuses to save a document
+     * loaded from one — "Namespace x.y is a view, not a collection". Writes
+     * therefore go through `this.model`, which is the collection by
+     * definition. For a service whose `findById` override only changes the
+     * not-found message, this loads exactly the same document.
+     */
+    protected findWritableById(id: string): Promise<D>;
+    update(id: string, input: UInput): Promise<D>;
+    /**
+     * Deletion flow:
+     *   1. `beforeDeleteMany` hook  — custom pre-checks (outside transaction)
+     *   2. `validateDeletion`       — all integrity blockers in parallel (outside transaction)
+     *   3. `runWithChangesListening`:
+     *        a. `runCascades`       — registered cascade handlers (inside transaction)
+     *        b. `model.deleteMany`  — parent documents deleted (inside transaction)
+     */
+    deleteMany(ids: string[]): Promise<void>;
+    delete(id: string): Promise<void>;
+    /**
+     * Override to customize the data passed to `model.create()`.
+     * Default: spread input as-is.
+     */
+    protected buildCreateData(input: CInput): Promise<Partial<InferDocType<D>>> | Partial<InferDocType<D>>;
+    /**
+     * Override to customize the fields applied to the document during update.
+     * Default: spread input as-is.
+     */
+    protected buildUpdateData(_doc: D, input: UInput): Promise<Partial<InferDocType<D>>> | Partial<InferDocType<D>>;
+    /**
+     * Called before integrity validation and the deletion transaction.
+     * Override to add pre-delete checks (e.g. status guards).
+     */
+    protected beforeDeleteMany(_ids: string[]): Promise<void>;
+    /**
+     * Called inside the create transaction, before `model.create()`.
+     * Override to add pre-create guards (e.g. uniqueness or status checks).
+     * The raw input is passed in case the check depends on it.
+     */
+    protected beforeCreate(_input: CInput): Promise<void>;
+    /**
+     * Called inside the update transaction, after `findById`, before
+     * `buildUpdateData`. Override to add pre-update guards (e.g. status locks).
+     * Receives the already-fetched document — no extra DB round-trip needed.
+     */
+    protected beforeUpdate(_doc: D, _input: UInput): Promise<void>;
+}
+export {};
+//# sourceMappingURL=crud.service.d.ts.map

package/dist/services/crud.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud.service.d.ts","sourceRoot":"","sources":["../../src/services/crud.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAG9C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIrE,KAAK,YAAY,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,IAChD,CAAC,SAAS,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE7C,8BAAsB,gBAAgB,CACrC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,EAC/B,MAAM,GAAG,GAAG,EACZ,MAAM,GAAG,GAAG;IAYA,QAAQ,CAAC,SAAS,CAAC,GAAE,SAAS,GAAG,IAAI;IAVjD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAM;IAEzC,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;gBAEX,SAAS,CAAC,GAAE,SAAS,GAAG,IAAI,aAAA;IAEjD,SAAS,KAAK,cAAc;;;;;;MAM3B;IAIK,IAAI,CAAC,MAAM,GAAE,WAAW,CAAC,CAAC,CAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAIrD;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAYhC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAgBvC;;;;;;;;;;OAUG;cACa,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAUlD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAyBnD;;;;;;;OAOG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvC;;;OAGG;IACH,SAAS,CAAC,eAAe,CACxB,KAAK,EAAE,MAAM,GACX,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAI/D;;;OAGG;IACH,SAAS,CAAC,eAAe,CACxB,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,GACX,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAI/D;;;OAGG;cACa,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;;;OAIG;cACa,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3D;;;;OAIG;cACa,YAAY,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CACpE"}

package/dist/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './crud.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+import './pagination.d.ts';
+import './shared.d.ts';
+import './soft-delete.d.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,CAAC;AAC3B,OAAO,eAAe,CAAC;AACvB,OAAO,oBAAoB,CAAC"}