browserless 10.11.4 → 10.12.1

package/index.d.ts

@@ -0,0 +1,82 @@
+import type { Browser, BrowserContext, HTTPResponse, Page, PDFOptions, Viewport } from 'puppeteer'
+
+export interface BrowserlessOptions {
+  timeout?: number
+  launchOpts?: LaunchOptions
+}
+
+export interface LaunchOptions {
+  headless?: boolean | 'new'
+  args?: string[]
+  executablePath?: string
+  timeout?: number
+  mode?: 'launch' | 'connect'
+  proxyServer?: string
+  proxyBypassList?: string[]
+  [key: string]: unknown
+}
+
+export interface BrowserContextOptions {
+  proxyServer?: string
+  proxyBypassList?: string[]
+  viewport?: Viewport
+}
+
+export interface ContextOptions extends BrowserContextOptions {
+  retry?: number
+  timeout?: number
+}
+
+export interface Context {
+  respawn: () => void
+  context: () => Promise<BrowserContext>
+  browser: () => Promise<Browser>
+  evaluate: <T>(fn: (page: Page, response?: HTTPResponse | undefined, error?: Error) => T | Promise<T>, gotoOpts?: GotoOptions) => Promise<T>
+  goto: (page: Page, url: string, opts?: GotoOptions) => Promise<GotoResult>
+  html: (url: string, opts?: GotoOptions) => Promise<string>
+  page: (name?: string) => Promise<Page>
+  pdf: (page: Page, opts?: PDFOptions) => Promise<Buffer>
+  screenshot: (page: Page, opts?: ScreenshotOptions) => Promise<Buffer>
+  text: (url: string, opts?: GotoOptions) => Promise<string>
+  getDevice: (deviceName: string) => Viewport | undefined
+  destroyContext: (opts?: { force?: boolean }) => Promise<void>
+  withPage: <T>(fn: (page: Page, goto: unknown) => Promise<T>, opts?: { timeout?: number }) => Promise<T>
+}
+
+export interface GotoOptions {
+  waitUntil?: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
+  timeout?: number
+  headers?: Record<string, string>
+  [key: string]: unknown
+}
+
+export interface GotoResult {
+  response: HTTPResponse | null
+  error: Error | null
+}
+
+export interface ScreenshotOptions {
+  type?: 'png' | 'jpeg' | 'webp'
+  fullPage?: boolean
+  clip?: {
+    x: number
+    y: number
+    width: number
+    height: number
+  }
+  omitBackground?: boolean
+  encoding?: 'binary' | 'base64'
+}
+
+export interface Browserless {
+  createContext: (opts?: ContextOptions) => Promise<Context>
+  respawn: () => void
+  browser: () => Promise<Browser>
+  close: () => Promise<void>
+  isClosed: () => boolean
+  driver: unknown
+}
+
+declare function browserless(options?: BrowserlessOptions): Promise<Browserless>
+
+export default browserless

package/package.json

@@ -2,8 +2,9 @@
   "name": "browserless",
   "description": "The headless Chrome/Chromium driver on top of Puppeteer. Take screenshots, generate PDFs, extract text and HTML with a production-ready API.",
   "homepage": "https://browserless.js.org",
-  "version": "10.11.4",
+  "version": "10.12.1",
   "main": "src/index.js",
+  "types": "index.d.ts",
   "author": {
     "email": "hello@microlink.io",
     "name": "microlink.io",
@@ -34,7 +35,7 @@
     "web-scraping"
   ],
   "dependencies": {
-    "@browserless/errors": "^10.11.3",
+    "@browserless/errors": "^10.12.1",
     "@browserless/goto": "^10.11.4",
     "@browserless/pdf": "^10.11.4",
     "@browserless/screenshot": "^10.11.4",
@@ -50,13 +51,15 @@
     "@browserless/test": "^10.11.4",
     "ava": "5",
     "ps-list": "7",
+    "puppeteer": "^24.37.5",
     "tinyspawn": "latest"
   },
   "engines": {
     "node": ">= 24"
   },
   "files": [
-    "src"
+    "src",
+    "index.d.ts"
   ],
   "scripts": {
     "test": "ava"
@@ -67,5 +70,5 @@
     "timeout": "2m",
     "workerThreads": false
   },
-  "gitHead": "9ff2a0f0dad20d64a5c47a04a989ee77d1ee5ae8"
+  "gitHead": "04b12b821bc166e1d40ad31013c2ea99e85c3d00"
 }