@base44-preview/sdk 0.8.51-pr.294.a7ae332 → 0.8.52-pr.286.58a3186

package/README.md

@@ -151,3 +151,13 @@ npm run create-docs
 cd docs
 mintlify dev
 ```
+
+### Platform browser subscriptions
+
+The separate `@base44/sdk/platform/client` entry point watches public builder
+updates for up to eight apps over the platform socket. It supports typed events,
+a snapshot on every join and bounded delivery, using a socket-session token your
+backend opens with its workspace key.
+See [setup, public contract and recovery](platform-docs/client.md) and the
+[TypeScript example](examples/platform-client.ts). White-label sockets must be enabled
+for the workspace; never use an API key in the browser.

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

@@ -127,7 +127,7 @@ export interface UploadPrivateFileResult {
 export interface CreateFileSignedUrlParams {
     /** URI of the uploaded private file. */
     file_uri: string;
-    /** How long the signed URL should be valid for, in seconds.
+    /** How long the signed URL should be valid for, in seconds. Must be between `60` (1 minute) and `3600` (1 hour).
      * @default 300 (5 minutes)
      */
     expires_in?: number;
@@ -352,7 +352,7 @@ export interface CoreIntegrations {
      * // Create a signed URL for a private file
      * const { signed_url } = await base44.integrations.Core.CreateFileSignedUrl({
      *   file_uri: "private/user123/document.pdf",
-     *   expires_in: 7200 // URL expires in 2 hours
+     *   expires_in: 1800 // URL expires in 30 minutes
      * });
      * console.log(signed_url); // https://...?signature=...
      * ```

package/dist/platform/client/client.d.ts

@@ -0,0 +1,9 @@
+import type { PlatformClientOptions } from "./client.types.js";
+import type { BuilderModule } from "./modules/builder.types.js";
+/** Browser platform client. Construction creates no sockets, timers or network requests. */
+export declare class Base44PlatformClient {
+    /** Lazy builder subscriptions with independent session lifecycles. */
+    readonly builder: BuilderModule;
+    /** Configure shared service/auth settings; each module initializes its own resources. */
+    constructor(options: PlatformClientOptions);
+}

package/dist/platform/client/client.js

@@ -0,0 +1,12 @@
+import { createBuilder } from "./modules/builder.js";
+/** Browser platform client. Construction creates no sockets, timers or network requests. */
+export class Base44PlatformClient {
+    /** Configure shared service/auth settings; each module initializes its own resources. */
+    constructor(options) {
+        const url = new URL(options.serverUrl);
+        if (!["https:", "http:"].includes(url.protocol) || url.username || url.password || url.search || url.hash || url.pathname !== "/") {
+            throw new TypeError("serverUrl must be an HTTP(S) origin without credentials, path, query or fragment");
+        }
+        this.builder = Object.freeze(createBuilder({ ...options, serverUrl: url.origin }));
+    }
+}

package/dist/platform/client/client.types.d.ts

@@ -0,0 +1,12 @@
+/** Shared configuration for browser platform modules. Never supply an API key. */
+export interface PlatformClientOptions {
+    /** Origin of the platform service, e.g. https://base44.app. No path/query/credentials. */
+    serverUrl: string;
+    /**
+     * Return a socket-session token from your backend, which opens the session with its
+     * workspace key (`POST /api/service/socket-sessions`) for the apps this page watches.
+     * Called when a builder session first connects, and again only after the server
+     * rejects or expires the current session. Sessions last one hour.
+     */
+    getSessionToken: () => string | Promise<string>;
+}

package/dist/platform/client/client.types.js

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

package/dist/platform/client/errors.d.ts

@@ -0,0 +1,10 @@
+import type { PlatformSocketErrorCode } from "./errors.types.js";
+/** Sanitized failure. Original session-token provider, handler and server exceptions are not retained. */
+export declare class PlatformSocketError extends Error {
+    /** Stable machine-readable category. */
+    readonly code: PlatformSocketErrorCode;
+    /** Associated app, when the server identifies a valid room. */
+    readonly appId?: string;
+    /** Create a sanitized error with no credential-bearing cause or payload. */
+    constructor(code: PlatformSocketErrorCode, appId?: string);
+}

package/dist/platform/client/errors.js

@@ -0,0 +1,10 @@
+/** Sanitized failure. Original session-token provider, handler and server exceptions are not retained. */
+export class PlatformSocketError extends Error {
+    /** Create a sanitized error with no credential-bearing cause or payload. */
+    constructor(code, appId) {
+        super(`Platform socket: ${code}`);
+        this.name = "PlatformSocketError";
+        this.code = code;
+        this.appId = appId;
+    }
+}

package/dist/platform/client/errors.types.d.ts

@@ -0,0 +1,2 @@
+/** Server refusals and client transport/processing failures. */
+export type PlatformSocketErrorCode = "connection_denied" | "connection_failed" | "session_unavailable" | "session_revoked" | "session_replaced" | "access_denied" | "access_revoked" | "snapshot_unavailable" | "subscription_limit" | "delivery_overflow" | "protocol_error" | "handler_failed" | "client_closed";

package/dist/platform/client/errors.types.js

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

package/dist/platform/client/index.d.ts

@@ -0,0 +1,7 @@
+/** Browser platform modules, separate from the runtime and server SDKs. */
+export { Base44PlatformClient } from "./client.js";
+export { PlatformSocketError } from "./errors.js";
+export type { PlatformSocketErrorCode } from "./errors.types.js";
+export type { PlatformClientOptions } from "./client.types.js";
+export type { BuilderModule, BuilderInitOptions, BuilderSession, PlatformSubscription, SubscriptionOptions } from "./modules/builder.types.js";
+export type { AppStatus, AppStatusChanged, BranchScoped, ChatMessage, ImageResolved, MessageParams, MessageRemoved, MessageUpdated, PlatformEvent, PlatformEventMap, PreviewNavigationRequested, QueueItem, QueueUpdated, Snapshot, SnapshotQueue, TaskProgressed, ToolArguments, ToolCall, ToolDisplay, ToolEntityMutationArguments, ToolGuardApproval, ToolMediaArguments, ToolMediaResult, ToolPackageArguments, ToolPackageOperation, ToolPlanArguments, ToolPlanUpdate, ToolPrdArguments, ToolQuestion, ToolQuestionAnswer, ToolQuestionArguments, ToolQuestionInput, ToolQuestionOption, ToolSecretArguments, ToolSecretField, } from "./modules/builder.events.types.js";

package/dist/platform/client/index.js

@@ -0,0 +1,3 @@
+/** Browser platform modules, separate from the runtime and server SDKs. */
+export { Base44PlatformClient } from "./client.js";
+export { PlatformSocketError } from "./errors.js";

package/dist/platform/client/modules/builder-protocol.d.ts

@@ -0,0 +1,15 @@
+import type { PlatformEvent, PlatformEventMap, Snapshot } from "./builder.events.types.js";
+export declare const eventNames: readonly ["message.updated", "message.removed", "app.status_changed", "preview.reload_requested", "preview.navigation_requested", "queue.updated", "task.progressed", "image.resolved", "conversation.changed", "files.changed", "branch.deleted", "repository.changed", "pull_request.changed"];
+/** Notices that name an app room, by the error code each one reports. */
+export declare const roomNotices: {
+    readonly "room.access_denied": "access_denied";
+    readonly "room.access_revoked": "access_revoked";
+    readonly "room.snapshot_unavailable": "snapshot_unavailable";
+};
+export declare const appPattern: RegExp;
+export declare const roomFor: (appId: string) => string;
+export declare function object(value: unknown): Record<string, unknown>;
+export declare function appFromRoom(value: unknown): string | undefined;
+/** Every event is `{room, data}`; payload schemas are the service's, so only the envelope is validated. */
+export declare function decode(type: keyof PlatformEventMap, appId: string, raw: unknown): PlatformEvent;
+export declare function decodeSnapshot(raw: unknown): Snapshot;

package/dist/platform/client/modules/builder-protocol.js

@@ -0,0 +1,34 @@
+export const eventNames = [
+    "message.updated", "message.removed", "app.status_changed", "preview.reload_requested",
+    "preview.navigation_requested", "queue.updated", "task.progressed", "image.resolved",
+    "conversation.changed", "files.changed", "branch.deleted", "repository.changed", "pull_request.changed",
+];
+/** Notices that name an app room, by the error code each one reports. */
+export const roomNotices = {
+    "room.access_denied": "access_denied",
+    "room.access_revoked": "access_revoked",
+    "room.snapshot_unavailable": "snapshot_unavailable",
+};
+export const appPattern = /^[a-f0-9]{24}$/;
+export const roomFor = (appId) => `/apps/${appId}`;
+export function object(value) {
+    if (!value || typeof value !== "object" || Array.isArray(value))
+        throw new Error("Invalid frame");
+    return value;
+}
+export function appFromRoom(value) {
+    return typeof value === "string" && /^\/apps\/[a-f0-9]{24}$/.test(value) ? value.slice(6) : undefined;
+}
+/** Every event is `{room, data}`; payload schemas are the service's, so only the envelope is validated. */
+export function decode(type, appId, raw) {
+    return { type, appId, data: object(object(raw).data) };
+}
+export function decodeSnapshot(raw) {
+    const frame = object(raw);
+    const data = object(frame.data);
+    if (!appFromRoom(frame.room) || !Array.isArray(data.messages) || (data.status !== null && typeof data.status !== "object")) {
+        throw new Error("Invalid snapshot");
+    }
+    const queue = data.queue !== null && typeof data.queue === "object" ? { queue: data.queue } : {};
+    return { room: frame.room, status: data.status, messages: data.messages, ...queue };
+}

package/dist/platform/client/modules/builder-socket.d.ts

@@ -0,0 +1,42 @@
+import type { PlatformClientOptions } from "../client.types.js";
+import type { BuilderInitOptions, BuilderSession, PlatformSubscription, SubscriptionOptions } from "./builder.types.js";
+/** @internal */
+export declare class BuilderSocket implements BuilderSession {
+    private readonly socket;
+    private readonly subscriptions;
+    private readonly options;
+    private closed;
+    private token?;
+    private tokenFresh;
+    private ending?;
+    private denialRetries;
+    private retryTimer?;
+    private authAttempt;
+    private cancelAuth?;
+    private connecting?;
+    private resolveConnect?;
+    private rejectConnect?;
+    constructor(config: PlatformClientOptions, options: BuilderInitOptions);
+    /** Connect with the session token. Resolves on CONNECT, before snapshots arrive.
+     * Transport loss retries up to five times and rejoins active subscriptions.
+     * Call again after a failure or `session_replaced`; concurrent calls share one attempt.
+     */
+    connect(): Promise<void>;
+    /** Subscribe before or after connecting. One subscription per app, maximum eight, each on the
+     * session's allowlist. Snapshots and events are awaited in order per app; a failed callback,
+     * an invalid frame or a server refusal ends the subscription.
+     */
+    subscribe(appId: string, options: SubscriptionOptions): PlatformSubscription;
+    /** Stop delivery, cancel reconnection and release all listeners. Idempotent and terminal. */
+    close(): void;
+    private join;
+    private authenticate;
+    /** A connect the server refused. Transport errors are Socket.IO's to retry. */
+    private refused;
+    private retryDenied;
+    private clearConnecting;
+    private connectionError;
+    private sessionEnded;
+    private roomNotice;
+    private protocolError;
+}

package/dist/platform/client/modules/builder-socket.js

@@ -0,0 +1,252 @@
+import { io } from "socket.io-client";
+import { PlatformSocketError } from "../errors.js";
+import { appFromRoom, appPattern, decode, decodeSnapshot, eventNames, object, roomFor, roomNotices } from "./builder-protocol.js";
+import { notify, Subscription } from "./builder-subscription.js";
+const MAX_DENIAL_RETRIES = 5;
+/** @internal */
+export class BuilderSocket {
+    constructor(config, options) {
+        this.subscriptions = new Map();
+        this.closed = false;
+        this.tokenFresh = false;
+        this.denialRetries = 0;
+        this.authAttempt = 0;
+        this.options = { ...config, onError: options.onError };
+        this.socket = io(config.serverUrl, {
+            path: "/ws/socket.io/", transports: ["websocket"], autoConnect: false,
+            forceNew: true, reconnectionAttempts: 5, reconnectionDelay: 1000, reconnectionDelayMax: 10000,
+            timeout: 20000,
+            auth: (callback) => { void this.authenticate(callback); },
+        });
+        this.socket.on("connect", () => {
+            var _a;
+            this.tokenFresh = false;
+            this.denialRetries = 0;
+            for (const subscription of this.subscriptions.values())
+                this.join(subscription);
+            (_a = this.resolveConnect) === null || _a === void 0 ? void 0 : _a.call(this);
+            this.clearConnecting();
+        });
+        this.socket.on("disconnect", (reason) => {
+            ++this.authAttempt;
+            if (this.closed || reason !== "io server disconnect")
+                return; // Transport loss reconnects by itself.
+            const ending = this.ending;
+            this.ending = undefined;
+            if (ending === "session_expired")
+                this.socket.connect(); // Renew through getSessionToken.
+            else
+                this.connectionError(new PlatformSocketError(ending !== null && ending !== void 0 ? ending : "connection_failed"));
+        });
+        this.socket.on("connect_error", (error) => this.refused(error));
+        this.socket.io.on("reconnect_failed", () => this.connectionError(new PlatformSocketError("connection_failed")));
+        this.socket.on("app.snapshot", (raw) => {
+            var _a;
+            try {
+                const snapshot = decodeSnapshot(raw);
+                (_a = this.subscriptions.get(appFromRoom(snapshot.room))) === null || _a === void 0 ? void 0 : _a.snapshot(snapshot);
+            }
+            catch (_b) {
+                this.protocolError(raw);
+            }
+        });
+        this.socket.on("session.ended", (raw) => this.sessionEnded(raw));
+        for (const [name, code] of Object.entries(roomNotices))
+            this.socket.on(name, (raw) => this.roomNotice(code, raw));
+        for (const type of eventNames)
+            this.socket.on(type, (raw) => {
+                try {
+                    const appId = appFromRoom(object(raw).room);
+                    if (!appId)
+                        throw new Error("Invalid app");
+                    const event = decode(type, appId, raw);
+                    const subscription = this.subscriptions.get(appId);
+                    subscription === null || subscription === void 0 ? void 0 : subscription.event(event);
+                    // The server does not resend a snapshot after a rewrite of main: rejoining asks for one.
+                    if (subscription && event.type === "conversation.changed" && event.data.branch_id == null)
+                        this.join(subscription);
+                }
+                catch (_a) {
+                    this.protocolError(raw);
+                }
+            });
+    }
+    /** Connect with the session token. Resolves on CONNECT, before snapshots arrive.
+     * Transport loss retries up to five times and rejoins active subscriptions.
+     * Call again after a failure or `session_replaced`; concurrent calls share one attempt.
+     */
+    connect() {
+        if (this.closed)
+            return Promise.reject(new PlatformSocketError("client_closed"));
+        if (this.socket.connected)
+            return Promise.resolve();
+        if (this.connecting)
+            return this.connecting;
+        const promise = new Promise((resolve, reject) => {
+            this.resolveConnect = resolve;
+            this.rejectConnect = reject;
+        });
+        this.connecting = promise;
+        this.socket.connect();
+        return promise;
+    }
+    /** Subscribe before or after connecting. One subscription per app, maximum eight, each on the
+     * session's allowlist. Snapshots and events are awaited in order per app; a failed callback,
+     * an invalid frame or a server refusal ends the subscription.
+     */
+    subscribe(appId, options) {
+        if (this.closed)
+            throw new PlatformSocketError("client_closed");
+        if (!appPattern.test(appId))
+            throw new TypeError("appId must be 24 lowercase hexadecimal characters");
+        if (this.subscriptions.has(appId))
+            throw new TypeError("An app may only have one subscription per builder session");
+        if (this.subscriptions.size >= 8)
+            throw new PlatformSocketError("subscription_limit", appId);
+        const subscription = new Subscription(appId, { ...options }, () => {
+            this.subscriptions.delete(appId);
+            if (this.socket.connected)
+                this.socket.emit("leave", roomFor(appId));
+        });
+        this.subscriptions.set(appId, subscription);
+        if (this.socket.connected)
+            this.join(subscription);
+        return subscription;
+    }
+    /** Stop delivery, cancel reconnection and release all listeners. Idempotent and terminal. */
+    close() {
+        var _a, _b;
+        if (this.closed)
+            return;
+        this.closed = true;
+        ++this.authAttempt;
+        (_a = this.cancelAuth) === null || _a === void 0 ? void 0 : _a.call(this);
+        clearTimeout(this.retryTimer);
+        for (const subscription of this.subscriptions.values())
+            subscription.unsubscribe();
+        (_b = this.rejectConnect) === null || _b === void 0 ? void 0 : _b.call(this, new PlatformSocketError("client_closed"));
+        this.clearConnecting();
+        this.socket.removeAllListeners();
+        this.socket.io.removeAllListeners();
+        this.socket.disconnect();
+    }
+    join(subscription) {
+        this.socket.emit("join", roomFor(subscription.appId));
+    }
+    async authenticate(callback) {
+        var _a;
+        const attempt = ++this.authAttempt;
+        (_a = this.cancelAuth) === null || _a === void 0 ? void 0 : _a.call(this);
+        let timer;
+        const timeout = new Promise((_, reject) => {
+            timer = setTimeout(() => reject(new Error("Session token timeout")), 20000);
+            this.cancelAuth = () => { clearTimeout(timer); reject(new Error("Cancelled")); };
+        });
+        try {
+            if (!this.token) {
+                const token = await Promise.race([Promise.resolve().then(() => this.options.getSessionToken()), timeout]);
+                if (this.closed || attempt !== this.authAttempt)
+                    return;
+                if (typeof token !== "string" || !token.trim())
+                    throw new Error("Missing session token");
+                this.token = token;
+                this.tokenFresh = true;
+            }
+            callback({ session_token: this.token });
+        }
+        catch (_b) {
+            if (this.closed || attempt !== this.authAttempt)
+                return;
+            this.socket.disconnect();
+            this.connectionError(new PlatformSocketError("session_unavailable"));
+        }
+        finally {
+            clearTimeout(timer);
+            if (attempt === this.authAttempt)
+                this.cancelAuth = undefined;
+        }
+    }
+    /** A connect the server refused. Transport errors are Socket.IO's to retry. */
+    refused(error) {
+        var _a;
+        if (this.closed || error.message !== "connection_denied")
+            return;
+        if (((_a = error.data) === null || _a === void 0 ? void 0 : _a.retryable) === true) {
+            this.retryDenied();
+            return;
+        }
+        // A token this attempt did not just fetch may have expired: renew it once.
+        const renew = !this.tokenFresh;
+        this.token = undefined;
+        if (renew)
+            this.socket.connect();
+        else
+            this.connectionError(new PlatformSocketError("connection_denied"));
+    }
+    retryDenied() {
+        if (++this.denialRetries > MAX_DENIAL_RETRIES) {
+            this.denialRetries = 0;
+            this.connectionError(new PlatformSocketError("connection_failed"));
+            return;
+        }
+        const delay = Math.min(1000 * 2 ** (this.denialRetries - 1), 10000) * (0.5 + Math.random() / 2);
+        this.retryTimer = setTimeout(() => { this.retryTimer = undefined; if (!this.closed)
+            this.socket.connect(); }, delay);
+    }
+    clearConnecting() {
+        this.connecting = undefined;
+        this.resolveConnect = undefined;
+        this.rejectConnect = undefined;
+    }
+    connectionError(error) {
+        var _a;
+        (_a = this.rejectConnect) === null || _a === void 0 ? void 0 : _a.call(this, error);
+        this.clearConnecting();
+        if (!this.closed)
+            notify(this.options.onError, error);
+    }
+    sessionEnded(raw) {
+        try {
+            const reason = object(object(raw).data).reason;
+            const ending = reason === "expired" ? "session_expired"
+                : reason === "revoked" ? "session_revoked"
+                    : reason === "replaced" ? "session_replaced" : undefined;
+            if (!ending)
+                throw new Error("Unknown reason");
+            // The server disconnects next; the disconnect handler renews or stops.
+            this.token = undefined;
+            this.ending = ending;
+        }
+        catch (_a) {
+            this.protocolError(raw);
+        }
+    }
+    roomNotice(code, raw) {
+        try {
+            const appId = appFromRoom(object(raw).room);
+            if (!appId)
+                throw new Error("Invalid app");
+            const subscription = this.subscriptions.get(appId);
+            if (code === "snapshot_unavailable")
+                subscription === null || subscription === void 0 ? void 0 : subscription.warn(code);
+            else
+                subscription === null || subscription === void 0 ? void 0 : subscription.fail(code);
+        }
+        catch (_a) {
+            this.protocolError(raw);
+        }
+    }
+    protocolError(raw) {
+        var _a;
+        const frame = raw && typeof raw === "object" ? raw : {};
+        const appId = appFromRoom(frame.room);
+        if (appId)
+            (_a = this.subscriptions.get(appId)) === null || _a === void 0 ? void 0 : _a.fail("protocol_error");
+        else {
+            // Unknown routing: no app can be told which update it missed.
+            for (const subscription of [...this.subscriptions.values()])
+                subscription.fail("protocol_error");
+            this.connectionError(new PlatformSocketError("protocol_error"));
+        }
+    }
+}

package/dist/platform/client/modules/builder-subscription.d.ts

@@ -0,0 +1,23 @@
+import type { PlatformEvent, Snapshot } from "./builder.events.types.js";
+import { PlatformSocketError } from "../errors.js";
+import type { PlatformSocketErrorCode } from "../errors.types.js";
+import type { PlatformSubscription, SubscriptionOptions } from "./builder.types.js";
+/** @internal */
+export declare function notify(callback: (error: PlatformSocketError) => void, error: PlatformSocketError): void;
+/** @internal */
+export declare class Subscription implements PlatformSubscription {
+    readonly appId: string;
+    private options;
+    private remove;
+    active: boolean;
+    private pending;
+    private tail;
+    constructor(appId: string, options: SubscriptionOptions, remove: () => void);
+    private enqueue;
+    event(event: PlatformEvent): void;
+    snapshot(snapshot: Snapshot): void;
+    /** A non-fatal problem; the subscription keeps receiving events. */
+    warn(code: PlatformSocketErrorCode): void;
+    fail(code: PlatformSocketErrorCode): void;
+    unsubscribe(): void;
+}

package/dist/platform/client/modules/builder-subscription.js

@@ -0,0 +1,55 @@
+import { PlatformSocketError } from "../errors.js";
+/** @internal */
+export function notify(callback, error) {
+    try {
+        callback(error);
+    }
+    catch ( /* An error observer cannot interrupt other app subscriptions. */_a) { /* An error observer cannot interrupt other app subscriptions. */ }
+}
+/** @internal */
+export class Subscription {
+    constructor(appId, options, remove) {
+        this.appId = appId;
+        this.options = options;
+        this.remove = remove;
+        this.active = true;
+        this.pending = 0;
+        this.tail = Promise.resolve();
+    }
+    enqueue(work) {
+        if (!this.active)
+            return;
+        if (this.pending >= 1000) {
+            this.fail("delivery_overflow");
+            return;
+        }
+        this.pending++;
+        this.tail = this.tail.then(async () => {
+            if (this.active)
+                await work();
+        }).catch(() => this.fail("handler_failed")).finally(() => { this.pending--; });
+    }
+    event(event) {
+        this.enqueue(() => this.options.onEvent(event));
+    }
+    snapshot(snapshot) {
+        this.enqueue(() => this.options.onSnapshot(snapshot));
+    }
+    /** A non-fatal problem; the subscription keeps receiving events. */
+    warn(code) {
+        if (this.active)
+            notify(this.options.onError, new PlatformSocketError(code, this.appId));
+    }
+    fail(code) {
+        if (!this.active)
+            return;
+        this.unsubscribe();
+        notify(this.options.onError, new PlatformSocketError(code, this.appId));
+    }
+    unsubscribe() {
+        if (!this.active)
+            return;
+        this.active = false;
+        this.remove();
+    }
+}

package/dist/platform/client/modules/builder.d.ts

@@ -0,0 +1,4 @@
+import type { PlatformClientOptions } from "../client.types.js";
+import type { BuilderModule } from "./builder.types.js";
+/** @internal */
+export declare function createBuilder(config: PlatformClientOptions): BuilderModule;

package/dist/platform/client/modules/builder.events.types.d.ts

@@ -0,0 +1,368 @@
+/** Activity a file, execution or entity tool declared public. */
+export interface ToolDisplay {
+    /** Changed file paths for a file operation. Source bodies and diffs are never included. */
+    file_paths?: string[];
+    /** Whether a file write intentionally used empty content. */
+    content_empty?: boolean;
+    /** Reviewed execution activity summary. Commands and execution output are never included. */
+    summary?: string;
+    /** Whether a reviewed execution action changed entity data. */
+    writes_entities?: boolean;
+    /** Entity type affected by an entity operation. Records and query values are never included. */
+    entity_name?: string;
+    /** Number of records affected when supplied by the producer. */
+    record_count?: number;
+}
+/** A selectable answer to a builder question. */
+export interface ToolQuestionOption {
+    /** Visible option label. */
+    label?: string;
+}
+/** A builder question. Image/HTML source and private design context are excluded. */
+export interface ToolQuestion {
+    /** Visible question text. */
+    question?: string;
+    /** Question category. */
+    type?: string;
+    /** Optional visible supporting text. */
+    description?: string;
+    /** Whether more than one answer may be selected. */
+    multi_select?: boolean;
+    /** Plan section the question covers. */
+    covers?: string;
+    /** Selectable options; a bare string option is its label. */
+    options?: (ToolQuestionOption | string)[];
+}
+/** `ask_clarifying_questions` and `ask_plan_questions` arguments. */
+export interface ToolQuestionArguments {
+    /** Questions presented to the user. */
+    questions?: ToolQuestion[];
+}
+/** A requested secret field. The secret value is never sent over the socket. */
+export interface ToolSecretField {
+    /** Requested secret name. */
+    secretName?: string;
+    /** Optional explanation of where to obtain it. */
+    description?: string;
+}
+/** `set_secrets` arguments. */
+export interface ToolSecretArguments {
+    /** Requested secret fields. */
+    secrets_schema?: ToolSecretField[];
+}
+/** A package operation. Versions and package-manager output are excluded. */
+export interface ToolPackageOperation {
+    /** Package name. */
+    name?: string;
+    /** Requested package operation. */
+    action?: string;
+}
+/** `install_npm_package` arguments. */
+export interface ToolPackageArguments {
+    /** Requested package operations. */
+    packages?: ToolPackageOperation[];
+}
+/** An add-only builder plan update. */
+export interface ToolPlanUpdate {
+    /** Update action. */
+    action?: string;
+    /** Plan section key. */
+    section?: string;
+    /** Optional user-facing section label. */
+    section_label?: string;
+    /** Plan point. */
+    text?: string;
+}
+/** `update_plan` arguments. */
+export interface ToolPlanArguments {
+    /** Plan updates in their emitted order. */
+    updates?: ToolPlanUpdate[];
+    /** Base plan sections the builder considers sufficiently specified. */
+    sections_with_enough?: string[];
+}
+/** `generate_prd` arguments: the user's own plan. In plan mode the message `content` beside it can be empty. */
+export interface ToolPrdArguments {
+    /** App or feature name. */
+    app_name?: string;
+    /** What is being built and why. */
+    intent_and_goal?: string;
+    /** Who uses it and their roles. */
+    audience_and_roles?: string;
+    /** End-to-end user flows. */
+    core_flows?: string[];
+    /** Specific technical requirements. */
+    technical_requirements?: string;
+    /** Design preferences. */
+    design_preferences?: string;
+    /** Build or plan declaration, when the builder asks for one. */
+    prd_type?: string;
+    /** Store platform settled in planning, for e-commerce plans. */
+    store_platform?: string;
+    /** Engine settled in planning, for game plans. */
+    game_engine?: string;
+}
+/** Image, game-image and video generation arguments. */
+export interface ToolMediaArguments {
+    /** Visible media label. */
+    label?: string;
+    /** Requested image or video aspect ratio. */
+    aspect_ratio?: string;
+}
+/** `update_entities` and `delete_entities` arguments; the entity is in `display.entity_name`. */
+export interface ToolEntityMutationArguments {
+    /** The agent's summary of the change. Queries and record values are never included. */
+    summary?: string;
+}
+/** The public arguments of a tool that declares them; narrow by the tool call's `name`. */
+export type ToolArguments = ToolQuestionArguments | ToolSecretArguments | ToolPackageArguments | ToolPlanArguments | ToolPrdArguments | ToolMediaArguments | ToolEntityMutationArguments;
+/** Generated-media state. Raw generation prompts and IDs are never included. */
+export interface ToolMediaResult {
+    /** Placeholder URL, used to associate an `image.resolved` event with this tool. */
+    placeholder_url?: string;
+    /** Current media-generation status. */
+    status?: "pending" | "completed" | "failed";
+    /** Generated asset URL, once available. */
+    image_url?: string | null;
+}
+/** An answer to a clarifying question. Secret-form input is never included. */
+export interface ToolQuestionAnswer {
+    /** Zero-based question index. */
+    question_index?: number;
+    /** Label selected for a single-select question. */
+    selected_label?: string;
+    /** Labels selected for a multi-select question. */
+    selected_labels?: string[];
+    /** User-provided free-text answer. Structural filtering does not redact prose. */
+    custom_text?: string;
+}
+/** Clarifying-question answers. */
+export interface ToolQuestionInput {
+    /** Answers supplied to the question card. */
+    answers?: ToolQuestionAnswer[];
+}
+/** Why a safety guard parked a call for approval. Only present while the call waits. */
+export interface ToolGuardApproval {
+    /** Guard identifier, e.g. `exec_tool_send_email` or `bash_approval`. */
+    guard: string;
+    /** Human-readable reason, for guards whose reason never quotes input (not shell commands). */
+    reason?: string;
+    /** The details the guard declares public; commands and record data are never included. */
+    details?: {
+        /** Entity method the code calls, e.g. `delete`. */
+        method?: string;
+        /** The agent's summary of what the code does. */
+        summary?: string;
+        /** Entity whose access rules change. */
+        entity_name?: string;
+        /** How the access rules change. */
+        change_type?: string;
+        /** Access operations whose rules change. */
+        changed_ops?: string[];
+        /** Backend function under test. */
+        function_name?: string;
+        /** The guard could not verify the function's source. */
+        inspection_failed?: boolean;
+    };
+}
+/** Public progress of a builder tool call. Only what the tool and its guard declare public is present. */
+export interface ToolCall {
+    /** Stable tool call identifier. */
+    id?: string;
+    /** Tool name. */
+    name?: string;
+    /** Current execution state. */
+    status?: "running" | "success" | "error" | "stopped" | "waiting_for_user_input";
+    /** Whether the tool needs a user response through the partner backend. */
+    requires_user_input?: boolean;
+    /** Whether the builder auto-approved the operation. */
+    auto_approved?: boolean;
+    /** Whether the mutation was applied. */
+    mutation_applied?: boolean | null;
+    /** Kind of response a parked call waits for. */
+    waiting_on?: {
+        /** Kind of response expected. */
+        kind?: "approval" | "choice" | "input";
+    };
+    /** The tool's public arguments; absent for tools that declare none and for partial streaming arguments. */
+    arguments?: ToolArguments;
+    /** What a file, execution or entity tool touched. */
+    display?: ToolDisplay;
+    /** Clarifying-question answers. */
+    user_input?: ToolQuestionInput;
+    /** Generated media, once the call is not waiting on a guard: the image tool's state, or a URL alone
+     * (a game asset's placeholder, which `image.resolved` replaces, or a finished video). */
+    results?: ToolMediaResult | string;
+    /** A parked call's guard, and its reason and details where the guard declares them. */
+    approval?: ToolGuardApproval;
+}
+/** Scalar parameters a chat UI needs while a turn runs. */
+export interface MessageParams {
+    /** Identifier the sending client attached, to match its optimistic message. */
+    client_creation_id?: string;
+    /** The message was sent in plan mode. */
+    plan_mode?: boolean;
+    /** The message approves a plan. */
+    plan_approved?: boolean;
+    /** The message expects no AI reply. */
+    skip_ai_response?: boolean;
+    /** System message category. */
+    system_message_type?: string;
+}
+/** A public chat message. Replace the message with the same `id` as a whole. */
+export interface ChatMessage {
+    /** Message identifier. */
+    id?: string;
+    /** Author category. System and hidden messages are never delivered. */
+    role?: "user" | "assistant";
+    /** Message text; structured content is withheld. Structural filtering is not prose redaction. */
+    content?: string | null;
+    /** Public tool progress. */
+    tool_calls?: ToolCall[] | null;
+    /** Message timestamp, without author identity. */
+    metadata?: {
+        /** ISO timestamp string. */
+        created_date?: string;
+    };
+    /** Checkpoint reference; mutations remain on the partner backend. */
+    checkpoint_id?: string | null;
+    /** Scalar message parameters. */
+    additional_message_params?: MessageParams;
+}
+/** Public builder state, without error diagnostics or billing context. */
+export interface AppStatus {
+    /** Current builder state. */
+    state?: "ready" | "processing" | "error";
+    /** State timestamp. */
+    last_updated_date?: string | null;
+    /** The user message that started the turn, when a turn set this state. Quote it to Base44 support. */
+    turn_id?: string | null;
+}
+/** Branch scope carried by app events. Null or absent is the main branch. */
+export interface BranchScoped {
+    /** Branch the change belongs to; null is main. */
+    branch_id?: string | null;
+}
+/** `message.updated`: a chat message was added or replaced. */
+export interface MessageUpdated extends BranchScoped {
+    /** The whole message; replace the one with the same `id`. */
+    message: ChatMessage;
+    /** Conversation containing the message. */
+    conversation_id?: string | null;
+}
+/** `message.removed`: a message was removed or hidden. An `id` the viewer never saw is a no-op. */
+export interface MessageRemoved extends BranchScoped {
+    /** Identifier of the message to remove. */
+    message_id: string;
+    /** Conversation that contained the message. */
+    conversation_id?: string | null;
+}
+/** `app.status_changed`: a turn started, finished or failed. */
+export interface AppStatusChanged extends BranchScoped {
+    /** The new state; null clears it. */
+    status: AppStatus | null;
+}
+/** `preview.navigation_requested`: show this page of the app in the preview. */
+export interface PreviewNavigationRequested extends BranchScoped {
+    /** App path to show. */
+    path: string;
+    /** Navigate even when the user has moved away from the page. */
+    force: boolean;
+}
+/** A queued builder request. */
+export interface QueueItem {
+    /** Queue item identifier. */
+    id?: string;
+    /** User-authored request text. */
+    content?: string;
+    /** Creation timestamp. */
+    created_at?: string;
+    /** Branch the request belongs to. */
+    branch_id?: string | null;
+}
+/** `queue.updated`: the whole prompt queue, replacing the previous one. */
+export interface QueueUpdated extends BranchScoped {
+    /** Pending items. */
+    items?: QueueItem[];
+    /** Whether queue processing is paused. */
+    is_paused?: boolean;
+    /** Identifier of the item just processed, when supplied. */
+    processed_item_id?: string | null;
+}
+/** `task.progressed`: progress of a long-running tool. */
+export interface TaskProgressed extends BranchScoped {
+    /** Associated tool call. */
+    tool_call_id?: string | null;
+    /** Associated chat message. */
+    message_id?: string | null;
+    /** Task lifecycle event, e.g. `task_progress`. */
+    event_type?: string | null;
+    /** Numeric progress only; diagnostic text is withheld. */
+    progress?: {
+        /** Completed work units. */
+        current?: number | null;
+        /** Total work units, when known. */
+        total?: number | null;
+        /** Producer-supplied percentage. */
+        percentage?: number | null;
+    } | null;
+}
+/** `image.resolved`: a generated image finished or failed. Replace its `placeholder_url` wherever it appears. */
+export type ImageResolved = ToolMediaResult;
+/** Mapping of public event names to their payloads. */
+export interface PlatformEventMap {
+    /** A chat message was added or replaced. */
+    "message.updated": MessageUpdated;
+    /** A chat message was removed or hidden. */
+    "message.removed": MessageRemoved;
+    /** The builder started, finished or failed a turn. */
+    "app.status_changed": AppStatusChanged;
+    /** Reload the app preview. */
+    "preview.reload_requested": BranchScoped;
+    /** Show a page of the app in the preview. */
+    "preview.navigation_requested": PreviewNavigationRequested;
+    /** The whole prompt queue. */
+    "queue.updated": QueueUpdated;
+    /** Progress of a long-running tool. */
+    "task.progressed": TaskProgressed;
+    /** A generated image finished or failed. */
+    "image.resolved": ImageResolved;
+    /** The conversation was rewritten (undo, restore, sync). On main, the SDK rejoins for a fresh snapshot. */
+    "conversation.changed": BranchScoped;
+    /** The app's files changed outside a chat turn. Re-read them. */
+    "files.changed": BranchScoped;
+    /** A branch was deleted. */
+    "branch.deleted": BranchScoped;
+    /** The imported app's repository changed. */
+    "repository.changed": BranchScoped;
+    /** The imported app's pull request changed. */
+    "pull_request.changed": BranchScoped;
+}
+/** Ordered delivery of one public event. */
+export type PlatformEvent = {
+    [K in keyof PlatformEventMap]: {
+        /** Public event name; narrows the payload type. */
+        type: K;
+        /** Authorized app receiving this event. */
+        appId: string;
+        /** Event payload. Omitted keys mean unchanged; explicit null clears. */
+        data: PlatformEventMap[K];
+    };
+}[keyof PlatformEventMap];
+/** An app's current state: sent after every join and rejoin, and after a main-conversation rewrite. */
+export interface Snapshot {
+    /** Canonical app room. */
+    room: string;
+    /** Current builder state. */
+    status: AppStatus | null;
+    /** The last 50 public messages, oldest first. */
+    messages: ChatMessage[];
+    /** The main branch's prompt queue. Replace it, as with `queue.updated`. Absent from older servers. */
+    queue?: SnapshotQueue;
+}
+/** The prompt queue in a snapshot. */
+export interface SnapshotQueue {
+    /** Pending items. */
+    items: QueueItem[];
+    /** Whether queue processing is paused. */
+    is_paused: boolean;
+}

package/dist/platform/client/modules/builder.events.types.js

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

package/dist/platform/client/modules/builder.js

@@ -0,0 +1,7 @@
+import { BuilderSocket } from "./builder-socket.js";
+/** @internal */
+export function createBuilder(config) {
+    return {
+        init(options) { return new BuilderSocket(config, options); },
+    };
+}

package/dist/platform/client/modules/builder.types.d.ts

@@ -0,0 +1,47 @@
+import type { PlatformEvent, Snapshot } from "./builder.events.types.js";
+import type { PlatformSocketError } from "../errors.js";
+/** Options for an independent builder socket session. */
+export interface BuilderInitOptions {
+    /** Connection-level errors, sanitized to exclude tokens and server exception text. */
+    onError: (error: PlatformSocketError) => void;
+}
+/** Lazy builder module; no socket exists until init is called. */
+export interface BuilderModule {
+    /** Create an independent session without connecting. Call connect on the returned session. */
+    init(options: BuilderInitOptions): BuilderSession;
+}
+/** One builder socket session. Owns its subscriptions and connection lifecycle. */
+export interface BuilderSession {
+    /** Connect with the session token; resolves on CONNECT, before snapshots arrive.
+     * Transport loss retries five times and rejoins active subscriptions, each with a fresh
+     * snapshot. An expired or rejected session is replaced once through `getSessionToken`.
+     * Call again after a failure or `session_replaced`. Concurrent calls share one attempt.
+     */
+    connect(): Promise<void>;
+    /** Subscribe before or after connecting. One subscription per app, up to eight per session,
+     * and each app must be on the session's allowlist. Callbacks run serially per app.
+     */
+    subscribe(appId: string, options: SubscriptionOptions): PlatformSubscription;
+    /** Stop this session, its subscriptions and reconnection. Idempotent and terminal. */
+    close(): void;
+}
+/** One app subscription; at most eight may be active per builder session. */
+export interface SubscriptionOptions {
+    /** Replace this app's state. Arrives after every join and rejoin, and after a main-conversation
+     * rewrite (undo, restore, sync). Live events follow it; it holds only the last 50 messages.
+     */
+    onSnapshot: (snapshot: Snapshot) => void | Promise<void>;
+    /** Apply each live event. Delivery is serial per app; a rejection ends this subscription. */
+    onEvent: (event: PlatformEvent) => void | Promise<void>;
+    /** Subscription errors. Only `snapshot_unavailable` leaves the subscription active. */
+    onError: (error: PlatformSocketError) => void;
+}
+/** One app subscription's lifetime. */
+export interface PlatformSubscription {
+    /** App identifier. */
+    readonly appId: string;
+    /** True while subscribed; false after an error or explicit unsubscribe. */
+    readonly active: boolean;
+    /** Stop this app's delivery and release its subscription slot. Idempotent. */
+    unsubscribe(): void;
+}

package/dist/platform/client/modules/builder.types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.51-pr.294.a7ae332",
+  "version": "0.8.52-pr.286.58a3186",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,8 +9,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc",
-    "lint": "eslint src",
+    "build": "npm run build:runtime && npm run build:platform",
+    "lint": "eslint src platform-src examples/platform-client.ts",
     "test": "npm run test:types && vitest run",
     "test:types": "tsc --noEmit -p tsconfig.type-tests.json",
     "test:unit": "vitest run tests/unit",
@@ -23,7 +23,11 @@
     "create-docs-local": "npm run create-docs && npm run copy-docs-local",
     "copy-docs-local": "node scripts/mintlify-post-processing/copy-to-local-docs.js",
     "create-docs:generate": "typedoc",
-    "create-docs:process": "node scripts/mintlify-post-processing/file-processing/file-processing.js"
+    "create-docs:process": "node scripts/mintlify-post-processing/file-processing/file-processing.js",
+    "build:runtime": "tsc",
+    "build:platform": "tsc -p tsconfig.platform.json",
+    "docs:platform-client": "typedoc --options typedoc.platform-client.json",
+    "test:package": "npm run build && node --test tests/package/platform-client.test.mjs"
   },
   "dependencies": {
     "axios": "^1.18.1",
@@ -63,5 +67,36 @@
   "bugs": {
     "url": "https://github.com/base44/javascript-sdk/issues"
   },
-  "homepage": "https://github.com/base44/javascript-sdk#readme"
+  "homepage": "https://github.com/base44/javascript-sdk#readme",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./dist/*.d.ts": "./dist/*.d.ts",
+    "./dist/*.js": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./dist/*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*",
+    "./platform/client": {
+      "types": "./dist/platform/client/index.d.ts",
+      "default": "./dist/platform/client/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "platform/client": [
+        "dist/platform/client/index.d.ts"
+      ],
+      "*": [
+        "*"
+      ]
+    }
+  }
 }