@ruiapp/rapid-core 0.1.4 → 0.1.6

package/dist/bootstrapApplicationConfig.d.ts

@@ -282,7 +282,7 @@ declare const _default: {
         type: "RESTful";
         method: "GET";
         endpoint: string;
-        handlers: {
+        actions: {
             code: string;
         }[];
     }[];

package/dist/core/actionHandler.d.ts

@@ -0,0 +1,17 @@
+import { RpdApplicationConfig } from "~/types";
+import { IRpdServer, RapidPlugin } from "./server";
+import { Next, RouteContext } from "./routeContext";
+export interface ActionHandlerContext {
+    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/dist/core/pluginManager.d.ts

@@ -1,27 +1,32 @@
 import { RpdApplicationConfig } from "~/types";
-import { IRpdServer } from "./server";
-export declare function loadPlugins(): Promise<void>;
-/** 初始化插件时调用。 */
-export declare function initPlugins(server: IRpdServer): Promise<void>;
-/** 注册中间件 */
-export declare function registerMiddlewares(server: IRpdServer): Promise<void>;
-/** 注册接口动作处理程序 */
-export declare function registerHttpHandlers(server: IRpdServer): Promise<void>;
-/** 注册事件处理程序 */
-export declare function registerEventHandlers(server: IRpdServer): Promise<void>;
-/** 注册消息处理程序 */
-export declare function registerMessageHandlers(server: IRpdServer): Promise<void>;
-/** 注册任务处理程序 */
-export declare function registerTaskProcessors(server: IRpdServer): Promise<void>;
-/** 在加载应用前调用。 */
-export declare function onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
-/** 配置数据模型 */
-export declare function configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
-/** 配置模型属性 */
-export declare function configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
-/** 配置路由 */
-export declare function configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
-/** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
-export declare function onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
-/** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
-export declare function onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+import { IRpdServer, RapidPlugin } from "./server";
+declare class PluginManager {
+    #private;
+    constructor(server: IRpdServer);
+    loadPlugins(plugins: RapidPlugin[]): Promise<void>;
+    /** 初始化插件时调用。 */
+    initPlugins(): Promise<void>;
+    /** 注册中间件 */
+    registerMiddlewares(): Promise<void>;
+    /** 注册接口动作处理程序 */
+    registerActionHandlers(): Promise<void>;
+    /** 注册事件处理程序 */
+    registerEventHandlers(): Promise<void>;
+    /** 注册消息处理程序 */
+    registerMessageHandlers(): Promise<void>;
+    /** 注册任务处理程序 */
+    registerTaskProcessors(): Promise<void>;
+    /** 在加载应用前调用。 */
+    onLoadingApplication(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+    /** 配置数据模型 */
+    configureModels(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+    /** 配置模型属性 */
+    configureModelProperties(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+    /** 配置路由 */
+    configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+    /** 在应用配置加载完成后调用。此时插件可以进行一些数据的初始化工作。 */
+    onApplicationLoaded(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+    /** 在应用准备完成后调用。此时服务器已经可以处理网络请求。 */
+    onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<void>;
+}
+export default PluginManager;

package/dist/core/server.d.ts

@@ -1,5 +1,5 @@
-import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IPluginInstance, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdServerEventTypes } from "~/types";
-import { IPluginHttpHandler, HttpRequestHandler } from "./httpHandler";
+import { GetDataAccessorOptions, GetModelOptions, IDatabaseConfig, IQueryBuilder, IRpdDataAccessor, RapidServerConfig, RpdApplicationConfig, RpdDataModel, RpdServerEventTypes } from "~/types";
+import { IPluginActionHandler, ActionHandler } from "./actionHandler";
 import { Next } from "./routeContext";
 export interface IRpdServer {
     config: RapidServerConfig;
@@ -8,14 +8,14 @@ export interface IRpdServer {
     queryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     tryQueryDatabaseObject: (sql: string, params?: unknown[] | Record<string, unknown>) => Promise<any[]>;
     registerMiddleware(middleware: any): void;
-    registerHttpHandler(plugin: IPluginInstance, options: IPluginHttpHandler): void;
-    getHttpHandlerByCode(code: string): HttpRequestHandler | undefined;
+    registerActionHandler(plugin: RapidPlugin, options: IPluginActionHandler): void;
+    getActionHandlerByCode(code: string): ActionHandler | undefined;
     getDataAccessor<T = any>(options: GetDataAccessorOptions): IRpdDataAccessor<T>;
     getApplicationConfig(): RpdApplicationConfig;
     appendApplicationConfig(config: Partial<RpdApplicationConfig>): any;
     getModel(options: GetModelOptions): RpdDataModel | undefined;
     registerEventHandler<K extends keyof RpdServerEventTypes>(eventName: K, listener: (...args: RpdServerEventTypes[K]) => void): this;
-    emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, sender: IPluginInstance, payload: RpdServerEventTypes[K][1]): void;
+    emitEvent<K extends keyof RpdServerEventTypes>(eventName: K, sender: RapidPlugin, payload: RpdServerEventTypes[K][1]): void;
     handleRequest(request: Request, next: Next): Promise<Response>;
 }
 export type RpdConfigurationItemTypes = "integer" | "text" | "boolean" | "date" | "datetime" | "json";
@@ -41,44 +41,44 @@ export interface RpdConfigurationItemOptions {
      */
     defaultValue?: string;
 }
-export type RpdServerPluginExtendingAbilities = /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware" | /** 是指增加系统中的集合的能力。 */ "extendModel" | /** 是指可以对模型增加属性的能力。 */ "extendProperty" | /** 是指增加接口动作的能力。 */ "extendHttpHandler" | /** 是指增加或者修改接口定义的能力。 */ "extendRoute" | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity" | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent" | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage" | /** 对特定任务进行处理的能力。 */ "processTask";
+export type RpdServerPluginExtendingAbilities = /** 是指提供处理网络请求的middleware的能力。 */ "extendMiddleware" | /** 是指增加系统中的集合的能力。 */ "extendModel" | /** 是指可以对模型增加属性的能力。 */ "extendProperty" | /** 是指增加接口动作的能力。 */ "extendActionHandler" | /** 是指增加或者修改接口定义的能力。 */ "extendRoute" | /** 是指对实体数据进行标准化的能力。 */ "normalizeEntity" | /** 处理事件总线发送过来的事件的能力。 */ "handleEvent" | /** 处理消息队列发送过来的消息的能力。 */ "handleMessage" | /** 对特定任务进行处理的能力。 */ "processTask";
 export interface RpdServerPluginConfigurableTargetOptions {
     targetCode: string;
     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>;
+    registerActionHandlers(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/dist/helpers/runCollectionEntityActionHandler.d.ts

@@ -0,0 +1,5 @@
+import { IRpdDataAccessor, RunEntityActionHandlerOptions } from "~/types";
+import { ActionHandlerContext } from "~/core/actionHandler";
+type DataAccessHandler = (dataAccessor: IRpdDataAccessor, input: any) => Promise<any>;
+export default function runCollectionEntityActionHandler(ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions, code: string, handleDataAccess: DataAccessHandler): Promise<void>;
+export {};

package/dist/index.d.ts

@@ -3,5 +3,13 @@ export * from "./server";
 export * from "./core/request";
 export * from "./core/routeContext";
 export * from "./core/server";
+export * from "./core/http-types";
+export * from "./core/actionHandler";
 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";