@geekbears/gb-mongoose-query-parser 1.2.1 → 1.3.0

package/README.md

@@ -1,6 +1,5 @@
 # gb-mongoose-query-parser
 
-## Moved to: [@geekbears/gb-mongoose-quey-parser](https://www.npmjs.com/package/@geekbears/gb-mongoose-query-parser)
 
 #### This is a fork from: [mongoose-quey-parser](https://github.com/leodinas-hao/mongoose-query-parser)
 
@@ -103,25 +102,6 @@ const parsed = parser.parse('${vip}&status=${sentStatus}&timestamp>2017-10-01&au
 
 ```
 
-## NestJS Swagger Decorator
-
-This package includes a `@nestjs/swagger` decorator to simplify the documentation of query parameters. The `@ApiStandardQuery()` decorator acts as an alias to `@ApiQuery()` and wraps all the standard query parameters used by Geekbears on `find` and `count` operations.
-
-### Usage
-
-Import the decorator and use it on the corresponding method on the controller class.
-
-```typescript
-import { ApiStandardQuery } from '@geekbears/gb-mongoose-query-parser';
-
-@Get()
-@ApiStandardQuery()
-async find(@Query() query: any): Promise<any> {
-    // Do something
-}
-
-```
-
 
 ## Supported features
 
@@ -404,7 +384,7 @@ const parser = new MongooseQueryParser({
     int: val => parseInt(val, 10),
   },
   castParams: {
-   key3: 'lowercase' 
+   key3: 'lowercase'
   }});
 parser.parse('key1=lowercase(VALUE)&key2=int(10.5)&key3=ABC');
 // {

package/lib/index.d.ts

@@ -1,4 +1,3 @@
 export * from './query-parser';
 export * from './query-parser-helper';
-export * from './decorators';
 export * from './types';

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -12,6 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./query-parser"), exports);
 __exportStar(require("./query-parser-helper"), exports);
-__exportStar(require("./decorators"), exports);
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/lib/query-parser-helper.js

@@ -25,7 +25,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/lib/query-parser.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MongooseQueryParser = void 0;
 var Moment = require("moment");
-var qs = require("querystring");
-var _ = require("lodash");
+var qs_1 = require("qs");
+var lodash_1 = require("lodash");
 var MongooseQueryParser = /** @class */ (function () {
     function MongooseQueryParser(options) {
-        var _this = this;
         if (options === void 0) { options = {}; }
+        var _this = this;
         this.options = options;
         this.defaultDateFormat = [Moment.ISO_8601];
         this.builtInCaster = {
@@ -18,7 +18,7 @@ var MongooseQueryParser = /** @class */ (function () {
                     return m.toDate();
                 }
                 else {
-                    throw new Error("Invalid date string: [" + val + "]");
+                    throw new Error("Invalid date string: [".concat(val, "]"));
                 }
             },
         };
@@ -40,7 +40,7 @@ var MongooseQueryParser = /** @class */ (function () {
         this.options.blacklist = options.blacklist || [];
         this.operators.forEach(function (_a) {
             var operator = _a.operator, method = _a.method, defaultKey = _a.defaultKey;
-            _this.options.blacklist.push(_this.options[operator + "Key"] || defaultKey);
+            _this.options.blacklist.push(_this.options["".concat(operator, "Key")] || defaultKey);
         });
     }
     /**
@@ -51,12 +51,12 @@ var MongooseQueryParser = /** @class */ (function () {
      */
     MongooseQueryParser.prototype.parse = function (query, context) {
         var _this = this;
-        var params = _.isString(query) ? qs.parse(query) : query;
+        var params = (0, lodash_1.isString)(query) ? (0, qs_1.parse)(query) : query;
         var options = this.options;
         var result = {};
         this.operators.forEach(function (_a) {
             var operator = _a.operator, method = _a.method, defaultKey = _a.defaultKey;
-            var key = options[operator + "Key"] || defaultKey;
+            var key = options["".concat(operator, "Key")] || defaultKey;
             var value = params[key];
             if (value || operator === 'filter') {
                 result[operator] = method.call(_this, value, params);
@@ -125,7 +125,7 @@ var MongooseQueryParser = /** @class */ (function () {
         var parsedFilter = filter ? this.parseFilter(filter) : {};
         return Object.keys(params)
             .map(function (val) {
-            var join = params[val] ? val + "=" + params[val] : val;
+            var join = params[val] ? "".concat(val, "=").concat(params[val]) : val;
             // Separate key, operators and value
             var _a = join.match(/(!?)([^><!=]+)([><]=?|!?=|)(.*)/), prefix = _a[1], key = _a[2], op = _a[3], value = _a[4];
             return { prefix: prefix, key: key, op: _this.parseOperator(op), value: _this.parseValue(value, key) };
@@ -165,7 +165,7 @@ var MongooseQueryParser = /** @class */ (function () {
             return JSON.parse(filter);
         }
         catch (err) {
-            throw new Error("Invalid JSON string: " + filter);
+            throw new Error("Invalid JSON string: ".concat(filter));
         }
     };
     MongooseQueryParser.prototype.parseOperator = function (operator) {
@@ -270,7 +270,7 @@ var MongooseQueryParser = /** @class */ (function () {
             return JSON.parse(deepPopulate);
         }
         catch (err) {
-            throw new Error("Invalid JSON string: " + deepPopulate);
+            throw new Error("Invalid JSON string: ".concat(deepPopulate));
         }
     };
     /**
@@ -289,7 +289,7 @@ var MongooseQueryParser = /** @class */ (function () {
      */
     MongooseQueryParser.prototype.parseUnaries = function (unaries, values) {
         if (values === void 0) { values = { plus: 1, minus: -1 }; }
-        var unariesAsArray = _.isString(unaries) ? unaries.split(',') : unaries;
+        var unariesAsArray = (0, lodash_1.isString)(unaries) ? unaries.split(',') : unaries;
         return unariesAsArray
             .map(function (x) { return x.match(/^(\+|-)?(.*)/); })
             .reduce(function (result, _a) {
@@ -341,51 +341,51 @@ var MongooseQueryParser = /** @class */ (function () {
                 var match = str.match(reg);
                 var val = undefined;
                 if (match) {
-                    val = _.property(match[1])(context);
+                    val = (0, lodash_1.property)(match[1])(context);
                     if (val === undefined) {
-                        throw new Error("No predefined query found for the provided reference [" + match[1] + "]");
+                        throw new Error("No predefined query found for the provided reference [".concat(match[1], "]"));
                     }
                 }
                 return { match: !!match, val: val };
             };
             var _transform_1 = function (obj) {
-                return _.reduce(obj, function (prev, curr, key) {
+                return (0, lodash_1.reduce)(obj, function (prev, curr, key) {
                     var _a, _b;
                     var val = undefined, match = undefined;
-                    if (_.isString(key)) {
+                    if ((0, lodash_1.isString)(key)) {
                         (_a = _match_1(key), match = _a.match, val = _a.val);
                         if (match) {
-                            if (_.has(curr, '$exists')) {
+                            if ((0, lodash_1.has)(curr, '$exists')) {
                                 // 1). as a key: {'${qry}': {$exits: true}} => {${qry object}}
-                                return _.merge(prev, val);
+                                return (0, lodash_1.merge)(prev, val);
                             }
-                            else if (_.isString(val)) {
+                            else if ((0, lodash_1.isString)(val)) {
                                 // 1). as a key: {'${qry}': 'something'} => {'${qry object}': 'something'}
                                 key = val;
                             }
                             else {
-                                throw new Error("Invalid query string at " + key);
+                                throw new Error("Invalid query string at ".concat(key));
                             }
                         }
                     }
-                    if (_.isString(curr)) {
+                    if ((0, lodash_1.isString)(curr)) {
                         (_b = _match_1(curr), match = _b.match, val = _b.val);
                         if (match) {
-                            _.isNumber(key)
+                            (0, lodash_1.isNumber)(key)
                                 ? prev.push(val) // 3). as an item of array: ['${qry}', ...] => [${qry object}, ...]
                                 : (prev[key] = val); // 2). as a value: {prop: '${qry}'} => {prop: ${qry object}}
                             return prev;
                         }
                     }
-                    if (_.isObject(curr) && !_.isRegExp(curr) && !_.isDate(curr)) {
+                    if ((0, lodash_1.isObject)(curr) && !(0, lodash_1.isRegExp)(curr) && !(0, lodash_1.isDate)(curr)) {
                         // iterate all props & keys recursively
-                        _.isNumber(key) ? prev.push(_transform_1(curr)) : (prev[key] = _transform_1(curr));
+                        (0, lodash_1.isNumber)(key) ? prev.push(_transform_1(curr)) : (prev[key] = _transform_1(curr));
                     }
                     else {
-                        _.isNumber(key) ? prev.push(curr) : (prev[key] = curr);
+                        (0, lodash_1.isNumber)(key) ? prev.push(curr) : (prev[key] = curr);
                     }
                     return prev;
-                }, _.isArray(obj) ? [] : {});
+                }, (0, lodash_1.isArray)(obj) ? [] : {});
             };
             return _transform_1(query);
         }

package/lib/test.spec.js

@@ -23,7 +23,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -112,7 +112,7 @@ var Tester = /** @class */ (function () {
         var obj = {
             $or: [{ key1: 'value1' }, { key2: 'value2' }],
         };
-        var qry = "filter=" + JSON.stringify(obj) + "&name=Google";
+        var qry = "filter=".concat(JSON.stringify(obj), "&name=Google");
         var parsed = parser.parse(qry);
         chai_1.assert.isArray(parsed.filter['$or']);
         chai_1.assert.isOk(parsed.filter['name'] === 'Google');

package/lib/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@geekbears/gb-mongoose-query-parser",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Convert url query string to MongooseJs friendly query object including advanced filtering, sorting, population, deep population, string template, type casting and many more...",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
     "clean": "rimraf lib",
-    "compile": "npm run clean && tsc",
+    "compile": "npm run clean && NODE_OPTIONS='--max-old-space-size=8192' tsc -p tsconfig.json",
     "prepublishOnly": "npm run compile",
     "pretest": "npm run compile",
     "test": "mocha ./lib/**/*.spec.js",
@@ -32,25 +32,24 @@
   "homepage": "https://gitlab.com/geekbears/utilities/backend/gb-mongoose-query-parser#readme",
   "devDependencies": {
     "@testdeck/mocha": "^0.3.3",
-    "@types/chai": "^4.3.4",
-    "@types/lodash": "^4.14.194",
+    "@types/chai": "^4.3.5",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.16.2",
+    "@types/node": "^20.4.7",
+    "@types/qs": "^6.9.7",
     "chai": "^4.3.7",
     "mocha": "^10.2.0",
-    "prettier": "^2.8.8",
-    "rimraf": "^5.0.0",
+    "prettier": "^3.0.1",
+    "rimraf": "^5.0.1",
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",
-    "typescript": "^5.0.4"
+    "typescript": "^5.1.6",
+    "@types/lodash": "^4.14.196"
   },
   "dependencies": {
     "lodash": "^4.17.21",
     "moment": "^2.29.4"
   },
   "peerDependencies": {
-    "@nestjs/common": "^9.0.0",
-    "@nestjs/swagger": "^6.0.0",
     "mongoose": "^7.0.0",
     "qs": "^6.10.1"
   }

package/lib/decorators/api-single-query.decorator.d.ts

@@ -1 +0,0 @@
-export declare const ApiSingleQuery: () => MethodDecorator;

package/lib/decorators/api-single-query.decorator.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiSingleQuery = void 0;
-var common_1 = require("@nestjs/common");
-var swagger_1 = require("@nestjs/swagger");
-var ApiSingleQuery = function () {
-    return (0, common_1.applyDecorators)((0, swagger_1.ApiQuery)({
-        name: 'populate',
-        description: 'A comma-separated list of virtual fields to populate',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'deepPopulate',
-        description: 'A stringified populate JSON object',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'select',
-        description: 'A comma-separated list of fields to select',
-        schema: { type: 'string' },
-        required: false,
-    }));
-};
-exports.ApiSingleQuery = ApiSingleQuery;
-//# sourceMappingURL=api-single-query.decorator.js.map

package/lib/decorators/api-standard-query.decorator.d.ts

@@ -1,6 +0,0 @@
-/**
- * Add geekbears standard query parameters
- * @description Swagger decorator. Adds all standard query parameters
- * @returns A method decorator wrapping calls to `@ApiQuery()` decorator
- */
-export declare const ApiStandardQuery: () => MethodDecorator;

package/lib/decorators/api-standard-query.decorator.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiStandardQuery = void 0;
-var common_1 = require("@nestjs/common");
-var swagger_1 = require("@nestjs/swagger");
-/**
- * Add geekbears standard query parameters
- * @description Swagger decorator. Adds all standard query parameters
- * @returns A method decorator wrapping calls to `@ApiQuery()` decorator
- */
-var ApiStandardQuery = function () {
-    return (0, common_1.applyDecorators)((0, swagger_1.ApiQuery)({
-        name: 'filter',
-        description: 'A stringified filter JSON object',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'populate',
-        description: 'A comma-separated list of virtual fields to populate',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'deepPopulate',
-        description: 'A stringified populate JSON object',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'sort',
-        description: 'The sorting configuration to apply to returned elements',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'limit',
-        description: 'The max amount of records to return',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'select',
-        description: 'A comma-separated list of fields to select',
-        schema: { type: 'string' },
-        required: false,
-    }), (0, swagger_1.ApiQuery)({
-        name: 'skip',
-        description: 'The amount of records to skip before returning',
-        schema: { type: 'string' },
-        required: false,
-    }));
-};
-exports.ApiStandardQuery = ApiStandardQuery;
-//# sourceMappingURL=api-standard-query.decorator.js.map

package/lib/decorators/index.d.ts

@@ -1,2 +0,0 @@
-export * from './api-standard-query.decorator';
-export * from './api-single-query.decorator';

package/lib/decorators/index.js

@@ -1,15 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./api-standard-query.decorator"), exports);
-__exportStar(require("./api-single-query.decorator"), exports);
-//# sourceMappingURL=index.js.map