api-def 0.12.0-alpha.43 → 0.12.0-alpha.44

package/cjs/EndpointBuilder.d.ts

@@ -4,6 +4,9 @@ import type { ResponseType } from "./ApiConstants";
 import type { Body, Params, Query, RawHeaders, State } from "./ApiTypes";
 import Endpoint, { type EndpointOptions } from "./Endpoint";
 type DefaultResponseOf<T extends ResponseType | undefined> = T extends "text" ? string : T extends "arraybuffer" ? ArrayBuffer : "stream" extends T ? AsyncIterable<Uint8Array> : unknown;
+export type EndpointBuildOptions<TResponse = unknown, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined, TPath extends string = string, TResponseType extends ResponseType | undefined = undefined> = Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation"> & {
+    responseType?: TResponseType;
+};
 export default class EndpointBuilder<TResponse = unknown, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> {
     private api;
     private readonly validation;
@@ -15,8 +18,6 @@ export default class EndpointBuilder<TResponse = unknown, TParams extends Params
     stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState, TRequestHeaders, TResponseHeaders>;
     requestHeadersOf<TNewRequestHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TNewRequestHeaders, TResponseHeaders>;
     responseHeadersOf<TNewResponseHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TNewResponseHeaders>;
-    build<TPath extends string, TResponseType extends ResponseType>(options: Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation"> & {
-        responseType?: TResponseType;
-    }): Endpoint<unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>;
+    build<TPath extends string, TResponseType extends ResponseType>(options: EndpointBuildOptions<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TPath, TResponseType>): Endpoint<unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>;
 }
 export {};

package/cjs/EndpointBuilder.js

@@ -12,10 +12,6 @@ var __assign = (this && this.__assign) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var Endpoint_1 = require("./Endpoint");
-/*type ExtractParams<Path> = Path extends `${infer Segment}/${infer Rest}`
-  ? Segment extends `:${infer Param}` ? Param | ExtractParams<Rest> : ExtractParams<Rest>
-  : Path extends `:${infer Param}` ? Param : undefined;
- */
 var EndpointBuilder = /** @class */ (function () {
     function EndpointBuilder(api) {
         this.validation = {};

package/cjs/index.d.ts

@@ -6,6 +6,7 @@ export { default as retry } from "./util/retry";
 export type { RetryOptions } from "./util/retry/interfaces";
 export { isRequestError, type RequestError } from "./RequestError";
 export { default as Endpoint, type EndpointConfig } from "./Endpoint";
+export { default as EndpointBuilder, type EndpointBuildOptions } from "./EndpointBuilder";
 export { clearClientCache, setClientCacheBackend } from "./cache/ClientCaching";
 export { default as LocalStorageClientCacheBackend } from "./cache/LocalStorageClientCacheBackend";
 export { default as LocalForageClientCacheBackend } from "./cache/LocalForageClientCacheBackend";

package/cjs/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoggingMiddleware = exports.ClientCacheMiddleware = exports.FetchRequestBackend = exports.AxiosRequestBackend = exports.LocalForageClientCacheBackend = exports.LocalStorageClientCacheBackend = exports.setClientCacheBackend = exports.clearClientCache = exports.Endpoint = exports.isRequestError = exports.retry = void 0;
+exports.LoggingMiddleware = exports.ClientCacheMiddleware = exports.FetchRequestBackend = exports.AxiosRequestBackend = exports.LocalForageClientCacheBackend = exports.LocalStorageClientCacheBackend = exports.setClientCacheBackend = exports.clearClientCache = exports.EndpointBuilder = exports.Endpoint = exports.isRequestError = exports.retry = void 0;
 __exportStar(require("./Api"), exports);
 __exportStar(require("./ApiTypes"), exports);
 __exportStar(require("./UtilTypes"), exports);
@@ -26,6 +26,8 @@ var RequestError_1 = require("./RequestError");
 Object.defineProperty(exports, "isRequestError", { enumerable: true, get: function () { return RequestError_1.isRequestError; } });
 var Endpoint_1 = require("./Endpoint");
 Object.defineProperty(exports, "Endpoint", { enumerable: true, get: function () { return Endpoint_1.default; } });
+var EndpointBuilder_1 = require("./EndpointBuilder");
+Object.defineProperty(exports, "EndpointBuilder", { enumerable: true, get: function () { return EndpointBuilder_1.default; } });
 var ClientCaching_1 = require("./cache/ClientCaching");
 Object.defineProperty(exports, "clearClientCache", { enumerable: true, get: function () { return ClientCaching_1.clearClientCache; } });
 Object.defineProperty(exports, "setClientCacheBackend", { enumerable: true, get: function () { return ClientCaching_1.setClientCacheBackend; } });

package/esm/EndpointBuilder.d.ts

@@ -4,6 +4,9 @@ import type { ResponseType } from "./ApiConstants";
 import type { Body, Params, Query, RawHeaders, State } from "./ApiTypes";
 import Endpoint, { type EndpointOptions } from "./Endpoint";
 type DefaultResponseOf<T extends ResponseType | undefined> = T extends "text" ? string : T extends "arraybuffer" ? ArrayBuffer : "stream" extends T ? AsyncIterable<Uint8Array> : unknown;
+export type EndpointBuildOptions<TResponse = unknown, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined, TPath extends string = string, TResponseType extends ResponseType | undefined = undefined> = Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation"> & {
+    responseType?: TResponseType;
+};
 export default class EndpointBuilder<TResponse = unknown, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> {
     private api;
     private readonly validation;
@@ -15,8 +18,6 @@ export default class EndpointBuilder<TResponse = unknown, TParams extends Params
     stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState, TRequestHeaders, TResponseHeaders>;
     requestHeadersOf<TNewRequestHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TNewRequestHeaders, TResponseHeaders>;
     responseHeadersOf<TNewResponseHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TNewResponseHeaders>;
-    build<TPath extends string, TResponseType extends ResponseType>(options: Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation"> & {
-        responseType?: TResponseType;
-    }): Endpoint<unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>;
+    build<TPath extends string, TResponseType extends ResponseType>(options: EndpointBuildOptions<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders, TPath, TResponseType>): Endpoint<unknown extends TResponse ? DefaultResponseOf<TResponseType> : TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>;
 }
 export {};

package/esm/EndpointBuilder.js

@@ -1,8 +1,4 @@
 import Endpoint from "./Endpoint";
-/*type ExtractParams<Path> = Path extends `${infer Segment}/${infer Rest}`
-  ? Segment extends `:${infer Param}` ? Param | ExtractParams<Rest> : ExtractParams<Rest>
-  : Path extends `:${infer Param}` ? Param : undefined;
- */
 export default class EndpointBuilder {
     constructor(api) {
         this.validation = {};

package/esm/index.d.ts

@@ -6,6 +6,7 @@ export { default as retry } from "./util/retry";
 export type { RetryOptions } from "./util/retry/interfaces";
 export { isRequestError, type RequestError } from "./RequestError";
 export { default as Endpoint, type EndpointConfig } from "./Endpoint";
+export { default as EndpointBuilder, type EndpointBuildOptions } from "./EndpointBuilder";
 export { clearClientCache, setClientCacheBackend } from "./cache/ClientCaching";
 export { default as LocalStorageClientCacheBackend } from "./cache/LocalStorageClientCacheBackend";
 export { default as LocalForageClientCacheBackend } from "./cache/LocalForageClientCacheBackend";

package/esm/index.js

@@ -6,6 +6,7 @@ export * from "./ApiConstants";
 export { default as retry } from "./util/retry";
 export { isRequestError } from "./RequestError";
 export { default as Endpoint } from "./Endpoint";
+export { default as EndpointBuilder } from "./EndpointBuilder";
 export { clearClientCache, setClientCacheBackend } from "./cache/ClientCaching";
 export { default as LocalStorageClientCacheBackend } from "./cache/LocalStorageClientCacheBackend";
 export { default as LocalForageClientCacheBackend } from "./cache/LocalForageClientCacheBackend";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.12.0-alpha.43",
+  "version": "0.12.0-alpha.44",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",