@saltcorn/data 1.6.0-beta.7 → 1.6.0-beta.9

package/dist/base-plugin/actions.js

@@ -279,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
@@ -338,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",
@@ -443,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",
@@ -455,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
                     ? [
@@ -495,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" },
@@ -1087,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 } : {}),
                     },
                 },
             ];
@@ -1137,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 [
                 {
@@ -1151,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"
@@ -1233,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",
@@ -1244,6 +1291,9 @@ module.exports = {
                         mode: "application/javascript",
                         compact: true,
                         expression_type: "row",
+                        table: table?.name,
+                        nojoins: true,
+                        user: true,
                     },
                 },
                 ...(mode === "edit" ||
@@ -1334,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"
@@ -1357,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 },
                 },
             ];
@@ -1373,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;
@@ -1392,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 [
@@ -1420,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",
@@ -1438,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",
@@ -1551,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 }) => {
@@ -1684,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",
@@ -2173,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 [
                 {
@@ -2187,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",
@@ -2232,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 },
             },
             {
@@ -2253,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",
@@ -2330,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",
             },
         ],
         /**