magicbell-js 1.5.0 → 1.7.0

package/dist/esm/project-client/http/client.js

@@ -6,7 +6,16 @@ import { RetryHandler } from './handlers/retry-handler.js';
 import { TerminatingHandler } from './handlers/terminating-handler.js';
 import { CustomHook } from './hooks/custom-hook.js';
 import { isRequestCursorPagination } from './transport/types.js';
+/**
+ * Core HTTP client for making API requests.
+ * Manages request/response handling through a chain of handlers for validation, retry, hooks, and more.
+ */
 export class HttpClient {
+    /**
+     * Creates a new HTTP client with configured request handlers.
+     * @param config - SDK configuration including base URL and authentication
+     * @param hook - Optional custom hook for request/response interception
+     */
     constructor(config, hook = new CustomHook()) {
         Object.defineProperty(this, "config", {
             enumerable: true,
@@ -14,6 +23,7 @@ export class HttpClient {
             writable: true,
             value: config
         });
+        /** Chain of request handlers that process requests in sequence */
         Object.defineProperty(this, "requestHandlerChain", {
             enumerable: true,
             configurable: true,
@@ -26,12 +36,32 @@ export class HttpClient {
         this.requestHandlerChain.addHandler(new HookHandler(hook));
         this.requestHandlerChain.addHandler(new TerminatingHandler());
     }
+    /**
+     * Executes a standard HTTP request.
+     * @template T - The expected response data type
+     * @param request - The HTTP request to execute
+     * @returns A promise that resolves to the HTTP response
+     */
     call(request) {
         return this.requestHandlerChain.callChain(request);
     }
+    /**
+     * Executes a streaming HTTP request that yields responses incrementally.
+     * @template T - The expected response data type for each chunk
+     * @param request - The HTTP request to execute
+     * @returns An async generator that yields HTTP responses
+     */
     async *stream(request) {
         yield* this.requestHandlerChain.streamChain(request);
     }
+    /**
+     * Executes a paginated HTTP request and extracts the page data from the response.
+     * @template FullResponse - The complete response type from the API
+     * @template Page - The type of a single page of data
+     * @param request - The paginated HTTP request to execute
+     * @returns A promise that resolves to the paginated HTTP response
+     * @throws Error if the response contains no data to paginate through
+     */
     async callPaginated(request) {
         const response = await this.call(request);
         if (!response.data) {
@@ -43,6 +73,14 @@ export class HttpClient {
             data: page,
         };
     }
+    /**
+     * Executes a cursor-paginated HTTP request and extracts both page data and the next cursor.
+     * @template FullResponse - The complete response type from the API
+     * @template Page - The type of a single page of data
+     * @param request - The cursor-paginated HTTP request to execute
+     * @returns A promise that resolves to the cursor-paginated HTTP response with next cursor
+     * @throws Error if the response contains no data to paginate through
+     */
     async callCursorPaginated(request) {
         const response = await this.call(request);
         if (!response.data) {
@@ -56,12 +94,29 @@ export class HttpClient {
             nextCursor,
         };
     }
+    /**
+     * Updates the base URL for all subsequent requests.
+     * @param url - The new base URL to use
+     */
     setBaseUrl(url) {
         this.config.baseUrl = url;
     }
+    /**
+     * Updates the SDK configuration.
+     * @param config - The new SDK configuration
+     */
     setConfig(config) {
         this.config = config;
     }
+    /**
+     * Extracts page data from a full API response using the configured pagination path.
+     * @template FullResponse - The complete response type from the API
+     * @template Page - The type of a single page of data
+     * @param request - The request containing pagination configuration
+     * @param data - The full response data to extract the page from
+     * @returns The extracted and parsed page data
+     * @throws Error if pagination is not configured or page extraction fails
+     */
     getPage(request, data) {
         var _a;
         if (!request.pagination) {
@@ -77,6 +132,14 @@ export class HttpClient {
         }
         return page;
     }
+    /**
+     * Extracts the next cursor from a full API response for cursor-based pagination.
+     * @template FullResponse - The complete response type from the API
+     * @template Page - The type of a single page of data
+     * @param request - The request containing cursor pagination configuration
+     * @param data - The full response data to extract the cursor from
+     * @returns The next cursor string, null if no more pages, or undefined if not cursor pagination
+     */
     getNextCursor(request, data) {
         var _a, _b;
         if (!isRequestCursorPagination(request.pagination)) {

package/dist/esm/project-client/http/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/project-client/http/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,2CAA2C,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAGjE,MAAM,OAAO,UAAU;IAGrB,YAAoB,MAAiB,EAAE,IAAI,GAAG,IAAI,UAAU,EAAE;QAAlD;;;;mBAAQ,MAAM;WAAW;QAFpB;;;;mBAAsB,IAAI,mBAAmB,EAAE;WAAC;QAG/D,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,yBAAyB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,wBAAwB,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,kBAAkB,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,CAAI,OAAgB;QACtB,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,CAAC,MAAM,CAAI,OAAgB;QAC/B,KAAK,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAqB,OAAsB;QACnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAe,OAAc,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAqB,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEtE,OAAO;YACL,GAAG,QAAQ;YACX,IAAI,EAAE,IAAI;SACX,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,OAAsB;QAEtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAe,OAAc,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAqB,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAqB,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAElF,OAAO;YACL,GAAG,QAAQ;YACX,IAAI,EAAE,IAAI;YACV,UAAU;SACX,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,GAAW;QACpB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED,SAAS,CAAC,MAAiB;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEO,OAAO,CAAqB,OAAsB,EAAE,IAAkB;;QAC5E,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACxD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAED,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,UAAU,CAAC,UAAU,0CAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACb,kCAAkC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eACpD,OAAO,CAAC,UAAU,CAAC,QACrB,WAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAClC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,aAAa,CAAqB,OAAsB,EAAE,IAAkB;;QAClF,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;YACpD,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxC,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,MAAA,MAAA,OAAO,CAAC,UAAU,CAAC,YAAY,0CAAE,KAAK,CAAC,IAAI,CAAC,mCAAI,IAAI,CAAC;IAC9D,CAAC;CACF"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/project-client/http/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,2CAA2C,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAGjE;;;GAGG;AACH,MAAM,OAAO,UAAU;IAIrB;;;;OAIG;IACH,YAAoB,MAAiB,EAAE,IAAI,GAAG,IAAI,UAAU,EAAE;QAAlD;;;;mBAAQ,MAAM;WAAW;QARrC,kEAAkE;QACjD;;;;mBAAsB,IAAI,mBAAmB,EAAE;WAAC;QAQ/D,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,yBAAyB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,wBAAwB,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,kBAAkB,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAI,OAAgB;QACtB,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,CAAC,MAAM,CAAI,OAAgB;QAC/B,KAAK,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,aAAa,CAAqB,OAAsB;QACnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAe,OAAc,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAqB,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEtE,OAAO;YACL,GAAG,QAAQ;YACX,IAAI,EAAE,IAAI;SACX,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,mBAAmB,CAC9B,OAAsB;QAEtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAe,OAAc,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAqB,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtE,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAqB,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAElF,OAAO;YACL,GAAG,QAAQ;YACX,IAAI,EAAE,IAAI;YACV,UAAU;SACX,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,GAAW;QACpB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAAiB;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACK,OAAO,CAAqB,OAAsB,EAAE,IAAkB;;QAC5E,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;YACxD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAED,MAAM,IAAI,GAAG,MAAA,OAAO,CAAC,UAAU,CAAC,UAAU,0CAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACb,kCAAkC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eACpD,OAAO,CAAC,UAAU,CAAC,QACrB,WAAW,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAClC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACK,aAAa,CAAqB,OAAsB,EAAE,IAAkB;;QAClF,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;YACpD,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxC,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,MAAA,MAAA,OAAO,CAAC,UAAU,CAAC,YAAY,0CAAE,KAAK,CAAC,IAAI,CAAC,mCAAI,IAAI,CAAC;IAC9D,CAAC;CACF"}

package/dist/esm/project-client/http/environment.d.ts

@@ -1,4 +1,9 @@
+/**
+ * Available API environments with their base URLs.
+ * Use these constants to configure the SDK for different environments (production, staging, etc.).
+ */
 export declare enum Environment {
+    /** DEFAULT environment base URL */
     DEFAULT = "https://api.magicbell.com/v2"
 }
 //# sourceMappingURL=environment.d.ts.map

package/dist/esm/project-client/http/environment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../../src/project-client/http/environment.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW;IACrB,OAAO,iCAAiC;CACzC"}
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../../src/project-client/http/environment.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,WAAW;IACrB,mCAAmC;IACnC,OAAO,iCAAiC;CACzC"}

package/dist/esm/project-client/http/environment.js

@@ -1,5 +1,10 @@
+/**
+ * Available API environments with their base URLs.
+ * Use these constants to configure the SDK for different environments (production, staging, etc.).
+ */
 export var Environment;
 (function (Environment) {
+    /** DEFAULT environment base URL */
     Environment["DEFAULT"] = "https://api.magicbell.com/v2";
 })(Environment || (Environment = {}));
 //# sourceMappingURL=environment.js.map

package/dist/esm/project-client/http/environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../../src/project-client/http/environment.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,WAEX;AAFD,WAAY,WAAW;IACrB,uDAAwC,CAAA;AAC1C,CAAC,EAFW,WAAW,KAAX,WAAW,QAEtB"}
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../../src/project-client/http/environment.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,mCAAmC;IACnC,uDAAwC,CAAA;AAC1C,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}

package/dist/esm/project-client/http/error.d.ts

@@ -1,8 +1,21 @@
 import { HttpMetadata } from './types.js';
+/**
+ * Error class for HTTP request failures.
+ * Captures error details including status, metadata, and the raw response.
+ */
 export declare class HttpError extends Error {
+    /** Error message or status text */
     readonly error: string;
+    /** HTTP response metadata (status, headers, etc.) */
     readonly metadata: HttpMetadata;
+    /** Raw response object from the HTTP client */
     readonly raw?: ArrayBuffer;
+    /**
+     * Creates a new HTTP error.
+     * @param metadata - HTTP response metadata
+     * @param raw - Raw response object (optional)
+     * @param error - Custom error message (optional, defaults to status text)
+     */
     constructor(metadata: HttpMetadata, raw?: ArrayBuffer, error?: string);
 }
 //# sourceMappingURL=error.d.ts.map

package/dist/esm/project-client/http/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../src/project-client/http/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,qBAAa,SAAU,SAAQ,KAAK;IAClC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,SAAgB,GAAG,CAAC,EAAE,WAAW,CAAC;gBAEtB,QAAQ,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM;CAMtE"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../src/project-client/http/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,mCAAmC;IACnC,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,qDAAqD;IACrD,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,+CAA+C;IAC/C,SAAgB,GAAG,CAAC,EAAE,WAAW,CAAC;IAElC;;;;;OAKG;gBACS,QAAQ,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM;CAMtE"}

package/dist/esm/project-client/http/error.js

@@ -1,18 +1,31 @@
+/**
+ * Error class for HTTP request failures.
+ * Captures error details including status, metadata, and the raw response.
+ */
 export class HttpError extends Error {
+    /**
+     * Creates a new HTTP error.
+     * @param metadata - HTTP response metadata
+     * @param raw - Raw response object (optional)
+     * @param error - Custom error message (optional, defaults to status text)
+     */
     constructor(metadata, raw, error) {
         super(error);
+        /** Error message or status text */
         Object.defineProperty(this, "error", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** HTTP response metadata (status, headers, etc.) */
         Object.defineProperty(this, "metadata", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Raw response object from the HTTP client */
         Object.defineProperty(this, "raw", {
             enumerable: true,
             configurable: true,

package/dist/esm/project-client/http/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../../src/project-client/http/error.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,SAAU,SAAQ,KAAK;IAKlC,YAAY,QAAsB,EAAE,GAAiB,EAAE,KAAc;QACnE,KAAK,CAAC,KAAK,CAAC,CAAC;QALC;;;;;WAAc;QACd;;;;;WAAuB;QACvB;;;;;WAAkB;QAIhC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;CACF"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../../src/project-client/http/error.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAQlC;;;;;OAKG;IACH,YAAY,QAAsB,EAAE,GAAiB,EAAE,KAAc;QACnE,KAAK,CAAC,KAAK,CAAC,CAAC;QAdf,mCAAmC;QACnB;;;;;WAAc;QAC9B,qDAAqD;QACrC;;;;;WAAuB;QACvC,+CAA+C;QAC/B;;;;;WAAkB;QAUhC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;CACF"}

package/dist/esm/project-client/http/errors/throwable-error.d.ts

@@ -1,7 +1,21 @@
+/**
+ * Error class that can be thrown explicitly via a throw() method.
+ * Extends the built-in Error class with a convenience method for throwing.
+ */
 export declare class ThrowableError extends Error {
     message: string;
     protected response?: unknown | undefined;
+    /**
+     * Creates a new throwable error.
+     * @param message - The error message
+     * @param response - Optional response data associated with the error
+     */
     constructor(message: string, response?: unknown | undefined);
+    /**
+     * Throws this error instance.
+     * Convenience method for explicitly throwing the error.
+     * @throws This error instance
+     */
     throw(): void;
 }
 //# sourceMappingURL=throwable-error.d.ts.map

package/dist/esm/project-client/http/errors/throwable-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"throwable-error.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/throwable-error.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAe,SAAQ,KAAK;IACpB,OAAO,EAAE,MAAM;IAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO;gBAA7C,OAAO,EAAE,MAAM,EAAY,QAAQ,CAAC,EAAE,OAAO,YAAA;IAIzD,KAAK;CAGb"}
+{"version":3,"file":"throwable-error.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/throwable-error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAMpB,OAAO,EAAE,MAAM;IAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO;IALhE;;;;OAIG;gBACgB,OAAO,EAAE,MAAM,EAAY,QAAQ,CAAC,EAAE,OAAO,YAAA;IAIhE;;;;OAIG;IACI,KAAK;CAGb"}

package/dist/esm/project-client/http/errors/throwable-error.js

@@ -1,4 +1,13 @@
+/**
+ * Error class that can be thrown explicitly via a throw() method.
+ * Extends the built-in Error class with a convenience method for throwing.
+ */
 export class ThrowableError extends Error {
+    /**
+     * Creates a new throwable error.
+     * @param message - The error message
+     * @param response - Optional response data associated with the error
+     */
     constructor(message, response) {
         super(message);
         Object.defineProperty(this, "message", {
@@ -14,6 +23,11 @@ export class ThrowableError extends Error {
             value: response
         });
     }
+    /**
+     * Throws this error instance.
+     * Convenience method for explicitly throwing the error.
+     * @throws This error instance
+     */
     throw() {
         throw this;
     }

package/dist/esm/project-client/http/errors/throwable-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"throwable-error.js","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/throwable-error.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvC,YAAmB,OAAe,EAAY,QAAkB;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC;QADL;;;;mBAAO,OAAO;WAAQ;QAAE;;;;mBAAU,QAAQ;WAAU;IAEhE,CAAC;IAEM,KAAK;QACV,MAAM,IAAI,CAAC;IACb,CAAC;CACF"}
+{"version":3,"file":"throwable-error.js","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/throwable-error.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvC;;;;OAIG;IACH,YAAmB,OAAe,EAAY,QAAkB;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC;QADL;;;;mBAAO,OAAO;WAAQ;QAAE;;;;mBAAU,QAAQ;WAAU;IAEhE,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,MAAM,IAAI,CAAC;IACb,CAAC;CACF"}

package/dist/esm/project-client/http/errors/validation-error.d.ts

@@ -1,6 +1,16 @@
 import { ZodError } from 'zod';
+/**
+ * Error class for data validation failures using Zod schemas.
+ * Provides detailed information about which properties failed validation and why.
+ */
 export declare class ValidationError extends Error {
+    /** Formatted error message with validation details */
     readonly error: string;
+    /**
+     * Creates a new validation error from a Zod error.
+     * @param zodError - The Zod validation error containing issue details
+     * @param object - The object that failed validation
+     */
     constructor(zodError: ZodError, object: any);
 }
 //# sourceMappingURL=validation-error.d.ts.map

package/dist/esm/project-client/http/errors/validation-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation-error.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/validation-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAE/B,qBAAa,eAAgB,SAAQ,KAAK;IACxC,SAAgB,KAAK,EAAE,MAAM,CAAC;gBAElB,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG;CAmB5C"}
+{"version":3,"file":"validation-error.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/validation-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAE/B;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IACxC,sDAAsD;IACtD,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;gBACS,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG;CAmB5C"}

package/dist/esm/project-client/http/errors/validation-error.js

@@ -1,4 +1,13 @@
+/**
+ * Error class for data validation failures using Zod schemas.
+ * Provides detailed information about which properties failed validation and why.
+ */
 export class ValidationError extends Error {
+    /**
+     * Creates a new validation error from a Zod error.
+     * @param zodError - The Zod validation error containing issue details
+     * @param object - The object that failed validation
+     */
     constructor(zodError, object) {
         let actual;
         try {
@@ -14,6 +23,7 @@ export class ValidationError extends Error {
             ...actual.split('\n').map((line) => `  ${line}`),
         ].join('\n');
         super(error);
+        /** Formatted error message with validation details */
         Object.defineProperty(this, "error", {
             enumerable: true,
             configurable: true,

package/dist/esm/project-client/http/errors/validation-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"validation-error.js","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/validation-error.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAGxC,YAAY,QAAkB,EAAE,MAAW;QACzC,IAAI,MAAc,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,MAAM,CAAC;QAClB,CAAC;QAED,MAAM,KAAK,GAAG;YACZ,kBAAkB;YAClB,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,KAAK,CAAC,OAAO,EAAE,CAAC;YACnG,cAAc;YACd,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;SACjD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,KAAK,CAAC,KAAK,CAAC,CAAC;QAjBC;;;;;WAAc;QAmB5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}
+{"version":3,"file":"validation-error.js","sourceRoot":"","sources":["../../../../../src/project-client/http/errors/validation-error.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAIxC;;;;OAIG;IACH,YAAY,QAAkB,EAAE,MAAW;QACzC,IAAI,MAAc,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,GAAG,MAAM,CAAC;QAClB,CAAC;QAED,MAAM,KAAK,GAAG;YACZ,kBAAkB;YAClB,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,KAAK,CAAC,OAAO,EAAE,CAAC;YACnG,cAAc;YACd,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;SACjD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,KAAK,CAAC,KAAK,CAAC,CAAC;QAvBf,sDAAsD;QACtC;;;;;WAAc;QAwB5B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}

package/dist/esm/project-client/http/handlers/handler-chain.d.ts

@@ -1,9 +1,33 @@
 import { Request } from '../transport/request.js';
 import { HttpResponse, RequestHandler } from '../types.js';
+/**
+ * Chain of Responsibility pattern implementation for request handlers.
+ * Manages a linked chain of handlers that process HTTP requests sequentially.
+ */
 export declare class RequestHandlerChain {
+    /** Array of handlers in the chain */
     private readonly handlers;
+    /**
+     * Adds a handler to the end of the chain.
+     * Links the new handler to the previous one in the chain.
+     * @param handler - The request handler to add
+     */
     addHandler(handler: RequestHandler): void;
+    /**
+     * Executes the handler chain for a standard request.
+     * @template T - The expected response data type
+     * @param request - The HTTP request to process
+     * @returns A promise that resolves to the HTTP response
+     * @throws Error if no handlers are added to the chain
+     */
     callChain<T>(request: Request): Promise<HttpResponse<T>>;
+    /**
+     * Executes the handler chain for a streaming request.
+     * @template T - The expected response data type for each chunk
+     * @param request - The HTTP request to process
+     * @returns An async generator that yields HTTP responses
+     * @throws Error if no handlers are added to the chain
+     */
     streamChain<T>(request: Request): AsyncGenerator<HttpResponse<T>>;
 }
 //# sourceMappingURL=handler-chain.d.ts.map

package/dist/esm/project-client/http/handlers/handler-chain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handler-chain.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/handler-chain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAwB;IAEjD,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAQnC,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAQvD,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAOzE"}
+{"version":3,"file":"handler-chain.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/handler-chain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAwB;IAEjD;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAQzC;;;;;;OAMG;IACG,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAQ9D;;;;;;OAMG;IACI,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAOzE"}

package/dist/esm/project-client/http/handlers/handler-chain.js

@@ -1,5 +1,10 @@
+/**
+ * Chain of Responsibility pattern implementation for request handlers.
+ * Manages a linked chain of handlers that process HTTP requests sequentially.
+ */
 export class RequestHandlerChain {
     constructor() {
+        /** Array of handlers in the chain */
         Object.defineProperty(this, "handlers", {
             enumerable: true,
             configurable: true,
@@ -7,6 +12,11 @@ export class RequestHandlerChain {
             value: []
         });
     }
+    /**
+     * Adds a handler to the end of the chain.
+     * Links the new handler to the previous one in the chain.
+     * @param handler - The request handler to add
+     */
     addHandler(handler) {
         if (this.handlers.length > 0) {
             const previousHandler = this.handlers[this.handlers.length - 1];
@@ -14,12 +24,26 @@ export class RequestHandlerChain {
         }
         this.handlers.push(handler);
     }
+    /**
+     * Executes the handler chain for a standard request.
+     * @template T - The expected response data type
+     * @param request - The HTTP request to process
+     * @returns A promise that resolves to the HTTP response
+     * @throws Error if no handlers are added to the chain
+     */
     async callChain(request) {
         if (!this.handlers.length) {
             throw new Error('No handlers added to the chain');
         }
         return this.handlers[0].handle(request);
     }
+    /**
+     * Executes the handler chain for a streaming request.
+     * @template T - The expected response data type for each chunk
+     * @param request - The HTTP request to process
+     * @returns An async generator that yields HTTP responses
+     * @throws Error if no handlers are added to the chain
+     */
     async *streamChain(request) {
         if (!this.handlers.length) {
             throw new Error('No handlers added to the chain');

package/dist/esm/project-client/http/handlers/handler-chain.js.map

@@ -1 +1 @@
-{"version":3,"file":"handler-chain.js","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/handler-chain.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,mBAAmB;IAAhC;QACmB;;;;mBAA6B,EAAE;WAAC;IAyBnD,CAAC;IAvBC,UAAU,CAAC,OAAuB;QAChC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAChE,eAAe,CAAC,IAAI,GAAG,OAAO,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,SAAS,CAAI,OAAgB;QACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAI,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,CAAC,WAAW,CAAI,OAAgB;QACpC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAI,OAAO,CAAC,CAAC;IAC7C,CAAC;CACF"}
+{"version":3,"file":"handler-chain.js","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/handler-chain.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAAhC;QACE,qCAAqC;QACpB;;;;mBAA6B,EAAE;WAAC;IA4CnD,CAAC;IA1CC;;;;OAIG;IACH,UAAU,CAAC,OAAuB;QAChC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAChE,eAAe,CAAC,IAAI,GAAG,OAAO,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CAAI,OAAgB;QACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAI,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,WAAW,CAAI,OAAgB;QACpC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAI,OAAO,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/esm/project-client/http/handlers/hook-handler.d.ts

@@ -1,12 +1,39 @@
 import { Hook } from '../hooks/hook.js';
 import { Request } from '../transport/request.js';
 import { HttpResponse, RequestHandler } from '../types.js';
+/**
+ * Request handler that invokes custom hooks before requests and after responses.
+ * Enables request/response interception and custom error handling.
+ */
 export declare class HookHandler implements RequestHandler {
     private readonly hook;
+    /** Next handler in the chain */
     next?: RequestHandler;
     constructor(hook: Hook);
+    /**
+     * Handles a standard HTTP request with hook invocation.
+     * Calls beforeRequest hook, processes the request, and calls afterResponse or onError hooks.
+     * @template T - The expected response data type
+     * @param request - The HTTP request to process
+     * @returns A promise that resolves to the HTTP response
+     * @throws Error if no next handler is set, or if error handling fails
+     */
     handle<T>(request: Request): Promise<HttpResponse<T>>;
+    /**
+     * Handles a streaming HTTP request with hook invocation.
+     * Calls beforeRequest hook and afterResponse/onError hooks for each chunk.
+     * @template T - The expected response data type for each chunk
+     * @param request - The HTTP request to process
+     * @returns An async generator that yields HTTP responses
+     * @throws Error if no next handler is set, or if error handling fails
+     */
     stream<T>(request: Request): AsyncGenerator<HttpResponse<T>>;
+    /**
+     * Extracts hook parameters from the request configuration.
+     * @template T - The response data type
+     * @param request - The HTTP request
+     * @returns A map of hook parameter names to values
+     */
     private getHookParams;
 }
 //# sourceMappingURL=hook-handler.d.ts.map

package/dist/esm/project-client/http/handlers/hook-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hook-handler.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/hook-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAGlD,OAAO,EAAe,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAGxE,qBAAa,WAAY,YAAW,cAAc;IAGpC,OAAO,CAAC,QAAQ,CAAC,IAAI;IAFjC,IAAI,CAAC,EAAE,cAAc,CAAC;gBAEO,IAAI,EAAE,IAAI;IAEjC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IA0CpD,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAsBnE,OAAO,CAAC,aAAa;CAItB"}
+{"version":3,"file":"hook-handler.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/hook-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAGlD,OAAO,EAAe,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAGxE;;;GAGG;AACH,qBAAa,WAAY,YAAW,cAAc;IAIpC,OAAO,CAAC,QAAQ,CAAC,IAAI;IAHjC,gCAAgC;IAChC,IAAI,CAAC,EAAE,cAAc,CAAC;gBAEO,IAAI,EAAE,IAAI;IAEvC;;;;;;;OAOG;IACG,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IA0C3D;;;;;;;OAOG;IACI,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAsBnE;;;;;OAKG;IACH,OAAO,CAAC,aAAa;CAItB"}

package/dist/esm/project-client/http/handlers/hook-handler.js

@@ -1,6 +1,10 @@
 import { HttpError } from '../error.js';
 import { TransportHookAdapter } from '../transport/transport-hook-adapter.js';
 import { getContentTypeDefinition } from '../utils/content-type.js';
+/**
+ * Request handler that invokes custom hooks before requests and after responses.
+ * Enables request/response interception and custom error handling.
+ */
 export class HookHandler {
     constructor(hook) {
         Object.defineProperty(this, "hook", {
@@ -9,6 +13,7 @@ export class HookHandler {
             writable: true,
             value: hook
         });
+        /** Next handler in the chain */
         Object.defineProperty(this, "next", {
             enumerable: true,
             configurable: true,
@@ -16,6 +21,14 @@ export class HookHandler {
             value: void 0
         });
     }
+    /**
+     * Handles a standard HTTP request with hook invocation.
+     * Calls beforeRequest hook, processes the request, and calls afterResponse or onError hooks.
+     * @template T - The expected response data type
+     * @param request - The HTTP request to process
+     * @returns A promise that resolves to the HTTP response
+     * @throws Error if no next handler is set, or if error handling fails
+     */
     async handle(request) {
         var _a;
         if (!this.next) {
@@ -44,6 +57,14 @@ export class HookHandler {
         const decodedBody = new TextDecoder().decode(arrayBuffer);
         throw new HttpError(response.metadata, arrayBuffer, `Unexpected response body for error status.\nStatusCode: ${response.metadata.status}\nBody: ${decodedBody}`);
     }
+    /**
+     * Handles a streaming HTTP request with hook invocation.
+     * Calls beforeRequest hook and afterResponse/onError hooks for each chunk.
+     * @template T - The expected response data type for each chunk
+     * @param request - The HTTP request to process
+     * @returns An async generator that yields HTTP responses
+     * @throws Error if no next handler is set, or if error handling fails
+     */
     async *stream(request) {
         if (!this.next) {
             throw new Error('No next handler set in hook handler.');
@@ -61,6 +82,12 @@ export class HookHandler {
             }
         }
     }
+    /**
+     * Extracts hook parameters from the request configuration.
+     * @template T - The response data type
+     * @param request - The HTTP request
+     * @returns A map of hook parameter names to values
+     */
     getHookParams(_request) {
         const hookParams = new Map();
         return hookParams;

package/dist/esm/project-client/http/handlers/hook-handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"hook-handler.js","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/hook-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAG9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,MAAM,OAAO,WAAW;IAGtB,YAA6B,IAAU;QAA3B;;;;mBAAiB,IAAI;WAAM;QAFvC;;;;;WAAsB;IAEoB,CAAC;IAE3C,KAAK,CAAC,MAAM,CAAI,OAAgB;;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,oBAAoB,EAAK,CAAC;QAE3C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAI,OAAO,CAAC,CAAC;QAElD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAI,WAAW,CAAC,CAAC;QAExD,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACnC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACrE,CAAC;QAED,yBAAyB;QACzB,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;QAEjC,MAAM,cAAc,GAAG,CAAA,MAAA,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,0CAAE,iBAAiB,EAAE,KAAI,EAAE,CAAC;QAC5F,MAAM,WAAW,GAAG,wBAAwB,CAAC,cAAc,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAE5C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAA4B,EAAE;YACpE,OAAO,KAAK,CAAC,WAAW,KAAK,WAAW,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,CAAC;QAC1E,CAAC,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAY,aAAZ,IAAI,uBAAJ,IAAI,CAAU,OAAO,KAAI,EAAE,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;QAC9D,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC1D,MAAM,IAAI,SAAS,CACjB,QAAQ,CAAC,QAAQ,EACjB,WAAW,EACX,2DAA2D,QAAQ,CAAC,QAAQ,CAAC,MAAM,WAAW,WAAW,EAAE,CAC5G,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,CAAC,MAAM,CAAI,OAAgB;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,oBAAoB,EAAK,CAAC;QAE3C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAI,OAAO,CAAC,CAAC;QAElD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAI,WAAW,CAAC,CAAC;QAEhD,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,MAAM,EAAE,CAAC;YACpC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACnC,MAAM,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpE,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;IACH,CAAC;IAEO,aAAa,CAAI,QAAiB;QACxC,MAAM,UAAU,GAAwB,IAAI,GAAG,EAAE,CAAC;QAClD,OAAO,UAAU,CAAC;IACpB,CAAC;CACF"}
+{"version":3,"file":"hook-handler.js","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/hook-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAG9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,WAAW;IAItB,YAA6B,IAAU;QAA3B;;;;mBAAiB,IAAI;WAAM;QAHvC,gCAAgC;QAChC;;;;;WAAsB;IAEoB,CAAC;IAE3C;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAI,OAAgB;;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,oBAAoB,EAAK,CAAC;QAE3C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAI,OAAO,CAAC,CAAC;QAElD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAI,WAAW,CAAC,CAAC;QAExD,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACnC,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACrE,CAAC;QAED,yBAAyB;QACzB,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;QAEjC,MAAM,cAAc,GAAG,CAAA,MAAA,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,0CAAE,iBAAiB,EAAE,KAAI,EAAE,CAAC;QAC5F,MAAM,WAAW,GAAG,wBAAwB,CAAC,cAAc,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAE5C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAA4B,EAAE;YACpE,OAAO,KAAK,CAAC,WAAW,KAAK,WAAW,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,CAAC;QAC1E,CAAC,CAAC,CAAC;QAEH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAY,aAAZ,IAAI,uBAAJ,IAAI,CAAU,OAAO,KAAI,EAAE,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;QAC9D,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC1D,MAAM,IAAI,SAAS,CACjB,QAAQ,CAAC,QAAQ,EACjB,WAAW,EACX,2DAA2D,QAAQ,CAAC,QAAQ,CAAC,MAAM,WAAW,WAAW,EAAE,CAC5G,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,CAAC,MAAM,CAAI,OAAgB;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,oBAAoB,EAAK,CAAC;QAE3C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAI,OAAO,CAAC,CAAC;QAElD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAI,WAAW,CAAC,CAAC;QAEhD,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,MAAM,EAAE,CAAC;YACpC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACnC,MAAM,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;YACpE,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,aAAa,CAAI,QAAiB;QACxC,MAAM,UAAU,GAAwB,IAAI,GAAG,EAAE,CAAC;QAClD,OAAO,UAAU,CAAC;IACpB,CAAC;CACF"}

package/dist/esm/project-client/http/handlers/request-validation-handler.d.ts

@@ -1,11 +1,48 @@
 import { Request } from '../transport/request.js';
 import { HttpResponse, RequestHandler } from '../types.js';
+/**
+ * Request handler that validates and serializes request bodies based on content type.
+ * Supports JSON, XML, text, binary, form data, and multipart form data.
+ */
 export declare class RequestValidationHandler implements RequestHandler {
+    /** Next handler in the chain */
     next?: RequestHandler;
+    /**
+     * Handles a standard HTTP request with validation.
+     * @template T - The expected response data type
+     * @param request - The HTTP request to validate
+     * @returns A promise that resolves to the HTTP response
+     * @throws Error if no next handler is set
+     */
     handle<T>(request: Request): Promise<HttpResponse<T>>;
+    /**
+     * Handles a streaming HTTP request with validation.
+     * @template T - The expected response data type for each chunk
+     * @param request - The HTTP request to validate
+     * @returns An async generator that yields HTTP responses
+     * @throws Error if no next handler is set
+     */
     stream<T>(request: Request): AsyncGenerator<HttpResponse<T>>;
+    /**
+     * Validates and serializes the request body based on its content type.
+     * @param request - The HTTP request to validate
+     * @throws ValidationError if Zod schema validation fails
+     */
     validateRequest(request: Request): void;
+    /**
+     * Converts request body to URL-encoded form data format.
+     * @param request - The HTTP request with body to convert
+     * @returns URL-encoded string representation of the body
+     */
     toFormUrlEncoded(request: Request): string;
+    /**
+     * Converts request body to multipart form data format.
+     * Handles files (ArrayBuffer), arrays, and regular values.
+     * @param body - The request body object
+     * @param filename - Optional filename for single file uploads
+     * @param filenames - Optional filenames array for array of file uploads
+     * @returns FormData object with serialized body
+     */
     toFormData(body: Record<string, any>, filename?: string, filenames?: string[]): FormData;
 }
 //# sourceMappingURL=request-validation-handler.d.ts.map

package/dist/esm/project-client/http/handlers/request-validation-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request-validation-handler.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/request-validation-handler.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAe,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAExE,qBAAa,wBAAyB,YAAW,cAAc;IAC7D,IAAI,CAAC,EAAE,cAAc,CAAC;IAEhB,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAUpD,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAUnE,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IA2BvC,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAsC1C,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,QAAQ;CA0BzF"}
+{"version":3,"file":"request-validation-handler.d.ts","sourceRoot":"","sources":["../../../../../src/project-client/http/handlers/request-validation-handler.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAe,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAExE;;;GAGG;AACH,qBAAa,wBAAyB,YAAW,cAAc;IAC7D,gCAAgC;IAChC,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB;;;;;;OAMG;IACG,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAU3D;;;;;;OAMG;IACI,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAUnE;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IA2BvC;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAsC1C;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,QAAQ;CA0BzF"}