Avacy CMP Web v3 — Preview

Preview tecnica. Questa sezione documenta la nuova superficie pubblica di @avacy/cmp-web v3 (PR #82) ed è accessibile solo via URL diretto — non compare nella sidebar né nella search della doc. Quando v3 sarà collegata al SaaS, questa pagina verrà promossa a stabile.

La libreria @avacy/cmp-web è il banner di consenso GDPR/IAB-TCF di Avacy, distribuita come pacchetto npm o bundle CDN. Espone un'unica superficie pubblica accessibile sia da window.Avacy (uso classico via tag) sia via import TypeScript (uso advanced per chi scrive storage custom o build enterprise).

Indice della documentazione

Guides

• Getting Started — installazione, primo banner in 30 secondi

Reference (Tier 1 — common API)

Tutto su window.Avacy.*, semver-stabile.

• Config reference — tutte le chiavi di AvacyUserConfig (store, core, frameworks, ui, customLabels, …)
• Lifecycle — init, reload, getData, version
• Consent actions — acceptAll, rejectAll, triggerConsent, updateConsent
• UI control — showPreferenceCenter, closePreferenceCenter, changeLanguage
• Consent query — getConsent (3 viste: macro + mappa purposes/vendors + array choices)
• Debug — setDebug
• Events — DOM CustomEvent su document

Reference (Tier 2 — advanced)

Solo via import { … } from '@avacy/cmp-web'. Etichettato @beta — può breakare in minor.

• Tier 2 reference — registerStoreProvider, CoreEvents, types

---

Quickstart

<script type="application/json" id="avacy-config">
  {
    "publisherCountryCode": "IT",
    "language": "it",
    "frameworks": [{ "tcf": { "cmpId": 297, "frameworkVersion": 2, "vendors": "all" } }]
  }
</script>
<script src="https://cdn.avacy.com/cmp-web/latest/cmpweb.esm.js" type="module"></script>

<script>
  document.addEventListener('avacy:consent-saved', (e) => {
    console.log('user saved consent:', e.detail.type);
  });
</script>

Versionamento

Tier	Stabilità	Cycle
Tier 1 (window.Avacy.*, avacy:* events, UserConfigType)	Semver strict	Deprecation: 1 MINOR con console.warn + TSDoc @deprecated → rimozione in MAJOR
Tier 2 (import { … })	Beta	Può breakare in MINOR. Annuncio su Slack #avacy-dev 1 settimana prima

Versione bundle: window.Avacy.version (es. "3.0.0").