@boatdev/sdk 1.0.0

package/.openapi-generator/FILES

@@ -0,0 +1,259 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+docs/AddEnvironmentRepoRequest.md
+docs/ApiKey.md
+docs/ApiKeyCatalog.md
+docs/ApiKeyCatalogScopeResources.md
+docs/ApiKeyCreatedResource.md
+docs/ApiKeyRequestUsage.md
+docs/ApiKeyResourceTotals.md
+docs/ApiKeyRevokeResponse.md
+docs/ApiKeyScope.md
+docs/ApiKeyScopeResource.md
+docs/ApiKeyScopeSandboxes.md
+docs/ApiKeySecretResponse.md
+docs/ApiKeyUsageResponse.md
+docs/ApiKeysResponse.md
+docs/BoatApi.md
+docs/Command200Response.md
+docs/CommandRequest.md
+docs/CommandResponse.md
+docs/CommandStartedResponse.md
+docs/CommandStatusResponse.md
+docs/CompletionEvent.md
+docs/Conversation.md
+docs/ConversationsResponse.md
+docs/CreateSandboxEnvironmentRequest.md
+docs/CreateSandboxRequest.md
+docs/CreateSandboxResponse.md
+docs/CreateScopedApiKey503Response.md
+docs/CreateScopedApiKeyRequest.md
+docs/DataRetentionPolicyResponse.md
+docs/DataRetentionUpdateRequest.md
+docs/DeletionOperation.md
+docs/DeletionOperationResponse.md
+docs/DesktopRequest.md
+docs/DesktopResponse.md
+docs/EnvironmentItemChangeResponse.md
+docs/ErrorEnvelope.md
+docs/ErrorEnvelopeError.md
+docs/ErrorEvent.md
+docs/EventsResponse.md
+docs/FileReadResponse.md
+docs/FileWriteRequest.md
+docs/FileWriteResponse.md
+docs/ForkRequest.md
+docs/HostPortRequest.md
+docs/HostPortResponse.md
+docs/LimitsFields.md
+docs/LimitsFieldsCurrentLimits.md
+docs/LimitsFieldsStartLimits.md
+docs/LimitsFieldsStarts.md
+docs/LimitsResponse.md
+docs/MeResponse.md
+docs/MeResponseAllOfUser.md
+docs/NamedSnapshot.md
+docs/NamedSnapshotDeletedResponse.md
+docs/NamedSnapshotInfoResponse.md
+docs/NamedSnapshotListResponse.md
+docs/NamedSnapshotSaveRequest.md
+docs/NamedSnapshotSavingResponse.md
+docs/PageInfo.md
+docs/PromptEvent.md
+docs/PromptEventData.md
+docs/PromptRequest.md
+docs/PromptResponse.md
+docs/PromptRun.md
+docs/PromptRunResponse.md
+docs/RepoSelectionRequest.md
+docs/RepoSelectionResponse.md
+docs/ReposResponse.md
+docs/Repository.md
+docs/RepositoryInstallation.md
+docs/ResponseEvent.md
+docs/ResponseEventData.md
+docs/ResumeRequest.md
+docs/RotateApiKey409Response.md
+docs/Sandbox.md
+docs/SandboxActionResponse.md
+docs/SandboxEnvironment.md
+docs/SandboxEnvironmentListResponse.md
+docs/SandboxEnvironmentResponse.md
+docs/SandboxEnvironmentVersionSummary.md
+docs/SandboxEvent.md
+docs/SandboxInfoResponse.md
+docs/SandboxListResponse.md
+docs/SandboxUsageResponse.md
+docs/SecretFile.md
+docs/SecretsResponse.md
+docs/SecretsUpdateRequest.md
+docs/SelectedRepository.md
+docs/SetEnvironmentSecretFileRequest.md
+docs/SetEnvironmentVarRequest.md
+docs/SnapshotChunk.md
+docs/SnapshotDownloadResponse.md
+docs/SnapshotDownloadResponseAllOfInventory.md
+docs/SnapshotLatestResponse.md
+docs/SnapshotListResponse.md
+docs/SnapshotSummary.md
+docs/SnapshotTreeEntry.md
+docs/SnapshotTreeResponse.md
+docs/SshKeyRequest.md
+docs/SshKeyResponse.md
+docs/StartWindowUsage.md
+docs/SteerEvent.md
+docs/SteerEventData.md
+docs/SteerRequest.md
+docs/SteerResponse.md
+docs/StopRequest.md
+docs/SuccessBase.md
+docs/UnknownEvent.md
+docs/UpdateSandboxEnvironmentRequest.md
+docs/UpdateSandboxEnvironmentRequestRepositoriesInner.md
+docs/UpdateSandboxRequest.md
+docs/UpgradeSandboxEnvironmentRequest.md
+docs/UpgradeSandboxEnvironmentResponse.md
+docs/Webhook.md
+docs/WebhookCreateRequest.md
+docs/WebhookDeleteResponse.md
+docs/WebhookEvent.md
+docs/WebhookEventData.md
+docs/WebhookEventDataSandbox.md
+docs/WebhookEventType.md
+docs/WebhookListResponse.md
+docs/WebhookResponse.md
+docs/WebhookSecretResponse.md
+docs/WebhookUpdateRequest.md
+package.json
+src/apis/BoatApi.ts
+src/apis/index.ts
+src/index.ts
+src/models/AddEnvironmentRepoRequest.ts
+src/models/ApiKey.ts
+src/models/ApiKeyCatalog.ts
+src/models/ApiKeyCatalogScopeResources.ts
+src/models/ApiKeyCreatedResource.ts
+src/models/ApiKeyRequestUsage.ts
+src/models/ApiKeyResourceTotals.ts
+src/models/ApiKeyRevokeResponse.ts
+src/models/ApiKeyScope.ts
+src/models/ApiKeyScopeResource.ts
+src/models/ApiKeyScopeSandboxes.ts
+src/models/ApiKeySecretResponse.ts
+src/models/ApiKeyUsageResponse.ts
+src/models/ApiKeysResponse.ts
+src/models/Command200Response.ts
+src/models/CommandRequest.ts
+src/models/CommandResponse.ts
+src/models/CommandStartedResponse.ts
+src/models/CommandStatusResponse.ts
+src/models/CompletionEvent.ts
+src/models/Conversation.ts
+src/models/ConversationsResponse.ts
+src/models/CreateSandboxEnvironmentRequest.ts
+src/models/CreateSandboxRequest.ts
+src/models/CreateSandboxResponse.ts
+src/models/CreateScopedApiKey503Response.ts
+src/models/CreateScopedApiKeyRequest.ts
+src/models/DataRetentionPolicyResponse.ts
+src/models/DataRetentionUpdateRequest.ts
+src/models/DeletionOperation.ts
+src/models/DeletionOperationResponse.ts
+src/models/DesktopRequest.ts
+src/models/DesktopResponse.ts
+src/models/EnvironmentItemChangeResponse.ts
+src/models/ErrorEnvelope.ts
+src/models/ErrorEnvelopeError.ts
+src/models/ErrorEvent.ts
+src/models/EventsResponse.ts
+src/models/FileReadResponse.ts
+src/models/FileWriteRequest.ts
+src/models/FileWriteResponse.ts
+src/models/ForkRequest.ts
+src/models/HostPortRequest.ts
+src/models/HostPortResponse.ts
+src/models/LimitsFields.ts
+src/models/LimitsFieldsCurrentLimits.ts
+src/models/LimitsFieldsStartLimits.ts
+src/models/LimitsFieldsStarts.ts
+src/models/LimitsResponse.ts
+src/models/MeResponse.ts
+src/models/MeResponseAllOfUser.ts
+src/models/NamedSnapshot.ts
+src/models/NamedSnapshotDeletedResponse.ts
+src/models/NamedSnapshotInfoResponse.ts
+src/models/NamedSnapshotListResponse.ts
+src/models/NamedSnapshotSaveRequest.ts
+src/models/NamedSnapshotSavingResponse.ts
+src/models/PageInfo.ts
+src/models/PromptEvent.ts
+src/models/PromptEventData.ts
+src/models/PromptRequest.ts
+src/models/PromptResponse.ts
+src/models/PromptRun.ts
+src/models/PromptRunResponse.ts
+src/models/RepoSelectionRequest.ts
+src/models/RepoSelectionResponse.ts
+src/models/ReposResponse.ts
+src/models/Repository.ts
+src/models/RepositoryInstallation.ts
+src/models/ResponseEvent.ts
+src/models/ResponseEventData.ts
+src/models/ResumeRequest.ts
+src/models/RotateApiKey409Response.ts
+src/models/Sandbox.ts
+src/models/SandboxActionResponse.ts
+src/models/SandboxEnvironment.ts
+src/models/SandboxEnvironmentListResponse.ts
+src/models/SandboxEnvironmentResponse.ts
+src/models/SandboxEnvironmentVersionSummary.ts
+src/models/SandboxEvent.ts
+src/models/SandboxInfoResponse.ts
+src/models/SandboxListResponse.ts
+src/models/SandboxUsageResponse.ts
+src/models/SecretFile.ts
+src/models/SecretsResponse.ts
+src/models/SecretsUpdateRequest.ts
+src/models/SelectedRepository.ts
+src/models/SetEnvironmentSecretFileRequest.ts
+src/models/SetEnvironmentVarRequest.ts
+src/models/SnapshotChunk.ts
+src/models/SnapshotDownloadResponse.ts
+src/models/SnapshotDownloadResponseAllOfInventory.ts
+src/models/SnapshotLatestResponse.ts
+src/models/SnapshotListResponse.ts
+src/models/SnapshotSummary.ts
+src/models/SnapshotTreeEntry.ts
+src/models/SnapshotTreeResponse.ts
+src/models/SshKeyRequest.ts
+src/models/SshKeyResponse.ts
+src/models/StartWindowUsage.ts
+src/models/SteerEvent.ts
+src/models/SteerEventData.ts
+src/models/SteerRequest.ts
+src/models/SteerResponse.ts
+src/models/StopRequest.ts
+src/models/SuccessBase.ts
+src/models/UnknownEvent.ts
+src/models/UpdateSandboxEnvironmentRequest.ts
+src/models/UpdateSandboxEnvironmentRequestRepositoriesInner.ts
+src/models/UpdateSandboxRequest.ts
+src/models/UpgradeSandboxEnvironmentRequest.ts
+src/models/UpgradeSandboxEnvironmentResponse.ts
+src/models/Webhook.ts
+src/models/WebhookCreateRequest.ts
+src/models/WebhookDeleteResponse.ts
+src/models/WebhookEvent.ts
+src/models/WebhookEventData.ts
+src/models/WebhookEventDataSandbox.ts
+src/models/WebhookEventType.ts
+src/models/WebhookListResponse.ts
+src/models/WebhookResponse.ts
+src/models/WebhookSecretResponse.ts
+src/models/WebhookUpdateRequest.ts
+src/models/index.ts
+src/runtime.ts
+tsconfig.esm.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.22.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Ascii
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,151 @@
+# @boatdev/sdk
+
+Use Boat from your application code.
+
+## Install
+
+```bash
+npm install @boatdev/sdk
+```
+
+## Links
+
+- SDK docs: https://docs.boat.dev/sdks
+- API reference: https://docs.boat.dev/api/reference
+- Dashboard: https://boat.dev/dashboard
+- API keys: https://boat.dev/dashboard?tab=api-keys
+
+## Flow
+
+1. Create an API key in the Boat dashboard.
+2. Create or resume a sandbox.
+3. Prompt the sandbox.
+4. Read events until the work is done.
+5. Open desktop access when you need browser or GUI visibility.
+6. Stop, resume, fork, or delete the sandbox according to your retention policy.
+
+## Notes
+
+- Put cleanup in `finally`: stop/archive or delete sandboxes you create for tests.
+- Treat API key secrets, Boat secrets, SSH keys, and desktop stream URLs as sensitive.
+- `updateSecrets` / `update_secrets` replaces the entire secret setup. Read the current setup first and send every env var and secret file that should remain.
+- `rotateApiKey` / `rotate_api_key` rotates the raw secret in place. Store the returned secret immediately; it is shown once.
+- Repository selection is idempotent. Selecting an already-selected repository updates its base branch.
+
+## Example
+
+### TypeScript
+
+```ts
+import { BoatApi, Configuration } from "@boatdev/sdk";
+
+const sandbox = new BoatApi(new Configuration({
+  basePath: process.env.BOAT_BASE_URL ?? "https://boat.dev/api/v1",
+  accessToken: process.env.BOAT_API_KEY ?? (() => {
+    throw new Error("Set BOAT_API_KEY from the Boat dashboard API keys tab.");
+  })(),
+}));
+
+async function main() {
+  let sandboxId: string | undefined;
+
+  try {
+    const created = await sandbox.create({
+      createSandboxRequest: {
+        ttlSeconds: 1800,
+      },
+    });
+
+    sandboxId = created.sandbox.id;
+
+    await sandbox.update({
+      sandboxId,
+      updateSandboxRequest: { name: "sdk-demo" },
+    });
+
+    while (!["ready", "idle"].includes((await sandbox.get({ sandboxId })).sandbox.state)) {
+      await new Promise((resolve) => setTimeout(resolve, 2000));
+    }
+
+    await sandbox.prompt({
+      sandboxId,
+      promptRequest: {
+        prompt: "Inspect the repository and summarize the test command.",
+        provider: "codex",
+      },
+    });
+
+    const events = await sandbox.events({ sandboxId });
+    console.log(events.events);
+  } finally {
+    if (sandboxId) {
+      await sandbox.stop({ sandboxId });
+    }
+  }
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});
+```
+
+### JavaScript
+
+```js
+const { BoatApi, Configuration } = require("@boatdev/sdk");
+
+const sandbox = new BoatApi(new Configuration({
+  basePath: process.env.BOAT_BASE_URL || "https://boat.dev/api/v1",
+  accessToken: process.env.BOAT_API_KEY || (() => {
+    throw new Error("Set BOAT_API_KEY from the Boat dashboard API keys tab.");
+  })(),
+}));
+
+async function main() {
+  let sandboxId;
+
+  try {
+    const created = await sandbox.create({
+      createSandboxRequest: {
+        ttlSeconds: 1800,
+      },
+    });
+
+    sandboxId = created.sandbox.id;
+
+    await sandbox.update({
+      sandboxId,
+      updateSandboxRequest: { name: "sdk-demo" },
+    });
+
+    while (!["ready", "idle"].includes((await sandbox.get({ sandboxId })).sandbox.state)) {
+      await new Promise((resolve) => setTimeout(resolve, 2000));
+    }
+
+    await sandbox.prompt({
+      sandboxId,
+      promptRequest: {
+        prompt: "Inspect the repository and summarize the test command.",
+        provider: "codex",
+      },
+    });
+
+    const events = await sandbox.events({ sandboxId });
+    console.log(events.events);
+  } finally {
+    if (sandboxId) {
+      await sandbox.stop({ sandboxId });
+    }
+  }
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});
+```
+
+## License
+
+This SDK is MIT licensed. Boat, the Boat API, the Boat CLI, and the sandbox product are proprietary.