@oya-ai/browser 1.0.106 → 1.0.110

package/README.md

@@ -468,6 +468,10 @@ const oya = new Oya({
 | `remove(id)`                                        | Delete persona and associated cookie jar                          |
 | `setMfa(id, config)`                                | Store TOTP secret (sealed at rest with AES-256-GCM)               |
 | `clearMfa(id)`                                      | Remove MFA secret from persona                                    |
+| `cookies(id, format?)` | Export the persona's logins; `'playwright'` fits `addCookies()` |
+| `importCookies(id, cookies)` | Merge cookies into the jar (from a file, a script, anywhere) |
+| `copyCookies(from, to)` | Copy one persona's logins into another |
+| `clearCookies(id)` | Forget every cookie: signs the persona out everywhere |
 
 ### Proxies (`oya.proxies`)
 

package/dist/index.cjs

@@ -694,11 +694,28 @@ var loginCalls = (http) => ({
     await http().request("DELETE", `/api/personas/${id}/credentials?domain=${encodeURIComponent(domain)}`);
   }
 });
+var jarPath = (id) => `/api/pool/cookies?persona=${encodeURIComponent(id)}`;
+var jarCalls = (http) => ({
+  /** Every cookie in the jar; `format: 'playwright'` is ready for `context.addCookies()`. */
+  cookies: async (id, format = "json") => (await http().request("GET", `${jarPath(id)}&format=${format}`)).cookies,
+  /** Merge cookies into the jar. The persona's browsers pick them up on their next visit to each site. */
+  importCookies: (id, list) => http().request("PUT", jarPath(id), { cookies: list })
+});
+var cookieCalls = (http) => ({
+  ...jarCalls(http),
+  /** Copy every login of persona `from` into persona `to`, which keeps its own device. */
+  copyCookies: async (from, to) => jarCalls(http).importCookies(to, await jarCalls(http).cookies(from)),
+  /** Forget every cookie in the jar: signs the persona out everywhere. */
+  clearCookies: async (id) => {
+    await http().request("DELETE", jarPath(id));
+  }
+});
 var personaApi = (http) => ({
   ...identityCalls(http),
   ...deviceCalls(http),
   ...mfaCalls(http),
-  ...loginCalls(http)
+  ...loginCalls(http),
+  ...cookieCalls(http)
 });
 
 // src/api/config.ts

package/dist/index.d.cts

@@ -689,6 +689,31 @@ interface SiteCredentials {
     /** The password; stored sealed and never returned. */
     password: string;
 }
+/** A cookie in a persona's jar. */
+interface Cookie {
+    /** The cookie's name. */
+    name: string;
+    /** Its value: a session, so treat it as a secret. */
+    value: string;
+    /** The domain it is sent to; a leading dot includes subdomains. */
+    domain: string;
+    /** The path it is sent to. `/` when omitted. */
+    path?: string;
+    /** Sent over HTTPS only. */
+    secure?: boolean;
+    /** Hidden from page scripts. */
+    httpOnly?: boolean;
+    /** `Strict`, `Lax` or `None` (Playwright), or `strict`, `lax`, `no_restriction` (Chrome extensions). */
+    sameSite?: string;
+    /** When it expires, in seconds since the epoch. A session cookie has none. */
+    expirationDate?: number;
+    /** The same, as Playwright and Puppeteer spell it; `-1` for a session cookie. */
+    expires?: number;
+    /** Whether it is sent to this exact host only. */
+    hostOnly?: boolean;
+}
+/** The formats a jar is exported in: as stored, or ready for Playwright's `context.addCookies()`. */
+type CookieFormat = 'json' | 'playwright';
 
 /**
  * Types for the durable control plane: sessions and their lifecycle, human
@@ -991,6 +1016,17 @@ interface SiteLogins {
     /** Usernames only. */
     credentials: SiteLogin[];
 }
+/** `PUT /api/pool/cookies`: what an import did. */
+interface CookiesImported {
+    /** The persona the cookies went to. */
+    persona: string;
+    /** Cookies merged into the jar. */
+    imported: number;
+    /** Cookies left out: no name, value or domain, or already expired. */
+    skipped: number;
+    /** Cookies in the jar afterwards. */
+    total: number;
+}
 
 /**
  * The shapes Browser's methods take and return that are not part of the
@@ -1316,6 +1352,10 @@ declare class Oya {
     };
     /** Identities: fingerprint, cookie jar and proxy bound together, plus their stored factors and logins. */
     readonly personas: {
+        copyCookies: (from: string, to: string) => Promise<CookiesImported>;
+        clearCookies: (id: string) => Promise<void>;
+        cookies: (id: string, format?: CookieFormat) => Promise<Cookie[]>;
+        importCookies: (id: string, list: Cookie[]) => Promise<CookiesImported>;
         setCredentials: (id: string, config: SiteCredentials) => Promise<CredentialsSaved>;
         credentials: (id: string) => Promise<SiteLogins>;
         clearCredentials: (id: string, domain: string) => Promise<void>;
@@ -1348,6 +1388,10 @@ declare class Oya {
     };
     /** Saved profiles. `personas` is retained as an alias for existing clients. */
     readonly profiles: {
+        copyCookies: (from: string, to: string) => Promise<CookiesImported>;
+        clearCookies: (id: string) => Promise<void>;
+        cookies: (id: string, format?: CookieFormat) => Promise<Cookie[]>;
+        importCookies: (id: string, list: Cookie[]) => Promise<CookiesImported>;
         setCredentials: (id: string, config: SiteCredentials) => Promise<CredentialsSaved>;
         credentials: (id: string) => Promise<SiteLogins>;
         clearCredentials: (id: string, domain: string) => Promise<void>;
@@ -1369,4 +1413,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 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, 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 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, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };

package/dist/index.d.ts

@@ -689,6 +689,31 @@ interface SiteCredentials {
     /** The password; stored sealed and never returned. */
     password: string;
 }
+/** A cookie in a persona's jar. */
+interface Cookie {
+    /** The cookie's name. */
+    name: string;
+    /** Its value: a session, so treat it as a secret. */
+    value: string;
+    /** The domain it is sent to; a leading dot includes subdomains. */
+    domain: string;
+    /** The path it is sent to. `/` when omitted. */
+    path?: string;
+    /** Sent over HTTPS only. */
+    secure?: boolean;
+    /** Hidden from page scripts. */
+    httpOnly?: boolean;
+    /** `Strict`, `Lax` or `None` (Playwright), or `strict`, `lax`, `no_restriction` (Chrome extensions). */
+    sameSite?: string;
+    /** When it expires, in seconds since the epoch. A session cookie has none. */
+    expirationDate?: number;
+    /** The same, as Playwright and Puppeteer spell it; `-1` for a session cookie. */
+    expires?: number;
+    /** Whether it is sent to this exact host only. */
+    hostOnly?: boolean;
+}
+/** The formats a jar is exported in: as stored, or ready for Playwright's `context.addCookies()`. */
+type CookieFormat = 'json' | 'playwright';
 
 /**
  * Types for the durable control plane: sessions and their lifecycle, human
@@ -991,6 +1016,17 @@ interface SiteLogins {
     /** Usernames only. */
     credentials: SiteLogin[];
 }
+/** `PUT /api/pool/cookies`: what an import did. */
+interface CookiesImported {
+    /** The persona the cookies went to. */
+    persona: string;
+    /** Cookies merged into the jar. */
+    imported: number;
+    /** Cookies left out: no name, value or domain, or already expired. */
+    skipped: number;
+    /** Cookies in the jar afterwards. */
+    total: number;
+}
 
 /**
  * The shapes Browser's methods take and return that are not part of the
@@ -1316,6 +1352,10 @@ declare class Oya {
     };
     /** Identities: fingerprint, cookie jar and proxy bound together, plus their stored factors and logins. */
     readonly personas: {
+        copyCookies: (from: string, to: string) => Promise<CookiesImported>;
+        clearCookies: (id: string) => Promise<void>;
+        cookies: (id: string, format?: CookieFormat) => Promise<Cookie[]>;
+        importCookies: (id: string, list: Cookie[]) => Promise<CookiesImported>;
         setCredentials: (id: string, config: SiteCredentials) => Promise<CredentialsSaved>;
         credentials: (id: string) => Promise<SiteLogins>;
         clearCredentials: (id: string, domain: string) => Promise<void>;
@@ -1348,6 +1388,10 @@ declare class Oya {
     };
     /** Saved profiles. `personas` is retained as an alias for existing clients. */
     readonly profiles: {
+        copyCookies: (from: string, to: string) => Promise<CookiesImported>;
+        clearCookies: (id: string) => Promise<void>;
+        cookies: (id: string, format?: CookieFormat) => Promise<Cookie[]>;
+        importCookies: (id: string, list: Cookie[]) => Promise<CookiesImported>;
         setCredentials: (id: string, config: SiteCredentials) => Promise<CredentialsSaved>;
         credentials: (id: string) => Promise<SiteLogins>;
         clearCredentials: (id: string, domain: string) => Promise<void>;
@@ -1369,4 +1413,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 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, 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 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, Run, type RunData, type RunInfo, type RunResult, type SiteCredentials, type StartOptions, type StartResult, type StopResult, type SubmitOptions, Oya as default, file };

package/dist/index.js

@@ -662,11 +662,28 @@ var loginCalls = (http) => ({
     await http().request("DELETE", `/api/personas/${id}/credentials?domain=${encodeURIComponent(domain)}`);
   }
 });
+var jarPath = (id) => `/api/pool/cookies?persona=${encodeURIComponent(id)}`;
+var jarCalls = (http) => ({
+  /** Every cookie in the jar; `format: 'playwright'` is ready for `context.addCookies()`. */
+  cookies: async (id, format = "json") => (await http().request("GET", `${jarPath(id)}&format=${format}`)).cookies,
+  /** Merge cookies into the jar. The persona's browsers pick them up on their next visit to each site. */
+  importCookies: (id, list) => http().request("PUT", jarPath(id), { cookies: list })
+});
+var cookieCalls = (http) => ({
+  ...jarCalls(http),
+  /** Copy every login of persona `from` into persona `to`, which keeps its own device. */
+  copyCookies: async (from, to) => jarCalls(http).importCookies(to, await jarCalls(http).cookies(from)),
+  /** Forget every cookie in the jar: signs the persona out everywhere. */
+  clearCookies: async (id) => {
+    await http().request("DELETE", jarPath(id));
+  }
+});
 var personaApi = (http) => ({
   ...identityCalls(http),
   ...deviceCalls(http),
   ...mfaCalls(http),
-  ...loginCalls(http)
+  ...loginCalls(http),
+  ...cookieCalls(http)
 });
 
 // src/api/config.ts

package/package.json

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