@ruiapp/rapid-core 0.1.41 → 0.1.43

package/dist/plugins/sequence/SequencePluginTypes.d.ts

@@ -38,6 +38,7 @@ export type SequenceDayOfYearSegmentConfig = {
 export type SequenceParameterSegmentConfig = {
     type: "parameter";
     parameterName: string;
+    defaultContent?: string;
     padding?: string;
     length?: number;
 };

package/dist/queryBuilder/queryBuilder.d.ts

@@ -1,7 +1,9 @@
-import { CountEntityOptions, DeleteEntityOptions, EntityFilterOptions, FindEntityOptions, CreateEntityOptions, RpdDataModel, UpdateEntityOptions, QuoteTableOptions } from "../types";
+import { RpdDataModel, CreateEntityOptions, QuoteTableOptions, DatabaseQuery } from "../types";
+import { CountRowOptions, DeleteRowOptions, FindRowOptions, RowFilterOptions, UpdateRowOptions, ColumnQueryOptions } from "../dataAccess/dataAccessTypes";
 export interface BuildQueryContext {
     builder: QueryBuilder;
     params: any[];
+    emitTableAlias: boolean;
 }
 export interface InitQueryBuilderOptions {
     dbDefaultSchema: string;
@@ -11,25 +13,13 @@ export default class QueryBuilder {
     constructor(options: InitQueryBuilderOptions);
     quoteTable(options: QuoteTableOptions): string;
     quoteObject(name: string): string;
-    select(model: RpdDataModel, options: FindEntityOptions): {
-        command: string;
-        params: any[];
-    };
-    count(model: RpdDataModel, options: CountEntityOptions): {
-        command: string;
-        params: any[];
-    };
-    insert(model: RpdDataModel, options: CreateEntityOptions): {
-        command: string;
-        params: any[];
-    };
-    update(model: RpdDataModel, options: UpdateEntityOptions): {
-        command: string;
-        params: any[];
-    };
-    delete(model: RpdDataModel, options: DeleteEntityOptions): {
-        command: string;
-        params: any[];
-    };
+    quoteColumn(column: ColumnQueryOptions, emitTableAlias: boolean): string;
+    select(model: RpdDataModel, options: FindRowOptions): DatabaseQuery;
+    selectDerived(derivedModel: RpdDataModel, baseModel: RpdDataModel, options: FindRowOptions): DatabaseQuery;
+    count(model: RpdDataModel, options: CountRowOptions): DatabaseQuery;
+    countDerived(derivedModel: RpdDataModel, baseModel: RpdDataModel, options: CountRowOptions): DatabaseQuery;
+    insert(model: RpdDataModel, options: CreateEntityOptions): DatabaseQuery;
+    update(model: RpdDataModel, options: UpdateRowOptions): DatabaseQuery;
+    delete(model: RpdDataModel, options: DeleteRowOptions): DatabaseQuery;
 }
-export declare function buildFiltersQuery(ctx: BuildQueryContext, filters: EntityFilterOptions[]): string;
+export declare function buildFiltersQuery(ctx: BuildQueryContext, filters: RowFilterOptions[]): string;

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import { RapidPlugin } from "./core/server";
+import { CountRowOptions, FindRowOptions } from "./dataAccess/dataAccessTypes";
 export type RapidServerConfig = {
     baseUrl?: string;
     sessionCookieName: string;
@@ -14,6 +15,10 @@ export interface IDatabaseConfig {
     dbDefaultSchema?: string;
     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[]>;
 }
@@ -62,22 +67,26 @@ 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;
 }
 export interface RpdEntityUpdateEventPayload {
     namespace: string;
     modelSingularCode: string;
+    baseModelSingularCode?: string;
     before: any;
     after: any;
     changes: any;
@@ -85,16 +94,19 @@ 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[];
@@ -102,6 +114,7 @@ export interface RpdEntityAddRelationsEventPayload {
 export interface RpdEntityRemoveRelationsEventPayload {
     namespace: string;
     modelSingularCode: string;
+    baseModelSingularCode?: string;
     entity: any;
     property: string;
     relations: any[];
@@ -128,6 +141,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;
@@ -147,6 +172,10 @@ export interface RpdDataModelProperty {
      * 表示此属性由谁来维护
      */
     maintainedBy?: string;
+    /**
+     * 表示是否基础属性
+     */
+    isBaseProperty?: boolean;
     /**
      * 字段名称。可以包含中文。
      */
@@ -230,7 +259,7 @@ export type RpdDataDictionary = {
     /**
      * 字典项值类型
      */
-    type: 'string' | 'integer';
+    type: "string" | "integer";
     /**
      * 字典项
      */
@@ -284,10 +313,10 @@ 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";
@@ -302,7 +331,7 @@ export interface FindEntityOptions {
     filters?: EntityFilterOptions[];
     orderBy?: FindEntityOrderByOptions[];
     pagination?: FindEntityPaginationOptions;
-    properties?: string[] | Record<string, any>;
+    properties?: string[];
     keepNonPropertyFields?: boolean;
 }
 export interface FindEntityRelationalFilterOptions {

package/dist/utilities/errorUtility.d.ts

@@ -0,0 +1,3 @@
+export declare function newError(type: string, message?: string, cause?: any): Error;
+export declare function newDatabaseError(message?: string, cause?: any): Error;
+export declare function newEntityOperationError(message?: string, cause?: any): Error;

package/package.json

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

package/rollup.config.js

@@ -1,20 +1,16 @@
-import typescript from 'rollup-plugin-typescript2';
-import tscAlias from 'rollup-plugin-tsc-alias';
+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: [
-    ]
+  input: ["src/index.ts"],
+  output: [
+    {
+      dir: "dist",
+      entryFileNames: "[name].js",
+      format: "cjs",
+      exports: "named",
+    },
+  ],
+  plugins: [typescript(), tscAlias()],
+  external: [],
 };

package/src/bootstrapApplicationConfig.ts

@@ -70,6 +70,27 @@ export default {
           type: "text",
           required: true,
         },
+        {
+          name: "base",
+          code: "base",
+          columnName: "base",
+          type: "text",
+          required: false,
+        },
+        {
+          name: "derivedType",
+          code: "derivedType",
+          columnName: "derived_type",
+          type: "text",
+          required: false,
+        },
+        {
+          name: "derivedTypePropertyCode",
+          code: "derivedTypePropertyCode",
+          columnName: "derived_type_property_code",
+          type: "text",
+          required: false,
+        },
         {
           name: "properties",
           code: "properties",
@@ -280,7 +301,7 @@ export default {
           columnName: "level",
           type: "text",
           required: false,
-          defaultValue: "'app'"
+          defaultValue: "'app'",
         },
         {
           name: "description",
@@ -325,7 +346,7 @@ export default {
           targetSingularCode: "data_dictionary_entry",
           selfIdColumnName: "dictionary_id",
         },
-      ]
+      ],
     },
     {
       maintainedBy: "metaManager",
@@ -358,7 +379,7 @@ export default {
           columnName: "order_num",
           type: "integer",
           required: true,
-          defaultValue: '0',
+          defaultValue: "0",
         },
         {
           name: "name",
@@ -402,7 +423,7 @@ export default {
           type: "boolean",
           required: false,
         },
-      ]
+      ],
     },
     {
       maintainedBy: "dataManager",

package/src/core/actionHandler.ts

@@ -14,12 +14,9 @@ export interface ActionHandlerContext {
   status?: Response["status"];
 }
 
-export type ActionHandler = (
-  ctx: ActionHandlerContext,
-  options: any,
-) => void | Promise<void>;
+export type ActionHandler = (ctx: ActionHandlerContext, options: any) => void | Promise<void>;
 
 export interface IPluginActionHandler {
   code: string;
   handler: (plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) => void | Promise<void>;
-}
+}

package/src/core/eventManager.ts

@@ -7,10 +7,7 @@ export default class EventManager<EventTypes extends Record<string, any[]>> {
     this.#eventEmitter = new EventEmitter();
   }
 
-  on<K extends keyof EventTypes>(
-    eventName: K,
-    listener: (...args: EventTypes[K]) => void,
-  ) {
+  on<K extends keyof EventTypes>(eventName: K, listener: (...args: EventTypes[K]) => void) {
     this.#eventEmitter.on(eventName as string, listener);
   }
 

package/src/core/facility.ts

@@ -4,4 +4,4 @@ export interface FacilityFactory {
   name: string;
 
   createFacility: (server: IRpdServer, options?: any) => Promise<any>;
-}
+}

package/src/core/http/formDataParser.ts

@@ -1,6 +1,6 @@
-import type { RapidRequest } from '../request'
+import type { RapidRequest } from "../request";
 
-export type BodyData = Record<string, string | File | (string | File)[]>
+export type BodyData = Record<string, string | File | (string | File)[]>;
 export type ParseBodyOptions = {
   /**
    * Parse all fields with multiple values should be parsed as an array.
@@ -19,83 +19,71 @@ export type ParseBodyOptions = {
    * If `all` is `true`:
    * parseBody should return `{ file: ['aaa', 'bbb'], message: 'hello' }`
    */
-  all?: boolean
-}
+  all?: boolean;
+};
 
-export const parseFormDataBody = async <T extends BodyData = BodyData>(
-  request: Request,
-  options: ParseBodyOptions = { all: false }
-): Promise<T> => {
-  const contentType = request.headers.get('Content-Type')
+export const parseFormDataBody = async <T extends BodyData = BodyData>(request: Request, options: ParseBodyOptions = { all: false }): Promise<T> => {
+  const contentType = request.headers.get("Content-Type");
 
   if (isFormDataContent(contentType)) {
-    return parseFormData<T>(request, options)
+    return parseFormData<T>(request, options);
   }
 
-  return {} as T
-}
+  return {} as T;
+};
 
 function isFormDataContent(contentType: string | null): boolean {
   if (contentType === null) {
-    return false
+    return false;
   }
 
-  return (
-    contentType.startsWith('multipart/form-data') ||
-    contentType.startsWith('application/x-www-form-urlencoded')
-  )
+  return contentType.startsWith("multipart/form-data") || contentType.startsWith("application/x-www-form-urlencoded");
 }
 
-async function parseFormData<T extends BodyData = BodyData>(
-  request: Request,
-  options: ParseBodyOptions
-): Promise<T> {
-  const formData = await (request as Request).formData()
+async function parseFormData<T extends BodyData = BodyData>(request: Request, options: ParseBodyOptions): Promise<T> {
+  const formData = await (request as Request).formData();
 
   if (formData) {
-    return convertFormDataToBodyData<T>(formData, options)
+    return convertFormDataToBodyData<T>(formData, options);
   }
 
-  return {} as T
+  return {} as T;
 }
 
-function convertFormDataToBodyData<T extends BodyData = BodyData>(
-  formData: FormData,
-  options: ParseBodyOptions
-): T {
-  const form: BodyData = {}
+function convertFormDataToBodyData<T extends BodyData = BodyData>(formData: FormData, options: ParseBodyOptions): T {
+  const form: BodyData = {};
 
   formData.forEach((value, key) => {
-    const shouldParseAllValues = options.all || key.endsWith('[]')
+    const shouldParseAllValues = options.all || key.endsWith("[]");
 
     if (!shouldParseAllValues) {
-      form[key] = value
+      form[key] = value;
     } else {
-      handleParsingAllValues(form, key, value)
+      handleParsingAllValues(form, key, value);
     }
-  })
+  });
 
-  return form as T
+  return form as T;
 }
 
 const handleParsingAllValues = (form: BodyData, key: string, value: FormDataEntryValue): void => {
   if (form[key] && isArrayField(form[key])) {
-    appendToExistingArray(form[key] as (string | File)[], value)
+    appendToExistingArray(form[key] as (string | File)[], value);
   } else if (form[key]) {
-    convertToNewArray(form, key, value)
+    convertToNewArray(form, key, value);
   } else {
-    form[key] = value
+    form[key] = value;
   }
-}
+};
 
 function isArrayField(field: unknown): field is (string | File)[] {
-  return Array.isArray(field)
+  return Array.isArray(field);
 }
 
 const appendToExistingArray = (arr: (string | File)[], value: FormDataEntryValue): void => {
-  arr.push(value)
-}
+  arr.push(value);
+};
 
 const convertToNewArray = (form: BodyData, key: string, value: FormDataEntryValue): void => {
-  form[key] = [form[key] as string | File, value]
-}
+  form[key] = [form[key] as string | File, value];
+};

package/src/core/pluginManager.ts

@@ -13,7 +13,7 @@ class PluginManager {
   }
 
   async loadPlugins(plugins: RapidPlugin[]) {
-    for(const plugin of plugins) {
+    for (const plugin of plugins) {
       this.#plugins.push(plugin);
     }
   }
@@ -73,9 +73,7 @@ class PluginManager {
   }
 
   /** 在加载应用前调用。 */
-  async onLoadingApplication(
-    applicationConfig: RpdApplicationConfig,
-  ) {
+  async onLoadingApplication(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {
       if (plugin.onLoadingApplication) {
         await plugin.onLoadingApplication(this.#server, applicationConfig);
@@ -84,9 +82,7 @@ class PluginManager {
   }
 
   /** 配置数据模型 */
-  async configureModels(
-    applicationConfig: RpdApplicationConfig,
-  ) {
+  async configureModels(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {
       if (plugin.configureModels) {
         await plugin.configureModels(this.#server, applicationConfig);
@@ -95,9 +91,7 @@ class PluginManager {
   }
 
   /** 配置模型属性 */
-  async configureModelProperties(
-    applicationConfig: RpdApplicationConfig,
-  ) {
+  async configureModelProperties(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {
       if (plugin.configureModelProperties) {
         await plugin.configureModelProperties(this.#server, applicationConfig);
@@ -105,11 +99,8 @@ class PluginManager {
     }
   }
 
-
   /** 配置服务 */
-  async configureServices(
-    applicationConfig: RpdApplicationConfig,
-  ) {
+  async configureServices(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {
       if (plugin.configureServices) {
         await plugin.configureServices(this.#server, applicationConfig);
@@ -118,9 +109,7 @@ class PluginManager {
   }
 
   /** 配置路由 */
-  async configureRoutes(
-    applicationConfig: RpdApplicationConfig,
-  ) {
+  async configureRoutes(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {
       if (plugin.configureRoutes) {
         await plugin.configureRoutes(this.#server, applicationConfig);
@@ -129,9 +118,7 @@ class PluginManager {
   }
 
   /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
-  async onApplicationLoaded(
-    applicationConfig: RpdApplicationConfig,
-  ) {
+  async onApplicationLoaded(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {
       if (plugin.onApplicationLoaded) {
         await plugin.onApplicationLoaded(this.#server, applicationConfig);
@@ -140,9 +127,7 @@ class PluginManager {
   }
 
   /** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
-  async onApplicationReady(
-    applicationConfig: RpdApplicationConfig,
-  ) {
+  async onApplicationReady(applicationConfig: RpdApplicationConfig) {
     for (const plugin of this.#plugins) {
       if (plugin.onApplicationReady) {
         await plugin.onApplicationReady(this.#server, applicationConfig);
@@ -151,9 +136,7 @@ class PluginManager {
   }
 
   /** 在接收到HTTP请求，准备路由上下文时调用。 */
-  async onPrepareRouteContext(
-    routeContext: RouteContext,
-  ) {
+  async onPrepareRouteContext(routeContext: RouteContext) {
     for (const plugin of this.#plugins) {
       if (plugin.onPrepareRouteContext) {
         await plugin.onPrepareRouteContext(this.#server, routeContext);
@@ -162,9 +145,7 @@ class PluginManager {
   }
 
   /** 在接收到HTTP请求，执行 actions 前调用。 */
-  async beforeRunRouteActions(
-    handlerContext: ActionHandlerContext,
-  ) {
+  async beforeRunRouteActions(handlerContext: ActionHandlerContext) {
     for (const plugin of this.#plugins) {
       if (plugin.beforeRunRouteActions) {
         await plugin.beforeRunRouteActions(this.#server, handlerContext);
@@ -173,10 +154,7 @@ class PluginManager {
   }
 
   /** 在创建实体前调用。 */
-  async beforeCreateEntity(
-    model: RpdDataModel,
-    options: CreateEntityOptions,
-  ) {
+  async beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions) {
     for (const plugin of this.#plugins) {
       if (plugin.beforeCreateEntity) {
         await plugin.beforeCreateEntity(this.#server, model, options);
@@ -185,11 +163,7 @@ class PluginManager {
   }
 
   /** 在更新实体前调用。 */
-  async beforeUpdateEntity(
-    model: RpdDataModel,
-    options: UpdateEntityByIdOptions,
-    currentEntity: any,
-  ) {
+  async beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any) {
     for (const plugin of this.#plugins) {
       if (plugin.beforeUpdateEntity) {
         await plugin.beforeUpdateEntity(this.#server, model, options, currentEntity);
@@ -198,4 +172,4 @@ class PluginManager {
   }
 }
 
-export default PluginManager;
+export default PluginManager;

package/src/core/providers/runtimeProvider.ts

@@ -2,4 +2,4 @@ export interface IRuntimeProvider {
   copyFile(fromPath: string, toPath: string): Promise<void>;
 
   removeFile(path: string): Promise<void>;
-}
+}

package/src/core/request.ts

@@ -49,12 +49,12 @@ export class RapidRequest {
         this.#body = {
           type: "form",
           value: qs.parse(bodyText),
-        }
+        };
       } else if (contentType.startsWith("multipart/form-data")) {
         this.#body = {
           type: "form-data",
           value: await parseFormDataBody(req),
-        }
+        };
       }
     } else {
       this.#body = null;
@@ -79,7 +79,7 @@ export class RapidRequest {
 
   get body(): RapidRequestBody {
     if (!this.#bodyParsed) {
-      throw new Error("Request body not parsed, you should call 'parseBody()' method before getting the body.")
+      throw new Error("Request body not parsed, you should call 'parseBody()' method before getting the body.");
     }
     return this.#body;
   }

package/src/core/response.ts

@@ -3,7 +3,6 @@ import { HttpStatus, ResponseData } from "./http-types";
 
 export const GlobalResponse = global.Response;
 
-
 function mergeHeaders(target: Headers, source: HeadersInit) {
   if (source instanceof Headers) {
     for (const keyValuePair of source.entries()) {
@@ -44,11 +43,7 @@ export class RapidResponse {
     this.status = init?.status;
   }
 
-  json(
-    obj: any,
-    status?: HttpStatus,
-    headers?: HeadersInit,
-  ) {
+  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
     let body: string | null = null;
     if (obj) {
       body = JSON.stringify(obj);
@@ -58,7 +53,7 @@ export class RapidResponse {
     if (headers) {
       mergeHeaders(responseHeaders, headers);
     }
-    this.#response = newResponse({body, status: status || 200, headers: responseHeaders});
+    this.#response = newResponse({ body, status: status || 200, headers: responseHeaders });
   }
 
   redirect(location: string, status?: HttpStatus) {

package/src/core/routeContext.ts

@@ -33,15 +33,11 @@ export class RouteContext {
     this.response.headers.set(headerName, headerValue);
   }
 
-  json(
-    obj: any,
-    status?: HttpStatus,
-    headers?: HeadersInit,
-  ) {
+  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
     this.response.json(obj, status, headers);
   }
 
   redirect(url: string, status?: HttpStatus) {
     this.response.redirect(url, status);
   }
-}
+}