@ruiapp/rapid-core 0.11.5 → 0.11.7

package/CHANGELOG.md

@@ -1,11 +1,11 @@
-# @ruiapp/rapid-core
-
-## 0.7.0
-
-- feature: added server.registerCronJob to allow plugins register cron jobs.
-
-## 0.2.4
-
-### Patch Changes
-
-- 146a99d: add between filterMode, range is deprecated
+# @ruiapp/rapid-core
+
+## 0.7.0
+
+- feature: added server.registerCronJob to allow plugins register cron jobs.
+
+## 0.2.4
+
+### Patch Changes
+
+- 146a99d: add between filterMode, range is deprecated

package/dist/core/pluginManager.d.ts

@@ -40,6 +40,8 @@ declare class PluginManager {
     beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
     /** 在执行 action hanlder 前调用。 */
     beforeRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig): Promise<void>;
+    /** 在执行 action handler 后调用。 */
+    afterRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig, error?: Error): Promise<void>;
     /** 在创建实体前调用。 */
     beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
     /** 在更新实体前调用。 */

package/dist/core/server.d.ts

@@ -34,6 +34,7 @@ export interface IRpdServer {
     runActionHandlers(handlerContext: ActionHandlerContext, actions: RpdRouteActionConfig[]): Promise<void>;
     beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
     beforeRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig): Promise<void>;
+    afterRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig, error?: Error): Promise<void>;
     beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
     beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
     registerCronJob(job: CronJobConfiguration): void;
@@ -112,6 +113,8 @@ export interface RapidPlugin {
     beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
     /** 在执行 action hanlder 前调用。 */
     beforeRunActionHandler?: (server: IRpdServer, handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig) => Promise<any>;
+    /** 在执行 action handler 后调用。 */
+    afterRunActionHandler?: (server: IRpdServer, handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig, error?: Error) => Promise<any>;
     /** 在创建实体前调用。 */
     beforeCreateEntity?: (server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) => Promise<any>;
     /** 在更新实体前调用。 */

package/dist/dataAccess/entityManager.d.ts

@@ -33,7 +33,7 @@ export default class EntityManager<TEntity = any> {
     createEntity(options: CreateEntityOptions, plugin?: RapidPlugin): Promise<TEntity>;
     updateEntityById(options: UpdateEntityByIdOptions, plugin?: RapidPlugin): Promise<TEntity>;
     count(options: CountEntityOptions): Promise<number>;
-    deleteById(options: DeleteEntityByIdOptions | string | number, plugin?: RapidPlugin): Promise<void>;
-    addRelations(options: AddEntityRelationsOptions, plugin?: RapidPlugin): Promise<void>;
-    removeRelations(options: RemoveEntityRelationsOptions, plugin?: RapidPlugin): Promise<void>;
+    deleteById(options: DeleteEntityByIdOptions | string | number, plugin?: RapidPlugin): Promise<TEntity>;
+    addRelations(options: AddEntityRelationsOptions, plugin?: RapidPlugin): Promise<any>;
+    removeRelations(options: RemoveEntityRelationsOptions, plugin?: RapidPlugin): Promise<any>;
 }

package/dist/index.js

@@ -936,6 +936,14 @@ class PluginManager {
             }
         }
     }
+    /** 在执行 action handler 后调用。 */
+    async afterRunActionHandler(handlerContext, actionConfig, error) {
+        for (const plugin of this.#plugins) {
+            if (plugin.afterRunActionHandler) {
+                await plugin.afterRunActionHandler(this.#server, handlerContext, actionConfig, error);
+            }
+        }
+    }
     /** 在创建实体前调用。 */
     async beforeCreateEntity(model, options) {
         for (const plugin of this.#plugins) {
@@ -1044,9 +1052,19 @@ async function executeHandlerOfActions(server, routeConfig, handlerContext) {
                 throw new Error("Unknown handler: " + actionCode);
             }
             await server.beforeRunActionHandler(handlerContext, actionConfig);
-            const result = handler(handlerContext, actionConfig.config);
-            if (result instanceof Promise) {
-                await result;
+            let err;
+            try {
+                const result = handler(handlerContext, actionConfig.config);
+                if (result instanceof Promise) {
+                    await result;
+                }
+            }
+            catch (error) {
+                err = error;
+                throw error;
+            }
+            finally {
+                await server.afterRunActionHandler(handlerContext, actionConfig, err);
             }
         }
     }
@@ -3174,7 +3192,7 @@ const UNDELETED_ENTITY_FILTER_OPTIONS = {
     field: "deletedAt",
 };
 function tryAddUndeletedEntityFilter(model, baseModel, filters) {
-    let isEntitySoftDeleteEnabled = baseModel ? baseModel.softDelete : model.softDelete;
+    let isEntitySoftDeleteEnabled = baseModel ? baseModel.softDelete || model.softDelete : model.softDelete;
     if (!isEntitySoftDeleteEnabled) {
         return filters;
     }
@@ -3406,8 +3424,8 @@ async function findManyRelationLinksViaLinkTable(options) {
     const command = `SELECT * FROM ${server.queryBuilder.quoteTable({
         schema: relationProperty.linkSchema,
         tableName: relationProperty.linkTableName,
-    })} WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = ANY($1::int[])
-    ORDER BY id
+    })} WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = ANY($1::int[])
+    ORDER BY id
   `;
     const params = [mainEntityIds];
     const relationLinks = await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
@@ -4060,7 +4078,7 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
             await server.queryDatabaseObject(`DELETE FROM ${server.queryBuilder.quoteTable({
                 schema: property.linkSchema,
                 tableName: property.linkTableName,
-            })} WHERE ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = $1
+            })} WHERE ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = $1
               AND ${server.queryBuilder.quoteObject(property.targetIdColumnName)} <> ALL($2::int[])`, [id, targetIdsToKeep], routeContext?.getDbTransactionClient());
         }
         else {
@@ -4089,8 +4107,8 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
                     await server.queryDatabaseObject(`UPDATE ${server.queryBuilder.quoteTable({
                         schema: relationModel.schema,
                         tableName: relationModel.tableName,
-                    })}
-            SET ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = null
+                    })}
+            SET ${server.queryBuilder.quoteObject(property.selfIdColumnName)} = null
             WHERE id = ANY($1::int[])`, [targetIdsToRemove], routeContext?.getDbTransactionClient());
                 }
                 else {
@@ -4279,6 +4297,12 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
         };
     }
     const model = dataAccessor.getModel();
+    let baseModel;
+    if (model.base) {
+        baseModel = server.getModel({
+            singularCode: model.base,
+        });
+    }
     if (model.derivedTypePropertyCode) {
         // TODO: should be allowed.
         throw newEntityOperationError("Delete base entity directly is not allowed.");
@@ -4292,7 +4316,8 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
     if (!entity) {
         return;
     }
-    if (model.softDelete) {
+    const isEntitySoftDeleteEnabled = model.base ? baseModel.softDelete || model.softDelete : model.softDelete;
+    if (isEntitySoftDeleteEnabled) {
         if (entity.deletedAt) {
             return;
         }
@@ -4307,12 +4332,18 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
         sender: plugin,
         routeContext,
     });
-    if (model.softDelete) {
+    if (isEntitySoftDeleteEnabled) {
         const currentUserId = routeContext?.state?.userId;
-        await dataAccessor.updateById(id, {
+        const updateFields = {
             deleted_at: getNowStringWithTimezone(),
             deleter_id: currentUserId,
-        }, routeContext?.getDbTransactionClient());
+        };
+        const softDeleteDataAccessor = model.base
+            ? server.getDataAccessor({
+                singularCode: model.base,
+            })
+            : dataAccessor;
+        await softDeleteDataAccessor.updateById(id, updateFields, routeContext?.getDbTransactionClient());
     }
     else {
         const relationPropertiesWithDeletingReaction = getEntityPropertiesIncludingBase(server, model, (property) => {
@@ -4375,7 +4406,7 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
                         await server.queryDatabaseObject(`DELETE FROM ${server.queryBuilder.quoteTable({
                             schema: relationProperty.linkSchema,
                             tableName: relationProperty.linkTableName,
-                        })}
+                        })}
               WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = $1`, [id], routeContext?.getDbTransactionClient());
                     }
                     else {
@@ -4385,8 +4416,8 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
                         await server.queryDatabaseObject(`UPDATE ${server.queryBuilder.quoteTable({
                             schema: relationModel.schema,
                             tableName: relationModel.tableName,
-                        })}
-              SET ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = null
+                        })}
+              SET ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = null
               WHERE ${server.queryBuilder.quoteObject(relationProperty.selfIdColumnName)} = $1`, [id], routeContext?.getDbTransactionClient());
                     }
                 }
@@ -4410,6 +4441,7 @@ async function deleteEntityById(server, dataAccessor, options, plugin) {
         sender: plugin,
         routeContext,
     });
+    return entity;
 }
 class EntityManager {
     #server;
@@ -4478,30 +4510,39 @@ class EntityManager {
             throw new Error(`Operation 'addRelations' is only supported on property of 'many' relation`);
         }
         const { queryBuilder } = server;
+        const targetEntityManager = server.getEntityManager(relationProperty.targetSingularCode);
+        const relationTargetEntities = [];
         if (relationProperty.linkTableName) {
             for (const relation of relations) {
                 const command = `INSERT INTO ${queryBuilder.quoteTable({
                     schema: relationProperty.linkSchema,
                     tableName: relationProperty.linkTableName,
-                })} (${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)})
-    SELECT $1, $2 WHERE NOT EXISTS (
-      SELECT ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}
-        FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
-        WHERE ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}=$1 AND ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}=$2
+                })} (${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)})
+    SELECT $1, $2 WHERE NOT EXISTS (
+      SELECT ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}, ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}
+        FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
+        WHERE ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}=$1 AND ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}=$2
       )`;
                 const targetId = relation[relationProperty.targetIdColumnName] || relation.id;
                 const params = [selfId, targetId];
-                await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
+                const result = await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
+                if (result?.length > 0) {
+                    const targetEntity = await targetEntityManager.findById({
+                        routeContext,
+                        id: targetId,
+                    });
+                    relationTargetEntities.push(targetEntity);
+                }
             }
         }
         else {
-            const targetEntityManager = server.getEntityManager(relationProperty.targetSingularCode);
             for (const relation of relations) {
                 relation[relationProperty.selfIdColumnName] = selfId;
-                await targetEntityManager.createEntity({
+                const targetEntity = await targetEntityManager.createEntity({
                     routeContext,
                     entity: relation,
                 });
+                relationTargetEntities.push(targetEntity);
             }
         }
         await server.emitEvent({
@@ -4512,10 +4553,17 @@ class EntityManager {
                 entity,
                 property,
                 relations,
+                relationTargetEntities,
             },
             sender: plugin,
             routeContext: options.routeContext,
         });
+        return {
+            entity,
+            property,
+            relations,
+            relationTargetEntities,
+        };
     }
     async removeRelations(options, plugin) {
         const server = this.#server;
@@ -4536,12 +4584,21 @@ class EntityManager {
             throw new Error(`Operation 'removeRelations' is only supported on property of 'many' relation`);
         }
         const { queryBuilder } = server;
+        const targetEntityManager = server.getEntityManager(relationProperty.targetSingularCode);
+        const relationTargetEntities = [];
         if (relationProperty.linkTableName) {
             for (const relation of relations) {
-                const command = `DELETE FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
+                const command = `DELETE FROM ${queryBuilder.quoteTable({ schema: relationProperty.linkSchema, tableName: relationProperty.linkTableName })}
     WHERE ${queryBuilder.quoteObject(relationProperty.selfIdColumnName)}=$1 AND ${queryBuilder.quoteObject(relationProperty.targetIdColumnName)}=$2;`;
                 const params = [id, relation.id];
-                await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
+                const result = await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
+                if (result?.length > 0) {
+                    const targetEntity = await targetEntityManager.findById({
+                        routeContext,
+                        id: relation.id,
+                    });
+                    relationTargetEntities.push(targetEntity);
+                }
             }
         }
         await server.emitEvent({
@@ -4552,10 +4609,17 @@ class EntityManager {
                 entity,
                 property,
                 relations,
+                relationTargetEntities,
             },
             sender: plugin,
             routeContext: options.routeContext,
         });
+        return {
+            entity,
+            property,
+            relations,
+            relationTargetEntities,
+        };
     }
 }
 
@@ -5004,7 +5068,15 @@ class RapidServer {
                 throw new Error("Unknown handler: " + actionCode);
             }
             await this.beforeRunActionHandler(handlerContext, action);
-            await handler(handlerContext, action.config);
+            try {
+                await handler(handlerContext, action.config);
+            }
+            catch (error) {
+                throw error;
+            }
+            finally {
+                await this.afterRunActionHandler(handlerContext, action);
+            }
         }
     }
     async beforeRunRouteActions(handlerContext) {
@@ -5013,6 +5085,9 @@ class RapidServer {
     async beforeRunActionHandler(handlerContext, actionConfig) {
         await this.#pluginManager.beforeRunActionHandler(handlerContext, actionConfig);
     }
+    async afterRunActionHandler(handlerContext, actionConfig, error) {
+        await this.#pluginManager.afterRunActionHandler(handlerContext, actionConfig, error);
+    }
     async beforeCreateEntity(model, options) {
         await this.#pluginManager.beforeCreateEntity(model, options);
     }
@@ -5890,9 +5965,9 @@ class MetaService {
                 await server.tryQueryDatabaseObject(`COMMENT ON TABLE ${queryBuilder.quoteTable(model)} IS ${queryBuilder.formatValueToSqlLiteral(model.name)};`, []);
             }
         }
-        const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type,  c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
-      FROM information_schema.columns c
-      INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
+        const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type,  c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
+      FROM information_schema.columns c
+      INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
       LEFT JOIN pg_catalog.pg_description d ON (d.objoid = st.relid and d.objsubid = c.ordinal_position);`;
         const columnsInDb = await server.queryDatabaseObject(sqlQueryColumnInformations, []);
         for (const model of applicationConfig.models) {
@@ -6436,13 +6511,15 @@ async function handler$o(plugin, ctx, options) {
             routeContext: routeContext,
             filters,
         });
+        const outputs = [];
         for (const entity of entities) {
-            await entityManager.deleteById({
+            const output = await entityManager.deleteById({
                 routeContext,
                 id: entity.id,
             }, plugin);
+            outputs.push(output);
         }
-        return {};
+        return outputs;
     });
 }
 
@@ -6456,11 +6533,11 @@ const code$n = "deleteCollectionEntityById";
 async function handler$n(plugin, ctx, options) {
     await runCollectionEntityActionHandler(ctx, options, code$n, true, true, async (entityManager, input) => {
         const { routerContext: routeContext } = ctx;
-        await entityManager.deleteById({
+        const output = await entityManager.deleteById({
             id: input.id,
             routeContext,
         }, plugin);
-        return {};
+        return output;
     });
 }
 
@@ -6475,8 +6552,8 @@ async function handler$m(plugin, ctx, options) {
     await runCollectionEntityActionHandler(ctx, options, code$m, true, true, async (entityManager, input) => {
         const { routerContext: routeContext } = ctx;
         input.routeContext = routeContext;
-        await entityManager.addRelations(input, plugin);
-        return {};
+        const result = await entityManager.addRelations(input, plugin);
+        return result;
     });
 }
 
@@ -6491,8 +6568,8 @@ async function handler$l(plugin, ctx, options) {
     await runCollectionEntityActionHandler(ctx, options, code$l, true, true, async (entityManager, input) => {
         const { routerContext: routeContext } = ctx;
         input.routeContext = routeContext;
-        await entityManager.removeRelations(input, plugin);
-        return {};
+        const result = await entityManager.removeRelations(input, plugin);
+        return result;
     });
 }
 
@@ -10119,9 +10196,9 @@ class EntityAccessControlPlugin {
         if (!userId) {
             return;
         }
-        const actions = await server.queryDatabaseObject(`select distinct a.* from sys_actions a
-      inner join oc_role_sys_action_links ra on a.id = ra.action_id
-      inner join oc_role_user_links ru on ru.role_id = ra.role_id
+        const actions = await server.queryDatabaseObject(`select distinct a.* from sys_actions a
+      inner join oc_role_sys_action_links ra on a.id = ra.action_id
+      inner join oc_role_user_links ru on ru.role_id = ra.role_id
       where ru.user_id = $1;`, [userId]);
         routeContext.state.allowedActions = actions.map((item) => item.code);
     }

package/dist/server.d.ts

@@ -60,6 +60,7 @@ export declare class RapidServer implements IRpdServer {
     runActionHandlers(handlerContext: ActionHandlerContext, actions: RpdRouteActionConfig[]): Promise<void>;
     beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
     beforeRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig): Promise<void>;
+    afterRunActionHandler(handlerContext: ActionHandlerContext, actionConfig: RpdRouteActionConfig, error?: Error): Promise<void>;
     beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
     beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
 }

package/dist/types.d.ts

@@ -147,6 +147,7 @@ export interface RpdEntityAddRelationsEventPayload {
     entity: any;
     property: string;
     relations: any[];
+    relationTargetEntities: any[];
 }
 export interface RpdEntityRemoveRelationsEventPayload {
     namespace: string;
@@ -155,6 +156,7 @@ export interface RpdEntityRemoveRelationsEventPayload {
     entity: any;
     property: string;
     relations: any[];
+    relationTargetEntities: any[];
 }
 export interface RpdEntityBeforeResponseEventPayload {
     namespace: string;

package/package.json

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

package/rollup.config.js

@@ -1,16 +1,16 @@
-import typescript from "rollup-plugin-typescript2";
-import tscAlias from "rollup-plugin-tsc-alias";
-
-export default {
-  input: ["src/index.ts"],
-  output: [
-    {
-      dir: "dist",
-      entryFileNames: "[name].js",
-      format: "cjs",
-      exports: "named",
-    },
-  ],
-  plugins: [typescript(), tscAlias()],
-  external: [],
-};
+import typescript from "rollup-plugin-typescript2";
+import tscAlias from "rollup-plugin-tsc-alias";
+
+export default {
+  input: ["src/index.ts"],
+  output: [
+    {
+      dir: "dist",
+      entryFileNames: "[name].js",
+      format: "cjs",
+      exports: "named",
+    },
+  ],
+  plugins: [typescript(), tscAlias()],
+  external: [],
+};