@vercel/sandbox 2.0.0-beta.11 → 2.0.0-beta.13

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.
Files changed (196) hide show
  1. package/README.md +8 -0
  2. package/dist/_virtual/rolldown_runtime.cjs +29 -0
  3. package/dist/api-client/api-client.cjs +456 -0
  4. package/dist/api-client/api-client.cjs.map +1 -0
  5. package/dist/api-client/api-client.d.cts +790 -0
  6. package/dist/api-client/api-client.d.ts +784 -777
  7. package/dist/api-client/api-client.js +445 -471
  8. package/dist/api-client/api-client.js.map +1 -1
  9. package/dist/api-client/api-error.cjs +32 -0
  10. package/dist/api-client/api-error.cjs.map +1 -0
  11. package/dist/api-client/api-error.d.cts +29 -0
  12. package/dist/api-client/api-error.d.ts +21 -18
  13. package/dist/api-client/api-error.js +28 -33
  14. package/dist/api-client/api-error.js.map +1 -1
  15. package/dist/api-client/base-client.cjs +125 -0
  16. package/dist/api-client/base-client.cjs.map +1 -0
  17. package/dist/api-client/base-client.d.cts +38 -0
  18. package/dist/api-client/base-client.d.ts +31 -36
  19. package/dist/api-client/base-client.js +110 -130
  20. package/dist/api-client/base-client.js.map +1 -1
  21. package/dist/api-client/file-writer.cjs +62 -0
  22. package/dist/api-client/file-writer.cjs.map +1 -0
  23. package/dist/api-client/file-writer.d.cts +66 -0
  24. package/dist/api-client/file-writer.d.ts +56 -52
  25. package/dist/api-client/file-writer.js +57 -61
  26. package/dist/api-client/file-writer.js.map +1 -1
  27. package/dist/api-client/index.cjs +2 -0
  28. package/dist/api-client/index.d.ts +2 -2
  29. package/dist/api-client/index.js +4 -21
  30. package/dist/api-client/validators.cjs +182 -0
  31. package/dist/api-client/validators.cjs.map +1 -0
  32. package/dist/api-client/validators.d.cts +1469 -0
  33. package/dist/api-client/validators.d.ts +1282 -3699
  34. package/dist/api-client/validators.js +155 -170
  35. package/dist/api-client/validators.js.map +1 -1
  36. package/dist/api-client/with-retry.cjs +89 -0
  37. package/dist/api-client/with-retry.cjs.map +1 -0
  38. package/dist/api-client/with-retry.d.cts +10 -0
  39. package/dist/api-client/with-retry.d.ts +9 -13
  40. package/dist/api-client/with-retry.js +81 -102
  41. package/dist/api-client/with-retry.js.map +1 -1
  42. package/dist/auth/api.cjs +29 -0
  43. package/dist/auth/api.cjs.map +1 -0
  44. package/dist/auth/api.js +26 -25
  45. package/dist/auth/api.js.map +1 -1
  46. package/dist/auth/error.cjs +13 -0
  47. package/dist/auth/error.cjs.map +1 -0
  48. package/dist/auth/error.js +11 -11
  49. package/dist/auth/error.js.map +1 -1
  50. package/dist/auth/file.cjs +64 -0
  51. package/dist/auth/file.cjs.map +1 -0
  52. package/dist/auth/file.d.cts +26 -0
  53. package/dist/auth/file.d.ts +19 -15
  54. package/dist/auth/file.js +49 -64
  55. package/dist/auth/file.js.map +1 -1
  56. package/dist/auth/index.cjs +12 -0
  57. package/dist/auth/index.d.cts +5 -0
  58. package/dist/auth/index.d.ts +5 -6
  59. package/dist/auth/index.js +6 -27
  60. package/dist/auth/linked-project.cjs +38 -0
  61. package/dist/auth/linked-project.cjs.map +1 -0
  62. package/dist/auth/linked-project.js +30 -64
  63. package/dist/auth/linked-project.js.map +1 -1
  64. package/dist/auth/oauth.cjs +205 -0
  65. package/dist/auth/oauth.cjs.map +1 -0
  66. package/dist/auth/oauth.d.cts +135 -0
  67. package/dist/auth/oauth.d.ts +113 -109
  68. package/dist/auth/oauth.js +185 -252
  69. package/dist/auth/oauth.js.map +1 -1
  70. package/dist/auth/poll-for-token.cjs +82 -0
  71. package/dist/auth/poll-for-token.cjs.map +1 -0
  72. package/dist/auth/poll-for-token.d.cts +28 -0
  73. package/dist/auth/poll-for-token.d.ts +23 -15
  74. package/dist/auth/poll-for-token.js +79 -64
  75. package/dist/auth/poll-for-token.js.map +1 -1
  76. package/dist/auth/project.cjs +80 -0
  77. package/dist/auth/project.cjs.map +1 -0
  78. package/dist/auth/project.d.cts +44 -0
  79. package/dist/auth/project.d.ts +12 -8
  80. package/dist/auth/project.js +70 -72
  81. package/dist/auth/project.js.map +1 -1
  82. package/dist/auth/zod.cjs +22 -0
  83. package/dist/auth/zod.cjs.map +1 -0
  84. package/dist/auth/zod.js +18 -17
  85. package/dist/auth/zod.js.map +1 -1
  86. package/dist/command.cjs +328 -0
  87. package/dist/command.cjs.map +1 -0
  88. package/dist/command.d.cts +289 -0
  89. package/dist/command.d.ts +265 -171
  90. package/dist/command.js +323 -226
  91. package/dist/command.js.map +1 -1
  92. package/dist/constants.d.cts +5 -0
  93. package/dist/constants.d.ts +5 -1
  94. package/dist/index.cjs +13 -0
  95. package/dist/index.d.cts +7 -0
  96. package/dist/index.d.ts +7 -6
  97. package/dist/index.js +7 -17
  98. package/dist/network-policy.d.cts +100 -0
  99. package/dist/network-policy.d.ts +32 -28
  100. package/dist/sandbox.cjs +694 -0
  101. package/dist/sandbox.cjs.map +1 -0
  102. package/dist/sandbox.d.cts +796 -0
  103. package/dist/sandbox.d.ts +783 -711
  104. package/dist/sandbox.js +684 -615
  105. package/dist/sandbox.js.map +1 -1
  106. package/dist/session.cjs +520 -0
  107. package/dist/session.cjs.map +1 -0
  108. package/dist/session.d.cts +406 -0
  109. package/dist/session.d.ts +398 -367
  110. package/dist/session.js +517 -505
  111. package/dist/session.js.map +1 -1
  112. package/dist/snapshot.cjs +116 -0
  113. package/dist/snapshot.cjs.map +1 -0
  114. package/dist/snapshot.d.cts +107 -0
  115. package/dist/snapshot.d.ts +98 -91
  116. package/dist/snapshot.js +114 -115
  117. package/dist/snapshot.js.map +1 -1
  118. package/dist/utils/array.cjs +17 -0
  119. package/dist/utils/array.cjs.map +1 -0
  120. package/dist/utils/array.js +12 -15
  121. package/dist/utils/array.js.map +1 -1
  122. package/dist/utils/consume-readable.cjs +18 -0
  123. package/dist/utils/consume-readable.cjs.map +1 -0
  124. package/dist/utils/consume-readable.js +13 -12
  125. package/dist/utils/consume-readable.js.map +1 -1
  126. package/dist/utils/decode-base64-url.cjs +15 -0
  127. package/dist/utils/decode-base64-url.cjs.map +1 -0
  128. package/dist/utils/decode-base64-url.js +10 -9
  129. package/dist/utils/decode-base64-url.js.map +1 -1
  130. package/dist/utils/dev-credentials.cjs +142 -0
  131. package/dist/utils/dev-credentials.cjs.map +1 -0
  132. package/dist/utils/dev-credentials.js +126 -184
  133. package/dist/utils/dev-credentials.js.map +1 -1
  134. package/dist/utils/get-credentials.cjs +123 -0
  135. package/dist/utils/get-credentials.cjs.map +1 -0
  136. package/dist/utils/get-credentials.d.cts +21 -0
  137. package/dist/utils/get-credentials.d.ts +19 -61
  138. package/dist/utils/get-credentials.js +106 -140
  139. package/dist/utils/get-credentials.js.map +1 -1
  140. package/dist/utils/log.cjs +25 -0
  141. package/dist/utils/log.cjs.map +1 -0
  142. package/dist/utils/log.js +15 -17
  143. package/dist/utils/log.js.map +1 -1
  144. package/dist/utils/network-policy.cjs +65 -0
  145. package/dist/utils/network-policy.cjs.map +1 -0
  146. package/dist/utils/network-policy.js +58 -77
  147. package/dist/utils/network-policy.js.map +1 -1
  148. package/dist/utils/normalizePath.cjs +27 -0
  149. package/dist/utils/normalizePath.cjs.map +1 -0
  150. package/dist/utils/normalizePath.js +21 -28
  151. package/dist/utils/normalizePath.js.map +1 -1
  152. package/dist/utils/resolveSignal.cjs +20 -0
  153. package/dist/utils/resolveSignal.cjs.map +1 -0
  154. package/dist/utils/resolveSignal.d.cts +15 -0
  155. package/dist/utils/resolveSignal.d.ts +12 -10
  156. package/dist/utils/resolveSignal.js +14 -17
  157. package/dist/utils/resolveSignal.js.map +1 -1
  158. package/dist/utils/sandbox-snapshot.cjs +14 -0
  159. package/dist/utils/sandbox-snapshot.cjs.map +1 -0
  160. package/dist/utils/sandbox-snapshot.d.cts +10 -0
  161. package/dist/utils/sandbox-snapshot.d.ts +11 -0
  162. package/dist/utils/sandbox-snapshot.js +14 -0
  163. package/dist/utils/sandbox-snapshot.js.map +1 -0
  164. package/dist/utils/types.cjs +13 -0
  165. package/dist/utils/types.cjs.map +1 -0
  166. package/dist/utils/types.d.cts +11 -0
  167. package/dist/utils/types.d.ts +5 -7
  168. package/dist/utils/types.js +8 -8
  169. package/dist/utils/types.js.map +1 -1
  170. package/dist/version.cjs +7 -0
  171. package/dist/version.cjs.map +1 -0
  172. package/dist/version.js +5 -5
  173. package/dist/version.js.map +1 -1
  174. package/package.json +23 -3
  175. package/dist/api-client/index.js.map +0 -1
  176. package/dist/auth/api.d.ts +0 -6
  177. package/dist/auth/error.d.ts +0 -11
  178. package/dist/auth/index.js.map +0 -1
  179. package/dist/auth/linked-project.d.ts +0 -10
  180. package/dist/auth/zod.d.ts +0 -5
  181. package/dist/constants.js +0 -3
  182. package/dist/constants.js.map +0 -1
  183. package/dist/index.js.map +0 -1
  184. package/dist/network-policy.js +0 -3
  185. package/dist/network-policy.js.map +0 -1
  186. package/dist/utils/array.d.ts +0 -9
  187. package/dist/utils/consume-readable.d.ts +0 -5
  188. package/dist/utils/convert-sandbox.d.ts +0 -6
  189. package/dist/utils/convert-sandbox.js +0 -14
  190. package/dist/utils/convert-sandbox.js.map +0 -1
  191. package/dist/utils/decode-base64-url.d.ts +0 -7
  192. package/dist/utils/dev-credentials.d.ts +0 -37
  193. package/dist/utils/log.d.ts +0 -2
  194. package/dist/utils/network-policy.d.ts +0 -7
  195. package/dist/utils/normalizePath.d.ts +0 -17
  196. package/dist/version.d.ts +0 -1
@@ -0,0 +1,790 @@
1
+ import { BaseClient, Parsed, RequestParams } from "./base-client.cjs";
2
+ import { CommandData, CommandFinishedData, CommandFinishedResponse, CommandResponse, CreateSnapshotResponse, LogLineStderr, LogLineStdout, SessionResponse, SnapshotResponse } from "./validators.cjs";
3
+ import { FileWriter } from "./file-writer.cjs";
4
+ import { NetworkPolicy } from "../network-policy.cjs";
5
+ import { WithPrivate } from "../utils/types.cjs";
6
+ import { RUNTIMES } from "../constants.cjs";
7
+ import { z } from "zod";
8
+ import { Readable } from "stream";
9
+
10
+ //#region src/api-client/api-client.d.ts
11
+ interface WithFetchOptions {
12
+ fetch?: typeof globalThis.fetch;
13
+ }
14
+ declare class APIClient extends BaseClient {
15
+ private teamId;
16
+ private projectId;
17
+ private isJwtToken;
18
+ constructor(params: {
19
+ baseUrl?: string;
20
+ teamId: string;
21
+ token: string;
22
+ fetch?: typeof globalThis.fetch;
23
+ });
24
+ private ensureValidToken;
25
+ protected request(path: string, params?: RequestParams): Promise<Response>;
26
+ getSession(params: WithPrivate<{
27
+ sessionId: string;
28
+ signal?: AbortSignal;
29
+ }>): Promise<Parsed<{
30
+ session: {
31
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
32
+ region: string;
33
+ vcpus: number;
34
+ memory: number;
35
+ runtime: string;
36
+ timeout: number;
37
+ createdAt: number;
38
+ updatedAt: number;
39
+ id: string;
40
+ requestedAt: number;
41
+ cwd: string;
42
+ networkPolicy?: z.objectInputType<{
43
+ mode: z.ZodLiteral<"allow-all">;
44
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
45
+ mode: z.ZodLiteral<"deny-all">;
46
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
47
+ mode: z.ZodLiteral<"custom">;
48
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
49
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
50
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
51
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
52
+ domain: z.ZodString;
53
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
54
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
55
+ }, "strip", z.ZodTypeAny, {
56
+ domain: string;
57
+ headers?: Record<string, string> | undefined;
58
+ headerNames?: string[] | undefined;
59
+ }, {
60
+ domain: string;
61
+ headers?: Record<string, string> | undefined;
62
+ headerNames?: string[] | undefined;
63
+ }>, "many">>;
64
+ }, z.ZodTypeAny, "passthrough"> | undefined;
65
+ startedAt?: number | undefined;
66
+ requestedStopAt?: number | undefined;
67
+ stoppedAt?: number | undefined;
68
+ abortedAt?: number | undefined;
69
+ duration?: number | undefined;
70
+ sourceSnapshotId?: string | undefined;
71
+ snapshottedAt?: number | undefined;
72
+ interactivePort?: number | undefined;
73
+ activeCpuDurationMs?: number | undefined;
74
+ networkTransfer?: {
75
+ ingress: number;
76
+ egress: number;
77
+ } | undefined;
78
+ } & {
79
+ [k: string]: unknown;
80
+ };
81
+ routes: {
82
+ url: string;
83
+ subdomain: string;
84
+ port: number;
85
+ }[];
86
+ }>>;
87
+ createSandbox(params: WithPrivate<{
88
+ name?: string;
89
+ ports?: number[];
90
+ projectId: string;
91
+ source?: {
92
+ type: "git";
93
+ url: string;
94
+ depth?: number;
95
+ revision?: string;
96
+ username?: string;
97
+ password?: string;
98
+ } | {
99
+ type: "tarball";
100
+ url: string;
101
+ } | {
102
+ type: "snapshot";
103
+ snapshotId: string;
104
+ };
105
+ timeout?: number;
106
+ resources?: {
107
+ vcpus: number;
108
+ };
109
+ persistent?: boolean;
110
+ runtime?: RUNTIMES | (string & {});
111
+ networkPolicy?: NetworkPolicy;
112
+ env?: Record<string, string>;
113
+ tags?: Record<string, string>;
114
+ snapshotExpiration?: number;
115
+ signal?: AbortSignal;
116
+ }>): Promise<Parsed<{
117
+ session: {
118
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
119
+ region: string;
120
+ vcpus: number;
121
+ memory: number;
122
+ runtime: string;
123
+ timeout: number;
124
+ createdAt: number;
125
+ updatedAt: number;
126
+ id: string;
127
+ requestedAt: number;
128
+ cwd: string;
129
+ networkPolicy?: z.objectInputType<{
130
+ mode: z.ZodLiteral<"allow-all">;
131
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
132
+ mode: z.ZodLiteral<"deny-all">;
133
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
134
+ mode: z.ZodLiteral<"custom">;
135
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
136
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
137
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
138
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
139
+ domain: z.ZodString;
140
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
141
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
142
+ }, "strip", z.ZodTypeAny, {
143
+ domain: string;
144
+ headers?: Record<string, string> | undefined;
145
+ headerNames?: string[] | undefined;
146
+ }, {
147
+ domain: string;
148
+ headers?: Record<string, string> | undefined;
149
+ headerNames?: string[] | undefined;
150
+ }>, "many">>;
151
+ }, z.ZodTypeAny, "passthrough"> | undefined;
152
+ startedAt?: number | undefined;
153
+ requestedStopAt?: number | undefined;
154
+ stoppedAt?: number | undefined;
155
+ abortedAt?: number | undefined;
156
+ duration?: number | undefined;
157
+ sourceSnapshotId?: string | undefined;
158
+ snapshottedAt?: number | undefined;
159
+ interactivePort?: number | undefined;
160
+ activeCpuDurationMs?: number | undefined;
161
+ networkTransfer?: {
162
+ ingress: number;
163
+ egress: number;
164
+ } | undefined;
165
+ } & {
166
+ [k: string]: unknown;
167
+ };
168
+ routes: {
169
+ url: string;
170
+ subdomain: string;
171
+ port: number;
172
+ }[];
173
+ sandbox: {
174
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
175
+ name: string;
176
+ persistent: boolean;
177
+ createdAt: number;
178
+ updatedAt: number;
179
+ currentSessionId: string;
180
+ tags?: Record<string, string> | undefined;
181
+ region?: string | undefined;
182
+ vcpus?: number | undefined;
183
+ memory?: number | undefined;
184
+ runtime?: string | undefined;
185
+ timeout?: number | undefined;
186
+ networkPolicy?: z.objectInputType<{
187
+ mode: z.ZodLiteral<"allow-all">;
188
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
189
+ mode: z.ZodLiteral<"deny-all">;
190
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
191
+ mode: z.ZodLiteral<"custom">;
192
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
193
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
194
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
195
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
196
+ domain: z.ZodString;
197
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
198
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
199
+ }, "strip", z.ZodTypeAny, {
200
+ domain: string;
201
+ headers?: Record<string, string> | undefined;
202
+ headerNames?: string[] | undefined;
203
+ }, {
204
+ domain: string;
205
+ headers?: Record<string, string> | undefined;
206
+ headerNames?: string[] | undefined;
207
+ }>, "many">>;
208
+ }, z.ZodTypeAny, "passthrough"> | undefined;
209
+ totalEgressBytes?: number | undefined;
210
+ totalIngressBytes?: number | undefined;
211
+ totalActiveCpuDurationMs?: number | undefined;
212
+ totalDurationMs?: number | undefined;
213
+ currentSnapshotId?: string | undefined;
214
+ cwd?: string | undefined;
215
+ statusUpdatedAt?: number | undefined;
216
+ snapshotExpiration?: number | undefined;
217
+ };
218
+ resumed?: boolean | undefined;
219
+ }>>;
220
+ runCommand(params: {
221
+ sessionId: string;
222
+ cwd?: string;
223
+ command: string;
224
+ args: string[];
225
+ env: Record<string, string>;
226
+ sudo: boolean;
227
+ wait: true;
228
+ signal?: AbortSignal;
229
+ }): Promise<{
230
+ command: CommandData;
231
+ finished: Promise<CommandFinishedData>;
232
+ }>;
233
+ runCommand(params: {
234
+ sessionId: string;
235
+ cwd?: string;
236
+ command: string;
237
+ args: string[];
238
+ env: Record<string, string>;
239
+ sudo: boolean;
240
+ wait?: false;
241
+ signal?: AbortSignal;
242
+ }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
243
+ getCommand(params: {
244
+ sessionId: string;
245
+ cmdId: string;
246
+ wait: true;
247
+ signal?: AbortSignal;
248
+ }): Promise<Parsed<z.infer<typeof CommandFinishedResponse>>>;
249
+ getCommand(params: {
250
+ sessionId: string;
251
+ cmdId: string;
252
+ wait?: boolean;
253
+ signal?: AbortSignal;
254
+ }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
255
+ mkDir(params: {
256
+ sessionId: string;
257
+ path: string;
258
+ cwd?: string;
259
+ signal?: AbortSignal;
260
+ }): Promise<Parsed<{}>>;
261
+ getFileWriter(params: {
262
+ sessionId: string;
263
+ extractDir: string;
264
+ signal?: AbortSignal;
265
+ }): {
266
+ response: Promise<Response>;
267
+ writer: FileWriter;
268
+ };
269
+ listSessions(params: {
270
+ /**
271
+ * The ID or name of the project to which the sessions belong.
272
+ * @example "my-project"
273
+ */
274
+ projectId: string;
275
+ /**
276
+ * Filter sessions by sandbox name.
277
+ */
278
+ name?: string;
279
+ /**
280
+ * Maximum number of sessions to list from a request.
281
+ * @example 10
282
+ */
283
+ limit?: number;
284
+ /**
285
+ * Cursor for pagination.
286
+ */
287
+ cursor?: string;
288
+ /**
289
+ * Sort order for results.
290
+ */
291
+ sortOrder?: "asc" | "desc";
292
+ signal?: AbortSignal;
293
+ }): Promise<Parsed<{
294
+ pagination: {
295
+ count: number;
296
+ next: string | null;
297
+ };
298
+ sessions: z.objectInputType<{
299
+ id: z.ZodString;
300
+ memory: z.ZodNumber;
301
+ vcpus: z.ZodNumber;
302
+ region: z.ZodString;
303
+ runtime: z.ZodString;
304
+ timeout: z.ZodNumber;
305
+ status: z.ZodEnum<["pending", "running", "stopping", "stopped", "failed", "aborted", "snapshotting"]>;
306
+ requestedAt: z.ZodNumber;
307
+ startedAt: z.ZodOptional<z.ZodNumber>;
308
+ requestedStopAt: z.ZodOptional<z.ZodNumber>;
309
+ stoppedAt: z.ZodOptional<z.ZodNumber>;
310
+ abortedAt: z.ZodOptional<z.ZodNumber>;
311
+ duration: z.ZodOptional<z.ZodNumber>;
312
+ sourceSnapshotId: z.ZodOptional<z.ZodString>;
313
+ snapshottedAt: z.ZodOptional<z.ZodNumber>;
314
+ createdAt: z.ZodNumber;
315
+ cwd: z.ZodString;
316
+ updatedAt: z.ZodNumber;
317
+ interactivePort: z.ZodOptional<z.ZodNumber>;
318
+ networkPolicy: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
319
+ mode: z.ZodLiteral<"allow-all">;
320
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
321
+ mode: z.ZodLiteral<"allow-all">;
322
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
323
+ mode: z.ZodLiteral<"allow-all">;
324
+ }, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
325
+ mode: z.ZodLiteral<"deny-all">;
326
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
327
+ mode: z.ZodLiteral<"deny-all">;
328
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
329
+ mode: z.ZodLiteral<"deny-all">;
330
+ }, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
331
+ mode: z.ZodLiteral<"custom">;
332
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
333
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
334
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
335
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
336
+ domain: z.ZodString;
337
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
338
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
339
+ }, "strip", z.ZodTypeAny, {
340
+ domain: string;
341
+ headers?: Record<string, string> | undefined;
342
+ headerNames?: string[] | undefined;
343
+ }, {
344
+ domain: string;
345
+ headers?: Record<string, string> | undefined;
346
+ headerNames?: string[] | undefined;
347
+ }>, "many">>;
348
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
349
+ mode: z.ZodLiteral<"custom">;
350
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
351
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
352
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
353
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
354
+ domain: z.ZodString;
355
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
356
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
357
+ }, "strip", z.ZodTypeAny, {
358
+ domain: string;
359
+ headers?: Record<string, string> | undefined;
360
+ headerNames?: string[] | undefined;
361
+ }, {
362
+ domain: string;
363
+ headers?: Record<string, string> | undefined;
364
+ headerNames?: string[] | undefined;
365
+ }>, "many">>;
366
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
367
+ mode: z.ZodLiteral<"custom">;
368
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
369
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
370
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
371
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
372
+ domain: z.ZodString;
373
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
374
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
375
+ }, "strip", z.ZodTypeAny, {
376
+ domain: string;
377
+ headers?: Record<string, string> | undefined;
378
+ headerNames?: string[] | undefined;
379
+ }, {
380
+ domain: string;
381
+ headers?: Record<string, string> | undefined;
382
+ headerNames?: string[] | undefined;
383
+ }>, "many">>;
384
+ }, z.ZodTypeAny, "passthrough">>]>>;
385
+ activeCpuDurationMs: z.ZodOptional<z.ZodNumber>;
386
+ networkTransfer: z.ZodOptional<z.ZodObject<{
387
+ ingress: z.ZodNumber;
388
+ egress: z.ZodNumber;
389
+ }, "strip", z.ZodTypeAny, {
390
+ ingress: number;
391
+ egress: number;
392
+ }, {
393
+ ingress: number;
394
+ egress: number;
395
+ }>>;
396
+ }, z.ZodTypeAny, "passthrough">[];
397
+ }>>;
398
+ listSnapshots(params: {
399
+ /**
400
+ * The ID or name of the project to which the snapshots belong.
401
+ * @example "my-project"
402
+ */
403
+ projectId: string;
404
+ /**
405
+ * Filter snapshots by sandbox name.
406
+ */
407
+ name?: string;
408
+ /**
409
+ * Maximum number of snapshots to list from a request.
410
+ * @example 10
411
+ */
412
+ limit?: number;
413
+ /**
414
+ * Cursor for pagination.
415
+ */
416
+ cursor?: string;
417
+ /**
418
+ * Sort order for results.
419
+ */
420
+ sortOrder?: "asc" | "desc";
421
+ signal?: AbortSignal;
422
+ }): Promise<Parsed<{
423
+ pagination: {
424
+ count: number;
425
+ next: string | null;
426
+ };
427
+ snapshots: {
428
+ status: "failed" | "created" | "deleted";
429
+ region: string;
430
+ createdAt: number;
431
+ updatedAt: number;
432
+ id: string;
433
+ sourceSessionId: string;
434
+ sizeBytes: number;
435
+ expiresAt?: number | undefined;
436
+ }[];
437
+ }>>;
438
+ writeFiles(params: {
439
+ sessionId: string;
440
+ cwd: string;
441
+ files: {
442
+ path: string;
443
+ content: string | Uint8Array;
444
+ mode?: number;
445
+ }[];
446
+ extractDir: string;
447
+ signal?: AbortSignal;
448
+ }): Promise<void>;
449
+ readFile(params: {
450
+ sessionId: string;
451
+ path: string;
452
+ cwd?: string;
453
+ signal?: AbortSignal;
454
+ }): Promise<Readable | null>;
455
+ killCommand(params: {
456
+ sessionId: string;
457
+ commandId: string;
458
+ signal: number;
459
+ abortSignal?: AbortSignal;
460
+ }): Promise<Parsed<{
461
+ command: {
462
+ name: string;
463
+ id: string;
464
+ startedAt: number;
465
+ cwd: string;
466
+ args: string[];
467
+ sessionId: string;
468
+ exitCode: number | null;
469
+ };
470
+ }>>;
471
+ getLogs(params: {
472
+ sessionId: string;
473
+ cmdId: string;
474
+ signal?: AbortSignal;
475
+ }): AsyncGenerator<z.infer<typeof LogLineStdout> | z.infer<typeof LogLineStderr>, void, void> & Disposable & {
476
+ close(): void;
477
+ };
478
+ stopSession(params: {
479
+ sessionId: string;
480
+ signal?: AbortSignal;
481
+ blocking?: boolean;
482
+ }): Promise<Parsed<z.infer<typeof SessionResponse>>>;
483
+ updateNetworkPolicy(params: {
484
+ sessionId: string;
485
+ networkPolicy: NetworkPolicy;
486
+ signal?: AbortSignal;
487
+ }): Promise<Parsed<z.infer<typeof SessionResponse>>>;
488
+ extendTimeout(params: {
489
+ sessionId: string;
490
+ duration: number;
491
+ signal?: AbortSignal;
492
+ }): Promise<Parsed<z.infer<typeof SessionResponse>>>;
493
+ createSnapshot(params: {
494
+ sessionId: string;
495
+ expiration?: number;
496
+ signal?: AbortSignal;
497
+ }): Promise<Parsed<z.infer<typeof CreateSnapshotResponse>>>;
498
+ deleteSnapshot(params: {
499
+ snapshotId: string;
500
+ signal?: AbortSignal;
501
+ }): Promise<Parsed<z.infer<typeof SnapshotResponse>>>;
502
+ getSnapshot(params: {
503
+ snapshotId: string;
504
+ signal?: AbortSignal;
505
+ }): Promise<Parsed<z.infer<typeof SnapshotResponse>>>;
506
+ getSandbox(params: WithPrivate<{
507
+ name: string;
508
+ projectId: string;
509
+ resume?: boolean;
510
+ signal?: AbortSignal;
511
+ }>): Promise<Parsed<{
512
+ session: {
513
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
514
+ region: string;
515
+ vcpus: number;
516
+ memory: number;
517
+ runtime: string;
518
+ timeout: number;
519
+ createdAt: number;
520
+ updatedAt: number;
521
+ id: string;
522
+ requestedAt: number;
523
+ cwd: string;
524
+ networkPolicy?: z.objectInputType<{
525
+ mode: z.ZodLiteral<"allow-all">;
526
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
527
+ mode: z.ZodLiteral<"deny-all">;
528
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
529
+ mode: z.ZodLiteral<"custom">;
530
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
531
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
532
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
533
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
534
+ domain: z.ZodString;
535
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
536
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
537
+ }, "strip", z.ZodTypeAny, {
538
+ domain: string;
539
+ headers?: Record<string, string> | undefined;
540
+ headerNames?: string[] | undefined;
541
+ }, {
542
+ domain: string;
543
+ headers?: Record<string, string> | undefined;
544
+ headerNames?: string[] | undefined;
545
+ }>, "many">>;
546
+ }, z.ZodTypeAny, "passthrough"> | undefined;
547
+ startedAt?: number | undefined;
548
+ requestedStopAt?: number | undefined;
549
+ stoppedAt?: number | undefined;
550
+ abortedAt?: number | undefined;
551
+ duration?: number | undefined;
552
+ sourceSnapshotId?: string | undefined;
553
+ snapshottedAt?: number | undefined;
554
+ interactivePort?: number | undefined;
555
+ activeCpuDurationMs?: number | undefined;
556
+ networkTransfer?: {
557
+ ingress: number;
558
+ egress: number;
559
+ } | undefined;
560
+ } & {
561
+ [k: string]: unknown;
562
+ };
563
+ routes: {
564
+ url: string;
565
+ subdomain: string;
566
+ port: number;
567
+ }[];
568
+ sandbox: {
569
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
570
+ name: string;
571
+ persistent: boolean;
572
+ createdAt: number;
573
+ updatedAt: number;
574
+ currentSessionId: string;
575
+ tags?: Record<string, string> | undefined;
576
+ region?: string | undefined;
577
+ vcpus?: number | undefined;
578
+ memory?: number | undefined;
579
+ runtime?: string | undefined;
580
+ timeout?: number | undefined;
581
+ networkPolicy?: z.objectInputType<{
582
+ mode: z.ZodLiteral<"allow-all">;
583
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
584
+ mode: z.ZodLiteral<"deny-all">;
585
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
586
+ mode: z.ZodLiteral<"custom">;
587
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
588
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
589
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
590
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
591
+ domain: z.ZodString;
592
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
593
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
594
+ }, "strip", z.ZodTypeAny, {
595
+ domain: string;
596
+ headers?: Record<string, string> | undefined;
597
+ headerNames?: string[] | undefined;
598
+ }, {
599
+ domain: string;
600
+ headers?: Record<string, string> | undefined;
601
+ headerNames?: string[] | undefined;
602
+ }>, "many">>;
603
+ }, z.ZodTypeAny, "passthrough"> | undefined;
604
+ totalEgressBytes?: number | undefined;
605
+ totalIngressBytes?: number | undefined;
606
+ totalActiveCpuDurationMs?: number | undefined;
607
+ totalDurationMs?: number | undefined;
608
+ currentSnapshotId?: string | undefined;
609
+ cwd?: string | undefined;
610
+ statusUpdatedAt?: number | undefined;
611
+ snapshotExpiration?: number | undefined;
612
+ };
613
+ resumed?: boolean | undefined;
614
+ }>>;
615
+ listSandboxes(params: {
616
+ projectId: string;
617
+ limit?: number;
618
+ sortBy?: "createdAt" | "name" | "statusUpdatedAt";
619
+ sortOrder?: "asc" | "desc";
620
+ namePrefix?: string;
621
+ cursor?: string;
622
+ tags?: Record<string, string>;
623
+ signal?: AbortSignal;
624
+ }): Promise<Parsed<{
625
+ sandboxes: {
626
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
627
+ name: string;
628
+ persistent: boolean;
629
+ createdAt: number;
630
+ updatedAt: number;
631
+ currentSessionId: string;
632
+ tags?: Record<string, string> | undefined;
633
+ region?: string | undefined;
634
+ vcpus?: number | undefined;
635
+ memory?: number | undefined;
636
+ runtime?: string | undefined;
637
+ timeout?: number | undefined;
638
+ networkPolicy?: z.objectInputType<{
639
+ mode: z.ZodLiteral<"allow-all">;
640
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
641
+ mode: z.ZodLiteral<"deny-all">;
642
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
643
+ mode: z.ZodLiteral<"custom">;
644
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
645
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
646
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
647
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
648
+ domain: z.ZodString;
649
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
650
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
651
+ }, "strip", z.ZodTypeAny, {
652
+ domain: string;
653
+ headers?: Record<string, string> | undefined;
654
+ headerNames?: string[] | undefined;
655
+ }, {
656
+ domain: string;
657
+ headers?: Record<string, string> | undefined;
658
+ headerNames?: string[] | undefined;
659
+ }>, "many">>;
660
+ }, z.ZodTypeAny, "passthrough"> | undefined;
661
+ totalEgressBytes?: number | undefined;
662
+ totalIngressBytes?: number | undefined;
663
+ totalActiveCpuDurationMs?: number | undefined;
664
+ totalDurationMs?: number | undefined;
665
+ currentSnapshotId?: string | undefined;
666
+ cwd?: string | undefined;
667
+ statusUpdatedAt?: number | undefined;
668
+ snapshotExpiration?: number | undefined;
669
+ }[];
670
+ pagination: {
671
+ count: number;
672
+ next: string | null;
673
+ };
674
+ }>>;
675
+ updateSandbox(params: {
676
+ name: string;
677
+ projectId: string;
678
+ persistent?: boolean;
679
+ resources?: {
680
+ vcpus?: number;
681
+ memory?: number;
682
+ };
683
+ runtime?: RUNTIMES | (string & {});
684
+ timeout?: number;
685
+ networkPolicy?: NetworkPolicy;
686
+ tags?: Record<string, string>;
687
+ snapshotExpiration?: number;
688
+ signal?: AbortSignal;
689
+ }): Promise<Parsed<{
690
+ sandbox: {
691
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
692
+ name: string;
693
+ persistent: boolean;
694
+ createdAt: number;
695
+ updatedAt: number;
696
+ currentSessionId: string;
697
+ tags?: Record<string, string> | undefined;
698
+ region?: string | undefined;
699
+ vcpus?: number | undefined;
700
+ memory?: number | undefined;
701
+ runtime?: string | undefined;
702
+ timeout?: number | undefined;
703
+ networkPolicy?: z.objectInputType<{
704
+ mode: z.ZodLiteral<"allow-all">;
705
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
706
+ mode: z.ZodLiteral<"deny-all">;
707
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
708
+ mode: z.ZodLiteral<"custom">;
709
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
710
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
711
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
712
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
713
+ domain: z.ZodString;
714
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
715
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
716
+ }, "strip", z.ZodTypeAny, {
717
+ domain: string;
718
+ headers?: Record<string, string> | undefined;
719
+ headerNames?: string[] | undefined;
720
+ }, {
721
+ domain: string;
722
+ headers?: Record<string, string> | undefined;
723
+ headerNames?: string[] | undefined;
724
+ }>, "many">>;
725
+ }, z.ZodTypeAny, "passthrough"> | undefined;
726
+ totalEgressBytes?: number | undefined;
727
+ totalIngressBytes?: number | undefined;
728
+ totalActiveCpuDurationMs?: number | undefined;
729
+ totalDurationMs?: number | undefined;
730
+ currentSnapshotId?: string | undefined;
731
+ cwd?: string | undefined;
732
+ statusUpdatedAt?: number | undefined;
733
+ snapshotExpiration?: number | undefined;
734
+ };
735
+ }>>;
736
+ deleteSandbox(params: {
737
+ name: string;
738
+ projectId: string;
739
+ signal?: AbortSignal;
740
+ }): Promise<Parsed<{
741
+ sandbox: {
742
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
743
+ name: string;
744
+ persistent: boolean;
745
+ createdAt: number;
746
+ updatedAt: number;
747
+ currentSessionId: string;
748
+ tags?: Record<string, string> | undefined;
749
+ region?: string | undefined;
750
+ vcpus?: number | undefined;
751
+ memory?: number | undefined;
752
+ runtime?: string | undefined;
753
+ timeout?: number | undefined;
754
+ networkPolicy?: z.objectInputType<{
755
+ mode: z.ZodLiteral<"allow-all">;
756
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
757
+ mode: z.ZodLiteral<"deny-all">;
758
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
759
+ mode: z.ZodLiteral<"custom">;
760
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
761
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
762
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
763
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
764
+ domain: z.ZodString;
765
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
766
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
767
+ }, "strip", z.ZodTypeAny, {
768
+ domain: string;
769
+ headers?: Record<string, string> | undefined;
770
+ headerNames?: string[] | undefined;
771
+ }, {
772
+ domain: string;
773
+ headers?: Record<string, string> | undefined;
774
+ headerNames?: string[] | undefined;
775
+ }>, "many">>;
776
+ }, z.ZodTypeAny, "passthrough"> | undefined;
777
+ totalEgressBytes?: number | undefined;
778
+ totalIngressBytes?: number | undefined;
779
+ totalActiveCpuDurationMs?: number | undefined;
780
+ totalDurationMs?: number | undefined;
781
+ currentSnapshotId?: string | undefined;
782
+ cwd?: string | undefined;
783
+ statusUpdatedAt?: number | undefined;
784
+ snapshotExpiration?: number | undefined;
785
+ };
786
+ }>>;
787
+ }
788
+ //#endregion
789
+ export { APIClient, WithFetchOptions };
790
+ //# sourceMappingURL=api-client.d.cts.map