@saltcorn/server 0.6.1-beta.0 → 0.6.1

package/routes/scapi.js

@@ -1,8 +1,12 @@
 /**
  * SC service API handler
  * Allows to list tables, views, etc
- * @type {module:express-promise-router}
+ * @category server
+ * @module routes/scapi
+ * @subcategory routes
  */
+
+/** @type {module:express-promise-router} */
 const Router = require("express-promise-router");
 //const db = require("@saltcorn/data/db");
 const { setTenant, error_catcher } = require("./utils.js");
@@ -21,15 +25,22 @@ const {
   stateFieldsToWhere,
   readState,
 } = require("@saltcorn/data/plugin-helper");
+
+/**
+ * @type {object}
+ * @const
+ * @namespace scapiRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
-
 /**
  * Check that user has right to read sc service api data.
  * Only admin currently can call this api.
- * @param req - httprequest
- * @param user - user based on access token
+ * @param {object} req httprequest
+ * @param {object} user user based on access token
  * @returns {boolean}
  */
 function accessAllowedRead(req, user){
@@ -43,12 +54,17 @@ function accessAllowedRead(req, user){
     return false;
 }
 
-/**
- * List SC Tables using GET
- */
+
 // todo add paging
 // todo more granular access rights for api. Currently only admin can call this api.
 // todo add support of fields
+/**
+ * List SC Tables using GET
+ * @name get/sc_tables
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
+ */
 router.get(
     "/sc_tables/",
     setTenant,
@@ -70,11 +86,16 @@ router.get(
         )(req, res, next);
     })
 );
+
+// todo add paging
+// todo more granular access rights for api. Currently only admin can call this api.
 /**
  * List SC Views using GET
+ * @name get/sc_views
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights for api. Currently only admin can call this api.
 router.get(
     "/sc_views/",
     setTenant,
@@ -97,11 +118,16 @@ router.get(
     })
 );
 
+
+// todo add paging
+// todo more granular access rights to api. Currently only admin can call this api.
 /**
  * List SC Pages using GET
+ * @name get/sc_pages
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights to api. Currently only admin can call this api.
 router.get(
     "/sc_pages/",
     setTenant,
@@ -123,11 +149,16 @@ router.get(
         )(req, res, next);
     })
 );
+
+// todo add paging
+// todo more granular access rights to api. Currently only admin can call this api.
 /**
  * List SC Files using GET
+ * @name get/sc_files
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights to api. Currently only admin can call this api.
 router.get(
     "/sc_files/",
     setTenant,
@@ -149,11 +180,16 @@ router.get(
         )(req, res, next);
     })
 );
+
+// todo add paging
+// todo more granular access rights to api. Currently only admin can call this api.
 /**
  * List SC Triggers using GET
+ * @name get/sc_triggers
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights to api. Currently only admin can call this api.
 router.get(
     "/sc_triggers/",
     setTenant,
@@ -175,11 +211,16 @@ router.get(
         )(req, res, next);
     })
 );
+
+// todo add paging
+// todo more granular access rights to api. Currently only admin can call this api.
 /**
  * List SC Roles using GET
+ * @name get/sc_roles
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights to api. Currently only admin can call this api.
 router.get(
     "/sc_roles/",
     setTenant,
@@ -201,11 +242,16 @@ router.get(
         )(req, res, next);
     })
 );
+
+// todo add paging
+// todo more granular access rights to api. Currently only admin can call this api.
 /**
  * List SC Tenants using GET
+ * @name get/sc_tenants
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights to api. Currently only admin can call this api.
 router.get(
     "/sc_tenants/",
     setTenant,
@@ -227,11 +273,16 @@ router.get(
         )(req, res, next);
     })
 );
+
+// todo add paging
+// todo more granular access rights to api. Currently only admin can call this api.
 /**
  * List SC Plugins using GET
+ * @name get/sc_plugins
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights to api. Currently only admin can call this api.
 router.get(
     "/sc_plugins/",
     setTenant,
@@ -253,11 +304,16 @@ router.get(
         )(req, res, next);
     })
 );
+
+// todo add paging
+// todo more granular access rights to api. Currently only admin can call this api.
 /**
  * List SC Config Items using GET
+ * @name get/sc_config
+ * @function
+ * @memberof module:routes/scapi~scapiRouter
+ * @function
  */
-// todo add paging
-// todo more granular access rights to api. Currently only admin can call this api.
 router.get(
     "/sc_config/",
     setTenant,

package/routes/search.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/search
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 const { span, h5, h4, nbsp, p, a, div } = require("@saltcorn/markup/tags");
 
@@ -10,9 +16,22 @@ const { renderForm } = require("@saltcorn/markup");
 const { pagination } = require("@saltcorn/markup/helpers");
 const { send_infoarch_page } = require("../markup/admin.js");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace searchRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {object[]} tables 
+ * @param {object[]} views 
+ * @param {object} req 
+ * @returns {Forms}
+ */
 const searchConfigForm = (tables, views, req) => {
   var fields = [];
   var tbls_noviews = [];
@@ -48,6 +67,12 @@ const searchConfigForm = (tables, views, req) => {
   });
 };
 
+/**
+ * @name get/config
+ * @function
+ * @memberof module:routes/search~searchRouter
+ * @function
+ */
 router.get(
   "/config",
   setTenant,
@@ -70,6 +95,13 @@ router.get(
   })
 );
 
+
+/**
+ * @name post/config
+ * @function
+ * @memberof module:routes/search~searchRouter
+ * @function
+ */
 router.post(
   "/config",
   setTenant,
@@ -98,6 +130,9 @@ router.post(
   })
 );
 
+/**
+ * @returns {Form}
+ */
 const searchForm = () =>
   new Form({
     action: "/search",
@@ -113,6 +148,16 @@ const searchForm = () =>
     ],
   });
 
+/**
+ * @param {object} opts
+ * @param {*} opts.q
+ * @param {*} opts._page
+ * @param {*} opts.table
+ * @param {object} opts
+ * @param {object} req 
+ * @param {object} res 
+ * @returns {Promise<void>}
+ */
 const runSearch = async ({ q, _page, table }, req, res) => {
   const role = (req.user || {}).role_id || 10;
   const cfg = getState().getConfig("globalSearch");
@@ -200,6 +245,12 @@ const runSearch = async ({ q, _page, table }, req, res) => {
   });
 };
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/search~searchRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,

package/routes/settings.js

@@ -1,10 +1,31 @@
+/**
+ * @category server
+ * @module routes/settings
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 const { i, h3, p, a } = require("@saltcorn/markup/tags");
 const { setTenant, isAdmin, error_catcher } = require("./utils.js");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace settingsRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {object} opts
+ * @param {string} opts.title
+ * @param {string} opts.icon
+ * @param {string} opts.blurb
+ * @param {string} opts.href
+ * @returns {object}
+ */
 const settingsCard = ({ title, icon, blurb, href }) => ({
   type: "card",
   url: href,
@@ -17,6 +38,12 @@ const settingsCard = ({ title, icon, blurb, href }) => ({
   },
 });
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/settings~settingsRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,