cloudcruise 0.0.2-alpha.0 → 0.0.2-alpha.2

package/README.md

@@ -1,9 +1,9 @@
 # cloudcruise-js
 
 [![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![NPM version](https://img.shields.io/npm/v/cloudcruise.svg?style=flat-square)](https://www.npmjs.com/package/cloudcruise)
+![NPM Downloads](https://img.shields.io/npm/dw/cloudcruise)
 [![GitHub Repo stars](https://img.shields.io/github/stars/CloudCruise/cloudcruise-js?style=flat-square&logo=GitHub&label=cloudcruise-js)](https://github.com/CloudCruise/cloudcruise-js)
-[![Discord](https://img.shields.io/discord/1111061815649124414?style=flat-square&logo=Discord&logoColor=white&label=Discord&color=%23434EE4)](https://discord.com/invite/MHjbUqedZF)
+[![Discord](https://img.shields.io/discord/1227480834945318933?style=flat-square&logo=Discord&logoColor=white&label=Discord&color=%23434EE4)](https://discord.com/invite/MHjbUqedZF)
 [![YC W24](https://img.shields.io/badge/Y%20Combinator-W24-orange?style=flat-square)](https://www.ycombinator.com/companies/cloudcruise)
 
 The official CloudCruise JavaScript/TypeScript client library for automated browser workflows, credential management, and real-time monitoring.

package/dist/CloudCruise.js

@@ -63,8 +63,7 @@ export class CloudCruise {
             }
             const contentType = response.headers.get('content-type');
             if (contentType && contentType.includes('application/json')) {
-                const jsonResponse = await response.json();
-                return jsonResponse.data || jsonResponse;
+                return await response.json();
             }
             else {
                 return await response.text();

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export { RunsClient } from './runs/RunsClient.js';
 export { WebhookClient } from './webhook/WebhookClient.js';
 export type { VaultEntry, GetVaultEntriesFilters, ProxyConfig, VaultPostPutHeadersInBody } from './vault/types.js';
 export type { Workflow, WorkflowInputSchema, WorkflowMetadata } from './workflows/types.js';
-export type { EventType, DryRun, Metadata, RunSpecificWebhook, PayloadWebhook, StartRunRequest, StartRunResponse, UserInteractionData, VideoUrl, FileUrl, ScreenshotUrl, RunError, RunResult, WebhookEvent, WebhookReplayResponse, RunHandle, RunStreamOptions, SseEventName, SseMessage, RunEventEnvelope } from './runs/types.js';
+export type { EventType, DryRun, Metadata, RunSpecificWebhook, PayloadWebhook, StartRunRequest, StartRunResponse, UserInteractionData, VideoUrl, SignedFileUrl, SignedScreenshotUrl, RunError, WorkflowError, RunResult, GetRunResult, WebhookEvent, WebhookReplayResponse, RunHandle, RunStreamOptions, SseEventName, SseMessage, RunEventEnvelope } from './runs/types.js';
 export type { WebhookPayload, WebhookVerificationOptions } from './webhook/types.js';
 export { VerificationError } from './webhook/types.js';
 export { InputValidationError } from './workflows/types.js';

package/dist/runs/RunsClient.d.ts

@@ -1,4 +1,4 @@
-import type { StartRunRequest, UserInteractionData, RunResult, WebhookReplayResponse, RunHandle, RunStreamOptions } from './types.js';
+import type { StartRunRequest, UserInteractionData, GetRunResult, WebhookReplayResponse, RunHandle, RunStreamOptions } from './types.js';
 import { ConnectionManager } from '../utils/connectionManager.js';
 export declare class RunsClient {
     private readonly makeRequest;
@@ -27,7 +27,7 @@ export declare class RunsClient {
      * @param sessionId - The unique identifier for the workflow execution session
      * @returns Promise resolving to complete run results
      */
-    getResults(sessionId: string): Promise<RunResult>;
+    getResults(sessionId: string): Promise<GetRunResult>;
     /**
      * Interrupts a running browser agent run
      * @param sessionId - The unique identifier for the workflow execution session

package/dist/runs/types.d.ts

@@ -34,26 +34,37 @@ export interface VideoUrl {
     signed_screen_recording_url: string;
     signed_screen_recording_url_expires: string;
 }
-export interface FileUrl {
+export interface RunError {
+    prompt?: string | null;
+    message?: string | null;
+    error_id?: string | null;
+    full_url?: string | null;
+    llm_model?: string | null;
+    created_at?: string | null;
+    error_code?: string | null;
+    action_type?: string | null;
+    action_display_name?: string | null;
+}
+export interface SignedFileUrl {
     signed_file_url: string;
     file_name: string;
     timestamp: string;
     signed_file_url_expires: string;
     metadata: Record<string, any>;
 }
-export interface ScreenshotUrl {
+export interface SignedScreenshotUrl {
     signed_screenshot_url: string;
     node_display_name: string;
     timestamp: string;
     signed_screenshot_url_expires: string;
     error_screenshot: boolean;
+    full_length_screenshot?: boolean;
+    retry_index?: number;
 }
-export interface RunError {
-    prompt?: string | null;
-    message?: string | null;
-    error_id?: string | null;
+export interface WorkflowError {
+    message: string;
+    error_id: string;
     full_url?: string | null;
-    llm_model?: string | null;
     created_at?: string | null;
     error_code?: string | null;
     action_type?: string | null;
@@ -65,10 +76,23 @@ export interface RunResult {
     input_variables: Record<string, any>;
     data: Record<string, any>;
     video_urls: VideoUrl[];
-    file_urls: FileUrl[];
-    screenshot_urls: ScreenshotUrl[];
+    file_urls: SignedFileUrl[];
+    screenshot_urls: SignedScreenshotUrl[];
     errors: RunError[] | null;
 }
+export interface GetRunResult {
+    data: Record<string, any> | null;
+    session_id: string;
+    errors: WorkflowError[];
+    status: EventType;
+    input_variables: Record<string, any>;
+    workflow_id: string | null;
+    session_retries: number | null;
+    encrypted_variables: string[] | null;
+    video_urls: VideoUrl[] | null;
+    screenshot_urls?: SignedScreenshotUrl[] | null;
+    file_urls: SignedFileUrl[] | null;
+}
 export interface WebhookEvent {
     success: boolean;
     response: string;
@@ -119,7 +143,7 @@ export interface RunStreamOptions {
 export interface RunHandle {
     sessionId: string;
     on(event: 'open' | 'reconnect' | 'error' | 'end' | SseEventName | 'message', handler: (e: unknown) => void): () => void;
-    wait(): Promise<RunResult>;
+    wait(): Promise<GetRunResult>;
     close(): void;
     [Symbol.asyncIterator](): AsyncIterator<SseMessage>;
 }

package/dist/vault/VaultClient.d.ts

@@ -17,12 +17,26 @@ export declare class VaultClient {
     get(filters?: GetVaultEntriesFilters): Promise<VaultEntry[]>;
     /**
      * Updates an existing vault entry
+     * @param updates - Vault entry updates including required fields
+     * @param updates.permissioned_user_id - Required: User identifier for the vault entry
+     * @param updates.user_name - Required: Username or email
+     * @param updates.password - Required: User password
+     * @param updates.domain - Required: Target domain for the credentials
      */
-    update(id: string, updates: Partial<VaultEntry>): Promise<VaultEntry>;
+    update(updates: Partial<VaultEntry> & {
+        permissioned_user_id: string;
+        user_name: string;
+        password: string;
+        domain: string;
+    }): Promise<VaultEntry>;
     /**
      * Deletes a vault entry by domain and permissioned user ID
-     * @param domain - The domain of the vault entry to delete
-     * @param permissioned_user_id - The permissioned user ID of the vault entry to delete
+     * @param params - Object containing domain and permissioned_user_id
+     * @param params.domain - The domain of the vault entry to delete
+     * @param params.permissioned_user_id - The permissioned user ID of the vault entry to delete
      */
-    delete(domain: string, permissioned_user_id: string): Promise<void>;
+    delete(params: {
+        domain: string;
+        permissioned_user_id: string;
+    }): Promise<void>;
 }

package/dist/vault/VaultClient.js

@@ -52,13 +52,27 @@ export class VaultClient {
     }
     /**
      * Updates an existing vault entry
+     * @param updates - Vault entry updates including required fields
+     * @param updates.permissioned_user_id - Required: User identifier for the vault entry
+     * @param updates.user_name - Required: Username or email
+     * @param updates.password - Required: User password
+     * @param updates.domain - Required: Target domain for the credentials
      */
-    async update(id, updates) {
-        const entry = {
-            id,
-            ...updates
-        };
-        let processedEntry = { ...entry };
+    async update(updates) {
+        // Validate required fields
+        if (!updates.permissioned_user_id) {
+            throw new Error('permissioned_user_id is required for vault updates');
+        }
+        if (!updates.user_name) {
+            throw new Error('user_name is required for vault updates');
+        }
+        if (!updates.password) {
+            throw new Error('password is required for vault updates');
+        }
+        if (!updates.domain) {
+            throw new Error('domain is required for vault updates');
+        }
+        let processedEntry = { ...updates };
         // Encrypt sensitive fields
         processedEntry = await encryptSensitiveFields(processedEntry, this.encryptionKey);
         const response = await this.makeRequest('PUT', '/vault', processedEntry);
@@ -67,10 +81,11 @@ export class VaultClient {
     }
     /**
      * Deletes a vault entry by domain and permissioned user ID
-     * @param domain - The domain of the vault entry to delete
-     * @param permissioned_user_id - The permissioned user ID of the vault entry to delete
+     * @param params - Object containing domain and permissioned_user_id
+     * @param params.domain - The domain of the vault entry to delete
+     * @param params.permissioned_user_id - The permissioned user ID of the vault entry to delete
      */
-    async delete(domain, permissioned_user_id) {
-        await this.makeRequest('DELETE', '/vault', { domain, permissioned_user_id });
+    async delete(params) {
+        await this.makeRequest('DELETE', '/vault', params);
     }
 }

package/dist/vault/types.d.ts

@@ -10,7 +10,7 @@ export interface ProxyConfig {
     target_ip?: string;
 }
 export interface VaultEntry {
-    id?: string;
+    id: string;
     domain: string;
     permissioned_user_id: string;
     workspace_id?: string;
@@ -24,17 +24,24 @@ export interface VaultEntry {
     ip_address?: string;
     session_id?: string;
     allow_multiple_sessions?: boolean;
+    prevent_concurrency_during_login?: boolean | null;
+    max_concurrency?: number | null;
+    expiry_time_from_last_use?: string | null;
+    expiry_time_from_session_data_set?: string | null;
+    tfa_method?: 'AUTHENTICATOR' | 'EMAIL' | 'SMS' | null;
     cookies?: any;
     local_storage?: any;
     session_storage?: any;
-    persist_cookies?: boolean;
-    persist_local_storage?: boolean;
-    persist_session_storage?: boolean;
+    persist_cookies?: boolean | null;
+    persist_local_storage?: boolean | null;
+    persist_session_storage?: boolean | null;
     cookie_domain_to_store?: string | null;
     proxy?: ProxyConfig;
     proxy_string?: string | null;
     headers?: VaultPostPutHeadersInBody[];
     created_at?: string | null;
+    session_data_set_at?: string | null;
+    effective_expires_at?: string | null;
 }
 export interface GetVaultEntriesFilters {
     permissioned_user_id?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudcruise",
-  "version": "0.0.2-alpha.0",
+  "version": "0.0.2-alpha.2",
   "description": "The official CloudCruise JS/TS client.",
   "homepage": "https://github.com/CloudCruise/cloudcruise-js#readme",
   "bugs": {
@@ -21,7 +21,7 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "pnpm build && node --test test/*.test.js"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",