@atlaskit/analytics-next 9.1.2 → 9.1.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/analytics-next
 
+## 9.1.3
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 9.1.2
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/analytics-next",
-	"version": "9.1.2",
+	"version": "9.1.3",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/analytics-next",
-	"version": "9.1.2",
+	"version": "9.1.3",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/analytics-next",
-	"version": "9.1.2",
+	"version": "9.1.3",
 	"sideEffects": false
 }

package/dist/types-ts4.5/components/AnalyticsContext/LegacyAnalyticsContext.d.ts

@@ -0,0 +1,29 @@
+import React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import { AnalyticsReactContextInterface } from '@atlaskit/analytics-next-stable-react-context';
+interface Props {
+    /** Children! */
+    children: React.ReactNode;
+    /** Arbitrary data. Any events created below this component in the tree will
+     * have this added as an item in their context array. */
+    data: Object;
+}
+declare class AnalyticsContext extends Component<Props, AnalyticsReactContextInterface> {
+    static contextTypes: {
+        getAtlaskitAnalyticsContext: PropTypes.Requireable<(...args: any[]) => any>;
+        getAtlaskitAnalyticsEventHandlers: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    static childContextTypes: {
+        getAtlaskitAnalyticsContext: PropTypes.Requireable<(...args: any[]) => any>;
+        getAtlaskitAnalyticsEventHandlers: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    contextValue: AnalyticsReactContextInterface;
+    constructor(props: Props);
+    getChildContext: () => {
+        getAtlaskitAnalyticsContext: () => any[];
+    };
+    getAnalyticsContext: () => any[];
+    getAnalyticsEventHandlers: () => any;
+    render(): JSX.Element;
+}
+export default AnalyticsContext;

package/dist/types-ts4.5/components/AnalyticsContext/ModernAnalyticsContext.d.ts

@@ -0,0 +1,3 @@
+import { AnalyticsContextFunction } from './types';
+declare const AnalyticsContext: AnalyticsContextFunction;
+export default AnalyticsContext;

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

@@ -0,0 +1,3 @@
+import { AnalyticsContextFunction } from './types';
+declare let ExportedAnalyticsContext: AnalyticsContextFunction;
+export default ExportedAnalyticsContext;

package/dist/types-ts4.5/components/AnalyticsContext/types.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { AnalyticsReactContextInterface } from '@atlaskit/analytics-next-stable-react-context';
+export type AnalyticsContextFunction = (props: {
+    /** Children! */
+    children: React.ReactNode;
+    /** Arbitrary data. Any events created below this component in the tree will
+     * have this added as an item in their context array. */
+    data: Object;
+}, context?: AnalyticsReactContextInterface) => JSX.Element;

package/dist/types-ts4.5/components/AnalyticsErrorBoundary.d.ts

@@ -0,0 +1,24 @@
+import React, { Component, ReactNode } from 'react';
+type AnalyticsErrorBoundaryErrorInfo = {
+    componentStack: string;
+};
+export interface AnalyticsErrorBoundaryProps {
+    /** React component to be wrapped */
+    children: ReactNode;
+    channel: string;
+    data: {};
+    ErrorComponent?: React.ComponentType;
+    onError?: (error: Error, info?: AnalyticsErrorBoundaryErrorInfo) => void;
+}
+type AnalyticsErrorBoundaryState = {
+    hasError: boolean;
+};
+/**
+ *  @deprecated
+ */
+export default class AnalyticsErrorBoundary extends Component<AnalyticsErrorBoundaryProps, AnalyticsErrorBoundaryState> {
+    constructor(props: AnalyticsErrorBoundaryProps);
+    componentDidCatch(error: Error, info?: AnalyticsErrorBoundaryErrorInfo): void;
+    render(): JSX.Element | null;
+}
+export {};

package/dist/types-ts4.5/components/AnalyticsListener/LegacyAnalyticsListener.d.ts

@@ -0,0 +1,33 @@
+import React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import { AnalyticsReactContextInterface } from '@atlaskit/analytics-next-stable-react-context';
+import UIAnalyticsEvent from '../../events/UIAnalyticsEvent';
+type 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;
+};
+declare class AnalyticsListener extends Component<Props> {
+    static contextTypes: {
+        getAtlaskitAnalyticsEventHandlers: PropTypes.Requireable<(...args: any[]) => any>;
+        getAtlaskitAnalyticsContext: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    static childContextTypes: {
+        getAtlaskitAnalyticsEventHandlers: PropTypes.Requireable<(...args: any[]) => any>;
+        getAtlaskitAnalyticsContext: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    contextValue: AnalyticsReactContextInterface;
+    constructor(props: Props);
+    getChildContext: () => {
+        getAtlaskitAnalyticsEventHandlers: () => any[];
+        getAtlaskitAnalyticsContext: () => any;
+    };
+    getAnalyticsEventHandlers: () => any[];
+    getAtlaskitAnalyticsContext: () => any;
+    render(): JSX.Element;
+}
+export default AnalyticsListener;

package/dist/types-ts4.5/components/AnalyticsListener/ModernAnalyticsListener.d.ts

@@ -0,0 +1,3 @@
+import { AnalyticsListenerFunction } from './types';
+declare const AnalyticsListener: AnalyticsListenerFunction;
+export default AnalyticsListener;

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

@@ -0,0 +1,3 @@
+import { AnalyticsListenerFunction } from './types';
+declare let ExportedAnalyticsListener: AnalyticsListenerFunction;
+export default ExportedAnalyticsListener;

package/dist/types-ts4.5/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 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.5/events/AnalyticsEvent.d.ts

@@ -0,0 +1,15 @@
+export type AnalyticsEventPayload = Record<string, any>;
+type AnalyticsEventCallback = (payload: AnalyticsEventPayload) => AnalyticsEventPayload;
+type AnalyticsEventUpdater = AnalyticsEventPayload | AnalyticsEventCallback;
+export 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.5/events/UIAnalyticsEvent.d.ts

@@ -0,0 +1,20 @@
+import AnalyticsEvent, { AnalyticsEventPayload, AnalyticsEventProps } from './AnalyticsEvent';
+type ChannelIdentifier = string;
+type Context = Record<string, any>[];
+export type UIAnalyticsEventHandler = (event: UIAnalyticsEvent, channel?: ChannelIdentifier) => void;
+export 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) => void;
+    update(updater: Record<string, any> | ((payload: AnalyticsEventPayload) => AnalyticsEventPayload)): this;
+}
+export {};

package/dist/types-ts4.5/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.5/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.5/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.5/hooks/useAnalyticsEvents.d.ts

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

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

@@ -0,0 +1,2 @@
+export 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.5/hooks/usePatchedProps.d.ts

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

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

@@ -0,0 +1,12 @@
+import UIAnalyticsEvent from '../events/UIAnalyticsEvent';
+export type UsePlatformLeafEventHandlerHookArgs<T> = {
+    fn: (value: T, analyticsEvent: UIAnalyticsEvent) => void;
+    action: string;
+    componentName: string;
+    actionSubject?: string;
+    packageName: string;
+    packageVersion: string;
+    analyticsData?: Record<string, any>;
+};
+export 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.5/hooks/usePlatformLeafSyntheticEventHandler.d.ts

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

package/dist/types-ts4.5/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.5/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.5/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.5/test-utils/useRenderCounter.d.ts

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

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

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

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/analytics-next",
-  "version": "9.1.2",
+  "version": "9.1.3",
   "description": "React components, HOCs and hooks to assist with tracking user activity with React components",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"