@keboola/api-client 0.1.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/LICENSE +21 -0
- package/README.md +456 -0
- package/dist/ai/index.cjs +203 -0
- package/dist/ai/index.cjs.map +1 -0
- package/dist/ai/index.d.cts +35 -0
- package/dist/ai/index.d.ts +35 -0
- package/dist/ai/index.js +197 -0
- package/dist/ai/index.js.map +1 -0
- package/dist/ai/types.cjs +4 -0
- package/dist/ai/types.cjs.map +1 -0
- package/dist/ai/types.d.cts +2 -0
- package/dist/ai/types.d.ts +2 -0
- package/dist/ai/types.js +3 -0
- package/dist/ai/types.js.map +1 -0
- package/dist/assets/index.cjs +182 -0
- package/dist/assets/index.cjs.map +1 -0
- package/dist/assets/index.d.cts +9 -0
- package/dist/assets/index.d.ts +9 -0
- package/dist/assets/index.js +176 -0
- package/dist/assets/index.js.map +1 -0
- package/dist/assets/types.cjs +4 -0
- package/dist/assets/types.cjs.map +1 -0
- package/dist/assets/types.d.cts +8 -0
- package/dist/assets/types.d.ts +8 -0
- package/dist/assets/types.js +3 -0
- package/dist/assets/types.js.map +1 -0
- package/dist/authMiddleware-BTFSCMTE.d.ts +11 -0
- package/dist/authMiddleware-BteBe1Bt.d.cts +11 -0
- package/dist/chat/index.cjs +428 -0
- package/dist/chat/index.cjs.map +1 -0
- package/dist/chat/index.d.cts +51 -0
- package/dist/chat/index.d.ts +51 -0
- package/dist/chat/index.js +422 -0
- package/dist/chat/index.js.map +1 -0
- package/dist/chat/suggestions.cjs +158 -0
- package/dist/chat/suggestions.cjs.map +1 -0
- package/dist/chat/suggestions.d.cts +437 -0
- package/dist/chat/suggestions.d.ts +437 -0
- package/dist/chat/suggestions.js +140 -0
- package/dist/chat/suggestions.js.map +1 -0
- package/dist/chat/types.cjs +10 -0
- package/dist/chat/types.cjs.map +1 -0
- package/dist/chat/types.d.cts +3 -0
- package/dist/chat/types.d.ts +3 -0
- package/dist/chat/types.js +8 -0
- package/dist/chat/types.js.map +1 -0
- package/dist/createGenericFetchClient-CLUzu-jY.d.cts +18 -0
- package/dist/createGenericFetchClient-DEakI3F1.d.ts +18 -0
- package/dist/createOpenapiFetchClient-CpXmAIFB.d.cts +24 -0
- package/dist/createOpenapiFetchClient-_sm4bchL.d.ts +24 -0
- package/dist/dataScience/index.cjs +416 -0
- package/dist/dataScience/index.cjs.map +1 -0
- package/dist/dataScience/index.d.cts +191 -0
- package/dist/dataScience/index.d.ts +191 -0
- package/dist/dataScience/index.js +388 -0
- package/dist/dataScience/index.js.map +1 -0
- package/dist/dataScience/types.cjs +4 -0
- package/dist/dataScience/types.cjs.map +1 -0
- package/dist/dataScience/types.d.cts +2 -0
- package/dist/dataScience/types.d.ts +2 -0
- package/dist/dataScience/types.js +3 -0
- package/dist/dataScience/types.js.map +1 -0
- package/dist/editor/index.cjs +275 -0
- package/dist/editor/index.cjs.map +1 -0
- package/dist/editor/index.d.cts +172 -0
- package/dist/editor/index.d.ts +172 -0
- package/dist/editor/index.js +269 -0
- package/dist/editor/index.js.map +1 -0
- package/dist/editor/types.cjs +4 -0
- package/dist/editor/types.cjs.map +1 -0
- package/dist/editor/types.d.cts +2 -0
- package/dist/editor/types.d.ts +2 -0
- package/dist/editor/types.js +3 -0
- package/dist/editor/types.js.map +1 -0
- package/dist/encryption/index.cjs +192 -0
- package/dist/encryption/index.cjs.map +1 -0
- package/dist/encryption/index.d.cts +14 -0
- package/dist/encryption/index.d.ts +14 -0
- package/dist/encryption/index.js +186 -0
- package/dist/encryption/index.js.map +1 -0
- package/dist/encryption/types.cjs +4 -0
- package/dist/encryption/types.cjs.map +1 -0
- package/dist/encryption/types.d.cts +8 -0
- package/dist/encryption/types.d.ts +8 -0
- package/dist/encryption/types.js +3 -0
- package/dist/encryption/types.js.map +1 -0
- package/dist/import/index.cjs +198 -0
- package/dist/import/index.cjs.map +1 -0
- package/dist/import/index.d.cts +9 -0
- package/dist/import/index.d.ts +9 -0
- package/dist/import/index.js +192 -0
- package/dist/import/index.js.map +1 -0
- package/dist/index.cjs +3910 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +3108 -0
- package/dist/index.d.ts +3108 -0
- package/dist/index.js +3858 -0
- package/dist/index.js.map +1 -0
- package/dist/keboolaUID-D1DGSbge.d.cts +19 -0
- package/dist/keboolaUID-D1DGSbge.d.ts +19 -0
- package/dist/management/index.cjs +872 -0
- package/dist/management/index.cjs.map +1 -0
- package/dist/management/index.d.cts +440 -0
- package/dist/management/index.d.ts +440 -0
- package/dist/management/index.js +865 -0
- package/dist/management/index.js.map +1 -0
- package/dist/management/types.cjs +4 -0
- package/dist/management/types.cjs.map +1 -0
- package/dist/management/types.d.cts +9 -0
- package/dist/management/types.d.ts +9 -0
- package/dist/management/types.js +3 -0
- package/dist/management/types.js.map +1 -0
- package/dist/metastore/index.cjs +339 -0
- package/dist/metastore/index.cjs.map +1 -0
- package/dist/metastore/index.d.cts +52 -0
- package/dist/metastore/index.d.ts +52 -0
- package/dist/metastore/index.js +333 -0
- package/dist/metastore/index.js.map +1 -0
- package/dist/metastore/types.cjs +4 -0
- package/dist/metastore/types.cjs.map +1 -0
- package/dist/metastore/types.d.cts +2 -0
- package/dist/metastore/types.d.ts +2 -0
- package/dist/metastore/types.js +3 -0
- package/dist/metastore/types.js.map +1 -0
- package/dist/queryService/index.cjs +250 -0
- package/dist/queryService/index.cjs.map +1 -0
- package/dist/queryService/index.d.cts +39 -0
- package/dist/queryService/index.d.ts +39 -0
- package/dist/queryService/index.js +244 -0
- package/dist/queryService/index.js.map +1 -0
- package/dist/queryService/types.cjs +4 -0
- package/dist/queryService/types.cjs.map +1 -0
- package/dist/queryService/types.d.cts +2 -0
- package/dist/queryService/types.d.ts +2 -0
- package/dist/queryService/types.js +3 -0
- package/dist/queryService/types.js.map +1 -0
- package/dist/queue/index.cjs +192 -0
- package/dist/queue/index.cjs.map +1 -0
- package/dist/queue/index.d.cts +133 -0
- package/dist/queue/index.d.ts +133 -0
- package/dist/queue/index.js +186 -0
- package/dist/queue/index.js.map +1 -0
- package/dist/queue/types.cjs +4 -0
- package/dist/queue/types.cjs.map +1 -0
- package/dist/queue/types.d.cts +2 -0
- package/dist/queue/types.d.ts +2 -0
- package/dist/queue/types.js +3 -0
- package/dist/queue/types.js.map +1 -0
- package/dist/sdk/storage/index.cjs +96 -0
- package/dist/sdk/storage/index.cjs.map +1 -0
- package/dist/sdk/storage/index.d.cts +24 -0
- package/dist/sdk/storage/index.d.ts +24 -0
- package/dist/sdk/storage/index.js +94 -0
- package/dist/sdk/storage/index.js.map +1 -0
- package/dist/sdk/tag/index.cjs +210 -0
- package/dist/sdk/tag/index.cjs.map +1 -0
- package/dist/sdk/tag/index.d.cts +25 -0
- package/dist/sdk/tag/index.d.ts +25 -0
- package/dist/sdk/tag/index.js +208 -0
- package/dist/sdk/tag/index.js.map +1 -0
- package/dist/sdk/tag/types.cjs +4 -0
- package/dist/sdk/tag/types.cjs.map +1 -0
- package/dist/sdk/tag/types.d.cts +30 -0
- package/dist/sdk/tag/types.d.ts +30 -0
- package/dist/sdk/tag/types.js +3 -0
- package/dist/sdk/tag/types.js.map +1 -0
- package/dist/status/index.cjs +178 -0
- package/dist/status/index.cjs.map +1 -0
- package/dist/status/index.d.cts +10 -0
- package/dist/status/index.d.ts +10 -0
- package/dist/status/index.js +172 -0
- package/dist/status/index.js.map +1 -0
- package/dist/status/types.cjs +4 -0
- package/dist/status/types.cjs.map +1 -0
- package/dist/status/types.d.cts +19 -0
- package/dist/status/types.d.ts +19 -0
- package/dist/status/types.js +3 -0
- package/dist/status/types.js.map +1 -0
- package/dist/storage/index.cjs +1021 -0
- package/dist/storage/index.cjs.map +1 -0
- package/dist/storage/index.d.cts +12 -0
- package/dist/storage/index.d.ts +12 -0
- package/dist/storage/index.js +1014 -0
- package/dist/storage/index.js.map +1 -0
- package/dist/storage/types.cjs +4 -0
- package/dist/storage/types.cjs.map +1 -0
- package/dist/storage/types.d.cts +10976 -0
- package/dist/storage/types.d.ts +10976 -0
- package/dist/storage/types.js +3 -0
- package/dist/storage/types.js.map +1 -0
- package/dist/storageClient-DPLh_p0V.d.cts +608 -0
- package/dist/storageClient-YVWer22Y.d.ts +608 -0
- package/dist/syncActions/index.cjs +366 -0
- package/dist/syncActions/index.cjs.map +1 -0
- package/dist/syncActions/index.d.cts +94 -0
- package/dist/syncActions/index.d.ts +94 -0
- package/dist/syncActions/index.js +341 -0
- package/dist/syncActions/index.js.map +1 -0
- package/dist/syncActions/types.cjs +4 -0
- package/dist/syncActions/types.cjs.map +1 -0
- package/dist/syncActions/types.d.cts +261 -0
- package/dist/syncActions/types.d.ts +261 -0
- package/dist/syncActions/types.js +3 -0
- package/dist/syncActions/types.js.map +1 -0
- package/dist/telemetry/index.cjs +189 -0
- package/dist/telemetry/index.cjs.map +1 -0
- package/dist/telemetry/index.d.cts +13 -0
- package/dist/telemetry/index.d.ts +13 -0
- package/dist/telemetry/index.js +183 -0
- package/dist/telemetry/index.js.map +1 -0
- package/dist/telemetry/types.cjs +4 -0
- package/dist/telemetry/types.cjs.map +1 -0
- package/dist/telemetry/types.d.cts +12 -0
- package/dist/telemetry/types.d.ts +12 -0
- package/dist/telemetry/types.js +3 -0
- package/dist/telemetry/types.js.map +1 -0
- package/dist/types-B51cQMrX.d.ts +1408 -0
- package/dist/types-B7k8S4ki.d.ts +1520 -0
- package/dist/types-BNQK_jR_.d.cts +1520 -0
- package/dist/types-BY0tjg2Q.d.ts +1079 -0
- package/dist/types-BeShtGlc.d.cts +8591 -0
- package/dist/types-BeShtGlc.d.ts +8591 -0
- package/dist/types-BjrNNn5I.d.ts +1643 -0
- package/dist/types-C-bd4ArM.d.cts +1079 -0
- package/dist/types-C7mpAfq-.d.cts +64 -0
- package/dist/types-C7mpAfq-.d.ts +64 -0
- package/dist/types-CGMJT3JL.d.ts +943 -0
- package/dist/types-CRSKcua9.d.cts +1314 -0
- package/dist/types-DJ6nbNq5.d.cts +1643 -0
- package/dist/types-DJkU9gvB.d.cts +943 -0
- package/dist/types-DYMMsuU0.d.cts +78 -0
- package/dist/types-DYMMsuU0.d.ts +78 -0
- package/dist/types-Dg1tEsVR.d.cts +17 -0
- package/dist/types-Dg1tEsVR.d.ts +17 -0
- package/dist/types-DgaMV8FF.d.cts +60 -0
- package/dist/types-DgaMV8FF.d.ts +60 -0
- package/dist/types-Dws8mFNY.d.cts +1408 -0
- package/dist/types-cH0_hkCW.d.ts +1314 -0
- package/dist/utils-BNQZiNOu.d.ts +1657 -0
- package/dist/utils-DE09pDTi.d.cts +1657 -0
- package/dist/vault/index.cjs +225 -0
- package/dist/vault/index.cjs.map +1 -0
- package/dist/vault/index.d.cts +26 -0
- package/dist/vault/index.d.ts +26 -0
- package/dist/vault/index.js +219 -0
- package/dist/vault/index.js.map +1 -0
- package/dist/vault/types.cjs +4 -0
- package/dist/vault/types.cjs.map +1 -0
- package/dist/vault/types.d.cts +390 -0
- package/dist/vault/types.d.ts +390 -0
- package/dist/vault/types.js +3 -0
- package/dist/vault/types.js.map +1 -0
- package/dist/verify/index.cjs +190 -0
- package/dist/verify/index.cjs.map +1 -0
- package/dist/verify/index.d.cts +9 -0
- package/dist/verify/index.d.ts +9 -0
- package/dist/verify/index.js +184 -0
- package/dist/verify/index.js.map +1 -0
- package/dist/verify/types.cjs +4 -0
- package/dist/verify/types.cjs.map +1 -0
- package/dist/verify/types.d.cts +29 -0
- package/dist/verify/types.d.ts +29 -0
- package/dist/verify/types.js +3 -0
- package/dist/verify/types.js.map +1 -0
- package/package.json +570 -0
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
declare const Backends: {
|
|
2
|
+
readonly SNOWFLAKE: "snowflake";
|
|
3
|
+
readonly BIGQUERY: "bigquery";
|
|
4
|
+
};
|
|
5
|
+
type Backend = (typeof Backends)[keyof typeof Backends];
|
|
6
|
+
type StorageTokenOwner = {
|
|
7
|
+
id: number;
|
|
8
|
+
name: string;
|
|
9
|
+
type: string;
|
|
10
|
+
region: string;
|
|
11
|
+
created: string;
|
|
12
|
+
expires: string | null;
|
|
13
|
+
features: string[];
|
|
14
|
+
dataSizeBytes: number;
|
|
15
|
+
rowsCount: number;
|
|
16
|
+
hasMysql: boolean;
|
|
17
|
+
hasSynapse: boolean;
|
|
18
|
+
hasRedshift: boolean;
|
|
19
|
+
hasSnowflake: boolean;
|
|
20
|
+
hasExasol: boolean;
|
|
21
|
+
hasTeradata: boolean;
|
|
22
|
+
hasBigquery: boolean;
|
|
23
|
+
defaultBackend: string;
|
|
24
|
+
hasTryModeOn: string;
|
|
25
|
+
limits: Record<string, {
|
|
26
|
+
name: string;
|
|
27
|
+
value: number;
|
|
28
|
+
}>;
|
|
29
|
+
metrics: Record<string, {
|
|
30
|
+
name: string;
|
|
31
|
+
value: number;
|
|
32
|
+
}>;
|
|
33
|
+
isDisabled: boolean;
|
|
34
|
+
billedMonthlyPrice: number | null;
|
|
35
|
+
dataRetentionTimeInDays: number;
|
|
36
|
+
assignedBackends: Backend[];
|
|
37
|
+
fileStorageProvider: string;
|
|
38
|
+
};
|
|
39
|
+
type StorageTokenAdmin = {
|
|
40
|
+
id: number;
|
|
41
|
+
name: string;
|
|
42
|
+
features: string[];
|
|
43
|
+
isOrganizationMember: boolean;
|
|
44
|
+
role: string;
|
|
45
|
+
};
|
|
46
|
+
type StorageTokenAdminOwner = {
|
|
47
|
+
id: number;
|
|
48
|
+
name: string;
|
|
49
|
+
email: string;
|
|
50
|
+
};
|
|
51
|
+
type StorageToken = {
|
|
52
|
+
id: string;
|
|
53
|
+
created: string;
|
|
54
|
+
refreshed: string;
|
|
55
|
+
description: string;
|
|
56
|
+
uri: string;
|
|
57
|
+
isMasterToken: boolean;
|
|
58
|
+
canManageBuckets: boolean;
|
|
59
|
+
canManageTokens: boolean;
|
|
60
|
+
canReadAllFileUploads: boolean;
|
|
61
|
+
canPurgeTrash: boolean;
|
|
62
|
+
canManageProtectedDefaultBranch: boolean;
|
|
63
|
+
canCreateJobs: boolean;
|
|
64
|
+
expires: string | null;
|
|
65
|
+
isExpired: boolean;
|
|
66
|
+
isDisabled: boolean;
|
|
67
|
+
isBYODB: boolean;
|
|
68
|
+
dailyCapacity: number;
|
|
69
|
+
bucketPermissions: Record<string, string>;
|
|
70
|
+
owner: StorageTokenOwner;
|
|
71
|
+
organization: {
|
|
72
|
+
id: string;
|
|
73
|
+
};
|
|
74
|
+
admin: StorageTokenAdmin;
|
|
75
|
+
adminOwner: StorageTokenAdminOwner;
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
export { type Backend as B, type StorageToken as S, Backends as a };
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
declare const Backends: {
|
|
2
|
+
readonly SNOWFLAKE: "snowflake";
|
|
3
|
+
readonly BIGQUERY: "bigquery";
|
|
4
|
+
};
|
|
5
|
+
type Backend = (typeof Backends)[keyof typeof Backends];
|
|
6
|
+
type StorageTokenOwner = {
|
|
7
|
+
id: number;
|
|
8
|
+
name: string;
|
|
9
|
+
type: string;
|
|
10
|
+
region: string;
|
|
11
|
+
created: string;
|
|
12
|
+
expires: string | null;
|
|
13
|
+
features: string[];
|
|
14
|
+
dataSizeBytes: number;
|
|
15
|
+
rowsCount: number;
|
|
16
|
+
hasMysql: boolean;
|
|
17
|
+
hasSynapse: boolean;
|
|
18
|
+
hasRedshift: boolean;
|
|
19
|
+
hasSnowflake: boolean;
|
|
20
|
+
hasExasol: boolean;
|
|
21
|
+
hasTeradata: boolean;
|
|
22
|
+
hasBigquery: boolean;
|
|
23
|
+
defaultBackend: string;
|
|
24
|
+
hasTryModeOn: string;
|
|
25
|
+
limits: Record<string, {
|
|
26
|
+
name: string;
|
|
27
|
+
value: number;
|
|
28
|
+
}>;
|
|
29
|
+
metrics: Record<string, {
|
|
30
|
+
name: string;
|
|
31
|
+
value: number;
|
|
32
|
+
}>;
|
|
33
|
+
isDisabled: boolean;
|
|
34
|
+
billedMonthlyPrice: number | null;
|
|
35
|
+
dataRetentionTimeInDays: number;
|
|
36
|
+
assignedBackends: Backend[];
|
|
37
|
+
fileStorageProvider: string;
|
|
38
|
+
};
|
|
39
|
+
type StorageTokenAdmin = {
|
|
40
|
+
id: number;
|
|
41
|
+
name: string;
|
|
42
|
+
features: string[];
|
|
43
|
+
isOrganizationMember: boolean;
|
|
44
|
+
role: string;
|
|
45
|
+
};
|
|
46
|
+
type StorageTokenAdminOwner = {
|
|
47
|
+
id: number;
|
|
48
|
+
name: string;
|
|
49
|
+
email: string;
|
|
50
|
+
};
|
|
51
|
+
type StorageToken = {
|
|
52
|
+
id: string;
|
|
53
|
+
created: string;
|
|
54
|
+
refreshed: string;
|
|
55
|
+
description: string;
|
|
56
|
+
uri: string;
|
|
57
|
+
isMasterToken: boolean;
|
|
58
|
+
canManageBuckets: boolean;
|
|
59
|
+
canManageTokens: boolean;
|
|
60
|
+
canReadAllFileUploads: boolean;
|
|
61
|
+
canPurgeTrash: boolean;
|
|
62
|
+
canManageProtectedDefaultBranch: boolean;
|
|
63
|
+
canCreateJobs: boolean;
|
|
64
|
+
expires: string | null;
|
|
65
|
+
isExpired: boolean;
|
|
66
|
+
isDisabled: boolean;
|
|
67
|
+
isBYODB: boolean;
|
|
68
|
+
dailyCapacity: number;
|
|
69
|
+
bucketPermissions: Record<string, string>;
|
|
70
|
+
owner: StorageTokenOwner;
|
|
71
|
+
organization: {
|
|
72
|
+
id: string;
|
|
73
|
+
};
|
|
74
|
+
admin: StorageTokenAdmin;
|
|
75
|
+
adminOwner: StorageTokenAdminOwner;
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
export { type Backend as B, type StorageToken as S, Backends as a };
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
type UploadFileParams = {
|
|
2
|
+
isPermanent?: boolean;
|
|
3
|
+
tags?: string[];
|
|
4
|
+
notify?: boolean;
|
|
5
|
+
branchId?: string;
|
|
6
|
+
};
|
|
7
|
+
type UploadedFile = {
|
|
8
|
+
id: number;
|
|
9
|
+
name: string;
|
|
10
|
+
url: string;
|
|
11
|
+
isPublic: boolean;
|
|
12
|
+
sizeBytes: number;
|
|
13
|
+
tags: string[];
|
|
14
|
+
created: string;
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
export type { UploadFileParams as U, UploadedFile as a };
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
type UploadFileParams = {
|
|
2
|
+
isPermanent?: boolean;
|
|
3
|
+
tags?: string[];
|
|
4
|
+
notify?: boolean;
|
|
5
|
+
branchId?: string;
|
|
6
|
+
};
|
|
7
|
+
type UploadedFile = {
|
|
8
|
+
id: number;
|
|
9
|
+
name: string;
|
|
10
|
+
url: string;
|
|
11
|
+
isPublic: boolean;
|
|
12
|
+
sizeBytes: number;
|
|
13
|
+
tags: string[];
|
|
14
|
+
created: string;
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
export type { UploadFileParams as U, UploadedFile as a };
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { IStringifyOptions } from 'qs';
|
|
2
|
+
|
|
3
|
+
declare class ApiError extends Error {
|
|
4
|
+
response: Response;
|
|
5
|
+
request: Request;
|
|
6
|
+
data: unknown;
|
|
7
|
+
constructor({ response, request, data }: ApiResponse);
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options';
|
|
11
|
+
type PathParam = Record<string, string | number>;
|
|
12
|
+
type QueryParam = Record<string, unknown>;
|
|
13
|
+
type BodyParam = Record<string, unknown> | FormData | string | undefined | null | Record<string, unknown>[];
|
|
14
|
+
type ValidateStatusFn = (options: ApiResponse) => boolean | ApiError;
|
|
15
|
+
type CustomRequestInit = Omit<RequestInit, 'method' | 'body'>;
|
|
16
|
+
type FetchFn = typeof fetch;
|
|
17
|
+
type CreateFetchClientOptions = {
|
|
18
|
+
baseUrl: string;
|
|
19
|
+
validateStatus?: ValidateStatusFn;
|
|
20
|
+
middlewares?: MiddlewareFn[];
|
|
21
|
+
fetchFn?: FetchFn;
|
|
22
|
+
} & CustomRequestInit;
|
|
23
|
+
type FetchClientOptions = {
|
|
24
|
+
validateStatus?: ValidateStatusFn;
|
|
25
|
+
queryArrayFormat?: IStringifyOptions['arrayFormat'];
|
|
26
|
+
middlewares?: MiddlewareFn[];
|
|
27
|
+
} & CustomRequestInit;
|
|
28
|
+
type ApiResponse<Data = unknown> = {
|
|
29
|
+
data: Data;
|
|
30
|
+
response: Response;
|
|
31
|
+
request: Request;
|
|
32
|
+
};
|
|
33
|
+
type FetchRequest = {
|
|
34
|
+
request: Request;
|
|
35
|
+
validateStatus: ValidateStatusFn;
|
|
36
|
+
};
|
|
37
|
+
type CoreFetchFn = (request: FetchRequest) => Promise<ApiResponse>;
|
|
38
|
+
type MiddlewareFn = (next: CoreFetchFn) => CoreFetchFn;
|
|
39
|
+
|
|
40
|
+
type FetchClientError = TypeError | ApiError | SyntaxError | DOMException;
|
|
41
|
+
declare const isApiError: (error: unknown) => error is ApiError;
|
|
42
|
+
declare const isAbortError: (error: unknown) => error is DOMException;
|
|
43
|
+
declare const isFetchClientError: (error: unknown) => error is FetchClientError;
|
|
44
|
+
|
|
45
|
+
type CreateCallbackMiddlewareOptions = {
|
|
46
|
+
onError?: (error: FetchClientError) => void;
|
|
47
|
+
onSuccess?: () => void;
|
|
48
|
+
onSettled?: () => void;
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
type BaseClientOptions = {
|
|
52
|
+
baseUrl: string;
|
|
53
|
+
callbacks?: CreateCallbackMiddlewareOptions;
|
|
54
|
+
};
|
|
55
|
+
type ClientInitOptions = {
|
|
56
|
+
baseUrl: string;
|
|
57
|
+
middlewares: MiddlewareFn[];
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
export { type ApiResponse as A, type BaseClientOptions as B, type ClientInitOptions as C, type FetchClientOptions as F, type HttpMethod as H, type MiddlewareFn as M, type PathParam as P, type QueryParam as Q, type CreateFetchClientOptions as a, type BodyParam as b, ApiError as c, type CreateCallbackMiddlewareOptions as d, type FetchClientError as e, isApiError as f, isFetchClientError as g, isAbortError as i };
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { IStringifyOptions } from 'qs';
|
|
2
|
+
|
|
3
|
+
declare class ApiError extends Error {
|
|
4
|
+
response: Response;
|
|
5
|
+
request: Request;
|
|
6
|
+
data: unknown;
|
|
7
|
+
constructor({ response, request, data }: ApiResponse);
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options';
|
|
11
|
+
type PathParam = Record<string, string | number>;
|
|
12
|
+
type QueryParam = Record<string, unknown>;
|
|
13
|
+
type BodyParam = Record<string, unknown> | FormData | string | undefined | null | Record<string, unknown>[];
|
|
14
|
+
type ValidateStatusFn = (options: ApiResponse) => boolean | ApiError;
|
|
15
|
+
type CustomRequestInit = Omit<RequestInit, 'method' | 'body'>;
|
|
16
|
+
type FetchFn = typeof fetch;
|
|
17
|
+
type CreateFetchClientOptions = {
|
|
18
|
+
baseUrl: string;
|
|
19
|
+
validateStatus?: ValidateStatusFn;
|
|
20
|
+
middlewares?: MiddlewareFn[];
|
|
21
|
+
fetchFn?: FetchFn;
|
|
22
|
+
} & CustomRequestInit;
|
|
23
|
+
type FetchClientOptions = {
|
|
24
|
+
validateStatus?: ValidateStatusFn;
|
|
25
|
+
queryArrayFormat?: IStringifyOptions['arrayFormat'];
|
|
26
|
+
middlewares?: MiddlewareFn[];
|
|
27
|
+
} & CustomRequestInit;
|
|
28
|
+
type ApiResponse<Data = unknown> = {
|
|
29
|
+
data: Data;
|
|
30
|
+
response: Response;
|
|
31
|
+
request: Request;
|
|
32
|
+
};
|
|
33
|
+
type FetchRequest = {
|
|
34
|
+
request: Request;
|
|
35
|
+
validateStatus: ValidateStatusFn;
|
|
36
|
+
};
|
|
37
|
+
type CoreFetchFn = (request: FetchRequest) => Promise<ApiResponse>;
|
|
38
|
+
type MiddlewareFn = (next: CoreFetchFn) => CoreFetchFn;
|
|
39
|
+
|
|
40
|
+
type FetchClientError = TypeError | ApiError | SyntaxError | DOMException;
|
|
41
|
+
declare const isApiError: (error: unknown) => error is ApiError;
|
|
42
|
+
declare const isAbortError: (error: unknown) => error is DOMException;
|
|
43
|
+
declare const isFetchClientError: (error: unknown) => error is FetchClientError;
|
|
44
|
+
|
|
45
|
+
type CreateCallbackMiddlewareOptions = {
|
|
46
|
+
onError?: (error: FetchClientError) => void;
|
|
47
|
+
onSuccess?: () => void;
|
|
48
|
+
onSettled?: () => void;
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
type BaseClientOptions = {
|
|
52
|
+
baseUrl: string;
|
|
53
|
+
callbacks?: CreateCallbackMiddlewareOptions;
|
|
54
|
+
};
|
|
55
|
+
type ClientInitOptions = {
|
|
56
|
+
baseUrl: string;
|
|
57
|
+
middlewares: MiddlewareFn[];
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
export { type ApiResponse as A, type BaseClientOptions as B, type ClientInitOptions as C, type FetchClientOptions as F, type HttpMethod as H, type MiddlewareFn as M, type PathParam as P, type QueryParam as Q, type CreateFetchClientOptions as a, type BodyParam as b, ApiError as c, type CreateCallbackMiddlewareOptions as d, type FetchClientError as e, isApiError as f, isFetchClientError as g, isAbortError as i };
|