react-lgpd-consent - v0.3.4
    Preparing search index...

    Interface ConsentCookieData

    Estrutura do cookie de consentimento em conformidade com LGPD/ANPD.

    Types

    0.2.1

    Esta interface define o formato do cookie persistido no navegador do usuário, contendo todas as informações necessárias para compliance com a LGPD e para o funcionamento correto da biblioteca.

    Importante: A estrutura utiliza um formato JSON simples e legível, projetado para ser autoexplicativo e atender diretamente aos requisitos da LGPD para sites de primeira parte (first-party contexts).

    Não implementa IAB TCF: Este formato não segue o padrão IAB Transparency and Consent Framework (TCF), que é mais complexo e voltado para o ecossistema de publicidade programática (ad-tech). A adoção do TCF pode ser uma evolução futura da biblioteca.

    const cookieData: ConsentCookieData = {
      version: '1.0',
      consented: true,
      preferences: {
        necessary: true,
        analytics: true,
        marketing: false
      },
      consentDate: '2024-01-15T10:30:00.000Z',
      lastUpdate: '2024-01-15T10:30:00.000Z',
      source: 'banner',
      projectConfig: {
        enabledCategories: ['analytics', 'marketing']
      }
    };
    interface ConsentCookieData {
        consentDate: string;
        consented: boolean;
        lastUpdate: string;
        preferences: ConsentPreferences;
        projectConfig?: ProjectCategoriesConfig;
        source: "banner" | "modal" | "programmatic";
        version: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    consentDate consented lastUpdate preferences projectConfig? source version

    Properties

    consentDate: string

    Timestamp ISO 8601 da primeira interação com o banner de consentimento.

    '2024-01-15T10:30:00.000Z'
    consented: boolean

    Indica se o usuário já prestou consentimento explícito.

    true
    lastUpdate: string

    Timestamp ISO 8601 da última modificação das preferências. Atualizado sempre que o usuário muda suas preferências.

    '2024-01-15T10:30:00.000Z'
    preferences: ConsentPreferences

    Preferências detalhadas por categoria de cookies. Contém apenas as categorias ativas no projeto.

    projectConfig?: ProjectCategoriesConfig

    Snapshot da configuração de categorias no momento do consentimento. Útil para detectar mudanças na configuração e solicitar novo consentimento.

    source: "banner" | "modal" | "programmatic"

    Origem da decisão de consentimento para auditoria.

    • 'banner': Decisão tomada no banner principal
    • 'modal': Decisão tomada no modal de preferências
    • 'programmatic': Decisão tomada via API programática
    version: string

    Versão do esquema do cookie para compatibilidade e migração futura.

    '1.0'

    Settings

    Member Visibility

    On This Page

    Properties