@nocobase/plugin-workflow-json-query 1.9.7

package/dist/server/JSONQueryInstruction.d.ts

@@ -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.
+ */
+import { Registry } from '@nocobase/utils';
+import { Instruction, Processor, FlowNodeModel } from '@nocobase/plugin-workflow';
+type JSONQueryEngine = (expression: string, scope: any) => any;
+export default class extends Instruction {
+    engines: Registry<JSONQueryEngine>;
+    constructor(workflow: any);
+    execute({ engine, expression, model, source }: {
+        engine?: string;
+        expression: any;
+        model: any;
+        source: any;
+    }): Promise<{
+        result: any;
+        status: 1;
+    } | {
+        result: any;
+        status: -2;
+    }>;
+    run(node: FlowNodeModel, prevJob: any, processor: Processor): Promise<{
+        result: any;
+        status: 1;
+    } | {
+        result: any;
+        status: -2;
+    }>;
+    test(config: any): Promise<{
+        result: any;
+        status: 1;
+    } | {
+        result: any;
+        status: -2;
+    }>;
+}
+export {};

package/dist/server/JSONQueryInstruction.js

@@ -0,0 +1,99 @@
+/**
+ * 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 JSONQueryInstruction_exports = {};
+__export(JSONQueryInstruction_exports, {
+  default: () => JSONQueryInstruction_default
+});
+module.exports = __toCommonJS(JSONQueryInstruction_exports);
+var import_lodash = require("lodash");
+var import_utils = require("@nocobase/utils");
+var import_plugin_workflow = require("@nocobase/plugin-workflow");
+function mapModel(data, model) {
+  const result = {};
+  model.forEach(({ path, alias }) => {
+    if (typeof data === "object" && data) {
+      result[alias || path.replace(/\./g, "_")] = (0, import_lodash.get)(data, path);
+    }
+  });
+  return result;
+}
+class JSONQueryInstruction_default extends import_plugin_workflow.Instruction {
+  engines = new import_utils.Registry();
+  constructor(workflow) {
+    super(workflow);
+    this.engines.register("jmespath", (expression, scope) => {
+      const jmespath = require("jmespath");
+      return jmespath.search(scope, expression);
+    });
+    this.engines.register("jsonpathplus", (expression, scope) => {
+      const { JSONPath } = require("jsonpath-plus");
+      return JSONPath({ path: expression, json: scope, wrap: false });
+    });
+    this.engines.register("jsonata", (expression, scope) => {
+      const jsonata = require("jsonata");
+      return jsonata(expression).evaluate(scope);
+    });
+  }
+  async execute({ engine = "jmespath", expression, model, source }) {
+    const query = this.engines.get(engine);
+    try {
+      let result = query ? await query(expression, source) : source;
+      if ((model == null ? void 0 : model.length) && typeof result === "object" && result) {
+        result = Array.isArray(result) ? result.map((item) => mapModel(item, model)) : mapModel(result, model);
+      }
+      return {
+        result,
+        status: import_plugin_workflow.JOB_STATUS.RESOLVED
+      };
+    } catch (e) {
+      return {
+        result: e.toString(),
+        status: import_plugin_workflow.JOB_STATUS.ERROR
+      };
+    }
+  }
+  async run(node, prevJob, processor) {
+    var _a;
+    const { engine = "jmespath", model, source = "" } = node.config;
+    const { data, expression } = processor.getParsedValue(
+      {
+        data: source,
+        expression: ((_a = node.config) == null ? void 0 : _a.expression) || ""
+      },
+      node.id
+    );
+    return this.execute({
+      engine,
+      expression,
+      model,
+      source: data
+    });
+  }
+  async test(config) {
+    return this.execute(config);
+  }
+}

package/dist/server/Plugin.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This program is offered under a commercial license.
+ * For more information, see <https://www.nocobase.com/agreement>
+ */
+import { Plugin } from '@nocobase/server';
+export declare class WorkflowJSONQueryPlugin extends Plugin {
+    load(): Promise<void>;
+    afterEnable(): Promise<void>;
+    afterDisable(): Promise<void>;
+    remove(): Promise<void>;
+}
+export default WorkflowJSONQueryPlugin;

package/dist/server/Plugin.js

@@ -0,0 +1,62 @@
+/**
+ * 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, {
+  WorkflowJSONQueryPlugin: () => WorkflowJSONQueryPlugin,
+  default: () => Plugin_default
+});
+module.exports = __toCommonJS(Plugin_exports);
+var import_server = require("@nocobase/server");
+var import_plugin_workflow = __toESM(require("@nocobase/plugin-workflow"));
+var import_JSONQueryInstruction = __toESM(require("./JSONQueryInstruction"));
+class WorkflowJSONQueryPlugin extends import_server.Plugin {
+  async load() {
+    const workflowPlugin = this.app.getPlugin(import_plugin_workflow.default);
+    workflowPlugin.registerInstruction("json-query", import_JSONQueryInstruction.default);
+  }
+  async afterEnable() {
+  }
+  async afterDisable() {
+  }
+  async remove() {
+  }
+}
+var Plugin_default = WorkflowJSONQueryPlugin;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  WorkflowJSONQueryPlugin
+});

package/dist/server/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This program is offered under a commercial license.
+ * For more information, see <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/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@nocobase/plugin-workflow-json-query",
+  "version": "1.9.7",
+  "displayName": "Workflow: JSON calculation",
+  "displayName.zh-CN": "工作流：JSON 计算",
+  "description": "Used for transforming or calculating values from complex JSON data (result of HTTP request or SQL etc.).",
+  "description.zh-CN": "用于转换或计算复杂 JSON 对象的值（例如 HTTP 请求节点和 SQL 节点的结果）。",
+  "main": "./dist/server/index.js",
+  "homepage": "https://docs.nocobase.com/handbook/workflow-json-query",
+  "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/workflow-json-query",
+  "keywords": [
+    "Workflow"
+  ],
+  "devDependencies": {
+    "@nocobase/plugin-workflow-test": "1.9.7",
+    "jmespath": "^0.16.0",
+    "jsonata": "^2.0.3",
+    "jsonpath-plus": "^10.3.0"
+  },
+  "peerDependencies": {
+    "@nocobase/client": "1.x",
+    "@nocobase/plugin-workflow": "1.x",
+    "@nocobase/server": "1.x",
+    "@nocobase/test": "1.x",
+    "@nocobase/utils": "1.x"
+  },
+  "gitHead": "f5b5050e4bb51b59a294a66481f563c9eb409d71",
+  "nocobase": {
+    "defaultEnabled": true
+  }
+}

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');