@ruiapp/rapid-core 0.3.2 → 0.3.4

package/src/plugins/auth/actionHandlers/deleteSession.ts

@@ -1,18 +1,18 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-import { setCookie } from "~/deno-std/http/cookie";
-
-export const code = "deleteSession";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, input, routerContext } = ctx;
-  const { response } = routerContext;
-
-  setCookie(response.headers, {
-    name: ctx.server.config.sessionCookieName,
-    value: "",
-    path: "/",
-  });
-
-  routerContext.redirect("/signin");
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+import { setCookie } from "~/deno-std/http/cookie";
+
+export const code = "deleteSession";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, input, routerContext } = ctx;
+  const { response } = routerContext;
+
+  setCookie(response.headers, {
+    name: ctx.server.config.sessionCookieName,
+    value: "",
+    path: "/",
+  });
+
+  routerContext.redirect("/signin");
+}

package/src/plugins/auth/actionHandlers/getMyProfile.ts

@@ -1,35 +1,35 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "getMyProfile";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, input, routerContext } = ctx;
-
-  const userId = routerContext.state.userId;
-  if (!userId) {
-    ctx.status = 401;
-    ctx.output = {
-      error: {
-        message: "You are not signed in.",
-      },
-    };
-    return;
-  }
-
-  const entityManager = server.getEntityManager("oc_user");
-  const user = await entityManager.findEntity({
-    filters: [
-      {
-        operator: "eq",
-        field: "id",
-        value: userId,
-      },
-    ],
-    properties: ["id", "name", "login", "email", "department", "roles", "state", "createdAt"],
-  });
-
-  ctx.output = {
-    user,
-  };
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "getMyProfile";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, input, routerContext } = ctx;
+
+  const userId = routerContext.state.userId;
+  if (!userId) {
+    ctx.status = 401;
+    ctx.output = {
+      error: {
+        message: "You are not signed in.",
+      },
+    };
+    return;
+  }
+
+  const entityManager = server.getEntityManager("oc_user");
+  const user = await entityManager.findEntity({
+    filters: [
+      {
+        operator: "eq",
+        field: "id",
+        value: userId,
+      },
+    ],
+    properties: ["id", "name", "login", "email", "department", "roles", "state", "createdAt"],
+  });
+
+  ctx.output = {
+    user,
+  };
+}

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

@@ -1,8 +1,8 @@
-import { IPluginActionHandler } from "~/core/actionHandler";
-import * as changePassword from "./changePassword";
-import * as createSession from "./createSession";
-import * as deleteSession from "./deleteSession";
-import * as getMyProfile from "./getMyProfile";
-import * as resetPassword from "./resetPassword";
-
-export default [changePassword, createSession, deleteSession, getMyProfile, resetPassword] satisfies IPluginActionHandler[];
+import { IPluginActionHandler } from "~/core/actionHandler";
+import * as changePassword from "./changePassword";
+import * as createSession from "./createSession";
+import * as deleteSession from "./deleteSession";
+import * as getMyProfile from "./getMyProfile";
+import * as resetPassword from "./resetPassword";
+
+export default [changePassword, createSession, deleteSession, getMyProfile, resetPassword] satisfies IPluginActionHandler[];

package/src/plugins/auth/models/AccessToken.ts

@@ -1,56 +1,56 @@
-import { RpdDataModel } from "~/types";
-
-export default {
-  maintainedBy: "authManager",
-  namespace: "auth",
-  name: "access_token",
-  singularCode: "access_token",
-  pluralCode: "access_tokens",
-  schema: "public",
-  tableName: "access_tokens",
-  properties: [
-    {
-      name: "id",
-      code: "id",
-      columnName: "id",
-      type: "integer",
-      required: true,
-      autoIncrement: true,
-    },
-    {
-      name: "token",
-      code: "token",
-      columnName: "token",
-      type: "text",
-      required: true,
-    },
-    {
-      name: "description",
-      code: "description",
-      columnName: "description",
-      type: "text",
-      required: false,
-    },
-    {
-      name: "ownerType",
-      code: "ownerType",
-      columnName: "owner_type",
-      type: "text",
-      required: true,
-    },
-    {
-      name: "ownerId",
-      code: "ownerId",
-      columnName: "owner_id",
-      type: "integer",
-      required: true,
-    },
-    {
-      name: "expirationTime",
-      code: "expirationTime",
-      columnName: "expiration_time",
-      type: "datetime",
-      required: true,
-    },
-  ],
-} as RpdDataModel;
+import { RpdDataModel } from "~/types";
+
+export default {
+  maintainedBy: "authManager",
+  namespace: "auth",
+  name: "access_token",
+  singularCode: "access_token",
+  pluralCode: "access_tokens",
+  schema: "public",
+  tableName: "access_tokens",
+  properties: [
+    {
+      name: "id",
+      code: "id",
+      columnName: "id",
+      type: "integer",
+      required: true,
+      autoIncrement: true,
+    },
+    {
+      name: "token",
+      code: "token",
+      columnName: "token",
+      type: "text",
+      required: true,
+    },
+    {
+      name: "description",
+      code: "description",
+      columnName: "description",
+      type: "text",
+      required: false,
+    },
+    {
+      name: "ownerType",
+      code: "ownerType",
+      columnName: "owner_type",
+      type: "text",
+      required: true,
+    },
+    {
+      name: "ownerId",
+      code: "ownerId",
+      columnName: "owner_id",
+      type: "integer",
+      required: true,
+    },
+    {
+      name: "expirationTime",
+      code: "expirationTime",
+      columnName: "expiration_time",
+      type: "datetime",
+      required: true,
+    },
+  ],
+} as RpdDataModel;

package/src/plugins/auth/models/index.ts

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

package/src/plugins/auth/routes/changePassword.ts

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

package/src/plugins/auth/routes/getMyProfile.ts

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

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

@@ -1,7 +1,7 @@
-import changePassword from "./changePassword";
-import getMyProfile from "./getMyProfile";
-import resetPassword from "./resetPassword";
-import signin from "./signin";
-import signout from "./signout";
-
-export default [changePassword, getMyProfile, resetPassword, signin, signout];
+import changePassword from "./changePassword";
+import getMyProfile from "./getMyProfile";
+import resetPassword from "./resetPassword";
+import signin from "./signin";
+import signout from "./signout";
+
+export default [changePassword, getMyProfile, resetPassword, signin, signout];

package/src/plugins/auth/routes/resetPassword.ts

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

package/src/plugins/auth/routes/signin.ts

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

package/src/plugins/auth/routes/signout.ts

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

package/src/plugins/cronJob/CronJobPlugin.ts

@@ -71,6 +71,7 @@ class CronJobPlugin implements RapidPlugin {
   async onApplicationReady(server: IRpdServer, applicationConfig: RpdApplicationConfig): Promise<any> {
     for (const job of this.#jobs) {
       const jobInstance = cron.CronJob.from({
+        ...(job.jobOptions || {}),
         cronTime: job.cronTime,
         onTick: async () => {
           server.getLogger().info(`Executing cron job '${job.code}'...`);

package/src/plugins/cronJob/CronJobPluginTypes.ts

@@ -1,49 +1,65 @@
-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";
+
+export interface CronJobConfiguration {
+  /**
+   * 定时任务编号
+   */
+  code: string;
+
+  /**
+   * 定时任务描述
+   */
+  description?: string;
+
+  /**
+   * crontab 表达式
+   */
+  cronTime: string;
+
+  /**
+   * 任务设置
+   */
+  jobOptions?: CronJobOptions;
+
+  /**
+   * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
+   */
+  actionHandlerCode?: string;
+
+  /**
+   * 定时任务处理程序
+   * @param ctx
+   * @param options
+   * @returns
+   */
+  handler?: (ctx: ActionHandlerContext, options: any) => Promise<void>;
+
+  /**
+   * 处理定时任务时的设置选项
+   */
+  handleOptions?: any;
+}
+
+export interface CronJobOptions {
+  /**
+   * Instantly triggers the onTick function post initialization. Default is false.
+   */
+  runOnInit?: boolean;
+
+  /**
+   * If true, no additional instances of the onTick callback function will run until the current onTick callback has completed. Any new scheduled executions that occur while the current callback is running will be skipped entirely. Default is false.
+   */
+  waitForCompletion?: boolean;
+}
+
+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;