@trackunit/react-core-contexts-api 0.2.30 → 0.2.32

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.30",
+  "version": "0.2.32",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",

package/src/analyticsContext.d.ts

@@ -17,6 +17,19 @@ export type Event<T> = {
      */
     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

package/src/index.d.ts

@@ -3,6 +3,7 @@ export * from "./assetSortingContext";
 export * from "./currentUserContext";
 export * from "./environmentContext";
 export * from "./globalSelectionContext";
+export * from "./oemBrandingContext";
 export * from "./toastContext";
 export * from "./tokenContext";
 export * from "./userSubscriptionContext";

package/src/oemBrandingContext.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Branding information for an asset
+ */
+export interface OemBranding {
+    /**
+     * Weather or not the logo exist for this brand.
+     */
+    logo: boolean;
+    /**
+     * Weather or not the darklogo exist for this brand.
+     */
+    darkLogo: boolean;
+    /**
+     * Weather or not the banner exist for this brand.
+     */
+    banner: boolean;
+    /**
+     * The color to use for this brand if it is set.
+     */
+    color?: string;
+    /**
+     * Weather or not the platformLogo exist for this brand.
+     */
+    platformLogo: boolean;
+    /**
+     * The conditions for the OEM branding to be applied
+     */
+    conditions?: {
+        /**
+         * The can profiles  for the OEM branding to be applied
+         */
+        canProfiles?: string[];
+    };
+}
+export type OemBrandingImageType = "logo" | "darkLogo" | "banner" | "platformLogo";
+export interface IOemBrandingContext {
+    getOemBranding: (brand: string) => Promise<OemBranding | null>;
+    getOemImage: (imageType: OemBrandingImageType, brand: string) => Promise<string | null>;
+}