@tealca/core-components 1.0.13 → 1.0.14

package/dist/index.d.ts

@@ -1565,6 +1565,39 @@ declare interface TrackingTableProps {
     wrapperClassName?: string;
 }
 
+/**
+ * `api` is an instance of `axios` configured for interacting with the backend API.
+ *
+ * It has interceptors to standardize requests and responses.
+ *
+ * Request Interceptor:
+ * 1. Adds the `Authorization` header with the JWT token if available.
+ * 2. Converts the keys of the request `data` from camelCase to snake_case.
+ * 3. Converts the keys of the request `params` from camelCase to snake_case.
+ *
+ * Response Interceptor:
+ * 1. Converts the keys of the response `data` from snake_case to camelCase.
+ * 2. If a 401 Unauthorized error occurs, it attempts to refresh the token.
+ *    - If token refresh is successful, it retries the original request with the new token.
+ *    - If token refresh fails, it rejects the promise.
+ */
+export declare const useApi: (apiUri: string, basicApi: AxiosInstance) => AxiosInstance;
+
+/**
+ * `basicApi` is an instance of `axios` configured with a base URL and a response interceptor.
+ *
+ * The response interceptor automatically converts all snake_case keys in the API
+ * response data to camelCase. This ensures that the frontend application can work
+ * with a consistent camelCase naming convention, regardless of the API's naming
+ * style.
+ *
+ * If an API response contains data, the interceptor will recursively traverse the
+ * data object (or array of objects) and convert all keys. If there is no data,
+ * or if an error occurs, the original response or error is returned without
+ * modification.
+ */
+export declare const useBasicApi: (apiUri: string) => AxiosInstance;
+
 export declare interface User {
     userId: string;
     department?: Department;