@saltcorn/server 0.6.1-beta.0 → 0.6.1

package/routes/infoarch.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/infoarch
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 const { isAdmin, setTenant, error_catcher } = require("./utils.js");
 const {
@@ -10,9 +16,23 @@ const { getState } = require("@saltcorn/data/db/state");
 const { div, a, i, text } = require("@saltcorn/markup/tags");
 const { mkTable, renderForm } = require("@saltcorn/markup");
 const Form = require("@saltcorn/data/models/form");
+
+/**
+ * @type {object}
+ * @const
+ * @namespace infoarchRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/infoarch~infoarchRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -21,6 +41,11 @@ router.get(
     res.redirect(`/menu`);
   })
 );
+
+/**
+ * @param {object} req 
+ * @returns {Form}
+ */
 const languageForm = (req) =>
   new Form({
     action: "/site-structure/localizer/save-lang",
@@ -49,6 +74,13 @@ const languageForm = (req) =>
       },
     ],
   });
+
+/**
+ * @name get/localizer
+ * @function
+ * @memberof module:routes/infoarch~infoarchRouter
+ * @function
+ */
 router.get(
   "/localizer",
   setTenant,
@@ -103,6 +135,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/localizer/add-lang
+ * @function
+ * @memberof module:routes/infoarch~infoarchRouter
+ * @function
+ */
 router.get(
   "/localizer/add-lang",
   setTenant,
@@ -121,6 +159,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/localizer/edit/:lang
+ * @function
+ * @memberof module:routes/infoarch~infoarchRouter
+ * @function
+ */
 router.get(
   "/localizer/edit/:lang",
   setTenant,
@@ -180,6 +224,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/localizer/save-string/:lang/:defstring
+ * @function
+ * @memberof module:routes/infoarch~infoarchRouter
+ * @function
+ */
 router.post(
   "/localizer/save-string/:lang/:defstring",
   setTenant,
@@ -196,6 +246,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/localizer/save-lang
+ * @function
+ * @memberof module:routes/infoarch~infoarchRouter
+ * @function
+ */
 router.post(
   "/localizer/save-lang",
   setTenant,

package/routes/library.js

@@ -1,12 +1,32 @@
+/**
+ * @category server
+ * @module routes/library
+ * @subcategory routes
+ */
+
 const Library = require("@saltcorn/data/models/library");
 const Router = require("express-promise-router");
 const { setTenant, isAdmin, error_catcher } = require("./utils.js");
 const { send_infoarch_page } = require("../markup/admin.js");
 const { mkTable, post_delete_btn } = require("@saltcorn/markup");
 const { i } = require("@saltcorn/markup/tags");
+
+/**
+ * @type {object}
+ * @const
+ * @namespace libraryRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name post/savefrombuilder
+ * @function
+ * @memberof module:routes/library~libraryRouter
+ * @function
+ */
 router.post(
   "/savefrombuilder",
   setTenant,
@@ -17,6 +37,12 @@ router.post(
   })
 );
 
+/**
+ * @name get/list
+ * @function
+ * @memberof module:routes/library~libraryRouter
+ * @function
+ */
 router.get(
   "/list",
   setTenant,
@@ -55,6 +81,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/delete/:id
+ * @function
+ * @memberof module:routes/library~libraryRouter
+ * @function
+ */
 router.post(
   "/delete/:id",
   setTenant,

package/routes/list.js

@@ -3,6 +3,9 @@
  * Used in Admin
  * ${base_url}/list
  * Look to server/public/gridedit.js for main logic of grid editor
+ * @category server
+ * @module routes/list
+ * @subcategory routes
  */
 
 const Router = require("express-promise-router");
@@ -15,12 +18,24 @@ const { setTenant, isAdmin, error_catcher } = require("./utils");
 const moment = require("moment");
 const { readState } = require("@saltcorn/data/plugin-helper");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace listRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 
 // export our router to be mounted by the parent application
 module.exports = router;
+
 /**
  * Show list of table data history (GET handler)
+ * @name get/_versions/:name/:id
+ * @function
+ * @memberof module:routes/list~listRouter
+ * @function
  */
 router.get(
   "/_versions/:name/:id",
@@ -63,8 +78,13 @@ router.get(
     );
   })
 );
+
 /**
  * Restore version of data in table (POST handler)
+ * @name post/_restore/:name/:id/:_version
+ * @function
+ * @memberof module:routes/list~listRouter
+ * @function
  */
 router.post(
   "/_restore/:name/:id/:_version",
@@ -129,8 +149,11 @@ const typeToJsGridType = (t, field) => {
   }
   return jsgField;
 };
+
 /**
  * Version Field
+ * @param {string} tname 
+ * @returns {string}
  */
 const versionsField = (tname) => `
 var VersionsField = function(config) {
@@ -150,9 +173,13 @@ VersionsField.prototype = new jsGrid.Field({
 jsGrid.fields.versions = VersionsField;
 `;
 // end of versionsField
+
 /**
  * Table Data List Viewer (GET handler))
- * /list/:table
+ * @name get/:tname
+ * @function
+ * @memberof module:routes/list~listRouter
+ * @function
  */
 router.get(
   "/:tname",

package/routes/menu.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/menu
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 
 const Field = require("@saltcorn/data/models/field");
@@ -15,9 +21,21 @@ const { mkTable, renderForm, link, post_btn } = require("@saltcorn/markup");
 const { script, domReady, div, ul } = require("@saltcorn/markup/tags");
 const { send_infoarch_page } = require("../markup/admin.js");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace menuRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * 
+ * @param {object} req 
+ * @returns {Promise<Form>}
+ */
 const menuForm = async (req) => {
   const views = await View.find({}, { orderBy: "name", nocase: true });
   const pages = await Page.find({}, { orderBy: "name", nocase: true });
@@ -138,6 +156,10 @@ const menuForm = async (req) => {
 
 //create -- new
 
+/**
+ * @param {object[]} menu_items 
+ * @returns {string}
+ */
 const menuEditorScript = (menu_items) => `
   var iconPickerOptions = {searchText: "Search icon...", labelHeader: "{0}/{1}"};
   let lastState;
@@ -178,6 +200,11 @@ const menuEditorScript = (menu_items) => `
   lastState=editor.getString()
   setInterval(ajax_save_menu, 500)
   `;
+
+/**
+ * @param {object[]} menu_items 
+ * @returns {object[]} 
+ */
 const menuTojQME = (menu_items) =>
   (menu_items || []).map((mi) => ({
     ...mi,
@@ -185,6 +212,11 @@ const menuTojQME = (menu_items) =>
     subitems: undefined,
     ...(mi.subitems ? { children: menuTojQME(mi.subitems) } : {}),
   }));
+
+/**
+ * @param {object[]} menu_items 
+ * @returns {object[]}
+ */
 const jQMEtoMenu = (menu_items) =>
   menu_items.map((mi) => ({
     ...mi,
@@ -192,6 +224,13 @@ const jQMEtoMenu = (menu_items) =>
     children: undefined,
     ...(mi.children ? { subitems: jQMEtoMenu(mi.children) } : {}),
   }));
+
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/menu~menuRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -240,6 +279,12 @@ router.get(
   })
 );
 
+/**
+ * @name post
+ * @function
+ * @memberof module:routes/menu~menuRouter
+ * @function
+ */
 router.post(
   "/",
   setTenant,

package/routes/packs.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/packs
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 const { setTenant, isAdmin, error_catcher } = require("./utils.js");
 const { mkTable, renderForm, link, post_btn } = require("@saltcorn/markup");
@@ -30,9 +36,22 @@ const Library = require("@saltcorn/data/models/library");
 const Trigger = require("@saltcorn/data/models/trigger");
 const Role = require("@saltcorn/data/models/role");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace packsRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/packs~packsRouter
+ * @function
+ */
 router.get(
   "/create/",
   setTenant,
@@ -112,6 +131,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/create
+ * @function
+ * @memberof module:routes/packs~packsRouter
+ * @function
+ */
 router.post(
   "/create",
   setTenant,
@@ -185,6 +210,10 @@ router.post(
   })
 );
 
+/**
+ * @param {object} req 
+ * @returns {Form}
+ */
 const install_pack_form = (req) =>
   new Form({
     action: "/packs/install",
@@ -199,6 +228,12 @@ const install_pack_form = (req) =>
     ],
   });
 
+/**
+ * @name get/install
+ * @function
+ * @memberof module:routes/packs~packsRouter
+ * @function
+ */
 router.get(
   "/install",
   setTenant,
@@ -224,6 +259,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/install
+ * @function
+ * @memberof module:routes/packs~packsRouter
+ * @function
+ */
 router.post(
   "/install",
   setTenant,
@@ -277,6 +318,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/install-named/:name
+ * @function
+ * @memberof module:routes/packs~packsRouter
+ * @function
+ */
 router.post(
   "/install-named/:name",
   setTenant,
@@ -308,6 +355,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/uninstall/:name
+ * @function
+ * @memberof module:routes/packs~packsRouter
+ * @function
+ */
 router.post(
   "/uninstall/:name",
   setTenant,

package/routes/page.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/page
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 
 const Page = require("@saltcorn/data/models/page");
@@ -13,9 +19,22 @@ const { add_edit_bar } = require("../markup/admin.js");
 const { traverseSync } = require("@saltcorn/data/models/layout");
 const { run_action_column } = require("@saltcorn/data/plugin-helper");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace pageRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name get/:pagename
+ * @function
+ * @memberof module:routes/page~pageRouter
+ * @function
+ */
 router.get(
   "/:pagename",
   setTenant,
@@ -43,6 +62,13 @@ router.get(
         .sendWrap(`${pagename} page`, req.__("Page %s not found", pagename));
   })
 );
+
+/**
+ * @name post/:pagename/action/:rndid
+ * @function
+ * @memberof module:routes/page~pageRouter
+ * @function
+ */
 router.post(
   "/:pagename/action/:rndid",
   setTenant,