@zcatalyst/transport 0.0.2 → 0.0.3

package/dist-es/utils/request-agent.js

@@ -1,4 +1,3 @@
-'use strict';
 import { CONSTANTS } from '@zcatalyst/utils';
 import { Agent as httpAgent } from 'http';
 import { Agent as httpsAgent } from 'https';

package/dist-types/fetch-handler.d.ts

@@ -1,8 +1,4 @@
-import { ConfigManager } from '@zcatalyst/auth-client';
 import { CoreType, IRequestConfig, jwtAccessTokenResponse, RequestHandlerOptions } from './utils/interfaces';
-export declare const keepAliveSupport: {
-    supported: undefined | boolean;
-};
 type ICatalystDataRes = Record<string, string> | string | Blob | ArrayBuffer | ReadableStreamDefaultReader<Uint8Array> | FormData;
 export interface ICatalystClientRes {
     request: RequestInit;
@@ -19,22 +15,135 @@ export declare class DefaultHttpResponse {
     headers: HeadersInit;
     config: RequestHandlerOptions;
     resp: ICatalystClientRes;
+    /**
+     * Creates a DefaultHttpResponse instance.
+     * @param resp - The resp value.
+     */
     constructor(resp: ICatalystClientRes);
+    /**
+     * Returns the data value for this DefaultHttpResponse instance.
+     *
+     * @returns The response payload.
+     * @throws {CatalystAPIError} when the request or response cannot be processed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     get data(): ICatalystDataRes;
 }
 export declare class ResponseHandler {
     #private;
-    static configManager: ConfigManager;
+    static apiDomain: string;
+    /**
+     * Creates a ResponseHandler instance.
+     */
     constructor();
+    /**
+     * Sends a browser fetch request with SDK authentication, timeout and response handling.
+     *
+     * @param options - The initialization or request options.
+     * @param options.requestCore - The Fetch API request configuration.
+     * @param options.url - The URL to update or request.
+     * @param requestOptions - The request handling options.
+     * @returns The fire general request result.
+     * @throws {CatalystAPIError} when the request or response cannot be processed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.fireGeneralRequest({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static fireGeneralRequest({ requestCore, url }: {
         requestCore: RequestInit;
         url: string;
     }, requestOptions?: RequestHandlerOptions): Promise<DefaultHttpResponse | void>;
+    /**
+     * Wraps a Fetch API response in the SDK response object.
+     *
+     * @param response - The response to wrap.
+     * @param options - The initialization or request options.
+     * @returns The wrap response result.
+     * @throws {CatalystAPIError} when the request or response cannot be processed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.wrapResponse({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static wrapResponse(response: Response, options?: RequestHandlerOptions): Promise<DefaultHttpResponse>;
+    /**
+     * Sends a browser fetch request without retry handling.
+     *
+     * @param requestCore - The Fetch API request configuration.
+     * @param reqOptions - The raw request handling options.
+     * @returns The fire raw request result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.fireRawRequest({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static fireRawRequest(requestCore: CoreType, reqOptions: RequestHandlerOptions): Promise<DefaultHttpResponse>;
+    /**
+     * Attaches browser authentication headers according to the configured auth protocol.
+     *
+     * @param headers - The headers object to mutate or extend.
+     * @returns The attach zcauth headers result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.attachZCAuthHeaders({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static attachZCAuthHeaders(headers: HeadersInit): Promise<HeadersInit>;
+    /**
+     * Builds the browser JWT authorization token from the configured cookie.
+     *
+     * @returns The get jwtzcauth token result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.getJWTZCAuthToken({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static getJWTZCAuthToken(): Promise<jwtAccessTokenResponse>;
+    /**
+     * Appends query parameters to a URL.
+     *
+     * @param url - The URL to update or request.
+     * @param qs - The query string values to append.
+     * @returns The URL with encoded query parameters.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.appendQueryString({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static appendQueryString(url: string, qs?: Record<string, string | number | boolean | undefined>): string;
-    static send(options: IRequestConfig): Promise<DefaultHttpResponse | void>;
+    /**
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param options - The initialization or request options.
+     * @param componentName - The component name for user-agent metadata.
+     * @param componentVersion - The component version for user-agent metadata.
+     * @returns The send result.
+     * @throws {CatalystAPIError} when the request or response cannot be processed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.send({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
+    static send(options: IRequestConfig, componentName?: string, componentVersion?: string): Promise<DefaultHttpResponse | void>;
 }
 export {};

package/dist-types/http-handler.d.ts

@@ -1,4 +1,4 @@
-import { CatalystApp } from '@zcatalyst/auth';
+import { CatalystApp } from '@zcatalyst/auth-admin';
 import { ClientRequest, IncomingHttpHeaders, IncomingMessage } from 'http';
 import { Component, IRequestConfig } from './utils/interfaces';
 export interface IAPIResponse {
@@ -15,25 +15,65 @@ export declare class DefaultHttpResponse {
     headers: IncomingHttpHeaders;
     config: IRequestConfig;
     resp: IAPIResponse;
+    /**
+     * Creates a DefaultHttpResponse instance.
+     * @param resp - The resp value.
+     */
     constructor(resp: IAPIResponse);
+    /**
+     * Returns the parsed response payload.
+     *
+     * @returns The data result.
+     * @throws {CatalystAPIError} when the operation cannot be completed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * // Use DefaultHttpResponse.data while preparing or sending an SDK request.
+     * ```
+     */
     get data(): any;
 }
 export declare class HttpClient {
     app?: CatalystApp;
-    private user;
+    /** * @param app - The app used to fetch access tokens to sign API requests. */
+    constructor(app?: CatalystApp);
     /**
-     * @param {CatalystApp} app The app used to fetch access tokens to sign API requests.
-     * @constructor
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param req - The req value.
+     * @param apmTrackerName - The apmTrackerName value.
+     * @param componentVersion - The componentVersion value.
+     * @returns The send result.
+     * @throws {CatalystAPIError} when the operation cannot be completed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * // Use HttpClient.send while preparing or sending an SDK request.
+     * ```
      */
-    constructor(app?: CatalystApp);
-    send(req: IRequestConfig, apmTrackerName?: string): Promise<DefaultHttpResponse>;
+    send(req: IRequestConfig, apmTrackerName?: string, componentVersion?: string): Promise<DefaultHttpResponse>;
 }
 export declare class AuthorizedHttpClient extends HttpClient {
     readonly componentName?: string;
+    readonly componentVersion?: string;
     /**
-     * @param {unknown} app The app used to fetch access tokens to sign API requests.
-     * @constructor
+     * @param app - The app used to fetch access tokens to sign API requests.
+     * @param component - Optional component metadata used to attach version headers.
      */
     constructor(app?: CatalystApp, component?: Component);
+    /**
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param request - The request value.
+     * @returns The send result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * // Use AuthorizedHttpClient.send while preparing or sending an SDK request.
+     * ```
+     */
     send(request: IRequestConfig): Promise<DefaultHttpResponse>;
 }

package/dist-types/index.browser.d.ts

@@ -1,11 +1,27 @@
 import { ICatalystClientRes } from './fetch-handler';
 import { Component, IRequestConfig } from './utils/interfaces';
+export { CatalystService, Component, CONSTANTS } from '@zcatalyst/utils';
+export { PrefixedCatalystError } from '@zcatalyst/utils';
 export declare class Handler {
     component?: Component;
     /**
-     * @constructor
+     * Creates a Handler instance.
+     * @param app - The app value.
+     * @param component - The component value.
      */
     constructor(app?: unknown, component?: Component);
+    /**
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param options - The initialization or request options.
+     * @returns The send result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     send(options: IRequestConfig): Promise<ICatalystClientRes>;
 }
 export { RequestType, ResponseType } from './utils/enums';

package/dist-types/index.d.ts

@@ -1,14 +1,34 @@
+/**
+ * Internal HTTP / fetch transport layer used by every Catalyst component package.
+ *
+ * @packageDocumentation
+ */
 import { DefaultHttpResponse } from './http-handler';
 import FormData from './utils/form-data';
 import { Component, IRequestConfig } from './utils/interfaces';
+export { CatalystService, Component, CONSTANTS } from '@zcatalyst/utils';
+export { PrefixedCatalystError } from '@zcatalyst/utils';
 export declare class Handler {
     component?: Component;
     app?: any;
     /**
-     * @param {unknown} app The app used to fetch access tokens to sign API requests.
-     * @constructor
+     * Creates a Handler instance.
+     * @param app - The app value.
+     * @param component - The component value.
      */
     constructor(app?: unknown, component?: Component);
+    /**
+     * Sends a Catalyst HTTP request through the Node transport handler.
+     *
+     * @param options - The request configuration to send.
+     * @returns The wrapped HTTP response.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await new Handler(app).send({ method: 'GET', url: 'https://example.com' });
+     * ```
+     */
     send(options: IRequestConfig): Promise<DefaultHttpResponse>;
 }
 export { RequestType, ResponseType } from './utils/enums';

package/dist-types/ts3.4/fetch-handler.d.ts

@@ -1,8 +1,4 @@
-import { ConfigManager } from '@zcatalyst/auth-client';
 import { CoreType, IRequestConfig, jwtAccessTokenResponse, RequestHandlerOptions } from './utils/interfaces';
-export declare const keepAliveSupport: {
-    supported: undefined | boolean;
-};
 type ICatalystDataRes = Record<string, string> | string | Blob | ArrayBuffer | ReadableStreamDefaultReader<Uint8Array> | FormData;
 export interface ICatalystClientRes {
     request: RequestInit;
@@ -19,22 +15,135 @@ export declare class DefaultHttpResponse {
     headers: HeadersInit;
     config: RequestHandlerOptions;
     resp: ICatalystClientRes;
+    /**
+     * Creates a DefaultHttpResponse instance.
+     * @param resp - The resp value.
+     */
     constructor(resp: ICatalystClientRes);
+    /*
+    * Returns the data value for this DefaultHttpResponse instance.
+    *
+    * @returns The response payload.
+    * @throws {CatalystAPIError} when the request or response cannot be processed.
+    *
+    * @example
+    * ```ts
+    * import { Handler } from '@zcatalyst/transport';
+    * const result = undefined;
+    * ```
+    */
     readonly data: ICatalystDataRes;
 }
 export declare class ResponseHandler {
     private "ResponseHandler.#private";
-    static configManager: ConfigManager;
+    static apiDomain: string;
+    /**
+     * Creates a ResponseHandler instance.
+     */
     constructor();
+    /**
+     * Sends a browser fetch request with SDK authentication, timeout and response handling.
+     *
+     * @param options - The initialization or request options.
+     * @param options.requestCore - The Fetch API request configuration.
+     * @param options.url - The URL to update or request.
+     * @param requestOptions - The request handling options.
+     * @returns The fire general request result.
+     * @throws {CatalystAPIError} when the request or response cannot be processed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.fireGeneralRequest({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static fireGeneralRequest({ requestCore, url }: {
         requestCore: RequestInit;
         url: string;
     }, requestOptions?: RequestHandlerOptions): Promise<DefaultHttpResponse | void>;
+    /**
+     * Wraps a Fetch API response in the SDK response object.
+     *
+     * @param response - The response to wrap.
+     * @param options - The initialization or request options.
+     * @returns The wrap response result.
+     * @throws {CatalystAPIError} when the request or response cannot be processed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.wrapResponse({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static wrapResponse(response: Response, options?: RequestHandlerOptions): Promise<DefaultHttpResponse>;
+    /**
+     * Sends a browser fetch request without retry handling.
+     *
+     * @param requestCore - The Fetch API request configuration.
+     * @param reqOptions - The raw request handling options.
+     * @returns The fire raw request result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.fireRawRequest({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static fireRawRequest(requestCore: CoreType, reqOptions: RequestHandlerOptions): Promise<DefaultHttpResponse>;
+    /**
+     * Attaches browser authentication headers according to the configured auth protocol.
+     *
+     * @param headers - The headers object to mutate or extend.
+     * @returns The attach zcauth headers result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.attachZCAuthHeaders({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static attachZCAuthHeaders(headers: HeadersInit): Promise<HeadersInit>;
+    /**
+     * Builds the browser JWT authorization token from the configured cookie.
+     *
+     * @returns The get jwtzcauth token result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.getJWTZCAuthToken({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static getJWTZCAuthToken(): Promise<jwtAccessTokenResponse>;
+    /**
+     * Appends query parameters to a URL.
+     *
+     * @param url - The URL to update or request.
+     * @param qs - The query string values to append.
+     * @returns The URL with encoded query parameters.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.appendQueryString({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
     static appendQueryString(url: string, qs?: Record<string, string | number | boolean | undefined>): string;
-    static send(options: IRequestConfig): Promise<DefaultHttpResponse | void>;
+    /**
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param options - The initialization or request options.
+     * @param componentName - The component name for user-agent metadata.
+     * @param componentVersion - The component version for user-agent metadata.
+     * @returns The send result.
+     * @throws {CatalystAPIError} when the request or response cannot be processed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await ResponseHandler.send({ url: '/baas/v1/project/123', method: 'GET', headers: {} });
+     * ```
+     */
+    static send(options: IRequestConfig, componentName?: string, componentVersion?: string): Promise<DefaultHttpResponse | void>;
 }
 export {};

package/dist-types/ts3.4/http-handler.d.ts

@@ -1,4 +1,4 @@
-import { CatalystApp } from '@zcatalyst/auth';
+import { CatalystApp } from '@zcatalyst/auth-admin';
 import { ClientRequest, IncomingHttpHeaders, IncomingMessage } from 'http';
 import { Component, IRequestConfig } from './utils/interfaces';
 export interface IAPIResponse {
@@ -15,25 +15,65 @@ export declare class DefaultHttpResponse {
     headers: IncomingHttpHeaders;
     config: IRequestConfig;
     resp: IAPIResponse;
+    /**
+     * Creates a DefaultHttpResponse instance.
+     * @param resp - The resp value.
+     */
     constructor(resp: IAPIResponse);
+    /*
+    * Returns the parsed response payload.
+    *
+    * @returns The data result.
+    * @throws {CatalystAPIError} when the operation cannot be completed.
+    *
+    * @example
+    * ```ts
+    * import { Handler } from '@zcatalyst/transport';
+    * // Use DefaultHttpResponse.data while preparing or sending an SDK request.
+    * ```
+    */
     readonly data: any;
 }
 export declare class HttpClient {
     app?: CatalystApp;
-    private user;
+    /** * @param app - The app used to fetch access tokens to sign API requests. */
+    constructor(app?: CatalystApp);
     /**
-     * @param {CatalystApp} app The app used to fetch access tokens to sign API requests.
-     * @constructor
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param req - The req value.
+     * @param apmTrackerName - The apmTrackerName value.
+     * @param componentVersion - The componentVersion value.
+     * @returns The send result.
+     * @throws {CatalystAPIError} when the operation cannot be completed.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * // Use HttpClient.send while preparing or sending an SDK request.
+     * ```
      */
-    constructor(app?: CatalystApp);
-    send(req: IRequestConfig, apmTrackerName?: string): Promise<DefaultHttpResponse>;
+    send(req: IRequestConfig, apmTrackerName?: string, componentVersion?: string): Promise<DefaultHttpResponse>;
 }
 export declare class AuthorizedHttpClient extends HttpClient {
     readonly componentName?: string;
+    readonly componentVersion?: string;
     /**
-     * @param {unknown} app The app used to fetch access tokens to sign API requests.
-     * @constructor
+     * @param app - The app used to fetch access tokens to sign API requests.
+     * @param component - Optional component metadata used to attach version headers.
      */
     constructor(app?: CatalystApp, component?: Component);
+    /**
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param request - The request value.
+     * @returns The send result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * // Use AuthorizedHttpClient.send while preparing or sending an SDK request.
+     * ```
+     */
     send(request: IRequestConfig): Promise<DefaultHttpResponse>;
 }

package/dist-types/ts3.4/index.browser.d.ts

@@ -1,11 +1,27 @@
 import { ICatalystClientRes } from './fetch-handler';
 import { Component, IRequestConfig } from './utils/interfaces';
+export { CatalystService, Component, CONSTANTS } from '@zcatalyst/utils';
+export { PrefixedCatalystError } from '@zcatalyst/utils';
 export declare class Handler {
     component?: Component;
     /**
-     * @constructor
+     * Creates a Handler instance.
+     * @param app - The app value.
+     * @param component - The component value.
      */
     constructor(app?: unknown, component?: Component);
+    /**
+     * Sends a Catalyst HTTP request and returns the wrapped response.
+     *
+     * @param options - The initialization or request options.
+     * @returns The send result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     send(options: IRequestConfig): Promise<ICatalystClientRes>;
 }
 export { RequestType, ResponseType } from './utils/enums';

package/dist-types/ts3.4/index.d.ts

@@ -1,14 +1,34 @@
+/**
+ * Internal HTTP / fetch transport layer used by every Catalyst component package.
+ *
+ * @packageDocumentation
+ */
 import { DefaultHttpResponse } from './http-handler';
 import FormData from './utils/form-data';
 import { Component, IRequestConfig } from './utils/interfaces';
+export { CatalystService, Component, CONSTANTS } from '@zcatalyst/utils';
+export { PrefixedCatalystError } from '@zcatalyst/utils';
 export declare class Handler {
     component?: Component;
     app?: any;
     /**
-     * @param {unknown} app The app used to fetch access tokens to sign API requests.
-     * @constructor
+     * Creates a Handler instance.
+     * @param app - The app value.
+     * @param component - The component value.
      */
     constructor(app?: unknown, component?: Component);
+    /**
+     * Sends a Catalyst HTTP request through the Node transport handler.
+     *
+     * @param options - The request configuration to send.
+     * @returns The wrapped HTTP response.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const response = await new Handler(app).send({ method: 'GET', url: 'https://example.com' });
+     * ```
+     */
     send(options: IRequestConfig): Promise<DefaultHttpResponse>;
 }
 export { RequestType, ResponseType } from './utils/enums';

package/dist-types/ts3.4/utils/clonable-stream.d.ts

@@ -1,10 +1,37 @@
 import { PassThrough, Readable } from 'stream';
 declare class StreamClone extends PassThrough {
     parent: CloneableStream;
+    /**
+     * Creates a StreamClone instance.
+     * @param parent - The parent value.
+     */
     constructor(parent: CloneableStream);
     private onDataClone;
     private onResumeClone;
+    /**
+     * Performs clone for the transport package.
+     *
+     * @returns The clone result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     clone(): StreamClone;
+    /**
+     * Performs is cloneable for the transport package.
+     *
+     * @param stream - The stream value.
+     * @returns The is cloneable result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     isCloneable(stream: unknown): stream is CloneableStream | StreamClone;
 }
 export default class CloneableStream extends PassThrough {
@@ -12,10 +39,37 @@ export default class CloneableStream extends PassThrough {
     _clonesCount: number;
     _internalPipe: boolean;
     _hasListener: boolean;
+    /**
+     * Creates a CloneableStream instance.
+     * @param stream - The stream value.
+     */
     constructor(stream: Readable);
     private onData;
     private onResume;
+    /**
+     * Performs resume for the transport package.
+     *
+     * @returns The resume result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     resume(): this;
+    /**
+     * Performs clone for the transport package.
+     *
+     * @returns The clone result.
+     * @throws {Error} when validation fails.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     clone(): StreamClone;
 }
 export {};

package/dist-types/ts3.4/utils/errors.d.ts

@@ -1,4 +1,11 @@
 import { PrefixedCatalystError } from '@zcatalyst/utils';
 export declare class CatalystAPIError extends PrefixedCatalystError {
+    /**
+     * Creates a CatalystAPIError instance.
+     * @param code - The code value.
+     * @param message - The message value.
+     * @param value - The value value.
+     * @param statusCode - The statusCode value.
+     */
     constructor(code: string, message: string, value?: unknown, statusCode?: number);
 }