@team-supercharge/oasg 13.0.0-test-export-01191261.0 → 13.1.0-kmp-8a9ad834.0

package/README.md

@@ -393,7 +393,7 @@ Glob patterns are supported.
 
 ### Overrides
 
-The following sections can be overrided: `info`, `externalDocs`, `license` and `contact`.
+The following sections can be overridden: `info`, `externalDocs`, `license` and `contact`.
 
 It does not override but replace the values of the OpenApi Specification with the corresponding values of the `config.json`.
 
@@ -402,20 +402,20 @@ You can check [here](https://gitlab.supercharge.io/misc/oasg/-/blob/master/confi
 ```json
 "overrides": {
   "info": {
-    "title": "Overrided Frontend API",
-    "description": "Overrided Frontend Merged API Description",
-    "termsOfService": "Overrided Terms Of Service",
+    "title": "Overridden Frontend API",
+    "description": "Overridden Frontend Merged API Description",
+    "termsOfService": "Overridden Terms Of Service",
     "version": "1.0.2"
   },
   "externalDocs": {
-    "description": "Overrided externalDocs",
+    "description": "Overridden externalDocs",
     "url": "https://supercharge.io"
   },
   "license": {
-    "name": "Overrided License"
+    "name": "Overridden License"
   },
   "contact": {
-    "name": "Overrided Contact",
+    "name": "Overridden Contact",
     "url": "https://supercharge.io",
     "email": "hello@supercharge.io"
   }
@@ -454,12 +454,12 @@ Common target parameters
 | packageName | Name of the generated NPM package | Y | - |
 | repository | URL of the NPM package registry | Y | - |
 
-#### `react-native`
+#### `react`
 
 ```json
 {
-  "id": "client-react-native",
-  "type": "react-native",
+  "id": "client-react",
+  "type": "react",
   "source": "source-merged",
   "packageName": "@project/oasg-example-react-native",
   "repository": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/npm/"
@@ -637,6 +637,33 @@ TBD
 | repository | URL of the generated client api code repository | Y | - |
 | generatorCustomArgs | Custom arguments of the generator | N | - |
 
+#### `kmp`
+
+```json
+{
+  "id": "client-kmp",
+  "type": "kmp",
+  "source": "source-merged",
+  "packageName": "io.supercharge.oasg.example",
+  "groupId": "io.supercharge.oasg.example",
+  "artifactId": "client",
+  "generatorCustomArgs": "--model-name-suffix=ApiModel",
+  "formatter": "1.0.0",
+  "formatterCustomArgs": "--disabled_rules=no-wildcard-imports,max-line-length,enum-entry-name-case",
+  "repository": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/maven"
+}
+```
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | Kotlin package name of the generated client | Y | - |
+| groupId | Generated artifact package's organization | Y | - |
+| artifactId | Generated artifact id  | Y | - |
+| generatorCustomArgs | Custom arguments of the generator | N | - |
+| formatter | `ktlint`: it can be a released version or a http(s) url | N | 1.0.0 |
+| 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`
 
 ```json
@@ -777,9 +804,11 @@ describe('Auth', function () {
 
 This section covers the breaking changes and their migrations across major version upgrades.
 
-## From `12.x.x` to `13.0.0`
+## From `12.x.x` to `13.0.1`
+
+> ❗ Due to version `13.0.0` has been published before erroneously (then unpublished) to the NPM registry, this version of the artifact won't be available either as an NPM package or a Docker base image. Please use the `13.0.1` patch version instead.
 
-### Schema naming updates in `angular`, `python`, `ios` targets
+### Schema naming updates in `angular`, `python`, `android`,`ios`, `nestjs`, `react` targets
 
 With the update to [OpenAPI Generator 7.0.0](https://github.com/OpenAPITools/openapi-generator/releases/tag/v7.0.0) the same breaking changes appear as in other targets before:
 
@@ -795,6 +824,12 @@ and more:
 
 * the default `ngVersion` parameter is set to `16.0.0` if you wish to specify another version, use e.g `"generatorCustomArgs": "-p ngVersion=12"` in your `config.json`
 
+### Breaking in `react-native` target
+
+* as both technologies used the same `typescript-fetch`-based generator, with this version the previous `react-native` target has been renamed to a more generic `react` name
+  - if at the future the best practices would change between the web-based _React_ and _React Native_ mobile projects, the `react-native` target will be reintroduced
+* enum key with multiple segments will contain underscores e.g. the enum key generated from the `value_one` value was used to be `VALUEONE`, this will become `VALUE_ONE` after the update
+
 ## From `11.x.x` to `12.0.0`
 
 The following options from the `openapi` target type has been moved to the [Source](#source) configuration.

package/bin/oasg

@@ -33,24 +33,25 @@ const PROXY_PORT = '9999';
 
 const DEFAULT_GENERATOR_MAPPING = {
   // client targets
-  "android":          { version: '6.6.0',   generator: 'kotlin' },
-  "angular":          { version: '7.0.0',   generator: 'typescript-angular' },
-  "feign":            { version: '6.6.0',   generator: 'spring' },
-  "feign-kotlin":     { version: '6.6.0',   generator: 'kotlin-spring' },
-  "flutter":          { version: '7.0.0',   generator: 'dart-dio' },
+  "android":          { version: '7.0.1',   generator: 'kotlin' },
+  "angular":          { version: '7.0.1',   generator: 'typescript-angular' },
+  "feign":            { version: '7.0.1',   generator: 'spring' },
+  "feign-kotlin":     { version: '7.0.1',   generator: 'kotlin-spring' },
+  "flutter":          { version: '7.0.1',   generator: 'dart-dio' },
   "ios":              { version: '7.0.1',   generator: 'swift5' },
-  "python":           { version: '7.0.0',   generator: 'python' },
-  "react-native":     { version: '4.3.1',   generator: 'typescript-fetch' },
+  "kmp":              { version: 'https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.2.0-SNAPSHOT/openapi-generator-cli-7.2.0-20231208.144106-84.jar',   generator: 'kotlin' },
+  "python":           { version: '7.0.1',   generator: 'python' },
+  "react":            { version: '7.0.1',   generator: 'typescript-fetch' },
   // server targets
-  "nestjs":           { version: '5.4.0',   generator: 'typescript-angular' },
-  "spring":           { version: '6.6.0',   generator: 'spring' },
-  "spring-kotlin":    { version: '6.6.0',   generator: 'kotlin-spring' },
+  "nestjs":           { version: '7.0.1',   generator: 'typescript-angular' },
+  "spring":           { version: '7.0.1',   generator: 'spring' },
+  "spring-kotlin":    { version: '7.0.1',   generator: 'kotlin-spring' },
   // misc targets
   "contract-testing": { version: '4.3.1',   generator: 'typescript-node' },
   "openapi":          { version: undefined, generator: undefined },
   "stubby":           { version: '4.3.1',   generator: 'stubby' },
 };
-const DEFAULT_KTLINT_VERSION = '0.39.0';
+const DEFAULT_KTLINT_VERSION = '1.0.0';
 const BIN_FOLDER = 'out/.bin';
 const TMP_FOLDER = 'out/.tmp';
 
@@ -108,9 +109,6 @@ async function run() {
 
     // generate
     .command(['generate [target]', 'g'], 'generate packages', (yargs) => {
-      console.log('----------------------------')
-      console.log(JSON.stringify(process.env))
-      console.log('----------------------------')
       yargs
         .positional('target', {
           describe: 'specify a target (optional)',
@@ -250,10 +248,10 @@ async function parseConfig() {
     }
   })
 
-  // set default ktlint to android targets with undefined
+  // set default ktlint to android and KMP targets with undefined
   config.targets.forEach(t => {
     //TODO: handle different types of platform
-    if (t.type === 'android') {
+    if (t.type === 'android' || t.type === 'kmp') {
       if (!t.formatter) {
         t.formatter = DEFAULT_KTLINT_VERSION;
       }
@@ -485,7 +483,7 @@ async function generate(argv) {
     let formatter;
 
     //TODO: handle different types of platforms
-    if (target.type === 'android') {
+    if (target.type === 'android' || target.type === 'kmp') {
       formatter = fetchFormatter(target);
     }
 

package/config.schema.yml

@@ -11,7 +11,7 @@ properties:
     items:
       oneOf:
         - $ref: '#/targets/Angular'
-        - $ref: '#/targets/ReactNative'
+        - $ref: '#/targets/React'
         - $ref: '#/targets/Feign'
         - $ref: '#/targets/FeignKotlin'
         - $ref: '#/targets/Spring'
@@ -24,6 +24,7 @@ properties:
         - $ref: '#/targets/NestJS'
         - $ref: '#/targets/OpenAPI'
         - $ref: '#/targets/Flutter'
+        - $ref: '#/targets/Kmp'
 required:
   - targets
 additionalProperties: false
@@ -121,12 +122,12 @@ targets:
           - packageName
           - repository
 
-  ReactNative:
+  React:
     allOf:
       - $ref: '#/targets/Base'
       - properties:
           type:
-            pattern: "^react-native$"
+            pattern: "^react$"
           packageName:
             type: string
           repository:
@@ -346,6 +347,31 @@ targets:
         - packageName
         - repository
 
+  Kmp:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^kmp$"
+          packageName:
+            type: string
+          groupId:
+            type: string
+          artifactId:
+            type: string
+          formatter:
+            type: string
+            pattern: '^(\d+\.\d+\.\d+(-.+)?)|(^http(s)?:\/\/.+$)$' # matches: 0.0.0(-pre) and http(s)://XXX
+          formatterCustomArgs:
+            type: string
+          repository:
+            type: string
+        required:
+        - packageName
+        - groupId
+        - artifactId
+        - repository
+
 definitions:
   # default
   SourceOverrides:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "13.0.0-test-export-01191261.0",
+  "version": "13.1.0-kmp-8a9ad834.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",
@@ -28,7 +28,7 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^10.1.0",
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@redocly/cli": "1.0.0-beta.126",
+    "@redocly/cli": "1.2.0",
     "@stoplight/prism-cli": "4.14.1",
     "@stoplight/spectral-cli": "6.6.0",
     "ajv": "^8.12.0",

package/targets/android/generate.sh

@@ -7,7 +7,7 @@ mkdir -p out/$targetId
 
 if [ -z "$formatterCustomArgs" ]
 then
-  formatterCustomArgs="--disabled_rules=no-wildcard-imports,max-line-length"
+  formatterCustomArgs="--disabled_rules=no-wildcard-imports,max-line-length,enum-entry-name-case"
 fi
 
 java -jar $binary generate \
@@ -18,4 +18,4 @@ java -jar $binary generate \
   -c $(dirname "$0")/generator-config.json \
   -p "artifactId=${artifactId},groupId=${groupId},packageName=${packageName},artifactVersion=${version}" $generatorCustomArgs
 
-$formatterBinary --verbose -F "out/$targetId/src/**/*.kt" $formatterCustomArgs --android
+$formatterBinary -F "out/$targetId/src/**/*.kt" $formatterCustomArgs

package/targets/android/generator-config.json

@@ -4,5 +4,10 @@
   "dateLibrary": "java8-localdatetime",
   "useCoroutines": true,
   "moshiCodeGen": true,
-  "omitGradleWrapper": true
+  "omitGradleWrapper": false,
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
 }

package/targets/android/templates/build.gradle.mustache

@@ -9,7 +9,7 @@ wrapper {
 {{/omitGradleWrapper}}
 
 buildscript {
-    ext.kotlin_version = '1.7.21'
+    ext.kotlin_version = '1.8.10'
     {{#jvm-ktor}}
     ext.ktor_version = '2.1.3'
     {{/jvm-ktor}}
@@ -28,6 +28,16 @@ buildscript {
     {{#jvm-vertx}}
     ext.vertx_version = "4.3.3"
     {{/jvm-vertx}}
+    {{#jvm-spring-webclient}}
+    {{#useSpringBoot3}}
+    ext.spring_boot_version = "3.1.0"
+    {{/useSpringBoot3}}
+    {{^useSpringBoot3}}
+    ext.spring_boot_version = "2.7.12"
+    {{/useSpringBoot3}}
+    ext.reactor_version = "3.5.6"
+    {{/jvm-spring-webclient}}
+    ext.spotless_version = "6.13.0"
 
     repositories {
         maven { url "https://repo1.maven.org/maven2" }
@@ -37,6 +47,7 @@ buildscript {
         {{#kotlinx_serialization}}
         classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
         {{/kotlinx_serialization}}
+        classpath "com.diffplug.spotless:spotless-plugin-gradle:$spotless_version"
     }
 }
 
@@ -54,6 +65,7 @@ apply plugin: 'kotlinx-serialization'
 apply plugin: 'idea'
 {{/idea}}
 apply plugin: 'maven-publish'
+apply plugin: 'com.diffplug.spotless'
 {{^useSettingsGradle}}
 
 repositories {
@@ -61,6 +73,27 @@ repositories {
 }
 {{/useSettingsGradle}}
 
+// Use spotless plugin to automatically format code, remove unused import, etc
+// To apply changes directly to the file, run `gradlew spotlessApply`
+// Ref: https://github.com/diffplug/spotless/tree/main/plugin-gradle
+spotless {
+    // comment out below to run spotless as part of the `check` task
+    enforceCheck false
+
+    format 'misc', {
+        // define the files (e.g. '*.gradle', '*.md') to apply `misc` to
+        target '.gitignore'
+
+        // define the steps to apply to those files
+        trimTrailingWhitespace()
+        indentWithSpaces() // Takes an integer argument if you don't like 4
+        endWithNewline()
+    }
+    kotlin {
+        ktfmt()
+    }
+}
+
 test {
     useJUnitPlatform()
 }
@@ -73,7 +106,13 @@ idea {
     }
 }
 {{/idea}}
-
+{{#jvm-spring-webclient}}{{#useSpringBoot3}}
+kotlin {
+    jvmToolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
+}
+{{/useSpringBoot3}}{{/jvm-spring-webclient}}
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
     {{^doNotUseRxAndCoroutines}}
@@ -84,13 +123,13 @@ dependencies {
     {{#moshi}}
     {{^moshiCodeGen}}
     implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
-    implementation "com.squareup.moshi:moshi-kotlin:1.13.0"
-    implementation "com.squareup.moshi:moshi-adapters:1.13.0"
+    implementation "com.squareup.moshi:moshi-kotlin:1.14.0"
+    implementation "com.squareup.moshi:moshi-adapters:1.14.0"
     {{/moshiCodeGen}}
     {{#moshiCodeGen}}
-    implementation "com.squareup.moshi:moshi:1.13.0"
-    implementation "com.squareup.moshi:moshi-adapters:1.13.0"
-    kapt "com.squareup.moshi:moshi-kotlin-codegen:1.13.0"
+    implementation "com.squareup.moshi:moshi:1.14.0"
+    implementation "com.squareup.moshi:moshi-adapters:1.14.0"
+    kapt "com.squareup.moshi:moshi-kotlin-codegen:1.14.0"
     {{/moshiCodeGen}}
     {{/moshi}}
     {{#gson}}
@@ -98,8 +137,8 @@ dependencies {
     {{/gson}}
     {{#jackson}}
     implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
-    implementation "com.fasterxml.jackson.module:jackson-module-kotlin:2.13.3"
-    implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.13.3"
+    implementation "com.fasterxml.jackson.module:jackson-module-kotlin:2.14.3"
+    implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.14.3"
     {{/jackson}}
     {{#kotlinx_serialization}}
     implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1"
@@ -120,10 +159,14 @@ dependencies {
     implementation "com.squareup.okhttp3:okhttp:3.12.13"
     {{/jvm-okhttp3}}
     {{#jvm-okhttp4}}
-    implementation "com.squareup.okhttp3:okhttp:4.10.0"
+    implementation "com.squareup.okhttp3:okhttp:4.11.0"
     {{/jvm-okhttp4}}
+    {{#jvm-spring-webclient}}
+    implementation "org.springframework.boot:spring-boot-starter-webflux:$spring_boot_version"
+    implementation "io.projectreactor:reactor-core:$reactor_version"
+    {{/jvm-spring-webclient}}
     {{#threetenbp}}
-    implementation "org.threeten:threetenbp:1.5.1"
+    implementation "org.threeten:threetenbp:1.6.8"
     {{/threetenbp}}
     {{#jvm-retrofit2}}
     {{#hasOAuthMethods}}
@@ -175,15 +218,12 @@ tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
 {{/kotlinx_serialization}}
 
 // OASg added for publication
-
 buildscript {
     dependencies {
         classpath 'org.jetbrains.dokka:dokka-gradle-plugin:1.7.20'
     }
 }
-
 apply plugin: 'org.jetbrains.dokka'
-
 task dokkaJar(type: Jar) {
     group = JavaBasePlugin.DOCUMENTATION_GROUP
     description = "Assembles Kotlin docs with Dokka"
@@ -191,38 +231,31 @@ task dokkaJar(type: Jar) {
     from(dokkaHtml)
     dependsOn(dokkaHtml)
 }
-
 task sourceJar(type: Jar) {
     archiveClassifier.set('sources')
     from sourceSets.main.allSource
     from 'build/generated/source/kapt/main'
     dependsOn project.tasks.getByName("compileKotlin")
 }
-
 publishing {
     publications {
         maven(MavenPublication) {
             groupId = '{{packageName}}'
             artifactId = '{{artifactId}}'
             version = "{{artifactVersion}}"
-
             artifact(dokkaJar)
             artifact(sourceJar)
-
             from components.java
         }
     }
-
     repositories {
         maven {
             name = "Gitlab"
             url = project.repoUrl
-
             credentials(HttpHeaderCredentials) {
                 name = "Job-Token"
                 value = System.env.CI_JOB_TOKEN
             }
-
             authentication {
                 header(HttpHeaderAuthentication)
             }

package/targets/android/templates/libraries/jvm-retrofit2/api.mustache

@@ -65,12 +65,6 @@ import okhttp3.MultipartBody
 
 {{/isMultipart}}
 {{/x-kotlin-multipart-import}}
-{{#operation}}
-{{#isResponseFile}}
-import okhttp3.ResponseBody
-
-{{/isResponseFile}}
-{{/operation}}
 interface {{classname}} {
     {{#operation}}
     {{#allParams}}
@@ -79,7 +73,7 @@ interface {{classname}} {
     /**
     * enum for parameter {{paramName}}
     */
-    {{#nonPublicApi}}internal {{/nonPublicApi}}enum class {{enumName}}_{{operationId}}(val value: {{^isContainer}}{{dataType}}{{/isContainer}}{{#isContainer}}kotlin.String{{/isContainer}}) {
+    {{#nonPublicApi}}internal {{/nonPublicApi}}enum class {{enumName}}{{operationIdCamelCase}}(val value: {{^isContainer}}{{dataType}}{{/isContainer}}{{#isContainer}}kotlin.String{{/isContainer}}) {
     {{^enumUnknownDefaultCase}}
         {{#allowableValues}}
             {{#enumVars}}
@@ -151,9 +145,7 @@ interface {{classname}} {
     {{^formParams}}
     {{#prioritizedContentTypes}}
     {{#-first}}
-    @Headers({
-        "Content-Type:{{{mediaType}}}"
-    })
+    @Headers("Content-Type:{{{mediaType}}}")
     {{/-first}}
     {{/prioritizedContentTypes}}
     {{/formParams}}