@peax/consent-banner-shared 0.4.0 → 0.6.0

package/README.md

@@ -8,4 +8,14 @@ The root exports `BannerOptions`, `BannerMsg`, preference section and navigation
 
 `transitionPreferencesView` receives explicit opening, dismissal, and controlled-input synchronization actions. Synchronize when visibility or floating-button availability changes; synchronizing on every render would discard a floating request awaiting application acknowledgement.
 
-ESM and TypeScript declarations are published at the root. Locales is the only dependency. There are no stylesheet exports or import-time side effects.
+ESM and TypeScript declarations are published at the root. There are no required dependencies and no dependency on the optional locales package. There are no stylesheet exports or import-time side effects.
+
+## Localization
+
+The root also exports `parseMessage`, `MessagePart`, `BannerMessages`, `BannerLocale`, `BuiltInPreferencesSectionId`, `PreferencesMessages`, `LocaleMessages`, `LocaleContent`, `PreferencesLocaleContent`, `BannerLocales`, `ResolvedLocaleContent`, `defaultEnglishLocale`, and `resolveLocaleContent`.
+
+`resolveLocaleContent(locale = 'en', locales?, hasContentOverrides = false)` returns `{ locale, banner, preferences }`. It matches normalized exact/base tags, fills missing copy from independent English defaults, and supports custom languages and preference IDs. No dictionary package is imported. Applications normally pass `locales`, `bannerContent`, and `preferencesContent` to their adapter instead of calling the helper directly.
+
+`parseMessage(message, allowlist)` returns ordered text/link parts with source offsets. The allowlist is required. Unknown, nested, attributed, or malformed placeholders remain literal text; messages are never interpreted as HTML. The parser moved here from locales without changing its behavior.
+
+See the [localization guide](https://github.com/peaxco/consent/blob/main/docs/localization.md).

package/dist/index.d.ts

@@ -1,6 +1,19 @@
-import { BannerMessages } from '@peax/consent-banner-locales';
-import { BuiltInPreferencesSectionId } from '@peax/consent-banner-locales';
-import { PreferencesMessages } from '@peax/consent-banner-locales';
+export declare type BannerLocale = 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'et' | 'fi' | 'fr' | 'ga' | 'hr' | 'hu' | 'it' | 'lt' | 'lv' | 'mt' | 'nl' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'sv';
+
+export declare type BannerLocales = Readonly<Record<string, LocaleContent | undefined>>;
+
+export declare type BannerMessages = Readonly<{
+    title: string;
+    collapsedText: string;
+    acceptAllLabel: string;
+    rejectAllLabel: string;
+    customizePreferencesLabel: string;
+    preferencesTitle: string;
+    preferencesText?: string;
+    closePreferencesLabel: string;
+    applyPreferencesLabel: string;
+    cookiePolicyLabel: string;
+}>;
 
 export declare type BannerMsg = PreferencesNavigationMsg | {
     type: 'on_accept_all' | 'on_reject_all';
@@ -21,6 +34,7 @@ export declare type BannerOptions = Placement & FloatingButtonOptions & {
     showCustomizePreferences?: boolean;
     variant?: 'compact' | 'stacked';
     locale?: string;
+    locales?: BannerLocales;
     cookiePolicyUrl?: string;
     bannerContent?: Partial<BannerMessages>;
     preferencesSections?: readonly PreferencesSectionId[];
@@ -28,6 +42,10 @@ export declare type BannerOptions = Placement & FloatingButtonOptions & {
     theme?: 'light' | 'dark' | 'auto';
 };
 
+export declare type BuiltInPreferencesSectionId = 'essential' | 'analytics' | 'marketing' | 'functional' | 'personalization' | 'social' | 'security';
+
+export declare const defaultEnglishLocale: LocaleMessages;
+
 export declare const defaultPreferencesSections: readonly ["essential", "analytics", "marketing"];
 
 export declare const entranceDuration = 0.36;
@@ -44,10 +62,33 @@ export declare type FloatingButtonOptions = {
 
 export declare type FloatingButtonPosition = 'left' | 'right';
 
+export declare type LocaleContent = Readonly<{
+    banner?: Partial<BannerMessages>;
+    preferences?: PreferencesLocaleContent;
+}>;
+
+/** Complete copy shipped by a built-in language entry. */
+export declare type LocaleMessages = Readonly<{
+    banner: BannerMessages;
+    preferences: PreferencesMessages;
+}>;
+
 export declare function mergeBannerContent(messages: BannerMessages, overrides?: Partial<BannerMessages>): BannerMessages;
 
+export declare type MessagePart<Link extends string = string> = Readonly<{
+    offset: number;
+    value: string;
+} & ({
+    type: 'text';
+} | {
+    type: 'link';
+    name: Link;
+})>;
+
 export declare function normalizeAppearanceDelay(delay: number): number;
 
+export declare function parseMessage<Link extends string>(message: string, links: readonly Link[]): MessagePart<Link>[];
+
 export declare type Placement = {
     position?: 'right';
     slideFrom?: 'bottom' | 'right';
@@ -59,6 +100,17 @@ export declare type Placement = {
     slideFrom?: 'bottom';
 };
 
+/** Application copy can translate custom sections and omit any field. */
+export declare type PreferencesLocaleContent = Readonly<Record<string, Readonly<{
+    title?: string;
+    text?: string;
+}> | undefined>>;
+
+export declare type PreferencesMessages = Readonly<Record<BuiltInPreferencesSectionId, Readonly<{
+    title: string;
+    text: string;
+}>>>;
+
 export declare type PreferencesNavigationMsg = {
     type: 'on_open_preferences' | 'on_close_preferences';
     source: PreferencesSource;
@@ -96,13 +148,22 @@ export declare type PreferencesViewAction = {
 /** Keep edits to surviving enabled sections; disabled values always follow the application. */
 export declare function reconcileDraft(sections: readonly ResolvedPreferencesSection[], draft?: ReadonlyMap<string, boolean>): Map<string, boolean>;
 
+export declare type ResolvedLocaleContent = Readonly<{
+    locale: string;
+    banner: BannerMessages;
+    preferences: PreferencesLocaleContent;
+}>;
+
 export declare type ResolvedPreferencesSection = Required<PreferencesSection> & {
     readonly id: PreferencesSectionId;
 };
 
 export declare function resolveFloatingPosition(position: string | undefined, override?: FloatingButtonPosition): FloatingButtonPosition;
 
-export declare function resolveSections(ids: readonly PreferencesSectionId[], content: Readonly<Partial<Record<PreferencesSectionId, PreferencesSection>>> | undefined, messages: PreferencesMessages): ResolvedPreferencesSection[];
+/** Resolve application-owned dictionaries without importing the optional locales package. */
+export declare function resolveLocaleContent(locale?: string, locales?: BannerLocales, hasContentOverrides?: boolean): ResolvedLocaleContent;
+
+export declare function resolveSections(ids: readonly PreferencesSectionId[], content: Readonly<Partial<Record<PreferencesSectionId, PreferencesSection>>> | undefined, messages: PreferencesLocaleContent): ResolvedPreferencesSection[];
 
 export declare function resolveSlideFrom(position: string, slideFrom: string): 'bottom' | 'left' | 'right';
 

package/dist/index.js

@@ -1,10 +1,137 @@
+//#region src/defaultEnglishLocale.ts
+var e = {
+	banner: {
+		title: "We use cookies",
+		collapsedText: "We use cookies to learn how you interact with our content to make your experience better with <cookiePolicy>Cookie Policy</cookiePolicy> in place.",
+		acceptAllLabel: "Accept all",
+		rejectAllLabel: "Reject all",
+		customizePreferencesLabel: "Customize preferences",
+		preferencesTitle: "Cookie Preferences",
+		closePreferencesLabel: "Close preferences",
+		applyPreferencesLabel: "Apply preferences",
+		cookiePolicyLabel: "Cookie policy"
+	},
+	preferences: {
+		essential: {
+			title: "Essential",
+			text: "Essential cookies are used to ensure the proper functioning of the website. They are necessary and cannot be disabled."
+		},
+		analytics: {
+			title: "Analytics",
+			text: "Analytical cookies are used to analyze performance and user behaviour to provide the most relevant experience. We use analytics tools to collect and analyze this data."
+		},
+		marketing: {
+			title: "Marketing",
+			text: "Marketing cookies are used to show relevant advertisements and measure the effectiveness of advertising campaigns."
+		},
+		functional: {
+			title: "Functional",
+			text: "Functional cookies enable optional website features, such as embedded videos and live chat."
+		},
+		personalization: {
+			title: "Personalization",
+			text: "Personalization cookies remember your preferences and adapt content and recommendations to your interests."
+		},
+		social: {
+			title: "Social media",
+			text: "Social media cookies enable sharing features and embedded content from social platforms. These platforms may use them to track your activity across websites."
+		},
+		security: {
+			title: "Security",
+			text: "Security cookies support optional fraud detection and additional protection features. Cookies required for basic website security are included under Essential."
+		}
+	}
+}, t = .36, n = [
+	.16,
+	1,
+	.3,
+	1
+];
+function r(e, t) {
+	return t ?? (e === "left" ? "left" : "right");
+}
+function i(e, t) {
+	return t === e && (t === "left" || t === "right") ? t : "bottom";
+}
+function a(e) {
+	return Number.isFinite(e) ? Math.max(0, e) : 0;
+}
+function o(e, t) {
+	return {
+		...e,
+		...Object.fromEntries(Object.entries(t ?? {}).filter(([, e]) => e != null))
+	};
+}
+function s(e) {
+	if (e?.trim()) try {
+		let t = new URL(e, "https://consent.invalid");
+		return t.protocol === "http:" || t.protocol === "https:" ? e : void 0;
+	} catch {
+		return;
+	}
+}
+//#endregion
+//#region src/localization.ts
+function c(t = "en", n, r = !1) {
+	let i = t.trim().toLowerCase() || "en", a = new Map(Object.entries(n ?? {}).map(([e, t]) => [e.trim().toLowerCase(), t])), s = i.split("-")[0] ?? i, c = a.get(i) ? i : a.get(s) ? s : void 0, l = { ...c ? a.get(c) : void 0 }, u = new Map(Object.entries(e.preferences)), d = new Map(Object.entries(l?.preferences ?? {})), f = /* @__PURE__ */ new Set([...u.keys(), ...d.keys()]), p = Object.fromEntries([...f].map((e) => {
+		let t = u.get(e), n = { ...d.get(e) };
+		return [e, {
+			title: n?.title?.trim() ? n.title : t?.title ?? e,
+			text: n?.text ?? t?.text ?? ""
+		}];
+	}));
+	return {
+		locale: c ?? (r ? i : "en"),
+		banner: o(e.banner, l?.banner),
+		preferences: p
+	};
+}
+//#endregion
+//#region src/parseMessage.ts
+function l(e, t) {
+	let n = [], r = t.map((e) => ({
+		name: e,
+		opening: `<${e}>`,
+		closing: `</${e}>`
+	})), i = 0, a = 0;
+	for (; a < e.length;) {
+		let t;
+		for (let n of r) {
+			let r = e.indexOf(n.opening, a);
+			r !== -1 && (!t || r < t.start) && (t = {
+				...n,
+				start: r
+			});
+		}
+		if (!t) break;
+		let { name: o, opening: s, closing: c, start: l } = t, u = e.indexOf(c, l + s.length);
+		if (u === -1) break;
+		let d = e.slice(l + s.length, u);
+		a = u + c.length, !/[<>]/.test(d) && (l > i && n.push({
+			type: "text",
+			value: e.slice(i, l),
+			offset: i
+		}), n.push({
+			type: "link",
+			name: o,
+			value: d,
+			offset: l
+		}), i = a);
+	}
+	return i < e.length && n.push({
+		type: "text",
+		value: e.slice(i),
+		offset: i
+	}), n;
+}
+//#endregion
 //#region src/preferences.ts
-var e = [
+var u = [
 	"essential",
 	"analytics",
 	"marketing"
 ];
-function t(e, t, n) {
+function d(e, t, n) {
 	let r = new Map(Object.entries(n));
 	return [...new Set(e.filter((e) => e.trim()))].map((e) => {
 		let n = r.get(e), i = t && Object.hasOwn(t, e) ? t[e] : void 0;
@@ -17,10 +144,10 @@ function t(e, t, n) {
 		};
 	});
 }
-function n(e, t = /* @__PURE__ */ new Map()) {
+function f(e, t = /* @__PURE__ */ new Map()) {
 	return new Map(e.map((e) => [e.id, e.disabled ? e.checked : t.get(e.id) ?? e.checked]));
 }
-function r(e, t) {
+function p(e, t) {
 	switch (t.type) {
 		case "open": return t.source === "banner" ? { source: "banner" } : {
 			source: "floating-button",
@@ -31,35 +158,4 @@ function r(e, t) {
 	}
 }
 //#endregion
-//#region src/presentation.ts
-var i = .36, a = [
-	.16,
-	1,
-	.3,
-	1
-];
-function o(e, t) {
-	return t ?? (e === "left" ? "left" : "right");
-}
-function s(e, t) {
-	return t === e && (t === "left" || t === "right") ? t : "bottom";
-}
-function c(e) {
-	return Number.isFinite(e) ? Math.max(0, e) : 0;
-}
-function l(e, t) {
-	return {
-		...e,
-		...Object.fromEntries(Object.entries(t ?? {}).filter(([, e]) => e != null))
-	};
-}
-function u(e) {
-	if (e?.trim()) try {
-		let t = new URL(e, "https://consent.invalid");
-		return t.protocol === "http:" || t.protocol === "https:" ? e : void 0;
-	} catch {
-		return;
-	}
-}
-//#endregion
-export { e as defaultPreferencesSections, i as entranceDuration, a as entranceEase, l as mergeBannerContent, c as normalizeAppearanceDelay, n as reconcileDraft, o as resolveFloatingPosition, t as resolveSections, s as resolveSlideFrom, u as safeHref, r as transitionPreferencesView };
+export { e as defaultEnglishLocale, u as defaultPreferencesSections, t as entranceDuration, n as entranceEase, o as mergeBannerContent, a as normalizeAppearanceDelay, l as parseMessage, f as reconcileDraft, r as resolveFloatingPosition, c as resolveLocaleContent, d as resolveSections, i as resolveSlideFrom, s as safeHref, p as transitionPreferencesView };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peax/consent-banner-shared",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Framework-independent presentation contracts and UI state helpers for Peax Consent banners.",
   "license": "Apache-2.0",
   "homepage": "https://github.com/peaxco/consent",
@@ -38,14 +38,11 @@
     }
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.59.0",
-    "@types/node": "^26.3.0",
+    "@microsoft/api-extractor": "^7.59.3",
+    "@types/node": "^26.6.4",
     "typescript": "5.9.3",
-    "vite": "^8.2.2",
-    "vite-plugin-dts": "^5.0.3",
-    "vitest": "^4.1.11"
-  },
-  "dependencies": {
-    "@peax/consent-banner-locales": "^0.4.0"
+    "vite": "^8.3.2",
+    "vite-plugin-dts": "^5.1.1",
+    "vitest": "^5.0.3"
   }
 }