@nommos/events_angular 0.0.43 → 0.0.45

package/README.md

@@ -151,6 +151,27 @@ bootstrapApplication(App, appConfig).catch((err) => console.error(err));
  );
 ```
 
+##### Web popup methods
+
+The SDK draws its own notification bell and tray, so these are only needed to drive popups from your
+own UI. See the **Web Popups** section of `@nommos/core`'s README for the tray's behaviour and the
+`data-nommos-notification-anchor` opt-in for placing the bell in your header.
+
+| Method | Parameters | Returns | Description |
+|--------|-----------|---------|-------------|
+| `openPopup` | `popupId?: number` | `Promise<void>` | Opens a popup directly, bypassing the tray. Defaults to the highest-ranked one. |
+| `getPopupInbox` | — | `WebPopupInboxState` | The current items and their unread count, for rendering your own badge. |
+| `setPopupSoundEnabled` | `enabled: boolean` | `void` | Mutes or unmutes the arrival chime. Visitor-level, persisted in `localStorage`. |
+
+```ts
+  // trackerService: TrackerService
+
+  const { items, unreadCount } = trackerService.getPopupInbox();
+  if (unreadCount > 0) {
+    await trackerService.openPopup(items[0].id);
+  }
+```
+
 ### 6.2 Directives
 #### `Directive: TrackClickDirective`
 A directive that will set the action being tracked, form the event and publish it on clicking the element where it is set (Buttons, links or any clickable element).

package/fesm2022/nommos-events_angular.mjs

@@ -38,6 +38,33 @@ class TrackerService {
     trackEvent(action, state, data = null, toggle = true, selected = null, userId = '') {
         this.eventTracker.trackEvent(action, state, data, toggle, selected, userId, this.router.url);
     }
+    /**
+     * Opens a web popup directly, bypassing the notification tray.
+     *
+     * <p>The SDK already draws its own bell and tray, so a host app needs this only to drive the
+     * viewer from its own UI — a "what's new" link, or restoring a popup after a route change.
+     *
+     * @param popupId - Optional: which popup to open. Defaults to the highest-ranked one.
+     */
+    openPopup(popupId) {
+        return this.eventTracker.openViewer(popupId);
+    }
+    /**
+     * The current inbox and its unread count, for a host app rendering its own badge instead of
+     * (or alongside) the SDK's bell.
+     */
+    getPopupInbox() {
+        return this.eventTracker.getInbox();
+    }
+    /**
+     * Mutes or unmutes the chime played when a popup arrives mid-session.
+     *
+     * <p>Visitor-level and persisted in `localStorage`, so it outlives the tab. The tray exposes the
+     * same preference as a toggle; this is for host apps that keep sound settings of their own.
+     */
+    setPopupSoundEnabled(enabled) {
+        this.eventTracker.setPopupSoundEnabled(enabled);
+    }
     ngOnDestroy() {
         this.eventTracker.unsubscribe();
     }

package/fesm2022/nommos-events_angular.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"nommos-events_angular.mjs","sources":["../../../../nommos/angular/src/services/tracker/tracker.service.ts","../../../../nommos/angular/src/directives/track-click/track-click.directive.ts","../../../../nommos/angular/src/directives/track-submit/track-submit.directive.ts","../../../../nommos/angular/src/activity-tracker.module.ts","../../../../nommos/angular/src/nommos-events_angular.ts"],"sourcesContent":["import { Injectable, OnDestroy } from '@angular/core';\r\nimport { Router } from '@angular/router';\r\nimport {\r\n  ANALYTICS_ACTION,\r\n  ANALYTICS_ACTION_STATE,\r\n  EventTracker,\r\n} from '@nommos/core';\r\n\r\n/**\r\n * TrackerService\r\n * -----------------------\r\n * An angular utility designed to record user actions such as clicks,\r\n * form submissions, and custom events for analytics of carried out .\r\n *\r\n * @example\r\n * ```ts\r\n * constructor(private tracker: TrackerService) {}\r\n *\r\n * this.tracker.trackEvent(ANALYTICS_ACTION_GROUPS.SIGN_IN, ANALYTICS_ACTION_STATE.SUBMIT, { login: 'johndoh@example.com' }, false, null, 'u123-456-789');\r\n * ```\r\n */\r\n\r\n@Injectable({\r\n  providedIn: 'root',\r\n})\r\nexport class TrackerService implements OnDestroy {\r\n  constructor(\r\n    private readonly eventTracker: EventTracker,\r\n    private readonly router: Router\r\n  ) {}\r\n\r\n  /**\r\n   * collects tracked actions carried with associated informations and publishes them for storage.\r\n   *\r\n   * @param action -  Name of action to be tracked.\r\n   * @param state - State associated to the action being tracked.\r\n   * @param data - Optional: information associated with the action being tracked.\r\n   * @param toggle - Enables toggling between two actions(select/unselect) for an action.\r\n   * @param selected - State of an event with select action (selected or unselected)\r\n   * @param userId - Optional: user ID associated to the current user carrying out the action.\r\n   */\r\n  trackEvent(\r\n    action: ANALYTICS_ACTION,\r\n    state: ANALYTICS_ACTION_STATE,\r\n    data: Record<string, unknown> | null = null,\r\n    toggle = true,\r\n    selected: boolean | null = null,\r\n    userId = ''\r\n  ): void {\r\n    this.eventTracker.trackEvent(\r\n      action,\r\n      state,\r\n      data,\r\n      toggle,\r\n      selected,\r\n      userId,\r\n      this.router.url\r\n    );\r\n  }\r\n\r\n  ngOnDestroy(): void {\r\n    this.eventTracker.unsubscribe();\r\n  }\r\n}\r\n","import { Directive, HostListener, Input } from '@angular/core';\r\nimport { ANALYTICS_ACTION, ANALYTICS_ACTION_STATE } from '@nommos/core';\r\nimport { TrackerService } from '../../services/tracker/tracker.service';\r\n\r\n/**\r\n * TrackClickDirective\r\n * --------------------\r\n * An attribute directive that automatically pushes setup action with associated information on clicks\r\n *\r\n * @example\r\n * ```html\r\n * <button\r\n *   [nommosTrackClick]=\"ANALYTICS_ACTION_GROUPS.REGISTRATION\"\r\n * >\r\n *   Sign Up\r\n * </button>\r\n * ```\r\n */\r\n@Directive({\r\n  selector: '[nommosTrackClick]',\r\n  standalone: false,\r\n})\r\nexport class TrackClickDirective {\r\n  /**\r\n   * The action to be tracked.\r\n   * @type {ANALYTICS_ACTION}\r\n   */\r\n  @Input('nommosTrackClick') action!: ANALYTICS_ACTION;\r\n\r\n  /**\r\n   * The state of the action carried to be tracked.\r\n   * @default ANALYTICS_ACTION_STATE.SELECT\r\n   * @type {ANALYTICS_ACTION_STATE}\r\n   */\r\n  @Input() state: ANALYTICS_ACTION_STATE = ANALYTICS_ACTION_STATE.SELECT;\r\n\r\n  /**\r\n   * Optional Information on the action carried out being tracked.\r\n   * @type {Record<string, unknown>}\r\n   */\r\n  @Input() data?: Record<string, unknown>;\r\n\r\n  /**\r\n   * Permits to toggle the selection state (ANALYTICS_ACTION_STATE.SELECT to/from ANALYTICS_ACTION_STATE.UN_SELECT)\r\n   * of an action by any element when clicked.\r\n   * **Default:** `true`\r\n   * @type {boolean}\r\n   */\r\n  @Input() toggle = true;\r\n\r\n  /**\r\n   * Permits multiple elements to change the selection state of an action.\r\n   * It has priority over the **toggle** input.\r\n   * **Default:** `false`\r\n   * @type {boolean}\r\n   */\r\n  @Input() multi = false;\r\n\r\n  /**\r\n   * The user ID associated to the current user carrying out the action.\r\n   * **Default:** `''`\r\n   * @type {string}\r\n   */\r\n  @Input() userId = '';\r\n  clicked = false;\r\n\r\n  constructor(private readonly trackerService: TrackerService) {}\r\n\r\n  @HostListener('click')\r\n  onClick(): void {\r\n    if (this.multi) {\r\n      this.clicked = !this.clicked;\r\n      this.trackerService.trackEvent(\r\n        this.action,\r\n        this.state,\r\n        this.data,\r\n        this.toggle,\r\n        this.clicked,\r\n        this.userId\r\n      );\r\n    } else {\r\n      this.trackerService.trackEvent(\r\n        this.action,\r\n        this.state,\r\n        this.data,\r\n        this.toggle,\r\n        null,\r\n        this.userId\r\n      );\r\n    }\r\n  }\r\n}\r\n","import { Directive, HostListener, Input } from '@angular/core';\r\nimport { ANALYTICS_ACTION, ANALYTICS_ACTION_STATE } from '@nommos/core';\r\nimport { TrackerService } from '../../services/tracker/tracker.service';\r\n\r\n/**\r\n * TrackSubmitDirective\r\n * --------------------\r\n * An attribute directive that automatically pushes setup action with associated information on form submissions\r\n *\r\n * @example\r\n * ```html\r\n * <button\r\n *   [nommosTrackSubmit]=\"ANALYTICS_ACTION_GROUPS.REGISTRATION\"\r\n * >\r\n *   Sign Up\r\n * </button>\r\n * ```\r\n */\r\n@Directive({\r\n  selector: '[nommosTrackSubmit]',\r\n  standalone: false,\r\n})\r\nexport class TrackSubmitDirective {\r\n  /**\r\n   * The action to be tracked.\r\n   * @type {ANALYTICS_ACTION}\r\n   */\r\n  @Input('nommosTrackSubmit') action!: ANALYTICS_ACTION;\r\n\r\n  /**\r\n   * Optional Information on the action carried out being tracked.\r\n   * @type {Record<string, unknown>}\r\n   */\r\n  @Input() data?: Record<string, unknown>;\r\n\r\n\r\n  /**\r\n   * The user ID associated to the current user carrying out the action.\r\n   * @default ''\r\n   * @type {string}\r\n   */\r\n  @Input() userId = '';\r\n\r\n  constructor(private readonly trackerService: TrackerService) {}\r\n\r\n  @HostListener('ngSubmit')\r\n  @HostListener('submit')\r\n  onClick(): void {\r\n    this.trackerService.trackEvent(\r\n      this.action,\r\n      ANALYTICS_ACTION_STATE.SUBMIT,\r\n      this.data,\r\n      false,\r\n      null,\r\n      this.userId\r\n    );\r\n  }\r\n}\r\n","import { ModuleWithProviders, NgModule, Provider } from '@angular/core';\r\nimport { CommonModule } from '@angular/common';\r\nimport { ConnectionConfig, EventTracker, UrlTrackingKey } from '@nommos/core';\r\nimport { TrackerService } from './services/tracker/tracker.service';\r\nimport { TrackClickDirective, TrackSubmitDirective } from './directives';\r\n\r\n@NgModule({\r\n  declarations: [TrackClickDirective, TrackSubmitDirective],\r\n  imports: [CommonModule],\r\n  exports: [TrackClickDirective, TrackSubmitDirective],\r\n})\r\nexport class ActivityTrackerModule {\r\n  /**\r\n   * Registers the ActivityTrackerModule using the Angular `forRoot()` pattern.\r\n   *\r\n   * This is intended for NgModule-based applications. It initializes the\r\n   * analytics engine with the provided connection configuration and URL\r\n   * tracking key.\r\n   *\r\n   * @param config - Connection configuration used by the `EventTracker` (a token)\r\n   * @param urlTrackingKey - Optional key for extracting tracking identifiers\r\n   *                         from the URL (e.g affiliate key)\r\n   * @returns A `ModuleWithProviders` containing the module and its providers\r\n   */\r\n\r\n  static forRoot(\r\n    config: ConnectionConfig,\r\n    urlTrackingKey: UrlTrackingKey\r\n  ): ModuleWithProviders<ActivityTrackerModule> {\r\n    return {\r\n      ngModule: ActivityTrackerModule,\r\n      providers: [\r\n        {\r\n          provide: EventTracker,\r\n          useValue: new EventTracker(config, urlTrackingKey),\r\n        },\r\n        TrackerService,\r\n      ],\r\n    };\r\n  }\r\n}\r\n\r\n/**\r\n * Standalone-friendly provider registration for the Activity Tracker.\r\n *\r\n * This function is recommended for Angular applications using the\r\n * Standalone API (`bootstrapApplication`) and cannot use `forRoot()`.\r\n *\r\n * @example\r\n * ```ts\r\n * bootstrapApplication(AppComponent, {\r\n *   providers: [\r\n *     ...provideActivityTracker(config, urlTrackingKey)\r\n *   ]\r\n * });\r\n * ```\r\n *\r\n * @param config - Connection configuration used by `EventTracker`\r\n * @param urlTrackingKey - Key used to extract tracking identifiers from URLs\r\n * @returns An array of Angular providers for use in standalone environments\r\n */\r\nexport function provideActivityTracker(\r\n  config: ConnectionConfig,\r\n  urlTrackingKey: UrlTrackingKey\r\n): Provider[] {\r\n  return [\r\n    {\r\n      provide: EventTracker,\r\n      useValue: new EventTracker(config, urlTrackingKey),\r\n    },\r\n    TrackerService,\r\n  ];\r\n}\r\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["i1.TrackerService"],"mappings":";;;;;;;AAQA;;;;;;;;;;;;AAYG;MAKU,cAAc,CAAA;AAEN,IAAA,YAAA;AACA,IAAA,MAAA;IAFnB,WAAA,CACmB,YAA0B,EAC1B,MAAc,EAAA;QADd,IAAA,CAAA,YAAY,GAAZ,YAAY;QACZ,IAAA,CAAA,MAAM,GAAN,MAAM;IACtB;AAEH;;;;;;;;;AASG;AACH,IAAA,UAAU,CACR,MAAwB,EACxB,KAA6B,EAC7B,OAAuC,IAAI,EAC3C,MAAM,GAAG,IAAI,EACb,QAAA,GAA2B,IAAI,EAC/B,MAAM,GAAG,EAAE,EAAA;QAEX,IAAI,CAAC,YAAY,CAAC,UAAU,CAC1B,MAAM,EACN,KAAK,EACL,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,MAAM,EACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAChB;IACH;IAEA,WAAW,GAAA;AACT,QAAA,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;IACjC;wGArCW,cAAc,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAAA,EAAA,CAAA,YAAA,EAAA,EAAA,EAAA,KAAA,EAAA,EAAA,CAAA,MAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAd,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,cAAc,cAFb,MAAM,EAAA,CAAA;;4FAEP,cAAc,EAAA,UAAA,EAAA,CAAA;kBAH1B,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE,MAAM;AACnB,iBAAA;;;ACpBD;;;;;;;;;;;;;AAaG;MAKU,mBAAmB,CAAA;AA4CD,IAAA,cAAA;AA3C7B;;;AAGG;AACwB,IAAA,MAAM;AAEjC;;;;AAIG;AACM,IAAA,KAAK,GAA2B,sBAAsB,CAAC,MAAM;AAEtE;;;AAGG;AACM,IAAA,IAAI;AAEb;;;;;AAKG;IACM,MAAM,GAAG,IAAI;AAEtB;;;;;AAKG;IACM,KAAK,GAAG,KAAK;AAEtB;;;;AAIG;IACM,MAAM,GAAG,EAAE;IACpB,OAAO,GAAG,KAAK;AAEf,IAAA,WAAA,CAA6B,cAA8B,EAAA;QAA9B,IAAA,CAAA,cAAc,GAAd,cAAc;IAAmB;IAG9D,OAAO,GAAA;AACL,QAAA,IAAI,IAAI,CAAC,KAAK,EAAE;AACd,YAAA,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO;AAC5B,YAAA,IAAI,CAAC,cAAc,CAAC,UAAU,CAC5B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,MAAM,CACZ;QACH;aAAO;YACL,IAAI,CAAC,cAAc,CAAC,UAAU,CAC5B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,EACJ,IAAI,CAAC,MAAM,CACZ;QACH;IACF;wGApEW,mBAAmB,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAAAA,cAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,SAAA,EAAA,CAAA;4FAAnB,mBAAmB,EAAA,YAAA,EAAA,KAAA,EAAA,QAAA,EAAA,oBAAA,EAAA,MAAA,EAAA,EAAA,MAAA,EAAA,CAAA,kBAAA,EAAA,QAAA,CAAA,EAAA,KAAA,EAAA,OAAA,EAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,QAAA,EAAA,KAAA,EAAA,OAAA,EAAA,MAAA,EAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,SAAA,EAAA,EAAA,OAAA,EAAA,WAAA,EAAA,EAAA,EAAA,QAAA,EAAA,EAAA,EAAA,CAAA;;4FAAnB,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAJ/B,SAAS;AAAC,YAAA,IAAA,EAAA,CAAA;AACT,oBAAA,QAAQ,EAAE,oBAAoB;AAC9B,oBAAA,UAAU,EAAE,KAAK;AAClB,iBAAA;;sBAME,KAAK;uBAAC,kBAAkB;;sBAOxB;;sBAMA;;sBAQA;;sBAQA;;sBAOA;;sBAKA,YAAY;uBAAC,OAAO;;;AChEvB;;;;;;;;;;;;;AAaG;MAKU,oBAAoB,CAAA;AAqBF,IAAA,cAAA;AApB7B;;;AAGG;AACyB,IAAA,MAAM;AAElC;;;AAGG;AACM,IAAA,IAAI;AAGb;;;;AAIG;IACM,MAAM,GAAG,EAAE;AAEpB,IAAA,WAAA,CAA6B,cAA8B,EAAA;QAA9B,IAAA,CAAA,cAAc,GAAd,cAAc;IAAmB;IAI9D,OAAO,GAAA;QACL,IAAI,CAAC,cAAc,CAAC,UAAU,CAC5B,IAAI,CAAC,MAAM,EACX,sBAAsB,CAAC,MAAM,EAC7B,IAAI,CAAC,IAAI,EACT,KAAK,EACL,IAAI,EACJ,IAAI,CAAC,MAAM,CACZ;IACH;wGAlCW,oBAAoB,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAAAA,cAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,SAAA,EAAA,CAAA;4FAApB,oBAAoB,EAAA,YAAA,EAAA,KAAA,EAAA,QAAA,EAAA,qBAAA,EAAA,MAAA,EAAA,EAAA,MAAA,EAAA,CAAA,mBAAA,EAAA,QAAA,CAAA,EAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,SAAA,EAAA,EAAA,UAAA,EAAA,WAAA,EAAA,QAAA,EAAA,WAAA,EAAA,EAAA,EAAA,QAAA,EAAA,EAAA,EAAA,CAAA;;4FAApB,oBAAoB,EAAA,UAAA,EAAA,CAAA;kBAJhC,SAAS;AAAC,YAAA,IAAA,EAAA,CAAA;AACT,oBAAA,QAAQ,EAAE,qBAAqB;AAC/B,oBAAA,UAAU,EAAE,KAAK;AAClB,iBAAA;;sBAME,KAAK;uBAAC,mBAAmB;;sBAMzB;;sBAQA;;sBAIA,YAAY;uBAAC,UAAU;;sBACvB,YAAY;uBAAC,QAAQ;;;MCnCX,qBAAqB,CAAA;AAChC;;;;;;;;;;;AAWG;AAEH,IAAA,OAAO,OAAO,CACZ,MAAwB,EACxB,cAA8B,EAAA;QAE9B,OAAO;AACL,YAAA,QAAQ,EAAE,qBAAqB;AAC/B,YAAA,SAAS,EAAE;AACT,gBAAA;AACE,oBAAA,OAAO,EAAE,YAAY;AACrB,oBAAA,QAAQ,EAAE,IAAI,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC;AACnD,iBAAA;gBACD,cAAc;AACf,aAAA;SACF;IACH;wGA5BW,qBAAqB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,QAAA,EAAA,CAAA;yGAArB,qBAAqB,EAAA,YAAA,EAAA,CAJjB,mBAAmB,EAAE,oBAAoB,aAC9C,YAAY,CAAA,EAAA,OAAA,EAAA,CACZ,mBAAmB,EAAE,oBAAoB,CAAA,EAAA,CAAA;AAExC,IAAA,OAAA,IAAA,GAAA,EAAA,CAAA,mBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,qBAAqB,YAHtB,YAAY,CAAA,EAAA,CAAA;;4FAGX,qBAAqB,EAAA,UAAA,EAAA,CAAA;kBALjC,QAAQ;AAAC,YAAA,IAAA,EAAA,CAAA;AACR,oBAAA,YAAY,EAAE,CAAC,mBAAmB,EAAE,oBAAoB,CAAC;oBACzD,OAAO,EAAE,CAAC,YAAY,CAAC;AACvB,oBAAA,OAAO,EAAE,CAAC,mBAAmB,EAAE,oBAAoB,CAAC;AACrD,iBAAA;;AAgCD;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,sBAAsB,CACpC,MAAwB,EACxB,cAA8B,EAAA;IAE9B,OAAO;AACL,QAAA;AACE,YAAA,OAAO,EAAE,YAAY;AACrB,YAAA,QAAQ,EAAE,IAAI,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC;AACnD,SAAA;QACD,cAAc;KACf;AACH;;ACxEA;;AAEG;;;;"}
+{"version":3,"file":"nommos-events_angular.mjs","sources":["../../../../nommos/angular/src/services/tracker/tracker.service.ts","../../../../nommos/angular/src/directives/track-click/track-click.directive.ts","../../../../nommos/angular/src/directives/track-submit/track-submit.directive.ts","../../../../nommos/angular/src/activity-tracker.module.ts","../../../../nommos/angular/src/nommos-events_angular.ts"],"sourcesContent":["import { Injectable, OnDestroy } from '@angular/core';\r\nimport { Router } from '@angular/router';\r\nimport {\r\n  ANALYTICS_ACTION,\r\n  ANALYTICS_ACTION_STATE,\r\n  EventTracker,\r\n  WebPopupInboxState,\r\n} from '@nommos/core';\r\n\r\n/**\r\n * TrackerService\r\n * -----------------------\r\n * An angular utility designed to record user actions such as clicks,\r\n * form submissions, and custom events for analytics of carried out .\r\n *\r\n * @example\r\n * ```ts\r\n * constructor(private tracker: TrackerService) {}\r\n *\r\n * this.tracker.trackEvent(ANALYTICS_ACTION_GROUPS.SIGN_IN, ANALYTICS_ACTION_STATE.SUBMIT, { login: 'johndoh@example.com' }, false, null, 'u123-456-789');\r\n * ```\r\n */\r\n\r\n@Injectable({\r\n  providedIn: 'root',\r\n})\r\nexport class TrackerService implements OnDestroy {\r\n  constructor(\r\n    private readonly eventTracker: EventTracker,\r\n    private readonly router: Router\r\n  ) {}\r\n\r\n  /**\r\n   * collects tracked actions carried with associated informations and publishes them for storage.\r\n   *\r\n   * @param action -  Name of action to be tracked.\r\n   * @param state - State associated to the action being tracked.\r\n   * @param data - Optional: information associated with the action being tracked.\r\n   * @param toggle - Enables toggling between two actions(select/unselect) for an action.\r\n   * @param selected - State of an event with select action (selected or unselected)\r\n   * @param userId - Optional: user ID associated to the current user carrying out the action.\r\n   */\r\n  trackEvent(\r\n    action: ANALYTICS_ACTION,\r\n    state: ANALYTICS_ACTION_STATE,\r\n    data: Record<string, unknown> | null = null,\r\n    toggle = true,\r\n    selected: boolean | null = null,\r\n    userId = ''\r\n  ): void {\r\n    this.eventTracker.trackEvent(\r\n      action,\r\n      state,\r\n      data,\r\n      toggle,\r\n      selected,\r\n      userId,\r\n      this.router.url\r\n    );\r\n  }\r\n\r\n  /**\r\n   * Opens a web popup directly, bypassing the notification tray.\r\n   *\r\n   * <p>The SDK already draws its own bell and tray, so a host app needs this only to drive the\r\n   * viewer from its own UI — a \"what's new\" link, or restoring a popup after a route change.\r\n   *\r\n   * @param popupId - Optional: which popup to open. Defaults to the highest-ranked one.\r\n   */\r\n  openPopup(popupId?: number): Promise<void> {\r\n    return this.eventTracker.openViewer(popupId);\r\n  }\r\n\r\n  /**\r\n   * The current inbox and its unread count, for a host app rendering its own badge instead of\r\n   * (or alongside) the SDK's bell.\r\n   */\r\n  getPopupInbox(): WebPopupInboxState {\r\n    return this.eventTracker.getInbox();\r\n  }\r\n\r\n  /**\r\n   * Mutes or unmutes the chime played when a popup arrives mid-session.\r\n   *\r\n   * <p>Visitor-level and persisted in `localStorage`, so it outlives the tab. The tray exposes the\r\n   * same preference as a toggle; this is for host apps that keep sound settings of their own.\r\n   */\r\n  setPopupSoundEnabled(enabled: boolean): void {\r\n    this.eventTracker.setPopupSoundEnabled(enabled);\r\n  }\r\n\r\n  ngOnDestroy(): void {\r\n    this.eventTracker.unsubscribe();\r\n  }\r\n}\r\n","import { Directive, HostListener, Input } from '@angular/core';\r\nimport { ANALYTICS_ACTION, ANALYTICS_ACTION_STATE } from '@nommos/core';\r\nimport { TrackerService } from '../../services/tracker/tracker.service';\r\n\r\n/**\r\n * TrackClickDirective\r\n * --------------------\r\n * An attribute directive that automatically pushes setup action with associated information on clicks\r\n *\r\n * @example\r\n * ```html\r\n * <button\r\n *   [nommosTrackClick]=\"ANALYTICS_ACTION_GROUPS.REGISTRATION\"\r\n * >\r\n *   Sign Up\r\n * </button>\r\n * ```\r\n */\r\n@Directive({\r\n  selector: '[nommosTrackClick]',\r\n  standalone: false,\r\n})\r\nexport class TrackClickDirective {\r\n  /**\r\n   * The action to be tracked.\r\n   * @type {ANALYTICS_ACTION}\r\n   */\r\n  @Input('nommosTrackClick') action!: ANALYTICS_ACTION;\r\n\r\n  /**\r\n   * The state of the action carried to be tracked.\r\n   * @default ANALYTICS_ACTION_STATE.SELECT\r\n   * @type {ANALYTICS_ACTION_STATE}\r\n   */\r\n  @Input() state: ANALYTICS_ACTION_STATE = ANALYTICS_ACTION_STATE.SELECT;\r\n\r\n  /**\r\n   * Optional Information on the action carried out being tracked.\r\n   * @type {Record<string, unknown>}\r\n   */\r\n  @Input() data?: Record<string, unknown>;\r\n\r\n  /**\r\n   * Permits to toggle the selection state (ANALYTICS_ACTION_STATE.SELECT to/from ANALYTICS_ACTION_STATE.UN_SELECT)\r\n   * of an action by any element when clicked.\r\n   * **Default:** `true`\r\n   * @type {boolean}\r\n   */\r\n  @Input() toggle = true;\r\n\r\n  /**\r\n   * Permits multiple elements to change the selection state of an action.\r\n   * It has priority over the **toggle** input.\r\n   * **Default:** `false`\r\n   * @type {boolean}\r\n   */\r\n  @Input() multi = false;\r\n\r\n  /**\r\n   * The user ID associated to the current user carrying out the action.\r\n   * **Default:** `''`\r\n   * @type {string}\r\n   */\r\n  @Input() userId = '';\r\n  clicked = false;\r\n\r\n  constructor(private readonly trackerService: TrackerService) {}\r\n\r\n  @HostListener('click')\r\n  onClick(): void {\r\n    if (this.multi) {\r\n      this.clicked = !this.clicked;\r\n      this.trackerService.trackEvent(\r\n        this.action,\r\n        this.state,\r\n        this.data,\r\n        this.toggle,\r\n        this.clicked,\r\n        this.userId\r\n      );\r\n    } else {\r\n      this.trackerService.trackEvent(\r\n        this.action,\r\n        this.state,\r\n        this.data,\r\n        this.toggle,\r\n        null,\r\n        this.userId\r\n      );\r\n    }\r\n  }\r\n}\r\n","import { Directive, HostListener, Input } from '@angular/core';\r\nimport { ANALYTICS_ACTION, ANALYTICS_ACTION_STATE } from '@nommos/core';\r\nimport { TrackerService } from '../../services/tracker/tracker.service';\r\n\r\n/**\r\n * TrackSubmitDirective\r\n * --------------------\r\n * An attribute directive that automatically pushes setup action with associated information on form submissions\r\n *\r\n * @example\r\n * ```html\r\n * <button\r\n *   [nommosTrackSubmit]=\"ANALYTICS_ACTION_GROUPS.REGISTRATION\"\r\n * >\r\n *   Sign Up\r\n * </button>\r\n * ```\r\n */\r\n@Directive({\r\n  selector: '[nommosTrackSubmit]',\r\n  standalone: false,\r\n})\r\nexport class TrackSubmitDirective {\r\n  /**\r\n   * The action to be tracked.\r\n   * @type {ANALYTICS_ACTION}\r\n   */\r\n  @Input('nommosTrackSubmit') action!: ANALYTICS_ACTION;\r\n\r\n  /**\r\n   * Optional Information on the action carried out being tracked.\r\n   * @type {Record<string, unknown>}\r\n   */\r\n  @Input() data?: Record<string, unknown>;\r\n\r\n\r\n  /**\r\n   * The user ID associated to the current user carrying out the action.\r\n   * @default ''\r\n   * @type {string}\r\n   */\r\n  @Input() userId = '';\r\n\r\n  constructor(private readonly trackerService: TrackerService) {}\r\n\r\n  @HostListener('ngSubmit')\r\n  @HostListener('submit')\r\n  onClick(): void {\r\n    this.trackerService.trackEvent(\r\n      this.action,\r\n      ANALYTICS_ACTION_STATE.SUBMIT,\r\n      this.data,\r\n      false,\r\n      null,\r\n      this.userId\r\n    );\r\n  }\r\n}\r\n","import { ModuleWithProviders, NgModule, Provider } from '@angular/core';\r\nimport { CommonModule } from '@angular/common';\r\nimport { ConnectionConfig, EventTracker, UrlTrackingKey } from '@nommos/core';\r\nimport { TrackerService } from './services/tracker/tracker.service';\r\nimport { TrackClickDirective, TrackSubmitDirective } from './directives';\r\n\r\n@NgModule({\r\n  declarations: [TrackClickDirective, TrackSubmitDirective],\r\n  imports: [CommonModule],\r\n  exports: [TrackClickDirective, TrackSubmitDirective],\r\n})\r\nexport class ActivityTrackerModule {\r\n  /**\r\n   * Registers the ActivityTrackerModule using the Angular `forRoot()` pattern.\r\n   *\r\n   * This is intended for NgModule-based applications. It initializes the\r\n   * analytics engine with the provided connection configuration and URL\r\n   * tracking key.\r\n   *\r\n   * @param config - Connection configuration used by the `EventTracker` (a token)\r\n   * @param urlTrackingKey - Optional key for extracting tracking identifiers\r\n   *                         from the URL (e.g affiliate key)\r\n   * @returns A `ModuleWithProviders` containing the module and its providers\r\n   */\r\n\r\n  static forRoot(\r\n    config: ConnectionConfig,\r\n    urlTrackingKey: UrlTrackingKey\r\n  ): ModuleWithProviders<ActivityTrackerModule> {\r\n    return {\r\n      ngModule: ActivityTrackerModule,\r\n      providers: [\r\n        {\r\n          provide: EventTracker,\r\n          useValue: new EventTracker(config, urlTrackingKey),\r\n        },\r\n        TrackerService,\r\n      ],\r\n    };\r\n  }\r\n}\r\n\r\n/**\r\n * Standalone-friendly provider registration for the Activity Tracker.\r\n *\r\n * This function is recommended for Angular applications using the\r\n * Standalone API (`bootstrapApplication`) and cannot use `forRoot()`.\r\n *\r\n * @example\r\n * ```ts\r\n * bootstrapApplication(AppComponent, {\r\n *   providers: [\r\n *     ...provideActivityTracker(config, urlTrackingKey)\r\n *   ]\r\n * });\r\n * ```\r\n *\r\n * @param config - Connection configuration used by `EventTracker`\r\n * @param urlTrackingKey - Key used to extract tracking identifiers from URLs\r\n * @returns An array of Angular providers for use in standalone environments\r\n */\r\nexport function provideActivityTracker(\r\n  config: ConnectionConfig,\r\n  urlTrackingKey: UrlTrackingKey\r\n): Provider[] {\r\n  return [\r\n    {\r\n      provide: EventTracker,\r\n      useValue: new EventTracker(config, urlTrackingKey),\r\n    },\r\n    TrackerService,\r\n  ];\r\n}\r\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["i1.TrackerService"],"mappings":";;;;;;;AASA;;;;;;;;;;;;AAYG;MAKU,cAAc,CAAA;AAEN,IAAA,YAAA;AACA,IAAA,MAAA;IAFnB,WAAA,CACmB,YAA0B,EAC1B,MAAc,EAAA;QADd,IAAA,CAAA,YAAY,GAAZ,YAAY;QACZ,IAAA,CAAA,MAAM,GAAN,MAAM;IACtB;AAEH;;;;;;;;;AASG;AACH,IAAA,UAAU,CACR,MAAwB,EACxB,KAA6B,EAC7B,OAAuC,IAAI,EAC3C,MAAM,GAAG,IAAI,EACb,QAAA,GAA2B,IAAI,EAC/B,MAAM,GAAG,EAAE,EAAA;QAEX,IAAI,CAAC,YAAY,CAAC,UAAU,CAC1B,MAAM,EACN,KAAK,EACL,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,MAAM,EACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAChB;IACH;AAEA;;;;;;;AAOG;AACH,IAAA,SAAS,CAAC,OAAgB,EAAA;QACxB,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC;IAC9C;AAEA;;;AAGG;IACH,aAAa,GAAA;AACX,QAAA,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;IACrC;AAEA;;;;;AAKG;AACH,IAAA,oBAAoB,CAAC,OAAgB,EAAA;AACnC,QAAA,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,OAAO,CAAC;IACjD;IAEA,WAAW,GAAA;AACT,QAAA,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE;IACjC;wGAnEW,cAAc,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAAA,EAAA,CAAA,YAAA,EAAA,EAAA,EAAA,KAAA,EAAA,EAAA,CAAA,MAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAd,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,cAAc,cAFb,MAAM,EAAA,CAAA;;4FAEP,cAAc,EAAA,UAAA,EAAA,CAAA;kBAH1B,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE,MAAM;AACnB,iBAAA;;;ACrBD;;;;;;;;;;;;;AAaG;MAKU,mBAAmB,CAAA;AA4CD,IAAA,cAAA;AA3C7B;;;AAGG;AACwB,IAAA,MAAM;AAEjC;;;;AAIG;AACM,IAAA,KAAK,GAA2B,sBAAsB,CAAC,MAAM;AAEtE;;;AAGG;AACM,IAAA,IAAI;AAEb;;;;;AAKG;IACM,MAAM,GAAG,IAAI;AAEtB;;;;;AAKG;IACM,KAAK,GAAG,KAAK;AAEtB;;;;AAIG;IACM,MAAM,GAAG,EAAE;IACpB,OAAO,GAAG,KAAK;AAEf,IAAA,WAAA,CAA6B,cAA8B,EAAA;QAA9B,IAAA,CAAA,cAAc,GAAd,cAAc;IAAmB;IAG9D,OAAO,GAAA;AACL,QAAA,IAAI,IAAI,CAAC,KAAK,EAAE;AACd,YAAA,IAAI,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO;AAC5B,YAAA,IAAI,CAAC,cAAc,CAAC,UAAU,CAC5B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,MAAM,CACZ;QACH;aAAO;YACL,IAAI,CAAC,cAAc,CAAC,UAAU,CAC5B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,EACJ,IAAI,CAAC,MAAM,CACZ;QACH;IACF;wGApEW,mBAAmB,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAAAA,cAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,SAAA,EAAA,CAAA;4FAAnB,mBAAmB,EAAA,YAAA,EAAA,KAAA,EAAA,QAAA,EAAA,oBAAA,EAAA,MAAA,EAAA,EAAA,MAAA,EAAA,CAAA,kBAAA,EAAA,QAAA,CAAA,EAAA,KAAA,EAAA,OAAA,EAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,QAAA,EAAA,KAAA,EAAA,OAAA,EAAA,MAAA,EAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,SAAA,EAAA,EAAA,OAAA,EAAA,WAAA,EAAA,EAAA,EAAA,QAAA,EAAA,EAAA,EAAA,CAAA;;4FAAnB,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAJ/B,SAAS;AAAC,YAAA,IAAA,EAAA,CAAA;AACT,oBAAA,QAAQ,EAAE,oBAAoB;AAC9B,oBAAA,UAAU,EAAE,KAAK;AAClB,iBAAA;;sBAME,KAAK;uBAAC,kBAAkB;;sBAOxB;;sBAMA;;sBAQA;;sBAQA;;sBAOA;;sBAKA,YAAY;uBAAC,OAAO;;;AChEvB;;;;;;;;;;;;;AAaG;MAKU,oBAAoB,CAAA;AAqBF,IAAA,cAAA;AApB7B;;;AAGG;AACyB,IAAA,MAAM;AAElC;;;AAGG;AACM,IAAA,IAAI;AAGb;;;;AAIG;IACM,MAAM,GAAG,EAAE;AAEpB,IAAA,WAAA,CAA6B,cAA8B,EAAA;QAA9B,IAAA,CAAA,cAAc,GAAd,cAAc;IAAmB;IAI9D,OAAO,GAAA;QACL,IAAI,CAAC,cAAc,CAAC,UAAU,CAC5B,IAAI,CAAC,MAAM,EACX,sBAAsB,CAAC,MAAM,EAC7B,IAAI,CAAC,IAAI,EACT,KAAK,EACL,IAAI,EACJ,IAAI,CAAC,MAAM,CACZ;IACH;wGAlCW,oBAAoB,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAAAA,cAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,SAAA,EAAA,CAAA;4FAApB,oBAAoB,EAAA,YAAA,EAAA,KAAA,EAAA,QAAA,EAAA,qBAAA,EAAA,MAAA,EAAA,EAAA,MAAA,EAAA,CAAA,mBAAA,EAAA,QAAA,CAAA,EAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,SAAA,EAAA,EAAA,UAAA,EAAA,WAAA,EAAA,QAAA,EAAA,WAAA,EAAA,EAAA,EAAA,QAAA,EAAA,EAAA,EAAA,CAAA;;4FAApB,oBAAoB,EAAA,UAAA,EAAA,CAAA;kBAJhC,SAAS;AAAC,YAAA,IAAA,EAAA,CAAA;AACT,oBAAA,QAAQ,EAAE,qBAAqB;AAC/B,oBAAA,UAAU,EAAE,KAAK;AAClB,iBAAA;;sBAME,KAAK;uBAAC,mBAAmB;;sBAMzB;;sBAQA;;sBAIA,YAAY;uBAAC,UAAU;;sBACvB,YAAY;uBAAC,QAAQ;;;MCnCX,qBAAqB,CAAA;AAChC;;;;;;;;;;;AAWG;AAEH,IAAA,OAAO,OAAO,CACZ,MAAwB,EACxB,cAA8B,EAAA;QAE9B,OAAO;AACL,YAAA,QAAQ,EAAE,qBAAqB;AAC/B,YAAA,SAAS,EAAE;AACT,gBAAA;AACE,oBAAA,OAAO,EAAE,YAAY;AACrB,oBAAA,QAAQ,EAAE,IAAI,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC;AACnD,iBAAA;gBACD,cAAc;AACf,aAAA;SACF;IACH;wGA5BW,qBAAqB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,QAAA,EAAA,CAAA;yGAArB,qBAAqB,EAAA,YAAA,EAAA,CAJjB,mBAAmB,EAAE,oBAAoB,aAC9C,YAAY,CAAA,EAAA,OAAA,EAAA,CACZ,mBAAmB,EAAE,oBAAoB,CAAA,EAAA,CAAA;AAExC,IAAA,OAAA,IAAA,GAAA,EAAA,CAAA,mBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,qBAAqB,YAHtB,YAAY,CAAA,EAAA,CAAA;;4FAGX,qBAAqB,EAAA,UAAA,EAAA,CAAA;kBALjC,QAAQ;AAAC,YAAA,IAAA,EAAA,CAAA;AACR,oBAAA,YAAY,EAAE,CAAC,mBAAmB,EAAE,oBAAoB,CAAC;oBACzD,OAAO,EAAE,CAAC,YAAY,CAAC;AACvB,oBAAA,OAAO,EAAE,CAAC,mBAAmB,EAAE,oBAAoB,CAAC;AACrD,iBAAA;;AAgCD;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,sBAAsB,CACpC,MAAwB,EACxB,cAA8B,EAAA;IAE9B,OAAO;AACL,QAAA;AACE,YAAA,OAAO,EAAE,YAAY;AACrB,YAAA,QAAQ,EAAE,IAAI,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC;AACnD,SAAA;QACD,cAAc;KACf;AACH;;ACxEA;;AAEG;;;;"}

package/index.d.ts

@@ -1,6 +1,6 @@
 import * as i0 from '@angular/core';
 import { OnDestroy, ModuleWithProviders, Provider } from '@angular/core';
-import { EventTracker, ANALYTICS_ACTION, ANALYTICS_ACTION_STATE, ConnectionConfig, UrlTrackingKey } from '@nommos/core';
+import { EventTracker, ANALYTICS_ACTION, ANALYTICS_ACTION_STATE, WebPopupInboxState, ConnectionConfig, UrlTrackingKey } from '@nommos/core';
 import { Router } from '@angular/router';
 import * as i3 from '@angular/common';
 
@@ -32,6 +32,27 @@ declare class TrackerService implements OnDestroy {
      * @param userId - Optional: user ID associated to the current user carrying out the action.
      */
     trackEvent(action: ANALYTICS_ACTION, state: ANALYTICS_ACTION_STATE, data?: Record<string, unknown> | null, toggle?: boolean, selected?: boolean | null, userId?: string): void;
+    /**
+     * Opens a web popup directly, bypassing the notification tray.
+     *
+     * <p>The SDK already draws its own bell and tray, so a host app needs this only to drive the
+     * viewer from its own UI — a "what's new" link, or restoring a popup after a route change.
+     *
+     * @param popupId - Optional: which popup to open. Defaults to the highest-ranked one.
+     */
+    openPopup(popupId?: number): Promise<void>;
+    /**
+     * The current inbox and its unread count, for a host app rendering its own badge instead of
+     * (or alongside) the SDK's bell.
+     */
+    getPopupInbox(): WebPopupInboxState;
+    /**
+     * Mutes or unmutes the chime played when a popup arrives mid-session.
+     *
+     * <p>Visitor-level and persisted in `localStorage`, so it outlives the tab. The tray exposes the
+     * same preference as a toggle; this is for host apps that keep sound settings of their own.
+     */
+    setPopupSoundEnabled(enabled: boolean): void;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TrackerService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TrackerService>;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@nommos/events_angular",
-  "version": "0.0.43",
+  "version": "0.0.45",
   "peerDependencies": {
     "@angular/common": ">=12.0.0 <=22.0.0",
     "@angular/core": ">=12.0.0 <=22.0.0",
     "@angular/router": ">=12.0.0 <=22.0.0"
   },
   "dependencies": {
-    "@nommos/core": "0.0.42",
+    "@nommos/core": "0.0.45",
     "tslib": "^2.3.0"
   },
   "engines": {