@ruiapp/rapid-core 0.11.7 → 0.12.0

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/index.js

@@ -1798,6 +1798,21 @@ var bootstrapApplicationConfig = {
                     required: true,
                     defaultValue: "false",
                 },
+                {
+                    name: "enableEventLog",
+                    code: "enableEventLog",
+                    columnName: "enable_event_log",
+                    type: "boolean",
+                    required: true,
+                    defaultValue: "false",
+                },
+                {
+                    name: "eventTypePolicy",
+                    code: "eventTypePolicy",
+                    columnName: "event_type_policy",
+                    type: "json",
+                    required: false,
+                },
                 {
                     name: "defaultOrderBy",
                     code: "defaultOrderBy",
@@ -2975,6 +2990,17 @@ async function findEntities(server, dataAccessor, options) {
     else {
         propertiesToSelect = getEntityPropertiesIncludingBase(server, model).filter((property) => options.properties.includes(property.code) || relationPropertyCodes.includes(property.code));
     }
+    const isEntitySoftDeleteEnabled = baseModel ? baseModel.softDelete || model.softDelete : model.softDelete;
+    if (options.includingSoftDeleted && isEntitySoftDeleteEnabled) {
+        const deletedAtProp = getEntityPropertyByCode(server, model, "deletedAt");
+        if (deletedAtProp && !lodash.find(propertiesToSelect, (p) => p.code === "deletedAt")) {
+            propertiesToSelect.push(deletedAtProp);
+        }
+        const deletedByProp = getEntityPropertyByCode(server, model, "deletedBy");
+        if (deletedByProp && !lodash.find(propertiesToSelect, (p) => p.code === "deletedBy")) {
+            propertiesToSelect.push(deletedByProp);
+        }
+    }
     const columnsToSelect = [];
     const relationPropertiesToSelect = [];
     lodash.forEach(propertiesToSelect, (property) => {
@@ -3424,8 +3450,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());
@@ -3444,6 +3470,7 @@ async function findManyRelationLinksViaLinkTable(options) {
             },
         ],
         keepNonPropertyFields: true,
+        includingSoftDeleted: true,
     };
     if (selectRelationOptions) {
         if (typeof selectRelationOptions !== "boolean") {
@@ -3497,6 +3524,7 @@ async function findManyRelatedEntitiesViaIdPropertyCode(options) {
         ],
         extraColumnsToSelect: [relationProperty.selfIdColumnName],
         keepNonPropertyFields: true,
+        includingSoftDeleted: true,
     };
     if (selectRelationOptions) {
         if (typeof selectRelationOptions !== "boolean") {
@@ -3540,6 +3568,7 @@ async function findOneRelatedEntitiesViaIdPropertyCode(options) {
             },
         ],
         keepNonPropertyFields: true,
+        includingSoftDeleted: true,
     };
     if (selectRelationOptions) {
         if (typeof selectRelationOptions !== "boolean") {
@@ -4078,7 +4107,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 {
@@ -4107,8 +4136,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 {
@@ -4406,7 +4435,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 {
@@ -4416,8 +4445,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());
                     }
                 }
@@ -4483,8 +4512,12 @@ class EntityManager {
                 singularCode: model.base,
             });
         }
+        let entityFilters = options.filters;
+        if (!options.includingSoftDeleted) {
+            entityFilters = tryAddUndeletedEntityFilter(model, baseModel, entityFilters);
+        }
         const countRowOptions = {
-            filters: await convertEntityFiltersToRowFilters(routeContext, this.#server, model, baseModel, options.filters),
+            filters: await convertEntityFiltersToRowFilters(routeContext, this.#server, model, baseModel, entityFilters),
         };
         return await this.#dataAccessor.count(countRowOptions, routeContext?.getDbTransactionClient());
     }
@@ -4517,11 +4550,11 @@ class EntityManager {
                 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];
@@ -4588,7 +4621,7 @@ class EntityManager {
         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];
                 const result = await server.queryDatabaseObject(command, params, routeContext?.getDbTransactionClient());
@@ -5965,9 +5998,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) {
@@ -10196,9 +10229,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/types.d.ts

@@ -228,6 +228,14 @@ export interface RpdDataModel {
      * 是否使用软删除
      */
     softDelete?: boolean;
+    /**
+     * 是否启用事件日志
+     */
+    enableEventLog?: boolean;
+    /**
+     * 事件类型策略
+     */
+    eventTypePolicy?: RapidEntityEventTypePolicy;
     /**
      * 多语言配置
      */
@@ -255,6 +263,29 @@ export interface PermissionPolicy {
     any?: string[];
     all?: string[];
 }
+export interface RapidEntityEventTypePolicy {
+    /**
+     * 区分事件类型属性code
+     */
+    propertyCode?: string;
+    /**
+     * 属性值事件类型
+     */
+    eventTypes?: {
+        /**
+         * 属性值
+         */
+        propertyValue: string;
+        /**
+         * 事件code前缀 默认取 propertyValue 的值
+         */
+        eventTypeCodePrefix?: string;
+        /**
+         * 属性值名称 区分定义事件类型名称
+         */
+        name: string;
+    }[];
+}
 export interface RpdDataModelProperty {
     /**
      * 表示此属性由谁来维护
@@ -604,6 +635,7 @@ export interface FindEntityOrderByOptions {
 export interface CountEntityOptions {
     routeContext?: RouteContext;
     filters?: EntityFilterOptions[];
+    includingSoftDeleted?: boolean;
 }
 export interface CountEntityResult {
     count: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.11.7",
+  "version": "0.12.0",
   "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: [],
+};