@tacxou/nestjs_module_restools 0.0.11

package/request-context/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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("./request-context.middleware"), exports);
+__exportStar(require("./request-context.storage"), exports);
+__exportStar(require("./request-context.module"), exports);
+//# sourceMappingURL=index.js.map

package/request-context/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/request-context/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+DAA4C;AAC5C,4DAAyC;AACzC,2DAAwC"}

package/request-context/request-context.middleware.d.ts

@@ -0,0 +1,4 @@
+import { NestMiddleware } from '@nestjs/common';
+export declare class RequestContextMiddleware<Request = any, Response = any> implements NestMiddleware<Request, Response> {
+    use(req: Request, res: Response, next: () => void): void;
+}

package/request-context/request-context.middleware.js

@@ -0,0 +1,21 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContextMiddleware = void 0;
+const common_1 = require("@nestjs/common");
+const request_context_storage_1 = require("./request-context.storage");
+let RequestContextMiddleware = class RequestContextMiddleware {
+    use(req, res, next) {
+        request_context_storage_1.RequestContextStorage.storage.run(new request_context_storage_1.RequestContextStorage(req, res), next);
+    }
+};
+exports.RequestContextMiddleware = RequestContextMiddleware;
+exports.RequestContextMiddleware = RequestContextMiddleware = __decorate([
+    (0, common_1.Injectable)()
+], RequestContextMiddleware);
+//# sourceMappingURL=request-context.middleware.js.map

package/request-context/request-context.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.middleware.js","sourceRoot":"","sources":["../../src/request-context/request-context.middleware.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA2D;AAC3D,uEAAiE;AAG1D,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IAC5B,GAAG,CAAC,GAAY,EAAE,GAAa,EAAE,IAAgB;QACtD,+CAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,+CAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;IAC9E,CAAC;CACF,CAAA;AAJY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;GACA,wBAAwB,CAIpC"}

package/request-context/request-context.module.d.ts

@@ -0,0 +1,4 @@
+import { MiddlewareConsumer, NestModule } from '@nestjs/common';
+export declare class RequestContextModule implements NestModule {
+    configure(consumer: MiddlewareConsumer): any;
+}

package/request-context/request-context.module.js

@@ -0,0 +1,24 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContextModule = void 0;
+const common_1 = require("@nestjs/common");
+const request_context_middleware_1 = require("./request-context.middleware");
+let RequestContextModule = class RequestContextModule {
+    configure(consumer) {
+        consumer.apply(request_context_middleware_1.RequestContextMiddleware).forRoutes('*');
+    }
+};
+exports.RequestContextModule = RequestContextModule;
+exports.RequestContextModule = RequestContextModule = __decorate([
+    (0, common_1.Module)({
+        providers: [request_context_middleware_1.RequestContextMiddleware],
+        exports: [request_context_middleware_1.RequestContextMiddleware],
+    })
+], RequestContextModule);
+//# sourceMappingURL=request-context.module.js.map

package/request-context/request-context.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.module.js","sourceRoot":"","sources":["../../src/request-context/request-context.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAuE;AACvE,6EAAuE;AAMhE,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,SAAS,CAAC,QAA4B;QACpC,QAAQ,CAAC,KAAK,CAAC,qDAAwB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACzD,CAAC;CACF,CAAA;AAJY,oDAAoB;+BAApB,oBAAoB;IAJhC,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,qDAAwB,CAAC;QACrC,OAAO,EAAE,CAAC,qDAAwB,CAAC;KACpC,CAAC;GACW,oBAAoB,CAIhC"}

package/request-context/request-context.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/request-context/request-context.spec.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const testing_1 = require("@nestjs/testing");
+const supertest_1 = __importDefault(require("supertest"));
+const test_module_1 = require("./_test/test.module");
+describe('request-context', () => {
+    let app;
+    beforeEach(async () => {
+        app = (await testing_1.Test.createTestingModule({
+            imports: [test_module_1.TestModule],
+        }).compile()).createNestApplication();
+        await app.init();
+    });
+    it('should work', () => {
+        expect(true).toBe(true);
+    });
+    it('test with multiples requests same as different requestId count', async () => {
+        await (0, supertest_1.default)(app.getHttpServer()).get('/').expect(200, {
+            initializationCount: 2,
+            requestId: 0,
+        });
+        await (0, supertest_1.default)(app.getHttpServer()).get('/').expect(200, {
+            initializationCount: 2,
+            requestId: 1,
+        });
+        await (0, supertest_1.default)(app.getHttpServer()).get('/').expect(200, {
+            initializationCount: 2,
+            requestId: 2,
+        });
+    });
+});
+//# sourceMappingURL=request-context.spec.js.map

package/request-context/request-context.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.spec.js","sourceRoot":"","sources":["../../src/request-context/request-context.spec.ts"],"names":[],"mappings":";;;;;AAAA,6CAAsC;AACtC,0DAA+B;AAE/B,qDAAgD;AAchD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAI,GAAqB,CAAA;IAEzB,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,GAAG,GAAG,CACJ,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC7B,OAAO,EAAE,CAAC,wBAAU,CAAC;SACtB,CAAC,CAAC,OAAO,EAAE,CACb,CAAC,qBAAqB,EAAE,CAAA;QACzB,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;IAClB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;QACrB,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,IAAA,mBAAO,EAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;YACtD,mBAAmB,EAAE,CAAC;YACtB,SAAS,EAAE,CAAC;SACb,CAAC,CAAA;QACF,MAAM,IAAA,mBAAO,EAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;YACtD,mBAAmB,EAAE,CAAC;YACtB,SAAS,EAAE,CAAC;SACb,CAAC,CAAA;QACF,MAAM,IAAA,mBAAO,EAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE;YACtD,mBAAmB,EAAE,CAAC;YACtB,SAAS,EAAE,CAAC;SACb,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/request-context/request-context.storage.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import { AsyncLocalStorage } from 'node:async_hooks';
+export declare class RequestContextStorage<TReq = any, TRes = any> {
+    readonly req: TReq;
+    readonly res: TRes;
+    static storage: AsyncLocalStorage<RequestContextStorage<any, any>>;
+    constructor(req: TReq, res: TRes);
+    static get currentContext(): RequestContextStorage;
+}

package/request-context/request-context.storage.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContextStorage = void 0;
+const node_async_hooks_1 = require("node:async_hooks");
+class RequestContextStorage {
+    constructor(req, res) {
+        this.req = req;
+        this.res = res;
+    }
+    static get currentContext() {
+        return this.storage.getStore();
+    }
+}
+exports.RequestContextStorage = RequestContextStorage;
+RequestContextStorage.storage = new node_async_hooks_1.AsyncLocalStorage();
+//# sourceMappingURL=request-context.storage.js.map

package/request-context/request-context.storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.storage.js","sourceRoot":"","sources":["../../src/request-context/request-context.storage.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AAEpD,MAAa,qBAAqB;IAGhC,YAAmC,GAAS,EAAkB,GAAS;QAApC,QAAG,GAAH,GAAG,CAAM;QAAkB,QAAG,GAAH,GAAG,CAAM;IAAI,CAAC;IAErE,MAAM,KAAK,cAAc;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IAChC,CAAC;;AAPH,sDAQC;AAPe,6BAAO,GAAG,IAAI,oCAAiB,EAAyB,CAAA"}

package/search-filter-schema/index.d.ts

@@ -0,0 +1,2 @@
+export * from './search-filter-options.decorator';
+export * from './search-filter-schema.decorator';

package/search-filter-schema/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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("./search-filter-options.decorator"), exports);
+__exportStar(require("./search-filter-schema.decorator"), exports);
+//# sourceMappingURL=index.js.map

package/search-filter-schema/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/search-filter-schema/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oEAAiD;AACjD,mEAAgD"}

package/search-filter-schema/search-filter-options.decorator.d.ts

@@ -0,0 +1,34 @@
+import { ParsedQs } from 'qs';
+export declare const DEFAULT_SEARCH_OPTIONS: {
+    loggerType: string;
+    defaultLimit: number;
+    limitKey: string;
+    skipKey: string;
+    pageKey: string;
+    sortKey: string;
+    allowUnlimited: boolean;
+};
+export interface FilterSearchOptions {
+    loggerType?: string;
+    defaultLimit?: number;
+    limitKey?: string;
+    skipKey?: string;
+    pageKey?: string;
+    sortKey?: string;
+    allowUnlimited?: boolean;
+}
+export interface SortOptions {
+    [key: string]: 'asc' | 'desc' | 1 | -1;
+}
+export declare const DEFAULT_FILTER_OPTIONS: {
+    limit: number;
+    skip: number;
+    sort: {};
+};
+export interface FilterOptions {
+    limit: number;
+    skip: number;
+    sort: SortOptions;
+}
+export declare const SearchFilterOptions: (...dataOrPipes: (import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>> | FilterSearchOptions)[]) => ParameterDecorator;
+export declare function filterOptions(queries: string | string[] | ParsedQs | ParsedQs[], options?: FilterSearchOptions): FilterOptions;

package/search-filter-schema/search-filter-options.decorator.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterOptions = exports.SearchFilterOptions = exports.DEFAULT_FILTER_OPTIONS = exports.DEFAULT_SEARCH_OPTIONS = void 0;
+const common_1 = require("@nestjs/common");
+exports.DEFAULT_SEARCH_OPTIONS = {
+    loggerType: 'FilterOptionsControl',
+    defaultLimit: 10,
+    limitKey: 'limit',
+    skipKey: 'skip',
+    pageKey: 'page',
+    sortKey: 'sort',
+    allowUnlimited: false,
+};
+exports.DEFAULT_FILTER_OPTIONS = {
+    limit: exports.DEFAULT_SEARCH_OPTIONS.defaultLimit,
+    skip: 0,
+    sort: {},
+};
+exports.SearchFilterOptions = (0, common_1.createParamDecorator)((options, ctx) => {
+    options = Object.assign(Object.assign({}, exports.DEFAULT_SEARCH_OPTIONS), options);
+    const req = ctx.switchToHttp().getRequest();
+    try {
+        return filterOptions(req.query, options);
+    }
+    catch (error) {
+        throw new common_1.BadRequestException(error.message);
+    }
+});
+function filterOptions(queries, options) {
+    options = Object.assign(Object.assign({}, exports.DEFAULT_SEARCH_OPTIONS), options);
+    let limit = parseInt(`${queries[options.limitKey]}`) || options.defaultLimit;
+    if (limit === -1 && options.allowUnlimited)
+        limit = undefined;
+    let skip = parseInt(`${queries[options.skipKey]}`) || 0;
+    if (queries[options.pageKey]) {
+        if (skip > 0)
+            common_1.Logger.debug(`Both ${options.skipKey} and ${options.pageKey} are set. ${options.skipKey} will be ignored`, options.loggerType);
+        skip = (parseInt(`${queries[options.pageKey]}`) - 1) * limit;
+    }
+    const sort = {};
+    for (const key in queries[options.sortKey]) {
+        switch (`${queries[options.sortKey][key]}`.toLowerCase()) {
+            case '1':
+            case 'asc':
+                sort[key] = 1;
+                break;
+            case '-1':
+            case 'desc':
+                sort[key] = -1;
+                break;
+        }
+    }
+    return {
+        limit,
+        skip,
+        sort,
+    };
+}
+exports.filterOptions = filterOptions;
+//# sourceMappingURL=search-filter-options.decorator.js.map

package/search-filter-schema/search-filter-options.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-filter-options.decorator.js","sourceRoot":"","sources":["../../src/search-filter-schema/search-filter-options.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAoG;AAIvF,QAAA,sBAAsB,GAAG;IACpC,UAAU,EAAE,sBAAsB;IAClC,YAAY,EAAE,EAAE;IAChB,QAAQ,EAAE,OAAO;IACjB,OAAO,EAAE,MAAM;IACf,OAAO,EAAE,MAAM;IACf,OAAO,EAAE,MAAM;IACf,cAAc,EAAE,KAAK;CACtB,CAAA;AAgBY,QAAA,sBAAsB,GAAG;IACpC,KAAK,EAAE,8BAAsB,CAAC,YAAY;IAC1C,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,EAAE;CACT,CAAA;AASY,QAAA,mBAAmB,GAAG,IAAA,6BAAoB,EAAC,CAAC,OAA4B,EAAE,GAAqB,EAAiB,EAAE;IAC7H,OAAO,mCAAQ,8BAAsB,GAAK,OAAO,CAAE,CAAA;IACnD,MAAM,GAAG,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAW,CAAA;IAEpD,IAAI,CAAC;QACH,OAAO,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,4BAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAC9C,CAAC;AACH,CAAC,CAAC,CAAA;AAEF,SAAgB,aAAa,CAC3B,OAAkD,EAClD,OAA6B;IAE7B,OAAO,mCAAQ,8BAAsB,GAAK,OAAO,CAAE,CAAA;IACnD,IAAI,KAAK,GAAG,QAAQ,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,YAAY,CAAA;IAC5E,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,OAAO,CAAC,cAAc;QAAE,KAAK,GAAG,SAAS,CAAA;IAC7D,IAAI,IAAI,GAAG,QAAQ,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;IAEvD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,IAAI,IAAI,GAAG,CAAC;YAAE,eAAM,CAAC,KAAK,CAAC,QAAQ,OAAO,CAAC,OAAO,QAAQ,OAAO,CAAC,OAAO,aAAa,OAAO,CAAC,OAAO,kBAAkB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;QAC5I,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAA;IAC9D,CAAC;IAED,MAAM,IAAI,GAAG,EAAE,CAAA;IACf,KAAK,MAAM,GAAG,IAA2B,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAClE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;YACzD,KAAK,GAAG,CAAC;YACT,KAAK,KAAK;gBACR,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBACb,MAAK;YAEP,KAAK,IAAI,CAAC;YACV,KAAK,MAAM;gBACT,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;gBACd,MAAK;QACT,CAAC;IACH,CAAC;IAED,OAAO;QACL,KAAK;QACL,IAAI;QACJ,IAAI;KACL,CAAA;AACH,CAAC;AAlCD,sCAkCC"}

package/search-filter-schema/search-filter-options.decorator.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/search-filter-schema/search-filter-options.decorator.spec.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const search_filter_options_decorator_1 = require("./search-filter-options.decorator");
+describe('search-filter-options', () => {
+    it('should work', () => {
+        expect(true).toBe(true);
+    });
+    it('sort with desc string', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            sort: { 'metadata.lastUpdatedAt': 'desc' },
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { sort: { 'metadata.lastUpdatedAt': -1 } }));
+    });
+    it('sort with desc number', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            sort: { 'metadata.lastUpdatedAt': '-1' },
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { sort: { 'metadata.lastUpdatedAt': -1 } }));
+    });
+    it('sort with asc string', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            sort: { 'metadata.lastUpdatedAt': 'asc' },
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { sort: { 'metadata.lastUpdatedAt': 1 } }));
+    });
+    it('sort with asc number', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            sort: { 'metadata.lastUpdatedAt': '1' },
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { sort: { 'metadata.lastUpdatedAt': 1 } }));
+    });
+    it('limit 69', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            limit: '69',
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { limit: 69 }));
+    });
+    it('skip 71', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            skip: '71',
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { skip: 71 }));
+    });
+    it('skip with other key', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            jump: '71',
+        }, { skipKey: 'jump' })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { skip: 71 }));
+    });
+    it('limit with other key', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            quota: '71',
+        }, { limitKey: 'quota' })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { limit: 71 }));
+    });
+    it('use pagination number', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            page: '42',
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { skip: search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS.limit * 41 }));
+    });
+    it('use pagination number with other key', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            increment: '11',
+        }, { pageKey: 'increment' })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { skip: search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS.limit * 10 }));
+    });
+    it('use pagination number and conflict with skip', () => {
+        expect((0, search_filter_options_decorator_1.filterOptions)({
+            page: '5',
+            skip: '50',
+        })).toStrictEqual(Object.assign(Object.assign({}, search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS), { skip: search_filter_options_decorator_1.DEFAULT_FILTER_OPTIONS.limit * 4 }));
+    });
+});
+//# sourceMappingURL=search-filter-options.decorator.spec.js.map

package/search-filter-schema/search-filter-options.decorator.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-filter-options.decorator.spec.js","sourceRoot":"","sources":["../../src/search-filter-schema/search-filter-options.decorator.spec.ts"],"names":[],"mappings":";;AAAA,uFAAyF;AAEzF,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;QACrB,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,EAAE,wBAAwB,EAAE,MAAM,EAAE;SAC3C,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,EAAE,wBAAwB,EAAE,CAAC,CAAC,EAAE,IACtC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE;SACzC,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,EAAE,wBAAwB,EAAE,CAAC,CAAC,EAAE,IACtC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,EAAE,wBAAwB,EAAE,KAAK,EAAE;SAC1C,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,EAAE,wBAAwB,EAAE,CAAC,EAAE,IACrC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,EAAE,wBAAwB,EAAE,GAAG,EAAE;SACxC,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,EAAE,wBAAwB,EAAE,CAAC,EAAE,IACrC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;QAClB,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,KAAK,EAAE,IAAI;SACZ,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,KAAK,EAAE,EAAE,IACT,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;QACjB,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,IAAI;SACX,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,EAAE,IACR,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,IAAI;SACX,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CACxB,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,EAAE,IACR,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,KAAK,EAAE,IAAI;SACZ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAC1B,CAAC,aAAa,iCACV,wDAAsB,KACzB,KAAK,EAAE,EAAE,IACT,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,IAAI;SACX,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,wDAAsB,CAAC,KAAK,GAAG,EAAE,IACvC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,SAAS,EAAE,IAAI;SAChB,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAC7B,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,wDAAsB,CAAC,KAAK,GAAG,EAAE,IACvC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CACJ,IAAA,+CAAa,EAAC;YACZ,IAAI,EAAE,GAAG;YACT,IAAI,EAAE,IAAI;SACX,CAAC,CACH,CAAC,aAAa,iCACV,wDAAsB,KACzB,IAAI,EAAE,wDAAsB,CAAC,KAAK,GAAG,CAAC,IACtC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/search-filter-schema/search-filter-schema.decorator.d.ts

@@ -0,0 +1,32 @@
+import { ParsedQs } from 'qs';
+export declare const FILTER_SYMBOL_EQUAL = ":";
+export declare const FILTER_SYMBOL_GREATER = ">";
+export declare const FILTER_SYMBOL_LESS = "<";
+export declare const FILTER_SYMBOL_NOT_EQUAL = "!";
+export declare const FILTER_SYMBOL_IN = "@";
+export declare const FILTER_SYMBOL_REGEX = "^";
+export declare const FILTER_SYMBOL_BOOLEAN = "?";
+export declare const FILTER_SYMBOL_NUMBER = "#";
+export declare const DEFAULT_ALLOWED_FILTERS: string[];
+export declare const DEFAULT_SCHEMA_OPTIONS: {
+    loggerType: string;
+    unsafe: boolean;
+    queryKey: string;
+    strict: boolean;
+    convertNull: boolean;
+    convertObjectId: boolean;
+};
+export interface FilterSchemaOptions {
+    loggerType?: string;
+    dayjsLocale?: string;
+    unsafe?: boolean;
+    queryKey?: string;
+    strict?: boolean;
+    convertNull?: boolean;
+    convertObjectId?: boolean;
+}
+export interface FilterSchema {
+    [key: string | number]: FilterSchema;
+}
+export declare const SearchFilterSchema: (...dataOrPipes: (import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>> | FilterSchemaOptions)[]) => ParameterDecorator;
+export declare function filterSchema(filters: string | string[] | ParsedQs | ParsedQs[], options?: FilterSchemaOptions): FilterSchema;

package/search-filter-schema/search-filter-schema.decorator.js

@@ -0,0 +1,238 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterSchema = exports.SearchFilterSchema = exports.DEFAULT_SCHEMA_OPTIONS = exports.DEFAULT_ALLOWED_FILTERS = exports.FILTER_SYMBOL_NUMBER = exports.FILTER_SYMBOL_BOOLEAN = exports.FILTER_SYMBOL_REGEX = exports.FILTER_SYMBOL_IN = exports.FILTER_SYMBOL_NOT_EQUAL = exports.FILTER_SYMBOL_LESS = exports.FILTER_SYMBOL_GREATER = exports.FILTER_SYMBOL_EQUAL = void 0;
+const common_1 = require("@nestjs/common");
+const dayjs_1 = __importDefault(require("dayjs"));
+const deepmerge_1 = __importDefault(require("deepmerge"));
+const is_plain_object_1 = require("is-plain-object");
+let ObjectId;
+(async () => {
+    try {
+        const mongooseModule = await Promise.resolve().then(() => __importStar(require('mongoose')));
+        ObjectId = mongooseModule.Types.ObjectId;
+    }
+    catch (error) {
+        common_1.Logger.debug(`Mongoose module not found`, exports.SearchFilterSchema.name);
+    }
+})();
+exports.FILTER_SYMBOL_EQUAL = ':';
+exports.FILTER_SYMBOL_GREATER = '>';
+exports.FILTER_SYMBOL_LESS = '<';
+exports.FILTER_SYMBOL_NOT_EQUAL = '!';
+exports.FILTER_SYMBOL_IN = '@';
+exports.FILTER_SYMBOL_REGEX = '^';
+exports.FILTER_SYMBOL_BOOLEAN = '?';
+exports.FILTER_SYMBOL_NUMBER = '#';
+exports.DEFAULT_ALLOWED_FILTERS = [
+    exports.FILTER_SYMBOL_EQUAL,
+    exports.FILTER_SYMBOL_BOOLEAN,
+    exports.FILTER_SYMBOL_NUMBER,
+    exports.FILTER_SYMBOL_NOT_EQUAL,
+    exports.FILTER_SYMBOL_GREATER,
+    exports.FILTER_SYMBOL_LESS,
+    exports.FILTER_SYMBOL_REGEX,
+    exports.FILTER_SYMBOL_IN,
+];
+exports.DEFAULT_SCHEMA_OPTIONS = {
+    loggerType: 'FilterSchemaControl',
+    unsafe: false,
+    queryKey: 'filters',
+    strict: true,
+    convertNull: true,
+    convertObjectId: true,
+};
+exports.SearchFilterSchema = (0, common_1.createParamDecorator)((options, ctx) => {
+    options = Object.assign(Object.assign({}, exports.DEFAULT_SCHEMA_OPTIONS), options);
+    const req = ctx.switchToHttp().getRequest();
+    try {
+        return filterSchema(req.query[options.queryKey], options);
+    }
+    catch (error) {
+        throw new common_1.BadRequestException(error.message);
+    }
+});
+function filterSchema(filters, options) {
+    options = Object.assign(Object.assign({}, exports.DEFAULT_SCHEMA_OPTIONS), options);
+    let conditions = {};
+    if (typeof filters === 'object') {
+        for (const key of Object.keys(filters)) {
+            const data = filters[key];
+            conditions = (0, deepmerge_1.default)(conditions, internalFilterbyType(key, data, exports.DEFAULT_ALLOWED_FILTERS, options), {
+                isMergeableObject: is_plain_object_1.isPlainObject,
+            });
+        }
+    }
+    return conditions;
+}
+exports.filterSchema = filterSchema;
+function internalFilterbyType(key, data, allowed, options) {
+    const parsed = {};
+    const keyCheck = key.replace(new RegExp(`[${allowed.join('')}]`, 'g'), '');
+    if (keyCheck.length === 0 || (!allowed.includes(key[0]) && !/[a-zA-Z0-9-_]/.test(key[0])))
+        return {};
+    switch (key[0]) {
+        case exports.FILTER_SYMBOL_BOOLEAN: {
+            parsed[key.slice(1)] = /true|on|yes|1/i.test(data);
+            break;
+        }
+        case exports.FILTER_SYMBOL_NUMBER: {
+            const valueHashtag = Number(data);
+            if (isNaN(valueHashtag)) {
+                if (options.strict)
+                    throw new Error(`Invalid filter key ${keyCheck} with number: ${data}`);
+                common_1.Logger.verbose(`Invalid filter key ${keyCheck} with number: ${data}`, options.loggerType);
+                break;
+            }
+            parsed[key.slice(1)] = valueHashtag;
+            break;
+        }
+        case exports.FILTER_SYMBOL_NOT_EQUAL: {
+            const valueExclamation = internalFilterbyType(key.slice(1), data, [
+                exports.FILTER_SYMBOL_NUMBER,
+                exports.FILTER_SYMBOL_IN,
+                exports.FILTER_SYMBOL_EQUAL,
+            ], options);
+            if (Object.keys(valueExclamation).length === 0)
+                break;
+            const typeExclamation = Object.keys(valueExclamation[keyCheck] || {})[0];
+            if (typeExclamation === '$in') {
+                parsed[keyCheck] = { $nin: valueExclamation[keyCheck]['$in'] };
+                break;
+            }
+            parsed[keyCheck] = { $ne: valueExclamation[keyCheck] };
+            break;
+        }
+        case exports.FILTER_SYMBOL_LESS:
+        case exports.FILTER_SYMBOL_GREATER: {
+            let upperLowerType = key[0] === exports.FILTER_SYMBOL_GREATER ? '$gt' : '$lt';
+            if (key[1] === '|')
+                upperLowerType = `${upperLowerType}e`;
+            const upperLowerKey = key.slice(upperLowerType.length - 2);
+            const valueGreater = internalFiltersByTypeUpperLower(upperLowerType, upperLowerKey, data, options);
+            if (Object.keys(valueGreater).length === 0)
+                break;
+            const subKeyGreater = Object.keys(valueGreater)[0];
+            parsed[subKeyGreater] = valueGreater[subKeyGreater];
+            break;
+        }
+        case exports.FILTER_SYMBOL_REGEX: {
+            const re = data.trim().split('/');
+            if (re[0] !== '' || re.length < 3) {
+                if (options.strict)
+                    throw new Error(`Invalid filter key ${keyCheck} with regex: ${data}`);
+                common_1.Logger.verbose(`Invalid filter key ${keyCheck} with regex: ${data}`, options.loggerType);
+                break;
+            }
+            re.shift();
+            const $options = re.pop();
+            parsed[key.slice(1)] = { $regex: re.join('') };
+            if ($options)
+                parsed[key.slice(1)]['$options'] = $options;
+            break;
+        }
+        case exports.FILTER_SYMBOL_IN: {
+            let subKeyAt;
+            const $in = [];
+            if (!Array.isArray(data)) {
+                if (options.strict)
+                    throw new Error(`Invalid filter key ${keyCheck} with bad array: ${data}`);
+                common_1.Logger.verbose(`Invalid filter key ${keyCheck} with bad array: ${data}`, options.loggerType);
+                break;
+            }
+            for (const d of data) {
+                const valueAt = internalFilterbyType(key.slice(1), d, [exports.FILTER_SYMBOL_NUMBER], options);
+                if (Object.keys(valueAt).length === 0)
+                    break;
+                subKeyAt = Object.keys(valueAt)[0];
+                $in.push(valueAt[subKeyAt]);
+            }
+            if (!subKeyAt) {
+                if (options.strict)
+                    throw new Error(`Invalid filter key ${keyCheck} with array: ${JSON.stringify(data)}`);
+                common_1.Logger.verbose(`Invalid filter key ${keyCheck} with array: ${JSON.stringify(data)}`, options.loggerType);
+                break;
+            }
+            parsed[subKeyAt] = { $in };
+            break;
+        }
+        case exports.FILTER_SYMBOL_EQUAL: {
+            if (Array.isArray(data)) {
+                if (options.strict)
+                    throw new Error(`Invalid filter key ${keyCheck} with strict array: ${JSON.stringify(data)}`);
+                common_1.Logger.verbose(`Invalid filter key ${keyCheck} with strict string: ${JSON.stringify(data)}`, options.loggerType);
+                break;
+            }
+            if (options.convertObjectId && ObjectId.isValid(data)) {
+                parsed[key.slice(1)] = new ObjectId(data);
+                break;
+            }
+            if (options.convertNull && data === 'null') {
+                parsed[key.slice(1)] = null;
+                break;
+            }
+            parsed[key.slice(1)] = `${data}`;
+            break;
+        }
+        default: {
+            if (!options.unsafe && Array.isArray(data)) {
+                if (options.strict)
+                    throw new Error(`Invalid filter key ${keyCheck} with unsafe: ${JSON.stringify(data)}`);
+                common_1.Logger.verbose(`Invalid filter key ${keyCheck} with unsafe: ${JSON.stringify(data)}`, options.loggerType);
+                break;
+            }
+            parsed[key] = data;
+            break;
+        }
+    }
+    return parsed;
+}
+function internalFiltersByTypeUpperLower(type, key, data, options) {
+    const parsed = {};
+    if (key[0] !== exports.FILTER_SYMBOL_NUMBER) {
+        const dayjsDate = (0, dayjs_1.default)(data, options.dayjsLocale);
+        if (!dayjsDate.isValid() || dayjsDate.toDate().toString() === 'Invalid Date') {
+            if (options.strict)
+                throw new Error(`Invalid filter key ${key} with date: ${data}`);
+            common_1.Logger.verbose(`Invalid filter key ${key} with date: ${data}`, options.loggerType);
+            return {};
+        }
+        parsed[key] = {};
+        parsed[key][type] = dayjsDate.toDate();
+        return parsed;
+    }
+    const value = internalFilterbyType(key, data, [exports.FILTER_SYMBOL_NUMBER], options);
+    if (Object.keys(value).length === 0)
+        return {};
+    const subKey = Object.keys(value)[0];
+    parsed[subKey] = {};
+    parsed[subKey][type] = {};
+    parsed[subKey][type] = value[subKey];
+    return parsed;
+}
+//# sourceMappingURL=search-filter-schema.decorator.js.map