@xyo-network/react-advertising 7.5.8 → 7.5.11

package/dist/browser/index.mjs

@@ -1,6 +1,3 @@
-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";
@@ -13,7 +10,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 = /* @__PURE__ */ __name(async () => {
+var UtmStorageArchivist = async () => {
   if (archivist) {
     return archivist;
   } else {
@@ -27,18 +24,18 @@ var UtmStorageArchivist = /* @__PURE__ */ __name(async () => {
     });
     return archivist;
   }
-}, "UtmStorageArchivist");
-var LatestUtmPayload = /* @__PURE__ */ __name(async () => {
+};
+var LatestUtmPayload = 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 = /* @__PURE__ */ __name(({ queryParams }) => {
+var useDefaultPageState = ({ queryParams }) => {
   const [searchParams, setSearchParams] = useSearchParams();
-  const patchDefaultPageState = /* @__PURE__ */ __name((source, key, value) => {
+  const patchDefaultPageState = (source, key, value) => {
     switch (source) {
       case "queryParams": {
         setSearchParams((prevSearchParams) => {
@@ -52,25 +49,19 @@ var useDefaultPageState = /* @__PURE__ */ __name(({ queryParams }) => {
         throw new Error(`Invalid source for default page state: ${source}`);
       }
     }
-  }, "patchDefaultPageState");
+  };
   const queryParamsState = useMemo(() => {
     if (!queryParams) return {};
-    let defaultState = {};
+    const defaultState = {};
     for (const [key, value] of searchParams.entries()) {
       if (queryParams.includes(key)) {
         defaultState[key] = value;
       }
     }
     return defaultState;
-  }, [
-    searchParams,
-    queryParams
-  ]);
-  return [
-    queryParamsState,
-    patchDefaultPageState
-  ];
-}, "useDefaultPageState");
+  }, [searchParams, queryParams]);
+  return [queryParamsState, patchDefaultPageState];
+};
 
 // src/utm/hooks/useDefaultUtmPageState.ts
 var UtmQueryParamStrings = {
@@ -80,21 +71,23 @@ var UtmQueryParamStrings = {
   utmSource: "utm_source",
   utmTerm: "utm_term"
 };
-var useDefaultUtmPageState = /* @__PURE__ */ __name(() => useDefaultPageState({
-  queryParams: Object.values(UtmQueryParamStrings)
-}), "useDefaultUtmPageState");
+var useDefaultUtmPageState = () => useDefaultPageState({ queryParams: Object.values(UtmQueryParamStrings) });
 
 // src/utm/hooks/useCaptureUtmLocation.ts
-var useCaptureUtmLocation = /* @__PURE__ */ __name((removeAfterCapture = true) => {
-  const [{ utm_campaign, utm_content, utm_medium, utm_source, utm_term }] = useDefaultUtmPageState();
+var useCaptureUtmLocation = (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: asSchema(UtmSchema, true)
-    };
+    const utm = { schema: asSchema(UtmSchema, true) };
     const utmParams = {
       utm_campaign,
       utm_content,
@@ -115,19 +108,11 @@ var useCaptureUtmLocation = /* @__PURE__ */ __name((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();
@@ -138,16 +123,9 @@ var useCaptureUtmLocation = /* @__PURE__ */ __name((removeAfterCapture = true) =
         });
       }
     }
-  }, [
-    sessionStorageArchivist,
-    utmPayload,
-    removeAfterCapture
-  ]);
-  return {
-    utmPayload,
-    error: error ?? insertError
-  };
-}, "useCaptureUtmLocation");
+  }, [sessionStorageArchivist, utmPayload, removeAfterCapture]);
+  return { utmPayload, error: error ?? insertError };
+};
 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 { 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"]}
+{"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 (): Promise<StorageArchivist> => {\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    const 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;AACpC,SAAS,gBAA8B;AACvC,SAAS,WAAAA,gBAAe;AACxB,SAAS,mBAAAC,wBAAuB;;;ACHhC,SAAS,aAAa;AAEtB,SAAS,kBAAkB,oCAAoC;AAG/D,IAAM,qBAAqB;AAE3B,IAAI;AAMG,IAAM,sBAAsB,YAAuC;AACxE,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,CAA2B;AAC3B,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mBAAmB,YAAkE;AAChG,QAAMC,aAAY,MAAM,oBAAoB;AAC5C,UAAQ,MAAMA,WAAU,KAAK,GAAG,KAAK,KAAK;AAC5C;;;AC/BA,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,UAAM,eAAe,CAAC;AACtB,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,MAAoB,EAAE,QAAQ,SAAS,WAAW,IAAI,EAAE;AAK9D,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"]}

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

@@ -1,2 +1,2 @@
-export type PageStateKeys = ReadonlyArray<string>;
+export type PageStateKeys = readonly string[];
 //# sourceMappingURL=PageStateKeys.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PageStateKeys.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/PageStateKeys.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA"}
+{"version":3,"file":"PageStateKeys.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/PageStateKeys.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,SAAS,MAAM,EAAE,CAAA"}

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

@@ -1,11 +1,10 @@
 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 { 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<StorageArchivistParams, import("@xyo-network/archivist-model").ArchivistModuleEventData>>;
+export declare const UtmStorageArchivist: () => Promise<StorageArchivist>;
 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,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"}
+{"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;AAG9E,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,QAAa,OAAO,CAAC,gBAAgB,CAYpE,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.5.8",
+  "version": "7.5.11",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -36,42 +36,91 @@
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/browser/index.mjs",
-  "types": "dist/browser/index.d.ts",
   "files": [
     "dist",
-    "src"
+    "README.md"
   ],
-  "dependencies": {
-    "@xylabs/react-promise": "~7.1.17",
-    "@xyo-network/advertising-payload-plugins": "~5.3.1",
-    "@xyo-network/archivist-storage": "~5.3.17",
-    "@xyo-network/payload-model": "~5.3.17"
-  },
   "devDependencies": {
-    "@mui/material": "~7.3.9",
-    "@storybook/react-vite": "~10.3.3",
+    "@bitauth/libauth": "~3.0.0",
+    "@mui/material": "^7.3.10",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/sdk-trace-base": "^2.7.0",
+    "@scure/base": "~2.2.0",
+    "@storybook/react-vite": "~10.3.5",
+    "@types/node": "~25.6.0",
     "@types/react": "^19.2.14",
-    "@xylabs/ts-scripts-common": "~7.5.6",
-    "@xylabs/ts-scripts-yarn3": "~7.5.6",
-    "@xylabs/tsconfig": "~7.5.6",
-    "@xylabs/tsconfig-dom": "~7.5.6",
-    "@xylabs/tsconfig-react": "~7.5.6",
-    "react": "^19.2.4",
-    "react-dom": "^19.2.4",
-    "storybook": "~10.3.3",
+    "@xylabs/react-promise": "~7.1.20",
+    "@xylabs/sdk-js": "^5.0.100",
+    "@xylabs/threads": "~5.0.100",
+    "@xylabs/toolchain": "~7.11.9",
+    "@xylabs/tsconfig": "^7.11.9",
+    "@xylabs/tsconfig-dom": "^7.11.9",
+    "@xylabs/tsconfig-react": "~7.11.9",
+    "@xyo-network/account": "~5.5.1",
+    "@xyo-network/account-model": "^5.5.1",
+    "@xyo-network/advertising-payload-plugins": "~5.4.9",
+    "@xyo-network/archivist-storage": "~5.5.5",
+    "@xyo-network/boundwitness-builder": "^5.5.1",
+    "@xyo-network/boundwitness-model": "^5.5.1",
+    "@xyo-network/boundwitness-wrapper": "~5.5.1",
+    "@xyo-network/config-payload-plugin": "~5.5.1",
+    "@xyo-network/manifest-model": "~5.5.1",
+    "@xyo-network/payload-builder": "^5.5.1",
+    "@xyo-network/payload-model": "^5.5.1",
+    "@xyo-network/query-payload-plugin": "~5.5.1",
+    "@xyo-network/wallet-model": "^5.5.1",
+    "async-mutex": "^0.5.0",
+    "axios": "^1.15.2",
+    "bn.js": "^5.2.3",
+    "buffer": "^6.0.3",
+    "chalk": "^5.6.2",
+    "debug": "~4.4.3",
+    "esbuild": "~0.28.0",
+    "eslint": "^10.2.1",
+    "ethers": "^6.16.0",
+    "hash-wasm": "~4.12.0",
+    "lru-cache": "^11.3.5",
+    "observable-fns": "~0.6.1",
+    "pako": "^2.1.0",
+    "react": "^19.2.5",
+    "react-dom": "^19.2.5",
+    "react-router-dom": "^7.14.2",
+    "store2": "~2.14.4",
+    "storybook": "^10.3.5",
     "typescript": "^5.9.3",
-    "vite": "~8.0.3",
+    "vite": "^8.0.10",
+    "wasm-feature-detect": "~1.8.0",
     "zod": "^4.3.6"
   },
   "peerDependencies": {
-    "react": "^19",
-    "react-dom": "^19",
-    "react-router-dom": "^7",
-    "zod": "^4"
+    "@opentelemetry/api": "^1.9.1",
+    "@scure/base": "~2.2.0",
+    "@xylabs/react-promise": "~7.1.20",
+    "@xylabs/sdk-js": "^5.0.100",
+    "@xyo-network/account": "~5.5.1",
+    "@xyo-network/account-model": "^5.5.1",
+    "@xyo-network/advertising-payload-plugins": "~5.4.9",
+    "@xyo-network/archivist-storage": "~5.5.5",
+    "@xyo-network/boundwitness-builder": "^5.5.1",
+    "@xyo-network/boundwitness-model": "^5.5.1",
+    "@xyo-network/boundwitness-wrapper": "~5.5.1",
+    "@xyo-network/config-payload-plugin": "~5.5.1",
+    "@xyo-network/manifest-model": "~5.5.1",
+    "@xyo-network/payload-builder": "^5.5.1",
+    "@xyo-network/payload-model": "^5.5.1",
+    "@xyo-network/query-payload-plugin": "~5.5.1",
+    "@xyo-network/wallet-model": "^5.5.1",
+    "async-mutex": "^0.5.0",
+    "ethers": "^6.16.0",
+    "lru-cache": "^11.3.5",
+    "react": "^19.2.5",
+    "react-dom": "^19.2.5",
+    "react-router-dom": "^7.14.2",
+    "store2": "~2.14.4",
+    "zod": "^4.3.6"
   },
   "publishConfig": {
     "access": "public"
   },
   "docs": "dist/docs.json"
-}
+}

package/src/index.ts

@@ -1 +0,0 @@
-export * from './utm/index.ts'

package/src/types/images.d.ts

@@ -1,5 +0,0 @@
-declare module '*.png'
-declare module '*.jpg'
-declare module '*.svg'
-declare module '*.gif'
-declare module '*.webp'

package/src/utm/hooks/UseCaptureUtmLocation.stories.tsx

@@ -1,83 +0,0 @@
-import { Box, Typography } from '@mui/material'
-import type { Meta, StoryFn } from '@storybook/react-vite'
-import { usePromise } from '@xylabs/react-promise'
-import type { PropsWithChildren } from 'react'
-import React, { useEffect } from 'react'
-import { BrowserRouter, useSearchParams } from 'react-router-dom'
-
-import { LatestUtmPayload, UtmStorageArchivist } from '../lib/index.ts'
-import { useCaptureUtmLocation } from './useCaptureUtmLocation.ts'
-
-export default { title: 'advertising/UseCaptureUtmLocation' } as Meta
-
-const UtmStub: React.FC<PropsWithChildren> = ({ children }) => {
-  const [, setParams] = useSearchParams()
-
-  useEffect(() => {
-    UtmStorageArchivist().then(async (archivist) => {
-      await archivist.clear()
-    }).catch(error => console.error(error))
-
-    setParams(() => {
-      const newParams = new URLSearchParams()
-      newParams.set('utm_campaign', 'test-campaign')
-      newParams.set('utm_content', 'test-content')
-      return newParams
-    })
-  }, [])
-
-  return children
-}
-
-const RouterDecorator = (Story: React.ElementType) => (
-  <BrowserRouter>
-    <UtmStub>
-      <Story />
-    </UtmStub>
-  </BrowserRouter>
-)
-
-const TemplateInner = ({ message }: { message: string }) => {
-  const [params] = useSearchParams()
-
-  const [payload] = usePromise(async () => await LatestUtmPayload(), [])
-  return (
-    <Box sx={{
-      display: 'flex', flexDirection: 'column', gap: 2,
-    }}
-    >
-      <Typography>
-        Stored Payload:
-        <code>
-          {JSON.stringify(payload, null, 2)}
-        </code>
-      </Typography>
-      <Typography>
-        {message}
-        <code>
-          {JSON.stringify(params.toString(), null, 2)}
-        </code>
-      </Typography>
-    </Box>
-  )
-}
-
-const Template: StoryFn = () => {
-  useCaptureUtmLocation()
-
-  return <TemplateInner message="Query Parameters (should be empty):" />
-}
-
-const TemplateWithoutClear: StoryFn = () => {
-  useCaptureUtmLocation(false)
-
-  return <TemplateInner message="Query Parameters (should NOT be empty):" />
-}
-
-const Default = Template.bind({})
-Default.decorators = [RouterDecorator]
-
-const WithNoClearAfterCapture = TemplateWithoutClear.bind({})
-WithNoClearAfterCapture.decorators = [RouterDecorator]
-
-export { Default, WithNoClearAfterCapture }

package/src/utm/hooks/index.ts

@@ -1,3 +0,0 @@
-export * from './useCaptureUtmLocation.ts'
-export * from './useDefaultPageState.ts'
-export * from './useDefaultUtmPageState.ts'

package/src/utm/hooks/useCaptureUtmLocation.ts

@@ -1,69 +0,0 @@
-import { usePromise } from '@xylabs/react-promise'
-import { type Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'
-import { asSchema, type Payload } from '@xyo-network/payload-model'
-import { useMemo } from 'react'
-import { useSearchParams } from 'react-router-dom'
-
-import { UtmStorageArchivist } from '../lib/index.ts'
-import { useDefaultUtmPageState, UtmQueryParamStrings } from './useDefaultUtmPageState.ts'
-
-export const useCaptureUtmLocation = (removeAfterCapture = true) => {
-  const [{
-    utm_campaign, utm_content, utm_medium, utm_source, utm_term,
-  }] = useDefaultUtmPageState()
-  const [,setSearchParams] = useSearchParams()
-
-  const [sessionStorageArchivist, error] = usePromise(async () => {
-    return await UtmStorageArchivist()
-  }, [])
-
-  const utmPayload = useMemo(() => {
-    // Construct the base UTM payload
-    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
-    // with none or they've already been captured
-    const utmParams = {
-      utm_campaign, utm_content, utm_medium, utm_source, utm_term,
-    }
-    const foundUpdatedUtmParams = Object.entries(utmParams).some(([key, value]) => {
-      return key.includes('utm_') && value
-    })
-
-    if (foundUpdatedUtmParams) {
-      // Conditionally add all the UTM parameters present
-      if (utm_campaign) utm.utm_campaign = utm_campaign
-      if (utm_content) utm.utm_content = utm_content
-      if (utm_medium) utm.utm_medium = utm_medium
-      if (utm_source) utm.utm_source = utm_source
-      if (utm_term) utm.utm_term = utm_term
-
-      return utm
-    } else {
-      return null
-    }
-  }, [utm_campaign, utm_content, utm_medium, utm_source, utm_term])
-
-  const [,insertError] = usePromise(async () => {
-    if (utmPayload && sessionStorageArchivist) {
-      // clear all previous utm payloads
-      await sessionStorageArchivist.clear()
-      // insert params into session storage
-      await sessionStorageArchivist.insert([utmPayload])
-
-      if (removeAfterCapture) {
-        // remove the utm params from the URL
-        setSearchParams(() => {
-          const newParams = new URLSearchParams()
-          for (const value of Object.values(UtmQueryParamStrings)) {
-            newParams.delete(value)
-          }
-          return newParams
-        })
-      }
-    }
-  }, [sessionStorageArchivist, utmPayload, removeAfterCapture])
-
-  return { utmPayload, error: error ?? insertError }
-}

package/src/utm/hooks/useDefaultPageState.ts

@@ -1,56 +0,0 @@
-import { useMemo } from 'react'
-import { useSearchParams } from 'react-router-dom'
-
-import type { PageStateKeys } from '../lib/index.ts'
-
-export interface DefaultPageStateParams<TQueryParams extends PageStateKeys = PageStateKeys> {
-  queryParams: TQueryParams
-}
-
-export type DefaultPageStateReturn<TPageStateKeys extends PageStateKeys = PageStateKeys> = [
-  Record<TPageStateKeys[number], string>,
-  (source: keyof DefaultPageStateParams, key: TPageStateKeys[number], value: string) => void,
-]
-
-/**
- * Hook to get default page state as key value pairs from various sources.  It provides a convenient abstraction over free form
- * page state like query params by narrowing the used params and centralizing their logic.
- *
- * Future work could include adding support for localStorage, sessionStorage, and precedence of sources.
- * @param defaultPageStateParams various sources of default page state (i.e. queryParams, localStorage, etc.)
- * @returns
- */
-export const useDefaultPageState = <TQueryParams extends PageStateKeys = PageStateKeys>(
-  { queryParams }: DefaultPageStateParams<TQueryParams>,
-): DefaultPageStateReturn<TQueryParams> => {
-  const [searchParams, setSearchParams] = useSearchParams()
-
-  const patchDefaultPageState = (source: keyof DefaultPageStateParams, key: TQueryParams[number], value: string) => {
-    switch (source) {
-      case 'queryParams': {
-        setSearchParams((prevSearchParams) => {
-          const newSearchParams = new URLSearchParams(prevSearchParams)
-          newSearchParams.set(key, value)
-          return newSearchParams
-        })
-        break
-      }
-      default: {
-        throw new Error(`Invalid source for default page state: ${source}`)
-      }
-    }
-  }
-
-  const queryParamsState = useMemo(() => {
-    if (!queryParams) return {} as Record<TQueryParams[number], string>
-    let defaultState = {} as Record<TQueryParams[number], string>
-    for (const [key, value] of searchParams.entries()) {
-      if (queryParams.includes(key)) {
-        defaultState[key as TQueryParams[number]] = value
-      }
-    }
-    return defaultState
-  }, [searchParams, queryParams])
-
-  return [queryParamsState, patchDefaultPageState]
-}

package/src/utm/hooks/useDefaultUtmPageState.ts

@@ -1,14 +0,0 @@
-import { useDefaultPageState } from './useDefaultPageState.ts'
-
-export const UtmQueryParamStrings = {
-  utmCampaign: 'utm_campaign',
-  utmContent: 'utm_content',
-  utmMedium: 'utm_medium',
-  utmSource: 'utm_source',
-  utmTerm: 'utm_term',
-} as const
-
-export type UtmQueryParams = typeof UtmQueryParamStrings[keyof typeof UtmQueryParamStrings]
-
-/** Get the default page state for utm values from specific query params */
-export const useDefaultUtmPageState = () => useDefaultPageState<UtmQueryParams[]>({ queryParams: Object.values(UtmQueryParamStrings) })

package/src/utm/index.ts

@@ -1,2 +0,0 @@
-export * from './hooks/index.ts'
-export * from './lib/index.ts'

package/src/utm/lib/PageStateKeys.ts

@@ -1 +0,0 @@
-export type PageStateKeys = ReadonlyArray<string>

package/src/utm/lib/UtmStorageArchivist.ts

@@ -1,32 +0,0 @@
-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 { Payload, Schema } from '@xyo-network/payload-model'
-
-const STORAGE_NAME_SPACE = 'utm' as const
-
-let archivist: StorageArchivist | undefined
-
-/**
- * Find or create a single instance of the UtmStorageArchivist
- * @returns Archivist instance
- */
-export const UtmStorageArchivist = async () => {
-  if (archivist) {
-    return archivist
-  } else {
-    archivist = await StorageArchivist.create({
-      account: 'random',
-      config: {
-        schema: StorageArchivistConfigSchema, namespace: STORAGE_NAME_SPACE, type: 'session',
-      },
-    } as StorageArchivistParams)
-    return archivist
-  }
-}
-
-export const LatestUtmPayload = async (): Promise<Payload<Utm, Schema<UtmSchema>> | undefined> => {
-  const archivist = await UtmStorageArchivist()
-  return (await archivist.next()).find(isUtm) as Payload<Utm, Schema<UtmSchema>>
-}

package/src/utm/lib/index.ts

@@ -1,2 +0,0 @@
-export * from './PageStateKeys.ts'
-export * from './UtmStorageArchivist.ts'