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

package/dist/queryParser.test.js

@@ -1,6 +1,12 @@
 import queryParser from './queryParser.js';
 const BlogPost = function () { };
 const Category = function () { };
+const List = function () { };
+const Mail = function () { };
+const Headers = function () { };
+const Body = function () { };
+const Label = function () { };
+const Domain = function () { };
 describe('queryParser', () => {
     it('parses a basic query', () => {
         const query = 'search';
@@ -45,13 +51,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'],
                 },
@@ -82,13 +88,13 @@ describe('queryParser', () => {
         ]);
     });
     it('parses the example query from the readme', () => {
-        const query = 'limit:4 foobar (| [archived] mdate<"2 weeks ago") category<{cat Tech}>';
+        const query = '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'],
                 },
@@ -254,6 +260,99 @@ 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"))';
         const [options, ...selectors] = queryParser({
@@ -293,6 +392,49 @@ 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({
@@ -477,7 +619,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses simple not equal clauses', () => {
-        const query = 'prop!=string';
+        const query = '-prop=string';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -509,7 +651,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,
@@ -541,7 +683,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses json not equal clauses', () => {
-        const query = 'prop!=true';
+        const query = '-prop=true';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -573,7 +715,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses not guid clauses', () => {
-        const query = '{!111111111111111111111111}';
+        const query = '-{111111111111111111111111}';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -605,7 +747,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses not tag clauses', () => {
-        const query = '<!tagname>';
+        const query = '-<tagname>';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -637,7 +779,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses not truthy clauses', () => {
-        const query = '[!truthyname]';
+        const query = '-[truthyname]';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -669,7 +811,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses not ref clauses', () => {
-        const query = 'prop!<{111111111111111111111111}>';
+        const query = '-prop<{111111111111111111111111}>';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -701,7 +843,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses simple not contain clauses', () => {
-        const query = 'prop!<string>';
+        const query = '-prop<string>';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -733,7 +875,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses json not contain clauses', () => {
-        const query = 'prop!<true>';
+        const query = '-prop<true>';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -765,7 +907,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses not match clauses', () => {
-        const query = 'prop!~/regex/';
+        const query = '-prop~/regex/';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -797,7 +939,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,
@@ -829,7 +971,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses simple not like clauses', () => {
-        const query = 'prop!~pattern';
+        const query = '-prop~pattern';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -861,7 +1003,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,
@@ -893,7 +1035,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,
@@ -924,6 +1066,22 @@ 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({
@@ -940,6 +1098,22 @@ 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({
@@ -956,6 +1130,22 @@ 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({
@@ -972,6 +1162,22 @@ 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({
@@ -988,6 +1194,22 @@ 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({
@@ -1004,6 +1226,22 @@ 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({
@@ -1020,6 +1258,22 @@ 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({
@@ -1036,6 +1290,22 @@ 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({
@@ -1052,6 +1322,22 @@ 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({
@@ -1068,6 +1354,22 @@ 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({
@@ -1084,6 +1386,22 @@ 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({
@@ -1100,8 +1418,24 @@ 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")';
+        const query = '(! [published] <draft>) (| -cdate>"6 months ago" mdate>"1 month ago")';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -1115,10 +1449,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: '!&',
@@ -1130,7 +1462,7 @@ describe('queryParser', () => {
         ]);
     });
     it('parses nested selectors', () => {
-        const query = '(! [published] <draft> (| cdate>"6 months ago" mdate>"1 month ago"))';
+        const query = '(! [published] <draft> (| -cdate>"6 months ago" mdate>"1 month ago"))';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -1146,17 +1478,15 @@ 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']],
                     },
                 ],
             },
         ]);
     });
     it('parses nested qref clauses', () => {
-        const query = 'categories<{Category parent<{Category id="sort+newsletters"}>}> ';
+        const query = 'categories<{Category parent<{Category list<{List frosting name(favorite)}>}> -parent<{Category id="sort+newsletters"}>}>';
         const [options, ...selectors] = queryParser({
             query,
             entityClass: BlogPost,
@@ -1166,6 +1496,10 @@ describe('queryParser', () => {
                     class: Category,
                     defaultFields: ['name'],
                 },
+                List: {
+                    class: List,
+                    defaultFields: ['name'],
+                },
             },
         });
         expect(options).toEqual({
@@ -1182,6 +1516,33 @@ describe('queryParser', () => {
                             {
                                 type: '&',
                                 qref: [
+                                    [
+                                        'parent',
+                                        [
+                                            { class: Category },
+                                            {
+                                                type: '&',
+                                                qref: [
+                                                    [
+                                                        'list',
+                                                        [
+                                                            { class: List },
+                                                            {
+                                                                type: '&',
+                                                                search: [['name', 'favorite']],
+                                                            },
+                                                            {
+                                                                type: '|',
+                                                                ilike: [['name', '%frosting%']],
+                                                            },
+                                                        ],
+                                                    ],
+                                                ],
+                                            },
+                                        ],
+                                    ],
+                                ],
+                                '!qref': [
                                     [
                                         'parent',
                                         [
@@ -1200,5 +1561,126 @@ 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]),
+                        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]),
+                    };
+                }
+                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'],
+            },
+        ]);
+    });
 });
 //# sourceMappingURL=queryParser.test.js.map