@saltcorn/data 0.6.1-beta.0 → 0.6.1

package/models/config.js

@@ -1,29 +1,33 @@
 /**
  * Config Variables
- *
+ * @category saltcorn-data
+ * @module models/config
+ * @subcategory models
  */
-
 const db = require("../db");
 const { contract, is } = require("contractis");
 const latestVersion = require("latest-version");
 const { getConfigFile, configFilePath } = require("../db/connect");
 const fs = require("fs");
 const moment = require("moment-timezone");
-/**
- * Config variables types
- * @type {{custom_ssl_private_key: {default: string, fieldview: string, label: string, type: string, hide_value: boolean}, allow_signup: {default: boolean, label: string, type: string, blurb: string}, smtp_host: {default: string, label: string, type: string, blurb: string}, min_role_upload: {default: string, label: string, type: string, blurb: string, required: boolean}, next_hourly_event: {default: null, label: string, type: string}, favicon_id: {default: number, attributes: {select_file_where: {min_role_read: number, mime_super: string}}, label: string, type: string, blurb: string}, login_form: {default: string, label: string, type: string, blurb: string}, installed_packs: {default: *[], label: string, type: string}, custom_ssl_certificate: {default: string, fieldview: string, label: string, type: string, hide_value: boolean}, page_custom_css: {default: string, input_type: string, attributes: {mode: string}, label: string, hide_value: boolean}, cookie_sessions: {default: boolean, restart_required: boolean, root_only: boolean, label: string, type: string, blurb: string}, elevate_verified: {label: string, type: string, blurb: string}, available_plugins: {label: string, type: string}, login_menu: {default: boolean, label: string, type: string, blurb: string}, role_to_create_tenant: {default: string, label: string, type: string, blurb: string}, available_packs: {label: string, type: string}, site_name: {default: string, label: string, type: string, blurb: string}, log_sql: {default: boolean, onChange(*=): void, label: string, type: string, blurb: string}, next_weekly_event: {default: null, label: string, type: string}, admin_home: {default: string, label: string, type: string}, smtp_port: {default: string, label: string, type: string}, allow_forgot: {default: boolean, label: string, type: string, blurb: string}, menu_items: {label: string, type: string}, email_mask: {default: string, label: string, type: string, blurb: string}, latest_npm_version: {default: {}, label: string, type: string}, next_daily_event: {default: null, label: string, type: string}, exttables_min_role_read: {default: {}, label: string, type: string}, layout_by_role: {default: {}, label: string, type: string}, timeout: {default: number, restart_required: boolean, root_only: boolean, label: string, type: string, sublabel: string}, smtp_username: {default: string, label: string, type: string}, smtp_password: {default: string, input_type: string, label: string, type: string}, create_tenant_warning: {default: boolean, label: string, type: string, blurb: string}, home_page_by_role: {label: string, type: string}, staff_home: {default: string, label: string, type: string}, development_mode: {default: boolean, label: string, type: string, blurb: string}, page_custom_html: {default: string, input_type: string, attributes: {mode: string}, label: string, hide_value: boolean}, multitenancy_enabled: {default: boolean, restart_required: boolean, onChange(*=): void, root_only: boolean, label: string, type: string}, signup_form: {default: string, label: string, type: string, blurb: string}, user_home: {default: string, label: string, type: string}, base_url: {default: string, onChange(*=): void, label: string, type: string, blurb: string}, site_logo_id: {default: number, attributes: {select_file_where: {min_role_read: number, mime_super: string}}, label: string, type: string, blurb: string}, available_plugins_fetched_at: {label: string, type: string}, user_settings_form: {default: string, label: string, type: string, blurb: string}, public_home: {default: string, label: string, type: string}, new_user_form: {default: string, label: string, type: string, blurb: string}, smtp_secure: {default: boolean, label: string, type: string, sublabel: string}, globalSearch: {label: string, type: string}, letsencrypt: {default: boolean, root_only: boolean, label: string, type: string, blurb: string}, verification_view: {default: string, label: string, type: string, blurb: string}, available_packs_fetched_at: {label: string, type: string}, email_from: {default: string, label: string, type: string, blurb: string}, custom_http_headers: {default: string, input_type: string, attributes: {mode: string}, label: string, blurb: string, hide_value: boolean}}}
- */
 
 const allTimezones = moment.tz.names();
 const defaultTimezone = moment.tz.guess();
 
+/**
+ * Config variables types
+ * @namespace
+ * @category saltcorn-data
+ */
 const configTypes = {
+  /** @type {object} */
   site_name: {
     type: "String",
     label: "Site name",
     default: "Saltcorn",
     blurb: "A short string which is the name of your site",
   },
+  /** @type {object} */
   timezone: {
     type: "String",
     label: "Home Timezone",
@@ -32,6 +36,7 @@ const configTypes = {
       options: allTimezones,
     },
   },
+  /** @type {object} */
   site_logo_id: {
     type: "File",
     label: "Site logo",
@@ -41,6 +46,7 @@ const configTypes = {
     },
     blurb: "Select a publicly accessible image file for the menu logo",
   },
+  /** @type {object} */
   favicon_id: {
     type: "File",
     label: "Favicon",
@@ -50,6 +56,7 @@ const configTypes = {
     },
     blurb: "Select a publicly accessible image file for the browser tab icon",
   },
+  /** @type {object} */
   base_url: {
     type: "String",
     label: "Base URL",
@@ -65,35 +72,50 @@ const configTypes = {
     blurb:
       "The URL at which your site is available. For instance, https://example.com/",
   },
+  /** @type {object} */
   menu_items: { type: "hidden", label: "Menu items" },
+  /** @type {object} */
   globalSearch: { type: "hidden", label: "Global search" },
+  /** @type {object} */
   available_packs: { type: "hidden", label: "Available packs" },
+  /** @type {object} */
   available_packs_fetched_at: {
     type: "Date",
     label: "Available packs fetched",
   },
+  /** @type {object} */
   available_plugins: { type: "hidden", label: "Available plugins" },
+  /** @type {object} */
   available_plugins_fetched_at: {
     type: "Date",
     label: "Available plugins fetched",
   },
+  /** @type {object} */
   home_page_by_role: { type: "hidden", label: "Home Page by Role" },
+  /** @type {object} */
   exttables_min_role_read: {
     type: "hidden",
     label: "Home Page by Role",
     default: {},
   },
+  /** @type {object} */
   public_home: { type: "String", label: "Public home page", default: "" },
+  /** @type {object} */
   user_home: { type: "String", label: "User home page", default: "" },
+  /** @type {object} */
   staff_home: { type: "String", label: "Staff home page", default: "" },
+  /** @type {object} */
   admin_home: { type: "String", label: "Admin home page", default: "" },
+  /** @type {object} */
   layout_by_role: { type: "hidden", label: "Layout by role", default: {} },
+  /** @type {object} */
   allow_signup: {
     type: "Bool",
     label: "Allow signups",
     default: true,
     blurb: "Allow users to sign up for a new user account",
   },
+  /** @type {object} */
   allow_forgot: {
     type: "Bool",
     label: "Allow password reset",
@@ -101,12 +123,14 @@ const configTypes = {
     blurb:
       "Allow users to request a password reset email. Email must be configured.",
   },
+  /** @type {object} */
   login_menu: {
     type: "Bool",
     label: "Login in menu",
     default: true,
     blurb: "Show the login link in the menu",
   },
+  /** @type {object} */
   cookie_sessions: {
     type: "Bool",
     label: "Cookie sessions",
@@ -115,30 +139,35 @@ const configTypes = {
     restart_required: true,
     blurb: "Store sessions entirely in client cookies for higher performance",
   },
+  /** @type {object} */
   new_user_form: {
     type: "View users",
     label: "New user form",
     default: "",
     blurb: "A view to show to new users",
   },
+  /** @type {object} */
   user_settings_form: {
     type: "View users",
     label: "User settings form",
     default: "",
     blurb: "A view for users to change their custom user fields",
   },
+  /** @type {object} */
   login_form: {
     type: "View users",
     label: "Login view",
     blurb: "A view with the login form",
     default: "",
   },
+  /** @type {object} */
   signup_form: {
     type: "View users",
     label: "Signup view",
     blurb: "A view with the signup form",
     default: "",
   },
+  /** @type {object} */
   verification_view: {
     type: "View users",
     label: "Verification view",
@@ -146,12 +175,14 @@ const configTypes = {
       "A view with the view to be emailed to users for email address verification",
     default: "",
   },
+  /** @type {object} */
   elevate_verified: {
     type: "Role",
     label: "Elevate verified to role",
     blurb:
       "Elevate users to a higher role when their email addresses have been verified",
   },
+  /** @type {object} */
   min_role_upload: {
     type: "Role",
     label: "Role to upload files",
@@ -160,13 +191,16 @@ const configTypes = {
     blurb:
       "User should have this role or higher to upload files with API (uploads through forms are not affected)",
   },
+  /** @type {object} */
   email_mask: {
     type: "String",
     label: "Email mask",
     default: "",
     blurb: "Emails used for signup must end with this string",
   },
+  /** @type {object} */
   installed_packs: { type: "String[]", label: "Installed packs", default: [] },
+  /** @type {object} */
   log_sql: {
     type: "Bool",
     label: "Log SQL to stdout",
@@ -176,6 +210,7 @@ const configTypes = {
     },
     blurb: "Print all SQL statements to the standard output",
   },
+  /** @type {object} */
   multitenancy_enabled: {
     type: "Bool",
     root_only: true,
@@ -186,12 +221,14 @@ const configTypes = {
       set_multitenancy_cfg(val);
     },
   },
+  /** @type {object} */
   role_to_create_tenant: {
     type: "Role",
     label: "Role to create tenants",
     blurb: "Minimum user role required to create a new tenant",
     default: "10",
   },
+  /** @type {object} */
   create_tenant_warning: {
     type: "Bool",
     label: "Create tenant warning",
@@ -199,6 +236,13 @@ const configTypes = {
     blurb:
       "Show a warning to users creating a tenant disclaiming warrenty of availability or security",
   },
+  /** @type {object} */
+  tenant_template: {
+    type: "Tenant",
+    label: "New tenant template",
+    blurb: "Copy site structure for new tenants from this tenant",
+  },
+  /** @type {object} */
   development_mode: {
     type: "Bool",
     label: "Development mode",
@@ -206,6 +250,7 @@ const configTypes = {
     blurb:
       "Disable JS/CSS asset caching, show full error to user on crash, enable editing field type",
   },
+  /** @type {object} */
   smtp_host: {
     type: "String",
     label: "SMTP host",
@@ -213,12 +258,14 @@ const configTypes = {
     blurb:
       "The host address of your SMTP server. For instance, smtp.postmarkapp.com",
   },
+  /** @type {object} */
   smtp_username: {
     type: "String",
     label: "SMTP username",
     default: "",
     blurb: "The user name to access SMTP server for sending emails.",
   },
+  /** @type {object} */
   smtp_password: {
     type: "String",
     label: "SMTP password",
@@ -229,12 +276,14 @@ const configTypes = {
       "If your SMTP provider allows to create app password for using from application " +
       "We recommends to use app password instead of user password.",
   },
+  /** @type {object} */
   smtp_port: {
     type: "Integer",
     label: "SMTP port",
     default: "25",
     blurb: "The port of your SMTP server",
   },
+  /** @type {object} */
   smtp_secure: {
     type: "Bool",
     label: "Force TLS",
@@ -242,6 +291,7 @@ const configTypes = {
     sublabel:
       "Always use TLS when connecting to server? If unchecked, TLS is used if server supports the STARTTLS extension. In most cases check this box if you are connecting to port 465. For port 587 or 25 keep it unchecked",
   },
+  /** @type {object} */
   email_from: {
     type: "String",
     label: "Email from address",
@@ -249,6 +299,7 @@ const configTypes = {
     blurb:
       "The email address from which emails are sent. For instance, hello@saltcorn.com",
   },
+  /** @type {object} */
   custom_ssl_certificate: {
     type: "String",
     fieldview: "textarea",
@@ -256,6 +307,7 @@ const configTypes = {
     default: "",
     hide_value: true,
   },
+  /** @type {object} */
   custom_ssl_private_key: {
     type: "String",
     fieldview: "textarea",
@@ -263,6 +315,7 @@ const configTypes = {
     hide_value: true,
     default: "",
   },
+  /** @type {object} */
   letsencrypt: {
     label: "LetsEncrypt enabled",
     default: false,
@@ -270,6 +323,7 @@ const configTypes = {
     root_only: true,
     blurb: "Enable SSL certificate from Let's Encrypt for HTTPS traffic",
   },
+  /** @type {object} */
   timeout: {
     type: "Integer",
     label: "HTTP timeout (s)",
@@ -278,21 +332,25 @@ const configTypes = {
     restart_required: true,
     sublabel: "Increase if you expect large uploads",
   },
+  /** @type {object} */
   latest_npm_version: {
     type: "hidden",
     label: "Latest npm version cache",
     default: {},
   },
+  /** @type {object} */
   event_log_settings: {
     type: "hidden",
     label: "Event log settings",
     default: {},
   },
+  /** @type {object} */
   custom_events: {
     type: "hidden",
     label: "Custom events",
     default: [],
   },
+  /** @type {object} */
   page_custom_css: {
     input_type: "code",
     label: "Custom CSS",
@@ -300,6 +358,7 @@ const configTypes = {
     hide_value: true,
     attributes: { mode: "text/css" },
   },
+  /** @type {object} */
   page_custom_html: {
     input_type: "code",
     label: "Custom HTML",
@@ -307,6 +366,7 @@ const configTypes = {
     hide_value: true,
     attributes: { mode: "text/html" },
   },
+  /** @type {object} */
   custom_http_headers: {
     input_type: "code",
     label: "Custom HTTP headers",
@@ -315,26 +375,31 @@ const configTypes = {
     hide_value: true,
     attributes: { mode: "message/http" },
   },
+  /** @type {object} */
   next_hourly_event: {
     type: "Date",
     label: "Next hourly event",
     default: null,
   },
+  /** @type {object} */
   next_daily_event: {
     type: "Date",
     label: "Next daily event",
     default: null,
   },
+  /** @type {object} */
   next_weekly_event: {
     type: "Date",
     label: "Next weekly event",
     default: null,
   },
+  /** @type {object} */
   localizer_languages: {
     type: "hidden",
     label: "Localizer languages",
     default: {},
   },
+  /** @type {object} */
   localizer_strings: {
     type: "hidden",
     label: "Localizer strings",
@@ -370,7 +435,10 @@ const available_languages = {
 };
 /**
  * Get Config variable value by key (contract)
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {string} key
+ * @param {object|undefined} def
+ * @returns {Promise<object>}
  */
 const getConfig = contract(
   is.fun([is.str, is.maybe(is.any)], is.promise(is.any)),
@@ -382,18 +450,21 @@ const getConfig = contract(
     else return configTypes[key] ? configTypes[key].default : undefined;
   }
 );
+
 /**
  * Returns true if key is defined in fixed_configration for tenant
- * @param key
- * @returns {boolean|*}
+ * @param {string} key
+ * @returns {boolean}
  */
 const isFixedConfig = (key) =>
   typeof db.connectObj.fixed_configuration[key] !== "undefined" ||
   (db.connectObj.inherit_configuration.includes(key) &&
     db.getTenantSchema() !== db.connectObj.default_schema);
+
 /**
- *  Get all config variables list
- * @type {*|(function(...[*]=): *)}
+ * Get all config variables list
+ * @function
+ * @returns {Promise<object>}
  */
 const getAllConfig = contract(
   is.fun([], is.promise(is.objVals(is.any))),
@@ -419,10 +490,12 @@ const getAllConfig = contract(
     return cfg;
   }
 );
+
 /**
  * Get all config variables list
  * If variable is not defined that default value is used
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @returns {Promise<object>}
  */
 const getAllConfigOrDefaults = contract(
   is.fun([], is.promise(is.objVals(is.any))),
@@ -441,7 +514,10 @@ const getAllConfigOrDefaults = contract(
 
 /**
  * Set config variable value by key
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {string} key
+ * @param {object} value
+ * @returns {Promise<void>}
  */
 // TODO move db specific to pg/sqlite
 const setConfig = contract(
@@ -465,7 +541,9 @@ const setConfig = contract(
 );
 /**
  * Delete config variable
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {string} key
+ * @returns {Promise<void>}
  */
 const deleteConfig = contract(
   is.fun(is.str, is.promise(is.undefined)),
@@ -473,9 +551,12 @@ const deleteConfig = contract(
     await db.deleteWhere("_sc_config", { key });
   }
 );
+
 /**
  * Remove from menu
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {object} item
+ * @returns {Promise<void>}
  */
 const remove_from_menu = contract(
   is.fun(
@@ -501,10 +582,11 @@ const remove_from_menu = contract(
     await getState().setConfig("menu_items", new_menu);
   }
 );
+
 /**
  * Get latest npm version
- * @param pkg
- * @returns {Promise<*|string|*>}
+ * @param {string} pkg
+ * @returns {Promise<string>}
  */
 const get_latest_npm_version = async (pkg) => {
   const { getState } = require("../db/state");
@@ -527,15 +609,17 @@ const get_latest_npm_version = async (pkg) => {
     else return "";
   }
 };
+
 /**
  * Ensure that string is finished with /
- * @param s
- * @returns {*|string}
+ * @param {string} s
+ * @returns {string}
  */
 const ensure_final_slash = (s) => (s.endsWith("/") ? s : s + "/");
+
 /**
  * Get base url
- * @param req
+ * @param {object} req
  * @returns {string}
  */
 const get_base_url = (req) => {
@@ -552,9 +636,12 @@ const get_base_url = (req) => {
   }
   return `${req.protocol}://${req.hostname}${ports}/`;
 };
+
 /**
  * Check email mask
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {string} email
+ * @returns {boolean}
  */
 const check_email_mask = contract(is.fun(is.str, is.bool), (email) => {
   const { getState } = require("../db/state");
@@ -564,15 +651,19 @@ const check_email_mask = contract(is.fun(is.str, is.bool), (email) => {
     return email.endsWith(cfg);
   } else return true;
 });
+
 /**
  * Set multitenancy cfg flag
- * @type {*|(function(...[*]=): *)}
+ * @function
+ * @param {boolean} val
+ * @returns {void}
  */
 const set_multitenancy_cfg = contract(is.fun(is.bool, is.undefined), (val) => {
   const cfg = getConfigFile();
   cfg.multi_tenant = val;
   fs.writeFileSync(configFilePath, JSON.stringify(cfg, null, 2));
 });
+
 module.exports = {
   getConfig,
   getAllConfig,

package/models/crash.js

@@ -1,8 +1,22 @@
+/**
+ * Crash Database Access Layer
+ * @category saltcorn-data
+ * @module models/crash
+ * @subcategory models
+ */
 const db = require("../db");
 const moment = require("moment");
 const { contract, is } = require("contractis");
 
+/**
+ * Crash Class
+ * @category saltcorn-data
+ */
 class Crash {
+  /**
+    * Crash constructor
+    * @param {object} o
+    */
   constructor(o) {
     this.id = o.id;
     this.stack = o.stack;
@@ -18,25 +32,55 @@ class Crash {
       typeof o.headers === "string" ? JSON.parse(o.headers) : o.headers;
     contract.class(this);
   }
+
+  /**
+   * @param {object} where 
+   * @param {object} selopts 
+   * @returns {Promise<Crash[]>}
+   */
   static async find(where, selopts) {
     const us = await db.select("_sc_errors", where, selopts);
     return us.map((u) => new Crash(u));
   }
+
+  /**
+   * @param {object} where 
+   * @returns {Promise<Crash>}
+   */
   static async findOne(where) {
     const u = await db.selectOne("_sc_errors", where);
     return new Crash(u);
   }
+
+  /**
+   * @type {string}
+   */
   get reltime() {
     return moment(this.occur_at).fromNow();
   }
+
+  /**
+   * @param {object} where 
+   * @returns {Promise<number>}
+   */
   static async count(where) {
     return await db.count("_sc_errors", where || {});
   }
+
+  /**
+   * @type {string}
+   */
   get msg_short() {
     return this.message.length > 90
       ? this.message.substring(0, 90)
       : this.message;
   }
+
+  /**
+   * @param {object} err 
+   * @param {object} [req = {}]
+   * @returns {Promise<void>}
+   */
   static async create(err, req = {}) {
     const schema = db.getTenantSchema();
     const payload = {

package/models/discovery.js

@@ -1,6 +1,8 @@
 /**
  * DB Tables discovery to Saltcorn tables.
- * @type {{changeConnection?: ((function(*): Promise<void>)|(function(*=): Promise<void>)), select?: ((function(*=, *=, *=): Promise<*>)|(function(*=, *=, *=): Promise<*>)), runWithTenant: ((function(*=, *=): (*))|(function(*, *): *)), set_sql_logging?: (function(*=): void), insert?: ((function(*=, *=, *=): Promise<undefined|*>)|(function(*=, *=, *=): Promise<undefined|*>)), update?: ((function(*=, *=, *=): Promise<void>)|(function(*=, *=, *=, *=): Promise<void>)), sql_log?: (function(*=, *=): void), deleteWhere?: ((function(*=, *=): Promise<void>)|(function(*=, *=): Promise<*>)), isSQLite: *, selectMaybeOne?: ((function(*=, *=): Promise<null|*>)|(function(*=, *=): Promise<null|*>)), close?: (function(): Promise<void>), drop_unique_constraint?: (function(*=, *): Promise<void>), enable_multi_tenant: (function()), getVersion?: ((function(): Promise<*>)|(function(*=): Promise<*>)), add_unique_constraint?: (function(*=, *): Promise<void>), getTenantSchema: ((function(): *)|(function(): *)), is_it_multi_tenant: ((function(): boolean)|(function(): boolean)), sqliteDatabase?: *, drop_reset_schema?: ((function(): Promise<void>)|(function(*): Promise<void>)), query?: ((function(*=, *=): Promise<unknown>)|(function(*=, *=): *)), count?: ((function(*=, *=): Promise<number>)|(function(*=, *=): Promise<number>)), pool?: *, connectObj: {sc_version: *, connectionString: string | undefined, git_commit: *, version_tag: *}|{sc_version: *, git_commit: *, version_tag: *}|boolean, sqlsanitize: *|(function(...[*]=): *), getClient?: (function(): Promise<*>), reset_sequence?: (function(*=): Promise<void>), copyFrom?: (function(*=, *=, *, *): Promise<void>), mkWhere: function(*=): {values: *, where: string|string}, selectOne?: ((function(*=, *=): Promise<*|undefined>)|(function(*=, *=): Promise<*|undefined>)), getTenantSchemaPrefix: function(): string|string}|{sqlsanitize?: *|(function(...[*]=): *), connectObj?: {sc_version: *, connectionString: string | undefined, git_commit: *, version_tag: *}|{sc_version: *, git_commit: *, version_tag: *}|boolean, isSQLite?: *, mkWhere?: function(*=): {values: *, where: string|string}, getTenantSchemaPrefix?: function(): string|string}}
+ * @category saltcorn-data
+ * @module models/discovery
+ * @subcategory models
  */
 const db = require("../db");
 const { getState } = require("../db/state");
@@ -12,8 +14,8 @@ const Table = require("./table");
  * List of discoverable tables.
  * Returns all tables that can be imported to Saltcorn from current tenant database schema.
  * The tables with name started with "_sc_" and tables imported to Saltcorn are ignored.
- * @param schema0 - current tenant db schema
- * @returns {Promise<*>} all tables that can be imported to Saltcorn from current tenant database schema
+ * @param {string} schema0 - current tenant db schema
+ * @returns {Promise<object[]>} all tables that can be imported to Saltcorn from current tenant database schema
  */
 const discoverable_tables = async (schema0) => {
   const schema = schema0 || db.getTenantSchema();
@@ -33,8 +35,8 @@ const discoverable_tables = async (schema0) => {
 };
 /**
  * List all views in current  tenant db schema
- * @param schema0 - current tenant db schema
- * @returns {Promise<*>} Return list of views
+ * @param {string} schema0 - current tenant db schema
+ * @returns {Promise<object[]>} Return list of views
  */
 const get_existing_views = async (schema0) => {
   const schema = schema0 || db.getTenantSchema();
@@ -48,8 +50,8 @@ const get_existing_views = async (schema0) => {
 };
 /**
  * Mapping SQL Type to Saltcorn type
- * @param sql_name - SQL type name
- * @returns {string|*} return Saltcorn type
+ * @param {string} sql_name - SQL type name
+ * @returns {string|void} return Saltcorn type
  */
 const findType = (sql_name) => {
   const fixed = {
@@ -78,9 +80,9 @@ const findType = (sql_name) => {
 };
 /**
  * Discover tables definitions
- * @param tableNames - list of table names
- * @param schema0 - db schema
- * @returns {Promise<{tables: *[]}>}
+ * @param {string[]} tableNames - list of table names
+ * @param {string} schema0 - db schema
+ * @returns {Promise<object>}
  */
 const discover_tables = async (tableNames, schema0) => {
   const schema = schema0 || db.getTenantSchema();
@@ -167,7 +169,7 @@ const discover_tables = async (tableNames, schema0) => {
 };
 /**
  * Add discovered tables to Saltcorn
- * @param pack - table definition
+ * @param {object} pack - table definition
  * @returns {Promise<void>}
  */
 const implement_discovery = async (pack) => {