@team-supercharge/oasg 15.2.0-typescript-axios-41a9a301.0 → 16.0.0

package/README.md

@@ -107,34 +107,33 @@ swaggerlint:
 
 The table below gives an overview of the changes (breaking, non-breaking, bug fixes) introduced in various major versions. For the resolution of breaking changes please consult the [Migration Guide](#migration-guide).
 
-| Component                    |   |   |   |   |   |   |   |   |   |   |   |   |   |   |   |
-|------------------------------|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
-| **Internal**                 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
-| _Core_                       |🐛  |💥  |✨  |🐛  |✨  |➖  |✨  |🐛  |🐛  |➖  |💥  |💥  |✨  |💥  |🆕  |
-| _Linter_                     |➖  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |🐛  |➖  |✨  |💥  |🆕  |
-| **Client Targets**           | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
-| `android`                    |➖  |🐛  |💥  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
-| `angular`                    |➖  |🐛  |💥  |➖  |➖  |➖  |🐛  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |🆕  |
-| `dotnet`                     |➖  |🆕  |
-| `feign`                      |➖  |➖  |➖  |➖  |➖  |✨  |💥  |💥  |➖  |➖  |🐛  |🐛  |🆕  |
-| `feign-kotlin`               |➖  |➖  |➖  |➖  |➖  |🆕  |
-| `flutter`                    |➖  |➖  |🆕  |
-| `ios`                        |➖  |➖  |💥  |🐛  |➖  |➖  |➖  |✨  |➖  |💥  |➖  |➖  |✨  |🆕  |
-| `kmp`                        |➖  |🆕  |
-| `python`                     |➖  |🐛  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
-| `react`                      |🐛  |➖  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
-| `typescript-axios`           |🆕  |
-| **Server Targets**           | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
-| `nestjs`                     |💥  |➖  |💥  |✨  |➖  |➖  |🐛  |➖  |➖  |✨  |🆕  |
-| `python-fastapi`             |➖  |🆕  |
-| `python-fastapi-raw-request` |➖  |🆕  |
-| `spring`                     |➖  |➖  |➖  |➖  |➖  |✨  |💥  |💥  |➖  |➖  |➖  |✨  |➖  |🆕  |
-| `spring-kotlin`              |➖  |➖  |➖  |➖  |➖  |✨  |💥  |💥  |➖  |➖  |🐛  |✨  |➖  |🆕  |
-| **Misc Targets**             | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
-| `contract-testing`           |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
-| `openapi`                    |➖  |➖  |➖  |💥  |➖  |➖  |✨  |➖  |🆕  |
-| `stubby`                     |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |🆕  |
-| `postman`                    |🆕  |
+| Component                    |   |   |   |   |   |   |   |   |   |   |   |   |   |   |   |   |
+|------------------------------|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
+| **Internal**                 | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
+| _Core_                       |➖  |🐛  |💥  |✨  |🐛  |✨  |➖  |✨  |🐛  |🐛  |➖  |💥  |💥  |✨  |💥  |🆕  |
+| _Linter_                     |➖  |➖  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |🐛  |➖  |✨  |💥  |🆕  |
+| **Client Targets**           | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
+| `android`                    |➖  |➖  |🐛  |💥  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
+| `angular`                    |➖  |➖  |🐛  |💥  |➖  |➖  |➖  |🐛  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |🆕  |
+| `dotnet`                     |➖  |➖  |🆕  |
+| `feign`                      |➖  |➖  |➖  |➖  |➖  |➖  |✨  |💥  |💥  |➖  |➖  |🐛  |🐛  |🆕  |
+| `feign-kotlin`               |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
+| `flutter`                    |➖  |➖  |➖  |🆕  |
+| `ios`                        |➖  |➖  |➖  |💥  |🐛  |➖  |➖  |➖  |✨  |➖  |💥  |➖  |➖  |✨  |🆕  |
+| `kmp`                        |➖  |➖  |🆕  |
+| `python-legacy`              |💥  |➖  |🐛  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
+| `react`                      |➖  |🐛  |➖  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
+| **Server Targets**           | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
+| `nestjs`                     |💥  |💥  |➖  |💥  |✨  |➖  |➖  |🐛  |➖  |➖  |✨  |🆕  |
+| `python-fastapi`             |➖  |➖  |🆕  |
+| `python-fastapi-raw-request` |➖  |➖  |🆕  |
+| `spring`                     |➖  |➖  |➖  |➖  |➖  |➖  |✨  |💥  |💥  |➖  |➖  |➖  |✨  |➖  |🆕  |
+| `spring-kotlin`              |➖  |➖  |➖  |➖  |➖  |➖  |✨  |💥  |💥  |➖  |➖  |🐛  |✨  |➖  |🆕  |
+| **Misc Targets**             | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
+| `contract-testing`           |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
+| `openapi`                    |➖  |➖  |➖  |➖  |💥  |➖  |➖  |✨  |➖  |🆕  |
+| `stubby`                     |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |🆕  |
+| `postman`                    |➖  |🆕  |
 
 **Legend:**
 
@@ -721,12 +720,12 @@ TBD
 | formatterCustomArgs | Custom arguments of the `ktlint` formatter | N | --disabled_rules=no-wildcard-imports,max-line-length,enum-entry-name-case |
 | repository | URL of the Maven Repository | N | - |
 
-#### `python`
+#### `python-legacy`
 
 ```json
 {
-  "id": "client-python",
-  "type": "python",
+  "id": "client-python-legacy",
+  "type": "python-legacy",
   "source": "source-merged",
   "packageName": "oasg_example",
   "repositoryUrl": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/pypi"
@@ -738,6 +737,8 @@ TBD
 | packageName | Package nem for the project (convention: snake_case) | Y | - |
 | repositoryUrl | URL of the PyPI repository | Y | - |
 
+> ⚠️ Using Pydantic v1 for legacy reasons, this target will be discontinued.
+
 Publishing the PyPI packages is done with Twine. For authentication against the PiPI repository you need to set the `TWINE_USERNAME` and `TWINE_PASSWORD` environment variables.
 
 
@@ -995,28 +996,34 @@ Validations from OpenAPI spec:
 |-|-|-|-|
 | fileName | Name of the generated file | N | `collection.json` |
 
-#### `typescript-axios`
+---
 
-```json
-{
-  "id": "client-typescript-axios",
-  "type": "typescript-axios",
-  "source": "source-simple",
-  "packageName": "@project/oasg-example-typescript-axios-simple",
-  "repository": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/npm/"
-}
+# Migration Guide
+
+This section covers the breaking changes and their migrations across major version upgrades.
+
+## From `15.x.x` to `16.0.0`
+
+### Breaking in `nestjs` target
+
+In the `nestjs` target the `AuthServiceInterface` needed to be implemented in projects got changed from:
+
+```typescript
+validate: (scheme: SecurityScheme, request: any) => boolean | Promise<boolean> | Observable<boolean>;
 ```
 
-|Parameter| Description| Required | Default |
-|-|-|-|-|
-| packageName | Name of the generated NPM package | Y | - |
-| repository | URL of the NPM package registry | Y | - |
+to
 
----
+```typescript
+validate: (scheme: SecurityScheme, context: ExecutionContext) => boolean | Promise<boolean> | Observable<boolean>;
+```
 
-# Migration Guide
+in order to provide compabilitity with existing Nest guards
+
+### Breaking in `python` target
+
+From this version the `python` target got renamed to `python-legacy` to reflect the same changes in __OpenAPI Generator__ where starting from version 7.1.0 the `python-pydantic-v1` generator outputs the "legacy compatible" code, and the ongoing `python` generator got updated to support Pydantic v2.
 
-This section covers the breaking changes and their migrations across major version upgrades.
 
 ## From `14.x.x` to `15.0.0`
 

package/bin/oasg

@@ -42,9 +42,8 @@ const DEFAULT_GENERATOR_MAPPING = {
   "flutter":                      { version: '7.0.1',   generator: 'dart-dio' },
   "ios":                          { version: '7.0.1',   generator: 'swift5' },
   "kmp":                          { version: '7.8.0',   generator: 'kotlin' },
-  "python":                       { version: '7.0.1',   generator: 'python' },
+  "python-legacy":                { version: '7.11.0',  generator: 'python-pydantic-v1' },
   "react":                        { version: '7.0.1',   generator: 'typescript-fetch' },
-  "typescript-axios":             { version: '7.11.0',  generator: 'typescript-axios' },
   // server targets
   "nestjs":                       { version: '7.0.1',   generator: 'typescript-angular' },
   "spring":                       { version: '7.0.1',   generator: 'spring' },

package/config.schema.yml

@@ -19,7 +19,7 @@ properties:
         - $ref: '#/targets/Stubby'
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
-        - $ref: '#/targets/Python'
+        - $ref: '#/targets/PythonLegacy'
         - $ref: '#/targets/PythonFastApi'
         - $ref: '#/targets/PythonFastApiRawRequest'
         - $ref: '#/targets/ContractTesting'
@@ -29,7 +29,6 @@ properties:
         - $ref: '#/targets/Kmp'
         - $ref: '#/targets/Dotnet'
         - $ref: '#/targets/Postman'
-        - $ref: '#/targets/TypeScriptAxios'
 required:
   - targets
 additionalProperties: false
@@ -287,12 +286,12 @@ targets:
         - repository
         - interfaceType
 
-  Python:
+  PythonLegacy:
     allOf:
       - $ref: '#/targets/Base'
       - properties:
           type:
-            pattern: "^python$"
+            pattern: "^python-legacy$"
           packageName:
             type: string
           repositoryUrl:
@@ -357,20 +356,6 @@ targets:
           - packageName
           - repository
 
-  TypeScriptAxios:
-    allOf:
-      - $ref: '#/targets/Base'
-      - properties:
-          type:
-            pattern: "^typescript-axios$"
-          packageName:
-            type: string
-          repository:
-            type: string
-        required:
-          - packageName
-          - repository
-
   OpenAPI:
     allOf:
       - $ref: '#/targets/Base'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "15.2.0-typescript-axios-41a9a301.0",
+  "version": "16.0.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

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

@@ -6,7 +6,7 @@ import {
   UnauthorizedException,
 } from "@nestjs/common";
 import { Reflector } from "@nestjs/core";
-import { Observable } from "rxjs";
+import { firstValueFrom, isObservable, Observable } from "rxjs";
 
 // export securityScheme names as enum
 export enum SecurityScheme { {{#authMethods}}
@@ -17,11 +17,7 @@ export enum SecurityScheme { {{#authMethods}}
 export const AuthSchemes = Reflector.createDecorator<SecurityScheme[]>();
 
 export interface AuthServiceInterface {
-  validate: (
-    scheme: SecurityScheme,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    request: any
-  ) => boolean | Promise<boolean> | Observable<boolean>;
+  validate: (scheme: SecurityScheme, context: ExecutionContext) => boolean | Promise<boolean> | Observable<boolean>;
 }
 
 export const AUTH_SERVICE_TOKEN = "OASG_AUTH_SERVICE";
@@ -34,15 +30,26 @@ export class AuthGuard implements CanActivate {
     private readonly reflector: Reflector
   ) {}
 
-  canActivate(
-    context: ExecutionContext
-  ): boolean | Promise<boolean> | Observable<boolean> {
+  async canActivate(context: ExecutionContext): Promise<boolean> {
     const schemes = this.reflector.get<SecurityScheme[]>(AuthSchemes, context.getHandler());
-    const request = context.switchToHttp().getRequest();
 
-    if (schemes.some((scheme) => this.authService.validate(scheme, request)))
+    const validationResults = await Promise.all(schemes
+      .map((scheme) => this.authService.validate(scheme, context))
+      .map((validationResult) => this.extractValidationResultAsPromise(validationResult))
+    );
+
+    if (validationResults.some((result) => result)) {
       return true;
+    }
 
     throw new UnauthorizedException();
   }
+
+  private async extractValidationResultAsPromise(validationResult: boolean | Promise<boolean> | Observable<boolean> ): Promise<boolean> {
+    if (isObservable(validationResult)) {
+      return firstValueFrom(validationResult);
+    }
+
+    return validationResult;
+  }
 }

package/targets/typescript-axios/generate.sh

@@ -1,20 +0,0 @@
-#/bin/bash
-
-source $(dirname "$0")/../common.sh
-
-rm -rf out/$targetId
-mkdir -p out/$targetId
-
-java -jar $binary generate \
-  -g $generatorId \
-  -i $openApiFile \
-  -t $templateDir \
-  -o out/$targetId \
-  -c $(dirname "$0")/generator-config.json \
-  -p "npmVersion=$version,npmName=$packageName,npmRepository=$repository" $generatorCustomArgs
-
-cd out/$targetId
-
-npm install
-npm run build
-cd ../..

package/targets/typescript-axios/generator-config.json

@@ -1,20 +0,0 @@
-{
-  "modelPropertyNaming": "original",
-  "supportsES6": "true",
-  "providedInRoot": "true",
-  "ngVersion": "10.0.2",
-  "serviceSuffix": "Api",
-  "serviceFileSuffix": ".api",
-  "stringEnums": "true",
-  "enumPropertyNaming": "UPPERCASE",
-  "fileNaming": "kebab-case",
-  "useSingleRequestParameter": "false",
-  "sortModelPropertiesByRequiredFlag": "false",
-  "sortParamsByRequiredFlag": "true",
-  "inlineSchemaOptions": {
-    "ARRAY_ITEM_SUFFIX": "",
-    "MAP_ITEM_SUFFIX": "",
-    "SKIP_SCHEMA_REUSE": "true",
-    "RESOLVE_INLINE_ENUMS": "true"
-  }
-}

package/targets/typescript-axios/publish.sh

@@ -1,8 +0,0 @@
-#/bin/bash
-
-source $(dirname "$0")/../common.sh
-
-cd out/$targetId
-npm publish \
-  $(if [[ "$preRelease" == "true" ]]; then echo "--tag next"; fi)
-cd ../..