plato-sandbox-sdk 1.1.1

package/api/types/Environment.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface Environment {
+    job_id: string;
+    alias?: string;
+    status?: string;
+}

package/api/types/EnvironmentStateResponse.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface EnvironmentStateResponse {
+    data?: EnvironmentStateResponse.Data;
+}
+
+export namespace EnvironmentStateResponse {
+    export interface Data {
+        state?: Record<string, unknown>;
+    }
+}

package/api/types/ErrorResponse.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface ErrorResponse {
+    error?: string;
+    message?: string;
+}

package/api/types/EvaluateResponse.ts

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface EvaluateResponse {
+    score?: EvaluateResponse.Score;
+}
+
+export namespace EvaluateResponse {
+    export interface Score {
+        result?: Score.Result;
+    }
+
+    export namespace Score {
+        export interface Result {
+            correct?: boolean;
+            reason?: string;
+            diffs?: Record<string, unknown>[];
+            expected_mutations?: Record<string, unknown>[];
+            mutations?: Record<string, unknown>[];
+        }
+    }
+}

package/api/types/EvaluationResult.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface EvaluationResult {
+    success: boolean;
+    reason?: string;
+    diffs?: Record<string, unknown>[];
+    expected_mutations?: Record<string, unknown>[];
+    actual_mutations?: Record<string, unknown>[];
+}

package/api/types/HeartbeatResponse.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface HeartbeatResponse {
+    success?: boolean;
+    timestamp?: string;
+}

package/api/types/JobStatusResponse.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface JobStatusResponse {
+    status: string;
+    job_id?: string;
+    job_group_id?: string;
+}

package/api/types/LogResponse.ts

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface LogResponse {
+    success?: boolean;
+}

package/api/types/MakeEnvironmentResponse.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface MakeEnvironmentResponse {
+    job_id: string;
+    alias?: string;
+}

package/api/types/OperationEvent.ts

@@ -0,0 +1,42 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * Server-sent event for operation monitoring. The SSE data field contains base64-encoded JSON of this object.
+ *
+ * **Event Types:**
+ * - `connected`: Initial connection event, no action needed, continue listening
+ * - `progress`: Progress update with human-readable message
+ * - `run_result`: Sandbox setup/creation completed (check `success` field)
+ * - `ssh_result`: SSH setup operation completed (check `success` field)
+ * - `error`: Operation failed (check `error` or `message` field)
+ *
+ * **Terminal Events:**
+ * `run_result`, `ssh_result`, and `error` are terminal events that indicate the operation has finished.
+ * Close the stream after receiving one of these.
+ *
+ * **Success Detection:**
+ * An operation is successful if you receive `run_result` or `ssh_result` with `success: true`.
+ * An operation failed if you receive an `error` event or a result event with `success: false`.
+ */
+export interface OperationEvent {
+    /** Type of operation event */
+    type: OperationEvent.Type;
+    /** Whether the operation was successful (only present in result events) */
+    success?: boolean;
+    /** Error message if operation failed */
+    error?: string;
+    /** Human-readable progress or status message */
+    message?: string;
+}
+
+export namespace OperationEvent {
+    /** Type of operation event */
+    export const Type = {
+        Connected: "connected",
+        RunResult: "run_result",
+        SshResult: "ssh_result",
+        Error: "error",
+        Progress: "progress",
+    } as const;
+    export type Type = (typeof Type)[keyof typeof Type];
+}

package/api/types/PlatoConfig.ts

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Api from "../index.js";
+
+export interface PlatoConfig {
+    service?: string;
+    datasets?: Record<string, Api.SimConfigDataset>;
+}

package/api/types/PlatoTask.ts

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Api from "../index.js";
+
+export interface PlatoTask {
+    public_id: string;
+    name: string;
+    prompt: string;
+    env_id: string;
+    start_url: string;
+    dataset_name?: string;
+    average_time?: number;
+    average_steps?: number;
+    num_validator_human_scores?: number;
+    default_scoring_config?: Record<string, unknown>;
+    scoring_type?: Api.ScoringType[];
+    output_schema?: Record<string, unknown>;
+    is_sample?: boolean;
+    simulator_artifact_id?: string;
+    metadata?: Api.PlatoTaskMetadata;
+}

package/api/types/PlatoTaskMetadata.ts

@@ -0,0 +1,20 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface PlatoTaskMetadata {
+    reasoning_level?: PlatoTaskMetadata.ReasoningLevel;
+    skills?: string[];
+    capabilities?: string[];
+    tags?: string[];
+    rejected?: boolean;
+}
+
+export namespace PlatoTaskMetadata {
+    export const ReasoningLevel = {
+        Level1: "level_1",
+        Level2: "level_2",
+        Level3: "level_3",
+        Level4: "level_4",
+        Level5: "level_5",
+    } as const;
+    export type ReasoningLevel = (typeof ReasoningLevel)[keyof typeof ReasoningLevel];
+}

package/api/types/PostEvaluationResultResponse.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface PostEvaluationResultResponse {
+    success?: boolean;
+    message?: string;
+}

package/api/types/ProxyUrlResponse.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface ProxyUrlResponse {
+    data?: ProxyUrlResponse.Data;
+    error?: string;
+}
+
+export namespace ProxyUrlResponse {
+    export interface Data {
+        proxy_url?: string;
+    }
+}

package/api/types/ResetEnvironmentResponse.ts

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface ResetEnvironmentResponse {
+    success: boolean;
+    error?: string;
+    data?: ResetEnvironmentResponse.Data;
+}
+
+export namespace ResetEnvironmentResponse {
+    export interface Data {
+        run_session_id?: string;
+    }
+}

package/api/types/RunningSessionsCountResponse.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface RunningSessionsCountResponse {
+    organization_id?: string;
+    running_sessions_count?: number;
+}

package/api/types/Sandbox.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface Sandbox {
+    job_id: string;
+    public_id: string;
+    job_group_id: string;
+    url?: string;
+    status?: string;
+    correlation_id?: string;
+}

package/api/types/ScoringType.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export const ScoringType = {
+    Output: "output",
+    Mutations: "mutations",
+} as const;
+export type ScoringType = (typeof ScoringType)[keyof typeof ScoringType];

package/api/types/SetupRootAccessResponse.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SetupRootAccessResponse {
+    success?: boolean;
+    /** Correlation ID for monitoring setup progress via SSE */
+    correlation_id?: string;
+}

package/api/types/SetupSandboxResponse.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SetupSandboxResponse {
+    /** Correlation ID for monitoring setup progress via SSE */
+    correlation_id: string;
+}

package/api/types/SimConfigCompute.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SimConfigCompute {
+    cpus: number;
+    memory: number;
+    disk: number;
+    app_port: number;
+    plato_messaging_port: number;
+}

package/api/types/SimConfigDataset.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Api from "../index.js";
+
+export interface SimConfigDataset {
+    compute: Api.SimConfigCompute;
+    metadata: Api.SimConfigMetadata;
+    services?: Record<string, Api.SimConfigService>;
+    listeners?: Record<string, Api.SimConfigListener>;
+}

package/api/types/SimConfigListener.ts

@@ -0,0 +1,27 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SimConfigListener {
+    type: SimConfigListener.Type;
+    db_type?: string;
+    db_host?: string;
+    db_port?: number;
+    db_user?: string;
+    db_password?: string;
+    db_database?: string;
+    target_dir?: string;
+    watch_enabled?: boolean;
+    watch_patterns?: string[];
+    ignore_patterns?: string[];
+    seed_data_path?: string;
+    seed_data_paths?: string[];
+    volumes?: string[];
+}
+
+export namespace SimConfigListener {
+    export const Type = {
+        Db: "db",
+        File: "file",
+        Proxy: "proxy",
+    } as const;
+    export type Type = (typeof Type)[keyof typeof Type];
+}

package/api/types/SimConfigMetadata.ts

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Api from "../index.js";
+
+export interface SimConfigMetadata {
+    favicon?: string;
+    name: string;
+    description?: string;
+    source_code_url?: string;
+    start_url?: string;
+    license?: string;
+    variables?: Api.Variable[];
+    flows_path?: string;
+}

package/api/types/SimConfigService.ts

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SimConfigService {
+    type: string;
+    file?: string;
+    required_healthy_containers?: string[];
+    healthy_wait_timeout?: number;
+}

package/api/types/Simulator.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface Simulator {
+    id?: number;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    sim_type?: string;
+    config?: Record<string, unknown>;
+}

package/api/types/SimulatorListItem.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SimulatorListItem {
+    name: string;
+    description?: string;
+    artifact_id?: string;
+}

package/api/types/SshInfo.ts

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface SshInfo {
+    /** Complete SSH command to connect */
+    ssh_command: string;
+    /** SSH host identifier */
+    ssh_host: string;
+    /** Path to SSH config file */
+    ssh_config_path: string;
+    /** Sandbox public ID */
+    public_id: string;
+    /** Generated SSH public key */
+    public_key?: string;
+    /** Path to private key file */
+    private_key_path?: string;
+    /** Correlation ID for monitoring SSH setup */
+    correlation_id?: string;
+}

package/api/types/StartWorkerResponse.ts

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface StartWorkerResponse {
+    status: string;
+    timestamp: string;
+    correlation_id: string;
+}

package/api/types/TaskMetadata.ts

@@ -0,0 +1,20 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface TaskMetadata {
+    reasoningLevel?: TaskMetadata.ReasoningLevel;
+    skills?: string[];
+    capabilities?: string[];
+    tags?: string[];
+    rejected?: boolean;
+}
+
+export namespace TaskMetadata {
+    export const ReasoningLevel = {
+        Level1: "level_1",
+        Level2: "level_2",
+        Level3: "level_3",
+        Level4: "level_4",
+        Level5: "level_5",
+    } as const;
+    export type ReasoningLevel = (typeof ReasoningLevel)[keyof typeof ReasoningLevel];
+}

package/api/types/TestCase.ts

@@ -0,0 +1,40 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Api from "../index.js";
+
+export interface TestCase {
+    publicId: string;
+    name: string;
+    prompt: string;
+    startUrl: string;
+    simulator: TestCase.Simulator;
+    averageTimeTaken?: number;
+    averageStepsTaken?: number;
+    defaultScoringConfig?: TestCase.DefaultScoringConfig;
+    scoringTypes?: TestCase.ScoringTypes.Item[];
+    outputSchema?: Record<string, unknown>;
+    isSample?: boolean;
+    simulatorArtifactId?: string;
+    metadataConfig?: Api.TaskMetadata;
+}
+
+export namespace TestCase {
+    export interface Simulator {
+        name?: string;
+        id?: number;
+    }
+
+    export interface DefaultScoringConfig {
+        num_sessions_used?: number;
+    }
+
+    export type ScoringTypes = ScoringTypes.Item[];
+
+    export namespace ScoringTypes {
+        export const Item = {
+            Output: "output",
+            Mutations: "mutations",
+        } as const;
+        export type Item = (typeof Item)[keyof typeof Item];
+    }
+}

package/api/types/TestCasesResponse.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Api from "../index.js";
+
+export interface TestCasesResponse {
+    testcases: Api.TestCase[];
+    total?: number;
+    page?: number;
+    page_size?: number;
+}

package/api/types/Variable.ts

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface Variable {
+    name: string;
+    value: string;
+}

package/api/types/WorkerReadyResponse.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface WorkerReadyResponse {
+    ready: boolean;
+    worker_ip?: string;
+    worker_port?: number;
+    health_status?: Record<string, unknown>;
+    error?: string;
+}

package/api/types/index.ts

@@ -0,0 +1,42 @@
+export * from "./ActiveSessionResponse.js";
+export * from "./BackupEnvironmentResponse.js";
+export * from "./CdpUrlResponse.js";
+export * from "./CloseEnvironmentResponse.js";
+export * from "./CreateSandboxResponse.js";
+export * from "./CreateSnapshotResponse.js";
+export * from "./DeleteSandboxResponse.js";
+export * from "./Environment.js";
+export * from "./EnvironmentStateResponse.js";
+export * from "./ErrorResponse.js";
+export * from "./EvaluateResponse.js";
+export * from "./EvaluationResult.js";
+export * from "./HeartbeatResponse.js";
+export * from "./JobStatusResponse.js";
+export * from "./LogResponse.js";
+export * from "./MakeEnvironmentResponse.js";
+export * from "./OperationEvent.js";
+export * from "./PlatoConfig.js";
+export * from "./PlatoTask.js";
+export * from "./PlatoTaskMetadata.js";
+export * from "./PostEvaluationResultResponse.js";
+export * from "./ProxyUrlResponse.js";
+export * from "./ResetEnvironmentResponse.js";
+export * from "./RunningSessionsCountResponse.js";
+export * from "./Sandbox.js";
+export * from "./ScoringType.js";
+export * from "./SetupRootAccessResponse.js";
+export * from "./SetupSandboxResponse.js";
+export * from "./SimConfigCompute.js";
+export * from "./SimConfigDataset.js";
+export * from "./SimConfigListener.js";
+export * from "./SimConfigMetadata.js";
+export * from "./SimConfigService.js";
+export * from "./Simulator.js";
+export * from "./SimulatorListItem.js";
+export * from "./SshInfo.js";
+export * from "./StartWorkerResponse.js";
+export * from "./TaskMetadata.js";
+export * from "./TestCase.js";
+export * from "./TestCasesResponse.js";
+export * from "./Variable.js";
+export * from "./WorkerReadyResponse.js";

package/core/fetcher/APIResponse.ts

@@ -0,0 +1,23 @@
+import type { RawResponse } from "./RawResponse.js";
+
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/core/fetcher/BinaryResponse.ts

@@ -0,0 +1,36 @@
+import type { ResponseWithBody } from "./ResponseWithBody.js";
+
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: boolean;
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => ReadableStream<Uint8Array>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => Promise<Blob>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+
+export function getBinaryResponse(response: ResponseWithBody): BinaryResponse {
+    const binaryResponse: BinaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+
+    return binaryResponse;
+}

package/core/fetcher/EndpointMetadata.ts

@@ -0,0 +1,13 @@
+export type SecuritySchemeKey = string;
+/**
+ * A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
+ * All schemes in the collection must be satisfied for authentication to be successful.
+ */
+export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
+export type AuthScope = string;
+export type EndpointMetadata = {
+    /**
+     * An array of security scheme collections. Each collection represents an alternative way to authenticate.
+     */
+    security?: SecuritySchemeCollection[];
+};

package/core/fetcher/EndpointSupplier.ts

@@ -0,0 +1,14 @@
+import type { EndpointMetadata } from "./EndpointMetadata.js";
+import type { Supplier } from "./Supplier.js";
+
+type EndpointSupplierFn<T> = (arg: { endpointMetadata: EndpointMetadata }) => T | Promise<T>;
+export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
+export const EndpointSupplier = {
+    get: async <T>(supplier: EndpointSupplier<T>, arg: { endpointMetadata: EndpointMetadata }): Promise<T> => {
+        if (typeof supplier === "function") {
+            return (supplier as EndpointSupplierFn<T>)(arg);
+        } else {
+            return supplier;
+        }
+    },
+};