@nymphjs/query-parser 1.0.0-beta.122 → 1.0.0-beta.124

package/src/queryParser.test.ts

@@ -3,6 +3,13 @@ import queryParser from './queryParser.js';
 
 const BlogPost = function () {} as unknown as typeof Entity;
 const Category = function () {} as unknown as typeof Entity;
+const List = function () {} as unknown as typeof Entity;
+
+const Mail = function () {} as unknown as typeof Entity;
+const Headers = function () {} as unknown as typeof Entity;
+const Body = function () {} as unknown as typeof Entity;
+const Label = function () {} as unknown as typeof Entity;
+const Domain = function () {} as unknown as typeof Entity;
 
 describe('queryParser', () => {
   it('parses a basic query', () => {
@@ -55,13 +62,13 @@ describe('queryParser', () => {
   });
 
   it('gives the correct entity and default fields to bare queries', () => {
-    const query = 'category<{cat search}>';
+    const query = 'category<{Cat search}>';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
       defaultFields: ['text'],
       qrefMap: {
-        cat: {
+        Cat: {
           class: Category,
           defaultFields: ['name'],
         },
@@ -97,13 +104,13 @@ describe('queryParser', () => {
 
   it('parses the example query from the readme', () => {
     const query =
-      'limit:4 foobar (| [archived] mdate<"2 weeks ago") category<{cat Tech}>';
+      'limit:4 foobar (| [archived] mdate<"2 weeks ago") category<{Cat Tech}>';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
       defaultFields: ['title', 'body'],
       qrefMap: {
-        cat: {
+        Cat: {
           class: Category,
           defaultFields: ['name'],
         },
@@ -289,6 +296,108 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses a query with not search', () => {
+    const query = 'limit:4 foobar -prop(a search string)';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+      defaultFields: ['title', 'body'],
+      qrefMap: {
+        cat: {
+          class: Category,
+          defaultFields: ['name'],
+        },
+      },
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+      limit: 4,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!search': [['prop', 'a search string']],
+      },
+      {
+        type: '|',
+        ilike: [
+          ['title', '%foobar%'],
+          ['body', '%foobar%'],
+        ],
+      },
+    ]);
+  });
+
+  it('parses a query with colon search', () => {
+    const query = 'limit:4 foobar prop:string';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+      defaultFields: ['title', 'body'],
+      qrefMap: {
+        cat: {
+          class: Category,
+          defaultFields: ['name'],
+        },
+      },
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+      limit: 4,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        search: [['prop', 'string']],
+      },
+      {
+        type: '|',
+        ilike: [
+          ['title', '%foobar%'],
+          ['body', '%foobar%'],
+        ],
+      },
+    ]);
+  });
+
+  it('parses a query with not colon search', () => {
+    const query = 'limit:4 foobar -prop:string';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+      defaultFields: ['title', 'body'],
+      qrefMap: {
+        cat: {
+          class: Category,
+          defaultFields: ['name'],
+        },
+      },
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+      limit: 4,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!search': [['prop', 'string']],
+      },
+      {
+        type: '|',
+        ilike: [
+          ['title', '%foobar%'],
+          ['body', '%foobar%'],
+        ],
+      },
+    ]);
+  });
+
   it('parses a query with search in a selector', () => {
     const query =
       'limit:4 foobar (| prop(a search string) prop2("another search string"))';
@@ -332,6 +441,53 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses a query with colon search in a selector', () => {
+    const query =
+      'limit:4 foobar (| prop:string prop2:"another search string" -prop3:pickle -prop4:\'another -pickle string\')';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+      defaultFields: ['title', 'body'],
+      qrefMap: {
+        cat: {
+          class: Category,
+          defaultFields: ['name'],
+        },
+      },
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+      limit: 4,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        selector: [
+          {
+            type: '|',
+            search: [
+              ['prop', 'string'],
+              ['prop2', '"another search string"'],
+            ],
+            '!search': [
+              ['prop3', 'pickle'],
+              ['prop4', "'another -pickle string'"],
+            ],
+          },
+        ],
+      },
+      {
+        type: '|',
+        ilike: [
+          ['title', '%foobar%'],
+          ['body', '%foobar%'],
+        ],
+      },
+    ]);
+  });
+
   it('parses a query with lt and tag', () => {
     const query = 'limit:4 foobar mdate<"2 weeks ago" <tag>';
     const [options, ...selectors] = queryParser({
@@ -537,7 +693,7 @@ describe('queryParser', () => {
   });
 
   it('parses simple not equal clauses', () => {
-    const query = 'prop!=string';
+    const query = '-prop=string';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -575,7 +731,7 @@ describe('queryParser', () => {
   });
 
   it('parses quoted not equal clauses', () => {
-    const query = 'prop!="a string"';
+    const query = '-prop="a string"';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -613,7 +769,7 @@ describe('queryParser', () => {
   });
 
   it('parses json not equal clauses', () => {
-    const query = 'prop!=true';
+    const query = '-prop=true';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -651,7 +807,7 @@ describe('queryParser', () => {
   });
 
   it('parses not guid clauses', () => {
-    const query = '{!111111111111111111111111}';
+    const query = '-{111111111111111111111111}';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -689,7 +845,7 @@ describe('queryParser', () => {
   });
 
   it('parses not tag clauses', () => {
-    const query = '<!tagname>';
+    const query = '-<tagname>';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -727,7 +883,7 @@ describe('queryParser', () => {
   });
 
   it('parses not truthy clauses', () => {
-    const query = '[!truthyname]';
+    const query = '-[truthyname]';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -765,7 +921,7 @@ describe('queryParser', () => {
   });
 
   it('parses not ref clauses', () => {
-    const query = 'prop!<{111111111111111111111111}>';
+    const query = '-prop<{111111111111111111111111}>';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -803,7 +959,7 @@ describe('queryParser', () => {
   });
 
   it('parses simple not contain clauses', () => {
-    const query = 'prop!<string>';
+    const query = '-prop<string>';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -841,7 +997,7 @@ describe('queryParser', () => {
   });
 
   it('parses json not contain clauses', () => {
-    const query = 'prop!<true>';
+    const query = '-prop<true>';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -879,7 +1035,7 @@ describe('queryParser', () => {
   });
 
   it('parses not match clauses', () => {
-    const query = 'prop!~/regex/';
+    const query = '-prop~/regex/';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -917,7 +1073,7 @@ describe('queryParser', () => {
   });
 
   it('parses not imatch clauses', () => {
-    const query = 'prop!~/regex/i';
+    const query = '-prop~/regex/i';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -955,7 +1111,7 @@ describe('queryParser', () => {
   });
 
   it('parses simple not like clauses', () => {
-    const query = 'prop!~pattern';
+    const query = '-prop~pattern';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -993,7 +1149,7 @@ describe('queryParser', () => {
   });
 
   it('parses quoted not like clauses', () => {
-    const query = 'prop!~"a pattern"';
+    const query = '-prop~"a pattern"';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -1031,7 +1187,7 @@ describe('queryParser', () => {
   });
 
   it('parses not ilike clauses', () => {
-    const query = 'prop!~"a pattern"i';
+    const query = '-prop~"a pattern"i';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -1068,6 +1224,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple not gt clauses', () => {
+    const query = '-prop>30.5';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!gt': [['prop', 30.5]],
+      },
+    ]);
+  });
+
   it('parses simple relative gt clauses', () => {
     const query = 'prop>yesterday';
     const [options, ...selectors] = queryParser({
@@ -1087,6 +1262,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple relative not gt clauses', () => {
+    const query = '-prop>yesterday';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!gt': [['prop', null, 'yesterday']],
+      },
+    ]);
+  });
+
   it('parses quote relative gt clauses', () => {
     const query = 'prop>"3 weeks ago"';
     const [options, ...selectors] = queryParser({
@@ -1106,6 +1300,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses quote relative not gt clauses', () => {
+    const query = '-prop>"3 weeks ago"';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!gt': [['prop', null, '3 weeks ago']],
+      },
+    ]);
+  });
+
   it('parses simple gte clauses', () => {
     const query = 'prop>=30.5';
     const [options, ...selectors] = queryParser({
@@ -1125,6 +1338,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple not gte clauses', () => {
+    const query = '-prop>=30.5';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!gte': [['prop', 30.5]],
+      },
+    ]);
+  });
+
   it('parses simple relative gte clauses', () => {
     const query = 'prop>=yesterday';
     const [options, ...selectors] = queryParser({
@@ -1144,6 +1376,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple relative not gte clauses', () => {
+    const query = '-prop>=yesterday';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!gte': [['prop', null, 'yesterday']],
+      },
+    ]);
+  });
+
   it('parses quote relative gte clauses', () => {
     const query = 'prop>="3 weeks ago"';
     const [options, ...selectors] = queryParser({
@@ -1163,6 +1414,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses quote relative not gte clauses', () => {
+    const query = '-prop>="3 weeks ago"';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!gte': [['prop', null, '3 weeks ago']],
+      },
+    ]);
+  });
+
   it('parses simple lt clauses', () => {
     const query = 'prop<30.5';
     const [options, ...selectors] = queryParser({
@@ -1182,6 +1452,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple not lt clauses', () => {
+    const query = '-prop<30.5';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!lt': [['prop', 30.5]],
+      },
+    ]);
+  });
+
   it('parses simple relative lt clauses', () => {
     const query = 'prop<yesterday';
     const [options, ...selectors] = queryParser({
@@ -1201,6 +1490,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple relative not lt clauses', () => {
+    const query = '-prop<yesterday';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!lt': [['prop', null, 'yesterday']],
+      },
+    ]);
+  });
+
   it('parses quote relative lt clauses', () => {
     const query = 'prop<"3 weeks ago"';
     const [options, ...selectors] = queryParser({
@@ -1220,6 +1528,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses quote relative not lt clauses', () => {
+    const query = '-prop<"3 weeks ago"';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!lt': [['prop', null, '3 weeks ago']],
+      },
+    ]);
+  });
+
   it('parses simple lte clauses', () => {
     const query = 'prop<=30.5';
     const [options, ...selectors] = queryParser({
@@ -1239,6 +1566,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple not lte clauses', () => {
+    const query = '-prop<=30.5';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!lte': [['prop', 30.5]],
+      },
+    ]);
+  });
+
   it('parses simple relative lte clauses', () => {
     const query = 'prop<=yesterday';
     const [options, ...selectors] = queryParser({
@@ -1258,6 +1604,25 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses simple relative not lte clauses', () => {
+    const query = '-prop<=yesterday';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!lte': [['prop', null, 'yesterday']],
+      },
+    ]);
+  });
+
   it('parses quote relative lte clauses', () => {
     const query = 'prop<="3 weeks ago"';
     const [options, ...selectors] = queryParser({
@@ -1277,9 +1642,28 @@ describe('queryParser', () => {
     ]);
   });
 
+  it('parses quote relative not lte clauses', () => {
+    const query = '-prop<="3 weeks ago"';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!lte': [['prop', null, '3 weeks ago']],
+      },
+    ]);
+  });
+
   it('parses complex selectors', () => {
     const query =
-      '(! [published] <draft>) (| cdate>"6 months ago" mdate>"1 month ago")';
+      '(! [published] <draft>) (| -cdate>"6 months ago" mdate>"1 month ago")';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -1295,10 +1679,8 @@ describe('queryParser', () => {
         selector: [
           {
             type: '|',
-            gt: [
-              ['cdate', null, '6 months ago'],
-              ['mdate', null, '1 month ago'],
-            ],
+            '!gt': [['cdate', null, '6 months ago']],
+            gt: [['mdate', null, '1 month ago']],
           },
           {
             type: '!&',
@@ -1312,7 +1694,7 @@ describe('queryParser', () => {
 
   it('parses nested selectors', () => {
     const query =
-      '(! [published] <draft> (| cdate>"6 months ago" mdate>"1 month ago"))';
+      '(! [published] <draft> (| -cdate>"6 months ago" mdate>"1 month ago"))';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -1330,10 +1712,8 @@ describe('queryParser', () => {
         selector: [
           {
             type: '|',
-            gt: [
-              ['cdate', null, '6 months ago'],
-              ['mdate', null, '1 month ago'],
-            ],
+            '!gt': [['cdate', null, '6 months ago']],
+            gt: [['mdate', null, '1 month ago']],
           },
         ],
       },
@@ -1342,7 +1722,7 @@ describe('queryParser', () => {
 
   it('parses nested qref clauses', () => {
     const query =
-      'categories<{Category parent<{Category id="sort+newsletters"}>}> ';
+      'categories<{Category parent<{Category list<{List frosting name(favorite)}>}> -parent<{Category id="sort+newsletters"}>}>';
     const [options, ...selectors] = queryParser({
       query,
       entityClass: BlogPost,
@@ -1352,6 +1732,10 @@ describe('queryParser', () => {
           class: Category,
           defaultFields: ['name'],
         },
+        List: {
+          class: List,
+          defaultFields: ['name'],
+        },
       },
     });
 
@@ -1370,6 +1754,33 @@ describe('queryParser', () => {
               {
                 type: '&',
                 qref: [
+                  [
+                    'parent',
+                    [
+                      { class: Category },
+                      {
+                        type: '&',
+                        qref: [
+                          [
+                            'list',
+                            [
+                              { class: List },
+                              {
+                                type: '&',
+                                search: [['name', 'favorite']],
+                              },
+                              {
+                                type: '|',
+                                ilike: [['name', '%frosting%']],
+                              },
+                            ],
+                          ],
+                        ],
+                      },
+                    ],
+                  ],
+                ],
+                '!qref': [
                   [
                     'parent',
                     [
@@ -1388,4 +1799,142 @@ describe('queryParser', () => {
       },
     ]);
   });
+
+  it('handles badly nested qref', () => {
+    const query = 'categories<{Category parent<{Category id="top"}>';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: BlogPost,
+    });
+
+    expect(options).toEqual({
+      class: BlogPost,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        contain: [['categories', '{Category parent<{Category}']],
+        equal: [['id', 'top']],
+      },
+    ]);
+  });
+
+  it('parses a realistic query', () => {
+    const query =
+      'labels<{Label [aggbox]}> -[trash] [delivered] -<spam> -<bare> -<autoreply> -<draft> -<sent> limit:10 reverse:true';
+    const [options, ...selectors] = queryParser({
+      query,
+      entityClass: Mail,
+      defaultFields: ['subject', 'from', 'sender'],
+      qrefMap: {
+        Mail: {
+          class: Mail,
+          defaultFields: ['subject', 'from', 'sender'],
+        },
+        Headers: {
+          class: Headers,
+          defaultFields: ['Message-ID'],
+        },
+        Body: {
+          class: Body,
+          defaultFields: ['text'],
+        },
+        Label: {
+          class: Label,
+          defaultFields: ['name', 'id'],
+        },
+        Domain: {
+          class: Domain,
+          defaultFields: ['fqdn'],
+        },
+      },
+      bareHandler: (
+        input,
+        entityClass,
+        defaultFields = ['subject', 'from', 'sender'],
+      ) => {
+        if (entityClass === Mail) {
+          return {
+            type: '|',
+            search: defaultFields.map((field) => [field, input]) as [
+              string,
+              string,
+            ][],
+            qref: [
+              [
+                'body',
+                [
+                  { class: Body },
+                  {
+                    type: '&',
+                    search: ['text', input],
+                  },
+                ],
+              ],
+              [
+                'body',
+                [
+                  { class: Body },
+                  {
+                    type: '&',
+                    search: ['html', input],
+                  },
+                ],
+              ],
+              [
+                'body',
+                [
+                  { class: Body },
+                  {
+                    type: '&',
+                    search: ['attachments', input],
+                  },
+                ],
+              ],
+            ],
+          };
+        }
+        if (defaultFields.length) {
+          return {
+            type: '|',
+            search: defaultFields.map((field) => [field, input]) as [
+              string,
+              string,
+            ][],
+          };
+        }
+        return {};
+      },
+    });
+
+    expect(options).toEqual({
+      class: Mail,
+      limit: 10,
+      reverse: true,
+    });
+
+    expect(selectors).toEqual([
+      {
+        type: '&',
+        '!tag': ['spam', 'bare', 'autoreply', 'draft', 'sent'],
+        '!truthy': ['trash'],
+        qref: [
+          [
+            'labels',
+            [
+              {
+                class: Label,
+              },
+              {
+                truthy: ['aggbox'],
+                type: '&',
+              },
+            ],
+          ],
+        ],
+        truthy: ['delivered'],
+      },
+    ]);
+  });
 });