@webda/core 3.5.0 → 3.7.0

package/lib/stores/store.d.ts

@@ -1,6 +1,6 @@
 import { Counter, EventWithContext, Histogram } from "../core.js";
 import { ConfigurationProvider, WebdaError } from "../index.js";
-import { Constructor, CoreModel, CoreModelDefinition, FilterKeys } from "../models/coremodel.js";
+import { Constructor, CoreModel, CoreModelDefinition, FilterAttributes } from "../models/coremodel.js";
 import { Service, ServiceParameters } from "../services/service.js";
 import { OperationContext, WebContext } from "../utils/context.js";
 import { HttpMethodType } from "../utils/httpcontext.js";
@@ -358,6 +358,14 @@ export declare class StoreParameters extends ServiceParameters {
      * @default "Webda/CoreModel"
      */
     model?: string;
+    /**
+     * Additional models
+     *
+     * Allow this store to manage other models
+     *
+     * @default []
+     */
+    additionalModels?: string[];
     /**
      * async delete
      */
@@ -594,10 +602,10 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param info
      * @returns
      */
-    incrementAttributes<FK extends FilterKeys<T, number>>(uid: string, info: {
+    incrementAttributes<FK extends FilterAttributes<T, number>>(uid: string, info: {
         property: FK;
         value: number;
-    }[]): Promise<any[]>;
+    }[]): Promise<Date>;
     /**
      * Helper function that call incrementAttributes
      * @param uid
@@ -605,7 +613,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param value
      * @returns
      */
-    incrementAttribute<FK extends FilterKeys<T, number>>(uid: string, prop: FK, value: number): Promise<any[]>;
+    incrementAttribute<FK extends FilterAttributes<T, number>>(uid: string, prop: FK, value: number): Promise<Date>;
     /**
      * Add or update an item to an array in the model
      *
@@ -616,7 +624,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param itemWriteCondition value of the condition to test (in case of update)
      * @param itemWriteConditionField field to read the condition from (in case of update)
      */
-    upsertItemToCollection<FK extends FilterKeys<T, Array<any>>>(uid: string, prop: FK, item: any, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
+    upsertItemToCollection<FK extends FilterAttributes<T, Array<any>>>(uid: string, prop: FK, item: any, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<Date>;
     /**
      * Remove an item from an array in the model
      *
@@ -626,15 +634,25 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param itemWriteCondition value of the condition
      * @param itemWriteConditionField field to read the condition from
      */
-    deleteItemFromCollection<FK extends FilterKeys<T, Array<any>>>(uid: string, prop: FK, index: number, itemWriteCondition: any, itemWriteConditionField?: string): Promise<void>;
+    deleteItemFromCollection<FK extends FilterAttributes<T, Array<any>>>(uid: string, prop: FK, index: number, itemWriteCondition: any, itemWriteConditionField?: string): Promise<Date>;
     /**
-     * Get all results without pagination
+     * Iterate through the results
      *
      * This can be resource consuming
      *
      * @param query
      * @param context
      */
+    iterate(query?: string, context?: OperationContext): AsyncGenerator<T>;
+    /**
+     * Query all the results
+     *
+     *
+     * @param query
+     * @param context
+     * @returns
+     * @deprecated use iterate instead
+     */
     queryAll(query: string, context?: OperationContext): Promise<T[]>;
     /**
      * Check that __type Comparison is only used with = and CONTAINS
@@ -695,7 +713,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param condition
      * @param uid
      */
-    checkCollectionUpdateCondition<FK extends FilterKeys<T, Array<any>>, CK extends keyof T>(model: T, collection: FK, conditionField?: CK, condition?: any, index?: number): void;
+    checkCollectionUpdateCondition<FK extends FilterAttributes<T, Array<any>>, CK extends keyof T>(model: T, collection: FK, conditionField?: CK, condition?: any, index?: number): void;
     /**
      * Update conditionally
      * @param uuid
@@ -714,7 +732,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param itemWriteConditionField
      * @param updateDate
      */
-    simulateUpsertItemToCollection<FK extends FilterKeys<T, Array<any>>>(model: T, prop: FK, item: any, updateDate: Date, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
+    simulateUpsertItemToCollection<FK extends FilterAttributes<T, Array<any>>>(model: T, prop: FK, item: any, updateDate: Date, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
     /**
      * Update an object
      *

package/lib/stores/store.js

@@ -57,6 +57,7 @@ export class StoreParameters extends ServiceParameters {
         this.forceModel ?? (this.forceModel = false);
         this.slowQueryThreshold ?? (this.slowQueryThreshold = 30000);
         this.modelAliases ?? (this.modelAliases = {});
+        this.additionalModels ?? (this.additionalModels = []);
     }
 }
 /**
@@ -139,6 +140,21 @@ class Store extends Service {
         if (!this.parameters.strict) {
             recursive(this._model.getHierarchy().children, 1);
         }
+        // Add additional models
+        if (this.parameters.additionalModels.length) {
+            // Strict mode is to only allow one model per store
+            if (this.parameters.strict) {
+                this.log("ERROR", "Cannot add additional models in strict mode");
+            }
+            else {
+                for (let modelType of this.parameters.additionalModels) {
+                    const model = app.getModel(modelType);
+                    this._modelsHierarchy[model.getIdentifier(false)] = 0;
+                    this._modelsHierarchy[model.getIdentifier()] = 0;
+                    recursive(model.getHierarchy().children, 1);
+                }
+            }
+        }
         if (this.getParameters().expose) {
             this.log("WARN", "Exposing a store is not recommended, use a DomainService instead to expose all your CoreModel");
         }
@@ -306,16 +322,16 @@ class Store extends Service {
                 let executer;
                 if (action.global) {
                     // By default will grab the object and then call the action
-                    if (!this._model[name] && !this._model["_" + name]) {
-                        throw Error("Action static method /_?" + name + "/ does not exist");
+                    if (!this._model[name]) {
+                        throw Error("Action static method " + name + " does not exist");
                     }
                     executer = this.httpGlobalAction;
                     this.addRoute(`./${name}`, action.methods, executer, action.openapi);
                 }
                 else {
                     // By default will grab the object and then call the action
-                    if (!this._model.prototype[name] && !this._model.prototype["_" + name]) {
-                        throw Error("Action method /_?" + name + "/ does not exist");
+                    if (!this._model.prototype[name]) {
+                        throw Error("Action method " + name + " does not exist");
                     }
                     executer = this.httpAction;
                     this.addRoute(`./{uuid}/${name}`, action.methods, executer, action.openapi);
@@ -371,12 +387,7 @@ class Store extends Service {
      */
     initModel(object = {}) {
         var _a;
-        if (object instanceof CoreModel) {
-            object.__type ?? (object.__type = this.getWebda().getApplication().getModelFromInstance(object) || this._modelType);
-        }
-        else {
-            object.__type ?? (object.__type = this._modelType);
-        }
+        object.__type ?? (object.__type = this.getWebda().getApplication().getModelFromInstance(object) || this._modelType);
         // Make sure to send a model object
         if (!(object instanceof this._model)) {
             // Dynamic load type
@@ -391,11 +402,11 @@ class Store extends Service {
                     if (!this.parameters.defaultModel) {
                         throw new Error(`Unknown model ${object.__type} found for Store(${this.getName()})`);
                     }
-                    object = this._model.factory(this._model, object);
+                    object = this._model.factory(object);
                 }
             }
             else {
-                object = this._model.factory(this._model, object);
+                object = this._model.factory(object);
             }
         }
         if (!object.getUuid()) {
@@ -455,7 +466,7 @@ class Store extends Service {
         this.metrics.operations_total.inc({ operation: "increment" });
         await this._incrementAttributes(uid, params, updateDate);
         await this._cacheStore?._incrementAttributes(uid, params, updateDate);
-        return this.emitSync("Store.PartialUpdated", {
+        this.emitSync("Store.PartialUpdated", {
             object_id: uid,
             store: this,
             updateDate,
@@ -463,6 +474,7 @@ class Store extends Service {
                 increments: params
             }
         });
+        return updateDate;
     }
     /**
      * Helper function that call incrementAttributes
@@ -501,6 +513,7 @@ class Store extends Service {
                 }
             }
         });
+        return updateDate;
     }
     /**
      * Remove an item from an array in the model
@@ -527,29 +540,48 @@ class Store extends Service {
                 }
             }
         });
+        return updateDate;
     }
     /**
-     * Get all results without pagination
+     * Iterate through the results
      *
      * This can be resource consuming
      *
      * @param query
      * @param context
      */
-    async queryAll(query, context) {
-        const res = [];
+    async *iterate(query = "", context) {
         if (query.includes("OFFSET")) {
-            throw new Error("Cannot contain an OFFSET for queryAll method");
+            throw new Error("Cannot contain an OFFSET for iterate method");
         }
         let continuationToken;
         do {
             let q = query + (continuationToken !== undefined ? ` OFFSET "${continuationToken}"` : "");
             let page = await this.query(q, context);
+            for (let item of page.results) {
+                yield item;
+            }
             continuationToken = page.continuationToken;
-            res.push(...page.results);
         } while (continuationToken);
+    }
+    // REFACTOR . >= 4
+    /**
+     * Query all the results
+     *
+     *
+     * @param query
+     * @param context
+     * @returns
+     * @deprecated use iterate instead
+     */
+    async queryAll(query, context) {
+        let res = [];
+        for await (let item of this.iterate(query, context)) {
+            res.push(item);
+        }
         return res;
     }
+    // END_REFACTOR
     /**
      * Check that __type Comparison is only used with = and CONTAINS
      * If CONTAINS is used, move __type to __types
@@ -718,30 +750,42 @@ class Store extends Service {
     async create(object, ctx = undefined) {
         object = this.initModel(object);
         // Dates should be store by the Store
-        object._creationDate ?? (object._creationDate = new Date());
-        object._lastUpdate = new Date();
+        if (!object._creationDate) {
+            object._creationDate = object._lastUpdate = new Date();
+        }
+        else {
+            object._lastUpdate = new Date();
+        }
         const ancestors = this.getWebda().getApplication().getModelHierarchy(object.__type).ancestors;
         object.__types = [object.__type, ...ancestors].filter(i => i !== "Webda/CoreModel" && i !== "CoreModel");
         if (ctx) {
             object.setContext(ctx);
         }
-        await this.emitSync("Store.Save", {
+        // Handle object auto listener
+        const evt = {
             object: object,
             store: this,
             context: ctx
-        });
-        // Handle object auto listener
-        await object._onSave();
+        };
+        await Promise.all([
+            this.emitSync("Store.Save", evt),
+            object?.__class.emitSync("Store.Save", evt),
+            object._onSave()
+        ]);
         this.metrics.operations_total.inc({ operation: "save" });
         let res = await this._save(object);
         await this._cacheStore?._save(object);
         object = this.initModel(res);
-        await this.emitSync("Store.Saved", {
+        const evtSaved = {
             object: object,
             store: this,
             context: ctx
-        });
-        await object._onSaved();
+        };
+        await Promise.all([
+            this.emitSync("Store.Saved", evtSaved),
+            object?.__class.emitSync("Store.Saved", evtSaved),
+            object._onSaved()
+        ]);
         return object;
     }
     /**
@@ -872,21 +916,16 @@ class Store extends Service {
         if (object instanceof CoreModel) {
             loaded.setContext(object.getContext());
         }
-        if (partial) {
-            await this.emitSync(`Store.PatchUpdate`, {
-                object: loaded,
-                store: this,
-                update: object
-            });
-        }
-        else {
-            await this.emitSync(`Store.Update`, {
-                object: loaded,
-                store: this,
-                update: object
-            });
-        }
-        await loaded._onUpdate(object);
+        const evt = {
+            object: loaded,
+            store: this,
+            update: object
+        };
+        await Promise.all([
+            this.emitSync(partial ? `Store.PatchUpdate` : `Store.Update`, evt),
+            object?.__class?.emitSync(partial ? `Store.PatchUpdate` : `Store.Update`, evt),
+            loaded._onUpdate(object)
+        ]);
         let res;
         if (conditionField !== null) {
             conditionField ?? (conditionField = "_lastUpdate");
@@ -916,19 +955,15 @@ class Store extends Service {
             loaded[i] = object[i];
         }
         saved = this.initModel(loaded);
-        if (partial) {
-            await this.emitSync(`Store.PatchUpdated`, {
-                object: saved,
-                store: this
-            });
-        }
-        else {
-            await this.emitSync(`Store.Updated`, {
-                object: saved,
-                store: this
-            });
-        }
-        await saved._onUpdated();
+        const evtUpdated = {
+            object: saved,
+            store: this
+        };
+        await Promise.all([
+            this.emitSync(partial ? `Store.PatchUpdated` : `Store.Updated`, evtUpdated),
+            saved?.__class.emitSync(partial ? `Store.PatchUpdated` : `Store.Updated`, evtUpdated),
+            saved._onUpdated()
+        ]);
         return saved;
     }
     /**
@@ -1133,12 +1168,16 @@ class Store extends Service {
                 throw new UpdateConditionFailError(to_delete.getUuid(), writeConditionField, writeCondition);
             }
         }
-        // Send preevent
-        await this.emitSync("Store.Delete", {
+        const evt = {
             object: to_delete,
             store: this
-        });
-        await to_delete._onDelete();
+        };
+        // Send preevent
+        await Promise.all([
+            this.emitSync("Store.Delete", evt),
+            to_delete?.__class.emitSync("Store.Delete", evt),
+            to_delete._onDelete()
+        ]);
         // If async we just tag the object as deleted
         if (this.parameters.asyncDelete && !sync) {
             this.metrics.operations_total.inc({ operation: "partialUpdate" });
@@ -1156,11 +1195,15 @@ class Store extends Service {
             await this._cacheStore?._delete(to_delete.getUuid(), writeCondition, writeConditionField);
         }
         // Send post event
-        await this.emitSync("Store.Deleted", {
+        const evtDeleted = {
             object: to_delete,
             store: this
-        });
-        await to_delete._onDeleted();
+        };
+        await Promise.all([
+            this.emitSync("Store.Deleted", evtDeleted),
+            to_delete.__class.emitSync("Store.Deleted", evtDeleted),
+            to_delete._onDeleted()
+        ]);
     }
     /**
      * By default we cannot know if the store will trigger or not
@@ -1224,12 +1267,12 @@ class Store extends Service {
         }
         object = this.initModel(object);
         object.setContext(ctx);
-        await this.emitSync("Store.Get", {
+        const evt = {
             object: object,
             store: this,
             context: ctx
-        });
-        await object._onGet();
+        };
+        await Promise.all([this.emitSync("Store.Get", evt), object.__class.emitSync("Store.Get", evt), object._onGet()]);
         return object;
     }
     /**
@@ -1328,7 +1371,7 @@ class Store extends Service {
     async operationCreate(ctx, model) {
         let body = await ctx.getInput();
         const modelPrototype = this.getWebda().getApplication().getModel(model);
-        let object = modelPrototype.factory(modelPrototype, body, ctx);
+        let object = modelPrototype.factory(body, ctx);
         object._creationDate = new Date();
         await object.checkAct(ctx, "create");
         try {
@@ -1343,12 +1386,13 @@ class Store extends Service {
         }
         await this.save(object, ctx);
         ctx.write(object);
-        await this.emitSync("Store.WebCreate", {
+        const evt = {
             context: ctx,
             values: body,
             object: object,
             store: this
-        });
+        };
+        await Promise.all([object.__class.emitSync("Store.WebCreate", evt), this.emitSync("Store.WebCreate", evt)]);
     }
     /**
      * Handle obect action
@@ -1361,23 +1405,28 @@ class Store extends Service {
             throw new WebdaError.NotFound("Object not found or is deleted");
         }
         await object.checkAct(ctx, action);
-        await this.emitSync("Store.Action", {
+        const evt = {
             action: action,
             object: object,
             store: this,
             context: ctx
-        });
+        };
+        await Promise.all([this.emitSync("Store.Action", evt), object.__class.emitSync("Store.Action", evt)]);
         const res = await object[action](ctx);
         if (res) {
             ctx.write(res);
         }
-        await this.emitSync("Store.Actioned", {
+        const evtActioned = {
             action: action,
             object: object,
             store: this,
             context: ctx,
             result: res
-        });
+        };
+        await Promise.all([
+            this.emitSync("Store.Actioned", evtActioned),
+            object?.__class.emitSync("Store.Actioned", evtActioned)
+        ]);
     }
     /**
      * Handle collection action
@@ -1385,23 +1434,25 @@ class Store extends Service {
      */
     async httpGlobalAction(ctx, model = this._model) {
         let action = ctx.getHttpContext().getUrl().split("/").pop();
-        await this.emitSync("Store.Action", {
+        const evt = {
             action: action,
             store: this,
             context: ctx,
             model
-        });
+        };
+        await Promise.all([this.emitSync("Store.Action", evt), model.emitSync("Store.Action", evt)]);
         const res = await model[action](ctx);
         if (res) {
             ctx.write(res);
         }
-        await this.emitSync("Store.Actioned", {
+        const evtActioned = {
             action: action,
             store: this,
             context: ctx,
             result: res,
             model
-        });
+        };
+        await Promise.all([this.emitSync("Store.Actioned", evtActioned), model?.emitSync("Store.Actioned", evtActioned)]);
     }
     /**
      * Handle HTTP Update for an object
@@ -1457,13 +1508,14 @@ class Store extends Service {
             object = await this.update(updateObject);
         }
         ctx.write(object);
-        await this.emitSync("Store.WebUpdate", {
+        const evt = {
             context: ctx,
             updates: body,
             object: object,
             store: this,
             method: ctx.getHttpContext().getMethod()
-        });
+        };
+        await Promise.all([object?.__class.emitSync("Store.WebUpdate", evt), this.emitSync("Store.WebUpdate", evt)]);
     }
     /**
      * Handle GET on object
@@ -1483,11 +1535,12 @@ class Store extends Service {
         }
         await object.checkAct(ctx, "get");
         ctx.write(object);
-        await this.emitSync("Store.WebGet", {
+        const evt = {
             context: ctx,
             object: object,
             store: this
-        });
+        };
+        await Promise.all([this.emitSync("Store.WebGet", evt), object.__class.emitSync("Store.WebGet", evt)]);
         ctx.write(object);
     }
     /**
@@ -1507,11 +1560,12 @@ class Store extends Service {
         // Might still run into: Have trouble to handle the Content-Length on API Gateway so returning an empty object for now
         ctx.writeHead(204, { "Content-Length": "0" });
         await this.delete(uuid);
-        await this.emitSync("Store.WebDelete", {
+        const evt = {
             context: ctx,
             object_id: uuid,
             store: this
-        });
+        };
+        await Promise.all([this.emitSync("Store.WebDelete", evt), object.__class.emitSync("Store.WebDelete", evt)]);
     }
     /**
      * Return the model uuid field