ngx-boomerangjs 1.0.0

package/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+<<<<<<< HEAD
+Copyright (c) 2026 Manuel Conde Vendrell
+=======
+Copyright (c) 2026 ngx-boomerangjs contributors
+>>>>>>> 87b5680 (Initial commit)
+
+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

@@ -0,0 +1,230 @@
+# ngx-boomerangjs
+
+An Angular 21+ wrapper for [boomerangjs](https://github.com/nicjansma/boomerangjs) that provides automatic script loading and Real User Monitoring (RUM) support via Angular's dependency injection system.
+
+## Features
+
+- Automatic boomerang script loading with ordered sequence support
+- Angular signal-based service for RUM metrics
+- `APP_INITIALIZER` integration for zero-boilerplate setup
+- Full TypeScript types for boomerang configuration
+- SPA-friendly with History and SPA plugin support
+- Configurable timeout and script integrity (SRI)
+
+## Requirements
+
+| Package           | Version    |
+| ----------------- | ---------- |
+| `@angular/core`   | `^21.0.0`  |
+| `@angular/common` | `^21.0.0`  |
+| `boomerangjs`     | `^1.815.1` |
+
+## Installation
+
+As ngx-boomerangjs has a peer dependency on boomerangjs, you need to install both packages:
+
+```bash
+npm install ngx-boomerangjs boomerangjs
+```
+
+## Quick Start
+
+### 1. Provide the configuration in `app.config.ts`
+
+Minimal example with boomerang core config:
+
+```ts
+import { ApplicationConfig } from '@angular/core';
+import { provideBoomerangMetrics } from 'ngx-boomerangjs';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideBoomerangMetrics({
+      enabled: true,
+      boomerangConfig: {
+        beacon_url: 'https://your-beacon-endpoint.example.com/beacon',
+        Errors: { enabled: true, sendInterval: 1000, maxErrors: 20 },
+        History: { enabled: true },
+      },
+    }),
+  ],
+};
+```
+
+Extended configuration example with custom script source, timeout, and source IP variable:
+
+```ts
+import { ApplicationConfig } from '@angular/core';
+import { provideBoomerangMetrics } from 'ngx-boomerangjs';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideBoomerangMetrics({
+      enabled: true,
+      boomerangConfig: {
+        beacon_url: 'https://your-beacon-endpoint.example.com/beacon',
+        Errors: { enabled: true, sendInterval: 1000, maxErrors: 20 },
+        History: { enabled: true },
+      },
+      scriptBaseUrl: '/assets/boomerang',
+      scriptLoadTimeoutMs: 15000,
+      sourceIpVarName: 'my_ip',
+      sourceIpFactory: async () => {
+        const ipService = inject(IpService);
+        const result = await firstValueFrom(ipService.getIpAddress());
+        return result.clientHost;
+      },
+    }),
+  ],
+};
+```
+
+### Set the needed assets for boomerangjs
+
+In `angular.json`, in `projects.<app>.architect.build.options.assets`, add the following entries to map the boomerang core and plugin scripts from `node_modules` to your `assets` folder during build:
+
+```json
+{
+  "glob": "boomerang.js",
+  "input": "node_modules/boomerangjs/",
+  "output": "assets/boomerang/"
+},
+{
+  "glob": "rt.js",
+  "input": "node_modules/boomerangjs/plugins/",
+  "output": "assets/boomerang/plugins/"
+},
+{
+  "glob": "auto-xhr.js",
+  "input": "node_modules/boomerangjs/plugins/",
+  "output": "assets/boomerang/plugins/"
+},
+{
+  "glob": "errors.js",
+  "input": "node_modules/boomerangjs/plugins/",
+  "output": "assets/boomerang/plugins/"
+},
+{
+  "glob": "memory.js",
+  "input": "node_modules/boomerangjs/plugins/",
+  "output": "assets/boomerang/plugins/"
+},
+{
+  "glob": "painttiming.js",
+  "input": "node_modules/boomerangjs/plugins/",
+  "output": "assets/boomerang/plugins/"
+},
+{
+  "glob": "navtiming.js",
+  "input": "node_modules/boomerangjs/plugins/",
+  "output": "assets/boomerang/plugins/"
+},
+{
+  "glob": "zzz-last-plugin.js",
+  "input": "node_modules/boomerangjs/plugins/",
+  "output": "assets/boomerang/plugins/"
+}
+```
+
+## API
+
+### `provideBoomerangMetrics(config: NgxBoomerangjsConfig)`
+
+Registers boomerang as an Angular environment provider. Runs script loading and initialization during `APP_INITIALIZER`.
+
+### `NgxBoomerangjsConfig`
+
+```ts
+export interface NgxBoomerangjsConfig {
+  enabled: boolean;
+  boomerangConfig: BoomrConfig;
+  scripts?: ScriptDescriptor[];
+  scriptBaseUrl?: string;
+  scriptLoadTimeoutMs?: number;
+  sourceIpVarName?: string;
+  sourceIpFactory?: () => Promise<string>;
+}
+```
+
+| Property              | Type                    | Description                                                                                 |
+| --------------------- | ----------------------- | ------------------------------------------------------------------------------------------- |
+| `enabled`             | `boolean`               | Enables or disables boomerang initialization.                                               |
+| `boomerangConfig`     | `BoomrConfig`           | Boomerang `BOOMR.init()` configuration.                                                     |
+| `scripts`             | `ScriptDescriptor[]`    | Optional ordered script list. If omitted, defaults are created from `scriptBaseUrl`.        |
+| `scriptBaseUrl`       | `string`                | Optional Base URL used by `createDefaultBoomerangScripts()` when `scripts` is not provided. |
+| `scriptLoadTimeoutMs` | `number`                | Optional Timeout in milliseconds for each script load.                                      |
+| `sourceIpVarName`     | `string`                | Optional beacon variable name used to store source IP.                                      |
+| `sourceIpFactory`     | `() => Promise<string>` | Optional async function that resolves the source IP value.                                  |
+
+### `createDefaultBoomerangScripts(options)`
+
+Helper to build a `ScriptDescriptor[]` list for the boomerang core and common plugins. With this option, you can replace the default script loading behavior with your own custom script list while still benefiting from the `scriptBaseUrl` and `scriptLoadTimeoutMs` configuration options.
+
+## Configuration Reference
+
+The `boomerangConfig` property maps directly to boomerang's `BOOMR.init()` options. See the [boomerangjs documentation](https://nicj.net/boomerangjs/) for the full list of supported plugins and settings.
+
+## Contributing
+
+Contributions are welcome, and pull requests are encouraged.
+
+If you want to propose a fix, improvement, or new feature, feel free to open an issue for discussion or submit a PR directly.
+
+## Development notes
+
+### Building the library
+
+This library is packaged using [ng-packagr](https://github.com/ng-packagr/ng-packagr) in **Angular Ivy partial compilation mode**, which is the standard format for distributing Angular libraries on npm.
+
+Partial compilation produces output that Angular's linker processes at the application build time, making it compatible with AOT and enabling tree-shaking.
+
+The build is driven by two config files:
+
+- `ng-package.json` — tells ng-packagr where the entry point is (`src/public-api.ts`) and where to write the output (`dist/`).
+- `tsconfig.lib.json` — extends the base `tsconfig.json` and sets `"compilationMode": "partial"` under `angularCompilerOptions`.
+
+To build the library:
+
+```bash
+pnpm run build
+```
+
+The output in `dist/` follows the Angular Package Format (APF):
+
+- `fesm2022/ngx-boomerangjs.mjs` — flat ES module bundle.
+- `types/ngx-boomerangjs.d.ts` — consolidated type declarations.
+- `package.json` — generated manifest with correct `exports`, `module`, and `typings` fields.
+
+### Testing locally before publishing
+
+To install the library in another project without publishing to npm, pack it as a tarball:
+
+```bash
+pnpm run build
+pnpm run pack:local
+```
+
+This generates `ngx-boomerangjs-1.0.0.tgz` in the root. Install it in the consuming project:
+
+```bash
+npm install ../ngx-boomerangjs/ngx-boomerangjs-1.0.0.tgz
+# or with pnpm:
+pnpm add ../ngx-boomerangjs/ngx-boomerangjs-1.0.0.tgz
+```
+
+> Note: after any source change, rebuild and repack before reinstalling in the consumer project.
+
+### Publishing to npm
+
+Authentication uses a project-scoped `.npmrc` with an `NPM_TOKEN` environment variable. Set the token before publishing:
+
+```bash
+set NPM_TOKEN=your_token_here   # Windows
+npm run publish:dist
+```
+
+The `publish:dist` script runs `npm publish ./dist`, so only the compiled output is uploaded — source files are never included.
+
+## License
+
+MIT © 2026

package/fesm2022/ngx-boomerangjs.mjs

@@ -0,0 +1,170 @@
+import * as i0 from '@angular/core';
+import { InjectionToken, inject, Injectable, makeEnvironmentProviders, provideAppInitializer } from '@angular/core';
+
+const DEFAULT_BASE = '/assets/boomerang';
+// These are the original boomerang scripts, but without integrity or crossOrigin attributes since those can vary based on hosting and build setup.
+// Users can customize the script list by providing their own in the config if needed.
+function createDefaultBoomerangScripts(baseUrl = DEFAULT_BASE) {
+    return [
+        { src: `${baseUrl}/boomerang.js` },
+        { src: `${baseUrl}/plugins/rt.js` },
+        { src: `${baseUrl}/plugins/auto-xhr.js` },
+        { src: `${baseUrl}/plugins/errors.js` },
+        { src: `${baseUrl}/plugins/memory.js` },
+        { src: `${baseUrl}/plugins/painttiming.js` },
+        { src: `${baseUrl}/plugins/navtiming.js` },
+        { src: `${baseUrl}/plugins/zzz-last-plugin.js` },
+    ];
+}
+
+class BoomerangRumManager {
+    constructor(runtimeWindow = window) {
+        this.runtimeWindow = runtimeWindow;
+        // Tracks boomerang runtime lifecycle to simplify service-level decisions.
+        this.state = 'idle';
+    }
+    getState() {
+        return this.state;
+    }
+    getBoomerang() {
+        return this.runtimeWindow.BOOMR ?? null;
+    }
+    markReadyIfAvailable() {
+        // Mark as ready only when the BOOMR global has been loaded on window.
+        if (!this.runtimeWindow.BOOMR) {
+            return false;
+        }
+        this.state = 'ready';
+        return true;
+    }
+    initialize(options) {
+        const boomerang = this.runtimeWindow.BOOMR;
+        // Initialization cannot proceed until boomerang exposes its init API.
+        if (!boomerang?.init) {
+            this.state = 'error';
+            return false;
+        }
+        boomerang.init(options.config);
+        if (options.onBeforeBeacon) {
+            boomerang.subscribe('before_beacon', options.onBeforeBeacon);
+        }
+        if (options.onOnBeacon) {
+            boomerang.subscribe('onbeacon', options.onOnBeacon);
+        }
+        if (options.callPageReady ?? true) {
+            // Trigger page_ready by default so initial navigation metrics are emitted.
+            boomerang.page_ready();
+        }
+        this.state = 'initialized';
+        return true;
+    }
+}
+
+const DEFAULT_TIMEOUT_MS = 5_000;
+const DEFAULT_SCRIPT_ATTRIBUTE = 'data-boomerang-script';
+function existingScript(selector) {
+    return document.querySelector(selector);
+}
+function appendScript(script, scriptAttribute) {
+    return new Promise((resolve, reject) => {
+        const el = document.createElement('script');
+        // Keep sync execution order so plugin dependencies are evaluated in sequence.
+        el.src = script.src;
+        el.async = false;
+        el.defer = false;
+        el.setAttribute(scriptAttribute, 'true');
+        if (script.integrity) {
+            el.integrity = script.integrity;
+            el.crossOrigin = script.crossOrigin ?? 'anonymous';
+        }
+        el.onload = () => resolve();
+        el.onerror = () => reject(new Error(`[ngx-boomerangjs] Failed to load script: ${script.src}`));
+        document.head.appendChild(el);
+    });
+}
+async function loadScriptsInOrder(scripts, options) {
+    const timeoutMs = options?.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+    const scriptAttribute = options?.scriptAttribute ?? DEFAULT_SCRIPT_ATTRIBUTE;
+    for (const script of scripts) {
+        // Skip script injection when the same source already exists in the document.
+        const selector = `script[src="${script.src}"]`;
+        if (existingScript(selector)) {
+            continue;
+        }
+        // Race the load promise against a timeout to avoid hanging forever on blocked networks.
+        await Promise.race([
+            appendScript(script, scriptAttribute),
+            new Promise((_, reject) => {
+                window.setTimeout(() => {
+                    reject(new Error(`[ngx-boomerangjs] Timeout loading script: ${script.src}`));
+                }, timeoutMs);
+            }),
+        ]);
+    }
+}
+
+const BOOMERANG_CONFIG = new InjectionToken('BOOMERANG_CONFIG');
+
+class BoomerangMetricsService {
+    constructor() {
+        this.config = inject(BOOMERANG_CONFIG);
+        this.manager = new BoomerangRumManager();
+        this.initialized = false;
+    }
+    async init() {
+        // Avoid duplicate setup and allow feature-level disablement
+        if (!this.config.enabled || this.initialized) {
+            return;
+        }
+        // User can use custom scripts providing it in config.scripts; otherwise load the default boomerang bundle
+        const scripts = this.config.scripts ?? createDefaultBoomerangScripts(this.config.scriptBaseUrl);
+        await loadScriptsInOrder(scripts, {
+            timeoutMs: this.config.scriptLoadTimeoutMs,
+        });
+        // Resolve source IP once and keep a safe fallback for environments where lookup fails.
+        // User can also choose to disable this feature by omitting sourceIpFactory and sourceIpVarName from config,
+        // in which case the default IP will be used without any lookup attempt.
+        const sourceIp = this.config.sourceIpFactory ? await this.config.sourceIpFactory().catch(() => '127.0.0.1') : '127.0.0.1';
+        const sourceIpVarName = this.config.sourceIpVarName ?? 'source_ip';
+        // Attach source IP variable right before beacon send, and clean them up immediately after
+        const initialized = this.manager.initialize({
+            config: this.config.boomerangConfig,
+            onBeforeBeacon: () => {
+                this.manager.getBoomerang()?.addVar(sourceIpVarName, sourceIp);
+            },
+            onOnBeacon: () => {
+                this.manager.getBoomerang()?.removeVar(sourceIpVarName);
+            },
+            callPageReady: true,
+        });
+        if (!initialized) {
+            throw new Error('[ngx-boomerangjs] BOOMR is unavailable after script load. Verify CSP/AdBlock constraints.');
+        }
+        this.initialized = true;
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.8", ngImport: i0, type: BoomerangMetricsService, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.8", ngImport: i0, type: BoomerangMetricsService, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.8", ngImport: i0, type: BoomerangMetricsService, decorators: [{
+            type: Injectable,
+            args: [{ providedIn: 'root' }]
+        }] });
+
+function provideBoomerangMetrics(config) {
+    return makeEnvironmentProviders([
+        {
+            provide: BOOMERANG_CONFIG,
+            useValue: config,
+        },
+        provideAppInitializer(() => inject(BoomerangMetricsService).init()),
+    ]);
+}
+
+// Angular provider & service
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { BOOMERANG_CONFIG, BoomerangMetricsService, BoomerangRumManager, createDefaultBoomerangScripts, loadScriptsInOrder, provideBoomerangMetrics };
+//# sourceMappingURL=ngx-boomerangjs.mjs.map

package/fesm2022/ngx-boomerangjs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngx-boomerangjs.mjs","sources":["../../src/default-scripts.ts","../../src/manager.ts","../../src/script-loader.ts","../../src/tokens.ts","../../src/boomerang-metrics.service.ts","../../src/providers.ts","../../src/public-api.ts","../../src/ngx-boomerangjs.ts"],"sourcesContent":["import type { ScriptDescriptor } from './types';\r\n\r\nconst DEFAULT_BASE = '/assets/boomerang';\r\n\r\n// These are the original boomerang scripts, but without integrity or crossOrigin attributes since those can vary based on hosting and build setup.\r\n// Users can customize the script list by providing their own in the config if needed.\r\nexport function createDefaultBoomerangScripts(baseUrl = DEFAULT_BASE): ScriptDescriptor[] {\r\n  return [\r\n    { src: `${baseUrl}/boomerang.js` },\r\n    { src: `${baseUrl}/plugins/rt.js` },\r\n    { src: `${baseUrl}/plugins/auto-xhr.js` },\r\n    { src: `${baseUrl}/plugins/errors.js` },\r\n    { src: `${baseUrl}/plugins/memory.js` },\r\n    { src: `${baseUrl}/plugins/painttiming.js` },\r\n    { src: `${baseUrl}/plugins/navtiming.js` },\r\n    { src: `${baseUrl}/plugins/zzz-last-plugin.js` },\r\n  ];\r\n}\r\n","import type { BoomerangGlobal, BoomerangRuntimeWindow, BoomrConfig } from './types';\r\n\r\nexport type BoomerangRuntimeState = 'idle' | 'ready' | 'initialized' | 'error';\r\n\r\nexport interface InitializeBoomerangOptions {\r\n  config: BoomrConfig;\r\n  onBeforeBeacon?: () => void;\r\n  onOnBeacon?: () => void;\r\n  callPageReady?: boolean;\r\n}\r\n\r\nexport class BoomerangRumManager {\r\n  // Tracks boomerang runtime lifecycle to simplify service-level decisions.\r\n  private state: BoomerangRuntimeState = 'idle';\r\n\r\n  constructor(private readonly runtimeWindow: BoomerangRuntimeWindow = window) {}\r\n\r\n  getState(): BoomerangRuntimeState {\r\n    return this.state;\r\n  }\r\n\r\n  getBoomerang(): BoomerangGlobal | null {\r\n    return this.runtimeWindow.BOOMR ?? null;\r\n  }\r\n\r\n  markReadyIfAvailable(): boolean {\r\n    // Mark as ready only when the BOOMR global has been loaded on window.\r\n    if (!this.runtimeWindow.BOOMR) {\r\n      return false;\r\n    }\r\n\r\n    this.state = 'ready';\r\n    return true;\r\n  }\r\n\r\n  initialize(options: InitializeBoomerangOptions): boolean {\r\n    const boomerang = this.runtimeWindow.BOOMR;\r\n    // Initialization cannot proceed until boomerang exposes its init API.\r\n    if (!boomerang?.init) {\r\n      this.state = 'error';\r\n      return false;\r\n    }\r\n\r\n    boomerang.init(options.config);\r\n\r\n    if (options.onBeforeBeacon) {\r\n      boomerang.subscribe('before_beacon', options.onBeforeBeacon);\r\n    }\r\n\r\n    if (options.onOnBeacon) {\r\n      boomerang.subscribe('onbeacon', options.onOnBeacon);\r\n    }\r\n\r\n    if (options.callPageReady ?? true) {\r\n      // Trigger page_ready by default so initial navigation metrics are emitted.\r\n      boomerang.page_ready();\r\n    }\r\n\r\n    this.state = 'initialized';\r\n    return true;\r\n  }\r\n}\r\n","import type { LoadScriptsOptions, ScriptDescriptor } from './types';\r\n\r\nconst DEFAULT_TIMEOUT_MS = 5_000;\r\nconst DEFAULT_SCRIPT_ATTRIBUTE = 'data-boomerang-script';\r\n\r\nfunction existingScript(selector: string): HTMLScriptElement | null {\r\n  return document.querySelector<HTMLScriptElement>(selector);\r\n}\r\n\r\nfunction appendScript(script: ScriptDescriptor, scriptAttribute: string): Promise<void> {\r\n  return new Promise((resolve, reject) => {\r\n    const el = document.createElement('script');\r\n    // Keep sync execution order so plugin dependencies are evaluated in sequence.\r\n    el.src = script.src;\r\n    el.async = false;\r\n    el.defer = false;\r\n    el.setAttribute(scriptAttribute, 'true');\r\n\r\n    if (script.integrity) {\r\n      el.integrity = script.integrity;\r\n      el.crossOrigin = script.crossOrigin ?? 'anonymous';\r\n    }\r\n\r\n    el.onload = () => resolve();\r\n    el.onerror = () => reject(new Error(`[ngx-boomerangjs] Failed to load script: ${script.src}`));\r\n\r\n    document.head.appendChild(el);\r\n  });\r\n}\r\n\r\nexport async function loadScriptsInOrder(scripts: ScriptDescriptor[], options?: LoadScriptsOptions): Promise<void> {\r\n  const timeoutMs = options?.timeoutMs ?? DEFAULT_TIMEOUT_MS;\r\n  const scriptAttribute = options?.scriptAttribute ?? DEFAULT_SCRIPT_ATTRIBUTE;\r\n\r\n  for (const script of scripts) {\r\n    // Skip script injection when the same source already exists in the document.\r\n    const selector = `script[src=\"${script.src}\"]`;\r\n    if (existingScript(selector)) {\r\n      continue;\r\n    }\r\n\r\n    // Race the load promise against a timeout to avoid hanging forever on blocked networks.\r\n    await Promise.race([\r\n      appendScript(script, scriptAttribute),\r\n      new Promise<never>((_, reject) => {\r\n        window.setTimeout(() => {\r\n          reject(new Error(`[ngx-boomerangjs] Timeout loading script: ${script.src}`));\r\n        }, timeoutMs);\r\n      }),\r\n    ]);\r\n  }\r\n}\r\n","import { InjectionToken } from '@angular/core';\r\nimport type { BoomrConfig, ScriptDescriptor } from './types';\r\n\r\nexport interface NgxBoomerangjsConfig {\r\n  enabled: boolean;\r\n  boomerangConfig: BoomrConfig;\r\n  scripts?: ScriptDescriptor[];\r\n  scriptBaseUrl?: string;\r\n  scriptLoadTimeoutMs?: number;\r\n  sourceIpVarName?: string;\r\n  sourceIpFactory?: () => Promise<string>;\r\n}\r\n\r\nexport const BOOMERANG_CONFIG = new InjectionToken<NgxBoomerangjsConfig>('BOOMERANG_CONFIG');\r\n","import { inject, Injectable } from '@angular/core';\r\nimport { createDefaultBoomerangScripts } from './default-scripts';\r\nimport { BoomerangRumManager } from './manager';\r\nimport { loadScriptsInOrder } from './script-loader';\r\nimport { BOOMERANG_CONFIG } from './tokens';\r\n\r\n@Injectable({ providedIn: 'root' })\r\nexport class BoomerangMetricsService {\r\n  private readonly config = inject(BOOMERANG_CONFIG);\r\n  \r\n  private readonly manager = new BoomerangRumManager();\r\n  private initialized = false;\r\n\r\n  async init(): Promise<void> {\r\n    // Avoid duplicate setup and allow feature-level disablement\r\n    if (!this.config.enabled || this.initialized) {\r\n      return;\r\n    }\r\n\r\n    // User can use custom scripts providing it in config.scripts; otherwise load the default boomerang bundle\r\n    const scripts = this.config.scripts ?? createDefaultBoomerangScripts(this.config.scriptBaseUrl);\r\n\r\n    await loadScriptsInOrder(scripts, {\r\n      timeoutMs: this.config.scriptLoadTimeoutMs,\r\n    });\r\n\r\n    // Resolve source IP once and keep a safe fallback for environments where lookup fails.\r\n    // User can also choose to disable this feature by omitting sourceIpFactory and sourceIpVarName from config,\r\n    // in which case the default IP will be used without any lookup attempt.\r\n    const sourceIp = this.config.sourceIpFactory ? await this.config.sourceIpFactory().catch(() => '127.0.0.1') : '127.0.0.1';\r\n    const sourceIpVarName = this.config.sourceIpVarName ?? 'source_ip';\r\n\r\n    // Attach source IP variable right before beacon send, and clean them up immediately after\r\n    const initialized = this.manager.initialize({\r\n      config: this.config.boomerangConfig,\r\n      onBeforeBeacon: () => {\r\n        this.manager.getBoomerang()?.addVar(sourceIpVarName, sourceIp);\r\n      },\r\n      onOnBeacon: () => {\r\n        this.manager.getBoomerang()?.removeVar(sourceIpVarName);\r\n      },\r\n      callPageReady: true,\r\n    });\r\n\r\n    if (!initialized) {\r\n      throw new Error('[ngx-boomerangjs] BOOMR is unavailable after script load. Verify CSP/AdBlock constraints.');\r\n    }\r\n\r\n    this.initialized = true;\r\n  }\r\n}\r\n","import { inject, makeEnvironmentProviders, provideAppInitializer, type EnvironmentProviders } from '@angular/core';\r\nimport { BoomerangMetricsService } from './boomerang-metrics.service';\r\nimport { BOOMERANG_CONFIG, type NgxBoomerangjsConfig } from './tokens';\r\n\r\nexport function provideBoomerangMetrics(config: NgxBoomerangjsConfig): EnvironmentProviders {\r\n  return makeEnvironmentProviders([\r\n    {\r\n      provide: BOOMERANG_CONFIG,\r\n      useValue: config,\r\n    },\r\n    provideAppInitializer(() => inject(BoomerangMetricsService).init()),\r\n  ]);\r\n}\r\n","// Angular provider & service\r\nexport { BoomerangMetricsService } from './boomerang-metrics.service';\r\nexport { createDefaultBoomerangScripts } from './default-scripts';\r\nexport { provideBoomerangMetrics } from './providers';\r\nexport { BOOMERANG_CONFIG } from './tokens';\r\nexport type { NgxBoomerangjsConfig } from './tokens';\r\n\r\n// Core types — useful for advanced usage and custom script config\r\nexport { BoomerangRumManager } from './manager';\r\nexport type { BoomerangRuntimeState, InitializeBoomerangOptions } from './manager';\r\nexport { loadScriptsInOrder } from './script-loader';\r\nexport type {\r\n  BoomerangGlobal, BoomerangRuntimeWindow, BoomrAutoXhrConfig, BoomrConfig, BoomrErrorsConfig, BoomrHistoryConfig, BoomrSpaConfig, LoadScriptsOptions, ScriptDescriptor\r\n} from './types';\r\n\r\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;AAEA,MAAM,YAAY,GAAG,mBAAmB;AAExC;AACA;AACM,SAAU,6BAA6B,CAAC,OAAO,GAAG,YAAY,EAAA;IAClE,OAAO;AACL,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,eAAe,EAAE;AAClC,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,gBAAgB,EAAE;AACnC,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,sBAAsB,EAAE;AACzC,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,oBAAoB,EAAE;AACvC,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,oBAAoB,EAAE;AACvC,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,yBAAyB,EAAE;AAC5C,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,uBAAuB,EAAE;AAC1C,QAAA,EAAE,GAAG,EAAE,CAAA,EAAG,OAAO,6BAA6B,EAAE;KACjD;AACH;;MCNa,mBAAmB,CAAA;AAI9B,IAAA,WAAA,CAA6B,gBAAwC,MAAM,EAAA;QAA9C,IAAA,CAAA,aAAa,GAAb,aAAa;;QAFlC,IAAA,CAAA,KAAK,GAA0B,MAAM;IAEiC;IAE9E,QAAQ,GAAA;QACN,OAAO,IAAI,CAAC,KAAK;IACnB;IAEA,YAAY,GAAA;AACV,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,IAAI;IACzC;IAEA,oBAAoB,GAAA;;AAElB,QAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE;AAC7B,YAAA,OAAO,KAAK;QACd;AAEA,QAAA,IAAI,CAAC,KAAK,GAAG,OAAO;AACpB,QAAA,OAAO,IAAI;IACb;AAEA,IAAA,UAAU,CAAC,OAAmC,EAAA;AAC5C,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK;;AAE1C,QAAA,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE;AACpB,YAAA,IAAI,CAAC,KAAK,GAAG,OAAO;AACpB,YAAA,OAAO,KAAK;QACd;AAEA,QAAA,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;AAE9B,QAAA,IAAI,OAAO,CAAC,cAAc,EAAE;YAC1B,SAAS,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,cAAc,CAAC;QAC9D;AAEA,QAAA,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC;QACrD;AAEA,QAAA,IAAI,OAAO,CAAC,aAAa,IAAI,IAAI,EAAE;;YAEjC,SAAS,CAAC,UAAU,EAAE;QACxB;AAEA,QAAA,IAAI,CAAC,KAAK,GAAG,aAAa;AAC1B,QAAA,OAAO,IAAI;IACb;AACD;;AC3DD,MAAM,kBAAkB,GAAG,KAAK;AAChC,MAAM,wBAAwB,GAAG,uBAAuB;AAExD,SAAS,cAAc,CAAC,QAAgB,EAAA;AACtC,IAAA,OAAO,QAAQ,CAAC,aAAa,CAAoB,QAAQ,CAAC;AAC5D;AAEA,SAAS,YAAY,CAAC,MAAwB,EAAE,eAAuB,EAAA;IACrE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAI;QACrC,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC;;AAE3C,QAAA,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG;AACnB,QAAA,EAAE,CAAC,KAAK,GAAG,KAAK;AAChB,QAAA,EAAE,CAAC,KAAK,GAAG,KAAK;AAChB,QAAA,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC;AAExC,QAAA,IAAI,MAAM,CAAC,SAAS,EAAE;AACpB,YAAA,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS;YAC/B,EAAE,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,WAAW;QACpD;QAEA,EAAE,CAAC,MAAM,GAAG,MAAM,OAAO,EAAE;AAC3B,QAAA,EAAE,CAAC,OAAO,GAAG,MAAM,MAAM,CAAC,IAAI,KAAK,CAAC,4CAA4C,MAAM,CAAC,GAAG,CAAA,CAAE,CAAC,CAAC;AAE9F,QAAA,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;AAC/B,IAAA,CAAC,CAAC;AACJ;AAEO,eAAe,kBAAkB,CAAC,OAA2B,EAAE,OAA4B,EAAA;AAChG,IAAA,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,kBAAkB;AAC1D,IAAA,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,wBAAwB;AAE5E,IAAA,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;;AAE5B,QAAA,MAAM,QAAQ,GAAG,CAAA,YAAA,EAAe,MAAM,CAAC,GAAG,IAAI;AAC9C,QAAA,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE;YAC5B;QACF;;QAGA,MAAM,OAAO,CAAC,IAAI,CAAC;AACjB,YAAA,YAAY,CAAC,MAAM,EAAE,eAAe,CAAC;AACrC,YAAA,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,KAAI;AAC/B,gBAAA,MAAM,CAAC,UAAU,CAAC,MAAK;oBACrB,MAAM,CAAC,IAAI,KAAK,CAAC,CAAA,0CAAA,EAA6C,MAAM,CAAC,GAAG,CAAA,CAAE,CAAC,CAAC;gBAC9E,CAAC,EAAE,SAAS,CAAC;AACf,YAAA,CAAC,CAAC;AACH,SAAA,CAAC;IACJ;AACF;;MCtCa,gBAAgB,GAAG,IAAI,cAAc,CAAuB,kBAAkB;;MCN9E,uBAAuB,CAAA;AADpC,IAAA,WAAA,GAAA;AAEmB,QAAA,IAAA,CAAA,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAEjC,QAAA,IAAA,CAAA,OAAO,GAAG,IAAI,mBAAmB,EAAE;QAC5C,IAAA,CAAA,WAAW,GAAG,KAAK;AAuC5B,IAAA;AArCC,IAAA,MAAM,IAAI,GAAA;;QAER,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE;YAC5C;QACF;;AAGA,QAAA,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QAE/F,MAAM,kBAAkB,CAAC,OAAO,EAAE;AAChC,YAAA,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,mBAAmB;AAC3C,SAAA,CAAC;;;;AAKF,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,KAAK,CAAC,MAAM,WAAW,CAAC,GAAG,WAAW;QACzH,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,WAAW;;AAGlE,QAAA,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;AAC1C,YAAA,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe;YACnC,cAAc,EAAE,MAAK;AACnB,gBAAA,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC;YAChE,CAAC;YACD,UAAU,EAAE,MAAK;gBACf,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,SAAS,CAAC,eAAe,CAAC;YACzD,CAAC;AACD,YAAA,aAAa,EAAE,IAAI;AACpB,SAAA,CAAC;QAEF,IAAI,CAAC,WAAW,EAAE;AAChB,YAAA,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC;QAC9G;AAEA,QAAA,IAAI,CAAC,WAAW,GAAG,IAAI;IACzB;8GA1CW,uBAAuB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;AAAvB,IAAA,SAAA,IAAA,CAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,uBAAuB,cADV,MAAM,EAAA,CAAA,CAAA;;2FACnB,uBAAuB,EAAA,UAAA,EAAA,CAAA;kBADnC,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE;;;ACF5B,SAAU,uBAAuB,CAAC,MAA4B,EAAA;AAClE,IAAA,OAAO,wBAAwB,CAAC;AAC9B,QAAA;AACE,YAAA,OAAO,EAAE,gBAAgB;AACzB,YAAA,QAAQ,EAAE,MAAM;AACjB,SAAA;QACD,qBAAqB,CAAC,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAC,IAAI,EAAE,CAAC;AACpE,KAAA,CAAC;AACJ;;ACZA;;ACAA;;AAEG;;;;"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "ngx-boomerangjs",
+  "version": "1.0.0",
+  "description": "Angular 21+ wrapper for boomerangjs with automatic script loading and RUM support",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "angular",
+    "boomerang",
+    "boomerangjs",
+    "rum",
+    "real-user-monitoring",
+    "ngx",
+    "performance"
+  ],
+  "peerDependencies": {
+    "@angular/common": "^21.0.0",
+    "@angular/core": "^21.0.0",
+    "boomerangjs": "^1.815.1"
+  },
+  "dependencies": {
+    "tslib": "^2.8.1"
+  },
+  "module": "fesm2022/ngx-boomerangjs.mjs",
+  "typings": "types/ngx-boomerangjs.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./types/ngx-boomerangjs.d.ts",
+      "default": "./fesm2022/ngx-boomerangjs.mjs"
+    }
+  },
+  "sideEffects": false
+}

package/types/ngx-boomerangjs.d.ts

@@ -0,0 +1,112 @@
+import * as i0 from '@angular/core';
+import { InjectionToken, EnvironmentProviders } from '@angular/core';
+
+declare class BoomerangMetricsService {
+    private readonly config;
+    private readonly manager;
+    private initialized;
+    init(): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BoomerangMetricsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<BoomerangMetricsService>;
+}
+
+interface BoomrAutoXhrConfig {
+    enabled?: boolean;
+    monitorFetch?: boolean;
+    alwaysSendXhr?: boolean;
+    xhrRequireChanges?: boolean;
+}
+interface BoomrErrorsConfig {
+    enabled?: boolean;
+    monitorRejections?: boolean;
+    monitorConsole?: boolean;
+    sendAfterOnload?: boolean;
+    sendInterval?: number;
+    maxErrors?: number;
+}
+interface BoomrSpaConfig {
+    enabled?: boolean;
+    singlePageApp?: boolean;
+}
+interface BoomrHistoryConfig {
+    enabled?: boolean;
+}
+interface BoomrConfig {
+    beacon_url: string;
+    beacon_type?: 'GET' | 'POST' | 'AUTO';
+    autorun?: boolean;
+    log?: ((msg: unknown, level: string, source: string) => void) | null;
+    instrument_xhr?: boolean;
+    ResourceTiming?: {
+        enabled?: boolean;
+        clearOnBeacon?: boolean;
+    };
+    NavigationTiming?: Record<string, unknown>;
+    PaintTiming?: Record<string, unknown>;
+    Memory?: Record<string, unknown>;
+    AutoXHR?: BoomrAutoXhrConfig;
+    Errors?: BoomrErrorsConfig;
+    SPA?: BoomrSpaConfig;
+    History?: BoomrHistoryConfig;
+    [key: string]: unknown;
+}
+interface BoomerangGlobal {
+    t_end: number;
+    debug: (...args: unknown[]) => void;
+    init(config: BoomrConfig): BoomerangGlobal;
+    page_ready(): void;
+    subscribe(event: string, callback: (...args: unknown[]) => void): BoomerangGlobal;
+    addVar(name: string, value: unknown): BoomerangGlobal;
+    removeVar(...names: string[]): BoomerangGlobal;
+    sendBeacon(): void;
+}
+interface ScriptDescriptor {
+    src: string;
+    integrity?: string;
+    crossOrigin?: 'anonymous' | 'use-credentials';
+}
+interface LoadScriptsOptions {
+    timeoutMs?: number;
+    scriptAttribute?: string;
+}
+type BoomerangRuntimeWindow = Window & {
+    BOOMR?: BoomerangGlobal;
+};
+
+declare function createDefaultBoomerangScripts(baseUrl?: string): ScriptDescriptor[];
+
+interface NgxBoomerangjsConfig {
+    enabled: boolean;
+    boomerangConfig: BoomrConfig;
+    scripts?: ScriptDescriptor[];
+    scriptBaseUrl?: string;
+    scriptLoadTimeoutMs?: number;
+    sourceIpVarName?: string;
+    sourceIpFactory?: () => Promise<string>;
+}
+declare const BOOMERANG_CONFIG: InjectionToken<NgxBoomerangjsConfig>;
+
+declare function provideBoomerangMetrics(config: NgxBoomerangjsConfig): EnvironmentProviders;
+
+type BoomerangRuntimeState = 'idle' | 'ready' | 'initialized' | 'error';
+interface InitializeBoomerangOptions {
+    config: BoomrConfig;
+    onBeforeBeacon?: () => void;
+    onOnBeacon?: () => void;
+    callPageReady?: boolean;
+}
+declare class BoomerangRumManager {
+    private readonly runtimeWindow;
+    private state;
+    constructor(runtimeWindow?: BoomerangRuntimeWindow);
+    getState(): BoomerangRuntimeState;
+    getBoomerang(): BoomerangGlobal | null;
+    markReadyIfAvailable(): boolean;
+    initialize(options: InitializeBoomerangOptions): boolean;
+}
+
+declare function loadScriptsInOrder(scripts: ScriptDescriptor[], options?: LoadScriptsOptions): Promise<void>;
+
+export { BOOMERANG_CONFIG, BoomerangMetricsService, BoomerangRumManager, createDefaultBoomerangScripts, loadScriptsInOrder, provideBoomerangMetrics };
+export type { BoomerangGlobal, BoomerangRuntimeState, BoomerangRuntimeWindow, BoomrAutoXhrConfig, BoomrConfig, BoomrErrorsConfig, BoomrHistoryConfig, BoomrSpaConfig, InitializeBoomerangOptions, LoadScriptsOptions, NgxBoomerangjsConfig, ScriptDescriptor };
+//# sourceMappingURL=ngx-boomerangjs.d.ts.map

package/types/ngx-boomerangjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngx-boomerangjs.d.ts","sources":["../../src/boomerang-metrics.service.ts","../../src/types.ts","../../src/default-scripts.ts","../../src/tokens.ts","../../src/providers.ts","../../src/manager.ts","../../src/script-loader.ts"],"mappings":";;;AAMA,cACa,uBAAuB;AAClC;AAEA;;AAGM,YAAQ,OAAO;yCANV,uBAAuB;6CAAvB,uBAAuB;AA2CnC;;UClDgB,kBAAkB;;;;;AAKlC;UAEgB,iBAAiB;;;;;;;AAOjC;UAEgB,cAAc;;;AAG9B;UAEgB,kBAAkB;;AAElC;UAEgB,WAAW;;AAE1B;;;;AAIA;;;;uBACmB,MAAM;kBACX,MAAM;aACX,MAAM;cACL,kBAAkB;aACnB,iBAAiB;UACpB,cAAc;cACV,kBAAkB;AAC5B;AACD;UAEgB,eAAe;;;AAG9B,iBAAa,WAAW,GAAG,eAAe;;AAE1C,sEAAkE,eAAe;0CAC3C,eAAe;mCACtB,eAAe;;AAE/C;UAEgB,gBAAgB;;;AAG/B;AACD;UAEgB,kBAAkB;;;AAGlC;AAEK,KAAM,sBAAsB,GAAG,MAAM;YACjC,eAAe;;;AC3DzB,iBAAgB,6BAA6B,oBAA0B,gBAAgB;;UCHtE,oBAAoB;;qBAElB,WAAW;AAC5B,cAAU,gBAAgB;;;;AAI1B,4BAAwB,OAAO;AAChC;AAED,cAAa,gBAAgB,EAAA,cAAA,CAAA,oBAAA;;ACT7B,iBAAgB,uBAAuB,SAAS,oBAAoB,GAAG,oBAAoB;;ACFrF,KAAM,qBAAqB;UAEhB,0BAA0B;YACjC,WAAW;AACnB;AACA;;AAED;AAED,cAAa,mBAAmB;;;AAID,gCAAe,sBAA+B;AAE3E,gBAAY,qBAAqB;oBAIjB,eAAe;AAI/B;AAUA,wBAAoB,0BAA0B;AA0B/C;;AC/BD,iBAAsB,kBAAkB,UAAU,gBAAgB,cAAc,kBAAkB,GAAG,OAAO;;;;","names":[]}