@ruiapp/rapid-core 0.1.50 → 0.1.52

package/dist/core/server.d.ts

@@ -1,4 +1,4 @@
-import { CreateEntityOptions, GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty, RpdServerEventTypes, UpdateEntityByIdOptions } from "../types";
+import { CreateEntityOptions, EntityWatcherType, GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty, RpdServerEventTypes, UpdateEntityByIdOptions } from "../types";
 import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
 import { Next, RouteContext } from "./routeContext";
 import EntityManager from "../dataAccess/entityManager";
@@ -24,7 +24,8 @@ export interface IRpdServer {
     appendApplicationConfig(config: Partial<RpdApplicationConfig>): any;
     appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]): any;
     getModel(options: GetModelOptions): RpdDataModel | undefined;
-    registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): this;
+    registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): any;
+    registerEntityWatcher(entityWatcher: EntityWatcherType): any;
     emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, payload: RpdServerEventTypes[K][1], sender?: RapidPlugin): void;
     handleRequest(request: Request, next: Next): Promise<Response>;
     beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;

package/dist/index.js

@@ -1804,9 +1804,16 @@ function getEntityPropertiesIncludingBase(server, model) {
     const baseModel = server.getModel({
         singularCode: model.base,
     });
-    baseModel.properties.forEach(prop => prop.isBaseProperty = true);
+    let baseProperties = [];
+    if (baseModel) {
+        baseModel.properties.map((property) => {
+            property = lodash.cloneDeep(property);
+            property.isBaseProperty = true;
+            return property;
+        });
+    }
     return [
-        ...baseModel.properties,
+        ...baseProperties,
         ...model.properties,
     ];
 }
@@ -1823,6 +1830,7 @@ function getEntityProperty(server, model, predicate) {
             });
             property = baseModel.properties.find(predicate);
             if (property) {
+                property = lodash.cloneDeep(property);
                 property.isBaseProperty = true;
             }
         }
@@ -2050,11 +2058,11 @@ async function findEntities(server, dataAccessor, options) {
         pagination: options.pagination,
         fields: columnsToSelect,
     };
-    const entities = await dataAccessor.find(findRowOptions);
-    if (!entities.length) {
+    const rows = await dataAccessor.find(findRowOptions);
+    if (!rows.length) {
         return [];
     }
-    const entityIds = entities.map((e) => e.id);
+    const entityIds = rows.map((row) => row.id);
     if (relationPropertiesToSelect.length) {
         for (const relationProperty of relationPropertiesToSelect) {
             const isManyRelation = relationProperty.relation === "many";
@@ -2065,9 +2073,9 @@ async function findEntities(server, dataAccessor, options) {
                 }
                 if (isManyRelation) {
                     const relationLinks = await findManyRelationLinksViaLinkTable(server, targetModel, relationProperty, entityIds);
-                    lodash.forEach(entities, (entity) => {
-                        entity[relationProperty.code] = lodash.filter(relationLinks, (link) => {
-                            return link[relationProperty.selfIdColumnName] == entity["id"];
+                    lodash.forEach(rows, (row) => {
+                        row[relationProperty.code] = lodash.filter(relationLinks, (link) => {
+                            return link[relationProperty.selfIdColumnName] == row["id"];
                         }).map((link) => mapDbRowToEntity(server, targetModel, link.targetEntity, false));
                     });
                 }
@@ -2078,29 +2086,36 @@ async function findEntities(server, dataAccessor, options) {
                     relatedEntities = await findManyRelatedEntitiesViaIdPropertyCode(server, model, relationProperty, entityIds);
                 }
                 else {
-                    const targetEntityIds = lodash.uniq(lodash.reject(lodash.map(entities, (entity) => entity[relationProperty.targetIdColumnName]), isNullOrUndefined));
+                    const targetEntityIds = lodash.uniq(lodash.reject(lodash.map(rows, (entity) => entity[relationProperty.targetIdColumnName]), isNullOrUndefined));
                     relatedEntities = await findOneRelatedEntitiesViaIdPropertyCode(server, model, relationProperty, targetEntityIds);
                 }
                 const targetModel = server.getModel({
                     singularCode: relationProperty.targetSingularCode,
                 });
-                entities.forEach((entity) => {
+                rows.forEach((row) => {
                     if (isManyRelation) {
-                        entity[relationProperty.code] = lodash.filter(relatedEntities, (relatedEntity) => {
-                            return relatedEntity[relationProperty.selfIdColumnName] == entity.id;
+                        row[relationProperty.code] = lodash.filter(relatedEntities, (relatedEntity) => {
+                            return relatedEntity[relationProperty.selfIdColumnName] == row.id;
                         }).map((item) => mapDbRowToEntity(server, targetModel, item, false));
                     }
                     else {
-                        entity[relationProperty.code] = mapDbRowToEntity(server, targetModel, lodash.find(relatedEntities, (relatedEntity) => {
+                        row[relationProperty.code] = mapDbRowToEntity(server, targetModel, lodash.find(relatedEntities, (relatedEntity) => {
                             // TODO: id property code should be configurable.
-                            return relatedEntity["id"] == entity[relationProperty.targetIdColumnName];
+                            return relatedEntity["id"] == row[relationProperty.targetIdColumnName];
                         }), false);
                     }
                 });
             }
         }
     }
-    return entities.map((item) => mapDbRowToEntity(server, model, item, options.keepNonPropertyFields));
+    const entities = rows.map((item) => mapDbRowToEntity(server, model, item, options.keepNonPropertyFields));
+    await server.emitEvent("entity.beforeResponse", {
+        namespace: model.namespace,
+        modelSingularCode: model.singularCode,
+        baseModelSingularCode: model.base,
+        entities,
+    }, null);
+    return entities;
 }
 async function findEntity(server, dataAccessor, options) {
     const entities = await findEntities(server, dataAccessor, options);
@@ -2867,6 +2882,7 @@ class RapidServer {
     #entityDeleteEventEmitters;
     #entityAddRelationsEventEmitters;
     #entityRemoveRelationsEventEmitters;
+    #entityBeforeResponseEventEmitters;
     #entityWatchers;
     #appEntityWatchers;
     #cachedEntityManager;
@@ -2900,6 +2916,7 @@ class RapidServer {
         this.#entityDeleteEventEmitters = new EventManager();
         this.#entityAddRelationsEventEmitters = new EventManager();
         this.#entityRemoveRelationsEventEmitters = new EventManager();
+        this.#entityBeforeResponseEventEmitters = new EventManager();
         this.registerEventHandler("entity.beforeCreate", this.#handleEntityEvent.bind(this, "entity.beforeCreate"));
         this.registerEventHandler("entity.create", this.#handleEntityEvent.bind(this, "entity.create"));
         this.registerEventHandler("entity.beforeUpdate", this.#handleEntityEvent.bind(this, "entity.beforeUpdate"));
@@ -2908,6 +2925,7 @@ class RapidServer {
         this.registerEventHandler("entity.delete", this.#handleEntityEvent.bind(this, "entity.delete"));
         this.registerEventHandler("entity.addRelations", this.#handleEntityEvent.bind(this, "entity.addRelations"));
         this.registerEventHandler("entity.removeRelations", this.#handleEntityEvent.bind(this, "entity.removeRelations"));
+        this.registerEventHandler("entity.beforeResponse", this.#handleEntityEvent.bind(this, "entity.beforeResponse"));
         this.#entityWatchers = [];
         this.#appEntityWatchers = options.entityWatchers || [];
         this.#services = new Map();
@@ -3022,7 +3040,6 @@ class RapidServer {
     }
     registerEventHandler(eventName, listener) {
         this.#eventManager.on(eventName, listener);
-        return this;
     }
     registerEntityWatcher(entityWatcher) {
         this.#entityWatchers.push(entityWatcher);
@@ -3081,6 +3098,9 @@ class RapidServer {
             else if (entityWatcher.eventName === "entity.removeRelations") {
                 this.#entityRemoveRelationsEventEmitters.on(entityWatcher.modelSingularCode, entityWatcher.handler);
             }
+            else if (entityWatcher.eventName === "entity.beforeResponse") {
+                this.#entityBeforeResponseEventEmitters.on(entityWatcher.modelSingularCode, entityWatcher.handler);
+            }
         }
         await this.configureApplication();
         this.#logger.info(`Rapid server ready.`);
@@ -3192,6 +3212,9 @@ class RapidServer {
         else if (eventName === "entity.removeRelations") {
             emitter = this.#entityRemoveRelationsEventEmitters;
         }
+        else if (eventName === "entity.beforeResponse") {
+            emitter = this.#entityBeforeResponseEventEmitters;
+        }
         emitter.emit(modelSingularCode, entityWatchHandlerContext);
         if (baseModelSingularCode) {
             emitter.emit(baseModelSingularCode, entityWatchHandlerContext);

package/dist/server.d.ts

@@ -31,7 +31,7 @@ export declare class RapidServer implements IRpdServer {
     getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
     getModel(options: GetModelOptions): RpdDataModel | undefined;
     getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
-    registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): this;
+    registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): void;
     registerEntityWatcher(entityWatcher: EntityWatcherType): void;
     emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, payload: RpdServerEventTypes[K][1], sender?: RapidPlugin): Promise<void>;
     registerService(name: string, service: any): void;

package/dist/types.d.ts

@@ -63,6 +63,7 @@ export type RpdServerEventTypes = {
     "entity.delete": [RapidPlugin, RpdEntityDeleteEventPayload];
     "entity.addRelations": [RapidPlugin, RpdEntityAddRelationsEventPayload];
     "entity.removeRelations": [RapidPlugin, RpdEntityRemoveRelationsEventPayload];
+    "entity.beforeResponse": [RapidPlugin, RpdEntityBeforeResponseEventPayload];
 };
 export interface RpdEntityBeforeCreateEventPayload {
     namespace: string;
@@ -119,6 +120,12 @@ export interface RpdEntityRemoveRelationsEventPayload {
     property: string;
     relations: any[];
 }
+export interface RpdEntityBeforeResponseEventPayload {
+    namespace: string;
+    modelSingularCode: string;
+    baseModelSingularCode?: string;
+    entities: any[];
+}
 export interface QuoteTableOptions {
     schema?: string;
     tableName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.1.50",
+  "version": "0.1.52",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/core/server.ts

@@ -1,4 +1,4 @@
-import { CreateEntityOptions, GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty, RpdServerEventTypes, UpdateEntityByIdOptions } from "~/types";
+import { CreateEntityOptions, EntityWatcherType, GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdDataModelProperty, RpdServerEventTypes, UpdateEntityByIdOptions } from "~/types";
 import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
 import { Next, RouteContext } from "./routeContext";
 import EntityManager from "~/dataAccess/entityManager";
@@ -28,7 +28,8 @@ export interface IRpdServer {
   appendApplicationConfig(config: Partial<RpdApplicationConfig>);
   appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]);
   getModel(options: GetModelOptions): RpdDataModel | undefined;
-  registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): this;
+  registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void);
+  registerEntityWatcher(entityWatcher: EntityWatcherType);
   emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, payload: RpdServerEventTypes[K][1], sender?: RapidPlugin): void;
   handleRequest(request: Request, next: Next): Promise<Response>;
   beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;

package/src/dataAccess/entityManager.ts

@@ -129,12 +129,12 @@ async function findEntities(server: IRpdServer, dataAccessor: IRpdDataAccessor,
     pagination: options.pagination,
     fields: columnsToSelect,
   };
-  const entities = await dataAccessor.find(findRowOptions);
-  if (!entities.length) {
+  const rows = await dataAccessor.find(findRowOptions);
+  if (!rows.length) {
     return [];
   }
 
-  const entityIds = entities.map((e) => e.id);
+  const entityIds = rows.map((row) => row.id);
   if (relationPropertiesToSelect.length) {
     for (const relationProperty of relationPropertiesToSelect) {
       const isManyRelation = relationProperty.relation === "many";
@@ -148,9 +148,9 @@ async function findEntities(server: IRpdServer, dataAccessor: IRpdDataAccessor,
         if (isManyRelation) {
           const relationLinks = await findManyRelationLinksViaLinkTable(server, targetModel, relationProperty, entityIds);
 
-          forEach(entities, (entity: any) => {
-            entity[relationProperty.code] = filter(relationLinks, (link: any) => {
-              return link[relationProperty.selfIdColumnName!] == entity["id"];
+          forEach(rows, (row: any) => {
+            row[relationProperty.code] = filter(relationLinks, (link: any) => {
+              return link[relationProperty.selfIdColumnName!] == row["id"];
             }).map((link) => mapDbRowToEntity(server, targetModel, link.targetEntity, false));
           });
         }
@@ -161,7 +161,7 @@ async function findEntities(server: IRpdServer, dataAccessor: IRpdDataAccessor,
         } else {
           const targetEntityIds = uniq(
             reject(
-              map(entities, (entity: any) => entity[relationProperty.targetIdColumnName!]),
+              map(rows, (entity: any) => entity[relationProperty.targetIdColumnName!]),
               isNullOrUndefined,
             ),
           );
@@ -171,18 +171,18 @@ async function findEntities(server: IRpdServer, dataAccessor: IRpdDataAccessor,
         const targetModel = server.getModel({
           singularCode: relationProperty.targetSingularCode!,
         });
-        entities.forEach((entity) => {
+        rows.forEach((row) => {
           if (isManyRelation) {
-            entity[relationProperty.code] = filter(relatedEntities, (relatedEntity: any) => {
-              return relatedEntity[relationProperty.selfIdColumnName!] == entity.id;
+            row[relationProperty.code] = filter(relatedEntities, (relatedEntity: any) => {
+              return relatedEntity[relationProperty.selfIdColumnName!] == row.id;
             }).map((item) => mapDbRowToEntity(server, targetModel!, item, false));
           } else {
-            entity[relationProperty.code] = mapDbRowToEntity(
+            row[relationProperty.code] = mapDbRowToEntity(
               server,
               targetModel!,
               find(relatedEntities, (relatedEntity: any) => {
                 // TODO: id property code should be configurable.
-                return relatedEntity["id"] == entity[relationProperty.targetIdColumnName!];
+                return relatedEntity["id"] == row[relationProperty.targetIdColumnName!];
               }),
               false,
             );
@@ -191,7 +191,20 @@ async function findEntities(server: IRpdServer, dataAccessor: IRpdDataAccessor,
       }
     }
   }
-  return entities.map((item) => mapDbRowToEntity(server, model, item, options.keepNonPropertyFields));
+  const entities = rows.map((item) => mapDbRowToEntity(server, model, item, options.keepNonPropertyFields));
+
+  await server.emitEvent(
+    "entity.beforeResponse",
+    {
+      namespace: model.namespace,
+      modelSingularCode: model.singularCode,
+      baseModelSingularCode: model.base,
+      entities,
+    },
+    null,
+  );
+
+  return entities;
 }
 
 async function findEntity(server: IRpdServer, dataAccessor: IRpdDataAccessor, options: FindEntityOptions) {

package/src/dataAccess/metaHelper.ts

@@ -1,3 +1,4 @@
+import { cloneDeep } from "lodash";
 import { IRpdServer } from "~/core/server";
 import { RpdDataModel, RpdDataModelProperty } from "~/types";
 
@@ -13,10 +14,17 @@ export function getEntityPropertiesIncludingBase(server: IRpdServer, model: RpdD
   const baseModel = server.getModel({
     singularCode: model.base,
   });
-  baseModel.properties.forEach(prop => prop.isBaseProperty = true);
+  let baseProperties: RpdDataModelProperty[] = [];
+  if (baseModel) {
+    baseModel.properties.map((property) => {
+      property = cloneDeep(property);
+      property.isBaseProperty = true;
+      return property;
+    })
+  }
 
   return [
-    ...baseModel.properties,
+    ...baseProperties,
     ...model.properties,
   ]
 }
@@ -36,6 +44,7 @@ export function getEntityProperty(server: IRpdServer, model: RpdDataModel, predi
 
       property = baseModel.properties.find(predicate);
       if (property) {
+        property = cloneDeep(property);
         property.isBaseProperty = true;
       }
     }

package/src/server.ts

@@ -47,6 +47,7 @@ export class RapidServer implements IRpdServer {
   #entityDeleteEventEmitters: EventManager<Record<string, [EntityWatchHandlerContext<any>]>>;
   #entityAddRelationsEventEmitters: EventManager<Record<string, [EntityWatchHandlerContext<any>]>>;
   #entityRemoveRelationsEventEmitters: EventManager<Record<string, [EntityWatchHandlerContext<any>]>>;
+  #entityBeforeResponseEventEmitters: EventManager<Record<string, [EntityWatchHandlerContext<any>]>>;
   #entityWatchers: EntityWatcherType[];
   #appEntityWatchers: EntityWatcherType[];
 
@@ -87,6 +88,7 @@ export class RapidServer implements IRpdServer {
     this.#entityDeleteEventEmitters = new EventManager();
     this.#entityAddRelationsEventEmitters = new EventManager();
     this.#entityRemoveRelationsEventEmitters = new EventManager();
+    this.#entityBeforeResponseEventEmitters = new EventManager();
 
     this.registerEventHandler("entity.beforeCreate", this.#handleEntityEvent.bind(this, "entity.beforeCreate"));
     this.registerEventHandler("entity.create", this.#handleEntityEvent.bind(this, "entity.create"));
@@ -96,6 +98,7 @@ export class RapidServer implements IRpdServer {
     this.registerEventHandler("entity.delete", this.#handleEntityEvent.bind(this, "entity.delete"));
     this.registerEventHandler("entity.addRelations", this.#handleEntityEvent.bind(this, "entity.addRelations"));
     this.registerEventHandler("entity.removeRelations", this.#handleEntityEvent.bind(this, "entity.removeRelations"));
+    this.registerEventHandler("entity.beforeResponse", this.#handleEntityEvent.bind(this, "entity.beforeResponse"));
 
     this.#entityWatchers = [];
     this.#appEntityWatchers = options.entityWatchers || [];
@@ -226,9 +229,8 @@ export class RapidServer implements IRpdServer {
     return entityManager;
   }
 
-  registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): this {
+  registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void) {
     this.#eventManager.on(eventName, listener);
-    return this;
   }
 
   registerEntityWatcher(entityWatcher: EntityWatcherType) {
@@ -288,6 +290,8 @@ export class RapidServer implements IRpdServer {
         this.#entityAddRelationsEventEmitters.on(entityWatcher.modelSingularCode, entityWatcher.handler);
       } else if (entityWatcher.eventName === "entity.removeRelations") {
         this.#entityRemoveRelationsEventEmitters.on(entityWatcher.modelSingularCode, entityWatcher.handler);
+      } else if (entityWatcher.eventName === "entity.beforeResponse") {
+        this.#entityBeforeResponseEventEmitters.on(entityWatcher.modelSingularCode, entityWatcher.handler);
       }
     }
 
@@ -412,6 +416,8 @@ export class RapidServer implements IRpdServer {
       emitter = this.#entityAddRelationsEventEmitters;
     } else if (eventName === "entity.removeRelations") {
       emitter = this.#entityRemoveRelationsEventEmitters;
+    } else if (eventName === "entity.beforeResponse") {
+      emitter = this.#entityBeforeResponseEventEmitters;
     }
 
     emitter.emit(modelSingularCode, entityWatchHandlerContext);

package/src/types.ts

@@ -75,6 +75,7 @@ export type RpdServerEventTypes = {
   "entity.delete": [RapidPlugin, RpdEntityDeleteEventPayload];
   "entity.addRelations": [RapidPlugin, RpdEntityAddRelationsEventPayload];
   "entity.removeRelations": [RapidPlugin, RpdEntityRemoveRelationsEventPayload];
+  "entity.beforeResponse": [RapidPlugin, RpdEntityBeforeResponseEventPayload];
 };
 
 export interface RpdEntityBeforeCreateEventPayload {
@@ -140,6 +141,13 @@ export interface RpdEntityRemoveRelationsEventPayload {
   relations: any[];
 }
 
+export interface RpdEntityBeforeResponseEventPayload {
+  namespace: string;
+  modelSingularCode: string;
+  baseModelSingularCode?: string;
+  entities: any[];
+}
+
 export interface QuoteTableOptions {
   schema?: string;
   tableName: string;