@xyo-network/react-advertising 6.2.0 → 7.0.1
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 +25 -47
- package/dist/browser/index.mjs.map +1 -1
- package/dist/browser/utm/hooks/UseCaptureUtmLocation.stories.d.ts +2 -2
- package/dist/browser/utm/hooks/UseCaptureUtmLocation.stories.d.ts.map +1 -1
- package/dist/browser/utm/lib/UtmStorageArchivist.d.ts +1 -1
- package/dist/browser/utm/lib/UtmStorageArchivist.d.ts.map +1 -1
- package/package.json +24 -17
- package/typedoc.json +0 -5
- package/xy.config.ts +0 -10
package/dist/browser/index.mjs
CHANGED
|
@@ -1,6 +1,3 @@
|
|
|
1
|
-
var __defProp = Object.defineProperty;
|
|
2
|
-
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
3
|
-
|
|
4
1
|
// src/utm/hooks/useCaptureUtmLocation.ts
|
|
5
2
|
import { usePromise } from "@xylabs/react-promise";
|
|
6
3
|
import { UtmSchema } from "@xyo-network/advertising-payload-plugins";
|
|
@@ -12,7 +9,7 @@ import { isUtm } from "@xyo-network/advertising-payload-plugins";
|
|
|
12
9
|
import { StorageArchivist, StorageArchivistConfigSchema } from "@xyo-network/archivist-storage";
|
|
13
10
|
var STORAGE_NAME_SPACE = "utm";
|
|
14
11
|
var archivist;
|
|
15
|
-
var UtmStorageArchivist =
|
|
12
|
+
var UtmStorageArchivist = async () => {
|
|
16
13
|
if (archivist) {
|
|
17
14
|
return archivist;
|
|
18
15
|
} else {
|
|
@@ -26,18 +23,18 @@ var UtmStorageArchivist = /* @__PURE__ */ __name(async () => {
|
|
|
26
23
|
});
|
|
27
24
|
return archivist;
|
|
28
25
|
}
|
|
29
|
-
}
|
|
30
|
-
var LatestUtmPayload =
|
|
26
|
+
};
|
|
27
|
+
var LatestUtmPayload = async () => {
|
|
31
28
|
const archivist2 = await UtmStorageArchivist();
|
|
32
29
|
return (await archivist2.next()).find(isUtm);
|
|
33
|
-
}
|
|
30
|
+
};
|
|
34
31
|
|
|
35
32
|
// src/utm/hooks/useDefaultPageState.ts
|
|
36
33
|
import { useMemo } from "react";
|
|
37
34
|
import { useSearchParams } from "react-router-dom";
|
|
38
|
-
var useDefaultPageState =
|
|
35
|
+
var useDefaultPageState = ({ queryParams }) => {
|
|
39
36
|
const [searchParams, setSearchParams] = useSearchParams();
|
|
40
|
-
const patchDefaultPageState =
|
|
37
|
+
const patchDefaultPageState = (source, key, value) => {
|
|
41
38
|
switch (source) {
|
|
42
39
|
case "queryParams": {
|
|
43
40
|
setSearchParams((prevSearchParams) => {
|
|
@@ -51,7 +48,7 @@ var useDefaultPageState = /* @__PURE__ */ __name(({ queryParams }) => {
|
|
|
51
48
|
throw new Error(`Invalid source for default page state: ${source}`);
|
|
52
49
|
}
|
|
53
50
|
}
|
|
54
|
-
}
|
|
51
|
+
};
|
|
55
52
|
const queryParamsState = useMemo(() => {
|
|
56
53
|
if (!queryParams) return {};
|
|
57
54
|
let defaultState = {};
|
|
@@ -61,15 +58,9 @@ var useDefaultPageState = /* @__PURE__ */ __name(({ queryParams }) => {
|
|
|
61
58
|
}
|
|
62
59
|
}
|
|
63
60
|
return defaultState;
|
|
64
|
-
}, [
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
]);
|
|
68
|
-
return [
|
|
69
|
-
queryParamsState,
|
|
70
|
-
patchDefaultPageState
|
|
71
|
-
];
|
|
72
|
-
}, "useDefaultPageState");
|
|
61
|
+
}, [searchParams, queryParams]);
|
|
62
|
+
return [queryParamsState, patchDefaultPageState];
|
|
63
|
+
};
|
|
73
64
|
|
|
74
65
|
// src/utm/hooks/useDefaultUtmPageState.ts
|
|
75
66
|
var UtmQueryParamStrings = {
|
|
@@ -79,21 +70,23 @@ var UtmQueryParamStrings = {
|
|
|
79
70
|
utmSource: "utm_source",
|
|
80
71
|
utmTerm: "utm_term"
|
|
81
72
|
};
|
|
82
|
-
var useDefaultUtmPageState =
|
|
83
|
-
queryParams: Object.values(UtmQueryParamStrings)
|
|
84
|
-
}), "useDefaultUtmPageState");
|
|
73
|
+
var useDefaultUtmPageState = () => useDefaultPageState({ queryParams: Object.values(UtmQueryParamStrings) });
|
|
85
74
|
|
|
86
75
|
// src/utm/hooks/useCaptureUtmLocation.ts
|
|
87
|
-
var useCaptureUtmLocation =
|
|
88
|
-
const [{
|
|
76
|
+
var useCaptureUtmLocation = (removeAfterCapture = true) => {
|
|
77
|
+
const [{
|
|
78
|
+
utm_campaign,
|
|
79
|
+
utm_content,
|
|
80
|
+
utm_medium,
|
|
81
|
+
utm_source,
|
|
82
|
+
utm_term
|
|
83
|
+
}] = useDefaultUtmPageState();
|
|
89
84
|
const [, setSearchParams] = useSearchParams2();
|
|
90
85
|
const [sessionStorageArchivist, error] = usePromise(async () => {
|
|
91
86
|
return await UtmStorageArchivist();
|
|
92
87
|
}, []);
|
|
93
88
|
const utmPayload = useMemo2(() => {
|
|
94
|
-
const utm = {
|
|
95
|
-
schema: UtmSchema
|
|
96
|
-
};
|
|
89
|
+
const utm = { schema: UtmSchema };
|
|
97
90
|
const utmParams = {
|
|
98
91
|
utm_campaign,
|
|
99
92
|
utm_content,
|
|
@@ -114,19 +107,11 @@ var useCaptureUtmLocation = /* @__PURE__ */ __name((removeAfterCapture = true) =
|
|
|
114
107
|
} else {
|
|
115
108
|
return null;
|
|
116
109
|
}
|
|
117
|
-
}, [
|
|
118
|
-
utm_campaign,
|
|
119
|
-
utm_content,
|
|
120
|
-
utm_medium,
|
|
121
|
-
utm_source,
|
|
122
|
-
utm_term
|
|
123
|
-
]);
|
|
110
|
+
}, [utm_campaign, utm_content, utm_medium, utm_source, utm_term]);
|
|
124
111
|
const [, insertError] = usePromise(async () => {
|
|
125
112
|
if (utmPayload && sessionStorageArchivist) {
|
|
126
113
|
await sessionStorageArchivist.clear();
|
|
127
|
-
await sessionStorageArchivist.insert([
|
|
128
|
-
utmPayload
|
|
129
|
-
]);
|
|
114
|
+
await sessionStorageArchivist.insert([utmPayload]);
|
|
130
115
|
if (removeAfterCapture) {
|
|
131
116
|
setSearchParams(() => {
|
|
132
117
|
const newParams = new URLSearchParams();
|
|
@@ -137,16 +122,9 @@ var useCaptureUtmLocation = /* @__PURE__ */ __name((removeAfterCapture = true) =
|
|
|
137
122
|
});
|
|
138
123
|
}
|
|
139
124
|
}
|
|
140
|
-
}, [
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
removeAfterCapture
|
|
144
|
-
]);
|
|
145
|
-
return {
|
|
146
|
-
utmPayload,
|
|
147
|
-
error: error ?? insertError
|
|
148
|
-
};
|
|
149
|
-
}, "useCaptureUtmLocation");
|
|
125
|
+
}, [sessionStorageArchivist, utmPayload, removeAfterCapture]);
|
|
126
|
+
return { utmPayload, error: error ?? insertError };
|
|
127
|
+
};
|
|
150
128
|
export {
|
|
151
129
|
LatestUtmPayload,
|
|
152
130
|
UtmQueryParamStrings,
|
|
@@ -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 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"]}
|
|
1
|
+
{"version":3,"sources":["../../src/utm/hooks/useCaptureUtmLocation.ts","../../src/utm/lib/UtmStorageArchivist.ts","../../src/utm/hooks/useDefaultPageState.ts","../../src/utm/hooks/useDefaultUtmPageState.ts"],"sourcesContent":["import { usePromise } from '@xylabs/react-promise'\nimport { type Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'\nimport type { PayloadWithOptionalSources } from '@xyo-network/payload-model'\nimport { useMemo } from 'react'\nimport { useSearchParams } from 'react-router-dom'\n\nimport { UtmStorageArchivist } from '../lib/index.ts'\nimport { useDefaultUtmPageState, UtmQueryParamStrings } from './useDefaultUtmPageState.ts'\n\nexport const useCaptureUtmLocation = (removeAfterCapture = true) => {\n const [{\n utm_campaign, utm_content, utm_medium, utm_source, utm_term,\n }] = useDefaultUtmPageState()\n const [,setSearchParams] = useSearchParams()\n\n const [sessionStorageArchivist, error] = usePromise(async () => {\n return await UtmStorageArchivist()\n }, [])\n\n const utmPayload = useMemo(() => {\n // Construct the base UTM payload\n const utm: PayloadWithOptionalSources<Utm> = { schema: UtmSchema }\n\n // determine if there's a utm field that still has a value\n // if there is none, it means that either the page loaded\n // with none or they've already been captured\n const utmParams = {\n utm_campaign, utm_content, utm_medium, utm_source, utm_term,\n }\n const foundUpdatedUtmParams = Object.entries(utmParams).some(([key, value]) => {\n return key.includes('utm_') && value\n })\n\n if (foundUpdatedUtmParams) {\n // Conditionally add all the UTM parameters present\n if (utm_campaign) utm.utm_campaign = utm_campaign\n if (utm_content) utm.utm_content = utm_content\n if (utm_medium) utm.utm_medium = utm_medium\n if (utm_source) utm.utm_source = utm_source\n if (utm_term) utm.utm_term = utm_term\n\n return utm\n } else {\n return null\n }\n }, [utm_campaign, utm_content, utm_medium, utm_source, utm_term])\n\n const [,insertError] = usePromise(async () => {\n if (utmPayload && sessionStorageArchivist) {\n // clear all previous utm payloads\n await sessionStorageArchivist.clear()\n // insert params into session storage\n await sessionStorageArchivist.insert([utmPayload])\n\n if (removeAfterCapture) {\n // remove the utm params from the URL\n setSearchParams(() => {\n const newParams = new URLSearchParams()\n for (const value of Object.values(UtmQueryParamStrings)) {\n newParams.delete(value)\n }\n return newParams\n })\n }\n }\n }, [sessionStorageArchivist, utmPayload, removeAfterCapture])\n\n return { utmPayload, error: error ?? insertError }\n}\n","import type { Utm } from '@xyo-network/advertising-payload-plugins'\nimport { isUtm } from '@xyo-network/advertising-payload-plugins'\nimport { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage'\nimport type { PayloadWithOptionalSources } from '@xyo-network/payload-model'\n\nconst STORAGE_NAME_SPACE = 'utm' as const\n\nlet archivist: StorageArchivist | undefined\n\n/**\n * Find or create a single instance of the UtmStorageArchivist\n * @returns Archivist instance\n */\nexport const UtmStorageArchivist = async () => {\n if (archivist) {\n return archivist\n } else {\n archivist = await StorageArchivist.create({\n account: 'random',\n config: {\n schema: StorageArchivistConfigSchema, namespace: STORAGE_NAME_SPACE, type: 'session',\n },\n })\n return archivist\n }\n}\n\nexport const LatestUtmPayload = async (): Promise<PayloadWithOptionalSources<Utm> | undefined> => {\n const archivist = await UtmStorageArchivist()\n return (await archivist.next()).find(isUtm) as PayloadWithOptionalSources<Utm>\n}\n","import { useMemo } from 'react'\nimport { useSearchParams } from 'react-router-dom'\n\nimport type { PageStateKeys } from '../lib/index.ts'\n\nexport interface DefaultPageStateParams<TQueryParams extends PageStateKeys = PageStateKeys> {\n queryParams: TQueryParams\n}\n\nexport type DefaultPageStateReturn<TPageStateKeys extends PageStateKeys = PageStateKeys> = [\n Record<TPageStateKeys[number], string>,\n (source: keyof DefaultPageStateParams, key: TPageStateKeys[number], value: string) => void,\n]\n\n/**\n * Hook to get default page state as key value pairs from various sources. It provides a convenient abstraction over free form\n * page state like query params by narrowing the used params and centralizing their logic.\n *\n * Future work could include adding support for localStorage, sessionStorage, and precedence of sources.\n * @param defaultPageStateParams various sources of default page state (i.e. queryParams, localStorage, etc.)\n * @returns\n */\nexport const useDefaultPageState = <TQueryParams extends PageStateKeys = PageStateKeys>(\n { queryParams }: DefaultPageStateParams<TQueryParams>,\n): DefaultPageStateReturn<TQueryParams> => {\n const [searchParams, setSearchParams] = useSearchParams()\n\n const patchDefaultPageState = (source: keyof DefaultPageStateParams, key: TQueryParams[number], value: string) => {\n switch (source) {\n case 'queryParams': {\n setSearchParams((prevSearchParams) => {\n const newSearchParams = new URLSearchParams(prevSearchParams)\n newSearchParams.set(key, value)\n return newSearchParams\n })\n break\n }\n default: {\n throw new Error(`Invalid source for default page state: ${source}`)\n }\n }\n }\n\n const queryParamsState = useMemo(() => {\n if (!queryParams) return {} as Record<TQueryParams[number], string>\n let defaultState = {} as Record<TQueryParams[number], string>\n for (const [key, value] of searchParams.entries()) {\n if (queryParams.includes(key)) {\n defaultState[key as TQueryParams[number]] = value\n }\n }\n return defaultState\n }, [searchParams, queryParams])\n\n return [queryParamsState, patchDefaultPageState]\n}\n","import { useDefaultPageState } from './useDefaultPageState.ts'\n\nexport const UtmQueryParamStrings = {\n utmCampaign: 'utm_campaign',\n utmContent: 'utm_content',\n utmMedium: 'utm_medium',\n utmSource: 'utm_source',\n utmTerm: 'utm_term',\n} as const\n\nexport type UtmQueryParams = typeof UtmQueryParamStrings[keyof typeof UtmQueryParamStrings]\n\n/** Get the default page state for utm values from specific query params */\nexport const useDefaultUtmPageState = () => useDefaultPageState<UtmQueryParams[]>({ queryParams: Object.values(UtmQueryParamStrings) })\n"],"mappings":";AAAA,SAAS,kBAAkB;AAC3B,SAAmB,iBAAiB;AAEpC,SAAS,WAAAA,gBAAe;AACxB,SAAS,mBAAAC,wBAAuB;;;ACHhC,SAAS,aAAa;AACtB,SAAS,kBAAkB,oCAAoC;AAG/D,IAAM,qBAAqB;AAE3B,IAAI;AAMG,IAAM,sBAAsB,YAAY;AAC7C,MAAI,WAAW;AACb,WAAO;AAAA,EACT,OAAO;AACL,gBAAY,MAAM,iBAAiB,OAAO;AAAA,MACxC,SAAS;AAAA,MACT,QAAQ;AAAA,QACN,QAAQ;AAAA,QAA8B,WAAW;AAAA,QAAoB,MAAM;AAAA,MAC7E;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAEO,IAAM,mBAAmB,YAAkE;AAChG,QAAMC,aAAY,MAAM,oBAAoB;AAC5C,UAAQ,MAAMA,WAAU,KAAK,GAAG,KAAK,KAAK;AAC5C;;;AC9BA,SAAS,eAAe;AACxB,SAAS,uBAAuB;AAqBzB,IAAM,sBAAsB,CACjC,EAAE,YAAY,MAC2B;AACzC,QAAM,CAAC,cAAc,eAAe,IAAI,gBAAgB;AAExD,QAAM,wBAAwB,CAAC,QAAsC,KAA2B,UAAkB;AAChH,YAAQ,QAAQ;AAAA,MACd,KAAK,eAAe;AAClB,wBAAgB,CAAC,qBAAqB;AACpC,gBAAM,kBAAkB,IAAI,gBAAgB,gBAAgB;AAC5D,0BAAgB,IAAI,KAAK,KAAK;AAC9B,iBAAO;AAAA,QACT,CAAC;AACD;AAAA,MACF;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,0CAA0C,MAAM,EAAE;AAAA,MACpE;AAAA,IACF;AAAA,EACF;AAEA,QAAM,mBAAmB,QAAQ,MAAM;AACrC,QAAI,CAAC,YAAa,QAAO,CAAC;AAC1B,QAAI,eAAe,CAAC;AACpB,eAAW,CAAC,KAAK,KAAK,KAAK,aAAa,QAAQ,GAAG;AACjD,UAAI,YAAY,SAAS,GAAG,GAAG;AAC7B,qBAAa,GAA2B,IAAI;AAAA,MAC9C;AAAA,IACF;AACA,WAAO;AAAA,EACT,GAAG,CAAC,cAAc,WAAW,CAAC;AAE9B,SAAO,CAAC,kBAAkB,qBAAqB;AACjD;;;ACrDO,IAAM,uBAAuB;AAAA,EAClC,aAAa;AAAA,EACb,YAAY;AAAA,EACZ,WAAW;AAAA,EACX,WAAW;AAAA,EACX,SAAS;AACX;AAKO,IAAM,yBAAyB,MAAM,oBAAsC,EAAE,aAAa,OAAO,OAAO,oBAAoB,EAAE,CAAC;;;AHJ/H,IAAM,wBAAwB,CAAC,qBAAqB,SAAS;AAClE,QAAM,CAAC;AAAA,IACL;AAAA,IAAc;AAAA,IAAa;AAAA,IAAY;AAAA,IAAY;AAAA,EACrD,CAAC,IAAI,uBAAuB;AAC5B,QAAM,CAAC,EAAC,eAAe,IAAIC,iBAAgB;AAE3C,QAAM,CAAC,yBAAyB,KAAK,IAAI,WAAW,YAAY;AAC9D,WAAO,MAAM,oBAAoB;AAAA,EACnC,GAAG,CAAC,CAAC;AAEL,QAAM,aAAaC,SAAQ,MAAM;AAE/B,UAAM,MAAuC,EAAE,QAAQ,UAAU;AAKjE,UAAM,YAAY;AAAA,MAChB;AAAA,MAAc;AAAA,MAAa;AAAA,MAAY;AAAA,MAAY;AAAA,IACrD;AACA,UAAM,wBAAwB,OAAO,QAAQ,SAAS,EAAE,KAAK,CAAC,CAAC,KAAK,KAAK,MAAM;AAC7E,aAAO,IAAI,SAAS,MAAM,KAAK;AAAA,IACjC,CAAC;AAED,QAAI,uBAAuB;AAEzB,UAAI,aAAc,KAAI,eAAe;AACrC,UAAI,YAAa,KAAI,cAAc;AACnC,UAAI,WAAY,KAAI,aAAa;AACjC,UAAI,WAAY,KAAI,aAAa;AACjC,UAAI,SAAU,KAAI,WAAW;AAE7B,aAAO;AAAA,IACT,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,GAAG,CAAC,cAAc,aAAa,YAAY,YAAY,QAAQ,CAAC;AAEhE,QAAM,CAAC,EAAC,WAAW,IAAI,WAAW,YAAY;AAC5C,QAAI,cAAc,yBAAyB;AAEzC,YAAM,wBAAwB,MAAM;AAEpC,YAAM,wBAAwB,OAAO,CAAC,UAAU,CAAC;AAEjD,UAAI,oBAAoB;AAEtB,wBAAgB,MAAM;AACpB,gBAAM,YAAY,IAAI,gBAAgB;AACtC,qBAAW,SAAS,OAAO,OAAO,oBAAoB,GAAG;AACvD,sBAAU,OAAO,KAAK;AAAA,UACxB;AACA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF,GAAG,CAAC,yBAAyB,YAAY,kBAAkB,CAAC;AAE5D,SAAO,EAAE,YAAY,OAAO,SAAS,YAAY;AACnD;","names":["useMemo","useSearchParams","archivist","useSearchParams","useMemo"]}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Meta } from '@storybook/react-vite';
|
|
2
2
|
declare const _default: Meta;
|
|
3
3
|
export default _default;
|
|
4
|
-
declare const Default: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
|
|
5
|
-
declare const WithNoClearAfterCapture: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
|
|
4
|
+
declare const Default: import(".store/storybook-virtual-997ab3c959/package/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
|
|
5
|
+
declare const WithNoClearAfterCapture: import(".store/storybook-virtual-997ab3c959/package/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
|
|
6
6
|
export { Default, WithNoClearAfterCapture };
|
|
7
7
|
//# sourceMappingURL=UseCaptureUtmLocation.stories.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UseCaptureUtmLocation.stories.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/UseCaptureUtmLocation.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,uBAAuB,CAAA;wBASO,IAAI;AAArE,wBAAqE;AAkErE,QAAA,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"UseCaptureUtmLocation.stories.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/UseCaptureUtmLocation.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,uBAAuB,CAAA;wBASO,IAAI;AAArE,wBAAqE;AAkErE,QAAA,MAAM,OAAO,0KAAoB,CAAA;AAGjC,QAAA,MAAM,uBAAuB,0KAAgC,CAAA;AAG7D,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAA"}
|
|
@@ -5,6 +5,6 @@ import type { PayloadWithOptionalSources } from '@xyo-network/payload-model';
|
|
|
5
5
|
* Find or create a single instance of the UtmStorageArchivist
|
|
6
6
|
* @returns Archivist instance
|
|
7
7
|
*/
|
|
8
|
-
export declare const UtmStorageArchivist: () => Promise<StorageArchivist<import("@xyo-network/archivist-storage").StorageArchivistParams, import("
|
|
8
|
+
export declare const UtmStorageArchivist: () => Promise<StorageArchivist<import("@xyo-network/archivist-storage").StorageArchivistParams, import(".store/@xyo-network-archivist-model-npm-5.0.5-ae2431c26f/package").ArchivistModuleEventData>>;
|
|
9
9
|
export declare const LatestUtmPayload: () => Promise<PayloadWithOptionalSources<Utm> | undefined>;
|
|
10
10
|
//# sourceMappingURL=UtmStorageArchivist.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UtmStorageArchivist.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/UtmStorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,0CAA0C,CAAA;AAEnE,OAAO,EAAE,gBAAgB,EAAgC,MAAM,gCAAgC,CAAA;AAC/F,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AAM5E;;;GAGG;AACH,eAAO,MAAM,mBAAmB,
|
|
1
|
+
{"version":3,"file":"UtmStorageArchivist.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/UtmStorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,0CAA0C,CAAA;AAEnE,OAAO,EAAE,gBAAgB,EAAgC,MAAM,gCAAgC,CAAA;AAC/F,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AAM5E;;;GAGG;AACH,eAAO,MAAM,mBAAmB,uMAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,GAAG,SAAS,CAG5F,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/react-advertising",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "7.0.1",
|
|
4
4
|
"description": "Common React library for all XYO projects that use React",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"xyo",
|
|
@@ -38,27 +38,34 @@
|
|
|
38
38
|
},
|
|
39
39
|
"module": "dist/browser/index.mjs",
|
|
40
40
|
"types": "dist/browser/index.d.ts",
|
|
41
|
+
"files": [
|
|
42
|
+
"dist",
|
|
43
|
+
"src"
|
|
44
|
+
],
|
|
41
45
|
"dependencies": {
|
|
42
|
-
"@xylabs/react-promise": "
|
|
43
|
-
"@xyo-network/advertising-payload-plugins": "
|
|
44
|
-
"@xyo-network/archivist-storage": "
|
|
45
|
-
"@xyo-network/payload-model": "
|
|
46
|
+
"@xylabs/react-promise": "~7.0.1",
|
|
47
|
+
"@xyo-network/advertising-payload-plugins": "~5.0.1",
|
|
48
|
+
"@xyo-network/archivist-storage": "~5.0.5",
|
|
49
|
+
"@xyo-network/payload-model": "~5.0.5"
|
|
46
50
|
},
|
|
47
51
|
"devDependencies": {
|
|
48
|
-
"@mui/material": "
|
|
49
|
-
"@storybook/react-vite": "
|
|
50
|
-
"@types/react": "
|
|
51
|
-
"@xylabs/ts-scripts-yarn3": "
|
|
52
|
-
"@xylabs/tsconfig
|
|
53
|
-
"
|
|
54
|
-
"react
|
|
55
|
-
"
|
|
56
|
-
"
|
|
52
|
+
"@mui/material": "~7.3.1",
|
|
53
|
+
"@storybook/react-vite": "~9.1.2",
|
|
54
|
+
"@types/react": "~19.1.10",
|
|
55
|
+
"@xylabs/ts-scripts-yarn3": "~7.1.1",
|
|
56
|
+
"@xylabs/tsconfig": "~7.1.1",
|
|
57
|
+
"@xylabs/tsconfig-dom": "~7.1.1",
|
|
58
|
+
"@xylabs/tsconfig-react": "~7.1.1",
|
|
59
|
+
"react": "~19.1.1",
|
|
60
|
+
"react-dom": "~19.1.1",
|
|
61
|
+
"storybook": "~9.1.2",
|
|
62
|
+
"typescript": "~5.9.2",
|
|
63
|
+
"vite": "~7.1.2"
|
|
57
64
|
},
|
|
58
65
|
"peerDependencies": {
|
|
59
|
-
"react": "
|
|
60
|
-
"react-dom": "
|
|
61
|
-
"react-router-dom": "
|
|
66
|
+
"react": "~19",
|
|
67
|
+
"react-dom": "~19",
|
|
68
|
+
"react-router-dom": "~7"
|
|
62
69
|
},
|
|
63
70
|
"publishConfig": {
|
|
64
71
|
"access": "public"
|
package/typedoc.json
DELETED