PE-2229 - rename to ClientConfig

lub0v-parsable · lub0v-parsable · commit 8dee0780e0d6 · 2021-08-26T13:38:40.000-07:00
diff --git a/src/templates/core/BaseHttpRequest.hbs b/src/templates/core/BaseHttpRequest.hbs
@@ -2,12 +2,12 @@
 
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
-import type { OpenAPIConfig } from './OpenAPI';
+import type { ClientConfig } from './OpenAPI';
 
 export interface BaseHttpRequest<T = any> {
     request<K = T>(
         options: ApiRequestOptions,
-        config: OpenAPIConfig,
-        mergeConfig?: OpenAPIConfig
+        config: ClientConfig,
+        mergeConfig?: ClientConfig
     ): Promise<ApiResult<K>>;
 }
diff --git a/src/templates/core/OpenAPI.hbs b/src/templates/core/OpenAPI.hbs
@@ -5,7 +5,7 @@ import type { ApiRequestOptions } from './ApiRequestOptions';
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
 type Headers = Record<string, string>;
 
-export type OpenAPIConfig = {
+export type ClientConfig = {
     baseUrl?: string;
     version?: string;
     withCredentials?: boolean;
@@ -15,7 +15,7 @@ export type OpenAPIConfig = {
     headers?: Headers | Resolver<Headers>;
 }
 {{#unless @root.exportClient}}
-export const OpenAPI: OpenAPIConfig = {
+export const OpenAPI: ClientConfig = {
     baseUrl: '{{{server}}}',
     version: '{{{version}}}',
     withCredentials: false,
diff --git a/src/templates/core/fetch/getHeaders.hbs b/src/templates/core/fetch/getHeaders.hbs
@@ -1,4 +1,4 @@
-async function getHeaders(options: ApiRequestOptions, config: OpenAPIConfig): Promise<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);
diff --git a/src/templates/core/fetch/request.hbs b/src/templates/core/fetch/request.hbs
@@ -3,7 +3,7 @@
 import { ApiError } from './ApiError';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
-import type { OpenAPIConfig } from './OpenAPI';
+import type { ClientConfig } from './OpenAPI';
 {{#if @root.exportClient}}
 import type { BaseHttpRequest } from './BaseHttpRequest';
 {{else}}
@@ -65,7 +65,7 @@ export class FetchHttpRequest implements BaseHttpRequest {
     * @returns ApiResult
     * @throws ApiError
     */
-    async request(options: ApiRequestOptions, config: OpenAPIConfig, mergeConfig?: OpenAPIConfig): Promise<ApiResult> {
+    async request(options: ApiRequestOptions, config: ClientConfig, mergeConfig?: ClientConfig): Promise<ApiResult> {
         const conf = mergeConfig ? deepAssign(config, mergeConfig) : config;
         const url = getUrl(options, conf);
         const response = await sendRequest(options, conf, url);
diff --git a/src/templates/core/fetch/sendRequest.hbs b/src/templates/core/fetch/sendRequest.hbs
@@ -1,4 +1,4 @@
-async function sendRequest(options: ApiRequestOptions, config: OpenAPIConfig, url: string): Promise<Response> {
+async function sendRequest(options: ApiRequestOptions, config: ClientConfig, url: string): Promise<Response> {
     const request: RequestInit = {
         method: options.method,
         headers: await getHeaders(options, config),
diff --git a/src/templates/core/functions/getUrl.hbs b/src/templates/core/functions/getUrl.hbs
@@ -1,4 +1,4 @@
-function getUrl(options: ApiRequestOptions, config: OpenAPIConfig): string {
+function getUrl(options: ApiRequestOptions, config: ClientConfig): string {
     const path = options.path.replace(/[:]/g, '_');
     const url = `${config.baseUrl}${path}`;
 
diff --git a/src/templates/core/index.hbs b/src/templates/core/index.hbs
@@ -6,7 +6,7 @@ export type { ApiResult } from './ApiResult';
 {{#if @root.exportClient}}
 export type { BaseHttpRequest } from './BaseHttpRequest';
 export { {{{httpRequestName}}} } from './{{{httpRequestName}}}';
-export type { OpenAPIConfig } from './OpenAPI';
+export type { ClientConfig } from './OpenAPI';
 {{else}}
 export { OpenAPI } from './OpenAPI';
 export { request } from './request';
diff --git a/src/templates/core/node/getHeaders.hbs b/src/templates/core/node/getHeaders.hbs
@@ -1,4 +1,4 @@
-async function getHeaders(options: ApiRequestOptions, config: OpenAPIConfig): Promise<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);
diff --git a/src/templates/core/node/request.hbs b/src/templates/core/node/request.hbs
@@ -7,7 +7,7 @@ import { types } from 'util';
 import { ApiError } from './ApiError';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
-import type { OpenAPIConfig } from './OpenAPI';
+import type { ClientConfig } from './OpenAPI';
 {{#if @root.exportClient}}
 import type { BaseHttpRequest } from './BaseHttpRequest';
 {{else}}
@@ -69,7 +69,7 @@ export class NodeHttpRequest implements BaseHttpRequest {
     * @returns ApiResult
     * @throws ApiError
     */
-    async request(options: ApiRequestOptions, config: OpenAPIConfig, mergeConfig?: OpenAPIConfig): Promise<ApiResult> {
+    async request(options: ApiRequestOptions, config: ClientConfig, mergeConfig?: ClientConfig): Promise<ApiResult> {
         const conf = mergeConfig ? deepAssign(config, mergeConfig) : config;
         const url = getUrl(options, conf);
         const response = await sendRequest(options, conf, url);
diff --git a/src/templates/core/node/sendRequest.hbs b/src/templates/core/node/sendRequest.hbs
@@ -1,4 +1,4 @@
-async function sendRequest(options: ApiRequestOptions, config: OpenAPIConfig, url: string): Promise<Response> {
+async function sendRequest(options: ApiRequestOptions, config: ClientConfig, url: string): Promise<Response> {
     const request: RequestInit = {
         method: options.method,
         headers: await getHeaders(options, config),
diff --git a/src/templates/core/xhr/getHeaders.hbs b/src/templates/core/xhr/getHeaders.hbs
@@ -1,4 +1,4 @@
-async function getHeaders(options: ApiRequestOptions, config: OpenAPIConfig): Promise<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);
diff --git a/src/templates/core/xhr/request.hbs b/src/templates/core/xhr/request.hbs
@@ -3,7 +3,7 @@
 import { ApiError } from './ApiError';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
-import type { OpenAPIConfig } from './OpenAPI';
+import type { ClientConfig } from './OpenAPI';
 {{#if @root.exportClient}}
 import type { BaseHttpRequest } from './BaseHttpRequest';
 {{else}}
@@ -69,7 +69,7 @@ export class XhrHttpRequest implements BaseHttpRequest {
     * @returns ApiResult
     * @throws ApiError
     */
-    async request(options: ApiRequestOptions, config: OpenAPIConfig, mergeConfig?: OpenAPIConfig): Promise<ApiResult> {
+    async request(options: ApiRequestOptions, config: ClientConfig, mergeConfig?: ClientConfig): Promise<ApiResult> {
         const conf = mergeConfig ? deepAssign(config, mergeConfig) : config;
         const url = getUrl(options, conf);
         const response = await sendRequest(options, conf, url);
diff --git a/src/templates/core/xhr/sendRequest.hbs b/src/templates/core/xhr/sendRequest.hbs
@@ -1,4 +1,4 @@
-async function sendRequest(options: ApiRequestOptions, config: OpenAPIConfig, url: string): Promise<XMLHttpRequest> {
+async function sendRequest(options: ApiRequestOptions, config: ClientConfig, url: string): Promise<XMLHttpRequest> {
 
     const xhr = new XMLHttpRequest();
     xhr.open(options.method, url, true);
diff --git a/src/templates/exportAppClient.hbs b/src/templates/exportAppClient.hbs
@@ -2,7 +2,7 @@
 
 import type { BaseHttpRequest } from './core';
 import { {{{httpClientRequest}}} } from './core';
-import type { OpenAPIConfig } from './core';
+import type { ClientConfig } from './core';
 {{#if services}}
 import {
 {{#each services}}
@@ -16,15 +16,15 @@ export class {{{clientName}}} {
     readonly {{{shortName}}}: {{{name}}};
 {{/each}}
 
-    constructor(openApiConfig: OpenAPIConfig, httpClient: BaseHttpRequest = new {{{httpClientRequest}}}()) {
+    constructor(ClientConfig: ClientConfig, httpClient: BaseHttpRequest = new {{{httpClientRequest}}}()) {
         const config = {
-            baseUrl: openApiConfig?.baseUrl ?? '{{{server}}}',
-            version: openApiConfig?.version ?? '{{{version}}}',
-            withCredentials: openApiConfig?.withCredentials ?? false,
-            token: openApiConfig?.token,
-            username: openApiConfig?.username,
-            password: openApiConfig?.password,
-            headers: openApiConfig?.headers,
+            baseUrl: ClientConfig?.baseUrl ?? '{{{server}}}',
+            version: ClientConfig?.version ?? '{{{version}}}',
+            withCredentials: ClientConfig?.withCredentials ?? false,
+            token: ClientConfig?.token,
+            username: ClientConfig?.username,
+            password: ClientConfig?.password,
+            headers: ClientConfig?.headers,
         }
         {{#each services}}
         this.{{{shortName}}} = new {{{name}}}(httpClient, config);
diff --git a/src/templates/partials/parameters.hbs b/src/templates/partials/parameters.hbs
@@ -11,12 +11,12 @@
 {{/if}}
 {{{name}}}{{>isRequired}}: {{>type}},
 {{/each}}
-}{{#if @root.exportClient}}, config?: OpenAPIConfig{{/if}}
+}{{#if @root.exportClient}}, config?: ClientConfig{{/if}}
 {{~else}}
 
 {{#each parameters}}
 {{{name}}}{{>isRequired}}: {{>type}}{{#if default}} = {{{default}}}{{/if}},
 {{/each}}
-{{#if @root.exportClient}}config?: OpenAPIConfig{{/if}}
+{{#if @root.exportClient}}config?: ClientConfig{{/if}}
 {{/if}}
-{{else}}{{#if @root.exportClient}}config?: OpenAPIConfig{{/if}}{{/if}}
+{{else}}{{#if @root.exportClient}}config?: ClientConfig{{/if}}{{/if}}
diff --git a/src/templates/services/exportService.hbs b/src/templates/services/exportService.hbs
@@ -8,7 +8,7 @@ import type {
 } from '../models';
 {{/if}}
 {{#if @root.exportClient}}
-import type { ApiResult, BaseHttpRequest, OpenAPIConfig } from '../core';
+import type { ApiResult, BaseHttpRequest, ClientConfig } from '../core';
 {{else}}
 import type { ApiResult } from '../core';
 import {
@@ -22,11 +22,11 @@ import {
 export class {{{name}}} {
     {{#if @root.exportClient}}
     private readonly httpRequest: BaseHttpRequest;
-    private readonly openApiConfig: OpenAPIConfig;
+    private readonly ClientConfig: ClientConfig;
 
-    constructor(httpRequest: BaseHttpRequest, openApiConfig: OpenAPIConfig) {
+    constructor(httpRequest: BaseHttpRequest, ClientConfig: ClientConfig) {
         this.httpRequest = httpRequest;
-        this.openApiConfig = openApiConfig;
+        this.ClientConfig = ClientConfig;
     }
     {{/if}}
 
@@ -102,7 +102,7 @@ export class {{{name}}} {
                 {{/each}}
             },
             {{/if}}
-        }{{#if @root.exportClient}}, this.openApiConfig, config{{/if}});
+        }{{#if @root.exportClient}}, this.ClientConfig, config{{/if}});
     }
 
     {{/each}}
diff --git a/src/utils/postProcessServiceOperations.ts b/src/utils/postProcessServiceOperations.ts
@@ -22,7 +22,7 @@ export function postProcessServiceOperations(service: Service, exportClient: boo
         names.set(name, index + 1);
 
         // Update the operation path with the dynamically injected version
-        clone.path = clone.path.replace('${apiVersion}', exportClient ? '${this.openApiConfig.version}' : '${OpenAPI.version}');
+        clone.path = clone.path.replace('${apiVersion}', exportClient ? '${this.ClientConfig.version}' : '${OpenAPI.version}');
 
         return clone;
     });
diff --git a/test/__snapshots__/index.client.spec.js.snap b/test/__snapshots__/index.client.spec.js.snap
diff --git a/test/__snapshots__/index.spec.js.snap b/test/__snapshots__/index.spec.js.snap

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-async function getHeaders(options: ApiRequestOptions, config: OpenAPIConfig): Promise<Headers> {`
	`1`	`+async function getHeaders(options: ApiRequestOptions, config: ClientConfig): Promise<Headers> {`
`2`	`2`	`const token = await resolve(options, config.token);`
`3`	`3`	`const username = await resolve(options, config.username);`
`4`	`4`	`const password = await resolve(options, config.password);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-async function sendRequest(options: ApiRequestOptions, config: OpenAPIConfig, url: string): Promise<Response> {`
	`1`	`+async function sendRequest(options: ApiRequestOptions, config: ClientConfig, url: string): Promise<Response> {`
`2`	`2`	`const request: RequestInit = {`
`3`	`3`	`method: options.method,`
`4`	`4`	`headers: await getHeaders(options, config),`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-function getUrl(options: ApiRequestOptions, config: OpenAPIConfig): string {`
	`1`	`+function getUrl(options: ApiRequestOptions, config: ClientConfig): string {`
`2`	`2`	`const path = options.path.replace(/[:]/g, '_');`
`3`	`3`	const url = `${config.baseUrl}${path}`;
`4`	`4`