@atlaskit/analytics-next 10.1.1 → 10.2.1

package/dist/types/index.d.ts

@@ -23,3 +23,6 @@ export { usePlatformLeafSyntheticEventHandler } from './hooks/usePlatformLeafSyn
 export type { UsePlatformLeafSyntheticEventHandlerHookArgs, UsePlatformLeafSyntheticEventHandlerHook, } from './hooks/usePlatformLeafSyntheticEventHandler';
 export { default as createAndFireEvent } from './utils/createAndFireEvent';
 export { default as cleanProps } from './utils/cleanProps';
+export { default as AnalyticsDecorator } from './components/AnalyticsDecorator';
+export { default as AnalyticsDelegate } from './components/AnalyticsDelegate';
+export { default as withAnalytics } from './utils/withAnalytics';

package/dist/types/utils/withAnalytics.d.ts

@@ -0,0 +1,80 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+type AnalyticsData = {
+    [key: string]: any;
+};
+type WithAnalyticsProps = {
+    analyticsId?: string;
+    analyticsData?: AnalyticsData;
+    fireAnalyticsEvent?: (name: string, data?: AnalyticsData) => void;
+    firePrivateAnalyticsEvent?: (name: string, data?: AnalyticsData) => void;
+    getParentAnalyticsData?: (name: string) => AnalyticsData;
+    delegateAnalyticsEvent?: (analyticsId: string, data: any, isPrivate: boolean) => void;
+    innerRef?: React.Ref<any>;
+    [key: string]: any;
+};
+type WithAnalyticsState = {
+    evaluatedMap: {
+        [key: string]: string | ((...args: any[]) => void);
+    };
+};
+/**
+ * The withAnalytics HOC wraps a component and provides the `fireAnalyticsEvent`
+ * and `firePrivateAnalyticsEvent` methods to it as props. It contains the logic
+ * for how to fire events, including handling the analyticsId and analyticsData
+ * props. The `map` argument may be an object or a function that returns an object.
+ * The properties of the `map` object/result can be strings (the name of the event
+ * that will be fired) or functions (which are responsible for firing the event).
+ * You can specify a default `analyticsId` and `analyticsData` with the `defaultProps`
+ * param. Please be aware that specifying a default `analyticsId` will cause public
+ * events to always fire for your component unless it has been set to a falsy by
+ * the component consumer.
+ *
+ * @param WrappedComponent
+ * @param map
+ * @param defaultProps
+ * @param withDelegation
+ */
+declare const withAnalytics: (WrappedComponent: React.ComponentType<any>, map?: {
+    [key: string]: string | ((...args: any[]) => void);
+} | ((fireAnalyticsEvent: (name: string, data?: AnalyticsData) => void) => {
+    [key: string]: string | ((...args: any[]) => void);
+}), defaultProps?: Partial<WithAnalyticsProps>, withDelegation?: boolean) => {
+    new (props: WithAnalyticsProps): {
+        componentDidMount(): void;
+        delegateAnalyticsEvent: (analyticsId: string, data: any, isPrivate: boolean) => void;
+        fireAnalyticsEvent: (name: string, data?: AnalyticsData) => void;
+        privateAnalyticsEvent: (name: string, data?: AnalyticsData) => void;
+        getParentAnalyticsData: (name: string) => AnalyticsData;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends "evaluatedMap">(state: WithAnalyticsState | ((prevState: Readonly<WithAnalyticsState>, props: Readonly<WithAnalyticsProps>) => WithAnalyticsState | Pick<WithAnalyticsState, K> | null) | Pick<WithAnalyticsState, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<WithAnalyticsProps> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<WithAnalyticsState>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        shouldComponentUpdate?(nextProps: Readonly<WithAnalyticsProps>, nextState: Readonly<WithAnalyticsState>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<WithAnalyticsProps>, prevState: Readonly<WithAnalyticsState>): any;
+        componentDidUpdate?(prevProps: Readonly<WithAnalyticsProps>, prevState: Readonly<WithAnalyticsState>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<WithAnalyticsProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<WithAnalyticsProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<WithAnalyticsProps>, nextState: Readonly<WithAnalyticsState>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<WithAnalyticsProps>, nextState: Readonly<WithAnalyticsState>, nextContext: any): void;
+    };
+    displayName: string;
+    contextTypes: {
+        onAnalyticsEvent: PropTypes.Requireable<(...args: any[]) => any>;
+        getParentAnalyticsData: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    defaultProps: Partial<WithAnalyticsProps>;
+    contextType?: React.Context<any> | undefined;
+};
+export default withAnalytics;

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

@@ -0,0 +1,46 @@
+import React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import { type Matcher } from '../matchEvent';
+type AnalyticsData = {
+    [key: string]: any;
+};
+type AnalyticsDecoratorProps = {
+    match: Matcher;
+    matchPrivate: boolean;
+    data?: AnalyticsData;
+    getData?: (name: string, data: AnalyticsData) => AnalyticsData;
+    children: React.ReactNode;
+};
+type AnalyticsDecoratorContext = {
+    onAnalyticsEvent?: (name: string, data: AnalyticsData, isPrivate: boolean) => void;
+    getParentAnalyticsData?: (name: string, isPrivate: boolean) => AnalyticsData;
+};
+export declare const ContextTypes: {
+    onAnalyticsEvent: PropTypes.Requireable<(...args: any[]) => any>;
+    getParentAnalyticsData: PropTypes.Requireable<(...args: any[]) => any>;
+};
+/**
+ * The Decorator component extends analytics event data
+ * for any events fired by its descendents,
+ * then passes the event up the hierarchy
+ */
+export declare class AnalyticsDecorator extends Component<AnalyticsDecoratorProps> {
+    static defaultProps: {
+        match: string;
+        matchPrivate: boolean;
+    };
+    static contextTypes: {
+        onAnalyticsEvent: PropTypes.Requireable<(...args: any[]) => any>;
+        getParentAnalyticsData: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    static childContextTypes: {
+        onAnalyticsEvent: PropTypes.Requireable<(...args: any[]) => any>;
+        getParentAnalyticsData: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    getChildContext(): AnalyticsDecoratorContext;
+    getDecoratedAnalyticsData: (name: string, srcData: AnalyticsData, isPrivate: boolean) => AnalyticsData;
+    onAnalyticsEvent: (name: string, srcData: AnalyticsData, isPrivate: boolean) => void;
+    getParentAnalyticsData: (name: string, isPrivate: boolean) => AnalyticsData;
+    render(): boolean | {} | React.ReactChild | React.ReactPortal | null | undefined;
+}
+export default AnalyticsDecorator;

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

@@ -0,0 +1,25 @@
+import React, { Component } from 'react';
+import PropTypes from 'prop-types';
+type AnalyticsDelegateProps = {
+    delegateAnalyticsEvent?: (name: string, data: any, isPrivate: boolean) => void;
+    children: React.ReactNode;
+};
+type AnalyticsDelegateContext = {
+    onAnalyticsEvent?: (name: string, data: any, isPrivate: boolean) => void;
+};
+/**
+ * Listens to public and private events and delegates to an analytics
+ * stack in a different React root.
+ */
+declare class AnalyticsDelegate extends Component<AnalyticsDelegateProps> {
+    static contextTypes: {
+        onAnalyticsEvent: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    static childContextTypes: {
+        onAnalyticsEvent: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    getChildContext(): AnalyticsDelegateContext;
+    onAnalyticsEvent: (name: string, data: any, isPrivate: boolean) => void;
+    render(): boolean | {} | React.ReactChild | React.ReactPortal | null | undefined;
+}
+export default AnalyticsDelegate;

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

@@ -0,0 +1,3 @@
+export type Matcher = string | RegExp | ((name: string) => boolean) | '*';
+declare function matchEvent(matcher: Matcher, name: string): boolean;
+export default matchEvent;

package/dist/types-ts4.5/hocs/withAnalyticsEvents.d.ts

@@ -8,5 +8,5 @@ export interface WithAnalyticsEventsProps {
     createAnalyticsEvent?: CreateUIAnalyticsEvent;
     ref?: React.Ref<any>;
 }
-declare const withAnalyticsEvents: (createEventMap?: CreateEventMap) => <Props extends WithAnalyticsEventsProps, Component>(WrappedComponent: React.ComponentType<Props> & Component) => React.ForwardRefExoticComponent<React.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Omit<Props, keyof WithAnalyticsEventsProps>>> & React.RefAttributes<any>>;
+declare const withAnalyticsEvents: (createEventMap?: CreateEventMap) => <Props, Component>(WrappedComponent: React.ComponentType<WithAnalyticsEventsProps & Props> & Component) => React.ForwardRefExoticComponent<React.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Omit<Props, keyof WithAnalyticsEventsProps>>> & React.RefAttributes<any>>;
 export default withAnalyticsEvents;

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

@@ -23,3 +23,6 @@ export { usePlatformLeafSyntheticEventHandler } from './hooks/usePlatformLeafSyn
 export type { UsePlatformLeafSyntheticEventHandlerHookArgs, UsePlatformLeafSyntheticEventHandlerHook, } from './hooks/usePlatformLeafSyntheticEventHandler';
 export { default as createAndFireEvent } from './utils/createAndFireEvent';
 export { default as cleanProps } from './utils/cleanProps';
+export { default as AnalyticsDecorator } from './components/AnalyticsDecorator';
+export { default as AnalyticsDelegate } from './components/AnalyticsDelegate';
+export { default as withAnalytics } from './utils/withAnalytics';

package/dist/types-ts4.5/utils/withAnalytics.d.ts

@@ -0,0 +1,80 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+type AnalyticsData = {
+    [key: string]: any;
+};
+type WithAnalyticsProps = {
+    analyticsId?: string;
+    analyticsData?: AnalyticsData;
+    fireAnalyticsEvent?: (name: string, data?: AnalyticsData) => void;
+    firePrivateAnalyticsEvent?: (name: string, data?: AnalyticsData) => void;
+    getParentAnalyticsData?: (name: string) => AnalyticsData;
+    delegateAnalyticsEvent?: (analyticsId: string, data: any, isPrivate: boolean) => void;
+    innerRef?: React.Ref<any>;
+    [key: string]: any;
+};
+type WithAnalyticsState = {
+    evaluatedMap: {
+        [key: string]: string | ((...args: any[]) => void);
+    };
+};
+/**
+ * The withAnalytics HOC wraps a component and provides the `fireAnalyticsEvent`
+ * and `firePrivateAnalyticsEvent` methods to it as props. It contains the logic
+ * for how to fire events, including handling the analyticsId and analyticsData
+ * props. The `map` argument may be an object or a function that returns an object.
+ * The properties of the `map` object/result can be strings (the name of the event
+ * that will be fired) or functions (which are responsible for firing the event).
+ * You can specify a default `analyticsId` and `analyticsData` with the `defaultProps`
+ * param. Please be aware that specifying a default `analyticsId` will cause public
+ * events to always fire for your component unless it has been set to a falsy by
+ * the component consumer.
+ *
+ * @param WrappedComponent
+ * @param map
+ * @param defaultProps
+ * @param withDelegation
+ */
+declare const withAnalytics: (WrappedComponent: React.ComponentType<any>, map?: {
+    [key: string]: string | ((...args: any[]) => void);
+} | ((fireAnalyticsEvent: (name: string, data?: AnalyticsData) => void) => {
+    [key: string]: string | ((...args: any[]) => void);
+}), defaultProps?: Partial<WithAnalyticsProps>, withDelegation?: boolean) => {
+    new (props: WithAnalyticsProps): {
+        componentDidMount(): void;
+        delegateAnalyticsEvent: (analyticsId: string, data: any, isPrivate: boolean) => void;
+        fireAnalyticsEvent: (name: string, data?: AnalyticsData) => void;
+        privateAnalyticsEvent: (name: string, data?: AnalyticsData) => void;
+        getParentAnalyticsData: (name: string) => AnalyticsData;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends "evaluatedMap">(state: WithAnalyticsState | ((prevState: Readonly<WithAnalyticsState>, props: Readonly<WithAnalyticsProps>) => WithAnalyticsState | Pick<WithAnalyticsState, K> | null) | Pick<WithAnalyticsState, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<WithAnalyticsProps> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<WithAnalyticsState>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        shouldComponentUpdate?(nextProps: Readonly<WithAnalyticsProps>, nextState: Readonly<WithAnalyticsState>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<WithAnalyticsProps>, prevState: Readonly<WithAnalyticsState>): any;
+        componentDidUpdate?(prevProps: Readonly<WithAnalyticsProps>, prevState: Readonly<WithAnalyticsState>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<WithAnalyticsProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<WithAnalyticsProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<WithAnalyticsProps>, nextState: Readonly<WithAnalyticsState>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<WithAnalyticsProps>, nextState: Readonly<WithAnalyticsState>, nextContext: any): void;
+    };
+    displayName: string;
+    contextTypes: {
+        onAnalyticsEvent: PropTypes.Requireable<(...args: any[]) => any>;
+        getParentAnalyticsData: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    defaultProps: Partial<WithAnalyticsProps>;
+    contextType?: React.Context<any> | undefined;
+};
+export default withAnalytics;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/analytics-next",
-	"version": "10.1.1",
+	"version": "10.2.1",
 	"description": "React components, HOCs and hooks to assist with tracking user activity with React components",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -33,6 +33,9 @@
 	"af:exports": {
 		"./types": "./src/types.ts",
 		"./AnalyticsContext": "./src/components/AnalyticsContext/index.tsx",
+		"./AnalyticsDecorator": "./src/components/AnalyticsDecorator/index.ts",
+		"./AnalyticsDelegate": "./src/components/AnalyticsDelegate/index.ts",
+		"./withAnalytics": "./src/utils/withAnalytics.tsx",
 		"./AnalyticsListener": "./src/components/AnalyticsListener/index.tsx",
 		"./AnalyticsErrorBoundary": "./src/components/AnalyticsErrorBoundary.tsx",
 		"./withAnalyticsEvents": "./src/hocs/withAnalyticsEvents.tsx",
@@ -54,16 +57,21 @@
 		"use-memo-one": "^1.1.1"
 	},
 	"peerDependencies": {
-		"react": "^16.8.0 || ^17.0.0 || ^18.0.0",
-		"react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
+		"react": "^16.8.0 || ^17.0.0 || ^18.2.0",
+		"react-dom": "^16.8.0 || ^17.0.0 || ^18.2.0"
 	},
 	"devDependencies": {
 		"@atlaskit/ssr": "*",
 		"@atlassian/feature-flags-test-utils": "*",
 		"@testing-library/react": "^12.1.5",
-		"storybook-addon-performance": "^0.16.0",
+		"storybook-addon-performance": "^0.17.3",
 		"typescript": "~5.4.2"
 	},
+	"overrides": {
+		"@atlaskit/analytics-next-stable-react-context": {
+			"react": "^18.2.0"
+		}
+	},
 	"techstack": {
 		"@atlassian/frontend": {
 			"import-structure": "atlassian-conventions"
@@ -87,7 +95,7 @@
 		}
 	},
 	"platform-feature-flags": {
-		"platform.analytics-next-use-modern-context_fqgbx": {
+		"analytics-next-use-modern-context_jira": {
 			"type": "boolean"
 		}
 	}

package/withAnalytics/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/analytics-next/withAnalytics",
+  "main": "../dist/cjs/utils/withAnalytics.js",
+  "module": "../dist/esm/utils/withAnalytics.js",
+  "module:es2019": "../dist/es2019/utils/withAnalytics.js",
+  "sideEffects": false,
+  "types": "../dist/types/utils/withAnalytics.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/utils/withAnalytics.d.ts"
+      ]
+    }
+  }
+}