@saltcorn/server 1.6.0-alpha.0 → 1.6.0-alpha.10

package/routes/sync.js

@@ -361,7 +361,7 @@ router.post(
   "/push_subscribe",
   loggedIn,
   error_catcher(async (req, res) => {
-    const { token, deviceId, synchedTables } = req.body || {};
+    const { token, deviceId, synchedTables, platform } = req.body || {};
     if (!token) {
       res.status(400).json({
         error: req.__("FCM token is required"),
@@ -382,10 +382,12 @@ router.post(
         message: req.__("sync push subscription already exists"),
       });
     } else {
+      // remove old subscriptions for this deviceId before adding
       userSubs = userSubs.filter((s) => s.deviceId !== deviceId);
       userSubs.push({
         token,
         deviceId,
+        type: platform === "android" ? "fcm-push" : "apns-push",
         synchedTables,
       });
       await getState().setConfig("push_sync_subscriptions", {

package/routes/tables.js

@@ -102,6 +102,7 @@ const tableForm = async (table, req) => {
     label: r.role,
   }));
   const ownership_opts = await table.ownership_options();
+  const writableTable = table.updateRow || table.insertRow || table.deleteRow;
   const form = new Form({
     action: "/table",
     noSubmitButton: true,
@@ -119,23 +120,27 @@ const tableForm = async (table, req) => {
         name: "min_role_read",
         input_type: "select",
         options: roleOptions,
-        attributes: { asideNext: !table.external && !table.provider_name },
+        attributes: { asideNext: !table.external && writableTable },
       },
-      ...(!table.external && !table.provider_name
+      ...(!table.external
         ? [
-            {
-              label: req.__("Minimum role to write"),
-              name: "min_role_write",
-              input_type: "select",
-              help: {
-                topic: "Table roles",
-                context: {},
-              },
-              sublabel: req.__(
-                "User must have this role or higher to edit or create new rows in the table, unless they are the owner"
-              ),
-              options: roleOptions,
-            },
+            ...(writableTable
+              ? [
+                  {
+                    label: req.__("Minimum role to write"),
+                    name: "min_role_write",
+                    input_type: "select",
+                    help: {
+                      topic: "Table roles",
+                      context: {},
+                    },
+                    sublabel: req.__(
+                      "User must have this role or higher to edit or create new rows in the table, unless they are the owner"
+                    ),
+                    options: roleOptions,
+                  },
+                ]
+              : []),
             {
               label: req.__("Ownership field"),
               name: "ownership_field_id",

package/routes/utils.js

@@ -383,7 +383,8 @@ const getSessionStore = (pruneInterval) => {
 const addOnDoneRedirect = (oldPath, req) => {
   const separator = oldPath.indexOf("?") > -1 ? "&" : "?";
   if (req.query.on_done_redirect) {
-    return `${oldPath}${separator}on_done_redirect=${req.query.on_done_redirect}`;
+    const encoded = encodeURIComponent(req.query.on_done_redirect);
+    return `${oldPath}${separator}on_done_redirect=${encoded}`;
   }
   return oldPath;
 };

package/routes/viewedit.js

@@ -560,11 +560,14 @@ router.post(
           }
 
         const v = result.success;
+        const vt = getState().viewtemplates[v.viewtemplate];
         if (v.table_name) {
           const table = Table.findOne({ name: v.table_name });
           if (table && table.id) {
             v.table_id = table.id;
           } else if (table && table.external) v.exttable_name = v.table_name;
+        } else if (vt?.table_optional) {
+          v.table_id = null;
         }
         if (v.table_id) {
           const table = Table.findOne({ id: v.table_id });
@@ -577,7 +580,6 @@ router.post(
         if ((req.body || {}).id) {
           await View.update(v, +(req.body || {}).id);
         } else {
-          const vt = getState().viewtemplates[v.viewtemplate];
           if (vt.initial_config) v.configuration = await vt.initial_config(v);
           else v.configuration = {};
           //console.log(v);
@@ -685,6 +687,9 @@ const respondWorkflow = (view, wf, wfres, req, res, table) => {
       )
     );
   else if (wfres.renderBuilder) {
+    const locale = req.getLocale();
+    wfres.renderBuilder.options.translations =
+      locale === "en" ? {} : req.getCatalog(locale) || {};
     wfres.renderBuilder.options.view_id = view.id;
     res.sendWrap(
       {

package/serve.js

@@ -342,23 +342,18 @@ const workerDispatchMsg = ({ tenant, ...msg }) => {
  * @returns {function}
  */
 const onMessageFromWorker =
-  (
-    masterState,
-    { port, host, watchReaper, disableScheduler, pid, nodesDispatchMsg }
-  ) =>
+  (masterState, { port, pid, nodesDispatchMsg, scheduleHelper, isLeader }) =>
   (msg) => {
     //console.log("worker msg", typeof msg, msg);
     if (msg === "Start" && !masterState.started) {
       masterState.started = true;
-      runScheduler({
-        port,
-        host,
-        watchReaper,
-        disableScheduler,
-        eachTenant,
-        auto_backup_now,
-        take_snapshot,
-      });
+      if (isLeader) scheduleHelper.start();
+      if (db.connectObj.multi_node) {
+        startLeadershipMonitor({
+          scheduleHelper,
+          wasLeader: isLeader,
+        });
+      }
       require("./systemd")({ port });
       return true;
     } else if (msg === "RestartServer") {
@@ -393,6 +388,10 @@ const escapeSingleQuotes = (value) => value.replace(/'/g, "''");
 const initOfflineStoreCfg = async () => {
   const rootState = getState();
   try {
+    if (!Plugin.local_store_entries_exists) {
+      await rootState.setConfig("pre_installed_module_infos", []);
+      return;
+    }
     const entries = await Plugin.read_local_store_entries();
     await rootState.setConfig("pre_installed_module_infos", entries);
   } catch (e) {
@@ -405,6 +404,54 @@ const initOfflineStoreCfg = async () => {
   }
 };
 
+/**
+ * returns a function that checks if current node is leader
+ * uses a dedicated pg connection that holds an advisory lock
+ */
+const getIsLeaderFn = async () => {
+  const electLeaderConn = await db.getClient();
+  const isSqlite = db.isSQLite;
+  return async () => {
+    if (isSqlite) return true;
+    const lockId = 11565;
+    const result = await electLeaderConn.query(
+      "SELECT pg_try_advisory_lock($1) AS is_leader",
+      [lockId]
+    );
+    if (result.rows[0].is_leader) return true;
+    else return false;
+  };
+};
+
+/**
+ * check periodically if the current node is leader and start/stop scheduler accordingly
+ * @param options - Options object
+ * @param options.scheduleHelper - Helper with start/stop and checkIsLeader function.
+ * @param options.wasLeader - flag if it was previously the leader.
+ * @param options.intervalMs - Monitor interval, Defaults to `5000`.
+ */
+const startLeadershipMonitor = ({
+  scheduleHelper,
+  wasLeader,
+  intervalMs = 5000,
+}) => {
+  let schedulerStarted = wasLeader;
+  setInterval(async () => {
+    try {
+      const isLeader = await scheduleHelper.isLeaderFn();
+      if (isLeader && !schedulerStarted) {
+        scheduleHelper.start();
+        schedulerStarted = true;
+      } else if (!isLeader && schedulerStarted) {
+        scheduleHelper.stop();
+        schedulerStarted = false;
+      }
+    } catch (e) {
+      console.log(`Error checking leadership: ${e.message}`);
+    }
+  }, intervalMs);
+};
+
 module.exports =
   /**
    * @function
@@ -456,8 +503,14 @@ module.exports =
 
     let nodesDispatchMsg = null;
     let multiNodeClient = null;
+    let isLeaderFn = null;
+    let isLeader = true;
     if (db.connectObj.multi_node) {
       multiNodeClient = await db.getClient();
+      if (cluster.isMaster) {
+        isLeaderFn = await getIsLeaderFn();
+        isLeader = await isLeaderFn();
+      }
       nodesDispatchMsg = async ({ tenant, ...msg }) => {
         if (tenant) {
           db.runWithTenant(tenant, () => nodesDispatchMsg(msg));
@@ -490,16 +543,36 @@ module.exports =
       };
     }
 
+    const scheduleHelper = {
+      stopScheduler: false,
+      start: () => {
+        this.stopScheduler = false;
+        runScheduler({
+          stop_when: () => this.stopScheduler,
+          port,
+          host,
+          watchReaper,
+          disableScheduler,
+          eachTenant,
+          auto_backup_now,
+          take_snapshot,
+        });
+      },
+      stop: () => {
+        this.stopScheduler = true;
+      },
+      isLeaderFn,
+    };
+
     const addWorker = (worker) => {
       worker.on(
         "message",
         onMessageFromWorker(masterState, {
           port,
-          host,
-          watchReaper,
-          disableScheduler,
           pid: worker.process.pid,
           nodesDispatchMsg,
+          scheduleHelper,
+          isLeader,
         })
       );
     };
@@ -604,15 +677,13 @@ module.exports =
             });
         };
         await nonGreenlockWorkerSetup(appargs, port, host);
-        runScheduler({
-          port,
-          host,
-          watchReaper,
-          disableScheduler,
-          eachTenant,
-          auto_backup_now,
-          take_snapshot,
-        });
+        if (isLeader) scheduleHelper.start();
+        if (db.connectObj.multi_node) {
+          startLeadershipMonitor({
+            scheduleHelper,
+            wasLeader: isLeader,
+          });
+        }
         require("./systemd")({ port });
       }
       Trigger.emitEvent("Startup");

package/tests/files.test.js

@@ -20,14 +20,21 @@ const Table = require("@saltcorn/data/models/table");
 const View = require("@saltcorn/data/models/view");
 const { existsSync } = require("fs");
 
-const createTestFile = async (folder, name, mimetype, content) => {
-  if (
-    !existsSync(
-      path.join(db.connectObj.file_store, db.getTenantSchema(), folder, name)
-    )
-  ) {
-    await File.from_contents(name, mimetype, content, 1, 100, folder);
-  }
+const createTestFile = async (
+  folder,
+  name,
+  mimetype,
+  content,
+  minRole = 100
+) => {
+  const fullPath = path.join(
+    db.connectObj.file_store,
+    db.getTenantSchema(),
+    folder,
+    name
+  );
+  if (existsSync(fullPath)) await fs.unlink(fullPath);
+  await File.from_contents(name, mimetype, content, 1, minRole, folder);
 };
 
 const checkFiles = (files, expecteds) =>
@@ -92,6 +99,13 @@ beforeAll(async () => {
     "image/png",
     "imagecontent"
   );
+  await createTestFile(
+    "_sc_test_subfolder_one",
+    "the-script.js",
+    "application/javascript",
+    "console.log('I am a script');",
+    1
+  );
 });
 afterAll(db.close);
 
@@ -191,6 +205,97 @@ describe("files admin", () => {
 
       .expect(toRedirect("/files?dir=."));
   });
+  describe("file editor", () => {
+    it("opens the file editor", async () => {
+      const app = await getApp({ disableCsrf: true });
+      const loginCookie = await getAdminLoginCookie();
+      await request(app)
+        .get(
+          `/files/edit/${encodeURIComponent("_sc_test_subfolder_one/the-script.js")}`
+        )
+        .set("Cookie", loginCookie)
+        .expect(toInclude("console.log('I am a script')"));
+    });
+    it("allows editing and saving a file", async () => {
+      const app = await getApp({ disableCsrf: true });
+      const loginCookie = await getAdminLoginCookie();
+      await request(app)
+        .post(
+          `/files/edit/${encodeURIComponent("_sc_test_subfolder_one/the-script.js")}`
+        )
+        .set("Cookie", loginCookie)
+        .send("value=console.log('I have been edited');")
+        .expect(toRedirect("/files?dir=_sc_test_subfolder_one"));
+    });
+
+    it("does not open for non-existing files", async () => {
+      const app = await getApp({ disableCsrf: true });
+      const loginCookie = await getAdminLoginCookie();
+      await request(app)
+        .get(
+          `/files/edit/${encodeURIComponent("_sc_test_subfolder_one/not-existing.js")}`
+        )
+        .set("Cookie", loginCookie)
+        .expect(toInclude("Not found", 404));
+    });
+    it("denies editing non-existing files", async () => {
+      const app = await getApp({ disableCsrf: true });
+      const loginCookie = await getAdminLoginCookie();
+      await request(app)
+        .post(
+          `/files/edit/${encodeURIComponent("_sc_test_subfolder_one/not-existing.js")}`
+        )
+        .set("Cookie", loginCookie)
+        .send("value=console.log('I have been edited');")
+        .expect(toRedirect("/files"));
+      await request(app)
+        .get("/files")
+        .set("Cookie", loginCookie)
+        .expect(toInclude("File not found"));
+    });
+
+    it("denies access to the file editor", async () => {
+      const app = await getApp({ disableCsrf: true });
+      const loginCookie = await getStaffLoginCookie();
+      await request(app)
+        .get(
+          `/files/edit/${encodeURIComponent("_sc_test_subfolder_one/the-script.js")}`
+        )
+        .set("Cookie", loginCookie)
+        .expect(toInclude("Not found", 404));
+    });
+    it("denies editing a file", async () => {
+      const app = await getApp({ disableCsrf: true });
+      const loginCookie = await getStaffLoginCookie();
+      await request(app)
+        .post(
+          `/files/edit/${encodeURIComponent("_sc_test_subfolder_one/the-script.js")}`
+        )
+        .set("Cookie", loginCookie)
+        .send("value=console.log('I have been edited');")
+        .expect(toRedirect("/files"));
+
+      await request(app)
+        .get("/")
+        .set("Cookie", loginCookie)
+        .expect(toInclude("File not found"));
+    });
+
+    it("does not open for folders or not editable extensions", async () => {
+      const app = await getApp({ disableCsrf: true });
+      const loginCookie = await getAdminLoginCookie();
+      await request(app)
+        .get(`/files/edit/${encodeURIComponent("_sc_test_subfolder_one")}`)
+        .set("Cookie", loginCookie)
+        .expect(toInclude("Directories cannot be edited", 400));
+      await request(app)
+        .get(
+          `/files/edit/${encodeURIComponent("_sc_test_subfolder_one/bar_image.png")}`
+        )
+        .set("Cookie", loginCookie)
+        .expect(toInclude("Files of this type cannot be edited", 400));
+    });
+  });
   it("search files by name", async () => {
     const app = await getApp({ disableCsrf: true });
     const loginCookie = await getAdminLoginCookie();
@@ -417,7 +522,9 @@ describe("visible_entries test", () => {
       .set("Cookie", staffCookie);
     expect(resp.statusCode).toBe(200);
     expect(
-      resp.body.directories.find((file) => file.filename === "_sc_test_subfolder_one/subsubfolder")
+      resp.body.directories.find(
+        (file) => file.filename === "_sc_test_subfolder_one/subsubfolder"
+      )
     ).toBeDefined();
   });
 

package/tests/menu.test.js

@@ -2,6 +2,7 @@ const request = require("supertest");
 const getApp = require("../app");
 const {
   getAdminLoginCookie,
+  getStaffLoginCookie,
   toInclude,
   succeedJsonWith,
   toSucceed,
@@ -120,3 +121,115 @@ describe("Menu tests", () => {
     }
   });
 });
+
+describe("Menu keyboard shortcuts", () => {
+  it("menu editor form includes shortcut field", async () => {
+    const app = await getApp({ disableCsrf: true });
+    const loginCookie = await getAdminLoginCookie();
+    const res = await request(app).get("/menu").set("Cookie", loginCookie);
+    expect(res.status).toBe(200);
+    expect(res.text).toContain('name="shortcut"');
+    expect(res.text).toContain("Keyboard shortcut");
+  });
+
+  it("injects _sc_menu_shortcuts when shortcuts are configured", async () => {
+    await save_menu_items([
+      {
+        type: "Page",
+        label: "test",
+        pagename: "test",
+        min_role: "100",
+        max_role: "1",
+        location: "Standard",
+        style: "",
+        shortcut: "Alt+k",
+      },
+    ]);
+    const app = await getApp({ disableCsrf: true });
+    const loginCookie = await getAdminLoginCookie();
+    const res = await request(app)
+      .get("/page/a_page")
+      .set("Cookie", loginCookie);
+    expect(res.text).toContain("_sc_menu_shortcuts");
+    expect(res.text).toContain("Alt+k");
+  });
+
+  it("does not inject _sc_menu_shortcuts when no shortcuts configured", async () => {
+    await save_menu_items([
+      {
+        type: "Page",
+        label: "test",
+        pagename: "test",
+        min_role: "100",
+        max_role: "1",
+        location: "Standard",
+        style: "",
+      },
+    ]);
+    const app = await getApp({ disableCsrf: true });
+    const loginCookie = await getAdminLoginCookie();
+    const res = await request(app)
+      .get("/page/a_page")
+      .set("Cookie", loginCookie);
+    expect(res.text).not.toContain("_sc_menu_shortcuts");
+  });
+
+  it("does not inject shortcuts for staff when min_role is admin only", async () => {
+    await save_menu_items([
+      {
+        type: "Page",
+        label: "test",
+        pagename: "test",
+        min_role: "1",
+        max_role: "1",
+        location: "Standard",
+        style: "",
+        shortcut: "Alt+k",
+      },
+    ]);
+    const app = await getApp({ disableCsrf: true });
+    const staffCookie = await getStaffLoginCookie();
+    const res = await request(app)
+      .get("/page/a_page")
+      .set("Cookie", staffCookie);
+    expect(res.text).not.toContain("_sc_menu_shortcuts");
+
+    const adminCookie = await getAdminLoginCookie();
+    const resAdmin = await request(app)
+      .get("/page/a_page")
+      .set("Cookie", adminCookie);
+    expect(resAdmin.text).toContain("_sc_menu_shortcuts");
+  });
+
+  it("collects shortcuts from nested subitems", async () => {
+    await save_menu_items([
+      {
+        type: "Header",
+        label: "Section",
+        min_role: "100",
+        max_role: "1",
+        location: "Standard",
+        style: "",
+        subitems: [
+          {
+            type: "Page",
+            label: "nested-test",
+            pagename: "test",
+            min_role: "100",
+            max_role: "1",
+            location: "Standard",
+            style: "",
+            shortcut: "Alt+n",
+          },
+        ],
+      },
+    ]);
+    const app = await getApp({ disableCsrf: true });
+    const loginCookie = await getAdminLoginCookie();
+    const res = await request(app)
+      .get("/page/a_page")
+      .set("Cookie", loginCookie);
+    expect(res.text).toContain("_sc_menu_shortcuts");
+    expect(res.text).toContain("Alt+n");
+  });
+});

package/wrapper.js

@@ -202,6 +202,33 @@ const get_brand = (state, req) => {
     logo: logo_id && logo_id !== "0" ? `/files/serve/${logo_id}` : undefined,
   };
 };
+/**
+ * Collect keyboard shortcuts from menu items
+ * @param {object[]} menu_sections
+ * @returns {object[]} array of {shortcut, link, type}
+ */
+const collect_menu_shortcuts = (menu_sections) => {
+  const shortcuts = [];
+  const extract = (items) => {
+    for (const item of items || []) {
+      if (item.shortcut && item.link) {
+        shortcuts.push({
+          shortcut: item.shortcut,
+          link: item.link,
+          type: item.type,
+        });
+      }
+      if (item.subitems) extract(item.subitems);
+    }
+  };
+  if (menu_sections) {
+    for (const section of menu_sections) {
+      extract(section.items || []);
+    }
+  }
+  return shortcuts;
+};
+
 module.exports = (version_tag) =>
   /**
    *
@@ -303,19 +330,34 @@ module.exports = (version_tag) =>
       const currentUrl = req.originalUrl.split("?")[0];
 
       const pageHeaders = typeof opts === "string" ? [] : opts.headers;
+      const menu = no_menu ? undefined : get_menu(req);
+      const shortcuts = collect_menu_shortcuts(menu);
+      const shortcutHeaders =
+        shortcuts.length > 0
+          ? [
+              {
+                scriptBody: `var _sc_menu_shortcuts = ${JSON.stringify(shortcuts)};`,
+              },
+            ]
+          : [];
 
       res.send(
         layout.wrap({
           title,
           brand: no_menu ? undefined : get_brand(state, req),
-          menu: no_menu ? undefined : get_menu(req),
+          menu,
           currentUrl,
           originalUrl: req.originalUrl,
           requestFluidLayout:
             typeof opts === "string" ? false : opts.requestFluidLayout,
           alerts,
           body: html.length === 1 ? html[0] : html.join(""),
-          headers: get_headers(req, version_tag, opts.description, pageHeaders),
+          headers: get_headers(
+            req,
+            version_tag,
+            opts.description,
+            [...(pageHeaders || []), ...shortcutHeaders]
+          ),
           role,
           req,
           bodyClass,

package/docs/functions/_saltcorn_data.base-plugin_fieldviews.radio_select.run.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>run | Documentation</title><meta name="description" content="Documentation for Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Documentation</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_saltcorn_data.html">@saltcorn/data</a></li><li><a href="../modules/_saltcorn_data.base-plugin_fieldviews.html">base-plugin/fieldviews</a></li><li><a href="../modules/_saltcorn_data.base-plugin_fieldviews.radio_select.html">radio_select</a></li><li><a href="" aria-current="page">run</a></li></ul><h1>Function run</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="run"><span class="tsd-kind-call-signature">run</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">attrs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">cls</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">reqd</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">field</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nm</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">v</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">attrs</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">cls</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">reqd</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">field</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/3c45426ff4200afd9e4f9894aebb9f0fdcfeb342/packages/saltcorn-data/base-plugin/fieldviews.js#L646">packages/saltcorn-data/base-plugin/fieldviews.js:646</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>