feature: add v3-next client exports

Author: mfal

.github/workflows/update-client-dev.yml

@@ -40,9 +40,11 @@ jobs:
 
       - name: Update OpenAPI ⬇️
         run: |
-          yarn nx run @mittwald/api-client:build:fetch-openapi-dev
+          yarn nx run @mittwald/api-client:build:fetch-openapi-v2-dev
+          yarn nx run @mittwald/api-client:build:fetch-openapi-v3-next-dev
           if [ $(git status --porcelain . | wc -l) -gt 0 ] ; then
-            yarn nx run @mittwald/api-client:build:client-dev
+            yarn nx run @mittwald/api-client:build:client-v2-dev
+            yarn nx run @mittwald/api-client:build:client-v3-next-dev
             git add .
             yarn test
             git commit -m "chore: update generated development client";            

.github/workflows/update-client.yml

@@ -40,9 +40,11 @@ jobs:
       - name: Update OpenAPI ⬇️
         if: github.ref == 'refs/heads/master'
         run: |
-          yarn nx run @mittwald/api-client:build:fetch-openapi-prod
+          yarn nx run @mittwald/api-client:build:fetch-openapi-v2-prod
+          yarn nx run @mittwald/api-client:build:fetch-openapi-v3-next-prod
           if [ $(git status --porcelain . | wc -l) -gt 0 ] ; then
-            yarn nx run @mittwald/api-client:build:client-prod
+            yarn nx run @mittwald/api-client:build:client-v2-prod
+            yarn nx run @mittwald/api-client:build:client-v3-next-prod
             git add .
             yarn test
             git commit -m "feat: update generated client";            

nx.json

@@ -12,10 +12,22 @@
       "cache": true,
       "dependsOn": ["^build"]
     },
+    "build:client-v2-prod": {
+      "cache": true,
+      "dependsOn": ["^build"]
+    },
+    "build:client-v3-next-prod": {
+      "cache": true,
+      "dependsOn": ["^build"]
+    },
     "build:client-dev": {
       "cache": true,
       "dependsOn": ["^build"]
     },
+    "build:client-v2-dev": {
+      "cache": true,
+      "dependsOn": ["^build"]
+    },
     "build:write-version-file": {
       "cache": true,
       "dependsOn": ["build"]

packages/mittwald/README.md

@@ -14,6 +14,7 @@ see the [LICENSE](../../LICENSE) file for details.
 
 - [Installing](#installing)
 - [Usage](#usage)
+  - [Using the v3-next client](#using-the-v3-next-client)
   - [Setting request parameters](#setting-request-parameters)
     - [Path parameters](#path-parameters)
     - [Headers, query parameters and request body](#headers-query-parameters-and-request-body)
@@ -58,6 +59,34 @@ different types of authentication:
 Have a look at our [API introduction][api-getting-started] for more information
 on how to obtain an API token and how to get started with the API.
 
+### Using the v3-next client
+
+The default import path exposes the v2 client. To use the production
+`v3-next` client, import it from the `@mittwald/api-client/v3-next` subpath:
+
+```typescript
+import { MittwaldAPIClient } from "@mittwald/api-client/v3-next";
+
+const mittwaldApi = MittwaldAPIClient.newWithToken("your-access-token");
+```
+
+The React client is available from the matching React subpath:
+
+```typescript
+import { MittwaldAPIClientReact } from "@mittwald/api-client/v3-next/react";
+```
+
+TypeScript request and response types are exported through the
+`MittwaldAPIV3Next` namespace:
+
+```typescript
+import { MittwaldAPIV3Next } from "@mittwald/api-client/v3-next";
+```
+
+This uses the published, non-development `v3-next` client. The package does not
+expose a `@mittwald/api-client/v3-next-dev` import path; the `v3-next-dev`
+OpenAPI spec is only used for generating development builds.
+
 ### Setting request parameters
 
 API requests may require these type of parameters:

packages/mittwald/package.json

@@ -25,6 +25,22 @@
     "./react": {
       "types": "./dist/types/react.d.ts",
       "import": "./dist/esm/react.js"
+    },
+    "./v2": {
+      "types": "./dist/types/v2/index.d.ts",
+      "import": "./dist/esm/v2/index.js"
+    },
+    "./v2/react": {
+      "types": "./dist/types/v2/react.d.ts",
+      "import": "./dist/esm/v2/react.js"
+    },
+    "./v3-next": {
+      "types": "./dist/types/v3-next/index.d.ts",
+      "import": "./dist/esm/v3-next/index.js"
+    },
+    "./v3-next/react": {
+      "types": "./dist/types/v3-next/react.d.ts",
+      "import": "./dist/esm/v3-next/react.js"
     }
   },
   "files": [
@@ -33,11 +49,21 @@
   "scripts": {
     "build": "run build:clean && run tsc",
     "build:clean": "run rimraf dist",
-    "build:client-base": "run acg generate --name MittwaldAPIV2 /dev/stdin src/generated/v2 --optionalHeader x-access-token",
-    "build:client-dev": "bash -e -o pipefail -c 'spec/transform-openapi.sh < spec/openapi-dev.json | run build:client-base'",
-    "build:client-prod": "bash -e -o pipefail -c 'spec/transform-openapi.sh < spec/openapi.json | run build:client-base'",
-    "build:fetch-openapi-dev": "curl --location --fail --silent https://developer.mittwald.de/specs/openapi-v2-dev.json > spec/openapi-dev.json",
-    "build:fetch-openapi-prod": "curl --location --fail --silent 'https://api.mittwald.de/v2/openapi.json?withExperimental=true' > spec/openapi.json",
+    "build:client-base": "run build:client-v2-base",
+    "build:client-dev": "run build:client-v2-dev && run build:client-v3-next-dev",
+    "build:client-prod": "run build:client-v2-prod && run build:client-v3-next-prod",
+    "build:client-v2-base": "run acg generate --name MittwaldAPIV2 /dev/stdin src/generated/v2 --optionalHeader x-access-token",
+    "build:client-v2-dev": "bash -e -o pipefail -c 'spec/transform-openapi.sh < spec/openapi-dev.json | run build:client-v2-base'",
+    "build:client-v2-prod": "bash -e -o pipefail -c 'spec/transform-openapi.sh < spec/openapi.json | run build:client-v2-base'",
+    "build:client-v3-next-base": "run acg generate --name MittwaldAPIV3Next /dev/stdin src/generated/v3-next --optionalHeader x-access-token",
+    "build:client-v3-next-dev": "bash -e -o pipefail -c 'spec/transform-openapi.sh < spec/openapi-v3-next-dev.json | run build:client-v3-next-base'",
+    "build:client-v3-next-prod": "bash -e -o pipefail -c 'spec/transform-openapi.sh < spec/openapi-v3-next.json | run build:client-v3-next-base'",
+    "build:fetch-openapi-dev": "run build:fetch-openapi-v2-dev && run build:fetch-openapi-v3-next-dev",
+    "build:fetch-openapi-prod": "run build:fetch-openapi-v2-prod && run build:fetch-openapi-v3-next-prod",
+    "build:fetch-openapi-v2-dev": "curl --location --fail --silent https://developer.mittwald.de/specs/openapi-v2-dev.json > spec/openapi-dev.json",
+    "build:fetch-openapi-v2-prod": "curl --location --fail --silent 'https://api.mittwald.de/v2/openapi.json?withExperimental=true' > spec/openapi.json",
+    "build:fetch-openapi-v3-next-dev": "curl --location --fail --silent https://developer.mittwald.de/specs/openapi-v3-next-dev.json > spec/openapi-v3-next-dev.json",
+    "build:fetch-openapi-v3-next-prod": "curl --location --fail --silent 'https://api.mittwald.de/v3-next/openapi.json?withExperimental=true' > spec/openapi-v3-next.json",
     "build:write-version-file": "run tsx dev/writeVersion.ts",
     "format": "run prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
     "lint": "run eslint .",