@boatdev/sdk 1.0.0

package/dist/models/CommandStartedResponse.d.ts

@@ -0,0 +1,93 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CommandStartedResponse
+ */
+export interface CommandStartedResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandStartedResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {CommandStartedResponseTypeEnum}
+     * @memberof CommandStartedResponse
+     */
+    type: CommandStartedResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandStartedResponse
+     */
+    success: boolean;
+    /**
+     * Process id to poll with the command status endpoint.
+     * @type {number}
+     * @memberof CommandStartedResponse
+     */
+    processId: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CommandStartedResponse
+     */
+    pid: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    command: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    cwd?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CommandStartedResponse
+     */
+    startedAt: Date;
+    /**
+     * Stdout log file on the sandbox (~/.ascii/processes/<pid>.log).
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    logPath?: string;
+    /**
+     * Stderr log file on the sandbox.
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    errLogPath?: string;
+}
+/**
+ * @export
+ */
+export declare const CommandStartedResponseTypeEnum: {
+    readonly CommandStarted: 'command.started';
+};
+export type CommandStartedResponseTypeEnum = typeof CommandStartedResponseTypeEnum[keyof typeof CommandStartedResponseTypeEnum];
+/**
+ * Check if a given object implements the CommandStartedResponse interface.
+ */
+export declare function instanceOfCommandStartedResponse(value: object): value is CommandStartedResponse;
+export declare function CommandStartedResponseFromJSON(json: any): CommandStartedResponse;
+export declare function CommandStartedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandStartedResponse;
+export declare function CommandStartedResponseToJSON(json: any): CommandStartedResponse;
+export declare function CommandStartedResponseToJSONTyped(value?: CommandStartedResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CommandStartedResponse.js

@@ -0,0 +1,87 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandStartedResponseTypeEnum = void 0;
+exports.instanceOfCommandStartedResponse = instanceOfCommandStartedResponse;
+exports.CommandStartedResponseFromJSON = CommandStartedResponseFromJSON;
+exports.CommandStartedResponseFromJSONTyped = CommandStartedResponseFromJSONTyped;
+exports.CommandStartedResponseToJSON = CommandStartedResponseToJSON;
+exports.CommandStartedResponseToJSONTyped = CommandStartedResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.CommandStartedResponseTypeEnum = {
+    CommandStarted: 'command.started'
+};
+/**
+ * Check if a given object implements the CommandStartedResponse interface.
+ */
+function instanceOfCommandStartedResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('processId' in value) || value['processId'] === undefined)
+        return false;
+    if (!('pid' in value) || value['pid'] === undefined)
+        return false;
+    if (!('command' in value) || value['command'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    return true;
+}
+function CommandStartedResponseFromJSON(json) {
+    return CommandStartedResponseFromJSONTyped(json, false);
+}
+function CommandStartedResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'processId': json['processId'],
+        'pid': json['pid'],
+        'command': json['command'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'startedAt': (new Date(json['startedAt'])),
+        'logPath': json['logPath'] == null ? undefined : json['logPath'],
+        'errLogPath': json['errLogPath'] == null ? undefined : json['errLogPath'],
+    };
+}
+function CommandStartedResponseToJSON(json) {
+    return CommandStartedResponseToJSONTyped(json, false);
+}
+function CommandStartedResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'processId': value['processId'],
+        'pid': value['pid'],
+        'command': value['command'],
+        'cwd': value['cwd'],
+        'startedAt': value['startedAt'].toISOString(),
+        'logPath': value['logPath'],
+        'errLogPath': value['errLogPath'],
+    };
+}

package/dist/models/CommandStatusResponse.d.ts

@@ -0,0 +1,162 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CommandStatusResponse
+ */
+export interface CommandStatusResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {CommandStatusResponseTypeEnum}
+     * @memberof CommandStatusResponse
+     */
+    type: CommandStatusResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    success: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof CommandStatusResponse
+     */
+    processId: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CommandStatusResponse
+     */
+    pid?: number;
+    /**
+     * lost: the sandbox agent restarted and forgot the process; running/exitCode are then a best-effort probe and the logs come from the on-disk files.
+     * @type {CommandStatusResponseStatusEnum}
+     * @memberof CommandStatusResponse
+     */
+    status: CommandStatusResponseStatusEnum;
+    /**
+     * Whether the process is still tracked by the sandbox agent.
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    known?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    running: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof CommandStatusResponse
+     */
+    exitCode: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    signal?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    command?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    cwd?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CommandStatusResponse
+     */
+    startedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CommandStatusResponse
+     */
+    finishedAt?: Date | null;
+    /**
+     * Tail of the stdout log file.
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    stdout: string;
+    /**
+     * Tail of the stderr log file.
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    stderr: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    stdoutTruncated?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandStatusResponse
+     */
+    stderrTruncated?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    logPath?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandStatusResponse
+     */
+    errLogPath?: string;
+}
+/**
+ * @export
+ */
+export declare const CommandStatusResponseTypeEnum: {
+    readonly CommandStatus: 'command.status';
+};
+export type CommandStatusResponseTypeEnum = typeof CommandStatusResponseTypeEnum[keyof typeof CommandStatusResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const CommandStatusResponseStatusEnum: {
+    readonly Running: 'running';
+    readonly Exited: 'exited';
+    readonly Lost: 'lost';
+};
+export type CommandStatusResponseStatusEnum = typeof CommandStatusResponseStatusEnum[keyof typeof CommandStatusResponseStatusEnum];
+/**
+ * Check if a given object implements the CommandStatusResponse interface.
+ */
+export declare function instanceOfCommandStatusResponse(value: object): value is CommandStatusResponse;
+export declare function CommandStatusResponseFromJSON(json: any): CommandStatusResponse;
+export declare function CommandStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandStatusResponse;
+export declare function CommandStatusResponseToJSON(json: any): CommandStatusResponse;
+export declare function CommandStatusResponseToJSONTyped(value?: CommandStatusResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CommandStatusResponse.js

@@ -0,0 +1,119 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandStatusResponseStatusEnum = exports.CommandStatusResponseTypeEnum = void 0;
+exports.instanceOfCommandStatusResponse = instanceOfCommandStatusResponse;
+exports.CommandStatusResponseFromJSON = CommandStatusResponseFromJSON;
+exports.CommandStatusResponseFromJSONTyped = CommandStatusResponseFromJSONTyped;
+exports.CommandStatusResponseToJSON = CommandStatusResponseToJSON;
+exports.CommandStatusResponseToJSONTyped = CommandStatusResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.CommandStatusResponseTypeEnum = {
+    CommandStatus: 'command.status'
+};
+/**
+ * @export
+ */
+exports.CommandStatusResponseStatusEnum = {
+    Running: 'running',
+    Exited: 'exited',
+    Lost: 'lost'
+};
+/**
+ * Check if a given object implements the CommandStatusResponse interface.
+ */
+function instanceOfCommandStatusResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('success' in value) || value['success'] === undefined)
+        return false;
+    if (!('processId' in value) || value['processId'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('running' in value) || value['running'] === undefined)
+        return false;
+    if (!('exitCode' in value) || value['exitCode'] === undefined)
+        return false;
+    if (!('stdout' in value) || value['stdout'] === undefined)
+        return false;
+    if (!('stderr' in value) || value['stderr'] === undefined)
+        return false;
+    return true;
+}
+function CommandStatusResponseFromJSON(json) {
+    return CommandStatusResponseFromJSONTyped(json, false);
+}
+function CommandStatusResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'processId': json['processId'],
+        'pid': json['pid'] == null ? undefined : json['pid'],
+        'status': json['status'],
+        'known': json['known'] == null ? undefined : json['known'],
+        'running': json['running'],
+        'exitCode': json['exitCode'],
+        'signal': json['signal'] == null ? undefined : json['signal'],
+        'command': json['command'] == null ? undefined : json['command'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'startedAt': json['startedAt'] == null ? undefined : (new Date(json['startedAt'])),
+        'finishedAt': json['finishedAt'] == null ? undefined : (new Date(json['finishedAt'])),
+        'stdout': json['stdout'],
+        'stderr': json['stderr'],
+        'stdoutTruncated': json['stdoutTruncated'] == null ? undefined : json['stdoutTruncated'],
+        'stderrTruncated': json['stderrTruncated'] == null ? undefined : json['stderrTruncated'],
+        'logPath': json['logPath'] == null ? undefined : json['logPath'],
+        'errLogPath': json['errLogPath'] == null ? undefined : json['errLogPath'],
+    };
+}
+function CommandStatusResponseToJSON(json) {
+    return CommandStatusResponseToJSONTyped(json, false);
+}
+function CommandStatusResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'processId': value['processId'],
+        'pid': value['pid'],
+        'status': value['status'],
+        'known': value['known'],
+        'running': value['running'],
+        'exitCode': value['exitCode'],
+        'signal': value['signal'],
+        'command': value['command'],
+        'cwd': value['cwd'],
+        'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
+        'finishedAt': value['finishedAt'] == null ? value['finishedAt'] : value['finishedAt'].toISOString(),
+        'stdout': value['stdout'],
+        'stderr': value['stderr'],
+        'stdoutTruncated': value['stdoutTruncated'],
+        'stderrTruncated': value['stderrTruncated'],
+        'logPath': value['logPath'],
+        'errLogPath': value['errLogPath'],
+    };
+}

package/dist/models/CompletionEvent.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CompletionEvent
+ */
+export interface CompletionEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof CompletionEvent
+     */
+    id: string;
+    /**
+     *
+     * @type {CompletionEventTypeEnum}
+     * @memberof CompletionEvent
+     */
+    type: CompletionEventTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof CompletionEvent
+     */
+    timestamp: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompletionEvent
+     */
+    taskId?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof CompletionEvent
+     */
+    data: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const CompletionEventTypeEnum: {
+    readonly CompactionComplete: 'compaction_complete';
+};
+export type CompletionEventTypeEnum = typeof CompletionEventTypeEnum[keyof typeof CompletionEventTypeEnum];
+/**
+ * Check if a given object implements the CompletionEvent interface.
+ */
+export declare function instanceOfCompletionEvent(value: object): value is CompletionEvent;
+export declare function CompletionEventFromJSON(json: any): CompletionEvent;
+export declare function CompletionEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): CompletionEvent;
+export declare function CompletionEventToJSON(json: any): CompletionEvent;
+export declare function CompletionEventToJSONTyped(value?: CompletionEvent | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CompletionEvent.js

@@ -0,0 +1,71 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompletionEventTypeEnum = void 0;
+exports.instanceOfCompletionEvent = instanceOfCompletionEvent;
+exports.CompletionEventFromJSON = CompletionEventFromJSON;
+exports.CompletionEventFromJSONTyped = CompletionEventFromJSONTyped;
+exports.CompletionEventToJSON = CompletionEventToJSON;
+exports.CompletionEventToJSONTyped = CompletionEventToJSONTyped;
+/**
+ * @export
+ */
+exports.CompletionEventTypeEnum = {
+    CompactionComplete: 'compaction_complete'
+};
+/**
+ * Check if a given object implements the CompletionEvent interface.
+ */
+function instanceOfCompletionEvent(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined)
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+function CompletionEventFromJSON(json) {
+    return CompletionEventFromJSONTyped(json, false);
+}
+function CompletionEventFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'type': json['type'],
+        'timestamp': json['timestamp'],
+        'taskId': json['taskId'] == null ? undefined : json['taskId'],
+        'data': json['data'],
+    };
+}
+function CompletionEventToJSON(json) {
+    return CompletionEventToJSONTyped(json, false);
+}
+function CompletionEventToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': value['type'],
+        'timestamp': value['timestamp'],
+        'taskId': value['taskId'],
+        'data': value['data'],
+    };
+}

package/dist/models/Conversation.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface Conversation
+ */
+export interface Conversation {
+    /**
+     * Conversation id. Pass it as `conversationId` on `POST /prompt` to continue this thread.
+     * @type {string}
+     * @memberof Conversation
+     */
+    id: string;
+    /**
+     * When the first prompt of this conversation was queued.
+     * @type {Date}
+     * @memberof Conversation
+     */
+    createdAt: Date | null;
+    /**
+     * When its most recent prompt was queued. The list is sorted by this, newest first.
+     * @type {Date}
+     * @memberof Conversation
+     */
+    lastPromptAt: Date | null;
+    /**
+     * Number of prompts sent to this conversation.
+     * @type {number}
+     * @memberof Conversation
+     */
+    prompts: number;
+    /**
+     * `true` while a turn is queued or running in this conversation.
+     * @type {boolean}
+     * @memberof Conversation
+     */
+    running: boolean;
+    /**
+     * Harness the most recent prompt ran on (`claude`, `codex`, `pi`, `opencode`, `prime-agent`, `kimi`).
+     * @type {string}
+     * @memberof Conversation
+     */
+    lastHarness: string | null;
+    /**
+     * Model id of the most recent prompt that chose one, or `null` when every prompt used the harness default.
+     * @type {string}
+     * @memberof Conversation
+     */
+    lastModel: string | null;
+    /**
+     * The first 80 characters of the most recent prompt.
+     * @type {string}
+     * @memberof Conversation
+     */
+    lastPromptPreview: string | null;
+    /**
+     * `true` on the conversation a `POST /prompt` without `new` or `conversationId` would continue: the sandbox's most recently prompted one. Exactly one conversation is current unless the list is empty.
+     * @type {boolean}
+     * @memberof Conversation
+     */
+    current: boolean;
+}
+/**
+ * Check if a given object implements the Conversation interface.
+ */
+export declare function instanceOfConversation(value: object): value is Conversation;
+export declare function ConversationFromJSON(json: any): Conversation;
+export declare function ConversationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Conversation;
+export declare function ConversationToJSON(json: any): Conversation;
+export declare function ConversationToJSONTyped(value?: Conversation | null, ignoreDiscriminator?: boolean): any;