@nymphjs/query-parser 1.0.0-beta.10 → 1.0.0-beta.101

package/src/queryParser.ts

@@ -1,10 +1,10 @@
 import type { EntityConstructor, Options, Selector } from '@nymphjs/client';
-import splitn from '@sciactive/splitn';
+import { splitn } from '@sciactive/splitn';
 
 export type BareQueryHandler = (
   input: string,
   entityClass?: EntityConstructor,
-  defaultFields?: string[]
+  defaultFields?: string[],
 ) => Partial<Selector>;
 
 export type QRefMap = {
@@ -12,7 +12,7 @@ export type QRefMap = {
 };
 
 export default function queryParser<
-  T extends EntityConstructor = EntityConstructor
+  T extends EntityConstructor = EntityConstructor,
 >({
   query,
   entityClass,
@@ -27,7 +27,7 @@ export default function queryParser<
         type: '|',
         ilike: defaultFields.map((field) => [field, input]) as [
           string,
-          string
+          string,
         ][],
       };
     }
@@ -90,7 +90,8 @@ function selectorsParser({
     } else if (inQuote) {
       continue;
     } else if (curQuery[i] === '(') {
-      if (currentStart == null) {
+      const searchClause = i !== 0 && !curQuery[i - 1].match(/\s/);
+      if (currentStart == null && !searchClause) {
         currentStart = i;
       } else {
         nesting++;
@@ -144,7 +145,7 @@ function selectorsParser({
           defaultFields,
           qrefMap,
           bareHandler,
-        })
+        }),
       );
     }
   }
@@ -171,6 +172,16 @@ function selectorsParser({
     }
     curQuery = curQuery.replace(offsetRegex, '');
 
+    // JavaScript variable names are ridiculously infeasable to check
+    // thoroughly, so this is a "best attempt".
+    const sortRegex =
+      /(?: |^)sort:([_$a-zA-Z\xA0-\uFFFF][_$a-zA-Z0-9\xA0-\uFFFF]*)(?= |$)/;
+    const sortMatch = curQuery.match(sortRegex);
+    if (sortMatch) {
+      options.sort = sortMatch[1];
+    }
+    curQuery = curQuery.replace(sortRegex, '');
+
     const reverseRegex = /(?: |^)reverse:(true|false|1|0)(?= |$)/;
     const reverseMatch = curQuery.match(reverseRegex);
     if (reverseMatch) {
@@ -222,8 +233,35 @@ function selectorParser({
 }): string {
   let curQuery = query;
 
+  // eg. prop(some search string) or prop!(some search string)
+  const searchRegex = /(?: |^)([^\s=\[\]<>{}]+?)!?\([^\)]+\)(?= |$)/g;
+  const searchMatch = curQuery.match(searchRegex);
+  if (searchMatch) {
+    selector.search = [];
+    selector['!search'] = [];
+    for (let match of searchMatch) {
+      try {
+        let [name, value] = splitn(match.trim().slice(0, -1), '(', 2);
+        if (name.endsWith('!')) {
+          selector['!search'].push([name.slice(0, -1), value]);
+        } else {
+          selector.search.push([name, value]);
+        }
+      } catch (e: any) {
+        continue;
+      }
+    }
+    if (!selector.search.length) {
+      delete selector.search;
+    }
+    if (!selector['!search'].length) {
+      delete selector['!search'];
+    }
+  }
+  curQuery = curQuery.replace(searchRegex, '');
+
   // eg. user<{User name="Hunter"}> or user!<{User name="Hunter"}>
-  const qrefRegex = /(?: |^)(\w+)!?<\{(\w+) (.*?[^\\])\}>(?= |$)/g;
+  const qrefRegex = /(?: |^)([^\s=\[\]<>{}]+?)!?<\{(\w+) (.*?[^\\])\}>(?= |$)/g;
   const qrefMatch = curQuery.match(qrefRegex);
   if (qrefMatch) {
     selector.qref = [];
@@ -232,7 +270,7 @@ function selectorParser({
       try {
         let [name, value] = splitn(match.trim().slice(0, -1), '<', 2);
         value = unQuoteCurlies(value.slice(1, -1));
-        let [className, qrefQuery] = value.split(' ', 2);
+        let [className, qrefQuery] = splitn(value, ' ', 2);
         const EntityClass = qrefMap[className].class;
         if (EntityClass == null) {
           continue;
@@ -262,50 +300,114 @@ function selectorParser({
   }
   curQuery = curQuery.replace(qrefRegex, '');
 
-  // eg. name=Marty or name="Marty McFly" or enabled=true or someArray=[1,2]
-  const equalRegex = /(?: |^)(\w+)!?=(""|".*?[^\\]"|[^ ]+)(?= |$)/g;
+  // eg. someArray=[1,2] or someObject={"prop":"some value"}
+  const equalJsonRegex = /(?: |^)([^\s=\[\]<>{}]+?)!?=(\{|\[)/g;
+  const equalJsonMatch = [...curQuery.matchAll(equalJsonRegex)];
+  if (equalJsonMatch) {
+    if (!('equal' in selector)) {
+      selector.equal = [];
+    }
+    if (!('!equal' in selector)) {
+      selector['!equal'] = [];
+    }
+    // Work backward to find all long JSON values.
+    for (let i = equalJsonMatch.length - 1; i >= 0; i--) {
+      const match = equalJsonMatch[i];
+      let [name, opener] = splitn(match[0].trim(), '=', 2);
+      let start = match.index + match[0].length - 1;
+      let nextEndToken = curQuery.indexOf(opener === '{' ? '}' : ']', start);
+      while (nextEndToken !== -1) {
+        try {
+          if (name.endsWith('!')) {
+            (selector['!equal'] as [string, any][]).unshift([
+              name.slice(0, -1),
+              JSON.parse(curQuery.substring(start, nextEndToken + 1)),
+            ]);
+          } else {
+            (selector.equal as [string, any][]).unshift([
+              name,
+              JSON.parse(curQuery.substring(start, nextEndToken + 1)),
+            ]);
+          }
+
+          curQuery =
+            curQuery.substring(0, match.index) +
+            curQuery.substring(nextEndToken + 1);
+          break;
+        } catch (e: any) {
+          nextEndToken = curQuery.indexOf(
+            opener === '{' ? '}' : ']',
+            nextEndToken + 1,
+          );
+        }
+      }
+    }
+    if (selector.equal == null || !selector.equal.length) {
+      delete selector.equal;
+    }
+    if (selector['!equal'] == null || !selector['!equal'].length) {
+      delete selector['!equal'];
+    }
+  }
+
+  // eg. name=Marty or name="Marty McFly" or enabled=true
+  const equalRegex =
+    /(?: |^)([^\s=\[\]<>{}]+?)!?=(""|".*?[^\\]"|[^ ]+)(?= |$)/g;
   const equalMatch = curQuery.match(equalRegex);
   if (equalMatch) {
-    selector.equal = [];
-    selector['!equal'] = [];
+    if (!('equal' in selector)) {
+      selector.equal = [];
+    }
+    if (!('!equal' in selector)) {
+      selector['!equal'] = [];
+    }
     for (let match of equalMatch) {
       try {
-        let [name, value] = match.trim().split('=', 2);
+        let [name, value] = splitn(match.trim(), '=', 2);
         try {
           if (name.endsWith('!')) {
-            selector['!equal'].push([name.slice(0, -1), JSON.parse(value)]);
+            (selector['!equal'] as [string, any][]).push([
+              name.slice(0, -1),
+              JSON.parse(value),
+            ]);
           } else {
-            selector.equal.push([name, JSON.parse(value)]);
+            (selector.equal as [string, any][]).push([name, JSON.parse(value)]);
           }
         } catch (e: any) {
           if (name.endsWith('!')) {
-            selector['!equal'].push([name.slice(0, -1), unQuoteString(value)]);
+            (selector['!equal'] as [string, any][]).push([
+              name.slice(0, -1),
+              unQuoteString(value),
+            ]);
           } else {
-            selector.equal.push([name, unQuoteString(value)]);
+            (selector.equal as [string, any][]).push([
+              name,
+              unQuoteString(value),
+            ]);
           }
         }
       } catch (e: any) {
         continue;
       }
     }
-    if (!selector.equal.length) {
+    if (selector.equal == null || !selector.equal.length) {
       delete selector.equal;
     }
-    if (!selector['!equal'].length) {
+    if (selector['!equal'] == null || !selector['!equal'].length) {
       delete selector['!equal'];
     }
   }
   curQuery = curQuery.replace(equalRegex, '');
 
   // eg. user<{790274347f9b3a018c2cedee}> or user!<{790274347f9b3a018c2cedee}>
-  const refRegex = /(?: |^)(\w+)!?<\{([0-9a-f]{24})\}>(?= |$)/g;
+  const refRegex = /(?: |^)([^\s=\[\]<>{}]+?)!?<\{([0-9a-f]{24})\}>(?= |$)/g;
   const refMatch = curQuery.match(refRegex);
   if (refMatch) {
     selector.ref = [];
     selector['!ref'] = [];
     for (let match of refMatch) {
       try {
-        let [name, value] = match.trim().slice(0, -1).split('<', 2);
+        let [name, value] = splitn(match.trim().slice(0, -1), '<', 2);
         if (name.endsWith('!')) {
           selector['!ref'].push([name.slice(0, -1), value.slice(1, -1)]);
         } else {
@@ -325,31 +427,32 @@ function selectorParser({
   curQuery = curQuery.replace(refRegex, '');
 
   // eg. someArrayOfNumbers<10> or someObject!<"some string">
-  const containRegex = /(?: |^)(\w+)!?(<.*?[^\\]>)(?= |$)/g;
+  const containRegex =
+    /(?: |^)([^\s=\[\]<>{}]+?)!?(<(?:[^"][^>]*?|".*?[^\\]"))>(?= |$)/g;
   const containMatch = curQuery.match(containRegex);
   if (containMatch) {
     selector.contain = [];
     selector['!contain'] = [];
     for (let match of containMatch) {
       try {
-        let [name, value] = match.trim().slice(0, -1).split('<', 2);
+        let [name, value] = splitn(match.trim().slice(0, -1), '<', 2);
         try {
           if (name.endsWith('!')) {
             selector['!contain'].push([
               name.slice(0, -1),
-              JSON.parse(unQuoteAngles(value)),
+              JSON.parse(unQuoteString(value)),
             ]);
           } else {
-            selector.contain.push([name, JSON.parse(unQuoteAngles(value))]);
+            selector.contain.push([name, JSON.parse(unQuoteString(value))]);
           }
         } catch (e: any) {
           if (name.endsWith('!')) {
             selector['!contain'].push([
               name.slice(0, -1),
-              unQuoteAngles(value),
+              unQuoteString(value),
             ]);
           } else {
-            selector.contain.push([name, unQuoteAngles(value)]);
+            selector.contain.push([name, unQuoteString(value)]);
           }
         }
       } catch (e: any) {
@@ -366,7 +469,8 @@ function selectorParser({
   curQuery = curQuery.replace(containRegex, '');
 
   // eg. name~/Hunter/ or name!~/hunter/i
-  const posixRegex = /(?: |^)(\w+)!?~(\/\/|\/.*?[^\\]\/)i?(?= |$)/g;
+  const posixRegex =
+    /(?: |^)([^\s=\[\]<>{}]+?)!?~(\/\/|\/.*?[^\\]\/)i?(?= |$)/g;
   const posixMatch = curQuery.match(posixRegex);
   if (posixMatch) {
     selector.match = [];
@@ -375,7 +479,7 @@ function selectorParser({
     selector['!imatch'] = [];
     for (let match of posixMatch) {
       try {
-        let [name, value] = match.trim().split('~', 2);
+        let [name, value] = splitn(match.trim(), '~', 2);
         if (name.endsWith('!')) {
           if (value.endsWith('i')) {
             selector['!imatch'].push([
@@ -415,7 +519,8 @@ function selectorParser({
   curQuery = curQuery.replace(posixRegex, '');
 
   // eg. name~Hunter or name!~"hunter"i
-  const likeRegex = /(?: |^)(\w+)!?~(""i?|".*?[^\\]"i?|[^ ]+)(?= |$)/g;
+  const likeRegex =
+    /(?: |^)([^\s=\[\]<>{}]+?)!?~(""i?|".*?[^\\]"i?|[^ ]+)(?= |$)/g;
   const likeMatch = curQuery.match(likeRegex);
   if (likeMatch) {
     selector.like = [];
@@ -424,7 +529,7 @@ function selectorParser({
     selector['!ilike'] = [];
     for (let match of likeMatch) {
       try {
-        let [name, value] = match.trim().split('~', 2);
+        let [name, value] = splitn(match.trim(), '~', 2);
         if (name.endsWith('!')) {
           if (value.endsWith('"i')) {
             selector['!ilike'].push([
@@ -488,7 +593,7 @@ function selectorParser({
   curQuery = curQuery.replace(guidRegex, '');
 
   // eg. [enabled] or [!defaultPrimaryGroup]
-  const truthyRegex = /(?: |^)\[(!?\w+)\](?= |$)/g;
+  const truthyRegex = /(?: |^)\[(!?[^\s=\[\]<>{}]+?)\](?= |$)/g;
   const truthyMatch = curQuery.match(truthyRegex);
   if (truthyMatch) {
     selector.truthy = [];
@@ -542,13 +647,13 @@ function selectorParser({
   curQuery = curQuery.replace(tagRegex, '');
 
   // eg. cdate>15
-  const gtRegex = /(?: |^)(\w+)>(-?\d+(?:\.\d+)?)(?= |$)/g;
+  const gtRegex = /(?: |^)([^\s=\[\]<>{}]+?)>(-?\d+(?:\.\d+)?)(?= |$)/g;
   const gtMatch = curQuery.match(gtRegex);
   if (gtMatch) {
     selector.gt = [];
     for (let match of gtMatch) {
       try {
-        let [name, value] = match.trim().split('>', 2);
+        let [name, value] = splitn(match.trim(), '>', 2);
         selector.gt.push([name, Number(value)]);
       } catch (e: any) {
         continue;
@@ -561,7 +666,7 @@ function selectorParser({
   curQuery = curQuery.replace(gtRegex, '');
 
   // eg. cdate>yesterday or cdate>"2 days ago"
-  const gtRelativeRegex = /(?: |^)(\w+)>(\w+|"[^"]+")(?= |$)/g;
+  const gtRelativeRegex = /(?: |^)([^\s=\[\]<>{}]+?)>(\w+|"[^"]+")(?= |$)/g;
   const gtRelativeMatch = curQuery.match(gtRelativeRegex);
   if (gtRelativeMatch) {
     if (selector.gt == null) {
@@ -569,7 +674,7 @@ function selectorParser({
     }
     for (let match of gtRelativeMatch) {
       try {
-        let [name, value] = match.trim().split('>', 2);
+        let [name, value] = splitn(match.trim(), '>', 2);
         (selector.gt as [string, null, string][]).push([
           name,
           null,
@@ -586,13 +691,13 @@ function selectorParser({
   curQuery = curQuery.replace(gtRelativeRegex, '');
 
   // eg. cdate>=15
-  const gteRegex = /(?: |^)(\w+)>=(-?\d+(?:\.\d+)?)(?= |$)/g;
+  const gteRegex = /(?: |^)([^\s=\[\]<>{}]+?)>=(-?\d+(?:\.\d+)?)(?= |$)/g;
   const gteMatch = curQuery.match(gteRegex);
   if (gteMatch) {
     selector.gte = [];
     for (let match of gteMatch) {
       try {
-        let [name, value] = match.trim().split('>=', 2);
+        let [name, value] = splitn(match.trim(), '>=', 2);
         selector.gte.push([name, Number(value)]);
       } catch (e: any) {
         continue;
@@ -605,7 +710,7 @@ function selectorParser({
   curQuery = curQuery.replace(gteRegex, '');
 
   // eg. cdate>=yesterday or cdate>="2 days ago"
-  const gteRelativeRegex = /(?: |^)(\w+)>=(\w+|"[^"]+")(?= |$)/g;
+  const gteRelativeRegex = /(?: |^)([^\s=\[\]<>{}]+?)>=(\w+|"[^"]+")(?= |$)/g;
   const gteRelativeMatch = curQuery.match(gteRelativeRegex);
   if (gteRelativeMatch) {
     if (selector.gte == null) {
@@ -613,7 +718,7 @@ function selectorParser({
     }
     for (let match of gteRelativeMatch) {
       try {
-        let [name, value] = match.trim().split('>=', 2);
+        let [name, value] = splitn(match.trim(), '>=', 2);
         (selector.gte as [string, null, string][]).push([
           name,
           null,
@@ -630,13 +735,13 @@ function selectorParser({
   curQuery = curQuery.replace(gteRelativeRegex, '');
 
   // eg. cdate<15
-  const ltRegex = /(?: |^)(\w+)<(-?\d+(?:\.\d+)?)(?= |$)/g;
+  const ltRegex = /(?: |^)([^\s=\[\]<>{}]+?)<(-?\d+(?:\.\d+)?)(?= |$)/g;
   const ltMatch = curQuery.match(ltRegex);
   if (ltMatch) {
     selector.lt = [];
     for (let match of ltMatch) {
       try {
-        let [name, value] = match.trim().split('<', 2);
+        let [name, value] = splitn(match.trim(), '<', 2);
         selector.lt.push([name, Number(value)]);
       } catch (e: any) {
         continue;
@@ -649,7 +754,7 @@ function selectorParser({
   curQuery = curQuery.replace(ltRegex, '');
 
   // eg. cdate<yesterday or cdate<"2 days ago"
-  const ltRelativeRegex = /(?: |^)(\w+)<(\w+|"[^"]+")(?= |$)/g;
+  const ltRelativeRegex = /(?: |^)([^\s=\[\]<>{}]+?)<(\w+|"[^"]+")(?= |$)/g;
   const ltRelativeMatch = curQuery.match(ltRelativeRegex);
   if (ltRelativeMatch) {
     if (selector.lt == null) {
@@ -657,7 +762,7 @@ function selectorParser({
     }
     for (let match of ltRelativeMatch) {
       try {
-        let [name, value] = match.trim().split('<', 2);
+        let [name, value] = splitn(match.trim(), '<', 2);
         (selector.lt as [string, null, string][]).push([
           name,
           null,
@@ -674,13 +779,13 @@ function selectorParser({
   curQuery = curQuery.replace(ltRelativeRegex, '');
 
   // eg. cdate<=15
-  const lteRegex = /(?: |^)(\w+)<=(-?\d+(?:\.\d+)?)(?= |$)/g;
+  const lteRegex = /(?: |^)([^\s=\[\]<>{}]+?)<=(-?\d+(?:\.\d+)?)(?= |$)/g;
   const lteMatch = curQuery.match(lteRegex);
   if (lteMatch) {
     selector.lte = [];
     for (let match of lteMatch) {
       try {
-        let [name, value] = match.trim().split('<=', 2);
+        let [name, value] = splitn(match.trim(), '<=', 2);
         selector.lte.push([name, Number(value)]);
       } catch (e: any) {
         continue;
@@ -693,7 +798,7 @@ function selectorParser({
   curQuery = curQuery.replace(lteRegex, '');
 
   // eg. cdate<=yesterday or cdate<="2 days ago"
-  const lteRelativeRegex = /(?: |^)(\w+)<=(\w+|"[^"]+")(?= |$)/g;
+  const lteRelativeRegex = /(?: |^)([^\s=\[\]<>{}]+?)<=(\w+|"[^"]+")(?= |$)/g;
   const lteRelativeMatch = curQuery.match(lteRelativeRegex);
   if (lteRelativeMatch) {
     if (selector.lte == null) {
@@ -701,7 +806,7 @@ function selectorParser({
     }
     for (let match of lteRelativeMatch) {
       try {
-        let [name, value] = match.trim().split('<=', 2);
+        let [name, value] = splitn(match.trim(), '<=', 2);
         (selector.lte as [string, null, string][]).push([
           name,
           null,

package/tsconfig.json

@@ -2,12 +2,14 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
-    "lib": ["DOM", "ES2021"],
-    "target": "ES2021",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "lib": ["DOM", "ES2022"],
+    "target": "ES2022",
     "noImplicitAny": true,
-    "removeComments": true,
+    "removeComments": false,
     "sourceMap": true,
-    "outDir": "lib",
+    "outDir": "dist",
     "resolveJsonModule": true,
     "rootDir": "src/",
     "declaration": true

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}

package/webpack.config.js

@@ -1,28 +0,0 @@
-const path = require('path');
-
-module.exports = {
-  mode: 'production',
-  devtool: 'source-map',
-  entry: {
-    NymphClient: './lib/index.js',
-  },
-  output: {
-    path: path.resolve(__dirname, 'dist'),
-    filename: 'index.js',
-    library: ['@nymphjs/client'],
-    libraryTarget: 'umd',
-    globalObject: 'this',
-  },
-  resolve: {
-    extensions: ['.tsx', '.ts', '.js'],
-  },
-  module: {
-    rules: [
-      {
-        test: /\.tsx?$/,
-        use: 'ts-loader',
-        exclude: /node_modules/,
-      },
-    ],
-  },
-};