@atlaskit/editor-core 179.0.3 → 179.1.0

package/dist/types/labs/next/presets/universal.d.ts

@@ -0,0 +1,30 @@
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { EditorPlugin } from '../../../types';
+import type { EditorAppearance, GetEditorContainerWidth } from '@atlaskit/editor-common/types';
+import { DefaultPresetPluginOptions } from './default';
+import { EditorPresetProps } from './types';
+import type { InsertNodeAPI } from '../../../insert-api/types';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { EditorSelectionAPI } from '@atlaskit/editor-common/selection';
+import { Preset } from './preset';
+import { FeatureFlags } from '../../../types/feature-flags';
+import { EditorPluginFeatureProps, EditorProviderProps } from '../../../types/editor-props';
+declare type UniversalPresetProps = EditorPresetProps & DefaultPresetPluginOptions & EditorPluginFeatureProps & EditorProviderProps;
+/**
+ * Creates a preset with all of the available plugins.
+ * Basis for create-plugins-list and can be used to migrate from Editor -> EditorNext (Presets project)
+ * with minimal friction.
+ *
+ * @param appearance
+ * @param props A subset of full EditorProps for the full feature preset
+ * @param featureFlags
+ * @param prevAppearance The appearance of the editor in the previous render
+ * @param createAnalyticsEvent
+ * @param insertNodeAPI
+ * @param editorAnalyticsAPI
+ * @param editorSelectionAPI
+ * @param getEditorContainerWidth
+ * @returns a full featured preset configured according to the provided props - basis for create-plugins-list
+ */
+export default function createUniversalPreset(appearance: EditorAppearance | undefined, props: UniversalPresetProps, featureFlags: FeatureFlags, prevAppearance?: EditorAppearance, createAnalyticsEvent?: CreateUIAnalyticsEvent, insertNodeAPI?: InsertNodeAPI, editorAnalyticsAPI?: EditorAnalyticsAPI, editorSelectionAPI?: EditorSelectionAPI, getEditorContainerWidth?: GetEditorContainerWidth): Preset<EditorPlugin, []>;
+export {};

package/dist/types/plugins/card/ui/EditLinkToolbar.d.ts

@@ -17,6 +17,10 @@ export declare type EditLinkToolbarProps = {
 export declare class EditLinkToolbar extends React.Component<EditLinkToolbarProps> {
     componentDidUpdate(prevProps: EditLinkToolbarProps): void;
     componentWillUnmount(): void;
+    /** Focus should move to the 'Edit link' button when the toolbar closes
+     * and not close the floating toolbar.
+     */
+    private handleEsc;
     private hideLinkToolbar;
     render(): JSX.Element;
 }

package/dist/types/plugins/expand/index.d.ts

@@ -5,7 +5,10 @@ interface ExpandPluginOptions extends LongPressSelectionPluginOptions {
     appearance?: EditorProps['appearance'];
 }
 declare const expandPlugin: NextEditorPlugin<'expand', never, ExpandPluginOptions>;
+interface ExpandEditorProps {
+    allowExpand?: EditorProps['allowExpand'];
+}
 export default expandPlugin;
 export type { ExpandPluginState } from './types';
-export declare function isExpandInsertionEnabled({ allowExpand }: EditorProps): boolean;
+export declare function isExpandInsertionEnabled({ allowExpand }: ExpandEditorProps): boolean;
 export { pluginKey } from './pm-plugins/plugin-factory';

package/dist/types/plugins/floating-toolbar/pm-plugins/force-focus/index.d.ts

@@ -0,0 +1,18 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from 'prosemirror-state';
+import { EditorView } from 'prosemirror-view';
+export declare const forceFocusStateKey: PluginKey<any, any>;
+declare const _default: () => SafePlugin<any, any>;
+/**
+ * Used in cases where a floating toolbar button opens a submenu which destroys
+ * the button, but the user has pressed ESC to close the submenu and focus needs
+ * to move back to the button. */
+export default _default;
+/**
+ * The provided selector should be the floating toolbar button that needs focus.
+ */
+export declare function forceFocusSelector(selector: string | null, view?: EditorView): void;
+/**
+ * If a selector is set and the element exists, focus it.
+ */
+export declare function checkShouldForceFocusAndApply(view?: EditorView): void;

package/dist/types/plugins/list/utils/analytics.d.ts

@@ -1,4 +1,7 @@
-import { EditorState } from 'prosemirror-state';
-import { CommonListAnalyticsAttributes } from '../../analytics';
+import { EditorState, Transaction } from 'prosemirror-state';
+import { RestartListsAttributesForListOutdented, CommonListAnalyticsAttributes } from '@atlaskit/editor-common/analytics';
 export declare const getCommonListAnalyticsAttributes: (state: EditorState) => CommonListAnalyticsAttributes;
 export declare const countListItemsInSelection: (state: EditorState) => number;
+export declare const RESTART_LISTS_ANALYTICS_KEY = "restartListsAnalytics";
+export declare const getRestartListsAttributes: (tr: Transaction) => RestartListsAttributesForListOutdented;
+export declare const storeRestartListsAttributes: (tr: Transaction, attributes: RestartListsAttributesForListOutdented) => void;

package/dist/types/plugins/media/commands/linking.d.ts

@@ -5,6 +5,6 @@ import { INPUT_METHOD } from '../../analytics';
 import { Command } from '../../../types';
 export declare const showLinkingToolbar: import("@atlaskit/editor-common/types").Command;
 export declare const showLinkingToolbarWithMediaTypeCheck: Command;
-export declare const hideLinkingToolbar: (state: EditorState, dispatch?: CommandDispatch | undefined, view?: EditorView<any> | undefined) => void;
+export declare const hideLinkingToolbar: (state: EditorState, dispatch?: CommandDispatch | undefined, view?: EditorView<any> | undefined, focusFloatingToolbar?: boolean | undefined) => void;
 export declare const unlink: import("@atlaskit/editor-common/types").Command;
 export declare const setUrlToMedia: (url: string, inputMethod: INPUT_METHOD.TYPEAHEAD | INPUT_METHOD.MANUAL) => import("@atlaskit/editor-common/types").Command;

package/dist/types/test-utils.d.ts

@@ -28,3 +28,10 @@ export { EventDispatcher } from './event-dispatcher';
 export type { Dispatch } from './event-dispatcher';
 export { GapCursorSelection, Side as GapCursorSide, } from './plugins/selection/gap-cursor/selection';
 export declare function setTextSelection(view: EditorView, anchor: number, head?: number): void;
+/**
+ * Given a selector, checks if an element matching the selector exists in the
+ * document.
+ * @param selector
+ * @returns true if element matching selector exists in document, false otherwise
+ */
+export declare const isElementBySelectorInDocument: (selector: string) => boolean;

package/dist/types/types/editor-props.d.ts

@@ -50,107 +50,32 @@ export declare type BeforeAndAfterToolbarComponents = {
     after: ReactComponents;
 };
 export declare type PrimaryToolbarComponents = BeforeAndAfterToolbarComponents | ReactComponents;
-export interface EditorProps {
+export interface EditorProps extends EditorPluginFeatureProps, EditorProviderProps {
     appearance?: EditorAppearance;
     contentComponents?: ReactComponents;
-    primaryToolbarComponents?: PrimaryToolbarComponents;
     primaryToolbarIconBefore?: ReactElement;
     secondaryToolbarComponents?: ReactComponents;
-    allowAnalyticsGASV3?: boolean;
-    allowBlockType?: BlockTypePluginOptions['allowBlockType'];
-    allowTasksAndDecisions?: boolean;
-    allowBreakout?: boolean;
-    allowRule?: boolean;
-    allowTextColor?: boolean | TextColorPluginConfig;
-    allowTables?: boolean | TablesPluginConfig;
-    allowHelpDialog?: boolean;
-    feedbackInfo?: FeedbackInfo;
-    allowJiraIssue?: boolean;
-    allowPanel?: boolean | PanelPluginConfig;
-    allowExtension?: boolean | ExtensionConfig;
-    allowConfluenceInlineComment?: boolean;
-    allowTemplatePlaceholders?: boolean | PlaceholderTextOptions;
-    allowDate?: boolean;
-    allowLayouts?: boolean | LayoutPluginOptions;
-    allowStatus?: boolean | {
-        menuDisabled: boolean;
-    };
-    allowTextAlignment?: boolean;
-    allowIndentation?: boolean;
-    /**
-     * This enables new insertion behaviour only for horizontal rule and media single in certain conditions.
-     * The idea of this new behaviour is to have a consistent outcome regardless of the insertion method.
-     **/
-    allowNewInsertionBehaviour?: boolean;
-    /**
-     * Set this to false to opt out of the default behaviour of auto scrolling into view
-     * whenever the document is changed
-     */
-    autoScrollIntoView?: boolean;
-    allowFindReplace?: boolean | FindReplaceOptions;
     persistScrollGutter?: boolean;
     quickInsert?: QuickInsertOptions;
-    /** @deprecated Use smartLinks instead. */
-    UNSAFE_cards?: CardOptions;
-    /** @deprecated Use linking instead. */
-    smartLinks?: CardOptions;
-    /**
-     *  Configure and extend editor linking behaviour
-     */
-    linking?: LinkingOptions;
-    allowExpand?: boolean | {
-        allowInsertion?: boolean;
-        allowInteractiveExpand?: boolean;
-    };
-    saveOnEnter?: boolean;
     shouldFocus?: boolean;
     disabled?: boolean;
     contextPanel?: ReactComponents;
     errorReporterHandler?: ErrorReportingHandler;
-    uploadErrorHandler?: (state: MediaState) => void;
-    activityProvider?: Promise<ActivityProvider>;
-    searchProvider?: Promise<SearchProvider>;
-    annotationProviders?: AnnotationProviders;
-    collabEditProvider?: Providers['collabEditProvider'];
-    presenceProvider?: Promise<any>;
-    emojiProvider?: Providers['emojiProvider'];
-    taskDecisionProvider?: Promise<TaskDecisionProvider>;
-    allowNestedTasks?: boolean;
-    contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
-    legacyImageUploadProvider?: Providers['imageUploadProvider'];
-    mentionProvider?: Promise<MentionProvider>;
-    mention?: MentionPluginConfig;
-    autoformattingProvider?: Providers['autoformattingProvider'];
-    macroProvider?: Providers['macroProvider'];
-    waitForMediaUpload?: boolean;
     contentTransformerProvider?: (schema: Schema) => Transformer<string>;
-    media?: MediaOptions;
-    collabEdit?: CollabEditOptions;
     textFormatting?: TextFormattingOptions;
     maxHeight?: number;
     minHeight?: number;
-    maxContentSize?: number;
     placeholder?: string;
     placeholderBracketHint?: string;
     defaultValue?: Node | string | Object;
     popupsMountPoint?: HTMLElement;
     popupsBoundariesElement?: HTMLElement;
     popupsScrollableElement?: HTMLElement;
-    insertMenuItems?: MenuItem[];
     editorActions?: EditorActions;
     onEditorReady?: (editorActions: EditorActions) => void;
     onDestroy?: () => void;
     onChange?: EditorOnChangeHandler;
-    onSave?: (editorView: EditorView) => void;
     onCancel?: (editorView: EditorView) => void;
-    extensionHandlers?: ExtensionHandlers;
-    sanitizePrivateContent?: boolean;
-    /**
-     * flag to indicate display name instead of nick name should be inserted for mentions
-     * default: false, which inserts the nick name
-     * @deprecated Use mention.mentionInsertDisplayName instead
-     */
-    mentionInsertDisplayName?: boolean;
     /**
      * @description The nth keystroke after which an input time taken event is sent, 0 to disable it
      * @default 100
@@ -159,18 +84,7 @@ export interface EditorProps {
     inputSamplingLimit?: number;
     extensionProviders?: ExtensionProvidersProp;
     UNSAFE_useAnalyticsContext?: boolean;
-    /**
-     * @description Control performance metric measurements and tracking
-     */
-    performanceTracking?: PerformanceTracking;
-    elementBrowser?: {
-        showModal?: boolean;
-        replacePlusMenu?: boolean;
-        helpUrl?: string;
-        emptyStateHandler?: EmptyStateHandler;
-    };
     codeBlock?: CodeBlockOptions;
-    allowUndoRedoButtons?: boolean;
     /**
      * @default undefined
      * @description Enables valid transaction events to be tracked in analytics (at a sampled rate)
@@ -217,11 +131,6 @@ export interface EditorProps {
     featureFlags?: {
         [featureFlag: string]: string | boolean;
     };
-    /**
-     * Enable support for the "fragment" mark.
-     * Refer to ADF Change proposal #60 for more details.
-     */
-    allowFragmentMark?: boolean;
     /**
      * @deprecated Do not use outside of Editor team.
      * This has subtle side effects - you __WILL__ break functionality without implementer knowledge of editor-core internals
@@ -233,4 +142,99 @@ export interface EditorProps {
         __plugins: EditorPlugin[];
     };
 }
+export interface EditorProviderProps {
+    activityProvider?: Promise<ActivityProvider>;
+    searchProvider?: Promise<SearchProvider>;
+    annotationProviders?: AnnotationProviders;
+    collabEditProvider?: Providers['collabEditProvider'];
+    presenceProvider?: Promise<any>;
+    emojiProvider?: Providers['emojiProvider'];
+    taskDecisionProvider?: Promise<TaskDecisionProvider>;
+    contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
+    legacyImageUploadProvider?: Providers['imageUploadProvider'];
+    mentionProvider?: Promise<MentionProvider>;
+    autoformattingProvider?: Providers['autoformattingProvider'];
+    macroProvider?: Providers['macroProvider'];
+}
+export interface EditorPluginFeatureProps {
+    allowExpand?: boolean | {
+        allowInsertion?: boolean;
+        allowInteractiveExpand?: boolean;
+    };
+    allowNestedTasks?: boolean;
+    allowAnalyticsGASV3?: boolean;
+    allowBlockType?: BlockTypePluginOptions['allowBlockType'];
+    allowTasksAndDecisions?: boolean;
+    allowBreakout?: boolean;
+    allowRule?: boolean;
+    allowTextColor?: boolean | TextColorPluginConfig;
+    allowTables?: boolean | TablesPluginConfig;
+    allowHelpDialog?: boolean;
+    allowJiraIssue?: boolean;
+    allowPanel?: boolean | PanelPluginConfig;
+    allowExtension?: boolean | ExtensionConfig;
+    allowConfluenceInlineComment?: boolean;
+    allowTemplatePlaceholders?: boolean | PlaceholderTextOptions;
+    allowDate?: boolean;
+    allowLayouts?: boolean | LayoutPluginOptions;
+    allowStatus?: boolean | {
+        menuDisabled: boolean;
+    };
+    allowTextAlignment?: boolean;
+    allowIndentation?: boolean;
+    /**
+     * This enables new insertion behaviour only for horizontal rule and media single in certain conditions.
+     * The idea of this new behaviour is to have a consistent outcome regardless of the insertion method.
+     **/
+    allowNewInsertionBehaviour?: boolean;
+    allowUndoRedoButtons?: boolean;
+    allowFindReplace?: boolean | FindReplaceOptions;
+    /**
+     * Enable support for the "fragment" mark.
+     * Refer to ADF Change proposal #60 for more details.
+     */
+    allowFragmentMark?: boolean;
+    /**
+     * Set this to false to opt out of the default behaviour of auto scrolling into view
+     * whenever the document is changed
+     */
+    autoScrollIntoView?: boolean;
+    elementBrowser?: {
+        showModal?: boolean;
+        replacePlusMenu?: boolean;
+        helpUrl?: string;
+        emptyStateHandler?: EmptyStateHandler;
+    };
+    maxContentSize?: number;
+    saveOnEnter?: boolean;
+    feedbackInfo?: FeedbackInfo;
+    media?: MediaOptions;
+    collabEdit?: CollabEditOptions;
+    primaryToolbarComponents?: PrimaryToolbarComponents;
+    /** @deprecated Use smartLinks instead. */
+    UNSAFE_cards?: CardOptions;
+    /** @deprecated Use linking instead. */
+    smartLinks?: CardOptions;
+    /**
+     *  Configure and extend editor linking behaviour
+     */
+    linking?: LinkingOptions;
+    sanitizePrivateContent?: boolean;
+    mention?: MentionPluginConfig;
+    /**
+     * flag to indicate display name instead of nick name should be inserted for mentions
+     * default: false, which inserts the nick name
+     * @deprecated Use mention.mentionInsertDisplayName instead
+     */
+    mentionInsertDisplayName?: boolean;
+    /**
+     * @description Control performance metric measurements and tracking
+     */
+    performanceTracking?: PerformanceTracking;
+    uploadErrorHandler?: (state: MediaState) => void;
+    onSave?: (editorView: EditorView) => void;
+    waitForMediaUpload?: boolean;
+    insertMenuItems?: MenuItem[];
+    extensionHandlers?: ExtensionHandlers;
+}
 export {};

package/dist/types/utils/input-rules.d.ts

@@ -3,6 +3,7 @@ import type { Node as PMNode, NodeType } from 'prosemirror-model';
 import { EditorState, Transaction } from 'prosemirror-state';
 import { InputRuleHandler, InputRuleWrapper } from '@atlaskit/prosemirror-input-rules';
 import { AnalyticsEventPayload } from '../plugins/analytics/types';
+import { JOIN_SCENARIOS_WHEN_TYPING_TO_INSERT_LIST } from '@atlaskit/editor-common/analytics';
 declare type GetPayload = AnalyticsEventPayload | ((state: EditorState, matchResult: RegExpExecArray) => AnalyticsEventPayload);
 export declare const ruleWithAnalytics: (getPayload: GetPayload) => (originalRule: InputRuleWrapper) => InputRuleWrapper;
 export declare const ruleWithTransform: (transform: (state: EditorState, tr: Transaction) => void) => (originalRule: InputRuleWrapper) => InputRuleWrapper;
@@ -22,7 +23,7 @@ declare type WrappingRuleProps = {
     match: RegExp;
     nodeType: NodeType;
     getAttrs?: Record<string, any> | ((matchResult: RegExpExecArray) => Record<string, any>);
-    joinPredicate?: (matchResult: RegExpExecArray, node: PMNode) => boolean;
+    joinPredicate?: (matchResult: RegExpExecArray, node: PMNode, joinScenario: JOIN_SCENARIOS_WHEN_TYPING_TO_INSERT_LIST) => boolean;
 };
 export declare const createWrappingJoinRule: ({ match, nodeType, getAttrs, joinPredicate, }: WrappingRuleProps) => InputRuleWrapper;
 export declare const createJoinNodesRule: (match: RegExp, nodeType: NodeType) => InputRuleWrapper;

package/dist/types/utils/lists.d.ts

@@ -0,0 +1,2 @@
+import { Selection } from 'prosemirror-state';
+export declare const doesSelectionWhichStartsOrEndsInListContainEntireList: (selection: Selection) => boolean;

package/dist/types/utils/prepare-quick-insert-provider.d.ts

@@ -0,0 +1,16 @@
+import type { ExtensionProvider } from '@atlaskit/editor-common/extensions';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
+import { QuickInsertProvider } from '@atlaskit/editor-common/provider-factory';
+import EditorActions from '../actions';
+import { QuickInsertOptions } from '../plugins/quick-insert/types';
+/**
+ *
+ * Used to combine the quickInsert provider and extension provider (if available)
+ * Or return a provider that is available (quickInsertProvider preferred)
+ * @param editorActions
+ * @param extensionProvider
+ * @param quickInsert
+ * @param createAnalyticsEvent
+ * @returns Quick insert provider if available
+ */
+export default function prepareQuickInsertProvider(editorActions: EditorActions, extensionProvider?: ExtensionProvider, quickInsert?: QuickInsertOptions, createAnalyticsEvent?: CreateUIAnalyticsEvent): Promise<QuickInsertProvider> | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "179.0.3",
+  "version": "179.1.0",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,12 +25,12 @@
   },
   "dependencies": {
     "@atlaskit/activity-provider": "^2.3.0",
-    "@atlaskit/adf-schema": "^25.1.0",
+    "@atlaskit/adf-schema": "^25.2.0",
     "@atlaskit/adf-utils": "^18.0.0",
     "@atlaskit/analytics-gas-types": "^5.0.0",
     "@atlaskit/analytics-listeners": "^8.5.0",
     "@atlaskit/analytics-namespaced-context": "^6.6.0",
-    "@atlaskit/analytics-next": "^8.2.0",
+    "@atlaskit/analytics-next": "^9.0.0",
     "@atlaskit/analytics-next-stable-react-context": "1.0.1",
     "@atlaskit/avatar": "^21.1.0",
     "@atlaskit/avatar-group": "^9.2.0",
@@ -40,7 +40,7 @@
     "@atlaskit/code": "^14.4.0",
     "@atlaskit/date": "^0.9.0",
     "@atlaskit/datetime-picker": "^12.3.0",
-    "@atlaskit/editor-common": "^72.2.0",
+    "@atlaskit/editor-common": "^72.4.0",
     "@atlaskit/editor-json-transformer": "^8.8.0",
     "@atlaskit/editor-markdown-transformer": "^5.0.0",
     "@atlaskit/editor-plugin-table": "^1.1.0",
@@ -54,7 +54,7 @@
     "@atlaskit/link-picker": "^1.16.0",
     "@atlaskit/locale": "^2.3.0",
     "@atlaskit/logo": "^13.11.0",
-    "@atlaskit/media-card": "^74.5.0",
+    "@atlaskit/media-card": "^74.6.0",
     "@atlaskit/media-client": "^20.0.0",
     "@atlaskit/media-common": "^2.19.0",
     "@atlaskit/media-filmstrip": "^46.1.0",
@@ -79,7 +79,7 @@
     "@atlaskit/textfield": "^5.3.0",
     "@atlaskit/theme": "^12.2.0",
     "@atlaskit/toggle": "^12.5.0",
-    "@atlaskit/tokens": "^1.1.0",
+    "@atlaskit/tokens": "^1.2.0",
     "@atlaskit/tooltip": "^17.6.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@atlaskit/width-detector": "^4.0.0",
@@ -132,9 +132,9 @@
   },
   "devDependencies": {
     "@atlaskit/atlassian-navigation": "^2.3.0",
-    "@atlaskit/breadcrumbs": "11.7.11",
+    "@atlaskit/breadcrumbs": "11.7.12",
     "@atlaskit/code": "^14.4.0",
-    "@atlaskit/collab-provider": "8.1.0",
+    "@atlaskit/collab-provider": "8.2.0",
     "@atlaskit/docs": "*",
     "@atlaskit/drawer": "^7.4.0",
     "@atlaskit/dropdown-menu": "^11.5.0",