@team-supercharge/oasg 13.0.1 → 13.1.0-kmp-8a9ad834.0

package/README.md

@@ -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

package/bin/oasg

@@ -39,6 +39,7 @@ const DEFAULT_GENERATOR_MAPPING = {
   "feign-kotlin":     { version: '7.0.1',   generator: 'kotlin-spring' },
   "flutter":          { version: '7.0.1',   generator: 'dart-dio' },
   "ios":              { version: '7.0.1',   generator: 'swift5' },
+  "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
@@ -247,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;
       }
@@ -482,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

@@ -24,6 +24,7 @@ properties:
         - $ref: '#/targets/NestJS'
         - $ref: '#/targets/OpenAPI'
         - $ref: '#/targets/Flutter'
+        - $ref: '#/targets/Kmp'
 required:
   - targets
 additionalProperties: false
@@ -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.1",
+  "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",

package/targets/kmp/generate.sh

@@ -0,0 +1,21 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+if [ -z "$formatterCustomArgs" ]
+then
+  formatterCustomArgs="--disabled_rules=no-wildcard-imports,max-line-length,enum-entry-name-case"
+fi
+
+java -jar $binary generate \
+  -g $generatorId \
+  -i $openApiFile \
+  -t $templateDir \
+  -o out/$targetId \
+  -c $(dirname "$0")/generator-config.json \
+  -p "artifactId=${artifactId},groupId=${groupId},packageName=${packageName},artifactVersion=${version}" $generatorCustomArgs
+
+$formatterBinary -F "out/$targetId/src/**/*.kt" $formatterCustomArgs

package/targets/kmp/generator-config.json

@@ -0,0 +1,12 @@
+{
+  "library": "multiplatform",
+  "enumPropertyNaming": "original",
+  "dateLibrary": "kotlinx-datetime",
+  "useCoroutines": true,
+  "omitGradleWrapper": false,
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
+}

package/targets/kmp/publish.sh

@@ -0,0 +1,11 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+
+chmod a+x gradlew
+
+./gradlew clean publish -PrepoUrl=$repository
+
+cd ../..

package/targets/kmp/templates/build.gradle.kts.mustache

@@ -0,0 +1,121 @@
+import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+
+plugins {
+    kotlin("multiplatform"){{^omitGradlePluginVersions}} version "1.9.20" // kotlin_version{{/omitGradlePluginVersions}}
+    kotlin("plugin.serialization"){{^omitGradlePluginVersions}} version "1.9.20" // kotlin_version{{/omitGradlePluginVersions}}
+    id("maven-publish") // OASg added for publication
+}
+
+group = "{{groupId}}"
+version = "{{artifactVersion}}"
+
+val kotlin_version = "1.9.20"
+val coroutines_version = "1.7.3"
+val serialization_version = "1.6.1"
+val ktor_version = "2.3.6"
+
+repositories {
+    mavenCentral()
+}
+
+kotlin {
+    jvm()
+    iosX64()
+    iosArm64()
+    iosSimulatorArm64()
+    js {
+        browser()
+        nodejs()
+    }
+
+    sourceSets {
+        commonMain {
+            dependencies {
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version")
+                implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:$serialization_version")
+
+                api("io.ktor:ktor-client-core:$ktor_version")
+                api("io.ktor:ktor-client-serialization:$ktor_version")
+                api("io.ktor:ktor-client-content-negotiation:$ktor_version")
+                api("io.ktor:ktor-serialization-kotlinx-json:$ktor_version")
+
+                {{#kotlinx-datetime}}
+                api("org.jetbrains.kotlinx:kotlinx-datetime:0.4.1")
+                {{/kotlinx-datetime}}
+            }
+        }
+
+        commonTest {
+            dependencies {
+                implementation(kotlin("test"))
+                implementation("io.ktor:ktor-client-mock:$ktor_version")
+            }
+        }
+
+        jvmMain {
+            dependencies {
+                implementation(kotlin("stdlib-jdk7"))
+                implementation("io.ktor:ktor-client-cio-jvm:$ktor_version")
+            }
+        }
+
+        jvmTest {
+            dependencies {
+                implementation(kotlin("test-junit"))
+            }
+        }
+
+        iosMain {
+            dependencies {
+                api("io.ktor:ktor-client-ios:$ktor_version")
+            }
+        }
+
+        jsMain {
+            dependencies {
+                api("io.ktor:ktor-client-js:$ktor_version")
+            }
+        }
+
+        all {
+            languageSettings.apply {
+                optIn("kotlin.Experimental")
+            }
+        }
+    }
+}
+
+tasks {
+    register("iosTest") {
+        val device = project.findProperty("device")?.toString() ?: "iPhone 8"
+        dependsOn("linkDebugTestIosX64")
+        group = JavaBasePlugin.VERIFICATION_GROUP
+        description = "Execute unit tests on ${device} simulator"
+        doLast {
+            val binary = kotlin.targets.getByName<KotlinNativeTarget>("iosX64").binaries.getTest("DEBUG")
+            exec {
+                commandLine("xcrun", "simctl", "spawn", device, binary.outputFile)
+            }
+        }
+    }
+    register("test") {
+        dependsOn("allTests")
+    }
+}
+
+// OASg added for publication
+publishing {
+    repositories {
+        maven {
+            name = "Gitlab"
+            url = uri(project.property("repoUrl")!!)
+            credentials(HttpHeaderCredentials::class) {
+                name = "Job-Token"
+                value = System.getenv("CI_JOB_TOKEN")
+            }
+            authentication {
+                create<HttpHeaderAuthentication>("header")
+            }
+        }
+    }
+}

package/targets/kmp/templates/libraries/multiplatform/api.mustache

@@ -0,0 +1,136 @@
+{{>licenseInfo}}
+package {{apiPackage}}
+
+{{#imports}}import {{import}}
+{{/imports}}
+
+import {{packageName}}.infrastructure.*
+import io.ktor.client.HttpClient
+import io.ktor.client.HttpClientConfig
+import io.ktor.client.call.body
+import io.ktor.client.request.forms.formData
+import io.ktor.client.engine.HttpClientEngine
+import kotlinx.serialization.json.Json
+import io.ktor.http.ParametersBuilder
+import kotlinx.serialization.*
+import kotlinx.serialization.descriptors.*
+import kotlinx.serialization.encoding.*
+
+{{#operations}}
+{{#nonPublicApi}}internal {{/nonPublicApi}}open class {{classname}} : ApiClient {
+
+    constructor(
+        baseUrl: String = ApiClient.BASE_URL,
+        httpClientEngine: HttpClientEngine? = null,
+        httpClientConfig: ((HttpClientConfig<*>) -> Unit)? = null,
+        jsonSerializer: Json = ApiClient.JSON_DEFAULT
+    ) : super(baseUrl = baseUrl, httpClientEngine = httpClientEngine, httpClientConfig = httpClientConfig, jsonBlock = jsonSerializer)
+
+    constructor(
+        baseUrl: String,
+        httpClient: HttpClient
+    ): super(baseUrl = baseUrl, httpClient = httpClient)
+
+    {{#operation}}
+    {{#allParams}}
+    {{#isEnum}}
+
+    /**
+     * enum for parameter {{paramName}}
+     */
+    @Serializable
+    {{#nonPublicApi}}internal {{/nonPublicApi}}enum class {{enumName}}{{operationIdCamelCase}}(val value: {{^isContainer}}{{dataType}}{{/isContainer}}{{#isContainer}}kotlin.String{{/isContainer}}) {
+    {{^enumUnknownDefaultCase}}
+        {{#allowableValues}}{{#enumVars}}
+        @SerialName(value = {{^isString}}"{{/isString}}{{{value}}}{{^isString}}"{{/isString}})
+        {{&name}}({{{value}}}){{^-last}},{{/-last}}
+        {{/enumVars}}{{/allowableValues}}
+    {{/enumUnknownDefaultCase}}
+    {{#enumUnknownDefaultCase}}
+        {{#allowableValues}}{{#enumVars}}{{^-last}}
+        @SerialName(value = {{^isString}}"{{/isString}}{{{value}}}{{^isString}}"{{/isString}})
+        {{&name}}({{{value}}}),
+        {{/-last}}{{/enumVars}}{{/allowableValues}}
+    {{/enumUnknownDefaultCase}}
+    }
+
+    {{/isEnum}}
+    {{/allParams}}
+    /**
+     * {{summary}}
+     * {{notes}}
+    {{#allParams}} * @param {{{paramName}}} {{description}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}{{/required}}
+    {{/allParams}} * @return {{{returnType}}}{{^returnType}}void{{/returnType}}
+     */
+    {{#returnType}}
+    @Suppress("UNCHECKED_CAST")
+    {{/returnType}}
+    open suspend fun {{operationId}}({{#allParams}}{{{paramName}}}: {{#isEnum}}{{#isContainer}}kotlin.collections.List<{{enumName}}{{operationIdCamelCase}}>{{/isContainer}}{{^isContainer}}{{enumName}}{{operationIdCamelCase}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#required}}{{#defaultValue}} = {{^isNumber}}{{#isEnum}}{{enumName}}{{operationIdCamelCase}}.{{enumDefaultValue}}{{/isEnum}}{{^isEnum}}{{{defaultValue}}}{{/isEnum}}{{/isNumber}}{{#isNumber}}{{{defaultValue}}}.toDouble(){{/isNumber}}{{/defaultValue}}{{/required}}{{^required}}?{{#defaultValue}} = {{^isNumber}}{{#isEnum}}{{enumName}}{{operationIdCamelCase}}.{{enumDefaultValue}}{{/isEnum}}{{^isEnum}}{{{defaultValue}}}{{/isEnum}}{{/isNumber}}{{#isNumber}}{{{defaultValue}}}.toDouble(){{/isNumber}}{{/defaultValue}}{{^defaultValue}} = null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}): {{{returnType}}}{{^returnType}}Unit{{/returnType}} {
+
+        val localVariableAuthNames = listOf<String>({{#authMethods}}"{{name}}"{{^-last}}, {{/-last}}{{/authMethods}})
+
+        val localVariableBody = {{#hasBodyParam}}{{#bodyParam}}{{#isArray}}{{operationIdCamelCase}}Request({{{paramName}}}{{^isList}}.asList(){{/isList}}){{/isArray}}{{^isArray}}{{#isMap}}{{operationIdCamelCase}}Request({{{paramName}}}){{/isMap}}{{^isMap}}{{{paramName}}}{{/isMap}}{{/isArray}}{{/bodyParam}}{{/hasBodyParam}}
+            {{^hasBodyParam}}
+            {{#hasFormParams}}
+            {{#isMultipart}}
+            formData {
+                {{#formParams}}
+                {{#isArray}}
+                {{{paramName}}}?.onEach {
+                    append("{{{baseName}}}[]", it)
+                }
+                {{/isArray}}
+                {{^isArray}}
+                {{{paramName}}}?.apply { append("{{{baseName}}}", {{{paramName}}}) }
+                {{/isArray}}
+                {{/formParams}}
+            }
+            {{/isMultipart}}
+            {{^isMultipart}}
+            ParametersBuilder().also {
+                {{#formParams}}
+                {{{paramName}}}?.apply { it.append("{{{baseName}}}", {{{paramName}}}.toString()) }
+                {{/formParams}}
+            }.build()
+            {{/isMultipart}}
+            {{/hasFormParams}}
+            {{^hasFormParams}}
+            io.ktor.client.utils.EmptyContent
+            {{/hasFormParams}}
+            {{/hasBodyParam}}
+
+        val localVariableQuery = mutableMapOf<String, List<String>>(){{#queryParams}}
+        {{{paramName}}}?.apply { localVariableQuery["{{baseName}}"] = {{#isContainer}}toMultiValue(this, "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf("${{{paramName}}}"){{/isContainer}} }{{/queryParams}}
+        val localVariableHeaders = mutableMapOf<String, String>(){{#headerParams}}
+        {{{paramName}}}?.apply { localVariableHeaders["{{baseName}}"] = {{#isContainer}}this.joinToString(separator = collectionDelimiter("{{collectionFormat}}")){{/isContainer}}{{^isContainer}}this.toString(){{/isContainer}} }{{/headerParams}}
+
+        val localVariableConfig = RequestConfig<kotlin.Any?>(
+            RequestMethod.{{httpMethod}},
+            "{{path}}"{{#pathParams}}.replace("{" + "{{baseName}}" + "}", {{#isContainer}}{{paramName}}.joinToString(","){{/isContainer}}{{^isContainer}}"${{{paramName}}}"{{/isContainer}}){{/pathParams}},
+            query = localVariableQuery,
+            headers = localVariableHeaders,
+            requiresAuthentication = {{#hasAuthMethods}}true{{/hasAuthMethods}}{{^hasAuthMethods}}false{{/hasAuthMethods}},
+        )
+
+        return {{#hasBodyParam}}jsonRequest{{/hasBodyParam}}{{^hasBodyParam}}{{#hasFormParams}}{{#isMultipart}}multipartFormRequest{{/isMultipart}}{{^isMultipart}}urlEncodedFormRequest{{/isMultipart}}{{/hasFormParams}}{{^hasFormParams}}request{{/hasFormParams}}{{/hasBodyParam}}(
+            localVariableConfig,
+            localVariableBody,
+            localVariableAuthNames
+        ).body()
+    }
+
+{{#hasBodyParam}}
+{{#bodyParam}}
+{{#isArray}}{{>serial_wrapper_request_list}}{{/isArray}}{{#isMap}}{{>serial_wrapper_request_map}}{{/isMap}}
+{{/bodyParam}}
+{{/hasBodyParam}}
+{{#isArray}}
+{{>serial_wrapper_response_list}}
+{{/isArray}}
+{{#isMap}}
+{{>serial_wrapper_response_map}}
+{{/isMap}}
+
+    {{/operation}}
+}
+{{/operations}}