@saltcorn/db-common 0.6.2-beta.1 → 0.6.2-beta.5

package/internal.js

@@ -1,342 +0,0 @@
-/**
- * @category db-common
- * @module internal
- */
-const { footer } = require("@saltcorn/markup/tags");
-const { contract, is } = require("contractis");
-
-//https://stackoverflow.com/questions/15300704/regex-with-my-jquery-function-for-sql-variable-name-validation
-/**
- * Transform value to correct sql name.
- * Note! Dont use other symbols than ^A-Za-z_0-9
- * @function
- * @param {string} nm
- * @returns {string}
- */
-const sqlsanitize = contract(is.fun(is.or(is.str, is.any), is.str), (nm) => {
-  if (typeof nm === "symbol") return sqlsanitize(nm.description);
-
-  const s = nm.replace(/[^A-Za-z_0-9]*/g, "");
-  if (s[0] >= "0" && s[0] <= "9") return `_${s}`;
-  else return s;
-});
-/**
- * Transform value to correct sql name.
- * Instead of sqlsanitize also allows .
- * For e.g. table name
- * Note! Dont use other symbols than ^A-Za-z_0-9.
- * @function
- * @param {string} nm
- * @returns {string}
- */
-const sqlsanitizeAllowDots = contract(
-  is.fun(is.or(is.str, is.any), is.str),
-  (nm) => {
-    if (typeof nm === "symbol") return sqlsanitizeAllowDots(s.description);
-    const s = nm.replace(/[^A-Za-z_0-9."]*/g, "");
-    if (s[0] >= "0" && s[0] <= "9") return `_${s}`;
-    else return s;
-  }
-);
-/**
- *
- * @param {object} v
- * @param {string} i
- * @param {boolean} is_sqlite
- * @returns {string}
- */
-const whereFTS = (v, i, is_sqlite) => {
-  const { fields, table } = v;
-  var flds = fields
-    .filter((f) => f.type && f.type.sql_name === "text")
-    .map(
-      (f) =>
-        "coalesce(" +
-        (table
-          ? `"${sqlsanitize(table)}"."${sqlsanitize(f.name)}"`
-          : `"${sqlsanitize(f.name)}"`) +
-        ",'')"
-    )
-    .join(" || ' ' || ");
-  if (flds === "") flds = "''";
-  if (is_sqlite) return `${flds} LIKE '%' || ? || '%'`;
-  else
-    return `to_tsvector('english', ${flds}) @@ plainto_tsquery('english', $${i})`;
-};
-
-/**
- * @param {boolean} is_sqlite
- * @param {string} i
- * @returns {string}
- */
-const placeHolder = (is_sqlite, i) => (is_sqlite ? `?` : `$${i}`);
-
-/**
- * @returns {number}
- */
-const mkCounter = (init = 0) => {
-  let i = init;
-  return () => {
-    i += 1;
-    return i;
-  };
-};
-/**
- *
- * @param {boolean} is_sqlite
- * @param {string} i
- * @returns {function}
- */
-const subSelectWhere = (is_sqlite, i) => (k, v) => {
-  const whereObj = v.inSelect.where;
-  const wheres = whereObj ? Object.entries(whereObj) : [];
-  const where =
-    whereObj && wheres.length > 0
-      ? "where " + wheres.map(whereClause(is_sqlite, i)).join(" and ")
-      : "";
-  return `${quote(sqlsanitizeAllowDots(k))} in (select ${
-    v.inSelect.field
-  } from ${v.inSelect.table} ${where})`;
-};
-/**
- * @param {object} v
- * @returns {object[]}
- */
-const subSelectVals = (v) => {
-  const whereObj = v.inSelect.where;
-  const wheres = whereObj ? Object.entries(whereObj) : [];
-  const xs = wheres
-    .map(getVal)
-    .flat(1)
-    .filter((v) => v !== null);
-  return xs;
-};
-/**
- * @param {string} s
- * @returns {string}
- */
-const wrapParens = (s) => (s ? `(${s})` : s);
-/**
- * @param {string} s
- * @returns {string}
- */
-const quote = (s) => (s.includes(".") || s.includes('"') ? s : `"${s}"`);
-/**
- * @param {boolean} is_sqlite
- * @param {string} i
- * @returns {function}
- */
-const whereOr = (is_sqlite, i) => (ors) =>
-  wrapParens(
-    ors
-      .map((vi) =>
-        Object.entries(vi)
-          .map((kv) => whereClause(is_sqlite, i)(kv))
-          .join(" and ")
-      )
-      .join(" or ")
-  );
-const equals = ([v1, v2], is_sqlite, i) => {
-  const pVal = (v) =>
-    typeof v === "symbol"
-      ? quote(sqlsanitizeAllowDots(v.description))
-      : placeHolder(is_sqlite, i()) + (typeof v === "string" ? "::text" : "");
-  const isNull = (v) => `${pVal(v)} is null`;
-  if (v1 === null && v2 === null) return "null is null";
-  if (v1 === null) return isNull(v2);
-  if (v2 === null) return isNull(v1);
-  return `${pVal(v1)}=${pVal(v2)}`;
-};
-const equalsVals = (vs) => {
-  let vals = [];
-
-  vs.forEach((v) => {
-    if (v !== null && typeof v !== "symbol") vals.push(v);
-  });
-  //console.log({ vals });
-  return vals;
-};
-/**
- * @param {boolean} is_sqlite
- * @param {string} i
- * @returns {function}
- */
-const whereClause = (is_sqlite, i) => ([k, v]) =>
-  k === "_fts"
-    ? whereFTS(v, i(), is_sqlite)
-    : typeof (v || {}).in !== "undefined"
-    ? `${quote(sqlsanitizeAllowDots(k))} = ${
-        is_sqlite ? "" : "ANY"
-      } (${placeHolder(is_sqlite, i())})`
-    : k === "or" && Array.isArray(v)
-    ? whereOr(is_sqlite, i)(v)
-    : k === "not" && typeof v === "object"
-    ? `not (${Object.entries(v)
-        .map((kv) => whereClause(is_sqlite, i)(kv))
-        .join(" and ")})`
-    : k === "eq" && Array.isArray(v)
-    ? equals(v, is_sqlite, i)
-    : v && v.or && Array.isArray(v.or)
-    ? wrapParens(
-        v.or.map((vi) => whereClause(is_sqlite, i)([k, vi])).join(" or ")
-      )
-    : Array.isArray(v)
-    ? v.map((vi) => whereClause(is_sqlite, i)([k, vi])).join(" and ")
-    : typeof (v || {}).ilike !== "undefined"
-    ? `${quote(sqlsanitizeAllowDots(k))} ${
-        is_sqlite ? "LIKE" : "ILIKE"
-      } '%' || ${placeHolder(is_sqlite, i())} || '%'`
-    : typeof (v || {}).gt !== "undefined"
-    ? `${quote(sqlsanitizeAllowDots(k))}>${v.equal ? "=" : ""}${placeHolder(
-        is_sqlite,
-        i()
-      )}`
-    : typeof (v || {}).lt !== "undefined"
-    ? `${quote(sqlsanitizeAllowDots(k))}<${v.equal ? "=" : ""}${placeHolder(
-        is_sqlite,
-        i()
-      )}`
-    : typeof (v || {}).inSelect !== "undefined"
-    ? subSelectWhere(is_sqlite, i)(k, v)
-    : typeof (v || {}).json !== "undefined"
-    ? is_sqlite
-      ? `json_extract(${quote(
-          sqlsanitizeAllowDots(k)
-        )}, '$.${sqlsanitizeAllowDots(v.json[0])}')=${placeHolder(
-          is_sqlite,
-          i()
-        )}`
-      : `${quote(sqlsanitizeAllowDots(k))}->>'${sqlsanitizeAllowDots(
-          v.json[0]
-        )}'=${placeHolder(is_sqlite, i())}`
-    : v === null
-    ? `${quote(sqlsanitizeAllowDots(k))} is null`
-    : k === "not"
-    ? `not (${
-        typeof v === "symbol" ? v.description : placeHolder(is_sqlite, i())
-      })`
-    : `${quote(sqlsanitizeAllowDots(k))}=${
-        typeof v === "symbol" ? v.description : placeHolder(is_sqlite, i())
-      }`;
-
-/**
- * @param {object[]} opts
- * @param {object} opts.k
- * @param {object} opts.v
- * @returns {boolean|object}
- */
-const getVal = ([k, v]) =>
-  k === "_fts"
-    ? v.searchTerm
-    : typeof (v || {}).in !== "undefined"
-    ? [v.in]
-    : k === "not" && typeof v === "object"
-    ? Object.entries(v).map(getVal).flat(1)
-    : k === "eq" && Array.isArray(v)
-    ? equalsVals(v).flat(1)
-    : k === "or" && Array.isArray(v)
-    ? v
-        .map((vi) => Object.entries(vi).map(getVal))
-        .flat(1)
-        .flat(1)
-    : v && v.or && Array.isArray(v.or)
-    ? v.or.map((vi) => getVal([k, vi])).flat(1)
-    : Array.isArray(v)
-    ? v.map((vi) => getVal([k, vi])).flat(1)
-    : typeof (v || {}).ilike !== "undefined"
-    ? v.ilike
-    : typeof (v || {}).inSelect !== "undefined"
-    ? subSelectVals(v)
-    : typeof (v || {}).lt !== "undefined"
-    ? v.lt
-    : typeof (v || {}).gt !== "undefined"
-    ? v.gt
-    : typeof (v || {}).sql !== "undefined"
-    ? null
-    : typeof (v || {}).json !== "undefined"
-    ? v.json[1]
-    : typeof v === "symbol"
-    ? null
-    : v;
-
-/**
- * @param {object} whereObj
- * @param {boolean} is_sqlite
- * @param {number} initCount
- * @returns {object}
- */
-const mkWhere = (whereObj, is_sqlite, initCount = 0) => {
-  const wheres = whereObj ? Object.entries(whereObj) : [];
-  //console.log({ wheres });
-  const where =
-    whereObj && wheres.length > 0
-      ? "where " +
-        wheres.map(whereClause(is_sqlite, mkCounter(initCount))).join(" and ")
-      : "";
-  const values = wheres
-    .map(getVal)
-    .flat(1)
-    .filter((v) => v !== null);
-  return { where, values };
-};
-
-/**
- * @param {number|string} x
- * @returns {number|null}
- */
-const toInt = (x) =>
-  typeof x === "number"
-    ? Math.round(x)
-    : typeof x === "string"
-    ? parseInt(x)
-    : null;
-
-/**
- * @param {object} opts
- * @param {string} opts.latField
- * @param {string} opts.longField
- * @param {number} opts.lat
- * @param {number} opts.long
- * @returns {string}
- */
-const getDistanceOrder = ({ latField, longField, lat, long }) => {
-  const cos_lat_2 = Math.pow(Math.cos((+lat * Math.PI) / 180), 2);
-  return `((${sqlsanitizeAllowDots(
-    latField
-  )} - ${+lat})*(${sqlsanitizeAllowDots(
-    latField
-  )} - ${+lat})) + ((${sqlsanitizeAllowDots(
-    longField
-  )} - ${+long})*(${sqlsanitizeAllowDots(longField)} - ${+long})*${cos_lat_2})`;
-};
-
-/**
- * @param {object} selopts
- * @returns {string[]}
- */
-const mkSelectOptions = (selopts) => {
-  const orderby =
-    selopts.orderBy === "RANDOM()"
-      ? "order by RANDOM()"
-      : selopts.orderBy && selopts.orderBy.distance
-      ? `order by ${getDistanceOrder(selopts.orderBy.distance)}`
-      : selopts.orderBy && selopts.nocase
-      ? `order by lower(${sqlsanitizeAllowDots(selopts.orderBy)})${
-          selopts.orderDesc ? " DESC" : ""
-        }`
-      : selopts.orderBy
-      ? `order by ${sqlsanitizeAllowDots(selopts.orderBy)}${
-          selopts.orderDesc ? " DESC" : ""
-        }`
-      : "";
-  const limit = selopts.limit ? `limit ${toInt(selopts.limit)}` : "";
-  const offset = selopts.offset ? `offset ${toInt(selopts.offset)}` : "";
-  return [orderby, limit, offset].filter((s) => s).join(" ");
-};
-
-module.exports = {
-  sqlsanitize,
-  mkWhere,
-  mkSelectOptions,
-  sqlsanitizeAllowDots,
-};

package/internal.test.js

@@ -1,198 +0,0 @@
-const { sqlsanitize, mkWhere, sqlsanitizeAllowDots } = require("./internal");
-
-describe("sqlsanitize", () => {
-  it("should not alter valid name", () => {
-    expect(sqlsanitize("ffoo_oo")).toBe("ffoo_oo");
-  });
-  it("should not alter valid symbol", () => {
-    expect(sqlsanitize(Symbol("ffoo_oo"))).toBe("ffoo_oo");
-  });
-  it("should remove spaces", () => {
-    expect(sqlsanitize(" ")).toBe("");
-  });
-  it("should remove chars from invalid name", () => {
-    expect(sqlsanitize("ffoo--oo--uu")).toBe("ffoooouu");
-  });
-  it("should remove chars from invalid symbol", () => {
-    expect(sqlsanitize(Symbol("ffoo--oo--uu"))).toBe("ffoooouu");
-  });
-  it("should not allow dots", () => {
-    expect(sqlsanitize("ffoo.oo")).toBe("ffoooo");
-  });
-  it("should allow dots when specified", () => {
-    expect(sqlsanitizeAllowDots("ffoo.oo")).toBe("ffoo.oo");
-  });
-  it("should allow quotes when dots specified", () => {
-    expect(sqlsanitizeAllowDots('ffoo."oo"')).toBe('ffoo."oo"');
-  });
-  it("should allow numbers", () => {
-    expect(sqlsanitize("ff1oo_oo")).toBe("ff1oo_oo");
-  });
-  it("should not allow numbers in initial position", () => {
-    expect(sqlsanitize("1ffoo_o1o")).toBe("_1ffoo_o1o");
-  });
-});
-
-describe("mkWhere", () => {
-  it("should empty on no arg", () => {
-    expect(mkWhere()).toStrictEqual({ values: [], where: "" });
-  });
-  it("should empty on null obj arg", () => {
-    expect(mkWhere({})).toStrictEqual({ values: [], where: "" });
-  });
-  it("should query json", () => {
-    expect(mkWhere({ foo: { json: ["bar", 5] } })).toStrictEqual({
-      values: [5],
-      where: `where "foo"->>'bar'=$1`,
-    });
-  });
-
-  it("should set id", () => {
-    expect(mkWhere({ id: 5 })).toStrictEqual({
-      values: [5],
-      where: 'where "id"=$1',
-    });
-    expect(mkWhere({ id: 5, hello: "world" })).toStrictEqual({
-      values: [5, "world"],
-      where: 'where "id"=$1 and "hello"=$2',
-    });
-  });
-  it("should read eq", () => {
-    expect(mkWhere({ eq: [Symbol("id"), 5] })).toStrictEqual({
-      values: [5],
-      where: 'where "id"=$1',
-    });
-    expect(mkWhere({ eq: [Symbol("id"), null] })).toStrictEqual({
-      values: [],
-      where: 'where "id" is null',
-    });
-    expect(mkWhere({ eq: ["id", null] })).toStrictEqual({
-      values: ["id"],
-      where: "where $1::text is null",
-    });
-    expect(mkWhere({ eq: [4, 5] })).toStrictEqual({
-      values: [4, 5],
-      where: "where $1=$2",
-    });
-    expect(mkWhere({ eq: [null, 5] })).toStrictEqual({
-      values: [5],
-      where: "where $1 is null",
-    });
-    expect(mkWhere({ not: { eq: [Symbol("id"), 5] } })).toStrictEqual({
-      values: [5],
-      where: 'where not ("id"=$1)',
-    });
-  });
-  it("should query null", () => {
-    expect(mkWhere({ id: null })).toStrictEqual({
-      values: [],
-      where: 'where "id" is null',
-    });
-    expect(mkWhere({ id: null, foo: 1 })).toStrictEqual({
-      values: [1],
-      where: 'where "id" is null and "foo"=$1',
-    });
-    expect(mkWhere({ foo: 1, id: null })).toStrictEqual({
-      values: [1],
-      where: 'where "foo"=$1 and "id" is null',
-    });
-  });
-  it("should query lt/gt", () => {
-    expect(mkWhere({ id: { lt: 5 } })).toStrictEqual({
-      values: [5],
-      where: 'where "id"<$1',
-    });
-    expect(mkWhere({ id: { gt: 8 } })).toStrictEqual({
-      values: [8],
-      where: 'where "id">$1',
-    });
-    expect(mkWhere({ id: { lt: 5, equal: true } })).toStrictEqual({
-      values: [5],
-      where: 'where "id"<=$1',
-    });
-    expect(mkWhere({ id: { gt: 8, equal: true } })).toStrictEqual({
-      values: [8],
-      where: 'where "id">=$1',
-    });
-    expect(mkWhere({ id: [{ gt: 0 }, { lt: 10 }] })).toStrictEqual({
-      values: [0, 10],
-      where: 'where "id">$1 and "id"<$2',
-    });
-    expect(mkWhere({ id: { or: [{ gt: 10 }, { lt: 5 }] } })).toStrictEqual({
-      values: [10, 5],
-      where: 'where ("id">$1 or "id"<$2)',
-    });
-  });
-  it("should query subselect", () => {
-    expect(
-      mkWhere({
-        id: [{ inSelect: { table: "foo", field: "bar", where: { baz: 7 } } }],
-      })
-    ).toStrictEqual({
-      values: [7],
-      where: 'where "id" in (select bar from foo where "baz"=$1)',
-    });
-    expect(
-      mkWhere({
-        age: 45,
-        id: [{ inSelect: { table: "foo", field: "bar", where: { baz: 7 } } }],
-        name: "Alice",
-      })
-    ).toStrictEqual({
-      values: [45, 7, "Alice"],
-      where: `where "age"=$1 and "id" in (select bar from foo where "baz"=$2) and "name"=$3`,
-    });
-  });
-  it("should query or", () => {
-    expect(mkWhere({ or: [{ id: 5 }, { x: 7 }] })).toStrictEqual({
-      values: [5, 7],
-      where: 'where ("id"=$1 or "x"=$2)',
-    });
-    expect(mkWhere({ or: [{ id: 5 }, { x: { gt: 7 } }] })).toStrictEqual({
-      values: [5, 7],
-      where: 'where ("id"=$1 or "x">$2)',
-    });
-    expect(mkWhere({ or: [{ id: 5 }, { x: 7, y: 8 }] })).toStrictEqual({
-      values: [5, 7, 8],
-      where: 'where ("id"=$1 or "x"=$2 and "y"=$3)',
-    });
-    expect(mkWhere({ not: { id: 5 } })).toStrictEqual({
-      values: [5],
-      where: 'where not ("id"=$1)',
-    });
-    expect(mkWhere({ not: { id: 5, y: 1 } })).toStrictEqual({
-      values: [5, 1],
-      where: 'where not ("id"=$1 and "y"=$2)',
-    });
-    expect(mkWhere({ not: { y: { in: [1, 2, 3] } } })).toStrictEqual({
-      values: [[1, 2, 3]],
-      where: 'where not ("y" = ANY ($1))',
-    });
-    expect(mkWhere({ y: { in: [1, 2, 3] } })).toStrictEqual({
-      values: [[1, 2, 3]],
-      where: 'where "y" = ANY ($1)',
-    });
-    expect(
-      mkWhere({
-        or: [
-          { not: { eq: ["1", null] } },
-          { not: { eq: [null, null] }, married_to: null },
-        ],
-      })
-    ).toStrictEqual({
-      values: ["1"],
-      where:
-        'where (not ($1::text is null) or not (null is null) and "married_to" is null)',
-    });
-    /*
-
-    expect(mkWhere([{ id: 5 }, { x: 7 }])).toStrictEqual({
-      values: [5, 7],
-      where: 'where "id"=$1 and "x"=$2',
-    });
-    expect(mkWhere([{ or: [{ id: 5 }, { x: 7 }] }, { z: 9 }])).toStrictEqual({
-      values: [5, 7, 9],
-      where: 'where ("id"=$1 or "x"=$2) and "z"=$3',
-    });*/
-  });
-});

package/multi-tenant.js

@@ -1,48 +0,0 @@
-/**
- * @category db-common
- * @module multi-tenant
- */
-const { AsyncLocalStorage } = require("async_hooks");
-const { sqlsanitize } = require("./internal");
-
-var is_multi_tenant = true;
-
-/**
- * @returns {boolean}
- */
-const is_it_multi_tenant = () => is_multi_tenant;
-
-const tenantNamespace = new AsyncLocalStorage();
-
-/**  
- * @returns {object}
-*/
-const enable_multi_tenant = () => {};
-
-/**
- * @param {object} tenant 
- * @param {function} f 
- * @returns {object}
- */
-const runWithTenant = (tenant, f) => {
-  if (!is_multi_tenant) return f();
-  else return tenantNamespace.run(sqlsanitize(tenant).toLowerCase(), f);
-};
-
-module.exports = /**
- * @function
- * @name "module.exports function"
- * @returns {exports}
- */
-(connObj) => ({
-  /**
-   * @returns {object}
-   */
-  getTenantSchema() {
-    const storeVal = tenantNamespace.getStore();
-    return storeVal || connObj.default_schema;
-  },
-  enable_multi_tenant,
-  runWithTenant,
-  is_it_multi_tenant,
-});

package/single-tenant.js

@@ -1,30 +0,0 @@
-/**
- * @category db-common
- * @module single-tenant
- */
-
-module.exports = /**
- * @function
- * @name "module.exports function"
- * @returns {exports}
- */
-(connObj) => ({
-  /**
-   * @returns {string}
-   */
-  getTenantSchema: () => connObj.default_schema,
-  /** 
-   * @returns {false}
-   */
-  is_it_multi_tenant: () => false,
-  enable_multi_tenant() {},
-  /**
-   * @param {*} t 
-   * @param {function} f 
-   * @returns {*}
-   */
-  runWithTenant(t, f) {
-    return f();
-  },
-});
-

package/tenants.js

@@ -1,21 +0,0 @@
-/**
- * @category db-common
- * @module tenants
- */
-
-let tenantExport = null;
-
-
-module.exports = /**
- * @function
- * @name "module.exports function"
- * @returns {multi-tenant|single-tenant}
- */
-(connObj) => {
-  if(!tenantExport) {
-    tenantExport = connObj.multi_tenant ? 
-        require("./multi-tenant")(connObj)
-      : require("./single-tenant")(connObj);
-  }
-  return tenantExport;
-}