@nestjs/swagger - npm Package Compare versions

Comparing version 4.6.1 to 4.7.0

dist/decorators/api-response.decorator.d.ts

@@ -21,2 +21,3 @@ import { Type } from '@nestjs/common';
 export declare const ApiMovedPermanentlyResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
+export declare const ApiFoundResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
 export declare const ApiBadRequestResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
@@ -23,0 +24,0 @@ export declare const ApiUnauthorizedResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;

dist/decorators/api-response.decorator.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiDefaultResponse = exports.ApiUnsupportedMediaTypeResponse = exports.ApiUnprocessableEntityResponse = exports.ApiServiceUnavailableResponse = exports.ApiRequestTimeoutResponse = exports.ApiPayloadTooLargeResponse = exports.ApiPreconditionFailedResponse = exports.ApiNotImplementedResponse = exports.ApiNotAcceptableResponse = exports.ApiMethodNotAllowedResponse = exports.ApiGoneResponse = exports.ApiGatewayTimeoutResponse = exports.ApiForbiddenResponse = exports.ApiConflictResponse = exports.ApiBadGatewayResponse = exports.ApiInternalServerErrorResponse = exports.ApiNotFoundResponse = exports.ApiTooManyRequestsResponse = exports.ApiUnauthorizedResponse = exports.ApiBadRequestResponse = exports.ApiMovedPermanentlyResponse = exports.ApiNoContentResponse = exports.ApiAcceptedResponse = exports.ApiCreatedResponse = exports.ApiOkResponse = exports.ApiResponse = void 0;
+exports.ApiDefaultResponse = exports.ApiUnsupportedMediaTypeResponse = exports.ApiUnprocessableEntityResponse = exports.ApiServiceUnavailableResponse = exports.ApiRequestTimeoutResponse = exports.ApiPayloadTooLargeResponse = exports.ApiPreconditionFailedResponse = exports.ApiNotImplementedResponse = exports.ApiNotAcceptableResponse = exports.ApiMethodNotAllowedResponse = exports.ApiGoneResponse = exports.ApiGatewayTimeoutResponse = exports.ApiForbiddenResponse = exports.ApiConflictResponse = exports.ApiBadGatewayResponse = exports.ApiInternalServerErrorResponse = exports.ApiNotFoundResponse = exports.ApiTooManyRequestsResponse = exports.ApiUnauthorizedResponse = exports.ApiBadRequestResponse = exports.ApiFoundResponse = exports.ApiMovedPermanentlyResponse = exports.ApiNoContentResponse = exports.ApiAcceptedResponse = exports.ApiCreatedResponse = exports.ApiOkResponse = exports.ApiResponse = void 0;
 const http_status_enum_1 = require("@nestjs/common/enums/http-status.enum");
@@ -31,2 +31,3 @@ const lodash_1 = require("lodash");
 exports.ApiMovedPermanentlyResponse = (options = {}) => ApiResponse(Object.assign(Object.assign({}, options), { status: http_status_enum_1.HttpStatus.MOVED_PERMANENTLY }));
+exports.ApiFoundResponse = (options = {}) => ApiResponse(Object.assign(Object.assign({}, options), { status: http_status_enum_1.HttpStatus.FOUND }));
 exports.ApiBadRequestResponse = (options = {}) => ApiResponse(Object.assign(Object.assign({}, options), { status: http_status_enum_1.HttpStatus.BAD_REQUEST }));
@@ -33,0 +34,0 @@ exports.ApiUnauthorizedResponse = (options = {}) => ApiResponse(Object.assign(Object.assign({}, options), { status: http_status_enum_1.HttpStatus.UNAUTHORIZED }));

dist/interfaces/swagger-document-options.interface.d.ts

@@ -6,2 +6,3 @@ export interface SwaggerDocumentOptions {
     deepScanRoutes?: boolean;
+    operationIdFactory?: (controllerKey: string, methodKey: string) => string;
 }

dist/swagger-explorer.d.ts

@@ -12,4 +12,5 @@ import { Controller } from '@nestjs/common/interfaces';
     private readonly schemaRefsStack;
+    private operationIdFactory;
     constructor(schemaObjectFactory: SchemaObjectFactory);
-    exploreController(wrapper: InstanceWrapper<Controller>, modulePath?: string, globalPrefix?: string): DenormalizedDoc[];
+    exploreController(wrapper: InstanceWrapper<Controller>, modulePath?: string, globalPrefix?: string, operationIdFactory?: (controllerKey: string, methodKey: string) => string): DenormalizedDoc[];
     getSchemas(): SchemaObject[];
@@ -16,0 +17,0 @@ private generateDenormalizedDocument;

dist/swagger-explorer.js

@@ -29,4 +29,8 @@ "use strict";
         this.schemaRefsStack = [];
+        this.operationIdFactory = (controllerKey, methodKey) => controllerKey ? `${controllerKey}_${methodKey}` : methodKey;
     }
-    exploreController(wrapper, modulePath, globalPrefix) {
+    exploreController(wrapper, modulePath, globalPrefix, operationIdFactory) {
+        if (operationIdFactory) {
+            this.operationIdFactory = operationIdFactory;
+        }
         const { instance, metatype } = wrapper;
@@ -115,6 +119,4 @@ const prototype = Object.getPrototypeOf(instance);
     getOperationId(instance, method) {
-        if (instance.constructor) {
-            return `${instance.constructor.name}_${method.name}`;
-        }
-        return method.name;
+        var _a;
+        return this.operationIdFactory(((_a = instance.constructor) === null || _a === void 0 ? void 0 : _a.name) || '', method.name);
     }
@@ -121,0 +123,0 @@ reflectControllerPath(metatype) {

dist/swagger-scanner.d.ts

@@ -11,3 +11,3 @@ import { INestApplication } from '@nestjs/common';
     scanApplication(app: INestApplication, options: SwaggerDocumentOptions): Omit<OpenAPIObject, 'openapi' | 'info'>;
-    scanModuleRoutes(routes: Map<string, InstanceWrapper>, modulePath?: string, globalPrefix?: string): Array<Omit<OpenAPIObject, 'openapi' | 'info'> & Record<'root', any>>;
+    scanModuleRoutes(routes: Map<string, InstanceWrapper>, modulePath?: string, globalPrefix?: string, operationIdFactory?: (controllerKey: string, methodKey: string) => string): Array<Omit<OpenAPIObject, 'openapi' | 'info'> & Record<'root', any>>;
     getModules(modulesContainer: Map<string, Module>, include: Function[]): Module[];
@@ -14,0 +14,0 @@ addExtraModels(schemas: SchemaObject[], extraModels: Function[]): void;

dist/swagger-scanner.js

@@ -19,3 +19,3 @@ "use strict";
     scanApplication(app, options) {
-        const { deepScanRoutes, include: includedModules = [], extraModels = [], ignoreGlobalPrefix = false } = options;
+        const { deepScanRoutes, include: includedModules = [], extraModels = [], ignoreGlobalPrefix = false, operationIdFactory } = options;
         const container = app.container;
@@ -40,3 +40,3 @@ const modules = this.getModules(container.getModules(), includedModules);
                 : undefined;
-            return this.scanModuleRoutes(allRoutes, path, globalPrefix);
+            return this.scanModuleRoutes(allRoutes, path, globalPrefix, operationIdFactory);
         });
@@ -49,4 +49,4 @@ const schemas = this.explorer.getSchemas();
     }
-    scanModuleRoutes(routes, modulePath, globalPrefix) {
-        const denormalizedArray = [...routes.values()].map((ctrl) => this.explorer.exploreController(ctrl, modulePath, globalPrefix));
+    scanModuleRoutes(routes, modulePath, globalPrefix, operationIdFactory) {
+        const denormalizedArray = [...routes.values()].map((ctrl) => this.explorer.exploreController(ctrl, modulePath, globalPrefix, operationIdFactory));
         return lodash_1.flatten(denormalizedArray);
@@ -53,0 +53,0 @@ }

dist/type-helpers/intersection-type.helper.js

@@ -14,2 +14,6 @@ "use strict";
     class IntersectionTypeClass {
+        constructor() {
+            mapped_types_1.inheritPropertyInitializers(this, classARef);
+            mapped_types_1.inheritPropertyInitializers(this, classBRef);
+        }
     }
@@ -16,0 +20,0 @@ mapped_types_1.inheritValidationMetadata(classARef, IntersectionTypeClass);

package.json

 {
   "name": "@nestjs/swagger",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "description": "Nest - modern, fast, powerful node.js web framework (@swagger)",
@@ -23,3 +23,3 @@ "author": "Kamil Mysliwiec",
   "dependencies": {
-    "@nestjs/mapped-types": "0.1.0",
+    "@nestjs/mapped-types": "0.1.1",
     "lodash": "4.17.20",
@@ -31,27 +31,27 @@ "path-to-regexp": "3.2.0"
     "@commitlint/config-angular": "11.0.0",
-    "@nestjs/common": "7.4.4",
-    "@nestjs/core": "7.4.4",
-    "@nestjs/platform-express": "7.4.4",
-    "@nestjs/platform-fastify": "7.4.4",
-    "@types/jest": "26.0.14",
-    "@types/lodash": "4.14.161",
+    "@nestjs/common": "7.5.1",
+    "@nestjs/core": "7.5.1",
+    "@nestjs/platform-express": "7.5.1",
+    "@nestjs/platform-fastify": "7.5.1",
+    "@types/jest": "26.0.15",
+    "@types/lodash": "4.14.165",
     "@types/node": "11.15.0",
-    "@typescript-eslint/eslint-plugin": "4.1.1",
-    "@typescript-eslint/parser": "4.1.1",
+    "@typescript-eslint/eslint-plugin": "4.6.1",
+    "@typescript-eslint/parser": "4.6.1",
     "class-transformer": "0.3.1",
     "class-validator": "0.12.2",
-    "eslint": "7.9.0",
-    "eslint-config-prettier": "6.11.0",
-    "eslint-plugin-import": "2.22.0",
+    "eslint": "7.12.1",
+    "eslint-config-prettier": "6.15.0",
+    "eslint-plugin-import": "2.22.1",
     "express": "4.17.1",
-    "fastify-swagger": "3.3.0",
+    "fastify-swagger": "3.5.0",
     "husky": "4.3.0",
-    "jest": "26.4.2",
-    "lint-staged": "10.4.0",
+    "jest": "26.6.3",
+    "lint-staged": "10.5.1",
     "prettier": "2.1.2",
     "reflect-metadata": "0.1.13",
-    "release-it": "14.0.3",
+    "release-it": "14.2.1",
     "swagger-parser": "10.0.2",
     "swagger-ui-express": "4.1.4",
-    "ts-jest": "26.4.0",
+    "ts-jest": "26.4.3",
     "typescript": "3.9.7"
@@ -58,0 +58,0 @@ },

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

209569

increased by0.51%

Lines of code

4275

increased by0.23%

Dependency changes

• + Added@nestjs/mapped-types@0.1.1(transitive)

• - Removed@nestjs/mapped-types@0.1.0(transitive)

• Updated@nestjs/mapped-types@0.1.1