@ametie/vue-muza-use 0.1.0 → 0.2.0

package/README.md

@@ -218,6 +218,55 @@ const { abortAll } = useAbortController()
 
 ---
 
+## 🚨 Advanced Error Handling
+
+By default, the library attempts to normalize errors into a standard `ApiError` format. However, every backend is different. You can fully customize how errors are parsed globally.
+
+### Default Behavior
+If you don't provide a parser, we extract the message from `error.response.data.message` or `error.message`.
+
+### Custom Error Parser
+Inject your own logic to transform your backend's specific error format into our uniform structure.
+
+```typescript
+// main.ts
+app.use(createApi({
+  axios: api,
+  // 👇 Define how to parse errors from your specific API
+  errorParser: (error: any) => {
+    const data = error.response?.data
+    
+    // Example: Laravel/Rails style validation errors
+    if (data?.errors) {
+       return {
+          message: 'Validation Failed',
+          status: error.response.status,
+          code: 'VALIDATION_ERROR',
+          errors: data.errors // { email: ['Invalid email'] }
+       }
+    }
+
+    // Example: Custom wrap format { success: false, error: { msg: "..." } }
+    if (data?.error?.msg) {
+        return {
+            message: data.error.msg,
+            status: error.response.status,
+            code: data.error.code
+        }
+    }
+
+    // Fallback to default behavior
+    return {
+       message: error.message || 'Unknown error',
+       status: error.response?.status || 500,
+       details: error
+    }
+  }
+}))
+```
+
+---
+
 ## 📚 API Reference
 
 ### `useApi<T, D>(url, options)`
@@ -298,6 +347,3 @@ This happens transparently to your components. They just "wait" a bit longer for
 
 ---
 
-## License
-
-MIT © [Ametie](https://github.com/ametie)

package/dist/index.cjs

@@ -182,7 +182,7 @@ function useAbortController() {
 
 // src/useApi.ts
 function useApi(url, options = {}) {
-  const { axios: axios2, onError: globalErrorHandler, globalOptions } = useApiConfig();
+  const { axios: axios2, onError: globalErrorHandler, globalOptions, errorParser } = useApiConfig();
   const {
     method = "GET",
     immediate = false,
@@ -247,7 +247,7 @@ function useApi(url, options = {}) {
         wasCancelled = true;
         return null;
       }
-      const apiError = parseApiError(err);
+      const apiError = errorParser ? errorParser(err) : parseApiError(err);
       if (!skipErrorNotification && globalErrorHandler) {
         globalErrorHandler(apiError, err);
       }

package/dist/index.d.cts

@@ -48,6 +48,11 @@ interface UseApiReturn<T = unknown, D = unknown> {
 interface ApiPluginOptions {
     axios: AxiosInstance;
     onError?: (error: ApiError, originalError: any) => void;
+    /**
+     * Custom error parser to transform backend errors into ApiError format.
+     * Useful if your backend has a different error structure.
+     */
+    errorParser?: (error: unknown) => ApiError;
     globalOptions?: {
         retry?: number | boolean;
         retryDelay?: number;

package/dist/index.d.ts

@@ -48,6 +48,11 @@ interface UseApiReturn<T = unknown, D = unknown> {
 interface ApiPluginOptions {
     axios: AxiosInstance;
     onError?: (error: ApiError, originalError: any) => void;
+    /**
+     * Custom error parser to transform backend errors into ApiError format.
+     * Useful if your backend has a different error structure.
+     */
+    errorParser?: (error: unknown) => ApiError;
     globalOptions?: {
         retry?: number | boolean;
         retryDelay?: number;

package/dist/index.mjs

@@ -132,7 +132,7 @@ function useAbortController() {
 
 // src/useApi.ts
 function useApi(url, options = {}) {
-  const { axios: axios2, onError: globalErrorHandler, globalOptions } = useApiConfig();
+  const { axios: axios2, onError: globalErrorHandler, globalOptions, errorParser } = useApiConfig();
   const {
     method = "GET",
     immediate = false,
@@ -197,7 +197,7 @@ function useApi(url, options = {}) {
         wasCancelled = true;
         return null;
       }
-      const apiError = parseApiError(err);
+      const apiError = errorParser ? errorParser(err) : parseApiError(err);
       if (!skipErrorNotification && globalErrorHandler) {
         globalErrorHandler(apiError, err);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ametie/vue-muza-use",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Powerful Vue 3 API composable (Muza Kit) with Axios, Auto-Refresh & TypeScript",
   "author": "MortyQ",
   "license": "MIT",
@@ -22,7 +22,9 @@
     "request",
     "auth",
     "refresh",
-    "muza"
+    "muza",
+    "rest",
+    "crud"
   ],
   "type": "module",
   "types": "./dist/index.d.ts",