@boatdev/sdk 1.0.0

package/dist/esm/models/CommandRequest.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 CommandRequest
+ */
+export interface CommandRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommandRequest
+     */
+    command: string;
+    /**
+     * Relative working directory inside the sandbox work directory.
+     * @type {string}
+     * @memberof CommandRequest
+     */
+    cwd?: string;
+    /**
+     * Command timeout in seconds. Values outside 1-600 are rejected with a 400 invalid_timeout error.
+     * @type {number}
+     * @memberof CommandRequest
+     */
+    timeoutSeconds?: number;
+    /**
+     * Start the command in the background and return a process id immediately instead of waiting for it to finish. Output goes to a log file on the sandbox; poll the status endpoint for it.
+     * @type {boolean}
+     * @memberof CommandRequest
+     */
+    detached?: boolean;
+}
+/**
+ * Check if a given object implements the CommandRequest interface.
+ */
+export declare function instanceOfCommandRequest(value: object): value is CommandRequest;
+export declare function CommandRequestFromJSON(json: any): CommandRequest;
+export declare function CommandRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandRequest;
+export declare function CommandRequestToJSON(json: any): CommandRequest;
+export declare function CommandRequestToJSONTyped(value?: CommandRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CommandRequest.js

@@ -0,0 +1,49 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CommandRequest interface.
+ */
+export function instanceOfCommandRequest(value) {
+    if (!('command' in value) || value['command'] === undefined)
+        return false;
+    return true;
+}
+export function CommandRequestFromJSON(json) {
+    return CommandRequestFromJSONTyped(json, false);
+}
+export function CommandRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'command': json['command'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'timeoutSeconds': json['timeoutSeconds'] == null ? undefined : json['timeoutSeconds'],
+        'detached': json['detached'] == null ? undefined : json['detached'],
+    };
+}
+export function CommandRequestToJSON(json) {
+    return CommandRequestToJSONTyped(json, false);
+}
+export function CommandRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'command': value['command'],
+        'cwd': value['cwd'],
+        'timeoutSeconds': value['timeoutSeconds'],
+        'detached': value['detached'],
+    };
+}

package/dist/esm/models/CommandResponse.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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 CommandResponse
+ */
+export interface CommandResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {CommandResponseTypeEnum}
+     * @memberof CommandResponse
+     */
+    type: CommandResponseTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    success: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof CommandResponse
+     */
+    exitCode: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    signal?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    stdout: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    stderr: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    stdoutTruncated?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    stderrTruncated?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandResponse
+     */
+    timedOut: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    cwd?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CommandResponse
+     */
+    startedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CommandResponse
+     */
+    finishedAt?: Date;
+}
+/**
+ * @export
+ */
+export declare const CommandResponseTypeEnum: {
+    readonly CommandFinished: 'command.finished';
+};
+export type CommandResponseTypeEnum = typeof CommandResponseTypeEnum[keyof typeof CommandResponseTypeEnum];
+/**
+ * Check if a given object implements the CommandResponse interface.
+ */
+export declare function instanceOfCommandResponse(value: object): value is CommandResponse;
+export declare function CommandResponseFromJSON(json: any): CommandResponse;
+export declare function CommandResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandResponse;
+export declare function CommandResponseToJSON(json: any): CommandResponse;
+export declare function CommandResponseToJSONTyped(value?: CommandResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CommandResponse.js

@@ -0,0 +1,85 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CommandResponseTypeEnum = {
+    CommandFinished: 'command.finished'
+};
+/**
+ * Check if a given object implements the CommandResponse interface.
+ */
+export function instanceOfCommandResponse(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 (!('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;
+    if (!('timedOut' in value) || value['timedOut'] === undefined)
+        return false;
+    return true;
+}
+export function CommandResponseFromJSON(json) {
+    return CommandResponseFromJSONTyped(json, false);
+}
+export function CommandResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'success': json['success'],
+        'exitCode': json['exitCode'],
+        'signal': json['signal'] == null ? undefined : json['signal'],
+        'stdout': json['stdout'],
+        'stderr': json['stderr'],
+        'stdoutTruncated': json['stdoutTruncated'] == null ? undefined : json['stdoutTruncated'],
+        'stderrTruncated': json['stderrTruncated'] == null ? undefined : json['stderrTruncated'],
+        'timedOut': json['timedOut'],
+        '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'])),
+    };
+}
+export function CommandResponseToJSON(json) {
+    return CommandResponseToJSONTyped(json, false);
+}
+export function CommandResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'success': value['success'],
+        'exitCode': value['exitCode'],
+        'signal': value['signal'],
+        'stdout': value['stdout'],
+        'stderr': value['stderr'],
+        'stdoutTruncated': value['stdoutTruncated'],
+        'stderrTruncated': value['stderrTruncated'],
+        'timedOut': value['timedOut'],
+        'cwd': value['cwd'],
+        'startedAt': value['startedAt'] == null ? value['startedAt'] : value['startedAt'].toISOString(),
+        'finishedAt': value['finishedAt'] == null ? value['finishedAt'] : value['finishedAt'].toISOString(),
+    };
+}

package/dist/esm/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/esm/models/CommandStartedResponse.js

@@ -0,0 +1,79 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CommandStartedResponseTypeEnum = {
+    CommandStarted: 'command.started'
+};
+/**
+ * Check if a given object implements the CommandStartedResponse interface.
+ */
+export 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;
+}
+export function CommandStartedResponseFromJSON(json) {
+    return CommandStartedResponseFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function CommandStartedResponseToJSON(json) {
+    return CommandStartedResponseToJSONTyped(json, false);
+}
+export 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/esm/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;