ferdikoomen · Aug 5, 2021 · Aug 5, 2021 · Aug 5, 2021 · Aug 5, 2021 · Aug 5, 2021
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,27 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "09:00"
+      timezone: "America/Los_Angeles"
+    ignore:
+      - dependency-name: "*"
+        update-types: [version-update:semver-major]
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "bot: update npm dependencies: "
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "09:00"
+      timezone: "America/Los_Angeles"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "[no-jira] bot: update github-actions image to "
+
diff --git a/.github/workflows/build-publish.yml b/.github/workflows/build-publish.yml
@@ -0,0 +1,57 @@
+name: build-publish
+permissions:
+  contents: write
+  id-token: write
+  packages: write
+
+on:
+  pull_request_target:
+    types:
+      - closed
+    branches:
+      - master
+
+jobs:
+  build-publish:
+    name: build publish artifact
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+    timeout-minutes: 20
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        ref: master
+        fetch-depth: 0
+    - name: Setup Node
+      uses: actions/setup-node@v4
+      with:
+        node-version: 16.x
+        registry-url: https://npm.pkg.github.com/
+        scope: '@parsable'
+        cache: yarn
+      env:
+        NODE_AUTH_TOKEN: ${{secrets.GH_PAT_CLASSIC_MACHINE_PARSABLE}}
+    - name: Install Dependencies
+      run: yarn install
+      env:
+        NODE_AUTH_TOKEN: ${{secrets.GH_PAT_CLASSIC_MACHINE_PARSABLE}}
+    - name: Tag
+      id: tag
+      run: |
+        truncated_version=1.0.4
+        git config --global user.email "ops+machine-parsable@parsable.com"
+        git config --global user.name "machine-parsable"
+        npm version -m "Updating package.json for version ${truncated_version}" ${truncated_version}
+        git pull --ff-only
+        git push origin $(git branch --show-current) --tags
+        git status
+        echo "new_tag=${truncated_version}" >> $GITHUB_OUTPUT
+    - name: Release
+      env:
+        GITHUB_TOKEN: ${{ secrets.GH_PARSABLE_BOT_BYPASS }}
+      run: gh release create "${{steps.version.outputs.version}}"
+    - name: publishing artifact
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,4 @@ test/e2e/generated
 samples/generated
 samples/swagger-codegen-cli-v2.jar
 samples/swagger-codegen-cli-v3.jar
+example
diff --git a/README.md b/README.md
@@ -47,6 +47,8 @@ $ openapi --help
     --exportServices <value>  Write services to disk (default: true)
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
+    --exportClient <value>    Generate and write client class to disk (default: false)
+    --name <value>            Custom client class name (default: "AppClient")
 
   Examples
     $ openapi --input ./spec.json
@@ -392,6 +394,29 @@ const getToken = async () => {
 OpenAPI.TOKEN = getToken;
 ```
 
+### Generate client instance with `--exportClient` option
+
+The OpenAPI generator allows to create client instances to support the multiple backend services use case.
+The generated client uses an instance of the server configuration and not the global `OpenAPI` constant.
+
+To generate a client instance, use `--exportClient` option. To set a custom name to the client class, use `--name` option.
+
+```
+openapi --input ./spec.json --output ./dist --exportClient true --name DemoAppClient
+```
+
+The generated client will be exported from the `index` file and can be used as shown below:
+```typescript
+// create the client instance with server and authentication details
+const appClient = new DemoAppClient({ BASE: 'http://server-host.com', TOKEN: '1234' });
+
+// use the client instance to make the API call
+const res: OrganizationResponse = await appClient.organizations.createOrganization({
+  name: 'OrgName',
+  description: 'OrgDescription',
+});
+```
+
 ### References
 
 Local references to schema definitions (those beginning with `#/definitions/schemas/`)

diff --git a/bin/index.js b/bin/index.js
@@ -19,7 +19,9 @@ const params = program
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
+    .option('--exportClient <value>', 'Generate and write client class to disk', false)
     .option('--request <value>', 'Path to custom request file')
+    .option('--name <value>', 'Custom client class name', 'AppClient')
     .parse(process.argv)
     .opts();
 
@@ -36,6 +38,8 @@ if (OpenAPI) {
         exportServices: JSON.parse(params.exportServices) === true,
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
+        exportClient: JSON.parse(params.exportClient) === true,
+        clientName: params.name,
         request: params.request,
     })
         .then(() => {

diff --git a/jest.config.js b/jest.config.js
@@ -5,10 +5,7 @@ module.exports = {
         {
             displayName: 'UNIT',
             testEnvironment: 'node',
-            testMatch: [
-                '<rootDir>/src/**/*.spec.ts',
-                '<rootDir>/test/index.spec.js',
-            ],
+            testMatch: ['<rootDir>/src/**/*.spec.ts', '<rootDir>/test/index.spec.js', '<rootDir>/test/index.client.spec.js'],
             moduleFileExtensions: ['js', 'ts', 'd.ts'],
             moduleNameMapper: {
                 '\\.hbs$': '<rootDir>/src/templates/__mocks__/index.js',
@@ -29,10 +26,5 @@ module.exports = {
             ],
         },
     ],
-    collectCoverageFrom: [
-        '<rootDir>/src/**/*.ts',
-        '!<rootDir>/src/**/*.d.ts',
-        '!<rootDir>/bin',
-        '!<rootDir>/dist',
-    ],
+    collectCoverageFrom: ['<rootDir>/src/**/*.ts', '!<rootDir>/src/**/*.d.ts', '!<rootDir>/bin', '!<rootDir>/dist'],
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-    "name": "openapi-typescript-codegen",
-    "version": "0.9.3",
+    "name": "@parsable/openapi-typescript-codegen",
+    "version": "0.0.4",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",

diff --git a/src/index.ts b/src/index.ts
@@ -20,7 +20,9 @@ export type Options = {
     exportServices?: boolean;
     exportModels?: boolean;
     exportSchemas?: boolean;
+    exportClient?: boolean;
     request?: string;
+    clientName?: string;
     write?: boolean;
 };
 
@@ -37,6 +39,8 @@ export type Options = {
  * @param exportServices: Generate services
  * @param exportModels: Generate models
  * @param exportSchemas: Generate schemas
+ * @param exportClient: Generate client class
+ * @param clientName: Custom client class name
  * @param request: Path to custom request file
  * @param write Write the files to disk (true or false)
  */
@@ -50,6 +54,8 @@ export async function generate({
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
+    exportClient = false,
+    clientName = 'AppClient',
     request,
     write = true,
 }: Options): Promise<void> {
@@ -64,17 +70,17 @@ export async function generate({
     switch (openApiVersion) {
         case OpenApiVersion.V2: {
             const client = parseV2(openApi);
-            const clientFinal = postProcessClient(client);
+            const clientFinal = postProcessClient(client, exportClient);
             if (!write) break;
-            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, request);
+            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, exportClient, clientName, request);
             break;
         }
 
         case OpenApiVersion.V3: {
             const client = parseV3(openApi);
-            const clientFinal = postProcessClient(client);
+            const clientFinal = postProcessClient(client, exportClient);
             if (!write) break;
-            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, request);
+            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, exportClient, clientName, request);
             break;
         }
     }

diff --git a/src/openApi/v2/parser/getOperationPath.spec.ts b/src/openApi/v2/parser/getOperationPath.spec.ts
@@ -2,8 +2,8 @@ import { getOperationPath } from './getOperationPath';
 
 describe('getOperationPath', () => {
     it('should produce correct result', () => {
-        expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}/${type}');
-        expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}');
+        expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${apiVersion}/list/${id}/${type}');
+        expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${apiVersion}/list/${id}');
         expect(getOperationPath('/api/v1/list/{id}')).toEqual('/api/v1/list/${id}');
         expect(getOperationPath('/api/{foobar}')).toEqual('/api/${foobar}');
         expect(getOperationPath('/api/{fooBar}')).toEqual('/api/${fooBar}');

diff --git a/src/openApi/v2/parser/getOperationPath.ts b/src/openApi/v2/parser/getOperationPath.ts
@@ -8,9 +8,7 @@ import { getOperationParameterName } from './getOperationParameterName';
  * @param path
  */
 export function getOperationPath(path: string): string {
-    return path
-        .replace(/\{(.*?)\}/g, (_, w: string) => {
-            return `\${${getOperationParameterName(w)}}`;
-        })
-        .replace('${apiVersion}', '${OpenAPI.VERSION}');
+    return path.replace(/\{(.*?)\}/g, (_, w: string) => {
+        return `\${${getOperationParameterName(w)}}`;
+    });
 }
diff --git a/src/openApi/v3/parser/getOperationPath.spec.ts b/src/openApi/v3/parser/getOperationPath.spec.ts
@@ -2,8 +2,8 @@ import { getOperationPath } from './getOperationPath';
 
 describe('getOperationPath', () => {
     it('should produce correct result', () => {
-        expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}/${type}');
-        expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}');
+        expect(getOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${apiVersion}/list/${id}/${type}');
+        expect(getOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${apiVersion}/list/${id}');
         expect(getOperationPath('/api/v1/list/{id}')).toEqual('/api/v1/list/${id}');
         expect(getOperationPath('/api/{foobar}')).toEqual('/api/${foobar}');
         expect(getOperationPath('/api/{fooBar}')).toEqual('/api/${fooBar}');

diff --git a/src/openApi/v3/parser/getOperationPath.ts b/src/openApi/v3/parser/getOperationPath.ts
@@ -8,9 +8,7 @@ import { getOperationParameterName } from './getOperationParameterName';
  * @param path
  */
 export function getOperationPath(path: string): string {
-    return path
-        .replace(/\{(.*?)\}/g, (_, w: string) => {
-            return `\${${getOperationParameterName(w)}}`;
-        })
-        .replace('${apiVersion}', '${OpenAPI.VERSION}');
+    return path.replace(/\{(.*?)\}/g, (_, w: string) => {
+        return `\${${getOperationParameterName(w)}}`;
+    });
 }
diff --git a/src/templates/core/ApiResult.hbs b/src/templates/core/ApiResult.hbs
@@ -1,9 +1,9 @@
 {{>header}}
 
-export type ApiResult = {
+export type ApiResult<T = any> = {
     readonly url: string;
     readonly ok: boolean;
     readonly status: number;
     readonly statusText: string;
-    readonly body: any;
+    readonly body: T;
 }
diff --git a/src/templates/core/BaseHttpRequest.hbs b/src/templates/core/BaseHttpRequest.hbs
@@ -0,0 +1,13 @@
+{{>header}}
+
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { ApiResult } from './ApiResult';
+import type { ClientConfig } from './OpenAPI';
+
+export interface BaseHttpRequest<T = any> {
+    request<K = T>(
+        options: ApiRequestOptions,
+        config: ClientConfig,
+        mergeConfig?: ClientConfig
+    ): Promise<ApiResult<K>>;
+}
diff --git a/src/templates/core/OpenAPI.hbs b/src/templates/core/OpenAPI.hbs
@@ -5,22 +5,23 @@ import type { ApiRequestOptions } from './ApiRequestOptions';
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
 type Headers = Record<string, string>;
 
-type Config = {
-    BASE: string;
-    VERSION: string;
-    WITH_CREDENTIALS: boolean;
-    TOKEN?: string | Resolver<string>;
-    USERNAME?: string | Resolver<string>;
-    PASSWORD?: string | Resolver<string>;
-    HEADERS?: Headers | Resolver<Headers>;
+export type ClientConfig = {
+    baseUrl?: string;
+    version?: string;
+    withCredentials?: boolean;
+    token?: string | Resolver<string>;
+    username?: string | Resolver<string>;
+    password?: string | Resolver<string>;
+    headers?: Headers | Resolver<Headers>;
 }
-
-export const OpenAPI: Config = {
-    BASE: '{{{server}}}',
-    VERSION: '{{{version}}}',
-    WITH_CREDENTIALS: false,
-    TOKEN: undefined,
-    USERNAME: undefined,
-    PASSWORD: undefined,
-    HEADERS: undefined,
+{{#unless @root.exportClient}}
+export const OpenAPI: ClientConfig = {
+    baseUrl: '{{{server}}}',
+    version: '{{{version}}}',
+    withCredentials: false,
+    token: undefined,
+    username: undefined,
+    password: undefined,
+    headers: undefined,
 };
+{{/unless}}
diff --git a/src/templates/core/fetch/getHeaders.hbs b/src/templates/core/fetch/getHeaders.hbs
@@ -1,8 +1,8 @@
-async function getHeaders(options: ApiRequestOptions): Promise<Headers> {
-    const token = await resolve(options, OpenAPI.TOKEN);
-    const username = await resolve(options, OpenAPI.USERNAME);
-    const password = await resolve(options, OpenAPI.PASSWORD);
-    const defaultHeaders = await resolve(options, OpenAPI.HEADERS);
+async function getHeaders(options: ApiRequestOptions, config: ClientConfig): Promise<Headers> {
+    const token = await resolve(options, config.token);
+    const username = await resolve(options, config.username);
+    const password = await resolve(options, config.password);
+    const defaultHeaders = await resolve(options, config.headers);
 
     const headers = new Headers({
         Accept: 'application/json',