@base44-preview/sdk 0.8.5-pr.52.e60528e → 0.8.6-pr.48.d625f02

package/dist/client.d.ts

@@ -1,239 +1,92 @@
-export type CreateClientOptions = {
-    onError?: (error: Error) => void;
-};
-export type Base44Client = ReturnType<typeof createClient>;
+import type { Base44Client, CreateClientConfig, CreateClientOptions } from "./client.types.js";
+export type { Base44Client, CreateClientConfig, CreateClientOptions };
 /**
- * Create a Base44 client instance
- * @param {Object} config - Client configuration
- * @param {string} [config.serverUrl='https://base44.app'] - API server URL
- * @param {string} [config.appBaseUrl] - Application base URL
- * @param {string|number} config.appId - Application ID
- * @param {string} [config.token] - Authentication token
- * @param {string} [config.serviceToken] - Service role authentication token
- * @param {boolean} [config.requiresAuth=false] - Whether the app requires authentication
- * @returns {Object} Base44 client instance
+ * Creates a Base44 client.
+ *
+ * This is the main entry point for the Base44 SDK. It creates a client that provides access to the SDK's modules, such as {@linkcode EntitiesModule | entities}, {@linkcode AuthModule | auth}, and {@linkcode FunctionsModule | functions}.
+ *
+ * Typically, you don't need to call this function because Base44 creates the client for you. You can then import and use the client to make API calls. The client takes care of managing authentication for you.
+ *
+ * The client supports three authentication modes:
+ * - **Anonymous**: Access modules anonymously without authentication using `base44.moduleName`. Operations are scoped to public data and permissions.
+ * - **User authentication**: Access modules with user-level permissions using `base44.moduleName`. Operations are scoped to the authenticated user's data and permissions.
+ * - **Service role authentication**: Access modules with elevated permissions using `base44.asServiceRole.moduleName`. Operations can access any data available to the app's admin. Can only be used in the backend. Typically, you create a client with service role authentication using the {@linkcode createClientFromRequest | createClientFromRequest()} function in your backend functions.
+ *
+ * For example, when using the {@linkcode EntitiesModule | entities} module:
+ * - **Anonymous**: Can only read public data.
+ * - **User authentication**: Can access the current user's data.
+ * - **Service role authentication**: Can access all data that admins can access.
+ *
+ * Most modules are available in all three modes, but with different permission levels. However, some modules are only available in specific authentication modes.
+ *
+ * @param config - Configuration object for the client.
+ * @returns A configured Base44 client instance with access to all SDK modules.
+ *
+ * @example
+ * ```typescript
+ * // Create a client for your app
+ * import { createClient } from '@base44/sdk';
+ *
+ * const base44 = createClient({
+ *   appId: 'my-app-id'
+ * });
+ *
+ * // Use the client to access your data
+ * const products = await base44.entities.Products.list();
+ * ```
  */
-export declare function createClient(config: {
-    serverUrl?: string;
-    appBaseUrl?: string;
-    appId: string;
-    token?: string;
-    serviceToken?: string;
-    requiresAuth?: boolean;
-    functionsVersion?: string;
-    headers?: Record<string, string>;
-    options?: CreateClientOptions;
-}): {
-    /**
-     * Set authentication token for all requests
-     * @param {string} newToken - New auth token
-     */
-    setToken(newToken: string): void;
-    /**
-     * Get current configuration
-     * @returns {Object} Current configuration
-     */
-    getConfig(): {
-        serverUrl: string;
-        appId: string;
-        requiresAuth: boolean;
-    };
-    asServiceRole: {
-        entities: {};
-        integrations: {};
-        sso: {
-            getAccessToken(userid: string): Promise<import("axios").AxiosResponse<any, any>>;
-        };
-        connectors: {
-            getAccessToken(integrationType: import("./types.js").ConnectorIntegrationType): Promise<import("./types.js").ConnectorAccessTokenResponse>;
-        };
-        functions: {
-            invoke(functionName: string, data: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
-        };
-        agents: {
-            getConversations: () => Promise<import("./types.js").AgentConversation[]>;
-            getConversation: (conversationId: string) => Promise<import("./types.js").AgentConversation | undefined>;
-            listConversations: (filterParams: import("./types.js").ModelFilterParams) => Promise<import("./types.js").AgentConversation[]>;
-            createConversation: (conversation: {
-                agent_name: string;
-                metadata?: Record<string, any>;
-            }) => Promise<import("./types.js").AgentConversation>;
-            addMessage: (conversation: import("./types.js").AgentConversation, message: import("./types.js").AgentMessage) => Promise<import("./types.js").AgentMessage>;
-            subscribeToConversation: (conversationId: string, onUpdate?: (conversation: import("./types.js").AgentConversation) => void) => () => void;
-            getWhatsAppConnectURL: (agentName: string) => string;
-        };
-        appLogs: {
-            logUserInApp(pageName: string): Promise<void>;
-            fetchLogs(params?: Record<string, any>): Promise<any>;
-            getStats(params?: Record<string, any>): Promise<any>;
-        };
-        cleanup: () => void;
-    };
-    entities: {};
-    integrations: {};
-    auth: {
-        me(): Promise<import("axios").AxiosResponse<any, any>>;
-        updateMe(data: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
-        redirectToLogin(nextUrl: string): void;
-        logout(redirectUrl?: string): void;
-        setToken(token: string, saveToStorage?: boolean): void;
-        loginViaEmailPassword(email: string, password: string, turnstileToken?: string): Promise<{
-            access_token: string;
-            user: any;
-        }>;
-        isAuthenticated(): Promise<boolean>;
-        inviteUser(userEmail: string, role: string): Promise<import("axios").AxiosResponse<any, any>>;
-        register(payload: {
-            email: string;
-            password: string;
-            turnstile_token?: string | null;
-            referral_code?: string | null;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-        verifyOtp({ email, otpCode }: {
-            email: string;
-            otpCode: string;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-        resendOtp(email: string): Promise<import("axios").AxiosResponse<any, any>>;
-        resetPasswordRequest(email: string): Promise<import("axios").AxiosResponse<any, any>>;
-        resetPassword({ resetToken, newPassword, }: {
-            resetToken: string;
-            newPassword: string;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-        changePassword({ userId, currentPassword, newPassword, }: {
-            userId: string;
-            currentPassword: string;
-            newPassword: string;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-    };
-    functions: {
-        invoke(functionName: string, data: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
-    };
-    agents: {
-        getConversations: () => Promise<import("./types.js").AgentConversation[]>;
-        getConversation: (conversationId: string) => Promise<import("./types.js").AgentConversation | undefined>;
-        listConversations: (filterParams: import("./types.js").ModelFilterParams) => Promise<import("./types.js").AgentConversation[]>;
-        createConversation: (conversation: {
-            agent_name: string;
-            metadata?: Record<string, any>;
-        }) => Promise<import("./types.js").AgentConversation>;
-        addMessage: (conversation: import("./types.js").AgentConversation, message: import("./types.js").AgentMessage) => Promise<import("./types.js").AgentMessage>;
-        subscribeToConversation: (conversationId: string, onUpdate?: (conversation: import("./types.js").AgentConversation) => void) => () => void;
-        getWhatsAppConnectURL: (agentName: string) => string;
-    };
-    appLogs: {
-        logUserInApp(pageName: string): Promise<void>;
-        fetchLogs(params?: Record<string, any>): Promise<any>;
-        getStats(params?: Record<string, any>): Promise<any>;
-    };
-    users: {
-        inviteUser(user_email: string, role: "user" | "admin"): Promise<any>;
-    };
-    cleanup: () => void;
-};
-export declare function createClientFromRequest(request: Request): {
-    /**
-     * Set authentication token for all requests
-     * @param {string} newToken - New auth token
-     */
-    setToken(newToken: string): void;
-    /**
-     * Get current configuration
-     * @returns {Object} Current configuration
-     */
-    getConfig(): {
-        serverUrl: string;
-        appId: string;
-        requiresAuth: boolean;
-    };
-    asServiceRole: {
-        entities: {};
-        integrations: {};
-        sso: {
-            getAccessToken(userid: string): Promise<import("axios").AxiosResponse<any, any>>;
-        };
-        connectors: {
-            getAccessToken(integrationType: import("./types.js").ConnectorIntegrationType): Promise<import("./types.js").ConnectorAccessTokenResponse>;
-        };
-        functions: {
-            invoke(functionName: string, data: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
-        };
-        agents: {
-            getConversations: () => Promise<import("./types.js").AgentConversation[]>;
-            getConversation: (conversationId: string) => Promise<import("./types.js").AgentConversation | undefined>;
-            listConversations: (filterParams: import("./types.js").ModelFilterParams) => Promise<import("./types.js").AgentConversation[]>;
-            createConversation: (conversation: {
-                agent_name: string;
-                metadata?: Record<string, any>;
-            }) => Promise<import("./types.js").AgentConversation>;
-            addMessage: (conversation: import("./types.js").AgentConversation, message: import("./types.js").AgentMessage) => Promise<import("./types.js").AgentMessage>;
-            subscribeToConversation: (conversationId: string, onUpdate?: (conversation: import("./types.js").AgentConversation) => void) => () => void;
-            getWhatsAppConnectURL: (agentName: string) => string;
-        };
-        appLogs: {
-            logUserInApp(pageName: string): Promise<void>;
-            fetchLogs(params?: Record<string, any>): Promise<any>;
-            getStats(params?: Record<string, any>): Promise<any>;
-        };
-        cleanup: () => void;
-    };
-    entities: {};
-    integrations: {};
-    auth: {
-        me(): Promise<import("axios").AxiosResponse<any, any>>;
-        updateMe(data: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
-        redirectToLogin(nextUrl: string): void;
-        logout(redirectUrl?: string): void;
-        setToken(token: string, saveToStorage?: boolean): void;
-        loginViaEmailPassword(email: string, password: string, turnstileToken?: string): Promise<{
-            access_token: string;
-            user: any;
-        }>;
-        isAuthenticated(): Promise<boolean>;
-        inviteUser(userEmail: string, role: string): Promise<import("axios").AxiosResponse<any, any>>;
-        register(payload: {
-            email: string;
-            password: string;
-            turnstile_token?: string | null;
-            referral_code?: string | null;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-        verifyOtp({ email, otpCode }: {
-            email: string;
-            otpCode: string;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-        resendOtp(email: string): Promise<import("axios").AxiosResponse<any, any>>;
-        resetPasswordRequest(email: string): Promise<import("axios").AxiosResponse<any, any>>;
-        resetPassword({ resetToken, newPassword, }: {
-            resetToken: string;
-            newPassword: string;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-        changePassword({ userId, currentPassword, newPassword, }: {
-            userId: string;
-            currentPassword: string;
-            newPassword: string;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
-    };
-    functions: {
-        invoke(functionName: string, data: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
-    };
-    agents: {
-        getConversations: () => Promise<import("./types.js").AgentConversation[]>;
-        getConversation: (conversationId: string) => Promise<import("./types.js").AgentConversation | undefined>;
-        listConversations: (filterParams: import("./types.js").ModelFilterParams) => Promise<import("./types.js").AgentConversation[]>;
-        createConversation: (conversation: {
-            agent_name: string;
-            metadata?: Record<string, any>;
-        }) => Promise<import("./types.js").AgentConversation>;
-        addMessage: (conversation: import("./types.js").AgentConversation, message: import("./types.js").AgentMessage) => Promise<import("./types.js").AgentMessage>;
-        subscribeToConversation: (conversationId: string, onUpdate?: (conversation: import("./types.js").AgentConversation) => void) => () => void;
-        getWhatsAppConnectURL: (agentName: string) => string;
-    };
-    appLogs: {
-        logUserInApp(pageName: string): Promise<void>;
-        fetchLogs(params?: Record<string, any>): Promise<any>;
-        getStats(params?: Record<string, any>): Promise<any>;
-    };
-    users: {
-        inviteUser(user_email: string, role: "user" | "admin"): Promise<any>;
-    };
-    cleanup: () => void;
-};
+export declare function createClient(config: CreateClientConfig): Base44Client;
+/**
+ * Creates a Base44 client from an HTTP request.
+ *
+ * The client is created by automatically extracting authentication tokens from a request to a backend function. Base44 inserts the necessary headers when forwarding requests to backend functions.
+ *
+ * To learn more about the Base44 client, see {@linkcode createClient | createClient()}.
+ *
+ * @param request - The incoming HTTP request object containing Base44 authentication headers.
+ * @returns A configured Base44 client instance with authentication from the incoming request.
+ *
+ * @example
+ * ```typescript
+ * // User authentication in backend function
+ * import { createClientFromRequest } from 'npm:@base44/sdk';
+ *
+ * Deno.serve(async (req) => {
+ *   try {
+ *     const base44 = createClientFromRequest(req);
+ *     const user = await base44.auth.me();
+ *
+ *     if (!user) {
+ *       return Response.json({ error: 'Unauthorized' }, { status: 401 });
+ *     }
+ *
+ *     // Access user's data
+ *     const userOrders = await base44.entities.Orders.filter({ userId: user.id });
+ *     return Response.json({ orders: userOrders });
+ *   } catch (error) {
+ *     return Response.json({ error: error.message }, { status: 500 });
+ *   }
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Service role authentication in backend function
+ * import { createClientFromRequest } from 'npm:@base44/sdk';
+ *
+ * Deno.serve(async (req) => {
+ *   try {
+ *     const base44 = createClientFromRequest(req);
+ *
+ *     // Access admin data with service role permissions
+ *     const recentOrders = await base44.asServiceRole.entities.Orders.list('-created_at', 50);
+ *
+ *     return Response.json({ orders: recentOrders });
+ *   } catch (error) {
+ *     return Response.json({ error: error.message }, { status: 500 });
+ *   }
+ * });
+ * ```
+ *
+ */
+export declare function createClientFromRequest(request: Request): Base44Client;

package/dist/client.js

@@ -11,15 +11,39 @@ import { createAppLogsModule } from "./modules/app-logs.js";
 import { createUsersModule } from "./modules/users.js";
 import { RoomsSocket } from "./utils/socket-utils.js";
 /**
- * Create a Base44 client instance
- * @param {Object} config - Client configuration
- * @param {string} [config.serverUrl='https://base44.app'] - API server URL
- * @param {string} [config.appBaseUrl] - Application base URL
- * @param {string|number} config.appId - Application ID
- * @param {string} [config.token] - Authentication token
- * @param {string} [config.serviceToken] - Service role authentication token
- * @param {boolean} [config.requiresAuth=false] - Whether the app requires authentication
- * @returns {Object} Base44 client instance
+ * Creates a Base44 client.
+ *
+ * This is the main entry point for the Base44 SDK. It creates a client that provides access to the SDK's modules, such as {@linkcode EntitiesModule | entities}, {@linkcode AuthModule | auth}, and {@linkcode FunctionsModule | functions}.
+ *
+ * Typically, you don't need to call this function because Base44 creates the client for you. You can then import and use the client to make API calls. The client takes care of managing authentication for you.
+ *
+ * The client supports three authentication modes:
+ * - **Anonymous**: Access modules anonymously without authentication using `base44.moduleName`. Operations are scoped to public data and permissions.
+ * - **User authentication**: Access modules with user-level permissions using `base44.moduleName`. Operations are scoped to the authenticated user's data and permissions.
+ * - **Service role authentication**: Access modules with elevated permissions using `base44.asServiceRole.moduleName`. Operations can access any data available to the app's admin. Can only be used in the backend. Typically, you create a client with service role authentication using the {@linkcode createClientFromRequest | createClientFromRequest()} function in your backend functions.
+ *
+ * For example, when using the {@linkcode EntitiesModule | entities} module:
+ * - **Anonymous**: Can only read public data.
+ * - **User authentication**: Can access the current user's data.
+ * - **Service role authentication**: Can access all data that admins can access.
+ *
+ * Most modules are available in all three modes, but with different permission levels. However, some modules are only available in specific authentication modes.
+ *
+ * @param config - Configuration object for the client.
+ * @returns A configured Base44 client instance with access to all SDK modules.
+ *
+ * @example
+ * ```typescript
+ * // Create a client for your app
+ * import { createClient } from '@base44/sdk';
+ *
+ * const base44 = createClient({
+ *   appId: 'my-app-id'
+ * });
+ *
+ * // Use the client to access your data
+ * const products = await base44.entities.Products.list();
+ * ```
  */
 export function createClient(config) {
     const { serverUrl = "https://base44.app", appId, token, serviceToken, requiresAuth = false, appBaseUrl, options, functionsVersion, headers: optionalHeaders, } = config;
@@ -30,9 +54,15 @@ export function createClient(config) {
         appId,
         token,
     };
-    const socket = RoomsSocket({
-        config: socketConfig,
-    });
+    let socket = null;
+    const getSocket = () => {
+        if (!socket) {
+            socket = RoomsSocket({
+                config: socketConfig,
+            });
+        }
+        return socket;
+    };
     const headers = {
         ...optionalHeaders,
         "X-App-Id": String(appId),
@@ -78,7 +108,7 @@ export function createClient(config) {
         functions: createFunctionsModule(functionsAxiosClient, appId),
         agents: createAgentsModule({
             axios: axiosClient,
-            socket,
+            getSocket,
             appId,
             serverUrl,
             token,
@@ -86,7 +116,9 @@ export function createClient(config) {
         appLogs: createAppLogsModule(axiosClient, appId),
         users: createUsersModule(axiosClient, appId),
         cleanup: () => {
-            socket.disconnect();
+            if (socket) {
+                socket.disconnect();
+            }
         },
     };
     const serviceRoleModules = {
@@ -97,14 +129,16 @@ export function createClient(config) {
         functions: createFunctionsModule(serviceRoleFunctionsAxiosClient, appId),
         agents: createAgentsModule({
             axios: serviceRoleAxiosClient,
-            socket,
+            getSocket,
             appId,
             serverUrl,
             token,
         }),
         appLogs: createAppLogsModule(serviceRoleAxiosClient, appId),
         cleanup: () => {
-            socket.disconnect();
+            if (socket) {
+                socket.disconnect();
+            }
         },
     };
     // Always try to get token from localStorage or URL parameters
@@ -135,18 +169,33 @@ export function createClient(config) {
     const client = {
         ...userModules,
         /**
-         * Set authentication token for all requests
-         * @param {string} newToken - New auth token
+         * Sets a new authentication token for all subsequent requests.
+         *
+         * @param newToken - The new authentication token
+         *
+         * @example
+         * ```typescript
+         * // Update token after login
+         * const { access_token } = await base44.auth.loginViaEmailPassword(
+         *   'user@example.com',
+         *   'password'
+         * );
+         * base44.setToken(access_token);
+         * ```
          */
         setToken(newToken) {
             userModules.auth.setToken(newToken);
-            socket.updateConfig({
-                token: newToken,
-            });
+            if (socket) {
+                socket.updateConfig({
+                    token: newToken,
+                });
+            }
+            socketConfig.token = newToken;
         },
         /**
-         * Get current configuration
-         * @returns {Object} Current configuration
+         * Gets the current client configuration.
+         *
+         * @internal
          */
         getConfig() {
             return {
@@ -156,8 +205,22 @@ export function createClient(config) {
             };
         },
         /**
-         * Access service role modules - throws error if no service token was provided
-         * @throws {Error} When accessed without a service token
+         * Provides access to service role modules.
+         *
+         * Service role authentication provides elevated permissions for server-side operations. Unlike user authentication, which is scoped to a specific user's permissions, service role authentication has access to the data and operations available to the app's admin.
+         *
+         * @throws {Error} When accessed without providing a serviceToken during client creation.
+         *
+         * @example
+         * ```typescript
+         * const base44 = createClient({
+         *   appId: 'my-app-id',
+         *   serviceToken: 'service-role-token'
+         * });
+         *
+         * // Also access a module with elevated permissions
+         * const allUsers = await base44.asServiceRole.entities.User.list();
+         * ```
          */
         get asServiceRole() {
             if (!serviceToken) {
@@ -168,6 +231,59 @@ export function createClient(config) {
     };
     return client;
 }
+/**
+ * Creates a Base44 client from an HTTP request.
+ *
+ * The client is created by automatically extracting authentication tokens from a request to a backend function. Base44 inserts the necessary headers when forwarding requests to backend functions.
+ *
+ * To learn more about the Base44 client, see {@linkcode createClient | createClient()}.
+ *
+ * @param request - The incoming HTTP request object containing Base44 authentication headers.
+ * @returns A configured Base44 client instance with authentication from the incoming request.
+ *
+ * @example
+ * ```typescript
+ * // User authentication in backend function
+ * import { createClientFromRequest } from 'npm:@base44/sdk';
+ *
+ * Deno.serve(async (req) => {
+ *   try {
+ *     const base44 = createClientFromRequest(req);
+ *     const user = await base44.auth.me();
+ *
+ *     if (!user) {
+ *       return Response.json({ error: 'Unauthorized' }, { status: 401 });
+ *     }
+ *
+ *     // Access user's data
+ *     const userOrders = await base44.entities.Orders.filter({ userId: user.id });
+ *     return Response.json({ orders: userOrders });
+ *   } catch (error) {
+ *     return Response.json({ error: error.message }, { status: 500 });
+ *   }
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Service role authentication in backend function
+ * import { createClientFromRequest } from 'npm:@base44/sdk';
+ *
+ * Deno.serve(async (req) => {
+ *   try {
+ *     const base44 = createClientFromRequest(req);
+ *
+ *     // Access admin data with service role permissions
+ *     const recentOrders = await base44.asServiceRole.entities.Orders.list('-created_at', 50);
+ *
+ *     return Response.json({ orders: recentOrders });
+ *   } catch (error) {
+ *     return Response.json({ error: error.message }, { status: 500 });
+ *   }
+ * });
+ * ```
+ *
+ */
 export function createClientFromRequest(request) {
     const authHeader = request.headers.get("Authorization");
     const serviceRoleAuthHeader = request.headers.get("Base44-Service-Authorization");