json-fs-query 1.0.4 → 1.0.6

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,47 +1,47 @@
-'use strict'
-
-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')
-/**
- * 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
+"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.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,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
-}
-exports.field = field
+"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.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,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')
-const _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
+"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.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,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
-})
-exports.keyReference = keyReference
+"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.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,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')
-const _field = require('./field')
-const _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
+"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
-const _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
+"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;