react-lgpd-consent 0.2.1 → 0.2.2

package/dist/index.d.cts

@@ -362,7 +362,9 @@ interface ConsentContextValue {
  *   <App />
  * </ConsentProvider>
  */
-declare function ConsentProvider({ initialState, texts: textsProp, theme, customCategories, scriptIntegrations, PreferencesModalComponent, preferencesModalProps, disableAutomaticModal, hideBranding, onConsentGiven, onPreferencesSaved, cookie: cookieOpts, children, }: Readonly<ConsentProviderProps>): react_jsx_runtime.JSX.Element;
+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;
 
 /**
  * Hook principal para acessar e manipular o estado de consentimento de cookies.
@@ -398,14 +400,73 @@ declare function useConsentTexts(): ConsentTexts;
 declare function useConsentHydration(): boolean;
 
 /**
- * Hook para acessar as categorias customizadas.
- * Retorna apenas as categorias customizadas (não as padrão analytics/marketing).
+ * Sistema de orientações para developers sobre configuração de categorias.
+ * Ajuda a manter coerência entre configuração da lib e componentes customizados.
+ */
+interface DeveloperGuidance {
+    /** Avisos sobre configuração inconsistente */
+    warnings: string[];
+    /** Sugestões de melhoria */
+    suggestions: string[];
+    /** Informações sobre categorias ativas */
+    activeCategoriesInfo: {
+        id: string;
+        name: string;
+        description: string;
+        essential: boolean;
+        uiRequired: boolean;
+    }[];
+    /** Se usa configuração padrão (não explícita) */
+    usingDefaults: boolean;
+}
+/**
+ * Configuração padrão quando developer não especifica categorias.
+ * Baseado nas necessidades mais comuns em conformidade LGPD.
  */
-declare function useCustomCategories(): CategoryDefinition[];
+declare const DEFAULT_PROJECT_CATEGORIES: ProjectCategoriesConfig;
+/**
+ * Analisa configuração do projeto e retorna orientações para o developer.
+ */
+declare function analyzeDeveloperConfiguration(config?: ProjectCategoriesConfig): DeveloperGuidance;
+
+/**
+ * Context para informações sobre categorias ativas no projeto.
+ * Fornece orientações e validações para components UI.
+ */
+interface CategoriesContextValue {
+    /** Configuração final das categorias (com padrão aplicado) */
+    config: ProjectCategoriesConfig;
+    /** Análise e orientações para developers */
+    guidance: DeveloperGuidance;
+    /** Categorias que precisam de toggle na UI */
+    toggleableCategories: DeveloperGuidance['activeCategoriesInfo'];
+    /** Todas as categorias ativas */
+    allCategories: DeveloperGuidance['activeCategoriesInfo'];
+    /** LEGACY: Apenas categorias customizadas (backward compatibility) */
+    legacyCategories: CategoryDefinition[];
+}
 /**
- * Hook para obter todas as categorias (padrão + customizadas).
+ * Hook para acessar informações sobre categorias ativas.
+ * Usado por componentes UI para renderizar adequadamente.
  */
-declare function useAllCategories(): CategoryDefinition[];
+declare function useCategories(): CategoriesContextValue;
+/**
+ * Hook de conveniência para verificar se uma categoria específica está ativa.
+ */
+declare function useCategoryStatus(categoryId: string): {
+    isActive: boolean;
+    isEssential: boolean;
+    needsToggle: boolean;
+    name: string | undefined;
+    description: string | undefined;
+};
+/**
+ * LEGACY: Hook para acessar as categorias customizadas.
+ * Mantido para backward compatibility.
+ *
+ * @deprecated Use useCategories() ao invés disso para acesso completo às categorias.
+ */
+declare function useCustomCategories(): CategoryDefinition[];
 
 declare function ConsentGate(props: Readonly<{
     category: string;
@@ -482,4 +543,4 @@ declare function ConsentScriptLoader({ integrations, reloadOnChange, }: Readonly
  */
 declare function useConsentScriptLoader(): (integration: ScriptIntegration) => Promise<boolean>;
 
-export { COMMON_INTEGRATIONS, type Category, type CategoryDefinition, type ConsentCookieOptions, ConsentGate, type ConsentPreferences, ConsentProvider, ConsentScriptLoader, type ConsentState, type ConsentTexts, CookieBanner, FloatingPreferencesButton, type GoogleAnalyticsConfig, type GoogleTagManagerConfig, PreferencesModal, type ScriptIntegration, type UserWayConfig, createGoogleAnalyticsIntegration, createGoogleTagManagerIntegration, createUserWayIntegration, defaultConsentTheme, loadScript, useAllCategories, useConsent, useConsentHydration, useConsentScriptLoader, useConsentTexts, useCustomCategories };
+export { COMMON_INTEGRATIONS, type Category, type CategoryDefinition, type ConsentCookieOptions, ConsentGate, type ConsentPreferences, ConsentProvider, ConsentScriptLoader, type ConsentState, type ConsentTexts, CookieBanner, DEFAULT_PROJECT_CATEGORIES, type DeveloperGuidance, FloatingPreferencesButton, type GoogleAnalyticsConfig, type GoogleTagManagerConfig, PreferencesModal, type ProjectCategoriesConfig, type ScriptIntegration, type UserWayConfig, analyzeDeveloperConfiguration, createGoogleAnalyticsIntegration, createGoogleTagManagerIntegration, createUserWayIntegration, defaultConsentTheme, loadScript, useCategories, useCategoryStatus, useConsent, useConsentHydration, useConsentScriptLoader, useConsentTexts, useCustomCategories };

package/dist/index.d.ts

@@ -362,7 +362,9 @@ interface ConsentContextValue {
  *   <App />
  * </ConsentProvider>
  */
-declare function ConsentProvider({ initialState, texts: textsProp, theme, customCategories, scriptIntegrations, PreferencesModalComponent, preferencesModalProps, disableAutomaticModal, hideBranding, onConsentGiven, onPreferencesSaved, cookie: cookieOpts, children, }: Readonly<ConsentProviderProps>): react_jsx_runtime.JSX.Element;
+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;
 
 /**
  * Hook principal para acessar e manipular o estado de consentimento de cookies.
@@ -398,14 +400,73 @@ declare function useConsentTexts(): ConsentTexts;
 declare function useConsentHydration(): boolean;
 
 /**
- * Hook para acessar as categorias customizadas.
- * Retorna apenas as categorias customizadas (não as padrão analytics/marketing).
+ * Sistema de orientações para developers sobre configuração de categorias.
+ * Ajuda a manter coerência entre configuração da lib e componentes customizados.
+ */
+interface DeveloperGuidance {
+    /** Avisos sobre configuração inconsistente */
+    warnings: string[];
+    /** Sugestões de melhoria */
+    suggestions: string[];
+    /** Informações sobre categorias ativas */
+    activeCategoriesInfo: {
+        id: string;
+        name: string;
+        description: string;
+        essential: boolean;
+        uiRequired: boolean;
+    }[];
+    /** Se usa configuração padrão (não explícita) */
+    usingDefaults: boolean;
+}
+/**
+ * Configuração padrão quando developer não especifica categorias.
+ * Baseado nas necessidades mais comuns em conformidade LGPD.
  */
-declare function useCustomCategories(): CategoryDefinition[];
+declare const DEFAULT_PROJECT_CATEGORIES: ProjectCategoriesConfig;
+/**
+ * Analisa configuração do projeto e retorna orientações para o developer.
+ */
+declare function analyzeDeveloperConfiguration(config?: ProjectCategoriesConfig): DeveloperGuidance;
+
+/**
+ * Context para informações sobre categorias ativas no projeto.
+ * Fornece orientações e validações para components UI.
+ */
+interface CategoriesContextValue {
+    /** Configuração final das categorias (com padrão aplicado) */
+    config: ProjectCategoriesConfig;
+    /** Análise e orientações para developers */
+    guidance: DeveloperGuidance;
+    /** Categorias que precisam de toggle na UI */
+    toggleableCategories: DeveloperGuidance['activeCategoriesInfo'];
+    /** Todas as categorias ativas */
+    allCategories: DeveloperGuidance['activeCategoriesInfo'];
+    /** LEGACY: Apenas categorias customizadas (backward compatibility) */
+    legacyCategories: CategoryDefinition[];
+}
 /**
- * Hook para obter todas as categorias (padrão + customizadas).
+ * Hook para acessar informações sobre categorias ativas.
+ * Usado por componentes UI para renderizar adequadamente.
  */
-declare function useAllCategories(): CategoryDefinition[];
+declare function useCategories(): CategoriesContextValue;
+/**
+ * Hook de conveniência para verificar se uma categoria específica está ativa.
+ */
+declare function useCategoryStatus(categoryId: string): {
+    isActive: boolean;
+    isEssential: boolean;
+    needsToggle: boolean;
+    name: string | undefined;
+    description: string | undefined;
+};
+/**
+ * LEGACY: Hook para acessar as categorias customizadas.
+ * Mantido para backward compatibility.
+ *
+ * @deprecated Use useCategories() ao invés disso para acesso completo às categorias.
+ */
+declare function useCustomCategories(): CategoryDefinition[];
 
 declare function ConsentGate(props: Readonly<{
     category: string;
@@ -482,4 +543,4 @@ declare function ConsentScriptLoader({ integrations, reloadOnChange, }: Readonly
  */
 declare function useConsentScriptLoader(): (integration: ScriptIntegration) => Promise<boolean>;
 
-export { COMMON_INTEGRATIONS, type Category, type CategoryDefinition, type ConsentCookieOptions, ConsentGate, type ConsentPreferences, ConsentProvider, ConsentScriptLoader, type ConsentState, type ConsentTexts, CookieBanner, FloatingPreferencesButton, type GoogleAnalyticsConfig, type GoogleTagManagerConfig, PreferencesModal, type ScriptIntegration, type UserWayConfig, createGoogleAnalyticsIntegration, createGoogleTagManagerIntegration, createUserWayIntegration, defaultConsentTheme, loadScript, useAllCategories, useConsent, useConsentHydration, useConsentScriptLoader, useConsentTexts, useCustomCategories };
+export { COMMON_INTEGRATIONS, type Category, type CategoryDefinition, type ConsentCookieOptions, ConsentGate, type ConsentPreferences, ConsentProvider, ConsentScriptLoader, type ConsentState, type ConsentTexts, CookieBanner, DEFAULT_PROJECT_CATEGORIES, type DeveloperGuidance, FloatingPreferencesButton, type GoogleAnalyticsConfig, type GoogleTagManagerConfig, PreferencesModal, type ProjectCategoriesConfig, type ScriptIntegration, type UserWayConfig, analyzeDeveloperConfiguration, createGoogleAnalyticsIntegration, createGoogleTagManagerIntegration, createUserWayIntegration, defaultConsentTheme, loadScript, useCategories, useCategoryStatus, useConsent, useConsentHydration, useConsentScriptLoader, useConsentTexts, useCustomCategories };

package/dist/index.js

@@ -1,14 +1,17 @@
 import {
   Branding,
   ConsentProvider,
+  DEFAULT_PROJECT_CATEGORIES,
   PreferencesModal,
+  analyzeDeveloperConfiguration,
   defaultConsentTheme,
-  useAllCategories,
+  useCategories,
+  useCategoryStatus,
   useConsent,
   useConsentHydration,
   useConsentTexts,
   useCustomCategories
-} from "./chunk-QCERRRSC.js";
+} from "./chunk-JAX63PBG.js";
 
 // src/components/CookieBanner.tsx
 import Button from "@mui/material/Button";
@@ -361,14 +364,17 @@ export {
   ConsentProvider,
   ConsentScriptLoader,
   CookieBanner,
+  DEFAULT_PROJECT_CATEGORIES,
   FloatingPreferencesButton,
   PreferencesModal,
+  analyzeDeveloperConfiguration,
   createGoogleAnalyticsIntegration,
   createGoogleTagManagerIntegration,
   createUserWayIntegration,
   defaultConsentTheme,
   loadScript,
-  useAllCategories,
+  useCategories,
+  useCategoryStatus,
   useConsent,
   useConsentHydration,
   useConsentScriptLoader,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-lgpd-consent",
-  "version": "0.2.1",
+  "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",