@xyo-network/react-advertising 4.1.10 → 4.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.mjs +5 -4
- package/dist/browser/index.mjs.map +1 -1
- package/dist/browser/utm/hooks/useCaptureUtmLocation.d.ts +1 -1
- package/dist/browser/utm/hooks/useCaptureUtmLocation.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/utm/hooks/useCaptureUtmLocation.ts +5 -3
- package/src/utm/lib/UtmStorageArchivist.ts +1 -1
package/dist/browser/index.mjs
CHANGED
|
@@ -29,7 +29,7 @@ var UtmStorageArchivist = /* @__PURE__ */ __name(async () => {
|
|
|
29
29
|
}, "UtmStorageArchivist");
|
|
30
30
|
var LatestUtmPayload = /* @__PURE__ */ __name(async () => {
|
|
31
31
|
const archivist2 = await UtmStorageArchivist();
|
|
32
|
-
return (await archivist2.
|
|
32
|
+
return (await archivist2.next()).find(isUtm);
|
|
33
33
|
}, "LatestUtmPayload");
|
|
34
34
|
|
|
35
35
|
// src/utm/hooks/useDefaultPageState.ts
|
|
@@ -84,7 +84,7 @@ var useDefaultUtmPageState = /* @__PURE__ */ __name(() => useDefaultPageState({
|
|
|
84
84
|
}), "useDefaultUtmPageState");
|
|
85
85
|
|
|
86
86
|
// src/utm/hooks/useCaptureUtmLocation.ts
|
|
87
|
-
var useCaptureUtmLocation = /* @__PURE__ */ __name((
|
|
87
|
+
var useCaptureUtmLocation = /* @__PURE__ */ __name((removeAfterCapture = true) => {
|
|
88
88
|
const [{ utm_campaign, utm_content, utm_medium, utm_source, utm_term }] = useDefaultUtmPageState();
|
|
89
89
|
const [, setSearchParams] = useSearchParams2();
|
|
90
90
|
const [sessionStorageArchivist, error] = usePromise(async () => {
|
|
@@ -123,10 +123,11 @@ var useCaptureUtmLocation = /* @__PURE__ */ __name((clearAfterCapture = true) =>
|
|
|
123
123
|
]);
|
|
124
124
|
const [, insertError] = usePromise(async () => {
|
|
125
125
|
if (utmPayload && sessionStorageArchivist) {
|
|
126
|
+
await sessionStorageArchivist.clear();
|
|
126
127
|
await sessionStorageArchivist.insert([
|
|
127
128
|
utmPayload
|
|
128
129
|
]);
|
|
129
|
-
if (
|
|
130
|
+
if (removeAfterCapture) {
|
|
130
131
|
setSearchParams(() => {
|
|
131
132
|
const newParams = new URLSearchParams();
|
|
132
133
|
for (const value of Object.values(UtmQueryParamStrings)) {
|
|
@@ -139,7 +140,7 @@ var useCaptureUtmLocation = /* @__PURE__ */ __name((clearAfterCapture = true) =>
|
|
|
139
140
|
}, [
|
|
140
141
|
sessionStorageArchivist,
|
|
141
142
|
utmPayload,
|
|
142
|
-
|
|
143
|
+
removeAfterCapture
|
|
143
144
|
]);
|
|
144
145
|
return {
|
|
145
146
|
utmPayload,
|
|
@@ -1 +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 = (clearAfterCapture = 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 // insert params into session storage\n await sessionStorageArchivist.insert([utmPayload])\n\n if (clearAfterCapture) {\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, clearAfterCapture])\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.all()).findLast(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,IAAG,GAAIC,SAASC,KAAAA;AAC1C,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,oBAAoB,SAAI;AAC5D,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,OAAO;QAACd;OAAW;AAEjD,UAAIb,mBAAmB;AAErBO,wBAAgB,MAAA;AACd,gBAAMqB,YAAY,IAAIC,gBAAAA;AACtB,qBAAWL,SAASJ,OAAOU,OAAOC,oBAAAA,GAAuB;AACvDH,sBAAUI,OAAOR,KAAAA;UACnB;AACA,iBAAOI;QACT,CAAA;MACF;IACF;EACF,GAAG;IAACnB;IAAyBI;IAAYb;GAAkB;AAE3D,SAAO;IAAEa;IAAYH,OAAOA,SAASgB;EAAY;AACnD,GAzDqC;","names":["usePromise","UtmSchema","useMemo","useSearchParams","isUtm","StorageArchivist","StorageArchivistConfigSchema","STORAGE_NAME_SPACE","archivist","UtmStorageArchivist","StorageArchivist","create","account","config","schema","StorageArchivistConfigSchema","namespace","type","LatestUtmPayload","all","findLast","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","clearAfterCapture","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","insert","newParams","URLSearchParams","values","UtmQueryParamStrings","delete"]}
|
|
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"]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Utm } from '@xyo-network/advertising-payload-plugins';
|
|
2
|
-
export declare const useCaptureUtmLocation: (
|
|
2
|
+
export declare const useCaptureUtmLocation: (removeAfterCapture?: boolean) => {
|
|
3
3
|
utmPayload: Utm | null;
|
|
4
4
|
error: Error | undefined;
|
|
5
5
|
};
|
|
@@ -1 +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;;;
|
|
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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/react-advertising",
|
|
3
|
-
"version": "4.1.
|
|
3
|
+
"version": "4.1.12",
|
|
4
4
|
"description": "Common React library for all XYO projects that use React",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"xyo",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"lint-pkg": "npmPkgJsonLint ."
|
|
44
44
|
},
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@xylabs/react-promise": "^5.2.
|
|
46
|
+
"@xylabs/react-promise": "^5.2.10",
|
|
47
47
|
"@xyo-network/advertising-payload-plugins": "^3.1.1",
|
|
48
48
|
"@xyo-network/archivist-storage": "^3.3.2"
|
|
49
49
|
},
|
|
@@ -6,7 +6,7 @@ import { useSearchParams } from 'react-router-dom'
|
|
|
6
6
|
import { UtmStorageArchivist } from '../lib/index.ts'
|
|
7
7
|
import { useDefaultUtmPageState, UtmQueryParamStrings } from './useDefaultUtmPageState.ts'
|
|
8
8
|
|
|
9
|
-
export const useCaptureUtmLocation = (
|
|
9
|
+
export const useCaptureUtmLocation = (removeAfterCapture = true) => {
|
|
10
10
|
const [{
|
|
11
11
|
utm_campaign, utm_content, utm_medium, utm_source, utm_term,
|
|
12
12
|
}] = useDefaultUtmPageState()
|
|
@@ -46,10 +46,12 @@ export const useCaptureUtmLocation = (clearAfterCapture = true) => {
|
|
|
46
46
|
|
|
47
47
|
const [,insertError] = usePromise(async () => {
|
|
48
48
|
if (utmPayload && sessionStorageArchivist) {
|
|
49
|
+
// clear all previous utm payloads
|
|
50
|
+
await sessionStorageArchivist.clear()
|
|
49
51
|
// insert params into session storage
|
|
50
52
|
await sessionStorageArchivist.insert([utmPayload])
|
|
51
53
|
|
|
52
|
-
if (
|
|
54
|
+
if (removeAfterCapture) {
|
|
53
55
|
// remove the utm params from the URL
|
|
54
56
|
setSearchParams(() => {
|
|
55
57
|
const newParams = new URLSearchParams()
|
|
@@ -60,7 +62,7 @@ export const useCaptureUtmLocation = (clearAfterCapture = true) => {
|
|
|
60
62
|
})
|
|
61
63
|
}
|
|
62
64
|
}
|
|
63
|
-
}, [sessionStorageArchivist, utmPayload,
|
|
65
|
+
}, [sessionStorageArchivist, utmPayload, removeAfterCapture])
|
|
64
66
|
|
|
65
67
|
return { utmPayload, error: error ?? insertError }
|
|
66
68
|
}
|
|
@@ -26,5 +26,5 @@ export const UtmStorageArchivist = async () => {
|
|
|
26
26
|
|
|
27
27
|
export const LatestUtmPayload = async (): Promise<Utm | undefined> => {
|
|
28
28
|
const archivist = await UtmStorageArchivist()
|
|
29
|
-
return (await archivist.
|
|
29
|
+
return (await archivist.next()).find(isUtm) as Utm
|
|
30
30
|
}
|