feat!: reformated onError interceptor's error object to be consistent…

… with the one from callapi

.changeset/sweet-hornets-cover.md

@@ -0,0 +1,5 @@
+---
+"@zayne-labs/callapi": minor
+---
+
+reformated onError interceptor's error object to be consistent with the one from callapi

src/createFetchClient.ts

@@ -4,7 +4,7 @@ import type {
 	ExtraOptions,
 	FetchConfig,
 	GetCallApiResult,
-	ResultModeUnion,
+	ResultModeUnion
 } from "./types";
 import { isObject, isQueryString, isString } from "./utils/typeof";
 import {
@@ -236,8 +236,7 @@ export const createFetchClient = <
 
 					// == Also call the onError interceptor
 					options.onError?.({
-						error: null,
-						errorData,
+						error,
 						options,
 						request: requestInit,
 						response,
@@ -247,21 +246,22 @@ export const createFetchClient = <
 				return resolveErrorResult(error);
 			}
 
+			const errorResult = resolveErrorResult();
+
 			void (await Promise.all([
 				// == At this point only the request errors exist, so the request error interceptor is called
 				options.onRequestError?.({ error: error as Error, options, request: requestInit }),
 
 				// == Also call the onError interceptor
 				options.onError?.({
-					error: error as Error,
-					errorData: null,
+					error: (errorResult as { error: never }).error,
 					options,
 					request: requestInit,
 					response: null,
 				}),
 			]));
 
-			return resolveErrorResult();
+			return errorResult;
 
 			// == Removing the now unneeded AbortController from store
 		} finally {

src/types.ts

@@ -223,15 +223,13 @@ export type ResponseErrorContext<TErrorData> = Prettify<{
 
 export type ErrorContext<TErrorData> =
 	| {
-			error: Error;
-			errorData?: null;
+			error: Extract<ErrorObjectUnion, { name: PossibleErrorNames }>;
 			options: ExtraOptions;
 			request: $RequestOptions;
 			response: null;
 	  }
 	| {
-			error: null;
-			errorData?: TErrorData;
+			error: Extract<ErrorObjectUnion<TErrorData>, { name: "HTTPError" }>;
 			options: ExtraOptions;
 			request: $RequestOptions;
 			response: Response;
@@ -247,23 +245,27 @@ type PossibleErrorNames = {
 	_: "AbortError" | "Error" | "SyntaxError" | "TimeoutError" | "TypeError" | "UnknownError";
 }["_"];
 
+type ErrorObjectUnion<TErrorData = unknown> =
+	| {
+			errorData: Error;
+			message: string;
+			name: PossibleErrorNames;
+	  }
+	| {
+			errorData: TErrorData;
+			message: string;
+			name: "HTTPError";
+	  };
+
 export type ApiErrorVariant<TErrorData> =
 	| {
 			data: null;
-			error: {
-				errorData: Error;
-				message: string;
-				name: PossibleErrorNames;
-			};
+			error: Extract<ErrorObjectUnion, { name: PossibleErrorNames }>;
 			response: null;
 	  }
 	| {
 			data: null;
-			error: {
-				errorData: TErrorData;
-				message: string;
-				name: "HTTPError";
-			};
+			error: Extract<ErrorObjectUnion<TErrorData>, { name: "HTTPError" }>;
 			response: Response;
 	  };
 

src/utils/utils.ts

@@ -194,8 +194,8 @@ export const getResolveErrorResultFn = <CallApiResult>(initInfo: {
 }) => {
 	const { error, options } = initInfo;
 
-	const resolveErrorResult = (errorInfo: Partial<HTTPError<unknown>> = {}): CallApiResult => {
-		const { errorData, message, response } = errorInfo;
+	const resolveErrorResult = <TErrorData>(errorInfo?: Partial<HTTPError<TErrorData>>): CallApiResult => {
+		const { errorData, message, response } = errorInfo ?? {};
 
 		const shouldThrowOnError = isFunction(options.throwOnError)
 			? options.throwOnError(error as Error)

website/pages/advanced.mdx

@@ -143,9 +143,13 @@ const callAnotherApi = callApi.create({
 `onError` is invoked both on request and response errors.
 It is basically a combination of `onRequestError` and `onResponseError` in that it provides access to:
 
--  The `errorData` (if the error a response error from api, else it's set to null).
 -  The response object (f the error is a response error from api, else it's set to null).
--  The `error` object (if the error is a request error, else it's set to null).
+-  The `error` object which contains the following properties (just like the error object destructured from callApi itself):
+
+   1. `name`: A string indicating the type of error (e.g., 'TypeError', 'SyntaxError', 'HTTPError').
+   2. `message`: The error message describing what went wrong.
+   3. `errorData`: The error data, which can be an error response from the API or a standard JavaScript error object..
+
 -  The request details.
 -  And finally the fetch options used.