@base44-preview/sdk 0.8.12-pr.70.fb3fcc2 → 0.8.13-pr.58.3a4abcb

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/connectors.types.d.ts

@@ -11,7 +11,9 @@ export interface ConnectorAccessTokenResponse {
 /**
  * Connectors module for managing OAuth tokens for external services.
  *
- * This module allows you to retrieve OAuth access tokens for external services that the app has connected to. Connectors are app-scoped. When an app builder connects an integration like Google Calendar or Slack, all users of the app share that same connection.
+ * This module allows you to retrieve OAuth access tokens for external services
+ * that the app has connected to. Use these tokens to make API
+ * calls to external services.
  *
  * Unlike the integrations module that provides pre-built functions, connectors give you
  * raw OAuth tokens so you can call external service APIs directly with full control over
@@ -24,9 +26,9 @@ export interface ConnectorsModule {
     /**
      * Retrieves an OAuth access token for a specific external integration type.
      *
-     * Returns the OAuth token string for an external service that an app builder
-     * has connected to. This token represents the connected app builder's account
-     * and can be used to make authenticated API calls to that external service on behalf of the app.
+     * Returns the OAuth token string for an external service that the app
+     * has connected to. You can then use this token to make authenticated API calls
+     * to that external service.
      *
      * @param integrationType - The type of integration, such as `'googlecalendar'`, `'slack'`, or `'github'`.
      * @returns Promise resolving to the access token string.

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

@@ -3,23 +3,20 @@
  */
 export interface CustomIntegrationCallParams {
     /**
-     * Request body to send to the external API. The payload is JSON-serialized before being sent.
+     * Request body payload to send to the external API.
      */
     payload?: Record<string, any>;
     /**
-     * Path parameters to substitute into the URL template.
-     * For example, if the API endpoint is `/repos/{owner}/{repo}/issues`,
-     * pass `{ owner: "myorg", repo: "myrepo" }`.
+     * Path parameters to substitute in the URL (e.g., `{ owner: "user", repo: "repo" }`).
      */
     pathParams?: Record<string, string>;
     /**
      * Query string parameters to append to the URL.
-     * For example, `{ state: "open", per_page: 50 }` becomes `?state=open&per_page=50`.
      */
     queryParams?: Record<string, any>;
     /**
-     * Additional HTTP headers to include in the request.
-     * These headers are merged with any headers configured for the integration itself, with headers specified here taking precedence in case of conflicts.
+     * Additional headers to send with this specific request.
+     * These are merged with the integration's configured headers.
      */
     headers?: Record<string, string>;
 }
@@ -36,25 +33,66 @@ export interface CustomIntegrationCallResponse {
      */
     status_code: number;
     /**
-     * The parsed JSON response body from the external API.
-     * The structure depends on the API endpoint being called.
+     * The response data from the external API.
+     * Can be any JSON-serializable value depending on the external API's response.
      */
     data: any;
 }
 /**
- * Custom integrations module for calling workspace-level API integrations.
+ * Module for calling custom workspace-level API integrations.
+ *
+ * Custom integrations allow workspace administrators to connect any external API
+ * by importing an OpenAPI specification. Apps in the workspace can then call
+ * these integrations using this module.
+ *
+ * Unlike the built-in integrations (like `Core`), custom integrations:
+ * - Are defined per-workspace by importing OpenAPI specs
+ * - Use a slug-based identifier instead of package names
+ * - Proxy requests through Base44's backend (credentials never exposed to frontend)
+ *
+ * @example
+ * ```typescript
+ * // Call a custom GitHub integration
+ * const response = await base44.integrations.custom.call(
+ *   "github",        // integration slug (defined by workspace admin)
+ *   "listIssues",    // operation ID from the OpenAPI spec
+ *   {
+ *     pathParams: { owner: "myorg", repo: "myrepo" },
+ *     queryParams: { state: "open", per_page: 100 }
+ *   }
+ * );
+ *
+ * if (response.success) {
+ *   console.log("Issues:", response.data);
+ * } else {
+ *   console.error("API returned error:", response.status_code);
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Call with request body payload
+ * const response = await base44.integrations.custom.call(
+ *   "github",
+ *   "createIssue",
+ *   {
+ *     pathParams: { owner: "myorg", repo: "myrepo" },
+ *     payload: {
+ *       title: "Bug report",
+ *       body: "Something is broken",
+ *       labels: ["bug"]
+ *     }
+ *   }
+ * );
+ * ```
  */
 export interface CustomIntegrationsModule {
     /**
      * Call a custom integration endpoint.
      *
-     * Custom integrations are external APIs that have been pre-configured by a workspace administrator who imports an OpenAPI specification. Each integration is identified by a slug and exposes operations defined in the specification.
-     *
-     * Requests are proxied through Base44's backend, so API credentials aren't exposed. That means you can safely use this method to call external APIs from frontend code.
-     *
-     * @param slug - The integration's unique identifier, as defined by the workspace admin.
-     * @param operationId - The operation ID from the OpenAPI specification, such as `"listIssues"` or `"getUser"`.
-     * @param params - Optional parameters to send to the external API.
+     * @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, pathParams, queryParams, and headers.
      * @returns Promise resolving to the integration call response.
      *
      * @throws {Error} If slug is not provided.
@@ -62,38 +100,6 @@ export interface CustomIntegrationsModule {
      * @throws {Base44Error} If the integration or operation is not found (404).
      * @throws {Base44Error} If the external API call fails (502).
      * @throws {Base44Error} If the request times out (504).
-     *
-     * @example
-     * ```typescript
-     * // GET request with path and query parameters
-     * const response = await base44.integrations.custom.call(
-     *   "github",
-     *   "listRepoIssues",
-     *   {
-     *     pathParams: { owner: "myorg", repo: "myrepo" },
-     *     queryParams: { state: "open", per_page: 50 }
-     *   }
-     * );
-     *
-     * if (response.success) {
-     *   console.log("Found issues:", response.data.length);
-     * }
-     * ```
-     *
-     * @example
-     * ```typescript
-     * // POST request with a JSON body
-     * const response = await base44.integrations.custom.call(
-     *   "slack",
-     *   "postMessage",
-     *   {
-     *     payload: {
-     *       channel: "#general",
-     *       text: "Hello from Base44!"
-     *     }
-     *   }
-     * );
-     * ```
      */
     call(slug: string, operationId: string, params?: CustomIntegrationCallParams): Promise<CustomIntegrationCallResponse>;
 }

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,21 @@ 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) => {
+                    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 {
+    /** The type of change that occurred */
+    type: RealtimeEventType;
+    /** The entity data */
+    data: any;
+    /** 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 = (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.
  *
@@ -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/dist/modules/integrations.types.d.ts

@@ -320,28 +320,22 @@ export interface CoreIntegrations {
     CreateFileSignedUrl(params: CreateFileSignedUrlParams): Promise<CreateFileSignedUrlResult>;
 }
 /**
- * Integrations module for calling integration methods.
+ * Integrations module for calling integration endpoints.
  *
- * This module provides access to integration methods for interacting with external services. Unlike the connectors module that gives you raw OAuth tokens, integrations provide pre-built functions that Base44 executes on your behalf.
+ * This module provides access to integration endpoints for interacting with external
+ * services. Integrations are organized into packages. Base44 provides built-in integrations
+ * in the `Core` package.
  *
- * There are two types of integrations:
+ * Unlike the connectors module that gives you raw OAuth tokens, integrations provide
+ * pre-built functions that Base44 executes on your behalf.
  *
- * - **Built-in integrations** (`Core`): Pre-built functions provided by Base44 for common tasks such as AI-powered text generation, image creation, file uploads, and email. Access core integration methods using:
- *   ```
- *   base44.integrations.Core.FunctionName(params)
- *   ```
- *
- * - **Custom integrations** (`custom`): Pre-configured external APIs. Custom integration calls are proxied through Base44's backend, so credentials are never exposed to the frontend. Access custom integration methods using:
- *   ```
- *   base44.integrations.custom.call(slug, operationId, params)
- *   ```
- *
- *   <Info>To call a custom integration, it must be pre-configured by a workspace administrator who imports an OpenAPI specification.</Info>
+ * Integration endpoints are accessed dynamically using the pattern:
+ * `base44.integrations.PackageName.EndpointName(params)`
  *
  * This module is available to use with a client in all authentication modes:
  *
- * - **Anonymous or User authentication** (`base44.integrations`): Integration methods are invoked with the current user's permissions. Anonymous users invoke methods without authentication, while authenticated users invoke methods with their authentication context.
- * - **Service role authentication** (`base44.asServiceRole.integrations`): Integration methods are invoked with elevated admin-level permissions. The methods execute with admin authentication context.
+ * - **Anonymous or User authentication** (`base44.integrations`): Integration endpoints are invoked with the current user's permissions. Anonymous users invoke endpoints without authentication, while authenticated users invoke endpoints with their authentication context.
+ * - **Service role authentication** (`base44.asServiceRole.integrations`): Integration endpoints are invoked with elevated admin-level permissions. The endpoints execute with admin authentication context.
  */
 export type IntegrationsModule = {
     /**
@@ -349,7 +343,22 @@ export type IntegrationsModule = {
      */
     Core: CoreIntegrations;
     /**
-     * Custom integrations module for calling pre-configured external APIs.
+     * Custom integrations module for calling workspace-level API integrations.
+     *
+     * Allows calling external APIs that workspace admins have configured
+     * by importing OpenAPI specifications.
+     *
+     * @example
+     * ```typescript
+     * const response = await base44.integrations.custom.call(
+     *   "github",        // integration slug
+     *   "listIssues",    // operation ID
+     *   {
+     *     pathParams: { owner: "myorg", repo: "myrepo" },
+     *     queryParams: { state: "open" }
+     *   }
+     * );
+     * ```
      */
     custom: CustomIntegrationsModule;
 } & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base44-preview/sdk",
-  "version": "0.8.12-pr.70.fb3fcc2",
+  "version": "0.8.13-pr.58.3a4abcb",
   "description": "JavaScript SDK for Base44 API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",