@team-supercharge/oasg 16.0.1-master-453dcbac.0 → 16.2.0

package/README.md

@@ -111,7 +111,7 @@ The table below gives an overview of the changes (breaking, non-breaking, bug fi
 |------------------------------|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
 | **Internal**                 | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
 | _Core_                       |➖  |🐛  |💥  |✨  |🐛  |✨  |➖  |✨  |🐛  |🐛  |➖  |💥  |💥  |✨  |💥  |🆕  |
-| _Linter_                     |➖  |➖  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |🐛  |➖  |✨  |💥  |🆕  |
+| _Linter_                     |🐛  |➖  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |🐛  |➖  |✨  |💥  |🆕  |
 | **Client Targets**           | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
 | `android`                    |➖  |➖  |🐛  |💥  |➖  |➖  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
 | `angular`                    |➖  |➖  |🐛  |💥  |➖  |➖  |➖  |🐛  |➖  |➖  |➖  |💥  |➖  |➖  |➖  |🆕  |
@@ -121,8 +121,11 @@ The table below gives an overview of the changes (breaking, non-breaking, bug fi
 | `flutter`                    |➖  |➖  |➖  |🆕  |
 | `ios`                        |➖  |➖  |➖  |💥  |🐛  |➖  |➖  |➖  |✨  |➖  |💥  |➖  |➖  |✨  |🆕  |
 | `kmp`                        |➖  |➖  |🆕  |
+| `python`                     |🆕  |
 | `python-legacy`              |💥  |➖  |🐛  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
 | `react`                      |➖  |🐛  |➖  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
+| `typescript-axios`           |🆕  |
+| `typescript-fetch`           |🆕  |
 | **Server Targets**           | 16 | 15 | 14 | 13 | 12 | 11 | 10 | 9  | 8  | 7  | 6  | 5   | 4  | 3  | 2  | 1  |
 | `nestjs`                     |💥  |💥  |➖  |💥  |✨  |➖  |➖  |🐛  |➖  |➖  |✨  |🆕  |
 | `python-fastapi`             |➖  |➖  |🆕  |
@@ -527,6 +530,8 @@ We welcome feedback and contributions to help address this issue.
 | packageName | Name of the generated NPM package | Y | - |
 | repository | URL of the NPM package registry | Y | - |
 
+> ℹ️ This package offers React Hooks for convenience.
+
 #### `stubby`
 
 **When using Stubby, you must use the Supercharge's fork of the OpenApi Generator!**
@@ -720,6 +725,25 @@ 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`
+
+```json
+{
+  "id": "client-python",
+  "type": "python",
+  "source": "source-merged",
+  "packageName": "oasg_example",
+  "repositoryUrl": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/pypi"
+}
+```
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | Package nem for the project (convention: snake_case) | Y | - |
+| repositoryUrl | URL of the PyPI repository | Y | - |
+
+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.
+
 #### `python-legacy`
 
 ```json
@@ -996,6 +1020,39 @@ 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-merged",
+  "packageName": "@project/oasg-example-typescript-axios",
+  "repository": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/npm/"
+}
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | Name of the generated NPM package | Y | - |
+| repository | URL of the NPM package registry | Y | - |
+
+
+#### `typescript-fetch`
+
+```json
+{
+  "id": "client-typescript-fetch",
+  "type": "typescript-fetch",
+  "source": "source-merged",
+  "packageName": "@project/oasg-example-typescript-fetch",
+  "repository": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/npm/"
+}
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | Name of the generated NPM package | Y | - |
+| repository | URL of the NPM package registry | Y | - |
+
 ---
 
 # Migration Guide

package/bin/oasg

@@ -42,8 +42,11 @@ 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.11.0',  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' },
+  "typescript-fetch":             { version: '7.11.0',  generator: 'typescript-fetch' },
   // server targets
   "nestjs":                       { version: '7.0.1',   generator: 'typescript-angular' },
   "spring":                       { version: '7.0.1',   generator: 'spring' },

package/config.schema.yml

@@ -19,6 +19,7 @@ properties:
         - $ref: '#/targets/Stubby'
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
+        - $ref: '#/targets/Python'
         - $ref: '#/targets/PythonLegacy'
         - $ref: '#/targets/PythonFastApi'
         - $ref: '#/targets/PythonFastApiRawRequest'
@@ -29,6 +30,8 @@ properties:
         - $ref: '#/targets/Kmp'
         - $ref: '#/targets/Dotnet'
         - $ref: '#/targets/Postman'
+        - $ref: '#/targets/TypeScriptAxios'
+        - $ref: '#/targets/TypeScriptFetch'
 required:
   - targets
 additionalProperties: false
@@ -286,6 +289,20 @@ targets:
         - repository
         - interfaceType
 
+  Python:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^python$"
+          packageName:
+            type: string
+          repositoryUrl:
+            type: string
+        required:
+        - packageName
+        - repositoryUrl
+
   PythonLegacy:
     allOf:
       - $ref: '#/targets/Base'
@@ -430,6 +447,34 @@ targets:
           fileName:
             type: string
 
+  TypeScriptAxios:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^typescript-axios$"
+          packageName:
+            type: string
+          repository:
+            type: string
+        required:
+          - packageName
+          - repository
+
+  TypeScriptFetch:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^typescript-fetch$"
+          packageName:
+            type: string
+          repository:
+            type: string
+        required:
+          - packageName
+          - repository
+
 definitions:
   # default
   SourceOverrides:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "16.0.1-master-453dcbac.0",
+  "version": "16.2.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/python/generate.sh

@@ -0,0 +1,25 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+# if the version contains a `-` character, then use PEP 440 beta version syntax
+# example: 1.0.0-beta.1 -> 1.0.0b0+beta.1
+if [[ $version == *"-"* ]]; then
+  version=$(echo $version | sed 's/-/b0+/')
+  echo "[NOTE] version updated to: ${version}"
+fi
+
+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
+
+cd out/$targetId
+python3 setup.py sdist bdist_wheel
+cd ../../

package/targets/python/generator-config.json

@@ -0,0 +1,8 @@
+{
+  "library": "urllib3",
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
+}

package/targets/python/publish.sh

@@ -0,0 +1,7 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+python3 -m twine upload --repository-url $repositoryUrl dist/*
+cd ../..

package/targets/typescript-axios/generate.sh

@@ -0,0 +1,20 @@
+#/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

@@ -0,0 +1,20 @@
+{
+  "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

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

package/targets/typescript-fetch/generate.sh

@@ -0,0 +1,19 @@
+#/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-fetch/generator-config.json

@@ -0,0 +1,14 @@
+{
+  "typescriptThreePlus": "true",
+  "supportsES6": "true",
+  "modelPropertyNaming": "original",
+  "withInterfaces": "true",
+  "fileNaming": "PascalCase",
+  "stringEnums": "true",
+  "enumPropertyNaming": "UPPERCASE",
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
+}

package/targets/typescript-fetch/publish.sh

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