@mayurajs/browser-browserless 0.0.0-stage → 1.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,8 @@
+Mayura
+Copyright 2026 The Mayura Authors
+
+This product includes software developed by the Mayura contributors.
+
+Third-party dependencies retain their own copyright and license terms. Exact
+resolved versions are recorded in pnpm-lock.yaml and reviewed by the release
+artifact and dependency qualification procedures.

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# @mayurajs/browser-browserless
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Browserless](https://docs.browserless.io) browsers for `mayura/browser`, hosted or self-hosted: each is a fresh
+browser that Browserless launches when its CDP connection opens and ends when it closes. From any runtime, with no
+dependency.
+
+```bash
+npm install mayura @mayurajs/browser-browserless
+```
+
+```ts
+import { createBrowsers } from 'mayura/browser';
+import { browserlessBrowsers } from '@mayurajs/browser-browserless';
+
+const browsers = createBrowsers(browserlessBrowsers({ token }), {
+  maxBrowsers: 2, maxLifetimeMs: 15 * 60_000,
+  origins: ['https://example.com'],
+});
+const browser = await browsers.open();
+await browser.goto('https://example.com/');
+await browser.release();
+```
+
+- Each browser is one connection to Browserless: nothing is kept between browsers (this is not Browserless's
+  persistent Session API). Releasing the browser closes the connection, which ends it; Browserless ends it at its
+  lifetime, given as the connection's `timeout`, should that never happen. Browserless's plans cap a browser at 2
+  minutes to an hour.
+- Since every connection is a browser of its own, a browser gives no `cdp` endpoint to other clients: Stagehand and
+  `@mayurajs/browser-agent-browser` cannot join it.
+- Hosted regions are `production-sfo` (the default), `production-lon` and `production-ams`. For your own Browserless,
+  give `endpoint`, such as `wss://browserless.internal`; plain `ws://` only on this machine.
+- Ad blocking and stealth are off unless asked for; no proxy is used. There is no live view.
+- The token travels in the connection's query, as Browserless takes it: treat the URL as a secret; Mayura never logs it.
+- Origins are enforced inside the browser, by intercepting its requests over CDP; a live check against Browserless
+  confirmed it on October 6, 2026. Should a connection ever not allow that, opening a browser fails rather than
+  running unchecked.
+- Options: `token`, `region`, `endpoint`, `blockAds`, `stealth`, `maxLifetimeMs` (1 hour).
+
+See the [browser guide](https://mayurajs.com/docs/guides/browsers/). Apache-2.0.

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import type { BrowserProvider } from 'mayura/browser';
+export interface BrowserlessBrowserOptions {
+    /** A Browserless API token. Nothing is read from the environment. */
+    readonly token: string;
+    /** Browserless's hosted region: `production-sfo` (the default), `production-lon` or `production-ams`. */
+    readonly region?: 'production-sfo' | 'production-lon' | 'production-ams';
+    /**
+     * Your own Browserless instead of the hosted one, such as `wss://browserless.internal` or, on this machine,
+     * `ws://127.0.0.1:3000`. Plain `ws://` is accepted only on this machine.
+     */
+    readonly endpoint?: string;
+    /** Block ads; off by default. */
+    readonly blockAds?: boolean;
+    /** Browserless's stealth mode; off by default. */
+    readonly stealth?: boolean;
+    /** The longest lifetime: 1 hour by default (Browserless's plans allow 2 minutes to an hour); up to 24 hours self-hosted. */
+    readonly maxLifetimeMs?: number;
+}
+/**
+ * Browsers from Browserless, hosted or your own: each is a fresh browser launched when its CDP connection opens and
+ * ended when it closes, kept to its lifetime by Browserless's timeout. Nothing is kept between browsers. From any
+ * runtime, with no dependency. Give the result to `createBrowsers` from `mayura/browser`.
+ */
+export declare function browserlessBrowsers(options: BrowserlessBrowserOptions): BrowserProvider;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAkB,eAAe,EAAuB,MAAM,gBAAgB,CAAC;AAE3F,MAAM,WAAW,yBAAyB;IACxC,qEAAqE;IACrE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,yGAAyG;IACzG,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IACzE;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,kDAAkD;IAClD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,4HAA4H;IAC5H,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAMD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,yBAAyB,GAAG,eAAe,CAmCvF"}

package/dist/index.js

@@ -0,0 +1,55 @@
+import { MayuraError } from 'mayura';
+const regions = ['production-sfo', 'production-lon', 'production-ams'];
+/** A WebSocket over TLS, or plain only on this machine. */
+const secureSocket = /^(?:wss:\/\/|ws:\/\/(?:127\.0\.0\.1|localhost|\[::1\])[:/])/u;
+/**
+ * Browsers from Browserless, hosted or your own: each is a fresh browser launched when its CDP connection opens and
+ * ended when it closes, kept to its lifetime by Browserless's timeout. Nothing is kept between browsers. From any
+ * runtime, with no dependency. Give the result to `createBrowsers` from `mayura/browser`.
+ */
+export function browserlessBrowsers(options) {
+    if (!options || typeof options.token !== 'string' || !/^[A-Za-z0-9_.-]{8,512}$/u.test(options.token))
+        throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): token must be a Browserless API token.');
+    if (options.region !== undefined && !regions.includes(options.region))
+        throw new MayuraError('INVALID_CONFIG', `browserlessBrowsers(): region is one of ${regions.join(', ')}.`);
+    if (options.region !== undefined && options.endpoint !== undefined)
+        throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): give a region or an endpoint, not both.');
+    for (const flag of ['blockAds', 'stealth']) {
+        if (options[flag] !== undefined && typeof options[flag] !== 'boolean')
+            throw new MayuraError('INVALID_CONFIG', `browserlessBrowsers(): ${flag} must be a boolean.`);
+    }
+    const endpoint = (() => {
+        const text = options.endpoint ?? `wss://${options.region ?? 'production-sfo'}.browserless.io`;
+        try {
+            const url = new URL(text);
+            if (!secureSocket.test(url.href) || url.search || url.hash || url.username || url.password)
+                throw new Error();
+            return url;
+        }
+        catch {
+            throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): endpoint is a wss:// URL (ws:// only on this machine), without a query.');
+        }
+    })();
+    const maxLifetimeMs = options.maxLifetimeMs ?? 3_600_000;
+    if (!Number.isSafeInteger(maxLifetimeMs) || maxLifetimeMs < 1_000 || maxLifetimeMs > 86_400_000)
+        throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): maxLifetimeMs is 1 s to 24 hours.');
+    let count = 0;
+    const create = async (spec) => {
+        const url = new URL(endpoint.href);
+        // The token goes in the query, as Browserless takes it; the timeout ends the browser at its lifetime.
+        url.searchParams.set('token', options.token);
+        url.searchParams.set('timeout', String(spec.lifetimeMs));
+        if (options.blockAds)
+            url.searchParams.set('blockAds', 'true');
+        if (options.stealth)
+            url.searchParams.set('stealth', 'true');
+        return {
+            // Each connection is a browser of its own: another client would not reach this one.
+            id: `browserless-${++count}`, cdp: { url: url.href, joinable: false },
+            // The browser ends when its connection does, which releasing the browser closes.
+            release: async () => undefined,
+        };
+    };
+    return Object.freeze({ id: 'browserless', features: Object.freeze({ liveView: false }), maxLifetimeMs, create });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAqBrC,MAAM,OAAO,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,gBAAgB,CAAU,CAAC;AAChF,2DAA2D;AAC3D,MAAM,YAAY,GAAG,8DAA8D,CAAC;AAEpF;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAkC;IACpE,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,+DAA+D,CAAC,CAAC;IAC/M,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,2CAA2C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjL,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,gEAAgE,CAAC,CAAC;IAC9K,KAAK,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE,SAAS,CAAU,EAAE,CAAC;QACpD,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,SAAS;YAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,0BAA0B,IAAI,qBAAqB,CAAC,CAAC;IACtK,CAAC;IACD,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE;QACrB,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,IAAI,SAAS,OAAO,CAAC,MAAM,IAAI,gBAAgB,iBAAiB,CAAC;QAC9F,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,EAAE,CAAC;YAC9G,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,MAAM,CAAC;YAAC,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,gGAAgG,CAAC,CAAC;QAAC,CAAC;IACxJ,CAAC,CAAC,EAAE,CAAC;IACL,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,SAAS,CAAC;IACzD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,aAAa,GAAG,KAAK,IAAI,aAAa,GAAG,UAAU;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,CAAC;IACrM,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,MAAM,MAAM,GAAG,KAAK,EAAE,IAAyB,EAA2B,EAAE;QAC1E,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnC,sGAAsG;QACtG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACzD,IAAI,OAAO,CAAC,QAAQ;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC/D,IAAI,OAAO,CAAC,OAAO;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7D,OAAO;YACL,oFAAoF;YACpF,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;YACrE,iFAAiF;YACjF,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS;SAC/B,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;AACnH,CAAC","sourcesContent":["import { MayuraError } from 'mayura';\nimport type { BrowserBackend, BrowserProvider, ProviderBrowserSpec } from 'mayura/browser';\n\nexport interface BrowserlessBrowserOptions {\n  /** A Browserless API token. Nothing is read from the environment. */\n  readonly token: string;\n  /** Browserless's hosted region: `production-sfo` (the default), `production-lon` or `production-ams`. */\n  readonly region?: 'production-sfo' | 'production-lon' | 'production-ams';\n  /**\n   * Your own Browserless instead of the hosted one, such as `wss://browserless.internal` or, on this machine,\n   * `ws://127.0.0.1:3000`. Plain `ws://` is accepted only on this machine.\n   */\n  readonly endpoint?: string;\n  /** Block ads; off by default. */\n  readonly blockAds?: boolean;\n  /** Browserless's stealth mode; off by default. */\n  readonly stealth?: boolean;\n  /** The longest lifetime: 1 hour by default (Browserless's plans allow 2 minutes to an hour); up to 24 hours self-hosted. */\n  readonly maxLifetimeMs?: number;\n}\n\nconst regions = ['production-sfo', 'production-lon', 'production-ams'] as const;\n/** A WebSocket over TLS, or plain only on this machine. */\nconst secureSocket = /^(?:wss:\\/\\/|ws:\\/\\/(?:127\\.0\\.0\\.1|localhost|\\[::1\\])[:/])/u;\n\n/**\n * Browsers from Browserless, hosted or your own: each is a fresh browser launched when its CDP connection opens and\n * ended when it closes, kept to its lifetime by Browserless's timeout. Nothing is kept between browsers. From any\n * runtime, with no dependency. Give the result to `createBrowsers` from `mayura/browser`.\n */\nexport function browserlessBrowsers(options: BrowserlessBrowserOptions): BrowserProvider {\n  if (!options || typeof options.token !== 'string' || !/^[A-Za-z0-9_.-]{8,512}$/u.test(options.token)) throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): token must be a Browserless API token.');\n  if (options.region !== undefined && !regions.includes(options.region)) throw new MayuraError('INVALID_CONFIG', `browserlessBrowsers(): region is one of ${regions.join(', ')}.`);\n  if (options.region !== undefined && options.endpoint !== undefined) throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): give a region or an endpoint, not both.');\n  for (const flag of ['blockAds', 'stealth'] as const) {\n    if (options[flag] !== undefined && typeof options[flag] !== 'boolean') throw new MayuraError('INVALID_CONFIG', `browserlessBrowsers(): ${flag} must be a boolean.`);\n  }\n  const endpoint = (() => {\n    const text = options.endpoint ?? `wss://${options.region ?? 'production-sfo'}.browserless.io`;\n    try {\n      const url = new URL(text);\n      if (!secureSocket.test(url.href) || url.search || url.hash || url.username || url.password) throw new Error();\n      return url;\n    } catch { throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): endpoint is a wss:// URL (ws:// only on this machine), without a query.'); }\n  })();\n  const maxLifetimeMs = options.maxLifetimeMs ?? 3_600_000;\n  if (!Number.isSafeInteger(maxLifetimeMs) || maxLifetimeMs < 1_000 || maxLifetimeMs > 86_400_000) throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): maxLifetimeMs is 1 s to 24 hours.');\n  let count = 0;\n\n  const create = async (spec: ProviderBrowserSpec): Promise<BrowserBackend> => {\n    const url = new URL(endpoint.href);\n    // The token goes in the query, as Browserless takes it; the timeout ends the browser at its lifetime.\n    url.searchParams.set('token', options.token);\n    url.searchParams.set('timeout', String(spec.lifetimeMs));\n    if (options.blockAds) url.searchParams.set('blockAds', 'true');\n    if (options.stealth) url.searchParams.set('stealth', 'true');\n    return {\n      // Each connection is a browser of its own: another client would not reach this one.\n      id: `browserless-${++count}`, cdp: { url: url.href, joinable: false },\n      // The browser ends when its connection does, which releasing the browser closes.\n      release: async () => undefined,\n    };\n  };\n\n  return Object.freeze({ id: 'browserless', features: Object.freeze({ liveView: false }), maxLifetimeMs, create });\n}\n"]}

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@mayurajs/browser-browserless",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.2.0",
+  "description": "Browserless browsers for mayura/browser, hosted or self-hosted.",
+  "author": {
+    "name": "Aryabh",
+    "email": "dev@rokad.co"
+  },
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KartikeyAI/mayura.git",
+    "directory": "extensions/browser-browserless"
+  },
+  "homepage": "https://github.com/KartikeyAI/mayura#readme",
+  "bugs": {
+    "url": "https://github.com/KartikeyAI/mayura/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0 <23 || >=24.14.1 <25"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src/**/*.ts",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "mayura": "^1.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/src/index.ts

@@ -0,0 +1,66 @@
+import { MayuraError } from 'mayura';
+import type { BrowserBackend, BrowserProvider, ProviderBrowserSpec } from 'mayura/browser';
+
+export interface BrowserlessBrowserOptions {
+  /** A Browserless API token. Nothing is read from the environment. */
+  readonly token: string;
+  /** Browserless's hosted region: `production-sfo` (the default), `production-lon` or `production-ams`. */
+  readonly region?: 'production-sfo' | 'production-lon' | 'production-ams';
+  /**
+   * Your own Browserless instead of the hosted one, such as `wss://browserless.internal` or, on this machine,
+   * `ws://127.0.0.1:3000`. Plain `ws://` is accepted only on this machine.
+   */
+  readonly endpoint?: string;
+  /** Block ads; off by default. */
+  readonly blockAds?: boolean;
+  /** Browserless's stealth mode; off by default. */
+  readonly stealth?: boolean;
+  /** The longest lifetime: 1 hour by default (Browserless's plans allow 2 minutes to an hour); up to 24 hours self-hosted. */
+  readonly maxLifetimeMs?: number;
+}
+
+const regions = ['production-sfo', 'production-lon', 'production-ams'] as const;
+/** A WebSocket over TLS, or plain only on this machine. */
+const secureSocket = /^(?:wss:\/\/|ws:\/\/(?:127\.0\.0\.1|localhost|\[::1\])[:/])/u;
+
+/**
+ * Browsers from Browserless, hosted or your own: each is a fresh browser launched when its CDP connection opens and
+ * ended when it closes, kept to its lifetime by Browserless's timeout. Nothing is kept between browsers. From any
+ * runtime, with no dependency. Give the result to `createBrowsers` from `mayura/browser`.
+ */
+export function browserlessBrowsers(options: BrowserlessBrowserOptions): BrowserProvider {
+  if (!options || typeof options.token !== 'string' || !/^[A-Za-z0-9_.-]{8,512}$/u.test(options.token)) throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): token must be a Browserless API token.');
+  if (options.region !== undefined && !regions.includes(options.region)) throw new MayuraError('INVALID_CONFIG', `browserlessBrowsers(): region is one of ${regions.join(', ')}.`);
+  if (options.region !== undefined && options.endpoint !== undefined) throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): give a region or an endpoint, not both.');
+  for (const flag of ['blockAds', 'stealth'] as const) {
+    if (options[flag] !== undefined && typeof options[flag] !== 'boolean') throw new MayuraError('INVALID_CONFIG', `browserlessBrowsers(): ${flag} must be a boolean.`);
+  }
+  const endpoint = (() => {
+    const text = options.endpoint ?? `wss://${options.region ?? 'production-sfo'}.browserless.io`;
+    try {
+      const url = new URL(text);
+      if (!secureSocket.test(url.href) || url.search || url.hash || url.username || url.password) throw new Error();
+      return url;
+    } catch { throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): endpoint is a wss:// URL (ws:// only on this machine), without a query.'); }
+  })();
+  const maxLifetimeMs = options.maxLifetimeMs ?? 3_600_000;
+  if (!Number.isSafeInteger(maxLifetimeMs) || maxLifetimeMs < 1_000 || maxLifetimeMs > 86_400_000) throw new MayuraError('INVALID_CONFIG', 'browserlessBrowsers(): maxLifetimeMs is 1 s to 24 hours.');
+  let count = 0;
+
+  const create = async (spec: ProviderBrowserSpec): Promise<BrowserBackend> => {
+    const url = new URL(endpoint.href);
+    // The token goes in the query, as Browserless takes it; the timeout ends the browser at its lifetime.
+    url.searchParams.set('token', options.token);
+    url.searchParams.set('timeout', String(spec.lifetimeMs));
+    if (options.blockAds) url.searchParams.set('blockAds', 'true');
+    if (options.stealth) url.searchParams.set('stealth', 'true');
+    return {
+      // Each connection is a browser of its own: another client would not reach this one.
+      id: `browserless-${++count}`, cdp: { url: url.href, joinable: false },
+      // The browser ends when its connection does, which releasing the browser closes.
+      release: async () => undefined,
+    };
+  };
+
+  return Object.freeze({ id: 'browserless', features: Object.freeze({ liveView: false }), maxLifetimeMs, create });
+}