@ruiapp/rapid-core 0.1.41 → 0.1.43

package/src/types.ts

@@ -1,4 +1,5 @@
 import { RapidPlugin } from "./core/server";
+import { CountRowOptions, FindRowOptions } from "./dataAccess/dataAccessTypes";
 
 export type RapidServerConfig = {
   baseUrl?: string;
@@ -17,11 +18,15 @@ export interface IDatabaseConfig {
   dbPoolConnections?: number;
 }
 
+export type DatabaseQuery = {
+  command: string;
+  params?: unknown[] | Record<string, unknown>;
+}
+
 export interface IDatabaseAccessor {
   queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
 }
 
-
 export interface RunEntityActionHandlerOptions {
   /** 模型所在的命名空间 */
   namespace: string;
@@ -75,18 +80,21 @@ export type RpdServerEventTypes = {
 export interface RpdEntityBeforeCreateEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   before: any;
 }
 
 export interface RpdEntityCreateEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   after: any;
 }
 
 export interface RpdEntityBeforeUpdateEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   before: any;
   changes: any;
 }
@@ -94,6 +102,7 @@ export interface RpdEntityBeforeUpdateEventPayload {
 export interface RpdEntityUpdateEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   before: any;
   after: any;
   changes: any;
@@ -102,18 +111,21 @@ export interface RpdEntityUpdateEventPayload {
 export interface RpdEntityBeforeDeleteEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   before: any;
 }
 
 export interface RpdEntityDeleteEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   before: any;
 }
 
 export interface RpdEntityAddRelationsEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   entity: any;
   property: string;
   relations: any[];
@@ -122,6 +134,7 @@ export interface RpdEntityAddRelationsEventPayload {
 export interface RpdEntityRemoveRelationsEventPayload {
   namespace: string;
   modelSingularCode: string;
+  baseModelSingularCode?: string;
   entity: any;
   property: string;
   relations: any[];
@@ -137,7 +150,6 @@ export interface IQueryBuilder {
   quoteObject: (name: string) => string;
 }
 
-
 export interface RpdApplicationConfig {
   code?: string;
   name?: string;
@@ -153,6 +165,18 @@ export interface RpdDataModel {
   pluralCode: string;
   schema?: string;
   tableName: string;
+  /**
+   * Configure the singular code of base entity.
+   */
+  base?: string;
+  /**
+   * Configure the type of derived entity.
+   */
+  derivedType?: string;
+  /**
+   * Configure the property code to save derived type for base entity.
+   */
+  derivedTypePropertyCode?: string;
   properties: RpdDataModelProperty[];
   extensions?: RpdDataModelExtension[];
   permissionPolicies?: RpdDataModelPermissionPolicies;
@@ -175,6 +199,10 @@ export interface RpdDataModelProperty {
    * 表示此属性由谁来维护
    */
   maintainedBy?: string;
+  /**
+   * 表示是否基础属性
+   */
+  isBaseProperty?: boolean;
   /**
    * 字段名称。可以包含中文。
    */
@@ -244,21 +272,7 @@ export interface RpdDataModelProperty {
   linkSchema?: string;
 }
 
-export type RpdDataPropertyTypes =
-  | "integer"
-  | "long"
-  | "float"
-  | "double"
-  | "decimal"
-  | "text"
-  | "boolean"
-  | "date"
-  | "datetime"
-  | "json"
-  | "relation"
-  | "relation[]"
-  | "option";
-
+export type RpdDataPropertyTypes = "integer" | "long" | "float" | "double" | "decimal" | "text" | "boolean" | "date" | "datetime" | "json" | "relation" | "relation[]" | "option";
 
 /**
  * 数据字典
@@ -277,7 +291,7 @@ export type RpdDataDictionary = {
   /**
    * 字典项值类型
    */
-  type: 'string' | 'integer';
+  type: "string" | "integer";
 
   /**
    * 字典项
@@ -315,16 +329,12 @@ export type RpdDataDictionaryEntry = {
   disabled: boolean;
 };
 
-
 export interface RpdDataModelExtension {
   code: string;
   config: any;
 }
 
-export type EventHandler<T = any> = (
-  sender: RapidPlugin,
-  payload: T,
-) => void;
+export type EventHandler<T = any> = (sender: RapidPlugin, payload: T) => void;
 
 export interface RpdRoute {
   name: string;
@@ -347,69 +357,34 @@ export interface IRpdDataAccessor<T = any> {
   getModel(): RpdDataModel;
   create(entity: any): Promise<any>;
   updateById(id: any, entity: any): Promise<any>;
-  find(options: FindEntityOptions): Promise<T[]>;
-  findOne(options: FindEntityOptions): Promise<T | null>;
+  find(options: FindRowOptions): Promise<T[]>;
+  findOne(options: FindRowOptions): Promise<T | null>;
   findById(id: any): Promise<T | null>;
-  count(options: CountEntityOptions): Promise<any>;
+  count(options: CountRowOptions): Promise<any>;
   deleteById(id: any): Promise<void>;
 }
 
-export type EntityFilterRelationalOperators =
-  | "eq"
-  | "ne"
-  | "lt"
-  | "lte"
-  | "gt"
-  | "gte"
-  | "contains"
-  | "notContains"
-  | "containsCS"
-  | "notContainsCS"
-  | "startsWith"
-  | "notStartsWith"
-  | "endsWith"
-  | "notEndsWith";
-
-export type EntityFilterSetOperators =
-  | "in"
-  | "notIn";
-
-export type EntityFilterLogicalOperators =
-  | "or"
-  | "and";
-
-export type EntityFilterUnaryOperators =
-  | "null"
-  | "notNull";
-
-export type EntityFilterExistenceOperators =
-  | "exists"
-  | "notExists";
-
-export type EntityFilterOperators =
-  | EntityFilterRelationalOperators
-  | EntityFilterSetOperators
-  | EntityFilterLogicalOperators
-  | EntityFilterUnaryOperators
-  | EntityFilterExistenceOperators;
-
-export type EntityFilterOptions =
-  | FindEntityRelationalFilterOptions
-  | FindEntitySetFilterOptions
-  | FindEntityLogicalFilterOptions
-  | FindEntityUnaryFilterOptions
-  | FindEntityExistenceFilterOptions;
-
-export type  EntityNonRelationPropertyFilterOptions =
-  | FindEntityRelationalFilterOptions
-  | FindEntitySetFilterOptions
-  | FindEntityUnaryFilterOptions;
+export type EntityFilterRelationalOperators = "eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "contains" | "notContains" | "containsCS" | "notContainsCS" | "startsWith" | "notStartsWith" | "endsWith" | "notEndsWith";
+
+export type EntityFilterSetOperators = "in" | "notIn";
+
+export type EntityFilterLogicalOperators = "or" | "and";
+
+export type EntityFilterUnaryOperators = "null" | "notNull";
+
+export type EntityFilterExistenceOperators = "exists" | "notExists";
+
+export type EntityFilterOperators = EntityFilterRelationalOperators | EntityFilterSetOperators | EntityFilterLogicalOperators | EntityFilterUnaryOperators | EntityFilterExistenceOperators;
+
+export type EntityFilterOptions = FindEntityRelationalFilterOptions | FindEntitySetFilterOptions | FindEntityLogicalFilterOptions | FindEntityUnaryFilterOptions | FindEntityExistenceFilterOptions;
+
+export type EntityNonRelationPropertyFilterOptions = FindEntityRelationalFilterOptions | FindEntitySetFilterOptions | FindEntityUnaryFilterOptions;
 
 export interface FindEntityOptions {
   filters?: EntityFilterOptions[];
   orderBy?: FindEntityOrderByOptions[];
   pagination?: FindEntityPaginationOptions;
-  properties?: string[] | Record<string, any>;
+  properties?: string[];
   keepNonPropertyFields?: boolean;
 }
 
@@ -484,11 +459,11 @@ export interface DeleteEntityOptions {
 export interface AddEntityRelationsOptions {
   id: number;
   property: string;
-  relations: {id?: number, [k: string]: any}[];
+  relations: { id?: number; [k: string]: any }[];
 }
 
 export interface RemoveEntityRelationsOptions {
   id: number;
   property: string;
-  relations: {id?: number, [k: string]: any}[];
+  relations: { id?: number; [k: string]: any }[];
 }

package/src/utilities/accessControlUtility.ts

@@ -3,7 +3,7 @@ import { find } from "lodash";
 export type PermissionCheckPolicy = {
   any?: string[];
   all?: string[];
-}
+};
 
 export function isAccessAllowed(policy: PermissionCheckPolicy, allowedActions: string[]): boolean {
   let isAnyCheckPassed = true;
@@ -12,7 +12,7 @@ export function isAccessAllowed(policy: PermissionCheckPolicy, allowedActions: s
   if (policy.any) {
     isAnyCheckPassed = false;
     for (const action of policy.any) {
-      if (find(allowedActions, item => item === action) != null) {
+      if (find(allowedActions, (item) => item === action) != null) {
         isAnyCheckPassed = true;
         break;
       }
@@ -22,7 +22,7 @@ export function isAccessAllowed(policy: PermissionCheckPolicy, allowedActions: s
   if (policy.all) {
     isAllCheckPassed = true;
     for (const action of policy.all) {
-      if (find(allowedActions, item => item === action) == null) {
+      if (find(allowedActions, (item) => item === action) == null) {
         isAnyCheckPassed = false;
         break;
       }
@@ -30,4 +30,4 @@ export function isAccessAllowed(policy: PermissionCheckPolicy, allowedActions: s
   }
 
   return isAnyCheckPassed && isAllCheckPassed;
-}
+}

package/src/utilities/errorUtility.ts

@@ -0,0 +1,17 @@
+export function newError(type: string, message?: string, cause?: any) {
+  const error = new Error(
+    message, {
+      cause,
+    }
+  );
+  error.name = type;
+  return error;
+}
+
+export function newDatabaseError(message?: string, cause?: any) {
+  return newError("DatabaseError", message, cause);
+}
+
+export function newEntityOperationError(message?: string, cause?: any) {
+  return newError("EntityOperationError", message, cause);
+}

package/src/utilities/fsUtility.ts

@@ -1,4 +1,4 @@
-import fs from 'fs';
+import fs from "fs";
 
 export async function readFile(path: string): Promise<Buffer> {
   return new Promise((resolve, reject) => {
@@ -8,8 +8,8 @@ export async function readFile(path: string): Promise<Buffer> {
       } else {
         resolve(data);
       }
-    })
-  })
+    });
+  });
 }
 
 export async function copyFile(fromPath: string, toPath: string): Promise<void> {
@@ -20,8 +20,8 @@ export async function copyFile(fromPath: string, toPath: string): Promise<void>
       } else {
         resolve();
       }
-    })
-  })
+    });
+  });
 }
 
 export async function removeFile(path: string): Promise<void> {
@@ -32,8 +32,8 @@ export async function removeFile(path: string): Promise<void> {
       } else {
         resolve();
       }
-    })
-  })
+    });
+  });
 }
 
 export async function moveFile(fromPath: string, toPath: string): Promise<void> {
@@ -44,8 +44,8 @@ export async function moveFile(fromPath: string, toPath: string): Promise<void>
       } else {
         resolve();
       }
-    })
-  })
+    });
+  });
 }
 
 export async function appendFile(path: string, data: ArrayBuffer): Promise<void> {
@@ -56,7 +56,6 @@ export async function appendFile(path: string, data: ArrayBuffer): Promise<void>
       } else {
         resolve();
       }
-    })
-  })
-
-}
+    });
+  });
+}

package/src/utilities/httpUtility.ts

@@ -1,8 +1,4 @@
-export async function fetchWithTimeout(
-  url: string,
-  reqInit: RequestInit,
-  timeout?: number,
-) : Promise<Response> {
+export async function fetchWithTimeout(url: string, reqInit: RequestInit, timeout?: number): Promise<Response> {
   if (!timeout) {
     return await fetch(url, reqInit);
   }

package/src/utilities/jwtUtility.ts

@@ -4,27 +4,23 @@ import crypto from "crypto";
 
 export function createJwt(payload: Record<string, any>, secret: Secret) {
   return sign(payload, secret, {
-    algorithm: 'HS512',
+    algorithm: "HS512",
   });
 }
 
 export function verifyJwt(token: string, secret: Secret): JwtPayload {
   return verify(token, secret, {
-    algorithms: ['HS512'],
+    algorithms: ["HS512"],
   }) as JwtPayload;
 }
 
 export function decodeJwt(token: string) {
-  return decode(token, { complete: true});
+  return decode(token, { complete: true });
 }
 
 export async function generateJwtSecretKey() {
-  const key = await crypto.subtle.generateKey(
-    { name: "HMAC", hash: "SHA-512" },
-    true,
-    ["sign", "verify"],
-  );
-  
+  const key = await crypto.subtle.generateKey({ name: "HMAC", hash: "SHA-512" }, true, ["sign", "verify"]);
+
   const exportedKey = await crypto.subtle.exportKey("raw", key);
   return base64Encode(exportedKey);
-}
+}

package/tsconfig.json

@@ -16,4 +16,4 @@
   },
   "exclude": ["src/**/*.spec.ts", "src/**/*.spec.tsx", "node_modules"],
   "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"]
-}
+}