@warlock.js/cascade 1.0.5 → 1.0.7

package/cjs/model/base-model.d.ts

@@ -0,0 +1,155 @@
+import { type Database } from "../database";
+import type { Model } from "./model";
+import { ModelEvents } from "./model-events";
+import type { FactoryCreatorCallback } from "./types";
+import { ModelDeleteStrategy, type ChildModel, type Document } from "./types";
+export declare abstract class BaseModel {
+    /**
+     * Collection Name
+     */
+    static collection: string;
+    /**
+     * Connection instance
+     */
+    static database: Database;
+    /**
+     * Model associated output
+     */
+    static output?: any;
+    /**
+     * Missing key symbol
+     */
+    static MISSING_KEY: symbol;
+    /**
+     * Define the initial value of the id
+     */
+    static initialId?: number;
+    /**
+     * Define the amount to eb incremented by for the next generated id
+     */
+    static incrementIdBy?: number;
+    /**
+     * Primary id column
+     */
+    static get primaryIdColumn(): string;
+    /**
+     * A flag to determine whether to auto generate id on insertion or not
+     *
+     * @default true
+     */
+    static autoGenerateId: boolean;
+    /**
+     * Query instance
+     */
+    static query: import("../query/query").Query;
+    /**
+     * Define the delete method
+     *
+     * @default true
+     */
+    static deleteStrategy: ModelDeleteStrategy;
+    /**
+     * Items per page
+     */
+    static perPage: number;
+    /**
+     * If set to true, then only the original data and the data in the casts property will be saved
+     * If set to false, all data will be saved
+     */
+    static isStrict: boolean;
+    /**
+     * Get increment id by
+     */
+    static getIncrementIdBy(): any;
+    /**
+     * Get initial id
+     */
+    static getInitialId(): any;
+    /**
+     * Generate next id
+     */
+    static genNextId(): Promise<number>;
+    /**
+     * Get last id of current model
+     */
+    static getLastId(): Promise<number>;
+    /**
+     * Get an instance of child class
+     */
+    protected static self(data: Document): any;
+    /**
+     * Get collection name
+     */
+    getCollection(): string;
+    /**
+     * Get collection query
+     */
+    getQuery(): any;
+    /**
+     * Get database instance
+     */
+    getDatabase(): Database;
+    /**
+     * Get static property
+     */
+    getStaticProperty(property: keyof typeof BaseModel): any;
+    /**
+     * Prepare model for response
+     */
+    toJSON(): Promise<any>;
+    /**
+     * Get current output instance
+     */
+    getOutput(data?: Document): any;
+    /**
+     * Get model events instance
+     */
+    static events<T extends Model>(this: ChildModel<T>): ModelEvents;
+    /**
+     * Get model events for current model
+     */
+    getModelEvents(): ModelEvents;
+    /**
+     * Get base model events
+     */
+    getBaseModelEvents(): ModelEvents;
+    /**
+     * Get model blueprint
+     */
+    static blueprint(): import("../blueprint/model-blueprint").ModelBlueprint;
+    /**
+     * Define what columns should be embedded when model document is embedded in another document.
+     */
+    static embedOnly(...columns: string[]): {
+        model: typeof BaseModel;
+        embeddedKey: string[];
+    };
+    /**
+     * Define the embedded getter key to be used when embedding the model
+     */
+    static embed(key: string | string[]): {
+        model: typeof BaseModel;
+        embeddedKey: string | string[];
+    };
+    /**
+     * Embed only id
+     */
+    static get embedOnlyId(): {
+        model: typeof BaseModel;
+        embeddedKey: string;
+    };
+    /**
+     * Document Factory
+     */
+    protected static documentFactory: FactoryCreatorCallback;
+    /**
+     * Get user factory
+     */
+    static get factory(): {
+        /**
+         * Create documents based on the given number of records
+         */
+        create: (size: number, recordCallback?: FactoryCreatorCallback) => Promise<void>;
+    };
+}
+//# sourceMappingURL=base-model.d.ts.map

package/cjs/model/base-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-model.d.ts","sourceRoot":"","sources":["../../src/model/base-model.ts"],"names":[],"mappings":"AAGA,OAAO,EAAY,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGtD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,KAAK,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAe9E,8BAAsB,SAAS;IAC7B;;OAEG;IACH,OAAc,UAAU,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,OAAc,QAAQ,EAAE,QAAQ,CAAY;IAE5C;;OAEG;IACH,OAAc,MAAM,CAAC,EAAE,GAAG,CAAC;IAE3B;;OAEG;IACH,OAAc,WAAW,SAAyB;IAElD;;OAEG;IACH,OAAc,SAAS,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,OAAc,aAAa,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,WAAkB,eAAe,WAEhC;IAED;;;;OAIG;IACH,OAAc,cAAc,UAAQ;IAEpC;;OAEG;IACH,OAAc,KAAK,iCAAS;IAE5B;;;;OAIG;IACH,OAAc,cAAc,EAAE,mBAAmB,CACf;IAElC;;OAEG;IACH,OAAc,OAAO,SAAM;IAE3B;;;OAGG;IACH,OAAc,QAAQ,UAAQ;IAE9B;;OAEG;WACW,gBAAgB;IAc9B;;OAEG;WACW,YAAY;IAc1B;;OAEG;WACiB,SAAS;IAQ7B;;OAEG;WACiB,SAAS;IAI7B;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ;IAIpC;;OAEG;IACI,aAAa,IAAI,MAAM;IAI9B;;OAEG;IACI,QAAQ;IAIf;;OAEG;IACI,WAAW,IAAI,QAAQ;IAI9B;;OAEG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,OAAO,SAAS;IAIzD;;OAEG;IACU,MAAM;IAcnB;;OAEG;IACI,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ;IAOhC;;OAEG;WACW,MAAM,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IAIzD;;OAEG;IACI,cAAc;IAIrB;;OAEG;IACI,kBAAkB;IAIzB;;OAEG;WACW,SAAS;IAIvB;;OAEG;WACW,SAAS,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE;;;;IAO5C;;OAEG;WACW,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;;;;IAO1C;;OAEG;IACH,WAAkB,WAAW;;;MAK5B;IAED;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,EAAE,sBAAsB,CAOtD;IAEF;;OAEG;IACH,WAAkB,OAAO;QAErB;;WAEG;uBAEK,MAAM,mBACI,sBAAsB;MAO3C;CACF"}

package/cjs/model/base-model.js

@@ -0,0 +1,230 @@
+'use strict';var faker=require('@faker-js/faker'),reinforcements=require('@mongez/reinforcements'),modelBlueprint=require('../blueprint/model-blueprint.js'),database=require('../database.js'),query=require('../query/query.js'),masterMind=require('./master-mind.js'),modelEvents$1=require('./model-events.js'),types=require('./types.js');const modelEvents = new Map();
+const getModelEvent = (collection) => {
+    let eventsInstance = modelEvents.get(collection);
+    if (!eventsInstance) {
+        eventsInstance = new modelEvents$1.ModelEvents(collection);
+        modelEvents.set(collection, eventsInstance);
+    }
+    return eventsInstance;
+};
+class BaseModel {
+    /**
+     * Collection Name
+     */
+    static collection;
+    /**
+     * Connection instance
+     */
+    static database = database.database;
+    /**
+     * Model associated output
+     */
+    static output;
+    /**
+     * Missing key symbol
+     */
+    static MISSING_KEY = Symbol("MISSING_KEY");
+    /**
+     * Define the initial value of the id
+     */
+    static initialId;
+    /**
+     * Define the amount to eb incremented by for the next generated id
+     */
+    static incrementIdBy;
+    /**
+     * Primary id column
+     */
+    static get primaryIdColumn() {
+        return "id";
+    }
+    /**
+     * A flag to determine whether to auto generate id on insertion or not
+     *
+     * @default true
+     */
+    static autoGenerateId = true;
+    /**
+     * Query instance
+     */
+    static query = query.query;
+    /**
+     * Define the delete method
+     *
+     * @default true
+     */
+    static deleteStrategy = types.ModelDeleteStrategy.moveToTrash;
+    /**
+     * Items per page
+     */
+    static perPage = 15;
+    /**
+     * If set to true, then only the original data and the data in the casts property will be saved
+     * If set to false, all data will be saved
+     */
+    static isStrict = true;
+    /**
+     * Get increment id by
+     */
+    static getIncrementIdBy() {
+        if (this.incrementIdBy)
+            return this.incrementIdBy;
+        const modelConfigurations = database.database.connection.configurations?.model || {};
+        const autoIncrementBy = modelConfigurations.autoIncrementBy;
+        if (autoIncrementBy)
+            return autoIncrementBy;
+        if (modelConfigurations.randomIncrement)
+            return reinforcements.Random.int(1, 999);
+        return 1;
+    }
+    /**
+     * Get initial id
+     */
+    static getInitialId() {
+        if (this.initialId)
+            return this.initialId;
+        const modelConfigurations = database.database.connection.configurations?.model || {};
+        const initialId = modelConfigurations.initialId;
+        if (initialId)
+            return initialId;
+        if (modelConfigurations.randomInitialId)
+            return reinforcements.Random.int(10000, 499999);
+        return 1;
+    }
+    /**
+     * Generate next id
+     */
+    static async genNextId() {
+        return await masterMind.masterMind.generateNextId(this.collection, this.getIncrementIdBy(), this.getInitialId());
+    }
+    /**
+     * Get last id of current model
+     */
+    static async getLastId() {
+        return await masterMind.masterMind.getLastId(this.collection);
+    }
+    /**
+     * Get an instance of child class
+     */
+    static self(data) {
+        return new this(data);
+    }
+    /**
+     * Get collection name
+     */
+    getCollection() {
+        return this.getStaticProperty("collection");
+    }
+    /**
+     * Get collection query
+     */
+    getQuery() {
+        return this.getStaticProperty("query");
+    }
+    /**
+     * Get database instance
+     */
+    getDatabase() {
+        return this.getStaticProperty("database");
+    }
+    /**
+     * Get static property
+     */
+    getStaticProperty(property) {
+        return this.constructor[property];
+    }
+    /**
+     * Prepare model for response
+     */
+    async toJSON() {
+        // get static output class
+        const Output = this.getStaticProperty("output");
+        // if the model has a Output class
+        if (Output) {
+            // then return the Output instance and call `toJSON` method
+            return await new Output(reinforcements.clone(this.data)).toJSON();
+        }
+        // otherwise return the data object
+        return this.publicData;
+    }
+    /**
+     * Get current output instance
+     */
+    getOutput(data) {
+        // get static output class
+        const Output = this.getStaticProperty("output");
+        return Output ? new Output(data) : data;
+    }
+    /**
+     * Get model events instance
+     */
+    static events() {
+        return getModelEvent(this.collection ?? "__baseModel__");
+    }
+    /**
+     * Get model events for current model
+     */
+    getModelEvents() {
+        return getModelEvent(this.getCollection());
+    }
+    /**
+     * Get base model events
+     */
+    getBaseModelEvents() {
+        return getModelEvent("__baseModel__");
+    }
+    /**
+     * Get model blueprint
+     */
+    static blueprint() {
+        return modelBlueprint.modelBlueprint(this);
+    }
+    /**
+     * Define what columns should be embedded when model document is embedded in another document.
+     */
+    static embedOnly(...columns) {
+        return {
+            model: this,
+            embeddedKey: columns,
+        };
+    }
+    /**
+     * Define the embedded getter key to be used when embedding the model
+     */
+    static embed(key) {
+        return {
+            model: this,
+            embeddedKey: key,
+        };
+    }
+    /**
+     * Embed only id
+     */
+    static get embedOnlyId() {
+        return {
+            model: this,
+            embeddedKey: "onlyId",
+        };
+    }
+    /**
+     * Document Factory
+     */
+    static documentFactory = (_faker, _index) => {
+        throw new Error("Document factory is not defined, pass a callback to `factory.create` method or define `documentFactory` method in the model class");
+    };
+    /**
+     * Get user factory
+     */
+    static get factory() {
+        return {
+            /**
+             * Create documents based on the given number of records
+             */
+            create: async (size, recordCallback = this.documentFactory) => {
+                for (let i = 0; i < size; i++) {
+                    await this.create(recordCallback(faker.faker, i));
+                }
+            },
+        };
+    }
+}exports.BaseModel=BaseModel;//# sourceMappingURL=base-model.js.map

package/cjs/model/base-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-model.js","sources":["../../src/model/base-model.ts"],"sourcesContent":[null],"names":["ModelEvents","database","query","ModelDeleteStrategy","Random","masterMind","clone","modelBlueprint","faker"],"mappings":"iVAWA,MAAM,WAAW,GAAG,IAAI,GAAG,EAAuB,CAAC;AAEnD,MAAM,aAAa,GAAG,CAAC,UAAkB,KAAI;IAC3C,IAAI,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEjD,IAAI,CAAC,cAAc,EAAE;AACnB,QAAA,cAAc,GAAG,IAAIA,yBAAW,CAAC,UAAU,CAAC,CAAC;AAC7C,QAAA,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;AAC7C,KAAA;AAED,IAAA,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;MAEoB,SAAS,CAAA;AAC7B;;AAEG;IACI,OAAO,UAAU,CAAS;AAEjC;;AAEG;AACI,IAAA,OAAO,QAAQ,GAAaC,iBAAQ,CAAC;AAE5C;;AAEG;IACI,OAAO,MAAM,CAAO;AAE3B;;AAEG;AACI,IAAA,OAAO,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;AAElD;;AAEG;IACI,OAAO,SAAS,CAAU;AAEjC;;AAEG;IACI,OAAO,aAAa,CAAU;AAErC;;AAEG;AACI,IAAA,WAAW,eAAe,GAAA;AAC/B,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;;;AAIG;AACI,IAAA,OAAO,cAAc,GAAG,IAAI,CAAC;AAEpC;;AAEG;AACI,IAAA,OAAO,KAAK,GAAGC,WAAK,CAAC;AAE5B;;;;AAIG;AACI,IAAA,OAAO,cAAc,GAC1BC,yBAAmB,CAAC,WAAW,CAAC;AAElC;;AAEG;AACI,IAAA,OAAO,OAAO,GAAG,EAAE,CAAC;AAE3B;;;AAGG;AACI,IAAA,OAAO,QAAQ,GAAG,IAAI,CAAC;AAE9B;;AAEG;AACI,IAAA,OAAO,gBAAgB,GAAA;QAC5B,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC,aAAa,CAAC;QAElD,MAAM,mBAAmB,GAAGF,iBAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE,CAAC;AAE5E,QAAA,MAAM,eAAe,GAAG,mBAAmB,CAAC,eAAe,CAAC;AAE5D,QAAA,IAAI,eAAe;AAAE,YAAA,OAAO,eAAe,CAAC;QAE5C,IAAI,mBAAmB,CAAC,eAAe;YAAE,OAAOG,qBAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAEnE,QAAA,OAAO,CAAC,CAAC;KACV;AAED;;AAEG;AACI,IAAA,OAAO,YAAY,GAAA;QACxB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC;QAE1C,MAAM,mBAAmB,GAAGH,iBAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE,CAAC;AAE5E,QAAA,MAAM,SAAS,GAAG,mBAAmB,CAAC,SAAS,CAAC;AAEhD,QAAA,IAAI,SAAS;AAAE,YAAA,OAAO,SAAS,CAAC;QAEhC,IAAI,mBAAmB,CAAC,eAAe;YAAE,OAAOG,qBAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAE1E,QAAA,OAAO,CAAC,CAAC;KACV;AAED;;AAEG;IACI,aAAa,SAAS,GAAA;AAC3B,QAAA,OAAO,MAAMC,qBAAU,CAAC,cAAc,CACpC,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,gBAAgB,EAAE,EACvB,IAAI,CAAC,YAAY,EAAE,CACpB,CAAC;KACH;AAED;;AAEG;IACI,aAAa,SAAS,GAAA;QAC3B,OAAO,MAAMA,qBAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;KACpD;AAED;;AAEG;IACO,OAAO,IAAI,CAAC,IAAc,EAAA;AAClC,QAAA,OAAO,IAAK,IAAY,CAAC,IAAI,CAAC,CAAC;KAChC;AAED;;AAEG;IACI,aAAa,GAAA;AAClB,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;KAC7C;AAED;;AAEG;IACI,QAAQ,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;KACxC;AAED;;AAEG;IACI,WAAW,GAAA;AAChB,QAAA,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;KAC3C;AAED;;AAEG;AACI,IAAA,iBAAiB,CAAC,QAAgC,EAAA;AACvD,QAAA,OAAQ,IAAI,CAAC,WAAmB,CAAC,QAAQ,CAAC,CAAC;KAC5C;AAED;;AAEG;AACI,IAAA,MAAM,MAAM,GAAA;;QAEjB,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;;AAGhD,QAAA,IAAI,MAAM,EAAE;;AAEV,YAAA,OAAO,MAAM,IAAI,MAAM,CAACC,oBAAK,CAAE,IAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;AACtE,SAAA;;QAGD,OAAQ,IAAY,CAAC,UAAU,CAAC;KACjC;AAED;;AAEG;AACI,IAAA,SAAS,CAAC,IAAe,EAAA;;QAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAEhD,QAAA,OAAO,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;KACzC;AAED;;AAEG;AACI,IAAA,OAAO,MAAM,GAAA;QAClB,OAAO,aAAa,CAAC,IAAI,CAAC,UAAU,IAAI,eAAe,CAAC,CAAC;KAC1D;AAED;;AAEG;IACI,cAAc,GAAA;AACnB,QAAA,OAAO,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,CAAgB,CAAC;KAC3D;AAED;;AAEG;IACI,kBAAkB,GAAA;AACvB,QAAA,OAAO,aAAa,CAAC,eAAe,CAAC,CAAC;KACvC;AAED;;AAEG;AACI,IAAA,OAAO,SAAS,GAAA;AACrB,QAAA,OAAOC,6BAAc,CAAC,IAAW,CAAC,CAAC;KACpC;AAED;;AAEG;AACI,IAAA,OAAO,SAAS,CAAC,GAAG,OAAiB,EAAA;QAC1C,OAAO;AACL,YAAA,KAAK,EAAE,IAAI;AACX,YAAA,WAAW,EAAE,OAAO;SACrB,CAAC;KACH;AAED;;AAEG;IACI,OAAO,KAAK,CAAC,GAAsB,EAAA;QACxC,OAAO;AACL,YAAA,KAAK,EAAE,IAAI;AACX,YAAA,WAAW,EAAE,GAAG;SACjB,CAAC;KACH;AAED;;AAEG;AACI,IAAA,WAAW,WAAW,GAAA;QAC3B,OAAO;AACL,YAAA,KAAK,EAAE,IAAI;AACX,YAAA,WAAW,EAAE,QAAQ;SACtB,CAAC;KACH;AAED;;AAEG;IACO,OAAO,eAAe,GAA2B,CACzD,MAAa,EACb,MAAc,KACZ;AACF,QAAA,MAAM,IAAI,KAAK,CACb,mIAAmI,CACpI,CAAC;AACJ,KAAC,CAAC;AAEF;;AAEG;AACI,IAAA,WAAW,OAAO,GAAA;QACvB,OAAO;AACL;;AAEG;YACH,MAAM,EAAE,OACN,IAAY,EACZ,iBAAyC,IAAI,CAAC,eAAe,KAC3D;gBACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE;oBAC7B,MAAO,IAAY,CAAC,MAAM,CAAC,cAAc,CAACC,WAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AACtD,iBAAA;aACF;SACF,CAAC;KACH;"}

package/cjs/model/crud-model.d.ts

@@ -0,0 +1,117 @@
+import { BaseModel } from "./base-model";
+import type { ChildModel, ChunkCallback, Document, Filter, FindOrCreateOptions, PaginationListing, PrimaryIdType } from "./types";
+export declare abstract class CrudModel extends BaseModel {
+    /**
+     * Create a new record in the database for the current model (child class of this one)
+     * and return a new instance of it with the created data and the new generated id
+     */
+    static create<T>(this: ChildModel<T>, data: Document): Promise<T>;
+    /**
+     * Called before creating a new record
+     */
+    protected beforeCreating<T>(this: ChildModel<T>, _data: Document): Promise<void>;
+    /**
+     * Called after creating a new record
+     */
+    protected onCreate<T>(this: ChildModel<T>): Promise<void>;
+    /**
+     * Update model by the given id
+     */
+    static update<T>(this: ChildModel<T>, id: PrimaryIdType, data: Document): Promise<T | null>;
+    /**
+     * Replace the entire document for the given document id with the given new data
+     */
+    static replace<T>(this: ChildModel<T>, id: PrimaryIdType, data: Document): Promise<T | null>;
+    /**
+     * Restore the document from trash
+     */
+    static restore<T>(this: ChildModel<T>, id: PrimaryIdType): Promise<T | null>;
+    /**
+     * Restore all documents from trash or by the given filter
+     */
+    static restoreAll<T>(this: ChildModel<T>, filter?: Filter): Promise<any>;
+    /**
+     * Get deleted document by id
+     */
+    static getDeleted<T>(this: ChildModel<T>, id: PrimaryIdType): Promise<T | null>;
+    /**
+     * Get all deleted documents
+     */
+    static getAllDeleted<T>(this: ChildModel<T>, filter?: Filter): Promise<any>;
+    /**
+     * Find and update the document for the given filter with the given data or create a new document/record
+     * if filter has no matching
+     */
+    static upsert<T>(this: ChildModel<T>, filter: Filter, data: Document): Promise<T>;
+    /**
+     * Find document by id
+     */
+    static find<T>(this: ChildModel<T>, id: PrimaryIdType): Promise<T>;
+    /**
+     * Find document by the given column and value
+     */
+    static findBy<T>(this: ChildModel<T>, column: string, value: any): Promise<T | null>;
+    /**
+     * Create an explain plan for the given filter
+     */
+    static explain<T>(this: ChildModel<T>, filter?: Filter): Promise<any>;
+    /**
+     * List multiple documents based on the given filter
+     */
+    static list<T>(this: ChildModel<T>, filter?: Filter): Promise<T[]>;
+    /**
+     * Paginate records based on the given filter
+     */
+    static paginate<T>(this: ChildModel<T>, filter: Filter, page?: number, limit?: number): Promise<PaginationListing<T>>;
+    /**
+     * Find or create a new document based on the given filter and data
+     * If the document is not found, it will be created
+     * otherwise, just return the found document
+     */
+    static findOrCreate<T>(this: ChildModel<T>, filter: Filter, data: Document, { merge }?: FindOrCreateOptions): Promise<T>;
+    /**
+     * Update or create a new document based on the given filter and data
+     */
+    static updateOrCreate<T>(this: ChildModel<T>, filter: Filter, data: Document): Promise<T>;
+    /**
+     * Count total documents based on the given filter
+     */
+    static count(filter?: Filter): Promise<any>;
+    /**
+     * Get first model for the given filter
+     */
+    static first<T>(this: ChildModel<T>, filter?: Filter): Promise<T | null>;
+    /**
+     * Get last model for the given filter
+     */
+    static last<T>(this: ChildModel<T>, filter?: Filter): Promise<T | null>;
+    /**
+     * Get latest documents
+     */
+    static latest<T>(this: ChildModel<T>, filter?: Filter): Promise<T[]>;
+    /**
+     * Delete single document if the given filter is an ObjectId of mongodb
+     * Otherwise, delete multiple documents based on the given filter object
+     */
+    static delete<T>(this: ChildModel<T>, filter?: PrimaryIdType | Filter): Promise<number>;
+    /**
+     * Chunk the documents
+     */
+    static chunk<T>(this: ChildModel<T>, limit: number, callback: ChunkCallback<T>): Promise<void>;
+    static chunk<T>(this: ChildModel<T>, filter: Filter & {
+        limit: number;
+    }, callback: ChunkCallback<T>): Promise<void>;
+    /**
+     * Check if document exists for the given filter
+     */
+    static exists<T>(this: ChildModel<T>, filter?: Filter): Promise<boolean>;
+    /**
+     * Get distinct values for the given column
+     */
+    static distinct<T>(this: ChildModel<T>, column: string, filter?: Filter): Promise<any[]>;
+    /**
+     * Prepare filters
+     */
+    protected static prepareFilters(filters?: Filter): Promise<Filter>;
+}
+//# sourceMappingURL=crud-model.d.ts.map

package/cjs/model/crud-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud-model.d.ts","sourceRoot":"","sources":["../../src/model/crud-model.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EACV,UAAU,EACV,aAAa,EACb,QAAQ,EACR,MAAM,EACN,mBAAmB,EAEnB,iBAAiB,EACjB,aAAa,EACd,MAAM,SAAS,CAAC;AAGjB,8BAAsB,SAAU,SAAQ,SAAS;IAC/C;;;OAGG;WACiB,MAAM,CAAC,CAAC,EAC1B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,IAAI,EAAE,QAAQ,GACb,OAAO,CAAC,CAAC,CAAC;IAWb;;OAEG;cACa,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ;IAItE;;OAEG;cACa,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IAI/C;;OAEG;WACiB,MAAM,CAAC,CAAC,EAC1B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,QAAQ,GACb,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAWpB;;OAEG;WACiB,OAAO,CAAC,CAAC,EAC3B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,QAAQ,GACb,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAYpB;;OAEG;WACiB,OAAO,CAAC,CAAC,EAC3B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IA2CpB;;OAEG;WACiB,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM;IAiDtE;;OAEG;WACiB,UAAU,CAAC,CAAC,EAC9B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IA8BpB;;OAEG;WACiB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM;IA2BzE;;;OAGG;WACiB,MAAM,CAAC,CAAC,EAC1B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,QAAQ,GACb,OAAO,CAAC,CAAC,CAAC;IAgBb;;OAEG;WACiB,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,aAAa;IAUlE;;OAEG;WACiB,MAAM,CAAC,CAAC,EAC1B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,GAAG,GACT,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAWpB;;OAEG;WACiB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,GAAE,MAAW;IAOvE;;OAEG;WACiB,IAAI,CAAC,CAAC,EACxB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,GAAE,MAAW,GAClB,OAAO,CAAC,CAAC,EAAE,CAAC;IASf;;OAEG;WACiB,QAAQ,CAAC,CAAC,EAC5B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,SAAI,EACR,KAAK,SAAK,GACT,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IA0BhC;;;;OAIG;WACiB,YAAY,CAAC,CAAC,EAChC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,QAAQ,EACd,EAAE,KAAa,EAAE,GAAE,mBAAwB,GAC1C,OAAO,CAAC,CAAC,CAAC;IAgBb;;OAEG;WACiB,cAAc,CAAC,CAAC,EAClC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,QAAQ,GACb,OAAO,CAAC,CAAC,CAAC;IAgBb;;OAEG;WACiB,KAAK,CAAC,MAAM,GAAE,MAAW;IAO7C;;OAEG;WACiB,KAAK,CAAC,CAAC,EACzB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,GAAE,MAAW,GAClB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IASpB;;OAEG;WACiB,IAAI,CAAC,CAAC,EACxB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,GAAE,MAAW,GAClB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IASpB;;OAEG;WACiB,MAAM,CAAC,CAAC,EAC1B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,GAAE,MAAW,GAClB,OAAO,CAAC,CAAC,EAAE,CAAC;IASf;;;OAGG;WACiB,MAAM,CAAC,CAAC,EAC1B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,GAAE,aAAa,GAAG,MAAW,GAClC,OAAO,CAAC,MAAM,CAAC;IAqBlB;;OAEG;WACiB,KAAK,CAAC,CAAC,EACzB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,IAAI,CAAC;WACI,KAAK,CAAC,CAAC,EACzB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,GAAG;QACf,KAAK,EAAE,MAAM,CAAC;KACf,EACD,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;OAEG;WACiB,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,GAAE,MAAW;IAOtE;;OAEG;WACiB,QAAQ,CAAC,CAAC,EAC5B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,MAAW,GAClB,OAAO,CAAC,GAAG,EAAE,CAAC;IAQjB;;OAEG;qBACoB,cAAc,CAAC,OAAO,GAAE,MAAW;CAoB3D"}