@zayne-labs/callapi 1.7.4 → 1.7.5

package/dist/cjs/{common-DiBiESb2.d.cts → common-BUhBcx_C.d.cts}

@@ -93,6 +93,30 @@ type PossibleHTTPError<TErrorData> = UnmaskType<{
     name: "HTTPError";
 }>;
 
+type StreamProgressEvent = {
+    /**
+     * Current chunk of data being streamed
+     */
+    chunk: Uint8Array;
+    /**
+     * Progress in percentage
+     */
+    progress: number;
+    /**
+     * Total size of data in bytes
+     */
+    totalBytes: number;
+    /**
+     * Amount of data transferred so far
+     */
+    transferredBytes: number;
+};
+declare global {
+    interface ReadableStream<R> {
+        [Symbol.asyncIterator]: () => AsyncIterableIterator<R>;
+    }
+}
+
 /**
  * The Standard Schema interface.
  * @see https://github.com/standard-schema/standard-schema
@@ -192,24 +216,6 @@ declare namespace StandardSchemaV1 {
     type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["output"];
 }
 
-type Params = UnmaskType<Record<string, boolean | number | string> | Array<boolean | number | string>>;
-type Query = UnmaskType<Record<string, boolean | number | string>>;
-type InitURL = UnmaskType<string | URL>;
-interface UrlOptions<TSchemas extends CallApiSchemas> {
-    /**
-     * URL to be used in the request.
-     */
-    readonly initURL?: string;
-    /**
-     * Parameters to be appended to the URL (i.e: /:id)
-     */
-    params?: InferSchemaResult<TSchemas["params"], Params>;
-    /**
-     * Query parameters to append to the URL.
-     */
-    query?: InferSchemaResult<TSchemas["query"], Query>;
-}
-
 interface CallApiSchemas {
     /**
      *  The schema to use for validating the request body.
@@ -261,56 +267,36 @@ interface CallApiValidators<TData = unknown, TErrorData = unknown> {
 }
 type InferSchemaResult<TSchema, TData> = TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TData;
 
-type Parser = (responseString: string) => Awaitable<Record<string, unknown>>;
-declare const getResponseType: <TResponse>(response: Response, parser?: Parser) => {
-    arrayBuffer: () => Promise<ArrayBuffer>;
-    blob: () => Promise<Blob>;
-    formData: () => Promise<FormData>;
-    json: () => Promise<TResponse>;
-    stream: () => ReadableStream<Uint8Array<ArrayBufferLike>> | null;
-    text: () => Promise<string>;
-};
-type InitResponseTypeMap<TResponse = unknown> = ReturnType<typeof getResponseType<TResponse>>;
-type ResponseTypeUnion = keyof InitResponseTypeMap | undefined;
-type ResponseTypeMap<TResponse> = {
-    [Key in keyof InitResponseTypeMap<TResponse>]: Awaited<ReturnType<InitResponseTypeMap<TResponse>[Key]>>;
-};
-type GetResponseType<TResponse, TResponseType extends ResponseTypeUnion, TComputedMap extends ResponseTypeMap<TResponse> = ResponseTypeMap<TResponse>> = undefined extends TResponseType ? TComputedMap["json"] : TResponseType extends NonNullable<ResponseTypeUnion> ? TComputedMap[TResponseType] : never;
-
-type StreamProgressEvent = {
-    /**
-     * Current chunk of data being streamed
-     */
-    chunk: Uint8Array;
+type Params = UnmaskType<Record<string, boolean | number | string> | Array<boolean | number | string>>;
+type Query = UnmaskType<Record<string, boolean | number | string>>;
+type InitURL = UnmaskType<string | URL>;
+interface UrlOptions<TSchemas extends CallApiSchemas> {
     /**
-     * Progress in percentage
+     * URL to be used in the request.
      */
-    progress: number;
+    readonly initURL?: string;
     /**
-     * Total size of data in bytes
+     * Parameters to be appended to the URL (i.e: /:id)
      */
-    totalBytes: number;
+    params?: InferSchemaResult<TSchemas["params"], Params>;
     /**
-     * Amount of data transferred so far
+     * Query parameters to append to the URL.
      */
-    transferredBytes: number;
-};
-declare global {
-    interface ReadableStream<R> {
-        [Symbol.asyncIterator]: () => AsyncIterableIterator<R>;
-    }
+    query?: InferSchemaResult<TSchemas["query"], Query>;
 }
 
 type UnionToIntersection<TUnion> = (TUnion extends unknown ? (param: TUnion) => void : never) extends (param: infer TParam) => void ? TParam : never;
 type InferSchema<TResult> = TResult extends StandardSchemaV1 ? InferSchemaResult<TResult, NonNullable<unknown>> : TResult;
 type InferPluginOptions<TPluginArray extends CallApiPlugin[]> = UnionToIntersection<InferSchema<ReturnType<NonNullable<TPluginArray[number]["createExtraOptions"]>>>>;
-type PluginInitContext<TMoreOptions = DefaultMoreOptions> = Prettify<SharedHookContext & WithMoreOptions<TMoreOptions> & {
+type PluginInitContext<TMoreOptions = DefaultMoreOptions> = Prettify<SharedHookContext<TMoreOptions> & {
     initURL: InitURL | undefined;
 }>;
 type PluginInitResult = Partial<Omit<PluginInitContext, "request"> & {
     request: CallApiRequestOptions;
 }>;
-interface CallApiPlugin<TData = never, TErrorData = never> {
+type PluginHooksWithMoreOptions<TMoreOptions = DefaultMoreOptions> = HooksOrHooksArray<never, never, TMoreOptions>;
+type PluginHooks<TData = never, TErrorData = never, TMoreOptions = DefaultMoreOptions> = HooksOrHooksArray<TData, TErrorData, TMoreOptions>;
+interface CallApiPlugin {
     /**
      * Defines additional options that can be passed to callApi
      */
@@ -322,7 +308,7 @@ interface CallApiPlugin<TData = never, TErrorData = never> {
     /**
      * Hooks / Interceptors for the plugin
      */
-    hooks?: hooksOrHooksArray<TData, TErrorData>;
+    hooks?: PluginHooks;
     /**
      *  A unique id for the plugin
      */
@@ -390,10 +376,10 @@ type Hooks<TData = DefaultDataType, TErrorData = DefaultDataType, TMoreOptions =
      */
     onSuccess?: (context: Prettify<SuccessContext<TData> & WithMoreOptions<TMoreOptions>>) => Awaitable<unknown>;
 };
-type hooksOrHooksArray<TData = DefaultDataType, TErrorData = DefaultDataType, TMoreOptions = DefaultMoreOptions> = {
+type HooksOrHooksArray<TData = DefaultDataType, TErrorData = DefaultDataType, TMoreOptions = DefaultMoreOptions> = {
     [Key in keyof Hooks<TData, TErrorData, TMoreOptions>]: Hooks<TData, TErrorData, TMoreOptions>[Key] | Array<Hooks<TData, TErrorData, TMoreOptions>[Key]>;
 };
-type SharedHookContext = {
+type SharedHookContext<TMoreOptions = DefaultMoreOptions> = {
     /**
      * Config object passed to createFetchClient
      */
@@ -406,7 +392,7 @@ type SharedHookContext = {
      * Merged options consisting of extra options from createFetchClient, the callApi instance and default options.
      *
      */
-    options: CombinedCallApiExtraOptions;
+    options: CombinedCallApiExtraOptions & Partial<TMoreOptions>;
     /**
      * Merged request consisting of request options from createFetchClient, the callApi instance and default request options.
      */
@@ -450,6 +436,22 @@ type ResponseStreamContext = UnmaskType<Prettify<SharedHookContext & {
     response: Response;
 }>>;
 
+type Parser = (responseString: string) => Awaitable<Record<string, unknown>>;
+declare const getResponseType: <TResponse>(response: Response, parser?: Parser) => {
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    blob: () => Promise<Blob>;
+    formData: () => Promise<FormData>;
+    json: () => Promise<TResponse>;
+    stream: () => ReadableStream<Uint8Array<ArrayBufferLike>> | null;
+    text: () => Promise<string>;
+};
+type InitResponseTypeMap<TResponse = unknown> = ReturnType<typeof getResponseType<TResponse>>;
+type ResponseTypeUnion = keyof InitResponseTypeMap | null;
+type ResponseTypeMap<TResponse> = {
+    [Key in keyof InitResponseTypeMap<TResponse>]: Awaited<ReturnType<InitResponseTypeMap<TResponse>[Key]>>;
+};
+type GetResponseType<TResponse, TResponseType extends ResponseTypeUnion, TComputedResponseTypeMap extends ResponseTypeMap<TResponse> = ResponseTypeMap<TResponse>> = null extends TResponseType ? TComputedResponseTypeMap["json"] : TResponseType extends NonNullable<ResponseTypeUnion> ? TComputedResponseTypeMap[TResponseType] : never;
+
 type RetryCondition<TErrorData> = (context: ErrorContext<TErrorData>) => Awaitable<boolean>;
 interface RetryOptions<TErrorData> {
     /**
@@ -581,7 +583,7 @@ type ResultModeOption<TErrorData, TResultMode extends ResultModeUnion> = TErrorD
     resultMode: "onlySuccessWithException";
 } : TErrorData extends false | undefined ? {
     resultMode?: "onlySuccessWithException";
-} : undefined extends TResultMode ? {
+} : null extends TResultMode ? {
     resultMode?: TResultMode;
 } : {
     resultMode: TResultMode;
@@ -695,7 +697,7 @@ type ExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResult
      * Custom validation functions for response validation
      */
     validators?: CallApiValidators<TData, TErrorData>;
-} & hooksOrHooksArray<TData, TErrorData> & Partial<InferPluginOptions<TPluginArray>> & MetaOption<TSchemas> & RetryOptions<TErrorData> & ResultModeOption<TErrorData, TResultMode> & UrlOptions<TSchemas>;
+} & HooksOrHooksArray<TData, TErrorData, Partial<InferPluginOptions<TPluginArray>>> & Partial<InferPluginOptions<TPluginArray>> & MetaOption<TSchemas> & RetryOptions<TErrorData> & ResultModeOption<TErrorData, TResultMode> & UrlOptions<TSchemas>;
 type CallApiExtraOptions<TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeUnion = ResultModeUnion, TThrowOnError extends boolean = DefaultThrowOnError, TResponseType extends ResponseTypeUnion = ResponseTypeUnion, TPluginArray extends CallApiPlugin[] = DefaultPluginArray, TSchemas extends CallApiSchemas = DefaultMoreOptions> = ExtraOptions<TData, TErrorData, TResultMode, TThrowOnError, TResponseType, TPluginArray, TSchemas> & {
     plugins?: Plugins<TPluginArray> | ((context: {
         basePlugins: Plugins<TPluginArray>;
@@ -731,8 +733,8 @@ type BaseCallApiExtraOptions<TBaseData = DefaultDataType, TBaseErrorData = Defau
     skipAutoMergeFor?: "all" | "options" | "request";
 };
 type CombinedExtraOptionsWithoutHooks = Omit<BaseCallApiExtraOptions & CallApiExtraOptions, keyof Hooks>;
-type ResolvedHooks = Hooks;
-type CombinedCallApiExtraOptions = CombinedExtraOptionsWithoutHooks & ResolvedHooks;
+interface CombinedCallApiExtraOptions extends CombinedExtraOptionsWithoutHooks, Hooks {
+}
 type BaseCallApiConfig<TBaseData = DefaultDataType, TBaseErrorData = DefaultDataType, TBaseResultMode extends ResultModeUnion = ResultModeUnion, TBaseThrowOnError extends boolean = DefaultThrowOnError, TBaseResponseType extends ResponseTypeUnion = ResponseTypeUnion, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray, TBaseSchemas extends CallApiSchemas = DefaultMoreOptions> = (CallApiRequestOptions<TBaseSchemas> & BaseCallApiExtraOptions<TBaseData, TBaseErrorData, TBaseResultMode, TBaseThrowOnError, TBaseResponseType, TBasePluginArray, TBaseSchemas>) | ((context: {
     initURL: string;
     options: CallApiExtraOptions;
@@ -767,8 +769,8 @@ type ResultModeMap<TData = DefaultDataType, TErrorData = DefaultDataType, TRespo
     onlySuccess: CallApiResultErrorVariant<TComputedErrorData>["data"] | CallApiResultSuccessVariant<TComputedData>["data"];
     onlySuccessWithException: CallApiResultSuccessVariant<TComputedData>["data"];
 }>;
-type ResultModeUnion = keyof ResultModeMap | undefined;
-type GetCallApiResult<TData, TErrorData, TResultMode extends ResultModeUnion, TThrowOnError extends boolean, TResponseType extends ResponseTypeUnion> = TErrorData extends false | undefined ? ResultModeMap<TData, TErrorData, TResponseType>["onlySuccessWithException"] : ResultModeUnion | undefined extends TResultMode ? TThrowOnError extends true ? ResultModeMap<TData, TErrorData, TResponseType>["allWithException"] : ResultModeMap<TData, TErrorData, TResponseType>["all"] : TResultMode extends NonNullable<ResultModeUnion> ? TResultMode extends "onlySuccess" ? ResultModeMap<TData, TErrorData, TResponseType>["onlySuccessWithException"] : TResultMode extends "onlyResponse" ? ResultModeMap<TData, TErrorData, TResponseType>["onlyResponseWithException"] : ResultModeMap<TData, TErrorData, TResponseType>[TResultMode] : never;
+type ResultModeUnion = keyof ResultModeMap | null;
+type GetCallApiResult<TData, TErrorData, TResultMode extends ResultModeUnion, TThrowOnError extends boolean, TResponseType extends ResponseTypeUnion> = TErrorData extends false | undefined ? ResultModeMap<TData, TErrorData, TResponseType>["onlySuccessWithException"] : null extends TResultMode ? TThrowOnError extends true ? ResultModeMap<TData, TErrorData, TResponseType>["allWithException"] : ResultModeMap<TData, TErrorData, TResponseType>["all"] : TResultMode extends NonNullable<ResultModeUnion> ? TResultMode extends "onlySuccess" ? ResultModeMap<TData, TErrorData, TResponseType>["onlySuccessWithException"] : TResultMode extends "onlyResponse" ? ResultModeMap<TData, TErrorData, TResponseType>["onlyResponseWithException"] : ResultModeMap<TData, TErrorData, TResponseType>[TResultMode] : never;
 type CallApiResult<TData, TErrorData, TResultMode extends ResultModeUnion, TThrowOnError extends boolean, TResponseType extends ResponseTypeUnion> = Promise<GetCallApiResult<TData, TErrorData, TResultMode, TThrowOnError, TResponseType>>;
 
-export { type CallApiResultErrorVariant as A, type BaseCallApiConfig as B, type CallApiPlugin as C, type DefaultPluginArray as D, type ErrorContext as E, type CallApiResultSuccessVariant as F, type CombinedCallApiExtraOptions as G, HTTPError as H, type InferSchemaResult as I, type Register as J, type PluginInitContext as P, type ResultModeUnion as R, type SharedHookContext as S, type ResponseTypeUnion as a, type CallApiSchemas as b, type CallApiConfig as c, type CallApiResult as d, type DefaultDataType as e, type DefaultThrowOnError as f, type DefaultMoreOptions as g, type CallApiParameters as h, definePlugin as i, getDefaultOptions as j, type RetryOptions as k, type PossibleHTTPError as l, type PossibleJavaScriptError as m, type Hooks as n, type hooksOrHooksArray as o, type RequestContext as p, type RequestErrorContext as q, type RequestStreamContext as r, type ResponseContext as s, type ResponseErrorContext as t, type ResponseStreamContext as u, type SuccessContext as v, type BaseCallApiExtraOptions as w, type CallApiExtraOptions as x, type CallApiRequestOptions as y, type CallApiRequestOptionsForHooks as z };
+export { type CallApiRequestOptions as A, type BaseCallApiConfig as B, type CallApiPlugin as C, type DefaultPluginArray as D, type ErrorContext as E, type CallApiRequestOptionsForHooks as F, type CallApiResultErrorVariant as G, HTTPError as H, type InferSchemaResult as I, type CallApiResultSuccessVariant as J, type CombinedCallApiExtraOptions as K, type Register as L, type PluginInitContext as P, type ResultModeUnion as R, type SharedHookContext as S, type ResponseTypeUnion as a, type CallApiSchemas as b, type CallApiConfig as c, type CallApiResult as d, type DefaultDataType as e, type DefaultThrowOnError as f, type DefaultMoreOptions as g, type CallApiParameters as h, definePlugin as i, type PluginHooks as j, type PluginHooksWithMoreOptions as k, getDefaultOptions as l, type RetryOptions as m, type PossibleHTTPError as n, type PossibleJavaScriptError as o, type Hooks as p, type HooksOrHooksArray as q, type RequestContext as r, type RequestErrorContext as s, type RequestStreamContext as t, type ResponseContext as u, type ResponseErrorContext as v, type ResponseStreamContext as w, type SuccessContext as x, type BaseCallApiExtraOptions as y, type CallApiExtraOptions as z };

package/dist/cjs/index.cjs

@@ -629,6 +629,9 @@ var getResponseType = (response, parser) => ({
 });
 var resolveResponseData = async (response, responseType, parser) => {
   const RESPONSE_TYPE_LOOKUP = getResponseType(response, parser);
+  if (!responseType) {
+    return RESPONSE_TYPE_LOOKUP.json();
+  }
   if (!Object.hasOwn(RESPONSE_TYPE_LOOKUP, responseType)) {
     throw new Error(`Invalid response type: ${responseType}`);
   }