@xyo-network/react-advertising 5.3.15 → 6.1.0

package/dist/browser/index.d.ts

@@ -0,0 +1,51 @@
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { PayloadWithOptionalSources } from '@xyo-network/payload-model';
+import { Utm } from '@xyo-network/advertising-payload-plugins';
+import * as _xyo_network_archivist_model from '@xyo-network/archivist-model';
+import * as _xyo_network_archivist_storage from '@xyo-network/archivist-storage';
+import { StorageArchivist } from '@xyo-network/archivist-storage';
+
+declare const useCaptureUtmLocation: (removeAfterCapture?: boolean) => {
+    utmPayload: _xyo_network_payload_model.Payload<Utm, void> | null;
+    error: Error | undefined;
+};
+
+type PageStateKeys = ReadonlyArray<string>;
+
+/**
+ * Find or create a single instance of the UtmStorageArchivist
+ * @returns Archivist instance
+ */
+declare const UtmStorageArchivist: () => Promise<StorageArchivist<_xyo_network_archivist_storage.StorageArchivistParams, _xyo_network_archivist_model.ArchivistModuleEventData>>;
+declare const LatestUtmPayload: () => Promise<PayloadWithOptionalSources<Utm> | undefined>;
+
+interface DefaultPageStateParams<TQueryParams extends PageStateKeys = PageStateKeys> {
+    queryParams: TQueryParams;
+}
+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
+ */
+declare const useDefaultPageState: <TQueryParams extends PageStateKeys = PageStateKeys>({ queryParams }: DefaultPageStateParams<TQueryParams>) => DefaultPageStateReturn<TQueryParams>;
+
+declare const UtmQueryParamStrings: {
+    readonly utmCampaign: "utm_campaign";
+    readonly utmContent: "utm_content";
+    readonly utmMedium: "utm_medium";
+    readonly utmSource: "utm_source";
+    readonly utmTerm: "utm_term";
+};
+type UtmQueryParams = typeof UtmQueryParamStrings[keyof typeof UtmQueryParamStrings];
+/** Get the default page state for utm values from specific query params */
+declare const useDefaultUtmPageState: () => DefaultPageStateReturn<UtmQueryParams[]>;
+
+export { LatestUtmPayload, UtmQueryParamStrings, UtmStorageArchivist, useCaptureUtmLocation, useDefaultPageState, useDefaultUtmPageState };
+export type { DefaultPageStateParams, DefaultPageStateReturn, PageStateKeys, UtmQueryParams };

package/dist/browser/utm/hooks/UseCaptureUtmLocation.stories.d.ts

@@ -0,0 +1,7 @@
+import type { Meta } from '@storybook/react-vite';
+declare const _default: Meta;
+export default _default;
+declare const Default: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
+declare const WithNoClearAfterCapture: import("storybook/internal/csf").AnnotatedStoryFn<import("@storybook/react-vite").ReactRenderer, import("@storybook/react-vite").Args>;
+export { Default, WithNoClearAfterCapture };
+//# sourceMappingURL=UseCaptureUtmLocation.stories.d.ts.map

package/dist/browser/utm/hooks/UseCaptureUtmLocation.stories.d.ts.map

@@ -0,0 +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,wIAAoB,CAAA;AAGjC,QAAA,MAAM,uBAAuB,wIAAgC,CAAA;AAG7D,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAA"}

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

@@ -0,0 +1,10 @@
+import type { Utm } from '@xyo-network/advertising-payload-plugins';
+import { StorageArchivist } from '@xyo-network/archivist-storage';
+import type { PayloadWithOptionalSources } from '@xyo-network/payload-model';
+/**
+ * Find or create a single instance of the UtmStorageArchivist
+ * @returns Archivist instance
+ */
+export declare const UtmStorageArchivist: () => Promise<StorageArchivist<import("@xyo-network/archivist-storage").StorageArchivistParams, import("@xyo-network/archivist-model").ArchivistModuleEventData>>;
+export declare const LatestUtmPayload: () => Promise<PayloadWithOptionalSources<Utm> | undefined>;
+//# sourceMappingURL=UtmStorageArchivist.d.ts.map

package/dist/{types → browser}/utm/lib/UtmStorageArchivist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UtmStorageArchivist.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/UtmStorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,0CAA0C,CAAA;AAEnE,OAAO,EAAE,gBAAgB,EAAgC,MAAM,gCAAgC,CAAA;AAC/F,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAA;AAM5E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;sMAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,GAAG,SAAS,CAG5F,CAAA"}
+{"version":3,"file":"UtmStorageArchivist.d.ts","sourceRoot":"","sources":["../../../../src/utm/lib/UtmStorageArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,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,mKAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,GAAG,SAAS,CAG5F,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-advertising",
-  "version": "5.3.15",
+  "version": "6.1.0",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -28,30 +28,31 @@
   "exports": {
     ".": {
       "browser": {
-        "types": "./dist/types/index.d.ts",
+        "types": "./dist/browser/index.d.ts",
         "default": "./dist/browser/index.mjs"
       },
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/browser/index.d.ts",
       "default": "./dist/browser/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/browser/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/react-promise": "^6.3.7",
-    "@xyo-network/advertising-payload-plugins": "^3.6.1",
-    "@xyo-network/archivist-storage": "^3.18.10",
-    "@xyo-network/payload-model": "^3.18.10"
+    "@xylabs/react-promise": "^6.3.10",
+    "@xyo-network/advertising-payload-plugins": "^4.0.0",
+    "@xyo-network/archivist-storage": "^4.1.1",
+    "@xyo-network/payload-model": "^4.1.1"
   },
   "devDependencies": {
-    "@mui/material": "^7.1.1",
+    "@mui/material": "^7.2.0",
+    "@storybook/react-vite": "^9.0.16",
     "@types/react": "^19.1.8",
-    "@xylabs/ts-scripts-yarn3": "^6.5.8",
-    "@xylabs/tsconfig-react": "^6.5.8",
+    "@xylabs/ts-scripts-yarn3": "next",
+    "@xylabs/tsconfig-react": "next",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
-    "storybook": "^9.0.12",
+    "storybook": "^9.0.16",
     "typescript": "^5.8.3"
   },
   "peerDependencies": {

package/dist/types/index.d.ts

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

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

@@ -1,19 +0,0 @@
-import type { Utm } from '@xyo-network/advertising-payload-plugins';
-import { StorageArchivist } from '@xyo-network/archivist-storage';
-import type { PayloadWithOptionalSources } from '@xyo-network/payload-model';
-/**
- * Find or create a single instance of the UtmStorageArchivist
- * @returns Archivist instance
- */
-export declare const UtmStorageArchivist: () => Promise<StorageArchivist<import("@xylabs/base").BaseParamsFields & {
-    account?: import("@xyo-network/account-model").AccountInstance | "random";
-    addToResolvers?: boolean;
-    additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
-    allowNameResolution?: boolean;
-    config: import("@xyo-network/module-model").AnyConfigSchema<import("@xyo-network/archivist-storage").StorageArchivistConfig>;
-    ephemeralQueryAccountEnabled?: boolean;
-    moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
-    statusReporter?: import("@xyo-network/module-model").ModuleStatusReporter;
-} & import("@xyo-network/module-model").ModuleChildrenParams & import("@xyo-network/archivist-model").ArchivistParamFields & object, import("@xyo-network/archivist-model").ArchivistModuleEventData>>;
-export declare const LatestUtmPayload: () => Promise<PayloadWithOptionalSources<Utm> | undefined>;
-//# sourceMappingURL=UtmStorageArchivist.d.ts.map