@atlaskit/analytics-next 8.3.1 → 8.3.3

package/dist/types-ts4.0/components/AnalyticsListener/types.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { AnalyticsReactContextInterface } from '@atlaskit/analytics-next-stable-react-context';
+import UIAnalyticsEvent from '../../events/UIAnalyticsEvent';
+export declare type AnalyticsListenerFunction = (props: {
+    /** Children! */
+    children?: React.ReactNode;
+    /** The channel to listen for events on. */
+    channel?: string;
+    /** A function which will be called when an event is fired on this Listener's
+     * channel. It is passed the event and the channel as arguments. */
+    onEvent: (event: UIAnalyticsEvent, channel?: string) => void;
+}, context?: AnalyticsReactContextInterface) => JSX.Element;

package/dist/types-ts4.0/events/AnalyticsEvent.d.ts

@@ -0,0 +1,15 @@
+export declare type AnalyticsEventPayload = Record<string, any>;
+declare type AnalyticsEventCallback = (payload: AnalyticsEventPayload) => AnalyticsEventPayload;
+declare type AnalyticsEventUpdater = AnalyticsEventPayload | AnalyticsEventCallback;
+export declare type AnalyticsEventProps = {
+    payload: AnalyticsEventPayload;
+};
+export declare const isAnalyticsEvent: (obj: any) => boolean;
+export default class AnalyticsEvent {
+    payload: AnalyticsEventPayload;
+    _isAnalyticsEvent: boolean;
+    constructor(props: AnalyticsEventProps);
+    clone: () => AnalyticsEvent | null;
+    update(updater: AnalyticsEventUpdater): this;
+}
+export {};

package/dist/types-ts4.0/events/UIAnalyticsEvent.d.ts

@@ -0,0 +1,20 @@
+import AnalyticsEvent, { AnalyticsEventPayload, AnalyticsEventProps } from './AnalyticsEvent';
+declare type ChannelIdentifier = string;
+declare type Context = Record<string, any>[];
+export declare type UIAnalyticsEventHandler = (event: UIAnalyticsEvent, channel?: ChannelIdentifier) => void;
+export declare type UIAnalyticsEventProps = AnalyticsEventProps & {
+    context?: Context;
+    handlers?: UIAnalyticsEventHandler[];
+};
+export declare const isUIAnalyticsEvent: (obj: any) => boolean;
+export default class UIAnalyticsEvent extends AnalyticsEvent {
+    context: Context;
+    handlers: UIAnalyticsEventHandler[];
+    hasFired: boolean;
+    _isUIAnalyticsEvent: boolean;
+    constructor(props: UIAnalyticsEventProps);
+    clone: () => UIAnalyticsEvent | null;
+    fire: (channel?: string | undefined) => void;
+    update(updater: Record<string, any> | ((payload: AnalyticsEventPayload) => AnalyticsEventPayload)): this;
+}
+export {};

package/dist/types-ts4.0/hocs/withAnalyticsContext.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface WithContextProps {
+    analyticsContext?: Record<string, any>;
+}
+declare const withAnalyticsContext: (defaultData?: any) => <Props, Component>(WrappedComponent: React.JSXElementConstructor<Props> & Component) => React.ForwardRefExoticComponent<React.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props & WithContextProps>> & React.RefAttributes<any>>;
+export default withAnalyticsContext;

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

@@ -0,0 +1,12 @@
+import React from 'react';
+import { CreateEventMap, CreateUIAnalyticsEvent } from '../types';
+export interface WithAnalyticsEventsProps {
+    /**
+     * You should not be accessing this prop under any circumstances.
+     * It is provided by `@atlaskit/analytics-next` and integrated in the component
+     */
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+    ref?: React.Ref<any>;
+}
+declare const withAnalyticsEvents: (createEventMap?: CreateEventMap) => <Props extends WithAnalyticsEventsProps, Component>(WrappedComponent: React.JSXElementConstructor<Props> & Component) => React.ForwardRefExoticComponent<React.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Omit<Props, keyof WithAnalyticsEventsProps>>> & React.RefAttributes<any>>;
+export default withAnalyticsEvents;

package/dist/types-ts4.0/hooks/useAnalyticsContext.d.ts

@@ -0,0 +1,2 @@
+import { AnalyticsReactContextInterface } from '@atlaskit/analytics-next-stable-react-context';
+export declare const useAnalyticsContext: () => AnalyticsReactContextInterface;

package/dist/types-ts4.0/hooks/useAnalyticsEvents.d.ts

@@ -0,0 +1,5 @@
+import { CreateUIAnalyticsEvent } from '../types';
+export declare type UseAnalyticsEventsHook = {
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+};
+export declare function useAnalyticsEvents(): UseAnalyticsEventsHook;

package/dist/types-ts4.0/hooks/useCallbackWithAnalytics.d.ts

@@ -0,0 +1,2 @@
+export declare type UseCallbackWithAnalyticsHook = (method: (...args: any[]) => void, payload: Record<string, any> | ((...args: any[]) => void), channel?: string) => (...args: any[]) => void;
+export declare const useCallbackWithAnalytics: UseCallbackWithAnalyticsHook;

package/dist/types-ts4.0/hooks/usePatchedProps.d.ts

@@ -0,0 +1,5 @@
+import { CreateEventMap } from '../types';
+export declare type PatchedPropsHook = {
+    patchedEventProps: CreateEventMap;
+};
+export declare function usePatchedProps<Props extends Record<string, any>>(createEventMap: CreateEventMap | undefined, wrappedComponentProps: Props): PatchedPropsHook;

package/dist/types-ts4.0/hooks/usePlatformLeafEventHandler.d.ts

@@ -0,0 +1,12 @@
+import UIAnalyticsEvent from '../events/UIAnalyticsEvent';
+export declare type UsePlatformLeafEventHandlerHookArgs<T> = {
+    fn: (value: T, analyticsEvent: UIAnalyticsEvent) => void;
+    action: string;
+    componentName: string;
+    actionSubject?: string;
+    packageName: string;
+    packageVersion: string;
+    analyticsData?: Record<string, any>;
+};
+export declare type UsePlatformLeafEventHandlerHook<T> = (value: T) => void;
+export declare function usePlatformLeafEventHandler<T>({ fn, action, componentName, actionSubject, packageName, packageVersion, analyticsData, }: UsePlatformLeafEventHandlerHookArgs<T>): (value: T) => void;

package/dist/types-ts4.0/hooks/usePlatformLeafSyntheticEventHandler.d.ts

@@ -0,0 +1,11 @@
+import UIAnalyticsEvent from '../events/UIAnalyticsEvent';
+export declare type UsePlatformLeafSyntheticEventHandlerHookArgs = {
+    fn: (analyticsEvent: UIAnalyticsEvent) => void;
+    action: string;
+    componentName: string;
+    packageName: string;
+    packageVersion: string;
+    analyticsData?: Record<string, any>;
+};
+export declare type UsePlatformLeafSyntheticEventHandlerHook = () => void;
+export declare function usePlatformLeafSyntheticEventHandler({ fn, action, componentName, packageName, packageVersion, analyticsData, }: UsePlatformLeafSyntheticEventHandlerHookArgs): () => void;

package/dist/types-ts4.0/hooks/useTrackedRef.d.ts

@@ -0,0 +1,2 @@
+import { MutableRefObject } from 'react';
+export declare const useTrackedRef: <T>(value: T) => MutableRefObject<T>;

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

@@ -0,0 +1,25 @@
+export type { CreateUIAnalyticsEvent } from './types';
+export { default as AnalyticsEvent, isAnalyticsEvent, } from './events/AnalyticsEvent';
+export type { AnalyticsEventPayload, AnalyticsEventProps, } from './events/AnalyticsEvent';
+export { default as UIAnalyticsEvent, isUIAnalyticsEvent, } from './events/UIAnalyticsEvent';
+export type { UIAnalyticsEventProps, UIAnalyticsEventHandler, } from './events/UIAnalyticsEvent';
+export { default as AnalyticsListener } from './components/AnalyticsListener/index';
+export { default as AnalyticsContext } from './components/AnalyticsContext/index';
+export { default as withAnalyticsContext } from './hocs/withAnalyticsContext';
+export type { WithContextProps } from './hocs/withAnalyticsContext';
+export { default as AnalyticsErrorBoundary } from './components/AnalyticsErrorBoundary';
+export type { AnalyticsErrorBoundaryProps } from './components/AnalyticsErrorBoundary';
+export { default as withAnalyticsEvents } from './hocs/withAnalyticsEvents';
+export type { WithAnalyticsEventsProps } from './hocs/withAnalyticsEvents';
+export { default as AnalyticsReactContext } from '@atlaskit/analytics-next-stable-react-context';
+export type { AnalyticsReactContextInterface } from '@atlaskit/analytics-next-stable-react-context';
+export { useAnalyticsEvents } from './hooks/useAnalyticsEvents';
+export type { UseAnalyticsEventsHook } from './hooks/useAnalyticsEvents';
+export { useCallbackWithAnalytics } from './hooks/useCallbackWithAnalytics';
+export type { UseCallbackWithAnalyticsHook } from './hooks/useCallbackWithAnalytics';
+export { usePlatformLeafEventHandler } from './hooks/usePlatformLeafEventHandler';
+export type { UsePlatformLeafEventHandlerHookArgs, UsePlatformLeafEventHandlerHook, } from './hooks/usePlatformLeafEventHandler';
+export { usePlatformLeafSyntheticEventHandler } from './hooks/usePlatformLeafSyntheticEventHandler';
+export type { UsePlatformLeafSyntheticEventHandlerHookArgs, UsePlatformLeafSyntheticEventHandlerHook, } from './hooks/usePlatformLeafSyntheticEventHandler';
+export { default as createAndFireEvent } from './utils/createAndFireEvent';
+export { default as cleanProps } from './utils/cleanProps';

package/dist/types-ts4.0/performance/examples.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const UsePlatformLeafEventHandlerHookTest: () => JSX.Element;
+export declare const UseAnalyticsEventHookTest: () => JSX.Element;
+export declare const UseCallbackWithAnalyticsHookTest: () => JSX.Element;
+export declare const HOCSTest: () => JSX.Element;

package/dist/types-ts4.0/test-utils/useRenderCounter.d.ts

@@ -0,0 +1 @@
+export declare const useRenderCounter: () => number;

package/dist/types-ts4.0/types.d.ts

@@ -0,0 +1,6 @@
+import { AnalyticsEventPayload } from './events/AnalyticsEvent';
+import UIAnalyticsEvent from './events/UIAnalyticsEvent';
+export declare type CreateUIAnalyticsEvent = (payload: AnalyticsEventPayload) => UIAnalyticsEvent;
+export declare type AnalyticsEventCreator = (create: CreateUIAnalyticsEvent, props: Record<string, any>) => UIAnalyticsEvent | undefined;
+export declare type CreateEventMapValue = AnalyticsEventPayload | AnalyticsEventCreator;
+export declare type CreateEventMap = Record<string, CreateEventMapValue>;

package/dist/types-ts4.0/utils/cleanProps.d.ts

@@ -0,0 +1,3 @@
+export default function cleanProps(props: Record<string, any>): {
+    [x: string]: any;
+};

package/dist/types-ts4.0/utils/createAndFireEvent.d.ts

@@ -0,0 +1,4 @@
+import { AnalyticsEventPayload } from '../events/AnalyticsEvent';
+import { CreateUIAnalyticsEvent } from '../types';
+declare const _default: (channel?: string | undefined) => (payload: AnalyticsEventPayload) => (createAnalyticsEvent: CreateUIAnalyticsEvent) => import("..").UIAnalyticsEvent;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/analytics-next",
-  "version": "8.3.1",
+  "version": "8.3.3",
   "description": "React components, HOCs and hooks to assist with tracking user activity with React components",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "atlassian": {
@@ -51,14 +58,14 @@
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
     "@atlaskit/ssr": "*",
-    "@atlaskit/textfield": "^5.0.0",
+    "@atlaskit/textfield": "^5.2.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@testing-library/react": "^8.0.1",
+    "@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": "4.2.4"
+    "typescript": "4.5.5"
   },
   "techstack": {
     "@atlassian/frontend": {