@ruiapp/rapid-core 0.3.0 → 0.3.2

package/src/plugins/cronJob/CronJobPlugin.ts

@@ -1,112 +1,112 @@
-import * as cron from "cron";
-import type { RpdApplicationConfig } from "~/types";
-import pluginActionHandlers from "./actionHandlers";
-import pluginRoutes from "./routes";
-import { CronJobConfiguration, CronJobPluginInitOptions } from "./CronJobPluginTypes";
-import {
-  IRpdServer,
-  RapidPlugin,
-  RpdConfigurationItemOptions,
-  RpdServerPluginConfigurableTargetOptions,
-  RpdServerPluginExtendingAbilities,
-} from "~/core/server";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { find } from "lodash";
-
-class CronJobPlugin implements RapidPlugin {
-  #jobs: CronJobConfiguration[];
-
-  constructor(options: CronJobPluginInitOptions) {
-    this.#jobs = options.jobs || [];
-  }
-
-  get code(): string {
-    return "cronJob";
-  }
-
-  get description(): string {
-    return "";
-  }
-
-  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 registerActionHandlers(server: IRpdServer): Promise<any> {
-    for (const actionHandler of pluginActionHandlers) {
-      server.registerActionHandler(this, actionHandler);
-    }
-  }
-
-  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> {}
-
-  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> {}
-
-  async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    for (const job of this.#jobs) {
-      const jobInstance = cron.CronJob.from({
-        cronTime: job.cronTime,
-        onTick: async () => {
-          server.getLogger().info(`Executing cron job '${job.code}'...`);
-          await this.executeJob(server, job);
-        },
-      });
-      jobInstance.start();
-    }
-  }
-
-  getJobConfigurationByCode(code: string) {
-    return find(this.#jobs, (job) => job.code === code);
-  }
-
-  async executeJob(server: IRpdServer, job: CronJobConfiguration) {
-    const logger = server.getLogger();
-    try {
-      let handlerContext: ActionHandlerContext = {
-        logger,
-        routerContext: null,
-        next: null,
-        server,
-        applicationConfig: null,
-        input: null,
-      };
-
-      if (job.actionHandlerCode) {
-        const actionHandler = server.getActionHandlerByCode(job.code);
-        await actionHandler(handlerContext, job.handleOptions);
-      } else {
-        await job.handler(handlerContext, job.handleOptions);
-      }
-    } catch (ex) {
-      logger.error("Cron job execution error: " + ex.message);
-    }
-  }
-}
-
-export default CronJobPlugin;
+import * as cron from "cron";
+import type { RpdApplicationConfig } from "~/types";
+import pluginActionHandlers from "./actionHandlers";
+import pluginRoutes from "./routes";
+import { CronJobConfiguration, CronJobPluginInitOptions } from "./CronJobPluginTypes";
+import {
+  IRpdServer,
+  RapidPlugin,
+  RpdConfigurationItemOptions,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdServerPluginExtendingAbilities,
+} from "~/core/server";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { find } from "lodash";
+
+class CronJobPlugin implements RapidPlugin {
+  #jobs: CronJobConfiguration[];
+
+  constructor(options: CronJobPluginInitOptions) {
+    this.#jobs = options.jobs || [];
+  }
+
+  get code(): string {
+    return "cronJob";
+  }
+
+  get description(): string {
+    return "";
+  }
+
+  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 registerActionHandlers(server: IRpdServer): Promise<any> {
+    for (const actionHandler of pluginActionHandlers) {
+      server.registerActionHandler(this, actionHandler);
+    }
+  }
+
+  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> {}
+
+  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> {}
+
+  async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    for (const job of this.#jobs) {
+      const jobInstance = cron.CronJob.from({
+        cronTime: job.cronTime,
+        onTick: async () => {
+          server.getLogger().info(`Executing cron job '${job.code}'...`);
+          await this.executeJob(server, job);
+        },
+      });
+      jobInstance.start();
+    }
+  }
+
+  getJobConfigurationByCode(code: string) {
+    return find(this.#jobs, (job) => job.code === code);
+  }
+
+  async executeJob(server: IRpdServer, job: CronJobConfiguration) {
+    const logger = server.getLogger();
+    try {
+      let handlerContext: ActionHandlerContext = {
+        logger,
+        routerContext: null,
+        next: null,
+        server,
+        applicationConfig: null,
+        input: null,
+      };
+
+      if (job.actionHandlerCode) {
+        const actionHandler = server.getActionHandlerByCode(job.code);
+        await actionHandler(handlerContext, job.handleOptions);
+      } else {
+        await job.handler(handlerContext, job.handleOptions);
+      }
+    } catch (ex) {
+      logger.error("Cron job execution error: " + ex.message);
+    }
+  }
+}
+
+export default CronJobPlugin;

package/src/plugins/dataManage/DataManagePlugin.ts

@@ -1,163 +1,163 @@
-/**
- * Support manage data in database.
- * This plugin provide:
- * - routes for manage data in database.
- */
-
-import { RpdApplicationConfig, RpdHttpMethod, RpdRoute, RunEntityActionHandlerOptions } from "~/types";
-
-import * as findCollectionEntities from "./actionHandlers/findCollectionEntities";
-import * as findCollectionEntityById from "./actionHandlers/findCollectionEntityById";
-import * as countCollectionEntities from "./actionHandlers/countCollectionEntities";
-import * as createCollectionEntity from "./actionHandlers/createCollectionEntity";
-import * as createCollectionEntitiesBatch from "./actionHandlers/createCollectionEntitiesBatch";
-import * as updateCollectionEntityById from "./actionHandlers/updateCollectionEntityById";
-import * as deleteCollectionEntities from "./actionHandlers/deleteCollectionEntities";
-import * as deleteCollectionEntityById from "./actionHandlers/deleteCollectionEntityById";
-import * as addEntityRelations from "./actionHandlers/addEntityRelations";
-import * as removeEntityRelations from "./actionHandlers/removeEntityRelations";
-import * as queryDatabase from "./actionHandlers/queryDatabase";
-import {
-  RpdServerPluginExtendingAbilities,
-  RpdServerPluginConfigurableTargetOptions,
-  RpdConfigurationItemOptions,
-  IRpdServer,
-  RapidPlugin,
-} from "~/core/server";
-
-const routeConfigs: {
-  code: string;
-  method: RpdHttpMethod;
-  endpoint: string;
-  handlerCode: string;
-}[] = [
-  {
-    code: "createBatch",
-    method: "POST",
-    endpoint: "/operations/create_batch",
-    handlerCode: "createCollectionEntitiesBatch",
-  },
-  {
-    code: "find",
-    method: "POST",
-    endpoint: "/operations/find",
-    handlerCode: "findCollectionEntities",
-  },
-  {
-    code: "count",
-    method: "POST",
-    endpoint: "/operations/count",
-    handlerCode: "countCollectionEntities",
-  },
-  {
-    code: "delete",
-    method: "POST",
-    endpoint: "/operations/delete",
-    handlerCode: "deleteCollectionEntities",
-  },
-  {
-    code: "addRelations",
-    method: "POST",
-    endpoint: "/operations/add_relations",
-    handlerCode: "addEntityRelations",
-  },
-  {
-    code: "removeRelations",
-    method: "POST",
-    endpoint: "/operations/remove_relations",
-    handlerCode: "removeEntityRelations",
-  },
-  {
-    code: "getById",
-    method: "GET",
-    endpoint: "/:id",
-    handlerCode: "findCollectionEntityById",
-  },
-  {
-    code: "create",
-    method: "POST",
-    endpoint: "",
-    handlerCode: "createCollectionEntity",
-  },
-  {
-    code: "updateById",
-    method: "PATCH",
-    endpoint: "/:id",
-    handlerCode: "updateCollectionEntityById",
-  },
-  {
-    code: "deleteById",
-    method: "DELETE",
-    endpoint: "/:id",
-    handlerCode: "deleteCollectionEntityById",
-  },
-];
-
-class DataManager implements RapidPlugin {
-  get code(): string {
-    return "dataManager";
-  }
-
-  get description(): string {
-    return "对数据进行管理，提供增删改查等接口。";
-  }
-
-  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
-    return [];
-  }
-
-  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
-    return [];
-  }
-
-  get configurations(): RpdConfigurationItemOptions[] {
-    return [];
-  }
-
-  async registerActionHandlers(server: IRpdServer): Promise<any> {
-    server.registerActionHandler(this, findCollectionEntities);
-    server.registerActionHandler(this, findCollectionEntityById);
-    server.registerActionHandler(this, countCollectionEntities);
-    server.registerActionHandler(this, createCollectionEntity);
-    server.registerActionHandler(this, createCollectionEntitiesBatch);
-    server.registerActionHandler(this, updateCollectionEntityById);
-    server.registerActionHandler(this, addEntityRelations);
-    server.registerActionHandler(this, removeEntityRelations);
-    server.registerActionHandler(this, deleteCollectionEntities);
-    server.registerActionHandler(this, deleteCollectionEntityById);
-    server.registerActionHandler(this, queryDatabase);
-  }
-
-  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
-    const { models } = applicationConfig;
-    const routes: RpdRoute[] = [];
-
-    models.forEach((model) => {
-      const { namespace, singularCode, pluralCode } = model;
-
-      routeConfigs.forEach((routeConfig) => {
-        routes.push({
-          namespace,
-          name: `${namespace}.${singularCode}.${routeConfig.code}`,
-          code: `${namespace}.${singularCode}.${routeConfig.code}`,
-          type: "RESTful",
-          method: routeConfig.method,
-          endpoint: `/${namespace}/${pluralCode}${routeConfig.endpoint}`,
-          actions: [
-            {
-              code: routeConfig.handlerCode,
-              config: {
-                namespace,
-                singularCode,
-              } as RunEntityActionHandlerOptions,
-            },
-          ],
-        });
-      });
-    });
-
-    server.appendApplicationConfig({ routes });
-  }
-}
-
-export default DataManager;
+/**
+ * Support manage data in database.
+ * This plugin provide:
+ * - routes for manage data in database.
+ */
+
+import { RpdApplicationConfig, RpdHttpMethod, RpdRoute, RunEntityActionHandlerOptions } from "~/types";
+
+import * as findCollectionEntities from "./actionHandlers/findCollectionEntities";
+import * as findCollectionEntityById from "./actionHandlers/findCollectionEntityById";
+import * as countCollectionEntities from "./actionHandlers/countCollectionEntities";
+import * as createCollectionEntity from "./actionHandlers/createCollectionEntity";
+import * as createCollectionEntitiesBatch from "./actionHandlers/createCollectionEntitiesBatch";
+import * as updateCollectionEntityById from "./actionHandlers/updateCollectionEntityById";
+import * as deleteCollectionEntities from "./actionHandlers/deleteCollectionEntities";
+import * as deleteCollectionEntityById from "./actionHandlers/deleteCollectionEntityById";
+import * as addEntityRelations from "./actionHandlers/addEntityRelations";
+import * as removeEntityRelations from "./actionHandlers/removeEntityRelations";
+import * as queryDatabase from "./actionHandlers/queryDatabase";
+import {
+  RpdServerPluginExtendingAbilities,
+  RpdServerPluginConfigurableTargetOptions,
+  RpdConfigurationItemOptions,
+  IRpdServer,
+  RapidPlugin,
+} from "~/core/server";
+
+const routeConfigs: {
+  code: string;
+  method: RpdHttpMethod;
+  endpoint: string;
+  handlerCode: string;
+}[] = [
+  {
+    code: "createBatch",
+    method: "POST",
+    endpoint: "/operations/create_batch",
+    handlerCode: "createCollectionEntitiesBatch",
+  },
+  {
+    code: "find",
+    method: "POST",
+    endpoint: "/operations/find",
+    handlerCode: "findCollectionEntities",
+  },
+  {
+    code: "count",
+    method: "POST",
+    endpoint: "/operations/count",
+    handlerCode: "countCollectionEntities",
+  },
+  {
+    code: "delete",
+    method: "POST",
+    endpoint: "/operations/delete",
+    handlerCode: "deleteCollectionEntities",
+  },
+  {
+    code: "addRelations",
+    method: "POST",
+    endpoint: "/operations/add_relations",
+    handlerCode: "addEntityRelations",
+  },
+  {
+    code: "removeRelations",
+    method: "POST",
+    endpoint: "/operations/remove_relations",
+    handlerCode: "removeEntityRelations",
+  },
+  {
+    code: "getById",
+    method: "GET",
+    endpoint: "/:id",
+    handlerCode: "findCollectionEntityById",
+  },
+  {
+    code: "create",
+    method: "POST",
+    endpoint: "",
+    handlerCode: "createCollectionEntity",
+  },
+  {
+    code: "updateById",
+    method: "PATCH",
+    endpoint: "/:id",
+    handlerCode: "updateCollectionEntityById",
+  },
+  {
+    code: "deleteById",
+    method: "DELETE",
+    endpoint: "/:id",
+    handlerCode: "deleteCollectionEntityById",
+  },
+];
+
+class DataManager implements RapidPlugin {
+  get code(): string {
+    return "dataManager";
+  }
+
+  get description(): string {
+    return "对数据进行管理，提供增删改查等接口。";
+  }
+
+  get extendingAbilities(): RpdServerPluginExtendingAbilities[] {
+    return [];
+  }
+
+  get configurableTargets(): RpdServerPluginConfigurableTargetOptions[] {
+    return [];
+  }
+
+  get configurations(): RpdConfigurationItemOptions[] {
+    return [];
+  }
+
+  async registerActionHandlers(server: IRpdServer): Promise<any> {
+    server.registerActionHandler(this, findCollectionEntities);
+    server.registerActionHandler(this, findCollectionEntityById);
+    server.registerActionHandler(this, countCollectionEntities);
+    server.registerActionHandler(this, createCollectionEntity);
+    server.registerActionHandler(this, createCollectionEntitiesBatch);
+    server.registerActionHandler(this, updateCollectionEntityById);
+    server.registerActionHandler(this, addEntityRelations);
+    server.registerActionHandler(this, removeEntityRelations);
+    server.registerActionHandler(this, deleteCollectionEntities);
+    server.registerActionHandler(this, deleteCollectionEntityById);
+    server.registerActionHandler(this, queryDatabase);
+  }
+
+  async configureRoutes(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
+    const { models } = applicationConfig;
+    const routes: RpdRoute[] = [];
+
+    models.forEach((model) => {
+      const { namespace, singularCode, pluralCode } = model;
+
+      routeConfigs.forEach((routeConfig) => {
+        routes.push({
+          namespace,
+          name: `${namespace}.${singularCode}.${routeConfig.code}`,
+          code: `${namespace}.${singularCode}.${routeConfig.code}`,
+          type: "RESTful",
+          method: routeConfig.method,
+          endpoint: `/${namespace}/${pluralCode}${routeConfig.endpoint}`,
+          actions: [
+            {
+              code: routeConfig.handlerCode,
+              config: {
+                namespace,
+                singularCode,
+              } as RunEntityActionHandlerOptions,
+            },
+          ],
+        });
+      });
+    });
+
+    server.appendApplicationConfig({ routes });
+  }
+}
+
+export default DataManager;

package/src/plugins/dataManage/actionHandlers/addEntityRelations.ts

@@ -1,20 +1,20 @@
-import { AddEntityRelationsOptions, RunEntityActionHandlerOptions } from "~/types";
-import { mergeInput } from "~/helpers/inputHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "addEntityRelations";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  const { logger, server, input } = ctx;
-
-  const { defaultInput, fixedInput } = options;
-  const mergedInput: AddEntityRelationsOptions = mergeInput(defaultInput, input, fixedInput);
-  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
-
-  const entityManager = server.getEntityManager(options.singularCode);
-  mergedInput.routeContext = ctx.routerContext;
-  await entityManager.addRelations(mergedInput, plugin);
-
-  ctx.output = {};
-}
+import { AddEntityRelationsOptions, RunEntityActionHandlerOptions } from "~/types";
+import { mergeInput } from "~/helpers/inputHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "addEntityRelations";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
+  const { logger, server, input } = ctx;
+
+  const { defaultInput, fixedInput } = options;
+  const mergedInput: AddEntityRelationsOptions = mergeInput(defaultInput, input, fixedInput);
+  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
+
+  const entityManager = server.getEntityManager(options.singularCode);
+  mergedInput.routeContext = ctx.routerContext;
+  await entityManager.addRelations(mergedInput, plugin);
+
+  ctx.output = {};
+}

package/src/plugins/dataManage/actionHandlers/countCollectionEntities.ts

@@ -1,16 +1,16 @@
-import { CountEntityOptions, CountEntityResult, RunEntityActionHandlerOptions } from "~/types";
-import runCollectionEntityActionHandler from "~/helpers/runCollectionEntityActionHandler";
-import { removeFiltersWithNullValue } from "~/helpers/filterHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "countCollectionEntities";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  await runCollectionEntityActionHandler(ctx, options, code, async (entityManager, input: CountEntityOptions): Promise<CountEntityResult> => {
-    input.filters = removeFiltersWithNullValue(input.filters);
-    input.routeContext = ctx.routerContext;
-    const count = await entityManager.count(input);
-    return { count };
-  });
-}
+import { CountEntityOptions, CountEntityResult, RunEntityActionHandlerOptions } from "~/types";
+import runCollectionEntityActionHandler from "~/helpers/runCollectionEntityActionHandler";
+import { removeFiltersWithNullValue } from "~/helpers/filterHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "countCollectionEntities";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
+  await runCollectionEntityActionHandler(ctx, options, code, async (entityManager, input: CountEntityOptions): Promise<CountEntityResult> => {
+    input.filters = removeFiltersWithNullValue(input.filters);
+    input.routeContext = ctx.routerContext;
+    const count = await entityManager.count(input);
+    return { count };
+  });
+}