@prized/sdk 0.1.1 → 0.1.3

package/dist/esm/sandbox.d.ts

@@ -4,6 +4,42 @@ import { type ClientOptions } from './http.js';
 import { type ExecResult, type Resources, type ResourcesInput, type SandboxInfo, type SandboxState, type Template } from './types.js';
 /** The header a request to a sandbox port's URL carries the API key in. */
 export declare const PREVIEW_KEY_HEADER = "Prized-Key";
+/** A sandbox port's preview link (`setPortPublic`): its URL, and whether
+ *  it is public, until when. */
+export interface PortPreview {
+    sandboxId: string;
+    port: number;
+    /** The port's URL for a program with the API key (`previewUrl`). */
+    url: string;
+    /** The same port on prized.link, which opens in a browser tab once the
+     *  port is public; null where the deployment has no browser domain. */
+    browserUrl: string | null;
+    /** Anyone with the URL reaches the port, no credential needed. */
+    public: boolean;
+    /** When the port goes private again on its own; null while private. */
+    publicExpiresAt: Date | null;
+}
+/** A short-lived URL token for a sandbox port (`previewToken`). */
+export interface PreviewToken {
+    /** The preview URL with the token in its `prized_token` query parameter. */
+    url: string;
+    /** The same on prized.link, to open in a browser tab or a frame; null
+     *  where the deployment has no browser domain. */
+    browserUrl: string | null;
+    token: string;
+    expiresAt: Date;
+}
+export interface PreviewTokenOptions {
+    /** How long the token opens the port, in seconds: 60 to 86 400. Default 3600 (an hour). */
+    expiresIn?: number;
+    signal?: AbortSignal;
+}
+export interface SetPortPublicOptions {
+    /** With `true`: how long the port stays public, in seconds: 300 to
+     *  2 592 000 (30 days). Default 7 days. */
+    expiresIn?: number;
+    signal?: AbortSignal;
+}
 /** The template a create uses when it names none. */
 export declare const DEFAULT_TEMPLATE = "prized-base-v1";
 /** How long create, resume and fork wait for `running` by default. */
@@ -128,8 +164,9 @@ export declare class Sandbox {
     /**
      * Delete every sandbox carrying all of `labels` (at least one) and resolve
      * with their ids (the API takes up to 250 a request; this repeats it until
-     * none are left). Safe to repeat: sandboxes already being
-     * deleted are in the answer again, and none matching resolves `[]`. Each
+     * none are left). Each request selects the current matches, so a repeat
+     * can delete sandboxes created since the first request. An uncertain
+     * answer is not retried; list the matches before deleting again. Each
      * counts toward the workspace's quotas until it is gone;
      * `Sandbox.list({ labels })` coming back empty means they all are.
      */
@@ -193,6 +230,35 @@ export declare class Sandbox {
      *  `redirect: 'manual'`: fetch resends custom headers to whatever host a
      *  redirect names, so only ever send them to the sandbox's preview URL. */
     previewHeaders(): Record<string, string>;
+    /**
+     * A short-lived token for `port`, for a client that cannot send
+     * `Prized-Key` in a header: a person in a browser tab, a WebSocket opened
+     * from a browser page, or a program you hand this one port to and not
+     * your API key. `browserUrl` is the port on prized.link with the token in
+     * its `prized_token` query parameter: it opens in a browser tab or a
+     * frame (the token moves into a cookie for that host; a tab's first visit
+     * shows a notice). `url` is the same on the preview URL, for programs. The
+     * app never sees the token. It opens the port until `expiresAt`
+     * (`expiresIn` seconds, 60 to 86 400, an hour by default), or until this
+     * client's key is revoked; making the port public or private again ends
+     * it too. It never wakes a paused sandbox (`503 sandbox_not_running`).
+     * Needs a paid workspace (`share_links_need_payment` otherwise).
+     */
+    previewToken(port: number, options?: PreviewTokenOptions): Promise<PreviewToken>;
+    /**
+     * Make `port` public (anyone with its URL reaches it, with no
+     * credential) for `expiresIn` seconds (300 to 2 592 000, 7 days by
+     * default), or private again with `false`. Public needs the workspace
+     * owner's key and a paid workspace, and counts toward the workspace's 10
+     * public ports and links. The answer's `browserUrl` (prized.link) opens in
+     * a browser tab (a tab's first visit shows a notice); `url` answers
+     * programs, `fetch` and WebSockets. A public port never wakes a paused
+     * sandbox. A port already public keeps its expiry: make it private, then
+     * public again, to change it.
+     */
+    setPortPublic(port: number, isPublic: boolean, options?: SetPortPublicOptions): Promise<PortPreview>;
+    /** A port a preview link may name: 1 to 65 535, never 22 or 81 (the sandbox's own). */
+    private previewPort;
     /** POST the verb, the call and its retries within `deadline`; with `hold`,
      *  held by the API until the sandbox is that (each attempt asks only for
      *  what is left). */

package/dist/esm/sandbox.js

@@ -4,7 +4,7 @@ import { execCommand } from './commands.js';
 import { PrizedError } from './errors.js';
 import { Files } from './files.js';
 import { callDeadline, cutByDeadline, MAX_RETRY_AFTER_MS, Polls, request, resolveConfig, toolboxBaseFor, warmEdge, } from './http.js';
-import { parseSandbox, parseTemplate, resourcesToWire, } from './types.js';
+import { parseSandbox, parseTemplate, parseTime, resourcesToWire, } from './types.js';
 /** The header a request to a sandbox port's URL carries the API key in. */
 export const PREVIEW_KEY_HEADER = 'Prized-Key';
 /** The template a create uses when it names none. */
@@ -73,6 +73,13 @@ function wholeMinutes(name, value, allowZero) {
     }
     return value;
 }
+function wholeSeconds(name, value) {
+    if (value === undefined)
+        return undefined;
+    if (!Number.isInteger(value) || value <= 0)
+        throw new PrizedError('invalid_argument', `${name} must be a whole number of seconds > 0`);
+    return value;
+}
 function apiUrl(config, path) {
     return `${config.baseUrl}/api/v1${path}`;
 }
@@ -437,8 +444,9 @@ export class Sandbox {
     /**
      * Delete every sandbox carrying all of `labels` (at least one) and resolve
      * with their ids (the API takes up to 250 a request; this repeats it until
-     * none are left). Safe to repeat: sandboxes already being
-     * deleted are in the answer again, and none matching resolves `[]`. Each
+     * none are left). Each request selects the current matches, so a repeat
+     * can delete sandboxes created since the first request. An uncertain
+     * answer is not retried; list the matches before deleting again. Each
      * counts toward the workspace's quotas until it is gone;
      * `Sandbox.list({ labels })` coming back empty means they all are.
      */
@@ -452,7 +460,15 @@ export class Sandbox {
         const deleted = new Set();
         const stuck = (calls) => new PrizedError('delete_incomplete', `Deleted ${deleted.size} sandboxes in ${calls} requests and some are left; call again to delete the rest.`);
         for (let call = 1; call <= MAX_BULK_DELETE_CALLS; call += 1) {
-            const result = await request(config, { method: 'DELETE', url: apiUrl(config, `/sandboxes${query}`), retry: 'safe', deadline });
+            // A label is a live selector, not a stable resource or idempotency key.
+            const result = await request(config, {
+                method: 'DELETE', url: apiUrl(config, `/sandboxes${query}`), retry: 'exec', deadline,
+                effect: {
+                    maybe: 'some matching sandboxes may already be deleting',
+                    did: 'The matching sandboxes were marked for deletion',
+                    check: 'It was not sent again: list the matching sandboxes before deleting again, because the matches may have changed.',
+                },
+            });
             const answer = result.json;
             const ids = answer?.ids;
             if (!Array.isArray(ids) || !ids.every((id) => typeof id === 'string')) {
@@ -549,9 +565,13 @@ export class Sandbox {
             body.maxRuntimeMin = maxRuntimeMin;
         const idempotencyKey = options.idempotencyKey ?? randomKey();
         const wire = snapshot(body); // as in create
+        const path = `${sandboxPathFor(this.id)}/fork`;
+        // Held by the API until every copy runs (or its bound), as create is,
+        // instead of polled; the cleanup's replay only wants the ids.
+        const held = options.wait !== false;
         const send = (deadline, attempts) => request(this.config, {
             method: 'POST',
-            url: apiUrl(this.config, `${sandboxPathFor(this.id)}/fork`),
+            url: (leftMs) => apiUrl(this.config, held && attempts !== undefined ? `${path}${holdQuery(this.config, 'running', leftMs)}` : path),
             json: wire,
             headers: { 'idempotency-key': idempotencyKey },
             retry: 'safe',
@@ -674,9 +694,7 @@ export class Sandbox {
      * `preview_unavailable` when the deployment has sandbox ingress off.
      */
     previewUrl(port) {
-        if (!Number.isInteger(port) || port < 1 || port > 65535 || port === 22 || port === 81) {
-            throw new PrizedError('bad_request', `port must be a whole number from 1 to 65535 other than 22 and 81, not ${String(port)}`, { sandboxId: this.id });
-        }
+        this.previewPort(port);
         const template = this.current.raw.previewUrlTemplate;
         if (typeof template !== 'string' || !template.includes('{port}')) {
             throw new PrizedError('preview_unavailable', 'sandbox ports at a URL are not turned on for this deployment', { sandboxId: this.id });
@@ -690,6 +708,93 @@ export class Sandbox {
     previewHeaders() {
         return { [PREVIEW_KEY_HEADER]: this.config.apiKey };
     }
+    /**
+     * A short-lived token for `port`, for a client that cannot send
+     * `Prized-Key` in a header: a person in a browser tab, a WebSocket opened
+     * from a browser page, or a program you hand this one port to and not
+     * your API key. `browserUrl` is the port on prized.link with the token in
+     * its `prized_token` query parameter: it opens in a browser tab or a
+     * frame (the token moves into a cookie for that host; a tab's first visit
+     * shows a notice). `url` is the same on the preview URL, for programs. The
+     * app never sees the token. It opens the port until `expiresAt`
+     * (`expiresIn` seconds, 60 to 86 400, an hour by default), or until this
+     * client's key is revoked; making the port public or private again ends
+     * it too. It never wakes a paused sandbox (`503 sandbox_not_running`).
+     * Needs a paid workspace (`share_links_need_payment` otherwise).
+     */
+    async previewToken(port, options = {}) {
+        this.previewPort(port);
+        const expiresIn = wholeSeconds('expiresIn', options.expiresIn);
+        const result = await request(this.config, {
+            method: 'POST',
+            url: apiUrl(this.config, `${sandboxPathFor(this.id)}/ports/${port}/token`),
+            json: expiresIn === undefined ? {} : { expiresIn },
+            // A second copy mints a second token nobody holds, which expires on its own.
+            retry: 'safe',
+            signal: options.signal,
+            deadline: callDeadline(this.config),
+            sandboxId: this.id,
+        });
+        const body = result.json;
+        const expiresAt = parseTime(body?.expiresAt);
+        if (typeof body?.url !== 'string' || typeof body.token !== 'string' || expiresAt === null) {
+            throw new PrizedError('bad_response', 'the API answered a preview token without its url, token or expiry', { sandboxId: this.id });
+        }
+        return {
+            url: body.url,
+            browserUrl: typeof body.browserUrl === 'string' ? body.browserUrl : null,
+            token: body.token,
+            expiresAt,
+        };
+    }
+    /**
+     * Make `port` public (anyone with its URL reaches it, with no
+     * credential) for `expiresIn` seconds (300 to 2 592 000, 7 days by
+     * default), or private again with `false`. Public needs the workspace
+     * owner's key and a paid workspace, and counts toward the workspace's 10
+     * public ports and links. The answer's `browserUrl` (prized.link) opens in
+     * a browser tab (a tab's first visit shows a notice); `url` answers
+     * programs, `fetch` and WebSockets. A public port never wakes a paused
+     * sandbox. A port already public keeps its expiry: make it private, then
+     * public again, to change it.
+     */
+    async setPortPublic(port, isPublic, options = {}) {
+        this.previewPort(port);
+        if (typeof isPublic !== 'boolean')
+            throw new PrizedError('invalid_argument', 'isPublic must be true or false', { sandboxId: this.id });
+        const expiresIn = wholeSeconds('expiresIn', options.expiresIn);
+        if (expiresIn !== undefined && !isPublic) {
+            throw new PrizedError('invalid_argument', 'expiresIn applies only when making a port public', { sandboxId: this.id });
+        }
+        const result = await request(this.config, {
+            method: 'PUT',
+            url: apiUrl(this.config, `${sandboxPathFor(this.id)}/ports/${port}`),
+            json: isPublic ? { public: true, ...(expiresIn === undefined ? {} : { expiresIn }) } : { public: false },
+            // Setting the same state again changes nothing.
+            retry: 'safe',
+            signal: options.signal,
+            deadline: callDeadline(this.config),
+            sandboxId: this.id,
+        });
+        const doc = result.json?.preview;
+        if (doc === undefined || typeof doc.url !== 'string' || typeof doc.public !== 'boolean') {
+            throw new PrizedError('bad_response', 'the API answered a port without its url or public setting', { sandboxId: this.id });
+        }
+        return {
+            sandboxId: typeof doc.sandboxId === 'string' ? doc.sandboxId : this.id,
+            port: typeof doc.port === 'number' ? doc.port : port,
+            url: doc.url,
+            browserUrl: typeof doc.browserUrl === 'string' ? doc.browserUrl : null,
+            public: doc.public,
+            publicExpiresAt: parseTime(doc.publicExpiresAt),
+        };
+    }
+    /** A port a preview link may name: 1 to 65 535, never 22 or 81 (the sandbox's own). */
+    previewPort(port) {
+        if (!Number.isInteger(port) || port < 1 || port > 65535 || port === 22 || port === 81) {
+            throw new PrizedError('bad_request', `port must be a whole number from 1 to 65535 other than 22 and 81, not ${String(port)}`, { sandboxId: this.id });
+        }
+    }
     // --- internals ------------------------------------------------------------------
     /** POST the verb, the call and its retries within `deadline`; with `hold`,
      *  held by the API until the sandbox is that (each attempt asks only for

package/dist/esm/shell.d.ts

@@ -11,7 +11,8 @@ export declare const RUN_ID_RE: RegExp;
 /**
  * Minutes (by the sandbox's clock) a cleaned or abandoned run's directory
  * stays: what keeps a resend of its start from running the command again.
- * The SDK stops resending a start within minutes, so an hour is ample; each
+ * The SDK stops resending a start once pollOutageMs (2 minutes by default)
+ * has run out after its first copy's retries, so an hour is ample; each
  * cleanup then removes the ones older than that, so they never pile up.
  */
 export declare const CLEANED_KEEP_MIN = 60;

package/dist/esm/shell.js

@@ -50,7 +50,8 @@ export const RUN_ID_RE = /^run_[0-9a-f]{16}$/;
 /**
  * Minutes (by the sandbox's clock) a cleaned or abandoned run's directory
  * stays: what keeps a resend of its start from running the command again.
- * The SDK stops resending a start within minutes, so an hour is ample; each
+ * The SDK stops resending a start once pollOutageMs (2 minutes by default)
+ * has run out after its first copy's retries, so an hour is ample; each
  * cleanup then removes the ones older than that, so they never pile up.
  */
 export const CLEANED_KEEP_MIN = 60;

package/dist/esm/toolbox.d.ts

@@ -30,6 +30,8 @@ export declare function rawExec(toolbox: Toolbox, req: RawExecRequest, options:
     deadline?: number | undefined;
     /** What the command does, for an error that says whether it happened (`exec`: a command unless given). */
     effect?: Effect | undefined;
+    /** An earlier copy of a keyed start may have reached the sandbox. */
+    acted?: boolean | undefined;
 }): Promise<ExecResult>;
 /** A helper command the SDK sends itself; a non-zero exit is the caller's to judge. */
 export declare function helperExec(toolbox: Toolbox, command: string, options?: {

package/dist/esm/toolbox.js

@@ -46,6 +46,7 @@ export async function rawExec(toolbox, req, options) {
         deadline: options.deadline,
         sandboxId: toolbox.sandboxId,
         ...(effect === undefined ? {} : { effect }),
+        ...(options.acted ? { acted: true } : {}),
     });
     const doc = result.json;
     if (doc === null || typeof doc !== 'object' || typeof doc.exitCode !== 'number') {

package/dist/esm/version.d.ts

@@ -1,2 +1,2 @@
 /** This package's version; test/version.test.ts holds it equal to package.json. */
-export declare const VERSION = "0.1.1";
+export declare const VERSION = "0.1.3";

package/dist/esm/version.js

@@ -1,2 +1,2 @@
 /** This package's version; test/version.test.ts holds it equal to package.json. */
-export const VERSION = '0.1.1';
+export const VERSION = '0.1.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prized/sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Prized Sandboxes (beta): create microVM sandboxes, run commands, move files, pause, resume and fork them from TypeScript.",
   "homepage": "https://prized.dev/docs/sandboxes",
   "license": "Apache-2.0",