@team-supercharge/oasg 14.1.0-feature-python-fastapi-e25c0a08.0 → 15.0.0-feature-nestjs-auth-guard-d8ac30be.0

package/README.md

@@ -821,6 +821,11 @@ describe('Auth', function () {
 | packageName | Name of the generated NPM package | Y | - |
 | repository | URL of the NPM package registry | Y | - |
 
+##### Authentication
+The package generates an AuthGuard and applies to endpoints, where a security scheme is defined.
+// TODO - rest of the description and how to use it
+
+
 **Known limitations:**
 - array of enums in query/header/path/form parameters are not validated (stay as string)
 - no multidimensional array validation in DTOs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "14.1.0-feature-python-fastapi-e25c0a08.0",
+  "version": "15.0.0-feature-nestjs-auth-guard-d8ac30be.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/nestjs/generator-config.json

@@ -15,6 +15,9 @@
     "pipes.ts": {
       "templateType": "SupportingFiles"
     },
+    "auth.guard.ts": {
+      "templateType": "SupportingFiles"
+    },
     "exceptions.ts": {
       "templateType": "SupportingFiles"
     },

package/targets/nestjs/templates/api.service.mustache

@@ -5,11 +5,12 @@
 import { Get, Post, Put, Delete, Patch, Options, Head } from '@nestjs/common';
 import { Query, Param, Headers, Body } from '@nestjs/common';
 import { HttpCode, Request } from '@nestjs/common';
-import { UseInterceptors, UploadedFile, StreamableFile } from '@nestjs/common';
+import { UseInterceptors, UseGuards, UploadedFile, StreamableFile } from '@nestjs/common';
 import { FileInterceptor } from '@nestjs/platform-express';
 
 import { OptionalParseIntPipe, OptionalParseFloatPipe, OptionalParseBoolPipe, OptionalParseEnumPipe, RequiredPipe } from '../pipes';
 import { ApiParseArrayPipe, ApiValidationPipe } from '../pipes';
+import { AuthGuard, AuthSchemes } from '../auth.guard';
 
 {{#imports}}
 // @ts-ignore
@@ -31,19 +32,22 @@ export abstract class {{classname}} {
 // ||||||||||
   /**
   {{#summary}}
-    * {{.}}
+   * {{.}}
   {{/summary}}
   {{#notes}}
-    * {{.}}
+   * {{.}}
   {{/notes}}
-
   {{#allParams}}
-    * @param {{paramName}} {{description}}
+   * @param {{paramName}} {{description}}
   {{/allParams}}
   {{#isDeprecated}}
-    * @deprecated
+   * @deprecated
   {{/isDeprecated}}
-    */
+   */
+
+  {{#authMethods}}{{#-first}}
+  @AuthSchemes([{{#authMethods}}'{{name}}'{{^-last}}, {{/-last}}{{/authMethods}}])
+  @UseGuards(AuthGuard) {{/-first}}{{/authMethods}}
   //// @{{httpMethod}}('{{path}}'){{#isMultipart}}
   @UseInterceptors(FileInterceptor({{#formParams}}{{#isFile}}'{{paramName}}'{{/isFile}}{{/formParams}})){{/isMultipart}}
   @HttpCode({{#responses.0}}{{code}}{{/responses.0}})

package/targets/nestjs/templates/auth.guard.ts

@@ -0,0 +1,38 @@
+import {
+  CanActivate,
+  ExecutionContext,
+  Inject,
+  Injectable,
+} from "@nestjs/common";
+import { Reflector } from "@nestjs/core";
+import { Observable } from "rxjs";
+
+export const AuthSchemes = Reflector.createDecorator<string[]>();
+
+export interface AuthServiceInterface {
+  validate: (
+    scheme: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    request: any
+  ) => boolean | Promise<boolean> | Observable<boolean>;
+}
+
+export const AUTH_SERVICE_TOKEN = "OASG_AUTH_SERVICE";
+
+@Injectable()
+export class AuthGuard implements CanActivate {
+  constructor(
+    @Inject(AUTH_SERVICE_TOKEN)
+    private readonly authService: AuthServiceInterface,
+    private readonly reflector: Reflector
+  ) {}
+
+  canActivate(
+    context: ExecutionContext
+  ): boolean | Promise<boolean> | Observable<boolean> {
+    const schemes = this.reflector.get(AuthSchemes, context.getHandler());
+    const request = context.switchToHttp().getRequest();
+
+    return schemes.some((scheme) => this.authService.validate(scheme, request));
+  }
+}

package/targets/nestjs/templates/package.mustache

@@ -13,10 +13,9 @@
   },
   "main": "dist/index.js",
   "peerDependencies": {
-    "@nestjs/common": "^9.0.0 || ^10.0.0",
-    "@nestjs/core": "^9.0.0 || ^10.0.0",
-    "@nestjs/platform-express": "^9.0.0 || ^10.0.0",
-    "@types/validator": "13.11.7"
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@nestjs/platform-express": "^10.0.0",
   },
   "dependencies": {
     "class-transformer": "^0.5.1",