@equinor/fusion-framework-react-app 8.0.1-cli-search-index.0 → 8.2.0

package/CHANGELOG.md

@@ -1,20 +1,48 @@
 # Change Log
 
-## 8.0.1-cli-search-index.0
+## 8.2.0
+
+### Minor Changes
+
+- [#3849](https://github.com/equinor/fusion-framework/pull/3849) [`7caca57`](https://github.com/equinor/fusion-framework/commit/7caca573584ae4daedfb17e287d0329c2633771a) Thanks [@asbjornhaland](https://github.com/asbjornhaland)! - `trackFeature` now has an extra optional argument for passing additional analytics
+  data.
+
+  Example
+
+  ```typescript
+  const trackFeature = useTrackFeature();
+
+  // Without extra data
+  trackFeature("SomeComponent:loaded");
+
+  // Send additional data
+  trackFeature("some:feature:happened", {
+    extra: "data",
+    foo: "bar",
+  });
+  ```
+
+## 8.1.1
 
 ### Patch Changes
 
-- [#3757](https://github.com/equinor/fusion-framework/pull/3757) [`db880d1`](https://github.com/equinor/fusion-framework/commit/db880d1fbdb62ba4667f11229d1e6c3a4cea06fc) Thanks [@odinr](https://github.com/odinr)! - preview release
+- [#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
+  - @equinor/fusion-framework-app@10.2.1
+
+## 8.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 [[`db880d1`](https://github.com/equinor/fusion-framework/commit/db880d1fbdb62ba4667f11229d1e6c3a4cea06fc)]:
-  - @equinor/fusion-framework-app@10.1.3-cli-search-index.0
-  - @equinor/fusion-framework-module-app@7.1.1-cli-search-index.0
-  - @equinor/fusion-framework-module@5.0.6-cli-search-index.0
-  - @equinor/fusion-framework-module-msal@6.0.1-cli-search-index.0
-  - @equinor/fusion-framework-module-navigation@6.0.1-cli-search-index.0
-  - @equinor/fusion-framework-react@7.4.20-cli-search-index.0
-  - @equinor/fusion-framework-react-module-http@10.0.1-cli-search-index.0
-  - @equinor/fusion-framework-react-module@3.1.14-cli-search-index.0
+- Updated dependencies [[`d38cd60`](https://github.com/equinor/fusion-framework/commit/d38cd60472380d60282c2a5672dc6e3bba3e7ca9)]:
+  - @equinor/fusion-framework-module-app@7.2.0
+  - @equinor/fusion-framework-app@10.2.0
 
 ## 8.0.0
 

package/dist/esm/analytics/index.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/analytics/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/esm/analytics/useTrackFeature.js

@@ -0,0 +1,48 @@
+import { useFrameworkModule } from '@equinor/fusion-framework-react';
+import { useCallback } from 'react';
+/**
+ * Hook for using analytics module configured in the framework.
+ */
+export const useTrackFeature = () => {
+    const analyticsProvider = useFrameworkModule('analytics');
+    const appProvider = useFrameworkModule('app');
+    const contextProvider = useFrameworkModule('context');
+    const telemetryProvider = useFrameworkModule('telemetry');
+    /**
+     * Tracks a analytics event.
+     *
+     * Can be used both in useCallback or useEffects - see README.md for examples.
+     *
+     * @param name - The feature to track
+     * @param data - Optional map of additional key-value pairs to include with the analytics event
+     */
+    const trackFeature = useCallback((name, data) => {
+        if (!analyticsProvider) {
+            telemetryProvider?.trackException({
+                name: 'AnalyticsProviderNotFound',
+                exception: new Error(`Analytics provider not found`),
+            });
+        }
+        analyticsProvider?.trackAnalytic({
+            name: 'app-feature',
+            value: {
+                feature: name,
+                data,
+            },
+            attributes: {
+                appKey: appProvider?.current?.appKey,
+                context: contextProvider?.currentContext
+                    ? {
+                        id: contextProvider.currentContext.id,
+                        externalId: contextProvider.currentContext.externalId,
+                        title: contextProvider.currentContext.title,
+                        type: contextProvider.currentContext.type.id,
+                        source: contextProvider.currentContext.source,
+                    }
+                    : undefined,
+            },
+        });
+    }, [analyticsProvider, appProvider, contextProvider, telemetryProvider]);
+    return trackFeature;
+};
+//# sourceMappingURL=useTrackFeature.js.map

package/dist/esm/analytics/useTrackFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTrackFeature.js","sourceRoot":"","sources":["../../../src/analytics/useTrackFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAGrE,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAEpC;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,MAAM,iBAAiB,GAAG,kBAAkB,CAAkB,WAAW,CAAC,CAAC;IAC3E,MAAM,WAAW,GAAG,kBAAkB,CAAY,KAAK,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,IAAY,EAAE,IAAkB,EAAE,EAAE;QACnC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,iBAAiB,EAAE,cAAc,CAAC;gBAChC,IAAI,EAAE,2BAA2B;gBACjC,SAAS,EAAE,IAAI,KAAK,CAAC,8BAA8B,CAAC;aACrD,CAAC,CAAC;QACL,CAAC;QAED,iBAAiB,EAAE,aAAa,CAAC;YAC/B,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE;gBACL,OAAO,EAAE,IAAI;gBACb,IAAI;aACL;YACD,UAAU,EAAE;gBACV,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM;gBACpC,OAAO,EAAE,eAAe,EAAE,cAAc;oBACtC,CAAC,CAAC;wBACE,EAAE,EAAE,eAAe,CAAC,cAAc,CAAC,EAAE;wBACrC,UAAU,EAAE,eAAe,CAAC,cAAc,CAAC,UAAU;wBACrD,KAAK,EAAE,eAAe,CAAC,cAAc,CAAC,KAAK;wBAC3C,IAAI,EAAE,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;wBAC5C,MAAM,EAAE,eAAe,CAAC,cAAc,CAAC,MAAM;qBAC9C;oBACH,CAAC,CAAC,SAAS;aACd;SACF,CAAC,CAAC;IACL,CAAC,EACD,CAAC,iBAAiB,EAAE,WAAW,EAAE,eAAe,EAAE,iBAAiB,CAAC,CACrE,CAAC;IAEF,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '8.0.1-cli-search-index.0';
+export const version = '8.2.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,0BAA0B,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}