Class AnalyticsStateful

Analytics implementation that maintains local state (consent, profile) and queues events until flushed or the queue reaches a maximum size.

Remarks

Repeated flush failures are managed by the configured QueueFlushPolicy using bounded backoff and a temporary circuit-open window.

Hierarchy

AnalyticsBase
- AnalyticsStateful

Implements

ConsentGuard

Index

Constructors

constructor

new AnalyticsStateful(options: AnalyticsStatefulOptions): AnalyticsStateful
Create a new stateful analytics instance.
Parameters
- options: AnalyticsStatefulOptions
  Options to configure the analytics product for stateful environments.
Returns AnalyticsStateful
Example
```
const analytics = new AnalyticsStateful({ api, builder, config: { defaults: { consent: true } }, interceptors })
```
Overrides AnalyticsBase.constructor
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:140

Properties

`Protected` `Optional` `Readonly`allowedEventTypes

allowedEventTypes?: string[]

Allow‑list of event type keys permitted when consent is not present.

`Protected` `Readonly`api

api: ApiClient

Optimization API client used to send events to the Experience and Insights APIs.

`Protected` `Readonly`builder

builder: EventBuilder

Event builder used to construct strongly‑typed events.

`Readonly`interceptors

interceptors: LifecycleInterceptors

Interceptors that can mutate/augment outgoing events or optimization state.

`Protected` `Optional` `Readonly`onEventBlocked

onEventBlocked?: (event: BlockedEvent) => void

Optional callback invoked when an event call is blocked.

`Readonly`states

states: AnalyticsStates = ...

Exposed observable state references.

Methods

flush

flush(options?: { force?: boolean }): Promise<void>
Send all queued events grouped by profile and clear the queue.
Parameters
- options: { force?: boolean } = {}
  Optional flush controls.
  - Optionalforce?: boolean
    When true, bypass offline/backoff/circuit gates and attempt immediately.
Returns Promise<void>
Remarks
Only under rare circumstances should there be more than one profile in a stateful application.
Example
```
await analytics.flush()
```
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:340

hasConsent

hasConsent(name: string): boolean
Determine whether the named operation is permitted based on consent and allowed event type configuration.
Parameters
- name: string
  The method name; component view/flag methods are normalized to 'component', component click methods are normalized to 'component_click', and component hover methods are normalized to 'component_hover' for allow‑list checks.
Returns boolean
true if the operation is permitted; otherwise false.
Example
```
if (analytics.hasConsent('track')) { ... }
```
Implementation of ConsentGuard.hasConsent
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:191

onBlockedByConsent

onBlockedByConsent(name: string, payload: readonly unknown[]): void
Hook invoked when an operation is blocked due to missing consent.
Parameters
- name: string
  The blocked operation name.
- payload: readonly unknown[]
  The original arguments supplied to the operation.
Returns void
Example
```
analytics.onBlockedByConsent('track', [payload])
```
Implementation of ConsentGuard.onBlockedByConsent
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:207

`Protected`reportBlockedEvent

reportBlockedEvent(
    reason: "consent",
    product: BlockedEventProduct,
    method: string,
    args: readonly unknown[],
): void
Publish blocked event metadata to both callback and blocked event signal.
Parameters
- reason: "consent"
  Reason the method call was blocked.
- product: BlockedEventProduct
  Product that blocked the method call.
- method: string
  Name of the blocked method.
- args: readonly unknown[]
  Original blocked call arguments.
Returns void
Inherited from AnalyticsBase.reportBlockedEvent
- Defined in packages/universal/core-sdk/src/ProductBase.ts:119

reset

reset(): void
Reset analytics‑related signals and the last emitted event.

Returns void
Example
```
analytics.reset()
```
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:167

trackComponentClick

trackComponentClick(
    payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        componentId: string;
        experienceId?: string;
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        screen?: { name: string; [key: string]: JSONType };
        userAgent?: string;
        variantIndex?: number;
    },
): Promise<void>
Queue a component click event for the active profile.
Parameters
- payload: {
      campaign?: {
          content?: string;
          medium?: string;
          name?: string;
          source?: string;
          term?: string;
      };
      componentId: string;
      experienceId?: string;
      locale?: string;
      location?: {
          city?: string;
          continent?: string;
          coordinates?: { latitude: number; longitude: number };
          country?: string;
          countryCode?: string;
          postalCode?: string;
          region?: string;
          regionCode?: string;
          timezone?: string;
      };
      page?: {
          path: string;
          query: Record<string, string>;
          referrer: string;
          search: string;
          title?: string;
          url: string;
          [key: string]: JSONType;
      };
      screen?: { name: string; [key: string]: JSONType };
      userAgent?: string;
      variantIndex?: number;
  }
  Component click builder arguments.
Returns Promise<void>
A promise that resolves when the event has been queued.
Example
```
await analytics.trackComponentClick({ componentId: 'hero-banner' })
```
Overrides AnalyticsBase.trackComponentClick
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:243

trackComponentHover

trackComponentHover(
    payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        componentHoverId: string;
        componentId: string;
        experienceId?: string;
        hoverDurationMs: number;
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        screen?: { name: string; [key: string]: JSONType };
        userAgent?: string;
        variantIndex?: number;
    },
): Promise<void>
Queue a component hover event for the active profile.
Parameters
- payload: {
      campaign?: {
          content?: string;
          medium?: string;
          name?: string;
          source?: string;
          term?: string;
      };
      componentHoverId: string;
      componentId: string;
      experienceId?: string;
      hoverDurationMs: number;
      locale?: string;
      location?: {
          city?: string;
          continent?: string;
          coordinates?: { latitude: number; longitude: number };
          country?: string;
          countryCode?: string;
          postalCode?: string;
          region?: string;
          regionCode?: string;
          timezone?: string;
      };
      page?: {
          path: string;
          query: Record<string, string>;
          referrer: string;
          search: string;
          title?: string;
          url: string;
          [key: string]: JSONType;
      };
      screen?: { name: string; [key: string]: JSONType };
      userAgent?: string;
      variantIndex?: number;
  }
  Component hover builder arguments.
Returns Promise<void>
A promise that resolves when the event has been queued.
Example
```
await analytics.trackComponentHover({ componentId: 'hero-banner' })
```
Overrides AnalyticsBase.trackComponentHover
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:260

trackComponentView

trackComponentView(
    payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        componentId: string;
        componentViewId: string;
        experienceId?: string;
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        screen?: { name: string; [key: string]: JSONType };
        sticky?: boolean;
        userAgent?: string;
        variantIndex?: number;
        viewDurationMs: number;
    },
): Promise<void>
Queue a component view event for the active profile.
Parameters
- payload: {
      campaign?: {
          content?: string;
          medium?: string;
          name?: string;
          source?: string;
          term?: string;
      };
      componentId: string;
      componentViewId: string;
      experienceId?: string;
      locale?: string;
      location?: {
          city?: string;
          continent?: string;
          coordinates?: { latitude: number; longitude: number };
          country?: string;
          countryCode?: string;
          postalCode?: string;
          region?: string;
          regionCode?: string;
          timezone?: string;
      };
      page?: {
          path: string;
          query: Record<string, string>;
          referrer: string;
          search: string;
          title?: string;
          url: string;
          [key: string]: JSONType;
      };
      screen?: { name: string; [key: string]: JSONType };
      sticky?: boolean;
      userAgent?: string;
      variantIndex?: number;
      viewDurationMs: number;
  }
  Component view builder arguments.
Returns Promise<void>
A promise that resolves when the event has been queued.
Example
```
await analytics.trackComponentView({ componentId: 'hero-banner' })
```
Overrides AnalyticsBase.trackComponentView
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:226

trackFlagView

trackFlagView(
    payload: {
        campaign?: {
            content?: string;
            medium?: string;
            name?: string;
            source?: string;
            term?: string;
        };
        componentId: string;
        componentViewId: string;
        experienceId?: string;
        locale?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
        page?: {
            path: string;
            query: Record<string, string>;
            referrer: string;
            search: string;
            title?: string;
            url: string;
            [key: string]: JSONType;
        };
        screen?: { name: string; [key: string]: JSONType };
        sticky?: boolean;
        userAgent?: string;
        variantIndex?: number;
        viewDurationMs: number;
    },
): Promise<void>
Queue a flag view event for the active profile.
Parameters
- payload: {
      campaign?: {
          content?: string;
          medium?: string;
          name?: string;
          source?: string;
          term?: string;
      };
      componentId: string;
      componentViewId: string;
      experienceId?: string;
      locale?: string;
      location?: {
          city?: string;
          continent?: string;
          coordinates?: { latitude: number; longitude: number };
          country?: string;
          countryCode?: string;
          postalCode?: string;
          region?: string;
          regionCode?: string;
          timezone?: string;
      };
      page?: {
          path: string;
          query: Record<string, string>;
          referrer: string;
          search: string;
          title?: string;
          url: string;
          [key: string]: JSONType;
      };
      screen?: { name: string; [key: string]: JSONType };
      sticky?: boolean;
      userAgent?: string;
      variantIndex?: number;
      viewDurationMs: number;
  }
  Flag view builder arguments.
Returns Promise<void>
A promise that resolves when the event has been queued.
Example
```
await analytics.trackFlagView({ componentId: 'feature-flag-123' })
```
Overrides AnalyticsBase.trackFlagView
- Defined in packages/universal/core-sdk/src/analytics/AnalyticsStateful.ts:277

Class AnalyticsStateful

Remarks

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AnalyticsStateful

Example

Properties

Protected Optional ReadonlyallowedEventTypes

Protected Readonlyapi

Protected Readonlybuilder

Readonlyinterceptors

Protected Optional ReadonlyonEventBlocked

Readonlystates

Methods

flush

Parameters

Optionalforce?: boolean

Returns Promise<void>

Remarks

Example

hasConsent

Parameters

Returns boolean

Example

onBlockedByConsent

Parameters

Returns void

Example

ProtectedreportBlockedEvent

Parameters

Returns void

reset

Returns void

Example

trackComponentClick

Parameters

Returns Promise<void>

Example

trackComponentHover

Parameters

Returns Promise<void>

Example

trackComponentView

Parameters

Returns Promise<void>

Example

trackFlagView

Parameters

Returns Promise<void>

Example

Settings

On This Page

`Protected` `Optional` `Readonly`allowedEventTypes

`Protected` `Readonly`api

`Protected` `Readonly`builder

`Readonly`interceptors

`Protected` `Optional` `Readonly`onEventBlocked

`Readonly`states

`Optional`force?: boolean

`Protected`reportBlockedEvent