@nocobase/plugin-workflow-sql 1.3.38-beta → 1.4.0-alpha

package/dist/client/SQLInstruction.d.ts

@@ -66,4 +66,5 @@ export default class extends Instruction {
         value: any;
         label: any;
     };
+    testable: boolean;
 }

package/dist/client/index.js

@@ -10,4 +10,4 @@
 (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;
-        `}},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"}})});
+        `}},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});r(this,"testable",!0)}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,13 @@
  */
 
 module.exports = {
-  "@nocobase/client": "1.3.38-beta",
-  "@nocobase/plugin-workflow": "1.3.38-beta",
+  "@nocobase/client": "1.4.0-alpha",
+  "@nocobase/plugin-workflow": "1.4.0-alpha",
   "react": "18.2.0",
   "react-i18next": "11.18.6",
-  "@nocobase/server": "1.3.38-beta",
-  "@nocobase/plugin-workflow-test": "1.3.38-beta",
-  "@nocobase/test": "1.3.38-beta",
-  "@nocobase/utils": "1.3.38-beta"
+  "@nocobase/server": "1.4.0-alpha",
+  "@nocobase/data-source-manager": "1.4.0-alpha",
+  "@nocobase/plugin-workflow-test": "1.4.0-alpha",
+  "@nocobase/test": "1.4.0-alpha",
+  "@nocobase/utils": "1.4.0-alpha"
 };

package/dist/server/SQLInstruction.d.ts

@@ -7,12 +7,24 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Processor, Instruction, FlowNodeModel } from '@nocobase/plugin-workflow';
+export type SQLInstructionConfig = {
+    dataSource?: string;
+    sql?: string;
+    withMeta?: boolean;
+};
 export default class extends Instruction {
     run(node: FlowNodeModel, input: any, processor: Processor): Promise<{
         status: 1;
         result?: undefined;
     } | {
-        result: any;
+        result: unknown[];
+        status: 1;
+    }>;
+    test({ dataSource, sql, withMeta }?: SQLInstructionConfig): Promise<{
+        result: unknown[];
         status: 1;
+    } | {
+        result: any;
+        status: -2;
     }>;
 }

package/dist/server/SQLInstruction.js

@@ -29,12 +29,13 @@ __export(SQLInstruction_exports, {
   default: () => SQLInstruction_default
 });
 module.exports = __toCommonJS(SQLInstruction_exports);
+var import_data_source_manager = require("@nocobase/data-source-manager");
 var import_plugin_workflow = require("@nocobase/plugin-workflow");
 class SQLInstruction_default extends import_plugin_workflow.Instruction {
   async run(node, input, processor) {
     const dataSourceName = node.config.dataSource || "main";
-    const { db } = this.workflow.app.dataSourceManager.dataSources.get(dataSourceName).collectionManager;
-    if (!db) {
+    const { collectionManager } = this.workflow.app.dataSourceManager.dataSources.get(dataSourceName);
+    if (!(collectionManager instanceof import_data_source_manager.SequelizeCollectionManager)) {
       throw new Error(`type of data source "${node.config.dataSource}" is not database`);
     }
     const sql = processor.getParsedValue(node.config.sql || "", node.id).trim();
@@ -43,7 +44,7 @@ class SQLInstruction_default extends import_plugin_workflow.Instruction {
         status: import_plugin_workflow.JOB_STATUS.RESOLVED
       };
     }
-    const [result = null, meta = null] = await db.sequelize.query(sql, {
+    const [result = null, meta = null] = await collectionManager.db.sequelize.query(sql, {
       transaction: this.workflow.useDataSourceTransaction(dataSourceName, processor.transaction)
       // plain: true,
       // model: db.getCollection(node.config.collection).model
@@ -53,4 +54,29 @@ class SQLInstruction_default extends import_plugin_workflow.Instruction {
       status: import_plugin_workflow.JOB_STATUS.RESOLVED
     };
   }
+  async test({ dataSource, sql, withMeta } = {}) {
+    if (!sql) {
+      return {
+        result: null,
+        status: import_plugin_workflow.JOB_STATUS.RESOLVED
+      };
+    }
+    const dataSourceName = dataSource || "main";
+    const { collectionManager } = this.workflow.app.dataSourceManager.dataSources.get(dataSourceName);
+    if (!(collectionManager instanceof import_data_source_manager.SequelizeCollectionManager)) {
+      throw new Error(`type of data source "${dataSource}" is not database`);
+    }
+    try {
+      const [result = null, meta = null] = await collectionManager.db.sequelize.query(sql) ?? [];
+      return {
+        result: withMeta ? [result, meta] : result,
+        status: import_plugin_workflow.JOB_STATUS.RESOLVED
+      };
+    } catch (error) {
+      return {
+        result: error.message,
+        status: import_plugin_workflow.JOB_STATUS.ERROR
+      };
+    }
+  }
 }

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "工作流：SQL 节点",
   "description": "Execute SQL statements in workflow.",
   "description.zh-CN": "可用于在工作流中对数据库执行任意 SQL 语句。",
-  "version": "1.3.38-beta",
+  "version": "1.4.0-alpha",
   "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": "1b9490667c9224cd0b179cbf75e10a581c49b230",
+  "gitHead": "f097a2bddec152522b5645bd5d451f4c866d2060",
   "keywords": [
     "Workflow"
   ]