@creopse/vue 0.0.47 → 0.0.48

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@creopse/vue",
   "description": "Creopse Vue Toolkit",
-  "version": "0.0.47",
+  "version": "0.0.48",
   "private": false,
   "author": "Noé Gnanih <noegnanih@gmail.com>",
   "license": "MIT",

package/types/composables/api.d.ts

@@ -1,23 +1,25 @@
-import type { ApiResponse, Payload } from '@/types/api';
+import type { Payload, Response } from '@/types/api';
+import type { AxiosError } from 'axios';
 /**
- * This composable is used to make API requests.
+ * A composable that provides a way to make API requests.
  *
- * @function useApi
- * @returns {Object} An object containing the following methods:
+ * The composable provides the following methods:
  *  - `request`: Makes an API request with the given payload.
- *  - `addItem`: Adds an item to the API.
- *  - `deleteItem`: Deletes an item from the API.
- *  - `updateItem`: Updates an item in the API.
- *  - `getAllItems`: Gets all items from the API.
- *  - `getItem`: Gets an item from the API.
+ *  - `getItemRequest`: Makes a GET request to the specified API endpoint with the given payload.
+ *  - `postItemRequest`: Makes a POST request to the specified API endpoint with the given payload.
+ *  - `putItemRequest`: Makes a PUT request to the specified API endpoint with the given payload.
+ *  - `deleteItemRequest`: Makes a DELETE request to the specified API endpoint with the given payload.
+ *  - `getAllItemsRequest`: Makes a GET request to the specified API endpoint with the given payload.
  *  - `handleError`: Handles an error from the API.
+ *
+ * @returns {Object} An object containing the methods listed above.
  */
 export declare const useApi: () => {
-    request: (payload: Payload, accessToken?: string, accessForbiddenCallback?: () => void) => Promise<any>;
-    getItem: (payload: Payload) => Promise<ApiResponse>;
-    addItem: (payload: Payload) => Promise<ApiResponse>;
-    updateItem: (payload: Payload) => Promise<ApiResponse>;
-    deleteItem: (payload: Payload) => Promise<ApiResponse>;
-    getAllItems: (payload: Payload) => Promise<ApiResponse>;
-    handleError: (error: any) => void;
+    request: <T = any>(payload: Payload, accessForbiddenCallback?: () => void) => Promise<Response<T>>;
+    getItemRequest: <T = any>(payload: Payload) => Promise<Response<T>>;
+    postItemRequest: <T = any>(payload: Payload) => Promise<Response<T>>;
+    putItemRequest: <T = any>(payload: Payload) => Promise<Response<T>>;
+    deleteItemRequest: <T = any>(payload: Payload) => Promise<Response<T>>;
+    getAllItemsRequest: <T = any>(payload: Payload) => Promise<Response<T>>;
+    handleError: (error: AxiosError) => void;
 };

package/types/composables/config.d.ts

@@ -10,12 +10,8 @@
 export declare const useConfig: () => {
     apiBaseUrl: string;
     apiUrl: string;
-    apiRequestHeaders: {
-        'X-API-Key': string;
-    };
     debug: boolean;
     appUrl: string;
-    xApiKey: string;
     locale: string;
     fallbackLocale: string;
     encryptionKey: string;

package/types/core/api.d.ts

@@ -0,0 +1,2 @@
+declare const api: import("axios").AxiosInstance;
+export default api;

package/types/types/api.d.ts

@@ -1,15 +1,22 @@
+import type { ResponseType } from 'axios';
 export type Method = 'get' | 'post' | 'put' | 'delete';
 export interface Payload {
     method?: Method;
     routeBase?: string;
-    params?: object;
-    data?: object;
+    responseType?: ResponseType;
+    params?: Record<string, any>;
+    data?: Record<string, any>;
     url?: string;
     id?: string;
+    headers?: Record<string, string>;
+    useApiBaseUrl?: boolean;
 }
-export interface ApiResponse {
+export interface Response<T> {
     success: boolean;
     failure: boolean;
-    result: any;
-    error: any;
+    result: {
+        [key: string]: any;
+        data?: T;
+    };
+    error?: any;
 }

package/types/types/plugin.d.ts

@@ -7,7 +7,6 @@ export type Props = SharedProps & PageProps & {
 export interface PluginConfig {
     debug: boolean;
     appUrl: string;
-    xApiKey: string;
     locale: string;
     fallbackLocale: string;
     encryptionKey: string;