@browserless/capture 10.11.1 → 10.11.2

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 (3) hide show
  1. package/README.md +37 -10
  2. package/package.json +2 -2
  3. package/src/index.js +1 -1
package/README.md CHANGED
@@ -23,18 +23,34 @@ npm install @browserless/capture --save
23
23
  const createBrowser = require('browserless')
24
24
  const createCapture = require('@browserless/capture')
25
25
 
26
- const browser = createBrowser({
27
- headless: 'new',
28
- ignoreDefaultArgs: ['--disable-extensions'],
29
- args: [
30
- `--allowlisted-extension-id=${createCapture.extensionId}`,
31
- `--disable-extensions-except=${createCapture.extensionPath}`,
32
- `--load-extension=${createCapture.extensionPath}`
33
- ]
34
- })
26
+ const withCaptureExtension = (launchOpts = {}) => {
27
+ const ignoreDefaultArgs = launchOpts.ignoreDefaultArgs
28
+
29
+ return {
30
+ ...launchOpts,
31
+ args: [
32
+ ...(launchOpts.args || []),
33
+ `--allowlisted-extension-id=${createCapture.extensionId}`,
34
+ `--disable-extensions-except=${createCapture.extensionPath}`,
35
+ `--load-extension=${createCapture.extensionPath}`
36
+ ],
37
+ ignoreDefaultArgs:
38
+ ignoreDefaultArgs === true
39
+ ? true
40
+ : [
41
+ ...new Set([
42
+ ...(Array.isArray(ignoreDefaultArgs) ? ignoreDefaultArgs : []),
43
+ '--disable-extensions'
44
+ ])
45
+ ]
46
+ }
47
+ }
48
+
49
+ const browser = createBrowser(withCaptureExtension({ headless: 'new' }))
35
50
 
36
51
  const browserless = await browser.createContext()
37
- const page = await browserless.page()
52
+ const puppeteerBrowser = await browserless.browser()
53
+ const page = await puppeteerBrowser.defaultBrowserContext().newPage()
38
54
  const capture = createCapture({ goto: browserless.goto })
39
55
 
40
56
  const video = await capture(page)('https://example.com', {
@@ -42,8 +58,19 @@ const video = await capture(page)('https://example.com', {
42
58
  type: 'mp4',
43
59
  path: '/tmp/demo.mp4'
44
60
  })
61
+
62
+ await page.close()
63
+ await browserless.destroyContext()
64
+ await browser.close()
45
65
  ```
46
66
 
67
+ `browserless` core does not inject capture extension flags automatically.
68
+ `@browserless/capture` requires:
69
+
70
+ - Loading the bundled extension using `--allowlisted-extension-id`, `--disable-extensions-except`, and `--load-extension`.
71
+ - Ensuring Chromium default arg `--disable-extensions` is ignored.
72
+ - Creating the captured page from `defaultBrowserContext()` (not an incognito context).
73
+
47
74
  API shape is intentionally simple, similar to `page.screenshot()`/`page.pdf()`:
48
75
 
49
76
  ```js
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@browserless/capture",
3
3
  "description": "Record a Puppeteer page using tabCapture API",
4
4
  "homepage": "https://browserless.js.org/#/?id=capturepage-options",
5
- "version": "10.11.1",
5
+ "version": "10.11.2",
6
6
  "main": "src/index.js",
7
7
  "author": {
8
8
  "email": "hello@microlink.io",
@@ -55,5 +55,5 @@
55
55
  "timeout": "2m",
56
56
  "workerThreads": false
57
57
  },
58
- "gitHead": "2a4bbeeadfb7f010d57a8806f706de2bc48f936e"
58
+ "gitHead": "efe1f5047f7fbb4f4fef20ed0c11dcb978070fc9"
59
59
  }
package/src/index.js CHANGED
@@ -10,7 +10,7 @@ module.exports = ({ goto, ...gotoOpts } = {}) => {
10
10
  goto = goto || createGoto(gotoOpts)
11
11
  return function capture (page) {
12
12
  return async (url, opts = {}) => {
13
- const duration = debug.duration({ url }, opts)
13
+ const duration = debug.duration({ url })
14
14
  const { device } = await goto(page, { ...opts, url })
15
15
  const result = await runCapture(page, opts, device.viewport)
16
16
  duration.info()