json-fs-query 1.1.0 → 2.0.0

package/dist/data/queries/parser.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parser=void 0;var _splitQueries=require("../utilities/parsers/splitQueries"),_parseQuery=require("../utilities/parsers/parseQuery");const parser=(e="")=>{const r=(0,_splitQueries.splitQueries)(e),s=[];let t="";for(const e of r){t=t?`${t}${e}`:e;let r={};try{r=(0,_parseQuery.parseQuery)(t),t=""}catch(e){continue}s.push(r)}if(t)throw new Error(`Failed to interpret: ${t}`);return s};exports.parser=parser;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.parser=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _splitQueries=require("../utilities/parsers/splitQueries"),_parseQuery=require("../utilities/parsers/parseQuery");const parser=(e="")=>{const r=(0,_splitQueries.splitQueries)(e);return r.map(((e,s)=>{try{return(0,_parseQuery.parseQuery)(e)}catch(t){const i=r.length>1?` query ${s+1} of ${r.length}`:"";throw new Error(`Failed to interpret${i}: ${e} (${t.message})`)}}))};exports.parser=parser;

package/dist/data/queries/query.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Parse a query string (one query, or several separated by `;`) and run each query in turn, resolving to one result
+ * per query. The queries of one call run together, under the database lock: no other call's queries run between
+ * them (see withDatabaseLock).
+ * @param queryString
+ */
 export declare const query: (queryString?: string) => Promise<any[]>;
 //# sourceMappingURL=query.d.ts.map

package/dist/data/queries/query.js

@@ -6,13 +6,22 @@ Object.defineProperty(exports, "__esModule", {
 exports.query = void 0;
 var _parser = require("./parser");
 var _runQuery = require("../utilities/runQuery");
+var _databaseLock = require("../utilities/databaseLock");
+/**
+ * Parse a query string (one query, or several separated by `;`) and run each query in turn, resolving to one result
+ * per query. The queries of one call run together, under the database lock: no other call's queries run between
+ * them (see withDatabaseLock).
+ * @param queryString
+ */
 const query = async (queryString = '') => {
   const parsedQueries = (0, _parser.parser)(queryString);
-  const queryResults = [];
-  for (const parsed of parsedQueries) {
-    const dataSet = await (0, _runQuery.runQuery)(parsed);
-    queryResults.push(dataSet[parsed.entity]);
-  }
-  return queryResults;
+  return (0, _databaseLock.withDatabaseLock)(async () => {
+    const queryResults = [];
+    for (const parsed of parsedQueries) {
+      const dataSet = await (0, _runQuery.runQuery)(parsed);
+      queryResults.push(dataSet[parsed.entity]);
+    }
+    return queryResults;
+  });
 };
 exports.query = query;

package/dist/data/queries/query.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.query=void 0;var _parser=require("./parser"),_runQuery=require("../utilities/runQuery");const query=async(r="")=>{const e=(0,_parser.parser)(r),u=[];for(const r of e){const e=await(0,_runQuery.runQuery)(r);u.push(e[r.entity])}return u};exports.query=query;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.query=void 0;var _parser=require("./parser"),_runQuery=require("../utilities/runQuery"),_databaseLock=require("../utilities/databaseLock");const query=async(e="")=>{const r=(0,_parser.parser)(e);return(0,_databaseLock.withDatabaseLock)((async()=>{const e=[];for(const t of r){const r=await(0,_runQuery.runQuery)(t);e.push(r[t.entity])}return e}))};exports.query=query;

package/dist/data/queries/queryStatus.d.ts

@@ -0,0 +1,15 @@
+export type QueryStatus = {
+    complete: boolean;
+    waitingFor: string;
+};
+/**
+ * Whether some query text, typed so far, is ready to run, and if not what it is waiting for: for a prompt which
+ * reads a query over several lines (such as the CLI). Uses the same rules as the parser, so a `;` inside a string,
+ * a comment or brackets doesn't count, and an open quote, comment or bracket keeps the query going.
+ * @example
+ * queryStatus("read notes where text = 'it") // { complete: false, waitingFor: "'" }
+ * queryStatus('read notes;') // { complete: true, waitingFor: '' }
+ * @param text - everything typed so far; join the lines with '\n', since a `--` comment ends at the end of a line
+ */
+export declare const queryStatus: (text?: string) => QueryStatus;
+//# sourceMappingURL=queryStatus.d.ts.map

package/dist/data/queries/queryStatus.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.queryStatus = void 0;
+var _scanQuery = require("../utilities/parsers/scanQuery");
+/**
+ * Whether some query text, typed so far, is ready to run, and if not what it is waiting for: for a prompt which
+ * reads a query over several lines (such as the CLI). Uses the same rules as the parser, so a `;` inside a string,
+ * a comment or brackets doesn't count, and an open quote, comment or bracket keeps the query going.
+ * @example
+ * queryStatus("read notes where text = 'it") // { complete: false, waitingFor: "'" }
+ * queryStatus('read notes;') // { complete: true, waitingFor: '' }
+ * @param text - everything typed so far; join the lines with '\n', since a `--` comment ends at the end of a line
+ */
+const queryStatus = (text = '') => {
+  const {
+    end,
+    closed,
+    terminated
+  } = (0, _scanQuery.scanQuery)(text);
+  if (terminated) {
+    return {
+      complete: true,
+      waitingFor: ''
+    };
+  }
+  if (end.quote) {
+    return {
+      complete: false,
+      waitingFor: end.quote
+    };
+  }
+  if (end.blockComment) {
+    return {
+      complete: false,
+      waitingFor: '/*'
+    };
+  }
+  if (!closed) {
+    return {
+      complete: false,
+      waitingFor: end.brackets[end.brackets.length - 1]
+    };
+  }
+  return {
+    complete: false,
+    waitingFor: ';'
+  };
+};
+exports.queryStatus = queryStatus;

package/dist/data/queries/queryStatus.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.queryStatus=void 0;var _scanQuery=require("../utilities/parsers/scanQuery");const queryStatus=(e="")=>{const{end:t,closed:r,terminated:o}=(0,_scanQuery.scanQuery)(e);return o?{complete:!0,waitingFor:""}:t.quote?{complete:!1,waitingFor:t.quote}:t.blockComment?{complete:!1,waitingFor:"/*"}:r?{complete:!1,waitingFor:";"}:{complete:!1,waitingFor:t.brackets[t.brackets.length-1]}};exports.queryStatus=queryStatus;

package/dist/data/queries/quote.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Write a value as a quoted string for a query, so any text can be used in one: the backslash and the quote are
+ * escaped, so the parser reads back exactly the text given.
+ * @example
+ * query(`insert exercises values name = ${quote("Farmer's walk")}`)
+ * // insert exercises values name = 'Farmer\'s walk'
+ * @param value - the text to quote (anything else is converted with String first)
+ * @param quoteChar - the quote to wrap it in
+ */
+export declare const quote: (value: any, quoteChar?: "'" | "\"") => string;
+//# sourceMappingURL=quote.d.ts.map

package/dist/data/queries/quote.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.quote = void 0;
+/**
+ * Write a value as a quoted string for a query, so any text can be used in one: the backslash and the quote are
+ * escaped, so the parser reads back exactly the text given.
+ * @example
+ * query(`insert exercises values name = ${quote("Farmer's walk")}`)
+ * // insert exercises values name = 'Farmer\'s walk'
+ * @param value - the text to quote (anything else is converted with String first)
+ * @param quoteChar - the quote to wrap it in
+ */
+const quote = (value, quoteChar = '\'') => `${quoteChar}${String(value).replace(/\\/g, '\\\\').split(quoteChar).join(`\\${quoteChar}`)}${quoteChar}`;
+exports.quote = quote;

package/dist/data/queries/quote.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.quote=void 0;const quote=(e,t="'")=>`${t}${String(e).replace(/\\/g,"\\\\").split(t).join(`\\${t}`)}${t}`;exports.quote=quote;

package/dist/data/queries/showRecords.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Run `show records`: the name of every record in the __RECORDS registry, in the order they were created. A database
+ * with no records yet (no registry file) gives an empty list.
+ */
+export declare const showRecords: () => Promise<string[]>;
+//# sourceMappingURL=showRecords.d.ts.map

package/dist/data/queries/showRecords.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.showRecords = void 0;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.map.js");
+var _retrieveRecord = require("../utilities/retrieveRecord");
+var _recordExists = require("../utilities/recordExists");
+/**
+ * Run `show records`: the name of every record in the __RECORDS registry, in the order they were created. A database
+ * with no records yet (no registry file) gives an empty list.
+ */
+const showRecords = async () => {
+  if (!(0, _recordExists.recordExists)('__RECORDS')) {
+    return [];
+  }
+  return (await (0, _retrieveRecord.retrieveRecord)('__RECORDS')).entries.map(fileName => fileName.replace(/\.json$/, ''));
+};
+exports.showRecords = showRecords;

package/dist/data/queries/showRecords.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.showRecords=void 0,require("core-js/modules/esnext.iterator.constructor.js"),require("core-js/modules/esnext.iterator.map.js");var _retrieveRecord=require("../utilities/retrieveRecord"),_recordExists=require("../utilities/recordExists");const showRecords=async()=>(0,_recordExists.recordExists)("__RECORDS")?(await(0,_retrieveRecord.retrieveRecord)("__RECORDS")).entries.map((e=>e.replace(/\.json$/,""))):[];exports.showRecords=showRecords;

package/dist/data/queries/sortBy.js

@@ -1,28 +1,28 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.sortBy = void 0;
-const sortBy = (dataSet = [], sortClauses = []) => {
-  if (!sortClauses.length) {
-    return dataSet;
-  }
-  dataSet.sort((a, b) => {
-    for (const sortClause of sortClauses) {
-      const property = sortClause.property;
-      const direction = sortClause.direction;
-      // Ordering compares the raw stored values, not by declared type (that's only for equality, see where), so
-      // numeric ids in a string field still sort numerically. Loose so '3' and 3 still tie.
-      // eslint-disable-next-line eqeqeq
-      if (a[property] == b[property]) {
-        continue;
-      }
-      const result = a[property] < b[property] ? -1 : 1;
-      return direction === 'asc' ? result : result * -1;
-    }
-    return 0;
-  });
-  return dataSet;
-};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sortBy = void 0;
+const sortBy = (dataSet = [], sortClauses = []) => {
+  if (!sortClauses.length) {
+    return dataSet;
+  }
+  dataSet.sort((a, b) => {
+    for (const sortClause of sortClauses) {
+      const property = sortClause.property;
+      const direction = sortClause.direction;
+      // Ordering compares the raw stored values, not by declared type (that's only for equality, see where), so
+      // numeric ids in a string field still sort numerically. Loose so '3' and 3 still tie.
+      // eslint-disable-next-line eqeqeq
+      if (a[property] == b[property]) {
+        continue;
+      }
+      const result = a[property] < b[property] ? -1 : 1;
+      return direction === 'asc' ? result : result * -1;
+    }
+    return 0;
+  });
+  return dataSet;
+};
 exports.sortBy = sortBy;