@ruiapp/rapid-core 0.3.0 → 0.3.2

package/src/core/response.ts

@@ -1,76 +1,76 @@
-import { isArray, isObject } from "lodash";
-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()) {
-      target.set(keyValuePair[0], keyValuePair[1]);
-    }
-  } else if (isArray(source)) {
-    for (const keyValuePair of source) {
-      target.set(keyValuePair[0], keyValuePair[1]);
-    }
-  } else if (isObject(source)) {
-    Object.entries(source).forEach(([key, value]) => target.set(key, value));
-  }
-  return target;
-}
-
-interface NewResponseOptions {
-  body?: ResponseData;
-  status?: HttpStatus;
-  headers?: HeadersInit;
-}
-
-function newResponse(options: NewResponseOptions) {
-  return new Response(options.body, {
-    headers: options.headers,
-    status: options.status || 200,
-  });
-}
-
-export class RapidResponse {
-  #response: Response;
-  status: number;
-  body: BodyInit;
-  headers: Headers;
-
-  constructor(body?: BodyInit, init?: ResponseInit) {
-    this.body = body;
-    this.headers = new Headers(init?.headers);
-    this.status = init?.status;
-  }
-
-  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
-    let body: string | null = null;
-    if (obj) {
-      body = JSON.stringify(obj);
-    }
-    this.headers.set("Content-Type", "application/json");
-    const responseHeaders = new Headers(this.headers);
-    if (headers) {
-      mergeHeaders(responseHeaders, headers);
-    }
-    this.#response = newResponse({ body, status: status || 200, headers: responseHeaders });
-  }
-
-  redirect(location: string, status?: HttpStatus) {
-    this.headers.set("Location", location);
-    this.#response = newResponse({
-      headers: this.headers,
-      status: status || 302,
-    });
-  }
-
-  getResponse() {
-    if (!this.#response) {
-      this.#response = new Response(this.body, {
-        status: this.status || (this.body ? 200 : 404),
-        headers: this.headers,
-      });
-    }
-    return this.#response;
-  }
-}
+import { isArray, isObject } from "lodash";
+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()) {
+      target.set(keyValuePair[0], keyValuePair[1]);
+    }
+  } else if (isArray(source)) {
+    for (const keyValuePair of source) {
+      target.set(keyValuePair[0], keyValuePair[1]);
+    }
+  } else if (isObject(source)) {
+    Object.entries(source).forEach(([key, value]) => target.set(key, value));
+  }
+  return target;
+}
+
+interface NewResponseOptions {
+  body?: ResponseData;
+  status?: HttpStatus;
+  headers?: HeadersInit;
+}
+
+function newResponse(options: NewResponseOptions) {
+  return new Response(options.body, {
+    headers: options.headers,
+    status: options.status || 200,
+  });
+}
+
+export class RapidResponse {
+  #response: Response;
+  status: number;
+  body: BodyInit;
+  headers: Headers;
+
+  constructor(body?: BodyInit, init?: ResponseInit) {
+    this.body = body;
+    this.headers = new Headers(init?.headers);
+    this.status = init?.status;
+  }
+
+  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
+    let body: string | null = null;
+    if (obj) {
+      body = JSON.stringify(obj);
+    }
+    this.headers.set("Content-Type", "application/json");
+    const responseHeaders = new Headers(this.headers);
+    if (headers) {
+      mergeHeaders(responseHeaders, headers);
+    }
+    this.#response = newResponse({ body, status: status || 200, headers: responseHeaders });
+  }
+
+  redirect(location: string, status?: HttpStatus) {
+    this.headers.set("Location", location);
+    this.#response = newResponse({
+      headers: this.headers,
+      status: status || 302,
+    });
+  }
+
+  getResponse() {
+    if (!this.#response) {
+      this.#response = new Response(this.body, {
+        status: this.status || (this.body ? 200 : 404),
+        headers: this.headers,
+      });
+    }
+    return this.#response;
+  }
+}

package/src/core/routeContext.ts

@@ -1,47 +1,47 @@
-import { isArray, isObject } from "lodash";
-import { RapidRequest } from "./request";
-import { RapidResponse } from "./response";
-import { HttpStatus, ResponseData } from "./http-types";
-import { IRpdServer } from "./server";
-import { Logger } from "~/facilities/log/LogFacility";
-
-export type Next = () => Promise<void>;
-
-export class RouteContext {
-  readonly request: RapidRequest;
-  readonly response: RapidResponse;
-  readonly state: Record<string, any>;
-  method: string;
-  path: string;
-  params: Record<string, string>;
-  routeConfig: any;
-
-  static newSystemOperationContext(server: IRpdServer) {
-    return new RouteContext(server);
-  }
-
-  constructor(server: IRpdServer, request?: RapidRequest) {
-    this.request = request;
-    this.state = {};
-    this.response = new RapidResponse();
-
-    // `method` and `path` are used by `koa-tree-router` to match route
-    if (this.request) {
-      this.method = request.method;
-      this.path = request.url.pathname;
-    }
-  }
-
-  // `koa-tree-router` uses this method to set headers
-  set(headerName: string, headerValue: string) {
-    this.response.headers.set(headerName, headerValue);
-  }
-
-  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
-    this.response.json(obj, status, headers);
-  }
-
-  redirect(url: string, status?: HttpStatus) {
-    this.response.redirect(url, status);
-  }
-}
+import { isArray, isObject } from "lodash";
+import { RapidRequest } from "./request";
+import { RapidResponse } from "./response";
+import { HttpStatus, ResponseData } from "./http-types";
+import { IRpdServer } from "./server";
+import { Logger } from "~/facilities/log/LogFacility";
+
+export type Next = () => Promise<void>;
+
+export class RouteContext {
+  readonly request: RapidRequest;
+  readonly response: RapidResponse;
+  readonly state: Record<string, any>;
+  method: string;
+  path: string;
+  params: Record<string, string>;
+  routeConfig: any;
+
+  static newSystemOperationContext(server: IRpdServer) {
+    return new RouteContext(server);
+  }
+
+  constructor(server: IRpdServer, request?: RapidRequest) {
+    this.request = request;
+    this.state = {};
+    this.response = new RapidResponse();
+
+    // `method` and `path` are used by `koa-tree-router` to match route
+    if (this.request) {
+      this.method = request.method;
+      this.path = request.url.pathname;
+    }
+  }
+
+  // `koa-tree-router` uses this method to set headers
+  set(headerName: string, headerValue: string) {
+    this.response.headers.set(headerName, headerValue);
+  }
+
+  json(obj: any, status?: HttpStatus, headers?: HeadersInit) {
+    this.response.json(obj, status, headers);
+  }
+
+  redirect(url: string, status?: HttpStatus) {
+    this.response.redirect(url, status);
+  }
+}

package/src/core/server.ts

@@ -1,142 +1,142 @@
-import {
-  CreateEntityOptions,
-  EmitServerEventOptions,
-  EntityWatcherType,
-  GetDataAccessorOptions,
-  GetModelOptions,
-  IDatabaseConfig,
-  IQueryBuilder,
-  IRpdDataAccessor,
-  RapidServerConfig,
-  RpdApplicationConfig,
-  RpdDataModel,
-  RpdDataModelProperty,
-  RpdServerEventTypes,
-  UpdateEntityByIdOptions,
-} from "~/types";
-import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
-import { Next, RouteContext } from "./routeContext";
-import EntityManager from "~/dataAccess/entityManager";
-import { Logger } from "~/facilities/log/LogFacility";
-import { FacilityFactory } from "./facility";
-
-export interface IRpdServer {
-  config: RapidServerConfig;
-  databaseConfig: IDatabaseConfig;
-  queryBuilder: IQueryBuilder;
-  getLogger(): Logger;
-
-  registerFacilityFactory(factory: FacilityFactory);
-
-  getFacility<TFacility = any>(name: string, options?: any): Promise<TFacility>;
-
-  queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
-  tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
-  registerMiddleware(middleware: any): void;
-  registerActionHandler(plugin: RapidPlugin, options: IPluginActionHandler): void;
-  getActionHandlerByCode(code: string): ActionHandler | undefined;
-  getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
-  getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
-  registerService(name: string, service: any);
-  getService<TService>(name: string): TService;
-  getApplicationConfig(): RpdApplicationConfig;
-  appendApplicationConfig(config: Partial<RpdApplicationConfig>);
-  appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]);
-  getModel(options: GetModelOptions): RpdDataModel | undefined;
-  registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void);
-  registerEntityWatcher(entityWatcher: EntityWatcherType);
-  emitEvent<TEventName extends keyof RpdServerEventTypes>(event: EmitServerEventOptions<TEventName>): void;
-  handleRequest(request: Request, next: Next): Promise<Response>;
-  beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
-  beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
-  beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
-}
-
-export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
-
-export interface RpdConfigurationItemOptions {
-  /**
-   * 配置项名称。可以包含中文。
-   */
-  name: string;
-  /**
-   * 配置项代码。
-   */
-  code: string;
-  /**
-   * 配置项类型。
-   */
-  type: RpdConfigurationItemTypes;
-  /**
-   * 是否必须有值。默认为 false。
-   */
-  required?: boolean;
-  /**
-   * 默认值。使用默认值的 JavaScript 字面量表示。
-   */
-  defaultValue?: string;
-}
-
-export type RpdServerPluginExtendingAbilities =
-  | /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware"
-  | /** 是指增加系统中的集合的能力。 */ "extendModel"
-  | /** 是指可以对模型增加属性的能力。 */ "extendProperty"
-  | /** 是指增加接口动作的能力。 */ "extendActionHandler"
-  | /** 是指增加或者修改接口定义的能力。 */ "extendRoute"
-  | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity"
-  | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent"
-  | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage"
-  | /** 对特定任务进行处理的能力。 */ "processTask";
-
-export interface RpdServerPluginConfigurableTargetOptions {
-  targetCode: string;
-
-  configurations: RpdConfigurationItemOptions[];
-}
-
-export interface RapidPlugin {
-  /** 插件代码 */
-  get code(): string;
-  /** 插件描述 */
-  get description(): string;
-  /** 插件可以提供哪些扩展能力 */
-  get extendingAbilities(): RpdServerPluginExtendingAbilities[];
-  /** 插件可以配置的目标实体，以及和配置目标相关的配置项 */
-  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
-  /** 插件的全局配置项 */
-  get configurations(): RpdConfigurationItemOptions[];
-  /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
-  initPlugin?: (server: IRpdServer) => Promise<any>;
-  /** 注册中间件 */
-  registerMiddlewares?: (server: IRpdServer) => Promise<any>;
-  /** 注册接口动作处理程序 */
-  registerActionHandlers?: (server: IRpdServer) => Promise<any>;
-  /** 注册事件处理程序 */
-  registerEventHandlers?: (server: IRpdServer) => Promise<any>;
-  /** 注册消息处理程序 */
-  registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
-  /** 注册任务处理程序 */
-  registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
-  /** 在加载应用前调用。 */
-  onLoadingApplication?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
-  /** 配置数据集合 */
-  configureModels?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
-  /** 配置模型属性 */
-  configureModelProperties?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
-  /** 配置服务 */
-  configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
-  /** 配置路由 */
-  configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
-  /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
-  onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
-  /** 在应用准备完成后调用。此时服务器已经可以处理网络请求，可以对外广播消息。 */
-  onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
-  /** 在接收到HTTP请求，准备路由上下文时调用。 */
-  onPrepareRouteContext?: (server: IRpdServer, routeContext: RouteContext) => Promise<any>;
-  /** 在接收到HTTP请求，执行 actions 前调用。 */
-  beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
-  /** 在创建实体前调用。 */
-  beforeCreateEntity?: (server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) => Promise<any>;
-  /** 在更新实体前调用。 */
-  beforeUpdateEntity?: (server: IRpdServer, model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any) => Promise<any>;
-}
+import {
+  CreateEntityOptions,
+  EmitServerEventOptions,
+  EntityWatcherType,
+  GetDataAccessorOptions,
+  GetModelOptions,
+  IDatabaseConfig,
+  IQueryBuilder,
+  IRpdDataAccessor,
+  RapidServerConfig,
+  RpdApplicationConfig,
+  RpdDataModel,
+  RpdDataModelProperty,
+  RpdServerEventTypes,
+  UpdateEntityByIdOptions,
+} from "~/types";
+import { IPluginActionHandler, ActionHandler, ActionHandlerContext } from "./actionHandler";
+import { Next, RouteContext } from "./routeContext";
+import EntityManager from "~/dataAccess/entityManager";
+import { Logger } from "~/facilities/log/LogFacility";
+import { FacilityFactory } from "./facility";
+
+export interface IRpdServer {
+  config: RapidServerConfig;
+  databaseConfig: IDatabaseConfig;
+  queryBuilder: IQueryBuilder;
+  getLogger(): Logger;
+
+  registerFacilityFactory(factory: FacilityFactory);
+
+  getFacility<TFacility = any>(name: string, options?: any): Promise<TFacility>;
+
+  queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
+  tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
+  registerMiddleware(middleware: any): void;
+  registerActionHandler(plugin: RapidPlugin, options: IPluginActionHandler): void;
+  getActionHandlerByCode(code: string): ActionHandler | undefined;
+  getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
+  getEntityManager<TEntity = any>(singularCode: string): EntityManager<TEntity>;
+  registerService(name: string, service: any);
+  getService<TService>(name: string): TService;
+  getApplicationConfig(): RpdApplicationConfig;
+  appendApplicationConfig(config: Partial<RpdApplicationConfig>);
+  appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]);
+  getModel(options: GetModelOptions): RpdDataModel | undefined;
+  registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void);
+  registerEntityWatcher(entityWatcher: EntityWatcherType);
+  emitEvent<TEventName extends keyof RpdServerEventTypes>(event: EmitServerEventOptions<TEventName>): void;
+  handleRequest(request: Request, next: Next): Promise<Response>;
+  beforeRunRouteActions(handlerContext: ActionHandlerContext): Promise<void>;
+  beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions): Promise<void>;
+  beforeUpdateEntity(model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any): Promise<void>;
+}
+
+export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
+
+export interface RpdConfigurationItemOptions {
+  /**
+   * 配置项名称。可以包含中文。
+   */
+  name: string;
+  /**
+   * 配置项代码。
+   */
+  code: string;
+  /**
+   * 配置项类型。
+   */
+  type: RpdConfigurationItemTypes;
+  /**
+   * 是否必须有值。默认为 false。
+   */
+  required?: boolean;
+  /**
+   * 默认值。使用默认值的 JavaScript 字面量表示。
+   */
+  defaultValue?: string;
+}
+
+export type RpdServerPluginExtendingAbilities =
+  | /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware"
+  | /** 是指增加系统中的集合的能力。 */ "extendModel"
+  | /** 是指可以对模型增加属性的能力。 */ "extendProperty"
+  | /** 是指增加接口动作的能力。 */ "extendActionHandler"
+  | /** 是指增加或者修改接口定义的能力。 */ "extendRoute"
+  | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity"
+  | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent"
+  | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage"
+  | /** 对特定任务进行处理的能力。 */ "processTask";
+
+export interface RpdServerPluginConfigurableTargetOptions {
+  targetCode: string;
+
+  configurations: RpdConfigurationItemOptions[];
+}
+
+export interface RapidPlugin {
+  /** 插件代码 */
+  get code(): string;
+  /** 插件描述 */
+  get description(): string;
+  /** 插件可以提供哪些扩展能力 */
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[];
+  /** 插件可以配置的目标实体，以及和配置目标相关的配置项 */
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
+  /** 插件的全局配置项 */
+  get configurations(): RpdConfigurationItemOptions[];
+  /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
+  initPlugin?: (server: IRpdServer) => Promise<any>;
+  /** 注册中间件 */
+  registerMiddlewares?: (server: IRpdServer) => Promise<any>;
+  /** 注册接口动作处理程序 */
+  registerActionHandlers?: (server: IRpdServer) => Promise<any>;
+  /** 注册事件处理程序 */
+  registerEventHandlers?: (server: IRpdServer) => Promise<any>;
+  /** 注册消息处理程序 */
+  registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
+  /** 注册任务处理程序 */
+  registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
+  /** 在加载应用前调用。 */
+  onLoadingApplication?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 配置数据集合 */
+  configureModels?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 配置模型属性 */
+  configureModelProperties?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 配置服务 */
+  configureServices?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 配置路由 */
+  configureRoutes?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
+  onApplicationLoaded?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 在应用准备完成后调用。此时服务器已经可以处理网络请求，可以对外广播消息。 */
+  onApplicationReady?: (server: IRpdServer, applicationConfig: RpdApplicationConfig) => Promise<any>;
+  /** 在接收到HTTP请求，准备路由上下文时调用。 */
+  onPrepareRouteContext?: (server: IRpdServer, routeContext: RouteContext) => Promise<any>;
+  /** 在接收到HTTP请求，执行 actions 前调用。 */
+  beforeRunRouteActions?: (server: IRpdServer, handlerContext: ActionHandlerContext) => Promise<any>;
+  /** 在创建实体前调用。 */
+  beforeCreateEntity?: (server: IRpdServer, model: RpdDataModel, options: CreateEntityOptions) => Promise<any>;
+  /** 在更新实体前调用。 */
+  beforeUpdateEntity?: (server: IRpdServer, model: RpdDataModel, options: UpdateEntityByIdOptions, currentEntity: any) => Promise<any>;
+}

package/src/dataAccess/columnTypeMapper.ts

@@ -1,22 +1,22 @@
-import { RpdDataPropertyTypes } from "~/types";
-import { DataAccessPgColumnTypes } from "./dataAccessTypes";
-
-export const pgPropertyTypeColumnMap: Record<Exclude<RpdDataPropertyTypes, "relation" | "relation[]">, DataAccessPgColumnTypes> = {
-  integer: "int4",
-  long: "int8",
-  float: "float4",
-  double: "float8",
-  decimal: "decimal",
-  text: "text",
-  boolean: "bool",
-  date: "date",
-  time: "time",
-  datetime: "timestamptz",
-  json: "jsonb",
-  option: "text",
-  "option[]": "text[]",
-  file: "jsonb",
-  "file[]": "jsonb",
-  image: "jsonb",
-  "image[]": "jsonb",
-};
+import { RpdDataPropertyTypes } from "~/types";
+import { DataAccessPgColumnTypes } from "./dataAccessTypes";
+
+export const pgPropertyTypeColumnMap: Record<Exclude<RpdDataPropertyTypes, "relation" | "relation[]">, DataAccessPgColumnTypes> = {
+  integer: "int4",
+  long: "int8",
+  float: "float4",
+  double: "float8",
+  decimal: "decimal",
+  text: "text",
+  boolean: "bool",
+  date: "date",
+  time: "time",
+  datetime: "timestamptz",
+  json: "jsonb",
+  option: "text",
+  "option[]": "text[]",
+  file: "jsonb",
+  "file[]": "jsonb",
+  image: "jsonb",
+  "image[]": "jsonb",
+};