@brokerize/elements 1.4.2 → 1.5.1

package/dist/bundle.d.ts

@@ -46,29 +46,96 @@ export declare type BrokerizeBaseConfig = {
     	saveDownloadedFile?: SaveDownloadedFile;
 };
 
+/**
+ * Represents a brokerize UI component instance.
+ * Provides methods to manage the component's lifecycle and appearance.
+ */
 export declare type BrokerizeElement = {
+    	/**
+     	 * The current theme applied to the component.
+     	 * Can be modified to dynamically change the component's styling.
+     	 */
     	theme: Theme;
+    	/**
+     	 * Destroys the component and cleans up all resources.
+     	 * Must be called when the component is no longer needed to prevent memory leaks.
+     	 */
     	destroy: () => void;
 };
 
 export declare type BrokerizeElements = {
+    	/**
+     	 * Creates the main brokerize component providing a complete trading interface.
+     	 * This is the primary entry point for full-featured trading applications.
+     	 */
     	createBrokerizeMain: (cfg: BrokerizeMainConfig) => BrokerizeMainElement;
+    	/**
+     	 * Creates an overview component for high-level portfolio and account information.
+     	 */
     	createOverview: (cfg: OverviewConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a broker list component for selecting and managing broker connections.
+     	 */
     	createBrokerList: (cfg: BrokerListConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a broker login form for authenticating with specific brokers.
+     	 */
     	createBrokerLoginForm: (cfg: BrokerLoginFormConfig) => BrokerizeElement;
+    	/**
+     	 * Creates an order form for placing new trading orders.
+     	 */
     	createOrderForm: (cfg: OrderFormConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a portfolio table displaying user's investment portfolios.
+     	 */
     	createPortfolioTable: (cfg: PortfolioTableConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a session TAN form for two-factor authentication during broker sessions.
+     	 */
     	createSessionTanForm: (cfg: SessionTanFormConfig) => BrokerizeElement;
+    	/**
+     	 * Creates an order table for viewing and managing trading orders.
+     	 */
     	createOrderTable: (cfg: OrderTableConfig) => BrokerizeElement;
+    	/**
+     	 * Creates an order receipt component for displaying order execution details.
+     	 */
     	createOrderReceipt: (cfg: OrderReceiptConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a positions table showing current portfolio positions.
+     	 */
     	createPositionsTable: (cfg: PositionsTableConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a change order form for modifying existing orders.
+     	 */
     	createChangeOrderForm: (cfg: ChangeOrderFormConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a cancel order form for cancelling pending orders.
+     	 */
     	createCancelOrderForm: (cfg: CancelOrderFormConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a sessions table for managing active broker sessions.
+     	 */
     	createSessionsTable: (cfg: SessionsTableConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a comprehensive portfolio view with integrated trading capabilities.
+     	 */
     	createPortfolioView: (cfg: PortfolioViewConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a modal host for displaying dialogs and modals.
+     	 */
     	createModalHost: (cfg: ModalHostConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a styling UI example component for theme development and testing.
+     	 */
     	createStylingUIExample: (cfg: StylingUIExampleConfig) => BrokerizeElement;
+    	/**
+     	 * Creates a loader component for displaying loading states.
+     	 */
     	createLoader: (cfg: LoaderConfig) => BrokerizeElement;
+    	/**
+     	 * Service for managing modal dialogs across the application.
+     	 */
     	modalService: ModalService;
     	/**
      	 * Configure global settings for Brokerize Elements. The global configuration is shared across all instances of Brokerize Elements.
@@ -97,6 +164,9 @@ export declare type BrokerizeElementsGlobalConfiguration = {
     	assetsPath?: string;
 };
 
+/**
+ * Variants for the brokerize loader component.
+ */
 export declare type BrokerizeLoaderVariant = 'brokerize' | 'spinner' | 'order' | 'loading';
 
 export declare type BrokerizeMainConfig = BrokerizeBaseConfig & {
@@ -113,7 +183,14 @@ export declare type BrokerizeMainConfig = BrokerizeBaseConfig & {
     	preferredExchangeId?: number;
 };
 
+/**
+ * Represents the main brokerize component with navigation capabilities.
+ * Extends BrokerizeElement with navigation functionality for complex trading interfaces.
+ */
 export declare type BrokerizeMainElement = BrokerizeElement & {
+    	/**
+     	 * Navigation object providing methods to navigate within the brokerize interface.
+     	 */
     	navigation: BrokerizeNavigation;
 };
 
@@ -165,15 +242,24 @@ export declare type BrokerizeRenderConfig = {
     	assetsPath?: string;
 };
 
-export declare type BrokerizeSummaryData = { title: string } & any;
-
 export declare type BrokerListConfig = {
+    	/**
+     	 * Callback triggered when user initiates login to a broker.
+     	 * @param data - Object containing the broker name.
+     	 */
     	onLogin: (data: { brokerName: string }) => void;
+    	/**
+     	 * Optional storage for user confirmations and agreements.
+     	 */
     	confirmationStorage?: ConfirmationStorage;
     	/** brokerize-internal */
     	disclaimerPrefixHtml?: string;
     	/** brokerize-internal */
     	infoPreamble?: string;
+    	/**
+     	 * Optional: pre-selected broker name to highlight or filter.
+     	 */
+    	brokerName?: string;
 } & BrokerizeBaseConfig;
 
 export declare type BrokerLoginFormConfig = {
@@ -185,6 +271,10 @@ export declare type BrokerLoginFormConfig = {
      	 */
     	env?: string;
 
+    	/**
+     	 * Callback triggered when user exits the login form.
+     	 * @param loggedIn - Whether the user successfully logged in.
+     	 */
     	onExit: (loggedIn: boolean) => void;
 
     	/**
@@ -211,8 +301,18 @@ export declare type BrokerLoginFormConfig = {
 } & BrokerizeBaseConfig;
 
 export declare type CancelOrderFormConfig = {
+    	/**
+     	 * ID of the order to be cancelled.
+     	 */
     	orderId: string;
+    	/**
+     	 * Callback triggered when user exits the cancel order form.
+     	 */
     	onExit: () => void;
+    	/**
+     	 * Callback for navigation events.
+     	 * @param linkTarget - The navigation target.
+     	 */
     	onNavigate: (linkTarget: LinkTarget) => void;
     	/**
      	 * Optional `reportingTag` to send with order creates. ReportingTags appear in order reports.
@@ -221,7 +321,13 @@ export declare type CancelOrderFormConfig = {
 } & BrokerizeBaseConfig;
 
 export declare type ChangeOrderFormConfig = {
+    	/**
+     	 * ID of the order to be changed.
+     	 */
     	orderId: string;
+    	/**
+     	 * Callback triggered when user exits the change order form.
+     	 */
     	onExit: () => void;
     	/**
      	 * Optional `reportingTag` to send with order creates. ReportingTags appear in order reports.
@@ -238,16 +344,41 @@ export { Client }
 export declare const cognitoFacade: Client.CognitoFacade;
 
 export declare type ConfirmationStorage = {
+    	/**
+     	 * Retrieves the acceptance entry for specific terms.
+     	 * @param termsId - Unique identifier for the terms.
+     	 * @returns The acceptance entry or null/undefined if not accepted.
+     	 */
     	getTermsAccepted(termsId: string): ConfirmItemAcceptanceEntry | null | undefined;
+    	/**
+     	 * Sets or removes the acceptance entry for specific terms.
+     	 * @param termsId - Unique identifier for the terms.
+     	 * @param entry - The acceptance entry to set, or null to remove.
+     	 */
     	setTermsAccepted(termsId: string, entry: ConfirmItemAcceptanceEntry | null);
 };
 
 export declare type ConfirmItemAcceptanceEntry = {
+    	/**
+     	 * Timestamp when the terms were accepted.
+     	 */
     	acceptedAt: number;
 };
 
 export declare type CredentialsStore = {
+    	/**
+     	 * Stores user credentials for a specific broker.
+     	 * @param displayLabel - Human-readable label for the stored credentials.
+     	 * @param brokerName - Name of the broker the credentials are for.
+     	 * @param value - The credential value to store (typically encrypted).
+     	 * @returns Promise that resolves when credentials are stored.
+     	 */
     	storeCredentials: (displayLabel: string, brokerName: string, value: string) => Promise<void>;
+    	/**
+     	 * Loads stored credentials for a specific broker.
+     	 * @param brokerName - Name of the broker to load credentials for.
+     	 * @returns Promise that resolves to the stored credential value or null if not found.
+     	 */
     	loadCredentials: (brokerName: string) => Promise<string | null>;
 };
 
@@ -369,8 +500,17 @@ export declare type DataCellValueString = {
  * headline title, a content text and a list of input boxes where users may enter data.
  */
 export declare type DialogConfig = {
+    	/**
+     	 * Optional title for the dialog.
+     	 */
     	title?: string;
+    	/**
+     	 * Optional content text for the dialog.
+     	 */
     	content?: string;
+    	/**
+     	 * List of input configurations for the dialog.
+     	 */
     	inputConfigs: InputConfig[];
 };
 
@@ -390,7 +530,13 @@ export declare type DialogResultCancel = { response: 'cancel' };
 export declare type DialogResultOk = { response: 'ok'; inputs: InputConfig[] };
 
 export declare type DownloadedFile = {
+    	/**
+     	 * The file blob to be saved.
+     	 */
     	blob: Blob;
+    	/**
+     	 * The filename for the downloaded file.
+     	 */
     	filename: string;
 };
 
@@ -400,15 +546,39 @@ export declare type DownloadedFile = {
  */
 export declare const Elements: BrokerizeElements;
 
+/**
+ * Array of header items defining table columns.
+ */
 export declare type Header = HeaderItem[];
 
 export declare type HeaderItem = {
+    	/**
+     	 * Unique identifier for the header column.
+     	 */
     	id: string;
+    	/**
+     	 * Display label for the header column.
+     	 */
     	label: string;
+    	/**
+     	 * Text alignment for the column ('left', 'right', or 'center').
+     	 */
     	align?: 'left' | 'right' | 'center';
+    	/**
+     	 * Width of the column (number in pixels or string with CSS units).
+     	 */
     	width?: number | string;
+    	/**
+     	 * Whether the column is sortable.
+     	 */
     	sortable?: boolean;
+    	/**
+     	 * Whether the column should be visually hidden.
+     	 */
     	visuallyHidden?: boolean;
+    	/**
+     	 * Default sort direction for the column.
+     	 */
     	defaultDirection?: OrderDirection;
 };
 
@@ -419,11 +589,29 @@ declare type Image_2 = {
 export { Image_2 as Image }
 
 export declare type InputConfig = {
+    	/**
+     	 * Optional unique identifier for the input field.
+     	 */
     	id?: string;
+    	/**
+     	 * Default value for the input field.
+     	 */
     	defaultValue?: string;
+    	/**
+     	 * Label text for the input field.
+     	 */
     	inputLabel: string;
+    	/**
+     	 * Placeholder text for the input field.
+     	 */
     	placeholder?: string;
+    	/**
+     	 * Whether the input field is required.
+     	 */
     	required?: boolean;
+    	/**
+     	 * Current value of the input field.
+     	 */
     	value?: string;
 };
 
@@ -434,40 +622,126 @@ export declare type LinkTarget = {
 };
 
 export declare type LoaderConfig = {
+    	/**
+     	 * Visual variant of the loader animation.
+     	 */
     	variant?: BrokerizeLoaderVariant;
+    	/**
+     	 * Text alignment for the loader.
+     	 */
     	alignment?: string;
+    	/**
+     	 * Whether to display the loader as an overlay.
+     	 */
     	overlay?: boolean;
+    	/**
+     	 * Whether the loader animation should repeat.
+     	 */
     	repeat?: boolean;
+    	/**
+     	 * Size of the loader in pixels.
+     	 */
     	size?: number;
 } & BrokerizeBaseConfig;
 
 export declare type LoginFormConfig = {
+    	/**
+     	 * Callback triggered when user chooses guest login.
+     	 */
     	onGuestLogin: () => void;
+    	/**
+     	 * The brokerize client instance for authentication.
+     	 */
     	client: Brokerize;
+    	/**
+     	 * Callback triggered when user successfully logs in.
+     	 * @param authCtxConfiguration - Authentication context configuration.
+     	 */
     	onLogin: (authCtxConfiguration: AuthContextConfiguration) => void;
 } & BrokerizeBaseConfig;
 
-export declare type ModalHostConfig = { showToast?: ShowToast } & BrokerizeBaseConfig;
+export declare type ModalHostConfig = {
+    	/**
+     	 * Optional function to display toast notifications.
+     	 */
+    	showToast?: ShowToast;
+} & BrokerizeBaseConfig;
 
+/**
+ * Service interface for managing modal dialogs and user interactions.
+ *
+ * The ModalService provides a centralized way to display various types of modal dialogs
+ * including security information, confirmation prompts, custom dialogs, and session TAN
+ * authentication modals. It supports activation/deactivation and method overriding for
+ * customization.
+ *
+ * @interface
+ */
 export declare interface ModalService {
+    	/**
+     	 * Shows security information in a modal dialog.
+     	 * @param title - The title of the security information dialog.
+     	 * @param content - The content to display in the dialog.
+     	 */
     	showSecurityInformation(title: string, content: string): void;
 
+    	/**
+     	 * Shows a confirmation dialog and returns a promise that resolves to the user's choice.
+     	 * @param msg - The confirmation message to display.
+     	 * @returns A promise that resolves to true if confirmed, false otherwise.
+     	 */
     	showConfirm(msg: string): Promise<boolean>;
 
+    	/**
+     	 * Shows a custom dialog based on the provided configuration.
+     	 * @param dialogConfig - Configuration for the dialog to display.
+     	 * @returns A promise that resolves with the dialog result.
+     	 */
     	showDialog(dialogConfig: DialogConfig): Promise<DialogResult>;
 
+    	/**
+     	 * Shows a session TAN modal for two-factor authentication.
+     	 * @param sessionId - The ID of the session requiring TAN input.
+     	 */
     	showSessionTanModal(sessionId: string): void;
 
+    	/**
+     	 * Activates the modal service for use.
+     	 */
     	activate(): void;
 
+    	/**
+     	 * Deactivates the modal service.
+     	 */
     	deactivate(): void;
 
+    	/**
+     	 * Overrides methods of the modal service with custom implementations.
+     	 * @param overrides - Partial object containing methods to override.
+     	 */
     	override(overrides: Partial<ModalService>): void;
 
+    	/**
+     	 * Shows an order receipt modal.
+     	 * @param data - The receipt data to display.
+     	 * @param showActions - Whether to show action buttons in the receipt.
+     	 * @param handleOrderTableAction - Callback for handling order table actions.
+     	 */
     	showReceipt(data: ReceiptData, showActions: boolean, handleOrderTableAction: (e: any) => void): void;
 
+    	/**
+     	 * Shows a detailed table modal.
+     	 * @param table - The generic table data to display.
+     	 */
     	showDetailedTable(table: Models.GenericTable): void;
 
+    	/**
+     	 * Shows position details in a modal.
+     	 * @param position - The position data to display.
+     	 * @param row - Optional table row data.
+     	 * @param header - Optional table header data.
+     	 * @param handleTableAction - Optional callback for table actions.
+     	 */
     	showPositionDetail(
     		position: Models.Position,
     		row?: TableRow,
@@ -475,13 +749,32 @@ export declare interface ModalService {
     		handleTableAction?: (actionId: string, rowId: string) => void
     	): void;
 
+    	/**
+     	 * Shows a login form modal for a specific broker.
+     	 * @param brokerName - The name of the broker.
+     	 * @param returnToUrl - The URL to return to after login.
+     	 * @param redirect - Optional callback for handling redirects.
+     	 */
     	showLoginForm(brokerName: any, returnToUrl: string, redirect: (redirecTo: string) => void): void;
 
+    	/**
+     	 * Shows a toast notification.
+     	 * @param opts - Options for the toast notification.
+     	 */
     	showToast(opts: ToastOptions): void;
 }
 
+/**
+ * Callback function for opening external links, allowing customization of link opening behavior.
+ * @param url - The URL to open.
+ * @param target - Optional target attribute for the link (e.g., '_blank').
+ * @param windowfeatures - Optional window features for new windows.
+ */
 export declare type openExternalLinkCallback = (url: string, target?: string, windowfeatures?: string) => void;
 
+/**
+ * Direction for table column sorting.
+ */
 export declare type OrderDirection = 'asc' | 'desc';
 
 export declare type OrderFlowParameters = {
@@ -504,6 +797,9 @@ export declare type OrderFlowParameters = {
 };
 
 export declare type OrderFormConfig = {
+    	/**
+     	 * ID of the portfolio to place the order in.
+     	 */
     	portfolioId: string;
     	/**
      	 * The ISIN to show the OrderForm.
@@ -589,34 +885,77 @@ export declare type OrderFormInitialOrder = Partial<
 >;
 
 export declare type OrderReceiptConfig = {
+    	/**
+     	 * Optional ID of the order for the receipt.
+     	 */
     	orderId?: string;
+    	/**
+     	 * Optional order data for the receipt.
+     	 */
     	orderData?: ReceiptData;
     	/**
      	 * `true` if the receipt is shown in response to an order creation.
      	 */
     	isOrderConfirmation?: boolean;
+    	/**
+     	 * Optional callback for navigation events.
+     	 * @param linkTarget - The navigation target.
+     	 */
     	onNavigate?: (linkTarget: LinkTarget) => void;
 } & BrokerizeBaseConfig;
 
 export declare type OrderTableConfig = {
+    	/**
+     	 * ID of the portfolio to display orders for.
+     	 */
     	portfolioId: string;
 
+    	/**
+     	 * Callback triggered when user wants to edit an order.
+     	 * @param params - Object containing the order ID.
+     	 */
     	onEditOrder: ({ orderId }: { orderId: string }) => void;
+    	/**
+     	 * Callback triggered when user wants to cancel an order.
+     	 * @param params - Object containing the order ID.
+     	 */
     	onCancelOrder: ({ orderId }: { orderId: string }) => void;
+    	/**
+     	 * Callback triggered when user wants to view order receipt.
+     	 * @param params - Object containing the order ID.
+     	 */
     	onShowReceipt: ({ orderId }: { orderId: string }) => void;
 } & BrokerizeBaseConfig;
 
 export declare type OverviewConfig = BrokerizeBaseConfig & {
+    	/**
+     	 * Callback triggered when user navigates to a specific portfolio.
+     	 * @param portfolio - The portfolio object the user navigated to.
+     	 */
     	onNavigate: (portfolio: Models.Portfolio) => void;
+    	/**
+     	 * Callback triggered when user initiates login to a broker.
+     	 * @param data - Object containing the broker name.
+     	 */
     	onLogin: (data: { brokerName: string }) => void;
 };
 
 export declare type PortfolioTableConfig = {
+    	/**
+     	 * If true, inactive portfolios will be hidden from the table.
+     	 */
     	hideInactivePortfolios?: boolean;
+    	/**
+     	 * Callback triggered when user navigates to a specific portfolio.
+     	 * @param portfolio - The portfolio object the user navigated to.
+     	 */
     	onNavigate: (portfolio: Models.Portfolio) => void;
 } & BrokerizeBaseConfig;
 
 export declare type PortfolioViewConfig = {
+    	/**
+     	 * ID of the portfolio to display.
+     	 */
     	portfolioId: string;
     	/**
      	 * Set this to `true` to allow users select a different portfolio inside the widget.
@@ -627,24 +966,62 @@ export declare type PortfolioViewConfig = {
      	 * Only available if allowChangePortfolio is true.
      	 */
     	onAddBrokerLogin?: () => void;
+    	/**
+     	 * Callback for buy orders.
+     	 * @param opts - Object containing security, ISIN, and optional available size.
+     	 */
     	onBuy: (opts: { security: Models.Security; isin: string; availableSize?: number }) => void;
+    	/**
+     	 * Callback for sell orders.
+     	 * @param opts - Object containing security, ISIN, and available size.
+     	 */
     	onSell: (opts: { security: Models.Security; isin: string; availableSize: number }) => void;
+    	/**
+     	 * Callback for cancelling orders.
+     	 * @param opts - Object containing the order ID.
+     	 */
     	onCancelOrder: (opts: { orderId: string }) => void;
+    	/**
+     	 * Callback for changing orders.
+     	 * @param opts - Object containing the order ID.
+     	 */
     	onChangeOrder: (opts: { orderId: string }) => void;
+    	/**
+     	 * Callback for showing order receipts.
+     	 * @param opts - Object containing the order ID.
+     	 */
     	onShowReceipt: (opts: { orderId: string }) => void;
 } & BrokerizeBaseConfig;
 
 export declare type PositionsTableConfig = {
+    	/**
+     	 * ID of the portfolio to display positions for.
+     	 */
     	portfolioId: string;
 
+    	/**
+     	 * Callback triggered when user wants to trade an instrument.
+     	 * @param opts - Object containing security, ISIN, and trade direction.
+     	 */
     	onTradeInstrument: (opts: { security: Models.Security; isin: string; direction: Models.Direction }) => void;
 } & BrokerizeBaseConfig;
 
 export declare type ReceiptData = {
+    	/**
+     	 * The order data for the receipt.
+     	 */
     	order: Models.Order;
+    	/**
+     	 * The portfolio data for the receipt.
+     	 */
     	portfolio: Models.Portfolio;
 };
 
+/**
+ * Callback function to save a downloaded file.
+ * @param download - The downloaded file to save.
+ * @returns A promise that resolves when the file is saved.
+ */
 export declare type SaveDownloadedFile = (download: DownloadedFile) => Promise<void>;
 
 export declare type SecurityQuote = {
@@ -695,6 +1072,9 @@ export declare type SecurityQuoteSubscription = { unsubscribe: () => void };
 export declare type SessionsTableConfig = BrokerizeBaseConfig;
 
 export declare type SessionTanFormConfig = {
+    	/**
+     	 * ID of the session requiring TAN authentication.
+     	 */
     	sessionId: string;
     	/**
      	 * Called when the SessionTanForm is ended.
@@ -704,27 +1084,58 @@ export declare type SessionTanFormConfig = {
     	onExit: (details: { enabled: boolean }) => void;
 } & BrokerizeBaseConfig;
 
+/**
+ * Callback function to display a toast notification.
+ * @param opts - Options for the toast notification.
+ */
 export declare type ShowToast = (opts: ToastOptions) => void;
 
 export declare type StylingUIExampleConfig = {
+    	/**
+     	 * Theme configuration for the styling example.
+     	 */
     	theme: Theme;
+    	/**
+     	 * DOM element where the styling example should be rendered.
+     	 */
     	renderTo: HTMLElement;
 };
 
 export declare type SupportLink = {
+    	/**
+     	 * Email subject line for support requests.
+     	 */
     	emailSubject: string;
 };
 
+/**
+ * Array of table rows representing the data for a table.
+ */
 export declare type TableData = TableRow[];
 
 export declare type TableOrder = {
+    	/**
+     	 * Field name to sort by.
+     	 */
     	field: string;
+    	/**
+     	 * Sort direction ('asc' or 'desc').
+     	 */
     	direction: OrderDirection;
 };
 
 export declare type TableRow = {
+    	/**
+     	 * Unique identifier for the table row.
+     	 */
     	id: string;
+    	/**
+     	 * Map of column IDs to cell values.
+     	 */
     	map: Record<string, DataCellValue>;
+    	/**
+     	 * Whether the row should be displayed with reduced opacity.
+     	 */
     	showFaded?: boolean;
 };
 
@@ -734,11 +1145,25 @@ export declare type TableRowAction = {
 };
 
 export declare type Theme = {
+    	/**
+     	 * Layout mode for the theme ('block' or 'columns').
+     	 */
     	layout: 'block' | 'columns';
+    	/**
+     	 * CSS custom property tokens for styling.
+     	 */
     	tokens: ThemeTokens;
+    	/**
+     	 * Logo style variant ('dark' or 'light').
+     	 */
     	logoStyle: 'dark' | 'light';
 };
 
+/**
+ * Theme tokens define CSS custom properties for styling brokerize elements.
+ * These tokens control colors, spacing, typography, and other visual aspects.
+ * All properties are optional and will fall back to default values if not provided.
+ */
 export declare type ThemeTokens = {
     	'zl-app-background-color'?: string;
     	'zl-app-background-image'?: string;
@@ -1172,7 +1597,13 @@ export declare type ThemeTokens = {
 };
 
 declare type ToastOptions = {
+    	/**
+     	 * The message to display in the toast notification.
+     	 */
     	message: string;
+    	/**
+     	 * The style of the toast: info, error, or success.
+     	 */
     	style: 'info' | 'error' | 'success';
 };