@ruiapp/rapid-core 0.1.3 → 0.1.5

package/src/core/pluginManager.ts

@@ -1,143 +1,144 @@
 import { RpdApplicationConfig } from "~/types";
-import Plugin from "./plugin";
-import * as metaManager from "~/plugins/metaManager/mod";
-import * as dataManager from "~/plugins/dataManager/mod";
-import * as routeManager from "~/plugins/routeManager/mod";
-import * as webhooks from "~/plugins/webhooks/mod";
-import * as authManager from "~/plugins/authManager/mod";
-import { IRpdServer, IRpdServerPlugin } from "./server";
-
-const plugins: IRpdServerPlugin[] = [];
-
-export async function loadPlugins() {
-  plugins.push(metaManager);
-  plugins.push(dataManager);
-  plugins.push(routeManager);
-  plugins.push(webhooks);
-  plugins.push(authManager);
-}
+import { IRpdServer, RapidPlugin } from "./server";
+
+class PluginManager {
+  #server: IRpdServer;
+  #plugins: RapidPlugin[];
 
-/** 初始化插件时调用。 */
-export async function initPlugins(server: IRpdServer) {
-  for (const plugin of plugins) {
-    const pluginInstance = new Plugin(plugin.code);
-    await plugin.initPlugin(pluginInstance, server);
+  constructor(server: IRpdServer) {
+    this.#server = server;
+    this.#plugins = [];
   }
-}
 
-/** 注册中间件 */
-export async function registerMiddlewares(server: IRpdServer) {
-  for (const plugin of plugins) {
-    if (plugin.registerMiddlewares) {
-      await plugin.registerMiddlewares(server);
+  async loadPlugins(plugins: RapidPlugin[]) {
+    for(const plugin of plugins) {
+      this.#plugins.push(plugin);
     }
   }
-}
 
-/** 注册接口动作处理程序 */
-export async function registerHttpHandlers(server: IRpdServer) {
-  for (const plugin of plugins) {
-    if (plugin.registerHttpHandlers) {
-      await plugin.registerHttpHandlers(server);
+  /** 初始化插件时调用。 */
+  async initPlugins() {
+    for (const plugin of this.#plugins) {
+      await plugin.initPlugin(this.#server);
     }
   }
-}
 
-/** 注册事件处理程序 */
-export async function registerEventHandlers(server: IRpdServer) {
-  for (const plugin of plugins) {
-    if (plugin.registerEventHandlers) {
-      await plugin.registerEventHandlers(server);
+  /** 注册中间件 */
+  async registerMiddlewares() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerMiddlewares) {
+        await plugin.registerMiddlewares(this.#server);
+      }
     }
   }
-}
 
-/** 注册消息处理程序 */
-export async function registerMessageHandlers(server: IRpdServer) {
-  for (const plugin of plugins) {
-    if (plugin.registerMessageHandlers) {
-      await plugin.registerMessageHandlers(server);
+  /** 注册接口动作处理程序 */
+  async registerHttpHandlers() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerHttpHandlers) {
+        await plugin.registerHttpHandlers(this.#server);
+      }
     }
   }
-}
 
-/** 注册任务处理程序 */
-export async function registerTaskProcessors(server: IRpdServer) {
-  for (const plugin of plugins) {
-    if (plugin.registerTaskProcessors) {
-      await plugin.registerTaskProcessors(server);
+  /** 注册事件处理程序 */
+  async registerEventHandlers() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerEventHandlers) {
+        await plugin.registerEventHandlers(this.#server);
+      }
     }
   }
-}
 
-/** 在加载应用前调用。 */
-export async function onLoadingApplication(
-  server: IRpdServer,
-  applicationConfig: RpdApplicationConfig,
-) {
-  for (const plugin of plugins) {
-    if (plugin.onLoadingApplication) {
-      await plugin.onLoadingApplication(server, applicationConfig);
+  /** 注册消息处理程序 */
+  async registerMessageHandlers() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerMessageHandlers) {
+        await plugin.registerMessageHandlers(this.#server);
+      }
     }
   }
-}
 
-/** 配置数据模型 */
-export async function configureModels(
-  server: IRpdServer,
-  applicationConfig: RpdApplicationConfig,
-) {
-  for (const plugin of plugins) {
-    if (plugin.configureModels) {
-      await plugin.configureModels(server, applicationConfig);
+  /** 注册任务处理程序 */
+  async registerTaskProcessors() {
+    for (const plugin of this.#plugins) {
+      if (plugin.registerTaskProcessors) {
+        await plugin.registerTaskProcessors(this.#server);
+      }
     }
   }
-}
 
-/** 配置模型属性 */
-export async function configureModelProperties(
-  server: IRpdServer,
-  applicationConfig: RpdApplicationConfig,
-) {
-  for (const plugin of plugins) {
-    if (plugin.configureModelProperties) {
-      await plugin.configureModelProperties(server, applicationConfig);
+  /** 在加载应用前调用。 */
+  async onLoadingApplication(
+    server: IRpdServer,
+    applicationConfig: RpdApplicationConfig,
+  ) {
+    for (const plugin of this.#plugins) {
+      if (plugin.onLoadingApplication) {
+        await plugin.onLoadingApplication(server, applicationConfig);
+      }
     }
   }
-}
 
-/** 配置路由 */
-export async function configureRoutes(
-  server: IRpdServer,
-  applicationConfig: RpdApplicationConfig,
-) {
-  for (const plugin of plugins) {
-    if (plugin.configureRoutes) {
-      await plugin.configureRoutes(server, applicationConfig);
+  /** 配置数据模型 */
+  async configureModels(
+    server: IRpdServer,
+    applicationConfig: RpdApplicationConfig,
+  ) {
+    for (const plugin of this.#plugins) {
+      if (plugin.configureModels) {
+        await plugin.configureModels(server, applicationConfig);
+      }
     }
   }
-}
 
-/** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
-export async function onApplicationLoaded(
-  server: IRpdServer,
-  applicationConfig: RpdApplicationConfig,
-) {
-  for (const plugin of plugins) {
-    if (plugin.onApplicationLoaded) {
-      await plugin.onApplicationLoaded(server, applicationConfig);
+  /** 配置模型属性 */
+  async configureModelProperties(
+    server: IRpdServer,
+    applicationConfig: RpdApplicationConfig,
+  ) {
+    for (const plugin of this.#plugins) {
+      if (plugin.configureModelProperties) {
+        await plugin.configureModelProperties(server, applicationConfig);
+      }
+    }
+  }
+
+  /** 配置路由 */
+  async configureRoutes(
+    server: IRpdServer,
+    applicationConfig: RpdApplicationConfig,
+  ) {
+    for (const plugin of this.#plugins) {
+      if (plugin.configureRoutes) {
+        await plugin.configureRoutes(server, applicationConfig);
+      }
     }
   }
-}
 
-/** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
-export async function onApplicationReady(
-  server: IRpdServer,
-  applicationConfig: RpdApplicationConfig,
-) {
-  for (const plugin of plugins) {
-    if (plugin.onApplicationReady) {
-      await plugin.onApplicationReady(server, applicationConfig);
+  /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
+  async onApplicationLoaded(
+    server: IRpdServer,
+    applicationConfig: RpdApplicationConfig,
+  ) {
+    for (const plugin of this.#plugins) {
+      if (plugin.onApplicationLoaded) {
+        await plugin.onApplicationLoaded(server, applicationConfig);
+      }
+    }
+  }
+
+  /** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
+  async onApplicationReady(
+    server: IRpdServer,
+    applicationConfig: RpdApplicationConfig,
+  ) {
+    for (const plugin of this.#plugins) {
+      if (plugin.onApplicationReady) {
+        await plugin.onApplicationReady(server, applicationConfig);
+      }
     }
   }
 }
+
+export default PluginManager;

package/src/core/providers/runtimeProvider.ts

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

package/src/core/request.ts

@@ -1,4 +1,5 @@
 import qs from "qs";
+import { parseFormDataBody } from "./http/formDataParser";
 
 export const GlobalRequest = global.Request;
 
@@ -46,7 +47,7 @@ export class RapidRequest {
       } else if (contentType.startsWith("multipart/form-data")) {
         this.#body = {
           type: "form-data",
-          value: await req.formData(),
+          value: await parseFormDataBody(req),
         }
       }
     } else {

package/src/core/routeContext.ts

@@ -11,7 +11,6 @@ export class RouteContext {
   readonly state: Record<string, any>;
   method: string;
   path: string;
-  status: HttpStatus;
   params: Record<string, string>;
 
   constructor(request: RapidRequest) {

package/src/core/routesBuilder.ts

@@ -47,15 +47,7 @@ export async function buildRoutes(
         ) {
           const body = request.body;
           if (body) {
-            if (body.type === "form-data") {
-              const formDataReader = body.value;
-              const formDataBody = await formDataReader.read({ maxFileSize: 1073741824 /* 1GB */});
-              Object.assign(input, {
-                formData: formDataBody
-              });
-            } else {
-              Object.assign(input, body.value);
-            }
+            Object.assign(input, body.value);
           }
         }
 
@@ -84,12 +76,8 @@ export async function buildRoutes(
           }
         }
 
-        if (handlerContext.status) {
-          routerContext.status = handlerContext.status;
-        }
-
         if (!isNullOrUndefined(handlerContext.output)) {
-          routerContext.json(handlerContext.output);
+          routerContext.json(handlerContext.output, handlerContext.status);
         }
       },
     );

package/src/core/server.ts

@@ -1,4 +1,4 @@
-import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IPluginInstance, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdServerEventTypes } from "~/types";
+import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdServerEventTypes } from "~/types";
 import { IPluginHttpHandler, HttpRequestHandler } from "./httpHandler";
 import { Next } from "./routeContext";
 
@@ -16,7 +16,7 @@ export interface IRpdServer {
   ) => Promise<any[]>;
   registerMiddleware(middleware: any): void;
   registerHttpHandler(
-    plugin: IPluginInstance,
+    plugin: RapidPlugin,
     options: IPluginHttpHandler,
   ): void;
   getHttpHandlerByCode(code: string): HttpRequestHandler | undefined;
@@ -32,7 +32,7 @@ export interface IRpdServer {
   ): this;
   emitEvent<K extends keyof RpdServerEventTypes>(
     eventName: K,
-    sender: IPluginInstance,
+    sender: RapidPlugin,
     payload: RpdServerEventTypes[K][1],
   ): void;
   handleRequest(request: Request, next: Next): Promise<Response>;
@@ -88,58 +88,40 @@ export interface RpdServerPluginConfigurableTargetOptions {
   configurations: RpdConfigurationItemOptions[];
 }
 
-export interface IRpdServerPlugin {
+export interface RapidPlugin {
   /** 插件代码 */
-  code: string;
+  get code(): string;
   /** 插件描述 */
-  description: string;
+  get description(): string;
   /** 插件可以提供哪些扩展能力 */
-  extendingAbilities: RpdServerPluginExtendingAbilities[];
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[];
   /** 插件可以配置的目标实体，以及和配置目标相关的配置项 */
-  configurableTargets?: RpdServerPluginConfigurableTargetOptions[];
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[];
   /** 插件的全局配置项 */
-  configurations?: RpdConfigurationItemOptions[];
+  get configurations(): RpdConfigurationItemOptions[];
   /** 初始化插件时调用。插件可以在此时进行一些内部对象的初始化工作。 */
-  initPlugin: (plugin: IPluginInstance, server: IRpdServer) => Promise<any>;
+  initPlugin(server: IRpdServer): Promise<any>;
   /** 注册中间件 */
-  registerMiddlewares?: (server: IRpdServer) => Promise<any>;
+  registerMiddlewares(server: IRpdServer): Promise<any>;
   /** 注册接口动作处理程序 */
-  registerHttpHandlers?: (server: IRpdServer) => Promise<any>;
+  registerHttpHandlers(server: IRpdServer): Promise<any>;
   /** 注册事件处理程序 */
-  registerEventHandlers?: (server: IRpdServer) => Promise<any>;
+  registerEventHandlers(server: IRpdServer): Promise<any>;
   /** 注册消息处理程序 */
-  registerMessageHandlers?: (server: IRpdServer) => Promise<any>;
+  registerMessageHandlers(server: IRpdServer): Promise<any>;
   /** 注册任务处理程序 */
-  registerTaskProcessors?: (server: IRpdServer) => Promise<any>;
+  registerTaskProcessors(server: IRpdServer): Promise<any>;
   /** 在加载应用前调用。 */
-  onLoadingApplication?: (
-    server: IRpdServer,
-    applicationConfig: RpdApplicationConfig,
-  ) => Promise<any>;
+  onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
   /** 配置数据集合 */
-  configureModels?: (
-    server: IRpdServer,
-    applicationConfig: RpdApplicationConfig,
-  ) => Promise<any>;
+  configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
   /** 配置模型属性 */
-  configureModelProperties?: (
-    server: IRpdServer,
-    applicationConfig: RpdApplicationConfig,
-  ) => Promise<any>;
+  configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
   /** 配置路由 */
-  configureRoutes?: (
-    server: IRpdServer,
-    applicationConfig: RpdApplicationConfig,
-  ) => Promise<any>;
+  configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
   /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
-  onApplicationLoaded?: (
-    server: IRpdServer,
-    applicationConfig: RpdApplicationConfig,
-  ) => Promise<any>;
+  onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
   /** 在应用准备完成后调用。此时服务器已经可以处理网络请求，可以对外广播消息。 */
-  onApplicationReady?: (
-    server: IRpdServer,
-    applicationConfig: RpdApplicationConfig,
-  ) => Promise<any>;
+  onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any>;
 }
 

package/src/dataAccess/dataAccessor.ts

@@ -56,7 +56,7 @@ export default class DataAccessor<T = any> implements IRpdDataAccessor<T> {
   }
 
   async find(options: FindEntityOptions): Promise<T[]> {
-    console.debug("DataAccessor.find() with options:", options);
+    console.debug(`DataAccessor '${this.#model.singularCode}' find with options:`, options);
     const query = this.#queryBuilder.select(this.#model, options);
     return await this.#databaseAccessor.queryDatabaseObject(query.command, query.params);
   }

package/src/index.ts

@@ -11,3 +11,10 @@ export * from "./core/server";
 export * from "./utilities/jwtUtility";
 
 export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";
+
+export { default as MetaManagePlugin } from "./plugins/metaManage/mod";
+export { default as DataManagePlugin } from "./plugins/dataManage/mod";
+export { default as RouteManagePlugin } from "./plugins/routeManage/mod";
+export { default as WebhooksPlugin } from "./plugins/webhooks/mod";
+export { default as AuthPlugin } from "./plugins/auth/mod";
+export { default as FileManagePlugin } from "./plugins/fileManage/mod";

package/src/plugins/{authManager → auth}/httpHandlers/createSession.ts

@@ -1,7 +1,7 @@
-import { IPluginInstance } from "~/types";
 import { setCookie } from "~/deno-std/http/cookie";
 import { createJwt } from "~/utilities/jwtUtility";
 import { HttpHandlerContext } from "~/core/httpHandler";
+import { RapidPlugin } from "~/core/server";
 
 export interface UserAccessToken {
   sub: "userAccessToken",
@@ -11,7 +11,7 @@ export interface UserAccessToken {
 export const code = "createSession";
 
 export async function handler(
-  plugin: IPluginInstance,
+  plugin: RapidPlugin,
   ctx: HttpHandlerContext,
   options: any,
 ) {

package/src/plugins/{authManager → auth}/httpHandlers/deleteSession.ts

@@ -1,11 +1,11 @@
 import { HttpHandlerContext } from "~/core/httpHandler";
+import { RapidPlugin } from "~/core/server";
 import { setCookie } from "~/deno-std/http/cookie";
-import { IPluginInstance } from "~/types";
 
 export const code = "deleteSession";
 
 export async function handler(
-  plugin: IPluginInstance,
+  plugin: RapidPlugin,
   ctx: HttpHandlerContext,
   options: any,
 ) {

package/src/plugins/{authManager → auth}/httpHandlers/getMyProfile.ts

@@ -1,11 +1,11 @@
-import { IPluginInstance } from "~/types";
 import { findEntity } from "~/dataAccess/entityManager";
 import { HttpHandlerContext } from "~/core/httpHandler";
+import { RapidPlugin } from "~/core/server";
 
 export const code = "getMyProfile";
 
 export async function handler(
-  plugin: IPluginInstance,
+  plugin: RapidPlugin,
   ctx: HttpHandlerContext,
   options: any,
 ) {

package/src/plugins/auth/mod.ts

@@ -0,0 +1,80 @@
+/**
+ * Auth manager plugin
+ */
+
+import * as _ from "lodash";
+import {
+  RpdApplicationConfig,
+} from "~/types";
+import { IRpdServer, RapidPlugin, RpdConfigurationItemOptions, RpdServerPluginConfigurableTargetOptions, RpdServerPluginExtendingAbilities } from "~/core/server";
+
+import pluginHttpHandlers from "./httpHandlers";
+import pluginModels from "./models";
+import pluginRoutes from "./routes";
+
+
+class AuthManager implements RapidPlugin {
+  get code(): string {
+    return "authManager";
+  }
+
+  get description(): string {
+    return null;
+  }
+
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
+    return [];
+  }
+
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
+    return [];
+  }
+
+  get configurations(): RpdConfigurationItemOptions[] {
+    return [];
+  }
+
+  async initPlugin(server: IRpdServer): Promise<any> {
+  }
+
+  async registerMiddlewares(server: IRpdServer): Promise<any> {
+  }
+
+  async registerHttpHandlers(server: IRpdServer): Promise<any> {
+    for (const httpHandler of pluginHttpHandlers) {
+      server.registerHttpHandler(this, httpHandler);
+    }
+  }
+
+  async registerEventHandlers(server: IRpdServer): Promise<any> {
+  }
+
+  async registerMessageHandlers(server: IRpdServer): Promise<any> {
+  }
+
+  async registerTaskProcessors(server: IRpdServer): Promise<any> {
+  }
+
+  async onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+  }
+
+  async configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ models: pluginModels });
+  }
+
+  async configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    server.appendApplicationConfig({ routes: pluginRoutes });
+  }
+
+  async onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    console.log("authManager.onApplicationLoaded");
+  }
+
+  async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+  }
+}
+
+export default AuthManager;

package/src/plugins/{dataManager → dataManage}/httpHandlers/addEntityRelations.ts

@@ -1,7 +1,8 @@
-import { IPluginInstance, RunEntityHttpHandlerOptions } from "~/types";
+import { RunEntityHttpHandlerOptions } from "~/types";
 import { mergeInput } from "~/helpers/inputHelper";
 import { isRelationProperty } from "~/utilities/rapidUtility";
 import { HttpHandlerContext } from "~/core/httpHandler";
+import { RapidPlugin } from "~/core/server";
 
 export const code = "addEntityRelations";
 
@@ -12,7 +13,7 @@ interface AddEntityRelationsInput {
 }
 
 export async function handler(
-  plugin: IPluginInstance,
+  plugin: RapidPlugin,
   ctx: HttpHandlerContext,
   options: RunEntityHttpHandlerOptions,
 ) {

package/src/plugins/{dataManager → dataManage}/httpHandlers/countCollectionEntities.ts

@@ -1,12 +1,13 @@
-import { IPluginInstance, RunEntityHttpHandlerOptions } from "~/types";
+import { RunEntityHttpHandlerOptions } from "~/types";
 import runCollectionEntityHttpHandler from "~/helpers/runCollectionEntityHttpHandler";
 import { removeFiltersWithNullValue } from "~/dataAccess/filterHelper";
 import { HttpHandlerContext } from "~/core/httpHandler";
+import { RapidPlugin } from "~/core/server";
 
 export const code = "countCollectionEntities";
 
 export async function handler(
-  plugin: IPluginInstance,
+  plugin: RapidPlugin,
   ctx: HttpHandlerContext,
   options: RunEntityHttpHandlerOptions,
 ) {

package/src/plugins/{dataManager → dataManage}/httpHandlers/createCollectionEntitiesBatch.ts

@@ -1,13 +1,14 @@
-import { IPluginInstance, RunEntityHttpHandlerOptions } from "~/types";
+import { RunEntityHttpHandlerOptions } from "~/types";
 import { mergeInput } from "~/helpers/inputHelper";
 import { createEntity } from "~/dataAccess/entityManager";
 import { isArray } from "lodash";
 import { HttpHandlerContext } from "~/core/httpHandler";
+import { RapidPlugin } from "~/core/server";
 
 export const code = "createCollectionEntitiesBatch";
 
 export async function handler(
-  plugin: IPluginInstance,
+  plugin: RapidPlugin,
   ctx: HttpHandlerContext,
   options: RunEntityHttpHandlerOptions,
 ) {

package/src/plugins/{dataManager → dataManage}/httpHandlers/createCollectionEntity.ts

@@ -1,12 +1,13 @@
-import { IPluginInstance, RunEntityHttpHandlerOptions } from "~/types";
+import { RunEntityHttpHandlerOptions } from "~/types";
 import { mergeInput } from "~/helpers/inputHelper";
 import { createEntity } from "~/dataAccess/entityManager";
 import { HttpHandlerContext } from "~/core/httpHandler";
+import { RapidPlugin } from "~/core/server";
 
 export const code = "createCollectionEntity";
 
 export async function handler(
-  plugin: IPluginInstance,
+  plugin: RapidPlugin,
   ctx: HttpHandlerContext,
   options: RunEntityHttpHandlerOptions,
 ) {