@trackunit/react-core-contexts-api 0.2.29 → 0.2.31

package/index.cjs

@@ -2,6 +2,21 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+/**
+ * Takes an event type and a description and returns an event
+ *
+ * @template T The event type.
+ * Use existing from EventTypes.ts or make custom inline for one offs.
+ * Defaults to BaseEvent
+ * @param {{ description: string }} event with the interface of the event type to be filled later
+ * @returns {*}  {Event<T>}
+ */
+const createEvent = (event) => ({
+    description: event === null || event === void 0 ? void 0 : event.description,
+    amplitudeName: event === null || event === void 0 ? void 0 : event.amplitudeName,
+    properties: {},
+});
+
 exports.AssetSortByProperty = void 0;
 (function (AssetSortByProperty) {
     AssetSortByProperty["Activity"] = "ACTIVITY";
@@ -42,3 +57,4 @@ const UserSubscriptionPackage = {
 };
 
 exports.UserSubscriptionPackage = UserSubscriptionPackage;
+exports.createEvent = createEvent;

package/index.js

@@ -1,3 +1,18 @@
+/**
+ * Takes an event type and a description and returns an event
+ *
+ * @template T The event type.
+ * Use existing from EventTypes.ts or make custom inline for one offs.
+ * Defaults to BaseEvent
+ * @param {{ description: string }} event with the interface of the event type to be filled later
+ * @returns {*}  {Event<T>}
+ */
+const createEvent = (event) => ({
+    description: event === null || event === void 0 ? void 0 : event.description,
+    amplitudeName: event === null || event === void 0 ? void 0 : event.amplitudeName,
+    properties: {},
+});
+
 var AssetSortByProperty;
 (function (AssetSortByProperty) {
     AssetSortByProperty["Activity"] = "ACTIVITY";
@@ -37,4 +52,4 @@ const UserSubscriptionPackage = {
     NONE: "NONE",
 };
 
-export { AssetSortByProperty, SortOrder, UserSubscriptionPackage };
+export { AssetSortByProperty, SortOrder, UserSubscriptionPackage, createEvent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-api",
-  "version": "0.2.29",
+  "version": "0.2.31",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",

package/src/analyticsContext.d.ts

@@ -0,0 +1,78 @@
+export type UnspecifiedEvent = Record<string, string | number | boolean | null | undefined | (string | number)[]>;
+export interface BaseEvent {
+    additionalProperties?: UnspecifiedEvent;
+}
+export type Event<T> = {
+    /**
+     * Explain what this event means
+     */
+    description?: string;
+    /**
+     * Alternative name to show in Amplitude. Only here for legacy reasons.
+     */
+    amplitudeName?: string;
+    /**
+     * The properties to log. Pick an existing type or make a custom one.
+     * Be specific.
+     */
+    properties: T;
+};
+/**
+ * Takes an event type and a description and returns an event
+ *
+ * @template T The event type.
+ * Use existing from EventTypes.ts or make custom inline for one offs.
+ * Defaults to BaseEvent
+ * @param {{ description: string }} event with the interface of the event type to be filled later
+ * @returns {*}  {Event<T>}
+ */
+export declare const createEvent: <T extends object = BaseEvent>(event?: {
+    amplitudeName?: string;
+    description?: string;
+}) => Event<T>;
+export interface IAnalyticsContext<Events extends Record<string, Event<BaseEvent | UnspecifiedEvent>>> {
+    /**
+     * @template EventName
+     * @param {EventName} eventName Name of the event. Used to look up event interface in EventName.ts
+     * @param {Events[T]["properties"]} details Event parameters. Must match event interface.
+     * @param {{prefix: string, postfix: string}} nameSupplement Generally not reccommended.
+     *
+     * **Prefix**: Add a prefix to begging event name when logging.
+     *
+     * **Postfix**: Add string to end of event name when logging.
+     * Makes unique events possible, while sharing the same EventName + type.
+     * Only here because the analytics team wants each report to log a unique event
+     * for easier comparison in Databricks.
+     */
+    logEvent<T extends keyof Events>(eventName: T, details: Events[T]["properties"], nameSupplement?: {
+        prefix?: string;
+        postfix?: string;
+    }): void;
+    /**
+     *
+     * @param details
+     */
+    logPageView(details: {
+        pageName: string;
+    } & BaseEvent): void;
+    /**
+     * Log an error event.
+     *
+     * @param details The error event to log.
+     */
+    logError(details: UnspecifiedEvent): void;
+    /**
+     * Track this user property for each event.
+     *
+     * @param name key of property to set
+     * @param data value of property to set
+     */
+    setUserProperty(name: string, data: string | number): void;
+}
+type PromisifyMethod<T> = T extends (...args: infer U) => infer V ? (...args: U) => Promise<V> : T;
+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 {};

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./analyticsContext";
 export * from "./assetSortingContext";
 export * from "./currentUserContext";
 export * from "./environmentContext";