Class AnalyticsStateful

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

Readonlystates

flush

• flush(): Promise<void>

  Send all queued events grouped by profile and clear the queue.

  Returns Promise<void>

  Remarks

  Only under rare circumstances should there be more than one profile in a stateful application.

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; 'trackComponentView' is normalized to 'component' for allow‑list checks.

  Returns boolean

  true if the operation is permitted; otherwise false.

isNotDuplicated

• isNotDuplicated(
      _name: string,
      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 };
              sticky?: boolean;
              userAgent?: string;
              variantIndex?: number;
          },
          string,
      ],
  ): boolean

  Guard used to suppress duplicate component/flag view events based on a duplication key and the component identifier.

  Parameters

  • _name: string

    The operation name (unused).
  • 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 };
            sticky?: boolean;
            userAgent?: string;
            variantIndex?: number;
        },
        string,
    ]

    Tuple of [builderArgs, duplicationScope].

  Returns boolean

  true if the event is NOT a duplicate and should proceed.

onBlockedByConsent

• onBlockedByConsent(name: string, payload: unknown[]): void

  Hook invoked when an operation is blocked due to missing consent.

  Parameters

  • name: string

    The blocked operation name.
  • payload: unknown[]

    The original arguments supplied to the operation.

  Returns void

onBlockedByDuplication

• onBlockedByDuplication(name: string, payload: unknown[]): void

  Hook invoked when an operation is blocked by the duplication guard.

  Parameters

  • name: string

    The blocked operation name.
  • payload: unknown[]

    The original arguments supplied to the operation.

  Returns void

reset

• reset(): void

  Reset analytics‑related signals and the last emitted event.

  Returns void

trackComponentView

• trackComponentView(
      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 };
          sticky?: boolean;
          userAgent?: string;
          variantIndex?: number;
      },
      _duplicationScope?: string,
  ): 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;
        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;
    }

    Component view builder arguments.
  • _duplicationScope: string = ''

    Optional string used to scope duplication (used by guards); an empty string '' is converted to the undefined scope

  Returns Promise<void>

trackFlagView

• trackFlagView(
      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 };
          sticky?: boolean;
          userAgent?: string;
          variantIndex?: number;
      },
      _duplicationScope?: string,
  ): 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;
        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;
    }

    Flag view builder arguments.
  • _duplicationScope: string = ''

    Optional string used to scope duplication (used by guards); an empty string '' is converted to the undefined scope

  Returns Promise<void>