@nationalarchives/frontend 0.41.1 → 0.42.0

package/nationalarchives/lib/cookies.mjs

@@ -1,63 +1,9 @@
-window.TNAFrontendCookies = window.TNAFrontendCookies || null;
-window.TNAFrontendCookieEvents = window.TNAFrontendCookieEvents || null;
+/* eslint-disable max-lines */
+/* eslint-disable no-console */
 
-export class CookieEventHandler {
-  events = {};
-  oneTimeEvents = {};
-  debug = false;
+import { CookieEventHandler } from "./cookie-events.mjs";
 
-  constructor(debug = false) {
-    this.debug = debug;
-    if (window.TNAFrontendCookieEvents) {
-      this.log("Using existing TNAFrontendCookieEvents instance");
-      return window.TNAFrontendCookieEvents;
-    }
-    window.TNAFrontendCookieEvents = this;
-  }
-
-  log(...args) {
-    if (this.debug) {
-      console.log("[TNA Frontend Cookie Events]", ...args);
-    }
-  }
-
-  /**
-   * Add an event listener.
-   * @param {String} event - The event to add a listener for.
-   * @param {Function} callback - The callback function to call when the event is triggered.
-   */
-  on(event, callback) {
-    if (!Object.hasOwn(this.events, event)) {
-      this.events[event] = [];
-    }
-    this.events[event] = [...this.events[event], callback];
-  }
-
-  once(event, callback) {
-    if (!Object.hasOwn(this.oneTimeEvents, event)) {
-      this.oneTimeEvents[event] = [];
-    }
-    this.oneTimeEvents[event] = [...this.oneTimeEvents[event], callback];
-  }
-
-  /** @protected */
-  trigger(event, data = {}) {
-    if (Object.hasOwn(this.events, event)) {
-      this.log(`Triggering event: ${event}`, data);
-      this.events[event].forEach((eventToTrigger) =>
-        eventToTrigger.call(this, data),
-      );
-    }
-    if (Object.hasOwn(this.oneTimeEvents, event)) {
-      this.log(`Triggering one-time event: ${event}`, data);
-      for (let i = this.oneTimeEvents[event].length - 1; i >= 0; i--) {
-        const eventToTrigger = this.oneTimeEvents[event][i];
-        eventToTrigger.call(this, data);
-        this.oneTimeEvents[event].splice(i, 1);
-      }
-    }
-  }
-}
+window.TNAFrontendCookies ||= null;
 
 const tnaCookiePolicies = ["usage", "settings", "marketing", "essential"];
 
@@ -106,39 +52,42 @@ export default class Cookies {
       noInit = false,
     } = options;
     if (!newInstance && window.TNAFrontendCookies) {
+      /* eslint-disable-next-line no-constructor-return */
       return window.TNAFrontendCookies;
     }
-    if (defaultDomain === undefined) {
+    if (defaultDomain) {
+      this.defaultDomain = defaultDomain;
+    } else {
       this.defaultDomain =
         document.documentElement.dataset.tnaCookiesDomain ||
         window.location.hostname;
-    } else {
-      this.defaultDomain = defaultDomain;
     }
-    if (defaultPath === undefined) {
-      this.defaultPath = document.documentElement.dataset.tnaCookiesPath || "/";
-    } else {
+    if (defaultPath) {
       this.defaultPath = defaultPath;
+    } else {
+      this.defaultPath = document.documentElement.dataset.tnaCookiesPath || "/";
     }
-    if (secure === undefined) {
+    if (secure) {
+      this.secure = secure;
+    } else {
       this.secure =
         document.documentElement.dataset.tnaCookiesInsecure !== "true";
-    } else {
-      this.secure = secure;
     }
-    if (policiesKey === undefined) {
+    if (policiesKey) {
+      this.policiesKey = policiesKey;
+    } else {
       this.policiesKey =
         document.documentElement.dataset.tnaCookiesPoliciesKey ||
         "cookies_policy";
-    } else {
-      this.policiesKey = policiesKey;
     }
-    if (defaultAge === undefined) {
-      this.defaultAge =
-        parseInt(document.documentElement.dataset.tnaCookiesDefaultAge) ||
-        31536000; // 365 days;
-    } else {
+    if (defaultAge) {
       this.defaultAge = defaultAge;
+    } else {
+      /* eslint-disable-next-line no-magic-numbers */
+      const secondsInAYear = 365 * 24 * 60 * 60;
+      this.defaultAge =
+        parseInt(document.documentElement.dataset.tnaCookiesDefaultAge, 10) ||
+        secondsInAYear;
     }
     this.events = new CookieEventHandler(this.debug);
     this.policiesCorrectOnInit =
@@ -173,7 +122,7 @@ export default class Cookies {
         .filter((policy) => tnaCookiePolicies.includes(policy))
         .map((policy) => [policy, existingPolicies[policy]]),
     );
-    if (Object.keys(filteredExistingPolicies).length > 0) {
+    if (Object.keys(filteredExistingPolicies).length) {
       this.log("Filtered existing policies:", filteredExistingPolicies);
     }
     this.savePolicies({
@@ -197,15 +146,17 @@ export default class Cookies {
   }
 
   /** @protected */
+  /* eslint-disable-next-line class-methods-use-this */
   get all() {
     const deserialised = {};
     document.cookie
       .split("; ")
-      .filter((x) => x)
+      .filter((cookie) => cookie.trim() !== "")
       .forEach((cookie) => {
         const parts = cookie.trim().split("=");
-        if (parts[0]) {
-          deserialised[parts[0]] = parts[1];
+        const [key, value] = parts;
+        if (key) {
+          deserialised[key] = decodeURIComponent(value || "");
         }
       });
     return deserialised;
@@ -215,7 +166,8 @@ export default class Cookies {
   get policies() {
     try {
       return JSON.parse(this.get(this.policiesKey) || "{}");
-    } catch (e) {
+      // eslint-disable-next-line no-unused-vars
+    } catch (error) {
       return {};
     }
   }
@@ -236,16 +188,19 @@ export default class Cookies {
    * @returns
    */
   hasValue(key, value) {
-    return this.get(key) == value;
+    return this.get(key) === value;
   }
 
   /**
    * Get a cookie.
    * @param {String} key - The cookie name.
-   * @returns {String|Number|Boolean}
+   * @returns {String|Number|Boolean|null}
    */
   get(key) {
-    return this.exists(key) ? decodeURIComponent(this.all[key]) : null;
+    if (this.exists(key)) {
+      return decodeURIComponent(this.all[key]);
+    }
+    return null;
   }
 
   /**
@@ -273,9 +228,15 @@ export default class Cookies {
     if (!key) {
       return;
     }
-    const cookie = `${encodeURIComponent(key)}=${encodeURIComponent(value)}; domain=${domain}; samesite=${sameSite}; path=${path}${!session ? `; max-age=${maxAge}` : ""}${
-      secure ? "; secure" : ""
-    }`;
+    let secureString = "";
+    if (secure) {
+      secureString = "; secure";
+    }
+    let sessionString = "";
+    if (!session) {
+      sessionString = `; max-age=${maxAge}`;
+    }
+    const cookie = `${encodeURIComponent(key)}=${encodeURIComponent(value)}; domain=${domain}; samesite=${sameSite}; path=${path}${sessionString}${secureString}`;
     document.cookie = cookie;
     this.log("Set cookie:", {
       key,
@@ -307,7 +268,7 @@ export default class Cookies {
    * @param {String} [path=/] - The path to the cookie is registered on.
    */
   delete(key, path = "/", domain = this.defaultDomain) {
-    const options = { maxAge: -1, path, domain: domain || undefined };
+    const options = { maxAge: -1, path, domain: domain || this.defaultDomain };
     this.set(key, "", options);
     this.log("Deleted cookie:", { key, path, domain, ...options });
     this.events.trigger("deleteCookie", { key, ...options });
@@ -371,7 +332,7 @@ export default class Cookies {
   acceptAllPolicies() {
     this.log("Accepting all policies");
     const allPolicies = Object.fromEntries(
-      Object.keys(this.policies).map((k) => [k.toLowerCase(), true]),
+      Object.keys(this.policies).map((key) => [key.toLowerCase(), true]),
     );
     this.savePolicies(allPolicies);
     this.events.trigger("acceptAllPolicies");
@@ -385,7 +346,7 @@ export default class Cookies {
     this.log("Rejecting all policies");
     const allPolicies = {
       ...Object.fromEntries(
-        Object.keys(this.policies).map((k) => [k.toLowerCase(), false]),
+        Object.keys(this.policies).map((key) => [key.toLowerCase(), false]),
       ),
       essential: true,
     };
@@ -409,9 +370,10 @@ export default class Cookies {
    * @returns {Boolean}
    */
   isPolicyAccepted(policy) {
-    return Object.hasOwn(this.policies, policy)
-      ? this.policies[policy] === true
-      : null;
+    if (Object.hasOwn(this.policies, policy)) {
+      return this.policies[policy] === true;
+    }
+    return null;
   }
 
   /**

package/nationalarchives/lib/helpers.mjs

@@ -7,10 +7,10 @@ export const iso8601ToPrettyDatetime = (dateStr) => {
     throw new Error("No datetime provided");
   }
   const isDateTime =
-    /^\d{4}(-\d{2}){2}(T| )\d{2}(:\d{2}){1,2}(\.\d+)?(Z|((\+|-)\d{2}:\d{2}))?$/.test(
+    /^\d{4}(?:-\d{2}){2}(?:T| )\d{2}(?::\d{2}){1,2}(?:\.\d+)?(?:Z|(?:[+-]\d{2}:\d{2}))?$/u.test(
       datetime,
     );
-  const isDate = /^\d{4}(-\d{2}){2}$/.test(datetime);
+  const isDate = /^\d{4}(?:-\d{2}){2}$/u.test(datetime);
   if (!isDateTime && !isDate) {
     throw new Error("Invalid datetime provided");
   }
@@ -23,7 +23,6 @@ export const iso8601ToPrettyDatetime = (dateStr) => {
   const dayString = date.toLocaleDateString("en-GB", {
     weekday: "long",
   });
-
   const dateString = date.toLocaleDateString("en-GB", {
     day: "numeric",
     month: "long",
@@ -43,9 +42,8 @@ export const iso8601ToPrettyDatetime = (dateStr) => {
       });
     }
     return `${dayString} ${dateString}, ${timeString}`;
-  } else {
-    return `${dayString} ${dateString}`;
   }
+  return `${dayString} ${dateString}`;
 };
 
 /*
@@ -91,20 +89,16 @@ export const updateTimeElement = ($el) => {
       $el.setAttribute("title", $el.textContent);
       $el.textContent = prettyDatetime;
     }
-  } catch (e) {
+    // eslint-disable-next-line no-unused-vars
+  } catch (error) {
     // Do nothing if the datetime is invalid or not provided
   }
 };
 
 export const checkTableForScroll = ($tableWrapper) => {
-  const isUninitialised = !(
-    $tableWrapper.dataset.tableScrollInitialised === "true"
-  );
   const $caption = $tableWrapper.querySelector("caption");
-  if (isUninitialised) {
-    if (!$caption) {
-      console.warn("Missing <caption> element on table", $tableWrapper);
-    } else if (!$caption.id) {
+  if (!($tableWrapper.dataset.tableScrollInitialised === "true")) {
+    if ($caption && !$caption.id) {
       $caption.id = `table-caption-${uuidv4()}`;
     }
     $tableWrapper.dataset.tableScrollInitialised = "true";

package/nationalarchives/lib/uuid.mjs

@@ -1,8 +1,10 @@
+/* eslint-disable no-magic-numbers */
+/* eslint-disable no-bitwise */
 const uuidv4 = () =>
-  ([1e7] + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/g, (c) =>
+  ([1e7] + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/gu, (char) =>
     (
-      c ^
-      (crypto.getRandomValues(new Uint8Array(1))[0] & (15 >> (c / 4)))
+      char ^
+      (crypto.getRandomValues(new Uint8Array(1))[0] & (15 >> (char / 4)))
     ).toString(16),
   );