@freshjuice/zest 0.1.0 → 2.0.0

package/src/core-lifecycle.js

@@ -0,0 +1,192 @@
+/**
+ * Core lifecycle - UI-agnostic initialization and consent actions.
+ *
+ * This module contains everything the main entry (with UI) and the
+ * headless entry (no UI) share: interceptor setup, consent load/save,
+ * replay, DNT handling, and the events/callbacks fan-out. It intentionally
+ * does NOT import anything from `./ui/*` so tree-shakers can drop the UI
+ * bundle entirely when only the headless API is used.
+ */
+
+import { interceptCookies, setConsentChecker as setCookieChecker, replayCookies } from './core/cookie-interceptor.js';
+import { interceptStorage, setConsentChecker as setStorageChecker, replayStorage } from './core/storage-interceptor.js';
+import { startScriptBlocking, setConsentChecker as setScriptChecker, replayScripts } from './core/script-blocker.js';
+import { setPatterns } from './core/pattern-matcher.js';
+import { getCategoryIds } from './core/categories.js';
+import { isDoNotTrackEnabled } from './core/dnt.js';
+import { safeInvoke } from './core/security.js';
+
+import { applyConsentSignals } from './integrations/consent-signals.js';
+
+import { setConfig } from './config/parser.js';
+
+import {
+  loadConsent,
+  hasConsent,
+  updateConsent,
+  acceptAll as storeAcceptAll,
+  rejectAll as storeRejectAll,
+  resetConsent,
+  hasConsentDecision
+} from './storage/consent-store.js';
+import { emitReady, emitConsent, emitReject, emitChange } from './storage/events.js';
+
+let initialized = false;
+let currentConfig = null;
+
+function checkConsent(category) {
+  return hasConsent(category);
+}
+
+function replayAll(categories) {
+  replayCookies(categories);
+  replayStorage(categories);
+  replayScripts(categories);
+}
+
+/**
+ * Run the non-UI half of init. Returns a snapshot the caller (UI or
+ * headless) can use to decide what to do next.
+ */
+export function coreInit(userConfig = {}) {
+  if (initialized) {
+    return {
+      alreadyInitialized: true,
+      config: currentConfig,
+      consent: loadConsent(),
+      hasDecision: hasConsentDecision(),
+      dntApplied: false
+    };
+  }
+
+  currentConfig = setConfig(userConfig);
+
+  // Push default-denied state to vendor consent mode APIs BEFORE any
+  // third-party script has a chance to fire.
+  applyConsentSignals(
+    { essential: true, functional: false, analytics: false, marketing: false },
+    currentConfig,
+    true
+  );
+
+  if (currentConfig.patterns) {
+    setPatterns(currentConfig.patterns);
+  }
+
+  setCookieChecker(checkConsent);
+  setStorageChecker(checkConsent);
+  setScriptChecker(checkConsent);
+
+  interceptCookies();
+  interceptStorage();
+  startScriptBlocking(currentConfig.mode, currentConfig.blockedDomains);
+
+  const consent = loadConsent();
+  initialized = true;
+
+  if (hasConsentDecision()) {
+    applyConsentSignals(consent, currentConfig, false);
+  }
+
+  // DNT / GPC handling — if the user signalled opt-out at the browser
+  // level and the site opts to respect it, auto-reject before the UI
+  // layer ever runs.
+  const dntEnabled = isDoNotTrackEnabled();
+  let dntApplied = false;
+
+  if (dntEnabled && currentConfig.respectDNT && currentConfig.dntBehavior !== 'ignore') {
+    if (currentConfig.dntBehavior === 'reject' && !hasConsentDecision()) {
+      const result = storeRejectAll(currentConfig.expiration);
+      dntApplied = true;
+      applyConsentSignals(result.current, currentConfig, false);
+      emitReject(result.current);
+      emitChange(result.current, result.previous);
+      safeInvoke(currentConfig.callbacks?.onReject);
+      safeInvoke(currentConfig.callbacks?.onChange, result.current);
+    }
+  }
+
+  emitReady(consent);
+  safeInvoke(currentConfig.callbacks?.onReady, consent);
+
+  return {
+    alreadyInitialized: false,
+    config: currentConfig,
+    consent,
+    hasDecision: hasConsentDecision(),
+    dntApplied
+  };
+}
+
+/**
+ * Accept all categories, replay queued items, fire events + callbacks.
+ * Returns { current, previous } or null if not yet initialized.
+ */
+export function coreAcceptAll() {
+  if (!initialized) return null;
+  const result = storeAcceptAll(currentConfig.expiration);
+  applyConsentSignals(result.current, currentConfig, false);
+  replayAll(getCategoryIds());
+  emitConsent(result.current, result.previous);
+  emitChange(result.current, result.previous);
+  safeInvoke(currentConfig.callbacks?.onAccept, result.current);
+  safeInvoke(currentConfig.callbacks?.onChange, result.current);
+  return result;
+}
+
+/**
+ * Reject all non-essential categories, fire events + callbacks.
+ */
+export function coreRejectAll() {
+  if (!initialized) return null;
+  const result = storeRejectAll(currentConfig.expiration);
+  applyConsentSignals(result.current, currentConfig, false);
+  emitReject(result.current);
+  emitChange(result.current, result.previous);
+  safeInvoke(currentConfig.callbacks?.onReject);
+  safeInvoke(currentConfig.callbacks?.onChange, result.current);
+  return result;
+}
+
+/**
+ * Save custom selections and replay only the newly-allowed categories.
+ */
+export function coreUpdateConsent(selections) {
+  if (!initialized) return null;
+  const result = updateConsent(selections, currentConfig.expiration);
+  applyConsentSignals(result.current, currentConfig, false);
+
+  const newlyAllowed = Object.keys(result.current).filter(
+    (cat) => result.current[cat] && !result.previous[cat]
+  );
+  if (newlyAllowed.length > 0) {
+    replayAll(newlyAllowed);
+  }
+
+  const hasNonEssential = Object.entries(selections || {}).some(
+    ([cat, val]) => cat !== 'essential' && val
+  );
+  if (hasNonEssential) {
+    emitConsent(result.current, result.previous);
+  } else {
+    emitReject(result.current);
+  }
+  emitChange(result.current, result.previous);
+  safeInvoke(currentConfig.callbacks?.onChange, result.current);
+  return result;
+}
+
+/**
+ * Clear the consent cookie. The caller is responsible for any UI reset.
+ */
+export function coreReset() {
+  resetConsent();
+}
+
+export function isInitialized() {
+  return initialized;
+}
+
+export function getActiveConfig() {
+  return currentConfig;
+}

package/src/headless.js

@@ -0,0 +1,133 @@
+/**
+ * Zest Headless - consent logic only, zero UI.
+ *
+ * Use this entry when you want to bring your own banner / modal / settings
+ * markup and style it with your own CSS. No Shadow DOM is mounted, no
+ * inline stylesheet is injected, and nothing is attached to `window`.
+ *
+ * Everything you need to wire a custom UI is here:
+ *
+ *   import Zest from '@freshjuice/zest/headless';
+ *
+ *   Zest.init({ mode: 'safe', respectDNT: true });
+ *
+ *   if (!Zest.hasConsentDecision()) {
+ *     myBanner.show();
+ *   }
+ *
+ *   myAcceptBtn.addEventListener('click', () => Zest.acceptAll());
+ *   myRejectBtn.addEventListener('click', () => Zest.rejectAll());
+ *   mySaveBtn.addEventListener('click', () => {
+ *     Zest.updateConsent({ analytics: true, marketing: false });
+ *   });
+ *
+ *   Zest.on(Zest.EVENTS.CHANGE, (e) => console.log(e.detail.consent));
+ *
+ * The headless build does NOT auto-initialize. You must call `init()`
+ * yourself, so you control exactly when interceptors come online.
+ */
+
+import {
+  coreInit,
+  coreAcceptAll,
+  coreRejectAll,
+  coreUpdateConsent,
+  coreReset,
+  isInitialized,
+  getActiveConfig
+} from './core-lifecycle.js';
+
+import {
+  getConsent,
+  hasConsent,
+  hasConsentDecision,
+  getConsentProof
+} from './storage/consent-store.js';
+
+import { isDoNotTrackEnabled, getDNTDetails } from './core/dnt.js';
+
+import { EVENTS, on, once } from './storage/events.js';
+
+function init(userConfig = {}) {
+  const snapshot = coreInit(userConfig);
+  // Headless returns the snapshot so callers can decide whether to
+  // render their banner / settings UI based on hasDecision / dntApplied.
+  return snapshot;
+}
+
+function acceptAll() {
+  if (!isInitialized()) {
+    console.warn('[Zest] Not initialized. Call Zest.init() first.');
+    return null;
+  }
+  return coreAcceptAll();
+}
+
+function rejectAll() {
+  if (!isInitialized()) {
+    console.warn('[Zest] Not initialized. Call Zest.init() first.');
+    return null;
+  }
+  return coreRejectAll();
+}
+
+function updateConsent(selections) {
+  if (!isInitialized()) {
+    console.warn('[Zest] Not initialized. Call Zest.init() first.');
+    return null;
+  }
+  return coreUpdateConsent(selections);
+}
+
+function reset() {
+  coreReset();
+}
+
+const Zest = {
+  init,
+
+  // Consent state
+  getConsent,
+  hasConsent,
+  hasConsentDecision,
+  getConsentProof,
+
+  // Actions
+  acceptAll,
+  rejectAll,
+  updateConsent,
+  reset,
+
+  // DNT introspection
+  isDoNotTrackEnabled,
+  getDNTDetails,
+
+  // Events
+  on,
+  once,
+  EVENTS,
+
+  // Config introspection
+  getConfig: getActiveConfig
+};
+
+export default Zest;
+
+// Named exports for tree-shake friendly consumers who only need a slice.
+export {
+  init,
+  acceptAll,
+  rejectAll,
+  updateConsent,
+  reset,
+  getConsent,
+  hasConsent,
+  hasConsentDecision,
+  getConsentProof,
+  isDoNotTrackEnabled,
+  getDNTDetails,
+  on,
+  once,
+  EVENTS,
+  getActiveConfig as getConfig
+};

package/src/i18n/lang-en.js

@@ -0,0 +1,54 @@
+/**
+ * English only translation
+ */
+export const translations = {
+  en: {
+    labels: {
+      banner: {
+        title: 'We value your privacy',
+        description: 'We use cookies to enhance your browsing experience, serve personalized content, and analyze our traffic. By clicking "Accept All", you consent to our use of cookies.',
+        acceptAll: 'Accept All',
+        rejectAll: 'Reject All',
+        settings: 'Settings'
+      },
+      modal: {
+        title: 'Privacy Settings',
+        description: 'Manage your cookie preferences. You can enable or disable different types of cookies below.',
+        save: 'Save Preferences',
+        acceptAll: 'Accept All',
+        rejectAll: 'Reject All'
+      },
+      widget: {
+        label: 'Cookie Settings'
+      }
+    },
+    categories: {
+      essential: {
+        label: 'Essential',
+        description: 'Required for the website to function properly. Cannot be disabled.'
+      },
+      functional: {
+        label: 'Functional',
+        description: 'Enable personalized features like language preferences and themes.'
+      },
+      analytics: {
+        label: 'Analytics',
+        description: 'Help us understand how visitors interact with our website.'
+      },
+      marketing: {
+        label: 'Marketing',
+        description: 'Used to deliver relevant advertisements and track campaign performance.'
+      }
+    }
+  }
+};
+
+export const supportedLanguages = ['en'];
+
+export function detectLanguage() {
+  return 'en';
+}
+
+export function getTranslation() {
+  return translations.en;
+}

package/src/i18n/single/lang-de.js

@@ -0,0 +1,55 @@
+/**
+ * DE only translation - auto-generated
+ * Do not edit manually, run: npm run build
+ */
+export const translations = {
+  de: {
+      "labels": {
+          "banner": {
+              "title": "Wir respektieren Ihre Privatsphäre",
+              "description": "Wir verwenden Cookies, um Ihr Surferlebnis zu verbessern, personalisierte Inhalte bereitzustellen und unseren Datenverkehr zu analysieren. Mit einem Klick auf „Alle akzeptieren\" stimmen Sie der Verwendung von Cookies zu.",
+              "acceptAll": "Alle akzeptieren",
+              "rejectAll": "Alle ablehnen",
+              "settings": "Einstellungen"
+          },
+          "modal": {
+              "title": "Datenschutzeinstellungen",
+              "description": "Verwalten Sie Ihre Cookie-Einstellungen. Sie können verschiedene Arten von Cookies unten aktivieren oder deaktivieren.",
+              "save": "Einstellungen speichern",
+              "acceptAll": "Alle akzeptieren",
+              "rejectAll": "Alle ablehnen"
+          },
+          "widget": {
+              "label": "Cookie-Einstellungen"
+          }
+      },
+      "categories": {
+          "essential": {
+              "label": "Notwendig",
+              "description": "Erforderlich für die ordnungsgemäße Funktion der Website. Können nicht deaktiviert werden."
+          },
+          "functional": {
+              "label": "Funktional",
+              "description": "Ermöglichen personalisierte Funktionen wie Spracheinstellungen und Designs."
+          },
+          "analytics": {
+              "label": "Analytisch",
+              "description": "Helfen uns zu verstehen, wie Besucher mit unserer Website interagieren."
+          },
+          "marketing": {
+              "label": "Marketing",
+              "description": "Werden verwendet, um relevante Werbung anzuzeigen und die Kampagnenleistung zu messen."
+          }
+      }
+  }
+};
+
+export const supportedLanguages = ['de'];
+
+export function detectLanguage() {
+  return 'de';
+}
+
+export function getTranslation() {
+  return translations.de;
+}

package/src/i18n/single/lang-en.js

@@ -0,0 +1,55 @@
+/**
+ * EN only translation - auto-generated
+ * Do not edit manually, run: npm run build
+ */
+export const translations = {
+  en: {
+      "labels": {
+          "banner": {
+              "title": "We value your privacy",
+              "description": "We use cookies to enhance your browsing experience, serve personalized content, and analyze our traffic. By clicking \"Accept All\", you consent to our use of cookies.",
+              "acceptAll": "Accept All",
+              "rejectAll": "Reject All",
+              "settings": "Settings"
+          },
+          "modal": {
+              "title": "Privacy Settings",
+              "description": "Manage your cookie preferences. You can enable or disable different types of cookies below.",
+              "save": "Save Preferences",
+              "acceptAll": "Accept All",
+              "rejectAll": "Reject All"
+          },
+          "widget": {
+              "label": "Cookie Settings"
+          }
+      },
+      "categories": {
+          "essential": {
+              "label": "Essential",
+              "description": "Required for the website to function properly. Cannot be disabled."
+          },
+          "functional": {
+              "label": "Functional",
+              "description": "Enable personalized features like language preferences and themes."
+          },
+          "analytics": {
+              "label": "Analytics",
+              "description": "Help us understand how visitors interact with our website."
+          },
+          "marketing": {
+              "label": "Marketing",
+              "description": "Used to deliver relevant advertisements and track campaign performance."
+          }
+      }
+  }
+};
+
+export const supportedLanguages = ['en'];
+
+export function detectLanguage() {
+  return 'en';
+}
+
+export function getTranslation() {
+  return translations.en;
+}

package/src/i18n/single/lang-es.js

@@ -0,0 +1,55 @@
+/**
+ * ES only translation - auto-generated
+ * Do not edit manually, run: npm run build
+ */
+export const translations = {
+  es: {
+      "labels": {
+          "banner": {
+              "title": "Valoramos tu privacidad",
+              "description": "Utilizamos cookies para mejorar tu experiencia de navegación, ofrecer contenido personalizado y analizar nuestro tráfico. Al hacer clic en \"Aceptar todo\", consientes el uso de cookies.",
+              "acceptAll": "Aceptar todo",
+              "rejectAll": "Rechazar todo",
+              "settings": "Configuración"
+          },
+          "modal": {
+              "title": "Configuración de privacidad",
+              "description": "Gestiona tus preferencias de cookies. Puedes activar o desactivar diferentes tipos de cookies a continuación.",
+              "save": "Guardar preferencias",
+              "acceptAll": "Aceptar todo",
+              "rejectAll": "Rechazar todo"
+          },
+          "widget": {
+              "label": "Configuración de cookies"
+          }
+      },
+      "categories": {
+          "essential": {
+              "label": "Esenciales",
+              "description": "Necesarias para el funcionamiento del sitio web. No se pueden desactivar."
+          },
+          "functional": {
+              "label": "Funcionales",
+              "description": "Permiten funciones personalizadas como preferencias de idioma y temas."
+          },
+          "analytics": {
+              "label": "Analíticas",
+              "description": "Nos ayudan a entender cómo los visitantes interactúan con nuestro sitio web."
+          },
+          "marketing": {
+              "label": "Marketing",
+              "description": "Se utilizan para mostrar anuncios relevantes y medir el rendimiento de las campañas."
+          }
+      }
+  }
+};
+
+export const supportedLanguages = ['es'];
+
+export function detectLanguage() {
+  return 'es';
+}
+
+export function getTranslation() {
+  return translations.es;
+}

package/src/i18n/single/lang-fr.js

@@ -0,0 +1,55 @@
+/**
+ * FR only translation - auto-generated
+ * Do not edit manually, run: npm run build
+ */
+export const translations = {
+  fr: {
+      "labels": {
+          "banner": {
+              "title": "Nous respectons votre vie privée",
+              "description": "Nous utilisons des cookies pour améliorer votre expérience de navigation, proposer du contenu personnalisé et analyser notre trafic. En cliquant sur « Tout accepter », vous consentez à l'utilisation de cookies.",
+              "acceptAll": "Tout accepter",
+              "rejectAll": "Tout refuser",
+              "settings": "Paramètres"
+          },
+          "modal": {
+              "title": "Paramètres de confidentialité",
+              "description": "Gérez vos préférences en matière de cookies. Vous pouvez activer ou désactiver différents types de cookies ci-dessous.",
+              "save": "Enregistrer les préférences",
+              "acceptAll": "Tout accepter",
+              "rejectAll": "Tout refuser"
+          },
+          "widget": {
+              "label": "Paramètres des cookies"
+          }
+      },
+      "categories": {
+          "essential": {
+              "label": "Essentiels",
+              "description": "Nécessaires au bon fonctionnement du site. Ne peuvent pas être désactivés."
+          },
+          "functional": {
+              "label": "Fonctionnels",
+              "description": "Permettent des fonctionnalités personnalisées comme les préférences de langue et de thème."
+          },
+          "analytics": {
+              "label": "Analytiques",
+              "description": "Nous aident à comprendre comment les visiteurs interagissent avec notre site."
+          },
+          "marketing": {
+              "label": "Marketing",
+              "description": "Utilisés pour afficher des publicités pertinentes et mesurer les performances des campagnes."
+          }
+      }
+  }
+};
+
+export const supportedLanguages = ['fr'];
+
+export function detectLanguage() {
+  return 'fr';
+}
+
+export function getTranslation() {
+  return translations.fr;
+}

package/src/i18n/single/lang-it.js

@@ -0,0 +1,55 @@
+/**
+ * IT only translation - auto-generated
+ * Do not edit manually, run: npm run build
+ */
+export const translations = {
+  it: {
+      "labels": {
+          "banner": {
+              "title": "Rispettiamo la tua privacy",
+              "description": "Utilizziamo i cookie per migliorare la tua esperienza di navigazione, fornire contenuti personalizzati e analizzare il nostro traffico. Cliccando su \"Accetta tutto\", acconsenti all'uso dei cookie.",
+              "acceptAll": "Accetta tutto",
+              "rejectAll": "Rifiuta tutto",
+              "settings": "Impostazioni"
+          },
+          "modal": {
+              "title": "Impostazioni privacy",
+              "description": "Gestisci le tue preferenze sui cookie. Puoi attivare o disattivare diversi tipi di cookie qui sotto.",
+              "save": "Salva preferenze",
+              "acceptAll": "Accetta tutto",
+              "rejectAll": "Rifiuta tutto"
+          },
+          "widget": {
+              "label": "Impostazioni cookie"
+          }
+      },
+      "categories": {
+          "essential": {
+              "label": "Essenziali",
+              "description": "Necessari per il corretto funzionamento del sito. Non possono essere disattivati."
+          },
+          "functional": {
+              "label": "Funzionali",
+              "description": "Abilitano funzionalità personalizzate come preferenze di lingua e tema."
+          },
+          "analytics": {
+              "label": "Analitici",
+              "description": "Ci aiutano a capire come i visitatori interagiscono con il nostro sito."
+          },
+          "marketing": {
+              "label": "Marketing",
+              "description": "Utilizzati per mostrare annunci pertinenti e misurare le prestazioni delle campagne."
+          }
+      }
+  }
+};
+
+export const supportedLanguages = ['it'];
+
+export function detectLanguage() {
+  return 'it';
+}
+
+export function getTranslation() {
+  return translations.it;
+}