@xyo-network/react-advertising 4.4.9 → 4.4.11

package/dist/browser/index.d.ts

@@ -1,50 +1,2 @@
-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_module_model from '@xyo-network/module-model';
-import * as _xyo_network_archivist_storage from '@xyo-network/archivist-storage';
-import { StorageArchivist } from '@xyo-network/archivist-storage';
-import * as _xyo_network_account_model from '@xyo-network/account-model';
-import * as _xylabs_object from '@xylabs/object';
-
-declare const useCaptureUtmLocation: (removeAfterCapture?: boolean) => {
-    utmPayload: _xyo_network_payload_model.Payload<Utm, void> | null;
-    error: Error | undefined;
-};
-
-type PageStateKeys = ReadonlyArray<string>;
-
-declare const UtmStorageArchivist: () => Promise<StorageArchivist<_xylabs_object.BaseParamsFields & {
-    account?: _xyo_network_account_model.AccountInstance | "random";
-    addToResolvers?: boolean;
-    additionalSigners?: _xyo_network_account_model.AccountInstance[];
-    allowNameResolution?: boolean;
-    config: _xyo_network_module_model.AnyConfigSchema<_xyo_network_archivist_storage.StorageArchivistConfig>;
-    ephemeralQueryAccountEnabled?: boolean;
-    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
-    privateChildren?: _xyo_network_module_model.ModuleInstance[];
-    publicChildren?: _xyo_network_module_model.ModuleInstance[];
-} & _xyo_network_archivist_model.ArchivistParamFields & object, _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
-];
-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];
-declare const useDefaultUtmPageState: () => DefaultPageStateReturn<UtmQueryParams[]>;
-
-export { type DefaultPageStateParams, type DefaultPageStateReturn, LatestUtmPayload, type PageStateKeys, UtmQueryParamStrings, type UtmQueryParams, UtmStorageArchivist, useCaptureUtmLocation, useDefaultPageState, useDefaultUtmPageState };
+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/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: (removeAfterCapture?: boolean) => {
+    utmPayload: import("@xyo-network/payload-model").Payload<Utm, void> | null;
+    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;AAQ9E,eAAO,MAAM,qBAAqB,GAAI,4BAAyB;;;CA2D9D,CAAA"}

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

@@ -0,0 +1,18 @@
+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 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;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAAI,YAAY,SAAS,aAAa,GAAG,aAAa,EACpF,iBAAiB,sBAAsB,CAAC,YAAY,CAAC,KACpD,sBAAsB,CAAC,YAAY,CA+BrC,CAAA"}

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

@@ -0,0 +1,11 @@
+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];
+/** Get the default page state for utm values from specific query params */
+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;AAE3F,2EAA2E;AAC3E,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,20 @@
+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/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/module-model").AnyConfigSchema<import("@xyo-network/archivist-storage").StorageArchivistConfig>;
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
+    privateChildren?: import("@xyo-network/module-model").ModuleInstance[];
+    publicChildren?: import("@xyo-network/module-model").ModuleInstance[];
+} & 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

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":"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;;;;;;;;;;2IAY/B,CAAA;AAED,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,GAAG,SAAS,CAG5F,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

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-advertising",
-  "version": "4.4.9",
+  "version": "4.4.11",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -43,20 +43,20 @@
     "lint-pkg": "npmPkgJsonLint ."
   },
   "dependencies": {
-    "@xylabs/react-promise": "^5.3.23",
-    "@xyo-network/advertising-payload-plugins": "^3.4.2",
-    "@xyo-network/archivist-storage": "^3.9.17",
-    "@xyo-network/payload-model": "^3.9.17"
+    "@xylabs/react-promise": "^5.3.25",
+    "@xyo-network/advertising-payload-plugins": "^3.4.3",
+    "@xyo-network/archivist-storage": "^3.9.25",
+    "@xyo-network/payload-model": "^3.9.25"
   },
   "devDependencies": {
     "@mui/material": "^6.4.6",
-    "@storybook/react": "^8.6.2",
-    "@xylabs/ts-scripts-yarn3": "^5.0.25",
-    "@xylabs/tsconfig-react": "^5.0.25",
+    "@storybook/react": "^8.6.3",
+    "@xylabs/ts-scripts-yarn3": "^5.0.39",
+    "@xylabs/tsconfig-react": "^5.0.39",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "storybook": "^8.6.2",
-    "typescript": "^5.7.3"
+    "storybook": "^8.6.3",
+    "typescript": "^5.8.2"
   },
   "peerDependencies": {
     "react": "^18",