@base44-preview/sdk 0.8.8-pr.60.dc14a43 → 0.8.10-pr.58.f752ec2

package/dist/client.js

@@ -104,7 +104,11 @@ export function createClient(config) {
         serverUrl,
     });
     const userModules = {
-        entities: createEntitiesModule(axiosClient, appId),
+        entities: createEntitiesModule({
+            axios: axiosClient,
+            appId,
+            getSocket,
+        }),
         integrations: createIntegrationsModule(axiosClient, appId),
         auth: userAuthModule,
         functions: createFunctionsModule(functionsAxiosClient, appId),
@@ -131,7 +135,11 @@ export function createClient(config) {
         },
     };
     const serviceRoleModules = {
-        entities: createEntitiesModule(serviceRoleAxiosClient, appId),
+        entities: createEntitiesModule({
+            axios: serviceRoleAxiosClient,
+            appId,
+            getSocket,
+        }),
         integrations: createIntegrationsModule(serviceRoleAxiosClient, appId),
         sso: createSsoModule(serviceRoleAxiosClient, appId, token),
         connectors: createConnectorsModule(serviceRoleAxiosClient, appId),

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, } from "./modules/entities.types.js";
+export type { EntitiesModule, EntityHandler, RealtimeEventType, RealtimeEvent, RealtimeCallback, SubscribeOptions, Subscription, } 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/analytics.js

@@ -46,9 +46,9 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
         });
     };
     // currently disabled, until fully tested  //
-    const beaconRequest = async (events) => {
-        const beaconPayload = JSON.stringify({ events });
+    const beaconRequest = (events) => {
         try {
+            const beaconPayload = JSON.stringify({ events });
             const blob = new Blob([beaconPayload], { type: "application/json" });
             return (typeof navigator === "undefined" ||
                 beaconPayload.length > 60000 ||
@@ -58,11 +58,15 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
             return false;
         }
     };
-    const flush = async (eventsData) => {
+    const flush = async (eventsData, options = {}) => {
+        if (eventsData.length === 0)
+            return;
         const sessionContext_ = await getSessionContext(userAuthModule);
         const events = eventsData.map(transformEventDataToApiRequestData(sessionContext_));
         try {
-            return batchRequestFallback(events);
+            if (!options.isBeacon || !beaconRequest(events)) {
+                await batchRequestFallback(events);
+            }
         }
         catch (_a) {
             // do nothing
@@ -94,10 +98,10 @@ export const createAnalyticsModule = ({ axiosClient, serverUrl, appId, userAuthM
     };
     const onDocHidden = () => {
         stopAnalyticsProcessor();
+        clearHeartBeatProcessor === null || clearHeartBeatProcessor === void 0 ? void 0 : clearHeartBeatProcessor();
         //  flush entire queue on visibility change and hope for the best //
         const eventsData = analyticsSharedState.requestsQueue.splice(0);
-        flush(eventsData);
-        clearHeartBeatProcessor === null || clearHeartBeatProcessor === void 0 ? void 0 : clearHeartBeatProcessor();
+        flush(eventsData, { isBeacon: true });
     };
     const onVisibilityChange = () => {
         if (typeof window === "undefined")

package/dist/modules/entities.d.ts

@@ -1,5 +1,23 @@
 import { AxiosInstance } from "axios";
 import { EntitiesModule } from "./entities.types";
+import { RoomsSocket } from "../utils/socket-utils";
+/**
+ * Configuration for the entities module.
+ * @internal
+ */
+export interface EntitiesModuleConfig {
+    axios: AxiosInstance;
+    appId: string;
+    getSocket: () => ReturnType<typeof RoomsSocket>;
+}
+/**
+ * Creates the entities module for the Base44 SDK.
+ *
+ * @param config - Configuration object containing axios, appId, and getSocket
+ * @returns Entities module with dynamic entity access
+ * @internal
+ */
+export declare function createEntitiesModule(config: EntitiesModuleConfig): EntitiesModule;
 /**
  * Creates the entities module for the Base44 SDK.
  *
@@ -7,5 +25,6 @@ import { EntitiesModule } from "./entities.types";
  * @param appId - Application ID
  * @returns Entities module with dynamic entity access
  * @internal
+ * @deprecated Use the config object overload instead
  */
 export declare function createEntitiesModule(axios: AxiosInstance, appId: string): EntitiesModule;

package/dist/modules/entities.js

@@ -1,12 +1,15 @@
-/**
- * Creates the entities module for the Base44 SDK.
- *
- * @param axios - Axios instance
- * @param appId - Application ID
- * @returns Entities module with dynamic entity access
- * @internal
- */
-export function createEntitiesModule(axios, appId) {
+export function createEntitiesModule(configOrAxios, appIdArg) {
+    // Handle both old and new signatures for backwards compatibility
+    const config = "axios" in configOrAxios
+        ? configOrAxios
+        : {
+            axios: configOrAxios,
+            appId: appIdArg,
+            getSocket: () => {
+                throw new Error("Realtime subscriptions are not available. Please update your client configuration.");
+            },
+        };
+    const { axios, appId, getSocket } = config;
     // Using Proxy to dynamically handle entity names
     return new Proxy({}, {
         get(target, entityName) {
@@ -17,20 +20,59 @@ export function createEntitiesModule(axios, appId) {
                 return undefined;
             }
             // Create entity handler
-            return createEntityHandler(axios, appId, entityName);
+            return createEntityHandler(axios, appId, entityName, getSocket);
         },
     });
 }
+/**
+ * Creates a stable hash from a query object for room naming.
+ * @internal
+ */
+function hashQuery(query) {
+    const sortedKeys = Object.keys(query).sort();
+    const normalized = sortedKeys
+        .map((k) => `${k}:${JSON.stringify(query[k])}`)
+        .join("|");
+    // Simple hash function
+    let hash = 0;
+    for (let i = 0; i < normalized.length; i++) {
+        const char = normalized.charCodeAt(i);
+        hash = (hash << 5) - hash + char;
+        hash = hash & hash; // Convert to 32bit integer
+    }
+    return Math.abs(hash).toString(36);
+}
+/**
+ * Parses the realtime message data and extracts event information.
+ * @internal
+ */
+function parseRealtimeMessage(dataStr) {
+    var _a;
+    try {
+        const parsed = JSON.parse(dataStr);
+        return {
+            type: parsed.type,
+            data: parsed.data,
+            id: parsed.id || ((_a = parsed.data) === null || _a === void 0 ? void 0 : _a.id),
+            timestamp: parsed.timestamp || new Date().toISOString(),
+            previousData: parsed.previousData,
+        };
+    }
+    catch (_b) {
+        return null;
+    }
+}
 /**
  * Creates a handler for a specific entity.
  *
  * @param axios - Axios instance
  * @param appId - Application ID
  * @param entityName - Entity name
+ * @param getSocket - Function to get the socket instance
  * @returns Entity handler with CRUD methods
  * @internal
  */
-function createEntityHandler(axios, appId, entityName) {
+function createEntityHandler(axios, appId, entityName, getSocket) {
     const baseURL = `/apps/${appId}/entities/${entityName}`;
     return {
         // List entities with optional pagination and sorting
@@ -95,5 +137,52 @@ function createEntityHandler(axios, appId, entityName) {
                 },
             });
         },
+        // Subscribe to realtime updates
+        subscribe(callbackOrIdOrQuery, callbackOrOptions, optionsArg) {
+            let room;
+            let callback;
+            let options;
+            // Parse overloaded arguments
+            if (typeof callbackOrIdOrQuery === "function") {
+                // subscribe(callback, options?)
+                room = `entities:${appId}:${entityName}`;
+                callback = callbackOrIdOrQuery;
+                options = callbackOrOptions;
+            }
+            else if (typeof callbackOrIdOrQuery === "string") {
+                // subscribe(id, callback, options?)
+                room = `entities:${appId}:${entityName}:${callbackOrIdOrQuery}`;
+                callback = callbackOrOptions;
+                options = optionsArg;
+            }
+            else {
+                // subscribe(query, callback, options?)
+                const queryHash = hashQuery(callbackOrIdOrQuery);
+                room = `entities:${appId}:${entityName}:query:${queryHash}`;
+                callback = callbackOrOptions;
+                options = optionsArg;
+            }
+            const eventFilter = options === null || options === void 0 ? void 0 : options.events;
+            // Get the socket and subscribe to the room
+            const socket = getSocket();
+            const unsubscribe = socket.subscribeToRoom(room, {
+                update_model: (msg) => {
+                    // Only process messages for our room
+                    if (msg.room !== room)
+                        return;
+                    const event = parseRealtimeMessage(msg.data);
+                    if (!event)
+                        return;
+                    // Apply event type filter if specified
+                    if (eventFilter && !eventFilter.includes(event.type)) {
+                        return;
+                    }
+                    callback(event);
+                },
+            });
+            return {
+                unsubscribe,
+            };
+        },
     };
 }

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

@@ -1,3 +1,40 @@
+/**
+ * Event types for realtime entity updates.
+ */
+export type RealtimeEventType = "create" | "update" | "delete";
+/**
+ * Payload received when a realtime event occurs.
+ */
+export interface RealtimeEvent<T = Record<string, any>> {
+    /** The type of change that occurred */
+    type: RealtimeEventType;
+    /** The entity data (new/updated for create/update, previous for delete) */
+    data: T;
+    /** The unique identifier of the affected entity */
+    id: string;
+    /** ISO 8601 timestamp of when the event occurred */
+    timestamp: string;
+    /** For update events, contains the previous data before the change */
+    previousData?: T;
+}
+/**
+ * Callback function invoked when a realtime event occurs.
+ */
+export type RealtimeCallback<T = Record<string, any>> = (event: RealtimeEvent<T>) => void;
+/**
+ * Options for subscribing to realtime updates.
+ */
+export interface SubscribeOptions {
+    /** Filter events by type. Defaults to all types. */
+    events?: RealtimeEventType[];
+}
+/**
+ * Handle returned from subscribe, used to unsubscribe.
+ */
+export interface Subscription {
+    /** Stops listening to updates and cleans up the subscription. */
+    unsubscribe: () => void;
+}
 /**
  * Entity handler providing CRUD operations for a specific entity type.
  *
@@ -242,6 +279,93 @@ export interface EntityHandler {
      * ```
      */
     importEntities(file: File): Promise<any>;
+    /**
+     * Subscribes to realtime updates for all records of this entity type.
+     *
+     * Receives notifications whenever any record is created, updated, or deleted.
+     *
+     * @param callback - Function called when an entity changes.
+     * @param options - Optional configuration for filtering events.
+     * @returns Subscription handle with an unsubscribe method.
+     *
+     * @example
+     * ```typescript
+     * // Subscribe to all Task changes
+     * const subscription = base44.entities.Task.subscribe((event) => {
+     *   console.log(`Task ${event.id} was ${event.type}d:`, event.data);
+     * });
+     *
+     * // Later, unsubscribe
+     * subscription.unsubscribe();
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Subscribe only to create events
+     * const subscription = base44.entities.Task.subscribe(
+     *   (event) => console.log("New task:", event.data),
+     *   { events: ["create"] }
+     * );
+     * ```
+     */
+    subscribe(callback: RealtimeCallback, options?: SubscribeOptions): Subscription;
+    /**
+     * Subscribes to realtime updates for a specific entity record.
+     *
+     * Receives notifications when the specified record is updated or deleted.
+     *
+     * @param id - The unique identifier of the record to watch.
+     * @param callback - Function called when the entity changes.
+     * @param options - Optional configuration for filtering events.
+     * @returns Subscription handle with an unsubscribe method.
+     *
+     * @example
+     * ```typescript
+     * // Subscribe to a specific task
+     * const subscription = base44.entities.Task.subscribe("task-123", (event) => {
+     *   if (event.type === "update") {
+     *     console.log("Task updated:", event.data);
+     *   } else if (event.type === "delete") {
+     *     console.log("Task was deleted");
+     *   }
+     * });
+     * ```
+     */
+    subscribe(id: string, callback: RealtimeCallback, options?: SubscribeOptions): Subscription;
+    /**
+     * Subscribes to realtime updates for records matching a query.
+     *
+     * Receives notifications for records that match the specified criteria.
+     * Includes create events when new records match the query, update events
+     * when matching records change, and delete events when matching records
+     * are removed.
+     *
+     * @param query - Query object with field-value pairs to filter records.
+     * @param callback - Function called when a matching entity changes.
+     * @param options - Optional configuration for filtering events.
+     * @returns Subscription handle with an unsubscribe method.
+     *
+     * @example
+     * ```typescript
+     * // Subscribe to all completed tasks
+     * const subscription = base44.entities.Task.subscribe(
+     *   { isCompleted: true },
+     *   (event) => {
+     *     console.log(`Completed task ${event.type}:`, event.data);
+     *   }
+     * );
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Subscribe to high-priority active tasks
+     * const subscription = base44.entities.Task.subscribe(
+     *   { priority: "high", status: "active" },
+     *   (event) => console.log("High priority task changed:", event.data)
+     * );
+     * ```
+     */
+    subscribe(query: Record<string, any>, callback: RealtimeCallback, options?: SubscribeOptions): Subscription;
 }
 /**
  * Entities module for managing app data.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.8-pr.60.dc14a43",
+  "version": "0.8.10-pr.58.f752ec2",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",