@saltcorn/server 0.7.2-beta.4 → 0.7.2-beta.7

package/routes/eventlog.js

@@ -5,7 +5,7 @@
  * @subcategory routes
  */
 const Router = require("express-promise-router");
-const { isAdmin, error_catcher, get_base_url } = require("./utils.js");
+const { isAdmin, error_catcher } = require("./utils.js");
 const { getState } = require("@saltcorn/data/db/state");
 const Trigger = require("@saltcorn/data/models/trigger");
 
@@ -21,19 +21,19 @@ module.exports = router;
 const {
   mkTable,
   renderForm,
-  link,
-  post_btn,
-  settingsDropdown,
-  post_dropdown_item,
+  //link,
+  //post_btn,
+  //settingsDropdown,
+  //post_dropdown_item,
   post_delete_btn,
   localeDateTime,
 } = require("@saltcorn/markup");
 const Form = require("@saltcorn/data/models/form");
 const {
   div,
-  code,
+  //code,
   a,
-  span,
+  //span,
   tr,
   table,
   tbody,
@@ -74,7 +74,7 @@ const logSettingsForm = async (req) => {
         name: w + "_channel",
         label: w + " channel",
         sublabel:
-          "Channels to create events for. Separate by comma; leave blank for all",
+          req.__("Channels to create events for. Separate by comma; leave blank for all"),
         type: "String",
         showIf: { [w]: true },
       });
@@ -168,25 +168,25 @@ router.get(
 /**
  * @returns {Form}
  */
-const customEventForm = () =>
-  new Form({
-    action: "/eventlog/custom/new",
-    submitButtonClass: "btn-outline-primary",
-    onChange: "remove_outline(this)",
-    fields: [
-      {
-        name: "name",
-        label: "Name",
-        type: "String",
-      },
-      {
-        name: "hasChannel",
-        label: "Has channels?",
-        type: "Bool",
-      },
-    ],
-  });
-
+const customEventForm = async (req) => {
+    return new Form({
+        action: "/eventlog/custom/new",
+        submitButtonClass: "btn-outline-primary",
+        onChange: "remove_outline(this)",
+        fields: [
+            {
+                name: "name",
+                label: req.__("Event Name"),
+                type: "String",
+            },
+            {
+                name: "hasChannel",
+                label: req.__("Has channels?"),
+                type: "Bool",
+            },
+        ],
+    });
+};
 /**
  * @name get/custom/new
  * @function
@@ -197,7 +197,7 @@ router.get(
   "/custom/new",
   isAdmin,
   error_catcher(async (req, res) => {
-    const form = customEventForm();
+    const form = await customEventForm(req);
     send_events_page({
       res,
       req,
@@ -222,7 +222,7 @@ router.post(
   "/custom/new",
   isAdmin,
   error_catcher(async (req, res) => {
-    const form = customEventForm();
+    const form = await customEventForm(req);
     form.validate(req.body);
     if (form.hasErrors) {
       send_events_page({
@@ -323,7 +323,7 @@ router.get(
       { orderBy: "occur_at", orderDesc: true, limit: rows_per_page, offset }
     );
     if (evlog.length === rows_per_page || current_page > 1) {
-      const nrows = await EventLog.count();
+      const nrows = await EventLog.count({});
       if (nrows > rows_per_page || current_page > 1) {
         page_opts.pagination = {
           current_page,

package/routes/fields.js

@@ -296,6 +296,12 @@ const fieldFlow = (req) =>
                   input_type: "select",
                   options: roles.map((r) => ({ value: r.id, label: r.role })),
                 },
+                {
+                  name: "also_delete_file",
+                  type: "Bool",
+                  label: req.__("Cascade delete to file"),
+                  sublabel: req.__("Deleting a row will also delete the file referenced by this field")
+                },
               ],
             });
           } else {

package/routes/files.js

@@ -1,4 +1,5 @@
 /**
+ * Files Route
  * @category server
  * @module routes/files
  * @subcategory routes
@@ -15,28 +16,12 @@ const {
   mkTable,
   renderForm,
   link,
-  post_btn,
+  //post_btn,
   post_delete_btn,
 } = require("@saltcorn/markup");
 const { isAdmin, error_catcher, setTenant } = require("./utils.js");
-const {
-  span,
-  h5,
-  h1,
-  h4,
-  nbsp,
-  p,
-  a,
-  div,
-  form,
-  input,
-  select,
-  button,
-  option,
-  text,
-  label,
-} = require("@saltcorn/markup/tags");
-const { csrfField } = require("./utils");
+const { h1, div, text } = require("@saltcorn/markup/tags");
+// const { csrfField } = require("./utils");
 const { editRoleForm, fileUploadForm } = require("../markup/forms.js");
 const { strictParseInt } = require("@saltcorn/data/plugin-helper");
 const {
@@ -44,7 +29,7 @@ const {
   config_fields_form,
   save_config_from_form,
 } = require("../markup/admin");
-const fsp = require("fs").promises;
+// const fsp = require("fs").promises;
 const fs = require("fs");
 
 /**
@@ -58,6 +43,7 @@ const router = new Router();
 module.exports = router;
 
 /**
+ * Edit file Role form
  * @param {*} file
  * @param {*} roles
  * @param {*} req
@@ -81,6 +67,7 @@ router.get(
   "/",
   isAdmin,
   error_catcher(async (req, res) => {
+    // todo limit select from file by 10 or 20
     const rows = await File.find({}, { orderBy: "filename" });
     const roles = await User.get_roles();
     send_files_page({

package/routes/homepage.js

@@ -1,4 +1,6 @@
 /**
+ * Default Home Page (Wellcome page)
+ * Opens for new site without any data
  * @category server
  * @module routes/homepage
  * @subcategory routes
@@ -10,11 +12,11 @@ const View = require("@saltcorn/data/models/view");
 const User = require("@saltcorn/data/models/user");
 const File = require("@saltcorn/data/models/file");
 const Page = require("@saltcorn/data/models/page");
-const { link, renderForm, mkTable, post_btn } = require("@saltcorn/markup");
-const { ul, li, div, small, a, h5, p, i } = require("@saltcorn/markup/tags");
+const { link, mkTable } = require("@saltcorn/markup");
+const { div, a, p, i } = require("@saltcorn/markup/tags");
 const Table = require("@saltcorn/data/models/table");
 const { fetch_available_packs } = require("@saltcorn/admin-models/models/pack");
-const { restore_backup } = require("../markup/admin");
+// const { restore_backup } = require("../markup/admin");
 const { get_latest_npm_version } = require("@saltcorn/data/models/config");
 const packagejson = require("../package.json");
 const Trigger = require("@saltcorn/data/models/trigger");
@@ -22,6 +24,7 @@ const { fileUploadForm } = require("../markup/forms");
 const { get_base_url } = require("./utils.js");
 
 /**
+ * Tables List
  * @param {*} tables
  * @param {object} req
  * @returns {Table}
@@ -39,6 +42,7 @@ const tableTable = (tables, req) =>
   );
 
 /**
+ * Tables Card
  * @param {*} tables
  * @param {object} req
  * @returns {object}
@@ -68,6 +72,7 @@ const tableCard = (tables, req) => ({
 });
 
 /**
+ * Views List
  * @param {*} views
  * @param {object} req
  * @returns {Table}
@@ -89,6 +94,7 @@ const viewTable = (views, req) =>
   );
 
 /**
+ * Views Card
  * @param {*} views
  * @param {object} req
  * @returns {object}
@@ -120,6 +126,7 @@ const viewCard = (views, req) => ({
 });
 
 /**
+ * Pages List
  * @param {*} pages
  * @param {object} req
  * @returns {Table}
@@ -141,6 +148,7 @@ const pageTable = (pages, req) =>
   );
 
 /**
+ * Page Card
  * @param {*} pages
  * @param {object} req
  * @returns {object}
@@ -173,13 +181,14 @@ const pageCard = (pages, req) => ({
 });
 
 /**
+ * Files Tab
  * @param {object} req
  * @returns {Promise<div>}
  */
 const filesTab = async (req) => {
   const files = await File.find({}, { orderBy: "filename", cached: true });
   return div(
-    files.length == 0
+    files.length === 0
       ? p(req.__("No files"))
       : mkTable(
           [
@@ -197,7 +206,10 @@ const filesTab = async (req) => {
 };
 
 /**
+ * Users Tab
  * @param {object} req
+ * @param users
+ * @param roleMap
  * @returns {Promise<div>}
  */
 const usersTab = async (req, users, roleMap) => {
@@ -221,7 +233,9 @@ const usersTab = async (req, users, roleMap) => {
 };
 
 /**
+ * Actions (Triggers) Tab
  * @param {object} req
+ * @param triggers
  * @returns {Promise<div>}
  */
 const actionsTab = async (req, triggers) => {
@@ -234,7 +248,7 @@ const actionsTab = async (req, triggers) => {
         { class: "mt-2 pe-2" },
         i(req.__("Triggers run actions in response to events."))
       ),
-    triggers.length == 0
+    triggers.length === 0
       ? p(req.__("No triggers"))
       : mkTable(
           [
@@ -260,6 +274,12 @@ const actionsTab = async (req, triggers) => {
     )
   );
 };
+/**
+ * Plugins and Packs Tab
+ * @param req
+ * @param packlist
+ * @returns {*}
+ */
 const packTab = (req, packlist) =>
   div(
     { class: "pb-3 pt-2 pe-4" },
@@ -286,7 +306,11 @@ const packTab = (req, packlist) =>
       req.__("Go to pack store »")
     )
   );
-
+/**
+ * Help Card
+ * @param req
+ * @returns {*}
+ */
 const helpCard = (req) =>
   div(
     { class: "pb-3 pt-2 pe-4" },
@@ -321,6 +345,7 @@ const helpCard = (req) =>
   );
 
 /**
+ * Wellcome page
  * @param {object} req
  * @returns {Promise<object>}
  */
@@ -393,6 +418,7 @@ const welcome_page = async (req) => {
 };
 
 /**
+ * No Views logged in
  * @param {object} req
  * @param {object} res
  * @returns {Promise<void>}
@@ -423,6 +449,7 @@ const no_views_logged_in = async (req, res) => {
 };
 
 /**
+ * Get Config respounce
  * @param {number} role_id
  * @param {object} res
  * @param {object} req
@@ -430,6 +457,7 @@ const no_views_logged_in = async (req, res) => {
  */
 const get_config_response = async (role_id, res, req) => {
   const modernCfg = getState().getConfig("home_page_by_role", false);
+  // predefined roles
   const legacy_role = { 10: "public", 8: "user", 4: "staff", 1: "admin" }[
     role_id
   ];
@@ -472,7 +500,7 @@ module.exports =
       const hasUsers = await User.nonEmpty();
       if (!hasUsers) {
         res.redirect("/auth/create_first_user");
-        return;
+        // return;
       } else res.redirect("/auth/login");
     } else {
       await no_views_logged_in(req, res);

package/routes/menu.js

@@ -1,4 +1,5 @@
 /**
+ * Menu Editor
  * @category server
  * @module routes/menu
  * @subcategory routes
@@ -6,18 +7,18 @@
 
 const Router = require("express-promise-router");
 
-const Field = require("@saltcorn/data/models/field");
+//const Field = require("@saltcorn/data/models/field");
 const Form = require("@saltcorn/data/models/form");
-const { isAdmin, setTenant, error_catcher } = require("./utils.js");
+const { isAdmin, error_catcher } = require("./utils.js");
 const { getState } = require("@saltcorn/data/db/state");
-const File = require("@saltcorn/data/models/file");
+//const File = require("@saltcorn/data/models/file");
 const User = require("@saltcorn/data/models/user");
 const View = require("@saltcorn/data/models/view");
 const Page = require("@saltcorn/data/models/page");
 const { save_menu_items } = require("@saltcorn/data/models/config");
 const db = require("@saltcorn/data/db");
 
-const { mkTable, renderForm, link, post_btn } = require("@saltcorn/markup");
+const { renderForm } = require("@saltcorn/markup");
 const { script, domReady, div, ul } = require("@saltcorn/markup/tags");
 const { send_infoarch_page } = require("../markup/admin.js");
 const Table = require("@saltcorn/data/models/table");
@@ -33,7 +34,7 @@ const router = new Router();
 module.exports = router;
 
 /**
- *
+ * Menu Form
  * @param {object} req
  * @returns {Promise<Form>}
  */
@@ -246,9 +247,11 @@ const menuForm = async (req) => {
 //create -- new
 
 /**
+ * Menu Editor Script
  * @param {object[]} menu_items
  * @returns {string}
  */
+// todo move to file the content of menuEditorScript
 const menuEditorScript = (menu_items) => `
   var iconPickerOptions = {searchText: "Search icon...", labelHeader: "{0}/{1}"};
   let lastState;
@@ -262,7 +265,7 @@ const menuEditorScript = (menu_items) => `
   }
   var sortableListOptions = {
       placeholderCss: {'background-color': "#cccccc"},
-      onChange: ajax_save_menu,
+      onChange: ajax_save_menu
   };
   editor = new MenuEditor('myEditor', 
               { 
@@ -285,7 +288,7 @@ const menuEditorScript = (menu_items) => `
     editor.update();
     ajax_save_menu(true);
     location.reload();
-});
+  });
   // Calling the add method
   $('#btnAdd').click(function(){
       editor.add();
@@ -360,6 +363,7 @@ router.get(
   })
 );
 /**
+ * jQME to Menu
  * @param {object[]} menu_items
  * @returns {object[]}
  */

package/routes/tables.js

@@ -1437,7 +1437,7 @@ router.post(
       res.redirect(`/table`);
       return;
     }
-
+    //intentionally omit await
     recalculate_for_stored(table);
 
     req.flash("success", req.__("Started recalculating stored fields"));

package/routes/tenant.js

@@ -1,4 +1,5 @@
 /**
+ * Tenant(s) Route
  * @category server
  * @module routes/tenant
  * @subcategory routes
@@ -36,22 +37,23 @@ const {
   code,
 } = require("@saltcorn/markup/tags");
 const db = require("@saltcorn/data/db");
-const url = require("url");
+//const url = require("url");
 const { loadAllPlugins, loadAndSaveNewPlugin } = require("../load_plugins");
 const { isAdmin, error_catcher } = require("./utils.js");
 const User = require("@saltcorn/data/models/user");
 const File = require("@saltcorn/data/models/file");
 const {
   send_infoarch_page,
-  send_admin_page,
+  //send_admin_page,
   config_fields_form,
   save_config_from_form,
 } = require("../markup/admin.js");
 const { getConfig } = require("@saltcorn/data/models/config");
-const {
-  create_backup,
-  restore,
-} = require("@saltcorn/admin-models/models/backup");
+// todo add button backup / restore for particular tenant (available in admin tenants screens)
+//const {
+//  create_backup,
+//  restore,
+//} = require("@saltcorn/admin-models/models/backup");
 
 /**
  * @type {object}
@@ -116,6 +118,7 @@ const is_ip_address = (hostname) => {
 };
 
 /**
+ * Create tenant screen runnning
  * @name get/create
  * @function
  * @memberof module:routes/tenant~tenantRouter
@@ -146,6 +149,7 @@ router.get(
         )
       );
     let create_tenant_warning = "";
+    // todo add custom create tenant  warning message
     if (getState().getConfig("create_tenant_warning"))
       create_tenant_warning = div(
         {
@@ -200,9 +204,8 @@ const getNewURL = (req, subdomain) => {
     if (hosts.length > 1) ports = `:${hosts[1]}`;
   }
   const hostname = req.hostname;
-  const newurl = `${req.protocol}://${subdomain}.${hostname}${ports}/`;
-
-  return newurl;
+  // return newurl
+  return `${req.protocol}://${subdomain}.${hostname}${ports}/`;
 };
 
 /**
@@ -307,7 +310,7 @@ router.post(
 );
 
 /**
- * List tenants HTTP GET Web UI
+ * List tenants ( on /tenant/list)
  * @name get/list
  * @function
  * @memberof module:routes/tenant~tenantRouter

package/routes/viewedit.js

@@ -586,11 +586,11 @@ router.get(
       view.configuration && Object.keys(view.configuration).length > 0;
     const wfres = await configFlow.run(
       {
+        ...view.configuration,
         id: hasConfig ? view.id : undefined,
         table_id: view.table_id,
         exttable_name: view.exttable_name,
         viewname: name,
-        ...view.configuration,
       },
       req
     );

package/wrapper.js

@@ -3,18 +3,28 @@
  * @module wrapper
  */
 const { getState } = require("@saltcorn/data/db/state");
-const db = require("@saltcorn/data/db");
-const { ul, li, h3, div, small } = require("@saltcorn/markup/tags");
+//const db = require("@saltcorn/data/db");
+const { h3, div, small } = require("@saltcorn/markup/tags");
 const { renderForm, link } = require("@saltcorn/markup");
 const renderLayout = require("@saltcorn/markup/layout");
-
+/**
+ * get flashes
+ * @param req
+ * @returns {T[]}
+ */
 const getFlashes = (req) =>
-  ["error", "success", "danger", "warning"]
+  ["error", "success", "danger", "warning","information"]
     .map((type) => {
       return { type, msg: req.flash(type) };
     })
     .filter((a) => a.msg && a.msg.length && a.msg.length > 0);
-
+/**
+ * Get extra menu
+ * @param role
+ * @param state
+ * @param req
+ * @returns {*}
+ */
 const get_extra_menu = (role, state, req) => {
   let cfg = getState().getConfig("unrolled_menu_items", []);
   if (!cfg || cfg.length === 0) {
@@ -43,7 +53,11 @@ const get_extra_menu = (role, state, req) => {
       }));
   return transform(cfg);
 };
-
+/**
+ * Get menu
+ * @param req
+ * @returns {(false|{section: *, items}|{section: *, items: [{link: string, icon: string, label: *},{link: string, icon: string, label: *},{link: string, icon: string, label: *},{icon: string, subitems: [{link: string, icon: string, label: *},{link: string, icon: string, label: *},{link: string, icon: string, altlinks: string[], label: *},{link: string, altlinks: string[], icon: string, label: *},{link: string, icon: string, label: *},null], label: *}]}|{section: *, isUser: boolean, items: ([{icon: string, subitems: [{label: *},{icon: string, link: string, label: *},{link: string, icon: string, label: *}], label: *, isUser: boolean}]|*[])})[]}
+ */
 const get_menu = (req) => {
   const isAuth = req.user && req.user.id;
   const state = getState();
@@ -82,8 +96,13 @@ const get_menu = (req) => {
           ? [{ link: "/auth/login", label: req.__("Login") }]
           : []),
       ];
-  const schema = db.getTenantSchema();
+  // const schema = db.getTenantSchema();
+  // Admin role id (todo move to common constants)
   const isAdmin = role === 1;
+    /*
+     * Admin Menu items
+     *
+     */
   const adminItems = [
     { link: "/table", icon: "fas fa-table", label: req.__("Tables") },
     { link: "/viewedit", icon: "far fa-eye", label: req.__("Views") },
@@ -126,7 +145,8 @@ const get_menu = (req) => {
     },
   ];
 
-  const menu = [
+  // return menu
+  return [
     extra_menu.length > 0 && {
       section: req.__("Menu"),
       items: extra_menu,
@@ -141,9 +161,16 @@ const get_menu = (req) => {
       items: authItems,
     },
   ].filter((s) => s);
-  return menu;
-};
 
+};
+/**
+ * Get Headers
+ * @param req
+ * @param version_tag
+ * @param description
+ * @param extras
+ * @returns {*[]}
+ */
 const get_headers = (req, version_tag, description, extras = []) => {
   const state = getState();
   const favicon = state.getConfig("favicon_id", null);
@@ -188,6 +215,11 @@ const get_headers = (req, version_tag, description, extras = []) => {
     ...from_cfg,
   ];
 };
+/**
+ * Get brand
+ * @param state
+ * @returns {{name: *, logo: (string|undefined)}}
+ */
 const get_brand = (state) => {
   const logo_id = state.getConfig("site_logo_id", "");
   return {
@@ -196,6 +228,12 @@ const get_brand = (state) => {
   };
 };
 module.exports = (version_tag) =>
+    /**
+     *
+     * @param req
+     * @param res
+     * @param next
+     */
   function (req, res, next) {
     const role = (req.user || {}).role_id || 10;
 
@@ -220,7 +258,7 @@ module.exports = (version_tag) =>
           })
         );
       } else {
-        var links = [];
+        let links = [];
         if (authLinks.login)
           links.push(
             link(authLinks.login, req.__("Already have an account? Login"))
@@ -301,7 +339,12 @@ module.exports = (version_tag) =>
     };
     next();
   };
-
+/**
+ * Default render to HTML
+ * @param s
+ * @param role
+ * @returns {string|string|*}
+ */
 const defaultRenderToHtml = (s, role) =>
   typeof s === "string"
     ? s