@saltcorn/data 0.6.1-beta.0 → 0.6.1

package/base-plugin/actions.js

@@ -1,6 +1,8 @@
 /**
  * Action description
- *
+ * @category saltcorn-data
+ * @module base-plugin/actions
+ * @subcategory base-plugin
  */
 
 const fetch = require("node-fetch");
@@ -25,6 +27,16 @@ const db = require("../db");
 //action use cases: field modify, like/rate (insert join), notify, send row to webhook
 // todo add translation
 
+/**
+ * @param {object} opts 
+ * @param {object} opts.row
+ * @param {object} opts.table
+ * @param {object} opts.channel
+ * @param {object} opts.configuration
+ * @param {object} opts.user
+ * @param {...*} opts.rest
+ * @returns {Promise<object>}
+ */
 const run_code = async ({
   row,
   table,
@@ -79,6 +91,11 @@ const run_code = async ({
 };
 
 module.exports = {
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   blocks: {
     disableInBuilder: true,
     disableInList: true,
@@ -92,9 +109,22 @@ module.exports = {
         input_type: "hidden",
       },
     ],
+    /** 
+     * @type {base-plugin/actions~run_code} 
+     * @see base-plugin/actions~run_code
+     */
     run: run_code,
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   emit_event: {
+    /**
+     * @returns {object[]}
+     */
     configFields: () => [
       {
         name: "eventType",
@@ -117,6 +147,13 @@ module.exports = {
         fieldview: "textarea",
       },
     ],
+    /**
+     * @param {object} opts
+     * @param {object} opts.row
+     * @param {object} opts.configuration
+     * @param {object} opts.user
+     * @returns {Promise<void>}
+     */
     run: async ({
       row,
       configuration: { eventType, channel, payload },
@@ -130,6 +167,12 @@ module.exports = {
       );
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   webhook: {
     configFields: [
       {
@@ -146,6 +189,12 @@ module.exports = {
         fieldview: "textarea", // I think that textarea is better
       },
     ],
+    /**
+     * @param {object} opts 
+     * @param {string} opts.url
+     * @param {object} opts.body
+     * @returns {Promise<object>}
+     */
     run: async ({ row, configuration: { url, body } }) => {
       return await fetch(url, {
         method: "post",
@@ -154,7 +203,16 @@ module.exports = {
       });
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   find_or_create_dm_room: {
+    /**
+     * @returns {Promise<object[]>}
+     */
     configFields: async () => {
       const views = await View.find_all_views_where(
         ({ viewrow }) => viewrow.viewtemplate === "Room"
@@ -171,6 +229,15 @@ module.exports = {
         },
       ];
     },
+
+    /**
+     * @param {object} opts
+     * @param {object} opts.row
+     * @param {*} opts.table
+     * @param {object} opts.configuration
+     * @param {object} opts.user
+     * @returns {Promise<object>}
+     */
     run: async ({ row, table, configuration: { viewname }, user }) => {
       const view = await View.findOne({ name: viewname });
       const { participant_field } = view.configuration;
@@ -214,7 +281,18 @@ module.exports = {
       }
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   send_email: {
+    /**
+     * @param {object} opts
+     * @param {object} opts.table
+     * @returns {Promise<object[]>}
+     */
     configFields: async ({ table }) => {
       if (!table) return [];
       const views = await View.find_table_views_where(
@@ -277,6 +355,14 @@ module.exports = {
       ];
     },
     requireRow: true,
+    /**
+     * @param {object} opts
+     * @param {object} opts.row
+     * @param {object} opts.table
+     * @param {object} opts.configuration
+     * @param {object} opts.user
+     * @returns {Promise<object>}
+     */
     run: async ({
       row,
       table,
@@ -329,7 +415,18 @@ module.exports = {
       return { notify: `E-mail sent to ${to_addr}` };
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   insert_joined_row: {
+    /**
+     * @param {object} opts
+     * @param {object} opts.table
+     * @returns {Promise<object[]>}
+     */
     configFields: async ({ table }) => {
       if (!table) return [];
       const { child_field_list } = await table.get_child_relations();
@@ -344,6 +441,14 @@ module.exports = {
       ];
     },
     requireRow: true,
+    /**
+     * @param {object} opts
+     * @param {object} opts.row
+     * @param {object} opts.table
+     * @param {object} opts.configuration
+     * @param {object} opts.user
+     * @returns {Promise<object>}
+     */
     run: async ({ row, table, configuration: { joined_table }, user }) => {
       const [join_table_name, join_field] = joined_table.split(".");
       const joinTable = await Table.findOne({ name: join_table_name });
@@ -361,9 +466,25 @@ module.exports = {
       return await joinTable.insertRow(newRow);
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   duplicate_row: {
+    /**
+     * @returns {Promise<object[]>}
+     */
     configFields: () => [],
     requireRow: true,
+    /**
+     * @param {object} opts
+     * @param {object} opts.row
+     * @param {object} opts.table
+     * @param {*} opts.user
+     * @returns {Promise<object>}
+     */
     run: async ({ row, table, user }) => {
       const newRow = { ...row };
       await table.getFields();
@@ -372,7 +493,18 @@ module.exports = {
       return { reload_page: true };
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   recalculate_stored_fields: {
+    /**
+     * @param {object} opts
+     * @param {object} opts.table
+     * @returns {Promise<object[]>}
+     */
     configFields: async ({ table }) => {
       const tables = await Table.find();
       return [
@@ -385,12 +517,28 @@ module.exports = {
         },
       ];
     },
+    /**
+     * @param {object} opts
+     * @param {object} opts.configuration
+     * @returns {Promise<void>}
+     */
     run: async ({ configuration: { table } }) => {
       const table_for_recalc = await Table.findOne({ name: table });
       recalculate_for_stored(table_for_recalc);
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   insert_any_row: {
+    /**
+     * @param {object} opts
+     * @param {*} opts.table
+     * @returns {Promise<object[]>}
+     */
     configFields: async ({ table }) => {
       const tables = await Table.find();
       return [
@@ -410,6 +558,14 @@ module.exports = {
         },
       ];
     },
+    /**
+     * @param {object} opts
+     * @param {object} opts.row
+     * @param {object} opts.configuration
+     * @param {object} opts.user
+     * @param {...*} opts.rest
+     * @returns {Promise<object|boolean>}
+     */
     run: async ({ row, configuration: { row_expr, table }, user, ...rest }) => {
       const f = get_async_expression_function(row_expr, [], {
         row: row || {},
@@ -423,7 +579,18 @@ module.exports = {
       else return true;
     },
   },
+
+  /**
+   * @namespace
+   * @category saltcorn-data
+   * @subcategory actions
+   */
   run_js_code: {
+    /**
+     * @param {object} opts
+     * @param {object} opts.table
+     * @returns {Promise<object[]>}
+     */
     configFields: async ({ table }) => {
       const fields = table ? (await table.getFields()).map((f) => f.name) : [];
       const vars = [
@@ -453,6 +620,10 @@ module.exports = {
         },
       ];
     },
+    /** 
+     * @type {base-plugin/actions~run_code} 
+     * @see base-plugin/actions~run_code
+     **/
     run: run_code,
   },
 };

package/base-plugin/fieldviews.js

@@ -1,3 +1,9 @@
+/**
+ * @category saltcorn-data
+ * @module base-plugin/fieldviews
+ * @subcategory base-plugin
+ */
+
 const View = require("../models/view");
 const Table = require("../models/table");
 const {
@@ -12,9 +18,19 @@ const {
 const tags = require("@saltcorn/markup/tags");
 const { select_options, radio_group } = require("@saltcorn/markup/helpers");
 
+/** 
+ * select namespace
+ * @namespace 
+ * @category saltcorn-data
+ */
 const select = {
+  /** @type {string} */
   type: "Key",
+  /** @type {boolean} */
   isEdit: true,
+  /**
+   * @type {object[]} 
+   */
   configFields: () => [
     {
       name: "neutral_label",
@@ -29,6 +45,16 @@ const select = {
       type: "Bool",
     },
   ],
+  
+  /**
+   * @param {*} nm 
+   * @param {*} v 
+   * @param {*} attrs 
+   * @param {*} cls 
+   * @param {*} reqd 
+   * @param {*} field 
+   * @returns {object} 
+   */
   run: (nm, v, attrs, cls, reqd, field) => {
     if (attrs.disabled)
       return (
@@ -58,9 +84,25 @@ const select = {
   },
 };
 
+/** 
+ * radio_select namespace
+ * @namespace 
+ * @category saltcorn-data
+ */
 const radio_select = {
+  /** @type {string} */
   type: "Key",
+  /** @type {boolean} */
   isEdit: true,
+  /**
+   * @param {*} nm 
+   * @param {*} v 
+   * @param {*} attrs 
+   * @param {*} cls 
+   * @param {*} reqd 
+   * @param {*} field 
+   * @returns {object}
+   */
   run: (nm, v, attrs, cls, reqd, field) =>
     radio_group({
       class: `${cls} ${field.class || ""}`,
@@ -70,9 +112,20 @@ const radio_select = {
     }),
 };
 
+/** 
+ * select namespace
+ * @namespace 
+ * @category saltcorn-data
+ */
 const search_or_create = {
+  /** @type {string} */
   type: "Key",
+  /** @type {boolean} */
   isEdit: true,
+  /**
+   * @param {object} field 
+   * @returns {Promise<object[]>}
+   */
   configFields: async (field) => {
     const reftable = await Table.findOne({ name: field.reftable_name });
     const views = await View.find({ table_id: reftable.id });
@@ -91,6 +144,16 @@ const search_or_create = {
       },
     ];
   },
+
+  /**
+   * @param {*} nm 
+   * @param {*} v 
+   * @param {*} attrs 
+   * @param {*} cls 
+   * @param {*} reqd 
+   * @param {*} field 
+   * @returns {object}
+   */
   run: (nm, v, attrs, cls, reqd, field) => {
     return (
       tags.select(

package/base-plugin/fileviews.js

@@ -1,23 +1,64 @@
+/**
+ * @category saltcorn-data
+ * @module base-plugin/fileview
+ * @subcategory base-plugin
+ */
 const { text, a, img } = require("@saltcorn/markup/tags");
 const { link } = require("@saltcorn/markup");
 
 module.exports = {
+  /** 
+   * @namespace 
+   * @category saltcorn-data
+   */
   "Download link": {
+    /**
+     * @param {string} file_id 
+     * @param {string} file_name 
+     * @returns {link}
+     */
     run: (file_id, file_name) =>
       link(`/files/download/${file_id}`, file_name || "Download"),
   },
+  /** 
+   * @namespace 
+   * @category saltcorn-data
+   */
   Link: {
+    /**
+     * @param {string} file_id 
+     * @param {string} file_name 
+     * @returns {link}
+     */
     run: (file_id, file_name) =>
       link(`/files/serve/${file_id}`, file_name || "Open"),
   },
+  /** 
+   * @namespace 
+   * @category saltcorn-data
+   */
   "Link (new tab)": {
+    /**
+     * @param {string} file_id 
+     * @param {string} file_name 
+     * @returns {a}
+     */
     run: (file_id, file_name) =>
       a(
         { href: `/files/serve/${file_id}`, target: "_blank" },
         file_name || "Open"
       ),
   },
+  /** 
+   * @namespace 
+   * @category saltcorn-data
+   */
   "Show Image": {
+    /**
+     * @param {string} file_id 
+     * @param {string} file_name 
+     * @returns {img}
+     */
     run: (file_id, file_name) =>
       img({ src: `/files/download/${file_id}`, style: "width: 100%" }),
   },

package/base-plugin/index.js

@@ -1,3 +1,30 @@
+/** 
+ * @category saltcorn-data
+ * @module base-plugin/index
+ * @subcategory base-plugin
+ */
+
+/**
+ * All files in the base-plugin module.
+ * @namespace base-plugin_overview
+ * @property {module:base-plugin/actions} actions
+ * @property {module:base-plugin/fieldviews} fieldviews
+ * @property {module:base-plugin/fileview} fileview
+ * @property {module:base-plugin/types} types
+ * 
+ * @property {module:base-plugin/viewtemplates/edit} edit
+ * @property {module:base-plugin/viewtemplates/feed} feed
+ * @property {module:base-plugin/viewtemplates/filter} filter
+ * @property {module:base-plugin/viewtemplates/list} list
+ * @property {module:base-plugin/viewtemplates/listshowlist} listshowlist
+ * @property {module:base-plugin/viewtemplates/room} room
+ * @property {module:base-plugin/viewtemplates/show} show
+ * @property {module:base-plugin/viewtemplates/viewable_fields} viewable_fields
+ * 
+ * 
+ * @category saltcorn-data
+ * @subcategory base-plugin
+ */
 const listshowlist = require("./viewtemplates/listshowlist");
 const list = require("./viewtemplates/list");
 const show = require("./viewtemplates/show");
@@ -14,13 +41,21 @@ const types = [string, int, bool, date, float, color];
 const viewtemplates = [list, edit, show, listshowlist, feed, filter, room];
 
 module.exports = {
+  /** @type {number} */
   sc_plugin_api_version: 1,
+  /** @type {object[]} */
   types,
+  /** @type {object[]} */
   viewtemplates,
+  /** @type {base-plugin/fileviews} */
   fileviews,
+  /** @type {base-plugin/actions} */
   actions,
+  /** @type {base-plugin/fieldviews} */
   fieldviews,
+  /** @type {object} */
   serve_dependencies: {
     blockly: require.resolve("blockly/package.json"),
   },
 };
+