@warlock.js/cascade 1.0.0

package/esm/model/ModelSync.js

@@ -0,0 +1,215 @@
+import {areEqual}from'@mongez/reinforcements';class ModelSync {
+    model;
+    columns;
+    embedMethod;
+    /**
+     * What do do when model is deleted
+     */
+    whenDelete = "unset";
+    /**
+     * Embed on create
+     */
+    embedOnCreate = "";
+    /**
+     * Sync mode
+     */
+    syncMode = "single";
+    /**
+     * Query runner using `when` method
+     */
+    queryRunner;
+    /**
+     * Define when should the synced model starts to update when any of the given columns is updated in the original model
+     */
+    _updateWhenChange;
+    /**
+     * Constructor
+     */
+    constructor(model, columns, embedMethod = "embedData") {
+        this.model = model;
+        this.columns = columns;
+        this.embedMethod = embedMethod;
+        //
+    }
+    /**
+     * Define when should the synced model starts to update when any of the given columns is updated in the original model
+     */
+    updateWhenChange(columns) {
+        this._updateWhenChange = Array.isArray(columns) ? columns : [columns];
+        return this;
+    }
+    /**
+     * Set query runner
+     */
+    where(queryRunner) {
+        this.queryRunner = queryRunner;
+        return this;
+    }
+    /**
+     * Unset on delete
+     */
+    unsetOnDelete() {
+        this.whenDelete = "unset";
+        return this;
+    }
+    /**
+     * Ignore on delete
+     */
+    ignoreOnDelete() {
+        this.whenDelete = "ignore";
+        return this;
+    }
+    /**
+     * Remove all matched documents on delete to be fully deleted
+     */
+    removeOnDelete() {
+        this.whenDelete = "remove";
+        return this;
+    }
+    /**
+     * Embed on create to injected model one the original model is created
+     */
+    embedOnCreateFrom(column) {
+        this.embedOnCreate = column;
+        return this;
+    }
+    /**
+     * Mark as many sync
+     */
+    syncMany() {
+        this.syncMode = "many";
+        return this;
+    }
+    /**
+     * Start syncing the model
+     */
+    async sync(model, saveMode, oldModel) {
+        if (saveMode === "update") {
+            return this.syncUpdate(model, oldModel);
+        }
+        if (!this.embedOnCreate)
+            return;
+        const columns = Array.isArray(this.columns) ? this.columns : [this.columns];
+        const syncedModel = await this.model.first({
+            id: model.get(this.embedOnCreate + ".id"),
+        });
+        if (!syncedModel)
+            return;
+        try {
+            const modelData = typeof model[this.embedMethod] !== "undefined"
+                ? model[this.embedMethod]
+                : model.data;
+            for (const column of columns) {
+                if (this.syncMode === "single") {
+                    syncedModel.set(column, modelData);
+                }
+                else {
+                    syncedModel.associate(column, modelData);
+                }
+            }
+            await syncedModel.save();
+        }
+        catch (error) {
+            console.log("Error in Sync", error.message);
+            console.log(model);
+            throw error;
+        }
+    }
+    /**
+     * Sync update
+     */
+    async syncUpdate(model, oldModel) {
+        if (this._updateWhenChange && oldModel) {
+            // now check if any of the columns has changed
+            // if all of them are the same, then we don't need to update
+            if (this._updateWhenChange.every(column => areEqual(model.get(column), oldModel.get(column)))) {
+                return;
+            }
+        }
+        const columns = Array.isArray(this.columns) ? this.columns : [this.columns];
+        const whereOptions = {};
+        for (const column of columns) {
+            whereOptions[column + ".id"] = model.id;
+        }
+        const query = this.model.aggregate().orWhere(whereOptions);
+        if (this.queryRunner) {
+            this.queryRunner(query);
+        }
+        const models = await query.get();
+        try {
+            const modelData = typeof model[this.embedMethod] !== "undefined"
+                ? model[this.embedMethod]
+                : model.embeddedData;
+            for (const updatingModel of models) {
+                for (const column of columns) {
+                    if (this.syncMode === "single") {
+                        updatingModel.set(column, modelData);
+                    }
+                    else {
+                        if (column.includes(".")) {
+                            // if column includes dot, then it's a nested column
+                            // so we need to get the top document key as it should be an array.
+                            const [topKey, nestedKey] = column.split(".");
+                            const documentsList = updatingModel.get(topKey) || [];
+                            // as we're updating, so there should be at least one document
+                            if (documentsList?.length === 0)
+                                continue;
+                            // now we need to find the document that has the same id as the model we're updating
+                            const documentIndex = documentsList.findIndex((document) => document[nestedKey]?.id === model.get("id"));
+                            // if document is not found, then we don't need to update
+                            if (documentIndex === -1)
+                                continue;
+                            // now we need to update the document
+                            documentsList[documentIndex][nestedKey] = modelData;
+                            // and finally set the updated documents list
+                            updatingModel.set(topKey, documentsList);
+                        }
+                        else {
+                            // otherwise, it is a direct column update so we can just set it
+                            updatingModel.reassociate(column, modelData);
+                        }
+                    }
+                }
+                // disable casting so we can save the data as it is
+                await updatingModel.save(undefined, {
+                    cast: false,
+                });
+            }
+        }
+        catch (error) {
+            console.log("Error in Sync", error.message);
+            console.log(model);
+            throw error;
+        }
+    }
+    /**
+     * Sync model destruction
+     */
+    async syncDestruction(model) {
+        const columns = Array.isArray(this.columns) ? this.columns : [this.columns];
+        const query = {};
+        for (const column of columns) {
+            query[column + ".id"] = model.get("id");
+        }
+        const models = await this.model
+            .aggregate()
+            .orWhere(query)
+            .get();
+        for (const currentModel of models) {
+            if (this.whenDelete === "unset") {
+                for (const column of columns) {
+                    if (this.syncMode === "single") {
+                        currentModel.unset(column);
+                    }
+                    else {
+                        currentModel.disassociate(column, model);
+                    }
+                }
+                await currentModel.save();
+            }
+            else if (this.whenDelete === "remove") {
+                await currentModel.destroy();
+            }
+        }
+    }
+}export{ModelSync};//# sourceMappingURL=ModelSync.js.map

package/esm/model/ModelSync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelSync.js","sources":["../../src/model/ModelSync.ts"],"sourcesContent":[null],"names":[],"mappings":"oDAMa,SAAS,CAAA;AA8BR,IAAA,KAAA,CAAA;AACA,IAAA,OAAA,CAAA;AACA,IAAA,WAAA,CAAA;AA/BZ;;AAEG;IACO,UAAU,GAAa,OAAO,CAAC;AAEzC;;AAEG;IACO,aAAa,GAAG,EAAE,CAAC;AAE7B;;AAEG;IACO,QAAQ,GAAsB,QAAQ,CAAC;AAEjD;;AAEG;AACO,IAAA,WAAW,CAA0C;AAE/D;;AAEG;AACO,IAAA,iBAAiB,CAAY;AAEvC;;AAEG;AACH,IAAA,WAAA,CACY,KAAmB,EACnB,OAA0B,EAC1B,cAAc,WAAW,EAAA;QAFzB,IAAK,CAAA,KAAA,GAAL,KAAK,CAAc;QACnB,IAAO,CAAA,OAAA,GAAP,OAAO,CAAmB;QAC1B,IAAW,CAAA,WAAA,GAAX,WAAW,CAAc;;KAGpC;AAED;;AAEG;AACI,IAAA,gBAAgB,CAAC,OAA0B,EAAA;AAChD,QAAA,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;AAEtE,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;AACI,IAAA,KAAK,CAAC,WAAmD,EAAA;AAC9D,QAAA,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;AAE/B,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;IACI,aAAa,GAAA;AAClB,QAAA,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;AAE1B,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;IACI,cAAc,GAAA;AACnB,QAAA,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;AAE3B,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;IACI,cAAc,GAAA;AACnB,QAAA,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;AAE3B,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;AACI,IAAA,iBAAiB,CAAC,MAAc,EAAA;AACrC,QAAA,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;AAE5B,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;IACI,QAAQ,GAAA;AACb,QAAA,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;AAEvB,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;AACI,IAAA,MAAM,IAAI,CACf,KAAY,EACZ,QAA6B,EAC7B,QAAgB,EAAA;QAEhB,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACzC,SAAA;QAED,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,OAAO;QAEhC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5E,MAAM,WAAW,GAAU,MAAO,IAAI,CAAC,KAAa,CAAC,KAAK,CAAC;YACzD,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;AAC1C,SAAA,CAAC,CAAC;AAEH,QAAA,IAAI,CAAC,WAAW;YAAE,OAAO;QAEzB,IAAI;YACF,MAAM,SAAS,GACb,OAAQ,KAAa,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,WAAW;AACrD,kBAAG,KAAa,CAAC,IAAI,CAAC,WAAW,CAAC;AAClC,kBAAE,KAAK,CAAC,IAAI,CAAC;AAEjB,YAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAC5B,gBAAA,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE;AAC9B,oBAAA,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AACpC,iBAAA;AAAM,qBAAA;AACL,oBAAA,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAC1C,iBAAA;AACF,aAAA;AAED,YAAA,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;AAC1B,SAAA;AAAC,QAAA,OAAO,KAAU,EAAE;YACnB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;AAC5C,YAAA,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACnB,YAAA,MAAM,KAAK,CAAC;AACb,SAAA;KACF;AAED;;AAEG;AACI,IAAA,MAAM,UAAU,CAAC,KAAY,EAAE,QAAgB,EAAA;AACpD,QAAA,IAAI,IAAI,CAAC,iBAAiB,IAAI,QAAQ,EAAE;;;YAGtC,IACE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,MAAM,IACjC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAClD,EACD;gBACA,OAAO;AACR,aAAA;AACF,SAAA;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5E,MAAM,YAAY,GAAQ,EAAE,CAAC;AAE7B,QAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,YAAY,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC;AACzC,SAAA;AAED,QAAA,MAAM,KAAK,GAAI,IAAI,CAAC,KAAa,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAEpE,IAAI,IAAI,CAAC,WAAW,EAAE;AACpB,YAAA,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AACzB,SAAA;AAED,QAAA,MAAM,MAAM,GAAY,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;QAE1C,IAAI;YACF,MAAM,SAAS,GACb,OAAQ,KAAa,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,WAAW;AACrD,kBAAG,KAAa,CAAC,IAAI,CAAC,WAAW,CAAC;AAClC,kBAAE,KAAK,CAAC,YAAY,CAAC;AAEzB,YAAA,KAAK,MAAM,aAAa,IAAI,MAAM,EAAE;AAClC,gBAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAC5B,oBAAA,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE;AAC9B,wBAAA,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AACtC,qBAAA;AAAM,yBAAA;AACL,wBAAA,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;;;AAGxB,4BAAA,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;4BAC9C,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;;AAEtD,4BAAA,IAAI,aAAa,EAAE,MAAM,KAAK,CAAC;gCAAE,SAAS;;4BAE1C,MAAM,aAAa,GAAG,aAAa,CAAC,SAAS,CAC3C,CAAC,QAAa,KAAK,QAAQ,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAC/D,CAAC;;4BAEF,IAAI,aAAa,KAAK,CAAC,CAAC;gCAAE,SAAS;;4BAGnC,aAAa,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;;AAGpD,4BAAA,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAC1C,yBAAA;AAAM,6BAAA;;AAEL,4BAAA,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAC9C,yBAAA;AACF,qBAAA;AACF,iBAAA;;AAGD,gBAAA,MAAM,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE;AAClC,oBAAA,IAAI,EAAE,KAAK;AACZ,iBAAA,CAAC,CAAC;AACJ,aAAA;AACF,SAAA;AAAC,QAAA,OAAO,KAAU,EAAE;YACnB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;AAC5C,YAAA,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACnB,YAAA,MAAM,KAAK,CAAC;AACb,SAAA;KACF;AAED;;AAEG;IACI,MAAM,eAAe,CAAC,KAAY,EAAA;QACvC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE5E,MAAM,KAAK,GAAQ,EAAE,CAAC;AAEtB,QAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAC5B,YAAA,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACzC,SAAA;AAED,QAAA,MAAM,MAAM,GAAY,MAAO,IAAI,CAAC,KAAa;AAC9C,aAAA,SAAS,EAAE;aACX,OAAO,CAAC,KAAK,CAAC;AACd,aAAA,GAAG,EAAE,CAAC;AAET,QAAA,KAAK,MAAM,YAAY,IAAI,MAAM,EAAE;AACjC,YAAA,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE;AAC/B,gBAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;AAC5B,oBAAA,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE;AAC9B,wBAAA,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC5B,qBAAA;AAAM,yBAAA;AACL,wBAAA,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC1C,qBAAA;AACF,iBAAA;AAED,gBAAA,MAAM,YAAY,CAAC,IAAI,EAAE,CAAC;AAC3B,aAAA;AAAM,iBAAA,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,EAAE;AACvC,gBAAA,MAAM,YAAY,CAAC,OAAO,EAAE,CAAC;AAC9B,aAAA;AACF,SAAA;KACF;AACF"}

package/esm/model/RelationshipWithMany.d.ts

@@ -0,0 +1,29 @@
+import { GenericObject } from "@mongez/reinforcements";
+import { Model } from "./model";
+import { Filter } from "./types";
+export declare class RelationshipWithMany<T> {
+    protected model: Model;
+    protected relatedModel: typeof Model;
+    protected column: string;
+    /**
+     * Constructor
+     */
+    constructor(model: Model, relatedModel: typeof Model, column: string);
+    /**
+     * Add the given model to the relationship
+     */
+    add(model: Model | GenericObject): Promise<void>;
+    /**
+     * Create and add the given model to the relationship
+     */
+    create(data: any): Promise<Model>;
+    /**
+     * Remove the given model from the relationship
+     */
+    remove(model: Model): Promise<void>;
+    /**
+     * Get all related models
+     */
+    list(filter?: Filter): Promise<T[]>;
+}
+//# sourceMappingURL=RelationshipWithMany.d.ts.map

package/esm/model/RelationshipWithMany.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipWithMany.d.ts","sourceRoot":"","sources":["../../src/model/RelationshipWithMany.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAEhD,qBAAa,oBAAoB,CAAC,CAAC;IAK/B,SAAS,CAAC,KAAK,EAAE,KAAK;IACtB,SAAS,CAAC,YAAY,EAAE,OAAO,KAAK;IACpC,SAAS,CAAC,MAAM,EAAE,MAAM;IAN1B;;OAEG;gBAES,KAAK,EAAE,KAAK,EACZ,YAAY,EAAE,OAAO,KAAK,EAC1B,MAAM,EAAE,MAAM;IAK1B;;OAEG;IACU,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,aAAa;IAU7C;;OAEG;IACU,MAAM,CAAC,IAAI,EAAE,GAAG;IAM7B;;OAEG;IACU,MAAM,CAAC,KAAK,EAAE,KAAK;IAIhC;;OAEG;IACU,IAAI,CAAC,MAAM,GAAE,MAAW;CAiBtC"}

package/esm/model/RelationshipWithMany.js

@@ -0,0 +1,52 @@
+import {Model}from'./model.js';class RelationshipWithMany {
+    model;
+    relatedModel;
+    column;
+    /**
+     * Constructor
+     */
+    constructor(model, relatedModel, column) {
+        this.model = model;
+        this.relatedModel = relatedModel;
+        this.column = column;
+        //
+    }
+    /**
+     * Add the given model to the relationship
+     */
+    async add(model) {
+        if (model instanceof Model === false) {
+            model = new this.relatedModel(model);
+        }
+        await model.save();
+        await this.model.associate(this.column, model).save();
+    }
+    /**
+     * Create and add the given model to the relationship
+     */
+    async create(data) {
+        data[this.column] = this.model.id;
+        return await this.relatedModel.create(data);
+    }
+    /**
+     * Remove the given model from the relationship
+     */
+    async remove(model) {
+        await this.model.disassociate(this.column, model).save();
+    }
+    /**
+     * Get all related models
+     */
+    async list(filter = {}) {
+        const embeddedDocuments = this.model.get(this.column) || [];
+        const embeddedDocumentsIds = embeddedDocuments.map(
+        // because it may be an array of ids or an array of documents
+        (document) => document.id || document);
+        const documents = (await this.relatedModel.list({
+            id: embeddedDocumentsIds,
+            ...filter,
+        }));
+        this.model.set(this.column, documents);
+        return documents;
+    }
+}export{RelationshipWithMany};//# sourceMappingURL=RelationshipWithMany.js.map

package/esm/model/RelationshipWithMany.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipWithMany.js","sources":["../../src/model/RelationshipWithMany.ts"],"sourcesContent":[null],"names":[],"mappings":"qCAIa,oBAAoB,CAAA;AAKnB,IAAA,KAAA,CAAA;AACA,IAAA,YAAA,CAAA;AACA,IAAA,MAAA,CAAA;AANZ;;AAEG;AACH,IAAA,WAAA,CACY,KAAY,EACZ,YAA0B,EAC1B,MAAc,EAAA;QAFd,IAAK,CAAA,KAAA,GAAL,KAAK,CAAO;QACZ,IAAY,CAAA,YAAA,GAAZ,YAAY,CAAc;QAC1B,IAAM,CAAA,MAAA,GAAN,MAAM,CAAQ;;KAGzB;AAED;;AAEG;IACI,MAAM,GAAG,CAAC,KAA4B,EAAA;AAC3C,QAAA,IAAI,KAAK,YAAY,KAAK,KAAK,KAAK,EAAE;YACpC,KAAK,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AACtC,SAAA;AAED,QAAA,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;AAEnB,QAAA,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;KACvD;AAED;;AAEG;IACI,MAAM,MAAM,CAAC,IAAS,EAAA;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAElC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;KAC7C;AAED;;AAEG;IACI,MAAM,MAAM,CAAC,KAAY,EAAA;AAC9B,QAAA,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;KAC1D;AAED;;AAEG;AACI,IAAA,MAAM,IAAI,CAAC,MAAA,GAAiB,EAAE,EAAA;AACnC,QAAA,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;AAE5D,QAAA,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,GAAG;;QAEhD,CAAC,QAAuB,KAAK,QAAQ,CAAC,EAAE,IAAI,QAAQ,CACrD,CAAC;QAEF,MAAM,SAAS,IAAI,MAAO,IAAI,CAAC,YAAoB,CAAC,IAAI,CAAC;AACvD,YAAA,EAAE,EAAE,oBAAoB;AACxB,YAAA,GAAG,MAAM;AACV,SAAA,CAAC,CAAQ,CAAC;QAEX,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEvC,QAAA,OAAO,SAAS,CAAC;KAClB;AACF"}

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

@@ -0,0 +1,148 @@
+import { type Database } from "../database";
+import type { Model } from "./model";
+import { ModelEvents } from "./model-events";
+import { FactoryCreatorCallback, 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 primaryIdColumn: string;
+    /**
+     * 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(): number;
+    /**
+     * Get initial id
+     */
+    static getInitialId(): number;
+    /**
+     * 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/esm/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,EACL,sBAAsB,EACtB,mBAAmB,EACnB,KAAK,UAAU,EACf,KAAK,QAAQ,EACd,MAAM,SAAS,CAAC;AAejB,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,OAAc,eAAe,SAAQ;IAErC;;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;IAO9B;;OAEG;WACW,YAAY;IAO1B;;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/esm/model/base-model.js

@@ -0,0 +1,212 @@
+import {faker}from'@faker-js/faker';import {Random,clone}from'@mongez/reinforcements';import {modelBlueprint}from'../blueprint/model-blueprint.js';import {database}from'../database.js';import {query}from'../query/query.js';import {masterMind}from'./master-mind.js';import {ModelEvents}from'./model-events.js';import {ModelDeleteStrategy}from'./types.js';const modelEvents = new Map();
+const getModelEvent = (collection) => {
+    let eventsInstance = modelEvents.get(collection);
+    if (!eventsInstance) {
+        eventsInstance = new ModelEvents(collection);
+        modelEvents.set(collection, eventsInstance);
+    }
+    return eventsInstance;
+};
+class BaseModel {
+    /**
+     * Collection Name
+     */
+    static collection;
+    /**
+     * Connection instance
+     */
+    static 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 primaryIdColumn = "id";
+    /**
+     * Query instance
+     */
+    static query = query;
+    /**
+     * Define the delete method
+     *
+     * @default true
+     */
+    static deleteStrategy = 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;
+        // return Random number
+        return Random.int(1, 999);
+    }
+    /**
+     * Get initial id
+     */
+    static getInitialId() {
+        if (this.initialId)
+            return this.initialId;
+        // return Random number
+        return Random.int(10000, 499999);
+    }
+    /**
+     * Generate next id
+     */
+    static async genNextId() {
+        return await masterMind.generateNextId(this.collection, this.getIncrementIdBy(), this.getInitialId());
+    }
+    /**
+     * Get last id of current model
+     */
+    static async getLastId() {
+        return await 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(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(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, i));
+                }
+            },
+        };
+    }
+}export{BaseModel};//# sourceMappingURL=base-model.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"base-model.js","sources":["../../src/model/base-model.ts"],"sourcesContent":[null],"names":[],"mappings":"kWAeA,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,IAAI,WAAW,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,GAAa,QAAQ,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,OAAO,eAAe,GAAG,IAAI,CAAC;AAErC;;AAEG;AACI,IAAA,OAAO,KAAK,GAAG,KAAK,CAAC;AAE5B;;;;AAIG;AACI,IAAA,OAAO,cAAc,GAC1B,mBAAmB,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;;QAGlD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;KAC3B;AAED;;AAEG;AACI,IAAA,OAAO,YAAY,GAAA;QACxB,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC;;QAG1C,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;KAClC;AAED;;AAEG;IACI,aAAa,SAAS,GAAA;AAC3B,QAAA,OAAO,MAAM,UAAU,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,MAAM,UAAU,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,CAAC,KAAK,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,OAAO,cAAc,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,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AACtD,iBAAA;aACF;SACF,CAAC;KACH;"}