@letsscrapedata/controller 0.0.70 → 0.0.71

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.cjs +165 -42
  2. package/dist/index.d.cts +20 -2
  3. package/dist/index.d.ts +20 -2
  4. package/dist/index.js +163 -40
  5. package/package.json +7 -12
package/dist/index.d.cts CHANGED
@@ -20,7 +20,7 @@ type CheerioNode = cheerio.Cheerio;
20
20
  type BrowserCreationMethod = "launch" | "connect";
21
21
  type BrowserContextCreationMethod = "launch" | "new";
22
22
  type BrowserContextStatus = "free" | "busy" | "closed";
23
- type LsdBrowserType = "chromium" | "firefox" | "webkit";
23
+ type LsdBrowserType = "chrome" | "chromium" | "firefox" | "webkit";
24
24
  /**
25
25
  * events emittd by controllers, such as playwright
26
26
  */
@@ -127,11 +127,13 @@ interface LsdApiContext {
127
127
  destroy(): Promise<boolean>;
128
128
  }
129
129
  interface PlaywrightBrowserTypes {
130
+ chrome: BrowserType;
130
131
  chromium: BrowserType;
131
132
  firefox: BrowserType;
132
133
  webkit: BrowserType;
133
134
  }
134
135
  interface PatchrightBrowserTypes {
136
+ chrome: BrowserType;
135
137
  chromium: BrowserType$1;
136
138
  firefox: BrowserType$1;
137
139
  webkit: BrowserType$1;
@@ -180,6 +182,9 @@ interface BrowserOptions {
180
182
  type BrowserLaunchMethod = "launch" | "launchServer";
181
183
  interface LsdLaunchOptions extends BrowserOptions {
182
184
  args?: string[];
185
+ /**
186
+ * executablePath is required to launch chrome
187
+ */
183
188
  executablePath?: string;
184
189
  /**
185
190
  * @default true
@@ -209,6 +214,12 @@ interface LsdLaunchOptions extends BrowserOptions {
209
214
  */
210
215
  userAgent?: string;
211
216
  userDataDir?: string;
217
+ /**
218
+ * only valid when browserType is "chrome" and userDataDir is "" (or undefined)
219
+ * * userDataDir: fs.mkdtempSync(path.join(userDataBaseDir, `lsd-${LsdBrowserControllerType}-chrome-`))
220
+ * @default os.tmpdir()
221
+ */
222
+ userDataBaseDir?: string;
212
223
  /**
213
224
  * @default "launch"
214
225
  */
@@ -1145,6 +1156,7 @@ interface LsdPage extends EventEmitter {
1145
1156
  * start to use this free page
1146
1157
  */
1147
1158
  use(): boolean;
1159
+ userAgent(): string;
1148
1160
  /**
1149
1161
  *
1150
1162
  * @param selector CSS selector, not XPath
@@ -1216,6 +1228,7 @@ interface LsdBrowserContext extends EventEmitter {
1216
1228
  * start to use this LsdBrowserContext
1217
1229
  */
1218
1230
  use(): boolean;
1231
+ userAgent(): string;
1219
1232
  _origBrowserContext(): AllBrowserContext;
1220
1233
  }
1221
1234
  interface LsdBrowser extends EventEmitter {
@@ -1328,7 +1341,7 @@ declare class PlaywrightBrowser extends EventEmitter implements LsdBrowser {
1328
1341
 
1329
1342
  declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowserContext {
1330
1343
  #private;
1331
- constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, maxViewportOfNewPage?: boolean);
1344
+ constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, userAgent?: string, maxViewportOfNewPage?: boolean);
1332
1345
  apiContext(): LsdApiContext;
1333
1346
  browser(): LsdBrowser;
1334
1347
  close(): Promise<boolean>;
@@ -1347,6 +1360,7 @@ declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowse
1347
1360
  setStateData(stateData: BrowserStateData): Promise<boolean>;
1348
1361
  status(): BrowserContextStatus;
1349
1362
  use(): boolean;
1363
+ userAgent(): string;
1350
1364
  _origBrowserContext(): AllBrowserContext;
1351
1365
  }
1352
1366
 
@@ -1409,6 +1423,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
1409
1423
  title(): Promise<string>;
1410
1424
  url(): string;
1411
1425
  use(): boolean;
1426
+ userAgent(): string;
1412
1427
  waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
1413
1428
  waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
1414
1429
  windowMember(keys: string[]): Promise<string>;
@@ -1495,6 +1510,7 @@ declare class PuppeteerBrowserContext extends EventEmitter implements LsdBrowser
1495
1510
  setStateData(stateData: BrowserStateData): Promise<boolean>;
1496
1511
  status(): BrowserContextStatus;
1497
1512
  use(): boolean;
1513
+ userAgent(): string;
1498
1514
  _origBrowserContext(): AllBrowserContext;
1499
1515
  }
1500
1516
 
@@ -1557,6 +1573,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
1557
1573
  title(): Promise<string>;
1558
1574
  url(): string;
1559
1575
  use(): boolean;
1576
+ userAgent(): string;
1560
1577
  waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
1561
1578
  waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
1562
1579
  windowMember(keys: string[]): Promise<string>;
@@ -1662,6 +1679,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
1662
1679
  title(): Promise<string>;
1663
1680
  url(): string;
1664
1681
  use(): boolean;
1682
+ userAgent(): string;
1665
1683
  waitForElement(): Promise<boolean>;
1666
1684
  waitForNavigation(): Promise<boolean>;
1667
1685
  windowMember(): Promise<string>;
package/dist/index.d.ts CHANGED
@@ -20,7 +20,7 @@ type CheerioNode = cheerio.Cheerio;
20
20
  type BrowserCreationMethod = "launch" | "connect";
21
21
  type BrowserContextCreationMethod = "launch" | "new";
22
22
  type BrowserContextStatus = "free" | "busy" | "closed";
23
- type LsdBrowserType = "chromium" | "firefox" | "webkit";
23
+ type LsdBrowserType = "chrome" | "chromium" | "firefox" | "webkit";
24
24
  /**
25
25
  * events emittd by controllers, such as playwright
26
26
  */
@@ -127,11 +127,13 @@ interface LsdApiContext {
127
127
  destroy(): Promise<boolean>;
128
128
  }
129
129
  interface PlaywrightBrowserTypes {
130
+ chrome: BrowserType;
130
131
  chromium: BrowserType;
131
132
  firefox: BrowserType;
132
133
  webkit: BrowserType;
133
134
  }
134
135
  interface PatchrightBrowserTypes {
136
+ chrome: BrowserType;
135
137
  chromium: BrowserType$1;
136
138
  firefox: BrowserType$1;
137
139
  webkit: BrowserType$1;
@@ -180,6 +182,9 @@ interface BrowserOptions {
180
182
  type BrowserLaunchMethod = "launch" | "launchServer";
181
183
  interface LsdLaunchOptions extends BrowserOptions {
182
184
  args?: string[];
185
+ /**
186
+ * executablePath is required to launch chrome
187
+ */
183
188
  executablePath?: string;
184
189
  /**
185
190
  * @default true
@@ -209,6 +214,12 @@ interface LsdLaunchOptions extends BrowserOptions {
209
214
  */
210
215
  userAgent?: string;
211
216
  userDataDir?: string;
217
+ /**
218
+ * only valid when browserType is "chrome" and userDataDir is "" (or undefined)
219
+ * * userDataDir: fs.mkdtempSync(path.join(userDataBaseDir, `lsd-${LsdBrowserControllerType}-chrome-`))
220
+ * @default os.tmpdir()
221
+ */
222
+ userDataBaseDir?: string;
212
223
  /**
213
224
  * @default "launch"
214
225
  */
@@ -1145,6 +1156,7 @@ interface LsdPage extends EventEmitter {
1145
1156
  * start to use this free page
1146
1157
  */
1147
1158
  use(): boolean;
1159
+ userAgent(): string;
1148
1160
  /**
1149
1161
  *
1150
1162
  * @param selector CSS selector, not XPath
@@ -1216,6 +1228,7 @@ interface LsdBrowserContext extends EventEmitter {
1216
1228
  * start to use this LsdBrowserContext
1217
1229
  */
1218
1230
  use(): boolean;
1231
+ userAgent(): string;
1219
1232
  _origBrowserContext(): AllBrowserContext;
1220
1233
  }
1221
1234
  interface LsdBrowser extends EventEmitter {
@@ -1328,7 +1341,7 @@ declare class PlaywrightBrowser extends EventEmitter implements LsdBrowser {
1328
1341
 
1329
1342
  declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowserContext {
1330
1343
  #private;
1331
- constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, maxViewportOfNewPage?: boolean);
1344
+ constructor(lsdBrowser: LsdBrowser, browserContext: BrowserContext, browserContextCreationMethod: BrowserContextCreationMethod, incognito?: boolean, proxy?: ProxyInController | null, browserIdx?: number, browserContextIdx?: number, maxPagesPerBrowserContext?: number, maxPageFreeSeconds?: number, userAgent?: string, maxViewportOfNewPage?: boolean);
1332
1345
  apiContext(): LsdApiContext;
1333
1346
  browser(): LsdBrowser;
1334
1347
  close(): Promise<boolean>;
@@ -1347,6 +1360,7 @@ declare class PlaywrightBrowserContext extends EventEmitter implements LsdBrowse
1347
1360
  setStateData(stateData: BrowserStateData): Promise<boolean>;
1348
1361
  status(): BrowserContextStatus;
1349
1362
  use(): boolean;
1363
+ userAgent(): string;
1350
1364
  _origBrowserContext(): AllBrowserContext;
1351
1365
  }
1352
1366
 
@@ -1409,6 +1423,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
1409
1423
  title(): Promise<string>;
1410
1424
  url(): string;
1411
1425
  use(): boolean;
1426
+ userAgent(): string;
1412
1427
  waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
1413
1428
  waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
1414
1429
  windowMember(keys: string[]): Promise<string>;
@@ -1495,6 +1510,7 @@ declare class PuppeteerBrowserContext extends EventEmitter implements LsdBrowser
1495
1510
  setStateData(stateData: BrowserStateData): Promise<boolean>;
1496
1511
  status(): BrowserContextStatus;
1497
1512
  use(): boolean;
1513
+ userAgent(): string;
1498
1514
  _origBrowserContext(): AllBrowserContext;
1499
1515
  }
1500
1516
 
@@ -1557,6 +1573,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
1557
1573
  title(): Promise<string>;
1558
1574
  url(): string;
1559
1575
  use(): boolean;
1576
+ userAgent(): string;
1560
1577
  waitForElement(selector: string, options?: WaitElementOptions): Promise<boolean>;
1561
1578
  waitForNavigation(options: WaitNavigationOptions): Promise<boolean>;
1562
1579
  windowMember(keys: string[]): Promise<string>;
@@ -1662,6 +1679,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
1662
1679
  title(): Promise<string>;
1663
1680
  url(): string;
1664
1681
  use(): boolean;
1682
+ userAgent(): string;
1665
1683
  waitForElement(): Promise<boolean>;
1666
1684
  waitForNavigation(): Promise<boolean>;
1667
1685
  windowMember(): Promise<string>;