json-fs-query 3.2.0 → 3.3.1

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.assertKnownFields=exports.assertFieldsDefined=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.filter.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.flat-map.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.set.add-all.js"),require("core-js/modules/esnext.set.delete-all.js"),require("core-js/modules/esnext.set.difference.js"),require("core-js/modules/esnext.set.every.js"),require("core-js/modules/esnext.set.filter.js"),require("core-js/modules/esnext.set.find.js"),require("core-js/modules/esnext.set.intersection.js"),require("core-js/modules/esnext.set.is-disjoint-from.js"),require("core-js/modules/esnext.set.is-subset-of.js"),require("core-js/modules/esnext.set.is-superset-of.js"),require("core-js/modules/esnext.set.join.js"),require("core-js/modules/esnext.set.map.js"),require("core-js/modules/esnext.set.reduce.js"),require("core-js/modules/esnext.set.some.js"),require("core-js/modules/esnext.set.symmetric-difference.js"),require("core-js/modules/esnext.set.union.js");var _retrieveRecord=require("./retrieveRecord"),_isEntityProperty=require("./parsers/isEntityProperty"),_splitEntityProperty=require("./parsers/splitEntityProperty"),_conditionTree=require("./conditionTree");const fieldList=e=>e.definition.map((e=>e.name)).join(", "),assertFieldsDefined=(e,r,s,t)=>{const o=new Set(r.definition.map((e=>e.name))),i=s.find((e=>!o.has(e)));if(void 0!==i)throw new Error(`Unknown field "${i}" in ${t}: ${e} has ${fieldList(r)}`)};exports.assertFieldsDefined=assertFieldsDefined;const assertKnownFields=async(e,r)=>{const s=new Set((e.mergeJoins||[]).map((e=>(0,_splitEntityProperty.splitEntityProperty)(e.propertyB).entity))),t=[...(0,_conditionTree.conditionsOf)(e.where).map((e=>({property:e.property,clause:"where"}))),...(e.sortClauses||[]).map((e=>({property:e.property,clause:"sort"}))),...(e.groupBy||[]).map((e=>({property:e,clause:"group by"}))),...(e.selectClauses||[]).filter((r=>r.property!==e.joinEntity)).map((e=>({property:e.property,clause:"select"}))),...(e.insertValues||[]).flatMap((e=>Object.keys(e||{}).map((e=>({property:e,clause:"insert",own:!0}))))),...Object.keys(e.updateValues||{}).map((e=>({property:e,clause:"set",own:!0}))),...(e.joinClauses||[]).flatMap((e=>[{property:e.propertyA,clause:"on"},{property:e.propertyB,clause:"on"}])),...(e.mergeJoins||[]).flatMap((e=>[{property:e.propertyA,clause:"merge"},{property:e.propertyB,clause:"merge"}]))];for(const{property:o,clause:i,own:n}of t){if("string"!=typeof o)continue;let t=e.entity,p=o;if(!n&&(0,_isEntityProperty.isEntityProperty)(o)&&({entity:t,property:p}=(0,_splitEntityProperty.splitEntityProperty)(o)),"select"===i&&t!==e.entity&&!s.has(t))throw new Error(`Can't select "${o}": a joined record's rows are a list under its name (select ${t}), and its fields are on each row only when merged (merge ... with ${t}.<field>)`);Object.prototype.hasOwnProperty.call(r,t)||(r[t]=await(0,_retrieveRecord.retrieveRecord)(t)),assertFieldsDefined(t,r[t],[p],i)}};exports.assertKnownFields=assertKnownFields;

package/dist/data/utilities/packedTable.d.ts

@@ -0,0 +1,34 @@
+import { recordDefinition } from '../introspect/definitions/record';
+/**
+ * One record packed into one file by packDatabase: its entry files' names and rows, in the record's order, so a browser
+ * reads a whole record in one request instead of one per row. Indexes stay in their own (small) files: a lookup that
+ * needs a few rows reads the index and those rows, not the whole record.
+ */
+export type packedTable = {
+    entries: string[];
+    rows: any[];
+};
+/**
+ * Where a record's packed file lives, inside the database.
+ * @param recordPath
+ */
+export declare const packedPath: (recordPath: string) => string;
+/**
+ * Whether reads may use packed files: by default in a browser (where every file is a request) and not in Node (which
+ * reads the entry files, the copy that's edited, so a packed file can never hide a change there). See configure.
+ */
+export declare const usesPackedReads: () => boolean;
+/**
+ * A record's packed file, when reads may use packed files (see usesPackedReads) and the record has one that matches it:
+ * the same entries in the same order as the record file. Anything else (no packed file, one that can't be read, or one
+ * packed before entries were added or removed) gives undefined, and the caller reads the entry files as before.
+ * @param record
+ */
+export declare const retrievePacked: (record: recordDefinition) => Promise<packedTable | undefined>;
+/**
+ * Remove a record's packed file, if it has one, as part of a statement that changes the record's rows: a packed file
+ * is a copy of them, and one left behind after a change would be read in a browser in place of the change.
+ * @param recordPath
+ */
+export declare const discardPacked: (recordPath: string) => Promise<void>;
+//# sourceMappingURL=packedTable.d.ts.map

package/dist/data/utilities/packedTable.js

@@ -0,0 +1,60 @@
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.usesPackedReads = exports.retrievePacked = exports.packedPath = exports.discardPacked = void 0;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.some.js");
+var jsEnv = _interopRequireWildcard(require("browser-or-node"));
+var _storage = require("../storage");
+var _config = require("./config");
+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; }
+/**
+ * Where a record's packed file lives, inside the database.
+ * @param recordPath
+ */
+const packedPath = recordPath => `__packed/${recordPath}.json`;
+/**
+ * Whether reads may use packed files: by default in a browser (where every file is a request) and not in Node (which
+ * reads the entry files, the copy that's edited, so a packed file can never hide a change there). See configure.
+ */
+exports.packedPath = packedPath;
+const usesPackedReads = () => (0, _config.getSetting)('packedReads', !jsEnv.isNode);
+/**
+ * A record's packed file, when reads may use packed files (see usesPackedReads) and the record has one that matches it:
+ * the same entries in the same order as the record file. Anything else (no packed file, one that can't be read, or one
+ * packed before entries were added or removed) gives undefined, and the caller reads the entry files as before.
+ * @param record
+ */
+exports.usesPackedReads = usesPackedReads;
+const retrievePacked = async record => {
+  if (!usesPackedReads()) {
+    return undefined;
+  }
+  let packed;
+  try {
+    packed = await (0, _storage.readJson)(packedPath(record.path));
+  } catch (error) {
+    return undefined;
+  }
+  const entries = record.entries || [];
+  if (!packed || !Array.isArray(packed.entries) || !Array.isArray(packed.rows) || packed.entries.length !== entries.length || packed.rows.length !== entries.length || packed.entries.some((entry, position) => entry !== entries[position])) {
+    return undefined;
+  }
+  return packed;
+};
+/**
+ * Remove a record's packed file, if it has one, as part of a statement that changes the record's rows: a packed file
+ * is a copy of them, and one left behind after a change would be read in a browser in place of the change.
+ * @param recordPath
+ */
+exports.retrievePacked = retrievePacked;
+const discardPacked = async recordPath => {
+  if ((0, _storage.fileExists)(packedPath(recordPath))) {
+    await (0, _storage.removeFile)(packedPath(recordPath));
+  }
+};
+exports.discardPacked = discardPacked;

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

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.usesPackedReads=exports.retrievePacked=exports.packedPath=exports.discardPacked=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.some.js");var e,jsEnv=_interopRequireWildcard(require("browser-or-node")),_storage=require("../storage"),_config=require("./config");function _interopRequireWildcard(r,t){if(!t&&r&&r.__esModule)return r;var s,a,o=Object.defineProperty,d={__proto__:null,default:r};if(Object(r)!==r)return d;if(e||"function"!=typeof WeakMap||(e=new WeakMap),e){if(e.has(r))return e.get(r);e.set(r,d)}for(a in r)"default"!==a&&{}.hasOwnProperty.call(r,a)&&((s=o&&Object.getOwnPropertyDescriptor(r,a))&&(s.get||s.set)?o(d,a,s):d[a]=r[a]);return d}const packedPath=e=>`__packed/${e}.json`;exports.packedPath=packedPath;const usesPackedReads=()=>(0,_config.getSetting)("packedReads",!jsEnv.isNode);exports.usesPackedReads=usesPackedReads;const retrievePacked=async e=>{if(!usesPackedReads())return;let r;try{r=await(0,_storage.readJson)(packedPath(e.path))}catch(e){return}const t=e.entries||[];return r&&Array.isArray(r.entries)&&Array.isArray(r.rows)&&r.entries.length===t.length&&r.rows.length===t.length&&!r.entries.some(((e,r)=>e!==t[r]))?r:void 0};exports.retrievePacked=retrievePacked;const discardPacked=async e=>{(0,_storage.fileExists)(packedPath(e))&&await(0,_storage.removeFile)(packedPath(e))};exports.discardPacked=discardPacked;

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

@@ -3,9 +3,9 @@ export type ParsedInsertRow = {
     [field: string]: any;
 };
 /**
- * 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.
+ * Read an insert's values clause body (see splitClauses), the same way findUpdateValues() does for "set": one row
+ * (`field = value, field2 = value2`), or several, each in brackets and separated by commas
+ * (`(field = value, field2 = value2), (field = value3, field2 = value4)`), inserted together in one statement.
  * @param parsed
  * @param body
  * @returns The rest of the body, after the last assignment.

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

@@ -7,29 +7,45 @@ exports.findInsertValues = void 0;
 var _parseLiteralValue = require("./parseLiteralValue");
 var _maskStrings = require("./maskStrings");
 const literal = `(?:${_maskStrings.placeholderSource.replace('(', '(?:')}|${_parseLiteralValue.numberSource}|${_maskStrings.arraySource.replace('(', '(?:')}|null|true|false)`;
-const valuesMatch = new RegExp(`^([a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*)`, 'i');
+const assignments = `[a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*`;
+const valuesMatch = new RegExp(`^(${assignments})`, 'i');
+const rowSource = `\\(\\s*(${assignments})\\s*\\)`;
+const rowsMatch = new RegExp(`^${rowSource}(?:\\s*,\\s*${rowSource.replace('(' + assignments, '(?:' + assignments)})*`, 'i');
+const rowMatch = new RegExp(rowSource, 'ig');
 const assignmentMatch = new RegExp(`([a-z0-9_-]+)\\s*=\\s*(${_maskStrings.placeholderSource}|(${_parseLiteralValue.numberSource})|${_maskStrings.arraySource}|(null)|(true)|(false))`, 'ig');
 /**
- * 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.
+ * One row's values from its assignments (`field = value, field2 = value2`).
+ * @param assignments
+ */
+const parseRow = assignments => {
+  const row = {};
+  // @ts-ignore
+  for (const assignment of assignments.matchAll(assignmentMatch)) {
+    row[assignment[1]] = (0, _parseLiteralValue.parseLiteralValue)(assignment, 3);
+  }
+  return row;
+};
+/**
+ * Read an insert's values clause body (see splitClauses), the same way findUpdateValues() does for "set": one row
+ * (`field = value, field2 = value2`), or several, each in brackets and separated by commas
+ * (`(field = value, field2 = value2), (field = value3, field2 = value4)`), inserted together in one statement.
  * @param parsed
  * @param body
  * @returns The rest of the body, after the last assignment.
  */
 const findInsertValues = (parsed, body) => {
-  const clauseFound = body.match(valuesMatch);
   parsed['insertValues'] = [];
+  const rowsFound = body.match(rowsMatch);
+  if (rowsFound) {
+    // @ts-ignore
+    parsed['insertValues'] = [...rowsFound[0].matchAll(rowMatch)].map(row => parseRow(row[1]));
+    return body.slice(rowsFound[0].length).trim();
+  }
+  const clauseFound = body.match(valuesMatch);
   if (!clauseFound) {
     return body;
   }
-  const row = {};
-  const assignmentsFound = clauseFound[1].matchAll(assignmentMatch);
-  // @ts-ignore
-  for (const assignment of assignmentsFound) {
-    row[assignment[1]] = (0, _parseLiteralValue.parseLiteralValue)(assignment, 3);
-  }
-  parsed['insertValues'] = [row];
+  parsed['insertValues'] = [parseRow(clauseFound[1])];
   return body.slice(clauseFound[0].length).trim();
 };
 exports.findInsertValues = findInsertValues;

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findInsertValues=void 0;var _parseLiteralValue=require("./parseLiteralValue"),_maskStrings=require("./maskStrings");const literal=`(?:${_maskStrings.placeholderSource.replace("(","(?:")}|${_parseLiteralValue.numberSource}|${_maskStrings.arraySource.replace("(","(?:")}|null|true|false)`,valuesMatch=new RegExp(`^([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}|(${_parseLiteralValue.numberSource})|${_maskStrings.arraySource}|(null)|(true)|(false))`,"ig"),findInsertValues=(e,r)=>{const a=r.match(valuesMatch);if(e.insertValues=[],!a)return r;const s={},t=a[1].matchAll(assignmentMatch);for(const e of t)s[e[1]]=(0,_parseLiteralValue.parseLiteralValue)(e,3);return e.insertValues=[s],r.slice(a[0].length).trim()};exports.findInsertValues=findInsertValues;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.findInsertValues=void 0;var _parseLiteralValue=require("./parseLiteralValue"),_maskStrings=require("./maskStrings");const literal=`(?:${_maskStrings.placeholderSource.replace("(","(?:")}|${_parseLiteralValue.numberSource}|${_maskStrings.arraySource.replace("(","(?:")}|null|true|false)`,assignments=`[a-z0-9_-]+\\s*=\\s*${literal}(?:\\s*,\\s*[a-z0-9_-]+\\s*=\\s*${literal})*`,valuesMatch=new RegExp(`^(${assignments})`,"i"),rowSource=`\\(\\s*(${assignments})\\s*\\)`,rowsMatch=new RegExp(`^${rowSource}(?:\\s*,\\s*${rowSource.replace("("+assignments,"(?:"+assignments)})*`,"i"),rowMatch=new RegExp(rowSource,"ig"),assignmentMatch=new RegExp(`([a-z0-9_-]+)\\s*=\\s*(${_maskStrings.placeholderSource}|(${_parseLiteralValue.numberSource})|${_maskStrings.arraySource}|(null)|(true)|(false))`,"ig"),parseRow=e=>{const s={};for(const r of e.matchAll(assignmentMatch))s[r[1]]=(0,_parseLiteralValue.parseLiteralValue)(r,3);return s},findInsertValues=(e,s)=>{e.insertValues=[];const r=s.match(rowsMatch);if(r)return e.insertValues=[...r[0].matchAll(rowMatch)].map((e=>parseRow(e[1]))),s.slice(r[0].length).trim();const a=s.match(valuesMatch);return a?(e.insertValues=[parseRow(a[1])],s.slice(a[0].length).trim()):s};exports.findInsertValues=findInsertValues;

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

@@ -54,11 +54,20 @@ const maskStrings = query => {
       }
     }
   }
-  return strings.reduceRight((masked, {
+  // One pass from the left (the strings come in order, without overlapping): rebuilding the whole query for each string
+  // made a long query (an insert of thousands of rows) take time growing with the square of its length
+  const parts = [];
+  let copied = 0;
+  for (const {
     start,
     end,
     value
-  }) => `${masked.slice(0, start)}\u0000${toHex(value)}\u0000${masked.slice(end)}`, query);
+  } of strings) {
+    parts.push(query.slice(copied, start), `\u0000${toHex(value)}\u0000`);
+    copied = end;
+  }
+  parts.push(query.slice(copied));
+  return parts.join('');
 };
 /**
  * Put every placeholder back the way it would be written in a query: strings quoted, arrays as JSON. For error

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

@@ -1 +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,t]of[["\0","NUL"],["
","SOH"]])for(let o=r.indexOf(s);-1!==o;o=r.indexOf(s,o+1))if(!e.some((({start:r,end:e})=>r<o&&o<e)))throw new Error(`Unexpected ${t} character at position ${o}`);return e.reduceRight(((r,{start:e,end:s,value:t})=>`${r.slice(0,e)}\0${toHex(t)}\0${r.slice(s)}`),r)};exports.maskStrings=maskStrings;const unmaskStrings=(r,e="json")=>r.replace(placeholderMatch,((r,s)=>{const t=fromPlaceholder(s);return"json"===e?JSON.stringify(t):`'${t.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`);if(Number.isInteger(e)&&!Number.isSafeInteger(e))throw new Error(`${e} is too large to store exactly (the largest whole number is ${Number.MAX_SAFE_INTEGER}): quote it to keep it as text`);return e})))}catch(e){throw new Error(`Invalid array ${unmaskStrings(r,"'")}: ${e.message}`)}},maskArrays=r=>{let e="",s=0,t=0;for(let o=0;o<r.length;o++){const a=r[o];if("["===a)0===s&&(t=o),s++;else if("]"===a&&s>0&&(s--,0===s)){e+=`
${toHex(arrayJson(r.slice(t,o+1)))}
`;continue}0===s&&(e+=a)}return s>0?e+r.slice(t):e};exports.maskArrays=maskArrays;
+"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,t]of[["\0","NUL"],["
","SOH"]])for(let o=r.indexOf(s);-1!==o;o=r.indexOf(s,o+1))if(!e.some((({start:r,end:e})=>r<o&&o<e)))throw new Error(`Unexpected ${t} character at position ${o}`);const s=[];let t=0;for(const{start:o,end:a,value:n}of e)s.push(r.slice(t,o),`\0${toHex(n)}\0`),t=a;return s.push(r.slice(t)),s.join("")};exports.maskStrings=maskStrings;const unmaskStrings=(r,e="json")=>r.replace(placeholderMatch,((r,s)=>{const t=fromPlaceholder(s);return"json"===e?JSON.stringify(t):`'${t.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`);if(Number.isInteger(e)&&!Number.isSafeInteger(e))throw new Error(`${e} is too large to store exactly (the largest whole number is ${Number.MAX_SAFE_INTEGER}): quote it to keep it as text`);return e})))}catch(e){throw new Error(`Invalid array ${unmaskStrings(r,"'")}: ${e.message}`)}},maskArrays=r=>{let e="",s=0,t=0;for(let o=0;o<r.length;o++){const a=r[o];if("["===a)0===s&&(t=o),s++;else if("]"===a&&s>0&&(s--,0===s)){e+=`
${toHex(arrayJson(r.slice(t,o+1)))}
`;continue}0===s&&(e+=a)}return s>0?e+r.slice(t):e};exports.maskArrays=maskArrays;

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

@@ -0,0 +1,33 @@
+import { fieldProperties } from '../../introspect/definitions/field';
+/**
+ * One change to a record's fields (see alter):
+ * - `add`: a new field, as create defines one
+ * - `drop`: remove a field
+ * - `rename`: give a field a new name
+ * - `modify`: a field's new definition (the same name and type; optional, null and default can change)
+ */
+export type ParsedAlter = {
+    action: 'add';
+    field: fieldProperties;
+} | {
+    action: 'drop';
+    name: string;
+} | {
+    action: 'rename';
+    name: string;
+    to: string;
+} | {
+    action: 'modify';
+    field: fieldProperties;
+};
+export type ParsedAlterQuery = {
+    entity: string;
+    alter: ParsedAlter;
+};
+export declare const alterMatch: RegExp;
+/**
+ * Read an alter statement (one change per statement; several statements in one query run in turn).
+ * @param query - The statement, with its strings and arrays masked (see maskStrings).
+ */
+export declare const parseAlter: (query: string) => ParsedAlterQuery;
+//# sourceMappingURL=parseAlter.d.ts.map

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

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseAlter = exports.alterMatch = void 0;
+var _parseCreate = require("./parseCreate");
+var _maskStrings = require("./maskStrings");
+var _startsQuery = require("./startsQuery");
+const alterMatch = exports.alterMatch = /^\s*alter(?![a-z0-9_-])/i;
+const headMatch = new RegExp(`^\\s*alter\\s+(${_parseCreate.nameSource})\\s+(add|drop|rename|modify)(?![a-z0-9_-])([\\s\\S]*)$`, 'i');
+const renameMatch = new RegExp(`^\\s*(${_parseCreate.nameSource})\\s+to\\s+(${_parseCreate.nameSource})\\s*$`, 'i');
+const expected = 'Expected: alter <record> add <field> <type> ..., drop <field>, rename <field> to <name>, or modify <field> <type> ...';
+const shown = text => (0, _maskStrings.unmaskStrings)(text.trim(), '\'');
+/**
+ * A field as create's field list writes one (`<name> <type> [optional] [null | not null] [default <value>] [auto]`).
+ * @param text
+ */
+const fieldSpec = text => {
+  const found = text.trim().match(_parseCreate.fieldMatch);
+  if (!found) {
+    throw new Error(`Expected a field (<name> <type> ...) in: ${shown(text)}`);
+  }
+  return (0, _parseCreate.parseField)(found);
+};
+/**
+ * Read an alter statement (one change per statement; several statements in one query run in turn).
+ * @param query - The statement, with its strings and arrays masked (see maskStrings).
+ */
+const parseAlter = query => {
+  const head = query.match(headMatch);
+  if (!head) {
+    throw new Error(expected);
+  }
+  const [, entity, actionWord, rest] = head;
+  if (entity === '__RECORDS') {
+    throw new Error('__RECORDS is reserved for the list of records');
+  }
+  const action = actionWord.toLowerCase();
+  if (_startsQuery.startsQueryMatch.test(rest.trim()) && !/^\s*(add|drop|rename|modify)\b/i.test(rest)) {
+    throw new Error(`Missing ; before: ${shown(rest)}`);
+  }
+  switch (action) {
+    case 'add':
+    case 'modify':
+      return {
+        entity,
+        alter: {
+          action,
+          field: fieldSpec(rest)
+        }
+      };
+    case 'drop':
+      {
+        const name = rest.trim();
+        if (!_parseCreate.nameMatch.test(name)) {
+          throw new Error(`Expected: alter ${entity} drop <field>${name ? ` (got: ${shown(name)})` : ''}`);
+        }
+        return {
+          entity,
+          alter: {
+            action,
+            name
+          }
+        };
+      }
+    default:
+      {
+        const found = rest.match(renameMatch);
+        if (!found) {
+          throw new Error(`Expected: alter ${entity} rename <field> to <name>${rest.trim() ? ` (got: ${shown(rest)})` : ''}`);
+        }
+        return {
+          entity,
+          alter: {
+            action: 'rename',
+            name: found[1],
+            to: found[2]
+          }
+        };
+      }
+  }
+};
+exports.parseAlter = parseAlter;

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parseAlter=exports.alterMatch=void 0;var _parseCreate=require("./parseCreate"),_maskStrings=require("./maskStrings"),_startsQuery=require("./startsQuery");const alterMatch=exports.alterMatch=/^\s*alter(?![a-z0-9_-])/i,headMatch=new RegExp(`^\\s*alter\\s+(${_parseCreate.nameSource})\\s+(add|drop|rename|modify)(?![a-z0-9_-])([\\s\\S]*)$`,"i"),renameMatch=new RegExp(`^\\s*(${_parseCreate.nameSource})\\s+to\\s+(${_parseCreate.nameSource})\\s*$`,"i"),expected="Expected: alter <record> add <field> <type> ..., drop <field>, rename <field> to <name>, or modify <field> <type> ...",shown=e=>(0,_maskStrings.unmaskStrings)(e.trim(),"'"),fieldSpec=e=>{const r=e.trim().match(_parseCreate.fieldMatch);if(!r)throw new Error(`Expected a field (<name> <type> ...) in: ${shown(e)}`);return(0,_parseCreate.parseField)(r)},parseAlter=e=>{const r=e.match(headMatch);if(!r)throw new Error(expected);const[,t,a,s]=r;if("__RECORDS"===t)throw new Error("__RECORDS is reserved for the list of records");const o=a.toLowerCase();if(_startsQuery.startsQueryMatch.test(s.trim())&&!/^\s*(add|drop|rename|modify)\b/i.test(s))throw new Error(`Missing ; before: ${shown(s)}`);switch(o){case"add":case"modify":return{entity:t,alter:{action:o,field:fieldSpec(s)}};case"drop":{const e=s.trim();if(!_parseCreate.nameMatch.test(e))throw new Error(`Expected: alter ${t} drop <field>${e?` (got: ${shown(e)})`:""}`);return{entity:t,alter:{action:o,name:e}}}default:{const e=s.match(renameMatch);if(!e)throw new Error(`Expected: alter ${t} rename <field> to <name>${s.trim()?` (got: ${shown(s)})`:""}`);return{entity:t,alter:{action:"rename",name:e[1],to:e[2]}}}}};exports.parseAlter=parseAlter;

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

@@ -10,6 +10,20 @@ export type ParsedCreateQuery = {
     create: ParsedCreate;
 };
 export declare const createMatch: RegExp;
+export declare const nameSource = "[a-z0-9_-]+";
+export declare const nameMatch: RegExp;
+export declare const fieldMatch: RegExp;
+/**
+ * The index file name a key's index lives in, from its type and fields (as create names it).
+ * @param type
+ * @param fields
+ */
+export declare const keyLookup: (type: string, fields: string[]) => string;
+/**
+ * One field: `<name> <type> [optional] [null | not null] [auto] [default <value>]`, the modifiers in any order.
+ * @param found - The field's fieldMatch match.
+ */
+export declare const parseField: (found: RegExpMatchArray) => fieldProperties;
 /**
  * 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

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.parseCreate = exports.createMatch = void 0;
+exports.parseField = exports.parseCreate = exports.nameSource = exports.nameMatch = exports.keyLookup = exports.fieldMatch = exports.createMatch = void 0;
 require("core-js/modules/es.array.includes.js");
 require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.filter.js");
@@ -32,10 +32,10 @@ var _parseLiteralValue = require("./parseLiteralValue");
 var _startsQuery = require("./startsQuery");
 const createMatch = exports.createMatch = /^\s*create(?![a-z0-9_-])/i;
 const headMatch = /^\s*create\s+(if\s+not\s+exists\s+)?([a-z0-9_-]+)\s*\(/i;
-const nameSource = '[a-z0-9_-]+';
-const nameMatch = new RegExp(`^${nameSource}$`, 'i');
+const nameSource = exports.nameSource = '[a-z0-9_-]+';
+const nameMatch = exports.nameMatch = new RegExp(`^${nameSource}$`, 'i');
 const numberMatch = new RegExp(`^${_parseLiteralValue.numberSource}$`, 'i');
-const fieldMatch = new RegExp(`^(${nameSource})\\s+(${nameSource})((?:\\s[\\s\\S]*)?)$`, 'i');
+const fieldMatch = exports.fieldMatch = new RegExp(`^(${nameSource})\\s+(${nameSource})((?:\\s[\\s\\S]*)?)$`, 'i');
 const primaryMatch = /^primary\s+key\s*\(([^()]*)\)$/i;
 const uniqueMatch = /^unique\s*\(([^()]*)\)$/i;
 const indexMatch = /^index\s*\(([^()]*)\)$/i;
@@ -48,10 +48,17 @@ const lookupPrefix = {
   index: 'index',
   foreign: 'fk'
 };
+/**
+ * The index file name a key's index lives in, from its type and fields (as create names it).
+ * @param type
+ * @param fields
+ */
+const keyLookup = (type, fields) => `${lookupPrefix[type]}_${fields.join('_')}.json`;
 /**
  * Show a piece of the (masked) query the way it was written, for an error message.
  * @param text
  */
+exports.keyLookup = keyLookup;
 const shown = text => (0, _maskStrings.unmaskStrings)(text.trim(), '\'');
 /**
  * The position of the `)` closing the `(` at `open`, or -1. Strings and arrays are placeholders by now, so round
@@ -197,6 +204,7 @@ const parseField = found => {
  * One key, or null when the item isn't written as a key (so it's a field).
  * @param item
  */
+exports.parseField = parseField;
 const parseKey = item => {
   let found = item.match(primaryMatch);
   if (found) {
@@ -254,7 +262,7 @@ const finishKeys = (definition, keys) => {
     if (missing) {
       throw new Error(`The ${key.type} key (${key.fields.join(', ')}) names "${missing}", which is not a field`);
     }
-    const lookup = `${lookupPrefix[key.type]}_${key.fields.join('_')}.json`;
+    const lookup = keyLookup(key.type, key.fields);
     if (lookups.has(lookup)) {
       throw new Error(`The same ${key.type} key on "${key.fields.join(', ')}" is given twice`);
     }

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parseCreate=exports.createMatch=void 0,require("core-js/modules/es.array.includes.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.filter.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.some.js"),require("core-js/modules/esnext.set.add-all.js"),require("core-js/modules/esnext.set.delete-all.js"),require("core-js/modules/esnext.set.difference.js"),require("core-js/modules/esnext.set.every.js"),require("core-js/modules/esnext.set.filter.js"),require("core-js/modules/esnext.set.find.js"),require("core-js/modules/esnext.set.intersection.js"),require("core-js/modules/esnext.set.is-disjoint-from.js"),require("core-js/modules/esnext.set.is-subset-of.js"),require("core-js/modules/esnext.set.is-superset-of.js"),require("core-js/modules/esnext.set.join.js"),require("core-js/modules/esnext.set.map.js"),require("core-js/modules/esnext.set.reduce.js"),require("core-js/modules/esnext.set.some.js"),require("core-js/modules/esnext.set.symmetric-difference.js"),require("core-js/modules/esnext.set.union.js");var _typeCheck=require("../../introspect/policies/typeCheck"),_maskStrings=require("./maskStrings"),_parseLiteralValue=require("./parseLiteralValue"),_startsQuery=require("./startsQuery");const createMatch=exports.createMatch=/^\s*create(?![a-z0-9_-])/i,headMatch=/^\s*create\s+(if\s+not\s+exists\s+)?([a-z0-9_-]+)\s*\(/i,nameSource="[a-z0-9_-]+",nameMatch=new RegExp(`^${nameSource}$`,"i"),numberMatch=new RegExp(`^${_parseLiteralValue.numberSource}$`,"i"),fieldMatch=new RegExp(`^(${nameSource})\\s+(${nameSource})((?:\\s[\\s\\S]*)?)$`,"i"),primaryMatch=/^primary\s+key\s*\(([^()]*)\)$/i,uniqueMatch=/^unique\s*\(([^()]*)\)$/i,indexMatch=/^index\s*\(([^()]*)\)$/i,foreignMatch=new RegExp(`^foreign\\s+key\\s*\\(([^()]*)\\)\\s*references\\s+(${nameSource})\\s*\\(([^()]*)\\)$`,"i"),stringLiteral=new RegExp(`^${_maskStrings.placeholderSource}$`),arrayLiteral=new RegExp(`^${_maskStrings.arraySource}$`),lookupPrefix={primary:"pk",unique:"unique",index:"index",foreign:"fk"},shown=e=>(0,_maskStrings.unmaskStrings)(e.trim(),"'"),findClose=(e,r)=>{let s=0;for(let t=r;t<e.length;t++)if("("===e[t])s++;else if(")"===e[t]&&(s--,0===s))return t;return-1},splitItems=e=>{const r=[];let s=0,t=0;for(let i=0;i<e.length;i++)"("===e[i]?s++:")"===e[i]?s--:","===e[i]&&0===s&&(r.push(e.slice(t,i)),t=i+1);return r.push(e.slice(t)),r.map((e=>e.trim()))},parseNames=(e,r)=>{const s=e.split(",").map((e=>e.trim()));if(s.some((e=>!nameMatch.test(e))))throw new Error(`Expected field names separated by commas in: ${shown(r)}`);if(new Set(s).size!==s.length)throw new Error(`The same field is named twice in: ${shown(r)}`);return s},parseDefault=e=>{if(void 0===e)throw new Error("Missing a value after default");const r=e.match(stringLiteral);if(r)return(0,_maskStrings.fromPlaceholder)(r[1]);const s=e.match(arrayLiteral);if(s)return JSON.parse((0,_maskStrings.fromPlaceholder)(s[1]));if(numberMatch.test(e))return(0,_parseLiteralValue.parseNumber)(e);switch(e.toLowerCase()){case"null":return null;case"true":return!0;case"false":return!1}throw new Error(`Unrecognized default value: ${shown(e)}`)},parseField=e=>{const[r,s,t,i]=e,n=t.toLowerCase();if(!_typeCheck.fieldTypes.includes(n))throw new Error(`Unknown type "${t}" for field "${s}" (expected ${_typeCheck.fieldTypes.join(", ")})`);const o={name:s,type:n,optional:!1,autoGenerate:!1},a=new Set,l=e=>{if(a.has(e))throw new Error(`"${e}" is given twice for field "${s}"`);a.add(e)},u=""===i.trim()?[]:i.trim().split(/\s+/);for(let e=0;e<u.length;e++){const t=u[e].toLowerCase();if("optional"===t)l("optional"),o.optional=!0;else if("auto"===t)l("auto"),o.autoGenerate=!0;else if("null"===t)l("null"),o.nullable=!0;else if("not"===t&&"null"===(u[e+1]||"").toLowerCase())l("null"),o.nullable=!1,e++;else{if("default"!==t)throw new Error(`Unrecognized "${shown(u[e])}" for field "${s}" in: ${shown(r)}`);l("default"),o.useDefault=!0,o.defaultValue=parseDefault(u[++e])}}if(o.autoGenerate&&o.useDefault)throw new Error(`Field "${s}" can't be both auto and have a default`);if(o.autoGenerate&&"string"!==n)throw new Error(`Field "${s}" is auto, which generates a UUID, so its type must be string`);return o},parseKey=e=>{let r=e.match(primaryMatch);if(r)return{type:"primary",fields:parseNames(r[1],e)};if(r=e.match(uniqueMatch),r)return{type:"unique",fields:parseNames(r[1],e)};if(r=e.match(indexMatch),r)return{type:"index",fields:parseNames(r[1],e)};if(r=e.match(foreignMatch),r){const s=parseNames(r[1],e),t=parseNames(r[3],e);if(1!==s.length||1!==t.length)throw new Error(`Only single-field foreign keys are supported so far: ${shown(e)}`);return{type:"foreign",fields:s,references:[{fields:[`${r[2]}.${t[0]}`],lookup:`${r[2]}.json`}]}}return null},finishKeys=(e,r)=>{const s=e.map((e=>e.name));if(r.filter((e=>"primary"===e.type)).length>1)throw new Error("Only one primary key is allowed");const t=new Set;return r.map((e=>{const r=e.fields.find((e=>!s.includes(e)));if(r)throw new Error(`The ${e.type} key (${e.fields.join(", ")}) names "${r}", which is not a field`);const i=`${lookupPrefix[e.type]}_${e.fields.join("_")}.json`;if(t.has(i))throw new Error(`The same ${e.type} key on "${e.fields.join(", ")}" is given twice`);return t.add(i),Object.assign({type:e.type,fields:e.fields,lookup:i},e.references?{references:e.references}:{})}))},parseCreate=e=>{const r=e.match(headMatch);if(!r)throw new Error("Expected: create [if not exists] <name> (<fields and keys>)");const s=r[2];if("__RECORDS"===s)throw new Error("__RECORDS is reserved for the list of records");const t=r[0].length-1,i=findClose(e,t);if(-1===i)throw new Error("Missing ) at the end of the field list");const n=e.slice(i+1).trim();if(n){if(_startsQuery.startsQueryMatch.test(n))throw new Error(`Missing ; before: ${shown(n)}`);throw new Error(`Unrecognized query value: ${shown(n)}`)}const o=e.slice(t+1,i),a=[],l=[];if(o.trim())for(const e of splitItems(o)){if(!e)throw new Error("Empty item in the field list (an extra comma?)");const r=parseKey(e);if(r){l.push(r);continue}const s=e.match(fieldMatch);if(!s)throw new Error(`Expected a field (<name> <type> ...) or a key in: ${shown(e)}`);const t=parseField(s);if(a.some((e=>e.name===t.name)))throw new Error(`Field "${t.name}" is given twice`);a.push(t)}return{entity:s,create:{ifNotExists:Boolean(r[1]),definition:a,keys:finishKeys(a,l)}}};exports.parseCreate=parseCreate;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parseField=exports.parseCreate=exports.nameSource=exports.nameMatch=exports.keyLookup=exports.fieldMatch=exports.createMatch=void 0,require("core-js/modules/es.array.includes.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.filter.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.some.js"),require("core-js/modules/esnext.set.add-all.js"),require("core-js/modules/esnext.set.delete-all.js"),require("core-js/modules/esnext.set.difference.js"),require("core-js/modules/esnext.set.every.js"),require("core-js/modules/esnext.set.filter.js"),require("core-js/modules/esnext.set.find.js"),require("core-js/modules/esnext.set.intersection.js"),require("core-js/modules/esnext.set.is-disjoint-from.js"),require("core-js/modules/esnext.set.is-subset-of.js"),require("core-js/modules/esnext.set.is-superset-of.js"),require("core-js/modules/esnext.set.join.js"),require("core-js/modules/esnext.set.map.js"),require("core-js/modules/esnext.set.reduce.js"),require("core-js/modules/esnext.set.some.js"),require("core-js/modules/esnext.set.symmetric-difference.js"),require("core-js/modules/esnext.set.union.js");var _typeCheck=require("../../introspect/policies/typeCheck"),_maskStrings=require("./maskStrings"),_parseLiteralValue=require("./parseLiteralValue"),_startsQuery=require("./startsQuery");const createMatch=exports.createMatch=/^\s*create(?![a-z0-9_-])/i,headMatch=/^\s*create\s+(if\s+not\s+exists\s+)?([a-z0-9_-]+)\s*\(/i,nameSource=exports.nameSource="[a-z0-9_-]+",nameMatch=exports.nameMatch=new RegExp(`^${nameSource}$`,"i"),numberMatch=new RegExp(`^${_parseLiteralValue.numberSource}$`,"i"),fieldMatch=exports.fieldMatch=new RegExp(`^(${nameSource})\\s+(${nameSource})((?:\\s[\\s\\S]*)?)$`,"i"),primaryMatch=/^primary\s+key\s*\(([^()]*)\)$/i,uniqueMatch=/^unique\s*\(([^()]*)\)$/i,indexMatch=/^index\s*\(([^()]*)\)$/i,foreignMatch=new RegExp(`^foreign\\s+key\\s*\\(([^()]*)\\)\\s*references\\s+(${nameSource})\\s*\\(([^()]*)\\)$`,"i"),stringLiteral=new RegExp(`^${_maskStrings.placeholderSource}$`),arrayLiteral=new RegExp(`^${_maskStrings.arraySource}$`),lookupPrefix={primary:"pk",unique:"unique",index:"index",foreign:"fk"},keyLookup=(e,r)=>`${lookupPrefix[e]}_${r.join("_")}.json`;exports.keyLookup=keyLookup;const shown=e=>(0,_maskStrings.unmaskStrings)(e.trim(),"'"),findClose=(e,r)=>{let s=0;for(let t=r;t<e.length;t++)if("("===e[t])s++;else if(")"===e[t]&&(s--,0===s))return t;return-1},splitItems=e=>{const r=[];let s=0,t=0;for(let i=0;i<e.length;i++)"("===e[i]?s++:")"===e[i]?s--:","===e[i]&&0===s&&(r.push(e.slice(t,i)),t=i+1);return r.push(e.slice(t)),r.map((e=>e.trim()))},parseNames=(e,r)=>{const s=e.split(",").map((e=>e.trim()));if(s.some((e=>!nameMatch.test(e))))throw new Error(`Expected field names separated by commas in: ${shown(r)}`);if(new Set(s).size!==s.length)throw new Error(`The same field is named twice in: ${shown(r)}`);return s},parseDefault=e=>{if(void 0===e)throw new Error("Missing a value after default");const r=e.match(stringLiteral);if(r)return(0,_maskStrings.fromPlaceholder)(r[1]);const s=e.match(arrayLiteral);if(s)return JSON.parse((0,_maskStrings.fromPlaceholder)(s[1]));if(numberMatch.test(e))return(0,_parseLiteralValue.parseNumber)(e);switch(e.toLowerCase()){case"null":return null;case"true":return!0;case"false":return!1}throw new Error(`Unrecognized default value: ${shown(e)}`)},parseField=e=>{const[r,s,t,i]=e,o=t.toLowerCase();if(!_typeCheck.fieldTypes.includes(o))throw new Error(`Unknown type "${t}" for field "${s}" (expected ${_typeCheck.fieldTypes.join(", ")})`);const n={name:s,type:o,optional:!1,autoGenerate:!1},a=new Set,l=e=>{if(a.has(e))throw new Error(`"${e}" is given twice for field "${s}"`);a.add(e)},u=""===i.trim()?[]:i.trim().split(/\s+/);for(let e=0;e<u.length;e++){const t=u[e].toLowerCase();if("optional"===t)l("optional"),n.optional=!0;else if("auto"===t)l("auto"),n.autoGenerate=!0;else if("null"===t)l("null"),n.nullable=!0;else if("not"===t&&"null"===(u[e+1]||"").toLowerCase())l("null"),n.nullable=!1,e++;else{if("default"!==t)throw new Error(`Unrecognized "${shown(u[e])}" for field "${s}" in: ${shown(r)}`);l("default"),n.useDefault=!0,n.defaultValue=parseDefault(u[++e])}}if(n.autoGenerate&&n.useDefault)throw new Error(`Field "${s}" can't be both auto and have a default`);if(n.autoGenerate&&"string"!==o)throw new Error(`Field "${s}" is auto, which generates a UUID, so its type must be string`);return n};exports.parseField=parseField;const parseKey=e=>{let r=e.match(primaryMatch);if(r)return{type:"primary",fields:parseNames(r[1],e)};if(r=e.match(uniqueMatch),r)return{type:"unique",fields:parseNames(r[1],e)};if(r=e.match(indexMatch),r)return{type:"index",fields:parseNames(r[1],e)};if(r=e.match(foreignMatch),r){const s=parseNames(r[1],e),t=parseNames(r[3],e);if(1!==s.length||1!==t.length)throw new Error(`Only single-field foreign keys are supported so far: ${shown(e)}`);return{type:"foreign",fields:s,references:[{fields:[`${r[2]}.${t[0]}`],lookup:`${r[2]}.json`}]}}return null},finishKeys=(e,r)=>{const s=e.map((e=>e.name));if(r.filter((e=>"primary"===e.type)).length>1)throw new Error("Only one primary key is allowed");const t=new Set;return r.map((e=>{const r=e.fields.find((e=>!s.includes(e)));if(r)throw new Error(`The ${e.type} key (${e.fields.join(", ")}) names "${r}", which is not a field`);const i=keyLookup(e.type,e.fields);if(t.has(i))throw new Error(`The same ${e.type} key on "${e.fields.join(", ")}" is given twice`);return t.add(i),Object.assign({type:e.type,fields:e.fields,lookup:i},e.references?{references:e.references}:{})}))},parseCreate=e=>{const r=e.match(headMatch);if(!r)throw new Error("Expected: create [if not exists] <name> (<fields and keys>)");const s=r[2];if("__RECORDS"===s)throw new Error("__RECORDS is reserved for the list of records");const t=r[0].length-1,i=findClose(e,t);if(-1===i)throw new Error("Missing ) at the end of the field list");const o=e.slice(i+1).trim();if(o){if(_startsQuery.startsQueryMatch.test(o))throw new Error(`Missing ; before: ${shown(o)}`);throw new Error(`Unrecognized query value: ${shown(o)}`)}const n=e.slice(t+1,i),a=[],l=[];if(n.trim())for(const e of splitItems(n)){if(!e)throw new Error("Empty item in the field list (an extra comma?)");const r=parseKey(e);if(r){l.push(r);continue}const s=e.match(fieldMatch);if(!s)throw new Error(`Expected a field (<name> <type> ...) or a key in: ${shown(e)}`);const t=parseField(s);if(a.some((e=>e.name===t.name)))throw new Error(`Field "${t.name}" is given twice`);a.push(t)}return{entity:s,create:{ifNotExists:Boolean(r[1]),definition:a,keys:finishKeys(a,l)}}};exports.parseCreate=parseCreate;

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

@@ -0,0 +1,17 @@
+export type ParsedDatabaseStatement = {
+    command: 'create database' | 'drop database' | 'use' | 'show databases';
+    entity: string;
+    ifExists: boolean;
+    ifNotExists: boolean;
+};
+/**
+ * The statements about databases rather than records. `create database (...)` and a bare `drop database` stay a record
+ * named "database": these need a database name after the keyword.
+ */
+export declare const databaseStatementMatch: RegExp;
+/**
+ * Read `create database [if not exists] <name>`, `drop database [if exists] <name>`, `use <name>` or `show databases`.
+ * @param query - The statement, with its strings and arrays masked (see maskStrings).
+ */
+export declare const parseDatabaseStatement: (query: string) => ParsedDatabaseStatement;
+//# sourceMappingURL=parseDatabaseStatement.d.ts.map

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

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseDatabaseStatement = exports.databaseStatementMatch = void 0;
+var _maskStrings = require("./maskStrings");
+var _startsQuery = require("./startsQuery");
+/**
+ * The statements about databases rather than records. `create database (...)` and a bare `drop database` stay a record
+ * named "database": these need a database name after the keyword.
+ */
+const databaseStatementMatch = exports.databaseStatementMatch = /^\s*(?:(?:create|drop)\s+database\s+(?!\()[a-z0-9_-]|show\s+databases(?![a-z0-9_-])|use(?![a-z0-9_.-]))/i;
+const createMatch = /^\s*create\s+database\s+(if\s+not\s+exists\s+)?([a-z0-9_-]+)/i;
+const dropMatch = /^\s*drop\s+database\s+(if\s+exists\s+)?([a-z0-9_-]+)/i;
+const useMatch = /^\s*use\s+([a-z0-9_-]+)/i;
+const showMatch = /^\s*show\s+databases/i;
+/**
+ * Nothing may follow a database statement but the end of the query.
+ * @param rest
+ */
+const assertNothingAfter = rest => {
+  const after = rest.trim();
+  if (!after) {
+    return;
+  }
+  const shown = (0, _maskStrings.unmaskStrings)(after, '\'');
+  if (_startsQuery.startsQueryMatch.test(after)) {
+    throw new Error(`Missing ; before: ${shown}`);
+  }
+  throw new Error(`Unrecognized query value: ${shown}`);
+};
+/**
+ * Read `create database [if not exists] <name>`, `drop database [if exists] <name>`, `use <name>` or `show databases`.
+ * @param query - The statement, with its strings and arrays masked (see maskStrings).
+ */
+const parseDatabaseStatement = query => {
+  const statement = {
+    ifExists: false,
+    ifNotExists: false
+  };
+  let found = query.match(createMatch);
+  if (found) {
+    assertNothingAfter(query.slice(found[0].length));
+    return {
+      ...statement,
+      command: 'create database',
+      entity: found[2],
+      ifNotExists: Boolean(found[1])
+    };
+  }
+  found = query.match(dropMatch);
+  if (found) {
+    assertNothingAfter(query.slice(found[0].length));
+    return {
+      ...statement,
+      command: 'drop database',
+      entity: found[2],
+      ifExists: Boolean(found[1])
+    };
+  }
+  found = query.match(showMatch);
+  if (found) {
+    assertNothingAfter(query.slice(found[0].length));
+    return {
+      ...statement,
+      command: 'show databases',
+      entity: '__DATABASES'
+    };
+  }
+  found = query.match(useMatch);
+  if (!found) {
+    throw new Error('Expected: use <database>');
+  }
+  assertNothingAfter(query.slice(found[0].length));
+  return {
+    ...statement,
+    command: 'use',
+    entity: found[1]
+  };
+};
+exports.parseDatabaseStatement = parseDatabaseStatement;

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parseDatabaseStatement=exports.databaseStatementMatch=void 0;var _maskStrings=require("./maskStrings"),_startsQuery=require("./startsQuery");const databaseStatementMatch=exports.databaseStatementMatch=/^\s*(?:(?:create|drop)\s+database\s+(?!\()[a-z0-9_-]|show\s+databases(?![a-z0-9_-])|use(?![a-z0-9_.-]))/i,createMatch=/^\s*create\s+database\s+(if\s+not\s+exists\s+)?([a-z0-9_-]+)/i,dropMatch=/^\s*drop\s+database\s+(if\s+exists\s+)?([a-z0-9_-]+)/i,useMatch=/^\s*use\s+([a-z0-9_-]+)/i,showMatch=/^\s*show\s+databases/i,assertNothingAfter=t=>{const e=t.trim();if(!e)return;const s=(0,_maskStrings.unmaskStrings)(e,"'");if(_startsQuery.startsQueryMatch.test(e))throw new Error(`Missing ; before: ${s}`);throw new Error(`Unrecognized query value: ${s}`)},parseDatabaseStatement=t=>{const e={ifExists:!1,ifNotExists:!1};let s=t.match(createMatch);if(s)return assertNothingAfter(t.slice(s[0].length)),{...e,command:"create database",entity:s[2],ifNotExists:Boolean(s[1])};if(s=t.match(dropMatch),s)return assertNothingAfter(t.slice(s[0].length)),{...e,command:"drop database",entity:s[2],ifExists:Boolean(s[1])};if(s=t.match(showMatch),s)return assertNothingAfter(t.slice(s[0].length)),{...e,command:"show databases",entity:"__DATABASES"};if(s=t.match(useMatch),!s)throw new Error("Expected: use <database>");return assertNothingAfter(t.slice(s[0].length)),{...e,command:"use",entity:s[1]}};exports.parseDatabaseStatement=parseDatabaseStatement;

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

@@ -11,6 +11,7 @@ import { ParsedGroupBy } from './findGroupBy';
 import { ParsedLimit } from './findLimit';
 import { ParsedOffset } from './findOffset';
 import { ParsedCreate } from './parseCreate';
+import { ParsedAlter } from './parseAlter';
 export type ParsedQuery = {
     command: ParsedCommand | undefined;
     entity: ParsedEntity | undefined;
@@ -26,6 +27,8 @@ export type ParsedQuery = {
     limit: ParsedLimit | undefined;
     offset: ParsedOffset | undefined;
     create: ParsedCreate | undefined;
+    alter?: ParsedAlter;
+    ifNotExists?: boolean;
     ifExists: boolean | undefined;
 };
 /**