@atlaskit/editor-core 180.0.0 → 181.0.0

package/dist/types/editor-next/editor-internal.d.ts

@@ -0,0 +1,44 @@
+/** @jsx jsx */
+import type { Transformer, AllEditorPresetPluginTypes } from '@atlaskit/editor-common/types';
+import { jsx } from '@emotion/react';
+import { EditorView } from 'prosemirror-view';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import EditorActions from '../actions';
+import { EventDispatcher } from '../event-dispatcher';
+import { FireAnalyticsCallback } from '@atlaskit/editor-common/analytics';
+import { EditorProps, EditorNextProps } from '../types/editor-props';
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { EditorPresetBuilder } from '@atlaskit/editor-common/preset';
+interface Props<PropsType> {
+    props: PropsType;
+    handleAnalyticsEvent: FireAnalyticsCallback;
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+    handleSave: (view: EditorView) => void;
+    editorActions: EditorActions;
+    getExperienceStore: () => ExperienceStore | undefined;
+    onEditorCreated: (instance: {
+        view: EditorView;
+        eventDispatcher: EventDispatcher;
+        transformer?: Transformer<string>;
+    }) => void;
+    onEditorDestroyed: (_instance: {
+        view: EditorView;
+        transformer?: Transformer<string>;
+    }) => void;
+    preset: EditorPresetBuilder<string[], AllEditorPresetPluginTypes[]>;
+}
+interface InternalProps extends Omit<Props<EditorNextProps | EditorProps>, 'getExperienceStore'> {
+    providerFactory: ProviderFactory;
+}
+/**
+ * EditorInternal is used for the internal editor react component
+ * with the lifecycle methods extracted into hooks.
+ */
+export default function EditorInternal(props: Props<EditorNextProps>): jsx.JSX.Element;
+/**
+ * EditorInternalComponent is used to capture the common component
+ * from the `render` method of `Editor` and share it with `EditorNext`.
+ */
+export declare function EditorInternalWithoutHooks({ props, handleAnalyticsEvent, createAnalyticsEvent, handleSave, editorActions, providerFactory, onEditorCreated, onEditorDestroyed, preset, }: InternalProps): jsx.JSX.Element;
+export {};

package/dist/types/editor-next/editor-migration-component.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import { EditorProps } from '../types/editor-props';
+export default class EditorMigrationComponent extends React.Component<EditorProps> {
+    render(): JSX.Element;
+}

package/dist/types/editor-next/hooks/useEditorMeasuresConstructor.d.ts

@@ -0,0 +1,17 @@
+/** @jsx jsx */
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import { EditorProps } from '../../types/editor-props';
+import { PerformanceTracking } from '../../types/performance-tracking';
+/**
+ *
+ * Hook to be used for running analytics on mounting the editor.
+ * Should run once.
+ * WARNING: Consider any changes to also make to `src/editor.tsx`
+ *
+ * @param performanceTracking
+ * @param featureFlags
+ * @param getExperienceStore function to retrieve the Editor's current ExperienceStore
+ * @param createAnalyticsEvent
+ */
+export default function useEditorConstructor(performanceTracking: PerformanceTracking | undefined, featureFlags: EditorProps['featureFlags'], getExperienceStore: () => ExperienceStore | undefined, createAnalyticsEvent: CreateUIAnalyticsEvent): void;

package/dist/types/editor-next/hooks/useMeasureEditorMountTime.d.ts

@@ -0,0 +1,13 @@
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import { EditorProps, EditorNextProps } from '../../types/editor-props';
+/**
+ *
+ * Hook to run the analytics for the Editor component.
+ * WARNING: Consider any changes to also make to `src/editor.tsx`
+ *
+ * @param props EditorProps
+ * @param getExperienceStore function to retrieve the Editor's current ExperienceStore
+ * @param createAnalyticsEvent
+ */
+export default function useMeasureEditorMountTime(props: EditorProps | EditorNextProps, getExperienceStore: () => ExperienceStore | undefined, createAnalyticsEvent: CreateUIAnalyticsEvent): void;

package/dist/types/editor-next/hooks/useProviderFactory.d.ts

@@ -0,0 +1,21 @@
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { EditorNextProps } from '../../types/editor-props';
+import EditorActions from '../../actions';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { QuickInsertProvider } from '../../plugins/quick-insert/types';
+import type { ExtensionProvider } from '@atlaskit/editor-common/extensions';
+export declare type ProviderFactoryState = {
+    extensionProvider?: ExtensionProvider;
+    quickInsertProvider?: Promise<QuickInsertProvider>;
+};
+/**
+ *
+ * This hook is used to create the provider factory object.
+ * WARNING: Consider any changes to also make to `src/editor.tsx`
+ *
+ * @param props
+ * @param editorActions
+ * @param createAnalyticsEvent
+ * @returns ProviderFactory for Editor
+ */
+export default function useProviderFactory(props: EditorNextProps, editorActions: EditorActions, createAnalyticsEvent: CreateUIAnalyticsEvent): ProviderFactory;

package/dist/types/editor-next/index.d.ts

@@ -0,0 +1,34 @@
+import { jsx } from '@emotion/react';
+import PropTypes from 'prop-types';
+import React from 'react';
+import { EditorNextProps } from '../types/editor-props';
+import { Context } from './utils/editorPropTypes';
+export default class EditorNext extends React.Component<EditorNextProps> {
+    /**
+     * WARNING: Code should be shared between Editor + EditorNext
+     * If you are making changes that affect both, consider making them
+     * in editor-next/editor-internal.tsx or editor-next/editor-utils.ts
+     */
+    static defaultProps: import("../types/editor-props").EditorProps;
+    static contextTypes: {
+        editorActions: PropTypes.Requireable<object>;
+    };
+    static propTypes: {
+        preset: ({ preset }: Pick<EditorNextProps, 'preset'>) => Error | null;
+        minHeight: ({ appearance, minHeight, }: Pick<import("../types/editor-props").EditorProps, "appearance" | "minHeight">) => Error | null;
+    };
+    private editorActions;
+    private createAnalyticsEvent?;
+    private editorSessionId;
+    private experienceStore?;
+    private startTime?;
+    constructor(props: EditorNextProps, context: Context);
+    private onEditorCreated;
+    private onEditorDestroyed;
+    private handleSave;
+    private handleAnalyticsEvent;
+    private registerEditorForActions;
+    private unregisterEditorFromActions;
+    private getExperienceStore;
+    render(): jsx.JSX.Element;
+}

package/dist/types/editor-next/utils/deprecationWarnings.d.ts

@@ -0,0 +1,2 @@
+import { EditorProps, EditorNextProps } from '../../types/editor-props';
+export default function deprecationWarnings(props: EditorProps | EditorNextProps): void;

package/dist/types/editor-next/utils/editorMeasureTTICallback.d.ts

@@ -0,0 +1,5 @@
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import { EditorProps } from '../../types/editor-props';
+import { PerformanceTracking } from '../../types/performance-tracking';
+export default function editorMeasureTTICallback(tti: number, ttiFromInvocation: number, canceled: boolean, performanceTracking: PerformanceTracking | undefined, featureFlags: EditorProps['featureFlags'], createAnalyticsEvent?: CreateUIAnalyticsEvent, experienceStore?: ExperienceStore): void;

package/dist/types/editor-next/utils/editorPropTypes.d.ts

@@ -0,0 +1,19 @@
+import type { IntlShape } from 'react-intl-next';
+import EditorActions from '../../actions';
+import { EditorProps } from '../../types/editor-props';
+export declare type Context = {
+    editorActions?: EditorActions;
+    intl: IntlShape;
+};
+/**
+ *
+ * Logic for Editor prop types (ie. `static propTypes = propTypes(message)`)
+ * for use with 'prop-types' library
+ *
+ * @param errorMessage
+ * @returns Editor prop-types
+ */
+export declare function propTypes(errorMessage: string): {
+    minHeight: ({ appearance, minHeight, }: Pick<EditorProps, 'appearance' | 'minHeight'>) => Error | null;
+};
+export declare const defaultProps: EditorProps;

package/dist/types/editor-next/utils/getBaseFontSize.d.ts

@@ -0,0 +1,6 @@
+import { EditorAppearance } from '@atlaskit/editor-common/types';
+/**
+ * @param appearance
+ * @returns default font size if valid
+ */
+export declare function getBaseFontSize(appearance?: EditorAppearance): number | undefined;

package/dist/types/editor-next/utils/getProvidersFromEditorProps.d.ts

@@ -0,0 +1,9 @@
+import { Providers } from '@atlaskit/editor-common/provider-factory';
+import { EditorProps } from '../../types/editor-props';
+declare type Complete<T> = {
+    [P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>> ? T[P] : T[P] | undefined;
+};
+declare type EditorProviderProps = Pick<EditorProps, 'linking' | 'smartLinks' | 'UNSAFE_cards' | 'autoformattingProvider' | 'media' | 'emojiProvider' | 'mentionProvider' | 'taskDecisionProvider' | 'contextIdentifierProvider' | 'searchProvider' | 'macroProvider' | 'activityProvider' | 'collabEdit' | 'collabEditProvider' | 'presenceProvider' | 'legacyImageUploadProvider'>;
+declare type RequiredProviders = Complete<Omit<Providers, 'reactionsStore' | 'profilecardProvider' | 'extensionProvider' | 'quickInsertProvider'>>;
+export default function getProvidersFromEditorProps({ linking, smartLinks, UNSAFE_cards, autoformattingProvider, media, emojiProvider, mentionProvider, legacyImageUploadProvider, taskDecisionProvider, contextIdentifierProvider, searchProvider, macroProvider, activityProvider, collabEdit, collabEditProvider, presenceProvider, }: EditorProviderProps): RequiredProviders;
+export {};

package/dist/types/editor-next/utils/handleProviders.d.ts

@@ -0,0 +1,14 @@
+import type { ExtensionProvider } from '@atlaskit/editor-common/extensions';
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { Providers } from '@atlaskit/editor-common/provider-factory';
+import { QuickInsertProvider } from '../../plugins/quick-insert/types';
+/**
+ *
+ * Utility to set all the providers on a provider factory
+ *
+ * @param providerFactory
+ * @param props
+ * @param extensionProvider
+ * @param quickInsertProvider
+ */
+export default function handleProviders(providerFactory: ProviderFactory, { emojiProvider, mentionProvider, taskDecisionProvider, contextIdentifierProvider, collabEditProvider, activityProvider, presenceProvider, macroProvider, imageUploadProvider, mediaProvider, autoformattingProvider, searchProvider, cardProvider, }: Providers, extensionProvider?: ExtensionProvider, quickInsertProvider?: Promise<QuickInsertProvider>): void;

package/dist/types/editor-next/utils/onEditorCreated.d.ts

@@ -0,0 +1,12 @@
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import { Transformer } from '@atlaskit/editor-common/types';
+import { EditorView } from 'prosemirror-view';
+import EditorActions from '../../actions';
+import { EventDispatcher } from '../../event-dispatcher';
+import { EditorProps, EditorNextProps } from '../../types/editor-props';
+export default function onEditorCreated(instance: {
+    view: EditorView;
+    eventDispatcher: EventDispatcher;
+    transformer?: Transformer<string>;
+}, props: EditorProps | EditorNextProps, setExperienceStore: (experienceStore: ExperienceStore) => void, getExperienceStore: () => ExperienceStore | undefined, getCreateAnalyticsEvent: () => CreateUIAnalyticsEvent | undefined, editorActions: EditorActions, startTime: number | undefined, registerEditorForActions: (editorView: EditorView, eventDispatcher: EventDispatcher, contentTransformer?: Transformer<string>) => void): void;

package/dist/types/editor-next/utils/sendDurationAnalytics.d.ts

@@ -0,0 +1,15 @@
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import { ACTION } from '@atlaskit/editor-common/analytics';
+import { EditorProps } from '../../types/editor-props';
+/**
+ *
+ * Util function to be used with the Editor component to send duration analytics
+ *
+ * @param action
+ * @param props
+ * @param getExperienceStore return the ExperienceStore of the Editor
+ * @param getCreateAnalyticsEvent return the CreateUIAnalyticsEvent of the Editor
+ * @returns
+ */
+export default function sendDurationAnalytics(action: ACTION.EDITOR_MOUNTED | ACTION.ON_EDITOR_READY_CALLBACK, props: Pick<EditorProps, 'contextIdentifierProvider' | 'featureFlags'>, getExperienceStore: () => ExperienceStore | undefined, createAnalyticsEvent: CreateUIAnalyticsEvent | undefined): (duration: number, startTime: number) => Promise<void>;

package/dist/types/editor-next/utils/trackEditorActions.d.ts

@@ -0,0 +1,29 @@
+import EditorActions from '../../actions';
+import { FireAnalyticsCallback } from '@atlaskit/editor-common/analytics';
+import { PerformanceTracking } from '../../types/performance-tracking';
+/**
+ *
+ * Util function to be used with the Editor to track the EditorActions prop
+ *
+ * @param editorActions
+ * @param performanceTracking
+ * @param handleAnalyticsEvent
+ * @returns
+ */
+export default function trackEditorActions(editorActions: EditorActions & {
+    _contentRetrievalTracking?: {
+        getValueTracked: boolean;
+        samplingCounters: {
+            success: number;
+            failure: number;
+        };
+    };
+}, performanceTracking: PerformanceTracking | undefined, handleAnalyticsEvent: FireAnalyticsCallback): EditorActions<any> & {
+    _contentRetrievalTracking?: {
+        getValueTracked: boolean;
+        samplingCounters: {
+            success: number;
+            failure: number;
+        };
+    } | undefined;
+};

package/dist/types/editor.d.ts

@@ -1,33 +1,35 @@
 /** @jsx jsx */
-import React from 'react';
 import { jsx } from '@emotion/react';
 import PropTypes from 'prop-types';
 import { EditorView } from 'prosemirror-view';
-import type { IntlShape } from 'react-intl-next';
+import React from 'react';
 import type { ExtensionProvider } from '@atlaskit/editor-common/extensions';
-import { Transformer } from '@atlaskit/editor-common/types';
+import type { EditorPresetBuilder } from '@atlaskit/editor-common/preset';
+import type { Transformer, AllEditorPresetPluginTypes } from '@atlaskit/editor-common/types';
 import EditorActions from './actions';
-import { EditorProps, ExtensionProvidersProp } from './types/editor-props';
+import { Context } from './editor-next/utils/editorPropTypes';
 import { EventDispatcher } from './event-dispatcher';
-import { FireAnalyticsCallback } from './plugins/analytics';
-import { QuickInsertProvider, QuickInsertOptions } from './plugins/quick-insert/types';
-export type { AllowedBlockTypes, Command, CommandDispatch, DomAtPos, EditorAppearance, EditorAppearanceComponentProps, EditorConfig, EditorInstance, EditorPlugin, EditorProps, ExtensionProvidersProp, ExtensionConfig, FeedbackInfo, MarkConfig, MessageDescriptor, NodeConfig, NodeViewConfig, PMPlugin, PMPluginCreateConfig, PMPluginFactory, PMPluginFactoryParams, PluginsOptions, ReactComponents, ToolbarUIComponentFactory, ToolbarUiComponentFactoryParams, UIComponentFactory, UiComponentFactoryParams, } from './types';
-declare type Context = {
-    editorActions?: EditorActions;
-    intl: IntlShape;
+import { FireAnalyticsCallback } from '@atlaskit/editor-common/analytics';
+import { QuickInsertOptions, QuickInsertProvider } from './plugins/quick-insert/types';
+import { EditorProps } from './types/editor-props';
+import { ProviderFactoryState } from './editor-next/hooks/useProviderFactory';
+export type { AllowedBlockTypes, Command, CommandDispatch, DomAtPos, EditorAppearance, EditorAppearanceComponentProps, EditorConfig, EditorInstance, EditorPlugin, EditorProps, ExtensionConfig, ExtensionProvidersProp, FeedbackInfo, MarkConfig, MessageDescriptor, NodeConfig, NodeViewConfig, PluginsOptions, PMPlugin, PMPluginCreateConfig, PMPluginFactory, PMPluginFactoryParams, ReactComponents, ToolbarUIComponentFactory, ToolbarUiComponentFactoryParams, UIComponentFactory, UiComponentFactoryParams, } from './types';
+declare type PresetState = {
+    preset: EditorPresetBuilder<string[], AllEditorPresetPluginTypes[]>;
 };
-declare type State = {
-    extensionProvider?: ExtensionProvider;
-    quickInsertProvider?: Promise<QuickInsertProvider>;
-};
-export default class Editor extends React.Component<EditorProps, State> {
+export default class Editor extends React.Component<EditorProps, ProviderFactoryState & PresetState> {
+    /**
+     * WARNING: Code should be shared between Editor + EditorNext
+     * If you are making changes that affect both, consider making them
+     * in editor-next/editor-internal.tsx or editor-next/editor-utils.ts
+     */
     static defaultProps: EditorProps;
-    static propTypes: {
-        minHeight: ({ appearance, minHeight }: EditorProps) => Error | null;
-    };
     static contextTypes: {
         editorActions: PropTypes.Requireable<object>;
     };
+    static propTypes: {
+        minHeight: ({ appearance, minHeight, }: Pick<EditorProps, "appearance" | "minHeight">) => Error | null;
+    };
     private providerFactory;
     private editorActions;
     private createAnalyticsEvent?;
@@ -35,8 +37,22 @@ export default class Editor extends React.Component<EditorProps, State> {
     private experienceStore?;
     private startTime?;
     constructor(props: EditorProps, context: Context);
+    /**
+     * Consider any changes here to corresponding file for `EditorNext` in
+     * `useProviderFactory` (editor-next/hooks/useProviderFactory.ts) and
+     * `useMeasureEditorMountTime` (editor-next/hooks/useMeasureEditorMountTime.ts)
+     */
     componentDidMount(): void;
+    /**
+     * Consider any changes here to corresponding file for `EditorNext` in
+     * `useProviderFactory` (editor-next/hooks/useProviderFactory.ts)
+     */
     componentDidUpdate(prevProps: EditorProps): void;
+    /**
+     * Consider any changes here to corresponding file for `EditorNext` in
+     * `useProviderFactory` (editor-next/hooks/useProviderFactory.ts) and
+     * `useMeasureEditorMountTime` (editor-next/hooks/useMeasureEditorMountTime.ts)
+     */
     componentWillUnmount(): void;
     /**
      * @private
@@ -67,7 +83,7 @@ export default class Editor extends React.Component<EditorProps, State> {
      * Please reach out to the Editor team if you were previously using this
      * and need to find a workaround.
      */
-    prepareExtensionProvider: import("memoize-one").MemoizedFn<(extensionProviders?: ExtensionProvidersProp | undefined) => ExtensionProvider<any> | undefined>;
+    prepareExtensionProvider: (extensionProviders?: import("./types").ExtensionProvidersProp | undefined) => ExtensionProvider<any> | undefined;
     /**
      * @private
      * @deprecated - Do not override this at all, this is an antipattern.
@@ -86,8 +102,6 @@ export default class Editor extends React.Component<EditorProps, State> {
         eventDispatcher: EventDispatcher;
         transformer?: Transformer<string>;
     }): void;
-    private sendDurationAnalytics;
-    private deprecationWarnings;
     /**
      * @private
      * @deprecated - Do not override this at all, this is an antipattern.
@@ -98,10 +112,6 @@ export default class Editor extends React.Component<EditorProps, State> {
         view: EditorView;
         transformer?: Transformer<string>;
     }): void;
-    private registerEditorForActions;
-    private unregisterEditorFromActions;
-    private handleProviders;
-    private getBaseFontSize;
     /**
      * @private
      * @deprecated - Do not override this at all, this is an antipattern.
@@ -116,5 +126,20 @@ export default class Editor extends React.Component<EditorProps, State> {
      * and need to find a workaround.
      */
     handleAnalyticsEvent: FireAnalyticsCallback;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
+    registerEditorForActions(editorView: EditorView, eventDispatcher: EventDispatcher, contentTransformer?: Transformer<string>): void;
+    /**
+     * @private
+     * @deprecated - Do not override this at all, this is an antipattern.
+     * Please reach out to the Editor team if you were previously using this
+     * and need to find a workaround.
+     */
+    unregisterEditorFromActions(): void;
+    private getExperienceStore;
     render(): jsx.JSX.Element;
 }

package/dist/types/index.d.ts

@@ -90,3 +90,4 @@ export { DEFAULT_BORDER_COLOR } from './ui/ColorPalette/Palettes/common';
 export { default as messages, statusMessages, dateMessages } from './messages';
 export { createTypeAheadTools } from './plugins/type-ahead/api';
 export { createQuickInsertTools } from './plugins/quick-insert/api';
+export { default as EditorMigrationComponent } from './editor-next/editor-migration-component';

package/dist/types/keymaps/consts.d.ts

@@ -1,12 +1 @@
-export declare const LEFT = 37;
-export declare const RIGHT = 39;
-export declare const UP = 38;
-export declare const DOWN = 40;
-export declare const KEY_0 = 48;
-export declare const KEY_1 = 49;
-export declare const KEY_2 = 50;
-export declare const KEY_3 = 51;
-export declare const KEY_4 = 52;
-export declare const KEY_5 = 53;
-export declare const KEY_6 = 54;
 export declare const HEADING_KEYS: number[];

package/dist/types/labs/next/internal/hooks/use-analytics/index.d.ts

@@ -5,4 +5,4 @@ import { EditorSharedConfig } from '../../../internal/context/shared-config';
  * and passes them through to `fireAnalyticsEvent`.
  */
 export declare function useAnalyticsHandler(editorSharedConfig: EditorSharedConfig | null): void;
-export declare function useCreateAnalyticsHandler(createAnalyticsEvent?: CreateUIAnalyticsEvent): import("../../../../../plugins/analytics").FireAnalyticsCallback;
+export declare function useCreateAnalyticsHandler(createAnalyticsEvent?: CreateUIAnalyticsEvent): import("@atlaskit/editor-common/analytics").FireAnalyticsCallback;

package/dist/types/labs/next/presets/create-stub-internal-apis.d.ts

@@ -0,0 +1,16 @@
+import type { EditorPlugin } from '@atlaskit/editor-common/types';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { EditorSelectionAPI } from '@atlaskit/editor-common/selection';
+/**
+ * DO NOT USE THIS FUNCTION
+ *
+ * IT IS A TEMPORARY PLACEHOLDER UNTIL THOSE TICKETS XX-11111 XX-22222 are done
+ **/
+export declare const createStubInternalApis: () => {
+    editorSelectionAPI: EditorSelectionAPI;
+    insertNodeAPI: import("../../../insert-api/types").InsertNodeAPI;
+    editorAnalyticsAPI: EditorAnalyticsAPI;
+    createAnalyticsEvent: CreateUIAnalyticsEvent;
+    stubInternalApisPlugin: () => EditorPlugin;
+};

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

@@ -8,5 +8,37 @@ export declare type EditorPresetCXHTMLProps = {
     mentionProvider?: Promise<MentionProvider>;
     mediaProvider?: Promise<MediaProvider>;
 } & EditorPresetProps;
-export declare function useCXHTMLPreset({ mentionProvider, mediaProvider, placeholder, featureFlags, }: EditorPresetCXHTMLProps): import("./preset").Preset<import("@atlaskit/editor-common/types").EditorPlugin, []>[];
+export declare function useCXHTMLPreset({ mentionProvider, mediaProvider, placeholder, featureFlags, }: EditorPresetCXHTMLProps): import("@atlaskit/editor-common/preset").EditorPresetBuilder<[...string[], "hyperlink", "textFormatting", "width", "quickInsert", "typeAhead", "unsupportedContent", "editorDisabled", "submitEditor", "fakeTextCursor", "floatingToolbar", "featureFlagsContext", "selection", "codeBlock"], [(config: import("../../../plugins/code-block/types").CodeBlockOptions, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"codeBlock", {
+    pluginConfiguration: import("../../../plugins/code-block/types").CodeBlockOptions;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"codeBlock", {
+    pluginConfiguration: import("../../../plugins/code-block/types").CodeBlockOptions;
+}>, (config?: import("../../../plugins/selection/types").SelectionPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"selection", {
+    pluginConfiguration: import("../../../plugins/selection/types").SelectionPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"selection", {
+    pluginConfiguration: import("../../../plugins/selection/types").SelectionPluginOptions | undefined;
+}>, (config: import("@atlaskit/editor-common/types").FeatureFlags, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"featureFlagsContext", {
+    pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"featureFlagsContext", {
+    pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"floatingToolbar", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"floatingToolbar", {}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"fakeTextCursor", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"fakeTextCursor", {}>, (config?: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"submitEditor", {
+    pluginConfiguration: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"submitEditor", {
+    pluginConfiguration: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"editorDisabled", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"editorDisabled", {}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"unsupportedContent", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"unsupportedContent", {}>, (config?: import("../../../plugins/type-ahead").TypeAheadPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"typeAhead", {
+    pluginConfiguration: import("../../../plugins/type-ahead").TypeAheadPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"typeAhead", {
+    pluginConfiguration: import("../../../plugins/type-ahead").TypeAheadPluginOptions | undefined;
+}>, (config?: import("../../../plugins/quick-insert").QuickInsertPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"quickInsert", {
+    pluginConfiguration: import("../../../plugins/quick-insert").QuickInsertPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"quickInsert", {
+    pluginConfiguration: import("../../../plugins/quick-insert").QuickInsertPluginOptions | undefined;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"width", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"width", {}>, (config?: import("../../../plugins/text-formatting/types").TextFormattingOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"textFormatting", {
+    pluginConfiguration: import("../../../plugins/text-formatting/types").TextFormattingOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"textFormatting", {
+    pluginConfiguration: import("../../../plugins/text-formatting/types").TextFormattingOptions | undefined;
+}>, (config?: import("../../../plugins/hyperlink/types").HyperlinkPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"hyperlink", {
+    pluginConfiguration: import("../../../plugins/hyperlink/types").HyperlinkPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"hyperlink", {
+    pluginConfiguration: import("../../../plugins/hyperlink/types").HyperlinkPluginOptions | undefined;
+}>, ...import("@atlaskit/editor-common/types").AllEditorPresetPluginTypes[]]>[];
 export declare function EditorPresetCXHTML(props: EditorPresetCXHTMLProps): JSX.Element;

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

@@ -1,11 +1,8 @@
-import React from 'react';
 import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
 import { PastePluginOptions } from '../../../plugins/paste';
 import { BasePluginOptions } from '../../../plugins/base';
 import { EditorProps } from '../Editor';
 import { EditorPresetProps } from './types';
-import { Preset } from './preset';
-import { EditorPlugin } from '../../../types/editor-plugin';
 import { BlockTypePluginOptions } from '../../../plugins/block-type/types';
 import { PlaceholderPluginOptions } from '../../../plugins/placeholder';
 import { AnnotationProviders } from '../../../plugins/annotation';
@@ -16,9 +13,7 @@ import { SelectionPluginOptions } from '../../../plugins/selection/types';
 import { CardOptions } from '@atlaskit/editor-common/card';
 import { TypeAheadPluginOptions } from '../../../plugins/type-ahead';
 import { HyperlinkPluginOptions } from '../../../plugins/hyperlink/types';
-interface EditorPresetDefaultProps {
-    children?: React.ReactNode;
-}
+import { EditorPresetBuilder } from '@atlaskit/editor-common/preset';
 export declare type DefaultPresetPluginOptions = {
     paste: PastePluginOptions;
     base?: BasePluginOptions;
@@ -39,7 +34,69 @@ export declare type DefaultPresetPluginOptions = {
  * Note: The order that presets are added determines
  * their placement in the editor toolbar
  */
-export declare function createDefaultPreset(options: EditorPresetProps & DefaultPresetPluginOptions): Preset<EditorPlugin, []>;
-export declare function useDefaultPreset(props: EditorPresetProps & DefaultPresetPluginOptions): Preset<EditorPlugin, []>[];
-export declare function EditorPresetDefault(props: EditorPresetDefaultProps & EditorPresetProps & DefaultPresetPluginOptions): JSX.Element;
-export {};
+export declare function createDefaultPreset(options: EditorPresetProps & DefaultPresetPluginOptions): EditorPresetBuilder<[...string[], "hyperlink", "textFormatting", "width", "quickInsert", "typeAhead", "unsupportedContent", "editorDisabled", "submitEditor", "fakeTextCursor", "floatingToolbar", "featureFlagsContext", "selection", "codeBlock"], [(config: CodeBlockOptions, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"codeBlock", {
+    pluginConfiguration: CodeBlockOptions;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"codeBlock", {
+    pluginConfiguration: CodeBlockOptions;
+}>, (config?: SelectionPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"selection", {
+    pluginConfiguration: SelectionPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"selection", {
+    pluginConfiguration: SelectionPluginOptions | undefined;
+}>, (config: import("@atlaskit/editor-common/types").FeatureFlags, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"featureFlagsContext", {
+    pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"featureFlagsContext", {
+    pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"floatingToolbar", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"floatingToolbar", {}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"fakeTextCursor", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"fakeTextCursor", {}>, (config?: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"submitEditor", {
+    pluginConfiguration: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"submitEditor", {
+    pluginConfiguration: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"editorDisabled", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"editorDisabled", {}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"unsupportedContent", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"unsupportedContent", {}>, (config?: TypeAheadPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"typeAhead", {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"typeAhead", {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+}>, (config?: QuickInsertPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"quickInsert", {
+    pluginConfiguration: QuickInsertPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"quickInsert", {
+    pluginConfiguration: QuickInsertPluginOptions | undefined;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"width", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"width", {}>, (config?: TextFormattingOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"textFormatting", {
+    pluginConfiguration: TextFormattingOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"textFormatting", {
+    pluginConfiguration: TextFormattingOptions | undefined;
+}>, (config?: HyperlinkPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"hyperlink", {
+    pluginConfiguration: HyperlinkPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"hyperlink", {
+    pluginConfiguration: HyperlinkPluginOptions | undefined;
+}>, ...import("@atlaskit/editor-common/types").AllEditorPresetPluginTypes[]]>;
+export declare function useDefaultPreset(props: EditorPresetProps & DefaultPresetPluginOptions): EditorPresetBuilder<[...string[], "hyperlink", "textFormatting", "width", "quickInsert", "typeAhead", "unsupportedContent", "editorDisabled", "submitEditor", "fakeTextCursor", "floatingToolbar", "featureFlagsContext", "selection", "codeBlock"], [(config: CodeBlockOptions, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"codeBlock", {
+    pluginConfiguration: CodeBlockOptions;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"codeBlock", {
+    pluginConfiguration: CodeBlockOptions;
+}>, (config?: SelectionPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"selection", {
+    pluginConfiguration: SelectionPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"selection", {
+    pluginConfiguration: SelectionPluginOptions | undefined;
+}>, (config: import("@atlaskit/editor-common/types").FeatureFlags, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"featureFlagsContext", {
+    pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"featureFlagsContext", {
+    pluginConfiguration: import("@atlaskit/editor-common/types").FeatureFlags;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"floatingToolbar", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"floatingToolbar", {}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"fakeTextCursor", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"fakeTextCursor", {}>, (config?: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"submitEditor", {
+    pluginConfiguration: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"submitEditor", {
+    pluginConfiguration: ((editorView: import("prosemirror-view").EditorView<any>) => void) | undefined;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"editorDisabled", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"editorDisabled", {}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"unsupportedContent", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"unsupportedContent", {}>, (config?: TypeAheadPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"typeAhead", {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"typeAhead", {
+    pluginConfiguration: TypeAheadPluginOptions | undefined;
+}>, (config?: QuickInsertPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"quickInsert", {
+    pluginConfiguration: QuickInsertPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"quickInsert", {
+    pluginConfiguration: QuickInsertPluginOptions | undefined;
+}>, (config?: undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"width", {}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"width", {}>, (config?: TextFormattingOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"textFormatting", {
+    pluginConfiguration: TextFormattingOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"textFormatting", {
+    pluginConfiguration: TextFormattingOptions | undefined;
+}>, (config?: HyperlinkPluginOptions | undefined, api?: import("@atlaskit/editor-common/types").PluginInjectionAPI<"hyperlink", {
+    pluginConfiguration: HyperlinkPluginOptions | undefined;
+}> | undefined) => import("@atlaskit/editor-common/types").DefaultEditorPlugin<"hyperlink", {
+    pluginConfiguration: HyperlinkPluginOptions | undefined;
+}>, ...import("@atlaskit/editor-common/types").AllEditorPresetPluginTypes[]]>[];