@recursyve/nestjs-data-filter 11.2.0 → 11.2.1

package/lib/filter/controllers/open-api-dynamic-filter.controller.d.ts

@@ -1,4 +1,8 @@
 import { Type } from "@nestjs/common";
+import { ApiParamOptions } from "@nestjs/swagger/dist/decorators/api-param.decorator";
 import { DynamicFilterController } from "../..";
 import { FilterService } from "../filter.service";
-export declare function OpenApiDynamicFilterController<T extends Type, D>(Base: T): Type<DynamicFilterController<D>> & (abstract new (filterService: FilterService<D>) => DynamicFilterController<D>);
+export type OpenApiDynamicFilterControllerOptions = {
+    param?: ApiParamOptions;
+};
+export declare function OpenApiDynamicFilterController<T extends Type, D>(Base: T, options?: OpenApiDynamicFilterControllerOptions): Type<DynamicFilterController<D>> & (abstract new (filterService: FilterService<D>) => DynamicFilterController<D>);

package/lib/filter/controllers/open-api-dynamic-filter.controller.js

@@ -19,7 +19,7 @@ const __1 = require("../..");
 const filter_query_guard_1 = require("../guards/filter-query.guard");
 const data_file_download_interceptor_1 = require("../interceptors/data-file-download.interceptor");
 const filter_resource_value_model_1 = require("../models/filter-resource-value.model");
-function OpenApiDynamicFilterController(Base) {
+function OpenApiDynamicFilterController(Base, options) {
     const _FilterResultModel = (0, __1.FilterResultModelMixin)(Base);
     class _FilterController extends __1.DynamicFilterController {
         async filter(query, req) {
@@ -69,13 +69,13 @@ function OpenApiDynamicFilterController(Base) {
         (0, common_1.HttpCode)(common_1.HttpStatus.OK),
         (0, common_1.UseInterceptors)(data_file_download_interceptor_1.DataFileDownloadInterceptor),
         (0, swagger_1.ApiOkResponse)({
-            description: 'Returns file data as binary (Buffer) or as text (string) depending on the export type.',
+            description: "Returns file data as binary (Buffer) or as text (string) depending on the export type.",
             content: {
-                'application/octet-stream': {
+                "application/octet-stream": {
                     schema: {
                         oneOf: [
-                            { type: 'string', format: 'binary' },
-                            { type: 'string' }
+                            { type: "string", format: "binary" },
+                            { type: "string" }
                         ]
                     }
                 }
@@ -119,6 +119,9 @@ function OpenApiDynamicFilterController(Base) {
         __metadata("design:paramtypes", [__1.FilterConfigurationSearchModel, Object]),
         __metadata("design:returntype", Promise)
     ], _FilterController.prototype, "searchFilterConfigValues", null);
+    if (options === null || options === void 0 ? void 0 : options.param) {
+        (0, common_1.applyDecorators)((0, swagger_1.ApiParam)(options.param))(_FilterController);
+    }
     // @ts-ignore
     return _FilterController;
 }

package/lib/filter/controllers/open-api-filter.controller.js

@@ -14,10 +14,10 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenApiFilterController = OpenApiFilterController;
 const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
 const __1 = require("../..");
 const filter_query_guard_1 = require("../guards/filter-query.guard");
 const data_file_download_interceptor_1 = require("../interceptors/data-file-download.interceptor");
-const swagger_1 = require("@nestjs/swagger");
 const filter_resource_value_model_1 = require("../models/filter-resource-value.model");
 function OpenApiFilterController(Base) {
     const _FilterResultModel = (0, __1.FilterResultModelMixin)(Base);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@recursyve/nestjs-data-filter",
-    "version": "11.2.0",
+    "version": "11.2.1",
     "description": "NestJs DataFilter library",
     "main": "index.js",
     "scripts": {