@nocobase/plugin-workflow-sql 1.3.15-beta → 1.3.16-beta

package/dist/client/SQLInstruction.d.ts

@@ -39,6 +39,12 @@ export default class extends Instruction {
                 className: string;
             };
         };
+        withMeta: {
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-content': string;
+        };
     };
     scope: {
         sqlDescription(): React.JSX.Element;

package/dist/client/index.js

@@ -7,7 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-(function(e,o){typeof exports=="object"&&typeof module!="undefined"?o(exports,require("@nocobase/client"),require("react/jsx-runtime"),require("@nocobase/plugin-workflow/client"),require("react-i18next")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client","react/jsx-runtime","@nocobase/plugin-workflow/client","react-i18next"],o):(e=typeof globalThis!="undefined"?globalThis:e||self,o(e["@nocobase/plugin-workflow-sql"]={},e["@nocobase/client"],e.jsxRuntime,e["@nocobase/plugin-workflow"],e["react-i18next"]))})(this,function(e,o,t,a,l){"use strict";var m=Object.defineProperty;var x=(e,o,t)=>o in e?m(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t;var r=(e,o,t)=>(x(e,typeof o!="symbol"?o+"":o,t),t);var d=(e,o,t)=>new Promise((a,l)=>{var s=n=>{try{i(t.next(n))}catch(c){l(c)}},p=n=>{try{i(t.throw(n))}catch(c){l(c)}},i=n=>n.done?a(n.value):Promise.resolve(n.value).then(s,p);i((t=t.apply(e,o)).next())});const s="@nocobase/plugin-workflow-sql";class p extends a.Instruction{constructor(){super(...arguments);r(this,"title",`{{t("SQL action", { ns: "${s}" })}}`);r(this,"type","sql");r(this,"group","collection");r(this,"description",`{{t("Execute a SQL statement in database.", { ns: "${s}" })}}`);r(this,"fieldset",{dataSource:{type:"string",required:!0,title:'{{t("Data source")}}',description:`{{t("Select a data source to execute SQL.", { ns: "${s}" })}}`,"x-decorator":"FormItem","x-component":"DataSourceSelect","x-component-props":{className:"auto-width",filter(u){return u.options.isDBInstance||u.key===o.DEFAULT_DATA_SOURCE_KEY}},default:"main"},sql:{type:"string",required:!0,title:"SQL",description:"{{sqlDescription()}}","x-decorator":"FormItem","x-component":"WorkflowVariableRawTextArea","x-component-props":{rows:20,className:o.css`
+(function(e,o){typeof exports=="object"&&typeof module!="undefined"?o(exports,require("@nocobase/client"),require("react/jsx-runtime"),require("@nocobase/plugin-workflow/client"),require("react-i18next")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client","react/jsx-runtime","@nocobase/plugin-workflow/client","react-i18next"],o):(e=typeof globalThis!="undefined"?globalThis:e||self,o(e["@nocobase/plugin-workflow-sql"]={},e["@nocobase/client"],e.jsxRuntime,e["@nocobase/plugin-workflow"],e["react-i18next"]))})(this,function(e,o,t,a,l){"use strict";var w=Object.defineProperty;var x=(e,o,t)=>o in e?w(e,o,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[o]=t;var r=(e,o,t)=>(x(e,typeof o!="symbol"?o+"":o,t),t);var d=(e,o,t)=>new Promise((a,l)=>{var s=n=>{try{i(t.next(n))}catch(c){l(c)}},p=n=>{try{i(t.throw(n))}catch(c){l(c)}},i=n=>n.done?a(n.value):Promise.resolve(n.value).then(s,p);i((t=t.apply(e,o)).next())});const s="@nocobase/plugin-workflow-sql";class p extends a.Instruction{constructor(){super(...arguments);r(this,"title",`{{t("SQL action", { ns: "${s}" })}}`);r(this,"type","sql");r(this,"group","collection");r(this,"description",`{{t("Execute a SQL statement in database.", { ns: "${s}" })}}`);r(this,"fieldset",{dataSource:{type:"string",required:!0,title:'{{t("Data source")}}',description:`{{t("Select a data source to execute SQL.", { ns: "${s}" })}}`,"x-decorator":"FormItem","x-component":"DataSourceSelect","x-component-props":{className:"auto-width",filter(u){return u.options.isDBInstance||u.key===o.DEFAULT_DATA_SOURCE_KEY}},default:"main"},sql:{type:"string",required:!0,title:"SQL",description:"{{sqlDescription()}}","x-decorator":"FormItem","x-component":"WorkflowVariableRawTextArea","x-component-props":{rows:20,className:o.css`
           font-size: 80%;
           font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
-        `}}});r(this,"scope",{sqlDescription(){return t.jsxs(l.Trans,{ns:s,children:["SQL query result could be used through ",t.jsx("a",{href:"https://docs-cn.nocobase.com/handbook/workflow-json-query",target:"_blank",rel:"noreferrer",children:"JSON query node"})," (Commercial plugin)."]})}});r(this,"components",{WorkflowVariableRawTextArea:a.WorkflowVariableRawTextArea})}useVariables({key:u,title:w},{types:b,fieldNames:f=a.defaultFieldNames}){return{[f.value]:u,[f.label]:w}}}class i extends o.Plugin{afterAdd(){return d(this,null,function*(){})}beforeLoad(){return d(this,null,function*(){})}load(){return d(this,null,function*(){this.app.pm.get("workflow").registerInstruction("sql",p)})}}e.default=i,Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
+        `}},withMeta:{type:"boolean","x-decorator":"FormItem","x-component":"Checkbox","x-content":`{{t("Include meta information of this query in result", { ns: "${s}" })}}`}});r(this,"scope",{sqlDescription(){return t.jsxs(l.Trans,{ns:s,children:["SQL query result could be used through ",t.jsx("a",{href:"https://docs-cn.nocobase.com/handbook/workflow-json-query",target:"_blank",rel:"noreferrer",children:"JSON query node"})," (Commercial plugin)."]})}});r(this,"components",{WorkflowVariableRawTextArea:a.WorkflowVariableRawTextArea})}useVariables({key:u,title:m},{types:b,fieldNames:f=a.defaultFieldNames}){return{[f.value]:u,[f.label]:m}}}class i extends o.Plugin{afterAdd(){return d(this,null,function*(){})}beforeLoad(){return d(this,null,function*(){})}load(){return d(this,null,function*(){this.app.pm.get("workflow").registerInstruction("sql",p)})}}e.default=i,Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/dist/externalVersion.js

@@ -8,12 +8,12 @@
  */
 
 module.exports = {
-  "@nocobase/client": "1.3.15-beta",
-  "@nocobase/plugin-workflow": "1.3.15-beta",
+  "@nocobase/client": "1.3.16-beta",
+  "@nocobase/plugin-workflow": "1.3.16-beta",
   "react": "18.2.0",
   "react-i18next": "11.18.6",
-  "@nocobase/server": "1.3.15-beta",
-  "@nocobase/plugin-workflow-test": "1.3.15-beta",
-  "@nocobase/test": "1.3.15-beta",
-  "@nocobase/utils": "1.3.15-beta"
+  "@nocobase/server": "1.3.16-beta",
+  "@nocobase/plugin-workflow-test": "1.3.16-beta",
+  "@nocobase/test": "1.3.16-beta",
+  "@nocobase/utils": "1.3.16-beta"
 };

package/dist/locale/zh-CN.json

@@ -2,5 +2,6 @@
   "SQL action": "SQL 操作",
   "Execute a SQL statement in database.": "在数据库中执行一个 SQL 语句",
   "Select a data source to execute SQL.": "选择一个数据源来执行 SQL",
-  "SQL query result could be used through <1>JSON query node</1> (Commercial plugin).": "SQL 执行的结果可在 <1>JSON 解析节点</1> 中使用（商业插件）。"
+  "SQL query result could be used through <1>JSON query node</1> (Commercial plugin).": "SQL 执行的结果可在 <1>JSON 解析节点</1> 中使用（商业插件）。",
+  "Include meta information of this query in result": "在结果中包含此查询的元信息"
 }

package/dist/server/SQLInstruction.js

@@ -32,9 +32,8 @@ module.exports = __toCommonJS(SQLInstruction_exports);
 var import_plugin_workflow = require("@nocobase/plugin-workflow");
 class SQLInstruction_default extends import_plugin_workflow.Instruction {
   async run(node, input, processor) {
-    const { db } = this.workflow.app.dataSourceManager.dataSources.get(
-      node.config.dataSource || "main"
-    ).collectionManager;
+    const dataSourceName = node.config.dataSource || "main";
+    const { db } = this.workflow.app.dataSourceManager.dataSources.get(dataSourceName).collectionManager;
     if (!db) {
       throw new Error(`type of data source "${node.config.dataSource}" is not database`);
     }
@@ -44,13 +43,13 @@ class SQLInstruction_default extends import_plugin_workflow.Instruction {
         status: import_plugin_workflow.JOB_STATUS.RESOLVED
       };
     }
-    const result = await db.sequelize.query(sql, {
-      transaction: processor.transaction
+    const [result, meta] = await db.sequelize.query(sql, {
+      transaction: this.workflow.useDataSourceTransaction(dataSourceName, processor.transaction)
       // plain: true,
       // model: db.getCollection(node.config.collection).model
     });
     return {
-      result,
+      result: node.config.withMeta ? [result, meta] : result,
       status: import_plugin_workflow.JOB_STATUS.RESOLVED
     };
   }

package/dist/server/migrations/20240902174913-add-raw-result-mode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 { Migration } from '@nocobase/server';
+export default class extends Migration {
+    appVersion: string;
+    up(): Promise<void>;
+}

package/dist/server/migrations/20240902174913-add-raw-result-mode.js

@@ -0,0 +1,58 @@
+/**
+ * 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 add_raw_result_mode_exports = {};
+__export(add_raw_result_mode_exports, {
+  default: () => add_raw_result_mode_default
+});
+module.exports = __toCommonJS(add_raw_result_mode_exports);
+var import_server = require("@nocobase/server");
+class add_raw_result_mode_default extends import_server.Migration {
+  appVersion = "<1.3.16-beta";
+  async up() {
+    const { db } = this.context;
+    const NodeRepo = db.getRepository("flow_nodes");
+    await db.sequelize.transaction(async (transaction) => {
+      const nodes = await NodeRepo.find({
+        filter: {
+          type: "sql"
+        },
+        transaction
+      });
+      await nodes.reduce(
+        (promise, node) => promise.then(() => {
+          node.set("config", { ...node.config, withMeta: true });
+          node.changed("config", true);
+          return node.save({
+            silent: true,
+            transaction
+          });
+        }),
+        Promise.resolve()
+      );
+    });
+  }
+}

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "工作流：SQL 节点",
   "description": "Execute SQL statements in workflow.",
   "description.zh-CN": "可用于在工作流中对数据库执行任意 SQL 语句。",
-  "version": "1.3.15-beta",
+  "version": "1.3.16-beta",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
   "homepage": "https://docs.nocobase.com/handbook/workflow-sql",
@@ -21,7 +21,7 @@
     "@nocobase/server": "1.x",
     "@nocobase/test": "1.x"
   },
-  "gitHead": "56869e2ddab40501e349974ba4a0c7856288371b",
+  "gitHead": "28fae8fe9165b82d6ee4d4104cd81530aa897176",
   "keywords": [
     "Workflow"
   ]