@owlmeans/consent 0.1.18-rc.9 → 0.1.18

package/src/i18n/pl.json

@@ -32,5 +32,12 @@
   "privacy": "Polityka prywatności",
   "terms": "Regulamin",
   "domains": "Ten wybór dotyczy: {{domains}}.",
-  "policyDomains": "Ten wybór dotyczy następujących domen:"
+  "policyDomains": "Ten wybór dotyczy następujących domen:",
+  "barTitle": "Pliki cookie w tym serwisie",
+  "barDescription": "Używamy niezbędnych plików cookie, aby serwis działał — do logowania, zapewnienia bezpieczeństwa i zapamiętania Twoich wyborów. Za Twoją zgodą użylibyśmy również tych opcjonalnych plików cookie: {{categories}}. Pozostają wyłączone, dopóki na nie nie zezwolisz, a swój wybór możesz w każdej chwili zmienić lub wycofać w preferencjach plików cookie.",
+  "barDescriptionEssential": "Ten serwis używa wyłącznie niezbędnych plików cookie — do logowania, zapewnienia bezpieczeństwa i zapamiętania Twoich wyborów. Nie wymagają one zgody i nie można ich wyłączyć.",
+  "acceptMandatory": "Akceptuj tylko niezbędne",
+  "locating": "Sprawdzamy Twój region…",
+  "autoReason": "Te ustawienia zastosowano automatycznie, ponieważ tam, skąd przeglądasz serwis, zgoda na pliki cookie nie jest wymagana. Możesz je zmienić w każdej chwili.",
+  "policyRegional": "Tam, gdzie prawo miejsca pobytu odwiedzającego wymaga uprzedniej zgody — w UE i EOG, w Wielkiej Brytanii, Szwajcarii i innych krajach o podobnych przepisach — opcjonalne pliki cookie pozostają wyłączone, dopóki odwiedzający na nie nie zezwoli. W pozostałych krajach są domyślnie włączone, chyba że przeglądarka wysyła sygnał Global Privacy Control, który traktujemy jako odmowę; w każdej chwili można je wyłączyć przyciskiem poniżej."
 }

package/src/i18n/ru.json

@@ -32,5 +32,12 @@
   "privacy": "Политика конфиденциальности",
   "terms": "Условия использования",
   "domains": "Этот выбор применяется к {{domains}}.",
-  "policyDomains": "Этот выбор применяется к следующим доменам:"
+  "policyDomains": "Этот выбор применяется к следующим доменам:",
+  "barTitle": "Файлы cookie на этом сайте",
+  "barDescription": "Мы используем необходимые файлы cookie для работы сайта — для входа, обеспечения безопасности и запоминания вашего выбора. С вашего согласия мы также использовали бы следующие необязательные файлы cookie: {{categories}}. Они остаются выключенными, пока вы их не разрешите, а свой выбор вы можете в любой момент изменить или отозвать в настройках файлов cookie.",
+  "barDescriptionEssential": "Этот сайт использует только необходимые файлы cookie — для входа, обеспечения безопасности и запоминания вашего выбора. Они не требуют согласия и не могут быть отключены.",
+  "acceptMandatory": "Принять только необходимые",
+  "locating": "Определяем ваш регион…",
+  "autoReason": "Эти настройки применены автоматически, поскольку там, откуда вы просматриваете сайт, согласие на файлы cookie не требуется. Вы можете изменить их в любой момент.",
+  "policyRegional": "Там, где закон места пребывания посетителя требует предварительного согласия, — в ЕС и ЕЭЗ, Великобритании, Швейцарии и других странах с аналогичными правилами — необязательные файлы cookie остаются выключенными, пока посетитель их не разрешит. В остальных странах они включены по умолчанию, кроме случаев, когда браузер передаёт сигнал Global Privacy Control, который учитывается как отказ; их можно отключить в любой момент кнопкой ниже."
 }

package/src/i18n/types.ts

@@ -0,0 +1,11 @@
+import type { ConsentLocale } from '../types.js'
+
+/** The dialog's built-in copy: the locale it is read in, the house translate shape, placeholders. */
+export interface ConsentI18nHelper {
+  /** A locale reduced to one the built-in copy carries — its base tag, else `en`. */
+  normalizeLocale: (locale?: string) => ConsentLocale
+  /** `(key, defaultValue) => string`, the house shape, backed by the built-in bundle. */
+  defaultConsentTranslate: (locale?: string) => (key: string, defaultValue: string) => string
+  /** Substitute `{{name}}` placeholders. Enough for the two the policy page needs. */
+  interpolate: (text: string, values: Record<string, string | number>) => string
+}

package/src/i18n/uk.json

@@ -32,5 +32,12 @@
   "privacy": "Політика конфіденційності",
   "terms": "Умови користування",
   "domains": "Цей вибір застосовується до {{domains}}.",
-  "policyDomains": "Цей вибір застосовується до таких доменів:"
+  "policyDomains": "Цей вибір застосовується до таких доменів:",
+  "barTitle": "Файли cookie на цьому сайті",
+  "barDescription": "Ми використовуємо необхідні файли cookie для роботи сайту — для входу, забезпечення безпеки та запам'ятовування вашого вибору. За вашою згодою ми також використовували б такі необов'язкові файли cookie: {{categories}}. Вони залишаються вимкненими, доки ви їх не дозволите, а свій вибір ви можете будь-коли змінити або відкликати в налаштуваннях файлів cookie.",
+  "barDescriptionEssential": "Цей сайт використовує лише необхідні файли cookie — для входу, забезпечення безпеки та запам'ятовування вашого вибору. Вони не потребують згоди й не можуть бути вимкнені.",
+  "acceptMandatory": "Прийняти лише необхідні",
+  "locating": "Визначаємо ваш регіон…",
+  "autoReason": "Ці налаштування застосовано автоматично, оскільки там, звідки ви переглядаєте сайт, згода на файли cookie не потрібна. Ви можете змінити їх будь-коли.",
+  "policyRegional": "Там, де закон місця перебування відвідувача вимагає попередньої згоди, — у ЄС і ЄЕЗ, Великій Британії, Швейцарії та інших країнах із подібними правилами — необов'язкові файли cookie залишаються вимкненими, доки відвідувач їх не дозволить. В інших країнах вони ввімкнені за замовчуванням, крім випадків, коли браузер надсилає сигнал Global Privacy Control, який враховується як відмова; їх можна будь-коли вимкнути кнопкою нижче."
 }

package/src/i18n.ts

@@ -1,39 +1,27 @@
-import { CONSENT_LOCALES } from './consts.js'
-import type { ConsentLocale } from './consts.js'
+import { CONSENT_LOCALES, DEFAULT_CONSENT_MESSAGES } from './consts.js'
+import type { ConsentLocale } from './types.js'
+import type { ConsentI18nHelper } from './i18n/types.js'
 
-import en from './i18n/en.json' with { type: 'json' }
-import pl from './i18n/pl.json' with { type: 'json' }
-import ru from './i18n/ru.json' with { type: 'json' }
-import be from './i18n/be.json' with { type: 'json' }
-import uk from './i18n/uk.json' with { type: 'json' }
-import es from './i18n/es.json' with { type: 'json' }
-import de from './i18n/de.json' with { type: 'json' }
-import fr from './i18n/fr.json' with { type: 'json' }
+export const createConsentI18nHelper = (): ConsentI18nHelper => {
+  const normalizeLocale = (locale?: string): ConsentLocale => {
+    const base = (locale ?? 'en').toLowerCase().split('-')[0]
 
-/**
- * The dialog's copy, in the box.
- *
- * Carried here rather than registered into an i18n framework because one of the three consumers is
- * an Astro site with React islands and no OwlMeans i18n at all — and a consent dialog that renders
- * raw keys is worse than no dialog. An application that HAS translations passes `translate` and
- * overrides every one of these.
- */
-export const DEFAULT_CONSENT_MESSAGES: Record<ConsentLocale, Record<string, string>> = {
-  en, pl, ru, be, uk, es, de, fr,
-}
+    return CONSENT_LOCALES.includes(base as ConsentLocale) ? base as ConsentLocale : 'en'
+  }
+
+  const defaultConsentTranslate = (locale?: string) =>
+    (key: string, defaultValue: string): string =>
+      DEFAULT_CONSENT_MESSAGES[normalizeLocale(locale)]?.[key] ?? defaultValue
 
-export const normalizeLocale = (locale?: string): ConsentLocale => {
-  const base = (locale ?? 'en').toLowerCase().split('-')[0]
+  const interpolate = (text: string, values: Record<string, string | number>): string =>
+    text.replace(/\{\{([a-z]+)\}\}/gi, (whole, name: string) =>
+      values[name] != null ? String(values[name]) : whole)
 
-  return CONSENT_LOCALES.includes(base as ConsentLocale) ? base as ConsentLocale : 'en'
+  return { normalizeLocale, defaultConsentTranslate, interpolate }
 }
 
-/** `(key, defaultValue) => string`, the house shape, backed by the built-in bundle. */
-export const defaultConsentTranslate = (locale?: string) =>
-  (key: string, defaultValue: string): string =>
-    DEFAULT_CONSENT_MESSAGES[normalizeLocale(locale)]?.[key] ?? defaultValue
+export const consentI18nHelper = createConsentI18nHelper()
 
-/** Substitute `{{name}}` placeholders. Enough for the two the policy page needs. */
-export const interpolate = (text: string, values: Record<string, string | number>): string =>
-  text.replace(/\{\{([a-z]+)\}\}/gi, (whole, name: string) =>
-    values[name] != null ? String(values[name]) : whole)
+/** @deprecated compat:factory-refactor — use `consentI18nHelper.defaultConsentTranslate(…)` */
+export const defaultConsentTranslate = (locale?: string): (key: string, defaultValue: string) => string =>
+  consentI18nHelper.defaultConsentTranslate(locale)

package/src/index.ts

@@ -1,17 +1,18 @@
 export type * from './types.js'
+export type * from './gtobserver/types.js'
+export type * from './i18n/types.js'
+export type * from './linker/types.js'
+export type * from './plugins/types.js'
+export type * from './storage/types.js'
+export type * from './geo/types.js'
 export * from './consts.js'
 export * from './storage.js'
-export * from './gtm.js'
+export * from './gtobserver.js'
 export * from './store.js'
 export * from './i18n.js'
-export type { ConsentPlugin } from './plugins.js'
-export {
-  registerConsentPlugin, consentPlugins, decorateConsentUrl, consentDomains, adoptConsent,
-  startConsentPlugins, adoptConsentLanguage,
-} from './plugins.js'
-export type { ConsentLinkPayload } from './linker.js'
-export {
-  consentLinker, encodeConsentLink, decodeConsentLink, stripConsentLinkParam, consentLinkerScript,
-  writeConsentLanguage,
-  CONSENT_LINK_PARAM, CONSENT_LINK_MAX_AGE, CONSENT_LINK_SKEW,
-} from './linker.js'
+export * from './geo.js'
+export type { ConsentPlugin } from './types.js'
+export { createConsentPluginHelper, consentPluginHelper, decorateConsentUrl } from './plugins.js'
+export type { ConsentLinkPayload } from './types.js'
+export { createConsentLinkHelper, consentLinkHelper, encodeConsentLink, consentLinkerScript } from './linker.js'
+export { CONSENT_LINK_PARAM, CONSENT_LINK_MAX_AGE, CONSENT_LINK_SKEW } from './consts.js'

package/src/linker/types.ts

@@ -0,0 +1,59 @@
+import type { ConsentLinkPayload, ConsentOptions, ConsentPlugin, ConsentRecord } from '../types.js'
+
+/** Cross-domain consent: the decorated-link parameter, the linker plugin and its inline twin. */
+export interface ConsentLinkHelper {
+  /**
+   * The link parameter's value: the current document's decision as `c` (one `0`/`1` per optional
+   * category — empty while `record` is `null`, i.e. before the visitor has decided, and for an
+   * automatic decision, which is not the visitor's to carry) and, when
+   * `opts.linker.language` is set, the page's language as `l`.
+   */
+  encodeConsentLink: (record: ConsentRecord | null, opts?: ConsentOptions) => string
+  /** Parse-only — no trust decision here, that is `consentLinker(opts).adopt`'s job. Never throws. */
+  decodeConsentLink: (value: string) => ConsentLinkPayload | null
+  /**
+   * Persist an adopted language where the application's i18n layer reads its explicit choice from —
+   * `linker.language.storageKey`, `owlmeans-lng` by default. Unconditional: the interface language is
+   * strictly necessary storage (the visitor picked it, and the site cannot speak to them without it),
+   * so no cookie decision — none yet, a refusal, an old record — stands between it and the device.
+   *
+   * It overwrites what is there on purpose: the carried language is the one the visitor was reading a
+   * moment ago, which outranks a choice they made on this domain some other day. Storage that refuses
+   * the write is not an error. Returns whether the language was written.
+   */
+  writeConsentLanguage: (language: string, opts?: ConsentOptions) => boolean
+  /**
+   * Cross-domain consent: share this decision, and adopt one, between the domains named in
+   * `opts.linker.domains`.
+   *
+   * `start` decorates outgoing first-party links; `adopt` reads and validates an incoming one;
+   * `domains` discloses the list a dialog or policy page names. `decorate` is generic (a bare `URL`,
+   * no DOM) so the same trust rule serves a real anchor click and a programmatic navigation
+   * (`decorateConsentUrl`) alike — the `rel="noreferrer"` exemption is a DOM-only concept and is
+   * therefore checked by `start`'s click handler, never here.
+   */
+  consentLinker: () => ConsentPlugin
+  /**
+   * Remove the link parameter from the visible URL, keeping every other parameter and the hash — the
+   * real-TS equivalent of what {@link consentLinkerScript}'s embedded fragment already did inline.
+   * Idempotent: a page with no head script calls this from `consentStore.init` and it strips once; a
+   * page that ALSO carried the head script finds the parameter already gone and does nothing.
+   */
+  stripConsentLinkParam: (opts: ConsentOptions) => void
+  /**
+   * The inline `<head>` fragment that adopts a decorated link's decision and strips the parameter —
+   * standalone, so a page can stamp it even where nothing else here runs (a legal page with no tag
+   * script). `@owlmeans/web-gtm`'s `consentBootstrapScript` embeds this SAME fragment right after
+   * pushing Consent Mode's defaults, so a page that has both never runs it twice with different
+   * effect — the second attempt finds the parameter already gone and does nothing.
+   *
+   * Mirrors `consentLinker().adopt` exactly (v2, referrer + freshness/skew + full optional coverage +
+   * no existing record — or only an automatic one, which the visitor's own choice replaces), but as hand-rolled JS text rather than a call into this module — the same
+   * discipline `consentBootstrapScript`/`consentGateScript` already follow, because this has to run
+   * before any bundle (this module included) has loaded. The parameter is ALWAYS stripped via
+   * `history.replaceState`, whether or not the trust rule accepts it: a stale or foreign `owlcc` is
+   * exactly as much noise as an adopted one, and neither belongs in the visible URL or in what a page
+   * reload, a shared link or a browser history entry carries forward.
+   */
+  consentLinkerScript: (opts: ConsentOptions) => string
+}