@saltcorn/data 1.6.0-alpha.9 → 1.6.0-beta.10

package/dist/base-plugin/actions.js

@@ -9,7 +9,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 const fetch = require("node-fetch");
-const vm = require("vm");
+const { VM } = require("vm2");
+const oldVm = require("vm");
 const table_1 = __importDefault(require("../models/table"));
 const eventlog_1 = __importDefault(require("../models/eventlog"));
 const view_1 = __importDefault(require("../models/view"));
@@ -31,6 +32,7 @@ const db = require("../db");
 const { isNode, isWeb, ppVal, getFetchProxyOptions } = require("../utils");
 const { available_languages } = require("../models/config");
 const MetaData = require("../models/metadata");
+const assert_1 = require("assert");
 //action use cases: field modify, like/rate (insert join), notify, send row to webhook
 // todo add translation
 const consoleInterceptor = (state) => {
@@ -60,11 +62,13 @@ const emit_to_client = (user) => (data, userIds) => {
     }
     const safeIds = Array.isArray(userIds)
         ? userIds
-        : userIds
-            ? [userIds]
-            : user?.id
-                ? [user.id]
-                : [];
+        : userIds === null
+            ? null
+            : userIds
+                ? [userIds]
+                : user?.id
+                    ? [user.id]
+                    : [];
     state.emitDynamicUpdate(db.getTenantSchema(), data, safeIds);
 };
 /**
@@ -77,7 +81,23 @@ const emit_to_client = (user) => (data, userIds) => {
  * @param opts.rest
  * @returns
  */
-const run_code = async ({ row, table, channel, configuration: { code, run_where }, user, ...rest }) => {
+const run_code = async ({ row, table, channel, configuration, user, ...rest }) => {
+    let stripTypes = (s) => s;
+    let code;
+    try {
+        const { stripTypeScriptTypes } = require("module");
+        if (stripTypeScriptTypes)
+            stripTypes = stripTypeScriptTypes;
+        code = stripTypes(`async () =>{${configuration.code}
+}`)
+            .replace("async () =>{", "")
+            .slice(0, -2);
+    }
+    catch (e) {
+        //console.error("strip error", e);
+        code = configuration.code;
+    }
+    const run_where = configuration.run_where;
     if (run_where === "Client page")
         return {
             eval_js: code,
@@ -139,7 +159,6 @@ const run_code = async ({ row, table, channel, configuration: { code, run_where
     const emitEvent = (eventType, channel, payload) => trigger_1.default.emitEvent(eventType, channel, user, payload);
     const fetchJSON = async (...args) => await (await fetch(...args)).json();
     const sysState = getState();
-    const require = (nm) => sysState.codeNPMmodules[nm];
     const refreshSystemCache = async (which) => {
         //this worker
         if (which)
@@ -156,7 +175,7 @@ const run_code = async ({ row, table, channel, configuration: { code, run_where
                 await getState().refresh(false);
         });
     };
-    const f = vm.runInNewContext(`async () => {${code}\n}`, {
+    const sandbox = {
         Table: table_1.default,
         table,
         row,
@@ -171,6 +190,7 @@ const run_code = async ({ row, table, channel, configuration: { code, run_where
         fetch,
         emit_to_client: emit_to_client(user),
         run_js_code,
+        ...(isNode() ? { assert: assert_1.strict } : {}),
         tryCatchInTransaction: db.tryCatchInTransaction,
         commitAndBeginNewTransaction: db.commitAndBeginNewTransaction,
         commitBeginNewTransactionAndRefreshCache: async () => {
@@ -190,7 +210,7 @@ const run_code = async ({ row, table, channel, configuration: { code, run_where
         WorkflowRun: workflow_run_1.default,
         setTimeout,
         interpolate,
-        require,
+        require: (nm) => sysState.codeNPMmodules[nm],
         refreshSystemCache,
         setConfig: (k, v) => sysState.isFixedConfig(k) ? undefined : sysState.setConfig(k, v),
         getConfig: (k) => sysState.isFixedConfig(k) ? undefined : sysState.getConfig(k),
@@ -202,8 +222,24 @@ const run_code = async ({ row, table, channel, configuration: { code, run_where
         ...(row || {}),
         ...getState().eval_context,
         ...rest,
-    });
-    return await f();
+    };
+    if (isNode()) {
+        const vm2 = new VM({ sandbox, eval: false, wasm: false });
+        const result = await vm2.run(`(async () => {${code}\n})()`);
+        if (result === null || result === undefined || typeof result !== "object")
+            return result;
+        try {
+            return JSON.parse(JSON.stringify(result));
+        }
+        catch {
+            return result;
+        }
+    }
+    else {
+        // on mobile, vm2 is not available
+        const f = oldVm.runInNewContext(`async () => {${code}\n}`, sandbox);
+        return await f();
+    }
 };
 module.exports = {
     /**
@@ -243,28 +279,64 @@ module.exports = {
          * @returns {object[]}
          */
         description: "Emit an event",
-        configFields: () => [
-            {
-                name: "eventType",
-                label: "Event type",
-                required: true,
-                input_type: "select",
-                options: trigger_1.default.when_options,
-            },
-            {
-                name: "channel",
-                label: "Channel",
-                type: "String",
-                fieldview: "textarea",
-            },
-            {
-                name: "payload",
-                label: "Payload JSON",
-                sublabel: "Leave blank to use row from table",
-                type: "String",
-                fieldview: "textarea",
-            },
-        ],
+        configFields: async ({ table }) => {
+            const evTypes = trigger_1.default.when_options;
+            const hasChannel = [];
+            const hasTable = [];
+            evTypes.forEach((ty) => {
+                if (eventlog_1.default.hasChannel(ty))
+                    hasChannel.push(ty);
+                if (eventlog_1.default.hasTable(ty))
+                    hasTable.push(ty);
+            });
+            const allTables = await table_1.default.find({}, { cached: true });
+            return [
+                {
+                    name: "eventType",
+                    label: "Event type",
+                    required: true,
+                    input_type: "select",
+                    options: evTypes,
+                },
+                {
+                    name: "channel",
+                    label: "Channel",
+                    type: "String",
+                    showIf: { eventType: hasChannel },
+                    help: {
+                        topic: "Event channel and payload",
+                    },
+                },
+                {
+                    name: "channel",
+                    label: "Table",
+                    type: "String",
+                    showIf: { eventType: hasTable },
+                    required: true,
+                    attributes: { options: allTables.map((t) => t.name) },
+                    help: {
+                        topic: "Event channel and payload",
+                    },
+                },
+                {
+                    name: "payload",
+                    label: "Payload JSON",
+                    sublabel: `Leave blank to use row from table. <code>user</code> ${table ? `and field variables ` : ""}in scope`,
+                    input_type: "code",
+                    attributes: {
+                        mode: "application/javascript",
+                        compact: true,
+                        expression_type: "row",
+                        table: table?.name,
+                        nojoins: true,
+                        user: true,
+                    },
+                    help: {
+                        topic: "Event channel and payload",
+                    },
+                },
+            ];
+        },
         /**
          * @param {object} opts
          * @param {object} opts.row
@@ -273,7 +345,7 @@ module.exports = {
          * @returns {Promise<void>}
          */
         run: async ({ row, configuration: { eventType, channel, payload }, user, }) => {
-            return await trigger_1.default.emitEvent(eventType, channel, user, payload ? JSON.parse(payload) : row);
+            return await trigger_1.default.emitEvent(eventType, channel, user, payload ? eval_expression(payload, row || {}, user) : row);
         },
         namespace: "Control",
     },
@@ -302,7 +374,7 @@ module.exports = {
                 {
                     name: "where",
                     label: "Where",
-                    sublabel: "Where-expression for subset of rows to loop over",
+                    sublabel: `Where-expression for subset of rows to loop over. For example: <code>{status: "Active"}</code>`,
                     input_type: "code",
                     attributes: {
                         mode: "application/javascript",
@@ -407,7 +479,7 @@ module.exports = {
                     name: "url",
                     label: "URL",
                     type: "String",
-                    sublabel: "Trigger will call specified URL",
+                    sublabel: "Trigger will call specified URL. Interpolations <code>{{ }}</code> can be used",
                 },
                 {
                     name: "method",
@@ -419,16 +491,23 @@ module.exports = {
                 {
                     name: "body",
                     label: "JSON body",
-                    sublabel: "Leave blank to use row from table",
-                    type: "String",
-                    fieldview: "textarea",
                     showIf: { method: ["POST", "PUT", "DELETE", "PATCH"] },
+                    sublabel: `Leave blank to use row from table.${table ? ` <code>user</code> and field variables in scope` : ""}`,
+                    input_type: "code",
+                    attributes: {
+                        mode: "application/javascript",
+                        compact: true,
+                        expression_type: "row",
+                        table: table?.name,
+                        nojoins: true,
+                        user: true,
+                    },
                 },
                 {
                     name: "authorization",
                     label: "Authorization header",
                     type: "String",
-                    sublabel: "For example <code>Bearer xxxx</code>",
+                    sublabel: "For example <code>Bearer xxxx</code>. Interpolations <code>{{ }}</code> can be used",
                 },
                 ...(field_opts.length
                     ? [
@@ -459,7 +538,7 @@ module.exports = {
          * @returns {Promise<object>}
          */
         run: async ({ row, user, table, configuration: { url, body, authorization, response_field, response_var, method, }, }) => {
-            let url1 = interpolate(url, row, user, "Webhook URL");
+            let url1 = interpolate(url, row || {}, user, "Webhook URL");
             const fetchOpts = {
                 method: (method || "post").toLowerCase(),
                 headers: { "Content-Type": "application/json" },
@@ -1051,12 +1130,13 @@ module.exports = {
                 {
                     name: "where",
                     label: "Recalculate where",
-                    sublabel: "Where-expression for subset of rows to recalculate",
+                    sublabel: "Where-expression for subset of rows to recalculate. Example: <code>{manager: id}</code>",
                     input_type: "code",
                     attributes: {
                         mode: "application/javascript",
                         singleline: true,
                         expression_type: "query",
+                        ...(table ? { table: table.name } : {}),
                     },
                 },
             ];
@@ -1101,7 +1181,7 @@ module.exports = {
          * @returns {Promise<object[]>}
          */
         description: "insert a row into any table, using a formula expression",
-        configFields: async ({ mode }) => {
+        configFields: async ({ mode, table }) => {
             const tables = await table_1.default.find({}, { cached: true });
             return [
                 {
@@ -1115,11 +1195,14 @@ module.exports = {
                     name: "row_expr",
                     label: "Row expression",
                     sublabel: "Expression for JavaScript object or array of objects. Example: <code>{first_name: name.split(' ')[0]}</code>",
-                    type: "String",
-                    fieldview: "textarea",
-                    class: "validate-expression",
+                    input_type: "code",
                     attributes: {
-                        spellcheck: false,
+                        mode: "application/javascript",
+                        compact: true,
+                        expression_type: "row",
+                        table: table?.name,
+                        nojoins: true,
+                        user: true,
                     },
                 },
                 ...(mode === "workflow"
@@ -1197,7 +1280,7 @@ module.exports = {
      */
     modify_row: {
         description: "Modify the triggering row",
-        configFields: async ({ mode, when_trigger, }) => {
+        configFields: async ({ mode, when_trigger, table, }) => {
             return [
                 {
                     name: "row_expr",
@@ -1208,6 +1291,9 @@ module.exports = {
                         mode: "application/javascript",
                         compact: true,
                         expression_type: "row",
+                        table: table?.name,
+                        nojoins: true,
+                        user: true,
                     },
                 },
                 ...(mode === "edit" ||
@@ -1298,7 +1384,7 @@ module.exports = {
          * @returns {Promise<object[]>}
          */
         description: "Modify the triggering row",
-        configFields: async ({ mode, when_trigger }) => {
+        configFields: async ({ mode, table, when_trigger }) => {
             const tables = await table_1.default.find({}, { cached: true });
             return [
                 ...(mode === "workflow"
@@ -1321,10 +1407,15 @@ module.exports = {
                 {
                     name: "delete_where",
                     label: "Delete where",
-                    type: "String",
+                    input_type: "code",
+                    attributes: {
+                        mode: "application/javascript",
+                        singleline: true,
+                        expression_type: "query",
+                        ...(table ? { table: table.name } : {}),
+                    },
                     sublabel: "Where expression, ex. <code>{manager: id}</code>",
                     required: true,
-                    class: "validate-expression",
                     showIf: mode === "workflow" ? undefined : { delete_triggering_row: false },
                 },
             ];
@@ -1337,7 +1428,7 @@ module.exports = {
                 await table.deleteRows({ [table.pk_name]: row[table.pk_name] }, user, false, resultCollector);
                 return resultCollector;
             }
-            const where = eval_expression(delete_where, row || {}, user, "recalculate_stored_fields where");
+            const where = eval_expression(delete_where, row || {}, user, "delete_rows where");
             const tbl = table_1.default.findOne({ name: table_name });
             await tbl.deleteRows(where, user, false, resultCollector);
             return resultCollector;
@@ -1356,7 +1447,7 @@ module.exports = {
          * @returns {Promise<object[]>}
          */
         description: "Navigation action",
-        configFields: async () => {
+        configFields: async ({ table }) => {
             const pages = await page_1.default.find({}, { cached: true });
             const views = await view_1.default.find({}, { cached: true });
             return [
@@ -1384,6 +1475,7 @@ module.exports = {
                     type: "String",
                     required: true,
                     showIf: { nav_action: ["Go to URL", "Popup modal"] },
+                    sublabel: "Use interpolations <code>{{ }}</code> to access row variables",
                 },
                 {
                     name: "page",
@@ -1402,9 +1494,20 @@ module.exports = {
                 {
                     name: "state_formula",
                     label: "State",
-                    type: "String",
-                    class: "validate-expression",
+                    input_type: "code",
+                    attributes: {
+                        mode: "application/javascript",
+                        singleline: true,
+                        expression_type: "query",
+                        ...(table ? { table: table.name } : {}),
+                    },
                     showIf: { nav_action: ["Go to Page", "Go to View"] },
+                    sublabel: `Additional state passed to the page. Example: <code>{id: 5}</code>`,
+                    help: {
+                        topic: "Extra state formula",
+                        context: table ? { srcTable: table.name } : {},
+                        dynContext: ["view"],
+                    },
                 },
                 {
                     name: "new_tab",
@@ -1515,18 +1618,26 @@ module.exports = {
             {
                 name: "form_action",
                 label: "Form Action",
-                type: "String",
+                input_type: "select",
                 required: true,
                 attributes: {
-                    options: [
-                        "RequestSubmit",
-                        "Submit",
-                        "Save",
-                        "Reset",
-                        "Submit with Ajax",
-                        "Ajax Save Form Data",
-                    ],
+                    explainers: {
+                        RequestSubmit: "Validate the form, and submit if no errors, or display errors",
+                        Submit: "Submit the form, skipping validation",
+                        Save: "Save the form contents on the server, stay on the form page",
+                        Reset: "Reset the form to the state it was in at page load time",
+                        "Submit with Ajax": "Submit the form with Ajax and follow the set destination if there are no errors",
+                        "Ajax Save Form Data": "Submit the form with Ajax and close the open popup ",
+                    },
                 },
+                options: [
+                    "RequestSubmit",
+                    "Submit",
+                    "Save",
+                    "Reset",
+                    "Submit with Ajax",
+                    "Ajax Save Form Data",
+                ],
             },
         ],
         run: async ({ row, table, user, req, configuration: { form_action }, ...rest }) => {
@@ -1648,12 +1759,13 @@ module.exports = {
                 label: "Text",
                 type: "String",
                 required: true,
+                sublabel: "Interpolations <code>{{ }}</code> can be used",
             },
             {
                 name: "title",
                 label: "Title",
-                sublabel: "Optional",
                 type: "String",
+                sublabel: "Optional. Interpolations <code>{{ }}</code> can be used",
             },
             {
                 name: "remove_delay",
@@ -1745,15 +1857,23 @@ module.exports = {
                         table: table?.name || undefined,
                         user: has_user,
                         workflow: mode === "workflow",
+                        nojoins: true,
                     },
-                    class: [
-                        "validate-statements",
-                        mode !== "workflow" && "enlarge-in-card",
-                    ],
+                    class: `validate-statements strip-types ${mode !== "workflow" ? "enlarge-in-card" : ""}`,
                     validator(s) {
+                        let stripTypes = (s) => s;
+                        try {
+                            const { stripTypeScriptTypes } = require("module");
+                            if (stripTypeScriptTypes)
+                                stripTypes = stripTypeScriptTypes;
+                        }
+                        catch (e) {
+                            //ignore
+                        }
                         try {
                             let AsyncFunction = Object.getPrototypeOf(async function () { }).constructor;
-                            AsyncFunction(s);
+                            AsyncFunction(stripTypes(`async () =>{${s}
+}`));
                             return true;
                         }
                         catch (e) {
@@ -1894,7 +2014,7 @@ module.exports = {
             const views = await view_1.default.find_table_views_where(table, ({ viewtemplate, viewrow, state_fields }) => viewrow.viewtemplate === "Edit");
             const fldOpts = fields.map((f) => ({
                 label: f.name,
-                name: f.name,
+                name: `_prefill_${f.name}`,
                 default: f.name !== "id",
                 type: "Bool",
             }));
@@ -1912,9 +2032,12 @@ module.exports = {
         requireRow: true,
         run: async ({ row, table, configuration: { viewname, ...flds }, user, }) => {
             const qs = Object.entries(flds)
-                .map(([k, v]) => v && typeof row[k] !== "undefined"
-                ? `${encodeURIComponent(k)}=${encodeURIComponent(row[k])}`
-                : false)
+                .map(([prefill_k, v]) => {
+                const k = prefill_k.replace("_prefill_", "");
+                return v && typeof row[k] !== "undefined"
+                    ? `${encodeURIComponent(k)}=${encodeURIComponent(row[k])}`
+                    : false;
+            })
                 .filter((s) => s)
                 .join("&");
             return { goto: `/view/${viewname}?${qs}` };
@@ -2126,7 +2249,7 @@ module.exports = {
     },
     reload_embedded_view: {
         description: "Reload an embedded view without full page reload",
-        configFields: async () => {
+        configFields: async ({ table }) => {
             const views = await view_1.default.find({});
             return [
                 {
@@ -2140,8 +2263,19 @@ module.exports = {
                 {
                     name: "new_state_fml",
                     label: "New state formula",
-                    type: "String",
-                    class: "validate-expression",
+                    input_type: "code",
+                    attributes: {
+                        mode: "application/javascript",
+                        singleline: true,
+                        expression_type: "row",
+                        ...(table ? { table: table.name } : {}),
+                    },
+                    sublabel: `Optional. Updated view state. Example: <code>{id: 5}</code>. Leave blank to keep existing state`,
+                    help: {
+                        topic: "Extra state formula",
+                        context: table ? { srcTable: table.name } : {},
+                        dynContext: ["view"],
+                    },
                 },
                 {
                     name: "interval",
@@ -2185,7 +2319,7 @@ module.exports = {
                 type: "String",
                 class: "validate-identifier",
                 required: true,
-                sublabel: "A valid JavaScript identifier for updating existing progress toasts",
+                sublabel: "A valid JavaScript identifier for updating existing progress toasts. Interpolations <code>{{ }}</code> can be used",
                 showIf: { blocking: false },
             },
             {
@@ -2206,12 +2340,14 @@ module.exports = {
                 label: "Title",
                 type: "String",
                 showIf: { close: false },
+                sublabel: "Use interpolations <code>{{ }}</code> to access row variables",
             },
             {
                 name: "message",
                 label: "Message",
                 type: "String",
                 showIf: { close: false },
+                sublabel: "Use interpolations <code>{{ }}</code> to access row variables",
             },
             {
                 name: "percent",
@@ -2283,27 +2419,31 @@ module.exports = {
     },
     notify_user: {
         description: "Send a notification to a specific user",
-        configFields: () => [
+        configFields: ({ table }) => [
             {
                 name: "user_spec",
                 label: "User where or email",
                 type: "String",
+                sublabel: `Valid input: <code>*</code> for all, a valid email address, or a where object, e.g. <code>{department: "Finance"}</code>${table ? ". Row values are in scope for where object." : ""}`,
             },
             {
                 name: "title",
                 label: "Title",
                 required: true,
                 type: "String",
+                sublabel: "<code>{{ }}</code> interpolations usable",
             },
             {
                 name: "body",
                 label: "Body",
                 type: "String",
+                sublabel: "<code>{{ }}</code> interpolations usable",
             },
             {
                 name: "link",
                 label: "Link",
                 type: "String",
+                sublabel: "<code>{{ }}</code> interpolations usable",
             },
         ],
         /**