@browserless.io/browserless 2.2.0 → 2.3.0-beta-1
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/bin/browserless.js +25 -14
- package/build/browserless.d.ts +6 -1
- package/build/browserless.js +38 -20
- package/build/exports.core.d.ts +24 -0
- package/build/exports.core.js +26 -0
- package/build/exports.d.ts +38 -24
- package/build/exports.js +44 -26
- package/build/routes/chrome/http/content.post.body.json +8 -8
- package/build/routes/chrome/http/download.post.body.json +489 -11
- package/build/routes/chrome/http/download.post.query.json +69 -6
- package/build/routes/chrome/http/download.post.response.json +1 -0
- package/build/routes/chrome/http/function.post.body.json +489 -11
- package/build/routes/chrome/http/function.post.query.json +69 -6
- package/build/routes/chrome/http/function.post.response.json +1 -0
- package/build/routes/chrome/http/json-list.get.response.json +1 -49
- package/build/routes/chrome/http/json-new.put.response.json +1 -41
- package/build/routes/chrome/http/json-protocol.get.response.json +1 -3
- package/build/routes/chrome/http/json-version.get.response.json +1 -41
- package/build/routes/chrome/http/pdf.post.body.json +9 -153
- package/build/routes/chrome/http/pdf.post.query.json +69 -6
- package/build/routes/chrome/http/performance.post.body.json +494 -10
- package/build/routes/chrome/http/performance.post.query.json +69 -6
- package/build/routes/chrome/http/performance.post.response.json +1 -3
- package/build/routes/chrome/http/scrape.post.body.json +9 -56
- package/build/routes/chrome/http/scrape.post.response.json +1 -305
- package/build/routes/chrome/http/screenshot.post.body.json +9 -99
- package/build/routes/chrome/http/screenshot.post.query.json +69 -6
- package/build/routes/chrome/ws/browser.query.json +69 -6
- package/build/routes/chrome/ws/cdp.query.json +69 -6
- package/build/routes/chrome/ws/page.query.json +69 -6
- package/build/routes/chrome/ws/playwright.query.json +90 -7
- package/build/routes/chromium/http/content.post.body.json +8 -8
- package/build/routes/chromium/http/download.post.body.json +489 -11
- package/build/routes/chromium/http/download.post.query.json +69 -6
- package/build/routes/chromium/http/download.post.response.json +1 -0
- package/build/routes/chromium/http/function.post.body.json +489 -11
- package/build/routes/chromium/http/function.post.query.json +69 -6
- package/build/routes/chromium/http/function.post.response.json +1 -0
- package/build/routes/chromium/http/json-list.get.response.json +1 -49
- package/build/routes/chromium/http/json-new.put.response.json +1 -41
- package/build/routes/chromium/http/json-protocol.get.response.json +1 -3
- package/build/routes/chromium/http/json-version.get.response.json +1 -41
- package/build/routes/chromium/http/pdf.post.body.json +9 -153
- package/build/routes/chromium/http/pdf.post.query.json +69 -6
- package/build/routes/chromium/http/performance.post.body.json +494 -10
- package/build/routes/chromium/http/performance.post.query.json +69 -6
- package/build/routes/chromium/http/performance.post.response.json +1 -3
- package/build/routes/chromium/http/scrape.post.body.json +9 -56
- package/build/routes/chromium/http/scrape.post.response.json +1 -305
- package/build/routes/chromium/http/screenshot.post.body.json +9 -99
- package/build/routes/chromium/http/screenshot.post.query.json +69 -6
- package/build/routes/chromium/ws/browser.query.json +69 -6
- package/build/routes/chromium/ws/cdp.query.json +69 -6
- package/build/routes/chromium/ws/page.query.json +69 -6
- package/build/routes/chromium/ws/playwright.query.json +90 -7
- package/build/routes/firefox/ws/playwright.d.ts +5 -1
- package/build/routes/firefox/ws/playwright.query.json +90 -7
- package/build/routes/management/http/config.get.response.json +1 -104
- package/build/routes/management/http/metrics-total.get.response.json +1 -69
- package/build/routes/management/http/metrics.get.response.json +1 -91
- package/build/routes/management/http/sessions.get.response.json +1 -232
- package/build/routes/management/http/static.get.js +7 -7
- package/build/routes/webkit/ws/playwright.query.json +90 -7
- package/build/shared/utils/performance/main.js +1 -1
- package/docker/chrome/Dockerfile +2 -0
- package/docker/chromium/Dockerfile +2 -0
- package/docker/firefox/Dockerfile +2 -0
- package/docker/multi/Dockerfile +2 -0
- package/docker/webkit/Dockerfile +2 -0
- package/package.json +1 -2
- package/scripts/build-open-api.js +18 -9
- package/scripts/build-schemas.js +2 -3
- package/src/browserless.ts +61 -36
- package/src/exports.core.ts +26 -0
- package/src/exports.ts +48 -26
- package/src/router.ts +6 -2
- package/src/routes/firefox/ws/playwright.ts +3 -1
- package/src/routes/management/http/static.get.ts +14 -9
- package/src/shared/utils/performance/main.ts +1 -2
- package/static/docs/swagger.json +1338 -2287
package/static/docs/swagger.json
CHANGED
|
@@ -225,14 +225,14 @@
|
|
|
225
225
|
"length": {
|
|
226
226
|
"type": "number"
|
|
227
227
|
},
|
|
228
|
-
"__@toStringTag@
|
|
228
|
+
"__@toStringTag@11053": {
|
|
229
229
|
"type": "string",
|
|
230
230
|
"const": "Uint8Array"
|
|
231
231
|
}
|
|
232
232
|
},
|
|
233
233
|
"required": [
|
|
234
234
|
"BYTES_PER_ELEMENT",
|
|
235
|
-
"__@toStringTag@
|
|
235
|
+
"__@toStringTag@11053",
|
|
236
236
|
"buffer",
|
|
237
237
|
"byteLength",
|
|
238
238
|
"byteOffset",
|
|
@@ -267,13 +267,13 @@
|
|
|
267
267
|
"byteLength": {
|
|
268
268
|
"type": "number"
|
|
269
269
|
},
|
|
270
|
-
"__@toStringTag@
|
|
270
|
+
"__@toStringTag@11053": {
|
|
271
271
|
"type": "string"
|
|
272
272
|
}
|
|
273
273
|
},
|
|
274
274
|
"additionalProperties": false,
|
|
275
275
|
"required": [
|
|
276
|
-
"__@toStringTag@
|
|
276
|
+
"__@toStringTag@11053",
|
|
277
277
|
"byteLength"
|
|
278
278
|
]
|
|
279
279
|
},
|
|
@@ -283,18 +283,18 @@
|
|
|
283
283
|
"byteLength": {
|
|
284
284
|
"type": "number"
|
|
285
285
|
},
|
|
286
|
-
"__@species@
|
|
286
|
+
"__@species@15209": {
|
|
287
287
|
"$ref": "#/definitions/SharedArrayBuffer"
|
|
288
288
|
},
|
|
289
|
-
"__@toStringTag@
|
|
289
|
+
"__@toStringTag@11053": {
|
|
290
290
|
"type": "string",
|
|
291
291
|
"const": "SharedArrayBuffer"
|
|
292
292
|
}
|
|
293
293
|
},
|
|
294
294
|
"additionalProperties": false,
|
|
295
295
|
"required": [
|
|
296
|
-
"__@species@
|
|
297
|
-
"__@toStringTag@
|
|
296
|
+
"__@species@15209",
|
|
297
|
+
"__@toStringTag@11053",
|
|
298
298
|
"byteLength"
|
|
299
299
|
]
|
|
300
300
|
},
|
|
@@ -483,634 +483,302 @@
|
|
|
483
483
|
}
|
|
484
484
|
},
|
|
485
485
|
"additionalProperties": false
|
|
486
|
-
}
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
"properties": {
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
"PDFOptions": {
|
|
550
|
-
"description": "Valid options to configure PDF generation via {@link Page.pdf}.",
|
|
551
|
-
"type": "object",
|
|
552
|
-
"properties": {
|
|
553
|
-
"scale": {
|
|
554
|
-
"description": "Scales the rendering of the web page. Amount must be between `0.1` and `2`.",
|
|
555
|
-
"type": "number"
|
|
556
|
-
},
|
|
557
|
-
"displayHeaderFooter": {
|
|
558
|
-
"description": "Whether to show the header and footer.",
|
|
559
|
-
"type": "boolean"
|
|
560
|
-
},
|
|
561
|
-
"headerTemplate": {
|
|
562
|
-
"description": "HTML template for the print header. Should be valid HTML with the following\nclasses used to inject values into them:\n\n- `date` formatted print date\n\n- `title` document title\n\n- `url` document location\n\n- `pageNumber` current page number\n\n- `totalPages` total pages in the document",
|
|
563
|
-
"type": "string"
|
|
564
|
-
},
|
|
565
|
-
"footerTemplate": {
|
|
566
|
-
"description": "HTML template for the print footer. Has the same constraints and support\nfor special classes as {@link PDFOptionsPDFOptions.headerTemplate}.",
|
|
567
|
-
"type": "string"
|
|
568
|
-
},
|
|
569
|
-
"printBackground": {
|
|
570
|
-
"description": "Set to `true` to print background graphics.",
|
|
571
|
-
"type": "boolean"
|
|
572
|
-
},
|
|
573
|
-
"landscape": {
|
|
574
|
-
"description": "Whether to print in landscape orientation.",
|
|
575
|
-
"type": "boolean"
|
|
576
|
-
},
|
|
577
|
-
"pageRanges": {
|
|
578
|
-
"description": "Paper ranges to print, e.g. `1-5, 8, 11-13`.",
|
|
579
|
-
"type": "string"
|
|
580
|
-
},
|
|
581
|
-
"format": {
|
|
582
|
-
"description": "All the valid paper format types when printing a PDF.",
|
|
583
|
-
"enum": [
|
|
584
|
-
"A0",
|
|
585
|
-
"A1",
|
|
586
|
-
"A2",
|
|
587
|
-
"A3",
|
|
588
|
-
"A4",
|
|
589
|
-
"A5",
|
|
590
|
-
"A6",
|
|
591
|
-
"LEDGER",
|
|
592
|
-
"LEGAL",
|
|
593
|
-
"LETTER",
|
|
594
|
-
"Ledger",
|
|
595
|
-
"Legal",
|
|
596
|
-
"Letter",
|
|
597
|
-
"TABLOID",
|
|
598
|
-
"Tabloid",
|
|
599
|
-
"a0",
|
|
600
|
-
"a1",
|
|
601
|
-
"a2",
|
|
602
|
-
"a3",
|
|
603
|
-
"a4",
|
|
604
|
-
"a5",
|
|
605
|
-
"a6",
|
|
606
|
-
"ledger",
|
|
607
|
-
"legal",
|
|
608
|
-
"letter",
|
|
609
|
-
"tabloid"
|
|
610
|
-
],
|
|
611
|
-
"type": "string"
|
|
612
|
-
},
|
|
613
|
-
"width": {
|
|
614
|
-
"description": "Sets the width of paper. You can pass in a number or a string with a unit.",
|
|
615
|
-
"type": [
|
|
616
|
-
"string",
|
|
617
|
-
"number"
|
|
618
|
-
]
|
|
619
|
-
},
|
|
620
|
-
"height": {
|
|
621
|
-
"description": "Sets the height of paper. You can pass in a number or a string with a unit.",
|
|
622
|
-
"type": [
|
|
623
|
-
"string",
|
|
624
|
-
"number"
|
|
625
|
-
]
|
|
626
|
-
},
|
|
627
|
-
"preferCSSPageSize": {
|
|
628
|
-
"description": "Give any CSS `@page` size declared in the page priority over what is\ndeclared in the `width` or `height` or `format` option.",
|
|
629
|
-
"type": "boolean"
|
|
630
|
-
},
|
|
631
|
-
"margin": {
|
|
632
|
-
"description": "Set the PDF margins.",
|
|
633
|
-
"$ref": "#/definitions/PDFMargin"
|
|
634
|
-
},
|
|
635
|
-
"path": {
|
|
636
|
-
"description": "The path to save the file to.",
|
|
637
|
-
"type": "string"
|
|
638
|
-
},
|
|
639
|
-
"omitBackground": {
|
|
640
|
-
"description": "Hides default white background and allows generating pdfs with transparency.",
|
|
641
|
-
"type": "boolean"
|
|
642
|
-
},
|
|
643
|
-
"tagged": {
|
|
644
|
-
"description": "Generate tagged (accessible) PDF.",
|
|
645
|
-
"type": "boolean"
|
|
646
|
-
},
|
|
647
|
-
"outline": {
|
|
648
|
-
"description": "Generate document outline.",
|
|
649
|
-
"type": "boolean"
|
|
650
|
-
},
|
|
651
|
-
"timeout": {
|
|
652
|
-
"description": "Timeout in milliseconds. Pass `0` to disable timeout.",
|
|
653
|
-
"type": "number"
|
|
654
|
-
}
|
|
655
|
-
},
|
|
656
|
-
"additionalProperties": false
|
|
657
|
-
},
|
|
658
|
-
"PDFMargin": {
|
|
659
|
-
"type": "object",
|
|
660
|
-
"properties": {
|
|
661
|
-
"top": {
|
|
662
|
-
"type": [
|
|
663
|
-
"string",
|
|
664
|
-
"number"
|
|
665
|
-
]
|
|
666
|
-
},
|
|
667
|
-
"bottom": {
|
|
668
|
-
"type": [
|
|
669
|
-
"string",
|
|
670
|
-
"number"
|
|
671
|
-
]
|
|
672
|
-
},
|
|
673
|
-
"left": {
|
|
674
|
-
"type": [
|
|
675
|
-
"string",
|
|
676
|
-
"number"
|
|
677
|
-
]
|
|
678
|
-
},
|
|
679
|
-
"right": {
|
|
680
|
-
"type": [
|
|
681
|
-
"string",
|
|
682
|
-
"number"
|
|
683
|
-
]
|
|
684
|
-
}
|
|
685
|
-
},
|
|
686
|
-
"additionalProperties": false
|
|
687
|
-
},
|
|
688
|
-
"ScrapeDebugOptions": {
|
|
689
|
-
"type": "object",
|
|
690
|
-
"properties": {
|
|
691
|
-
"console": {
|
|
692
|
-
"type": "boolean"
|
|
693
|
-
},
|
|
694
|
-
"cookies": {
|
|
695
|
-
"type": "boolean"
|
|
696
|
-
},
|
|
697
|
-
"html": {
|
|
698
|
-
"type": "boolean"
|
|
699
|
-
},
|
|
700
|
-
"network": {
|
|
701
|
-
"type": "boolean"
|
|
702
|
-
},
|
|
703
|
-
"screenshot": {
|
|
704
|
-
"type": "boolean"
|
|
705
|
-
}
|
|
706
|
-
},
|
|
707
|
-
"additionalProperties": false
|
|
708
|
-
},
|
|
709
|
-
"ScrapeElementSelector": {
|
|
710
|
-
"type": "object",
|
|
711
|
-
"properties": {
|
|
712
|
-
"selector": {
|
|
713
|
-
"type": "string"
|
|
714
|
-
},
|
|
715
|
-
"timeout": {
|
|
716
|
-
"type": "number"
|
|
717
|
-
}
|
|
718
|
-
},
|
|
719
|
-
"additionalProperties": false,
|
|
720
|
-
"required": [
|
|
721
|
-
"selector"
|
|
722
|
-
]
|
|
723
|
-
},
|
|
724
|
-
"Cookie": {
|
|
725
|
-
"description": "Represents a cookie object.",
|
|
726
|
-
"type": "object",
|
|
727
|
-
"properties": {
|
|
728
|
-
"name": {
|
|
729
|
-
"description": "Cookie name.",
|
|
730
|
-
"type": "string"
|
|
731
|
-
},
|
|
732
|
-
"value": {
|
|
733
|
-
"description": "Cookie value.",
|
|
734
|
-
"type": "string"
|
|
735
|
-
},
|
|
736
|
-
"domain": {
|
|
737
|
-
"description": "Cookie domain.",
|
|
738
|
-
"type": "string"
|
|
739
|
-
},
|
|
740
|
-
"path": {
|
|
741
|
-
"description": "Cookie path.",
|
|
742
|
-
"type": "string"
|
|
743
|
-
},
|
|
744
|
-
"expires": {
|
|
745
|
-
"description": "Cookie expiration date as the number of seconds since the UNIX epoch. Set to `-1` for\nsession cookies",
|
|
746
|
-
"type": "number"
|
|
747
|
-
},
|
|
748
|
-
"size": {
|
|
749
|
-
"description": "Cookie size.",
|
|
750
|
-
"type": "number"
|
|
751
|
-
},
|
|
752
|
-
"httpOnly": {
|
|
753
|
-
"description": "True if cookie is http-only.",
|
|
754
|
-
"type": "boolean"
|
|
755
|
-
},
|
|
756
|
-
"secure": {
|
|
757
|
-
"description": "True if cookie is secure.",
|
|
758
|
-
"type": "boolean"
|
|
759
|
-
},
|
|
760
|
-
"session": {
|
|
761
|
-
"description": "True in case of session cookie.",
|
|
762
|
-
"type": "boolean"
|
|
763
|
-
},
|
|
764
|
-
"sameSite": {
|
|
765
|
-
"description": "Cookie SameSite type.",
|
|
766
|
-
"enum": [
|
|
767
|
-
"Lax",
|
|
768
|
-
"None",
|
|
769
|
-
"Strict"
|
|
770
|
-
],
|
|
771
|
-
"type": "string"
|
|
772
|
-
},
|
|
773
|
-
"priority": {
|
|
774
|
-
"description": "Cookie Priority. Supported only in Chrome.",
|
|
775
|
-
"enum": [
|
|
776
|
-
"High",
|
|
777
|
-
"Low",
|
|
778
|
-
"Medium"
|
|
779
|
-
],
|
|
780
|
-
"type": "string"
|
|
781
|
-
},
|
|
782
|
-
"sameParty": {
|
|
783
|
-
"description": "True if cookie is SameParty. Supported only in Chrome.",
|
|
784
|
-
"type": "boolean"
|
|
785
|
-
},
|
|
786
|
-
"sourceScheme": {
|
|
787
|
-
"description": "Cookie source scheme type. Supported only in Chrome.",
|
|
788
|
-
"enum": [
|
|
789
|
-
"NonSecure",
|
|
790
|
-
"Secure",
|
|
791
|
-
"Unset"
|
|
792
|
-
],
|
|
793
|
-
"type": "string"
|
|
794
|
-
},
|
|
795
|
-
"partitionKey": {
|
|
796
|
-
"description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. Supported only in Chrome.",
|
|
797
|
-
"type": "string"
|
|
798
|
-
},
|
|
799
|
-
"partitionKeyOpaque": {
|
|
800
|
-
"description": "True if cookie partition key is opaque. Supported only in Chrome.",
|
|
801
|
-
"type": "boolean"
|
|
802
|
-
}
|
|
803
|
-
},
|
|
804
|
-
"additionalProperties": false,
|
|
805
|
-
"required": [
|
|
806
|
-
"domain",
|
|
807
|
-
"expires",
|
|
808
|
-
"httpOnly",
|
|
809
|
-
"name",
|
|
810
|
-
"path",
|
|
811
|
-
"secure",
|
|
812
|
-
"session",
|
|
813
|
-
"size",
|
|
814
|
-
"value"
|
|
815
|
-
]
|
|
816
|
-
},
|
|
817
|
-
"InBoundRequest": {
|
|
818
|
-
"type": "object",
|
|
819
|
-
"properties": {
|
|
820
|
-
"headers": {},
|
|
821
|
-
"status": {
|
|
822
|
-
"type": "number"
|
|
823
|
-
},
|
|
824
|
-
"url": {
|
|
825
|
-
"type": "string"
|
|
826
|
-
}
|
|
827
|
-
},
|
|
828
|
-
"additionalProperties": false,
|
|
829
|
-
"required": [
|
|
830
|
-
"headers",
|
|
831
|
-
"status",
|
|
832
|
-
"url"
|
|
833
|
-
]
|
|
834
|
-
},
|
|
835
|
-
"OutBoundRequest": {
|
|
836
|
-
"type": "object",
|
|
837
|
-
"properties": {
|
|
838
|
-
"headers": {},
|
|
839
|
-
"method": {
|
|
840
|
-
"type": "string"
|
|
841
|
-
},
|
|
842
|
-
"url": {
|
|
843
|
-
"type": "string"
|
|
844
|
-
}
|
|
845
|
-
},
|
|
846
|
-
"additionalProperties": false,
|
|
847
|
-
"required": [
|
|
848
|
-
"headers",
|
|
849
|
-
"method",
|
|
850
|
-
"url"
|
|
851
|
-
]
|
|
852
|
-
},
|
|
853
|
-
"ScreenshotOptions": {
|
|
854
|
-
"type": "object",
|
|
855
|
-
"properties": {
|
|
856
|
-
"optimizeForSpeed": {
|
|
857
|
-
"type": "boolean"
|
|
858
|
-
},
|
|
859
|
-
"type": {
|
|
860
|
-
"enum": [
|
|
861
|
-
"jpeg",
|
|
862
|
-
"png",
|
|
863
|
-
"webp"
|
|
864
|
-
],
|
|
865
|
-
"type": "string"
|
|
866
|
-
},
|
|
867
|
-
"quality": {
|
|
868
|
-
"description": "Quality of the image, between 0-100. Not applicable to `png` images.",
|
|
869
|
-
"type": "number"
|
|
870
|
-
},
|
|
871
|
-
"fromSurface": {
|
|
872
|
-
"description": "Capture the screenshot from the surface, rather than the view.",
|
|
873
|
-
"type": "boolean"
|
|
874
|
-
},
|
|
875
|
-
"fullPage": {
|
|
876
|
-
"description": "When `true`, takes a screenshot of the full page.",
|
|
877
|
-
"type": "boolean"
|
|
878
|
-
},
|
|
879
|
-
"omitBackground": {
|
|
880
|
-
"description": "Hides default white background and allows capturing screenshots with transparency.",
|
|
881
|
-
"type": "boolean"
|
|
882
|
-
},
|
|
883
|
-
"path": {
|
|
884
|
-
"description": "The file path to save the image to. The screenshot type will be inferred\nfrom file extension. If path is a relative path, then it is resolved\nrelative to current working directory. If no path is provided, the image\nwon't be saved to the disk.",
|
|
885
|
-
"type": "string"
|
|
886
|
-
},
|
|
887
|
-
"clip": {
|
|
888
|
-
"description": "Specifies the region of the page to clip.",
|
|
889
|
-
"$ref": "#/definitions/ScreenshotClip"
|
|
890
|
-
},
|
|
891
|
-
"encoding": {
|
|
892
|
-
"description": "Encoding of the image.",
|
|
893
|
-
"enum": [
|
|
894
|
-
"base64",
|
|
895
|
-
"binary"
|
|
896
|
-
],
|
|
897
|
-
"type": "string"
|
|
898
|
-
},
|
|
899
|
-
"captureBeyondViewport": {
|
|
900
|
-
"description": "Capture the screenshot beyond the viewport.",
|
|
901
|
-
"type": "boolean"
|
|
902
|
-
}
|
|
903
|
-
},
|
|
904
|
-
"additionalProperties": false
|
|
905
|
-
},
|
|
906
|
-
"ScreenshotClip": {
|
|
907
|
-
"type": "object",
|
|
908
|
-
"properties": {
|
|
909
|
-
"scale": {
|
|
910
|
-
"type": "number"
|
|
911
|
-
},
|
|
912
|
-
"width": {
|
|
913
|
-
"description": "the width of the element in pixels.",
|
|
914
|
-
"type": "number"
|
|
915
|
-
},
|
|
916
|
-
"height": {
|
|
917
|
-
"description": "the height of the element in pixels.",
|
|
918
|
-
"type": "number"
|
|
919
|
-
},
|
|
920
|
-
"x": {
|
|
921
|
-
"type": "number"
|
|
922
|
-
},
|
|
923
|
-
"y": {
|
|
924
|
-
"type": "number"
|
|
925
|
-
}
|
|
926
|
-
},
|
|
927
|
-
"additionalProperties": false,
|
|
928
|
-
"required": [
|
|
929
|
-
"height",
|
|
930
|
-
"width",
|
|
931
|
-
"x",
|
|
932
|
-
"y"
|
|
933
|
-
]
|
|
934
|
-
},
|
|
935
|
-
"IBrowserlessStats": {
|
|
936
|
-
"type": "object",
|
|
937
|
-
"properties": {
|
|
938
|
-
"cpu": {
|
|
939
|
-
"type": [
|
|
940
|
-
"null",
|
|
941
|
-
"number"
|
|
942
|
-
]
|
|
943
|
-
},
|
|
944
|
-
"date": {
|
|
945
|
-
"type": "number"
|
|
946
|
-
},
|
|
947
|
-
"error": {
|
|
948
|
-
"type": "number"
|
|
949
|
-
},
|
|
950
|
-
"maxConcurrent": {
|
|
951
|
-
"type": "number"
|
|
952
|
-
},
|
|
953
|
-
"maxTime": {
|
|
954
|
-
"type": "number"
|
|
955
|
-
},
|
|
956
|
-
"meanTime": {
|
|
957
|
-
"type": "number"
|
|
958
|
-
},
|
|
959
|
-
"memory": {
|
|
960
|
-
"type": [
|
|
961
|
-
"null",
|
|
962
|
-
"number"
|
|
963
|
-
]
|
|
964
|
-
},
|
|
965
|
-
"minTime": {
|
|
966
|
-
"type": "number"
|
|
967
|
-
},
|
|
968
|
-
"queued": {
|
|
969
|
-
"type": "number"
|
|
970
|
-
},
|
|
971
|
-
"rejected": {
|
|
972
|
-
"type": "number"
|
|
973
|
-
},
|
|
974
|
-
"sessionTimes": {
|
|
975
|
-
"type": "array",
|
|
976
|
-
"items": {
|
|
977
|
-
"type": "number"
|
|
486
|
+
}
|
|
487
|
+
},
|
|
488
|
+
"info": {
|
|
489
|
+
"description": "\n\n\n\n\n\n\n\n\n\n> [Looking for v1.x.x of browserless? You can find it here](https://github.com/browserless/chrome/tree/v1), although we recommend migrating to v2.\n\nBrowserless allows remote clients to connect and execute headless work, all inside of docker. It supports the standard, unforked Puppeteer and Playwright libraries, as well offering REST-based APIs for common actions like data collection, PDF generation and more.\n\nWe take care of common issues such as missing system-fonts, missing external libraries, and performance improvements, along with edge-cases like downloading files and managing sessions. For details, check out the documentation site built into the project which includes Open API docs.\n\nIf you've been struggling to deploy headless browsers without running into issues or bloated resource requirements, then Browserless was built for you. Run the browsers in [our cloud](https://browserless.io/) or your own, [free for non-commercial uses](https://github.com/browserless/browserless#licensing).\n# Table of Contents\n\n1. [Features](#features)\n2. [How it works](#how-it-works)\n3. [Docker](#docker)\n4. [Hosting](#hosting-providers)\n5. [Puppeteer](#puppeteer)\n6. [Playwright](#playwright)\n7. [Extending with NodeJS SDK](#extending-nodejs-skd)\n8. [Licensing](#licensing)\n9. [Changelog](https://github.com/browserless/chrome/blob/master/CHANGELOG.md)\n\n## External links\n\n1. [Full documentation site](https://www.browserless.io/docs/start)\n2. [Live Debugger (using browserless.io)](https://chrome.browserless.io/)\n3. [Docker](https://github.com/browserless/browserless/pkgs/container/base)\n4. [Slack](https://join.slack.com/t/browserless/shared_invite/enQtMzA3OTMwNjA3MzY1LTRmMWU5NjQ0MTQ2YTE2YmU3MzdjNmVlMmU4MThjM2UxODNmNzNlZjVkY2U2NjdkMzYyNTgyZTBiMmE3Nzg0MzY)\n\n# Features\n\n- Parallelism and request-queueing are built-in + configurable.\n- Fonts and emoji's working out-of-the-box.\n- Debug Viewer for actively viewing/debugging running sessions.\n- An interactive puppeteer debugger, so you can see what the headless browser is doing and use its DevTools.\n- Works with unforked Puppeteer and Playwright.\n- Configurable session timers and health-checks to keep things running smoothly.\n- Error tolerant: if Chrome dies it won't.\n- [Support for running and development on Apple's M1 machines](#building-for-arm64-apple-m1-machines)\n\n# How it works\n\nBrowserless listens for both incoming websocket requests, generally issued by most libraries, as well as pre-build REST APIs to do common functions (PDF generation, images and so on). When a websocket connects to Browserless it starts Chrome and proxies your request into it. Once the session is done then it closes and awaits for more connections. Some libraries use Chrome's HTTP endpoints, like `/json` to inspect debug-able targets, which Browserless also supports.\n\nYou still execute the script itself which gives you total control over what library you want to choose and when to do upgrades. This also comes with the benefit of keep your code proprietary and able to run on numerous platforms. We simply take care of all the browser-aspects and offer a management layer on top of the browser.\n\n# Docker\n\n> See more options on our [full documentation site](https://www.browserless.io/docs/docker-quickstart).\n\n1. `docker run -p 3000:3000 ghcr.io/browserless/chrome`\n2. Visit `http://localhost:3000/docs` to see the documentation site.\n3. See more at our [docker package](https://github.com/browserless/browserless/pkgs/container/base).\n\n# Hosting Providers\n\nWe offer a first-class hosted product located [here](https://browserless.io). Alternatively you can host this image on just about any major platform that offers hosting for docker. Our hosted service takes care of all the machine provisioning, notifications, dashboards and monitoring plus more:\n\n- Easily upgrade and toggle between versions at the press of a button. No managing repositories and other code artifacts.\n- Never need to update or pull anything from docker. There's literally zero software to install to get started.\n- Scale your consumption up or down with different plans. We support up to thousands of concurrent sessions at a given time.\n\nIf you're interested in using this image for commercial aspects, then please read the below section on licensing.\n\n# Puppeteer\n\nPuppeteer allows you to specify a remote location for chrome via the `browserWSEndpoint` option. Setting this for Browserless is a single line of code change.\n\n**Before**\n```js\nconst browser = await puppeteer.launch();\n```\n\n**After**\n```js\nconst browser = await puppeteer.connect({ browserWSEndpoint: 'ws://localhost:3000' });\n```\n\n# Playwright\n\nWe support running with playwright via their remote connection method on the `chromium` interface. Since playwright is very similar to puppeteer, even launch arguments and other things \"just work\":\n\n**Before**\n```js\nconst browser = await pw.chromium.launch();\n```\n\n**After**\n```js\nconst browser = await pw.chromium.connect('ws://localhost:3000/playwright/chromium');\n\n// OR\nconst browser = await pw.chromium.connectOverCDP('ws://localhost:3000');\n```\n\nAfter that, the rest of your code remains the same with no other changes required.\n\n# Extending (NodeJS SKD)\n\nBrowserless comes with built-in extension capabilities, and allows for extending nearly any aspect of the system (for Version 2+). For more details on how to write your own routes, build docker images, and more, [see our SDK README.md](/bin/scaffold/README.md) or simply run \"npx @browserless.io/browserless create\" in a terminal and follow the onscreen prompts.\n\n# Usage with other libraries\n\nMost libraries allow you to specify a remote instance of Chrome to interact with. They are either looking for a websocket endpoint, a host and port, or some address. Browserless supports these by default, however if you're having issues please make an issue in this project and we'll try and work with the library authors to get them integrated with browserless. Please note that in V2 we no longer support selenium or webdriver integrations.\n\nYou can find a much larger list of supported libraries [on our documentation site](https://www.browserless.io/docs/puppeteer-library).\n\n# Motivations\n\nRunning Chrome on lambda or on your own is a fantastic idea but in practice is quite challenging in production. You're met with pretty tough cloud limits, possibly building Chrome yourself, and then dealing with odd invocation issues should everything else go ok. A lot of issues in various repositories are due to just challenges of getting Chrome running smoothly in AWS (see [here](https://github.com/GoogleChrome/puppeteer/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc)). You can see for yourself by going to nearly any library and sorting issues by most commented.\n\nGetting Chrome running well in docker is also a challenge as there's quiet a few packages you need in order to get Chrome running. Once that's done then there's still missing fonts, getting libraries to work with it, and having limitations on service reliability. This is also ignoring CVEs, access-controls, and scaling strategies.\n\nAll of these issues prompted us to build a first-class image and workflow for interacting with Chrome in a more streamlined way. With Browserless you never have to worry about fonts, extra packages, library support, security, or anything else. It just works reliably like any other modern web service. On top of that it comes with a prescribed approach on how you interact with Chrome, which is through socket connections (similar to a database or any other external appliance). What this means is that you get the ability to drive Chrome remotely without having to do updates/releases to the thing that runs Chrome since it's divorced from your application.\n\n# Licensing\n\nSPDX-License-Identifier: SSPL-1.0 OR Browserless Commercial License.\n\nIf you want to use Browserless to build commercial sites, applications, or in a continuous-integration system that's closed-source then you'll need to purchase a commercial license. This allows you to keep your software proprietary whilst still using browserless. [You can purchase a commercial license here](https://www.browserless.io/contact). A commercial license grants you:\n\n- Priority support on issues and features.\n- On-premise running as well as running on public cloud providers for commercial/CI purposes for proprietary systems.\n- Ability to modify the source (forking) for your own purposes.\n- A new admin user-interface.\n\nNot only does it grant you a license to run such a critical piece of infrastructure, but you are also supporting further innovation in this space and our ability to contribute to it.\n\nIf you are creating an open source application under a license compatible with the Server Side License 1.0, you may use Browserless under those terms.\n\n# Changelog\n<h1><a href=\"https://github.com/browserless/chrome/compare/v2.2.0...main\">Latest</a></h1>\n<ul>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v2.1.0...v2.2.0\">v2.2.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li><code>ghcr.io/browserless/chrome</code> now runs actual Chrome and not Chromium! If you were using this tag please update to use <code>ghcr.io/browserless/chromium</code>!<ul>\n<li>This Chrome tag uses the new routing convention below. If you get random 404's, please add <code>/chrome</code> to the start of the route. EG, <code>/pdf</code> becomes <code>/chrome/pdf</code>.</li>\n<li>Websocket connections follow a similar breakage in that the URL will go from something like <code>ws://localhost:3000</code> to <code>ws://localhost:3000/chrome</code>.</li>\n</ul>\n</li>\n<li>Adds a new <code>ghcr.io/browserless/chromium</code>, and updates <code>ghcr.io/browserless/chrome</code> to use actual Chrome.</li>\n<li>New and current APIs now follow a routing convention of <code>/$BROWSER/$ACTION</code>. In our Chrome image, you'll see <code>/chrome/pdf</code> for the PDF route as opposed to <code>/pdf</code>.<ul>\n<li>To keep things backwards compatible, all our prior REST APIs still have the same path as well as the new semantic, but only in the <code>multi</code> and <code>chromium</code> tags.</li>\n<li>These backwards compatible routes are ONLY available in <code>ghcr.io/browserless/chromium</code> and <code>ghcr.io/browserless/multi</code>.</li>\n</ul>\n</li>\n<li>Refer to the embedded documentation site for any and all updates on API differences.</li>\n</ul>\n<p><strong>Other Changes</strong></p>\n<ul>\n<li>HTTPRoutes and WebSocket routes can now have multiple paths to listen on.</li>\n<li>Add <code>clean</code> command to <code>@browserless.io/browserless</code> CLI.</li>\n<li>Adds support for <code>/json/list</code>, <code>/json/new</code>, <code>/json/version</code> and <code>json/protocol</code> APIs (Chrome and Chromium only).<ul>\n<li>When both Chrome and Chromium are present (in the case of the multi image), browserless opts for Chromium for these requests.</li>\n</ul>\n</li>\n<li>Removes legacy <code>browser.json</code> files since browserless now generates those and caches when requested.</li>\n<li>Stable docker images are coming! Please be sure to see our packages page for stable tags.</li>\n<li>Only verify that internally managed browsers are installed when starting.</li>\n<li>Preliminary support for <code>--headless=shell</code>.</li>\n<li>More unit-tests for the Chrome /json APIs.</li>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/browserless/compare/v2.0.0-beta-1...v2.1.0\">v2.1.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Name is now <code>@browserless.io/browserless</code> to reflect our npm package.</li>\n<li>NEW: SDK is now live here: <a href=\"https://www.npmjs.com/package/@browserless.io/browserless\">https://www.npmjs.com/package/@browserless.io/browserless</a>.</li>\n<li>Drops gulp and other gulp utilities in favor of our own. Move to modules in <code>scripts</code> dir.</li>\n<li>Many private class properties now use <code>protected</code> so they can be referenced in SDK extensions.</li>\n<li>Adds a <code>/json/version</code> route for older libraries that use it.</li>\n<li>Merge startup/test scripts into <code>scripts</code> dir.</li>\n<li>Moves installed browsers to <code>/usr/local/bin/playwright-browsers</code>.</li>\n<li>Merge root files into package.json where possible.</li>\n<li>README updates and fixes.</li>\n<li>Numerous link and copyright fixes.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/master...feat/browserless-2.0\">v2.0.0</a></h1>\n<p>browserless 2.0.0 represents the best body of work after running browserless for over 5 years. It contains mostly the same functionality and more, and is rebuilt to be more modular and offer a NodeJS SDK. It's also much lighter and faster than prior versions and includes a lot of semantic changes.</p>\n<h2>Features</h2>\n<ul>\n<li>ECMAScript style module loading and dependencies.</li>\n<li>New routing system using purely NodeJS's HTTP module.</li>\n<li>Better logs and concurrency/queueing parameters.</li>\n<li>Support for running the other major browser vendors in the same format and package.</li>\n<li>The service now compiles TypeScript to runtime JOI validation for our routes.</li>\n<li>Soon: upcoming support for extensions, long-running sessions and more.</li>\n</ul>\n<h2>Breaking Changes</h2>\n<ul>\n<li>Remove support for Selenium.</li>\n<li>The <code>/function</code> API now runs inside the context of the browser and not in Node.</li>\n<li>Drop support for keep-alive and pre-booting.</li>\n<li>Support for a single <code>launch</code> query-string parameter for launching a browser versus many individual parameters.</li>\n</ul>\n<h2>Minor Changes</h2>\n<ul>\n<li>Many docker parameters have been renamed, but are backwards compatible. See config.ts for details.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.60.2...v1.61.0\">v1.61.0</a></h1>\n<ul>\n<li><strong>FINAL of V1 for browserless/chrome. <a href=\"https://github.com/browserless/chrome/pull/3345\">See notes on V2 here</a></strong></li>\n<li>Dependency updates.</li>\n<li>Added <code>fonts-urw-base35</code>.</li>\n<li>Supports puppeteer <code>1.20</code>, <code>10.4.0</code>, <code>13.1.3</code>, <code>14.4.1</code>, <code>16.2.0</code>, <code>19.7.5</code> and <code>21.4.1</code>.</li>\n<li>Supports playwright <code>1.39</code>, <code>1.38</code>, <code>1.37</code>, <code>1.36</code>, <code>1.35</code>, <code>1.34</code>, and <code>1.33</code>.</li>\n<li>Fixes an issue where keep-alive chrome instances aren't properly tracked when <code>browser.close</code> is called.</li>\n<li>Fix improper handling of HTTP writing on bare sockets with 500 errors.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.60.1...v1.60.2\">v1.60.2</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fixes an issue where calls to GET /sessions sometimes return blank results.</li>\n<li>Drop puppeteer <code>21.3.1</code> in favor of <code>21.3.6</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.60.0...v1.60.1\">v1.60.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Drop the <code>partner</code> repo from builds as we no longer use it for installing <code>flash</code>.</li>\n<li>Bump to <code>Ubuntu</code> lunar.</li>\n<li>Bump to NodeJS 18.17.0</li>\n<li>Package.json <code>engines.node</code> now reflects what node version we run on the docker image.</li>\n<li>Drops support for playwright@<code>1.33</code> and default playwright to <code>1.38</code>.</li>\n<li>Drops support for puppeteer@<code>21.1.1</code> in favor of <code>21.3.1</code>.</li>\n<li>Replaces legacy <code>request</code> module with Node's native <code>fetch</code> for webhooks.</li>\n<li>Drops <code>node-fetch</code> across the board in favor of <code>fetch</code> native.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.59.0...v1.60.0\">v1.60.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New build arguments in our Dockerfile to apply different named base repo.</li>\n<li>New <code>CHROME_STABLE_VERSION</code> build arg for specifying a particular chrome stable version.</li>\n<li>Fixes in postinstall hooks for various platforms and chrome-stable.</li>\n<li>NEW: <code>waitFor</code> properties in our APIs now supports an object with selector + timeouts for more fine tuning.</li>\n<li>Bump puppeteer <code>20.x.x</code> to <code>21.1.1</code> (116.0.5845.96).</li>\n<li>Supports playwright versions <code>1.37</code>, <code>1.36</code>, <code>1.35</code>, <code>1.34</code>, and <code>1.33</code>.</li>\n<li>Fixes in deploy script to handle versions, platforms and architectures.</li>\n<li>Fixes an issue where headless defaults to <code>DEFAULT_STEALTH</code>.</li>\n<li>New <code>PREBOOT_QUANTITY</code> for overriding the amount of pre-booted instances of Chrome.</li>\n<li>Allow using a host's display by setting <code>DISPLAY</code> env variable.</li>\n<li>Link fixes in README.md.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.58.0...v1.59.0\">v1.59.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump to Ubuntu Kinetic release + updates to use relevant packages.</li>\n<li>In support of puppeteer 20+, updates to <code>env.js</code> for finding/symlinking Chrome.</li>\n<li>Supports playwright <code>1.33</code>, <code>1.32</code>, <code>1.31</code>, and <code>1.29.</code>. Drops support for earlier versions.</li>\n<li>Ad-blocking and other request-interception in browserless is graceful using the <code>isInterceptResolutionHandled</code> method.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.57.0...v1.58.0\">v1.58.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Documentation link fixes.</li>\n<li>Add new required lib <code>libu2f-udev</code>.</li>\n<li>Support for <a href=\"mailto:puppeteer@19.7.5\">puppeteer@19.7.5</a>.</li>\n<li>Supports playwright versions: <code>1.27</code>, <code>1.28</code>, <code>1.29</code>, <code>1.30</code> and <code>1.31</code>.</li>\n<li>Better internal TypeScript definitions.</li>\n<li>Print's a few extra log-lines at startup for links to various resources.</li>\n<li><code>/kill/all</code> now supports rebooting when PREBOOT is turned on.</li>\n<li>Fixes an issue with chromedriver boot-looping in modern versions.</li>\n<li>Adds support for <code>--headless=new</code>.</li>\n<li>Fixes an issue where user-data-dirs aren't deleted due to a crashed container.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.56.0...v1.57.0\">v1.57.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Add back in <code>puppeteer@13.1.3</code> for PDF/Screenshot performance.</li>\n<li>Replace <code>puppeteer@18.0.5</code> in favor of <code>puppeteer@19.2.2</code>.</li>\n<li>Better puppeteer install/binary path lookups.</li>\n<li>Support for the following playwright versions via the /playwright path:<ul>\n<li>1.23.3</li>\n<li>1.24.2</li>\n<li>1.25.2</li>\n<li>1.26.1</li>\n<li>1.27.1</li>\n</ul>\n</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.55.0...v1.56.0\">v1.56.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fixes various puppeteer issues with regards to revision information and browser-fetching.</li>\n<li>Fixes a Selenium issue where failed browsers can cause session to zombie.</li>\n<li>Small fix for route error handling.</li>\n<li>Better selenium W3C support.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.55.0...v1.54.1\">v1.55.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>Update base OS from Ubuntu 20.04 to Ubuntu 22.04.</li>\n<li>Drops <code>path</code> support for both <code>addScriptTag</code> and <code>addStyleTag</code>. Use <code>url</code> or inject content directly.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency updates.</li>\n<li>We now support multiple versions of playwright via <code>playwright-core</code>. browserless checks the User-Agent string and tries to load a compatible playwright server at runtime in order to avoid breakages between versions.</li>\n<li>New <code>scrollPage</code> boolean parameter for the screenshot and other relevant APIs.</li>\n<li>browserless now writes appropriately formatted HTTP and WebSocket messages for non-2xx responses.</li>\n<li>Better CI coverage with prior puppeteer versions.</li>\n<li>Adds back a <code>browser.json</code> file in our docker images for easier CDP-related queries.</li>\n<li>A new <code>PORT</code> arg is available at build time in order to specify a PORT to listen onto.</li>\n<li>Updated links for browserless documentation in docs.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.54.1...v1.54.0\">v1.54.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Add <code>browser.json</code> file to git tags.</li>\n<li>Prettier fixes on source.</li>\n<li>deploy.js file fixes for creating production tags.</li>\n<li>Fix: add the <code>userDataDir</code> option so that we don't fill disks when using <code>stealth</code>.</li>\n<li>Fix: allow <code>disconnect</code> listeners to fire before closing.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.53.0...v1.54.0\">v1.54.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Move to using <code>mocha</code> for better esm support.</li>\n<li>Drop puppeteer <code>13.6.0</code> in favor of <code>14.4.1</code>.</li>\n<li>Utilize puppeteer <code>14.4.1</code> for <code>chrome-stable</code>.</li>\n<li>New internal <code>getCDPClient</code> for loading a page's CPD connection.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.52.1...v1.53.0\">v1.53.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump <code>browserless:base</code> to <code>1.16.0</code>.</li>\n<li>Drop <code>--quiet</code> from deploy scripts.</li>\n<li><code>arm64</code> support for latest as well as puppeteer at versions 9,10 and 13.</li>\n<li>Update puppeteer 13 from <code>13.5.2</code> to <code>13.6.0</code> (revision <code>982053</code>).</li>\n<li>README updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.52.0...v1.52.1\">v1.52.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Playwright example correction in README.md.</li>\n<li>Use revision <code>970485</code> for puppeteer 13.x.x, <code>latest</code>, chrome-stable and <code>arm64</code>.</li>\n<li>When using <code>KEEPALIVE</code> and <code>PREBOOT</code>, don't create new blank pages, and use the existing one instead.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.51.1...v1.52.0\">v1.52.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Added in new fonts: <code>fonts-gfs-neohellenic</code>.</li>\n<li>Minor code formatting changes.</li>\n<li>Drop <a href=\"mailto:puppeteer@13.1.3\">puppeteer@13.1.3</a> in favor of 13.5.2.</li>\n<li>Make <code>heapdump</code> an optional dependency as it's not always used, and add it back in.</li>\n<li>Utilize <code>fs/promise</code> vs home-rolled promisified utils.</li>\n<li>Fix an issue where PREBOOT and KEEPALIVE might return an <code>undefined</code> browser.</li>\n<li>Logging when file-protocol requests happen and terminate a session.</li>\n<li>Move the browser process exit listener into the puppeteer-provider for better session cleanup.</li>\n<li>Allow "headfull" playwright sessions.</li>\n<li>Don't <code>await</code> chrome-helper's closing of the browser as it's not truly async.</li>\n<li>Remove <code>body-parser</code> in favor of <code>express</code>'s JSON and other parsers.</li>\n<li>Fixes an issue where using a user-data-dir that doesn't exist causes chrome to crash.</li>\n<li>Add in more unit and integration tests.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.51.1...v1.52.0\">v1.52.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Added in new fonts: <code>fonts-gfs-neohellenic</code>.</li>\n<li>Minor code formatting changes.</li>\n<li>Drop <a href=\"mailto:puppeteer@13.1.3\">puppeteer@13.1.3</a> in favor of 13.5.2.</li>\n<li>Make <code>heapdump</code> an optional dependency as it's not always used, and add it back in.</li>\n<li>Utilize <code>fs/promise</code> vs home-rolled promisified utils.</li>\n<li>Fix an issue where PREBOOT and KEEPALIVE might return an <code>undefined</code> browser.</li>\n<li>Logging when file-protocol requests happen and terminate a session.</li>\n<li>Move the browser process exit listener into the puppeteer-provider for better session cleanup.</li>\n<li>Allow "headfull" playwright sessions.</li>\n<li>Don't <code>await</code> chrome-helper's closing of the browser as it's not truly async.</li>\n<li>Remove <code>body-parser</code> in favor of <code>express</code>'s JSON and other parsers.</li>\n<li>Fixes an issue where using a user-data-dir that doesn't exist causes chrome to crash.</li>\n<li>Add in more unit and integration tests.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.51.0...v1.51.1\">v1.51.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Updates the <code>vm2</code> module to <code>3.9.7</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.50.0...v1.51.0\">v1.51.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>viewport</code> option inside of the content API.</li>\n<li>New <code>encoding</code> option in the screenshot API.</li>\n<li>Drop <a href=\"mailto:puppeteer@12.x.x\">puppeteer@12.x.x</a> in favor of 13.x.x.</li>\n<li>Fixes in our deploy scripts.</li>\n<li>Fixes for windows binaries in our postinstall hook.</li>\n<li>Fixes an issue where playwright tries to use a pre-booted chrome instance.</li>\n<li>Small type updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.49.1...v1.50.0\">v1.50.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Drops support for <code>puppeteer-4.0.1</code> in favor of <code>puppeteer-12.0.1</code>.</li>\n<li>Chrome-stable now utilizes puppeteer @ <code>12.0.1</code>.</li>\n<li>Support for <code>arm64</code> via production tags (<code>1-arm64</code>) as well as in <code>latest</code>.</li>\n<li>Static JSON files (<code>protocol.json</code>, <code>version.json</code>) are built at runtime on their first request and then cached in memory.</li>\n<li>Bumps <code>browserless/base</code> to <code>1.14.0</code>.</li>\n<li>New <code>selector</code> property for screenshot-ing a single DOM node in the screenshot API.</li>\n<li><code>puppeteerVersions</code> in the package.json file has been rename do <code>chromeVersions</code>.</li>\n<li>Internal changes for deploying production tag scripts.</li>\n<li>Consolidate scripts for <code>postinstall</code>.</li>\n<li>Drop support for <code>heapdump</code> due to its age and lack of platform varieties.</li>\n<li>New <code>/metrics/total</code> route for summing up all statistics in a single JSON payload.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.49.0...v1.49.1\">v1.49.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fix webhook not using timeout URL.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.48.0...v1.49.0\">v1.49.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Support for ARM64 builds by dropping flash for it.</li>\n<li>Bump puppeteer 10.2.0 for 10.4.0.</li>\n<li>New puppeteer-hook for injecting a puppeteer-compatible library, eg. puppeteer-extra.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.47.0...v1.48.0\">v1.48.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>API calls with <code>html</code> in their payloads now use the <code>page.setContent</code> API versus a prior hack using one-time network-request interception (<a href=\"https://github.com/browserless/chrome/compare/v1.47.0...master#diff-67b699af1b24472604e21081d0509620d4ab3d986fcd4f8aa0b04d5ee5e4c63fL88\">example here</a>). Old versions of puppeteer might not work properly with this (<= 5.x.x). This effects the following APIS: <code>/content</code>, <code>/pdf</code> and <code>/screenshot</code>.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump <code>browserless/base</code> to <code>1.12.0</code> (add user-id to <code>blessuser</code> of <code>BLESS_USER_ID=999</code>).</li>\n<li>Bumps puppeteer @10.x.x to <code>10.2.0</code> with revision <code>901912</code>.</li>\n<li>Makes API calls use <code>setContent</code> properly now (no more one-time network interception). This fixes certain issues with images not loading in PDFs and screenshots.</li>\n<li>Fix some typings in tests.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.46.0...v1.47.0\">v1.47.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump <code>browserless/base</code> to <code>1.11.0</code>.</li>\n<li>Add new lint task and rename GitHub actions tasks, remove <code>tslint</code>.</li>\n<li>Lint and prettier fixes.</li>\n<li>Delay url parsing until after <code>before</code> hook runs.</li>\n<li>New <code>meta</code> object param for page hooks (passing through arbitrary meta data set by prior hooks).</li>\n<li>New <code>FUNCTION_ENV_VARS</code> environment variable pass through an allow-list of environment variables for functions to access.</li>\n<li>Fix <code>someObject.hasOwnProperty</code> to <code>Object.prototype.hasOwnProperty.call</code>.</li>\n<li></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.45.0...v1.46.0\">v1.46.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Move to Node 16.x.x.</li>\n<li>Bump browserless/base to 1.10.0.</li>\n<li>Limit <code>x-response-url</code> to 100 characters.</li>\n<li>Add support for <a href=\"mailto:puppeteer@10.x.x\">puppeteer@10.x.x</a>.</li>\n<li>Add <code>maxConcurrent</code> stat for metrics API + log stats every 5 minutes to stdout.</li>\n<li>Some performance improvements to how pages/browsers are setup and torn down.</li>\n<li>Add <code>API_DOCS_ENDPOINT</code> as a filterable API to deny access to.</li>\n<li>Minor code reformatting from prettier.</li>\n<li>Better page setup and logging.</li>\n<li>Fixes <code>DEFAULT_STEALTH</code> for self-hosted deployments.</li>\n<li>Improvements on how chrome is closed.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.44.0...v1.45.0\">1.45.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Support for <a href=\"https://github.com/browserless/chrome/commit/0903795e936b93a511ec04f7ae35c03397682905\">playwright proxies</a>.</li>\n<li>Fixes an issue with larger headers potentially causing load-balancers to crash and fail.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.43.0...v1.44.0\">v1.44.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li><code>PROXY_HOST</code> and <code>PROXY_PORT</code> are now replaced with a single <code>PROXY_URL</code> param, eg: <code>https://www.mybrowserless.com/optional/paths</code>. When set, browserless uses this fully-qualified URL to build out links <em>back</em> to its internal debugger and sessions. Useful when you're instance is behind a proxy or load-balancer of some kind.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency Updates.</li>\n<li>Use recent Node 14 (browserless-base 1.7.0).</li>\n<li>New <code>rejectResourceTypes</code> property on most APIs (content, screenshot, pdf, etc.).</li>\n<li>Allow serving of <code>file://</code> protocols when explicitly enabled (default is off due to security concerns). Set <code>ALLOW_FILE_PROTOCOL=true</code> in your env params.</li>\n<li>The <code>/pressure</code> API now takes into account CPU/Memory consumption, and adds a "reason" property for why the machine might be not available.</li>\n<li>Fixes an issue where playwright couldn't download files.</li>\n<li>You can now filter /sessions calls with a <code>trackingId</code> parameter.</li>\n<li><code>detached</code> functions now return a <code>trackingId</code> when present.</li>\n<li>More types, tests, and utility consolidation.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.42.0...v1.43.0\">v1.43.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fixes an issue where --user-data-dirs aren't deleted properly, potentially filling disks.</li>\n<li>Changes CPU/Memory checks to be user-based and not the entire OS.</li>\n<li>Adds tests for the user-data-dir issue.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.41.0...v1.42.0\">v1.42.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Move to Node 14!</li>\n<li>Use <code>esModuleInterop</code> for imports.</li>\n<li>Remove <code>page.waitFor</code> in favor of downstream methods.</li>\n<li>Adds new <code>?stealth</code> parameter for API calls (see puppeteer-extra-stealth-plugin).</li>\n<li>New <code>DEFAULT_STEALTH</code> param for making stealth calls by default.</li>\n<li>Fixes <code>ignoreDefaultArgs</code> in chrome stable.</li>\n<li>Ensure temp user-data-dirs are always cleaned up.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.40.2...v1.41.0\">v1.41.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>New <code>SESSION_CHECK_FAIL_URL</code> webhook for when pre-session checks fail.</li>\n<li>Health checks now take the last two CPU/Memory samples to determine if a failure (5 minutes).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.40.1...v1.40.2\">v1.40.2</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fix potentially unhandled stream error events when closing chrome.</li>\n<li>Bump puppeteer to 5.4.1 for major 5.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.40.0...v1.40.1\">v1.40.1</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>New <code>SOCKET_CLOSE_METHOD</code> for better load-balancing behavior when under load.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.39.0...v1.40.0\">v1.40.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Support for playwright 1.4.0 and greater. <a href=\"https://github.com/microsoft/playwright/issues/4054\">See more here</a>.</li>\n<li>New <code>PRE_REQUEST_HEALTH_CHECK</code> env variable to check CPU/Memory prior to running a session. Set <code>MAX_CPU_PERCENT</code> or <code>MAX_MEMORY_PERCENT</code> for setting these thresholds. Responds with a <code>503</code> HTTP code if CPU/Memory are high on any inbound session (API, puppeteer or webdriver).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.38.0...v1.39.0\">v1.39.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes a crash due to <code>browser.close</code> streams not completing properly.</li>\n<li>Adds a <code>dumpio</code> query-string parameter for launching with puppeteer.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.37.2...v1.38.0\">v1.38.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes a memory leak when browsers don't close properly.</li>\n<li>Adds a <code>/heapdump</code> route for capturing heap dumps. Turn on by setting <code>ENABLE_HEAP_DUMP=true</code> in your docker env.</li>\n<li><code>emulateMedia</code> fixes on the pdf route.</li>\n<li>CodeQL implemented.</li>\n<li>README fixes.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.37.1...v1.37.2\">v1.37.2</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes an issue where the webserver can crash after rejecting a request.</li>\n<li>Fixes deployment script not waiting for zip files to be finished unzipped.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.37.0...v1.37.1\">1.37.1</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes an issue in webdriver not starting properly.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.36.0...v1.37.0\">1.37.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>Due to stability issues, puppeteer version 3.x.x and 4.x.x now use chromium revision <code>782078</code>. See our <code>package.json</code> for details.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency Updates</li>\n<li>README Updates</li>\n<li>Fixes an issue for secured containers using prometheus (plus tests).</li>\n<li>Support for puppeteer <code>5.2.1</code></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.35.0...v1.36.0\">1.36.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Drops support for puppeteer <code>2.0.0</code> and <code>3.0.4</code>, please use <code>2.1.1</code> and <code>3.3.0</code> for those revisions.</li>\n<li>Adds support for puppeteer <code>5.0.0</code>.</li>\n<li>Bug-fix with the server randomly closing with an uncaught error event thrown from inside underlying socket connection.</li>\n<li>Adds back in <code>--disable-dev-shm-usage</code> to default arguments for better SHM performance.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.34.0...v1.35.0\">1.35.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>New <code>maxTime</code>, <code>minTime</code>, <code>meanTime</code> and <code>totalTime</code> of all sessions for a given period in /stats.</li>\n<li>Bugfix on CPU/Memory triggering health failure webhooks.</li>\n<li>Fix issues in websocket errors by awaiting browser.close (or 5 seconds, whichever is quickest).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.33.1...v1.34.0\">v1.34.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>screencast API no longer supports <code>audio</code> or the <code>setPreferences</code> function in order to offer a better video experience. In order to set the width/height, simply set a page width height to what you'd like.</li>\n<li><code>chrome-stable</code> will now use <code>puppeteer@3.1.0</code> for better compatibility.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency updates.</li>\n<li>Drops puppeteer version <code>1.20.0</code> and below.</li>\n<li>Move <code>browserless/base</code> to <code>v1.5.0</code>.</li>\n<li>Puppeteer support for <code>3.3.0</code> (3.2.x and 3.1.x have the same chromium revision).</li>\n<li>Fixes <code>trackingId</code> on pre-booted sessions.</li>\n<li><code>about:blank</code> pages now are returned in the <code>/sessions</code> API for transparency of open sessions/browsers.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.33.0...v1.33.1\">1.33.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fix socket errors from accidentally firing error webhooks.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.32.0...v1.33.0\">1.33.0</a></h1>\n<ul>\n<li>Drops support for puppeteer 1.17.x and 1.18.x</li>\n<li>Support for puppeteer 3.0.x</li>\n<li>Dependency updates</li>\n<li>Fix reject stat firing on debugger pages not being found</li>\n<li>Consolidates more types.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.31.1...v1.32.0\">1.32.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Adds roboto fonts.</li>\n<li>Updates <code>pressure</code> API to take account of running browsers in the <code>running</code> count.</li>\n<li>Adds <code>maxConcurrent</code>, <code>maxQueued</code>, <code>cpu</code> and <code>memory</code> to pressure.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.31.0...v1.31.1\">1.31.1</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fixes a small issue where XVFB doesn't start properly during an automated restart.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.30.0...v1.31.0\">1.31.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Allows <code>trackingId</code> on uploaded files to save in the appropriate tracking-ID folder.</li>\n<li>New <code>userAgent</code> param for setting user-agent in API requests.</li>\n<li>Fixes an issue where chrome wasn't being closed in rare cases.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.29.1...v1.30.0\">1.30.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Updates to Node 13 for speed and memory improvements.</li>\n<li>browserless/<a href=\"mailto:base@1.4.0\">base@1.4.0</a></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.29.0...v1.29.1\">1.29.1</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fixes how deploy script determines errors when running child commands.</li>\n<li>Fixes issues when many selenium sessions can potentially fill up disk space.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.28.0...v1.29.0\">1.29.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Uses <code>pipe</code>'s for most API calls and other internal endpoints for faster/better throughput. Works only for <code>headless</code> API/puppeteer calls.</li>\n<li>Allows custom lighthouse configs via POST <code>config</code> property.</li>\n<li>Patches vm2.</li>\n<li>Before hooks no longer end requests forcefully -- external hooks must manually end the request/sockets themselves.</li>\n<li>Properly passes socket errors to the error handler/webhook</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.27.0...v1.28.0\">1.28.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Sets a system-default font of Ubuntu for most sites that use <code>system-ui</code> in their font declarations.</li>\n<li>Fixes health-check failure webhooks.</li>\n<li>New <code>PROXY_HOST</code>, <code>PROXY_PORT</code> and <code>PROXY_SSL</code> for external load-balancers. <a href=\"https://www.browserless.io/docs/docker.html#using-a-proxy\">See docsite for more info</a>.</li>\n<li>Moves over to GH actions over Travis for CI.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.26.1...v1.27.0\">1.27.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>manipulate</code> params for screenshots, allowing for resizing, flipping and more.</li>\n<li>Better tracking of chrome-process for cleanup of zombied sessions.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.26.0...v1.26.1\">1.26.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Added <code>git</code> as a dependency in dockerfile for git-based npm dependencies to work.</li>\n<li>Fixed an issue in <code>start.sh</code> so that errors bubble up properly and close the process.</li>\n<li>Bumps <code>browserless/base</code> to <code>1.2.0</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.25.0...v1.26.0\">1.26.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Dropping pre-push hooks for speed.</li>\n<li>Consolidate all interfaces/types to a types.d.ts file.</li>\n<li>Fixes an issue where numerous chrome instances launch when prebooting.</li>\n<li>Fixes an issue where incoming requests don't use the pre-booted chrome instance.</li>\n<li>Uses <code>page.setViewport</code> when <code>--window-size</code> is set in params to help with screenshots not appearing properly (chromedriver only).</li>\n<li></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.24.0...v1.25.0\">1.25.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Stricter build-time arguments for chromium and chromedriver assets.</li>\n<li>Better XVFB functionality.</li>\n<li>New parameters for most API's, <code>addScriptTag</code> and <code>addStyleTag</code>, accepting an array of scripts/styles respectively.</li>\n<li>Drop support for <code>puppeteer@1.17.0</code>.</li>\n<li>Proper support for parsing <code>ignoreDefaultArgs</code> query-parameters.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.23.1...v1.24.0\">1.24.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bugfix on our debugger's play button being off-center.</li>\n<li>Fixes driver.close() calls not cleaning the browser.</li>\n<li>New <code>/GET</code> option for most our APIs. Stringify your JSON and add a ?body=YOUR-JSON with a /GET call to most of our functions! Requires <code>ENABLE_API_GET=true</code> in you docker env variables.</li>\n<li>WebSocket (Socket) exception handling and logging.</li>\n<li>More integration and unit tests added.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.23.0...v1.23.1\">1.23.1</a></h1>\n<ul>\n<li>Fixes an issue in chromedriver where commands would hang.</li>\n<li>Fixes an issue in chromedriver sessions not being removed properly.</li>\n<li>Fixes and pins the base image so that headful sessions work again.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.22.0...v1.23.0\">1.23.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Use <code>apt-get</code> to install <code>dumb-init</code>.</li>\n<li>Add a LANG arg in docker.</li>\n<li>New <code>setJavaScriptEnabled</code> property for REST APIs.</li>\n<li>Fixes an issue with <code>waitFor</code> functions in REST API calls.</li>\n<li>Fixes issues when PREBOOT_CHROME and KEEPALIVE are true.</li>\n<li>Updates protocol and host information in ad-blocking.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.21.0...v1.22.0\">1.22.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Removal of unnecessary '--disable-dev-shm-usage'</li>\n<li>Squelching of chromedriver's verbose args unless <code>DEBUG=*</code> is set.</li>\n<li>New <code>/kill/${id}</code> route for remotely killing a certain browser.</li>\n<li>Allowing of sub-child routes in workspaces.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.20.0...v1.21.0\">1.21.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>viewport</code> property option for PDF endpoint.</li>\n<li>The <code>/stats</code> endpoint now runs in a separate process meaning it can be parallelized.</li>\n<li>Fixed a bug where hardware monitoring can cause the container to restart/crash.</li>\n<li>Fixes an issue with the file-chooser API not working in puppeteer.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.19.0...v1.20.0\">1.20.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>/scrape</code> API!</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.18.0...v1.19.0\">1.19.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fixes chrome-stable's binary chromedriver.</li>\n<li>Move over to Node 12.</li>\n<li>Bugfix on width/height in the screencast API.</li>\n<li>Support for <a href=\"mailto:puppeteer@2.0.0\">puppeteer@2.0.0</a>.</li>\n<li>Fixed issues with the devtools JS files missing.</li>\n<li>Adds support for blacklisting routes in Docker.</li>\n<li>Consolidates hooks into a hooks module.</li>\n<li>Allows Selenium to specify download-paths and pausing via preferences.</li>\n<li>Fixes an issue in certain JSON-based CDP libraries.</li>\n<li>Function API's can now run incognito mode with a new Docker param.</li>\n<li></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.17.0...v1.18.0\">1.18.0</a></h1>\n<ul>\n<li>Dependency updates</li>\n<li>Better <code>IS_DOCKER</code> check for kubernetes.</li>\n<li>Updates to README.md, spelling fixes and Slack link.</li>\n<li>Fixes to debugger and larger code bodies.</li>\n<li>Removal of analytics in debugger.</li>\n<li>Screencast improvements and adding ability to set new options.</li>\n<li>New <code>waitFor</code> property in our APIs (content, pdf and screenshot).</li>\n<li>Don't allow file requests on the debugger for security reasons.</li>\n<li>Better metrics monitoring.</li>\n<li><code>singleRun</code> mode in docker.</li>\n<li>New prometheus support!</li>\n<li>Fixing issues with keeping chrome alive (only closing once TTL is met).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.16.0...v1.17.0\">1.17.0</a></h1>\n<ul>\n<li>Dependency updates</li>\n<li>Splitting docker images into two repositories for faster builds and pulls</li>\n<li>Adding in external routing capabilities</li>\n<li>New error hook</li>\n<li>More/better types</li>\n<li>Updating <code>deviceScaleFactor</code> in API's for more granular control.</li>\n<li>Better chromedriver failure messages.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.15.0...v1.16.0\">1.16.0</a></h1>\n<ul>\n<li>Adding <code>ffmpeg</code> to the docker dependency list.</li>\n<li>Add <code>timecut</code> as a dependency for recording.</li>\n<li>Better logs on chrome PID's and closing forcefully.</li>\n<li>Fixed <code>DEFAULT_CHROME</code> => <code>DEFAULT_HEADLESS</code>.</li>\n<li>Fixed a bug where <code>xvfb</code> doesn't start in time.</li>\n<li>Use <code>SIGKILL</code> for killing chromedriver.</li>\n<li><code>/json/version</code> now returns a <code>webSocketDebuggerUrl</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.14.1...v1.15.0\">1.15.0</a></h1>\n<ul>\n<li>New <code>page</code> and <code>browser</code> hooks for docker images that <code>FROM</code> browserless.</li>\n<li><code>bluebird</code> added as a module for <code>function</code> and other endpoints.</li>\n<li>More dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.14.0...v1.14.1\">1.14.1</a></h1>\n<ul>\n<li>Bugfix when running multiple "headfull" sessions.</li>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.13.0...v1.14.0\">1.14.0</a></h1>\n<ul>\n<li>New <code>WORKSPACE_DELETE_EXPIRED</code> and <code>WORKSPACE_EXPIRE_DAYS</code> to auto-cleanup workspace dirs.</li>\n<li>README.md cleanup now that HTTPS is no longer required.</li>\n<li>Support for <code>~</code> in docker env parameters.</li>\n<li>More alignment with how chromedriver and puppeteer sessions get cleaned up.</li>\n<li><code>/session</code> API now returns <code>browserWSEndpoint</code> and <code>browserId</code> properties for having multiple debuggers connected.</li>\n<li>Support for reconnecting(!!). When a <code>?keepalive=KEEP-ALIVE-IN-MS</code> is seen in the <code>puppeteer.connect</code> call we keep the browser active for that many ms after the debugger disconnects.</li>\n<li>New <code>/kill/all</code> route which closes <em>all</em> actively running sessions.</li>\n<li>New internal scheduler module, making future things like cron-based jobs a possibility.</li>\n<li>Better internal types.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.12.0...v1.13.0\">1.13.0</a></h1>\n<ul>\n<li>A minor refactor to consolidate calls to <code>url.parse</code> for performance gains.</li>\n<li>Introduces a per-session based timeout that overrides the global timeout.</li>\n<li>Consolidates authorization checks to remove duplication.</li>\n<li>Moves more types into their backing modules in order to better consolidate files.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.11.0...v1.12.0\">1.12.0</a></h1>\n<ul>\n<li>Set's a non-conflicting <code>WORKSPACE_DIR</code> and <code>DEFAULT_USER_DATA_DIR</code> in docker by default.</li>\n<li>Drops support for puppeteer <code>1.15.0</code> and adds <code>1.19.0</code>.</li>\n<li>Web-based debugger now sends cookies for docker deployments that are secure.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.10.0...v1.11.0\">1.11.0</a></h1>\n<ul>\n<li>Live debugger is now self-hosted, no more enforced https though it's still recommended.</li>\n<li>Consolidated build steps.</li>\n<li>Using the same chromedriver binary that matches the puppeteer's bundled chromium.</li>\n<li>Introducing <code>trackingId</code> workflows.</li>\n<li>Fixing unused export's, removing extraneous internal methods.</li>\n<li><code>/workspace</code> API now returns sub-files and scopes sessions by <code>trackingId</code> when present.</li>\n<li>Support for <code>/json/new</code> protocol.</li>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.9.0...v1.10.0\">1.10.0</a></h1>\n<ul>\n<li>Dropped support for puppeteer <code>1.9.0 => 1.14.0</code>.</li>\n<li>Added support for puppeteer <code>1.16.0 => 1.18.0</code>.</li>\n<li>A version of chromedriver is now installed to perfectly match the version of puppeteer's chromium.</li>\n<li>In dev, chromedriver now uses the puppeteer version of chromium.</li>\n<li>Defaulted most ENV-variables in docker to sensible defaults.</li>\n<li>New <code>rotate</code> feature for PDF endpoint: <code>{ rotate: 90 }</code> => rotate left 90 degrees.</li>\n<li>Support for <code>browserless.token</code> in the docker image.</li>\n<li>puppeteer integration now returns semantic HTTP codes for certain errors (<code>400</code>, <code>403</code> and <code>429</code>).</li>\n<li>Support for chromedriver's move to the W3C spec 'goog:chromeOptions'.</li>\n<li>The debugger now filters out <code>about:blank</code> pages, and includes sessions by Selenium.</li>\n<li>Workspace support for selenium-based integrations.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.8.0...v1.9.0\">1.9.0</a></h1>\n<ul>\n<li>Better handling of browser/socket closing in puppeteer integrations.</li>\n<li>Numerous screencast fixes.</li>\n<li>Moved all GH links to new repo location.</li>\n<li>Dep updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.7.0...v1.8.0\">1.8.0</a></h1>\n<ul>\n<li>Better windows dev experience.</li>\n<li>Indian font support.</li>\n<li>Video capture now supports audio and browser width/height.</li>\n<li>Dependency updates.</li>\n<li>DEFAULT env variables for launching pre-booted Chrome.</li>\n</ul>\n<h1>1.7.0</h1>\n<ul>\n<li>Dep updates</li>\n<li>New <code>?blockAds</code> query-parameter for disabling 3rd-party ad calls.</li>\n</ul>\n<h1>1.6.0</h1>\n<ul>\n<li>New <code>authenticate</code> and <code>setExtraHTTPHeaders</code> params for the <code>content</code>, <code>pdf</code>, and <code>screenshot</code> APIs. Useful for using proxies in our REST APIs.</li>\n<li>Fixed a bunch of bugs inside of the webdriver integration, making it more REST-ful.</li>\n<li>Updated dependencies inside of Chromedriver.</li>\n<li>New <code>DISABLE_AUTO_SET_DOWNLOAD_BEHAVIOR</code> for mitigating errors in puppeteer < 1.15.0.</li>\n<li>Bumped Puppeteer to 1.15.0.</li>\n</ul>\n<h1>1.5.0</h1>\n<ul>\n<li>New <code>/session</code> API (and accompanying routes) for display/viewing active sesions in a remote debugger(!).</li>\n<li>New <code>?pause</code> query-param for pausing sessions prior to running them (useful for the live debug viewer).</li>\n<li>The browserless debugger now exposes links to these debug pages via the sidebar.</li>\n<li>New Debugger page can be disabled via the <code>ENABLE_DEBUG_VIEWER=false</code> environment variable flag.</li>\n<li>Move to use <code>node@10</code>.</li>\n<li>No more <code>no-implicit-any</code>'s inside the codebase.</li>\n</ul>\n<h1>1.4.0</h1>\n<ul>\n<li>During connection, we now set the download dir of REST and puppeteer sessions. Cloud users and docker users no longer have to manually set this field, and the <code>/workspace</code> API references it as well!</li>\n</ul>\n<h1>1.3.1</h1>\n<h1>Fixes</h1>\n<ul>\n<li>New deploy.js file to do deployments "on-prem"</li>\n<li>Updated new builds for puppeteer 1.12.2 and 1.13.0</li>\n<li>Fixes an issues in CORS handling</li>\n</ul>\n<h1>1.3.0</h1>\n<h1>Minor changes</h1>\n<ul>\n<li>The <code>screenshot</code>, <code>function</code>, <code>pdf</code>, and <code>content</code> API's now accept new content-types for easier POSTing of small payloads (see docsite).</li>\n<li>The <code>screencast</code> API can now start/stop recording programmatically via a <code>startScreencast</code> and <code>stopScreencast</code> params (see docsite).</li>\n<li>New <code>external</code> dir for injecting custom <code>before</code> and <code>after</code> hooks in external docker builds.</li>\n<li>A new <code>timeout</code> query-option for session-based timeouts vs using the global one.</li>\n<li>New <code>requestInterceptors</code> for injection custom request behavior.</li>\n</ul>\n<h1>Fixes</h1>\n<ul>\n<li>Numerous default fixes in the APIs.</li>\n<li>Stray consoles removed :)</li>\n<li>Consolidated download behavior in <code>screencast</code> and <code>download</code> APIs</li>\n</ul>\n<h1>1.2.0</h1>\n<h1>Minor Changes</h1>\n<ul>\n<li>New <code>requestInterceptors</code> for the /screenshot API, <a href=\"https://github.com/browserless/chrome/pull/119\">allowing you to mock data in response to a request</a>.</li>\n<li>Code debugger now transmits code over-the-wire via cookies to avoid URL max-length issues.</li>\n<li>Now supports cookie-based authentication via a <code>browserless_token=TOKEN;</code> cookie.</li>\n</ul>\n<h1>Fixes</h1>\n<ul>\n<li><a href=\"https://github.com/browserless/chrome/issues/118\">Comments in the debugger won't break it.</a></li>\n<li>Requests that are rejected due to auth reasons aren't logged in stats.</li>\n</ul>\n<h1>1.1.0</h1>\n<p>With 1.1.0 we offer a refined way of dealing with both downloads and uploads. Both use-cases are tightly coupled to the file-system, and can leave you scratching your head as to what's going one. For more information and detailed documentation, please refer to our doc-site at <a href=\"https://www.browserless.io/\">https://www.browserless.io/</a></p>\n<h2>Minor Changes</h2>\n<ul>\n<li>New <code>WORKSPACE_DIR</code> variable for controlling where browserless stores files and uploads.</li>\n<li>New <code>/workspace</code> API for doing RESTful operations on the downloads/uploads file-system.</li>\n<li>New <code>/download</code> API for running a puppeteer-script, and responding with the resulting downloaded file.</li>\n</ul>\n<h2>Internal Changes</h2>\n<ul>\n<li>Moved routes out of the browserless module and into their own file/module.</li>\n<li>Renamed the <code>browserless-web-service</code> module to just <code>browserless</code> for simplicity.</li>\n<li>Moved the <code>DOWNLOAD_DIR</code> to <code>WORKSPACE_DIR</code> since it handles both uploads and downloads.</li>\n</ul>\n<h1>1.0.0</h1>\n<p>🥁 -- Stable version 1.0 is here! While this doesn't include major functionality changes, it <em>does</em> change how the docker builds are generated going forward. The versioning will now contain two pieces of crucial information: the version of the <em>browserless</em> service + the version of Chrome under-the-hood. For instance <code>1.2.3-puppeteer-1.10.0</code> is browserless at <code>1.2.3</code>, exposing puppeteer at <code>1.10.0</code>.</p>\n<p>Similar to how NodeJS itself does docker releases, we'll now provide releases in 3 distinct ways:</p>\n<ul>\n<li>An <em>immutable</em>, pinned version release: <code>1.0.0-puppeteer-1.11.0</code></li>\n<li>A mutable minor version release: <code>1.1-puppeteer-1.12.0</code></li>\n<li>A mutable major version release: <code>1-puppeteer-1.9.0</code></li>\n</ul>\n<p>For production deployments, we recommend using <em>pinned</em> version releases as they won't change once released. The mutable minor/major releases will receive on-going updates whenever we do changes that are bug-fixes or feature release. Even with the best intentions it's possible that instability can be introduced with these mutable images, hence why recommend the pinned version releases.</p>\n<p>Finally, we'll continue to ship support for the last 5 minor versions of Puppeteer + the Google Chrome (stable). Old images will remain, but newer versions of browserless won't be included.</p>\n<p>We'll continue to keep this changelog up-to-date anytime we do docker releases.</p>\n",
|
|
490
|
+
"title": "Browserless",
|
|
491
|
+
"version": "2.3.0-beta-1",
|
|
492
|
+
"x-logo": {
|
|
493
|
+
"altText": "browserless logo",
|
|
494
|
+
"url": "./docs/browserless-logo-inline.svg"
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
"openapi": "3.0.0",
|
|
498
|
+
"paths": {
|
|
499
|
+
"/chrome/content": {
|
|
500
|
+
"post": {
|
|
501
|
+
"definitions": {},
|
|
502
|
+
"description": "A JSON-based API. Given a \"url\" or \"html\" field, runs and returns HTML content after the page has loaded and JavaScript has parsed.",
|
|
503
|
+
"parameters": [
|
|
504
|
+
{
|
|
505
|
+
"in": "query",
|
|
506
|
+
"name": "blockAds",
|
|
507
|
+
"schema": {
|
|
508
|
+
"description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
|
|
509
|
+
"type": "boolean"
|
|
510
|
+
}
|
|
511
|
+
},
|
|
512
|
+
{
|
|
513
|
+
"in": "query",
|
|
514
|
+
"name": "launch",
|
|
515
|
+
"schema": {
|
|
516
|
+
"anyOf": [
|
|
517
|
+
{
|
|
518
|
+
"$ref": "#/definitions/CDPLaunchOptions"
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
"type": "string"
|
|
522
|
+
}
|
|
523
|
+
]
|
|
524
|
+
}
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"in": "query",
|
|
528
|
+
"name": "record",
|
|
529
|
+
"schema": {
|
|
530
|
+
"description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
|
|
531
|
+
"type": "boolean"
|
|
532
|
+
}
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"in": "query",
|
|
536
|
+
"name": "timeout",
|
|
537
|
+
"schema": {
|
|
538
|
+
"description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
|
|
539
|
+
"type": "number"
|
|
540
|
+
}
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"in": "query",
|
|
544
|
+
"name": "token",
|
|
545
|
+
"schema": {
|
|
546
|
+
"description": "The authorization token",
|
|
547
|
+
"type": "string"
|
|
548
|
+
}
|
|
978
549
|
}
|
|
979
|
-
|
|
980
|
-
"
|
|
981
|
-
"
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
550
|
+
],
|
|
551
|
+
"requestBody": {
|
|
552
|
+
"content": {
|
|
553
|
+
"application/json": {
|
|
554
|
+
"schema": {
|
|
555
|
+
"properties": {
|
|
556
|
+
"addScriptTag": {
|
|
557
|
+
"type": "array",
|
|
558
|
+
"items": {
|
|
559
|
+
"$ref": "#/definitions/FrameAddScriptTagOptions"
|
|
560
|
+
}
|
|
561
|
+
},
|
|
562
|
+
"addStyleTag": {
|
|
563
|
+
"type": "array",
|
|
564
|
+
"items": {
|
|
565
|
+
"$ref": "#/definitions/FrameAddStyleTagOptions"
|
|
566
|
+
}
|
|
567
|
+
},
|
|
568
|
+
"authenticate": {
|
|
569
|
+
"$ref": "#/definitions/Credentials"
|
|
570
|
+
},
|
|
571
|
+
"bestAttempt": {
|
|
572
|
+
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
573
|
+
"type": "boolean"
|
|
574
|
+
},
|
|
575
|
+
"cookies": {
|
|
576
|
+
"type": "array",
|
|
577
|
+
"items": {
|
|
578
|
+
"$ref": "#/definitions/CookieParam"
|
|
579
|
+
}
|
|
580
|
+
},
|
|
581
|
+
"emulateMediaType": {
|
|
582
|
+
"type": "string"
|
|
583
|
+
},
|
|
584
|
+
"gotoOptions": {
|
|
585
|
+
"$ref": "#/definitions/GoToOptions"
|
|
586
|
+
},
|
|
587
|
+
"html": {
|
|
588
|
+
"type": "string"
|
|
589
|
+
},
|
|
590
|
+
"rejectRequestPattern": {
|
|
591
|
+
"type": "array",
|
|
592
|
+
"items": {
|
|
593
|
+
"type": "string"
|
|
594
|
+
}
|
|
595
|
+
},
|
|
596
|
+
"rejectResourceTypes": {
|
|
597
|
+
"type": "array",
|
|
598
|
+
"items": {
|
|
599
|
+
"enum": [
|
|
600
|
+
"cspviolationreport",
|
|
601
|
+
"document",
|
|
602
|
+
"eventsource",
|
|
603
|
+
"fetch",
|
|
604
|
+
"font",
|
|
605
|
+
"image",
|
|
606
|
+
"manifest",
|
|
607
|
+
"media",
|
|
608
|
+
"other",
|
|
609
|
+
"ping",
|
|
610
|
+
"prefetch",
|
|
611
|
+
"preflight",
|
|
612
|
+
"script",
|
|
613
|
+
"signedexchange",
|
|
614
|
+
"stylesheet",
|
|
615
|
+
"texttrack",
|
|
616
|
+
"websocket",
|
|
617
|
+
"xhr"
|
|
618
|
+
],
|
|
619
|
+
"type": "string"
|
|
620
|
+
}
|
|
621
|
+
},
|
|
622
|
+
"requestInterceptors": {
|
|
623
|
+
"type": "array",
|
|
624
|
+
"items": {
|
|
625
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
626
|
+
"type": "object",
|
|
627
|
+
"properties": {
|
|
628
|
+
"pattern": {
|
|
629
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
630
|
+
"type": "string"
|
|
631
|
+
},
|
|
632
|
+
"response": {
|
|
633
|
+
"$ref": "#/definitions/Partial<ResponseForRequest>"
|
|
634
|
+
}
|
|
635
|
+
},
|
|
636
|
+
"additionalProperties": false,
|
|
637
|
+
"required": [
|
|
638
|
+
"pattern",
|
|
639
|
+
"response"
|
|
640
|
+
]
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
"setExtraHTTPHeaders": {
|
|
644
|
+
"$ref": "#/definitions/Record<string,string>"
|
|
645
|
+
},
|
|
646
|
+
"setJavaScriptEnabled": {
|
|
647
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
648
|
+
"type": "boolean"
|
|
649
|
+
},
|
|
650
|
+
"url": {
|
|
651
|
+
"type": "string"
|
|
652
|
+
},
|
|
653
|
+
"userAgent": {
|
|
654
|
+
"type": "string"
|
|
655
|
+
},
|
|
656
|
+
"viewport": {
|
|
657
|
+
"$ref": "#/definitions/Viewport"
|
|
658
|
+
},
|
|
659
|
+
"waitForEvent": {
|
|
660
|
+
"type": "object",
|
|
661
|
+
"properties": {
|
|
662
|
+
"event": {
|
|
663
|
+
"type": "string"
|
|
664
|
+
},
|
|
665
|
+
"timeout": {
|
|
666
|
+
"type": "number"
|
|
667
|
+
}
|
|
668
|
+
},
|
|
669
|
+
"additionalProperties": false,
|
|
670
|
+
"required": [
|
|
671
|
+
"event"
|
|
672
|
+
]
|
|
673
|
+
},
|
|
674
|
+
"waitForFunction": {
|
|
675
|
+
"type": "object",
|
|
676
|
+
"properties": {
|
|
677
|
+
"fn": {
|
|
678
|
+
"description": "The function, or statement, to be evaluated in browser context",
|
|
679
|
+
"type": "string"
|
|
680
|
+
},
|
|
681
|
+
"polling": {
|
|
682
|
+
"description": "An interval at which the pageFunction is executed, defaults to raf.\nIf polling is a number, then it is treated as an interval in milliseconds\nat which the function would be executed. If polling is a string,\nthen it can be one of the following values: \"raf\" or \"mutation\"",
|
|
683
|
+
"type": [
|
|
684
|
+
"string",
|
|
685
|
+
"number"
|
|
686
|
+
]
|
|
687
|
+
},
|
|
688
|
+
"timeout": {
|
|
689
|
+
"description": "Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds).\nPass 0 to disable timeout.",
|
|
690
|
+
"type": "number"
|
|
691
|
+
}
|
|
692
|
+
},
|
|
693
|
+
"additionalProperties": false,
|
|
694
|
+
"required": [
|
|
695
|
+
"fn"
|
|
696
|
+
]
|
|
697
|
+
},
|
|
698
|
+
"waitForSelector": {
|
|
699
|
+
"type": "object",
|
|
700
|
+
"properties": {
|
|
701
|
+
"hidden": {
|
|
702
|
+
"type": "boolean"
|
|
703
|
+
},
|
|
704
|
+
"selector": {
|
|
705
|
+
"type": "string"
|
|
706
|
+
},
|
|
707
|
+
"timeout": {
|
|
708
|
+
"type": "number"
|
|
709
|
+
},
|
|
710
|
+
"visible": {
|
|
711
|
+
"type": "boolean"
|
|
712
|
+
}
|
|
713
|
+
},
|
|
714
|
+
"additionalProperties": false,
|
|
715
|
+
"required": [
|
|
716
|
+
"selector"
|
|
717
|
+
]
|
|
718
|
+
},
|
|
719
|
+
"waitForTimeout": {
|
|
720
|
+
"type": "number"
|
|
721
|
+
}
|
|
722
|
+
},
|
|
723
|
+
"type": "object"
|
|
724
|
+
}
|
|
1051
725
|
}
|
|
1052
|
-
|
|
1053
|
-
},
|
|
1054
|
-
"numbConnected": {
|
|
1055
|
-
"type": "number"
|
|
726
|
+
}
|
|
1056
727
|
},
|
|
1057
|
-
"
|
|
1058
|
-
"
|
|
1059
|
-
{
|
|
1060
|
-
"
|
|
1061
|
-
|
|
1062
|
-
|
|
728
|
+
"responses": {
|
|
729
|
+
"200": {
|
|
730
|
+
"content": {
|
|
731
|
+
"text/html": {
|
|
732
|
+
"schema": {
|
|
733
|
+
"description": "An HTML payload of the website or HTML after JavaScript\nparsing and execution.",
|
|
734
|
+
"type": "string",
|
|
735
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
736
|
+
}
|
|
1063
737
|
}
|
|
1064
738
|
},
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
739
|
+
"description": "An HTML payload of the website or HTML after JavaScript\nparsing and execution."
|
|
740
|
+
},
|
|
741
|
+
"400": {
|
|
742
|
+
"code": 400,
|
|
743
|
+
"description": "The request contains errors or didn't properly encode content.",
|
|
744
|
+
"message": "HTTP/1.1 400 Bad Request"
|
|
745
|
+
},
|
|
746
|
+
"401": {
|
|
747
|
+
"code": 401,
|
|
748
|
+
"description": "The request is missing, or contains bad, authorization credentials.",
|
|
749
|
+
"message": "HTTP/1.1 401 Unauthorized"
|
|
750
|
+
},
|
|
751
|
+
"404": {
|
|
752
|
+
"code": 404,
|
|
753
|
+
"description": "Resource couldn't be found.",
|
|
754
|
+
"message": "HTTP/1.1 404 Not Found"
|
|
755
|
+
},
|
|
756
|
+
"408": {
|
|
757
|
+
"code": 408,
|
|
758
|
+
"description": "The request took has taken too long to process.",
|
|
759
|
+
"message": "HTTP/1.1 408 Request Timeout"
|
|
760
|
+
},
|
|
761
|
+
"429": {
|
|
762
|
+
"code": 429,
|
|
763
|
+
"description": "Too many requests are currently being processed.",
|
|
764
|
+
"message": "HTTP/1.1 429 Too Many Requests"
|
|
765
|
+
},
|
|
766
|
+
"500": {
|
|
767
|
+
"code": 500,
|
|
768
|
+
"description": "An internal error occurred when handling the request.",
|
|
769
|
+
"message": "HTTP/1.1 500 Internal Server Error"
|
|
770
|
+
}
|
|
1075
771
|
},
|
|
1076
|
-
"
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
"additionalProperties": false,
|
|
1084
|
-
"required": [
|
|
1085
|
-
"browser",
|
|
1086
|
-
"browserId",
|
|
1087
|
-
"id",
|
|
1088
|
-
"initialConnectURL",
|
|
1089
|
-
"killURL",
|
|
1090
|
-
"launchOptions",
|
|
1091
|
-
"numbConnected",
|
|
1092
|
-
"routePath",
|
|
1093
|
-
"startedOn",
|
|
1094
|
-
"timeAliveMs",
|
|
1095
|
-
"userDataDir"
|
|
1096
|
-
]
|
|
1097
|
-
}
|
|
1098
|
-
},
|
|
1099
|
-
"info": {
|
|
1100
|
-
"description": "\n\n\n\n\n\n\n\n\n\n> [Looking for v1.x.x of browserless? You can find it here](https://github.com/browserless/chrome/tree/v1), although we recommend migrating to v2.\n\nBrowserless allows remote clients to connect and execute headless work, all inside of docker. It supports the standard, unforked Puppeteer and Playwright libraries, as well offering REST-based APIs for common actions like data collection, PDF generation and more.\n\nWe take care of common issues such as missing system-fonts, missing external libraries, and performance improvements, along with edge-cases like downloading files and managing sessions. For details, check out the documentation site built into the project which includes Open API docs.\n\nIf you've been struggling to deploy headless browsers without running into issues or bloated resource requirements, then Browserless was built for you. Run the browsers in [our cloud](https://browserless.io/) or your own, [free for non-commercial uses](https://github.com/browserless/browserless#licensing).\n# Table of Contents\n\n1. [Features](#features)\n2. [How it works](#how-it-works)\n3. [Docker](#docker)\n4. [Hosting](#hosting-providers)\n5. [Puppeteer](#puppeteer)\n6. [Playwright](#playwright)\n7. [Extending with NodeJS SDK](#extending-nodejs-skd)\n8. [Licensing](#licensing)\n9. [Changelog](https://github.com/browserless/chrome/blob/master/CHANGELOG.md)\n\n## External links\n\n1. [Full documentation site](https://www.browserless.io/docs/start)\n2. [Live Debugger (using browserless.io)](https://chrome.browserless.io/)\n3. [Docker](https://github.com/browserless/browserless/pkgs/container/base)\n4. [Slack](https://join.slack.com/t/browserless/shared_invite/enQtMzA3OTMwNjA3MzY1LTRmMWU5NjQ0MTQ2YTE2YmU3MzdjNmVlMmU4MThjM2UxODNmNzNlZjVkY2U2NjdkMzYyNTgyZTBiMmE3Nzg0MzY)\n\n# Features\n\n- Parallelism and request-queueing are built-in + configurable.\n- Fonts and emoji's working out-of-the-box.\n- Debug Viewer for actively viewing/debugging running sessions.\n- An interactive puppeteer debugger, so you can see what the headless browser is doing and use its DevTools.\n- Works with unforked Puppeteer and Playwright.\n- Configurable session timers and health-checks to keep things running smoothly.\n- Error tolerant: if Chrome dies it won't.\n- [Support for running and development on Apple's M1 machines](#building-for-arm64-apple-m1-machines)\n\n# How it works\n\nBrowserless listens for both incoming websocket requests, generally issued by most libraries, as well as pre-build REST APIs to do common functions (PDF generation, images and so on). When a websocket connects to Browserless it starts Chrome and proxies your request into it. Once the session is done then it closes and awaits for more connections. Some libraries use Chrome's HTTP endpoints, like `/json` to inspect debug-able targets, which Browserless also supports.\n\nYou still execute the script itself which gives you total control over what library you want to choose and when to do upgrades. This also comes with the benefit of keep your code proprietary and able to run on numerous platforms. We simply take care of all the browser-aspects and offer a management layer on top of the browser.\n\n# Docker\n\n> See more options on our [full documentation site](https://www.browserless.io/docs/docker-quickstart).\n\n1. `docker run -p 3000:3000 ghcr.io/browserless/chrome`\n2. Visit `http://localhost:3000/docs` to see the documentation site.\n3. See more at our [docker package](https://github.com/browserless/browserless/pkgs/container/base).\n\n# Hosting Providers\n\nWe offer a first-class hosted product located [here](https://browserless.io). Alternatively you can host this image on just about any major platform that offers hosting for docker. Our hosted service takes care of all the machine provisioning, notifications, dashboards and monitoring plus more:\n\n- Easily upgrade and toggle between versions at the press of a button. No managing repositories and other code artifacts.\n- Never need to update or pull anything from docker. There's literally zero software to install to get started.\n- Scale your consumption up or down with different plans. We support up to thousands of concurrent sessions at a given time.\n\nIf you're interested in using this image for commercial aspects, then please read the below section on licensing.\n\n# Puppeteer\n\nPuppeteer allows you to specify a remote location for chrome via the `browserWSEndpoint` option. Setting this for Browserless is a single line of code change.\n\n**Before**\n```js\nconst browser = await puppeteer.launch();\n```\n\n**After**\n```js\nconst browser = await puppeteer.connect({ browserWSEndpoint: 'ws://localhost:3000' });\n```\n\n# Playwright\n\nWe support running with playwright via their remote connection method on the `chromium` interface. Since playwright is very similar to puppeteer, even launch arguments and other things \"just work\":\n\n**Before**\n```js\nconst browser = await pw.chromium.launch();\n```\n\n**After**\n```js\nconst browser = await pw.chromium.connect('ws://localhost:3000/playwright/chromium');\n\n// OR\nconst browser = await pw.chromium.connectOverCDP('ws://localhost:3000');\n```\n\nAfter that, the rest of your code remains the same with no other changes required.\n\n# Extending (NodeJS SKD)\n\nBrowserless comes with built-in extension capabilities, and allows for extending nearly any aspect of the system (for Version 2+). For more details on how to write your own routes, build docker images, and more, [see our SDK README.md](/bin/scaffold/README.md) or simply run \"npx @browserless.io/browserless create\" in a terminal and follow the onscreen prompts.\n\n# Usage with other libraries\n\nMost libraries allow you to specify a remote instance of Chrome to interact with. They are either looking for a websocket endpoint, a host and port, or some address. Browserless supports these by default, however if you're having issues please make an issue in this project and we'll try and work with the library authors to get them integrated with browserless. Please note that in V2 we no longer support selenium or webdriver integrations.\n\nYou can find a much larger list of supported libraries [on our documentation site](https://www.browserless.io/docs/puppeteer-library).\n\n# Motivations\n\nRunning Chrome on lambda or on your own is a fantastic idea but in practice is quite challenging in production. You're met with pretty tough cloud limits, possibly building Chrome yourself, and then dealing with odd invocation issues should everything else go ok. A lot of issues in various repositories are due to just challenges of getting Chrome running smoothly in AWS (see [here](https://github.com/GoogleChrome/puppeteer/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc)). You can see for yourself by going to nearly any library and sorting issues by most commented.\n\nGetting Chrome running well in docker is also a challenge as there's quiet a few packages you need in order to get Chrome running. Once that's done then there's still missing fonts, getting libraries to work with it, and having limitations on service reliability. This is also ignoring CVEs, access-controls, and scaling strategies.\n\nAll of these issues prompted us to build a first-class image and workflow for interacting with Chrome in a more streamlined way. With Browserless you never have to worry about fonts, extra packages, library support, security, or anything else. It just works reliably like any other modern web service. On top of that it comes with a prescribed approach on how you interact with Chrome, which is through socket connections (similar to a database or any other external appliance). What this means is that you get the ability to drive Chrome remotely without having to do updates/releases to the thing that runs Chrome since it's divorced from your application.\n\n# Licensing\n\nSPDX-License-Identifier: SSPL-1.0 OR Browserless Commercial License.\n\nIf you want to use Browserless to build commercial sites, applications, or in a continuous-integration system that's closed-source then you'll need to purchase a commercial license. This allows you to keep your software proprietary whilst still using browserless. [You can purchase a commercial license here](https://www.browserless.io/contact). A commercial license grants you:\n\n- Priority support on issues and features.\n- On-premise running as well as running on public cloud providers for commercial/CI purposes for proprietary systems.\n- Ability to modify the source (forking) for your own purposes.\n- A new admin user-interface.\n\nNot only does it grant you a license to run such a critical piece of infrastructure, but you are also supporting further innovation in this space and our ability to contribute to it.\n\nIf you are creating an open source application under a license compatible with the Server Side License 1.0, you may use Browserless under those terms.\n\n# Changelog\n<h1><a href=\"https://github.com/browserless/chrome/compare/v2.2.0...main\">Latest</a></h1>\n<ul>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v2.1.0...v2.2.0\">v2.2.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li><code>ghcr.io/browserless/chrome</code> now runs actual Chrome and not Chromium! If you were using this tag please update to use <code>ghcr.io/browserless/chromium</code>!<ul>\n<li>This Chrome tag uses the new routing convention below. If you get random 404's, please add <code>/chrome</code> to the start of the route. EG, <code>/pdf</code> becomes <code>/chrome/pdf</code>.</li>\n<li>Websocket connections follow a similar breakage in that the URL will go from something like <code>ws://localhost:3000</code> to <code>ws://localhost:3000/chrome</code>.</li>\n</ul>\n</li>\n<li>Adds a new <code>ghcr.io/browserless/chromium</code>, and updates <code>ghcr.io/browserless/chrome</code> to use actual Chrome.</li>\n<li>New and current APIs now follow a routing convention of <code>/$BROWSER/$ACTION</code>. In our Chrome image, you'll see <code>/chrome/pdf</code> for the PDF route as opposed to <code>/pdf</code>.<ul>\n<li>To keep things backwards compatible, all our prior REST APIs still have the same path as well as the new semantic, but only in the <code>multi</code> and <code>chromium</code> tags.</li>\n<li>These backwards compatible routes are ONLY available in <code>ghcr.io/browserless/chromium</code> and <code>ghcr.io/browserless/multi</code>.</li>\n</ul>\n</li>\n<li>Refer to the embedded documentation site for any and all updates on API differences.</li>\n</ul>\n<p><strong>Other Changes</strong></p>\n<ul>\n<li>HTTPRoutes and WebSocket routes can now have multiple paths to listen on.</li>\n<li>Add <code>clean</code> command to <code>@browserless.io/browserless</code> CLI.</li>\n<li>Adds support for <code>/json/list</code>, <code>/json/new</code>, <code>/json/version</code> and <code>json/protocol</code> APIs (Chrome and Chromium only).<ul>\n<li>When both Chrome and Chromium are present (in the case of the multi image), browserless opts for Chromium for these requests.</li>\n</ul>\n</li>\n<li>Removes legacy <code>browser.json</code> files since browserless now generates those and caches when requested.</li>\n<li>Stable docker images are coming! Please be sure to see our packages page for stable tags.</li>\n<li>Only verify that internally managed browsers are installed when starting.</li>\n<li>Preliminary support for <code>--headless=shell</code>.</li>\n<li>More unit-tests for the Chrome /json APIs.</li>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/browserless/compare/v2.0.0-beta-1...v2.1.0\">v2.1.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Name is now <code>@browserless.io/browserless</code> to reflect our npm package.</li>\n<li>NEW: SDK is now live here: <a href=\"https://www.npmjs.com/package/@browserless.io/browserless\">https://www.npmjs.com/package/@browserless.io/browserless</a>.</li>\n<li>Drops gulp and other gulp utilities in favor of our own. Move to modules in <code>scripts</code> dir.</li>\n<li>Many private class properties now use <code>protected</code> so they can be referenced in SDK extensions.</li>\n<li>Adds a <code>/json/version</code> route for older libraries that use it.</li>\n<li>Merge startup/test scripts into <code>scripts</code> dir.</li>\n<li>Moves installed browsers to <code>/usr/local/bin/playwright-browsers</code>.</li>\n<li>Merge root files into package.json where possible.</li>\n<li>README updates and fixes.</li>\n<li>Numerous link and copyright fixes.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/master...feat/browserless-2.0\">v2.0.0</a></h1>\n<p>browserless 2.0.0 represents the best body of work after running browserless for over 5 years. It contains mostly the same functionality and more, and is rebuilt to be more modular and offer a NodeJS SDK. It's also much lighter and faster than prior versions and includes a lot of semantic changes.</p>\n<h2>Features</h2>\n<ul>\n<li>ECMAScript style module loading and dependencies.</li>\n<li>New routing system using purely NodeJS's HTTP module.</li>\n<li>Better logs and concurrency/queueing parameters.</li>\n<li>Support for running the other major browser vendors in the same format and package.</li>\n<li>The service now compiles TypeScript to runtime JOI validation for our routes.</li>\n<li>Soon: upcoming support for extensions, long-running sessions and more.</li>\n</ul>\n<h2>Breaking Changes</h2>\n<ul>\n<li>Remove support for Selenium.</li>\n<li>The <code>/function</code> API now runs inside the context of the browser and not in Node.</li>\n<li>Drop support for keep-alive and pre-booting.</li>\n<li>Support for a single <code>launch</code> query-string parameter for launching a browser versus many individual parameters.</li>\n</ul>\n<h2>Minor Changes</h2>\n<ul>\n<li>Many docker parameters have been renamed, but are backwards compatible. See config.ts for details.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.60.2...v1.61.0\">v1.61.0</a></h1>\n<ul>\n<li><strong>FINAL of V1 for browserless/chrome. <a href=\"https://github.com/browserless/chrome/pull/3345\">See notes on V2 here</a></strong></li>\n<li>Dependency updates.</li>\n<li>Added <code>fonts-urw-base35</code>.</li>\n<li>Supports puppeteer <code>1.20</code>, <code>10.4.0</code>, <code>13.1.3</code>, <code>14.4.1</code>, <code>16.2.0</code>, <code>19.7.5</code> and <code>21.4.1</code>.</li>\n<li>Supports playwright <code>1.39</code>, <code>1.38</code>, <code>1.37</code>, <code>1.36</code>, <code>1.35</code>, <code>1.34</code>, and <code>1.33</code>.</li>\n<li>Fixes an issue where keep-alive chrome instances aren't properly tracked when <code>browser.close</code> is called.</li>\n<li>Fix improper handling of HTTP writing on bare sockets with 500 errors.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.60.1...v1.60.2\">v1.60.2</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fixes an issue where calls to GET /sessions sometimes return blank results.</li>\n<li>Drop puppeteer <code>21.3.1</code> in favor of <code>21.3.6</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.60.0...v1.60.1\">v1.60.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Drop the <code>partner</code> repo from builds as we no longer use it for installing <code>flash</code>.</li>\n<li>Bump to <code>Ubuntu</code> lunar.</li>\n<li>Bump to NodeJS 18.17.0</li>\n<li>Package.json <code>engines.node</code> now reflects what node version we run on the docker image.</li>\n<li>Drops support for playwright@<code>1.33</code> and default playwright to <code>1.38</code>.</li>\n<li>Drops support for puppeteer@<code>21.1.1</code> in favor of <code>21.3.1</code>.</li>\n<li>Replaces legacy <code>request</code> module with Node's native <code>fetch</code> for webhooks.</li>\n<li>Drops <code>node-fetch</code> across the board in favor of <code>fetch</code> native.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.59.0...v1.60.0\">v1.60.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New build arguments in our Dockerfile to apply different named base repo.</li>\n<li>New <code>CHROME_STABLE_VERSION</code> build arg for specifying a particular chrome stable version.</li>\n<li>Fixes in postinstall hooks for various platforms and chrome-stable.</li>\n<li>NEW: <code>waitFor</code> properties in our APIs now supports an object with selector + timeouts for more fine tuning.</li>\n<li>Bump puppeteer <code>20.x.x</code> to <code>21.1.1</code> (116.0.5845.96).</li>\n<li>Supports playwright versions <code>1.37</code>, <code>1.36</code>, <code>1.35</code>, <code>1.34</code>, and <code>1.33</code>.</li>\n<li>Fixes in deploy script to handle versions, platforms and architectures.</li>\n<li>Fixes an issue where headless defaults to <code>DEFAULT_STEALTH</code>.</li>\n<li>New <code>PREBOOT_QUANTITY</code> for overriding the amount of pre-booted instances of Chrome.</li>\n<li>Allow using a host's display by setting <code>DISPLAY</code> env variable.</li>\n<li>Link fixes in README.md.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.58.0...v1.59.0\">v1.59.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump to Ubuntu Kinetic release + updates to use relevant packages.</li>\n<li>In support of puppeteer 20+, updates to <code>env.js</code> for finding/symlinking Chrome.</li>\n<li>Supports playwright <code>1.33</code>, <code>1.32</code>, <code>1.31</code>, and <code>1.29.</code>. Drops support for earlier versions.</li>\n<li>Ad-blocking and other request-interception in browserless is graceful using the <code>isInterceptResolutionHandled</code> method.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.57.0...v1.58.0\">v1.58.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Documentation link fixes.</li>\n<li>Add new required lib <code>libu2f-udev</code>.</li>\n<li>Support for <a href=\"mailto:puppeteer@19.7.5\">puppeteer@19.7.5</a>.</li>\n<li>Supports playwright versions: <code>1.27</code>, <code>1.28</code>, <code>1.29</code>, <code>1.30</code> and <code>1.31</code>.</li>\n<li>Better internal TypeScript definitions.</li>\n<li>Print's a few extra log-lines at startup for links to various resources.</li>\n<li><code>/kill/all</code> now supports rebooting when PREBOOT is turned on.</li>\n<li>Fixes an issue with chromedriver boot-looping in modern versions.</li>\n<li>Adds support for <code>--headless=new</code>.</li>\n<li>Fixes an issue where user-data-dirs aren't deleted due to a crashed container.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.56.0...v1.57.0\">v1.57.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Add back in <code>puppeteer@13.1.3</code> for PDF/Screenshot performance.</li>\n<li>Replace <code>puppeteer@18.0.5</code> in favor of <code>puppeteer@19.2.2</code>.</li>\n<li>Better puppeteer install/binary path lookups.</li>\n<li>Support for the following playwright versions via the /playwright path:<ul>\n<li>1.23.3</li>\n<li>1.24.2</li>\n<li>1.25.2</li>\n<li>1.26.1</li>\n<li>1.27.1</li>\n</ul>\n</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.55.0...v1.56.0\">v1.56.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fixes various puppeteer issues with regards to revision information and browser-fetching.</li>\n<li>Fixes a Selenium issue where failed browsers can cause session to zombie.</li>\n<li>Small fix for route error handling.</li>\n<li>Better selenium W3C support.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.55.0...v1.54.1\">v1.55.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>Update base OS from Ubuntu 20.04 to Ubuntu 22.04.</li>\n<li>Drops <code>path</code> support for both <code>addScriptTag</code> and <code>addStyleTag</code>. Use <code>url</code> or inject content directly.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency updates.</li>\n<li>We now support multiple versions of playwright via <code>playwright-core</code>. browserless checks the User-Agent string and tries to load a compatible playwright server at runtime in order to avoid breakages between versions.</li>\n<li>New <code>scrollPage</code> boolean parameter for the screenshot and other relevant APIs.</li>\n<li>browserless now writes appropriately formatted HTTP and WebSocket messages for non-2xx responses.</li>\n<li>Better CI coverage with prior puppeteer versions.</li>\n<li>Adds back a <code>browser.json</code> file in our docker images for easier CDP-related queries.</li>\n<li>A new <code>PORT</code> arg is available at build time in order to specify a PORT to listen onto.</li>\n<li>Updated links for browserless documentation in docs.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.54.1...v1.54.0\">v1.54.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Add <code>browser.json</code> file to git tags.</li>\n<li>Prettier fixes on source.</li>\n<li>deploy.js file fixes for creating production tags.</li>\n<li>Fix: add the <code>userDataDir</code> option so that we don't fill disks when using <code>stealth</code>.</li>\n<li>Fix: allow <code>disconnect</code> listeners to fire before closing.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.53.0...v1.54.0\">v1.54.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Move to using <code>mocha</code> for better esm support.</li>\n<li>Drop puppeteer <code>13.6.0</code> in favor of <code>14.4.1</code>.</li>\n<li>Utilize puppeteer <code>14.4.1</code> for <code>chrome-stable</code>.</li>\n<li>New internal <code>getCDPClient</code> for loading a page's CPD connection.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.52.1...v1.53.0\">v1.53.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump <code>browserless:base</code> to <code>1.16.0</code>.</li>\n<li>Drop <code>--quiet</code> from deploy scripts.</li>\n<li><code>arm64</code> support for latest as well as puppeteer at versions 9,10 and 13.</li>\n<li>Update puppeteer 13 from <code>13.5.2</code> to <code>13.6.0</code> (revision <code>982053</code>).</li>\n<li>README updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.52.0...v1.52.1\">v1.52.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Playwright example correction in README.md.</li>\n<li>Use revision <code>970485</code> for puppeteer 13.x.x, <code>latest</code>, chrome-stable and <code>arm64</code>.</li>\n<li>When using <code>KEEPALIVE</code> and <code>PREBOOT</code>, don't create new blank pages, and use the existing one instead.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.51.1...v1.52.0\">v1.52.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Added in new fonts: <code>fonts-gfs-neohellenic</code>.</li>\n<li>Minor code formatting changes.</li>\n<li>Drop <a href=\"mailto:puppeteer@13.1.3\">puppeteer@13.1.3</a> in favor of 13.5.2.</li>\n<li>Make <code>heapdump</code> an optional dependency as it's not always used, and add it back in.</li>\n<li>Utilize <code>fs/promise</code> vs home-rolled promisified utils.</li>\n<li>Fix an issue where PREBOOT and KEEPALIVE might return an <code>undefined</code> browser.</li>\n<li>Logging when file-protocol requests happen and terminate a session.</li>\n<li>Move the browser process exit listener into the puppeteer-provider for better session cleanup.</li>\n<li>Allow "headfull" playwright sessions.</li>\n<li>Don't <code>await</code> chrome-helper's closing of the browser as it's not truly async.</li>\n<li>Remove <code>body-parser</code> in favor of <code>express</code>'s JSON and other parsers.</li>\n<li>Fixes an issue where using a user-data-dir that doesn't exist causes chrome to crash.</li>\n<li>Add in more unit and integration tests.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.51.1...v1.52.0\">v1.52.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Added in new fonts: <code>fonts-gfs-neohellenic</code>.</li>\n<li>Minor code formatting changes.</li>\n<li>Drop <a href=\"mailto:puppeteer@13.1.3\">puppeteer@13.1.3</a> in favor of 13.5.2.</li>\n<li>Make <code>heapdump</code> an optional dependency as it's not always used, and add it back in.</li>\n<li>Utilize <code>fs/promise</code> vs home-rolled promisified utils.</li>\n<li>Fix an issue where PREBOOT and KEEPALIVE might return an <code>undefined</code> browser.</li>\n<li>Logging when file-protocol requests happen and terminate a session.</li>\n<li>Move the browser process exit listener into the puppeteer-provider for better session cleanup.</li>\n<li>Allow "headfull" playwright sessions.</li>\n<li>Don't <code>await</code> chrome-helper's closing of the browser as it's not truly async.</li>\n<li>Remove <code>body-parser</code> in favor of <code>express</code>'s JSON and other parsers.</li>\n<li>Fixes an issue where using a user-data-dir that doesn't exist causes chrome to crash.</li>\n<li>Add in more unit and integration tests.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.51.0...v1.51.1\">v1.51.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Updates the <code>vm2</code> module to <code>3.9.7</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.50.0...v1.51.0\">v1.51.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>viewport</code> option inside of the content API.</li>\n<li>New <code>encoding</code> option in the screenshot API.</li>\n<li>Drop <a href=\"mailto:puppeteer@12.x.x\">puppeteer@12.x.x</a> in favor of 13.x.x.</li>\n<li>Fixes in our deploy scripts.</li>\n<li>Fixes for windows binaries in our postinstall hook.</li>\n<li>Fixes an issue where playwright tries to use a pre-booted chrome instance.</li>\n<li>Small type updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.49.1...v1.50.0\">v1.50.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Drops support for <code>puppeteer-4.0.1</code> in favor of <code>puppeteer-12.0.1</code>.</li>\n<li>Chrome-stable now utilizes puppeteer @ <code>12.0.1</code>.</li>\n<li>Support for <code>arm64</code> via production tags (<code>1-arm64</code>) as well as in <code>latest</code>.</li>\n<li>Static JSON files (<code>protocol.json</code>, <code>version.json</code>) are built at runtime on their first request and then cached in memory.</li>\n<li>Bumps <code>browserless/base</code> to <code>1.14.0</code>.</li>\n<li>New <code>selector</code> property for screenshot-ing a single DOM node in the screenshot API.</li>\n<li><code>puppeteerVersions</code> in the package.json file has been rename do <code>chromeVersions</code>.</li>\n<li>Internal changes for deploying production tag scripts.</li>\n<li>Consolidate scripts for <code>postinstall</code>.</li>\n<li>Drop support for <code>heapdump</code> due to its age and lack of platform varieties.</li>\n<li>New <code>/metrics/total</code> route for summing up all statistics in a single JSON payload.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.49.0...v1.49.1\">v1.49.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fix webhook not using timeout URL.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.48.0...v1.49.0\">v1.49.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Support for ARM64 builds by dropping flash for it.</li>\n<li>Bump puppeteer 10.2.0 for 10.4.0.</li>\n<li>New puppeteer-hook for injecting a puppeteer-compatible library, eg. puppeteer-extra.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.47.0...v1.48.0\">v1.48.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>API calls with <code>html</code> in their payloads now use the <code>page.setContent</code> API versus a prior hack using one-time network-request interception (<a href=\"https://github.com/browserless/chrome/compare/v1.47.0...master#diff-67b699af1b24472604e21081d0509620d4ab3d986fcd4f8aa0b04d5ee5e4c63fL88\">example here</a>). Old versions of puppeteer might not work properly with this (<= 5.x.x). This effects the following APIS: <code>/content</code>, <code>/pdf</code> and <code>/screenshot</code>.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump <code>browserless/base</code> to <code>1.12.0</code> (add user-id to <code>blessuser</code> of <code>BLESS_USER_ID=999</code>).</li>\n<li>Bumps puppeteer @10.x.x to <code>10.2.0</code> with revision <code>901912</code>.</li>\n<li>Makes API calls use <code>setContent</code> properly now (no more one-time network interception). This fixes certain issues with images not loading in PDFs and screenshots.</li>\n<li>Fix some typings in tests.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.46.0...v1.47.0\">v1.47.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bump <code>browserless/base</code> to <code>1.11.0</code>.</li>\n<li>Add new lint task and rename GitHub actions tasks, remove <code>tslint</code>.</li>\n<li>Lint and prettier fixes.</li>\n<li>Delay url parsing until after <code>before</code> hook runs.</li>\n<li>New <code>meta</code> object param for page hooks (passing through arbitrary meta data set by prior hooks).</li>\n<li>New <code>FUNCTION_ENV_VARS</code> environment variable pass through an allow-list of environment variables for functions to access.</li>\n<li>Fix <code>someObject.hasOwnProperty</code> to <code>Object.prototype.hasOwnProperty.call</code>.</li>\n<li></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.45.0...v1.46.0\">v1.46.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Move to Node 16.x.x.</li>\n<li>Bump browserless/base to 1.10.0.</li>\n<li>Limit <code>x-response-url</code> to 100 characters.</li>\n<li>Add support for <a href=\"mailto:puppeteer@10.x.x\">puppeteer@10.x.x</a>.</li>\n<li>Add <code>maxConcurrent</code> stat for metrics API + log stats every 5 minutes to stdout.</li>\n<li>Some performance improvements to how pages/browsers are setup and torn down.</li>\n<li>Add <code>API_DOCS_ENDPOINT</code> as a filterable API to deny access to.</li>\n<li>Minor code reformatting from prettier.</li>\n<li>Better page setup and logging.</li>\n<li>Fixes <code>DEFAULT_STEALTH</code> for self-hosted deployments.</li>\n<li>Improvements on how chrome is closed.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.44.0...v1.45.0\">1.45.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Support for <a href=\"https://github.com/browserless/chrome/commit/0903795e936b93a511ec04f7ae35c03397682905\">playwright proxies</a>.</li>\n<li>Fixes an issue with larger headers potentially causing load-balancers to crash and fail.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.43.0...v1.44.0\">v1.44.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li><code>PROXY_HOST</code> and <code>PROXY_PORT</code> are now replaced with a single <code>PROXY_URL</code> param, eg: <code>https://www.mybrowserless.com/optional/paths</code>. When set, browserless uses this fully-qualified URL to build out links <em>back</em> to its internal debugger and sessions. Useful when you're instance is behind a proxy or load-balancer of some kind.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency Updates.</li>\n<li>Use recent Node 14 (browserless-base 1.7.0).</li>\n<li>New <code>rejectResourceTypes</code> property on most APIs (content, screenshot, pdf, etc.).</li>\n<li>Allow serving of <code>file://</code> protocols when explicitly enabled (default is off due to security concerns). Set <code>ALLOW_FILE_PROTOCOL=true</code> in your env params.</li>\n<li>The <code>/pressure</code> API now takes into account CPU/Memory consumption, and adds a "reason" property for why the machine might be not available.</li>\n<li>Fixes an issue where playwright couldn't download files.</li>\n<li>You can now filter /sessions calls with a <code>trackingId</code> parameter.</li>\n<li><code>detached</code> functions now return a <code>trackingId</code> when present.</li>\n<li>More types, tests, and utility consolidation.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.42.0...v1.43.0\">v1.43.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fixes an issue where --user-data-dirs aren't deleted properly, potentially filling disks.</li>\n<li>Changes CPU/Memory checks to be user-based and not the entire OS.</li>\n<li>Adds tests for the user-data-dir issue.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.41.0...v1.42.0\">v1.42.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Move to Node 14!</li>\n<li>Use <code>esModuleInterop</code> for imports.</li>\n<li>Remove <code>page.waitFor</code> in favor of downstream methods.</li>\n<li>Adds new <code>?stealth</code> parameter for API calls (see puppeteer-extra-stealth-plugin).</li>\n<li>New <code>DEFAULT_STEALTH</code> param for making stealth calls by default.</li>\n<li>Fixes <code>ignoreDefaultArgs</code> in chrome stable.</li>\n<li>Ensure temp user-data-dirs are always cleaned up.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.40.2...v1.41.0\">v1.41.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>New <code>SESSION_CHECK_FAIL_URL</code> webhook for when pre-session checks fail.</li>\n<li>Health checks now take the last two CPU/Memory samples to determine if a failure (5 minutes).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.40.1...v1.40.2\">v1.40.2</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fix potentially unhandled stream error events when closing chrome.</li>\n<li>Bump puppeteer to 5.4.1 for major 5.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.40.0...v1.40.1\">v1.40.1</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>New <code>SOCKET_CLOSE_METHOD</code> for better load-balancing behavior when under load.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.39.0...v1.40.0\">v1.40.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Support for playwright 1.4.0 and greater. <a href=\"https://github.com/microsoft/playwright/issues/4054\">See more here</a>.</li>\n<li>New <code>PRE_REQUEST_HEALTH_CHECK</code> env variable to check CPU/Memory prior to running a session. Set <code>MAX_CPU_PERCENT</code> or <code>MAX_MEMORY_PERCENT</code> for setting these thresholds. Responds with a <code>503</code> HTTP code if CPU/Memory are high on any inbound session (API, puppeteer or webdriver).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.38.0...v1.39.0\">v1.39.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes a crash due to <code>browser.close</code> streams not completing properly.</li>\n<li>Adds a <code>dumpio</code> query-string parameter for launching with puppeteer.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.37.2...v1.38.0\">v1.38.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes a memory leak when browsers don't close properly.</li>\n<li>Adds a <code>/heapdump</code> route for capturing heap dumps. Turn on by setting <code>ENABLE_HEAP_DUMP=true</code> in your docker env.</li>\n<li><code>emulateMedia</code> fixes on the pdf route.</li>\n<li>CodeQL implemented.</li>\n<li>README fixes.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.37.1...v1.37.2\">v1.37.2</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes an issue where the webserver can crash after rejecting a request.</li>\n<li>Fixes deployment script not waiting for zip files to be finished unzipped.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.37.0...v1.37.1\">1.37.1</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Fixes an issue in webdriver not starting properly.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.36.0...v1.37.0\">1.37.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>Due to stability issues, puppeteer version 3.x.x and 4.x.x now use chromium revision <code>782078</code>. See our <code>package.json</code> for details.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency Updates</li>\n<li>README Updates</li>\n<li>Fixes an issue for secured containers using prometheus (plus tests).</li>\n<li>Support for puppeteer <code>5.2.1</code></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.35.0...v1.36.0\">1.36.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>Drops support for puppeteer <code>2.0.0</code> and <code>3.0.4</code>, please use <code>2.1.1</code> and <code>3.3.0</code> for those revisions.</li>\n<li>Adds support for puppeteer <code>5.0.0</code>.</li>\n<li>Bug-fix with the server randomly closing with an uncaught error event thrown from inside underlying socket connection.</li>\n<li>Adds back in <code>--disable-dev-shm-usage</code> to default arguments for better SHM performance.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.34.0...v1.35.0\">1.35.0</a></h1>\n<ul>\n<li>Dependency Updates</li>\n<li>New <code>maxTime</code>, <code>minTime</code>, <code>meanTime</code> and <code>totalTime</code> of all sessions for a given period in /stats.</li>\n<li>Bugfix on CPU/Memory triggering health failure webhooks.</li>\n<li>Fix issues in websocket errors by awaiting browser.close (or 5 seconds, whichever is quickest).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.33.1...v1.34.0\">v1.34.0</a></h1>\n<p><strong>Potentially Breaking</strong></p>\n<ul>\n<li>screencast API no longer supports <code>audio</code> or the <code>setPreferences</code> function in order to offer a better video experience. In order to set the width/height, simply set a page width height to what you'd like.</li>\n<li><code>chrome-stable</code> will now use <code>puppeteer@3.1.0</code> for better compatibility.</li>\n</ul>\n<hr>\n<ul>\n<li>Dependency updates.</li>\n<li>Drops puppeteer version <code>1.20.0</code> and below.</li>\n<li>Move <code>browserless/base</code> to <code>v1.5.0</code>.</li>\n<li>Puppeteer support for <code>3.3.0</code> (3.2.x and 3.1.x have the same chromium revision).</li>\n<li>Fixes <code>trackingId</code> on pre-booted sessions.</li>\n<li><code>about:blank</code> pages now are returned in the <code>/sessions</code> API for transparency of open sessions/browsers.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.33.0...v1.33.1\">1.33.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fix socket errors from accidentally firing error webhooks.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.32.0...v1.33.0\">1.33.0</a></h1>\n<ul>\n<li>Drops support for puppeteer 1.17.x and 1.18.x</li>\n<li>Support for puppeteer 3.0.x</li>\n<li>Dependency updates</li>\n<li>Fix reject stat firing on debugger pages not being found</li>\n<li>Consolidates more types.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.31.1...v1.32.0\">1.32.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Adds roboto fonts.</li>\n<li>Updates <code>pressure</code> API to take account of running browsers in the <code>running</code> count.</li>\n<li>Adds <code>maxConcurrent</code>, <code>maxQueued</code>, <code>cpu</code> and <code>memory</code> to pressure.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.31.0...v1.31.1\">1.31.1</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fixes a small issue where XVFB doesn't start properly during an automated restart.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.30.0...v1.31.0\">1.31.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Allows <code>trackingId</code> on uploaded files to save in the appropriate tracking-ID folder.</li>\n<li>New <code>userAgent</code> param for setting user-agent in API requests.</li>\n<li>Fixes an issue where chrome wasn't being closed in rare cases.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.29.1...v1.30.0\">1.30.0</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Updates to Node 13 for speed and memory improvements.</li>\n<li>browserless/<a href=\"mailto:base@1.4.0\">base@1.4.0</a></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.29.0...v1.29.1\">1.29.1</a></h1>\n<ul>\n<li>Dependency Updates.</li>\n<li>Fixes how deploy script determines errors when running child commands.</li>\n<li>Fixes issues when many selenium sessions can potentially fill up disk space.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.28.0...v1.29.0\">1.29.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Uses <code>pipe</code>'s for most API calls and other internal endpoints for faster/better throughput. Works only for <code>headless</code> API/puppeteer calls.</li>\n<li>Allows custom lighthouse configs via POST <code>config</code> property.</li>\n<li>Patches vm2.</li>\n<li>Before hooks no longer end requests forcefully -- external hooks must manually end the request/sockets themselves.</li>\n<li>Properly passes socket errors to the error handler/webhook</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.27.0...v1.28.0\">1.28.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Sets a system-default font of Ubuntu for most sites that use <code>system-ui</code> in their font declarations.</li>\n<li>Fixes health-check failure webhooks.</li>\n<li>New <code>PROXY_HOST</code>, <code>PROXY_PORT</code> and <code>PROXY_SSL</code> for external load-balancers. <a href=\"https://www.browserless.io/docs/docker.html#using-a-proxy\">See docsite for more info</a>.</li>\n<li>Moves over to GH actions over Travis for CI.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.26.1...v1.27.0\">1.27.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>manipulate</code> params for screenshots, allowing for resizing, flipping and more.</li>\n<li>Better tracking of chrome-process for cleanup of zombied sessions.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.26.0...v1.26.1\">1.26.1</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Added <code>git</code> as a dependency in dockerfile for git-based npm dependencies to work.</li>\n<li>Fixed an issue in <code>start.sh</code> so that errors bubble up properly and close the process.</li>\n<li>Bumps <code>browserless/base</code> to <code>1.2.0</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.25.0...v1.26.0\">1.26.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Dropping pre-push hooks for speed.</li>\n<li>Consolidate all interfaces/types to a types.d.ts file.</li>\n<li>Fixes an issue where numerous chrome instances launch when prebooting.</li>\n<li>Fixes an issue where incoming requests don't use the pre-booted chrome instance.</li>\n<li>Uses <code>page.setViewport</code> when <code>--window-size</code> is set in params to help with screenshots not appearing properly (chromedriver only).</li>\n<li></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.24.0...v1.25.0\">1.25.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Stricter build-time arguments for chromium and chromedriver assets.</li>\n<li>Better XVFB functionality.</li>\n<li>New parameters for most API's, <code>addScriptTag</code> and <code>addStyleTag</code>, accepting an array of scripts/styles respectively.</li>\n<li>Drop support for <code>puppeteer@1.17.0</code>.</li>\n<li>Proper support for parsing <code>ignoreDefaultArgs</code> query-parameters.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.23.1...v1.24.0\">1.24.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Bugfix on our debugger's play button being off-center.</li>\n<li>Fixes driver.close() calls not cleaning the browser.</li>\n<li>New <code>/GET</code> option for most our APIs. Stringify your JSON and add a ?body=YOUR-JSON with a /GET call to most of our functions! Requires <code>ENABLE_API_GET=true</code> in you docker env variables.</li>\n<li>WebSocket (Socket) exception handling and logging.</li>\n<li>More integration and unit tests added.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.23.0...v1.23.1\">1.23.1</a></h1>\n<ul>\n<li>Fixes an issue in chromedriver where commands would hang.</li>\n<li>Fixes an issue in chromedriver sessions not being removed properly.</li>\n<li>Fixes and pins the base image so that headful sessions work again.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.22.0...v1.23.0\">1.23.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Use <code>apt-get</code> to install <code>dumb-init</code>.</li>\n<li>Add a LANG arg in docker.</li>\n<li>New <code>setJavaScriptEnabled</code> property for REST APIs.</li>\n<li>Fixes an issue with <code>waitFor</code> functions in REST API calls.</li>\n<li>Fixes issues when PREBOOT_CHROME and KEEPALIVE are true.</li>\n<li>Updates protocol and host information in ad-blocking.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.21.0...v1.22.0\">1.22.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Removal of unnecessary '--disable-dev-shm-usage'</li>\n<li>Squelching of chromedriver's verbose args unless <code>DEBUG=*</code> is set.</li>\n<li>New <code>/kill/${id}</code> route for remotely killing a certain browser.</li>\n<li>Allowing of sub-child routes in workspaces.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.20.0...v1.21.0\">1.21.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>viewport</code> property option for PDF endpoint.</li>\n<li>The <code>/stats</code> endpoint now runs in a separate process meaning it can be parallelized.</li>\n<li>Fixed a bug where hardware monitoring can cause the container to restart/crash.</li>\n<li>Fixes an issue with the file-chooser API not working in puppeteer.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.19.0...v1.20.0\">1.20.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>New <code>/scrape</code> API!</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.18.0...v1.19.0\">1.19.0</a></h1>\n<ul>\n<li>Dependency updates.</li>\n<li>Fixes chrome-stable's binary chromedriver.</li>\n<li>Move over to Node 12.</li>\n<li>Bugfix on width/height in the screencast API.</li>\n<li>Support for <a href=\"mailto:puppeteer@2.0.0\">puppeteer@2.0.0</a>.</li>\n<li>Fixed issues with the devtools JS files missing.</li>\n<li>Adds support for blacklisting routes in Docker.</li>\n<li>Consolidates hooks into a hooks module.</li>\n<li>Allows Selenium to specify download-paths and pausing via preferences.</li>\n<li>Fixes an issue in certain JSON-based CDP libraries.</li>\n<li>Function API's can now run incognito mode with a new Docker param.</li>\n<li></li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.17.0...v1.18.0\">1.18.0</a></h1>\n<ul>\n<li>Dependency updates</li>\n<li>Better <code>IS_DOCKER</code> check for kubernetes.</li>\n<li>Updates to README.md, spelling fixes and Slack link.</li>\n<li>Fixes to debugger and larger code bodies.</li>\n<li>Removal of analytics in debugger.</li>\n<li>Screencast improvements and adding ability to set new options.</li>\n<li>New <code>waitFor</code> property in our APIs (content, pdf and screenshot).</li>\n<li>Don't allow file requests on the debugger for security reasons.</li>\n<li>Better metrics monitoring.</li>\n<li><code>singleRun</code> mode in docker.</li>\n<li>New prometheus support!</li>\n<li>Fixing issues with keeping chrome alive (only closing once TTL is met).</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.16.0...v1.17.0\">1.17.0</a></h1>\n<ul>\n<li>Dependency updates</li>\n<li>Splitting docker images into two repositories for faster builds and pulls</li>\n<li>Adding in external routing capabilities</li>\n<li>New error hook</li>\n<li>More/better types</li>\n<li>Updating <code>deviceScaleFactor</code> in API's for more granular control.</li>\n<li>Better chromedriver failure messages.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.15.0...v1.16.0\">1.16.0</a></h1>\n<ul>\n<li>Adding <code>ffmpeg</code> to the docker dependency list.</li>\n<li>Add <code>timecut</code> as a dependency for recording.</li>\n<li>Better logs on chrome PID's and closing forcefully.</li>\n<li>Fixed <code>DEFAULT_CHROME</code> => <code>DEFAULT_HEADLESS</code>.</li>\n<li>Fixed a bug where <code>xvfb</code> doesn't start in time.</li>\n<li>Use <code>SIGKILL</code> for killing chromedriver.</li>\n<li><code>/json/version</code> now returns a <code>webSocketDebuggerUrl</code>.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.14.1...v1.15.0\">1.15.0</a></h1>\n<ul>\n<li>New <code>page</code> and <code>browser</code> hooks for docker images that <code>FROM</code> browserless.</li>\n<li><code>bluebird</code> added as a module for <code>function</code> and other endpoints.</li>\n<li>More dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.14.0...v1.14.1\">1.14.1</a></h1>\n<ul>\n<li>Bugfix when running multiple "headfull" sessions.</li>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.13.0...v1.14.0\">1.14.0</a></h1>\n<ul>\n<li>New <code>WORKSPACE_DELETE_EXPIRED</code> and <code>WORKSPACE_EXPIRE_DAYS</code> to auto-cleanup workspace dirs.</li>\n<li>README.md cleanup now that HTTPS is no longer required.</li>\n<li>Support for <code>~</code> in docker env parameters.</li>\n<li>More alignment with how chromedriver and puppeteer sessions get cleaned up.</li>\n<li><code>/session</code> API now returns <code>browserWSEndpoint</code> and <code>browserId</code> properties for having multiple debuggers connected.</li>\n<li>Support for reconnecting(!!). When a <code>?keepalive=KEEP-ALIVE-IN-MS</code> is seen in the <code>puppeteer.connect</code> call we keep the browser active for that many ms after the debugger disconnects.</li>\n<li>New <code>/kill/all</code> route which closes <em>all</em> actively running sessions.</li>\n<li>New internal scheduler module, making future things like cron-based jobs a possibility.</li>\n<li>Better internal types.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.12.0...v1.13.0\">1.13.0</a></h1>\n<ul>\n<li>A minor refactor to consolidate calls to <code>url.parse</code> for performance gains.</li>\n<li>Introduces a per-session based timeout that overrides the global timeout.</li>\n<li>Consolidates authorization checks to remove duplication.</li>\n<li>Moves more types into their backing modules in order to better consolidate files.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.11.0...v1.12.0\">1.12.0</a></h1>\n<ul>\n<li>Set's a non-conflicting <code>WORKSPACE_DIR</code> and <code>DEFAULT_USER_DATA_DIR</code> in docker by default.</li>\n<li>Drops support for puppeteer <code>1.15.0</code> and adds <code>1.19.0</code>.</li>\n<li>Web-based debugger now sends cookies for docker deployments that are secure.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.10.0...v1.11.0\">1.11.0</a></h1>\n<ul>\n<li>Live debugger is now self-hosted, no more enforced https though it's still recommended.</li>\n<li>Consolidated build steps.</li>\n<li>Using the same chromedriver binary that matches the puppeteer's bundled chromium.</li>\n<li>Introducing <code>trackingId</code> workflows.</li>\n<li>Fixing unused export's, removing extraneous internal methods.</li>\n<li><code>/workspace</code> API now returns sub-files and scopes sessions by <code>trackingId</code> when present.</li>\n<li>Support for <code>/json/new</code> protocol.</li>\n<li>Dependency updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.9.0...v1.10.0\">1.10.0</a></h1>\n<ul>\n<li>Dropped support for puppeteer <code>1.9.0 => 1.14.0</code>.</li>\n<li>Added support for puppeteer <code>1.16.0 => 1.18.0</code>.</li>\n<li>A version of chromedriver is now installed to perfectly match the version of puppeteer's chromium.</li>\n<li>In dev, chromedriver now uses the puppeteer version of chromium.</li>\n<li>Defaulted most ENV-variables in docker to sensible defaults.</li>\n<li>New <code>rotate</code> feature for PDF endpoint: <code>{ rotate: 90 }</code> => rotate left 90 degrees.</li>\n<li>Support for <code>browserless.token</code> in the docker image.</li>\n<li>puppeteer integration now returns semantic HTTP codes for certain errors (<code>400</code>, <code>403</code> and <code>429</code>).</li>\n<li>Support for chromedriver's move to the W3C spec 'goog:chromeOptions'.</li>\n<li>The debugger now filters out <code>about:blank</code> pages, and includes sessions by Selenium.</li>\n<li>Workspace support for selenium-based integrations.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.8.0...v1.9.0\">1.9.0</a></h1>\n<ul>\n<li>Better handling of browser/socket closing in puppeteer integrations.</li>\n<li>Numerous screencast fixes.</li>\n<li>Moved all GH links to new repo location.</li>\n<li>Dep updates.</li>\n</ul>\n<h1><a href=\"https://github.com/browserless/chrome/compare/v1.7.0...v1.8.0\">1.8.0</a></h1>\n<ul>\n<li>Better windows dev experience.</li>\n<li>Indian font support.</li>\n<li>Video capture now supports audio and browser width/height.</li>\n<li>Dependency updates.</li>\n<li>DEFAULT env variables for launching pre-booted Chrome.</li>\n</ul>\n<h1>1.7.0</h1>\n<ul>\n<li>Dep updates</li>\n<li>New <code>?blockAds</code> query-parameter for disabling 3rd-party ad calls.</li>\n</ul>\n<h1>1.6.0</h1>\n<ul>\n<li>New <code>authenticate</code> and <code>setExtraHTTPHeaders</code> params for the <code>content</code>, <code>pdf</code>, and <code>screenshot</code> APIs. Useful for using proxies in our REST APIs.</li>\n<li>Fixed a bunch of bugs inside of the webdriver integration, making it more REST-ful.</li>\n<li>Updated dependencies inside of Chromedriver.</li>\n<li>New <code>DISABLE_AUTO_SET_DOWNLOAD_BEHAVIOR</code> for mitigating errors in puppeteer < 1.15.0.</li>\n<li>Bumped Puppeteer to 1.15.0.</li>\n</ul>\n<h1>1.5.0</h1>\n<ul>\n<li>New <code>/session</code> API (and accompanying routes) for display/viewing active sesions in a remote debugger(!).</li>\n<li>New <code>?pause</code> query-param for pausing sessions prior to running them (useful for the live debug viewer).</li>\n<li>The browserless debugger now exposes links to these debug pages via the sidebar.</li>\n<li>New Debugger page can be disabled via the <code>ENABLE_DEBUG_VIEWER=false</code> environment variable flag.</li>\n<li>Move to use <code>node@10</code>.</li>\n<li>No more <code>no-implicit-any</code>'s inside the codebase.</li>\n</ul>\n<h1>1.4.0</h1>\n<ul>\n<li>During connection, we now set the download dir of REST and puppeteer sessions. Cloud users and docker users no longer have to manually set this field, and the <code>/workspace</code> API references it as well!</li>\n</ul>\n<h1>1.3.1</h1>\n<h1>Fixes</h1>\n<ul>\n<li>New deploy.js file to do deployments "on-prem"</li>\n<li>Updated new builds for puppeteer 1.12.2 and 1.13.0</li>\n<li>Fixes an issues in CORS handling</li>\n</ul>\n<h1>1.3.0</h1>\n<h1>Minor changes</h1>\n<ul>\n<li>The <code>screenshot</code>, <code>function</code>, <code>pdf</code>, and <code>content</code> API's now accept new content-types for easier POSTing of small payloads (see docsite).</li>\n<li>The <code>screencast</code> API can now start/stop recording programmatically via a <code>startScreencast</code> and <code>stopScreencast</code> params (see docsite).</li>\n<li>New <code>external</code> dir for injecting custom <code>before</code> and <code>after</code> hooks in external docker builds.</li>\n<li>A new <code>timeout</code> query-option for session-based timeouts vs using the global one.</li>\n<li>New <code>requestInterceptors</code> for injection custom request behavior.</li>\n</ul>\n<h1>Fixes</h1>\n<ul>\n<li>Numerous default fixes in the APIs.</li>\n<li>Stray consoles removed :)</li>\n<li>Consolidated download behavior in <code>screencast</code> and <code>download</code> APIs</li>\n</ul>\n<h1>1.2.0</h1>\n<h1>Minor Changes</h1>\n<ul>\n<li>New <code>requestInterceptors</code> for the /screenshot API, <a href=\"https://github.com/browserless/chrome/pull/119\">allowing you to mock data in response to a request</a>.</li>\n<li>Code debugger now transmits code over-the-wire via cookies to avoid URL max-length issues.</li>\n<li>Now supports cookie-based authentication via a <code>browserless_token=TOKEN;</code> cookie.</li>\n</ul>\n<h1>Fixes</h1>\n<ul>\n<li><a href=\"https://github.com/browserless/chrome/issues/118\">Comments in the debugger won't break it.</a></li>\n<li>Requests that are rejected due to auth reasons aren't logged in stats.</li>\n</ul>\n<h1>1.1.0</h1>\n<p>With 1.1.0 we offer a refined way of dealing with both downloads and uploads. Both use-cases are tightly coupled to the file-system, and can leave you scratching your head as to what's going one. For more information and detailed documentation, please refer to our doc-site at <a href=\"https://www.browserless.io/\">https://www.browserless.io/</a></p>\n<h2>Minor Changes</h2>\n<ul>\n<li>New <code>WORKSPACE_DIR</code> variable for controlling where browserless stores files and uploads.</li>\n<li>New <code>/workspace</code> API for doing RESTful operations on the downloads/uploads file-system.</li>\n<li>New <code>/download</code> API for running a puppeteer-script, and responding with the resulting downloaded file.</li>\n</ul>\n<h2>Internal Changes</h2>\n<ul>\n<li>Moved routes out of the browserless module and into their own file/module.</li>\n<li>Renamed the <code>browserless-web-service</code> module to just <code>browserless</code> for simplicity.</li>\n<li>Moved the <code>DOWNLOAD_DIR</code> to <code>WORKSPACE_DIR</code> since it handles both uploads and downloads.</li>\n</ul>\n<h1>1.0.0</h1>\n<p>🥁 -- Stable version 1.0 is here! While this doesn't include major functionality changes, it <em>does</em> change how the docker builds are generated going forward. The versioning will now contain two pieces of crucial information: the version of the <em>browserless</em> service + the version of Chrome under-the-hood. For instance <code>1.2.3-puppeteer-1.10.0</code> is browserless at <code>1.2.3</code>, exposing puppeteer at <code>1.10.0</code>.</p>\n<p>Similar to how NodeJS itself does docker releases, we'll now provide releases in 3 distinct ways:</p>\n<ul>\n<li>An <em>immutable</em>, pinned version release: <code>1.0.0-puppeteer-1.11.0</code></li>\n<li>A mutable minor version release: <code>1.1-puppeteer-1.12.0</code></li>\n<li>A mutable major version release: <code>1-puppeteer-1.9.0</code></li>\n</ul>\n<p>For production deployments, we recommend using <em>pinned</em> version releases as they won't change once released. The mutable minor/major releases will receive on-going updates whenever we do changes that are bug-fixes or feature release. Even with the best intentions it's possible that instability can be introduced with these mutable images, hence why recommend the pinned version releases.</p>\n<p>Finally, we'll continue to ship support for the last 5 minor versions of Puppeteer + the Google Chrome (stable). Old images will remain, but newer versions of browserless won't be included.</p>\n<p>We'll continue to keep this changelog up-to-date anytime we do docker releases.</p>\n",
|
|
1101
|
-
"title": "Browserless",
|
|
1102
|
-
"version": "2.2.0",
|
|
1103
|
-
"x-logo": {
|
|
1104
|
-
"altText": "browserless logo",
|
|
1105
|
-
"url": "./docs/browserless-logo-inline.svg"
|
|
1106
|
-
}
|
|
1107
|
-
},
|
|
1108
|
-
"openapi": "3.0.0",
|
|
1109
|
-
"paths": {
|
|
1110
|
-
"/chrome/content": {
|
|
772
|
+
"summary": "/chrome/content",
|
|
773
|
+
"tags": [
|
|
774
|
+
"Browser REST APIs"
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
},
|
|
778
|
+
"/chrome/download": {
|
|
1111
779
|
"post": {
|
|
1112
780
|
"definitions": {},
|
|
1113
|
-
"description": "A JSON-
|
|
781
|
+
"description": "A JSON or JavaScript content-type API for returning files Chrome has downloaded during\nthe execution of puppeteer code, which is ran inside context of the browser.\nBrowserless sets up a blank page, a fresh download directory, injects your puppeteer code, and then executes it.\nYou can load external libraries via the \"import\" syntax, and import ESM-style modules\nthat are written for execution inside of the browser. Once your script is finished, any\ndownloaded files from Chromium are returned back with the appropriate content-type header.",
|
|
1114
782
|
"parameters": [
|
|
1115
783
|
{
|
|
1116
784
|
"in": "query",
|
|
@@ -1339,15 +1007,15 @@
|
|
|
1339
1007
|
"responses": {
|
|
1340
1008
|
"200": {
|
|
1341
1009
|
"content": {
|
|
1342
|
-
"
|
|
1010
|
+
"*/*": {
|
|
1343
1011
|
"schema": {
|
|
1344
|
-
"description": "
|
|
1012
|
+
"description": "Responses are determined by the returned value of the downloads\nthemselves, so there isn't a static response type for this API.",
|
|
1345
1013
|
"type": "string",
|
|
1346
1014
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1347
1015
|
}
|
|
1348
1016
|
}
|
|
1349
1017
|
},
|
|
1350
|
-
"description": "
|
|
1018
|
+
"description": "Responses are determined by the returned value of the downloads\nthemselves, so there isn't a static response type for this API."
|
|
1351
1019
|
},
|
|
1352
1020
|
"400": {
|
|
1353
1021
|
"code": 400,
|
|
@@ -1380,16 +1048,16 @@
|
|
|
1380
1048
|
"message": "HTTP/1.1 500 Internal Server Error"
|
|
1381
1049
|
}
|
|
1382
1050
|
},
|
|
1383
|
-
"summary": "/chrome/
|
|
1051
|
+
"summary": "/chrome/download",
|
|
1384
1052
|
"tags": [
|
|
1385
1053
|
"Browser REST APIs"
|
|
1386
1054
|
]
|
|
1387
1055
|
}
|
|
1388
1056
|
},
|
|
1389
|
-
"/chrome/
|
|
1057
|
+
"/chrome/function": {
|
|
1390
1058
|
"post": {
|
|
1391
1059
|
"definitions": {},
|
|
1392
|
-
"description": "A JSON or JavaScript content-type API for
|
|
1060
|
+
"description": "A JSON or JavaScript content-type API for running puppeteer code in the browser's context.\nBrowserless sets up a blank page, injects your puppeteer code, and runs it.\nYou can optionally load external libraries via the \"import\" module that are meant for browser usage.\nValues returned from the function are checked and an appropriate content-type and response is sent back\nto your HTTP call.",
|
|
1393
1061
|
"parameters": [
|
|
1394
1062
|
{
|
|
1395
1063
|
"in": "query",
|
|
@@ -1403,7 +1071,6 @@
|
|
|
1403
1071
|
"in": "query",
|
|
1404
1072
|
"name": "launch",
|
|
1405
1073
|
"schema": {
|
|
1406
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
1407
1074
|
"anyOf": [
|
|
1408
1075
|
{
|
|
1409
1076
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -1443,128 +1110,175 @@
|
|
|
1443
1110
|
"content": {
|
|
1444
1111
|
"application/json": {
|
|
1445
1112
|
"schema": {
|
|
1446
|
-
"
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
"
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1113
|
+
"properties": {
|
|
1114
|
+
"addScriptTag": {
|
|
1115
|
+
"type": "array",
|
|
1116
|
+
"items": {
|
|
1117
|
+
"$ref": "#/definitions/FrameAddScriptTagOptions"
|
|
1118
|
+
}
|
|
1119
|
+
},
|
|
1120
|
+
"addStyleTag": {
|
|
1121
|
+
"type": "array",
|
|
1122
|
+
"items": {
|
|
1123
|
+
"$ref": "#/definitions/FrameAddStyleTagOptions"
|
|
1124
|
+
}
|
|
1125
|
+
},
|
|
1126
|
+
"authenticate": {
|
|
1127
|
+
"$ref": "#/definitions/Credentials"
|
|
1128
|
+
},
|
|
1129
|
+
"bestAttempt": {
|
|
1130
|
+
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
1131
|
+
"type": "boolean"
|
|
1132
|
+
},
|
|
1133
|
+
"cookies": {
|
|
1134
|
+
"type": "array",
|
|
1135
|
+
"items": {
|
|
1136
|
+
"$ref": "#/definitions/CookieParam"
|
|
1137
|
+
}
|
|
1138
|
+
},
|
|
1139
|
+
"emulateMediaType": {
|
|
1140
|
+
"type": "string"
|
|
1141
|
+
},
|
|
1142
|
+
"gotoOptions": {
|
|
1143
|
+
"$ref": "#/definitions/GoToOptions"
|
|
1144
|
+
},
|
|
1145
|
+
"html": {
|
|
1146
|
+
"type": "string"
|
|
1147
|
+
},
|
|
1148
|
+
"rejectRequestPattern": {
|
|
1149
|
+
"type": "array",
|
|
1150
|
+
"items": {
|
|
1151
|
+
"type": "string"
|
|
1152
|
+
}
|
|
1153
|
+
},
|
|
1154
|
+
"rejectResourceTypes": {
|
|
1155
|
+
"type": "array",
|
|
1156
|
+
"items": {
|
|
1157
|
+
"enum": [
|
|
1158
|
+
"cspviolationreport",
|
|
1159
|
+
"document",
|
|
1160
|
+
"eventsource",
|
|
1161
|
+
"fetch",
|
|
1162
|
+
"font",
|
|
1163
|
+
"image",
|
|
1164
|
+
"manifest",
|
|
1165
|
+
"media",
|
|
1166
|
+
"other",
|
|
1167
|
+
"ping",
|
|
1168
|
+
"prefetch",
|
|
1169
|
+
"preflight",
|
|
1170
|
+
"script",
|
|
1171
|
+
"signedexchange",
|
|
1172
|
+
"stylesheet",
|
|
1173
|
+
"texttrack",
|
|
1174
|
+
"websocket",
|
|
1175
|
+
"xhr"
|
|
1176
|
+
],
|
|
1177
|
+
"type": "string"
|
|
1178
|
+
}
|
|
1179
|
+
},
|
|
1180
|
+
"requestInterceptors": {
|
|
1181
|
+
"type": "array",
|
|
1182
|
+
"items": {
|
|
1183
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
1184
|
+
"type": "object",
|
|
1185
|
+
"properties": {
|
|
1186
|
+
"pattern": {
|
|
1187
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
1188
|
+
"type": "string"
|
|
1189
|
+
},
|
|
1190
|
+
"response": {
|
|
1191
|
+
"$ref": "#/definitions/Partial<ResponseForRequest>"
|
|
1192
|
+
}
|
|
1193
|
+
},
|
|
1194
|
+
"additionalProperties": false,
|
|
1195
|
+
"required": [
|
|
1196
|
+
"pattern",
|
|
1197
|
+
"response"
|
|
1198
|
+
]
|
|
1199
|
+
}
|
|
1200
|
+
},
|
|
1201
|
+
"setExtraHTTPHeaders": {
|
|
1202
|
+
"$ref": "#/definitions/Record<string,string>"
|
|
1203
|
+
},
|
|
1204
|
+
"setJavaScriptEnabled": {
|
|
1205
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
1206
|
+
"type": "boolean"
|
|
1207
|
+
},
|
|
1208
|
+
"url": {
|
|
1209
|
+
"type": "string"
|
|
1210
|
+
},
|
|
1211
|
+
"userAgent": {
|
|
1212
|
+
"type": "string"
|
|
1213
|
+
},
|
|
1214
|
+
"viewport": {
|
|
1215
|
+
"$ref": "#/definitions/Viewport"
|
|
1216
|
+
},
|
|
1217
|
+
"waitForEvent": {
|
|
1218
|
+
"type": "object",
|
|
1219
|
+
"properties": {
|
|
1220
|
+
"event": {
|
|
1221
|
+
"type": "string"
|
|
1222
|
+
},
|
|
1223
|
+
"timeout": {
|
|
1224
|
+
"type": "number"
|
|
1225
|
+
}
|
|
1226
|
+
},
|
|
1227
|
+
"additionalProperties": false,
|
|
1228
|
+
"required": [
|
|
1229
|
+
"event"
|
|
1230
|
+
]
|
|
1231
|
+
},
|
|
1232
|
+
"waitForFunction": {
|
|
1233
|
+
"type": "object",
|
|
1234
|
+
"properties": {
|
|
1235
|
+
"fn": {
|
|
1236
|
+
"description": "The function, or statement, to be evaluated in browser context",
|
|
1237
|
+
"type": "string"
|
|
1238
|
+
},
|
|
1239
|
+
"polling": {
|
|
1240
|
+
"description": "An interval at which the pageFunction is executed, defaults to raf.\nIf polling is a number, then it is treated as an interval in milliseconds\nat which the function would be executed. If polling is a string,\nthen it can be one of the following values: \"raf\" or \"mutation\"",
|
|
1241
|
+
"type": [
|
|
1242
|
+
"string",
|
|
1243
|
+
"number"
|
|
1244
|
+
]
|
|
1245
|
+
},
|
|
1246
|
+
"timeout": {
|
|
1247
|
+
"description": "Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds).\nPass 0 to disable timeout.",
|
|
1248
|
+
"type": "number"
|
|
1249
|
+
}
|
|
1250
|
+
},
|
|
1251
|
+
"additionalProperties": false,
|
|
1252
|
+
"required": [
|
|
1253
|
+
"fn"
|
|
1254
|
+
]
|
|
1255
|
+
},
|
|
1256
|
+
"waitForSelector": {
|
|
1257
|
+
"type": "object",
|
|
1258
|
+
"properties": {
|
|
1259
|
+
"hidden": {
|
|
1260
|
+
"type": "boolean"
|
|
1261
|
+
},
|
|
1262
|
+
"selector": {
|
|
1263
|
+
"type": "string"
|
|
1264
|
+
},
|
|
1265
|
+
"timeout": {
|
|
1266
|
+
"type": "number"
|
|
1267
|
+
},
|
|
1268
|
+
"visible": {
|
|
1269
|
+
"type": "boolean"
|
|
1270
|
+
}
|
|
1271
|
+
},
|
|
1272
|
+
"additionalProperties": false,
|
|
1273
|
+
"required": [
|
|
1274
|
+
"selector"
|
|
1275
|
+
]
|
|
1276
|
+
},
|
|
1277
|
+
"waitForTimeout": {
|
|
1278
|
+
"type": "number"
|
|
1279
|
+
}
|
|
1526
1280
|
},
|
|
1527
|
-
|
|
1528
|
-
"type": "string"
|
|
1529
|
-
}
|
|
1530
|
-
]
|
|
1531
|
-
}
|
|
1532
|
-
},
|
|
1533
|
-
{
|
|
1534
|
-
"in": "query",
|
|
1535
|
-
"name": "record",
|
|
1536
|
-
"schema": {
|
|
1537
|
-
"description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
|
|
1538
|
-
"type": "boolean"
|
|
1539
|
-
}
|
|
1540
|
-
},
|
|
1541
|
-
{
|
|
1542
|
-
"in": "query",
|
|
1543
|
-
"name": "timeout",
|
|
1544
|
-
"schema": {
|
|
1545
|
-
"description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
|
|
1546
|
-
"type": "number"
|
|
1547
|
-
}
|
|
1548
|
-
},
|
|
1549
|
-
{
|
|
1550
|
-
"in": "query",
|
|
1551
|
-
"name": "token",
|
|
1552
|
-
"schema": {
|
|
1553
|
-
"description": "The authorization token",
|
|
1554
|
-
"type": "string"
|
|
1555
|
-
}
|
|
1556
|
-
}
|
|
1557
|
-
],
|
|
1558
|
-
"requestBody": {
|
|
1559
|
-
"content": {
|
|
1560
|
-
"application/json": {
|
|
1561
|
-
"schema": {
|
|
1562
|
-
"$ref": "#/definitions/JSONSchema"
|
|
1563
|
-
}
|
|
1564
|
-
},
|
|
1565
|
-
"application/javascript": {
|
|
1566
|
-
"schema": {
|
|
1567
|
-
"type": "string"
|
|
1281
|
+
"type": "object"
|
|
1568
1282
|
}
|
|
1569
1283
|
}
|
|
1570
1284
|
}
|
|
@@ -1575,6 +1289,7 @@
|
|
|
1575
1289
|
"*/*": {
|
|
1576
1290
|
"schema": {
|
|
1577
1291
|
"description": "Responses are determined by the returned value of the function\nitself. Binary responses (PDF's, screenshots) are returned back\nas binary data, and primitive JavaScript values are returned back\nby type (HTML data is \"text/html\", Objects are \"application/json\")",
|
|
1292
|
+
"type": "string",
|
|
1578
1293
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1579
1294
|
}
|
|
1580
1295
|
}
|
|
@@ -1631,55 +1346,7 @@
|
|
|
1631
1346
|
"content": {
|
|
1632
1347
|
"application/json": {
|
|
1633
1348
|
"schema": {
|
|
1634
|
-
"type": "
|
|
1635
|
-
"items": {
|
|
1636
|
-
"$ref": "#/definitions/CDPJSONPayload"
|
|
1637
|
-
},
|
|
1638
|
-
"definitions": {
|
|
1639
|
-
"CDPJSONPayload": {
|
|
1640
|
-
"type": "object",
|
|
1641
|
-
"properties": {
|
|
1642
|
-
"description": {
|
|
1643
|
-
"description": "The description of the target. Generally the page's title.",
|
|
1644
|
-
"type": "string"
|
|
1645
|
-
},
|
|
1646
|
-
"devtoolsFrontendUrl": {
|
|
1647
|
-
"description": "The fully-qualified URL of the Devtools inspector app.",
|
|
1648
|
-
"type": "string"
|
|
1649
|
-
},
|
|
1650
|
-
"id": {
|
|
1651
|
-
"description": "A Unique Id for the underlying target.",
|
|
1652
|
-
"type": "string"
|
|
1653
|
-
},
|
|
1654
|
-
"title": {
|
|
1655
|
-
"description": "The title of the target. For pages this is the page's title.",
|
|
1656
|
-
"type": "string"
|
|
1657
|
-
},
|
|
1658
|
-
"type": {
|
|
1659
|
-
"description": "The type of target, generally \"page\" or \"background_page\".",
|
|
1660
|
-
"type": "string"
|
|
1661
|
-
},
|
|
1662
|
-
"url": {
|
|
1663
|
-
"description": "The current URL the target is consuming or visiting.",
|
|
1664
|
-
"type": "string"
|
|
1665
|
-
},
|
|
1666
|
-
"webSocketDebuggerUrl": {
|
|
1667
|
-
"description": "The target or page's WebSocket Debugger URL. Primarily used for legacy\nlibraries to connect and inspect or remote automate this target.",
|
|
1668
|
-
"type": "string"
|
|
1669
|
-
}
|
|
1670
|
-
},
|
|
1671
|
-
"additionalProperties": false,
|
|
1672
|
-
"required": [
|
|
1673
|
-
"description",
|
|
1674
|
-
"devtoolsFrontendUrl",
|
|
1675
|
-
"id",
|
|
1676
|
-
"title",
|
|
1677
|
-
"type",
|
|
1678
|
-
"url",
|
|
1679
|
-
"webSocketDebuggerUrl"
|
|
1680
|
-
]
|
|
1681
|
-
}
|
|
1682
|
-
},
|
|
1349
|
+
"type": "string",
|
|
1683
1350
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1684
1351
|
}
|
|
1685
1352
|
}
|
|
@@ -1737,47 +1404,7 @@
|
|
|
1737
1404
|
"content": {
|
|
1738
1405
|
"application/json": {
|
|
1739
1406
|
"schema": {
|
|
1740
|
-
"type": "
|
|
1741
|
-
"properties": {
|
|
1742
|
-
"description": {
|
|
1743
|
-
"description": "The description of the target. Generally the page's title.",
|
|
1744
|
-
"type": "string"
|
|
1745
|
-
},
|
|
1746
|
-
"devtoolsFrontendUrl": {
|
|
1747
|
-
"description": "The fully-qualified URL of the Devtools inspector app.",
|
|
1748
|
-
"type": "string"
|
|
1749
|
-
},
|
|
1750
|
-
"id": {
|
|
1751
|
-
"description": "A Unique Id for the underlying target.",
|
|
1752
|
-
"type": "string"
|
|
1753
|
-
},
|
|
1754
|
-
"title": {
|
|
1755
|
-
"description": "The title of the target. For pages this is the page's title.",
|
|
1756
|
-
"type": "string"
|
|
1757
|
-
},
|
|
1758
|
-
"type": {
|
|
1759
|
-
"description": "The type of target, generally \"page\" or \"background_page\".",
|
|
1760
|
-
"type": "string"
|
|
1761
|
-
},
|
|
1762
|
-
"url": {
|
|
1763
|
-
"description": "The current URL the target is consuming or visiting.",
|
|
1764
|
-
"type": "string"
|
|
1765
|
-
},
|
|
1766
|
-
"webSocketDebuggerUrl": {
|
|
1767
|
-
"description": "The target or page's WebSocket Debugger URL. Primarily used for legacy\nlibraries to connect and inspect or remote automate this target.",
|
|
1768
|
-
"type": "string"
|
|
1769
|
-
}
|
|
1770
|
-
},
|
|
1771
|
-
"additionalProperties": false,
|
|
1772
|
-
"required": [
|
|
1773
|
-
"description",
|
|
1774
|
-
"devtoolsFrontendUrl",
|
|
1775
|
-
"id",
|
|
1776
|
-
"title",
|
|
1777
|
-
"type",
|
|
1778
|
-
"url",
|
|
1779
|
-
"webSocketDebuggerUrl"
|
|
1780
|
-
],
|
|
1407
|
+
"type": "string",
|
|
1781
1408
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1782
1409
|
}
|
|
1783
1410
|
}
|
|
@@ -1835,9 +1462,7 @@
|
|
|
1835
1462
|
"content": {
|
|
1836
1463
|
"application/json": {
|
|
1837
1464
|
"schema": {
|
|
1838
|
-
"type": "
|
|
1839
|
-
"properties": {},
|
|
1840
|
-
"additionalProperties": true,
|
|
1465
|
+
"type": "string",
|
|
1841
1466
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1842
1467
|
}
|
|
1843
1468
|
}
|
|
@@ -1895,47 +1520,7 @@
|
|
|
1895
1520
|
"content": {
|
|
1896
1521
|
"application/json": {
|
|
1897
1522
|
"schema": {
|
|
1898
|
-
"type": "
|
|
1899
|
-
"properties": {
|
|
1900
|
-
"description": {
|
|
1901
|
-
"description": "The description of the target. Generally the page's title.",
|
|
1902
|
-
"type": "string"
|
|
1903
|
-
},
|
|
1904
|
-
"devtoolsFrontendUrl": {
|
|
1905
|
-
"description": "The fully-qualified URL of the Devtools inspector app.",
|
|
1906
|
-
"type": "string"
|
|
1907
|
-
},
|
|
1908
|
-
"id": {
|
|
1909
|
-
"description": "A Unique Id for the underlying target.",
|
|
1910
|
-
"type": "string"
|
|
1911
|
-
},
|
|
1912
|
-
"title": {
|
|
1913
|
-
"description": "The title of the target. For pages this is the page's title.",
|
|
1914
|
-
"type": "string"
|
|
1915
|
-
},
|
|
1916
|
-
"type": {
|
|
1917
|
-
"description": "The type of target, generally \"page\" or \"background_page\".",
|
|
1918
|
-
"type": "string"
|
|
1919
|
-
},
|
|
1920
|
-
"url": {
|
|
1921
|
-
"description": "The current URL the target is consuming or visiting.",
|
|
1922
|
-
"type": "string"
|
|
1923
|
-
},
|
|
1924
|
-
"webSocketDebuggerUrl": {
|
|
1925
|
-
"description": "The target or page's WebSocket Debugger URL. Primarily used for legacy\nlibraries to connect and inspect or remote automate this target.",
|
|
1926
|
-
"type": "string"
|
|
1927
|
-
}
|
|
1928
|
-
},
|
|
1929
|
-
"additionalProperties": false,
|
|
1930
|
-
"required": [
|
|
1931
|
-
"description",
|
|
1932
|
-
"devtoolsFrontendUrl",
|
|
1933
|
-
"id",
|
|
1934
|
-
"title",
|
|
1935
|
-
"type",
|
|
1936
|
-
"url",
|
|
1937
|
-
"webSocketDebuggerUrl"
|
|
1938
|
-
],
|
|
1523
|
+
"type": "string",
|
|
1939
1524
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
1940
1525
|
}
|
|
1941
1526
|
}
|
|
@@ -1997,7 +1582,6 @@
|
|
|
1997
1582
|
"in": "query",
|
|
1998
1583
|
"name": "launch",
|
|
1999
1584
|
"schema": {
|
|
2000
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
2001
1585
|
"anyOf": [
|
|
2002
1586
|
{
|
|
2003
1587
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -2057,9 +1641,6 @@
|
|
|
2057
1641
|
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
2058
1642
|
"type": "boolean"
|
|
2059
1643
|
},
|
|
2060
|
-
"blockModals": {
|
|
2061
|
-
"type": "boolean"
|
|
2062
|
-
},
|
|
2063
1644
|
"cookies": {
|
|
2064
1645
|
"type": "array",
|
|
2065
1646
|
"items": {
|
|
@@ -2075,9 +1656,6 @@
|
|
|
2075
1656
|
"html": {
|
|
2076
1657
|
"type": "string"
|
|
2077
1658
|
},
|
|
2078
|
-
"options": {
|
|
2079
|
-
"$ref": "#/definitions/PDFOptions"
|
|
2080
|
-
},
|
|
2081
1659
|
"rejectRequestPattern": {
|
|
2082
1660
|
"type": "array",
|
|
2083
1661
|
"items": {
|
|
@@ -2135,6 +1713,7 @@
|
|
|
2135
1713
|
"$ref": "#/definitions/Record<string,string>"
|
|
2136
1714
|
},
|
|
2137
1715
|
"setJavaScriptEnabled": {
|
|
1716
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
2138
1717
|
"type": "boolean"
|
|
2139
1718
|
},
|
|
2140
1719
|
"url": {
|
|
@@ -2282,7 +1861,6 @@
|
|
|
2282
1861
|
"in": "query",
|
|
2283
1862
|
"name": "launch",
|
|
2284
1863
|
"schema": {
|
|
2285
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
2286
1864
|
"anyOf": [
|
|
2287
1865
|
{
|
|
2288
1866
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -2323,21 +1901,171 @@
|
|
|
2323
1901
|
"application/json": {
|
|
2324
1902
|
"schema": {
|
|
2325
1903
|
"properties": {
|
|
2326
|
-
"
|
|
1904
|
+
"addScriptTag": {
|
|
1905
|
+
"type": "array",
|
|
1906
|
+
"items": {
|
|
1907
|
+
"$ref": "#/definitions/FrameAddScriptTagOptions"
|
|
1908
|
+
}
|
|
1909
|
+
},
|
|
1910
|
+
"addStyleTag": {
|
|
1911
|
+
"type": "array",
|
|
1912
|
+
"items": {
|
|
1913
|
+
"$ref": "#/definitions/FrameAddStyleTagOptions"
|
|
1914
|
+
}
|
|
1915
|
+
},
|
|
1916
|
+
"authenticate": {
|
|
1917
|
+
"$ref": "#/definitions/Credentials"
|
|
1918
|
+
},
|
|
1919
|
+
"bestAttempt": {
|
|
1920
|
+
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
1921
|
+
"type": "boolean"
|
|
1922
|
+
},
|
|
1923
|
+
"cookies": {
|
|
1924
|
+
"type": "array",
|
|
1925
|
+
"items": {
|
|
1926
|
+
"$ref": "#/definitions/CookieParam"
|
|
1927
|
+
}
|
|
1928
|
+
},
|
|
1929
|
+
"emulateMediaType": {
|
|
1930
|
+
"type": "string"
|
|
1931
|
+
},
|
|
1932
|
+
"gotoOptions": {
|
|
1933
|
+
"$ref": "#/definitions/GoToOptions"
|
|
1934
|
+
},
|
|
1935
|
+
"html": {
|
|
1936
|
+
"type": "string"
|
|
1937
|
+
},
|
|
1938
|
+
"rejectRequestPattern": {
|
|
1939
|
+
"type": "array",
|
|
1940
|
+
"items": {
|
|
1941
|
+
"type": "string"
|
|
1942
|
+
}
|
|
1943
|
+
},
|
|
1944
|
+
"rejectResourceTypes": {
|
|
1945
|
+
"type": "array",
|
|
1946
|
+
"items": {
|
|
1947
|
+
"enum": [
|
|
1948
|
+
"cspviolationreport",
|
|
1949
|
+
"document",
|
|
1950
|
+
"eventsource",
|
|
1951
|
+
"fetch",
|
|
1952
|
+
"font",
|
|
1953
|
+
"image",
|
|
1954
|
+
"manifest",
|
|
1955
|
+
"media",
|
|
1956
|
+
"other",
|
|
1957
|
+
"ping",
|
|
1958
|
+
"prefetch",
|
|
1959
|
+
"preflight",
|
|
1960
|
+
"script",
|
|
1961
|
+
"signedexchange",
|
|
1962
|
+
"stylesheet",
|
|
1963
|
+
"texttrack",
|
|
1964
|
+
"websocket",
|
|
1965
|
+
"xhr"
|
|
1966
|
+
],
|
|
1967
|
+
"type": "string"
|
|
1968
|
+
}
|
|
1969
|
+
},
|
|
1970
|
+
"requestInterceptors": {
|
|
2327
1971
|
"type": "array",
|
|
2328
1972
|
"items": {
|
|
1973
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
2329
1974
|
"type": "object",
|
|
2330
|
-
"properties": {
|
|
2331
|
-
|
|
1975
|
+
"properties": {
|
|
1976
|
+
"pattern": {
|
|
1977
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
1978
|
+
"type": "string"
|
|
1979
|
+
},
|
|
1980
|
+
"response": {
|
|
1981
|
+
"$ref": "#/definitions/Partial<ResponseForRequest>"
|
|
1982
|
+
}
|
|
1983
|
+
},
|
|
1984
|
+
"additionalProperties": false,
|
|
1985
|
+
"required": [
|
|
1986
|
+
"pattern",
|
|
1987
|
+
"response"
|
|
1988
|
+
]
|
|
2332
1989
|
}
|
|
2333
1990
|
},
|
|
2334
|
-
"
|
|
2335
|
-
"
|
|
2336
|
-
|
|
2337
|
-
|
|
1991
|
+
"setExtraHTTPHeaders": {
|
|
1992
|
+
"$ref": "#/definitions/Record<string,string>"
|
|
1993
|
+
},
|
|
1994
|
+
"setJavaScriptEnabled": {
|
|
1995
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
1996
|
+
"type": "boolean"
|
|
2338
1997
|
},
|
|
2339
1998
|
"url": {
|
|
2340
1999
|
"type": "string"
|
|
2000
|
+
},
|
|
2001
|
+
"userAgent": {
|
|
2002
|
+
"type": "string"
|
|
2003
|
+
},
|
|
2004
|
+
"viewport": {
|
|
2005
|
+
"$ref": "#/definitions/Viewport"
|
|
2006
|
+
},
|
|
2007
|
+
"waitForEvent": {
|
|
2008
|
+
"type": "object",
|
|
2009
|
+
"properties": {
|
|
2010
|
+
"event": {
|
|
2011
|
+
"type": "string"
|
|
2012
|
+
},
|
|
2013
|
+
"timeout": {
|
|
2014
|
+
"type": "number"
|
|
2015
|
+
}
|
|
2016
|
+
},
|
|
2017
|
+
"additionalProperties": false,
|
|
2018
|
+
"required": [
|
|
2019
|
+
"event"
|
|
2020
|
+
]
|
|
2021
|
+
},
|
|
2022
|
+
"waitForFunction": {
|
|
2023
|
+
"type": "object",
|
|
2024
|
+
"properties": {
|
|
2025
|
+
"fn": {
|
|
2026
|
+
"description": "The function, or statement, to be evaluated in browser context",
|
|
2027
|
+
"type": "string"
|
|
2028
|
+
},
|
|
2029
|
+
"polling": {
|
|
2030
|
+
"description": "An interval at which the pageFunction is executed, defaults to raf.\nIf polling is a number, then it is treated as an interval in milliseconds\nat which the function would be executed. If polling is a string,\nthen it can be one of the following values: \"raf\" or \"mutation\"",
|
|
2031
|
+
"type": [
|
|
2032
|
+
"string",
|
|
2033
|
+
"number"
|
|
2034
|
+
]
|
|
2035
|
+
},
|
|
2036
|
+
"timeout": {
|
|
2037
|
+
"description": "Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds).\nPass 0 to disable timeout.",
|
|
2038
|
+
"type": "number"
|
|
2039
|
+
}
|
|
2040
|
+
},
|
|
2041
|
+
"additionalProperties": false,
|
|
2042
|
+
"required": [
|
|
2043
|
+
"fn"
|
|
2044
|
+
]
|
|
2045
|
+
},
|
|
2046
|
+
"waitForSelector": {
|
|
2047
|
+
"type": "object",
|
|
2048
|
+
"properties": {
|
|
2049
|
+
"hidden": {
|
|
2050
|
+
"type": "boolean"
|
|
2051
|
+
},
|
|
2052
|
+
"selector": {
|
|
2053
|
+
"type": "string"
|
|
2054
|
+
},
|
|
2055
|
+
"timeout": {
|
|
2056
|
+
"type": "number"
|
|
2057
|
+
},
|
|
2058
|
+
"visible": {
|
|
2059
|
+
"type": "boolean"
|
|
2060
|
+
}
|
|
2061
|
+
},
|
|
2062
|
+
"additionalProperties": false,
|
|
2063
|
+
"required": [
|
|
2064
|
+
"selector"
|
|
2065
|
+
]
|
|
2066
|
+
},
|
|
2067
|
+
"waitForTimeout": {
|
|
2068
|
+
"type": "number"
|
|
2341
2069
|
}
|
|
2342
2070
|
},
|
|
2343
2071
|
"type": "object"
|
|
@@ -2351,9 +2079,7 @@
|
|
|
2351
2079
|
"application/json": {
|
|
2352
2080
|
"schema": {
|
|
2353
2081
|
"description": "The response of the lighthouse stats. Response objects are\ndetermined by the type of budgets and config in the POST\nJSON body",
|
|
2354
|
-
"type": "
|
|
2355
|
-
"properties": {},
|
|
2356
|
-
"additionalProperties": true,
|
|
2082
|
+
"type": "string",
|
|
2357
2083
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
2358
2084
|
}
|
|
2359
2085
|
}
|
|
@@ -2479,15 +2205,6 @@
|
|
|
2479
2205
|
"$ref": "#/definitions/CookieParam"
|
|
2480
2206
|
}
|
|
2481
2207
|
},
|
|
2482
|
-
"debugOpts": {
|
|
2483
|
-
"$ref": "#/definitions/ScrapeDebugOptions"
|
|
2484
|
-
},
|
|
2485
|
-
"elements": {
|
|
2486
|
-
"type": "array",
|
|
2487
|
-
"items": {
|
|
2488
|
-
"$ref": "#/definitions/ScrapeElementSelector"
|
|
2489
|
-
}
|
|
2490
|
-
},
|
|
2491
2208
|
"emulateMediaType": {
|
|
2492
2209
|
"type": "string"
|
|
2493
2210
|
},
|
|
@@ -2554,6 +2271,7 @@
|
|
|
2554
2271
|
"$ref": "#/definitions/Record<string,string>"
|
|
2555
2272
|
},
|
|
2556
2273
|
"setJavaScriptEnabled": {
|
|
2274
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
2557
2275
|
"type": "boolean"
|
|
2558
2276
|
},
|
|
2559
2277
|
"url": {
|
|
@@ -2640,311 +2358,7 @@
|
|
|
2640
2358
|
"application/json": {
|
|
2641
2359
|
"schema": {
|
|
2642
2360
|
"description": "The JSON response body",
|
|
2643
|
-
"type": "
|
|
2644
|
-
"properties": {
|
|
2645
|
-
"data": {
|
|
2646
|
-
"anyOf": [
|
|
2647
|
-
{
|
|
2648
|
-
"type": "array",
|
|
2649
|
-
"items": {
|
|
2650
|
-
"type": "object",
|
|
2651
|
-
"properties": {
|
|
2652
|
-
"results": {
|
|
2653
|
-
"type": "array",
|
|
2654
|
-
"items": {
|
|
2655
|
-
"type": "object",
|
|
2656
|
-
"properties": {
|
|
2657
|
-
"attributes": {
|
|
2658
|
-
"description": "A list of HTML attributes of the element",
|
|
2659
|
-
"type": "array",
|
|
2660
|
-
"items": {
|
|
2661
|
-
"type": "object",
|
|
2662
|
-
"properties": {
|
|
2663
|
-
"name": {
|
|
2664
|
-
"description": "The name of the HTML attribute for the element",
|
|
2665
|
-
"type": "string"
|
|
2666
|
-
},
|
|
2667
|
-
"value": {
|
|
2668
|
-
"description": "The value of the HTML attribute for the element",
|
|
2669
|
-
"type": "string"
|
|
2670
|
-
}
|
|
2671
|
-
},
|
|
2672
|
-
"additionalProperties": false,
|
|
2673
|
-
"required": [
|
|
2674
|
-
"name",
|
|
2675
|
-
"value"
|
|
2676
|
-
]
|
|
2677
|
-
}
|
|
2678
|
-
},
|
|
2679
|
-
"height": {
|
|
2680
|
-
"description": "The height the element",
|
|
2681
|
-
"type": "number"
|
|
2682
|
-
},
|
|
2683
|
-
"html": {
|
|
2684
|
-
"description": "The HTML the element",
|
|
2685
|
-
"type": "string"
|
|
2686
|
-
},
|
|
2687
|
-
"left": {
|
|
2688
|
-
"description": "The amount of pixels from the left of the page",
|
|
2689
|
-
"type": "number"
|
|
2690
|
-
},
|
|
2691
|
-
"text": {
|
|
2692
|
-
"description": "The text the element",
|
|
2693
|
-
"type": "string"
|
|
2694
|
-
},
|
|
2695
|
-
"top": {
|
|
2696
|
-
"description": "The amount of pixels from the top of the page",
|
|
2697
|
-
"type": "number"
|
|
2698
|
-
},
|
|
2699
|
-
"width": {
|
|
2700
|
-
"description": "The width the element",
|
|
2701
|
-
"type": "number"
|
|
2702
|
-
}
|
|
2703
|
-
},
|
|
2704
|
-
"additionalProperties": false,
|
|
2705
|
-
"required": [
|
|
2706
|
-
"attributes",
|
|
2707
|
-
"height",
|
|
2708
|
-
"html",
|
|
2709
|
-
"left",
|
|
2710
|
-
"text",
|
|
2711
|
-
"top",
|
|
2712
|
-
"width"
|
|
2713
|
-
]
|
|
2714
|
-
}
|
|
2715
|
-
},
|
|
2716
|
-
"selector": {
|
|
2717
|
-
"description": "The DOM selector of the element",
|
|
2718
|
-
"type": "string"
|
|
2719
|
-
}
|
|
2720
|
-
},
|
|
2721
|
-
"additionalProperties": false,
|
|
2722
|
-
"required": [
|
|
2723
|
-
"results",
|
|
2724
|
-
"selector"
|
|
2725
|
-
]
|
|
2726
|
-
}
|
|
2727
|
-
},
|
|
2728
|
-
{
|
|
2729
|
-
"type": "null"
|
|
2730
|
-
}
|
|
2731
|
-
]
|
|
2732
|
-
},
|
|
2733
|
-
"debug": {
|
|
2734
|
-
"description": "When debugOpts options are present, results are here",
|
|
2735
|
-
"anyOf": [
|
|
2736
|
-
{
|
|
2737
|
-
"type": "object",
|
|
2738
|
-
"properties": {
|
|
2739
|
-
"console": {
|
|
2740
|
-
"description": "A list of console messages from the browser",
|
|
2741
|
-
"type": "array",
|
|
2742
|
-
"items": {
|
|
2743
|
-
"type": "string"
|
|
2744
|
-
}
|
|
2745
|
-
},
|
|
2746
|
-
"cookies": {
|
|
2747
|
-
"description": "List of cookies for the site or null",
|
|
2748
|
-
"anyOf": [
|
|
2749
|
-
{
|
|
2750
|
-
"type": "array",
|
|
2751
|
-
"items": {
|
|
2752
|
-
"$ref": "#/definitions/Cookie"
|
|
2753
|
-
}
|
|
2754
|
-
},
|
|
2755
|
-
{
|
|
2756
|
-
"type": "null"
|
|
2757
|
-
}
|
|
2758
|
-
]
|
|
2759
|
-
},
|
|
2760
|
-
"html": {
|
|
2761
|
-
"description": "The HTML string of the website or null",
|
|
2762
|
-
"type": [
|
|
2763
|
-
"null",
|
|
2764
|
-
"string"
|
|
2765
|
-
]
|
|
2766
|
-
},
|
|
2767
|
-
"network": {
|
|
2768
|
-
"type": "object",
|
|
2769
|
-
"properties": {
|
|
2770
|
-
"inbound": {
|
|
2771
|
-
"type": "array",
|
|
2772
|
-
"items": {
|
|
2773
|
-
"$ref": "#/definitions/InBoundRequest"
|
|
2774
|
-
}
|
|
2775
|
-
},
|
|
2776
|
-
"outbound": {
|
|
2777
|
-
"type": "array",
|
|
2778
|
-
"items": {
|
|
2779
|
-
"$ref": "#/definitions/OutBoundRequest"
|
|
2780
|
-
}
|
|
2781
|
-
}
|
|
2782
|
-
},
|
|
2783
|
-
"additionalProperties": false,
|
|
2784
|
-
"required": [
|
|
2785
|
-
"inbound",
|
|
2786
|
-
"outbound"
|
|
2787
|
-
]
|
|
2788
|
-
},
|
|
2789
|
-
"screenshot": {
|
|
2790
|
-
"description": "A base64-encoded string of the site or null",
|
|
2791
|
-
"type": [
|
|
2792
|
-
"null",
|
|
2793
|
-
"string"
|
|
2794
|
-
]
|
|
2795
|
-
}
|
|
2796
|
-
},
|
|
2797
|
-
"additionalProperties": false,
|
|
2798
|
-
"required": [
|
|
2799
|
-
"console",
|
|
2800
|
-
"cookies",
|
|
2801
|
-
"html",
|
|
2802
|
-
"network",
|
|
2803
|
-
"screenshot"
|
|
2804
|
-
]
|
|
2805
|
-
},
|
|
2806
|
-
{
|
|
2807
|
-
"type": "null"
|
|
2808
|
-
}
|
|
2809
|
-
]
|
|
2810
|
-
}
|
|
2811
|
-
},
|
|
2812
|
-
"additionalProperties": false,
|
|
2813
|
-
"required": [
|
|
2814
|
-
"data",
|
|
2815
|
-
"debug"
|
|
2816
|
-
],
|
|
2817
|
-
"definitions": {
|
|
2818
|
-
"Cookie": {
|
|
2819
|
-
"description": "Represents a cookie object.",
|
|
2820
|
-
"type": "object",
|
|
2821
|
-
"properties": {
|
|
2822
|
-
"name": {
|
|
2823
|
-
"description": "Cookie name.",
|
|
2824
|
-
"type": "string"
|
|
2825
|
-
},
|
|
2826
|
-
"value": {
|
|
2827
|
-
"description": "Cookie value.",
|
|
2828
|
-
"type": "string"
|
|
2829
|
-
},
|
|
2830
|
-
"domain": {
|
|
2831
|
-
"description": "Cookie domain.",
|
|
2832
|
-
"type": "string"
|
|
2833
|
-
},
|
|
2834
|
-
"path": {
|
|
2835
|
-
"description": "Cookie path.",
|
|
2836
|
-
"type": "string"
|
|
2837
|
-
},
|
|
2838
|
-
"expires": {
|
|
2839
|
-
"description": "Cookie expiration date as the number of seconds since the UNIX epoch. Set to `-1` for\nsession cookies",
|
|
2840
|
-
"type": "number"
|
|
2841
|
-
},
|
|
2842
|
-
"size": {
|
|
2843
|
-
"description": "Cookie size.",
|
|
2844
|
-
"type": "number"
|
|
2845
|
-
},
|
|
2846
|
-
"httpOnly": {
|
|
2847
|
-
"description": "True if cookie is http-only.",
|
|
2848
|
-
"type": "boolean"
|
|
2849
|
-
},
|
|
2850
|
-
"secure": {
|
|
2851
|
-
"description": "True if cookie is secure.",
|
|
2852
|
-
"type": "boolean"
|
|
2853
|
-
},
|
|
2854
|
-
"session": {
|
|
2855
|
-
"description": "True in case of session cookie.",
|
|
2856
|
-
"type": "boolean"
|
|
2857
|
-
},
|
|
2858
|
-
"sameSite": {
|
|
2859
|
-
"description": "Cookie SameSite type.",
|
|
2860
|
-
"enum": [
|
|
2861
|
-
"Lax",
|
|
2862
|
-
"None",
|
|
2863
|
-
"Strict"
|
|
2864
|
-
],
|
|
2865
|
-
"type": "string"
|
|
2866
|
-
},
|
|
2867
|
-
"priority": {
|
|
2868
|
-
"description": "Cookie Priority. Supported only in Chrome.",
|
|
2869
|
-
"enum": [
|
|
2870
|
-
"High",
|
|
2871
|
-
"Low",
|
|
2872
|
-
"Medium"
|
|
2873
|
-
],
|
|
2874
|
-
"type": "string"
|
|
2875
|
-
},
|
|
2876
|
-
"sameParty": {
|
|
2877
|
-
"description": "True if cookie is SameParty. Supported only in Chrome.",
|
|
2878
|
-
"type": "boolean"
|
|
2879
|
-
},
|
|
2880
|
-
"sourceScheme": {
|
|
2881
|
-
"description": "Cookie source scheme type. Supported only in Chrome.",
|
|
2882
|
-
"enum": [
|
|
2883
|
-
"NonSecure",
|
|
2884
|
-
"Secure",
|
|
2885
|
-
"Unset"
|
|
2886
|
-
],
|
|
2887
|
-
"type": "string"
|
|
2888
|
-
},
|
|
2889
|
-
"partitionKey": {
|
|
2890
|
-
"description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. Supported only in Chrome.",
|
|
2891
|
-
"type": "string"
|
|
2892
|
-
},
|
|
2893
|
-
"partitionKeyOpaque": {
|
|
2894
|
-
"description": "True if cookie partition key is opaque. Supported only in Chrome.",
|
|
2895
|
-
"type": "boolean"
|
|
2896
|
-
}
|
|
2897
|
-
},
|
|
2898
|
-
"additionalProperties": false,
|
|
2899
|
-
"required": [
|
|
2900
|
-
"domain",
|
|
2901
|
-
"expires",
|
|
2902
|
-
"httpOnly",
|
|
2903
|
-
"name",
|
|
2904
|
-
"path",
|
|
2905
|
-
"secure",
|
|
2906
|
-
"session",
|
|
2907
|
-
"size",
|
|
2908
|
-
"value"
|
|
2909
|
-
]
|
|
2910
|
-
},
|
|
2911
|
-
"InBoundRequest": {
|
|
2912
|
-
"type": "object",
|
|
2913
|
-
"properties": {
|
|
2914
|
-
"headers": {},
|
|
2915
|
-
"status": {
|
|
2916
|
-
"type": "number"
|
|
2917
|
-
},
|
|
2918
|
-
"url": {
|
|
2919
|
-
"type": "string"
|
|
2920
|
-
}
|
|
2921
|
-
},
|
|
2922
|
-
"additionalProperties": false,
|
|
2923
|
-
"required": [
|
|
2924
|
-
"headers",
|
|
2925
|
-
"status",
|
|
2926
|
-
"url"
|
|
2927
|
-
]
|
|
2928
|
-
},
|
|
2929
|
-
"OutBoundRequest": {
|
|
2930
|
-
"type": "object",
|
|
2931
|
-
"properties": {
|
|
2932
|
-
"headers": {},
|
|
2933
|
-
"method": {
|
|
2934
|
-
"type": "string"
|
|
2935
|
-
},
|
|
2936
|
-
"url": {
|
|
2937
|
-
"type": "string"
|
|
2938
|
-
}
|
|
2939
|
-
},
|
|
2940
|
-
"additionalProperties": false,
|
|
2941
|
-
"required": [
|
|
2942
|
-
"headers",
|
|
2943
|
-
"method",
|
|
2944
|
-
"url"
|
|
2945
|
-
]
|
|
2946
|
-
}
|
|
2947
|
-
},
|
|
2361
|
+
"type": "string",
|
|
2948
2362
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
2949
2363
|
}
|
|
2950
2364
|
}
|
|
@@ -3005,7 +2419,6 @@
|
|
|
3005
2419
|
"in": "query",
|
|
3006
2420
|
"name": "launch",
|
|
3007
2421
|
"schema": {
|
|
3008
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
3009
2422
|
"anyOf": [
|
|
3010
2423
|
{
|
|
3011
2424
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -3080,9 +2493,6 @@
|
|
|
3080
2493
|
"html": {
|
|
3081
2494
|
"type": "string"
|
|
3082
2495
|
},
|
|
3083
|
-
"options": {
|
|
3084
|
-
"$ref": "#/definitions/ScreenshotOptions"
|
|
3085
|
-
},
|
|
3086
2496
|
"rejectRequestPattern": {
|
|
3087
2497
|
"type": "array",
|
|
3088
2498
|
"items": {
|
|
@@ -3136,16 +2546,11 @@
|
|
|
3136
2546
|
]
|
|
3137
2547
|
}
|
|
3138
2548
|
},
|
|
3139
|
-
"scrollPage": {
|
|
3140
|
-
"type": "boolean"
|
|
3141
|
-
},
|
|
3142
|
-
"selector": {
|
|
3143
|
-
"type": "string"
|
|
3144
|
-
},
|
|
3145
2549
|
"setExtraHTTPHeaders": {
|
|
3146
2550
|
"$ref": "#/definitions/Record<string,string>"
|
|
3147
2551
|
},
|
|
3148
2552
|
"setJavaScriptEnabled": {
|
|
2553
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
3149
2554
|
"type": "boolean"
|
|
3150
2555
|
},
|
|
3151
2556
|
"url": {
|
|
@@ -3221,31 +2626,127 @@
|
|
|
3221
2626
|
"type": "number"
|
|
3222
2627
|
}
|
|
3223
2628
|
},
|
|
3224
|
-
"type": "object"
|
|
3225
|
-
}
|
|
2629
|
+
"type": "object"
|
|
2630
|
+
}
|
|
2631
|
+
}
|
|
2632
|
+
}
|
|
2633
|
+
},
|
|
2634
|
+
"responses": {
|
|
2635
|
+
"200": {
|
|
2636
|
+
"content": {
|
|
2637
|
+
"image/png": {
|
|
2638
|
+
"schema": {
|
|
2639
|
+
"type": "text"
|
|
2640
|
+
}
|
|
2641
|
+
},
|
|
2642
|
+
"image/jpeg": {
|
|
2643
|
+
"schema": {
|
|
2644
|
+
"type": "text"
|
|
2645
|
+
}
|
|
2646
|
+
},
|
|
2647
|
+
"text/plain": {
|
|
2648
|
+
"schema": {
|
|
2649
|
+
"type": "text"
|
|
2650
|
+
}
|
|
2651
|
+
}
|
|
2652
|
+
},
|
|
2653
|
+
"description": "Response can either be a text/plain base64 encoded body\nor a binary stream with png/jpeg as a content-type"
|
|
2654
|
+
},
|
|
2655
|
+
"400": {
|
|
2656
|
+
"code": 400,
|
|
2657
|
+
"description": "The request contains errors or didn't properly encode content.",
|
|
2658
|
+
"message": "HTTP/1.1 400 Bad Request"
|
|
2659
|
+
},
|
|
2660
|
+
"401": {
|
|
2661
|
+
"code": 401,
|
|
2662
|
+
"description": "The request is missing, or contains bad, authorization credentials.",
|
|
2663
|
+
"message": "HTTP/1.1 401 Unauthorized"
|
|
2664
|
+
},
|
|
2665
|
+
"404": {
|
|
2666
|
+
"code": 404,
|
|
2667
|
+
"description": "Resource couldn't be found.",
|
|
2668
|
+
"message": "HTTP/1.1 404 Not Found"
|
|
2669
|
+
},
|
|
2670
|
+
"408": {
|
|
2671
|
+
"code": 408,
|
|
2672
|
+
"description": "The request took has taken too long to process.",
|
|
2673
|
+
"message": "HTTP/1.1 408 Request Timeout"
|
|
2674
|
+
},
|
|
2675
|
+
"429": {
|
|
2676
|
+
"code": 429,
|
|
2677
|
+
"description": "Too many requests are currently being processed.",
|
|
2678
|
+
"message": "HTTP/1.1 429 Too Many Requests"
|
|
2679
|
+
},
|
|
2680
|
+
"500": {
|
|
2681
|
+
"code": 500,
|
|
2682
|
+
"description": "An internal error occurred when handling the request.",
|
|
2683
|
+
"message": "HTTP/1.1 500 Internal Server Error"
|
|
2684
|
+
}
|
|
2685
|
+
},
|
|
2686
|
+
"summary": "/chrome/screenshot",
|
|
2687
|
+
"tags": [
|
|
2688
|
+
"Browser REST APIs"
|
|
2689
|
+
]
|
|
2690
|
+
}
|
|
2691
|
+
},
|
|
2692
|
+
"/devtools/browser/*": {
|
|
2693
|
+
"get": {
|
|
2694
|
+
"definitions": {},
|
|
2695
|
+
"description": "Connect to an already-running Chromium process with a library like\npuppeteer, or others, that work over chrome-devtools-protocol. Chromium\nmust already be launched in order to not return a 404.",
|
|
2696
|
+
"parameters": [
|
|
2697
|
+
{
|
|
2698
|
+
"in": "query",
|
|
2699
|
+
"name": "blockAds",
|
|
2700
|
+
"schema": {
|
|
2701
|
+
"description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
|
|
2702
|
+
"type": "boolean"
|
|
2703
|
+
}
|
|
2704
|
+
},
|
|
2705
|
+
{
|
|
2706
|
+
"in": "query",
|
|
2707
|
+
"name": "launch",
|
|
2708
|
+
"schema": {
|
|
2709
|
+
"anyOf": [
|
|
2710
|
+
{
|
|
2711
|
+
"$ref": "#/definitions/CDPLaunchOptions"
|
|
2712
|
+
},
|
|
2713
|
+
{
|
|
2714
|
+
"type": "string"
|
|
2715
|
+
}
|
|
2716
|
+
]
|
|
2717
|
+
}
|
|
2718
|
+
},
|
|
2719
|
+
{
|
|
2720
|
+
"in": "query",
|
|
2721
|
+
"name": "record",
|
|
2722
|
+
"schema": {
|
|
2723
|
+
"description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
|
|
2724
|
+
"type": "boolean"
|
|
2725
|
+
}
|
|
2726
|
+
},
|
|
2727
|
+
{
|
|
2728
|
+
"in": "query",
|
|
2729
|
+
"name": "timeout",
|
|
2730
|
+
"schema": {
|
|
2731
|
+
"description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
|
|
2732
|
+
"type": "number"
|
|
2733
|
+
}
|
|
2734
|
+
},
|
|
2735
|
+
{
|
|
2736
|
+
"in": "query",
|
|
2737
|
+
"name": "token",
|
|
2738
|
+
"schema": {
|
|
2739
|
+
"description": "The authorization token",
|
|
2740
|
+
"type": "string"
|
|
3226
2741
|
}
|
|
3227
2742
|
}
|
|
2743
|
+
],
|
|
2744
|
+
"requestBody": {
|
|
2745
|
+
"content": {}
|
|
3228
2746
|
},
|
|
3229
2747
|
"responses": {
|
|
3230
|
-
"
|
|
3231
|
-
"
|
|
3232
|
-
"image/png": {
|
|
3233
|
-
"schema": {
|
|
3234
|
-
"type": "text"
|
|
3235
|
-
}
|
|
3236
|
-
},
|
|
3237
|
-
"image/jpeg": {
|
|
3238
|
-
"schema": {
|
|
3239
|
-
"type": "text"
|
|
3240
|
-
}
|
|
3241
|
-
},
|
|
3242
|
-
"text/plain": {
|
|
3243
|
-
"schema": {
|
|
3244
|
-
"type": "text"
|
|
3245
|
-
}
|
|
3246
|
-
}
|
|
3247
|
-
},
|
|
3248
|
-
"description": "Response can either be a text/plain base64 encoded body\nor a binary stream with png/jpeg as a content-type"
|
|
2748
|
+
"101": {
|
|
2749
|
+
"description": "Indicates successful WebSocket upgrade."
|
|
3249
2750
|
},
|
|
3250
2751
|
"400": {
|
|
3251
2752
|
"code": 400,
|
|
@@ -3278,16 +2779,18 @@
|
|
|
3278
2779
|
"message": "HTTP/1.1 500 Internal Server Error"
|
|
3279
2780
|
}
|
|
3280
2781
|
},
|
|
3281
|
-
"summary":
|
|
2782
|
+
"summary": [
|
|
2783
|
+
"/devtools/browser/*"
|
|
2784
|
+
],
|
|
3282
2785
|
"tags": [
|
|
3283
|
-
"Browser
|
|
2786
|
+
"Browser WebSocket APIs"
|
|
3284
2787
|
]
|
|
3285
2788
|
}
|
|
3286
2789
|
},
|
|
3287
|
-
"/
|
|
2790
|
+
"/chrome": {
|
|
3288
2791
|
"get": {
|
|
3289
2792
|
"definitions": {},
|
|
3290
|
-
"description": "
|
|
2793
|
+
"description": "Launch and connect to Chromium with a library like puppeteer or others that work over chrome-devtools-protocol.",
|
|
3291
2794
|
"parameters": [
|
|
3292
2795
|
{
|
|
3293
2796
|
"in": "query",
|
|
@@ -3301,7 +2804,6 @@
|
|
|
3301
2804
|
"in": "query",
|
|
3302
2805
|
"name": "launch",
|
|
3303
2806
|
"schema": {
|
|
3304
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
3305
2807
|
"anyOf": [
|
|
3306
2808
|
{
|
|
3307
2809
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -3375,18 +2877,16 @@
|
|
|
3375
2877
|
"message": "HTTP/1.1 500 Internal Server Error"
|
|
3376
2878
|
}
|
|
3377
2879
|
},
|
|
3378
|
-
"summary":
|
|
3379
|
-
"/devtools/browser/*"
|
|
3380
|
-
],
|
|
2880
|
+
"summary": "/chrome",
|
|
3381
2881
|
"tags": [
|
|
3382
2882
|
"Browser WebSocket APIs"
|
|
3383
2883
|
]
|
|
3384
2884
|
}
|
|
3385
2885
|
},
|
|
3386
|
-
"/
|
|
2886
|
+
"/devtools/page/*": {
|
|
3387
2887
|
"get": {
|
|
3388
2888
|
"definitions": {},
|
|
3389
|
-
"description": "
|
|
2889
|
+
"description": "Connect to an existing page in Chromium with a library like\nchrome-remote-interface or others that work the page websocketDebugger\nURL. You can get this unique URL by calling the /json/list API\nor by finding the page's unique ID from your library of choice.",
|
|
3390
2890
|
"parameters": [
|
|
3391
2891
|
{
|
|
3392
2892
|
"in": "query",
|
|
@@ -3400,7 +2900,6 @@
|
|
|
3400
2900
|
"in": "query",
|
|
3401
2901
|
"name": "launch",
|
|
3402
2902
|
"schema": {
|
|
3403
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
3404
2903
|
"anyOf": [
|
|
3405
2904
|
{
|
|
3406
2905
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -3474,16 +2973,18 @@
|
|
|
3474
2973
|
"message": "HTTP/1.1 500 Internal Server Error"
|
|
3475
2974
|
}
|
|
3476
2975
|
},
|
|
3477
|
-
"summary":
|
|
2976
|
+
"summary": [
|
|
2977
|
+
"/devtools/page/*"
|
|
2978
|
+
],
|
|
3478
2979
|
"tags": [
|
|
3479
2980
|
"Browser WebSocket APIs"
|
|
3480
2981
|
]
|
|
3481
2982
|
}
|
|
3482
2983
|
},
|
|
3483
|
-
"/
|
|
2984
|
+
"/chrome/playwright": {
|
|
3484
2985
|
"get": {
|
|
3485
2986
|
"definitions": {},
|
|
3486
|
-
"description": "Connect to
|
|
2987
|
+
"description": "Connect to Chromium with any playwright style library.",
|
|
3487
2988
|
"parameters": [
|
|
3488
2989
|
{
|
|
3489
2990
|
"in": "query",
|
|
@@ -3497,7 +2998,6 @@
|
|
|
3497
2998
|
"in": "query",
|
|
3498
2999
|
"name": "launch",
|
|
3499
3000
|
"schema": {
|
|
3500
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
3501
3001
|
"anyOf": [
|
|
3502
3002
|
{
|
|
3503
3003
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -3571,18 +3071,16 @@
|
|
|
3571
3071
|
"message": "HTTP/1.1 500 Internal Server Error"
|
|
3572
3072
|
}
|
|
3573
3073
|
},
|
|
3574
|
-
"summary":
|
|
3575
|
-
"/devtools/page/*"
|
|
3576
|
-
],
|
|
3074
|
+
"summary": "/chrome/playwright",
|
|
3577
3075
|
"tags": [
|
|
3578
3076
|
"Browser WebSocket APIs"
|
|
3579
3077
|
]
|
|
3580
3078
|
}
|
|
3581
3079
|
},
|
|
3582
|
-
"/
|
|
3583
|
-
"
|
|
3080
|
+
"/content /chromium/content": {
|
|
3081
|
+
"post": {
|
|
3584
3082
|
"definitions": {},
|
|
3585
|
-
"description": "
|
|
3083
|
+
"description": "A JSON-based API. Given a \"url\" or \"html\" field, runs and returns HTML content after the page has loaded and JavaScript has parsed.",
|
|
3586
3084
|
"parameters": [
|
|
3587
3085
|
{
|
|
3588
3086
|
"in": "query",
|
|
@@ -3596,48 +3094,230 @@
|
|
|
3596
3094
|
"in": "query",
|
|
3597
3095
|
"name": "launch",
|
|
3598
3096
|
"schema": {
|
|
3599
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
3600
3097
|
"anyOf": [
|
|
3601
3098
|
{
|
|
3602
|
-
"$ref": "#/definitions/
|
|
3099
|
+
"$ref": "#/definitions/CDPLaunchOptions"
|
|
3100
|
+
},
|
|
3101
|
+
{
|
|
3102
|
+
"type": "string"
|
|
3103
|
+
}
|
|
3104
|
+
]
|
|
3105
|
+
}
|
|
3106
|
+
},
|
|
3107
|
+
{
|
|
3108
|
+
"in": "query",
|
|
3109
|
+
"name": "record",
|
|
3110
|
+
"schema": {
|
|
3111
|
+
"description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
|
|
3112
|
+
"type": "boolean"
|
|
3113
|
+
}
|
|
3114
|
+
},
|
|
3115
|
+
{
|
|
3116
|
+
"in": "query",
|
|
3117
|
+
"name": "timeout",
|
|
3118
|
+
"schema": {
|
|
3119
|
+
"description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
|
|
3120
|
+
"type": "number"
|
|
3121
|
+
}
|
|
3122
|
+
},
|
|
3123
|
+
{
|
|
3124
|
+
"in": "query",
|
|
3125
|
+
"name": "token",
|
|
3126
|
+
"schema": {
|
|
3127
|
+
"description": "The authorization token",
|
|
3128
|
+
"type": "string"
|
|
3129
|
+
}
|
|
3130
|
+
}
|
|
3131
|
+
],
|
|
3132
|
+
"requestBody": {
|
|
3133
|
+
"content": {
|
|
3134
|
+
"application/json": {
|
|
3135
|
+
"schema": {
|
|
3136
|
+
"properties": {
|
|
3137
|
+
"addScriptTag": {
|
|
3138
|
+
"type": "array",
|
|
3139
|
+
"items": {
|
|
3140
|
+
"$ref": "#/definitions/FrameAddScriptTagOptions"
|
|
3141
|
+
}
|
|
3142
|
+
},
|
|
3143
|
+
"addStyleTag": {
|
|
3144
|
+
"type": "array",
|
|
3145
|
+
"items": {
|
|
3146
|
+
"$ref": "#/definitions/FrameAddStyleTagOptions"
|
|
3147
|
+
}
|
|
3148
|
+
},
|
|
3149
|
+
"authenticate": {
|
|
3150
|
+
"$ref": "#/definitions/Credentials"
|
|
3151
|
+
},
|
|
3152
|
+
"bestAttempt": {
|
|
3153
|
+
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
3154
|
+
"type": "boolean"
|
|
3155
|
+
},
|
|
3156
|
+
"cookies": {
|
|
3157
|
+
"type": "array",
|
|
3158
|
+
"items": {
|
|
3159
|
+
"$ref": "#/definitions/CookieParam"
|
|
3160
|
+
}
|
|
3161
|
+
},
|
|
3162
|
+
"emulateMediaType": {
|
|
3163
|
+
"type": "string"
|
|
3164
|
+
},
|
|
3165
|
+
"gotoOptions": {
|
|
3166
|
+
"$ref": "#/definitions/GoToOptions"
|
|
3167
|
+
},
|
|
3168
|
+
"html": {
|
|
3169
|
+
"type": "string"
|
|
3170
|
+
},
|
|
3171
|
+
"rejectRequestPattern": {
|
|
3172
|
+
"type": "array",
|
|
3173
|
+
"items": {
|
|
3174
|
+
"type": "string"
|
|
3175
|
+
}
|
|
3176
|
+
},
|
|
3177
|
+
"rejectResourceTypes": {
|
|
3178
|
+
"type": "array",
|
|
3179
|
+
"items": {
|
|
3180
|
+
"enum": [
|
|
3181
|
+
"cspviolationreport",
|
|
3182
|
+
"document",
|
|
3183
|
+
"eventsource",
|
|
3184
|
+
"fetch",
|
|
3185
|
+
"font",
|
|
3186
|
+
"image",
|
|
3187
|
+
"manifest",
|
|
3188
|
+
"media",
|
|
3189
|
+
"other",
|
|
3190
|
+
"ping",
|
|
3191
|
+
"prefetch",
|
|
3192
|
+
"preflight",
|
|
3193
|
+
"script",
|
|
3194
|
+
"signedexchange",
|
|
3195
|
+
"stylesheet",
|
|
3196
|
+
"texttrack",
|
|
3197
|
+
"websocket",
|
|
3198
|
+
"xhr"
|
|
3199
|
+
],
|
|
3200
|
+
"type": "string"
|
|
3201
|
+
}
|
|
3202
|
+
},
|
|
3203
|
+
"requestInterceptors": {
|
|
3204
|
+
"type": "array",
|
|
3205
|
+
"items": {
|
|
3206
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
3207
|
+
"type": "object",
|
|
3208
|
+
"properties": {
|
|
3209
|
+
"pattern": {
|
|
3210
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
3211
|
+
"type": "string"
|
|
3212
|
+
},
|
|
3213
|
+
"response": {
|
|
3214
|
+
"$ref": "#/definitions/Partial<ResponseForRequest>"
|
|
3215
|
+
}
|
|
3216
|
+
},
|
|
3217
|
+
"additionalProperties": false,
|
|
3218
|
+
"required": [
|
|
3219
|
+
"pattern",
|
|
3220
|
+
"response"
|
|
3221
|
+
]
|
|
3222
|
+
}
|
|
3223
|
+
},
|
|
3224
|
+
"setExtraHTTPHeaders": {
|
|
3225
|
+
"$ref": "#/definitions/Record<string,string>"
|
|
3226
|
+
},
|
|
3227
|
+
"setJavaScriptEnabled": {
|
|
3228
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
3229
|
+
"type": "boolean"
|
|
3230
|
+
},
|
|
3231
|
+
"url": {
|
|
3232
|
+
"type": "string"
|
|
3233
|
+
},
|
|
3234
|
+
"userAgent": {
|
|
3235
|
+
"type": "string"
|
|
3236
|
+
},
|
|
3237
|
+
"viewport": {
|
|
3238
|
+
"$ref": "#/definitions/Viewport"
|
|
3239
|
+
},
|
|
3240
|
+
"waitForEvent": {
|
|
3241
|
+
"type": "object",
|
|
3242
|
+
"properties": {
|
|
3243
|
+
"event": {
|
|
3244
|
+
"type": "string"
|
|
3245
|
+
},
|
|
3246
|
+
"timeout": {
|
|
3247
|
+
"type": "number"
|
|
3248
|
+
}
|
|
3249
|
+
},
|
|
3250
|
+
"additionalProperties": false,
|
|
3251
|
+
"required": [
|
|
3252
|
+
"event"
|
|
3253
|
+
]
|
|
3254
|
+
},
|
|
3255
|
+
"waitForFunction": {
|
|
3256
|
+
"type": "object",
|
|
3257
|
+
"properties": {
|
|
3258
|
+
"fn": {
|
|
3259
|
+
"description": "The function, or statement, to be evaluated in browser context",
|
|
3260
|
+
"type": "string"
|
|
3261
|
+
},
|
|
3262
|
+
"polling": {
|
|
3263
|
+
"description": "An interval at which the pageFunction is executed, defaults to raf.\nIf polling is a number, then it is treated as an interval in milliseconds\nat which the function would be executed. If polling is a string,\nthen it can be one of the following values: \"raf\" or \"mutation\"",
|
|
3264
|
+
"type": [
|
|
3265
|
+
"string",
|
|
3266
|
+
"number"
|
|
3267
|
+
]
|
|
3268
|
+
},
|
|
3269
|
+
"timeout": {
|
|
3270
|
+
"description": "Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds).\nPass 0 to disable timeout.",
|
|
3271
|
+
"type": "number"
|
|
3272
|
+
}
|
|
3273
|
+
},
|
|
3274
|
+
"additionalProperties": false,
|
|
3275
|
+
"required": [
|
|
3276
|
+
"fn"
|
|
3277
|
+
]
|
|
3278
|
+
},
|
|
3279
|
+
"waitForSelector": {
|
|
3280
|
+
"type": "object",
|
|
3281
|
+
"properties": {
|
|
3282
|
+
"hidden": {
|
|
3283
|
+
"type": "boolean"
|
|
3284
|
+
},
|
|
3285
|
+
"selector": {
|
|
3286
|
+
"type": "string"
|
|
3287
|
+
},
|
|
3288
|
+
"timeout": {
|
|
3289
|
+
"type": "number"
|
|
3290
|
+
},
|
|
3291
|
+
"visible": {
|
|
3292
|
+
"type": "boolean"
|
|
3293
|
+
}
|
|
3294
|
+
},
|
|
3295
|
+
"additionalProperties": false,
|
|
3296
|
+
"required": [
|
|
3297
|
+
"selector"
|
|
3298
|
+
]
|
|
3299
|
+
},
|
|
3300
|
+
"waitForTimeout": {
|
|
3301
|
+
"type": "number"
|
|
3302
|
+
}
|
|
3603
3303
|
},
|
|
3604
|
-
|
|
3605
|
-
|
|
3606
|
-
}
|
|
3607
|
-
]
|
|
3608
|
-
}
|
|
3609
|
-
},
|
|
3610
|
-
{
|
|
3611
|
-
"in": "query",
|
|
3612
|
-
"name": "record",
|
|
3613
|
-
"schema": {
|
|
3614
|
-
"description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
|
|
3615
|
-
"type": "boolean"
|
|
3616
|
-
}
|
|
3617
|
-
},
|
|
3618
|
-
{
|
|
3619
|
-
"in": "query",
|
|
3620
|
-
"name": "timeout",
|
|
3621
|
-
"schema": {
|
|
3622
|
-
"description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
|
|
3623
|
-
"type": "number"
|
|
3624
|
-
}
|
|
3625
|
-
},
|
|
3626
|
-
{
|
|
3627
|
-
"in": "query",
|
|
3628
|
-
"name": "token",
|
|
3629
|
-
"schema": {
|
|
3630
|
-
"description": "The authorization token",
|
|
3631
|
-
"type": "string"
|
|
3304
|
+
"type": "object"
|
|
3305
|
+
}
|
|
3632
3306
|
}
|
|
3633
3307
|
}
|
|
3634
|
-
],
|
|
3635
|
-
"requestBody": {
|
|
3636
|
-
"content": {}
|
|
3637
3308
|
},
|
|
3638
3309
|
"responses": {
|
|
3639
|
-
"
|
|
3640
|
-
"
|
|
3310
|
+
"200": {
|
|
3311
|
+
"content": {
|
|
3312
|
+
"text/html": {
|
|
3313
|
+
"schema": {
|
|
3314
|
+
"description": "An HTML payload of the website or HTML after JavaScript\nparsing and execution.",
|
|
3315
|
+
"type": "string",
|
|
3316
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
3317
|
+
}
|
|
3318
|
+
}
|
|
3319
|
+
},
|
|
3320
|
+
"description": "An HTML payload of the website or HTML after JavaScript\nparsing and execution."
|
|
3641
3321
|
},
|
|
3642
3322
|
"400": {
|
|
3643
3323
|
"code": 400,
|
|
@@ -3670,16 +3350,16 @@
|
|
|
3670
3350
|
"message": "HTTP/1.1 500 Internal Server Error"
|
|
3671
3351
|
}
|
|
3672
3352
|
},
|
|
3673
|
-
"summary": "/
|
|
3353
|
+
"summary": "/content /chromium/content",
|
|
3674
3354
|
"tags": [
|
|
3675
|
-
"Browser
|
|
3355
|
+
"Browser REST APIs"
|
|
3676
3356
|
]
|
|
3677
3357
|
}
|
|
3678
3358
|
},
|
|
3679
|
-
"/
|
|
3359
|
+
"/download /chromium/download": {
|
|
3680
3360
|
"post": {
|
|
3681
3361
|
"definitions": {},
|
|
3682
|
-
"description": "A JSON-
|
|
3362
|
+
"description": "A JSON or JavaScript content-type API for returning files Chrome has downloaded during\nthe execution of puppeteer code, which is ran inside context of the browser.\nBrowserless sets up a blank page, a fresh download directory, injects your puppeteer code, and then executes it.\nYou can load external libraries via the \"import\" syntax, and import ESM-style modules\nthat are written for execution inside of the browser. Once your script is finished, any\ndownloaded files from Chromium are returned back with the appropriate content-type header.",
|
|
3683
3363
|
"parameters": [
|
|
3684
3364
|
{
|
|
3685
3365
|
"in": "query",
|
|
@@ -3908,15 +3588,15 @@
|
|
|
3908
3588
|
"responses": {
|
|
3909
3589
|
"200": {
|
|
3910
3590
|
"content": {
|
|
3911
|
-
"
|
|
3591
|
+
"*/*": {
|
|
3912
3592
|
"schema": {
|
|
3913
|
-
"description": "
|
|
3593
|
+
"description": "Responses are determined by the returned value of the downloads\nthemselves, so there isn't a static response type for this API.",
|
|
3914
3594
|
"type": "string",
|
|
3915
3595
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
3916
3596
|
}
|
|
3917
3597
|
}
|
|
3918
3598
|
},
|
|
3919
|
-
"description": "
|
|
3599
|
+
"description": "Responses are determined by the returned value of the downloads\nthemselves, so there isn't a static response type for this API."
|
|
3920
3600
|
},
|
|
3921
3601
|
"400": {
|
|
3922
3602
|
"code": 400,
|
|
@@ -3949,16 +3629,16 @@
|
|
|
3949
3629
|
"message": "HTTP/1.1 500 Internal Server Error"
|
|
3950
3630
|
}
|
|
3951
3631
|
},
|
|
3952
|
-
"summary": "/
|
|
3632
|
+
"summary": "/download /chromium/download",
|
|
3953
3633
|
"tags": [
|
|
3954
3634
|
"Browser REST APIs"
|
|
3955
3635
|
]
|
|
3956
3636
|
}
|
|
3957
3637
|
},
|
|
3958
|
-
"/
|
|
3638
|
+
"/function /chromium/function": {
|
|
3959
3639
|
"post": {
|
|
3960
3640
|
"definitions": {},
|
|
3961
|
-
"description": "A JSON or JavaScript content-type API for
|
|
3641
|
+
"description": "A JSON or JavaScript content-type API for running puppeteer code in the browser's context.\nBrowserless sets up a blank page, injects your puppeteer code, and runs it.\nYou can optionally load external libraries via the \"import\" module that are meant for browser usage.\nValues returned from the function are checked and an appropriate content-type and response is sent back\nto your HTTP call.",
|
|
3962
3642
|
"parameters": [
|
|
3963
3643
|
{
|
|
3964
3644
|
"in": "query",
|
|
@@ -3972,7 +3652,6 @@
|
|
|
3972
3652
|
"in": "query",
|
|
3973
3653
|
"name": "launch",
|
|
3974
3654
|
"schema": {
|
|
3975
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
3976
3655
|
"anyOf": [
|
|
3977
3656
|
{
|
|
3978
3657
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -4012,128 +3691,175 @@
|
|
|
4012
3691
|
"content": {
|
|
4013
3692
|
"application/json": {
|
|
4014
3693
|
"schema": {
|
|
4015
|
-
"
|
|
4016
|
-
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
|
|
4026
|
-
|
|
4027
|
-
|
|
4028
|
-
|
|
4029
|
-
|
|
4030
|
-
|
|
4031
|
-
"
|
|
4032
|
-
|
|
4033
|
-
|
|
4034
|
-
|
|
4035
|
-
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
|
|
4045
|
-
|
|
4046
|
-
|
|
4047
|
-
|
|
4048
|
-
|
|
4049
|
-
|
|
4050
|
-
|
|
4051
|
-
|
|
4052
|
-
|
|
4053
|
-
|
|
4054
|
-
|
|
4055
|
-
|
|
4056
|
-
|
|
4057
|
-
|
|
4058
|
-
|
|
4059
|
-
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
|
|
4066
|
-
|
|
4067
|
-
|
|
4068
|
-
|
|
4069
|
-
|
|
4070
|
-
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
|
|
4076
|
-
|
|
4077
|
-
|
|
4078
|
-
|
|
4079
|
-
|
|
4080
|
-
|
|
4081
|
-
|
|
4082
|
-
|
|
4083
|
-
|
|
4084
|
-
|
|
4085
|
-
|
|
4086
|
-
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
|
|
4090
|
-
|
|
4091
|
-
|
|
4092
|
-
|
|
4093
|
-
|
|
4094
|
-
|
|
3694
|
+
"properties": {
|
|
3695
|
+
"addScriptTag": {
|
|
3696
|
+
"type": "array",
|
|
3697
|
+
"items": {
|
|
3698
|
+
"$ref": "#/definitions/FrameAddScriptTagOptions"
|
|
3699
|
+
}
|
|
3700
|
+
},
|
|
3701
|
+
"addStyleTag": {
|
|
3702
|
+
"type": "array",
|
|
3703
|
+
"items": {
|
|
3704
|
+
"$ref": "#/definitions/FrameAddStyleTagOptions"
|
|
3705
|
+
}
|
|
3706
|
+
},
|
|
3707
|
+
"authenticate": {
|
|
3708
|
+
"$ref": "#/definitions/Credentials"
|
|
3709
|
+
},
|
|
3710
|
+
"bestAttempt": {
|
|
3711
|
+
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
3712
|
+
"type": "boolean"
|
|
3713
|
+
},
|
|
3714
|
+
"cookies": {
|
|
3715
|
+
"type": "array",
|
|
3716
|
+
"items": {
|
|
3717
|
+
"$ref": "#/definitions/CookieParam"
|
|
3718
|
+
}
|
|
3719
|
+
},
|
|
3720
|
+
"emulateMediaType": {
|
|
3721
|
+
"type": "string"
|
|
3722
|
+
},
|
|
3723
|
+
"gotoOptions": {
|
|
3724
|
+
"$ref": "#/definitions/GoToOptions"
|
|
3725
|
+
},
|
|
3726
|
+
"html": {
|
|
3727
|
+
"type": "string"
|
|
3728
|
+
},
|
|
3729
|
+
"rejectRequestPattern": {
|
|
3730
|
+
"type": "array",
|
|
3731
|
+
"items": {
|
|
3732
|
+
"type": "string"
|
|
3733
|
+
}
|
|
3734
|
+
},
|
|
3735
|
+
"rejectResourceTypes": {
|
|
3736
|
+
"type": "array",
|
|
3737
|
+
"items": {
|
|
3738
|
+
"enum": [
|
|
3739
|
+
"cspviolationreport",
|
|
3740
|
+
"document",
|
|
3741
|
+
"eventsource",
|
|
3742
|
+
"fetch",
|
|
3743
|
+
"font",
|
|
3744
|
+
"image",
|
|
3745
|
+
"manifest",
|
|
3746
|
+
"media",
|
|
3747
|
+
"other",
|
|
3748
|
+
"ping",
|
|
3749
|
+
"prefetch",
|
|
3750
|
+
"preflight",
|
|
3751
|
+
"script",
|
|
3752
|
+
"signedexchange",
|
|
3753
|
+
"stylesheet",
|
|
3754
|
+
"texttrack",
|
|
3755
|
+
"websocket",
|
|
3756
|
+
"xhr"
|
|
3757
|
+
],
|
|
3758
|
+
"type": "string"
|
|
3759
|
+
}
|
|
3760
|
+
},
|
|
3761
|
+
"requestInterceptors": {
|
|
3762
|
+
"type": "array",
|
|
3763
|
+
"items": {
|
|
3764
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
3765
|
+
"type": "object",
|
|
3766
|
+
"properties": {
|
|
3767
|
+
"pattern": {
|
|
3768
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
3769
|
+
"type": "string"
|
|
3770
|
+
},
|
|
3771
|
+
"response": {
|
|
3772
|
+
"$ref": "#/definitions/Partial<ResponseForRequest>"
|
|
3773
|
+
}
|
|
3774
|
+
},
|
|
3775
|
+
"additionalProperties": false,
|
|
3776
|
+
"required": [
|
|
3777
|
+
"pattern",
|
|
3778
|
+
"response"
|
|
3779
|
+
]
|
|
3780
|
+
}
|
|
3781
|
+
},
|
|
3782
|
+
"setExtraHTTPHeaders": {
|
|
3783
|
+
"$ref": "#/definitions/Record<string,string>"
|
|
3784
|
+
},
|
|
3785
|
+
"setJavaScriptEnabled": {
|
|
3786
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
3787
|
+
"type": "boolean"
|
|
3788
|
+
},
|
|
3789
|
+
"url": {
|
|
3790
|
+
"type": "string"
|
|
3791
|
+
},
|
|
3792
|
+
"userAgent": {
|
|
3793
|
+
"type": "string"
|
|
3794
|
+
},
|
|
3795
|
+
"viewport": {
|
|
3796
|
+
"$ref": "#/definitions/Viewport"
|
|
3797
|
+
},
|
|
3798
|
+
"waitForEvent": {
|
|
3799
|
+
"type": "object",
|
|
3800
|
+
"properties": {
|
|
3801
|
+
"event": {
|
|
3802
|
+
"type": "string"
|
|
3803
|
+
},
|
|
3804
|
+
"timeout": {
|
|
3805
|
+
"type": "number"
|
|
3806
|
+
}
|
|
3807
|
+
},
|
|
3808
|
+
"additionalProperties": false,
|
|
3809
|
+
"required": [
|
|
3810
|
+
"event"
|
|
3811
|
+
]
|
|
3812
|
+
},
|
|
3813
|
+
"waitForFunction": {
|
|
3814
|
+
"type": "object",
|
|
3815
|
+
"properties": {
|
|
3816
|
+
"fn": {
|
|
3817
|
+
"description": "The function, or statement, to be evaluated in browser context",
|
|
3818
|
+
"type": "string"
|
|
3819
|
+
},
|
|
3820
|
+
"polling": {
|
|
3821
|
+
"description": "An interval at which the pageFunction is executed, defaults to raf.\nIf polling is a number, then it is treated as an interval in milliseconds\nat which the function would be executed. If polling is a string,\nthen it can be one of the following values: \"raf\" or \"mutation\"",
|
|
3822
|
+
"type": [
|
|
3823
|
+
"string",
|
|
3824
|
+
"number"
|
|
3825
|
+
]
|
|
3826
|
+
},
|
|
3827
|
+
"timeout": {
|
|
3828
|
+
"description": "Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds).\nPass 0 to disable timeout.",
|
|
3829
|
+
"type": "number"
|
|
3830
|
+
}
|
|
3831
|
+
},
|
|
3832
|
+
"additionalProperties": false,
|
|
3833
|
+
"required": [
|
|
3834
|
+
"fn"
|
|
3835
|
+
]
|
|
3836
|
+
},
|
|
3837
|
+
"waitForSelector": {
|
|
3838
|
+
"type": "object",
|
|
3839
|
+
"properties": {
|
|
3840
|
+
"hidden": {
|
|
3841
|
+
"type": "boolean"
|
|
3842
|
+
},
|
|
3843
|
+
"selector": {
|
|
3844
|
+
"type": "string"
|
|
3845
|
+
},
|
|
3846
|
+
"timeout": {
|
|
3847
|
+
"type": "number"
|
|
3848
|
+
},
|
|
3849
|
+
"visible": {
|
|
3850
|
+
"type": "boolean"
|
|
3851
|
+
}
|
|
3852
|
+
},
|
|
3853
|
+
"additionalProperties": false,
|
|
3854
|
+
"required": [
|
|
3855
|
+
"selector"
|
|
3856
|
+
]
|
|
3857
|
+
},
|
|
3858
|
+
"waitForTimeout": {
|
|
3859
|
+
"type": "number"
|
|
3860
|
+
}
|
|
4095
3861
|
},
|
|
4096
|
-
|
|
4097
|
-
"type": "string"
|
|
4098
|
-
}
|
|
4099
|
-
]
|
|
4100
|
-
}
|
|
4101
|
-
},
|
|
4102
|
-
{
|
|
4103
|
-
"in": "query",
|
|
4104
|
-
"name": "record",
|
|
4105
|
-
"schema": {
|
|
4106
|
-
"description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
|
|
4107
|
-
"type": "boolean"
|
|
4108
|
-
}
|
|
4109
|
-
},
|
|
4110
|
-
{
|
|
4111
|
-
"in": "query",
|
|
4112
|
-
"name": "timeout",
|
|
4113
|
-
"schema": {
|
|
4114
|
-
"description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
|
|
4115
|
-
"type": "number"
|
|
4116
|
-
}
|
|
4117
|
-
},
|
|
4118
|
-
{
|
|
4119
|
-
"in": "query",
|
|
4120
|
-
"name": "token",
|
|
4121
|
-
"schema": {
|
|
4122
|
-
"description": "The authorization token",
|
|
4123
|
-
"type": "string"
|
|
4124
|
-
}
|
|
4125
|
-
}
|
|
4126
|
-
],
|
|
4127
|
-
"requestBody": {
|
|
4128
|
-
"content": {
|
|
4129
|
-
"application/json": {
|
|
4130
|
-
"schema": {
|
|
4131
|
-
"$ref": "#/definitions/JSONSchema"
|
|
4132
|
-
}
|
|
4133
|
-
},
|
|
4134
|
-
"application/javascript": {
|
|
4135
|
-
"schema": {
|
|
4136
|
-
"type": "string"
|
|
3862
|
+
"type": "object"
|
|
4137
3863
|
}
|
|
4138
3864
|
}
|
|
4139
3865
|
}
|
|
@@ -4144,6 +3870,7 @@
|
|
|
4144
3870
|
"*/*": {
|
|
4145
3871
|
"schema": {
|
|
4146
3872
|
"description": "Responses are determined by the returned value of the function\nitself. Binary responses (PDF's, screenshots) are returned back\nas binary data, and primitive JavaScript values are returned back\nby type (HTML data is \"text/html\", Objects are \"application/json\")",
|
|
3873
|
+
"type": "string",
|
|
4147
3874
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
4148
3875
|
}
|
|
4149
3876
|
}
|
|
@@ -4204,7 +3931,6 @@
|
|
|
4204
3931
|
"in": "query",
|
|
4205
3932
|
"name": "launch",
|
|
4206
3933
|
"schema": {
|
|
4207
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
4208
3934
|
"anyOf": [
|
|
4209
3935
|
{
|
|
4210
3936
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -4264,9 +3990,6 @@
|
|
|
4264
3990
|
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
4265
3991
|
"type": "boolean"
|
|
4266
3992
|
},
|
|
4267
|
-
"blockModals": {
|
|
4268
|
-
"type": "boolean"
|
|
4269
|
-
},
|
|
4270
3993
|
"cookies": {
|
|
4271
3994
|
"type": "array",
|
|
4272
3995
|
"items": {
|
|
@@ -4282,9 +4005,6 @@
|
|
|
4282
4005
|
"html": {
|
|
4283
4006
|
"type": "string"
|
|
4284
4007
|
},
|
|
4285
|
-
"options": {
|
|
4286
|
-
"$ref": "#/definitions/PDFOptions"
|
|
4287
|
-
},
|
|
4288
4008
|
"rejectRequestPattern": {
|
|
4289
4009
|
"type": "array",
|
|
4290
4010
|
"items": {
|
|
@@ -4342,6 +4062,7 @@
|
|
|
4342
4062
|
"$ref": "#/definitions/Record<string,string>"
|
|
4343
4063
|
},
|
|
4344
4064
|
"setJavaScriptEnabled": {
|
|
4065
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
4345
4066
|
"type": "boolean"
|
|
4346
4067
|
},
|
|
4347
4068
|
"url": {
|
|
@@ -4489,7 +4210,6 @@
|
|
|
4489
4210
|
"in": "query",
|
|
4490
4211
|
"name": "launch",
|
|
4491
4212
|
"schema": {
|
|
4492
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
4493
4213
|
"anyOf": [
|
|
4494
4214
|
{
|
|
4495
4215
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -4530,21 +4250,171 @@
|
|
|
4530
4250
|
"application/json": {
|
|
4531
4251
|
"schema": {
|
|
4532
4252
|
"properties": {
|
|
4533
|
-
"
|
|
4253
|
+
"addScriptTag": {
|
|
4254
|
+
"type": "array",
|
|
4255
|
+
"items": {
|
|
4256
|
+
"$ref": "#/definitions/FrameAddScriptTagOptions"
|
|
4257
|
+
}
|
|
4258
|
+
},
|
|
4259
|
+
"addStyleTag": {
|
|
4260
|
+
"type": "array",
|
|
4261
|
+
"items": {
|
|
4262
|
+
"$ref": "#/definitions/FrameAddStyleTagOptions"
|
|
4263
|
+
}
|
|
4264
|
+
},
|
|
4265
|
+
"authenticate": {
|
|
4266
|
+
"$ref": "#/definitions/Credentials"
|
|
4267
|
+
},
|
|
4268
|
+
"bestAttempt": {
|
|
4269
|
+
"description": "When bestAttempt is set to true, browserless attempt to proceed\nwhen \"awaited\" events fail or timeout. This includes things like\ngoto, waitForSelector, and more.",
|
|
4270
|
+
"type": "boolean"
|
|
4271
|
+
},
|
|
4272
|
+
"cookies": {
|
|
4273
|
+
"type": "array",
|
|
4274
|
+
"items": {
|
|
4275
|
+
"$ref": "#/definitions/CookieParam"
|
|
4276
|
+
}
|
|
4277
|
+
},
|
|
4278
|
+
"emulateMediaType": {
|
|
4279
|
+
"type": "string"
|
|
4280
|
+
},
|
|
4281
|
+
"gotoOptions": {
|
|
4282
|
+
"$ref": "#/definitions/GoToOptions"
|
|
4283
|
+
},
|
|
4284
|
+
"html": {
|
|
4285
|
+
"type": "string"
|
|
4286
|
+
},
|
|
4287
|
+
"rejectRequestPattern": {
|
|
4288
|
+
"type": "array",
|
|
4289
|
+
"items": {
|
|
4290
|
+
"type": "string"
|
|
4291
|
+
}
|
|
4292
|
+
},
|
|
4293
|
+
"rejectResourceTypes": {
|
|
4294
|
+
"type": "array",
|
|
4295
|
+
"items": {
|
|
4296
|
+
"enum": [
|
|
4297
|
+
"cspviolationreport",
|
|
4298
|
+
"document",
|
|
4299
|
+
"eventsource",
|
|
4300
|
+
"fetch",
|
|
4301
|
+
"font",
|
|
4302
|
+
"image",
|
|
4303
|
+
"manifest",
|
|
4304
|
+
"media",
|
|
4305
|
+
"other",
|
|
4306
|
+
"ping",
|
|
4307
|
+
"prefetch",
|
|
4308
|
+
"preflight",
|
|
4309
|
+
"script",
|
|
4310
|
+
"signedexchange",
|
|
4311
|
+
"stylesheet",
|
|
4312
|
+
"texttrack",
|
|
4313
|
+
"websocket",
|
|
4314
|
+
"xhr"
|
|
4315
|
+
],
|
|
4316
|
+
"type": "string"
|
|
4317
|
+
}
|
|
4318
|
+
},
|
|
4319
|
+
"requestInterceptors": {
|
|
4534
4320
|
"type": "array",
|
|
4535
4321
|
"items": {
|
|
4322
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
4536
4323
|
"type": "object",
|
|
4537
|
-
"properties": {
|
|
4538
|
-
|
|
4324
|
+
"properties": {
|
|
4325
|
+
"pattern": {
|
|
4326
|
+
"description": "An array of patterns (using `req.url().match(r.pattern)` to match) and their\ncorresponding responses to use in order to fulfill those requests.",
|
|
4327
|
+
"type": "string"
|
|
4328
|
+
},
|
|
4329
|
+
"response": {
|
|
4330
|
+
"$ref": "#/definitions/Partial<ResponseForRequest>"
|
|
4331
|
+
}
|
|
4332
|
+
},
|
|
4333
|
+
"additionalProperties": false,
|
|
4334
|
+
"required": [
|
|
4335
|
+
"pattern",
|
|
4336
|
+
"response"
|
|
4337
|
+
]
|
|
4539
4338
|
}
|
|
4540
4339
|
},
|
|
4541
|
-
"
|
|
4340
|
+
"setExtraHTTPHeaders": {
|
|
4341
|
+
"$ref": "#/definitions/Record<string,string>"
|
|
4342
|
+
},
|
|
4343
|
+
"setJavaScriptEnabled": {
|
|
4344
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
4345
|
+
"type": "boolean"
|
|
4346
|
+
},
|
|
4347
|
+
"url": {
|
|
4348
|
+
"type": "string"
|
|
4349
|
+
},
|
|
4350
|
+
"userAgent": {
|
|
4351
|
+
"type": "string"
|
|
4352
|
+
},
|
|
4353
|
+
"viewport": {
|
|
4354
|
+
"$ref": "#/definitions/Viewport"
|
|
4355
|
+
},
|
|
4356
|
+
"waitForEvent": {
|
|
4357
|
+
"type": "object",
|
|
4358
|
+
"properties": {
|
|
4359
|
+
"event": {
|
|
4360
|
+
"type": "string"
|
|
4361
|
+
},
|
|
4362
|
+
"timeout": {
|
|
4363
|
+
"type": "number"
|
|
4364
|
+
}
|
|
4365
|
+
},
|
|
4366
|
+
"additionalProperties": false,
|
|
4367
|
+
"required": [
|
|
4368
|
+
"event"
|
|
4369
|
+
]
|
|
4370
|
+
},
|
|
4371
|
+
"waitForFunction": {
|
|
4372
|
+
"type": "object",
|
|
4373
|
+
"properties": {
|
|
4374
|
+
"fn": {
|
|
4375
|
+
"description": "The function, or statement, to be evaluated in browser context",
|
|
4376
|
+
"type": "string"
|
|
4377
|
+
},
|
|
4378
|
+
"polling": {
|
|
4379
|
+
"description": "An interval at which the pageFunction is executed, defaults to raf.\nIf polling is a number, then it is treated as an interval in milliseconds\nat which the function would be executed. If polling is a string,\nthen it can be one of the following values: \"raf\" or \"mutation\"",
|
|
4380
|
+
"type": [
|
|
4381
|
+
"string",
|
|
4382
|
+
"number"
|
|
4383
|
+
]
|
|
4384
|
+
},
|
|
4385
|
+
"timeout": {
|
|
4386
|
+
"description": "Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds).\nPass 0 to disable timeout.",
|
|
4387
|
+
"type": "number"
|
|
4388
|
+
}
|
|
4389
|
+
},
|
|
4390
|
+
"additionalProperties": false,
|
|
4391
|
+
"required": [
|
|
4392
|
+
"fn"
|
|
4393
|
+
]
|
|
4394
|
+
},
|
|
4395
|
+
"waitForSelector": {
|
|
4542
4396
|
"type": "object",
|
|
4543
|
-
"properties": {
|
|
4544
|
-
|
|
4397
|
+
"properties": {
|
|
4398
|
+
"hidden": {
|
|
4399
|
+
"type": "boolean"
|
|
4400
|
+
},
|
|
4401
|
+
"selector": {
|
|
4402
|
+
"type": "string"
|
|
4403
|
+
},
|
|
4404
|
+
"timeout": {
|
|
4405
|
+
"type": "number"
|
|
4406
|
+
},
|
|
4407
|
+
"visible": {
|
|
4408
|
+
"type": "boolean"
|
|
4409
|
+
}
|
|
4410
|
+
},
|
|
4411
|
+
"additionalProperties": false,
|
|
4412
|
+
"required": [
|
|
4413
|
+
"selector"
|
|
4414
|
+
]
|
|
4545
4415
|
},
|
|
4546
|
-
"
|
|
4547
|
-
"type": "
|
|
4416
|
+
"waitForTimeout": {
|
|
4417
|
+
"type": "number"
|
|
4548
4418
|
}
|
|
4549
4419
|
},
|
|
4550
4420
|
"type": "object"
|
|
@@ -4558,9 +4428,7 @@
|
|
|
4558
4428
|
"application/json": {
|
|
4559
4429
|
"schema": {
|
|
4560
4430
|
"description": "The response of the lighthouse stats. Response objects are\ndetermined by the type of budgets and config in the POST\nJSON body",
|
|
4561
|
-
"type": "
|
|
4562
|
-
"properties": {},
|
|
4563
|
-
"additionalProperties": true,
|
|
4431
|
+
"type": "string",
|
|
4564
4432
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
4565
4433
|
}
|
|
4566
4434
|
}
|
|
@@ -4686,15 +4554,6 @@
|
|
|
4686
4554
|
"$ref": "#/definitions/CookieParam"
|
|
4687
4555
|
}
|
|
4688
4556
|
},
|
|
4689
|
-
"debugOpts": {
|
|
4690
|
-
"$ref": "#/definitions/ScrapeDebugOptions"
|
|
4691
|
-
},
|
|
4692
|
-
"elements": {
|
|
4693
|
-
"type": "array",
|
|
4694
|
-
"items": {
|
|
4695
|
-
"$ref": "#/definitions/ScrapeElementSelector"
|
|
4696
|
-
}
|
|
4697
|
-
},
|
|
4698
4557
|
"emulateMediaType": {
|
|
4699
4558
|
"type": "string"
|
|
4700
4559
|
},
|
|
@@ -4761,6 +4620,7 @@
|
|
|
4761
4620
|
"$ref": "#/definitions/Record<string,string>"
|
|
4762
4621
|
},
|
|
4763
4622
|
"setJavaScriptEnabled": {
|
|
4623
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
4764
4624
|
"type": "boolean"
|
|
4765
4625
|
},
|
|
4766
4626
|
"url": {
|
|
@@ -4847,311 +4707,7 @@
|
|
|
4847
4707
|
"application/json": {
|
|
4848
4708
|
"schema": {
|
|
4849
4709
|
"description": "The JSON response body",
|
|
4850
|
-
"type": "
|
|
4851
|
-
"properties": {
|
|
4852
|
-
"data": {
|
|
4853
|
-
"anyOf": [
|
|
4854
|
-
{
|
|
4855
|
-
"type": "array",
|
|
4856
|
-
"items": {
|
|
4857
|
-
"type": "object",
|
|
4858
|
-
"properties": {
|
|
4859
|
-
"results": {
|
|
4860
|
-
"type": "array",
|
|
4861
|
-
"items": {
|
|
4862
|
-
"type": "object",
|
|
4863
|
-
"properties": {
|
|
4864
|
-
"attributes": {
|
|
4865
|
-
"description": "A list of HTML attributes of the element",
|
|
4866
|
-
"type": "array",
|
|
4867
|
-
"items": {
|
|
4868
|
-
"type": "object",
|
|
4869
|
-
"properties": {
|
|
4870
|
-
"name": {
|
|
4871
|
-
"description": "The name of the HTML attribute for the element",
|
|
4872
|
-
"type": "string"
|
|
4873
|
-
},
|
|
4874
|
-
"value": {
|
|
4875
|
-
"description": "The value of the HTML attribute for the element",
|
|
4876
|
-
"type": "string"
|
|
4877
|
-
}
|
|
4878
|
-
},
|
|
4879
|
-
"additionalProperties": false,
|
|
4880
|
-
"required": [
|
|
4881
|
-
"name",
|
|
4882
|
-
"value"
|
|
4883
|
-
]
|
|
4884
|
-
}
|
|
4885
|
-
},
|
|
4886
|
-
"height": {
|
|
4887
|
-
"description": "The height the element",
|
|
4888
|
-
"type": "number"
|
|
4889
|
-
},
|
|
4890
|
-
"html": {
|
|
4891
|
-
"description": "The HTML the element",
|
|
4892
|
-
"type": "string"
|
|
4893
|
-
},
|
|
4894
|
-
"left": {
|
|
4895
|
-
"description": "The amount of pixels from the left of the page",
|
|
4896
|
-
"type": "number"
|
|
4897
|
-
},
|
|
4898
|
-
"text": {
|
|
4899
|
-
"description": "The text the element",
|
|
4900
|
-
"type": "string"
|
|
4901
|
-
},
|
|
4902
|
-
"top": {
|
|
4903
|
-
"description": "The amount of pixels from the top of the page",
|
|
4904
|
-
"type": "number"
|
|
4905
|
-
},
|
|
4906
|
-
"width": {
|
|
4907
|
-
"description": "The width the element",
|
|
4908
|
-
"type": "number"
|
|
4909
|
-
}
|
|
4910
|
-
},
|
|
4911
|
-
"additionalProperties": false,
|
|
4912
|
-
"required": [
|
|
4913
|
-
"attributes",
|
|
4914
|
-
"height",
|
|
4915
|
-
"html",
|
|
4916
|
-
"left",
|
|
4917
|
-
"text",
|
|
4918
|
-
"top",
|
|
4919
|
-
"width"
|
|
4920
|
-
]
|
|
4921
|
-
}
|
|
4922
|
-
},
|
|
4923
|
-
"selector": {
|
|
4924
|
-
"description": "The DOM selector of the element",
|
|
4925
|
-
"type": "string"
|
|
4926
|
-
}
|
|
4927
|
-
},
|
|
4928
|
-
"additionalProperties": false,
|
|
4929
|
-
"required": [
|
|
4930
|
-
"results",
|
|
4931
|
-
"selector"
|
|
4932
|
-
]
|
|
4933
|
-
}
|
|
4934
|
-
},
|
|
4935
|
-
{
|
|
4936
|
-
"type": "null"
|
|
4937
|
-
}
|
|
4938
|
-
]
|
|
4939
|
-
},
|
|
4940
|
-
"debug": {
|
|
4941
|
-
"description": "When debugOpts options are present, results are here",
|
|
4942
|
-
"anyOf": [
|
|
4943
|
-
{
|
|
4944
|
-
"type": "object",
|
|
4945
|
-
"properties": {
|
|
4946
|
-
"console": {
|
|
4947
|
-
"description": "A list of console messages from the browser",
|
|
4948
|
-
"type": "array",
|
|
4949
|
-
"items": {
|
|
4950
|
-
"type": "string"
|
|
4951
|
-
}
|
|
4952
|
-
},
|
|
4953
|
-
"cookies": {
|
|
4954
|
-
"description": "List of cookies for the site or null",
|
|
4955
|
-
"anyOf": [
|
|
4956
|
-
{
|
|
4957
|
-
"type": "array",
|
|
4958
|
-
"items": {
|
|
4959
|
-
"$ref": "#/definitions/Cookie"
|
|
4960
|
-
}
|
|
4961
|
-
},
|
|
4962
|
-
{
|
|
4963
|
-
"type": "null"
|
|
4964
|
-
}
|
|
4965
|
-
]
|
|
4966
|
-
},
|
|
4967
|
-
"html": {
|
|
4968
|
-
"description": "The HTML string of the website or null",
|
|
4969
|
-
"type": [
|
|
4970
|
-
"null",
|
|
4971
|
-
"string"
|
|
4972
|
-
]
|
|
4973
|
-
},
|
|
4974
|
-
"network": {
|
|
4975
|
-
"type": "object",
|
|
4976
|
-
"properties": {
|
|
4977
|
-
"inbound": {
|
|
4978
|
-
"type": "array",
|
|
4979
|
-
"items": {
|
|
4980
|
-
"$ref": "#/definitions/InBoundRequest"
|
|
4981
|
-
}
|
|
4982
|
-
},
|
|
4983
|
-
"outbound": {
|
|
4984
|
-
"type": "array",
|
|
4985
|
-
"items": {
|
|
4986
|
-
"$ref": "#/definitions/OutBoundRequest"
|
|
4987
|
-
}
|
|
4988
|
-
}
|
|
4989
|
-
},
|
|
4990
|
-
"additionalProperties": false,
|
|
4991
|
-
"required": [
|
|
4992
|
-
"inbound",
|
|
4993
|
-
"outbound"
|
|
4994
|
-
]
|
|
4995
|
-
},
|
|
4996
|
-
"screenshot": {
|
|
4997
|
-
"description": "A base64-encoded string of the site or null",
|
|
4998
|
-
"type": [
|
|
4999
|
-
"null",
|
|
5000
|
-
"string"
|
|
5001
|
-
]
|
|
5002
|
-
}
|
|
5003
|
-
},
|
|
5004
|
-
"additionalProperties": false,
|
|
5005
|
-
"required": [
|
|
5006
|
-
"console",
|
|
5007
|
-
"cookies",
|
|
5008
|
-
"html",
|
|
5009
|
-
"network",
|
|
5010
|
-
"screenshot"
|
|
5011
|
-
]
|
|
5012
|
-
},
|
|
5013
|
-
{
|
|
5014
|
-
"type": "null"
|
|
5015
|
-
}
|
|
5016
|
-
]
|
|
5017
|
-
}
|
|
5018
|
-
},
|
|
5019
|
-
"additionalProperties": false,
|
|
5020
|
-
"required": [
|
|
5021
|
-
"data",
|
|
5022
|
-
"debug"
|
|
5023
|
-
],
|
|
5024
|
-
"definitions": {
|
|
5025
|
-
"Cookie": {
|
|
5026
|
-
"description": "Represents a cookie object.",
|
|
5027
|
-
"type": "object",
|
|
5028
|
-
"properties": {
|
|
5029
|
-
"name": {
|
|
5030
|
-
"description": "Cookie name.",
|
|
5031
|
-
"type": "string"
|
|
5032
|
-
},
|
|
5033
|
-
"value": {
|
|
5034
|
-
"description": "Cookie value.",
|
|
5035
|
-
"type": "string"
|
|
5036
|
-
},
|
|
5037
|
-
"domain": {
|
|
5038
|
-
"description": "Cookie domain.",
|
|
5039
|
-
"type": "string"
|
|
5040
|
-
},
|
|
5041
|
-
"path": {
|
|
5042
|
-
"description": "Cookie path.",
|
|
5043
|
-
"type": "string"
|
|
5044
|
-
},
|
|
5045
|
-
"expires": {
|
|
5046
|
-
"description": "Cookie expiration date as the number of seconds since the UNIX epoch. Set to `-1` for\nsession cookies",
|
|
5047
|
-
"type": "number"
|
|
5048
|
-
},
|
|
5049
|
-
"size": {
|
|
5050
|
-
"description": "Cookie size.",
|
|
5051
|
-
"type": "number"
|
|
5052
|
-
},
|
|
5053
|
-
"httpOnly": {
|
|
5054
|
-
"description": "True if cookie is http-only.",
|
|
5055
|
-
"type": "boolean"
|
|
5056
|
-
},
|
|
5057
|
-
"secure": {
|
|
5058
|
-
"description": "True if cookie is secure.",
|
|
5059
|
-
"type": "boolean"
|
|
5060
|
-
},
|
|
5061
|
-
"session": {
|
|
5062
|
-
"description": "True in case of session cookie.",
|
|
5063
|
-
"type": "boolean"
|
|
5064
|
-
},
|
|
5065
|
-
"sameSite": {
|
|
5066
|
-
"description": "Cookie SameSite type.",
|
|
5067
|
-
"enum": [
|
|
5068
|
-
"Lax",
|
|
5069
|
-
"None",
|
|
5070
|
-
"Strict"
|
|
5071
|
-
],
|
|
5072
|
-
"type": "string"
|
|
5073
|
-
},
|
|
5074
|
-
"priority": {
|
|
5075
|
-
"description": "Cookie Priority. Supported only in Chrome.",
|
|
5076
|
-
"enum": [
|
|
5077
|
-
"High",
|
|
5078
|
-
"Low",
|
|
5079
|
-
"Medium"
|
|
5080
|
-
],
|
|
5081
|
-
"type": "string"
|
|
5082
|
-
},
|
|
5083
|
-
"sameParty": {
|
|
5084
|
-
"description": "True if cookie is SameParty. Supported only in Chrome.",
|
|
5085
|
-
"type": "boolean"
|
|
5086
|
-
},
|
|
5087
|
-
"sourceScheme": {
|
|
5088
|
-
"description": "Cookie source scheme type. Supported only in Chrome.",
|
|
5089
|
-
"enum": [
|
|
5090
|
-
"NonSecure",
|
|
5091
|
-
"Secure",
|
|
5092
|
-
"Unset"
|
|
5093
|
-
],
|
|
5094
|
-
"type": "string"
|
|
5095
|
-
},
|
|
5096
|
-
"partitionKey": {
|
|
5097
|
-
"description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. Supported only in Chrome.",
|
|
5098
|
-
"type": "string"
|
|
5099
|
-
},
|
|
5100
|
-
"partitionKeyOpaque": {
|
|
5101
|
-
"description": "True if cookie partition key is opaque. Supported only in Chrome.",
|
|
5102
|
-
"type": "boolean"
|
|
5103
|
-
}
|
|
5104
|
-
},
|
|
5105
|
-
"additionalProperties": false,
|
|
5106
|
-
"required": [
|
|
5107
|
-
"domain",
|
|
5108
|
-
"expires",
|
|
5109
|
-
"httpOnly",
|
|
5110
|
-
"name",
|
|
5111
|
-
"path",
|
|
5112
|
-
"secure",
|
|
5113
|
-
"session",
|
|
5114
|
-
"size",
|
|
5115
|
-
"value"
|
|
5116
|
-
]
|
|
5117
|
-
},
|
|
5118
|
-
"InBoundRequest": {
|
|
5119
|
-
"type": "object",
|
|
5120
|
-
"properties": {
|
|
5121
|
-
"headers": {},
|
|
5122
|
-
"status": {
|
|
5123
|
-
"type": "number"
|
|
5124
|
-
},
|
|
5125
|
-
"url": {
|
|
5126
|
-
"type": "string"
|
|
5127
|
-
}
|
|
5128
|
-
},
|
|
5129
|
-
"additionalProperties": false,
|
|
5130
|
-
"required": [
|
|
5131
|
-
"headers",
|
|
5132
|
-
"status",
|
|
5133
|
-
"url"
|
|
5134
|
-
]
|
|
5135
|
-
},
|
|
5136
|
-
"OutBoundRequest": {
|
|
5137
|
-
"type": "object",
|
|
5138
|
-
"properties": {
|
|
5139
|
-
"headers": {},
|
|
5140
|
-
"method": {
|
|
5141
|
-
"type": "string"
|
|
5142
|
-
},
|
|
5143
|
-
"url": {
|
|
5144
|
-
"type": "string"
|
|
5145
|
-
}
|
|
5146
|
-
},
|
|
5147
|
-
"additionalProperties": false,
|
|
5148
|
-
"required": [
|
|
5149
|
-
"headers",
|
|
5150
|
-
"method",
|
|
5151
|
-
"url"
|
|
5152
|
-
]
|
|
5153
|
-
}
|
|
5154
|
-
},
|
|
4710
|
+
"type": "string",
|
|
5155
4711
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
5156
4712
|
}
|
|
5157
4713
|
}
|
|
@@ -5212,7 +4768,6 @@
|
|
|
5212
4768
|
"in": "query",
|
|
5213
4769
|
"name": "launch",
|
|
5214
4770
|
"schema": {
|
|
5215
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
5216
4771
|
"anyOf": [
|
|
5217
4772
|
{
|
|
5218
4773
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -5287,9 +4842,6 @@
|
|
|
5287
4842
|
"html": {
|
|
5288
4843
|
"type": "string"
|
|
5289
4844
|
},
|
|
5290
|
-
"options": {
|
|
5291
|
-
"$ref": "#/definitions/ScreenshotOptions"
|
|
5292
|
-
},
|
|
5293
4845
|
"rejectRequestPattern": {
|
|
5294
4846
|
"type": "array",
|
|
5295
4847
|
"items": {
|
|
@@ -5343,16 +4895,11 @@
|
|
|
5343
4895
|
]
|
|
5344
4896
|
}
|
|
5345
4897
|
},
|
|
5346
|
-
"scrollPage": {
|
|
5347
|
-
"type": "boolean"
|
|
5348
|
-
},
|
|
5349
|
-
"selector": {
|
|
5350
|
-
"type": "string"
|
|
5351
|
-
},
|
|
5352
4898
|
"setExtraHTTPHeaders": {
|
|
5353
4899
|
"$ref": "#/definitions/Record<string,string>"
|
|
5354
4900
|
},
|
|
5355
4901
|
"setJavaScriptEnabled": {
|
|
4902
|
+
"description": "Whether or not to allow JavaScript to run on the page.",
|
|
5356
4903
|
"type": "boolean"
|
|
5357
4904
|
},
|
|
5358
4905
|
"url": {
|
|
@@ -5508,7 +5055,6 @@
|
|
|
5508
5055
|
"in": "query",
|
|
5509
5056
|
"name": "launch",
|
|
5510
5057
|
"schema": {
|
|
5511
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
5512
5058
|
"anyOf": [
|
|
5513
5059
|
{
|
|
5514
5060
|
"$ref": "#/definitions/CDPLaunchOptions"
|
|
@@ -5605,10 +5151,9 @@
|
|
|
5605
5151
|
"in": "query",
|
|
5606
5152
|
"name": "launch",
|
|
5607
5153
|
"schema": {
|
|
5608
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
5609
5154
|
"anyOf": [
|
|
5610
5155
|
{
|
|
5611
|
-
"$ref": "#/definitions/
|
|
5156
|
+
"$ref": "#/definitions/CDPLaunchOptions"
|
|
5612
5157
|
},
|
|
5613
5158
|
{
|
|
5614
5159
|
"type": "string"
|
|
@@ -5702,10 +5247,9 @@
|
|
|
5702
5247
|
"in": "query",
|
|
5703
5248
|
"name": "launch",
|
|
5704
5249
|
"schema": {
|
|
5705
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
5706
5250
|
"anyOf": [
|
|
5707
5251
|
{
|
|
5708
|
-
"$ref": "#/definitions/
|
|
5252
|
+
"$ref": "#/definitions/CDPLaunchOptions"
|
|
5709
5253
|
},
|
|
5710
5254
|
{
|
|
5711
5255
|
"type": "string"
|
|
@@ -5795,110 +5339,7 @@
|
|
|
5795
5339
|
"content": {
|
|
5796
5340
|
"application/json": {
|
|
5797
5341
|
"schema": {
|
|
5798
|
-
"type": "
|
|
5799
|
-
"properties": {
|
|
5800
|
-
"allowCORS": {
|
|
5801
|
-
"type": "boolean"
|
|
5802
|
-
},
|
|
5803
|
-
"allowFileProtocol": {
|
|
5804
|
-
"type": "boolean"
|
|
5805
|
-
},
|
|
5806
|
-
"allowGetCalls": {
|
|
5807
|
-
"type": "boolean"
|
|
5808
|
-
},
|
|
5809
|
-
"concurrent": {
|
|
5810
|
-
"type": "number"
|
|
5811
|
-
},
|
|
5812
|
-
"data": {
|
|
5813
|
-
"type": "string"
|
|
5814
|
-
},
|
|
5815
|
-
"debug": {
|
|
5816
|
-
"type": "string"
|
|
5817
|
-
},
|
|
5818
|
-
"errorAlertURL": {
|
|
5819
|
-
"type": [
|
|
5820
|
-
"null",
|
|
5821
|
-
"string"
|
|
5822
|
-
]
|
|
5823
|
-
},
|
|
5824
|
-
"healthFailureURL": {
|
|
5825
|
-
"type": [
|
|
5826
|
-
"null",
|
|
5827
|
-
"string"
|
|
5828
|
-
]
|
|
5829
|
-
},
|
|
5830
|
-
"host": {
|
|
5831
|
-
"type": "string"
|
|
5832
|
-
},
|
|
5833
|
-
"maxCPU": {
|
|
5834
|
-
"type": "number"
|
|
5835
|
-
},
|
|
5836
|
-
"maxMemory": {
|
|
5837
|
-
"type": "number"
|
|
5838
|
-
},
|
|
5839
|
-
"metricsJSONPath": {
|
|
5840
|
-
"type": "string"
|
|
5841
|
-
},
|
|
5842
|
-
"port": {
|
|
5843
|
-
"type": "number"
|
|
5844
|
-
},
|
|
5845
|
-
"queued": {
|
|
5846
|
-
"type": "number"
|
|
5847
|
-
},
|
|
5848
|
-
"queuedAlertURL": {
|
|
5849
|
-
"type": [
|
|
5850
|
-
"null",
|
|
5851
|
-
"string"
|
|
5852
|
-
]
|
|
5853
|
-
},
|
|
5854
|
-
"rejectAlertURL": {
|
|
5855
|
-
"type": [
|
|
5856
|
-
"null",
|
|
5857
|
-
"string"
|
|
5858
|
-
]
|
|
5859
|
-
},
|
|
5860
|
-
"retries": {
|
|
5861
|
-
"type": "number"
|
|
5862
|
-
},
|
|
5863
|
-
"timeout": {
|
|
5864
|
-
"type": "number"
|
|
5865
|
-
},
|
|
5866
|
-
"timeoutAlertURL": {
|
|
5867
|
-
"type": [
|
|
5868
|
-
"null",
|
|
5869
|
-
"string"
|
|
5870
|
-
]
|
|
5871
|
-
},
|
|
5872
|
-
"token": {
|
|
5873
|
-
"type": [
|
|
5874
|
-
"null",
|
|
5875
|
-
"string"
|
|
5876
|
-
]
|
|
5877
|
-
}
|
|
5878
|
-
},
|
|
5879
|
-
"additionalProperties": false,
|
|
5880
|
-
"required": [
|
|
5881
|
-
"allowCORS",
|
|
5882
|
-
"allowFileProtocol",
|
|
5883
|
-
"allowGetCalls",
|
|
5884
|
-
"concurrent",
|
|
5885
|
-
"data",
|
|
5886
|
-
"debug",
|
|
5887
|
-
"errorAlertURL",
|
|
5888
|
-
"healthFailureURL",
|
|
5889
|
-
"host",
|
|
5890
|
-
"maxCPU",
|
|
5891
|
-
"maxMemory",
|
|
5892
|
-
"metricsJSONPath",
|
|
5893
|
-
"port",
|
|
5894
|
-
"queued",
|
|
5895
|
-
"queuedAlertURL",
|
|
5896
|
-
"rejectAlertURL",
|
|
5897
|
-
"retries",
|
|
5898
|
-
"timeout",
|
|
5899
|
-
"timeoutAlertURL",
|
|
5900
|
-
"token"
|
|
5901
|
-
],
|
|
5342
|
+
"type": "string",
|
|
5902
5343
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
5903
5344
|
}
|
|
5904
5345
|
}
|
|
@@ -5956,75 +5397,7 @@
|
|
|
5956
5397
|
"content": {
|
|
5957
5398
|
"application/json": {
|
|
5958
5399
|
"schema": {
|
|
5959
|
-
"type": "
|
|
5960
|
-
"properties": {
|
|
5961
|
-
"error": {
|
|
5962
|
-
"type": "number"
|
|
5963
|
-
},
|
|
5964
|
-
"estimatedMonthlyUnits": {
|
|
5965
|
-
"type": "number"
|
|
5966
|
-
},
|
|
5967
|
-
"maxConcurrent": {
|
|
5968
|
-
"type": "number"
|
|
5969
|
-
},
|
|
5970
|
-
"maxTime": {
|
|
5971
|
-
"type": "number"
|
|
5972
|
-
},
|
|
5973
|
-
"meanTime": {
|
|
5974
|
-
"type": "number"
|
|
5975
|
-
},
|
|
5976
|
-
"minTime": {
|
|
5977
|
-
"type": "number"
|
|
5978
|
-
},
|
|
5979
|
-
"minutesOfMetricsAvailable": {
|
|
5980
|
-
"type": "number"
|
|
5981
|
-
},
|
|
5982
|
-
"queued": {
|
|
5983
|
-
"type": "number"
|
|
5984
|
-
},
|
|
5985
|
-
"rejected": {
|
|
5986
|
-
"type": "number"
|
|
5987
|
-
},
|
|
5988
|
-
"sessionTimes": {
|
|
5989
|
-
"type": "array",
|
|
5990
|
-
"items": {
|
|
5991
|
-
"type": "number"
|
|
5992
|
-
}
|
|
5993
|
-
},
|
|
5994
|
-
"successful": {
|
|
5995
|
-
"type": "number"
|
|
5996
|
-
},
|
|
5997
|
-
"timedout": {
|
|
5998
|
-
"type": "number"
|
|
5999
|
-
},
|
|
6000
|
-
"totalTime": {
|
|
6001
|
-
"type": "number"
|
|
6002
|
-
},
|
|
6003
|
-
"unhealthy": {
|
|
6004
|
-
"type": "number"
|
|
6005
|
-
},
|
|
6006
|
-
"units": {
|
|
6007
|
-
"type": "number"
|
|
6008
|
-
}
|
|
6009
|
-
},
|
|
6010
|
-
"additionalProperties": false,
|
|
6011
|
-
"required": [
|
|
6012
|
-
"error",
|
|
6013
|
-
"estimatedMonthlyUnits",
|
|
6014
|
-
"maxConcurrent",
|
|
6015
|
-
"maxTime",
|
|
6016
|
-
"meanTime",
|
|
6017
|
-
"minTime",
|
|
6018
|
-
"minutesOfMetricsAvailable",
|
|
6019
|
-
"queued",
|
|
6020
|
-
"rejected",
|
|
6021
|
-
"sessionTimes",
|
|
6022
|
-
"successful",
|
|
6023
|
-
"timedout",
|
|
6024
|
-
"totalTime",
|
|
6025
|
-
"unhealthy",
|
|
6026
|
-
"units"
|
|
6027
|
-
],
|
|
5400
|
+
"type": "string",
|
|
6028
5401
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
6029
5402
|
}
|
|
6030
5403
|
}
|
|
@@ -6082,97 +5455,7 @@
|
|
|
6082
5455
|
"content": {
|
|
6083
5456
|
"application/json": {
|
|
6084
5457
|
"schema": {
|
|
6085
|
-
"type": "
|
|
6086
|
-
"items": {
|
|
6087
|
-
"$ref": "#/definitions/IBrowserlessStats"
|
|
6088
|
-
},
|
|
6089
|
-
"definitions": {
|
|
6090
|
-
"IBrowserlessStats": {
|
|
6091
|
-
"type": "object",
|
|
6092
|
-
"properties": {
|
|
6093
|
-
"cpu": {
|
|
6094
|
-
"type": [
|
|
6095
|
-
"null",
|
|
6096
|
-
"number"
|
|
6097
|
-
]
|
|
6098
|
-
},
|
|
6099
|
-
"date": {
|
|
6100
|
-
"type": "number"
|
|
6101
|
-
},
|
|
6102
|
-
"error": {
|
|
6103
|
-
"type": "number"
|
|
6104
|
-
},
|
|
6105
|
-
"maxConcurrent": {
|
|
6106
|
-
"type": "number"
|
|
6107
|
-
},
|
|
6108
|
-
"maxTime": {
|
|
6109
|
-
"type": "number"
|
|
6110
|
-
},
|
|
6111
|
-
"meanTime": {
|
|
6112
|
-
"type": "number"
|
|
6113
|
-
},
|
|
6114
|
-
"memory": {
|
|
6115
|
-
"type": [
|
|
6116
|
-
"null",
|
|
6117
|
-
"number"
|
|
6118
|
-
]
|
|
6119
|
-
},
|
|
6120
|
-
"minTime": {
|
|
6121
|
-
"type": "number"
|
|
6122
|
-
},
|
|
6123
|
-
"queued": {
|
|
6124
|
-
"type": "number"
|
|
6125
|
-
},
|
|
6126
|
-
"rejected": {
|
|
6127
|
-
"type": "number"
|
|
6128
|
-
},
|
|
6129
|
-
"sessionTimes": {
|
|
6130
|
-
"type": "array",
|
|
6131
|
-
"items": {
|
|
6132
|
-
"type": "number"
|
|
6133
|
-
}
|
|
6134
|
-
},
|
|
6135
|
-
"successful": {
|
|
6136
|
-
"type": "number"
|
|
6137
|
-
},
|
|
6138
|
-
"timedout": {
|
|
6139
|
-
"type": "number"
|
|
6140
|
-
},
|
|
6141
|
-
"totalTime": {
|
|
6142
|
-
"type": "number"
|
|
6143
|
-
},
|
|
6144
|
-
"unauthorized": {
|
|
6145
|
-
"type": "number"
|
|
6146
|
-
},
|
|
6147
|
-
"unhealthy": {
|
|
6148
|
-
"type": "number"
|
|
6149
|
-
},
|
|
6150
|
-
"units": {
|
|
6151
|
-
"type": "number"
|
|
6152
|
-
}
|
|
6153
|
-
},
|
|
6154
|
-
"additionalProperties": false,
|
|
6155
|
-
"required": [
|
|
6156
|
-
"cpu",
|
|
6157
|
-
"date",
|
|
6158
|
-
"error",
|
|
6159
|
-
"maxConcurrent",
|
|
6160
|
-
"maxTime",
|
|
6161
|
-
"meanTime",
|
|
6162
|
-
"memory",
|
|
6163
|
-
"minTime",
|
|
6164
|
-
"queued",
|
|
6165
|
-
"rejected",
|
|
6166
|
-
"sessionTimes",
|
|
6167
|
-
"successful",
|
|
6168
|
-
"timedout",
|
|
6169
|
-
"totalTime",
|
|
6170
|
-
"unauthorized",
|
|
6171
|
-
"unhealthy",
|
|
6172
|
-
"units"
|
|
6173
|
-
]
|
|
6174
|
-
}
|
|
6175
|
-
},
|
|
5458
|
+
"type": "string",
|
|
6176
5459
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
6177
5460
|
}
|
|
6178
5461
|
}
|
|
@@ -6230,238 +5513,7 @@
|
|
|
6230
5513
|
"content": {
|
|
6231
5514
|
"application/json": {
|
|
6232
5515
|
"schema": {
|
|
6233
|
-
"type": "
|
|
6234
|
-
"items": {
|
|
6235
|
-
"$ref": "#/definitions/BrowserlessSessionJSON"
|
|
6236
|
-
},
|
|
6237
|
-
"definitions": {
|
|
6238
|
-
"BrowserlessSessionJSON": {
|
|
6239
|
-
"type": "object",
|
|
6240
|
-
"properties": {
|
|
6241
|
-
"browser": {
|
|
6242
|
-
"type": "string"
|
|
6243
|
-
},
|
|
6244
|
-
"browserId": {
|
|
6245
|
-
"type": "string"
|
|
6246
|
-
},
|
|
6247
|
-
"id": {
|
|
6248
|
-
"type": [
|
|
6249
|
-
"null",
|
|
6250
|
-
"string"
|
|
6251
|
-
]
|
|
6252
|
-
},
|
|
6253
|
-
"initialConnectURL": {
|
|
6254
|
-
"type": "string"
|
|
6255
|
-
},
|
|
6256
|
-
"killURL": {
|
|
6257
|
-
"type": [
|
|
6258
|
-
"null",
|
|
6259
|
-
"string"
|
|
6260
|
-
]
|
|
6261
|
-
},
|
|
6262
|
-
"launchOptions": {
|
|
6263
|
-
"anyOf": [
|
|
6264
|
-
{
|
|
6265
|
-
"$ref": "#/definitions/CDPLaunchOptions"
|
|
6266
|
-
},
|
|
6267
|
-
{
|
|
6268
|
-
"$ref": "#/definitions/BrowserServerOptions"
|
|
6269
|
-
}
|
|
6270
|
-
]
|
|
6271
|
-
},
|
|
6272
|
-
"numbConnected": {
|
|
6273
|
-
"type": "number"
|
|
6274
|
-
},
|
|
6275
|
-
"routePath": {
|
|
6276
|
-
"anyOf": [
|
|
6277
|
-
{
|
|
6278
|
-
"type": "array",
|
|
6279
|
-
"items": {
|
|
6280
|
-
"type": "string"
|
|
6281
|
-
}
|
|
6282
|
-
},
|
|
6283
|
-
{
|
|
6284
|
-
"type": "string"
|
|
6285
|
-
}
|
|
6286
|
-
]
|
|
6287
|
-
},
|
|
6288
|
-
"startedOn": {
|
|
6289
|
-
"type": "number"
|
|
6290
|
-
},
|
|
6291
|
-
"timeAliveMs": {
|
|
6292
|
-
"type": "number"
|
|
6293
|
-
},
|
|
6294
|
-
"userDataDir": {
|
|
6295
|
-
"type": [
|
|
6296
|
-
"null",
|
|
6297
|
-
"string"
|
|
6298
|
-
]
|
|
6299
|
-
}
|
|
6300
|
-
},
|
|
6301
|
-
"additionalProperties": false,
|
|
6302
|
-
"required": [
|
|
6303
|
-
"browser",
|
|
6304
|
-
"browserId",
|
|
6305
|
-
"id",
|
|
6306
|
-
"initialConnectURL",
|
|
6307
|
-
"killURL",
|
|
6308
|
-
"launchOptions",
|
|
6309
|
-
"numbConnected",
|
|
6310
|
-
"routePath",
|
|
6311
|
-
"startedOn",
|
|
6312
|
-
"timeAliveMs",
|
|
6313
|
-
"userDataDir"
|
|
6314
|
-
]
|
|
6315
|
-
},
|
|
6316
|
-
"CDPLaunchOptions": {
|
|
6317
|
-
"type": "object",
|
|
6318
|
-
"properties": {
|
|
6319
|
-
"args": {
|
|
6320
|
-
"type": "array",
|
|
6321
|
-
"items": {
|
|
6322
|
-
"type": "string"
|
|
6323
|
-
}
|
|
6324
|
-
},
|
|
6325
|
-
"defaultViewport": {
|
|
6326
|
-
"type": "object",
|
|
6327
|
-
"properties": {
|
|
6328
|
-
"deviceScaleFactor": {
|
|
6329
|
-
"type": "number"
|
|
6330
|
-
},
|
|
6331
|
-
"hasTouch": {
|
|
6332
|
-
"type": "boolean"
|
|
6333
|
-
},
|
|
6334
|
-
"height": {
|
|
6335
|
-
"type": "number"
|
|
6336
|
-
},
|
|
6337
|
-
"isLandscape": {
|
|
6338
|
-
"type": "boolean"
|
|
6339
|
-
},
|
|
6340
|
-
"isMobile": {
|
|
6341
|
-
"type": "boolean"
|
|
6342
|
-
},
|
|
6343
|
-
"width": {
|
|
6344
|
-
"type": "number"
|
|
6345
|
-
}
|
|
6346
|
-
},
|
|
6347
|
-
"additionalProperties": false,
|
|
6348
|
-
"required": [
|
|
6349
|
-
"height",
|
|
6350
|
-
"width"
|
|
6351
|
-
]
|
|
6352
|
-
},
|
|
6353
|
-
"devtools": {
|
|
6354
|
-
"type": "boolean"
|
|
6355
|
-
},
|
|
6356
|
-
"dumpio": {
|
|
6357
|
-
"type": "boolean"
|
|
6358
|
-
},
|
|
6359
|
-
"headless": {
|
|
6360
|
-
"enum": [
|
|
6361
|
-
false,
|
|
6362
|
-
"shell",
|
|
6363
|
-
true
|
|
6364
|
-
]
|
|
6365
|
-
},
|
|
6366
|
-
"ignoreDefaultArgs": {
|
|
6367
|
-
"anyOf": [
|
|
6368
|
-
{
|
|
6369
|
-
"type": "array",
|
|
6370
|
-
"items": {
|
|
6371
|
-
"type": "string"
|
|
6372
|
-
}
|
|
6373
|
-
},
|
|
6374
|
-
{
|
|
6375
|
-
"type": "boolean"
|
|
6376
|
-
}
|
|
6377
|
-
]
|
|
6378
|
-
},
|
|
6379
|
-
"ignoreHTTPSErrors": {
|
|
6380
|
-
"type": "boolean"
|
|
6381
|
-
},
|
|
6382
|
-
"slowMo": {
|
|
6383
|
-
"type": "number"
|
|
6384
|
-
},
|
|
6385
|
-
"stealth": {
|
|
6386
|
-
"type": "boolean"
|
|
6387
|
-
},
|
|
6388
|
-
"timeout": {
|
|
6389
|
-
"type": "number"
|
|
6390
|
-
},
|
|
6391
|
-
"userDataDir": {
|
|
6392
|
-
"type": "string"
|
|
6393
|
-
},
|
|
6394
|
-
"waitForInitialPage": {
|
|
6395
|
-
"type": "boolean"
|
|
6396
|
-
}
|
|
6397
|
-
},
|
|
6398
|
-
"additionalProperties": false
|
|
6399
|
-
},
|
|
6400
|
-
"BrowserServerOptions": {
|
|
6401
|
-
"type": "object",
|
|
6402
|
-
"properties": {
|
|
6403
|
-
"args": {
|
|
6404
|
-
"type": "array",
|
|
6405
|
-
"items": {
|
|
6406
|
-
"type": "string"
|
|
6407
|
-
}
|
|
6408
|
-
},
|
|
6409
|
-
"chromiumSandbox": {
|
|
6410
|
-
"type": "boolean"
|
|
6411
|
-
},
|
|
6412
|
-
"devtools": {
|
|
6413
|
-
"type": "boolean"
|
|
6414
|
-
},
|
|
6415
|
-
"downloadsPath": {
|
|
6416
|
-
"type": "string"
|
|
6417
|
-
},
|
|
6418
|
-
"headless": {
|
|
6419
|
-
"type": "boolean"
|
|
6420
|
-
},
|
|
6421
|
-
"ignoreDefaultArgs": {
|
|
6422
|
-
"anyOf": [
|
|
6423
|
-
{
|
|
6424
|
-
"type": "array",
|
|
6425
|
-
"items": {
|
|
6426
|
-
"type": "string"
|
|
6427
|
-
}
|
|
6428
|
-
},
|
|
6429
|
-
{
|
|
6430
|
-
"type": "boolean"
|
|
6431
|
-
}
|
|
6432
|
-
]
|
|
6433
|
-
},
|
|
6434
|
-
"proxy": {
|
|
6435
|
-
"type": "object",
|
|
6436
|
-
"properties": {
|
|
6437
|
-
"bypass": {
|
|
6438
|
-
"type": "string"
|
|
6439
|
-
},
|
|
6440
|
-
"password": {
|
|
6441
|
-
"type": "string"
|
|
6442
|
-
},
|
|
6443
|
-
"server": {
|
|
6444
|
-
"type": "string"
|
|
6445
|
-
},
|
|
6446
|
-
"username": {
|
|
6447
|
-
"type": "string"
|
|
6448
|
-
}
|
|
6449
|
-
},
|
|
6450
|
-
"additionalProperties": false,
|
|
6451
|
-
"required": [
|
|
6452
|
-
"server"
|
|
6453
|
-
]
|
|
6454
|
-
},
|
|
6455
|
-
"timeout": {
|
|
6456
|
-
"type": "number"
|
|
6457
|
-
},
|
|
6458
|
-
"tracesDir": {
|
|
6459
|
-
"type": "string"
|
|
6460
|
-
}
|
|
6461
|
-
},
|
|
6462
|
-
"additionalProperties": false
|
|
6463
|
-
}
|
|
6464
|
-
},
|
|
5516
|
+
"type": "string",
|
|
6465
5517
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
6466
5518
|
}
|
|
6467
5519
|
}
|
|
@@ -6571,10 +5623,9 @@
|
|
|
6571
5623
|
"in": "query",
|
|
6572
5624
|
"name": "launch",
|
|
6573
5625
|
"schema": {
|
|
6574
|
-
"description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
|
|
6575
5626
|
"anyOf": [
|
|
6576
5627
|
{
|
|
6577
|
-
"$ref": "#/definitions/
|
|
5628
|
+
"$ref": "#/definitions/CDPLaunchOptions"
|
|
6578
5629
|
},
|
|
6579
5630
|
{
|
|
6580
5631
|
"type": "string"
|