-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(types): Add support for typescript and add types to api module (#…
- Loading branch information
Showing
9 changed files
with
267 additions
and
201 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
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 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 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 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,104 @@ | ||
| import axios, { | ||
| AxiosError, | ||
| AxiosInstance, | ||
| AxiosInterceptorManager, | ||
| AxiosPromise, | ||
| AxiosRequestConfig, | ||
| AxiosResponse, | ||
| ResponseType, | ||
| } from 'axios'; | ||
| import pickBy from 'lodash/pickBy'; | ||
| import DownloadReachability from './DownloadReachability'; | ||
| import MetadataAPI from './metadataAPI'; | ||
|
|
||
| export type APIGetConfig = { type?: ResponseType } & AxiosRequestConfig; | ||
| export type APIError = { response: AxiosResponse } & Error; | ||
| export type APIPromise = Promise<AxiosPromise | SyntaxError>; | ||
|
|
||
| const filterOptions = (options: AxiosRequestConfig = {}): AxiosRequestConfig => { | ||
| return pickBy(options, (value: keyof AxiosRequestConfig) => value !== undefined && value !== null); | ||
| }; | ||
|
|
||
| const handleError = ({ response }: AxiosError): void => { | ||
| if (response) { | ||
| const error = new Error(response.statusText) as APIError; | ||
| error.response = response; // Need to pass response through so we can see what kind of HTTP error this was | ||
| throw error; | ||
| } | ||
| }; | ||
| const parseResponse = (response: AxiosResponse): AxiosResponse | AxiosResponse['data'] => { | ||
| if (response.status === 204 || response.status === 202) { | ||
| return response; | ||
| } | ||
|
|
||
| return response.data; | ||
| }; | ||
|
|
||
| const transformTextResponse = <D>(data: D): D => data; | ||
|
|
||
| export default class Api { | ||
| client: AxiosInstance; | ||
|
|
||
| interceptors: number[] = []; | ||
|
|
||
| metadata: MetadataAPI; | ||
|
|
||
| reachability: DownloadReachability; | ||
|
|
||
| constructor() { | ||
| this.client = axios.create(); | ||
| this.metadata = new MetadataAPI(this); | ||
| this.reachability = new DownloadReachability(this); | ||
| } | ||
|
|
||
| addResponseInterceptor(responseInterceptor: AxiosInterceptorManager<AxiosResponse>): void { | ||
| if (typeof responseInterceptor === 'function') { | ||
| this.interceptors.push(this.client.interceptors.response.use(responseInterceptor)); | ||
| } | ||
| } | ||
|
|
||
| addRequestInterceptor(requestInterceptor: AxiosInterceptorManager<AxiosRequestConfig>): void { | ||
| if (typeof requestInterceptor === 'function') { | ||
| this.interceptors.push(this.client.interceptors.request.use(requestInterceptor)); | ||
| } | ||
| } | ||
|
|
||
| ejectInterceptors(): void { | ||
| this.interceptors.forEach(interceptorIndex => { | ||
| this.client.interceptors.request.eject(interceptorIndex); | ||
| this.client.interceptors.response.eject(interceptorIndex); | ||
| }); | ||
| } | ||
|
|
||
| delete<D>(url: string, data: D, options: AxiosRequestConfig = {}): AxiosPromise { | ||
| return this.xhr(url, { method: 'delete', data, ...options }); | ||
| } | ||
|
|
||
| get(url: string, { type: responseType = 'json', ...options }: APIGetConfig = {}): AxiosPromise { | ||
| return this.xhr(url, { method: 'get', responseType, ...options }); | ||
| } | ||
|
|
||
| head(url: string, options: AxiosRequestConfig = {}): AxiosPromise { | ||
| return this.xhr(url, { method: 'head', ...options }); | ||
| } | ||
|
|
||
| post<D>(url: string, data: D, options: AxiosRequestConfig = {}): AxiosPromise { | ||
| return this.xhr(url, { method: 'post', data, ...options }); | ||
| } | ||
|
|
||
| put<D>(url: string, data: D, options: AxiosRequestConfig = {}): AxiosPromise { | ||
| return this.xhr(url, { method: 'put', data, ...options }); | ||
| } | ||
|
|
||
| xhr(url: string, options: AxiosRequestConfig = {}): AxiosPromise { | ||
| let transformResponse; | ||
|
|
||
| if (options.responseType === 'text') { | ||
| transformResponse = transformTextResponse; | ||
| } | ||
|
|
||
| return this.client(url, filterOptions({ transformResponse, ...options })) | ||
| .then(parseResponse) | ||
| .catch(handleError); | ||
| } | ||
| } |
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,5 @@ | ||
| { | ||
| "extends": "@box/frontend/ts/tsconfig.json", | ||
| "include": ["./src/**/*"], | ||
| "exclude": ["node_modules", "dist"] | ||
| } |
Oops, something went wrong.