react-lgpd-consent 0.2.2 → 0.2.4

package/dist/index.d.ts

@@ -284,41 +284,198 @@ interface ConsentCookieOptions {
     path: string;
 }
 /**
- * Propriedades aceitas pelo componente ConsentProvider.
+ * Propriedades do componente ConsentProvider - configuração principal da biblioteca.
+ *
+ * @example Uso básico (configuração mínima):
+ * ```tsx
+ * <ConsentProvider
+ *   categories={{ enabledCategories: ['analytics'] }}
+ * >
+ *   <App />
+ * </ConsentProvider>
+ * ```
+ *
+ * @example Configuração completa com textos ANPD:
+ * ```tsx
+ * <ConsentProvider
+ *   categories={{
+ *     enabledCategories: ['analytics', 'functional'],
+ *     customCategories: [{
+ *       id: 'governo',
+ *       name: 'Cookies Governamentais',
+ *       description: 'Coleta para estatísticas públicas',
+ *       essential: false
+ *     }]
+ *   }}
+ *   texts={{
+ *     bannerMessage: 'Utilizamos cookies conforme LGPD...',
+ *     controllerInfo: 'Controlado por: Ministério XYZ - CNPJ: 00.000.000/0001-00',
+ *     dataTypes: 'Coletamos: dados de navegação para análise estatística',
+ *     userRights: 'Direitos: acessar, corrigir, excluir dados',
+ *     contactInfo: 'DPO: dpo@ministerio.gov.br'
+ *   }}
+ *   onConsentGiven={(state) => console.log('Consentimento:', state)}
+ * >
+ *   <App />
+ * </ConsentProvider>
+ * ```
  */
 interface ConsentProviderProps {
-    /** Estado inicial do consentimento (para SSR). */
+    /**
+     * Estado inicial do consentimento para hidratação SSR.
+     *
+     * @example
+     * ```tsx
+     * // Em Next.js para evitar flash do banner
+     * <ConsentProvider initialState={{ consented: true, preferences: {...} }}>
+     * ```
+     */
     initialState?: ConsentState;
-    /** Configuração de categorias ativas no projeto. */
+    /**
+     * Configuração das categorias de cookies utilizadas no projeto.
+     * Define quais categorias padrão serão habilitadas e categorias customizadas.
+     *
+     * @example Apenas analytics:
+     * ```tsx
+     * categories={{ enabledCategories: ['analytics'] }}
+     * ```
+     *
+     * @example Com categoria customizada:
+     * ```tsx
+     * categories={{
+     *   enabledCategories: ['analytics', 'marketing'],
+     *   customCategories: [{
+     *     id: 'pesquisa',
+     *     name: 'Cookies de Pesquisa',
+     *     description: 'Coleta feedback e opinião dos usuários',
+     *     essential: false
+     *   }]
+     * }}
+     * ```
+     */
     categories?: ProjectCategoriesConfig;
-    /** Textos customizados para a interface. */
+    /**
+     * Textos customizados da interface (banner e modal).
+     * Todos os campos são opcionais - valores não fornecidos usam o padrão em português.
+     *
+     * @example Textos básicos:
+     * ```tsx
+     * texts={{
+     *   bannerMessage: 'We use cookies...',
+     *   acceptAll: 'Accept All',
+     *   declineAll: 'Reject'
+     * }}
+     * ```
+     *
+     * @example Textos ANPD para compliance:
+     * ```tsx
+     * texts={{
+     *   controllerInfo: 'Controlado por: Empresa XYZ - CNPJ: 12.345.678/0001-90',
+     *   dataTypes: 'Coletamos: endereço IP, preferências de navegação',
+     *   userRights: 'Você pode solicitar acesso, correção ou exclusão dos dados'
+     * }}
+     * ```
+     */
     texts?: Partial<ConsentTexts>;
-    /** Tema customizado para os componentes MUI. Aceita qualquer propriedade. */
+    /**
+     * Tema customizado Material-UI aplicado aos componentes.
+     * Aceita qualquer objeto que será passado para ThemeProvider.
+     *
+     * @example
+     * ```tsx
+     * theme={{
+     *   palette: { primary: { main: '#1976d2' } },
+     *   components: { MuiButton: { styleOverrides: { root: { borderRadius: 8 } } } }
+     * }}
+     * ```
+     */
     theme?: any;
     /**
-     * @deprecated Use `categories.customCategories` em vez disso.
-     * Categorias customizadas de cookies (complementa as padrão).
+     * @deprecated Usar `categories.customCategories` em vez disso.
+     * Mantido para compatibilidade com v0.1.x
      */
     customCategories?: CategoryDefinition[];
-    /** Integrações nativas de scripts (Google Analytics, etc.). */
+    /**
+     * Integrações nativas de scripts terceiros (Google Analytics, etc.).
+     * Scripts são carregados automaticamente baseado no consentimento.
+     *
+     * @example
+     * ```tsx
+     * import { createGoogleAnalyticsIntegration } from 'react-lgpd-consent'
+     *
+     * scriptIntegrations={[
+     *   createGoogleAnalyticsIntegration('GA_MEASUREMENT_ID')
+     * ]}
+     * ```
+     */
     scriptIntegrations?: ScriptIntegration[];
-    /** Componente customizado para modal de preferências. */
+    /**
+     * Componente customizado para substituir o modal padrão de preferências.
+     * Deve implementar a lógica de consentimento usando os hooks da biblioteca.
+     */
     PreferencesModalComponent?: React.ComponentType<any>;
-    /** Props adicionais para o modal customizado. */
+    /** Props adicionais passadas para o modal customizado. */
     preferencesModalProps?: Record<string, any>;
-    /** Desabilita o modal automático (para usar componente totalmente customizado). */
+    /**
+     * Desabilita o modal automático de preferências.
+     * Útil quando se quer controle total sobre quando/como exibir as opções.
+     */
     disableAutomaticModal?: boolean;
-    /** Comportamento do banner: true = bloqueia até decisão, false = não bloqueia */
+    /**
+     * Comportamento do banner de consentimento:
+     * - `false` (padrão): Banner não-intrusivo, usuário pode navegar livremente
+     * - `true`: Banner bloqueia interação até decisão (compliance rigorosa)
+     */
     blocking?: boolean;
-    /** Esconde branding "fornecido por LÉdipO.eti.br". */
+    /** Oculta o branding "fornecido por LÉdipO.eti.br" dos componentes. */
     hideBranding?: boolean;
-    /** Callback chamado quando o consentimento é dado. */
+    /**
+     * Callback executado quando usuário dá consentimento pela primeira vez.
+     * Útil para inicializar analytics, registrar evento, etc.
+     *
+     * @example
+     * ```tsx
+     * onConsentGiven={(state) => {
+     *   console.log('Consentimento registrado:', state)
+     *   // Inicializar Google Analytics, etc.
+     * }}
+     * ```
+     */
     onConsentGiven?: (state: ConsentState) => void;
-    /** Callback chamado ao salvar preferências. */
+    /**
+     * Callback executado quando usuário modifica preferências.
+     * Executado após salvar as mudanças.
+     *
+     * @example
+     * ```tsx
+     * onPreferencesSaved={(prefs) => {
+     *   console.log('Novas preferências:', prefs)
+     *   // Reconfigurar scripts baseado nas preferências
+     * }}
+     * ```
+     */
     onPreferencesSaved?: (prefs: ConsentPreferences) => void;
-    /** Configurações customizadas do cookie. */
+    /**
+     * Configurações do cookie de consentimento.
+     * Valores não fornecidos usam padrões seguros para LGPD.
+     *
+     * @example
+     * ```tsx
+     * cookie={{
+     *   name: 'meuAppConsent',
+     *   maxAgeDays: 180,
+     *   sameSite: 'Strict'
+     * }}
+     * ```
+     */
     cookie?: Partial<ConsentCookieOptions>;
-    /** Elementos filhos do provider. */
+    /**
+     * Desabilita os avisos e sugestões para desenvolvedores no console.
+     * Útil para ambientes de produção ou quando os avisos não são desejados.
+     * Por padrão, os avisos já são desabilitados em builds de produção.
+     */
+    disableDeveloperGuidance?: boolean;
+    /** Elementos filhos - toda a aplicação que precisa de contexto de consentimento. */
     children: React.ReactNode;
 }
 /**
@@ -364,7 +521,9 @@ interface ConsentContextValue {
  */
 declare function ConsentProvider({ initialState, categories, // NOVO: configuração completa de categorias
 texts: textsProp, theme, customCategories, // LEGACY: compatibilidade
-scriptIntegrations, PreferencesModalComponent, preferencesModalProps, disableAutomaticModal, hideBranding, onConsentGiven, onPreferencesSaved, cookie: cookieOpts, children, }: Readonly<ConsentProviderProps>): react_jsx_runtime.JSX.Element;
+scriptIntegrations, // eslint-disable-line no-unused-vars
+PreferencesModalComponent, preferencesModalProps, disableAutomaticModal, hideBranding, onConsentGiven, onPreferencesSaved, cookie: cookieOpts, disableDeveloperGuidance, // NOVO: desabilita avisos de dev
+children, }: Readonly<ConsentProviderProps>): react_jsx_runtime.JSX.Element;
 
 /**
  * Hook principal para acessar e manipular o estado de consentimento de cookies.

package/dist/index.js

@@ -11,7 +11,7 @@ import {
   useConsentHydration,
   useConsentTexts,
   useCustomCategories
-} from "./chunk-JAX63PBG.js";
+} from "./chunk-UKKWGQN7.js";
 
 // src/components/CookieBanner.tsx
 import Button from "@mui/material/Button";
@@ -309,7 +309,7 @@ function createGoogleAnalyticsIntegration(config) {
     init: () => {
       if (typeof window !== "undefined") {
         let gtag2 = function(...args) {
-          window.dataLayer.push(arguments);
+          window.dataLayer.push(...args);
         };
         var gtag = gtag2;
         window.dataLayer = window.dataLayer || [];

package/package.json

@@ -1,105 +1,109 @@
-{
-  "name": "react-lgpd-consent",
-  "version": "0.2.2",
-  "description": "Biblioteca completa de consentimento LGPD com 6 categorias ANPD, integrações nativas e sistema extensível para React.",
-  "keywords": [
-    "lgpd",
-    "anpd",
-    "cookie",
-    "consent",
-    "react",
-    "client-side",
-    "spa",
-    "material-ui",
-    "mui",
-    "typescript",
-    "js-cookie",
-    "consentimento",
-    "privacidade",
-    "acessibilidade",
-    "google-analytics",
-    "tag-manager",
-    "userway",
-    "categorias-extensiveis"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "author": {
-    "name": "Luciano Édipo",
-    "email": "luciano.psilva@anpd.gov.br",
-    "url": "https://github.com/lucianoedipo"
-  },
-  "license": "MIT",
-  "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
-    "./package.json": "./package.json"
-  },
-  "sideEffects": false,
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE",
-    "COMPLIANCE.md"
-  ],
-  "engines": {
-    "node": ">=18.18"
-  },
-  "packageManager": "pnpm@9.0.0",
-  "scripts": {
-    "clean": "rimraf dist",
-    "build": "cross-env NODE_ENV=production tsup src/index.ts --format esm,cjs --dts --clean",
-    "dev": "cross-env NODE_ENV=development tsup src/index.ts --format esm,cjs --dts --watch",
-    "lint": "eslint . --ext .ts,.tsx",
-    "format": "prettier --write \"src/**/*.{ts,tsx,json,md}\"",
-    "type-check": "tsc --noEmit",
-    "prepublishOnly": "npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/lucianoedipo/react-lgpd-consent.git"
-  },
-  "bugs": {
-    "url": "https://github.com/lucianoedipo/react-lgpd-consent/issues"
-  },
-  "homepage": "https://github.com/lucianoedipo/react-lgpd-consent#readme",
-  "peerDependencies": {
-    "@mui/material": "^7.0.0 || ^6.0.0 || ^5.15.0",
-    "@mui/icons-material": "^7.0.0 || ^6.0.0 || ^5.15.0",
-    "react": "^18.2.0 || ^19.0.0",
-    "react-dom": "^18.2.0 || ^19.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@mui/icons-material": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "js-cookie": "^3.0.5"
-  },
-  "devDependencies": {
-    "@types/js-cookie": "^3.0.6",
-    "@types/react": "^19.1.9",
-    "@types/react-dom": "^19.1.7",
-    "@mui/material": "^7.3.1",
-    "@mui/icons-material": "^7.3.1",
-    "react": "^19.1.1",
-    "react-dom": "^19.1.1",
-    "cross-env": "^10.0.0",
-    "eslint": "^9.33.0",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-react-hooks": "^5.2.0",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "tsup": "^8.5.0",
-    "typescript": "^5.9.2"
-  }
-}
+{
+  "name": "react-lgpd-consent",
+  "version": "0.2.4",
+  "description": "Biblioteca completa de consentimento LGPD com 6 categorias ANPD, integrações nativas e sistema extensível para React.",
+  "keywords": [
+    "lgpd",
+    "anpd",
+    "cookie",
+    "consent",
+    "react",
+    "client-side",
+    "spa",
+    "material-ui",
+    "mui",
+    "typescript",
+    "js-cookie",
+    "consentimento",
+    "privacidade",
+    "acessibilidade",
+    "google-analytics",
+    "tag-manager",
+    "userway",
+    "categorias-extensiveis"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": {
+    "name": "Luciano Édipo",
+    "email": "luciano.psilva@anpd.gov.br",
+    "url": "https://github.com/lucianoedipo"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "COMPLIANCE.md"
+  ],
+  "engines": {
+    "node": ">=18.18"
+  },
+  "packageManager": "pnpm@9.0.0",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "cross-env NODE_ENV=production tsup src/index.ts --format esm,cjs --dts --clean",
+    "dev": "cross-env NODE_ENV=development tsup src/index.ts --format esm,cjs --dts --watch",
+    "lint": "eslint . --ext .ts,.tsx",
+    "format": "prettier --write \"src/**/*.{ts,tsx,json,md}\" \"eslint.config.js\"",
+    "type-check": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lucianoedipo/react-lgpd-consent.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lucianoedipo/react-lgpd-consent/issues"
+  },
+  "homepage": "https://github.com/lucianoedipo/react-lgpd-consent#readme",
+  "peerDependencies": {
+    "@mui/icons-material": "^7.0.0 || ^6.0.0 || ^5.15.0",
+    "@mui/material": "^7.0.0 || ^6.0.0 || ^5.15.0",
+    "react": "^18.2.0 || ^19.0.0",
+    "react-dom": "^18.2.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@mui/icons-material": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "js-cookie": "^3.0.5"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1.3.2",
+    "@mui/icons-material": "^7.3.1",
+    "@mui/material": "^7.3.1",
+    "@types/js-cookie": "^3.0.6",
+    "@types/react": "^19.1.9",
+    "@types/react-dom": "^19.1.7",
+    "@typescript-eslint/eslint-plugin": "^8.39.1",
+    "@typescript-eslint/parser": "^8.39.1",
+    "cross-env": "^10.0.0",
+    "eslint": "^9.33.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "prettier": "^3.6.2",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.39.1"
+  }
+}