@windstream/react-shared-components 0.1.38 → 0.1.40

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.ts

@@ -0,0 +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;
+};

package/src/utils/cookie.ts

@@ -1,80 +1,84 @@
-/**
- * Cookie Helpers for UTM Parameter Storage
- *
- * Provides Base64-encoded JSON cookie storage for UTM parameters.
- */
-import type { UTMProperties } from "../types/utm";
-import { Base64 } from "js-base64";
-import Cookies from "js-cookie";
-
-const UTM_COOKIE_KEY = "utm_parameters";
-const DEFAULT_DOMAIN = ".windstream.com";
-
-/**
- * Reads UTM parameters from the Base64-encoded cookie.
- * @returns Parsed UTMProperties or null if cookie doesn't exist / is invalid.
- */
-export function getUTMs(): UTMProperties | null {
-  if (typeof window === "undefined") return null;
-
-  const raw = Cookies.get(UTM_COOKIE_KEY);
-  if (!raw) return null;
-
-  try {
-    const decoded = Base64.decode(raw);
-    return JSON.parse(decoded) as UTMProperties;
-  } catch {
-    return null;
-  }
-}
-
-/**
- * Stores UTM parameters as a Base64-encoded JSON cookie.
- * @param utms - The UTM properties to store.
- * @param domain - Cookie domain (defaults to `.windstream.com`).
- */
-export function setUTMs(
-  utms: UTMProperties,
-  domain: string = DEFAULT_DOMAIN
-): void {
-  if (typeof window === "undefined") return;
-
-  const json = JSON.stringify(utms);
-  const encoded = Base64.encode(json);
-
-  Cookies.set(UTM_COOKIE_KEY, encoded, {
-    domain,
-    path: "/",
-    sameSite: "Lax",
-  });
-}
-
-/**
- * Removes the UTM cookie.
- * @param domain - Cookie domain (defaults to `.windstream.com`).
- */
-export function removeUTMs(domain: string = DEFAULT_DOMAIN): void {
-  Cookies.remove(UTM_COOKIE_KEY, { domain, path: "/" });
-}
-export function getCookie(key: string): string | null {
-  if (typeof window === "undefined") return "";
-  const encryptedValue = Cookies.get(key);
-
-  if (encryptedValue) return Base64.decode(encryptedValue);
-
-  return null;
-};
-export const getParsedCookie = (key: string) => {
-  try {
-    return JSON.parse(getCookie(key) || "");
-  } catch {
-    return null;
-  }
-};
-export const setCookie = (key: string, value: any, options: Cookies.CookieAttributes) => {
-  if (typeof window === "undefined") return;
-  const stringValue = JSON.stringify(value);
-  const encryptedValue = Base64.encode(stringValue);
-
-  Cookies.set(key, encryptedValue, options);
-};
+/**
+ * Cookie Helpers for UTM Parameter Storage
+ *
+ * Provides Base64-encoded JSON cookie storage for UTM parameters.
+ */
+import type { UTMProperties } from "../types/utm";
+import { Base64 } from "js-base64";
+import Cookies from "js-cookie";
+
+const UTM_COOKIE_KEY = "utm_parameters";
+const DEFAULT_DOMAIN = ".windstream.com";
+
+/**
+ * Reads UTM parameters from the Base64-encoded cookie.
+ * @returns Parsed UTMProperties or null if cookie doesn't exist / is invalid.
+ */
+export function getUTMs(): UTMProperties | null {
+  if (typeof window === "undefined") return null;
+
+  const raw = Cookies.get(UTM_COOKIE_KEY);
+  if (!raw) return null;
+
+  try {
+    const decoded = Base64.decode(raw);
+    return JSON.parse(decoded) as UTMProperties;
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Stores UTM parameters as a Base64-encoded JSON cookie.
+ * @param utms - The UTM properties to store.
+ * @param domain - Cookie domain (defaults to `.windstream.com`).
+ */
+export function setUTMs(
+  utms: UTMProperties,
+  domain: string = DEFAULT_DOMAIN
+): void {
+  if (typeof window === "undefined") return;
+
+  const json = JSON.stringify(utms);
+  const encoded = Base64.encode(json);
+
+  Cookies.set(UTM_COOKIE_KEY, encoded, {
+    domain,
+    path: "/",
+    sameSite: "Lax",
+  });
+}
+
+/**
+ * Removes the UTM cookie.
+ * @param domain - Cookie domain (defaults to `.windstream.com`).
+ */
+export function removeUTMs(domain: string = DEFAULT_DOMAIN): void {
+  Cookies.remove(UTM_COOKIE_KEY, { domain, path: "/" });
+}
+export function getCookie(key: string): string | null {
+  if (typeof window === "undefined") return "";
+  const encryptedValue = Cookies.get(key);
+
+  if (encryptedValue) return Base64.decode(encryptedValue);
+
+  return null;
+}
+export const getParsedCookie = (key: string) => {
+  try {
+    return JSON.parse(getCookie(key) || "");
+  } catch {
+    return null;
+  }
+};
+export const setCookie = (
+  key: string,
+  value: any,
+  options: Cookies.CookieAttributes
+) => {
+  if (typeof window === "undefined") return;
+  const stringValue = JSON.stringify(value);
+  const encryptedValue = Base64.encode(stringValue);
+
+  Cookies.set(key, encryptedValue, options);
+};

package/src/utils/cx.ts

@@ -0,0 +1,49 @@
+import { clsx, type ClassValue } from "clsx";
+import { extendTailwindMerge } from "tailwind-merge";
+
+const twMerge = extendTailwindMerge({
+  // Define class groups so twMerge knows which classes override each other
+  extend: {
+    classGroups: {
+      ["font-variants" as any]: [
+        "heading1",
+        "heading2",
+        "heading3",
+        "heading4",
+        "heading5",
+        "heading6",
+        "subheading1",
+        "subheading2",
+        "subheading3",
+        "subheading4",
+        "subheading5",
+        "subheading6",
+        "body1",
+        "body2",
+        "body3",
+        "footnote",
+        "micro",
+        "label1",
+        "label2",
+        "label3",
+        "label4",
+      ],
+      ["button-sizes" as any]: [
+        "btn-small",
+        "btn-medium",
+        "btn-large",
+        "btn-x-large",
+      ],
+    },
+  },
+});
+
+/**
+ * Utility function to combine class names using clsx
+ * @param inputs - Class values to combine
+ * @returns Combined class string
+ */
+export const cx = (...val: ClassValue[]) => twMerge(clsx(...val));
+
+export { clsx };
+export type { ClassValue };

package/src/utils/index.ts

@@ -1,65 +1,38 @@
-import { clsx, type ClassValue } from "clsx";
-import { extendTailwindMerge } from "tailwind-merge";
-
-const twMerge = extendTailwindMerge({
-  // Define class groups so twMerge knows which classes override each other
-  extend: {
-    classGroups: {
-      ["font-variants" as any]: [
-        "heading1",
-        "heading2",
-        "heading3",
-        "heading4",
-        "heading5",
-        "heading6",
-        "subheading1",
-        "subheading2",
-        "subheading3",
-        "subheading4",
-        "subheading5",
-        "subheading6",
-        "body1",
-        "body2",
-        "body3",
-        "footnote",
-        "micro",
-        "label1",
-        "label2",
-        "label3",
-        "label4",
-      ],
-      ["button-sizes" as any]: [
-        "btn-small",
-        "btn-medium",
-        "btn-large",
-        "btn-x-large",
-      ],
-    },
-  },
-});
-
-/**
- * Utility function to combine class names using clsx
- * @param inputs - Class values to combine
- * @returns Combined class string
- */
-export const cx = (...val: ClassValue[]) => twMerge(clsx(...val));
-
-export { clsx };
-export type { ClassValue };
-
-// UTM & Cookie utilities
-export { getUTMs, setUTMs, removeUTMs, getCookie, getParsedCookie, setCookie } from "./cookie";
-export {
-  getUtmParametersFromURL,
-  combineExistingAndNewUTMs,
-  getOrganicTrafficUtmParameters,
-  getCampaignProperties,
-  buildPreservedQueryHref,
-} from "./utm";
-export type {
-  UTMProperty,
-  UTMProperties,
-  CampaignProperties,
-} from "../types/utm";
-export { UTM_PARAM_NAMES } from "../types/utm";
+export { cx, clsx } from "./cx";
+export type { ClassValue } from "./cx";
+
+// UTM & Cookie utilities
+export {
+  getUTMs,
+  setUTMs,
+  removeUTMs,
+  getCookie,
+  getParsedCookie,
+  setCookie,
+} from "./cookie";
+export {
+  getUtmParametersFromURL,
+  combineExistingAndNewUTMs,
+  getOrganicTrafficUtmParameters,
+  getCampaignProperties,
+  buildPreservedQueryHref,
+} from "./utm";
+export type {
+  UTMProperty,
+  UTMProperties,
+  CampaignProperties,
+} from "../types/utm";
+export { UTM_PARAM_NAMES } from "../types/utm";
+
+// Contentful utilities (server-safe, no "use client")
+export { toDocument } from "./contentful/to-document";
+export {
+  renderContentfulRichText,
+  useContentfulRichText,
+  renderContentfulRichTextTable,
+} from "../hooks/contentful/use-contentful-rich-text";
+export {
+  useProcessedChecklist,
+  label1BoldOptions,
+} from "../hooks/contentful/use-processed-check-list";
+export type { ProcessedChecklistItem } from "../hooks/contentful/use-processed-check-list";