@depup/base44__sdk 0.8.22-depup.0

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

@@ -0,0 +1,44 @@
+/**
+ * Response from SSO access token endpoint.
+ * @internal
+ */
+export interface SsoAccessTokenResponse {
+    access_token: string;
+}
+/**
+ * SSO (Single Sign-On) module for managing SSO authentication.
+ *
+ * This module provides methods for retrieving SSO access tokens for users.
+ * These tokens allow you to authenticate Base44 users with external
+ * systems or services.
+ *
+ * This module is only available to use with a client in service role authentication mode, which means it can only be used in backend environments.
+ *
+ * @internal
+ *
+ * @example
+ * ```typescript
+ * // Access SSO module with service role
+ * const response = await base44.asServiceRole.sso.getAccessToken('user_123');
+ * console.log(response.data.access_token);
+ * ```
+ */
+export interface SsoModule {
+    /**
+     * Gets SSO access token for a specific user.
+     *
+     * Retrieves a Single Sign-On access token that can be used to authenticate
+     * a user with external services or systems.
+     *
+     * @param userid - The user ID to get the access token for.
+     * @returns Promise resolving to the SSO access token response.
+     *
+     * @example
+     * ```typescript
+     * // Get SSO access token for a user
+     * const response = await base44.asServiceRole.sso.getAccessToken('user_123');
+     * console.log(response.access_token);
+     * ```
+     */
+    getAccessToken(userid: string): Promise<SsoAccessTokenResponse>;
+}

package/dist/modules/sso.types.js

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

package/dist/modules/types.d.ts

@@ -0,0 +1,4 @@
+export * from "./app.types.js";
+export * from "./agents.types.js";
+export * from "./connectors.types.js";
+export * from "./analytics.types.js";

package/dist/modules/types.js

@@ -0,0 +1,4 @@
+export * from "./app.types.js";
+export * from "./agents.types.js";
+export * from "./connectors.types.js";
+export * from "./analytics.types.js";

package/dist/modules/users.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from "axios";
+/**
+ * Creates the users module for the Base44 SDK
+ * @param {AxiosInstance} axios - Axios instance
+ * @param {string} appId - Application ID
+ * @returns {Object} Users module
+ */
+export declare function createUsersModule(axios: AxiosInstance, appId: string): {
+    /**
+     * Invite a user to the application
+     * @param {string} user_email - User's email address
+     * @param {'user'|'admin'} role - User's role (user or admin)
+     * @returns {Promise<any>}
+     */
+    inviteUser(user_email: string, role: "user" | "admin"): Promise<any>;
+};

package/dist/modules/users.js

@@ -0,0 +1,23 @@
+/**
+ * Creates the users module for the Base44 SDK
+ * @param {AxiosInstance} axios - Axios instance
+ * @param {string} appId - Application ID
+ * @returns {Object} Users module
+ */
+export function createUsersModule(axios, appId) {
+    return {
+        /**
+         * Invite a user to the application
+         * @param {string} user_email - User's email address
+         * @param {'user'|'admin'} role - User's role (user or admin)
+         * @returns {Promise<any>}
+         */
+        async inviteUser(user_email, role) {
+            if (role !== "user" && role !== "admin") {
+                throw new Error(`Invalid role: "${role}". Role must be either "user" or "admin".`);
+            }
+            const response = await axios.post(`/apps/${appId}/runtime/users/invite-user`, { user_email, role });
+            return response;
+        },
+    };
+}

package/dist/types.d.ts

@@ -0,0 +1,72 @@
+export * from "./modules/types.js";
+/**
+ * Parameters for filtering, sorting, and paginating agent model data.
+ *
+ * Used in the agents module for querying agent conversations. Provides a structured way to specify query criteria, sorting, pagination, and field selection.
+ *
+ * @property q - Query object with field-value pairs for filtering.
+ * @property sort - Sort parameter. For example, "-created_date" for descending order.
+ * @property sort_by - Alternative sort parameter. Use either `sort` or `sort_by`.
+ * @property limit - Maximum number of results to return.
+ * @property skip - Number of results to skip. Used for pagination.
+ * @property fields - Array of field names to include in the response.
+ *
+ * @example
+ * ```typescript
+ * // Filter conversations by agent name
+ * const conversations = await base44.agents.listConversations({
+ *   q: { agent_name: 'support-bot' }
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Filter conversations with sorting
+ * const conversations = await base44.agents.listConversations({
+ *   q: { status: 'active' },
+ *   sort: '-created_at'  // Sort by created_at descending
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Filter conversations with pagination
+ * const conversations = await base44.agents.listConversations({
+ *   q: { agent_name: 'support-bot' },
+ *   limit: 20,  // Get 20 results
+ *   skip: 40    // Skip first 40 (page 3)
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Filter conversations with field selection
+ * const conversations = await base44.agents.listConversations({
+ *   q: { status: 'active' },
+ *   fields: ['id', 'agent_name', 'created_at']
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Filter conversations with multiple filters
+ * const conversations = await base44.agents.listConversations({
+ *   q: {
+ *     agent_name: 'support-bot',
+ *     'metadata.priority': 'high',
+ *     status: 'active'
+ *   },
+ *   sort: '-updated_at',
+ *   limit: 50,
+ *   skip: 0
+ * });
+ * ```
+ */
+export interface ModelFilterParams {
+    q?: Record<string, any>;
+    sort?: string | null;
+    sort_by?: string | null;
+    limit?: number | null;
+    skip?: number | null;
+    fields?: string[] | null;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export * from "./modules/types.js";

package/dist/utils/auth-utils.d.ts

@@ -0,0 +1,117 @@
+import { GetAccessTokenOptions, SaveAccessTokenOptions, RemoveAccessTokenOptions, GetLoginUrlOptions } from "./auth-utils.types.js";
+/**
+ * Retrieves an access token from URL parameters or local storage.
+ *
+ * Low-level utility for manually retrieving tokens. In most cases, the Base44 client handles
+ * token management automatically. This function is useful for custom authentication flows or when you need direct access to stored tokens. Requires a browser environment and can't be used in the backend.
+ *
+ * @internal
+ *
+ * @param options - Configuration options for token retrieval.
+ * @returns The access token string if found, null otherwise.
+ *
+ * @example
+ * ```typescript
+ * // Get access token from URL or local storage
+ * const token = getAccessToken();
+ *
+ * if (token) {
+ *   console.log('User is authenticated');
+ * } else {
+ *   console.log('No token found, redirect to login');
+ * }
+ * ```
+ * @example
+ * ```typescript
+ * // Get access token from custom local storage key
+ * const token = getAccessToken({ storageKey: 'my_app_token' });
+ * ```
+ * @example
+ * ```typescript
+ * // Get access token from URL but don't save or remove it
+ * const token = getAccessToken({
+ *   saveToStorage: false,
+ *   removeFromUrl: false
+ * });
+ * ```
+ */
+export declare function getAccessToken(options?: GetAccessTokenOptions): string | null;
+/**
+ * Saves an access token to local storage.
+ *
+ * Low-level utility for manually saving tokens. In most cases, the Base44 client handles token management automatically. This function is useful for custom authentication flows or managing custom tokens. Requires a browser environment and can't be used in the backend.
+ *
+ * @internal
+ *
+ * @param token - The access token string to save.
+ * @param options - Configuration options for saving the token.
+ * @returns Returns`true` if the token was saved successfully, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * // Save access token after login
+ * const response = await base44.auth.loginViaEmailPassword(email, password);
+ * const success = saveAccessToken(response.access_token, {});
+ *
+ * if (success) {
+ *   console.log('User is now authenticated');
+ *   // Token is now available for future page loads
+ * }
+ * ```
+ * @example
+ * ```typescript
+ * // Save access token to local storage using custom key
+ * const success = saveAccessToken(token, {
+ *   storageKey: `my_custom_token_key`
+ * });
+ * ```
+ */
+export declare function saveAccessToken(token: string, options: SaveAccessTokenOptions): boolean;
+/**
+ * Removes the access token from local storage.
+ *
+ * Low-level utility for manually removing tokens from the browser's local storage. In most cases, the Base44 client handles token management automatically. For standard logout flows, use {@linkcode AuthModule.logout | base44.auth.logout()} instead, which handles token removal and redirects automatically. This function is useful for custom authentication flows or when you need to manually remove tokens. Requires a browser environment and can't be used in the backend.
+ *
+ * @internal
+ *
+ * @param options - Configuration options for token removal.
+ * @returns Returns `true` if the token was removed successfully, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * // Remove custom token key
+ * const success = removeAccessToken({
+ *   storageKey: 'my_custom_token_key'
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Standard logout flow with token removal and redirect
+ * base44.auth.logout('/login');
+ * ```
+ */
+export declare function removeAccessToken(options: RemoveAccessTokenOptions): boolean;
+/**
+ * Constructs the absolute URL for the login page with a redirect parameter.
+ *
+ * Low-level utility for building login URLs. For standard login redirects, use {@linkcode AuthModule.redirectToLogin | base44.auth.redirectToLogin()} instead, which handles this automatically. This function is useful when you need to construct login URLs without a client instance or for custom authentication flows.
+ *
+ * @internal
+ *
+ * @param nextUrl - The URL to redirect to after successful login.
+ * @param options - Configuration options.
+ * @returns The complete login URL with encoded redirect parameters.
+ *
+ * @example
+ * ```typescript
+ * // Redirect to login page
+ * const loginUrl = getLoginUrl('/dashboard', {
+ *   serverUrl: 'https://base44.app',
+ *   appId: 'my-app-123'
+ * });
+ * window.location.href = loginUrl;
+ * // User will be redirected back to /dashboard after login
+ * ```
+ */
+export declare function getLoginUrl(nextUrl: string, options: GetLoginUrlOptions): string;

package/dist/utils/auth-utils.js

@@ -0,0 +1,189 @@
+/**
+ * Retrieves an access token from URL parameters or local storage.
+ *
+ * Low-level utility for manually retrieving tokens. In most cases, the Base44 client handles
+ * token management automatically. This function is useful for custom authentication flows or when you need direct access to stored tokens. Requires a browser environment and can't be used in the backend.
+ *
+ * @internal
+ *
+ * @param options - Configuration options for token retrieval.
+ * @returns The access token string if found, null otherwise.
+ *
+ * @example
+ * ```typescript
+ * // Get access token from URL or local storage
+ * const token = getAccessToken();
+ *
+ * if (token) {
+ *   console.log('User is authenticated');
+ * } else {
+ *   console.log('No token found, redirect to login');
+ * }
+ * ```
+ * @example
+ * ```typescript
+ * // Get access token from custom local storage key
+ * const token = getAccessToken({ storageKey: 'my_app_token' });
+ * ```
+ * @example
+ * ```typescript
+ * // Get access token from URL but don't save or remove it
+ * const token = getAccessToken({
+ *   saveToStorage: false,
+ *   removeFromUrl: false
+ * });
+ * ```
+ */
+export function getAccessToken(options = {}) {
+    const { storageKey = "base44_access_token", paramName = "access_token", saveToStorage = true, removeFromUrl = true, } = options;
+    let token = null;
+    // Try to get token from URL parameters
+    if (typeof window !== "undefined" && window.location) {
+        try {
+            const urlParams = new URLSearchParams(window.location.search);
+            token = urlParams.get(paramName);
+            // If token found in URL
+            if (token) {
+                // Save token to local storage if requested
+                if (saveToStorage) {
+                    saveAccessToken(token, { storageKey });
+                }
+                // Remove token from URL for security if requested
+                if (removeFromUrl) {
+                    urlParams.delete(paramName);
+                    const newUrl = `${window.location.pathname}${urlParams.toString() ? `?${urlParams.toString()}` : ""}${window.location.hash}`;
+                    window.history.replaceState({}, document.title, newUrl);
+                }
+                return token;
+            }
+        }
+        catch (e) {
+            console.error("Error retrieving token from URL:", e);
+        }
+    }
+    // If no token in URL, try local storage
+    if (typeof window !== "undefined" && window.localStorage) {
+        try {
+            token = window.localStorage.getItem(storageKey);
+            return token;
+        }
+        catch (e) {
+            console.error("Error retrieving token from local storage:", e);
+        }
+    }
+    return null;
+}
+/**
+ * Saves an access token to local storage.
+ *
+ * Low-level utility for manually saving tokens. In most cases, the Base44 client handles token management automatically. This function is useful for custom authentication flows or managing custom tokens. Requires a browser environment and can't be used in the backend.
+ *
+ * @internal
+ *
+ * @param token - The access token string to save.
+ * @param options - Configuration options for saving the token.
+ * @returns Returns`true` if the token was saved successfully, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * // Save access token after login
+ * const response = await base44.auth.loginViaEmailPassword(email, password);
+ * const success = saveAccessToken(response.access_token, {});
+ *
+ * if (success) {
+ *   console.log('User is now authenticated');
+ *   // Token is now available for future page loads
+ * }
+ * ```
+ * @example
+ * ```typescript
+ * // Save access token to local storage using custom key
+ * const success = saveAccessToken(token, {
+ *   storageKey: `my_custom_token_key`
+ * });
+ * ```
+ */
+export function saveAccessToken(token, options) {
+    const { storageKey = "base44_access_token" } = options;
+    if (typeof window === "undefined" || !window.localStorage || !token) {
+        return false;
+    }
+    try {
+        window.localStorage.setItem(storageKey, token);
+        // Set "token" that is set by the built-in SDK of platform version 2
+        window.localStorage.setItem("token", token);
+        return true;
+    }
+    catch (e) {
+        console.error("Error saving token to local storage:", e);
+        return false;
+    }
+}
+/**
+ * Removes the access token from local storage.
+ *
+ * Low-level utility for manually removing tokens from the browser's local storage. In most cases, the Base44 client handles token management automatically. For standard logout flows, use {@linkcode AuthModule.logout | base44.auth.logout()} instead, which handles token removal and redirects automatically. This function is useful for custom authentication flows or when you need to manually remove tokens. Requires a browser environment and can't be used in the backend.
+ *
+ * @internal
+ *
+ * @param options - Configuration options for token removal.
+ * @returns Returns `true` if the token was removed successfully, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * // Remove custom token key
+ * const success = removeAccessToken({
+ *   storageKey: 'my_custom_token_key'
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Standard logout flow with token removal and redirect
+ * base44.auth.logout('/login');
+ * ```
+ */
+export function removeAccessToken(options) {
+    const { storageKey = "base44_access_token" } = options;
+    if (typeof window === "undefined" || !window.localStorage) {
+        return false;
+    }
+    try {
+        window.localStorage.removeItem(storageKey);
+        return true;
+    }
+    catch (e) {
+        console.error("Error removing token from local storage:", e);
+        return false;
+    }
+}
+/**
+ * Constructs the absolute URL for the login page with a redirect parameter.
+ *
+ * Low-level utility for building login URLs. For standard login redirects, use {@linkcode AuthModule.redirectToLogin | base44.auth.redirectToLogin()} instead, which handles this automatically. This function is useful when you need to construct login URLs without a client instance or for custom authentication flows.
+ *
+ * @internal
+ *
+ * @param nextUrl - The URL to redirect to after successful login.
+ * @param options - Configuration options.
+ * @returns The complete login URL with encoded redirect parameters.
+ *
+ * @example
+ * ```typescript
+ * // Redirect to login page
+ * const loginUrl = getLoginUrl('/dashboard', {
+ *   serverUrl: 'https://base44.app',
+ *   appId: 'my-app-123'
+ * });
+ * window.location.href = loginUrl;
+ * // User will be redirected back to /dashboard after login
+ * ```
+ */
+export function getLoginUrl(nextUrl, options) {
+    const { serverUrl, appId, loginPath = "/login" } = options;
+    if (!serverUrl || !appId) {
+        throw new Error("serverUrl and appId are required to construct login URL");
+    }
+    const encodedRedirectUrl = encodeURIComponent(nextUrl || (typeof window !== "undefined" ? window.location.href : ""));
+    return `${serverUrl}${loginPath}?from_url=${encodedRedirectUrl}&app_id=${appId}`;
+}

package/dist/utils/auth-utils.types.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Configuration options for retrieving an access token.
+ *
+ * @internal
+ *
+ * @example
+ * ```typescript
+ * // Get access token from URL or local storage using default options
+ * const token = getAccessToken();
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Get access token from custom local storage key
+ * const token = getAccessToken({ storageKey: 'my_app_token' });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Get token from URL but don't save or remove from URL
+ * const token = getAccessToken({
+ *   saveToStorage: false,
+ *   removeFromUrl: false
+ * });
+ * ```
+ */
+export interface GetAccessTokenOptions {
+    /**
+     * The key to use when storing or retrieving the token in local storage.
+     * @default 'base44_access_token'
+     */
+    storageKey?: string;
+    /**
+     * The URL parameter name to check for the access token.
+     * @default 'access_token'
+     */
+    paramName?: string;
+    /**
+     * Whether to save the token to local storage if found in the URL.
+     * @default true
+     */
+    saveToStorage?: boolean;
+    /**
+     * Whether to remove the token from the URL after retrieval for security.
+     * @default true
+     */
+    removeFromUrl?: boolean;
+}
+/**
+ * Configuration options for saving an access token.
+ *
+ * @internal
+ *
+ * @example
+ * ```typescript
+ * // Use default storage key
+ * saveAccessToken('my-token-123', {});
+ *
+ * // Use custom storage key
+ * saveAccessToken('my-token-123', { storageKey: 'my_app_token' });
+ * ```
+ */
+export interface SaveAccessTokenOptions {
+    /**
+     * The key to use when storing the token in local storage.
+     * @default 'base44_access_token'
+     */
+    storageKey?: string;
+}
+/**
+ * Configuration options for removing an access token.
+ *
+ * @internal
+ *
+ * @example
+ * ```typescript
+ * // Remove token from default storage key
+ * removeAccessToken({});
+ *
+ * // Remove token from custom storage key
+ * removeAccessToken({ storageKey: 'my_app_token' });
+ * ```
+ */
+export interface RemoveAccessTokenOptions {
+    /**
+     * The key to use when removing the token from local storage.
+     * @default 'base44_access_token'
+     */
+    storageKey?: string;
+}
+/**
+ * Configuration options for constructing a login URL.
+ *
+ * @internal
+ *
+ * @example
+ * ```typescript
+ * const loginUrl = getLoginUrl('/dashboard', {
+ *   serverUrl: 'https://base44.app',
+ *   appId: 'my-app-123'
+ * });
+ * // Returns: 'https://base44.app/login?from_url=%2Fdashboard&app_id=my-app-123'
+ *
+ * // Custom login path
+ * const loginUrl = getLoginUrl('/dashboard', {
+ *   serverUrl: 'https://base44.app',
+ *   appId: 'my-app-123',
+ *   loginPath: '/auth/login'
+ * });
+ * ```
+ */
+export interface GetLoginUrlOptions {
+    /**
+     * The base server URL (e.g., 'https://base44.app').
+     */
+    serverUrl: string;
+    /**
+     * The app ID.
+     */
+    appId: string;
+    /**
+     * The path to the login endpoint.
+     * @default '/login'
+     */
+    loginPath?: string;
+}
+/**
+ * Type definition for getAccessToken function.
+ * @internal
+ */
+export type GetAccessTokenFunction = (options?: GetAccessTokenOptions) => string | null;
+/**
+ * Type definition for saveAccessToken function.
+ * @internal
+ */
+export type SaveAccessTokenFunction = (token: string, options: SaveAccessTokenOptions) => boolean;
+/**
+ * Type definition for removeAccessToken function.
+ * @internal
+ */
+export type RemoveAccessTokenFunction = (options: RemoveAccessTokenOptions) => boolean;
+/**
+ * Type definition for getLoginUrl function.
+ * @internal
+ */
+export type GetLoginUrlFunction = (nextUrl: string, options: GetLoginUrlOptions) => string;

package/dist/utils/auth-utils.types.js

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