npm - @zayne-labs/callapi-plugins - Versions diffs - 4.0.39 → 4.0.41 - Mend

@zayne-labs/callapi-plugins 4.0.39 → 4.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/dist/{index-doc1rAsf.d.ts → index-LJprBgx9.d.ts} +39 -43
package/dist/index.d.ts +1 -1
package/dist/plugins/logger/index.d.ts +1 -1
package/package.json +3 -3

package/dist/{index-doc1rAsf.d.ts → index-LJprBgx9.d.ts} RENAMED Viewed

@@ -1,15 +1,9 @@
 import { AnyFunction } from "@zayne-labs/toolkit-type-helpers";
-//#region ../callapi/dist/validation-Do6HBp6Z.d.ts
+//#region ../callapi/dist/index-CCyp1Rmr.d.ts
 //#region src/constants/common.d.ts
 declare const fetchSpecificKeys: readonly (keyof RequestInit | "duplex")[];
 //#endregion
-//#region src/constants/validation.d.ts
-declare const fallBackRouteSchemaKey = "@default";
-type FallBackRouteSchemaKey = typeof fallBackRouteSchemaKey;
-//#endregion
-//#endregion
-//#region ../callapi/dist/index-DLD315Wj.d.ts
 //#region src/types/type-helpers.d.ts
 type AnyString = string & NonNullable<unknown>;
 type AnyNumber = number & NonNullable<unknown>;
@@ -558,6 +552,10 @@ interface Middlewares<TCallApiContext extends NoInfer<CallApiContext> = DefaultC
   fetchMiddleware?: (context: FetchMiddlewareContext<TCallApiContext>) => FetchImpl;
 }
 //#endregion
+//#region src/constants/validation.d.ts
+declare const fallBackRouteSchemaKey = "@default";
+type FallBackRouteSchemaKey = typeof fallBackRouteSchemaKey;
+//#endregion
 //#region src/types/standard-schema.d.ts
 /**
  * The Standard Schema interface.
@@ -681,40 +679,41 @@ interface CallApiSchemaConfig {
    */
   strict?: boolean;
 }
+type CallApiSchemaType<TInput> = StandardSchemaV1<TInput | undefined> | ((value: TInput) => Awaitable<TInput | undefined>);
 interface CallApiSchema {
-  auth?: StandardSchemaV1<AuthOption | undefined> | ((auth: AuthOption) => Awaitable<AuthOption | undefined>);
+  auth?: CallApiSchemaType<AuthOption>;
   /**
    *  The schema to use for validating the request body.
    */
-  body?: StandardSchemaV1<Body | undefined> | ((body: Body) => Awaitable<Body | undefined>);
+  body?: CallApiSchemaType<Body>;
   /**
    *  The schema to use for validating the response data.
    */
-  data?: StandardSchemaV1 | ((data: unknown) => unknown);
+  data?: CallApiSchemaType<unknown>;
   /**
    *  The schema to use for validating the response error data.
    */
-  errorData?: StandardSchemaV1 | ((errorData: unknown) => unknown);
+  errorData?: CallApiSchemaType<unknown>;
   /**
    *  The schema to use for validating the request headers.
    */
-  headers?: StandardSchemaV1<HeadersOption | undefined> | ((headers: HeadersOption) => Awaitable<HeadersOption | undefined>);
+  headers?: CallApiSchemaType<HeadersOption>;
   /**
    *  The schema to use for validating the meta option.
    */
-  meta?: StandardSchemaV1<GlobalMeta | undefined> | ((meta: GlobalMeta) => Awaitable<GlobalMeta | undefined>);
+  meta?: CallApiSchemaType<GlobalMeta>;
   /**
    *  The schema to use for validating the request method.
    */
-  method?: StandardSchemaV1<MethodUnion | undefined> | ((method: MethodUnion) => Awaitable<MethodUnion | undefined>);
+  method?: CallApiSchemaType<MethodUnion>;
   /**
    *  The schema to use for validating the request url parameters.
    */
-  params?: StandardSchemaV1<Params | undefined> | ((params: Params) => Awaitable<Params | undefined>);
+  params?: CallApiSchemaType<Params>;
   /**
    *  The schema to use for validating the request url queries.
    */
-  query?: StandardSchemaV1<Query | undefined> | ((query: Query) => Awaitable<Query | undefined>);
+  query?: CallApiSchemaType<Query>;
 }
 declare const routeKeyMethods: readonly ["delete", "get", "patch", "post", "put"];
 type RouteKeyMethods = (typeof routeKeyMethods)[number];
@@ -733,7 +732,7 @@ type AllowedQueryParamValues = UnmaskType<boolean | number | string>;
 type RecordStyleParams = UnmaskType<Record<string, AllowedQueryParamValues>>;
 type TupleStyleParams = UnmaskType<AllowedQueryParamValues[]>;
 type Params = UnmaskType<RecordStyleParams | TupleStyleParams>;
-type Query = UnmaskType<Record<string, AllowedQueryParamValues>>;
+type Query = UnmaskType<Record<string, AllowedQueryParamValues> | URLSearchParams>;
 type InitURLOrURLObject = AnyString | RouteKeyMethodsURLUnion | URL;
 interface URLOptions {
   /**
@@ -859,8 +858,8 @@ type ApplyStrictConfig<TSchemaConfig extends CallApiSchemaConfig, TSchemaRouteKe
 // eslint-disable-next-line perfectionist/sort-union-types -- Don't sort union types
 TSchemaRouteKeys | Exclude<InitURLOrURLObject, RouteKeyMethodsURLUnion>;
 type ApplySchemaConfiguration<TSchemaConfig extends CallApiSchemaConfig, TSchemaRouteKeys extends string> = ApplyStrictConfig<TSchemaConfig, ApplyURLBasedConfig<TSchemaConfig, TSchemaRouteKeys>>;
-type InferAllRouteKeys<TBaseSchemaRoutes extends BaseCallApiSchemaRoutes, TSchemaConfig extends CallApiSchemaConfig> = ApplySchemaConfiguration<TSchemaConfig, Exclude<Extract<keyof TBaseSchemaRoutes, string>, FallBackRouteSchemaKey>>;
-type InferInitURL<TBaseSchemaRoutes extends BaseCallApiSchemaRoutes, TSchemaConfig extends CallApiSchemaConfig> = keyof TBaseSchemaRoutes extends never ? InitURLOrURLObject : InferAllRouteKeys<TBaseSchemaRoutes, TSchemaConfig>;
+type InferAllMainRouteKeys<TBaseSchemaRoutes extends BaseCallApiSchemaRoutes, TSchemaConfig extends CallApiSchemaConfig> = ApplySchemaConfiguration<TSchemaConfig, Exclude<Extract<keyof TBaseSchemaRoutes, string>, FallBackRouteSchemaKey>>;
+type InferInitURL<TBaseSchemaRoutes extends BaseCallApiSchemaRoutes, TSchemaConfig extends CallApiSchemaConfig> = keyof TBaseSchemaRoutes extends never ? InitURLOrURLObject : InferAllMainRouteKeys<TBaseSchemaRoutes, TSchemaConfig>;
 type GetCurrentRouteSchema<TBaseSchemaRoutes extends BaseCallApiSchemaRoutes, TCurrentRouteSchemaKey extends string, TComputedFallBackRouteSchema = TBaseSchemaRoutes[FallBackRouteSchemaKey], TComputedCurrentRouteSchema = TBaseSchemaRoutes[TCurrentRouteSchemaKey], TComputedRouteSchema extends CallApiSchema = NonNullable<Omit<TComputedFallBackRouteSchema, keyof TComputedCurrentRouteSchema> & TComputedCurrentRouteSchema>> = TComputedRouteSchema extends CallApiSchema ? Writeable<TComputedRouteSchema, "deep"> : CallApiSchema;
 type JsonPrimitive = boolean | number | string | null | undefined;
 type SerializableObject = Record<PropertyKey, unknown>;
@@ -1088,7 +1087,7 @@ type ValidationErrorDetails = {
    *
    * 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-(${SafeExtract<keyof CallApiSchemaConfig, "strict">})` | keyof CallApiSchema;
+  issueCause: "toFormData" | "toQueryString" | "unknown" | `schemaConfig-(${SafeExtract<keyof CallApiSchemaConfig, "strict">})` | keyof CallApiSchema;
   /**
    * The issues that caused the validation error.
    */
@@ -1130,7 +1129,7 @@ type FetchSpecificKeysUnion = Exclude<(typeof fetchSpecificKeys)[number], "body"
 type ModifiedRequestInit = RequestInit & {
   duplex?: "half";
 };
-type CallApiRequestOptions = Prettify<{
+type CallApiRequestOptions = {
   /**
    * Body of the request, can be a object or any other supported body type.
    */
@@ -1144,7 +1143,7 @@ type CallApiRequestOptions = Prettify<{
    * @default "GET"
    */
   method?: MethodUnion;
-} & Pick<ModifiedRequestInit, FetchSpecificKeysUnion>>;
+} & Pick<ModifiedRequestInit, FetchSpecificKeysUnion>;
 type CallApiRequestOptionsForHooks = Omit<CallApiRequestOptions, "headers"> & {
   headers: Record<string, string | undefined>;
 };
@@ -1174,7 +1173,7 @@ type SharedExtraOptions<TCallApiContext extends CallApiContext = DefaultCallApiC
    * ```ts
    * // Custom form data serialization
    * bodySerializer: (data) => {
-   *   const formData = new URLSearchParams();
+   *   const formData = new FormData();
    *   Object.entries(data).forEach(([key, value]) => {
    *     formData.append(key, String(value));
    *   });
@@ -1277,18 +1276,15 @@ type SharedExtraOptions<TCallApiContext extends CallApiContext = DefaultCallApiC
    */
   defaultHTTPErrorMessage?: string | ((context: Pick<HTTPError<TErrorData>, "errorData" | "response">) => string);
   /**
-   * Forces calculation of total byte size from request/response body streams.
+   * Forces calculation of total byte size from request body streams.
    *
    * Useful when the Content-Length header is missing or incorrect, and you need
-   * accurate size information for progress tracking or bandwidth monitoring.
+   * accurate size information for progress tracking.
    *
    * @default false
    *
    */
-  forcefullyCalculateStreamSize?: boolean | {
-    request?: boolean;
-    response?: boolean;
-  };
+  forcefullyCalculateRequestStreamSize?: boolean;
   /**
    * Optional metadata field for associating additional information with requests.
    *
@@ -1339,20 +1335,20 @@ type SharedExtraOptions<TCallApiContext extends CallApiContext = DefaultCallApiC
    *
    * @example
    * ```ts
-   * responseParser: (responseString) => {
-   *   return JSON.parse(responseString);
+   * responseParser: (text) => {
+   *   return JSON.parse(text);
    * }
    *
    * // Parse XML responses
-   * responseParser: (responseString) => {
+   * responseParser: (text) => {
    *   const parser = new DOMParser();
-   *   const doc = parser.parseFromString(responseString, "text/xml");
+   *   const doc = parser.parseFromString(text, "text/xml");
    *   return xmlToObject(doc);
    * }
    *
    * // Parse CSV responses
-   * responseParser: (responseString) => {
-   *   const lines = responseString.split('\n');
+   * responseParser: (text) => {
+   *   const lines = text.split('\n');
    *   const headers = lines[0].split(',');
    *   const data = lines.slice(1).map(line => {
    *     const values = line.split(',');
@@ -1366,7 +1362,7 @@ type SharedExtraOptions<TCallApiContext extends CallApiContext = DefaultCallApiC
    *
    * ```
    */
-  responseParser?: (responseString: string) => Awaitable<TData>;
+  responseParser?: ResponseParser<TData>;
   /**
    * Expected response type, determines how the response body is parsed.
    *
@@ -1676,16 +1672,16 @@ type BaseCallApiConfig<TBaseCallApiContext extends CallApiContext = DefaultCallA
 type CallApiConfig<TCallApiContext extends CallApiContext = DefaultCallApiContext, TData = DefaultDataType, TErrorData = DefaultDataType, TResultMode extends ResultModeType = ResultModeType, TThrowOnError extends ThrowOnErrorUnion = DefaultThrowOnError, TResponseType extends ResponseTypeType = ResponseTypeType, TBaseSchemaRoutes extends BaseCallApiSchemaRoutes = BaseCallApiSchemaRoutes, TSchema extends CallApiSchema = CallApiSchema, TBaseSchemaConfig extends CallApiSchemaConfig = CallApiSchemaConfig, TSchemaConfig extends CallApiSchemaConfig = CallApiSchemaConfig, TInitURL extends InitURLOrURLObject = InitURLOrURLObject, TCurrentRouteSchemaKey extends string = string, TBasePluginArray extends CallApiPlugin[] = DefaultPluginArray, TPluginArray extends CallApiPlugin[] = DefaultPluginArray> = InferExtraOptions<TSchema, TBaseSchemaRoutes, TCurrentRouteSchemaKey, TCallApiContext> & InferRequestOptions<TSchema, TInitURL> & Omit<CallApiExtraOptions<TCallApiContext, TData, TErrorData, TResultMode, TThrowOnError, TResponseType, TBasePluginArray, TPluginArray, TBaseSchemaRoutes, TSchema, TBaseSchemaConfig, TSchemaConfig, TCurrentRouteSchemaKey>, keyof InferExtraOptions<CallApiSchema, BaseCallApiSchemaRoutes, string, CallApiContext>> & Omit<CallApiRequestOptions, keyof InferRequestOptions<CallApiSchema, string>>;
 //#endregion
 //#region src/result.d.ts
-type Parser<TData> = (responseString: string) => Awaitable<TData>;
-declare const getResponseType: <TResponse>(response: Response, parser: Parser<TResponse>) => {
+type ResponseParser<TData> = (text: string) => Awaitable<TData>;
+declare const getResponseType: <TData>(response: Response, responseParser: ResponseParser<TData>) => {
   arrayBuffer: () => Promise<ArrayBuffer>;
   blob: () => Promise<Blob>;
   formData: () => Promise<FormData>;
-  json: () => Promise<TResponse>;
+  json: () => Promise<TData>;
   stream: () => ReadableStream<Uint8Array<ArrayBuffer>> | null;
   text: () => Promise<string>;
 };
-type InitResponseTypeMap<TResponse = unknown> = ReturnType<typeof getResponseType<TResponse>>;
+type InitResponseTypeMap<TData = unknown> = ReturnType<typeof getResponseType<TData>>;
 type ResponseTypeUnion = keyof InitResponseTypeMap;
 type ResponseTypePlaceholder = null;
 type ResponseTypeType = ResponseTypePlaceholder | ResponseTypeUnion;
@@ -1766,7 +1762,7 @@ interface CallApiPlugin<TCallApiContext extends CallApiContext = DefaultCallApiC
   /**
    * Hooks for the plugin
    */
-  hooks?: PluginHooks<TCallApiContext> | ((context: PluginSetupContext<TCallApiContext>) => Awaitable<PluginHooks<TCallApiContext>>);
+  hooks?: PluginHooks<TCallApiContext> | ((context: PluginSetupContext<TCallApiContext>) => Awaitable<PluginHooks<TCallApiContext>> | Awaitable<void>);
   /**
    *  A unique id for the plugin
    */
@@ -1774,7 +1770,7 @@ interface CallApiPlugin<TCallApiContext extends CallApiContext = DefaultCallApiC
   /**
    * Middlewares that for the plugin
    */
-  middlewares?: PluginMiddlewares<TCallApiContext> | ((context: PluginSetupContext<TCallApiContext>) => Awaitable<PluginMiddlewares<TCallApiContext>>);
+  middlewares?: PluginMiddlewares<TCallApiContext> | ((context: PluginSetupContext<TCallApiContext>) => Awaitable<PluginMiddlewares<TCallApiContext>> | Awaitable<void>);
   /**
    * A name for the plugin
    */
@@ -1929,4 +1925,4 @@ declare const loggerPlugin: (options?: LoggerOptions) => {
 };
 //#endregion
 export { defaultConsoleObject as n, loggerPlugin as r, LoggerOptions as t };
-//# sourceMappingURL=index-doc1rAsf.d.ts.map
+//# sourceMappingURL=index-LJprBgx9.d.ts.map

package/dist/index.d.ts CHANGED Viewed

@@ -1,2 +1,2 @@
-import { n as defaultConsoleObject, r as loggerPlugin, t as LoggerOptions } from "./index-doc1rAsf.js";
+import { n as defaultConsoleObject, r as loggerPlugin, t as LoggerOptions } from "./index-LJprBgx9.js";
 export { LoggerOptions, defaultConsoleObject, loggerPlugin };

package/dist/plugins/logger/index.d.ts CHANGED Viewed

@@ -1,2 +1,2 @@
-import { n as defaultConsoleObject, r as loggerPlugin, t as LoggerOptions } from "../../index-doc1rAsf.js";
+import { n as defaultConsoleObject, r as loggerPlugin, t as LoggerOptions } from "../../index-LJprBgx9.js";
 export { LoggerOptions, defaultConsoleObject, loggerPlugin };

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@zayne-labs/callapi-plugins",
   "type": "module",
-  "version": "4.0.39",
+  "version": "4.0.41",
   "description": "A collection of plugins for callapi",
   "author": "Ryan Zayne",
   "license": "MIT",
@@ -24,7 +24,7 @@
   "peerDependencies": {
     "@zayne-labs/toolkit-type-helpers": ">=0.11.17",
     "consola": "3.x.x",
-    "@zayne-labs/callapi": "1.11.39"
+    "@zayne-labs/callapi": "1.11.41"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",
@@ -41,7 +41,7 @@
     "tsdown": "0.19.0-beta.3",
     "typescript": "5.9.3",
     "vitest": "^4.0.16",
-    "@zayne-labs/callapi": "1.11.39"
+    "@zayne-labs/callapi": "1.11.41"
   },
   "publishConfig": {
     "access": "public",