@letsscrapedata/controller 0.0.70 → 0.1.0

package/dist/index.d.cts

@@ -20,7 +20,7 @@ type CheerioNode = cheerio.Cheerio;
 type BrowserCreationMethod = "launch" | "connect";
 type BrowserContextCreationMethod = "launch" | "new";
 type BrowserContextStatus = "free" | "busy" | "closed";
-type LsdBrowserType = "chromium" | "firefox" | "webkit";
+type LsdBrowserType = "chrome" | "chromium" | "firefox" | "webkit";
 /**
  * events emittd by controllers, such as playwright
  */
@@ -127,11 +127,13 @@ interface LsdApiContext {
     destroy(): Promise<boolean>;
 }
 interface PlaywrightBrowserTypes {
+    chrome: BrowserType;
     chromium: BrowserType;
     firefox: BrowserType;
     webkit: BrowserType;
 }
 interface PatchrightBrowserTypes {
+    chrome: BrowserType;
     chromium: BrowserType$1;
     firefox: BrowserType$1;
     webkit: BrowserType$1;
@@ -180,6 +182,9 @@ interface BrowserOptions {
 type BrowserLaunchMethod = "launch" | "launchServer";
 interface LsdLaunchOptions extends BrowserOptions {
     args?: string[];
+    /**
+     * executablePath is required to launch chrome
+     */
     executablePath?: string;
     /**
      * @default true
@@ -208,6 +213,13 @@ interface LsdLaunchOptions extends BrowserOptions {
      * * puppeteer creates a default/new browserContext during launching browser
      */
     userAgent?: string;
+    /**
+     * only valid when !userAgent && headerless && !headlessUserAgent
+     */
+    headlessUserAgent?: string;
+    /**
+     * if userDataDir is not "" (or undefined) and browserControllerType is "playwright" / "patchwright", then launch
+     */
     userDataDir?: string;
     /**
      * @default "launch"
@@ -692,6 +704,10 @@ interface ResponseInterceptionItem {
      * request.postData()
      */
     requestData: string;
+    /**
+     * request.resourceType()
+     */
+    resourceType: string;
     /**
      * response.text()
      */
@@ -1145,6 +1161,7 @@ interface LsdPage extends EventEmitter {
      * start to use this free page
      */
     use(): boolean;
+    userAgent(): string;
     /**
      *
      * @param selector CSS selector, not XPath
@@ -1160,8 +1177,9 @@ interface LsdPage extends EventEmitter {
      * obj=window?.[key1]...?.[keyn]
      * @return obj ? JSON.stringify(obj) : ""
      * @param keys
+     * @param isolated default true; whether to run in isolated context; only valid for patchwright(TBD: and camoufox)
      */
-    windowMember(keys: string[]): Promise<string>;
+    windowMember(keys: string[], isolated?: boolean): Promise<string>;
     _origPage(): AllPage;
 }
 interface LsdBrowserContext extends EventEmitter {
@@ -1216,6 +1234,7 @@ interface LsdBrowserContext extends EventEmitter {
      * start to use this LsdBrowserContext
      */
     use(): boolean;
+    userAgent(): string;
     _origBrowserContext(): AllBrowserContext;
 }
 interface LsdBrowser extends EventEmitter {
@@ -1328,7 +1347,7 @@ declare class PlaywrightBrowser extends EventEmitter implements LsdBrowser {
 
 declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowserContext {
     #private;
-    constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, maxViewportOfNewPage?: boolean);
+    constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, userAgent?: string, maxViewportOfNewPage?: boolean);
     apiContext(): LsdApiContext;
     browser(): LsdBrowser;
     close(): Promise<boolean>;
@@ -1347,6 +1366,7 @@ declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowse
     setStateData(stateData: BrowserStateData): Promise<boolean>;
     status(): BrowserContextStatus;
     use(): boolean;
+    userAgent(): string;
     _origBrowserContext(): AllBrowserContext;
 }
 
@@ -1409,6 +1429,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
     title(): Promise<string>;
     url(): string;
     use(): boolean;
+    userAgent(): string;
     waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
     waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
     windowMember(keys: string[]): Promise<string>;
@@ -1495,6 +1516,7 @@ declare class PuppeteerBrowserContext extends EventEmitter implements LsdBrowser
     setStateData(stateData: BrowserStateData): Promise<boolean>;
     status(): BrowserContextStatus;
     use(): boolean;
+    userAgent(): string;
     _origBrowserContext(): AllBrowserContext;
 }
 
@@ -1557,6 +1579,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
     title(): Promise<string>;
     url(): string;
     use(): boolean;
+    userAgent(): string;
     waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
     waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
     windowMember(keys: string[]): Promise<string>;
@@ -1662,6 +1685,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
     title(): Promise<string>;
     url(): string;
     use(): boolean;
+    userAgent(): string;
     waitForElement(): Promise<boolean>;
     waitForNavigation(): Promise<boolean>;
     windowMember(): Promise<string>;

package/dist/index.d.ts

@@ -20,7 +20,7 @@ type CheerioNode = cheerio.Cheerio;
 type BrowserCreationMethod = "launch" | "connect";
 type BrowserContextCreationMethod = "launch" | "new";
 type BrowserContextStatus = "free" | "busy" | "closed";
-type LsdBrowserType = "chromium" | "firefox" | "webkit";
+type LsdBrowserType = "chrome" | "chromium" | "firefox" | "webkit";
 /**
  * events emittd by controllers, such as playwright
  */
@@ -127,11 +127,13 @@ interface LsdApiContext {
     destroy(): Promise<boolean>;
 }
 interface PlaywrightBrowserTypes {
+    chrome: BrowserType;
     chromium: BrowserType;
     firefox: BrowserType;
     webkit: BrowserType;
 }
 interface PatchrightBrowserTypes {
+    chrome: BrowserType;
     chromium: BrowserType$1;
     firefox: BrowserType$1;
     webkit: BrowserType$1;
@@ -180,6 +182,9 @@ interface BrowserOptions {
 type BrowserLaunchMethod = "launch" | "launchServer";
 interface LsdLaunchOptions extends BrowserOptions {
     args?: string[];
+    /**
+     * executablePath is required to launch chrome
+     */
     executablePath?: string;
     /**
      * @default true
@@ -208,6 +213,13 @@ interface LsdLaunchOptions extends BrowserOptions {
      * * puppeteer creates a default/new browserContext during launching browser
      */
     userAgent?: string;
+    /**
+     * only valid when !userAgent && headerless && !headlessUserAgent
+     */
+    headlessUserAgent?: string;
+    /**
+     * if userDataDir is not "" (or undefined) and browserControllerType is "playwright" / "patchwright", then launch
+     */
     userDataDir?: string;
     /**
      * @default "launch"
@@ -692,6 +704,10 @@ interface ResponseInterceptionItem {
      * request.postData()
      */
     requestData: string;
+    /**
+     * request.resourceType()
+     */
+    resourceType: string;
     /**
      * response.text()
      */
@@ -1145,6 +1161,7 @@ interface LsdPage extends EventEmitter {
      * start to use this free page
      */
     use(): boolean;
+    userAgent(): string;
     /**
      *
      * @param selector CSS selector, not XPath
@@ -1160,8 +1177,9 @@ interface LsdPage extends EventEmitter {
      * obj=window?.[key1]...?.[keyn]
      * @return obj ? JSON.stringify(obj) : ""
      * @param keys
+     * @param isolated default true; whether to run in isolated context; only valid for patchwright(TBD: and camoufox)
      */
-    windowMember(keys: string[]): Promise<string>;
+    windowMember(keys: string[], isolated?: boolean): Promise<string>;
     _origPage(): AllPage;
 }
 interface LsdBrowserContext extends EventEmitter {
@@ -1216,6 +1234,7 @@ interface LsdBrowserContext extends EventEmitter {
      * start to use this LsdBrowserContext
      */
     use(): boolean;
+    userAgent(): string;
     _origBrowserContext(): AllBrowserContext;
 }
 interface LsdBrowser extends EventEmitter {
@@ -1328,7 +1347,7 @@ declare class PlaywrightBrowser extends EventEmitter implements LsdBrowser {
 
 declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowserContext {
     #private;
-    constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, maxViewportOfNewPage?: boolean);
+    constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, userAgent?: string, maxViewportOfNewPage?: boolean);
     apiContext(): LsdApiContext;
     browser(): LsdBrowser;
     close(): Promise<boolean>;
@@ -1347,6 +1366,7 @@ declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowse
     setStateData(stateData: BrowserStateData): Promise<boolean>;
     status(): BrowserContextStatus;
     use(): boolean;
+    userAgent(): string;
     _origBrowserContext(): AllBrowserContext;
 }
 
@@ -1409,6 +1429,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
     title(): Promise<string>;
     url(): string;
     use(): boolean;
+    userAgent(): string;
     waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
     waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
     windowMember(keys: string[]): Promise<string>;
@@ -1495,6 +1516,7 @@ declare class PuppeteerBrowserContext extends EventEmitter implements LsdBrowser
     setStateData(stateData: BrowserStateData): Promise<boolean>;
     status(): BrowserContextStatus;
     use(): boolean;
+    userAgent(): string;
     _origBrowserContext(): AllBrowserContext;
 }
 
@@ -1557,6 +1579,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
     title(): Promise<string>;
     url(): string;
     use(): boolean;
+    userAgent(): string;
     waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
     waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
     windowMember(keys: string[]): Promise<string>;
@@ -1662,6 +1685,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
     title(): Promise<string>;
     url(): string;
     use(): boolean;
+    userAgent(): string;
     waitForElement(): Promise<boolean>;
     waitForNavigation(): Promise<boolean>;
     windowMember(): Promise<string>;