@oya-ai/browser 1.0.119 → 1.0.121

package/dist/index.d.cts

@@ -273,6 +273,69 @@ type LlmProvider = 'openai' | 'anthropic'
 /** Gemini Enterprise, ex-Vertex AI. Express mode by default; set `openai_base_url` to a
  *  project-scoped `.../endpoints/openapi` endpoint to use an enterprise project. */
  | 'vertex';
+/**
+ * Which runtime this key's `'oya-cloud'` browsers run on. `'docker'` and `'k8s'`
+ * run on the deployment's own daemon or cluster, exactly as its operator set them up;
+ * `'daytona'` and `'ecs'` run on your own account once you set that runtime's
+ * credentials below, and on the deployment's otherwise.
+ */
+type SandboxRuntime = 'daytona' | 'docker' | 'k8s' | 'ecs';
+/**
+ * How Oya signs in to your AWS account to run `'ecs'` browsers.
+ *
+ * - `iam`: an access key (optionally temporary, with its session token).
+ * - `role`: Oya assumes `roleArn` from its own AWS identity. Put Oya's AWS
+ *   account and `config.get().ecs.externalId` in the role's trust policy; the
+ *   ExternalId is Oya's, one per API key, and cannot be set.
+ * - `sso`: an IAM Identity Center access token (from `aws sso login`'s cache or
+ *   the SSO OIDC device flow) for `accountId` and `roleName`. It expires; starts
+ *   then fail with `sso_token_expired` until you set a fresh one.
+ */
+type EcsAuth = {
+    /** An IAM access key. */
+    type: 'iam';
+    /** The access key id. */
+    accessKeyId: string;
+    /** Its secret. Read back masked. */
+    secretAccessKey: string;
+    /** For temporary credentials. Read back masked. */
+    sessionToken?: string;
+} | {
+    /** A role Oya assumes. */
+    type: 'role';
+    /** e.g. arn:aws:iam::123456789012:role/oya-browsers */
+    roleArn: string;
+} | {
+    /** IAM Identity Center. */
+    type: 'sso';
+    /** The SSO access token. Read back masked. */
+    accessToken: string;
+    /** The 12-digit account to sign in to. */
+    accountId: string;
+    /** The permission set's role name in that account. */
+    roleName: string;
+    /** The SSO portal's region, when it differs from `region`. */
+    ssoRegion?: string;
+};
+/** Where `'ecs'` browsers run: one Fargate task each, of a task definition that runs the Oya browser image. */
+interface EcsConfig {
+    /** The ECS cluster. */
+    cluster: string;
+    /** The task definition: family, family:revision or ARN. */
+    taskDefinition: string;
+    /** Subnet ids for the tasks, e.g. ['subnet-0abc']. */
+    subnets: string[];
+    /** Security group ids for the tasks. */
+    securityGroups?: string[];
+    /** Give each task a public IP; needed in a public subnet without a NAT gateway. */
+    assignPublicIp?: boolean;
+    /** The container in the task definition that runs the browser; defaults to 'browser'. */
+    container?: string;
+    /** The AWS region, e.g. 'us-east-1'. */
+    region: string;
+    /** How Oya signs in to your account. */
+    auth: EcsAuth;
+}
 /** Empty disables solving. */
 type CaptchaSolver = 'capsolver' | '2captcha' | '';
 /**
@@ -303,6 +366,16 @@ interface ConfigUpdate {
     browseruse_api_key?: string | null;
     /** The DevTools WebSocket URL of your own Chrome, for the 'cdp' provider. */
     cdp_ws_url?: string | null;
+    /** Which runtime `'oya-cloud'` browsers run on; unset uses the deployment's. */
+    sandbox_runtime?: SandboxRuntime | null;
+    /** Your Daytona API key, so `'daytona'` runs on your own Daytona account. */
+    daytona_api_key?: string | null;
+    /** The Daytona snapshot of the Oya browser image, in your account. */
+    daytona_snapshot?: string | null;
+    /** The Daytona region, e.g. 'us' or 'eu'. */
+    daytona_target?: string | null;
+    /** Where this key's `'ecs'` browsers run and how Oya signs in to your AWS account. */
+    ecs?: EcsConfig | null;
     /** Which CAPTCHA solving service to call. */
     captcha_solver?: CaptchaSolver | null;
     /** The solving service's API key. */
@@ -311,7 +384,14 @@ interface ConfigUpdate {
     onboarded?: string | null;
 }
 /** What `config.get()` returns. Secrets read back masked, never in full. */
-interface Config extends Omit<ConfigUpdate, 'llm_provider' | 'browser_provider' | 'captcha_solver'> {
+interface Config extends Omit<ConfigUpdate, 'llm_provider' | 'browser_provider' | 'captcha_solver' | 'sandbox_runtime' | 'ecs'> {
+    /** The configured sandbox runtime, or empty for the deployment's. */
+    sandbox_runtime?: SandboxRuntime | '';
+    /** The ECS setting with its credentials masked, and the ExternalId to trust for `auth.type: 'role'`. */
+    ecs: Partial<EcsConfig> & {
+        /** Put this in your role's trust policy as sts:ExternalId. Shown even before ECS is set. */
+        externalId: string;
+    };
     /** The configured LLM vendor, or empty for the deployment default. */
     llm_provider?: LlmProvider | '';
     /** The configured browser provider, or empty for the deployment default. */
@@ -1433,4 +1513,4 @@ declare class Oya {
     private waitUntilConnected;
 }
 
-export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, type RecoverOptions, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };
+export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type EcsAuth, type EcsConfig, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, type RecoverOptions, Run, type RunData, type RunInfo, type RunResult, type SandboxRuntime, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };

package/dist/index.d.ts

@@ -273,6 +273,69 @@ type LlmProvider = 'openai' | 'anthropic'
 /** Gemini Enterprise, ex-Vertex AI. Express mode by default; set `openai_base_url` to a
  *  project-scoped `.../endpoints/openapi` endpoint to use an enterprise project. */
  | 'vertex';
+/**
+ * Which runtime this key's `'oya-cloud'` browsers run on. `'docker'` and `'k8s'`
+ * run on the deployment's own daemon or cluster, exactly as its operator set them up;
+ * `'daytona'` and `'ecs'` run on your own account once you set that runtime's
+ * credentials below, and on the deployment's otherwise.
+ */
+type SandboxRuntime = 'daytona' | 'docker' | 'k8s' | 'ecs';
+/**
+ * How Oya signs in to your AWS account to run `'ecs'` browsers.
+ *
+ * - `iam`: an access key (optionally temporary, with its session token).
+ * - `role`: Oya assumes `roleArn` from its own AWS identity. Put Oya's AWS
+ *   account and `config.get().ecs.externalId` in the role's trust policy; the
+ *   ExternalId is Oya's, one per API key, and cannot be set.
+ * - `sso`: an IAM Identity Center access token (from `aws sso login`'s cache or
+ *   the SSO OIDC device flow) for `accountId` and `roleName`. It expires; starts
+ *   then fail with `sso_token_expired` until you set a fresh one.
+ */
+type EcsAuth = {
+    /** An IAM access key. */
+    type: 'iam';
+    /** The access key id. */
+    accessKeyId: string;
+    /** Its secret. Read back masked. */
+    secretAccessKey: string;
+    /** For temporary credentials. Read back masked. */
+    sessionToken?: string;
+} | {
+    /** A role Oya assumes. */
+    type: 'role';
+    /** e.g. arn:aws:iam::123456789012:role/oya-browsers */
+    roleArn: string;
+} | {
+    /** IAM Identity Center. */
+    type: 'sso';
+    /** The SSO access token. Read back masked. */
+    accessToken: string;
+    /** The 12-digit account to sign in to. */
+    accountId: string;
+    /** The permission set's role name in that account. */
+    roleName: string;
+    /** The SSO portal's region, when it differs from `region`. */
+    ssoRegion?: string;
+};
+/** Where `'ecs'` browsers run: one Fargate task each, of a task definition that runs the Oya browser image. */
+interface EcsConfig {
+    /** The ECS cluster. */
+    cluster: string;
+    /** The task definition: family, family:revision or ARN. */
+    taskDefinition: string;
+    /** Subnet ids for the tasks, e.g. ['subnet-0abc']. */
+    subnets: string[];
+    /** Security group ids for the tasks. */
+    securityGroups?: string[];
+    /** Give each task a public IP; needed in a public subnet without a NAT gateway. */
+    assignPublicIp?: boolean;
+    /** The container in the task definition that runs the browser; defaults to 'browser'. */
+    container?: string;
+    /** The AWS region, e.g. 'us-east-1'. */
+    region: string;
+    /** How Oya signs in to your account. */
+    auth: EcsAuth;
+}
 /** Empty disables solving. */
 type CaptchaSolver = 'capsolver' | '2captcha' | '';
 /**
@@ -303,6 +366,16 @@ interface ConfigUpdate {
     browseruse_api_key?: string | null;
     /** The DevTools WebSocket URL of your own Chrome, for the 'cdp' provider. */
     cdp_ws_url?: string | null;
+    /** Which runtime `'oya-cloud'` browsers run on; unset uses the deployment's. */
+    sandbox_runtime?: SandboxRuntime | null;
+    /** Your Daytona API key, so `'daytona'` runs on your own Daytona account. */
+    daytona_api_key?: string | null;
+    /** The Daytona snapshot of the Oya browser image, in your account. */
+    daytona_snapshot?: string | null;
+    /** The Daytona region, e.g. 'us' or 'eu'. */
+    daytona_target?: string | null;
+    /** Where this key's `'ecs'` browsers run and how Oya signs in to your AWS account. */
+    ecs?: EcsConfig | null;
     /** Which CAPTCHA solving service to call. */
     captcha_solver?: CaptchaSolver | null;
     /** The solving service's API key. */
@@ -311,7 +384,14 @@ interface ConfigUpdate {
     onboarded?: string | null;
 }
 /** What `config.get()` returns. Secrets read back masked, never in full. */
-interface Config extends Omit<ConfigUpdate, 'llm_provider' | 'browser_provider' | 'captcha_solver'> {
+interface Config extends Omit<ConfigUpdate, 'llm_provider' | 'browser_provider' | 'captcha_solver' | 'sandbox_runtime' | 'ecs'> {
+    /** The configured sandbox runtime, or empty for the deployment's. */
+    sandbox_runtime?: SandboxRuntime | '';
+    /** The ECS setting with its credentials masked, and the ExternalId to trust for `auth.type: 'role'`. */
+    ecs: Partial<EcsConfig> & {
+        /** Put this in your role's trust policy as sts:ExternalId. Shown even before ECS is set. */
+        externalId: string;
+    };
     /** The configured LLM vendor, or empty for the deployment default. */
     llm_provider?: LlmProvider | '';
     /** The configured browser provider, or empty for the deployment default. */
@@ -1433,4 +1513,4 @@ declare class Oya {
     private waitUntilConnected;
 }
 
-export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, type RecoverOptions, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };
+export { type Activity, type Analysis, type AnalyzeOptions, type AttentionRequest, type Block, Browser, type BrowserDetail, type BrowserInfo, type CaptchaResult, type CaptchaSolver, type Config, type ConfigUpdate, type ControlCredential, type ControlEvent, type ControlOverview, type ControlRole, type ControlSession, type Cookie, type CookieFormat, type EcsAuth, type EcsConfig, type Element, type FileValue, type Fingerprint, type Health, type HumanInputAction, type LlmProvider, MAX_FILE_BYTES, type MfaConfig, type MfaResult, Oya, OyaError, type OyaOptions, type PageFormat, type PersonaInfo, type PersonaPrefs, type PlayResult, type Playbook, type PlaybookSummary, type ProjectSettings, type Provider, type ProxyCreate, type ProxyInfo, type RecoverOptions, Run, type RunData, type RunInfo, type RunResult, type SandboxRuntime, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oya-ai/browser",
-  "version": "1.0.119",
+  "version": "1.0.121",
   "description": "Rotate thousands of browsers behind one API, personas, proxies, stealth, CAPTCHA and MFA.",
   "license": "MIT",
   "homepage": "https://oyabrowser.com",