@atlaskit/editor-common 107.28.2 → 107.30.0

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

@@ -11,71 +11,66 @@ import type { ReactHookFactory, UIComponentFactory } from './ui-components';
 export type PluginsOptions = {
     [pluginName: string]: any;
     /**
-     * Handler returns an array of QuickInsertItem that are added to the Element Browser, Insert Menu and Quick Insert
+     * Handler returning a React component that is added to the context panel.
+     *
+     * See https://product-fabric.atlassian.net/wiki/spaces/E/pages/1406016239/Context+Panel
      */
-    quickInsert?: QuickInsertHandler;
-    typeAhead?: TypeAheadHandler;
+    contextPanel?: ContextPanelHandler;
     /**
      * See: `FloatingToolbarConfig`
      */
     floatingToolbar?: FloatingToolbarHandler;
+    /**
+     * Handler returns an array of QuickInsertItem that are added to the Element Browser, Insert Menu and Quick Insert
+     */
+    quickInsert?: QuickInsertHandler;
     /**
      * The selection toolbar is a floating toolbar that is displayed for
      * range selections when any plugins return a selection toolbar group with
      * items.
      */
     selectionToolbar?: SelectionToolbarHandler;
-    /**
-     * Handler returning a React component that is added to the context panel.
-     *
-     * See https://product-fabric.atlassian.net/wiki/spaces/E/pages/1406016239/Context+Panel
-     */
-    contextPanel?: ContextPanelHandler;
+    typeAhead?: TypeAheadHandler;
 };
 type EditorViewStateUpdatedCallbackProps = {
+    readonly newEditorState: Readonly<EditorState>;
+    readonly oldEditorState: Readonly<EditorState>;
     readonly originalTransaction: Readonly<Transaction>;
     readonly transactions: readonly Transaction[];
-    readonly oldEditorState: Readonly<EditorState>;
-    readonly newEditorState: Readonly<EditorState>;
 };
 export interface EditorPlugin {
     /**
-     * Name of a plugin, that other plugins can use to provide options to it or exclude via a preset.
+     * Optional UI-component that lives inside the actual content-area (like mention-picker, floating toolbar for links, etc.)
+     *
+     * Handler returns a React component that is added to the top of the editor content area (PluginSlot).
+     * Although it’s common to specify a custom mount point (eg. date picker)
      */
-    name: string;
+    contentComponent?: UIComponentFactory;
     /**
-     * Options that will be passed to a plugin with a corresponding name if it exists and enabled.
+     * A list of `MarkConfig`s with a name and a `MarkSpec` (`MarkSpec` is imported from @atlaskit/adf-schema)
      */
-    pluginsOptions?: PluginsOptions;
+    marks?: () => MarkConfig[];
     /**
-     * List of ProseMirror-plugins. This is where we define which plugins will be added to EditorView (main-plugin, keybindings, input-rules, etc.).
+     * Name of a plugin, that other plugins can use to provide options to it or exclude via a preset.
      */
-    pmPlugins?: (pluginOptions?: any) => Array<PMPlugin>;
+    name: string;
     /**
      * A list of `NodeConfig`s with a name and a `NodeSpec`. (`NodeSpec` is imported from @atlaskit/adf-schema)
      *
      */
     nodes?: () => NodeConfig[];
     /**
-     * A list of `MarkConfig`s with a name and a `MarkSpec` (`MarkSpec` is imported from @atlaskit/adf-schema)
+     * Called after EditorView state is updated.
      */
-    marks?: () => MarkConfig[];
+    onEditorViewStateUpdated?: (props: EditorViewStateUpdatedCallbackProps) => void;
     /**
-     * Optional UI-component that lives inside the actual content-area (like mention-picker, floating toolbar for links, etc.)
-     *
-     * Handler returns a React component that is added to the top of the editor content area (PluginSlot).
-     * Although it’s common to specify a custom mount point (eg. date picker)
+     * Options that will be passed to a plugin with a corresponding name if it exists and enabled.
      */
-    contentComponent?: UIComponentFactory;
+    pluginsOptions?: PluginsOptions;
     /**
-     * Optional react hook that is mounted for all appearances
-     *
-     * This can be used to access React context, or other React specific code (ie. run `useEffect`)
-     * within a plugin that will run for all appearances without mounting any components.
-     *
-     * Example usages include analytics or width.
+     * List of ProseMirror-plugins. This is where we define which plugins will be added to EditorView (main-plugin, keybindings, input-rules, etc.).
      */
-    usePluginHook?: ReactHookFactory;
+    pmPlugins?: (pluginOptions?: any) => Array<PMPlugin>;
     /**
      * Optional UI-component that will be added to the toolbar at the top of the editor (doesn't exist in the compact-editor).
      *
@@ -90,9 +85,14 @@ export interface EditorPlugin {
      */
     secondaryToolbarComponent?: UIComponentFactory;
     /**
-     * Called after EditorView state is updated.
+     * Optional react hook that is mounted for all appearances
+     *
+     * This can be used to access React context, or other React specific code (ie. run `useEffect`)
+     * within a plugin that will run for all appearances without mounting any components.
+     *
+     * Example usages include analytics or width.
      */
-    onEditorViewStateUpdated?: (props: EditorViewStateUpdatedCallbackProps) => void;
+    usePluginHook?: ReactHookFactory;
 }
 export type getPosHandler = getPosHandlerNode | boolean;
 export type getPosHandlerNode = () => number | undefined;

package/dist/types/types/empty-state-handler.d.ts

@@ -1,6 +1,6 @@
 export type EmptyStateHandler = (params: EmptyStateHandlerParams) => React.ReactElement<any> | null;
 export type EmptyStateHandlerParams = {
     mode: string;
-    selectedCategory?: string;
     searchTerm?: string;
+    selectedCategory?: string;
 };

package/dist/types/types/feature-flags.d.ts

@@ -31,70 +31,76 @@ import type { DisableSpellcheckByBrowser } from './supported-browsers';
 export type FeatureFlags = {
     /**
      * @description
-     * Whether a placeholder bracket hint was provided (`string => boolean`)
-     * Placeholder text to be displayed when a bracket '{' is typed and the line is empty e.g. 'Did you mean to use '/' to insert content?'
-     * This is used to aid migration for TinyMCE power users to the new Fabric editor power user shortcuts.
+     * Enable add column custom step
      *
-     * @see https://product-fabric.atlassian.net/l/c/4JLjusAP
-     * @default true
+     * @see https://product-fabric.atlassian.net/browse/ED-8856
+     * @default false
      */
-    placeholderBracketHint?: boolean;
+    addColumnWithCustomStep?: boolean;
     /**
      * @description
-     * Whether placeholder hints were provided (`string[] => boolean`)
-     * Placeholder text values to display on new empty lines.
+     * Measure render performance for all tracked analytics events
      *
-     * @see https://product-fabric.atlassian.net/l/c/GG1Yv9cK
      * @default false
      */
-    placeholderHints?: boolean;
+    catchAllTracking?: boolean;
     /**
-     * @description
-     * Enable `localId` generation for extensions.
-     *
-     * @see https://product-fabric.atlassian.net/l/c/2m0i9jLX
-     * @default false
+     * Enable custom up/down key handler when cursor below/above an inline media
+     * @see https://product-fabric.atlassian.net/browse/ED-13066
+     * Chrome bug: https://bugs.chromium.org/p/chromium/issues/detail?id=1227468
+     * @default undefined
      */
-    extensionLocalIdGeneration?: boolean;
+    chromeCursorHandlerFixedVersion?: number;
     /**
      * @description
-     * Enable add column custom step
+     * Enable scroll-to-telepointer for collab avatars
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-8856
+     * @see https://product-fabric.atlassian.net/browse/ED-12460
      * @default false
      */
-    addColumnWithCustomStep?: boolean;
+    collabAvatarScroll?: boolean;
     /**
      * @description
-     * Enable undo/redo buttons and functionality within the editor
+     * Enables extra analytics to be added for comments on media
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-9537
+     * @see https://product-fabric.atlassian.net/browse/ED-23355
      * @default false
      */
-    undoRedoButtons?: boolean;
+    commentsOnMediaAnalytics?: boolean;
     /**
      * @description
-     * Measure render performance for all tracked analytics events
+     * Enables fix for comment sidebar is not scrolled into view when adding/viewing a comment on media
      *
+     * @see https://product-fabric.atlassian.net/browse/ED-23281
      * @default false
+
      */
-    catchAllTracking?: boolean;
+    commentsOnMediaAutoscrollInEditor?: boolean;
     /**
-     * @private
-     * @deprecated This is always on now and this prop is no longer required.
      * @description
-     * Yield to user interaction work before sending analytics
+     * Generic way of disabling spellcheck per browser by version range
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-10584
-     * @default false
+     * @see https://product-fabric.atlassian.net/browse/ED-14510
+     * @default {}
+     * Example:
+     * {
+     *    ie: {
+     *      minimum: 101,
+     *    },
+     *    chrome: {
+     *      minimum: 96,
+     *      maximum: 109,
+     *    },
+     * };
      */
-    queueAnalytics?: boolean;
+    disableSpellcheckByBrowser?: DisableSpellcheckByBrowser | undefined;
     /**
-     * Show the avatar group as a plugin
-     * @see https://product-fabric.atlassian.net/browse/CERN-747
+     * @decsription
+     * Enables the view update subscription plugin
+     *
      * @default false
      */
-    showAvatarGroupAsPlugin?: boolean;
+    enableViewUpdateSubscription?: boolean;
     /**
      * @description
      * Enables docStructure for unhandleErrorEvents
@@ -105,83 +111,99 @@ export type FeatureFlags = {
     errorBoundaryDocStructure?: boolean;
     /**
      * @description
-     * Enables docStructure for synchronyError
+     * Enable the new editor media resize experience.
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-12998
+     * @see https://product-fabric.atlassian.net/browse/ED-18316
      * @default false
      */
-    synchronyErrorDocStructure?: boolean;
+    extendedMediaResizeExperience?: boolean | undefined;
     /**
-     * @decsription
-     * Enables the view update subscription plugin
+     * @description
+     * Enable `localId` generation for extensions.
      *
+     * @see https://product-fabric.atlassian.net/l/c/2m0i9jLX
      * @default false
      */
-    enableViewUpdateSubscription?: boolean;
+    extensionLocalIdGeneration?: boolean;
     /**
      * @description
-     * Enable scroll-to-telepointer for collab avatars
+     * Used by the legacy content macro to disable render tracking due to excessive logs.
+     * Will be removed once re-rendering issue is resolved.
+     * Note: This is hardcoded into the LCM code, it does not exist in Switcheroo.
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-12460
+     * @see https://product-fabric.atlassian.net/browse/ED-26650
      * @default false
      */
-    collabAvatarScroll?: boolean;
+    lcmPreventRenderTracking?: boolean;
     /**
-     * Split editor toolbar to two lines when viewport is small
-     * @see https://product-fabric.atlassian.net/browse/CERN-1124
+     * @description
+     * Use the linking platform link picker for link insertion and edit
+     *
+     * @see https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3158246501/PP+Link+Picker+-+Standalone
+     * @see https://product-fabric.atlassian.net/browse/EDM-2577
      * @default false
      */
-    twoLineEditorToolbar?: boolean;
+    lpLinkPicker?: boolean;
     /**
-     * @deprecated
      * @description
-     * Enable new collab service
-     * @see https://product-fabric.atlassian.net/browse/ED-14097
+     * Enables macro interaction visual updates
+     *
+     * @see https://product-fabric.atlassian.net/browse/PGXT-4910
      * @default false
      */
-    useNativeCollabPlugin?: boolean;
+    macroInteractionUpdates?: boolean;
     /**
-     * Enable custom up/down key handler when cursor below/above an inline media
-     * @see https://product-fabric.atlassian.net/browse/ED-13066
-     * Chrome bug: https://bugs.chromium.org/p/chromium/issues/detail?id=1227468
-     * @default undefined
+     * @description
+     * Enables more elements in view in quick insert typeahead
+     *
+     * @see https://product-fabric.atlassian.net/browse/ED-24231
+     * @default false
+
      */
-    chromeCursorHandlerFixedVersion?: number;
+    moreElementsInQuickInsertView?: boolean;
     /**
      * @description
-     * Generic way of disabling spellcheck per browser by version range
+     * Whether a placeholder bracket hint was provided (`string => boolean`)
+     * Placeholder text to be displayed when a bracket '{' is typed and the line is empty e.g. 'Did you mean to use '/' to insert content?'
+     * This is used to aid migration for TinyMCE power users to the new Fabric editor power user shortcuts.
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-14510
-     * @default {}
-     * Example:
-     * {
-     *    ie: {
-     *      minimum: 101,
-     *    },
-     *    chrome: {
-     *      minimum: 96,
-     *      maximum: 109,
-     *    },
-     * };
+     * @see https://product-fabric.atlassian.net/l/c/4JLjusAP
+     * @default true
      */
-    disableSpellcheckByBrowser?: DisableSpellcheckByBrowser | undefined;
+    placeholderBracketHint?: boolean;
     /**
      * @description
-     * Use the linking platform link picker for link insertion and edit
+     * Whether placeholder hints were provided (`string[] => boolean`)
+     * Placeholder text values to display on new empty lines.
      *
-     * @see https://product-fabric.atlassian.net/wiki/spaces/EM/pages/3158246501/PP+Link+Picker+-+Standalone
-     * @see https://product-fabric.atlassian.net/browse/EDM-2577
+     * @see https://product-fabric.atlassian.net/l/c/GG1Yv9cK
      * @default false
      */
-    lpLinkPicker?: boolean;
+    placeholderHints?: boolean;
     /**
+     * @private
+     * @deprecated This is always on now and this prop is no longer required.
      * @description
-     * Enable the new editor media resize experience.
+     * Yield to user interaction work before sending analytics
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-18316
+     * @see https://product-fabric.atlassian.net/browse/ED-10584
      * @default false
      */
-    extendedMediaResizeExperience?: boolean | undefined;
+    queueAnalytics?: boolean;
+    /**
+     * Show the avatar group as a plugin
+     * @see https://product-fabric.atlassian.net/browse/CERN-747
+     * @default false
+     */
+    showAvatarGroupAsPlugin?: boolean;
+    /**
+     * @description
+     * Enables docStructure for synchronyError
+     *
+     * @see https://product-fabric.atlassian.net/browse/ED-12998
+     * @default false
+     */
+    synchronyErrorDocStructure?: boolean;
     /**
      * @description
      * Enables the drag and drop rows/columns for tables
@@ -207,49 +229,27 @@ export type FeatureFlags = {
      */
     tableWithFixedColumnWidthsOption?: boolean;
     /**
-     * @description
-     * Enables macro interaction visual updates
-     *
-     * @see https://product-fabric.atlassian.net/browse/PGXT-4910
-     * @default false
-     */
-    macroInteractionUpdates?: boolean;
-    /**
-     * @description
-     * Enables extra analytics to be added for comments on media
-     *
-     * @see https://product-fabric.atlassian.net/browse/ED-23355
-     * @default false
-     */
-    commentsOnMediaAnalytics?: boolean;
-    /**
-     * @description
-     * Enables fix for comment sidebar is not scrolled into view when adding/viewing a comment on media
-     *
-     * @see https://product-fabric.atlassian.net/browse/ED-23281
+     * Split editor toolbar to two lines when viewport is small
+     * @see https://product-fabric.atlassian.net/browse/CERN-1124
      * @default false
-
      */
-    commentsOnMediaAutoscrollInEditor?: boolean;
+    twoLineEditorToolbar?: boolean;
     /**
      * @description
-     * Enables more elements in view in quick insert typeahead
+     * Enable undo/redo buttons and functionality within the editor
      *
-     * @see https://product-fabric.atlassian.net/browse/ED-24231
+     * @see https://product-fabric.atlassian.net/browse/ED-9537
      * @default false
-
      */
-    moreElementsInQuickInsertView?: boolean;
+    undoRedoButtons?: boolean;
     /**
+     * @deprecated
      * @description
-     * Used by the legacy content macro to disable render tracking due to excessive logs.
-     * Will be removed once re-rendering issue is resolved.
-     * Note: This is hardcoded into the LCM code, it does not exist in Switcheroo.
-     *
-     * @see https://product-fabric.atlassian.net/browse/ED-26650
+     * Enable new collab service
+     * @see https://product-fabric.atlassian.net/browse/ED-14097
      * @default false
      */
-    lcmPreventRenderTracking?: boolean;
+    useNativeCollabPlugin?: boolean;
 };
 export type FeatureFlagKey = keyof FeatureFlags;
 export type GetEditorFeatureFlags = () => FeatureFlags;

package/dist/types/types/feedback-dialog.d.ts

@@ -1,10 +1,10 @@
 export type FeedbackInfo = {
-    product?: string;
-    packageVersion?: string;
-    packageName?: string;
+    contentId?: string;
+    coreVersion?: string;
     labels?: Array<string>;
+    packageName?: string;
+    packageVersion?: string;
+    product?: string;
     sessionId?: string;
-    contentId?: string;
     tabId?: string;
-    coreVersion?: string;
 };