@phala/cloud 0.0.1 → 0.0.2
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/actions/add_compose_hash.d.ts +62 -0
- package/dist/actions/add_compose_hash.d.ts.map +1 -0
- package/dist/actions/commit_cvm_compose_file_update.d.ts +143 -0
- package/dist/actions/commit_cvm_compose_file_update.d.ts.map +1 -0
- package/dist/actions/commit_cvm_provision.d.ts +209 -0
- package/dist/actions/commit_cvm_provision.d.ts.map +1 -0
- package/dist/actions/deploy_app_auth.d.ts +156 -0
- package/dist/actions/deploy_app_auth.d.ts.map +1 -0
- package/dist/actions/get_app_env_encrypt_pubkey.d.ts +30 -0
- package/dist/actions/get_app_env_encrypt_pubkey.d.ts.map +1 -0
- package/dist/actions/get_available_nodes.d.ts +572 -0
- package/dist/actions/get_available_nodes.d.ts.map +1 -0
- package/dist/actions/get_current_user.d.ts +92 -0
- package/dist/actions/get_current_user.d.ts.map +1 -0
- package/dist/actions/get_cvm_compose_file.d.ts +190 -0
- package/dist/actions/get_cvm_compose_file.d.ts.map +1 -0
- package/dist/actions/get_cvm_info.d.ts +292 -0
- package/dist/actions/get_cvm_info.d.ts.map +1 -0
- package/dist/actions/get_cvm_list.d.ts +392 -0
- package/dist/actions/get_cvm_list.d.ts.map +1 -0
- package/dist/actions/get_kms_info.d.ts +34 -0
- package/dist/actions/get_kms_info.d.ts.map +1 -0
- package/dist/actions/get_kms_list.d.ts +82 -0
- package/dist/actions/get_kms_list.d.ts.map +1 -0
- package/dist/actions/index.d.ts +15 -0
- package/dist/actions/index.d.ts.map +1 -0
- package/dist/actions/provision_cvm.d.ts +228 -0
- package/dist/actions/provision_cvm.d.ts.map +1 -0
- package/dist/actions/provision_cvm_compose_file_update.d.ts +313 -0
- package/dist/actions/provision_cvm_compose_file_update.d.ts.map +1 -0
- package/dist/client.d.ts +80 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/index.d.ts +8 -2978
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +5 -2
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +5 -2
- package/dist/index.mjs.map +1 -0
- package/dist/types/client.d.ts +126 -0
- package/dist/types/client.d.ts.map +1 -0
- package/dist/types/common.d.ts +17 -0
- package/dist/types/common.d.ts.map +1 -0
- package/dist/types/cvm_info.d.ts +325 -0
- package/dist/types/cvm_info.d.ts.map +1 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/kms_info.d.ts +28 -0
- package/dist/types/kms_info.d.ts.map +1 -0
- package/dist/utils/as-hex.d.ts +17 -0
- package/dist/utils/as-hex.d.ts.map +1 -0
- package/dist/utils/client-factories.d.ts +44 -0
- package/dist/utils/client-factories.d.ts.map +1 -0
- package/dist/utils/get_compose_hash.d.ts +15 -0
- package/dist/utils/get_compose_hash.d.ts.map +1 -0
- package/dist/utils/get_error_message.d.ts +3 -0
- package/dist/utils/get_error_message.d.ts.map +1 -0
- package/dist/utils/index.d.ts +9 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/network.d.ts +101 -0
- package/dist/utils/network.d.ts.map +1 -0
- package/dist/utils/transaction.d.ts +81 -0
- package/dist/utils/transaction.d.ts.map +1 -0
- package/dist/utils/validate-parameters.d.ts +20 -0
- package/dist/utils/validate-parameters.d.ts.map +1 -0
- package/package.json +10 -4
- package/dist/index.d.mts +0 -2978
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { type Client, type SafeResult } from "../client";
|
|
3
|
+
import { ActionParameters, ActionReturnType } from "../types/common";
|
|
4
|
+
/**
|
|
5
|
+
* Provision a CVM (Confidential Virtual Machine)
|
|
6
|
+
*
|
|
7
|
+
* This action provisions a new CVM on a specified node, returning the app_id, encryption public key, and other metadata required for secure deployment.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* import { createClient, getAvailableNodes, provisionCvm } from '@phala/cloud'
|
|
12
|
+
*
|
|
13
|
+
* const client = createClient();
|
|
14
|
+
* const nodes = await getAvailableNodes(client);
|
|
15
|
+
* const node = nodes.nodes[0];
|
|
16
|
+
*
|
|
17
|
+
* const docker_compose = `
|
|
18
|
+
*version: '3'
|
|
19
|
+
*services:
|
|
20
|
+
* demo:
|
|
21
|
+
* image: leechael/phala-cloud-bun-starter:latest
|
|
22
|
+
* container_name: demo
|
|
23
|
+
* ports:
|
|
24
|
+
* - "3000:3000"
|
|
25
|
+
* volumes:
|
|
26
|
+
* - /var/run/tappd.sock:/var/run/tappd.sock
|
|
27
|
+
*`;
|
|
28
|
+
*
|
|
29
|
+
* const app_compose = {
|
|
30
|
+
* name: 'my-app',
|
|
31
|
+
* node_id: node.node_id,
|
|
32
|
+
* image: node.images[0].name,
|
|
33
|
+
* vcpu: 1,
|
|
34
|
+
* memory: 1024,
|
|
35
|
+
* disk_size: 10,
|
|
36
|
+
* compose_file: {
|
|
37
|
+
* docker_compose_file: docker_compose,
|
|
38
|
+
* name: 'my-app',
|
|
39
|
+
* },
|
|
40
|
+
* };
|
|
41
|
+
*
|
|
42
|
+
* const result = await provisionCvm(client, app_compose);
|
|
43
|
+
* console.log(result.app_id);
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* ## Safe Version
|
|
47
|
+
*
|
|
48
|
+
* Use `safeProvisionCvm` for error handling without exceptions:
|
|
49
|
+
*
|
|
50
|
+
* ```typescript
|
|
51
|
+
* const result = await safeProvisionCvm(client, app_compose);
|
|
52
|
+
* if (result.success) {
|
|
53
|
+
* console.log(result.data.app_id);
|
|
54
|
+
* } else {
|
|
55
|
+
* console.error('Failed to provision CVM:', result.error.message);
|
|
56
|
+
* }
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
export declare const ProvisionCvmSchema: z.ZodObject<{
|
|
60
|
+
app_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
61
|
+
app_env_encrypt_pubkey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
62
|
+
compose_hash: z.ZodString;
|
|
63
|
+
fmspc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
64
|
+
device_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
65
|
+
os_image_hash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
66
|
+
node_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
67
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
68
|
+
app_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
69
|
+
app_env_encrypt_pubkey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
70
|
+
compose_hash: z.ZodString;
|
|
71
|
+
fmspc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
72
|
+
device_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
73
|
+
os_image_hash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
74
|
+
node_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
75
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
76
|
+
app_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
77
|
+
app_env_encrypt_pubkey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
78
|
+
compose_hash: z.ZodString;
|
|
79
|
+
fmspc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
80
|
+
device_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
81
|
+
os_image_hash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
82
|
+
node_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
83
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
84
|
+
export type ProvisionCvm = z.infer<typeof ProvisionCvmSchema>;
|
|
85
|
+
export declare const ProvisionCvmRequestSchema: z.ZodObject<{
|
|
86
|
+
node_id: z.ZodOptional<z.ZodNumber>;
|
|
87
|
+
teepod_id: z.ZodOptional<z.ZodNumber>;
|
|
88
|
+
name: z.ZodString;
|
|
89
|
+
image: z.ZodString;
|
|
90
|
+
vcpu: z.ZodNumber;
|
|
91
|
+
memory: z.ZodNumber;
|
|
92
|
+
disk_size: z.ZodNumber;
|
|
93
|
+
compose_file: z.ZodObject<{
|
|
94
|
+
allowed_envs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
95
|
+
pre_launch_script: z.ZodOptional<z.ZodString>;
|
|
96
|
+
docker_compose_file: z.ZodOptional<z.ZodString>;
|
|
97
|
+
name: z.ZodOptional<z.ZodString>;
|
|
98
|
+
kms_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
99
|
+
public_logs: z.ZodOptional<z.ZodBoolean>;
|
|
100
|
+
public_sysinfo: z.ZodOptional<z.ZodBoolean>;
|
|
101
|
+
gateway_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
102
|
+
tproxy_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
103
|
+
}, "strip", z.ZodTypeAny, {
|
|
104
|
+
docker_compose_file?: string | undefined;
|
|
105
|
+
pre_launch_script?: string | undefined;
|
|
106
|
+
name?: string | undefined;
|
|
107
|
+
allowed_envs?: string[] | undefined;
|
|
108
|
+
kms_enabled?: boolean | undefined;
|
|
109
|
+
public_logs?: boolean | undefined;
|
|
110
|
+
public_sysinfo?: boolean | undefined;
|
|
111
|
+
gateway_enabled?: boolean | undefined;
|
|
112
|
+
tproxy_enabled?: boolean | undefined;
|
|
113
|
+
}, {
|
|
114
|
+
docker_compose_file?: string | undefined;
|
|
115
|
+
pre_launch_script?: string | undefined;
|
|
116
|
+
name?: string | undefined;
|
|
117
|
+
allowed_envs?: string[] | undefined;
|
|
118
|
+
kms_enabled?: boolean | undefined;
|
|
119
|
+
public_logs?: boolean | undefined;
|
|
120
|
+
public_sysinfo?: boolean | undefined;
|
|
121
|
+
gateway_enabled?: boolean | undefined;
|
|
122
|
+
tproxy_enabled?: boolean | undefined;
|
|
123
|
+
}>;
|
|
124
|
+
listed: z.ZodOptional<z.ZodBoolean>;
|
|
125
|
+
instance_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
126
|
+
kms_id: z.ZodOptional<z.ZodString>;
|
|
127
|
+
env_keys: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
128
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
129
|
+
node_id: z.ZodOptional<z.ZodNumber>;
|
|
130
|
+
teepod_id: z.ZodOptional<z.ZodNumber>;
|
|
131
|
+
name: z.ZodString;
|
|
132
|
+
image: z.ZodString;
|
|
133
|
+
vcpu: z.ZodNumber;
|
|
134
|
+
memory: z.ZodNumber;
|
|
135
|
+
disk_size: z.ZodNumber;
|
|
136
|
+
compose_file: z.ZodObject<{
|
|
137
|
+
allowed_envs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
138
|
+
pre_launch_script: z.ZodOptional<z.ZodString>;
|
|
139
|
+
docker_compose_file: z.ZodOptional<z.ZodString>;
|
|
140
|
+
name: z.ZodOptional<z.ZodString>;
|
|
141
|
+
kms_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
142
|
+
public_logs: z.ZodOptional<z.ZodBoolean>;
|
|
143
|
+
public_sysinfo: z.ZodOptional<z.ZodBoolean>;
|
|
144
|
+
gateway_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
145
|
+
tproxy_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
146
|
+
}, "strip", z.ZodTypeAny, {
|
|
147
|
+
docker_compose_file?: string | undefined;
|
|
148
|
+
pre_launch_script?: string | undefined;
|
|
149
|
+
name?: string | undefined;
|
|
150
|
+
allowed_envs?: string[] | undefined;
|
|
151
|
+
kms_enabled?: boolean | undefined;
|
|
152
|
+
public_logs?: boolean | undefined;
|
|
153
|
+
public_sysinfo?: boolean | undefined;
|
|
154
|
+
gateway_enabled?: boolean | undefined;
|
|
155
|
+
tproxy_enabled?: boolean | undefined;
|
|
156
|
+
}, {
|
|
157
|
+
docker_compose_file?: string | undefined;
|
|
158
|
+
pre_launch_script?: string | undefined;
|
|
159
|
+
name?: string | undefined;
|
|
160
|
+
allowed_envs?: string[] | undefined;
|
|
161
|
+
kms_enabled?: boolean | undefined;
|
|
162
|
+
public_logs?: boolean | undefined;
|
|
163
|
+
public_sysinfo?: boolean | undefined;
|
|
164
|
+
gateway_enabled?: boolean | undefined;
|
|
165
|
+
tproxy_enabled?: boolean | undefined;
|
|
166
|
+
}>;
|
|
167
|
+
listed: z.ZodOptional<z.ZodBoolean>;
|
|
168
|
+
instance_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
169
|
+
kms_id: z.ZodOptional<z.ZodString>;
|
|
170
|
+
env_keys: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
171
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
172
|
+
node_id: z.ZodOptional<z.ZodNumber>;
|
|
173
|
+
teepod_id: z.ZodOptional<z.ZodNumber>;
|
|
174
|
+
name: z.ZodString;
|
|
175
|
+
image: z.ZodString;
|
|
176
|
+
vcpu: z.ZodNumber;
|
|
177
|
+
memory: z.ZodNumber;
|
|
178
|
+
disk_size: z.ZodNumber;
|
|
179
|
+
compose_file: z.ZodObject<{
|
|
180
|
+
allowed_envs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
181
|
+
pre_launch_script: z.ZodOptional<z.ZodString>;
|
|
182
|
+
docker_compose_file: z.ZodOptional<z.ZodString>;
|
|
183
|
+
name: z.ZodOptional<z.ZodString>;
|
|
184
|
+
kms_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
185
|
+
public_logs: z.ZodOptional<z.ZodBoolean>;
|
|
186
|
+
public_sysinfo: z.ZodOptional<z.ZodBoolean>;
|
|
187
|
+
gateway_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
188
|
+
tproxy_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
189
|
+
}, "strip", z.ZodTypeAny, {
|
|
190
|
+
docker_compose_file?: string | undefined;
|
|
191
|
+
pre_launch_script?: string | undefined;
|
|
192
|
+
name?: string | undefined;
|
|
193
|
+
allowed_envs?: string[] | undefined;
|
|
194
|
+
kms_enabled?: boolean | undefined;
|
|
195
|
+
public_logs?: boolean | undefined;
|
|
196
|
+
public_sysinfo?: boolean | undefined;
|
|
197
|
+
gateway_enabled?: boolean | undefined;
|
|
198
|
+
tproxy_enabled?: boolean | undefined;
|
|
199
|
+
}, {
|
|
200
|
+
docker_compose_file?: string | undefined;
|
|
201
|
+
pre_launch_script?: string | undefined;
|
|
202
|
+
name?: string | undefined;
|
|
203
|
+
allowed_envs?: string[] | undefined;
|
|
204
|
+
kms_enabled?: boolean | undefined;
|
|
205
|
+
public_logs?: boolean | undefined;
|
|
206
|
+
public_sysinfo?: boolean | undefined;
|
|
207
|
+
gateway_enabled?: boolean | undefined;
|
|
208
|
+
tproxy_enabled?: boolean | undefined;
|
|
209
|
+
}>;
|
|
210
|
+
listed: z.ZodOptional<z.ZodBoolean>;
|
|
211
|
+
instance_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
212
|
+
kms_id: z.ZodOptional<z.ZodString>;
|
|
213
|
+
env_keys: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
214
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
215
|
+
export type ProvisionCvmRequest = z.infer<typeof ProvisionCvmRequestSchema> & {
|
|
216
|
+
node_id?: number;
|
|
217
|
+
teepod_id?: number;
|
|
218
|
+
compose_file?: {
|
|
219
|
+
gateway_enabled?: boolean;
|
|
220
|
+
tproxy_enabled?: boolean;
|
|
221
|
+
[key: string]: unknown;
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
export type ProvisionCvmParameters<T = undefined> = ActionParameters<T>;
|
|
225
|
+
export type ProvisionCvmReturnType<T = undefined> = ActionReturnType<ProvisionCvm, T>;
|
|
226
|
+
export declare function provisionCvm<T extends z.ZodSchema | false | undefined = undefined>(client: Client, appCompose: ProvisionCvmRequest, parameters?: ProvisionCvmParameters<T>): Promise<ProvisionCvmReturnType<T>>;
|
|
227
|
+
export declare function safeProvisionCvm<T extends z.ZodSchema | false | undefined = undefined>(client: Client, appCompose: ProvisionCvmRequest, parameters?: ProvisionCvmParameters<T>): Promise<SafeResult<ProvisionCvmReturnType<T>>>;
|
|
228
|
+
//# sourceMappingURL=provision_cvm.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"provision_cvm.d.ts","sourceRoot":"","sources":["../../src/actions/provision_cvm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAGH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;gCAUf,CAAC;AAEjB,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAG9D,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAyBtB,CAAC;AAEjB,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,GAAG;IAC5E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE;QACb,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAExE,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;AA8DtF,wBAAsB,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,EACtF,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,mBAAmB,EAC/B,UAAU,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAuBpC;AAGD,wBAAsB,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,EAC1F,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,mBAAmB,EAC/B,UAAU,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,GACrC,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CA4BhD"}
|
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { type Client, type SafeResult } from "../client";
|
|
3
|
+
import { ActionParameters, ActionReturnType } from "../types/common";
|
|
4
|
+
/**
|
|
5
|
+
* Provision CVM compose file update
|
|
6
|
+
*
|
|
7
|
+
* Provisions a CVM compose file update by uploading the new compose file configuration.
|
|
8
|
+
* Returns a compose_hash that must be used with `commitCvmComposeFileUpdate` to finalize the update.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```typescript
|
|
12
|
+
* import { createClient, provisionCvmComposeFileUpdate } from '@phala/cloud'
|
|
13
|
+
*
|
|
14
|
+
* const client = createClient({ apiKey: 'your-api-key' })
|
|
15
|
+
* const result = await provisionCvmComposeFileUpdate(client, {
|
|
16
|
+
* id: 'cvm-123',
|
|
17
|
+
* app_compose: {
|
|
18
|
+
* name: 'my-app',
|
|
19
|
+
* docker_compose_file: 'version: "3.8"\nservices:\n app:\n image: nginx'
|
|
20
|
+
* }
|
|
21
|
+
* })
|
|
22
|
+
* console.log(`Compose hash: ${result.compose_hash}`)
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* ## Returns
|
|
26
|
+
*
|
|
27
|
+
* `ProvisionCvmComposeFileUpdateResult | unknown`
|
|
28
|
+
*
|
|
29
|
+
* Provision response including compose_hash and metadata needed for committing the update.
|
|
30
|
+
* Return type depends on schema parameter.
|
|
31
|
+
*
|
|
32
|
+
* ## Parameters
|
|
33
|
+
*
|
|
34
|
+
* ### request (required)
|
|
35
|
+
* - **Type:** `ProvisionCvmComposeFileUpdateRequest`
|
|
36
|
+
*
|
|
37
|
+
* Request parameters containing the CVM ID and compose file configuration.
|
|
38
|
+
*
|
|
39
|
+
* ### parameters (optional)
|
|
40
|
+
* - **Type:** `ProvisionCvmComposeFileUpdateParameters`
|
|
41
|
+
*
|
|
42
|
+
* Optional behavior parameters for schema validation.
|
|
43
|
+
*
|
|
44
|
+
* ```typescript
|
|
45
|
+
* // Use default schema
|
|
46
|
+
* const result = await provisionCvmComposeFileUpdate(client, {
|
|
47
|
+
* id: 'cvm-123',
|
|
48
|
+
* app_compose: { name: 'my-app', docker_compose_file: '...' }
|
|
49
|
+
* })
|
|
50
|
+
*
|
|
51
|
+
* // Return raw data without validation
|
|
52
|
+
* const raw = await provisionCvmComposeFileUpdate(client, request, { schema: false })
|
|
53
|
+
*
|
|
54
|
+
* // Use custom schema
|
|
55
|
+
* const customSchema = z.object({ compose_hash: z.string() })
|
|
56
|
+
* const custom = await provisionCvmComposeFileUpdate(client, request, { schema: customSchema })
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* ## Safe Version
|
|
60
|
+
*
|
|
61
|
+
* Use `safeProvisionCvmComposeFileUpdate` for error handling without exceptions:
|
|
62
|
+
*
|
|
63
|
+
* ```typescript
|
|
64
|
+
* import { safeProvisionCvmComposeFileUpdate } from '@phala/cloud'
|
|
65
|
+
*
|
|
66
|
+
* const result = await safeProvisionCvmComposeFileUpdate(client, {
|
|
67
|
+
* id: 'cvm-123',
|
|
68
|
+
* app_compose: { name: 'my-app', docker_compose_file: '...' }
|
|
69
|
+
* })
|
|
70
|
+
* if (result.success) {
|
|
71
|
+
* console.log(`Compose hash: ${result.data.compose_hash}`)
|
|
72
|
+
* } else {
|
|
73
|
+
* if ("isRequestError" in result.error) {
|
|
74
|
+
* console.error(`HTTP ${result.error.status}: ${result.error.message}`)
|
|
75
|
+
* } else {
|
|
76
|
+
* console.error(`Validation error: ${result.error.issues}`)
|
|
77
|
+
* }
|
|
78
|
+
* }
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
export declare const ProvisionCvmComposeFileUpdateRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
|
|
82
|
+
id: z.ZodOptional<z.ZodString>;
|
|
83
|
+
uuid: z.ZodOptional<z.ZodString>;
|
|
84
|
+
app_id: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>>;
|
|
85
|
+
instance_id: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>>;
|
|
86
|
+
app_compose: z.ZodObject<{
|
|
87
|
+
allowed_envs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
88
|
+
docker_compose_file: z.ZodString;
|
|
89
|
+
name: z.ZodString;
|
|
90
|
+
kms_enabled: z.ZodOptional<z.ZodBoolean>;
|
|
91
|
+
public_logs: z.ZodOptional<z.ZodBoolean>;
|
|
92
|
+
public_sysinfo: z.ZodOptional<z.ZodBoolean>;
|
|
93
|
+
pre_launch_script: z.ZodOptional<z.ZodString>;
|
|
94
|
+
}, "strip", z.ZodTypeAny, {
|
|
95
|
+
docker_compose_file: string;
|
|
96
|
+
name: string;
|
|
97
|
+
pre_launch_script?: string | undefined;
|
|
98
|
+
allowed_envs?: string[] | undefined;
|
|
99
|
+
kms_enabled?: boolean | undefined;
|
|
100
|
+
public_logs?: boolean | undefined;
|
|
101
|
+
public_sysinfo?: boolean | undefined;
|
|
102
|
+
}, {
|
|
103
|
+
docker_compose_file: string;
|
|
104
|
+
name: string;
|
|
105
|
+
pre_launch_script?: string | undefined;
|
|
106
|
+
allowed_envs?: string[] | undefined;
|
|
107
|
+
kms_enabled?: boolean | undefined;
|
|
108
|
+
public_logs?: boolean | undefined;
|
|
109
|
+
public_sysinfo?: boolean | undefined;
|
|
110
|
+
}>;
|
|
111
|
+
}, "strip", z.ZodTypeAny, {
|
|
112
|
+
app_compose: {
|
|
113
|
+
docker_compose_file: string;
|
|
114
|
+
name: string;
|
|
115
|
+
pre_launch_script?: string | undefined;
|
|
116
|
+
allowed_envs?: string[] | undefined;
|
|
117
|
+
kms_enabled?: boolean | undefined;
|
|
118
|
+
public_logs?: boolean | undefined;
|
|
119
|
+
public_sysinfo?: boolean | undefined;
|
|
120
|
+
};
|
|
121
|
+
id?: string | undefined;
|
|
122
|
+
app_id?: string | undefined;
|
|
123
|
+
instance_id?: string | undefined;
|
|
124
|
+
uuid?: string | undefined;
|
|
125
|
+
}, {
|
|
126
|
+
app_compose: {
|
|
127
|
+
docker_compose_file: string;
|
|
128
|
+
name: string;
|
|
129
|
+
pre_launch_script?: string | undefined;
|
|
130
|
+
allowed_envs?: string[] | undefined;
|
|
131
|
+
kms_enabled?: boolean | undefined;
|
|
132
|
+
public_logs?: boolean | undefined;
|
|
133
|
+
public_sysinfo?: boolean | undefined;
|
|
134
|
+
};
|
|
135
|
+
id?: string | undefined;
|
|
136
|
+
app_id?: string | undefined;
|
|
137
|
+
instance_id?: string | undefined;
|
|
138
|
+
uuid?: string | undefined;
|
|
139
|
+
}>, {
|
|
140
|
+
app_compose: {
|
|
141
|
+
docker_compose_file: string;
|
|
142
|
+
name: string;
|
|
143
|
+
pre_launch_script?: string | undefined;
|
|
144
|
+
allowed_envs?: string[] | undefined;
|
|
145
|
+
kms_enabled?: boolean | undefined;
|
|
146
|
+
public_logs?: boolean | undefined;
|
|
147
|
+
public_sysinfo?: boolean | undefined;
|
|
148
|
+
};
|
|
149
|
+
id?: string | undefined;
|
|
150
|
+
app_id?: string | undefined;
|
|
151
|
+
instance_id?: string | undefined;
|
|
152
|
+
uuid?: string | undefined;
|
|
153
|
+
}, {
|
|
154
|
+
app_compose: {
|
|
155
|
+
docker_compose_file: string;
|
|
156
|
+
name: string;
|
|
157
|
+
pre_launch_script?: string | undefined;
|
|
158
|
+
allowed_envs?: string[] | undefined;
|
|
159
|
+
kms_enabled?: boolean | undefined;
|
|
160
|
+
public_logs?: boolean | undefined;
|
|
161
|
+
public_sysinfo?: boolean | undefined;
|
|
162
|
+
};
|
|
163
|
+
id?: string | undefined;
|
|
164
|
+
app_id?: string | undefined;
|
|
165
|
+
instance_id?: string | undefined;
|
|
166
|
+
uuid?: string | undefined;
|
|
167
|
+
}>, {
|
|
168
|
+
cvmId: string | undefined;
|
|
169
|
+
request: {
|
|
170
|
+
docker_compose_file: string;
|
|
171
|
+
name: string;
|
|
172
|
+
pre_launch_script?: string | undefined;
|
|
173
|
+
allowed_envs?: string[] | undefined;
|
|
174
|
+
kms_enabled?: boolean | undefined;
|
|
175
|
+
public_logs?: boolean | undefined;
|
|
176
|
+
public_sysinfo?: boolean | undefined;
|
|
177
|
+
};
|
|
178
|
+
_raw: {
|
|
179
|
+
app_compose: {
|
|
180
|
+
docker_compose_file: string;
|
|
181
|
+
name: string;
|
|
182
|
+
pre_launch_script?: string | undefined;
|
|
183
|
+
allowed_envs?: string[] | undefined;
|
|
184
|
+
kms_enabled?: boolean | undefined;
|
|
185
|
+
public_logs?: boolean | undefined;
|
|
186
|
+
public_sysinfo?: boolean | undefined;
|
|
187
|
+
};
|
|
188
|
+
id?: string | undefined;
|
|
189
|
+
app_id?: string | undefined;
|
|
190
|
+
instance_id?: string | undefined;
|
|
191
|
+
uuid?: string | undefined;
|
|
192
|
+
};
|
|
193
|
+
}, {
|
|
194
|
+
app_compose: {
|
|
195
|
+
docker_compose_file: string;
|
|
196
|
+
name: string;
|
|
197
|
+
pre_launch_script?: string | undefined;
|
|
198
|
+
allowed_envs?: string[] | undefined;
|
|
199
|
+
kms_enabled?: boolean | undefined;
|
|
200
|
+
public_logs?: boolean | undefined;
|
|
201
|
+
public_sysinfo?: boolean | undefined;
|
|
202
|
+
};
|
|
203
|
+
id?: string | undefined;
|
|
204
|
+
app_id?: string | undefined;
|
|
205
|
+
instance_id?: string | undefined;
|
|
206
|
+
uuid?: string | undefined;
|
|
207
|
+
}>;
|
|
208
|
+
export declare const ProvisionCvmComposeFileUpdateResultSchema: z.ZodObject<{
|
|
209
|
+
app_id: z.ZodNullable<z.ZodString>;
|
|
210
|
+
device_id: z.ZodNullable<z.ZodString>;
|
|
211
|
+
compose_hash: z.ZodString;
|
|
212
|
+
kms_info: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
213
|
+
id: z.ZodString;
|
|
214
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
215
|
+
url: z.ZodString;
|
|
216
|
+
version: z.ZodString;
|
|
217
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
218
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
219
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
220
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
221
|
+
id: z.ZodString;
|
|
222
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
223
|
+
url: z.ZodString;
|
|
224
|
+
version: z.ZodString;
|
|
225
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
226
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
227
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
228
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
229
|
+
id: z.ZodString;
|
|
230
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
231
|
+
url: z.ZodString;
|
|
232
|
+
version: z.ZodString;
|
|
233
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
234
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
235
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
236
|
+
}, z.ZodTypeAny, "passthrough">>>>;
|
|
237
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
238
|
+
app_id: z.ZodNullable<z.ZodString>;
|
|
239
|
+
device_id: z.ZodNullable<z.ZodString>;
|
|
240
|
+
compose_hash: z.ZodString;
|
|
241
|
+
kms_info: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
242
|
+
id: z.ZodString;
|
|
243
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
244
|
+
url: z.ZodString;
|
|
245
|
+
version: z.ZodString;
|
|
246
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
247
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
248
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
249
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
250
|
+
id: z.ZodString;
|
|
251
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
252
|
+
url: z.ZodString;
|
|
253
|
+
version: z.ZodString;
|
|
254
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
255
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
256
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
257
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
258
|
+
id: z.ZodString;
|
|
259
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
260
|
+
url: z.ZodString;
|
|
261
|
+
version: z.ZodString;
|
|
262
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
263
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
264
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
265
|
+
}, z.ZodTypeAny, "passthrough">>>>;
|
|
266
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
267
|
+
app_id: z.ZodNullable<z.ZodString>;
|
|
268
|
+
device_id: z.ZodNullable<z.ZodString>;
|
|
269
|
+
compose_hash: z.ZodString;
|
|
270
|
+
kms_info: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
271
|
+
id: z.ZodString;
|
|
272
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
273
|
+
url: z.ZodString;
|
|
274
|
+
version: z.ZodString;
|
|
275
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
276
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
277
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
278
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
279
|
+
id: z.ZodString;
|
|
280
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
281
|
+
url: z.ZodString;
|
|
282
|
+
version: z.ZodString;
|
|
283
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
284
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
285
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
286
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
287
|
+
id: z.ZodString;
|
|
288
|
+
slug: z.ZodNullable<z.ZodString>;
|
|
289
|
+
url: z.ZodString;
|
|
290
|
+
version: z.ZodString;
|
|
291
|
+
chain_id: z.ZodNullable<z.ZodNumber>;
|
|
292
|
+
kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
293
|
+
gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
|
|
294
|
+
}, z.ZodTypeAny, "passthrough">>>>;
|
|
295
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
296
|
+
export type ProvisionCvmComposeFileUpdateRequest = z.input<typeof ProvisionCvmComposeFileUpdateRequestSchema>;
|
|
297
|
+
export type ProvisionCvmComposeFileUpdateResult = z.infer<typeof ProvisionCvmComposeFileUpdateResultSchema>;
|
|
298
|
+
export type ProvisionCvmComposeFileUpdateParameters<T = undefined> = ActionParameters<T>;
|
|
299
|
+
export type ProvisionCvmComposeFileUpdateReturnType<T = undefined> = ActionReturnType<ProvisionCvmComposeFileUpdateResult, T>;
|
|
300
|
+
/**
|
|
301
|
+
* Provision a CVM compose file update
|
|
302
|
+
*
|
|
303
|
+
* @param client - The API client
|
|
304
|
+
* @param request - Request parameters containing CVM ID and compose file configuration
|
|
305
|
+
* @param parameters - Optional behavior parameters
|
|
306
|
+
* @returns Update provision result
|
|
307
|
+
*/
|
|
308
|
+
export declare function provisionCvmComposeFileUpdate<T extends z.ZodSchema | false | undefined = undefined>(client: Client, request: ProvisionCvmComposeFileUpdateRequest, parameters?: ProvisionCvmComposeFileUpdateParameters<T>): Promise<ProvisionCvmComposeFileUpdateReturnType<T>>;
|
|
309
|
+
/**
|
|
310
|
+
* Safe version of provisionCvmComposeFileUpdate that returns a Result type instead of throwing
|
|
311
|
+
*/
|
|
312
|
+
export declare function safeProvisionCvmComposeFileUpdate<T extends z.ZodSchema | false | undefined = undefined>(client: Client, request: ProvisionCvmComposeFileUpdateRequest, parameters?: ProvisionCvmComposeFileUpdateParameters<T>): Promise<SafeResult<ProvisionCvmComposeFileUpdateReturnType<T>>>;
|
|
313
|
+
//# sourceMappingURL=provision_cvm_compose_file_update.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"provision_cvm_compose_file_update.d.ts","sourceRoot":"","sources":["../../src/actions/provision_cvm_compose_file_update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AAEH,eAAO,MAAM,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyClD,CAAC;AAEN,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAOtC,CAAC;AAEjB,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,0CAA0C,CAClD,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,yCAAyC,CACjD,CAAC;AAEF,MAAM,MAAM,uCAAuC,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC;AACzF,MAAM,MAAM,uCAAuC,CAAC,CAAC,GAAG,SAAS,IAAI,gBAAgB,CACnF,mCAAmC,EACnC,CAAC,CACF,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,6BAA6B,CACjD,CAAC,SAAS,CAAC,CAAC,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,EAErD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,oCAAoC,EAC7C,UAAU,CAAC,EAAE,uCAAuC,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,uCAAuC,CAAC,CAAC,CAAC,CAAC,CAcrD;AAED;;GAEG;AACH,wBAAsB,iCAAiC,CACrD,CAAC,SAAS,CAAC,CAAC,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,EAErD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,oCAAoC,EAC7C,UAAU,CAAC,EAAE,uCAAuC,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,UAAU,CAAC,uCAAuC,CAAC,CAAC,CAAC,CAAC,CAAC,CAwBjE"}
|
package/dist/client.d.ts
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { ofetch, type FetchOptions, type FetchRequest } from "ofetch";
|
|
2
|
+
import { type SafeResult, RequestError, type ClientConfig } from "./types/client";
|
|
3
|
+
export type { SafeResult } from "./types/client";
|
|
4
|
+
/**
|
|
5
|
+
* HTTP Client class with ofetch compatibility
|
|
6
|
+
*/
|
|
7
|
+
export declare class Client {
|
|
8
|
+
protected fetchInstance: typeof ofetch;
|
|
9
|
+
readonly config: ClientConfig;
|
|
10
|
+
constructor(config?: ClientConfig);
|
|
11
|
+
/**
|
|
12
|
+
* Get the underlying ofetch instance for advanced usage
|
|
13
|
+
*/
|
|
14
|
+
get raw(): import("ofetch").$Fetch;
|
|
15
|
+
/**
|
|
16
|
+
* Perform GET request (throws on error)
|
|
17
|
+
*/
|
|
18
|
+
get<T = unknown>(request: FetchRequest, options?: Omit<FetchOptions, "method">): Promise<T>;
|
|
19
|
+
/**
|
|
20
|
+
* Perform POST request (throws on error)
|
|
21
|
+
*/
|
|
22
|
+
post<T = unknown>(request: FetchRequest, body?: RequestInit["body"] | Record<string, unknown>, options?: Omit<FetchOptions, "method" | "body">): Promise<T>;
|
|
23
|
+
/**
|
|
24
|
+
* Perform PUT request (throws on error)
|
|
25
|
+
*/
|
|
26
|
+
put<T = unknown>(request: FetchRequest, body?: RequestInit["body"] | Record<string, unknown>, options?: Omit<FetchOptions, "method" | "body">): Promise<T>;
|
|
27
|
+
/**
|
|
28
|
+
* Perform PATCH request (throws on error)
|
|
29
|
+
*/
|
|
30
|
+
patch<T = unknown>(request: FetchRequest, body?: RequestInit["body"] | Record<string, unknown>, options?: Omit<FetchOptions, "method" | "body">): Promise<T>;
|
|
31
|
+
/**
|
|
32
|
+
* Perform DELETE request (throws on error)
|
|
33
|
+
*/
|
|
34
|
+
delete<T = unknown>(request: FetchRequest, options?: Omit<FetchOptions, "method">): Promise<T>;
|
|
35
|
+
/**
|
|
36
|
+
* Safe wrapper for any request method (zod-style result)
|
|
37
|
+
*/
|
|
38
|
+
private safeRequest;
|
|
39
|
+
/**
|
|
40
|
+
* Safe GET request (returns SafeResult)
|
|
41
|
+
*/
|
|
42
|
+
safeGet<T = unknown>(request: FetchRequest, options?: Omit<FetchOptions, "method">): Promise<SafeResult<T, RequestError>>;
|
|
43
|
+
/**
|
|
44
|
+
* Safe POST request (returns SafeResult)
|
|
45
|
+
*/
|
|
46
|
+
safePost<T = unknown>(request: FetchRequest, body?: RequestInit["body"] | Record<string, unknown>, options?: Omit<FetchOptions, "method" | "body">): Promise<SafeResult<T, RequestError>>;
|
|
47
|
+
/**
|
|
48
|
+
* Safe PUT request (returns SafeResult)
|
|
49
|
+
*/
|
|
50
|
+
safePut<T = unknown>(request: FetchRequest, body?: RequestInit["body"] | Record<string, unknown>, options?: Omit<FetchOptions, "method" | "body">): Promise<SafeResult<T, RequestError>>;
|
|
51
|
+
/**
|
|
52
|
+
* Safe PATCH request (returns SafeResult)
|
|
53
|
+
*/
|
|
54
|
+
safePatch<T = unknown>(request: FetchRequest, body?: RequestInit["body"] | Record<string, unknown>, options?: Omit<FetchOptions, "method" | "body">): Promise<SafeResult<T, RequestError>>;
|
|
55
|
+
/**
|
|
56
|
+
* Safe DELETE request (returns SafeResult)
|
|
57
|
+
*/
|
|
58
|
+
safeDelete<T = unknown>(request: FetchRequest, options?: Omit<FetchOptions, "method">): Promise<SafeResult<T, RequestError>>;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Create a new HTTP client instance
|
|
62
|
+
*
|
|
63
|
+
* Configuration can be provided via parameters or environment variables:
|
|
64
|
+
* - PHALA_CLOUD_API_KEY: API key for authentication
|
|
65
|
+
* - PHALA_CLOUD_API_PREFIX: Base URL prefix for the API
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```typescript
|
|
69
|
+
* // Using explicit configuration
|
|
70
|
+
* const client = createClient({
|
|
71
|
+
* apiKey: 'your-api-key',
|
|
72
|
+
* baseURL: 'https://custom-api.example.com'
|
|
73
|
+
* })
|
|
74
|
+
*
|
|
75
|
+
* // Using environment variables (set PHALA_CLOUD_API_KEY)
|
|
76
|
+
* const client = createClient()
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
export declare function createClient(config?: ClientConfig): Client;
|
|
80
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,KAAK,YAAY,EAAc,MAAM,QAAQ,CAAC;AAClF,OAAO,EAAE,KAAK,UAAU,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAClF,YAAY,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAIjD;;GAEG;AACH,qBAAa,MAAM;IACjB,SAAS,CAAC,aAAa,EAAE,OAAO,MAAM,CAAC;IACvC,SAAgB,MAAM,EAAE,YAAY,CAAC;gBAEzB,MAAM,GAAE,YAAiB;IA8CrC;;OAEG;IACH,IAAI,GAAG,4BAEN;IAID;;OAEG;IACG,GAAG,CAAC,CAAC,GAAG,OAAO,EACnB,OAAO,EAAE,YAAY,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GACrC,OAAO,CAAC,CAAC,CAAC;IAQb;;OAEG;IACG,IAAI,CAAC,CAAC,GAAG,OAAO,EACpB,OAAO,EAAE,YAAY,EACrB,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,CAAC,GAC9C,OAAO,CAAC,CAAC,CAAC;IASb;;OAEG;IACG,GAAG,CAAC,CAAC,GAAG,OAAO,EACnB,OAAO,EAAE,YAAY,EACrB,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,CAAC,GAC9C,OAAO,CAAC,CAAC,CAAC;IASb;;OAEG;IACG,KAAK,CAAC,CAAC,GAAG,OAAO,EACrB,OAAO,EAAE,YAAY,EACrB,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,CAAC,GAC9C,OAAO,CAAC,CAAC,CAAC;IASb;;OAEG;IACG,MAAM,CAAC,CAAC,GAAG,OAAO,EACtB,OAAO,EAAE,YAAY,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GACrC,OAAO,CAAC,CAAC,CAAC;IAUb;;OAEG;YACW,WAAW;IAoBzB;;OAEG;IACG,OAAO,CAAC,CAAC,GAAG,OAAO,EACvB,OAAO,EAAE,YAAY,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GACrC,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAIvC;;OAEG;IACG,QAAQ,CAAC,CAAC,GAAG,OAAO,EACxB,OAAO,EAAE,YAAY,EACrB,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,CAAC,GAC9C,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAIvC;;OAEG;IACG,OAAO,CAAC,CAAC,GAAG,OAAO,EACvB,OAAO,EAAE,YAAY,EACrB,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,CAAC,GAC9C,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAIvC;;OAEG;IACG,SAAS,CAAC,CAAC,GAAG,OAAO,EACzB,OAAO,EAAE,YAAY,EACrB,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,CAAC,GAC9C,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAIvC;;OAEG;IACG,UAAU,CAAC,CAAC,GAAG,OAAO,EAC1B,OAAO,EAAE,YAAY,EACrB,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GACrC,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;CAGxC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,CAAC,MAAM,GAAE,YAAiB,GAAG,MAAM,CAE9D"}
|