@trackunit/react-core-hooks 0.2.228 → 0.2.230

package/index.cjs.js

@@ -47,7 +47,29 @@ const useAnalytics = (events) => {
     if (!context) {
         throw new Error("useAnalytics must be used within an AnalyticsProvider");
     }
-    return context;
+    const logEvent = React.useMemo(() => logEventWithDescription(context.logEvent, events), [context.logEvent, events]);
+    return {
+        ...context,
+        logEvent,
+    };
+};
+// Automatically append the description from the event type
+const logEventWithDescription = (logEvent, events) => {
+    return (eventName, details, nameSupplement) => {
+        const event = events === null || events === void 0 ? void 0 : events[eventName];
+        const eventDescription = event === null || event === void 0 ? void 0 : event.description;
+        // Include description in the details object.
+        const detailsWithDescription = {
+            eventDescription,
+            ...details,
+        };
+        if (nameSupplement) {
+            logEvent(eventName, detailsWithDescription, nameSupplement);
+        }
+        else {
+            logEvent(eventName, detailsWithDescription);
+        }
+    };
 };
 
 const AssetSortingContext = React.createContext(null);

package/index.esm.js

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { createContext, useContext, useState, useCallback, useMemo, useEffect } from 'react';
+import { createContext, useContext, useMemo, useState, useCallback, useEffect } from 'react';
 import { jsx } from 'react/jsx-runtime';
 import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { filterByMultiple } from '@trackunit/shared-utils';
@@ -27,7 +27,29 @@ const useAnalytics = (events) => {
     if (!context) {
         throw new Error("useAnalytics must be used within an AnalyticsProvider");
     }
-    return context;
+    const logEvent = useMemo(() => logEventWithDescription(context.logEvent, events), [context.logEvent, events]);
+    return {
+        ...context,
+        logEvent,
+    };
+};
+// Automatically append the description from the event type
+const logEventWithDescription = (logEvent, events) => {
+    return (eventName, details, nameSupplement) => {
+        const event = events === null || events === void 0 ? void 0 : events[eventName];
+        const eventDescription = event === null || event === void 0 ? void 0 : event.description;
+        // Include description in the details object.
+        const detailsWithDescription = {
+            eventDescription,
+            ...details,
+        };
+        if (nameSupplement) {
+            logEvent(eventName, detailsWithDescription, nameSupplement);
+        }
+        else {
+            logEvent(eventName, detailsWithDescription);
+        }
+    };
 };
 
 const AssetSortingContext = createContext(null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.228",
+  "version": "0.2.230",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/analytics/AnalyticsProvider.d.ts

@@ -1,4 +1,4 @@
-import { BaseEvent, Event, IAnalyticsContext, UnspecifiedEvent } from "@trackunit/react-core-contexts-api";
+import { EventDictionary, IAnalyticsContext } from "@trackunit/react-core-contexts-api";
 export declare const AnalyticsContext: import("react").Context<IAnalyticsContext<Record<string, never>> | null>;
 export declare const AnalyticsContextProvider: import("react").Provider<IAnalyticsContext<Record<string, never>> | null>;
 /**
@@ -17,4 +17,4 @@ export declare const AnalyticsContextProvider: import("react").Provider<IAnalyti
  * logEvent("Login", { loginPage: "New Manager" });
  * @see {@link IAnalyticsContext}
  */
-export declare const useAnalytics: <TEvents extends Record<string, Event<BaseEvent | UnspecifiedEvent>> = never>(events: TEvents) => IAnalyticsContext<TEvents>;
+export declare const useAnalytics: <TEvents extends EventDictionary = never>(events: TEvents) => IAnalyticsContext<TEvents>;