aspi 1.1.0-beta.1 → 1.2.1

package/dist/index.cjs

@@ -20,13 +20,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  Aspi: () => Aspi,
+  Aspi: () => Aspi2,
   AspiError: () => AspiError,
   CustomError: () => CustomError,
   Request: () => Request,
   Result: () => result_exports,
   getHttpErrorStatus: () => getHttpErrorStatus,
-  httpErrors: () => httpErrors
+  httpErrors: () => httpErrors,
+  isAspiError: () => isAspiError,
+  isCustomError: () => isCustomError
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -100,6 +102,12 @@ var CustomError = class extends Error {
     this.data = data;
   }
 };
+var isAspiError = (error) => {
+  return error instanceof AspiError;
+};
+var isCustomError = (error) => {
+  return error instanceof CustomError;
+};
 
 // src/result.ts
 var result_exports = {};
@@ -306,17 +314,20 @@ var Request = class {
   #retryConfig;
   #shouldBeResult = false;
   #bodySchemaIssues = [];
+  #throwOnError = false;
   constructor(method, path, {
     requestConfig,
     retryConfig,
     middlewares,
-    errorCbs
+    errorCbs,
+    throwOnError
   }) {
     this.#path = path;
     this.#middlewares = middlewares || [];
     this.#localRequestInit = { ...requestConfig, method };
     this.#retryConfig = retryConfig;
     this.#customErrorCbs = errorCbs || {};
+    this.#throwOnError = throwOnError || false;
   }
   /**
    * Sets the base URL for the request.
@@ -646,6 +657,22 @@ var Request = class {
     this.#schema = schema;
     return this;
   }
+  /**
+   * Sets the request to throw an error if the response status is not successful.
+   * @returns The request instance for chaining
+   * @example
+   * const request = new Request('/users', config);
+   * const result = await request
+   *   .withResult()
+   *   .throwable()
+   *   .json();
+   *
+   */
+  throwable() {
+    this.#shouldBeResult = false;
+    this.#throwOnError = true;
+    return this;
+  }
   /**
    * Executes the request and returns the JSON response.
    * @returns A Promise containing the Result type with either successful data or error information
@@ -653,7 +680,8 @@ var Request = class {
    * const request = new Request('/users', config);
    * const result = await request
    *   .setQueryParams({ id: '123' })
-   *   .withResult()
+   *   .
+   withResult()
    *   .notFound((error) => ({ message: 'User not found' }))
    *   .json<User>();
    *
@@ -752,6 +780,7 @@ var Request = class {
    * }
    */
   withResult() {
+    this.#throwOnError = false;
     this.#shouldBeResult = true;
     return this;
   }
@@ -759,6 +788,9 @@ var Request = class {
     if (this.#shouldBeResult) {
       return value;
     }
+    if (this.#throwOnError) {
+      return getOrThrow(value);
+    }
     if (isOk(value)) {
       return [getOrNull(value), null];
     } else {
@@ -936,11 +968,12 @@ var Request = class {
 };
 
 // src/aspi.ts
-var Aspi = class {
+var Aspi2 = class {
   #globalRequestInit;
   #middlewares = [];
   #retryConfig;
   #customErrorCbs = {};
+  #throwOnError = false;
   constructor(config) {
     const { retryConfig, ...requestConfig } = config;
     this.#globalRequestInit = requestConfig;
@@ -987,7 +1020,8 @@ var Aspi = class {
       },
       retryConfig: this.#retryConfig,
       middlewares: this.#middlewares,
-      errorCbs: this.#customErrorCbs
+      errorCbs: this.#customErrorCbs,
+      throwOnError: this.#throwOnError
     });
   }
   /**
@@ -1243,6 +1277,21 @@ var Aspi = class {
   internalServerError(cb) {
     return this.error("internalServerErrorError", "INTERNAL_SERVER_ERROR", cb);
   }
+  /**
+   * Sets the aspi to throw an error if the response status is not successful.
+   * @returns The request instance for chaining
+   * @example
+   * const aspi = new Aspi({baseUrl: 'https://example.com'});
+   * const result = await aspi.get('/users')
+   *   .withResult()
+   *   .throwable()
+   *   .json();
+   *
+   */
+  throwable() {
+    this.#throwOnError = true;
+    return this;
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -1252,5 +1301,7 @@ var Aspi = class {
   Request,
   Result,
   getHttpErrorStatus,
-  httpErrors
+  httpErrors,
+  isAspiError,
+  isCustomError
 });

package/dist/index.d.cts

@@ -67,6 +67,10 @@ declare const getHttpErrorStatus: (status: HttpErrorCodes) => HttpErrorStatus;
  */
 type HttpMethods = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'TRACE' | 'CONNECT';
 
+type Prettify<Type> = Type extends Function ? Type : Extract<{
+    [Key in keyof Type]: Type[Key];
+}, Type>;
+type Merge<Object1, Object2> = Prettify<Omit<Object1, keyof Object2> & Object2>;
 type AspiConfigBase = {
     baseUrl: string;
     retryConfig?: AspiRetryConfig<AspiRequestInit>;
@@ -91,6 +95,7 @@ type RequestOptions<TRequest extends AspiRequestInit> = {
     retryConfig?: AspiRetryConfig<TRequest>;
     middlewares?: Middleware<TRequest, TRequest>[];
     errorCbs?: ErrorCallbacks;
+    throwOnError?: boolean;
 };
 type ErrorCallbacks = Record<number, {
     cb: (input: {
@@ -104,6 +109,7 @@ type AspiResultOk<TRequest extends AspiRequestInit, TData> = {
     request: AspiRequest<TRequest>;
     response: AspiResponse;
 };
+type AspiPlainResponse<TRequest extends AspiRequestInit, TData> = AspiResultOk<TRequest, TData>;
 
 /**
  * Response interface used in error handling
@@ -195,6 +201,8 @@ interface JSONParseError extends CustomError<'jsonParseError', {
     message: string;
 }> {
 }
+declare const isAspiError: <TReq extends AspiRequestInit>(error: unknown) => error is AspiError<TReq>;
+declare const isCustomError: <Tag extends string, A>(error: unknown) => error is CustomError<Tag, A>;
 
 type Ok<T> = {
     __tag: 'ok';
@@ -598,7 +606,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
     error: {};
 }> {
     #private;
-    constructor(method: HttpMethods, path: string, { requestConfig, retryConfig, middlewares, errorCbs, }: RequestOptions<TRequest>);
+    constructor(method: HttpMethods, path: string, { requestConfig, retryConfig, middlewares, errorCbs, throwOnError, }: RequestOptions<TRequest>);
     /**
      * Sets the base URL for the request.
      * @param url The base URL to set
@@ -690,9 +698,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   age: 30
      * });
      */
-    bodyJson<Body extends StandardSchemaV1.InferInput<Opts['bodySchema']>>(body: Body): Request<Method, TRequest, Omit<Opts, "body"> & {
+    bodyJson<Body extends StandardSchemaV1.InferInput<Opts['bodySchema']>>(body: Body): Request<Method, TRequest, Merge<Omit<Opts, "body">, {
         body: Body;
-    }>;
+    }>>;
     /**
      * Sets the raw request body (unsafe, use with caution).
      * @param body The body content to send with the request
@@ -707,9 +715,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      * // or with URLSearchParams
      * request.unsafeBody(new URLSearchParams({ key: 'value' }));
      */
-    unsafeBody(body: BodyInit): Request<Method, TRequest, Omit<Opts, "body"> & {
+    unsafeBody(body: BodyInit): Request<Method, TRequest, Merge<Omit<Opts, "body">, {
         body: BodyInit;
-    }>;
+    }>>;
     /**
      * Handles 404 Not Found errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -721,9 +729,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Custom not found message' };
      * });
      */
-    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in "notFoundError" | keyof Opts["error"]]: K extends "notFoundError" ? CustomError<"notFoundError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 429 Too Many Requests errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -735,9 +743,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Please try again later' };
      * });
      */
-    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "tooManyRequestsError"]: K extends "tooManyRequestsError" ? CustomError<"tooManyRequestsError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 400 Bad Request errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -749,9 +757,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Invalid request parameters' };
      * });
      */
-    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "badRequestError"]: K extends "badRequestError" ? CustomError<"badRequestError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 409 Conflict errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -763,9 +771,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Resource conflict detected' };
      * });
      */
-    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "conflictError"]: K extends "conflictError" ? CustomError<"conflictError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 401 Unauthorized errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -777,9 +785,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Please login first' };
      * });
      */
-    unauthorised<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    unauthorised<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "unauthorisedError"]: K extends "unauthorisedError" ? CustomError<"unauthorisedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 403 Forbidden errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -791,9 +799,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'You do not have permission' };
      * });
      */
-    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "forbiddenError"]: K extends "forbiddenError" ? CustomError<"forbiddenError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 501 Not Implemented errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -805,9 +813,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'This feature is not implemented yet' };
      * });
      */
-    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "notImplementedError"]: K extends "notImplementedError" ? CustomError<"notImplementedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 500 Internal Server Error errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -819,9 +827,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'An unexpected error occurred' };
      * });
      */
-    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "internalServerError"]: K extends "internalServerError" ? CustomError<"internalServerError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Sets a custom error handler for a specific HTTP status code.
      * @param tag A string identifier for the error type
@@ -847,9 +855,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   console.log(result.error.data.message); // 'Invalid input'
      * }
      */
-    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Merge<Omit<Opts, "error">, {
         error: { [K in Tag | keyof Opts["error"]]: K extends Tag ? CustomError<Tag, A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Sets query parameters for the request URL.
      * @param params An object containing query parameter key-value pairs
@@ -862,9 +870,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   sort: 'desc'
      * });
      */
-    setQueryParams<T extends Record<string, string> | string[][] | string | URLSearchParams>(params: T): Request<Method, TRequest, Omit<Opts, "queryParams"> & {
-        qyeryParams: T;
-    }>;
+    setQueryParams<T extends Record<string, string> | string[][] | string | URLSearchParams>(params: T): Request<Method, TRequest, Merge<Omit<Opts, "queryParams">, {
+        queryParams: T;
+    }>>;
     /**
      * Sets the output schema for validating the response data using Zod.
      * @param schema The Zod schema to validate the response
@@ -888,12 +896,27 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   const user = result.value; // Typed and validated user data
      * }
      */
-    schema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Omit<Opts, "schema"> & {
+    schema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Merge<Omit<Opts, "schema">, {
         schema: TSchema;
-        error: Opts["error"] & {
+        error: Merge<Opts["error"], {
             parseError: CustomError<"parseError", StandardSchemaV1.FailureResult["issues"]>;
-        };
-    }>;
+        }>;
+    }>>;
+    /**
+     * Sets the request to throw an error if the response status is not successful.
+     * @returns The request instance for chaining
+     * @example
+     * const request = new Request('/users', config);
+     * const result = await request
+     *   .withResult()
+     *   .throwable()
+     *   .json();
+     *
+     */
+    throwable(): Request<Method, TRequest, Merge<Omit<Opts, "withResult" | "throwable">, {
+        withResult: false;
+        throwable: true;
+    }>>;
     /**
      * Executes the request and returns the JSON response.
      * @returns A Promise containing the Result type with either successful data or error information
@@ -901,7 +924,8 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      * const request = new Request('/users', config);
      * const result = await request
      *   .setQueryParams({ id: '123' })
-     *   .withResult()
+     *   .
+     withResult()
      *   .notFound((error) => ({ message: 'User not found' }))
      *   .json<User>();
      *
@@ -913,7 +937,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      */
     json<T extends StandardSchemaV1.InferOutput<Opts['schema']>>(): Promise<Opts['withResult'] extends true ? Result<AspiResultOk<TRequest, T>, AspiError<TRequest> | (Opts extends {
         error: any;
-    } ? Opts['error'][keyof Opts['error']] : never) | JSONParseError> : [
+    } ? Opts['error'][keyof Opts['error']] : never) | JSONParseError> : Opts['throwable'] extends true ? AspiPlainResponse<TRequest, T> : [
         AspiResultOk<TRequest, T> | null,
         ((AspiError<TRequest> | (Opts extends {
             error: any;
@@ -938,7 +962,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      */
     text(): Promise<Opts['withResult'] extends true ? Result<AspiResultOk<TRequest, string>, AspiError<TRequest> | (Opts extends {
         error: any;
-    } ? Opts['error'][keyof Opts['error']] : never)> : [
+    } ? Opts['error'][keyof Opts['error']] : never)> : Opts['throwable'] extends true ? AspiPlainResponse<TRequest, string> : [
         AspiResultOk<TRequest, string> | null,
         ((AspiError<TRequest> | (Opts extends {
             error: any;
@@ -963,7 +987,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      */
     blob(): Promise<Opts['withResult'] extends true ? Result<AspiResultOk<TRequest, Blob>, AspiError<TRequest> | (Opts extends {
         error: any;
-    } ? Opts['error'][keyof Opts['error']] : never)> : [
+    } ? Opts['error'][keyof Opts['error']] : never)> : Opts['throwable'] extends true ? AspiPlainResponse<TRequest, Blob> : [
         AspiResultOk<TRequest, Blob> | null,
         ((AspiError<TRequest> | (Opts extends {
             error: any;
@@ -993,9 +1017,10 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   const user = result.value;
      * }
      */
-    withResult(): Request<Method, TRequest, Omit<Opts, "withResult"> & {
+    withResult(): Request<Method, TRequest, Merge<Omit<Opts, "withResult" | "throwable">, {
         withResult: true;
-    }>;
+        throwable: false;
+    }>>;
 }
 
 /**
@@ -1165,9 +1190,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Invalid input' };
      * });
      */
-    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in Tag | keyof Opts["error"]]: K extends Tag ? CustomError<Tag, A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 404 Not Found errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -1179,9 +1204,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Resource not found' };
      * });
      */
-    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "notFoundError" | keyof Opts["error"]]: K extends "notFoundError" ? CustomError<"notFoundError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 429 Too Many Requests errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -1193,9 +1218,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Please try again later' };
      * });
      */
-    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "tooManyRequestsError" | keyof Opts["error"]]: K extends "tooManyRequestsError" ? CustomError<"tooManyRequestsError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 409 Conflict errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -1207,9 +1232,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Resource conflict detected' };
      * });
      */
-    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "conflictError" | keyof Opts["error"]]: K extends "conflictError" ? CustomError<"conflictError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 400 Bad Request errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1217,9 +1242,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.badRequest((req, res) => ({ message: 'Invalid request parameters' }));
      */
-    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "badRequestError" | keyof Opts["error"]]: K extends "badRequestError" ? CustomError<"badRequestError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 401 Unauthorized errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1227,9 +1252,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.unauthorized((req, res) => ({ message: 'Authentication required' }));
      */
-    unauthorized<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    unauthorized<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in keyof Opts["error"] | "unauthorizedError"]: K extends "unauthorizedError" ? CustomError<"unauthorizedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 403 Forbidden errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1237,9 +1262,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.forbidden((req, res) => ({ message: 'Access denied' }));
      */
-    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "forbiddenError" | keyof Opts["error"]]: K extends "forbiddenError" ? CustomError<"forbiddenError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 501 Not Implemented errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1247,9 +1272,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.notImplemented((req, res) => ({ message: 'Feature not implemented' }));
      */
-    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "notImplementedError" | keyof Opts["error"]]: K extends "notImplementedError" ? CustomError<"notImplementedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 500 Internal Server errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1257,9 +1282,23 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.internalServerError((req, res) => ({ message: 'Server error occurred' }));
      */
-    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in keyof Opts["error"] | "internalServerErrorError"]: K extends "internalServerErrorError" ? CustomError<"internalServerErrorError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
+    /**
+     * Sets the aspi to throw an error if the response status is not successful.
+     * @returns The request instance for chaining
+     * @example
+     * const aspi = new Aspi({baseUrl: 'https://example.com'});
+     * const result = await aspi.get('/users')
+     *   .withResult()
+     *   .throwable()
+     *   .json();
+     *
+     */
+    throwable(): Aspi<TRequest, Prettify<Opts & {
+        throwable: true;
+    }>>;
 }
 
-export { Aspi, type AspiConfig, type AspiConfigBase, AspiError, type AspiRequest, type AspiRequestInit, type AspiResponse, type AspiResultOk, type AspiRetryConfig, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Middleware, Request, type RequestOptions, result as Result, getHttpErrorStatus, httpErrors };
+export { Aspi, type AspiConfig, type AspiConfigBase, AspiError, type AspiPlainResponse, type AspiRequest, type AspiRequestInit, type AspiResponse, type AspiResultOk, type AspiRetryConfig, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Merge, type Middleware, type Prettify, Request, type RequestOptions, result as Result, getHttpErrorStatus, httpErrors, isAspiError, isCustomError };

package/dist/index.d.ts

@@ -67,6 +67,10 @@ declare const getHttpErrorStatus: (status: HttpErrorCodes) => HttpErrorStatus;
  */
 type HttpMethods = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'TRACE' | 'CONNECT';
 
+type Prettify<Type> = Type extends Function ? Type : Extract<{
+    [Key in keyof Type]: Type[Key];
+}, Type>;
+type Merge<Object1, Object2> = Prettify<Omit<Object1, keyof Object2> & Object2>;
 type AspiConfigBase = {
     baseUrl: string;
     retryConfig?: AspiRetryConfig<AspiRequestInit>;
@@ -91,6 +95,7 @@ type RequestOptions<TRequest extends AspiRequestInit> = {
     retryConfig?: AspiRetryConfig<TRequest>;
     middlewares?: Middleware<TRequest, TRequest>[];
     errorCbs?: ErrorCallbacks;
+    throwOnError?: boolean;
 };
 type ErrorCallbacks = Record<number, {
     cb: (input: {
@@ -104,6 +109,7 @@ type AspiResultOk<TRequest extends AspiRequestInit, TData> = {
     request: AspiRequest<TRequest>;
     response: AspiResponse;
 };
+type AspiPlainResponse<TRequest extends AspiRequestInit, TData> = AspiResultOk<TRequest, TData>;
 
 /**
  * Response interface used in error handling
@@ -195,6 +201,8 @@ interface JSONParseError extends CustomError<'jsonParseError', {
     message: string;
 }> {
 }
+declare const isAspiError: <TReq extends AspiRequestInit>(error: unknown) => error is AspiError<TReq>;
+declare const isCustomError: <Tag extends string, A>(error: unknown) => error is CustomError<Tag, A>;
 
 type Ok<T> = {
     __tag: 'ok';
@@ -598,7 +606,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
     error: {};
 }> {
     #private;
-    constructor(method: HttpMethods, path: string, { requestConfig, retryConfig, middlewares, errorCbs, }: RequestOptions<TRequest>);
+    constructor(method: HttpMethods, path: string, { requestConfig, retryConfig, middlewares, errorCbs, throwOnError, }: RequestOptions<TRequest>);
     /**
      * Sets the base URL for the request.
      * @param url The base URL to set
@@ -690,9 +698,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   age: 30
      * });
      */
-    bodyJson<Body extends StandardSchemaV1.InferInput<Opts['bodySchema']>>(body: Body): Request<Method, TRequest, Omit<Opts, "body"> & {
+    bodyJson<Body extends StandardSchemaV1.InferInput<Opts['bodySchema']>>(body: Body): Request<Method, TRequest, Merge<Omit<Opts, "body">, {
         body: Body;
-    }>;
+    }>>;
     /**
      * Sets the raw request body (unsafe, use with caution).
      * @param body The body content to send with the request
@@ -707,9 +715,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      * // or with URLSearchParams
      * request.unsafeBody(new URLSearchParams({ key: 'value' }));
      */
-    unsafeBody(body: BodyInit): Request<Method, TRequest, Omit<Opts, "body"> & {
+    unsafeBody(body: BodyInit): Request<Method, TRequest, Merge<Omit<Opts, "body">, {
         body: BodyInit;
-    }>;
+    }>>;
     /**
      * Handles 404 Not Found errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -721,9 +729,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Custom not found message' };
      * });
      */
-    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in "notFoundError" | keyof Opts["error"]]: K extends "notFoundError" ? CustomError<"notFoundError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 429 Too Many Requests errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -735,9 +743,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Please try again later' };
      * });
      */
-    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "tooManyRequestsError"]: K extends "tooManyRequestsError" ? CustomError<"tooManyRequestsError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 400 Bad Request errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -749,9 +757,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Invalid request parameters' };
      * });
      */
-    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "badRequestError"]: K extends "badRequestError" ? CustomError<"badRequestError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 409 Conflict errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -763,9 +771,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Resource conflict detected' };
      * });
      */
-    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "conflictError"]: K extends "conflictError" ? CustomError<"conflictError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 401 Unauthorized errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -777,9 +785,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'Please login first' };
      * });
      */
-    unauthorised<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    unauthorised<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "unauthorisedError"]: K extends "unauthorisedError" ? CustomError<"unauthorisedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 403 Forbidden errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -791,9 +799,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'You do not have permission' };
      * });
      */
-    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "forbiddenError"]: K extends "forbiddenError" ? CustomError<"forbiddenError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 501 Not Implemented errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -805,9 +813,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'This feature is not implemented yet' };
      * });
      */
-    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "notImplementedError"]: K extends "notImplementedError" ? CustomError<"notImplementedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 500 Internal Server Error errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -819,9 +827,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   return { message: 'An unexpected error occurred' };
      * });
      */
-    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Prettify<Omit<Omit<Opts, "error">, "error"> & {
         error: { [K in keyof Opts["error"] | "internalServerError"]: K extends "internalServerError" ? CustomError<"internalServerError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Sets a custom error handler for a specific HTTP status code.
      * @param tag A string identifier for the error type
@@ -847,9 +855,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   console.log(result.error.data.message); // 'Invalid input'
      * }
      */
-    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Omit<Opts, "error"> & {
+    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Request<Method, TRequest, Merge<Omit<Opts, "error">, {
         error: { [K in Tag | keyof Opts["error"]]: K extends Tag ? CustomError<Tag, A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Sets query parameters for the request URL.
      * @param params An object containing query parameter key-value pairs
@@ -862,9 +870,9 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   sort: 'desc'
      * });
      */
-    setQueryParams<T extends Record<string, string> | string[][] | string | URLSearchParams>(params: T): Request<Method, TRequest, Omit<Opts, "queryParams"> & {
-        qyeryParams: T;
-    }>;
+    setQueryParams<T extends Record<string, string> | string[][] | string | URLSearchParams>(params: T): Request<Method, TRequest, Merge<Omit<Opts, "queryParams">, {
+        queryParams: T;
+    }>>;
     /**
      * Sets the output schema for validating the response data using Zod.
      * @param schema The Zod schema to validate the response
@@ -888,12 +896,27 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   const user = result.value; // Typed and validated user data
      * }
      */
-    schema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Omit<Opts, "schema"> & {
+    schema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Merge<Omit<Opts, "schema">, {
         schema: TSchema;
-        error: Opts["error"] & {
+        error: Merge<Opts["error"], {
             parseError: CustomError<"parseError", StandardSchemaV1.FailureResult["issues"]>;
-        };
-    }>;
+        }>;
+    }>>;
+    /**
+     * Sets the request to throw an error if the response status is not successful.
+     * @returns The request instance for chaining
+     * @example
+     * const request = new Request('/users', config);
+     * const result = await request
+     *   .withResult()
+     *   .throwable()
+     *   .json();
+     *
+     */
+    throwable(): Request<Method, TRequest, Merge<Omit<Opts, "withResult" | "throwable">, {
+        withResult: false;
+        throwable: true;
+    }>>;
     /**
      * Executes the request and returns the JSON response.
      * @returns A Promise containing the Result type with either successful data or error information
@@ -901,7 +924,8 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      * const request = new Request('/users', config);
      * const result = await request
      *   .setQueryParams({ id: '123' })
-     *   .withResult()
+     *   .
+     withResult()
      *   .notFound((error) => ({ message: 'User not found' }))
      *   .json<User>();
      *
@@ -913,7 +937,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      */
     json<T extends StandardSchemaV1.InferOutput<Opts['schema']>>(): Promise<Opts['withResult'] extends true ? Result<AspiResultOk<TRequest, T>, AspiError<TRequest> | (Opts extends {
         error: any;
-    } ? Opts['error'][keyof Opts['error']] : never) | JSONParseError> : [
+    } ? Opts['error'][keyof Opts['error']] : never) | JSONParseError> : Opts['throwable'] extends true ? AspiPlainResponse<TRequest, T> : [
         AspiResultOk<TRequest, T> | null,
         ((AspiError<TRequest> | (Opts extends {
             error: any;
@@ -938,7 +962,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      */
     text(): Promise<Opts['withResult'] extends true ? Result<AspiResultOk<TRequest, string>, AspiError<TRequest> | (Opts extends {
         error: any;
-    } ? Opts['error'][keyof Opts['error']] : never)> : [
+    } ? Opts['error'][keyof Opts['error']] : never)> : Opts['throwable'] extends true ? AspiPlainResponse<TRequest, string> : [
         AspiResultOk<TRequest, string> | null,
         ((AspiError<TRequest> | (Opts extends {
             error: any;
@@ -963,7 +987,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      */
     blob(): Promise<Opts['withResult'] extends true ? Result<AspiResultOk<TRequest, Blob>, AspiError<TRequest> | (Opts extends {
         error: any;
-    } ? Opts['error'][keyof Opts['error']] : never)> : [
+    } ? Opts['error'][keyof Opts['error']] : never)> : Opts['throwable'] extends true ? AspiPlainResponse<TRequest, Blob> : [
         AspiResultOk<TRequest, Blob> | null,
         ((AspiError<TRequest> | (Opts extends {
             error: any;
@@ -993,9 +1017,10 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
      *   const user = result.value;
      * }
      */
-    withResult(): Request<Method, TRequest, Omit<Opts, "withResult"> & {
+    withResult(): Request<Method, TRequest, Merge<Omit<Opts, "withResult" | "throwable">, {
         withResult: true;
-    }>;
+        throwable: false;
+    }>>;
 }
 
 /**
@@ -1165,9 +1190,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Invalid input' };
      * });
      */
-    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    error<Tag extends string, A extends {}>(tag: Tag, status: HttpErrorStatus, cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in Tag | keyof Opts["error"]]: K extends Tag ? CustomError<Tag, A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 404 Not Found errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -1179,9 +1204,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Resource not found' };
      * });
      */
-    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    notFound<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "notFoundError" | keyof Opts["error"]]: K extends "notFoundError" ? CustomError<"notFoundError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 429 Too Many Requests errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -1193,9 +1218,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Please try again later' };
      * });
      */
-    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    tooManyRequests<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "tooManyRequestsError" | keyof Opts["error"]]: K extends "tooManyRequestsError" ? CustomError<"tooManyRequestsError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Handles 409 Conflict errors with a custom callback.
      * @param cb The callback function to handle the error
@@ -1207,9 +1232,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      *   return { message: 'Resource conflict detected' };
      * });
      */
-    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    conflict<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "conflictError" | keyof Opts["error"]]: K extends "conflictError" ? CustomError<"conflictError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 400 Bad Request errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1217,9 +1242,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.badRequest((req, res) => ({ message: 'Invalid request parameters' }));
      */
-    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    badRequest<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "badRequestError" | keyof Opts["error"]]: K extends "badRequestError" ? CustomError<"badRequestError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 401 Unauthorized errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1227,9 +1252,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.unauthorized((req, res) => ({ message: 'Authentication required' }));
      */
-    unauthorized<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    unauthorized<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in keyof Opts["error"] | "unauthorizedError"]: K extends "unauthorizedError" ? CustomError<"unauthorizedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 403 Forbidden errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1237,9 +1262,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.forbidden((req, res) => ({ message: 'Access denied' }));
      */
-    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    forbidden<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "forbiddenError" | keyof Opts["error"]]: K extends "forbiddenError" ? CustomError<"forbiddenError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 501 Not Implemented errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1247,9 +1272,9 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.notImplemented((req, res) => ({ message: 'Feature not implemented' }));
      */
-    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    notImplemented<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in "notImplementedError" | keyof Opts["error"]]: K extends "notImplementedError" ? CustomError<"notImplementedError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
     /**
      * Registers a handler for 500 Internal Server errors
      * @param {CustomErrorCb<TRequest, A>} cb - The callback function to handle the error
@@ -1257,9 +1282,23 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
      * @example
      * api.internalServerError((req, res) => ({ message: 'Server error occurred' }));
      */
-    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Opts & {
+    internalServerError<A extends {}>(cb: CustomErrorCb<TRequest, A>): Aspi<TRequest, Prettify<Opts & {
         error: { [K in keyof Opts["error"] | "internalServerErrorError"]: K extends "internalServerErrorError" ? CustomError<"internalServerErrorError", A> : Opts["error"][K]; };
-    }>;
+    }>>;
+    /**
+     * Sets the aspi to throw an error if the response status is not successful.
+     * @returns The request instance for chaining
+     * @example
+     * const aspi = new Aspi({baseUrl: 'https://example.com'});
+     * const result = await aspi.get('/users')
+     *   .withResult()
+     *   .throwable()
+     *   .json();
+     *
+     */
+    throwable(): Aspi<TRequest, Prettify<Opts & {
+        throwable: true;
+    }>>;
 }
 
-export { Aspi, type AspiConfig, type AspiConfigBase, AspiError, type AspiRequest, type AspiRequestInit, type AspiResponse, type AspiResultOk, type AspiRetryConfig, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Middleware, Request, type RequestOptions, result as Result, getHttpErrorStatus, httpErrors };
+export { Aspi, type AspiConfig, type AspiConfigBase, AspiError, type AspiPlainResponse, type AspiRequest, type AspiRequestInit, type AspiResponse, type AspiResultOk, type AspiRetryConfig, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Merge, type Middleware, type Prettify, Request, type RequestOptions, result as Result, getHttpErrorStatus, httpErrors, isAspiError, isCustomError };

package/dist/index.js

@@ -74,6 +74,12 @@ var CustomError = class extends Error {
     this.data = data;
   }
 };
+var isAspiError = (error) => {
+  return error instanceof AspiError;
+};
+var isCustomError = (error) => {
+  return error instanceof CustomError;
+};
 
 // src/result.ts
 var result_exports = {};
@@ -280,17 +286,20 @@ var Request = class {
   #retryConfig;
   #shouldBeResult = false;
   #bodySchemaIssues = [];
+  #throwOnError = false;
   constructor(method, path, {
     requestConfig,
     retryConfig,
     middlewares,
-    errorCbs
+    errorCbs,
+    throwOnError
   }) {
     this.#path = path;
     this.#middlewares = middlewares || [];
     this.#localRequestInit = { ...requestConfig, method };
     this.#retryConfig = retryConfig;
     this.#customErrorCbs = errorCbs || {};
+    this.#throwOnError = throwOnError || false;
   }
   /**
    * Sets the base URL for the request.
@@ -620,6 +629,22 @@ var Request = class {
     this.#schema = schema;
     return this;
   }
+  /**
+   * Sets the request to throw an error if the response status is not successful.
+   * @returns The request instance for chaining
+   * @example
+   * const request = new Request('/users', config);
+   * const result = await request
+   *   .withResult()
+   *   .throwable()
+   *   .json();
+   *
+   */
+  throwable() {
+    this.#shouldBeResult = false;
+    this.#throwOnError = true;
+    return this;
+  }
   /**
    * Executes the request and returns the JSON response.
    * @returns A Promise containing the Result type with either successful data or error information
@@ -627,7 +652,8 @@ var Request = class {
    * const request = new Request('/users', config);
    * const result = await request
    *   .setQueryParams({ id: '123' })
-   *   .withResult()
+   *   .
+   withResult()
    *   .notFound((error) => ({ message: 'User not found' }))
    *   .json<User>();
    *
@@ -726,6 +752,7 @@ var Request = class {
    * }
    */
   withResult() {
+    this.#throwOnError = false;
     this.#shouldBeResult = true;
     return this;
   }
@@ -733,6 +760,9 @@ var Request = class {
     if (this.#shouldBeResult) {
       return value;
     }
+    if (this.#throwOnError) {
+      return getOrThrow(value);
+    }
     if (isOk(value)) {
       return [getOrNull(value), null];
     } else {
@@ -910,11 +940,12 @@ var Request = class {
 };
 
 // src/aspi.ts
-var Aspi = class {
+var Aspi2 = class {
   #globalRequestInit;
   #middlewares = [];
   #retryConfig;
   #customErrorCbs = {};
+  #throwOnError = false;
   constructor(config) {
     const { retryConfig, ...requestConfig } = config;
     this.#globalRequestInit = requestConfig;
@@ -961,7 +992,8 @@ var Aspi = class {
       },
       retryConfig: this.#retryConfig,
       middlewares: this.#middlewares,
-      errorCbs: this.#customErrorCbs
+      errorCbs: this.#customErrorCbs,
+      throwOnError: this.#throwOnError
     });
   }
   /**
@@ -1217,13 +1249,30 @@ var Aspi = class {
   internalServerError(cb) {
     return this.error("internalServerErrorError", "INTERNAL_SERVER_ERROR", cb);
   }
+  /**
+   * Sets the aspi to throw an error if the response status is not successful.
+   * @returns The request instance for chaining
+   * @example
+   * const aspi = new Aspi({baseUrl: 'https://example.com'});
+   * const result = await aspi.get('/users')
+   *   .withResult()
+   *   .throwable()
+   *   .json();
+   *
+   */
+  throwable() {
+    this.#throwOnError = true;
+    return this;
+  }
 };
 export {
-  Aspi,
+  Aspi2 as Aspi,
   AspiError,
   CustomError,
   Request,
   result_exports as Result,
   getHttpErrorStatus,
-  httpErrors
+  httpErrors,
+  isAspiError,
+  isCustomError
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "aspi",
   "description": "Rest API client for typescript projects with chain of responsibility design pattern.",
-  "version": "1.1.0-beta.1",
+  "version": "1.2.1",
   "module": "src/index.ts",
   "type": "module",
   "devDependencies": {