@equinor/fusion-framework-module-analytics 0.3.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @equinor/fusion-framework-module-analytics
 
+## 1.0.1
+
+### Patch Changes
+
+- [#4149](https://github.com/equinor/fusion-framework/pull/4149) [`c0f86d0`](https://github.com/equinor/fusion-framework/commit/c0f86d00e939e00e08871aa6a7db3b51b7305220) Thanks [@asbjornhaland](https://github.com/asbjornhaland)! - Fix `extractContextMetadata` to use nullish coalescing (`?? undefined`) for
+  optional fields (`externalId`, `title`, `source`), ensuring `null` values from
+  `ContextItem` are coerced to `undefined` to comply with the Zod context schema.
+
+## 1.0.0
+
+### Major Changes
+
+- [#4119](https://github.com/equinor/fusion-framework/pull/4119) [`4e2ae5c`](https://github.com/equinor/fusion-framework/commit/4e2ae5cf55c4d7924d40f7cef0f0c563246132e8) Thanks [@asbjornhaland](https://github.com/asbjornhaland)! - `ContextSelectedCollector` now accepts an `AppModuleProvider` as a second
+  constructor argument and includes the currently active application key
+  (`appKey`) in the event attributes.
+
+  This allows analytics consumers to correlate context-change events with the app
+  that was active when the context switch occurred.
+
+  **Breaking change for direct users of `ContextSelectedCollector`:** the
+  constructor now requires a second argument:
+
+  ```typescript
+  // Before
+  new ContextSelectedCollector(contextProvider);
+  // After
+  new ContextSelectedCollector(contextProvider, appProvider);
+  ```
+
+  The emitted event attributes schema is extended accordingly:
+
+  ```typescript
+  // attributes shape
+  {
+    previous: ContextMetadata | null | undefined;
+    appKey?: string; // newly added — the appKey of the active app at the time of the context change
+  }
+  ```
+
 ## 0.3.0
 
 ### Minor Changes

package/README.md

@@ -25,7 +25,8 @@ const configure = (configurator: IModulesConfigurator<any, any>) => {
 
     builder.setCollector('context-selected', async (args) => {
       const contextProvider = await args.requireInstance('context');
-      return new ContextSelectedCollector(contextProvider);
+      const appProvider = await args.requireInstance('app');
+      return new ContextSelectedCollector(contextProvider, appProvider);
     });
   });
 }
@@ -180,7 +181,8 @@ 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);
+      const appProvider = await args.requireInstance('app');
+      return new ContextSelectedCollector(contextProvider, appProvider);
     });
   });
 }
@@ -210,7 +212,8 @@ 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);
+      const appProvider = await args.requireInstance('app');
+      return new ContextSelectedCollector(contextProvider, appProvider);
     });
   });
 }

package/dist/esm/collectors/ContextSelectedCollector.js

@@ -5,16 +5,18 @@ import { contextSchema, extractContextMetadata, } from './utils/extractContextMe
 /**
  * The schema of the data to be sent.
  */
-const eventSchema = createSchema(contextSchema, z.object({ previous: contextSchema }));
+const eventSchema = createSchema(contextSchema, z.object({ previous: contextSchema, appKey: z.string().optional() }));
 /**
  * Collector to listen for context changes and add values and attributes for
  * further processing by adapters.
  */
 export class ContextSelectedCollector extends BaseCollector {
     #contextProvider;
-    constructor(contextProvider) {
+    #appProvider;
+    constructor(contextProvider, appProvider) {
         super('context-selected', eventSchema);
         this.#contextProvider = contextProvider;
+        this.#appProvider = appProvider;
     }
     _initialize() {
         const contextSelected$ = this.#contextProvider.currentContext$.pipe(
@@ -27,6 +29,7 @@ export class ContextSelectedCollector extends BaseCollector {
                 value: next && extractContextMetadata(next),
                 attributes: {
                     previous: prev && extractContextMetadata(prev),
+                    appKey: this.#appProvider.current?.appKey,
                 },
             };
         }));

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

@@ -1 +1 @@
-{"version":3,"file":"ContextSelectedCollector.js","sourceRoot":"","sources":["../../../src/collectors/ContextSelectedCollector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,GAAG,EAAwB,QAAQ,EAAE,MAAM,MAAM,CAAC;AAGjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAEL,aAAa,EACb,sBAAsB,GACvB,MAAM,mCAAmC,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,OAAO,wBACX,SAAQ,aAA8D;IAGtE,gBAAgB,CAAmB;IAEnC,YAAY,eAAiC;QAC3C,KAAK,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;IAC1C,CAAC;IAED,WAAW;QAIT,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,IAAI;QACjE,gDAAgD;QAChD,oBAAoB,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE,EAAE,CAAC;QAC3D,0CAA0C;QAC1C,QAAQ,EAAE,CACX,CAAC;QAEF,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CACjC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACnB,OAAO;gBACL,KAAK,EAAE,IAAI,IAAI,sBAAsB,CAAC,IAAI,CAAC;gBAC3C,UAAU,EAAE;oBACV,QAAQ,EAAE,IAAI,IAAI,sBAAsB,CAAC,IAAI,CAAC;iBAC/C;aACF,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}
+{"version":3,"file":"ContextSelectedCollector.js","sourceRoot":"","sources":["../../../src/collectors/ContextSelectedCollector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,GAAG,EAAwB,QAAQ,EAAE,MAAM,MAAM,CAAC;AAIjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAEL,aAAa,EACb,sBAAsB,GACvB,MAAM,mCAAmC,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,GAAG,YAAY,CAC9B,aAAa,EACb,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CACrE,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,wBACX,SAAQ,aAA+E;IAGvF,gBAAgB,CAAmB;IACnC,YAAY,CAAoB;IAEhC,YAAY,eAAiC,EAAE,WAA8B;QAC3E,KAAK,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED,WAAW;QAIT,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,IAAI;QACjE,gDAAgD;QAChD,oBAAoB,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE,EAAE,CAAC;QAC3D,0CAA0C;QAC1C,QAAQ,EAAE,CACX,CAAC;QAEF,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CACjC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACnB,OAAO;gBACL,KAAK,EAAE,IAAI,IAAI,sBAAsB,CAAC,IAAI,CAAC;gBAC3C,UAAU,EAAE;oBACV,QAAQ,EAAE,IAAI,IAAI,sBAAsB,CAAC,IAAI,CAAC;oBAC9C,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM;iBAC1C;aACF,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/dist/esm/collectors/utils/extractContextMetadata.js

@@ -14,10 +14,10 @@ export const contextSchema = z
 export const extractContextMetadata = (context) => {
     return {
         id: context.id,
-        externalId: context.externalId,
-        title: context.title,
+        externalId: context.externalId ?? undefined,
+        title: context.title ?? undefined,
         type: context.type.id,
-        source: context.source,
+        source: context.source ?? undefined,
     };
 };
 //# sourceMappingURL=extractContextMetadata.js.map

package/dist/esm/collectors/utils/extractContextMetadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"extractContextMetadata.js","sourceRoot":"","sources":["../../../../src/collectors/utils/extractContextMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,sEAAsE;AACtE,6CAA6C;AAC7C,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,QAAQ,EAAE;KACV,QAAQ,EAAE,CAAC;AAId,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,OAAoB,EAAiC,EAAE;IAC5F,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE;QACrB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"extractContextMetadata.js","sourceRoot":"","sources":["../../../../src/collectors/utils/extractContextMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,sEAAsE;AACtE,6CAA6C;AAC7C,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,QAAQ,EAAE;KACV,QAAQ,EAAE,CAAC;AAId,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,OAAoB,EAAiC,EAAE;IAC5F,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,SAAS;QAC3C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,SAAS;QACjC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE;QACrB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;KACpC,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/version.js

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