@openfn/language-mysql 2.2.2 → 3.0.1

package/ast.json

@@ -1,18 +1,17 @@
 {
   "operations": [
     {
-      "name": "insert",
+      "name": "sql",
       "params": [
-        "table",
-        "fields"
+        "sqlQuery",
+        "options"
       ],
       "docs": {
-        "description": "Insert a record",
+        "description": "Execute a SQL statement. Take care when inserting values from state directly into a query,\nas this can be a vector for injection attacks. See [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html)\nfor guidelines",
         "tags": [
           {
             "title": "example",
-            "description": "insert(\"users\", { name: (state) => state.data.name });",
-            "caption": "Insert a record into the `users` table"
+            "description": "sql(state => `select * from ${state.data.tableName};`, { writeSql: true })"
           },
           {
             "title": "function",
@@ -26,21 +25,59 @@
           },
           {
             "title": "param",
-            "description": "The target table",
+            "description": "The SQL query as a string or a function that returns a string using state.",
             "type": {
-              "type": "NameExpression",
-              "name": "string"
+              "type": "UnionType",
+              "elements": [
+                {
+                  "type": "NameExpression",
+                  "name": "string"
+                },
+                {
+                  "type": "NameExpression",
+                  "name": "function"
+                }
+              ]
             },
-            "name": "table"
+            "name": "sqlQuery"
           },
           {
             "title": "param",
-            "description": "A fields object",
+            "description": "Optional options argument.",
             "type": {
-              "type": "NameExpression",
-              "name": "object"
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "object"
+              }
             },
-            "name": "fields"
+            "name": "options"
+          },
+          {
+            "title": "param",
+            "description": "If true, logs the generated SQL statement. Defaults to false.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "boolean"
+              }
+            },
+            "name": "options.writeSql",
+            "default": "false"
+          },
+          {
+            "title": "param",
+            "description": "If false, does not execute the SQL, just logs it and adds to state.queries. Defaults to true.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "boolean"
+              }
+            },
+            "name": "options.execute",
+            "default": "true"
           },
           {
             "title": "returns",
@@ -52,21 +89,21 @@
           }
         ]
       },
-      "valid": true
+      "valid": false
     },
     {
-      "name": "upsert",
+      "name": "insert",
       "params": [
         "table",
         "fields"
       ],
       "docs": {
-        "description": "Insert or Update a record if matched",
+        "description": "Insert a record",
         "tags": [
           {
             "title": "example",
-            "description": "upsert(\"table\", { name: (state) => state.data.name });",
-            "caption": "Upsert a record"
+            "description": "insert(\"users\", { name: (state) => state.data.name });",
+            "caption": "Insert a record into the `users` table"
           },
           {
             "title": "function",
@@ -109,23 +146,18 @@
       "valid": true
     },
     {
-      "name": "upsertMany",
+      "name": "upsert",
       "params": [
         "table",
-        "data"
+        "fields"
       ],
       "docs": {
-        "description": "Insert or update multiple records using ON DUPLICATE KEY",
+        "description": "Insert or Update a record if matched",
         "tags": [
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
           {
             "title": "example",
-            "description": "upsertMany(\n  'users', // the DB table\n  [\n    { name: 'one', email: 'one@openfn.org' },\n    { name: 'two', email: 'two@openfn.org' },\n  ]\n)",
-            "caption": "Upsert multiple records"
+            "description": "upsert(\"table\", { name: (state) => state.data.name });",
+            "caption": "Upsert a record"
           },
           {
             "title": "function",
@@ -148,12 +180,12 @@
           },
           {
             "title": "param",
-            "description": "An array of objects or a function that returns an array",
+            "description": "A fields object",
             "type": {
               "type": "NameExpression",
-              "name": "array"
+              "name": "object"
             },
-            "name": "data"
+            "name": "fields"
           },
           {
             "title": "returns",
@@ -168,17 +200,23 @@
       "valid": true
     },
     {
-      "name": "query",
+      "name": "upsertMany",
       "params": [
-        "options"
+        "table",
+        "data"
       ],
       "docs": {
-        "description": "Execute a SQL statement",
+        "description": "Insert or update multiple records using ON DUPLICATE KEY",
         "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
           {
             "title": "example",
-            "description": "query({ sql: 'select * from users;' })",
-            "caption": "Execute a SQL statement"
+            "description": "upsertMany(\n  'users', // the DB table\n  [\n    { name: 'one', email: 'one@openfn.org' },\n    { name: 'two', email: 'two@openfn.org' },\n  ]\n)",
+            "caption": "Upsert multiple records"
           },
           {
             "title": "function",
@@ -192,56 +230,21 @@
           },
           {
             "title": "param",
-            "description": "Payload data for the message",
+            "description": "The target table",
             "type": {
               "type": "NameExpression",
-              "name": "object"
+              "name": "string"
             },
-            "name": "options"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "Operation"
-            }
-          }
-        ]
-      },
-      "valid": true
-    },
-    {
-      "name": "sqlString",
-      "params": [
-        "queryString"
-      ],
-      "docs": {
-        "description": "Execute a SQL statement",
-        "tags": [
-          {
-            "title": "example",
-            "description": "sqlString(state => \"select * from items;\")",
-            "caption": "Execute a SQL statement"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "public",
-            "description": null,
-            "type": null
+            "name": "table"
           },
           {
             "title": "param",
-            "description": "A query string (or function which takes state and returns a string)",
+            "description": "An array of objects or a function that returns an array",
             "type": {
               "type": "NameExpression",
-              "name": "String"
+              "name": "array"
             },
-            "name": "queryString"
+            "name": "data"
           },
           {
             "title": "returns",
@@ -308,7 +311,7 @@
         "operation"
       ],
       "docs": {
-        "description": "A custom operation that will only execute the function if the condition returns true",
+        "description": "Execute a function only when the condition returns true",
         "tags": [
           {
             "title": "public",

package/dist/index.cjs

@@ -40,13 +40,11 @@ __export(src_exports, {
   fields: () => import_language_common2.fields,
   fn: () => import_language_common2.fn,
   fnIf: () => import_language_common2.fnIf,
-  http: () => import_language_common2.http,
   insert: () => insert,
   lastReferenceValue: () => import_language_common2.lastReferenceValue,
   merge: () => import_language_common2.merge,
-  query: () => query,
   sourceValue: () => import_language_common2.sourceValue,
-  sqlString: () => sqlString,
+  sql: () => sql,
   upsert: () => upsert,
   upsertMany: () => upsertMany
 });
@@ -69,13 +67,11 @@ __export(Adaptor_exports, {
   fields: () => import_language_common2.fields,
   fn: () => import_language_common2.fn,
   fnIf: () => import_language_common2.fnIf,
-  http: () => import_language_common2.http,
   insert: () => insert,
   lastReferenceValue: () => import_language_common2.lastReferenceValue,
   merge: () => import_language_common2.merge,
-  query: () => query,
   sourceValue: () => import_language_common2.sourceValue,
-  sqlString: () => sqlString,
+  sql: () => sql,
   upsert: () => upsert,
   upsertMany: () => upsertMany
 });
@@ -84,6 +80,36 @@ var import_util = require("@openfn/language-common/util");
 var import_mysql = __toESM(require("mysql"), 1);
 var import_squel = __toESM(require("squel"), 1);
 var import_language_common2 = require("@openfn/language-common");
+function sql(sqlQuery, options = {}) {
+  return (state) => {
+    const { connection } = state;
+    const [resolvedSqlQuery, resolvedOptions] = (0, import_util.expandReferences)(
+      state,
+      sqlQuery,
+      options
+    );
+    const { writeSql = false, execute: execute2 = true } = resolvedOptions;
+    if (writeSql) {
+      console.log("Prepared SQL:", resolvedSqlQuery);
+    }
+    if (!execute2) {
+      return {
+        ...state,
+        queries: [...state.queries || [], resolvedSqlQuery]
+      };
+    }
+    return new Promise((resolve, reject) => {
+      connection.query(resolvedSqlQuery, (err, results, fields2) => {
+        if (err) {
+          console.log("Error executing query. Disconnecting from database.");
+          connection.end();
+          return reject(err);
+        }
+        resolve({ ...state, response: { body: results, fields: fields2 } });
+      });
+    });
+  };
+}
 function execute(...operations) {
   const initialState = {
     references: [],
@@ -127,9 +153,9 @@ function insert(table, fields2) {
     var sqlParams = squelMysql.insert({
       autoQuoteFieldNames: true
     }).into(table).setFields(valuesObj).toParam();
-    var sql = sqlParams.text;
-    var inserts = sqlParams.values;
-    sqlString = import_mysql.default.format(sql, inserts);
+    const sql2 = sqlParams.text;
+    const inserts = sqlParams.values;
+    const sqlString = import_mysql.default.format(sql2, inserts);
     console.log(`Executing MySQL query: ${sqlString}`);
     return new Promise((resolve, reject) => {
       connection.query(sqlString, function(err, results, fields3) {
@@ -158,15 +184,15 @@ function upsert(table, fields2) {
     var insertParams = squelMysql.insert({
       autoQuoteFieldNames: true
     }).into(table).setFields(valuesObj).toParam();
-    var sql = insertParams.text;
+    var sql2 = insertParams.text;
     var inserts = insertParams.values;
-    const insertString = import_mysql.default.format(sql, inserts);
+    const insertString = import_mysql.default.format(sql2, inserts);
     var updateParams = squelMysql.update({
       autoQuoteFieldNames: true
     }).table("").setFields(valuesObj).toParam();
-    var sql = updateParams.text;
+    var sql2 = updateParams.text;
     var inserts = updateParams.values;
-    const updateString = import_mysql.default.format(sql, inserts);
+    const updateString = import_mysql.default.format(sql2, inserts);
     const upsertString = insertString + ` ON DUPLICATE KEY UPDATE ` + updateString.slice(10);
     console.log("Executing MySQL query: " + upsertString);
     return new Promise((resolve, reject) => {
@@ -222,36 +248,6 @@ function upsertMany(table, data) {
     });
   };
 }
-function query(options) {
-  return (state) => {
-    let { connection } = state;
-    const [opts] = (0, import_util.expandReferences)(state, options);
-    console.log(
-      "Executing MySQL statement with options: " + JSON.stringify(opts, 2, null)
-    );
-    return new Promise((resolve, reject) => {
-      connection.query(opts, function(err, results, fields2) {
-        if (err) {
-          reject(err);
-          console.log("That's an error. Disconnecting from database.");
-          connection.end();
-        } else {
-          console.log("Success...");
-          resolve(JSON.parse(JSON.stringify(results)));
-        }
-      });
-    }).then((data) => {
-      console.log(data);
-      const nextState = { ...state, response: { body: data } };
-      return nextState;
-    });
-  };
-}
-function sqlString(queryString) {
-  return (state) => {
-    return query({ sql: queryString })(state);
-  };
-}
 
 // src/index.js
 var src_default = Adaptor_exports;
@@ -271,13 +267,11 @@ var src_default = Adaptor_exports;
   fields,
   fn,
   fnIf,
-  http,
   insert,
   lastReferenceValue,
   merge,
-  query,
   sourceValue,
-  sqlString,
+  sql,
   upsert,
   upsertMany
 });

package/dist/index.js

@@ -21,13 +21,11 @@ __export(Adaptor_exports, {
   fields: () => fields,
   fn: () => fn,
   fnIf: () => fnIf,
-  http: () => http,
   insert: () => insert,
   lastReferenceValue: () => lastReferenceValue,
   merge: () => merge,
-  query: () => query,
   sourceValue: () => sourceValue,
-  sqlString: () => sqlString,
+  sql: () => sql,
   upsert: () => upsert,
   upsertMany: () => upsertMany
 });
@@ -39,7 +37,6 @@ import {
   fn,
   fnIf,
   each,
-  http,
   merge,
   field,
   fields,
@@ -54,6 +51,36 @@ import {
   lastReferenceValue,
   as
 } from "@openfn/language-common";
+function sql(sqlQuery, options = {}) {
+  return (state) => {
+    const { connection } = state;
+    const [resolvedSqlQuery, resolvedOptions] = expandReferences(
+      state,
+      sqlQuery,
+      options
+    );
+    const { writeSql = false, execute: execute2 = true } = resolvedOptions;
+    if (writeSql) {
+      console.log("Prepared SQL:", resolvedSqlQuery);
+    }
+    if (!execute2) {
+      return {
+        ...state,
+        queries: [...state.queries || [], resolvedSqlQuery]
+      };
+    }
+    return new Promise((resolve, reject) => {
+      connection.query(resolvedSqlQuery, (err, results, fields2) => {
+        if (err) {
+          console.log("Error executing query. Disconnecting from database.");
+          connection.end();
+          return reject(err);
+        }
+        resolve({ ...state, response: { body: results, fields: fields2 } });
+      });
+    });
+  };
+}
 function execute(...operations) {
   const initialState = {
     references: [],
@@ -97,9 +124,9 @@ function insert(table, fields2) {
     var sqlParams = squelMysql.insert({
       autoQuoteFieldNames: true
     }).into(table).setFields(valuesObj).toParam();
-    var sql = sqlParams.text;
-    var inserts = sqlParams.values;
-    sqlString = mysql.format(sql, inserts);
+    const sql2 = sqlParams.text;
+    const inserts = sqlParams.values;
+    const sqlString = mysql.format(sql2, inserts);
     console.log(`Executing MySQL query: ${sqlString}`);
     return new Promise((resolve, reject) => {
       connection.query(sqlString, function(err, results, fields3) {
@@ -128,15 +155,15 @@ function upsert(table, fields2) {
     var insertParams = squelMysql.insert({
       autoQuoteFieldNames: true
     }).into(table).setFields(valuesObj).toParam();
-    var sql = insertParams.text;
+    var sql2 = insertParams.text;
     var inserts = insertParams.values;
-    const insertString = mysql.format(sql, inserts);
+    const insertString = mysql.format(sql2, inserts);
     var updateParams = squelMysql.update({
       autoQuoteFieldNames: true
     }).table("").setFields(valuesObj).toParam();
-    var sql = updateParams.text;
+    var sql2 = updateParams.text;
     var inserts = updateParams.values;
-    const updateString = mysql.format(sql, inserts);
+    const updateString = mysql.format(sql2, inserts);
     const upsertString = insertString + ` ON DUPLICATE KEY UPDATE ` + updateString.slice(10);
     console.log("Executing MySQL query: " + upsertString);
     return new Promise((resolve, reject) => {
@@ -192,36 +219,6 @@ function upsertMany(table, data) {
     });
   };
 }
-function query(options) {
-  return (state) => {
-    let { connection } = state;
-    const [opts] = expandReferences(state, options);
-    console.log(
-      "Executing MySQL statement with options: " + JSON.stringify(opts, 2, null)
-    );
-    return new Promise((resolve, reject) => {
-      connection.query(opts, function(err, results, fields2) {
-        if (err) {
-          reject(err);
-          console.log("That's an error. Disconnecting from database.");
-          connection.end();
-        } else {
-          console.log("Success...");
-          resolve(JSON.parse(JSON.stringify(results)));
-        }
-      });
-    }).then((data) => {
-      console.log(data);
-      const nextState = { ...state, response: { body: data } };
-      return nextState;
-    });
-  };
-}
-function sqlString(queryString) {
-  return (state) => {
-    return query({ sql: queryString })(state);
-  };
-}
 
 // src/index.js
 var src_default = Adaptor_exports;
@@ -241,13 +238,11 @@ export {
   fields,
   fn,
   fnIf,
-  http,
   insert,
   lastReferenceValue,
   merge,
-  query,
   sourceValue,
-  sqlString,
+  sql,
   upsert,
   upsertMany
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/language-mysql",
   "label": "MySQL",
-  "version": "2.2.2",
+  "version": "3.0.1",
   "description": "A MySQL Language Pack for OpenFn",
   "homepage": "https://docs.openfn.org",
   "main": "dist/index.cjs",
@@ -22,15 +22,13 @@
     "mysql": "^2.13.0",
     "squel": "^5.8.0",
     "string-escape": "^0.3.0",
-    "@openfn/language-common": "3.0.2"
+    "@openfn/language-common": "3.0.3"
   },
   "devDependencies": {
     "assertion-error": "^1.0.1",
-    "chai": "^3.4.0",
+    "chai": "^5.2.0",
     "deep-eql": "^0.1.3",
-    "nock": "^12.0.3",
-    "rimraf": "^3.0.2",
-    "sinon": "^1.17.2"
+    "rimraf": "^3.0.2"
   },
   "type": "module",
   "exports": {

package/types/Adaptor.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Execute a SQL statement. Take care when inserting values from state directly into a query,
+ * as this can be a vector for injection attacks. See [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html)
+ * for guidelines
+ * @example
+ * sql(state => `select * from ${state.data.tableName};`, { writeSql: true })
+ * @function
+ * @public
+ * @param {string|function} sqlQuery - The SQL query as a string or a function that returns a string using state.
+ * @param {object} [options] - Optional options argument.
+ * @param {boolean} [options.writeSql = false] - If true, logs the generated SQL statement. Defaults to false.
+ * @param {boolean} [options.execute = true] - If false, does not execute the SQL, just logs it and adds to state.queries. Defaults to true.
+ * @returns {Operation}
+ */
+export function sql(sqlQuery: string | Function, options?: {
+    writeSql?: boolean;
+    execute?: boolean;
+}): Operation;
 /**
  * Execute a sequence of operations.
  * Wraps `language-common/execute`, and prepends initial state for mysql.
@@ -46,24 +64,4 @@ export function upsert(table: string, fields: object): Operation;
  * @returns {Operation}
  */
 export function upsertMany(table: string, data: any[]): Operation;
-/**
- * Execute a SQL statement
- * @example <caption>Execute a SQL statement</caption>
- * query({ sql: 'select * from users;' })
- * @function
- * @public
- * @param {object} options - Payload data for the message
- * @returns {Operation}
- */
-export function query(options: object): Operation;
-/**
- * Execute a SQL statement
- * @example <caption>Execute a SQL statement</caption>
- * sqlString(state => "select * from items;")
- * @function
- * @public
- * @param {String} queryString - A query string (or function which takes state and returns a string)
- * @returns {Operation}
- */
-export function sqlString(queryString: string): Operation;
-export { fn, fnIf, each, http, merge, field, fields, cursor, dateFns, combine, dataPath, dataValue, alterState, sourceValue, arrayToString, lastReferenceValue, as } from "@openfn/language-common";
+export { fn, fnIf, each, merge, field, fields, cursor, dateFns, combine, dataPath, dataValue, alterState, sourceValue, arrayToString, lastReferenceValue, as } from "@openfn/language-common";