@saltcorn/data 1.3.1-beta.8 → 1.3.1

package/dist/base-plugin/viewtemplates/edit.d.ts

@@ -31,7 +31,7 @@ export function run(table_id: number, viewname: string, cfg: any, state: string,
  * @param {object} extra
  * @returns {Promise<Form[]>}
  */
-export function runMany(table_id: number, viewname: string, { columns, layout, auto_save, split_paste, confirm_leave }: {
+export function runMany(table_id: number, viewname: string, { columns, layout, auto_save, split_paste, confirm_leave, enable_realtime, update_events, }: {
     columns: any;
     layout: any;
 }, state: State, extra: object, { editManyQuery, getRowQuery, optionsQuery }: {
@@ -110,8 +110,9 @@ export function authorise_post({ body, table_id, req }: {
 }, { authorizePostQuery }: {
     authorizePostQuery: any;
 }): Promise<boolean>;
-export function virtual_triggers(table_id: any, viewname: any, { enable_realtime }: {
+export function virtual_triggers(table_id: any, viewname: any, { enable_realtime, update_events }: {
     enable_realtime: any;
+    update_events: any;
 }): {
     when_trigger: string;
     table_id: any;
@@ -172,7 +173,7 @@ export declare let name: string;
 export declare let description: string;
 export declare function authorise_get({ query, table_id, req }: {
     query: object;
-    rest: any;
+    rest: any[];
 }, { authorizeGetQuery }: {
     authorizeGetQuery: any;
 }): Promise<boolean>;
@@ -184,7 +185,7 @@ export declare function authorise_get({ query, table_id, req }: {
 export declare function getStringsForI18n({ layout }: {
     layout: Layout;
 }): string[];
-export declare function queries({ table_id, name, configuration: { columns, default_state, layout, auto_save, split_paste, destination_type, fixed, confirm_leave, auto_create, delete_unchanged_auto_create, enable_realtime, }, req, res, }: {
+export declare function queries({ table_id, name, configuration: { columns, default_state, layout, auto_save, split_paste, destination_type, fixed, confirm_leave, auto_create, delete_unchanged_auto_create, enable_realtime, update_events, }, req, res, }: {
     table_id: any;
     name: any;
     configuration: {
@@ -199,6 +200,7 @@ export declare function queries({ table_id, name, configuration: { columns, defa
         auto_create: any;
         delete_unchanged_auto_create: any;
         enable_realtime: any;
+        update_events: any;
     };
     req: any;
     res: any;

package/dist/base-plugin/viewtemplates/edit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../../base-plugin/viewtemplates/edit.js"],"names":[],"mappings":"AA8FA;;;GAGG;AAEH,4CAJW,MAAM,GACJ,QAAQ,CAwXjB;AA+CJ;;;;;;;;;;;GAWG;AACH,8BAXW,MAAM,YACN,MAAM,mBAIN,MAAM;IAEU,GAAG,EAAnB,MAAM;IACU,GAAG,EAAnB,MAAM;;;IACJ,QAAQ,IAAI,CAAC,CAYzB;AAED;;;;;;;;;GASG;AACH,kCATW,MAAM,YACN,MAAM;IAEE,OAAO;IACP,MAAM;wBAEd,MAAM;;;;IACJ,QAAQ,IAAI,EAAE,CAAC,CA0C3B;AA4qBD;;;;;;;;;;;;;;;;GAgBG;AACH,kCAhBW,MAAM,YACN,MAAM;IAEY,OAAO,EAAzB,MAAM,EAAE;IACQ,MAAM;IACN,KAAK,EAArB,MAAM;IACW,cAAc,EAA/B,OAAO;IACW,oBAAoB,EAAtC,MAAM,EAAE;UACR,MAAM;IAGU,GAAG,EAAnB,MAAM;IACU,GAAG,EAAnB,MAAM;IACU,QAAQ,EAAxB,MAAM;;;;;;;;;iBACJ,QAAQ,IAAI,CAAC,CAmUzB;AA0FD,mKA6BC;AAGD,sHA6BC;AA5wCD;;;;;;GAMG;AACH;IAHmB,OAAO;IACb,QAAQ,MAAM,EAAE,CAAC,CAQ7B;AA6BD,uBAAuB;AACvB,sCAAuD;AAwsDvD;;;;;;iBAwGC;AA1pBD;;;;;;GAMG;AACH;IALwB,IAAI,EAAjB,MAAM;IACO,QAAQ,EAArB,MAAM;IACO,GAAG,EAAhB,MAAM;;;IACJ,QAAQ,OAAO,CAAC,CAO5B;AAgpBD;;;;;;;;;IAyDC;;;;AAxoBD;;;;;;;;;;;GAWG;AACH,sCAXW,MAAM;IAGS,OAAO,EAAtB,MAAM,EAAE;IACA,MAAM;;IAGE,GAAG,EAAnB,MAAM;IACK,GAAG;;;IACZ,QAAQ,MAAM,CAAC,CAe3B;AAED;;;;;;;;;;;;;;;;;;;;;;kBA0GC;;yBAsgBY,MAAM;gCAEN,MAAM;AAmBF;;;;;qBAEd;AACD;;;;GAIG;AACH;;aAEC;AACQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmcP;;;;;AAEF,yGAkBC;AACY;;;GA2DZ;AACiB,6HAEjB"}
+{"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../../base-plugin/viewtemplates/edit.js"],"names":[],"mappings":"AA+FA;;;GAGG;AAEH,4CAJW,MAAM,GACJ,QAAQ,CA4YjB;AA+CJ;;;;;;;;;;;GAWG;AACH,8BAXW,MAAM,YACN,MAAM,mBAIN,MAAM,4CAEd;IAAwB,GAAG,EAAnB,MAAM;IACU,GAAG,EAAnB,MAAM;CACd;;IAAU,OAAO,CAAC,IAAI,CAAC,CAYzB;AAED;;;;;;;;;GASG;AACH,kCATW,MAAM,YACN,MAAM,+FAEd;IAAgB,OAAO,EAAf,GAAC;IACO,MAAM,EAAd,GAAC;CACT,SAAQ,KAAK,SACL,MAAM;;;;IACJ,OAAO,CAAC,IAAI,EAAE,CAAC,CAoD3B;AAwsBD;;;;;;;;;;;;;;;;GAgBG;AACH,kCAhBW,MAAM,YACN,MAAM,0JAEd;IAA0B,OAAO,EAAzB,MAAM,EAAE;IACQ,MAAM,EAAtB,MAAM;IACU,KAAK,EAArB,MAAM;IACW,cAAc,EAA/B,OAAO;IACW,oBAAoB,EAAtC,MAAM,EAAE;CAChB,SAAQ,MAAM,QACN,GAAC,0BAET;IAAwB,GAAG,EAAnB,MAAM;IACU,GAAG,EAAnB,MAAM;IACU,QAAQ,EAAxB,MAAM;CACd;;;;;;;;iBAAU,OAAO,CAAC,IAAI,CAAC,CAmUzB;AA0FD,mKA6BC;AAGD,sHA6BC;AAlzCD;;;;;;GAMG;AACH,2CANW,GAAC,YACD,GAAC,eAET;IAAgB,OAAO,EAAf,GAAC;CACT,GAAU,OAAO,CAAC,MAAM,EAAE,CAAC,CAQ7B;AA6BD,uBAAuB;AACvB,sCAAuD;AA8uDvD;;;;;;iBAwGC;AA1pBD;;;;;;GAMG;AACH,wDALG;IAAqB,IAAI,EAAjB,MAAM;IACO,QAAQ,EAArB,MAAM;IACO,GAAG,EAAhB,MAAM;CACd;;IAAU,OAAO,CAAC,OAAO,CAAC,CAO5B;AAgpBD;;;;;;;;;;IAmEC;;;;AAlpBD;;;;;;;;;;;GAWG;AACH,sCAXW,MAAM,YACN,GAAC,uBAET;IAAuB,OAAO,EAAtB,MAAM,EAAE;IACA,MAAM,EAAd,GAAC;CACT,QAAQ,GAAC,gBAET;IAAwB,GAAG,EAAnB,MAAM;IACK,GAAG,EAAd,GAAC;CACT;;IAAU,OAAO,CAAC,MAAM,CAAC,CAe3B;AAED;;;;;;;;;;;;;;;;;;;;;;kBA0GC;;yBAghBY,MAAM;gCAEN,MAAM;AAmBF,gEAJZ;IAAqB,KAAK,EAAlB,MAAM;IACK,IAAI,EAAZ,GAAC,EAAA;CACZ;;IAAU,OAAO,CAAC,OAAO,CAAC,CAI5B;AACD;;;;GAIG;AACH,sDAHG;IAAqB,MAAM,EAAnB,MAAM;CACd,GAAU,MAAM,EAAE,CAIpB;AACQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqcP;;;;;AAEF,yGAkBC;AACY;;;GA2DZ;AACiB,6HAEjB"}

package/dist/base-plugin/viewtemplates/edit.js

@@ -23,7 +23,7 @@ const { get_expression_function, expressionChecker, eval_expression, freeVariabl
 const { InvalidConfiguration, isNode, isWeb, isTest, mergeIntoWhere, dollarizeObject, getSessionId, interpolate, asyncMap, removeEmptyStrings, } = require("../../utils");
 const Library = require("../../models/library");
 const { check_view_columns } = require("../../plugin-testing");
-const { initial_config_all_fields, calcfldViewOptions, calcfldViewConfig, get_parent_views, picked_fields_to_query, stateFieldsToWhere, stateFieldsToQuery, getActionConfigFields, run_action_column, add_free_variables_to_joinfields, readState, stateToQueryString, pathToState, displayType, } = require("../../plugin-helper");
+const { initial_config_all_fields, calcfldViewOptions, calcfldViewConfig, get_parent_views, picked_fields_to_query, stateFieldsToWhere, stateFieldsToQuery, getActionConfigFields, run_action_column, add_free_variables_to_joinfields, readState, stateToQueryString, pathToState, displayType, runCollabEvents, } = require("../../plugin-helper");
 const { splitUniques, getForm, fill_presets, parse_view_select, get_view_link_query, objToQueryString, action_url, action_link, view_linker, edit_build_in_actions, } = require("./viewable_fields");
 const { traverse, getStringsForI18n, translateLayout, traverseSync, splitLayoutContainerFields, findLayoutBranchWith, } = require("../../models/layout");
 const { extractFromLayout } = require("../../diagram/node_extract_utils");
@@ -239,6 +239,7 @@ const configuration_workflow = (req) => new Workflow({
                 }));
                 const pages = await Page.find();
                 const groups = await PageGroup.find();
+                const triggers = Trigger.find();
                 return new Form({
                     fields: [
                         {
@@ -280,6 +281,21 @@ const configuration_workflow = (req) => new Workflow({
                             type: "Bool",
                             default: false,
                         },
+                        new FieldRepeat({
+                            name: "update_events",
+                            showIf: { enable_realtime: true },
+                            fields: [
+                                {
+                                    type: "String",
+                                    name: "event",
+                                    label: req.__("Update event"),
+                                    sublabel: req.__("Custom event for real-time updates"),
+                                    attributes: {
+                                        options: triggers.map((t) => t.name),
+                                    },
+                                },
+                            ],
+                        }),
                         {
                             name: "destination_type",
                             label: "Destination type",
@@ -432,7 +448,7 @@ const run = async (table_id, viewname, cfg, state, { res, req, isPreview, hidden
  * @param {object} extra
  * @returns {Promise<Form[]>}
  */
-const runMany = async (table_id, viewname, { columns, layout, auto_save, split_paste, confirm_leave }, state, extra, { editManyQuery, getRowQuery, optionsQuery }) => {
+const runMany = async (table_id, viewname, { columns, layout, auto_save, split_paste, confirm_leave, enable_realtime, update_events, }, state, extra, { editManyQuery, getRowQuery, optionsQuery }) => {
     let { table, fields, rows } = await editManyQuery(state, {
         limit: extra.limit,
         offset: extra.offset,
@@ -462,6 +478,8 @@ const runMany = async (table_id, viewname, { columns, layout, auto_save, split_p
             split_paste,
             isRemote,
             confirm_leave,
+            enable_realtime,
+            update_events,
         });
         return { html, row };
     });
@@ -476,7 +494,8 @@ const runMany = async (table_id, viewname, { columns, layout, auto_save, split_p
  * @throws {InvalidConfiguration}
  * @returns {Promise<void>}
  */
-const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname, optionsQuery, }) => {
+const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname, optionsQuery, state, }) => {
+    let originalState = state;
     let pseudo_row = {};
     if (!row) {
         table.fields.forEach((f) => {
@@ -653,6 +672,11 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
                 segment.field_repeat = fr;
                 return;
             } // end edit in edit
+            const outerState = {};
+            Object.entries(originalState || {}).forEach(([k, v]) => {
+                if (k.startsWith("_"))
+                    outerState[k] = v;
+            });
             let state = {};
             let urlFormula;
             let needFields = new Set();
@@ -673,7 +697,7 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
                     const type = relation.type;
                     if (!row && type == RelationType.OWN) {
                         segment.type = "blank";
-                        urlFormula = `add_extra_state('/view/${view.name}/?${relFmlQS}', ${JSON.stringify(segment.extra_state_fml)}, row)`;
+                        urlFormula = `add_extra_state('/view/${view.name}/?${relFmlQS}', ${JSON.stringify(segment.extra_state_fml)}, row, ${JSON.stringify(outerState)})`;
                         segment.contents = segment.contents = div({
                             class: "d-inline",
                             "data-sc-embed-viewname": view.name,
@@ -685,7 +709,7 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
                     else if (!row &&
                         type !== RelationType.INDEPENDENT &&
                         !relation.isFixedRelation()) {
-                        urlFormula = `add_extra_state('/view/${view.name}/?${relFmlQS}', ${JSON.stringify(segment.extra_state_fml)}, row)`;
+                        urlFormula = `add_extra_state('/view/${view.name}/?${relFmlQS}', ${JSON.stringify(segment.extra_state_fml)}, row, ${JSON.stringify(outerState)})`;
                         segment.contents = segment.contents = div({
                             class: "d-inline",
                             "data-sc-embed-viewname": view.name,
@@ -696,7 +720,7 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
                     }
                     const userId = req?.user?.id;
                     state = pathToState(relation, relation.isFixedRelation() ? () => userId : (k) => row[k]);
-                    urlFormula = `add_extra_state('/view/${view.name}?${relFmlQS}', ${JSON.stringify(segment.extra_state_fml)}, row)`;
+                    urlFormula = `add_extra_state('/view/${view.name}?${relFmlQS}', ${JSON.stringify(segment.extra_state_fml)}, row, ${JSON.stringify(outerState)})`;
                 }
             }
             else {
@@ -707,23 +731,23 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
                 switch (view_select.type) {
                     case "Own":
                         state = { id: row?.id };
-                        urlFormula = `add_extra_state('/view/${view.name}/?id='+row.id, ${JSON.stringify(segment.extra_state_fml)}, row)`;
+                        urlFormula = `add_extra_state('/view/${view.name}/?id='+row.id, ${JSON.stringify(segment.extra_state_fml)}, row, ${JSON.stringify(outerState)})`;
                         needFields.add("id");
                         break;
                     case "Independent":
                         state = {};
-                        urlFormula = `add_extra_state('/view/${view.name}/?id='+row.id, ${JSON.stringify(segment.extra_state_fml)}, row)`;
+                        urlFormula = `add_extra_state('/view/${view.name}/?id='+row.id, ${JSON.stringify(segment.extra_state_fml)}, row, ${JSON.stringify(outerState)})`;
                         needFields.add("id");
                         break;
                     case "ChildList":
                     case "OneToOneShow":
                         state = { [view_select.field_name]: row?.id };
-                        urlFormula = `add_extra_state('/view/${view.name}/?${view_select.field_name}='+row.id, ${JSON.stringify(segment.extra_state_fml)}, row)`;
+                        urlFormula = `add_extra_state('/view/${view.name}/?${view_select.field_name}='+row.id, ${JSON.stringify(segment.extra_state_fml)}, row, ${JSON.stringify(outerState)})`;
                         needFields.add("id");
                         break;
                     case "ParentShow":
                         state = { id: row?.[view_select.field_name] };
-                        urlFormula = `add_extra_state('/view/${view.name}/?id='+row.${view_select.field_name}, ${JSON.stringify(segment.extra_state_fml)}, row)`;
+                        urlFormula = `add_extra_state('/view/${view.name}/?id='+row.${view_select.field_name}, ${JSON.stringify(segment.extra_state_fml)}, row, ${JSON.stringify(outerState)})`;
                         needFields.add(view_select.field_name);
                         break;
                 }
@@ -745,7 +769,7 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
                     ...(row || pseudo_row),
                 }, req.user, `Extra state formula for embedding view ${view.name}`)
                 : {};
-            const qs = stateToQueryString({ ...state, ...extra_state }, true);
+            const qs = stateToQueryString({ ...state, ...outerState, ...extra_state }, true);
             segment.contents = div({
                 class: "d-inline",
                 "data-sc-embed-viewname": view.name,
@@ -753,7 +777,7 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
                 "data-view-source-current": `/view/${view.name}${qs}`,
                 "data-view-source-need-fields": [...needFields].join(","),
                 "data-view-source": encodeURIComponent(urlFormula),
-            }, await view.run({ ...state, ...extra_state }, { req, res }, view.isRemoteTable()));
+            }, await view.run({ ...state, ...outerState, ...extra_state }, { req, res }, view.isRemoteTable()));
         },
     });
     translateLayout(form.layout, req.getLocale());
@@ -761,22 +785,33 @@ const transformForm = async ({ form, table, req, row, res, getRowQuery, viewname
         form.xhrSubmit = true;
     setDateLocales(form, req.getLocale());
 };
-const realTimeScript = (viewname, table_id, row) => {
+const realTimeScript = (viewname, table_id, row, scriptId) => {
     const view = View.findOne({ name: viewname });
     const table = Table.findOne({ id: table_id });
     const rowId = row[table.pk_name];
     return `
   const collabCfg = {
     events: {
-      '${view.getRealTimeEventName(`UPDATE_EVENT?id=${rowId}`)}': (data) => {
+      '${view.getRealTimeEventName(`UPDATE_EVENT?id=${rowId}`)}': async (data) => {
         console.log("Update event received for view ${viewname}", data);
+        const script = document.getElementById('${scriptId}');
+        const closestDiv = script?.closest(
+          'div[data-sc-embed-viewname="${viewname}"]'
+        );
         if (data.updates) {
-          common_done({set_fields: data.updates, no_onchange: true}, "${viewname}");
+          if (closestDiv) await common_done({set_fields: data.updates, no_onchange: true}, closestDiv);
+          else await common_done({set_fields: data.updates, no_onchange: true}, "${viewname}");
+        }
+        if (data.actions) {
+          for (const action of data.actions) {
+            if (closestDiv) await common_done(action, closestDiv);
+            else await common_done(action, "${viewname}");
+          }
         }
       }
     }
   };
-  init_collab_room('${viewname}', collabCfg);`;
+  init_collab_room('${viewname}', collabCfg);`.trim();
 };
 /**
  * @param {object} opts
@@ -937,12 +972,16 @@ const render = async ({ table, fields, viewname, columns, layout, row, req, stat
         : `form${Math.floor(Math.random() * 16777215).toString(16)}`;
     const identicalFieldsScript = script(domReady(`const editForm = document.getElementById('${formId}'); if (editForm) editForm.addEventListener("change", handle_identical_fields, true);`));
     const dynamic_updates_enabled = getState().getConfig("enable_dynamic_updates", true);
+    const rndid = isTest()
+        ? "test-script-id"
+        : Math.floor(Math.random() * 16777215).toString(16);
     const realTimeCollabScript = enable_realtime && row && !(req.headers?.pjaxpageload === "true")
         ? (!dynamic_updates_enabled
             ? script({
                 src: `/static_assets/${db.connectObj.version_tag}/socket.io.min.js`,
             })
-            : "") + script(domReady(realTimeScript(viewname, table.id, row)))
+            : "") +
+            script({ id: rndid }, domReady(realTimeScript(viewname, table.id, row, rndid)))
         : "";
     if (actually_auto_save) {
         for (const field of form.fields) {
@@ -959,6 +998,7 @@ const render = async ({ table, fields, viewname, columns, layout, row, req, stat
         getRowQuery,
         viewname,
         optionsQuery,
+        state,
     });
     form.id = formId;
     return (renderForm(form, !isRemote && req.csrfToken ? req.csrfToken() : false) +
@@ -1756,7 +1796,7 @@ const createBasicView = async ({ table, viewname, template_view, template_table,
     cfg.split_paste = template_view.configuration.split_paste;
     return cfg;
 };
-const virtual_triggers = (table_id, viewname, { enable_realtime }) => {
+const virtual_triggers = (table_id, viewname, { enable_realtime, update_events }) => {
     if (!enable_realtime)
         return [];
     const table = Table.findOne({ id: table_id });
@@ -1792,15 +1832,21 @@ const virtual_triggers = (table_id, viewname, { enable_realtime }) => {
                 }
                 else {
                     // build and emit updates
-                    const updateVals = {};
+                    const updates = {};
                     for (const fieldName of changedLayoutFields) {
                         const newVal = row[fieldName];
-                        updateVals[fieldName] = newVal;
+                        updates[fieldName] = newVal;
                     }
                     const rowId = row[table.pk_name];
-                    getState().log(6, "Emitting real-time update for row", rowId, updateVals);
+                    const actionResults = await runCollabEvents(update_events, user, {
+                        new_row: row,
+                        old_row: old_row,
+                        updates: updates,
+                    });
+                    getState().log(6, "Emitting real-time update for row", rowId, updates);
                     view.emitRealTimeEvent(`UPDATE_EVENT?id=${rowId}`, {
-                        updates: updateVals,
+                        updates: updates,
+                        actions: actionResults,
                     });
                 }
             },
@@ -1840,7 +1886,7 @@ module.exports = {
     getStringsForI18n({ layout }) {
         return getStringsForI18n(layout);
     },
-    queries: ({ table_id, name, configuration: { columns, default_state, layout, auto_save, split_paste, destination_type, fixed, confirm_leave, auto_create, delete_unchanged_auto_create, enable_realtime, }, req, res, }) => ({
+    queries: ({ table_id, name, configuration: { columns, default_state, layout, auto_save, split_paste, destination_type, fixed, confirm_leave, auto_create, delete_unchanged_auto_create, enable_realtime, update_events, }, req, res, }) => ({
         async editQuery(state, mobileReferrer, isPreview, hiddenLoginDest) {
             const table = Table.findOne({ id: table_id });
             const fields = table.getFields();
@@ -1922,6 +1968,7 @@ module.exports = {
                 auto_created_row,
                 hiddenLoginDest,
                 enable_realtime,
+                update_events,
             });
         },
         async editManyQuery(state, { limit, offset, orderBy, orderDesc, where }) {