@zcatalyst/transport 0.0.2 → 0.0.3
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/LICENCE +55 -1
- package/README.md +266 -0
- package/dist-cjs/fetch-handler.js +67 -64
- package/dist-cjs/http-handler.js +25 -23
- package/dist-cjs/index.browser.js +8 -3
- package/dist-cjs/index.js +9 -7
- package/dist-cjs/utils/clonable-stream.js +1 -1
- package/dist-cjs/utils/form-data.js +11 -5
- package/dist-cjs/utils/request-agent.js +1 -1
- package/dist-es/fetch-handler.js +64 -64
- package/dist-es/http-handler.js +25 -24
- package/dist-es/index.browser.js +3 -2
- package/dist-es/index.js +3 -5
- package/dist-es/utils/clonable-stream.js +0 -1
- package/dist-es/utils/form-data.js +10 -5
- package/dist-es/utils/request-agent.js +0 -1
- package/dist-types/fetch-handler.d.ts +115 -6
- package/dist-types/http-handler.d.ts +48 -8
- package/dist-types/index.browser.d.ts +17 -1
- package/dist-types/index.d.ts +22 -2
- package/dist-types/ts3.4/fetch-handler.d.ts +115 -6
- package/dist-types/ts3.4/http-handler.d.ts +48 -8
- package/dist-types/ts3.4/index.browser.d.ts +17 -1
- package/dist-types/ts3.4/index.d.ts +22 -2
- package/dist-types/ts3.4/utils/clonable-stream.d.ts +54 -0
- package/dist-types/ts3.4/utils/errors.d.ts +7 -0
- package/dist-types/ts3.4/utils/form-data.d.ts +242 -1
- package/dist-types/ts3.4/utils/helpers.d.ts +12 -0
- package/dist-types/ts3.4/utils/interfaces.d.ts +5 -1
- package/dist-types/ts3.4/utils/request-agent.d.ts +6 -0
- package/dist-types/ts3.4/utils/request-timeout.d.ts +12 -0
- package/dist-types/utils/clonable-stream.d.ts +54 -0
- package/dist-types/utils/errors.d.ts +7 -0
- package/dist-types/utils/form-data.d.ts +242 -1
- package/dist-types/utils/helpers.d.ts +12 -0
- package/dist-types/utils/interfaces.d.ts +5 -1
- package/dist-types/utils/request-agent.d.ts +6 -0
- package/dist-types/utils/request-timeout.d.ts +12 -0
- package/package.json +31 -6
|
@@ -1 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reports whether a URL uses the HTTPS protocol.
|
|
3
|
+
*
|
|
4
|
+
* @param url - The URL to update or request.
|
|
5
|
+
* @returns True when the URL uses HTTPS.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* import { Handler } from '@zcatalyst/transport';
|
|
10
|
+
* const result = isHttps("https://example.com");
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
1
13
|
export declare function isHttps(url?: string | URL): boolean;
|
|
@@ -2,6 +2,7 @@ import { CatalystService } from '@zcatalyst/utils';
|
|
|
2
2
|
import { RequestType, ResponseType } from './enums';
|
|
3
3
|
export interface Component {
|
|
4
4
|
getComponentName(): string;
|
|
5
|
+
getComponentVersion?(): string;
|
|
5
6
|
}
|
|
6
7
|
export interface jwtAccessTokenResponse {
|
|
7
8
|
access_token: string;
|
|
@@ -27,6 +28,8 @@ export interface RequestHandlerOptions {
|
|
|
27
28
|
requestTimeout?: number;
|
|
28
29
|
expecting?: ResponseType;
|
|
29
30
|
auth?: boolean;
|
|
31
|
+
duplex?: string;
|
|
32
|
+
service?: CatalystService;
|
|
30
33
|
}
|
|
31
34
|
export interface HTTP_CODE_MAP_BODY_TYPE {
|
|
32
35
|
CODE: number;
|
|
@@ -43,9 +46,10 @@ export interface FORMDATA {
|
|
|
43
46
|
name: string;
|
|
44
47
|
}
|
|
45
48
|
export interface IRequestConfig {
|
|
49
|
+
duplex?: string;
|
|
46
50
|
data?: string | Array<{
|
|
47
51
|
[x: string]: unknown;
|
|
48
|
-
}> | Array<string | number> | Record<string, unknown> |
|
|
52
|
+
}> | Array<string | number> | Record<string, unknown> | unknown;
|
|
49
53
|
type?: RequestType;
|
|
50
54
|
qs?: Record<string, string | number | boolean | undefined>;
|
|
51
55
|
path?: string;
|
|
@@ -2,5 +2,11 @@ import { Agent as httpAgent } from 'http';
|
|
|
2
2
|
import { Agent as httpsAgent } from 'https';
|
|
3
3
|
export default class RequestAgent {
|
|
4
4
|
agent: httpAgent | httpsAgent;
|
|
5
|
+
/**
|
|
6
|
+
* Creates a RequestAgent instance.
|
|
7
|
+
* @param isHttps - The isHttps value.
|
|
8
|
+
* @param host - The host value.
|
|
9
|
+
* @param replaceAgent - The replaceAgent value.
|
|
10
|
+
*/
|
|
5
11
|
constructor(isHttps: boolean, host: string, replaceAgent: boolean);
|
|
6
12
|
}
|
|
@@ -1 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Creates a promise that rejects when a request exceeds the configured timeout.
|
|
3
|
+
*
|
|
4
|
+
* @param timeoutInMs - The timeout duration in milliseconds.
|
|
5
|
+
* @returns A promise that rejects when the timeout elapses.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* import { Handler } from '@zcatalyst/transport';
|
|
10
|
+
* const result = undefined;
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
1
13
|
export declare function requestTimeout(timeoutInMs?: number): Promise<never>;
|
package/package.json
CHANGED
|
@@ -1,19 +1,44 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zcatalyst/transport",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"main": "./dist-cjs/index.js",
|
|
5
5
|
"module": "./dist-es/index.js",
|
|
6
6
|
"types": "./dist-types/index.d.ts",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": {
|
|
9
|
+
"node": {
|
|
10
|
+
"import": "./dist-es/index.js",
|
|
11
|
+
"require": "./dist-cjs/index.js",
|
|
12
|
+
"types": "./dist-types/index.d.ts"
|
|
13
|
+
},
|
|
14
|
+
"browser": {
|
|
15
|
+
"import": "./dist-es/index.browser.js",
|
|
16
|
+
"require": "./dist-cjs/index.browser.js",
|
|
17
|
+
"types": "./dist-types/index.browser.d.ts"
|
|
18
|
+
},
|
|
19
|
+
"default": {
|
|
20
|
+
"import": "./dist-es/index.js",
|
|
21
|
+
"require": "./dist-cjs/index.js",
|
|
22
|
+
"types": "./dist-types/index.d.ts"
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
},
|
|
7
26
|
"license": "Apache-2.0",
|
|
27
|
+
"sideEffects": false,
|
|
8
28
|
"dependencies": {
|
|
9
|
-
"@zcatalyst/
|
|
10
|
-
"@zcatalyst/auth-
|
|
11
|
-
"@zcatalyst/
|
|
29
|
+
"@zcatalyst/utils": "^0.0.3",
|
|
30
|
+
"@zcatalyst/auth-admin": "^0.0.3",
|
|
31
|
+
"@zcatalyst/auth-client": "^0.0.3"
|
|
12
32
|
},
|
|
13
33
|
"browser": {
|
|
14
34
|
"./dist-cjs/index.js": "./dist-cjs/index.browser.js",
|
|
15
35
|
"./dist-es/index.js": "./dist-es/index.browser.js",
|
|
16
|
-
"./dist-types/index.d.ts": "./dist-types/index.browser.d.ts"
|
|
36
|
+
"./dist-types/index.d.ts": "./dist-types/index.browser.d.ts",
|
|
37
|
+
"stream": false,
|
|
38
|
+
"crypto": false,
|
|
39
|
+
"fs": false,
|
|
40
|
+
"path": false,
|
|
41
|
+
"process": false
|
|
17
42
|
},
|
|
18
43
|
"engines": {
|
|
19
44
|
"node": ">=20"
|
|
@@ -27,7 +52,7 @@
|
|
|
27
52
|
"catalyst"
|
|
28
53
|
],
|
|
29
54
|
"scripts": {
|
|
30
|
-
"build": "concurrently 'pnpm:build:cjs' 'pnpm:build:es' 'pnpm:build:types && pnpm build:types:downlevel'",
|
|
55
|
+
"build": "pnpm clean && concurrently 'pnpm:build:cjs' 'pnpm:build:es' 'pnpm:build:types && pnpm build:types:downlevel'",
|
|
31
56
|
"build:cjs": "pnpm tsc -p tsconfig.cjs.json",
|
|
32
57
|
"build:es": "pnpm tsc -p tsconfig.es.json",
|
|
33
58
|
"build:types": "pnpm tsc -p tsconfig.types.json",
|