@tiny-fish/sdk 0.0.6 → 0.0.7

package/dist/agent/types.d.ts

@@ -1,42 +1,75 @@
 /**
- * Agent automation request/response types.
+ * Agent automation request/response types and schemas.
  */
+import { z } from "zod";
 /** Browser profile for execution. */
-export declare enum BrowserProfile {
-    LITE = "lite",
-    STEALTH = "stealth"
-}
+export declare const BrowserProfile: {
+    readonly LITE: "lite";
+    readonly STEALTH: "stealth";
+};
+export declare const browserProfileSchema: z.ZodEnum<{
+    readonly LITE: "lite";
+    readonly STEALTH: "stealth";
+}>;
+export type BrowserProfile = z.infer<typeof browserProfileSchema>;
 /** ISO 3166-1 alpha-2 country code for proxy location. */
-export declare enum ProxyCountryCode {
-    US = "US",
-    GB = "GB",
-    CA = "CA",
-    DE = "DE",
-    FR = "FR",
-    JP = "JP",
-    AU = "AU"
-}
+export declare const ProxyCountryCode: {
+    readonly US: "US";
+    readonly GB: "GB";
+    readonly CA: "CA";
+    readonly DE: "DE";
+    readonly FR: "FR";
+    readonly JP: "JP";
+    readonly AU: "AU";
+};
+export declare const proxyCountryCodeSchema: z.ZodEnum<{
+    readonly US: "US";
+    readonly GB: "GB";
+    readonly CA: "CA";
+    readonly DE: "DE";
+    readonly FR: "FR";
+    readonly JP: "JP";
+    readonly AU: "AU";
+}>;
+export type ProxyCountryCode = z.infer<typeof proxyCountryCodeSchema>;
 /** Proxy configuration for browser automation. */
-export interface ProxyConfig {
-    /** Enable proxy for this automation run. */
-    enabled: boolean;
-    /** ISO 3166-1 alpha-2 country code for proxy location. */
-    country_code?: ProxyCountryCode;
-}
+export declare const proxyConfigSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    country_code: z.ZodOptional<z.ZodEnum<{
+        readonly US: "US";
+        readonly GB: "GB";
+        readonly CA: "CA";
+        readonly DE: "DE";
+        readonly FR: "FR";
+        readonly JP: "JP";
+        readonly AU: "AU";
+    }>>;
+}, z.core.$strict>;
+export type ProxyConfig = z.infer<typeof proxyConfigSchema>;
 /** Parameters for a synchronous agent run. */
-export interface AgentRunParams {
-    /** Natural language description of what to do on the page. */
-    goal: string;
-    /** The URL to open the browser on. */
-    url: string;
-    /** `"lite"` (default) or `"stealth"` (anti-detection). */
-    browser_profile?: BrowserProfile;
-    /** Optional proxy settings. */
-    proxy_config?: ProxyConfig;
-}
-/** Per-request transport controls for agent calls. */
+export declare const agentRunParamsSchema: z.ZodObject<{
+    goal: z.ZodString;
+    url: z.ZodString;
+    browser_profile: z.ZodOptional<z.ZodEnum<{
+        readonly LITE: "lite";
+        readonly STEALTH: "stealth";
+    }>>;
+    proxy_config: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        country_code: z.ZodOptional<z.ZodEnum<{
+            readonly US: "US";
+            readonly GB: "GB";
+            readonly CA: "CA";
+            readonly DE: "DE";
+            readonly FR: "FR";
+            readonly JP: "JP";
+            readonly AU: "AU";
+        }>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type AgentRunParams = z.infer<typeof agentRunParamsSchema>;
+/** Request-scoped options that are not part of the API wire contract. */
 export interface AgentRequestOptions {
-    /** Abort this specific request without changing the client-wide timeout. */
     signal?: AbortSignal;
 }
 /**
@@ -46,13 +79,21 @@ export interface AgentRequestOptions {
  * on run status — your IDE will autocomplete the options and typos become
  * type errors.
  */
-export declare enum RunStatus {
-    PENDING = "PENDING",
-    RUNNING = "RUNNING",
-    COMPLETED = "COMPLETED",
-    FAILED = "FAILED",
-    CANCELLED = "CANCELLED"
-}
+export declare const RunStatus: {
+    readonly PENDING: "PENDING";
+    readonly RUNNING: "RUNNING";
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+    readonly CANCELLED: "CANCELLED";
+};
+export declare const runStatusSchema: z.ZodEnum<{
+    readonly PENDING: "PENDING";
+    readonly RUNNING: "RUNNING";
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+    readonly CANCELLED: "CANCELLED";
+}>;
+export type RunStatus = z.infer<typeof runStatusSchema>;
 /**
  * Error category indicating the source of failure.
  *
@@ -60,24 +101,30 @@ export declare enum RunStatus {
  * - `AGENT_FAILURE` — Problem with the run itself, fix the input.
  * - `UNKNOWN` — Unclassified, treat as retryable.
  */
-export declare enum ErrorCategory {
-    SYSTEM_FAILURE = "SYSTEM_FAILURE",
-    AGENT_FAILURE = "AGENT_FAILURE",
-    UNKNOWN = "UNKNOWN"
-}
+export declare const ErrorCategory: {
+    readonly SYSTEM_FAILURE: "SYSTEM_FAILURE";
+    readonly AGENT_FAILURE: "AGENT_FAILURE";
+    readonly UNKNOWN: "UNKNOWN";
+};
+export declare const errorCategorySchema: z.ZodEnum<{
+    readonly SYSTEM_FAILURE: "SYSTEM_FAILURE";
+    readonly AGENT_FAILURE: "AGENT_FAILURE";
+    readonly UNKNOWN: "UNKNOWN";
+}>;
+export type ErrorCategory = z.infer<typeof errorCategorySchema>;
 /** Error details for failed runs. */
-export interface RunError {
-    /** Error message describing why the run failed. */
-    message: string;
-    /** Error category indicating the source of failure. */
-    category: ErrorCategory;
-    /** Suggested retry delay in whole seconds (integer). */
-    retry_after: number | null;
-    /** URL to troubleshooting docs. */
-    help_url?: string;
-    /** Human-readable guidance. */
-    help_message?: string;
-}
+export declare const runErrorSchema: z.ZodObject<{
+    message: z.ZodString;
+    category: z.ZodEnum<{
+        readonly SYSTEM_FAILURE: "SYSTEM_FAILURE";
+        readonly AGENT_FAILURE: "AGENT_FAILURE";
+        readonly UNKNOWN: "UNKNOWN";
+    }>;
+    retry_after: z.ZodNullable<z.ZodNumber>;
+    help_url: z.ZodOptional<z.ZodString>;
+    help_message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type RunError = z.infer<typeof runErrorSchema>;
 /**
  * Response from synchronous automation execution.
  *
@@ -85,92 +132,171 @@ export interface RunError {
  * - On success: `result` is populated, `error` is `null`.
  * - On failure: `result` is `null`, `error` contains the message.
  */
-export interface AgentRunResponse {
-    /** Final status of the automation run. */
-    status: RunStatus;
-    /** Unique identifier for the automation run. */
-    run_id: string | null;
-    /** Structured JSON result extracted from the automation. `null` if the run failed. */
-    result: Record<string, unknown> | null;
-    /** Error details. `null` if the run succeeded. */
-    error: RunError | null;
-    /** Number of steps taken during the automation. */
-    num_of_steps: number;
-    /** ISO 8601 timestamp when the run started. */
-    started_at: string | null;
-    /** ISO 8601 timestamp when the run finished. */
-    finished_at: string | null;
-}
+export declare const agentRunResponseSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        readonly PENDING: "PENDING";
+        readonly RUNNING: "RUNNING";
+        readonly COMPLETED: "COMPLETED";
+        readonly FAILED: "FAILED";
+        readonly CANCELLED: "CANCELLED";
+    }>;
+    run_id: z.ZodNullable<z.ZodString>;
+    result: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    error: z.ZodNullable<z.ZodObject<{
+        message: z.ZodString;
+        category: z.ZodEnum<{
+            readonly SYSTEM_FAILURE: "SYSTEM_FAILURE";
+            readonly AGENT_FAILURE: "AGENT_FAILURE";
+            readonly UNKNOWN: "UNKNOWN";
+        }>;
+        retry_after: z.ZodNullable<z.ZodNumber>;
+        help_url: z.ZodOptional<z.ZodString>;
+        help_message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    num_of_steps: z.ZodNullable<z.ZodNumber>;
+    started_at: z.ZodNullable<z.ZodString>;
+    finished_at: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type AgentRunResponse = z.infer<typeof agentRunResponseSchema>;
 /**
  * Response from asynchronous automation execution.
  *
  * Returns `run_id` immediately without waiting for completion.
  * Use `client.runs.get(run_id)` to check status later.
- *
- * This is a discriminated union — check `error` to narrow the type:
- * ```typescript
- * const response = await client.agent.queue({ goal, url });
- * if (response.error) {
- *     // response.run_id is null here
- *     console.error(response.error.message);
- * } else {
- *     // response.run_id is string here
- *     const run = await client.runs.get(response.run_id);
- * }
- * ```
  */
-export type AgentRunAsyncResponse = {
-    /** Unique identifier for the created automation run. */ run_id: string /** No error. */;
-    error: null;
-} | {
-    run_id: null /** Error details. */;
-    error: RunError;
-};
+export declare const agentRunAsyncResponseSchema: z.ZodUnion<readonly [z.ZodObject<{
+    run_id: z.ZodString;
+    error: z.ZodNull;
+}, z.core.$strip>, z.ZodObject<{
+    run_id: z.ZodNull;
+    error: z.ZodObject<{
+        message: z.ZodString;
+        category: z.ZodEnum<{
+            readonly SYSTEM_FAILURE: "SYSTEM_FAILURE";
+            readonly AGENT_FAILURE: "AGENT_FAILURE";
+            readonly UNKNOWN: "UNKNOWN";
+        }>;
+        retry_after: z.ZodNullable<z.ZodNumber>;
+        help_url: z.ZodOptional<z.ZodString>;
+        help_message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>]>;
+export type AgentRunAsyncResponse = z.infer<typeof agentRunAsyncResponseSchema>;
 /** SSE event type discriminator. */
-export declare enum EventType {
-    STARTED = "STARTED",
-    STREAMING_URL = "STREAMING_URL",
-    PROGRESS = "PROGRESS",
-    HEARTBEAT = "HEARTBEAT",
-    COMPLETE = "COMPLETE"
-}
+export declare const EventType: {
+    readonly STARTED: "STARTED";
+    readonly STREAMING_URL: "STREAMING_URL";
+    readonly PROGRESS: "PROGRESS";
+    readonly HEARTBEAT: "HEARTBEAT";
+    readonly COMPLETE: "COMPLETE";
+};
+export declare const eventTypeSchema: z.ZodEnum<{
+    readonly STARTED: "STARTED";
+    readonly STREAMING_URL: "STREAMING_URL";
+    readonly PROGRESS: "PROGRESS";
+    readonly HEARTBEAT: "HEARTBEAT";
+    readonly COMPLETE: "COMPLETE";
+}>;
+export type EventType = z.infer<typeof eventTypeSchema>;
 /** SSE event indicating the automation run has started. */
-export interface StartedEvent {
-    type: "STARTED";
-    run_id: string;
-    timestamp: string;
-}
+export declare const startedEventSchema: z.ZodObject<{
+    type: z.ZodLiteral<"STARTED">;
+    run_id: z.ZodString;
+    timestamp: z.ZodString;
+}, z.core.$strip>;
+export type StartedEvent = z.infer<typeof startedEventSchema>;
 /** SSE event providing the live browser streaming URL. */
-export interface StreamingUrlEvent {
-    type: "STREAMING_URL";
-    run_id: string;
-    streaming_url: string;
-    timestamp: string;
-}
+export declare const streamingUrlEventSchema: z.ZodObject<{
+    type: z.ZodLiteral<"STREAMING_URL">;
+    run_id: z.ZodString;
+    streaming_url: z.ZodString;
+    timestamp: z.ZodString;
+}, z.core.$strip>;
+export type StreamingUrlEvent = z.infer<typeof streamingUrlEventSchema>;
 /** SSE event indicating automation progress/activity. */
-export interface ProgressEvent {
-    type: "PROGRESS";
-    run_id: string;
-    purpose: string;
-    timestamp: string;
-}
+export declare const progressEventSchema: z.ZodObject<{
+    type: z.ZodLiteral<"PROGRESS">;
+    run_id: z.ZodString;
+    purpose: z.ZodString;
+    timestamp: z.ZodString;
+}, z.core.$strip>;
+export type ProgressEvent = z.infer<typeof progressEventSchema>;
 /** SSE event for connection keepalive. */
-export interface HeartbeatEvent {
-    type: "HEARTBEAT";
-    timestamp: string;
-}
+export declare const heartbeatEventSchema: z.ZodObject<{
+    type: z.ZodLiteral<"HEARTBEAT">;
+    timestamp: z.ZodString;
+}, z.core.$strip>;
+export type HeartbeatEvent = z.infer<typeof heartbeatEventSchema>;
 /** SSE event indicating the automation run has completed. */
-export interface CompleteEvent {
-    type: "COMPLETE";
-    run_id: string;
-    status: RunStatus;
-    timestamp: string;
-    result: Record<string, unknown> | null;
-    error: RunError | null;
-}
+export declare const completeEventSchema: z.ZodObject<{
+    type: z.ZodLiteral<"COMPLETE">;
+    run_id: z.ZodString;
+    status: z.ZodEnum<{
+        readonly PENDING: "PENDING";
+        readonly RUNNING: "RUNNING";
+        readonly COMPLETED: "COMPLETED";
+        readonly FAILED: "FAILED";
+        readonly CANCELLED: "CANCELLED";
+    }>;
+    timestamp: z.ZodString;
+    result: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    error: z.ZodNullable<z.ZodObject<{
+        message: z.ZodString;
+        category: z.ZodEnum<{
+            readonly SYSTEM_FAILURE: "SYSTEM_FAILURE";
+            readonly AGENT_FAILURE: "AGENT_FAILURE";
+            readonly UNKNOWN: "UNKNOWN";
+        }>;
+        retry_after: z.ZodNullable<z.ZodNumber>;
+        help_url: z.ZodOptional<z.ZodString>;
+        help_message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type CompleteEvent = z.infer<typeof completeEventSchema>;
 /** Union type for all possible SSE streaming events. */
-export type AgentRunWithStreamingResponse = StartedEvent | StreamingUrlEvent | ProgressEvent | HeartbeatEvent | CompleteEvent;
-/** Optional callbacks for stream events. */
+export declare const agentRunWithStreamingResponseSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"STARTED">;
+    run_id: z.ZodString;
+    timestamp: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"STREAMING_URL">;
+    run_id: z.ZodString;
+    streaming_url: z.ZodString;
+    timestamp: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"PROGRESS">;
+    run_id: z.ZodString;
+    purpose: z.ZodString;
+    timestamp: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"HEARTBEAT">;
+    timestamp: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"COMPLETE">;
+    run_id: z.ZodString;
+    status: z.ZodEnum<{
+        readonly PENDING: "PENDING";
+        readonly RUNNING: "RUNNING";
+        readonly COMPLETED: "COMPLETED";
+        readonly FAILED: "FAILED";
+        readonly CANCELLED: "CANCELLED";
+    }>;
+    timestamp: z.ZodString;
+    result: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    error: z.ZodNullable<z.ZodObject<{
+        message: z.ZodString;
+        category: z.ZodEnum<{
+            readonly SYSTEM_FAILURE: "SYSTEM_FAILURE";
+            readonly AGENT_FAILURE: "AGENT_FAILURE";
+            readonly UNKNOWN: "UNKNOWN";
+        }>;
+        retry_after: z.ZodNullable<z.ZodNumber>;
+        help_url: z.ZodOptional<z.ZodString>;
+        help_message: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "type">;
+export type AgentRunWithStreamingResponse = z.infer<typeof agentRunWithStreamingResponseSchema>;
+/** Optional callbacks for stream events plus request-scoped options. */
 export interface StreamOptions extends AgentRequestOptions {
     onStarted?: (event: StartedEvent) => void;
     onStreamingUrl?: (event: StreamingUrlEvent) => void;

package/dist/agent/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/agent/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,qCAAqC;AACrC,oBAAY,cAAc;IACzB,IAAI,SAAS;IACb,OAAO,YAAY;CACnB;AAED,0DAA0D;AAC1D,oBAAY,gBAAgB;IAC3B,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;CACT;AAED,kDAAkD;AAClD,MAAM,WAAW,WAAW;IAC3B,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,gBAAgB,CAAC;CAChC;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC9B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,+BAA+B;IAC/B,YAAY,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,sDAAsD;AACtD,MAAM,WAAW,mBAAmB;IACnC,4EAA4E;IAC5E,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB;AAID;;;;;;GAMG;AACH,oBAAY,SAAS;IACpB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,SAAS,cAAc;CACvB;AAED;;;;;;GAMG;AACH,oBAAY,aAAa;IACxB,cAAc,mBAAmB;IACjC,aAAa,kBAAkB;IAC/B,OAAO,YAAY;CACnB;AAED,qCAAqC;AACrC,MAAM,WAAW,QAAQ;IACxB,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,QAAQ,EAAE,aAAa,CAAC;IACxB,wDAAwD;IACxD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAChC,0CAA0C;IAC1C,MAAM,EAAE,SAAS,CAAC;IAClB,gDAAgD;IAChD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,kDAAkD;IAClD,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,gDAAgD;IAChD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,qBAAqB,GAC9B;IACA,wDAAwD,CAAC,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACzF,KAAK,EAAE,IAAI,CAAC;CACX,GACD;IAA+B,MAAM,EAAE,IAAI,CAAC,qBAAqB,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,CAAC;AAIxF,oCAAoC;AACpC,oBAAY,SAAS;IACpB,OAAO,YAAY;IACnB,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,QAAQ,aAAa;CACrB;AAED,2DAA2D;AAC3D,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,0DAA0D;AAC1D,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,yDAAyD;AACzD,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,0CAA0C;AAC1C,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,6DAA6D;AAC7D,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;CACvB;AAED,wDAAwD;AACxD,MAAM,MAAM,6BAA6B,GACtC,YAAY,GACZ,iBAAiB,GACjB,aAAa,GACb,cAAc,GACd,aAAa,CAAC;AAEjB,4CAA4C;AAC5C,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACzD,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IAC1C,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACpD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;IAC5C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC9C,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;CAC5C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/agent/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,qCAAqC;AACrC,eAAO,MAAM,cAAc;;;CAGjB,CAAC;AACX,eAAO,MAAM,oBAAoB;;;EAAyB,CAAC;AAC3D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,0DAA0D;AAC1D,eAAO,MAAM,gBAAgB;;;;;;;;CAQnB,CAAC;AACX,eAAO,MAAM,sBAAsB;;;;;;;;EAA2B,CAAC;AAC/D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,kDAAkD;AAClD,eAAO,MAAM,iBAAiB;;;;;;;;;;;kBAG5B,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,8CAA8C;AAC9C,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;kBAK/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,yEAAyE;AACzE,MAAM,WAAW,mBAAmB;IACnC,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,SAAS;;;;;;CAMZ,CAAC;AACX,eAAO,MAAM,eAAe;;;;;;EAAoB,CAAC;AACjD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;;;;CAIhB,CAAC;AACX,eAAO,MAAM,mBAAmB;;;;EAAwB,CAAC;AACzD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,qCAAqC;AACrC,eAAO,MAAM,cAAc;;;;;;;;;;iBAMzB,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;iBAQjC,CAAC;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;mBAStC,CAAC;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,oCAAoC;AACpC,eAAO,MAAM,SAAS;;;;;;CAMZ,CAAC;AACX,eAAO,MAAM,eAAe;;;;;;EAAoB,CAAC;AACjD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD,2DAA2D;AAC3D,eAAO,MAAM,kBAAkB;;;;iBAI7B,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;;;;;iBAKlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,yDAAyD;AACzD,eAAO,MAAM,mBAAmB;;;;;iBAK9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,0CAA0C;AAC1C,eAAO,MAAM,oBAAoB;;;iBAG/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,6DAA6D;AAC7D,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;iBAO9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,wDAAwD;AACxD,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAM9C,CAAC;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG,wEAAwE;AACxE,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACzD,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;IAC1C,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACpD,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;IAC5C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC9C,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;CAC5C"}

package/dist/agent/types.js

@@ -1,25 +1,36 @@
 /**
- * Agent automation request/response types.
+ * Agent automation request/response types and schemas.
  */
-// -- Input types --
+import { z } from "zod";
 /** Browser profile for execution. */
-export var BrowserProfile;
-(function (BrowserProfile) {
-    BrowserProfile["LITE"] = "lite";
-    BrowserProfile["STEALTH"] = "stealth";
-})(BrowserProfile || (BrowserProfile = {}));
+export const BrowserProfile = {
+    LITE: "lite",
+    STEALTH: "stealth",
+};
+export const browserProfileSchema = z.enum(BrowserProfile);
 /** ISO 3166-1 alpha-2 country code for proxy location. */
-export var ProxyCountryCode;
-(function (ProxyCountryCode) {
-    ProxyCountryCode["US"] = "US";
-    ProxyCountryCode["GB"] = "GB";
-    ProxyCountryCode["CA"] = "CA";
-    ProxyCountryCode["DE"] = "DE";
-    ProxyCountryCode["FR"] = "FR";
-    ProxyCountryCode["JP"] = "JP";
-    ProxyCountryCode["AU"] = "AU";
-})(ProxyCountryCode || (ProxyCountryCode = {}));
-// -- Response types (shared with runs later) --
+export const ProxyCountryCode = {
+    US: "US",
+    GB: "GB",
+    CA: "CA",
+    DE: "DE",
+    FR: "FR",
+    JP: "JP",
+    AU: "AU",
+};
+export const proxyCountryCodeSchema = z.enum(ProxyCountryCode);
+/** Proxy configuration for browser automation. */
+export const proxyConfigSchema = z.strictObject({
+    enabled: z.boolean(),
+    country_code: proxyCountryCodeSchema.optional(),
+});
+/** Parameters for a synchronous agent run. */
+export const agentRunParamsSchema = z.strictObject({
+    goal: z.string(),
+    url: z.string(),
+    browser_profile: browserProfileSchema.optional(),
+    proxy_config: proxyConfigSchema.optional(),
+});
 /**
  * Status of an automation run.
  *
@@ -27,14 +38,14 @@ export var ProxyCountryCode;
  * on run status — your IDE will autocomplete the options and typos become
  * type errors.
  */
-export var RunStatus;
-(function (RunStatus) {
-    RunStatus["PENDING"] = "PENDING";
-    RunStatus["RUNNING"] = "RUNNING";
-    RunStatus["COMPLETED"] = "COMPLETED";
-    RunStatus["FAILED"] = "FAILED";
-    RunStatus["CANCELLED"] = "CANCELLED";
-})(RunStatus || (RunStatus = {}));
+export const RunStatus = {
+    PENDING: "PENDING",
+    RUNNING: "RUNNING",
+    COMPLETED: "COMPLETED",
+    FAILED: "FAILED",
+    CANCELLED: "CANCELLED",
+};
+export const runStatusSchema = z.enum(RunStatus);
 /**
  * Error category indicating the source of failure.
  *
@@ -42,20 +53,101 @@ export var RunStatus;
  * - `AGENT_FAILURE` — Problem with the run itself, fix the input.
  * - `UNKNOWN` — Unclassified, treat as retryable.
  */
-export var ErrorCategory;
-(function (ErrorCategory) {
-    ErrorCategory["SYSTEM_FAILURE"] = "SYSTEM_FAILURE";
-    ErrorCategory["AGENT_FAILURE"] = "AGENT_FAILURE";
-    ErrorCategory["UNKNOWN"] = "UNKNOWN";
-})(ErrorCategory || (ErrorCategory = {}));
-// -- SSE streaming event types --
+export const ErrorCategory = {
+    SYSTEM_FAILURE: "SYSTEM_FAILURE",
+    AGENT_FAILURE: "AGENT_FAILURE",
+    UNKNOWN: "UNKNOWN",
+};
+export const errorCategorySchema = z.enum(ErrorCategory);
+/** Error details for failed runs. */
+export const runErrorSchema = z.object({
+    message: z.string(),
+    category: errorCategorySchema,
+    retry_after: z.number().nullable(),
+    help_url: z.string().optional(),
+    help_message: z.string().optional(),
+});
+/**
+ * Response from synchronous automation execution.
+ *
+ * Check `status` to determine success/failure:
+ * - On success: `result` is populated, `error` is `null`.
+ * - On failure: `result` is `null`, `error` contains the message.
+ */
+export const agentRunResponseSchema = z.object({
+    status: runStatusSchema,
+    run_id: z.string().nullable(),
+    result: z.record(z.string(), z.unknown()).nullable(),
+    error: runErrorSchema.nullable(),
+    num_of_steps: z.number().nullable(),
+    started_at: z.string().nullable(),
+    finished_at: z.string().nullable(),
+});
+/**
+ * Response from asynchronous automation execution.
+ *
+ * Returns `run_id` immediately without waiting for completion.
+ * Use `client.runs.get(run_id)` to check status later.
+ */
+export const agentRunAsyncResponseSchema = z.union([
+    z.object({
+        run_id: z.string(),
+        error: z.null(),
+    }),
+    z.object({
+        run_id: z.null(),
+        error: runErrorSchema,
+    }),
+]);
 /** SSE event type discriminator. */
-export var EventType;
-(function (EventType) {
-    EventType["STARTED"] = "STARTED";
-    EventType["STREAMING_URL"] = "STREAMING_URL";
-    EventType["PROGRESS"] = "PROGRESS";
-    EventType["HEARTBEAT"] = "HEARTBEAT";
-    EventType["COMPLETE"] = "COMPLETE";
-})(EventType || (EventType = {}));
+export const EventType = {
+    STARTED: "STARTED",
+    STREAMING_URL: "STREAMING_URL",
+    PROGRESS: "PROGRESS",
+    HEARTBEAT: "HEARTBEAT",
+    COMPLETE: "COMPLETE",
+};
+export const eventTypeSchema = z.enum(EventType);
+/** SSE event indicating the automation run has started. */
+export const startedEventSchema = z.object({
+    type: z.literal(EventType.STARTED),
+    run_id: z.string(),
+    timestamp: z.string(),
+});
+/** SSE event providing the live browser streaming URL. */
+export const streamingUrlEventSchema = z.object({
+    type: z.literal(EventType.STREAMING_URL),
+    run_id: z.string(),
+    streaming_url: z.string(),
+    timestamp: z.string(),
+});
+/** SSE event indicating automation progress/activity. */
+export const progressEventSchema = z.object({
+    type: z.literal(EventType.PROGRESS),
+    run_id: z.string(),
+    purpose: z.string(),
+    timestamp: z.string(),
+});
+/** SSE event for connection keepalive. */
+export const heartbeatEventSchema = z.object({
+    type: z.literal(EventType.HEARTBEAT),
+    timestamp: z.string(),
+});
+/** SSE event indicating the automation run has completed. */
+export const completeEventSchema = z.object({
+    type: z.literal(EventType.COMPLETE),
+    run_id: z.string(),
+    status: runStatusSchema,
+    timestamp: z.string(),
+    result: z.record(z.string(), z.unknown()).nullable(),
+    error: runErrorSchema.nullable(),
+});
+/** Union type for all possible SSE streaming events. */
+export const agentRunWithStreamingResponseSchema = z.discriminatedUnion("type", [
+    startedEventSchema,
+    streamingUrlEventSchema,
+    progressEventSchema,
+    heartbeatEventSchema,
+    completeEventSchema,
+]);
 //# sourceMappingURL=types.js.map