@atlaskit/analytics-next 9.0.0 → 9.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/analytics-next
 
+## 9.0.2
+
+### Patch Changes
+
+- [`7caf968e4cf`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7caf968e4cf) - Move analytics-next to maintenance mode
+
+## 9.0.1
+
+### Patch Changes
+
+- [`fbff320b423`](https://bitbucket.org/atlassian/atlassian-frontend/commits/fbff320b423) - Move package to continuous model and to push model consumption
+
 ## 9.0.0
 
 ### Major Changes

package/README.md

@@ -1,7 +1,10 @@
 # Analytics-next
-
 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. \
+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
 
 ```sh

package/dist/cjs/version.json

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

package/dist/es2019/components/AnalyticsErrorBoundary.js

@@ -2,8 +2,7 @@ import React, { Component } from 'react';
 import AnalyticsContext from './AnalyticsContext/LegacyAnalyticsContext';
 /**
  *  @deprecated
- */
-// eslint-disable-next-line @repo/internal/react/no-class-components
+ */ // eslint-disable-next-line @repo/internal/react/no-class-components
 export default class AnalyticsErrorBoundary extends Component {
   constructor(props) {
     super(props);

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

package/docs/0-intro.tsx

@@ -1,6 +1,10 @@
 import { md } from '@atlaskit/docs';
 
 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.
+
 This package aims to help assist consumers track the way their React components are being used.
 
 ### Contents

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/analytics-next",
-  "version": "9.0.0",
+  "version": "9.0.2",
   "description": "React components, HOCs and hooks to assist with tracking user activity with React components",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -16,7 +16,10 @@
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "team": "UIP Frontend Observability",
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
+    "productPushConsumption": [
+      "jira"
+    ],
     "website": {
       "name": "Analytics next"
     }
@@ -48,7 +51,7 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/button": "^16.5.0",
+    "@atlaskit/button": "^16.6.0",
     "@atlaskit/docs": "*",
     "@atlaskit/ssr": "*",
     "@atlaskit/textfield": "^5.3.0",

package/report.api.md

@@ -19,6 +19,7 @@
 
 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';
 
@@ -34,11 +35,17 @@ type AnalyticsContextFunction = (
   context?: AnalyticsReactContextInterface,
 ) => JSX.Element;
 
-// @public (undocumented)
-export const AnalyticsErrorBoundary: React_2.ForwardRefExoticComponent<
-  Omit<AnalyticsErrorBoundaryProps, keyof WithAnalyticsEventsProps> &
-    React_2.RefAttributes<any>
->;
+// @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 = {
@@ -46,7 +53,7 @@ type AnalyticsErrorBoundaryErrorInfo = {
 };
 
 // @public (undocumented)
-export interface AnalyticsErrorBoundaryProps extends WithAnalyticsEventsProps {
+export interface AnalyticsErrorBoundaryProps {
   // (undocumented)
   channel: string;
   children: ReactNode;
@@ -58,6 +65,11 @@ export interface AnalyticsErrorBoundaryProps extends WithAnalyticsEventsProps {
   onError?: (error: Error, info?: AnalyticsErrorBoundaryErrorInfo) => void;
 }
 
+// @public (undocumented)
+type AnalyticsErrorBoundaryState = {
+  hasError: boolean;
+};
+
 // @public (undocumented)
 export class AnalyticsEvent {
   constructor(props: AnalyticsEventProps);

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)
+
+```