@saltcorn/server 0.6.1-beta.0 → 0.6.1

package/routes/pageedit.js

@@ -1,3 +1,8 @@
+/**
+ * @category server
+ * @module routes/pageedit
+ * @subcategory routes
+ */
 const Router = require("express-promise-router");
 
 const View = require("@saltcorn/data/models/view");
@@ -30,9 +35,22 @@ const { getActionConfigFields } = require("@saltcorn/data/plugin-helper");
 const { editRoleForm, wizardCardTitle } = require("../markup/forms.js");
 const Library = require("@saltcorn/data/models/library");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace pageeditRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {object} page 
+ * @param {*} roles 
+ * @param {object} req 
+ * @returns {Form}
+ */
 const editPageRoleForm = (page, roles, req) =>
   editRoleForm({
     url: `/pageedit/setrole/${page.id}`,
@@ -41,6 +59,11 @@ const editPageRoleForm = (page, roles, req) =>
     req,
   });
 
+/**
+ * @param {object} page 
+ * @param {object} req 
+ * @returns {string}
+ */
 const page_dropdown = (page, req) =>
   settingsDropdown(`dropdownMenuButton${page.id}`, [
     a(
@@ -77,6 +100,11 @@ const page_dropdown = (page, req) =>
     ),
   ]);
 
+/**
+ * 
+ * @param {object} req 
+ * @returns {Promise<Form>}
+ */
 const pagePropertiesForm = async (req) => {
   const roles = await User.get_roles();
 
@@ -117,6 +145,12 @@ const pagePropertiesForm = async (req) => {
   return form;
 };
 
+/**
+ * 
+ * @param {object} req 
+ * @param {object} context 
+ * @returns {Promise<object>}
+ */
 const pageBuilderData = async (req, context) => {
   const views = await View.find();
   const pages = await Page.find();
@@ -190,6 +224,12 @@ const pageBuilderData = async (req, context) => {
   };
 };
 
+/**
+ * @param {*} rows 
+ * @param {*} roles 
+ * @param {object} req 
+ * @returns {div}
+ */
 const getPageList = (rows, roles, req) => {
   return div(
     mkTable(
@@ -223,12 +263,13 @@ const getPageList = (rows, roles, req) => {
     )
   );
 };
+
 /**
  * Root pages configuration Form
  * Allows to configure root page for each role
- * @param pages - list of pages
- * @param roles - list of roles
- * @param req - request
+ * @param {object[]} pages list of pages
+ * @param {object[]} roles - list of roles
+ * @param {object} req - request
  * @returns {Form} return Form
  */
 const getRootPageForm = (pages, roles, req) => {
@@ -258,6 +299,13 @@ const getRootPageForm = (pages, roles, req) => {
   }
   return form;
 };
+
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -289,6 +337,14 @@ router.get(
     });
   })
 );
+
+/**
+ * @param {*} contents 
+ * @param {*} noCard 
+ * @param {object} req 
+ * @param {*} page 
+ * @returns {*}
+ */
 const wrap = (contents, noCard, req, page) => ({
   above: [
     {
@@ -308,6 +364,12 @@ const wrap = (contents, noCard, req, page) => ({
   ],
 });
 
+/**
+ * @name get/edit-properties/:pagename
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.get(
   "/edit-properties/:pagename",
   setTenant,
@@ -330,6 +392,13 @@ router.get(
     }
   })
 );
+
+/**
+ * @name get/new
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.get(
   "/new",
   setTenant,
@@ -343,6 +412,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/edit-properties
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/edit-properties",
   setTenant,
@@ -373,6 +448,12 @@ router.post(
   })
 );
 
+/**
+ * @name get/edit/:pagename
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.get(
   "/edit/:pagename",
   setTenant,
@@ -408,6 +489,13 @@ router.get(
     }
   })
 );
+
+/**
+ * @name post/edit/:pagename
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/edit/:pagename",
   setTenant,
@@ -433,6 +521,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/savebuilder/:id
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/savebuilder/:id",
   setTenant,
@@ -449,6 +543,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/delete/:id
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/delete/:id",
   setTenant,
@@ -462,6 +562,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/set_root_page
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/set_root_page",
   setTenant,
@@ -484,6 +590,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/add-to-menu/:id
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/add-to-menu/:id",
   setTenant,
@@ -507,6 +619,13 @@ router.post(
     res.redirect(`/pageedit`);
   })
 );
+
+/**
+ * @name post/clone/:id
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/clone/:id",
   setTenant,
@@ -522,6 +641,13 @@ router.post(
     res.redirect(`/pageedit`);
   })
 );
+
+/**
+ * @name post/setrole/:id
+ * @function
+ * @memberof module:routes/pageedit~pageeditRouter
+ * @function
+ */
 router.post(
   "/setrole/:id",
   setTenant,

package/routes/plugins.js

@@ -1,5 +1,8 @@
 /**
  * Plugin Handler for Admin zone
+ * @category server 
+ * @module routes/plugins
+ * @subcategory routes
  */
 
 const Router = require("express-promise-router");
@@ -49,12 +52,20 @@ const path = require("path");
 const { get_latest_npm_version } = require("@saltcorn/data/models/config");
 const { flash_restart } = require("../markup/admin.js");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace pluginsRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
+
 /**
  * Plugin Form Creation
- * @param req
- * @param plugin
+ * @param {object} req
+ * @param {object} plugin
  * @returns {Form}
  */
 const pluginForm = (req, plugin) => {
@@ -119,18 +130,20 @@ const pluginForm = (req, plugin) => {
   }
   return form;
 };
+
 /**
  * Returns true if plugin has own theme
- * @param name -plugin name
+ * @param {string} name plugin name
  * @returns {*|boolean}
  */
 const local_has_theme = (name) => {
   const mod = getState().plugins[name];
   return mod ? mod.layout : false;
 };
+
 /**
  * Get Pluging store itmes
- * @returns {Promise<*[]>}
+ * @returns {Promise<Object[]>}
  */
 const get_store_items = async () => {
   const installed_plugins = await Plugin.find({});
@@ -175,6 +188,11 @@ const get_store_items = async () => {
   );
 };
 
+/**
+ * @param {object} req 
+ * @param {object} row 
+ * @returns {a|string}
+ */
 const cfg_link = (req, row) => {
   let plugin = getState().plugins[row.name];
   let linknm = row.name;
@@ -200,6 +218,11 @@ const cfg_link = (req, row) => {
   else return "";
 };
 
+/**
+ * @param {object} req 
+ * @param {object} row 
+ * @returns {a}
+ */
 const info_link = (req, row) =>
   a(
     {
@@ -211,9 +234,18 @@ const info_link = (req, row) =>
     '<i class="far fa-question-circle"></i>'
   );
 
-const badge = (title) =>
+/**
+ * @param {string} title 
+ * @returns {span}
+ */
+  const badge = (title) =>
   span({ class: "badge badge-secondary plugin-store" }, title);
 
+/**
+ * 
+ * @param {object} req 
+ * @returns {function}
+ */
 const store_item_html = (req) => (item) => ({
   type: "card",
   title: item.name,
@@ -300,6 +332,11 @@ const store_item_html = (req) => (item) => ({
     )
   ),
 });
+
+/**
+ * @param {object} req 
+ * @returns {ul}
+ */
 const storeNavPills = (req) => {
   const link = (txt) =>
     li(
@@ -327,20 +364,41 @@ const storeNavPills = (req) => {
   );
 };
 
+/**
+ * @param {object[]} items 
+ * @param {object} query 
+ * @returns {object[]}
+ */
 const filter_items = (items, query) => {
   const in_set = filter_items_set(items, query);
   if (!query.q) return in_set;
   return in_set.filter((p) => satisfy_q(p, query.q.toLowerCase()));
 };
 
+/**
+ * @param {string} s 
+ * @param {string} q 
+ * @returns {boolean}
+ */
 const match_string = (s, q) => {
   if (!s || !q) return false;
   return s.toLowerCase().includes(q);
 };
 
+/**
+ * @param {string} p
+ * @param {string} q 
+ * @returns {boolean}
+ */
 const satisfy_q = (p, q) => {
   return match_string(p.name, q) || match_string(p.description, q);
 };
+
+/**
+ * @param {object[]} items 
+ * @param {object} query 
+ * @returns {object[]}
+ */
 const filter_items_set = (items, query) => {
   switch (query.set) {
     case "plugins":
@@ -355,6 +413,11 @@ const filter_items_set = (items, query) => {
       return items;
   }
 };
+
+/**
+ * @param {object} req 
+ * @returns {div}
+ */
 const store_actions_dropdown = (req) =>
   div(
     { class: "dropdown" },
@@ -418,6 +481,12 @@ const store_actions_dropdown = (req) =>
       //create pack
     )
   );
+
+/**
+ * @param {object[]} items 
+ * @param {object} req 
+ * @returns {object}
+ */
 const plugin_store_html = (items, req) => {
   return {
     above: [
@@ -448,6 +517,12 @@ const plugin_store_html = (items, req) => {
   };
 };
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -459,6 +534,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/configure/:name
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/configure/:name",
   setTenant,
@@ -485,6 +566,13 @@ router.get(
     );
   })
 );
+
+/**
+ * @name post/configure/:name
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.post(
   "/configure/:name",
   setTenant,
@@ -520,6 +608,13 @@ router.post(
     }
   })
 );
+
+/**
+ * @name get/new
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/new",
   setTenant,
@@ -544,6 +639,13 @@ router.get(
     });
   })
 );
+
+/**
+ * @name get/public/:plugin/*
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/public/:plugin/*",
   setTenant,
@@ -564,6 +666,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/pubdeps/:plugin/:dependency/:version/*
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/pubdeps/:plugin/:dependency/:version/*",
   setTenant,
@@ -591,6 +699,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/info/:name
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/info/:name",
   setTenant,
@@ -694,6 +808,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/refresh
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/refresh",
   setTenant,
@@ -712,6 +832,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/upgrade
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/upgrade",
   setTenant,
@@ -727,6 +853,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/upgrade-plugin/:name
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.get(
   "/upgrade-plugin/:name",
   setTenant,
@@ -741,6 +873,13 @@ router.get(
     res.redirect(`/plugins/info/${plugin.name}`);
   })
 );
+
+/**
+ * @name post
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.post(
   "/",
   setTenant,
@@ -771,6 +910,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/delete/:name
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.post(
   "/delete/:name",
   setTenant,
@@ -801,6 +946,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/install/:name
+ * @function
+ * @memberof module:routes/plugins~pluginsRouter
+ * @function
+ */
 router.post(
   "/install/:name",
   setTenant,