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

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/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;
+}

package/dist/index.cjs

@@ -297,12 +297,14 @@ var __webpack_exports__ = {};
         LoggedMainContainer: ()=>LoggedMainContainer,
         Login: ()=>Login,
         CodebitThemeProvider: ()=>CodebitThemeProvider,
+        useErrorModal: ()=>useErrorModal,
         ErrorRetry: ()=>ErrorRetry,
         CodebitThemeContext: ()=>CodebitThemeContext,
         CodebitConfigContext: ()=>CodebitConfigContext,
         ListCard: ()=>ListCard,
         ForgotPassword: ()=>ForgotPassword,
         LoginContainer: ()=>LoginContainer,
+        useErrorMessage: ()=>useErrorMessage,
         LocalLoginRecoveryPasswordResult: ()=>LocalLoginRecoveryPasswordResult,
         FilterContainer: ()=>FilterContainer,
         HandleError: ()=>HandleError,
@@ -424,7 +426,8 @@ var __webpack_exports__ = {};
                 genericMessage: 'Ocorreu um erro inesperado.',
                 backHome: 'Voltar para página inicial'
             },
-            ErrorRetry: {
+            Error: {
+                errorTitle: 'Erro',
                 defaultError: 'Erro ao carregar',
                 retryButton: 'Tentar novamente',
                 reloadPageButton: 'Recarregar página',
@@ -525,7 +528,8 @@ var __webpack_exports__ = {};
                 genericMessage: 'An unexpected error occurred.',
                 backHome: 'Back to home'
             },
-            ErrorRetry: {
+            Error: {
+                errorTitle: 'Error',
                 defaultError: 'Failed to load',
                 retryButton: 'Try again',
                 reloadPageButton: 'Reload page',
@@ -628,53 +632,69 @@ var __webpack_exports__ = {};
     const useCodebitWebAntdTranslation = ()=>(0, external_react_i18next_namespaceObject.useTranslation)('codebitWebAntd', {
             i18n: i18n
         });
+    function useErrorMessage() {
+        const { t } = useCodebitWebAntdTranslation();
+        const getErrorMessage = (error)=>{
+            let status = 'error';
+            const responseStatus = error?.response?.status || null;
+            let errorMessage = t('Error.defaultError');
+            let retryText = t('Error.retryButton');
+            let onRetryAction = null;
+            if (error?.errorCode) switch(error.errorCode){
+                case codebit_web_namespaceObject.ErrorCode.ERR_NETWORK:
+                    errorMessage = t('Error.networkError');
+                    break;
+                case codebit_web_namespaceObject.ErrorCode.ERR_TIMEOUT:
+                    errorMessage = t('Error.timeoutError');
+                    break;
+            }
+            else if (responseStatus) switch(responseStatus){
+                case 400:
+                    errorMessage = t('Error.badRequestError');
+                    break;
+                case 403:
+                    errorMessage = t('Error.forbiddenError');
+                    retryText = t('Error.reloadPageButton');
+                    status = 403;
+                    onRetryAction = ()=>{
+                        globalThis.location.reload();
+                    };
+                    break;
+                case 404:
+                    errorMessage = t('Error.notFoundError');
+                    status = 404;
+                    break;
+                case 500:
+                    errorMessage = t('Error.internalServerError');
+                    status = 500;
+                    break;
+                case 401:
+                    errorMessage = t('Error.sessionExpiredError');
+                    retryText = t('Error.reloadPageButton');
+                    onRetryAction = ()=>{
+                        globalThis.location.reload();
+                    };
+                    break;
+            }
+            return {
+                errorMessage,
+                status,
+                retryText,
+                onRetryAction
+            };
+        };
+        return {
+            getErrorMessage
+        };
+    }
     const ErrorRetry_logger = new codebit_web_namespaceObject.Logger('ErrorRetry');
     function ErrorRetry({ error, onRetry }) {
-        const { t } = useCodebitWebAntdTranslation();
         if (error && error instanceof Error) {
             ErrorRetry_logger.error('Fail to load.', error);
             react_namespaceObject.captureException(error);
         }
-        const responseStatus = error?.response?.status || null;
-        let errorMessage = t('ErrorRetry.defaultError');
-        let retryText = t('ErrorRetry.retryButton');
-        let status = 'error';
-        if (error?.errorCode) switch(error.errorCode){
-            case codebit_web_namespaceObject.ErrorCode.ERR_NETWORK:
-                errorMessage = t('ErrorRetry.networkError');
-                break;
-            case codebit_web_namespaceObject.ErrorCode.ERR_TIMEOUT:
-                errorMessage = t('ErrorRetry.timeoutError');
-                break;
-        }
-        else if (responseStatus) switch(responseStatus){
-            case 400:
-                errorMessage = t('ErrorRetry.badRequestError');
-                break;
-            case 403:
-                errorMessage = t('ErrorRetry.forbiddenError');
-                retryText = t('ErrorRetry.reloadPageButton');
-                onRetry = ()=>{
-                    globalThis.location.reload();
-                };
-                status = 403;
-                break;
-            case 404:
-                errorMessage = t('ErrorRetry.notFoundError');
-                status = 404;
-                break;
-            case 500:
-                errorMessage = t('ErrorRetry.internalServerError');
-                status = 500;
-                break;
-            case 401:
-                errorMessage = t('ErrorRetry.sessionExpiredError');
-                retryText = t('ErrorRetry.reloadPageButton');
-                onRetry = ()=>{
-                    globalThis.location.reload();
-                };
-                break;
-        }
+        const { getErrorMessage } = useErrorMessage();
+        const { status, errorMessage, retryText, onRetryAction } = getErrorMessage(error);
         return /*#__PURE__*/ (0, jsx_runtime.jsx)(external_antd_namespaceObject.Card, {
             children: /*#__PURE__*/ (0, jsx_runtime.jsx)(external_antd_namespaceObject.Result, {
                 status: status,
@@ -682,7 +702,7 @@ var __webpack_exports__ = {};
                 extra: [
                     /*#__PURE__*/ (0, jsx_runtime.jsx)(external_antd_namespaceObject.Button, {
                         type: 'primary',
-                        onClick: onRetry,
+                        onClick: onRetryAction ?? onRetry,
                         icon: /*#__PURE__*/ (0, jsx_runtime.jsx)(icons_namespaceObject.ReloadOutlined, {}),
                         children: retryText
                     }, 'retry')
@@ -1679,6 +1699,33 @@ var __webpack_exports__ = {};
         navigateToLogin: external_prop_types_default().func,
         submitRecoveryPassword: external_prop_types_default().func.isRequired
     };
+    const useErrorModal_logger = new codebit_web_namespaceObject.Logger('useErrorModal');
+    function useErrorModal() {
+        const { modal } = external_antd_namespaceObject.App.useApp();
+        const { getErrorMessage } = useErrorMessage();
+        const { t } = useCodebitWebAntdTranslation();
+        const showErrorModal = (error, title, closeButtonText, onClose)=>{
+            if (error && error instanceof Error) {
+                useErrorModal_logger.error('Fail to load.', error);
+                react_namespaceObject.captureException(error);
+            }
+            const { errorMessage, retryText, onRetryAction } = getErrorMessage(error);
+            if (error && error instanceof Error) {
+                useErrorModal_logger.error(error);
+                react_namespaceObject.captureException(error);
+            }
+            onClose = onClose ?? onRetryAction;
+            modal.error({
+                title: title || t('Error.errorTitle'),
+                content: errorMessage + '.',
+                afterClose: onClose,
+                okText: closeButtonText || (onClose ? retryText : t('Common.close'))
+            });
+        };
+        return {
+            showErrorModal
+        };
+    }
 })();
 exports.CodebitConfigContext = __webpack_exports__.CodebitConfigContext;
 exports.CodebitConfigProvider = __webpack_exports__.CodebitConfigProvider;
@@ -1697,6 +1744,8 @@ exports.Login = __webpack_exports__.Login;
 exports.LoginContainer = __webpack_exports__.LoginContainer;
 exports.TableContainer = __webpack_exports__.TableContainer;
 exports.ThemeToggle = __webpack_exports__.ThemeToggle;
+exports.useErrorMessage = __webpack_exports__.useErrorMessage;
+exports.useErrorModal = __webpack_exports__.useErrorModal;
 for(var __rspack_i in __webpack_exports__)if (-1 === [
     "CodebitConfigContext",
     "CodebitConfigProvider",
@@ -1714,7 +1763,9 @@ for(var __rspack_i in __webpack_exports__)if (-1 === [
     "Login",
     "LoginContainer",
     "TableContainer",
-    "ThemeToggle"
+    "ThemeToggle",
+    "useErrorMessage",
+    "useErrorModal"
 ].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {
     value: true

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './components/index';
 export * from './contexts/index';
 export * from './public-pages/index';
+export * from './hooks';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codebit-programando-solucoes/codebit-web-antd",
-  "version": "1.1.20",
+  "version": "1.1.21",
   "main": "./dist/index.cjs",
   "type": "module",
   "types": "./src/index.d.ts",