@emplugins/emprivacy 3.0.0 → 3.2.0

package/README.md

@@ -87,7 +87,7 @@ The legacy unscoped package `emprivacy` is deprecated; migrate imports to `@empl
 
 5. **Create a Privacy Policy Page** (and optional Cookie Policy Page) in EmDash, then in admin (shield → **EmPrivacy**) set the public path (`/privacy`) or an `https://` URL.
 
-6. Pick an analytics preset (Cloudflare, Plausible, Fathom, Umami, Simple Analytics, GA4, GTM, None, or Custom), optional marketing script URLs, and **Save**.
+6. Pick an analytics preset (Cloudflare, Plausible, Fathom, Umami, Simple Analytics, GA4, GTM, Microsoft Clarity, Microsoft UET, None, or Custom), optional marketing script URLs, and **Save**.
 
 Visitors see a banner on first visit, when **Policy / consent version** changes, or when an older cookie is missing the functional flag (`f`). Existing `{ v, a, m }` cookies are treated as expired so visitors choose the new category.
 
@@ -97,7 +97,8 @@ After the banner script runs:
 
 ```ts
 window.emprivacy.get();
-// { v, essential: true, functional, analytics, marketing } | null
+// { v, essential: true, functional, analytics, marketing, gpc } | null
+// gpc is true when Global Privacy Control forced marketing off
 
 window.emprivacy.has("analytics"); // boolean
 window.emprivacy.open();           // reopen the panel
@@ -113,16 +114,21 @@ stop();
 |--------|-------------|
 | Categories | Essential (always on), **Functional**, **Analytics**, **Marketing** |
 | Privacy / cookie links | EmDash **Page** path or `https://` URL; resolved with `ctx.url()` |
-| Analytics presets | Cloudflare Web Analytics, Plausible, Fathom, Umami, Simple Analytics, GA4, **GTM (Marketing)**, None, Custom `https` URLs (+ optional SRI / host allowlist) |
+| Analytics presets | Cloudflare Web Analytics, Plausible, Fathom, Umami, Simple Analytics, GA4, **GTM (Marketing)**, **Microsoft Clarity (Analytics)**, **Microsoft UET (Marketing)**, None, Custom `https` URLs (SRI and script host allowlist required) |
 | Marketing scripts | Only **https** URLs you list, injected as `<script src>` after marketing consent |
 | Official embeds | Optional placeholders for `@emdash-cms/plugin-embeds` block types; YouTube/Vimeo use allowlisted player URLs (`youtube-nocookie`, `player.vimeo.com`); client re-checks URLs before mount |
 | Re-open preferences | Cookie button (bottom-left); saving reloads so script loading matches the latest choice |
 | Consent cookie | `emprivacy_cc` (`path=/`, `SameSite=Lax`, `Secure` on HTTPS, configurable `Max-Age`, default 180 days), JSON `{ v, f, a, m }` |
 | Vendor list | Derived from settings; shown under Customize; JSON at `/_emdash/api/plugins/emprivacy/vendors` (no tokens) |
-| Optional server log | POST `{ policyVersion, functional, analytics, marketing }` to `/_emdash/api/plugins/emprivacy/record` (Origin / Sec-Fetch-Site, rate-limited, no IP) |
+| Optional server log | POST `{ policyVersion, functional, analytics, marketing, gpc }` to `/_emdash/api/plugins/emprivacy/record` (Origin / Sec-Fetch-Site, rate-limited, no IP). Signed-in admins can download `/_emdash/api/plugins/emprivacy/consent-export` as CSV |
+| Global Privacy Control | When `navigator.globalPrivacyControl` is true, Marketing stays off (including Accept all) until the signal is gone. Analytics is unchanged. Visitors can still open preferences |
+| Cookie cleanup | Turning Analytics or Marketing off expires a fixed list of first-party cookie names for the presets EmPrivacy loads. The consent cookie is kept. HttpOnly and third-party cookies cannot be cleared from the page |
+| Keyboard | Focus moves into the banner. Tab stays inside it. Escape closes the reopen panel and returns focus to the cookie button. The first visit stays open until a choice |
 | Google Consent Mode v2 | Optional denied defaults in `<head>` + `gtag('consent','update',…)` including `functionality_storage` |
+| Microsoft consent | Clarity and UET presets queue denied signals in `<head>`. The Clarity tag loads only after Analytics consent; the UET tag loads only after Marketing consent |
 | i18n | Built-in chrome for common locales; optional JSON title/message overrides |
-| Theme | Hex CSS variables (`--emprivacy-bg`, `--emprivacy-text`, `--emprivacy-accent`, `--emprivacy-radius`) |
+| Theme | Starts on the Slate profile. Also Paper, Ink, Indigo, Primer, or custom hex. Custom opens with the colors already in effect. Profiles use fixed colors only |
+| Banner position | Fixed to the bottom (default) or top of the viewport. The fragment still renders at `body:end` |
 
 ## Capabilities
 

package/dist/index.d.mts

@@ -50,6 +50,16 @@ type AnalyticsLoader = {
 {
   type: "gtm";
   containerId: string;
+} |
+/** Loaded only after Analytics consent. Advertising storage follows Marketing. */
+{
+  type: "clarity";
+  projectId: string;
+} |
+/** Loaded only after Marketing consent. */
+{
+  type: "uet";
+  tagId: string;
 };
 export declare function buildAnalyticsLoader(cfg: EmprivacyConfig): AnalyticsLoader;
 export declare function buildVendorList(cfg: EmprivacyConfig): VendorRow[];
@@ -74,6 +84,7 @@ interface EmprivacyChromeStrings {
   embedNeedConsent: string;
   vendorsHeading: string;
   whatWeUse: string;
+  gpcNote: string;
 }
 interface EmprivacyLocaleCopy {
   bannerTitle: string;
@@ -88,11 +99,46 @@ interface EmprivacyTheme {
   accent: string;
   radiusPx: number;
 }
+/** Fixed banner palettes. Colors are constants, never taken from the admin form. */
+declare const THEME_PROFILES: {
+  readonly slate: {
+    readonly bg: "#0f172a";
+    readonly text: "#f8fafc";
+    readonly accent: "#3b82f6";
+    readonly radiusPx: 8;
+  };
+  readonly paper: {
+    readonly bg: "#f7f6f3";
+    readonly text: "#37352f";
+    readonly accent: "#1d4ed8";
+    readonly radiusPx: 6;
+  };
+  readonly ink: {
+    readonly bg: "#000000";
+    readonly text: "#ededed";
+    readonly accent: "#0070f3";
+    readonly radiusPx: 8;
+  };
+  readonly indigo: {
+    readonly bg: "#ffffff";
+    readonly text: "#0f172a";
+    readonly accent: "#4f46e5";
+    readonly radiusPx: 12;
+  };
+  readonly primer: {
+    readonly bg: "#f6f8fa";
+    readonly text: "#1f2328";
+    readonly accent: "#0969da";
+    readonly radiusPx: 6;
+  };
+};
+type ThemeProfileId = keyof typeof THEME_PROFILES;
+type ThemeChoice = ThemeProfileId | "custom";
 //#endregion
 //#region src/config.d.ts
 export declare const KV_KEY: "consent:config";
 export declare const COOKIE_NAME: "emprivacy_cc";
-type AnalyticsProvider = "cloudflare" | "none" | "custom" | "plausible" | "fathom" | "umami" | "simpleanalytics" | "ga4" | "gtm";
+type AnalyticsProvider = "cloudflare" | "none" | "custom" | "plausible" | "fathom" | "umami" | "simpleanalytics" | "ga4" | "gtm" | "clarity" | "uet";
 type EmbedCategory = "functional" | "marketing";
 interface EmprivacyConfig {
   bannerTitle: string;
@@ -125,10 +171,15 @@ interface EmprivacyConfig {
   /** Optional SRI hashes keyed by script src (sha256/384/512-…) */
   scriptIntegrity: Record<string, string>;
   /**
-   * When non-empty, Custom analytics and marketing script hosts must be on this list.
-   * Preset CDN hosts remain allowed for built-in providers.
+   * Hostnames allowed for Custom analytics, Umami, and marketing scripts.
+   * An empty list denies those URLs. Preset CDN hosts stay allowed for built-in providers.
    */
   scriptHostAllowlist: string[];
+  /**
+   * Hosts that may become https links for Mastodon and link previews.
+   * X, Bluesky, Gist, YouTube, and Vimeo do not use this list.
+   */
+  embedHostAllowlist: string[];
   /** Consent cookie Max-Age in days (1–365, default 180) */
   cookieMaxAgeDays: number;
   /** Emit Google Consent Mode v2 defaults (denied) in head; updates after choice */
@@ -141,10 +192,15 @@ interface EmprivacyConfig {
   gateEmbeds: boolean;
   /** Hide the first-visit banner on privacy/cookie policy paths */
   hideBannerOnPolicyPages: boolean;
+  /** Viewport edge for the fixed consent banner. Fragment placement stays `body:end`. */
+  bannerPosition: BannerPosition;
   defaultLocale: string;
   localeOverrides: LocaleOverrides;
+  /** `custom` uses `theme`. A profile id replaces `theme` with that profile’s fixed colors. */
+  themeProfile: ThemeChoice;
   theme: EmprivacyTheme;
 }
+type BannerPosition = "bottom" | "top";
 export declare const DEFAULT_CONFIG: EmprivacyConfig;
 /** Reject characters that would break JSON or attributes; allow typical Cloudflare site token strings. */
 export declare function assertValidCloudflareToken(t: string): void;
@@ -167,6 +223,8 @@ interface ConsentRecordPayload {
   functional: boolean;
   analytics: boolean;
   marketing: boolean;
+  /** Present when the browser's Global Privacy Control signal forced marketing off. */
+  gpc?: boolean;
 }
 interface ConsentState {
   v: string;
@@ -195,6 +253,7 @@ interface EmprivacyPublicRuntimeConfig {
   embedCategory: EmbedCategory;
   gateEmbeds: boolean;
   hideBanner: boolean;
+  bannerPosition: BannerPosition;
   theme: EmprivacyTheme;
   ui: EmprivacyChromeStrings;
   loader: AnalyticsLoader;
@@ -203,6 +262,7 @@ interface EmprivacyPublicRuntimeConfig {
     integrity: string | null;
   }[];
   scriptHostAllowlist: string[];
+  embedHostAllowlist: string[];
   scriptIntegrity: Record<string, string>;
   cookieMaxAge: number;
   vendors: VendorPublicRow[];
@@ -259,4 +319,4 @@ export declare function resolveEmbed(node: {
  */
 export declare function emprivacyPlugin(): PluginDescriptor;
 //#endregion
-export { type AnalyticsLoader, type AnalyticsProvider, type ConsentRecordPayload, type ConsentState, type EmbedCategory, type EmprivacyBrowserApi, type EmprivacyCategory, type EmprivacyConfig, type EmprivacyPublicRuntimeConfig, type ResolvedEmbed, type VendorPublicRow, type VendorRow, createPlugin as default };
+export { type AnalyticsLoader, type AnalyticsProvider, type BannerPosition, type ConsentRecordPayload, type ConsentState, type EmbedCategory, type EmprivacyBrowserApi, type EmprivacyCategory, type EmprivacyConfig, type EmprivacyPublicRuntimeConfig, type ResolvedEmbed, type VendorPublicRow, type VendorRow, createPlugin as default };