@base44-preview/sdk 0.8.17-pr.74.aa2810d → 0.8.17-pr.76.a16c363

package/dist/client.js

@@ -11,7 +11,6 @@ import { createAppLogsModule } from "./modules/app-logs.js";
 import { createUsersModule } from "./modules/users.js";
 import { RoomsSocket } from "./utils/socket-utils.js";
 import { createAnalyticsModule } from "./modules/analytics.js";
-import { createRecordingModule } from "./modules/recording.js";
 /**
  * Creates a Base44 client.
  *
@@ -128,7 +127,6 @@ export function createClient(config) {
             appId,
             userAuthModule,
         }),
-        recording: createRecordingModule(),
         cleanup: () => {
             userModules.analytics.cleanup();
             if (socket) {

package/dist/client.types.d.ts

@@ -7,7 +7,6 @@ import type { FunctionsModule } from "./modules/functions.types.js";
 import type { AgentsModule } from "./modules/agents.types.js";
 import type { AppLogsModule } from "./modules/app-logs.types.js";
 import type { AnalyticsModule } from "./modules/analytics.types.js";
-import type { RecordingModule } from "./modules/recording.types.js";
 /**
  * Options for creating a Base44 client.
  */
@@ -86,8 +85,6 @@ export interface Base44Client {
     appLogs: AppLogsModule;
     /** {@link AnalyticsModule | Analytics module} for tracking app usage. */
     analytics: AnalyticsModule;
-    /** {@link RecordingModule | Recording module} for capturing debug sessions. */
-    recording: RecordingModule;
     /** Cleanup function to disconnect WebSocket connections. Call when you're done with the client. */
     cleanup: () => void;
     /**

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { getAccessToken, saveAccessToken, removeAccessToken, getLoginUrl } from
 export { createClient, createClientFromRequest, Base44Error, getAccessToken, saveAccessToken, removeAccessToken, getLoginUrl, };
 export type { Base44Client, CreateClientConfig, CreateClientOptions, Base44ErrorJSON, };
 export * from "./types.js";
-export type { EntitiesModule, EntityHandler, RealtimeEventType, RealtimeEvent, RealtimeCallback, Subscription, } from "./modules/entities.types.js";
+export type { EntitiesModule, EntityHandler, RealtimeEventType, RealtimeEvent, RealtimeCallback, } from "./modules/entities.types.js";
 export type { AuthModule, LoginResponse, RegisterParams, VerifyOtpParams, ChangePasswordParams, ResetPasswordParams, User, } from "./modules/auth.types.js";
 export type { IntegrationsModule, IntegrationPackage, IntegrationEndpointFunction, CoreIntegrations, InvokeLLMParams, GenerateImageParams, GenerateImageResult, UploadFileParams, UploadFileResult, SendEmailParams, SendEmailResult, ExtractDataFromUploadedFileParams, ExtractDataFromUploadedFileResult, UploadPrivateFileParams, UploadPrivateFileResult, CreateFileSignedUrlParams, CreateFileSignedUrlResult, } from "./modules/integrations.types.js";
 export type { FunctionsModule } from "./modules/functions.types.js";

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

@@ -138,7 +138,7 @@ export interface CreateConversationParams {
 export interface AgentsModuleConfig {
     /** Axios instance for HTTP requests */
     axios: AxiosInstance;
-    /** Function to get WebSocket instance for real-time updates (lazy initialization) */
+    /** Function to get WebSocket instance for realtime updates (lazy initialization) */
     getSocket: () => ReturnType<typeof RoomsSocket>;
     /** Application ID */
     appId: string;
@@ -151,7 +151,7 @@ export interface AgentsModuleConfig {
  * Agents module for managing AI agent conversations.
  *
  * This module provides methods to create and manage conversations with AI agents,
- * send messages, and subscribe to real-time updates. Conversations can be used
+ * send messages, and subscribe to realtime updates. Conversations can be used
  * for chat interfaces, support systems, or any interactive AI app.
  *
  * The agents module enables you to:
@@ -159,7 +159,7 @@ export interface AgentsModuleConfig {
  * - **Create conversations** with agents defined in the app.
  * - **Send messages** from users to agents and receive AI-generated responses.
  * - **Retrieve conversations** individually or as filtered lists with sorting and pagination.
- * - **Subscribe to real-time updates** using WebSocket connections to receive instant notifications when new messages arrive.
+ * - **Subscribe to realtime updates** using WebSocket connections to receive instant notifications when new messages arrive.
  * - **Attach metadata** to conversations for tracking context, categories, priorities, or linking to external systems.
  * - **Generate WhatsApp connection URLs** for users to interact with agents through WhatsApp.
  *
@@ -275,7 +275,7 @@ export interface AgentsModule {
      * Adds a message to a conversation.
      *
      * Sends a message to the agent and updates the conversation. This method
-     * also updates the real-time socket to notify any subscribers.
+     * also updates the realtime socket to notify any subscribers.
      *
      * @param conversation - The conversation to add the message to.
      * @param message - The message to add.
@@ -293,19 +293,25 @@ export interface AgentsModule {
      */
     addMessage(conversation: AgentConversation, message: Partial<AgentMessage>): Promise<AgentMessage>;
     /**
-     * Subscribes to real-time updates for a conversation.
+     * Subscribes to realtime updates for a conversation.
      *
      * Establishes a WebSocket connection to receive instant updates when new
      * messages are added to the conversation. Returns an unsubscribe function
      * to clean up the connection.
      *
      * @param conversationId - The conversation ID to subscribe to.
-     * @param onUpdate - Callback function called when the conversation is updated.
+     * @param onUpdate - Callback function called when the conversation is updated. The callback receives a conversation object with the following properties:
+     * - `id`: Unique identifier for the conversation.
+     * - `agent_name`: Name of the agent in this conversation.
+     * - `created_date`: ISO 8601 timestamp of when the conversation was created.
+     * - `updated_date`: ISO 8601 timestamp of when the conversation was last updated.
+     * - `messages`: Array of messages in the conversation. Each message includes `id`, `role` (`'user'`, `'assistant'`, or `'system'`), `content`, `created_date`, and optionally `tool_calls`, `reasoning`, `file_urls`, and `usage`.
+     * - `metadata`: Optional metadata associated with the conversation.
      * @returns Unsubscribe function to stop receiving updates.
      *
      * @example
      * ```typescript
-     * // Subscribe to real-time updates
+     * // Subscribe to realtime updates
      * const unsubscribe = base44.agents.subscribeToConversation(
      *   'conv-123',
      *   (updatedConversation) => {

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

@@ -19,10 +19,6 @@ export interface RealtimeEvent {
  * Callback function invoked when a realtime event occurs.
  */
 export type RealtimeCallback = (event: RealtimeEvent) => void;
-/**
- * Function returned from subscribe, call it to unsubscribe.
- */
-export type Subscription = () => void;
 /**
  * Entity handler providing CRUD operations for a specific entity type.
  *
@@ -270,10 +266,16 @@ export interface EntityHandler {
     /**
      * Subscribes to realtime updates for all records of this entity type.
      *
-     * Receives notifications whenever any record is created, updated, or deleted.
+     * Establishes a WebSocket connection to receive instant updates when any
+     * record is created, updated, or deleted. Returns an unsubscribe function
+     * to clean up the connection.
      *
-     * @param callback - Function called when an entity changes.
-     * @returns Unsubscribe function to stop listening.
+     * @param callback - Callback function called when an entity changes. The callback receives an event object with the following properties:
+     * - `type`: The type of change that occurred - `'create'`, `'update'`, or `'delete'`.
+     * - `data`: The entity data after the change.
+     * - `id`: The unique identifier of the affected entity.
+     * - `timestamp`: ISO 8601 timestamp of when the event occurred.
+     * @returns Unsubscribe function to stop receiving updates.
      *
      * @example
      * ```typescript
@@ -282,11 +284,11 @@ export interface EntityHandler {
      *   console.log(`Task ${event.id} was ${event.type}d:`, event.data);
      * });
      *
-     * // Later, unsubscribe
+     * // Later, clean up the subscription
      * unsubscribe();
      * ```
      */
-    subscribe(callback: RealtimeCallback): Subscription;
+    subscribe(callback: RealtimeCallback): () => void;
 }
 /**
  * Entities module for managing app data.

package/dist/modules/types.d.ts

@@ -2,4 +2,3 @@ export * from "./app.types.js";
 export * from "./agents.types.js";
 export * from "./connectors.types.js";
 export * from "./analytics.types.js";
-export * from "./recording.types.js";

package/dist/modules/types.js

@@ -2,4 +2,3 @@ export * from "./app.types.js";
 export * from "./agents.types.js";
 export * from "./connectors.types.js";
 export * from "./analytics.types.js";
-export * from "./recording.types.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.17-pr.74.aa2810d",
+  "version": "0.8.17-pr.76.a16c363",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,13 +20,12 @@
     "prepublishOnly": "npm run build",
     "create-docs": "npm run create-docs:generate && npm run create-docs:process",
     "push-docs": "node scripts/mintlify-post-processing/push-to-docs-repo.js",
+    "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"
   },
   "dependencies": {
-    "@rrweb/rrweb-plugin-console-record": "^2.0.0-alpha.18",
     "axios": "^1.6.2",
-    "rrweb": "^2.0.0-alpha.18",
     "socket.io-client": "^4.7.5",
     "uuid": "^13.0.0"
   },

package/dist/modules/recording.d.ts

@@ -1,8 +0,0 @@
-import type { RecordingModule } from "./recording.types.js";
-/**
- * Creates the recording module for the Base44 SDK.
- *
- * @returns Recording module with methods for capturing debug sessions
- * @internal
- */
-export declare function createRecordingModule(): RecordingModule;

package/dist/modules/recording.js

@@ -1,266 +0,0 @@
-import { record, IncrementalSource, MouseInteractions, } from "rrweb";
-import { getRecordConsolePlugin } from "@rrweb/rrweb-plugin-console-record";
-import { generateUuid } from "../utils/common.js";
-const state = {
-    isRecording: false,
-    sessionId: null,
-    startTime: null,
-    events: [],
-    stopFn: null,
-};
-/**
- * Creates the recording module for the Base44 SDK.
- *
- * @returns Recording module with methods for capturing debug sessions
- * @internal
- */
-export function createRecordingModule() {
-    return {
-        start() {
-            if (state.isRecording) {
-                throw new Error("Recording is already in progress");
-            }
-            if (typeof window === "undefined") {
-                throw new Error("Recording is only available in browser environments");
-            }
-            // Reset state
-            state.isRecording = true;
-            state.sessionId = generateUuid();
-            state.startTime = new Date().toISOString();
-            state.events = [];
-            const stopFn = record({
-                emit: (event) => {
-                    state.events.push(event);
-                },
-                plugins: [
-                    getRecordConsolePlugin({
-                        level: ["log", "warn", "error", "info", "debug"],
-                        lengthThreshold: 10000,
-                        stringifyOptions: {
-                            stringLengthLimit: 5000,
-                            numOfKeysLimit: 100,
-                            depthOfLimit: 5,
-                        },
-                    }),
-                ],
-            });
-            state.stopFn = stopFn !== null && stopFn !== void 0 ? stopFn : null;
-        },
-        stop() {
-            if (!state.isRecording) {
-                throw new Error("No recording is in progress");
-            }
-            // Stop rrweb recording
-            if (state.stopFn) {
-                state.stopFn();
-                state.stopFn = null;
-            }
-            const endTime = new Date().toISOString();
-            const startTime = state.startTime;
-            const duration = new Date(endTime).getTime() - new Date(startTime).getTime();
-            // Extract data from events
-            const consoleEntries = extractConsoleEntries(state.events);
-            const userActions = extractUserActions(state.events);
-            const report = {
-                sessionId: state.sessionId,
-                startTime,
-                endTime,
-                duration,
-                console: consoleEntries,
-                userActions,
-            };
-            // Reset state
-            state.isRecording = false;
-            state.sessionId = null;
-            state.startTime = null;
-            state.events = [];
-            return report;
-        },
-        isRecording() {
-            return state.isRecording;
-        },
-        toText(report) {
-            const lines = [
-                "## Debug Session Report",
-                `Session ID: ${report.sessionId}`,
-                `Duration: ${report.duration}ms`,
-                `Recorded: ${report.startTime} to ${report.endTime}`,
-                "",
-                `### User Actions (${report.userActions.length} actions)`,
-            ];
-            if (report.userActions.length === 0) {
-                lines.push("No user actions captured.");
-            }
-            else {
-                for (const action of report.userActions) {
-                    const timestamp = new Date(action.timestamp).toISOString();
-                    const valueStr = action.value ? ` = "${action.value}"` : "";
-                    lines.push(`[${timestamp}] ${action.type}: ${action.target}${valueStr}`);
-                }
-            }
-            lines.push("");
-            lines.push(`### Console Output (${report.console.length} entries)`);
-            if (report.console.length === 0) {
-                lines.push("No console output captured.");
-            }
-            else {
-                for (const entry of report.console) {
-                    const timestamp = new Date(entry.timestamp).toISOString();
-                    lines.push(`[${timestamp}] [${entry.level.toUpperCase()}] ${entry.message}`);
-                }
-            }
-            return lines.join("\n");
-        },
-    };
-}
-/**
- * Extracts console entries from rrweb events.
- */
-function extractConsoleEntries(events) {
-    var _a;
-    const consoleEntries = [];
-    for (const event of events) {
-        // rrweb plugin events have type 6
-        if (event.type === 6 && ((_a = event.data) === null || _a === void 0 ? void 0 : _a.plugin) === "rrweb/console@1") {
-            const payload = event.data.payload;
-            if (payload && payload.level && payload.payload) {
-                const message = stringifyConsolePayload(payload.payload);
-                consoleEntries.push({
-                    level: payload.level,
-                    message,
-                    timestamp: event.timestamp,
-                });
-            }
-        }
-    }
-    return consoleEntries;
-}
-/**
- * Converts console payload array to a readable string.
- */
-function stringifyConsolePayload(payload) {
-    return payload
-        .map((item) => {
-        if (typeof item === "string") {
-            return item;
-        }
-        try {
-            return JSON.stringify(item);
-        }
-        catch (_a) {
-            return String(item);
-        }
-    })
-        .join(" ");
-}
-/**
- * Extracts user actions from rrweb events.
- */
-function extractUserActions(events) {
-    const userActions = [];
-    // Build a map of node IDs to readable descriptions from the full snapshot
-    const nodeMap = buildNodeMap(events);
-    for (const event of events) {
-        // IncrementalSnapshot events have type 3
-        if (event.type !== 3 || !event.data)
-            continue;
-        const { source, type, id, text } = event.data;
-        // Mouse interactions
-        if (source === IncrementalSource.MouseInteraction && id !== undefined) {
-            const actionType = getMouseInteractionType(type);
-            if (actionType) {
-                userActions.push({
-                    type: actionType,
-                    target: nodeMap.get(id) || `element#${id}`,
-                    timestamp: event.timestamp,
-                });
-            }
-        }
-        // Input events
-        if (source === IncrementalSource.Input && id !== undefined) {
-            userActions.push({
-                type: "input",
-                target: nodeMap.get(id) || `input#${id}`,
-                value: text ? truncateString(text, 100) : undefined,
-                timestamp: event.timestamp,
-            });
-        }
-    }
-    return userActions;
-}
-/**
- * Maps mouse interaction type number to readable action type.
- */
-function getMouseInteractionType(type) {
-    switch (type) {
-        case MouseInteractions.Click:
-            return "click";
-        case MouseInteractions.DblClick:
-            return "dblclick";
-        default:
-            return null;
-    }
-}
-/**
- * Builds a map of node IDs to readable descriptions from the full snapshot.
- */
-function buildNodeMap(events) {
-    var _a;
-    const nodeMap = new Map();
-    // Find the full snapshot (type 2)
-    const fullSnapshot = events.find((e) => e.type === 2);
-    if (!fullSnapshot)
-        return nodeMap;
-    // Recursively extract node info
-    const extractNodes = (node) => {
-        if (!node || typeof node !== "object")
-            return;
-        if (node.id !== undefined && node.tagName) {
-            const parts = [`<${node.tagName.toLowerCase()}`];
-            if (node.attributes) {
-                if (node.attributes.id) {
-                    parts[0] += `#${node.attributes.id}`;
-                }
-                if (node.attributes.class) {
-                    const firstClass = node.attributes.class.split(" ")[0];
-                    if (firstClass)
-                        parts[0] += `.${firstClass}`;
-                }
-            }
-            parts[0] += ">";
-            // Add text content hint if available
-            if (node.childNodes) {
-                for (const child of node.childNodes) {
-                    if (child.type === 3 && child.textContent) {
-                        // Text node
-                        const text = child.textContent.trim().slice(0, 30);
-                        if (text) {
-                            parts.push(`"${text}"`);
-                            break;
-                        }
-                    }
-                }
-            }
-            nodeMap.set(node.id, parts.join(" "));
-        }
-        // Recurse into children
-        if (node.childNodes) {
-            for (const child of node.childNodes) {
-                extractNodes(child);
-            }
-        }
-    };
-    // Start from the snapshot data
-    if ((_a = fullSnapshot.data) === null || _a === void 0 ? void 0 : _a.node) {
-        extractNodes(fullSnapshot.data.node);
-    }
-    return nodeMap;
-}
-/**
- * Truncates a string to a maximum length.
- */
-function truncateString(str, maxLength) {
-    if (str.length <= maxLength)
-        return str;
-    return str.slice(0, maxLength - 3) + "...";
-}

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

@@ -1,118 +0,0 @@
-/**
- * A console log entry captured during recording.
- */
-export interface ConsoleEntry {
-    /** The console method that was called. */
-    level: "log" | "warn" | "error" | "info" | "debug";
-    /** The logged message content. */
-    message: string;
-    /** Unix timestamp when the log occurred. */
-    timestamp: number;
-}
-/**
- * A user action captured during recording.
- */
-export interface UserAction {
-    /** The type of interaction. */
-    type: "click" | "dblclick" | "input";
-    /** Description of the target element. */
-    target: string;
-    /** Value entered (for input actions). */
-    value?: string;
-    /** Unix timestamp when the action occurred. */
-    timestamp: number;
-}
-/**
- * Debug report containing captured session data.
- */
-export interface DebugReport {
-    /** Unique session identifier. */
-    sessionId: string;
-    /** Recording start time (ISO 8601). */
-    startTime: string;
-    /** Recording end time (ISO 8601). */
-    endTime: string;
-    /** Duration in milliseconds. */
-    duration: number;
-    /** Captured console output. */
-    console: ConsoleEntry[];
-    /** Captured user actions (clicks, inputs, etc.). */
-    userActions: UserAction[];
-}
-/**
- * Recording module for capturing debug sessions.
- *
- * This module captures console output from the running app to help debug issues.
- * It's designed to provide context for AI agents analyzing app problems.
- *
- * @example
- * ```typescript
- * // Start recording
- * base44.recording.start();
- *
- * // ... user reproduces the issue ...
- *
- * // Stop and get the report
- * const report = base44.recording.stop();
- * console.log(report.console); // All console output
- *
- * // Get text summary for LLM
- * const summary = base44.recording.toText(report);
- * ```
- */
-export interface RecordingModule {
-    /**
-     * Starts a debug recording session.
-     *
-     * Captures console output until stopped.
-     * Only one recording can be active at a time.
-     *
-     * @throws {Error} If a recording is already in progress.
-     *
-     * @example
-     * ```typescript
-     * base44.recording.start();
-     * ```
-     */
-    start(): void;
-    /**
-     * Stops the current recording and returns the captured data.
-     *
-     * @returns The debug report containing all captured console output.
-     * @throws {Error} If no recording is in progress.
-     *
-     * @example
-     * ```typescript
-     * const report = base44.recording.stop();
-     * console.log(`Captured ${report.console.length} console entries`);
-     * ```
-     */
-    stop(): DebugReport;
-    /**
-     * Checks if a recording is currently in progress.
-     *
-     * @returns True if recording, false otherwise.
-     *
-     * @example
-     * ```typescript
-     * if (!base44.recording.isRecording()) {
-     *   base44.recording.start();
-     * }
-     * ```
-     */
-    isRecording(): boolean;
-    /**
-     * Generates a text summary of a debug report for LLM consumption.
-     *
-     * @param report - The debug report to summarize.
-     * @returns A formatted text summary.
-     *
-     * @example
-     * ```typescript
-     * const report = base44.recording.stop();
-     * const summary = base44.recording.toText(report);
-     * // Send summary to your backend for LLM processing
-     * ```
-     */
-    toText(report: DebugReport): string;
-}

package/dist/modules/recording.types.js

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