Merge pull request #293 from balena-io-modules/add-engagement-typings

Add Amplitude Engagement Guides & Surveys helper and typing

Author: myarmolinsky

src/index.tsx

@@ -192,3 +192,5 @@ export * as designTokens from '@balena/design-tokens';
 export * as ReactQuery from '@tanstack/react-query';
 export { default as dayjs } from 'dayjs';
 export * as XDatePickers from '@mui/x-date-pickers';
+export { getHasGuidesAndSurveysEnabled } from './utils/amplitude';
+import './typings/window-augmentation';

src/typings/window-augmentation.ts

@@ -0,0 +1,14 @@
+export {};
+
+declare global {
+	// This needs to be a separate interface instead of directly on Window.engagement so that it could merge with whatever the user adds to Window.engagement in their package
+	interface Engagement {
+		gs: {
+			list: () => undefined | Record<string, unknown>;
+		};
+	}
+
+	interface Window {
+		engagement: Engagement;
+	}
+}

src/utils/amplitude.ts

@@ -0,0 +1,3 @@
+export const getHasGuidesAndSurveysEnabled = () => {
+	return window.engagement.gs.list() !== undefined;
+};