@atlaskit/editor-core 220.4.3 → 220.4.5

package/dist/types-ts4.5/presets/default-preset-type.d.ts

@@ -1,87 +0,0 @@
-import type { EditorPresetBuilder } from '@atlaskit/editor-common/preset';
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
-import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
-import type { AnalyticsPlugin } from '@atlaskit/editor-plugins/analytics';
-import type { BasePlugin } from '@atlaskit/editor-plugins/base';
-import type { BetterTypeHistoryPlugin } from '@atlaskit/editor-plugins/better-type-history';
-import type { BlockMenuPlugin } from '@atlaskit/editor-plugins/block-menu';
-import type { BlockTypePlugin } from '@atlaskit/editor-plugins/block-type';
-import type { ClearMarksOnEmptyDocPlugin } from '@atlaskit/editor-plugins/clear-marks-on-empty-doc';
-import type { ClipboardPlugin } from '@atlaskit/editor-plugins/clipboard';
-import type { CodeBlockPlugin } from '@atlaskit/editor-plugins/code-block';
-import type { CompositionPlugin } from '@atlaskit/editor-plugins/composition';
-import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugins/context-identifier';
-import type { CopyButtonPlugin } from '@atlaskit/editor-plugins/copy-button';
-import type { DecorationsPlugin } from '@atlaskit/editor-plugins/decorations';
-import type { EditorDisabledPlugin } from '@atlaskit/editor-plugins/editor-disabled';
-import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugins/feature-flags';
-import type { FloatingToolbarPlugin } from '@atlaskit/editor-plugins/floating-toolbar';
-import type { FocusPlugin } from '@atlaskit/editor-plugins/focus';
-import type { HistoryPlugin } from '@atlaskit/editor-plugins/history';
-import type { HyperlinkPlugin } from '@atlaskit/editor-plugins/hyperlink';
-import type { InteractionPlugin } from '@atlaskit/editor-plugins/interaction';
-import type { PastePlugin } from '@atlaskit/editor-plugins/paste';
-import type { PlaceholderPlugin } from '@atlaskit/editor-plugins/placeholder';
-import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugins/primary-toolbar';
-import type { QuickInsertPlugin } from '@atlaskit/editor-plugins/quick-insert';
-import type { SelectionPlugin } from '@atlaskit/editor-plugins/selection';
-import type { SelectionToolbarPlugin } from '@atlaskit/editor-plugins/selection-toolbar';
-import type { SubmitEditorPlugin } from '@atlaskit/editor-plugins/submit-editor';
-import type { TextFormattingPlugin } from '@atlaskit/editor-plugins/text-formatting';
-import type { ToolbarPlugin } from '@atlaskit/editor-plugins/toolbar';
-import type { TypeAheadPlugin } from '@atlaskit/editor-plugins/type-ahead';
-import type { UiControlRegistryPlugin } from '@atlaskit/editor-plugins/ui-control-registry';
-import type { UndoRedoPlugin } from '@atlaskit/editor-plugins/undo-redo';
-import type { UnsupportedContentPlugin } from '@atlaskit/editor-plugins/unsupported-content';
-import type { UserIntentPlugin } from '@atlaskit/editor-plugins/user-intent';
-import type { WidthPlugin } from '@atlaskit/editor-plugins/width';
-type ExtractPluginName<Plugin> = Plugin extends NextEditorPlugin<infer PluginName, any> | undefined ? PluginName : never;
-export type DefaultPresetPlugins = [
-    CodeBlockPlugin,
-    SelectionPlugin,
-    FloatingToolbarPlugin,
-    CopyButtonPlugin,
-    SubmitEditorPlugin,
-    EditorDisabledPlugin,
-    UnsupportedContentPlugin,
-    PlaceholderPlugin,
-    QuickInsertPlugin,
-    WidthPlugin,
-    TextFormattingPlugin,
-    HyperlinkPlugin,
-    SelectionToolbarPlugin,
-    ClearMarksOnEmptyDocPlugin,
-    BlockTypePlugin,
-    BlockMenuPlugin | undefined,
-    UndoRedoPlugin | undefined,
-    UiControlRegistryPlugin | undefined,
-    PrimaryToolbarPlugin,
-    ToolbarPlugin | undefined,
-    UserIntentPlugin | undefined,
-    HistoryPlugin | undefined,
-    TypeAheadPlugin,
-    DecorationsPlugin,
-    BasePlugin,
-    ContextIdentifierPlugin,
-    CompositionPlugin,
-    InteractionPlugin | undefined,
-    UserPreferencesPlugin | undefined,
-    FocusPlugin,
-    ClipboardPlugin,
-    PastePlugin,
-    BetterTypeHistoryPlugin,
-    AnalyticsPlugin | undefined,
-    FeatureFlagsPlugin
-];
-type ExtractPluginNames<PluginList extends (NextEditorPlugin<any, any> | undefined)[]> = PluginList extends [
-    infer Head,
-    ...infer Tail
-] ? Tail extends (NextEditorPlugin<any, any> | undefined)[] ? [
-    ExtractPluginName<Head>,
-    ...ExtractPluginNames<Tail>
-] : [
-] : [
-];
-type DefaultPresetPluginNames = ExtractPluginNames<DefaultPresetPlugins>;
-export type DefaultPresetBuilder = EditorPresetBuilder<DefaultPresetPluginNames, DefaultPresetPlugins>;
-export {};

package/dist/types-ts4.5/presets/default.d.ts

@@ -1,66 +0,0 @@
-import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
-import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
-import type { SelectionPluginOptions } from '@atlaskit/editor-common/selection';
-import type { EditorAppearance, FeatureFlags, PerformanceTracking } from '@atlaskit/editor-common/types';
-import type { BasePluginOptions } from '@atlaskit/editor-plugins/base';
-import type { BlockMenuPluginOptions } from '@atlaskit/editor-plugins/block-menu';
-import type { BlockTypePluginOptions } from '@atlaskit/editor-plugins/block-type';
-import type { CodeBlockPluginOptions } from '@atlaskit/editor-plugins/code-block';
-import type { HyperlinkPluginOptions } from '@atlaskit/editor-plugins/hyperlink';
-import type { PastePluginOptions } from '@atlaskit/editor-plugins/paste';
-import type { PlaceholderPluginOptions } from '@atlaskit/editor-plugins/placeholder';
-import type { QuickInsertPluginOptions } from '@atlaskit/editor-plugins/quick-insert';
-import type { TextFormattingPluginOptions } from '@atlaskit/editor-plugins/text-formatting';
-import type { ToolbarPluginOptions } from '@atlaskit/editor-plugins/toolbar';
-import type { TypeAheadPluginOptions } from '@atlaskit/editor-plugins/type-ahead';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { DefaultPresetBuilder } from './default-preset-type';
-export type DefaultPresetPluginOptions = {
-    /**
-     * There is expected to be temporary divergence between Live Page editor expand behaviour and the standard expand behaviour.
-     *
-     * This is expected to be removed in Q4 as Editor and Live Page teams align on a singular behaviour.
-     *
-     * It is only supported for use by Confluence.
-     *
-     * @default false
-     */
-    __livePage?: boolean;
-    allowAnalyticsGASV3?: boolean;
-    allowUndoRedoButtons?: boolean;
-    appearance?: EditorAppearance | undefined;
-    base?: BasePluginOptions;
-    blockMenu?: BlockMenuPluginOptions & {
-        enabled?: boolean;
-    };
-    blockType?: BlockTypePluginOptions;
-    codeBlock?: CodeBlockPluginOptions;
-    contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-    disabled?: boolean;
-    featureFlags?: FeatureFlags;
-    hyperlinkOptions?: HyperlinkPluginOptions;
-    paste?: PastePluginOptions;
-    performanceTracking?: PerformanceTracking;
-    placeholder?: PlaceholderPluginOptions;
-    preferenceToolbarAboveSelection?: boolean;
-    quickInsert?: QuickInsertPluginOptions;
-    selection?: SelectionPluginOptions;
-    submitEditor?: (editorView: EditorView) => void;
-    textFormatting?: TextFormattingPluginOptions;
-    toolbar?: ToolbarPluginOptions;
-    typeAhead?: TypeAheadPluginOptions;
-};
-/**
- * Note: The order that presets are added determines
- * their placement in the editor toolbar
- * @param options
- * @example
- */
-export declare function createDefaultPreset(options: DefaultPresetPluginOptions): DefaultPresetBuilder;
-/**
- *
- * @param props
- * @example
- */
-export declare function useDefaultPreset(props: DefaultPresetPluginOptions): DefaultPresetBuilder[];

package/dist/types-ts4.5/presets/universal.d.ts

@@ -1,98 +0,0 @@
-import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next/types';
-import type { ContextualFormattingEnabledOptions } from '@atlaskit/editor-common/toolbar';
-import type { EditorAppearance, FeatureFlags } from '@atlaskit/editor-common/types';
-import type { ToolbarInsertBlockButtonsConfig } from '@atlaskit/editor-plugin-insert-block';
-import type { ExtensionPluginOptions } from '@atlaskit/editor-plugins/extension';
-import type { BreakpointPreset } from '@atlaskit/editor-toolbar';
-import type { EditorPluginFeatureProps, EditorProps, EditorProviderProps, EditorSharedPropsWithPlugins } from '../types/editor-props';
-import type { DefaultPresetPluginOptions } from './default';
-export type UniversalPresetProps = DefaultPresetPluginOptions & EditorSharedPropsWithPlugins & Omit<EditorPluginFeatureProps, 'placeholder'> & EditorProviderProps;
-/**
- * Mechanism to configuring plugins as the universal preset blocks direct access
- * to configuring plugins.
- *
- * Note: not all plugins are configurable via this mechanism, and for plugins configured -- it is only doing a subset of the configuration.
- */
-export type InitialPluginConfiguration = {
-    blockControlsPlugin?: {
-        enabled?: boolean;
-        quickInsertButtonEnabled?: boolean;
-        rightSideControlsEnabled?: boolean;
-    };
-    blockMenuPlugin?: {
-        blockLinkHashPrefix?: string;
-        enabled?: boolean;
-        getLinkPath?: () => string | null;
-        useStandardNodeWidth?: boolean;
-    };
-    blockTypePlugin?: {
-        allowFontSize?: boolean;
-    };
-    emojiPlugin?: {
-        disableAutoformat?: boolean;
-    };
-    extensionPlugin?: {
-        __rendererExtensionOptions?: ExtensionPluginOptions['__rendererExtensionOptions'];
-    };
-    insertBlockPlugin?: {
-        toolbarButtons?: ToolbarInsertBlockButtonsConfig;
-        toolbarShowPlusInsertOnly?: boolean;
-    };
-    mentionsPlugin?: {
-        handleMentionsChanged?: (mentionChanges: {
-            id: string;
-            localId: string;
-            taskLocalId?: string;
-            type: 'added' | 'deleted';
-        }[]) => void;
-    };
-    tasksAndDecisionsPlugin?: {
-        allowBlockTaskItem?: boolean;
-        hasEditPermission?: boolean;
-        quickInsertActionDescription?: string;
-        requestEditPermission?: () => void;
-        taskPlaceholder?: string;
-    };
-    toolbarPlugin?: {
-        breakpointPreset?: BreakpointPreset;
-        contextualFormattingEnabled?: ContextualFormattingEnabledOptions;
-        /**
-         * The disableSelectionToolbar option is deprecated and will be removed in the future, replaced with `contextualFormattingEnabled`.
-         *
-         * To disable the selection toolbar (so only the primary toolbar is shown), use `contextualFormattingEnabled: 'always-pinned'`.
-         */
-        disableSelectionToolbar?: boolean;
-        enableNewToolbarExperience?: boolean;
-    };
-    trackChangesPlugin?: {
-        showOnToolbar?: boolean;
-    };
-};
-/**
- * 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
- * @returns a full featured preset configured according to the provided props - basis for create-plugins-list
- */
-export default function createUniversalPresetInternal({ appearance, props, featureFlags, initialPluginConfiguration, prevAppearance, createAnalyticsEvent, }: {
-    appearance: EditorAppearance | undefined;
-    createAnalyticsEvent?: CreateUIAnalyticsEvent;
-    featureFlags: FeatureFlags;
-    /**
-     * Allows configuring plugins as the universal preset blocks direct access
-     * to configuring plugins.
-     */
-    initialPluginConfiguration?: InitialPluginConfiguration;
-    prevAppearance?: EditorAppearance;
-    props: UniversalPresetProps;
-}): any;
-interface ExpandEditorProps {
-    allowExpand?: EditorProps['allowExpand'];
-}
-export declare function isExpandInsertionEnabled({ allowExpand }: ExpandEditorProps): boolean;
-export {};

package/dist/types-ts4.5/presets/useUniversalPreset.d.ts

@@ -1,8 +0,0 @@
-import type { EditorProps } from '../types/editor-props';
-import type { InitialPluginConfiguration } from './universal';
-interface PresetProps {
-    initialPluginConfiguration?: InitialPluginConfiguration;
-    props: EditorProps;
-}
-export default function useUniversalPreset({ props, initialPluginConfiguration, }: PresetProps): any;
-export {};

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

@@ -1,2 +0,0 @@
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-export declare function setTextSelection(view: EditorView, anchor: number, head?: number): void;

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

@@ -1,24 +0,0 @@
-import type { EditorPluginInjectionAPI } from '@atlaskit/editor-common/preset';
-import { EditorPresetBuilder } from '@atlaskit/editor-common/preset';
-import type { MarkConfig, NodeConfig, ReactHookFactory, UIComponentFactory } from '@atlaskit/editor-common/types';
-import type { Schema } from '@atlaskit/editor-prosemirror/model';
-import type { Plugin } from '@atlaskit/editor-prosemirror/state';
-import type { LightPMPlugin, LightPMPluginFactoryParams, OnEditorViewStateUpdated } from './create-editor/get-plugins';
-export interface LightEditorConfig {
-    contentComponents: UIComponentFactory[];
-    marks: MarkConfig[];
-    nodes: NodeConfig[];
-    onEditorViewStateUpdatedCallbacks: Array<OnEditorViewStateUpdated>;
-    pluginHooks: ReactHookFactory[];
-    plugins: Array<LightPMPlugin>;
-}
-type PluginData = {
-    editorConfig: LightEditorConfig;
-    onEditorViewStateUpdatedCallbacks: Array<OnEditorViewStateUpdated>;
-    plugins: Plugin[];
-    schema: Schema;
-};
-export declare const createPMSchemaAndPlugins: (inputPreset?: EditorPresetBuilder) => (pluginFactoryParams: Omit<LightPMPluginFactoryParams, "schema"> & {
-    pluginInjectionAPI: EditorPluginInjectionAPI;
-}) => PluginData;
-export {};

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

@@ -1,10 +0,0 @@
-/**
- * This file is a temporary hack to allow the editor to have references to the QuickInsertPlugin type.
- *
- * There is bug in tsconfig references generation, where it only adds references to the immediate dependencies of the project.
- * and not transitive dependencies. Typescript doesn't look into transitive dependencies tp update cached declarations of a package.
- *
- * Typecheck team is working on a fix for this issue.
- **/
-import type { QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
-export type tmpQuickInsertPlugin = QuickInsertPlugin;

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

@@ -1,5 +0,0 @@
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-export type CommandDispatch = (tr: Transaction) => void;
-export type Command = (state: EditorState, dispatch?: CommandDispatch, view?: EditorView) => boolean;
-export type HigherOrderCommand = (command: Command) => Command;

package/dist/types-ts4.5/types/dom-at-pos.d.ts

@@ -1,4 +0,0 @@
-export type DomAtPos = (pos: number) => {
-    node: Node;
-    offset: number;
-};

package/dist/types-ts4.5/types/editor-appearance-component.d.ts

@@ -1,57 +0,0 @@
-import type { ReactElement, RefObject } from 'react';
-import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
-import type { CollabEditOptions } from '@atlaskit/editor-common/collab';
-import type { EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
-import type { ExtensionHandlers } from '@atlaskit/editor-common/extensions';
-import type { AllEditorPresetPluginTypes, EditorPresetBuilder } from '@atlaskit/editor-common/preset';
-import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
-import type { EditorAppearance, EditorContentMode, FeatureFlags, NextEditorPlugin, PublicPluginAPI, ReactHookFactory, ToolbarUIComponentFactory, UIComponentFactory } from '@atlaskit/editor-common/types';
-import type { UseStickyToolbarType } from '@atlaskit/editor-common/ui';
-import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type EditorActions from '../actions';
-import type { ContentComponents, PrimaryToolbarComponents, ReactComponents } from '../types/editor-props';
-export interface EditorAppearanceComponentProps<Plugins extends NextEditorPlugin<any, any>[]> {
-    __livePage?: boolean;
-    appearance?: EditorAppearance;
-    collabEdit?: CollabEditOptions;
-    contentComponents?: UIComponentFactory[];
-    contentMode?: EditorContentMode;
-    contextPanel?: ReactComponents;
-    customContentComponents?: ContentComponents;
-    customPrimaryToolbarComponents?: PrimaryToolbarComponents;
-    customSecondaryToolbarComponents?: ReactComponents;
-    disabled?: boolean;
-    dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
-    editorActions?: EditorActions;
-    editorAPI: PublicPluginAPI<Plugins> | undefined;
-    editorDOMElement: JSX.Element;
-    editorView?: EditorView;
-    enableToolbarMinWidth?: boolean;
-    eventDispatcher?: EventDispatcher;
-    extensionHandlers?: ExtensionHandlers;
-    featureFlags: FeatureFlags;
-    innerRef?: RefObject<HTMLDivElement>;
-    insertMenuItems?: MenuItem[];
-    isEditorModernisationEnabled?: boolean;
-    maxHeight?: number;
-    minHeight?: number;
-    onCancel?: (editorView: EditorView) => void;
-    onSave?: (editorView: EditorView) => void;
-    onSSRMeasure?: (measure: {
-        endTimestamp: number;
-        segmentName: string;
-        startTimestamp: number;
-    }) => void;
-    persistScrollGutter?: boolean;
-    pluginHooks?: ReactHookFactory[];
-    popupsBoundariesElement?: HTMLElement;
-    popupsMountPoint?: HTMLElement;
-    popupsScrollableElement?: HTMLElement;
-    preset?: EditorPresetBuilder<string[], AllEditorPresetPluginTypes[]>;
-    primaryToolbarComponents?: ToolbarUIComponentFactory[];
-    primaryToolbarIconBefore?: ReactElement;
-    providerFactory: ProviderFactory;
-    secondaryToolbarComponents?: UIComponentFactory[];
-    useStickyToolbar?: UseStickyToolbarType;
-}

package/dist/types-ts4.5/types/editor-config.d.ts

@@ -1,21 +0,0 @@
-import type { MarkConfig, NodeConfig, PMPlugin, ReactHookFactory, ToolbarUIComponentFactory, UIComponentFactory } from '@atlaskit/editor-common/types';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-export type EditorViewStateUpdatedCallbackProps = {
-    readonly newEditorState: Readonly<EditorState>;
-    readonly oldEditorState: Readonly<EditorState>;
-    readonly originalTransaction: Readonly<Transaction>;
-    readonly transactions: readonly Transaction[];
-};
-export interface EditorConfig {
-    contentComponents: UIComponentFactory[];
-    marks: MarkConfig[];
-    nodes: NodeConfig[];
-    onEditorViewStateUpdatedCallbacks: Array<{
-        callback: (props: EditorViewStateUpdatedCallbackProps) => void;
-        pluginName: string;
-    }>;
-    pluginHooks: ReactHookFactory[];
-    pmPlugins: Array<PMPlugin>;
-    primaryToolbarComponents: ToolbarUIComponentFactory[];
-    secondaryToolbarComponents: UIComponentFactory[];
-}

package/dist/types-ts4.5/types/editor-instance.d.ts

@@ -1,19 +0,0 @@
-import type { EventDispatcher } from '@atlaskit/editor-common/event-dispatcher';
-import type { ToolbarUIComponentFactory, UIComponentFactory, ReactHookFactory } from '@atlaskit/editor-common/types';
-import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { OnEditorViewStateUpdated } from '../create-editor/get-plugins';
-export interface EditorInstance {
-    contentComponents: UIComponentFactory[];
-    contentTransformer?: Transformer<string>;
-    editorView: EditorView;
-    eventDispatcher: EventDispatcher;
-    insertMenuItems?: MenuItem[];
-    onEditorViewStateUpdatedCallbacks: {
-        callback: OnEditorViewStateUpdated;
-        pluginName: string;
-    }[];
-    pluginHooks: ReactHookFactory[];
-    primaryToolbarComponents: ToolbarUIComponentFactory[];
-    secondaryToolbarComponents: UIComponentFactory[];
-}

package/dist/types-ts4.5/types/editor-onchange.d.ts

@@ -1,14 +0,0 @@
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-export type EditorOnChangeHandler = (editorView: EditorView, meta: {
-    /**
-     * Indicates whether or not the change may be unnecessary to listen to (dirty
-     * changes can generally be ignored).
-     *
-     * This might be changes to media attributes for example when it gets updated
-     * due to initial setup.
-     *
-     * We still fire these events however to avoid a breaking change.
-     */
-    isDirtyChange: boolean;
-    source: 'local' | 'remote';
-}) => void;