@boatdev/sdk 1.4.0 → 1.6.0

package/src/boat-helpers.ts

@@ -182,8 +182,34 @@ export async function writeText(api: BoatApi, sandboxId: string, path: string, c
   return api.writeFile({ sandboxId, fileWriteRequest: { path, content, encoding: 'utf8' } });
 }
 
+// A refusal that provably never ran the command (the sandbox is still restoring
+// its disk, `retryable: true`) is retried for this long.
+const STREAM_RETRY_MS = 60_000;
+
+async function isRetryable(e: unknown): Promise<boolean> {
+  const response = (e as { response?: Response })?.response;
+  if (!response) return false;
+  const body = await response.clone().json().catch(() => undefined);
+  return body?.retryable === true;
+}
+
+/**
+ * Run a command and return its result.
+ *
+ * Safe to call right after `resume()`: a refusal that never ran the command
+ * (`retryable: true`, the sandbox is still restoring) is resent for up to 60 s.
+ */
 export async function execCommand(api: BoatApi, sandboxId: string, command: string, cwd?: string, timeoutSeconds = 30) {
-  return api.command({ sandboxId, commandRequest: { command, cwd, timeoutSeconds } });
+  const deadline = Date.now() + STREAM_RETRY_MS;
+  for (;;) {
+    try {
+      return await api.command({ sandboxId, commandRequest: { command, cwd, timeoutSeconds } });
+    } catch (e) {
+      // The 1 s pause before the resend must also fit before the deadline.
+      if (Date.now() + 1_000 >= deadline || !(await isRetryable(e))) throw e;
+    }
+    await delay(1_000);
+  }
 }
 
 /** One line of a streamed command, as sent (an `exit` frame also carries e.g. `signal`, `oomKilled`). */
@@ -195,10 +221,6 @@ export type StreamCommandOptions = {
   signal?: AbortSignal;
 };
 
-// A refusal that provably never ran the command (the sandbox is still restoring
-// its disk, `retryable: true` before `started`) is retried for this long.
-const STREAM_RETRY_MS = 60_000;
-
 async function* ndjsonFrames(response: Response): AsyncGenerator<CommandFrame> {
   if (!response.body) throw new Error('The command stream has no body');
   const reader = response.body.getReader();

package/src/models/NamedSnapshotAllowance.ts

@@ -0,0 +1,121 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * What the request's wallet (your active organization, `?org=`, or personal) pays for named snapshots. 10 are free per wallet; each one above costs $1.70 a month, charged daily from usage. An organization's count includes every member's names billed to it.
+ * @export
+ * @interface NamedSnapshotAllowance
+ */
+export interface NamedSnapshotAllowance {
+    /**
+     * Organization the numbers are for. null = personal.
+     * @type {string}
+     * @memberof NamedSnapshotAllowance
+     */
+    org?: string | null;
+    /**
+     * That organization's name.
+     * @type {string}
+     * @memberof NamedSnapshotAllowance
+     */
+    orgName?: string | null;
+    /**
+     * Named snapshots kept for free.
+     * @type {number}
+     * @memberof NamedSnapshotAllowance
+     */
+    free?: number;
+    /**
+     * Named snapshots this wallet keeps.
+     * @type {number}
+     * @memberof NamedSnapshotAllowance
+     */
+    used?: number;
+    /**
+     * Named snapshots above the free ones.
+     * @type {number}
+     * @memberof NamedSnapshotAllowance
+     */
+    extra?: number;
+    /**
+     * What the extra ones cost per month.
+     * @type {number}
+     * @memberof NamedSnapshotAllowance
+     */
+    extraMonthlyDollars?: number;
+    /**
+     * Boat time the extra ones take per day, in dollars (the daily charge).
+     * @type {number}
+     * @memberof NamedSnapshotAllowance
+     */
+    extraDailyDollars?: number;
+    /**
+     * Monthly price of one extra named snapshot.
+     * @type {number}
+     * @memberof NamedSnapshotAllowance
+     */
+    pricePerExtraMonthlyDollars?: number;
+}
+
+/**
+ * Check if a given object implements the NamedSnapshotAllowance interface.
+ */
+export function instanceOfNamedSnapshotAllowance(value: object): value is NamedSnapshotAllowance {
+    return true;
+}
+
+export function NamedSnapshotAllowanceFromJSON(json: any): NamedSnapshotAllowance {
+    return NamedSnapshotAllowanceFromJSONTyped(json, false);
+}
+
+export function NamedSnapshotAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamedSnapshotAllowance {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'org': json['org'] == null ? undefined : json['org'],
+        'orgName': json['orgName'] == null ? undefined : json['orgName'],
+        'free': json['free'] == null ? undefined : json['free'],
+        'used': json['used'] == null ? undefined : json['used'],
+        'extra': json['extra'] == null ? undefined : json['extra'],
+        'extraMonthlyDollars': json['extraMonthlyDollars'] == null ? undefined : json['extraMonthlyDollars'],
+        'extraDailyDollars': json['extraDailyDollars'] == null ? undefined : json['extraDailyDollars'],
+        'pricePerExtraMonthlyDollars': json['pricePerExtraMonthlyDollars'] == null ? undefined : json['pricePerExtraMonthlyDollars'],
+    };
+}
+
+export function NamedSnapshotAllowanceToJSON(json: any): NamedSnapshotAllowance {
+    return NamedSnapshotAllowanceToJSONTyped(json, false);
+}
+
+export function NamedSnapshotAllowanceToJSONTyped(value?: NamedSnapshotAllowance | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'org': value['org'],
+        'orgName': value['orgName'],
+        'free': value['free'],
+        'used': value['used'],
+        'extra': value['extra'],
+        'extraMonthlyDollars': value['extraMonthlyDollars'],
+        'extraDailyDollars': value['extraDailyDollars'],
+        'pricePerExtraMonthlyDollars': value['pricePerExtraMonthlyDollars'],
+    };
+}
+

package/src/models/NamedSnapshotListResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { NamedSnapshotAllowance } from './NamedSnapshotAllowance';
+import {
+    NamedSnapshotAllowanceFromJSON,
+    NamedSnapshotAllowanceFromJSONTyped,
+    NamedSnapshotAllowanceToJSON,
+    NamedSnapshotAllowanceToJSONTyped,
+} from './NamedSnapshotAllowance';
 import type { NamedSnapshot } from './NamedSnapshot';
 import {
     NamedSnapshotFromJSON,
@@ -45,6 +52,12 @@ export interface NamedSnapshotListResponse {
      * @memberof NamedSnapshotListResponse
      */
     snapshots: Array<NamedSnapshot>;
+    /**
+     * 
+     * @type {NamedSnapshotAllowance}
+     * @memberof NamedSnapshotListResponse
+     */
+    allowance?: NamedSnapshotAllowance;
 }
 
 
@@ -80,6 +93,7 @@ export function NamedSnapshotListResponseFromJSONTyped(json: any, ignoreDiscrimi
         'ok': json['ok'],
         'type': json['type'],
         'snapshots': ((json['snapshots'] as Array<any>).map(NamedSnapshotFromJSON)),
+        'allowance': json['allowance'] == null ? undefined : NamedSnapshotAllowanceFromJSON(json['allowance']),
     };
 }
 
@@ -97,6 +111,7 @@ export function NamedSnapshotListResponseToJSONTyped(value?: NamedSnapshotListRe
         'ok': value['ok'],
         'type': value['type'],
         'snapshots': ((value['snapshots'] as Array<any>).map(NamedSnapshotToJSON)),
+        'allowance': NamedSnapshotAllowanceToJSON(value['allowance']),
     };
 }
 

package/src/models/PromptRequest.ts

@@ -44,6 +44,12 @@ export interface PromptRequest {
      * @memberof PromptRequest
      */
     reasoningEffort?: string | null;
+    /**
+     * Optional. `true` runs this prompt in fast mode. The model stays the same and gives output faster. The provider bills fast mode at its higher fast rate. Omit to use the choice saved on the Agents dashboard for that model. `false` forces standard speed. Only models with `fastMode` set to `true` in `GET /provider-models` accept `true`. Other models return 400 `fast_mode_not_supported`.
+     * @type {boolean}
+     * @memberof PromptRequest
+     */
+    fast?: boolean | null;
     /**
      * Start a NEW conversation on the sandbox (runs in parallel with any existing ones) instead of continuing the most-recently-active one. Mutually exclusive with `conversationId`.
      * @type {boolean}
@@ -104,6 +110,7 @@ export function PromptRequestFromJSONTyped(json: any, ignoreDiscriminator: boole
         'provider': json['provider'],
         'model': json['model'] == null ? undefined : json['model'],
         'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        'fast': json['fast'] == null ? undefined : json['fast'],
         '_new': json['new'] == null ? undefined : json['new'],
         'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
         'prompt': json['prompt'],
@@ -124,6 +131,7 @@ export function PromptRequestToJSONTyped(value?: PromptRequest | null, ignoreDis
         'provider': value['provider'],
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
         'new': value['_new'],
         'conversationId': value['conversationId'],
         'prompt': value['prompt'],

package/src/models/PromptResponse.ts

@@ -87,6 +87,12 @@ export interface PromptResponse {
      * @memberof PromptResponse
      */
     reasoningEffort?: string | null;
+    /**
+     * The prompt runs in fast mode.
+     * @type {boolean}
+     * @memberof PromptResponse
+     */
+    fast?: boolean;
 }
 
 
@@ -141,6 +147,7 @@ export function PromptResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'provider': json['provider'],
         'model': json['model'] == null ? undefined : json['model'],
         'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        'fast': json['fast'] == null ? undefined : json['fast'],
     };
 }
 
@@ -165,6 +172,7 @@ export function PromptResponseToJSONTyped(value?: PromptResponse | null, ignoreD
         'provider': value['provider'],
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
     };
 }
 

package/src/models/PromptRun.ts

@@ -67,6 +67,12 @@ export interface PromptRun {
      * @memberof PromptRun
      */
     reasoningEffort?: string | null;
+    /**
+     * The prompt runs in fast mode. `null` means no speed is set yet. The prompt waits without a speed choice, or it ended without running (`done` is true). The speed is set when the prompt starts, for the model that runs.
+     * @type {boolean}
+     * @memberof PromptRun
+     */
+    fast?: boolean | null;
     /**
      * The conversation this prompt ran in. A Sandbox runs many conversations in parallel; see [Integrated agents](/integrated-agents).
      * @type {string}
@@ -120,6 +126,7 @@ export function PromptRunFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'model': json['model'] == null ? undefined : json['model'],
         'reasoningEffort': json['reasoningEffort'] == null ? undefined : json['reasoningEffort'],
+        'fast': json['fast'] == null ? undefined : json['fast'],
         'conversationId': json['conversationId'] == null ? undefined : json['conversationId'],
     };
 }
@@ -143,6 +150,7 @@ export function PromptRunToJSONTyped(value?: PromptRun | null, ignoreDiscriminat
         'createdAt': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
         'model': value['model'],
         'reasoningEffort': value['reasoningEffort'],
+        'fast': value['fast'],
         'conversationId': value['conversationId'],
     };
 }

package/src/models/Sandbox.ts

@@ -177,6 +177,36 @@ export interface Sandbox {
      * @memberof Sandbox
      */
     team?: SandboxTeam;
+    /**
+     * Display name (or email) of the person who created the sandbox. Organization members see every sandbox the organization pays for, so this says whose it is.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    createdBy?: string | null;
+    /**
+     * Account id of the person who created the sandbox.
+     * @type {string}
+     * @memberof Sandbox
+     */
+    createdById?: string | null;
+    /**
+     * What you may do with this sandbox. `owner`: you created it. `use`: a teammate's organization sandbox that is `noEnv` (created with it, or shared and restarted), so you can open, run commands in, prompt, resume and stop it. `view`: a teammate's organization sandbox that still holds their personal logins, so you can see it and stop it until they share it (`POST /sandboxes/{sandboxId}/share`).
+     * @type {SandboxAccessEnum}
+     * @memberof Sandbox
+     */
+    access?: SandboxAccessEnum;
+    /**
+     * True while the sandbox still holds its creator's personal logins (GitHub token, model logins, secrets). Other members can only see such a sandbox.
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    holdsCreatorLogins?: boolean;
+    /**
+     * True once the sandbox is shared but not restarted yet. Its creator's logins are wiped at its next start, and the organization can use it from then on.
+     * @type {boolean}
+     * @memberof Sandbox
+     */
+    wipePendingUntilRestart?: boolean;
     /**
      * The sandbox's stable three-word subdomain slug (e.g. "frazil-pneuma-rallye"), or null before one is assigned.
      * @type {string}
@@ -268,6 +298,16 @@ export const SandboxMachineProviderEnum = {
 } as const;
 export type SandboxMachineProviderEnum = typeof SandboxMachineProviderEnum[keyof typeof SandboxMachineProviderEnum];
 
+/**
+ * @export
+ */
+export const SandboxAccessEnum = {
+    Owner: 'owner',
+    Use: 'use',
+    View: 'view'
+} as const;
+export type SandboxAccessEnum = typeof SandboxAccessEnum[keyof typeof SandboxAccessEnum];
+
 /**
  * @export
  */
@@ -339,6 +379,11 @@ export function SandboxFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
         'snapshotCompletedAt': json['snapshotCompletedAt'] == null ? undefined : (new Date(json['snapshotCompletedAt'])),
         'snapshotVerifiedAt': json['snapshotVerifiedAt'] == null ? undefined : (new Date(json['snapshotVerifiedAt'])),
         'team': json['team'] == null ? undefined : SandboxTeamFromJSON(json['team']),
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'createdById': json['createdById'] == null ? undefined : json['createdById'],
+        'access': json['access'] == null ? undefined : json['access'],
+        'holdsCreatorLogins': json['holdsCreatorLogins'] == null ? undefined : json['holdsCreatorLogins'],
+        'wipePendingUntilRestart': json['wipePendingUntilRestart'] == null ? undefined : json['wipePendingUntilRestart'],
         'subdomain': json['subdomain'] == null ? undefined : json['subdomain'],
         'lastSnapshotAttemptAt': json['lastSnapshotAttemptAt'] == null ? undefined : (new Date(json['lastSnapshotAttemptAt'])),
         'lastSnapshotStatus': json['lastSnapshotStatus'] == null ? undefined : json['lastSnapshotStatus'],
@@ -385,6 +430,11 @@ export function SandboxToJSONTyped(value?: Sandbox | null, ignoreDiscriminator:
         'snapshotCompletedAt': value['snapshotCompletedAt'] == null ? value['snapshotCompletedAt'] : value['snapshotCompletedAt'].toISOString(),
         'snapshotVerifiedAt': value['snapshotVerifiedAt'] == null ? value['snapshotVerifiedAt'] : value['snapshotVerifiedAt'].toISOString(),
         'team': SandboxTeamToJSON(value['team']),
+        'createdBy': value['createdBy'],
+        'createdById': value['createdById'],
+        'access': value['access'],
+        'holdsCreatorLogins': value['holdsCreatorLogins'],
+        'wipePendingUntilRestart': value['wipePendingUntilRestart'],
         'subdomain': value['subdomain'],
         'lastSnapshotAttemptAt': value['lastSnapshotAttemptAt'] == null ? value['lastSnapshotAttemptAt'] : value['lastSnapshotAttemptAt'].toISOString(),
         'lastSnapshotStatus': value['lastSnapshotStatus'],

package/src/models/Share200Response.ts

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Boat Public API v1
+ * Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { Sandbox } from './Sandbox';
+import {
+    SandboxFromJSON,
+    SandboxFromJSONTyped,
+    SandboxToJSON,
+    SandboxToJSONTyped,
+} from './Sandbox';
+
+/**
+ * 
+ * @export
+ * @interface Share200Response
+ */
+export interface Share200Response {
+    /**
+     * 
+     * @type {Sandbox}
+     * @memberof Share200Response
+     */
+    sandbox?: Sandbox;
+    /**
+     * True when the sandbox was running: what runs on it still holds your logins in memory, so it stays `view` for the organization until you stop and resume it.
+     * @type {boolean}
+     * @memberof Share200Response
+     */
+    restartRequired?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Share200Response
+     */
+    message?: string;
+}
+
+/**
+ * Check if a given object implements the Share200Response interface.
+ */
+export function instanceOfShare200Response(value: object): value is Share200Response {
+    return true;
+}
+
+export function Share200ResponseFromJSON(json: any): Share200Response {
+    return Share200ResponseFromJSONTyped(json, false);
+}
+
+export function Share200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Share200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sandbox': json['sandbox'] == null ? undefined : SandboxFromJSON(json['sandbox']),
+        'restartRequired': json['restartRequired'] == null ? undefined : json['restartRequired'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function Share200ResponseToJSON(json: any): Share200Response {
+    return Share200ResponseToJSONTyped(json, false);
+}
+
+export function Share200ResponseToJSONTyped(value?: Share200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sandbox': SandboxToJSON(value['sandbox']),
+        'restartRequired': value['restartRequired'],
+        'message': value['message'],
+    };
+}
+

package/src/models/index.ts

@@ -59,6 +59,7 @@ export * from './LimitsResponse';
 export * from './MeResponse';
 export * from './MeResponseAllOfUser';
 export * from './NamedSnapshot';
+export * from './NamedSnapshotAllowance';
 export * from './NamedSnapshotDeletedResponse';
 export * from './NamedSnapshotInfoResponse';
 export * from './NamedSnapshotListResponse';
@@ -101,6 +102,7 @@ export * from './SecretsUpdateRequest';
 export * from './SelectedRepository';
 export * from './SetEnvironmentSecretFileRequest';
 export * from './SetEnvironmentVarRequest';
+export * from './Share200Response';
 export * from './SnapshotChunk';
 export * from './SnapshotDownloadResponse';
 export * from './SnapshotDownloadResponseAllOfInventory';