json-fs-query 0.1.0

package/MAIN.md

@@ -0,0 +1,15 @@
+# json-file-db
+
+Read and manage data with JSON files - a small query engine that treats a folder of JSON files as a database, with
+a SQL-like query string (`read workouts where date = '2024-06-02'`) instead of a query builder API.
+
+## The modules
+
+Each module of the documentation is a folder of `src/data/`:
+
+* `introspect`: create, drop and describe a JSON-file "table" (and the policies that validate one).
+* `queries`: parse a query string and run it - reads, inserts, updates, deletes, joins, `where`, `sortBy`, `groupBy`.
+* `utilities`: shared helpers the queries use - retrieving records/files/indexes and merging join results.
+
+Note: `src/index.ts` (the package's top-level entry point) is still an empty stub - there is no public
+`require('json-file-db')` API yet, only the individual modules above.

package/README.md

@@ -0,0 +1,63 @@
+# json-fs-query
+
+Read and manage data with JSON files - a small query engine that treats a folder of JSON files as a database, with
+a SQL-like query string (`read workouts where date = '2024-06-02'`) instead of a query builder API.
+
+> **Pre-release.** The core engine (schema management plus a full read/insert/update/delete query language) is
+> implemented and tested. Still open: multi-field keys, a browser-safe build, and referential integrity on
+> delete/update (see the repository's issue tracker for details). Expect the public API below to stay stable, but
+> breaking changes are possible before a 1.0 release.
+
+## Install
+
+```shell
+npm install json-fs-query
+```
+
+## Usage
+
+```js
+const { create, query, drop } = require('json-fs-query')
+
+await create('workouts', [
+  { name: '_id', type: 'string', optional: false, autoGenerate: true },
+  { name: 'reps', type: 'int', optional: false },
+  { name: 'date', type: 'string', optional: false }
+], [
+  { type: 'primary', fields: ['_id'], lookup: 'pk__id.json' }
+])
+
+await query("insert workouts values reps = 10, date = '2024-06-02'")
+const rows = await query("read workouts where date = '2024-06-02'")
+await query("update workouts set reps = 12 where date = '2024-06-02'")
+await query("delete workouts where date = '2024-06-02'")
+
+await drop('workouts')
+```
+
+This is a Node-only admin API today - `create`/`drop`/`query` all read and write real files on disk. A
+browser-safe read-only build is planned but not yet built (see the pre-release note above).
+
+## Documentation
+
+The reference for every function is in [`docs/`](https://joshuaheagle.com/projects/json-file-db/docs/index.html) (or open `docs/index.html` locally). It is generated from the TypeScript source, and each module is a folder of `src/data/`:
+
+| Module | What it holds |
+| --- | --- |
+| `introspect` | Create, drop and describe a JSON-file "table" (and the policies that validate one) |
+| `queries` | Parse a query string and run it - reads, inserts, updates, deletes, joins, `where`, `sortBy`, `groupBy` |
+| `utilities` | Shared helpers the queries use - retrieving records/files/indexes and merging join results |
+
+`src/index.ts` is the package's public entry point - it re-exports `query`, `create`, `drop`, `describe`, and the
+schema-definition types (`fieldProperties`, `keyProperties`, etc.) needed to build a `create()` call. Everything else
+under `src/data/` is an internal module, reachable but not part of the supported public API.
+
+## Development
+
+```shell
+npm install
+npm test          # the tests
+npm run typecheck # the types
+npm run build     # dist/ and docs/
+npm run docs      # only the documentation
+```

package/babel.config.js

@@ -0,0 +1,3 @@
+const babelConfig = require('js-build-tools/babel.config')
+babelConfig.presets.push('@babel/preset-typescript')
+module.exports = babelConfig

package/build-tools.config.json

@@ -0,0 +1,30 @@
+{
+  "browser": {
+    "enabled": false,
+    "name": "jsonFileDb"
+  },
+  "dist": {
+    "main": "dist/index.js"
+  },
+  "docs": {
+    "enabled": true,
+    "from": "src/data",
+    "index": "MAIN.md",
+    "to": "../joshuaheagle.local/projects/json-file-db/docs"
+  },
+  "typescript": {
+    "config": "tsconfig.json",
+    "enabled": true
+  },
+  "test": {
+    "options": {
+      "testMatch": [
+        "**/?(*.)+(spec|test).js?(x)"
+      ]
+    },
+    "path": "src",
+    "watch": "src/**/*.[jt]s"
+  },
+  "relativePath": "http://joshuaheagle.local/projects/workout-planner",
+  "databasePath": "database/"
+}

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

@@ -0,0 +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>;
+//# sourceMappingURL=create.d.ts.map

package/dist/data/introspect/create.js

@@ -0,0 +1,45 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.create = void 0
+require('core-js/modules/es.json.stringify.js')
+const _testFilesystem = require('test-filesystem')
+const _record = require('./definitions/record')
+const _registerRecord = require('../utilities/registerRecord')
+/**
+ * Create a new record.
+ * @param recordName
+ * @param definition
+ * @param keys
+ */
+const create = async (recordName, definition = [], keys = []) => {
+  const gulpConfig = require('js-build-tools/gulp.config')
+  const {
+    writeFile,
+    mkdir
+  } = require('fs/promises')
+  const databasePath = gulpConfig.get('databasePath', 'database/')
+  if (recordName === '__RECORDS') {
+    return null
+  }
+  if ((0, _testFilesystem.fileExists)(`${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/create.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.create=void 0,require("core-js/modules/es.json.stringify.js");var _testFilesystem=require("test-filesystem"),_record=require("./definitions/record"),_registerRecord=require("../utilities/registerRecord");const create=async(e,r=[],t=[])=>{const s=require("js-build-tools/gulp.config"),{writeFile:i,mkdir:o}=require("fs/promises"),a=s.get("databasePath","database/");if("__RECORDS"===e)return null;if((0,_testFilesystem.fileExists)(`${a}${e}.json`))return null;await o(a,{recursive:!0});const c=(0,_record.record)({path:e,definition:r,keys:t});return await i(`${a}${e}.json`,JSON.stringify(c,null,2)),await o(`${a}${e}`,{recursive:!0}),await(0,_registerRecord.registerRecord)(e),c};exports.create=create;

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

@@ -0,0 +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;
+//# sourceMappingURL=field.d.ts.map

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

@@ -0,0 +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

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.field=void 0;const field=({name:e="",type:t="string",optional:o=!1,useDefault:a=!1,defaultValue:l="",autoGenerate:n=!1}={})=>{const r={name:e,type:t,optional:o,autoGenerate:n};return a&&(r.default=l),r};exports.field=field;

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

@@ -0,0 +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;
+//# sourceMappingURL=key.d.ts.map

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

@@ -0,0 +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

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.key=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _keyReference=require("./keyReference");const key=({type:e="index",fields:r=[],lookup:t="",references:o=[]}={})=>{switch(e){case"primary":case"index":case"unique":o=[];break;case"multi":if(r.length<2)throw new Error("Multi key indicated with less than two fields");break;case"foreign":if(o.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 n={type:e,fields:r,lookup:t};return void 0!==o&&o.length>0&&(n.references=o.map(_keyReference.keyReference)),n};exports.key=key;

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

@@ -0,0 +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;
+//# sourceMappingURL=keyReference.d.ts.map

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

@@ -0,0 +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

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.keyReference=void 0;const keyReference=({fields:e=[],lookup:o=""}={})=>({fields:e,lookup:o});exports.keyReference=keyReference;

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

@@ -0,0 +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;
+//# sourceMappingURL=record.d.ts.map

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

@@ -0,0 +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

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

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.record=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _field=require("./field"),_key=require("./key");const record=({path:e="",definition:r=[],keys:t=[],entries:i=[]}={})=>({path:e,definition:r.map(_field.field),keys:t.map(_key.key),entries:i});exports.record=record;

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

@@ -0,0 +1,2 @@
+export declare const describe: (record?: string) => Promise<any>;
+//# sourceMappingURL=describe.d.ts.map

package/dist/data/introspect/describe.js

@@ -0,0 +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

package/dist/data/introspect/describe.min.js

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

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

@@ -0,0 +1,2 @@
+export declare const drop: (record: any) => Promise<any>;
+//# sourceMappingURL=drop.d.ts.map

package/dist/data/introspect/drop.js

@@ -0,0 +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
+const _retrieveFile = require('../utilities/retrieveFile')
+const _deregisterRecord = require('../utilities/deregisterRecord')
+const gulpConfig = require('js-build-tools/gulp.config')
+const {
+  rm
+} = require('fs/promises')
+const drop = async record => {
+  const databasePath = gulpConfig.get('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/drop.min.js

@@ -0,0 +1 @@
+"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:!0}),exports.drop=void 0;var _retrieveFile=require("../utilities/retrieveFile"),_deregisterRecord=require("../utilities/deregisterRecord");const gulpConfig=require("js-build-tools/gulp.config"),{rm:rm}=require("fs/promises"),drop=async e=>{const r=gulpConfig.get("databasePath","database/");if("__RECORDS"===e)return null;const t=await(0,_retrieveFile.retrieveFile)(`${e}.json`);for(const e of t.entries)await rm(`${r}${t.path}/${e}`);await rm(`${r}${t.path}`,{recursive:!0,force:!0}),await rm(`${r}__indexes/${t.path}`,{recursive:!0,force:!0}),await rm(`${r}${e}.json`),await(0,_deregisterRecord.deregisterRecord)(e)};exports.drop=drop;

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

@@ -0,0 +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';
+//# sourceMappingURL=index.d.ts.map

package/dist/data/introspect/index.js

@@ -0,0 +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')
+var _describe = require('./describe')

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

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

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

@@ -0,0 +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>;
+//# sourceMappingURL=foreignKeyExists.d.ts.map

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

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

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

@@ -0,0 +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;

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

@@ -0,0 +1,2 @@
+export declare const keyGenerate: (entity: any, references?: any[]) => Promise<any>;
+//# sourceMappingURL=keyGenerate.d.ts.map

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

@@ -0,0 +1,17 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.keyGenerate = void 0
+const _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/keyGenerate.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.keyGenerate=void 0;var _keyUnique=require("./keyUnique");const keyGenerate=async(e,r=[])=>{let t=null,n=!1;for(;!n;)t=crypto.randomUUID(),n=await(0,_keyUnique.keyUnique)(e,r,t);return t};exports.keyGenerate=keyGenerate;

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

@@ -0,0 +1,2 @@
+export declare const keyUnique: (entity: any, references?: any[], checkKey?: any) => Promise<boolean>;
+//# sourceMappingURL=keyUnique.d.ts.map

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

@@ -0,0 +1,21 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.keyUnique = void 0
+const _retrieveRecords = require('../../utilities/retrieveRecords')
+const _where = require('../../queries/where')
+const keyUnique = async (entity, references = [], checkKey = null) => {
+  if (references.length !== 1) {
+    return false
+  }
+  const records = await (0, _retrieveRecords.retrieveRecords)(entity)
+  const found = (0, _where.where)(records, {
+    property: references[0],
+    comparator: '=',
+    value: checkKey
+  })
+  return !found.length
+}
+exports.keyUnique = keyUnique

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

@@ -0,0 +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=null)=>{if(1!==r.length)return!1;const i=await(0,_retrieveRecords.retrieveRecords)(e);return!(0,_where.where)(i,{property:r[0],comparator:"=",value:t}).length};exports.keyUnique=keyUnique;