json-fs-query 3.1.4 → 3.3.0

package/dist/data/queries/query.js

@@ -7,10 +7,12 @@ exports.query = void 0;
 var _parser = require("./parser");
 var _runQuery = require("../utilities/runQuery");
 var _databaseLock = require("../utilities/databaseLock");
+var _storage = require("../storage");
 /**
  * Parse a query string (one query, or several separated by `;`) and run each query in turn, resolving to one result
  * per query. The queries of one call run together, under the database lock: no other call's queries run between
- * them (see withDatabaseLock).
+ * them (see withDatabaseLock). Each query is all or nothing: one that fails changes nothing, and the queries before it
+ * keep their changes (see withWriteSet).
  * @param queryString
  */
 const query = async (queryString = '') => {
@@ -18,7 +20,8 @@ const query = async (queryString = '') => {
   return (0, _databaseLock.withDatabaseLock)(async () => {
     const queryResults = [];
     for (const parsed of parsedQueries) {
-      const dataSet = await (0, _runQuery.runQuery)(parsed);
+      // Each query's changes reach storage together, or not at all if it fails (see withWriteSet)
+      const dataSet = await (0, _storage.withWriteSet)(() => (0, _runQuery.runQuery)(parsed));
       queryResults.push(dataSet[parsed.entity]);
     }
     return queryResults;

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

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.query=void 0;var _parser=require("./parser"),_runQuery=require("../utilities/runQuery"),_databaseLock=require("../utilities/databaseLock");const query=async(e="")=>{const r=(0,_parser.parser)(e);return(0,_databaseLock.withDatabaseLock)((async()=>{const e=[];for(const t of r){const r=await(0,_runQuery.runQuery)(t);e.push(r[t.entity])}return e}))};exports.query=query;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.query=void 0;var _parser=require("./parser"),_runQuery=require("../utilities/runQuery"),_databaseLock=require("../utilities/databaseLock"),_storage=require("../storage");const query=async(e="")=>{const r=(0,_parser.parser)(e);return(0,_databaseLock.withDatabaseLock)((async()=>{const e=[];for(const t of r){const r=await(0,_storage.withWriteSet)((()=>(0,_runQuery.runQuery)(t)));e.push(r[t.entity])}return e}))};exports.query=query;

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

@@ -1,12 +1,13 @@
 import { ParsedSelect } from '../utilities/parsers/findSelects';
 import { Group } from './groupBy';
 /**
- * Shape each row down to only the selected properties (aliased, when given). dataSet is either a list of rows, or
- * (once groupBy has run) a list of groups, whose rows are shaped the same way at any depth; the groups keep their
- * field and value, selected or not.
+ * Shape each row down to only the selected properties (aliased, when given, otherwise named as written). dataSet is
+ * either a list of rows, or (once groupBy has run) a list of groups, whose rows are shaped the same way at any depth;
+ * the groups keep their field and value, selected or not.
  * @param dataSet
  * @param selectClauses
  * @param grouped Whether dataSet is a list of groups (see groupBy)
+ * @param entity The queried record's name, so `<record>.<field>` picks the row's own field
  */
-export declare const selectFields: (dataSet?: Object[] | Group[], selectClauses?: ParsedSelect[], grouped?: boolean) => Object[] | Group[];
+export declare const selectFields: (dataSet?: Object[] | Group[], selectClauses?: ParsedSelect[], grouped?: boolean, entity?: string) => Object[] | Group[];
 //# sourceMappingURL=selectFields.d.ts.map

package/dist/data/queries/selectFields.js

@@ -7,35 +7,49 @@ exports.selectFields = void 0;
 require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.map.js");
 require("core-js/modules/esnext.iterator.reduce.js");
-const shapeRow = (row, selectClauses) => selectClauses.reduce((shaped, {
+/**
+ * The value a select name picks from a row: the row's own key (a field, a merged record's `<record>.<field>`, or a
+ * joined record's rows), or for `<queried record>.<field>`, the row's own field.
+ * @param row
+ * @param property
+ * @param entity - The queried record's name.
+ */
+const pick = (row, property, entity) => {
+  if (Object.prototype.hasOwnProperty.call(row, property) || typeof entity === 'undefined' || !property.startsWith(`${entity}.`)) {
+    return row[property];
+  }
+  return row[property.slice(entity.length + 1)];
+};
+const shapeRow = (row, selectClauses, entity) => selectClauses.reduce((shaped, {
   property,
   alias
 }) => {
-  shaped[alias || property] = row[property];
+  shaped[alias || property] = pick(row, property, entity);
   return shaped;
 }, {});
-const shapeGroup = (group, selectClauses) => group.groups ? {
+const shapeGroup = (group, selectClauses, entity) => group.groups ? {
   ...group,
-  groups: group.groups.map(inner => shapeGroup(inner, selectClauses))
+  groups: group.groups.map(inner => shapeGroup(inner, selectClauses, entity))
 } : {
   ...group,
-  rows: group.rows.map(row => shapeRow(row, selectClauses))
+  rows: group.rows.map(row => shapeRow(row, selectClauses, entity))
 };
 /**
- * Shape each row down to only the selected properties (aliased, when given). dataSet is either a list of rows, or
- * (once groupBy has run) a list of groups, whose rows are shaped the same way at any depth; the groups keep their
- * field and value, selected or not.
+ * Shape each row down to only the selected properties (aliased, when given, otherwise named as written). dataSet is
+ * either a list of rows, or (once groupBy has run) a list of groups, whose rows are shaped the same way at any depth;
+ * the groups keep their field and value, selected or not.
  * @param dataSet
  * @param selectClauses
  * @param grouped Whether dataSet is a list of groups (see groupBy)
+ * @param entity The queried record's name, so `<record>.<field>` picks the row's own field
  */
-const selectFields = (dataSet = [], selectClauses = [], grouped = false) => {
+const selectFields = (dataSet = [], selectClauses = [], grouped = false, entity) => {
   if (!selectClauses.length) {
     return dataSet;
   }
   if (grouped) {
-    return dataSet.map(group => shapeGroup(group, selectClauses));
+    return dataSet.map(group => shapeGroup(group, selectClauses, entity));
   }
-  return dataSet.map(row => shapeRow(row, selectClauses));
+  return dataSet.map(row => shapeRow(row, selectClauses, entity));
 };
 exports.selectFields = selectFields;

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

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

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,30 @@ 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");
+var _packedTable = require("../utilities/packedTable");
+var _knownFields = require("../utilities/knownFields");
 /**
  * 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;
     }
   }
@@ -68,7 +76,8 @@ const assertUniqueForUpdate = async (entity, record, oldData, newData, newValues
       continue;
     }
     const checkKeys = key.fields.map(field => newData[field]);
-    if (checkKeys.some(value => value === null)) {
+    // A null, or a field the row doesn't have (left out, or removed by this update), is never a duplicate
+    if (checkKeys.some(value => value === null || typeof value === 'undefined')) {
       continue;
     }
     const isUnique = await (0, _keyUnique.keyUnique)(entity, key.fields, checkKeys);
@@ -93,7 +102,8 @@ const assertForeignKeysForUpdate = async (entity, record, oldData, newValues) =>
       continue;
     }
     const field = key.fields[0];
-    if (!Object.prototype.hasOwnProperty.call(newValues, field) || newValues[field] === null || (0, _compareAs.sameValue)((0, _fieldType.fieldType)(record, field), newValues[field], oldData[field])) {
+    // A null, or a field the update removes (undefined), references nothing
+    if (!Object.prototype.hasOwnProperty.call(newValues, field) || newValues[field] === null || typeof newValues[field] === 'undefined' || (0, _compareAs.sameValue)((0, _fieldType.fieldType)(record, field), newValues[field], oldData[field])) {
       continue;
     }
     const {
@@ -163,7 +173,7 @@ const assertUniqueWithinUpdate = (entity, record, planned, newValues) => {
       oldData,
       newData
     } of planned) {
-      if (!keyFieldsChanged(record, key, oldData, newValues) || key.fields.some(field => newData[field] === null)) {
+      if (!keyFieldsChanged(record, key, oldData, newValues) || key.fields.some(field => newData[field] === null || typeof newData[field] === 'undefined')) {
         continue;
       }
       const value = (0, _computeKeyValue.computeKeyValue)(key.fields, newData);
@@ -186,6 +196,11 @@ const assertRequiredFields = (entity, record, newData) => {
  * of the merged record - a field whose already-stored value doesn't match its declared type
  * (nothing enforced this before typeCheck() existed) must not block an update that never touches
  * that field.
+ *
+ * A null for an optional field that isn't nullable means the field is removed from the row (the
+ * field can't hold null, so this is the only thing it can mean, and the only way to clear one):
+ * it's kept as undefined here, so the key checks and indexes see the field change, and removed from
+ * the row that's written (see withoutRemoved).
  * @param record
  * @param values
  */
@@ -193,19 +208,40 @@ const applyFieldTypes = (record, values) => {
   const typedValues = Object.assign({}, values);
   for (const field of record.definition) {
     if (Object.prototype.hasOwnProperty.call(typedValues, field.name)) {
-      typedValues[field.name] = (0, _typeCheck.typeCheck)(field.type, typedValues[field.name], field.nullable);
+      typedValues[field.name] = typedValues[field.name] === null && field.optional && !field.nullable ? undefined : (0, _typeCheck.typeCheck)(field.type, typedValues[field.name], field.nullable);
     }
   }
   return typedValues;
 };
+/**
+ * A row without the fields an update removes (those it set to undefined, see applyFieldTypes).
+ * @param row
+ * @param typedValues
+ */
+const withoutRemoved = (row, typedValues) => {
+  const kept = Object.assign({}, row);
+  for (const field of Object.keys(typedValues)) {
+    if (typeof typedValues[field] === 'undefined') {
+      delete kept[field];
+    }
+  }
+  return kept;
+};
 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) {
     throw new Error(`Cannot update "${entity}" without a primary key`);
   }
+  // A field the record doesn't define would otherwise be stored outside its definition
+  (0, _knownFields.assertFieldsDefined)(entity, record, Object.keys(values || {}), 'set');
   const typedValues = applyFieldTypes(record, values);
+  // A row is found by its primary key, so none of its fields can be cleared (an optional one could be, by null)
+  for (const field of primaryKey.fields) {
+    if (Object.prototype.hasOwnProperty.call(typedValues, field) && typeof typedValues[field] === 'undefined') {
+      throw new Error(`Cannot clear "${field}" on ${entity}: it's part of the primary key`);
+    }
+  }
   // Check every row first and write only once all of them pass, so a row that fails leaves the others unchanged too
   const planned = [];
   for (const row of dataSet[entity] || []) {
@@ -218,7 +254,7 @@ const updateEntity = async (entity = '', values = {}, dataSet = {}) => {
       continue;
     }
     const oldData = await (0, _retrieveFile.retrieveFile)(`${record.path}/${fileName}`);
-    const newData = Object.assign({}, oldData, typedValues);
+    const newData = withoutRemoved(Object.assign({}, oldData, typedValues), typedValues);
     await assertUniqueForUpdate(entity, record, oldData, newData, typedValues);
     await assertForeignKeysForUpdate(entity, record, oldData, typedValues);
     await assertNoDependentsForUpdate(entity, record, primaryKey, oldData, typedValues);
@@ -230,13 +266,16 @@ const updateEntity = async (entity = '', values = {}, dataSet = {}) => {
     });
   }
   assertUniqueWithinUpdate(entity, record, planned, typedValues);
+  if (planned.length) {
+    await (0, _packedTable.discardPacked)(record.path);
+  }
   for (const {
     fileName,
     oldData,
     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"),_packedTable=require("../utilities/packedTable"),_knownFields=require("../utilities/knownFields");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]||void 0===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]||void 0===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]=null===i[t.name]&&t.optional&&!t.nullable?void 0:(0,_typeCheck.typeCheck)(t.type,i[t.name],t.nullable));return i},withoutRemoved=(e,t)=>{const i=Object.assign({},e);for(const e of Object.keys(t))void 0===t[e]&&delete i[e];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`);(0,_knownFields.assertFieldsDefined)(e,r,Object.keys(t||{}),"set");const s=applyFieldTypes(r,t);for(const t of o.fields)if(Object.prototype.hasOwnProperty.call(s,t)&&void 0===s[t])throw new Error(`Cannot clear "${t}" on ${e}: it's part of the primary key`);const 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=withoutRemoved(Object.assign({},a,s),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),n.length&&await(0,_packedTable.discardPacked)(r.path);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/databases.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Where something in the folder holding the databases is (see databasesFolder), as storagePath gives it for a database:
+ * on disk in Node, behind relativePath over fetch() in a browser.
+ * @param path - A path inside that folder, such as `__DATABASES.json` or a database's name.
+ */
+export declare const databasesLocation: (path?: string) => string;
+/**
+ * The databases' names, in the order they were created, from `__DATABASES.json` in the folder holding them (a list, so
+ * a browser can read it too: it can't list a folder). No list yet means no databases.
+ */
+export declare const readDatabaseList: () => Promise<string[]>;
+/**
+ * Replace the list of databases. Node only.
+ * @param names
+ */
+export declare const writeDatabaseList: (names: string[]) => Promise<void>;
+/**
+ * Whether a database's folder exists. Node only.
+ * @param name
+ */
+export declare const databaseFolderExists: (name: string) => boolean;
+/**
+ * Create a database's (empty) folder. Node only.
+ * @param name
+ */
+export declare const makeDatabaseFolder: (name: string) => Promise<void>;
+/**
+ * Delete a database's folder and everything in it, and forget anything read from it. Node only.
+ * @param name
+ */
+export declare const removeDatabaseFolder: (name: string) => Promise<void>;
+//# sourceMappingURL=databases.d.ts.map

package/dist/data/storage/databases.js

@@ -0,0 +1,93 @@
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.writeDatabaseList = exports.removeDatabaseFolder = exports.readDatabaseList = exports.makeDatabaseFolder = exports.databasesLocation = exports.databaseFolderExists = void 0;
+require("core-js/modules/es.json.stringify.js");
+var jsEnv = _interopRequireWildcard(require("browser-or-node"));
+var _config = require("../utilities/config");
+var _nodeFiles = require("./nodeFiles");
+var _readCache = require("./readCache");
+var _writeSet = require("./writeSet");
+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 something in the folder holding the databases is (see databasesFolder), as storagePath gives it for a database:
+ * on disk in Node, behind relativePath over fetch() in a browser.
+ * @param path - A path inside that folder, such as `__DATABASES.json` or a database's name.
+ */
+const databasesLocation = (path = '') => {
+  const relativePath = jsEnv.isBrowser ? (0, _config.getSetting)('relativePath', '') : '';
+  return `${relativePath}${(0, _config.databasesFolder)()}${path}`;
+};
+exports.databasesLocation = databasesLocation;
+const listLocation = () => databasesLocation('__DATABASES.json');
+/**
+ * The databases' names, in the order they were created, from `__DATABASES.json` in the folder holding them (a list, so
+ * a browser can read it too: it can't list a folder). No list yet means no databases.
+ */
+const readDatabaseList = async () => {
+  let text;
+  try {
+    text = jsEnv.isNode ? await (0, _nodeFiles.nodeFiles)().readFile(listLocation(), 'utf8') : await fetch(listLocation()).then(response => response.ok === false ? '[]' : response.text());
+  } catch (error) {
+    if (jsEnv.isNode && error?.code !== 'ENOENT') {
+      throw error;
+    }
+    return [];
+  }
+  try {
+    const names = JSON.parse(text);
+    return Array.isArray(names) ? names : [];
+  } catch (error) {
+    // A static host answers a missing file with a page that isn't JSON
+    if (!jsEnv.isNode) {
+      return [];
+    }
+    throw new Error(`Could not read ${listLocation()}: ${error.message}`);
+  }
+};
+/**
+ * Replace the list of databases. Node only.
+ * @param names
+ */
+exports.readDatabaseList = readDatabaseList;
+const writeDatabaseList = async names => {
+  await (0, _nodeFiles.nodeFiles)().mkdir(databasesLocation(), {
+    recursive: true
+  });
+  await (0, _writeSet.writeAtomically)(listLocation(), JSON.stringify(names));
+};
+/**
+ * Whether a database's folder exists. Node only.
+ * @param name
+ */
+exports.writeDatabaseList = writeDatabaseList;
+const databaseFolderExists = name => require('fs').existsSync(databasesLocation(name));
+/**
+ * Create a database's (empty) folder. Node only.
+ * @param name
+ */
+exports.databaseFolderExists = databaseFolderExists;
+const makeDatabaseFolder = async name => {
+  await (0, _nodeFiles.nodeFiles)().mkdir(databasesLocation(name), {
+    recursive: true
+  });
+};
+/**
+ * Delete a database's folder and everything in it, and forget anything read from it. Node only.
+ * @param name
+ */
+exports.makeDatabaseFolder = makeDatabaseFolder;
+const removeDatabaseFolder = async name => {
+  const location = databasesLocation(name);
+  (0, _readCache.cacheRemove)(location, true);
+  await (0, _nodeFiles.nodeFiles)().rm(location, {
+    recursive: true,
+    force: true
+  });
+  (0, _readCache.cacheRemove)(location, true);
+};
+exports.removeDatabaseFolder = removeDatabaseFolder;

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

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.writeDatabaseList=exports.removeDatabaseFolder=exports.readDatabaseList=exports.makeDatabaseFolder=exports.databasesLocation=exports.databaseFolderExists=void 0,require("core-js/modules/es.json.stringify.js");var e,jsEnv=_interopRequireWildcard(require("browser-or-node")),_config=require("../utilities/config"),_nodeFiles=require("./nodeFiles"),_readCache=require("./readCache"),_writeSet=require("./writeSet");function _interopRequireWildcard(a,t){if(!t&&a&&a.__esModule)return a;var s,r,o=Object.defineProperty,i={__proto__:null,default:a};if(Object(a)!==a)return i;if(e||"function"!=typeof WeakMap||(e=new WeakMap),e){if(e.has(a))return e.get(a);e.set(a,i)}for(r in a)"default"!==r&&{}.hasOwnProperty.call(a,r)&&((s=o&&Object.getOwnPropertyDescriptor(a,r))&&(s.get||s.set)?o(i,r,s):i[r]=a[r]);return i}const databasesLocation=(e="")=>`${jsEnv.isBrowser?(0,_config.getSetting)("relativePath",""):""}${(0,_config.databasesFolder)()}${e}`;exports.databasesLocation=databasesLocation;const listLocation=()=>databasesLocation("__DATABASES.json"),readDatabaseList=async()=>{let e;try{e=jsEnv.isNode?await(0,_nodeFiles.nodeFiles)().readFile(listLocation(),"utf8"):await fetch(listLocation()).then((e=>!1===e.ok?"[]":e.text()))}catch(e){if(jsEnv.isNode&&"ENOENT"!==e?.code)throw e;return[]}try{const a=JSON.parse(e);return Array.isArray(a)?a:[]}catch(e){if(!jsEnv.isNode)return[];throw new Error(`Could not read ${listLocation()}: ${e.message}`)}};exports.readDatabaseList=readDatabaseList;const writeDatabaseList=async e=>{await(0,_nodeFiles.nodeFiles)().mkdir(databasesLocation(),{recursive:!0}),await(0,_writeSet.writeAtomically)(listLocation(),JSON.stringify(e))};exports.writeDatabaseList=writeDatabaseList;const databaseFolderExists=e=>require("fs").existsSync(databasesLocation(e));exports.databaseFolderExists=databaseFolderExists;const makeDatabaseFolder=async e=>{await(0,_nodeFiles.nodeFiles)().mkdir(databasesLocation(e),{recursive:!0})};exports.makeDatabaseFolder=makeDatabaseFolder;const removeDatabaseFolder=async e=>{const a=databasesLocation(e);(0,_readCache.cacheRemove)(a,!0),await(0,_nodeFiles.nodeFiles)().rm(a,{recursive:!0,force:!0}),(0,_readCache.cacheRemove)(a,!0)};exports.removeDatabaseFolder=removeDatabaseFolder;

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

@@ -0,0 +1,7 @@
+/**
+ * Whether a file (or folder) of the database exists, counting what the running statement has written or deleted so
+ * far (see withWriteSet). 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,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fileExists = void 0;
+var _storagePath = require("./storagePath");
+var _writeSet = require("./writeSet");
+/**
+ * Whether a file (or folder) of the database exists, counting what the running statement has written or deleted so
+ * far (see withWriteSet). Node only, like the schema statements that use it.
+ * @param path - A path inside the database, such as `users.json`.
+ */
+const fileExists = path => {
+  const location = (0, _storagePath.storagePath)(path);
+  const pending = (0, _writeSet.pendingExists)(location);
+  if (pending !== undefined) {
+    return pending;
+  }
+  const {
+    existsSync
+  } = require('fs');
+  return existsSync(location);
+};
+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"),_writeSet=require("./writeSet");const fileExists=e=>{const t=(0,_storagePath.storagePath)(e),s=(0,_writeSet.pendingExists)(t);if(void 0!==s)return s;const{existsSync:r}=require("fs");return r(t)};exports.fileExists=fileExists;

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

@@ -0,0 +1,19 @@
+/**
+ * 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, readText } from './readJson';
+export { writeJson, jsonText } from './writeJson';
+export { makeDirectory } from './makeDirectory';
+export { removeFile } from './removeFile';
+export { removeDirectory } from './removeDirectory';
+export { fileExists } from './fileExists';
+export { listFiles } from './listFiles';
+export { databasesLocation, readDatabaseList, writeDatabaseList, databaseFolderExists, makeDatabaseFolder, removeDatabaseFolder } from './databases';
+export { withReadCache } from './readCache';
+export { withWriteSet } from './writeSet';
+//# sourceMappingURL=index.d.ts.map

package/dist/data/storage/index.js

@@ -0,0 +1,124 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "databaseFolderExists", {
+  enumerable: true,
+  get: function () {
+    return _databases.databaseFolderExists;
+  }
+});
+Object.defineProperty(exports, "databasesLocation", {
+  enumerable: true,
+  get: function () {
+    return _databases.databasesLocation;
+  }
+});
+Object.defineProperty(exports, "fileExists", {
+  enumerable: true,
+  get: function () {
+    return _fileExists.fileExists;
+  }
+});
+Object.defineProperty(exports, "jsonText", {
+  enumerable: true,
+  get: function () {
+    return _writeJson.jsonText;
+  }
+});
+Object.defineProperty(exports, "listFiles", {
+  enumerable: true,
+  get: function () {
+    return _listFiles.listFiles;
+  }
+});
+Object.defineProperty(exports, "makeDatabaseFolder", {
+  enumerable: true,
+  get: function () {
+    return _databases.makeDatabaseFolder;
+  }
+});
+Object.defineProperty(exports, "makeDirectory", {
+  enumerable: true,
+  get: function () {
+    return _makeDirectory.makeDirectory;
+  }
+});
+Object.defineProperty(exports, "readDatabaseList", {
+  enumerable: true,
+  get: function () {
+    return _databases.readDatabaseList;
+  }
+});
+Object.defineProperty(exports, "readJson", {
+  enumerable: true,
+  get: function () {
+    return _readJson.readJson;
+  }
+});
+Object.defineProperty(exports, "readText", {
+  enumerable: true,
+  get: function () {
+    return _readJson.readText;
+  }
+});
+Object.defineProperty(exports, "removeDatabaseFolder", {
+  enumerable: true,
+  get: function () {
+    return _databases.removeDatabaseFolder;
+  }
+});
+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, "withWriteSet", {
+  enumerable: true,
+  get: function () {
+    return _writeSet.withWriteSet;
+  }
+});
+Object.defineProperty(exports, "writeDatabaseList", {
+  enumerable: true,
+  get: function () {
+    return _databases.writeDatabaseList;
+  }
+});
+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 _listFiles = require("./listFiles");
+var _databases = require("./databases");
+var _readCache = require("./readCache");
+var _writeSet = require("./writeSet");

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"databaseFolderExists",{enumerable:!0,get:function(){return _databases.databaseFolderExists}}),Object.defineProperty(exports,"databasesLocation",{enumerable:!0,get:function(){return _databases.databasesLocation}}),Object.defineProperty(exports,"fileExists",{enumerable:!0,get:function(){return _fileExists.fileExists}}),Object.defineProperty(exports,"jsonText",{enumerable:!0,get:function(){return _writeJson.jsonText}}),Object.defineProperty(exports,"listFiles",{enumerable:!0,get:function(){return _listFiles.listFiles}}),Object.defineProperty(exports,"makeDatabaseFolder",{enumerable:!0,get:function(){return _databases.makeDatabaseFolder}}),Object.defineProperty(exports,"makeDirectory",{enumerable:!0,get:function(){return _makeDirectory.makeDirectory}}),Object.defineProperty(exports,"readDatabaseList",{enumerable:!0,get:function(){return _databases.readDatabaseList}}),Object.defineProperty(exports,"readJson",{enumerable:!0,get:function(){return _readJson.readJson}}),Object.defineProperty(exports,"readText",{enumerable:!0,get:function(){return _readJson.readText}}),Object.defineProperty(exports,"removeDatabaseFolder",{enumerable:!0,get:function(){return _databases.removeDatabaseFolder}}),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,"withWriteSet",{enumerable:!0,get:function(){return _writeSet.withWriteSet}}),Object.defineProperty(exports,"writeDatabaseList",{enumerable:!0,get:function(){return _databases.writeDatabaseList}}),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"),_listFiles=require("./listFiles"),_databases=require("./databases"),_readCache=require("./readCache"),_writeSet=require("./writeSet");

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

@@ -0,0 +1,8 @@
+/**
+ * Every file in a folder of the database and the folders inside it, as paths inside the database (such as
+ * `users/1.json`), sorted. During a statement it counts what the statement has written or deleted (see withWriteSet).
+ * A folder that doesn't exist has no files. Node only.
+ * @param path - A path inside the database, such as `users`. Empty for the whole database.
+ */
+export declare const listFiles: (path?: string) => Promise<string[]>;
+//# sourceMappingURL=listFiles.d.ts.map