@equinor/fusion-framework-module-analytics 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @equinor/fusion-framework-module-analytics
+
+## 0.1.1
+
+### Patch Changes
+
+- [#3845](https://github.com/equinor/fusion-framework/pull/3845) [`5114ac4`](https://github.com/equinor/fusion-framework/commit/5114ac4f71a60935d0194b9b2766f95adff0ba1e) Thanks [@asbjornhaland](https://github.com/asbjornhaland)! - Fix tsconfig references
+
+- Updated dependencies [[`5114ac4`](https://github.com/equinor/fusion-framework/commit/5114ac4f71a60935d0194b9b2766f95adff0ba1e)]:
+  - @equinor/fusion-framework-module-app@7.2.1
+
+## 0.1.0
+
+### Minor Changes
+
+- [#3842](https://github.com/equinor/fusion-framework/pull/3842) [`d38cd60`](https://github.com/equinor/fusion-framework/commit/d38cd60472380d60282c2a5672dc6e3bba3e7ca9) Thanks [@asbjornhaland](https://github.com/asbjornhaland)! - Add module fusion-framework-module-analytics
+
+### Patch Changes
+
+- Updated dependencies [[`d38cd60`](https://github.com/equinor/fusion-framework/commit/d38cd60472380d60282c2a5672dc6e3bba3e7ca9)]:
+  - @equinor/fusion-framework-module-app@7.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Equinor
+
+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,248 @@
+# Analytics Module
+
+The Fusion Framework Analytics Module provides an unified way to track analytics.
+It offers a consistent API for logging analytics data while supporting multiple
+adapters and collectors.
+
+When a collector emits a event, it will be sent to all adapters.
+
+## Configuration
+
+To configure the analytics module, you need to provide a function that specifies
+the adapters and collectors you want to use. The configuration can be done in
+your portal entry file or wherever you initialize the Fusion Framework.
+
+```typescript
+import { enableAnalytics } from '@equinor/fusion-framework-module-analytics';
+
+const configure = (configurator: IModulesConfigurator<any, any>) => {
+  enableAnalytics(configurator, (builder) => {
+    // configure the analytics module
+
+    builder.setAdapter('console', async () => {
+      return new ConsoleAnalyticsAdapter();
+    });
+
+    builder.setCollector('context-selected', async (args) => {
+      const contextProvider = await args.requireInstance('context');
+      return new ContextSelectedCollector(contextProvider);
+    });
+  });
+}
+```
+
+## Initialization
+
+The analytics module supports asynchronous initialization of adapters and
+collectors. The provider exposes an `initialize()` method that should be called
+to set up all configured adapters and collectors:
+
+```typescript
+// Get the analytics provider from modules
+const provider = modules.analytics;
+
+// Initialize adapters and collectors (required before use)
+await provider.initialize();
+
+// Check if provider is initialized
+if (provider.initialized) {
+  // Provider is ready for use
+}
+```
+
+> [!NOTE]
+> The analytics module will automatically initialize when used within the
+> Fusion Framework module system. Manual initialization is only required when
+> accessing the provider directly.
+
+## Adapters
+
+Adapters are responsible for processing and sending telemetry data to their
+respective destinations. All adapters support asynchronous initialization and
+will automatically be initialized when the analytics provider initializes.
+
+### Using `setAdapter`
+
+The `AnalyticsConfigurator` provides a method for adding adapters: `setAdapter`
+for pre-instantiated adapters.
+
+#### Simple `setAdapter` Example
+
+```typescript
+import { enableAnalytics } from '@equinor/fusion-framework-module-analytics';
+import { ConsoleAnalyticsAdapter } from '@equinor/fusion-framework-module-analytics/adapters';
+
+const configure = (configurator: IModulesConfigurator<any, any>) => {
+  enableAnalytics(configurator, (builder) => {
+    builder.setAdapter('console', async () => {
+      return new ConsoleAnalyticsAdapter();
+    });
+  });
+}
+```
+
+### Console Adapter
+
+The `ConsoleAnalyticsAdapter` provides a simple way to log analytics data to the
+console, useful for development and debugging.
+
+#### Installation
+
+The Console Adapter is included with the analytics module and doesn't require
+additional installation.
+
+#### Configuration
+
+The Console Adapter does not require any configuration.
+
+### Fusion Analytics Adapter
+
+The `FusionAnalyticsAdapter` provides a way to log analytics data to a service
+using the OpenTelemetry Logs pattern.
+
+#### Installation
+
+The Fusion Analytics Adapter is included with the analytics module and doesn't
+require additional installation.
+
+#### Configuration
+
+The Fusion Analytics Adapter support the following configuration options:
+
+- `portalId`: The portal Id to be included in log records.
+
+- `logExporter`: The exporter to use. We bundle `OTLPLogExporter` and `FusionOTLPLogExporter` - see below.
+
+##### Example configuration
+
+```typescript
+// OTLPLogExporter
+import { OTLPLogExporter } from '@equinor/fusion-framework-module-analytics/logExporters';
+
+builder.setAdapter('fusion-log', async () => {
+  const logExporter = new OTLPLogExporter({
+    url: 'URL_TO_POST_TO',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+  });
+
+  return new FusionAnalyticsAdapter({
+    portalId: 'PORTAL_ID',
+    logExporter,
+  });
+});
+
+// FusionOTLPLogExporter with httpClient
+import { FusionOTLPLogExporter } from '@equinor/fusion-framework-module-analytics/logExporters';
+
+builder.setAdapter('fusion', async (args) => {
+  if (args.hasModule('serviceDiscovery')) {
+    const serviceDiscovery = await args.requireInstance<ServiceDiscoveryProvider>(
+      'serviceDiscovery'
+    );
+    const httpClient = await serviceDiscovery.createClient('SERVICE_DISCOVERY_NAME');
+
+    const logExporter = new FusionOTLPLogExporter(httpClient);
+
+    return new FusionAnalyticsAdapter({
+      portalId: 'PORTAL_ID',
+      logExporter,
+    });
+  }
+  console.error('Could not instanziate monitor http client from service-discovery');
+});
+```
+
+### Creating Custom Adapters
+
+You can create custom analytics adapters by implementing the `IAnalyticsAdapter`
+interface and add it in configuration.
+
+## Collectors
+
+Collectors are responsible for sending events that adapters can pick up. All
+collectors support asynchronous initialization and will automatically be
+initialized when the analytics provider initializes.
+
+### Using `setCollector`
+
+The `AnalyticsConfigurator` provides a method for adding collectors:
+`setCollector` for pre-instantiated collectors.
+
+### Simple `setCollector` Example
+
+```typescript
+import { enableAnalytics } from '@equinor/fusion-framework-module-analytics';
+import { ContextSelectedCollector } from '@equinor/fusion-framework-module-analytics/collectors';
+
+const configure = (configurator: IModulesConfigurator<any, any>) => {
+  enableAnalytics(configurator, (builder) => {
+    builder.setCollector('context-selected', async (args) => {
+      const contextProvider = await args.requireInstance('context');
+      return new ContextSelectedCollector(contextProvider);
+    });
+  });
+}
+```
+
+### Context Selected Collector
+
+The `ContextSelectedCollector` listens for selection in the context module and emits
+the new and optional previous context.
+
+#### Installation
+
+The Context Selected Collector is included with the analytics module and doesn't
+require additional installation.
+
+#### Configuration
+
+The Context Selected Collector needs the context provider.
+
+##### Example configuration
+
+```typescript
+import { enableAnalytics } from '@equinor/fusion-framework-module-analytics';
+import { ContextSelectedCollector } from '@equinor/fusion-framework-module-analytics/collectors';
+
+const configure = (configurator: IModulesConfigurator<any, any>) => {
+  enableAnalytics(configurator, (builder) => {
+    builder.setCollector('context-selected', async (args) => {
+      const contextProvider = await args.requireInstance('context');
+      return new ContextSelectedCollector(contextProvider);
+    });
+  });
+}
+```
+
+### Creating Custom Collectors
+
+You can create custom analytics collector by extending the `BaseCollector` class,
+or implement the `IAnalyticsCollector` interface and add it in configuration.
+
+#### Example Custom Collector
+
+```typescript
+import { type AnalyticsEvent, enableAnalytics } from '@equinor/fusion-framework-module-analytics';
+
+const configure = (configurator: IModulesConfigurator<any, any>) => {
+  enableAnalytics(configurator, (builder) => {
+    builder.setCollector('click-test', async () => {
+      const subject = new Subject<AnalyticsEvent>();
+      window.addEventListener('click', (e) => {
+        subject.next({
+          name: 'window-clicker',
+          value: 42,
+        });
+      });
+
+      return {
+        subscribe: (subscriber) => {
+          return subject.subscribe(subscriber);
+        },
+      };
+    });
+  });
+}
+```

package/dist/esm/AnalyticsConfigurator.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AnalyticsConfigurator.interface.js.map

package/dist/esm/AnalyticsConfigurator.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsConfigurator.interface.js","sourceRoot":"","sources":["../../src/AnalyticsConfigurator.interface.ts"],"names":[],"mappings":""}

package/dist/esm/AnalyticsConfigurator.js

@@ -0,0 +1,61 @@
+import { BaseConfigBuilder, } from '@equinor/fusion-framework-module';
+import { from } from 'rxjs';
+import { map, scan, filter, defaultIfEmpty, shareReplay, mergeMap } from 'rxjs/operators';
+/**
+ * Configures analytics settings for the module.
+ *
+ * The `AnalyticsConfigurator` class extends `BaseConfigBuilder` to provide a fluent API for
+ * setting up analytics adapters and collectors.
+ *
+ * @remarks
+ * - Adapters are managed internally and can be set using `setAdapter`.
+ * - Collectors are managed internally and can be set using `setCollector`.
+ * - All setter methods return `this` for method chaining.
+ *
+ * @see BaseConfigBuilder
+ * @see IAnalyticsConfigurator
+ */
+export class AnalyticsConfigurator extends BaseConfigBuilder {
+    #collectorCallbacks = {};
+    #adapterCallbacks = {};
+    constructor() {
+        super();
+        // Configure async collectors resolution using mergeMap to handle Promise/Observable collector factories
+        this._set('collectors', (args) => {
+            return from(Object.entries(this.#collectorCallbacks)).pipe(mergeMap(([identifier, collectorFn]) => from(collectorFn(args)).pipe(filter((collector) => !!collector), map((collector) => [identifier, collector]))), scan((acc, [identifier, collector]) => {
+                acc[identifier] = collector;
+                return acc;
+            }, {}), defaultIfEmpty({}), shareReplay({ bufferSize: 1, refCount: true }));
+        });
+        // Configure async adapters resolution using mergeMap to handle Promise/Observable adapter factories
+        this._set('adapters', (args) => {
+            return from(Object.entries(this.#adapterCallbacks)).pipe(mergeMap(([identifier, adapterFn]) => from(adapterFn(args)).pipe(filter((adapter) => !!adapter), map((adapter) => [identifier, adapter]))), scan((acc, [identifier, adapter]) => {
+                acc[identifier] = adapter;
+                return acc;
+            }, {}), defaultIfEmpty({}), shareReplay({ bufferSize: 1, refCount: true }));
+        });
+    }
+    /**
+     * Registers a analytics collector with the configurator.
+     *
+     * @param identifier - The name of the collector
+     * @param callback - A callback function that returns an analytics collector instance
+     * @returns The current instance for method chaining
+     */
+    setCollector(identifier, callback) {
+        this.#collectorCallbacks[identifier] = callback;
+        return this;
+    }
+    /**
+     * Registers a analytics adapter with the configurator.
+     *
+     * @param identifier - The name of the adapter
+     * @param callback - A callback function that returns an analytics adapter instance
+     * @returns The current instance for method chaining
+     */
+    setAdapter(identifier, callback) {
+        this.#adapterCallbacks[identifier] = callback;
+        return this;
+    }
+}
+//# sourceMappingURL=AnalyticsConfigurator.js.map

package/dist/esm/AnalyticsConfigurator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsConfigurator.js","sourceRoot":"","sources":["../../src/AnalyticsConfigurator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,GAGlB,MAAM,kCAAkC,CAAC;AAK1C,OAAO,EAAE,IAAI,EAAwB,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1F;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,qBACX,SAAQ,iBAAkC;IAG1C,mBAAmB,GAA+D,EAAE,CAAC;IACrF,iBAAiB,GAA6D,EAAE,CAAC;IAEjF;QACE,KAAK,EAAE,CAAC;QAER,wGAAwG;QACxG,IAAI,CAAC,IAAI,CACP,YAAY,EACZ,CAAC,IAA+B,EAAwD,EAAE;YACxF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CACxD,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,CACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAC1B,MAAM,CAAC,CAAC,SAAS,EAAoC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EACpE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,SAAS,CAAU,CAAC,CACrD,CACF,EACD,IAAI,CACF,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,EAAE;gBAC/B,GAAG,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;gBAC5B,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAAyC,CAC1C,EACD,cAAc,CAAC,EAAE,CAAC,EAClB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/C,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,oGAAoG;QACpG,IAAI,CAAC,IAAI,CACP,UAAU,EACV,CAAC,IAA+B,EAAsD,EAAE;YACtF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CACtD,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,EAAE,CACnC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CACxB,MAAM,CAAC,CAAC,OAAO,EAAgC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAC5D,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAU,CAAC,CACjD,CACF,EACD,IAAI,CACF,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,EAAE;gBAC7B,GAAG,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;gBAC1B,OAAO,GAAG,CAAC;YACb,CAAC,EACD,EAAuC,CACxC,EACD,cAAc,CAAC,EAAE,CAAC,EAClB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/C,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CACV,UAAkB,EAClB,QAAuD;QAEvD,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CACR,UAAkB,EAClB,QAAqD;QAErD,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/esm/AnalyticsProvider.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AnalyticsProvider.interface.js.map

package/dist/esm/AnalyticsProvider.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsProvider.interface.js","sourceRoot":"","sources":["../../src/AnalyticsProvider.interface.ts"],"names":[],"mappings":""}

package/dist/esm/AnalyticsProvider.js

@@ -0,0 +1,92 @@
+import { BaseModuleProvider } from '@equinor/fusion-framework-module/provider';
+import { version } from './version.js';
+import { from, Subject, Subscription } from 'rxjs';
+class DisposableSubscription extends Subscription {
+    constructor(subscription) {
+        super(subscription.unsubscribe);
+    }
+    [Symbol.dispose] = () => {
+        this.unsubscribe();
+    };
+}
+/**
+ * Provides analytics tracking, adapters integration and collectors for application instrumentation.
+ *
+ * The `AnalyticsProvider` class is responsible for collecting, processing and relaying analytics
+ * data to the adapters. The events are collected with collectors.
+ *
+ * @typeParam AnalyticsConfig - The configuration type for analytics.
+ * @implements IAnalyticsProvider
+ * @extends BaseModuleProvider<AnalyticsConfig>
+ */
+export class AnalyticsProvider extends BaseModuleProvider {
+    #analytics;
+    #collectors;
+    #adapters;
+    constructor(config) {
+        super({ version, config });
+        this.#analytics = new Subject();
+        this.#collectors = config.collectors;
+        this.#adapters = config.adapters;
+    }
+    /**
+     * Initializes the analytics provider with adapters and collectors.
+     *
+     * This method sets up the provider for operation by:
+     * 1. Storing the provided adapters
+     * 2. Initializing all adapters
+     * 3. Storing the provided collectors
+     * 4. Initializing all collectors
+     * 5. Setting up subscription for analytics processing
+     *
+     * @returns A promise that resolves when initialization is complete
+     */
+    async initialize() {
+        const initializedCollectors = Object.values(this.#collectors).map((collector) => Promise.resolve(collector.initialize?.()));
+        const initializedAdapters = Object.values(this.#adapters).map((adapters) => Promise.resolve(adapters.initialize?.()));
+        await Promise.allSettled(initializedCollectors);
+        await Promise.allSettled(initializedAdapters);
+        for (const collector of Object.values(this.#collectors)) {
+            const subscription = collector.subscribe({
+                next: (event) => {
+                    this.#analytics.next(event);
+                },
+            });
+            this._addTeardown(subscription);
+        }
+        const adapterSubscription = this.#analytics.subscribe({
+            next: (event) => {
+                for (const adapter of Object.values(this.#adapters)) {
+                    adapter.registerAnalytic(event);
+                }
+            },
+        });
+        this._addTeardown(adapterSubscription);
+    }
+    /**
+     * Tracks an analytics event
+     *
+     * @param event - The analytics event to track
+     */
+    trackAnalytic(event) {
+        // @TODO: Validate AnalyticsEvent includes name, value and attributes
+        this.#analytics.next(event);
+    }
+    /**
+     * Uses a analytics stream and returns both Disposable and Subscription for cleanup.
+     *
+     * @param analytic$ - Observable input stream of analytic events.
+     * @returns Object containing both Disposable and Subscription for proper cleanup.
+     */
+    trackAnalytic$(analytic$) {
+        const subscription = from(analytic$)
+            // @TODO: Validate AnalyticsEvent includes name, value and attributes
+            .subscribe({
+            next: (event) => {
+                this.#analytics.next(event);
+            },
+        });
+        return new DisposableSubscription(subscription);
+    }
+}
+//# sourceMappingURL=AnalyticsProvider.js.map

package/dist/esm/AnalyticsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsProvider.js","sourceRoot":"","sources":["../../src/AnalyticsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAE/E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAKvC,OAAO,EAAE,IAAI,EAAwB,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAIzE,MAAM,sBAAuB,SAAQ,YAAY;IAC/C,YAAY,YAA0B;QACpC,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,EAAE;QACtB,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC,CAAC;CACH;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,iBACX,SAAQ,kBAAmC;IAG3C,UAAU,CAA0B;IACpC,WAAW,CAAsC;IACjD,SAAS,CAAoC;IAE7C,YAAY,MAAuB;QACjC,KAAK,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAE3B,IAAI,CAAC,UAAU,GAAG,IAAI,OAAO,EAAE,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAC9E,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,CAAC,CAC1C,CAAC;QACF,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,CACzC,CAAC;QAEF,MAAM,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QAChD,MAAM,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAE9C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACxD,MAAM,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC;gBACvC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;oBACd,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAClC,CAAC;QAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;YACpD,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;gBACd,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBACpD,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAqB;QACjC,qEAAqE;QACrE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,SAA0C;QACvD,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC;YAClC,qEAAqE;aACpE,SAAS,CAAC;YACT,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;gBACd,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;SACF,CAAC,CAAC;QAEL,OAAO,IAAI,sBAAsB,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;CACF"}

package/dist/esm/adapters/AnalyticsAdapter.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AnalyticsAdapter.interface.js.map

package/dist/esm/adapters/AnalyticsAdapter.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsAdapter.interface.js","sourceRoot":"","sources":["../../../src/adapters/AnalyticsAdapter.interface.ts"],"names":[],"mappings":""}

package/dist/esm/adapters/ConsoleAnalyticsAdapter.js

@@ -0,0 +1,12 @@
+/**
+ * An analytics adapter printing the events to the console.
+ */
+export class ConsoleAnalyticsAdapter {
+    registerAnalytic(event) {
+        console.log('Analytics::Adapter::Console', event);
+    }
+    [Symbol.dispose]() {
+        // no-op
+    }
+}
+//# sourceMappingURL=ConsoleAnalyticsAdapter.js.map

package/dist/esm/adapters/ConsoleAnalyticsAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConsoleAnalyticsAdapter.js","sourceRoot":"","sources":["../../../src/adapters/ConsoleAnalyticsAdapter.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,OAAO,uBAAuB;IAGlC,gBAAgB,CAAC,KAAQ;QACvB,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,QAAQ;IACV,CAAC;CACF"}

package/dist/esm/adapters/FusionAnalyticsAdapter.js

@@ -0,0 +1,42 @@
+import { LoggerProvider, SimpleLogRecordProcessor, } from '@opentelemetry/sdk-logs';
+import { SeverityNumber, } from '@opentelemetry/api-logs';
+import { resourceFromAttributes } from '@opentelemetry/resources';
+import { version } from '../version.js';
+import { v7 as uuid } from 'uuid';
+/**
+ * An analytics adapter for sending events to the log exporter for handling.
+ *
+ * The exporter is a Open Telemetry exporter.
+ * @see OTLPExporterBase
+ */
+export class FusionAnalyticsAdapter {
+    #logExporter;
+    #loggerProvider;
+    #logger;
+    constructor(args) {
+        this.#logExporter = args.logExporter;
+        this.#loggerProvider = new LoggerProvider({
+            processors: [new SimpleLogRecordProcessor(this.#logExporter)],
+            resource: resourceFromAttributes({
+                'module.version': version,
+                'session.id': uuid(),
+                'portal.id': args.portalId,
+            }),
+        });
+        this.#logger = this.#loggerProvider.getLogger('fusion');
+    }
+    registerAnalytic(event) {
+        const logRecord = {
+            eventName: event.name,
+            attributes: event.attributes,
+            body: event.value,
+            severityNumber: SeverityNumber.INFO,
+        };
+        this.#logger.emit(logRecord);
+    }
+    [Symbol.dispose]() {
+        this.#logExporter.shutdown();
+        this.#loggerProvider.shutdown();
+    }
+}
+//# sourceMappingURL=FusionAnalyticsAdapter.js.map

package/dist/esm/adapters/FusionAnalyticsAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FusionAnalyticsAdapter.js","sourceRoot":"","sources":["../../../src/adapters/FusionAnalyticsAdapter.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,cAAc,EACd,wBAAwB,GAEzB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACL,cAAc,GAIf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;GAKG;AACH,MAAM,OAAO,sBAAsB;IAGjC,YAAY,CAAwC;IACpD,eAAe,CAAiB;IAChC,OAAO,CAAS;IAEhB,YAAY,IAA8E;QACxF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QAErC,IAAI,CAAC,eAAe,GAAG,IAAI,cAAc,CAAC;YACxC,UAAU,EAAE,CAAC,IAAI,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC7D,QAAQ,EAAE,sBAAsB,CAAC;gBAC/B,gBAAgB,EAAE,OAAO;gBACzB,YAAY,EAAE,IAAI,EAAE;gBACpB,WAAW,EAAE,IAAI,CAAC,QAAQ;aAC3B,CAAC;SACH,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,gBAAgB,CAAC,KAAQ;QACvB,MAAM,SAAS,GAAuB;YACpC,SAAS,EAAE,KAAK,CAAC,IAAI;YACrB,UAAU,EAAE,KAAK,CAAC,UAA2B;YAC7C,IAAI,EAAE,KAAK,CAAC,KAAK;YACjB,cAAc,EAAE,cAAc,CAAC,IAAI;SACpC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,CAAC,MAAM,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;CACF"}

package/dist/esm/adapters/index.js

@@ -0,0 +1,3 @@
+export { ConsoleAnalyticsAdapter } from './ConsoleAnalyticsAdapter.js';
+export { FusionAnalyticsAdapter } from './FusionAnalyticsAdapter.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/adapters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC"}

package/dist/esm/collectors/AnalyticsCollector.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AnalyticsCollector.interface.js.map

package/dist/esm/collectors/AnalyticsCollector.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsCollector.interface.js","sourceRoot":"","sources":["../../../src/collectors/AnalyticsCollector.interface.ts"],"names":[],"mappings":""}

package/dist/esm/collectors/AppLoadedCollector.js

@@ -0,0 +1,42 @@
+import { BaseCollector, createSchema } from './BaseCollector.js';
+import { appSchema, extractAppMetadata } from './utils/extractAppMetadata.js';
+import { contextSchema, extractContextMetadata, } from './utils/extractContextMetadata.js';
+import { Subject } from 'rxjs';
+import { z } from 'zod';
+const EVENT_NAME = 'onAppModulesLoaded';
+/**
+ * The schema of the data to be sent.
+ */
+const eventSchema = createSchema(appSchema, z.object({ context: contextSchema }));
+/**
+ * Collector to listen for app loaded and add values and attributes for
+ * further processing by adapters.
+ */
+export class AppLoadedCollector extends BaseCollector {
+    #eventProvider;
+    #appProvider;
+    constructor(eventProvider, appProvider) {
+        super('app-loaded', eventSchema);
+        this.#eventProvider = eventProvider;
+        this.#appProvider = appProvider;
+    }
+    _initialize() {
+        const subject = new Subject();
+        this.#eventProvider.addEventListener(EVENT_NAME, (event) => {
+            // Fallback to appProvider for manifest if app is not updated with latest
+            // payload for onAppModulesLoaded (missing manifest).
+            const manifest = event.detail.manifest ?? this.#appProvider.current?.manifest;
+            const modules = event.detail.modules;
+            const data = {
+                value: manifest && extractAppMetadata(manifest),
+                attributes: {
+                    context: modules.context?.currentContext &&
+                        extractContextMetadata(modules.context.currentContext),
+                },
+            };
+            subject.next(data);
+        });
+        return subject;
+    }
+}
+//# sourceMappingURL=AppLoadedCollector.js.map

package/dist/esm/collectors/AppLoadedCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppLoadedCollector.js","sourceRoot":"","sources":["../../../src/collectors/AppLoadedCollector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAoB,SAAS,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAChG,OAAO,EAEL,aAAa,EACb,sBAAsB,GACvB,MAAM,mCAAmC,CAAC;AAU3C,OAAO,EAAwB,OAAO,EAAE,MAAM,MAAM,CAAC;AACrD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,UAAU,GAAG,oBAAoB,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,GAAG,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;AAElF;;;GAGG;AACH,MAAM,OAAO,kBACX,SAAQ,aAAyD;IAGjE,cAAc,CAAuB;IACrC,YAAY,CAAoB;IAEhC,YAAY,aAAmC,EAAE,WAA8B;QAC7E,KAAK,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED,WAAW;QAIT,MAAM,OAAO,GAAG,IAAI,OAAO,EAGvB,CAAC;QACL,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;YACzD,yEAAyE;YACzE,qDAAqD;YACrD,MAAM,QAAQ,GACX,KAAK,CAAC,MAAM,CAAC,QAAwB,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC;YAChF,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,OAA8C,CAAC;YAE5E,MAAM,IAAI,GAAG;gBACX,KAAK,EAAE,QAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC;gBAC/C,UAAU,EAAE;oBACV,OAAO,EACL,OAAO,CAAC,OAAO,EAAE,cAAc;wBAC/B,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC;iBACzD;aACF,CAAC;YAEF,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/dist/esm/collectors/AppSelectedCollector.js

@@ -0,0 +1,32 @@
+import { map, pairwise } from 'rxjs';
+import { BaseCollector, createSchema } from './BaseCollector.js';
+import { appKeySchema, extractAppKeyMetadata, } from './utils/extractAppMetadata.js';
+import { z } from 'zod';
+/**
+ * The schema of the data to be sent.
+ */
+const eventSchema = createSchema(appKeySchema, z.object({ previous: appKeySchema }));
+/**
+ * Collector to listen for app selection and add values and attributes for
+ * further processing by adapters.
+ */
+export class AppSelectedCollector extends BaseCollector {
+    #appProvider;
+    constructor(appProvider) {
+        super('app-selected', eventSchema);
+        this.#appProvider = appProvider;
+    }
+    _initialize() {
+        const appSelected$ = this.#appProvider.current$.pipe(pairwise());
+        const data$ = appSelected$.pipe(map(([prev, next]) => {
+            return {
+                value: extractAppKeyMetadata(next),
+                attributes: {
+                    previous: prev && extractAppKeyMetadata(prev),
+                },
+            };
+        }));
+        return data$;
+    }
+}
+//# sourceMappingURL=AppSelectedCollector.js.map

package/dist/esm/collectors/AppSelectedCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppSelectedCollector.js","sourceRoot":"","sources":["../../../src/collectors/AppSelectedCollector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAwB,QAAQ,EAAE,MAAM,MAAM,CAAC;AAE3D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAEL,YAAY,EACZ,qBAAqB,GACtB,MAAM,+BAA+B,CAAC;AAIvC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;AAErF;;;GAGG;AACH,MAAM,OAAO,oBACX,SAAQ,aAAoD;IAG5D,YAAY,CAAoB;IAEhC,YAAY,WAA8B;QACxC,KAAK,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED,WAAW;QAIT,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEjE,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAC7B,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACnB,OAAO;gBACL,KAAK,EAAE,qBAAqB,CAAC,IAAI,CAAC;gBAClC,UAAU,EAAE;oBACV,QAAQ,EAAE,IAAI,IAAI,qBAAqB,CAAC,IAAI,CAAC;iBAC9C;aACF,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}