@team-supercharge/oasg 16.6.0 → 16.7.1-temp-feat-swift-openapi-generator-e02341ef

package/README.md

@@ -142,6 +142,7 @@ The table below gives an overview of the changes (breaking, non-breaking, bug fi
 | `plain-java`                 |🆕  |
 | `flutter`                    |➖  |➖  |➖  |🆕  |
 | `ios`                        |➖  |➖  |➖  |💥  |🐛  |➖  |➖  |➖  |✨  |➖  |💥  |➖  |➖  |✨  |🆕  |
+| `swift-openapi-generator`    |🆕  |
 | `kmp`                        |➖  |➖  |🆕  |
 | `python`                     |🆕  |
 | `python-legacy`              |💥  |➖  |🐛  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
@@ -701,6 +702,25 @@ TBD
 | interfaceType | Response type of the generated client: `Combine` / `Result` / `RxSwift` / `AsyncAwait` / `PromiseKit` | Y | - |
 | generatorCustomArgs | Custom arguments of the generator | N | - |
 
+#### `swift-openapi-generator`
+
+```json
+{
+  "id": "client-ios",
+  "type": "swift-openapi-generator",
+  "source": "source-merged",
+  "projectName": "OASgExample",
+  "repository": "git@gitlab.supercharge.io:example/openapi-generator-source.git",
+  "generatorCustomArgs": ""
+}
+```
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| projectName | Name of the project | Y | - |
+| repository | URL of the generated client api code repository | Y | - |
+| generatorCustomArgs | Custom arguments of the generator | N | - |
+
 #### `flutter`
 
 ```json
@@ -926,7 +946,7 @@ describe('Auth', function () {
 | repository | URL of the NPM package registry | Y | - |
 
 **Authorisation**<br>
-The package generates an AuthGuard and applies to endpoints, where a security scheme is defined.
+The package generates an AuthGuard and applies it to endpoints where a security scheme is defined.
 
 AuthGuard usage:
 Implement the `AuthServiceInterface`, which will receive a validation request for each security scheme added to the checked endpoint and define the validation per scheme.
@@ -953,7 +973,7 @@ Future improvements:
 - no multidimensional array validation in DTOs
 
 **Validation availability:**
-<br> _List is not comprehensive, missing items are definitely not currently supported_
+<br> _List is not comprehensive, missing items are definitely not supported currently_
 
 Validations in General:
 | Validation             | DTO | Query | Header | Path |

package/bin/oasg

@@ -42,6 +42,7 @@ const DEFAULT_GENERATOR_MAPPING = {
   "plain-java":                   { version: '7.11.0',  generator: 'java' },
   "flutter":                      { version: '7.0.1',   generator: 'dart-dio' },
   "ios":                          { version: '7.0.1',   generator: 'swift5' },
+  "swift-openapi-generator":      { version: undefined, generator: undefined },
   "kmp":                          { version: '7.8.0',   generator: 'kotlin' },
   "python":                       { version: '7.11.0',  generator: 'python' },
   "python-legacy":                { version: '7.11.0',  generator: 'python-pydantic-v1' },

package/config.schema.yml

@@ -312,6 +312,20 @@ targets:
         - repository
         - interfaceType
 
+  SwiftOpenAPIGenerator:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^swift-openapi-generator$"
+          packageName:
+            type: string
+          repositoryUrl:
+            type: string
+        required:
+        - packageName
+        - repositoryUrl
+
   Python:
     allOf:
       - $ref: '#/targets/Base'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "16.6.0",
+  "version": "16.7.1-temp-feat-swift-openapi-generator-e02341ef",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

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

@@ -4,7 +4,7 @@
 
 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 { HttpCode, Request, Response } from '@nestjs/common';
 import { UseInterceptors, UseGuards, UploadedFile, StreamableFile } from '@nestjs/common';
 import { FileInterceptor } from '@nestjs/platform-express';
 
@@ -51,11 +51,11 @@ export abstract class {{classname}} {
   //// @{{httpMethod}}('{{path}}'){{#isMultipart}}
   @UseInterceptors(FileInterceptor({{#formParams}}{{#isFile}}'{{paramName}}'{{/isFile}}{{/formParams}})){{/isMultipart}}
   @HttpCode({{#responses.0}}{{code}}{{/responses.0}})
-  private _{{nickname}}(@Request() req{{#allParams}}{{^isBodyParam}}, {{#isQueryParam}}@Query({{/isQueryParam}}{{#isPathParam}}@Param({{/isPathParam}}{{#isHeaderParam}}@Headers({{/isHeaderParam}}{{#isFormParam}}{{^isFile}}@Body({{/isFile}}{{#isFile}}@UploadedFile({{/isFile}}{{/isFormParam}}'{{paramName}}'{{#required}}{{#isHeaderParam}}{{/isHeaderParam}}{{^isHeaderParam}}, RequiredPipe{{/isHeaderParam}}{{/required}}{{#isArray}}, new ApiParseArrayPipe({ optional: true{{#items}}{{#isNumeric}}, items: Number{{/isNumeric}}{{#isBoolean}}, items: Boolean{{/isBoolean}}{{/items}} }){{/isArray}}{{#isNumber}}, OptionalParseFloatPipe{{/isNumber}}{{#isFloat}}, OptionalParseFloatPipe{{/isFloat}}{{#isDouble}}, OptionalParseFloatPipe{{/isDouble}}{{#isInteger}}, OptionalParseIntPipe{{/isInteger}}{{#isLong}}, OptionalParseIntPipe{{/isLong}}{{#isBoolean}}, OptionalParseBoolPipe{{/isBoolean}}{{#allowableValues}}{{^enumVars.empty}}, new OptionalParseEnumPipe({{{dataType}}}){{/enumVars.empty}}{{/allowableValues}}) {{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{/isBodyParam}}{{/allParams}}{{#bodyParam}}, @Body(new ApiValidationPipe({ whitelist: true, forbidNonWhitelisted: true })) requestBody{{^required}}?{{/required}}: {{{dataType}}}{{/bodyParam}}): Promise<{{#returnType}}{{#isResponseFile}}StreamableFile{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}{{/returnType}}{{^returnType}}void{{/returnType}}> {
-    return this.{{nickname}}({{#allParams.0}}{ params: { {{#allParams}}{{^isBodyParam}}{{^-first}}, {{/-first}}{{paramName}}{{/isBodyParam}}{{/allParams}} }{{#bodyParam}}, body: requestBody{{/bodyParam}} }, {{/allParams.0}}req);
+  private _{{nickname}}(@Request() req: unknown, @Response({ passthrough: true }) res: unknown{{#allParams}}{{^isBodyParam}}, {{#isQueryParam}}@Query({{/isQueryParam}}{{#isPathParam}}@Param({{/isPathParam}}{{#isHeaderParam}}@Headers({{/isHeaderParam}}{{#isFormParam}}{{^isFile}}@Body({{/isFile}}{{#isFile}}@UploadedFile({{/isFile}}{{/isFormParam}}'{{paramName}}'{{#required}}{{#isHeaderParam}}{{/isHeaderParam}}{{^isHeaderParam}}, RequiredPipe{{/isHeaderParam}}{{/required}}{{#isArray}}, new ApiParseArrayPipe({ optional: true{{#items}}{{#isNumeric}}, items: Number{{/isNumeric}}{{#isBoolean}}, items: Boolean{{/isBoolean}}{{/items}} }){{/isArray}}{{#isNumber}}, OptionalParseFloatPipe{{/isNumber}}{{#isFloat}}, OptionalParseFloatPipe{{/isFloat}}{{#isDouble}}, OptionalParseFloatPipe{{/isDouble}}{{#isInteger}}, OptionalParseIntPipe{{/isInteger}}{{#isLong}}, OptionalParseIntPipe{{/isLong}}{{#isBoolean}}, OptionalParseBoolPipe{{/isBoolean}}{{#allowableValues}}{{^enumVars.empty}}, new OptionalParseEnumPipe({{{dataType}}}){{/enumVars.empty}}{{/allowableValues}}) {{paramName}}{{^required}}?{{/required}}: {{{dataType}}}{{/isBodyParam}}{{/allParams}}{{#bodyParam}}, @Body(new ApiValidationPipe({ whitelist: true, forbidNonWhitelisted: true })) requestBody{{^required}}?{{/required}}: {{{dataType}}}{{/bodyParam}}): Promise<{{#returnType}}{{#isResponseFile}}StreamableFile{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}{{/returnType}}{{^returnType}}void{{/returnType}}> {
+    return this.{{nickname}}({{#allParams.0}}{ params: { {{#allParams}}{{^isBodyParam}}{{^-first}}, {{/-first}}{{paramName}}{{/isBodyParam}}{{/allParams}} }{{#bodyParam}}, body: requestBody{{/bodyParam}} }, {{/allParams.0}}req, res);
   }
 
-  abstract {{nickname}}({{#allParams.0}}context: {{operationIdCamelCase}}Context, {{/allParams.0}}req?): Promise<{{#returnType}}{{#isResponseFile}}StreamableFile{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}{{/returnType}}{{^returnType}}void{{/returnType}}>;
+  abstract {{nickname}}({{#allParams.0}}context: {{operationIdCamelCase}}Context, {{/allParams.0}}req?: unknown, res?: unknown): Promise<{{#returnType}}{{#isResponseFile}}StreamableFile{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}{{/returnType}}{{^returnType}}void{{/returnType}}>;
 
   {{/operation}}
 // ||||||||||

package/targets/nestjs/templates/is-valid-iso8601-date.validator.ts

@@ -10,7 +10,11 @@ export const IsValidISO8601Date = () => {
       options: {},
       validator: {
         validate(value: string) {
-          const [year, month, day] = value.split("-").map(Number);
+          const [year, month, day] = value.split("-").map(Number) as [
+            number,
+            number,
+            number
+          ];
           const date = new Date(year, month - 1, day);
 
           // Check if the date components are valid

package/targets/swift-openapi-generator/Package.swift

@@ -0,0 +1,26 @@
+// swift-tools-version: 6.0
+import PackageDescription
+
+let package = Package(
+    name: "__PROJECT_NAME__",
+    platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6), .visionOS(.v1)],
+    products: [
+        .library(
+            name: "__PROJECT_NAME__",
+            targets: ["__PROJECT_NAME__"]
+        )
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),
+    ],
+    targets: [
+        .target(
+            name: "__PROJECT_NAME__",
+            dependencies: [
+                .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
+                .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
+            ]
+        )
+    ]
+)

package/targets/swift-openapi-generator/generate.sh

@@ -0,0 +1,47 @@
+#/bin/bash
+
+CURRENT_WORKING_DIR=$(pwd)
+
+source $(dirname "$0")/../common.sh
+
+# Clear the output directory
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+# Variables
+SWIFT_OPENAPI_GENERATOR_GIT_URL=https://github.com/apple/swift-openapi-generator
+SWIFT_OPENAPI_GENERATOR_GIT_TAG=1.7.2
+SWIFT_OPENAPI_GENERATOR_CLONE_DIR=swift-openapi-generator/$SWIFT_OPENAPI_GENERATOR_GIT_TAG
+SWIFT_OPENAPI_GENERATOR_BIN="$SWIFT_OPENAPI_GENERATOR_CLONE_DIR/.build/release/swift-openapi-generator"
+OPENAPI_GENERATOR_CONFIG_PATH=openapi-generator-config.yaml
+
+# Clear OpenAPI generator directory
+rm -rf "$SWIFT_OPENAPI_GENERATOR_CLONE_DIR"
+mkdir -p "$SWIFT_OPENAPI_GENERATOR_CLONE_DIR"
+
+# Checkout the swift-openapi-generator repo
+git \
+  -c advice.detachedHead=false \
+  clone \
+  --branch "$SWIFT_OPENAPI_GENERATOR_GIT_TAG" \
+  --depth 1 \
+  "$SWIFT_OPENAPI_GENERATOR_GIT_URL" \
+  "$SWIFT_OPENAPI_GENERATOR_CLONE_DIR"
+
+# Build the swift-openapi-generator
+swift \
+  build \
+  --package-path "$SWIFT_OPENAPI_GENERATOR_CLONE_DIR" \
+  --configuration release \
+  --product swift-openapi-generator
+
+# Generate the swift client
+"$SWIFT_OPENAPI_GENERATOR_BIN" \
+	generate \
+  --config "$OPENAPI_GENERATOR_CONFIG_PATH" \
+  --output-directory "out/$targetId/Sources/$projectName" \
+  "$openApiFile"
+
+# Copy Package.swift file
+cp Package.swift out/$targetId
+sed -i '' "s/__PROJECT_NAME__/$projectName/" out/$targetId/Package.swift

package/targets/swift-openapi-generator/openapi-generator-config.yaml

@@ -0,0 +1,5 @@
+generate:
+  - types
+  - client
+accessModifier: public
+namingStrategy: idiomatic

package/targets/swift-openapi-generator/publish.sh

@@ -0,0 +1,33 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out
+git clone $repository generator-source
+
+# Remove all old files from the generator-source directory
+cd generator-source
+git rm -rf .
+git clean -fdx
+cd ..
+
+# Copy the generated files to the generator-source directory
+cp -rf $targetId/* generator-source
+
+cd generator-source
+if [ $(git status --porcelain | wc -l) -eq "0" ]; then
+  echo "🟢 No changes"
+else
+  git add .
+  git commit -m "chore(release): $version"
+
+  if [ "$preRelease" == "false" ]; then git push; fi
+
+  tagVersion="v$version"
+  git tag -f $tagVersion
+  git push origin -f --tags
+fi
+
+cd ..
+rm -rf generator-source
+cd ../..