@mayurajs/browser-kernel 0.0.0-stage → 1.1.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,37 @@
-# Temporary Holding Version
+# @mayurajs/browser-kernel
 
-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.
+[Kernel](https://www.kernel.sh/docs) browsers for `mayura/browser`: hosted Chromium, created over Kernel's browsers
+API and driven over CDP, from any runtime, with no dependency.
+
+```bash
+npm install mayura @mayurajs/browser-kernel
+```
+
+```ts
+import { createBrowsers } from 'mayura/browser';
+import { kernelBrowsers } from '@mayurajs/browser-kernel';
+
+const browsers = createBrowsers(kernelBrowsers({ apiKey }), {
+  maxBrowsers: 2, maxLifetimeMs: 30 * 60_000,
+  origins: ['https://example.com'],
+});
+const browser = await browsers.open();
+await browser.goto('https://example.com/');
+await browser.release();
+```
+
+- Each browser is created when opened and deleted when released. Kernel keeps a browser running for as long as it is
+  connected, so its lifetime is kept by `createBrowsers`, which releases it then. Once nothing is connected (this
+  process stopped, say), Kernel deletes it after `standbyTimeoutSeconds`: 60 by default.
+- **Stealth is off**, since in Kernel it also turns on a captcha solver; turn it on with `stealth`. No proxy is used.
+  Labels become the browser's tags.
+- `liveViewUrl` is Kernel's live view, a link with a token in it: by default it only shows the browser
+  (`liveView: 'view'`); `'interact'` lets whoever has the link use it too; `false` gives none and runs the browser
+  headless.
+- Treat the CDP URL as a secret, as Kernel does not say what it carries: Mayura never logs it.
+- Origins are enforced inside the browser, by intercepting its requests over CDP. This has not yet been tried against
+  Kernel itself: should its connection not allow that, opening a browser fails rather than running unchecked.
+- Options: `apiKey`, `liveView`, `stealth`, `region` (`us-east`, `eu-west`, `ap-southeast`), `standbyTimeoutSeconds`,
+  `maxLifetimeMs` (24 hours), `fetch`, `baseUrl`.
+
+See the [browser guide](https://mayurajs.com/docs/guides/browsers/). Apache-2.0.

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { type BrowserProvider } from 'mayura/browser';
+export interface KernelBrowserOptions {
+    /** A Kernel API key. Nothing is read from the environment. */
+    readonly apiKey: string;
+    /**
+     * Give each browser a live view (`liveViewUrl`), a link with a token in it: `'view'` (the default) only shows the
+     * browser; `'interact'` also lets whoever has the link use it; `false` gives none, and runs the browser headless.
+     */
+    readonly liveView?: 'view' | 'interact' | false;
+    /** Kernel's stealth mode, which also turns on its captcha solver; off by default. */
+    readonly stealth?: boolean;
+    /** Where browsers run: `us-east` (Kernel's default), `eu-west` or `ap-southeast`. */
+    readonly region?: 'us-east' | 'eu-west' | 'ap-southeast';
+    /**
+     * How long a browser waits once nothing is connected before Kernel deletes it, in seconds: 60 by default (10 to
+     * 259,200). It ends a browser whose release never came, such as when this process stops.
+     */
+    readonly standbyTimeoutSeconds?: number;
+    /** The longest lifetime; 24 hours by default. */
+    readonly maxLifetimeMs?: number;
+    /** For tests and proxies: the fetch to use. */
+    readonly fetch?: typeof fetch;
+    /** The API's address; `https://api.onkernel.com` by default. */
+    readonly baseUrl?: string;
+}
+/**
+ * Browsers from Kernel: hosted Chromium, driven over CDP from any runtime, with no dependency. Each browser is created
+ * when opened and deleted when released. Kernel keeps a browser running while it is connected, so its lifetime is kept
+ * by `createBrowsers`; a browser left without a connection is deleted after `standbyTimeoutSeconds`.
+ * Give the result to `createBrowsers` from `mayura/browser`.
+ */
+export declare function kernelBrowsers(options: KernelBrowserOptions): 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,EAEgB,KAAK,eAAe,EAC1C,MAAM,gBAAgB,CAAC;AAExB,MAAM,WAAW,oBAAoB;IACnC,8DAA8D;IAC9D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;IAChD,qFAAqF;IACrF,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,qFAAqF;IACrF,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,cAAc,CAAC;IACzD;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IACxC,iDAAiD;IACjD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,+CAA+C;IAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IAC9B,gEAAgE;IAChE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAMD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,oBAAoB,GAAG,eAAe,CAoD7E"}

package/dist/index.js

@@ -0,0 +1,84 @@
+import { MayuraError } from 'mayura';
+import { BrowserError, browserHttpFailure, browserResponseFailure, } from 'mayura/browser';
+const regions = ['us-east', 'eu-west', 'ap-southeast'];
+/** A CDP WebSocket over TLS, or plain only on this machine (a local proxy or a test). */
+const secureSocket = /^(?:wss:\/\/|ws:\/\/(?:127\.0\.0\.1|localhost|\[::1\])[:/])/u;
+/**
+ * Browsers from Kernel: hosted Chromium, driven over CDP from any runtime, with no dependency. Each browser is created
+ * when opened and deleted when released. Kernel keeps a browser running while it is connected, so its lifetime is kept
+ * by `createBrowsers`; a browser left without a connection is deleted after `standbyTimeoutSeconds`.
+ * Give the result to `createBrowsers` from `mayura/browser`.
+ */
+export function kernelBrowsers(options) {
+    if (!options || typeof options.apiKey !== 'string' || !/^[!-~]{8,512}$/u.test(options.apiKey))
+        throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): apiKey must be a Kernel API key.');
+    const liveView = options.liveView ?? 'view';
+    if (liveView !== 'view' && liveView !== 'interact' && liveView !== false)
+        throw new MayuraError('INVALID_CONFIG', "kernelBrowsers(): liveView is 'view', 'interact' or false.");
+    if (options.stealth !== undefined && typeof options.stealth !== 'boolean')
+        throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): stealth must be a boolean.');
+    if (options.region !== undefined && !regions.includes(options.region))
+        throw new MayuraError('INVALID_CONFIG', `kernelBrowsers(): region is one of ${regions.join(', ')}.`);
+    const standby = options.standbyTimeoutSeconds ?? 60;
+    if (!Number.isSafeInteger(standby) || standby < 10 || standby > 259_200)
+        throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): standbyTimeoutSeconds is 10 to 259,200.');
+    const maxLifetimeMs = options.maxLifetimeMs ?? 86_400_000;
+    if (!Number.isSafeInteger(maxLifetimeMs) || maxLifetimeMs < 1_000 || maxLifetimeMs > 259_200_000)
+        throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): maxLifetimeMs is 1 s to 72 hours.');
+    if (options.fetch !== undefined && typeof options.fetch !== 'function')
+        throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): fetch must be a function.');
+    const base = (() => {
+        try {
+            const url = new URL(options.baseUrl ?? 'https://api.onkernel.com');
+            if (url.protocol !== 'https:' && url.hostname !== '127.0.0.1' && url.hostname !== 'localhost')
+                throw new Error();
+            return url.origin;
+        }
+        catch {
+            throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): baseUrl must be an https URL.');
+        }
+    })();
+    const fetcher = options.fetch ?? globalThis.fetch;
+    const headers = (json = false) => ({ authorization: `Bearer ${options.apiKey}`, ...(json ? { 'content-type': 'application/json' } : {}) });
+    const create = async (spec, { signal }) => {
+        const created = await fetcher(`${base}/browsers`, { method: 'POST', signal, headers: headers(true), body: JSON.stringify({
+                timeout_seconds: standby,
+                // Kernel's live view needs a browser with a screen.
+                headless: liveView === false,
+                stealth: options.stealth ?? false,
+                viewport: { width: spec.viewport.width, height: spec.viewport.height },
+                ...(options.region ? { region: options.region } : {}),
+                ...(Object.keys(spec.labels).length ? { tags: { ...spec.labels } } : {}),
+            }) });
+        if (!created.ok)
+            throw browserResponseFailure(created);
+        const browser = await created.json().catch(() => undefined);
+        if (typeof browser?.session_id !== 'string' || !/^[A-Za-z0-9_-]{1,128}$/u.test(browser.session_id) || typeof browser.cdp_ws_url !== 'string' || !secureSocket.test(browser.cdp_ws_url)) {
+            throw new BrowserError('invalid_response');
+        }
+        const id = browser.session_id;
+        let liveViewUrl;
+        // Without liveView, createBrowsers shows none (and a headless browser has none).
+        if (typeof browser.browser_live_view_url === 'string') {
+            try {
+                const view = new URL(browser.browser_live_view_url);
+                if (liveView === 'view')
+                    view.searchParams.set('readOnly', 'true');
+                liveViewUrl = view.href;
+            }
+            catch { /* no live view */ }
+        }
+        return {
+            id, cdp: { url: browser.cdp_ws_url }, ...(liveViewUrl ? { liveViewUrl } : {}),
+            release: async ({ signal: callSignal }) => {
+                const reply = await fetcher(`${base}/browsers/${id}`, { method: 'DELETE', signal: callSignal, headers: headers() });
+                void reply.body?.cancel().catch(() => undefined);
+                // 404: deleted already, which createBrowsers counts as released.
+                if (!reply.ok)
+                    throw browserHttpFailure(reply.status);
+            },
+        };
+    };
+    return Object.freeze({ id: 'kernel', features: Object.freeze({ liveView: 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;AACrC,OAAO,EACL,YAAY,EAAE,kBAAkB,EAAE,sBAAsB,GAEzD,MAAM,gBAAgB,CAAC;AA2BxB,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,cAAc,CAAU,CAAC;AAChE,yFAAyF;AACzF,MAAM,YAAY,GAAG,8DAA8D,CAAC;AAEpF;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,OAA6B;IAC1D,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,oDAAoD,CAAC,CAAC;IAC7L,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC;IAC5C,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,UAAU,IAAI,QAAQ,KAAK,KAAK;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,4DAA4D,CAAC,CAAC;IAChL,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,SAAS;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,8CAA8C,CAAC,CAAC;IACnK,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,sCAAsC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5K,MAAM,OAAO,GAAG,OAAO,CAAC,qBAAqB,IAAI,EAAE,CAAC;IACpD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,EAAE,IAAI,OAAO,GAAG,OAAO;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,2DAA2D,CAAC,CAAC;IAC9K,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,UAAU,CAAC;IAC1D,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,aAAa,GAAG,KAAK,IAAI,aAAa,GAAG,WAAW;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,qDAAqD,CAAC,CAAC;IACjM,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,UAAU;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,6CAA6C,CAAC,CAAC;IAC/J,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC;YAAC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,0BAA0B,CAAC,CAAC;YAAC,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,WAAW,IAAI,GAAG,CAAC,QAAQ,KAAK,WAAW;gBAAE,MAAM,IAAI,KAAK,EAAE,CAAC;YAAC,OAAO,GAAG,CAAC,MAAM,CAAC;QAAC,CAAC;QAChN,MAAM,CAAC;YAAC,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,iDAAiD,CAAC,CAAC;QAAC,CAAC;IACvG,CAAC,CAAC,EAAE,CAAC;IACL,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IAClD,MAAM,OAAO,GAAG,CAAC,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,OAAO,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAE3I,MAAM,MAAM,GAAG,KAAK,EAAE,IAAyB,EAAE,EAAE,MAAM,EAAoC,EAA2B,EAAE;QACxH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,IAAI,WAAW,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACvH,eAAe,EAAE,OAAO;gBACxB,oDAAoD;gBACpD,QAAQ,EAAE,QAAQ,KAAK,KAAK;gBAC5B,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;gBACjC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;gBACtE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACzE,CAAC,EAAE,CAAC,CAAC;QACN,IAAI,CAAC,OAAO,CAAC,EAAE;YAAE,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAgG,CAAC;QAC3J,IAAI,OAAO,OAAO,EAAE,UAAU,KAAK,QAAQ,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACvL,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;QAC9B,IAAI,WAA+B,CAAC;QACpC,iFAAiF;QACjF,IAAI,OAAO,OAAO,CAAC,qBAAqB,KAAK,QAAQ,EAAE,CAAC;YACtD,IAAI,CAAC;gBAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;gBAAC,IAAI,QAAQ,KAAK,MAAM;oBAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;gBAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;YAAC,CAAC;YACzJ,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO;YACL,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7E,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;gBACxC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,IAAI,aAAa,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;gBACpH,KAAK,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBACjD,iEAAiE;gBACjE,IAAI,CAAC,KAAK,CAAC,EAAE;oBAAE,MAAM,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACxD,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,KAAK,KAAK,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;AAC3H,CAAC","sourcesContent":["import { MayuraError } from 'mayura';\nimport {\n  BrowserError, browserHttpFailure, browserResponseFailure,\n  type BrowserBackend, type BrowserProvider, type ProviderBrowserSpec,\n} from 'mayura/browser';\n\nexport interface KernelBrowserOptions {\n  /** A Kernel API key. Nothing is read from the environment. */\n  readonly apiKey: string;\n  /**\n   * Give each browser a live view (`liveViewUrl`), a link with a token in it: `'view'` (the default) only shows the\n   * browser; `'interact'` also lets whoever has the link use it; `false` gives none, and runs the browser headless.\n   */\n  readonly liveView?: 'view' | 'interact' | false;\n  /** Kernel's stealth mode, which also turns on its captcha solver; off by default. */\n  readonly stealth?: boolean;\n  /** Where browsers run: `us-east` (Kernel's default), `eu-west` or `ap-southeast`. */\n  readonly region?: 'us-east' | 'eu-west' | 'ap-southeast';\n  /**\n   * How long a browser waits once nothing is connected before Kernel deletes it, in seconds: 60 by default (10 to\n   * 259,200). It ends a browser whose release never came, such as when this process stops.\n   */\n  readonly standbyTimeoutSeconds?: number;\n  /** The longest lifetime; 24 hours by default. */\n  readonly maxLifetimeMs?: number;\n  /** For tests and proxies: the fetch to use. */\n  readonly fetch?: typeof fetch;\n  /** The API's address; `https://api.onkernel.com` by default. */\n  readonly baseUrl?: string;\n}\n\nconst regions = ['us-east', 'eu-west', 'ap-southeast'] as const;\n/** A CDP WebSocket over TLS, or plain only on this machine (a local proxy or a test). */\nconst secureSocket = /^(?:wss:\\/\\/|ws:\\/\\/(?:127\\.0\\.0\\.1|localhost|\\[::1\\])[:/])/u;\n\n/**\n * Browsers from Kernel: hosted Chromium, driven over CDP from any runtime, with no dependency. Each browser is created\n * when opened and deleted when released. Kernel keeps a browser running while it is connected, so its lifetime is kept\n * by `createBrowsers`; a browser left without a connection is deleted after `standbyTimeoutSeconds`.\n * Give the result to `createBrowsers` from `mayura/browser`.\n */\nexport function kernelBrowsers(options: KernelBrowserOptions): BrowserProvider {\n  if (!options || typeof options.apiKey !== 'string' || !/^[!-~]{8,512}$/u.test(options.apiKey)) throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): apiKey must be a Kernel API key.');\n  const liveView = options.liveView ?? 'view';\n  if (liveView !== 'view' && liveView !== 'interact' && liveView !== false) throw new MayuraError('INVALID_CONFIG', \"kernelBrowsers(): liveView is 'view', 'interact' or false.\");\n  if (options.stealth !== undefined && typeof options.stealth !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): stealth must be a boolean.');\n  if (options.region !== undefined && !regions.includes(options.region)) throw new MayuraError('INVALID_CONFIG', `kernelBrowsers(): region is one of ${regions.join(', ')}.`);\n  const standby = options.standbyTimeoutSeconds ?? 60;\n  if (!Number.isSafeInteger(standby) || standby < 10 || standby > 259_200) throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): standbyTimeoutSeconds is 10 to 259,200.');\n  const maxLifetimeMs = options.maxLifetimeMs ?? 86_400_000;\n  if (!Number.isSafeInteger(maxLifetimeMs) || maxLifetimeMs < 1_000 || maxLifetimeMs > 259_200_000) throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): maxLifetimeMs is 1 s to 72 hours.');\n  if (options.fetch !== undefined && typeof options.fetch !== 'function') throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): fetch must be a function.');\n  const base = (() => {\n    try { const url = new URL(options.baseUrl ?? 'https://api.onkernel.com'); if (url.protocol !== 'https:' && url.hostname !== '127.0.0.1' && url.hostname !== 'localhost') throw new Error(); return url.origin; }\n    catch { throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): baseUrl must be an https URL.'); }\n  })();\n  const fetcher = options.fetch ?? globalThis.fetch;\n  const headers = (json = false) => ({ authorization: `Bearer ${options.apiKey}`, ...(json ? { 'content-type': 'application/json' } : {}) });\n\n  const create = async (spec: ProviderBrowserSpec, { signal }: { readonly signal: AbortSignal }): Promise<BrowserBackend> => {\n    const created = await fetcher(`${base}/browsers`, { method: 'POST', signal, headers: headers(true), body: JSON.stringify({\n      timeout_seconds: standby,\n      // Kernel's live view needs a browser with a screen.\n      headless: liveView === false,\n      stealth: options.stealth ?? false,\n      viewport: { width: spec.viewport.width, height: spec.viewport.height },\n      ...(options.region ? { region: options.region } : {}),\n      ...(Object.keys(spec.labels).length ? { tags: { ...spec.labels } } : {}),\n    }) });\n    if (!created.ok) throw browserResponseFailure(created);\n    const browser = await created.json().catch(() => undefined) as { session_id?: unknown; cdp_ws_url?: unknown; browser_live_view_url?: unknown } | undefined;\n    if (typeof browser?.session_id !== 'string' || !/^[A-Za-z0-9_-]{1,128}$/u.test(browser.session_id) || typeof browser.cdp_ws_url !== 'string' || !secureSocket.test(browser.cdp_ws_url)) {\n      throw new BrowserError('invalid_response');\n    }\n    const id = browser.session_id;\n    let liveViewUrl: string | undefined;\n    // Without liveView, createBrowsers shows none (and a headless browser has none).\n    if (typeof browser.browser_live_view_url === 'string') {\n      try { const view = new URL(browser.browser_live_view_url); if (liveView === 'view') view.searchParams.set('readOnly', 'true'); liveViewUrl = view.href; }\n      catch { /* no live view */ }\n    }\n    return {\n      id, cdp: { url: browser.cdp_ws_url }, ...(liveViewUrl ? { liveViewUrl } : {}),\n      release: async ({ signal: callSignal }) => {\n        const reply = await fetcher(`${base}/browsers/${id}`, { method: 'DELETE', signal: callSignal, headers: headers() });\n        void reply.body?.cancel().catch(() => undefined);\n        // 404: deleted already, which createBrowsers counts as released.\n        if (!reply.ok) throw browserHttpFailure(reply.status);\n      },\n    };\n  };\n\n  return Object.freeze({ id: 'kernel', features: Object.freeze({ liveView: liveView !== false }), maxLifetimeMs, create });\n}\n"]}

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@mayurajs/browser-kernel",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.0",
+  "description": "Kernel browsers for mayura/browser, over its browsers API.",
+  "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-kernel"
+  },
+  "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.1.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/src/index.ts

@@ -0,0 +1,94 @@
+import { MayuraError } from 'mayura';
+import {
+  BrowserError, browserHttpFailure, browserResponseFailure,
+  type BrowserBackend, type BrowserProvider, type ProviderBrowserSpec,
+} from 'mayura/browser';
+
+export interface KernelBrowserOptions {
+  /** A Kernel API key. Nothing is read from the environment. */
+  readonly apiKey: string;
+  /**
+   * Give each browser a live view (`liveViewUrl`), a link with a token in it: `'view'` (the default) only shows the
+   * browser; `'interact'` also lets whoever has the link use it; `false` gives none, and runs the browser headless.
+   */
+  readonly liveView?: 'view' | 'interact' | false;
+  /** Kernel's stealth mode, which also turns on its captcha solver; off by default. */
+  readonly stealth?: boolean;
+  /** Where browsers run: `us-east` (Kernel's default), `eu-west` or `ap-southeast`. */
+  readonly region?: 'us-east' | 'eu-west' | 'ap-southeast';
+  /**
+   * How long a browser waits once nothing is connected before Kernel deletes it, in seconds: 60 by default (10 to
+   * 259,200). It ends a browser whose release never came, such as when this process stops.
+   */
+  readonly standbyTimeoutSeconds?: number;
+  /** The longest lifetime; 24 hours by default. */
+  readonly maxLifetimeMs?: number;
+  /** For tests and proxies: the fetch to use. */
+  readonly fetch?: typeof fetch;
+  /** The API's address; `https://api.onkernel.com` by default. */
+  readonly baseUrl?: string;
+}
+
+const regions = ['us-east', 'eu-west', 'ap-southeast'] as const;
+/** A CDP WebSocket over TLS, or plain only on this machine (a local proxy or a test). */
+const secureSocket = /^(?:wss:\/\/|ws:\/\/(?:127\.0\.0\.1|localhost|\[::1\])[:/])/u;
+
+/**
+ * Browsers from Kernel: hosted Chromium, driven over CDP from any runtime, with no dependency. Each browser is created
+ * when opened and deleted when released. Kernel keeps a browser running while it is connected, so its lifetime is kept
+ * by `createBrowsers`; a browser left without a connection is deleted after `standbyTimeoutSeconds`.
+ * Give the result to `createBrowsers` from `mayura/browser`.
+ */
+export function kernelBrowsers(options: KernelBrowserOptions): BrowserProvider {
+  if (!options || typeof options.apiKey !== 'string' || !/^[!-~]{8,512}$/u.test(options.apiKey)) throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): apiKey must be a Kernel API key.');
+  const liveView = options.liveView ?? 'view';
+  if (liveView !== 'view' && liveView !== 'interact' && liveView !== false) throw new MayuraError('INVALID_CONFIG', "kernelBrowsers(): liveView is 'view', 'interact' or false.");
+  if (options.stealth !== undefined && typeof options.stealth !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): stealth must be a boolean.');
+  if (options.region !== undefined && !regions.includes(options.region)) throw new MayuraError('INVALID_CONFIG', `kernelBrowsers(): region is one of ${regions.join(', ')}.`);
+  const standby = options.standbyTimeoutSeconds ?? 60;
+  if (!Number.isSafeInteger(standby) || standby < 10 || standby > 259_200) throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): standbyTimeoutSeconds is 10 to 259,200.');
+  const maxLifetimeMs = options.maxLifetimeMs ?? 86_400_000;
+  if (!Number.isSafeInteger(maxLifetimeMs) || maxLifetimeMs < 1_000 || maxLifetimeMs > 259_200_000) throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): maxLifetimeMs is 1 s to 72 hours.');
+  if (options.fetch !== undefined && typeof options.fetch !== 'function') throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): fetch must be a function.');
+  const base = (() => {
+    try { const url = new URL(options.baseUrl ?? 'https://api.onkernel.com'); if (url.protocol !== 'https:' && url.hostname !== '127.0.0.1' && url.hostname !== 'localhost') throw new Error(); return url.origin; }
+    catch { throw new MayuraError('INVALID_CONFIG', 'kernelBrowsers(): baseUrl must be an https URL.'); }
+  })();
+  const fetcher = options.fetch ?? globalThis.fetch;
+  const headers = (json = false) => ({ authorization: `Bearer ${options.apiKey}`, ...(json ? { 'content-type': 'application/json' } : {}) });
+
+  const create = async (spec: ProviderBrowserSpec, { signal }: { readonly signal: AbortSignal }): Promise<BrowserBackend> => {
+    const created = await fetcher(`${base}/browsers`, { method: 'POST', signal, headers: headers(true), body: JSON.stringify({
+      timeout_seconds: standby,
+      // Kernel's live view needs a browser with a screen.
+      headless: liveView === false,
+      stealth: options.stealth ?? false,
+      viewport: { width: spec.viewport.width, height: spec.viewport.height },
+      ...(options.region ? { region: options.region } : {}),
+      ...(Object.keys(spec.labels).length ? { tags: { ...spec.labels } } : {}),
+    }) });
+    if (!created.ok) throw browserResponseFailure(created);
+    const browser = await created.json().catch(() => undefined) as { session_id?: unknown; cdp_ws_url?: unknown; browser_live_view_url?: unknown } | undefined;
+    if (typeof browser?.session_id !== 'string' || !/^[A-Za-z0-9_-]{1,128}$/u.test(browser.session_id) || typeof browser.cdp_ws_url !== 'string' || !secureSocket.test(browser.cdp_ws_url)) {
+      throw new BrowserError('invalid_response');
+    }
+    const id = browser.session_id;
+    let liveViewUrl: string | undefined;
+    // Without liveView, createBrowsers shows none (and a headless browser has none).
+    if (typeof browser.browser_live_view_url === 'string') {
+      try { const view = new URL(browser.browser_live_view_url); if (liveView === 'view') view.searchParams.set('readOnly', 'true'); liveViewUrl = view.href; }
+      catch { /* no live view */ }
+    }
+    return {
+      id, cdp: { url: browser.cdp_ws_url }, ...(liveViewUrl ? { liveViewUrl } : {}),
+      release: async ({ signal: callSignal }) => {
+        const reply = await fetcher(`${base}/browsers/${id}`, { method: 'DELETE', signal: callSignal, headers: headers() });
+        void reply.body?.cancel().catch(() => undefined);
+        // 404: deleted already, which createBrowsers counts as released.
+        if (!reply.ok) throw browserHttpFailure(reply.status);
+      },
+    };
+  };
+
+  return Object.freeze({ id: 'kernel', features: Object.freeze({ liveView: liveView !== false }), maxLifetimeMs, create });
+}