@xyo-network/react-advertising 4.2.13 → 4.3.0-rc.1

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 { 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: 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'\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<Utm | undefined> => {\n  const archivist = await UtmStorageArchivist()\n  return (await archivist.next()).find(isUtm) as 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,SAASA,kBAAkB;AAC3B,SAAmBC,iBAAiB;AACpC,SAASC,WAAAA,gBAAe;AACxB,SAASC,mBAAAA,wBAAuB;;;ACFhC,SAASC,aAAa;AACtB,SAASC,kBAAkBC,oCAAoC;AAE/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;;;AC1BhC,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;;;AHL/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,MAAW;MAAEC,QAAQC;IAAU;AAKrC,UAAMC,YAAY;MAChBjB;MAAcC;MAAaC;MAAYC;MAAYC;IACrD;AACA,UAAMc,wBAAwBC,OAAOC,QAAQH,SAAAA,EAAWI,KAAK,CAAC,CAACC,KAAKC,KAAAA,MAAM;AACxE,aAAOD,IAAIE,SAAS,MAAA,KAAWD;IACjC,CAAA;AAEA,QAAIL,uBAAuB;AAEzB,UAAIlB,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,EAAEqB,WAAAA,IAAef,WAAW,YAAA;AAChC,QAAIE,cAAcJ,yBAAyB;AAEzC,YAAMA,wBAAwBkB,MAAK;AAEnC,YAAMlB,wBAAwBmB,OAAO;QAACf;OAAW;AAEjD,UAAIb,oBAAoB;AAEtBO,wBAAgB,MAAA;AACd,gBAAMsB,YAAY,IAAIC,gBAAAA;AACtB,qBAAWN,SAASJ,OAAOW,OAAOC,oBAAAA,GAAuB;AACvDH,sBAAUI,OAAOT,KAAAA;UACnB;AACA,iBAAOK;QACT,CAAA;MACF;IACF;EACF,GAAG;IAACpB;IAAyBI;IAAYb;GAAmB;AAE5D,SAAO;IAAEa;IAAYH,OAAOA,SAASgB;EAAY;AACnD,GA3DqC;","names":["usePromise","UtmSchema","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","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 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,SAASA,kBAAkB;AAC3B,SAAmBC,iBAAiB;AAEpC,SAASC,WAAAA,gBAAe;AACxB,SAASC,mBAAAA,wBAAuB;;;ACHhC,SAASC,aAAa;AACtB,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;;;AC3BhC,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,MAAuC;MAAEC,QAAQC;IAAU;AAKjE,UAAMC,YAAY;MAChBjB;MAAcC;MAAaC;MAAYC;MAAYC;IACrD;AACA,UAAMc,wBAAwBC,OAAOC,QAAQH,SAAAA,EAAWI,KAAK,CAAC,CAACC,KAAKC,KAAAA,MAAM;AACxE,aAAOD,IAAIE,SAAS,MAAA,KAAWD;IACjC,CAAA;AAEA,QAAIL,uBAAuB;AAEzB,UAAIlB,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,EAAEqB,WAAAA,IAAef,WAAW,YAAA;AAChC,QAAIE,cAAcJ,yBAAyB;AAEzC,YAAMA,wBAAwBkB,MAAK;AAEnC,YAAMlB,wBAAwBmB,OAAO;QAACf;OAAW;AAEjD,UAAIb,oBAAoB;AAEtBO,wBAAgB,MAAA;AACd,gBAAMsB,YAAY,IAAIC,gBAAAA;AACtB,qBAAWN,SAASJ,OAAOW,OAAOC,oBAAAA,GAAuB;AACvDH,sBAAUI,OAAOT,KAAAA;UACnB;AACA,iBAAOK;QACT,CAAA;MACF;IACF;EACF,GAAG;IAACpB;IAAyBI;IAAYb;GAAmB;AAE5D,SAAO;IAAEa;IAAYH,OAAOA,SAASgB;EAAY;AACnD,GA3DqC;","names":["usePromise","UtmSchema","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","UtmSchema","utmParams","foundUpdatedUtmParams","Object","entries","some","key","value","includes","insertError","clear","insert","newParams","URLSearchParams","values","UtmQueryParamStrings","delete"]}

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

@@ -1,6 +1,12 @@
-import { type Utm } from '@xyo-network/advertising-payload-plugins';
 export declare const useCaptureUtmLocation: (removeAfterCapture?: boolean) => {
-    utmPayload: Utm | null;
+    utmPayload: import("@xylabs/object").DeepRestrictToStringKeys<{
+        schema: "network.xyo.advertising.utm";
+        utm_campaign?: string | undefined;
+        utm_content?: string | undefined;
+        utm_medium?: string | undefined;
+        utm_source?: string | undefined;
+        utm_term?: string | undefined;
+    }> | 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;AAO9E,eAAO,MAAM,qBAAqB;;;CA2DjC,CAAA"}
+{"version":3,"file":"useCaptureUtmLocation.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/useCaptureUtmLocation.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,qBAAqB;;;;;;;;;;CA2DjC,CAAA"}

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

@@ -1,5 +1,6 @@
 import type { Utm } from '@xyo-network/advertising-payload-plugins';
-import { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage';
+import { StorageArchivist } from '@xyo-network/archivist-storage';
+import type { PayloadWithOptionalSources } from '@xyo-network/payload-model';
 /**
  * Find or create a single instance of the UtmStorageArchivist
  * @returns Archivist instance
@@ -9,25 +10,65 @@ export declare const UtmStorageArchivist: () => Promise<StorageArchivist<import(
     addToResolvers?: boolean;
     additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
     allowNameResolution?: boolean;
-    config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
-        parents?: import("@xyo-network/archivist-model").ArchivistParents;
-        requireAllParents?: boolean;
-        schema: "network.xyo.archivist.storage.config";
-        storage?: import("@xyo-network/archivist-model").ArchivistStorage;
-        storeParentReads?: boolean;
-    } & {
-        maxEntries?: number;
-        maxEntrySize?: number;
-        namespace?: string;
-        schema: StorageArchivistConfigSchema;
-        type?: "local" | "session" | "page";
-    }, "schema"> & {
-        schema: "network.xyo.archivist.storage.config";
-    }, "schema"> & {
-        schema: string;
-    };
+    config: import("@xylabs/object").DeepRestrictToStringKeys<{
+        schema: import("@xyo-network/payload-model").Schema;
+        readonly archiving?: {
+            readonly archivists?: string[] | undefined;
+            readonly queries?: string[] | undefined;
+        } | undefined;
+        readonly allowedQueries?: string[] | undefined;
+        readonly archivist?: import("@xyo-network/module-model").ModuleIdentifier | undefined;
+        readonly consoleLogger?: import("@xylabs/logger").LogLevel | undefined;
+        readonly labels?: {
+            [x: string]: string | undefined;
+        } | undefined;
+        readonly name?: import("@xyo-network/module-model").ModuleName | undefined;
+        readonly paging?: {
+            [x: string]: {
+                size?: number | undefined;
+            };
+        } | undefined;
+        readonly retry?: {
+            backoff?: number | undefined;
+            interval?: number | undefined;
+            retries?: number | undefined;
+        } | undefined;
+        readonly security?: {
+            readonly allowAnonymous?: boolean | undefined;
+            readonly allowed?: {
+                [x: string]: (Lowercase<string> | Lowercase<string>[])[];
+            } | undefined;
+            readonly disallowed?: {
+                [x: string]: Lowercase<string>[];
+            } | undefined;
+        } | undefined;
+        readonly sign?: boolean | undefined;
+        readonly storeQueries?: boolean | undefined;
+        readonly timestamp?: boolean | undefined;
+        parents?: {
+            commit?: Lowercase<string>[] | undefined;
+            read?: Lowercase<string>[] | undefined;
+            write?: Lowercase<string>[] | undefined;
+        } | undefined;
+        requireAllParents?: boolean | undefined;
+        storage?: {
+            indexes?: {
+                key: {
+                    [x: string]: import("@xyo-network/archivist-model").IndexDirection;
+                };
+                multiEntry?: boolean | undefined;
+                name?: string | undefined;
+                unique?: boolean | undefined;
+            }[] | undefined;
+        } | undefined;
+        storeParentReads?: boolean | undefined;
+        maxEntries?: number | undefined;
+        maxEntrySize?: number | undefined;
+        namespace?: string | undefined;
+        type?: "local" | "session" | "page" | undefined;
+    }>;
     ephemeralQueryAccountEnabled?: boolean;
     moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
 }, import("@xyo-network/archivist-model").ArchivistModuleEventData>>;
-export declare const LatestUtmPayload: () => Promise<Utm | undefined>;
+export declare const LatestUtmPayload: () => Promise<PayloadWithOptionalSources<Utm> | 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,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAA;AAM/F;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;oEAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,GAAG,GAAG,SAAS,CAGhE,CAAA"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oEAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,GAAG,SAAS,CAG5F,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-advertising",
-  "version": "4.2.13",
+  "version": "4.3.0-rc.1",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -44,8 +44,9 @@
   },
   "dependencies": {
     "@xylabs/react-promise": "^5.3.13",
-    "@xyo-network/advertising-payload-plugins": "^3.1.2",
-    "@xyo-network/archivist-storage": "^3.5.2"
+    "@xyo-network/advertising-payload-plugins": "^3.2.0-rc.3",
+    "@xyo-network/archivist-storage": "^3.6.0-rc.14",
+    "@xyo-network/payload-model": "^3.6.0-rc.14"
   },
   "devDependencies": {
     "@mui/material": "^6.2.1",
@@ -65,5 +66,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "docs": "dist/docs.json"
+  "docs": "dist/docs.json",
+  "stableVersion": "4.2.14"
 }

package/src/utm/hooks/useCaptureUtmLocation.ts

@@ -1,5 +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 { useMemo } from 'react'
 import { useSearchParams } from 'react-router-dom'
 
@@ -18,7 +19,7 @@ export const useCaptureUtmLocation = (removeAfterCapture = true) => {
 
   const utmPayload = useMemo(() => {
     // Construct the base UTM payload
-    const utm: Utm = { schema: UtmSchema }
+    const utm: PayloadWithOptionalSources<Utm> = { schema: UtmSchema }
 
     // 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,6 +1,7 @@
 import type { Utm } from '@xyo-network/advertising-payload-plugins'
 import { isUtm } from '@xyo-network/advertising-payload-plugins'
 import { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage'
+import type { PayloadWithOptionalSources } from '@xyo-network/payload-model'
 
 const STORAGE_NAME_SPACE = 'utm' as const
 
@@ -24,7 +25,7 @@ export const UtmStorageArchivist = async () => {
   }
 }
 
-export const LatestUtmPayload = async (): Promise<Utm | undefined> => {
+export const LatestUtmPayload = async (): Promise<PayloadWithOptionalSources<Utm> | undefined> => {
   const archivist = await UtmStorageArchivist()
-  return (await archivist.next()).find(isUtm) as Utm
+  return (await archivist.next()).find(isUtm) as PayloadWithOptionalSources<Utm>
 }