@atlaskit/editor-plugin-avatar-group 4.1.6 → 4.1.7

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-avatar-group
 
+## 4.1.7
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 4.1.6
 
 ### Patch Changes

package/dist/cjs/ui/avatars.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.scrollToCollabCursor = exports.Avatars = void 0;
+exports.Avatars = void 0;
 var _react = _interopRequireDefault(require("react"));
 var _react2 = require("@emotion/react");
 var _avatarGroup = _interopRequireDefault(require("@atlaskit/avatar-group"));
@@ -19,7 +19,7 @@ var _toAvatar = _interopRequireDefault(require("./to-avatar"));
 
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 
-var scrollToCollabCursor = exports.scrollToCollabCursor = function scrollToCollabCursor(editorAPI, participants, sessionId, index, editorAnalyticsAPI) {
+var scrollToCollabCursor = function scrollToCollabCursor(editorAPI, participants, sessionId, index, editorAnalyticsAPI) {
   var selectedUser = participants[index];
   var cursorPos = selectedUser.cursorPos;
   if (selectedUser && cursorPos !== undefined && selectedUser.sessionId !== sessionId) {

package/dist/es2019/ui/avatars.js

@@ -12,7 +12,7 @@ import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/anal
 import { Selection } from '@atlaskit/editor-prosemirror/state';
 import { avatarContainerStyles } from './styles';
 import toAvatar from './to-avatar';
-export const scrollToCollabCursor = (editorAPI, participants, sessionId, index, editorAnalyticsAPI) => {
+const scrollToCollabCursor = (editorAPI, participants, sessionId, index, editorAnalyticsAPI) => {
   const selectedUser = participants[index];
   const cursorPos = selectedUser.cursorPos;
   if (selectedUser && cursorPos !== undefined && selectedUser.sessionId !== sessionId) {

package/dist/esm/ui/avatars.js

@@ -12,7 +12,7 @@ import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/anal
 import { Selection } from '@atlaskit/editor-prosemirror/state';
 import { avatarContainerStyles } from './styles';
 import toAvatar from './to-avatar';
-export var scrollToCollabCursor = function scrollToCollabCursor(editorAPI, participants, sessionId, index, editorAnalyticsAPI) {
+var scrollToCollabCursor = function scrollToCollabCursor(editorAPI, participants, sessionId, index, editorAnalyticsAPI) {
   var selectedUser = participants[index];
   var cursorPos = selectedUser.cursorPos;
   if (selectedUser && cursorPos !== undefined && selectedUser.sessionId !== sessionId) {

package/dist/types/avatarGroupPluginType.d.ts

@@ -6,8 +6,8 @@ import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 export type AvatarGroupPluginOptions = {
     collabEdit?: CollabEditOptions;
-    takeFullWidth: boolean;
     showAvatarGroup?: boolean;
+    takeFullWidth: boolean;
 };
 export type AvatarGroupPluginDependencies = [
     OptionalPlugin<FeatureFlagsPlugin>,
@@ -16,9 +16,9 @@ export type AvatarGroupPluginDependencies = [
     OptionalPlugin<PrimaryToolbarPlugin>
 ];
 export type AvatarGroupPlugin = NextEditorPlugin<'avatarGroup', {
-    pluginConfiguration: AvatarGroupPluginOptions;
-    dependencies: AvatarGroupPluginDependencies;
     actions: {
         getToolbarItem: ({ inviteToEditHandler, isInviteToEditButtonSelected, inviteToEditComponent, }: CollabInviteToEditProps) => JSX.Element | null;
     };
+    dependencies: AvatarGroupPluginDependencies;
+    pluginConfiguration: AvatarGroupPluginOptions;
 }>;

package/dist/types/ui/AvatarGroupPluginWrapper.d.ts

@@ -7,12 +7,12 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AvatarGroupPlugin } from '../index';
 declare const AvatarGroupPluginWrapper: (props: {
     collabEdit?: CollabEditOptions;
-    editorView: EditorView;
-    eventDispatcher: EventDispatcher<any>;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
-    takeFullWidth: boolean;
-    featureFlags: FeatureFlags;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
+    editorView: EditorView;
+    eventDispatcher: EventDispatcher<any>;
+    featureFlags: FeatureFlags;
+    takeFullWidth: boolean;
 }) => jsx.JSX.Element;
 export default AvatarGroupPluginWrapper;

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

@@ -6,26 +6,19 @@ 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';
-export type AvatarsWithPluginStateProps = {
-    editorView?: EditorView;
-    eventDispatcher?: EventDispatcher;
-    featureFlags: FeatureFlags;
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
-} & CollabInviteToEditProps;
-declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
     editorView?: EditorView;
     eventDispatcher?: EventDispatcher;
     featureFlags: FeatureFlags;
-    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-    editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
 } & CollabInviteToEditProps & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<{
+        editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+        editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
         editorView?: EditorView;
         eventDispatcher?: EventDispatcher;
         featureFlags: FeatureFlags;
-        editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-        editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
     } & CollabInviteToEditProps & WrappedComponentProps>;
 };
 export default _default;

package/dist/types/ui/avatars.d.ts

@@ -6,19 +6,18 @@ import type { ReactNode } from 'react';
 import React from 'react';
 import { jsx } from '@emotion/react';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabParticipant } from '@atlaskit/editor-common/collab';
 import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
 import type { ReadOnlyParticipants } from '@atlaskit/editor-plugin-collab-edit';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-export interface AvatarsProps {
-    sessionId?: string;
-    participants: ReadOnlyParticipants | undefined;
-    editorView?: EditorView;
-    featureFlags: FeatureFlags;
+interface AvatarsProps {
+    children: ReactNode;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
-    children: ReactNode;
+    editorView?: EditorView;
+    featureFlags: FeatureFlags;
+    participants: ReadOnlyParticipants | undefined;
+    sessionId?: string;
 }
-export declare const scrollToCollabCursor: (editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined, participants: CollabParticipant[], sessionId: string | undefined, index: number, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => void;
 export declare const Avatars: React.MemoExoticComponent<(props: AvatarsProps) => jsx.JSX.Element | null>;
+export {};

package/dist/types/ui/colored-avatar-item.d.ts

@@ -5,10 +5,11 @@
 import { jsx } from '@emotion/react';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-export interface ColoredAvatarItemProps {
-    sessionId: string;
-    presenceId?: string;
-    name: string;
+interface ColoredAvatarItemProps {
     api: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
+    name: string;
+    presenceId?: string;
+    sessionId: string;
 }
 export declare const ColoredAvatarItem: (props: ColoredAvatarItemProps) => jsx.JSX.Element;
+export {};

package/dist/types/ui/invite-to-edit.d.ts

@@ -5,10 +5,11 @@
 import React, { type PropsWithChildren } from 'react';
 import { jsx } from '@emotion/react';
 import type { InviteToEditComponentProps } from '@atlaskit/editor-common/collab';
-export type InviteToEditButtonProps = PropsWithChildren<{
+type InviteToEditButtonProps = PropsWithChildren<{
+    Component?: React.ComponentType<React.PropsWithChildren<InviteToEditComponentProps>>;
     onClick?: React.MouseEventHandler;
     selected?: boolean;
-    Component?: React.ComponentType<React.PropsWithChildren<InviteToEditComponentProps>>;
     title: string;
 }>;
 export declare const InviteToEditButton: (props: InviteToEditButtonProps) => jsx.JSX.Element | null;
+export {};

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

@@ -6,8 +6,8 @@ import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 export type AvatarGroupPluginOptions = {
     collabEdit?: CollabEditOptions;
-    takeFullWidth: boolean;
     showAvatarGroup?: boolean;
+    takeFullWidth: boolean;
 };
 export type AvatarGroupPluginDependencies = [
     OptionalPlugin<FeatureFlagsPlugin>,
@@ -16,9 +16,9 @@ export type AvatarGroupPluginDependencies = [
     OptionalPlugin<PrimaryToolbarPlugin>
 ];
 export type AvatarGroupPlugin = NextEditorPlugin<'avatarGroup', {
-    pluginConfiguration: AvatarGroupPluginOptions;
-    dependencies: AvatarGroupPluginDependencies;
     actions: {
         getToolbarItem: ({ inviteToEditHandler, isInviteToEditButtonSelected, inviteToEditComponent, }: CollabInviteToEditProps) => JSX.Element | null;
     };
+    dependencies: AvatarGroupPluginDependencies;
+    pluginConfiguration: AvatarGroupPluginOptions;
 }>;

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

@@ -7,12 +7,12 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AvatarGroupPlugin } from '../index';
 declare const AvatarGroupPluginWrapper: (props: {
     collabEdit?: CollabEditOptions;
-    editorView: EditorView;
-    eventDispatcher: EventDispatcher<any>;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
-    takeFullWidth: boolean;
-    featureFlags: FeatureFlags;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
+    editorView: EditorView;
+    eventDispatcher: EventDispatcher<any>;
+    featureFlags: FeatureFlags;
+    takeFullWidth: boolean;
 }) => jsx.JSX.Element;
 export default AvatarGroupPluginWrapper;

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

@@ -6,26 +6,19 @@ 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';
-export type AvatarsWithPluginStateProps = {
-    editorView?: EditorView;
-    eventDispatcher?: EventDispatcher;
-    featureFlags: FeatureFlags;
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
-} & CollabInviteToEditProps;
-declare const _default: React.FC<import("react-intl-next").WithIntlProps<{
     editorView?: EditorView;
     eventDispatcher?: EventDispatcher;
     featureFlags: FeatureFlags;
-    editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-    editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
 } & CollabInviteToEditProps & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<{
+        editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
+        editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
         editorView?: EditorView;
         eventDispatcher?: EventDispatcher;
         featureFlags: FeatureFlags;
-        editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
-        editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
     } & CollabInviteToEditProps & WrappedComponentProps>;
 };
 export default _default;

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

@@ -6,19 +6,18 @@ import type { ReactNode } from 'react';
 import React from 'react';
 import { jsx } from '@emotion/react';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type { CollabParticipant } from '@atlaskit/editor-common/collab';
 import type { ExtractInjectionAPI, FeatureFlags } from '@atlaskit/editor-common/types';
 import type { ReadOnlyParticipants } from '@atlaskit/editor-plugin-collab-edit';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-export interface AvatarsProps {
-    sessionId?: string;
-    participants: ReadOnlyParticipants | undefined;
-    editorView?: EditorView;
-    featureFlags: FeatureFlags;
+interface AvatarsProps {
+    children: ReactNode;
     editorAnalyticsAPI: EditorAnalyticsAPI | undefined;
     editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
-    children: ReactNode;
+    editorView?: EditorView;
+    featureFlags: FeatureFlags;
+    participants: ReadOnlyParticipants | undefined;
+    sessionId?: string;
 }
-export declare const scrollToCollabCursor: (editorAPI: ExtractInjectionAPI<AvatarGroupPlugin> | undefined, participants: CollabParticipant[], sessionId: string | undefined, index: number, editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => void;
 export declare const Avatars: React.MemoExoticComponent<(props: AvatarsProps) => jsx.JSX.Element | null>;
+export {};

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

@@ -5,10 +5,11 @@
 import { jsx } from '@emotion/react';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { AvatarGroupPlugin } from '../avatarGroupPluginType';
-export interface ColoredAvatarItemProps {
-    sessionId: string;
-    presenceId?: string;
-    name: string;
+interface ColoredAvatarItemProps {
     api: ExtractInjectionAPI<AvatarGroupPlugin> | undefined;
+    name: string;
+    presenceId?: string;
+    sessionId: string;
 }
 export declare const ColoredAvatarItem: (props: ColoredAvatarItemProps) => jsx.JSX.Element;
+export {};

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

@@ -5,10 +5,11 @@
 import React, { type PropsWithChildren } from 'react';
 import { jsx } from '@emotion/react';
 import type { InviteToEditComponentProps } from '@atlaskit/editor-common/collab';
-export type InviteToEditButtonProps = PropsWithChildren<{
+type InviteToEditButtonProps = PropsWithChildren<{
+    Component?: React.ComponentType<React.PropsWithChildren<InviteToEditComponentProps>>;
     onClick?: React.MouseEventHandler;
     selected?: boolean;
-    Component?: React.ComponentType<React.PropsWithChildren<InviteToEditComponentProps>>;
     title: string;
 }>;
 export declare const InviteToEditButton: (props: InviteToEditButtonProps) => jsx.JSX.Element | null;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-avatar-group",
-	"version": "4.1.6",
+	"version": "4.1.7",
 	"description": "Avatar Group plugin for @atlaskit/editor-core.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -45,7 +45,7 @@
 		"@atlaskit/icon": "^28.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/theme": "^19.0.0",
-		"@atlaskit/tmp-editor-statsig": "^11.3.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
@@ -53,7 +53,7 @@
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {