json-fs-query 1.0.5 → 1.1.0

package/dist/data/introspect/create.js

@@ -1,47 +1,47 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.create = void 0;
-require("core-js/modules/es.json.stringify.js");
-var _record = require("./definitions/record");
-var _registerRecord = require("../utilities/registerRecord");
-var _config = require("../utilities/config");
-/**
- * Create a new record.
- * @param recordName
- * @param definition
- * @param keys
- */
-const create = async (recordName, definition = [], keys = []) => {
-  const {
-    writeFile,
-    mkdir
-  } = require('fs/promises');
-  const {
-    existsSync
-  } = require('fs');
-  const databasePath = (0, _config.getSetting)('databasePath', 'database/');
-  if (recordName === '__RECORDS') {
-    return null;
-  }
-  if (existsSync(`${databasePath}${recordName}.json`)) {
-    return null;
-  }
-  await mkdir(databasePath, {
-    recursive: true
-  });
-  const recordContent = (0, _record.record)({
-    path: recordName,
-    definition,
-    keys
-  });
-  await writeFile(`${databasePath}${recordName}.json`, JSON.stringify(recordContent, null, 2));
-  await mkdir(`${databasePath}${recordName}`, {
-    recursive: true
-  });
-  await (0, _registerRecord.registerRecord)(recordName);
-  return recordContent;
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.create = void 0;
+require("core-js/modules/es.json.stringify.js");
+var _record = require("./definitions/record");
+var _registerRecord = require("../utilities/registerRecord");
+var _config = require("../utilities/config");
+/**
+ * Create a new record.
+ * @param recordName
+ * @param definition
+ * @param keys
+ */
+const create = async (recordName, definition = [], keys = []) => {
+  const {
+    writeFile,
+    mkdir
+  } = require('fs/promises');
+  const {
+    existsSync
+  } = require('fs');
+  const databasePath = (0, _config.getSetting)('databasePath', 'database/');
+  if (recordName === '__RECORDS') {
+    return null;
+  }
+  if (existsSync(`${databasePath}${recordName}.json`)) {
+    return null;
+  }
+  await mkdir(databasePath, {
+    recursive: true
+  });
+  const recordContent = (0, _record.record)({
+    path: recordName,
+    definition,
+    keys
+  });
+  await writeFile(`${databasePath}${recordName}.json`, JSON.stringify(recordContent, null, 2));
+  await mkdir(`${databasePath}${recordName}`, {
+    recursive: true
+  });
+  await (0, _registerRecord.registerRecord)(recordName);
+  return recordContent;
+};
 exports.create = create;

package/dist/data/introspect/definitions/field.js

@@ -1,36 +1,36 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.field = void 0;
-/**
- * Generate a field for a record.
- * @param properties
- * @param properties.name
- * @param properties.type
- * @param properties.optional
- * @param properties.useDefault
- * @param properties.defaultValue
- * @param properties.autoGenerate
- */
-const field = ({
-  name = '',
-  type = 'string',
-  optional = false,
-  useDefault = false,
-  defaultValue = '',
-  autoGenerate = false
-} = {}) => {
-  const returnField = {
-    name,
-    type,
-    optional,
-    autoGenerate
-  };
-  if (useDefault) {
-    returnField['default'] = defaultValue;
-  }
-  return returnField;
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.field = void 0;
+/**
+ * Generate a field for a record.
+ * @param properties
+ * @param properties.name
+ * @param properties.type
+ * @param properties.optional
+ * @param properties.useDefault
+ * @param properties.defaultValue
+ * @param properties.autoGenerate
+ */
+const field = ({
+  name = '',
+  type = 'string',
+  optional = false,
+  useDefault = false,
+  defaultValue = '',
+  autoGenerate = false
+} = {}) => {
+  const returnField = {
+    name,
+    type,
+    optional,
+    autoGenerate
+  };
+  if (useDefault) {
+    returnField['default'] = defaultValue;
+  }
+  return returnField;
+};
 exports.field = field;

package/dist/data/introspect/definitions/key.js

@@ -1,53 +1,53 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.key = void 0;
-require("core-js/modules/esnext.iterator.constructor.js");
-require("core-js/modules/esnext.iterator.map.js");
-var _keyReference = require("./keyReference");
-/**
- * Create a field key.
- * @param properties
- * @param properties.type
- * @param properties.fields
- * @param properties.lookup
- * @param properties.references
- */
-const key = ({
-  type = 'index',
-  fields = [],
-  lookup = '',
-  references = []
-} = {}) => {
-  switch (type) {
-    case 'primary':
-    case 'index':
-    case 'unique':
-      references = [];
-      break;
-    case 'multi':
-      if (fields.length < 2) {
-        throw new Error('Multi key indicated with less than two fields');
-      }
-      break;
-    case 'foreign':
-      if (references.length < 1) {
-        throw new Error('Foreign key must have one reference to an external record');
-      }
-      break;
-    default:
-      throw new Error('Unrecognized key type; must be index, primary, unique, multi, or foreign');
-  }
-  const keyDefinition = {
-    type,
-    fields,
-    lookup
-  };
-  if (typeof references !== 'undefined' && references.length > 0) {
-    keyDefinition['references'] = references.map(_keyReference.keyReference);
-  }
-  return keyDefinition;
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.key = void 0;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.map.js");
+var _keyReference = require("./keyReference");
+/**
+ * Create a field key.
+ * @param properties
+ * @param properties.type
+ * @param properties.fields
+ * @param properties.lookup
+ * @param properties.references
+ */
+const key = ({
+  type = 'index',
+  fields = [],
+  lookup = '',
+  references = []
+} = {}) => {
+  switch (type) {
+    case 'primary':
+    case 'index':
+    case 'unique':
+      references = [];
+      break;
+    case 'multi':
+      if (fields.length < 2) {
+        throw new Error('Multi key indicated with less than two fields');
+      }
+      break;
+    case 'foreign':
+      if (references.length < 1) {
+        throw new Error('Foreign key must have one reference to an external record');
+      }
+      break;
+    default:
+      throw new Error('Unrecognized key type; must be index, primary, unique, multi, or foreign');
+  }
+  const keyDefinition = {
+    type,
+    fields,
+    lookup
+  };
+  if (typeof references !== 'undefined' && references.length > 0) {
+    keyDefinition['references'] = references.map(_keyReference.keyReference);
+  }
+  return keyDefinition;
+};
 exports.key = key;

package/dist/data/introspect/definitions/keyReference.js

@@ -1,20 +1,20 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.keyReference = void 0;
-/**
- * Create a reference to a remote (foreign; existing on another record) key.
- * @param properties
- * @param properties.fields
- * @param properties.lookup
- */
-const keyReference = ({
-  fields = [],
-  lookup = ''
-} = {}) => ({
-  fields,
-  lookup
-});
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.keyReference = void 0;
+/**
+ * Create a reference to a remote (foreign; existing on another record) key.
+ * @param properties
+ * @param properties.fields
+ * @param properties.lookup
+ */
+const keyReference = ({
+  fields = [],
+  lookup = ''
+} = {}) => ({
+  fields,
+  lookup
+});
 exports.keyReference = keyReference;

package/dist/data/introspect/definitions/record.js

@@ -1,32 +1,32 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.record = void 0;
-require("core-js/modules/esnext.iterator.constructor.js");
-require("core-js/modules/esnext.iterator.map.js");
-var _field = require("./field");
-var _key = require("./key");
-/**
- *
- * @param properties
- * @param properties.path
- * @param properties.definition
- * @param properties.keys
- * @param properties.entries
- */
-const record = ({
-  path = '',
-  definition = [],
-  keys = [],
-  entries = []
-} = {}) => {
-  return {
-    path,
-    definition: definition.map(_field.field),
-    keys: keys.map(_key.key),
-    entries
-  };
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.record = void 0;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.map.js");
+var _field = require("./field");
+var _key = require("./key");
+/**
+ *
+ * @param properties
+ * @param properties.path
+ * @param properties.definition
+ * @param properties.keys
+ * @param properties.entries
+ */
+const record = ({
+  path = '',
+  definition = [],
+  keys = [],
+  entries = []
+} = {}) => {
+  return {
+    path,
+    definition: definition.map(_field.field),
+    keys: keys.map(_key.key),
+    entries
+  };
+};
 exports.record = record;

package/dist/data/introspect/describe.js

@@ -1,15 +1,15 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.describe = void 0;
-var _retrieveFile = require("../utilities/retrieveFile");
-const describe = async (record = '__RECORDS') => {
-  const recordFile = await (0, _retrieveFile.retrieveFile)(`${record}.json`);
-  if (record === '__RECORDS') {
-    return recordFile.entries;
-  }
-  return recordFile.definition;
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.describe = void 0;
+var _retrieveFile = require("../utilities/retrieveFile");
+const describe = async (record = '__RECORDS') => {
+  const recordFile = await (0, _retrieveFile.retrieveFile)(`${record}.json`);
+  if (record === '__RECORDS') {
+    return recordFile.entries;
+  }
+  return recordFile.definition;
+};
 exports.describe = describe;

package/dist/data/introspect/drop.js

@@ -1,37 +1,37 @@
-"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: true
-});
-exports.drop = void 0;
-var _retrieveFile = require("../utilities/retrieveFile");
-var _deregisterRecord = require("../utilities/deregisterRecord");
-var _config = require("../utilities/config");
-const {
-  rm
-} = require('fs/promises');
-const drop = async record => {
-  const databasePath = (0, _config.getSetting)('databasePath', 'database/');
-  if (record === '__RECORDS') {
-    return null;
-  }
-  const recordFile = await (0, _retrieveFile.retrieveFile)(`${record}.json`);
-  for (const file of recordFile.entries) {
-    await rm(`${databasePath}${recordFile.path}/${file}`);
-  }
-  await rm(`${databasePath}${recordFile.path}`, {
-    recursive: true,
-    force: true
-  });
-  await rm(`${databasePath}__indexes/${recordFile.path}`, {
-    recursive: true,
-    force: true
-  });
-  await rm(`${databasePath}${record}.json`);
-  await (0, _deregisterRecord.deregisterRecord)(record);
-};
+"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: true
+});
+exports.drop = void 0;
+var _retrieveFile = require("../utilities/retrieveFile");
+var _deregisterRecord = require("../utilities/deregisterRecord");
+var _config = require("../utilities/config");
+const {
+  rm
+} = require('fs/promises');
+const drop = async record => {
+  const databasePath = (0, _config.getSetting)('databasePath', 'database/');
+  if (record === '__RECORDS') {
+    return null;
+  }
+  const recordFile = await (0, _retrieveFile.retrieveFile)(`${record}.json`);
+  for (const file of recordFile.entries) {
+    await rm(`${databasePath}${recordFile.path}/${file}`);
+  }
+  await rm(`${databasePath}${recordFile.path}`, {
+    recursive: true,
+    force: true
+  });
+  await rm(`${databasePath}__indexes/${recordFile.path}`, {
+    recursive: true,
+    force: true
+  });
+  await rm(`${databasePath}${record}.json`);
+  await (0, _deregisterRecord.deregisterRecord)(record);
+};
 exports.drop = drop;

package/dist/data/introspect/index.js

@@ -1,30 +1,30 @@
-"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: true
-});
-Object.defineProperty(exports, "create", {
-  enumerable: true,
-  get: function () {
-    return _create.create;
-  }
-});
-Object.defineProperty(exports, "describe", {
-  enumerable: true,
-  get: function () {
-    return _describe.describe;
-  }
-});
-Object.defineProperty(exports, "drop", {
-  enumerable: true,
-  get: function () {
-    return _drop.drop;
-  }
-});
-var _create = require("./create");
-var _drop = require("./drop");
+"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: true
+});
+Object.defineProperty(exports, "create", {
+  enumerable: true,
+  get: function () {
+    return _create.create;
+  }
+});
+Object.defineProperty(exports, "describe", {
+  enumerable: true,
+  get: function () {
+    return _describe.describe;
+  }
+});
+Object.defineProperty(exports, "drop", {
+  enumerable: true,
+  get: function () {
+    return _drop.drop;
+  }
+});
+var _create = require("./create");
+var _drop = require("./drop");
 var _describe = require("./describe");

package/dist/data/introspect/policies/foreignKeyExists.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.foreignKeyExists = void 0;
 var _retrieveRecords = require("../../utilities/retrieveRecords");
 var _where = require("../../queries/where");
+var _retrieveRecord = require("../../utilities/retrieveRecord");
+var _fieldType = require("../../utilities/fieldType");
 /**
  * Check whether any record in the referenced entity has the given property set to the given
  * value - the mirror image of keyUnique(), which checks that no record already has a value.
@@ -15,10 +17,12 @@ var _where = require("../../queries/where");
  */
 const foreignKeyExists = async (entity, property, value) => {
   const records = await (0, _retrieveRecords.retrieveRecords)(entity);
+  const type = (0, _fieldType.fieldType)(await (0, _retrieveRecord.retrieveRecord)(entity), property);
   const found = (0, _where.where)(records, {
     property,
     comparator: '=',
-    value
+    value,
+    type
   });
   return found.length > 0;
 };

package/dist/data/introspect/policies/foreignKeyExists.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.foreignKeyExists=void 0;var _retrieveRecords=require("../../utilities/retrieveRecords"),_where=require("../../queries/where");const foreignKeyExists=async(e,r,t)=>{const s=await(0,_retrieveRecords.retrieveRecords)(e);return(0,_where.where)(s,{property:r,comparator:"=",value:t}).length>0};exports.foreignKeyExists=foreignKeyExists;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.foreignKeyExists=void 0;var _retrieveRecords=require("../../utilities/retrieveRecords"),_where=require("../../queries/where"),_retrieveRecord=require("../../utilities/retrieveRecord"),_fieldType=require("../../utilities/fieldType");const foreignKeyExists=async(e,r,i)=>{const t=await(0,_retrieveRecords.retrieveRecords)(e),s=(0,_fieldType.fieldType)(await(0,_retrieveRecord.retrieveRecord)(e),r);return(0,_where.where)(t,{property:r,comparator:"=",value:i,type:s}).length>0};exports.foreignKeyExists=foreignKeyExists;

package/dist/data/introspect/policies/hasDependents.js

@@ -8,6 +8,7 @@ var _describe = require("../describe");
 var _retrieveRecord = require("../../utilities/retrieveRecord");
 var _retrieveRecords = require("../../utilities/retrieveRecords");
 var _where = require("../../queries/where");
+var _fieldType = require("../../utilities/fieldType");
 var _splitEntityProperty = require("../../utilities/parsers/splitEntityProperty");
 /**
  * Check whether any other record, in any entity, still has a single-field foreign key pointing
@@ -40,7 +41,8 @@ const hasDependents = async (entity, property, value) => {
       const found = (0, _where.where)(records, {
         property: key.fields[0],
         comparator: '=',
-        value
+        value,
+        type: (0, _fieldType.fieldType)(otherRecord, key.fields[0])
       });
       if (found.length) {
         return true;

package/dist/data/introspect/policies/hasDependents.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.hasDependents=void 0;var _describe=require("../describe"),_retrieveRecord=require("../../utilities/retrieveRecord"),_retrieveRecords=require("../../utilities/retrieveRecords"),_where=require("../../queries/where"),_splitEntityProperty=require("../../utilities/parsers/splitEntityProperty");const hasDependents=async(e,r,t)=>{const i=await(0,_describe.describe)();for(const s of i){const i=s.replace(/\.json$/,""),o=await(0,_retrieveRecord.retrieveRecord)(i);for(const s of o.keys){if("foreign"!==s.type||1!==s.fields.length||!s.references||1!==s.references.length)continue;const{entity:o,property:n}=(0,_splitEntityProperty.splitEntityProperty)(s.references[0].fields[0]);if(o!==e||n!==r)continue;const c=await(0,_retrieveRecords.retrieveRecords)(i);if((0,_where.where)(c,{property:s.fields[0],comparator:"=",value:t}).length)return!0}}return!1};exports.hasDependents=hasDependents;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.hasDependents=void 0;var _describe=require("../describe"),_retrieveRecord=require("../../utilities/retrieveRecord"),_retrieveRecords=require("../../utilities/retrieveRecords"),_where=require("../../queries/where"),_fieldType=require("../../utilities/fieldType"),_splitEntityProperty=require("../../utilities/parsers/splitEntityProperty");const hasDependents=async(e,r,t)=>{const i=await(0,_describe.describe)();for(const s of i){const i=s.replace(/\.json$/,""),o=await(0,_retrieveRecord.retrieveRecord)(i);for(const s of o.keys){if("foreign"!==s.type||1!==s.fields.length||!s.references||1!==s.references.length)continue;const{entity:n,property:c}=(0,_splitEntityProperty.splitEntityProperty)(s.references[0].fields[0]);if(n!==e||c!==r)continue;const p=await(0,_retrieveRecords.retrieveRecords)(i);if((0,_where.where)(p,{property:s.fields[0],comparator:"=",value:t,type:(0,_fieldType.fieldType)(o,s.fields[0])}).length)return!0}}return!1};exports.hasDependents=hasDependents;

package/dist/data/introspect/policies/keyGenerate.js

@@ -1,17 +1,17 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.keyGenerate = void 0;
-var _keyUnique = require("./keyUnique");
-const keyGenerate = async (entity, references = []) => {
-  let uuid = null;
-  let isUnique = false;
-  while (!isUnique) {
-    uuid = crypto.randomUUID();
-    isUnique = await (0, _keyUnique.keyUnique)(entity, references, [uuid]);
-  }
-  return uuid;
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.keyGenerate = void 0;
+var _keyUnique = require("./keyUnique");
+const keyGenerate = async (entity, references = []) => {
+  let uuid = null;
+  let isUnique = false;
+  while (!isUnique) {
+    uuid = crypto.randomUUID();
+    isUnique = await (0, _keyUnique.keyUnique)(entity, references, [uuid]);
+  }
+  return uuid;
+};
 exports.keyGenerate = keyGenerate;

package/dist/data/introspect/policies/keyUnique.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.keyUnique = void 0;
 var _retrieveRecords = require("../../utilities/retrieveRecords");
 var _where = require("../../queries/where");
+var _retrieveRecord = require("../../utilities/retrieveRecord");
+var _fieldType = require("../../utilities/fieldType");
 /**
  * Check that no existing record already has this combination of values across all of the given
  * fields - a single field for a normal unique/primary key, or several for a composite one.
@@ -19,11 +21,13 @@ const keyUnique = async (entity, references = [], checkKeys = []) => {
     return false;
   }
   let records = await (0, _retrieveRecords.retrieveRecords)(entity);
+  const record = await (0, _retrieveRecord.retrieveRecord)(entity);
   for (let i = 0; i < references.length; i++) {
     records = (0, _where.where)(records, {
       property: references[i],
       comparator: '=',
-      value: checkKeys[i]
+      value: checkKeys[i],
+      type: (0, _fieldType.fieldType)(record, references[i])
     });
   }
   return !records.length;

package/dist/data/introspect/policies/keyUnique.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.keyUnique=void 0;var _retrieveRecords=require("../../utilities/retrieveRecords"),_where=require("../../queries/where");const keyUnique=async(e,r=[],t=[])=>{if(!r.length||r.length!==t.length)return!1;let i=await(0,_retrieveRecords.retrieveRecords)(e);for(let e=0;e<r.length;e++)i=(0,_where.where)(i,{property:r[e],comparator:"=",value:t[e]});return!i.length};exports.keyUnique=keyUnique;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.keyUnique=void 0;var _retrieveRecords=require("../../utilities/retrieveRecords"),_where=require("../../queries/where"),_retrieveRecord=require("../../utilities/retrieveRecord"),_fieldType=require("../../utilities/fieldType");const keyUnique=async(e,r=[],t=[])=>{if(!r.length||r.length!==t.length)return!1;let i=await(0,_retrieveRecords.retrieveRecords)(e);const o=await(0,_retrieveRecord.retrieveRecord)(e);for(let e=0;e<r.length;e++)i=(0,_where.where)(i,{property:r[e],comparator:"=",value:t[e],type:(0,_fieldType.fieldType)(o,r[e])});return!i.length};exports.keyUnique=keyUnique;