@spoosh/core 0.9.3 → 0.10.0

package/README.md

@@ -2,7 +2,7 @@
 
 Core client and plugin system for Spoosh - a type-safe API client framework.
 
-**[Documentation](https://spoosh.dev/docs)** · **Requirements:** TypeScript >= 5.0
+**[Documentation](https://spoosh.dev/docs/react)** · **Requirements:** TypeScript >= 5.0
 
 ## Installation
 

package/dist/index.d.mts

@@ -72,6 +72,24 @@ declare function resolveRequestBody(rawBody: unknown): {
     headers?: Record<string, string>;
 } | undefined;
 
+interface TransportResponse {
+    ok: boolean;
+    status: number;
+    headers: Headers;
+    data: unknown;
+}
+type Transport<TOptions = unknown> = (url: string, init: RequestInit, options?: TOptions) => Promise<TransportResponse>;
+/**
+ * Transport layer used for requests.
+ *
+ * - `"fetch"` — Uses the Fetch API (default).
+ * - `"xhr"` — Uses XMLHttpRequest. Required for upload/download progress tracking.
+ */
+type TransportOption = "fetch" | "xhr";
+interface TransportOptionsMap {
+    fetch: never;
+}
+
 type RetryConfig = {
     retries?: number | false;
     retryDelay?: number;
@@ -79,7 +97,26 @@ type RetryConfig = {
 type HeadersInitOrGetter = HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
 type SpooshOptions = Omit<RequestInit, "method" | "body" | "headers"> & {
     headers?: HeadersInitOrGetter;
+    /** Default transport for all requests. */
+    transport?: TransportOption;
 };
+type FetchOnlyInitKeys = "mode" | "cache" | "integrity" | "keepalive" | "next" | "priority" | "redirect" | "referrer" | "referrerPolicy" | "window";
+type SharedSpooshOptions = Omit<RequestInit, "signal" | "method" | "body" | "headers" | FetchOnlyInitKeys> & {
+    headers?: HeadersInitOrGetter;
+};
+type SpooshFetchOptions = SharedSpooshOptions & Pick<RequestInit, Extract<keyof RequestInit, FetchOnlyInitKeys>> & {
+    transport?: "fetch";
+};
+type SpooshXhrOptions = SharedSpooshOptions & {
+    transport: "xhr";
+};
+/**
+ * Constructor-level options with transport-aware type narrowing.
+ *
+ * When `transport` is `"xhr"`, fetch-only fields (e.g. `mode`, `cache`, `redirect`) are
+ * excluded from autocomplete since they have no effect on XMLHttpRequest.
+ */
+type SpooshOptionsInput = SpooshFetchOptions | SpooshXhrOptions;
 type BaseRequestOptions$1 = {
     headers?: HeadersInitOrGetter;
     cache?: RequestCache;
@@ -101,6 +138,10 @@ type AnyRequestOptions = BaseRequestOptions$1 & {
     query?: Record<string, string | number | boolean | undefined>;
     params?: Record<string, string | number>;
     signal?: AbortSignal;
+    /** Per-request transport override. */
+    transport?: TransportOption;
+    /** Transport-specific options passed through to the transport function. */
+    transportOptions?: unknown;
 } & Partial<RetryConfig>;
 type DynamicParamsOption = {
     params?: Record<string, string | number>;
@@ -728,7 +769,7 @@ declare function createPluginRegistry<TPlugins extends SpooshPlugin<PluginTypeCo
 type ApiSchema = {
     [path: string]: {
         [method in HttpMethod]?: {
-            data: unknown;
+            data?: unknown;
             body?: unknown;
             query?: unknown;
             error?: unknown;
@@ -740,7 +781,7 @@ type ApiSchema = {
  */
 type ExtractData<T> = T extends {
     data: infer D;
-} ? D : never;
+} ? D : void;
 /**
  * Extract body type from an endpoint.
  */
@@ -1136,7 +1177,7 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
      * Creates a new Spoosh instance.
      *
      * @param baseUrl - The base URL for all API requests (e.g., '/api' or 'https://api.example.com')
-     * @param defaultOptions - Optional default options applied to all requests (headers, credentials, etc.)
+     * @param defaultOptions - Optional default options applied to all requests (headers, credentials, transport, etc.)
      * @param plugins - Internal parameter used by the `.use()` method. Do not pass directly.
      *
      * @example
@@ -1148,9 +1189,15 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
      * const client = new Spoosh<ApiSchema, Error>('/api', {
      *   headers: { 'X-API-Key': 'secret' }
      * });
+     *
+     * // With XHR transport (narrows available options to XHR-compatible fields)
+     * const client = new Spoosh<ApiSchema, Error>('/api', {
+     *   transport: 'xhr',
+     *   credentials: 'include',
+     * });
      * ```
      */
-    constructor(baseUrl: string, defaultOptions?: SpooshOptions, plugins?: TPlugins);
+    constructor(baseUrl: string, defaultOptions?: SpooshOptionsInput, plugins?: TPlugins);
     /**
      * Adds plugins to the Spoosh instance.
      *
@@ -1301,7 +1348,7 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
 
 type SpooshClientConfig = {
     baseUrl: string;
-    defaultOptions?: SpooshOptions;
+    defaultOptions?: SpooshOptionsInput;
     middlewares?: SpooshMiddleware[];
 };
 /**
@@ -1339,6 +1386,12 @@ type SpooshClientConfig = {
  * const { data } = await api("posts").GET();
  * const { data: post } = await api("posts/123").GET();
  * await api("posts/:id").GET({ params: { id: 123 } });
+ *
+ * // With XHR transport
+ * const api = createClient<ApiSchema, ApiError>({
+ *   baseUrl: "/api",
+ *   defaultOptions: { transport: "xhr" },
+ * });
  * ```
  */
 declare function createClient<TSchema, TDefaultError = unknown>(config: SpooshClientConfig): SpooshClient<TSchema, TDefaultError>;
@@ -1527,6 +1580,19 @@ declare function extractPathFromSelector(fn: unknown): string;
  */
 declare function extractMethodFromSelector(fn: unknown): string | undefined;
 
+declare const fetchTransport: Transport;
+
+interface XhrTransportOptions {
+    /** Called on upload and download progress events. */
+    onProgress?: (event: ProgressEvent, xhr: XMLHttpRequest) => void;
+}
+declare module "./types" {
+    interface TransportOptionsMap {
+        xhr: XhrTransportOptions;
+    }
+}
+declare const xhrTransport: Transport<XhrTransportOptions>;
+
 declare function executeFetch<TData, TError>(baseUrl: string, path: string[], method: HttpMethod, defaultOptions: SpooshOptions & SpooshOptionsExtra, requestOptions?: AnyRequestOptions, nextTags?: boolean): Promise<SpooshResponse<TData, TError>>;
 
 declare function createMiddleware<TData = unknown, TError = unknown>(name: string, phase: MiddlewarePhase, handler: SpooshMiddleware<TData, TError>["handler"]): SpooshMiddleware<TData, TError>;
@@ -1621,4 +1687,4 @@ type CreateInfiniteReadOptions<TData, TItem, TError, TRequest> = {
 };
 declare function createInfiniteReadController<TData, TItem, TError, TRequest extends InfiniteRequestOptions = InfiniteRequestOptions>(options: CreateInfiniteReadOptions<TData, TItem, TError, TRequest>): InfiniteReadController<TData, TItem, TError>;
 
-export { type AnyRequestOptions, type ApiSchema, type BuiltInEvents, type CacheEntry, type CacheEntryWithKey, type CapturedCall, type SpooshClientConfig as ClientConfig, type ComputeRequestOptions, type CoreRequestOptionsBase, type CreateInfiniteReadOptions, type CreateOperationOptions, type DataAwareCallback, type DataAwareTransform, type EventEmitter, type ExtractBody$1 as ExtractBody, type ExtractData, type ExtractError, type ExtractMethodOptions, type ExtractParamNames, type ExtractQuery$1 as ExtractQuery, type FetchDirection, type FetchExecutor, type FindMatchingKey, HTTP_METHODS, type HasParams, type HasReadMethod, type HasWriteMethod, type HeadersInitOrGetter, type HttpMethod, type HttpMethodKey, type InfiniteReadController, type InfiniteReadState, type InfiniteRequestOptions, type InstanceApiContext, type InstanceApiResolvers, type InstancePluginExecutor, type LifecyclePhase, type MergePluginInstanceApi, type MergePluginOptions, type MergePluginResults, type MethodOptionsMap, type MiddlewareContext, type MiddlewareHandler, type MiddlewarePhase, type OperationController, type OperationState, type OperationType, type PageContext, type PluginAccessor, type PluginArray, type PluginContext, type PluginContextInput, type PluginExecutor, type PluginExportsRegistry, type PluginFactory, type PluginHandler, type PluginLifecycle, type PluginMiddleware, type PluginRegistry, type PluginResolvers, type PluginResponseHandler, type PluginResultResolvers, type PluginTypeConfig, type PluginUpdateHandler, type ReadClient, type ReadPaths, type ReadSchemaHelper, type RefetchEvent, type RequestOptions$1 as RequestOptions, type ResolveInstanceApi, type ResolveResultTypes, type ResolveSchemaTypes, type ResolveTypes, type ResolverContext, type RetryConfig, type SchemaPaths, type SelectedEndpoint, type SelectorFunction, type SelectorResult, type Simplify, Spoosh, type SpooshBody, type SpooshClient, type SpooshConfig, type SpooshInstance, type SpooshMiddleware, type SpooshOptions, type SpooshOptionsExtra, type SpooshPlugin, type SpooshResponse, type SpooshSchema, type StateManager, type StripPrefix, type TagMode, type TagOptions, type WriteClient, type WriteMethod, type WritePaths, type WriteSchemaHelper, __DEV__, applyMiddlewares, buildUrl, composeMiddlewares, containsFile, createClient, createEventEmitter, createInfiniteReadController, createInitialState, createMiddleware, createOperationController, createPluginExecutor, createPluginRegistry, createProxyHandler, createSelectorProxy, createStateManager, executeFetch, extractMethodFromSelector, extractPathFromSelector, form, generateTags, getContentType, isJsonBody, isSpooshBody, json, mergeHeaders, objectToFormData, objectToUrlEncoded, resolveHeadersToRecord, resolvePath, resolveRequestBody, resolveTags, setHeaders, sortObjectKeys, urlencoded };
+export { type AnyRequestOptions, type ApiSchema, type BuiltInEvents, type CacheEntry, type CacheEntryWithKey, type CapturedCall, type SpooshClientConfig as ClientConfig, type ComputeRequestOptions, type CoreRequestOptionsBase, type CreateInfiniteReadOptions, type CreateOperationOptions, type DataAwareCallback, type DataAwareTransform, type EventEmitter, type ExtractBody$1 as ExtractBody, type ExtractData, type ExtractError, type ExtractMethodOptions, type ExtractParamNames, type ExtractQuery$1 as ExtractQuery, type FetchDirection, type FetchExecutor, type FindMatchingKey, HTTP_METHODS, type HasParams, type HasReadMethod, type HasWriteMethod, type HeadersInitOrGetter, type HttpMethod, type HttpMethodKey, type InfiniteReadController, type InfiniteReadState, type InfiniteRequestOptions, type InstanceApiContext, type InstanceApiResolvers, type InstancePluginExecutor, type LifecyclePhase, type MergePluginInstanceApi, type MergePluginOptions, type MergePluginResults, type MethodOptionsMap, type MiddlewareContext, type MiddlewareHandler, type MiddlewarePhase, type OperationController, type OperationState, type OperationType, type PageContext, type PluginAccessor, type PluginArray, type PluginContext, type PluginContextInput, type PluginExecutor, type PluginExportsRegistry, type PluginFactory, type PluginHandler, type PluginLifecycle, type PluginMiddleware, type PluginRegistry, type PluginResolvers, type PluginResponseHandler, type PluginResultResolvers, type PluginTypeConfig, type PluginUpdateHandler, type ReadClient, type ReadPaths, type ReadSchemaHelper, type RefetchEvent, type RequestOptions$1 as RequestOptions, type ResolveInstanceApi, type ResolveResultTypes, type ResolveSchemaTypes, type ResolveTypes, type ResolverContext, type RetryConfig, type SchemaPaths, type SelectedEndpoint, type SelectorFunction, type SelectorResult, type Simplify, Spoosh, type SpooshBody, type SpooshClient, type SpooshConfig, type SpooshInstance, type SpooshMiddleware, type SpooshOptions, type SpooshOptionsExtra, type SpooshOptionsInput, type SpooshPlugin, type SpooshResponse, type SpooshSchema, type StateManager, type StripPrefix, type TagMode, type TagOptions, type Transport, type TransportOption, type TransportOptionsMap, type TransportResponse, type WriteClient, type WriteMethod, type WritePaths, type WriteSchemaHelper, __DEV__, applyMiddlewares, buildUrl, composeMiddlewares, containsFile, createClient, createEventEmitter, createInfiniteReadController, createInitialState, createMiddleware, createOperationController, createPluginExecutor, createPluginRegistry, createProxyHandler, createSelectorProxy, createStateManager, executeFetch, extractMethodFromSelector, extractPathFromSelector, fetchTransport, form, generateTags, getContentType, isJsonBody, isSpooshBody, json, mergeHeaders, objectToFormData, objectToUrlEncoded, resolveHeadersToRecord, resolvePath, resolveRequestBody, resolveTags, setHeaders, sortObjectKeys, urlencoded, xhrTransport };

package/dist/index.d.ts

@@ -72,6 +72,24 @@ declare function resolveRequestBody(rawBody: unknown): {
     headers?: Record<string, string>;
 } | undefined;
 
+interface TransportResponse {
+    ok: boolean;
+    status: number;
+    headers: Headers;
+    data: unknown;
+}
+type Transport<TOptions = unknown> = (url: string, init: RequestInit, options?: TOptions) => Promise<TransportResponse>;
+/**
+ * Transport layer used for requests.
+ *
+ * - `"fetch"` — Uses the Fetch API (default).
+ * - `"xhr"` — Uses XMLHttpRequest. Required for upload/download progress tracking.
+ */
+type TransportOption = "fetch" | "xhr";
+interface TransportOptionsMap {
+    fetch: never;
+}
+
 type RetryConfig = {
     retries?: number | false;
     retryDelay?: number;
@@ -79,7 +97,26 @@ type RetryConfig = {
 type HeadersInitOrGetter = HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
 type SpooshOptions = Omit<RequestInit, "method" | "body" | "headers"> & {
     headers?: HeadersInitOrGetter;
+    /** Default transport for all requests. */
+    transport?: TransportOption;
 };
+type FetchOnlyInitKeys = "mode" | "cache" | "integrity" | "keepalive" | "next" | "priority" | "redirect" | "referrer" | "referrerPolicy" | "window";
+type SharedSpooshOptions = Omit<RequestInit, "signal" | "method" | "body" | "headers" | FetchOnlyInitKeys> & {
+    headers?: HeadersInitOrGetter;
+};
+type SpooshFetchOptions = SharedSpooshOptions & Pick<RequestInit, Extract<keyof RequestInit, FetchOnlyInitKeys>> & {
+    transport?: "fetch";
+};
+type SpooshXhrOptions = SharedSpooshOptions & {
+    transport: "xhr";
+};
+/**
+ * Constructor-level options with transport-aware type narrowing.
+ *
+ * When `transport` is `"xhr"`, fetch-only fields (e.g. `mode`, `cache`, `redirect`) are
+ * excluded from autocomplete since they have no effect on XMLHttpRequest.
+ */
+type SpooshOptionsInput = SpooshFetchOptions | SpooshXhrOptions;
 type BaseRequestOptions$1 = {
     headers?: HeadersInitOrGetter;
     cache?: RequestCache;
@@ -101,6 +138,10 @@ type AnyRequestOptions = BaseRequestOptions$1 & {
     query?: Record<string, string | number | boolean | undefined>;
     params?: Record<string, string | number>;
     signal?: AbortSignal;
+    /** Per-request transport override. */
+    transport?: TransportOption;
+    /** Transport-specific options passed through to the transport function. */
+    transportOptions?: unknown;
 } & Partial<RetryConfig>;
 type DynamicParamsOption = {
     params?: Record<string, string | number>;
@@ -728,7 +769,7 @@ declare function createPluginRegistry<TPlugins extends SpooshPlugin<PluginTypeCo
 type ApiSchema = {
     [path: string]: {
         [method in HttpMethod]?: {
-            data: unknown;
+            data?: unknown;
             body?: unknown;
             query?: unknown;
             error?: unknown;
@@ -740,7 +781,7 @@ type ApiSchema = {
  */
 type ExtractData<T> = T extends {
     data: infer D;
-} ? D : never;
+} ? D : void;
 /**
  * Extract body type from an endpoint.
  */
@@ -1136,7 +1177,7 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
      * Creates a new Spoosh instance.
      *
      * @param baseUrl - The base URL for all API requests (e.g., '/api' or 'https://api.example.com')
-     * @param defaultOptions - Optional default options applied to all requests (headers, credentials, etc.)
+     * @param defaultOptions - Optional default options applied to all requests (headers, credentials, transport, etc.)
      * @param plugins - Internal parameter used by the `.use()` method. Do not pass directly.
      *
      * @example
@@ -1148,9 +1189,15 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
      * const client = new Spoosh<ApiSchema, Error>('/api', {
      *   headers: { 'X-API-Key': 'secret' }
      * });
+     *
+     * // With XHR transport (narrows available options to XHR-compatible fields)
+     * const client = new Spoosh<ApiSchema, Error>('/api', {
+     *   transport: 'xhr',
+     *   credentials: 'include',
+     * });
      * ```
      */
-    constructor(baseUrl: string, defaultOptions?: SpooshOptions, plugins?: TPlugins);
+    constructor(baseUrl: string, defaultOptions?: SpooshOptionsInput, plugins?: TPlugins);
     /**
      * Adds plugins to the Spoosh instance.
      *
@@ -1301,7 +1348,7 @@ declare class Spoosh<TSchema = unknown, TError = unknown, TPlugins extends Plugi
 
 type SpooshClientConfig = {
     baseUrl: string;
-    defaultOptions?: SpooshOptions;
+    defaultOptions?: SpooshOptionsInput;
     middlewares?: SpooshMiddleware[];
 };
 /**
@@ -1339,6 +1386,12 @@ type SpooshClientConfig = {
  * const { data } = await api("posts").GET();
  * const { data: post } = await api("posts/123").GET();
  * await api("posts/:id").GET({ params: { id: 123 } });
+ *
+ * // With XHR transport
+ * const api = createClient<ApiSchema, ApiError>({
+ *   baseUrl: "/api",
+ *   defaultOptions: { transport: "xhr" },
+ * });
  * ```
  */
 declare function createClient<TSchema, TDefaultError = unknown>(config: SpooshClientConfig): SpooshClient<TSchema, TDefaultError>;
@@ -1527,6 +1580,19 @@ declare function extractPathFromSelector(fn: unknown): string;
  */
 declare function extractMethodFromSelector(fn: unknown): string | undefined;
 
+declare const fetchTransport: Transport;
+
+interface XhrTransportOptions {
+    /** Called on upload and download progress events. */
+    onProgress?: (event: ProgressEvent, xhr: XMLHttpRequest) => void;
+}
+declare module "./types" {
+    interface TransportOptionsMap {
+        xhr: XhrTransportOptions;
+    }
+}
+declare const xhrTransport: Transport<XhrTransportOptions>;
+
 declare function executeFetch<TData, TError>(baseUrl: string, path: string[], method: HttpMethod, defaultOptions: SpooshOptions & SpooshOptionsExtra, requestOptions?: AnyRequestOptions, nextTags?: boolean): Promise<SpooshResponse<TData, TError>>;
 
 declare function createMiddleware<TData = unknown, TError = unknown>(name: string, phase: MiddlewarePhase, handler: SpooshMiddleware<TData, TError>["handler"]): SpooshMiddleware<TData, TError>;
@@ -1621,4 +1687,4 @@ type CreateInfiniteReadOptions<TData, TItem, TError, TRequest> = {
 };
 declare function createInfiniteReadController<TData, TItem, TError, TRequest extends InfiniteRequestOptions = InfiniteRequestOptions>(options: CreateInfiniteReadOptions<TData, TItem, TError, TRequest>): InfiniteReadController<TData, TItem, TError>;
 
-export { type AnyRequestOptions, type ApiSchema, type BuiltInEvents, type CacheEntry, type CacheEntryWithKey, type CapturedCall, type SpooshClientConfig as ClientConfig, type ComputeRequestOptions, type CoreRequestOptionsBase, type CreateInfiniteReadOptions, type CreateOperationOptions, type DataAwareCallback, type DataAwareTransform, type EventEmitter, type ExtractBody$1 as ExtractBody, type ExtractData, type ExtractError, type ExtractMethodOptions, type ExtractParamNames, type ExtractQuery$1 as ExtractQuery, type FetchDirection, type FetchExecutor, type FindMatchingKey, HTTP_METHODS, type HasParams, type HasReadMethod, type HasWriteMethod, type HeadersInitOrGetter, type HttpMethod, type HttpMethodKey, type InfiniteReadController, type InfiniteReadState, type InfiniteRequestOptions, type InstanceApiContext, type InstanceApiResolvers, type InstancePluginExecutor, type LifecyclePhase, type MergePluginInstanceApi, type MergePluginOptions, type MergePluginResults, type MethodOptionsMap, type MiddlewareContext, type MiddlewareHandler, type MiddlewarePhase, type OperationController, type OperationState, type OperationType, type PageContext, type PluginAccessor, type PluginArray, type PluginContext, type PluginContextInput, type PluginExecutor, type PluginExportsRegistry, type PluginFactory, type PluginHandler, type PluginLifecycle, type PluginMiddleware, type PluginRegistry, type PluginResolvers, type PluginResponseHandler, type PluginResultResolvers, type PluginTypeConfig, type PluginUpdateHandler, type ReadClient, type ReadPaths, type ReadSchemaHelper, type RefetchEvent, type RequestOptions$1 as RequestOptions, type ResolveInstanceApi, type ResolveResultTypes, type ResolveSchemaTypes, type ResolveTypes, type ResolverContext, type RetryConfig, type SchemaPaths, type SelectedEndpoint, type SelectorFunction, type SelectorResult, type Simplify, Spoosh, type SpooshBody, type SpooshClient, type SpooshConfig, type SpooshInstance, type SpooshMiddleware, type SpooshOptions, type SpooshOptionsExtra, type SpooshPlugin, type SpooshResponse, type SpooshSchema, type StateManager, type StripPrefix, type TagMode, type TagOptions, type WriteClient, type WriteMethod, type WritePaths, type WriteSchemaHelper, __DEV__, applyMiddlewares, buildUrl, composeMiddlewares, containsFile, createClient, createEventEmitter, createInfiniteReadController, createInitialState, createMiddleware, createOperationController, createPluginExecutor, createPluginRegistry, createProxyHandler, createSelectorProxy, createStateManager, executeFetch, extractMethodFromSelector, extractPathFromSelector, form, generateTags, getContentType, isJsonBody, isSpooshBody, json, mergeHeaders, objectToFormData, objectToUrlEncoded, resolveHeadersToRecord, resolvePath, resolveRequestBody, resolveTags, setHeaders, sortObjectKeys, urlencoded };
+export { type AnyRequestOptions, type ApiSchema, type BuiltInEvents, type CacheEntry, type CacheEntryWithKey, type CapturedCall, type SpooshClientConfig as ClientConfig, type ComputeRequestOptions, type CoreRequestOptionsBase, type CreateInfiniteReadOptions, type CreateOperationOptions, type DataAwareCallback, type DataAwareTransform, type EventEmitter, type ExtractBody$1 as ExtractBody, type ExtractData, type ExtractError, type ExtractMethodOptions, type ExtractParamNames, type ExtractQuery$1 as ExtractQuery, type FetchDirection, type FetchExecutor, type FindMatchingKey, HTTP_METHODS, type HasParams, type HasReadMethod, type HasWriteMethod, type HeadersInitOrGetter, type HttpMethod, type HttpMethodKey, type InfiniteReadController, type InfiniteReadState, type InfiniteRequestOptions, type InstanceApiContext, type InstanceApiResolvers, type InstancePluginExecutor, type LifecyclePhase, type MergePluginInstanceApi, type MergePluginOptions, type MergePluginResults, type MethodOptionsMap, type MiddlewareContext, type MiddlewareHandler, type MiddlewarePhase, type OperationController, type OperationState, type OperationType, type PageContext, type PluginAccessor, type PluginArray, type PluginContext, type PluginContextInput, type PluginExecutor, type PluginExportsRegistry, type PluginFactory, type PluginHandler, type PluginLifecycle, type PluginMiddleware, type PluginRegistry, type PluginResolvers, type PluginResponseHandler, type PluginResultResolvers, type PluginTypeConfig, type PluginUpdateHandler, type ReadClient, type ReadPaths, type ReadSchemaHelper, type RefetchEvent, type RequestOptions$1 as RequestOptions, type ResolveInstanceApi, type ResolveResultTypes, type ResolveSchemaTypes, type ResolveTypes, type ResolverContext, type RetryConfig, type SchemaPaths, type SelectedEndpoint, type SelectorFunction, type SelectorResult, type Simplify, Spoosh, type SpooshBody, type SpooshClient, type SpooshConfig, type SpooshInstance, type SpooshMiddleware, type SpooshOptions, type SpooshOptionsExtra, type SpooshOptionsInput, type SpooshPlugin, type SpooshResponse, type SpooshSchema, type StateManager, type StripPrefix, type TagMode, type TagOptions, type Transport, type TransportOption, type TransportOptionsMap, type TransportResponse, type WriteClient, type WriteMethod, type WritePaths, type WriteSchemaHelper, __DEV__, applyMiddlewares, buildUrl, composeMiddlewares, containsFile, createClient, createEventEmitter, createInfiniteReadController, createInitialState, createMiddleware, createOperationController, createPluginExecutor, createPluginRegistry, createProxyHandler, createSelectorProxy, createStateManager, executeFetch, extractMethodFromSelector, extractPathFromSelector, fetchTransport, form, generateTags, getContentType, isJsonBody, isSpooshBody, json, mergeHeaders, objectToFormData, objectToUrlEncoded, resolveHeadersToRecord, resolvePath, resolveRequestBody, resolveTags, setHeaders, sortObjectKeys, urlencoded, xhrTransport };

package/dist/index.js

@@ -41,6 +41,7 @@ __export(src_exports, {
   executeFetch: () => executeFetch,
   extractMethodFromSelector: () => extractMethodFromSelector,
   extractPathFromSelector: () => extractPathFromSelector,
+  fetchTransport: () => fetchTransport,
   form: () => form,
   generateTags: () => generateTags,
   getContentType: () => getContentType,
@@ -56,7 +57,8 @@ __export(src_exports, {
   resolveTags: () => resolveTags,
   setHeaders: () => setHeaders,
   sortObjectKeys: () => sortObjectKeys,
-  urlencoded: () => urlencoded
+  urlencoded: () => urlencoded,
+  xhrTransport: () => xhrTransport
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -368,6 +370,87 @@ function resolvePath(path, params) {
   });
 }
 
+// src/transport/fetch.ts
+var fetchTransport = async (url, init) => {
+  const res = await fetch(url, init);
+  const contentType = res.headers.get("content-type");
+  const isJson = contentType?.includes("application/json");
+  const data = isJson ? await res.json() : res;
+  return { ok: res.ok, status: res.status, headers: res.headers, data };
+};
+
+// src/transport/xhr.ts
+var xhrTransport = (url, init, options) => {
+  return new Promise((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    xhr.open(init.method ?? "GET", url);
+    if (init.headers) {
+      const headers = init.headers instanceof Headers ? init.headers : new Headers(init.headers);
+      headers.forEach((value, key) => {
+        xhr.setRequestHeader(key, value);
+      });
+    }
+    if (init.credentials === "include") {
+      xhr.withCredentials = true;
+    }
+    const onAbort = () => xhr.abort();
+    if (init.signal) {
+      if (init.signal.aborted) {
+        xhr.abort();
+        return;
+      }
+      init.signal.addEventListener("abort", onAbort);
+    }
+    const cleanup = () => {
+      init.signal?.removeEventListener("abort", onAbort);
+    };
+    if (options?.onProgress) {
+      xhr.upload.addEventListener("progress", (event) => {
+        options.onProgress(event, xhr);
+      });
+      xhr.addEventListener("progress", (event) => {
+        options.onProgress(event, xhr);
+      });
+    }
+    xhr.addEventListener("load", () => {
+      cleanup();
+      const status = xhr.status;
+      const ok = status >= 200 && status < 300;
+      const responseHeaders = new Headers();
+      const rawHeaders = xhr.getAllResponseHeaders().trim();
+      if (rawHeaders) {
+        rawHeaders.split("\r\n").forEach((line) => {
+          const idx = line.indexOf(": ");
+          if (idx > 0) {
+            responseHeaders.append(
+              line.substring(0, idx),
+              line.substring(idx + 2)
+            );
+          }
+        });
+      }
+      const contentType = responseHeaders.get("content-type");
+      const isJson = contentType?.includes("application/json");
+      let data;
+      try {
+        data = isJson ? JSON.parse(xhr.responseText) : xhr.responseText;
+      } catch {
+        data = xhr.responseText;
+      }
+      resolve({ ok, status, headers: responseHeaders, data });
+    });
+    xhr.addEventListener("error", () => {
+      cleanup();
+      reject(new TypeError("Network request failed"));
+    });
+    xhr.addEventListener("abort", () => {
+      cleanup();
+      reject(new DOMException("Aborted", "AbortError"));
+    });
+    xhr.send(init.body);
+  });
+};
+
 // src/fetch.ts
 var delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 var isNetworkError = (err) => err instanceof TypeError;
@@ -416,6 +499,12 @@ function buildInputFields(requestOptions) {
   }
   return { input: fields };
 }
+function resolveTransport(option) {
+  if (option === "xhr" && typeof XMLHttpRequest !== "undefined") {
+    return xhrTransport;
+  }
+  return fetchTransport;
+}
 async function executeCoreFetch(config) {
   const {
     baseUrl,
@@ -429,6 +518,7 @@ async function executeCoreFetch(config) {
   const {
     middlewares: _,
     headers: defaultHeaders,
+    transport: defaultTransport,
     ...fetchDefaults
   } = defaultOptions;
   void _;
@@ -473,28 +563,30 @@ async function executeCoreFetch(config) {
       }
     }
   }
+  const resolvedTransport = resolveTransport(
+    requestOptions?.transport ?? defaultTransport
+  );
   let lastError;
   for (let attempt = 0; attempt <= retryCount; attempt++) {
     try {
-      const res = await fetch(url, fetchInit);
-      const status = res.status;
-      const resHeaders = res.headers;
-      const contentType = resHeaders.get("content-type");
-      const isJson = contentType?.includes("application/json");
-      const body = isJson ? await res.json() : res;
-      if (res.ok) {
+      const result = await resolvedTransport(
+        url,
+        fetchInit,
+        requestOptions?.transportOptions
+      );
+      if (result.ok) {
         return {
-          status,
-          data: body,
-          headers: resHeaders,
+          status: result.status,
+          data: result.data,
+          headers: result.headers,
           error: void 0,
           ...inputFields
         };
       }
       return {
-        status,
-        error: body,
-        headers: resHeaders,
+        status: result.status,
+        error: result.data,
+        headers: result.headers,
         data: void 0,
         ...inputFields
       };
@@ -738,6 +830,7 @@ function createStateManager() {
       for (const [name, value] of Object.entries(data)) {
         entry.meta.set(name, value);
       }
+      entry.state = { ...entry.state };
       notifySubscribers(key);
     },
     markStale(tags) {
@@ -949,7 +1042,7 @@ var Spoosh = class _Spoosh {
    * Creates a new Spoosh instance.
    *
    * @param baseUrl - The base URL for all API requests (e.g., '/api' or 'https://api.example.com')
-   * @param defaultOptions - Optional default options applied to all requests (headers, credentials, etc.)
+   * @param defaultOptions - Optional default options applied to all requests (headers, credentials, transport, etc.)
    * @param plugins - Internal parameter used by the `.use()` method. Do not pass directly.
    *
    * @example
@@ -961,6 +1054,12 @@ var Spoosh = class _Spoosh {
    * const client = new Spoosh<ApiSchema, Error>('/api', {
    *   headers: { 'X-API-Key': 'secret' }
    * });
+   *
+   * // With XHR transport (narrows available options to XHR-compatible fields)
+   * const client = new Spoosh<ApiSchema, Error>('/api', {
+   *   transport: 'xhr',
+   *   credentials: 'include',
+   * });
    * ```
    */
   constructor(baseUrl, defaultOptions, plugins) {
@@ -1156,7 +1255,10 @@ var Spoosh = class _Spoosh {
 // src/createClient.ts
 function createClient(config) {
   const { baseUrl, defaultOptions = {}, middlewares = [] } = config;
-  const optionsWithMiddlewares = { ...defaultOptions, middlewares };
+  const optionsWithMiddlewares = {
+    ...defaultOptions,
+    middlewares
+  };
   return createProxyHandler({
     baseUrl,
     defaultOptions: optionsWithMiddlewares,

package/dist/index.mjs

@@ -306,6 +306,87 @@ function resolvePath(path, params) {
   });
 }
 
+// src/transport/fetch.ts
+var fetchTransport = async (url, init) => {
+  const res = await fetch(url, init);
+  const contentType = res.headers.get("content-type");
+  const isJson = contentType?.includes("application/json");
+  const data = isJson ? await res.json() : res;
+  return { ok: res.ok, status: res.status, headers: res.headers, data };
+};
+
+// src/transport/xhr.ts
+var xhrTransport = (url, init, options) => {
+  return new Promise((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    xhr.open(init.method ?? "GET", url);
+    if (init.headers) {
+      const headers = init.headers instanceof Headers ? init.headers : new Headers(init.headers);
+      headers.forEach((value, key) => {
+        xhr.setRequestHeader(key, value);
+      });
+    }
+    if (init.credentials === "include") {
+      xhr.withCredentials = true;
+    }
+    const onAbort = () => xhr.abort();
+    if (init.signal) {
+      if (init.signal.aborted) {
+        xhr.abort();
+        return;
+      }
+      init.signal.addEventListener("abort", onAbort);
+    }
+    const cleanup = () => {
+      init.signal?.removeEventListener("abort", onAbort);
+    };
+    if (options?.onProgress) {
+      xhr.upload.addEventListener("progress", (event) => {
+        options.onProgress(event, xhr);
+      });
+      xhr.addEventListener("progress", (event) => {
+        options.onProgress(event, xhr);
+      });
+    }
+    xhr.addEventListener("load", () => {
+      cleanup();
+      const status = xhr.status;
+      const ok = status >= 200 && status < 300;
+      const responseHeaders = new Headers();
+      const rawHeaders = xhr.getAllResponseHeaders().trim();
+      if (rawHeaders) {
+        rawHeaders.split("\r\n").forEach((line) => {
+          const idx = line.indexOf(": ");
+          if (idx > 0) {
+            responseHeaders.append(
+              line.substring(0, idx),
+              line.substring(idx + 2)
+            );
+          }
+        });
+      }
+      const contentType = responseHeaders.get("content-type");
+      const isJson = contentType?.includes("application/json");
+      let data;
+      try {
+        data = isJson ? JSON.parse(xhr.responseText) : xhr.responseText;
+      } catch {
+        data = xhr.responseText;
+      }
+      resolve({ ok, status, headers: responseHeaders, data });
+    });
+    xhr.addEventListener("error", () => {
+      cleanup();
+      reject(new TypeError("Network request failed"));
+    });
+    xhr.addEventListener("abort", () => {
+      cleanup();
+      reject(new DOMException("Aborted", "AbortError"));
+    });
+    xhr.send(init.body);
+  });
+};
+
 // src/fetch.ts
 var delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 var isNetworkError = (err) => err instanceof TypeError;
@@ -354,6 +435,12 @@ function buildInputFields(requestOptions) {
   }
   return { input: fields };
 }
+function resolveTransport(option) {
+  if (option === "xhr" && typeof XMLHttpRequest !== "undefined") {
+    return xhrTransport;
+  }
+  return fetchTransport;
+}
 async function executeCoreFetch(config) {
   const {
     baseUrl,
@@ -367,6 +454,7 @@ async function executeCoreFetch(config) {
   const {
     middlewares: _,
     headers: defaultHeaders,
+    transport: defaultTransport,
     ...fetchDefaults
   } = defaultOptions;
   void _;
@@ -411,28 +499,30 @@ async function executeCoreFetch(config) {
       }
     }
   }
+  const resolvedTransport = resolveTransport(
+    requestOptions?.transport ?? defaultTransport
+  );
   let lastError;
   for (let attempt = 0; attempt <= retryCount; attempt++) {
     try {
-      const res = await fetch(url, fetchInit);
-      const status = res.status;
-      const resHeaders = res.headers;
-      const contentType = resHeaders.get("content-type");
-      const isJson = contentType?.includes("application/json");
-      const body = isJson ? await res.json() : res;
-      if (res.ok) {
+      const result = await resolvedTransport(
+        url,
+        fetchInit,
+        requestOptions?.transportOptions
+      );
+      if (result.ok) {
         return {
-          status,
-          data: body,
-          headers: resHeaders,
+          status: result.status,
+          data: result.data,
+          headers: result.headers,
           error: void 0,
           ...inputFields
         };
       }
       return {
-        status,
-        error: body,
-        headers: resHeaders,
+        status: result.status,
+        error: result.data,
+        headers: result.headers,
         data: void 0,
         ...inputFields
       };
@@ -676,6 +766,7 @@ function createStateManager() {
       for (const [name, value] of Object.entries(data)) {
         entry.meta.set(name, value);
       }
+      entry.state = { ...entry.state };
       notifySubscribers(key);
     },
     markStale(tags) {
@@ -887,7 +978,7 @@ var Spoosh = class _Spoosh {
    * Creates a new Spoosh instance.
    *
    * @param baseUrl - The base URL for all API requests (e.g., '/api' or 'https://api.example.com')
-   * @param defaultOptions - Optional default options applied to all requests (headers, credentials, etc.)
+   * @param defaultOptions - Optional default options applied to all requests (headers, credentials, transport, etc.)
    * @param plugins - Internal parameter used by the `.use()` method. Do not pass directly.
    *
    * @example
@@ -899,6 +990,12 @@ var Spoosh = class _Spoosh {
    * const client = new Spoosh<ApiSchema, Error>('/api', {
    *   headers: { 'X-API-Key': 'secret' }
    * });
+   *
+   * // With XHR transport (narrows available options to XHR-compatible fields)
+   * const client = new Spoosh<ApiSchema, Error>('/api', {
+   *   transport: 'xhr',
+   *   credentials: 'include',
+   * });
    * ```
    */
   constructor(baseUrl, defaultOptions, plugins) {
@@ -1094,7 +1191,10 @@ var Spoosh = class _Spoosh {
 // src/createClient.ts
 function createClient(config) {
   const { baseUrl, defaultOptions = {}, middlewares = [] } = config;
-  const optionsWithMiddlewares = { ...defaultOptions, middlewares };
+  const optionsWithMiddlewares = {
+    ...defaultOptions,
+    middlewares
+  };
   return createProxyHandler({
     baseUrl,
     defaultOptions: optionsWithMiddlewares,
@@ -1681,6 +1781,7 @@ export {
   executeFetch,
   extractMethodFromSelector,
   extractPathFromSelector,
+  fetchTransport,
   form,
   generateTags,
   getContentType,
@@ -1696,5 +1797,6 @@ export {
   resolveTags,
   setHeaders,
   sortObjectKeys,
-  urlencoded
+  urlencoded,
+  xhrTransport
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/core",
-  "version": "0.9.3",
+  "version": "0.10.0",
   "license": "MIT",
   "description": "Type-safe API client with plugin middleware system",
   "keywords": [
@@ -14,13 +14,13 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nxnom/spoosh.git",
+    "url": "git+https://github.com/spooshdev/spoosh.git",
     "directory": "packages/core"
   },
   "bugs": {
-    "url": "https://github.com/nxnom/spoosh/issues"
+    "url": "https://github.com/spooshdev/spoosh/issues"
   },
-  "homepage": "https://spoosh.dev/react/docs/core",
+  "homepage": "https://spoosh.dev/docs/react/core",
   "publishConfig": {
     "access": "public"
   },