@saltcorn/sql 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Saltcorn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# sql
+
+Actions and views based on SQL
+
+### SQLView
+
+Use this view to create HTML code views of the results of arbitrary SQL queries
+
+1. Create a view of this type.
+2. Set output type = Table or JSON to begin with
+3. Start by creating your SQL query with no qualifiers (which will come from the URL query state). The preview table should update as you type
+4. When you are happy with the SQL query, switch to output type = HTML
+5. Create your HTML cod, use `{{ rows }}` to access rows. For instance if your query is an aggregation with a single row result (e.g. `SELECT COUNT(*) FROM...`), access this with `{{ rows[0].count }}`, for example `<h2>{{ rows[0].count }}</h2>`. You can also loop, e.g. `{{# for(const row of rows) { }}`
+6. When you are happy with both you are SQL and HTML code, Think about whether you need any parameters from the state. List these comma-separated, in order and use in the SQL code as `$1`, `$2` etc. Example SQL code: `select * from _sc_config where key = $1;`

package/index.js

@@ -0,0 +1,140 @@
+const db = require("@saltcorn/data/db");
+const Form = require("@saltcorn/data/models/form");
+const Field = require("@saltcorn/data/models/field");
+const Table = require("@saltcorn/data/models/table");
+const FieldRepeat = require("@saltcorn/data/models/fieldrepeat");
+const Workflow = require("@saltcorn/data/models/workflow");
+const { eval_expression } = require("@saltcorn/data/models/expression");
+const {
+  text,
+  div,
+  h5,
+  style,
+  a,
+  script,
+  pre,
+  domReady,
+  i,
+  text_attr,
+} = require("@saltcorn/markup/tags");
+const { mkTable } = require("@saltcorn/markup");
+const { readState } = require("@saltcorn/data/plugin-helper");
+
+const _ = require("underscore");
+
+const configuration_workflow = () =>
+  new Workflow({
+    steps: [
+      {
+        name: "views",
+        form: async (context) => {
+          return new Form({
+            fields: [
+              {
+                name: "sql",
+                label: "SQL",
+                input_type: "code",
+                attributes: { mode: "text/x-sql" },
+              },
+              {
+                name: "state_parameters",
+                label: "State parameters",
+                sublabel:
+                  "Comma separated list of state variables from URL querystring to use as SQL query parameters",
+                type: "String",
+              },
+              {
+                name: "output_type",
+                label: "Output type",
+                type: "String",
+                required: true,
+                attributes: { options: ["Table", "JSON", "HTML"] },
+              },
+              {
+                name: "html_code",
+                label: "HTML Code",
+                input_type: "code",
+                attributes: { mode: "text/html" },
+                showIf: { output_type: "HTML" },
+              },
+              {
+                input_type: "section_header",
+                label: " ",
+                sublabel: div(
+                  "Use handlebars to access query result in the <code>rows</code> variable. Example: <code>{{#each rows}}&lt;h1&gt;{{this.name}}&lt;/h1&gt;{{/each}}</code>"
+                ),
+                showIf: { row_count: "Many" },
+              },
+            ],
+          });
+        },
+      },
+    ],
+  });
+
+const get_state_fields = () => [];
+
+const run = async (
+  table_id,
+  viewname,
+  { sql, output_type, state_parameters, html_code },
+  state,
+  extraArgs
+) => {
+  const is_sqlite = db.isSQLite;
+
+  const phValues = [];
+  (state_parameters || "")
+    .split(",")
+    .filter((s) => s)
+    .forEach((sp0) => {
+      const sp = sp0.trim();
+      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;`);
+  }
+  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 || "", {
+        evaluate: /\{\{#(.+?)\}\}/g,
+        interpolate: /\{\{([^#].+?)\}\}/g,
+      });
+
+      return template({ rows: qres.rows });
+
+    case "JSON":
+      return `<pre>${JSON.stringify(qres.rows, null, 2)}</pre>`;
+
+    default: //Table
+      return mkTable(
+        qres.fields.map((field) => ({ label: field.name, key: field.name })),
+        qres.rows
+      );
+  }
+};
+
+module.exports = {
+  sc_plugin_api_version: 1,
+  plugin_name: "sql",
+  viewtemplates: [
+    {
+      name: "SQLView",
+      display_state_form: false,
+      tableless: true,
+      get_state_fields,
+      configuration_workflow,
+      run,
+    },
+  ],
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@saltcorn/sql",
+  "version": "0.1.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"
+  },
+  "author": "Tom Nielsen",
+  "license": "MIT",
+  "eslintConfig": {
+    "extends": "eslint:recommended",
+    "parserOptions": {
+      "ecmaVersion": 2020
+    },
+    "env": {
+      "node": true,
+      "es6": true
+    },
+    "rules": {
+      "no-unused-vars": "off",
+      "no-case-declarations": "off",
+      "no-empty": "warn",
+      "no-fallthrough": "warn"
+    }
+  }
+}