react-lgpd-consent 0.1.11 → 0.1.12

package/dist/{PreferencesModal-IHXZDNYT.js → PreferencesModal-IFKCHTF2.js}

@@ -1,6 +1,6 @@
 import {
   PreferencesModal
-} from "./chunk-LRMSFSP2.js";
+} from "./chunk-V54LZT2Q.js";
 export {
   PreferencesModal
 };

package/dist/{chunk-LRMSFSP2.js → chunk-V54LZT2Q.js}

@@ -55,12 +55,10 @@ var defaultConsentTheme = createTheme({
   palette: {
     primary: {
       main: "#1976d2",
-      // Azul institucional
       contrastText: "#ffffff"
     },
     secondary: {
       main: "#dc004e",
-      // Rosa/vermelho para ações importantes
       contrastText: "#ffffff"
     },
     background: {
@@ -84,7 +82,6 @@ var defaultConsentTheme = createTheme({
     button: {
       fontWeight: 500,
       textTransform: "none"
-      // Manter capitalização original
     }
   },
   components: {
@@ -123,7 +120,7 @@ var defaultConsentTheme = createTheme({
 // src/context/ConsentContext.tsx
 import { jsx, jsxs } from "react/jsx-runtime";
 var PreferencesModal = React.lazy(
-  () => import("./PreferencesModal-IHXZDNYT.js").then((m) => ({
+  () => import("./PreferencesModal-IFKCHTF2.js").then((m) => ({
     default: m.PreferencesModal
   }))
 );
@@ -371,7 +368,7 @@ function Branding({ variant, hidden = false }) {
         /* @__PURE__ */ jsx2(
           Link,
           {
-            href: "https://ledipo.eti.br",
+            href: "https://www.ledipo.eti.br",
             target: "_blank",
             rel: "noopener noreferrer",
             sx: (theme) => ({

package/dist/index.cjs

@@ -81,12 +81,10 @@ var init_theme = __esm({
       palette: {
         primary: {
           main: "#1976d2",
-          // Azul institucional
           contrastText: "#ffffff"
         },
         secondary: {
           main: "#dc004e",
-          // Rosa/vermelho para ações importantes
           contrastText: "#ffffff"
         },
         background: {
@@ -110,7 +108,6 @@ var init_theme = __esm({
         button: {
           fontWeight: 500,
           textTransform: "none"
-          // Manter capitalização original
         }
       },
       components: {
@@ -165,7 +162,7 @@ function Branding({ variant, hidden = false }) {
         /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
           import_Link.default,
           {
-            href: "https://ledipo.eti.br",
+            href: "https://www.ledipo.eti.br",
             target: "_blank",
             rel: "noopener noreferrer",
             sx: (theme) => ({
@@ -671,16 +668,16 @@ function CookieBanner({
 init_PreferencesModal();
 
 // src/components/FloatingPreferencesButton.tsx
+var import_CookieOutlined = __toESM(require("@mui/icons-material/CookieOutlined"), 1);
 var import_Fab = __toESM(require("@mui/material/Fab"), 1);
 var import_Tooltip = __toESM(require("@mui/material/Tooltip"), 1);
-var import_Settings = __toESM(require("@mui/icons-material/Settings"), 1);
 var import_styles3 = require("@mui/material/styles");
 init_useConsent();
 var import_jsx_runtime5 = require("react/jsx-runtime");
 function FloatingPreferencesButton({
   position = "bottom-right",
   offset = 24,
-  icon = /* @__PURE__ */ (0, import_jsx_runtime5.jsx)(import_Settings.default, {}),
+  icon = /* @__PURE__ */ (0, import_jsx_runtime5.jsx)(import_CookieOutlined.default, {}),
   tooltip,
   FabProps,
   hideWhenConsented = false
@@ -695,7 +692,6 @@ function FloatingPreferencesButton({
     const styles = {
       position: "fixed",
       zIndex: 1200
-      // Abaixo do modal mas acima do conteúdo
     };
     switch (position) {
       case "bottom-left":

package/dist/index.d.cts

@@ -6,6 +6,16 @@ import { FabProps } from '@mui/material/Fab';
 import * as React$1 from 'react';
 import * as _mui_material_styles from '@mui/material/styles';
 
+/**
+ * Props para o componente CookieBanner.
+ *
+ * @property policyLinkUrl URL da política de privacidade (opcional).
+ * @property debug Força exibição do banner para QA/debug (opcional).
+ * @property blocking Se true, bloqueia interação até decisão do usuário (default: true).
+ * @property hideBranding Se true, oculta o branding "fornecido por LÉdipO.eti.br" (opcional).
+ * @property SnackbarProps Props adicionais para o componente MUI Snackbar (opcional).
+ * @property PaperProps Props adicionais para o componente MUI Paper (opcional).
+ */
 interface CookieBannerProps {
     policyLinkUrl?: string;
     debug?: boolean;
@@ -14,29 +24,79 @@ interface CookieBannerProps {
     SnackbarProps?: Partial<SnackbarProps>;
     PaperProps?: Partial<PaperProps>;
 }
+/**
+ * Banner de consentimento de cookies conforme LGPD.
+ *
+ * Exibe mensagem informativa, botões de ação e link para política de privacidade.
+ * Compatível com modo bloqueante (overlay) e não bloqueante (Snackbar).
+ *
+ * - Textos em pt-BR, customizáveis via contexto.
+ * - Acessível e responsivo.
+ * - Branding opcional.
+ *
+ * @param props Propriedades do banner de consentimento.
+ */
 declare function CookieBanner({ policyLinkUrl, debug, blocking, // Por padrão, bloqueia até decisão
 hideBranding, SnackbarProps, PaperProps, }: Readonly<CookieBannerProps>): react_jsx_runtime.JSX.Element | null;
 
+/**
+ * Props para o componente PreferencesModal.
+ *
+ * @property DialogProps Props opcionais para customizar o Dialog do Material-UI.
+ * @property hideBranding Se true, oculta o branding "fornecido por LÉdipO.eti.br".
+ */
 interface PreferencesModalProps {
     DialogProps?: Partial<DialogProps>;
     hideBranding?: boolean;
 }
+/**
+ * Modal de preferências de cookies.
+ *
+ * Permite ao usuário ajustar suas preferências de consentimento para cookies analíticos e de marketing.
+ * Utiliza Material-UI Dialog, switches para cada categoria e textos customizáveis via contexto.
+ * Acessível, responsivo e compatível com SSR.
+ *
+ * @param props Props do modal, incluindo customização do Dialog e opção de ocultar branding.
+ */
 declare function PreferencesModal({ DialogProps, hideBranding, }: Readonly<PreferencesModalProps>): react_jsx_runtime.JSX.Element;
 
+/**
+ * Props para o componente FloatingPreferencesButton.
+ *
+ * Permite configurar posição, ícone, tooltip, e comportamento de exibição do botão flutuante
+ * para abrir o modal de preferências de cookies LGPD.
+ *
+ * Todos os campos são opcionais e possuem valores padrão.
+ */
 interface FloatingPreferencesButtonProps {
     /** Posição do botão flutuante. Padrão: 'bottom-right' */
     position?: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right';
     /** Offset da borda em pixels. Padrão: 24 */
     offset?: number;
-    /** Ícone customizado. Padrão: SettingsIcon */
+    /** Ícone customizado. Padrão: CookieOutlined */
     icon?: React.ReactNode;
-    /** Tooltip customizado */
+    /** Tooltip customizado exibido ao passar o mouse */
     tooltip?: string;
-    /** Props do Fab do MUI */
+    /** Props adicionais para o Fab do MUI */
     FabProps?: Partial<FabProps>;
     /** Se deve esconder quando consentimento já foi dado. Padrão: false */
     hideWhenConsented?: boolean;
 }
+/**
+ * Botão flutuante para abrir o modal de preferências de cookies.
+ *
+ * Permite ao usuário acessar rapidamente as configurações de consentimento LGPD.
+ * Pode ser posicionado em qualquer canto da tela e customizado via props.
+ *
+ * @param position Posição do botão na tela. Padrão: 'bottom-right'.
+ * @param offset Distância da borda em pixels. Padrão: 24.
+ * @param icon Ícone customizado para o botão. Padrão: CookieOutlined.
+ * @param tooltip Texto do tooltip exibido ao passar o mouse. Padrão: 'Gerenciar Preferências de Cookies'.
+ * @param FabProps Props adicionais para o componente Fab do MUI.
+ * @param hideWhenConsented Se verdadeiro, esconde o botão após consentimento. Padrão: false.
+ *
+ * @returns JSX.Element | null
+ */
 declare function FloatingPreferencesButton({ position, offset, icon, tooltip, FabProps, hideWhenConsented, }: Readonly<FloatingPreferencesButtonProps>): react_jsx_runtime.JSX.Element | null;
 
 /**
@@ -62,6 +122,25 @@ interface ConsentState {
 }
 /**
  * Textos utilizados na interface de consentimento.
+ *
+ * @remarks
+ * Esta interface define todos os textos exibidos na UI do banner e modal de consentimento.
+ * Os campos opcionais permitem adequação à ANPD e customização conforme necessidade do projeto.
+ *
+ * @property bannerMessage - Mensagem principal exibida no banner de consentimento.
+ * @property acceptAll - Texto do botão para aceitar todos os cookies.
+ * @property declineAll - Texto do botão para recusar todos os cookies.
+ * @property preferences - Texto do botão para abrir preferências.
+ * @property policyLink - (Opcional) Link para política de privacidade.
+ * @property modalTitle - Título do modal de preferências.
+ * @property modalIntro - Texto introdutório do modal.
+ * @property save - Texto do botão para salvar preferências.
+ * @property necessaryAlwaysOn - Texto explicativo para cookies necessários.
+ * @property controllerInfo - (Opcional) Informação sobre o controlador dos dados.
+ * @property dataTypes - (Opcional) Tipos de dados coletados.
+ * @property thirdPartySharing - (Opcional) Compartilhamento com terceiros.
+ * @property userRights - (Opcional) Direitos do titular dos dados.
+ * @property contactInfo - (Opcional) Informações de contato do DPO.
  */
 interface ConsentTexts {
     bannerMessage: string;
@@ -142,8 +221,44 @@ interface ConsentContextValue {
     resetConsent: () => void;
 }
 
+/**
+ * Provider principal do contexto de consentimento LGPD.
+ *
+ * Gerencia o estado global de consentimento de cookies, preferências do usuário,
+ * textos customizáveis e integração com SSR. Permite customização do modal de preferências,
+ * callbacks externos e opções de cookie.
+ *
+ * @param props Propriedades do ConsentProvider (ver ConsentProviderProps)
+ * @returns JSX.Element
+ *
+ * @example
+ * <ConsentProvider>
+ *   <App />
+ * </ConsentProvider>
+ */
 declare function ConsentProvider({ initialState, texts: textsProp, theme, PreferencesModalComponent, preferencesModalProps, disableAutomaticModal, hideBranding, onConsentGiven, onPreferencesSaved, cookie: cookieOpts, children, }: Readonly<ConsentProviderProps>): react_jsx_runtime.JSX.Element;
 
+/**
+ * Hook principal para acessar e manipular o estado de consentimento de cookies.
+ *
+ * Retorna o estado atual do consentimento, preferências do usuário e métodos para
+ * aceitar, recusar, modificar ou resetar consentimentos. Ideal para integração
+ * com componentes customizados ou lógica de negócio.
+ *
+ * @returns {ConsentContextValue} Estado e ações do consentimento.
+ *
+ * @example
+ * const {
+ *   consented,
+ *   preferences,
+ *   acceptAll,
+ *   rejectAll,
+ *   setPreference,
+ *   openPreferences,
+ *   closePreferences,
+ *   resetConsent,
+ * } = useConsent();
+ */
 declare function useConsent(): ConsentContextValue;
 /**
  * Hook para acessar textos customizados do ConsentProvider.
@@ -162,14 +277,27 @@ declare function ConsentGate(props: Readonly<{
 }>): react_jsx_runtime.JSX.Element | null;
 
 /**
- * Carrega um script dinamicamente após consentimento finalizado.
- * Aguarda que o usuário tome uma decisão definitiva (banner fechado ou preferências salvas).
+ * Carrega dinamicamente um script externo após o consentimento do usuário ser finalizado.
+ *
+ * Aguarda até que o usuário tome uma decisão definitiva (banner fechado ou preferências salvas)
+ * antes de inserir o script na página. Permite restringir o carregamento por categoria de consentimento.
+ *
+ * @param id - Identificador único do elemento script a ser criado.
+ * @param src - URL do script externo.
+ * @param category - Categoria de consentimento exigida para o script ('analytics', 'marketing' ou null).
+ * @param attrs - Atributos adicionais a serem aplicados ao elemento script.
+ * @returns Promise que resolve quando o script é carregado ou rejeita se o consentimento não for dado.
  */
 declare function loadScript(id: string, src: string, category?: 'analytics' | 'marketing' | null, attrs?: Record<string, string>): Promise<void>;
 
 /**
- * Tema padrão para os componentes de consentimento.
- * Baseado no design system da ANPD/governo brasileiro.
+ * Tema padrão utilizado pelos componentes de consentimento da biblioteca.
+ *
+ * Inclui configurações de cores, tipografia e estilos para componentes Material-UI,
+ * garantindo aparência consistente e acessível conforme guidelines LGPD.
+ *
+ * @remarks
+ * Pode ser sobrescrito via ThemeProvider externo se necessário.
  */
 declare const defaultConsentTheme: _mui_material_styles.Theme;
 

package/dist/index.d.ts

@@ -6,6 +6,16 @@ import { FabProps } from '@mui/material/Fab';
 import * as React$1 from 'react';
 import * as _mui_material_styles from '@mui/material/styles';
 
+/**
+ * Props para o componente CookieBanner.
+ *
+ * @property policyLinkUrl URL da política de privacidade (opcional).
+ * @property debug Força exibição do banner para QA/debug (opcional).
+ * @property blocking Se true, bloqueia interação até decisão do usuário (default: true).
+ * @property hideBranding Se true, oculta o branding "fornecido por LÉdipO.eti.br" (opcional).
+ * @property SnackbarProps Props adicionais para o componente MUI Snackbar (opcional).
+ * @property PaperProps Props adicionais para o componente MUI Paper (opcional).
+ */
 interface CookieBannerProps {
     policyLinkUrl?: string;
     debug?: boolean;
@@ -14,29 +24,79 @@ interface CookieBannerProps {
     SnackbarProps?: Partial<SnackbarProps>;
     PaperProps?: Partial<PaperProps>;
 }
+/**
+ * Banner de consentimento de cookies conforme LGPD.
+ *
+ * Exibe mensagem informativa, botões de ação e link para política de privacidade.
+ * Compatível com modo bloqueante (overlay) e não bloqueante (Snackbar).
+ *
+ * - Textos em pt-BR, customizáveis via contexto.
+ * - Acessível e responsivo.
+ * - Branding opcional.
+ *
+ * @param props Propriedades do banner de consentimento.
+ */
 declare function CookieBanner({ policyLinkUrl, debug, blocking, // Por padrão, bloqueia até decisão
 hideBranding, SnackbarProps, PaperProps, }: Readonly<CookieBannerProps>): react_jsx_runtime.JSX.Element | null;
 
+/**
+ * Props para o componente PreferencesModal.
+ *
+ * @property DialogProps Props opcionais para customizar o Dialog do Material-UI.
+ * @property hideBranding Se true, oculta o branding "fornecido por LÉdipO.eti.br".
+ */
 interface PreferencesModalProps {
     DialogProps?: Partial<DialogProps>;
     hideBranding?: boolean;
 }
+/**
+ * Modal de preferências de cookies.
+ *
+ * Permite ao usuário ajustar suas preferências de consentimento para cookies analíticos e de marketing.
+ * Utiliza Material-UI Dialog, switches para cada categoria e textos customizáveis via contexto.
+ * Acessível, responsivo e compatível com SSR.
+ *
+ * @param props Props do modal, incluindo customização do Dialog e opção de ocultar branding.
+ */
 declare function PreferencesModal({ DialogProps, hideBranding, }: Readonly<PreferencesModalProps>): react_jsx_runtime.JSX.Element;
 
+/**
+ * Props para o componente FloatingPreferencesButton.
+ *
+ * Permite configurar posição, ícone, tooltip, e comportamento de exibição do botão flutuante
+ * para abrir o modal de preferências de cookies LGPD.
+ *
+ * Todos os campos são opcionais e possuem valores padrão.
+ */
 interface FloatingPreferencesButtonProps {
     /** Posição do botão flutuante. Padrão: 'bottom-right' */
     position?: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right';
     /** Offset da borda em pixels. Padrão: 24 */
     offset?: number;
-    /** Ícone customizado. Padrão: SettingsIcon */
+    /** Ícone customizado. Padrão: CookieOutlined */
     icon?: React.ReactNode;
-    /** Tooltip customizado */
+    /** Tooltip customizado exibido ao passar o mouse */
     tooltip?: string;
-    /** Props do Fab do MUI */
+    /** Props adicionais para o Fab do MUI */
     FabProps?: Partial<FabProps>;
     /** Se deve esconder quando consentimento já foi dado. Padrão: false */
     hideWhenConsented?: boolean;
 }
+/**
+ * Botão flutuante para abrir o modal de preferências de cookies.
+ *
+ * Permite ao usuário acessar rapidamente as configurações de consentimento LGPD.
+ * Pode ser posicionado em qualquer canto da tela e customizado via props.
+ *
+ * @param position Posição do botão na tela. Padrão: 'bottom-right'.
+ * @param offset Distância da borda em pixels. Padrão: 24.
+ * @param icon Ícone customizado para o botão. Padrão: CookieOutlined.
+ * @param tooltip Texto do tooltip exibido ao passar o mouse. Padrão: 'Gerenciar Preferências de Cookies'.
+ * @param FabProps Props adicionais para o componente Fab do MUI.
+ * @param hideWhenConsented Se verdadeiro, esconde o botão após consentimento. Padrão: false.
+ *
+ * @returns JSX.Element | null
+ */
 declare function FloatingPreferencesButton({ position, offset, icon, tooltip, FabProps, hideWhenConsented, }: Readonly<FloatingPreferencesButtonProps>): react_jsx_runtime.JSX.Element | null;
 
 /**
@@ -62,6 +122,25 @@ interface ConsentState {
 }
 /**
  * Textos utilizados na interface de consentimento.
+ *
+ * @remarks
+ * Esta interface define todos os textos exibidos na UI do banner e modal de consentimento.
+ * Os campos opcionais permitem adequação à ANPD e customização conforme necessidade do projeto.
+ *
+ * @property bannerMessage - Mensagem principal exibida no banner de consentimento.
+ * @property acceptAll - Texto do botão para aceitar todos os cookies.
+ * @property declineAll - Texto do botão para recusar todos os cookies.
+ * @property preferences - Texto do botão para abrir preferências.
+ * @property policyLink - (Opcional) Link para política de privacidade.
+ * @property modalTitle - Título do modal de preferências.
+ * @property modalIntro - Texto introdutório do modal.
+ * @property save - Texto do botão para salvar preferências.
+ * @property necessaryAlwaysOn - Texto explicativo para cookies necessários.
+ * @property controllerInfo - (Opcional) Informação sobre o controlador dos dados.
+ * @property dataTypes - (Opcional) Tipos de dados coletados.
+ * @property thirdPartySharing - (Opcional) Compartilhamento com terceiros.
+ * @property userRights - (Opcional) Direitos do titular dos dados.
+ * @property contactInfo - (Opcional) Informações de contato do DPO.
  */
 interface ConsentTexts {
     bannerMessage: string;
@@ -142,8 +221,44 @@ interface ConsentContextValue {
     resetConsent: () => void;
 }
 
+/**
+ * Provider principal do contexto de consentimento LGPD.
+ *
+ * Gerencia o estado global de consentimento de cookies, preferências do usuário,
+ * textos customizáveis e integração com SSR. Permite customização do modal de preferências,
+ * callbacks externos e opções de cookie.
+ *
+ * @param props Propriedades do ConsentProvider (ver ConsentProviderProps)
+ * @returns JSX.Element
+ *
+ * @example
+ * <ConsentProvider>
+ *   <App />
+ * </ConsentProvider>
+ */
 declare function ConsentProvider({ initialState, texts: textsProp, theme, PreferencesModalComponent, preferencesModalProps, disableAutomaticModal, hideBranding, onConsentGiven, onPreferencesSaved, cookie: cookieOpts, children, }: Readonly<ConsentProviderProps>): react_jsx_runtime.JSX.Element;
 
+/**
+ * Hook principal para acessar e manipular o estado de consentimento de cookies.
+ *
+ * Retorna o estado atual do consentimento, preferências do usuário e métodos para
+ * aceitar, recusar, modificar ou resetar consentimentos. Ideal para integração
+ * com componentes customizados ou lógica de negócio.
+ *
+ * @returns {ConsentContextValue} Estado e ações do consentimento.
+ *
+ * @example
+ * const {
+ *   consented,
+ *   preferences,
+ *   acceptAll,
+ *   rejectAll,
+ *   setPreference,
+ *   openPreferences,
+ *   closePreferences,
+ *   resetConsent,
+ * } = useConsent();
+ */
 declare function useConsent(): ConsentContextValue;
 /**
  * Hook para acessar textos customizados do ConsentProvider.
@@ -162,14 +277,27 @@ declare function ConsentGate(props: Readonly<{
 }>): react_jsx_runtime.JSX.Element | null;
 
 /**
- * Carrega um script dinamicamente após consentimento finalizado.
- * Aguarda que o usuário tome uma decisão definitiva (banner fechado ou preferências salvas).
+ * Carrega dinamicamente um script externo após o consentimento do usuário ser finalizado.
+ *
+ * Aguarda até que o usuário tome uma decisão definitiva (banner fechado ou preferências salvas)
+ * antes de inserir o script na página. Permite restringir o carregamento por categoria de consentimento.
+ *
+ * @param id - Identificador único do elemento script a ser criado.
+ * @param src - URL do script externo.
+ * @param category - Categoria de consentimento exigida para o script ('analytics', 'marketing' ou null).
+ * @param attrs - Atributos adicionais a serem aplicados ao elemento script.
+ * @returns Promise que resolve quando o script é carregado ou rejeita se o consentimento não for dado.
  */
 declare function loadScript(id: string, src: string, category?: 'analytics' | 'marketing' | null, attrs?: Record<string, string>): Promise<void>;
 
 /**
- * Tema padrão para os componentes de consentimento.
- * Baseado no design system da ANPD/governo brasileiro.
+ * Tema padrão utilizado pelos componentes de consentimento da biblioteca.
+ *
+ * Inclui configurações de cores, tipografia e estilos para componentes Material-UI,
+ * garantindo aparência consistente e acessível conforme guidelines LGPD.
+ *
+ * @remarks
+ * Pode ser sobrescrito via ThemeProvider externo se necessário.
  */
 declare const defaultConsentTheme: _mui_material_styles.Theme;
 

package/dist/index.js

@@ -6,7 +6,7 @@ import {
   useConsent,
   useConsentHydration,
   useConsentTexts
-} from "./chunk-LRMSFSP2.js";
+} from "./chunk-V54LZT2Q.js";
 
 // src/components/CookieBanner.tsx
 import Button from "@mui/material/Button";
@@ -115,15 +115,15 @@ function CookieBanner({
 }
 
 // src/components/FloatingPreferencesButton.tsx
+import CookieOutlined from "@mui/icons-material/CookieOutlined";
 import Fab from "@mui/material/Fab";
 import Tooltip from "@mui/material/Tooltip";
-import SettingsIcon from "@mui/icons-material/Settings";
 import { useTheme } from "@mui/material/styles";
 import { jsx as jsx2 } from "react/jsx-runtime";
 function FloatingPreferencesButton({
   position = "bottom-right",
   offset = 24,
-  icon = /* @__PURE__ */ jsx2(SettingsIcon, {}),
+  icon = /* @__PURE__ */ jsx2(CookieOutlined, {}),
   tooltip,
   FabProps,
   hideWhenConsented = false
@@ -138,7 +138,6 @@ function FloatingPreferencesButton({
     const styles = {
       position: "fixed",
       zIndex: 1200
-      // Abaixo do modal mas acima do conteúdo
     };
     switch (position) {
       case "bottom-left":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-lgpd-consent",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "Biblioteca de consentimento de cookies (LGPD) para React e Next.js, com contexto, banner e modal personalizáveis usando MUI.",
   "keywords": [
     "lgpd",