@trackunit/react-core-contexts-api 0.2.154 → 0.2.156

package/package.json

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

package/src/analyticsContext.d.ts

@@ -17,6 +17,7 @@ export type Event<T> = {
      */
     properties: T;
 };
+export type EventDictionary = Record<string, Event<BaseEvent | UnspecifiedEvent>>;
 /**
  * Takes an event type and a description and returns an event
  *
@@ -29,11 +30,12 @@ export type Event<T> = {
 export declare const createEvent: <T extends object = BaseEvent>(event?: {
     description?: string;
 }) => Event<T>;
-export interface IAnalyticsContext<Events extends Record<string, Event<BaseEvent | UnspecifiedEvent>>> {
+export interface IAnalyticsContext<Events extends EventDictionary> {
     /**
      * @template EventName
      * @param {EventName} eventName Name of the event. Used to look up event interface in EventName.ts
      * @param details Event parameters. Must match event interface.
+     * @param description Description of the event.
      * @param {{prefix: string, postfix: string}} nameSupplement Generally not reccommended.
      *
      * **Prefix**: Add a prefix to begging event name when logging.
@@ -72,6 +74,6 @@ type PromisifyMethod<T> = T extends (...args: infer U) => infer V ? (...args: U)
 type PromisifyObject<T> = {
     [K in keyof T]: PromisifyMethod<T[K]>;
 };
-export interface IAnalyticsContextAsync<T extends Record<string, Event<BaseEvent | UnspecifiedEvent>>> extends PromisifyObject<IAnalyticsContext<T>> {
+export interface IAnalyticsContextAsync<T extends EventDictionary> extends PromisifyObject<IAnalyticsContext<T>> {
 }
 export {};