@saltcorn/data 0.6.1-beta.0 → 0.6.1

package/models/view.js

@@ -1,6 +1,8 @@
 /**
- *
  * View Data Access Layer
+ * @category saltcorn-data
+ * @module models/view
+ * @subcategory models
  */
 
 const db = require("../db");
@@ -21,8 +23,13 @@ const { renderForm } = require("@saltcorn/markup");
 
 /**
  * View Class
+ * @category saltcorn-data
  */
 class View {
+  /**
+   * View constructor
+   * @param {object} o
+   */
   constructor(o) {
     this.name = o.name;
     this.id = o.id;
@@ -46,6 +53,11 @@ class View {
     this.default_render_page = o.default_render_page;
     contract.class(this);
   }
+
+  /**
+   * @param {object} where
+   * @returns {View}
+   */
   static findOne(where) {
     const { getState } = require("../db/state");
     const v = getState().views.find(
@@ -61,20 +73,22 @@ class View {
   }
 
   /**
-   *
    * @param where
    * @param selectopts
-   * @returns {Promise<*>}
+   * @returns {Promise<View[]>}
    */
   static async find(where, selectopts = { orderBy: "name", nocase: true }) {
+    if (selectopts.cached) {
+      const { getState } = require("../db/state");
+      return getState().views.map((t) => new View(t));
+    }
     const views = await db.select("_sc_views", where, selectopts);
 
     return views.map((v) => new View(v));
   }
 
   /**
-   *
-   * @returns {Promise<*|*[]>}
+   * @returns {Promise<object[]>}
    */
   async get_state_fields() {
     if (this.viewtemplateObj && this.viewtemplateObj.get_state_fields) {
@@ -88,7 +102,7 @@ class View {
 
   /**
    * Get menu label
-   * @returns {*|undefined}
+   * @type {string|undefined}
    */
   get menu_label() {
     const { getState } = require("../db/state");
@@ -98,10 +112,9 @@ class View {
   }
 
   /**
-   *
    * @param table
    * @param pred
-   * @returns {Promise<*[]>}
+   * @returns {Promise<object[]>}
    */
   static async find_table_views_where(table, pred) {
     var link_view_opts = [];
@@ -133,6 +146,9 @@ class View {
     return link_view_opts;
   }
 
+  /**
+   * @type {object}
+   */
   get select_option() {
     return {
       name: this.name,
@@ -146,6 +162,10 @@ class View {
     };
   }
 
+  /**
+   * @param {function} pred
+   * @returns {Promise<object>}
+   */
   static async find_all_views_where(pred) {
     var link_view_opts = [];
     const link_views = await View.find({}, { orderBy: "name", nocase: true });
@@ -165,6 +185,10 @@ class View {
     return link_view_opts;
   }
 
+  /**
+   * @param {Table|object} table
+   * @returns {Promise<View[]>}
+   */
   static async find_possible_links_to_table(table) {
     return View.find_table_views_where(table, ({ state_fields }) =>
       state_fields.some((sf) => sf.name === "id" || sf.primary_key)
@@ -254,15 +278,27 @@ class View {
     await require("../db/state").getState().refresh_views();
   }
 
+  /**
+   * @param {*} arg
+   * @returns {Promise<object>}
+   */
   async authorise_post(arg) {
     if (!this.viewtemplateObj.authorise_post) return false;
     return await this.viewtemplateObj.authorise_post(arg);
   }
+
+  /**
+   * @param {*} arg
+   * @returns {Promise<object>}
+   */
   async authorise_get(arg) {
     if (!this.viewtemplateObj.authorise_get) return false;
     return await this.viewtemplateObj.authorise_get(arg);
   }
 
+  /**
+   * @returns {string}
+   */
   getStringsForI18n() {
     if (!this.viewtemplateObj || !this.viewtemplateObj.getStringsForI18n)
       return [];
@@ -290,12 +326,23 @@ class View {
       throw error;
     }
   }
+
+  /**
+   * @throws {InvalidConfiguration}
+   */
   check_viewtemplate() {
     if (!this.viewtemplateObj)
       throw new InvalidConfiguration(
         `Cannot find viewtemplate ${this.viewtemplate} in view ${this.name}`
       );
   }
+
+  /**
+   * @param {*} query
+   * @param {*} req
+   * @param {*} res
+   * @returns {Promise<object>}
+   */
   async run_possibly_on_page(query, req, res) {
     const view = this;
     this.check_viewtemplate();
@@ -317,6 +364,12 @@ class View {
     return contents;
   }
 
+  /**
+   * @param {*} query
+   * @param {*} extraArgs
+   * @throws {InvalidConfiguration}
+   * @returns {Promise<object>}
+   */
   async runMany(query, extraArgs) {
     this.check_viewtemplate();
     try {
@@ -354,6 +407,13 @@ class View {
       `runMany on view ${this.name}: viewtemplate ${this.viewtemplate} does not have renderRows or runMany methods`
     );
   }
+
+  /**
+   * @param {*} query
+   * @param {*} body
+   * @param {*} extraArgs
+   * @returns {Promise<object>}
+   */
   async runPost(query, body, extraArgs) {
     this.check_viewtemplate();
     return await this.viewtemplateObj.runPost(
@@ -366,6 +426,13 @@ class View {
     );
   }
 
+  /**
+   * @param {*} route
+   * @param {*} body
+   * @param {*} res
+   * @param {*} extraArgs
+   * @returns {Promise<void>}
+   */
   async runRoute(route, body, res, extraArgs) {
     this.check_viewtemplate();
     const result = await this.viewtemplateObj.routes[route](
@@ -380,6 +447,10 @@ class View {
     else res.json({ success: "ok" });
   }
 
+  /**
+   * @param {object} req_query
+   * @returns {object}
+   */
   combine_state_and_default_state(req_query) {
     var state = { ...req_query };
     this.check_viewtemplate();
@@ -394,6 +465,12 @@ class View {
     });
     return state;
   }
+
+  /**
+   * @param {object} query
+   * @param {object} req
+   * @returns {Promise<Form|null>}
+   */
   async get_state_form(query, req) {
     this.check_viewtemplate();
     const vt_display_state_form = this.viewtemplateObj.display_state_form;
@@ -427,6 +504,10 @@ class View {
     } else return null;
   }
 
+  /**
+   * @param {object} req
+   * @returns {Promise<object>}
+   */
   async get_config_flow(req) {
     this.check_viewtemplate();
     const configFlow = this.viewtemplateObj.configuration_workflow(req);

package/models/workflow.js

@@ -1,10 +1,24 @@
+/**
+ * view description
+ * @category saltcorn-data
+ * @module models/workflow
+ * @subcategory models
+ */
 const db = require("../db");
 const { getState } = require("../db/state");
 const Field = require("./field");
 const { contract, is } = require("contractis");
 const { applyAsync, apply } = require("../utils");
 
+/**
+ * Workflow class
+ * @category saltcorn-data
+ */
 class Workflow {
+  /**
+   * Workflow constructor
+   * @param {*} o 
+   */
   constructor(o) {
     this.steps = o.steps || [];
     this.onDone = o.onDone || ((c) => c);
@@ -12,6 +26,12 @@ class Workflow {
     this.__ = (s) => s;
     contract.class(this);
   }
+
+  /**
+   * @param {object} body 
+   * @param {object} req 
+   * @returns {Promise<object>}
+   */
   async run(body, req) {
     if (req) this.__ = (s) => req.__(s);
     if (!body || !body.stepName) {
@@ -77,6 +97,12 @@ class Workflow {
       return this.runStep({ ...context, ...toCtx }, stepIx + 1);
     }
   }
+  
+  /**
+   * @param {object} context 
+   * @param {number} stepIx 
+   * @returns {Promise<object>}
+   */
   async runStep(context, stepIx) {
     if (stepIx >= this.steps.length) {
       return await this.onDone(context);
@@ -149,6 +175,11 @@ class Workflow {
     }
   }
 
+  /**
+   * @param {object} step 
+   * @param {number} stepIx 
+   * @returns {string}
+   */
   title(step, stepIx) {
     return `${step.name} (${this.__("step")} ${stepIx + 1} / ${
       this.steps.length > stepIx + 1 ? this.__("max") + " " : ""

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saltcorn/data",
-  "version": "0.6.1-beta.0",
+  "version": "0.6.1",
   "description": "Data models for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
   "scripts": {
@@ -9,8 +9,13 @@
   "author": "Tom Nielsen",
   "license": "MIT",
   "main": "index.js",
+  "optionalDependencies": {
+    "@saltcorn/postgres": "0.6.1",
+    "@saltcorn/sqlite": "0.6.1"
+  },
   "dependencies": {
-    "@saltcorn/markup": "0.6.1-beta.0",
+    "@saltcorn/markup": "0.6.1",
+    "@saltcorn/db-common": "0.6.1",
     "acorn": "^8.0.3",
     "adm-zip": "0.5.5",
     "astring": "^1.4.3",
@@ -32,10 +37,7 @@
     "moment-timezone": "^0.5.33",
     "node-fetch": "2.6.2",
     "nodemailer": "^6.4.17",
-    "pg": "^8.2.1",
-    "pg-copy-streams": "^5.1.1",
     "pluralize": "^8.0.0",
-    "sqlite3": "^5.0.2",
     "tmp-promise": "^3.0.2",
     "uuid": "^8.2.0"
   },

package/plugin-helper.js

@@ -1,6 +1,7 @@
 /**
  * Plugin-helper
- *
+ * @category saltcorn-data
+ * @module plugin-helper
  */
 const View = require("./models/view");
 const Field = require("./models/field");
@@ -22,14 +23,17 @@ const { applyAsync, InvalidConfiguration } = require("./utils");
 const { jsexprToSQL } = require("./models/expression");
 /**
  *
- * @param url
- * @param label
- * @param popup
- * @param link_style
- * @param link_size
- * @param link_icon
- * @param textStyle
- * @returns {string}
+ * @param {string} url
+ * @param {string} label
+ * @param {boolean} [popup]
+ * @param {string} [link_style = ""]
+ * @param {string} [link_size = ""]
+ * @param {string} [link_icon = ""]
+ * @param {string} [textStyle = ""]
+ * @param {string} [link_bgcol]
+ * @param {string} [link_bordercol]
+ * @param {string} [link_textcol]
+ * @returns {button|a}
  */
 const link_view = (
   url,
@@ -76,6 +80,11 @@ const link_view = (
     );
 };
 
+/**
+ * @function
+ * @param {object} [state]
+ * @returns {string}
+ */
 const stateToQueryString = contract(
   is.fun(is.maybe(is.obj()), is.str),
   (state) => {
@@ -94,9 +103,12 @@ const stateToQueryString = contract(
     );
   }
 );
+
 /**
- *
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {Field[]} fields
+ * @param {boolean}
+ * @returns {object}
  */
 const calcfldViewOptions = contract(
   is.fun(
@@ -148,9 +160,12 @@ const calcfldViewOptions = contract(
     return { field_view_options: fvs, handlesTextStyle };
   }
 );
+
 /**
- *
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {Field[]} fields
+ * @param {boolean}
+ * @returns {Promise<object>}
  */
 const calcfldViewConfig = contract(
   is.fun([is.array(is.class("Field")), is.bool], is.promise(is.obj())),
@@ -173,9 +188,13 @@ const calcfldViewConfig = contract(
     return fieldViewConfigForms;
   }
 );
+
 /**
- *
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {Table|object} table
+ * @param {string} viewname
+ * @param {boolean}
+ * @returns {Promise<object[]>}
  */
 const get_link_view_opts = contract(
   is.fun(
@@ -235,19 +254,24 @@ const get_link_view_opts = contract(
     return link_view_opts;
   }
 );
+
 /**
  * Get Action configuration fields
- * @param action
- * @param table
- * @returns {Promise<*|[{name: string, label: string, type: string}, {name: string, label: string, type: string, sublabel: string}]|[{name: string, label: string, type: string, sublabel: string}]|[{name: string, type: string}]|[{name: string, label: string, type: string}]|*|*[]>}
+ * @param {object} action
+ * @param {object} table
+ * @returns {Promise<object[]>}
  */
 const getActionConfigFields = async (action, table) =>
   typeof action.configFields === "function"
     ? await action.configFields({ table })
     : action.configFields || [];
+
 /**
- *
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {Table|object} table
+ * @param {string} viewname
+ * @param {object} req
+ * @returns {Promise<object[]>}
  */
 const field_picker_fields = contract(
   is.fun(
@@ -652,9 +676,13 @@ const field_picker_fields = contract(
     ];
   }
 );
+
 /**
  * get_child_views Contract
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {Table|object} table
+ * @param {string} viewname
+ * @returns {Promise<object[]>}
  */
 const get_child_views = contract(
   is.fun(
@@ -684,9 +712,13 @@ const get_child_views = contract(
     return child_views;
   }
 );
+
 /**
  * get_parent_views Contract
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {Table|object} table
+ * @param {string} viewname
+ * @returns {Promise<object[]>}
  */
 const get_parent_views = contract(
   is.fun(
@@ -722,9 +754,13 @@ const get_parent_views = contract(
     return parent_views;
   }
 );
+
 /**
  * get_onetoone_views Contract
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {Table|is_tablely} table
+ * @param {string} viewname
+ * @returns {Promise<object[]>}
  */
 const get_onetoone_views = contract(
   is.fun(
@@ -761,7 +797,11 @@ const get_onetoone_views = contract(
 
 /**
  * picked_fields_to_query Contract
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {object[]} columns
+ * @param {Field[]} fields
+ * @throws {InvalidConfiguration}
+ * @returns {object}
  */
 const picked_fields_to_query = contract(
   is.fun([is.array(is_column), is.array(is.class("Field"))], is_table_query),
@@ -831,9 +871,13 @@ const picked_fields_to_query = contract(
     return { joinFields, aggregations };
   }
 );
+
 /**
- *
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {object}
+ * @param {object}
+ * @param {string} - missing in contract
+ * @returns {object}
  */
 const stateFieldsToQuery = contract(
   is.fun(is.obj(), is.obj()),
@@ -863,19 +907,26 @@ const stateFieldsToQuery = contract(
     return q;
   }
 );
+
 /**
  *
- * @param container
- * @param key
- * @param x
+ * @param {object} container
+ * @param {string} key
+ * @param {object} x
+ * @returns {void}
  */
 const addOrCreateList = (container, key, x) => {
   if (container[key]) container[key].push(x);
   else container[key] = [x];
 };
+
 /**
- *
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {object} opts
+ * @param {Field[]} opts.fields
+ * @param {object} opts.state missing in contract
+ * @param {boolean} [opts.approximate = true]
+ * @returns {object}
  */
 const stateFieldsToWhere = contract(
   is.fun(
@@ -936,9 +987,12 @@ const stateFieldsToWhere = contract(
     return qstate;
   }
 );
+
 /**
  * initial_config_all_fields Contract
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {boolean}
+ * @returns {function}
  */
 const initial_config_all_fields = contract(
   is.fun(
@@ -1049,20 +1103,22 @@ const initial_config_all_fields = contract(
     return cfg;
   }
 );
+
 /**
  *
- * @param x
+ * @param {string} x
  * @returns {number|undefined}
  */
 const strictParseInt = (x) => {
   const y = +x;
   return !isNaN(y) && y ? y : undefined;
 };
+
 /**
  *
- * @param state
- * @param fields
- * @returns {*}
+ * @param {object} state
+ * @param {object[]} fields
+ * @returns {object}
  */
 const readState = (state, fields, req) => {
   fields.forEach((f) => {
@@ -1081,10 +1137,11 @@ const readState = (state, fields, req) => {
   });
   return state;
 };
+
 /**
  *
- * @param state
- * @param fields
+ * @param {object} state
+ * @param {object[]} fields
  * @returns {boolean|*}
  */
 const readStateStrict = (state, fields) => {
@@ -1116,9 +1173,9 @@ const readStateStrict = (state, fields) => {
 };
 /**
  *
- * @param get_json_list
- * @param fields0
- * @returns {any[]|{child_relations: *[], child_field_list: *[]}|{readonly min_role_read: *, get_child_relations(): {child_relations: [], child_field_list: []}, external: boolean, getFields(): *, owner_fieldname(): null, getJoinedRows(*=): Promise<*|*>, countRows(*): Promise<*>, distinctValues(*): Promise<*>, getRows: ((function(*=, *=): Promise<*|*>)|*), fields, get_parent_relations(): {parent_relations: [], parent_field_list: []}}|{parent_relations: *[], parent_field_list: *[]}|null|*|number|Promise<*|*>}
+ * @param {function} get_json_list
+ * @param {object[]} fields0
+ * @returns {object}
  */
 const json_list_to_external_table = (get_json_list, fields0) => {
   const fields = fields0.map((f) =>
@@ -1186,11 +1243,12 @@ const json_list_to_external_table = (get_json_list, fields0) => {
   };
   return tbl;
 };
+
 /**
  *
- * @param col
- * @param req
- * @param rest
+ * @param {object} col
+ * @param {object} req
+ * @param {...*} rest
  * @returns {Promise<*>}
  */
 const run_action_column = async ({ col, req, ...rest }) => {

package/plugin-testing.js

@@ -1,3 +1,7 @@
+/**
+ * @category saltcorn-data
+ * @module plugin-testing
+ */
 const { contract, is, auto_test } = require("contractis");
 const { is_plugin_wrap, is_plugin } = require("./contracts");
 const { getState } = require("./db/state");