@saltcorn/data 0.6.1-beta.0 → 0.6.1

package/base-plugin/viewtemplates/edit.js

@@ -1,3 +1,8 @@
+/**
+ * @category saltcorn-data
+ * @module base-plugin/viewtemplates/edit
+ * @subcategory base-plugin
+ */
 const Field = require("../../models/field");
 const File = require("../../models/file");
 const Table = require("../../models/table");
@@ -37,6 +42,10 @@ const {
 } = require("../../models/layout");
 const { asyncMap } = require("../../utils");
 
+/**
+ * @param {object} req 
+ * @returns {Workflow}
+ */
 const configuration_workflow = (req) =>
   new Workflow({
     steps: [
@@ -240,6 +249,14 @@ const configuration_workflow = (req) =>
       },
     ],
   });
+
+/**
+ * @param {*} table_id 
+ * @param {*} viewname 
+ * @param {object} opts
+ * @param {*} opts.columns
+ * @returns {Promise<object[]>}
+ */
 const get_state_fields = async (table_id, viewname, { columns }) => [
   {
     name: "id",
@@ -248,6 +265,10 @@ const get_state_fields = async (table_id, viewname, { columns }) => [
   },
 ];
 
+/**
+ * @param {Form} form 
+ * @param {string} locale 
+ */
 const setDateLocales = (form, locale) => {
   form.fields.forEach((f) => {
     if (f.type && f.type.name === "Date") {
@@ -256,8 +277,21 @@ const setDateLocales = (form, locale) => {
   });
 };
 
+/** @type {function} */
 const initial_config = initial_config_all_fields(true);
 
+/**
+ * @param {number} table_id 
+ * @param {string} viewname 
+ * @param {object} optsOne
+ * @param {*} optsOne.columns
+ * @param {*} optsOne.layout
+ * @param {string} state 
+ * @param {object} optsTwo
+ * @param {object} optsTwo.req
+ * @param {object} optsTwo.res
+ * @returns {Promise<Form>}
+ */
 const run = async (
   table_id,
   viewname,
@@ -284,6 +318,17 @@ const run = async (
     state,
   });
 };
+
+/**
+ * @param {number} table_id 
+ * @param {string} viewname 
+ * @param {object} opts
+ * @param {*} opts.columns
+ * @param {*} opts.layout
+ * @param {State} state 
+ * @param {object} extra 
+ * @returns {Promise<Form[]>}
+ */
 const runMany = async (
   table_id,
   viewname,
@@ -323,6 +368,16 @@ const runMany = async (
   });
 };
 
+/**
+ * @param {object} opts
+ * @param {Form} opts.form
+ * @param {Table} opts.table
+ * @param {object} opts.req
+ * @param {object} opts.row
+ * @param {object} opts.res
+ * @throws {InvalidConfiguration}
+ * @returns {Promise<void>}
+ */
 const transformForm = async ({ form, table, req, row, res }) => {
   await traverse(form.layout, {
     action(segment) {
@@ -371,6 +426,19 @@ const transformForm = async ({ form, table, req, row, res }) => {
   setDateLocales(form, req.getLocale());
 };
 
+/**
+ * @param {object} opts
+ * @param {Table} opts.table
+ * @param {Fields[]} opts.fields
+ * @param {string} opts.viewname
+ * @param {object[]} opts.columns
+ * @param {Layout} opts.layout
+ * @param {object} opts.row
+ * @param {object} opts.req
+ * @param {object} opts.state
+ * @param {object} opts.res
+ * @returns {Promise<Form>}
+ */
 const render = async ({
   table,
   fields,
@@ -413,6 +481,23 @@ const render = async ({
   return renderForm(form, req.csrfToken());
 };
 
+/**
+ * @param {number} table_id 
+ * @param {string} viewname 
+ * @param {object} optsOne
+ * @param {object[]} optsOne.columns
+ * @param {Layout} optsOne.layout
+ * @param {object} optsOne.fixed
+ * @param {boolean} optsOne.view_when_done
+ * @param {object[]} optsOne.formula_destinations
+ * @param {object} state 
+ * @param {*} body 
+ * @param {object} optsTwo
+ * @param {object} optsTwo.res
+ * @param {object} optsTwo.req
+ * @param {string} optsTwo.redirect
+ * @returns {Promise<void>}
+ */
 const runPost = async (
   table_id,
   viewname,
@@ -526,6 +611,14 @@ const runPost = async (
     }
   }
 };
+
+/**
+ * @param {object} opts
+ * @param {object} opts.body
+ * @param {string} opts.table_id
+ * @param {object} opts.req
+ * @returns {Promise<boolean>}
+ */
 const authorise_post = async ({ body, table_id, req }) => {
   const table = await Table.findOne({ id: table_id });
   const user_id = req.user ? req.user.id : null;
@@ -540,7 +633,9 @@ const authorise_post = async ({ body, table_id, req }) => {
   return false;
 };
 module.exports = {
+  /** @type {string} */
   name: "Edit",
+  /** @type {string} */
   description: "Form for creating a new row or editing existing rows",
   configuration_workflow,
   run,
@@ -548,10 +643,22 @@ module.exports = {
   runPost,
   get_state_fields,
   initial_config,
+  /** @type {boolean} */
   display_state_form: false,
   authorise_post,
+  /**
+   * @param {object} opts
+   * @param {object} opts.query
+   * @param {...*} opts.rest
+   * @returns {Promise<boolean>}
+   */
   authorise_get: async ({ query, ...rest }) =>
     authorise_post({ body: query, ...rest }),
+  /**
+   * @param {object} opts
+   * @param {Layout} opts.layout
+   * @returns {string[]}
+   */
   getStringsForI18n({ layout }) {
     return getStringsForI18n(layout);
   },

package/base-plugin/viewtemplates/feed.js

@@ -1,3 +1,8 @@
+/**
+ * @category saltcorn-data
+ * @module base-plugin/viewtemplates/feed
+ * @subcategory base-plugin
+ */
 const Field = require("../../models/field");
 const Table = require("../../models/table");
 const Form = require("../../models/form");
@@ -19,6 +24,10 @@ const {
 const { InvalidConfiguration } = require("../../utils");
 const { getState } = require("../../db/state");
 
+/**
+ * @param {object} req 
+ * @returns {Workflow}
+ */
 const configuration_workflow = (req) =>
   new Workflow({
     steps: [
@@ -218,6 +227,13 @@ const configuration_workflow = (req) =>
     ],
   });
 
+/**
+ * @param {number} table_id 
+ * @param {*} viewname 
+ * @param {object} opts
+ * @param {*} opts.show_view 
+ * @returns {Promise<Field>}
+ */
 const get_state_fields = async (table_id, viewname, { show_view }) => {
   const table_fields = await Field.find({ table_id });
   return table_fields
@@ -228,6 +244,28 @@ const get_state_fields = async (table_id, viewname, { show_view }) => {
       return sf;
     });
 };
+
+/**
+ * @param {number} table_id 
+ * @param {string} viewname 
+ * @param {object} opts
+ * @param {string} opts.show_view
+ * @param {name} opts.order_field
+ * @param {boolean} opts.descending
+ * @param {string} [opts.view_to_create]
+ * @param {string} opts.create_view_display
+ * @param {boolean} opts.in_card
+ * @param {string} opts.masonry_columns
+ * @param {number} [opts.rows_per_page = 20]
+ * @param {boolean} opts.hide_pagination
+ * @param {string} [opts.create_view_label]
+ * @param {string} [opts.create_view_location]
+ * @param {boolean} opts.always_create_view
+ * @param {*} opts.cols
+ * @param {object} state 
+ * @param {*} extraArgs 
+ * @returns {Promise<div>}
+ */
 const run = async (
   table_id,
   viewname,
@@ -374,13 +412,21 @@ const run = async (
 };
 
 module.exports = {
+  /** @type {string} */
   name: "Feed",
+  /** @type {string} */
   description:
     "Show multiple rows by displaying a chosen view for each row, stacked or in columns",
   configuration_workflow,
   run,
   get_state_fields,
+  /** @type {boolean} */
   display_state_form: false,
+  /**
+   * @param {object} opts 
+   * @param {*} opts.create_view_label
+   * @returns {string[]|Object[]}
+   */
   getStringsForI18n({ create_view_label }) {
     if (create_view_label) return [create_view_label];
     else return [];

package/base-plugin/viewtemplates/filter.js

@@ -1,3 +1,8 @@
+/**
+ * @category saltcorn-data
+ * @module base-plugin/viewtemplates/filter
+ * @subcategory base-plugin
+ */
 const User = require("../../models/user");
 const View = require("../../models/view");
 const Table = require("../../models/table");
@@ -26,6 +31,9 @@ const { InvalidConfiguration } = require("../../utils");
 const { jsexprToWhere } = require("../../models/expression");
 const Library = require("../../models/library");
 
+/**
+ * @returns {Workflow}
+ */
 const configuration_workflow = () =>
   new Workflow({
     steps: [
@@ -80,10 +88,26 @@ const configuration_workflow = () =>
       },
     ],
   });
+
+/** @returns {object[]} */
 const get_state_fields = () => [];
 
+/**
+ * 
+ * @returns {Promise<object>}
+ */
 const initial_config = async () => ({ layout: {}, columns: [] });
 
+/**
+ * @param {number} table_id 
+ * @param {string} viewname 
+ * @param {object} opts
+ * @param {object[]} opts.columns
+ * @param {object} opts.layout
+ * @param {object} state 
+ * @param {object} extra 
+ * @returns {Promise<Layout>}
+ */
 const run = async (table_id, viewname, { columns, layout }, state, extra) => {
   //console.log(columns);
   //console.log(layout);
@@ -251,17 +275,36 @@ const run = async (table_id, viewname, { columns, layout }, state, extra) => {
   return renderLayout({ blockDispatch, layout, role });
 };
 
+/**
+ * @param {object|undefined} x 
+ * @param {object|undefined} y 
+ * @returns {object}
+ */
 const or_if_undef = (x, y) => (typeof x === "undefined" ? y : x);
+
+/**
+ * @param {string} x 
+ * @param {string} y 
+ * @returns {boolean}
+ */
 const eq_string = (x, y) => `${x}` === `${y}`;
 module.exports = {
+  /** @type {string} */
   name: "Filter",
+  /** @type {string} */
   description:
     "Elements that limit the rows shown in other views on the same page. Filter views do not show any rows on their own.",
   get_state_fields,
   configuration_workflow,
   run,
   initial_config,
+  /** @type {boolean} */
   display_state_form: false,
+  /**
+   * @param {object} opts
+   * @param {*} opts.layout
+   * @returns {string[]}
+   */
   getStringsForI18n({ layout }) {
     return getStringsForI18n(layout);
   },

package/base-plugin/viewtemplates/list.js

@@ -1,3 +1,8 @@
+/**
+ * @category saltcorn-data
+ * @module base-plugin/viewtemplates/list
+ * @subcategory base-plugin
+ */
 const Field = require("../../models/field");
 const FieldRepeat = require("../../models/fieldrepeat");
 const Table = require("../../models/table");
@@ -31,6 +36,10 @@ const db = require("../../db");
 const { get_existing_views } = require("../../models/discovery");
 const { InvalidConfiguration } = require("../../utils");
 
+/**
+ * @param {object} context 
+ * @returns {Promise<void>}
+ */
 const create_db_view = async (context) => {
   const table = await Table.findOne({ id: context.table_id });
   const fields = await table.getFields();
@@ -54,6 +63,13 @@ const create_db_view = async (context) => {
   await db.query(`create or replace view ${sql_view_name} as ${sql};`);
 };
 
+/**
+ * @param {*} table_id 
+ * @param {string} viewname 
+ * @param {object} opts
+ * @param {*} opts.default_state
+ * @returns {Promise<void>}
+ */
 const on_delete = async (table_id, viewname, { default_state }) => {
   if (!db.isSQLite) {
     const sqlviews = (await get_existing_views()).map((v) => v.table_name);
@@ -66,6 +82,10 @@ const on_delete = async (table_id, viewname, { default_state }) => {
   }
 };
 
+/**
+ * @param {object} req 
+ * @returns {Workflow}
+ */
 const configuration_workflow = (req) =>
   new Workflow({
     onDone: async (ctx) => {
@@ -261,6 +281,14 @@ const configuration_workflow = (req) =>
       },
     ],
   });
+
+/**
+ * @param {string} table_id 
+ * @param {*} viewname 
+ * @param {object} opts
+ * @param {object[]} opts.columns
+ * @returns {function}
+ */
 const get_state_fields = async (table_id, viewname, { columns }) => {
   const table_fields = await Field.find({ table_id });
   var state_fields = [];
@@ -281,8 +309,23 @@ const get_state_fields = async (table_id, viewname, { columns }) => {
   return state_fields;
 };
 
+/** @type {function} */
 const initial_config = initial_config_all_fields(false);
 
+/**
+ * @param {string|number} table_id 
+ * @param {string} viewname 
+ * @param {object} opts
+ * @param {object[]} opts.columns
+ * @param {string} [opts.view_to_create]
+ * @param {string} opts.create_view_display
+ * @param {string} [opts.create_view_label]
+ * @param {object} [opts.default_state]
+ * @param {string} [opts.create_view_location]
+ * @param {object} [stateWithId]
+ * @param {object} extraOpts 
+ * @returns {Promise<*>}
+ */
 const run = async (
   table_id,
   viewname,
@@ -429,6 +472,18 @@ const run = async (
   return istop ? create_link_div + tableHtml : tableHtml + create_link_div;
 };
 
+/**
+ * @param {number} table_id 
+ * @param {*} viewname 
+ * @param {object} optsOne
+ * @param {object[]} optsOne.columns
+ * @param {*} optsOne.layout
+ * @param {object} body 
+ * @param {object} optsTwo
+ * @param {object} optsTwo.req
+ * @param {*} optsTwo.res
+ * @returns {Promise<object>}
+ */
 const run_action = async (
   table_id,
   viewname,
@@ -468,23 +523,40 @@ const run_action = async (
 };
 
 module.exports = {
+  /** @type {string} */
   name: "List",
+  /** @type {string} */
   description:
-    "Display multiple rows from a table in a grid with columns you specify",
+    "Display multiple rows from a table in a grid with columns you specify", 
   configuration_workflow,
   run,
+  /** @type {string} */
   view_quantity: "Many",
   get_state_fields,
   initial_config,
   on_delete,
   routes: { run_action },
+  /**
+   * @param {object} opts 
+   * @returns {boolean}
+   */
   display_state_form: (opts) =>
     !(opts && opts.default_state && opts.default_state._omit_state_form),
+  /**
+   * @param {object} opts 
+   * @returns {boolean}
+   */
   default_state_form: ({ default_state }) => {
     if (!default_state) return default_state;
     const { _omit_state_form, _create_db_view, ...ds } = default_state;
     return ds && removeDefaultColor(removeEmptyStrings(ds));
   },
+  /**
+   * @param {object} opts 
+   * @param {*} opts.columns
+   * @param {*} opts.create_view_label
+   * @returns {string[]}
+   */
   getStringsForI18n({ columns, create_view_label }) {
     const strings = [];
     const maybeAdd = (s) => {

package/base-plugin/viewtemplates/listshowlist.js

@@ -1,3 +1,8 @@
+/**
+ * @category saltcorn-data
+ * @module base-plugin/viewtemplates/listshowlist
+ * @subcategory base-plugin
+ */
 const Table = require("../../models/table");
 const Form = require("../../models/form");
 const View = require("../../models/view");
@@ -12,6 +17,10 @@ const {
 const { splitUniques } = require("./viewable_fields");
 const { InvalidConfiguration } = require("../../utils");
 
+/**
+ * @param {object} req
+ * @returns {Workflow}
+ */
 const configuration_workflow = (req) =>
   new Workflow({
     steps: [
@@ -58,6 +67,19 @@ const configuration_workflow = (req) =>
                   options: show_view_opts,
                 },
               },
+              {
+                name: "list_width",
+                label: req.__("List width"),
+                sublabel: req.__(
+                  "Number of columns (1-12) allocated to the list view"
+                ),
+                type: "Integer",
+                default: 6,
+                attributes: {
+                  min: 1,
+                  max: 12,
+                },
+              },
               {
                 name: "_omit_state_form",
                 label: req.__("Omit search form"),
@@ -106,6 +128,14 @@ const configuration_workflow = (req) =>
     ],
   });
 
+/**
+ * @param {*} table_id
+ * @param {*} viewname
+ * @param {object} opts
+ * @param {string} opts.list_view
+ * @param {*} opts.show_view
+ * @returns {Promise<object[]>}
+ */
 const get_state_fields = async (
   table_id,
   viewname,
@@ -125,10 +155,21 @@ const get_state_fields = async (
   } else return [id];
 };
 
+/**
+ * @param {string} table_id
+ * @param {string} viewname
+ * @param {object} opts
+ * @param {string} opts.list_view
+ * @param {string} opts.show_view
+ * @param {object} opts.subtables
+ * @param {*} state
+ * @param {*} extraArgs
+ * @returns {Promise<div>}
+ */
 const run = async (
   table_id,
   viewname,
-  { list_view, show_view, subtables },
+  { list_view, show_view, list_width, subtables },
   state,
   extraArgs
 ) => {
@@ -219,10 +260,11 @@ const run = async (
       ? [h6(Object.keys(reltbls)[0]), reltbls[Object.keys(reltbls)[0]]]
       : tabs(reltbls);
   if (lresp) {
+    if (list_width === 12) return lresp;
     return div(
       { class: "row" },
-      div({ class: "col-sm-6" }, lresp),
-      div({ class: "col-sm-6" }, sresp, relTblResp)
+      div({ class: `col-sm-${list_width || 6}` }, lresp),
+      div({ class: `col-sm-${12 - (list_width || 6)}` }, sresp, relTblResp)
     );
   } else {
     return div(sresp, relTblResp);
@@ -230,12 +272,21 @@ const run = async (
 };
 
 module.exports = {
+  /** @type {string} */
   name: "ListShowList",
+  /** @type {string} */
   description:
     "Combine an optional list view on the left with displays on the right of a single selected row, with views of related rows from different tables underneath",
   configuration_workflow,
   run,
   get_state_fields,
+  /**
+
+   * @param {object} opts
+   * @param {string} opts.list_view
+   * @param {boolean} opts._omit_state_form
+   * @returns {boolean}
+   */
   display_state_form: ({ list_view, _omit_state_form }) =>
     !!list_view && !_omit_state_form,
 };