@xyo-network/react-advertising 7.4.1 → 7.5.0

package/dist/browser/index.mjs

@@ -1,6 +1,10 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
 // src/utm/hooks/useCaptureUtmLocation.ts
 import { usePromise } from "@xylabs/react-promise";
 import { UtmSchema } from "@xyo-network/advertising-payload-plugins";
+import { asSchema } from "@xyo-network/payload-model";
 import { useMemo as useMemo2 } from "react";
 import { useSearchParams as useSearchParams2 } from "react-router-dom";
 
@@ -9,7 +13,7 @@ import { isUtm } from "@xyo-network/advertising-payload-plugins";
 import { StorageArchivist, StorageArchivistConfigSchema } from "@xyo-network/archivist-storage";
 var STORAGE_NAME_SPACE = "utm";
 var archivist;
-var UtmStorageArchivist = async () => {
+var UtmStorageArchivist = /* @__PURE__ */ __name(async () => {
   if (archivist) {
     return archivist;
   } else {
@@ -23,18 +27,18 @@ var UtmStorageArchivist = async () => {
     });
     return archivist;
   }
-};
-var LatestUtmPayload = async () => {
+}, "UtmStorageArchivist");
+var LatestUtmPayload = /* @__PURE__ */ __name(async () => {
   const archivist2 = await UtmStorageArchivist();
   return (await archivist2.next()).find(isUtm);
-};
+}, "LatestUtmPayload");
 
 // src/utm/hooks/useDefaultPageState.ts
 import { useMemo } from "react";
 import { useSearchParams } from "react-router-dom";
-var useDefaultPageState = ({ queryParams }) => {
+var useDefaultPageState = /* @__PURE__ */ __name(({ queryParams }) => {
   const [searchParams, setSearchParams] = useSearchParams();
-  const patchDefaultPageState = (source, key, value) => {
+  const patchDefaultPageState = /* @__PURE__ */ __name((source, key, value) => {
     switch (source) {
       case "queryParams": {
         setSearchParams((prevSearchParams) => {
@@ -48,7 +52,7 @@ var useDefaultPageState = ({ queryParams }) => {
         throw new Error(`Invalid source for default page state: ${source}`);
       }
     }
-  };
+  }, "patchDefaultPageState");
   const queryParamsState = useMemo(() => {
     if (!queryParams) return {};
     let defaultState = {};
@@ -58,9 +62,15 @@ var useDefaultPageState = ({ queryParams }) => {
       }
     }
     return defaultState;
-  }, [searchParams, queryParams]);
-  return [queryParamsState, patchDefaultPageState];
-};
+  }, [
+    searchParams,
+    queryParams
+  ]);
+  return [
+    queryParamsState,
+    patchDefaultPageState
+  ];
+}, "useDefaultPageState");
 
 // src/utm/hooks/useDefaultUtmPageState.ts
 var UtmQueryParamStrings = {
@@ -70,23 +80,21 @@ var UtmQueryParamStrings = {
   utmSource: "utm_source",
   utmTerm: "utm_term"
 };
-var useDefaultUtmPageState = () => useDefaultPageState({ queryParams: Object.values(UtmQueryParamStrings) });
+var useDefaultUtmPageState = /* @__PURE__ */ __name(() => useDefaultPageState({
+  queryParams: Object.values(UtmQueryParamStrings)
+}), "useDefaultUtmPageState");
 
 // src/utm/hooks/useCaptureUtmLocation.ts
-var useCaptureUtmLocation = (removeAfterCapture = true) => {
-  const [{
-    utm_campaign,
-    utm_content,
-    utm_medium,
-    utm_source,
-    utm_term
-  }] = useDefaultUtmPageState();
+var useCaptureUtmLocation = /* @__PURE__ */ __name((removeAfterCapture = true) => {
+  const [{ utm_campaign, utm_content, utm_medium, utm_source, utm_term }] = useDefaultUtmPageState();
   const [, setSearchParams] = useSearchParams2();
   const [sessionStorageArchivist, error] = usePromise(async () => {
     return await UtmStorageArchivist();
   }, []);
   const utmPayload = useMemo2(() => {
-    const utm = { schema: UtmSchema };
+    const utm = {
+      schema: asSchema(UtmSchema, true)
+    };
     const utmParams = {
       utm_campaign,
       utm_content,
@@ -107,11 +115,19 @@ var useCaptureUtmLocation = (removeAfterCapture = true) => {
     } else {
       return null;
     }
-  }, [utm_campaign, utm_content, utm_medium, utm_source, utm_term]);
+  }, [
+    utm_campaign,
+    utm_content,
+    utm_medium,
+    utm_source,
+    utm_term
+  ]);
   const [, insertError] = usePromise(async () => {
     if (utmPayload && sessionStorageArchivist) {
       await sessionStorageArchivist.clear();
-      await sessionStorageArchivist.insert([utmPayload]);
+      await sessionStorageArchivist.insert([
+        utmPayload
+      ]);
       if (removeAfterCapture) {
         setSearchParams(() => {
           const newParams = new URLSearchParams();
@@ -122,9 +138,16 @@ var useCaptureUtmLocation = (removeAfterCapture = true) => {
         });
       }
     }
-  }, [sessionStorageArchivist, utmPayload, removeAfterCapture]);
-  return { utmPayload, error: error ?? insertError };
-};
+  }, [
+    sessionStorageArchivist,
+    utmPayload,
+    removeAfterCapture
+  ]);
+  return {
+    utmPayload,
+    error: error ?? insertError
+  };
+}, "useCaptureUtmLocation");
 export {
   LatestUtmPayload,
   UtmQueryParamStrings,

package/dist/browser/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utm/hooks/useCaptureUtmLocation.ts","../../src/utm/lib/UtmStorageArchivist.ts","../../src/utm/hooks/useDefaultPageState.ts","../../src/utm/hooks/useDefaultUtmPageState.ts"],"sourcesContent":["import { usePromise } from '@xylabs/react-promise'\nimport { type Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'\nimport type { PayloadWithOptionalSources } from '@xyo-network/payload-model'\nimport { useMemo } from 'react'\nimport { useSearchParams } from 'react-router-dom'\n\nimport { UtmStorageArchivist } from '../lib/index.ts'\nimport { useDefaultUtmPageState, UtmQueryParamStrings } from './useDefaultUtmPageState.ts'\n\nexport const useCaptureUtmLocation = (removeAfterCapture = true) => {\n  const [{\n    utm_campaign, utm_content, utm_medium, utm_source, utm_term,\n  }] = useDefaultUtmPageState()\n  const [,setSearchParams] = useSearchParams()\n\n  const [sessionStorageArchivist, error] = usePromise(async () => {\n    return await UtmStorageArchivist()\n  }, [])\n\n  const utmPayload = useMemo(() => {\n    // Construct the base UTM payload\n    const utm: PayloadWithOptionalSources<Utm> = { schema: UtmSchema }\n\n    // determine if there's a utm field that still has a value\n    // if there is none, it means that either the page loaded\n    // with none or they've already been captured\n    const utmParams = {\n      utm_campaign, utm_content, utm_medium, utm_source, utm_term,\n    }\n    const foundUpdatedUtmParams = Object.entries(utmParams).some(([key, value]) => {\n      return key.includes('utm_') && value\n    })\n\n    if (foundUpdatedUtmParams) {\n      // Conditionally add all the UTM parameters present\n      if (utm_campaign) utm.utm_campaign = utm_campaign\n      if (utm_content) utm.utm_content = utm_content\n      if (utm_medium) utm.utm_medium = utm_medium\n      if (utm_source) utm.utm_source = utm_source\n      if (utm_term) utm.utm_term = utm_term\n\n      return utm\n    } else {\n      return null\n    }\n  }, [utm_campaign, utm_content, utm_medium, utm_source, utm_term])\n\n  const [,insertError] = usePromise(async () => {\n    if (utmPayload && sessionStorageArchivist) {\n      // clear all previous utm payloads\n      await sessionStorageArchivist.clear()\n      // insert params into session storage\n      await sessionStorageArchivist.insert([utmPayload])\n\n      if (removeAfterCapture) {\n        // remove the utm params from the URL\n        setSearchParams(() => {\n          const newParams = new URLSearchParams()\n          for (const value of Object.values(UtmQueryParamStrings)) {\n            newParams.delete(value)\n          }\n          return newParams\n        })\n      }\n    }\n  }, [sessionStorageArchivist, utmPayload, removeAfterCapture])\n\n  return { utmPayload, error: error ?? insertError }\n}\n","import type { Utm } from '@xyo-network/advertising-payload-plugins'\nimport { isUtm } from '@xyo-network/advertising-payload-plugins'\nimport { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage'\nimport type { PayloadWithOptionalSources } from '@xyo-network/payload-model'\n\nconst STORAGE_NAME_SPACE = 'utm' as const\n\nlet archivist: StorageArchivist | undefined\n\n/**\n * Find or create a single instance of the UtmStorageArchivist\n * @returns Archivist instance\n */\nexport const UtmStorageArchivist = async () => {\n  if (archivist) {\n    return archivist\n  } else {\n    archivist = await StorageArchivist.create({\n      account: 'random',\n      config: {\n        schema: StorageArchivistConfigSchema, namespace: STORAGE_NAME_SPACE, type: 'session',\n      },\n    })\n    return archivist\n  }\n}\n\nexport const LatestUtmPayload = async (): Promise<PayloadWithOptionalSources<Utm> | undefined> => {\n  const archivist = await UtmStorageArchivist()\n  return (await archivist.next()).find(isUtm) as PayloadWithOptionalSources<Utm>\n}\n","import { useMemo } from 'react'\nimport { useSearchParams } from 'react-router-dom'\n\nimport type { PageStateKeys } from '../lib/index.ts'\n\nexport interface DefaultPageStateParams<TQueryParams extends PageStateKeys = PageStateKeys> {\n  queryParams: TQueryParams\n}\n\nexport type DefaultPageStateReturn<TPageStateKeys extends PageStateKeys = PageStateKeys> = [\n  Record<TPageStateKeys[number], string>,\n  (source: keyof DefaultPageStateParams, key: TPageStateKeys[number], value: string) => void,\n]\n\n/**\n * Hook to get default page state as key value pairs from various sources.  It provides a convenient abstraction over free form\n * page state like query params by narrowing the used params and centralizing their logic.\n *\n * Future work could include adding support for localStorage, sessionStorage, and precedence of sources.\n * @param defaultPageStateParams various sources of default page state (i.e. queryParams, localStorage, etc.)\n * @returns\n */\nexport const useDefaultPageState = <TQueryParams extends PageStateKeys = PageStateKeys>(\n  { queryParams }: DefaultPageStateParams<TQueryParams>,\n): DefaultPageStateReturn<TQueryParams> => {\n  const [searchParams, setSearchParams] = useSearchParams()\n\n  const patchDefaultPageState = (source: keyof DefaultPageStateParams, key: TQueryParams[number], value: string) => {\n    switch (source) {\n      case 'queryParams': {\n        setSearchParams((prevSearchParams) => {\n          const newSearchParams = new URLSearchParams(prevSearchParams)\n          newSearchParams.set(key, value)\n          return newSearchParams\n        })\n        break\n      }\n      default: {\n        throw new Error(`Invalid source for default page state: ${source}`)\n      }\n    }\n  }\n\n  const queryParamsState = useMemo(() => {\n    if (!queryParams) return {} as Record<TQueryParams[number], string>\n    let defaultState = {} as Record<TQueryParams[number], string>\n    for (const [key, value] of searchParams.entries()) {\n      if (queryParams.includes(key)) {\n        defaultState[key as TQueryParams[number]] = value\n      }\n    }\n    return defaultState\n  }, [searchParams, queryParams])\n\n  return [queryParamsState, patchDefaultPageState]\n}\n","import { useDefaultPageState } from './useDefaultPageState.ts'\n\nexport const UtmQueryParamStrings = {\n  utmCampaign: 'utm_campaign',\n  utmContent: 'utm_content',\n  utmMedium: 'utm_medium',\n  utmSource: 'utm_source',\n  utmTerm: 'utm_term',\n} as const\n\nexport type UtmQueryParams = typeof UtmQueryParamStrings[keyof typeof UtmQueryParamStrings]\n\n/** Get the default page state for utm values from specific query params */\nexport const useDefaultUtmPageState = () => useDefaultPageState<UtmQueryParams[]>({ queryParams: Object.values(UtmQueryParamStrings) })\n"],"mappings":";AAAA,SAAS,kBAAkB;AAC3B,SAAmB,iBAAiB;AAEpC,SAAS,WAAAA,gBAAe;AACxB,SAAS,mBAAAC,wBAAuB;;;ACHhC,SAAS,aAAa;AACtB,SAAS,kBAAkB,oCAAoC;AAG/D,IAAM,qBAAqB;AAE3B,IAAI;AAMG,IAAM,sBAAsB,YAAY;AAC7C,MAAI,WAAW;AACb,WAAO;AAAA,EACT,OAAO;AACL,gBAAY,MAAM,iBAAiB,OAAO;AAAA,MACxC,SAAS;AAAA,MACT,QAAQ;AAAA,QACN,QAAQ;AAAA,QAA8B,WAAW;AAAA,QAAoB,MAAM;AAAA,MAC7E;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mBAAmB,YAAkE;AAChG,QAAMC,aAAY,MAAM,oBAAoB;AAC5C,UAAQ,MAAMA,WAAU,KAAK,GAAG,KAAK,KAAK;AAC5C;;;AC9BA,SAAS,eAAe;AACxB,SAAS,uBAAuB;AAqBzB,IAAM,sBAAsB,CACjC,EAAE,YAAY,MAC2B;AACzC,QAAM,CAAC,cAAc,eAAe,IAAI,gBAAgB;AAExD,QAAM,wBAAwB,CAAC,QAAsC,KAA2B,UAAkB;AAChH,YAAQ,QAAQ;AAAA,MACd,KAAK,eAAe;AAClB,wBAAgB,CAAC,qBAAqB;AACpC,gBAAM,kBAAkB,IAAI,gBAAgB,gBAAgB;AAC5D,0BAAgB,IAAI,KAAK,KAAK;AAC9B,iBAAO;AAAA,QACT,CAAC;AACD;AAAA,MACF;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,0CAA0C,MAAM,EAAE;AAAA,MACpE;AAAA,IACF;AAAA,EACF;AAEA,QAAM,mBAAmB,QAAQ,MAAM;AACrC,QAAI,CAAC,YAAa,QAAO,CAAC;AAC1B,QAAI,eAAe,CAAC;AACpB,eAAW,CAAC,KAAK,KAAK,KAAK,aAAa,QAAQ,GAAG;AACjD,UAAI,YAAY,SAAS,GAAG,GAAG;AAC7B,qBAAa,GAA2B,IAAI;AAAA,MAC9C;AAAA,IACF;AACA,WAAO;AAAA,EACT,GAAG,CAAC,cAAc,WAAW,CAAC;AAE9B,SAAO,CAAC,kBAAkB,qBAAqB;AACjD;;;ACrDO,IAAM,uBAAuB;AAAA,EAClC,aAAa;AAAA,EACb,YAAY;AAAA,EACZ,WAAW;AAAA,EACX,WAAW;AAAA,EACX,SAAS;AACX;AAKO,IAAM,yBAAyB,MAAM,oBAAsC,EAAE,aAAa,OAAO,OAAO,oBAAoB,EAAE,CAAC;;;AHJ/H,IAAM,wBAAwB,CAAC,qBAAqB,SAAS;AAClE,QAAM,CAAC;AAAA,IACL;AAAA,IAAc;AAAA,IAAa;AAAA,IAAY;AAAA,IAAY;AAAA,EACrD,CAAC,IAAI,uBAAuB;AAC5B,QAAM,CAAC,EAAC,eAAe,IAAIC,iBAAgB;AAE3C,QAAM,CAAC,yBAAyB,KAAK,IAAI,WAAW,YAAY;AAC9D,WAAO,MAAM,oBAAoB;AAAA,EACnC,GAAG,CAAC,CAAC;AAEL,QAAM,aAAaC,SAAQ,MAAM;AAE/B,UAAM,MAAuC,EAAE,QAAQ,UAAU;AAKjE,UAAM,YAAY;AAAA,MAChB;AAAA,MAAc;AAAA,MAAa;AAAA,MAAY;AAAA,MAAY;AAAA,IACrD;AACA,UAAM,wBAAwB,OAAO,QAAQ,SAAS,EAAE,KAAK,CAAC,CAAC,KAAK,KAAK,MAAM;AAC7E,aAAO,IAAI,SAAS,MAAM,KAAK;AAAA,IACjC,CAAC;AAED,QAAI,uBAAuB;AAEzB,UAAI,aAAc,KAAI,eAAe;AACrC,UAAI,YAAa,KAAI,cAAc;AACnC,UAAI,WAAY,KAAI,aAAa;AACjC,UAAI,WAAY,KAAI,aAAa;AACjC,UAAI,SAAU,KAAI,WAAW;AAE7B,aAAO;AAAA,IACT,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,GAAG,CAAC,cAAc,aAAa,YAAY,YAAY,QAAQ,CAAC;AAEhE,QAAM,CAAC,EAAC,WAAW,IAAI,WAAW,YAAY;AAC5C,QAAI,cAAc,yBAAyB;AAEzC,YAAM,wBAAwB,MAAM;AAEpC,YAAM,wBAAwB,OAAO,CAAC,UAAU,CAAC;AAEjD,UAAI,oBAAoB;AAEtB,wBAAgB,MAAM;AACpB,gBAAM,YAAY,IAAI,gBAAgB;AACtC,qBAAW,SAAS,OAAO,OAAO,oBAAoB,GAAG;AACvD,sBAAU,OAAO,KAAK;AAAA,UACxB;AACA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF,GAAG,CAAC,yBAAyB,YAAY,kBAAkB,CAAC;AAE5D,SAAO,EAAE,YAAY,OAAO,SAAS,YAAY;AACnD;","names":["useMemo","useSearchParams","archivist","useSearchParams","useMemo"]}
+{"version":3,"sources":["../../src/utm/hooks/useCaptureUtmLocation.ts","../../src/utm/lib/UtmStorageArchivist.ts","../../src/utm/hooks/useDefaultPageState.ts","../../src/utm/hooks/useDefaultUtmPageState.ts"],"sourcesContent":["import { usePromise } from '@xylabs/react-promise'\nimport { type Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'\nimport { asSchema, type Payload } from '@xyo-network/payload-model'\nimport { useMemo } from 'react'\nimport { useSearchParams } from 'react-router-dom'\n\nimport { UtmStorageArchivist } from '../lib/index.ts'\nimport { useDefaultUtmPageState, UtmQueryParamStrings } from './useDefaultUtmPageState.ts'\n\nexport const useCaptureUtmLocation = (removeAfterCapture = true) => {\n  const [{\n    utm_campaign, utm_content, utm_medium, utm_source, utm_term,\n  }] = useDefaultUtmPageState()\n  const [,setSearchParams] = useSearchParams()\n\n  const [sessionStorageArchivist, error] = usePromise(async () => {\n    return await UtmStorageArchivist()\n  }, [])\n\n  const utmPayload = useMemo(() => {\n    // Construct the base UTM payload\n    const utm: Payload<Utm> = { schema: asSchema(UtmSchema, true) }\n\n    // determine if there's a utm field that still has a value\n    // if there is none, it means that either the page loaded\n    // with none or they've already been captured\n    const utmParams = {\n      utm_campaign, utm_content, utm_medium, utm_source, utm_term,\n    }\n    const foundUpdatedUtmParams = Object.entries(utmParams).some(([key, value]) => {\n      return key.includes('utm_') && value\n    })\n\n    if (foundUpdatedUtmParams) {\n      // Conditionally add all the UTM parameters present\n      if (utm_campaign) utm.utm_campaign = utm_campaign\n      if (utm_content) utm.utm_content = utm_content\n      if (utm_medium) utm.utm_medium = utm_medium\n      if (utm_source) utm.utm_source = utm_source\n      if (utm_term) utm.utm_term = utm_term\n\n      return utm\n    } else {\n      return null\n    }\n  }, [utm_campaign, utm_content, utm_medium, utm_source, utm_term])\n\n  const [,insertError] = usePromise(async () => {\n    if (utmPayload && sessionStorageArchivist) {\n      // clear all previous utm payloads\n      await sessionStorageArchivist.clear()\n      // insert params into session storage\n      await sessionStorageArchivist.insert([utmPayload])\n\n      if (removeAfterCapture) {\n        // remove the utm params from the URL\n        setSearchParams(() => {\n          const newParams = new URLSearchParams()\n          for (const value of Object.values(UtmQueryParamStrings)) {\n            newParams.delete(value)\n          }\n          return newParams\n        })\n      }\n    }\n  }, [sessionStorageArchivist, utmPayload, removeAfterCapture])\n\n  return { utmPayload, error: error ?? insertError }\n}\n","import type { Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'\nimport { isUtm } from '@xyo-network/advertising-payload-plugins'\nimport type { StorageArchivistParams } from '@xyo-network/archivist-storage'\nimport { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage'\nimport type { Payload, Schema } from '@xyo-network/payload-model'\n\nconst STORAGE_NAME_SPACE = 'utm' as const\n\nlet archivist: StorageArchivist | undefined\n\n/**\n * Find or create a single instance of the UtmStorageArchivist\n * @returns Archivist instance\n */\nexport const UtmStorageArchivist = async () => {\n  if (archivist) {\n    return archivist\n  } else {\n    archivist = await StorageArchivist.create({\n      account: 'random',\n      config: {\n        schema: StorageArchivistConfigSchema, namespace: STORAGE_NAME_SPACE, type: 'session',\n      },\n    } as StorageArchivistParams)\n    return archivist\n  }\n}\n\nexport const LatestUtmPayload = async (): Promise<Payload<Utm, Schema<UtmSchema>> | undefined> => {\n  const archivist = await UtmStorageArchivist()\n  return (await archivist.next()).find(isUtm) as Payload<Utm, Schema<UtmSchema>>\n}\n","import { useMemo } from 'react'\nimport { useSearchParams } from 'react-router-dom'\n\nimport type { PageStateKeys } from '../lib/index.ts'\n\nexport interface DefaultPageStateParams<TQueryParams extends PageStateKeys = PageStateKeys> {\n  queryParams: TQueryParams\n}\n\nexport type DefaultPageStateReturn<TPageStateKeys extends PageStateKeys = PageStateKeys> = [\n  Record<TPageStateKeys[number], string>,\n  (source: keyof DefaultPageStateParams, key: TPageStateKeys[number], value: string) => void,\n]\n\n/**\n * Hook to get default page state as key value pairs from various sources.  It provides a convenient abstraction over free form\n * page state like query params by narrowing the used params and centralizing their logic.\n *\n * Future work could include adding support for localStorage, sessionStorage, and precedence of sources.\n * @param defaultPageStateParams various sources of default page state (i.e. queryParams, localStorage, etc.)\n * @returns\n */\nexport const useDefaultPageState = <TQueryParams extends PageStateKeys = PageStateKeys>(\n  { queryParams }: DefaultPageStateParams<TQueryParams>,\n): DefaultPageStateReturn<TQueryParams> => {\n  const [searchParams, setSearchParams] = useSearchParams()\n\n  const patchDefaultPageState = (source: keyof DefaultPageStateParams, key: TQueryParams[number], value: string) => {\n    switch (source) {\n      case 'queryParams': {\n        setSearchParams((prevSearchParams) => {\n          const newSearchParams = new URLSearchParams(prevSearchParams)\n          newSearchParams.set(key, value)\n          return newSearchParams\n        })\n        break\n      }\n      default: {\n        throw new Error(`Invalid source for default page state: ${source}`)\n      }\n    }\n  }\n\n  const queryParamsState = useMemo(() => {\n    if (!queryParams) return {} as Record<TQueryParams[number], string>\n    let defaultState = {} as Record<TQueryParams[number], string>\n    for (const [key, value] of searchParams.entries()) {\n      if (queryParams.includes(key)) {\n        defaultState[key as TQueryParams[number]] = value\n      }\n    }\n    return defaultState\n  }, [searchParams, queryParams])\n\n  return [queryParamsState, patchDefaultPageState]\n}\n","import { useDefaultPageState } from './useDefaultPageState.ts'\n\nexport const UtmQueryParamStrings = {\n  utmCampaign: 'utm_campaign',\n  utmContent: 'utm_content',\n  utmMedium: 'utm_medium',\n  utmSource: 'utm_source',\n  utmTerm: 'utm_term',\n} as const\n\nexport type UtmQueryParams = typeof UtmQueryParamStrings[keyof typeof UtmQueryParamStrings]\n\n/** Get the default page state for utm values from specific query params */\nexport const useDefaultUtmPageState = () => useDefaultPageState<UtmQueryParams[]>({ queryParams: Object.values(UtmQueryParamStrings) })\n"],"mappings":";;;;AAAA,SAASA,kBAAkB;AAC3B,SAAmBC,iBAAiB;AACpC,SAASC,gBAA8B;AACvC,SAASC,WAAAA,gBAAe;AACxB,SAASC,mBAAAA,wBAAuB;;;ACHhC,SAASC,aAAa;AAEtB,SAASC,kBAAkBC,oCAAoC;AAG/D,IAAMC,qBAAqB;AAE3B,IAAIC;AAMG,IAAMC,sBAAsB,mCAAA;AACjC,MAAID,WAAW;AACb,WAAOA;EACT,OAAO;AACLA,gBAAY,MAAME,iBAAiBC,OAAO;MACxCC,SAAS;MACTC,QAAQ;QACNC,QAAQC;QAA8BC,WAAWT;QAAoBU,MAAM;MAC7E;IACF,CAAA;AACA,WAAOT;EACT;AACF,GAZmC;AAc5B,IAAMU,mBAAmB,mCAAA;AAC9B,QAAMV,aAAY,MAAMC,oBAAAA;AACxB,UAAQ,MAAMD,WAAUW,KAAI,GAAIC,KAAKC,KAAAA;AACvC,GAHgC;;;AC5BhC,SAASC,eAAe;AACxB,SAASC,uBAAuB;AAqBzB,IAAMC,sBAAsB,wBACjC,EAAEC,YAAW,MAAwC;AAErD,QAAM,CAACC,cAAcC,eAAAA,IAAmBC,gBAAAA;AAExC,QAAMC,wBAAwB,wBAACC,QAAsCC,KAA2BC,UAAAA;AAC9F,YAAQF,QAAAA;MACN,KAAK,eAAe;AAClBH,wBAAgB,CAACM,qBAAAA;AACf,gBAAMC,kBAAkB,IAAIC,gBAAgBF,gBAAAA;AAC5CC,0BAAgBE,IAAIL,KAAKC,KAAAA;AACzB,iBAAOE;QACT,CAAA;AACA;MACF;MACA,SAAS;AACP,cAAM,IAAIG,MAAM,0CAA0CP,MAAAA,EAAQ;MACpE;IACF;EACF,GAd8B;AAgB9B,QAAMQ,mBAAmBC,QAAQ,MAAA;AAC/B,QAAI,CAACd,YAAa,QAAO,CAAC;AAC1B,QAAIe,eAAe,CAAC;AACpB,eAAW,CAACT,KAAKC,KAAAA,KAAUN,aAAae,QAAO,GAAI;AACjD,UAAIhB,YAAYiB,SAASX,GAAAA,GAAM;AAC7BS,qBAAaT,GAAAA,IAA+BC;MAC9C;IACF;AACA,WAAOQ;EACT,GAAG;IAACd;IAAcD;GAAY;AAE9B,SAAO;IAACa;IAAkBT;;AAC5B,GAjCmC;;;ACpB5B,IAAMc,uBAAuB;EAClCC,aAAa;EACbC,YAAY;EACZC,WAAW;EACXC,WAAW;EACXC,SAAS;AACX;AAKO,IAAMC,yBAAyB,6BAAMC,oBAAsC;EAAEC,aAAaC,OAAOC,OAAOV,oBAAAA;AAAsB,CAAA,GAA/F;;;AHJ/B,IAAMW,wBAAwB,wBAACC,qBAAqB,SAAI;AAC7D,QAAM,CAAC,EACLC,cAAcC,aAAaC,YAAYC,YAAYC,SAAQ,CAC5D,IAAIC,uBAAAA;AACL,QAAM,CAAA,EAAEC,eAAAA,IAAmBC,iBAAAA;AAE3B,QAAM,CAACC,yBAAyBC,KAAAA,IAASC,WAAW,YAAA;AAClD,WAAO,MAAMC,oBAAAA;EACf,GAAG,CAAA,CAAE;AAEL,QAAMC,aAAaC,SAAQ,MAAA;AAEzB,UAAMC,MAAoB;MAAEC,QAAQC,SAASC,WAAW,IAAA;IAAM;AAK9D,UAAMC,YAAY;MAChBlB;MAAcC;MAAaC;MAAYC;MAAYC;IACrD;AACA,UAAMe,wBAAwBC,OAAOC,QAAQH,SAAAA,EAAWI,KAAK,CAAC,CAACC,KAAKC,KAAAA,MAAM;AACxE,aAAOD,IAAIE,SAAS,MAAA,KAAWD;IACjC,CAAA;AAEA,QAAIL,uBAAuB;AAEzB,UAAInB,aAAcc,KAAId,eAAeA;AACrC,UAAIC,YAAaa,KAAIb,cAAcA;AACnC,UAAIC,WAAYY,KAAIZ,aAAaA;AACjC,UAAIC,WAAYW,KAAIX,aAAaA;AACjC,UAAIC,SAAUU,KAAIV,WAAWA;AAE7B,aAAOU;IACT,OAAO;AACL,aAAO;IACT;EACF,GAAG;IAACd;IAAcC;IAAaC;IAAYC;IAAYC;GAAS;AAEhE,QAAM,CAAA,EAAEsB,WAAAA,IAAehB,WAAW,YAAA;AAChC,QAAIE,cAAcJ,yBAAyB;AAEzC,YAAMA,wBAAwBmB,MAAK;AAEnC,YAAMnB,wBAAwBoB,OAAO;QAAChB;OAAW;AAEjD,UAAIb,oBAAoB;AAEtBO,wBAAgB,MAAA;AACd,gBAAMuB,YAAY,IAAIC,gBAAAA;AACtB,qBAAWN,SAASJ,OAAOW,OAAOC,oBAAAA,GAAuB;AACvDH,sBAAUI,OAAOT,KAAAA;UACnB;AACA,iBAAOK;QACT,CAAA;MACF;IACF;EACF,GAAG;IAACrB;IAAyBI;IAAYb;GAAmB;AAE5D,SAAO;IAAEa;IAAYH,OAAOA,SAASiB;EAAY;AACnD,GA3DqC;","names":["usePromise","UtmSchema","asSchema","useMemo","useSearchParams","isUtm","StorageArchivist","StorageArchivistConfigSchema","STORAGE_NAME_SPACE","archivist","UtmStorageArchivist","StorageArchivist","create","account","config","schema","StorageArchivistConfigSchema","namespace","type","LatestUtmPayload","next","find","isUtm","useMemo","useSearchParams","useDefaultPageState","queryParams","searchParams","setSearchParams","useSearchParams","patchDefaultPageState","source","key","value","prevSearchParams","newSearchParams","URLSearchParams","set","Error","queryParamsState","useMemo","defaultState","entries","includes","UtmQueryParamStrings","utmCampaign","utmContent","utmMedium","utmSource","utmTerm","useDefaultUtmPageState","useDefaultPageState","queryParams","Object","values","useCaptureUtmLocation","removeAfterCapture","utm_campaign","utm_content","utm_medium","utm_source","utm_term","useDefaultUtmPageState","setSearchParams","useSearchParams","sessionStorageArchivist","error","usePromise","UtmStorageArchivist","utmPayload","useMemo","utm","schema","asSchema","UtmSchema","utmParams","foundUpdatedUtmParams","Object","entries","some","key","value","includes","insertError","clear","insert","newParams","URLSearchParams","values","UtmQueryParamStrings","delete"]}

package/dist/browser/utm/hooks/UseCaptureUtmLocation.stories.d.ts

@@ -1,7 +1,7 @@
 import type { Meta } from '@storybook/react-vite';
 declare const _default: Meta;
 export default _default;
-declare const Default: import(".store/storybook-virtual-a067dd1507/package/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
-declare const WithNoClearAfterCapture: import(".store/storybook-virtual-a067dd1507/package/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
+declare const Default: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/react-vite").Args>;
+declare const WithNoClearAfterCapture: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, import("@storybook/react-vite").Args>;
 export { Default, WithNoClearAfterCapture };
 //# sourceMappingURL=UseCaptureUtmLocation.stories.d.ts.map

package/dist/browser/utm/hooks/UseCaptureUtmLocation.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UseCaptureUtmLocation.stories.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/UseCaptureUtmLocation.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,uBAAuB,CAAA;wBASO,IAAI;AAArE,wBAAqE;AAkErE,QAAA,MAAM,OAAO,0KAAoB,CAAA;AAGjC,QAAA,MAAM,uBAAuB,0KAAgC,CAAA;AAG7D,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAA"}
+{"version":3,"file":"UseCaptureUtmLocation.stories.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/UseCaptureUtmLocation.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,uBAAuB,CAAA;wBASO,IAAI;AAArE,wBAAqE;AAkErE,QAAA,MAAM,OAAO,mIAAoB,CAAA;AAGjC,QAAA,MAAM,uBAAuB,mIAAgC,CAAA;AAG7D,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAA"}

package/dist/browser/utm/hooks/useCaptureUtmLocation.d.ts

@@ -1,6 +1,7 @@
 import { type Utm } from '@xyo-network/advertising-payload-plugins';
+import { type Payload } from '@xyo-network/payload-model';
 export declare const useCaptureUtmLocation: (removeAfterCapture?: boolean) => {
-    utmPayload: import("@xyo-network/payload-model").Payload<Utm, void> | null;
+    utmPayload: Payload<Utm> | null;
     error: Error | undefined;
 };
 //# sourceMappingURL=useCaptureUtmLocation.d.ts.map

package/dist/browser/utm/hooks/useCaptureUtmLocation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCaptureUtmLocation.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/useCaptureUtmLocation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,GAAG,EAAa,MAAM,0CAA0C,CAAA;AAQ9E,eAAO,MAAM,qBAAqB,GAAI,4BAAyB;;;CA2D9D,CAAA"}
+{"version":3,"file":"useCaptureUtmLocation.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/useCaptureUtmLocation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,GAAG,EAAa,MAAM,0CAA0C,CAAA;AAC9E,OAAO,EAAY,KAAK,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAOnE,eAAO,MAAM,qBAAqB,GAAI,4BAAyB;;;CA2D9D,CAAA"}

package/dist/browser/utm/lib/UtmStorageArchivist.d.ts

@@ -1,10 +1,11 @@
-import type { Utm } from '@xyo-network/advertising-payload-plugins';
+import type { Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins';
+import type { StorageArchivistParams } from '@xyo-network/archivist-storage';
 import { StorageArchivist } from '@xyo-network/archivist-storage';
-import type { PayloadWithOptionalSources } from '@xyo-network/payload-model';
+import type { Payload, Schema } from '@xyo-network/payload-model';
 /**
  * Find or create a single instance of the UtmStorageArchivist
  * @returns Archivist instance
  */
-export declare const UtmStorageArchivist: () => Promise<StorageArchivist<import("@xyo-network/archivist-storage").StorageArchivistParams, import(".store/@xyo-network-archivist-model-npm-5.2.17-88cd38e532/package").ArchivistModuleEventData>>;
-export declare const LatestUtmPayload: () => Promise<PayloadWithOptionalSources<Utm> | undefined>;
+export declare const UtmStorageArchivist: () => Promise<StorageArchivist<StorageArchivistParams, import("@xyo-network/archivist-model").ArchivistModuleEventData>>;
+export declare const LatestUtmPayload: () => Promise<Payload<Utm, Schema<UtmSchema>> | undefined>;
 //# sourceMappingURL=UtmStorageArchivist.d.ts.map

package/dist/browser/utm/lib/UtmStorageArchivist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UtmStorageArchivist.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/UtmStorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,0CAA0C,CAAA;AAEnE,OAAO,EAAE,gBAAgB,EAAgC,MAAM,gCAAgC,CAAA;AAC/F,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AAM5E;;;GAGG;AACH,eAAO,MAAM,mBAAmB,wMAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,GAAG,SAAS,CAG5F,CAAA"}
+{"version":3,"file":"UtmStorageArchivist.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/UtmStorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAA;AAE9E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAA;AAC5E,OAAO,EAAE,gBAAgB,EAAgC,MAAM,gCAAgC,CAAA;AAC/F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAMjE;;;GAGG;AACH,eAAO,MAAM,mBAAmB,0HAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAG5F,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-advertising",
-  "version": "7.4.1",
+  "version": "7.5.0",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -43,32 +43,33 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/react-promise": "~7.1.8",
-    "@xyo-network/advertising-payload-plugins": "~5.2.4",
-    "@xyo-network/archivist-storage": "~5.2.17",
-    "@xyo-network/payload-model": "~5.2.17"
+    "@xylabs/react-promise": "~7.1.9",
+    "@xyo-network/advertising-payload-plugins": "~5.3.1",
+    "@xyo-network/archivist-storage": "~5.3.2",
+    "@xyo-network/payload-model": "~5.3.2"
   },
   "devDependencies": {
-    "@mui/material": "~7.3.6",
-    "@storybook/react-vite": "~10.1.4",
-    "@types/react": "^19.2.7",
-    "@xylabs/ts-scripts-yarn3": "~7.2.8",
-    "@xylabs/tsconfig": "~7.2.8",
-    "@xylabs/tsconfig-dom": "~7.2.8",
-    "@xylabs/tsconfig-react": "~7.2.8",
-    "react": "^19.2.1",
-    "react-dom": "^19.2.1",
-    "storybook": "~10.1.4",
+    "@mui/material": "~7.3.7",
+    "@storybook/react-vite": "~10.2.1",
+    "@types/react": "^19.2.10",
+    "@xylabs/ts-scripts-yarn3": "~7.3.2",
+    "@xylabs/tsconfig": "~7.3.2",
+    "@xylabs/tsconfig-dom": "~7.3.2",
+    "@xylabs/tsconfig-react": "~7.3.2",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "storybook": "~10.2.1",
     "typescript": "^5.9.3",
-    "vite": "~7.2.6"
+    "vite": "~7.3.1"
   },
   "peerDependencies": {
     "react": "^19",
     "react-dom": "^19",
-    "react-router-dom": "^7"
+    "react-router-dom": "^7",
+    "zod": "^4"
   },
   "publishConfig": {
     "access": "public"
   },
   "docs": "dist/docs.json"
-}
+}

package/src/utm/hooks/useCaptureUtmLocation.ts

@@ -1,6 +1,6 @@
 import { usePromise } from '@xylabs/react-promise'
 import { type Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'
-import type { PayloadWithOptionalSources } from '@xyo-network/payload-model'
+import { asSchema, type Payload } from '@xyo-network/payload-model'
 import { useMemo } from 'react'
 import { useSearchParams } from 'react-router-dom'
 
@@ -19,7 +19,7 @@ export const useCaptureUtmLocation = (removeAfterCapture = true) => {
 
   const utmPayload = useMemo(() => {
     // Construct the base UTM payload
-    const utm: PayloadWithOptionalSources<Utm> = { schema: UtmSchema }
+    const utm: Payload<Utm> = { schema: asSchema(UtmSchema, true) }
 
     // determine if there's a utm field that still has a value
     // if there is none, it means that either the page loaded

package/src/utm/lib/UtmStorageArchivist.ts

@@ -1,7 +1,8 @@
-import type { Utm } from '@xyo-network/advertising-payload-plugins'
+import type { Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'
 import { isUtm } from '@xyo-network/advertising-payload-plugins'
+import type { StorageArchivistParams } from '@xyo-network/archivist-storage'
 import { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage'
-import type { PayloadWithOptionalSources } from '@xyo-network/payload-model'
+import type { Payload, Schema } from '@xyo-network/payload-model'
 
 const STORAGE_NAME_SPACE = 'utm' as const
 
@@ -20,12 +21,12 @@ export const UtmStorageArchivist = async () => {
       config: {
         schema: StorageArchivistConfigSchema, namespace: STORAGE_NAME_SPACE, type: 'session',
       },
-    })
+    } as StorageArchivistParams)
     return archivist
   }
 }
 
-export const LatestUtmPayload = async (): Promise<PayloadWithOptionalSources<Utm> | undefined> => {
+export const LatestUtmPayload = async (): Promise<Payload<Utm, Schema<UtmSchema>> | undefined> => {
   const archivist = await UtmStorageArchivist()
-  return (await archivist.next()).find(isUtm) as PayloadWithOptionalSources<Utm>
+  return (await archivist.next()).find(isUtm) as Payload<Utm, Schema<UtmSchema>>
 }