@zayne-labs/callapi 1.10.2 → 1.10.4

package/README.md

@@ -57,6 +57,6 @@ To do this, you first need to set your `script`'s type to `module`, then import
 
 <!-- Locked to a specific version -->
 <script type="module">
-	import { callApi } from "https://esm.run/@zayne-labs/callapi@1.8.9";
+	import { callApi } from "https://esm.run/@zayne-labs/callapi@1.10.3";
 </script>
 ```

package/dist/esm/{common-ChqKsMZ2.d.ts → common-Bk1Hh1hR.d.ts}

@@ -163,42 +163,6 @@ declare namespace StandardSchemaV1 {
   type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["output"];
 }
 //#endregion
-//#region src/error.d.ts
-type HTTPErrorDetails<TErrorData> = Pick<CallApiExtraOptions, "defaultHTTPErrorMessage"> & {
-  errorData: TErrorData;
-  response: Response;
-};
-declare class HTTPError<TErrorData = Record<string, unknown>> extends Error {
-  errorData: HTTPErrorDetails<TErrorData>["errorData"];
-  readonly httpErrorSymbol: symbol;
-  name: "HTTPError";
-  response: HTTPErrorDetails<TErrorData>["response"];
-  constructor(errorDetails: HTTPErrorDetails<TErrorData>, errorOptions?: ErrorOptions);
-  /**
-   * @description Checks if the given error is an instance of HTTPError
-   * @param error - The error to check
-   * @returns true if the error is an instance of HTTPError, false otherwise
-   */
-  static isError<TErrorData>(error: unknown): error is HTTPError<TErrorData>;
-}
-type ValidationErrorDetails = {
-  issues: readonly StandardSchemaV1.Issue[];
-  response: Response | null;
-};
-declare class ValidationError extends Error {
-  errorData: ValidationErrorDetails["issues"];
-  name: "ValidationError";
-  response: ValidationErrorDetails["response"];
-  readonly validationErrorSymbol: symbol;
-  constructor(details: ValidationErrorDetails, errorOptions?: ErrorOptions);
-  /**
-   * @description Checks if the given error is an instance of ValidationError
-   * @param error - The error to check
-   * @returns true if the error is an instance of ValidationError, false otherwise
-   */
-  static isError(error: unknown): error is ValidationError;
-}
-//#endregion
 //#region src/url.d.ts
 type AllowedQueryParamValues = UnmaskType<boolean | number | string>;
 type RecordStyleParams = UnmaskType<Record<string, AllowedQueryParamValues>>;
@@ -403,6 +367,56 @@ type BaseCallApiSchemaAndConfig = {
 declare const fallBackRouteSchemaKey = ".";
 type FallBackRouteSchemaKey = typeof fallBackRouteSchemaKey;
 //#endregion
+//#region src/error.d.ts
+type HTTPErrorDetails<TErrorData> = Pick<CallApiExtraOptions, "defaultHTTPErrorMessage"> & {
+  errorData: TErrorData;
+  response: Response;
+};
+declare class HTTPError<TErrorData = Record<string, unknown>> extends Error {
+  errorData: HTTPErrorDetails<TErrorData>["errorData"];
+  readonly httpErrorSymbol: symbol;
+  name: "HTTPError";
+  response: HTTPErrorDetails<TErrorData>["response"];
+  constructor(errorDetails: HTTPErrorDetails<TErrorData>, errorOptions?: ErrorOptions);
+  /**
+   * @description Checks if the given error is an instance of HTTPError
+   * @param error - The error to check
+   * @returns true if the error is an instance of HTTPError, false otherwise
+   */
+  static isError<TErrorData>(error: unknown): error is HTTPError<TErrorData>;
+}
+type LockedExtract<TUnion, TKey extends TUnion> = Extract<TUnion, TKey>;
+type ValidationErrorDetails = {
+  /**
+   * The cause of the validation error.
+   *
+   * It's either the name the schema for which validation failed, or the name of the schema config option that led to the validation error.
+   */
+  issueCause: "unknown" | `schemaConfig-(${LockedExtract<keyof CallApiSchemaConfig, "strict">})` | keyof CallApiSchema;
+  /**
+   * The issues that caused the validation error.
+   */
+  issues: readonly StandardSchemaV1.Issue[];
+  /**
+   * The response from server, if any.
+   */
+  response: Response | null;
+};
+declare class ValidationError extends Error {
+  errorData: ValidationErrorDetails["issues"];
+  issueCause: ValidationErrorDetails["issueCause"];
+  name: "ValidationError";
+  response: ValidationErrorDetails["response"];
+  readonly validationErrorSymbol: symbol;
+  constructor(details: ValidationErrorDetails, errorOptions?: ErrorOptions);
+  /**
+   * @description Checks if the given error is an instance of ValidationError
+   * @param error - The error to check
+   * @returns true if the error is an instance of ValidationError, false otherwise
+   */
+  static isError(error: unknown): error is ValidationError;
+}
+//#endregion
 //#region src/plugins.d.ts
 type PluginSetupContext<TPluginExtraOptions = unknown> = RequestContext & PluginExtraOptions<TPluginExtraOptions> & {
   initURL: string;
@@ -486,6 +500,7 @@ type PossibleHTTPError<TErrorData> = UnmaskType<{
 }>;
 type PossibleValidationError = UnmaskType<{
   errorData: ValidationError["errorData"];
+  issueCause: ValidationError["issueCause"];
   message: string;
   name: "ValidationError";
   originalError: ValidationError;
@@ -508,7 +523,7 @@ type ResultModeMapWithException<TData, TResponseType extends ResponseTypeUnion,
   all: CallApiResultSuccessVariant<TComputedData>;
   onlyData: CallApiResultSuccessVariant<TComputedData>["data"];
 };
-type ResultModeMap<TData = DefaultDataType, TErrorData = DefaultDataType, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TThrowOnError extends ThrowOnErrorUnion = false> = TThrowOnError extends true ? ResultModeMapWithException<TData, TResponseType> : ResultModeMapWithoutException<TData, TErrorData, TResponseType>;
+type ResultModeMap<TData = DefaultDataType, TErrorData = DefaultDataType, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TThrowOnError extends ThrowOnErrorUnion = DefaultThrowOnError> = TThrowOnError extends true ? ResultModeMapWithException<TData, TResponseType> : ResultModeMapWithoutException<TData, TErrorData, TResponseType>;
 type ResultModePlaceholder = null;
 type ResultModeUnion = keyof ResultModeMap | ResultModePlaceholder;
 type GetCallApiResult<TData, TErrorData, TResultMode extends ResultModeUnion, TThrowOnError extends ThrowOnErrorUnion, TResponseType extends ResponseTypeUnion> = TErrorData extends false ? ResultModeMapWithException<TData, TResponseType>["onlyData"] : TErrorData extends false | undefined ? ResultModeMapWithException<TData, TResponseType>["onlyData"] : ResultModePlaceholder extends TResultMode ? ResultModeMap<TData, TErrorData, TResponseType, TThrowOnError>["all"] : TResultMode extends Exclude<ResultModeUnion, ResultModePlaceholder> ? ResultModeMap<TData, TErrorData, TResponseType, TThrowOnError>[TResultMode] : never;
@@ -807,7 +822,7 @@ type RequestContext = {
 };
 type ValidationErrorContext = UnmaskType<RequestContext & {
   /** Validation error containing details about what failed validation */
-  error: ValidationError;
+  error: PossibleValidationError;
   /** HTTP response object if validation failed on response, null if on request */
   response: Response | null;
 }>;
@@ -822,7 +837,7 @@ type ResponseContext<TData, TErrorData> = UnmaskType<RequestContext & (Prettify<
 }>>)>;
 type RequestErrorContext = RequestContext & {
   /** Error that occurred during the request (network, timeout, etc.) */
-  error: PossibleJavaScriptOrValidationError;
+  error: PossibleJavaScriptError;
   /** Always null for request errors since no response was received */
   response: null;
 };
@@ -1234,12 +1249,13 @@ type ResultModeOption<TErrorData, TResultMode extends ResultModeUnion> = TErrorD
   resultMode?: TResultMode;
 };
 type ThrowOnErrorUnion = boolean;
+type ThrowOnErrorType<TErrorData, TThrowOnError extends ThrowOnErrorUnion> = TThrowOnError | ((context: ErrorContext<TErrorData>) => TThrowOnError);
 type ThrowOnErrorOption<TErrorData, TThrowOnError extends ThrowOnErrorUnion> = TErrorData extends false ? {
   throwOnError: true;
 } : TErrorData extends false | undefined ? {
   throwOnError?: true;
 } : {
-  throwOnError?: TThrowOnError | ((context: ErrorContext<TErrorData>) => TThrowOnError);
+  throwOnError?: ThrowOnErrorType<TErrorData, TThrowOnError>;
 };
 //#endregion
 //#region src/types/common.d.ts
@@ -1614,7 +1630,7 @@ type SharedExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, T
    * }
    * ```
    */
-  throwOnError?: TThrowOnError | ((context: ErrorContext<TErrorData>) => TThrowOnError);
+  throwOnError?: ThrowOnErrorType<TErrorData, TThrowOnError>;
   /**
    * Request timeout in milliseconds. Request will be aborted if it takes longer.
    *
@@ -1776,7 +1792,7 @@ type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType,
   }) => TSchemaConfig);
 };
 type CallApiExtraOptionsForHooks = Hooks & Omit<CallApiExtraOptions, keyof Hooks>;
-type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends ThrowOnErrorUnion = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBaseSchemaAndConfig extends BaseCallApiSchemaAndConfig = BaseCallApiSchemaAndConfig, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray> = (CallApiRequestOptions & BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemaAndConfig>) | ((context: {
+type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends ThrowOnErrorUnion = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBaseSchemaAndConfig extends BaseCallApiSchemaAndConfig = BaseCallApiSchemaAndConfig, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray> = (CallApiRequestOptions & BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemaAndConfig>) | ((instanceConfig: {
   initURL: string;
   options: CallApiExtraOptions;
   request: CallApiRequestOptions;
@@ -1786,4 +1802,4 @@ type CallApiParameters<TData = DefaultDataType, TErrorData = DefaultDataType, TR
 type CallApiResult<TData, TErrorData, TResultMode extends ResultModeUnion, TThrowOnError extends ThrowOnErrorUnion, TResponseType extends ResponseTypeUnion> = Promise<GetCallApiResult<TData, TErrorData, TResultMode, TThrowOnError, TResponseType>>;
 //#endregion
 export { AnyFunction, AnyString, ApplyStrictConfig, ApplyURLBasedConfig, BaseCallApiConfig, BaseCallApiExtraOptions, BaseCallApiSchemaAndConfig, BaseCallApiSchemaRoutes, CallApiConfig, CallApiExtraOptions, CallApiExtraOptionsForHooks, CallApiParameters, CallApiPlugin, CallApiRequestOptions, CallApiRequestOptionsForHooks, CallApiResult, CallApiResultErrorVariant, CallApiResultSuccessVariant, CallApiSchema, CallApiSchemaConfig, DedupeOptions, DefaultDataType, DefaultPluginArray, DefaultThrowOnError, ErrorContext, GetCurrentRouteSchema, GetCurrentRouteSchemaKey, GetResponseType, HTTPError, Hooks, HooksOrHooksArray, InferInitURL, InferParamsFromRoute, InferSchemaOutputResult, PluginExtraOptions, PluginHooks, PluginHooksWithMoreOptions, PluginSetupContext, PossibleHTTPError, PossibleJavaScriptError, PossibleJavaScriptOrValidationError, PossibleValidationError, Register, RequestContext, RequestStreamContext, ResponseContext, ResponseErrorContext, ResponseStreamContext, ResponseTypeMap, ResponseTypeUnion, ResultModeUnion, RetryOptions, SuccessContext, ThrowOnErrorUnion, URLOptions, ValidationError, Writeable, fallBackRouteSchemaKey };
-//# sourceMappingURL=common-ChqKsMZ2.d.ts.map
+//# sourceMappingURL=common-Bk1Hh1hR.d.ts.map

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
-import { AnyFunction, AnyString, ApplyStrictConfig, ApplyURLBasedConfig, BaseCallApiConfig, BaseCallApiExtraOptions, BaseCallApiSchemaAndConfig, BaseCallApiSchemaRoutes, CallApiConfig, CallApiExtraOptions, CallApiExtraOptionsForHooks, CallApiParameters, CallApiPlugin, CallApiRequestOptions, CallApiRequestOptionsForHooks, CallApiResult, CallApiResultErrorVariant, CallApiResultSuccessVariant, CallApiSchema, CallApiSchemaConfig, DedupeOptions, DefaultDataType, DefaultPluginArray, DefaultThrowOnError, ErrorContext, GetCurrentRouteSchema, GetCurrentRouteSchemaKey, GetResponseType, HTTPError, Hooks, HooksOrHooksArray, InferInitURL, InferParamsFromRoute, InferSchemaOutputResult, PluginExtraOptions, PluginHooks, PluginHooksWithMoreOptions, PluginSetupContext, PossibleHTTPError, PossibleJavaScriptError, PossibleJavaScriptOrValidationError, PossibleValidationError, Register, RequestContext, RequestStreamContext, ResponseContext, ResponseErrorContext, ResponseStreamContext, ResponseTypeMap, ResponseTypeUnion, ResultModeUnion, RetryOptions, SuccessContext, ThrowOnErrorUnion, URLOptions, ValidationError, Writeable, fallBackRouteSchemaKey } from "./common-ChqKsMZ2.js";
+import { AnyFunction, AnyString, ApplyStrictConfig, ApplyURLBasedConfig, BaseCallApiConfig, BaseCallApiExtraOptions, BaseCallApiSchemaAndConfig, BaseCallApiSchemaRoutes, CallApiConfig, CallApiExtraOptions, CallApiExtraOptionsForHooks, CallApiParameters, CallApiPlugin, CallApiRequestOptions, CallApiRequestOptionsForHooks, CallApiResult, CallApiResultErrorVariant, CallApiResultSuccessVariant, CallApiSchema, CallApiSchemaConfig, DedupeOptions, DefaultDataType, DefaultPluginArray, DefaultThrowOnError, ErrorContext, GetCurrentRouteSchema, GetCurrentRouteSchemaKey, GetResponseType, HTTPError, Hooks, HooksOrHooksArray, InferInitURL, InferParamsFromRoute, InferSchemaOutputResult, PluginExtraOptions, PluginHooks, PluginHooksWithMoreOptions, PluginSetupContext, PossibleHTTPError, PossibleJavaScriptError, PossibleJavaScriptOrValidationError, PossibleValidationError, Register, RequestContext, RequestStreamContext, ResponseContext, ResponseErrorContext, ResponseStreamContext, ResponseTypeMap, ResponseTypeUnion, ResultModeUnion, RetryOptions, SuccessContext, ThrowOnErrorUnion, URLOptions, ValidationError, Writeable, fallBackRouteSchemaKey } from "./common-Bk1Hh1hR.js";
 
 //#region src/createFetchClient.d.ts
 

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-import { HTTPError, ValidationError, createCombinedSignal, createTimeoutSignal, defineEnum, deterministicHashFn, extraOptionDefaults, getBody, getFetchImpl, getHeaders, isArray, isBoolean, isFunction, isHTTPErrorInstance, isObject, isPlainObject, isReadableStream, isString, isValidationErrorInstance, requestOptionDefaults, splitBaseConfig, splitConfig, toArray, toQueryString, waitFor } from "./utils-zvYT8TK8.js";
+import { HTTPError, ValidationError, createCombinedSignal, createTimeoutSignal, defineEnum, deterministicHashFn, extraOptionDefaults, getBody, getFetchImpl, getHeaders, isArray, isBoolean, isFunction, isHTTPErrorInstance, isObject, isPlainObject, isReadableStream, isString, isValidationErrorInstance, requestOptionDefaults, splitBaseConfig, splitConfig, toArray, toQueryString, waitFor } from "./utils-Bm4Dvem6.js";
 
 //#region src/result.ts
 const getResponseType = (response, parser) => ({
@@ -66,6 +66,7 @@ const resolveErrorResult = (error, info) => {
 			data: null,
 			error: {
 				errorData,
+				issueCause: error.issueCause,
 				message,
 				name: "ValidationError",
 				originalError: error
@@ -341,12 +342,15 @@ const handleValidatorFunction = async (validator, inputData) => {
 		};
 	}
 };
-const standardSchemaParser = async (schema, inputData, response) => {
+const standardSchemaParser = async (fullSchema, schemaName, inputData, response) => {
+	const schema = fullSchema?.[schemaName];
+	if (!schema) return inputData;
 	const result = isFunction(schema) ? await handleValidatorFunction(schema, inputData) : await schema["~standard"].validate(inputData);
 	if (result.issues) throw new ValidationError({
+		issueCause: schemaName,
 		issues: result.issues,
 		response: response ?? null
-	}, { cause: result.issues });
+	});
 	return result.value;
 };
 const routeKeyMethods = defineEnum([
@@ -356,10 +360,10 @@ const routeKeyMethods = defineEnum([
 	"post",
 	"put"
 ]);
-const handleSchemaValidation = async (schema, validationOptions) => {
+const handleSchemaValidation = async (fullSchema, schemaName, validationOptions) => {
 	const { inputValue, response, schemaConfig } = validationOptions;
-	if (!schema || schemaConfig?.disableRuntimeValidation) return inputValue;
-	return await standardSchemaParser(schema, inputValue, response);
+	if (schemaConfig?.disableRuntimeValidation) return inputValue;
+	return await standardSchemaParser(fullSchema, schemaName, inputValue, response);
 };
 const extraOptionsToBeValidated = [
 	"meta",
@@ -368,15 +372,15 @@ const extraOptionsToBeValidated = [
 ];
 const handleExtraOptionsValidation = async (validationOptions) => {
 	const { options, schema, schemaConfig } = validationOptions;
-	const validationResultArray = await Promise.all(extraOptionsToBeValidated.map((propertyKey) => handleSchemaValidation(schema?.[propertyKey], {
-		inputValue: options[propertyKey],
+	const validationResultArray = await Promise.all(extraOptionsToBeValidated.map((schemaName) => handleSchemaValidation(schema, schemaName, {
+		inputValue: options[schemaName],
 		schemaConfig
 	})));
 	const validatedResultObject = {};
-	for (const [index, propertyKey] of extraOptionsToBeValidated.entries()) {
+	for (const [index, schemaName] of extraOptionsToBeValidated.entries()) {
 		const validationResult = validationResultArray[index];
 		if (validationResult === void 0) continue;
-		validatedResultObject[propertyKey] = validationResult;
+		validatedResultObject[schemaName] = validationResult;
 	}
 	return validatedResultObject;
 };
@@ -387,8 +391,8 @@ const requestOptionsToBeValidated = [
 ];
 const handleRequestOptionsValidation = async (validationOptions) => {
 	const { requestOptions, schema, schemaConfig } = validationOptions;
-	const validationResultArray = await Promise.all(requestOptionsToBeValidated.map((propertyKey) => handleSchemaValidation(schema?.[propertyKey], {
-		inputValue: requestOptions[propertyKey],
+	const validationResultArray = await Promise.all(requestOptionsToBeValidated.map((schemaName) => handleSchemaValidation(schema, schemaName, {
+		inputValue: requestOptions[schemaName],
 		schemaConfig
 	})));
 	const validatedResultObject = {};
@@ -410,7 +414,8 @@ const handleConfigValidation = async (validationOptions) => {
 		baseExtraOptions,
 		extraOptions
 	});
-	if (!currentRouteSchema && resolvedSchemaConfig?.strict === true) throw new ValidationError({
+	if (resolvedSchemaConfig?.strict === true && !currentRouteSchema) throw new ValidationError({
+		issueCause: "schemaConfig-(strict)",
 		issues: [{ message: `Strict Mode - No schema found for route '${currentRouteSchemaKey}' ` }],
 		response: null
 	});
@@ -601,7 +606,7 @@ const createRetryStrategy = (ctx) => {
 		const retryMethods = new Set(options.retryMethods ?? options.retry?.methods ?? extraOptionDefaults().retryMethods);
 		const includesMethod = isString(ctx.request.method) && retryMethods.size > 0 ? retryMethods.has(ctx.request.method) : true;
 		const retryStatusCodes = new Set(options.retryStatusCodes ?? options.retry?.statusCodes ?? extraOptionDefaults().retryStatusCodes);
-		const includesStatusCodes = Boolean(ctx.response) && retryStatusCodes.size > 0 ? retryStatusCodes.has(ctx.response.status) : true;
+		const includesStatusCodes = ctx.response != null && retryStatusCodes.size > 0 ? retryStatusCodes.has(ctx.response.status) : true;
 		return includesMethod && includesStatusCodes;
 	};
 	return {
@@ -815,7 +820,7 @@ const createFetchClient = (initBaseConfig = {}) => {
 			const shouldCloneResponse = resolvedDedupeStrategy === "defer" || options.cloneResponse;
 			if (!response.ok) {
 				const errorData = await resolveResponseData(shouldCloneResponse ? response.clone() : response, options.responseType, options.responseParser);
-				const validErrorData = await handleSchemaValidation(resolvedSchema?.errorData, {
+				const validErrorData = await handleSchemaValidation(resolvedSchema, "errorData", {
 					inputValue: errorData,
 					response,
 					schemaConfig: resolvedSchemaConfig
@@ -827,7 +832,7 @@ const createFetchClient = (initBaseConfig = {}) => {
 				}, { cause: validErrorData });
 			}
 			const successData = await resolveResponseData(shouldCloneResponse ? response.clone() : response, options.responseType, options.responseParser);
-			const validSuccessData = await handleSchemaValidation(resolvedSchema?.data, {
+			const validSuccessData = await handleSchemaValidation(resolvedSchema, "data", {
 				inputValue: successData,
 				response,
 				schemaConfig: resolvedSchemaConfig
@@ -862,7 +867,7 @@ const createFetchClient = (initBaseConfig = {}) => {
 				request,
 				response: errorDetails.response
 			};
-			const shouldThrowOnError = isFunction(options.throwOnError) ? options.throwOnError(errorContext) : options.throwOnError;
+			const shouldThrowOnError = Boolean(isFunction(options.throwOnError) ? options.throwOnError(errorContext) : options.throwOnError);
 			const hookInfo = {
 				errorInfo,
 				shouldThrowOnError
@@ -887,11 +892,7 @@ const createFetchClient = (initBaseConfig = {}) => {
 				if (shouldThrowOnError) throw error;
 				return generalErrorResult;
 			};
-			if (isValidationErrorInstance(error)) return await executeHooksInCatchBlock([
-				options.onValidationError?.(errorContext),
-				options.onRequestError?.(errorContext),
-				options.onError?.(errorContext)
-			], hookInfo) ?? await handleRetryOrGetErrorResult();
+			if (isValidationErrorInstance(error)) return await executeHooksInCatchBlock([options.onValidationError?.(errorContext), options.onError?.(errorContext)], hookInfo) ?? await handleRetryOrGetErrorResult();
 			if (isHTTPErrorInstance(error)) return await executeHooksInCatchBlock([
 				options.onResponseError?.(errorContext),
 				options.onError?.(errorContext),