@nortic/citronkaka-service 0.0.2-beta.32

package/dist/index.d.ts

@@ -0,0 +1,156 @@
+declare class CookieCleaner {
+    /**
+     * Cleans up cookies based on a list of blacklist patterns.
+     * @param blacklist An array of RegExp patterns for cookies to delete.
+     */
+    static run(blacklist: RegExp[], persistentService?: typeof CookieService): void;
+}
+
+declare class CookieConsent {
+    private config;
+    private listeners;
+    private persistentService;
+    private cookieCleaner;
+    private cookieInterceptor;
+    private scriptInterceptor;
+    constructor(config?: CookieConsentConfig, listeners?: Record<CookieConsentEvent, CookieConsentEventListener[]>, persistentService?: typeof CookieService, cookieCleaner?: typeof CookieCleaner, cookieInterceptor?: typeof CookieInterceptor, scriptInterceptor?: typeof ScriptInterceptor);
+    /**
+     * Retrieves the current cookie consent model from persistent storage.
+     * If the stored value is invalid, it falls back to the default model.
+     */
+    get model(): CookieConsentModel;
+    /**
+     * Updates the cookie consent model in persistent storage after validation.
+     * @param value The new model to save. Must pass validation as a CookieConsentModel.
+     * @throws Error if the provided model is invalid.
+     */
+    private set model(value);
+    /**
+     * Update the cookie consent model and notify listeners.
+     * @param consent The new cookie consent values.
+     */
+    update(consent: CookieConsentValue): void;
+    /**
+     * Register an event listener for a specific event.
+     * @param eventName The name of the event.
+     * @param listener The listener function to register.
+     */
+    on(eventName: CookieConsentEvent, listener: CookieConsentEventListener): void;
+    /**
+     * Notify all listeners for a specific event.
+     * @param eventName The name of the event to notify.
+     */
+    private notifyListeners;
+    /**
+     * Generates a blacklist of cookies and scripts to block based on user consent.
+     * @returns An object containing arrays of cookies and scripts to block.
+     */
+    private get blacklist();
+    /**
+     * Validates whether a value conforms to the CookieConsentModel interface.
+     * @param value The value to validate.
+     * @returns True if the value is a valid CookieConsentModel, otherwise false.
+     */
+    private isCookieConsentModel;
+}
+
+declare interface CookieConsentConfig {
+    domain: string;
+    defaultModel: CookieConsentModel;
+    persistentKey: string;
+    persistentExpirationDays: number;
+    categories: string[];
+    services: {
+        name: string;
+        category: string;
+        scripts: RegExp[];
+        cookies: RegExp[];
+    }[];
+}
+
+declare type CookieConsentEvent = 'update';
+
+declare type CookieConsentEventListener = (model: CookieConsentModel) => void;
+
+declare interface CookieConsentModel {
+    useraction: boolean;
+    value: CookieConsentValue;
+}
+
+export declare interface CookieConsentValue {
+    necessary: true;
+    functional: boolean;
+    analytics: boolean;
+    marketing: boolean;
+}
+
+declare class CookieInterceptor {
+    /**
+     * Starts the cookie interception process to block cookies based on a blacklist.
+     * @param blacklist An array of RegExp patterns for cookie names to block.
+     */
+    static run(blacklist: RegExp[]): void;
+}
+
+declare class CookieService {
+    private static createCookieString;
+    /**
+     * Sets a cookie with the specified options.
+     * @param name The name of the cookie.
+     * @param value The value of the cookie (string or object).
+     * @param days Number of days until the cookie expires.
+     * @param domain Optional domain for the cookie.
+     */
+    static set<T extends string | object>(name: string, value: T, days: number, domain?: string): void;
+    /**
+     * Retrieves the value of a cookie by name.
+     * @param name The name of the cookie.
+     * @returns The value of the cookie or null if not found.
+     */
+    static get<T extends string | object>(name: string): T | null;
+    /**
+     * Deletes a cookie by name.
+     * @param name The name of the cookie.
+     * @param domain Optional domain for the cookie.
+     */
+    static delete(name: string, domain?: string): void;
+}
+
+declare const _default: CookieConsent;
+export default _default;
+
+declare class ScriptInterceptor {
+    /**
+     * Starts the script interception process with a list of blacklist patterns for script `src` attributes.
+     * @param blacklist An array of RegExp patterns for script `src` attributes to block.
+     */
+    static run(blacklist: RegExp[]): void;
+    /**
+     * Determines whether a script should be blocked based on its `src` attribute.
+     * @param blacklist An array of RegExp patterns to match against the script `src`.
+     * @param src The `src` attribute of the script to check.
+     * @returns True if the script should be blocked, false otherwise.
+     */
+    private static shouldBlockScript;
+    /**
+     * Intercepts the creation of `<script>` elements via `document.createElement`.
+     * Blocks scripts with `src` matching a blacklist pattern.
+     * @param blacklist An array of RegExp patterns for script `src` attributes to block.
+     */
+    private static interceptScriptCreation;
+    /**
+     * Observes dynamically added `<script>` elements in the DOM and blocks them if necessary.
+     * Prevents execution of blocked scripts by attaching a `beforescriptexecute` listener (Firefox specific fix).
+     * @param blacklist An array of RegExp patterns for script `src` attributes to block.
+     */
+    private static observeDynamicScripts;
+}
+
+export { }
+
+
+declare global {
+    interface Window {
+        Citronkaka: InstanceType<typeof CookieConsent>;
+    }
+}

package/dist/index.es.js

@@ -0,0 +1,269 @@
+const f = { BASE_URL: "/", DEV: !1, DOMAIN: "localhost", MODE: "development", NODE_ENV: "development", PROD: !0, SSR: !1 }, { DOMAIN: m } = f, k = {
+  domain: m,
+  defaultModel: {
+    useraction: !1,
+    value: { necessary: !0, functional: !1, analytics: !1, marketing: !1 }
+  },
+  persistentKey: "nortic_cookie_consent",
+  persistentExpirationDays: 365,
+  categories: ["necessary", "functional", "analytics", "marketing"],
+  services: [
+    { name: "Translations", category: "functional", scripts: [], cookies: [/^i18n_redirected/] },
+    { name: "Color mode", category: "functional", scripts: [], cookies: [/^color-mode/] }
+  ]
+};
+class p {
+  static createCookieString(e, t, o = {}) {
+    const { expires: i, path: r = "/", sameSite: s = "Strict", domain: n } = o, c = encodeURIComponent(t), u = i ? `; expires=${i.toUTCString()}` : "", d = n ? `; domain=${n}` : "";
+    return `${e}=${c}${u}; path=${r}; SameSite=${s}${d}`;
+  }
+  /**
+   * Sets a cookie with the specified options.
+   * @param name The name of the cookie.
+   * @param value The value of the cookie (string or object).
+   * @param days Number of days until the cookie expires.
+   * @param domain Optional domain for the cookie.
+   */
+  static set(e, t, o, i) {
+    const r = typeof t == "string" ? t : JSON.stringify(t), s = new Date(Date.now() + o * 24 * 60 * 60 * 1e3);
+    document.cookie = this.createCookieString(e, r, { expires: s, domain: i });
+  }
+  /**
+   * Retrieves the value of a cookie by name.
+   * @param name The name of the cookie.
+   * @returns The value of the cookie or null if not found.
+   */
+  static get(e) {
+    const t = document.cookie.match(new RegExp(`(^| )${e}=([^;]+)`));
+    if (!t)
+      return null;
+    const o = decodeURIComponent(t[2]);
+    try {
+      return JSON.parse(o);
+    } catch {
+      return o;
+    }
+  }
+  /**
+   * Deletes a cookie by name.
+   * @param name The name of the cookie.
+   * @param domain Optional domain for the cookie.
+   */
+  static delete(e, t) {
+    document.cookie = this.createCookieString(e, "", {
+      expires: /* @__PURE__ */ new Date(0),
+      domain: t
+    });
+  }
+}
+class h {
+  /**
+   * Cleans up cookies based on a list of blacklist patterns.
+   * @param blacklist An array of RegExp patterns for cookies to delete.
+   */
+  static run(e, t = p) {
+    function o(i) {
+      document.cookie.split(";").forEach((r) => {
+        const s = r.split("=")[0].trim();
+        i.test(s) && (t.delete(s), console.warn(`Removed cookie: ${s}`));
+      });
+    }
+    e.forEach((i) => {
+      o(i);
+    });
+  }
+}
+class y {
+  /**
+   * Starts the cookie interception process to block cookies based on a blacklist.
+   * @param blacklist An array of RegExp patterns for cookie names to block.
+   */
+  static run(e) {
+    const t = Object.getOwnPropertyDescriptor(Document.prototype, "cookie");
+    if (!t) {
+      console.error("Failed to retrieve the cookie property descriptor.");
+      return;
+    }
+    Object.defineProperty(document, "cookie", {
+      configurable: !0,
+      enumerable: !0,
+      /**
+       * Getter for `document.cookie`.
+       * @returns The current cookies as a string.
+       */
+      get() {
+        var o;
+        return ((o = t.get) == null ? void 0 : o.call(document)) || "";
+      },
+      /**
+       * Setter for `document.cookie`. Intercepts and blocks cookies based on the blacklist.
+       * @param cookieString The cookie string to be set.
+       */
+      set(o) {
+        var n;
+        const i = o.split("=")[0].trim(), r = o.match(/expires=([^;]+)/i);
+        (r ? new Date(r[1]).getTime() < Date.now() : !1) || !e.some((c) => c.test(i)) ? (n = t.set) == null || n.call(document, o) : console.warn(`Blocked cookie: ${i}`);
+      }
+    });
+  }
+}
+class l {
+  /**
+   * Starts the script interception process with a list of blacklist patterns for script `src` attributes.
+   * @param blacklist An array of RegExp patterns for script `src` attributes to block.
+   */
+  static run(e) {
+    this.interceptScriptCreation(e), this.observeDynamicScripts(e);
+  }
+  /**
+   * Determines whether a script should be blocked based on its `src` attribute.
+   * @param blacklist An array of RegExp patterns to match against the script `src`.
+   * @param src The `src` attribute of the script to check.
+   * @returns True if the script should be blocked, false otherwise.
+   */
+  static shouldBlockScript(e, t) {
+    return e.some((o) => o.test(t));
+  }
+  /**
+   * Intercepts the creation of `<script>` elements via `document.createElement`.
+   * Blocks scripts with `src` matching a blacklist pattern.
+   * @param blacklist An array of RegExp patterns for script `src` attributes to block.
+   */
+  static interceptScriptCreation(e) {
+    const t = document.createElement.bind(document);
+    document.createElement = function(o) {
+      const i = t(o);
+      if (o.toLowerCase() === "script") {
+        const r = i, s = Object.getOwnPropertyDescriptor(
+          HTMLScriptElement.prototype,
+          "src"
+        );
+        s && Object.defineProperty(r, "src", {
+          configurable: !0,
+          enumerable: !0,
+          get() {
+            var n;
+            return (n = s.get) == null ? void 0 : n.call(r);
+          },
+          set(n) {
+            var c;
+            if (l.shouldBlockScript(e, n)) {
+              console.warn(`Blocked script: ${n}`), r.type = "javascript/blocked";
+              return;
+            }
+            (c = s.set) == null || c.call(r, n);
+          }
+        });
+      }
+      return i;
+    };
+  }
+  /**
+   * Observes dynamically added `<script>` elements in the DOM and blocks them if necessary.
+   * Prevents execution of blocked scripts by attaching a `beforescriptexecute` listener (Firefox specific fix).
+   * @param blacklist An array of RegExp patterns for script `src` attributes to block.
+   */
+  static observeDynamicScripts(e) {
+    new MutationObserver((o) => {
+      o.forEach(({ addedNodes: i }) => {
+        i.forEach((r) => {
+          if (r.nodeType === Node.ELEMENT_NODE && r.tagName === "SCRIPT") {
+            const s = r;
+            if (s.src && this.shouldBlockScript(e, s.src)) {
+              console.warn(`Blocked dynamically added script: ${s.src}`), s.type = "javascript/blocked";
+              const n = (c) => {
+                s.getAttribute("type") === "javascript/blocked" && (c.preventDefault(), console.warn(`Prevented execution of blocked script: ${s.src}`)), s.removeEventListener("beforescriptexecute", n);
+              };
+              s.addEventListener("beforescriptexecute", n);
+            }
+          }
+        });
+      });
+    }).observe(document.documentElement, {
+      childList: !0,
+      subtree: !0
+    });
+  }
+}
+class g {
+  constructor(e = k, t = { update: [] }, o = p, i = h, r = y, s = l) {
+    this.config = e, this.listeners = t, this.persistentService = o, this.cookieCleaner = i, this.cookieInterceptor = r, this.scriptInterceptor = s, i.run(this.blacklist.cookies), r.run(this.blacklist.cookies), s.run(this.blacklist.scripts);
+  }
+  /**
+   * Retrieves the current cookie consent model from persistent storage.
+   * If the stored value is invalid, it falls back to the default model.
+   */
+  get model() {
+    const e = this.persistentService.get(this.config.persistentKey);
+    return this.isCookieConsentModel(e) ? e : this.config.defaultModel;
+  }
+  /**
+   * Updates the cookie consent model in persistent storage after validation.
+   * @param value The new model to save. Must pass validation as a CookieConsentModel.
+   * @throws Error if the provided model is invalid.
+   */
+  set model(e) {
+    if (!this.isCookieConsentModel(e))
+      throw new Error("Invalid model: The provided value is not a valid CookieConsentModel.");
+    this.persistentService.set(
+      this.config.persistentKey,
+      e,
+      this.config.persistentExpirationDays,
+      this.config.domain
+    );
+  }
+  /**
+   * Update the cookie consent model and notify listeners.
+   * @param consent The new cookie consent values.
+   */
+  update(e) {
+    this.model = { useraction: !0, value: e }, this.notifyListeners("update");
+  }
+  /**
+   * Register an event listener for a specific event.
+   * @param eventName The name of the event.
+   * @param listener The listener function to register.
+   */
+  on(e, t) {
+    this.listeners[e].push(t);
+  }
+  /**
+   * Notify all listeners for a specific event.
+   * @param eventName The name of the event to notify.
+   */
+  notifyListeners(e) {
+    this.listeners[e].forEach((t) => t(this.model));
+  }
+  /**
+   * Generates a blacklist of cookies and scripts to block based on user consent.
+   * @returns An object containing arrays of cookies and scripts to block.
+   */
+  get blacklist() {
+    return this.config.services.reduce((e, t) => {
+      if (this.model.value[t.category] === !1) {
+        const { cookies: o, scripts: i } = t;
+        e.cookies = e.cookies.concat(o), e.scripts = e.scripts.concat(i);
+      }
+      return e;
+    }, { cookies: [], scripts: [] });
+  }
+  /**
+   * Validates whether a value conforms to the CookieConsentModel interface.
+   * @param value The value to validate.
+   * @returns True if the value is a valid CookieConsentModel, otherwise false.
+   */
+  isCookieConsentModel(e) {
+    if (typeof e != "object" || e === null)
+      return !1;
+    const t = e;
+    if (typeof t.useraction != "boolean" || typeof t.value != "object" || t.value === null)
+      return !1;
+    const o = t.value;
+    return o.necessary === !0 && typeof o.functional == "boolean" && typeof o.analytics == "boolean" && typeof o.marketing == "boolean";
+  }
+}
+window.Citronkaka = window.Citronkaka || new g();
+const b = window.Citronkaka;
+export {
+  b as default
+};

package/dist/index.iife.js

@@ -0,0 +1 @@
+var Citronkaka=function(){"use strict";const u={BASE_URL:"/",DEV:!1,DOMAIN:"localhost",MODE:"development",NODE_ENV:"development",PROD:!0,SSR:!1},{DOMAIN:d}=u,f={domain:d,defaultModel:{useraction:!1,value:{necessary:!0,functional:!1,analytics:!1,marketing:!1}},persistentKey:"nortic_cookie_consent",persistentExpirationDays:365,categories:["necessary","functional","analytics","marketing"],services:[{name:"Translations",category:"functional",scripts:[],cookies:[/^i18n_redirected/]},{name:"Color mode",category:"functional",scripts:[],cookies:[/^color-mode/]}]};class p{static createCookieString(e,t,o={}){const{expires:s,path:r="/",sameSite:i="Strict",domain:n}=o,c=encodeURIComponent(t),y=s?`; expires=${s.toUTCString()}`:"",g=n?`; domain=${n}`:"";return`${e}=${c}${y}; path=${r}; SameSite=${i}${g}`}static set(e,t,o,s){const r=typeof t=="string"?t:JSON.stringify(t),i=new Date(Date.now()+o*24*60*60*1e3);document.cookie=this.createCookieString(e,r,{expires:i,domain:s})}static get(e){const t=document.cookie.match(new RegExp(`(^| )${e}=([^;]+)`));if(!t)return null;const o=decodeURIComponent(t[2]);try{return JSON.parse(o)}catch{return o}}static delete(e,t){document.cookie=this.createCookieString(e,"",{expires:new Date(0),domain:t})}}class m{static run(e,t=p){function o(s){document.cookie.split(";").forEach(r=>{const i=r.split("=")[0].trim();s.test(i)&&(t.delete(i),console.warn(`Removed cookie: ${i}`))})}e.forEach(s=>{o(s)})}}class k{static run(e){const t=Object.getOwnPropertyDescriptor(Document.prototype,"cookie");if(!t){console.error("Failed to retrieve the cookie property descriptor.");return}Object.defineProperty(document,"cookie",{configurable:!0,enumerable:!0,get(){var o;return((o=t.get)==null?void 0:o.call(document))||""},set(o){var n;const s=o.split("=")[0].trim(),r=o.match(/expires=([^;]+)/i);(r?new Date(r[1]).getTime()<Date.now():!1)||!e.some(c=>c.test(s))?(n=t.set)==null||n.call(document,o):console.warn(`Blocked cookie: ${s}`)}})}}class a{static run(e){this.interceptScriptCreation(e),this.observeDynamicScripts(e)}static shouldBlockScript(e,t){return e.some(o=>o.test(t))}static interceptScriptCreation(e){const t=document.createElement.bind(document);document.createElement=function(o){const s=t(o);if(o.toLowerCase()==="script"){const r=s,i=Object.getOwnPropertyDescriptor(HTMLScriptElement.prototype,"src");i&&Object.defineProperty(r,"src",{configurable:!0,enumerable:!0,get(){var n;return(n=i.get)==null?void 0:n.call(r)},set(n){var c;if(a.shouldBlockScript(e,n)){console.warn(`Blocked script: ${n}`),r.type="javascript/blocked";return}(c=i.set)==null||c.call(r,n)}})}return s}}static observeDynamicScripts(e){new MutationObserver(o=>{o.forEach(({addedNodes:s})=>{s.forEach(r=>{if(r.nodeType===Node.ELEMENT_NODE&&r.tagName==="SCRIPT"){const i=r;if(i.src&&this.shouldBlockScript(e,i.src)){console.warn(`Blocked dynamically added script: ${i.src}`),i.type="javascript/blocked";const n=c=>{i.getAttribute("type")==="javascript/blocked"&&(c.preventDefault(),console.warn(`Prevented execution of blocked script: ${i.src}`)),i.removeEventListener("beforescriptexecute",n)};i.addEventListener("beforescriptexecute",n)}}})})}).observe(document.documentElement,{childList:!0,subtree:!0})}}class h{constructor(e=f,t={update:[]},o=p,s=m,r=k,i=a){this.config=e,this.listeners=t,this.persistentService=o,this.cookieCleaner=s,this.cookieInterceptor=r,this.scriptInterceptor=i,s.run(this.blacklist.cookies),r.run(this.blacklist.cookies),i.run(this.blacklist.scripts)}get model(){const e=this.persistentService.get(this.config.persistentKey);return this.isCookieConsentModel(e)?e:this.config.defaultModel}set model(e){if(!this.isCookieConsentModel(e))throw new Error("Invalid model: The provided value is not a valid CookieConsentModel.");this.persistentService.set(this.config.persistentKey,e,this.config.persistentExpirationDays,this.config.domain)}update(e){this.model={useraction:!0,value:e},this.notifyListeners("update")}on(e,t){this.listeners[e].push(t)}notifyListeners(e){this.listeners[e].forEach(t=>t(this.model))}get blacklist(){return this.config.services.reduce((e,t)=>{if(this.model.value[t.category]===!1){const{cookies:o,scripts:s}=t;e.cookies=e.cookies.concat(o),e.scripts=e.scripts.concat(s)}return e},{cookies:[],scripts:[]})}isCookieConsentModel(e){if(typeof e!="object"||e===null)return!1;const t=e;if(typeof t.useraction!="boolean"||typeof t.value!="object"||t.value===null)return!1;const o=t.value;return o.necessary===!0&&typeof o.functional=="boolean"&&typeof o.analytics=="boolean"&&typeof o.marketing=="boolean"}}return window.Citronkaka=window.Citronkaka||new h,window.Citronkaka}();

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@nortic/citronkaka-service",
+  "type": "module",
+  "version": "0.0.2-beta.32",
+  "private": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.es.js",
+      "default": "./dist/index.iife.js"
+    }
+  },
+  "browser": "./dist/index.iife.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@tsconfig/node20": "^20.1.4",
+    "@types/jsdom": "^21.1.7",
+    "@types/node": "^20.14.5",
+    "@vue/tsconfig": "^0.7.0",
+    "jsdom": "^25.0.1",
+    "npm-run-all2": "^6.2.0",
+    "typescript": "~5.6.3",
+    "vite": "^5.4.8",
+    "vite-plugin-dts": "^4.3.0",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "run-p type:check \"build:only {@}\" --",
+    "build:only": "vite build",
+    "type:check": "vue-tsc --build --force",
+    "test": "vitest run"
+  }
+}