@browserless.io/browserless 2.3.0-beta-1 → 2.3.0
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.
- package/CHANGELOG.md +9 -1
- package/README.md +2 -2
- package/bin/browserless.js +47 -18
- package/bin/scaffold/README.md +50 -0
- package/bin/scaffold/src/hello-world.http.ts +2 -1
- package/build/browserless.d.ts +3 -5
- package/build/browserless.js +17 -11
- package/build/browsers/chrome.cdp.js +1 -1
- package/build/browsers/chrome.playwright.js +1 -1
- package/build/browsers/index.d.ts +1 -0
- package/build/browsers/index.js +4 -1
- package/build/data/classes.json +1 -1
- package/build/data/selectors.json +1 -1
- package/build/exports.d.ts +24 -38
- package/build/exports.js +25 -44
- package/build/limiter.d.ts +2 -1
- package/build/limiter.js +6 -3
- package/build/routes/chrome/http/content.post.body.json +8 -8
- package/build/routes/chrome/http/content.post.d.ts +2 -1
- package/build/routes/chrome/http/content.post.js +3 -2
- package/build/routes/chrome/http/download.post.body.json +11 -489
- package/build/routes/chrome/http/download.post.d.ts +2 -1
- package/build/routes/chrome/http/download.post.js +3 -2
- package/build/routes/chrome/http/download.post.query.json +6 -69
- package/build/routes/chrome/http/download.post.response.json +0 -1
- package/build/routes/chrome/http/function.post.body.json +11 -489
- package/build/routes/chrome/http/function.post.d.ts +2 -1
- package/build/routes/chrome/http/function.post.js +3 -2
- package/build/routes/chrome/http/function.post.query.json +6 -69
- package/build/routes/chrome/http/function.post.response.json +0 -1
- package/build/routes/chrome/http/json-list.get.d.ts +5 -1
- package/build/routes/chrome/http/json-list.get.js +5 -1
- package/build/routes/chrome/http/json-list.get.response.json +49 -1
- package/build/routes/chrome/http/json-new.put.d.ts +5 -1
- package/build/routes/chrome/http/json-new.put.js +5 -1
- package/build/routes/chrome/http/json-new.put.response.json +41 -1
- package/build/routes/chrome/http/json-protocol.get.d.ts +5 -1
- package/build/routes/chrome/http/json-protocol.get.js +5 -1
- package/build/routes/chrome/http/json-protocol.get.response.json +3 -1
- package/build/routes/chrome/http/json-version.get.d.ts +5 -1
- package/build/routes/chrome/http/json-version.get.js +5 -1
- package/build/routes/chrome/http/json-version.get.response.json +41 -1
- package/build/routes/chrome/http/pdf.post.body.json +153 -9
- package/build/routes/chrome/http/pdf.post.d.ts +2 -1
- package/build/routes/chrome/http/pdf.post.js +3 -2
- package/build/routes/chrome/http/pdf.post.query.json +6 -69
- package/build/routes/chrome/http/performance.post.body.json +10 -494
- package/build/routes/chrome/http/performance.post.d.ts +2 -1
- package/build/routes/chrome/http/performance.post.js +3 -2
- package/build/routes/chrome/http/performance.post.query.json +6 -69
- package/build/routes/chrome/http/performance.post.response.json +3 -1
- package/build/routes/chrome/http/scrape.post.body.json +56 -9
- package/build/routes/chrome/http/scrape.post.d.ts +2 -1
- package/build/routes/chrome/http/scrape.post.js +3 -2
- package/build/routes/chrome/http/scrape.post.response.json +305 -1
- package/build/routes/chrome/http/screenshot.post.body.json +99 -9
- package/build/routes/chrome/http/screenshot.post.d.ts +2 -1
- package/build/routes/chrome/http/screenshot.post.js +3 -2
- package/build/routes/chrome/http/screenshot.post.query.json +6 -69
- package/build/routes/chrome/ws/browser.d.ts +2 -1
- package/build/routes/chrome/ws/browser.js +3 -2
- package/build/routes/chrome/ws/browser.query.json +6 -69
- package/build/routes/chrome/ws/cdp.d.ts +2 -1
- package/build/routes/chrome/ws/cdp.js +3 -2
- package/build/routes/chrome/ws/cdp.query.json +6 -69
- package/build/routes/chrome/ws/page.d.ts +3 -2
- package/build/routes/chrome/ws/page.js +3 -2
- package/build/routes/chrome/ws/page.query.json +6 -69
- package/build/routes/chrome/ws/playwright.d.ts +1 -0
- package/build/routes/chrome/ws/playwright.js +2 -1
- package/build/routes/chrome/ws/playwright.query.json +7 -90
- package/build/routes/chromium/http/content.post.body.json +8 -8
- package/build/routes/chromium/http/download.post.body.json +11 -489
- package/build/routes/chromium/http/download.post.query.json +6 -69
- package/build/routes/chromium/http/download.post.response.json +0 -1
- package/build/routes/chromium/http/function.post.body.json +11 -489
- package/build/routes/chromium/http/function.post.query.json +6 -69
- package/build/routes/chromium/http/function.post.response.json +0 -1
- package/build/routes/chromium/http/json-list.get.response.json +49 -1
- package/build/routes/chromium/http/json-new.put.response.json +41 -1
- package/build/routes/chromium/http/json-protocol.get.response.json +3 -1
- package/build/routes/chromium/http/json-version.get.response.json +41 -1
- package/build/routes/chromium/http/pdf.post.body.json +153 -9
- package/build/routes/chromium/http/pdf.post.query.json +6 -69
- package/build/routes/chromium/http/performance.post.body.json +10 -494
- package/build/routes/chromium/http/performance.post.query.json +6 -69
- package/build/routes/chromium/http/performance.post.response.json +3 -1
- package/build/routes/chromium/http/scrape.post.body.json +56 -9
- package/build/routes/chromium/http/scrape.post.response.json +305 -1
- package/build/routes/chromium/http/screenshot.post.body.json +99 -9
- package/build/routes/chromium/http/screenshot.post.query.json +6 -69
- package/build/routes/chromium/ws/browser.query.json +6 -69
- package/build/routes/chromium/ws/cdp.query.json +6 -69
- package/build/routes/chromium/ws/page.query.json +6 -69
- package/build/routes/chromium/ws/playwright.query.json +7 -90
- package/build/routes/firefox/ws/playwright.d.ts +2 -1
- package/build/routes/firefox/ws/playwright.js +3 -2
- package/build/routes/firefox/ws/playwright.query.json +30 -115
- package/build/routes/management/http/config.get.d.ts +1 -0
- package/build/routes/management/http/config.get.js +2 -1
- package/build/routes/management/http/config.get.response.json +104 -1
- package/build/routes/management/http/metrics-total.get.d.ts +1 -0
- package/build/routes/management/http/metrics-total.get.js +2 -1
- package/build/routes/management/http/metrics-total.get.response.json +69 -1
- package/build/routes/management/http/metrics.get.d.ts +1 -0
- package/build/routes/management/http/metrics.get.js +2 -1
- package/build/routes/management/http/metrics.get.response.json +91 -1
- package/build/routes/management/http/sessions.get.d.ts +1 -0
- package/build/routes/management/http/sessions.get.js +2 -1
- package/build/routes/management/http/sessions.get.response.json +232 -1
- package/build/routes/management/http/static.get.d.ts +1 -0
- package/build/routes/management/http/static.get.js +2 -1
- package/build/routes/webkit/ws/playwright.d.ts +2 -1
- package/build/routes/webkit/ws/playwright.js +3 -2
- package/build/routes/webkit/ws/playwright.query.json +7 -90
- package/build/shared/browser.ws.d.ts +2 -1
- package/build/shared/browser.ws.js +3 -2
- package/build/shared/chromium.playwright.ws.d.ts +2 -1
- package/build/shared/chromium.playwright.ws.js +3 -2
- package/build/shared/chromium.ws.d.ts +2 -1
- package/build/shared/chromium.ws.js +3 -2
- package/build/shared/content.http.d.ts +2 -1
- package/build/shared/content.http.js +3 -2
- package/build/shared/download.http.d.ts +2 -1
- package/build/shared/download.http.js +3 -2
- package/build/shared/function.http.d.ts +2 -1
- package/build/shared/function.http.js +3 -2
- package/build/shared/json-list.http.d.ts +2 -1
- package/build/shared/json-list.http.js +3 -2
- package/build/shared/json-new.http.d.ts +2 -1
- package/build/shared/json-new.http.js +3 -2
- package/build/shared/json-protocol.http.d.ts +2 -1
- package/build/shared/json-protocol.http.js +3 -2
- package/build/shared/json-version.http.d.ts +2 -1
- package/build/shared/json-version.http.js +3 -2
- package/build/shared/page.ws.d.ts +2 -1
- package/build/shared/page.ws.js +3 -2
- package/build/shared/pdf.http.d.ts +2 -1
- package/build/shared/pdf.http.js +3 -2
- package/build/shared/performance.http.d.ts +1 -0
- package/build/shared/performance.http.js +2 -1
- package/build/shared/scrape.http.d.ts +2 -1
- package/build/shared/scrape.http.js +3 -2
- package/build/shared/screenshot.http.d.ts +1 -0
- package/build/shared/screenshot.http.js +2 -1
- package/build/types.d.ts +91 -0
- package/build/types.js +54 -0
- package/build/utils.d.ts +1 -1
- package/build/utils.js +11 -6
- package/docker/chrome/Dockerfile +0 -2
- package/docker/chromium/Dockerfile +1 -4
- package/docker/firefox/Dockerfile +1 -4
- package/docker/multi/Dockerfile +2 -6
- package/docker/webkit/Dockerfile +1 -4
- package/package.json +11 -10
- package/scripts/build-open-api.js +150 -141
- package/scripts/build-schemas.js +3 -2
- package/src/browserless.ts +43 -30
- package/src/browsers/chrome.cdp.ts +1 -1
- package/src/browsers/chrome.playwright.ts +1 -1
- package/src/browsers/index.ts +5 -1
- package/src/exports.ts +25 -49
- package/src/limiter.ts +7 -3
- package/src/routes/chrome/http/content.post.ts +7 -2
- package/src/routes/chrome/http/download.post.ts +7 -2
- package/src/routes/chrome/http/function.post.ts +7 -2
- package/src/routes/chrome/http/json-list.get.ts +7 -1
- package/src/routes/chrome/http/json-new.put.ts +7 -1
- package/src/routes/chrome/http/json-protocol.get.ts +7 -1
- package/src/routes/chrome/http/json-version.get.ts +7 -1
- package/src/routes/chrome/http/pdf.post.ts +7 -2
- package/src/routes/chrome/http/performance.post.ts +7 -2
- package/src/routes/chrome/http/scrape.post.ts +7 -2
- package/src/routes/chrome/http/screenshot.post.ts +7 -2
- package/src/routes/chrome/ws/browser.ts +3 -2
- package/src/routes/chrome/ws/cdp.ts +7 -2
- package/src/routes/chrome/ws/page.ts +3 -2
- package/src/routes/chrome/ws/playwright.ts +6 -1
- package/src/routes/firefox/ws/playwright.ts +3 -1
- package/src/routes/management/http/config.get.ts +2 -0
- package/src/routes/management/http/metrics-total.get.ts +2 -0
- package/src/routes/management/http/metrics.get.ts +2 -0
- package/src/routes/management/http/sessions.get.ts +2 -0
- package/src/routes/management/http/static.get.ts +2 -0
- package/src/routes/webkit/ws/playwright.ts +3 -1
- package/src/shared/browser.ws.ts +3 -1
- package/src/shared/chromium.playwright.ws.ts +3 -1
- package/src/shared/chromium.ws.ts +3 -1
- package/src/shared/content.http.ts +3 -1
- package/src/shared/download.http.ts +3 -1
- package/src/shared/function.http.ts +3 -1
- package/src/shared/json-list.http.ts +3 -1
- package/src/shared/json-new.http.ts +3 -1
- package/src/shared/json-protocol.http.ts +3 -1
- package/src/shared/json-version.http.ts +3 -1
- package/src/shared/page.ws.ts +3 -1
- package/src/shared/pdf.http.ts +3 -1
- package/src/shared/performance.http.ts +2 -0
- package/src/shared/scrape.http.ts +3 -1
- package/src/shared/screenshot.http.ts +2 -0
- package/src/types.ts +66 -0
- package/src/utils.ts +13 -7
- package/static/docs/swagger.json +2511 -1520
- package/static/docs/swagger.min.json +6697 -0
- package/static/function/client.js +323 -323
- package/build/exports.core.d.ts +0 -24
- package/build/exports.core.js +0 -26
- package/src/exports.core.ts +0 -26
package/src/types.ts
CHANGED
|
@@ -104,6 +104,12 @@ abstract class Route {
|
|
|
104
104
|
protected _monitoring: Browserless['monitoring'],
|
|
105
105
|
) {}
|
|
106
106
|
|
|
107
|
+
/**
|
|
108
|
+
* A unique name to identify this route. Used in downstream
|
|
109
|
+
* SDKs to potentially remove or disable.
|
|
110
|
+
*/
|
|
111
|
+
abstract name: string;
|
|
112
|
+
|
|
107
113
|
/**
|
|
108
114
|
* A boolean, or a function that returns a boolean, on
|
|
109
115
|
* whether the route requires an API token to access.
|
|
@@ -602,3 +608,63 @@ export interface CDPJSONPayload {
|
|
|
602
608
|
*/
|
|
603
609
|
webSocketDebuggerUrl: string;
|
|
604
610
|
}
|
|
611
|
+
|
|
612
|
+
export const BrowserlessChromeRoutes = {
|
|
613
|
+
ChromeBrowserWebSocketRoute: 'ChromeBrowserWebSocketRoute',
|
|
614
|
+
ChromeCDPWebSocketRoute: 'ChromeCDPWebSocketRoute',
|
|
615
|
+
ChromeContentPostRoute: 'ChromeContentPostRoute',
|
|
616
|
+
ChromeDownloadPostRoute: 'ChromeDownloadPostRoute',
|
|
617
|
+
ChromeFunctionPostRoute: 'ChromeFunctionPostRoute',
|
|
618
|
+
ChromeJSONListGetRoute: 'ChromeJSONListGetRoute',
|
|
619
|
+
ChromeJSONNewPutRoute: 'ChromeJSONNewPutRoute',
|
|
620
|
+
ChromeJSONProtocolGetRoute: 'ChromeJSONProtocolGetRoute',
|
|
621
|
+
ChromeJSONVersionGetRoute: 'ChromeJSONVersionGetRoute',
|
|
622
|
+
ChromePDFPostRoute: 'ChromePDFPostRoute',
|
|
623
|
+
ChromePageWebSocketRoute: 'ChromePageWebSocketRoute',
|
|
624
|
+
ChromePerformancePostRoute: 'ChromePerformancePostRoute',
|
|
625
|
+
ChromePlaywrightWebSocketRoute: 'ChromePlaywrightWebSocketRoute',
|
|
626
|
+
ChromeScrapePostRoute: 'ChromeScrapePostRoute',
|
|
627
|
+
ChromeScreenshotPostRoute: 'ChromeScreenshotPostRoute',
|
|
628
|
+
};
|
|
629
|
+
|
|
630
|
+
export const BrowserlessChromiumRoutes = {
|
|
631
|
+
ChromiumBrowserWebSocketRoute: 'ChromiumBrowserWebSocketRoute',
|
|
632
|
+
ChromiumCDPWebSocketRoute: 'ChromiumCDPWebSocketRoute',
|
|
633
|
+
ChromiumContentPostRoute: 'ChromiumContentPostRoute',
|
|
634
|
+
ChromiumDownloadPostRoute: 'ChromiumDownloadPostRoute',
|
|
635
|
+
ChromiumFunctionPostRoute: 'ChromiumFunctionPostRoute',
|
|
636
|
+
ChromiumJSONListGetRoute: 'ChromiumJSONListGetRoute',
|
|
637
|
+
ChromiumJSONNewPutRoute: 'ChromiumJSONNewPutRoute',
|
|
638
|
+
ChromiumJSONProtocolGetRoute: 'ChromiumJSONProtocolGetRoute',
|
|
639
|
+
ChromiumJSONVersionGetRoute: 'ChromiumJSONVersionGetRoute',
|
|
640
|
+
ChromiumPDFPostRoute: 'ChromiumPDFPostRoute',
|
|
641
|
+
ChromiumPageWebSocketRoute: 'ChromiumPageWebSocketRoute',
|
|
642
|
+
ChromiumPerformancePostRoute: 'ChromiumPerformancePostRoute',
|
|
643
|
+
ChromiumPlaywrightWebSocketRoute: 'ChromiumPlaywrightWebSocketRoute',
|
|
644
|
+
ChromiumScrapePostRoute: 'ChromiumScrapePostRoute',
|
|
645
|
+
ChromiumScreenshotPostRoute: 'ChromiumScreenshotPostRoute',
|
|
646
|
+
};
|
|
647
|
+
|
|
648
|
+
export const BrowserlessFirefoxRoutes = {
|
|
649
|
+
FirefoxPlaywrightWebSocketRoute: 'FirefoxPlaywrightWebSocketRoute',
|
|
650
|
+
};
|
|
651
|
+
|
|
652
|
+
export const BrowserlessWebKitRoutes = {
|
|
653
|
+
WebKitPlaywrightWebSocketRoute: 'WebKitPlaywrightWebSocketRoute',
|
|
654
|
+
};
|
|
655
|
+
|
|
656
|
+
export const BrowserlessManagementRoutes = {
|
|
657
|
+
ConfigGetRoute: 'ConfigGetRoute',
|
|
658
|
+
MetricsGetRoute: 'MetricsGetRoute',
|
|
659
|
+
MetricsTotalGetRoute: 'MetricsTotalGetRoute',
|
|
660
|
+
SessionsGetRoute: 'SessionsGetRoute',
|
|
661
|
+
StaticGetRoute: 'StaticGetRoute',
|
|
662
|
+
};
|
|
663
|
+
|
|
664
|
+
export const BrowserlessRoutes = {
|
|
665
|
+
...BrowserlessChromeRoutes,
|
|
666
|
+
...BrowserlessChromiumRoutes,
|
|
667
|
+
...BrowserlessFirefoxRoutes,
|
|
668
|
+
...BrowserlessWebKitRoutes,
|
|
669
|
+
...BrowserlessManagementRoutes,
|
|
670
|
+
};
|
package/src/utils.ts
CHANGED
|
@@ -303,12 +303,18 @@ export const readBody = async (
|
|
|
303
303
|
* Lists the path of Chromes (stable) install since
|
|
304
304
|
* no library or utility out there does it including playwright.
|
|
305
305
|
*/
|
|
306
|
-
export const chromeExecutablePath =
|
|
307
|
-
process.platform === 'win32'
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
306
|
+
export const chromeExecutablePath = () => {
|
|
307
|
+
if (process.platform === 'win32') {
|
|
308
|
+
// Windows always includes the ProgramFiles variable in the environment
|
|
309
|
+
return `${process.env['ProgramFiles']}\\Google\\Chrome\\Application\\chrome.exe`;
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
if (process.platform === 'darwin') {
|
|
313
|
+
return '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome';
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
return '/usr/bin/google-chrome-stable';
|
|
317
|
+
};
|
|
312
318
|
|
|
313
319
|
export const getRouteFiles = async (config: Config): Promise<string[][]> => {
|
|
314
320
|
const routes = config.getRoutes();
|
|
@@ -432,7 +438,7 @@ export const availableBrowsers = Promise.all([
|
|
|
432
438
|
exists(playwright.chromium.executablePath()),
|
|
433
439
|
exists(playwright.firefox.executablePath()),
|
|
434
440
|
exists(playwright.webkit.executablePath()),
|
|
435
|
-
exists(chromeExecutablePath),
|
|
441
|
+
exists(chromeExecutablePath()),
|
|
436
442
|
]).then(([chromiumExists, firefoxExists, webkitExists, chromeExists]) => {
|
|
437
443
|
const availableBrowsers = [];
|
|
438
444
|
|