@ruiapp/rapid-core 0.2.7 → 0.2.9

package/dist/dataAccess/dataAccessor.d.ts

@@ -17,6 +17,6 @@ export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
     find(options: FindRowOptions): Promise<T[]>;
     findOne(options: FindRowOptions): Promise<T>;
     findById(id: any): Promise<T | null>;
-    count(options: CountRowOptions): Promise<any>;
+    count(options: CountRowOptions): Promise<number>;
     deleteById(id: any): Promise<void>;
 }

package/dist/dataAccess/entityManager.d.ts

@@ -1,4 +1,4 @@
-import { AddEntityRelationsOptions, CountEntityOptions, CountEntityResult, CreateEntityOptions, DeleteEntityByIdOptions, FindEntityByIdOptions, FindEntityOptions, IRpdDataAccessor, RemoveEntityRelationsOptions, RpdDataModel, RpdDataModelIndex, RpdDataModelProperty, UpdateEntityByIdOptions, FindEntityFindOneRelationEntitiesOptions, FindEntityFindManyRelationEntitiesOptions } from "../types";
+import { AddEntityRelationsOptions, CountEntityOptions, CreateEntityOptions, DeleteEntityByIdOptions, FindEntityByIdOptions, FindEntityOptions, IRpdDataAccessor, RemoveEntityRelationsOptions, RpdDataModel, RpdDataModelIndex, RpdDataModelProperty, UpdateEntityByIdOptions, FindEntityFindOneRelationEntitiesOptions, FindEntityFindManyRelationEntitiesOptions } from "../types";
 import { IRpdServer, RapidPlugin } from "../core/server";
 import { RouteContext } from "../core/routeContext";
 export type FindOneRelationEntitiesOptions = {
@@ -30,7 +30,7 @@ export default class EntityManager<TEntity = any> {
     findById(options: FindEntityByIdOptions | string | number): Promise<TEntity | null>;
     createEntity(options: CreateEntityOptions, plugin?: RapidPlugin): Promise<TEntity>;
     updateEntityById(options: UpdateEntityByIdOptions, plugin?: RapidPlugin): Promise<TEntity>;
-    count(options: CountEntityOptions): Promise<CountEntityResult>;
+    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>;

package/dist/index.js

@@ -159,11 +159,9 @@ class DataAccessor {
         const result = await this.#databaseAccessor.queryDatabaseObject(query.command, query.params);
         const row = lodash.first(result);
         if (row) {
-            return row;
+            return row.count;
         }
-        return {
-            count: 0,
-        };
+        return 0;
     }
     async deleteById(id) {
         const options = {
@@ -3254,15 +3252,15 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
     const updatedEntityOneRelationProps = {};
     for (const property of oneRelationPropertiesToUpdate) {
         const rowToBeSaved = property.isBaseProperty ? baseRow : row;
-        const fieldValue = changes[property.code];
+        const relatedEntityToBeSaved = changes[property.code];
         const targetDataAccessor = server.getDataAccessor({
             singularCode: property.targetSingularCode,
         });
-        if (lodash.isObject(fieldValue)) {
-            const targetEntityId = fieldValue["id"];
-            if (!targetEntityId) {
+        if (lodash.isObject(relatedEntityToBeSaved)) {
+            const relatedEntityId = relatedEntityToBeSaved["id"];
+            if (!relatedEntityId) {
                 if (!property.selfIdColumnName) {
-                    const targetEntity = fieldValue;
+                    const targetEntity = relatedEntityToBeSaved;
                     const newTargetEntity = await createEntity(server, targetDataAccessor, {
                         routeContext,
                         entity: targetEntity,
@@ -3272,20 +3270,44 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
                 }
             }
             else {
-                const targetEntity = await findById(server, targetDataAccessor, {
-                    id: targetEntityId,
+                let targetEntity = await findById(server, targetDataAccessor, {
+                    id: relatedEntityId,
                     routeContext,
                 });
                 if (!targetEntity) {
-                    throw newEntityOperationError(`Create ${model.singularCode} entity failed. Property '${property.code}' was invalid. Related ${property.targetSingularCode} entity with id '${targetEntityId}' was not found.`);
+                    throw newEntityOperationError(`Update ${model.singularCode} entity failed. Property '${property.code}' was invalid. Related ${property.targetSingularCode} entity with id '${relatedEntityId}' was not found.`);
+                }
+                // update relation entity if options.relationPropertiesToUpdate is specified.
+                const updateRelationPropertiesOptions = lodash.get(options.relationPropertiesToUpdate, property.code);
+                let subRelationPropertiesToUpdate = undefined;
+                let relationEntityToUpdate = null;
+                if (updateRelationPropertiesOptions === true) {
+                    relationEntityToUpdate = targetEntity;
+                }
+                else if (updateRelationPropertiesOptions) {
+                    let propertiesToUpdate = lodash.uniq([
+                        "id",
+                        ...(updateRelationPropertiesOptions.propertiesToUpdate || []),
+                        ...Object.keys(updateRelationPropertiesOptions.relationPropertiesToUpdate || []),
+                    ]);
+                    relationEntityToUpdate = lodash.pick(relatedEntityToBeSaved, propertiesToUpdate);
+                    subRelationPropertiesToUpdate = updateRelationPropertiesOptions.relationPropertiesToUpdate;
+                }
+                if (relationEntityToUpdate) {
+                    targetEntity = await updateEntityById(server, targetDataAccessor, {
+                        routeContext: routeContext,
+                        id: relatedEntityId,
+                        entityToSave: relationEntityToUpdate,
+                        relationPropertiesToUpdate: subRelationPropertiesToUpdate,
+                    });
                 }
                 updatedEntityOneRelationProps[property.code] = targetEntity;
-                rowToBeSaved[property.targetIdColumnName] = targetEntityId;
+                rowToBeSaved[property.targetIdColumnName] = relatedEntityId;
             }
         }
-        else if (lodash.isNumber(fieldValue) || lodash.isString(fieldValue)) {
+        else if (lodash.isNumber(relatedEntityToBeSaved) || lodash.isString(relatedEntityToBeSaved)) {
             // fieldValue is id;
-            const targetEntityId = fieldValue;
+            const targetEntityId = relatedEntityToBeSaved;
             const targetEntity = await findById(server, targetDataAccessor, {
                 id: targetEntityId,
                 routeContext,
@@ -3419,9 +3441,33 @@ async function updateEntityById(server, dataAccessor, options, plugin) {
                 }
                 else {
                     // related entity is existed
-                    const targetEntity = await targetDataAccessor.findById(relatedEntityId);
+                    let targetEntity = await targetDataAccessor.findById(relatedEntityId);
                     if (!targetEntity) {
-                        throw new Error(`Entity with id '${relatedEntityId}' in field '${property.code}' is not exists.`);
+                        throw new Error(`Entity with id '${relatedEntityId}' in field '${property.code}' does not exist.`);
+                    }
+                    // update relation entity if options.relationPropertiesToUpdate is specified.
+                    const updateRelationPropertiesOptions = lodash.get(options.relationPropertiesToUpdate, property.code);
+                    let subRelationPropertiesToUpdate = undefined;
+                    let relationEntityToUpdate = null;
+                    if (updateRelationPropertiesOptions === true) {
+                        relationEntityToUpdate = targetEntity;
+                    }
+                    else if (updateRelationPropertiesOptions) {
+                        let propertiesToUpdate = lodash.uniq([
+                            "id",
+                            ...(updateRelationPropertiesOptions.propertiesToUpdate || []),
+                            ...Object.keys(updateRelationPropertiesOptions.relationPropertiesToUpdate || []),
+                        ]);
+                        relationEntityToUpdate = lodash.pick(relatedEntityToBeSaved, propertiesToUpdate);
+                        subRelationPropertiesToUpdate = updateRelationPropertiesOptions.relationPropertiesToUpdate;
+                    }
+                    if (relationEntityToUpdate) {
+                        targetEntity = await updateEntityById(server, targetDataAccessor, {
+                            routeContext: routeContext,
+                            id: relatedEntityId,
+                            entityToSave: relationEntityToUpdate,
+                            relationPropertiesToUpdate: subRelationPropertiesToUpdate,
+                        });
                     }
                     if (!currentTargetIds.includes(relatedEntityId)) {
                         if (property.linkTableName) {
@@ -4790,8 +4836,8 @@ async function handler$q(plugin, ctx, options) {
         const result = { list: entities };
         if (input.pagination && !input.pagination.withoutTotal) {
             // TOOD: count entities when calling findEntities for performance.
-            const countResult = await entityManager.count(input);
-            result.total = countResult.count;
+            const total = await entityManager.count(input);
+            result.total = total;
         }
         return result;
     });
@@ -4827,10 +4873,11 @@ var findCollectionEntityById = /*#__PURE__*/Object.freeze({
 
 const code$o = "countCollectionEntities";
 async function handler$o(plugin, ctx, options) {
-    await runCollectionEntityActionHandler(ctx, options, code$o, (entityManager, input) => {
+    await runCollectionEntityActionHandler(ctx, options, code$o, async (entityManager, input) => {
         input.filters = removeFiltersWithNullValue(input.filters);
         input.routeContext = ctx.routerContext;
-        return entityManager.count(input);
+        const count = await entityManager.count(input);
+        return { count };
     });
 }
 
@@ -4906,11 +4953,16 @@ async function handler$l(plugin, ctx, options) {
     if (stateProperties) {
         delete mergedInput.$stateProperties;
     }
+    const relationPropertiesToUpdate = mergedInput.$relationPropertiesToUpdate;
+    if (relationPropertiesToUpdate) {
+        delete mergedInput.$relationPropertiesToUpdate;
+    }
     const updateEntityByIdOptions = {
         id: mergedInput.id,
         entityToSave: mergedInput,
         operation,
         stateProperties,
+        relationPropertiesToUpdate,
         routeContext: ctx.routerContext,
     };
     const entityManager = server.getEntityManager(options.singularCode);

package/dist/types.d.ts

@@ -377,7 +377,7 @@ export interface IRpdDataAccessor<T = any> {
     find(options: FindRowOptions): Promise<T[]>;
     findOne(options: FindRowOptions): Promise<T | null>;
     findById(id: any): Promise<T | null>;
-    count(options: CountRowOptions): Promise<any>;
+    count(options: CountRowOptions): Promise<number>;
     deleteById(id: any): Promise<void>;
 }
 export type EntityFilterRelationalOperators = "eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "contains" | "notContains" | "containsCS" | "notContainsCS" | "startsWith" | "notStartsWith" | "endsWith" | "notEndsWith";
@@ -487,9 +487,20 @@ export interface UpdateEntityByIdOptions {
     operation?: {
         type: string;
     };
+    /**
+     * 指定需要更新那几个状态属性（配置了`config.stateMachine`的属性）。当不指定时默认更新全部状态属性。
+     */
     stateProperties?: string[];
     postponeUniquenessCheck?: boolean;
+    /**
+     * 指定需要更新关联对象的哪些属性。更新实体时，会创建关联对象，但是默认不更新关联对象的属性。
+     */
+    relationPropertiesToUpdate?: Record<string, UpdateRelationPropertiesOptions>;
 }
+export type UpdateRelationPropertiesOptions = true | {
+    propertiesToUpdate?: string[];
+    relationPropertiesToUpdate?: Record<string, UpdateRelationPropertiesOptions>;
+};
 export interface DeleteEntityOptions {
     routeContext?: RouteContext;
     filters?: EntityFilterOptions[];

package/package.json

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

package/src/dataAccess/dataAccessor.ts

@@ -98,7 +98,7 @@ export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
     return result;
   }
 
-  async count(options: CountRowOptions): Promise<any> {
+  async count(options: CountRowOptions): Promise<number> {
     let query: DatabaseQuery;
     if (this.#model.base) {
       const baseModel = this.#server.getModel({
@@ -112,11 +112,9 @@ export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
 
     const row = first(result);
     if (row) {
-      return row;
+      return row.count;
     }
-    return {
-      count: 0,
-    };
+    return 0;
   }
 
   async deleteById(id: any) {

package/src/dataAccess/entityManager.ts

@@ -1,7 +1,6 @@
 import {
   AddEntityRelationsOptions,
   CountEntityOptions,
-  CountEntityResult,
   CreateEntityOptions,
   DeleteEntityByIdOptions,
   EntityFilterOperators,
@@ -25,7 +24,26 @@ import { mapDbRowToEntity, mapEntityToDbRow } from "./entityMapper";
 import { mapPropertyNameToColumnName } from "./propertyMapper";
 import { IRpdServer, RapidPlugin } from "~/core/server";
 import { getEntityPartChanges } from "~/helpers/entityHelpers";
-import { cloneDeep, filter, find, first, forEach, isArray, isNumber, isObject, isPlainObject, isString, isUndefined, keys, map, reject, uniq } from "lodash";
+import {
+  cloneDeep,
+  concat,
+  filter,
+  find,
+  first,
+  forEach,
+  get,
+  isArray,
+  isNumber,
+  isObject,
+  isPlainObject,
+  isString,
+  isUndefined,
+  keys,
+  map,
+  pick,
+  reject,
+  uniq,
+} from "lodash";
 import {
   getEntityPropertiesIncludingBase,
   getEntityProperty,
@@ -1104,16 +1122,16 @@ async function updateEntityById(server: IRpdServer, dataAccessor: IRpdDataAccess
   const updatedEntityOneRelationProps = {};
   for (const property of oneRelationPropertiesToUpdate) {
     const rowToBeSaved = property.isBaseProperty ? baseRow : row;
-    const fieldValue = changes[property.code];
+    const relatedEntityToBeSaved = changes[property.code];
     const targetDataAccessor = server.getDataAccessor({
       singularCode: property.targetSingularCode!,
     });
 
-    if (isObject(fieldValue)) {
-      const targetEntityId = fieldValue["id"];
-      if (!targetEntityId) {
+    if (isObject(relatedEntityToBeSaved)) {
+      const relatedEntityId = relatedEntityToBeSaved["id"];
+      if (!relatedEntityId) {
         if (!property.selfIdColumnName) {
-          const targetEntity = fieldValue;
+          const targetEntity = relatedEntityToBeSaved;
           const newTargetEntity = await createEntity(server, targetDataAccessor, {
             routeContext,
             entity: targetEntity,
@@ -1122,21 +1140,46 @@ async function updateEntityById(server: IRpdServer, dataAccessor: IRpdDataAccess
           rowToBeSaved[property.targetIdColumnName!] = newTargetEntity["id"];
         }
       } else {
-        const targetEntity = await findById(server, targetDataAccessor, {
-          id: targetEntityId,
+        let targetEntity = await findById(server, targetDataAccessor, {
+          id: relatedEntityId,
           routeContext,
         });
         if (!targetEntity) {
           throw newEntityOperationError(
-            `Create ${model.singularCode} entity failed. Property '${property.code}' was invalid. Related ${property.targetSingularCode} entity with id '${targetEntityId}' was not found.`,
+            `Update ${model.singularCode} entity failed. Property '${property.code}' was invalid. Related ${property.targetSingularCode} entity with id '${relatedEntityId}' was not found.`,
           );
         }
+
+        // update relation entity if options.relationPropertiesToUpdate is specified.
+        const updateRelationPropertiesOptions = get(options.relationPropertiesToUpdate, property.code);
+        let subRelationPropertiesToUpdate = undefined;
+        let relationEntityToUpdate = null;
+        if (updateRelationPropertiesOptions === true) {
+          relationEntityToUpdate = targetEntity;
+        } else if (updateRelationPropertiesOptions) {
+          let propertiesToUpdate = uniq([
+            "id",
+            ...(updateRelationPropertiesOptions.propertiesToUpdate || []),
+            ...Object.keys(updateRelationPropertiesOptions.relationPropertiesToUpdate || []),
+          ]);
+          relationEntityToUpdate = pick(relatedEntityToBeSaved, propertiesToUpdate);
+          subRelationPropertiesToUpdate = updateRelationPropertiesOptions.relationPropertiesToUpdate;
+        }
+        if (relationEntityToUpdate) {
+          targetEntity = await updateEntityById(server, targetDataAccessor, {
+            routeContext: routeContext,
+            id: relatedEntityId,
+            entityToSave: relationEntityToUpdate,
+            relationPropertiesToUpdate: subRelationPropertiesToUpdate,
+          });
+        }
+
         updatedEntityOneRelationProps[property.code] = targetEntity;
-        rowToBeSaved[property.targetIdColumnName!] = targetEntityId;
+        rowToBeSaved[property.targetIdColumnName!] = relatedEntityId;
       }
-    } else if (isNumber(fieldValue) || isString(fieldValue)) {
+    } else if (isNumber(relatedEntityToBeSaved) || isString(relatedEntityToBeSaved)) {
       // fieldValue is id;
-      const targetEntityId = fieldValue;
+      const targetEntityId = relatedEntityToBeSaved;
       const targetEntity = await findById(server, targetDataAccessor, {
         id: targetEntityId,
         routeContext,
@@ -1290,9 +1333,33 @@ async function updateEntityById(server: IRpdServer, dataAccessor: IRpdDataAccess
           relatedEntities.push(newTargetEntity);
         } else {
           // related entity is existed
-          const targetEntity = await targetDataAccessor.findById(relatedEntityId);
+          let targetEntity = await targetDataAccessor.findById(relatedEntityId);
           if (!targetEntity) {
-            throw new Error(`Entity with id '${relatedEntityId}' in field '${property.code}' is not exists.`);
+            throw new Error(`Entity with id '${relatedEntityId}' in field '${property.code}' does not exist.`);
+          }
+
+          // update relation entity if options.relationPropertiesToUpdate is specified.
+          const updateRelationPropertiesOptions = get(options.relationPropertiesToUpdate, property.code);
+          let subRelationPropertiesToUpdate = undefined;
+          let relationEntityToUpdate = null;
+          if (updateRelationPropertiesOptions === true) {
+            relationEntityToUpdate = targetEntity;
+          } else if (updateRelationPropertiesOptions) {
+            let propertiesToUpdate = uniq([
+              "id",
+              ...(updateRelationPropertiesOptions.propertiesToUpdate || []),
+              ...Object.keys(updateRelationPropertiesOptions.relationPropertiesToUpdate || []),
+            ]);
+            relationEntityToUpdate = pick(relatedEntityToBeSaved, propertiesToUpdate);
+            subRelationPropertiesToUpdate = updateRelationPropertiesOptions.relationPropertiesToUpdate;
+          }
+          if (relationEntityToUpdate) {
+            targetEntity = await updateEntityById(server, targetDataAccessor, {
+              routeContext: routeContext,
+              id: relatedEntityId,
+              entityToSave: relationEntityToUpdate,
+              relationPropertiesToUpdate: subRelationPropertiesToUpdate,
+            });
           }
 
           if (!currentTargetIds.includes(relatedEntityId)) {
@@ -1459,7 +1526,7 @@ export default class EntityManager<TEntity = any> {
     return await updateEntityById(this.#server, this.#dataAccessor, options, plugin);
   }
 
-  async count(options: CountEntityOptions): Promise<CountEntityResult> {
+  async count(options: CountEntityOptions): Promise<number> {
     const model = this.#dataAccessor.getModel();
     let baseModel: RpdDataModel;
     if (model.base) {

package/src/plugins/dataManage/actionHandlers/countCollectionEntities.ts

@@ -1,4 +1,4 @@
-import { CountEntityOptions, RunEntityActionHandlerOptions } from "~/types";
+import { CountEntityOptions, CountEntityResult, RunEntityActionHandlerOptions } from "~/types";
 import runCollectionEntityActionHandler from "~/helpers/runCollectionEntityActionHandler";
 import { removeFiltersWithNullValue } from "~/helpers/filterHelper";
 import { ActionHandlerContext } from "~/core/actionHandler";
@@ -7,9 +7,10 @@ import { RapidPlugin } from "~/core/server";
 export const code = "countCollectionEntities";
 
 export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  await runCollectionEntityActionHandler(ctx, options, code, (entityManager, input: CountEntityOptions) => {
+  await runCollectionEntityActionHandler(ctx, options, code, async (entityManager, input: CountEntityOptions): Promise<CountEntityResult> => {
     input.filters = removeFiltersWithNullValue(input.filters);
     input.routeContext = ctx.routerContext;
-    return entityManager.count(input);
+    const count = await entityManager.count(input);
+    return { count };
   });
 }

package/src/plugins/dataManage/actionHandlers/findCollectionEntities.ts

@@ -18,8 +18,8 @@ export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, op
 
     if (input.pagination && !input.pagination.withoutTotal) {
       // TOOD: count entities when calling findEntities for performance.
-      const countResult = await entityManager.count(input);
-      result.total = countResult.count;
+      const total = await entityManager.count(input);
+      result.total = total;
     }
     return result;
   });

package/src/plugins/dataManage/actionHandlers/updateCollectionEntityById.ts

@@ -22,11 +22,17 @@ export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, op
     delete mergedInput.$stateProperties;
   }
 
+  const relationPropertiesToUpdate = mergedInput.$relationPropertiesToUpdate;
+  if (relationPropertiesToUpdate) {
+    delete mergedInput.$relationPropertiesToUpdate;
+  }
+
   const updateEntityByIdOptions: UpdateEntityByIdOptions = {
     id: mergedInput.id,
     entityToSave: mergedInput,
     operation,
     stateProperties,
+    relationPropertiesToUpdate,
     routeContext: ctx.routerContext,
   };
   const entityManager = server.getEntityManager(options.singularCode);

package/src/types.ts

@@ -456,7 +456,7 @@ export interface IRpdDataAccessor<T = any> {
   find(options: FindRowOptions): Promise<T[]>;
   findOne(options: FindRowOptions): Promise<T | null>;
   findById(id: any): Promise<T | null>;
-  count(options: CountRowOptions): Promise<any>;
+  count(options: CountRowOptions): Promise<number>;
   deleteById(id: any): Promise<void>;
 }
 
@@ -628,10 +628,24 @@ export interface UpdateEntityByIdOptions {
   operation?: {
     type: string;
   };
+  /**
+   * 指定需要更新那几个状态属性（配置了`config.stateMachine`的属性）。当不指定时默认更新全部状态属性。
+   */
   stateProperties?: string[];
   postponeUniquenessCheck?: boolean;
+  /**
+   * 指定需要更新关联对象的哪些属性。更新实体时，会创建关联对象，但是默认不更新关联对象的属性。
+   */
+  relationPropertiesToUpdate?: Record<string, UpdateRelationPropertiesOptions>;
 }
 
+export type UpdateRelationPropertiesOptions =
+  | true
+  | {
+      propertiesToUpdate?: string[];
+      relationPropertiesToUpdate?: Record<string, UpdateRelationPropertiesOptions>;
+    };
+
 export interface DeleteEntityOptions {
   routeContext?: RouteContext;
   filters?: EntityFilterOptions[];