json-fs-query 0.1.1 → 1.0.1

package/dist/data/utilities/computeKeyValue.js

@@ -0,0 +1,26 @@
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.computeKeyValue = void 0
+require('core-js/modules/es.json.stringify.js')
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.map.js')
+/**
+ * The value a key (of any field count) indexes and checks uniqueness by. A single-field key uses
+ * the field's own raw value directly - this is the pre-existing, already-shipped index file
+ * format (e.g. a plain "2024-06-02" or 1), and stays exactly as it was for backward compatibility
+ * with real fixture data. A multi-field key has no single value to use, so its fields' values are
+ * combined into one deterministic composite (a JSON array), in the same field order as key.fields
+ * - two records only share a composite value if every field matches.
+ * @param fields
+ * @param values
+ */
+const computeKeyValue = (fields, values) => {
+  if (fields.length === 1) {
+    return values[fields[0]]
+  }
+  return JSON.stringify(fields.map(field => values[field]))
+}
+exports.computeKeyValue = computeKeyValue

package/dist/data/utilities/computeKeyValue.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.computeKeyValue=void 0,require("core-js/modules/es.json.stringify.js"),require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");const computeKeyValue=(e,r)=>1===e.length?r[e[0]]:JSON.stringify(e.map((e=>r[e])));exports.computeKeyValue=computeKeyValue;

package/dist/data/utilities/config.d.ts

@@ -1,12 +1,18 @@
 export type RuntimeSettings = {
     databasePath: string;
     relativePath: string;
+    enforceForeignKeys: boolean;
 };
 /**
  * Set where this package's data lives: databasePath (a filesystem path, used in Node) and/or
  * relativePath (a URL prefix prepended to databasePath, used when reading over fetch() in a
  * browser). Call this once before using create()/drop()/query() - a fresh consumer has no other
  * way to point this package at their own data directory.
+ *
+ * enforceForeignKeys (default true) controls whether deleteEntity/updateEntity block an operation
+ * that would leave another record's foreign key pointing at a value that no longer exists -
+ * mirroring MySQL's own foreign_key_checks setting, which is also toggleable rather than always
+ * on, since strict enforcement isn't always what every consumer wants.
  * @param newSettings
  */
 export declare const configure: (newSettings: Partial<RuntimeSettings>) => void;

package/dist/data/utilities/config.js

@@ -6,7 +6,8 @@ Object.defineProperty(exports, '__esModule', {
 exports.getSetting = exports.configure = void 0
 const defaults = {
   databasePath: 'database/',
-  relativePath: ''
+  relativePath: '',
+  enforceForeignKeys: true
 }
 let settings = {
   ...defaults
@@ -16,6 +17,11 @@ let settings = {
  * relativePath (a URL prefix prepended to databasePath, used when reading over fetch() in a
  * browser). Call this once before using create()/drop()/query() - a fresh consumer has no other
  * way to point this package at their own data directory.
+ *
+ * enforceForeignKeys (default true) controls whether deleteEntity/updateEntity block an operation
+ * that would leave another record's foreign key pointing at a value that no longer exists -
+ * mirroring MySQL's own foreign_key_checks setting, which is also toggleable rather than always
+ * on, since strict enforcement isn't always what every consumer wants.
  * @param newSettings
  */
 const configure = newSettings => {

package/dist/data/utilities/config.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getSetting=exports.configure=void 0;const defaults={databasePath:"database/",relativePath:""};let settings={...defaults};const configure=t=>{settings={...settings,...t}};exports.configure=configure;const getSetting=(t,e)=>void 0!==settings[t]?settings[t]:e;exports.getSetting=getSetting;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.getSetting=exports.configure=void 0;const defaults={databasePath:"database/",relativePath:"",enforceForeignKeys:!0};let settings={...defaults};const configure=t=>{settings={...settings,...t}};exports.configure=configure;const getSetting=(t,e)=>void 0!==settings[t]?settings[t]:e;exports.getSetting=getSetting;

package/dist/data/utilities/runQuery.js

@@ -15,6 +15,8 @@ const _mergeJoins = require('../queries/mergeJoins')
 const _where = require('../queries/where')
 const _sortBy = require('../queries/sortBy')
 const _groupBy = require('../queries/groupBy')
+const _limitOffset = require('../queries/limitOffset')
+const _selectFields = require('../queries/selectFields')
 const _retrieveRecord = require('./retrieveRecord')
 const _getConditionIndexedList = require('./getConditionIndexedList')
 const _getJoinIndexedList = require('./getJoinIndexedList')
@@ -66,7 +68,9 @@ const runQuery = async parsed => {
     }, dataSet[parsed.entity])
   }
   dataSet[parsed.entity] = (0, _sortBy.sortBy)(dataSet[parsed.entity], parsed.sortClauses)
+  dataSet[parsed.entity] = (0, _limitOffset.limitOffset)(dataSet[parsed.entity], parsed.offset, parsed.limit)
   dataSet[parsed.entity] = (0, _groupBy.groupBy)(dataSet[parsed.entity], parsed.groupBy)
+  dataSet[parsed.entity] = (0, _selectFields.selectFields)(dataSet[parsed.entity], parsed.selectClauses)
   return dataSet
 }
 exports.runQuery = runQuery

package/dist/data/utilities/runQuery.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.runQuery=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.reduce.js");var _deleteEntity=require("../queries/deleteEntity"),_insertEntity=require("../queries/insertEntity"),_readEntity=require("../queries/readEntity"),_updateEntity=require("../queries/updateEntity"),_joinEntity=require("../queries/joinEntity"),_mergeJoins=require("../queries/mergeJoins"),_where=require("../queries/where"),_sortBy=require("../queries/sortBy"),_groupBy=require("../queries/groupBy"),_retrieveRecord=require("./retrieveRecord"),_getConditionIndexedList=require("./getConditionIndexedList"),_getJoinIndexedList=require("./getJoinIndexedList");const runQuery=async e=>{const t={[e.entity]:await(0,_retrieveRecord.retrieveRecord)(e.entity)};void 0!==e.joinEntity&&(t[e.joinEntity]=await(0,_retrieveRecord.retrieveRecord)(e.joinEntity));let i={[e.entity]:[]};switch(e=await(0,_getConditionIndexedList.getConditionIndexedList)(e,t,i),"delete"!==(e=await(0,_getJoinIndexedList.getJoinIndexedList)(e,t,i)).command&&"update"!==e.command||(i=await(0,_readEntity.readEntity)(e.entity,i),i[e.entity]=e.conditions.reduce(((e,t)=>(0,_where.where)(e,t)),i[e.entity])),e.command){case"delete":i=await(0,_deleteEntity.deleteEntity)(e.entity,i);break;case"insert":i=await(0,_insertEntity.insertEntity)(e.entity,e.insertValues,i);break;case"read":i=await(0,_readEntity.readEntity)(e.entity,i);break;case"update":i=await(0,_updateEntity.updateEntity)(e.entity,e.updateValues,i);break;default:throw new Error(`Unknown command: ${e.command}`)}return i=await(0,_joinEntity.joinEntity)(e.entity,e.joinEntity,i,e.joinClauses),i=await(0,_mergeJoins.mergeJoins)(i,e.mergeJoins),"delete"!==e.command&&"update"!==e.command&&(i[e.entity]=e.conditions.reduce(((e,t)=>(0,_where.where)(e,t)),i[e.entity])),i[e.entity]=(0,_sortBy.sortBy)(i[e.entity],e.sortClauses),i[e.entity]=(0,_groupBy.groupBy)(i[e.entity],e.groupBy),i};exports.runQuery=runQuery;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.runQuery=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.reduce.js");var _deleteEntity=require("../queries/deleteEntity"),_insertEntity=require("../queries/insertEntity"),_readEntity=require("../queries/readEntity"),_updateEntity=require("../queries/updateEntity"),_joinEntity=require("../queries/joinEntity"),_mergeJoins=require("../queries/mergeJoins"),_where=require("../queries/where"),_sortBy=require("../queries/sortBy"),_groupBy=require("../queries/groupBy"),_limitOffset=require("../queries/limitOffset"),_selectFields=require("../queries/selectFields"),_retrieveRecord=require("./retrieveRecord"),_getConditionIndexedList=require("./getConditionIndexedList"),_getJoinIndexedList=require("./getJoinIndexedList");const runQuery=async e=>{const t={[e.entity]:await(0,_retrieveRecord.retrieveRecord)(e.entity)};void 0!==e.joinEntity&&(t[e.joinEntity]=await(0,_retrieveRecord.retrieveRecord)(e.joinEntity));let i={[e.entity]:[]};switch(e=await(0,_getConditionIndexedList.getConditionIndexedList)(e,t,i),"delete"!==(e=await(0,_getJoinIndexedList.getJoinIndexedList)(e,t,i)).command&&"update"!==e.command||(i=await(0,_readEntity.readEntity)(e.entity,i),i[e.entity]=e.conditions.reduce(((e,t)=>(0,_where.where)(e,t)),i[e.entity])),e.command){case"delete":i=await(0,_deleteEntity.deleteEntity)(e.entity,i);break;case"insert":i=await(0,_insertEntity.insertEntity)(e.entity,e.insertValues,i);break;case"read":i=await(0,_readEntity.readEntity)(e.entity,i);break;case"update":i=await(0,_updateEntity.updateEntity)(e.entity,e.updateValues,i);break;default:throw new Error(`Unknown command: ${e.command}`)}return i=await(0,_joinEntity.joinEntity)(e.entity,e.joinEntity,i,e.joinClauses),i=await(0,_mergeJoins.mergeJoins)(i,e.mergeJoins),"delete"!==e.command&&"update"!==e.command&&(i[e.entity]=e.conditions.reduce(((e,t)=>(0,_where.where)(e,t)),i[e.entity])),i[e.entity]=(0,_sortBy.sortBy)(i[e.entity],e.sortClauses),i[e.entity]=(0,_limitOffset.limitOffset)(i[e.entity],e.offset,e.limit),i[e.entity]=(0,_groupBy.groupBy)(i[e.entity],e.groupBy),i[e.entity]=(0,_selectFields.selectFields)(i[e.entity],e.selectClauses),i};exports.runQuery=runQuery;

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "json-fs-query",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "description": "Use json files to manage and read data.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "unpkg": "browser/jsonFsQuery.min.js",
+  "jsdelivr": "browser/jsonFsQuery.min.js",
   "files": [
-    "dist"
+    "dist",
+    "browser"
   ],
   "scripts": {
     "build": "gulp build",
@@ -36,9 +39,9 @@
   "homepage": "https://github.com/jheagle/json-file-db#readme",
   "devDependencies": {
     "gulp": "^5.0.1",
-    "js-build-tools": "^5.3.2",
-    "typedoc": "^0.28.20",
-    "test-filesystem": "^1.3.14"
+    "js-build-tools": "^5.4.0",
+    "test-filesystem": "^1.3.14",
+    "typedoc": "^0.28.20"
   },
   "dependencies": {
     "browser-or-node": "^3.0.0",