@stackone/transport 1.8.3 → 1.9.0

package/dist/index.d.mts

@@ -1,9 +1,10 @@
 import * as redis from "redis";
 import { AxiosInstance, AxiosInterceptorOptions, AxiosResponse, CreateAxiosDefaults, InternalAxiosRequestConfig } from "axios";
-import { AgentOptions } from "node:http";
+import http, { AgentOptions } from "node:http";
 import { ILogger } from "@stackone/logger";
 import { z } from "zod/v4";
 import https from "https";
+import https$1 from "node:https";
 
 //#region src/authorization/types.d.ts
 type BasicAuthorizationParams = {
@@ -69,7 +70,7 @@ interface ICacheClient<ClientType = unknown> {
 }
 type PubSubListener<ReturnsBuffer extends boolean = false> = <T extends (ReturnsBuffer extends true ? Buffer : string)>(message: T, channel: T) => unknown;
 //#endregion
-//#region src/redisClient/index.d.ts
+//#region src/redisClient/types.d.ts
 type RedisClientType = redis.RedisClientType;
 interface RedisClientConfig {
   getRedisClient?: typeof redis.createClient;
@@ -79,6 +80,9 @@ interface RedisClientConfig {
   reconnect?: boolean;
   database?: number;
 }
+type RedisClientBuilder = (config: RedisClientConfig, logger?: ILogger) => Promise<ICacheClient<RedisClientType> | undefined>;
+//#endregion
+//#region src/redisClient/index.d.ts
 declare const buildRedisClientInstance: (config: RedisClientConfig, logger?: ILogger) => Promise<ICacheClient<RedisClientType> | undefined>;
 declare class RedisClient implements ICacheClient<RedisClientType> {
   #private;
@@ -335,6 +339,16 @@ type RequestContext = {
   accountSettings?: AccountSettings;
   behaviours?: HttpClientBehaviour[];
 };
+type ErrorMappingFn<TError extends Error = Error> = (error: Error) => TError | undefined;
+type TransportFactory = ({
+  logger,
+  redisClientConfig,
+  context
+}: {
+  logger?: ILogger;
+  redisClientConfig?: RedisClientConfig;
+  context?: RequestContext;
+}) => Promise<AxiosInstance>;
 //#endregion
 //#region src/errors/httpResponseError.d.ts
 declare class HttpResponseError extends Error {
@@ -405,53 +419,71 @@ declare class EventClient<T> {
 }
 //#endregion
 //#region src/getTransportInstance/index.d.ts
-declare const getTransportInstance: (logger: ILogger, context?: RequestContext) => Promise<AxiosInstance>;
+declare const getTransportInstance: ({
+  logger,
+  redisClientConfig,
+  context
+}?: {
+  logger?: ILogger;
+  redisClientConfig?: RedisClientConfig;
+  context?: RequestContext;
+}) => Promise<AxiosInstance>;
 //#endregion
 //#region src/httpClient/httpClient.d.ts
-declare class HttpClient implements IHttpClient {
+declare class HttpClient<TError extends Error = Error> implements IHttpClient {
   #private;
   constructor({
-    transportInstance
+    transportFactory,
+    getRedisClient,
+    logger,
+    redisClientConfig,
+    errorMappingFn
   }?: {
-    transportInstance?: AxiosInstance;
+    transportFactory?: TransportFactory;
+    getRedisClient?: RedisClientBuilder;
+    logger?: ILogger;
+    redisClientConfig?: RedisClientConfig;
+    errorMappingFn?: ErrorMappingFn<TError>;
   });
   request<P, T>({
     headers,
     url,
     method,
-    queryParams,
     maxRedirects,
     responseType,
     cacheTTL,
     context,
+    traceId,
     payload,
-    httpsAgent
+    httpsAgent,
+    httpAgent
   }: {
     headers?: HttpHeaders;
     url: string;
     method?: HttpMethod;
-    queryParams?: HttpQueryParams;
     maxRedirects?: number;
     responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
     cacheTTL?: number;
-    context?: unknown;
+    context?: RequestContext;
+    traceId?: string;
     payload?: P;
-    httpsAgent?: https.Agent;
+    httpsAgent?: https$1.Agent;
+    httpAgent?: http.Agent;
   }): Promise<HttpResponse<T>>;
   get<T>({
     headers,
     url,
-    queryParams,
     maxRedirects,
     cacheTTL,
-    context
+    context,
+    traceId
   }: {
     headers?: HttpHeaders;
     url: string;
-    queryParams?: HttpQueryParams;
     maxRedirects?: number;
     cacheTTL?: number;
-    context?: unknown;
+    context?: RequestContext;
+    traceId?: string;
   }): Promise<HttpResponse<T>>;
   post<P, T>({
     headers,
@@ -459,25 +491,33 @@ declare class HttpClient implements IHttpClient {
     maxRedirects,
     cacheTTL,
     context,
+    traceId,
     payload
   }: {
     headers?: HttpHeaders;
     url: string;
     maxRedirects?: number;
     cacheTTL?: number;
-    context?: unknown;
+    context?: RequestContext;
+    traceId?: string;
     payload?: P;
   }): Promise<HttpResponse<T>>;
 }
 //#endregion
 //#region src/httpClient/httpClientManager.d.ts
-declare const buildHttpClientInstance: () => IHttpClient;
+declare const buildHttpClientInstance: <TError extends Error = Error>(redisClientConfig: RedisClientConfig, logger?: ILogger, errorMappingFn?: ErrorMappingFn<TError>) => IHttpClient;
 declare class HttpClientManager {
   private static httpClientInstance;
-  static getInstance({
-    getHttpClient
-  }?: {
-    getHttpClient?: typeof buildHttpClientInstance;
+  static getInstance<TError extends Error = Error>({
+    getHttpClient,
+    redisClientConfig,
+    logger,
+    errorMappingFn
+  }: {
+    getHttpClient: typeof buildHttpClientInstance;
+    redisClientConfig: RedisClientConfig;
+    logger?: ILogger;
+    errorMappingFn?: ErrorMappingFn<TError>;
   }): Promise<IHttpClient>;
   static resetInstance(): void;
 }
@@ -539,7 +579,7 @@ type HttpTransportInstanceConfig = {
   interceptors?: InterceptorConfigs;
   instanceConfig?: CreateAxiosDefaults;
   httpAgentConfig?: AgentOptions;
-  logger: ILogger;
+  logger?: ILogger;
   context?: RequestContext;
 };
 //#endregion
@@ -708,13 +748,10 @@ declare class RequestClientFactory {
   static build(type?: RequestClientType): IRequestClient;
 }
 //#endregion
-//#region src/redisClient/types.d.ts
-type GetRedisClient = typeof buildRedisClientInstance;
-//#endregion
 //#region src/subscriptionManager/types.d.ts
 type SubscriptionManagerOptions = {
   config?: RedisClientConfig;
-  getCacheClient?: GetRedisClient;
+  getCacheClient?: typeof buildRedisClientInstance;
   logger?: ILogger;
   instantiator?: string;
   subscriptionTTL?: number;
@@ -750,4 +787,4 @@ type LockEntry = {
   unlock: Unlock;
 };
 //#endregion
-export { CUSTOM_ERROR_CONFIG_SCHEMA, ConcurrencyManager, CustomErrorConfig, EventClient, HttpClient, HttpClientManager, HttpErrorMessages, HttpHeaders, HttpMethod, HttpMethods, HttpParameters, HttpQueryParams, HttpResponse, HttpResponseError, HttpTransportFactory, ICacheClient, IHttpClient, InstanceManager, Lock, LockEntry, LockManager, MemoryStore, MemoryStoreConfig, PruneCount, PubSubListener, QueueManager, RateLimitManager, RedisClient, RequestClientFactory, RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, Unlock, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };
+export { CUSTOM_ERROR_CONFIG_SCHEMA, ConcurrencyManager, CustomErrorConfig, ErrorMappingFn, EventClient, HttpClient, HttpClientManager, HttpErrorMessages, HttpHeaders, HttpMethod, HttpMethods, HttpParameters, HttpQueryParams, HttpResponse, HttpResponseError, HttpTransportFactory, ICacheClient, IHttpClient, InstanceManager, Lock, LockEntry, LockManager, MemoryStore, MemoryStoreConfig, PruneCount, PubSubListener, QueueManager, RateLimitManager, RedisClient, RequestClientFactory, RequestContext, RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, Unlock, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };

package/dist/index.d.ts

@@ -3,7 +3,8 @@ import * as redis from "redis";
 import { AxiosInstance, AxiosInterceptorOptions, AxiosResponse, CreateAxiosDefaults, InternalAxiosRequestConfig } from "axios";
 import { z } from "zod/v4";
 import https from "https";
-import { AgentOptions } from "node:http";
+import http, { AgentOptions } from "node:http";
+import https$1 from "node:https";
 
 //#region src/authorization/types.d.ts
 type BasicAuthorizationParams = {
@@ -69,7 +70,7 @@ interface ICacheClient<ClientType = unknown> {
 }
 type PubSubListener<ReturnsBuffer extends boolean = false> = <T extends (ReturnsBuffer extends true ? Buffer : string)>(message: T, channel: T) => unknown;
 //#endregion
-//#region src/redisClient/index.d.ts
+//#region src/redisClient/types.d.ts
 type RedisClientType = redis.RedisClientType;
 interface RedisClientConfig {
   getRedisClient?: typeof redis.createClient;
@@ -79,6 +80,9 @@ interface RedisClientConfig {
   reconnect?: boolean;
   database?: number;
 }
+type RedisClientBuilder = (config: RedisClientConfig, logger?: ILogger) => Promise<ICacheClient<RedisClientType> | undefined>;
+//#endregion
+//#region src/redisClient/index.d.ts
 declare const buildRedisClientInstance: (config: RedisClientConfig, logger?: ILogger) => Promise<ICacheClient<RedisClientType> | undefined>;
 declare class RedisClient implements ICacheClient<RedisClientType> {
   #private;
@@ -335,6 +339,16 @@ type RequestContext = {
   accountSettings?: AccountSettings;
   behaviours?: HttpClientBehaviour[];
 };
+type ErrorMappingFn<TError extends Error = Error> = (error: Error) => TError | undefined;
+type TransportFactory = ({
+  logger,
+  redisClientConfig,
+  context
+}: {
+  logger?: ILogger;
+  redisClientConfig?: RedisClientConfig;
+  context?: RequestContext;
+}) => Promise<AxiosInstance>;
 //#endregion
 //#region src/errors/httpResponseError.d.ts
 declare class HttpResponseError extends Error {
@@ -405,53 +419,71 @@ declare class EventClient<T> {
 }
 //#endregion
 //#region src/getTransportInstance/index.d.ts
-declare const getTransportInstance: (logger: ILogger, context?: RequestContext) => Promise<AxiosInstance>;
+declare const getTransportInstance: ({
+  logger,
+  redisClientConfig,
+  context
+}?: {
+  logger?: ILogger;
+  redisClientConfig?: RedisClientConfig;
+  context?: RequestContext;
+}) => Promise<AxiosInstance>;
 //#endregion
 //#region src/httpClient/httpClient.d.ts
-declare class HttpClient implements IHttpClient {
+declare class HttpClient<TError extends Error = Error> implements IHttpClient {
   #private;
   constructor({
-    transportInstance
+    transportFactory,
+    getRedisClient,
+    logger,
+    redisClientConfig,
+    errorMappingFn
   }?: {
-    transportInstance?: AxiosInstance;
+    transportFactory?: TransportFactory;
+    getRedisClient?: RedisClientBuilder;
+    logger?: ILogger;
+    redisClientConfig?: RedisClientConfig;
+    errorMappingFn?: ErrorMappingFn<TError>;
   });
   request<P, T>({
     headers,
     url,
     method,
-    queryParams,
     maxRedirects,
     responseType,
     cacheTTL,
     context,
+    traceId,
     payload,
-    httpsAgent
+    httpsAgent,
+    httpAgent
   }: {
     headers?: HttpHeaders;
     url: string;
     method?: HttpMethod;
-    queryParams?: HttpQueryParams;
     maxRedirects?: number;
     responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
     cacheTTL?: number;
-    context?: unknown;
+    context?: RequestContext;
+    traceId?: string;
     payload?: P;
-    httpsAgent?: https.Agent;
+    httpsAgent?: https$1.Agent;
+    httpAgent?: http.Agent;
   }): Promise<HttpResponse<T>>;
   get<T>({
     headers,
     url,
-    queryParams,
     maxRedirects,
     cacheTTL,
-    context
+    context,
+    traceId
   }: {
     headers?: HttpHeaders;
     url: string;
-    queryParams?: HttpQueryParams;
     maxRedirects?: number;
     cacheTTL?: number;
-    context?: unknown;
+    context?: RequestContext;
+    traceId?: string;
   }): Promise<HttpResponse<T>>;
   post<P, T>({
     headers,
@@ -459,25 +491,33 @@ declare class HttpClient implements IHttpClient {
     maxRedirects,
     cacheTTL,
     context,
+    traceId,
     payload
   }: {
     headers?: HttpHeaders;
     url: string;
     maxRedirects?: number;
     cacheTTL?: number;
-    context?: unknown;
+    context?: RequestContext;
+    traceId?: string;
     payload?: P;
   }): Promise<HttpResponse<T>>;
 }
 //#endregion
 //#region src/httpClient/httpClientManager.d.ts
-declare const buildHttpClientInstance: () => IHttpClient;
+declare const buildHttpClientInstance: <TError extends Error = Error>(redisClientConfig: RedisClientConfig, logger?: ILogger, errorMappingFn?: ErrorMappingFn<TError>) => IHttpClient;
 declare class HttpClientManager {
   private static httpClientInstance;
-  static getInstance({
-    getHttpClient
-  }?: {
-    getHttpClient?: typeof buildHttpClientInstance;
+  static getInstance<TError extends Error = Error>({
+    getHttpClient,
+    redisClientConfig,
+    logger,
+    errorMappingFn
+  }: {
+    getHttpClient: typeof buildHttpClientInstance;
+    redisClientConfig: RedisClientConfig;
+    logger?: ILogger;
+    errorMappingFn?: ErrorMappingFn<TError>;
   }): Promise<IHttpClient>;
   static resetInstance(): void;
 }
@@ -539,7 +579,7 @@ type HttpTransportInstanceConfig = {
   interceptors?: InterceptorConfigs;
   instanceConfig?: CreateAxiosDefaults;
   httpAgentConfig?: AgentOptions;
-  logger: ILogger;
+  logger?: ILogger;
   context?: RequestContext;
 };
 //#endregion
@@ -708,13 +748,10 @@ declare class RequestClientFactory {
   static build(type?: RequestClientType): IRequestClient;
 }
 //#endregion
-//#region src/redisClient/types.d.ts
-type GetRedisClient = typeof buildRedisClientInstance;
-//#endregion
 //#region src/subscriptionManager/types.d.ts
 type SubscriptionManagerOptions = {
   config?: RedisClientConfig;
-  getCacheClient?: GetRedisClient;
+  getCacheClient?: typeof buildRedisClientInstance;
   logger?: ILogger;
   instantiator?: string;
   subscriptionTTL?: number;
@@ -750,4 +787,4 @@ type LockEntry = {
   unlock: Unlock;
 };
 //#endregion
-export { CUSTOM_ERROR_CONFIG_SCHEMA, ConcurrencyManager, CustomErrorConfig, EventClient, HttpClient, HttpClientManager, HttpErrorMessages, HttpHeaders, HttpMethod, HttpMethods, HttpParameters, HttpQueryParams, HttpResponse, HttpResponseError, HttpTransportFactory, ICacheClient, IHttpClient, InstanceManager, Lock, LockEntry, LockManager, MemoryStore, MemoryStoreConfig, PruneCount, PubSubListener, QueueManager, RateLimitManager, RedisClient, RequestClientFactory, RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, Unlock, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };
+export { CUSTOM_ERROR_CONFIG_SCHEMA, ConcurrencyManager, CustomErrorConfig, ErrorMappingFn, EventClient, HttpClient, HttpClientManager, HttpErrorMessages, HttpHeaders, HttpMethod, HttpMethods, HttpParameters, HttpQueryParams, HttpResponse, HttpResponseError, HttpTransportFactory, ICacheClient, IHttpClient, InstanceManager, Lock, LockEntry, LockManager, MemoryStore, MemoryStoreConfig, PruneCount, PubSubListener, QueueManager, RateLimitManager, RedisClient, RequestClientFactory, RequestContext, RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, Unlock, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };