@boatdev/sdk 1.9.1 → 1.9.3

package/dist/models/CommandListResponse.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 type { CommandRecord } from './CommandRecord';
+/**
+ *
+ * @export
+ * @interface CommandListResponse
+ */
+export interface CommandListResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandListResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {CommandListResponseTypeEnum}
+     * @memberof CommandListResponse
+     */
+    type: CommandListResponseTypeEnum;
+    /**
+     * Newest first.
+     * @type {Array<CommandRecord>}
+     * @memberof CommandListResponse
+     */
+    commands: Array<CommandRecord>;
+    /**
+     * Pass as `cursor` to get the next page. Null on the last page.
+     * @type {string}
+     * @memberof CommandListResponse
+     */
+    nextCursor: string | null;
+}
+/**
+ * @export
+ */
+export declare const CommandListResponseTypeEnum: {
+    readonly CommandList: 'command.list';
+};
+export type CommandListResponseTypeEnum = typeof CommandListResponseTypeEnum[keyof typeof CommandListResponseTypeEnum];
+/**
+ * Check if a given object implements the CommandListResponse interface.
+ */
+export declare function instanceOfCommandListResponse(value: object): value is CommandListResponse;
+export declare function CommandListResponseFromJSON(json: any): CommandListResponse;
+export declare function CommandListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandListResponse;
+export declare function CommandListResponseToJSON(json: any): CommandListResponse;
+export declare function CommandListResponseToJSONTyped(value?: CommandListResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CommandListResponse.js

@@ -0,0 +1,70 @@
+"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.CommandListResponseTypeEnum = void 0;
+exports.instanceOfCommandListResponse = instanceOfCommandListResponse;
+exports.CommandListResponseFromJSON = CommandListResponseFromJSON;
+exports.CommandListResponseFromJSONTyped = CommandListResponseFromJSONTyped;
+exports.CommandListResponseToJSON = CommandListResponseToJSON;
+exports.CommandListResponseToJSONTyped = CommandListResponseToJSONTyped;
+const CommandRecord_1 = require("./CommandRecord");
+/**
+ * @export
+ */
+exports.CommandListResponseTypeEnum = {
+    CommandList: 'command.list'
+};
+/**
+ * Check if a given object implements the CommandListResponse interface.
+ */
+function instanceOfCommandListResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('commands' in value) || value['commands'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function CommandListResponseFromJSON(json) {
+    return CommandListResponseFromJSONTyped(json, false);
+}
+function CommandListResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'commands': (json['commands'].map(CommandRecord_1.CommandRecordFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function CommandListResponseToJSON(json) {
+    return CommandListResponseToJSONTyped(json, false);
+}
+function CommandListResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'commands': (value['commands'].map(CommandRecord_1.CommandRecordToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/CommandLogsResponse.d.ts

@@ -0,0 +1,109 @@
+/**
+ * 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 CommandLogsResponse
+ */
+export interface CommandLogsResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CommandLogsResponse
+     */
+    ok: boolean;
+    /**
+     *
+     * @type {CommandLogsResponseTypeEnum}
+     * @memberof CommandLogsResponse
+     */
+    type: CommandLogsResponseTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandLogsResponse
+     */
+    commandId: string;
+    /**
+     *
+     * @type {CommandLogsResponseStreamEnum}
+     * @memberof CommandLogsResponse
+     */
+    stream: CommandLogsResponseStreamEnum;
+    /**
+     * Byte position of the first byte in `data`. Greater than the requested offset only when output was not kept (see outputTruncated).
+     * @type {number}
+     * @memberof CommandLogsResponse
+     */
+    offset: number;
+    /**
+     * Pass as `offset` to read on.
+     * @type {number}
+     * @memberof CommandLogsResponse
+     */
+    nextOffset: number;
+    /**
+     * Bytes the stream has so far.
+     * @type {number}
+     * @memberof CommandLogsResponse
+     */
+    size: number;
+    /**
+     *
+     * @type {CommandLogsResponseEncodingEnum}
+     * @memberof CommandLogsResponse
+     */
+    encoding: CommandLogsResponseEncodingEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandLogsResponse
+     */
+    data: string;
+    /**
+     * True when the command ended and this read reached the end of the stream.
+     * @type {boolean}
+     * @memberof CommandLogsResponse
+     */
+    done: boolean;
+}
+/**
+ * @export
+ */
+export declare const CommandLogsResponseTypeEnum: {
+    readonly CommandLogs: 'command.logs';
+};
+export type CommandLogsResponseTypeEnum = typeof CommandLogsResponseTypeEnum[keyof typeof CommandLogsResponseTypeEnum];
+/**
+ * @export
+ */
+export declare const CommandLogsResponseStreamEnum: {
+    readonly Stdout: 'stdout';
+    readonly Stderr: 'stderr';
+};
+export type CommandLogsResponseStreamEnum = typeof CommandLogsResponseStreamEnum[keyof typeof CommandLogsResponseStreamEnum];
+/**
+ * @export
+ */
+export declare const CommandLogsResponseEncodingEnum: {
+    readonly Utf8: 'utf8';
+    readonly Base64: 'base64';
+};
+export type CommandLogsResponseEncodingEnum = typeof CommandLogsResponseEncodingEnum[keyof typeof CommandLogsResponseEncodingEnum];
+/**
+ * Check if a given object implements the CommandLogsResponse interface.
+ */
+export declare function instanceOfCommandLogsResponse(value: object): value is CommandLogsResponse;
+export declare function CommandLogsResponseFromJSON(json: any): CommandLogsResponse;
+export declare function CommandLogsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandLogsResponse;
+export declare function CommandLogsResponseToJSON(json: any): CommandLogsResponse;
+export declare function CommandLogsResponseToJSONTyped(value?: CommandLogsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CommandLogsResponse.js

@@ -0,0 +1,107 @@
+"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.CommandLogsResponseEncodingEnum = exports.CommandLogsResponseStreamEnum = exports.CommandLogsResponseTypeEnum = void 0;
+exports.instanceOfCommandLogsResponse = instanceOfCommandLogsResponse;
+exports.CommandLogsResponseFromJSON = CommandLogsResponseFromJSON;
+exports.CommandLogsResponseFromJSONTyped = CommandLogsResponseFromJSONTyped;
+exports.CommandLogsResponseToJSON = CommandLogsResponseToJSON;
+exports.CommandLogsResponseToJSONTyped = CommandLogsResponseToJSONTyped;
+/**
+ * @export
+ */
+exports.CommandLogsResponseTypeEnum = {
+    CommandLogs: 'command.logs'
+};
+/**
+ * @export
+ */
+exports.CommandLogsResponseStreamEnum = {
+    Stdout: 'stdout',
+    Stderr: 'stderr'
+};
+/**
+ * @export
+ */
+exports.CommandLogsResponseEncodingEnum = {
+    Utf8: 'utf8',
+    Base64: 'base64'
+};
+/**
+ * Check if a given object implements the CommandLogsResponse interface.
+ */
+function instanceOfCommandLogsResponse(value) {
+    if (!('ok' in value) || value['ok'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('commandId' in value) || value['commandId'] === undefined)
+        return false;
+    if (!('stream' in value) || value['stream'] === undefined)
+        return false;
+    if (!('offset' in value) || value['offset'] === undefined)
+        return false;
+    if (!('nextOffset' in value) || value['nextOffset'] === undefined)
+        return false;
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    if (!('encoding' in value) || value['encoding'] === undefined)
+        return false;
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('done' in value) || value['done'] === undefined)
+        return false;
+    return true;
+}
+function CommandLogsResponseFromJSON(json) {
+    return CommandLogsResponseFromJSONTyped(json, false);
+}
+function CommandLogsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ok': json['ok'],
+        'type': json['type'],
+        'commandId': json['commandId'],
+        'stream': json['stream'],
+        'offset': json['offset'],
+        'nextOffset': json['nextOffset'],
+        'size': json['size'],
+        'encoding': json['encoding'],
+        'data': json['data'],
+        'done': json['done'],
+    };
+}
+function CommandLogsResponseToJSON(json) {
+    return CommandLogsResponseToJSONTyped(json, false);
+}
+function CommandLogsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ok': value['ok'],
+        'type': value['type'],
+        'commandId': value['commandId'],
+        'stream': value['stream'],
+        'offset': value['offset'],
+        'nextOffset': value['nextOffset'],
+        'size': value['size'],
+        'encoding': value['encoding'],
+        'data': value['data'],
+        'done': value['done'],
+    };
+}

package/dist/models/CommandRecord.d.ts

@@ -0,0 +1,132 @@
+/**
+ * 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.
+ */
+/**
+ * One command run through the commands endpoint (kept 90 days), or one process of the sandbox with mode `process` (kept 72 hours). Readable while the sandbox is stopped.
+ * @export
+ * @interface CommandRecord
+ */
+export interface CommandRecord {
+    /**
+     * Id of the record in the command history.
+     * @type {string}
+     * @memberof CommandRecord
+     */
+    commandId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandRecord
+     */
+    sandboxId: string;
+    /**
+     * The command text as sent (first 64 KiB).
+     * @type {string}
+     * @memberof CommandRecord
+     */
+    command: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandRecord
+     */
+    cwd?: string | null;
+    /**
+     * sync: the request waited for the result. stream: the output was streamed. detached: started in the background. process: any other process of the sandbox, recorded from what it wrote to its stdout/stderr.
+     * @type {CommandRecordModeEnum}
+     * @memberof CommandRecord
+     */
+    mode: CommandRecordModeEnum;
+    /**
+     * detached: the process id on the sandbox.
+     * @type {number}
+     * @memberof CommandRecord
+     */
+    processId?: number | null;
+    /**
+     * failed: the command could not start or its result never arrived. killed: ended by a signal or by DELETE /commands/{processId}. lost: the sandbox stopped or its agent restarted while the command ran.
+     * @type {CommandRecordStatusEnum}
+     * @memberof CommandRecord
+     */
+    status: CommandRecordStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof CommandRecord
+     */
+    exitCode?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CommandRecord
+     */
+    signal?: string | null;
+    /**
+     * Bytes of stdout written so far.
+     * @type {number}
+     * @memberof CommandRecord
+     */
+    stdoutBytes: number;
+    /**
+     * Bytes of stderr written so far.
+     * @type {number}
+     * @memberof CommandRecord
+     */
+    stderrBytes: number;
+    /**
+     * True when part of the output is not kept: the sandbox cut the output of a waiting command at 8 MiB, or the account wrote more than 10 MiB (compressed) of command output, or of process output, in one hour.
+     * @type {boolean}
+     * @memberof CommandRecord
+     */
+    outputTruncated: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof CommandRecord
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CommandRecord
+     */
+    finishedAt?: Date | null;
+}
+/**
+ * @export
+ */
+export declare const CommandRecordModeEnum: {
+    readonly Sync: 'sync';
+    readonly Stream: 'stream';
+    readonly Detached: 'detached';
+    readonly Process: 'process';
+};
+export type CommandRecordModeEnum = typeof CommandRecordModeEnum[keyof typeof CommandRecordModeEnum];
+/**
+ * @export
+ */
+export declare const CommandRecordStatusEnum: {
+    readonly Running: 'running';
+    readonly Exited: 'exited';
+    readonly TimedOut: 'timed_out';
+    readonly Failed: 'failed';
+    readonly Killed: 'killed';
+    readonly Lost: 'lost';
+};
+export type CommandRecordStatusEnum = typeof CommandRecordStatusEnum[keyof typeof CommandRecordStatusEnum];
+/**
+ * Check if a given object implements the CommandRecord interface.
+ */
+export declare function instanceOfCommandRecord(value: object): value is CommandRecord;
+export declare function CommandRecordFromJSON(json: any): CommandRecord;
+export declare function CommandRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommandRecord;
+export declare function CommandRecordToJSON(json: any): CommandRecord;
+export declare function CommandRecordToJSONTyped(value?: CommandRecord | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CommandRecord.js

@@ -0,0 +1,113 @@
+"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.CommandRecordStatusEnum = exports.CommandRecordModeEnum = void 0;
+exports.instanceOfCommandRecord = instanceOfCommandRecord;
+exports.CommandRecordFromJSON = CommandRecordFromJSON;
+exports.CommandRecordFromJSONTyped = CommandRecordFromJSONTyped;
+exports.CommandRecordToJSON = CommandRecordToJSON;
+exports.CommandRecordToJSONTyped = CommandRecordToJSONTyped;
+/**
+ * @export
+ */
+exports.CommandRecordModeEnum = {
+    Sync: 'sync',
+    Stream: 'stream',
+    Detached: 'detached',
+    Process: 'process'
+};
+/**
+ * @export
+ */
+exports.CommandRecordStatusEnum = {
+    Running: 'running',
+    Exited: 'exited',
+    TimedOut: 'timed_out',
+    Failed: 'failed',
+    Killed: 'killed',
+    Lost: 'lost'
+};
+/**
+ * Check if a given object implements the CommandRecord interface.
+ */
+function instanceOfCommandRecord(value) {
+    if (!('commandId' in value) || value['commandId'] === undefined)
+        return false;
+    if (!('sandboxId' in value) || value['sandboxId'] === undefined)
+        return false;
+    if (!('command' in value) || value['command'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('stdoutBytes' in value) || value['stdoutBytes'] === undefined)
+        return false;
+    if (!('stderrBytes' in value) || value['stderrBytes'] === undefined)
+        return false;
+    if (!('outputTruncated' in value) || value['outputTruncated'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    return true;
+}
+function CommandRecordFromJSON(json) {
+    return CommandRecordFromJSONTyped(json, false);
+}
+function CommandRecordFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'commandId': json['commandId'],
+        'sandboxId': json['sandboxId'],
+        'command': json['command'],
+        'cwd': json['cwd'] == null ? undefined : json['cwd'],
+        'mode': json['mode'],
+        'processId': json['processId'] == null ? undefined : json['processId'],
+        'status': json['status'],
+        'exitCode': json['exitCode'] == null ? undefined : json['exitCode'],
+        'signal': json['signal'] == null ? undefined : json['signal'],
+        'stdoutBytes': json['stdoutBytes'],
+        'stderrBytes': json['stderrBytes'],
+        'outputTruncated': json['outputTruncated'],
+        'startedAt': (new Date(json['startedAt'])),
+        'finishedAt': json['finishedAt'] == null ? undefined : (new Date(json['finishedAt'])),
+    };
+}
+function CommandRecordToJSON(json) {
+    return CommandRecordToJSONTyped(json, false);
+}
+function CommandRecordToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'commandId': value['commandId'],
+        'sandboxId': value['sandboxId'],
+        'command': value['command'],
+        'cwd': value['cwd'],
+        'mode': value['mode'],
+        'processId': value['processId'],
+        'status': value['status'],
+        'exitCode': value['exitCode'],
+        'signal': value['signal'],
+        'stdoutBytes': value['stdoutBytes'],
+        'stderrBytes': value['stderrBytes'],
+        'outputTruncated': value['outputTruncated'],
+        'startedAt': value['startedAt'].toISOString(),
+        'finishedAt': value['finishedAt'] == null ? value['finishedAt'] : value['finishedAt'].toISOString(),
+    };
+}

package/dist/models/CommandResponse.d.ts

@@ -33,6 +33,12 @@ export interface CommandResponse {
      * @memberof CommandResponse
      */
     success: boolean;
+    /**
+     * The command's record in the command history.
+     * @type {string}
+     * @memberof CommandResponse
+     */
+    commandId?: string;
     /**
      *
      * @type {number}

package/dist/models/CommandResponse.js

@@ -56,6 +56,7 @@ function CommandResponseFromJSONTyped(json, ignoreDiscriminator) {
         'ok': json['ok'],
         'type': json['type'],
         'success': json['success'],
+        'commandId': json['commandId'] == null ? undefined : json['commandId'],
         'exitCode': json['exitCode'],
         'signal': json['signal'] == null ? undefined : json['signal'],
         'oomKilled': json['oomKilled'] == null ? undefined : json['oomKilled'],
@@ -80,6 +81,7 @@ function CommandResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'ok': value['ok'],
         'type': value['type'],
         'success': value['success'],
+        'commandId': value['commandId'],
         'exitCode': value['exitCode'],
         'signal': value['signal'],
         'oomKilled': value['oomKilled'],

package/dist/models/CommandStartedResponse.d.ts

@@ -33,6 +33,12 @@ export interface CommandStartedResponse {
      * @memberof CommandStartedResponse
      */
     success: boolean;
+    /**
+     * The command's record in the command history. Its output is copied there every 30 s.
+     * @type {string}
+     * @memberof CommandStartedResponse
+     */
+    commandId?: string;
     /**
      * Process id to poll with the command status endpoint.
      * @type {number}

package/dist/models/CommandStartedResponse.js

@@ -56,6 +56,7 @@ function CommandStartedResponseFromJSONTyped(json, ignoreDiscriminator) {
         'ok': json['ok'],
         'type': json['type'],
         'success': json['success'],
+        'commandId': json['commandId'] == null ? undefined : json['commandId'],
         'processId': json['processId'],
         'pid': json['pid'],
         'command': json['command'],
@@ -76,6 +77,7 @@ function CommandStartedResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'ok': value['ok'],
         'type': value['type'],
         'success': value['success'],
+        'commandId': value['commandId'],
         'processId': value['processId'],
         'pid': value['pid'],
         'command': value['command'],