json-fs-query 3.1.4 → 3.2.0

package/dist/data/queries/updateEntity.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.updateEntity = void 0;
-require("core-js/modules/es.json.stringify.js");
 require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.find.js");
 require("core-js/modules/esnext.iterator.map.js");
@@ -22,21 +21,28 @@ var _foreignKeyExists = require("../introspect/policies/foreignKeyExists");
 var _hasDependents = require("../introspect/policies/hasDependents");
 var _splitEntityProperty = require("../utilities/parsers/splitEntityProperty");
 var _config = require("../utilities/config");
-const {
-  writeFile
-} = require('fs/promises');
+var _keyIndexFiles = require("../utilities/keyIndexFiles");
+var _storage = require("../storage");
 /**
  * Same reasoning as deleteEntity: a record object carries no memory of which entry file it came
- * from, so re-scan entries[] and match by the record's own primary key value(s) - a single field,
- * or a composite of several for a multi-field primary key.
+ * from, so find the file whose primary key value(s) match - a single field, or a composite of
+ * several for a multi-field primary key. The primary key's index says which file that is; the file
+ * is read to confirm it, and without an index (or when it leads nowhere) every entry is looked at
+ * in turn, as before.
  * @param record
  * @param primaryKey
  * @param primaryValue
  */
 const findEntryFile = async (record, primaryKey, primaryValue) => {
+  const type = (0, _fieldType.keyValueType)(record, primaryKey);
+  const isMatch = async fileName => (0, _compareAs.sameValue)(type, (0, _computeKeyValue.computeKeyValue)(primaryKey.fields, await (0, _retrieveFile.retrieveFile)(`${record.path}/${fileName}`)), primaryValue);
+  for (const fileName of (await (0, _keyIndexFiles.keyIndexFiles)(record, primaryKey, value => (0, _compareAs.sameValue)(type, value, primaryValue))) ?? []) {
+    if (await isMatch(fileName)) {
+      return fileName;
+    }
+  }
   for (const fileName of record.entries) {
-    const data = await (0, _retrieveFile.retrieveFile)(`${record.path}/${fileName}`);
-    if ((0, _compareAs.sameValue)((0, _fieldType.keyValueType)(record, primaryKey), (0, _computeKeyValue.computeKeyValue)(primaryKey.fields, data), primaryValue)) {
+    if (await isMatch(fileName)) {
       return fileName;
     }
   }
@@ -199,7 +205,6 @@ const applyFieldTypes = (record, values) => {
   return typedValues;
 };
 const updateEntity = async (entity = '', values = {}, dataSet = {}) => {
-  const databasePath = (0, _config.getSetting)('databasePath', 'database/');
   const record = await (0, _retrieveRecord.retrieveRecord)(entity);
   const primaryKey = record.keys.find(key => key.type === 'primary');
   if (!primaryKey) {
@@ -236,7 +241,7 @@ const updateEntity = async (entity = '', values = {}, dataSet = {}) => {
     newData
   } of planned) {
     await reconcileIndexes(record, oldData, newData, typedValues, fileName);
-    await writeFile(`${databasePath}${record.path}/${fileName}`, JSON.stringify(newData, null, 2));
+    await (0, _storage.writeJson)(`${record.path}/${fileName}`, newData);
   }
   dataSet[entity] = planned.map(({
     newData

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.updateEntity=void 0,require("core-js/modules/es.json.stringify.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.find.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/esnext.iterator.some.js");var _retrieveRecord=require("../utilities/retrieveRecord"),_retrieveFile=require("../utilities/retrieveFile"),_updateIndex=require("../utilities/updateIndex"),_removeFromIndex=require("../utilities/removeFromIndex"),_computeKeyValue=require("../utilities/computeKeyValue"),_fieldType=require("../utilities/fieldType"),_compareAs=require("../utilities/compareAs"),_keyUnique=require("../introspect/policies/keyUnique"),_typeCheck=require("../introspect/policies/typeCheck"),_foreignKeyExists=require("../introspect/policies/foreignKeyExists"),_hasDependents=require("../introspect/policies/hasDependents"),_splitEntityProperty=require("../utilities/parsers/splitEntityProperty"),_config=require("../utilities/config");const{writeFile:writeFile}=require("fs/promises"),findEntryFile=async(e,t,i)=>{for(const r of e.entries){const o=await(0,_retrieveFile.retrieveFile)(`${e.path}/${r}`);if((0,_compareAs.sameValue)((0,_fieldType.keyValueType)(e,t),(0,_computeKeyValue.computeKeyValue)(t.fields,o),i))return r}return null},keyFieldsChanged=(e,t,i,r)=>t.fields.some((t=>Object.prototype.hasOwnProperty.call(r,t)&&!(0,_compareAs.sameValue)((0,_fieldType.fieldType)(e,t),r[t],i[t]))),assertUniqueForUpdate=async(e,t,i,r,o)=>{for(const s of t.keys){if("primary"!==s.type&&"unique"!==s.type||!keyFieldsChanged(t,s,i,o))continue;const n=s.fields.map((e=>r[e]));if(n.some((e=>null===e)))continue;if(!await(0,_keyUnique.keyUnique)(e,s.fields,n))throw new Error(`Duplicate value for ${s.type} key "${s.fields.join(", ")}" on ${e}`)}},assertForeignKeysForUpdate=async(e,t,i,r)=>{for(const o of t.keys){if("foreign"!==o.type||1!==o.fields.length||!o.references||1!==o.references.length)continue;const s=o.fields[0];if(!Object.prototype.hasOwnProperty.call(r,s)||null===r[s]||(0,_compareAs.sameValue)((0,_fieldType.fieldType)(t,s),r[s],i[s]))continue;const{entity:n,property:a}=(0,_splitEntityProperty.splitEntityProperty)(o.references[0].fields[0]);if(!await(0,_foreignKeyExists.foreignKeyExists)(n,a,r[s]))throw new Error(`Foreign key "${s}" on ${e} references a nonexistent ${n}.${a} = ${r[s]}`)}},assertNoDependentsForUpdate=async(e,t,i,r,o)=>{if(!(0,_config.getSetting)("enforceForeignKeys",!0)||1!==i.fields.length||!keyFieldsChanged(t,i,r,o))return;const s=i.fields[0];if(await(0,_hasDependents.hasDependents)(e,s,r[s]))throw new Error(`Cannot update "${e}" where "${s}" = ${r[s]} - other records still reference it`)},reconcileIndexes=async(e,t,i,r,o)=>{for(const s of e.keys)keyFieldsChanged(e,s,t,r)&&(await(0,_removeFromIndex.removeFromIndex)(e.path,s,(0,_computeKeyValue.computeKeyValue)(s.fields,t),o,(0,_fieldType.keyValueType)(e,s)),await(0,_updateIndex.updateIndex)(e.path,s,(0,_computeKeyValue.computeKeyValue)(s.fields,i),o,(0,_fieldType.keyValueType)(e,s)))},assertUniqueWithinUpdate=(e,t,i,r)=>{for(const o of t.keys){if("primary"!==o.type&&"unique"!==o.type)continue;const s=[];for(const{oldData:n,newData:a}of i){if(!keyFieldsChanged(t,o,n,r)||o.fields.some((e=>null===a[e])))continue;const i=(0,_computeKeyValue.computeKeyValue)(o.fields,a);if(s.some((e=>(0,_compareAs.sameValue)((0,_fieldType.keyValueType)(t,o),e,i))))throw new Error(`Duplicate value for ${o.type} key "${o.fields.join(", ")}" on ${e}`);s.push(i)}}},assertRequiredFields=(e,t,i)=>{for(const r of t.definition)if(!r.optional&&void 0===i[r.name])throw new Error(`Missing required field "${r.name}" for ${e}`)},applyFieldTypes=(e,t)=>{const i=Object.assign({},t);for(const t of e.definition)Object.prototype.hasOwnProperty.call(i,t.name)&&(i[t.name]=(0,_typeCheck.typeCheck)(t.type,i[t.name],t.nullable));return i},updateEntity=async(e="",t={},i={})=>{const r=(0,_config.getSetting)("databasePath","database/"),o=await(0,_retrieveRecord.retrieveRecord)(e),s=o.keys.find((e=>"primary"===e.type));if(!s)throw new Error(`Cannot update "${e}" without a primary key`);const n=applyFieldTypes(o,t),a=[];for(const t of i[e]||[]){const i=await findEntryFile(o,s,(0,_computeKeyValue.computeKeyValue)(s.fields,t));if(!i)throw new Error(`Could not find entry for ${e} where "${s.fields.join(", ")}" = ${(0,_computeKeyValue.computeKeyValue)(s.fields,t)}`);if(a.some((e=>e.fileName===i)))continue;const r=await(0,_retrieveFile.retrieveFile)(`${o.path}/${i}`),l=Object.assign({},r,n);await assertUniqueForUpdate(e,o,r,l,n),await assertForeignKeysForUpdate(e,o,r,n),await assertNoDependentsForUpdate(e,o,s,r,n),assertRequiredFields(e,o,l),a.push({fileName:i,oldData:r,newData:l})}assertUniqueWithinUpdate(e,o,a,n);for(const{fileName:e,oldData:t,newData:i}of a)await reconcileIndexes(o,t,i,n,e),await writeFile(`${r}${o.path}/${e}`,JSON.stringify(i,null,2));return i[e]=a.map((({newData:e})=>e)),i};exports.updateEntity=updateEntity;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.updateEntity=void 0,require("core-js/modules/esnext.iterator.constructor.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");var _retrieveRecord=require("../utilities/retrieveRecord"),_retrieveFile=require("../utilities/retrieveFile"),_updateIndex=require("../utilities/updateIndex"),_removeFromIndex=require("../utilities/removeFromIndex"),_computeKeyValue=require("../utilities/computeKeyValue"),_fieldType=require("../utilities/fieldType"),_compareAs=require("../utilities/compareAs"),_keyUnique=require("../introspect/policies/keyUnique"),_typeCheck=require("../introspect/policies/typeCheck"),_foreignKeyExists=require("../introspect/policies/foreignKeyExists"),_hasDependents=require("../introspect/policies/hasDependents"),_splitEntityProperty=require("../utilities/parsers/splitEntityProperty"),_config=require("../utilities/config"),_keyIndexFiles=require("../utilities/keyIndexFiles"),_storage=require("../storage");const findEntryFile=async(e,t,i)=>{const r=(0,_fieldType.keyValueType)(e,t),o=async o=>(0,_compareAs.sameValue)(r,(0,_computeKeyValue.computeKeyValue)(t.fields,await(0,_retrieveFile.retrieveFile)(`${e.path}/${o}`)),i);for(const s of await(0,_keyIndexFiles.keyIndexFiles)(e,t,(e=>(0,_compareAs.sameValue)(r,e,i)))??[])if(await o(s))return s;for(const t of e.entries)if(await o(t))return t;return null},keyFieldsChanged=(e,t,i,r)=>t.fields.some((t=>Object.prototype.hasOwnProperty.call(r,t)&&!(0,_compareAs.sameValue)((0,_fieldType.fieldType)(e,t),r[t],i[t]))),assertUniqueForUpdate=async(e,t,i,r,o)=>{for(const s of t.keys){if("primary"!==s.type&&"unique"!==s.type||!keyFieldsChanged(t,s,i,o))continue;const n=s.fields.map((e=>r[e]));if(n.some((e=>null===e)))continue;if(!await(0,_keyUnique.keyUnique)(e,s.fields,n))throw new Error(`Duplicate value for ${s.type} key "${s.fields.join(", ")}" on ${e}`)}},assertForeignKeysForUpdate=async(e,t,i,r)=>{for(const o of t.keys){if("foreign"!==o.type||1!==o.fields.length||!o.references||1!==o.references.length)continue;const s=o.fields[0];if(!Object.prototype.hasOwnProperty.call(r,s)||null===r[s]||(0,_compareAs.sameValue)((0,_fieldType.fieldType)(t,s),r[s],i[s]))continue;const{entity:n,property:a}=(0,_splitEntityProperty.splitEntityProperty)(o.references[0].fields[0]);if(!await(0,_foreignKeyExists.foreignKeyExists)(n,a,r[s]))throw new Error(`Foreign key "${s}" on ${e} references a nonexistent ${n}.${a} = ${r[s]}`)}},assertNoDependentsForUpdate=async(e,t,i,r,o)=>{if(!(0,_config.getSetting)("enforceForeignKeys",!0)||1!==i.fields.length||!keyFieldsChanged(t,i,r,o))return;const s=i.fields[0];if(await(0,_hasDependents.hasDependents)(e,s,r[s]))throw new Error(`Cannot update "${e}" where "${s}" = ${r[s]} - other records still reference it`)},reconcileIndexes=async(e,t,i,r,o)=>{for(const s of e.keys)keyFieldsChanged(e,s,t,r)&&(await(0,_removeFromIndex.removeFromIndex)(e.path,s,(0,_computeKeyValue.computeKeyValue)(s.fields,t),o,(0,_fieldType.keyValueType)(e,s)),await(0,_updateIndex.updateIndex)(e.path,s,(0,_computeKeyValue.computeKeyValue)(s.fields,i),o,(0,_fieldType.keyValueType)(e,s)))},assertUniqueWithinUpdate=(e,t,i,r)=>{for(const o of t.keys){if("primary"!==o.type&&"unique"!==o.type)continue;const s=[];for(const{oldData:n,newData:a}of i){if(!keyFieldsChanged(t,o,n,r)||o.fields.some((e=>null===a[e])))continue;const i=(0,_computeKeyValue.computeKeyValue)(o.fields,a);if(s.some((e=>(0,_compareAs.sameValue)((0,_fieldType.keyValueType)(t,o),e,i))))throw new Error(`Duplicate value for ${o.type} key "${o.fields.join(", ")}" on ${e}`);s.push(i)}}},assertRequiredFields=(e,t,i)=>{for(const r of t.definition)if(!r.optional&&void 0===i[r.name])throw new Error(`Missing required field "${r.name}" for ${e}`)},applyFieldTypes=(e,t)=>{const i=Object.assign({},t);for(const t of e.definition)Object.prototype.hasOwnProperty.call(i,t.name)&&(i[t.name]=(0,_typeCheck.typeCheck)(t.type,i[t.name],t.nullable));return i},updateEntity=async(e="",t={},i={})=>{const r=await(0,_retrieveRecord.retrieveRecord)(e),o=r.keys.find((e=>"primary"===e.type));if(!o)throw new Error(`Cannot update "${e}" without a primary key`);const s=applyFieldTypes(r,t),n=[];for(const t of i[e]||[]){const i=await findEntryFile(r,o,(0,_computeKeyValue.computeKeyValue)(o.fields,t));if(!i)throw new Error(`Could not find entry for ${e} where "${o.fields.join(", ")}" = ${(0,_computeKeyValue.computeKeyValue)(o.fields,t)}`);if(n.some((e=>e.fileName===i)))continue;const a=await(0,_retrieveFile.retrieveFile)(`${r.path}/${i}`),l=Object.assign({},a,s);await assertUniqueForUpdate(e,r,a,l,s),await assertForeignKeysForUpdate(e,r,a,s),await assertNoDependentsForUpdate(e,r,o,a,s),assertRequiredFields(e,r,l),n.push({fileName:i,oldData:a,newData:l})}assertUniqueWithinUpdate(e,r,n,s);for(const{fileName:e,oldData:t,newData:i}of n)await reconcileIndexes(r,t,i,s,e),await(0,_storage.writeJson)(`${r.path}/${e}`,i);return i[e]=n.map((({newData:e})=>e)),i};exports.updateEntity=updateEntity;

package/dist/data/storage/fileExists.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Whether a file (or folder) of the database exists. Node only, like the schema statements that use it.
+ * @param path - A path inside the database, such as `users.json`.
+ */
+export declare const fileExists: (path: string) => boolean;
+//# sourceMappingURL=fileExists.d.ts.map

package/dist/data/storage/fileExists.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fileExists = void 0;
+var _storagePath = require("./storagePath");
+/**
+ * Whether a file (or folder) of the database exists. Node only, like the schema statements that use it.
+ * @param path - A path inside the database, such as `users.json`.
+ */
+const fileExists = path => {
+  const {
+    existsSync
+  } = require('fs');
+  return existsSync((0, _storagePath.storagePath)(path));
+};
+exports.fileExists = fileExists;

package/dist/data/storage/fileExists.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.fileExists=void 0;var _storagePath=require("./storagePath");const fileExists=e=>{const{existsSync:s}=require("fs");return s((0,_storagePath.storagePath)(e))};exports.fileExists=fileExists;

package/dist/data/storage/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The storage layer: every file json-fs-query reads, writes or deletes goes through these functions, and nothing else
+ * touches `fs` or `fetch()`. Paths given to them are inside the database (see storagePath).
+ *
+ * Today there is one backend, JSON files (on disk in Node, over fetch() in a browser). Keeping it behind these few
+ * functions is what lets a read cache, batched writes and other storage backends come later without touching queries.
+ */
+export { storagePath } from './storagePath';
+export { readJson } from './readJson';
+export { writeJson } from './writeJson';
+export { makeDirectory } from './makeDirectory';
+export { removeFile } from './removeFile';
+export { removeDirectory } from './removeDirectory';
+export { fileExists } from './fileExists';
+export { withReadCache } from './readCache';
+//# sourceMappingURL=index.d.ts.map

package/dist/data/storage/index.js

@@ -0,0 +1,61 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "fileExists", {
+  enumerable: true,
+  get: function () {
+    return _fileExists.fileExists;
+  }
+});
+Object.defineProperty(exports, "makeDirectory", {
+  enumerable: true,
+  get: function () {
+    return _makeDirectory.makeDirectory;
+  }
+});
+Object.defineProperty(exports, "readJson", {
+  enumerable: true,
+  get: function () {
+    return _readJson.readJson;
+  }
+});
+Object.defineProperty(exports, "removeDirectory", {
+  enumerable: true,
+  get: function () {
+    return _removeDirectory.removeDirectory;
+  }
+});
+Object.defineProperty(exports, "removeFile", {
+  enumerable: true,
+  get: function () {
+    return _removeFile.removeFile;
+  }
+});
+Object.defineProperty(exports, "storagePath", {
+  enumerable: true,
+  get: function () {
+    return _storagePath.storagePath;
+  }
+});
+Object.defineProperty(exports, "withReadCache", {
+  enumerable: true,
+  get: function () {
+    return _readCache.withReadCache;
+  }
+});
+Object.defineProperty(exports, "writeJson", {
+  enumerable: true,
+  get: function () {
+    return _writeJson.writeJson;
+  }
+});
+var _storagePath = require("./storagePath");
+var _readJson = require("./readJson");
+var _writeJson = require("./writeJson");
+var _makeDirectory = require("./makeDirectory");
+var _removeFile = require("./removeFile");
+var _removeDirectory = require("./removeDirectory");
+var _fileExists = require("./fileExists");
+var _readCache = require("./readCache");

package/dist/data/storage/index.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"fileExists",{enumerable:!0,get:function(){return _fileExists.fileExists}}),Object.defineProperty(exports,"makeDirectory",{enumerable:!0,get:function(){return _makeDirectory.makeDirectory}}),Object.defineProperty(exports,"readJson",{enumerable:!0,get:function(){return _readJson.readJson}}),Object.defineProperty(exports,"removeDirectory",{enumerable:!0,get:function(){return _removeDirectory.removeDirectory}}),Object.defineProperty(exports,"removeFile",{enumerable:!0,get:function(){return _removeFile.removeFile}}),Object.defineProperty(exports,"storagePath",{enumerable:!0,get:function(){return _storagePath.storagePath}}),Object.defineProperty(exports,"withReadCache",{enumerable:!0,get:function(){return _readCache.withReadCache}}),Object.defineProperty(exports,"writeJson",{enumerable:!0,get:function(){return _writeJson.writeJson}});var _storagePath=require("./storagePath"),_readJson=require("./readJson"),_writeJson=require("./writeJson"),_makeDirectory=require("./makeDirectory"),_removeFile=require("./removeFile"),_removeDirectory=require("./removeDirectory"),_fileExists=require("./fileExists"),_readCache=require("./readCache");

package/dist/data/storage/makeDirectory.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Create a folder of the database, and any missing folders above it (doing nothing if it already exists). Node only.
+ * @param path - A path inside the database, such as `users`. Empty for the database folder itself.
+ */
+export declare const makeDirectory: (path?: string) => Promise<void>;
+//# sourceMappingURL=makeDirectory.d.ts.map

package/dist/data/storage/makeDirectory.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.makeDirectory = void 0;
+var _storagePath = require("./storagePath");
+var _nodeFiles = require("./nodeFiles");
+/**
+ * Create a folder of the database, and any missing folders above it (doing nothing if it already exists). Node only.
+ * @param path - A path inside the database, such as `users`. Empty for the database folder itself.
+ */
+const makeDirectory = async (path = '') => {
+  await (0, _nodeFiles.nodeFiles)().mkdir((0, _storagePath.storagePath)(path), {
+    recursive: true
+  });
+};
+exports.makeDirectory = makeDirectory;

package/dist/data/storage/makeDirectory.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.makeDirectory=void 0;var _storagePath=require("./storagePath"),_nodeFiles=require("./nodeFiles");const makeDirectory=async(e="")=>{await(0,_nodeFiles.nodeFiles)().mkdir((0,_storagePath.storagePath)(e),{recursive:!0})};exports.makeDirectory=makeDirectory;

package/dist/data/storage/nodeFiles.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Node's `fs/promises`, loaded when a storage function runs rather than when the module is imported, so the browser
+ * bundle (which leaves `fs` out) can still import the storage module.
+ */
+export declare const nodeFiles: () => any;
+//# sourceMappingURL=nodeFiles.d.ts.map

package/dist/data/storage/nodeFiles.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.nodeFiles = void 0;
+/**
+ * Node's `fs/promises`, loaded when a storage function runs rather than when the module is imported, so the browser
+ * bundle (which leaves `fs` out) can still import the storage module.
+ */
+const nodeFiles = () => require('fs/promises');
+exports.nodeFiles = nodeFiles;

package/dist/data/storage/nodeFiles.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.nodeFiles=void 0;const nodeFiles=()=>require("fs/promises");exports.nodeFiles=nodeFiles;

package/dist/data/storage/readCache.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Run `task` with a read cache for the configured database: while it runs, each file is read from storage once and
+ * later reads of it are answered from memory, so a join no longer reads the joined record's files again for every row.
+ * Writes and deletes made during the task update the cache (see cacheWrite, cacheRemove), so a query reads its own
+ * writes. Outside any task nothing is cached and every read goes to storage, as before.
+ *
+ * The cache holds text, not parsed objects: every read parses its own copy, so a caller changing what it read (a join
+ * attaches rows to the rows it read) never changes what the next reader gets.
+ *
+ * withDatabaseLock runs every public call (query, create, drop, describe) inside one, so the cache lasts one call. In
+ * Node calls on one database never overlap (the lock queues them). In a browser they can, and a read can't tell which
+ * call it belongs to, so each call that starts empties the cache: calls still running carry on (only reading their
+ * files again), and nothing is older than the newest call, however long calls keep overlapping.
+ * @param task
+ */
+export declare const withReadCache: <T>(task: () => Promise<T>) => Promise<T>;
+/**
+ * The text of the file at `location`: from the cache when a call is running and the file was read (or written) during
+ * it, otherwise from `read`, kept for the rest of the call. A failed read isn't kept, so it fails (or succeeds) afresh
+ * the next time.
+ * @param location - The file's full location (see storagePath).
+ * @param read - Reads the file's text from storage.
+ */
+export declare const cachedRead: (location: string, read: () => Promise<string>) => Promise<string>;
+/**
+ * Keep the text just written to `location`, so the rest of the call reads it without going back to storage.
+ * @param location - The file's full location (see storagePath).
+ * @param text
+ */
+export declare const cacheWrite: (location: string, text: string) => void;
+/**
+ * Forget a removed file, or (with `folder`) everything under a removed folder.
+ * @param location - The full location (see storagePath) of the file or folder.
+ * @param folder - Whether `location` is a folder.
+ */
+export declare const cacheRemove: (location: string, folder?: boolean) => void;
+//# sourceMappingURL=readCache.d.ts.map

package/dist/data/storage/readCache.js

@@ -0,0 +1,117 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.withReadCache = exports.cachedRead = exports.cacheWrite = exports.cacheRemove = void 0;
+require("core-js/modules/esnext.map.delete-all.js");
+require("core-js/modules/esnext.map.every.js");
+require("core-js/modules/esnext.map.filter.js");
+require("core-js/modules/esnext.map.find.js");
+require("core-js/modules/esnext.map.find-key.js");
+require("core-js/modules/esnext.map.includes.js");
+require("core-js/modules/esnext.map.key-of.js");
+require("core-js/modules/esnext.map.map-keys.js");
+require("core-js/modules/esnext.map.map-values.js");
+require("core-js/modules/esnext.map.merge.js");
+require("core-js/modules/esnext.map.reduce.js");
+require("core-js/modules/esnext.map.some.js");
+require("core-js/modules/esnext.map.update.js");
+var _storagePath = require("./storagePath");
+const scopes = new Map();
+/**
+ * The scope of the database configured now (by its location, see storagePath), if a call on it is running.
+ */
+const currentScope = () => scopes.get((0, _storagePath.storagePath)());
+/**
+ * Run `task` with a read cache for the configured database: while it runs, each file is read from storage once and
+ * later reads of it are answered from memory, so a join no longer reads the joined record's files again for every row.
+ * Writes and deletes made during the task update the cache (see cacheWrite, cacheRemove), so a query reads its own
+ * writes. Outside any task nothing is cached and every read goes to storage, as before.
+ *
+ * The cache holds text, not parsed objects: every read parses its own copy, so a caller changing what it read (a join
+ * attaches rows to the rows it read) never changes what the next reader gets.
+ *
+ * withDatabaseLock runs every public call (query, create, drop, describe) inside one, so the cache lasts one call. In
+ * Node calls on one database never overlap (the lock queues them). In a browser they can, and a read can't tell which
+ * call it belongs to, so each call that starts empties the cache: calls still running carry on (only reading their
+ * files again), and nothing is older than the newest call, however long calls keep overlapping.
+ * @param task
+ */
+const withReadCache = async task => {
+  const database = (0, _storagePath.storagePath)();
+  const scope = scopes.get(database) || {
+    calls: 0,
+    files: new Map()
+  };
+  scopes.set(database, scope);
+  scope.calls++;
+  if (scope.calls > 1) {
+    scope.files = new Map();
+  }
+  try {
+    return await task();
+  } finally {
+    scope.calls--;
+    if (!scope.calls && scopes.get(database) === scope) {
+      scopes.delete(database);
+    }
+  }
+};
+/**
+ * The text of the file at `location`: from the cache when a call is running and the file was read (or written) during
+ * it, otherwise from `read`, kept for the rest of the call. A failed read isn't kept, so it fails (or succeeds) afresh
+ * the next time.
+ * @param location - The file's full location (see storagePath).
+ * @param read - Reads the file's text from storage.
+ */
+exports.withReadCache = withReadCache;
+const cachedRead = (location, read) => {
+  const scope = currentScope();
+  if (!scope) {
+    return read();
+  }
+  const cached = scope.files.get(location);
+  if (cached) {
+    return cached;
+  }
+  const reading = read();
+  scope.files.set(location, reading);
+  reading.catch(() => {
+    if (scope.files.get(location) === reading) {
+      scope.files.delete(location);
+    }
+  });
+  return reading;
+};
+/**
+ * Keep the text just written to `location`, so the rest of the call reads it without going back to storage.
+ * @param location - The file's full location (see storagePath).
+ * @param text
+ */
+exports.cachedRead = cachedRead;
+const cacheWrite = (location, text) => {
+  currentScope()?.files.set(location, Promise.resolve(text));
+};
+/**
+ * Forget a removed file, or (with `folder`) everything under a removed folder.
+ * @param location - The full location (see storagePath) of the file or folder.
+ * @param folder - Whether `location` is a folder.
+ */
+exports.cacheWrite = cacheWrite;
+const cacheRemove = (location, folder = false) => {
+  const scope = currentScope();
+  if (!scope) {
+    return;
+  }
+  scope.files.delete(location);
+  if (folder) {
+    const prefix = location.endsWith('/') ? location : `${location}/`;
+    for (const cachedLocation of [...scope.files.keys()]) {
+      if (cachedLocation.startsWith(prefix)) {
+        scope.files.delete(cachedLocation);
+      }
+    }
+  }
+};
+exports.cacheRemove = cacheRemove;

package/dist/data/storage/readCache.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.withReadCache=exports.cachedRead=exports.cacheWrite=exports.cacheRemove=void 0,require("core-js/modules/esnext.map.delete-all.js"),require("core-js/modules/esnext.map.every.js"),require("core-js/modules/esnext.map.filter.js"),require("core-js/modules/esnext.map.find.js"),require("core-js/modules/esnext.map.find-key.js"),require("core-js/modules/esnext.map.includes.js"),require("core-js/modules/esnext.map.key-of.js"),require("core-js/modules/esnext.map.map-keys.js"),require("core-js/modules/esnext.map.map-values.js"),require("core-js/modules/esnext.map.merge.js"),require("core-js/modules/esnext.map.reduce.js"),require("core-js/modules/esnext.map.some.js"),require("core-js/modules/esnext.map.update.js");var _storagePath=require("./storagePath");const scopes=new Map,currentScope=()=>scopes.get((0,_storagePath.storagePath)()),withReadCache=async e=>{const s=(0,_storagePath.storagePath)(),r=scopes.get(s)||{calls:0,files:new Map};scopes.set(s,r),r.calls++,r.calls>1&&(r.files=new Map);try{return await e()}finally{r.calls--,r.calls||scopes.get(s)!==r||scopes.delete(s)}};exports.withReadCache=withReadCache;const cachedRead=(e,s)=>{const r=currentScope();if(!r)return s();const t=r.files.get(e);if(t)return t;const c=s();return r.files.set(e,c),c.catch((()=>{r.files.get(e)===c&&r.files.delete(e)})),c};exports.cachedRead=cachedRead;const cacheWrite=(e,s)=>{currentScope()?.files.set(e,Promise.resolve(s))};exports.cacheWrite=cacheWrite;const cacheRemove=(e,s=!1)=>{const r=currentScope();if(r&&(r.files.delete(e),s)){const s=e.endsWith("/")?e:`${e}/`;for(const e of[...r.files.keys()])e.startsWith(s)&&r.files.delete(e)}};exports.cacheRemove=cacheRemove;

package/dist/data/storage/readJson.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Read and parse one JSON file of the database: from disk in Node, over `fetch()` in a browser (see storagePath for
+ * where it's looked for). During a call, a file already read is answered from the read cache (see withReadCache).
+ * @param path - A path inside the database, such as `users.json`.
+ * @throws {Error} When the file can't be read or isn't valid JSON (the error from the file system, fetch or JSON.parse).
+ */
+export declare const readJson: (path: string) => Promise<any>;
+//# sourceMappingURL=readJson.d.ts.map

package/dist/data/storage/readJson.js

@@ -0,0 +1,25 @@
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.readJson = void 0;
+var jsEnv = _interopRequireWildcard(require("browser-or-node"));
+var _storagePath = require("./storagePath");
+var _nodeFiles = require("./nodeFiles");
+var _readCache = require("./readCache");
+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; }
+/**
+ * Read and parse one JSON file of the database: from disk in Node, over `fetch()` in a browser (see storagePath for
+ * where it's looked for). During a call, a file already read is answered from the read cache (see withReadCache).
+ * @param path - A path inside the database, such as `users.json`.
+ * @throws {Error} When the file can't be read or isn't valid JSON (the error from the file system, fetch or JSON.parse).
+ */
+const readJson = async path => {
+  const location = (0, _storagePath.storagePath)(path);
+  const text = await (0, _readCache.cachedRead)(location, () => jsEnv.isNode ? (0, _nodeFiles.nodeFiles)().readFile(location, 'utf8') : fetch(location).then(response => response.text()));
+  return JSON.parse(text);
+};
+exports.readJson = readJson;

package/dist/data/storage/readJson.min.js

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.readJson=void 0;var e,jsEnv=_interopRequireWildcard(require("browser-or-node")),_storagePath=require("./storagePath"),_nodeFiles=require("./nodeFiles"),_readCache=require("./readCache");function _interopRequireWildcard(r,t){if(!t&&r&&r.__esModule)return r;var a,o,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(o in r)"default"!==o&&{}.hasOwnProperty.call(r,o)&&((a=s&&Object.getOwnPropertyDescriptor(r,o))&&(a.get||a.set)?s(n,o,a):n[o]=r[o]);return n}const readJson=async e=>{const r=(0,_storagePath.storagePath)(e),t=await(0,_readCache.cachedRead)(r,(()=>jsEnv.isNode?(0,_nodeFiles.nodeFiles)().readFile(r,"utf8"):fetch(r).then((e=>e.text()))));return JSON.parse(t)};exports.readJson=readJson;

package/dist/data/storage/removeDirectory.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Delete a folder of the database and everything in it; a folder that doesn't exist is left alone. Node only.
+ * @param path - A path inside the database, such as `__indexes/users`.
+ */
+export declare const removeDirectory: (path: string) => Promise<void>;
+//# sourceMappingURL=removeDirectory.d.ts.map

package/dist/data/storage/removeDirectory.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeDirectory = void 0;
+var _storagePath = require("./storagePath");
+var _nodeFiles = require("./nodeFiles");
+var _readCache = require("./readCache");
+/**
+ * Delete a folder of the database and everything in it; a folder that doesn't exist is left alone. Node only.
+ * @param path - A path inside the database, such as `__indexes/users`.
+ */
+const removeDirectory = async path => {
+  const location = (0, _storagePath.storagePath)(path);
+  // Forgotten before and after: a read that starts while rm runs would otherwise keep a removed file's old text
+  (0, _readCache.cacheRemove)(location, true);
+  await (0, _nodeFiles.nodeFiles)().rm(location, {
+    recursive: true,
+    force: true
+  });
+  (0, _readCache.cacheRemove)(location, true);
+};
+exports.removeDirectory = removeDirectory;

package/dist/data/storage/removeDirectory.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.removeDirectory=void 0;var _storagePath=require("./storagePath"),_nodeFiles=require("./nodeFiles"),_readCache=require("./readCache");const removeDirectory=async e=>{const r=(0,_storagePath.storagePath)(e);(0,_readCache.cacheRemove)(r,!0),await(0,_nodeFiles.nodeFiles)().rm(r,{recursive:!0,force:!0}),(0,_readCache.cacheRemove)(r,!0)};exports.removeDirectory=removeDirectory;

package/dist/data/storage/removeFile.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Delete one file of the database. Node only.
+ * @param path - A path inside the database, such as `users/1.json`.
+ * @throws {Error} When the file doesn't exist.
+ */
+export declare const removeFile: (path: string) => Promise<void>;
+//# sourceMappingURL=removeFile.d.ts.map

package/dist/data/storage/removeFile.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.removeFile = void 0;
+var _storagePath = require("./storagePath");
+var _nodeFiles = require("./nodeFiles");
+var _readCache = require("./readCache");
+/**
+ * Delete one file of the database. Node only.
+ * @param path - A path inside the database, such as `users/1.json`.
+ * @throws {Error} When the file doesn't exist.
+ */
+const removeFile = async path => {
+  const location = (0, _storagePath.storagePath)(path);
+  // Forgotten before and after: a read that starts while rm runs would otherwise keep the file's old text
+  (0, _readCache.cacheRemove)(location);
+  await (0, _nodeFiles.nodeFiles)().rm(location);
+  (0, _readCache.cacheRemove)(location);
+};
+exports.removeFile = removeFile;

package/dist/data/storage/removeFile.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.removeFile=void 0;var _storagePath=require("./storagePath"),_nodeFiles=require("./nodeFiles"),_readCache=require("./readCache");const removeFile=async e=>{const r=(0,_storagePath.storagePath)(e);(0,_readCache.cacheRemove)(r),await(0,_nodeFiles.nodeFiles)().rm(r),(0,_readCache.cacheRemove)(r)};exports.removeFile=removeFile;

package/dist/data/storage/storagePath.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Turn a path inside the database (such as `users.json` or `__indexes/users/name.json`) into the location the files
+ * backend uses: the configured databasePath in front of it, and in a browser also the relativePath (the URL prefix the
+ * database is served from).
+ *
+ * Every other part of json-fs-query names files by their path inside the database only; this is the one place that
+ * knows where the database is.
+ * @param path - A path inside the database, without a leading slash. Empty for the database folder itself.
+ */
+export declare const storagePath: (path?: string) => string;
+//# sourceMappingURL=storagePath.d.ts.map

package/dist/data/storage/storagePath.js

@@ -0,0 +1,25 @@
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.storagePath = void 0;
+var jsEnv = _interopRequireWildcard(require("browser-or-node"));
+var _config = require("../utilities/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; }
+/**
+ * Turn a path inside the database (such as `users.json` or `__indexes/users/name.json`) into the location the files
+ * backend uses: the configured databasePath in front of it, and in a browser also the relativePath (the URL prefix the
+ * database is served from).
+ *
+ * Every other part of json-fs-query names files by their path inside the database only; this is the one place that
+ * knows where the database is.
+ * @param path - A path inside the database, without a leading slash. Empty for the database folder itself.
+ */
+const storagePath = (path = '') => {
+  const relativePath = jsEnv.isBrowser ? (0, _config.getSetting)('relativePath', '') : '';
+  return `${relativePath}${(0, _config.getSetting)('databasePath', 'database/')}${path}`;
+};
+exports.storagePath = storagePath;

package/dist/data/storage/storagePath.min.js

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.storagePath=void 0;var e,jsEnv=_interopRequireWildcard(require("browser-or-node")),_config=require("../utilities/config");function _interopRequireWildcard(t,r){if(!r&&t&&t.__esModule)return t;var a,o,i=Object.defineProperty,s={__proto__:null,default:t};if(Object(t)!==t)return s;if(e||"function"!=typeof WeakMap||(e=new WeakMap),e){if(e.has(t))return e.get(t);e.set(t,s)}for(o in t)"default"!==o&&{}.hasOwnProperty.call(t,o)&&((a=i&&Object.getOwnPropertyDescriptor(t,o))&&(a.get||a.set)?i(s,o,a):s[o]=t[o]);return s}const storagePath=(e="")=>`${jsEnv.isBrowser?(0,_config.getSetting)("relativePath",""):""}${(0,_config.getSetting)("databasePath","database/")}${e}`;exports.storagePath=storagePath;

package/dist/data/storage/writeJson.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Write `content` to one file of the database as JSON (indented by 2 spaces), replacing the file if it exists. Its
+ * folder must already exist (see makeDirectory). Node only.
+ * @param path - A path inside the database, such as `users.json`.
+ * @param content - Anything JSON.stringify accepts.
+ */
+export declare const writeJson: (path: string, content: any) => Promise<void>;
+//# sourceMappingURL=writeJson.d.ts.map

package/dist/data/storage/writeJson.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.writeJson = void 0;
+require("core-js/modules/es.json.stringify.js");
+var _storagePath = require("./storagePath");
+var _nodeFiles = require("./nodeFiles");
+var _readCache = require("./readCache");
+/**
+ * Write `content` to one file of the database as JSON (indented by 2 spaces), replacing the file if it exists. Its
+ * folder must already exist (see makeDirectory). Node only.
+ * @param path - A path inside the database, such as `users.json`.
+ * @param content - Anything JSON.stringify accepts.
+ */
+const writeJson = async (path, content) => {
+  const location = (0, _storagePath.storagePath)(path);
+  const text = JSON.stringify(content, null, 2);
+  await (0, _nodeFiles.nodeFiles)().writeFile(location, text);
+  (0, _readCache.cacheWrite)(location, text);
+};
+exports.writeJson = writeJson;

package/dist/data/storage/writeJson.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.writeJson=void 0,require("core-js/modules/es.json.stringify.js");var _storagePath=require("./storagePath"),_nodeFiles=require("./nodeFiles"),_readCache=require("./readCache");const writeJson=async(e,r)=>{const s=(0,_storagePath.storagePath)(e),t=JSON.stringify(r,null,2);await(0,_nodeFiles.nodeFiles)().writeFile(s,t),(0,_readCache.cacheWrite)(s,t)};exports.writeJson=writeJson;

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

@@ -8,6 +8,7 @@
  * @param value
  */
 export declare const compareAs: (type: string | undefined, value: any) => any;
+export declare const comparableTypes: string[];
 /**
  * Whether two values are equal for a field of the given declared type: both are normalized to
  * that type (see compareAs) and compared strictly. A field with no declared type, or one that