@atlaskit/editor-plugin-avatar-group 9.0.0 → 9.0.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-avatar-group
 
+## 9.0.1
+
+### Patch Changes
+
+- [`92f6f3650479b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/92f6f3650479b) -
+  Update README.md and 0-intro.tsx
+- Updated dependencies
+
 ## 9.0.0
 
 ### Patch Changes

package/README.md

@@ -1,13 +1,22 @@
-# Editor plugin avatar group
+# Editor Plugin Avatar Group
 
 Avatar Group plugin for @atlaskit/editor-core
 
-The avatar-group plugin is just a placeholder for the AvatarsWithPluginState component so that it is properly integrated into the toolbar.
-The avatar-group plugin itself doesn't do anything so all the pm-plugin related code has been removed.
-
 **Note:** This component is designed for internal Atlassian development.
 External contributors will be able to use this component but will not be able to submit issues.
 
+## Overview
+
+The Avatar Group plugin displays active collaborators in the editor toolbar. It integrates with the collaboration editing system to show real-time participant avatars and provides an optional "Invite to Edit" button for sharing the document with others.
+
+## Key features
+
+- **Real-time participant display** - Shows avatars of active collaborators in the current editing session
+- **Toolbar integration** - Seamlessly integrates into the primary toolbar through the editor plugin system
+- **Invite to edit** - Provides optional invite-to-edit functionality with customizable components and handlers
+- **Collaboration state tracking** - Monitors collaboration edit plugin state to display active participants
+- **Analytics integration** - Tracks avatar group interactions and visibility events
+
 ## Install
 ---
 - **Install** - *yarn add @atlaskit/editor-plugin-avatar-group*
@@ -30,4 +39,4 @@ Please see [Atlaskit - Editor plugin avatar group](https://atlaskit.atlassian.co
 For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
 ## License
 ---
- Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#Platform-License) for more licensing information.
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/dist/cjs/ui/AvatarGroupPluginWrapper.js

@@ -16,7 +16,7 @@ var _avatarsWithPluginState = _interopRequireDefault(require("./avatars-with-plu
  * @jsx jsx
  */
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 
 // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
 var toolbarButtonWrapper = (0, _react2.css)({

package/dist/cjs/ui/avatars-with-plugin-state.js

@@ -48,4 +48,7 @@ var AvatarsWithPluginState = function AvatarsWithPluginState(props) {
     Component: Component
   }));
 };
-var _default = exports.default = (0, _reactIntlNext.injectIntl)(AvatarsWithPluginState);
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+var _default_1 = (0, _reactIntlNext.injectIntl)(AvatarsWithPluginState);
+var _default = exports.default = _default_1;

package/dist/cjs/ui/avatars.js

@@ -18,7 +18,7 @@ var _toAvatar = _interopRequireDefault(require("./to-avatar"));
  * @jsx jsx
  */
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 
 var scrollToCollabCursor = function scrollToCollabCursor(editorAPI, participants, sessionId, index, editorAnalyticsAPI) {
   var selectedUser = participants[index];

package/dist/cjs/ui/colored-avatar-item.js

@@ -11,7 +11,7 @@ var _styles = require("./styles");
  * @jsxRuntime classic
  * @jsx jsx
  */
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 
 var ColoredAvatarItem = exports.ColoredAvatarItem = function ColoredAvatarItem(props) {
   var _props$api$collabEdit, _props$api, _props$presenceId;

package/dist/cjs/ui/invite-to-edit.js

@@ -17,7 +17,7 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
  * @jsx jsx
  */
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 
 var ID = function ID(props) {
   return (0, _react2.jsx)(_react.Fragment, null, props.children);

package/dist/cjs/ui/to-avatar.js

@@ -24,10 +24,11 @@ var toAvatar = function toAvatar(participant, api, formatMessage) {
     })
   };
 };
-var _default = exports.default = (0, _memoizeOne.default)(toAvatar, function participantEquals(_ref, _ref2) {
+var _default_1 = (0, _memoizeOne.default)(toAvatar, function participantEquals(_ref, _ref2) {
   var _ref3 = (0, _slicedToArray2.default)(_ref, 1),
     a = _ref3[0];
   var _ref4 = (0, _slicedToArray2.default)(_ref2, 1),
     b = _ref4[0];
   return a.name === b.name && a.avatar === b.avatar && a.sessionId === b.sessionId;
-});
+});
+var _default = exports.default = _default_1;

package/dist/es2019/ui/AvatarGroupPluginWrapper.js

@@ -4,7 +4,7 @@
  */
 import { useEffect } from 'react';
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { css, jsx } from '@emotion/react';
 import { useIntl } from 'react-intl-next';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';

package/dist/es2019/ui/avatars-with-plugin-state.js

@@ -44,4 +44,7 @@ const AvatarsWithPluginState = props => {
     Component: Component
   }));
 };
-export default injectIntl(AvatarsWithPluginState);
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+const _default_1 = injectIntl(AvatarsWithPluginState);
+export default _default_1;

package/dist/es2019/ui/avatars.js

@@ -5,7 +5,7 @@
 
 import React from 'react';
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { jsx } from '@emotion/react';
 import { useIntl } from 'react-intl-next';
 import AvatarGroup from '@atlaskit/avatar-group';

package/dist/es2019/ui/colored-avatar-item.js

@@ -2,7 +2,7 @@
  * @jsxRuntime classic
  * @jsx jsx
  */
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { jsx } from '@emotion/react';
 import { N900, R100 } from '@atlaskit/theme/colors';
 import { badge } from './styles';

package/dist/es2019/ui/invite-to-edit.js

@@ -4,7 +4,7 @@
  */
 import React, { Fragment } from 'react';
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { jsx } from '@emotion/react';
 import { ToolbarButton } from '@atlaskit/editor-common/ui-menu';
 import AddIcon from '@atlaskit/icon/core/add';

package/dist/es2019/ui/to-avatar.js

@@ -14,6 +14,7 @@ const toAvatar = (participant, api, formatMessage) => ({
     presenceId: participant.presenceId
   })
 });
-export default memoizeOne(toAvatar, function participantEquals([a], [b]) {
+const _default_1 = memoizeOne(toAvatar, function participantEquals([a], [b]) {
   return a.name === b.name && a.avatar === b.avatar && a.sessionId === b.sessionId;
-});
+});
+export default _default_1;

package/dist/esm/ui/AvatarGroupPluginWrapper.js

@@ -4,7 +4,7 @@
  */
 import { useEffect } from 'react';
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { css, jsx } from '@emotion/react';
 import { useIntl } from 'react-intl-next';
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';

package/dist/esm/ui/avatars-with-plugin-state.js

@@ -41,4 +41,7 @@ var AvatarsWithPluginState = function AvatarsWithPluginState(props) {
     Component: Component
   }));
 };
-export default injectIntl(AvatarsWithPluginState);
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+var _default_1 = injectIntl(AvatarsWithPluginState);
+export default _default_1;

package/dist/esm/ui/avatars.js

@@ -5,7 +5,7 @@
 
 import React from 'react';
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { jsx } from '@emotion/react';
 import { useIntl } from 'react-intl-next';
 import AvatarGroup from '@atlaskit/avatar-group';

package/dist/esm/ui/colored-avatar-item.js

@@ -2,7 +2,7 @@
  * @jsxRuntime classic
  * @jsx jsx
  */
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { jsx } from '@emotion/react';
 import { N900, R100 } from '@atlaskit/theme/colors';
 import { badge } from './styles';

package/dist/esm/ui/invite-to-edit.js

@@ -4,7 +4,7 @@
  */
 import React, { Fragment } from 'react';
 
-// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled, @typescript-eslint/consistent-type-imports
 import { jsx } from '@emotion/react';
 import { ToolbarButton } from '@atlaskit/editor-common/ui-menu';
 import AddIcon from '@atlaskit/icon/core/add';

package/dist/esm/ui/to-avatar.js

@@ -17,10 +17,11 @@ var toAvatar = function toAvatar(participant, api, formatMessage) {
     })
   };
 };
-export default memoizeOne(toAvatar, function participantEquals(_ref, _ref2) {
+var _default_1 = memoizeOne(toAvatar, function participantEquals(_ref, _ref2) {
   var _ref3 = _slicedToArray(_ref, 1),
     a = _ref3[0];
   var _ref4 = _slicedToArray(_ref2, 1),
     b = _ref4[0];
   return a.name === b.name && a.avatar === b.avatar && a.sessionId === b.sessionId;
-});
+});
+export default _default_1;

package/dist/types/ui/avatars-with-plugin-state.d.ts

@@ -1,12 +1,12 @@
 import React from 'react';
-import type { WrappedComponentProps } from 'react-intl-next';
+import type { WithIntlProps, WrappedComponentProps } from 'react-intl-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { CollabInviteToEditProps } from '@atlaskit/editor-common/collab';
 import type { EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
 import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
+declare const _default_1: React.FC<WithIntlProps<{
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
     editorView?: EditorView;
@@ -21,4 +21,4 @@ declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
         featureFlags: FeatureFlags;
     } & CollabInviteToEditProps & WrappedComponentProps>;
 };
-export default _default;
+export default _default_1;

package/dist/types/ui/to-avatar.d.ts

@@ -1,7 +1,8 @@
+import { type MemoizedFn } from 'memoize-one';
 import type { IntlShape } from 'react-intl-next';
 import type { AvatarProps } from '@atlaskit/avatar-group';
 import type { CollabParticipant } from '@atlaskit/editor-common/collab';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-declare const _default: import("memoize-one").MemoizedFn<(participant: CollabParticipant, api: ExtractInjectionAPI<AvatarGroupPlugin> | undefined, formatMessage: IntlShape["formatMessage"]) => AvatarProps>;
-export default _default;
+declare const _default_1: MemoizedFn<(participant: CollabParticipant, api: ExtractInjectionAPI<AvatarGroupPlugin> | undefined, formatMessage: IntlShape['formatMessage']) => AvatarProps>;
+export default _default_1;

package/dist/types-ts4.5/ui/avatars-with-plugin-state.d.ts

@@ -1,12 +1,12 @@
 import React from 'react';
-import type { WrappedComponentProps } from 'react-intl-next';
+import type { WithIntlProps, WrappedComponentProps } from 'react-intl-next';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { CollabInviteToEditProps } from '@atlaskit/editor-common/collab';
 import type { EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
 import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
+declare const _default_1: React.FC<WithIntlProps<{
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
     editorView?: EditorView;
@@ -21,4 +21,4 @@ declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
         featureFlags: FeatureFlags;
     } & CollabInviteToEditProps & WrappedComponentProps>;
 };
-export default _default;
+export default _default_1;

package/dist/types-ts4.5/ui/to-avatar.d.ts

@@ -1,7 +1,8 @@
+import { type MemoizedFn } from 'memoize-one';
 import type { IntlShape } from 'react-intl-next';
 import type { AvatarProps } from '@atlaskit/avatar-group';
 import type { CollabParticipant } from '@atlaskit/editor-common/collab';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-declare const _default: import("memoize-one").MemoizedFn<(participant: CollabParticipant, api: ExtractInjectionAPI<AvatarGroupPlugin> | undefined, formatMessage: IntlShape["formatMessage"]) => AvatarProps>;
-export default _default;
+declare const _default_1: MemoizedFn<(participant: CollabParticipant, api: ExtractInjectionAPI<AvatarGroupPlugin> | undefined, formatMessage: IntlShape['formatMessage']) => AvatarProps>;
+export default _default_1;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-avatar-group",
-	"version": "9.0.0",
+	"version": "9.0.1",
 	"description": "Avatar Group plugin for @atlaskit/editor-core.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -49,7 +49,7 @@
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.0.0",
+		"@atlaskit/editor-common": "^112.1.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {