@ruiapp/rapid-core 0.3.3 → 0.3.5

package/dist/helpers/licenseHelper.d.ts

@@ -0,0 +1,4 @@
+import { IRpdServer } from "../core/server";
+import { Logger } from "../facilities/log/LogFacility";
+export declare function validateLicense(server: IRpdServer): void;
+export declare function tryValidateLicense(logger: Logger, server: IRpdServer): boolean;

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export * from "./utilities/accessControlUtility";
 export * from "./utilities/entityUtility";
 export * from "./utilities/jwtUtility";
 export * from "./utilities/timeUtility";
+export * from "./helpers/licenseHelper";
 export { mapDbRowToEntity } from "./dataAccess/entityMapper";
 export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";
 export { default as MetaManagePlugin } from "./plugins/metaManage/MetaManagePlugin";

package/dist/index.js

@@ -4361,6 +4361,30 @@ async function generateJwtSecretKey() {
     return encode(exportedKey);
 }
 
+function validateLicense(server) {
+    const licenseService = server.getService("licenseService");
+    const license = licenseService.getLicense();
+    if (!license) {
+        const errorMessage = `无法获取系统授权信息。`;
+        throw new Error(errorMessage);
+    }
+    if (licenseService.isExpired()) {
+        const expireDate = lodash.get(license.authority, "expireDate");
+        const errorMessage = `您的系统授权已于${expireDate}过期。`;
+        throw new Error(errorMessage);
+    }
+}
+function tryValidateLicense(logger, server) {
+    try {
+        validateLicense(server);
+        return true;
+    }
+    catch (err) {
+        logger.error("授权验证失败：%s", err.message || "");
+    }
+    return false;
+}
+
 const code$u = "listMetaModels";
 async function handler$u(plugin, ctx, options) {
     const { applicationConfig } = ctx;
@@ -6043,18 +6067,10 @@ var changePassword$1 = /*#__PURE__*/Object.freeze({
 
 const code$d = "createSession";
 async function handler$d(plugin, ctx, options) {
-    const { server, input, routerContext } = ctx;
-    const { response } = routerContext;
+    const { server, input, routerContext: routeContext, logger } = ctx;
+    const { response } = routeContext;
     const { account, password } = input;
-    const licenseService = server.getService("licenseService");
-    const license = licenseService.getLicense();
-    if (!license) {
-        throw new Error(`登录失败，无法获取系统授权信息。`);
-    }
-    if (licenseService.isExpired()) {
-        const expireDate = lodash.get(license.authority, "expireDate");
-        throw new Error(`登录失败，系统授权已于${expireDate}过期。`);
-    }
+    validateLicense(server);
     const userDataAccessor = server.getDataAccessor({
         singularCode: "oc_user",
     });
@@ -7853,6 +7869,7 @@ class CronJobPlugin {
     async onApplicationReady(server, applicationConfig) {
         for (const job of this.#jobs) {
             const jobInstance = cron__namespace.CronJob.from({
+                ...(job.jobOptions || {}),
                 cronTime: job.cronTime,
                 onTick: async () => {
                     server.getLogger().info(`Executing cron job '${job.code}'...`);
@@ -7868,6 +7885,7 @@ class CronJobPlugin {
     async executeJob(server, job) {
         const logger = server.getLogger();
         try {
+            validateLicense(server);
             let handlerContext = {
                 logger,
                 routerContext: null,
@@ -8303,4 +8321,6 @@ exports.getNowString = getNowString;
 exports.getNowStringWithTimezone = getNowStringWithTimezone;
 exports.isAccessAllowed = isAccessAllowed;
 exports.mapDbRowToEntity = mapDbRowToEntity;
+exports.tryValidateLicense = tryValidateLicense;
+exports.validateLicense = validateLicense;
 exports.verifyJwt = verifyJwt;

package/dist/plugins/cronJob/CronJobPluginTypes.d.ts

@@ -12,6 +12,10 @@ export interface CronJobConfiguration {
      * crontab 表达式
      */
     cronTime: string;
+    /**
+     * 任务设置
+     */
+    jobOptions?: CronJobOptions;
     /**
      * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
      */
@@ -28,6 +32,16 @@ export interface CronJobConfiguration {
      */
     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[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/helpers/licenseHelper.ts

@@ -0,0 +1,29 @@
+import { get } from "lodash";
+import { IRpdServer } from "~/core/server";
+import { Logger } from "~/facilities/log/LogFacility";
+import LicenseService from "~/plugins/license/LicenseService";
+
+export function validateLicense(server: IRpdServer) {
+  const licenseService = server.getService<LicenseService>("licenseService");
+  const license = licenseService.getLicense();
+  if (!license) {
+    const errorMessage = `无法获取系统授权信息。`;
+    throw new Error(errorMessage);
+  }
+  if (licenseService.isExpired()) {
+    const expireDate = get(license.authority, "expireDate");
+    const errorMessage = `您的系统授权已于${expireDate}过期。`;
+    throw new Error(errorMessage);
+  }
+}
+
+export function tryValidateLicense(logger: Logger, server: IRpdServer) {
+  try {
+    validateLicense(server);
+    return true;
+  } catch (err: any) {
+    logger.error("授权验证失败：%s", err.message || "");
+  }
+
+  return false;
+}

package/src/index.ts

@@ -15,6 +15,8 @@ export * from "./utilities/entityUtility";
 export * from "./utilities/jwtUtility";
 export * from "./utilities/timeUtility";
 
+export * from "./helpers/licenseHelper";
+
 export { mapDbRowToEntity } from "./dataAccess/entityMapper";
 
 export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";

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

@@ -3,8 +3,7 @@ import { setCookie } from "~/deno-std/http/cookie";
 import { createJwt } from "~/utilities/jwtUtility";
 import { ActionHandlerContext } from "~/core/actionHandler";
 import { RapidPlugin } from "~/core/server";
-import LicenseService from "~/plugins/license/LicenseService";
-import { get } from "lodash";
+import { validateLicense } from "~/helpers/licenseHelper";
 
 export interface UserAccessToken {
   sub: "userAccessToken";
@@ -14,19 +13,11 @@ export interface UserAccessToken {
 export const code = "createSession";
 
 export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, input, routerContext } = ctx;
-  const { response } = routerContext;
+  const { server, input, routerContext: routeContext, logger } = ctx;
+  const { response } = routeContext;
   const { account, password } = input;
 
-  const licenseService = server.getService<LicenseService>("licenseService");
-  const license = licenseService.getLicense();
-  if (!license) {
-    throw new Error(`登录失败，无法获取系统授权信息。`);
-  }
-  if (licenseService.isExpired()) {
-    const expireDate = get(license.authority, "expireDate");
-    throw new Error(`登录失败，系统授权已于${expireDate}过期。`);
-  }
+  validateLicense(server);
 
   const userDataAccessor = server.getDataAccessor({
     singularCode: "oc_user",

package/src/plugins/cronJob/CronJobPlugin.ts

@@ -12,6 +12,7 @@ import {
 } from "~/core/server";
 import { ActionHandlerContext } from "~/core/actionHandler";
 import { find } from "lodash";
+import { validateLicense } from "~/helpers/licenseHelper";
 
 class CronJobPlugin implements RapidPlugin {
   #jobs: CronJobConfiguration[];
@@ -71,6 +72,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}'...`);
@@ -88,6 +90,8 @@ class CronJobPlugin implements RapidPlugin {
   async executeJob(server: IRpdServer, job: CronJobConfiguration) {
     const logger = server.getLogger();
     try {
+      validateLicense(server);
+
       let handlerContext: ActionHandlerContext = {
         logger,
         routerContext: null,

package/src/plugins/cronJob/CronJobPluginTypes.ts

@@ -1,5 +1,4 @@
 import { ActionHandlerContext } from "~/core/actionHandler";
-import { RpdHttpMethod } from "~/types";
 
 export interface CronJobConfiguration {
   /**
@@ -17,6 +16,11 @@ export interface CronJobConfiguration {
    */
   cronTime: string;
 
+  /**
+   * 任务设置
+   */
+  jobOptions?: CronJobOptions;
+
   /**
    * 任务处理程序编号。当指定处理程序编号时，忽略 handler 配置。
    */
@@ -36,6 +40,18 @@ export interface CronJobConfiguration {
   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[];
 }