@ruiapp/rapid-core 0.3.2 → 0.3.4

package/dist/index.d.ts

@@ -5,7 +5,10 @@ export * from "./core/routeContext";
 export * from "./core/server";
 export * from "./core/http-types";
 export * from "./core/actionHandler";
+export * from "./utilities/accessControlUtility";
+export * from "./utilities/entityUtility";
 export * from "./utilities/jwtUtility";
+export * from "./utilities/timeUtility";
 export { mapDbRowToEntity } from "./dataAccess/entityMapper";
 export * as bootstrapApplicationConfig from "./bootstrapApplicationConfig";
 export { default as MetaManagePlugin } from "./plugins/metaManage/MetaManagePlugin";

package/dist/index.js

@@ -2304,6 +2304,9 @@ function getEntityPartChanges(server, model, before, after) {
     return null;
 }
 
+function getNowString() {
+    return dayjs__default["default"]().format("YYYY-MM-DD HH:mm:ss.SSS");
+}
 function getNowStringWithTimezone() {
     return dayjs__default["default"]().format("YYYY-MM-DD HH:mm:ss.SSSZ");
 }
@@ -4175,6 +4178,46 @@ class RapidServer {
     }
 }
 
+function isAccessAllowed(policy, allowedActions) {
+    let isAnyCheckPassed = true;
+    let isAllCheckPassed = true;
+    if (policy.any) {
+        isAnyCheckPassed = false;
+        for (const action of policy.any) {
+            if (lodash.find(allowedActions, (item) => item === action) != null) {
+                isAnyCheckPassed = true;
+                break;
+            }
+        }
+    }
+    if (policy.all) {
+        isAllCheckPassed = true;
+        for (const action of policy.all) {
+            if (lodash.find(allowedActions, (item) => item === action) == null) {
+                isAnyCheckPassed = false;
+                break;
+            }
+        }
+    }
+    return isAnyCheckPassed && isAllCheckPassed;
+}
+
+function getEntityRelationTargetId(entity, propName, targetColumnName) {
+    if (!entity) {
+        throw new Error(`"entity" parameter is required.`);
+    }
+    let targetId = entity[propName];
+    if (!targetId && targetColumnName) {
+        targetId = entity[targetColumnName];
+    }
+    if (lodash.isObject(targetId)) {
+        return targetId.id;
+    }
+    else {
+        return targetId;
+    }
+}
+
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 // This module is browser compatible.
 /**
@@ -7810,6 +7853,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}'...`);
@@ -8111,30 +8155,6 @@ function getStateMachineCode(model, property) {
     }
 }
 
-function isAccessAllowed(policy, allowedActions) {
-    let isAnyCheckPassed = true;
-    let isAllCheckPassed = true;
-    if (policy.any) {
-        isAnyCheckPassed = false;
-        for (const action of policy.any) {
-            if (lodash.find(allowedActions, (item) => item === action) != null) {
-                isAnyCheckPassed = true;
-                break;
-            }
-        }
-    }
-    if (policy.all) {
-        isAllCheckPassed = true;
-        for (const action of policy.all) {
-            if (lodash.find(allowedActions, (item) => item === action) == null) {
-                isAnyCheckPassed = false;
-                break;
-            }
-        }
-    }
-    return isAnyCheckPassed && isAllCheckPassed;
-}
-
 class EntityAccessControlPlugin {
     constructor() { }
     get code() {
@@ -8279,5 +8299,9 @@ exports.bootstrapApplicationConfig = bootstrapApplicationConfig$1;
 exports.createJwt = createJwt;
 exports.decodeJwt = decodeJwt;
 exports.generateJwtSecretKey = generateJwtSecretKey;
+exports.getEntityRelationTargetId = getEntityRelationTargetId;
+exports.getNowString = getNowString;
+exports.getNowStringWithTimezone = getNowStringWithTimezone;
+exports.isAccessAllowed = isAccessAllowed;
 exports.mapDbRowToEntity = mapDbRowToEntity;
 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/dist/utilities/entityUtility.d.ts

@@ -0,0 +1 @@
+export declare function getEntityRelationTargetId(entity: Record<string, any>, propName: string, targetColumnName?: string): number;

package/package.json

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

package/rollup.config.js

@@ -1,16 +1,16 @@
-import typescript from "rollup-plugin-typescript2";
-import tscAlias from "rollup-plugin-tsc-alias";
-
-export default {
-  input: ["src/index.ts"],
-  output: [
-    {
-      dir: "dist",
-      entryFileNames: "[name].js",
-      format: "cjs",
-      exports: "named",
-    },
-  ],
-  plugins: [typescript(), tscAlias()],
-  external: [],
-};
+import typescript from "rollup-plugin-typescript2";
+import tscAlias from "rollup-plugin-tsc-alias";
+
+export default {
+  input: ["src/index.ts"],
+  output: [
+    {
+      dir: "dist",
+      entryFileNames: "[name].js",
+      format: "cjs",
+      exports: "named",
+    },
+  ],
+  plugins: [typescript(), tscAlias()],
+  external: [],
+};

package/src/core/actionHandler.ts

@@ -1,22 +1,22 @@
-import { RpdApplicationConfig } from "~/types";
-import { IRpdServer, RapidPlugin } from "./server";
-import { Next, RouteContext } from "./routeContext";
-import { Logger } from "~/facilities/log/LogFacility";
-
-export interface ActionHandlerContext {
-  logger: Logger;
-  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>;
-}
+import { RpdApplicationConfig } from "~/types";
+import { IRpdServer, RapidPlugin } from "./server";
+import { Next, RouteContext } from "./routeContext";
+import { Logger } from "~/facilities/log/LogFacility";
+
+export interface ActionHandlerContext {
+  logger: Logger;
+  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/src/core/eventManager.ts

@@ -1,20 +1,20 @@
-import { EventEmitter } from "events";
-
-export default class EventManager<EventTypes extends Record<string, any[]>> {
-  #eventEmitter: EventEmitter;
-
-  constructor() {
-    this.#eventEmitter = new EventEmitter();
-  }
-
-  on<K extends keyof EventTypes>(eventName: K, listener: (...args: EventTypes[K]) => void) {
-    this.#eventEmitter.on(eventName as string, listener);
-  }
-
-  async emit<K extends keyof EventTypes>(eventName: K, ...args: EventTypes[K]) {
-    const listeners = this.#eventEmitter.listeners(eventName as string);
-    for (const listener of listeners) {
-      await listener(...args);
-    }
-  }
-}
+import { EventEmitter } from "events";
+
+export default class EventManager<EventTypes extends Record<string, any[]>> {
+  #eventEmitter: EventEmitter;
+
+  constructor() {
+    this.#eventEmitter = new EventEmitter();
+  }
+
+  on<K extends keyof EventTypes>(eventName: K, listener: (...args: EventTypes[K]) => void) {
+    this.#eventEmitter.on(eventName as string, listener);
+  }
+
+  async emit<K extends keyof EventTypes>(eventName: K, ...args: EventTypes[K]) {
+    const listeners = this.#eventEmitter.listeners(eventName as string);
+    for (const listener of listeners) {
+      await listener(...args);
+    }
+  }
+}

package/src/core/facility.ts

@@ -1,7 +1,7 @@
-import { IRpdServer } from "./server";
-
-export interface FacilityFactory {
-  name: string;
-
-  createFacility: (server: IRpdServer, options?: any) => Promise<any>;
-}
+import { IRpdServer } from "./server";
+
+export interface FacilityFactory {
+  name: string;
+
+  createFacility: (server: IRpdServer, options?: any) => Promise<any>;
+}

package/src/core/http/formDataParser.ts

@@ -1,89 +1,89 @@
-import type { RapidRequest } from "../request";
-
-export type BodyData = Record<string, string | File | (string | File)[]>;
-export type ParseBodyOptions = {
-  /**
-   * Parse all fields with multiple values should be parsed as an array.
-   * @default false
-   * @example
-   * ```ts
-   * const data = new FormData()
-   * data.append('file', 'aaa')
-   * data.append('file', 'bbb')
-   * data.append('message', 'hello')
-   * ```
-   *
-   * If `all` is `false`:
-   * parseBody should return `{ file: 'bbb', message: 'hello' }`
-   *
-   * If `all` is `true`:
-   * parseBody should return `{ file: ['aaa', 'bbb'], message: 'hello' }`
-   */
-  all?: boolean;
-};
-
-export const parseFormDataBody = async <T extends BodyData = BodyData>(request: Request, options: ParseBodyOptions = { all: false }): Promise<T> => {
-  const contentType = request.headers.get("Content-Type");
-
-  if (isFormDataContent(contentType)) {
-    return parseFormData<T>(request, options);
-  }
-
-  return {} as T;
-};
-
-function isFormDataContent(contentType: string | null): boolean {
-  if (contentType === null) {
-    return false;
-  }
-
-  return contentType.startsWith("multipart/form-data") || contentType.startsWith("application/x-www-form-urlencoded");
-}
-
-async function parseFormData<T extends BodyData = BodyData>(request: Request, options: ParseBodyOptions): Promise<T> {
-  const formData = await (request as Request).formData();
-
-  if (formData) {
-    return convertFormDataToBodyData<T>(formData, options);
-  }
-
-  return {} as T;
-}
-
-function convertFormDataToBodyData<T extends BodyData = BodyData>(formData: FormData, options: ParseBodyOptions): T {
-  const form: BodyData = {};
-
-  formData.forEach((value, key) => {
-    const shouldParseAllValues = options.all || key.endsWith("[]");
-
-    if (!shouldParseAllValues) {
-      form[key] = value;
-    } else {
-      handleParsingAllValues(form, key, value);
-    }
-  });
-
-  return form as T;
-}
-
-const handleParsingAllValues = (form: BodyData, key: string, value: FormDataEntryValue): void => {
-  if (form[key] && isArrayField(form[key])) {
-    appendToExistingArray(form[key] as (string | File)[], value);
-  } else if (form[key]) {
-    convertToNewArray(form, key, value);
-  } else {
-    form[key] = value;
-  }
-};
-
-function isArrayField(field: unknown): field is (string | File)[] {
-  return Array.isArray(field);
-}
-
-const appendToExistingArray = (arr: (string | File)[], value: FormDataEntryValue): void => {
-  arr.push(value);
-};
-
-const convertToNewArray = (form: BodyData, key: string, value: FormDataEntryValue): void => {
-  form[key] = [form[key] as string | File, value];
-};
+import type { RapidRequest } from "../request";
+
+export type BodyData = Record<string, string | File | (string | File)[]>;
+export type ParseBodyOptions = {
+  /**
+   * Parse all fields with multiple values should be parsed as an array.
+   * @default false
+   * @example
+   * ```ts
+   * const data = new FormData()
+   * data.append('file', 'aaa')
+   * data.append('file', 'bbb')
+   * data.append('message', 'hello')
+   * ```
+   *
+   * If `all` is `false`:
+   * parseBody should return `{ file: 'bbb', message: 'hello' }`
+   *
+   * If `all` is `true`:
+   * parseBody should return `{ file: ['aaa', 'bbb'], message: 'hello' }`
+   */
+  all?: boolean;
+};
+
+export const parseFormDataBody = async <T extends BodyData = BodyData>(request: Request, options: ParseBodyOptions = { all: false }): Promise<T> => {
+  const contentType = request.headers.get("Content-Type");
+
+  if (isFormDataContent(contentType)) {
+    return parseFormData<T>(request, options);
+  }
+
+  return {} as T;
+};
+
+function isFormDataContent(contentType: string | null): boolean {
+  if (contentType === null) {
+    return false;
+  }
+
+  return contentType.startsWith("multipart/form-data") || contentType.startsWith("application/x-www-form-urlencoded");
+}
+
+async function parseFormData<T extends BodyData = BodyData>(request: Request, options: ParseBodyOptions): Promise<T> {
+  const formData = await (request as Request).formData();
+
+  if (formData) {
+    return convertFormDataToBodyData<T>(formData, options);
+  }
+
+  return {} as T;
+}
+
+function convertFormDataToBodyData<T extends BodyData = BodyData>(formData: FormData, options: ParseBodyOptions): T {
+  const form: BodyData = {};
+
+  formData.forEach((value, key) => {
+    const shouldParseAllValues = options.all || key.endsWith("[]");
+
+    if (!shouldParseAllValues) {
+      form[key] = value;
+    } else {
+      handleParsingAllValues(form, key, value);
+    }
+  });
+
+  return form as T;
+}
+
+const handleParsingAllValues = (form: BodyData, key: string, value: FormDataEntryValue): void => {
+  if (form[key] && isArrayField(form[key])) {
+    appendToExistingArray(form[key] as (string | File)[], value);
+  } else if (form[key]) {
+    convertToNewArray(form, key, value);
+  } else {
+    form[key] = value;
+  }
+};
+
+function isArrayField(field: unknown): field is (string | File)[] {
+  return Array.isArray(field);
+}
+
+const appendToExistingArray = (arr: (string | File)[], value: FormDataEntryValue): void => {
+  arr.push(value);
+};
+
+const convertToNewArray = (form: BodyData, key: string, value: FormDataEntryValue): void => {
+  form[key] = [form[key] as string | File, value];
+};

package/src/core/http-types.ts

@@ -1,4 +1,4 @@
-export type HttpStatus = number;
-export type ResponseData = string | ArrayBuffer | ReadableStream;
-
-export type HeadersDefinition = [string, string][] | Record<string, string>;
+export type HttpStatus = number;
+export type ResponseData = string | ArrayBuffer | ReadableStream;
+
+export type HeadersDefinition = [string, string][] | Record<string, string>;