@base44-preview/sdk 0.8.53-pr.327.be55878 → 0.8.53-pr.328.3b9beb7

package/dist/client.js

@@ -3,6 +3,7 @@ import { createEntitiesModule } from "./modules/entities.js";
 import { createIntegrationsModule } from "./modules/integrations.js";
 import { createAuthModule } from "./modules/auth.js";
 import { createSsoModule } from "./modules/sso.js";
+import { createBrowserModule } from "./modules/browser.js";
 import { createConnectorsModule, createUserConnectorsModule, } from "./modules/connectors.js";
 import { getAccessToken } from "./utils/auth-utils.js";
 import { createFetchWithAuth } from "./utils/fetch-with-auth.js";
@@ -226,6 +227,7 @@ export function createClient(config) {
         }),
         integrations: createIntegrationsModule(serviceRoleAxiosClient, appId),
         sso: createSsoModule(serviceRoleAxiosClient, appId),
+        browser: createBrowserModule(serviceRoleAxiosClient),
         connectors: createConnectorsModule(serviceRoleAxiosClient, appId),
         functions: createFunctionsModule(serviceRoleFunctionsAxiosClient, appId, {
             getAuthHeaders: () => {

package/dist/client.types.d.ts

@@ -2,6 +2,7 @@ import type { EntitiesModule } from "./modules/entities.types.js";
 import type { IntegrationsModule } from "./modules/integrations.types.js";
 import type { AuthModule } from "./modules/auth.types.js";
 import type { SsoModule } from "./modules/sso.types.js";
+import type { BrowserModule } from "./modules/browser.types.js";
 import type { ConnectorsModule, UserConnectorsModule } from "./modules/connectors.types.js";
 import type { FunctionsModule } from "./modules/functions.types.js";
 import type { AgentsModule } from "./modules/agents.types.js";
@@ -225,6 +226,8 @@ export interface Base44Client {
         aiGateway: AiGatewayModule;
         /** {@link AppLogsModule | App logs module} with elevated permissions. */
         appLogs: AppLogsModule;
+        /** {@link BrowserModule | Browser module} for remote browser sessions. */
+        browser: BrowserModule;
         /** {@link ConnectorsModule | Connectors module} for OAuth token retrieval. */
         connectors: ConnectorsModule;
         /** {@link EntitiesModule | Entities module} with elevated permissions. */

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export type { AppLogsModule } from "./modules/app-logs.types.js";
 export type { AppModule, AppPublicSettings, AppPublicSettingsResponse, } from "./modules/app.types.js";
 export type { ActorsModule, ActorClient, ActorRef, Connection, ActorSubscription, ActorConnectOptions, ActorNameRegistry, ActorRegistry, } from "./modules/actors.types.js";
 export type { SsoModule, SsoAccessTokenResponse } from "./modules/sso.types.js";
+export type { BrowserModule, BrowserSession, BrowserSessionOptions, } from "./modules/browser.types.js";
 export { Actor, type Conn } from "./actor.js";
 export type { ConnectorsModule, UserConnectorsModule, ConnectorApiRequest, ConnectorApiResponse, ConnectorApiResponsePhase, } from "./modules/connectors.types.js";
 export type { CustomIntegrationsModule, CustomIntegrationCallParams, CustomIntegrationCallResponse, } from "./modules/custom-integrations.types.js";

package/dist/modules/browser.d.ts

@@ -0,0 +1,10 @@
+import { AxiosInstance } from "axios";
+import { BrowserModule } from "./browser.types.js";
+/**
+ * Creates the Browser module for the Base44 SDK.
+ *
+ * @param axios - Axios instance (should be service role client)
+ * @returns Browser module with methods to create remote browser sessions
+ * @internal
+ */
+export declare function createBrowserModule(axios: AxiosInstance): BrowserModule;

package/dist/modules/browser.js

@@ -0,0 +1,28 @@
+/**
+ * Creates the Browser module for the Base44 SDK.
+ *
+ * @param axios - Axios instance (should be service role client)
+ * @returns Browser module with methods to create remote browser sessions
+ * @internal
+ */
+export function createBrowserModule(axios) {
+    return {
+        async getSession(options = {}) {
+            var _a;
+            // The app is derived from the service token, so the route isn't app-scoped.
+            const response = await axios.post("/v1/browser-sessions", { capture_debug_artifacts: (_a = options.captureDebugArtifacts) !== null && _a !== void 0 ? _a : true });
+            const data = response;
+            return {
+                sessionId: data.session_id,
+                connectionUrl: data.connection_url,
+                connectionScope: data.connection_scope,
+                ...(data.connection_expires_at && {
+                    connectionExpiresAt: data.connection_expires_at,
+                }),
+                ...(data.session_expires_at && {
+                    sessionExpiresAt: data.session_expires_at,
+                }),
+            };
+        },
+    };
+}

package/dist/modules/browser.types.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Options for {@linkcode BrowserModule.getSession | getSession()}.
+ */
+export interface BrowserSessionOptions {
+    /**
+     * Whether to capture browser recordings and diagnostic logs for the session.
+     *
+     * Captured artifacts stay with the remote browser provider and can't be retrieved through the SDK. Defaults to `true`.
+     */
+    captureDebugArtifacts?: boolean;
+}
+/**
+ * A remote browser session returned by {@linkcode BrowserModule.getSession | getSession()}.
+ */
+export interface BrowserSession {
+    /** Opaque session identifier issued by the remote browser provider. */
+    sessionId: string;
+    /**
+     * Signed WebSocket URL for connecting to the browser over the Chrome DevTools Protocol (CDP).
+     *
+     * Treat the complete URL as a credential. Don't log it or send it to the frontend.
+     */
+    connectionUrl: string;
+    /**
+     * Scope of the CDP connection.
+     *
+     * - `'browser'`: The socket controls the whole browser.
+     * - `'page'`: The socket controls a single page.
+     */
+    connectionScope: "browser" | "page";
+    /** ISO 8601 timestamp when the connection URL expires. Omitted when the provider doesn't expose it. */
+    connectionExpiresAt?: string;
+    /** ISO 8601 timestamp when the browser session expires. Omitted when the provider doesn't expose it. */
+    sessionExpiresAt?: string;
+}
+/**
+ * Browser module for running browser automation from your backend.
+ *
+ * This module creates remote browser sessions that you can control with a CDP client library such as Playwright or Puppeteer. Base44 doesn't store browser state, so each session is independent.
+ *
+ * This module is only available to use with a client in service role authentication mode, which means it can only be used in backend environments.
+ */
+export interface BrowserModule {
+    /**
+     * Creates a new remote browser session and returns its connection details.
+     *
+     * Each call creates a fresh session. Calls aren't retried automatically, and repeating a failed call doesn't resume a previous session. Session creation is rate limited per app.
+     *
+     * @param options - Optional session settings.
+     * @returns Promise resolving to the new browser session.
+     *
+     * @example
+     * ```typescript
+     * // Open a page in a remote browser with Playwright
+     * import { createClientFromRequest } from 'npm:@base44/sdk';
+     * import { chromium } from 'npm:playwright-core';
+     *
+     * Deno.serve(async (req) => {
+     *   const base44 = createClientFromRequest(req);
+     *   const { connectionUrl } = await base44.asServiceRole.browser.getSession();
+     *
+     *   const browser = await chromium.connectOverCDP(connectionUrl);
+     *   const page = browser.contexts()[0].pages()[0] ?? (await browser.newPage());
+     *   await page.goto('https://example.com');
+     *   const title = await page.title();
+     *   await browser.close();
+     *
+     *   return Response.json({ title });
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Turn off recordings and diagnostic logs
+     * const session = await base44.asServiceRole.browser.getSession({
+     *   captureDebugArtifacts: false,
+     * });
+     * ```
+     */
+    getSession(options?: BrowserSessionOptions): Promise<BrowserSession>;
+}

package/dist/modules/browser.types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.53-pr.327.be55878",
+  "version": "0.8.53-pr.328.3b9beb7",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",