@atlaskit/teams-app-internal-analytics 1.0.0

package/dist/esm/common/test-utils/index.js

@@ -0,0 +1,93 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import React from 'react';
+import { render } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import FabricAnalyticsListeners, { FabricChannel } from '@atlaskit/analytics-listeners';
+/**
+ * Creates a mock analytics client for testing
+ */
+export var createMockAnalyticsClient = function createMockAnalyticsClient() {
+  return {
+    sendUIEvent: jest.fn(),
+    sendOperationalEvent: jest.fn(),
+    sendTrackEvent: jest.fn(),
+    sendScreenEvent: jest.fn()
+  };
+};
+
+/**
+ * Test utility for testing analytics payloads end-to-end.
+ * Renders children with analytics listener and provides mock client for event verification.
+ *
+ * @example
+ * ```tsx
+ * const { user, mockClient, expectEventToBeFired } = renderWithAnalyticsListener({
+ *   children: (
+ *     <PeopleTeamsAnalyticsContext data={{ source: 'teamsApp' }}>
+ *       <ButtonWithAnalytics eventType="ui" testId="button-with-analytics"/>
+ *     </PeopleTeamsAnalyticsContext>
+ *   )
+ * });
+ *
+ * // Test triggers event however it needs to
+ * const button = screen.getByTestId('button-with-analytics');
+ * await act(() => user.click(button));
+ *
+ * // Option 1: Use the helper function
+ * expectEventToBeFired('ui', {
+ *   action: 'clicked',
+ *   source: 'teamsApp',
+ *   attributes: expect.objectContaining({
+ *     packageName: expect.any(String)
+ *   })
+ * });
+ *
+ * // Option 2: Use mockClient directly for more control
+ * expect(mockClient.sendUIEvent).toHaveBeenCalledWith(
+ *   expect.objectContaining({ source: 'teamsApp' })
+ * );
+ * ```
+ */
+export var renderWithAnalyticsListener = function renderWithAnalyticsListener(ui, options) {
+  var _ref = options || {},
+    setup = _ref.setup,
+    providedMockClient = _ref.mockClient;
+  if (setup) {
+    setup();
+  }
+  var mockClient = providedMockClient || createMockAnalyticsClient();
+  var user = userEvent.setup();
+  var renderResult = render( /*#__PURE__*/React.createElement(FabricAnalyticsListeners, {
+    excludedChannels: Object.values(FabricChannel).filter(function (channel) {
+      return channel !== FabricChannel.peopleTeams;
+    }),
+    client: mockClient
+  }, ui));
+  var expectEventToBeFired = function expectEventToBeFired(eventType, expectedPayload) {
+    var getMockForEventType = function getMockForEventType(type) {
+      switch (type) {
+        case 'ui':
+          return mockClient.sendUIEvent;
+        case 'operational':
+          return mockClient.sendOperationalEvent;
+        case 'track':
+          return mockClient.sendTrackEvent;
+        case 'screen':
+          return mockClient.sendScreenEvent;
+        default:
+          throw new Error("Unsupported event type: ".concat(type));
+      }
+    };
+    var targetMock = getMockForEventType(eventType);
+    expect(targetMock).toHaveBeenCalledWith(expect.objectContaining(_objectSpread(_objectSpread({}, expectedPayload), {}, {
+      attributes: expect.objectContaining(expectedPayload.attributes || {})
+    })));
+  };
+  return _objectSpread(_objectSpread({}, renderResult), {}, {
+    user: user,
+    mockClient: mockClient,
+    expectEventToBeFired: expectEventToBeFired
+  });
+};

package/dist/esm/common/utils/constants.js

@@ -0,0 +1 @@
+export var EVENT_CHANNEL = 'peopleTeams';

package/dist/esm/common/utils/generated/create-event-payload.js

@@ -0,0 +1,38 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::050566410df453c9b1ba071c6805ead2>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
+ */
+
+var createEventPayload = function createEventPayload(eventKey) {
+  for (var _len = arguments.length, _ref = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+    _ref[_key - 1] = arguments[_key];
+  }
+  var attributes = _ref[0];
+  var _eventKey$split = eventKey.split('.'),
+    _eventKey$split2 = _slicedToArray(_eventKey$split, 4),
+    eventType = _eventKey$split2[0],
+    actionSubject = _eventKey$split2[1],
+    action = _eventKey$split2[2],
+    actionSubjectId = _eventKey$split2[3];
+  if (eventType === 'screen') {
+    return {
+      eventType: eventType,
+      name: actionSubject,
+      action: 'viewed',
+      attributes: attributes
+    };
+  }
+  return {
+    eventType: eventType,
+    actionSubject: actionSubject,
+    action: action,
+    actionSubjectId: actionSubjectId,
+    attributes: attributes
+  };
+};
+export default createEventPayload;

package/dist/esm/common/utils/generated/use-analytics-events.js

@@ -0,0 +1,23 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::d01fef63886f2825ffbc3a0ec1ca7534>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
+ */
+import { useCallback } from 'react';
+import { useAnalyticsEvents as useAnalyticsNextEvents } from '@atlaskit/analytics-next';
+import { EVENT_CHANNEL } from '../constants';
+import createEventPayload from './create-event-payload';
+export var useAnalyticsEvents = function useAnalyticsEvents() {
+  var _useAnalyticsNextEven = useAnalyticsNextEvents(),
+    createAnalyticsEvent = _useAnalyticsNextEven.createAnalyticsEvent;
+  var fireEvent = useCallback(function () {
+    var event = createAnalyticsEvent(createEventPayload.apply(void 0, arguments));
+    event.fire(EVENT_CHANNEL);
+  }, [createAnalyticsEvent]);
+  return {
+    fireEvent: fireEvent
+  };
+};

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { TeamsAppAnalyticsContext } from './ui/analytics-context';
+export { useAnalyticsEvents } from './common/utils/generated/use-analytics-events';

package/dist/esm/ui/analytics-context/index.js

@@ -0,0 +1,23 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _typeof from "@babel/runtime/helpers/typeof";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import React, { useMemo } from 'react';
+import { PeopleTeamsAnalyticsContext } from '@atlaskit/analytics-namespaced-context';
+export var defaultAnalyticsContextData = {
+  packageName: "@atlaskit/teams-app-internal-analytics",
+  packageVersion: "0.0.0"
+};
+export function TeamsAppAnalyticsContext(_ref) {
+  var data = _ref.data,
+    children = _ref.children;
+  var analyticsContextData = useMemo(function () {
+    if (_typeof(data) === 'object') {
+      return _objectSpread(_objectSpread({}, defaultAnalyticsContextData), data);
+    }
+    return defaultAnalyticsContextData;
+  }, [data]);
+  return /*#__PURE__*/React.createElement(PeopleTeamsAnalyticsContext, {
+    data: analyticsContextData
+  }, children);
+}

package/dist/types/common/test-utils/index.d.ts

@@ -0,0 +1,107 @@
+import React from 'react';
+import type { EventType } from '@atlaskit/analytics-gas-types';
+import { type AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import type { AnalyticsEventPayload } from '@atlaskit/analytics-next';
+interface AnalyticsTestUtilOptions {
+    /** Additional setup before rendering */
+    setup?: () => void;
+    /** Optional mock client to use instead of creating a new one */
+    mockClient?: AnalyticsWebClient;
+}
+/**
+ * Creates a mock analytics client for testing
+ */
+export declare const createMockAnalyticsClient: () => AnalyticsWebClient;
+/**
+ * Test utility for testing analytics payloads end-to-end.
+ * Renders children with analytics listener and provides mock client for event verification.
+ *
+ * @example
+ * ```tsx
+ * const { user, mockClient, expectEventToBeFired } = renderWithAnalyticsListener({
+ *   children: (
+ *     <PeopleTeamsAnalyticsContext data={{ source: 'teamsApp' }}>
+ *       <ButtonWithAnalytics eventType="ui" testId="button-with-analytics"/>
+ *     </PeopleTeamsAnalyticsContext>
+ *   )
+ * });
+ *
+ * // Test triggers event however it needs to
+ * const button = screen.getByTestId('button-with-analytics');
+ * await act(() => user.click(button));
+ *
+ * // Option 1: Use the helper function
+ * expectEventToBeFired('ui', {
+ *   action: 'clicked',
+ *   source: 'teamsApp',
+ *   attributes: expect.objectContaining({
+ *     packageName: expect.any(String)
+ *   })
+ * });
+ *
+ * // Option 2: Use mockClient directly for more control
+ * expect(mockClient.sendUIEvent).toHaveBeenCalledWith(
+ *   expect.objectContaining({ source: 'teamsApp' })
+ * );
+ * ```
+ */
+export declare const renderWithAnalyticsListener: (ui: React.ReactElement, options?: AnalyticsTestUtilOptions) => {
+    user: import("@testing-library/user-event").UserEvent;
+    mockClient: AnalyticsWebClient;
+    expectEventToBeFired: (eventType: EventType, expectedPayload: AnalyticsEventPayload) => void;
+    container: HTMLElement;
+    baseElement: HTMLElement;
+    debug: (baseElement?: Element | DocumentFragment | Array<Element | DocumentFragment>, maxLength?: number, options?: import("pretty-format").OptionsReceived) => void;
+    rerender: (ui: React.ReactElement) => void;
+    unmount: () => void;
+    asFragment: () => DocumentFragment;
+    getByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement;
+    getAllByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    queryByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement | null;
+    queryAllByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    findByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement;
+    getAllByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    queryByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement | null;
+    queryAllByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    findByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement;
+    getAllByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement[];
+    queryByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement | null;
+    queryAllByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement[];
+    findByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+};
+export {};

package/dist/types/common/utils/constants.d.ts

@@ -0,0 +1 @@
+export declare const EVENT_CHANNEL = "peopleTeams";

package/dist/types/common/utils/generated/analytics.types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::d5728d78d59f2a7bb511dc13bc1e6953>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
+ */
+export type PackageMetaDataType = {
+    packageName: string;
+    packageVersion: string;
+};
+export type ButtonClickedAnalyticsExampleAttributesType = {
+    testAttribute: string;
+};
+export type AutomationTriggeredAnalyticsExampleAttributesType = {
+    testAttribute: string;
+};
+export type AutomationFiredAnalyticsExampleAttributesType = {
+    testAttribute: string;
+};
+export type AnalyticsExampleScreenViewedAttributesType = {
+    testAttribute: string;
+};
+export type AnalyticsEventAttributes = {
+    /**
+     * fired when the teams-app-internal-analytics example button is clicked */
+    'ui.button.clicked.analyticsExample': ButtonClickedAnalyticsExampleAttributesType;
+    /**
+     * fired when the teams-app-internal-analytics example button is clicked */
+    'track.automation.triggered.analyticsExample': AutomationTriggeredAnalyticsExampleAttributesType;
+    /**
+     * fired when the teams-app-internal-analytics example button is clicked */
+    'operational.automation.fired.analyticsExample': AutomationFiredAnalyticsExampleAttributesType;
+    /**
+     * fired when the teams-app-internal-analytics example is viewed */
+    'screen.analyticsExampleScreen.viewed': AnalyticsExampleScreenViewedAttributesType;
+};
+export type EventKey = keyof AnalyticsEventAttributes;

package/dist/types/common/utils/generated/create-event-payload.d.ts

@@ -0,0 +1,27 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::050566410df453c9b1ba071c6805ead2>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
+ */
+import type { AnalyticsEventAttributes, EventKey } from './analytics.types';
+type OptionalIfUndefined<T> = undefined extends T ? [param?: T] : [param: T];
+export type EventPayloadAttributes<K extends EventKey> = OptionalIfUndefined<AnalyticsEventAttributes[K]>;
+type EventTypes = 'ui' | 'track' | 'operational' | 'screen';
+type ScreenEventPayload<K extends EventKey> = {
+    eventType: 'screen';
+    name: string;
+    action: 'viewed';
+    attributes?: AnalyticsEventAttributes[K];
+};
+type EventPayload<K extends EventKey> = {
+    eventType: Omit<EventTypes, 'screen'>;
+    actionSubject: string;
+    action: string;
+    actionSubjectId?: string;
+    attributes?: AnalyticsEventAttributes[K];
+};
+declare const createEventPayload: <K extends EventKey>(eventKey: K, ...[attributes]: EventPayloadAttributes<K>) => ScreenEventPayload<K> | EventPayload<K>;
+export default createEventPayload;

package/dist/types/common/utils/generated/use-analytics-events.d.ts

@@ -0,0 +1,4 @@
+import type { EventKey } from './analytics.types';
+export declare const useAnalyticsEvents: () => {
+    fireEvent: <K extends EventKey>(eventKey: K, ...params: undefined extends import("./analytics.types").AnalyticsEventAttributes[K] ? [param?: import("./analytics.types").AnalyticsEventAttributes[K] | undefined] : [param: import("./analytics.types").AnalyticsEventAttributes[K]]) => void;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { TeamsAppAnalyticsContext } from './ui/analytics-context';
+export { useAnalyticsEvents } from './common/utils/generated/use-analytics-events';

package/dist/types/ui/analytics-context/index.d.ts

@@ -0,0 +1,12 @@
+import React, { type ReactNode } from 'react';
+import type { PackageMetaDataType } from '../../common/utils/generated/analytics.types';
+export declare const defaultAnalyticsContextData: PackageMetaDataType;
+type TeamsAppAnalyticsContextData = {
+    source?: string;
+    attributes?: Record<string, any>;
+};
+export declare function TeamsAppAnalyticsContext({ data, children, }: {
+    data?: TeamsAppAnalyticsContextData;
+    children: ReactNode;
+}): React.JSX.Element;
+export {};

package/dist/types-ts4.5/common/test-utils/index.d.ts

@@ -0,0 +1,107 @@
+import React from 'react';
+import type { EventType } from '@atlaskit/analytics-gas-types';
+import { type AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import type { AnalyticsEventPayload } from '@atlaskit/analytics-next';
+interface AnalyticsTestUtilOptions {
+    /** Additional setup before rendering */
+    setup?: () => void;
+    /** Optional mock client to use instead of creating a new one */
+    mockClient?: AnalyticsWebClient;
+}
+/**
+ * Creates a mock analytics client for testing
+ */
+export declare const createMockAnalyticsClient: () => AnalyticsWebClient;
+/**
+ * Test utility for testing analytics payloads end-to-end.
+ * Renders children with analytics listener and provides mock client for event verification.
+ *
+ * @example
+ * ```tsx
+ * const { user, mockClient, expectEventToBeFired } = renderWithAnalyticsListener({
+ *   children: (
+ *     <PeopleTeamsAnalyticsContext data={{ source: 'teamsApp' }}>
+ *       <ButtonWithAnalytics eventType="ui" testId="button-with-analytics"/>
+ *     </PeopleTeamsAnalyticsContext>
+ *   )
+ * });
+ *
+ * // Test triggers event however it needs to
+ * const button = screen.getByTestId('button-with-analytics');
+ * await act(() => user.click(button));
+ *
+ * // Option 1: Use the helper function
+ * expectEventToBeFired('ui', {
+ *   action: 'clicked',
+ *   source: 'teamsApp',
+ *   attributes: expect.objectContaining({
+ *     packageName: expect.any(String)
+ *   })
+ * });
+ *
+ * // Option 2: Use mockClient directly for more control
+ * expect(mockClient.sendUIEvent).toHaveBeenCalledWith(
+ *   expect.objectContaining({ source: 'teamsApp' })
+ * );
+ * ```
+ */
+export declare const renderWithAnalyticsListener: (ui: React.ReactElement, options?: AnalyticsTestUtilOptions) => {
+    user: import("@testing-library/user-event").UserEvent;
+    mockClient: AnalyticsWebClient;
+    expectEventToBeFired: (eventType: EventType, expectedPayload: AnalyticsEventPayload) => void;
+    container: HTMLElement;
+    baseElement: HTMLElement;
+    debug: (baseElement?: Element | DocumentFragment | Array<Element | DocumentFragment>, maxLength?: number, options?: import("pretty-format").OptionsReceived) => void;
+    rerender: (ui: React.ReactElement) => void;
+    unmount: () => void;
+    asFragment: () => DocumentFragment;
+    getByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement;
+    getAllByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    queryByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement | null;
+    queryAllByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    findByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByLabelText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByPlaceholderText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement;
+    getAllByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    queryByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement | null;
+    queryAllByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined) => HTMLElement[];
+    findByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").SelectorMatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByAltText: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByTitle: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByDisplayValue: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement;
+    getAllByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement[];
+    queryByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement | null;
+    queryAllByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined) => HTMLElement[];
+    findByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByRole: (role: import("@testing-library/react").ByRoleMatcher, options?: import("@testing-library/react").ByRoleOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+    getByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement;
+    getAllByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    queryByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement | null;
+    queryAllByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined) => HTMLElement[];
+    findByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement>;
+    findAllByTestId: (id: import("@testing-library/react").Matcher, options?: import("@testing-library/react").MatcherOptions | undefined, waitForElementOptions?: import("@testing-library/react").waitForOptions | undefined) => Promise<HTMLElement[]>;
+};
+export {};

package/dist/types-ts4.5/common/utils/constants.d.ts

@@ -0,0 +1 @@
+export declare const EVENT_CHANNEL = "peopleTeams";

package/dist/types-ts4.5/common/utils/generated/analytics.types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::d5728d78d59f2a7bb511dc13bc1e6953>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
+ */
+export type PackageMetaDataType = {
+    packageName: string;
+    packageVersion: string;
+};
+export type ButtonClickedAnalyticsExampleAttributesType = {
+    testAttribute: string;
+};
+export type AutomationTriggeredAnalyticsExampleAttributesType = {
+    testAttribute: string;
+};
+export type AutomationFiredAnalyticsExampleAttributesType = {
+    testAttribute: string;
+};
+export type AnalyticsExampleScreenViewedAttributesType = {
+    testAttribute: string;
+};
+export type AnalyticsEventAttributes = {
+    /**
+     * fired when the teams-app-internal-analytics example button is clicked */
+    'ui.button.clicked.analyticsExample': ButtonClickedAnalyticsExampleAttributesType;
+    /**
+     * fired when the teams-app-internal-analytics example button is clicked */
+    'track.automation.triggered.analyticsExample': AutomationTriggeredAnalyticsExampleAttributesType;
+    /**
+     * fired when the teams-app-internal-analytics example button is clicked */
+    'operational.automation.fired.analyticsExample': AutomationFiredAnalyticsExampleAttributesType;
+    /**
+     * fired when the teams-app-internal-analytics example is viewed */
+    'screen.analyticsExampleScreen.viewed': AnalyticsExampleScreenViewedAttributesType;
+};
+export type EventKey = keyof AnalyticsEventAttributes;

package/dist/types-ts4.5/common/utils/generated/create-event-payload.d.ts

@@ -0,0 +1,31 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * Generates Typescript types for analytics events from analytics.spec.yaml
+ *
+ * @codegen <<SignedSource::050566410df453c9b1ba071c6805ead2>>
+ * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen teams-app-internal-analytics
+ */
+import type { AnalyticsEventAttributes, EventKey } from './analytics.types';
+type OptionalIfUndefined<T> = undefined extends T ? [
+    param?: T
+] : [
+    param: T
+];
+export type EventPayloadAttributes<K extends EventKey> = OptionalIfUndefined<AnalyticsEventAttributes[K]>;
+type EventTypes = 'ui' | 'track' | 'operational' | 'screen';
+type ScreenEventPayload<K extends EventKey> = {
+    eventType: 'screen';
+    name: string;
+    action: 'viewed';
+    attributes?: AnalyticsEventAttributes[K];
+};
+type EventPayload<K extends EventKey> = {
+    eventType: Omit<EventTypes, 'screen'>;
+    actionSubject: string;
+    action: string;
+    actionSubjectId?: string;
+    attributes?: AnalyticsEventAttributes[K];
+};
+declare const createEventPayload: <K extends EventKey>(eventKey: K, ...[attributes]: EventPayloadAttributes<K>) => ScreenEventPayload<K> | EventPayload<K>;
+export default createEventPayload;

package/dist/types-ts4.5/common/utils/generated/use-analytics-events.d.ts

@@ -0,0 +1,8 @@
+import type { EventKey } from './analytics.types';
+export declare const useAnalyticsEvents: () => {
+    fireEvent: <K extends EventKey>(eventKey: K, ...params: undefined extends import("./analytics.types").AnalyticsEventAttributes[K] ? [
+        param?: import("./analytics.types").AnalyticsEventAttributes[K] | undefined
+    ] : [
+        param: import("./analytics.types").AnalyticsEventAttributes[K]
+    ]) => void;
+};

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,2 @@
+export { TeamsAppAnalyticsContext } from './ui/analytics-context';
+export { useAnalyticsEvents } from './common/utils/generated/use-analytics-events';

package/dist/types-ts4.5/ui/analytics-context/index.d.ts

@@ -0,0 +1,12 @@
+import React, { type ReactNode } from 'react';
+import type { PackageMetaDataType } from '../../common/utils/generated/analytics.types';
+export declare const defaultAnalyticsContextData: PackageMetaDataType;
+type TeamsAppAnalyticsContextData = {
+    source?: string;
+    attributes?: Record<string, any>;
+};
+export declare function TeamsAppAnalyticsContext({ data, children, }: {
+    data?: TeamsAppAnalyticsContextData;
+    children: ReactNode;
+}): React.JSX.Element;
+export {};