plato-sandbox-sdk 1.1.13 → 1.1.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "plato-sandbox-sdk",
-  "version": "1.1.13",
+  "version": "1.1.14",
   "description": "TypeScript SDK for interacting with the Plato platform - manage environments, VMs, simulators, and more",
   "author": "Plato AI",
   "repository": {

package/dist/examples/flow-executor-example.d.ts

@@ -1,11 +0,0 @@
-/**
- * Example of using the Flow Executor for browser automation
- *
- * Run this example:
- * 1. Install dependencies: npm install playwright
- * 2. Build the SDK: npm run build
- * 3. Run: npx ts-node examples/flow-executor-example.ts
- */
-declare function exampleLoginFlow(): Promise<boolean>;
-declare function exampleLoginScenario(): Promise<boolean>;
-export { exampleLoginFlow, exampleLoginScenario };

package/dist/examples/flow-executor-example.js

@@ -1,193 +0,0 @@
-"use strict";
-/**
- * Example of using the Flow Executor for browser automation
- *
- * Run this example:
- * 1. Install dependencies: npm install playwright
- * 2. Build the SDK: npm run build
- * 3. Run: npx ts-node examples/flow-executor-example.ts
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.exampleLoginFlow = exampleLoginFlow;
-exports.exampleLoginScenario = exampleLoginScenario;
-const playwright_1 = require("playwright");
-const flow_1 = require("../src/flow");
-function exampleLoginFlow() {
-    return __awaiter(this, void 0, void 0, function* () {
-        console.log('🚀 Starting Flow Executor Example\n');
-        const browser = yield playwright_1.chromium.launch({ headless: false });
-        const page = yield browser.newPage();
-        // Define a complete flow
-        const flow = {
-            name: 'example-navigation',
-            description: 'Example flow demonstrating various step types',
-            steps: [
-                {
-                    type: 'navigate',
-                    url: 'https://example.com',
-                    description: 'Navigate to Example.com'
-                },
-                {
-                    type: 'wait',
-                    duration: 1000,
-                    description: 'Wait for page to settle'
-                },
-                {
-                    type: 'verify',
-                    verifyType: 'page_title',
-                    title: 'Example Domain',
-                    contains: false,
-                    description: 'Verify exact page title'
-                },
-                {
-                    type: 'verify',
-                    verifyType: 'element_exists',
-                    selector: 'h1',
-                    description: 'Verify h1 element exists'
-                },
-                {
-                    type: 'verify',
-                    verifyType: 'element_text',
-                    selector: 'h1',
-                    text: 'Example Domain',
-                    contains: false,
-                    description: 'Verify h1 text content'
-                },
-                {
-                    type: 'screenshot',
-                    filename: 'example-page.png',
-                    fullPage: true,
-                    description: 'Take full page screenshot'
-                },
-                {
-                    type: 'verify_no_errors',
-                    description: 'Ensure no error indicators on page'
-                },
-                {
-                    type: 'verify_url',
-                    url: 'example.com',
-                    contains: true,
-                    description: 'Verify URL contains example.com'
-                }
-            ]
-        };
-        const executor = new flow_1.FlowExecutor({
-            page,
-            flow,
-            screenshotsDir: './flow-screenshots'
-        });
-        const success = yield executor.executeFlow();
-        console.log('\n' + '='.repeat(60));
-        if (success) {
-            console.log('✅ Flow completed successfully!');
-        }
-        else {
-            console.log('❌ Flow failed!');
-        }
-        console.log('='.repeat(60) + '\n');
-        // Keep browser open for a moment to see the result
-        yield page.waitForTimeout(2000);
-        yield browser.close();
-        return success;
-    });
-}
-// More complex example with a simulated login
-function exampleLoginScenario() {
-    return __awaiter(this, void 0, void 0, function* () {
-        console.log('🚀 Starting Login Scenario Example\n');
-        const browser = yield playwright_1.chromium.launch({ headless: false });
-        const page = yield browser.newPage();
-        const loginFlow = {
-            name: 'github-login-page-visit',
-            description: 'Navigate to GitHub login and verify elements',
-            steps: [
-                {
-                    type: 'navigate',
-                    url: 'https://github.com/login',
-                    description: 'Navigate to GitHub login page'
-                },
-                {
-                    type: 'wait_for_selector',
-                    selector: '#login_field',
-                    timeout: 5000,
-                    description: 'Wait for username field'
-                },
-                {
-                    type: 'verify',
-                    verifyType: 'element_visible',
-                    selector: '#login_field',
-                    description: 'Verify username field is visible'
-                },
-                {
-                    type: 'verify',
-                    verifyType: 'element_visible',
-                    selector: '#password',
-                    description: 'Verify password field is visible'
-                },
-                {
-                    type: 'check_element',
-                    selector: 'input[type="submit"]',
-                    shouldExist: true,
-                    description: 'Check that submit button exists'
-                },
-                {
-                    type: 'screenshot',
-                    filename: 'github-login.png',
-                    fullPage: false,
-                    description: 'Capture login page'
-                },
-                {
-                    type: 'verify_no_errors',
-                    description: 'Verify no errors on login page'
-                }
-            ]
-        };
-        const executor = new flow_1.FlowExecutor({
-            page,
-            flow: loginFlow,
-            screenshotsDir: './flow-screenshots'
-        });
-        const success = yield executor.executeFlow();
-        console.log('\n' + '='.repeat(60));
-        if (success) {
-            console.log('✅ Login page verification completed successfully!');
-        }
-        else {
-            console.log('❌ Login page verification failed!');
-        }
-        console.log('='.repeat(60) + '\n');
-        yield page.waitForTimeout(2000);
-        yield browser.close();
-        return success;
-    });
-}
-// Run examples
-function main() {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            // Run first example
-            yield exampleLoginFlow();
-            // Small delay between examples
-            yield new Promise(resolve => setTimeout(resolve, 1000));
-            // Run second example
-            yield exampleLoginScenario();
-        }
-        catch (error) {
-            console.error('Error running examples:', error);
-            process.exit(1);
-        }
-    });
-}
-// Only run if this is the main module
-if (require.main === module) {
-    main();
-}

package/dist/src/apis/EnvApi.d.ts

@@ -1,304 +0,0 @@
-/**
- * Plato API
- * API for Plato platform - SDK routes only
- *
- * 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 * as runtime from '../runtime';
-import type { CreateSimulatorRequest, EvaluateRequest, JobStatusResponse, Log, MakeEnvRequest2, MakeEnvResponse, ResetEnvRequest, ScoreRequest, WorkerReadyResponse } from '../models/index';
-export interface BackupEnvApiEnvJobGroupIdBackupPostRequest {
-    jobGroupId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface CloseEnvApiEnvJobGroupIdClosePostRequest {
-    jobGroupId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface CreateSimulatorApiEnvSimulatorsPostRequest {
-    createSimulatorRequest: CreateSimulatorRequest;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface EvaluateSessionApiEnvSessionSessionIdEvaluatePostRequest {
-    sessionId: string;
-    authorization?: string;
-    xInternalService?: string;
-    evaluateRequest?: EvaluateRequest;
-}
-export interface GetActiveSessionApiEnvJobGroupIdActiveSessionGetRequest {
-    jobGroupId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface GetCdpUrlApiEnvJobGroupIdCdpUrlGetRequest {
-    jobGroupId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface GetEnvStateApiEnvJobGroupIdStateGetRequest {
-    jobGroupId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface GetJobStatusApiEnvJobGroupIdStatusGetRequest {
-    jobGroupId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface GetProxyUrlApiEnvJobGroupIdProxyUrlGetRequest {
-    jobGroupId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface GetSimulatorsApiEnvSimulatorsGetRequest {
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface GetWorkerReadyApiEnvJobIdWorkerReadyGetRequest {
-    jobId: string;
-    timeout?: number;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface LogStateMutationApiEnvSessionIdLogPostRequest {
-    sessionId: string;
-    log: Log;
-}
-export interface MakeEnvApiEnvMake2PostRequest {
-    makeEnvRequest2: MakeEnvRequest2;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface ResetEnvApiEnvJobGroupIdResetPostRequest {
-    jobGroupId: string;
-    resetEnvRequest: ResetEnvRequest;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface ScoreEnvApiEnvSessionSessionIdScorePostRequest {
-    sessionId: string;
-    scoreRequest: ScoreRequest;
-    authorization?: string;
-    xInternalService?: string;
-}
-export interface SendHeartbeatApiEnvJobIdHeartbeatPostRequest {
-    jobId: string;
-    authorization?: string;
-    xInternalService?: string;
-}
-/**
- *
- */
-export declare class EnvApi extends runtime.BaseAPI {
-    /**
-     * Create a backup of the environment.
-     * Backup Env
-     */
-    backupEnvApiEnvJobGroupIdBackupPostRaw(requestParameters: BackupEnvApiEnvJobGroupIdBackupPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Create a backup of the environment.
-     * Backup Env
-     */
-    backupEnvApiEnvJobGroupIdBackupPost(requestParameters: BackupEnvApiEnvJobGroupIdBackupPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Close Env
-     */
-    closeEnvApiEnvJobGroupIdClosePostRaw(requestParameters: CloseEnvApiEnvJobGroupIdClosePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Close Env
-     */
-    closeEnvApiEnvJobGroupIdClosePost(requestParameters: CloseEnvApiEnvJobGroupIdClosePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Create a new simulator.
-     * Create Simulator
-     */
-    createSimulatorApiEnvSimulatorsPostRaw(requestParameters: CreateSimulatorApiEnvSimulatorsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Create a new simulator.
-     * Create Simulator
-     */
-    createSimulatorApiEnvSimulatorsPost(requestParameters: CreateSimulatorApiEnvSimulatorsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Evaluate the session.
-     * Evaluate Session
-     */
-    evaluateSessionApiEnvSessionSessionIdEvaluatePostRaw(requestParameters: EvaluateSessionApiEnvSessionSessionIdEvaluatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Evaluate the session.
-     * Evaluate Session
-     */
-    evaluateSessionApiEnvSessionSessionIdEvaluatePost(requestParameters: EvaluateSessionApiEnvSessionSessionIdEvaluatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Get the active session for a job group.
-     * Get Active Session
-     */
-    getActiveSessionApiEnvJobGroupIdActiveSessionGetRaw(requestParameters: GetActiveSessionApiEnvJobGroupIdActiveSessionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Get the active session for a job group.
-     * Get Active Session
-     */
-    getActiveSessionApiEnvJobGroupIdActiveSessionGet(requestParameters: GetActiveSessionApiEnvJobGroupIdActiveSessionGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Get the CDP URL for the environment.
-     * Get Cdp Url
-     */
-    getCdpUrlApiEnvJobGroupIdCdpUrlGetRaw(requestParameters: GetCdpUrlApiEnvJobGroupIdCdpUrlGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Get the CDP URL for the environment.
-     * Get Cdp Url
-     */
-    getCdpUrlApiEnvJobGroupIdCdpUrlGet(requestParameters: GetCdpUrlApiEnvJobGroupIdCdpUrlGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Get Env State
-     */
-    getEnvStateApiEnvJobGroupIdStateGetRaw(requestParameters: GetEnvStateApiEnvJobGroupIdStateGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Get Env State
-     */
-    getEnvStateApiEnvJobGroupIdStateGet(requestParameters: GetEnvStateApiEnvJobGroupIdStateGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Get Job Status
-     */
-    getJobStatusApiEnvJobGroupIdStatusGetRaw(requestParameters: GetJobStatusApiEnvJobGroupIdStatusGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobStatusResponse>>;
-    /**
-     * Get Job Status
-     */
-    getJobStatusApiEnvJobGroupIdStatusGet(requestParameters: GetJobStatusApiEnvJobGroupIdStatusGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobStatusResponse>;
-    /**
-     * Get the public URL for the environment.
-     * Get Proxy Url
-     */
-    getProxyUrlApiEnvJobGroupIdProxyUrlGetRaw(requestParameters: GetProxyUrlApiEnvJobGroupIdProxyUrlGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Get the public URL for the environment.
-     * Get Proxy Url
-     */
-    getProxyUrlApiEnvJobGroupIdProxyUrlGet(requestParameters: GetProxyUrlApiEnvJobGroupIdProxyUrlGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Get all simulators with optimized queries.
-     * Get Simulators
-     */
-    getSimulatorsApiEnvSimulatorsGetRaw(requestParameters: GetSimulatorsApiEnvSimulatorsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
-        [key: string]: any;
-    }>>>;
-    /**
-     * Get all simulators with optimized queries.
-     * Get Simulators
-     */
-    getSimulatorsApiEnvSimulatorsGet(requestParameters?: GetSimulatorsApiEnvSimulatorsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Check if the workers for this job group are ready and healthy.  Uses the persistent job ready notification service to wait for job readiness. Falls back to checking Redis if notification not received (in case we missed it). Raises 500 if job not ready after all checks.
-     * Get Worker Ready
-     */
-    getWorkerReadyApiEnvJobIdWorkerReadyGetRaw(requestParameters: GetWorkerReadyApiEnvJobIdWorkerReadyGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkerReadyResponse>>;
-    /**
-     * Check if the workers for this job group are ready and healthy.  Uses the persistent job ready notification service to wait for job readiness. Falls back to checking Redis if notification not received (in case we missed it). Raises 500 if job not ready after all checks.
-     * Get Worker Ready
-     */
-    getWorkerReadyApiEnvJobIdWorkerReadyGet(requestParameters: GetWorkerReadyApiEnvJobIdWorkerReadyGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkerReadyResponse>;
-    /**
-     * Log a state mutation or batch of mutations.
-     * Log State Mutation
-     */
-    logStateMutationApiEnvSessionIdLogPostRaw(requestParameters: LogStateMutationApiEnvSessionIdLogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Log a state mutation or batch of mutations.
-     * Log State Mutation
-     */
-    logStateMutationApiEnvSessionIdLogPost(requestParameters: LogStateMutationApiEnvSessionIdLogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Make Env
-     */
-    makeEnvApiEnvMake2PostRaw(requestParameters: MakeEnvApiEnvMake2PostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MakeEnvResponse>>;
-    /**
-     * Make Env
-     */
-    makeEnvApiEnvMake2Post(requestParameters: MakeEnvApiEnvMake2PostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MakeEnvResponse>;
-    /**
-     * Reset the environment with an optional task.
-     * Reset Env
-     */
-    resetEnvApiEnvJobGroupIdResetPostRaw(requestParameters: ResetEnvApiEnvJobGroupIdResetPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Reset the environment with an optional task.
-     * Reset Env
-     */
-    resetEnvApiEnvJobGroupIdResetPost(requestParameters: ResetEnvApiEnvJobGroupIdResetPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Score the environment.
-     * Score Env
-     */
-    scoreEnvApiEnvSessionSessionIdScorePostRaw(requestParameters: ScoreEnvApiEnvSessionSessionIdScorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Score the environment.
-     * Score Env
-     */
-    scoreEnvApiEnvSessionSessionIdScorePost(requestParameters: ScoreEnvApiEnvSessionSessionIdScorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-    /**
-     * Send a heartbeat to keep the environment session alive.
-     * Send Heartbeat
-     */
-    sendHeartbeatApiEnvJobIdHeartbeatPostRaw(requestParameters: SendHeartbeatApiEnvJobIdHeartbeatPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
-        [key: string]: any;
-    }>>;
-    /**
-     * Send a heartbeat to keep the environment session alive.
-     * Send Heartbeat
-     */
-    sendHeartbeatApiEnvJobIdHeartbeatPost(requestParameters: SendHeartbeatApiEnvJobIdHeartbeatPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
-        [key: string]: any;
-    }>;
-}