@ruiapp/rapid-core 0.5.11 → 0.5.13

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/cronJob/CronJobPluginTypes.ts

@@ -1,49 +1,49 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RpdHttpMethod } from "~/types";
-
-export interface CronJobConfiguration {
-  /**
-   * 定时任务编号
-   */
-  code: string;
-
-  /**
-   * 定时任务描述
-   */
-  description?: string;
-
-  /**
-   * crontab 表达式
-   */
-  cronTime: string;
-
-  /**
-   * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
-   */
-  actionHandlerCode?: string;
-
-  /**
-   * 定时任务处理程序
-   * @param ctx
-   * @param options
-   * @returns
-   */
-  handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
-
-  /**
-   * 处理定时任务时的设置选项
-   */
-  handleOptions?: any;
-}
-
-export interface CronJobPluginInitOptions {
-  jobs: CronJobConfiguration[];
-}
-
-export type RunCronJobActionHandlerOptions = {
-  code?: string;
-};
-
-export type RunCronJobInput = {
-  code?: string;
-};
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RpdHttpMethod } from "~/types";
+
+export interface CronJobConfiguration {
+  /**
+   * 定时任务编号
+   */
+  code: string;
+
+  /**
+   * 定时任务描述
+   */
+  description?: string;
+
+  /**
+   * crontab 表达式
+   */
+  cronTime: string;
+
+  /**
+   * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
+   */
+  actionHandlerCode?: string;
+
+  /**
+   * 定时任务处理程序
+   * @param ctx
+   * @param options
+   * @returns
+   */
+  handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
+
+  /**
+   * 处理定时任务时的设置选项
+   */
+  handleOptions?: any;
+}
+
+export interface CronJobPluginInitOptions {
+  jobs: CronJobConfiguration[];
+}
+
+export type RunCronJobActionHandlerOptions = {
+  code?: string;
+};
+
+export type RunCronJobInput = {
+  code?: string;
+};

package/src/plugins/cronJob/actionHandlers/index.ts

@@ -1,4 +1,4 @@
-import { IPluginActionHandler } from "~/core/actionHandler";
-import * as runCronJob from "./runCronJob";
-
-export default [runCronJob] satisfies IPluginActionHandler[];
+import { IPluginActionHandler } from "~/core/actionHandler";
+import * as runCronJob from "./runCronJob";
+
+export default [runCronJob] satisfies IPluginActionHandler[];

package/src/plugins/cronJob/actionHandlers/runCronJob.ts

@@ -1,29 +1,29 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RunCronJobActionHandlerOptions, RunCronJobInput } from "../CronJobPluginTypes";
-import type CronJobPlugin from "../CronJobPlugin";
-
-export const code = "runCronJob";
-
-export async function handler(plugin: CronJobPlugin, ctx: ActionHandlerContext, options: RunCronJobActionHandlerOptions) {
-  const { server, routerContext } = ctx;
-  const { response } = routerContext;
-
-  const input: RunCronJobInput = ctx.input;
-
-  if (options.code) {
-    input.code = options.code;
-  }
-
-  if (!input.code) {
-    throw new Error(`Cron job code is required.`);
-  }
-
-  const job = plugin.getJobConfigurationByCode(input.code);
-  if (!job) {
-    throw new Error(`Cron job with code '${input.code}' was not found.`);
-  }
-
-  await plugin.executeJob(server, job);
-
-  response.json({});
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RunCronJobActionHandlerOptions, RunCronJobInput } from "../CronJobPluginTypes";
+import type CronJobPlugin from "../CronJobPlugin";
+
+export const code = "runCronJob";
+
+export async function handler(plugin: CronJobPlugin, ctx: ActionHandlerContext, options: RunCronJobActionHandlerOptions) {
+  const { server, routerContext } = ctx;
+  const { response } = routerContext;
+
+  const input: RunCronJobInput = ctx.input;
+
+  if (options.code) {
+    input.code = options.code;
+  }
+
+  if (!input.code) {
+    throw new Error(`Cron job code is required.`);
+  }
+
+  const job = plugin.getJobConfigurationByCode(input.code);
+  if (!job) {
+    throw new Error(`Cron job with code '${input.code}' was not found.`);
+  }
+
+  await plugin.executeJob(server, job);
+
+  response.json({});
+}

package/src/plugins/cronJob/routes/index.ts

@@ -1,3 +1,3 @@
-import runCronJob from "./runCronJob";
-
-export default [runCronJob];
+import runCronJob from "./runCronJob";
+
+export default [runCronJob];

package/src/plugins/cronJob/routes/runCronJob.ts

@@ -1,15 +1,15 @@
-import { RpdRoute } from "~/types";
-
-export default {
-  namespace: "svc",
-  name: "svc.runCronJob",
-  code: "svc.runCronJob",
-  type: "RESTful",
-  method: "POST",
-  endpoint: "/svc/runCronJob",
-  actions: [
-    {
-      code: "runCronJob",
-    },
-  ],
-} satisfies RpdRoute;
+import { RpdRoute } from "~/types";
+
+export default {
+  namespace: "svc",
+  name: "svc.runCronJob",
+  code: "svc.runCronJob",
+  type: "RESTful",
+  method: "POST",
+  endpoint: "/svc/runCronJob",
+  actions: [
+    {
+      code: "runCronJob",
+    },
+  ],
+} satisfies RpdRoute;