@metamask-previews/analytics-controller 2.0.0-preview-0d04fb622 → 2.0.0-preview-6b7c25c

package/dist/EventFragment.types.d.cts

@@ -1,88 +0,0 @@
-import type { AnalyticsContext, AnalyticsEventProperties } from "./AnalyticsPlatformAdapter.types.cjs";
-/**
- * A bag of analytics properties that accumulates across a user journey.
- *
- * A fragment lets several parts of a client contribute properties to the same
- * logical journey (a signature request, a transaction confirmation) without
- * having to re-derive them for every event, and lets the journey be closed as
- * a success or a failure.
- *
- * All three event names are optional. A fragment that declares none of them
- * never emits anything and acts purely as a property bag that the client reads
- * back with {@link AnalyticsController.getEventFragmentById} at the moment it
- * emits its own event.
- */
-export type AnalyticsEventFragment = {
-    /**
-     * The fragment identifier, unique per client.
-     */
-    id: string;
-    /**
-     * Properties tracked with every event this fragment emits.
-     */
-    properties: AnalyticsEventProperties;
-    /**
-     * Properties that must not be linked to the user's analytics ID. They are
-     * delivered on a separate anonymous payload when the anonymous events
-     * feature is enabled.
-     */
-    sensitiveProperties: AnalyticsEventProperties;
-    /**
-     * Name of an event emitted immediately when the fragment is created.
-     */
-    initialEvent?: string;
-    /**
-     * Name of the event emitted when the fragment is finalized normally.
-     */
-    successEvent?: string;
-    /**
-     * Name of the event emitted when the fragment is finalized as abandoned.
-     */
-    failureEvent?: string;
-    /**
-     * Platform-specific context forwarded with every event this fragment emits.
-     */
-    context?: AnalyticsContext;
-    /**
-     * Whether the fragment survives {@link AnalyticsController.init}. Fragments
-     * that do not set this are discarded when the controller re-initializes,
-     * since the journey they belonged to cannot be resumed.
-     */
-    persist?: boolean;
-    /**
-     * `Date.now()` when the fragment was created.
-     */
-    createdAt: number;
-    /**
-     * `Date.now()` when the fragment was last written to.
-     */
-    lastUpdated: number;
-};
-/**
- * Event fragments keyed by fragment ID.
- */
-export type AnalyticsEventFragments = Record<string, AnalyticsEventFragment>;
-/**
- * Options accepted when creating an event fragment. An `id` is generated when
- * one is not supplied.
- */
-export type AnalyticsEventFragmentOptions = Partial<Pick<AnalyticsEventFragment, 'id' | 'initialEvent' | 'successEvent' | 'failureEvent' | 'properties' | 'sensitiveProperties' | 'context' | 'persist'>>;
-/**
- * The fields that can be written to an existing event fragment.
- */
-export type AnalyticsEventFragmentPayload = Pick<AnalyticsEventFragmentOptions, 'properties' | 'sensitiveProperties' | 'context'>;
-/**
- * Options accepted when finalizing an event fragment.
- */
-export type AnalyticsEventFragmentFinalizeOptions = {
-    /**
-     * Whether the journey was abandoned, which selects `failureEvent` instead of
-     * `successEvent`.
-     */
-    abandoned?: boolean;
-    /**
-     * Context merged over the fragment's own context for the emitted event.
-     */
-    context?: AnalyticsContext;
-};
-//# sourceMappingURL=EventFragment.types.d.cts.map

package/dist/EventFragment.types.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventFragment.types.d.cts","sourceRoot":"","sources":["../src/EventFragment.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,wBAAwB,EACzB,6CAAyC;AAE1C;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,wBAAwB,CAAC;IAErC;;;;OAIG;IACH,mBAAmB,EAAE,wBAAwB,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,OAAO,CACjD,IAAI,CACF,sBAAsB,EACpB,IAAI,GACJ,cAAc,GACd,cAAc,GACd,cAAc,GACd,YAAY,GACZ,qBAAqB,GACrB,SAAS,GACT,SAAS,CACZ,CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAC9C,6BAA6B,EAC7B,YAAY,GAAG,qBAAqB,GAAG,SAAS,CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC"}

package/dist/EventFragment.types.d.mts

@@ -1,88 +0,0 @@
-import type { AnalyticsContext, AnalyticsEventProperties } from "./AnalyticsPlatformAdapter.types.mjs";
-/**
- * A bag of analytics properties that accumulates across a user journey.
- *
- * A fragment lets several parts of a client contribute properties to the same
- * logical journey (a signature request, a transaction confirmation) without
- * having to re-derive them for every event, and lets the journey be closed as
- * a success or a failure.
- *
- * All three event names are optional. A fragment that declares none of them
- * never emits anything and acts purely as a property bag that the client reads
- * back with {@link AnalyticsController.getEventFragmentById} at the moment it
- * emits its own event.
- */
-export type AnalyticsEventFragment = {
-    /**
-     * The fragment identifier, unique per client.
-     */
-    id: string;
-    /**
-     * Properties tracked with every event this fragment emits.
-     */
-    properties: AnalyticsEventProperties;
-    /**
-     * Properties that must not be linked to the user's analytics ID. They are
-     * delivered on a separate anonymous payload when the anonymous events
-     * feature is enabled.
-     */
-    sensitiveProperties: AnalyticsEventProperties;
-    /**
-     * Name of an event emitted immediately when the fragment is created.
-     */
-    initialEvent?: string;
-    /**
-     * Name of the event emitted when the fragment is finalized normally.
-     */
-    successEvent?: string;
-    /**
-     * Name of the event emitted when the fragment is finalized as abandoned.
-     */
-    failureEvent?: string;
-    /**
-     * Platform-specific context forwarded with every event this fragment emits.
-     */
-    context?: AnalyticsContext;
-    /**
-     * Whether the fragment survives {@link AnalyticsController.init}. Fragments
-     * that do not set this are discarded when the controller re-initializes,
-     * since the journey they belonged to cannot be resumed.
-     */
-    persist?: boolean;
-    /**
-     * `Date.now()` when the fragment was created.
-     */
-    createdAt: number;
-    /**
-     * `Date.now()` when the fragment was last written to.
-     */
-    lastUpdated: number;
-};
-/**
- * Event fragments keyed by fragment ID.
- */
-export type AnalyticsEventFragments = Record<string, AnalyticsEventFragment>;
-/**
- * Options accepted when creating an event fragment. An `id` is generated when
- * one is not supplied.
- */
-export type AnalyticsEventFragmentOptions = Partial<Pick<AnalyticsEventFragment, 'id' | 'initialEvent' | 'successEvent' | 'failureEvent' | 'properties' | 'sensitiveProperties' | 'context' | 'persist'>>;
-/**
- * The fields that can be written to an existing event fragment.
- */
-export type AnalyticsEventFragmentPayload = Pick<AnalyticsEventFragmentOptions, 'properties' | 'sensitiveProperties' | 'context'>;
-/**
- * Options accepted when finalizing an event fragment.
- */
-export type AnalyticsEventFragmentFinalizeOptions = {
-    /**
-     * Whether the journey was abandoned, which selects `failureEvent` instead of
-     * `successEvent`.
-     */
-    abandoned?: boolean;
-    /**
-     * Context merged over the fragment's own context for the emitted event.
-     */
-    context?: AnalyticsContext;
-};
-//# sourceMappingURL=EventFragment.types.d.mts.map

package/dist/EventFragment.types.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventFragment.types.d.mts","sourceRoot":"","sources":["../src/EventFragment.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,wBAAwB,EACzB,6CAAyC;AAE1C;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,wBAAwB,CAAC;IAErC;;;;OAIG;IACH,mBAAmB,EAAE,wBAAwB,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,OAAO,CACjD,IAAI,CACF,sBAAsB,EACpB,IAAI,GACJ,cAAc,GACd,cAAc,GACd,cAAc,GACd,YAAY,GACZ,qBAAqB,GACrB,SAAS,GACT,SAAS,CACZ,CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAC9C,6BAA6B,EAC7B,YAAY,GAAG,qBAAqB,GAAG,SAAS,CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC"}

package/dist/EventFragment.types.mjs

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=EventFragment.types.mjs.map

package/dist/EventFragment.types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventFragment.types.mjs","sourceRoot":"","sources":["../src/EventFragment.types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  AnalyticsContext,\n  AnalyticsEventProperties,\n} from './AnalyticsPlatformAdapter.types';\n\n/**\n * A bag of analytics properties that accumulates across a user journey.\n *\n * A fragment lets several parts of a client contribute properties to the same\n * logical journey (a signature request, a transaction confirmation) without\n * having to re-derive them for every event, and lets the journey be closed as\n * a success or a failure.\n *\n * All three event names are optional. A fragment that declares none of them\n * never emits anything and acts purely as a property bag that the client reads\n * back with {@link AnalyticsController.getEventFragmentById} at the moment it\n * emits its own event.\n */\nexport type AnalyticsEventFragment = {\n  /**\n   * The fragment identifier, unique per client.\n   */\n  id: string;\n\n  /**\n   * Properties tracked with every event this fragment emits.\n   */\n  properties: AnalyticsEventProperties;\n\n  /**\n   * Properties that must not be linked to the user's analytics ID. They are\n   * delivered on a separate anonymous payload when the anonymous events\n   * feature is enabled.\n   */\n  sensitiveProperties: AnalyticsEventProperties;\n\n  /**\n   * Name of an event emitted immediately when the fragment is created.\n   */\n  initialEvent?: string;\n\n  /**\n   * Name of the event emitted when the fragment is finalized normally.\n   */\n  successEvent?: string;\n\n  /**\n   * Name of the event emitted when the fragment is finalized as abandoned.\n   */\n  failureEvent?: string;\n\n  /**\n   * Platform-specific context forwarded with every event this fragment emits.\n   */\n  context?: AnalyticsContext;\n\n  /**\n   * Whether the fragment survives {@link AnalyticsController.init}. Fragments\n   * that do not set this are discarded when the controller re-initializes,\n   * since the journey they belonged to cannot be resumed.\n   */\n  persist?: boolean;\n\n  /**\n   * `Date.now()` when the fragment was created.\n   */\n  createdAt: number;\n\n  /**\n   * `Date.now()` when the fragment was last written to.\n   */\n  lastUpdated: number;\n};\n\n/**\n * Event fragments keyed by fragment ID.\n */\nexport type AnalyticsEventFragments = Record<string, AnalyticsEventFragment>;\n\n/**\n * Options accepted when creating an event fragment. An `id` is generated when\n * one is not supplied.\n */\nexport type AnalyticsEventFragmentOptions = Partial<\n  Pick<\n    AnalyticsEventFragment,\n    | 'id'\n    | 'initialEvent'\n    | 'successEvent'\n    | 'failureEvent'\n    | 'properties'\n    | 'sensitiveProperties'\n    | 'context'\n    | 'persist'\n  >\n>;\n\n/**\n * The fields that can be written to an existing event fragment.\n */\nexport type AnalyticsEventFragmentPayload = Pick<\n  AnalyticsEventFragmentOptions,\n  'properties' | 'sensitiveProperties' | 'context'\n>;\n\n/**\n * Options accepted when finalizing an event fragment.\n */\nexport type AnalyticsEventFragmentFinalizeOptions = {\n  /**\n   * Whether the journey was abandoned, which selects `failureEvent` instead of\n   * `successEvent`.\n   */\n  abandoned?: boolean;\n\n  /**\n   * Context merged over the fragment's own context for the emitted event.\n   */\n  context?: AnalyticsContext;\n};\n"]}