@codebit-programando-solucoes/codebit-web-antd 1.1.16 → 1.1.21

package/dist/components/CssTokenBridge.d.ts

@@ -40,10 +40,18 @@ import { FC } from 'react';
  *
  * **Font size tokens:**
  *
+ * - --antd-font-size-xxs: 8px (Micro text, accessibility disclaimers, disabled elements)
+ * - --antd-font-size-xs: 10px (Extra small text, fine print, legal disclaimers)
  * - --antd-font-size-sm: 12px (Small text, captions, labels)
  * - --antd-font-size: 14px (Base font size, body text)
  * - --antd-font-size-lg: 16px (Large text, emphasis)
  * - --antd-font-size-xl: 20px (Extra large text, subheadings)
+ * - --antd-font-size-xxl: 24px (Largest base text size for prominent content)
+ * - --antd-font-size-heading1: 38px (Primary heading - main page titles)
+ * - --antd-font-size-heading2: 30px (Secondary heading - section titles)
+ * - --antd-font-size-heading3: 24px (Tertiary heading - subsections)
+ * - --antd-font-size-heading4: 20px (Quaternary heading - component titles)
+ * - --antd-font-size-heading5: 16px (Quinary heading - labels and captions)
  *
  * **Line height tokens:**
  *
@@ -64,6 +72,7 @@ import { FC } from 'react';
  *
  * @example
  *     ```tsx
+ *
  *     // Place this component at the root level of your app
  *     function App() {
  *       return (
@@ -77,6 +86,7 @@ import { FC } from 'react';
  *
  * @example
  *     ```css
+ *
  *     // Use the exposed CSS variables in your stylesheets
  *     .my-component {
  *       background-color: var(--antd-color-bg-container);

package/dist/components/LoggedMainContainer.d.ts

@@ -12,16 +12,17 @@ export interface LoggedMainContainerProps {
  * Provides a responsive layout with:
  *
  * - Collapsible sidebar navigation (desktop) or drawer menu (mobile)
+ * - Optional secondary sidebar/drawer for additional content
  * - Dynamic theme switching (light/dark mode)
  * - Role-based menu filtering
  * - User logout functionality
  * - Application version display
  *
- * This component must be used within a CodebitConfigProvider context to access configuration such as menu items, user data, and theme settings.
+ * This component must be used within a `CodebitConfigProvider` and `CodebitThemeContext` context to access configuration such as menu items, user data, and theme settings.
  *
  * @param props - Component props
  * @returns JSX.Element - Logged container layout
- * @throws Error if used CodebitConfigProvider context
+ * @throws Error if used outside `CodebitConfigProvider` and `CodebitThemeContext` contexts
  */
 export function LoggedMainContainer(
     props: LoggedMainContainerProps,

package/dist/components/ThemeToggle.d.ts

@@ -1,11 +1,10 @@
-import * as React from 'react';
+import { JSX } from 'react';
 
 /**
  * Theme switcher component that toggles between light and dark modes.
  *
- * This component displays a switch with sun/moon icons and handles theme toggling based on the context. It can be used independently or integrated with a theme context.
- *
  * @returns JSX.Element - A Switch component with theme toggle functionality.
- * @throws Error if used outside CodebitConfigProvider context
+ * @throws Error If used outside `CodebitThemeContext` context
+ * @component
  */
-export const ThemeToggle: () => React.JSX.Element;
+export const ThemeToggle: () => JSX.Element;

package/dist/components/index.d.ts

@@ -4,4 +4,4 @@ export * from './ErrorRetry';
 export * from './ListCard';
 export * from './CssTokenBridge';
 export * from './TableContainer';
-export * from './FilterContainer.jsx';
+export * from './FilterContainer';

package/dist/contexts/CodebitConfigContext.d.ts

@@ -24,63 +24,63 @@ export interface LoggedUser {
     roles?: string[];
 }
 
-/** Context type for Codebit configuration */
-export interface CodebitConfigContextType {
-    /** Array of menu items */
-    menuItems: MenuItem[];
-    /** Current user object */
-    user: LoggedUser;
-    /** Logout handler */
-    onLogout: () => void | Promise<void>;
-    /** Function to toggle the theme */
-    toggleTheme: () => void;
-    /** Current dark mode state */
-    isDarkMode: boolean;
-    /** Application version */
-    version?: string;
-    /** Show version in menu */
-    showVersion?: boolean;
-    /** Internationalization instance */
-    i18n?: import('i18next').i18n;
-    /** Optional secondary sidebar content */
-    secondarySidebar?: React.ReactNode;
-    /** Width of the secondary sidebar */
-    secondarySidebarWidth?: number;
-}
+/** The configuration context for Codebit application, providing access to session and UI settings. */
+export const CodebitConfigContext: React.Context<CodebitConfigContextType | null>;
 
-/** Props for the CodebitConfigProvider component */
-export interface CodebitConfigProviderProps {
-    /** Child components */
-    children: React.ReactNode;
-    /** Menu items configuration */
-    menuItems: MenuItem[];
-    /** Current user object */
-    user: LoggedUser;
-    /** Logout handler */
-    onLogout: () => void | Promise<void>;
-    /** Application version. Default is '1.0' */
-    version?: string;
-    /** Show version in menu. Default is true */
-    showVersion?: boolean;
-    /** Optional secondary sidebar content */
-    secondarySidebar?: React.ReactNode;
-    /** Width of the secondary sidebar */
+/** Context type definition for Codebit configuration. */
+export interface CodebitConfigContextType {
+    /**
+     * A function that returns menu items configuration for the sidebar based on the current user's context. Takes an optional `LoggedUser` object as parameter and returns an array
+     * of `MenuItem` objects.
+     */
+    menuItems: (user?: LoggedUser) => MenuItem[];
+    /** Indicates if the user is currently logged in. */
+    isLogged: boolean;
+    /** The current user object, null when not logged in. */
+    user: LoggedUser | null;
+    /** Logs out the current user and resets session state. */
+    logout: () => Promise<void>;
+    /** Application version string. */
+    version: string;
+    /**
+     * A function that determines whether to display the application version in the UI based on user context. Takes an optional `LoggedUser` object as parameter and returns a
+     * boolean value.
+     */
+    showVersion: (user?: LoggedUser) => boolean;
+    /** A function that returns optional secondary sidebar content based on the current user's context. Takes an optional `LoggedUser` object as parameter and returns React nodes. */
+    secondarySidebar?: (user?: LoggedUser) => React.ReactNode | null;
+    /** Width of the secondary sidebar in pixels (default: 280). */
     secondarySidebarWidth?: number;
-    /** Controls theme persistence in localStorage. Default is `true` */
-    storeThemeInLocalStorage?: boolean;
 }
 
 /**
- * Configuration provider for Codebit components. Similar to Ant Design's ConfigProvider.
- *
- * Provides global configuration for theme, user data, menu items, and authentication settings to all child components within the provider tree.
+ * Provider component for Codebit configuration and session management.
  *
- * @param props - Component props
- * @returns JSX.Element - Provider wrapper
+ * @param props - Configuration provider properties.
  */
 export function CodebitConfigProvider(
     props: CodebitConfigProviderProps,
-): React.JSX.Element;
+): React.ReactElement;
 
-/** Context for Codebit configuration */
-export const CodebitConfigContext: React.Context<CodebitConfigContextType | null>;
+/** Properties for the CodebitConfigProvider component. */
+export interface CodebitConfigProviderProps {
+    /** Child components that will have access to the configuration context. */
+    children: React.ReactNode;
+    /**
+     * A function that returns menu items configuration for the sidebar based on the current user's context. Takes an optional `LoggedUser` object as parameter and returns an array
+     * of `MenuItem` objects.
+     */
+    menuItems: (user?: LoggedUser) => MenuItem[];
+    /** Application version string (default: '1.0'). */
+    version?: string;
+    /** A function that determines whether to display the application version based on user context. Takes an optional `LoggedUser` object as parameter and returns a boolean value. */
+    showVersion?: (user?: LoggedUser) => boolean;
+    /** A function that returns optional secondary sidebar content based on user context. Takes an optional `LoggedUser` object as parameter and returns React nodes. */
+    secondarySidebar?: (user: LoggedUser) => React.ReactNode | null;
+    /** Width of the secondary sidebar in pixels (default: 280). */
+    secondarySidebarWidth?: number;
+    /** Function to handle user logout. */
+    doLogout: () => Promise<void>;
+    /** Function to check login status and return user data. */
+    checkLogin: () => Promise<any | null>;
+}

package/dist/contexts/CodebitThemeContext.d.ts

@@ -0,0 +1,26 @@
+import * as React from 'react';
+import type { ConfigProviderProps } from 'antd';
+
+/** Context for managing theme state in Codebit applications. Provides theme toggling and current theme state to components. */
+export const CodebitThemeContext: React.Context<CodebitThemeContextProps | null>;
+
+/** Provider component that wraps the application to enable theme management. */
+export const CodebitThemeProvider: React.FC<CodebitThemeProviderProps>;
+
+/** Context value type containing theme state and controls */
+interface CodebitThemeContextProps {
+    /** Current theme state (`true` for dark mode) */
+    isDarkMode: boolean;
+    /** Toggles between dark and light themes */
+    toggleTheme: () => void;
+    /** Manually sets the theme state */
+    setIsDarkMode: (isDark: boolean) => void;
+}
+
+/** Properties for the theme provider component */
+type CodebitThemeProviderProps = {
+    /** Child components that will have access to theme context */
+    children: React.ReactNode;
+    /** Whether to persist theme preference in localStorage (default: `true`) */
+    storeThemeInLocalStorage?: boolean;
+} & ConfigProviderProps;

package/dist/contexts/index.d.ts

@@ -1 +1,2 @@
 export * from './CodebitConfigContext';
+export * from './CodebitThemeContext';

package/dist/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useErrorMessage';
+export * from './useErrorModal';

package/dist/hooks/useErrorMessage.d.ts

@@ -0,0 +1,46 @@
+import {
+    ApiError,
+    ApiNetworkError,
+} from '@codebit-programando-solucoes/codebit-web';
+
+/**
+ * Normalized status values used by UI components.
+ *
+ * - `'error'` – generic fallback status.
+ * - `403` – forbidden (often accompanied by a page‑reload action).
+ * - `404` – resource not found.
+ * - `500` – internal server error.
+ */
+export type ErrorStatus = 403 | 404 | 500 | 'error';
+
+/**
+ * Shape of the object returned by `getErrorMessage`.
+ *
+ * @property {string} errorMessage - Human‑readable description of the error.
+ * @property {ErrorStatus} status - Normalized status for UI handling.
+ * @property {string} retryText - Text displayed on the retry button.
+ * @property {(() => void) | null} onRetryAction - Callback invoked when the user clicks the retry button, or `null` when no action is required.
+ */
+export interface ErrorMessage {
+    errorMessage: string;
+    status: ErrorStatus;
+    retryText: string;
+    onRetryAction: (() => void) | null;
+}
+
+/**
+ * Accepted error types for `getErrorMessage`.
+ *
+ * - Standard JavaScript `Error`.
+ * - `ApiError` and `ApiNetworkError` exported from the Codebit Web package.
+ */
+export type AcceptedError = Error | ApiError | ApiNetworkError;
+
+/**
+ * Hook that returns a function to map an error object to an {@link ErrorMessage}.
+ *
+ * @returns {{ getErrorMessage: (error: AcceptedError) => ErrorMessage }}
+ */
+export function useErrorMessage(): {
+    getErrorMessage: (error: AcceptedError) => ErrorMessage;
+};

package/dist/hooks/useErrorModal.d.ts

@@ -0,0 +1,27 @@
+import { AcceptedError } from './useErrorMessage';
+
+/**
+ * Hook that provides a function to display an error modal using Ant Design's `App` modal API. The hook integrates with Sentry for error reporting and with the library's
+ * translation utilities.
+ *
+ * @returns An object containing the `showErrorModal` function.
+ */
+export declare function useErrorModal(): UseErrorModalReturn;
+
+/** Shape of the object returned by {@link useErrorModal}. */
+export interface UseErrorModalReturn {
+    /**
+     * Shows an error modal.
+     *
+     * @param error - The error to be displayed. It can be any object that extends the native `Error` type.
+     * @param title - Optional custom title for the modal. If omitted, a default translated title is used.
+     * @param closeButtonText - Optional custom text for the modal's close button.
+     * @param onClose - Optional callback executed when the modal is closed. If not provided, the retry action derived from the error message will be used.
+     */
+    showErrorModal(
+        error: AcceptedError,
+        title?: string,
+        closeButtonText?: string,
+        onClose?: () => void,
+    ): void;
+}