@nymphjs/query-parser 1.0.0-beta.6 → 1.0.0-beta.60

package/src/queryParser.test.ts

@@ -151,7 +151,7 @@ describe('queryParser', () => {
   });
 
   it('parses all options', () => {
-    const query = 'limit:10 offset:15 reverse:true search';
+    const query = 'limit:10 offset:15 sort:someProp reverse:true search';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -162,6 +162,7 @@ describe('queryParser', () => {
       class: BlogPost,
       limit: 10,
       offset: 15,
+      sort: 'someProp',
       reverse: true,
     });
 
@@ -995,4 +996,53 @@ describe('queryParser', () => {
       },
     ]);
   });
+
+  it('parses nested qref clauses', () => {
+    const query =
+      'categories<{Category parent<{Category id="sort+newsletters"}>}> ';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+      defaultFields: ['title', 'body'],
+      qrefMap: {
+        Category: {
+          class: Category,
+          defaultFields: ['name'],
+        },
+      },
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        qref: [
+          [
+            'categories',
+            [
+              { class: Category },
+              {
+                type: '&',
+                qref: [
+                  [
+                    'parent',
+                    [
+                      { class: Category },
+                      {
+                        type: '&',
+                        equal: [['id', 'sort+newsletters']],
+                      },
+                    ],
+                  ],
+                ],
+              },
+            ],
+          ],
+        ],
+      },
+    ]);
+  });
 });

package/src/queryParser.ts

@@ -4,7 +4,7 @@ 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,
         ][],
       };
     }
@@ -144,7 +144,7 @@ function selectorsParser({
           defaultFields,
           qrefMap,
           bareHandler,
-        })
+        }),
       );
     }
   }
@@ -171,6 +171,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) {
@@ -232,7 +242,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;
@@ -270,7 +280,7 @@ function selectorParser({
     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)]);
@@ -305,7 +315,7 @@ function selectorParser({
     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 {
@@ -332,7 +342,7 @@ function selectorParser({
     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([
@@ -375,7 +385,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([
@@ -424,7 +434,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([
@@ -548,7 +558,7 @@ function selectorParser({
     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;
@@ -569,7 +579,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,
@@ -592,7 +602,7 @@ function selectorParser({
     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;
@@ -613,7 +623,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,
@@ -636,7 +646,7 @@ function selectorParser({
     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;
@@ -657,7 +667,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,
@@ -680,7 +690,7 @@ function selectorParser({
     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;
@@ -701,7 +711,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

@@ -5,7 +5,7 @@
     "lib": ["DOM", "ES2021"],
     "target": "ES2021",
     "noImplicitAny": true,
-    "removeComments": true,
+    "removeComments": false,
     "sourceMap": true,
     "outDir": "lib",
     "resolveJsonModule": true,

package/typedoc.json

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