api-def 0.9.4-alpha.2 → 0.10.0-alpha.2

package/cjs/Api.js

@@ -120,7 +120,6 @@ var Api = /** @class */ (function () {
             if (process.env.NODE_ENV === "development") {
                 if ((0, exports.isRequestBackendDefault)() && !defaultBackendMessageShown) {
                     defaultBackendMessageShown = true;
-                    // eslint-disable-next-line
                     console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
                 }
             }

package/cjs/ApiTypes.d.ts

@@ -8,12 +8,14 @@ export type Headers = Record<string, string | number | boolean | null | undefine
 export type Params = string;
 export type Query = string | undefined | Record<string, any>;
 export type Body = string | number | Record<string, any>;
+export type State = Record<string, any>;
 export interface ApiResponse<T = any> {
     readonly method: RequestMethod;
     readonly url: string;
     readonly status: number;
     readonly data: T;
     readonly headers: Record<string, string>;
+    readonly state: State;
 }
 export type RequestLock = string | false;
 export type QueryStringify = (query: any) => string;
@@ -41,22 +43,27 @@ export interface BaseRequestConfig {
     queryParser?: QueryStringify;
     queryHandling?: Partial<QueryHandling>;
 }
-export type RequestConfig<P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = (P extends undefined ? {
+export type RequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = (TParams extends undefined ? {
     params?: never;
 } : {
-    params: Record<P extends Params ? P : never, string>;
-}) & (Q extends undefined ? {
+    params: Record<TParams extends Params ? TParams : never, string>;
+}) & (TQuery extends undefined ? {
     query?: never;
 } : {
-    query: Q;
-}) & (B extends undefined ? {
+    query: TQuery;
+}) & (TBody extends undefined ? {
     body?: never;
 } : {
-    body: B;
+    body: TBody;
+}) & ({} extends TState ? {
+    state?: TState;
+} : {
+    state: TState;
 }) & BaseRequestConfig;
 export declare const COMPUTED_CONFIG_SYMBOL: unique symbol;
-export type ComputedRequestConfig<P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = Omit<RequestConfig<P, Q, B>, "queryParser" | "query" | "queryHandling"> & {
+export type ComputedRequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = Omit<RequestConfig<TParams, TQuery, TBody, TState>, "queryParser" | "query" | "queryHandling" | "state"> & {
     [COMPUTED_CONFIG_SYMBOL]: true;
+    state: TState;
     queryObject: Record<string, any> | undefined;
     queryString: string | undefined;
     queryHandling: QueryHandling;
@@ -90,7 +97,7 @@ export interface RequestHost {
     readonly path: string;
     readonly responseType: ResponseType | undefined;
     readonly validation: Validation;
-    computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     computePath(path: string, config: RequestConfig): string;
     getRequestBackend(): RequestBackend;
 }

package/cjs/Endpoint.d.ts

@@ -1,13 +1,13 @@
 import type { Api } from "./Api";
 import type { RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost } from "./ApiTypes";
+import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost, State } from "./ApiTypes";
 import type * as Mocking from "./MockingTypes";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
-export interface EndpointConfig<R, P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined, Path extends string = string> {
+export interface EndpointConfig<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> {
     readonly id: string;
     readonly method: RequestMethod;
-    readonly path: Path;
+    readonly path: TPath;
     /**
      * Name your endpoint to help with debugging and documentation
      * @default `id` is used as the name if no name is supplied
@@ -29,10 +29,10 @@ export interface EndpointConfig<R, P extends Params | undefined, Q extends Query
      * and testing.
      * Enable/disable mocked returns for all endpoints on your API object.
      */
-    readonly mocking?: Mocking.EndpointMockingConfig<R, P, Q, B>;
-    readonly validation?: Validation<R, P, Q, B>;
+    readonly mocking?: Mocking.EndpointMockingConfig<TResult, TParams, TQuery, TBody, TState>;
+    readonly validation?: Validation<TResult, TParams, TQuery, TBody, TState>;
 }
-export default class Endpoint<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> implements EndpointConfig<R, P, Q, B>, RequestHost {
+export default class Endpoint<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> implements EndpointConfig<TResponse, TParams, TQuery, TBody, TState>, RequestHost {
     readonly api: Api;
     readonly id: string;
     readonly method: RequestMethod;
@@ -41,12 +41,12 @@ export default class Endpoint<R = any, P extends Params | undefined = Params | u
     readonly path: string;
     readonly config?: BaseRequestConfig;
     readonly responseType: ResponseType | undefined;
-    readonly mocking?: Mocking.EndpointMockingConfig<R, P, Q, B>;
-    readonly validation: Validation<R, P, Q, B>;
-    constructor(api: Api, info: EndpointConfig<R, P, Q, B>);
-    submit(config: RequestConfig<P, Q, B>): Promise<ApiResponse<R>>;
+    readonly mocking?: Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState>;
+    readonly validation: Validation<TResponse, TParams, TQuery, TBody, TState>;
+    constructor(api: Api, info: EndpointConfig<TResponse, TParams, TQuery, TBody, TState>);
+    submit(config: RequestConfig<TParams, TQuery, TBody, TState>): Promise<ApiResponse<TResponse>>;
     computePath(path: string, request: RequestConfig): string;
     get baseUrl(): string;
-    computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     getRequestBackend(): RequestBackend;
 }

package/cjs/EndpointBuilder.d.ts

@@ -1,14 +1,15 @@
 import type * as zod from "zod";
 import type { Api } from "./Api";
-import type { Body, Params, Query } from "./ApiTypes";
+import type { Body, Params, Query, State } from "./ApiTypes";
 import Endpoint, { type EndpointConfig } from "./Endpoint";
-export default class EndpointBuilder<R = any, P extends Params | undefined = undefined, Q extends Query | undefined = undefined, B extends Body | undefined = undefined> {
+export default class EndpointBuilder<TResponse = any, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State> {
     private api;
     private readonly validation;
     constructor(api: Api);
-    queryOf<Q extends Query>(schema?: zod.Schema<Q>): EndpointBuilder<R, P, Q, B>;
-    paramsOf<P extends Params>(): EndpointBuilder<R, P, Q, B>;
-    bodyOf<B extends Body>(schema?: zod.Schema<B>): EndpointBuilder<R, P, Q, B>;
-    responseOf<R>(schema?: zod.Schema<R>): EndpointBuilder<R, P, Q, B>;
-    build<Path extends string>(config: Omit<EndpointConfig<R, P, Q, B, Path>, "validation">): Endpoint<R, P, Q, B>;
+    queryOf<TNewQuery extends Query>(schema?: zod.Schema<TNewQuery>): EndpointBuilder<TResponse, TParams, TNewQuery, TBody>;
+    paramsOf<TNewParams extends Params>(): EndpointBuilder<TResponse, TNewParams, TQuery, TBody, TState>;
+    bodyOf<TNewBody extends Body>(schema?: zod.Schema<TNewBody>): EndpointBuilder<TResponse, TParams, TQuery, TNewBody, TState>;
+    responseOf<TNewResponse>(schema?: zod.Schema<TNewResponse>): EndpointBuilder<TNewResponse, TParams, TQuery, TBody, TState>;
+    stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState>;
+    build<TPath extends string>(config: Omit<EndpointConfig<TResponse, TParams, TQuery, TBody, TState, TPath>, "validation">): Endpoint<TResponse, TParams, TQuery, TBody, TState>;
 }

package/cjs/EndpointBuilder.js

@@ -36,6 +36,10 @@ var EndpointBuilder = /** @class */ (function () {
         this.validation.response = schema;
         return this;
     };
+    EndpointBuilder.prototype.stateOf = function (schema) {
+        this.validation.state = schema;
+        return this;
+    };
     EndpointBuilder.prototype.build = function (config) {
         var endpoint = new Endpoint_1.default(this.api, __assign(__assign({}, config), { validation: this.validation }));
         this.api.endpoints[endpoint.id] = endpoint;

package/cjs/MockingTypes.d.ts

@@ -1,30 +1,31 @@
-import type { ApiResponse, Body, Headers, Params, Query } from "./ApiTypes";
+import type { ApiResponse, Body, Headers, Params, Query, State } from "./ApiTypes";
 export interface ApiMockingConfig {
     enabled: boolean | (() => boolean);
 }
-export interface MockRequest<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
-    params: P extends Params ? Record<P, string> : {};
-    body: B;
-    query: Q;
+export interface MockRequest<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
+    params: TParams extends Params ? Record<TParams, string> : {};
+    body: TBody;
+    query: TQuery;
     headers: Readonly<Headers>;
     url: string;
+    state: TState;
 }
-export interface MockResponse<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
+export interface MockResponse<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     statusCode: number;
-    response: R | undefined;
+    response: TResponse | undefined;
     headers: Headers;
     status(statusCode: number): this;
-    send(response: R): this;
+    send(response: TResponse): this;
 }
 export type MockRequestError = Error & {
     response?: ApiResponse;
 };
-export type EndpointMockingFunction<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = (req: MockRequest<R, P, Q, B>, res: MockResponse<R, P, Q, B>) => Promise<MockResponse<R, P, Q, B>> | MockResponse<R, P, Q, B>;
-export interface EndpointMockingConfig<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
+export type EndpointMockingFunction<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = (req: MockRequest<TResponse, TParams, TQuery, TBody, TState>, res: MockResponse<TResponse, TParams, TQuery, TBody, TState>) => Promise<MockResponse<TResponse, TParams, TQuery, TBody>> | MockResponse<TResponse, TParams, TQuery, TBody, TState>;
+export interface EndpointMockingConfig<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     /**-
      * The range supplied will be used to simulate the lag in obtaining a response
      * your endpoint. If no values are supplied, a response will be returned immediately
      */
     delay?: number | [minMs: number, maxMs: number];
-    handler: EndpointMockingFunction<R, P, Q, B>;
+    handler: EndpointMockingFunction<TResponse, TParams, TQuery, TBody, TState>;
 }

package/cjs/RequestConfig.d.ts

@@ -1,2 +1,2 @@
-import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Query, type RequestConfig } from "./ApiTypes";
-export declare const computeRequestConfig: <P extends string | undefined, Q extends Query, B extends Body | undefined>(configs: (RequestConfig<P, Q, B> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<P, Q, B>;
+import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Query, type RequestConfig, type State } from "./ApiTypes";
+export declare const computeRequestConfig: <TParams extends string | undefined, TQuery extends Query, TBody extends Body | undefined, TState extends State>(configs: (RequestConfig<TParams, TQuery, TBody, TState> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<TParams, TQuery, TBody, TState>;

package/cjs/RequestConfig.js

@@ -69,6 +69,9 @@ var computeRequestConfig = function (configs) {
             },
         });
     }
+    if (!computedConfig.state) {
+        computedConfig.state = {};
+    }
     return computedConfig;
 };
 exports.computeRequestConfig = computeRequestConfig;

package/cjs/RequestContext.d.ts

@@ -1,11 +1,11 @@
 import type { Api } from "./Api";
 import type { RequestEvent, RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Headers, Params, Query, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost } from "./ApiTypes";
+import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Headers, Params, Query, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost, State } from "./ApiTypes";
 import type { EndpointMockingConfig } from "./MockingTypes";
 import type { RequestError } from "./RequestError";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
-export default class RequestContext<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
+export default class RequestContext<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     readonly id: number;
     readonly key: string;
     private computedPath;
@@ -13,19 +13,23 @@ export default class RequestContext<R = any, P extends Params | undefined = Para
     private computedMethod;
     readonly stats: RequestContextStats;
     private readonly host;
-    readonly eventHandlers: RequestEventHandlers<R>;
+    readonly eventHandlers: RequestEventHandlers<TResponse>;
     readonly backend: RequestBackend;
     private canceler;
-    response: ApiResponse<R> | null | undefined;
+    response: ApiResponse<TResponse> | null | undefined;
     error: RequestError | null;
     readonly cacheInfo: RequestCacheInfo;
     cancelled: boolean;
-    readonly computedConfig: ComputedRequestConfig<P, Q, B>;
+    /**
+     * @deprecated Use `requestConfig` instead
+     */
+    readonly computedConfig: ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     private computedRequestUrl;
-    readonly mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined;
+    readonly mocking: EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | null | undefined;
     private parsedBody;
-    readonly validation: Validation<R, P, Q, B>;
-    constructor(backend: RequestBackend, host: RequestHost, config: ComputedRequestConfig<P, Q, B>, computedPath: string, mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined);
+    readonly validation: Validation<TResponse, TParams, TQuery, TBody, TState>;
+    constructor(backend: RequestBackend, host: RequestHost, config: ComputedRequestConfig<TParams, TQuery, TBody, TState>, computedPath: string, mocking: EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | null | undefined);
+    get requestConfig(): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     get method(): RequestMethod;
     get api(): Api;
     get baseUrl(): string;
@@ -35,8 +39,8 @@ export default class RequestContext<R = any, P extends Params | undefined = Para
     updateHeaders(newHeaders: Headers): this;
     private parseRequestBody;
     getParsedBody(): any;
-    updateQuery(newQuery: Partial<Q>): this;
-    triggerEvent(eventType: RequestEvent): Promise<EventResult<R> | undefined>;
+    updateQuery(newQuery: Partial<TQuery>): this;
+    triggerEvent(eventType: RequestEvent): Promise<EventResult<TResponse> | undefined>;
     addCanceller(canceler: () => void): void;
     cancel(): void;
     get requestUrl(): URL;

package/cjs/RequestContext.js

@@ -65,6 +65,13 @@ var RequestContext = /** @class */ (function () {
         this.parseRequestBody();
         this.computedRequestUrl = this.generateRequestUrl();
     }
+    Object.defineProperty(RequestContext.prototype, "requestConfig", {
+        get: function () {
+            return this.computedConfig;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(RequestContext.prototype, "method", {
         get: function () {
             return this.computedMethod;

package/cjs/Requester.d.ts

@@ -1,3 +1,3 @@
-import type { ApiResponse, Body, Query, RequestConfig, RequestHost } from "./ApiTypes";
+import type { ApiResponse, Body, Query, RequestConfig, RequestHost, State } from "./ApiTypes";
 import type { EndpointMockingConfig } from "./MockingTypes";
-export declare const submit: <R, P extends string | undefined, Q extends Query, B extends Body | undefined>(host: RequestHost, config: RequestConfig<P, Q, B>, mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined) => Promise<ApiResponse<R>>;
+export declare const submit: <TResponse, TParams extends string | undefined, TQuery extends Query, TBody extends Body | undefined, TState extends State>(host: RequestHost, config: RequestConfig<TParams, TQuery, TBody, TState>, mocking: EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | null | undefined) => Promise<ApiResponse<TResponse>>;

package/cjs/TextDecoding.js

@@ -1,6 +1,4 @@
 "use strict";
-/* eslint-disable prefer-const */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.textDecode = void 0;
 // polyfill from https://github.com/anonyco/FastestSmallestTextEncoderDecoder/blob/master/EncoderDecoderTogether.src.js

package/cjs/Utils.js

@@ -13,7 +13,6 @@ exports.assign = Object.assign ||
         }
         var to = Object(target);
         for (var index = 0; index < varArgs.length; index++) {
-            // eslint-disable-next-line prefer-rest-params
             var nextSource = varArgs[index];
             if (nextSource !== null && nextSource !== undefined) {
                 for (var nextKey in nextSource) {
@@ -49,7 +48,6 @@ var getGlobalFetch = function () {
     return undefined;
 };
 exports.getGlobalFetch = getGlobalFetch;
-// eslint-disable-next-line @typescript-eslint/no-empty-function
 var noop = function () { };
 exports.noop = noop;
 /**

package/cjs/Validation.d.ts

@@ -1,8 +1,9 @@
 import type * as zod from "zod";
-import type { Body, Params, Query } from "./ApiTypes";
-export interface Validation<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
-    query?: zod.Schema<Q>;
-    params?: zod.Schema<P>;
-    body?: zod.Schema<B>;
-    response?: zod.Schema<R>;
+import type { Body, Params, Query, State } from "./ApiTypes";
+export interface Validation<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
+    query?: zod.Schema<TQuery>;
+    params?: zod.Schema<TParams>;
+    body?: zod.Schema<TBody>;
+    response?: zod.Schema<TResponse>;
+    state?: zod.Schema<TState>;
 }

package/cjs/backend/AxiosRequestBackend.js

@@ -43,7 +43,6 @@ var isAxiosError = function (error) {
 };
 exports.isAxiosError = isAxiosError;
 var AxiosRequestBackend = /** @class */ (function () {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     function AxiosRequestBackend(axiosLibrary) {
         this.id = "axios";
         axios = axiosLibrary;
@@ -67,22 +66,23 @@ var AxiosRequestBackend = /** @class */ (function () {
                         data: response.data,
                         headers: response.headers,
                         status: response.status,
+                        state: context.requestConfig.state,
                         __lowercaseHeaders: response._lowerCaseResponseHeaders,
                     }];
             });
         });
     };
     AxiosRequestBackend.prototype.makeRequest = function (context) {
-        var computedConfig = context.computedConfig;
+        var requestConfig = context.requestConfig;
         var url = context.requestUrl;
         var canceler = null;
         var promise = axios({
             method: context.method,
             url: url.href,
             data: context.getParsedBody(),
-            headers: computedConfig.headers || {},
+            headers: requestConfig.headers || {},
             responseType: context.responseType,
-            withCredentials: computedConfig.includeCredentials,
+            withCredentials: requestConfig.includeCredentials,
             cancelToken: new axios.CancelToken(function (cancellerFunc) {
                 canceler = cancellerFunc;
             }),

package/cjs/backend/FetchRequestBackend.d.ts

@@ -4,7 +4,7 @@ import { type Fetch } from "../Utils";
 import type RequestBackend from "./RequestBackend";
 import type { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
 export default class FetchRequestBackend implements RequestBackend<Response> {
-    fetch: (((input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
+    fetch: (((input: URL | RequestInfo, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
     readonly id = "fetch";
     constructor(fetchLibrary?: Fetch);
     extractResponseFromError(error: Error): Promise<Response | null | undefined>;

package/cjs/backend/FetchRequestBackend.js

@@ -105,6 +105,7 @@ var FetchRequestBackend = /** @class */ (function () {
                             data: undefined,
                             status: status,
                             headers: processedHeaders,
+                            state: context.requestConfig.state,
                         };
                         responseType = (_a = context.responseType) !== null && _a !== void 0 ? _a : (0, ApiUtils_1.inferResponseType)(response.headers.get("Content-Type"));
                         _b.label = 1;
@@ -172,13 +173,14 @@ var FetchRequestBackend = /** @class */ (function () {
             method: context.method.toUpperCase(),
             body: bodyJsonify ? JSON.stringify(body) : body,
             headers: parsedHeaders,
-            credentials: context.computedConfig.includeCredentials ? "include" : undefined,
             signal: abortSignal,
         };
-        // edge doesn't support mode
         if ("mode" in Request.prototype) {
             fetchOptions.mode = "cors";
         }
+        if ("credentials" in Request.prototype) {
+            fetchOptions.credentials = context.requestConfig.includeCredentials ? "include" : undefined;
+        }
         var promise = this.fetch(url.href, fetchOptions).then(function (response) {
             responded = true;
             if (!response.ok) {

package/cjs/backend/MockRequestBackend.js

@@ -79,10 +79,11 @@ var MockRequestBackend = /** @class */ (function () {
                         }
                         req = {
                             body: context.getParsedBody(),
-                            params: (_c = context.computedConfig.params) !== null && _c !== void 0 ? _c : {},
-                            query: context.computedConfig.queryObject,
-                            headers: (_d = context.computedConfig.headers) !== null && _d !== void 0 ? _d : {},
+                            params: (_c = context.requestConfig.params) !== null && _c !== void 0 ? _c : {},
+                            query: context.requestConfig.queryObject,
+                            headers: (_d = context.requestConfig.headers) !== null && _d !== void 0 ? _d : {},
                             url: context.requestUrl.toString(),
+                            state: context.requestConfig.state,
                         };
                         res = {
                             statusCode: -1,
@@ -145,6 +146,7 @@ var MockRequestBackend = /** @class */ (function () {
                                 headers: parsedHeaders,
                                 data: res.response,
                                 status: res.statusCode,
+                                state: context.requestConfig.state,
                             }];
                 }
             });

package/cjs/cache/LocalForageCacheBackend.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var LocalForageCacheBackend = /** @class */ (function () {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     function LocalForageCacheBackend(localforage) {
         this.store = localforage.createInstance({
             name: "requestCache",

package/cjs/middleware/LoggingMiddleware.js

@@ -50,11 +50,8 @@ var log = function (context, type, message, config, objects) {
         "color:".concat(color),
         "color:gray",
     ];
-    /* eslint-disable-next-line no-console */
     console.groupCollapsed.apply(console, args);
-    /* eslint-disable-next-line no-console */
     console.log(Utils.assign({ context: context }, objects || {}));
-    /* eslint-disable-next-line no-console */
     console.groupEnd();
 };
 var LoggingMiddleware = function (config) {

package/cjs/util/retry/lib/retry.js

@@ -32,7 +32,6 @@ var _timeouts = function (options) {
     };
     var defaultRetries = 10;
     var opts = __assign({ retries: defaultRetries, factor: 2, minTimeout: 1 * 1000, maxTimeout: Number.POSITIVE_INFINITY, randomize: false }, options);
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     if (opts.minTimeout > opts.maxTimeout) {
         throw new Error("minTimeout is greater than maxTimeout");
     }

package/esm/Api.js

@@ -74,7 +74,6 @@ export class Api {
             if (process.env.NODE_ENV === "development") {
                 if (isRequestBackendDefault() && !defaultBackendMessageShown) {
                     defaultBackendMessageShown = true;
-                    // eslint-disable-next-line
                     console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
                 }
             }

package/esm/ApiTypes.d.ts

@@ -8,12 +8,14 @@ export type Headers = Record<string, string | number | boolean | null | undefine
 export type Params = string;
 export type Query = string | undefined | Record<string, any>;
 export type Body = string | number | Record<string, any>;
+export type State = Record<string, any>;
 export interface ApiResponse<T = any> {
     readonly method: RequestMethod;
     readonly url: string;
     readonly status: number;
     readonly data: T;
     readonly headers: Record<string, string>;
+    readonly state: State;
 }
 export type RequestLock = string | false;
 export type QueryStringify = (query: any) => string;
@@ -41,22 +43,27 @@ export interface BaseRequestConfig {
     queryParser?: QueryStringify;
     queryHandling?: Partial<QueryHandling>;
 }
-export type RequestConfig<P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = (P extends undefined ? {
+export type RequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = (TParams extends undefined ? {
     params?: never;
 } : {
-    params: Record<P extends Params ? P : never, string>;
-}) & (Q extends undefined ? {
+    params: Record<TParams extends Params ? TParams : never, string>;
+}) & (TQuery extends undefined ? {
     query?: never;
 } : {
-    query: Q;
-}) & (B extends undefined ? {
+    query: TQuery;
+}) & (TBody extends undefined ? {
     body?: never;
 } : {
-    body: B;
+    body: TBody;
+}) & ({} extends TState ? {
+    state?: TState;
+} : {
+    state: TState;
 }) & BaseRequestConfig;
 export declare const COMPUTED_CONFIG_SYMBOL: unique symbol;
-export type ComputedRequestConfig<P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = Omit<RequestConfig<P, Q, B>, "queryParser" | "query" | "queryHandling"> & {
+export type ComputedRequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = Omit<RequestConfig<TParams, TQuery, TBody, TState>, "queryParser" | "query" | "queryHandling" | "state"> & {
     [COMPUTED_CONFIG_SYMBOL]: true;
+    state: TState;
     queryObject: Record<string, any> | undefined;
     queryString: string | undefined;
     queryHandling: QueryHandling;
@@ -90,7 +97,7 @@ export interface RequestHost {
     readonly path: string;
     readonly responseType: ResponseType | undefined;
     readonly validation: Validation;
-    computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     computePath(path: string, config: RequestConfig): string;
     getRequestBackend(): RequestBackend;
 }

package/esm/Endpoint.d.ts

@@ -1,13 +1,13 @@
 import type { Api } from "./Api";
 import type { RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost } from "./ApiTypes";
+import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost, State } from "./ApiTypes";
 import type * as Mocking from "./MockingTypes";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
-export interface EndpointConfig<R, P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined, Path extends string = string> {
+export interface EndpointConfig<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> {
     readonly id: string;
     readonly method: RequestMethod;
-    readonly path: Path;
+    readonly path: TPath;
     /**
      * Name your endpoint to help with debugging and documentation
      * @default `id` is used as the name if no name is supplied
@@ -29,10 +29,10 @@ export interface EndpointConfig<R, P extends Params | undefined, Q extends Query
      * and testing.
      * Enable/disable mocked returns for all endpoints on your API object.
      */
-    readonly mocking?: Mocking.EndpointMockingConfig<R, P, Q, B>;
-    readonly validation?: Validation<R, P, Q, B>;
+    readonly mocking?: Mocking.EndpointMockingConfig<TResult, TParams, TQuery, TBody, TState>;
+    readonly validation?: Validation<TResult, TParams, TQuery, TBody, TState>;
 }
-export default class Endpoint<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> implements EndpointConfig<R, P, Q, B>, RequestHost {
+export default class Endpoint<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> implements EndpointConfig<TResponse, TParams, TQuery, TBody, TState>, RequestHost {
     readonly api: Api;
     readonly id: string;
     readonly method: RequestMethod;
@@ -41,12 +41,12 @@ export default class Endpoint<R = any, P extends Params | undefined = Params | u
     readonly path: string;
     readonly config?: BaseRequestConfig;
     readonly responseType: ResponseType | undefined;
-    readonly mocking?: Mocking.EndpointMockingConfig<R, P, Q, B>;
-    readonly validation: Validation<R, P, Q, B>;
-    constructor(api: Api, info: EndpointConfig<R, P, Q, B>);
-    submit(config: RequestConfig<P, Q, B>): Promise<ApiResponse<R>>;
+    readonly mocking?: Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState>;
+    readonly validation: Validation<TResponse, TParams, TQuery, TBody, TState>;
+    constructor(api: Api, info: EndpointConfig<TResponse, TParams, TQuery, TBody, TState>);
+    submit(config: RequestConfig<TParams, TQuery, TBody, TState>): Promise<ApiResponse<TResponse>>;
     computePath(path: string, request: RequestConfig): string;
     get baseUrl(): string;
-    computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     getRequestBackend(): RequestBackend;
 }

package/esm/EndpointBuilder.d.ts

@@ -1,14 +1,15 @@
 import type * as zod from "zod";
 import type { Api } from "./Api";
-import type { Body, Params, Query } from "./ApiTypes";
+import type { Body, Params, Query, State } from "./ApiTypes";
 import Endpoint, { type EndpointConfig } from "./Endpoint";
-export default class EndpointBuilder<R = any, P extends Params | undefined = undefined, Q extends Query | undefined = undefined, B extends Body | undefined = undefined> {
+export default class EndpointBuilder<TResponse = any, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State> {
     private api;
     private readonly validation;
     constructor(api: Api);
-    queryOf<Q extends Query>(schema?: zod.Schema<Q>): EndpointBuilder<R, P, Q, B>;
-    paramsOf<P extends Params>(): EndpointBuilder<R, P, Q, B>;
-    bodyOf<B extends Body>(schema?: zod.Schema<B>): EndpointBuilder<R, P, Q, B>;
-    responseOf<R>(schema?: zod.Schema<R>): EndpointBuilder<R, P, Q, B>;
-    build<Path extends string>(config: Omit<EndpointConfig<R, P, Q, B, Path>, "validation">): Endpoint<R, P, Q, B>;
+    queryOf<TNewQuery extends Query>(schema?: zod.Schema<TNewQuery>): EndpointBuilder<TResponse, TParams, TNewQuery, TBody>;
+    paramsOf<TNewParams extends Params>(): EndpointBuilder<TResponse, TNewParams, TQuery, TBody, TState>;
+    bodyOf<TNewBody extends Body>(schema?: zod.Schema<TNewBody>): EndpointBuilder<TResponse, TParams, TQuery, TNewBody, TState>;
+    responseOf<TNewResponse>(schema?: zod.Schema<TNewResponse>): EndpointBuilder<TNewResponse, TParams, TQuery, TBody, TState>;
+    stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState>;
+    build<TPath extends string>(config: Omit<EndpointConfig<TResponse, TParams, TQuery, TBody, TState, TPath>, "validation">): Endpoint<TResponse, TParams, TQuery, TBody, TState>;
 }

package/esm/EndpointBuilder.js

@@ -23,6 +23,10 @@ export default class EndpointBuilder {
         this.validation.response = schema;
         return this;
     }
+    stateOf(schema) {
+        this.validation.state = schema;
+        return this;
+    }
     build(config) {
         const endpoint = new Endpoint(this.api, Object.assign(Object.assign({}, config), { validation: this.validation }));
         this.api.endpoints[endpoint.id] = endpoint;

package/esm/MockingTypes.d.ts

@@ -1,30 +1,31 @@
-import type { ApiResponse, Body, Headers, Params, Query } from "./ApiTypes";
+import type { ApiResponse, Body, Headers, Params, Query, State } from "./ApiTypes";
 export interface ApiMockingConfig {
     enabled: boolean | (() => boolean);
 }
-export interface MockRequest<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
-    params: P extends Params ? Record<P, string> : {};
-    body: B;
-    query: Q;
+export interface MockRequest<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
+    params: TParams extends Params ? Record<TParams, string> : {};
+    body: TBody;
+    query: TQuery;
     headers: Readonly<Headers>;
     url: string;
+    state: TState;
 }
-export interface MockResponse<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
+export interface MockResponse<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     statusCode: number;
-    response: R | undefined;
+    response: TResponse | undefined;
     headers: Headers;
     status(statusCode: number): this;
-    send(response: R): this;
+    send(response: TResponse): this;
 }
 export type MockRequestError = Error & {
     response?: ApiResponse;
 };
-export type EndpointMockingFunction<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = (req: MockRequest<R, P, Q, B>, res: MockResponse<R, P, Q, B>) => Promise<MockResponse<R, P, Q, B>> | MockResponse<R, P, Q, B>;
-export interface EndpointMockingConfig<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
+export type EndpointMockingFunction<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = (req: MockRequest<TResponse, TParams, TQuery, TBody, TState>, res: MockResponse<TResponse, TParams, TQuery, TBody, TState>) => Promise<MockResponse<TResponse, TParams, TQuery, TBody>> | MockResponse<TResponse, TParams, TQuery, TBody, TState>;
+export interface EndpointMockingConfig<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     /**-
      * The range supplied will be used to simulate the lag in obtaining a response
      * your endpoint. If no values are supplied, a response will be returned immediately
      */
     delay?: number | [minMs: number, maxMs: number];
-    handler: EndpointMockingFunction<R, P, Q, B>;
+    handler: EndpointMockingFunction<TResponse, TParams, TQuery, TBody, TState>;
 }

package/esm/RequestConfig.d.ts

@@ -1,2 +1,2 @@
-import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Query, type RequestConfig } from "./ApiTypes";
-export declare const computeRequestConfig: <P extends string | undefined, Q extends Query, B extends Body | undefined>(configs: (RequestConfig<P, Q, B> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<P, Q, B>;
+import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Query, type RequestConfig, type State } from "./ApiTypes";
+export declare const computeRequestConfig: <TParams extends string | undefined, TQuery extends Query, TBody extends Body | undefined, TState extends State>(configs: (RequestConfig<TParams, TQuery, TBody, TState> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<TParams, TQuery, TBody, TState>;

package/esm/RequestConfig.js

@@ -52,5 +52,8 @@ export const computeRequestConfig = (configs) => {
             },
         });
     }
+    if (!computedConfig.state) {
+        computedConfig.state = {};
+    }
     return computedConfig;
 };

package/esm/RequestContext.d.ts

@@ -1,11 +1,11 @@
 import type { Api } from "./Api";
 import type { RequestEvent, RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Headers, Params, Query, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost } from "./ApiTypes";
+import type { ApiResponse, Body, ComputedRequestConfig, EventResult, Headers, Params, Query, RequestCacheInfo, RequestContextStats, RequestEventHandlers, RequestHost, State } from "./ApiTypes";
 import type { EndpointMockingConfig } from "./MockingTypes";
 import type { RequestError } from "./RequestError";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
-export default class RequestContext<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
+export default class RequestContext<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
     readonly id: number;
     readonly key: string;
     private computedPath;
@@ -13,19 +13,23 @@ export default class RequestContext<R = any, P extends Params | undefined = Para
     private computedMethod;
     readonly stats: RequestContextStats;
     private readonly host;
-    readonly eventHandlers: RequestEventHandlers<R>;
+    readonly eventHandlers: RequestEventHandlers<TResponse>;
     readonly backend: RequestBackend;
     private canceler;
-    response: ApiResponse<R> | null | undefined;
+    response: ApiResponse<TResponse> | null | undefined;
     error: RequestError | null;
     readonly cacheInfo: RequestCacheInfo;
     cancelled: boolean;
-    readonly computedConfig: ComputedRequestConfig<P, Q, B>;
+    /**
+     * @deprecated Use `requestConfig` instead
+     */
+    readonly computedConfig: ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     private computedRequestUrl;
-    readonly mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined;
+    readonly mocking: EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | null | undefined;
     private parsedBody;
-    readonly validation: Validation<R, P, Q, B>;
-    constructor(backend: RequestBackend, host: RequestHost, config: ComputedRequestConfig<P, Q, B>, computedPath: string, mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined);
+    readonly validation: Validation<TResponse, TParams, TQuery, TBody, TState>;
+    constructor(backend: RequestBackend, host: RequestHost, config: ComputedRequestConfig<TParams, TQuery, TBody, TState>, computedPath: string, mocking: EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | null | undefined);
+    get requestConfig(): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
     get method(): RequestMethod;
     get api(): Api;
     get baseUrl(): string;
@@ -35,8 +39,8 @@ export default class RequestContext<R = any, P extends Params | undefined = Para
     updateHeaders(newHeaders: Headers): this;
     private parseRequestBody;
     getParsedBody(): any;
-    updateQuery(newQuery: Partial<Q>): this;
-    triggerEvent(eventType: RequestEvent): Promise<EventResult<R> | undefined>;
+    updateQuery(newQuery: Partial<TQuery>): this;
+    triggerEvent(eventType: RequestEvent): Promise<EventResult<TResponse> | undefined>;
     addCanceller(canceler: () => void): void;
     cancel(): void;
     get requestUrl(): URL;

package/esm/RequestContext.js

@@ -36,6 +36,9 @@ export default class RequestContext {
         this.parseRequestBody();
         this.computedRequestUrl = this.generateRequestUrl();
     }
+    get requestConfig() {
+        return this.computedConfig;
+    }
     get method() {
         return this.computedMethod;
     }
@@ -110,7 +113,6 @@ export default class RequestContext {
             if (eventHandlers) {
                 for (let i = 0; i < eventHandlers.length; i++) {
                     const eventHandler = eventHandlers[i];
-                    // eslint-disable-next-line no-await-in-loop
                     const eventResult = yield eventHandler(this);
                     if (eventResult) {
                         return eventResult;

package/esm/Requester.d.ts

@@ -1,3 +1,3 @@
-import type { ApiResponse, Body, Query, RequestConfig, RequestHost } from "./ApiTypes";
+import type { ApiResponse, Body, Query, RequestConfig, RequestHost, State } from "./ApiTypes";
 import type { EndpointMockingConfig } from "./MockingTypes";
-export declare const submit: <R, P extends string | undefined, Q extends Query, B extends Body | undefined>(host: RequestHost, config: RequestConfig<P, Q, B>, mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined) => Promise<ApiResponse<R>>;
+export declare const submit: <TResponse, TParams extends string | undefined, TQuery extends Query, TBody extends Body | undefined, TState extends State>(host: RequestHost, config: RequestConfig<TParams, TQuery, TBody, TState>, mocking: EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | null | undefined) => Promise<ApiResponse<TResponse>>;

package/esm/TextDecoding.js

@@ -1,5 +1,3 @@
-/* eslint-disable prefer-const */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 // polyfill from https://github.com/anonyco/FastestSmallestTextEncoderDecoder/blob/master/EncoderDecoderTogether.src.js
 export const textDecode = (inputArrayOrBuffer, options) => {
     if (typeof TextDecoder !== "undefined") {

package/esm/Utils.js

@@ -6,7 +6,6 @@ export const assign = Object.assign ||
         }
         const to = Object(target);
         for (let index = 0; index < varArgs.length; index++) {
-            // eslint-disable-next-line prefer-rest-params
             const nextSource = varArgs[index];
             if (nextSource !== null && nextSource !== undefined) {
                 for (const nextKey in nextSource) {
@@ -39,7 +38,6 @@ export const getGlobalFetch = () => {
     }
     return undefined;
 };
-// eslint-disable-next-line @typescript-eslint/no-empty-function
 export const noop = () => { };
 /**
  * Just used to simulate lag, or loading times.

package/esm/Validation.d.ts

@@ -1,8 +1,9 @@
 import type * as zod from "zod";
-import type { Body, Params, Query } from "./ApiTypes";
-export interface Validation<R = any, P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> {
-    query?: zod.Schema<Q>;
-    params?: zod.Schema<P>;
-    body?: zod.Schema<B>;
-    response?: zod.Schema<R>;
+import type { Body, Params, Query, State } from "./ApiTypes";
+export interface Validation<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> {
+    query?: zod.Schema<TQuery>;
+    params?: zod.Schema<TParams>;
+    body?: zod.Schema<TBody>;
+    response?: zod.Schema<TResponse>;
+    state?: zod.Schema<TState>;
 }

package/esm/backend/AxiosRequestBackend.js

@@ -12,7 +12,6 @@ export const isAxiosError = (error) => {
     return "isAxiosError" in error;
 };
 export default class AxiosRequestBackend {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     constructor(axiosLibrary) {
         this.id = "axios";
         axios = axiosLibrary;
@@ -33,21 +32,22 @@ export default class AxiosRequestBackend {
                 data: response.data,
                 headers: response.headers,
                 status: response.status,
+                state: context.requestConfig.state,
                 __lowercaseHeaders: response._lowerCaseResponseHeaders,
             };
         });
     }
     makeRequest(context) {
-        const { computedConfig } = context;
+        const { requestConfig } = context;
         const url = context.requestUrl;
         let canceler = null;
         const promise = axios({
             method: context.method,
             url: url.href,
             data: context.getParsedBody(),
-            headers: computedConfig.headers || {},
+            headers: requestConfig.headers || {},
             responseType: context.responseType,
-            withCredentials: computedConfig.includeCredentials,
+            withCredentials: requestConfig.includeCredentials,
             cancelToken: new axios.CancelToken((cancellerFunc) => {
                 canceler = cancellerFunc;
             }),

package/esm/backend/FetchRequestBackend.d.ts

@@ -4,7 +4,7 @@ import { type Fetch } from "../Utils";
 import type RequestBackend from "./RequestBackend";
 import type { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
 export default class FetchRequestBackend implements RequestBackend<Response> {
-    fetch: (((input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
+    fetch: (((input: URL | RequestInfo, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
     readonly id = "fetch";
     constructor(fetchLibrary?: Fetch);
     extractResponseFromError(error: Error): Promise<Response | null | undefined>;

package/esm/backend/FetchRequestBackend.js

@@ -49,6 +49,7 @@ export default class FetchRequestBackend {
                 data: undefined,
                 status: status,
                 headers: processedHeaders,
+                state: context.requestConfig.state,
             };
             const responseType = (_a = context.responseType) !== null && _a !== void 0 ? _a : inferResponseType(response.headers.get("Content-Type"));
             let text;
@@ -107,13 +108,14 @@ export default class FetchRequestBackend {
             method: context.method.toUpperCase(),
             body: bodyJsonify ? JSON.stringify(body) : body,
             headers: parsedHeaders,
-            credentials: context.computedConfig.includeCredentials ? "include" : undefined,
             signal: abortSignal,
         };
-        // edge doesn't support mode
         if ("mode" in Request.prototype) {
             fetchOptions.mode = "cors";
         }
+        if ("credentials" in Request.prototype) {
+            fetchOptions.credentials = context.requestConfig.includeCredentials ? "include" : undefined;
+        }
         const promise = this.fetch(url.href, fetchOptions).then((response) => {
             responded = true;
             if (!response.ok) {

package/esm/backend/MockRequestBackend.js

@@ -41,10 +41,11 @@ export default class MockRequestBackend {
             }
             const req = {
                 body: context.getParsedBody(),
-                params: (_b = context.computedConfig.params) !== null && _b !== void 0 ? _b : {},
-                query: context.computedConfig.queryObject,
-                headers: (_c = context.computedConfig.headers) !== null && _c !== void 0 ? _c : {},
+                params: (_b = context.requestConfig.params) !== null && _b !== void 0 ? _b : {},
+                query: context.requestConfig.queryObject,
+                headers: (_c = context.requestConfig.headers) !== null && _c !== void 0 ? _c : {},
                 url: context.requestUrl.toString(),
+                state: context.requestConfig.state,
             };
             const res = {
                 statusCode: -1,
@@ -101,6 +102,7 @@ export default class MockRequestBackend {
                 headers: parsedHeaders,
                 data: res.response,
                 status: res.statusCode,
+                state: context.requestConfig.state,
             };
         });
     }

package/esm/cache/LocalForageCacheBackend.js

@@ -1,5 +1,4 @@
 export default class LocalForageCacheBackend {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     constructor(localforage) {
         this.store = localforage.createInstance({
             name: "requestCache",

package/esm/middleware/LoggingMiddleware.js

@@ -47,11 +47,8 @@ const log = (context, type, message, config, objects) => {
         `color:${color}`,
         "color:gray",
     ];
-    /* eslint-disable-next-line no-console */
     console.groupCollapsed(...args);
-    /* eslint-disable-next-line no-console */
     console.log(Utils.assign({ context: context }, objects || {}));
-    /* eslint-disable-next-line no-console */
     console.groupEnd();
 };
 const LoggingMiddleware = (config = {}) => {

package/esm/util/retry/lib/retry.js

@@ -17,7 +17,6 @@ const _timeouts = (options) => {
     };
     const defaultRetries = 10;
     const opts = Object.assign({ retries: defaultRetries, factor: 2, minTimeout: 1 * 1000, maxTimeout: Number.POSITIVE_INFINITY, randomize: false }, options);
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     if (opts.minTimeout > opts.maxTimeout) {
         throw new Error("minTimeout is greater than maxTimeout");
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.9.4-alpha.2",
+  "version": "0.10.0-alpha.2",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",
@@ -30,20 +30,20 @@
   },
   "repository": "https://github.com/Censkh/api-def",
   "devDependencies": {
-    "@biomejs/biome": "latest",
+    "@biomejs/biome": "1.7.3",
     "@swc/core": "latest",
     "@swc/jest": "latest",
     "@types/axios": "0.14.0",
     "@types/jest": "^29.5.12",
-    "@types/node": "20.12.7",
+    "@types/node": "20.12.11",
     "@types/qs": "6.9.15",
     "axios": "1.6.8",
     "cross-env": "7.0.3",
     "jest": "latest",
     "npm-run-all": "4.1.5",
     "qs": "6.12.1",
-    "rimraf": "5.0.5",
+    "rimraf": "5.0.6",
     "typescript": "5.4.5",
-    "zod": "3.22.5"
+    "zod": "3.23.8"
   }
 }