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

package/dist/modules/app-logs.types.d.ts

@@ -0,0 +1,44 @@
+/**
+ * App Logs module for tracking and analyzing app usage.
+ *
+ * This module provides a method to log user activity. The logs are reflected in the Analytics page in the app dashboard.
+ *
+ * This module is available to use with a client in all authentication modes.
+ */
+export interface AppLogsModule {
+    /**
+     * Log user activity in the app.
+     *
+     * Records when a user visits a specific page or section of the app. Useful for tracking user navigation patterns and popular features. The logs are reflected in the Analytics page in the app dashboard.
+     *
+     * The specified page name doesn't have to be the name of an actual page in the app, it can be any string you want to use to track the activity.
+     *
+     * @param pageName - Name of the page or section being visited.
+     * @returns Promise that resolves when the log is recorded.
+     *
+     * @example
+     * ```typescript
+     * // Log page visit or feature usage
+     * await base44.appLogs.logUserInApp('home');
+     * await base44.appLogs.logUserInApp('features-section');
+     * await base44.appLogs.logUserInApp('button-click');
+     * ```
+     */
+    logUserInApp(pageName: string): Promise<void>;
+    /**
+     * Fetch app logs with optional parameters.
+     *
+     * @param params - Optional query parameters for filtering logs.
+     * @returns Promise resolving to the logs data.
+     * @internal
+     */
+    fetchLogs(params?: Record<string, any>): Promise<any>;
+    /**
+     * Get app statistics.
+     *
+     * @param params - Optional query parameters for filtering stats.
+     * @returns Promise resolving to the stats data.
+     * @internal
+     */
+    getStats(params?: Record<string, any>): Promise<any>;
+}

package/dist/modules/app-logs.types.js

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

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

@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export interface AppMessageContent {
     content?: string;
     file_urls?: string[];
@@ -5,16 +8,25 @@ export interface AppMessageContent {
     additional_message_params?: Record<string, unknown>;
     [key: string]: unknown;
 }
+/**
+ * @internal
+ */
 export interface AppConversationMessage extends AppMessageContent {
     id?: string | null;
     role?: "user" | "assistant" | string;
 }
+/**
+ * @internal
+ */
 export interface AppConversationLike {
     id?: string | null;
     messages?: AppMessageContent[] | null;
     model?: string;
     functions_fail_silently?: boolean;
 }
+/**
+ * @internal
+ */
 export interface DenoProjectLike {
     project_id: string;
     project_name: string;
@@ -24,6 +36,9 @@ export interface DenoProjectLike {
         code: string;
     }>;
 }
+/**
+ * @internal
+ */
 export interface AppLike {
     id?: string;
     conversation?: AppConversationLike | null;
@@ -80,9 +95,15 @@ export interface AppLike {
     app_code_hash?: string;
     has_backend_functions_enabled?: boolean;
 }
+/**
+ * @internal
+ */
 export interface UserLike {
     id?: string | null;
 }
+/**
+ * @internal
+ */
 export interface UserEntityLike {
     type: string;
     name: string;
@@ -104,6 +125,9 @@ export interface UserEntityLike {
     };
     required: string[];
 }
+/**
+ * @internal
+ */
 export interface AuthConfigLike {
     enable_username_password?: boolean;
     enable_google_login?: boolean;
@@ -112,4 +136,7 @@ export interface AuthConfigLike {
     sso_provider_name?: string;
     enable_sso_login?: boolean;
 }
+/**
+ * @internal
+ */
 export type LoginInfoResponse = Pick<AppLike, "id" | "name" | "slug" | "logo_url" | "user_description" | "updated_date" | "created_date" | "auth_config" | "platform_version">;

package/dist/modules/auth.d.ts

@@ -1,81 +1,13 @@
 import { AxiosInstance } from "axios";
+import { AuthModule, AuthModuleOptions } from "./auth.types";
 /**
- * Creates the auth module for the Base44 SDK
- * @param {import('axios').AxiosInstance} axios - Axios instance
- * @param {string|number} appId - Application ID
- * @param {string} serverUrl - Server URL
- * @returns {Object} Auth module with authentication methods
+ * Creates the auth module for the Base44 SDK.
+ *
+ * @param axios - Axios instance for API requests
+ * @param functionsAxiosClient - Axios instance for functions API requests
+ * @param appId - Application ID
+ * @param options - Configuration options including server URLs
+ * @returns Auth module with authentication and user management methods
+ * @internal
  */
-export declare function createAuthModule(axios: AxiosInstance, functionsAxiosClient: AxiosInstance, appId: string, options: {
-    serverUrl: string;
-    appBaseUrl?: string;
-}): {
-    /**
-     * Get current user information
-     * @returns {Promise<Object>} Current user data
-     */
-    me(): Promise<import("axios").AxiosResponse<any, any>>;
-    /**
-     * Update current user data
-     * @param {Object} data - Updated user data
-     * @returns {Promise<Object>} Updated user
-     */
-    updateMe(data: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
-    /**
-     * Redirects the user to the app's login page
-     * @param {string} nextUrl - URL to redirect to after successful login
-     * @throws {Error} When not in a browser environment
-     */
-    redirectToLogin(nextUrl: string): void;
-    /**
-     * Logout the current user
-     * Removes the token from localStorage and optionally redirects to a URL or reloads the page
-     * @param redirectUrl - Optional URL to redirect to after logout. Reloads the page if not provided
-     * @returns {Promise<void>}
-     */
-    logout(redirectUrl?: string): void;
-    /**
-     * Set authentication token
-     * @param {string} token - Auth token
-     * @param {boolean} [saveToStorage=true] - Whether to save the token to localStorage
-     */
-    setToken(token: string, saveToStorage?: boolean): void;
-    /**
-     * Login via username and password
-     * @param email - User email
-     * @param password - User password
-     * @param turnstileToken - Optional Turnstile captcha token
-     * @returns Login response with access_token and user
-     */
-    loginViaEmailPassword(email: string, password: string, turnstileToken?: string): Promise<{
-        access_token: string;
-        user: any;
-    }>;
-    /**
-     * Verify if the current token is valid
-     * @returns {Promise<boolean>} True if token is valid
-     */
-    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>>;
-};
+export declare function createAuthModule(axios: AxiosInstance, functionsAxiosClient: AxiosInstance, appId: string, options: AuthModuleOptions): AuthModule;

package/dist/modules/auth.js

@@ -1,32 +1,24 @@
 /**
- * Creates the auth module for the Base44 SDK
- * @param {import('axios').AxiosInstance} axios - Axios instance
- * @param {string|number} appId - Application ID
- * @param {string} serverUrl - Server URL
- * @returns {Object} Auth module with authentication methods
+ * Creates the auth module for the Base44 SDK.
+ *
+ * @param axios - Axios instance for API requests
+ * @param functionsAxiosClient - Axios instance for functions API requests
+ * @param appId - Application ID
+ * @param options - Configuration options including server URLs
+ * @returns Auth module with authentication and user management methods
+ * @internal
  */
 export function createAuthModule(axios, functionsAxiosClient, appId, options) {
     return {
-        /**
-         * Get current user information
-         * @returns {Promise<Object>} Current user data
-         */
+        // Get current user information
         async me() {
             return axios.get(`/apps/${appId}/entities/User/me`);
         },
-        /**
-         * Update current user data
-         * @param {Object} data - Updated user data
-         * @returns {Promise<Object>} Updated user
-         */
+        // Update current user data
         async updateMe(data) {
             return axios.put(`/apps/${appId}/entities/User/me`, data);
         },
-        /**
-         * Redirects the user to the app's login page
-         * @param {string} nextUrl - URL to redirect to after successful login
-         * @throws {Error} When not in a browser environment
-         */
+        // Redirects the user to the app's login page
         redirectToLogin(nextUrl) {
             var _a;
             // This function only works in a browser environment
@@ -42,12 +34,8 @@ export function createAuthModule(axios, functionsAxiosClient, appId, options) {
             // Redirect to the login page
             window.location.href = loginUrl;
         },
-        /**
-         * Logout the current user
-         * Removes the token from localStorage and optionally redirects to a URL or reloads the page
-         * @param redirectUrl - Optional URL to redirect to after logout. Reloads the page if not provided
-         * @returns {Promise<void>}
-         */
+        // Logout the current user
+        // Removes the token from localStorage and optionally redirects to a URL or reloads the page
         logout(redirectUrl) {
             // Remove token from axios headers
             delete axios.defaults.headers.common["Authorization"];
@@ -72,11 +60,7 @@ export function createAuthModule(axios, functionsAxiosClient, appId, options) {
                 }
             }
         },
-        /**
-         * Set authentication token
-         * @param {string} token - Auth token
-         * @param {boolean} [saveToStorage=true] - Whether to save the token to localStorage
-         */
+        // Set authentication token
         setToken(token, saveToStorage = true) {
             if (!token)
                 return;
@@ -97,13 +81,7 @@ export function createAuthModule(axios, functionsAxiosClient, appId, options) {
                 }
             }
         },
-        /**
-         * Login via username and password
-         * @param email - User email
-         * @param password - User password
-         * @param turnstileToken - Optional Turnstile captcha token
-         * @returns Login response with access_token and user
-         */
+        // Login using username and password
         async loginViaEmailPassword(email, password, turnstileToken) {
             var _a;
             try {
@@ -129,10 +107,7 @@ export function createAuthModule(axios, functionsAxiosClient, appId, options) {
                 throw error;
             }
         },
-        /**
-         * Verify if the current token is valid
-         * @returns {Promise<boolean>} True if token is valid
-         */
+        // Verify if the current token is valid
         async isAuthenticated() {
             try {
                 await this.me();
@@ -142,35 +117,42 @@ export function createAuthModule(axios, functionsAxiosClient, appId, options) {
                 return false;
             }
         },
+        // Invite a user to the app
         inviteUser(userEmail, role) {
             return axios.post(`/apps/${appId}/users/invite-user`, {
                 user_email: userEmail,
                 role,
             });
         },
+        // Register a new user account
         register(payload) {
             return axios.post(`/apps/${appId}/auth/register`, payload);
         },
+        // Verify an OTP (One-time password) code
         verifyOtp({ email, otpCode }) {
             return axios.post(`/apps/${appId}/auth/verify-otp`, {
                 email,
                 otp_code: otpCode,
             });
         },
+        // Resend an OTP code to the user's email
         resendOtp(email) {
             return axios.post(`/apps/${appId}/auth/resend-otp`, { email });
         },
+        // Request a password reset
         resetPasswordRequest(email) {
             return axios.post(`/apps/${appId}/auth/reset-password-request`, {
                 email,
             });
         },
-        resetPassword({ resetToken, newPassword, }) {
+        // Reset password using a reset token
+        resetPassword({ resetToken, newPassword }) {
             return axios.post(`/apps/${appId}/auth/reset-password`, {
                 reset_token: resetToken,
                 new_password: newPassword,
             });
         },
+        // Change the user's password
         changePassword({ userId, currentPassword, newPassword, }) {
             return axios.post(`/apps/${appId}/auth/change-password`, {
                 user_id: userId,