@team-supercharge/oasg 16.7.1 → 16.8.1

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`                        |➖  |➖  |➖  |💥  |🐛  |➖  |➖  |➖  |✨  |➖  |💥  |➖  |➖  |✨  |🆕  |
+| `apple-swift`                |🆕  |
 | `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 | - |
 
+#### `apple-swift`
+
+```json
+{
+  "id": "client-ios",
+  "type": "apple-swift",
+  "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
@@ -1028,6 +1048,27 @@ Validations from OpenAPI spec:
 | packageName | Name of the generated package | Y | - |
 | generatorCustomArgs | Custom arguments of the generator (--global-property, --additional-properties) | N | - |
 
+#### `dotnet-webapi`
+
+```json
+{
+  "id": "dotnet-webapi",
+  "type": "dotnet-webapi",
+  "source": "source-merged",
+  "sourceUrl": "https://api.nuget.org/v3/index.json",
+  "apiKey": "apiKey",
+  "packageName": "packageName",
+  "generatorCustomArgs": "--global-property=supportingFiles,modelDocs --additional-properties=nullableReferenceTypes=false"
+}
+```
+
+| Parameter           | Description                                                                    | Required | Default |
+| ------------------- | ------------------------------------------------------------------------------ | -------- | ------- |
+| sourceUrl           | Url to where the package will be published                                     | Y        | -       |
+| packageName         | Name of the generated package                                                  | Y        | -       |
+| apiKey              | Api key of nuget source (If not specified, provide the CI_JOB_TOKEN)           | N        | -       |
+| generatorCustomArgs | Custom arguments of the generator (--global-property, --additional-properties) | N        | -       |
+
 #### `postman`
 
 ```json

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' },
+  "apple-swift":                  { 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' },
@@ -54,7 +55,8 @@ const DEFAULT_GENERATOR_MAPPING = {
   "spring-kotlin":                { version: '7.11.0',  generator: 'kotlin-spring' },
   "python-fastapi":               { version: '7.8.0',   generator: 'python-fastapi' },
   "python-fastapi-raw-request":   { version: '7.0.1',   generator: 'python-fastapi' },
-  "dotnet":                       { version: '7.8.0',   generator: 'csharp-functions' },
+  "dotnet":                       { version: '7.11.0',  generator: 'csharp-functions' },
+  "dotnet-webapi":                { version: '7.11.0',  generator: 'aspnetcore' },
   // misc targets
   "contract-testing":             { version: '4.3.1',   generator: 'typescript-node' },
   "openapi":                      { version: undefined, generator: undefined },
@@ -551,7 +553,10 @@ function fetchBinary(target) {
   const generator = target.generator
   const binary = {};
 
-  if (generator.startsWith('http')) {
+  if (generator === undefined) {
+    return '/dev/null';
+  }
+  else if (generator.startsWith('http')) {
     binary.url = generator;
 
     const hash = crypto.createHash('sha256').update(binary.url).digest('hex').substring(0, 8);

package/config.schema.yml

@@ -20,6 +20,7 @@ properties:
         - $ref: '#/targets/Stubby'
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
+        - $ref: '#/targets/AppleSwift'
         - $ref: '#/targets/Python'
         - $ref: '#/targets/PythonLegacy'
         - $ref: '#/targets/PythonFastApi'
@@ -30,6 +31,7 @@ properties:
         - $ref: '#/targets/Flutter'
         - $ref: '#/targets/Kmp'
         - $ref: '#/targets/Dotnet'
+        - $ref: '#/targets/DotnetWebApi'
         - $ref: '#/targets/Postman'
         - $ref: '#/targets/TypeScriptAxios'
         - $ref: '#/targets/TypeScriptFetch'
@@ -312,6 +314,20 @@ targets:
         - repository
         - interfaceType
 
+  AppleSwift:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^apple-swift$"
+          projectName:
+            type: string
+          repository:
+            type: string
+        required:
+        - projectName
+        - repository
+
   Python:
     allOf:
       - $ref: '#/targets/Base'
@@ -436,6 +452,22 @@ targets:
           - apiKey
           - packageName
 
+  DotnetWebApi:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: '^dotnet-webapi$'
+          sourceUrl:
+            type: string
+          apiKey:
+            type: string
+          packageName:
+            type: string
+        required:
+          - sourceUrl
+          - packageName    
+
   Kmp:
     allOf:
       - $ref: '#/targets/Base'

package/package.json

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

package/targets/apple-swift/generate.sh

@@ -0,0 +1,30 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+# Clear the output directory
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+# Generate swift code from OpenAPI spec
+swift-openapi-generator \
+	generate \
+  --config "$templateDir/openapi-generator-config-client.yaml" \
+  --output-directory "out/$targetId/Sources/$projectName" \
+  "$openApiFile"
+
+swift-openapi-generator \
+	generate \
+  --config "$templateDir/openapi-generator-config-server.yaml" \
+  --output-directory "out/$targetId/Sources/${projectName}Server" \
+  "$openApiFile"
+
+# Copy Package.swift file
+cp "$templateDir/Package.swift" "out/$targetId/"
+
+# Replace the placeholder in Package.swift with the project name
+if [[ "$(uname -s)" == "Darwin"* ]]; then
+  sed -i '' "s/__PROJECT_NAME__/$projectName/" "out/$targetId/Package.swift"
+else
+  sed -i "s/__PROJECT_NAME__/$projectName/" "out/$targetId/Package.swift"
+fi

package/targets/apple-swift/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 ../..

package/targets/apple-swift/templates/Package.swift

@@ -0,0 +1,36 @@
+// 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__"]
+        ),
+        .library(
+            name: "__PROJECT_NAME__Server",
+            targets: ["__PROJECT_NAME__Server"]
+        )
+    ],
+    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"),
+            ]
+        ),
+        .target(
+            name: "__PROJECT_NAME__Server",
+            dependencies: [
+                .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
+            ]
+        ),
+    ]
+)

package/targets/apple-swift/templates/openapi-generator-config-client.yaml

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

package/targets/apple-swift/templates/openapi-generator-config-server.yaml

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

package/targets/dotnet/publish.sh

@@ -4,20 +4,18 @@ source $(dirname "$0")/../common.sh
 
 cd out/$targetId
 
+# install dotnet
+wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
+chmod +x dotnet-install.sh
+./dotnet-install.sh --channel 6.0 --install-dir "$HOME/.dotnet"
+export PATH="$HOME/.dotnet:$PATH"
+
 # pack
 dotnet restore
 dotnet build -c Release
 dotnet pack -c Release -p:Version=$version -p:IsPackable=true
 
-isWindows=false
-if [[ "$OSTYPE" == "cygwin"* ]] || [[ "$OSTYPE" == "msys"* ]]; then
-    isWindows=true
-fi
-storePasswordOption=$([[ $isWindows == true ]] && echo "" || echo "--store-password-in-clear-text")
-
 # publish
-echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><configuration></configuration>" > nuget.config
-dotnet nuget add source "${sourceUrl}" -n Feed -u User -p "${apiKey}" --configfile nuget.config $storePasswordOption
-dotnet nuget push "src/**/bin/Release/*.nupkg" -s ${sourceUrl} -k AZ
+dotnet nuget push "src/**/bin/Release/*.nupkg" --source $sourceUrl -k ${apiKey:-$CI_JOB_TOKEN}
 
 cd ../..

package/targets/dotnet-webapi/generate.sh

@@ -0,0 +1,15 @@
+#!/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 "packageVersion=$version,packageName=$packageName" \
+  $generatorCustomArgs

package/targets/dotnet-webapi/generator-config.json

@@ -0,0 +1,17 @@
+{
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  },
+  "additionalProperties": {
+    "aspnetCoreVersion": "8.0",
+    "operationIsAsync": true,
+    "buildTarget": "library",
+    "generateBody": false,
+    "nullableReferenceTypes": true,
+    "operationResultTask": true,
+    "enumNameSuffix": "",
+    "enumValueSuffix": ""
+  }
+}

package/targets/dotnet-webapi/publish.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+
+# install dotnet
+wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
+chmod +x dotnet-install.sh
+./dotnet-install.sh --channel 8.0 --install-dir "$HOME/.dotnet"
+export PATH="$HOME/.dotnet:$PATH"
+
+# pack
+dotnet restore
+dotnet build -c Release
+dotnet pack -c Release -p:Version=$version -p:IsPackable=true
+
+# publish
+dotnet nuget push "src/**/bin/Release/*.nupkg" --source $sourceUrl -k ${apiKey:-$CI_JOB_TOKEN}
+
+cd ../..

package/targets/dotnet-webapi/templates/model.mustache

@@ -0,0 +1,198 @@
+{{>partial_header}}
+using System;
+using System.Linq;
+using System.Text;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.ComponentModel.DataAnnotations;
+using System.Runtime.Serialization;
+{{#useNewtonsoft}}
+using Newtonsoft.Json;
+{{/useNewtonsoft}}
+{{^useNewtonsoft}}
+using System.Text.Json;
+{{/useNewtonsoft}}
+{{#models}}
+{{#model}}
+{{#discriminator}}
+using JsonSubTypes;
+{{#useSwashbuckle}}
+using Swashbuckle.AspNetCore.Annotations;
+{{/useSwashbuckle}}
+{{/discriminator}}
+{{/model}}
+{{/models}}
+using {{packageName}}.Converters;
+
+{{#models}}
+{{#model}}
+namespace {{modelPackage}}
+{ {{#isEnum}}{{>enumClass}}{{/isEnum}}{{^isEnum}}
+    /// <summary>
+    /// {{description}}
+    /// </summary>
+    [DataContract]
+    {{#discriminator}}
+    {{#useNewtonsoft}}
+    {{#mappedModels.size}}
+    [JsonConverter(typeof(JsonSubtypes), "{{{discriminatorName}}}")]
+    {{/mappedModels.size}}
+    {{/useNewtonsoft}}
+    {{#useSwashbuckle}}
+    [SwaggerDiscriminator("{{{discriminatorName}}}")]
+    {{/useSwashbuckle}}
+    {{#mappedModels}}
+    [JsonSubtypes.KnownSubType(typeof({{{modelName}}}), "{{^vendorExtensions.x-discriminator-value}}{{{mappingName}}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{.}}}{{/vendorExtensions.x-discriminator-value}}")]
+    {{#useSwashbuckle}}
+    [SwaggerSubType(typeof({{{modelName}}}), DiscriminatorValue =  "{{^vendorExtensions.x-discriminator-value}}{{{mappingName}}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{.}}}{{/vendorExtensions.x-discriminator-value}}")]
+    {{/useSwashbuckle}}
+    {{/mappedModels}}
+    {{/discriminator}}
+    public {{#modelClassModifier}}{{.}} {{/modelClassModifier}}class {{classname}} {{#parent}}: {{{.}}}{{^pocoModels}}, {{/pocoModels}}{{/parent}}{{^pocoModels}}{{^parent}}: {{/parent}}IEquatable<{{classname}}>{{/pocoModels}}
+    {
+        {{#vars}}
+        {{#items.isEnum}}
+        {{#items}}
+        {{^complexType}}
+{{>enumClass}}
+        {{/complexType}}
+        {{/items}}
+        {{/items.isEnum}}
+        {{#isEnum}}
+        {{^complexType}}
+{{>enumClass}}
+        {{/complexType}}
+        {{/isEnum}}
+        /// <summary>
+        /// {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}}
+        /// </summary>{{#description}}
+        /// <value>{{.}}</value>{{/description}}{{#example}}
+        /* <example>{{.}}</example> */{{/example}}{{#required}}
+        [Required]{{/required}}{{#pattern}}
+        [RegularExpression("{{{.}}}")]{{/pattern}}{{#minLength}}{{#maxLength}}
+        [StringLength({{maxLength}}, MinimumLength={{minLength}})]{{/maxLength}}{{/minLength}}{{#minLength}}{{^maxLength}}
+        [MinLength({{minLength}})]{{/maxLength}}{{/minLength}}{{^minLength}}{{#maxLength}}
+        [MaxLength({{.}})]{{/maxLength}}{{/minLength}}{{#minimum}}{{#maximum}}
+        [Range({{minimum}}, {{maximum}})]{{/maximum}}{{/minimum}}
+        [DataMember(Name="{{baseName}}", EmitDefaultValue={{#isNullable}}true{{/isNullable}}{{^isNullable}}{{#vendorExtensions.x-is-value-type}}true{{/vendorExtensions.x-is-value-type}}{{^vendorExtensions.x-is-value-type}}false{{/vendorExtensions.x-is-value-type}}{{/isNullable}})]
+        {{#isEnum}}
+        public {{{datatypeWithEnum}}}{{#isNullable}}{{^required}}?{{/required}}{{/isNullable}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
+        {{/isEnum}}
+        {{^isEnum}}
+        public {{{dataType}}}{{#nullableReferenceTypes}}{{^isContainer}}{{^required}}{{^isNullable}}?{{/isNullable}}{{/required}}{{/isContainer}}{{/nullableReferenceTypes}} {{name}} { get; set; }{{#defaultValue}} = {{{.}}};{{/defaultValue}}
+        {{/isEnum}}
+        {{^-last}}
+
+        {{/-last}}
+        {{/vars}}
+
+        {{^pocoModels}}
+        /// <summary>
+        /// Returns the string presentation of the object
+        /// </summary>
+        /// <returns>String presentation of the object</returns>
+        public override string ToString()
+        {
+            var sb = new StringBuilder();
+            sb.Append("class {{classname}} {\n");
+            {{#vars}}
+            sb.Append("  {{name}}: ").Append({{name}}).Append("\n");
+            {{/vars}}
+            sb.Append("}\n");
+            return sb.ToString();
+        }
+
+        /// <summary>
+        /// Returns the JSON string presentation of the object
+        /// </summary>
+        /// <returns>JSON string presentation of the object</returns>
+        public {{#parent}}{{^isMap}}{{^isArray}}new {{/isArray}}{{/isMap}}{{/parent}}string ToJson()
+        {
+            {{#useNewtonsoft}}
+            return JsonConvert.SerializeObject(this, Formatting.Indented);
+            {{/useNewtonsoft}}
+            {{^useNewtonsoft}}
+            var options = new JsonSerializerOptions
+            {
+                WriteIndented = true
+            };
+
+            return JsonSerializer.Serialize(this, options);
+            {{/useNewtonsoft}}
+        }
+
+        /// <summary>
+        /// Returns true if objects are equal
+        /// </summary>
+        /// <param name="obj">Object to be compared</param>
+        /// <returns>Boolean</returns>
+        public override bool Equals(object obj)
+        {
+            if (obj is null) return false;
+            if (ReferenceEquals(this, obj)) return true;
+            return obj.GetType() == GetType() && Equals(({{classname}})obj);
+        }
+
+        /// <summary>
+        /// Returns true if {{classname}} instances are equal
+        /// </summary>
+        /// <param name="other">Instance of {{classname}} to be compared</param>
+        /// <returns>Boolean</returns>
+        public bool Equals({{classname}} other)
+        {
+            if (other is null) return false;
+            if (ReferenceEquals(this, other)) return true;
+
+            return {{#vars}}{{^isContainer}}
+                (
+                    {{name}} == other.{{name}} ||
+                    {{^vendorExtensions.x-is-value-type}}{{name}} != null &&{{/vendorExtensions.x-is-value-type}}
+                    {{name}}.Equals(other.{{name}})
+                ){{^-last}} && {{/-last}}{{/isContainer}}{{#isContainer}}
+                (
+                    {{name}} == other.{{name}} ||
+                    {{^vendorExtensions.x-is-value-type}}{{name}} != null &&
+                    other.{{name}} != null &&
+                    {{/vendorExtensions.x-is-value-type}}{{name}}.SequenceEqual(other.{{name}})
+                ){{^-last}} && {{/-last}}{{/isContainer}}{{/vars}}{{^vars}}false{{/vars}};
+        }
+
+        /// <summary>
+        /// Gets the hash code
+        /// </summary>
+        /// <returns>Hash code</returns>
+        public override int GetHashCode()
+        {
+            unchecked // Overflow is fine, just wrap
+            {
+                var hashCode = 41;
+                // Suitable nullity checks etc, of course :)
+                {{#vars}}
+                    {{^vendorExtensions.x-is-value-type}}if ({{name}} != null){{/vendorExtensions.x-is-value-type}}
+                    hashCode = hashCode * 59 + {{name}}.GetHashCode();
+                {{/vars}}
+                return hashCode;
+            }
+        }
+
+        #region Operators
+        #pragma warning disable 1591
+
+        public static bool operator ==({{classname}} left, {{classname}} right)
+        {
+            return Equals(left, right);
+        }
+
+        public static bool operator !=({{classname}} left, {{classname}} right)
+        {
+            return !Equals(left, right);
+        }
+
+        #pragma warning restore 1591
+        #endregion Operators
+        {{/pocoModels}}
+    }
+{{/isEnum}}
+{{/model}}
+{{/models}}
+}

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

@@ -18,7 +18,7 @@ import { {{ classname }} } from '{{ filename }}';
 {{/imports}}
 
 {{#operations}}
-{{#operation}}{{#allParams.0}}export interface {{operationIdCamelCase}}Context { params: { {{#allParams}}{{^isBodyParam}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}; {{/isBodyParam}}{{/allParams}} }{{#bodyParam}}, body: {{{dataType}}}{{/bodyParam}} };{{/allParams.0}}
+{{#operation}}{{#allParams.0}}export interface {{operationIdCamelCase}}Context { params: { {{#allParams}}{{^isBodyParam}}{{paramName}}{{^required}}?{{/required}}: {{{dataType}}}; {{/isBodyParam}}{{/allParams}} }{{#bodyParam}}, body{{^required}}?{{/required}}: {{{dataType}}}{{/bodyParam}} };{{/allParams.0}}
 {{/operation}}
 
 {{#description}}