@windstream/react-shared-components 0.1.78 → 0.1.79

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (204) hide show
  1. package/README.md +635 -635
  2. package/dist/contentful/index.d.ts +3 -1
  3. package/dist/contentful/index.esm.js +3 -3
  4. package/dist/contentful/index.esm.js.map +1 -1
  5. package/dist/contentful/index.js +2 -2
  6. package/dist/contentful/index.js.map +1 -1
  7. package/dist/core.d.ts +1 -1
  8. package/dist/index.d.ts +1 -1
  9. package/dist/index.esm.js.map +1 -1
  10. package/dist/index.js.map +1 -1
  11. package/dist/next/index.esm.js.map +1 -1
  12. package/dist/next/index.js.map +1 -1
  13. package/dist/styles.css +1 -1
  14. package/dist/utils/index.esm.js.map +1 -1
  15. package/dist/utils/index.js.map +1 -1
  16. package/package.json +185 -185
  17. package/src/components/accordion/Accordion.stories.tsx +230 -230
  18. package/src/components/accordion/index.tsx +70 -70
  19. package/src/components/accordion/types.ts +12 -12
  20. package/src/components/alert-card/AlertCard.stories.tsx +171 -171
  21. package/src/components/alert-card/index.tsx +41 -41
  22. package/src/components/alert-card/types.ts +13 -13
  23. package/src/components/brand-button/BrandButton.stories.tsx +223 -223
  24. package/src/components/brand-button/helpers.ts +35 -35
  25. package/src/components/brand-button/index.tsx +120 -120
  26. package/src/components/brand-button/types.ts +38 -38
  27. package/src/components/button/Button.stories.tsx +108 -108
  28. package/src/components/button/index.tsx +27 -27
  29. package/src/components/button/types.ts +14 -14
  30. package/src/components/call-button/CallButton.stories.tsx +324 -324
  31. package/src/components/call-button/index.tsx +106 -106
  32. package/src/components/call-button/types.ts +16 -16
  33. package/src/components/checkbox/Checkbox.stories.tsx +247 -247
  34. package/src/components/checkbox/index.tsx +197 -197
  35. package/src/components/checkbox/types.ts +27 -27
  36. package/src/components/checklist/Checklist.stories.tsx +150 -150
  37. package/src/components/checklist/index.tsx +61 -61
  38. package/src/components/checklist/types.ts +17 -17
  39. package/src/components/collapse/Collapse.stories.tsx +255 -255
  40. package/src/components/collapse/index.tsx +46 -46
  41. package/src/components/collapse/types.ts +6 -6
  42. package/src/components/divider/Divider.stories.tsx +205 -205
  43. package/src/components/divider/index.tsx +22 -22
  44. package/src/components/divider/type.ts +3 -3
  45. package/src/components/image/Image.stories.tsx +113 -113
  46. package/src/components/image/index.tsx +25 -25
  47. package/src/components/image/types.ts +40 -40
  48. package/src/components/input/Input.stories.tsx +325 -325
  49. package/src/components/input/index.tsx +177 -177
  50. package/src/components/input/types.ts +37 -37
  51. package/src/components/link/Link.stories.tsx +163 -163
  52. package/src/components/link/index.tsx +116 -116
  53. package/src/components/link/types.ts +25 -25
  54. package/src/components/list/List.stories.tsx +272 -272
  55. package/src/components/list/index.tsx +88 -88
  56. package/src/components/list/list-item/index.tsx +38 -38
  57. package/src/components/list/list-item/types.ts +13 -13
  58. package/src/components/list/types.ts +29 -29
  59. package/src/components/material-icon/MaterialIcon.stories.tsx +322 -322
  60. package/src/components/material-icon/constants.ts +99 -99
  61. package/src/components/material-icon/index.tsx +47 -47
  62. package/src/components/material-icon/types.ts +31 -31
  63. package/src/components/modal/Modal.stories.tsx +171 -171
  64. package/src/components/modal/index.tsx +164 -164
  65. package/src/components/modal/types.ts +24 -24
  66. package/src/components/next-image/index.tsx +74 -74
  67. package/src/components/next-image/types.ts +1 -1
  68. package/src/components/pagination/index.tsx +91 -91
  69. package/src/components/pagination/types.ts +6 -6
  70. package/src/components/radio-button/RadioButton.stories.tsx +307 -307
  71. package/src/components/radio-button/index.tsx +75 -75
  72. package/src/components/radio-button/types.ts +21 -21
  73. package/src/components/see-more/SeeMore.stories.tsx +181 -181
  74. package/src/components/see-more/index.tsx +44 -44
  75. package/src/components/see-more/types.ts +4 -4
  76. package/src/components/select/Select.stories.tsx +411 -411
  77. package/src/components/select/index.tsx +155 -155
  78. package/src/components/select/types.ts +36 -36
  79. package/src/components/select-plan-button/SelectPlanButton.stories.tsx +184 -184
  80. package/src/components/select-plan-button/index.tsx +63 -63
  81. package/src/components/select-plan-button/types.ts +17 -17
  82. package/src/components/skeleton/Skeleton.stories.tsx +179 -179
  83. package/src/components/skeleton/index.tsx +61 -61
  84. package/src/components/skeleton/types.ts +4 -4
  85. package/src/components/spinner/Spinner.stories.tsx +335 -335
  86. package/src/components/spinner/index.tsx +44 -44
  87. package/src/components/spinner/types.ts +5 -5
  88. package/src/components/text/Text.stories.tsx +321 -321
  89. package/src/components/text/index.tsx +25 -25
  90. package/src/components/text/types.ts +45 -45
  91. package/src/components/tooltip/Tooltip.stories.tsx +219 -219
  92. package/src/components/tooltip/index.tsx +74 -74
  93. package/src/components/tooltip/types.ts +7 -7
  94. package/src/components/view-cart-button/ViewCartButton.stories.tsx +252 -252
  95. package/src/components/view-cart-button/index.tsx +42 -42
  96. package/src/components/view-cart-button/types.ts +5 -5
  97. package/src/contentful/blocks/accordion/Accordion.stories.mocks.tsx +128 -128
  98. package/src/contentful/blocks/accordion/Accordion.stories.tsx +98 -98
  99. package/src/contentful/blocks/accordion/index.tsx +112 -112
  100. package/src/contentful/blocks/accordion/types.ts +34 -34
  101. package/src/contentful/blocks/address-input-banner/index.tsx +52 -52
  102. package/src/contentful/blocks/address-input-banner/types.ts +14 -14
  103. package/src/contentful/blocks/anchored-bottom-banner/index.tsx +181 -181
  104. package/src/contentful/blocks/anchored-bottom-banner/types.ts +13 -13
  105. package/src/contentful/blocks/blogs-grid/BlogGrid.stories.mocks.tsx +144 -0
  106. package/src/contentful/blocks/blogs-grid/BlogGrid.stories.tsx +156 -0
  107. package/src/contentful/blocks/blogs-grid/index.tsx +134 -134
  108. package/src/contentful/blocks/blogs-grid/types.ts +26 -26
  109. package/src/contentful/blocks/blogs-grid-base/index.tsx +119 -119
  110. package/src/contentful/blocks/blogs-grid-base/types.ts +36 -36
  111. package/src/contentful/blocks/breadcrumbs/BreadcrumbNavigation.stories.tsx +147 -0
  112. package/src/contentful/blocks/breadcrumbs/index.tsx +95 -81
  113. package/src/contentful/blocks/breadcrumbs/types.ts +8 -6
  114. package/src/contentful/blocks/button/Button.stories.tsx +40 -40
  115. package/src/contentful/blocks/button/index.tsx +131 -131
  116. package/src/contentful/blocks/button/types.ts +39 -39
  117. package/src/contentful/blocks/callout/Callout.stories.tsx +23 -23
  118. package/src/contentful/blocks/callout/index.tsx +265 -265
  119. package/src/contentful/blocks/callout/types.ts +72 -72
  120. package/src/contentful/blocks/cards/Cards.stories.tsx +23 -23
  121. package/src/contentful/blocks/cards/blog-card/index.tsx +129 -129
  122. package/src/contentful/blocks/cards/blog-card/types.ts +34 -34
  123. package/src/contentful/blocks/cards/floating-image-card/index.tsx +119 -119
  124. package/src/contentful/blocks/cards/floating-image-card/types.ts +30 -30
  125. package/src/contentful/blocks/cards/full-image-card/index.tsx +130 -130
  126. package/src/contentful/blocks/cards/full-image-card/types.ts +29 -29
  127. package/src/contentful/blocks/cards/index.tsx +13 -13
  128. package/src/contentful/blocks/cards/product-card/index.tsx +251 -251
  129. package/src/contentful/blocks/cards/product-card/types.ts +28 -28
  130. package/src/contentful/blocks/cards/simple-card/index.tsx +325 -325
  131. package/src/contentful/blocks/cards/simple-card/types.ts +71 -71
  132. package/src/contentful/blocks/cards/testimonial-card/index.tsx +90 -90
  133. package/src/contentful/blocks/cards/testimonial-card/types.tsx +12 -12
  134. package/src/contentful/blocks/cards/types.ts +1 -1
  135. package/src/contentful/blocks/carousel/Carousel.stories.tsx +23 -23
  136. package/src/contentful/blocks/carousel/helper.tsx +440 -440
  137. package/src/contentful/blocks/carousel/index.tsx +85 -85
  138. package/src/contentful/blocks/carousel/types.ts +144 -144
  139. package/src/contentful/blocks/cart-retention-banner/index.tsx +105 -105
  140. package/src/contentful/blocks/cart-retention-banner/types.ts +11 -11
  141. package/src/contentful/blocks/comparison-table/index.tsx +29 -29
  142. package/src/contentful/blocks/comparison-table/types.ts +6 -6
  143. package/src/contentful/blocks/cookiebanner/index.tsx +146 -146
  144. package/src/contentful/blocks/cookiebanner/type.ts +7 -7
  145. package/src/contentful/blocks/cta-callout/CtaCallout.stories.tsx +46 -46
  146. package/src/contentful/blocks/cta-callout/index.tsx +71 -71
  147. package/src/contentful/blocks/cta-callout/types.ts +26 -26
  148. package/src/contentful/blocks/dynamic-tabs/index.tsx +204 -204
  149. package/src/contentful/blocks/dynamic-tabs/types.ts +21 -21
  150. package/src/contentful/blocks/email-input-block/index.tsx +116 -116
  151. package/src/contentful/blocks/email-input-block/types.ts +16 -16
  152. package/src/contentful/blocks/find-kinetic/FindKinetic.stories.tsx +23 -23
  153. package/src/contentful/blocks/find-kinetic/index.tsx +130 -130
  154. package/src/contentful/blocks/find-kinetic/types.ts +19 -19
  155. package/src/contentful/blocks/floating-banner/FloatingBanner.stories.tsx +34 -34
  156. package/src/contentful/blocks/floating-banner/index.tsx +97 -97
  157. package/src/contentful/blocks/floating-banner/types.ts +22 -22
  158. package/src/contentful/blocks/footer/Footer.stories.tsx +317 -317
  159. package/src/contentful/blocks/footer/index.tsx +91 -91
  160. package/src/contentful/blocks/footer/types.ts +13 -13
  161. package/src/contentful/blocks/image-promo-bar/ImagePromoBar.stories.tsx +23 -23
  162. package/src/contentful/blocks/image-promo-bar/helper.tsx +28 -28
  163. package/src/contentful/blocks/image-promo-bar/index.tsx +246 -246
  164. package/src/contentful/blocks/image-promo-bar/types.ts +44 -44
  165. package/src/contentful/blocks/image-promo-bar/vimeo-embed.tsx +93 -93
  166. package/src/contentful/blocks/image-promo-bar/youtube-embed.tsx +46 -46
  167. package/src/contentful/blocks/modal/constants.ts +53 -53
  168. package/src/contentful/blocks/modal/index.tsx +107 -107
  169. package/src/contentful/blocks/modal/types.ts +12 -12
  170. package/src/contentful/blocks/navigation/desktop-link-groups.tsx/index.tsx +139 -139
  171. package/src/contentful/blocks/navigation/index.tsx +568 -568
  172. package/src/contentful/blocks/navigation/mobile-link-groups.tsx/index.tsx +82 -82
  173. package/src/contentful/blocks/navigation/types.ts +71 -71
  174. package/src/contentful/blocks/primary-hero/PrimaryHero.stories.tsx +23 -23
  175. package/src/contentful/blocks/primary-hero/index.tsx +236 -236
  176. package/src/contentful/blocks/primary-hero/types.ts +37 -37
  177. package/src/contentful/blocks/search-block/index.tsx +90 -90
  178. package/src/contentful/blocks/search-block/types.ts +15 -15
  179. package/src/contentful/blocks/shape-background-wrapper/ShapeBackgroundWrapper.stories.tsx +26 -26
  180. package/src/contentful/blocks/shape-background-wrapper/index.tsx +124 -124
  181. package/src/contentful/blocks/shape-background-wrapper/types.ts +36 -36
  182. package/src/contentful/blocks/text/Text.stories.tsx +23 -23
  183. package/src/contentful/blocks/text/index.tsx +12 -12
  184. package/src/contentful/blocks/text/types.ts +1 -1
  185. package/src/contentful/index.ts +105 -105
  186. package/src/hooks/contentful/use-contentful-rich-text.tsx +309 -309
  187. package/src/hooks/contentful/use-processed-check-list.ts +63 -63
  188. package/src/hooks/use-body-scroll-lock.ts +34 -34
  189. package/src/hooks/use-carousel-swipe.ts +264 -264
  190. package/src/hooks/use-outside-click.ts +17 -17
  191. package/src/index.ts +101 -101
  192. package/src/next/index.ts +5 -5
  193. package/src/setupTests.ts +46 -46
  194. package/src/stories/DocsTemplate.tsx +24 -24
  195. package/src/styles/globals.css +343 -343
  196. package/src/types/global.d.ts +9 -9
  197. package/src/types/micro-components.ts +99 -99
  198. package/src/types/utm.ts +49 -49
  199. package/src/utils/contentful/to-document.ts +24 -24
  200. package/src/utils/cookie.ts +84 -84
  201. package/src/utils/cx.ts +49 -49
  202. package/src/utils/index.ts +41 -41
  203. package/src/utils/speed-card-bg.ts +24 -24
  204. package/src/utils/utm.ts +221 -221
@@ -1,41 +1,41 @@
1
- export { cx, clsx } from "./cx";
2
- export type { ClassValue } from "./cx";
3
-
4
- // Decorative SVG generators
5
- export { SpeedCardBg } from "./speed-card-bg";
6
-
7
- // UTM & Cookie utilities
8
- export {
9
- getUTMs,
10
- setUTMs,
11
- removeUTMs,
12
- getCookie,
13
- getParsedCookie,
14
- setCookie,
15
- } from "./cookie";
16
- export {
17
- getUtmParametersFromURL,
18
- combineExistingAndNewUTMs,
19
- getOrganicTrafficUtmParameters,
20
- getCampaignProperties,
21
- buildPreservedQueryHref,
22
- } from "./utm";
23
- export type {
24
- UTMProperty,
25
- UTMProperties,
26
- CampaignProperties,
27
- } from "../types/utm";
28
- export { UTM_PARAM_NAMES } from "../types/utm";
29
-
30
- // Contentful utilities (server-safe, no "use client")
31
- export { toDocument } from "./contentful/to-document";
32
- export {
33
- renderContentfulRichText,
34
- useContentfulRichText,
35
- renderContentfulRichTextTable,
36
- } from "../hooks/contentful/use-contentful-rich-text";
37
- export {
38
- useProcessedChecklist,
39
- label1BoldOptions,
40
- } from "../hooks/contentful/use-processed-check-list";
41
- export type { ProcessedChecklistItem } from "../hooks/contentful/use-processed-check-list";
1
+ export { cx, clsx } from "./cx";
2
+ export type { ClassValue } from "./cx";
3
+
4
+ // Decorative SVG generators
5
+ export { SpeedCardBg } from "./speed-card-bg";
6
+
7
+ // UTM & Cookie utilities
8
+ export {
9
+ getUTMs,
10
+ setUTMs,
11
+ removeUTMs,
12
+ getCookie,
13
+ getParsedCookie,
14
+ setCookie,
15
+ } from "./cookie";
16
+ export {
17
+ getUtmParametersFromURL,
18
+ combineExistingAndNewUTMs,
19
+ getOrganicTrafficUtmParameters,
20
+ getCampaignProperties,
21
+ buildPreservedQueryHref,
22
+ } from "./utm";
23
+ export type {
24
+ UTMProperty,
25
+ UTMProperties,
26
+ CampaignProperties,
27
+ } from "../types/utm";
28
+ export { UTM_PARAM_NAMES } from "../types/utm";
29
+
30
+ // Contentful utilities (server-safe, no "use client")
31
+ export { toDocument } from "./contentful/to-document";
32
+ export {
33
+ renderContentfulRichText,
34
+ useContentfulRichText,
35
+ renderContentfulRichTextTable,
36
+ } from "../hooks/contentful/use-contentful-rich-text";
37
+ export {
38
+ useProcessedChecklist,
39
+ label1BoldOptions,
40
+ } from "../hooks/contentful/use-processed-check-list";
41
+ export type { ProcessedChecklistItem } from "../hooks/contentful/use-processed-check-list";
@@ -1,24 +1,24 @@
1
- /**
2
- * Returns an inline SVG string for the SpeedCard pinwheel decorative
3
- * background. The two paths are filled with the provided color so callers
4
- * can theme the background dynamically (used by SimpleCard when
5
- * `showBackgroundImage` is enabled and a `pinwheelColor` is provided).
6
- *
7
- * Output is intended to be embedded as a `data:image/svg+xml;utf8,...`
8
- * `background-image`. Encode the result with `encodeURIComponent`.
9
- */
10
- export const SpeedCardBg = (color: string = "#24A76A"): string => {
11
- return `<svg xmlns="http://www.w3.org/2000/svg" width="684" height="107" viewBox="0 0 684 107" fill="none">
12
- <g clip-path="url(#clip0_12352_9042)">
13
- <path d="M154.09 -70.5605C173.769 -7.58032 204.79 24.8889 328.202 55.2823C444.619 83.9133 629.479 141.332 667.653 80.7015C691.679 45.2165 678.322 -5.62201 670.537 -46.3554C664.452 -73.1846 658.327 -97.1939 652.913 -123.475C651.135 -132.091 638.766 -131.974 637.067 -123.318C628.136 -77.6888 612.526 -44.9062 577.593 -22.4637C517.962 20.1889 377.954 -6.48361 303.148 -38.287C223.245 -70.7171 200.918 -132.366 195.425 -199.341C193.37 -235.257 198.467 -269.841 208.07 -299.569C210.915 -308.303 199.218 -314.178 193.844 -306.697C151.324 -247.751 137.69 -140.395 154.129 -70.5213" fill="${color}" />
14
- <path d="M167.605 -417.382C104.062 -397.877 71.302 -367.131 40.6368 -244.813C11.7499 -129.428 -46.182 53.7941 14.9903 91.6292C50.7927 115.443 102.086 102.204 143.183 94.4883C170.253 88.4567 194.476 82.3858 220.992 77.02C229.686 75.2574 229.568 62.9983 220.834 61.3141C174.797 52.4624 141.721 36.9915 119.078 2.36813C76.0441 -56.7345 102.955 -195.502 135.043 -269.645C167.763 -348.84 229.963 -370.969 297.537 -376.414C333.774 -378.45 368.667 -373.398 398.661 -363.88C407.473 -361.06 413.401 -372.654 405.853 -377.98C346.38 -420.124 238.064 -433.636 167.565 -417.343" fill="${color}" />
15
- </g>
16
- <defs>
17
- <clipPath id="clip0_12352_9042">
18
- <rect width="684" height="107" fill="white" />
19
- </clipPath>
20
- </defs>
21
- </svg>`;
22
- };
23
-
24
- export default SpeedCardBg;
1
+ /**
2
+ * Returns an inline SVG string for the SpeedCard pinwheel decorative
3
+ * background. The two paths are filled with the provided color so callers
4
+ * can theme the background dynamically (used by SimpleCard when
5
+ * `showBackgroundImage` is enabled and a `pinwheelColor` is provided).
6
+ *
7
+ * Output is intended to be embedded as a `data:image/svg+xml;utf8,...`
8
+ * `background-image`. Encode the result with `encodeURIComponent`.
9
+ */
10
+ export const SpeedCardBg = (color: string = "#24A76A"): string => {
11
+ return `<svg xmlns="http://www.w3.org/2000/svg" width="684" height="107" viewBox="0 0 684 107" fill="none">
12
+ <g clip-path="url(#clip0_12352_9042)">
13
+ <path d="M154.09 -70.5605C173.769 -7.58032 204.79 24.8889 328.202 55.2823C444.619 83.9133 629.479 141.332 667.653 80.7015C691.679 45.2165 678.322 -5.62201 670.537 -46.3554C664.452 -73.1846 658.327 -97.1939 652.913 -123.475C651.135 -132.091 638.766 -131.974 637.067 -123.318C628.136 -77.6888 612.526 -44.9062 577.593 -22.4637C517.962 20.1889 377.954 -6.48361 303.148 -38.287C223.245 -70.7171 200.918 -132.366 195.425 -199.341C193.37 -235.257 198.467 -269.841 208.07 -299.569C210.915 -308.303 199.218 -314.178 193.844 -306.697C151.324 -247.751 137.69 -140.395 154.129 -70.5213" fill="${color}" />
14
+ <path d="M167.605 -417.382C104.062 -397.877 71.302 -367.131 40.6368 -244.813C11.7499 -129.428 -46.182 53.7941 14.9903 91.6292C50.7927 115.443 102.086 102.204 143.183 94.4883C170.253 88.4567 194.476 82.3858 220.992 77.02C229.686 75.2574 229.568 62.9983 220.834 61.3141C174.797 52.4624 141.721 36.9915 119.078 2.36813C76.0441 -56.7345 102.955 -195.502 135.043 -269.645C167.763 -348.84 229.963 -370.969 297.537 -376.414C333.774 -378.45 368.667 -373.398 398.661 -363.88C407.473 -361.06 413.401 -372.654 405.853 -377.98C346.38 -420.124 238.064 -433.636 167.565 -417.343" fill="${color}" />
15
+ </g>
16
+ <defs>
17
+ <clipPath id="clip0_12352_9042">
18
+ <rect width="684" height="107" fill="white" />
19
+ </clipPath>
20
+ </defs>
21
+ </svg>`;
22
+ };
23
+
24
+ export default SpeedCardBg;
package/src/utils/utm.ts CHANGED
@@ -1,221 +1,221 @@
1
- /**
2
- * UTM Parameter Helpers
3
- *
4
- * Functions for extracting, combining, and mapping UTM parameters
5
- * for marketing campaign attribution.
6
- */
7
- import {
8
- UTM_PARAM_NAMES,
9
- type CampaignProperties,
10
- type UTMProperties,
11
- type UTMProperty,
12
- } from "../types/utm";
13
-
14
- /**
15
- * Extracts UTM parameters from the current page URL.
16
- * Parses window.location.search for the 10 tracked UTM/click-ID params.
17
- * @returns UTMProperties with any found values, or null if none found.
18
- */
19
- export function getUtmParametersFromURL(): UTMProperties | null {
20
- if (typeof window === "undefined") return null;
21
-
22
- const searchParams = new URLSearchParams(window.location.search);
23
- const utms: UTMProperties = {};
24
- let found = false;
25
-
26
- for (const param of UTM_PARAM_NAMES) {
27
- const value = searchParams.get(param);
28
- if (value) {
29
- utms[param] = value;
30
- found = true;
31
- }
32
- }
33
-
34
- return found ? utms : null;
35
- }
36
-
37
- /**
38
- * Smart-merges existing (cookie) UTMs with newly arrived (URL) UTMs.
39
- *
40
- * Logic:
41
- * - If the same campaign (campaign, medium, source, campaign_id, adgroup_id,
42
- * fbclid, gclid, msclkid all match): preserve existing utm_content and
43
- * utm_term (first-touch attribution for ad content/keyword).
44
- * - If only campaign-level UTMs changed (no new content/term provided):
45
- * carry forward existing content/term from cookie.
46
- * - If completely different campaign: new UTMs fully overwrite.
47
- *
48
- * @param existing - UTM values currently stored in cookie.
49
- * @param incoming - UTM values extracted from the current URL.
50
- * @returns Merged UTMProperties.
51
- */
52
- export function combineExistingAndNewUTMs(
53
- existing: UTMProperties | null,
54
- incoming: UTMProperties | null
55
- ): UTMProperties {
56
- if (!incoming) return existing || {};
57
- if (!existing) return incoming;
58
-
59
- // Campaign-level keys used to determine if it's the "same campaign"
60
- const campaignKeys: UTMProperty[] = [
61
- "utm_campaign",
62
- "utm_medium",
63
- "utm_source",
64
- "utm_campaign_id",
65
- "utm_adgroup_id",
66
- "fbclid",
67
- "gclid",
68
- "msclkid",
69
- ];
70
-
71
- const isSameCampaign = campaignKeys.every(
72
- key => (existing[key] || "") === (incoming[key] || "")
73
- );
74
-
75
- if (isSameCampaign) {
76
- // Same campaign — preserve existing content/term (first-touch)
77
- return {
78
- ...incoming,
79
- utm_content: existing.utm_content || incoming.utm_content,
80
- utm_term: existing.utm_term || incoming.utm_term,
81
- };
82
- }
83
-
84
- // Different campaign — check if incoming has content/term
85
- const hasNewContent = !!incoming.utm_content;
86
- const hasNewTerm = !!incoming.utm_term;
87
-
88
- return {
89
- ...incoming,
90
- // Carry forward existing content/term only if incoming doesn't provide them
91
- ...(!hasNewContent &&
92
- existing.utm_content && { utm_content: existing.utm_content }),
93
- ...(!hasNewTerm && existing.utm_term && { utm_term: existing.utm_term }),
94
- };
95
- }
96
-
97
- /**
98
- * Generates synthetic UTM parameters for organic/direct traffic
99
- * based on document.referrer.
100
- *
101
- * - No referrer → direct / direct
102
- * - Google/Bing → organic / google or bing
103
- * - Other external site (not windstream.com) → referral / <domain>
104
- * - Internal (windstream.com) → null (no cookie set)
105
- *
106
- * @returns UTMProperties for organic traffic, or null for internal nav.
107
- */
108
- export function getOrganicTrafficUtmParameters(): UTMProperties | null {
109
- if (typeof document === "undefined") return null;
110
-
111
- const referrer = document.referrer;
112
-
113
- if (!referrer) {
114
- return { utm_medium: "direct", utm_source: "direct" };
115
- }
116
-
117
- let referrerHost: string;
118
- try {
119
- referrerHost = new URL(referrer).hostname.toLowerCase();
120
- } catch {
121
- return { utm_medium: "direct", utm_source: "direct" };
122
- }
123
-
124
- // Internal navigation — don't set organic UTMs
125
- if (
126
- referrerHost.includes("windstream.com") ||
127
- referrerHost.includes("gokinetic.com")
128
- ) {
129
- return null;
130
- }
131
-
132
- // Search engines → organic
133
- if (referrerHost.includes("google.")) {
134
- return { utm_medium: "organic", utm_source: "google" };
135
- }
136
- if (referrerHost.includes("bing.")) {
137
- return { utm_medium: "organic", utm_source: "bing" };
138
- }
139
-
140
- // External referral
141
- return { utm_medium: "referral", utm_source: referrerHost };
142
- }
143
-
144
- /**
145
- * Maps UTMProperties to Segment's campaign context schema.
146
- * @param utms - The UTM properties (typically from cookie).
147
- * @returns CampaignProperties for Segment context.
148
- */
149
- export function getCampaignProperties(
150
- utms: UTMProperties | null
151
- ): CampaignProperties | null {
152
- if (!utms) return null;
153
-
154
- const campaign: CampaignProperties = {};
155
-
156
- if (utms.utm_campaign) campaign.name = utms.utm_campaign;
157
- if (utms.utm_source) campaign.source = utms.utm_source;
158
- if (utms.utm_medium) campaign.medium = utms.utm_medium;
159
- if (utms.utm_term) campaign.term = utms.utm_term;
160
- if (utms.utm_content) campaign.content = utms.utm_content;
161
- if (utms.utm_campaign_id) campaign.campaign_id = utms.utm_campaign_id;
162
- if (utms.utm_adgroup_id) campaign.adgroup_id = utms.utm_adgroup_id;
163
- if (utms.gclid) campaign.gclid = utms.gclid;
164
- if (utms.fbclid) campaign.fbclid = utms.fbclid;
165
- if (utms.msclkid) campaign.msclkid = utms.msclkid;
166
-
167
- return Object.keys(campaign).length > 0 ? campaign : null;
168
- }
169
-
170
- /**
171
- * Builds a URL with non-UTM query params preserved and UTM params stripped.
172
- * Used by the Link/Button component when preserveQueryParameters is true.
173
- *
174
- * @param href - The target URL/path.
175
- * @param currentSearch - The current page's search string (e.g. "?foo=bar&utm_source=google").
176
- * @returns The href with non-UTM params merged and UTM params removed.
177
- */
178
- export function buildPreservedQueryHref(
179
- href: string,
180
- currentSearch: string
181
- ): string {
182
- if (!currentSearch) return href;
183
-
184
- const currentParams = new URLSearchParams(currentSearch);
185
- const utmSet = new Set<string>(UTM_PARAM_NAMES);
186
-
187
- // Also strip common non-UTM params that shouldn't carry forward
188
- const stripParams = new Set([...utmSet, "searchtext", "page"]);
189
-
190
- // Parse the target href to separate path and existing query
191
- let basePath: string;
192
- let targetParams: URLSearchParams;
193
-
194
- try {
195
- // Handle both absolute URLs and relative paths
196
- if (href.startsWith("http://") || href.startsWith("https://")) {
197
- const url = new URL(href);
198
- basePath = url.origin + url.pathname;
199
- targetParams = url.searchParams;
200
- } else {
201
- const [path, query] = href.split("?");
202
- basePath = path;
203
- targetParams = new URLSearchParams(query || "");
204
- }
205
- } catch {
206
- return href;
207
- }
208
-
209
- // Start with target's existing params
210
- const merged = new URLSearchParams(targetParams);
211
-
212
- // Add current page params that aren't UTM and aren't already in target
213
- currentParams.forEach((value, key) => {
214
- if (!stripParams.has(key.toLowerCase()) && !merged.has(key)) {
215
- merged.set(key, value);
216
- }
217
- });
218
-
219
- const queryString = merged.toString();
220
- return queryString ? `${basePath}?${queryString}` : basePath;
221
- }
1
+ /**
2
+ * UTM Parameter Helpers
3
+ *
4
+ * Functions for extracting, combining, and mapping UTM parameters
5
+ * for marketing campaign attribution.
6
+ */
7
+ import {
8
+ UTM_PARAM_NAMES,
9
+ type CampaignProperties,
10
+ type UTMProperties,
11
+ type UTMProperty,
12
+ } from "../types/utm";
13
+
14
+ /**
15
+ * Extracts UTM parameters from the current page URL.
16
+ * Parses window.location.search for the 10 tracked UTM/click-ID params.
17
+ * @returns UTMProperties with any found values, or null if none found.
18
+ */
19
+ export function getUtmParametersFromURL(): UTMProperties | null {
20
+ if (typeof window === "undefined") return null;
21
+
22
+ const searchParams = new URLSearchParams(window.location.search);
23
+ const utms: UTMProperties = {};
24
+ let found = false;
25
+
26
+ for (const param of UTM_PARAM_NAMES) {
27
+ const value = searchParams.get(param);
28
+ if (value) {
29
+ utms[param] = value;
30
+ found = true;
31
+ }
32
+ }
33
+
34
+ return found ? utms : null;
35
+ }
36
+
37
+ /**
38
+ * Smart-merges existing (cookie) UTMs with newly arrived (URL) UTMs.
39
+ *
40
+ * Logic:
41
+ * - If the same campaign (campaign, medium, source, campaign_id, adgroup_id,
42
+ * fbclid, gclid, msclkid all match): preserve existing utm_content and
43
+ * utm_term (first-touch attribution for ad content/keyword).
44
+ * - If only campaign-level UTMs changed (no new content/term provided):
45
+ * carry forward existing content/term from cookie.
46
+ * - If completely different campaign: new UTMs fully overwrite.
47
+ *
48
+ * @param existing - UTM values currently stored in cookie.
49
+ * @param incoming - UTM values extracted from the current URL.
50
+ * @returns Merged UTMProperties.
51
+ */
52
+ export function combineExistingAndNewUTMs(
53
+ existing: UTMProperties | null,
54
+ incoming: UTMProperties | null
55
+ ): UTMProperties {
56
+ if (!incoming) return existing || {};
57
+ if (!existing) return incoming;
58
+
59
+ // Campaign-level keys used to determine if it's the "same campaign"
60
+ const campaignKeys: UTMProperty[] = [
61
+ "utm_campaign",
62
+ "utm_medium",
63
+ "utm_source",
64
+ "utm_campaign_id",
65
+ "utm_adgroup_id",
66
+ "fbclid",
67
+ "gclid",
68
+ "msclkid",
69
+ ];
70
+
71
+ const isSameCampaign = campaignKeys.every(
72
+ key => (existing[key] || "") === (incoming[key] || "")
73
+ );
74
+
75
+ if (isSameCampaign) {
76
+ // Same campaign — preserve existing content/term (first-touch)
77
+ return {
78
+ ...incoming,
79
+ utm_content: existing.utm_content || incoming.utm_content,
80
+ utm_term: existing.utm_term || incoming.utm_term,
81
+ };
82
+ }
83
+
84
+ // Different campaign — check if incoming has content/term
85
+ const hasNewContent = !!incoming.utm_content;
86
+ const hasNewTerm = !!incoming.utm_term;
87
+
88
+ return {
89
+ ...incoming,
90
+ // Carry forward existing content/term only if incoming doesn't provide them
91
+ ...(!hasNewContent &&
92
+ existing.utm_content && { utm_content: existing.utm_content }),
93
+ ...(!hasNewTerm && existing.utm_term && { utm_term: existing.utm_term }),
94
+ };
95
+ }
96
+
97
+ /**
98
+ * Generates synthetic UTM parameters for organic/direct traffic
99
+ * based on document.referrer.
100
+ *
101
+ * - No referrer → direct / direct
102
+ * - Google/Bing → organic / google or bing
103
+ * - Other external site (not windstream.com) → referral / <domain>
104
+ * - Internal (windstream.com) → null (no cookie set)
105
+ *
106
+ * @returns UTMProperties for organic traffic, or null for internal nav.
107
+ */
108
+ export function getOrganicTrafficUtmParameters(): UTMProperties | null {
109
+ if (typeof document === "undefined") return null;
110
+
111
+ const referrer = document.referrer;
112
+
113
+ if (!referrer) {
114
+ return { utm_medium: "direct", utm_source: "direct" };
115
+ }
116
+
117
+ let referrerHost: string;
118
+ try {
119
+ referrerHost = new URL(referrer).hostname.toLowerCase();
120
+ } catch {
121
+ return { utm_medium: "direct", utm_source: "direct" };
122
+ }
123
+
124
+ // Internal navigation — don't set organic UTMs
125
+ if (
126
+ referrerHost.includes("windstream.com") ||
127
+ referrerHost.includes("gokinetic.com")
128
+ ) {
129
+ return null;
130
+ }
131
+
132
+ // Search engines → organic
133
+ if (referrerHost.includes("google.")) {
134
+ return { utm_medium: "organic", utm_source: "google" };
135
+ }
136
+ if (referrerHost.includes("bing.")) {
137
+ return { utm_medium: "organic", utm_source: "bing" };
138
+ }
139
+
140
+ // External referral
141
+ return { utm_medium: "referral", utm_source: referrerHost };
142
+ }
143
+
144
+ /**
145
+ * Maps UTMProperties to Segment's campaign context schema.
146
+ * @param utms - The UTM properties (typically from cookie).
147
+ * @returns CampaignProperties for Segment context.
148
+ */
149
+ export function getCampaignProperties(
150
+ utms: UTMProperties | null
151
+ ): CampaignProperties | null {
152
+ if (!utms) return null;
153
+
154
+ const campaign: CampaignProperties = {};
155
+
156
+ if (utms.utm_campaign) campaign.name = utms.utm_campaign;
157
+ if (utms.utm_source) campaign.source = utms.utm_source;
158
+ if (utms.utm_medium) campaign.medium = utms.utm_medium;
159
+ if (utms.utm_term) campaign.term = utms.utm_term;
160
+ if (utms.utm_content) campaign.content = utms.utm_content;
161
+ if (utms.utm_campaign_id) campaign.campaign_id = utms.utm_campaign_id;
162
+ if (utms.utm_adgroup_id) campaign.adgroup_id = utms.utm_adgroup_id;
163
+ if (utms.gclid) campaign.gclid = utms.gclid;
164
+ if (utms.fbclid) campaign.fbclid = utms.fbclid;
165
+ if (utms.msclkid) campaign.msclkid = utms.msclkid;
166
+
167
+ return Object.keys(campaign).length > 0 ? campaign : null;
168
+ }
169
+
170
+ /**
171
+ * Builds a URL with non-UTM query params preserved and UTM params stripped.
172
+ * Used by the Link/Button component when preserveQueryParameters is true.
173
+ *
174
+ * @param href - The target URL/path.
175
+ * @param currentSearch - The current page's search string (e.g. "?foo=bar&utm_source=google").
176
+ * @returns The href with non-UTM params merged and UTM params removed.
177
+ */
178
+ export function buildPreservedQueryHref(
179
+ href: string,
180
+ currentSearch: string
181
+ ): string {
182
+ if (!currentSearch) return href;
183
+
184
+ const currentParams = new URLSearchParams(currentSearch);
185
+ const utmSet = new Set<string>(UTM_PARAM_NAMES);
186
+
187
+ // Also strip common non-UTM params that shouldn't carry forward
188
+ const stripParams = new Set([...utmSet, "searchtext", "page"]);
189
+
190
+ // Parse the target href to separate path and existing query
191
+ let basePath: string;
192
+ let targetParams: URLSearchParams;
193
+
194
+ try {
195
+ // Handle both absolute URLs and relative paths
196
+ if (href.startsWith("http://") || href.startsWith("https://")) {
197
+ const url = new URL(href);
198
+ basePath = url.origin + url.pathname;
199
+ targetParams = url.searchParams;
200
+ } else {
201
+ const [path, query] = href.split("?");
202
+ basePath = path;
203
+ targetParams = new URLSearchParams(query || "");
204
+ }
205
+ } catch {
206
+ return href;
207
+ }
208
+
209
+ // Start with target's existing params
210
+ const merged = new URLSearchParams(targetParams);
211
+
212
+ // Add current page params that aren't UTM and aren't already in target
213
+ currentParams.forEach((value, key) => {
214
+ if (!stripParams.has(key.toLowerCase()) && !merged.has(key)) {
215
+ merged.set(key, value);
216
+ }
217
+ });
218
+
219
+ const queryString = merged.toString();
220
+ return queryString ? `${basePath}?${queryString}` : basePath;
221
+ }