@saltcorn/server 0.6.1-beta.0 → 0.6.1

package/locales/en.json

@@ -808,5 +808,11 @@
 	"Set to 0 for expration at the end of browser session": "Set to 0 for expration at the end of browser session",
 	"Cookie duration (hours) when remember ticked": "Cookie duration (hours) when remember ticked",
 	"Forget table": "Forget table",
-	"Table %s forgotten. You can now discover it.": "Table %s forgotten. You can now discover it."
+	"Table %s forgotten. You can now discover it.": "Table %s forgotten. You can now discover it.",
+	"No triggers": "No triggers",
+	"List width": "List width",
+	"Number of columns (1-12) allocated to the list view": "Number of columns (1-12) allocated to the list view",
+	"New tenant template": "New tenant template",
+	"Copy site structure for new tenants from this tenant": "Copy site structure for new tenants from this tenant",
+	"Use this link: <a href=\"%s\">%s</a> to revisit your application at any time.": "Use this link: <a href=\"%s\">%s</a> to revisit your application at any time."
 }

package/markup/admin.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module markup/admin
+ * @subcategory markup
+ */
+
 const {
   div,
   hr,
@@ -26,6 +32,12 @@ const Table = require("@saltcorn/data/models/table");
 const View = require("@saltcorn/data/models/view");
 const User = require("@saltcorn/data/models/user");
 
+/**
+ * @param {*} csrf
+ * @param {*} inner
+ * @param {string} action
+ * @returns {*}
+ */
 const restore_backup = (csrf, inner, action = `/admin/restore`) =>
   form(
     {
@@ -45,6 +57,16 @@ const restore_backup = (csrf, inner, action = `/admin/restore`) =>
     })
   );
 
+/**
+ * @param {object} opts
+ * @param {*} opts.role
+ * @param {*} opts.title
+ * @param {*} opts.contents
+ * @param {*} opts.what
+ * @param {*} opts.url
+ * @param {*} opts.req
+ * @returns {object}
+ */
 const add_edit_bar = ({ role, title, contents, what, url, req }) => {
   if (role > 1 && req && req.xhr) return { above: [contents] }; //make sure not put in card
   if (role > 1) return contents;
@@ -61,6 +83,19 @@ const add_edit_bar = ({ role, title, contents, what, url, req }) => {
   } else return { above: [bar, contents] };
 };
 
+/**
+ * @param {object} opts
+ * @param {*} opts.req,
+ * @param {*} opts.res,
+ * @param {*} opts.main_section,
+ * @param {*} opts.main_section_href,
+ * @param {*} opts.sub_sections,
+ * @param {*} opts.active_sub,
+ * @param {*} opts.contents,
+ * @param {*} opts.headers,
+ * @param {*} opts.no_nav_pills,
+ * @param {*} opts.sub2_page,
+ */
 const send_settings_page = ({
   req,
   res,
@@ -132,6 +167,10 @@ const send_settings_page = ({
   });
 };
 
+/**
+ * @param {object} args
+ * @returns {void}
+ */
 const send_infoarch_page = (args) => {
   const tenant_list =
     db.is_it_multi_tenant() &&
@@ -155,6 +194,10 @@ const send_infoarch_page = (args) => {
   });
 };
 
+/**
+ * @param {object} args
+ * @returns {void}
+ */
 const send_users_page = (args) => {
   const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
   return send_settings_page({
@@ -170,6 +213,10 @@ const send_users_page = (args) => {
   });
 };
 
+/**
+ * @param {object} args
+ * @returns {void}
+ */
 const send_events_page = (args) => {
   const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
   return send_settings_page({
@@ -185,6 +232,11 @@ const send_events_page = (args) => {
     ...args,
   });
 };
+
+/**
+ * @param {object} args
+ * @returns {void}
+ */
 const send_admin_page = (args) => {
   const isRoot = db.getTenantSchema() === db.connectObj.default_schema;
   return send_settings_page({
@@ -199,6 +251,11 @@ const send_admin_page = (args) => {
     ...args,
   });
 };
+
+/**
+ * @param {object} key
+ * @returns {Promise<object>}
+ */
 const viewAttributes = async (key) => {
   const [v, table_name] = configTypes[key].type.split(" ");
   const table = await Table.findOne({ name: table_name });
@@ -211,6 +268,11 @@ const viewAttributes = async (key) => {
   };
 };
 
+/**
+ * @param {*} cfgForm
+ * @param {*} req
+ * @returns {void}
+ */
 const flash_restart_if_required = (cfgForm, req) => {
   let restart = false;
   cfgForm.fields.forEach((f) => {
@@ -222,6 +284,10 @@ const flash_restart_if_required = (cfgForm, req) => {
   if (restart) flash_restart(req);
 };
 
+/**
+ * @param {object} req
+ * @returns {void}
+ */
 const flash_restart = (req) => {
   req.flash(
     "warning",
@@ -231,6 +297,13 @@ const flash_restart = (req) => {
   );
 };
 
+/**
+ * @param {object} opts
+ * @param {string[]} opts.field_names
+ * @param {object} opts.req
+ * @param {*} opts.formArgs
+ * @returns {Promise<Form>}
+ */
 const config_fields_form = async ({ field_names, req, ...formArgs }) => {
   const values = {};
   const state = getState();
@@ -243,6 +316,7 @@ const config_fields_form = async ({ field_names, req, ...formArgs }) => {
       continue;
     const isView = (configTypes[name].type || "").startsWith("View ");
     const isRole = configTypes[name].type === "Role";
+    const isTenant = configTypes[name].type === "Tenant";
     const label = configTypes[name].label || name;
     const sublabel = configTypes[name].sublabel || configTypes[name].blurb;
     const roleAttribs = {
@@ -251,6 +325,10 @@ const config_fields_form = async ({ field_names, req, ...formArgs }) => {
         name: `${r.id}`,
       })),
     };
+    const getTenants = async () => {
+      const tens = await db.select("_sc_tenants");
+      return { options: tens.map((t) => t.subdomain) };
+    };
     fields.push({
       name,
       ...configTypes[name],
@@ -258,7 +336,7 @@ const config_fields_form = async ({ field_names, req, ...formArgs }) => {
       sublabel: sublabel ? req.__(sublabel) : undefined,
       disabled: isFixedConfig(name),
       type:
-        isView || isRole
+        isView || isRole || isTenant
           ? "String"
           : configTypes[name].input_type
           ? undefined
@@ -268,6 +346,8 @@ const config_fields_form = async ({ field_names, req, ...formArgs }) => {
         ? await viewAttributes(name)
         : isRole
         ? roleAttribs
+        : isTenant
+        ? await getTenants()
         : configTypes[name].attributes,
     });
   }
@@ -282,6 +362,10 @@ const config_fields_form = async ({ field_names, req, ...formArgs }) => {
   return form;
 };
 
+/**
+ * @param {*} form
+ * @returns {Promise<void>}
+ */
 const save_config_from_form = async (form) => {
   const state = getState();
 
@@ -292,6 +376,9 @@ const save_config_from_form = async (form) => {
   }
 };
 
+/**
+ * @returns {string}
+ */
 const getBaseDomain = () => {
   const base_url = getState().getConfig("base_url");
   if (!base_url) return null;
@@ -303,8 +390,17 @@ const getBaseDomain = () => {
   return domain;
 };
 
+/**
+ * @param {object} req
+ * @param {string} domain
+ * @returns {boolean}
+ */
 const hostname_matches_baseurl = (req, domain) => domain === req.hostname;
 
+/**
+ * @param {string} domain
+ * @returns {string[]}
+ */
 const is_hsts_tld = (domain) => {
   if (!domain) return false;
   const ds = domain.split(".");

package/markup/blockly.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module markup/blockly
+ * @subcategory markup
+ */
+
 const {
   div,
   code,
@@ -9,6 +15,11 @@ const {
 } = require("@saltcorn/markup/tags");
 const db = require("@saltcorn/data/db");
 
+/**
+ * @param {object} opts
+ * @param {string} opts.locale
+ * @returns {string}
+ */
 const blocklyImportScripts = ({ locale }) =>
   script({
     src: "/plugins/pubdeps/base/blockly/6.20210701.0/blockly_compressed.js",
@@ -26,6 +37,10 @@ const blocklyImportScripts = ({ locale }) =>
     src: `/static_assets/${db.connectObj.version_tag}/blockly.js`,
   });
 
+/**
+ * @param {boolean} hasActions 
+ * @returns {string}
+ */
 const blocklyToolbox = (hasActions) => `
   <xml xmlns="https://developers.google.com/blockly/xml" id="toolbox" style="display: none">
     <category name="Control Flow"  categorystyle="loop_category">

package/markup/expression_blurb.js

@@ -1,7 +1,17 @@
+/**
+ * @category server
+ * @module markup/expression_blurb
+ * @subcategory markup
+ */
+
 const { p, code, li, ul, pre } = require("@saltcorn/markup/tags");
 const { contract, is } = require("contractis");
 const { getState } = require("@saltcorn/data/db/state");
 
+/**
+ * @param {*} type 
+ * @returns {*}
+ */
 const toJsType = (type) =>
   ({
     Integer: "number",
@@ -12,6 +22,11 @@ const toJsType = (type) =>
     Color: "string",
   }[type] || type);
 
+/**
+ * @param {*} type 
+ * @param {object[]} fields 
+ * @returns {string[]}
+ */
 const intExamples = (type, fields) => {
   const boolFields = fields.filter((f) => f.type && f.type.name === "Bool");
   const intFields = fields.filter((f) => f.type && f.type.name === "Integer");
@@ -27,6 +42,11 @@ const intExamples = (type, fields) => {
   return exs;
 };
 
+/**
+ * @param {*} type 
+ * @param {object[]} fields 
+ * @returns {string[]}
+ */
 const colorExamples = (type, fields) => {
   const boolFields = fields.filter((f) => f.type && f.type.name === "Bool");
   const exs = [`"#06ab6d1"`];
@@ -36,6 +56,12 @@ const colorExamples = (type, fields) => {
   }
   return exs;
 };
+
+/**
+ * @param {*} type 
+ * @param {object[]} fields 
+ * @returns {string[]}
+ */
 const stringExamples = (type, fields) => {
   const boolFields = fields.filter((f) => f.type && f.type.name === "Bool");
   const strFields = fields.filter((f) => f.type && f.type.name === "String");
@@ -50,6 +76,12 @@ const stringExamples = (type, fields) => {
   }
   return exs;
 };
+
+/**
+ * @param {*} type 
+ * @param {object[]} fields 
+ * @returns {string[]}
+ */
 const floatExamples = (type, fields) => {
   const boolFields = fields.filter((f) => f.type && f.type.name === "Bool");
   const numFields = fields.filter(
@@ -73,6 +105,12 @@ const floatExamples = (type, fields) => {
   }
   return exs;
 };
+
+/**
+ * @param {*} type 
+ * @param {object[]} fields 
+ * @returns {string[]}
+ */
 const boolExamples = (type, fields) => {
   const boolFields = fields.filter((f) => f.type && f.type.name === "Bool");
   const numFields = fields.filter(
@@ -100,6 +138,13 @@ const boolExamples = (type, fields) => {
   return exs;
 };
 
+/**
+ * @param {string} type 
+ * @param {*} stored 
+ * @param {object[]} allFields 
+ * @param {object} req 
+ * @returns {p[]}
+ */
 const expressionBlurb = (type, stored, allFields, req) => {
   const fields = allFields.filter((f) => !f.is_fkey && !f.calculated);
   const funs = getState().functions;

package/markup/forms.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module markup/forms
+ * @subcategory markup
+ */
+
 const {
   form,
   select,
@@ -11,6 +17,14 @@ const {
 } = require("@saltcorn/markup/tags");
 const { csrfField } = require("../routes/utils");
 
+/**
+ * @param {object} opts
+ * @param {string} opts.url
+ * @param {Role} opts.current_role
+ * @param {Role[]} opts.roles
+ * @param {object} opts.req
+ * @returns {Form}
+ */
 const editRoleForm = ({ url, current_role, roles, req }) =>
   form(
     {
@@ -32,6 +46,10 @@ const editRoleForm = ({ url, current_role, roles, req }) =>
     )
   );
 
+/**
+ * @param {object} req 
+ * @returns {Form}
+ */
 const fileUploadForm = (req) =>
   form(
     {
@@ -50,6 +68,12 @@ const fileUploadForm = (req) =>
     })
   );
 
+/**
+ * @param {string} wizardTitle 
+ * @param {*} wf 
+ * @param {object} wfres 
+ * @returns {string}
+ */
 const wizardCardTitle = (wizardTitle, wf, wfres) =>
   `${wizardTitle}: ${wfres.stepName}`;
 

package/markup/index.js

@@ -0,0 +1,7 @@
+// for the jsdoc documentation
+/**
+ *
+ * @category server
+ * @module markup/index
+ * @subcategory markup
+ */

package/markup/plugin-store.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module markup/plugin-store
+ * @subcategory markup
+ */
+
 const {
   h5,
   h4,
@@ -17,9 +23,20 @@ const {
   strong,
 } = require("@saltcorn/markup/tags");
 const { link } = require("@saltcorn/markup");
+
+/**
+ * @param {object} args 
+ * @returns {string}
+ */
 const show_function_arguments = (args) =>
   (args || []).map(({ name, type }) => `${name}: ${type}`).join(", ");
 
+/**
+ * @param {object} plugin 
+ * @param {string} key 
+ * @param {object} def 
+ * @returns {*}
+ */
 const withCfg = (plugin, key, def) =>
   plugin.plugin_module.configuration_workflow
     ? plugin.plugin_module[key]
@@ -27,6 +44,11 @@ const withCfg = (plugin, key, def) =>
       : def
     : plugin.plugin_module[key] || def;
 
+/**
+ * @param {object} plugin 
+ * @param {object} req 
+ * @returns {*}
+ */
 const plugin_types_info_card = (plugin, req) => ({
   type: "card",
   title: req.__("Types"),
@@ -35,6 +57,11 @@ const plugin_types_info_card = (plugin, req) => ({
   ),
 });
 
+/**
+ * @param {object} plugin 
+ * @param {object} req 
+ * @returns {*}
+ */
 const plugin_functions_info_card = (plugin, req) => ({
   type: "card",
   title: req.__("Functions"),
@@ -53,6 +80,11 @@ const plugin_functions_info_card = (plugin, req) => ({
     .join("<hr>"),
 });
 
+/**
+ * @param {object} plugin 
+ * @param {object} req 
+ * @returns {*}
+ */
 const plugin_viewtemplates_info_card = (plugin, req) => ({
   type: "card",
   title: req.__("View templates"),
@@ -61,6 +93,10 @@ const plugin_viewtemplates_info_card = (plugin, req) => ({
     .join("<hr>"),
 });
 
+/**
+ * @param {object} repo 
+ * @returns {*}
+ */
 const showRepository = (repo) =>
   !repo
     ? repo

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@saltcorn/server",
-  "version": "0.6.1-beta.0",
+  "version": "0.6.1",
   "description": "Server app for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
-    "@saltcorn/base-plugin": "0.6.1-beta.0",
-    "@saltcorn/builder": "0.6.1-beta.0",
-    "@saltcorn/data": "0.6.1-beta.0",
+    "@saltcorn/base-plugin": "0.6.1",
+    "@saltcorn/builder": "0.6.1",
+    "@saltcorn/data": "0.6.1",
     "greenlock-express": "^4.0.3",
-    "@saltcorn/markup": "0.6.1-beta.0",
-    "@saltcorn/sbadmin2": "0.6.1-beta.0",
+    "@saltcorn/markup": "0.6.1",
+    "@saltcorn/sbadmin2": "0.6.1",
     "@socket.io/cluster-adapter": "^0.1.0",
     "@socket.io/sticky": "^1.0.1",
     "connect-flash": "^0.1.1",

package/public/saltcorn-builder.css

@@ -1,5 +1,6 @@
 .canvas:empty {
   min-height: 20px;
+  min-width: 10px;
 }
 
 span.is-html-block {

package/public/saltcorn.js

@@ -341,7 +341,11 @@ function pjax_to(href) {
         setTimeout(() => {
           loadPage = true;
         }, 0);
-
+        if (res.includes("<!--SCPT:")) {
+          const start = res.indexOf("<!--SCPT:");
+          const end = res.indexOf("-->", start);
+          document.title = res.substring(start + 9, end);
+        }
         $("#page-inner-content").html(res);
         initialize_page();
       },

package/routes/actions.js

@@ -1,6 +1,8 @@
 /**
  * Actions (Triggers) Handler
- *
+ * @category server
+ * @module routes/actions
+ * @subcategory routes
  */
 const Router = require("express-promise-router");
 const {
@@ -12,6 +14,13 @@ const {
 const { getState } = require("@saltcorn/data/db/state");
 const Trigger = require("@saltcorn/data/models/trigger");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace actionsRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 const {
@@ -55,6 +64,9 @@ const {
   blocklyToolbox,
 } = require("../markup/blockly.js");
 
+/**
+ * @returns {Promise<object>}
+ */
 const getActions = async () => {
   return Object.entries(getState().actions).map(([k, v]) => {
     const hasConfig = !!v.configFields;
@@ -66,8 +78,12 @@ const getActions = async () => {
     };
   });
 };
+
 /**
  * Show list of Actions (Triggers) (HTTP GET)
+ * @name get
+ * @function
+ * @memberof module:routes/actions~actionsRouter
  */
 router.get(
   "/",
@@ -263,8 +279,12 @@ const triggerForm = async (req, trigger) => {
   //  }
   return form;
 };
+
 /**
  * Show form to create new Trigger (get)
+ * @name get/new
+ * @function
+ * @memberof module:routes/actions~actionsRouter
  */
 router.get(
   "/new",
@@ -285,8 +305,12 @@ router.get(
     });
   })
 );
+
 /**
  * Show form to Edit existing Trigger (get)
+ * @name get/edit/:id
+ * @function
+ * @memberof module:routes/actions~actionsRouter
  */
 router.get(
   "/edit/:id",
@@ -311,8 +335,12 @@ router.get(
     });
   })
 );
+
 /**
  * POST for new or existing trigger (Save trigger)
+ * @name post/new
+ * @function
+ * @memberof module:routes/actions~actionsRouter
  */
 router.post(
   "/new",
@@ -347,8 +375,12 @@ router.post(
     }
   })
 );
+
 /**
  * POST for existing trigger (Save trigger)
+ * @name /edit/:id
+ * @function
+ * @memberof module:routes/actions~actionsRouter
  */
 router.post(
   "/edit/:id",
@@ -381,6 +413,7 @@ router.post(
     }
   })
 );
+
 /**
  * Edit Trigger configuration (GET)
  *
@@ -388,6 +421,9 @@ router.post(
  *
  * - get configuration fields
  * - create form
+ * @name get/configure/:id
+ * @function
+ * @memberof module:routes/actions~actionsRouter
  */
 router.get(
   "/configure/:id",
@@ -498,8 +534,12 @@ router.get(
     }
   })
 );
+
 /**
  * Configure Trigger (POST)
+ * @name post/configure/:id
+ * @function
+ * @memberof module:routes/actions~actionsRouter
  */
 router.post(
   "/configure/:id",
@@ -537,6 +577,12 @@ router.post(
     }
   })
 );
+
+/**
+ * @name post/delete/:id
+ * @function
+ * @memberof module:routes/actions~actionsRouter
+ */
 router.post(
   "/delete/:id",
   setTenant,
@@ -548,6 +594,12 @@ router.post(
     res.redirect(`/actions/`);
   })
 );
+
+/**
+ * @name get/testrun/:id
+ * @function
+ * @memberof module:routes/actions~actionsRouter
+ */
 router.get(
   "/testrun/:id",
   setTenant,