@ruiapp/rapid-core 0.10.12 → 0.11.0

package/dist/index.js

@@ -2988,7 +2988,11 @@ async function findEntities(server, dataAccessor, options) {
             }
         });
     }
-    const rowFilters = await convertEntityFiltersToRowFilters(routeContext, server, model, baseModel, options.filters);
+    let entityFilters = options.filters;
+    if (!options.includingSoftDeleted) {
+        entityFilters = tryAddUndeletedEntityFilter(model, baseModel, entityFilters);
+    }
+    const rowFilters = await convertEntityFiltersToRowFilters(routeContext, server, model, baseModel, entityFilters);
     const findRowOptions = {
         filters: rowFilters,
         orderBy: convertEntityOrderByToRowOrderBy(server, model, baseModel, options.orderBy),
@@ -3121,6 +3125,33 @@ async function findById(server, dataAccessor, options) {
         routeContext,
     });
 }
+const UNDELETED_ENTITY_FILTER_OPTIONS = {
+    operator: "null",
+    field: "deletedAt",
+};
+function tryAddUndeletedEntityFilter(model, baseModel, filters) {
+    let isEntitySoftDeleteEnabled = baseModel ? baseModel.softDelete : model.softDelete;
+    if (!isEntitySoftDeleteEnabled) {
+        return filters;
+    }
+    if (!filters || !filters.length) {
+        filters = [UNDELETED_ENTITY_FILTER_OPTIONS];
+    }
+    else if (filters.length === 1 && filters[0].operator === "and") {
+        let andFilters = filters[0].filters;
+        if (!andFilters || !andFilters.length) {
+            andFilters = [UNDELETED_ENTITY_FILTER_OPTIONS];
+        }
+        else {
+            andFilters = [UNDELETED_ENTITY_FILTER_OPTIONS, ...andFilters];
+        }
+        filters[0].filters = andFilters;
+    }
+    else {
+        filters = [UNDELETED_ENTITY_FILTER_OPTIONS, ...filters];
+    }
+    return filters;
+}
 async function convertEntityFiltersToRowFilters(routeContext, server, model, baseModel, filters) {
     if (!filters || !filters.length) {
         return [];
@@ -3142,10 +3173,23 @@ async function convertEntityFiltersToRowFilters(routeContext, server, model, bas
             if (!isRelationProperty(relationProperty)) {
                 throw new Error(`Invalid filters. Filter with 'existence' operator on property '${filter.field}' is not allowed. You can only use it on an relation property.`);
             }
-            const relatedEntityFilters = filter.filters;
+            let relatedEntityFilters = filter.filters;
             if (!relatedEntityFilters || !relatedEntityFilters.length) {
                 throw new Error(`Invalid filters. 'filters' must be provided on filter with 'existence' operator.`);
             }
+            const relatedEntityDataAccessor = server.getDataAccessor({
+                singularCode: relationProperty.targetSingularCode,
+            });
+            const relatedModel = relatedEntityDataAccessor.getModel();
+            let relatedBaseModel;
+            if (relatedModel.base) {
+                relatedBaseModel = server.getModel({
+                    singularCode: relatedModel.base,
+                });
+            }
+            if (!filter.includingSoftDeleted) {
+                relatedEntityFilters = tryAddUndeletedEntityFilter(relatedModel, relatedBaseModel, relatedEntityFilters);
+            }
             if (relationProperty.relation === "one") {
                 // Optimize when filtering by id of related entity
                 if (relatedEntityFilters.length === 1) {
@@ -3174,18 +3218,8 @@ async function convertEntityFiltersToRowFilters(routeContext, server, model, bas
                         continue;
                     }
                 }
-                const dataAccessor = server.getDataAccessor({
-                    singularCode: relationProperty.targetSingularCode,
-                });
-                const relatedModel = dataAccessor.getModel();
-                let relatedBaseModel;
-                if (relatedModel.base) {
-                    relatedBaseModel = server.getModel({
-                        singularCode: relatedModel.base,
-                    });
-                }
-                const rows = await dataAccessor.find({
-                    filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, filter.filters),
+                const rows = await relatedEntityDataAccessor.find({
+                    filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, relatedEntityFilters),
                     fields: [
                         {
                             name: "id",
@@ -3208,18 +3242,8 @@ async function convertEntityFiltersToRowFilters(routeContext, server, model, bas
                 if (!relationProperty.selfIdColumnName) {
                     throw new Error(`Invalid filters. 'selfIdColumnName' of property '${relationProperty.code}' was not configured`);
                 }
-                const targetEntityDataAccessor = server.getDataAccessor({
-                    singularCode: relationProperty.targetSingularCode,
-                });
-                const relatedModel = targetEntityDataAccessor.getModel();
-                let relatedBaseModel;
-                if (relatedModel.base) {
-                    relatedBaseModel = server.getModel({
-                        singularCode: relatedModel.base,
-                    });
-                }
-                const targetEntities = await targetEntityDataAccessor.find({
-                    filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, filter.filters),
+                const targetEntities = await relatedEntityDataAccessor.find({
+                    filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, relatedEntityFilters),
                     fields: [
                         {
                             name: relationProperty.selfIdColumnName,
@@ -3248,18 +3272,8 @@ async function convertEntityFiltersToRowFilters(routeContext, server, model, bas
                 // 1. find target entities
                 // 2. find links
                 // 3. convert to 'in' filter
-                const targetEntityDataAccessor = server.getDataAccessor({
-                    singularCode: relationProperty.targetSingularCode,
-                });
-                const relatedModel = targetEntityDataAccessor.getModel();
-                let relatedBaseModel;
-                if (relatedModel.base) {
-                    relatedBaseModel = server.getModel({
-                        singularCode: relatedModel.base,
-                    });
-                }
-                const targetEntities = await targetEntityDataAccessor.find({
-                    filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, filter.filters),
+                const targetEntities = await relatedEntityDataAccessor.find({
+                    filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, relatedEntityFilters),
                     fields: [
                         {
                             name: "id",
@@ -3389,6 +3403,9 @@ async function findManyRelationLinksViaLinkTable(options) {
             if (!lodash.isUndefined(selectRelationOptions.keepNonPropertyFields)) {
                 findEntityOptions.keepNonPropertyFields = selectRelationOptions.keepNonPropertyFields;
             }
+            if (!lodash.isUndefined(selectRelationOptions.includingSoftDeleted)) {
+                findEntityOptions.includingSoftDeleted = selectRelationOptions.includingSoftDeleted;
+            }
         }
     }
     const targetEntities = await findEntities(server, dataAccessor, findEntityOptions);
@@ -3439,6 +3456,9 @@ async function findManyRelatedEntitiesViaIdPropertyCode(options) {
             if (!lodash.isUndefined(selectRelationOptions.keepNonPropertyFields)) {
                 findEntityOptions.keepNonPropertyFields = selectRelationOptions.keepNonPropertyFields;
             }
+            if (!lodash.isUndefined(selectRelationOptions.includingSoftDeleted)) {
+                findEntityOptions.includingSoftDeleted = selectRelationOptions.includingSoftDeleted;
+            }
         }
     }
     return await findEntities(server, dataAccessor, findEntityOptions);
@@ -3467,6 +3487,12 @@ async function findOneRelatedEntitiesViaIdPropertyCode(options) {
             if (selectRelationOptions.relations) {
                 findEntityOptions.relations = selectRelationOptions.relations;
             }
+            if (!lodash.isUndefined(selectRelationOptions.keepNonPropertyFields)) {
+                findEntityOptions.keepNonPropertyFields = selectRelationOptions.keepNonPropertyFields;
+            }
+            if (!lodash.isUndefined(selectRelationOptions.includingSoftDeleted)) {
+                findEntityOptions.includingSoftDeleted = selectRelationOptions.includingSoftDeleted;
+            }
         }
     }
     return await findEntities(server, dataAccessor, findEntityOptions);

package/dist/types.d.ts

@@ -530,6 +530,10 @@ export interface FindEntityOptions {
     relations?: Record<string, FindEntityFindRelationEntitiesOptions>;
     extraColumnsToSelect?: ColumnSelectOptions[];
     keepNonPropertyFields?: boolean;
+    /**
+     * 是否包含已经软删除的实体
+     */
+    includingSoftDeleted?: boolean;
 }
 export interface FindEntityByIdOptions {
     routeContext?: RouteContext;
@@ -567,6 +571,7 @@ export interface FindEntityExistenceFilterOptions {
     field: string;
     operator: EntityFilterExistenceOperators;
     filters: EntityFilterOptions[];
+    includingSoftDeleted?: boolean;
 }
 export interface FindEntityPaginationOptions {
     offset: number;
@@ -578,6 +583,7 @@ export type FindEntityFindOneRelationEntitiesOptions = true | {
     properties?: string[];
     relations?: Record<string, FindEntityFindRelationEntitiesOptions>;
     keepNonPropertyFields?: boolean;
+    includingSoftDeleted?: boolean;
 };
 export type FindEntityFindManyRelationEntitiesOptions = true | {
     properties?: string[];
@@ -586,6 +592,7 @@ export type FindEntityFindManyRelationEntitiesOptions = true | {
     orderBy?: FindEntityOrderByOptions[];
     pagination?: FindEntityPaginationOptions;
     keepNonPropertyFields?: boolean;
+    includingSoftDeleted?: boolean;
 };
 export interface FindEntityOrderByOptions {
     field: string;

package/package.json

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

package/src/dataAccess/entityManager.ts

@@ -248,7 +248,11 @@ async function findEntities(server: IRpdServer, dataAccessor: IRpdDataAccessor,
     });
   }
 
-  const rowFilters = await convertEntityFiltersToRowFilters(routeContext, server, model, baseModel, options.filters);
+  let entityFilters = options.filters;
+  if (!options.includingSoftDeleted) {
+    entityFilters = tryAddUndeletedEntityFilter(model, baseModel, entityFilters);
+  }
+  const rowFilters = await convertEntityFiltersToRowFilters(routeContext, server, model, baseModel, entityFilters);
   const findRowOptions: FindRowOptions = {
     filters: rowFilters,
     orderBy: convertEntityOrderByToRowOrderBy(server, model, baseModel, options.orderBy),
@@ -391,6 +395,34 @@ async function findById(server: IRpdServer, dataAccessor: IRpdDataAccessor, opti
   });
 }
 
+const UNDELETED_ENTITY_FILTER_OPTIONS: EntityFilterOptions = {
+  operator: "null",
+  field: "deletedAt",
+};
+
+function tryAddUndeletedEntityFilter(model: RpdDataModel, baseModel: RpdDataModel, filters: EntityFilterOptions[] | undefined) {
+  let isEntitySoftDeleteEnabled = baseModel ? baseModel.softDelete : model.softDelete;
+  if (!isEntitySoftDeleteEnabled) {
+    return filters;
+  }
+
+  if (!filters || !filters.length) {
+    filters = [UNDELETED_ENTITY_FILTER_OPTIONS];
+  } else if (filters.length === 1 && filters[0].operator === "and") {
+    let andFilters = filters[0].filters;
+    if (!andFilters || !andFilters.length) {
+      andFilters = [UNDELETED_ENTITY_FILTER_OPTIONS];
+    } else {
+      andFilters = [UNDELETED_ENTITY_FILTER_OPTIONS, ...andFilters];
+    }
+    filters[0].filters = andFilters;
+  } else {
+    filters = [UNDELETED_ENTITY_FILTER_OPTIONS, ...filters];
+  }
+
+  return filters;
+}
+
 async function convertEntityFiltersToRowFilters(
   routeContext: RouteContext,
   server: IRpdServer,
@@ -421,11 +453,26 @@ async function convertEntityFiltersToRowFilters(
         );
       }
 
-      const relatedEntityFilters = filter.filters;
+      let relatedEntityFilters = filter.filters;
       if (!relatedEntityFilters || !relatedEntityFilters.length) {
         throw new Error(`Invalid filters. 'filters' must be provided on filter with 'existence' operator.`);
       }
 
+      const relatedEntityDataAccessor = server.getDataAccessor({
+        singularCode: relationProperty.targetSingularCode as string,
+      });
+      const relatedModel = relatedEntityDataAccessor.getModel();
+      let relatedBaseModel: RpdDataModel;
+      if (relatedModel.base) {
+        relatedBaseModel = server.getModel({
+          singularCode: relatedModel.base,
+        });
+      }
+
+      if (!filter.includingSoftDeleted) {
+        relatedEntityFilters = tryAddUndeletedEntityFilter(relatedModel, relatedBaseModel, relatedEntityFilters);
+      }
+
       if (relationProperty.relation === "one") {
         // Optimize when filtering by id of related entity
         if (relatedEntityFilters.length === 1) {
@@ -453,19 +500,9 @@ async function convertEntityFiltersToRowFilters(
           }
         }
 
-        const dataAccessor = server.getDataAccessor({
-          singularCode: relationProperty.targetSingularCode as string,
-        });
-        const relatedModel = dataAccessor.getModel();
-        let relatedBaseModel: RpdDataModel;
-        if (relatedModel.base) {
-          relatedBaseModel = server.getModel({
-            singularCode: relatedModel.base,
-          });
-        }
-        const rows = await dataAccessor.find(
+        const rows = await relatedEntityDataAccessor.find(
           {
-            filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, filter.filters),
+            filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, relatedEntityFilters),
             fields: [
               {
                 name: "id",
@@ -490,19 +527,9 @@ async function convertEntityFiltersToRowFilters(
           throw new Error(`Invalid filters. 'selfIdColumnName' of property '${relationProperty.code}' was not configured`);
         }
 
-        const targetEntityDataAccessor = server.getDataAccessor({
-          singularCode: relationProperty.targetSingularCode as string,
-        });
-        const relatedModel = targetEntityDataAccessor.getModel();
-        let relatedBaseModel: RpdDataModel;
-        if (relatedModel.base) {
-          relatedBaseModel = server.getModel({
-            singularCode: relatedModel.base,
-          });
-        }
-        const targetEntities = await targetEntityDataAccessor.find(
+        const targetEntities = await relatedEntityDataAccessor.find(
           {
-            filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, filter.filters),
+            filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, relatedEntityFilters),
             fields: [
               {
                 name: relationProperty.selfIdColumnName,
@@ -534,19 +561,9 @@ async function convertEntityFiltersToRowFilters(
         // 1. find target entities
         // 2. find links
         // 3. convert to 'in' filter
-        const targetEntityDataAccessor = server.getDataAccessor({
-          singularCode: relationProperty.targetSingularCode as string,
-        });
-        const relatedModel = targetEntityDataAccessor.getModel();
-        let relatedBaseModel: RpdDataModel;
-        if (relatedModel.base) {
-          relatedBaseModel = server.getModel({
-            singularCode: relatedModel.base,
-          });
-        }
-        const targetEntities = await targetEntityDataAccessor.find(
+        const targetEntities = await relatedEntityDataAccessor.find(
           {
-            filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, filter.filters),
+            filters: await convertEntityFiltersToRowFilters(routeContext, server, relatedModel, relatedBaseModel, relatedEntityFilters),
             fields: [
               {
                 name: "id",
@@ -683,6 +700,9 @@ async function findManyRelationLinksViaLinkTable(options: FindManyRelationEntiti
       if (!isUndefined(selectRelationOptions.keepNonPropertyFields)) {
         findEntityOptions.keepNonPropertyFields = selectRelationOptions.keepNonPropertyFields;
       }
+      if (!isUndefined(selectRelationOptions.includingSoftDeleted)) {
+        findEntityOptions.includingSoftDeleted = selectRelationOptions.includingSoftDeleted;
+      }
     }
   }
 
@@ -739,6 +759,9 @@ async function findManyRelatedEntitiesViaIdPropertyCode(options: FindManyRelatio
       if (!isUndefined(selectRelationOptions.keepNonPropertyFields)) {
         findEntityOptions.keepNonPropertyFields = selectRelationOptions.keepNonPropertyFields;
       }
+      if (!isUndefined(selectRelationOptions.includingSoftDeleted)) {
+        findEntityOptions.includingSoftDeleted = selectRelationOptions.includingSoftDeleted;
+      }
     }
   }
 
@@ -772,6 +795,12 @@ async function findOneRelatedEntitiesViaIdPropertyCode(options: FindOneRelationE
       if (selectRelationOptions.relations) {
         findEntityOptions.relations = selectRelationOptions.relations;
       }
+      if (!isUndefined(selectRelationOptions.keepNonPropertyFields)) {
+        findEntityOptions.keepNonPropertyFields = selectRelationOptions.keepNonPropertyFields;
+      }
+      if (!isUndefined(selectRelationOptions.includingSoftDeleted)) {
+        findEntityOptions.includingSoftDeleted = selectRelationOptions.includingSoftDeleted;
+      }
     }
   }
 

package/src/types.ts

@@ -681,6 +681,10 @@ export interface FindEntityOptions {
   relations?: Record<string, FindEntityFindRelationEntitiesOptions>;
   extraColumnsToSelect?: ColumnSelectOptions[];
   keepNonPropertyFields?: boolean;
+  /**
+   * 是否包含已经软删除的实体
+   */
+  includingSoftDeleted?: boolean;
 }
 
 export interface FindEntityByIdOptions {
@@ -725,6 +729,7 @@ export interface FindEntityExistenceFilterOptions {
   field: string;
   operator: EntityFilterExistenceOperators;
   filters: EntityFilterOptions[];
+  includingSoftDeleted?: boolean;
 }
 
 export interface FindEntityPaginationOptions {
@@ -741,6 +746,7 @@ export type FindEntityFindOneRelationEntitiesOptions =
       properties?: string[];
       relations?: Record<string, FindEntityFindRelationEntitiesOptions>;
       keepNonPropertyFields?: boolean;
+      includingSoftDeleted?: boolean;
     };
 
 export type FindEntityFindManyRelationEntitiesOptions =
@@ -752,6 +758,7 @@ export type FindEntityFindManyRelationEntitiesOptions =
       orderBy?: FindEntityOrderByOptions[];
       pagination?: FindEntityPaginationOptions;
       keepNonPropertyFields?: boolean;
+      includingSoftDeleted?: boolean;
     };
 
 export interface FindEntityOrderByOptions {