@xyo-network/react-advertising 4.1.5

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,13 @@
+[![logo][]](https://xyo.network)
+
+Part of [@xyo-network/sdk-xyo-react](https://www.npmjs.com/package/@xyo-network/sdk-xyo-react)
+
+## License
+
+> See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/browser/index.d.ts

@@ -0,0 +1,2 @@
+export * from './utm/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}

package/dist/browser/index.mjs

@@ -0,0 +1,131 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/utm/hooks/useCaptureUtmLocation.ts
+import { usePromise } from "@xylabs/react-promise";
+import { UtmSchema } from "@xyo-network/advertising-payload-plugins";
+import { useMemo as useMemo2 } from "react";
+
+// src/utm/lib/UtmStorageArchivist.ts
+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 () => {
+  if (archivist) {
+    return archivist;
+  } else {
+    archivist = await StorageArchivist.create({
+      account: "random",
+      config: {
+        schema: StorageArchivistConfigSchema,
+        namespace: STORAGE_NAME_SPACE,
+        type: "session"
+      }
+    });
+    return archivist;
+  }
+}, "UtmStorageArchivist");
+var LatestUtmPayload = /* @__PURE__ */ __name(async () => {
+  const archivist2 = await UtmStorageArchivist();
+  return (await archivist2.all()).findLast(isUtm);
+}, "LatestUtmPayload");
+
+// src/utm/hooks/useDefaultPageState.ts
+import { useMemo } from "react";
+import { useSearchParams } from "react-router-dom";
+var useDefaultPageState = /* @__PURE__ */ __name(({ queryParams }) => {
+  const [searchParams, setSearchParams] = useSearchParams();
+  const patchDefaultPageState = /* @__PURE__ */ __name((source, key, value) => {
+    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}`);
+      }
+    }
+  }, "patchDefaultPageState");
+  const queryParamsState = useMemo(() => {
+    if (!queryParams) return {};
+    let defaultState = {};
+    for (const [key, value] of searchParams.entries()) {
+      if (queryParams.includes(key)) {
+        defaultState[key] = value;
+      }
+    }
+    return defaultState;
+  }, [
+    searchParams,
+    queryParams
+  ]);
+  return [
+    queryParamsState,
+    patchDefaultPageState
+  ];
+}, "useDefaultPageState");
+
+// src/utm/hooks/useDefaultUtmPageState.ts
+var UtmQueryParamStrings = {
+  utmCampaign: "utm_campaign",
+  utmContent: "utm_content",
+  utmMedium: "utm_medium",
+  utmSource: "utm_source",
+  utmTerm: "utm_term"
+};
+var useDefaultUtmPageState = /* @__PURE__ */ __name(() => useDefaultPageState({
+  queryParams: Object.values(UtmQueryParamStrings)
+}), "useDefaultUtmPageState");
+
+// src/utm/hooks/useCaptureUtmLocation.ts
+var useCaptureUtmLocation = /* @__PURE__ */ __name(() => {
+  const [{ utm_campaign, utm_content, utm_medium, utm_source, utm_term }] = useDefaultUtmPageState();
+  const [sessionStorageArchivist, error] = usePromise(async () => {
+    return await UtmStorageArchivist();
+  }, []);
+  const utmPayload = useMemo2(() => {
+    const utm = {
+      schema: UtmSchema
+    };
+    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;
+  }, [
+    utm_campaign,
+    utm_content,
+    utm_medium,
+    utm_source,
+    utm_term
+  ]);
+  const [, insertError] = usePromise(async () => {
+    if (utmPayload && sessionStorageArchivist) {
+      await sessionStorageArchivist.insert([
+        utmPayload
+      ]);
+    }
+  }, [
+    sessionStorageArchivist,
+    utmPayload
+  ]);
+  return {
+    utmPayload,
+    error: error ?? insertError
+  };
+}, "useCaptureUtmLocation");
+export {
+  LatestUtmPayload,
+  UtmQueryParamStrings,
+  UtmStorageArchivist,
+  useCaptureUtmLocation,
+  useDefaultPageState,
+  useDefaultUtmPageState
+};
+//# sourceMappingURL=index.mjs.map

package/dist/browser/index.mjs.map

@@ -0,0 +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'\n\nimport { UtmStorageArchivist } from '../lib/index.ts'\nimport { useDefaultUtmPageState } from './useDefaultUtmPageState.ts'\n\nexport const useCaptureUtmLocation = () => {\n  const [{\n    utm_campaign, utm_content, utm_medium, utm_source, utm_term,\n  }] = useDefaultUtmPageState()\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    // 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  }, [utm_campaign, utm_content, utm_medium, utm_source, utm_term])\n\n  const [,insertError] = usePromise(async () => {\n    if (utmPayload && sessionStorageArchivist) {\n      await sessionStorageArchivist.insert([utmPayload])\n    }\n  }, [sessionStorageArchivist, utmPayload])\n\n  return { utmPayload, error: error ?? insertError }\n}\n","import { 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 () => {\n  const archivist = await UtmStorageArchivist()\n  return (await archivist.all()).findLast(isUtm)\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;;;ACFxB,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;;;ACzBhC,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;;;AHN/B,IAAMW,wBAAwB,6BAAA;AACnC,QAAM,CAAC,EACLC,cAAcC,aAAaC,YAAYC,YAAYC,SAAQ,CAC5D,IAAIC,uBAAAA;AAEL,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;AAGrC,QAAId,aAAcY,KAAIZ,eAAeA;AACrC,QAAIC,YAAaW,KAAIX,cAAcA;AACnC,QAAIC,WAAYU,KAAIV,aAAaA;AACjC,QAAIC,WAAYS,KAAIT,aAAaA;AACjC,QAAIC,SAAUQ,KAAIR,WAAWA;AAE7B,WAAOQ;EACT,GAAG;IAACZ;IAAcC;IAAaC;IAAYC;IAAYC;GAAS;AAEhE,QAAM,CAAA,EAAEW,WAAAA,IAAeP,WAAW,YAAA;AAChC,QAAIE,cAAcJ,yBAAyB;AACzC,YAAMA,wBAAwBU,OAAO;QAACN;OAAW;IACnD;EACF,GAAG;IAACJ;IAAyBI;GAAW;AAExC,SAAO;IAAEA;IAAYH,OAAOA,SAASQ;EAAY;AACnD,GA9BqC;","names":["usePromise","UtmSchema","useMemo","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","utm_campaign","utm_content","utm_medium","utm_source","utm_term","useDefaultUtmPageState","sessionStorageArchivist","error","usePromise","UtmStorageArchivist","utmPayload","useMemo","utm","schema","UtmSchema","insertError","insert"]}

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

@@ -0,0 +1,4 @@
+export * from './useCaptureUtmLocation.ts';
+export * from './useDefaultPageState.ts';
+export * from './useDefaultUtmPageState.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,0BAA0B,CAAA;AACxC,cAAc,6BAA6B,CAAA"}

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

@@ -0,0 +1,6 @@
+import { type Utm } from '@xyo-network/advertising-payload-plugins';
+export declare const useCaptureUtmLocation: () => {
+    utmPayload: Utm;
+    error: Error | undefined;
+};
+//# sourceMappingURL=useCaptureUtmLocation.d.ts.map

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

@@ -0,0 +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;AAM9E,eAAO,MAAM,qBAAqB;;;CA8BjC,CAAA"}

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

@@ -0,0 +1,10 @@
+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
+];
+export declare const useDefaultPageState: <TQueryParams extends PageStateKeys = PageStateKeys>({ queryParams }: DefaultPageStateParams<TQueryParams>) => DefaultPageStateReturn<TQueryParams>;
+//# sourceMappingURL=useDefaultPageState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useDefaultPageState.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/useDefaultPageState.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAEpD,MAAM,WAAW,sBAAsB,CAAC,YAAY,SAAS,aAAa,GAAG,aAAa;IACxF,WAAW,EAAE,YAAY,CAAA;CAC1B;AAED,MAAM,MAAM,sBAAsB,CAAC,cAAc,SAAS,aAAa,GAAG,aAAa,IAAI;IACzF,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,MAAM,EAAE,MAAM,sBAAsB,EAAE,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI;CAC3F,CAAA;AAUD,eAAO,MAAM,mBAAmB,GAAI,YAAY,SAAS,aAAa,mCACnD,sBAAsB,CAAC,YAAY,CAAC,KACpD,sBAAsB,CAAC,YAAY,CA+BrC,CAAA"}

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

@@ -0,0 +1,10 @@
+export declare const UtmQueryParamStrings: {
+    readonly utmCampaign: "utm_campaign";
+    readonly utmContent: "utm_content";
+    readonly utmMedium: "utm_medium";
+    readonly utmSource: "utm_source";
+    readonly utmTerm: "utm_term";
+};
+export type UtmQueryParams = typeof UtmQueryParamStrings[keyof typeof UtmQueryParamStrings];
+export declare const useDefaultUtmPageState: () => import("./useDefaultPageState.ts").DefaultPageStateReturn<UtmQueryParams[]>;
+//# sourceMappingURL=useDefaultUtmPageState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useDefaultUtmPageState.d.ts","sourceRoot":"","sources":["../../../../src/utm/hooks/useDefaultUtmPageState.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,oBAAoB;;;;;;CAMvB,CAAA;AAEV,MAAM,MAAM,cAAc,GAAG,OAAO,oBAAoB,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAA;AAG3F,eAAO,MAAM,sBAAsB,mFAAoG,CAAA"}

package/dist/browser/utm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './hooks/index.ts';
+export * from './lib/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/utm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utm/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,gBAAgB,CAAA"}

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

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

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

@@ -0,0 +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"}

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

@@ -0,0 +1,30 @@
+import { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage';
+export declare const UtmStorageArchivist: () => Promise<StorageArchivist<import("@xylabs/object").BaseParamsFields & {
+    account?: import("@xyo-network/account-model").AccountInstance | "random";
+    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;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
+}, import("@xyo-network/archivist-model").ArchivistModuleEventData>>;
+export declare const LatestUtmPayload: () => Promise<import("@xyo-network/payload-model").WithMeta<{
+    schema: string;
+} & import("@xyo-network/payload-model").PayloadFields> | undefined>;
+//# sourceMappingURL=UtmStorageArchivist.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UtmStorageArchivist.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/UtmStorageArchivist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAA;AAU/F,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;oEAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB;;oEAG5B,CAAA"}

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

@@ -0,0 +1,3 @@
+export * from './PageStateKeys.ts';
+export * from './UtmStorageArchivist.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,0BAA0B,CAAA"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@xyo-network/react-advertising",
+  "version": "4.1.5",
+  "description": "Common React library for all XYO projects that use React",
+  "keywords": [
+    "xyo",
+    "utility",
+    "typescript",
+    "react"
+  ],
+  "homepage": "https://xyo.network",
+  "bugs": {
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-react-js/issues",
+    "email": "support@xyo.network"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-react-js.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XYO Development Team",
+    "email": "support@xyo.network",
+    "url": "https://xyo.network"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "browser": {
+        "types": "./dist/browser/index.d.ts",
+        "default": "./dist/browser/index.mjs"
+      },
+      "types": "./dist/browser/index.d.ts",
+      "default": "./dist/browser/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "dist/browser/index.mjs",
+  "types": "dist/browser/index.d.ts",
+  "scripts": {
+    "license": "yarn license-checker --exclude \"MIT, ISC, Apache-2.0, BSD, BSD-2-Clause, CC-BY-4.0, Unlicense, CC-BY-3.0, CC0-1.0\"",
+    "lint-pkg": "npmPkgJsonLint ."
+  },
+  "dependencies": {
+    "@xylabs/react-promise": "^5.2.2",
+    "@xyo-network/advertising-payload-plugins": "^3.1.1",
+    "@xyo-network/archivist-storage": "^3.3.0"
+  },
+  "devDependencies": {
+    "@mui/material": "^6.1.4",
+    "@storybook/react": "^8.3.6",
+    "@xylabs/ts-scripts-yarn3": "^4.2.1",
+    "@xylabs/tsconfig-react": "^4.2.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "storybook": "^8.3.6",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "react": "^18",
+    "react-dom": "^18",
+    "react-router-dom": "^6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "docs": "dist/docs.json"
+}

package/src/index.ts

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

package/src/types/images.d.ts

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

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

@@ -0,0 +1,54 @@
+import { Box } from '@mui/material'
+import type { Meta, StoryFn } from '@storybook/react'
+import { usePromise } from '@xylabs/react-promise'
+import type { PropsWithChildren } from 'react'
+import React, { useEffect } from 'react'
+import { BrowserRouter, useSearchParams } from 'react-router-dom'
+
+import { 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(() => {
+    setParams(() => {
+      const newParams = new URLSearchParams()
+      newParams.set('utm_campaign', 'test-campaign')
+      newParams.set('utm_content', 'test-content')
+      return newParams
+    })
+  }, [])
+
+  return children
+}
+
+const RouterDecorator = (Story: StoryFn) => (
+  <BrowserRouter>
+    <UtmStub>
+      <Story />
+    </UtmStub>
+  </BrowserRouter>
+)
+
+const Template: StoryFn = () => {
+  useCaptureUtmLocation()
+
+  const [payloads] = usePromise(async () => {
+    const archivist = await UtmStorageArchivist()
+    return await archivist.all()
+  }, [])
+
+  return (
+    <Box>
+      {payloads?.map(payload => <Box key={payload.$hash}>{JSON.stringify(payload, null, 2)}</Box>)}
+    </Box>
+  )
+}
+
+const Default = Template.bind({})
+Default.decorators = [RouterDecorator]
+
+export { Default }

package/src/utm/hooks/index.ts

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

package/src/utm/hooks/useCaptureUtmLocation.ts

@@ -0,0 +1,38 @@
+import { usePromise } from '@xylabs/react-promise'
+import { type Utm, UtmSchema } from '@xyo-network/advertising-payload-plugins'
+import { useMemo } from 'react'
+
+import { UtmStorageArchivist } from '../lib/index.ts'
+import { useDefaultUtmPageState } from './useDefaultUtmPageState.ts'
+
+export const useCaptureUtmLocation = () => {
+  const [{
+    utm_campaign, utm_content, utm_medium, utm_source, utm_term,
+  }] = useDefaultUtmPageState()
+
+  const [sessionStorageArchivist, error] = usePromise(async () => {
+    return await UtmStorageArchivist()
+  }, [])
+
+  const utmPayload = useMemo(() => {
+    // Construct the base UTM payload
+    const utm: Utm = { schema: UtmSchema }
+
+    // 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
+  }, [utm_campaign, utm_content, utm_medium, utm_source, utm_term])
+
+  const [,insertError] = usePromise(async () => {
+    if (utmPayload && sessionStorageArchivist) {
+      await sessionStorageArchivist.insert([utmPayload])
+    }
+  }, [sessionStorageArchivist, utmPayload])
+
+  return { utmPayload, error: error ?? insertError }
+}

package/src/utm/hooks/useDefaultPageState.ts

@@ -0,0 +1,56 @@
+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

@@ -0,0 +1,14 @@
+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

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

package/src/utm/lib/PageStateKeys.ts

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

package/src/utm/lib/UtmStorageArchivist.ts

@@ -0,0 +1,29 @@
+import { isUtm } from '@xyo-network/advertising-payload-plugins'
+import { StorageArchivist, StorageArchivistConfigSchema } from '@xyo-network/archivist-storage'
+
+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',
+      },
+    })
+    return archivist
+  }
+}
+
+export const LatestUtmPayload = async () => {
+  const archivist = await UtmStorageArchivist()
+  return (await archivist.all()).findLast(isUtm)
+}

package/src/utm/lib/index.ts

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

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}

package/xy.config.ts

@@ -0,0 +1,10 @@
+import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: { src: true },
+    node: {},
+    neutral: {},
+  },
+}
+
+export default config