@tilli-pro/cookieconsent-plugin 0.6.0 → 0.7.23

package/src/init/tilli-pay-website.ts

@@ -0,0 +1,221 @@
+import type { CookieConsentConfig } from "@tilli-pro/cookieconsent";
+
+import _config from "../config";
+import { run } from "../init";
+import {
+  makeInitFn,
+  stripInvalidLinkedCategoriesFromTranslations,
+} from "./utils";
+
+// TODO: migrate from monay.com to tillipay.com
+
+const categories: CookieConsentConfig["categories"] = {
+  necessary: {
+    enabled: true, // "necessary" category is always enabled.
+    readOnly: true,
+    services: {
+      "Session": {
+        label: "Session",
+        cookies: [
+          {
+            name: /^(_scc_session)/, // session ID for core functionality
+          },
+        ],
+      },
+    },
+  },
+  functional: {
+    services: {
+      "Hubspot": {
+        label: "Hubspot",
+        cookies: [
+          {
+            name: /^(messagesUtk)/, // Hubspot (chat user identity)
+            domain: ".monay.com",
+          },
+        ],
+      },
+    },
+    autoClear: {
+      // TODO: DRY this with the services above
+      cookies: [
+        /** Hubspot */
+        {
+          name: /^(messagesUtk)/, // Hubspot (chat user identity)
+          domain: ".monay.com",
+        },
+      ],
+    },
+  },
+  analytics: {
+    services: {
+      "Google Analytics": {
+        label: "Google Analytics",
+        cookies: [
+          {
+            name: /^(_ga_)/, // Google Analytics
+            domain: "tilli.pro",
+          },
+        ],
+      },
+      "TelemetryDeck": {
+        label: "TelemetryDeck",
+        cookies: [
+          {
+            name: /^(_tccl_)/, // TelemetryDeck
+            domain: "tilli.pro",
+          },
+        ],
+      },
+    },
+    autoClear: {
+      // TODO: DRY this with the services above
+      cookies: [
+        /** Google Analytics */
+        {
+          name: /^(_ga_)/, // Google Analytics
+          domain: "tilli.pro",
+        },
+
+        /** TelemetryDeck */
+        {
+          name: /^(_tccl_)/, // TelemetryDeck
+          domain: "tilli.pro",
+        },
+      ],
+    },
+  },
+  marketing: {
+    services: {
+      "Hubspot": {
+        label: "Hubspot",
+        cookies: [
+          {
+            name: /^(__hs)/, // Hubspot (Session Tracking)
+            domain: "tilli.pro",
+          },
+          {
+            name: /^(hubspotutk)/, // Hubspot (User Tracking)
+            domain: "tilli.pro",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Analytics - Cloudfare)
+            domain: ".hs-analytics.net",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Banner - Cloudfare)
+            domain: ".hs-banner.com",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Scripts - Cloudfare)
+            domain: ".hs-scripts.com",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Adspixel - Cloudfare)
+            domain: ".hsadspixel.net",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Twitter - Cloudfare)
+            domain: ".t.co",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (User Messages - Cloudfare)
+            domain: ".usermessages.com",
+          },
+          {
+            name: /^(_cfuvid)/, // Hubspot (Visitor ID - Cloudfare)
+            domain: ".hubspot.com",
+          },
+        ],
+      },
+      "Facebook": {
+        label: "Facebook",
+        cookies: [
+          {
+            name: /^(_fb)/, // Facebook (ads)
+            domain: "tilli.pro",
+          },
+        ],
+      },
+      "Twitter": {
+        label: "Twitter",
+        cookies: [
+          {
+            name: /^(muc_ads)/, // Twitter (ads)
+            domain: ".t.co",
+          },
+        ],
+      },
+    },
+    autoClear: {
+      // TODO: DRY this with the services above
+      cookies: [
+        /** Hubspot */
+        {
+          name: /^(__hs)/, // Hubspot (Session Tracking)
+          domain: "tilli.pro",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Analytics - Cloudfare)
+          domain: ".hs-analytics.net",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Banner - Cloudfare)
+          domain: ".hs-banner.com",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Scripts - Cloudfare)
+          domain: ".hs-scripts.com",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Adspixel - Cloudfare)
+          domain: ".hsadspixel.net",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Twitter - Cloudfare)
+          domain: ".t.co",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (User Messages - Cloudfare)
+          domain: ".usermessages.com",
+        },
+        {
+          name: /^(_cfuvid)/, // Hubspot (Visitor ID - Cloudfare)
+          domain: ".hubspot.com",
+        },
+
+        /** Facebook */
+        {
+          name: /^(_fb)/, // Facebook (ads)
+          domain: "tilli.pro",
+        },
+
+        /** Twitter */
+        {
+          name: /^(muc_ads)/, // Twitter (ads)
+          domain: ".t.co",
+        },
+      ],
+    },
+  },
+};
+
+// TODO: DRY further w/ `./brf.ts`
+const language: CookieConsentConfig["language"] = {
+  ..._config.language,
+  translations: stripInvalidLinkedCategoriesFromTranslations(
+    _config.language.translations,
+    categories,
+    true, // clear cookie tables // FIXME: refactor this to actually just use the proper cookie table accoring to the categories var
+  ),
+};
+
+const config: CookieConsentConfig = {
+  ..._config,
+  categories,
+  language,
+};
+
+// console.debug({ config }, "Initializing Cookie Consent (tilli Website)...");
+const init = makeInitFn(run, config);
+void init();

package/src/init/tilli-pay.ts

@@ -0,0 +1,35 @@
+import type { CookieConsentConfig } from "@tilli-pro/cookieconsent";
+
+import _config from "../config";
+import { run } from "../init";
+import {
+  makeInitFn,
+  stripInvalidLinkedCategoriesFromTranslations,
+} from "./utils";
+
+const categories: CookieConsentConfig["categories"] = {
+  necessary: {
+    enabled: true, // "necessary" category is always enabled.
+    readOnly: true,
+  },
+};
+
+// TODO: DRY further w/ `./brf.ts`
+const language: CookieConsentConfig["language"] = {
+  ..._config.language,
+  translations: stripInvalidLinkedCategoriesFromTranslations(
+    _config.language.translations,
+    categories,
+    true, // clear cookie tables // FIXME: refactor this to actually just use the proper cookie table accoring to the categories var
+  ),
+};
+
+const config: CookieConsentConfig = {
+  ..._config,
+  categories,
+  language,
+};
+
+// console.debug({ config }, "Initializing Cookie Consent (tilli Website)...");
+const init = makeInitFn(run, config);
+void init();

package/src/init/tilli-website.ts

@@ -11,9 +11,199 @@ const categories: CookieConsentConfig["categories"] = {
   necessary: {
     enabled: true, // "necessary" category is always enabled.
     readOnly: true,
+    services: {
+      "Session": {
+        label: "Session",
+        cookies: [
+          {
+            name: /^(_scc_session)/, // session ID for core functionality
+          },
+        ],
+      },
+    },
+  },
+  analytics: {
+    services: {
+      "Google Analytics": {
+        label: "Google Analytics",
+        cookies: [
+          {
+            name: /^(_ga_)/, // Google Analytics
+            domain: "tilli.pro",
+          },
+        ],
+      },
+      "TelemetryDeck": {
+        label: "TelemetryDeck",
+        cookies: [
+          {
+            name: /^(_tccl_)/, // TelemetryDeck
+            domain: "tilli.pro",
+          },
+        ],
+      },
+    },
+    autoClear: {
+      // TODO: DRY this with the services above
+      cookies: [
+        /** Google Analytics */
+        {
+          name: /^(_ga_)/, // Google Analytics
+          domain: "tilli.pro",
+        },
+
+        /** TelemetryDeck */
+        {
+          name: /^(_tccl_)/, // TelemetryDeck
+          domain: "tilli.pro",
+        },
+      ],
+    },
+  },
+  marketing: {
+    services: {
+      "Google Tag Manager": {
+        label: "Google Tag Manager",
+        cookies: [
+          {
+            name: /^(_gtm_)/, // Google Tag Manager
+            domain: "tilli.pro",
+          },
+          {
+            name: /^(_gat)/, // Google Tag Manager (analytics)
+            domain: "tilli.pro",
+          },
+          {
+            name: /^(_gid)/, // Google Tag Manager (session ID)
+            domain: "tilli.pro",
+          },
+        ],
+      },
+      "Hubspot": {
+        label: "Hubspot",
+        cookies: [
+          {
+            name: /^(__hs)/, // Hubspot (Session Tracking)
+            domain: "tilli.pro",
+          },
+          {
+            name: /^(hubspotutk)/, // Hubspot (User Tracking)
+            domain: "tilli.pro",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Analytics - Cloudfare)
+            domain: ".hs-analytics.net",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Banner - Cloudfare)
+            domain: ".hs-banner.com",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Scripts - Cloudfare)
+            domain: ".hs-scripts.com",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Adspixel - Cloudfare)
+            domain: ".hsadspixel.net",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (Twitter - Cloudfare)
+            domain: ".t.co",
+          },
+          {
+            name: /^(__cf_bm)/, // Hubspot (User Messages - Cloudfare)
+            domain: ".usermessages.com",
+          },
+          {
+            name: /^(_cfuvid)/, // Hubspot (Visitor ID - Cloudfare)
+            domain: ".hubspot.com",
+          },
+        ],
+      },
+      "Facebook": {
+        label: "Facebook",
+        cookies: [
+          {
+            name: /^(_fb)/, // Facebook (ads)
+            domain: "tilli.pro",
+          },
+        ],
+      },
+      "Twitter": {
+        label: "Twitter",
+        cookies: [
+          {
+            name: /^(muc_ads)/, // Twitter (ads)
+            domain: ".t.co",
+          },
+        ],
+      },
+    },
+    autoClear: {
+      // TODO: DRY this with the services above
+      cookies: [
+        /** Google Tag Manager */
+        {
+          name: /^(_gtm_)/, // Google Tag Manager
+          domain: "tilli.pro",
+        },
+        {
+          name: /^(_gat)/, // Google Tag Manager (analytics)
+          domain: "tilli.pro",
+        },
+        {
+          name: /^(_gid)/, // Google Tag Manager (session ID)
+          domain: "tilli.pro",
+        },
+
+        /** Hubspot */
+        {
+          name: /^(__hs)/, // Hubspot (Session Tracking)
+          domain: "tilli.pro",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Analytics - Cloudfare)
+          domain: ".hs-analytics.net",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Banner - Cloudfare)
+          domain: ".hs-banner.com",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Scripts - Cloudfare)
+          domain: ".hs-scripts.com",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Adspixel - Cloudfare)
+          domain: ".hsadspixel.net",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (Twitter - Cloudfare)
+          domain: ".t.co",
+        },
+        {
+          name: /^(__cf_bm)/, // Hubspot (User Messages - Cloudfare)
+          domain: ".usermessages.com",
+        },
+        {
+          name: /^(_cfuvid)/, // Hubspot (Visitor ID - Cloudfare)
+          domain: ".hubspot.com",
+        },
+
+        /** Facebook */
+        {
+          name: /^(_fb)/, // Facebook (ads)
+          domain: "tilli.pro",
+        },
+
+        /** Twitter */
+        {
+          name: /^(muc_ads)/, // Twitter (ads)
+          domain: ".t.co",
+        },
+      ],
+    },
   },
-  analytics: {},
-  marketing: {},
 };
 
 // TODO: DRY further w/ `./brf.ts`

package/src/init/tilliX.ts

@@ -0,0 +1,37 @@
+import type { CookieConsentConfig } from "@tilli-pro/cookieconsent";
+
+import _config from "../config";
+import { run } from "../init";
+import {
+  makeInitFn,
+  stripInvalidLinkedCategoriesFromTranslations,
+} from "./utils";
+
+const categories: CookieConsentConfig["categories"] = {
+  necessary: {
+    enabled: true, // "necessary" category is always enabled.
+    readOnly: true,
+  },
+  functional: {},
+  analytics: {},
+};
+
+// TODO: DRY further w/ `./brf.ts`
+const language: CookieConsentConfig["language"] = {
+  ..._config.language,
+  translations: stripInvalidLinkedCategoriesFromTranslations(
+    _config.language.translations,
+    categories,
+    true, // clear cookie tables // FIXME: refactor this to actually just use the proper cookie table accoring to the categories var
+  ),
+};
+
+const config: CookieConsentConfig = {
+  ..._config,
+  categories,
+  language,
+};
+
+// console.debug({ config }, "Initializing Cookie Consent (tilli Website)...");
+const init = makeInitFn(run, config);
+void init();

package/src/init/utils.script.ts

@@ -0,0 +1,72 @@
+/** extracts the `theme` parameter from the script URL */
+export function getThemeFromScriptUrl(scriptUrl: string): string | null {
+  const url = new URL(scriptUrl, document.baseURI);
+  return url.searchParams.get("theme");
+}
+
+/** adds a `cc--<theme>` CSS class to the <html> element, if not already present */
+export function addHtmlClass(theme: string): void {
+  const className = `cc--${theme}`;
+  const htmlEl = document.documentElement;
+
+  if (!htmlEl.classList.contains(className)) htmlEl.classList.add(className);
+}
+
+/**
+ * determines the URL of the currently executing script
+ *  - (works for both ES modules (`import.meta.url`) and classic scripts (`document.currentScript`))
+ * @returns The script URL, or `undefined` if it cannot be determined.
+ */
+export function getCurrentScriptUrl(): string | undefined {
+  if (
+    typeof document !== "undefined" &&
+    document.currentScript instanceof HTMLScriptElement
+  ) return document.currentScript.src;
+
+  if (
+    typeof import.meta !== "undefined" &&
+    typeof import.meta.url === "string"
+  ) return import.meta.url;
+
+  console.warn("[cc-plugin]: unable to resolve current script URL");
+  return undefined;
+}
+
+/**
+ * inits theme by reading the `theme` query param from the provided script URL (or auto-detected script)
+ * and then adding the corresponding CSS class to <html>.
+ * 
+ * @param scriptUrl - Optional explicit URL; if omitted, auto-detection is used
+ * 
+ * @usage in an ES module entry point:
+ *    import { initTheme } from './init/utils.script.ts';
+ *    initTheme(import.meta.url);
+ *
+ * @usage in a classic script:
+ *    import { initTheme } from './init/utils.script.ts';
+ *    initTheme();
+ */
+export function initTheme(scriptUrl?: string): void {
+  const src = scriptUrl ?? getCurrentScriptUrl();
+  if (!src) return;
+
+  /** first, try to get theme from the direct script URL */
+  let theme = getThemeFromScriptUrl(src);
+
+  /** otherwise, try checking the URL of the script that loaded this script */
+  if (!theme) {
+    /** extract git SHA from the URL (looking for @<sha>/ in the path) */
+    const shaMatch = src.match(/@([0-9a-f]{7,40})\b/);
+    const sha = shaMatch ? shaMatch[1] : null;
+    if (sha && typeof document !== "undefined") {
+      /** find a <script> whose src contains the same SHA and "/init" in the path */
+      const scripts = Array.from(document.getElementsByTagName("script"));
+      const candidate = scripts.find((s) =>
+        s.src.includes(`@${sha}/`) && s.src.includes("/init")
+      );
+      if (candidate) theme = getThemeFromScriptUrl(candidate.src);
+    }
+  }
+  
+  if (theme) addHtmlClass(theme);
+}

package/src/init.ts

@@ -1,4 +1,4 @@
-import "https://cdn.jsdelivr.net/gh/tilli-pro/cookieconsent@5fb70ab82fb1764d33cb75ab3bf9f3320d62cd75/dist/cookieconsent.umd.js";
+import "https://cdn.jsdelivr.net/gh/tilli-pro/cookieconsent@693e3343f65c0e2a3c186bc4b913a83b9319a9f2/dist/cookieconsent.umd.js";
 
 import type * as _CookieConsent from "@tilli-pro/cookieconsent";
 import type { CookieConsentConfig } from "@tilli-pro/cookieconsent";
@@ -6,6 +6,7 @@ import type { CookieConsentConfig } from "@tilli-pro/cookieconsent";
 import { cookieConsentTheme } from "./_utils";
 import _config from "./config";
 import styles from "./styles";
+import { initTheme } from "./init/utils.script";
 
 declare module CookieConsent {
   const run: typeof _CookieConsent.run;
@@ -17,7 +18,7 @@ declare global {
   }
 }
 
-const GIT_SHA = "5fb70ab82fb1764d33cb75ab3bf9f3320d62cd75";
+const GIT_SHA = "693e3343f65c0e2a3c186bc4b913a83b9319a9f2";
 const GIT_REPO = "tilli-pro/cookieconsent";
 const GIT_CDN_BASE_URL = "https://cdn.jsdelivr.net/gh";
 const GIT_CDN_URL = `${GIT_CDN_BASE_URL}/${GIT_REPO}@${GIT_SHA}`;
@@ -70,6 +71,7 @@ async function always() {
   loadCSS(CC_CSS_URL);
   loadNestedPluginCSS("styles", styles); // TODO: make dynamic (only import dependent styles - aka if a certain `init` config is specified)
   window.cookieConsentTheme = cookieConsentTheme; // used to fetch the correct classname to apply a specified theme | THIS SHOULD BE INJECTED INTO THE <HTML> TAG!!! // TODO: auto-inject (?)
+  initTheme();
 }
 
 void always();

package/src/styles/index.ts

@@ -1,6 +1,11 @@
 export default {
+  "tilli-website": "tilli-website.css",
+  "tilli-pay": "tilli-pay.css",
+  nudge: "nudge.css",
   tenants: {
     freeman: "freeman.css",
     frontier: "frontier.css",
+    "con-edison": "con-edison.css",
+    oru: "oru.css",
   },
 } as const;