@saltcorn/server 0.6.1-beta.0 → 0.6.1

package/routes/admin.js

@@ -1,3 +1,8 @@
+/**
+ * @category server
+ * @module routes/admin
+ * @subcategory routes
+ */
 const Router = require("express-promise-router");
 
 const {
@@ -62,9 +67,20 @@ const {
 } = require("../markup/admin");
 const moment = require("moment");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace routes/adminRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {object} req 
+ * @returns {Promise<Form>}
+ */
 const site_id_form = (req) =>
   config_fields_form({
     req,
@@ -85,7 +101,7 @@ const site_id_form = (req) =>
   });
 /**
  * Email settings form definition
- * @param req - request
+ * @param {object} req request
  * @returns {Promise<Form>} form
  */
 const email_form = async (req) => {
@@ -107,6 +123,12 @@ const email_form = async (req) => {
     "remove_outline(this);$('#testemail').attr('href','#').removeClass('btn-primary').addClass('btn-outline-primary')";
   return form;
 };
+
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.get(
   "/",
   setTenant,
@@ -126,6 +148,12 @@ router.get(
     });
   })
 );
+
+/**
+ * @name post
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/",
   setTenant,
@@ -153,6 +181,12 @@ router.post(
     }
   })
 );
+
+/**
+ * @name get/email
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.get(
   "/email",
   setTenant,
@@ -182,6 +216,11 @@ router.get(
   })
 );
 
+/**
+ * @name get/send-test-email
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.get(
   "/send-test-email",
   setTenant,
@@ -207,6 +246,12 @@ router.get(
     res.redirect("/admin/email");
   })
 );
+
+/**
+ * @name post/email
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/email",
   setTenant,
@@ -232,6 +277,12 @@ router.post(
     }
   })
 );
+
+/**
+ * @name get/backup
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.get(
   "/backup",
   setTenant,
@@ -272,6 +323,11 @@ router.get(
   })
 );
 
+/**
+ * @name get/system
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.get(
   "/system",
   setTenant,
@@ -387,6 +443,11 @@ router.get(
   })
 );
 
+/**
+ * @name post/restart
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/restart",
   setTenant,
@@ -405,6 +466,11 @@ router.post(
   })
 );
 
+/**
+ * @name post/upgrade
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/upgrade",
   setTenant,
@@ -437,6 +503,11 @@ router.post(
   })
 );
 
+/**
+ * @name post/backup
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/backup",
   setTenant,
@@ -453,6 +524,11 @@ router.post(
   })
 );
 
+/**
+ * @name post/restore
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/restore",
   setTenant,
@@ -470,6 +546,10 @@ router.post(
   })
 );
 
+/**
+ * @param {object} req 
+ * @returns {Form}
+ */
 const clearAllForm = (req) =>
   new Form({
     action: "/admin/clear-all",
@@ -541,6 +621,11 @@ const clearAllForm = (req) =>
     ],
   });
 
+/**
+ * @name post/enable-letsencrypt
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/enable-letsencrypt",
   setTenant,
@@ -614,6 +699,11 @@ router.post(
   })
 );
 
+/**
+ * @name get/clear-all
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.get(
   "/clear-all",
   setTenant,
@@ -638,6 +728,12 @@ router.get(
     });
   })
 );
+
+/**
+ * @name post/clear-all
+ * @function
+ * @memberof module:routes/admin~routes/adminRouter
+ */
 router.post(
   "/clear-all",
   setTenant,

package/routes/api.js

@@ -9,8 +9,11 @@
  * To solve this in future needs to publish sc_role table into user tables of saltcorn.
  *
  * Documentation: https://wiki.saltcorn.com/view/ShowPage?title=API
- * @type {module:express-promise-router}
+ * @category server
+ * @module routes/api
+ * @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");
@@ -26,9 +29,21 @@ const {
   stateFieldsToWhere,
   readState,
 } = require("@saltcorn/data/plugin-helper");
+
+/**
+ * @type {object}
+ * @const
+ * @namespace apiRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @param {*} fields 
+ * @returns {*}
+ */
 const limitFields = (fields) => (r) => {
   if (fields) {
     let res = {};
@@ -44,9 +59,9 @@ const limitFields = (fields) => (r) => {
 
 /**
  * Check that user has right to read table data (only read in terms of CRUD)
- * @param req - httprequest
- * @param user - user based on access token
- * @param table
+ * @param {object} req httprequest
+ * @param {object} user - user based on access token
+ * @param {Table} table
  * @returns {boolean}
  */
 function accessAllowedRead(req, user, table){
@@ -61,9 +76,9 @@ function accessAllowedRead(req, user, table){
 
 /**
  * Check that user has right to write table data (create, update, delete in terms of  CRUD)
- * @param req - httprequest
- * @param user - user based on access token
- * @param table
+ * @param {object} req httprequest
+ * @param {object} user user based on access token
+ * @param {Table} table
  * @returns {boolean}
  */
 function accessAllowedWrite(req, user, table){
@@ -78,9 +93,9 @@ function accessAllowedWrite(req, user, table){
 }
 /**
  * Check that user has right to trigger call
- * @param req - httprequest
- * @param user - user based on access token
- * @param trigger
+ * @param {object} req httprequest
+ * @param {object} user user based on access token
+ * @param {Trigger} trigger
  * @returns {boolean}
  */
 function accessAllowed(req, user, trigger){
@@ -92,8 +107,12 @@ function accessAllowed(req, user, trigger){
 
     return role <= trigger.min_role;
 }
+
 /**
  * Select Table rows using GET
+ * @name get/:tableName/
+ * @function
+ * @memberof module:routes/api~apiRouter
  */
 // todo add paging
 router.get(
@@ -147,9 +166,13 @@ router.get(
     )(req, res, next);
   })
 );
+
 /**
  * Call Action (Trigger) using POST
  * Attention! if you have table with name "action" it can be problem in future
+ * @name post/action/:actionname/
+ * @function
+ * @memberof module:routes/api~apiRouter
  */
 router.post(
   "/action/:actionname/",
@@ -193,8 +216,12 @@ router.post(
     )(req, res, next);
   })
 );
+
 /**
  * Insert into Table using POST
+ * @name post/:tableName/
+ * @function
+ * @memberof module:routes/api~apiRouter
  */
 router.post(
   "/:tableName/",
@@ -257,9 +284,13 @@ router.post(
     )(req, res, next);
   })
 );
+
 /**
  * Update Table row directed by ID using POST
  * POST api/<table>/id
+ * @name post/:tableName/:id
+ * @function
+ * @memberof module:routes/api~apiRouter
  */
 router.post(
   "/:tableName/:id",
@@ -314,8 +345,12 @@ router.post(
     )(req, res, next);
   })
 );
+
 /**
  * Delete Table row by ID using DELETE
+ * @name delete/:tableName/:id
+ * @function
+ * @memberof module:routes/api~apiRouter
  */
 router.delete(
   "/:tableName/:id",

package/routes/config.js

@@ -1,3 +1,8 @@
+/**
+ * @category server
+ * @module routes/config
+ * @subcategory routes
+ */
 const Router = require("express-promise-router");
 
 const Field = require("@saltcorn/data/models/field");
@@ -25,9 +30,22 @@ const {
 } = require("@saltcorn/data/models/config");
 const { table, tbody, tr, th, td, div } = require("@saltcorn/markup/tags");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace configRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name post/delete/:key
+ * @function
+ * @memberof module:routes/config~configRouter
+ * @function
+ */
 router.post(
   "/delete/:key",
   setTenant,

package/routes/crashlog.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/crashlog
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 const Crash = require("@saltcorn/data/models/crash");
 const db = require("@saltcorn/data/db");
@@ -17,9 +23,22 @@ const {
 const { setTenant, isAdmin, error_catcher } = require("./utils.js");
 const { send_events_page } = require("../markup/admin.js");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace crashlogRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/crashlog~crashlogRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -76,6 +95,12 @@ router.get(
   })
 );
 
+/**
+ * @name post
+ * @function
+ * @memberof module:routes/crashlog~crashlogRouter
+ * @function
+ */
 router.post(
   "/",
   setTenant,
@@ -90,6 +115,12 @@ router.post(
   })
 );
 
+/**
+ * @name get/:id
+ * @function
+ * @memberof module:routes/crashlog~crashlogRouter
+ * @function
+ */
 router.get(
   "/:id",
   setTenant,

package/routes/delete.js

@@ -1,13 +1,32 @@
+/**
+ * @category server
+ * @module routes/delete
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 
 const { setTenant, loggedIn, error_catcher } = require("./utils.js");
 const Table = require("@saltcorn/data/models/table");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace deleteRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 
 // export our router to be mounted by the parent application
 module.exports = router;
 
+/**
+ * @name post/:name/:id
+ * @function
+ * @memberof module:routes/delete~deleteRouter
+ * @function
+ */
 router.post(
   "/:name/:id",
   setTenant,

package/routes/edit.js

@@ -1,3 +1,9 @@
+/**
+ * @category server
+ * @module routes/edit
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 
 const Field = require("@saltcorn/data/models/field");
@@ -9,9 +15,22 @@ const pluralize = require("pluralize");
 
 const { renderForm } = require("@saltcorn/markup");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace editRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name post/toggle/:name/:id/:field_name
+ * @function
+ * @memberof module:routes/edit~editRouter
+ * @function
+ */
 router.post(
   "/toggle/:name/:id/:field_name",
   setTenant,

package/routes/eventlog.js

@@ -1,6 +1,8 @@
 /**
  * Actions (Triggers) Handler
- *
+ * @category server
+ * @module routes/eventlog
+ * @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 eventlogRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 const {
@@ -42,6 +51,10 @@ const Table = require("@saltcorn/data/models/table");
 const { send_events_page } = require("../markup/admin.js");
 const EventLog = require("@saltcorn/data/models/eventlog");
 
+/**
+ * @param {object} req 
+ * @returns {Promise<Form>}
+ */
 const logSettingsForm = async (req) => {
   const fields = [];
   for (const w of Trigger.when_options) {
@@ -80,6 +93,12 @@ const logSettingsForm = async (req) => {
   });
 };
 
+/**
+ * @name get/settings
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.get(
   "/settings",
   setTenant,
@@ -101,6 +120,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/custom
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.get(
   "/custom",
   setTenant,
@@ -147,6 +172,9 @@ router.get(
   })
 );
 
+/**
+ * @returns {Form}
+ */
 const customEventForm = () =>
   new Form({
     action: "/eventlog/custom/new",
@@ -166,6 +194,12 @@ const customEventForm = () =>
     ],
   });
 
+/**
+ * @name get/custom/new
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.get(
   "/custom/new",
   setTenant,
@@ -186,6 +220,12 @@ router.get(
   })
 );
 
+/**
+ * @name post/custom/new
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.post(
   "/custom/new",
   setTenant,
@@ -216,6 +256,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/custom/delete/:name
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.post(
   "/custom/delete/:name",
   setTenant,
@@ -234,6 +280,12 @@ router.post(
   })
 );
 
+/**
+ * @name post/settings
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.post(
   "/settings",
   setTenant,
@@ -261,6 +313,12 @@ router.post(
   })
 );
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,
@@ -311,6 +369,12 @@ router.get(
   })
 );
 
+/**
+ * @name get/:id
+ * @function
+ * @memberof module:routes/eventlog~eventlogRouter
+ * @function
+ */
 router.get(
   "/:id",
   setTenant,

package/routes/events.js

@@ -1,9 +1,28 @@
+/**
+ * @category server
+ * @module routes/events
+ * @subcategory routes
+ */
+
 const Router = require("express-promise-router");
 const { isAdmin, setTenant, error_catcher } = require("./utils.js");
 
+/**
+ * @type {object}
+ * @const
+ * @namespace eventsRouter
+ * @category server
+ * @subcategory routes
+ */
 const router = new Router();
 module.exports = router;
 
+/**
+ * @name get
+ * @function
+ * @memberof module:routes/events~eventsRouter
+ * @function
+ */
 router.get(
   "/",
   setTenant,