@atlaskit/analytics-next 9.3.0 → 9.3.2

package/package.json

@@ -1,101 +1,100 @@
 {
-  "name": "@atlaskit/analytics-next",
-  "version": "9.3.0",
-  "description": "React components, HOCs and hooks to assist with tracking user activity with React components",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
-  "author": "Atlassian Pty Ltd",
-  "license": "Apache-2.0",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "module:es2019": "dist/es2019/index.js",
-  "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.5 <4.9": {
-      "*": [
-        "dist/types-ts4.5/*",
-        "dist/types-ts4.5/index.d.ts"
-      ]
-    }
-  },
-  "sideEffects": false,
-  "atlaskit:src": "src/index.ts",
-  "atlassian": {
-    "team": "UIP Frontend Observability",
-    "releaseModel": "continuous",
-    "productPushConsumption": [
-      "jira"
-    ],
-    "website": {
-      "name": "Analytics next"
-    }
-  },
-  "./types": "./src/types.ts",
-  "af:exports": {
-    "./types": "./src/types.ts",
-    "./AnalyticsContext": "./src/components/AnalyticsContext/index.tsx",
-    "./AnalyticsListener": "./src/components/AnalyticsListener/index.tsx",
-    "./AnalyticsErrorBoundary": "./src/components/AnalyticsErrorBoundary.tsx",
-    "./withAnalyticsEvents": "./src/hocs/withAnalyticsEvents.tsx",
-    "./withAnalyticsContext": "./src/hocs/withAnalyticsContext.tsx",
-    "./usePlatformLeafEventHandler": "./src/hooks/usePlatformLeafEventHandler.ts",
-    "./useAnalyticsEvents": "./src/hooks/useAnalyticsEvents.ts",
-    "./useCallbackWithAnalytics": "./src/hooks/useCallbackWithAnalytics.ts",
-    "./usePatchedProps": "./src/hooks/usePatchedProps.ts",
-    "./AnalyticsEvent": "./src/events/AnalyticsEvent.ts",
-    "./UIAnalyticsEvent": "./src/events/UIAnalyticsEvent.ts",
-    "./createAndFireEvents": "./src/utils/createAndFireEvent.ts",
-    ".": "./src/index.ts"
-  },
-  "dependencies": {
-    "@atlaskit/analytics-next-stable-react-context": "1.0.1",
-    "@atlaskit/platform-feature-flags": "^0.2.2",
-    "@babel/runtime": "^7.0.0",
-    "prop-types": "^15.5.10",
-    "use-memo-one": "^1.1.1"
-  },
-  "peerDependencies": {
-    "react": "^16.8.0"
-  },
-  "devDependencies": {
-    "@atlaskit/ssr": "*",
-    "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@atlassian/feature-flags-test-utils": "*",
-    "@testing-library/react": "^12.1.5",
-    "enzyme": "^3.10.0",
-    "react-dom": "^16.8.0",
-    "redux": "^3.7.2",
-    "storybook-addon-performance": "^0.16.0",
-    "typescript": "~5.4.2"
-  },
-  "techstack": {
-    "@atlassian/frontend": {
-      "import-structure": "atlassian-conventions"
-    },
-    "@repo/internal": {
-      "ui-components": [
-        "lite-mode"
-      ],
-      "analytics": [
-        "analytics-next"
-      ],
-      "design-tokens": [
-        "color"
-      ],
-      "theming": [
-        "react-context"
-      ],
-      "deprecation": [
-        "no-deprecated-imports"
-      ]
-    }
-  },
-  "platform-feature-flags": {
-    "platform.analytics-next-use-modern-context_fqgbx": {
-      "type": "boolean"
-    }
-  },
-  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
-}
+	"name": "@atlaskit/analytics-next",
+	"version": "9.3.2",
+	"description": "React components, HOCs and hooks to assist with tracking user activity with React components",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.ts",
+	"atlassian": {
+		"team": "UIP Frontend Observability",
+		"releaseModel": "continuous",
+		"productPushConsumption": [
+			"jira"
+		],
+		"website": {
+			"name": "Analytics next"
+		}
+	},
+	"./types": "./src/types.ts",
+	"af:exports": {
+		"./types": "./src/types.ts",
+		"./AnalyticsContext": "./src/components/AnalyticsContext/index.tsx",
+		"./AnalyticsListener": "./src/components/AnalyticsListener/index.tsx",
+		"./AnalyticsErrorBoundary": "./src/components/AnalyticsErrorBoundary.tsx",
+		"./withAnalyticsEvents": "./src/hocs/withAnalyticsEvents.tsx",
+		"./withAnalyticsContext": "./src/hocs/withAnalyticsContext.tsx",
+		"./usePlatformLeafEventHandler": "./src/hooks/usePlatformLeafEventHandler.ts",
+		"./useAnalyticsEvents": "./src/hooks/useAnalyticsEvents.ts",
+		"./useCallbackWithAnalytics": "./src/hooks/useCallbackWithAnalytics.ts",
+		"./usePatchedProps": "./src/hooks/usePatchedProps.ts",
+		"./AnalyticsEvent": "./src/events/AnalyticsEvent.ts",
+		"./UIAnalyticsEvent": "./src/events/UIAnalyticsEvent.ts",
+		"./createAndFireEvents": "./src/utils/createAndFireEvent.ts",
+		".": "./src/index.ts"
+	},
+	"dependencies": {
+		"@atlaskit/analytics-next-stable-react-context": "1.0.1",
+		"@atlaskit/platform-feature-flags": "^0.3.0",
+		"@babel/runtime": "^7.0.0",
+		"prop-types": "^15.5.10",
+		"use-memo-one": "^1.1.1"
+	},
+	"peerDependencies": {
+		"react": "^16.8.0 || ^17.0.0 || ~18.2.0"
+	},
+	"runReact18": true,
+	"devDependencies": {
+		"@atlaskit/ssr": "*",
+		"@atlassian/feature-flags-test-utils": "*",
+		"@testing-library/react": "^12.1.5",
+		"enzyme": "^3.10.0",
+		"react-dom-18": "npm:react-dom@^18.2.0",
+		"redux": "^3.7.2",
+		"storybook-addon-performance": "^0.16.0",
+		"typescript": "~5.4.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"import-structure": "atlassian-conventions"
+		},
+		"@repo/internal": {
+			"ui-components": [
+				"lite-mode"
+			],
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"deprecation": [
+				"no-deprecated-imports"
+			]
+		}
+	},
+	"platform-feature-flags": {
+		"platform.analytics-next-use-modern-context_fqgbx": {
+			"type": "boolean"
+		}
+	}
+}

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/analytics-next"
 
-> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using
+> [API Extractor](https://api-extractor.com/).
 > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ### Table of contents
@@ -28,70 +29,68 @@ export let AnalyticsContext: AnalyticsContextFunction;
 
 // @public (undocumented)
 type AnalyticsContextFunction = (
-  props: {
-    children: React.ReactNode;
-    data: Object;
-  },
-  context?: AnalyticsReactContextInterface,
+	props: {
+		children: React.ReactNode;
+		data: Object;
+	},
+	context?: AnalyticsReactContextInterface,
 ) => JSX.Element;
 
 // @public @deprecated (undocumented)
 export class AnalyticsErrorBoundary extends Component<
-  AnalyticsErrorBoundaryProps,
-  AnalyticsErrorBoundaryState
+	AnalyticsErrorBoundaryProps,
+	AnalyticsErrorBoundaryState
 > {
-  constructor(props: AnalyticsErrorBoundaryProps);
-  // (undocumented)
-  componentDidCatch(error: Error, info?: AnalyticsErrorBoundaryErrorInfo): void;
-  // (undocumented)
-  render(): JSX.Element | null;
+	constructor(props: AnalyticsErrorBoundaryProps);
+	// (undocumented)
+	componentDidCatch(error: Error, info?: AnalyticsErrorBoundaryErrorInfo): void;
+	// (undocumented)
+	render(): JSX.Element | null;
 }
 
 // @public (undocumented)
 type AnalyticsErrorBoundaryErrorInfo = {
-  componentStack: string;
+	componentStack: string;
 };
 
 // @public (undocumented)
 export interface AnalyticsErrorBoundaryProps {
-  // (undocumented)
-  channel: string;
-  children: ReactNode;
-  // (undocumented)
-  data: {};
-  // (undocumented)
-  ErrorComponent?: React_2.ComponentType;
-  // (undocumented)
-  onError?: (error: Error, info?: AnalyticsErrorBoundaryErrorInfo) => void;
+	// (undocumented)
+	channel: string;
+	children: ReactNode;
+	// (undocumented)
+	data: {};
+	// (undocumented)
+	ErrorComponent?: React_2.ComponentType;
+	// (undocumented)
+	onError?: (error: Error, info?: AnalyticsErrorBoundaryErrorInfo) => void;
 }
 
 // @public (undocumented)
 type AnalyticsErrorBoundaryState = {
-  hasError: boolean;
+	hasError: boolean;
 };
 
 // @public (undocumented)
 export class AnalyticsEvent {
-  constructor(props: AnalyticsEventProps);
-  // (undocumented)
-  clone: () => AnalyticsEvent | null;
-  // (undocumented)
-  _isAnalyticsEvent: boolean;
-  // (undocumented)
-  payload: AnalyticsEventPayload;
-  // (undocumented)
-  update(updater: AnalyticsEventUpdater): this;
+	constructor(props: AnalyticsEventProps);
+	// (undocumented)
+	clone: () => AnalyticsEvent | null;
+	// (undocumented)
+	_isAnalyticsEvent: boolean;
+	// (undocumented)
+	payload: AnalyticsEventPayload;
+	// (undocumented)
+	update(updater: AnalyticsEventUpdater): this;
 }
 
 // @public (undocumented)
-type AnalyticsEventCallback = (
-  payload: AnalyticsEventPayload,
-) => AnalyticsEventPayload;
+type AnalyticsEventCallback = (payload: AnalyticsEventPayload) => AnalyticsEventPayload;
 
 // @public (undocumented)
 type AnalyticsEventCreator = (
-  create: CreateUIAnalyticsEvent,
-  props: Record<string, any>,
+	create: CreateUIAnalyticsEvent,
+	props: Record<string, any>,
 ) => UIAnalyticsEvent | undefined;
 
 // @public (undocumented)
@@ -99,7 +98,7 @@ export type AnalyticsEventPayload = Record<string, any>;
 
 // @public (undocumented)
 export type AnalyticsEventProps = {
-  payload: AnalyticsEventPayload;
+	payload: AnalyticsEventPayload;
 };
 
 // @public (undocumented)
@@ -110,12 +109,12 @@ export let AnalyticsListener: AnalyticsListenerFunction;
 
 // @public (undocumented)
 type AnalyticsListenerFunction = (
-  props: {
-    children?: React.ReactNode;
-    channel?: string;
-    onEvent: (event: UIAnalyticsEvent, channel?: string) => void;
-  },
-  context?: AnalyticsReactContextInterface,
+	props: {
+		children?: React.ReactNode;
+		channel?: string;
+		onEvent: (event: UIAnalyticsEvent, channel?: string) => void;
+	},
+	context?: AnalyticsReactContextInterface,
 ) => JSX.Element;
 
 export { AnalyticsReactContext };
@@ -127,7 +126,7 @@ type ChannelIdentifier = string;
 
 // @public (undocumented)
 export function cleanProps(props: Record<string, any>): {
-  [x: string]: any;
+	[x: string]: any;
 };
 
 // @public (undocumented)
@@ -135,9 +134,9 @@ type Context = Record<string, any>[];
 
 // @public (undocumented)
 export const createAndFireEvent: (
-  channel?: string,
+	channel?: string,
 ) => (
-  payload: AnalyticsEventPayload,
+	payload: AnalyticsEventPayload,
 ) => (createAnalyticsEvent: CreateUIAnalyticsEvent) => UIAnalyticsEvent;
 
 // @public (undocumented)
@@ -147,9 +146,7 @@ type CreateEventMap = Record<string, CreateEventMapValue>;
 type CreateEventMapValue = AnalyticsEventCreator | AnalyticsEventPayload;
 
 // @public (undocumented)
-export type CreateUIAnalyticsEvent = (
-  payload: AnalyticsEventPayload,
-) => UIAnalyticsEvent;
+export type CreateUIAnalyticsEvent = (payload: AnalyticsEventPayload) => UIAnalyticsEvent;
 
 // @public (undocumented)
 export const isAnalyticsEvent: (obj: any) => boolean;
@@ -159,37 +156,35 @@ export const isUIAnalyticsEvent: (obj: any) => boolean;
 
 // @public (undocumented)
 export class UIAnalyticsEvent extends AnalyticsEvent {
-  constructor(props: UIAnalyticsEventProps);
-  // (undocumented)
-  clone: () => UIAnalyticsEvent | null;
-  // (undocumented)
-  context: Context;
-  // (undocumented)
-  fire: (channel?: string) => void;
-  // (undocumented)
-  handlers: UIAnalyticsEventHandler[];
-  // (undocumented)
-  hasFired: boolean;
-  // (undocumented)
-  _isUIAnalyticsEvent: boolean;
-  // (undocumented)
-  update(
-    updater:
-      | ((payload: AnalyticsEventPayload) => AnalyticsEventPayload)
-      | Record<string, any>,
-  ): this;
+	constructor(props: UIAnalyticsEventProps);
+	// (undocumented)
+	clone: () => UIAnalyticsEvent | null;
+	// (undocumented)
+	context: Context;
+	// (undocumented)
+	fire: (channel?: string) => void;
+	// (undocumented)
+	handlers: UIAnalyticsEventHandler[];
+	// (undocumented)
+	hasFired: boolean;
+	// (undocumented)
+	_isUIAnalyticsEvent: boolean;
+	// (undocumented)
+	update(
+		updater: ((payload: AnalyticsEventPayload) => AnalyticsEventPayload) | Record<string, any>,
+	): this;
 }
 
 // @public (undocumented)
 export type UIAnalyticsEventHandler = (
-  event: UIAnalyticsEvent,
-  channel?: ChannelIdentifier,
+	event: UIAnalyticsEvent,
+	channel?: ChannelIdentifier,
 ) => void;
 
 // @public (undocumented)
 export type UIAnalyticsEventProps = AnalyticsEventProps & {
-  context?: Context;
-  handlers?: UIAnalyticsEventHandler[];
+	context?: Context;
+	handlers?: UIAnalyticsEventHandler[];
 };
 
 // @public (undocumented)
@@ -197,7 +192,7 @@ export function useAnalyticsEvents(): UseAnalyticsEventsHook;
 
 // @public (undocumented)
 export type UseAnalyticsEventsHook = {
-  createAnalyticsEvent: CreateUIAnalyticsEvent;
+	createAnalyticsEvent: CreateUIAnalyticsEvent;
 };
 
 // @public (undocumented)
@@ -205,20 +200,20 @@ export const useCallbackWithAnalytics: UseCallbackWithAnalyticsHook;
 
 // @public (undocumented)
 export type UseCallbackWithAnalyticsHook = (
-  method: (...args: any[]) => void,
-  payload: ((...args: any[]) => void) | Record<string, any>,
-  channel?: string,
+	method: (...args: any[]) => void,
+	payload: ((...args: any[]) => void) | Record<string, any>,
+	channel?: string,
 ) => (...args: any[]) => void;
 
 // @public (undocumented)
 export function usePlatformLeafEventHandler<T>({
-  fn,
-  action,
-  componentName,
-  actionSubject,
-  packageName,
-  packageVersion,
-  analyticsData,
+	fn,
+	action,
+	componentName,
+	actionSubject,
+	packageName,
+	packageVersion,
+	analyticsData,
 }: UsePlatformLeafEventHandlerHookArgs<T>): (value: T) => void;
 
 // @public (undocumented)
@@ -226,23 +221,23 @@ export type UsePlatformLeafEventHandlerHook<T> = (value: T) => void;
 
 // @public (undocumented)
 export type UsePlatformLeafEventHandlerHookArgs<T> = {
-  fn: (value: T, analyticsEvent: UIAnalyticsEvent) => void;
-  action: string;
-  componentName: string;
-  actionSubject?: string;
-  packageName: string;
-  packageVersion: string;
-  analyticsData?: Record<string, any>;
+	fn: (value: T, analyticsEvent: UIAnalyticsEvent) => void;
+	action: string;
+	componentName: string;
+	actionSubject?: string;
+	packageName: string;
+	packageVersion: string;
+	analyticsData?: Record<string, any>;
 };
 
 // @public (undocumented)
 export function usePlatformLeafSyntheticEventHandler({
-  fn,
-  action,
-  componentName,
-  packageName,
-  packageVersion,
-  analyticsData,
+	fn,
+	action,
+	componentName,
+	packageName,
+	packageVersion,
+	analyticsData,
 }: UsePlatformLeafSyntheticEventHandlerHookArgs): () => void;
 
 // @public (undocumented)
@@ -250,52 +245,47 @@ export type UsePlatformLeafSyntheticEventHandlerHook = () => void;
 
 // @public (undocumented)
 export type UsePlatformLeafSyntheticEventHandlerHookArgs = {
-  fn: (analyticsEvent: UIAnalyticsEvent) => void;
-  action: string;
-  componentName: string;
-  packageName: string;
-  packageVersion: string;
-  analyticsData?: Record<string, any>;
+	fn: (analyticsEvent: UIAnalyticsEvent) => void;
+	action: string;
+	componentName: string;
+	packageName: string;
+	packageVersion: string;
+	analyticsData?: Record<string, any>;
 };
 
 // @public (undocumented)
 export const withAnalyticsContext: (
-  defaultData?: any,
+	defaultData?: any,
 ) => <Props, Component>(
-  WrappedComponent: React_2.JSXElementConstructor<Props> & Component,
+	WrappedComponent: React_2.JSXElementConstructor<Props> & Component,
 ) => React_2.ForwardRefExoticComponent<
-  React_2.PropsWithoutRef<
-    JSX.LibraryManagedAttributes<Component, Props & WithContextProps>
-  > &
-    React_2.RefAttributes<any>
+	React_2.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props & WithContextProps>> &
+		React_2.RefAttributes<any>
 >;
 
 // @public (undocumented)
 export const withAnalyticsEvents: (
-  createEventMap?: CreateEventMap,
+	createEventMap?: CreateEventMap,
 ) => <Props extends WithAnalyticsEventsProps, Component>(
-  WrappedComponent: React_2.JSXElementConstructor<Props> & Component,
+	WrappedComponent: React_2.JSXElementConstructor<Props> & Component,
 ) => React_2.ForwardRefExoticComponent<
-  React_2.PropsWithoutRef<
-    JSX.LibraryManagedAttributes<
-      Component,
-      Omit<Props, keyof WithAnalyticsEventsProps>
-    >
-  > &
-    React_2.RefAttributes<any>
+	React_2.PropsWithoutRef<
+		JSX.LibraryManagedAttributes<Component, Omit<Props, keyof WithAnalyticsEventsProps>>
+	> &
+		React_2.RefAttributes<any>
 >;
 
 // @public (undocumented)
 export interface WithAnalyticsEventsProps {
-  createAnalyticsEvent?: CreateUIAnalyticsEvent;
-  // (undocumented)
-  ref?: React_2.Ref<any>;
+	createAnalyticsEvent?: CreateUIAnalyticsEvent;
+	// (undocumented)
+	ref?: React_2.Ref<any>;
 }
 
 // @public (undocumented)
 export interface WithContextProps {
-  // (undocumented)
-  analyticsContext?: Record<string, any>;
+	// (undocumented)
+	analyticsContext?: Record<string, any>;
 }
 
 // (No @packageDocumentation comment for this package)
@@ -309,7 +299,7 @@ export interface WithContextProps {
 
 ```json
 {
-  "react": "^16.8.0"
+	"react": "^16.8.0"
 }
 ```