tsdk/fe-sdk-template/src/axios.ts

Type-safe API development and code share tool for TypeScript projects.

import { AxiosRequestConfig, AxiosInstance } from 'axios';

import { NoHandlerError } from './error';
import { pathParams } from './path-params';
import { APIConfig, checkMethodHasBody } from './shared/tsdk-helper';

let axiosInstance: AxiosInstance;

/**
 * Set the AxiosInstance
 *
 * @param instance - AxiosInstance
 */
export const setAxiosInstance = (instance: AxiosInstance): void => {
  axiosInstance = instance;
};

/**
 * Get the AxiosInstance
 *
 * @param instance - AxiosInstance
 * @returns The AxiosInstance
 */
export const getAxiosInstance = () => {
  return axiosInstance;
};

export type RequestConfig<ReqPayload> = Omit<AxiosRequestConfig, 'data'> & {
  data?: ReqPayload;
};

export async function axiosHandler(
  apiConfig: APIConfig,
  requestData: any,
  requestConfig?: RequestConfig<any>
) {
  const instance = getAxiosInstance();
  if (!axiosInstance) {
    throw new NoHandlerError(`Call \`setAxiosInstance\` first`);
  }
  const { path, headers } = apiConfig;
  const method = apiConfig.method.toLowerCase();

  const payload: AxiosRequestConfig = {
    method: method === 'patch' ? method.toUpperCase() : method,
    url: path,
    ...requestConfig,
  };

  if (headers) {
    payload.headers = {
      ...payload.headers,
      ...headers,
    };
  }

  if (requestData) {
    const data = requestData;
    if (checkMethodHasBody(method)) {
      payload.data = data;
      if (requestConfig?.params) {
        payload.params = requestConfig.params;
      }
    } else {
      payload.params = requestConfig?.params ? { ...requestConfig.params, ...data } : data;
    }
  }
  if (requestData && (apiConfig as any).paramsInUrl) {
    payload.url = pathParams(path, requestData, (apiConfig as any).paramsInUrl);
  }

  const { data } = await instance.request(payload);
  return data;
}