Skip to content

Add 'injected' HTTP client option #492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export enum HttpClient {
FETCH = 'fetch',
XHR = 'xhr',
NODE = 'node',
INJECTED = 'injected'
}

export type Options = {
Expand Down
6 changes: 3 additions & 3 deletions src/templates/core/fetch/request.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ import { OpenAPI } from './OpenAPI';
/**
* Request using fetch client
* @param options The request options from the the service
* @returns ApiResult
* @returns The response from the API
* @throws ApiError
*/
export async function request(options: ApiRequestOptions): Promise<ApiResult> {
export async function request(options: ApiRequestOptions): Promise<any> {
const url = getUrl(options);
const response = await sendRequest(options, url);
const responseBody = await getResponseBody(response);
Expand All @@ -68,5 +68,5 @@ export async function request(options: ApiRequestOptions): Promise<ApiResult> {
};

catchErrors(options, result);
return result;
return result.body;
}
6 changes: 3 additions & 3 deletions src/templates/core/node/request.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ import { OpenAPI } from './OpenAPI';
/**
* Request using node-fetch client
* @param options The request options from the the service
* @returns ApiResult
* @returns The response from the API
* @throws ApiError
*/
export async function request(options: ApiRequestOptions): Promise<ApiResult> {
export async function request(options: ApiRequestOptions): Promise<any> {
const url = getUrl(options);
const response = await sendRequest(options, url);
const responseBody = await getResponseBody(response);
Expand All @@ -72,5 +72,5 @@ export async function request(options: ApiRequestOptions): Promise<ApiResult> {
};

catchErrors(options, result);
return result;
return result.body;
}
6 changes: 3 additions & 3 deletions src/templates/core/xhr/request.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ import { OpenAPI } from './OpenAPI';
/**
* Request using XHR client
* @param options The request options from the the service
* @returns ApiResult
* @returns The response from the API
* @throws ApiError
*/
export async function request(options: ApiRequestOptions): Promise<ApiResult> {
export async function request(options: ApiRequestOptions): Promise<any> {
const url = getUrl(options);
const response = await sendRequest(options, url);
const responseBody = getResponseBody(response);
Expand All @@ -71,5 +71,5 @@ export async function request(options: ApiRequestOptions): Promise<ApiResult> {
};

catchErrors(options, result);
return result;
return result.body;
}
8 changes: 4 additions & 4 deletions src/templates/exportService.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
import type { {{{this}}} } from '../models/{{{this}}}';
{{/each}}
{{/if}}
import { request as __request } from '../core/request';
import { ApiRequestOptions } from '../core/ApiRequestOptions';
{{#if @root.useVersion}}
import { OpenAPI } from '../core/OpenAPI';
{{/if}}

export class {{{name}}} {
constructor(private __request: (options: ApiRequestOptions) => Promise<any>) {}

{{#each operations}}
/**
Expand All @@ -35,8 +36,8 @@ export class {{{name}}} {
{{/each}}
* @throws ApiError
*/
public static async {{{name}}}({{>parameters}}): Promise<{{>result}}> {
const result = await __request({
public async {{{name}}}({{>parameters}}): Promise<{{>result}}> {
return await this.__request({
method: '{{{method}}}',
path: `{{{path}}}`,
{{#if parametersCookie}}
Expand Down Expand Up @@ -81,7 +82,6 @@ export class {{{name}}} {
},
{{/if}}
});
return result.body;
}

{{/each}}
Expand Down
18 changes: 18 additions & 0 deletions src/templates/index.hbs
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
{{>header}}
{{#if @root.exportServices}}
{{#if services}}
{{#notEquals @root.httpClient 'injected'}}

{{#each services}}
import { {{{name}}} as _{{{name}}} } from './services/{{{name}}}';
{{/each}}
import { request } from './core/request';
{{/notEquals}}
{{/if}}
{{/if}}
{{#if @root.exportCore}}

export { ApiError } from './core/ApiError';
Expand Down Expand Up @@ -31,8 +42,15 @@ export { ${{{name}}} } from './schemas/${{{name}}}';
{{#if @root.exportServices}}
{{#if services}}

{{#notEquals @root.httpClient 'injected'}}
{{#each services}}
export const {{{name}}} = new _{{{name}}}(request);
{{/each}}
{{/notEquals}}
{{~#equals @root.httpClient 'injected'}}
{{#each services}}
export { {{{name}}} } from './services/{{{name}}}';
{{/each}}
{{/equals~}}
{{/if}}
{{/if}}
2 changes: 1 addition & 1 deletion src/utils/writeClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ export async function writeClient(

if (exportCore || exportServices || exportSchemas || exportModels) {
await mkdir(outputPath);
await writeClientIndex(client, templates, outputPath, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas);
await writeClientIndex(client, templates, outputPath, httpClient, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas);
}
}
60 changes: 37 additions & 23 deletions src/utils/writeClientCore.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,34 @@ import { writeClientCore } from './writeClientCore';
jest.mock('./fileSystem');

describe('writeClientCore', () => {
it('should write to filesystem', async () => {
const client: Client = {
server: 'http://localhost:8080',
version: '1.0',
models: [],
services: [],
};

const templates: Templates = {
index: () => 'index',
exports: {
model: () => 'model',
schema: () => 'schema',
service: () => 'service',
},
core: {
settings: () => 'settings',
apiError: () => 'apiError',
apiRequestOptions: () => 'apiRequestOptions',
apiResult: () => 'apiResult',
request: () => 'request',
},
};
const client: Client = {
server: 'http://localhost:8080',
version: '1.0',
models: [],
services: [],
};

const templates: Templates = {
index: () => 'index',
exports: {
model: () => 'model',
schema: () => 'schema',
service: () => 'service',
},
core: {
settings: () => 'settings',
apiError: () => 'apiError',
apiRequestOptions: () => 'apiRequestOptions',
apiResult: () => 'apiResult',
request: () => 'request',
},
};

afterEach(() => {
jest.clearAllMocks();
});

it('should write to filesystem', async () => {
await writeClientCore(client, templates, '/', HttpClient.FETCH);

expect(writeFile).toBeCalledWith('/OpenAPI.ts', 'settings');
Expand All @@ -39,4 +43,14 @@ describe('writeClientCore', () => {
expect(writeFile).toBeCalledWith('/ApiResult.ts', 'apiResult');
expect(writeFile).toBeCalledWith('/request.ts', 'request');
});

it('should not write request.ts if HTTP client is INJECTED', async () => {
await writeClientCore(client, templates, '/', HttpClient.INJECTED);

expect(writeFile).toBeCalledWith('/OpenAPI.ts', 'settings');
expect(writeFile).toBeCalledWith('/ApiError.ts', 'apiError');
expect(writeFile).toBeCalledWith('/ApiRequestOptions.ts', 'apiRequestOptions');
expect(writeFile).toBeCalledWith('/ApiResult.ts', 'apiResult');
expect(writeFile).not.toBeCalledWith('/request.ts', 'request');
});
});
5 changes: 4 additions & 1 deletion src/utils/writeClientCore.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,8 @@ export async function writeClientCore(client: Client, templates: Templates, outp
await writeFile(path.resolve(outputPath, 'ApiError.ts'), templates.core.apiError({}));
await writeFile(path.resolve(outputPath, 'ApiRequestOptions.ts'), templates.core.apiRequestOptions({}));
await writeFile(path.resolve(outputPath, 'ApiResult.ts'), templates.core.apiResult({}));
await writeFile(path.resolve(outputPath, 'request.ts'), templates.core.request(context));

if (httpClient !== HttpClient.INJECTED) {
await writeFile(path.resolve(outputPath, 'request.ts'), templates.core.request(context));
}
}
3 changes: 3 additions & 0 deletions src/utils/writeClientIndex.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as path from 'path';

import type { Client } from '../client/interfaces/Client';
import {HttpClient} from '..';
import { writeFile } from './fileSystem';
import { Templates } from './registerHandlebarTemplates';
import { sortModelsByName } from './sortModelsByName';
Expand All @@ -23,6 +24,7 @@ export async function writeClientIndex(
client: Client,
templates: Templates,
outputPath: string,
httpClient: HttpClient,
useUnionTypes: boolean,
exportCore: boolean,
exportServices: boolean,
Expand All @@ -36,6 +38,7 @@ export async function writeClientIndex(
exportServices,
exportModels,
exportSchemas,
httpClient,
useUnionTypes,
server: client.server,
version: client.version,
Expand Down
Loading