@nocobase/plugin-workflow-date-calculation 2.0.3

package/dist/server/DateCalculationInstruction.d.ts

@@ -0,0 +1,43 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Processor, Instruction, FlowNodeModel } from '@nocobase/plugin-workflow';
+import { Registry } from '@nocobase/utils';
+export default class extends Instruction {
+    functions: Registry<Function>;
+    constructor(workflow: any);
+    calculate({ steps, input, inputType }: {
+        steps?: any[];
+        input?: Date;
+        inputType?: string;
+    }): {
+        result: any;
+        status: -2;
+    } | {
+        result: number | Date;
+        status: 1;
+    };
+    run(node: FlowNodeModel, _: any, processor: Processor): Promise<{
+        result: any;
+        status: -2;
+    } | {
+        result: number | Date;
+        status: 1;
+    }>;
+    test({ steps, input, inputType }: {
+        steps?: any[];
+        input?: Date;
+        inputType?: string;
+    }): Promise<{
+        result: any;
+        status: -2;
+    } | {
+        result: number | Date;
+        status: 1;
+    }>;
+}

package/dist/server/DateCalculationInstruction.js

@@ -0,0 +1,93 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var DateCalculationInstruction_exports = {};
+__export(DateCalculationInstruction_exports, {
+  default: () => DateCalculationInstruction_default
+});
+module.exports = __toCommonJS(DateCalculationInstruction_exports);
+var import_plugin_workflow = require("@nocobase/plugin-workflow");
+var import_dayjs = __toESM(require("dayjs"));
+var import_isLeapYear = __toESM(require("dayjs/plugin/isLeapYear"));
+var import_dateFunction = require("./dateFunction");
+var import__ = require("..");
+var import_utils = require("@nocobase/utils");
+import_dayjs.default.extend(import_isLeapYear.default);
+class DateCalculationInstruction_default extends import_plugin_workflow.Instruction {
+  functions = new import_utils.Registry();
+  constructor(workflow) {
+    super(workflow);
+    for (const key in import_dateFunction.functions) {
+      this.functions.register(key, import_dateFunction.functions[key]);
+    }
+  }
+  calculate({ steps = [], input = /* @__PURE__ */ new Date(), inputType = "date" }) {
+    let result;
+    if (inputType === "date" && (0, import__.isDate)(input)) {
+      result = (0, import_dayjs.default)(input);
+    } else if (inputType === "number" && typeof input === "number") {
+      result = input;
+    } else {
+      return {
+        result: "Invalid input",
+        status: import_plugin_workflow.JOB_STATUS.ERROR
+      };
+    }
+    for (let i = 0; i < steps.length; i++) {
+      const step = steps[i];
+      const calculate = this.functions.get(step.function);
+      try {
+        result = calculate(result, step.arguments);
+      } catch (e) {
+        return {
+          result: e.toString(),
+          status: import_plugin_workflow.JOB_STATUS.ERROR
+        };
+      }
+    }
+    return {
+      result: import_dayjs.default.isDayjs(result) ? result.toDate() : result,
+      status: import_plugin_workflow.JOB_STATUS.RESOLVED
+    };
+  }
+  async run(node, _, processor) {
+    const { steps = [], input = /* @__PURE__ */ new Date(), inputType = "date" } = processor.getParsedValue(node.config, node.id);
+    return this.calculate({ steps, input, inputType });
+  }
+  async test({ steps = [], input = /* @__PURE__ */ new Date(), inputType = "date" }) {
+    return this.calculate({ steps, input, inputType });
+  }
+}

package/dist/server/dateFunction.d.ts

@@ -0,0 +1,15 @@
+import dayjs from 'dayjs';
+export declare const functions: {
+    add(input: any, args: any): any;
+    subtract(input: any, args: any): any;
+    diff(input: any, args: any): any;
+    get(input: any, args: any): any;
+    startOfTime(input: any, args: any): any;
+    endOfTime(input: any, args: any): any;
+    isLeapYear(input: any, args: any): any;
+    format(input: any, args: any): any;
+    transDuration(input: any, args: any): any;
+    toTimestamp(input: any, args: any): any;
+    tsToDate(input: any, args: any): dayjs.Dayjs;
+    changeTimezone(input: any, args: any): any;
+};

package/dist/server/dateFunction.js

@@ -0,0 +1,205 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var dateFunction_exports = {};
+__export(dateFunction_exports, {
+  functions: () => functions
+});
+module.exports = __toCommonJS(dateFunction_exports);
+var import_dayjs = __toESM(require("dayjs"));
+var import_duration = __toESM(require("dayjs/plugin/duration"));
+var import_quarterOfYear = __toESM(require("dayjs/plugin/quarterOfYear"));
+var import__ = require("..");
+import_dayjs.default.extend(import_duration.default);
+import_dayjs.default.extend(import_quarterOfYear.default);
+const methodsMap = {
+  year: "asYears",
+  month: "asMonths",
+  week: "asWeeks",
+  day: "asDays",
+  hour: "asHours",
+  minute: "asMinutes",
+  second: "asSeconds",
+  millisecond: "asMilliseconds"
+};
+const getMethodsMap = {
+  year: "year",
+  month: "month",
+  quarter: "quarter",
+  week: "day",
+  day: "date",
+  hour: "hour",
+  minute: "minute",
+  second: "second",
+  millisecond: "millisecond"
+};
+const transDurationMethodsMap = {
+  year: "years",
+  month: "months",
+  week: "weeks",
+  day: "days",
+  hour: "hours",
+  minute: "minutes",
+  second: "seconds",
+  millisecond: "milliseconds"
+};
+const startOfTimeMethodsMap = {
+  year: "year",
+  quarter: "quarter",
+  month: "month",
+  week: "isoWeek",
+  day: "day",
+  hour: "hour",
+  minute: "minute",
+  second: "second",
+  millisecond: "millisecond"
+};
+const endOfTimeMethodsMap = {
+  year: "year",
+  quarter: "quarter",
+  month: "month",
+  week: "isoWeek",
+  day: "day",
+  hour: "hour",
+  minute: "minute",
+  second: "second",
+  millisecond: "millisecond"
+};
+const timestampUnitFnsMap = {
+  second: "unix",
+  millisecond: "valueOf"
+};
+const functions = {
+  add(input, args) {
+    const { number, unit } = args;
+    return input.add(number, unit);
+  },
+  subtract(input, args) {
+    const { number, unit } = args;
+    return input.subtract(number, unit);
+  },
+  diff(input, args) {
+    const { date, unit, isAbs, round } = args;
+    if (!(0, import__.isDate)(date)) {
+      throw new Error(`Diff date [${date}] is not a valid date`);
+    }
+    const diffDay = (0, import_dayjs.default)(date);
+    let diff = input.diff(diffDay, unit, true);
+    if (isAbs) {
+      diff = Math.abs(diff);
+    }
+    if (round === -1) {
+      diff = Math.floor(diff);
+    } else if (round === 0) {
+      diff = Math.round(diff);
+    } else if (round === 1) {
+      diff = Math.ceil(diff);
+    }
+    return diff;
+  },
+  get(input, args) {
+    const { unit } = args;
+    const method = getMethodsMap[unit];
+    if (!method) {
+      return input.millisecond();
+    }
+    if (input[method]) {
+      const result = input[method]();
+      return unit === "month" ? result + 1 : result;
+    }
+    return input;
+  },
+  startOfTime(input, args) {
+    const { unit } = args;
+    return input.startOf(startOfTimeMethodsMap[unit]);
+  },
+  endOfTime(input, args) {
+    const { unit } = args;
+    return input.endOf(endOfTimeMethodsMap[unit]);
+  },
+  isLeapYear(input, args) {
+    return input.isLeapYear();
+  },
+  format(input, args) {
+    const { format } = args;
+    if (typeof format !== "string") {
+      throw new TypeError(`[${format}] is not a string`);
+    }
+    return input.format(format);
+  },
+  transDuration(input, args) {
+    const { unitBefore, unitAfter, round } = args;
+    if (!transDurationMethodsMap[unitBefore]) {
+      throw new TypeError(`[${unitBefore}] is not a unit string`);
+    }
+    if (!methodsMap[unitAfter]) {
+      throw new TypeError(`[${unitAfter}] is not a unit string`);
+    }
+    const duration2 = import_dayjs.default.duration(input, transDurationMethodsMap[unitBefore]);
+    let result = duration2[methodsMap[unitAfter]]();
+    if (round === -1) {
+      result = Math.floor(result);
+    } else if (round === 0) {
+      result = Math.round(result);
+    } else if (round === 1) {
+      result = Math.ceil(result);
+    }
+    return result;
+  },
+  toTimestamp(input, args) {
+    const { unit = "second" } = args;
+    const method = timestampUnitFnsMap[unit];
+    if (!method) {
+      throw new TypeError(`[${unit}] is not valid, only accept second or millisecond`);
+    }
+    return input[method]();
+  },
+  tsToDate(input, args) {
+    const { unit = "second" } = args;
+    if (!["second", "millisecond"].includes(unit)) {
+      throw new TypeError(`[${unit}] is not valid, only accept second or millisecond`);
+    }
+    return unit === "second" ? import_dayjs.default.unix(input) : (0, import_dayjs.default)(input);
+  },
+  changeTimezone(input, args) {
+    const { timezone } = args;
+    return input.tz(timezone);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  functions
+});

package/dist/server/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export { default } from './plugin';

package/dist/server/index.js

@@ -0,0 +1,42 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  default: () => import_plugin.default
+});
+module.exports = __toCommonJS(server_exports);
+var import_plugin = __toESM(require("./plugin"));

package/dist/server/plugin.d.ts

@@ -0,0 +1,11 @@
+import { Plugin } from '@nocobase/server';
+export declare class PluginWorkflowDateCalculationServer extends Plugin {
+    afterAdd(): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+    install(): Promise<void>;
+    afterEnable(): Promise<void>;
+    afterDisable(): Promise<void>;
+    remove(): Promise<void>;
+}
+export default PluginWorkflowDateCalculationServer;

package/dist/server/plugin.js

@@ -0,0 +1,68 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_exports = {};
+__export(plugin_exports, {
+  PluginWorkflowDateCalculationServer: () => PluginWorkflowDateCalculationServer,
+  default: () => plugin_default
+});
+module.exports = __toCommonJS(plugin_exports);
+var import_plugin_workflow = __toESM(require("@nocobase/plugin-workflow"));
+var import_server = require("@nocobase/server");
+var import_DateCalculationInstruction = __toESM(require("./DateCalculationInstruction"));
+class PluginWorkflowDateCalculationServer extends import_server.Plugin {
+  async afterAdd() {
+  }
+  async beforeLoad() {
+  }
+  async load() {
+    const workflowPlugin = this.app.pm.get(import_plugin_workflow.default);
+    workflowPlugin.registerInstruction("dateCalculation", import_DateCalculationInstruction.default);
+  }
+  async install() {
+  }
+  async afterEnable() {
+  }
+  async afterDisable() {
+  }
+  async remove() {
+  }
+}
+var plugin_default = PluginWorkflowDateCalculationServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginWorkflowDateCalculationServer
+});

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export declare function isDate(value: any): boolean;

package/dist/utils/index.js

@@ -0,0 +1,39 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var utils_exports = {};
+__export(utils_exports, {
+  isDate: () => isDate
+});
+module.exports = __toCommonJS(utils_exports);
+function isDate(value) {
+  const date = new Date(value);
+  return date.toString() !== "Invalid Date";
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isDate
+});

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@nocobase/plugin-workflow-date-calculation",
+  "displayName": "Workflow: date calculation node",
+  "displayName.zh-CN": "工作流: 日期计算节点",
+  "description": "Used to do date calculation in workflows, such as manipulating, comparing and formatting, etc.",
+  "description.zh-CN": "可用于在工作流中对日期进行操作求值，如加减、比较操作，格式化等。",
+  "version": "2.0.3",
+  "main": "dist/server/index.js",
+  "devDependencies": {
+    "moment-timezone": "0.5.48"
+  },
+  "nocobase": {
+    "supportedVersions": [
+      "1.x",
+      "2.x"
+    ],
+    "editionLevel": 0
+  },
+  "peerDependencies": {
+    "@nocobase/client": "2.x",
+    "@nocobase/plugin-workflow": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/test": "2.x"
+  },
+  "keywords": [
+    "Workflow"
+  ],
+  "license": "Apache-2.0",
+  "gitHead": "5bcb42fc092f85adb9511c1a351b388bd7aaf66e"
+}

package/server.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/server';
+export { default } from './dist/server';

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./dist/server/index.js');