@saltcorn/sql 0.4.3 → 0.5.0

package/agent-skill.js

@@ -0,0 +1,116 @@
+const { div, pre, a } = require("@saltcorn/markup/tags");
+const Workflow = require("@saltcorn/data/models/workflow");
+const Form = require("@saltcorn/data/models/form");
+const Table = require("@saltcorn/data/models/table");
+const View = require("@saltcorn/data/models/view");
+const Trigger = require("@saltcorn/data/models/trigger");
+const { getState } = require("@saltcorn/data/db/state");
+const db = require("@saltcorn/data/db");
+const { eval_expression } = require("@saltcorn/data/models/expression");
+const { interpolate } = require("@saltcorn/data/utils");
+
+//const { fieldProperties } = require("./helpers");
+
+class SQLQuerySkill {
+  static skill_name = "SQL query";
+
+  get skill_label() {
+    return "SQL Query";
+  }
+
+  constructor(cfg) {
+    Object.assign(this, cfg);
+  }
+
+  async runQuery({ triggering_row, user }) {
+    const row = triggering_row;
+    const read_only = true;
+    const is_sqlite = db.isSQLite;
+
+    const phValues = [];
+    (this.query_parameters || "")
+      .split(",")
+      .filter((s) => s)
+      .forEach((sp0) => {
+        const sp = sp0.trim();
+        if (sp.startsWith("user.")) {
+          phValues.push(eval_expression(sp, {}, user));
+        } else if (typeof row[sp] === "undefined") phValues.push(null);
+        else phValues.push(row[sp]);
+      });
+
+    const client = is_sqlite ? db : await db.getClient();
+    await client.query(`BEGIN;`);
+    if (!is_sqlite) {
+      await client.query(`SET LOCAL search_path TO "${db.getTenantSchema()}";`);
+      if (read_only)
+        await client.query(
+          `SET SESSION CHARACTERISTICS AS TRANSACTION READ ONLY;`
+        );
+    }
+    const qres = await client.query(this.sql, phValues);
+
+    await client.query(`COMMIT;`);
+
+    if (!is_sqlite) client.release(true);
+
+    if (this.row_format) {
+      return qres.rows
+        .map((r) => interpolate(this.row_format, r, user))
+        .join("\n\n");
+    }
+    return JSON.stringify(qres.rows);
+  }
+
+  async systemPrompt({ triggering_row, user }) {
+    if (this.mode === "Preload into system prompt") {
+      const rows = await this.runQuery({ triggering_row, user });
+      return `${this.add_sys_prompt}: ${rows}`;
+    }
+    return `${this.add_sys_prompt}`;
+  }
+
+  static async configFields() {
+    return [
+      {
+        name: "mode",
+        label: "Mode",
+        type: "String",
+        required: true,
+        attributes: { options: [/*"Tool",*/ "Preload into system prompt"] },
+      },
+      {
+        name: "sql",
+        label: "SQL",
+        input_type: "code",
+        attributes: { mode: "text/x-sql" },
+        sublabel:
+          "Refer to row parameters in the order below with <code>$1</code>, <code>$2</code> etc",
+      },
+      {
+        name: "query_parameters",
+        label: "Query parameters",
+        sublabel:
+          "Comma separated list of variables to use as SQL query parameters. User variables can be used as <code>user.id</code> etc",
+        type: "String",
+        //showIf: { mode: "Tool" },
+      },
+      {
+        name: "add_sys_prompt",
+        label: "Additional prompt",
+        type: "String",
+        fieldview: "textarea",
+      },
+      {
+        name: "row_format",
+        label: "Row format",
+        type: "String",
+        fieldview: "textarea",
+        sublabel:
+          "Format of text to send to LLM, use <code>{{ }}</code> to access row fields. If not set, rows will be sent as JSON",
+      },
+    ];
+  }
+}
+
+module.exports = SQLQuerySkill;

package/index.js

@@ -96,18 +96,23 @@ const run = async (
       } else if (typeof state[sp] === "undefined") phValues.push(null);
       else phValues.push(state[sp]);
     });
-
-  const client = is_sqlite ? db : await db.getClient();
-  await client.query(`BEGIN;`);
-  if (!is_sqlite) {
-    await client.query(`SET LOCAL search_path TO "${db.getTenantSchema()}";`);
-    await client.query(`SET SESSION CHARACTERISTICS AS TRANSACTION READ ONLY;`);
+  let qres, client;
+  try {
+    client = is_sqlite ? db : await db.getClient();
+    await client.query(`BEGIN;`);
+    if (!is_sqlite) {
+      await client.query(`SET LOCAL search_path TO "${db.getTenantSchema()}";`);
+      await client.query(
+        `SET SESSION CHARACTERISTICS AS TRANSACTION READ ONLY;`
+      );
+    }
+    qres = await client.query(sql, phValues);
+  } catch (e) {
+    throw e;
+  } finally {
+    await client.query(`ROLLBACK;`);
+    if (!is_sqlite) client.release(true);
   }
-  const qres = await client.query(sql, phValues);
-
-  await client.query(`ROLLBACK;`);
-
-  if (!is_sqlite) client.release(true);
   switch (output_type) {
     case "HTML":
       const template = _.template(html_code || "", {
@@ -133,6 +138,9 @@ module.exports = {
   plugin_name: "sql",
   actions: require("./action.js"),
   table_providers: require("./table-provider.js"),
+  exchange: {
+    agent_skills: [require("./agent-skill.js")],
+  },
   functions: {
     sqlQuery: {
       run: async (query, parameters) => {

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@saltcorn/sql",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "Actions and views based on SQL",
   "main": "index.js",
   "dependencies": {
     "@saltcorn/markup": "^0.6.0",
     "@saltcorn/data": "^0.6.0",
     "underscore": "1.13.6",
-    "node-sql-parser": "4.0.8",
+    "node-sql-parser": "5.3.10",
     "sqlstring": "^2.3.3"
   },
   "author": "Tom Nielsen",
@@ -15,7 +15,7 @@
   "eslintConfig": {
     "extends": "eslint:recommended",
     "parserOptions": {
-      "ecmaVersion": 2020
+      "ecmaVersion": 2022
     },
     "env": {
       "node": true,