@owlmeans/consent 0.1.18-rc.9 → 0.1.18

package/build/index.d.ts

@@ -1,11 +1,19 @@
 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';
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,YAAY,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EACL,qBAAqB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EACvF,mBAAmB,EAAE,oBAAoB,GAC1C,MAAM,cAAc,CAAA;AACrB,YAAY,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EACL,aAAa,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,mBAAmB,EAC/F,oBAAoB,EACpB,kBAAkB,EAAE,oBAAoB,EAAE,iBAAiB,GAC5D,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,YAAY,CAAA;AAC/B,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,iBAAiB,CAAA;AACpC,mBAAmB,mBAAmB,CAAA;AACtC,mBAAmB,oBAAoB,CAAA;AACvC,mBAAmB,oBAAoB,CAAA;AACvC,mBAAmB,gBAAgB,CAAA;AACnC,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjG,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAChH,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA"}

package/build/index.js

@@ -1,8 +1,10 @@
 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 { registerConsentPlugin, consentPlugins, decorateConsentUrl, consentDomains, adoptConsent, startConsentPlugins, adoptConsentLanguage, } from './plugins.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 { createConsentPluginHelper, consentPluginHelper, decorateConsentUrl } from './plugins.js';
+export { createConsentLinkHelper, consentLinkHelper, encodeConsentLink, consentLinkerScript } from './linker.js';
+export { CONSENT_LINK_PARAM, CONSENT_LINK_MAX_AGE, CONSENT_LINK_SKEW } from './consts.js';
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AAEzB,OAAO,EACL,qBAAqB,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EACvF,mBAAmB,EAAE,oBAAoB,GAC1C,MAAM,cAAc,CAAA;AAErB,OAAO,EACL,aAAa,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,mBAAmB,EAC/F,oBAAoB,EACpB,kBAAkB,EAAE,oBAAoB,EAAE,iBAAiB,GAC5D,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AAExB,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEjG,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAChH,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA"}

package/build/linker/types.d.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;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/linker/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/linker/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEnG,iGAAiG;AACjG,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE,cAAc,KAAK,MAAM,CAAA;IAClF,oGAAoG;IACpG,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,kBAAkB,GAAG,IAAI,CAAA;IAC/D;;;;;;;;;OASG;IACH,oBAAoB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,KAAK,OAAO,CAAA;IAC1E;;;;;;;;;OASG;IACH,aAAa,EAAE,MAAM,aAAa,CAAA;IAClC;;;;;OAKG;IACH,qBAAqB,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAA;IACrD;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,MAAM,CAAA;CACtD"}

package/build/linker/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/linker/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/linker/types.ts"],"names":[],"mappings":""}

package/build/linker.d.ts

@@ -1,78 +1,9 @@
-import type { ConsentPlugin } from './plugins.js';
 import type { ConsentOptions, ConsentRecord } from './types.js';
-/** The URL parameter a decorated link carries the decision in, absent an override. */
-export declare const CONSENT_LINK_PARAM = "owlcc";
-/** How old a decorated link's timestamp may be and still be trusted, in seconds, absent an override. */
-export declare const CONSENT_LINK_MAX_AGE = 300;
-/** Clock skew allowed the OTHER way — a timestamp up to this far in the future is still trusted. */
-export declare const CONSENT_LINK_SKEW = 60;
-declare const CONSENT_LINK_VERSION = 2;
-/** The decoded, not-yet-validated payload a decorated link's parameter carries. */
-export interface ConsentLinkPayload {
-    v: typeof CONSENT_LINK_VERSION;
-    /** One entry per OPTIONAL category this site knows, `1` granted / `0` denied. */
-    c: Record<string, 0 | 1>;
-    /** Unix seconds the link was decorated at. */
-    t: number;
-    /**
-     * The interface language of the page the link was on (a BCP 47 tag, lower-cased) — present only
-     * when the sender has `linker.language` set and its `<html lang>` names one. Optional on the
-     * wire, so a receiver that predates it reads the same `v: 2` payload and ignores the field.
-     */
-    l?: string;
-}
-/**
- * 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, when
- * `opts.linker.language` is set, the page's language as `l`.
- */
+import type { ConsentLinkHelper } from './linker/types.js';
+export declare const createConsentLinkHelper: () => ConsentLinkHelper;
+export declare const consentLinkHelper: ConsentLinkHelper;
+/** @deprecated compat:factory-refactor — use `consentLinkHelper.encodeConsentLink(…)` */
 export declare const encodeConsentLink: (record: ConsentRecord | null, opts?: ConsentOptions) => string;
-/** Parse-only — no trust decision here, that is `consentLinker(opts).adopt`'s job. Never throws. */
-export declare const 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.
- */
-export declare const 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.
- */
-export declare const 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.
- */
-export declare const 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), 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.
- */
+/** @deprecated compat:factory-refactor — use `consentLinkHelper.consentLinkerScript(…)` */
 export declare const consentLinkerScript: (opts: ConsentOptions) => string;
-export {};
 //# sourceMappingURL=linker.d.ts.map

package/build/linker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"linker.d.ts","sourceRoot":"","sources":["../src/linker.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAGjD,OAAO,KAAK,EAAmB,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAEhF,sFAAsF;AACtF,eAAO,MAAM,kBAAkB,UAAU,CAAA;AACzC,wGAAwG;AACxG,eAAO,MAAM,oBAAoB,MAAM,CAAA;AACvC,oGAAoG;AACpG,eAAO,MAAM,iBAAiB,KAAK,CAAA;AAEnC,QAAA,MAAM,oBAAoB,IAAI,CAAA;AAE9B,mFAAmF;AACnF,MAAM,WAAW,kBAAkB;IACjC,CAAC,EAAE,OAAO,oBAAoB,CAAA;IAC9B,iFAAiF;IACjF,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;IACxB,8CAA8C;IAC9C,CAAC,EAAE,MAAM,CAAA;IACT;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;CACX;AAqCD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,WAAY,aAAa,GAAG,IAAI,SAAS,cAAc,KAAG,MAavF,CAAA;AAED,oGAAoG;AACpG,eAAO,MAAM,iBAAiB,UAAW,MAAM,KAAG,kBAAkB,GAAG,IAuBtE,CAAA;AAyDD;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,aAAc,MAAM,SAAS,cAAc,KAAG,OAS9E,CAAA;AAQD;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,QAAO,aA2FhC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,SAAU,cAAc,KAAG,IAgB5D,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,SAAU,cAAc,KAAG,MA2D1D,CAAA"}
+{"version":3,"file":"linker.d.ts","sourceRoot":"","sources":["../src/linker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAkC,cAAc,EAAE,aAAa,EAAsB,MAAM,YAAY,CAAA;AAInH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAE1D,eAAO,MAAM,uBAAuB,QAAO,iBA6U1C,CAAA;AAED,eAAO,MAAM,iBAAiB,mBAA4B,CAAA;AAE1D,yFAAyF;AACzF,eAAO,MAAM,iBAAiB,WAAY,aAAa,GAAG,IAAI,SAAS,cAAc,KAAG,MACrC,CAAA;AAEnD,2FAA2F;AAC3F,eAAO,MAAM,mBAAmB,SAAU,cAAc,KAAG,MAAqD,CAAA"}