@atlaskit/analytics-next 9.1.0 → 9.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/analytics-next
 
+## 9.1.1
+
+### Patch Changes
+
+- [`7cc1e8f18ec`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7cc1e8f18ec) - Move analytics-next to maintenance mode
+
 ## 9.1.0
 
 ### Minor Changes

package/README.md

@@ -2,7 +2,7 @@
 Tools for tracking interactions with UI components. Easily capture UI context and state when these events occur.
 
 > **_Maintaince Mode:_** \
-This package is officially in maintenance mode, which means only bugfixes or VULN fixes are currently being accepted and no breaking changes will be approved in the PR process. \
+This package is officially in maintenance mode, which means only bugfixes or VULN fixes are currently being accepted and no known breaking changes will be approved in the PR process. \
 Please refer to this [DACI](https://hello.atlassian.net/wiki/spaces/APD/pages/2470435075/DACI+analytics-next+in+a+maintenance+mode) for more details.
 
 ## Installation

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

package/docs/0-intro.tsx

@@ -1,9 +1,29 @@
+import React from 'react';
+
 import { md } from '@atlaskit/docs';
+import SectionMessage from '@atlaskit/section-message';
 
 export default md`
-> **_Maintaince Mode:_** \
-> This package is officially in maintenance mode, which means only bugfixes or VULN fixes are currently being accepted and no breaking changes will be approved in the PR process. \
-> Please refer to this [DACI](https://hello.atlassian.net/wiki/spaces/APD/pages/2470435075/DACI+analytics-next+in+a+maintenance+mode) for more details.
+
+${(
+  <SectionMessage
+    appearance="warning"
+    title="Maintaince Mode: @atlaskit/analytics is in maintenance mode."
+  >
+    This package is officially in maintenance mode, which means only bugfixes or
+    VULN fixes are currently being accepted and no known breaking changes will
+    be approved in the PR process. <br />
+    Please refer to this
+    <a
+      href="https://hello.atlassian.net/wiki/spaces/APD/pages/2470435075/DACI+analytics-next+in+a+maintenance+mode"
+      target="_blank"
+    >
+      {' '}
+      DACI{' '}
+    </a>{' '}
+    for more details.
+  </SectionMessage>
+)}
 
 This package aims to help assist consumers track the way their React components are being used.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/analytics-next",
-  "version": "9.1.0",
+  "version": "9.1.1",
   "description": "React components, HOCs and hooks to assist with tracking user activity with React components",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -53,6 +53,7 @@
   "devDependencies": {
     "@atlaskit/button": "^16.7.0",
     "@atlaskit/docs": "*",
+    "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/textfield": "^5.4.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,225 @@
+## API Report File for "@atlaskit/analytics-next"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import { default as AnalyticsReactContext } from '@atlaskit/analytics-next-stable-react-context';
+import { AnalyticsReactContextInterface } from '@atlaskit/analytics-next-stable-react-context';
+import { Component } from 'react';
+import { default as React_2 } from 'react';
+import { ReactNode } from 'react';
+
+// @public (undocumented)
+export let AnalyticsContext: AnalyticsContextFunction;
+
+// @public (undocumented)
+type AnalyticsContextFunction = (props: {
+    children: React.ReactNode;
+    data: Object;
+}, context?: AnalyticsReactContextInterface) => JSX.Element;
+
+// @public @deprecated (undocumented)
+export class AnalyticsErrorBoundary extends Component<AnalyticsErrorBoundaryProps, AnalyticsErrorBoundaryState> {
+    constructor(props: AnalyticsErrorBoundaryProps);
+    // (undocumented)
+    componentDidCatch(error: Error, info?: AnalyticsErrorBoundaryErrorInfo): void;
+    // (undocumented)
+    render(): JSX.Element | null;
+}
+
+// @public (undocumented)
+type AnalyticsErrorBoundaryErrorInfo = {
+    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;
+}
+
+// @public (undocumented)
+type AnalyticsErrorBoundaryState = {
+    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;
+}
+
+// @public (undocumented)
+type AnalyticsEventCallback = (payload: AnalyticsEventPayload) => AnalyticsEventPayload;
+
+// @public (undocumented)
+type AnalyticsEventCreator = (create: CreateUIAnalyticsEvent, props: Record<string, any>) => UIAnalyticsEvent | undefined;
+
+// @public (undocumented)
+export type AnalyticsEventPayload = Record<string, any>;
+
+// @public (undocumented)
+export type AnalyticsEventProps = {
+    payload: AnalyticsEventPayload;
+};
+
+// @public (undocumented)
+type AnalyticsEventUpdater = AnalyticsEventCallback | AnalyticsEventPayload;
+
+// @public (undocumented)
+export let AnalyticsListener: AnalyticsListenerFunction;
+
+// @public (undocumented)
+type AnalyticsListenerFunction = (props: {
+    children?: React.ReactNode;
+    channel?: string;
+    onEvent: (event: UIAnalyticsEvent, channel?: string) => void;
+}, context?: AnalyticsReactContextInterface) => JSX.Element;
+
+export { AnalyticsReactContext }
+
+export { AnalyticsReactContextInterface }
+
+// @public (undocumented)
+type ChannelIdentifier = string;
+
+// @public (undocumented)
+export function cleanProps(props: Record<string, any>): {
+    [x: string]: any;
+};
+
+// @public (undocumented)
+type Context = Record<string, any>[];
+
+// @public (undocumented)
+export const createAndFireEvent: (channel?: string | undefined) => (payload: AnalyticsEventPayload) => (createAnalyticsEvent: CreateUIAnalyticsEvent) => UIAnalyticsEvent;
+
+// @public (undocumented)
+type CreateEventMap = Record<string, CreateEventMapValue>;
+
+// @public (undocumented)
+type CreateEventMapValue = AnalyticsEventCreator | AnalyticsEventPayload;
+
+// @public (undocumented)
+export type CreateUIAnalyticsEvent = (payload: AnalyticsEventPayload) => UIAnalyticsEvent;
+
+// @public (undocumented)
+export const isAnalyticsEvent: (obj: any) => boolean;
+
+// @public (undocumented)
+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 | undefined) => 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) => void;
+
+// @public (undocumented)
+export type UIAnalyticsEventProps = AnalyticsEventProps & {
+    context?: Context;
+    handlers?: UIAnalyticsEventHandler[];
+};
+
+// @public (undocumented)
+export function useAnalyticsEvents(): UseAnalyticsEventsHook;
+
+// @public (undocumented)
+export type UseAnalyticsEventsHook = {
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+};
+
+// @public (undocumented)
+export const useCallbackWithAnalytics: UseCallbackWithAnalyticsHook;
+
+// @public (undocumented)
+export type UseCallbackWithAnalyticsHook = (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, }: UsePlatformLeafEventHandlerHookArgs<T>): (value: T) => void;
+
+// @public (undocumented)
+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>;
+};
+
+// @public (undocumented)
+export function usePlatformLeafSyntheticEventHandler({ fn, action, componentName, packageName, packageVersion, analyticsData, }: UsePlatformLeafSyntheticEventHandlerHookArgs): () => void;
+
+// @public (undocumented)
+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>;
+};
+
+// @public (undocumented)
+export const withAnalyticsContext: (defaultData?: any) => <Props, Component>(WrappedComponent: React_2.JSXElementConstructor<Props> & Component) => React_2.ForwardRefExoticComponent<React_2.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props & WithContextProps>> & React_2.RefAttributes<any>>;
+
+// @public (undocumented)
+export const withAnalyticsEvents: (createEventMap?: CreateEventMap) => <Props extends WithAnalyticsEventsProps, Component>(WrappedComponent: React_2.JSXElementConstructor<Props> & Component) => React_2.ForwardRefExoticComponent<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>;
+}
+
+// @public (undocumented)
+export interface WithContextProps {
+    // (undocumented)
+    analyticsContext?: Record<string, any>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```