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

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 +788 -0
  6. package/dist/api-client/api-client.d.ts +782 -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 +181 -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 +154 -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 +688 -0
  101. package/dist/sandbox.cjs.map +1 -0
  102. package/dist/sandbox.d.cts +780 -0
  103. package/dist/sandbox.d.ts +767 -711
  104. package/dist/sandbox.js +678 -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,788 @@
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
+ }>>;
219
+ runCommand(params: {
220
+ sessionId: string;
221
+ cwd?: string;
222
+ command: string;
223
+ args: string[];
224
+ env: Record<string, string>;
225
+ sudo: boolean;
226
+ wait: true;
227
+ signal?: AbortSignal;
228
+ }): Promise<{
229
+ command: CommandData;
230
+ finished: Promise<CommandFinishedData>;
231
+ }>;
232
+ runCommand(params: {
233
+ sessionId: string;
234
+ cwd?: string;
235
+ command: string;
236
+ args: string[];
237
+ env: Record<string, string>;
238
+ sudo: boolean;
239
+ wait?: false;
240
+ signal?: AbortSignal;
241
+ }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
242
+ getCommand(params: {
243
+ sessionId: string;
244
+ cmdId: string;
245
+ wait: true;
246
+ signal?: AbortSignal;
247
+ }): Promise<Parsed<z.infer<typeof CommandFinishedResponse>>>;
248
+ getCommand(params: {
249
+ sessionId: string;
250
+ cmdId: string;
251
+ wait?: boolean;
252
+ signal?: AbortSignal;
253
+ }): Promise<Parsed<z.infer<typeof CommandResponse>>>;
254
+ mkDir(params: {
255
+ sessionId: string;
256
+ path: string;
257
+ cwd?: string;
258
+ signal?: AbortSignal;
259
+ }): Promise<Parsed<{}>>;
260
+ getFileWriter(params: {
261
+ sessionId: string;
262
+ extractDir: string;
263
+ signal?: AbortSignal;
264
+ }): {
265
+ response: Promise<Response>;
266
+ writer: FileWriter;
267
+ };
268
+ listSessions(params: {
269
+ /**
270
+ * The ID or name of the project to which the sessions belong.
271
+ * @example "my-project"
272
+ */
273
+ projectId: string;
274
+ /**
275
+ * Filter sessions by sandbox name.
276
+ */
277
+ name?: string;
278
+ /**
279
+ * Maximum number of sessions to list from a request.
280
+ * @example 10
281
+ */
282
+ limit?: number;
283
+ /**
284
+ * Cursor for pagination.
285
+ */
286
+ cursor?: string;
287
+ /**
288
+ * Sort order for results.
289
+ */
290
+ sortOrder?: "asc" | "desc";
291
+ signal?: AbortSignal;
292
+ }): Promise<Parsed<{
293
+ pagination: {
294
+ count: number;
295
+ next: string | null;
296
+ };
297
+ sessions: z.objectInputType<{
298
+ id: z.ZodString;
299
+ memory: z.ZodNumber;
300
+ vcpus: z.ZodNumber;
301
+ region: z.ZodString;
302
+ runtime: z.ZodString;
303
+ timeout: z.ZodNumber;
304
+ status: z.ZodEnum<["pending", "running", "stopping", "stopped", "failed", "aborted", "snapshotting"]>;
305
+ requestedAt: z.ZodNumber;
306
+ startedAt: z.ZodOptional<z.ZodNumber>;
307
+ requestedStopAt: z.ZodOptional<z.ZodNumber>;
308
+ stoppedAt: z.ZodOptional<z.ZodNumber>;
309
+ abortedAt: z.ZodOptional<z.ZodNumber>;
310
+ duration: z.ZodOptional<z.ZodNumber>;
311
+ sourceSnapshotId: z.ZodOptional<z.ZodString>;
312
+ snapshottedAt: z.ZodOptional<z.ZodNumber>;
313
+ createdAt: z.ZodNumber;
314
+ cwd: z.ZodString;
315
+ updatedAt: z.ZodNumber;
316
+ interactivePort: z.ZodOptional<z.ZodNumber>;
317
+ networkPolicy: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
318
+ mode: z.ZodLiteral<"allow-all">;
319
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
320
+ mode: z.ZodLiteral<"allow-all">;
321
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
322
+ mode: z.ZodLiteral<"allow-all">;
323
+ }, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
324
+ mode: z.ZodLiteral<"deny-all">;
325
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
326
+ mode: z.ZodLiteral<"deny-all">;
327
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
328
+ mode: z.ZodLiteral<"deny-all">;
329
+ }, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
330
+ mode: z.ZodLiteral<"custom">;
331
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
332
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
333
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
334
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
335
+ domain: z.ZodString;
336
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
337
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
338
+ }, "strip", z.ZodTypeAny, {
339
+ domain: string;
340
+ headers?: Record<string, string> | undefined;
341
+ headerNames?: string[] | undefined;
342
+ }, {
343
+ domain: string;
344
+ headers?: Record<string, string> | undefined;
345
+ headerNames?: string[] | undefined;
346
+ }>, "many">>;
347
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
348
+ mode: z.ZodLiteral<"custom">;
349
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
350
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
351
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
352
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
353
+ domain: z.ZodString;
354
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
355
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
356
+ }, "strip", z.ZodTypeAny, {
357
+ domain: string;
358
+ headers?: Record<string, string> | undefined;
359
+ headerNames?: string[] | undefined;
360
+ }, {
361
+ domain: string;
362
+ headers?: Record<string, string> | undefined;
363
+ headerNames?: string[] | undefined;
364
+ }>, "many">>;
365
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
366
+ mode: z.ZodLiteral<"custom">;
367
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
368
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
369
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
370
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
371
+ domain: z.ZodString;
372
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
373
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
374
+ }, "strip", z.ZodTypeAny, {
375
+ domain: string;
376
+ headers?: Record<string, string> | undefined;
377
+ headerNames?: string[] | undefined;
378
+ }, {
379
+ domain: string;
380
+ headers?: Record<string, string> | undefined;
381
+ headerNames?: string[] | undefined;
382
+ }>, "many">>;
383
+ }, z.ZodTypeAny, "passthrough">>]>>;
384
+ activeCpuDurationMs: z.ZodOptional<z.ZodNumber>;
385
+ networkTransfer: z.ZodOptional<z.ZodObject<{
386
+ ingress: z.ZodNumber;
387
+ egress: z.ZodNumber;
388
+ }, "strip", z.ZodTypeAny, {
389
+ ingress: number;
390
+ egress: number;
391
+ }, {
392
+ ingress: number;
393
+ egress: number;
394
+ }>>;
395
+ }, z.ZodTypeAny, "passthrough">[];
396
+ }>>;
397
+ listSnapshots(params: {
398
+ /**
399
+ * The ID or name of the project to which the snapshots belong.
400
+ * @example "my-project"
401
+ */
402
+ projectId: string;
403
+ /**
404
+ * Filter snapshots by sandbox name.
405
+ */
406
+ name?: string;
407
+ /**
408
+ * Maximum number of snapshots to list from a request.
409
+ * @example 10
410
+ */
411
+ limit?: number;
412
+ /**
413
+ * Cursor for pagination.
414
+ */
415
+ cursor?: string;
416
+ /**
417
+ * Sort order for results.
418
+ */
419
+ sortOrder?: "asc" | "desc";
420
+ signal?: AbortSignal;
421
+ }): Promise<Parsed<{
422
+ pagination: {
423
+ count: number;
424
+ next: string | null;
425
+ };
426
+ snapshots: {
427
+ status: "failed" | "created" | "deleted";
428
+ region: string;
429
+ createdAt: number;
430
+ updatedAt: number;
431
+ id: string;
432
+ sourceSessionId: string;
433
+ sizeBytes: number;
434
+ expiresAt?: number | undefined;
435
+ }[];
436
+ }>>;
437
+ writeFiles(params: {
438
+ sessionId: string;
439
+ cwd: string;
440
+ files: {
441
+ path: string;
442
+ content: string | Uint8Array;
443
+ mode?: number;
444
+ }[];
445
+ extractDir: string;
446
+ signal?: AbortSignal;
447
+ }): Promise<void>;
448
+ readFile(params: {
449
+ sessionId: string;
450
+ path: string;
451
+ cwd?: string;
452
+ signal?: AbortSignal;
453
+ }): Promise<Readable | null>;
454
+ killCommand(params: {
455
+ sessionId: string;
456
+ commandId: string;
457
+ signal: number;
458
+ abortSignal?: AbortSignal;
459
+ }): Promise<Parsed<{
460
+ command: {
461
+ name: string;
462
+ id: string;
463
+ startedAt: number;
464
+ cwd: string;
465
+ args: string[];
466
+ sessionId: string;
467
+ exitCode: number | null;
468
+ };
469
+ }>>;
470
+ getLogs(params: {
471
+ sessionId: string;
472
+ cmdId: string;
473
+ signal?: AbortSignal;
474
+ }): AsyncGenerator<z.infer<typeof LogLineStdout> | z.infer<typeof LogLineStderr>, void, void> & Disposable & {
475
+ close(): void;
476
+ };
477
+ stopSession(params: {
478
+ sessionId: string;
479
+ signal?: AbortSignal;
480
+ blocking?: boolean;
481
+ }): Promise<Parsed<z.infer<typeof SessionResponse>>>;
482
+ updateNetworkPolicy(params: {
483
+ sessionId: string;
484
+ networkPolicy: NetworkPolicy;
485
+ signal?: AbortSignal;
486
+ }): Promise<Parsed<z.infer<typeof SessionResponse>>>;
487
+ extendTimeout(params: {
488
+ sessionId: string;
489
+ duration: number;
490
+ signal?: AbortSignal;
491
+ }): Promise<Parsed<z.infer<typeof SessionResponse>>>;
492
+ createSnapshot(params: {
493
+ sessionId: string;
494
+ expiration?: number;
495
+ signal?: AbortSignal;
496
+ }): Promise<Parsed<z.infer<typeof CreateSnapshotResponse>>>;
497
+ deleteSnapshot(params: {
498
+ snapshotId: string;
499
+ signal?: AbortSignal;
500
+ }): Promise<Parsed<z.infer<typeof SnapshotResponse>>>;
501
+ getSnapshot(params: {
502
+ snapshotId: string;
503
+ signal?: AbortSignal;
504
+ }): Promise<Parsed<z.infer<typeof SnapshotResponse>>>;
505
+ getSandbox(params: WithPrivate<{
506
+ name: string;
507
+ projectId: string;
508
+ resume?: boolean;
509
+ signal?: AbortSignal;
510
+ }>): Promise<Parsed<{
511
+ session: {
512
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
513
+ region: string;
514
+ vcpus: number;
515
+ memory: number;
516
+ runtime: string;
517
+ timeout: number;
518
+ createdAt: number;
519
+ updatedAt: number;
520
+ id: string;
521
+ requestedAt: number;
522
+ cwd: string;
523
+ networkPolicy?: z.objectInputType<{
524
+ mode: z.ZodLiteral<"allow-all">;
525
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
526
+ mode: z.ZodLiteral<"deny-all">;
527
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
528
+ mode: z.ZodLiteral<"custom">;
529
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
530
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
531
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
532
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
533
+ domain: z.ZodString;
534
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
535
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
536
+ }, "strip", z.ZodTypeAny, {
537
+ domain: string;
538
+ headers?: Record<string, string> | undefined;
539
+ headerNames?: string[] | undefined;
540
+ }, {
541
+ domain: string;
542
+ headers?: Record<string, string> | undefined;
543
+ headerNames?: string[] | undefined;
544
+ }>, "many">>;
545
+ }, z.ZodTypeAny, "passthrough"> | undefined;
546
+ startedAt?: number | undefined;
547
+ requestedStopAt?: number | undefined;
548
+ stoppedAt?: number | undefined;
549
+ abortedAt?: number | undefined;
550
+ duration?: number | undefined;
551
+ sourceSnapshotId?: string | undefined;
552
+ snapshottedAt?: number | undefined;
553
+ interactivePort?: number | undefined;
554
+ activeCpuDurationMs?: number | undefined;
555
+ networkTransfer?: {
556
+ ingress: number;
557
+ egress: number;
558
+ } | undefined;
559
+ } & {
560
+ [k: string]: unknown;
561
+ };
562
+ routes: {
563
+ url: string;
564
+ subdomain: string;
565
+ port: number;
566
+ }[];
567
+ sandbox: {
568
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
569
+ name: string;
570
+ persistent: boolean;
571
+ createdAt: number;
572
+ updatedAt: number;
573
+ currentSessionId: string;
574
+ tags?: Record<string, string> | undefined;
575
+ region?: string | undefined;
576
+ vcpus?: number | undefined;
577
+ memory?: number | undefined;
578
+ runtime?: string | undefined;
579
+ timeout?: number | undefined;
580
+ networkPolicy?: z.objectInputType<{
581
+ mode: z.ZodLiteral<"allow-all">;
582
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
583
+ mode: z.ZodLiteral<"deny-all">;
584
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
585
+ mode: z.ZodLiteral<"custom">;
586
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
587
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
588
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
589
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
590
+ domain: z.ZodString;
591
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
592
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
593
+ }, "strip", z.ZodTypeAny, {
594
+ domain: string;
595
+ headers?: Record<string, string> | undefined;
596
+ headerNames?: string[] | undefined;
597
+ }, {
598
+ domain: string;
599
+ headers?: Record<string, string> | undefined;
600
+ headerNames?: string[] | undefined;
601
+ }>, "many">>;
602
+ }, z.ZodTypeAny, "passthrough"> | undefined;
603
+ totalEgressBytes?: number | undefined;
604
+ totalIngressBytes?: number | undefined;
605
+ totalActiveCpuDurationMs?: number | undefined;
606
+ totalDurationMs?: number | undefined;
607
+ currentSnapshotId?: string | undefined;
608
+ cwd?: string | undefined;
609
+ statusUpdatedAt?: number | undefined;
610
+ snapshotExpiration?: number | undefined;
611
+ };
612
+ }>>;
613
+ listSandboxes(params: {
614
+ projectId: string;
615
+ limit?: number;
616
+ sortBy?: "createdAt" | "name" | "statusUpdatedAt";
617
+ sortOrder?: "asc" | "desc";
618
+ namePrefix?: string;
619
+ cursor?: string;
620
+ tags?: Record<string, string>;
621
+ signal?: AbortSignal;
622
+ }): Promise<Parsed<{
623
+ sandboxes: {
624
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
625
+ name: string;
626
+ persistent: boolean;
627
+ createdAt: number;
628
+ updatedAt: number;
629
+ currentSessionId: string;
630
+ tags?: Record<string, string> | undefined;
631
+ region?: string | undefined;
632
+ vcpus?: number | undefined;
633
+ memory?: number | undefined;
634
+ runtime?: string | undefined;
635
+ timeout?: number | undefined;
636
+ networkPolicy?: z.objectInputType<{
637
+ mode: z.ZodLiteral<"allow-all">;
638
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
639
+ mode: z.ZodLiteral<"deny-all">;
640
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
641
+ mode: z.ZodLiteral<"custom">;
642
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
643
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
644
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
645
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
646
+ domain: z.ZodString;
647
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
648
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
649
+ }, "strip", z.ZodTypeAny, {
650
+ domain: string;
651
+ headers?: Record<string, string> | undefined;
652
+ headerNames?: string[] | undefined;
653
+ }, {
654
+ domain: string;
655
+ headers?: Record<string, string> | undefined;
656
+ headerNames?: string[] | undefined;
657
+ }>, "many">>;
658
+ }, z.ZodTypeAny, "passthrough"> | undefined;
659
+ totalEgressBytes?: number | undefined;
660
+ totalIngressBytes?: number | undefined;
661
+ totalActiveCpuDurationMs?: number | undefined;
662
+ totalDurationMs?: number | undefined;
663
+ currentSnapshotId?: string | undefined;
664
+ cwd?: string | undefined;
665
+ statusUpdatedAt?: number | undefined;
666
+ snapshotExpiration?: number | undefined;
667
+ }[];
668
+ pagination: {
669
+ count: number;
670
+ next: string | null;
671
+ };
672
+ }>>;
673
+ updateSandbox(params: {
674
+ name: string;
675
+ projectId: string;
676
+ persistent?: boolean;
677
+ resources?: {
678
+ vcpus?: number;
679
+ memory?: number;
680
+ };
681
+ runtime?: RUNTIMES | (string & {});
682
+ timeout?: number;
683
+ networkPolicy?: NetworkPolicy;
684
+ tags?: Record<string, string>;
685
+ snapshotExpiration?: number;
686
+ signal?: AbortSignal;
687
+ }): Promise<Parsed<{
688
+ sandbox: {
689
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
690
+ name: string;
691
+ persistent: boolean;
692
+ createdAt: number;
693
+ updatedAt: number;
694
+ currentSessionId: string;
695
+ tags?: Record<string, string> | undefined;
696
+ region?: string | undefined;
697
+ vcpus?: number | undefined;
698
+ memory?: number | undefined;
699
+ runtime?: string | undefined;
700
+ timeout?: number | undefined;
701
+ networkPolicy?: z.objectInputType<{
702
+ mode: z.ZodLiteral<"allow-all">;
703
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
704
+ mode: z.ZodLiteral<"deny-all">;
705
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
706
+ mode: z.ZodLiteral<"custom">;
707
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
708
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
709
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
710
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
711
+ domain: z.ZodString;
712
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
713
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
714
+ }, "strip", z.ZodTypeAny, {
715
+ domain: string;
716
+ headers?: Record<string, string> | undefined;
717
+ headerNames?: string[] | undefined;
718
+ }, {
719
+ domain: string;
720
+ headers?: Record<string, string> | undefined;
721
+ headerNames?: string[] | undefined;
722
+ }>, "many">>;
723
+ }, z.ZodTypeAny, "passthrough"> | undefined;
724
+ totalEgressBytes?: number | undefined;
725
+ totalIngressBytes?: number | undefined;
726
+ totalActiveCpuDurationMs?: number | undefined;
727
+ totalDurationMs?: number | undefined;
728
+ currentSnapshotId?: string | undefined;
729
+ cwd?: string | undefined;
730
+ statusUpdatedAt?: number | undefined;
731
+ snapshotExpiration?: number | undefined;
732
+ };
733
+ }>>;
734
+ deleteSandbox(params: {
735
+ name: string;
736
+ projectId: string;
737
+ signal?: AbortSignal;
738
+ }): Promise<Parsed<{
739
+ sandbox: {
740
+ status: "aborted" | "pending" | "running" | "stopping" | "stopped" | "failed" | "snapshotting";
741
+ name: string;
742
+ persistent: boolean;
743
+ createdAt: number;
744
+ updatedAt: number;
745
+ currentSessionId: string;
746
+ tags?: Record<string, string> | undefined;
747
+ region?: string | undefined;
748
+ vcpus?: number | undefined;
749
+ memory?: number | undefined;
750
+ runtime?: string | undefined;
751
+ timeout?: number | undefined;
752
+ networkPolicy?: z.objectInputType<{
753
+ mode: z.ZodLiteral<"allow-all">;
754
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
755
+ mode: z.ZodLiteral<"deny-all">;
756
+ }, z.ZodTypeAny, "passthrough"> | z.objectInputType<{
757
+ mode: z.ZodLiteral<"custom">;
758
+ allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
759
+ allowedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
760
+ deniedCIDRs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
761
+ injectionRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
762
+ domain: z.ZodString;
763
+ headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
764
+ headerNames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
765
+ }, "strip", z.ZodTypeAny, {
766
+ domain: string;
767
+ headers?: Record<string, string> | undefined;
768
+ headerNames?: string[] | undefined;
769
+ }, {
770
+ domain: string;
771
+ headers?: Record<string, string> | undefined;
772
+ headerNames?: string[] | undefined;
773
+ }>, "many">>;
774
+ }, z.ZodTypeAny, "passthrough"> | undefined;
775
+ totalEgressBytes?: number | undefined;
776
+ totalIngressBytes?: number | undefined;
777
+ totalActiveCpuDurationMs?: number | undefined;
778
+ totalDurationMs?: number | undefined;
779
+ currentSnapshotId?: string | undefined;
780
+ cwd?: string | undefined;
781
+ statusUpdatedAt?: number | undefined;
782
+ snapshotExpiration?: number | undefined;
783
+ };
784
+ }>>;
785
+ }
786
+ //#endregion
787
+ export { APIClient, WithFetchOptions };
788
+ //# sourceMappingURL=api-client.d.cts.map