json-fs-query 2.3.1 → 3.1.0

package/dist/data/introspect/create.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.create = void 0;
+require("core-js/modules/es.array.includes.js");
 require("core-js/modules/es.json.stringify.js");
 require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.find.js");
@@ -12,11 +13,28 @@ var _record = require("./definitions/record");
 var _registerRecord = require("../utilities/registerRecord");
 var _config = require("../utilities/config");
 var _typeCheck = require("./policies/typeCheck");
+const knownKeyProperties = ['type', 'fields', 'lookup', 'references'];
+/**
+ * Reject a key with a property key() would ignore (a typo such as `keys` for `fields`), which has to be
+ * checked on the keys as given, before key() drops it.
+ * @param recordName
+ * @param keys
+ */
+const assertKnownKeyProperties = (recordName, keys) => {
+  for (const key of keys) {
+    for (const property of Object.keys(key)) {
+      if (!knownKeyProperties.includes(property)) {
+        throw new Error(`Unknown property "${property}" on ${key.type ?? 'index'} key of ${recordName}; must be ${knownKeyProperties.join(', ')}`);
+      }
+    }
+  }
+};
 /**
  * Reject a definition that could never be written correctly, before anything is created: a
  * default that fails its field's type check (otherwise every insert leaving that field out would
  * fail instead), including a null default on a field that isn't nullable, and a nullable field in
- * the primary key (an entry's file name comes from its primary key value).
+ * the primary key (an entry's file name comes from its primary key value). Also a key with no fields,
+ * or with a field that isn't in the definition.
  * @param recordName
  * @param recordContent
  */
@@ -31,6 +49,16 @@ const assertValidDefinition = (recordName, recordContent) => {
       throw new Error(`Invalid default for field "${field.name}" of ${recordName}: ${err.message}`);
     }
   }
+  for (const key of recordContent.keys) {
+    if (key.fields.length < 1) {
+      throw new Error(`The ${key.type} key of ${recordName} must have at least one field`);
+    }
+    for (const fieldName of key.fields) {
+      if (!recordContent.definition.some(field => field.name === fieldName)) {
+        throw new Error(`The ${key.type} key of ${recordName} names field "${fieldName}", which isn't in the definition`);
+      }
+    }
+  }
   const primaryKey = recordContent.keys.find(key => key.type === 'primary');
   for (const fieldName of primaryKey ? primaryKey.fields : []) {
     if (recordContent.definition.some(field => field.name === fieldName && field.nullable)) {
@@ -59,6 +87,7 @@ const create = async (recordName, definition = [], keys = []) => {
   if (existsSync(`${databasePath}${recordName}.json`)) {
     return null;
   }
+  assertKnownKeyProperties(recordName, keys);
   const recordContent = (0, _record.record)({
     path: recordName,
     definition,

package/dist/data/introspect/create.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.create=void 0,require("core-js/modules/es.json.stringify.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.some.js");var _record=require("./definitions/record"),_registerRecord=require("../utilities/registerRecord"),_config=require("../utilities/config"),_typeCheck=require("./policies/typeCheck");const assertValidDefinition=(e,r)=>{for(const t of r.definition)if(Object.prototype.hasOwnProperty.call(t,"default"))try{(0,_typeCheck.typeCheck)(t.type,t.default,t.nullable)}catch(r){throw new Error(`Invalid default for field "${t.name}" of ${e}: ${r.message}`)}const t=r.keys.find((e=>"primary"===e.type));for(const i of t?t.fields:[])if(r.definition.some((e=>e.name===i&&e.nullable)))throw new Error(`Primary key field "${i}" of ${e} can't be nullable`)},create=async(e,r=[],t=[])=>{const{writeFile:i,mkdir:s}=require("fs/promises"),{existsSync:o}=require("fs"),n=(0,_config.getSetting)("databasePath","database/");if("__RECORDS"===e)return null;if(o(`${n}${e}.json`))return null;const a=(0,_record.record)({path:e,definition:r,keys:t});return assertValidDefinition(e,a),await s(n,{recursive:!0}),await i(`${n}${e}.json`,JSON.stringify(a,null,2)),await s(`${n}${e}`,{recursive:!0}),await(0,_registerRecord.registerRecord)(e),a};exports.create=create;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.create=void 0,require("core-js/modules/es.array.includes.js"),require("core-js/modules/es.json.stringify.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.some.js");var _record=require("./definitions/record"),_registerRecord=require("../utilities/registerRecord"),_config=require("../utilities/config"),_typeCheck=require("./policies/typeCheck");const knownKeyProperties=["type","fields","lookup","references"],assertKnownKeyProperties=(e,r)=>{for(const t of r)for(const r of Object.keys(t))if(!knownKeyProperties.includes(r))throw new Error(`Unknown property "${r}" on ${t.type??"index"} key of ${e}; must be ${knownKeyProperties.join(", ")}`)},assertValidDefinition=(e,r)=>{for(const t of r.definition)if(Object.prototype.hasOwnProperty.call(t,"default"))try{(0,_typeCheck.typeCheck)(t.type,t.default,t.nullable)}catch(r){throw new Error(`Invalid default for field "${t.name}" of ${e}: ${r.message}`)}for(const t of r.keys){if(t.fields.length<1)throw new Error(`The ${t.type} key of ${e} must have at least one field`);for(const i of t.fields)if(!r.definition.some((e=>e.name===i)))throw new Error(`The ${t.type} key of ${e} names field "${i}", which isn't in the definition`)}const t=r.keys.find((e=>"primary"===e.type));for(const i of t?t.fields:[])if(r.definition.some((e=>e.name===i&&e.nullable)))throw new Error(`Primary key field "${i}" of ${e} can't be nullable`)},create=async(e,r=[],t=[])=>{const{writeFile:i,mkdir:o}=require("fs/promises"),{existsSync:s}=require("fs"),n=(0,_config.getSetting)("databasePath","database/");if("__RECORDS"===e)return null;if(s(`${n}${e}.json`))return null;assertKnownKeyProperties(e,t);const a=(0,_record.record)({path:e,definition:r,keys:t});return assertValidDefinition(e,a),await o(n,{recursive:!0}),await i(`${n}${e}.json`,JSON.stringify(a,null,2)),await o(`${n}${e}`,{recursive:!0}),await(0,_registerRecord.registerRecord)(e),a};exports.create=create;

package/dist/data/queries/groupBy.d.ts

@@ -1,2 +1,21 @@
-export declare const groupBy: (dataSet?: any[], groupProperty?: string) => any;
+/**
+ * One group of a grouped read: the field and the value its rows share, then either the rows themselves or, for
+ * `group by a, b`, the groups within it by the next field. A group of rows missing the field has `missing: true`
+ * and no value; `null` is a value of its own (see Null and missing fields in the README).
+ */
+export type Group = {
+    field: string;
+    value?: any;
+    missing?: true;
+    rows?: Object[];
+    groups?: Group[];
+};
+/**
+ * Group rows by each field in turn. The groups are a list in the order their first row came, so a sort before
+ * grouping orders the groups too (and the rows within each one).
+ * @param dataSet
+ * @param fields
+ * @returns The rows as they were when there's no field, otherwise the groups.
+ */
+export declare const groupBy: (dataSet?: Object[], fields?: string[]) => Object[] | Group[];
 //# sourceMappingURL=groupBy.d.ts.map

package/dist/data/queries/groupBy.js

@@ -4,19 +4,81 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.groupBy = void 0;
+require("core-js/modules/es.json.stringify.js");
 require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.map.js");
 require("core-js/modules/esnext.iterator.reduce.js");
-const groupBy = (dataSet = [], groupProperty = '') => {
-  if (!groupProperty) {
+require("core-js/modules/esnext.map.delete-all.js");
+require("core-js/modules/esnext.map.every.js");
+require("core-js/modules/esnext.map.filter.js");
+require("core-js/modules/esnext.map.find.js");
+require("core-js/modules/esnext.map.find-key.js");
+require("core-js/modules/esnext.map.includes.js");
+require("core-js/modules/esnext.map.key-of.js");
+require("core-js/modules/esnext.map.map-keys.js");
+require("core-js/modules/esnext.map.map-values.js");
+require("core-js/modules/esnext.map.merge.js");
+require("core-js/modules/esnext.map.reduce.js");
+require("core-js/modules/esnext.map.some.js");
+require("core-js/modules/esnext.map.update.js");
+// An object's keys in sorted order, at any depth, so { a, b } and { b, a } are the same value; arrays keep their order
+const sortedKeys = value => {
+  if (Array.isArray(value)) {
+    return value.map(sortedKeys);
+  }
+  if (value !== null && typeof value === 'object') {
+    return Object.keys(value).sort().reduce((sorted, key) => {
+      sorted[key] = sortedKeys(value[key]);
+      return sorted;
+    }, {});
+  }
+  return value;
+};
+// Rows share a group when their values are the same, type included: 1 and '1' are two groups, as are null and missing
+const groupKey = (row, field) => {
+  if (!Object.prototype.hasOwnProperty.call(row, field)) {
+    return 'missing';
+  }
+  const value = row[field];
+  return value !== null && typeof value === 'object' ? `json:${JSON.stringify(sortedKeys(value))}` : `${typeof value}:${String(value)}`;
+};
+/**
+ * Group rows by each field in turn. The groups are a list in the order their first row came, so a sort before
+ * grouping orders the groups too (and the rows within each one).
+ * @param dataSet
+ * @param fields
+ * @returns The rows as they were when there's no field, otherwise the groups.
+ */
+const groupBy = (dataSet = [], fields = []) => {
+  if (!fields.length) {
     return dataSet;
   }
-  return dataSet.reduce((groupedData, data) => {
-    const property = data[groupProperty];
-    if (!Object.prototype.hasOwnProperty.call(groupedData, property)) {
-      groupedData[property] = [];
+  const [field, ...rest] = fields;
+  const groups = new Map();
+  for (const row of dataSet) {
+    const key = groupKey(row, field);
+    if (!groups.has(key)) {
+      groups.set(key, key === 'missing' ? {
+        field,
+        missing: true,
+        rows: []
+      } : {
+        field,
+        value: row[field],
+        rows: []
+      });
     }
-    groupedData[property].push(data);
-    return groupedData;
-  }, {});
+    groups.get(key).rows.push(row);
+  }
+  return [...groups.values()].map(({
+    rows,
+    ...group
+  }) => rest.length ? {
+    ...group,
+    groups: groupBy(rows, rest)
+  } : {
+    ...group,
+    rows
+  });
 };
 exports.groupBy = groupBy;

package/dist/data/queries/groupBy.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.groupBy=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.reduce.js");const groupBy=(e=[],r="")=>r?e.reduce(((e,o)=>{const t=o[r];return Object.prototype.hasOwnProperty.call(e,t)||(e[t]=[]),e[t].push(o),e}),{}):e;exports.groupBy=groupBy;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.groupBy=void 0,require("core-js/modules/es.json.stringify.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.reduce.js"),require("core-js/modules/esnext.map.delete-all.js"),require("core-js/modules/esnext.map.every.js"),require("core-js/modules/esnext.map.filter.js"),require("core-js/modules/esnext.map.find.js"),require("core-js/modules/esnext.map.find-key.js"),require("core-js/modules/esnext.map.includes.js"),require("core-js/modules/esnext.map.key-of.js"),require("core-js/modules/esnext.map.map-keys.js"),require("core-js/modules/esnext.map.map-values.js"),require("core-js/modules/esnext.map.merge.js"),require("core-js/modules/esnext.map.reduce.js"),require("core-js/modules/esnext.map.some.js"),require("core-js/modules/esnext.map.update.js");const sortedKeys=e=>Array.isArray(e)?e.map(sortedKeys):null!==e&&"object"==typeof e?Object.keys(e).sort().reduce(((s,r)=>(s[r]=sortedKeys(e[r]),s)),{}):e,groupKey=(e,s)=>{if(!Object.prototype.hasOwnProperty.call(e,s))return"missing";const r=e[s];return null!==r&&"object"==typeof r?`json:${JSON.stringify(sortedKeys(r))}`:`${typeof r}:${String(r)}`},groupBy=(e=[],s=[])=>{if(!s.length)return e;const[r,...o]=s,t=new Map;for(const s of e){const e=groupKey(s,r);t.has(e)||t.set(e,"missing"===e?{field:r,missing:!0,rows:[]}:{field:r,value:s[r],rows:[]}),t.get(e).rows.push(s)}return[...t.values()].map((({rows:e,...s})=>o.length?{...s,groups:groupBy(e,o)}:{...s,rows:e}))};exports.groupBy=groupBy;

package/dist/data/queries/limitOffset.d.ts

@@ -1,5 +1,5 @@
 /**
- * Slice a dataSet down to at most `limit` rows, starting after the first `offset` of them.
+ * Slice a dataSet down to at most `limit` rows (or groups, after group by), starting after the first `offset` of them.
  * @param dataSet
  * @param offset
  * @param limit

package/dist/data/queries/limitOffset.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.limitOffset = void 0;
 /**
- * Slice a dataSet down to at most `limit` rows, starting after the first `offset` of them.
+ * Slice a dataSet down to at most `limit` rows (or groups, after group by), starting after the first `offset` of them.
  * @param dataSet
  * @param offset
  * @param limit

package/dist/data/queries/selectFields.d.ts

@@ -1,10 +1,12 @@
 import { ParsedSelect } from '../utilities/parsers/findSelects';
+import { Group } from './groupBy';
 /**
- * Shape each row down to only the selected properties (aliased, when given). dataSet is either a plain array of
- * rows, or (once groupBy has run) a plain object keyed by group value, each value an array of rows - both are
- * shaped the same way, row by row.
+ * Shape each row down to only the selected properties (aliased, when given). dataSet is either a list of rows, or
+ * (once groupBy has run) a list of groups, whose rows are shaped the same way at any depth; the groups keep their
+ * field and value, selected or not.
  * @param dataSet
  * @param selectClauses
+ * @param grouped Whether dataSet is a list of groups (see groupBy)
  */
-export declare const selectFields: (dataSet?: Object[] | Object, selectClauses?: ParsedSelect[]) => Object[] | Object;
+export declare const selectFields: (dataSet?: Object[] | Group[], selectClauses?: ParsedSelect[], grouped?: boolean) => Object[] | Group[];
 //# sourceMappingURL=selectFields.d.ts.map

package/dist/data/queries/selectFields.js

@@ -14,23 +14,28 @@ const shapeRow = (row, selectClauses) => selectClauses.reduce((shaped, {
   shaped[alias || property] = row[property];
   return shaped;
 }, {});
+const shapeGroup = (group, selectClauses) => group.groups ? {
+  ...group,
+  groups: group.groups.map(inner => shapeGroup(inner, selectClauses))
+} : {
+  ...group,
+  rows: group.rows.map(row => shapeRow(row, selectClauses))
+};
 /**
- * Shape each row down to only the selected properties (aliased, when given). dataSet is either a plain array of
- * rows, or (once groupBy has run) a plain object keyed by group value, each value an array of rows - both are
- * shaped the same way, row by row.
+ * Shape each row down to only the selected properties (aliased, when given). dataSet is either a list of rows, or
+ * (once groupBy has run) a list of groups, whose rows are shaped the same way at any depth; the groups keep their
+ * field and value, selected or not.
  * @param dataSet
  * @param selectClauses
+ * @param grouped Whether dataSet is a list of groups (see groupBy)
  */
-const selectFields = (dataSet = [], selectClauses = []) => {
+const selectFields = (dataSet = [], selectClauses = [], grouped = false) => {
   if (!selectClauses.length) {
     return dataSet;
   }
-  if (Array.isArray(dataSet)) {
-    return dataSet.map(row => shapeRow(row, selectClauses));
+  if (grouped) {
+    return dataSet.map(group => shapeGroup(group, selectClauses));
   }
-  return Object.keys(dataSet).reduce((shaped, key) => {
-    shaped[key] = dataSet[key].map(row => shapeRow(row, selectClauses));
-    return shaped;
-  }, {});
+  return dataSet.map(row => shapeRow(row, selectClauses));
 };
 exports.selectFields = selectFields;

package/dist/data/queries/selectFields.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.selectFields=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.reduce.js");const shapeRow=(e,s)=>s.reduce(((s,{property:r,alias:t})=>(s[t||r]=e[r],s)),{}),selectFields=(e=[],s=[])=>s.length?Array.isArray(e)?e.map((e=>shapeRow(e,s))):Object.keys(e).reduce(((r,t)=>(r[t]=e[t].map((e=>shapeRow(e,s))),r)),{}):e;exports.selectFields=selectFields;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.selectFields=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.reduce.js");const shapeRow=(e,s)=>s.reduce(((s,{property:r,alias:o})=>(s[o||r]=e[r],s)),{}),shapeGroup=(e,s)=>e.groups?{...e,groups:e.groups.map((e=>shapeGroup(e,s)))}:{...e,rows:e.rows.map((e=>shapeRow(e,s)))},selectFields=(e=[],s=[],r=!1)=>s.length?r?e.map((e=>shapeGroup(e,s))):e.map((e=>shapeRow(e,s))):e;exports.selectFields=selectFields;

package/dist/data/utilities/databaseLock.js

@@ -20,7 +20,8 @@ require("core-js/modules/esnext.map.some.js");
 require("core-js/modules/esnext.map.update.js");
 var jsEnv = _interopRequireWildcard(require("browser-or-node"));
 var _config = require("./config");
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+var e;
+function _interopRequireWildcard(t, r) { if (!r && t && t.__esModule) return t; var n, a, o = Object.defineProperty, f = { __proto__: null, default: t }; if (Object(t) !== t) return f; if (e || "function" != typeof WeakMap || (e = new WeakMap()), e) { if (e.has(t)) return e.get(t); e.set(t, f); } for (a in t) "default" !== a && {}.hasOwnProperty.call(t, a) && ((n = o && Object.getOwnPropertyDescriptor(t, a)) && (n.get || n.set) ? o(f, a, n) : f[a] = t[a]); return f; }
 const queues = new Map();
 /**
  * Run `task` once every earlier task on the same database (the configured databasePath) has finished, so that calls

package/dist/data/utilities/databaseLock.min.js

@@ -1 +1 @@
-"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.withDatabaseLock=void 0,require("core-js/modules/esnext.map.delete-all.js"),require("core-js/modules/esnext.map.every.js"),require("core-js/modules/esnext.map.filter.js"),require("core-js/modules/esnext.map.find.js"),require("core-js/modules/esnext.map.find-key.js"),require("core-js/modules/esnext.map.includes.js"),require("core-js/modules/esnext.map.key-of.js"),require("core-js/modules/esnext.map.map-keys.js"),require("core-js/modules/esnext.map.map-values.js"),require("core-js/modules/esnext.map.merge.js"),require("core-js/modules/esnext.map.reduce.js"),require("core-js/modules/esnext.map.some.js"),require("core-js/modules/esnext.map.update.js");var jsEnv=_interopRequireWildcard(require("browser-or-node")),_config=require("./config");function _interopRequireWildcard(e,r){if("function"==typeof WeakMap)var s=new WeakMap,t=new WeakMap;return(_interopRequireWildcard=function(e,r){if(!r&&e&&e.__esModule)return e;var o,a,u={__proto__:null,default:e};if(null===e||"object"!=typeof e&&"function"!=typeof e)return u;if(o=r?t:s){if(o.has(e))return o.get(e);o.set(e,u)}for(const r in e)"default"!==r&&{}.hasOwnProperty.call(e,r)&&((a=(o=Object.defineProperty)&&Object.getOwnPropertyDescriptor(e,r))&&(a.get||a.set)?o(u,r,a):u[r]=e[r]);return u})(e,r)}const queues=new Map,withDatabaseLock=async e=>{if(!jsEnv.isNode)return e();const r=(0,_config.resolveDatabasePath)((0,_config.getSetting)("databasePath","database/")),s=(0,_config.trackDatabaseCall)(),t=queues.get(r)||Promise.resolve();let o;const a=new Promise((e=>{o=e})),u=t.then((()=>a));queues.set(r,u),await t;try{return await e()}finally{s(),o(),queues.get(r)===u&&queues.delete(r)}};exports.withDatabaseLock=withDatabaseLock;
+"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.withDatabaseLock=void 0,require("core-js/modules/esnext.map.delete-all.js"),require("core-js/modules/esnext.map.every.js"),require("core-js/modules/esnext.map.filter.js"),require("core-js/modules/esnext.map.find.js"),require("core-js/modules/esnext.map.find-key.js"),require("core-js/modules/esnext.map.includes.js"),require("core-js/modules/esnext.map.key-of.js"),require("core-js/modules/esnext.map.map-keys.js"),require("core-js/modules/esnext.map.map-values.js"),require("core-js/modules/esnext.map.merge.js"),require("core-js/modules/esnext.map.reduce.js"),require("core-js/modules/esnext.map.some.js"),require("core-js/modules/esnext.map.update.js");var e,jsEnv=_interopRequireWildcard(require("browser-or-node")),_config=require("./config");function _interopRequireWildcard(s,r){if(!r&&s&&s.__esModule)return s;var t,a,o=Object.defineProperty,u={__proto__:null,default:s};if(Object(s)!==s)return u;if(e||"function"!=typeof WeakMap||(e=new WeakMap),e){if(e.has(s))return e.get(s);e.set(s,u)}for(a in s)"default"!==a&&{}.hasOwnProperty.call(s,a)&&((t=o&&Object.getOwnPropertyDescriptor(s,a))&&(t.get||t.set)?o(u,a,t):u[a]=s[a]);return u}const queues=new Map,withDatabaseLock=async e=>{if(!jsEnv.isNode)return e();const s=(0,_config.resolveDatabasePath)((0,_config.getSetting)("databasePath","database/")),r=(0,_config.trackDatabaseCall)(),t=queues.get(s)||Promise.resolve();let a;const o=new Promise((e=>{a=e})),u=t.then((()=>o));queues.set(s,u),await t;try{return await e()}finally{r(),a(),queues.get(s)===u&&queues.delete(s)}};exports.withDatabaseLock=withDatabaseLock;

package/dist/data/utilities/parsers/findCommand.d.ts

@@ -2,9 +2,10 @@ import { ParsedQuery } from './parseQuery';
 export type ParsedCommand = string | 'delete' | 'insert' | 'read' | 'update';
 export type ParsedEntity = string;
 /**
- * Extract command clauses from the query.
+ * Read the command and record name from the start of a query's head (see splitClauses).
  * @param parsed
  * @param query
+ * @returns The rest of the head (a joined record, `.joined`, for findJoinEntity).
  */
 export declare const findCommand: (parsed: ParsedQuery, query: string) => string;
 //# sourceMappingURL=findCommand.d.ts.map

package/dist/data/utilities/parsers/findCommand.js

@@ -4,12 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.findCommand = void 0;
-var _removeFromQuery = require("./removeFromQuery");
-const commandMatch = /^(delete|insert|read|update)\s+([a-z0-9_-]+)[\w\n]*/i;
+const commandMatch = /^(delete|insert|read|update)\s+([a-z0-9_-]+)/i;
 /**
- * Extract command clauses from the query.
+ * Read the command and record name from the start of a query's head (see splitClauses).
  * @param parsed
  * @param query
+ * @returns The rest of the head (a joined record, `.joined`, for findJoinEntity).
  */
 const findCommand = (parsed, query) => {
   const commandFound = query.match(commandMatch);
@@ -18,7 +18,7 @@ const findCommand = (parsed, query) => {
   if (commandFound) {
     parsed['command'] = commandFound[1].toLowerCase();
     parsed['entity'] = commandFound[2];
-    return (0, _removeFromQuery.removeFromQuery)(commandFound[0], query);
+    return query.slice(commandFound[0].length).trim();
   }
   return query;
 };

package/dist/data/utilities/parsers/findCommand.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findCommand=void 0;var _removeFromQuery=require("./removeFromQuery");const commandMatch=/^(delete|insert|read|update)\s+([a-z0-9_-]+)[\w\n]*/i,findCommand=(e,o)=>{const r=o.match(commandMatch);return e.command=void 0,e.entity=void 0,r?(e.command=r[1].toLowerCase(),e.entity=r[2],(0,_removeFromQuery.removeFromQuery)(r[0],o)):o};exports.findCommand=findCommand;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findCommand=void 0;const commandMatch=/^(delete|insert|read|update)\s+([a-z0-9_-]+)/i,findCommand=(e,t)=>{const d=t.match(commandMatch);return e.command=void 0,e.entity=void 0,d?(e.command=d[1].toLowerCase(),e.entity=d[2],t.slice(d[0].length).trim()):t};exports.findCommand=findCommand;

package/dist/data/utilities/parsers/findConditions.d.ts

@@ -8,15 +8,14 @@ export type ParsedCondition = {
     type?: string;
 };
 /**
- * Extract the where clause from the query into a tree (see ConditionNode): `where` followed by conditions joined with
- * `and` / `or`, `not`, and brackets, nested to any depth. Each condition is `<field> <comparator> <value>`, or
- * `<field> is null`, `is not null`, `exists` or `does not exist`. A comparison with the literal null (`= null`) is
- * refused: it would never match, as null equals nothing (see where). The expression ends at the next clause keyword
- * outside brackets, so clauses may come in any order; several separate `where`s (or `and where` after another clause)
- * are joined with `and`, as before.
+ * Read a where clause body (see splitClauses) into a tree (see ConditionNode): conditions joined with `and` / `or`,
+ * `not`, and brackets, nested to any depth. Each condition is `<field> <comparator> <value>`, or `<field> is null`,
+ * `is not null`, `exists` or `does not exist`. A comparison with the literal null (`= null`) is refused: it would never
+ * match, as null equals nothing (see where).
  * @param parsed
- * @param query
- * @throws {Error} For the errors readExpression and readCondition describe, and `or where` after another clause.
+ * @param body
+ * @returns The rest of the body, after the expression.
+ * @throws {Error} For the errors readExpression and readCondition describe.
  */
-export declare const findConditions: (parsed: ParsedQuery, query: string) => string;
+export declare const findConditions: (parsed: ParsedQuery, body: string) => string;
 //# sourceMappingURL=findConditions.d.ts.map

package/dist/data/utilities/parsers/findConditions.js

@@ -10,15 +10,13 @@ require("core-js/modules/esnext.iterator.flat-map.js");
 var _parseLiteralValue = require("./parseLiteralValue");
 var _conditionTree = require("../conditionTree");
 var _maskStrings = require("./maskStrings");
+var _splitClauses = require("./splitClauses");
 // Keywords count only as whole words: in `on t.x = u.color where ...` the `or` is part of the name `color`
 const wordEnd = '(?![a-z0-9_.-])';
 const keyword = words => new RegExp(`^(?:${words})${wordEnd}`, 'i');
 // One condition, at the start of the text: a field, then `is [not] null` / `exists` / `does not exist`, or a comparator
 // and a value (strings and arrays are placeholders by then, see maskStrings)
 const conditionMatch = new RegExp(`^([a-z0-9_-]+\\.?[a-z0-9_-]*)\\s+(?:(is\\s+not\\s+null|is\\s+null|exists|does\\s+not\\s+exist)${wordEnd}|(<>|!=|>=|<=|=|>|<|in|between|like)\\s+(${_maskStrings.placeholderSource}|(${_parseLiteralValue.numberSource})|${_maskStrings.arraySource}|(null)|(true)|(false)))`, 'i');
-// The clause keywords that end a where expression (outside brackets), and `and on` (a join clause's own `and`)
-const expressionEnd = keyword('sort|group|limit|offset|select|merge|on|where|and\\s+on');
-const whereMatch = new RegExp(`(^|[^a-z0-9._-])((?:(and|or)\\s+)?where)${wordEnd}`, 'i');
 /**
  * Read one condition from a match of conditionMatch.
  * @param match
@@ -62,15 +60,15 @@ const join = (kind, nodes) => {
   };
 };
 /**
- * Read one where expression from the masked query, starting at `start` (just after its `where`). Precedence, loosest
- * first: `or`, `and`, `not`; brackets group. `and where` / `or where` are the older spellings of `and` / `or`.
+ * Read one where expression from the start of a where clause body (masked, see maskStrings). Precedence, loosest
+ * first: `or`, `and`, `not`; brackets group.
  * @param text
- * @param start
- * @returns The expression's tree and where it ends (the next clause keyword outside brackets, or the end).
- * @throws {Error} For an unbalanced bracket, empty brackets, or an operator with no condition after it.
+ * @returns The expression's tree and where it ends (at the first text that can't carry it on, or the end).
+ * @throws {Error} For an unbalanced bracket, empty brackets, an operator with no condition after it, or two conditions
+ * with no and/or between them.
  */
-const readExpression = (text, start) => {
-  let at = start;
+const readExpression = text => {
+  let at = 0;
   const rest = () => text.slice(at);
   const skipSpace = () => {
     at += rest().length - rest().trimStart().length;
@@ -93,6 +91,10 @@ const readExpression = (text, start) => {
       at += condition[0].length;
       return readCondition(condition);
     }
+    // The 2.x `and where` / `or where` inside brackets, where splitClauses doesn't look
+    if ((after === 'and' || after === 'or') && keyword('where').test(rest())) {
+      throw new Error(`"${after} where" is no longer supported: ${_splitClauses.whereHint}`);
+    }
     if (take(keyword('not'))) {
       return {
         not: factor('not')
@@ -115,11 +117,7 @@ const readExpression = (text, start) => {
   const term = after => {
     const nodes = [factor(after)];
     for (;;) {
-      skipSpace();
-      if (keyword('and\\s+on').test(rest())) {
-        break;
-      }
-      const connector = take(keyword('and(?:\\s+where)?'));
+      const connector = take(keyword('and'));
       if (!connector) {
         break;
       }
@@ -130,7 +128,7 @@ const readExpression = (text, start) => {
   const expression = after => {
     const nodes = [term(after)];
     for (;;) {
-      const connector = take(keyword('or(?:\\s+where)?'));
+      const connector = take(keyword('or'));
       if (!connector) {
         break;
       }
@@ -143,7 +141,7 @@ const readExpression = (text, start) => {
   if (rest().startsWith(')')) {
     throw new Error(`Unexpected ) in a where clause: ${shown()}`);
   }
-  if (rest() && !expressionEnd.test(rest()) && conditionMatch.test(rest())) {
+  if (conditionMatch.test(rest())) {
     throw new Error(`Missing and/or before: ${shown()}`);
   }
   return {
@@ -152,31 +150,21 @@ const readExpression = (text, start) => {
   };
 };
 /**
- * Extract the where clause from the query into a tree (see ConditionNode): `where` followed by conditions joined with
- * `and` / `or`, `not`, and brackets, nested to any depth. Each condition is `<field> <comparator> <value>`, or
- * `<field> is null`, `is not null`, `exists` or `does not exist`. A comparison with the literal null (`= null`) is
- * refused: it would never match, as null equals nothing (see where). The expression ends at the next clause keyword
- * outside brackets, so clauses may come in any order; several separate `where`s (or `and where` after another clause)
- * are joined with `and`, as before.
+ * Read a where clause body (see splitClauses) into a tree (see ConditionNode): conditions joined with `and` / `or`,
+ * `not`, and brackets, nested to any depth. Each condition is `<field> <comparator> <value>`, or `<field> is null`,
+ * `is not null`, `exists` or `does not exist`. A comparison with the literal null (`= null`) is refused: it would never
+ * match, as null equals nothing (see where).
  * @param parsed
- * @param query
- * @throws {Error} For the errors readExpression and readCondition describe, and `or where` after another clause.
+ * @param body
+ * @returns The rest of the body, after the expression.
+ * @throws {Error} For the errors readExpression and readCondition describe.
  */
-const findConditions = (parsed, query) => {
-  const expressions = [];
-  for (let found = query.match(whereMatch); found; found = query.match(whereMatch)) {
-    if ((found[3] || '').toLowerCase() === 'or') {
-      throw new Error('`or where` must follow the conditions it joins: put them in one where clause');
-    }
-    const whereStart = found.index + found[1].length;
-    const {
-      node,
-      end
-    } = readExpression(query, whereStart + found[2].length);
-    expressions.push(node);
-    query = `${query.slice(0, whereStart)} ${query.slice(end)}`.replace(/\s+/g, ' ').trim();
-  }
-  parsed['where'] = expressions.length ? join('and', expressions) : (0, _conditionTree.allOf)([]);
-  return query;
+const findConditions = (parsed, body) => {
+  const {
+    node,
+    end
+  } = readExpression(body);
+  parsed['where'] = node;
+  return body.slice(end).trim();
 };
 exports.findConditions = findConditions;

package/dist/data/utilities/parsers/findConditions.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findConditions=void 0,require("core-js/modules/es.array.includes.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.flat-map.js");var _parseLiteralValue=require("./parseLiteralValue"),_conditionTree=require("../conditionTree"),_maskStrings=require("./maskStrings");const wordEnd="(?![a-z0-9_.-])",keyword=e=>new RegExp(`^(?:${e})${wordEnd}`,"i"),conditionMatch=new RegExp(`^([a-z0-9_-]+\\.?[a-z0-9_-]*)\\s+(?:(is\\s+not\\s+null|is\\s+null|exists|does\\s+not\\s+exist)${wordEnd}|(<>|!=|>=|<=|=|>|<|in|between|like)\\s+(${_maskStrings.placeholderSource}|(${_parseLiteralValue.numberSource})|${_maskStrings.arraySource}|(null)|(true)|(false)))`,"i"),expressionEnd=keyword("sort|group|limit|offset|select|merge|on|where|and\\s+on"),whereMatch=new RegExp(`(^|[^a-z0-9._-])((?:(and|or)\\s+)?where)${wordEnd}`,"i"),readCondition=e=>{const r=e[1];if(void 0!==e[2])return{property:r,comparator:e[2].toLowerCase().replace(/\s+/g," "),value:null};const n=e[3].toLowerCase(),t=(0,_parseLiteralValue.parseLiteralValue)(e,5);if(null===t)throw new Error(`\`${r} ${n} null\` never matches (null equals nothing, as in SQL): use \`${r} is null\` or \`${r} is not null\``);if("between"===n&&Array.isArray(t)&&t.includes(null))throw new Error(`\`${r} between\` can't have a null bound: it would never match`);return{property:r,comparator:n,value:t}},join=(e,r)=>{const n=r.flatMap((r=>!(0,_conditionTree.isCondition)(r)&&e in r?r[e]:[r]));return 1===n.length?n[0]:"and"===e?{and:n}:{or:n}},readExpression=(e,r)=>{let n=r;const t=()=>e.slice(n),o=()=>{n+=t().length-t().trimStart().length},s=e=>{o();const r=t().match(e);if(r)return n+=r[0].length,r[0]},i=()=>(0,_maskStrings.unmaskStrings)(t().trim(),"'"),a=e=>{o();const r=t().match(conditionMatch);if(r)return n+=r[0].length,readCondition(r);if(s(keyword("not")))return{not:a("not")};if(s(/^\(/)){if(o(),t().startsWith(")"))throw new Error("Empty brackets in a where clause");const e=d("(");if(!s(/^\)/))throw new Error("Missing ) "+(t().trim()?`before: ${i()}`:"at the end of the where clause"));return e}throw new Error(`Missing a condition after ${e}${t().trim()?`: ${i()}`:""}`)},l=e=>{const r=[a(e)];for(;o(),!keyword("and\\s+on").test(t());){const e=s(keyword("and(?:\\s+where)?"));if(!e)break;r.push(a(e.toLowerCase().replace(/\s+/g," ")))}return join("and",r)},d=e=>{const r=[l(e)];for(;;){const e=s(keyword("or(?:\\s+where)?"));if(!e)break;r.push(l(e.toLowerCase().replace(/\s+/g," ")))}return join("or",r)},c=d("where");if(o(),t().startsWith(")"))throw new Error(`Unexpected ) in a where clause: ${i()}`);if(t()&&!expressionEnd.test(t())&&conditionMatch.test(t()))throw new Error(`Missing and/or before: ${i()}`);return{node:c,end:n}},findConditions=(e,r)=>{const n=[];for(let e=r.match(whereMatch);e;e=r.match(whereMatch)){if("or"===(e[3]||"").toLowerCase())throw new Error("`or where` must follow the conditions it joins: put them in one where clause");const t=e.index+e[1].length,{node:o,end:s}=readExpression(r,t+e[2].length);n.push(o),r=`${r.slice(0,t)} ${r.slice(s)}`.replace(/\s+/g," ").trim()}return e.where=n.length?join("and",n):(0,_conditionTree.allOf)([]),r};exports.findConditions=findConditions;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findConditions=void 0,require("core-js/modules/es.array.includes.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.flat-map.js");var _parseLiteralValue=require("./parseLiteralValue"),_conditionTree=require("../conditionTree"),_maskStrings=require("./maskStrings"),_splitClauses=require("./splitClauses");const wordEnd="(?![a-z0-9_.-])",keyword=e=>new RegExp(`^(?:${e})${wordEnd}`,"i"),conditionMatch=new RegExp(`^([a-z0-9_-]+\\.?[a-z0-9_-]*)\\s+(?:(is\\s+not\\s+null|is\\s+null|exists|does\\s+not\\s+exist)${wordEnd}|(<>|!=|>=|<=|=|>|<|in|between|like)\\s+(${_maskStrings.placeholderSource}|(${_parseLiteralValue.numberSource})|${_maskStrings.arraySource}|(null)|(true)|(false)))`,"i"),readCondition=e=>{const r=e[1];if(void 0!==e[2])return{property:r,comparator:e[2].toLowerCase().replace(/\s+/g," "),value:null};const n=e[3].toLowerCase(),t=(0,_parseLiteralValue.parseLiteralValue)(e,5);if(null===t)throw new Error(`\`${r} ${n} null\` never matches (null equals nothing, as in SQL): use \`${r} is null\` or \`${r} is not null\``);if("between"===n&&Array.isArray(t)&&t.includes(null))throw new Error(`\`${r} between\` can't have a null bound: it would never match`);return{property:r,comparator:n,value:t}},join=(e,r)=>{const n=r.flatMap((r=>!(0,_conditionTree.isCondition)(r)&&e in r?r[e]:[r]));return 1===n.length?n[0]:"and"===e?{and:n}:{or:n}},readExpression=e=>{let r=0;const n=()=>e.slice(r),t=()=>{r+=n().length-n().trimStart().length},o=e=>{t();const o=n().match(e);if(o)return r+=o[0].length,o[0]},s=()=>(0,_maskStrings.unmaskStrings)(n().trim(),"'"),i=e=>{t();const a=n().match(conditionMatch);if(a)return r+=a[0].length,readCondition(a);if(("and"===e||"or"===e)&&keyword("where").test(n()))throw new Error(`"${e} where" is no longer supported: ${_splitClauses.whereHint}`);if(o(keyword("not")))return{not:i("not")};if(o(/^\(/)){if(t(),n().startsWith(")"))throw new Error("Empty brackets in a where clause");const e=l("(");if(!o(/^\)/))throw new Error("Missing ) "+(n().trim()?`before: ${s()}`:"at the end of the where clause"));return e}throw new Error(`Missing a condition after ${e}${n().trim()?`: ${s()}`:""}`)},a=e=>{const r=[i(e)];for(;;){const e=o(keyword("and"));if(!e)break;r.push(i(e.toLowerCase().replace(/\s+/g," ")))}return join("and",r)},l=e=>{const r=[a(e)];for(;;){const e=o(keyword("or"));if(!e)break;r.push(a(e.toLowerCase().replace(/\s+/g," ")))}return join("or",r)},u=l("where");if(t(),n().startsWith(")"))throw new Error(`Unexpected ) in a where clause: ${s()}`);if(conditionMatch.test(n()))throw new Error(`Missing and/or before: ${s()}`);return{node:u,end:r}},findConditions=(e,r)=>{const{node:n,end:t}=readExpression(r);return e.where=n,r.slice(t).trim()};exports.findConditions=findConditions;

package/dist/data/utilities/parsers/findGroupBy.d.ts

@@ -1,9 +1,11 @@
 import { ParsedQuery } from './parseQuery';
-export type ParsedGroupBy = string;
+export type ParsedGroupBy = string[];
 /**
- * Extract the group by clauses from the query.
+ * Read a group by clause body (`a, b`, see splitClauses).
  * @param parsed
- * @param query
+ * @param body
+ * @returns The rest of the body, after the last field.
+ * @throws {Error} For a field named twice.
  */
-export declare const findGroupBy: (parsed: ParsedQuery, query: string) => string;
+export declare const findGroupBy: (parsed: ParsedQuery, body: string) => string;
 //# sourceMappingURL=findGroupBy.d.ts.map

package/dist/data/utilities/parsers/findGroupBy.js

@@ -4,19 +4,27 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.findGroupBy = void 0;
-var _removeFromQuery = require("./removeFromQuery");
-const groupMatch = /group\s+by\s+(,?[a-z0-9._-]+)+/i;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.find.js");
+const groupMatch = /^[a-z0-9._-]+(?:\s*,\s*[a-z0-9._-]+)*/i;
 /**
- * Extract the group by clauses from the query.
+ * Read a group by clause body (`a, b`, see splitClauses).
  * @param parsed
- * @param query
+ * @param body
+ * @returns The rest of the body, after the last field.
+ * @throws {Error} For a field named twice.
  */
-const findGroupBy = (parsed, query) => {
-  const groupFound = query.match(groupMatch);
+const findGroupBy = (parsed, body) => {
+  const groupFound = body.match(groupMatch);
   if (groupFound) {
-    parsed['groupBy'] = groupFound ? groupFound[1] : undefined;
-    return (0, _removeFromQuery.removeFromQuery)(groupFound[0], query);
+    const fields = groupFound[0].split(/\s*,\s*/);
+    const repeated = fields.find((field, index) => fields.indexOf(field) !== index);
+    if (repeated) {
+      throw new Error(`"${repeated}" is in group by twice`);
+    }
+    parsed['groupBy'] = fields;
+    return body.slice(groupFound[0].length).trim();
   }
-  return query;
+  return body;
 };
 exports.findGroupBy = findGroupBy;

package/dist/data/utilities/parsers/findGroupBy.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findGroupBy=void 0;var _removeFromQuery=require("./removeFromQuery");const groupMatch=/group\s+by\s+(,?[a-z0-9._-]+)+/i,findGroupBy=(r,e)=>{const o=e.match(groupMatch);return o?(r.groupBy=o?o[1]:void 0,(0,_removeFromQuery.removeFromQuery)(o[0],e)):e};exports.findGroupBy=findGroupBy;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findGroupBy=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.find.js");const groupMatch=/^[a-z0-9._-]+(?:\s*,\s*[a-z0-9._-]+)*/i,findGroupBy=(r,e)=>{const t=e.match(groupMatch);if(t){const o=t[0].split(/\s*,\s*/),s=o.find(((r,e)=>o.indexOf(r)!==e));if(s)throw new Error(`"${s}" is in group by twice`);return r.groupBy=o,e.slice(t[0].length).trim()}return e};exports.findGroupBy=findGroupBy;

package/dist/data/utilities/parsers/findInsertValues.d.ts

@@ -3,11 +3,12 @@ export type ParsedInsertRow = {
     [field: string]: any;
 };
 /**
- * Extract an insert's "values field = value, field2 = value2" clause from the query, the same way
+ * Read an insert's values clause body (`field = value, field2 = value2`, see splitClauses), the same way
  * findUpdateValues() does for "set". insertEntity() accepts an array of rows for bulk inserts, but
  * a query string only describes a single row for now - wrapped in a one-element array to match.
  * @param parsed
- * @param query
+ * @param body
+ * @returns The rest of the body, after the last assignment.
  */
-export declare const findInsertValues: (parsed: ParsedQuery, query: string) => string;
+export declare const findInsertValues: (parsed: ParsedQuery, body: string) => string;
 //# sourceMappingURL=findInsertValues.d.ts.map