feat(projects): @sa/axios: add response to flatRequest when success

packages/axios/src/index.ts

@@ -162,12 +162,12 @@ export function createFlatRequest<ResponseData = any, State = Record<string, unk
       if (responseType === 'json') {
         const data = opts.transformBackendResponse(response);
 
-        return { data, error: null };
+        return { data, error: null, response };
       }
 
       return { data: response.data as MappedType<R, T>, error: null };
     } catch (error) {
-      return { data: null, error };
+      return { data: null, error, response: (error as AxiosError<ResponseData>).response };
     }
   } as FlatRequestInstance<State, ResponseData>;
 

packages/axios/src/type.ts

@@ -69,7 +69,19 @@ export type CustomAxiosRequestConfig<R extends ResponseType = 'json'> = Omit<Axi
 };
 
 export interface RequestInstanceCommon<T> {
+  /**
+   * cancel the request by request id
+   *
+   * if the request provide abort controller sign from config, it will not collect in the abort controller map
+   *
+   * @param requestId
+   */
   cancelRequest: (requestId: string) => void;
+  /**
+   * cancel all request
+   *
+   * if the request provide abort controller sign from config, it will not collect in the abort controller map
+   */
   cancelAllRequest: () => void;
   /** you can set custom state in the request instance */
   state: T;
@@ -80,18 +92,20 @@ export interface RequestInstance<S = Record<string, unknown>> extends RequestIns
   <T = any, R extends ResponseType = 'json'>(config: CustomAxiosRequestConfig<R>): Promise<MappedType<R, T>>;
 }
 
-export type FlatResponseSuccessData<T = any> = {
+export type FlatResponseSuccessData<T = any, ResponseData = any> = {
   data: T;
   error: null;
+  response: AxiosResponse<ResponseData>;
 };
 
 export type FlatResponseFailData<ResponseData = any> = {
   data: null;
   error: AxiosError<ResponseData>;
+  response: AxiosResponse<ResponseData>;
 };
 
 export type FlatResponseData<T = any, ResponseData = any> =
-  | FlatResponseSuccessData<T>
+  | FlatResponseSuccessData<T, ResponseData>
   | FlatResponseFailData<ResponseData>;
 
 export interface FlatRequestInstance<S = Record<string, unknown>, ResponseData = any> extends RequestInstanceCommon<S> {