@bloomscorp/ngx-bloomsight 1.5.1 → 2.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Bloomscorp]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,144 +1,276 @@
-# ngx-bloomsight
-
-A client side angular library to work with bloomsight.io
-
-## Badges
-
-[![ License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE.md)
-
-## Installation
-
-Install using `npm` by running
-
-```bash
-npm install @bloomscorp/ngx-bloomsight
-```
-
-## Usage/Examples
-
-
-### Configuration
-
-Use the `app.module.ts` to configure the library.
-
-```ts
-import {NgxBloomsightModule} from '@bloomscorp/ngx-bloomsight';
-
-@NgModule({
-    declarations: [AppComponent],
-    imports: [
-        BrowserModule,
-        AppRoutingModule,
-        NgxBloomsightModule.forRoot({
-            propertyToken: '65143f755c403e030c222340',
-            isDevelopmentMode: true,
-            stopAll: false,
-            ...
-        }),
-    ],
-    providers: [],
-    bootstrap: [AppComponent]
-})
-export class AppModule { }
-```
-
-Below is the table with all the possible options that can be configured.
-
-| Option                 | Type      | Description                                                                                                                                 | Mandatory | Default |
-|:-----------------------|:----------|:--------------------------------------------------------------------------------------------------------------------------------------------|:----------|:--------|
-| `propertyToken`        | `string`  | [bloomsight.io](https://bloomsight.io) property token                                                                                       | ✅         | NA      |
-| `isDevelopmentMode`    | `boolean` | if `true`, then logs data in the browser console                                                                                            | ✅         | NA      |
-| `observePageViaWebAPI` | `boolean` | if `true`, will detect page view event based on web APIs. However, if `false`, `pageViewObserver` should be used to trigger page view event | ❌         | `true`  |
-| `stopSimpleEvent`      | `boolean` | stops only simple event tracking                                                                                                            | ❌         | `false` |
-| `stopDataEvent`        | `boolean` | stops only data event tracking                                                                                                              | ❌         | `false` |
-| `stopPageViewEvent`    | `boolean` | stops only page view event tracking                                                                                                         | ❌         | `false` |
-| `stopAll`              | `boolean` | stops all event tracking                                                                                                                    | ❌         | `false` |
-| `logOnly`              | `boolean` | tracks event but doesn't save to database. Should be used only when `isDevelopmentMode: true`                                               | ❌         | `false` |
-
-
-## Page View Event
-To tracking website visits for your angular application just initialize `BloomsightEventService` service in  `app.component.ts`.
-
-```ts
-import {BloomsightEventService} from '@bloomscorp/ngx-bloomsight';
-
-constructor(public bloomsightService: BloomsightEventService) { }
-```
-
-### Simple Event
-
-Use the `resolveSimpleEvent` method to log simple events
-
-```ts
-import {BloomsightEventService} from '@bloomscorp/ngx-bloomsight';
-
-constructor(public bloomsightService: BloomsightEventService) { }
-
-this.bloomsightService
-    .resolveSimpleEvent('65d735b122354c8ba6a489c2', 'Contact Us CTA button');
-```
-| Option       | Type     | Description        | Mandatory | Default |
-|:-------------|:---------|:-------------------|:----------|:--------|
-| `eventToken` | `string` | Id of simple event | ✅         | NA      |
-| `label`      | `string` | a label/name for the event for future reference | ❌         | ''      |
-
-
-### Data Event
-
-Use the `resolveDataEvent` method to log data events
-
-```ts
-import {BloomsightEventService} from '@bloomscorp/ngx-bloomsight';
-
-constructor(public bloomsightService: BloomsightEventService) { }
-
-this.bloomsightService.resolveDataEvent(
-    '66d735b122355c8ba6a456f8', 
-    {
-        productId: 120,
-        sku: 'PROD021298'
-    },
-    'Add to Wishlist CTA button'
-);
-```
-| Option       | Type     | Description                              | Mandatory | Default |
-|:-------------|:---------|:-----------------------------------------|:----------|:--------|
-| `eventToken` | `string` | Id of data event                         | ✅         | NA      |
-| `eventData`  | `Object` | additional metadata in key, value format | ✅         | NA      |
-| `label`      | `string` | a label/name for the event for future reference | ❌         | ''      |
-
-
-### Send Email
-
-Use `sendEmail` method to send email
-
-```ts
-import {BloomsightMailService} from '@bloomscorp/ngx-bloomsight';
-
-constructor(public bloomsightMailService: BloomsightMailService) { }
-
-this.bloomsightMailService.sendEmail(
-  '66d735b122355c8ba6a456f8', 
-  '63d735h822355s6ba6a4556k',
-  '61d895h922355b6ba6a4587a',
-  ...
-)
-```
-
-| Option            | Type       | Description                                                                                | Mandatory | Default |
-|:------------------|:-----------|:-------------------------------------------------------------------------------------------|:----------|:--------|
-| `engineId`        | `string`   | Id of the engine that will be used to send email                                           | ✅         | NA      |
-| `templateId`      | `string`   | Id of the email template that will be used as email body                                   | ✅         | NA      |
-| `templateOwnerId` | `string`   | Id of the user who has created the template                                                | ✅         | NA      |
-| `emailMetaData`   | `FormData` | attachment & variables used in the template & their respective values in key, value format | ✅          | NA      |
-| `onSuccess`   | `function` | pass a function to trigger on successfully sending email | ✅         | NA      |
-| `onError`   | `function` | pass a function to trigger when an error occurs | ✅          | NA      |
-
-## License
-
-[MIT](./LICENSE.md)
-
-
-## Support
-
-Report issues or feature requests [here]()
+# @bloomscorp/ngx-bloomsight
+
+Bloomsight analytics for Angular: events, page views, mail and failure
+reporting, through one provider and one service.
+
+It wraps [`@bloomscorp/bloomsight.js`](https://www.npmjs.com/package/@bloomscorp/bloomsight.js)
+and works with both backends: the standalone Bloomsight server, and Bloomsight
+inside blooms.ai.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/bloomscorp/ngx-bloomsight/blob/main/LICENSE.md)
+
+> **Upgrading from 1.x?** 2.0.0 replaces `NgxBloomsightModule.forRoot()` and the
+> two services. See the [migration guide](https://github.com/bloomscorp/ngx-bloomsight/blob/main/MIGRATION.md).
+
+## Requirements
+
+| | Supported |
+|---|---|
+| Angular (`@angular/core`, `common`, `router`) | **19, 20, 21, 22**. CI compiles the published package with each of them |
+| `@bloomscorp/bloomsight.js` | `>=0.9.2 <1.0.0` |
+| RxJS | 7 or 8 |
+
+## Install
+
+```bash
+npm install @bloomscorp/ngx-bloomsight @bloomscorp/bloomsight.js
+```
+
+`@bloomscorp/bloomsight.js` is a peer dependency: install it, but never import
+it. Everything your app needs comes from `@bloomscorp/ngx-bloomsight` (see
+[Types](#types)).
+
+## Set up
+
+Call `provideBloomsight()` once, in the application's root providers:
+
+```ts
+// app.config.ts
+import {ApplicationConfig} from '@angular/core';
+import {provideRouter} from '@angular/router';
+import {provideBloomsight} from '@bloomscorp/ngx-bloomsight';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideRouter(routes),
+    provideBloomsight({
+      propertyToken: '65d72f0b5e990c6028790156',
+      isDevelopmentMode: false
+    })
+  ]
+};
+```
+
+An app that still bootstraps an `AppModule` puts the same call in that module's
+`providers`:
+
+```ts
+@NgModule({
+  // …
+  providers: [provideBloomsight({propertyToken: '…', isDevelopmentMode: false})]
+})
+export class AppModule {}
+```
+
+That is all the setup. The SDK starts when the app starts, page views are
+recorded from the router, and `BloomsightService` can be injected anywhere,
+including lazy-loaded routes.
+
+Call it **once**, in the root providers: not in a lazy route's `providers`, and
+not in a component.
+
+## Configuration
+
+| Field | Type | Default | What it does |
+|---|---|---|---|
+| `propertyToken` | `string` | **required** | The property's token. Never regenerate it: the token is how events are attributed |
+| `isDevelopmentMode` | `boolean` | **required** | Logs everything to the console, and skips checking the property against the page's host. Never ship `true` to production |
+| `target` | `'bloomsight'` \| `'blooms-ai'` | `'bloomsight'` | Which backend receives events. See [Moving to blooms.ai](#moving-to-bloomsai) |
+| `apiBase` | `string` | `https://z.bloomscorp.com` | blooms.ai only: the API origin, for pointing a project at staging first |
+| `logOnly` | `boolean` | `false` | Runs everything and sends nothing: each event and mail is logged instead. For demos, tests and dry runs |
+| `debug` | `boolean` | `false` | blooms.ai only: full logging without `isDevelopmentMode` |
+| `onError` | `(error: BloomsightError) => void` | — | Called for every failure the SDK reports. See [Errors](#errors) |
+| `stopAll` | `boolean` | `false` | Records nothing |
+| `stopSimpleEvent` | `boolean` | `false` | Records no simple events |
+| `stopDataEvent` | `boolean` | `false` | Records no data events |
+| `stopPageViewEvent` | `boolean` | `false` | Records no page views |
+
+The SDK reads its configuration once, when the app starts.
+
+## Events
+
+```ts
+import {Component, inject} from '@angular/core';
+import {BloomsightService} from '@bloomscorp/ngx-bloomsight';
+
+@Component({/* … */})
+export class PricingComponent {
+  private readonly bloomsight = inject(BloomsightService);
+
+  contactUs(): void {
+    this.bloomsight.track('65d735b122354c8ba6a489c2');
+  }
+
+  choosePlan(plan: string, seats: number): void {
+    this.bloomsight.trackData('66d735b122355c8ba6a456f8', {plan, seats});
+  }
+}
+```
+
+| Method | Records |
+|---|---|
+| `track(eventToken)` | a simple event |
+| `trackData(eventToken, data)` | a data event, with `data` as a JSON-serialisable object |
+
+The event token comes from the Bloomsight dashboard, where the event is defined.
+
+## Page views
+
+Recorded automatically, with no code in your app:
+
+- **Once per new destination.** A view is recorded each time a navigation lands
+  somewhere new, by the URL the user ends up on after redirects. Following a
+  link that redirects to the current page is not a new view
+- **Standalone Bloomsight server only.** blooms.ai has no page-view endpoint, so
+  with `target: 'blooms-ai'` the router is not watched at all
+- **After two seconds.** The SDK records a view only once the visitor has spent
+  two seconds on the page
+
+`stopPageViewEvent: true` turns them off.
+
+## Mail
+
+```ts
+import {BloomsightError, BloomsightService} from '@bloomscorp/ngx-bloomsight';
+
+const data = new FormData();
+data.append('name', form.name);
+data.append('email', form.email);
+
+this.bloomsight.sendMail({
+  engineId: '66d735b122355c8ba6a456f8',
+  templateId: '63d735h822355s6ba6a4556k',
+  templateOwnerId: '61d895h922355b6ba6a4587a',
+  data,
+  engine: 'GMAIL'                      // or 'CUSTOM_SMTP'; defaults to 'GMAIL'
+}).subscribe({
+  next: () => this.sent.set(true),
+  error: (error: BloomsightError) => this.failure.set(error.message)
+});
+```
+
+| Field | Required | |
+|---|---|---|
+| `engineId` | ✅ | The mail engine, from the dashboard |
+| `templateId` | ✅ | The template to render |
+| `templateOwnerId` | ✅ | The user who owns the template |
+| `data` | ✅ | The template's values; each field arrives as `metadata[<name>]` |
+| `engine` | | `'GMAIL'` or `'CUSTOM_SMTP'`. Defaults to `'GMAIL'` |
+
+The result behaves like `HttpClient`:
+
+- **Nothing is sent until you subscribe**, and each subscription sends once
+- It emits once and completes when the server accepts the mail
+- It errors with a `BloomsightError` (`code: 'MAIL_FAILED'`) when the server
+  rejects it or cannot be reached
+- Under `logOnly` the mail is logged, not sent, and the result still emits and
+  completes, so a "sending…" state is always released
+
+Mail always goes to the standalone Bloomsight server, whatever `target` is set
+to.
+
+## Errors
+
+On blooms.ai, every failed request is reported, with the server's own code
+where there is one (`ORIGIN_REJECTED`, `UNKNOWN_PROPERTY`, `NETWORK_FAILURE`,
+…). There are two ways to receive them:
+
+```ts
+// 1. In the configuration. Called for every failure, including at startup.
+provideBloomsight({
+  propertyToken: '…',
+  isDevelopmentMode: false,
+  target: 'blooms-ai',
+  onError: (error) => monitoring.report(error)
+});
+
+// 2. As a stream, anywhere.
+inject(BloomsightService).errors$.subscribe((error) => console.warn(error.code, error.message));
+
+// …or the latest one as a signal, for a template.
+readonly lastError = toSignal(inject(BloomsightService).errors$);
+```
+
+- **`errors$` only sees what comes after you subscribe.** It emits the failures
+  that happen after that point, not earlier ones
+- **A failed start doesn't stop your app.** If the SDK fails to start, the app
+  keeps running without it. The failure (`INIT_FAILED`) is reported to `onError`
+  and the console, on either target. It is not on `errors$`, because startup
+  happens before anything can subscribe
+- **Mail failures stay with the mail.** They are the error of that `sendMail()`
+  call, not on `errors$`
+- **The standalone server reports almost nothing.** There the SDK reports no
+  request failures; only `INIT_FAILED` reaches `onError`
+
+## Moving to blooms.ai
+
+Change the target. The property token and every call site stay the same:
+
+```ts
+provideBloomsight({
+  propertyToken: '65d72f0b5e990c6028790156',   // unchanged
+  isDevelopmentMode: false,
+  target: 'blooms-ai',
+  apiBase: 'https://staging.example.com',      // optional: try staging first
+  onError: (error) => monitoring.report(error)
+});
+```
+
+On blooms.ai:
+
+- events go to blooms.ai, and never to the standalone server
+- page views are not collected
+- mail is unchanged: it still goes to the standalone server
+- failures are reported through `onError` and `errors$`
+
+## Server-side rendering
+
+Nothing runs on the server. The SDK starts in the browser, `track` and
+`trackData` do nothing during server rendering, and `sendMail` completes without
+sending.
+
+## Types
+
+Everything is exported from `@bloomscorp/ngx-bloomsight`:
+
+| Export | |
+|---|---|
+| `provideBloomsight(config)` | Sets up the SDK |
+| `BloomsightService` | `track`, `trackData`, `sendMail`, `errors$` |
+| `BLOOMSIGHT_CONFIG` | Injection token holding the configuration the app started with |
+| `BloomsightConfig` | The configuration |
+| `BloomsightError` | `{code, message, status?, eventToken?}` |
+| `BloomsightEmailEngine` | `'GMAIL' \| 'CUSTOM_SMTP'` |
+| `BloomsightMailRequest` | What `sendMail` takes |
+| `BloomsightEventData` | What `trackData` takes |
+
+**Don't import `@bloomscorp/bloomsight.js` in your app.** If something you need
+is not exported here, that's a gap in this library: please
+[open an issue](https://github.com/bloomscorp/ngx-bloomsight/issues).
+
+## Testing your app
+
+Use `logOnly` in tests, so nothing is sent:
+
+```ts
+TestBed.configureTestingModule({
+  providers: [provideBloomsight({propertyToken: 'test', isDevelopmentMode: false, logOnly: true})]
+});
+```
+
+In a jsdom test environment (Vitest or Jest), the SDK reads `window.matchMedia`
+at startup, and jsdom doesn't have it. Your tests still pass, but the SDK
+reports `INIT_FAILED` and stays off. To run it for real, stub `matchMedia` in
+your test setup file:
+
+```ts
+window.matchMedia ??= (query: string) => ({
+  matches: false, media: query, onchange: null,
+  addListener: () => {}, removeListener: () => {},
+  addEventListener: () => {}, removeEventListener: () => {}, dispatchEvent: () => false
+}) as MediaQueryList;
+```
+
+## License
+
+[MIT](https://github.com/bloomscorp/ngx-bloomsight/blob/main/LICENSE.md)

package/fesm2022/bloomscorp-ngx-bloomsight.mjs

@@ -0,0 +1,168 @@
+import * as i0 from "@angular/core";
+import { DestroyRef, Injectable, InjectionToken, PLATFORM_ID, inject, makeEnvironmentProviders, provideAppInitializer } from "@angular/core";
+import { isPlatformBrowser } from "@angular/common";
+import { takeUntilDestroyed } from "@angular/core/rxjs-interop";
+import { NavigationEnd, Router } from "@angular/router";
+import { Observable, Subject, distinctUntilChanged, filter, map } from "rxjs";
+import { init, pageViewObserver, resolveDataEvent, resolveSimpleEvent, sendEmail } from "@bloomscorp/bloomsight.js";
+const BLOOMSIGHT_CONFIG = new InjectionToken("BLOOMSIGHT_CONFIG");
+var BloomsightErrors = class BloomsightErrors {
+	constructor() {
+		this.failures = new Subject();
+		this.errors$ = this.failures.asObservable();
+	}
+	report(error) {
+		this.failures.next(error);
+	}
+	static {
+		this.ɵfac = i0.ɵɵngDeclareFactory({
+			minVersion: "12.0.0",
+			version: "22.2.2",
+			ngImport: i0,
+			type: BloomsightErrors,
+			deps: [],
+			target: i0.ɵɵFactoryTarget.Injectable
+		});
+	}
+	static {
+		this.ɵprov = i0.ɵɵngDeclareInjectable({
+			minVersion: "12.0.0",
+			version: "22.2.2",
+			ngImport: i0,
+			type: BloomsightErrors,
+			providedIn: "root"
+		});
+	}
+};
+i0.ɵɵngDeclareClassMetadata({
+	minVersion: "12.0.0",
+	version: "22.2.2",
+	ngImport: i0,
+	type: BloomsightErrors,
+	decorators: [{
+		type: Injectable,
+		args: [{ providedIn: "root" }]
+	}]
+});
+function startBloomsight() {
+	if (!isPlatformBrowser(inject(PLATFORM_ID))) return;
+	const config = inject(BLOOMSIGHT_CONFIG);
+	initialise(config, inject(BloomsightErrors));
+	observePageViews(config, inject(Router), inject(DestroyRef));
+}
+function initialise(config, errors) {
+	try {
+		init({
+			...config,
+			onError: (error) => {
+				errors.report(error);
+				config.onError?.(error);
+			}
+		});
+	} catch (cause) {
+		reportInitFailure(config, cause);
+	}
+}
+function reportInitFailure(config, cause) {
+	const error = {
+		code: "INIT_FAILED",
+		message: `bloomsight.js failed to initialise: ${cause instanceof Error ? cause.message : String(cause)}`
+	};
+	console.error("ngx-bloomsight:", error.message);
+	try {
+		config.onError?.(error);
+	} catch {}
+}
+function observePageViews(config, router, destroyRef) {
+	if (config.target === "blooms-ai") {
+		if (config.debug || config.isDevelopmentMode) console.log("ngx-bloomsight: page views are not collected on blooms.ai, so the router is not observed");
+		return;
+	}
+	router.events.pipe(filter((event) => event instanceof NavigationEnd), map((event) => event.urlAfterRedirects), distinctUntilChanged(), takeUntilDestroyed(destroyRef)).subscribe(() => pageViewObserver());
+}
+function provideBloomsight(config) {
+	return makeEnvironmentProviders([{
+		provide: BLOOMSIGHT_CONFIG,
+		useValue: config
+	}, provideAppInitializer(startBloomsight)]);
+}
+var BloomsightService = class BloomsightService {
+	constructor() {
+		this.config = requireConfig();
+		this.isBrowser = isPlatformBrowser(inject(PLATFORM_ID));
+		this.errors$ = inject(BloomsightErrors).errors$;
+	}
+	track(eventToken) {
+		if (this.isBrowser) resolveSimpleEvent(eventToken);
+	}
+	trackData(eventToken, data) {
+		if (this.isBrowser) resolveDataEvent(eventToken, data);
+	}
+	sendMail(request) {
+		return new Observable((subscriber) => {
+			if (!this.isBrowser) {
+				subscriber.complete();
+				return;
+			}
+			const succeed = () => {
+				subscriber.next();
+				subscriber.complete();
+			};
+			const fail = (cause) => subscriber.error(mailFailure(cause));
+			try {
+				sendEmail(request.engine ?? "GMAIL", request.engineId, request.templateId, request.templateOwnerId, request.data, succeed, () => fail());
+			} catch (cause) {
+				fail(cause);
+				return;
+			}
+			if (this.config.logOnly) succeed();
+		});
+	}
+	static {
+		this.ɵfac = i0.ɵɵngDeclareFactory({
+			minVersion: "12.0.0",
+			version: "22.2.2",
+			ngImport: i0,
+			type: BloomsightService,
+			deps: [],
+			target: i0.ɵɵFactoryTarget.Injectable
+		});
+	}
+	static {
+		this.ɵprov = i0.ɵɵngDeclareInjectable({
+			minVersion: "12.0.0",
+			version: "22.2.2",
+			ngImport: i0,
+			type: BloomsightService,
+			providedIn: "root"
+		});
+	}
+};
+i0.ɵɵngDeclareClassMetadata({
+	minVersion: "12.0.0",
+	version: "22.2.2",
+	ngImport: i0,
+	type: BloomsightService,
+	decorators: [{
+		type: Injectable,
+		args: [{ providedIn: "root" }]
+	}]
+});
+function requireConfig() {
+	const config = inject(BLOOMSIGHT_CONFIG, { optional: true });
+	if (!config) throw new Error("ngx-bloomsight: BloomsightService was injected, but the application never called provideBloomsight(). Add provideBloomsight({ propertyToken, isDevelopmentMode }) to the root providers.");
+	return config;
+}
+function mailFailure(cause) {
+	if (cause === void 0) return {
+		code: "MAIL_FAILED",
+		message: "The mail was not sent: the server rejected it or could not be reached"
+	};
+	return {
+		code: "MAIL_FAILED",
+		message: `The mail was not sent: ${cause instanceof Error ? cause.message : String(cause)}`
+	};
+}
+export { BLOOMSIGHT_CONFIG, BloomsightService, provideBloomsight };
+
+//# sourceMappingURL=bloomscorp-ngx-bloomsight.mjs.map

package/fesm2022/bloomscorp-ngx-bloomsight.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"bloomscorp-ngx-bloomsight.mjs","names":[],"sources":["../../../../projects/bloomscorp/ngx-bloomsight/src/lib/bloomsight-config.token.ts","../../../../projects/bloomscorp/ngx-bloomsight/src/lib/internal/bloomsight-errors.ts","../../../../projects/bloomscorp/ngx-bloomsight/src/lib/internal/start-bloomsight.ts","../../../../projects/bloomscorp/ngx-bloomsight/src/lib/provide-bloomsight.ts","../../../../projects/bloomscorp/ngx-bloomsight/src/lib/bloomsight.service.ts"],"sourcesContent":["import {InjectionToken} from '@angular/core';\nimport {BloomsightConfig} from './type/bloomsight-config';\n\n/**\n * The configuration given to `provideBloomsight()`.\n *\n * A real `InjectionToken` (P3). 1.x used the string `'bloomsightConfig'`,\n * which carries no type — whatever was injected under it was trusted to be a\n * config — and which any other library could collide with.\n *\n * Inject it to read the configuration the app started with. Provide it through\n * `provideBloomsight()`, not directly: that is what also starts the SDK.\n *\n * The explicit annotation is deliberate. Inferred, the published declaration\n * comes out as `InjectionToken<import(\"@bloomscorp/bloomsight.js\").IConfig>` —\n * the compiler expands the alias — and the core's name leaks into this\n * package's public types (§2.3).\n */\nexport const BLOOMSIGHT_CONFIG: InjectionToken<BloomsightConfig> =\n\tnew InjectionToken<BloomsightConfig>('BLOOMSIGHT_CONFIG');\n","import {Injectable} from '@angular/core';\nimport {Observable, Subject} from 'rxjs';\nimport {BloomsightError} from '../type/bloomsight-error';\n\n/**\n * Collects the failures the core reports, for `BloomsightService.errors$`.\n *\n * Internal — not exported from the public API. The service hands out the\n * stream read-only, so only the SDK's own `onError` hook can push to it.\n *\n * Hot, like `Router.events`: a subscriber sees the failures that happen after\n * it subscribes. That is why `INIT_FAILED` is not emitted here — initialisation\n * runs while the app starts, before any component exists to subscribe. It goes\n * to the app's `onError` and the console instead.\n */\n@Injectable({providedIn: 'root'})\nexport class BloomsightErrors {\n\n\tprivate readonly failures = new Subject<BloomsightError>();\n\n\treadonly errors$: Observable<BloomsightError> = this.failures.asObservable();\n\n\treport(error: BloomsightError): void {\n\t\tthis.failures.next(error);\n\t}\n}\n","import {DestroyRef, inject, PLATFORM_ID} from '@angular/core';\nimport {isPlatformBrowser} from '@angular/common';\nimport {takeUntilDestroyed} from '@angular/core/rxjs-interop';\nimport {NavigationEnd, Router} from '@angular/router';\nimport {distinctUntilChanged, filter, map} from 'rxjs';\nimport {init, pageViewObserver} from '@bloomscorp/bloomsight.js';\nimport {BLOOMSIGHT_CONFIG} from '../bloomsight-config.token';\nimport {BloomsightConfig} from '../type/bloomsight-config';\nimport {BloomsightErrors} from './bloomsight-errors';\n\n/**\n * The app initializer `provideBloomsight()` registers: starts the SDK once,\n * when the application starts.\n *\n * In 1.x the services did this from their constructors, which is what B1, B7\n * and B8 all came from: the SDK started only if something happened to inject a\n * service, started twice if two did, and started again in a lazy-loaded module\n * that imported `forRoot()`. An initializer runs once per application, whether\n * or not anything injects anything.\n *\n * Nothing runs during server-side rendering (A3): there is no visitor to\n * measure, and the core's browser detection would only report blanks.\n */\nexport function startBloomsight(): void {\n\tif (!isPlatformBrowser(inject(PLATFORM_ID))) return;\n\n\tconst config = inject(BLOOMSIGHT_CONFIG);\n\tinitialise(config, inject(BloomsightErrors));\n\tobservePageViews(config, inject(Router), inject(DestroyRef));\n}\n\n/**\n * Start the core, and never let a failure escape.\n *\n * A throw here would abort the application's bootstrap, so a broken analytics\n * SDK would take the whole app down with it (RV4). The failure is reported\n * instead, and the app carries on without the SDK.\n *\n * The core is given a copy of the config with its own `onError`, which feeds\n * `errors$` and then calls the app's handler. The core copies the config it is\n * given, so the app's object is never touched either way.\n */\nfunction initialise(config: BloomsightConfig, errors: BloomsightErrors): void {\n\ttry {\n\t\tinit({\n\t\t\t...config,\n\t\t\tonError: (error) => {\n\t\t\t\terrors.report(error);\n\t\t\t\tconfig.onError?.(error);\n\t\t\t}\n\t\t});\n\t} catch (cause) {\n\t\treportInitFailure(config, cause);\n\t}\n}\n\nfunction reportInitFailure(config: BloomsightConfig, cause: unknown): void {\n\tconst error = {\n\t\tcode: 'INIT_FAILED',\n\t\tmessage: `bloomsight.js failed to initialise: ${cause instanceof Error ? cause.message : String(cause)}`\n\t};\n\tconsole.error('ngx-bloomsight:', error.message);\n\ttry {\n\t\tconfig.onError?.(error);\n\t} catch {\n\t\t// A throwing handler must not turn a reported failure back into a crash.\n\t}\n}\n\n/**\n * Record a page view each time a navigation lands somewhere new.\n *\n * - `urlAfterRedirects`, not `url` (B3): a redirect or guard means the two\n *   differ, and only the first is where the user actually is.\n * - `distinctUntilChanged`: two requested URLs resolving to the same page are\n *   one page view, as is a same-URL reload.\n * - `takeUntilDestroyed` (B4): 1.x never unsubscribed. Here the subscription\n *   ends with the application's injector.\n *\n * Not observed at all on blooms.ai, which has no page-view endpoint: every call\n * would be a no-op in the core.\n */\nfunction observePageViews(config: BloomsightConfig, router: Router, destroyRef: DestroyRef): void {\n\tif (config.target === 'blooms-ai') {\n\t\tif (config.debug || config.isDevelopmentMode) {\n\t\t\tconsole.log('ngx-bloomsight: page views are not collected on blooms.ai, so the router is not observed');\n\t\t}\n\t\treturn;\n\t}\n\n\trouter.events.pipe(\n\t\tfilter((event): event is NavigationEnd => event instanceof NavigationEnd),\n\t\tmap((event) => event.urlAfterRedirects),\n\t\tdistinctUntilChanged(),\n\t\ttakeUntilDestroyed(destroyRef)\n\t).subscribe(() => pageViewObserver());\n}\n","import {EnvironmentProviders, makeEnvironmentProviders, provideAppInitializer} from '@angular/core';\nimport {BLOOMSIGHT_CONFIG} from './bloomsight-config.token';\nimport {startBloomsight} from './internal/start-bloomsight';\nimport {BloomsightConfig} from './type/bloomsight-config';\n\n/**\n * Set up Bloomsight for an application. Call it once, in the root providers:\n *\n * ```ts\n * bootstrapApplication(AppComponent, {\n *   providers: [\n *     provideRouter(routes),\n *     provideBloomsight({ propertyToken: '…', isDevelopmentMode: false })\n *   ]\n * });\n * ```\n *\n * It provides the configuration and starts the SDK when the application starts.\n * Page views are then recorded from the router automatically, and\n * `BloomsightService` can be injected anywhere — including lazy-loaded routes,\n * and components that only send mail.\n *\n * Returns `EnvironmentProviders`, which Angular accepts only in an environment\n * injector — the application or a route — never in a component's `providers`.\n * That replaces 1.x's `NgxBloomsightModule.forRoot()`, whose services existed\n * only where the module was imported with `forRoot()` (B6), and twice if a\n * lazy module imported it again (B7).\n */\nexport function provideBloomsight(config: BloomsightConfig): EnvironmentProviders {\n\treturn makeEnvironmentProviders([\n\t\t{provide: BLOOMSIGHT_CONFIG, useValue: config},\n\t\tprovideAppInitializer(startBloomsight)\n\t]);\n}\n","import {inject, Injectable, PLATFORM_ID} from '@angular/core';\nimport {isPlatformBrowser} from '@angular/common';\nimport {Observable} from 'rxjs';\nimport {resolveDataEvent, resolveSimpleEvent, sendEmail} from '@bloomscorp/bloomsight.js';\nimport {BLOOMSIGHT_CONFIG} from './bloomsight-config.token';\nimport {BloomsightErrors} from './internal/bloomsight-errors';\nimport {BloomsightConfig} from './type/bloomsight-config';\nimport {BloomsightError} from './type/bloomsight-error';\nimport {BloomsightEventData} from './type/bloomsight-event-data';\nimport {BloomsightMailRequest} from './type/bloomsight-mail-request';\n\n/**\n * Everything an app does with Bloomsight: events, mail, and failures.\n *\n * One root service, replacing 1.x's `BloomsightEventService` and\n * `BloomsightMailService`. It does not start the SDK — `provideBloomsight()`\n * does that when the app starts — so injecting it has no side effects.\n *\n * During server-side rendering every method is a no-op (A3).\n */\n@Injectable({providedIn: 'root'})\nexport class BloomsightService {\n\n\tprivate readonly config: BloomsightConfig = requireConfig();\n\n\tprivate readonly isBrowser: boolean = isPlatformBrowser(inject(PLATFORM_ID));\n\n\t/**\n\t * Every failure the SDK reports after you subscribe — rejected or\n\t * unreachable requests, with the server's own code where there is one.\n\t * The configured `onError` is called as well.\n\t *\n\t * Mail failures are not included: they are the error of that `sendMail()`\n\t * call, where a caller is already waiting for them.\n\t */\n\treadonly errors$: Observable<BloomsightError> = inject(BloomsightErrors).errors$;\n\n\t/** Record a simple event. */\n\ttrack(eventToken: string): void {\n\t\tif (this.isBrowser) resolveSimpleEvent(eventToken);\n\t}\n\n\t/** Record a data event, with its payload. */\n\ttrackData(eventToken: string, data: BloomsightEventData): void {\n\t\tif (this.isBrowser) resolveDataEvent(eventToken, data);\n\t}\n\n\t/**\n\t * Send a mail through the standalone Bloomsight server. Mail always goes\n\t * there, whatever `target` is set to.\n\t *\n\t * Nothing is sent until the result is subscribed to, and it is sent once per\n\t * subscription — the same as `HttpClient`. It emits once and completes when\n\t * the server accepts the mail, and errors with a `BloomsightError`\n\t * (`code: 'MAIL_FAILED'`) when it does not.\n\t *\n\t * Under `logOnly` the mail is handed to the core, which logs it and sends\n\t * nothing, and the result still emits and completes, so a UI waiting on it\n\t * is released (F2). During server-side rendering it completes without\n\t * sending or emitting.\n\t */\n\tsendMail(request: BloomsightMailRequest): Observable<void> {\n\t\treturn new Observable<void>((subscriber) => {\n\t\t\tif (!this.isBrowser) {\n\t\t\t\tsubscriber.complete();\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tconst succeed = (): void => {\n\t\t\t\tsubscriber.next();\n\t\t\t\tsubscriber.complete();\n\t\t\t};\n\t\t\tconst fail = (cause?: unknown): void => subscriber.error(mailFailure(cause));\n\n\t\t\ttry {\n\t\t\t\tsendEmail(\n\t\t\t\t\trequest.engine ?? 'GMAIL',\n\t\t\t\t\trequest.engineId,\n\t\t\t\t\trequest.templateId,\n\t\t\t\t\trequest.templateOwnerId,\n\t\t\t\t\trequest.data,\n\t\t\t\t\tsucceed,\n\t\t\t\t\t() => fail()\n\t\t\t\t);\n\t\t\t} catch (cause) {\n\t\t\t\tfail(cause);\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\t// The core returns before sending under logOnly, and calls neither\n\t\t\t// callback, so it is up to this wrapper to finish the call.\n\t\t\tif (this.config.logOnly) succeed();\n\t\t});\n\t}\n}\n\nfunction requireConfig(): BloomsightConfig {\n\tconst config = inject(BLOOMSIGHT_CONFIG, {optional: true});\n\tif (!config) {\n\t\tthrow new Error(\n\t\t\t'ngx-bloomsight: BloomsightService was injected, but the application never called provideBloomsight(). ' +\n\t\t\t'Add provideBloomsight({ propertyToken, isDevelopmentMode }) to the root providers.'\n\t\t);\n\t}\n\treturn config;\n}\n\nfunction mailFailure(cause?: unknown): BloomsightError {\n\tif (cause === undefined) {\n\t\treturn {code: 'MAIL_FAILED', message: 'The mail was not sent: the server rejected it or could not be reached'};\n\t}\n\treturn {\n\t\tcode: 'MAIL_FAILED',\n\t\tmessage: `The mail was not sent: ${cause instanceof Error ? cause.message : String(cause)}`\n\t};\n}\n"],"mappings":";;;;;;;AAkBA,MAAa,oBACZ,IAAI,eAAiC,mBAAmB;ACHzD,IAAa,mBAAb,MAAa,iBAAgB;CAD7B,cAAA;EAGkB,KAAA,WAAW,IAAI,QAAO;EAE9B,KAAA,UAAuC,KAAK,SAAS,aAAY;CAK1E;CAHA,OAAO,OAAsB;EAC5B,KAAK,SAAS,KAAK,KAAK;CACzB;CARY;EAAA,KAAA,OAAA,GAAA,mBAAA;GAAA,YAAA;GAAA,SAAA;GAAA,UAAA;GAAA,MAAA;GAAgB,MAAA,CAAA;GAAA,QAAA,GAAA,gBAAA;EAAA,CAAA;CAAA;CAAhB;EAAA,KAAA,QAAA,GAAA,sBAAA;GAAA,YAAA;GAAA,SAAA;GAAA,UAAA;GAAA,MAAA;GAAgB,YADJ;EAAM,CAAA;CAAA;;AAClB,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAgB,YAAA,CAAA;EAD5B,MAAA;EAAW,MAAA,CAAA,EAAC,YAAY,OAAM,CAAC;;;ACQhC,SAAgB,kBAAe;CAC9B,IAAI,CAAC,kBAAkB,OAAO,WAAW,CAAC,GAAG;CAE7C,MAAM,SAAS,OAAO,iBAAiB;CACvC,WAAW,QAAQ,OAAO,gBAAgB,CAAC;CAC3C,iBAAiB,QAAQ,OAAO,MAAM,GAAG,OAAO,UAAU,CAAC;AAC5D;AAaA,SAAS,WAAW,QAA0B,QAAwB;CACrE,IAAI;EACH,KAAK;GACJ,GAAG;GACH,UAAU,UAAS;IAClB,OAAO,OAAO,KAAK;IACnB,OAAO,UAAU,KAAK;GACvB;EACA,CAAA;CACF,SAAS,OAAO;EACf,kBAAkB,QAAQ,KAAK;CAChC;AACD;AAEA,SAAS,kBAAkB,QAA0B,OAAc;CAClE,MAAM,QAAQ;EACb,MAAM;EACN,SAAS,uCAAuC,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;CACrG;CACD,QAAQ,MAAM,mBAAmB,MAAM,OAAO;CAC9C,IAAI;EACH,OAAO,UAAU,KAAK;CACvB,QAAQ,CAER;AACD;AAeA,SAAS,iBAAiB,QAA0B,QAAgB,YAAsB;CACzF,IAAI,OAAO,WAAW,aAAa;EAClC,IAAI,OAAO,SAAS,OAAO,mBAC1B,QAAQ,IAAI,0FAA0F;EAEvG;CACD;CAEA,OAAO,OAAO,KACb,QAAQ,UAAkC,iBAAiB,aAAa,GACxE,KAAK,UAAU,MAAM,iBAAiB,GACtC,qBAAoB,GACpB,mBAAmB,UAAU,CAAC,CAC9B,CAAC,gBAAgB,iBAAgB,CAAE;AACrC;ACpEA,SAAgB,kBAAkB,QAAwB;CACzD,OAAO,yBAAyB,CAC/B;EAAC,SAAS;EAAmB,UAAU;CAAM,GAC7C,sBAAsB,eAAe,CACrC,CAAA;AACF;ACZA,IAAa,oBAAb,MAAa,kBAAiB;CAD9B,cAAA;EAGkB,KAAA,SAA2B,cAAa;EAExC,KAAA,YAAqB,kBAAkB,OAAO,WAAW,CAAC;EAUlE,KAAA,UAAuC,OAAO,gBAAgB,CAAC,CAAC;CA2DzE;CAxDA,MAAM,YAAkB;EACvB,IAAI,KAAK,WAAW,mBAAmB,UAAU;CAClD;CAGA,UAAU,YAAoB,MAAyB;EACtD,IAAI,KAAK,WAAW,iBAAiB,YAAY,IAAI;CACtD;CAgBA,SAAS,SAA8B;EACtC,OAAO,IAAI,YAAkB,eAAc;GAC1C,IAAI,CAAC,KAAK,WAAW;IACpB,WAAW,SAAQ;IACnB;GACD;GAEA,MAAM,gBAAqB;IAC1B,WAAW,KAAI;IACf,WAAW,SAAQ;GACpB;GACA,MAAM,QAAQ,UAA0B,WAAW,MAAM,YAAY,KAAK,CAAC;GAE3E,IAAI;IACH,UACC,QAAQ,UAAU,SAClB,QAAQ,UACR,QAAQ,YACR,QAAQ,iBACR,QAAQ,MACR,eACM,KAAI,CAAE;GAEd,SAAS,OAAO;IACf,KAAK,KAAK;IACV;GACD;GAIA,IAAI,KAAK,OAAO,SAAS,QAAO;EACjC,CAAC;CACF;CAxEY;EAAA,KAAA,OAAA,GAAA,mBAAA;GAAA,YAAA;GAAA,SAAA;GAAA,UAAA;GAAA,MAAA;GAAiB,MAAA,CAAA;GAAA,QAAA,GAAA,gBAAA;EAAA,CAAA;CAAA;CAAjB;EAAA,KAAA,QAAA,GAAA,sBAAA;GAAA,YAAA;GAAA,SAAA;GAAA,UAAA;GAAA,MAAA;GAAiB,YADL;EAAM,CAAA;CAAA;;AAClB,GAAA,yBAAA;CAAA,YAAA;CAAA,SAAA;CAAA,UAAA;CAAA,MAAA;CAAiB,YAAA,CAAA;EAD7B,MAAA;EAAW,MAAA,CAAA,EAAC,YAAY,OAAM,CAAC;;;AA4EhC,SAAS,gBAAa;CACrB,MAAM,SAAS,OAAO,mBAAmB,EAAC,UAAU,KAAI,CAAC;CACzD,IAAI,CAAC,QACJ,MAAM,IAAI,MACT,0LACoF;CAGtF,OAAO;AACR;AAEA,SAAS,YAAY,OAAe;CACnC,IAAI,UAAU,QACb,OAAO;EAAC,MAAM;EAAe,SAAS;CAAuE;CAE9G,OAAO;EACN,MAAM;EACN,SAAS,0BAA0B,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;CACxF;AACF"}