@saltcorn/data 0.6.2-beta.0 → 0.6.2-beta.4

package/contracts.js

@@ -1,311 +0,0 @@
-/**
- * @category saltcorn-data
- * @module contract
- */
-const { contract, is } = require("contractis");
-
-/**
- * @type {function}
- */
-const fieldlike = is.obj(
-  {
-    name: is.str,
-    input_type: is.maybe(is.str),
-    type: is.maybe(is.or(is.str, is.obj({ name: is.str }))),
-  },
-  (o) => o.type || o.input_type
-);
-
-/**
- * @type {function}
- */
-const is_header = is.obj({ script: is.maybe(is.str) });
-
-/**
- * @type {function}
- */
-const is_menu_item = is.obj({
-  label: is.str,
-  link: is.maybe(is.str),
-  subitems: is.maybe(
-    is.array(
-      is.obj({
-        label: is.str,
-        link: is.maybe(is.str),
-      })
-    )
-  ),
-});
-
-/**
- * @type {function}
- */
-const is_layout_container = is.or(
-  is.eq(null),
-  is.obj({
-    type: is.one_of(
-      "blank card hero pageHeader footer image link line_break view".split(" ")
-    ),
-  }),
-  is.obj({})
-);
-
-/**
- * @type {function}
- */
-const is_layout = is.or(
-  is.obj(
-    {
-      above: is.maybe(
-        is.array(
-          is.or(
-            is_layout_container,
-            is.obj({ besides: is.array(is_layout_container) }),
-            is.obj({ above: is.array(is_layout_container) })
-          )
-        )
-      ),
-      besides: is.maybe(
-        is.array(
-          is.or(
-            is_layout_container,
-            is.obj({ above: is.array(is_layout_container) }),
-            is.obj({ besides: is.array(is_layout_container) })
-          )
-        )
-      ),
-    },
-    (l) => (l.above && !l.besides) || (!l.above && l.besides)
-  ),
-  is.and(is_layout_container, is.obj({}))
-);
-
-/**
- * @type {function}
- */
-const is_plugin_wrap_arg = is.obj({
-  title: is.str,
-  body: is.or(is.str, is_layout),
-  currentUrl: is.str,
-  brand: is.obj({ name: is.str }),
-  menu: is.array(
-    is.obj({
-      section: is.str,
-      items: is.array(is_menu_item),
-    })
-  ),
-  alerts: is.array(
-    is.obj({
-      type: is.one_of(["error", "danger", "success", "warning"]),
-      msg: is.or(is.str, is.array(is.str)),
-    })
-  ),
-  headers: is.array(is_header),
-});
-
-/**
- * @type {function}
- */
-const is_plugin_authwrap_arg = is.obj({
-  title: is.str,
-  form: is.class("Form"),
-  afterForm: is.maybe(is.str),
-  brand: is.obj({ name: is.str, logo: is.maybe(is.str) }),
-  menu: is.array(
-    is.obj({
-      section: is.str,
-      items: is.array(is_menu_item),
-    })
-  ),
-  alerts: is.array(
-    is.obj({
-      type: is.one_of(["error", "danger", "success", "warning"]),
-      msg: is.or(is.str, is.array(is.str)),
-    })
-  ),
-  headers: is.array(is_header),
-  authLinks: is.obj({
-    login: is.maybe(is.str),
-    signup: is.maybe(is.str),
-    forgot: is.maybe(is.str),
-  }),
-});
-
-/**
- * @type {function}
- */
-const is_plugin_wrap = is.fun(is_plugin_wrap_arg, is.str);
-
-/**
- * @type {function}
- */
-const is_plugin_layout = is.obj({
-  wrap: is_plugin_wrap,
-  authWrap: is.maybe(is.fun(is_plugin_authwrap_arg, is.str)),
-});
-
-const is_attribute = is.obj({ name: is.str, type: is.str, required: is.bool });
-
-/**
- * @type {function}
- */
-const is_plugin_type = is.obj({
-  name: is.str,
-  sql_name: is.str,
-  contract: is.maybe(is.fun(is.obj(), is.contract)),
-  fieldviews: is.objVals(
-    is.obj({
-      isEdit: is.bool,
-      run: is.or(
-        is.fun(is.any, is.str),
-        is.fun([is.str, is.any, is.maybe(is.obj()), is.str, is.bool], is.str)
-      ),
-    })
-  ),
-  attributes: is.maybe(
-    is.or(is.fun(is.obj(), is.array(is_attribute)), is.array(is_attribute))
-  ),
-  readFromFormRecord: is.maybe(is.fun([is.obj(), is.str], is.any)),
-  read: is.fun(is.any, is.any),
-  readFromDB: is.maybe(is.fun(is.any, is.any)),
-  validate: is.maybe(is.fun(is.obj(), is.fun(is.any, is.bool))),
-  presets: is.maybe(is.objVals(is.fun([], is.any))),
-});
-
-/**
- * @type {function}
- */
-const is_table_query = is.obj({
-  joinFields: is.maybe(is.objVals(is.obj({ ref: is.str, target: is.str }))),
-  aggregations: is.maybe(
-    is.objVals(
-      is.obj({
-        ref: is.str,
-        table: is.str,
-        field: is.str,
-        aggregate: is.str,
-      })
-    )
-  ),
-  where: is.maybe(is.obj()),
-  limit: is.maybe(is.positive),
-  offset: is.maybe(is.positive),
-  orderBy: is.maybe(is.or(is.str, is.obj({}))),
-  orderDesc: is.maybe(is.bool),
-});
-
-/**
- * @type {function}
- */
-const is_viewtemplate = is.obj({
-  name: is.str,
-  get_state_fields: is.maybe(
-    is.fun([is.posint, is.str, is.any], is.promise(fieldlike))
-  ),
-  display_state_form: is.maybe(is.or(is.bool, is.fun(is.any, is.bool))),
-  configuration_workflow: is.fun(
-    is.obj({ __: is.fun(is.str, is.str) }),
-    is.class("Workflow")
-  ),
-  view_quantity: is.maybe(is.one_of("Many", "ZeroOrOne", "One")),
-  initial_config: is.maybe(
-    is.fun(is.obj({ table_id: is.posint }), is.promise(is.obj()))
-  ),
-  run: is.fun(
-    [is.posint, is.str, is.any, is.obj(), is.obj()],
-    is.promise(is.str)
-  ),
-});
-const is_plugin_function = is.obj({
-  run: is.fun(is.any, is.any),
-  returns: is.maybe(is.str),
-  arguments: is.maybe(is.array(is.str)),
-  isAsync: is.maybe(is.bool),
-});
-
-/**
- * 
- * @param {*} a 
- * @returns {function}
- */
-const is_maybe_cfg_fun = (a) => is.or(is.fun(is.obj, a), a, is.undefined);
-
-/**
- * @type {function}
- */
-const is_plugin = is.obj({
-  sc_plugin_api_version: is.posint,
-  headers: is_maybe_cfg_fun(is.array(is_header)),
-  functions: is_maybe_cfg_fun(
-    is.objVals(is.or(is_plugin_function, is.fun(is.any, is.any)))
-  ),
-  layout: is_maybe_cfg_fun(is_plugin_layout),
-  types: is_maybe_cfg_fun(is.array(is_plugin_type)),
-  viewtemplates: is_maybe_cfg_fun(is.array(is_viewtemplate)),
-  configuration_workflow: is.maybe(is.fun([], is.class("Workflow"))),
-  fieldviews: is.maybe(
-    is.objVals(
-      is.obj(
-        {
-          type: is.str,
-          isEdit: is.bool,
-          run: is.or(
-            is.fun(is.any, is.str),
-            is.fun(
-              [is.str, is.any, is.maybe(is.obj()), is.str, is.bool],
-              is.str
-            )
-          ),
-        },
-        (o) =>
-          (o.isEdit && o.run.length >= 2) || (!o.isEdit && o.run.length == 1)
-      )
-    )
-  ),
-  dependencies: is.maybe(is.array(is.str)),
-});
-
-/**
- * @type {function}
- */
-const is_pack = is.obj({
-  tables: is.array(is.obj({ name: is.str, fields: is.array(fieldlike) })),
-  views: is.array(
-    is.obj({ name: is.str, viewtemplate: is.str, configuration: is.any })
-  ),
-  plugins: is.array(is.obj({ name: is.str, source: is.str, location: is.str })),
-});
-
-/**
- * @type {function}
- */
-const is_column = is.obj({
-  type: is.one_of([
-    "Action",
-    "ViewLink",
-    "Link",
-    "JoinField",
-    "Aggregation",
-    "Field",
-  ]),
-});
-
-/**
- * @type {function}
- */
-const is_tablely = is.or(is.class("Table"), is.obj({ external: is.eq(true) }));
-
-module.exports = {
-  is_table_query,
-  is_plugin_wrap,
-  is_plugin_wrap_arg,
-  is_plugin_type,
-  is_plugin,
-  fieldlike,
-  is_viewtemplate,
-  is_header,
-  is_pack,
-  is_column,
-  is_plugin_layout,
-  is_tablely,
-};

package/db/connect.js

@@ -1,151 +0,0 @@
-/**
- * Controls Saltcorn configuration
- * @category saltcorn-data
- * @module db/connect
- * @subcategory db
- */
-
-const path = require("path");
-const fs = require("fs");
-const envPaths = require("env-paths");
-
-const pathsNoApp = envPaths("", { suffix: "" });
-const pathsWithApp = envPaths("saltcorn", { suffix: "" });
-/**
- * Default data path?
- * @type {string}
- */
-const defaultDataPath = pathsWithApp.data;
-
-/**
- * @param {string|object} x 
- * @returns {object}
- */
-const stringToJSON = (x) => (typeof x === "string" ? JSON.parse(x) : x);
-/**
- * Get Git revision of Saltcorn source.
- * Required to work:
- *  - Git client installed,
- *  - Local git with repo Saltcorn sources.
- * @returns {string} - Return current Git commit
- */
-const getGitRevision = () => {
-  let revision = null;
-  let options = { stdio: "pipe", cwd: __dirname };
-  try {
-    revision = require("child_process")
-      .execSync("git rev-parse HEAD", options)
-      .toString()
-      .trim();
-  } catch (error) {}
-  return revision;
-};
-/**
- * Prepare Saltcorn connection object that controls main Saltcorn instance settings like:
- * - PostgreSQL or SQLite
- * - Connection to DB settings
- * - Multitenant mode
- * - Web Session secret
- * - File store path
- * - Saltcorn confuration inheritance and fixed configuration
- * For all parameters and priority see the code of function.
- * @param {object} [connSpec = {}]
- * @returns {object|boolean}
- */
-const getConnectObject = (connSpec = {}) => {
-  const git_commit = getGitRevision();
-  const sc_version = require("../package.json").version;
-  const version_tag = git_commit || sc_version;
-  var connObj = { version_tag, git_commit, sc_version };
-  const fileCfg = getConfigFile() || {};
-
-  function setKey(k, envnm, opts = {}) {
-    const f = opts.transform || ((x) => x);
-    // Priorities:
-    // 1. getConnectObject argument
-    if (typeof connSpec[k] !== "undefined") connObj[k] = f(connSpec[k]);
-    // 2. Environment variables
-    else if (typeof process.env[envnm] !== "undefined")
-      connObj[k] = f(process.env[envnm]);
-    // 3. Config file
-    else if (typeof fileCfg[k] !== "undefined") connObj[k] = f(fileCfg[k]);
-    // 4. default
-    else if (typeof opts.default !== "undefined") connObj[k] = f(opts.default);
-  }
-
-  setKey("user", "PGUSER");
-  setKey("sqlite_path", "SQLITE_FILEPATH");
-  setKey("host", "PGHOST");
-  setKey("port", "PGPORT");
-  setKey("password", "PGPASSWORD");
-  setKey("database", "PGDATABASE");
-  setKey("session_secret", "SALTCORN_SESSION_SECRET");
-  setKey("multi_tenant", "SALTCORN_MULTI_TENANT", { default: false });
-  setKey("file_store", "SALTCORN_FILE_STORE", { default: pathsWithApp.data });
-  setKey("default_schema", "SALTCORN_DEFAULT_SCHEMA", { default: "public" });
-  setKey("fixed_configuration", "SALTCORN_FIXED_CONFIGURATION", {
-    default: {},
-    transform: stringToJSON,
-  });
-  setKey("inherit_configuration", "SALTCORN_INHERIT_CONFIGURATION", {
-    default: [],
-    transform: stringToJSON,
-  });
-
-  if (process.env.DATABASE_URL) {
-    delete connObj[user];
-    delete connObj[password];
-    delete connObj[database];
-    delete connObj[sqlite_path];
-    return { ...connObj, connectionString: process.env.DATABASE_URL };
-  } else if (
-    connObj.sqlite_path ||
-    (connObj.user && connObj.password && connObj.database)
-  ) {
-    return connObj;
-  } else {
-    return false;
-  }
-};
-/**
- * Path to Config directory
- * @type {string}
- */
-const configFileDir = pathsNoApp.config;
-/**
- * Path to config file .saltcorn
- * @type {string}
- */
-const configFilePath = path.join(configFileDir, ".saltcorn");
-/**
- * Reads Saltcorn configuration file
- * @returns {boolean|any} - Returns JSON presentation of Saltcorn confuration file. Returns false in case of Exception.
- */
-const getConfigFile = () => {
-  try {
-    let rawdata = fs.readFileSync(configFilePath);
-    return JSON.parse(rawdata);
-  } catch (e) {
-    return false;
-  }
-};
-/**
- * Check that Saltcorn configured to use SQLite as database
- * @param {object} connObj - connectin object
- * @returns {boolean} - Returns true if Saltcorn configured to use SQLite as database
- */
-const is_sqlite = (connObj) => {
-  if (connObj.connectionString)
-    return connObj.connectionString.startsWith("sqlite");
-
-  return !!connObj.sqlite_path;
-};
-
-module.exports = {
-  getConnectObject,
-  getConfigFile,
-  configFileDir,
-  configFilePath,
-  is_sqlite,
-  defaultDataPath,
-};

package/db/db.test.js

@@ -1,33 +0,0 @@
-const db = require("./index.js");
-const Table = require("../models/table");
-
-afterAll(db.close);
-
-describe("where", () => {
-  it("should support in", async () => {
-    await Table.create("myothertable");
-    if (!db.isSQLite) {
-      const tf = await db.selectOne("_sc_tables", {
-        name: { in: ["myothertable", "nosuchtable"] },
-      });
-
-      expect(tf.name).toStrictEqual("myothertable");
-    }
-  });
-
-  it("should support ilike", async () => {
-    const tf = await db.selectOne("_sc_tables", {
-      name: { ilike: "yothertabl" },
-    });
-
-    expect(tf.name).toStrictEqual("myothertable");
-  });
-
-  it("should  count", async () => {
-    const tbls = await db.count("_sc_tables", {
-      name: { ilike: "yothertabl" },
-    });
-
-    expect(tbls).toStrictEqual(1);
-  });
-});