generated from Byndyusoft/node-typescript-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
39b1084
commit 117bf3c
Showing
12 changed files
with
559 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| MD013: false | ||
| MD033: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,17 @@ | ||
| # ᐸRepository nameᐳ | ||
| # nest-http-client | ||
|
|
||
| [](https://www.npmjs.com/package/@byndyusoft/typescript-template) | ||
| [](https://github.com/Byndyusoft/node-typescript-template/actions/workflows/test.yaml) | ||
| [](https://www.npmjs.com/package/@byndyusoft/nest-http-client) | ||
| [](https://github.com/Byndyusoft/nest-http-client/actions/workflows/test.yaml) | ||
| [](https://github.com/prettier/prettier) | ||
| [](https://github.com/semantic-release/semantic-release) | ||
|
|
||
| ᐸRepository descriptionᐳ | ||
| axios for NestJS | ||
|
|
||
| ## Comparison with `@nestjs/axios` | ||
|
|
||
| - [Promises instead of Observables](https://github.com/nestjs/axios/issues/271) | ||
| - `axios` dependency [is not pinning](https://github.com/nestjs/axios/pull/149#issuecomment-925764515), you must provide it by yourself (e.g. get it from `HttpService`) | ||
| - Allowing you use global `axios` with interceptors and different configs for various clients | ||
|
|
||
| ## Requirements | ||
|
|
||
|
|
@@ -15,25 +21,161 @@ | |
| ## Install | ||
|
|
||
| ```bash | ||
| npm install ᐸPackage nameᐳ | ||
| npm install @byndyusoft/nest-http-client @nestjs/common axios | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ```bash | ||
| yarn add ᐸPackage nameᐳ | ||
| yarn add @byndyusoft/nest-http-client @nestjs/common axios | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| <details> | ||
| <summary>1. Create module</summary> | ||
|
|
||
| ```typescript | ||
| // Usage example | ||
| import { | ||
| DynamicModuleHelper, | ||
| TRegisterAsyncOptions, | ||
| } from "@byndyusoft/nest-dynamic-module"; | ||
| import { | ||
| HttpClientModule, | ||
| IHttpClientOptions, | ||
| } from "@byndyusoft/nest-http-client"; | ||
| import { DynamicModule, Module } from "@nestjs/common"; | ||
| import urlJoin from "proper-url-join"; | ||
| import qs from "qs"; | ||
|
|
||
| import { ClientBaseOptionsToken, ClientOptionsToken } from "./tokens"; | ||
| import { UsersClient } from "./usersClient"; | ||
|
|
||
| @Module({ | ||
| imports: [ | ||
| HttpClientModule.registerAsync({ | ||
| inject: [ClientOptionsToken], | ||
| useFactory: (options: IHttpClientOptions) => options, | ||
| }), | ||
| ], | ||
| providers: [UsersClient], | ||
| exports: [UsersClient], | ||
| }) | ||
| export class ClientModule { | ||
| public static registerAsync( | ||
| options?: TRegisterAsyncOptions<IHttpClientOptions>, | ||
| ): DynamicModule { | ||
| return DynamicModuleHelper.registerAsync( | ||
| { | ||
| module: ClientModule, | ||
| global: true, | ||
| providers: [ | ||
| { | ||
| provide: ClientOptionsToken, | ||
| inject: [ClientBaseOptionsToken], | ||
| useFactory: (baseOptions: IHttpClientOptions) => | ||
| ClientModule.clientOptionsFactory(baseOptions), | ||
| }, | ||
| ], | ||
| exports: [ClientOptionsToken], | ||
| }, | ||
| ClientBaseOptionsToken, | ||
| options, | ||
| ); | ||
| } | ||
|
|
||
| private static clientOptionsFactory( | ||
| baseOptions: IHttpClientOptions, | ||
| ): IHttpClientOptions { | ||
| return { | ||
| ...baseOptions, | ||
| config: { | ||
| ...baseOptions.config, | ||
| baseURL: urlJoin(baseOptions.config?.baseURL as string, "/api/v1"), | ||
| paramsSerializer: (params) => | ||
| qs.stringify(params, { | ||
| skipNulls: true, | ||
| arrayFormat: "repeat", | ||
| }), | ||
| }, | ||
| }; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>2. Create client</summary> | ||
|
|
||
| ```typescript | ||
| import { HttpClient } from "@byndyusoft/nest-http-client"; | ||
| import { Injectable } from "@nestjs/common"; | ||
| import _ from "lodash"; | ||
| import { keys } from "ts-transformer-keys"; | ||
|
|
||
| import { | ||
| CreateUserDto, | ||
| ListUsersQueryDto, | ||
| ListUsersResponseDto, | ||
| ParamsWithUserIdDto, | ||
| QueryWithUserVersionDto, | ||
| UpdateUserDto, | ||
| UserDto, | ||
| } from "ᐸDtosᐳ"; | ||
|
|
||
| @Injectable() | ||
| export class UsersClient { | ||
| public constructor(private readonly httpClient: HttpClient) {} | ||
|
|
||
| public createUser(request: CreateUserDto): Promise<UserDto> { | ||
| return this.httpClient.post("/users", request); | ||
| } | ||
|
|
||
| public deleteUser( | ||
| request: ParamsWithUserIdDto & QueryWithUserVersionDto, | ||
| ): Promise<UserDto> { | ||
| return this.httpClient.delete( | ||
| `/users/${encodeURIComponent(request.userId)}`, | ||
| { | ||
| params: _.pick(request, keys<QueryWithUserVersionDto>()), | ||
| }, | ||
| ); | ||
| } | ||
|
|
||
| public getUserById(request: ParamsWithUserIdDto): Promise<UserDto> { | ||
| return this.httpClient.get(`/users/${encodeURIComponent(request.userId)}`); | ||
| } | ||
|
|
||
| public listUsers( | ||
| request?: Partial<ListUsersQueryDto>, | ||
| ): Promise<ListUsersResponseDto> { | ||
| return this.httpClient.get("/users", { | ||
| params: request, | ||
| }); | ||
| } | ||
|
|
||
| public updateUser( | ||
| request: ParamsWithUserIdDto & QueryWithUserVersionDto & UpdateUserDto, | ||
| ): Promise<UserDto> { | ||
| return this.httpClient.patch( | ||
| `/users/${encodeURIComponent(request.userId)}`, | ||
| _.pick(request, keys<UpdateUserDto>()), | ||
| { | ||
| params: _.pick(request, keys<QueryWithUserVersionDto>()), | ||
| }, | ||
| ); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| ## Maintainers | ||
|
|
||
| - [@Byndyusoft/owners](https://github.com/orgs/Byndyusoft/teams/owners) <<[email protected]>> | ||
| - [@Byndyusoft/team](https://github.com/orgs/Byndyusoft/teams/team) | ||
| - [@KillWolfVlad](https://github.com/KillWolfVlad) | ||
|
|
||
| ## License | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Copyright 2022 Byndyusoft | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| /* eslint-disable @typescript-eslint/explicit-module-boundary-types,@typescript-eslint/no-explicit-any */ | ||
|
|
||
| import { Injectable } from "@nestjs/common"; | ||
| import { AxiosRequestConfig } from "axios"; | ||
|
|
||
| import { HttpCoreClient } from "./httpCoreClient"; | ||
|
|
||
| @Injectable() | ||
| export class HttpClient { | ||
| public constructor(private readonly httpCoreClient: HttpCoreClient) {} | ||
|
|
||
| public async delete<T = any>( | ||
| url: string, | ||
| config?: AxiosRequestConfig, | ||
| ): Promise<T> { | ||
| const response = await this.httpCoreClient.delete<T>(url, config); | ||
|
|
||
| return response.data; | ||
| } | ||
|
|
||
| public async get<T = any>( | ||
| url: string, | ||
| config?: AxiosRequestConfig, | ||
| ): Promise<T> { | ||
| const response = await this.httpCoreClient.get<T>(url, config); | ||
|
|
||
| return response.data; | ||
| } | ||
|
|
||
| public async head<T = any>( | ||
| url: string, | ||
| config?: AxiosRequestConfig, | ||
| ): Promise<T> { | ||
| const response = await this.httpCoreClient.head<T>(url, config); | ||
|
|
||
| return response.data; | ||
| } | ||
|
|
||
| public async patch<T = any>( | ||
| url: string, | ||
| data?: any, | ||
| config?: AxiosRequestConfig, | ||
| ): Promise<T> { | ||
| const response = await this.httpCoreClient.patch<T>(url, data, config); | ||
|
|
||
| return response.data; | ||
| } | ||
|
|
||
| public async post<T = any>( | ||
| url: string, | ||
| data?: any, | ||
| config?: AxiosRequestConfig, | ||
| ): Promise<T> { | ||
| const response = await this.httpCoreClient.post<T>(url, data, config); | ||
|
|
||
| return response.data; | ||
| } | ||
|
|
||
| public async put<T = any>( | ||
| url: string, | ||
| data?: any, | ||
| config?: AxiosRequestConfig, | ||
| ): Promise<T> { | ||
| const response = await this.httpCoreClient.put<T>(url, data, config); | ||
|
|
||
| return response.data; | ||
| } | ||
|
|
||
| public async request<T = any>(config: AxiosRequestConfig): Promise<T> { | ||
| const response = await this.httpCoreClient.request<T>(config); | ||
|
|
||
| return response.data; | ||
| } | ||
| } |
Oops, something went wrong.