@base44-preview/sdk 0.8.10-pr.62.8f72a2c → 0.8.11-pr.58.0494dbf

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, 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/custom-integrations.js

@@ -1,35 +1,3 @@
-/**
- * Normalizes parameters to snake_case for the API.
- *
- * Supports both camelCase (pathParams) and snake_case (path_params) input,
- * always outputting snake_case for the backend.
- */
-function normalizeParams(params) {
-    var _a, _b;
-    if (!params) {
-        return {};
-    }
-    const normalized = {};
-    // Handle payload
-    if (params.payload !== undefined) {
-        normalized.payload = params.payload;
-    }
-    // Handle path_params (support both camelCase and snake_case)
-    const pathParams = (_a = params.pathParams) !== null && _a !== void 0 ? _a : params.path_params;
-    if (pathParams !== undefined) {
-        normalized.path_params = pathParams;
-    }
-    // Handle query_params (support both camelCase and snake_case)
-    const queryParams = (_b = params.queryParams) !== null && _b !== void 0 ? _b : params.query_params;
-    if (queryParams !== undefined) {
-        normalized.query_params = queryParams;
-    }
-    // Handle headers
-    if (params.headers !== undefined) {
-        normalized.headers = params.headers;
-    }
-    return normalized;
-}
 /**
  * Creates the custom integrations module for the Base44 SDK.
  *
@@ -42,18 +10,22 @@ export function createCustomIntegrationsModule(axios, appId) {
     return {
         async call(slug, operationId, params) {
             // Validate required parameters
-            if (!slug) {
-                throw new Error("Integration slug is required");
+            if (!(slug === null || slug === void 0 ? void 0 : slug.trim())) {
+                throw new Error("Integration slug is required and cannot be empty");
             }
-            if (!operationId) {
-                throw new Error("Operation ID is required");
+            if (!(operationId === null || operationId === void 0 ? void 0 : operationId.trim())) {
+                throw new Error("Operation ID is required and cannot be empty");
             }
-            // Normalize parameters to snake_case
-            const normalizedParams = normalizeParams(params);
+            // Convert camelCase to snake_case for Python backend
+            const { pathParams, queryParams, ...rest } = params !== null && params !== void 0 ? params : {};
+            const body = {
+                ...rest,
+                ...(pathParams && { path_params: pathParams }),
+                ...(queryParams && { query_params: queryParams }),
+            };
             // Make the API call
-            const response = await axios.post(`/apps/${appId}/integrations/custom/${slug}/${operationId}`, normalizedParams);
-            // Return the response data
-            // Note: axios interceptor already extracts data from response
+            const response = await axios.post(`/apps/${appId}/integrations/custom/${slug}/${operationId}`, body);
+            // The axios interceptor extracts response.data, so we get the payload directly
             return response;
         },
     };

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

@@ -1,8 +1,5 @@
 /**
  * Parameters for calling a custom integration endpoint.
- *
- * Supports both camelCase and snake_case parameter names for developer convenience.
- * The SDK will normalize to snake_case before sending to the API.
  */
 export interface CustomIntegrationCallParams {
     /**
@@ -11,24 +8,12 @@ export interface CustomIntegrationCallParams {
     payload?: Record<string, any>;
     /**
      * Path parameters to substitute in the URL (e.g., `{ owner: "user", repo: "repo" }`).
-     * Can use either `pathParams` (camelCase) or `path_params` (snake_case).
      */
     pathParams?: Record<string, string>;
-    /**
-     * Path parameters to substitute in the URL (snake_case variant).
-     * @see {@link pathParams}
-     */
-    path_params?: Record<string, string>;
     /**
      * Query string parameters to append to the URL.
-     * Can use either `queryParams` (camelCase) or `query_params` (snake_case).
      */
     queryParams?: Record<string, any>;
-    /**
-     * Query string parameters (snake_case variant).
-     * @see {@link queryParams}
-     */
-    query_params?: Record<string, any>;
     /**
      * Additional headers to send with this specific request.
      * These are merged with the integration's configured headers.
@@ -107,7 +92,7 @@ export interface CustomIntegrationsModule {
      *
      * @param slug - The integration's unique identifier (slug), as defined by the workspace admin.
      * @param operationId - The operation ID from the OpenAPI spec (e.g., "listIssues", "getUser").
-     * @param params - Optional parameters including payload, path params, query params, and headers.
+     * @param params - Optional parameters including payload, pathParams, queryParams, and headers.
      * @returns Promise resolving to the integration call response.
      *
      * @throws {Error} If slug is not provided.

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,40 @@ export function createEntitiesModule(axios, appId) {
                 return undefined;
             }
             // Create entity handler
-            return createEntityHandler(axios, appId, entityName);
+            return createEntityHandler(axios, appId, entityName, getSocket);
         },
     });
 }
+/**
+ * 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(),
+        };
+    }
+    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 +118,25 @@ function createEntityHandler(axios, appId, entityName) {
                 },
             });
         },
+        // Subscribe to realtime updates
+        subscribe(callback) {
+            const room = `entities:${appId}:${entityName}`;
+            // 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;
+                    }
+                    callback(event);
+                },
+            });
+            return unsubscribe;
+        },
     };
 }

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

@@ -1,3 +1,28 @@
+/**
+ * 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;
+}
+/**
+ * Callback function invoked when a realtime event occurs.
+ */
+export type RealtimeCallback<T = Record<string, any>> = (event: RealtimeEvent<T>) => void;
+/**
+ * Function returned from subscribe, call it to unsubscribe.
+ */
+export type Subscription = () => void;
 /**
  * Entity handler providing CRUD operations for a specific entity type.
  *
@@ -242,6 +267,26 @@ 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.
+     * @returns Unsubscribe function to stop listening.
+     *
+     * @example
+     * ```typescript
+     * // Subscribe to all Task changes
+     * const unsubscribe = base44.entities.Task.subscribe((event) => {
+     *   console.log(`Task ${event.id} was ${event.type}d:`, event.data);
+     * });
+     *
+     * // Later, unsubscribe
+     * unsubscribe();
+     * ```
+     */
+    subscribe(callback: RealtimeCallback): Subscription;
 }
 /**
  * Entities module for managing app data.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.10-pr.62.8f72a2c",
+  "version": "0.8.11-pr.58.0494dbf",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",