json-fs-query 3.2.0 → 3.3.0

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

@@ -20,6 +20,8 @@ var _findOffset = require("./findOffset");
 var _maskStrings = require("./maskStrings");
 var _parseCreate = require("./parseCreate");
 var _parseSchemaStatement = require("./parseSchemaStatement");
+var _parseAlter = require("./parseAlter");
+var _parseDatabaseStatement = require("./parseDatabaseStatement");
 var _splitClauses = require("./splitClauses");
 var _startsQuery = require("./startsQuery");
 // Each clause's own step, and what its body must start with (for the error when it doesn't)
@@ -101,6 +103,11 @@ const parseQuery = query => {
   };
   // No find* step may see inside a string or an array: each one becomes a placeholder holding its value
   query = (0, _maskStrings.maskArrays)((0, _maskStrings.maskStrings)(query));
+  // Statements about databases (create / drop database, use, show databases) come first: they share their first words
+  // with the record statements
+  if (_parseDatabaseStatement.databaseStatementMatch.test(query)) {
+    return Object.assign(parsedQuery, (0, _parseDatabaseStatement.parseDatabaseStatement)(query));
+  }
   // A create statement has its own shape (a bracketed list of fields and keys), so it gets its own parser
   if (_parseCreate.createMatch.test(query)) {
     const {
@@ -116,6 +123,18 @@ const parseQuery = query => {
   if (_parseSchemaStatement.schemaStatementMatch.test(query)) {
     return Object.assign(parsedQuery, (0, _parseSchemaStatement.parseSchemaStatement)(query));
   }
+  // So does alter: one change to a record's fields
+  if (_parseAlter.alterMatch.test(query)) {
+    const {
+      entity,
+      alter
+    } = (0, _parseAlter.parseAlter)(query);
+    return Object.assign(parsedQuery, {
+      command: 'alter',
+      entity,
+      alter
+    });
+  }
   // Clauses come at most once each, in a fixed order (see clauseOrder); each step reads only its own clause's body
   const split = (0, _splitClauses.splitClauses)(query);
   if (!split) {
@@ -146,6 +165,11 @@ const parseQuery = query => {
       throw leftoverError(rest, `${keyword} ${body.slice(0, body.length - rest.length).trim()}`);
     }
   }
+  // `on` joins the record named after the queried one: without it there's nothing to join (this used to fail later,
+  // reading a record with no name, as "Could not read .json")
+  if ((parsedQuery.joinClauses || []).length && !parsedQuery.joinEntity) {
+    throw new Error(`"on" needs the record to join, after the one read: ${parsedQuery.command} ${parsedQuery.entity}.<record> on ...`);
+  }
   return parsedQuery;
 };
 exports.parseQuery = parseQuery;

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parseQuery=void 0;var _findCommand=require("./findCommand"),_findInsertValues=require("./findInsertValues"),_findUpdateValues=require("./findUpdateValues"),_findJoinEntity=require("./findJoinEntity"),_findSelects=require("./findSelects"),_findConditions=require("./findConditions"),_conditionTree=require("../conditionTree"),_findJoinClauses=require("./findJoinClauses"),_findMergeJoins=require("./findMergeJoins"),_findSortClauses=require("./findSortClauses"),_findGroupBy=require("./findGroupBy"),_findLimit=require("./findLimit"),_findOffset=require("./findOffset"),_maskStrings=require("./maskStrings"),_parseCreate=require("./parseCreate"),_parseSchemaStatement=require("./parseSchemaStatement"),_splitClauses=require("./splitClauses"),_startsQuery=require("./startsQuery");const clauseSteps={values:{step:_findInsertValues.findInsertValues,expected:"an assignment (field = value)"},set:{step:_findUpdateValues.findUpdateValues,expected:"an assignment (field = value)"},select:{step:_findSelects.findSelects,expected:"a field"},on:{step:_findJoinClauses.findJoinClauses,expected:"a join condition (a.x = b.y)"},merge:{step:_findMergeJoins.findMergeJoins,expected:"a merge (a.x with b.y)"},where:{step:_findConditions.findConditions,expected:"a condition"},"group by":{step:_findGroupBy.findGroupBy,expected:"a field"},sort:{step:_findSortClauses.findSortClauses,expected:"a field"},limit:{step:_findLimit.findLimit,expected:"a whole number"},offset:{step:_findOffset.findOffset,expected:"a whole number"}},leftoverError=(e,t)=>{const i=e=>(0,_maskStrings.unmaskStrings)(e,"'");return _startsQuery.startsQueryMatch.test(e)?new Error(`Missing ; before: ${i(e)}`):new Error(`Unexpected "${i(e)}" after "${i(t)}"`)},parseQuery=e=>{const t={command:void 0,entity:void 0,joinEntity:void 0,selectClauses:[],insertValues:[],updateValues:{},where:void 0,joinClauses:[],mergeJoins:[],sortClauses:[],groupBy:void 0,limit:void 0,offset:void 0,create:void 0,ifExists:void 0};if(e=(0,_maskStrings.maskArrays)((0,_maskStrings.maskStrings)(e)),_parseCreate.createMatch.test(e)){const{entity:i,create:r}=(0,_parseCreate.parseCreate)(e);return Object.assign(t,{command:"create",entity:i,create:r})}if(_parseSchemaStatement.schemaStatementMatch.test(e))return Object.assign(t,(0,_parseSchemaStatement.parseSchemaStatement)(e));const i=(0,_splitClauses.splitClauses)(e);if(!i){if(e=e.trim(),_startsQuery.startsQueryMatch.test(e))throw new Error(`Missing ; before: ${(0,_maskStrings.unmaskStrings)(e,"'")}`);throw new Error(`Unrecognized query value: ${(0,_maskStrings.unmaskStrings)(e,"'")}`)}if((0,_findJoinEntity.findJoinEntity)(t,(0,_findCommand.findCommand)(t,i.head)),t.where=(0,_conditionTree.allOf)([]),i.leading)throw leftoverError(i.leading,i.head);for(const{keyword:e,body:r}of i.clauses){const{step:i,expected:s}=clauseSteps[e],n=i(t,r);if(n===r)throw new Error(`Missing ${s} after ${e}${r?`: ${(0,_maskStrings.unmaskStrings)(r,"'")}`:""}`);if(n)throw leftoverError(n,`${e} ${r.slice(0,r.length-n.length).trim()}`)}return t};exports.parseQuery=parseQuery;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parseQuery=void 0;var _findCommand=require("./findCommand"),_findInsertValues=require("./findInsertValues"),_findUpdateValues=require("./findUpdateValues"),_findJoinEntity=require("./findJoinEntity"),_findSelects=require("./findSelects"),_findConditions=require("./findConditions"),_conditionTree=require("../conditionTree"),_findJoinClauses=require("./findJoinClauses"),_findMergeJoins=require("./findMergeJoins"),_findSortClauses=require("./findSortClauses"),_findGroupBy=require("./findGroupBy"),_findLimit=require("./findLimit"),_findOffset=require("./findOffset"),_maskStrings=require("./maskStrings"),_parseCreate=require("./parseCreate"),_parseSchemaStatement=require("./parseSchemaStatement"),_parseAlter=require("./parseAlter"),_parseDatabaseStatement=require("./parseDatabaseStatement"),_splitClauses=require("./splitClauses"),_startsQuery=require("./startsQuery");const clauseSteps={values:{step:_findInsertValues.findInsertValues,expected:"an assignment (field = value)"},set:{step:_findUpdateValues.findUpdateValues,expected:"an assignment (field = value)"},select:{step:_findSelects.findSelects,expected:"a field"},on:{step:_findJoinClauses.findJoinClauses,expected:"a join condition (a.x = b.y)"},merge:{step:_findMergeJoins.findMergeJoins,expected:"a merge (a.x with b.y)"},where:{step:_findConditions.findConditions,expected:"a condition"},"group by":{step:_findGroupBy.findGroupBy,expected:"a field"},sort:{step:_findSortClauses.findSortClauses,expected:"a field"},limit:{step:_findLimit.findLimit,expected:"a whole number"},offset:{step:_findOffset.findOffset,expected:"a whole number"}},leftoverError=(e,t)=>{const r=e=>(0,_maskStrings.unmaskStrings)(e,"'");return _startsQuery.startsQueryMatch.test(e)?new Error(`Missing ; before: ${r(e)}`):new Error(`Unexpected "${r(e)}" after "${r(t)}"`)},parseQuery=e=>{const t={command:void 0,entity:void 0,joinEntity:void 0,selectClauses:[],insertValues:[],updateValues:{},where:void 0,joinClauses:[],mergeJoins:[],sortClauses:[],groupBy:void 0,limit:void 0,offset:void 0,create:void 0,ifExists:void 0};if(e=(0,_maskStrings.maskArrays)((0,_maskStrings.maskStrings)(e)),_parseDatabaseStatement.databaseStatementMatch.test(e))return Object.assign(t,(0,_parseDatabaseStatement.parseDatabaseStatement)(e));if(_parseCreate.createMatch.test(e)){const{entity:r,create:s}=(0,_parseCreate.parseCreate)(e);return Object.assign(t,{command:"create",entity:r,create:s})}if(_parseSchemaStatement.schemaStatementMatch.test(e))return Object.assign(t,(0,_parseSchemaStatement.parseSchemaStatement)(e));if(_parseAlter.alterMatch.test(e)){const{entity:r,alter:s}=(0,_parseAlter.parseAlter)(e);return Object.assign(t,{command:"alter",entity:r,alter:s})}const r=(0,_splitClauses.splitClauses)(e);if(!r){if(e=e.trim(),_startsQuery.startsQueryMatch.test(e))throw new Error(`Missing ; before: ${(0,_maskStrings.unmaskStrings)(e,"'")}`);throw new Error(`Unrecognized query value: ${(0,_maskStrings.unmaskStrings)(e,"'")}`)}if((0,_findJoinEntity.findJoinEntity)(t,(0,_findCommand.findCommand)(t,r.head)),t.where=(0,_conditionTree.allOf)([]),r.leading)throw leftoverError(r.leading,r.head);for(const{keyword:e,body:s}of r.clauses){const{step:r,expected:i}=clauseSteps[e],n=r(t,s);if(n===s)throw new Error(`Missing ${i} after ${e}${s?`: ${(0,_maskStrings.unmaskStrings)(s,"'")}`:""}`);if(n)throw leftoverError(n,`${e} ${s.slice(0,s.length-n.length).trim()}`)}if((t.joinClauses||[]).length&&!t.joinEntity)throw new Error(`"on" needs the record to join, after the one read: ${t.command} ${t.entity}.<record> on ...`);return t};exports.parseQuery=parseQuery;

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

@@ -7,4 +7,4 @@ exports.startsQueryMatch = void 0;
 /**
  * Matches text that starts with a command word, for the "Missing ; before" error when a query runs on into the next.
  */
-const startsQueryMatch = exports.startsQueryMatch = /^\s*(create|delete|describe|drop|insert|read|show|update)(?![a-z0-9_-])/i;
+const startsQueryMatch = exports.startsQueryMatch = /^\s*(alter|create|delete|describe|drop|insert|read|show|update|use)(?![a-z0-9_-])/i;

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.startsQueryMatch=void 0;const startsQueryMatch=exports.startsQueryMatch=/^\s*(create|delete|describe|drop|insert|read|show|update)(?![a-z0-9_-])/i;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.startsQueryMatch=void 0;const startsQueryMatch=exports.startsQueryMatch=/^\s*(alter|create|delete|describe|drop|insert|read|show|update|use)(?![a-z0-9_-])/i;

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

@@ -0,0 +1,15 @@
+/**
+ * Read several files of the database at once and resolve to their contents in the order of `paths`. Up to
+ * `readConcurrency` reads (see configure) are in flight together: in a browser each file is an HTTP request, so a full
+ * read of 1,000 rows no longer waits for 1,000 requests one after another.
+ *
+ * Fails as reading them one at a time would: with the error of the first file (in `paths` order) that can't be read.
+ * Once a read fails no new ones start; the ones already started are awaited, so none is left running after this
+ * returns, and since reads start in order, every file before the first failure was read.
+ * @param paths - Paths inside the database, such as `users/1.json`.
+ * @param read - Reads one path (default retrieveFile); callers with their own error message for a missing file pass it
+ *   here.
+ * @throws {Error} The error of the first file that couldn't be read.
+ */
+export declare const retrieveFiles: (paths: string[], read?: (path: string) => Promise<any>) => Promise<any[]>;
+//# sourceMappingURL=retrieveFiles.d.ts.map

package/dist/data/utilities/retrieveFiles.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.retrieveFiles = void 0;
+var _retrieveFile = require("./retrieveFile");
+var _config = require("./config");
+/**
+ * Read several files of the database at once and resolve to their contents in the order of `paths`. Up to
+ * `readConcurrency` reads (see configure) are in flight together: in a browser each file is an HTTP request, so a full
+ * read of 1,000 rows no longer waits for 1,000 requests one after another.
+ *
+ * Fails as reading them one at a time would: with the error of the first file (in `paths` order) that can't be read.
+ * Once a read fails no new ones start; the ones already started are awaited, so none is left running after this
+ * returns, and since reads start in order, every file before the first failure was read.
+ * @param paths - Paths inside the database, such as `users/1.json`.
+ * @param read - Reads one path (default retrieveFile); callers with their own error message for a missing file pass it
+ *   here.
+ * @throws {Error} The error of the first file that couldn't be read.
+ */
+const retrieveFiles = async (paths, read = _retrieveFile.retrieveFile) => {
+  const limit = Math.max(1, Math.floor((0, _config.getSetting)('readConcurrency', 16)) || 1);
+  const contents = new Array(paths.length);
+  const failures = [];
+  let next = 0;
+  const worker = async () => {
+    while (next < paths.length && !failures.length) {
+      const position = next++;
+      try {
+        contents[position] = await read(paths[position]);
+      } catch (error) {
+        failures.push({
+          position,
+          error
+        });
+      }
+    }
+  };
+  await Promise.all(Array.from({
+    length: Math.min(limit, paths.length)
+  }, worker));
+  if (failures.length) {
+    throw failures.reduce((first, failure) => failure.position < first.position ? failure : first).error;
+  }
+  return contents;
+};
+exports.retrieveFiles = retrieveFiles;

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.retrieveFiles=void 0;var _retrieveFile=require("./retrieveFile"),_config=require("./config");const retrieveFiles=async(e,r=_retrieveFile.retrieveFile)=>{const t=Math.max(1,Math.floor((0,_config.getSetting)("readConcurrency",16))||1),i=new Array(e.length),o=[];let n=0;if(await Promise.all(Array.from({length:Math.min(t,e.length)},(async()=>{for(;n<e.length&&!o.length;){const t=n++;try{i[t]=await r(e[t])}catch(e){o.push({position:t,error:e})}}}))),o.length)throw o.reduce(((e,r)=>r.position<e.position?r:e)).error;return i};exports.retrieveFiles=retrieveFiles;

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

@@ -1,2 +1,8 @@
+/**
+ * A record's definition (its fields, keys and entries), from `<entity>.json`.
+ * @param entity
+ * @throws {Error} `Record "<entity>" doesn't exist` when it doesn't (in Node, checked before reading; in a browser,
+ *   where that can't be checked without reading, when the file can't be read).
+ */
 export declare const retrieveRecord: (entity?: string) => Promise<any>;
 //# sourceMappingURL=retrieveRecord.d.ts.map

package/dist/data/utilities/retrieveRecord.js

@@ -1,9 +1,32 @@
 "use strict";
 
+require("core-js/modules/esnext.weak-map.delete-all.js");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.retrieveRecord = void 0;
+var jsEnv = _interopRequireWildcard(require("browser-or-node"));
 var _retrieveFile = require("./retrieveFile");
-const retrieveRecord = async (entity = '') => await (0, _retrieveFile.retrieveFile)(`${entity}.json`);
+var _recordExists = require("./recordExists");
+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; }
+/**
+ * A record's definition (its fields, keys and entries), from `<entity>.json`.
+ * @param entity
+ * @throws {Error} `Record "<entity>" doesn't exist` when it doesn't (in Node, checked before reading; in a browser,
+ *   where that can't be checked without reading, when the file can't be read).
+ */
+const retrieveRecord = async (entity = '') => {
+  if (jsEnv.isNode && !(0, _recordExists.recordExists)(entity)) {
+    throw new Error(`Record "${entity}" doesn't exist`);
+  }
+  try {
+    return await (0, _retrieveFile.retrieveFile)(`${entity}.json`);
+  } catch (error) {
+    if (!jsEnv.isNode) {
+      throw new Error(`Record "${entity}" doesn't exist, or ${entity}.json can't be read`);
+    }
+    throw error;
+  }
+};
 exports.retrieveRecord = retrieveRecord;

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.retrieveRecord=void 0;var _retrieveFile=require("./retrieveFile");const retrieveRecord=async(e="")=>await(0,_retrieveFile.retrieveFile)(`${e}.json`);exports.retrieveRecord=retrieveRecord;
+"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.retrieveRecord=void 0;var e,jsEnv=_interopRequireWildcard(require("browser-or-node")),_retrieveFile=require("./retrieveFile"),_recordExists=require("./recordExists");function _interopRequireWildcard(r,t){if(!t&&r&&r.__esModule)return r;var o,i,s=Object.defineProperty,n={__proto__:null,default:r};if(Object(r)!==r)return n;if(e||"function"!=typeof WeakMap||(e=new WeakMap),e){if(e.has(r))return e.get(r);e.set(r,n)}for(i in r)"default"!==i&&{}.hasOwnProperty.call(r,i)&&((o=s&&Object.getOwnPropertyDescriptor(r,i))&&(o.get||o.set)?s(n,i,o):n[i]=r[i]);return n}const retrieveRecord=async(e="")=>{if(jsEnv.isNode&&!(0,_recordExists.recordExists)(e))throw new Error(`Record "${e}" doesn't exist`);try{return await(0,_retrieveFile.retrieveFile)(`${e}.json`)}catch(r){if(!jsEnv.isNode)throw new Error(`Record "${e}" doesn't exist, or ${e}.json can't be read`);throw r}};exports.retrieveRecord=retrieveRecord;

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

@@ -1,2 +1,24 @@
+import { recordDefinition } from '../introspect/definitions/record';
+/**
+ * Read one entry file, failing with the message a missing entry has always had.
+ * @param path - The entry's path inside the database, such as `users/1.json`.
+ */
+export declare const retrieveEntry: (path: string) => Promise<any>;
+/**
+ * The rows of some of a record's entry files, in the order of `files`. When they're more than one round of reads
+ * (`readConcurrency`, see retrieveFiles) and the record has a packed file that matches it (see retrievePacked), they
+ * come from the packed file in one read; otherwise, and for any file the packed file doesn't hold (an index can list a
+ * file the record doesn't), from the entry files, several at a time. So a lookup of a few rows never downloads a whole
+ * record, and a record of a few rows is never asked for a packed file.
+ * @param record
+ * @param files - Entry file names, such as `1.json`.
+ * @param read - Reads one entry file (default retrieveEntry).
+ */
+export declare const retrieveEntryRows: (record: recordDefinition, files: string[], read?: (path: string) => Promise<any>) => Promise<any[]>;
+/**
+ * Every row of a record, in the record's order: from its packed file when there's one that matches (see
+ * retrievePacked), otherwise from its entry files, several at a time (see retrieveFiles).
+ * @param entity
+ */
 export declare const retrieveRecords: (entity?: string) => Promise<any[]>;
 //# sourceMappingURL=retrieveRecords.d.ts.map

package/dist/data/utilities/retrieveRecords.js

@@ -3,19 +3,69 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.retrieveRecords = void 0;
+exports.retrieveRecords = exports.retrieveEntryRows = exports.retrieveEntry = void 0;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.filter.js");
+require("core-js/modules/esnext.iterator.map.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");
 var _retrieveFile = require("./retrieveFile");
 var _retrieveRecord = require("./retrieveRecord");
+var _retrieveFiles = require("./retrieveFiles");
+var _packedTable = require("./packedTable");
+var _config = require("./config");
+/**
+ * Read one entry file, failing with the message a missing entry has always had.
+ * @param path - The entry's path inside the database, such as `users/1.json`.
+ */
+const retrieveEntry = async path => {
+  const data = await (0, _retrieveFile.retrieveFile)(path).catch(err => console.error(err));
+  if (!data) {
+    throw new Error(`Could not read entity ${path.slice(path.lastIndexOf('/') + 1)}`);
+  }
+  return data;
+};
+/**
+ * The rows of some of a record's entry files, in the order of `files`. When they're more than one round of reads
+ * (`readConcurrency`, see retrieveFiles) and the record has a packed file that matches it (see retrievePacked), they
+ * come from the packed file in one read; otherwise, and for any file the packed file doesn't hold (an index can list a
+ * file the record doesn't), from the entry files, several at a time. So a lookup of a few rows never downloads a whole
+ * record, and a record of a few rows is never asked for a packed file.
+ * @param record
+ * @param files - Entry file names, such as `1.json`.
+ * @param read - Reads one entry file (default retrieveEntry).
+ */
+exports.retrieveEntry = retrieveEntry;
+const retrieveEntryRows = async (record, files, read = retrieveEntry) => {
+  const packed = files.length > (0, _config.getSetting)('readConcurrency', 16) ? await (0, _packedTable.retrievePacked)(record) : undefined;
+  if (!packed) {
+    return (0, _retrieveFiles.retrieveFiles)(files.map(file => `${record.path}/${file}`), read);
+  }
+  const positions = new Map(packed.entries.map((entry, position) => [entry, position]));
+  const unpacked = files.filter(file => !positions.has(file));
+  const readRows = unpacked.length ? await (0, _retrieveFiles.retrieveFiles)(unpacked.map(file => `${record.path}/${file}`), read) : [];
+  const fromFiles = new Map(unpacked.map((file, position) => [file, readRows[position]]));
+  return files.map(file => positions.has(file) ? packed.rows[positions.get(file)] : fromFiles.get(file));
+};
+/**
+ * Every row of a record, in the record's order: from its packed file when there's one that matches (see
+ * retrievePacked), otherwise from its entry files, several at a time (see retrieveFiles).
+ * @param entity
+ */
+exports.retrieveEntryRows = retrieveEntryRows;
 const retrieveRecords = async (entity = '') => {
   const recordFile = await (0, _retrieveRecord.retrieveRecord)(entity);
-  const dataSet = [];
-  for (const file of recordFile.entries) {
-    const data = await (0, _retrieveFile.retrieveFile)(`${recordFile.path}/${file}`).catch(err => console.error(err));
-    if (!data) {
-      throw new Error(`Could not read entity ${file}`);
-    }
-    dataSet.push(data);
-  }
-  return dataSet;
+  return retrieveEntryRows(recordFile, recordFile.entries);
 };
 exports.retrieveRecords = retrieveRecords;

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.retrieveRecords=void 0;var _retrieveFile=require("./retrieveFile"),_retrieveRecord=require("./retrieveRecord");const retrieveRecords=async(e="")=>{const r=await(0,_retrieveRecord.retrieveRecord)(e),t=[];for(const e of r.entries){const o=await(0,_retrieveFile.retrieveFile)(`${r.path}/${e}`).catch((e=>console.error(e)));if(!o)throw new Error(`Could not read entity ${e}`);t.push(o)}return t};exports.retrieveRecords=retrieveRecords;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.retrieveRecords=exports.retrieveEntryRows=exports.retrieveEntry=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.filter.js"),require("core-js/modules/esnext.iterator.map.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");var _retrieveFile=require("./retrieveFile"),_retrieveRecord=require("./retrieveRecord"),_retrieveFiles=require("./retrieveFiles"),_packedTable=require("./packedTable"),_config=require("./config");const retrieveEntry=async e=>{const r=await(0,_retrieveFile.retrieveFile)(e).catch((e=>console.error(e)));if(!r)throw new Error(`Could not read entity ${e.slice(e.lastIndexOf("/")+1)}`);return r};exports.retrieveEntry=retrieveEntry;const retrieveEntryRows=async(e,r,s=retrieveEntry)=>{const t=r.length>(0,_config.getSetting)("readConcurrency",16)?await(0,_packedTable.retrievePacked)(e):void 0;if(!t)return(0,_retrieveFiles.retrieveFiles)(r.map((r=>`${e.path}/${r}`)),s);const i=new Map(t.entries.map(((e,r)=>[e,r]))),o=r.filter((e=>!i.has(e))),n=o.length?await(0,_retrieveFiles.retrieveFiles)(o.map((r=>`${e.path}/${r}`)),s):[],a=new Map(o.map(((e,r)=>[e,n[r]])));return r.map((e=>i.has(e)?t.rows[i.get(e)]:a.get(e)))};exports.retrieveEntryRows=retrieveEntryRows;const retrieveRecords=async(e="")=>{const r=await(0,_retrieveRecord.retrieveRecord)(e);return retrieveEntryRows(r,r.entries)};exports.retrieveRecords=retrieveRecords;

package/dist/data/utilities/runQuery.js

@@ -28,6 +28,8 @@ var _updateEntity = require("../queries/updateEntity");
 var _createRecord = require("../queries/createRecord");
 var _dropRecord = require("../queries/dropRecord");
 var _describeRecord = require("../queries/describeRecord");
+var _alter = require("../introspect/alter");
+var _databaseStatements = require("../queries/databaseStatements");
 var _showRecords = require("../queries/showRecords");
 var _joinEntity = require("../queries/joinEntity");
 var _mergeJoins = require("../queries/mergeJoins");
@@ -44,6 +46,7 @@ var _fieldType = require("./fieldType");
 var _conditionTree = require("./conditionTree");
 var _conditionEntities = require("./conditionEntities");
 var _requireNode = require("./requireNode");
+var _knownFields = require("./knownFields");
 /**
  * Give each condition and sort clause its field's declared type, so where and sortBy compare by it
  * (a joined entity's field is looked up on that entity's record).
@@ -70,7 +73,7 @@ const runQuery = async parsed => {
   // Checked before anything is read: which entity each condition is on, and whether it needs per-pair evaluation
   const perPair = typeof parsed.where !== 'undefined' && (0, _conditionEntities.conditionEntities)(parsed);
   // Writes and schema changes need the filesystem; say so plainly in a browser
-  if (['insert', 'update', 'delete', 'create', 'drop'].includes(parsed.command)) {
+  if (['insert', 'update', 'delete', 'create', 'drop', 'alter'].includes(parsed.command)) {
     (0, _requireNode.requireNode)(`"${parsed.command}"`);
   }
   // Schema statements act on the database, not on entries (for create there is no record to read yet)
@@ -87,6 +90,26 @@ const runQuery = async parsed => {
       return {
         [parsed.entity]: await (0, _describeRecord.describeRecord)(parsed.entity)
       };
+    case 'alter':
+      return {
+        [parsed.entity]: await (0, _alter.alter)(parsed.entity, parsed.alter)
+      };
+    case 'create database':
+      return {
+        [parsed.entity]: await (0, _databaseStatements.createDatabase)(parsed.entity, parsed.ifNotExists)
+      };
+    case 'drop database':
+      return {
+        [parsed.entity]: await (0, _databaseStatements.dropDatabase)(parsed.entity, parsed.ifExists)
+      };
+    case 'use':
+      return {
+        [parsed.entity]: await (0, _databaseStatements.useDatabase)(parsed.entity)
+      };
+    case 'show databases':
+      return {
+        [parsed.entity]: await (0, _databaseStatements.showDatabases)()
+      };
     case 'show':
       return {
         [parsed.entity]: await (0, _showRecords.showRecords)()
@@ -98,6 +121,8 @@ const runQuery = async parsed => {
   if (typeof parsed.joinEntity !== 'undefined') {
     recordData[parsed.joinEntity] = await (0, _retrieveRecord.retrieveRecord)(parsed.joinEntity);
   }
+  // Every field the query names must be one its record defines: a misspelled one would otherwise match nothing
+  await (0, _knownFields.assertKnownFields)(parsed, recordData);
   await typeClauses(parsed, recordData);
   let dataSet = {
     [parsed.entity]: []
@@ -153,7 +178,7 @@ const runQuery = async parsed => {
   dataSet[parsed.entity] = (0, _sortBy.sortBy)(dataSet[parsed.entity], parsed.sortClauses);
   dataSet[parsed.entity] = (0, _groupBy.groupBy)(dataSet[parsed.entity], parsed.groupBy);
   dataSet[parsed.entity] = (0, _limitOffset.limitOffset)(dataSet[parsed.entity], parsed.offset, parsed.limit);
-  dataSet[parsed.entity] = (0, _selectFields.selectFields)(dataSet[parsed.entity], parsed.selectClauses, Boolean(parsed.groupBy?.length));
+  dataSet[parsed.entity] = (0, _selectFields.selectFields)(dataSet[parsed.entity], parsed.selectClauses, Boolean(parsed.groupBy?.length), parsed.entity);
   return dataSet;
 };
 exports.runQuery = runQuery;

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.runQuery=void 0,require("core-js/modules/es.array.includes.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 _deleteEntity=require("../queries/deleteEntity"),_insertEntity=require("../queries/insertEntity"),_readEntity=require("../queries/readEntity"),_updateEntity=require("../queries/updateEntity"),_createRecord=require("../queries/createRecord"),_dropRecord=require("../queries/dropRecord"),_describeRecord=require("../queries/describeRecord"),_showRecords=require("../queries/showRecords"),_joinEntity=require("../queries/joinEntity"),_mergeJoins=require("../queries/mergeJoins"),_where=require("../queries/where"),_sortBy=require("../queries/sortBy"),_groupBy=require("../queries/groupBy"),_limitOffset=require("../queries/limitOffset"),_selectFields=require("../queries/selectFields"),_retrieveRecord=require("./retrieveRecord"),_getConditionIndexedList=require("./getConditionIndexedList"),_isEntityProperty=require("./parsers/isEntityProperty"),_splitEntityProperty=require("./parsers/splitEntityProperty"),_fieldType=require("./fieldType"),_conditionTree=require("./conditionTree"),_conditionEntities=require("./conditionEntities"),_requireNode=require("./requireNode");const typeClauses=async(e,t)=>{for(const r of[...(0,_conditionTree.conditionsOf)(e.where),...e.sortClauses]){let i=e.entity,s=r.property;(0,_isEntityProperty.isEntityProperty)(s)&&({entity:i,property:s}=(0,_splitEntityProperty.splitEntityProperty)(s)),Object.prototype.hasOwnProperty.call(t,i)||(t[i]=await(0,_retrieveRecord.retrieveRecord)(i)),r.type=(0,_fieldType.fieldType)(t[i],s)}},runQuery=async e=>{const t=void 0!==e.where&&(0,_conditionEntities.conditionEntities)(e);switch(["insert","update","delete","create","drop"].includes(e.command)&&(0,_requireNode.requireNode)(`"${e.command}"`),e.command){case"create":return{[e.entity]:await(0,_createRecord.createRecord)(e.entity,e.create)};case"drop":return{[e.entity]:await(0,_dropRecord.dropRecord)(e.entity,e.ifExists)};case"describe":return{[e.entity]:await(0,_describeRecord.describeRecord)(e.entity)};case"show":return{[e.entity]:await(0,_showRecords.showRecords)()}}const r={[e.entity]:await(0,_retrieveRecord.retrieveRecord)(e.entity)};void 0!==e.joinEntity&&(r[e.joinEntity]=await(0,_retrieveRecord.retrieveRecord)(e.joinEntity)),await typeClauses(e,r);let i={[e.entity]:[]};const s=new Set;e=await(0,_getConditionIndexedList.getConditionIndexedList)(e,r,i,s);const n=s.has(e.entity);switch("delete"!==e.command&&"update"!==e.command||(n||(i=await(0,_readEntity.readEntity)(e.entity,i)),i[e.entity]=(0,_where.whereTree)(i[e.entity],e.where)),e.command){case"delete":i=await(0,_deleteEntity.deleteEntity)(e.entity,i);break;case"insert":i=await(0,_insertEntity.insertEntity)(e.entity,e.insertValues,i);break;case"read":n||(i=await(0,_readEntity.readEntity)(e.entity,i));break;case"update":i=await(0,_updateEntity.updateEntity)(e.entity,e.updateValues,i);break;default:throw new Error(`Unknown command: ${e.command}`)}return i=await(0,_joinEntity.joinEntity)(e.entity,e.joinEntity,i,e.joinClauses,n,s.has(e.joinEntity)),i=await(0,_mergeJoins.mergeJoins)(i,e.mergeJoins),"delete"!==e.command&&"update"!==e.command&&(i[e.entity]=(0,_where.whereTree)(i[e.entity],e.where,t?e.joinEntity:void 0)),i[e.entity]=(0,_sortBy.sortBy)(i[e.entity],e.sortClauses),i[e.entity]=(0,_groupBy.groupBy)(i[e.entity],e.groupBy),i[e.entity]=(0,_limitOffset.limitOffset)(i[e.entity],e.offset,e.limit),i[e.entity]=(0,_selectFields.selectFields)(i[e.entity],e.selectClauses,Boolean(e.groupBy?.length)),i};exports.runQuery=runQuery;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.runQuery=void 0,require("core-js/modules/es.array.includes.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 _deleteEntity=require("../queries/deleteEntity"),_insertEntity=require("../queries/insertEntity"),_readEntity=require("../queries/readEntity"),_updateEntity=require("../queries/updateEntity"),_createRecord=require("../queries/createRecord"),_dropRecord=require("../queries/dropRecord"),_describeRecord=require("../queries/describeRecord"),_alter=require("../introspect/alter"),_databaseStatements=require("../queries/databaseStatements"),_showRecords=require("../queries/showRecords"),_joinEntity=require("../queries/joinEntity"),_mergeJoins=require("../queries/mergeJoins"),_where=require("../queries/where"),_sortBy=require("../queries/sortBy"),_groupBy=require("../queries/groupBy"),_limitOffset=require("../queries/limitOffset"),_selectFields=require("../queries/selectFields"),_retrieveRecord=require("./retrieveRecord"),_getConditionIndexedList=require("./getConditionIndexedList"),_isEntityProperty=require("./parsers/isEntityProperty"),_splitEntityProperty=require("./parsers/splitEntityProperty"),_fieldType=require("./fieldType"),_conditionTree=require("./conditionTree"),_conditionEntities=require("./conditionEntities"),_requireNode=require("./requireNode"),_knownFields=require("./knownFields");const typeClauses=async(e,t)=>{for(const r of[...(0,_conditionTree.conditionsOf)(e.where),...e.sortClauses]){let i=e.entity,s=r.property;(0,_isEntityProperty.isEntityProperty)(s)&&({entity:i,property:s}=(0,_splitEntityProperty.splitEntityProperty)(s)),Object.prototype.hasOwnProperty.call(t,i)||(t[i]=await(0,_retrieveRecord.retrieveRecord)(i)),r.type=(0,_fieldType.fieldType)(t[i],s)}},runQuery=async e=>{const t=void 0!==e.where&&(0,_conditionEntities.conditionEntities)(e);switch(["insert","update","delete","create","drop","alter"].includes(e.command)&&(0,_requireNode.requireNode)(`"${e.command}"`),e.command){case"create":return{[e.entity]:await(0,_createRecord.createRecord)(e.entity,e.create)};case"drop":return{[e.entity]:await(0,_dropRecord.dropRecord)(e.entity,e.ifExists)};case"describe":return{[e.entity]:await(0,_describeRecord.describeRecord)(e.entity)};case"alter":return{[e.entity]:await(0,_alter.alter)(e.entity,e.alter)};case"create database":return{[e.entity]:await(0,_databaseStatements.createDatabase)(e.entity,e.ifNotExists)};case"drop database":return{[e.entity]:await(0,_databaseStatements.dropDatabase)(e.entity,e.ifExists)};case"use":return{[e.entity]:await(0,_databaseStatements.useDatabase)(e.entity)};case"show databases":return{[e.entity]:await(0,_databaseStatements.showDatabases)()};case"show":return{[e.entity]:await(0,_showRecords.showRecords)()}}const r={[e.entity]:await(0,_retrieveRecord.retrieveRecord)(e.entity)};void 0!==e.joinEntity&&(r[e.joinEntity]=await(0,_retrieveRecord.retrieveRecord)(e.joinEntity)),await(0,_knownFields.assertKnownFields)(e,r),await typeClauses(e,r);let i={[e.entity]:[]};const s=new Set;e=await(0,_getConditionIndexedList.getConditionIndexedList)(e,r,i,s);const n=s.has(e.entity);switch("delete"!==e.command&&"update"!==e.command||(n||(i=await(0,_readEntity.readEntity)(e.entity,i)),i[e.entity]=(0,_where.whereTree)(i[e.entity],e.where)),e.command){case"delete":i=await(0,_deleteEntity.deleteEntity)(e.entity,i);break;case"insert":i=await(0,_insertEntity.insertEntity)(e.entity,e.insertValues,i);break;case"read":n||(i=await(0,_readEntity.readEntity)(e.entity,i));break;case"update":i=await(0,_updateEntity.updateEntity)(e.entity,e.updateValues,i);break;default:throw new Error(`Unknown command: ${e.command}`)}return i=await(0,_joinEntity.joinEntity)(e.entity,e.joinEntity,i,e.joinClauses,n,s.has(e.joinEntity)),i=await(0,_mergeJoins.mergeJoins)(i,e.mergeJoins),"delete"!==e.command&&"update"!==e.command&&(i[e.entity]=(0,_where.whereTree)(i[e.entity],e.where,t?e.joinEntity:void 0)),i[e.entity]=(0,_sortBy.sortBy)(i[e.entity],e.sortClauses),i[e.entity]=(0,_groupBy.groupBy)(i[e.entity],e.groupBy),i[e.entity]=(0,_limitOffset.limitOffset)(i[e.entity],e.offset,e.limit),i[e.entity]=(0,_selectFields.selectFields)(i[e.entity],e.selectClauses,Boolean(e.groupBy?.length),e.entity),i};exports.runQuery=runQuery;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { query } from './data/queries/query';
 export { quote } from './data/queries/quote';
 export { queryStatus, QueryStatus } from './data/queries/queryStatus';
-export { create, drop, describe } from './data/introspect';
+export { create, drop, alter, describe, formatDatabase, packDatabase, checkPacked } from './data/introspect';
 export { configure } from './data/utilities/config';
 export { fieldProperties, fieldDefinition, fieldName, keyProperties, keyDefinition, indexType, indexLocation, referenceProperties, reference, recordProperties, recordDefinition, recordPath, entityPath } from './data/introspect';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -7,6 +7,18 @@ require("core-js/modules/esnext.iterator.drop.js");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "alter", {
+  enumerable: true,
+  get: function () {
+    return _introspect.alter;
+  }
+});
+Object.defineProperty(exports, "checkPacked", {
+  enumerable: true,
+  get: function () {
+    return _introspect.checkPacked;
+  }
+});
 Object.defineProperty(exports, "configure", {
   enumerable: true,
   get: function () {
@@ -31,6 +43,18 @@ Object.defineProperty(exports, "drop", {
     return _introspect.drop;
   }
 });
+Object.defineProperty(exports, "formatDatabase", {
+  enumerable: true,
+  get: function () {
+    return _introspect.formatDatabase;
+  }
+});
+Object.defineProperty(exports, "packDatabase", {
+  enumerable: true,
+  get: function () {
+    return _introspect.packDatabase;
+  }
+});
 Object.defineProperty(exports, "query", {
   enumerable: true,
   get: function () {

package/dist/index.min.js

@@ -1 +1 @@
-"use strict";require("core-js/modules/esnext.async-iterator.constructor.js"),require("core-js/modules/esnext.async-iterator.drop.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.drop.js"),Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"configure",{enumerable:!0,get:function(){return _config.configure}}),Object.defineProperty(exports,"create",{enumerable:!0,get:function(){return _introspect.create}}),Object.defineProperty(exports,"describe",{enumerable:!0,get:function(){return _introspect.describe}}),Object.defineProperty(exports,"drop",{enumerable:!0,get:function(){return _introspect.drop}}),Object.defineProperty(exports,"query",{enumerable:!0,get:function(){return _query.query}}),Object.defineProperty(exports,"queryStatus",{enumerable:!0,get:function(){return _queryStatus.queryStatus}}),Object.defineProperty(exports,"quote",{enumerable:!0,get:function(){return _quote.quote}});var _query=require("./data/queries/query"),_quote=require("./data/queries/quote"),_queryStatus=require("./data/queries/queryStatus"),_introspect=require("./data/introspect"),_config=require("./data/utilities/config");
+"use strict";require("core-js/modules/esnext.async-iterator.constructor.js"),require("core-js/modules/esnext.async-iterator.drop.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.drop.js"),Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"alter",{enumerable:!0,get:function(){return _introspect.alter}}),Object.defineProperty(exports,"checkPacked",{enumerable:!0,get:function(){return _introspect.checkPacked}}),Object.defineProperty(exports,"configure",{enumerable:!0,get:function(){return _config.configure}}),Object.defineProperty(exports,"create",{enumerable:!0,get:function(){return _introspect.create}}),Object.defineProperty(exports,"describe",{enumerable:!0,get:function(){return _introspect.describe}}),Object.defineProperty(exports,"drop",{enumerable:!0,get:function(){return _introspect.drop}}),Object.defineProperty(exports,"formatDatabase",{enumerable:!0,get:function(){return _introspect.formatDatabase}}),Object.defineProperty(exports,"packDatabase",{enumerable:!0,get:function(){return _introspect.packDatabase}}),Object.defineProperty(exports,"query",{enumerable:!0,get:function(){return _query.query}}),Object.defineProperty(exports,"queryStatus",{enumerable:!0,get:function(){return _queryStatus.queryStatus}}),Object.defineProperty(exports,"quote",{enumerable:!0,get:function(){return _quote.quote}});var _query=require("./data/queries/query"),_quote=require("./data/queries/quote"),_queryStatus=require("./data/queries/queryStatus"),_introspect=require("./data/introspect"),_config=require("./data/utilities/config");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "json-fs-query",
-  "version": "3.2.0",
-  "description": "Use json files to manage and read data.",
+  "version": "3.3.0",
+  "description": "A git-native JSON data store for static sites: JSON files with a schema, enforced keys and a SQL-like query language, read straight from static hosting.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "unpkg": "browser/jsonFsQuery.min.js",
@@ -35,7 +35,11 @@
     "database",
     "filesystem",
     "json",
-    "data"
+    "data",
+    "static-site",
+    "git",
+    "query",
+    "sql"
   ],
   "author": "Joshua Heagle <joshuaheagle@gmail.com>",
   "license": "GPL-3.0-or-later",