json-fs-query 1.0.3 → 1.0.5

package/dist/data/introspect/create.d.ts

@@ -1,11 +1,11 @@
-import { recordDefinition } from './definitions/record';
-import { keyProperties } from './definitions/key';
-import { fieldProperties } from './definitions/field';
-/**
- * Create a new record.
- * @param recordName
- * @param definition
- * @param keys
- */
-export declare const create: (recordName: string, definition?: fieldProperties[], keys?: keyProperties[]) => Promise<recordDefinition | null>;
+import { recordDefinition } from './definitions/record';
+import { keyProperties } from './definitions/key';
+import { fieldProperties } from './definitions/field';
+/**
+ * Create a new record.
+ * @param recordName
+ * @param definition
+ * @param keys
+ */
+export declare const create: (recordName: string, definition?: fieldProperties[], keys?: keyProperties[]) => Promise<recordDefinition | null>;
 //# sourceMappingURL=create.d.ts.map

package/dist/data/introspect/create.js

@@ -1,13 +1,13 @@
-'use strict'
+"use strict";
 
-Object.defineProperty(exports, '__esModule', {
+Object.defineProperty(exports, "__esModule", {
   value: true
-})
-exports.create = void 0
-require('core-js/modules/es.json.stringify.js')
-const _record = require('./definitions/record')
-const _registerRecord = require('../utilities/registerRecord')
-const _config = require('../utilities/config')
+});
+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
@@ -18,30 +18,30 @@ const create = async (recordName, definition = [], keys = []) => {
   const {
     writeFile,
     mkdir
-  } = require('fs/promises')
+  } = require('fs/promises');
   const {
     existsSync
-  } = require('fs')
-  const databasePath = (0, _config.getSetting)('databasePath', 'database/')
+  } = require('fs');
+  const databasePath = (0, _config.getSetting)('databasePath', 'database/');
   if (recordName === '__RECORDS') {
-    return null
+    return null;
   }
   if (existsSync(`${databasePath}${recordName}.json`)) {
-    return null
+    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 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
+  });
+  await (0, _registerRecord.registerRecord)(recordName);
+  return recordContent;
+};
+exports.create = create;

package/dist/data/introspect/definitions/field.d.ts

@@ -1,28 +1,28 @@
-export type fieldName = string;
-export type fieldDefinition = {
-    name: fieldName;
-    type: string;
-    optional: boolean;
-    default?: any;
-    autoGenerate: boolean;
-};
-export type fieldProperties = {
-    name?: string;
-    type?: string;
-    optional?: boolean;
-    useDefault?: boolean;
-    defaultValue?: any;
-    autoGenerate?: boolean;
-};
-/**
- * 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
- */
-export declare const field: ({ name, type, optional, useDefault, defaultValue, autoGenerate }?: fieldProperties) => fieldDefinition;
+export type fieldName = string;
+export type fieldDefinition = {
+    name: fieldName;
+    type: string;
+    optional: boolean;
+    default?: any;
+    autoGenerate: boolean;
+};
+export type fieldProperties = {
+    name?: string;
+    type?: string;
+    optional?: boolean;
+    useDefault?: boolean;
+    defaultValue?: any;
+    autoGenerate?: boolean;
+};
+/**
+ * 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
+ */
+export declare const field: ({ name, type, optional, useDefault, defaultValue, autoGenerate }?: fieldProperties) => fieldDefinition;
 //# sourceMappingURL=field.d.ts.map

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

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

package/dist/data/introspect/definitions/key.d.ts

@@ -1,26 +1,26 @@
-import { reference } from './keyReference';
-import { fieldName } from './field';
-export type indexType = string;
-export type indexLocation = string;
-export type keyDefinition = {
-    type: indexType;
-    fields: Array<fieldName>;
-    lookup: indexLocation;
-    references?: Array<reference>;
-};
-export type keyProperties = {
-    type?: indexType;
-    fields?: Array<fieldName>;
-    lookup?: indexLocation;
-    references?: Array<reference>;
-};
-/**
- * Create a field key.
- * @param properties
- * @param properties.type
- * @param properties.fields
- * @param properties.lookup
- * @param properties.references
- */
-export declare const key: ({ type, fields, lookup, references }?: keyProperties) => keyDefinition;
+import { reference } from './keyReference';
+import { fieldName } from './field';
+export type indexType = string;
+export type indexLocation = string;
+export type keyDefinition = {
+    type: indexType;
+    fields: Array<fieldName>;
+    lookup: indexLocation;
+    references?: Array<reference>;
+};
+export type keyProperties = {
+    type?: indexType;
+    fields?: Array<fieldName>;
+    lookup?: indexLocation;
+    references?: Array<reference>;
+};
+/**
+ * Create a field key.
+ * @param properties
+ * @param properties.type
+ * @param properties.fields
+ * @param properties.lookup
+ * @param properties.references
+ */
+export declare const key: ({ type, fields, lookup, references }?: keyProperties) => keyDefinition;
 //# sourceMappingURL=key.d.ts.map

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

@@ -1,12 +1,12 @@
-'use strict'
+"use strict";
 
-Object.defineProperty(exports, '__esModule', {
+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')
-const _keyReference = require('./keyReference')
+});
+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
@@ -25,29 +25,29 @@ const key = ({
     case 'primary':
     case 'index':
     case 'unique':
-      references = []
-      break
+      references = [];
+      break;
     case 'multi':
       if (fields.length < 2) {
-        throw new Error('Multi key indicated with less than two fields')
+        throw new Error('Multi key indicated with less than two fields');
       }
-      break
+      break;
     case 'foreign':
       if (references.length < 1) {
-        throw new Error('Foreign key must have one reference to an external record')
+        throw new Error('Foreign key must have one reference to an external record');
       }
-      break
+      break;
     default:
-      throw new Error('Unrecognized key type; must be index, primary, unique, multi, or foreign')
+      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)
+    keyDefinition['references'] = references.map(_keyReference.keyReference);
   }
-  return keyDefinition
-}
-exports.key = key
+  return keyDefinition;
+};
+exports.key = key;

package/dist/data/introspect/definitions/keyReference.d.ts

@@ -1,18 +1,18 @@
-import { fieldName } from './field';
-import { recordPath } from './record';
-export type reference = {
-    fields: fieldName[];
-    lookup: recordPath;
-};
-export type referenceProperties = {
-    fields?: fieldName[];
-    lookup?: recordPath;
-};
-/**
- * Create a reference to a remote (foreign; existing on another record) key.
- * @param properties
- * @param properties.fields
- * @param properties.lookup
- */
-export declare const keyReference: ({ fields, lookup }?: referenceProperties) => reference;
+import { fieldName } from './field';
+import { recordPath } from './record';
+export type reference = {
+    fields: fieldName[];
+    lookup: recordPath;
+};
+export type referenceProperties = {
+    fields?: fieldName[];
+    lookup?: recordPath;
+};
+/**
+ * Create a reference to a remote (foreign; existing on another record) key.
+ * @param properties
+ * @param properties.fields
+ * @param properties.lookup
+ */
+export declare const keyReference: ({ fields, lookup }?: referenceProperties) => reference;
 //# sourceMappingURL=keyReference.d.ts.map

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

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

package/dist/data/introspect/definitions/record.d.ts

@@ -1,26 +1,26 @@
-import { fieldDefinition, fieldProperties } from './field';
-import { keyDefinition, keyProperties } from './key';
-export type recordPath = string;
-export type entityPath = string;
-export type recordDefinition = {
-    path: recordPath;
-    definition: fieldDefinition[];
-    keys: keyDefinition[];
-    entries: entityPath[];
-};
-export type recordProperties = {
-    path?: recordPath;
-    definition?: fieldProperties[];
-    keys?: keyProperties[];
-    entries?: entityPath[];
-};
-/**
- *
- * @param properties
- * @param properties.path
- * @param properties.definition
- * @param properties.keys
- * @param properties.entries
- */
-export declare const record: ({ path, definition, keys, entries }?: recordProperties) => recordDefinition;
+import { fieldDefinition, fieldProperties } from './field';
+import { keyDefinition, keyProperties } from './key';
+export type recordPath = string;
+export type entityPath = string;
+export type recordDefinition = {
+    path: recordPath;
+    definition: fieldDefinition[];
+    keys: keyDefinition[];
+    entries: entityPath[];
+};
+export type recordProperties = {
+    path?: recordPath;
+    definition?: fieldProperties[];
+    keys?: keyProperties[];
+    entries?: entityPath[];
+};
+/**
+ *
+ * @param properties
+ * @param properties.path
+ * @param properties.definition
+ * @param properties.keys
+ * @param properties.entries
+ */
+export declare const record: ({ path, definition, keys, entries }?: recordProperties) => recordDefinition;
 //# sourceMappingURL=record.d.ts.map

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

@@ -1,13 +1,13 @@
-'use strict'
+"use strict";
 
-Object.defineProperty(exports, '__esModule', {
+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')
-const _field = require('./field')
-const _key = require('./key')
+});
+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
@@ -27,6 +27,6 @@ const record = ({
     definition: definition.map(_field.field),
     keys: keys.map(_key.key),
     entries
-  }
-}
-exports.record = record
+  };
+};
+exports.record = record;

package/dist/data/introspect/describe.js

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

package/dist/data/introspect/drop.js

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

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

@@ -1,8 +1,8 @@
-export { create } from './create';
-export { drop } from './drop';
-export { describe } from './describe';
-export { fieldProperties, fieldDefinition, fieldName } from './definitions/field';
-export { keyProperties, keyDefinition, indexType, indexLocation } from './definitions/key';
-export { referenceProperties, reference } from './definitions/keyReference';
-export { recordProperties, recordDefinition, recordPath, entityPath } from './definitions/record';
+export { create } from './create';
+export { drop } from './drop';
+export { describe } from './describe';
+export { fieldProperties, fieldDefinition, fieldName } from './definitions/field';
+export { keyProperties, keyDefinition, indexType, indexLocation } from './definitions/key';
+export { referenceProperties, reference } from './definitions/keyReference';
+export { recordProperties, recordDefinition, recordPath, entityPath } from './definitions/record';
 //# sourceMappingURL=index.d.ts.map

package/dist/data/introspect/index.js

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

package/dist/data/introspect/policies/foreignKeyExists.d.ts

@@ -1,9 +1,9 @@
-/**
- * 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.
- * @param entity
- * @param property
- * @param value
- */
-export declare const foreignKeyExists: (entity: string, property: string, value: any) => Promise<boolean>;
+/**
+ * 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.
+ * @param entity
+ * @param property
+ * @param value
+ */
+export declare const foreignKeyExists: (entity: string, property: string, value: any) => Promise<boolean>;
 //# sourceMappingURL=foreignKeyExists.d.ts.map

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

@@ -1,11 +1,11 @@
-'use strict'
+"use strict";
 
-Object.defineProperty(exports, '__esModule', {
+Object.defineProperty(exports, "__esModule", {
   value: true
-})
-exports.foreignKeyExists = void 0
-const _retrieveRecords = require('../../utilities/retrieveRecords')
-const _where = require('../../queries/where')
+});
+exports.foreignKeyExists = void 0;
+var _retrieveRecords = require("../../utilities/retrieveRecords");
+var _where = require("../../queries/where");
 /**
  * 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.
@@ -14,12 +14,12 @@ const _where = require('../../queries/where')
  * @param value
  */
 const foreignKeyExists = async (entity, property, value) => {
-  const records = await (0, _retrieveRecords.retrieveRecords)(entity)
+  const records = await (0, _retrieveRecords.retrieveRecords)(entity);
   const found = (0, _where.where)(records, {
     property,
     comparator: '=',
     value
-  })
-  return found.length > 0
-}
-exports.foreignKeyExists = foreignKeyExists
+  });
+  return found.length > 0;
+};
+exports.foreignKeyExists = foreignKeyExists;