@saltcorn/server 0.6.1-beta.0 → 0.6.1

package/routes/fields.js

@@ -1,6 +1,9 @@
 /**
  *
  * Field Router
+ * @category server
+ * @module routes/fields
+ * @subcategory routes
  */
 
 const Router = require("express-promise-router");
@@ -23,9 +26,25 @@ const { setTenant, isAdmin, error_catcher } = require("./utils.js");
 const expressionBlurb = require("../markup/expression_blurb");
 const { readState } = require("@saltcorn/data/plugin-helper");
 const { wizardCardTitle } = require("../markup/forms.js");
+
+/**
+ * @type {object}
+ * @const
+ * @namespace fieldsRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {object} req 
+ * @param {*} fkey_opts 
+ * @param {*} existing_names 
+ * @param {*} id 
+ * @param {*} hasData 
+ * @returns {Promise<Form>}
+ */
 const fieldForm = async (req, fkey_opts, existing_names, id, hasData) => {
   let isPrimary = false;
   let primaryTypes = Object.entries(getState().types)
@@ -116,22 +135,41 @@ const fieldForm = async (req, fkey_opts, existing_names, id, hasData) => {
     ],
   });
 };
+
+/**
+ * @param {string} ctxType 
+ * @returns {object}
+ */
 const calcFieldType = (ctxType) =>
   ctxType.startsWith("Key to")
     ? { type: "Key", reftable_name: ctxType.replace("Key to ", "") }
     : { type: ctxType };
 
+/**
+ * @param {*} attrs 
+ * @param {object} req 
+ * @returns {*}
+ */
 const translateAttributes = (attrs, req) =>
   Array.isArray(attrs)
     ? attrs.map((attr) => translateAttribute(attr, req))
     : attrs;
 
+/**
+ * @param {*} attr 
+ * @param {*} req 
+ * @returns {object}
+ */
 const translateAttribute = (attr, req) => {
   const res = { ...attr };
   if (res.sublabel) res.sublabel = req.__(res.sublabel);
   return res;
 };
 
+/**
+ * @param {*} req 
+ * @returns {Workflow}
+ */
 const fieldFlow = (req) =>
   new Workflow({
     action: "/field",
@@ -372,6 +410,13 @@ const fieldFlow = (req) =>
       },
     ],
   });
+
+/**
+ * @name get/:id
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.get(
   "/:id",
   setTenant,
@@ -419,6 +464,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/new/:table_id
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.get(
   "/new/:table_id",
   setTenant,
@@ -450,6 +501,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/delete/:id
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.post(
   "/delete/:id",
   setTenant,
@@ -470,6 +527,12 @@ router.post(
   })
 );
 
+/**
+ * @name post
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.post(
   "/",
   setTenant,
@@ -513,6 +576,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/test-formula
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.post(
   "/test-formula",
   setTenant,
@@ -544,6 +613,13 @@ router.post(
     }
   })
 );
+
+/**
+ * @name post/show-calculated/:tableName/:fieldName/:fieldview
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.post(
   "/show-calculated/:tableName/:fieldName/:fieldview",
   setTenant,
@@ -573,6 +649,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/preview/:tableName/:fieldName/:fieldview
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.post(
   "/preview/:tableName/:fieldName/:fieldview",
   setTenant,
@@ -632,6 +714,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/preview/:tableName/:fieldName/
+ * @function
+ * @memberof module:routes/fields~fieldsRouter
+ * @function
+ */
 router.post(
   "/preview/:tableName/:fieldName/",
   setTenant,

package/routes/files.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/files
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 const File = require("@saltcorn/data/models/file");
 const User = require("@saltcorn/data/models/user");
@@ -32,9 +38,22 @@ const { csrfField } = require("./utils");
 const { editRoleForm, fileUploadForm } = require("../markup/forms.js");
 const { strictParseInt } = require("@saltcorn/data/plugin-helper");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace filesRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {*} file 
+ * @param {*} roles 
+ * @param {*} req 
+ * @returns {Form}
+ */
 const editFileRoleForm = (file, roles, req) =>
   editRoleForm({
     url: `/files/setrole/${file.id}`,
@@ -43,6 +62,12 @@ const editFileRoleForm = (file, roles, req) =>
     req,
   });
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/files~filesRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -104,6 +129,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/download/:id
+ * @function
+ * @memberof module:routes/files~filesRouter
+ * @function
+ */
 router.get(
   "/download/:id",
   setTenant,
@@ -122,6 +153,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/serve/:id
+ * @function
+ * @memberof module:routes/files~filesRouter
+ * @function
+ */
 router.get(
   "/serve/:id",
   setTenant,
@@ -152,6 +189,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/setrole/:id
+ * @function
+ * @memberof module:routes/files~filesRouter
+ * @function
+ */
 router.post(
   "/setrole/:id",
   setTenant,
@@ -173,6 +216,13 @@ router.post(
     res.redirect("/files");
   })
 );
+
+/**
+ * @name post/setname/:id
+ * @function
+ * @memberof module:routes/files~filesRouter
+ * @function
+ */
 router.post(
   "/setname/:id",
   setTenant,
@@ -186,6 +236,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/upload
+ * @function
+ * @memberof module:routes/files~filesRouter
+ * @function
+ */
 router.post(
   "/upload",
   setTenant,
@@ -233,6 +289,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/delete/:id
+ * @function
+ * @memberof module:routes/files~filesRouter
+ * @function
+ */
 router.post(
   "/delete/:id",
   setTenant,

package/routes/homepage.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/homepage
+ * @subcategory routes
+ */
+
 const { getState } = require("@saltcorn/data/db/state");
 const db = require("@saltcorn/data/db");
 const View = require("@saltcorn/data/models/view");
@@ -14,6 +20,11 @@ const packagejson = require("../package.json");
 const Trigger = require("@saltcorn/data/models/trigger");
 const { fileUploadForm } = require("../markup/forms");
 
+/**
+ * @param {*} tables
+ * @param {object} req
+ * @returns {Table}
+ */
 const tableTable = (tables, req) =>
   mkTable(
     [
@@ -26,6 +37,11 @@ const tableTable = (tables, req) =>
     tables
   );
 
+/**
+ * @param {*} tables
+ * @param {object} req
+ * @returns {object}
+ */
 const tableCard = (tables, req) => ({
   type: "card",
   class: "welcome-page-entity-list",
@@ -50,6 +66,11 @@ const tableCard = (tables, req) => ({
   ),
 });
 
+/**
+ * @param {*} views
+ * @param {object} req
+ * @returns {Table}
+ */
 const viewTable = (views, req) =>
   mkTable(
     [
@@ -66,6 +87,11 @@ const viewTable = (views, req) =>
     views
   );
 
+/**
+ * @param {*} views
+ * @param {object} req
+ * @returns {object}
+ */
 const viewCard = (views, req) => ({
   type: "card",
   title: link("/viewedit", req.__("Views")),
@@ -91,6 +117,12 @@ const viewCard = (views, req) => ({
     )
   ),
 });
+
+/**
+ * @param {*} pages
+ * @param {object} req
+ * @returns {Table}
+ */
 const pageTable = (pages, req) =>
   mkTable(
     [
@@ -106,6 +138,12 @@ const pageTable = (pages, req) =>
     ],
     pages
   );
+
+/**
+ * @param {*} pages
+ * @param {object} req
+ * @returns {object}
+ */
 const pageCard = (pages, req) => ({
   type: "card",
   title: link("/pageedit", req.__("Pages")),
@@ -133,8 +171,12 @@ const pageCard = (pages, req) => ({
   ),
 });
 
+/**
+ * @param {object} req
+ * @returns {Promise<div>}
+ */
 const filesTab = async (req) => {
-  const files = await File.find({}, { orderBy: "filename" });
+  const files = await File.find({}, { orderBy: "filename", cached: true });
   return div(
     files.length == 0
       ? p(req.__("No files"))
@@ -152,13 +194,12 @@ const filesTab = async (req) => {
     fileUploadForm(req)
   );
 };
-const usersTab = async (req) => {
-  const users = await User.find({}, { orderBy: "id" });
-  const roles = await User.get_roles();
-  var roleMap = {};
-  roles.forEach((r) => {
-    roleMap[r.id] = r.role;
-  });
+
+/**
+ * @param {object} req
+ * @returns {Promise<div>}
+ */
+const usersTab = async (req, users, roleMap) => {
   return div(
     mkTable(
       [
@@ -172,15 +213,19 @@ const usersTab = async (req) => {
       users
     ),
     a(
-      { href: `/useradmin/new`, class: "btn btn-secondary" },
+      { href: `/useradmin/new`, class: "btn btn-secondary my-3" },
       req.__("Create user")
     )
   );
 };
-const actionsTab = async (req) => {
-  const triggers = await Trigger.findAllWithTableName();
 
+/**
+ * @param {object} req
+ * @returns {Promise<div>}
+ */
+const actionsTab = async (req, triggers) => {
   return div(
+    { class: "pb-3" },
     triggers.length <= 1 &&
       p(
         { class: "mt-2 pr-2" },
@@ -207,21 +252,91 @@ const actionsTab = async (req) => {
           triggers
         ),
     a(
-      { href: "/actions/new", class: "btn btn-secondary btn-smj" },
+      { href: "/actions/new", class: "btn btn-secondary my-3" },
       req.__("Add trigger")
     )
   );
 };
+const packTab = (req, packlist) =>
+  div(
+    { class: "pb-3 pt-2 pr-4" },
+    p(req.__("Instead of building, get up and running in no time with packs")),
+    p(
+      { class: "font-italic" },
+      req.__(
+        "Packs are collections of tables, views and plugins that give you a full application which you can then edit to suit your needs."
+      )
+    ),
+    mkTable(
+      [
+        { label: req.__("Name"), key: "name" },
+        {
+          label: req.__("Description"),
+          key: "description",
+        },
+      ],
+      packlist,
+      { noHeader: true }
+    ),
+    a(
+      { href: `/plugins?set=packs`, class: "btn btn-primary" },
+      req.__("Go to pack store »")
+    )
+  );
+
+const helpCard = (req) =>
+  div(
+    { class: "pb-3 pt-2 pr-4" },
+    p(req.__("Confused?")),
+    p(
+      req.__(
+        "The Wiki contains the documentation and tutorials on installing and using Saltcorn"
+      )
+    ),
+    a(
+      {
+        href: `https://wiki.saltcorn.com/`,
+        class: "btn btn-primary",
+      },
+      req.__("Go to Wiki »")
+    ),
+    p(req.__("The YouTube channel has some video tutorials")),
+    a(
+      {
+        href: `https://www.youtube.com/channel/UCBOpAcH8ep7ESbuocxcq0KQ`,
+        class: "btn btn-secondary",
+      },
+      req.__("Go to YouTube »")
+    ),
+    div(
+      { class: "mt-3" },
+      a(
+        { href: `https://blog.saltcorn.com/` },
+        req.__("What's new? Read the blog »")
+      )
+    )
+  );
+
+/**
+ * @param {object} req
+ * @returns {Promise<object>}
+ */
 const welcome_page = async (req) => {
   const packs_available = await fetch_available_packs();
   const packlist = [
     ...packs_available.slice(0, 5),
     { name: req.__("More..."), description: "" },
   ];
-  const tables = await Table.find({}, { orderBy: "name" });
-  const views = await View.find({});
-  const pages = await Page.find({});
-
+  const tables = await Table.find({}, { cached: true });
+  const views = await View.find({}, { cached: true });
+  const pages = await Page.find({}, { cached: true });
+  const triggers = await Trigger.findAllWithTableName();
+  const users = await User.find({}, { orderBy: "id" });
+  const roles = await User.get_roles();
+  let roleMap = {};
+  roles.forEach((r) => {
+    roleMap[r.id] = r.role;
+  });
   return {
     above: [
       {
@@ -236,75 +351,37 @@ const welcome_page = async (req) => {
           {
             type: "card",
             //title: req.__("Install pack"),
-            tabContents: {
-              Packs: div(
-                p(
-                  req.__(
-                    "Instead of building, get up and running in no time with packs"
-                  )
-                ),
-                p(
-                  { class: "font-italic" },
-                  req.__(
-                    "Packs are collections of tables, views and plugins that give you a full application which you can then edit to suit your needs."
-                  )
-                ),
-                mkTable(
-                  [
-                    { label: req.__("Name"), key: "name" },
-                    {
-                      label: req.__("Description"),
-                      key: "description",
-                    },
-                  ],
-                  packlist,
-                  { noHeader: true }
-                ),
-                a(
-                  { href: `/plugins?set=packs`, class: "btn btn-primary" },
-                  req.__("Go to pack store »")
-                )
-              ),
-              Triggers: await actionsTab(req),
-              Files: await filesTab(req),
-            },
+            bodyClass: "py-0 pr-0",
+            class: "welcome-page-entity-list",
+
+            tabContents:
+              triggers.length > 0
+                ? {
+                    Triggers: await actionsTab(req, triggers),
+                    Files: await filesTab(req),
+                    Packs: packTab(req, packlist),
+                  }
+                : {
+                    Packs: packTab(req, packlist),
+                    Triggers: await actionsTab(req, triggers),
+                    Files: await filesTab(req),
+                  },
           },
           {
             type: "card",
             //title: req.__("Learn"),
-            tabContents: {
-              Help: div(
-                p(req.__("Confused?")),
-                p(
-                  req.__(
-                    "The Wiki contains the documentation and tutorials on installing and using Saltcorn"
-                  )
-                ),
-                a(
-                  {
-                    href: `https://wiki.saltcorn.com/`,
-                    class: "btn btn-primary",
-                  },
-                  req.__("Go to Wiki »")
-                ),
-                p(req.__("The YouTube channel has some video tutorials")),
-                a(
-                  {
-                    href: `https://www.youtube.com/channel/UCBOpAcH8ep7ESbuocxcq0KQ`,
-                    class: "btn btn-secondary",
+            bodyClass: "py-0 pr-0",
+            class: "welcome-page-entity-list",
+            tabContents:
+              users.length > 4
+                ? {
+                    Users: await usersTab(req, users, roleMap),
+                    Help: helpCard(req),
+                  }
+                : {
+                    Help: helpCard(req),
+                    Users: await usersTab(req, users, roleMap),
                   },
-                  req.__("Go to YouTube »")
-                ),
-                div(
-                  { class: "mt-3" },
-                  a(
-                    { href: `https://blog.saltcorn.com/` },
-                    req.__("What's new? Read the blog »")
-                  )
-                )
-              ),
-              Users: await usersTab(req),
-            },
           },
         ],
       },
@@ -312,6 +389,11 @@ const welcome_page = async (req) => {
   };
 };
 
+/**
+ * @param {object} req
+ * @param {object} res
+ * @returns {Promise<void>}
+ */
 const no_views_logged_in = async (req, res) => {
   const role = req.isAuthenticated() ? req.user.role_id : 10;
   if (role > 1 || req.user.tenant !== db.getTenantSchema())
@@ -337,6 +419,12 @@ const no_views_logged_in = async (req, res) => {
   }
 };
 
+/**
+ * @param {number} role_id
+ * @param {object} res
+ * @param {object} req
+ * @returns {Promise<boolean>}
+ */
 const get_config_response = async (role_id, res, req) => {
   const modernCfg = getState().getConfig("home_page_by_role", false);
   const legacy_role = { 10: "public", 8: "user", 4: "staff", 1: "admin" }[
@@ -360,6 +448,13 @@ const get_config_response = async (role_id, res, req) => {
     return true;
   }
 };
+
+/**
+ * Function assigned to 'module.exports'.
+ * @param {object} req
+ * @param {object} res
+ * @returns {Promise<void>}
+ */
 module.exports = async (req, res) => {
   const isAuth = req.isAuthenticated();
   const role_id = req.user ? req.user.role_id : 10;

package/routes/index.js

@@ -1,6 +1,8 @@
 /**
  * Index is Main Router of App
- * @type {module:express-promise-router}
+ * @category server
+ * @module routes/index
+ * @subcategory routes
  */
 const table = require("./tables");
 const field = require("./fields");
@@ -32,6 +34,10 @@ const useradmin = require("../auth/admin");
 const roleadmin = require("../auth/roleadmin");
 const scapi = require("./scapi");
 
+/**
+ * Function assigned to 'module.exports'
+ * @returns {void}
+ */
 module.exports = (app) => {
   app.use("/table", table);
   app.use("/field", field);