json-fs-query 1.1.0 → 2.0.0

package/dist/data/utilities/mergeJoin.js

@@ -1,48 +1,48 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.mergeJoin = void 0;
-require("core-js/modules/esnext.iterator.constructor.js");
-require("core-js/modules/esnext.iterator.map.js");
-var _readEntity = require("../queries/readEntity");
-var _splitEntityProperty = require("./parsers/splitEntityProperty");
-var _where = require("../queries/where");
-var _retrieveRecord = require("./retrieveRecord");
-var _fieldType = require("./fieldType");
-const mergeJoin = async (propertyA = '', propertyB = '', dataSets = {}) => {
-  const {
-    entity: entityA,
-    property: propA
-  } = (0, _splitEntityProperty.splitEntityProperty)(propertyA);
-  const {
-    entity: entityB,
-    property: propB
-  } = (0, _splitEntityProperty.splitEntityProperty)(propertyB);
-  dataSets = await (0, _readEntity.readEntity)(entityA, dataSets);
-  dataSets = await (0, _readEntity.readEntity)(entityB, dataSets);
-  const typeB = (0, _fieldType.fieldType)(await (0, _retrieveRecord.retrieveRecord)(entityB), propB);
-  dataSets[entityA] = dataSets[entityA].map(dataA => {
-    const matches = (0, _where.where)(dataSets[entityB], {
-      property: propB,
-      comparator: '=',
-      value: dataA[propA],
-      type: typeB
-    });
-    if (!matches.length) {
-      return dataA;
-    }
-    const mergeMatch = matches[0];
-    for (const prop in mergeMatch) {
-      if (prop === propB) {
-        // Skip the condition property since it is irrelevant
-        continue;
-      }
-      dataA[`${entityB}.${prop}`] = mergeMatch[prop];
-    }
-    return dataA;
-  });
-  return dataSets;
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mergeJoin = void 0;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.map.js");
+var _readEntity = require("../queries/readEntity");
+var _splitEntityProperty = require("./parsers/splitEntityProperty");
+var _where = require("../queries/where");
+var _retrieveRecord = require("./retrieveRecord");
+var _fieldType = require("./fieldType");
+const mergeJoin = async (propertyA = '', propertyB = '', dataSets = {}) => {
+  const {
+    entity: entityA,
+    property: propA
+  } = (0, _splitEntityProperty.splitEntityProperty)(propertyA);
+  const {
+    entity: entityB,
+    property: propB
+  } = (0, _splitEntityProperty.splitEntityProperty)(propertyB);
+  dataSets = await (0, _readEntity.readEntity)(entityA, dataSets);
+  dataSets = await (0, _readEntity.readEntity)(entityB, dataSets);
+  const typeB = (0, _fieldType.fieldType)(await (0, _retrieveRecord.retrieveRecord)(entityB), propB);
+  dataSets[entityA] = dataSets[entityA].map(dataA => {
+    const matches = (0, _where.where)(dataSets[entityB], {
+      property: propB,
+      comparator: '=',
+      value: dataA[propA],
+      type: typeB
+    });
+    if (!matches.length) {
+      return dataA;
+    }
+    const mergeMatch = matches[0];
+    for (const prop in mergeMatch) {
+      if (prop === propB) {
+        // Skip the condition property since it is irrelevant
+        continue;
+      }
+      dataA[`${entityB}.${prop}`] = mergeMatch[prop];
+    }
+    return dataA;
+  });
+  return dataSets;
+};
 exports.mergeJoin = mergeJoin;

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

@@ -1,16 +1,19 @@
-import { LiteralValue } from './parseLiteralValue';
-import { ParsedQuery } from './parseQuery';
-export type ConditionValue = LiteralValue;
-export type ParsedCondition = {
-    property: string;
-    comparator: string;
-    value: ConditionValue;
-    type?: string;
-};
-/**
- * Extract condition clauses from the query.
- * @param parsed
- * @param query
- */
-export declare const findConditions: (parsed: ParsedQuery, query: string) => string;
+import { LiteralValue } from './parseLiteralValue';
+import { ParsedQuery } from './parseQuery';
+export type ConditionValue = LiteralValue;
+export type ParsedCondition = {
+    property: string;
+    comparator: string;
+    value: ConditionValue;
+    type?: string;
+};
+/**
+ * Extract condition clauses from the query: `where <field> <comparator> <value>`, each further one joined with
+ * `and where`. `or where` is refused until or is built (TASKS: the where-clauses epic): it used to be read the same as
+ * `and where`, which silently returned the wrong rows.
+ * @param parsed
+ * @param query
+ * @throws {Error} For `or where`.
+ */
+export declare const findConditions: (parsed: ParsedQuery, query: string) => string;
 //# sourceMappingURL=findConditions.d.ts.map

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

@@ -6,22 +6,31 @@ Object.defineProperty(exports, "__esModule", {
 exports.findConditions = void 0;
 var _removeFromQuery = require("./removeFromQuery");
 var _parseLiteralValue = require("./parseLiteralValue");
-const conditionMatch = /(and|or)?\s*(where)\s+([a-z0-9_-]+\.?[a-z0-9_-]*)\s+(=|!=|>|<|>=|<=|in|between|like)\s+(["'](.*)['"]|([0-9]+)|(\[.*])|(null)|(true)|(false))/ig;
+var _maskStrings = require("./maskStrings");
+// `and`/`or`/`where` count only as whole words: in `on t.x = u.color where ...` the `or` is part of the name `color`
+const conditionMatch = new RegExp(`(^|[^a-z0-9._-])(?:(and|or)\\s+)?(where)\\s+([a-z0-9_-]+\\.?[a-z0-9_-]*)\\s+(=|!=|>|<|>=|<=|in|between|like)\\s+(${_maskStrings.placeholderSource}|([0-9]+)|${_maskStrings.arraySource}|(null)|(true)|(false))`, 'ig');
 /**
- * Extract condition clauses from the query.
+ * Extract condition clauses from the query: `where <field> <comparator> <value>`, each further one joined with
+ * `and where`. `or where` is refused until or is built (TASKS: the where-clauses epic): it used to be read the same as
+ * `and where`, which silently returned the wrong rows.
  * @param parsed
  * @param query
+ * @throws {Error} For `or where`.
  */
 const findConditions = (parsed, query) => {
   const conditionsFound = query.matchAll(conditionMatch);
   // @ts-ignore
   for (const condition of conditionsFound) {
+    if (typeof condition[2] !== 'undefined' && condition[2].toLowerCase() === 'or') {
+      throw new Error('`or where` is not supported yet: use `and where`, or run one query per alternative');
+    }
     parsed['conditions'].push({
-      property: condition[3],
-      comparator: condition[4],
-      value: (0, _parseLiteralValue.parseLiteralValue)(condition, 6)
+      property: condition[4],
+      comparator: condition[5],
+      value: (0, _parseLiteralValue.parseLiteralValue)(condition, 7)
     });
-    query = (0, _removeFromQuery.removeFromQuery)(condition[0], query);
+    // Leave out the character before the condition (group 1): it isn't part of it, and an earlier removal may have trimmed it
+    query = (0, _removeFromQuery.removeFromQuery)(condition[0].slice(condition[1].length), query);
   }
   return query;
 };

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findConditions=void 0;var _removeFromQuery=require("./removeFromQuery"),_parseLiteralValue=require("./parseLiteralValue");const conditionMatch=/(and|or)?\s*(where)\s+([a-z0-9_-]+\.?[a-z0-9_-]*)\s+(=|!=|>|<|>=|<=|in|between|like)\s+(["'](.*)['"]|([0-9]+)|(\[.*])|(null)|(true)|(false))/gi,findConditions=(e,r)=>{const o=r.matchAll(conditionMatch);for(const i of o)e.conditions.push({property:i[3],comparator:i[4],value:(0,_parseLiteralValue.parseLiteralValue)(i,6)}),r=(0,_removeFromQuery.removeFromQuery)(i[0],r);return r};exports.findConditions=findConditions;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findConditions=void 0;var _removeFromQuery=require("./removeFromQuery"),_parseLiteralValue=require("./parseLiteralValue"),_maskStrings=require("./maskStrings");const conditionMatch=new RegExp(`(^|[^a-z0-9._-])(?:(and|or)\\s+)?(where)\\s+([a-z0-9_-]+\\.?[a-z0-9_-]*)\\s+(=|!=|>|<|>=|<=|in|between|like)\\s+(${_maskStrings.placeholderSource}|([0-9]+)|${_maskStrings.arraySource}|(null)|(true)|(false))`,"ig"),findConditions=(e,r)=>{const o=r.matchAll(conditionMatch);for(const t of o){if(void 0!==t[2]&&"or"===t[2].toLowerCase())throw new Error("`or where` is not supported yet: use `and where`, or run one query per alternative");e.conditions.push({property:t[4],comparator:t[5],value:(0,_parseLiteralValue.parseLiteralValue)(t,7)}),r=(0,_removeFromQuery.removeFromQuery)(t[0].slice(t[1].length),r)}return r};exports.findConditions=findConditions;

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

@@ -6,9 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 exports.findInsertValues = void 0;
 var _removeFromQuery = require("./removeFromQuery");
 var _parseLiteralValue = require("./parseLiteralValue");
-const literal = '(?:["\'][^"\']*[\'"]|[0-9]+|\\[.*?]|null|true|false)';
+var _maskStrings = require("./maskStrings");
+const literal = `(?:${_maskStrings.placeholderSource.replace('(', '(?:')}|[0-9]+|${_maskStrings.arraySource.replace('(', '(?:')}|null|true|false)`;
 const valuesClauseMatch = new RegExp(`(values)\\s+([a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*)`, 'i');
-const assignmentMatch = /([a-z0-9_-]+)\s*=\s*(["'](.*?)['"]|([0-9]+)|(\[.*?])|(null)|(true)|(false))/ig;
+const assignmentMatch = new RegExp(`([a-z0-9_-]+)\\s*=\\s*(${_maskStrings.placeholderSource}|([0-9]+)|${_maskStrings.arraySource}|(null)|(true)|(false))`, 'ig');
 /**
  * Extract an insert's "values field = value, field2 = value2" clause from the query, the same way
  * findUpdateValues() does for "set". insertEntity() accepts an array of rows for bulk inserts, but

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findInsertValues=void 0;var _removeFromQuery=require("./removeFromQuery"),_parseLiteralValue=require("./parseLiteralValue");const literal="(?:[\"'][^\"']*['\"]|[0-9]+|\\[.*?]|null|true|false)",valuesClauseMatch=new RegExp(`(values)\\s+([a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*)`,"i"),assignmentMatch=/([a-z0-9_-]+)\s*=\s*(["'](.*?)['"]|([0-9]+)|(\[.*?])|(null)|(true)|(false))/gi,findInsertValues=(e,r)=>{const s=r.match(valuesClauseMatch);if(e.insertValues=[],!s)return r;const a={},t=s[2].matchAll(assignmentMatch);for(const e of t)a[e[1]]=(0,_parseLiteralValue.parseLiteralValue)(e,3);return e.insertValues=[a],(0,_removeFromQuery.removeFromQuery)(s[0],r)};exports.findInsertValues=findInsertValues;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findInsertValues=void 0;var _removeFromQuery=require("./removeFromQuery"),_parseLiteralValue=require("./parseLiteralValue"),_maskStrings=require("./maskStrings");const literal=`(?:${_maskStrings.placeholderSource.replace("(","(?:")}|[0-9]+|${_maskStrings.arraySource.replace("(","(?:")}|null|true|false)`,valuesClauseMatch=new RegExp(`(values)\\s+([a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*)`,"i"),assignmentMatch=new RegExp(`([a-z0-9_-]+)\\s*=\\s*(${_maskStrings.placeholderSource}|([0-9]+)|${_maskStrings.arraySource}|(null)|(true)|(false))`,"ig"),findInsertValues=(e,r)=>{const s=r.match(valuesClauseMatch);if(e.insertValues=[],!s)return r;const a={},t=s[2].matchAll(assignmentMatch);for(const e of t)a[e[1]]=(0,_parseLiteralValue.parseLiteralValue)(e,3);return e.insertValues=[a],(0,_removeFromQuery.removeFromQuery)(s[0],r)};exports.findInsertValues=findInsertValues;

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

@@ -5,8 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.findSelects = void 0;
 var _removeFromQuery = require("./removeFromQuery");
-const selectClausesMatch = /select\s+([a-z0-9=._-]+\s*(as\s+)?([a-z0-9_-]+)?)+\s*(,\s*[a-z0-9=._-]+\s*(as\s*[a-z0-9_-]+)?)*/i;
-const selectClauseMatch = /(select)?\s*,?\s*([a-z0-9=._-]+)\s*(as\s+)?([a-z0-9_-]+)?/ig;
+// One field is a name, then optionally `as <alias>` (`as` as a whole word); fields are separated by commas. The first
+// field used to accept an alias without `as`, so in `select name where a = 1` the word `where` became the alias.
+const selectField = '[a-z0-9=._-]+(?:\\s+as\\s+[a-z0-9_-]+)?';
+const selectClausesMatch = new RegExp(`select\\s+${selectField}(?:\\s*,\\s*${selectField})*`, 'i');
+const selectClauseMatch = /(select)?\s*,?\s*([a-z0-9=._-]+)(?:\s+as\s+([a-z0-9_-]+))?/ig;
 /**
  * Extract select clauses from the query.
  * @param parsed
@@ -20,7 +23,7 @@ const findSelects = (parsed, query) => {
     for (const selectClause of selectClausesFound) {
       parsed['selectClauses'].push({
         property: selectClause[2],
-        alias: selectClause[4]
+        alias: selectClause[3]
       });
     }
     return (0, _removeFromQuery.removeFromQuery)(selectsFound[0], query);

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findSelects=void 0;var _removeFromQuery=require("./removeFromQuery");const selectClausesMatch=/select\s+([a-z0-9=._-]+\s*(as\s+)?([a-z0-9_-]+)?)+\s*(,\s*[a-z0-9=._-]+\s*(as\s*[a-z0-9_-]+)?)*/i,selectClauseMatch=/(select)?\s*,?\s*([a-z0-9=._-]+)\s*(as\s+)?([a-z0-9_-]+)?/gi,findSelects=(e,s)=>{const t=s.match(selectClausesMatch);if(t){const r=t[0].matchAll(selectClauseMatch);for(const s of r)e.selectClauses.push({property:s[2],alias:s[4]});return(0,_removeFromQuery.removeFromQuery)(t[0],s)}return s};exports.findSelects=findSelects;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findSelects=void 0;var _removeFromQuery=require("./removeFromQuery");const selectField="[a-z0-9=._-]+(?:\\s+as\\s+[a-z0-9_-]+)?",selectClausesMatch=new RegExp(`select\\s+${selectField}(?:\\s*,\\s*${selectField})*`,"i"),selectClauseMatch=/(select)?\s*,?\s*([a-z0-9=._-]+)(?:\s+as\s+([a-z0-9_-]+))?/gi,findSelects=(e,s)=>{const t=s.match(selectClausesMatch);if(t){const r=t[0].matchAll(selectClauseMatch);for(const s of r)e.selectClauses.push({property:s[2],alias:s[3]});return(0,_removeFromQuery.removeFromQuery)(t[0],s)}return s};exports.findSelects=findSelects;

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

@@ -5,8 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.findSortClauses = void 0;
 var _removeFromQuery = require("./removeFromQuery");
-const sortMatch = /sort\s+([a-z0-9._-]+\s*(asc|desc)?)+\s*(,\s*[a-z0-9._-]+\s*(asc|desc)?)*/i;
-const sortRuleMatch = /(sort)?\s*,?\s*([a-z0-9._-]+)\s*(asc|desc)?/ig;
+// One rule is a field, then optionally asc or desc as a whole word. Rules are separated by commas, so the list ends
+// at the first word that doesn't follow a comma: in `sort a limit 1`, `limit` starts the next clause.
+const sortRule = '[a-z0-9._-]+(?:\\s+(?:asc|desc)(?![a-z0-9._-]))?';
+const sortMatch = new RegExp(`sort\\s+${sortRule}(?:\\s*,\\s*${sortRule})*`, 'i');
+const sortRuleMatch = /(sort)?\s*,?\s*([a-z0-9._-]+)(?:\s+(asc|desc)(?![a-z0-9._-]))?/ig;
 /**
  * Extract sort clauses from the query.
  * @param parsed

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findSortClauses=void 0;var _removeFromQuery=require("./removeFromQuery");const sortMatch=/sort\s+([a-z0-9._-]+\s*(asc|desc)?)+\s*(,\s*[a-z0-9._-]+\s*(asc|desc)?)*/i,sortRuleMatch=/(sort)?\s*,?\s*([a-z0-9._-]+)\s*(asc|desc)?/gi,findSortClauses=(s,r)=>{const e=r.match(sortMatch);if(e){const o=e[0].matchAll(sortRuleMatch);for(const r of o)s.sortClauses.push({property:r[2],direction:r[3]||"asc"});return(0,_removeFromQuery.removeFromQuery)(e[0],r)}return r};exports.findSortClauses=findSortClauses;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findSortClauses=void 0;var _removeFromQuery=require("./removeFromQuery");const sortRule="[a-z0-9._-]+(?:\\s+(?:asc|desc)(?![a-z0-9._-]))?",sortMatch=new RegExp(`sort\\s+${sortRule}(?:\\s*,\\s*${sortRule})*`,"i"),sortRuleMatch=/(sort)?\s*,?\s*([a-z0-9._-]+)(?:\s+(asc|desc)(?![a-z0-9._-]))?/gi,findSortClauses=(e,r)=>{const s=r.match(sortMatch);if(s){const o=s[0].matchAll(sortRuleMatch);for(const r of o)e.sortClauses.push({property:r[2],direction:r[3]||"asc"});return(0,_removeFromQuery.removeFromQuery)(s[0],r)}return r};exports.findSortClauses=findSortClauses;

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

@@ -6,9 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 exports.findUpdateValues = void 0;
 var _removeFromQuery = require("./removeFromQuery");
 var _parseLiteralValue = require("./parseLiteralValue");
-const literal = '(?:["\'][^"\']*[\'"]|[0-9]+|\\[.*?]|null|true|false)';
+var _maskStrings = require("./maskStrings");
+const literal = `(?:${_maskStrings.placeholderSource.replace('(', '(?:')}|[0-9]+|${_maskStrings.arraySource.replace('(', '(?:')}|null|true|false)`;
 const setClauseMatch = new RegExp(`(set)\\s+([a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*)`, 'i');
-const assignmentMatch = /([a-z0-9_-]+)\s*=\s*(["'](.*?)['"]|([0-9]+)|(\[.*?])|(null)|(true)|(false))/ig;
+const assignmentMatch = new RegExp(`([a-z0-9_-]+)\\s*=\\s*(${_maskStrings.placeholderSource}|([0-9]+)|${_maskStrings.arraySource}|(null)|(true)|(false))`, 'ig');
 /**
  * Extract an update's "set field = value, field2 = value2" clause from the query. Uses a two-pass
  * match, unlike the other parsers here: the set clause's own boundary is found first (so it can

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findUpdateValues=void 0;var _removeFromQuery=require("./removeFromQuery"),_parseLiteralValue=require("./parseLiteralValue");const literal="(?:[\"'][^\"']*['\"]|[0-9]+|\\[.*?]|null|true|false)",setClauseMatch=new RegExp(`(set)\\s+([a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*)`,"i"),assignmentMatch=/([a-z0-9_-]+)\s*=\s*(["'](.*?)['"]|([0-9]+)|(\[.*?])|(null)|(true)|(false))/gi,findUpdateValues=(e,a)=>{const r=a.match(setClauseMatch);if(e.updateValues={},!r)return a;const s=r[2].matchAll(assignmentMatch);for(const a of s)e.updateValues[a[1]]=(0,_parseLiteralValue.parseLiteralValue)(a,3);return(0,_removeFromQuery.removeFromQuery)(r[0],a)};exports.findUpdateValues=findUpdateValues;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findUpdateValues=void 0;var _removeFromQuery=require("./removeFromQuery"),_parseLiteralValue=require("./parseLiteralValue"),_maskStrings=require("./maskStrings");const literal=`(?:${_maskStrings.placeholderSource.replace("(","(?:")}|[0-9]+|${_maskStrings.arraySource.replace("(","(?:")}|null|true|false)`,setClauseMatch=new RegExp(`(set)\\s+([a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*)`,"i"),assignmentMatch=new RegExp(`([a-z0-9_-]+)\\s*=\\s*(${_maskStrings.placeholderSource}|([0-9]+)|${_maskStrings.arraySource}|(null)|(true)|(false))`,"ig"),findUpdateValues=(e,r)=>{const a=r.match(setClauseMatch);if(e.updateValues={},!a)return r;const s=a[2].matchAll(assignmentMatch);for(const r of s)e.updateValues[r[1]]=(0,_parseLiteralValue.parseLiteralValue)(r,3);return(0,_removeFromQuery.removeFromQuery)(a[0],r)};exports.findUpdateValues=findUpdateValues;

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

@@ -0,0 +1,39 @@
+/**
+ * Regex source matching one placeholder from maskStrings, with the hex-encoded value as its only group. The
+ * find* parsers use it where they would otherwise match a quoted string.
+ */
+export declare const placeholderSource = "\\u0000([0-9a-f]*)\\u0000";
+/**
+ * Regex source matching one placeholder from maskArrays, with the hex-encoded JSON of the array as its only group.
+ * The find* parsers use it where they would otherwise match `[...]`.
+ */
+export declare const arraySource = "\\u0001([0-9a-f]*)\\u0001";
+/**
+ * Turn the hex of a placeholder back into the string's value.
+ * @param hex
+ */
+export declare const fromPlaceholder: (hex: string) => string;
+/**
+ * Replace every quoted string in a query with a placeholder holding its value (with the escapes applied), so that
+ * nothing inside a string (a keyword, a quote, `and`, a `]`) can be matched by the find* parsers.
+ * @param query
+ * @throws {Error} For an unclosed string, comment or bracket, or a NUL or SOH character outside a string (which
+ * could otherwise pass for a placeholder).
+ */
+export declare const maskStrings: (query: string) => string;
+/**
+ * Put every placeholder back the way it would be written in a query: strings quoted, arrays as JSON. For error
+ * messages, and for reading an array's text as JSON.
+ * @param text
+ * @param quote - wrap strings with JSON's double quotes (the default) or with single quotes
+ */
+export declare const unmaskStrings: (text: string, quote?: "json" | "'") => string;
+/**
+ * Replace every array (outermost brackets only, so a nested array stays inside its parent) with a placeholder holding
+ * its JSON, so that the find* parsers never have to find where an array ends, and nothing inside one (a `.`, a `]`,
+ * a keyword) can be matched by them. Run it on the output of maskStrings, where no `[` or `]` is inside a string.
+ * @param masked
+ * @throws {Error} For an array which is not valid JSON once its strings are put back.
+ */
+export declare const maskArrays: (masked: string) => string;
+//# sourceMappingURL=maskStrings.d.ts.map

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

@@ -0,0 +1,123 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.unmaskStrings = exports.placeholderSource = exports.maskStrings = exports.maskArrays = exports.fromPlaceholder = exports.arraySource = 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.some.js");
+var _scanQuery = require("./scanQuery");
+/**
+ * Regex source matching one placeholder from maskStrings, with the hex-encoded value as its only group. The
+ * find* parsers use it where they would otherwise match a quoted string.
+ */
+const placeholderSource = exports.placeholderSource = '\\u0000([0-9a-f]*)\\u0000';
+const placeholderMatch = new RegExp(placeholderSource, 'g');
+/**
+ * Regex source matching one placeholder from maskArrays, with the hex-encoded JSON of the array as its only group.
+ * The find* parsers use it where they would otherwise match `[...]`.
+ */
+const arraySource = exports.arraySource = '\\u0001([0-9a-f]*)\\u0001';
+const arrayMatch = new RegExp(arraySource, 'g');
+/**
+ * Encode a value as hex, four digits per UTF-16 code unit: only 0-9 and a-f, so no keyword, quote, space or
+ * bracket a parser looks for can appear in it.
+ * @param value
+ */
+const toHex = value => value.split('').map(char => char.charCodeAt(0).toString(16).padStart(4, '0')).join('');
+/**
+ * Turn the hex of a placeholder back into the string's value.
+ * @param hex
+ */
+const fromPlaceholder = hex => (hex.match(/.{4}/g) || []).map(code => String.fromCharCode(parseInt(code, 16))).join('');
+/**
+ * Replace every quoted string in a query with a placeholder holding its value (with the escapes applied), so that
+ * nothing inside a string (a keyword, a quote, `and`, a `]`) can be matched by the find* parsers.
+ * @param query
+ * @throws {Error} For an unclosed string, comment or bracket, or a NUL or SOH character outside a string (which
+ * could otherwise pass for a placeholder).
+ */
+exports.fromPlaceholder = fromPlaceholder;
+const maskStrings = query => {
+  const {
+    strings
+  } = (0, _scanQuery.assertClosed)((0, _scanQuery.scanQuery)(query));
+  for (const [character, name] of [['\u0000', 'NUL'], ['\u0001', 'SOH']]) {
+    for (let index = query.indexOf(character); index !== -1; index = query.indexOf(character, index + 1)) {
+      if (!strings.some(({
+        start,
+        end
+      }) => start < index && index < end)) {
+        throw new Error(`Unexpected ${name} character at position ${index}`);
+      }
+    }
+  }
+  return strings.reduceRight((masked, {
+    start,
+    end,
+    value
+  }) => `${masked.slice(0, start)}\u0000${toHex(value)}\u0000${masked.slice(end)}`, query);
+};
+/**
+ * Put every placeholder back the way it would be written in a query: strings quoted, arrays as JSON. For error
+ * messages, and for reading an array's text as JSON.
+ * @param text
+ * @param quote - wrap strings with JSON's double quotes (the default) or with single quotes
+ */
+exports.maskStrings = maskStrings;
+const unmaskStrings = (text, quote = 'json') => text.replace(placeholderMatch, (placeholder, hex) => {
+  const value = fromPlaceholder(hex);
+  return quote === 'json' ? JSON.stringify(value) : `'${value.replace(/\\/g, '\\\\').replace(/'/g, '\\\'')}'`;
+}).replace(arrayMatch, (placeholder, hex) => fromPlaceholder(hex));
+/**
+ * Read one array's text (its strings already placeholders) as JSON, so it is checked once, here, with a clear error.
+ * @param text
+ */
+exports.unmaskStrings = unmaskStrings;
+const arrayJson = text => {
+  try {
+    // A number too big for a double reads as Infinity, which JSON would write back as null: refuse it instead
+    return JSON.stringify(JSON.parse(unmaskStrings(text), (key, value) => {
+      if (typeof value === 'number' && !Number.isFinite(value)) {
+        throw new Error(`${value} is too large`);
+      }
+      return value;
+    }));
+  } catch (e) {
+    throw new Error(`Invalid array ${unmaskStrings(text, '\'')}: ${e.message}`);
+  }
+};
+/**
+ * Replace every array (outermost brackets only, so a nested array stays inside its parent) with a placeholder holding
+ * its JSON, so that the find* parsers never have to find where an array ends, and nothing inside one (a `.`, a `]`,
+ * a keyword) can be matched by them. Run it on the output of maskStrings, where no `[` or `]` is inside a string.
+ * @param masked
+ * @throws {Error} For an array which is not valid JSON once its strings are put back.
+ */
+const maskArrays = masked => {
+  let result = '';
+  let depth = 0;
+  let start = 0;
+  for (let index = 0; index < masked.length; index++) {
+    const char = masked[index];
+    if (char === '[') {
+      if (depth === 0) {
+        start = index;
+      }
+      depth++;
+    } else if (char === ']' && depth > 0) {
+      depth--;
+      if (depth === 0) {
+        result += `\u0001${toHex(arrayJson(masked.slice(start, index + 1)))}\u0001`;
+        continue;
+      }
+    }
+    if (depth === 0) {
+      result += char;
+    }
+  }
+  return depth > 0 ? result + masked.slice(start) : result;
+};
+exports.maskArrays = maskArrays;

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.unmaskStrings=exports.placeholderSource=exports.maskStrings=exports.maskArrays=exports.fromPlaceholder=exports.arraySource=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.some.js");var _scanQuery=require("./scanQuery");const placeholderSource=exports.placeholderSource="\\u0000([0-9a-f]*)\\u0000",placeholderMatch=new RegExp(placeholderSource,"g"),arraySource=exports.arraySource="\\u0001([0-9a-f]*)\\u0001",arrayMatch=new RegExp(arraySource,"g"),toHex=r=>r.split("").map((r=>r.charCodeAt(0).toString(16).padStart(4,"0"))).join(""),fromPlaceholder=r=>(r.match(/.{4}/g)||[]).map((r=>String.fromCharCode(parseInt(r,16)))).join("");exports.fromPlaceholder=fromPlaceholder;const maskStrings=r=>{const{strings:e}=(0,_scanQuery.assertClosed)((0,_scanQuery.scanQuery)(r));for(const[s,o]of[["\0","NUL"],["
","SOH"]])for(let t=r.indexOf(s);-1!==t;t=r.indexOf(s,t+1))if(!e.some((({start:r,end:e})=>r<t&&t<e)))throw new Error(`Unexpected ${o} character at position ${t}`);return e.reduceRight(((r,{start:e,end:s,value:o})=>`${r.slice(0,e)}\0${toHex(o)}\0${r.slice(s)}`),r)};exports.maskStrings=maskStrings;const unmaskStrings=(r,e="json")=>r.replace(placeholderMatch,((r,s)=>{const o=fromPlaceholder(s);return"json"===e?JSON.stringify(o):`'${o.replace(/\\/g,"\\\\").replace(/'/g,"\\'")}'`})).replace(arrayMatch,((r,e)=>fromPlaceholder(e)));exports.unmaskStrings=unmaskStrings;const arrayJson=r=>{try{return JSON.stringify(JSON.parse(unmaskStrings(r),((r,e)=>{if("number"==typeof e&&!Number.isFinite(e))throw new Error(`${e} is too large`);return e})))}catch(e){throw new Error(`Invalid array ${unmaskStrings(r,"'")}: ${e.message}`)}},maskArrays=r=>{let e="",s=0,o=0;for(let t=0;t<r.length;t++){const a=r[t];if("["===a)0===s&&(o=t),s++;else if("]"===a&&s>0&&(s--,0===s)){e+=`
${toHex(arrayJson(r.slice(o,t+1)))}
`;continue}0===s&&(e+=a)}return s>0?e+r.slice(o):e};exports.maskArrays=maskArrays;

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

@@ -0,0 +1,20 @@
+import { fieldProperties } from '../../introspect/definitions/field';
+import { keyProperties } from '../../introspect/definitions/key';
+export type ParsedCreate = {
+    ifNotExists: boolean;
+    definition: fieldProperties[];
+    keys: keyProperties[];
+};
+export type ParsedCreateQuery = {
+    entity: string;
+    create: ParsedCreate;
+};
+export declare const createMatch: RegExp;
+/**
+ * Parse a create statement (strings and arrays already masked):
+ * `create [if not exists] <name> (<field>, ..., <key>, ...)`. See the README's "Creating a record". Only checks
+ * what the text alone can tell; the referenced records of foreign keys are checked when it runs.
+ * @param query
+ */
+export declare const parseCreate: (query: string) => ParsedCreateQuery;
+//# sourceMappingURL=parseCreate.d.ts.map