@windstream/react-shared-components 0.1.92 → 0.1.94

package/src/types/global.d.ts

@@ -1,9 +1,9 @@
-declare module "*.module.css" {
-  const classes: { [key: string]: string };
-  export default classes;
-}
-
-declare module "*.css" {
-  const content: string;
-  export default content;
-}
+declare module "*.module.css" {
+  const classes: { [key: string]: string };
+  export default classes;
+}
+
+declare module "*.css" {
+  const content: string;
+  export default content;
+}

package/src/types/micro-components.ts

@@ -1,99 +1,99 @@
-import { ButtonProps } from "@shared/contentful";
-
-export interface Asset {
-  url?: string | null;
-  title?: string | null;
-  description?: string | null;
-  contentType?: string | null;
-  width?: number | null;
-  height?: number | null;
-}
-export interface Button {
-  anchorId?: string | null;
-  showButtonAs?: "solid" | "text" | null;
-  buttonLabel: string; // required in your model
-  buttonPrefix?: string | null;
-  href?: string | null;
-  target?: "_blank" | "_self" | null;
-  badge?: string | null;
-  preserveQueryParameters: boolean; // non-null in your model
-  badgeIcon?: Asset | null;
-  buttonVariant?: "primary_brand" | "primary_inverse" | "secondary" | null;
-  buttonIcon?: Asset | null;
-  buttonIconPosition?: boolean | null; // matches EntryFieldTypes.Boolean in your model
-  clickToOpen?: "accordion" | "modal" | "tab" | null;
-  tabmodalNameToOpen?: string | null;
-  preDefinedFunctionExecution?: "check availability" | null;
-}
-
-export interface ButtonGroup {
-  __typename: "ComponentButtonGroup";
-  anchorId?: string | null;
-  title?: string | null;
-  itemsCollection?: {
-    items: Button[];
-  };
-}
-export interface Card {
-  anchorId?: string;
-  title?: string;
-  body?: {
-    json: any; // Contentful Rich Text
-  };
-  image?: Asset;
-  imageLink?: string;
-  imageAlignment?: "Left" | "Right" | "Center" | string;
-  imageView?: "Full" | "Inset" | string;
-  cta?: Button;
-  ctaAlignment?: "Left" | "Right" | "Center" | string;
-  textColor?: string;
-  backgroundColor?: string;
-  showBackgroundImage?: boolean;
-  pinwheelColor?: "blue" | "green" | "navy" | "purple" | "white" | "yellow";
-  iconToRichTextAlignment?: string;
-  phoneNumber?: string;
-  workingHours?: string;
-  titleLocation?: "Top" | "Bottom" | string;
-  ctaBottom?: Button;
-  ctaAlignmentBottom?: "Left" | "Right" | "Center" | string;
-  imageFloatingType?: boolean;
-}
-
-export interface VideoLink {
-  image?: Asset;
-  videoPopup?: boolean;
-  link?: string;
-}
-
-export interface Checklist {
-  list?: {
-    items: {
-      checkListTitle?: { json: any };
-      icon?: Asset;
-      anchorId?: string;
-    }[];
-  };
-}
-
-export interface RichTextItem {
-  title?: string;
-  isTargetBlank?: boolean;
-  richText?: { json: any };
-}
-
-export type CheckPlansProps = {
-  className?: string;
-  title?: string;
-  ctaAlignment?: "new-row" | "same-row";
-  ctaText?: string;
-  buttonVariant?: "primary_brand" | "secondary" | "primary_inverse";
-  showButtonAs?: "solid" | "unstyled" | "text" | undefined;
-  cta?: ButtonProps;
-  speedCardConfig?: {
-    isModalOpen?: boolean;
-    setModalOpen?: () => void;
-    speed?: string;
-    techType?: string;
-    isMax?: boolean;
-  };
-};
+import { ButtonProps } from "@shared/contentful";
+
+export interface Asset {
+  url?: string | null;
+  title?: string | null;
+  description?: string | null;
+  contentType?: string | null;
+  width?: number | null;
+  height?: number | null;
+}
+export interface Button {
+  anchorId?: string | null;
+  showButtonAs?: "solid" | "text" | null;
+  buttonLabel: string; // required in your model
+  buttonPrefix?: string | null;
+  href?: string | null;
+  target?: "_blank" | "_self" | null;
+  badge?: string | null;
+  preserveQueryParameters: boolean; // non-null in your model
+  badgeIcon?: Asset | null;
+  buttonVariant?: "primary_brand" | "primary_inverse" | "secondary" | null;
+  buttonIcon?: Asset | null;
+  buttonIconPosition?: boolean | null; // matches EntryFieldTypes.Boolean in your model
+  clickToOpen?: "accordion" | "modal" | "tab" | null;
+  tabmodalNameToOpen?: string | null;
+  preDefinedFunctionExecution?: "check availability" | null;
+}
+
+export interface ButtonGroup {
+  __typename: "ComponentButtonGroup";
+  anchorId?: string | null;
+  title?: string | null;
+  itemsCollection?: {
+    items: Button[];
+  };
+}
+export interface Card {
+  anchorId?: string;
+  title?: string;
+  body?: {
+    json: any; // Contentful Rich Text
+  };
+  image?: Asset;
+  imageLink?: string;
+  imageAlignment?: "Left" | "Right" | "Center" | string;
+  imageView?: "Full" | "Inset" | string;
+  cta?: Button;
+  ctaAlignment?: "Left" | "Right" | "Center" | string;
+  textColor?: string;
+  backgroundColor?: string;
+  showBackgroundImage?: boolean;
+  pinwheelColor?: "blue" | "green" | "navy" | "purple" | "white" | "yellow";
+  iconToRichTextAlignment?: string;
+  phoneNumber?: string;
+  workingHours?: string;
+  titleLocation?: "Top" | "Bottom" | string;
+  ctaBottom?: Button;
+  ctaAlignmentBottom?: "Left" | "Right" | "Center" | string;
+  imageFloatingType?: boolean;
+}
+
+export interface VideoLink {
+  image?: Asset;
+  videoPopup?: boolean;
+  link?: string;
+}
+
+export interface Checklist {
+  list?: {
+    items: {
+      checkListTitle?: { json: any };
+      icon?: Asset;
+      anchorId?: string;
+    }[];
+  };
+}
+
+export interface RichTextItem {
+  title?: string;
+  isTargetBlank?: boolean;
+  richText?: { json: any };
+}
+
+export type CheckPlansProps = {
+  className?: string;
+  title?: string;
+  ctaAlignment?: "new-row" | "same-row";
+  ctaText?: string;
+  buttonVariant?: "primary_brand" | "secondary" | "primary_inverse";
+  showButtonAs?: "solid" | "unstyled" | "text" | undefined;
+  cta?: ButtonProps;
+  speedCardConfig?: {
+    isModalOpen?: boolean;
+    setModalOpen?: () => void;
+    speed?: string;
+    techType?: string;
+    isMax?: boolean;
+  };
+};

package/src/types/utm.ts

@@ -1,49 +1,49 @@
-/**
- * UTM Parameter Types
- *
- * Type definitions for UTM tracking parameters used across Kinetic applications.
- */
-
-/** All tracked UTM and click-ID parameter names */
-export type UTMProperty =
-  | "utm_content"
-  | "utm_medium"
-  | "utm_campaign"
-  | "utm_source"
-  | "utm_term"
-  | "utm_campaign_id"
-  | "utm_adgroup_id"
-  | "fbclid"
-  | "gclid"
-  | "msclkid";
-
-/** Partial record of UTM parameter values */
-export type UTMProperties = Partial<Record<UTMProperty, string>>;
-
-/** Segment campaign context schema */
-export interface CampaignProperties {
-  name?: string;
-  source?: string;
-  medium?: string;
-  term?: string;
-  content?: string;
-  campaign_id?: string;
-  adgroup_id?: string;
-  gclid?: string;
-  fbclid?: string;
-  msclkid?: string;
-}
-
-/** List of all UTM parameter names for filtering */
-export const UTM_PARAM_NAMES: UTMProperty[] = [
-  "utm_content",
-  "utm_medium",
-  "utm_campaign",
-  "utm_source",
-  "utm_term",
-  "utm_campaign_id",
-  "utm_adgroup_id",
-  "fbclid",
-  "gclid",
-  "msclkid",
-];
+/**
+ * UTM Parameter Types
+ *
+ * Type definitions for UTM tracking parameters used across Kinetic applications.
+ */
+
+/** All tracked UTM and click-ID parameter names */
+export type UTMProperty =
+  | "utm_content"
+  | "utm_medium"
+  | "utm_campaign"
+  | "utm_source"
+  | "utm_term"
+  | "utm_campaign_id"
+  | "utm_adgroup_id"
+  | "fbclid"
+  | "gclid"
+  | "msclkid";
+
+/** Partial record of UTM parameter values */
+export type UTMProperties = Partial<Record<UTMProperty, string>>;
+
+/** Segment campaign context schema */
+export interface CampaignProperties {
+  name?: string;
+  source?: string;
+  medium?: string;
+  term?: string;
+  content?: string;
+  campaign_id?: string;
+  adgroup_id?: string;
+  gclid?: string;
+  fbclid?: string;
+  msclkid?: string;
+}
+
+/** List of all UTM parameter names for filtering */
+export const UTM_PARAM_NAMES: UTMProperty[] = [
+  "utm_content",
+  "utm_medium",
+  "utm_campaign",
+  "utm_source",
+  "utm_term",
+  "utm_campaign_id",
+  "utm_adgroup_id",
+  "fbclid",
+  "gclid",
+  "msclkid",
+];

package/src/utils/contentful/to-document.test.ts

@@ -0,0 +1,85 @@
+import { toDocument } from "./to-document";
+
+import { BLOCKS, type Document } from "@contentful/rich-text-types";
+
+const makeDocument = (text = "Hello"): Document => ({
+  nodeType: BLOCKS.DOCUMENT,
+  data: {},
+  content: [
+    {
+      nodeType: BLOCKS.PARAGRAPH,
+      data: {},
+      content: [{ nodeType: "text", value: text, marks: [], data: {} }],
+    },
+  ],
+});
+
+describe("toDocument", () => {
+  // ── Falsy inputs ─────────────────────────────────────
+  it("returns null for null", () => {
+    expect(toDocument(null)).toBeNull();
+  });
+
+  it("returns null for undefined", () => {
+    expect(toDocument(undefined)).toBeNull();
+  });
+
+  it("returns null for empty string", () => {
+    expect(toDocument("")).toBeNull();
+  });
+
+  it("returns null for 0", () => {
+    expect(toDocument(0)).toBeNull();
+  });
+
+  it("returns null for false", () => {
+    expect(toDocument(false)).toBeNull();
+  });
+
+  // ── REST/CDA Document ────────────────────────────────
+  it("returns Document directly when given a valid REST Document", () => {
+    const doc = makeDocument();
+    expect(toDocument(doc)).toBe(doc);
+  });
+
+  // ── GraphQL RichText { json: Document } ──────────────
+  it("extracts Document from GraphQL format { json, links }", () => {
+    const doc = makeDocument("GraphQL");
+    const graphql = { json: doc, links: { assets: [] } };
+    expect(toDocument(graphql)).toBe(doc);
+  });
+
+  it("extracts Document from GraphQL format without links", () => {
+    const doc = makeDocument("NoLinks");
+    expect(toDocument({ json: doc })).toBe(doc);
+  });
+
+  it("returns null when json property is not a valid Document", () => {
+    expect(toDocument({ json: "not-a-document" })).toBeNull();
+  });
+
+  it("returns null when json property is null", () => {
+    expect(toDocument({ json: null })).toBeNull();
+  });
+
+  // ── Non-matching objects ─────────────────────────────
+  it("returns null for an object without nodeType or json", () => {
+    expect(toDocument({ foo: "bar" })).toBeNull();
+  });
+
+  it("returns null for an object with nodeType but no content", () => {
+    expect(toDocument({ nodeType: BLOCKS.DOCUMENT })).toBeNull();
+  });
+
+  it("returns null for an array", () => {
+    expect(toDocument([1, 2, 3])).toBeNull();
+  });
+
+  it("returns null for a number", () => {
+    expect(toDocument(42)).toBeNull();
+  });
+
+  it("returns null for a non-empty string", () => {
+    expect(toDocument("hello")).toBeNull();
+  });
+});

package/src/utils/contentful/to-document.ts

@@ -1,24 +1,24 @@
-import type { Document } from "@contentful/rich-text-types";
-
-type GraphqlRichText = { json: Document; links?: unknown };
-
-const isDocument = (v: unknown): v is Document =>
-  !!v &&
-  typeof v === "object" &&
-  "nodeType" in (v as any) &&
-  "content" in (v as any);
-
-export const toDocument = (v: unknown | null | undefined): Document | null => {
-  if (!v) return null;
-
-  // REST/CDA Document
-  if (isDocument(v)) return v;
-
-  // GraphQL RichText { json: Document, links? }
-  if (typeof v === "object" && v !== null && "json" in (v as any)) {
-    const json = (v as GraphqlRichText).json;
-    return isDocument(json) ? json : null;
-  }
-
-  return null;
-};
+import type { Document } from "@contentful/rich-text-types";
+
+type GraphqlRichText = { json: Document; links?: unknown };
+
+const isDocument = (v: unknown): v is Document =>
+  !!v &&
+  typeof v === "object" &&
+  "nodeType" in (v as any) &&
+  "content" in (v as any);
+
+export const toDocument = (v: unknown | null | undefined): Document | null => {
+  if (!v) return null;
+
+  // REST/CDA Document
+  if (isDocument(v)) return v;
+
+  // GraphQL RichText { json: Document, links? }
+  if (typeof v === "object" && v !== null && "json" in (v as any)) {
+    const json = (v as GraphqlRichText).json;
+    return isDocument(json) ? json : null;
+  }
+
+  return null;
+};

package/src/utils/cookie.test.ts

@@ -0,0 +1,180 @@
+import {
+  getCookie,
+  getParsedCookie,
+  getUTMs,
+  removeUTMs,
+  setCookie,
+  setUTMs,
+} from "./cookie";
+import { Base64 } from "js-base64";
+import Cookies from "js-cookie";
+
+jest.mock("js-cookie");
+
+const mockCookiesGet = Cookies.get as jest.Mock;
+const mockCookiesSet = Cookies.set as jest.Mock;
+const mockCookiesRemove = Cookies.remove as jest.Mock;
+
+describe("cookie utilities", () => {
+  afterEach(() => {
+    mockCookiesGet.mockReset();
+    mockCookiesSet.mockReset();
+    mockCookiesRemove.mockReset();
+  });
+
+  // ── getUTMs ──────────────────────────────────────────
+  describe("getUTMs", () => {
+    it("returns null when window is undefined", () => {
+      const origWindow = globalThis.window;
+      // @ts-expect-error - intentionally deleting window
+      delete globalThis.window;
+      expect(getUTMs()).toBeNull();
+      globalThis.window = origWindow;
+    });
+
+    it("returns null when cookie does not exist", () => {
+      mockCookiesGet.mockReturnValue(undefined as any);
+      expect(getUTMs()).toBeNull();
+      expect(mockCookiesGet).toHaveBeenCalledWith("utm_parameters");
+    });
+
+    it("decodes and parses a valid Base64 cookie", () => {
+      const utms = { utm_source: "google", utm_medium: "cpc" };
+      const encoded = Base64.encode(JSON.stringify(utms));
+      mockCookiesGet.mockReturnValue(encoded as any);
+
+      expect(getUTMs()).toEqual(utms);
+    });
+
+    it("returns null for an invalid Base64/JSON cookie", () => {
+      mockCookiesGet.mockReturnValue("not-valid-base64!!!" as any);
+      expect(getUTMs()).toBeNull();
+    });
+  });
+
+  // ── setUTMs ──────────────────────────────────────────
+  describe("setUTMs", () => {
+    it("returns early when window is undefined", () => {
+      const origWindow = globalThis.window;
+      // @ts-expect-error - intentionally deleting window
+      delete globalThis.window;
+      setUTMs({ utm_source: "test" });
+      expect(mockCookiesSet).not.toHaveBeenCalled();
+      globalThis.window = origWindow;
+    });
+
+    it("encodes UTMs to Base64 and sets cookie with default domain", () => {
+      const utms = { utm_source: "google" };
+      setUTMs(utms);
+
+      const expectedEncoded = Base64.encode(JSON.stringify(utms));
+      expect(mockCookiesSet).toHaveBeenCalledWith(
+        "utm_parameters",
+        expectedEncoded,
+        { domain: ".gokinetic.com", path: "/", sameSite: "Lax" }
+      );
+    });
+
+    it("accepts a custom domain", () => {
+      setUTMs({ utm_source: "bing" }, ".custom.com");
+      expect(mockCookiesSet).toHaveBeenCalledWith(
+        "utm_parameters",
+        expect.any(String),
+        { domain: ".custom.com", path: "/", sameSite: "Lax" }
+      );
+    });
+  });
+
+  // ── removeUTMs ───────────────────────────────────────
+  describe("removeUTMs", () => {
+    it("removes cookie with default domain", () => {
+      removeUTMs();
+      expect(mockCookiesRemove).toHaveBeenCalledWith("utm_parameters", {
+        domain: ".gokinetic.com",
+        path: "/",
+      });
+    });
+
+    it("removes cookie with custom domain", () => {
+      removeUTMs(".other.com");
+      expect(mockCookiesRemove).toHaveBeenCalledWith("utm_parameters", {
+        domain: ".other.com",
+        path: "/",
+      });
+    });
+  });
+
+  // ── getCookie ────────────────────────────────────────
+  describe("getCookie", () => {
+    it("returns empty string when window is undefined", () => {
+      const origWindow = globalThis.window;
+      // @ts-expect-error - intentionally deleting window
+      delete globalThis.window;
+      expect(getCookie("key")).toBe("");
+      globalThis.window = origWindow;
+    });
+
+    it("returns decoded value when cookie exists", () => {
+      const value = "hello world";
+      mockCookiesGet.mockReturnValue(Base64.encode(value) as any);
+      expect(getCookie("my_key")).toBe(value);
+    });
+
+    it("returns null when cookie does not exist", () => {
+      mockCookiesGet.mockReturnValue(undefined as any);
+      expect(getCookie("missing")).toBeNull();
+    });
+  });
+
+  // ── getParsedCookie ──────────────────────────────────
+  describe("getParsedCookie", () => {
+    it("returns parsed JSON from cookie", () => {
+      const obj = { foo: "bar", num: 42 };
+      mockCookiesGet.mockReturnValue(Base64.encode(JSON.stringify(obj)) as any);
+      expect(getParsedCookie("key")).toEqual(obj);
+    });
+
+    it("returns null when cookie is missing", () => {
+      mockCookiesGet.mockReturnValue(undefined as any);
+      expect(getParsedCookie("missing")).toBeNull();
+    });
+
+    it("returns null when cookie has invalid JSON", () => {
+      mockCookiesGet.mockReturnValue(Base64.encode("not json") as any);
+      expect(getParsedCookie("bad")).toBeNull();
+    });
+  });
+
+  // ── setCookie ────────────────────────────────────────
+  describe("setCookie", () => {
+    it("returns early when window is undefined", () => {
+      const origWindow = globalThis.window;
+      // @ts-expect-error - intentionally deleting window
+      delete globalThis.window;
+      setCookie("key", "value", {});
+      expect(mockCookiesSet).not.toHaveBeenCalled();
+      globalThis.window = origWindow;
+    });
+
+    it("encodes value to Base64 and sets cookie with options", () => {
+      const value = { plan: "fiber", speed: 500 };
+      const options = { domain: ".test.com", path: "/" };
+      setCookie("plan_data", value, options);
+
+      const expectedEncoded = Base64.encode(JSON.stringify(value));
+      expect(mockCookiesSet).toHaveBeenCalledWith(
+        "plan_data",
+        expectedEncoded,
+        options
+      );
+    });
+
+    it("handles string values", () => {
+      setCookie("simple", "hello", { path: "/" });
+      const expectedEncoded = Base64.encode(JSON.stringify("hello"));
+      expect(mockCookiesSet).toHaveBeenCalledWith("simple", expectedEncoded, {
+        path: "/",
+      });
+    });
+  });
+});