@eox/pages-theme-eox 2.0.0-alpha.5 → 2.0.0-alpha.7

package/src/helpers.test.js

@@ -0,0 +1,153 @@
+import { describe, it, beforeEach } from "node:test";
+import assert from "node:assert/strict";
+import {
+  normalizeTrackingUrl,
+  trackPageView,
+  trackEvent,
+  trackSiteSearch,
+  formatPrice,
+  t,
+  isActive,
+} from "./helpers.js";
+
+describe("normalizeTrackingUrl", () => {
+  it("strips trailing slashes from path", () => {
+    assert.equal(normalizeTrackingUrl("/explore/"), "/explore");
+    assert.equal(normalizeTrackingUrl("/explore"), "/explore");
+    assert.equal(normalizeTrackingUrl("/story/"), "/story");
+    assert.equal(normalizeTrackingUrl("/news_updates/"), "/news_updates");
+  });
+
+  it("keeps single root slash as /", () => {
+    assert.equal(normalizeTrackingUrl("/"), "/");
+    assert.equal(normalizeTrackingUrl(""), "");
+  });
+
+  it("removes volatile map coordinate parameters (x, y, z) and keeps template/zoom/datetime", () => {
+    assert.equal(
+      normalizeTrackingUrl("/explore/?x=15.0000&y=48.0000&z=4.0000"),
+      "/explore",
+    );
+    assert.equal(
+      normalizeTrackingUrl(
+        "/explore/?x=15.0000&y=48.0000&z=4.0000&template=expert&indicator=N11&datetime=2024-08-16&zoom=5",
+      ),
+      "/explore?datetime=2024-08-16&indicator=N11&template=expert&zoom=5",
+    );
+  });
+
+  it("preserves semantic content query params and sorts them", () => {
+    assert.equal(
+      normalizeTrackingUrl("/story/?page=2&id=sea-ice-extent"),
+      "/story?id=sea-ice-extent&page=2",
+    );
+    assert.equal(
+      normalizeTrackingUrl("/story/?id=sea-ice-extent&page=2"),
+      "/story?id=sea-ice-extent&page=2",
+    );
+  });
+
+  it("normalizes full URLs", () => {
+    assert.equal(
+      normalizeTrackingUrl("https://eodash.eox.at/explore/"),
+      "https://eodash.eox.at/explore",
+    );
+    assert.equal(
+      normalizeTrackingUrl(
+        "https://eodash.eox.at/explore/?x=12&y=34&indicator=TEST",
+      ),
+      "https://eodash.eox.at/explore?indicator=TEST",
+    );
+  });
+});
+
+describe("trackEvent", () => {
+  beforeEach(() => {
+    globalThis._paq = [];
+    globalThis.window = globalThis;
+  });
+
+  it("pushes array payload to _paq and normalizes path arguments", () => {
+    trackEvent(["Interaction", "Scroll Depth", "/explore/", 50]);
+    assert.deepEqual(globalThis._paq, [
+      ["trackEvent", "Interaction", "Scroll Depth", "/explore", 50],
+    ]);
+  });
+
+  it("supports positional arguments", () => {
+    trackEvent("CTA", "/click-link/", "Button Text");
+    assert.deepEqual(globalThis._paq, [
+      ["trackEvent", "CTA", "/click-link", "Button Text"],
+    ]);
+  });
+});
+
+describe("trackPageView", () => {
+  beforeEach(() => {
+    globalThis._paq = [];
+    globalThis.window = globalThis;
+    globalThis.document = { title: "Default Title" };
+  });
+
+  it("normalizes URL and sets document title before tracking page view", () => {
+    trackPageView({
+      path: "/explore/?x=10&indicator=AIR",
+      title: "Explore Indicators",
+    });
+    assert.deepEqual(globalThis._paq, [
+      ["setCustomUrl", "/explore?indicator=AIR"],
+      ["setDocumentTitle", "Explore Indicators"],
+      ["trackPageView"],
+      ["enableLinkTracking"],
+    ]);
+  });
+
+  it("accepts router route object", () => {
+    trackPageView({
+      route: {
+        path: "/story/",
+        data: { title: "Climate Story" },
+      },
+    });
+    assert.deepEqual(globalThis._paq, [
+      ["setCustomUrl", "/story"],
+      ["setDocumentTitle", "Climate Story"],
+      ["trackPageView"],
+      ["enableLinkTracking"],
+    ]);
+  });
+});
+
+describe("trackSiteSearch", () => {
+  beforeEach(() => {
+    globalThis._paq = [];
+    globalThis.window = globalThis;
+  });
+
+  it("pushes trackSiteSearch event with keyword, category, and result count", () => {
+    trackSiteSearch("methane", "indicators", 5);
+    assert.deepEqual(globalThis._paq, [
+      ["trackSiteSearch", "methane", "indicators", 5],
+    ]);
+  });
+});
+
+describe("existing helpers", () => {
+  it("formats prices correctly", () => {
+    assert.equal(formatPrice(12000, "en"), "€ 12,000.-");
+    assert.equal(formatPrice(49.99, "de"), "€ 49,99");
+  });
+
+  it("translates i18n keys with fallback", () => {
+    assert.equal(t("nav.home", { nav: { home: "Home Page" } }), "Home Page");
+    assert.equal(
+      t("nav.unknown", { nav: { home: "Home Page" } }),
+      "nav.unknown",
+    );
+  });
+
+  it("checks isActive links correctly", () => {
+    assert.equal(isActive({ link: "/explore/" }, "/explore"), true);
+    assert.equal(isActive({ link: "/explore" }, "/explore/"), true);
+  });
+});

package/src/llms/index.js

@@ -0,0 +1,64 @@
+import llmstxt from "vitepress-plugin-llms";
+import { createStoriesPlugin } from "./storiesPlugin.js";
+
+const LLMS_DEFAULTS = {};
+
+/**
+ * Normalizes a URL by stripping trailing slashes.
+ * @param {string | undefined | null} url
+ * @returns {string | null}
+ */
+export const normalizeDomain = (url) => {
+  if (!url || typeof url !== "string") return null;
+  return url.replace(/\/+$/, "");
+};
+
+/**
+ * Resolve the llms option into Vite plugins and package-owned flags.
+ * @param {boolean | Record<string, any>} [option] The `llms` option
+ * @param {Record<string, any>} [brandConfig] Brand configuration object
+ * @returns {{ plugins: any[], copyButtons: boolean, stories: any, domain: string | null }}
+ */
+export const resolveLlms = (option, brandConfig = {}) => {
+  if (option === false) {
+    return {
+      plugins: [],
+      copyButtons: false,
+      stories: null,
+      domain: null,
+    };
+  }
+
+  const {
+    copyButtons = false,
+    stories = null,
+    ...settings
+  } = option === true || option === undefined ? {} : option;
+
+  const rawDomain = settings.domain;
+  const domain = normalizeDomain(rawDomain);
+
+  const upstreamPlugins = llmstxt({
+    ...LLMS_DEFAULTS,
+    ...settings,
+    ...(domain ? { domain } : {}),
+  });
+
+  const plugins = [...upstreamPlugins];
+  if (stories !== false) {
+    plugins.push(
+      createStoriesPlugin({
+        storiesOption: stories,
+        brandConfig,
+        domain,
+      }),
+    );
+  }
+
+  return {
+    plugins,
+    copyButtons: Boolean(copyButtons),
+    stories,
+    domain,
+  };
+};