@equinor/fusion-framework 7.3.20 → 7.4.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Change Log
 
+## 7.4.0
+
+### Minor Changes
+
+- [#3492](https://github.com/equinor/fusion-framework/pull/3492) [`7ba4713`](https://github.com/equinor/fusion-framework/commit/7ba47139a8d7cfbb757bd4626425c611e22c2126) Thanks [@odinr](https://github.com/odinr)! - Integrate telemetry module into framework core.
+
+  - Add TelemetryModule to FusionModules type definition
+  - Enable telemetry in FrameworkConfigurator with default configuration
+  - Add event$ observable with framework-specific event prefixing
+  - Include framework metadata in telemetry collection
+
+  resolves: [#3491](https://github.com/equinor/fusion-framework/issues/3491)
+
+### Patch Changes
+
+- [#3490](https://github.com/equinor/fusion-framework/pull/3490) [`45954e5`](https://github.com/equinor/fusion-framework/commit/45954e5db471a2faa24e88e41fc6d6c18817d6d1) Thanks [@odinr](https://github.com/odinr)! - Remove explicit logger initialization from configurator constructors in favor of telemetry.
+
+  - Removed `this.logger = new ModuleConsoleLogger(...)` from FrameworkConfigurator, AppConfigurator, and WidgetConfigurator constructors
+  - Logger functionality will be handled through telemetry module with console logging adapter
+
+  This prepares the configurators to use telemetry for logging instead of direct console logger initialization.
+
+- Updated dependencies [[`6cb288b`](https://github.com/equinor/fusion-framework/commit/6cb288b9e1ec4fae68ae6899735c176837bb4275), [`a66d70a`](https://github.com/equinor/fusion-framework/commit/a66d70a9fa40ab14f2534be4f22b6d1f602097a0), [`45954e5`](https://github.com/equinor/fusion-framework/commit/45954e5db471a2faa24e88e41fc6d6c18817d6d1), [`4e78565`](https://github.com/equinor/fusion-framework/commit/4e7856590f73fee840b065a0e4d89962e167ed9e), [`0bad642`](https://github.com/equinor/fusion-framework/commit/0bad642205a7f780dcb6685243102b65b3755fa2), [`45954e5`](https://github.com/equinor/fusion-framework/commit/45954e5db471a2faa24e88e41fc6d6c18817d6d1)]:
+  - @equinor/fusion-framework-module-context@7.0.1
+  - @equinor/fusion-framework-module-http@7.0.2
+  - @equinor/fusion-framework-module@5.0.3
+  - @equinor/fusion-framework-module-telemetry@4.2.0
+  - @equinor/fusion-framework-module-service-discovery@9.0.2
+
 ## 7.3.20
 
 ### Patch Changes

package/dist/esm/FrameworkConfigurator.js

@@ -1,26 +1,132 @@
-import { ModuleConsoleLogger, ModulesConfigurator, } from '@equinor/fusion-framework-module';
+import { ModulesConfigurator, } from '@equinor/fusion-framework-module';
 import event from '@equinor/fusion-framework-module-event';
 import http, { configureHttpClient, configureHttp, } from '@equinor/fusion-framework-module-http';
 import auth from '@equinor/fusion-framework-module-msal';
 import context from '@equinor/fusion-framework-module-context';
 import disco from '@equinor/fusion-framework-module-service-discovery';
 import services from '@equinor/fusion-framework-module-services';
+import telemetry, { enableTelemetry } from '@equinor/fusion-framework-module-telemetry';
+import { version } from './version.js';
 /**
  * Module configurator for Framework modules
  * @template TModules - Addition modules
  * @template TRef - usually undefined, optional references
  */
 export class FrameworkConfigurator extends ModulesConfigurator {
+    /**
+     * Creates a new FrameworkConfigurator instance with default telemetry configuration.
+     *
+     * Initializes the framework with core modules (event, auth, http, service discovery,
+     * services, context, and telemetry) and sets up default telemetry that includes
+     * framework version metadata and 'framework' scope for all telemetry events.
+     *
+     * @example
+     * ```typescript
+     * const configurator = new FrameworkConfigurator();
+     * // Now ready to configure additional modules
+     * ```
+     */
     constructor() {
-        super([event, auth, http, disco, services, context]);
-        this.logger = new ModuleConsoleLogger('FrameworkConfigurator');
+        super([event, auth, http, disco, services, context, telemetry]);
+        // default configuration
+        enableTelemetry(this, {
+            configure: (builder) => {
+                builder.setMetadata({
+                    fusion: {
+                        type: 'framework-telemetry',
+                        framework: {
+                            version,
+                        },
+                    },
+                });
+                builder.setDefaultScope(['framework']);
+            },
+        });
     }
+    /**
+     * Configures the global HTTP module settings such as base URLs, default headers,
+     * request/response interceptors, and timeout settings.
+     *
+     * This affects all HTTP requests made through the framework's HTTP module.
+     * Use this for application-wide HTTP configuration.
+     *
+     * @param args - HTTP module configuration arguments (same as configureHttp function)
+     *
+     * @example
+     * ```typescript
+     * configurator.configureHttp({
+     *   baseUri: 'https://api.example.com',
+     *   defaultHeaders: { 'X-App-Version': '1.0.0' }
+     * });
+     * ```
+     */
     configureHttp(...args) {
         this.addConfig(configureHttp(...args));
     }
+    /**
+     * Configures a named HTTP client instance with specific settings.
+     *
+     * Unlike configureHttp which sets global HTTP settings, this creates a named client
+     * that can have its own base URL, headers, interceptors, and other HTTP-specific
+     * configuration. Useful for connecting to different APIs or services with different requirements.
+     *
+     * @param args - HTTP client configuration arguments: [name, clientOptions]
+     *               where name is a string identifier and clientOptions contains HTTP settings
+     *
+     * @example
+     * ```typescript
+     * // Configure a client for external API
+     * configurator.configureHttpClient('external-api', {
+     *   baseUri: 'https://external-api.com',
+     *   defaultHeaders: { 'Authorization': 'Bearer token' }
+     * });
+     *
+     * // Configure a client for internal services
+     * configurator.configureHttpClient('internal', {
+     *   baseUri: 'https://internal.company.com',
+     *   timeout: 10000
+     * });
+     * ```
+     */
     configureHttpClient(...args) {
         this.addConfig(configureHttpClient(...args));
     }
+    /**
+     * Configures Microsoft Authentication Library (MSAL) authentication for the framework.
+     *
+     * This sets up OAuth 2.0 / OpenID Connect authentication using Azure AD or other
+     * MSAL-compatible identity providers. The authentication module will handle token
+     * acquisition, refresh, and user session management.
+     *
+     * @param cb_or_config - Authentication configuration. Can be either:
+     *                      - A callback function that receives an auth builder for advanced configuration
+     *                      - A client configuration object with MSAL settings
+     * @param requiresAuth - Whether the application requires authentication to function.
+     *                      When true (default), unauthenticated users cannot access the app.
+     *                      When false, authentication is optional but available when needed.
+     *
+     * @example
+     * ```typescript
+     * // Simple configuration with client config object
+     * configurator.configureMsal({
+     *   clientId: 'your-client-id',
+     *   authority: 'https://login.microsoftonline.com/your-tenant-id'
+     * });
+     *
+     * // Advanced configuration with callback
+     * configurator.configureMsal((builder) => {
+     *   builder.setClientConfig({
+     *     clientId: 'your-client-id',
+     *     authority: 'https://login.microsoftonline.com/your-tenant-id'
+     *   });
+     *   builder.setScopes(['User.Read', 'api://your-api/scope']);
+     *   builder.setRequiresAuth(true);
+     * });
+     *
+     * // Optional authentication
+     * configurator.configureMsal(config, false);
+     * ```
+     */
     configureMsal(cb_or_config, requiresAuth = true) {
         this.addConfig({
             module: auth,
@@ -37,9 +143,70 @@ export class FrameworkConfigurator extends ModulesConfigurator {
             },
         });
     }
+    /**
+     * Configures the service discovery module to automatically find and connect to services.
+     *
+     * Service discovery allows the framework to dynamically locate microservices and APIs
+     * at runtime rather than hardcoding their URLs. This is essential in distributed systems
+     * where services may be deployed across multiple environments or scaled dynamically.
+     *
+     * @param args - Configuration object for service discovery
+     * @param args.client - HTTP client configuration used to communicate with the
+     *                     service discovery registry. Typically includes base URL,
+     *                     authentication, and timeout settings.
+     *
+     * @example
+     * ```typescript
+     * configurator.configureServiceDiscovery({
+     *   client: {
+     *     baseUri: 'https://service-registry.company.com',
+     *     defaultHeaders: { 'Authorization': 'Bearer token' },
+     *     timeout: 5000
+     *   }
+     * });
+     * ```
+     */
     configureServiceDiscovery(args) {
         this.configureHttpClient('service_discovery', args.client);
     }
+    /**
+     * Configures application telemetry and observability settings.
+     *
+     * Telemetry enables tracking of application usage, performance metrics, errors,
+     * and custom events. This helps with monitoring, debugging, and understanding
+     * how your application is being used. The framework comes with default telemetry
+     * that includes framework version and scope information.
+     *
+     * @param cb - Configuration callback function that receives a telemetry builder.
+     *             Use this to customize telemetry settings like event scopes, metadata,
+     *             sampling rates, and custom instrumentation.
+     *
+     * @example
+     * ```typescript
+     * configurator.configureTelemetry((builder) => {
+     *   // Add custom metadata to all telemetry events
+     *   builder.setMetadata({
+     *     application: 'my-app',
+     *     environment: 'production',
+     *     version: '1.2.3'
+     *   });
+     *
+     *   // Set custom scopes for filtering events
+     *   builder.setDefaultScope(['app', 'performance']);
+     *
+     *   // Configure sampling (only send 10% of events)
+     *   builder.setSamplingRate(0.1);
+     *
+     *   // Add custom instrumentation
+     *   builder.addInstrumentation('custom-operation', (context) => {
+     *     // Track custom metrics
+     *   });
+     * });
+     * ```
+     */
+    configureTelemetry(cb) {
+        enableTelemetry(this, cb);
+    }
 }
 export default FrameworkConfigurator;
 //# sourceMappingURL=FrameworkConfigurator.js.map

package/dist/esm/FrameworkConfigurator.js.map

@@ -1 +1 @@
-{"version":3,"file":"FrameworkConfigurator.js","sourceRoot":"","sources":["../../src/FrameworkConfigurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,KAAK,MAAM,wCAAwC,CAAC;AAE3D,OAAO,IAAI,EAAE,EACX,mBAAmB,EACnB,aAAa,GAEd,MAAM,uCAAuC,CAAC;AAG/C,OAAO,IAA2B,MAAM,uCAAuC,CAAC;AAEhF,OAAO,OAAO,MAAM,0CAA0C,CAAC;AAE/D,OAAO,KAAK,MAAM,oDAAoD,CAAC;AACvE,OAAO,QAAQ,MAAM,2CAA2C,CAAC;AAKjE;;;;GAIG;AACH,MAAM,OAAO,qBAIX,SAAQ,mBAAkD;IAC1D;QACE,KAAK,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;IACjE,CAAC;IAEM,aAAa,CAAC,GAAG,IAAsC;QAC5D,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACzC,CAAC;IAEM,mBAAmB,CAAC,GAAG,IAA4C;QACxE,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;IAEM,aAAa,CAAC,YAA6C,EAAE,YAAY,GAAG,IAAI;QACrF,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBACrB,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;gBAC1C,CAAC;gBACD,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;oBACvC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACxB,CAAC;gBACD,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;oBACrC,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;gBACxC,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAEM,yBAAyB,CAAC,IAAmD;QAClF,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;CACF;AAED,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"FrameworkConfigurator.js","sourceRoot":"","sources":["../../src/FrameworkConfigurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,GAEpB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,KAAK,MAAM,wCAAwC,CAAC;AAE3D,OAAO,IAAI,EAAE,EACX,mBAAmB,EACnB,aAAa,GAEd,MAAM,uCAAuC,CAAC;AAG/C,OAAO,IAA2B,MAAM,uCAAuC,CAAC;AAEhF,OAAO,OAAO,MAAM,0CAA0C,CAAC;AAE/D,OAAO,KAAK,MAAM,oDAAoD,CAAC;AACvE,OAAO,QAAQ,MAAM,2CAA2C,CAAC;AACjE,OAAO,SAAS,EAAE,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAC;AAIxF,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAIvC;;;;GAIG;AACH,MAAM,OAAO,qBAIX,SAAQ,mBAAkD;IAC1D;;;;;;;;;;;;OAYG;IACH;QACE,KAAK,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QAEhE,wBAAwB;QACxB,eAAe,CAAC,IAAI,EAAE;YACpB,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBACrB,OAAO,CAAC,WAAW,CAAC;oBAClB,MAAM,EAAE;wBACN,IAAI,EAAE,qBAAqB;wBAC3B,SAAS,EAAE;4BACT,OAAO;yBACR;qBACF;iBACF,CAAC,CAAC;gBACH,OAAO,CAAC,eAAe,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;YACzC,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,aAAa,CAAC,GAAG,IAAsC;QAC5D,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,mBAAmB,CAAC,GAAG,IAA4C;QACxE,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACI,aAAa,CAAC,YAA6C,EAAE,YAAY,GAAG,IAAI;QACrF,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBACrB,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;gBAC1C,CAAC;gBACD,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;oBACvC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACxB,CAAC;gBACD,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;oBACrC,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;gBACxC,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,yBAAyB,CAAC,IAAmD;QAClF,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,kBAAkB,CAAC,EAAyC;QACjE,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5B,CAAC;CACF;AAED,eAAe,qBAAqB,CAAC"}

package/dist/esm/__tests__/FrameworkConfigurator.test.js

@@ -0,0 +1,29 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { firstValueFrom, take } from 'rxjs';
+import { FrameworkConfigurator } from '../FrameworkConfigurator.js';
+import { SemanticVersion } from '@equinor/fusion-framework-module';
+describe('FrameworkConfigurator', () => {
+    let configurator;
+    // Create a mock module for testing
+    const createMockModule = (name, version = '1.0.0') => ({
+        name,
+        version: new SemanticVersion(version),
+        initialize: () => ({ mockInstance: true }),
+    });
+    beforeEach(() => {
+        configurator = new FrameworkConfigurator();
+    });
+    describe('Event Name Prefixing', () => {
+        it('should prefix event names with "FrameworkConfigurator::"', async () => {
+            // Trigger event by adding a config
+            configurator.addConfig({
+                module: createMockModule('test', '1.0.0'),
+                configure: () => { },
+            });
+            // Wait for the first event to be emitted
+            const event = await firstValueFrom(configurator.event$.pipe(take(1)));
+            expect(event.name).toMatch(/^FrameworkConfigurator::/);
+        });
+    });
+});
+//# sourceMappingURL=FrameworkConfigurator.test.js.map

package/dist/esm/__tests__/FrameworkConfigurator.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkConfigurator.test.js","sourceRoot":"","sources":["../../../src/__tests__/FrameworkConfigurator.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAEnE,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAI,YAAmC,CAAC;IAExC,mCAAmC;IACnC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,OAAO,GAAG,OAAO,EAAa,EAAE,CAAC,CAAC;QACxE,IAAI;QACJ,OAAO,EAAE,IAAI,eAAe,CAAC,OAAO,CAAC;QACrC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;KAC3C,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACd,YAAY,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,mCAAmC;YACnC,YAAY,CAAC,SAAS,CAAC;gBACrB,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC;gBACzC,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC;aACpB,CAAC,CAAC;YAEH,yCAAyC;YACzC,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAEtE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '7.3.20';
+export const version = '7.4.0';
 //# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}