@stackone/transport 1.11.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +144 -55
- package/dist/index.d.ts +143 -54
- package/dist/index.js +13 -13
- package/dist/index.mjs +15 -15
- package/package.json +1 -3
package/dist/index.d.mts
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
import * as redis from "redis";
|
|
2
2
|
import { AxiosInstance, AxiosInterceptorOptions, AxiosResponse, CreateAxiosDefaults, InternalAxiosRequestConfig } from "axios";
|
|
3
|
-
import
|
|
4
|
-
import { ILogger } from "@stackone/logger";
|
|
3
|
+
import https from "node:https";
|
|
5
4
|
import { z } from "zod/v4";
|
|
6
|
-
import
|
|
7
|
-
import https$1 from "node:https";
|
|
5
|
+
import http, { AgentOptions } from "node:http";
|
|
8
6
|
|
|
9
7
|
//#region src/authorization/types.d.ts
|
|
10
8
|
type BasicAuthorizationParams = {
|
|
@@ -24,6 +22,69 @@ declare const createAuthorizationHeaders: (authenticationParams: BasicAuthorizat
|
|
|
24
22
|
authorization: string;
|
|
25
23
|
};
|
|
26
24
|
//#endregion
|
|
25
|
+
//#region ../logger/src/types.d.ts
|
|
26
|
+
interface ILogger {
|
|
27
|
+
debug({
|
|
28
|
+
category,
|
|
29
|
+
message,
|
|
30
|
+
traceId,
|
|
31
|
+
context
|
|
32
|
+
}: {
|
|
33
|
+
category?: string;
|
|
34
|
+
message: string;
|
|
35
|
+
traceId?: string;
|
|
36
|
+
context?: Record<string, unknown>;
|
|
37
|
+
}): void;
|
|
38
|
+
info({
|
|
39
|
+
category,
|
|
40
|
+
message,
|
|
41
|
+
traceId,
|
|
42
|
+
context
|
|
43
|
+
}: {
|
|
44
|
+
category?: string;
|
|
45
|
+
message: string;
|
|
46
|
+
traceId?: string;
|
|
47
|
+
context?: Record<string, unknown>;
|
|
48
|
+
}): void;
|
|
49
|
+
warning({
|
|
50
|
+
category,
|
|
51
|
+
message,
|
|
52
|
+
traceId,
|
|
53
|
+
error,
|
|
54
|
+
code,
|
|
55
|
+
context
|
|
56
|
+
}: {
|
|
57
|
+
category?: string;
|
|
58
|
+
message: string;
|
|
59
|
+
traceId?: string;
|
|
60
|
+
error?: LogError;
|
|
61
|
+
code?: string;
|
|
62
|
+
context?: Record<string, unknown>;
|
|
63
|
+
}): void;
|
|
64
|
+
error({
|
|
65
|
+
category,
|
|
66
|
+
message,
|
|
67
|
+
traceId,
|
|
68
|
+
error,
|
|
69
|
+
code,
|
|
70
|
+
context
|
|
71
|
+
}: {
|
|
72
|
+
category?: string;
|
|
73
|
+
message: string;
|
|
74
|
+
traceId?: string;
|
|
75
|
+
error?: LogError;
|
|
76
|
+
code: string;
|
|
77
|
+
context?: Record<string, unknown>;
|
|
78
|
+
}): void;
|
|
79
|
+
}
|
|
80
|
+
type LogError = Error & {
|
|
81
|
+
response?: {
|
|
82
|
+
data?: unknown;
|
|
83
|
+
};
|
|
84
|
+
context?: Record<string, unknown>;
|
|
85
|
+
url?: string;
|
|
86
|
+
};
|
|
87
|
+
//#endregion
|
|
27
88
|
//#region src/cacheClient/types.d.ts
|
|
28
89
|
interface ICacheClient<ClientType = unknown> {
|
|
29
90
|
getData<T>(key: string): Promise<T | null>;
|
|
@@ -229,6 +290,44 @@ declare const CUSTOM_ERROR_CONFIG_SCHEMA: z.ZodObject<{
|
|
|
229
290
|
type CustomErrorConfig = z.infer<typeof CUSTOM_ERROR_CONFIG_SCHEMA>;
|
|
230
291
|
declare const HttpErrorMessages: Record<number, string>;
|
|
231
292
|
//#endregion
|
|
293
|
+
//#region src/rateLimitManager/types.d.ts
|
|
294
|
+
type RateLimitSubPoolConfig = {
|
|
295
|
+
subPoolKey: string;
|
|
296
|
+
urlPattern: RegExp | string;
|
|
297
|
+
rateLimit: number;
|
|
298
|
+
};
|
|
299
|
+
type RetryUnit = 'seconds' | 'milliseconds' | 'date';
|
|
300
|
+
type MappedRateLimitErrorConfig = {
|
|
301
|
+
errorStatus: number;
|
|
302
|
+
errorMessage: string | RegExp;
|
|
303
|
+
errorMessagePath?: string;
|
|
304
|
+
retryAfterPath?: string;
|
|
305
|
+
retryAfterUnit?: RetryUnit;
|
|
306
|
+
retryAfterValue?: number;
|
|
307
|
+
};
|
|
308
|
+
type RateLimitConfig = {
|
|
309
|
+
mainRatelimit: number;
|
|
310
|
+
subPools?: RateLimitSubPoolConfig[];
|
|
311
|
+
mappedRateLimitErrors?: MappedRateLimitErrorConfig[];
|
|
312
|
+
};
|
|
313
|
+
//#endregion
|
|
314
|
+
//#region src/interceptors/types.d.ts
|
|
315
|
+
type RequestInterceptor = (value: InternalAxiosRequestConfig<unknown>) => InternalAxiosRequestConfig<unknown> | Promise<InternalAxiosRequestConfig<unknown>>;
|
|
316
|
+
type ResponseInterceptor = (value: AxiosResponse<unknown, unknown>) => AxiosResponse<unknown, unknown> | Promise<AxiosResponse<unknown, unknown>>;
|
|
317
|
+
type ErrorInterceptor = (error: unknown) => unknown;
|
|
318
|
+
type Interceptor = RequestInterceptor | ResponseInterceptor | ErrorInterceptor | null;
|
|
319
|
+
interface InterceptorDependencies {
|
|
320
|
+
axiosInstance?: AxiosInstance;
|
|
321
|
+
logger?: ILogger;
|
|
322
|
+
context?: RequestContext;
|
|
323
|
+
requestConfig?: RequestConfig;
|
|
324
|
+
[key: string]: unknown;
|
|
325
|
+
}
|
|
326
|
+
type RequestConfig = {
|
|
327
|
+
rateLimits?: RateLimitConfig;
|
|
328
|
+
concurrency?: ConcurrencyConfig;
|
|
329
|
+
};
|
|
330
|
+
//#endregion
|
|
232
331
|
//#region src/httpClient/types.d.ts
|
|
233
332
|
type HttpHeaders = {
|
|
234
333
|
[key: string]: string;
|
|
@@ -263,7 +362,10 @@ interface IHttpClient {
|
|
|
263
362
|
cacheTTL,
|
|
264
363
|
context,
|
|
265
364
|
payload,
|
|
266
|
-
httpsAgent
|
|
365
|
+
httpsAgent,
|
|
366
|
+
httpAgent,
|
|
367
|
+
requestConfig,
|
|
368
|
+
httpsAgentConfig
|
|
267
369
|
}: {
|
|
268
370
|
headers?: HttpHeaders;
|
|
269
371
|
url: string;
|
|
@@ -275,6 +377,9 @@ interface IHttpClient {
|
|
|
275
377
|
context?: unknown;
|
|
276
378
|
payload?: P;
|
|
277
379
|
httpsAgent?: https.Agent;
|
|
380
|
+
httpAgent?: http.Agent;
|
|
381
|
+
requestConfig?: RequestConfig;
|
|
382
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
278
383
|
}): Promise<HttpResponse<T>>;
|
|
279
384
|
get<T>({
|
|
280
385
|
headers,
|
|
@@ -282,7 +387,8 @@ interface IHttpClient {
|
|
|
282
387
|
queryParams,
|
|
283
388
|
maxRedirects,
|
|
284
389
|
cacheTTL,
|
|
285
|
-
context
|
|
390
|
+
context,
|
|
391
|
+
requestConfig
|
|
286
392
|
}: {
|
|
287
393
|
headers?: HttpHeaders;
|
|
288
394
|
url: string;
|
|
@@ -290,6 +396,7 @@ interface IHttpClient {
|
|
|
290
396
|
maxRedirects?: number;
|
|
291
397
|
cacheTTL?: number;
|
|
292
398
|
context?: unknown;
|
|
399
|
+
requestConfig?: RequestConfig;
|
|
293
400
|
}): Promise<HttpResponse<T>>;
|
|
294
401
|
post<P, T>({
|
|
295
402
|
headers,
|
|
@@ -297,7 +404,8 @@ interface IHttpClient {
|
|
|
297
404
|
maxRedirects,
|
|
298
405
|
cacheTTL,
|
|
299
406
|
context,
|
|
300
|
-
payload
|
|
407
|
+
payload,
|
|
408
|
+
requestConfig
|
|
301
409
|
}: {
|
|
302
410
|
headers?: HttpHeaders;
|
|
303
411
|
url: string;
|
|
@@ -305,6 +413,7 @@ interface IHttpClient {
|
|
|
305
413
|
cacheTTL?: number;
|
|
306
414
|
context?: unknown;
|
|
307
415
|
payload?: P;
|
|
416
|
+
requestConfig?: RequestConfig;
|
|
308
417
|
}): Promise<HttpResponse<T>>;
|
|
309
418
|
}
|
|
310
419
|
interface OperationSetting {
|
|
@@ -343,11 +452,15 @@ type ErrorMappingFn<TError extends Error = Error> = (error: Error) => TError | u
|
|
|
343
452
|
type TransportFactory = ({
|
|
344
453
|
logger,
|
|
345
454
|
redisClientConfig,
|
|
346
|
-
context
|
|
455
|
+
context,
|
|
456
|
+
requestConfig,
|
|
457
|
+
httpsAgentConfig
|
|
347
458
|
}: {
|
|
348
459
|
logger?: ILogger;
|
|
349
460
|
redisClientConfig?: RedisClientConfig;
|
|
350
461
|
context?: RequestContext;
|
|
462
|
+
requestConfig?: RequestConfig;
|
|
463
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
351
464
|
}) => Promise<AxiosInstance>;
|
|
352
465
|
//#endregion
|
|
353
466
|
//#region src/errors/httpResponseError.d.ts
|
|
@@ -422,11 +535,15 @@ declare class EventClient<T> {
|
|
|
422
535
|
declare const getTransportInstance: ({
|
|
423
536
|
logger,
|
|
424
537
|
redisClientConfig,
|
|
425
|
-
context
|
|
538
|
+
context,
|
|
539
|
+
requestConfig,
|
|
540
|
+
httpsAgentConfig
|
|
426
541
|
}?: {
|
|
427
542
|
logger?: ILogger;
|
|
428
543
|
redisClientConfig?: RedisClientConfig;
|
|
429
544
|
context?: RequestContext;
|
|
545
|
+
requestConfig?: RequestConfig;
|
|
546
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
430
547
|
}) => Promise<AxiosInstance>;
|
|
431
548
|
//#endregion
|
|
432
549
|
//#region src/httpClient/httpClient.d.ts
|
|
@@ -456,7 +573,9 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
456
573
|
traceId,
|
|
457
574
|
payload,
|
|
458
575
|
httpsAgent,
|
|
459
|
-
httpAgent
|
|
576
|
+
httpAgent,
|
|
577
|
+
requestConfig,
|
|
578
|
+
httpsAgentConfig
|
|
460
579
|
}: {
|
|
461
580
|
headers?: HttpHeaders;
|
|
462
581
|
url: string;
|
|
@@ -467,8 +586,10 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
467
586
|
context?: RequestContext;
|
|
468
587
|
traceId?: string;
|
|
469
588
|
payload?: P;
|
|
470
|
-
httpsAgent?: https
|
|
589
|
+
httpsAgent?: https.Agent;
|
|
471
590
|
httpAgent?: http.Agent;
|
|
591
|
+
requestConfig?: RequestConfig;
|
|
592
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
472
593
|
}): Promise<HttpResponse<T>>;
|
|
473
594
|
get<T>({
|
|
474
595
|
headers,
|
|
@@ -476,7 +597,8 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
476
597
|
maxRedirects,
|
|
477
598
|
cacheTTL,
|
|
478
599
|
context,
|
|
479
|
-
traceId
|
|
600
|
+
traceId,
|
|
601
|
+
requestConfig
|
|
480
602
|
}: {
|
|
481
603
|
headers?: HttpHeaders;
|
|
482
604
|
url: string;
|
|
@@ -484,6 +606,7 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
484
606
|
cacheTTL?: number;
|
|
485
607
|
context?: RequestContext;
|
|
486
608
|
traceId?: string;
|
|
609
|
+
requestConfig?: RequestConfig;
|
|
487
610
|
}): Promise<HttpResponse<T>>;
|
|
488
611
|
post<P, T>({
|
|
489
612
|
headers,
|
|
@@ -492,7 +615,8 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
492
615
|
cacheTTL,
|
|
493
616
|
context,
|
|
494
617
|
traceId,
|
|
495
|
-
payload
|
|
618
|
+
payload,
|
|
619
|
+
requestConfig
|
|
496
620
|
}: {
|
|
497
621
|
headers?: HttpHeaders;
|
|
498
622
|
url: string;
|
|
@@ -501,6 +625,7 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
501
625
|
context?: RequestContext;
|
|
502
626
|
traceId?: string;
|
|
503
627
|
payload?: P;
|
|
628
|
+
requestConfig?: RequestConfig;
|
|
504
629
|
}): Promise<HttpResponse<T>>;
|
|
505
630
|
}
|
|
506
631
|
//#endregion
|
|
@@ -522,44 +647,6 @@ declare class HttpClientManager {
|
|
|
522
647
|
static resetInstance(): void;
|
|
523
648
|
}
|
|
524
649
|
//#endregion
|
|
525
|
-
//#region src/rateLimitManager/types.d.ts
|
|
526
|
-
type RateLimitSubPoolConfig = {
|
|
527
|
-
subPoolKey: string;
|
|
528
|
-
urlPattern: RegExp | string;
|
|
529
|
-
rateLimit: number;
|
|
530
|
-
};
|
|
531
|
-
type RetryUnit = 'seconds' | 'milliseconds' | 'date';
|
|
532
|
-
type MappedRateLimitErrorConfig = {
|
|
533
|
-
errorStatus: number;
|
|
534
|
-
errorMessage: string | RegExp;
|
|
535
|
-
errorMessagePath?: string;
|
|
536
|
-
retryAfterPath?: string;
|
|
537
|
-
retryAfterUnit?: RetryUnit;
|
|
538
|
-
retryAfterValue?: number;
|
|
539
|
-
};
|
|
540
|
-
type RateLimitConfig = {
|
|
541
|
-
mainRatelimit: number;
|
|
542
|
-
subPools?: RateLimitSubPoolConfig[];
|
|
543
|
-
mappedRateLimitErrors?: MappedRateLimitErrorConfig[];
|
|
544
|
-
};
|
|
545
|
-
//#endregion
|
|
546
|
-
//#region src/interceptors/types.d.ts
|
|
547
|
-
type RequestInterceptor = (value: InternalAxiosRequestConfig<unknown>) => InternalAxiosRequestConfig<unknown> | Promise<InternalAxiosRequestConfig<unknown>>;
|
|
548
|
-
type ResponseInterceptor = (value: AxiosResponse<unknown, unknown>) => AxiosResponse<unknown, unknown> | Promise<AxiosResponse<unknown, unknown>>;
|
|
549
|
-
type ErrorInterceptor = (error: unknown) => unknown;
|
|
550
|
-
type Interceptor = RequestInterceptor | ResponseInterceptor | ErrorInterceptor | null;
|
|
551
|
-
interface InterceptorDependencies {
|
|
552
|
-
axiosInstance?: AxiosInstance;
|
|
553
|
-
logger?: ILogger;
|
|
554
|
-
context?: RequestContext;
|
|
555
|
-
requestConfig?: RequestConfig;
|
|
556
|
-
[key: string]: unknown;
|
|
557
|
-
}
|
|
558
|
-
type RequestConfig = {
|
|
559
|
-
rateLimits?: RateLimitConfig;
|
|
560
|
-
concurrency?: ConcurrencyConfig;
|
|
561
|
-
};
|
|
562
|
-
//#endregion
|
|
563
650
|
//#region src/httpTransportFactory/types.d.ts
|
|
564
651
|
type InterceptorDependencyInjector<T extends Interceptor> = (dependencies: InterceptorDependencies) => T;
|
|
565
652
|
type RequestInterceptorConfig = {
|
|
@@ -578,9 +665,10 @@ type InterceptorConfigs = {
|
|
|
578
665
|
type HttpTransportInstanceConfig = {
|
|
579
666
|
interceptors?: InterceptorConfigs;
|
|
580
667
|
instanceConfig?: CreateAxiosDefaults;
|
|
581
|
-
|
|
668
|
+
httpsAgentConfig?: AgentOptions;
|
|
582
669
|
logger?: ILogger;
|
|
583
670
|
context?: RequestContext;
|
|
671
|
+
requestConfig?: RequestConfig;
|
|
584
672
|
};
|
|
585
673
|
//#endregion
|
|
586
674
|
//#region src/httpTransportFactory/index.d.ts
|
|
@@ -588,9 +676,10 @@ declare class HttpTransportFactory {
|
|
|
588
676
|
static createInstance({
|
|
589
677
|
interceptors,
|
|
590
678
|
instanceConfig,
|
|
591
|
-
|
|
679
|
+
httpsAgentConfig,
|
|
592
680
|
logger,
|
|
593
|
-
context
|
|
681
|
+
context,
|
|
682
|
+
requestConfig
|
|
594
683
|
}: HttpTransportInstanceConfig): AxiosInstance;
|
|
595
684
|
private static applyInterceptors;
|
|
596
685
|
private static resolveInterceptorInstance;
|
|
@@ -787,4 +876,4 @@ type LockEntry = {
|
|
|
787
876
|
unlock: Unlock;
|
|
788
877
|
};
|
|
789
878
|
//#endregion
|
|
790
|
-
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, RedisClientConfig, RedisClientType, RequestClientFactory, RequestContext, RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, Unlock, buildHttpClientInstance, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };
|
|
879
|
+
export { CUSTOM_ERROR_CONFIG_SCHEMA, ConcurrencyManager, type CustomErrorConfig, type ErrorMappingFn, EventClient, HttpClient, HttpClientManager, HttpErrorMessages, type HttpHeaders, type HttpMethod, HttpMethods, type HttpParameters, type HttpQueryParams, type HttpResponse, HttpResponseError, HttpTransportFactory, type ICacheClient, type IHttpClient, InstanceManager, type Lock, type LockEntry, LockManager, MemoryStore, type MemoryStoreConfig, type PruneCount, type PubSubListener, QueueManager, RateLimitManager, RedisClient, type RedisClientConfig, type RedisClientType, RequestClientFactory, type RequestContext, type RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, type Unlock, buildHttpClientInstance, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
import { ILogger } from "@stackone/logger";
|
|
2
1
|
import * as redis from "redis";
|
|
3
2
|
import { AxiosInstance, AxiosInterceptorOptions, AxiosResponse, CreateAxiosDefaults, InternalAxiosRequestConfig } from "axios";
|
|
4
3
|
import { z } from "zod/v4";
|
|
5
|
-
import https from "https";
|
|
6
4
|
import http, { AgentOptions } from "node:http";
|
|
7
|
-
import https
|
|
5
|
+
import https from "node:https";
|
|
8
6
|
|
|
9
7
|
//#region src/authorization/types.d.ts
|
|
10
8
|
type BasicAuthorizationParams = {
|
|
@@ -24,6 +22,69 @@ declare const createAuthorizationHeaders: (authenticationParams: BasicAuthorizat
|
|
|
24
22
|
authorization: string;
|
|
25
23
|
};
|
|
26
24
|
//#endregion
|
|
25
|
+
//#region ../logger/src/types.d.ts
|
|
26
|
+
interface ILogger {
|
|
27
|
+
debug({
|
|
28
|
+
category,
|
|
29
|
+
message,
|
|
30
|
+
traceId,
|
|
31
|
+
context
|
|
32
|
+
}: {
|
|
33
|
+
category?: string;
|
|
34
|
+
message: string;
|
|
35
|
+
traceId?: string;
|
|
36
|
+
context?: Record<string, unknown>;
|
|
37
|
+
}): void;
|
|
38
|
+
info({
|
|
39
|
+
category,
|
|
40
|
+
message,
|
|
41
|
+
traceId,
|
|
42
|
+
context
|
|
43
|
+
}: {
|
|
44
|
+
category?: string;
|
|
45
|
+
message: string;
|
|
46
|
+
traceId?: string;
|
|
47
|
+
context?: Record<string, unknown>;
|
|
48
|
+
}): void;
|
|
49
|
+
warning({
|
|
50
|
+
category,
|
|
51
|
+
message,
|
|
52
|
+
traceId,
|
|
53
|
+
error,
|
|
54
|
+
code,
|
|
55
|
+
context
|
|
56
|
+
}: {
|
|
57
|
+
category?: string;
|
|
58
|
+
message: string;
|
|
59
|
+
traceId?: string;
|
|
60
|
+
error?: LogError;
|
|
61
|
+
code?: string;
|
|
62
|
+
context?: Record<string, unknown>;
|
|
63
|
+
}): void;
|
|
64
|
+
error({
|
|
65
|
+
category,
|
|
66
|
+
message,
|
|
67
|
+
traceId,
|
|
68
|
+
error,
|
|
69
|
+
code,
|
|
70
|
+
context
|
|
71
|
+
}: {
|
|
72
|
+
category?: string;
|
|
73
|
+
message: string;
|
|
74
|
+
traceId?: string;
|
|
75
|
+
error?: LogError;
|
|
76
|
+
code: string;
|
|
77
|
+
context?: Record<string, unknown>;
|
|
78
|
+
}): void;
|
|
79
|
+
}
|
|
80
|
+
type LogError = Error & {
|
|
81
|
+
response?: {
|
|
82
|
+
data?: unknown;
|
|
83
|
+
};
|
|
84
|
+
context?: Record<string, unknown>;
|
|
85
|
+
url?: string;
|
|
86
|
+
};
|
|
87
|
+
//#endregion
|
|
27
88
|
//#region src/cacheClient/types.d.ts
|
|
28
89
|
interface ICacheClient<ClientType = unknown> {
|
|
29
90
|
getData<T>(key: string): Promise<T | null>;
|
|
@@ -229,6 +290,44 @@ declare const CUSTOM_ERROR_CONFIG_SCHEMA: z.ZodObject<{
|
|
|
229
290
|
type CustomErrorConfig = z.infer<typeof CUSTOM_ERROR_CONFIG_SCHEMA>;
|
|
230
291
|
declare const HttpErrorMessages: Record<number, string>;
|
|
231
292
|
//#endregion
|
|
293
|
+
//#region src/rateLimitManager/types.d.ts
|
|
294
|
+
type RateLimitSubPoolConfig = {
|
|
295
|
+
subPoolKey: string;
|
|
296
|
+
urlPattern: RegExp | string;
|
|
297
|
+
rateLimit: number;
|
|
298
|
+
};
|
|
299
|
+
type RetryUnit = 'seconds' | 'milliseconds' | 'date';
|
|
300
|
+
type MappedRateLimitErrorConfig = {
|
|
301
|
+
errorStatus: number;
|
|
302
|
+
errorMessage: string | RegExp;
|
|
303
|
+
errorMessagePath?: string;
|
|
304
|
+
retryAfterPath?: string;
|
|
305
|
+
retryAfterUnit?: RetryUnit;
|
|
306
|
+
retryAfterValue?: number;
|
|
307
|
+
};
|
|
308
|
+
type RateLimitConfig = {
|
|
309
|
+
mainRatelimit: number;
|
|
310
|
+
subPools?: RateLimitSubPoolConfig[];
|
|
311
|
+
mappedRateLimitErrors?: MappedRateLimitErrorConfig[];
|
|
312
|
+
};
|
|
313
|
+
//#endregion
|
|
314
|
+
//#region src/interceptors/types.d.ts
|
|
315
|
+
type RequestInterceptor = (value: InternalAxiosRequestConfig<unknown>) => InternalAxiosRequestConfig<unknown> | Promise<InternalAxiosRequestConfig<unknown>>;
|
|
316
|
+
type ResponseInterceptor = (value: AxiosResponse<unknown, unknown>) => AxiosResponse<unknown, unknown> | Promise<AxiosResponse<unknown, unknown>>;
|
|
317
|
+
type ErrorInterceptor = (error: unknown) => unknown;
|
|
318
|
+
type Interceptor = RequestInterceptor | ResponseInterceptor | ErrorInterceptor | null;
|
|
319
|
+
interface InterceptorDependencies {
|
|
320
|
+
axiosInstance?: AxiosInstance;
|
|
321
|
+
logger?: ILogger;
|
|
322
|
+
context?: RequestContext;
|
|
323
|
+
requestConfig?: RequestConfig;
|
|
324
|
+
[key: string]: unknown;
|
|
325
|
+
}
|
|
326
|
+
type RequestConfig = {
|
|
327
|
+
rateLimits?: RateLimitConfig;
|
|
328
|
+
concurrency?: ConcurrencyConfig;
|
|
329
|
+
};
|
|
330
|
+
//#endregion
|
|
232
331
|
//#region src/httpClient/types.d.ts
|
|
233
332
|
type HttpHeaders = {
|
|
234
333
|
[key: string]: string;
|
|
@@ -263,7 +362,10 @@ interface IHttpClient {
|
|
|
263
362
|
cacheTTL,
|
|
264
363
|
context,
|
|
265
364
|
payload,
|
|
266
|
-
httpsAgent
|
|
365
|
+
httpsAgent,
|
|
366
|
+
httpAgent,
|
|
367
|
+
requestConfig,
|
|
368
|
+
httpsAgentConfig
|
|
267
369
|
}: {
|
|
268
370
|
headers?: HttpHeaders;
|
|
269
371
|
url: string;
|
|
@@ -275,6 +377,9 @@ interface IHttpClient {
|
|
|
275
377
|
context?: unknown;
|
|
276
378
|
payload?: P;
|
|
277
379
|
httpsAgent?: https.Agent;
|
|
380
|
+
httpAgent?: http.Agent;
|
|
381
|
+
requestConfig?: RequestConfig;
|
|
382
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
278
383
|
}): Promise<HttpResponse<T>>;
|
|
279
384
|
get<T>({
|
|
280
385
|
headers,
|
|
@@ -282,7 +387,8 @@ interface IHttpClient {
|
|
|
282
387
|
queryParams,
|
|
283
388
|
maxRedirects,
|
|
284
389
|
cacheTTL,
|
|
285
|
-
context
|
|
390
|
+
context,
|
|
391
|
+
requestConfig
|
|
286
392
|
}: {
|
|
287
393
|
headers?: HttpHeaders;
|
|
288
394
|
url: string;
|
|
@@ -290,6 +396,7 @@ interface IHttpClient {
|
|
|
290
396
|
maxRedirects?: number;
|
|
291
397
|
cacheTTL?: number;
|
|
292
398
|
context?: unknown;
|
|
399
|
+
requestConfig?: RequestConfig;
|
|
293
400
|
}): Promise<HttpResponse<T>>;
|
|
294
401
|
post<P, T>({
|
|
295
402
|
headers,
|
|
@@ -297,7 +404,8 @@ interface IHttpClient {
|
|
|
297
404
|
maxRedirects,
|
|
298
405
|
cacheTTL,
|
|
299
406
|
context,
|
|
300
|
-
payload
|
|
407
|
+
payload,
|
|
408
|
+
requestConfig
|
|
301
409
|
}: {
|
|
302
410
|
headers?: HttpHeaders;
|
|
303
411
|
url: string;
|
|
@@ -305,6 +413,7 @@ interface IHttpClient {
|
|
|
305
413
|
cacheTTL?: number;
|
|
306
414
|
context?: unknown;
|
|
307
415
|
payload?: P;
|
|
416
|
+
requestConfig?: RequestConfig;
|
|
308
417
|
}): Promise<HttpResponse<T>>;
|
|
309
418
|
}
|
|
310
419
|
interface OperationSetting {
|
|
@@ -343,11 +452,15 @@ type ErrorMappingFn<TError extends Error = Error> = (error: Error) => TError | u
|
|
|
343
452
|
type TransportFactory = ({
|
|
344
453
|
logger,
|
|
345
454
|
redisClientConfig,
|
|
346
|
-
context
|
|
455
|
+
context,
|
|
456
|
+
requestConfig,
|
|
457
|
+
httpsAgentConfig
|
|
347
458
|
}: {
|
|
348
459
|
logger?: ILogger;
|
|
349
460
|
redisClientConfig?: RedisClientConfig;
|
|
350
461
|
context?: RequestContext;
|
|
462
|
+
requestConfig?: RequestConfig;
|
|
463
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
351
464
|
}) => Promise<AxiosInstance>;
|
|
352
465
|
//#endregion
|
|
353
466
|
//#region src/errors/httpResponseError.d.ts
|
|
@@ -422,11 +535,15 @@ declare class EventClient<T> {
|
|
|
422
535
|
declare const getTransportInstance: ({
|
|
423
536
|
logger,
|
|
424
537
|
redisClientConfig,
|
|
425
|
-
context
|
|
538
|
+
context,
|
|
539
|
+
requestConfig,
|
|
540
|
+
httpsAgentConfig
|
|
426
541
|
}?: {
|
|
427
542
|
logger?: ILogger;
|
|
428
543
|
redisClientConfig?: RedisClientConfig;
|
|
429
544
|
context?: RequestContext;
|
|
545
|
+
requestConfig?: RequestConfig;
|
|
546
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
430
547
|
}) => Promise<AxiosInstance>;
|
|
431
548
|
//#endregion
|
|
432
549
|
//#region src/httpClient/httpClient.d.ts
|
|
@@ -456,7 +573,9 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
456
573
|
traceId,
|
|
457
574
|
payload,
|
|
458
575
|
httpsAgent,
|
|
459
|
-
httpAgent
|
|
576
|
+
httpAgent,
|
|
577
|
+
requestConfig,
|
|
578
|
+
httpsAgentConfig
|
|
460
579
|
}: {
|
|
461
580
|
headers?: HttpHeaders;
|
|
462
581
|
url: string;
|
|
@@ -467,8 +586,10 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
467
586
|
context?: RequestContext;
|
|
468
587
|
traceId?: string;
|
|
469
588
|
payload?: P;
|
|
470
|
-
httpsAgent?: https
|
|
589
|
+
httpsAgent?: https.Agent;
|
|
471
590
|
httpAgent?: http.Agent;
|
|
591
|
+
requestConfig?: RequestConfig;
|
|
592
|
+
httpsAgentConfig?: https.AgentOptions;
|
|
472
593
|
}): Promise<HttpResponse<T>>;
|
|
473
594
|
get<T>({
|
|
474
595
|
headers,
|
|
@@ -476,7 +597,8 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
476
597
|
maxRedirects,
|
|
477
598
|
cacheTTL,
|
|
478
599
|
context,
|
|
479
|
-
traceId
|
|
600
|
+
traceId,
|
|
601
|
+
requestConfig
|
|
480
602
|
}: {
|
|
481
603
|
headers?: HttpHeaders;
|
|
482
604
|
url: string;
|
|
@@ -484,6 +606,7 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
484
606
|
cacheTTL?: number;
|
|
485
607
|
context?: RequestContext;
|
|
486
608
|
traceId?: string;
|
|
609
|
+
requestConfig?: RequestConfig;
|
|
487
610
|
}): Promise<HttpResponse<T>>;
|
|
488
611
|
post<P, T>({
|
|
489
612
|
headers,
|
|
@@ -492,7 +615,8 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
492
615
|
cacheTTL,
|
|
493
616
|
context,
|
|
494
617
|
traceId,
|
|
495
|
-
payload
|
|
618
|
+
payload,
|
|
619
|
+
requestConfig
|
|
496
620
|
}: {
|
|
497
621
|
headers?: HttpHeaders;
|
|
498
622
|
url: string;
|
|
@@ -501,6 +625,7 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
|
|
|
501
625
|
context?: RequestContext;
|
|
502
626
|
traceId?: string;
|
|
503
627
|
payload?: P;
|
|
628
|
+
requestConfig?: RequestConfig;
|
|
504
629
|
}): Promise<HttpResponse<T>>;
|
|
505
630
|
}
|
|
506
631
|
//#endregion
|
|
@@ -522,44 +647,6 @@ declare class HttpClientManager {
|
|
|
522
647
|
static resetInstance(): void;
|
|
523
648
|
}
|
|
524
649
|
//#endregion
|
|
525
|
-
//#region src/rateLimitManager/types.d.ts
|
|
526
|
-
type RateLimitSubPoolConfig = {
|
|
527
|
-
subPoolKey: string;
|
|
528
|
-
urlPattern: RegExp | string;
|
|
529
|
-
rateLimit: number;
|
|
530
|
-
};
|
|
531
|
-
type RetryUnit = 'seconds' | 'milliseconds' | 'date';
|
|
532
|
-
type MappedRateLimitErrorConfig = {
|
|
533
|
-
errorStatus: number;
|
|
534
|
-
errorMessage: string | RegExp;
|
|
535
|
-
errorMessagePath?: string;
|
|
536
|
-
retryAfterPath?: string;
|
|
537
|
-
retryAfterUnit?: RetryUnit;
|
|
538
|
-
retryAfterValue?: number;
|
|
539
|
-
};
|
|
540
|
-
type RateLimitConfig = {
|
|
541
|
-
mainRatelimit: number;
|
|
542
|
-
subPools?: RateLimitSubPoolConfig[];
|
|
543
|
-
mappedRateLimitErrors?: MappedRateLimitErrorConfig[];
|
|
544
|
-
};
|
|
545
|
-
//#endregion
|
|
546
|
-
//#region src/interceptors/types.d.ts
|
|
547
|
-
type RequestInterceptor = (value: InternalAxiosRequestConfig<unknown>) => InternalAxiosRequestConfig<unknown> | Promise<InternalAxiosRequestConfig<unknown>>;
|
|
548
|
-
type ResponseInterceptor = (value: AxiosResponse<unknown, unknown>) => AxiosResponse<unknown, unknown> | Promise<AxiosResponse<unknown, unknown>>;
|
|
549
|
-
type ErrorInterceptor = (error: unknown) => unknown;
|
|
550
|
-
type Interceptor = RequestInterceptor | ResponseInterceptor | ErrorInterceptor | null;
|
|
551
|
-
interface InterceptorDependencies {
|
|
552
|
-
axiosInstance?: AxiosInstance;
|
|
553
|
-
logger?: ILogger;
|
|
554
|
-
context?: RequestContext;
|
|
555
|
-
requestConfig?: RequestConfig;
|
|
556
|
-
[key: string]: unknown;
|
|
557
|
-
}
|
|
558
|
-
type RequestConfig = {
|
|
559
|
-
rateLimits?: RateLimitConfig;
|
|
560
|
-
concurrency?: ConcurrencyConfig;
|
|
561
|
-
};
|
|
562
|
-
//#endregion
|
|
563
650
|
//#region src/httpTransportFactory/types.d.ts
|
|
564
651
|
type InterceptorDependencyInjector<T extends Interceptor> = (dependencies: InterceptorDependencies) => T;
|
|
565
652
|
type RequestInterceptorConfig = {
|
|
@@ -578,9 +665,10 @@ type InterceptorConfigs = {
|
|
|
578
665
|
type HttpTransportInstanceConfig = {
|
|
579
666
|
interceptors?: InterceptorConfigs;
|
|
580
667
|
instanceConfig?: CreateAxiosDefaults;
|
|
581
|
-
|
|
668
|
+
httpsAgentConfig?: AgentOptions;
|
|
582
669
|
logger?: ILogger;
|
|
583
670
|
context?: RequestContext;
|
|
671
|
+
requestConfig?: RequestConfig;
|
|
584
672
|
};
|
|
585
673
|
//#endregion
|
|
586
674
|
//#region src/httpTransportFactory/index.d.ts
|
|
@@ -588,9 +676,10 @@ declare class HttpTransportFactory {
|
|
|
588
676
|
static createInstance({
|
|
589
677
|
interceptors,
|
|
590
678
|
instanceConfig,
|
|
591
|
-
|
|
679
|
+
httpsAgentConfig,
|
|
592
680
|
logger,
|
|
593
|
-
context
|
|
681
|
+
context,
|
|
682
|
+
requestConfig
|
|
594
683
|
}: HttpTransportInstanceConfig): AxiosInstance;
|
|
595
684
|
private static applyInterceptors;
|
|
596
685
|
private static resolveInterceptorInstance;
|
|
@@ -787,4 +876,4 @@ type LockEntry = {
|
|
|
787
876
|
unlock: Unlock;
|
|
788
877
|
};
|
|
789
878
|
//#endregion
|
|
790
|
-
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, RedisClientConfig, RedisClientType, RequestClientFactory, RequestContext, RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, Unlock, buildHttpClientInstance, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };
|
|
879
|
+
export { CUSTOM_ERROR_CONFIG_SCHEMA, ConcurrencyManager, type CustomErrorConfig, type ErrorMappingFn, EventClient, HttpClient, HttpClientManager, HttpErrorMessages, type HttpHeaders, type HttpMethod, HttpMethods, type HttpParameters, type HttpQueryParams, type HttpResponse, HttpResponseError, HttpTransportFactory, type ICacheClient, type IHttpClient, InstanceManager, type Lock, type LockEntry, LockManager, MemoryStore, type MemoryStoreConfig, type PruneCount, type PubSubListener, QueueManager, RateLimitManager, RedisClient, type RedisClientConfig, type RedisClientType, RequestClientFactory, type RequestContext, type RequestParameter, RequestParameterLocations, ScriptManager, SubscriptionManager, type Unlock, buildHttpClientInstance, createAuthorizationHeaders, getTransportInstance, isFailedStatusCode, isInfoStatusCode, isSuccessStatusCode, parseRequestParameters };
|