@ruiapp/rapid-core 0.5.11 → 0.5.13

package/src/core/actionHandler.ts

@@ -1,22 +1,22 @@
-import { RpdApplicationConfig } from "~/types";
-import { IRpdServer, RapidPlugin } from "./server";
-import { Next, RouteContext } from "./routeContext";
-import { Logger } from "~/facilities/log/LogFacility";
-
-export interface ActionHandlerContext {
-  logger: Logger;
-  routerContext: RouteContext;
-  next: Next;
-  server: IRpdServer;
-  applicationConfig: RpdApplicationConfig;
-  input?: any;
-  output?: any;
-  status?: Response["status"];
-}
-
-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>;
-}
+import { RpdApplicationConfig } from "~/types";
+import { IRpdServer, RapidPlugin } from "./server";
+import { Next, RouteContext } from "./routeContext";
+import { Logger } from "~/facilities/log/LogFacility";
+
+export interface ActionHandlerContext {
+  logger: Logger;
+  routerContext: RouteContext;
+  next: Next;
+  server: IRpdServer;
+  applicationConfig: RpdApplicationConfig;
+  input?: any;
+  output?: any;
+  status?: Response["status"];
+}
+
+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

@@ -1,20 +1,20 @@
-import { EventEmitter } from "events";
-
-export default class EventManager<EventTypes extends Record<string, any[]>> {
-  #eventEmitter: EventEmitter;
-
-  constructor() {
-    this.#eventEmitter = new EventEmitter();
-  }
-
-  on<K extends keyof EventTypes>(eventName: K, listener: (...args: EventTypes[K]) => void) {
-    this.#eventEmitter.on(eventName as string, listener);
-  }
-
-  async emit<K extends keyof EventTypes>(eventName: K, ...args: EventTypes[K]) {
-    const listeners = this.#eventEmitter.listeners(eventName as string);
-    for (const listener of listeners) {
-      await listener(...args);
-    }
-  }
-}
+import { EventEmitter } from "events";
+
+export default class EventManager<EventTypes extends Record<string, any[]>> {
+  #eventEmitter: EventEmitter;
+
+  constructor() {
+    this.#eventEmitter = new EventEmitter();
+  }
+
+  on<K extends keyof EventTypes>(eventName: K, listener: (...args: EventTypes[K]) => void) {
+    this.#eventEmitter.on(eventName as string, listener);
+  }
+
+  async emit<K extends keyof EventTypes>(eventName: K, ...args: EventTypes[K]) {
+    const listeners = this.#eventEmitter.listeners(eventName as string);
+    for (const listener of listeners) {
+      await listener(...args);
+    }
+  }
+}

package/src/core/facility.ts

@@ -1,7 +1,7 @@
-import { IRpdServer } from "./server";
-
-export interface FacilityFactory<TFacility = any, TCreateFacilityOptions = any> {
-  name: string;
-
-  createFacility: (server: IRpdServer, options?: TCreateFacilityOptions) => Promise<TFacility>;
-}
+import { IRpdServer } from "./server";
+
+export interface FacilityFactory<TFacility = any, TCreateFacilityOptions = any> {
+  name: string;
+
+  createFacility: (server: IRpdServer, options?: TCreateFacilityOptions) => Promise<TFacility>;
+}

package/src/core/http/formDataParser.ts

@@ -1,89 +1,89 @@
-import type { RapidRequest } from "../request";
-
-export type BodyData = Record<string, string | File | (string | File)[]>;
-export type ParseBodyOptions = {
-  /**
-   * Parse all fields with multiple values should be parsed as an array.
-   * @default false
-   * @example
-   * ```ts
-   * const data = new FormData()
-   * data.append('file', 'aaa')
-   * data.append('file', 'bbb')
-   * data.append('message', 'hello')
-   * ```
-   *
-   * If `all` is `false`:
-   * parseBody should return `{ file: 'bbb', message: 'hello' }`
-   *
-   * If `all` is `true`:
-   * parseBody should return `{ file: ['aaa', 'bbb'], message: 'hello' }`
-   */
-  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");
-
-  if (isFormDataContent(contentType)) {
-    return parseFormData<T>(request, options);
-  }
-
-  return {} as T;
-};
-
-function isFormDataContent(contentType: string | null): boolean {
-  if (contentType === null) {
-    return false;
-  }
-
-  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();
-
-  if (formData) {
-    return convertFormDataToBodyData<T>(formData, options);
-  }
-
-  return {} as T;
-}
-
-function convertFormDataToBodyData<T extends BodyData = BodyData>(formData: FormData, options: ParseBodyOptions): T {
-  const form: BodyData = {};
-
-  formData.forEach((value, key) => {
-    const shouldParseAllValues = options.all || key.endsWith("[]");
-
-    if (!shouldParseAllValues) {
-      form[key] = value;
-    } else {
-      handleParsingAllValues(form, key, value);
-    }
-  });
-
-  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);
-  } else if (form[key]) {
-    convertToNewArray(form, key, value);
-  } else {
-    form[key] = value;
-  }
-};
-
-function isArrayField(field: unknown): field is (string | File)[] {
-  return Array.isArray(field);
-}
-
-const appendToExistingArray = (arr: (string | File)[], value: FormDataEntryValue): void => {
-  arr.push(value);
-};
-
-const convertToNewArray = (form: BodyData, key: string, value: FormDataEntryValue): void => {
-  form[key] = [form[key] as string | File, value];
-};
+import type { RapidRequest } from "../request";
+
+export type BodyData = Record<string, string | File | (string | File)[]>;
+export type ParseBodyOptions = {
+  /**
+   * Parse all fields with multiple values should be parsed as an array.
+   * @default false
+   * @example
+   * ```ts
+   * const data = new FormData()
+   * data.append('file', 'aaa')
+   * data.append('file', 'bbb')
+   * data.append('message', 'hello')
+   * ```
+   *
+   * If `all` is `false`:
+   * parseBody should return `{ file: 'bbb', message: 'hello' }`
+   *
+   * If `all` is `true`:
+   * parseBody should return `{ file: ['aaa', 'bbb'], message: 'hello' }`
+   */
+  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");
+
+  if (isFormDataContent(contentType)) {
+    return parseFormData<T>(request, options);
+  }
+
+  return {} as T;
+};
+
+function isFormDataContent(contentType: string | null): boolean {
+  if (contentType === null) {
+    return false;
+  }
+
+  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();
+
+  if (formData) {
+    return convertFormDataToBodyData<T>(formData, options);
+  }
+
+  return {} as T;
+}
+
+function convertFormDataToBodyData<T extends BodyData = BodyData>(formData: FormData, options: ParseBodyOptions): T {
+  const form: BodyData = {};
+
+  formData.forEach((value, key) => {
+    const shouldParseAllValues = options.all || key.endsWith("[]");
+
+    if (!shouldParseAllValues) {
+      form[key] = value;
+    } else {
+      handleParsingAllValues(form, key, value);
+    }
+  });
+
+  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);
+  } else if (form[key]) {
+    convertToNewArray(form, key, value);
+  } else {
+    form[key] = value;
+  }
+};
+
+function isArrayField(field: unknown): field is (string | File)[] {
+  return Array.isArray(field);
+}
+
+const appendToExistingArray = (arr: (string | File)[], value: FormDataEntryValue): void => {
+  arr.push(value);
+};
+
+const convertToNewArray = (form: BodyData, key: string, value: FormDataEntryValue): void => {
+  form[key] = [form[key] as string | File, value];
+};

package/src/core/http-types.ts

@@ -1,4 +1,4 @@
-export type HttpStatus = number;
-export type ResponseData = string | ArrayBuffer | ReadableStream;
-
-export type HeadersDefinition = [string, string][] | Record<string, string>;
+export type HttpStatus = number;
+export type ResponseData = string | ArrayBuffer | ReadableStream;
+
+export type HeadersDefinition = [string, string][] | Record<string, string>;

package/src/core/pluginManager.ts

@@ -1,175 +1,175 @@
-import { CreateEntityOptions, RpdApplicationConfig, RpdDataModel, UpdateEntityByIdOptions } from "~/types";
-import { IRpdServer, RapidPlugin } from "./server";
-import { RouteContext } from "./routeContext";
-import { ActionHandlerContext } from "./actionHandler";
-
-class PluginManager {
-  #server: IRpdServer;
-  #plugins: RapidPlugin[];
-
-  constructor(server: IRpdServer) {
-    this.#server = server;
-    this.#plugins = [];
-  }
-
-  async loadPlugins(plugins: RapidPlugin[]) {
-    for (const plugin of plugins) {
-      this.#plugins.push(plugin);
-    }
-  }
-
-  /** 初始化插件时调用。 */
-  async initPlugins() {
-    for (const plugin of this.#plugins) {
-      if (plugin.initPlugin) {
-        await plugin.initPlugin(this.#server);
-      }
-    }
-  }
-
-  /** 注册中间件 */
-  async registerMiddlewares() {
-    for (const plugin of this.#plugins) {
-      if (plugin.registerMiddlewares) {
-        await plugin.registerMiddlewares(this.#server);
-      }
-    }
-  }
-
-  /** 注册接口动作处理程序 */
-  async registerActionHandlers() {
-    for (const plugin of this.#plugins) {
-      if (plugin.registerActionHandlers) {
-        await plugin.registerActionHandlers(this.#server);
-      }
-    }
-  }
-
-  /** 注册事件处理程序 */
-  async registerEventHandlers() {
-    for (const plugin of this.#plugins) {
-      if (plugin.registerEventHandlers) {
-        await plugin.registerEventHandlers(this.#server);
-      }
-    }
-  }
-
-  /** 注册消息处理程序 */
-  async registerMessageHandlers() {
-    for (const plugin of this.#plugins) {
-      if (plugin.registerMessageHandlers) {
-        await plugin.registerMessageHandlers(this.#server);
-      }
-    }
-  }
-
-  /** 注册任务处理程序 */
-  async registerTaskProcessors() {
-    for (const plugin of this.#plugins) {
-      if (plugin.registerTaskProcessors) {
-        await plugin.registerTaskProcessors(this.#server);
-      }
-    }
-  }
-
-  /** 在加载应用前调用。 */
-  async onLoadingApplication(applicationConfig: RpdApplicationConfig) {
-    for (const plugin of this.#plugins) {
-      if (plugin.onLoadingApplication) {
-        await plugin.onLoadingApplication(this.#server, applicationConfig);
-      }
-    }
-  }
-
-  /** 配置数据模型 */
-  async configureModels(applicationConfig: RpdApplicationConfig) {
-    for (const plugin of this.#plugins) {
-      if (plugin.configureModels) {
-        await plugin.configureModels(this.#server, applicationConfig);
-      }
-    }
-  }
-
-  /** 配置模型属性 */
-  async configureModelProperties(applicationConfig: RpdApplicationConfig) {
-    for (const plugin of this.#plugins) {
-      if (plugin.configureModelProperties) {
-        await plugin.configureModelProperties(this.#server, applicationConfig);
-      }
-    }
-  }
-
-  /** 配置服务 */
-  async configureServices(applicationConfig: RpdApplicationConfig) {
-    for (const plugin of this.#plugins) {
-      if (plugin.configureServices) {
-        await plugin.configureServices(this.#server, applicationConfig);
-      }
-    }
-  }
-
-  /** 配置路由 */
-  async configureRoutes(applicationConfig: RpdApplicationConfig) {
-    for (const plugin of this.#plugins) {
-      if (plugin.configureRoutes) {
-        await plugin.configureRoutes(this.#server, applicationConfig);
-      }
-    }
-  }
-
-  /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
-  async onApplicationLoaded(applicationConfig: RpdApplicationConfig) {
-    for (const plugin of this.#plugins) {
-      if (plugin.onApplicationLoaded) {
-        await plugin.onApplicationLoaded(this.#server, applicationConfig);
-      }
-    }
-  }
-
-  /** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
-  async onApplicationReady(applicationConfig: RpdApplicationConfig) {
-    for (const plugin of this.#plugins) {
-      if (plugin.onApplicationReady) {
-        await plugin.onApplicationReady(this.#server, applicationConfig);
-      }
-    }
-  }
-
-  /** 在接收到HTTP请求，准备路由上下文时调用。 */
-  async onPrepareRouteContext(routeContext: RouteContext) {
-    for (const plugin of this.#plugins) {
-      if (plugin.onPrepareRouteContext) {
-        await plugin.onPrepareRouteContext(this.#server, routeContext);
-      }
-    }
-  }
-
-  /** 在接收到HTTP请求，执行 actions 前调用。 */
-  async beforeRunRouteActions(handlerContext: ActionHandlerContext) {
-    for (const plugin of this.#plugins) {
-      if (plugin.beforeRunRouteActions) {
-        await plugin.beforeRunRouteActions(this.#server, handlerContext);
-      }
-    }
-  }
-
-  /** 在创建实体前调用。 */
-  async beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions) {
-    for (const plugin of this.#plugins) {
-      if (plugin.beforeCreateEntity) {
-        await plugin.beforeCreateEntity(this.#server, model, options);
-      }
-    }
-  }
-
-  /** 在更新实体前调用。 */
-  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);
-      }
-    }
-  }
-}
-
-export default PluginManager;
+import { CreateEntityOptions, RpdApplicationConfig, RpdDataModel, UpdateEntityByIdOptions } from "~/types";
+import { IRpdServer, RapidPlugin } from "./server";
+import { RouteContext } from "./routeContext";
+import { ActionHandlerContext } from "./actionHandler";
+
+class PluginManager {
+  #server: IRpdServer;
+  #plugins: RapidPlugin[];
+
+  constructor(server: IRpdServer) {
+    this.#server = server;
+    this.#plugins = [];
+  }
+
+  async loadPlugins(plugins: RapidPlugin[]) {
+    for (const plugin of plugins) {
+      this.#plugins.push(plugin);
+    }
+  }
+
+  /** 初始化插件时调用。 */
+  async initPlugins() {
+    for (const plugin of this.#plugins) {
+      if (plugin.initPlugin) {
+        await plugin.initPlugin(this.#server);
+      }
+    }
+  }
+
+  /** 注册中间件 */
+  async registerMiddlewares() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerMiddlewares) {
+        await plugin.registerMiddlewares(this.#server);
+      }
+    }
+  }
+
+  /** 注册接口动作处理程序 */
+  async registerActionHandlers() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerActionHandlers) {
+        await plugin.registerActionHandlers(this.#server);
+      }
+    }
+  }
+
+  /** 注册事件处理程序 */
+  async registerEventHandlers() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerEventHandlers) {
+        await plugin.registerEventHandlers(this.#server);
+      }
+    }
+  }
+
+  /** 注册消息处理程序 */
+  async registerMessageHandlers() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerMessageHandlers) {
+        await plugin.registerMessageHandlers(this.#server);
+      }
+    }
+  }
+
+  /** 注册任务处理程序 */
+  async registerTaskProcessors() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerTaskProcessors) {
+        await plugin.registerTaskProcessors(this.#server);
+      }
+    }
+  }
+
+  /** 在加载应用前调用。 */
+  async onLoadingApplication(applicationConfig: RpdApplicationConfig) {
+    for (const plugin of this.#plugins) {
+      if (plugin.onLoadingApplication) {
+        await plugin.onLoadingApplication(this.#server, applicationConfig);
+      }
+    }
+  }
+
+  /** 配置数据模型 */
+  async configureModels(applicationConfig: RpdApplicationConfig) {
+    for (const plugin of this.#plugins) {
+      if (plugin.configureModels) {
+        await plugin.configureModels(this.#server, applicationConfig);
+      }
+    }
+  }
+
+  /** 配置模型属性 */
+  async configureModelProperties(applicationConfig: RpdApplicationConfig) {
+    for (const plugin of this.#plugins) {
+      if (plugin.configureModelProperties) {
+        await plugin.configureModelProperties(this.#server, applicationConfig);
+      }
+    }
+  }
+
+  /** 配置服务 */
+  async configureServices(applicationConfig: RpdApplicationConfig) {
+    for (const plugin of this.#plugins) {
+      if (plugin.configureServices) {
+        await plugin.configureServices(this.#server, applicationConfig);
+      }
+    }
+  }
+
+  /** 配置路由 */
+  async configureRoutes(applicationConfig: RpdApplicationConfig) {
+    for (const plugin of this.#plugins) {
+      if (plugin.configureRoutes) {
+        await plugin.configureRoutes(this.#server, applicationConfig);
+      }
+    }
+  }
+
+  /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
+  async onApplicationLoaded(applicationConfig: RpdApplicationConfig) {
+    for (const plugin of this.#plugins) {
+      if (plugin.onApplicationLoaded) {
+        await plugin.onApplicationLoaded(this.#server, applicationConfig);
+      }
+    }
+  }
+
+  /** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
+  async onApplicationReady(applicationConfig: RpdApplicationConfig) {
+    for (const plugin of this.#plugins) {
+      if (plugin.onApplicationReady) {
+        await plugin.onApplicationReady(this.#server, applicationConfig);
+      }
+    }
+  }
+
+  /** 在接收到HTTP请求，准备路由上下文时调用。 */
+  async onPrepareRouteContext(routeContext: RouteContext) {
+    for (const plugin of this.#plugins) {
+      if (plugin.onPrepareRouteContext) {
+        await plugin.onPrepareRouteContext(this.#server, routeContext);
+      }
+    }
+  }
+
+  /** 在接收到HTTP请求，执行 actions 前调用。 */
+  async beforeRunRouteActions(handlerContext: ActionHandlerContext) {
+    for (const plugin of this.#plugins) {
+      if (plugin.beforeRunRouteActions) {
+        await plugin.beforeRunRouteActions(this.#server, handlerContext);
+      }
+    }
+  }
+
+  /** 在创建实体前调用。 */
+  async beforeCreateEntity(model: RpdDataModel, options: CreateEntityOptions) {
+    for (const plugin of this.#plugins) {
+      if (plugin.beforeCreateEntity) {
+        await plugin.beforeCreateEntity(this.#server, model, options);
+      }
+    }
+  }
+
+  /** 在更新实体前调用。 */
+  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);
+      }
+    }
+  }
+}
+
+export default PluginManager;

package/src/core/providers/runtimeProvider.ts

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