@ruiapp/rapid-core 0.1.21 → 0.1.23

package/dist/core/facility.d.ts

@@ -0,0 +1,5 @@
+import { IRpdServer } from "./server";
+export interface FacilityFactory {
+    name: string;
+    createFacility: (server: IRpdServer, options?: any) => Promise<any>;
+}

package/dist/core/server.d.ts

@@ -3,11 +3,14 @@ import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./act
 import { Next, RouteContext } from "./routeContext";
 import EntityManager from "../dataAccess/entityManager";
 import { Logger } from "../facilities/log/LogFacility";
+import { FacilityFactory } from "./facility";
 export interface IRpdServer {
     config: RapidServerConfig;
     databaseConfig: IDatabaseConfig;
     queryBuilder: IQueryBuilder;
     getLogger(): Logger;
+    registerFacilityFactory(factory: FacilityFactory): any;
+    getFacility<TFacility = any>(name: string, options?: any): Promise<TFacility>;
     queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     registerMiddleware(middleware: any): void;
@@ -20,7 +23,7 @@ export interface IRpdServer {
     appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]): any;
     getModel(options: GetModelOptions): RpdDataModel | undefined;
     registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): this;
-    emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, sender: RapidPlugin, payload: RpdServerEventTypes[K][1]): void;
+    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/dataAccess/entityManager.d.ts

@@ -7,10 +7,10 @@ export default class EntityManager<TEntity = any> {
     findEntities(options: FindEntityOptions): Promise<TEntity[]>;
     findEntity(options: FindEntityOptions): Promise<TEntity | null>;
     findById(id: any, keepNonPropertyFields?: boolean): Promise<TEntity | null>;
-    createEntity(options: CreateEntityOptions, plugin: RapidPlugin): Promise<TEntity>;
-    updateEntityById(options: UpdateEntityByIdOptions, plugin: RapidPlugin): Promise<TEntity>;
+    createEntity(options: CreateEntityOptions, plugin?: RapidPlugin): Promise<TEntity>;
+    updateEntityById(options: UpdateEntityByIdOptions, plugin?: RapidPlugin): Promise<TEntity>;
     count(options: CountEntityOptions): Promise<CountEntityResult>;
-    deleteById(id: any, plugin: RapidPlugin): Promise<void>;
-    addRelations(options: AddEntityRelationsOptions, plugin: RapidPlugin): Promise<void>;
-    removeRelations(options: RemoveEntityRelationsOptions, plugin: RapidPlugin): Promise<void>;
+    deleteById(id: any, plugin?: RapidPlugin): Promise<void>;
+    addRelations(options: AddEntityRelationsOptions, plugin?: RapidPlugin): Promise<void>;
+    removeRelations(options: RemoveEntityRelationsOptions, plugin?: RapidPlugin): Promise<void>;
 }

package/dist/index.js

@@ -1041,7 +1041,7 @@ class RapidRequest {
         const requestMethod = this.method;
         if (requestMethod === "POST" || requestMethod === "PUT" || requestMethod === "PATCH") {
             const req = this.#raw;
-            const contentType = this.#headers.get("Content-Type");
+            const contentType = this.#headers.get("Content-Type") || "application/json";
             if (contentType.includes("json")) {
                 this.#body = {
                     type: "json",
@@ -2245,13 +2245,13 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
         }
         updatedEntity[property.code] = relatedEntities;
     }
-    server.emitEvent("entity.update", plugin, {
+    server.emitEvent("entity.update", {
         namespace: model.namespace,
         modelSingularCode: model.singularCode,
         before: entity,
         after: updatedEntity,
         changes: changes,
-    });
+    }, plugin);
     return updatedEntity;
 }
 class EntityManager {
@@ -2276,11 +2276,11 @@ class EntityManager {
     async createEntity(options, plugin) {
         const model = this.getModel();
         const newEntity = await createEntity(this.#server, this.#dataAccessor, options);
-        this.#server.emitEvent("entity.create", plugin, {
+        this.#server.emitEvent("entity.create", {
             namespace: model.namespace,
             modelSingularCode: model.singularCode,
             after: newEntity,
-        });
+        }, plugin);
         return newEntity;
     }
     async updateEntityById(options, plugin) {
@@ -2296,11 +2296,11 @@ class EntityManager {
             return;
         }
         await this.#dataAccessor.deleteById(id);
-        this.#server.emitEvent("entity.delete", plugin, {
+        this.#server.emitEvent("entity.delete", {
             namespace: model.namespace,
             modelSingularCode: model.singularCode,
             before: entity,
-        });
+        }, plugin);
     }
     async addRelations(options, plugin) {
         const model = this.getModel();
@@ -2330,13 +2330,13 @@ class EntityManager {
                 await server.queryDatabaseObject(command, params);
             }
         }
-        server.emitEvent("entity.addRelations", plugin, {
+        server.emitEvent("entity.addRelations", {
             namespace: model.namespace,
             modelSingularCode: model.singularCode,
             entity,
             property,
             relations,
-        });
+        }, plugin);
     }
     async removeRelations(options, plugin) {
         const model = this.getModel();
@@ -2362,18 +2362,19 @@ class EntityManager {
                 await server.queryDatabaseObject(command, params);
             }
         }
-        server.emitEvent("entity.removeRelations", plugin, {
+        server.emitEvent("entity.removeRelations", {
             namespace: model.namespace,
             modelSingularCode: model.singularCode,
             entity,
             property,
             relations,
-        });
+        }, plugin);
     }
 }
 
 class RapidServer {
     #logger;
+    #facilityFactories;
     #pluginManager;
     #plugins;
     #eventManager;
@@ -2390,6 +2391,12 @@ class RapidServer {
     #buildedRoutes;
     constructor(options) {
         this.#logger = options.logger;
+        this.#facilityFactories = new Map();
+        if (options.facilityFactories) {
+            lodash.forEach(options.facilityFactories, (factory) => {
+                this.registerFacilityFactory(factory);
+            });
+        }
         this.#pluginManager = new PluginManager(this);
         this.#eventManager = new EventManager();
         this.#middlewares = [];
@@ -2512,7 +2519,7 @@ class RapidServer {
         this.#eventManager.on(eventName, listener);
         return this;
     }
-    async emitEvent(eventName, sender, payload) {
+    async emitEvent(eventName, payload, sender) {
         this.#logger.debug(`Emitting '${eventName}' event.`, { eventName, payload });
         await this.#eventManager.emit(eventName, sender, payload);
         // TODO: should move this logic into metaManager
@@ -2549,6 +2556,21 @@ class RapidServer {
         await pluginManager.onApplicationLoaded(this.#applicationConfig);
         this.#buildedRoutes = await buildRoutes(this, this.#applicationConfig);
     }
+    registerFacilityFactory(factory) {
+        this.#facilityFactories.set(factory.name, factory);
+    }
+    async getFacility(name, options, nullIfUnknownFacility) {
+        const factory = this.#facilityFactories.get(name);
+        if (!factory) {
+            if (nullIfUnknownFacility) {
+                return null;
+            }
+            else {
+                throw new Error(`Failed to get facility. Unknown facility name: ${name}`);
+            }
+        }
+        return await factory.createFacility(this, options);
+    }
     async queryDatabaseObject(sql, params) {
         try {
             return await this.#databaseAccessor.queryDatabaseObject(sql, params);

package/dist/server.d.ts

@@ -4,12 +4,14 @@ import { IRpdServer, RapidPlugin } from "./core/server";
 import { Next } from "./core/routeContext";
 import EntityManager from "./dataAccess/entityManager";
 import { Logger } from "./facilities/log/LogFacility";
+import { FacilityFactory } from "./core/facility";
 export interface InitServerOptions {
     logger: Logger;
     databaseAccessor: IDatabaseAccessor;
     databaseConfig: IDatabaseConfig;
     serverConfig: RapidServerConfig;
     applicationConfig?: RpdApplicationConfig;
+    facilityFactories?: FacilityFactory[];
     plugins?: RapidPlugin[];
 }
 export declare class RapidServer implements IRpdServer {
@@ -29,9 +31,11 @@ export declare class RapidServer implements IRpdServer {
     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;
-    emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, sender: RapidPlugin, payload: RpdServerEventTypes[K][1]): Promise<void>;
+    emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, payload: RpdServerEventTypes[K][1], sender?: RapidPlugin): Promise<void>;
     start(): Promise<void>;
     configureApplication(): Promise<void>;
+    registerFacilityFactory(factory: FacilityFactory): void;
+    getFacility<TFacility = any>(name: string, options?: any, nullIfUnknownFacility?: boolean): Promise<TFacility>;
     queryDatabaseObject(sql: string, params?: unknown[] | Record<string, unknown>): Promise<any[]>;
     tryQueryDatabaseObject(sql: string, params?: unknown[] | Record<string, unknown>): Promise<any[]>;
     get middlewares(): any[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.1.21",
+  "version": "0.1.23",
   "description": "",
   "main": "dist/index.js",
   "keywords": [],

package/src/core/facility.ts

@@ -0,0 +1,7 @@
+import { IRpdServer } from "./server";
+
+export interface FacilityFactory {
+  name: string;
+
+  createFacility: (server: IRpdServer, options?: any) => Promise<any>;
+}

package/src/core/request.ts

@@ -38,7 +38,7 @@ export class RapidRequest {
     const requestMethod = this.method;
     if (requestMethod === "POST" || requestMethod === "PUT" || requestMethod === "PATCH") {
       const req = this.#raw;
-      const contentType = this.#headers.get("Content-Type");
+      const contentType = this.#headers.get("Content-Type") || "application/json";
       if (contentType.includes("json")) {
         this.#body = {
           type: "json",

package/src/core/server.ts

@@ -3,12 +3,18 @@ import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./act
 import { Next, RouteContext } from "./routeContext";
 import EntityManager from "~/dataAccess/entityManager";
 import { Logger } from "~/facilities/log/LogFacility";
+import { FacilityFactory } from "./facility";
 
 export interface IRpdServer {
   config: RapidServerConfig;
   databaseConfig: IDatabaseConfig;
   queryBuilder: IQueryBuilder;
   getLogger(): Logger;
+
+  registerFacilityFactory(factory: FacilityFactory);
+
+  getFacility<TFacility=any>(name: string, options?: any): Promise<TFacility>;
+
   queryDatabaseObject: (
     sql: string,
     params?: unknown[] | Record<string, unknown>,
@@ -37,8 +43,8 @@ export interface IRpdServer {
   ): this;
   emitEvent<K extends keyof RpdServerEventTypes>(
     eventName: K,
-    sender: RapidPlugin,
     payload: RpdServerEventTypes[K][1],
+    sender?: RapidPlugin,
   ): void;
   handleRequest(request: Request, next: Next): Promise<Response>;
   beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;

package/src/dataAccess/entityManager.ts

@@ -553,7 +553,7 @@ async function updateEntityById(
   server: IRpdServer,
   dataAccessor: IRpdDataAccessor,
   options: UpdateEntityByIdOptions,
-  plugin: RapidPlugin
+  plugin?: RapidPlugin
 ) {
   const model = dataAccessor.getModel();
   const { id, entityToSave } = options;
@@ -685,7 +685,6 @@ async function updateEntityById(
   
   server.emitEvent(
     "entity.update",
-    plugin,
     {
       namespace: model.namespace,
       modelSingularCode: model.singularCode,
@@ -693,6 +692,7 @@ async function updateEntityById(
       after: updatedEntity,
       changes: changes,
     },
+    plugin,
   );
   return updatedEntity;
 }
@@ -722,24 +722,24 @@ export default class EntityManager<TEntity=any> {
     return await findById(this.#server, this.#dataAccessor, id, keepNonPropertyFields);
   }
 
-  async createEntity(options: CreateEntityOptions, plugin: RapidPlugin): Promise<TEntity> {
+  async createEntity(options: CreateEntityOptions, plugin?: RapidPlugin): Promise<TEntity> {
     const model = this.getModel();
     const newEntity = await createEntity(this.#server, this.#dataAccessor, options);
 
     this.#server.emitEvent(
       "entity.create",
-      plugin,
       {
         namespace: model.namespace,
         modelSingularCode: model.singularCode,
         after: newEntity,
       },
+      plugin,
     );
 
     return newEntity;
   }
 
-  async updateEntityById(options: UpdateEntityByIdOptions, plugin: RapidPlugin): Promise<TEntity> {
+  async updateEntityById(options: UpdateEntityByIdOptions, plugin?: RapidPlugin): Promise<TEntity> {
     return await updateEntityById(this.#server, this.#dataAccessor, options, plugin);
   }
 
@@ -747,7 +747,7 @@ export default class EntityManager<TEntity=any> {
     return await this.#dataAccessor.count(options);
   }
 
-  async deleteById(id: any, plugin: RapidPlugin): Promise<void> {
+  async deleteById(id: any, plugin?: RapidPlugin): Promise<void> {
     const model = this.getModel();
     const entity = await this.findById(id, true);
     if (!entity) {
@@ -757,16 +757,16 @@ export default class EntityManager<TEntity=any> {
     await this.#dataAccessor.deleteById(id);
     this.#server.emitEvent(
       "entity.delete",
-      plugin,
       {
         namespace: model.namespace,
         modelSingularCode: model.singularCode,
         before: entity,
       },
+      plugin,
     );
   }
 
-  async addRelations(options: AddEntityRelationsOptions, plugin: RapidPlugin): Promise<void> {
+  async addRelations(options: AddEntityRelationsOptions, plugin?: RapidPlugin): Promise<void> {
     const model = this.getModel();
     const {id, property, relations} = options;
     const entity = await this.findById(id);
@@ -800,7 +800,6 @@ export default class EntityManager<TEntity=any> {
 
     server.emitEvent(
       "entity.addRelations",
-      plugin,
       {
         namespace: model.namespace,
         modelSingularCode: model.singularCode,
@@ -808,10 +807,11 @@ export default class EntityManager<TEntity=any> {
         property,
         relations,
       },
+      plugin,
     );
   }
 
-  async removeRelations(options: RemoveEntityRelationsOptions, plugin: RapidPlugin): Promise<void> {
+  async removeRelations(options: RemoveEntityRelationsOptions, plugin?: RapidPlugin): Promise<void> {
     const model = this.getModel();
     const {id, property, relations} = options;
     const entity = await this.findById(id);
@@ -841,7 +841,6 @@ export default class EntityManager<TEntity=any> {
 
     server.emitEvent(
       "entity.removeRelations",
-      plugin,
       {
         namespace: model.namespace,
         modelSingularCode: model.singularCode,
@@ -849,6 +848,7 @@ export default class EntityManager<TEntity=any> {
         property,
         relations,
       },
+      plugin,
     );
   }
 }

package/src/server.ts

@@ -23,8 +23,9 @@ import { Next, RouteContext } from "./core/routeContext";
 import { RapidRequest } from "./core/request";
 import bootstrapApplicationConfig from "./bootstrapApplicationConfig";
 import EntityManager from "./dataAccess/entityManager";
-import { bind, cloneDeep, find, merge, omit } from "lodash";
+import { bind, cloneDeep, find, forEach, merge, omit } from "lodash";
 import { Logger } from "./facilities/log/LogFacility";
+import { FacilityFactory } from "./core/facility";
 
 export interface InitServerOptions {
   logger: Logger;
@@ -32,11 +33,13 @@ export interface InitServerOptions {
   databaseConfig: IDatabaseConfig;
   serverConfig: RapidServerConfig;
   applicationConfig?: RpdApplicationConfig;
+  facilityFactories?: FacilityFactory[];
   plugins?: RapidPlugin[];
 }
 
 export class RapidServer implements IRpdServer {
   #logger: Logger;
+  #facilityFactories: Map<string, FacilityFactory>;
   #pluginManager: PluginManager;
   #plugins: RapidPlugin[];
   #eventManager: EventManager<RpdServerEventTypes>;
@@ -55,6 +58,13 @@ export class RapidServer implements IRpdServer {
   constructor(options: InitServerOptions) {
     this.#logger = options.logger;
 
+    this.#facilityFactories = new Map();
+    if (options.facilityFactories) {
+      forEach(options.facilityFactories, (factory) => {
+        this.registerFacilityFactory(factory);
+      })
+    }
+
     this.#pluginManager = new PluginManager(this);
     this.#eventManager = new EventManager();
     this.#middlewares = [];
@@ -205,8 +215,8 @@ export class RapidServer implements IRpdServer {
 
   async emitEvent<K extends keyof RpdServerEventTypes>(
     eventName: K,
-    sender: RapidPlugin,
     payload: RpdServerEventTypes[K][1],
+    sender?: RapidPlugin,
   ) {
     this.#logger.debug(`Emitting '${eventName}' event.`, { eventName, payload });
     await this.#eventManager.emit<K>(eventName, sender, payload as any);
@@ -258,6 +268,23 @@ export class RapidServer implements IRpdServer {
     this.#buildedRoutes = await buildRoutes(this, this.#applicationConfig);
   }
 
+  registerFacilityFactory(factory: FacilityFactory) {
+    this.#facilityFactories.set(factory.name, factory);
+  }
+
+  async getFacility<TFacility=any>(name: string, options?: any, nullIfUnknownFacility?: boolean): Promise<TFacility> {
+    const factory = this.#facilityFactories.get(name);
+    if (!factory) {
+      if (nullIfUnknownFacility) {
+        return null;
+      } else {
+        throw new Error(`Failed to get facility. Unknown facility name: ${name}`);
+      }
+    }
+
+    return await factory.createFacility(this, options);
+  }
+
   async queryDatabaseObject(sql: string, params?: unknown[] | Record<string,unknown>) : Promise<any[]> {
     try {
       return await this.#databaseAccessor.queryDatabaseObject(sql, params);