aspi 2.6.0 → 2.7.0

package/dist/index.cjs

@@ -30,7 +30,7 @@ __export(index_exports, {
   isAspiError: () => isAspiError,
   isCustomError: () => isCustomError,
   isJSONParseError: () => isJSONParseError,
-  isParseError: () => isParseError
+  isSchemaParseError: () => isSchemaParseError
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -110,12 +110,12 @@ var isAspiError = (error) => {
 var isCustomError = (error) => {
   return error instanceof CustomError;
 };
-var isParseError = (error) => {
-  return error instanceof CustomError && error.tag === "parseError";
-};
 var isJSONParseError = (error) => {
   return error instanceof CustomError && error.tag === "jsonParseError";
 };
+var isSchemaParseError = (error) => {
+  return error instanceof CustomError && error.tag === "schemaParseError";
+};
 
 // src/result.ts
 var result_exports = {};
@@ -1176,7 +1176,9 @@ var Request = class {
   }
   async #makeRequest(responseParser, isJson = false) {
     if (this.#bodySchemaIssues.length) {
-      return err(new CustomError("parseError", this.#bodySchemaIssues));
+      return err(
+        new CustomError("schemaParseError", this.#bodySchemaIssues)
+      );
     }
     const request = this.#request();
     const { retries, retryDelay, retryOn, retryWhile, onRetry } = this.#sanitisedRetryConfig();
@@ -1315,7 +1317,7 @@ var Request = class {
           throw new Error("Schema validation should not return a promise");
         }
         if (data.issues) {
-          return err(new CustomError("parseError", data.issues));
+          return err(new CustomError("schemaParseError", data.issues));
         }
         return ok({
           data: data.value,
@@ -1939,5 +1941,5 @@ var Aspi = class {
   isAspiError,
   isCustomError,
   isJSONParseError,
-  isParseError
+  isSchemaParseError
 });

package/dist/index.d.cts

@@ -1,3 +1,64 @@
+/**
+ * Standard Schema is a common interface designed to be implemented by JavaScript and TypeScript schema libraries.
+ * Will support multiple schema validators including Zod, Valibot, and ArkType
+ * https://standardschema.dev/
+ */
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /** The Standard Schema properties. */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+    /** The Standard Schema properties interface. */
+    interface Props<Input = unknown, Output = Input> {
+        /** The version number of the standard. */
+        readonly version: 1;
+        /** The vendor name of the schema library. */
+        readonly vendor: string;
+        /** Validates unknown input values. */
+        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
+        /** Inferred types associated with the schema. */
+        readonly types?: Types<Input, Output> | undefined;
+    }
+    /** The result interface of the validate function. */
+    type Result<Output> = SuccessResult<Output> | FailureResult;
+    /** The result interface if validation succeeds. */
+    interface SuccessResult<Output> {
+        /** The typed output value. */
+        readonly value: Output;
+        /** The non-existent issues. */
+        readonly issues?: undefined;
+    }
+    /** The result interface if validation fails. */
+    interface FailureResult {
+        /** The issues of failed validation. */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /** The issue interface of the failure output. */
+    interface Issue {
+        /** The error message of the issue. */
+        readonly message: string;
+        /** The path of the issue, if any. */
+        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+    }
+    /** The path segment interface of the issue. */
+    interface PathSegment {
+        /** The key representing a path segment. */
+        readonly key: PropertyKey;
+    }
+    /** The Standard Schema types interface. */
+    interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /** Infers the input type of a Standard Schema. */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /** Infers the output type of a Standard Schema. */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+}
+
 /**
  * Standard HTTP /**
  * Common HTTP error status codes with their numeric values.
@@ -364,14 +425,16 @@ interface JSONParseError extends CustomError<'jsonParseError', {
 }> {
 }
 /**
- * Type alias for a schema validation parse error.
- * Emitted when either the request body schema or the response schema fails validation.
+ * Interface representing a schema validation error (body or response).
+ * @interface SchemaParseError
+ * @extends {CustomError<'schemaParseError', ReadonlyArray<StandardSchemaV1.Issue>>}
  */
-type ParseError = CustomError<'parseError', unknown>;
+interface SchemaParseError extends CustomError<'schemaParseError', ReadonlyArray<StandardSchemaV1.Issue>> {
+}
 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>;
-declare const isParseError: (error: unknown) => error is ParseError;
 declare const isJSONParseError: (error: unknown) => error is JSONParseError;
+declare const isSchemaParseError: (error: unknown) => error is SchemaParseError;
 
 /**
  * Arguments passed to a capability factory.
@@ -756,67 +819,6 @@ declare namespace result {
   export { type result_Err as Err, type result_Ok as Ok, type result_Result as Result, result_catchAllErrors as catchAllErrors, result_catchError as catchError, result_catchErrors as catchErrors, result_err as err, result_getErrorOrNull as getErrorOrNull, result_getOrElse as getOrElse, result_getOrNull as getOrNull, result_getOrThrow as getOrThrow, result_getOrThrowWith as getOrThrowWith, result_isErr as isErr, result_isOk as isOk, result_map as map, result_mapErr as mapErr, result_match as match, result_ok as ok, result_pipe as pipe };
 }
 
-/**
- * Standard Schema is a common interface designed to be implemented by JavaScript and TypeScript schema libraries.
- * Will support multiple schema validators including Zod, Valibot, and ArkType
- * https://standardschema.dev/
- */
-/** The Standard Schema interface. */
-interface StandardSchemaV1<Input = unknown, Output = Input> {
-    /** The Standard Schema properties. */
-    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardSchemaV1 {
-    /** The Standard Schema properties interface. */
-    interface Props<Input = unknown, Output = Input> {
-        /** The version number of the standard. */
-        readonly version: 1;
-        /** The vendor name of the schema library. */
-        readonly vendor: string;
-        /** Validates unknown input values. */
-        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
-        /** Inferred types associated with the schema. */
-        readonly types?: Types<Input, Output> | undefined;
-    }
-    /** The result interface of the validate function. */
-    type Result<Output> = SuccessResult<Output> | FailureResult;
-    /** The result interface if validation succeeds. */
-    interface SuccessResult<Output> {
-        /** The typed output value. */
-        readonly value: Output;
-        /** The non-existent issues. */
-        readonly issues?: undefined;
-    }
-    /** The result interface if validation fails. */
-    interface FailureResult {
-        /** The issues of failed validation. */
-        readonly issues: ReadonlyArray<Issue>;
-    }
-    /** The issue interface of the failure output. */
-    interface Issue {
-        /** The error message of the issue. */
-        readonly message: string;
-        /** The path of the issue, if any. */
-        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-    /** The path segment interface of the issue. */
-    interface PathSegment {
-        /** The key representing a path segment. */
-        readonly key: PropertyKey;
-    }
-    /** The Standard Schema types interface. */
-    interface Types<Input = unknown, Output = Input> {
-        /** The input type of the schema. */
-        readonly input: Input;
-        /** The output type of the schema. */
-        readonly output: Output;
-    }
-    /** Infers the input type of a Standard Schema. */
-    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
-    /** Infers the output type of a Standard Schema. */
-    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
-}
-
 /**
  * A class for building and executing HTTP requests with customizable options and error handling.
  * @template Method The HTTP method type (GET, POST, etc.)
@@ -937,7 +939,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
     bodySchema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Omit<Opts, "bodySchema"> & {
         bodySchema: TSchema;
         error: Opts["error"] & {
-            parseError: CustomError<"parseError", StandardSchemaV1.FailureResult["issues"]>;
+            schemaParseError: CustomError<"schemaParseError", StandardSchemaV1.FailureResult["issues"]>;
         };
     }>;
     /**
@@ -1209,7 +1211,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
     schema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Merge<Omit<Opts, "schema">, {
         schema: TSchema;
         error: Merge<Opts["error"], {
-            parseError: CustomError<"parseError", StandardSchemaV1.FailureResult["issues"]>;
+            schemaParseError: CustomError<"schemaParseError", StandardSchemaV1.FailureResult["issues"]>;
         }>;
     }>>;
     /**
@@ -2005,4 +2007,4 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
     useCapability(capability: Capability<TRequest>): this;
 }
 
-export { Aspi, type AspiConfigBase, AspiError, type AspiPlainResponse, type AspiRequest, type AspiRequestInit, type AspiRequestInitWithoutBodyAndMethod, type AspiResponse, type AspiResultOk, type AspiRetryConfig, type BaseURL, type Capability, type CapabilityArgs, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Merge, type ParseError, type Prettify, Request, type RequestOptions, type RequestTransformer, result as Result, getHttpErrorStatus, httpErrors, isAspiError, isCustomError, isJSONParseError, isParseError };
+export { Aspi, type AspiConfigBase, AspiError, type AspiPlainResponse, type AspiRequest, type AspiRequestInit, type AspiRequestInitWithoutBodyAndMethod, type AspiResponse, type AspiResultOk, type AspiRetryConfig, type BaseURL, type Capability, type CapabilityArgs, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Merge, type Prettify, Request, type RequestOptions, type RequestTransformer, result as Result, type SchemaParseError, getHttpErrorStatus, httpErrors, isAspiError, isCustomError, isJSONParseError, isSchemaParseError };

package/dist/index.d.ts

@@ -1,3 +1,64 @@
+/**
+ * Standard Schema is a common interface designed to be implemented by JavaScript and TypeScript schema libraries.
+ * Will support multiple schema validators including Zod, Valibot, and ArkType
+ * https://standardschema.dev/
+ */
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /** The Standard Schema properties. */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+    /** The Standard Schema properties interface. */
+    interface Props<Input = unknown, Output = Input> {
+        /** The version number of the standard. */
+        readonly version: 1;
+        /** The vendor name of the schema library. */
+        readonly vendor: string;
+        /** Validates unknown input values. */
+        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
+        /** Inferred types associated with the schema. */
+        readonly types?: Types<Input, Output> | undefined;
+    }
+    /** The result interface of the validate function. */
+    type Result<Output> = SuccessResult<Output> | FailureResult;
+    /** The result interface if validation succeeds. */
+    interface SuccessResult<Output> {
+        /** The typed output value. */
+        readonly value: Output;
+        /** The non-existent issues. */
+        readonly issues?: undefined;
+    }
+    /** The result interface if validation fails. */
+    interface FailureResult {
+        /** The issues of failed validation. */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /** The issue interface of the failure output. */
+    interface Issue {
+        /** The error message of the issue. */
+        readonly message: string;
+        /** The path of the issue, if any. */
+        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+    }
+    /** The path segment interface of the issue. */
+    interface PathSegment {
+        /** The key representing a path segment. */
+        readonly key: PropertyKey;
+    }
+    /** The Standard Schema types interface. */
+    interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /** Infers the input type of a Standard Schema. */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /** Infers the output type of a Standard Schema. */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+}
+
 /**
  * Standard HTTP /**
  * Common HTTP error status codes with their numeric values.
@@ -364,14 +425,16 @@ interface JSONParseError extends CustomError<'jsonParseError', {
 }> {
 }
 /**
- * Type alias for a schema validation parse error.
- * Emitted when either the request body schema or the response schema fails validation.
+ * Interface representing a schema validation error (body or response).
+ * @interface SchemaParseError
+ * @extends {CustomError<'schemaParseError', ReadonlyArray<StandardSchemaV1.Issue>>}
  */
-type ParseError = CustomError<'parseError', unknown>;
+interface SchemaParseError extends CustomError<'schemaParseError', ReadonlyArray<StandardSchemaV1.Issue>> {
+}
 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>;
-declare const isParseError: (error: unknown) => error is ParseError;
 declare const isJSONParseError: (error: unknown) => error is JSONParseError;
+declare const isSchemaParseError: (error: unknown) => error is SchemaParseError;
 
 /**
  * Arguments passed to a capability factory.
@@ -756,67 +819,6 @@ declare namespace result {
   export { type result_Err as Err, type result_Ok as Ok, type result_Result as Result, result_catchAllErrors as catchAllErrors, result_catchError as catchError, result_catchErrors as catchErrors, result_err as err, result_getErrorOrNull as getErrorOrNull, result_getOrElse as getOrElse, result_getOrNull as getOrNull, result_getOrThrow as getOrThrow, result_getOrThrowWith as getOrThrowWith, result_isErr as isErr, result_isOk as isOk, result_map as map, result_mapErr as mapErr, result_match as match, result_ok as ok, result_pipe as pipe };
 }
 
-/**
- * Standard Schema is a common interface designed to be implemented by JavaScript and TypeScript schema libraries.
- * Will support multiple schema validators including Zod, Valibot, and ArkType
- * https://standardschema.dev/
- */
-/** The Standard Schema interface. */
-interface StandardSchemaV1<Input = unknown, Output = Input> {
-    /** The Standard Schema properties. */
-    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardSchemaV1 {
-    /** The Standard Schema properties interface. */
-    interface Props<Input = unknown, Output = Input> {
-        /** The version number of the standard. */
-        readonly version: 1;
-        /** The vendor name of the schema library. */
-        readonly vendor: string;
-        /** Validates unknown input values. */
-        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
-        /** Inferred types associated with the schema. */
-        readonly types?: Types<Input, Output> | undefined;
-    }
-    /** The result interface of the validate function. */
-    type Result<Output> = SuccessResult<Output> | FailureResult;
-    /** The result interface if validation succeeds. */
-    interface SuccessResult<Output> {
-        /** The typed output value. */
-        readonly value: Output;
-        /** The non-existent issues. */
-        readonly issues?: undefined;
-    }
-    /** The result interface if validation fails. */
-    interface FailureResult {
-        /** The issues of failed validation. */
-        readonly issues: ReadonlyArray<Issue>;
-    }
-    /** The issue interface of the failure output. */
-    interface Issue {
-        /** The error message of the issue. */
-        readonly message: string;
-        /** The path of the issue, if any. */
-        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-    /** The path segment interface of the issue. */
-    interface PathSegment {
-        /** The key representing a path segment. */
-        readonly key: PropertyKey;
-    }
-    /** The Standard Schema types interface. */
-    interface Types<Input = unknown, Output = Input> {
-        /** The input type of the schema. */
-        readonly input: Input;
-        /** The output type of the schema. */
-        readonly output: Output;
-    }
-    /** Infers the input type of a Standard Schema. */
-    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
-    /** Infers the output type of a Standard Schema. */
-    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
-}
-
 /**
  * A class for building and executing HTTP requests with customizable options and error handling.
  * @template Method The HTTP method type (GET, POST, etc.)
@@ -937,7 +939,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
     bodySchema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Omit<Opts, "bodySchema"> & {
         bodySchema: TSchema;
         error: Opts["error"] & {
-            parseError: CustomError<"parseError", StandardSchemaV1.FailureResult["issues"]>;
+            schemaParseError: CustomError<"schemaParseError", StandardSchemaV1.FailureResult["issues"]>;
         };
     }>;
     /**
@@ -1209,7 +1211,7 @@ declare class Request<Method extends HttpMethods, TRequest extends AspiRequestIn
     schema<TSchema extends StandardSchemaV1>(schema: TSchema): Request<Method, TRequest, Merge<Omit<Opts, "schema">, {
         schema: TSchema;
         error: Merge<Opts["error"], {
-            parseError: CustomError<"parseError", StandardSchemaV1.FailureResult["issues"]>;
+            schemaParseError: CustomError<"schemaParseError", StandardSchemaV1.FailureResult["issues"]>;
         }>;
     }>>;
     /**
@@ -2005,4 +2007,4 @@ declare class Aspi<TRequest extends AspiRequestInit = AspiRequestInit, Opts exte
     useCapability(capability: Capability<TRequest>): this;
 }
 
-export { Aspi, type AspiConfigBase, AspiError, type AspiPlainResponse, type AspiRequest, type AspiRequestInit, type AspiRequestInitWithoutBodyAndMethod, type AspiResponse, type AspiResultOk, type AspiRetryConfig, type BaseURL, type Capability, type CapabilityArgs, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Merge, type ParseError, type Prettify, Request, type RequestOptions, type RequestTransformer, result as Result, getHttpErrorStatus, httpErrors, isAspiError, isCustomError, isJSONParseError, isParseError };
+export { Aspi, type AspiConfigBase, AspiError, type AspiPlainResponse, type AspiRequest, type AspiRequestInit, type AspiRequestInitWithoutBodyAndMethod, type AspiResponse, type AspiResultOk, type AspiRetryConfig, type BaseURL, type Capability, type CapabilityArgs, CustomError, type CustomErrorCb, type ErrorCallbacks, type HttpErrorCodes, type HttpErrorStatus, type HttpMethods, type JSONParseError, type Merge, type Prettify, Request, type RequestOptions, type RequestTransformer, result as Result, type SchemaParseError, getHttpErrorStatus, httpErrors, isAspiError, isCustomError, isJSONParseError, isSchemaParseError };

package/dist/index.js

@@ -80,12 +80,12 @@ var isAspiError = (error) => {
 var isCustomError = (error) => {
   return error instanceof CustomError;
 };
-var isParseError = (error) => {
-  return error instanceof CustomError && error.tag === "parseError";
-};
 var isJSONParseError = (error) => {
   return error instanceof CustomError && error.tag === "jsonParseError";
 };
+var isSchemaParseError = (error) => {
+  return error instanceof CustomError && error.tag === "schemaParseError";
+};
 
 // src/result.ts
 var result_exports = {};
@@ -1146,7 +1146,9 @@ var Request = class {
   }
   async #makeRequest(responseParser, isJson = false) {
     if (this.#bodySchemaIssues.length) {
-      return err(new CustomError("parseError", this.#bodySchemaIssues));
+      return err(
+        new CustomError("schemaParseError", this.#bodySchemaIssues)
+      );
     }
     const request = this.#request();
     const { retries, retryDelay, retryOn, retryWhile, onRetry } = this.#sanitisedRetryConfig();
@@ -1285,7 +1287,7 @@ var Request = class {
           throw new Error("Schema validation should not return a promise");
         }
         if (data.issues) {
-          return err(new CustomError("parseError", data.issues));
+          return err(new CustomError("schemaParseError", data.issues));
         }
         return ok({
           data: data.value,
@@ -1908,5 +1910,5 @@ export {
   isAspiError,
   isCustomError,
   isJSONParseError,
-  isParseError
+  isSchemaParseError
 };

package/package.json

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