@atlaskit/editor-core 183.0.9 → 183.1.0

package/dist/types-ts4.5/commands/index.d.ts

@@ -0,0 +1,23 @@
+import { Node as PMNode, NodeType, MarkType, Schema } from 'prosemirror-model';
+import { EditorState, Transaction } from 'prosemirror-state';
+import { Command } from '../types';
+import { AlignmentState } from '../plugins/alignment/pm-plugins/types';
+export declare function preventDefault(): Command;
+export declare function insertNewLine(): Command;
+export declare const insertNewLineWithAnalytics: Command;
+export declare const createNewParagraphAbove: Command;
+export declare const createNewParagraphBelow: Command;
+export declare function createParagraphNear(append?: boolean): Command;
+export declare function addParagraphAtEnd(tr: Transaction): void;
+export declare function createParagraphAtEnd(): Command;
+export declare const changeImageAlignment: (align?: AlignmentState) => Command;
+export declare const createToggleBlockMarkOnRange: <T extends {} = object>(markType: MarkType, getAttrs: (prevAttrs?: T | undefined, node?: PMNode) => false | T | undefined, allowedBlocks?: NodeType<any>[] | ((schema: Schema, node: PMNode, parent: PMNode) => boolean) | undefined) => (from: number, to: number, tr: Transaction, state: EditorState) => boolean;
+/**
+ * Toggles block mark based on the return type of `getAttrs`.
+ * This is similar to ProseMirror's `getAttrs` from `AttributeSpec`
+ * return `false` to remove the mark.
+ * return `undefined for no-op.
+ * return an `object` to update the mark.
+ */
+export declare const toggleBlockMark: <T extends {} = object>(markType: MarkType, getAttrs: (prevAttrs?: T | undefined, node?: PMNode) => false | T | undefined, allowedBlocks?: NodeType<any>[] | ((schema: Schema, node: PMNode, parent: PMNode) => boolean) | undefined) => Command;
+export declare const clearEditorContent: Command;

package/dist/types-ts4.5/create-editor/ErrorBoundary.d.ts

@@ -0,0 +1,44 @@
+import { EditorView } from 'prosemirror-view';
+import React from 'react';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import type { UserBrowserExtensionResults } from '@atlaskit/editor-common/utils';
+import { FeatureFlags } from '../types/feature-flags';
+export type ErrorBoundaryProps = {
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+    contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
+    editorView?: EditorView;
+    rethrow?: boolean;
+    children: React.ReactNode;
+    featureFlags: FeatureFlags;
+    errorTracking?: boolean;
+};
+export type ErrorBoundaryState = {
+    error?: Error;
+};
+type AnalyticsErrorBoundaryErrorInfo = {
+    componentStack: string;
+};
+export declare class ErrorBoundaryWithEditorView extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    featureFlags: FeatureFlags;
+    browserExtensions?: UserBrowserExtensionResults;
+    experienceStore?: ExperienceStore;
+    static defaultProps: {
+        rethrow: boolean;
+        errorTracking: boolean;
+    };
+    state: {
+        error: undefined;
+    };
+    constructor(props: ErrorBoundaryProps);
+    private sendErrorData;
+    private getProductName;
+    private fireAnalyticsEvent;
+    private getExperienceMetadata;
+    componentDidCatch(error: Error, errorInfo: AnalyticsErrorBoundaryErrorInfo): void;
+    componentDidMount(): Promise<void>;
+    render(): JSX.Element;
+}
+declare const _default: React.ComponentType<Omit<ErrorBoundaryProps, "editorView">>;
+export default _default;

package/dist/types-ts4.5/create-editor/ReactEditorView.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { ReactEditorView as BaseReactEditorView } from './ReactEditorViewInternal';
+export declare class ReactEditorView<T = {}> extends BaseReactEditorView<T> {
+}
+declare const _default: import("react").FC<import("react-intl-next").WithIntlProps<import("./ReactEditorViewInternal").EditorViewProps & import("react-intl-next").WrappedComponentProps<"intl">>> & {
+    WrappedComponent: import("react").ComponentType<import("./ReactEditorViewInternal").EditorViewProps & import("react-intl-next").WrappedComponentProps<"intl">>;
+};
+export default _default;

package/dist/types-ts4.5/create-editor/ReactEditorViewContext.d.ts

@@ -0,0 +1,2 @@
+import { ReactEditorViewContext } from '@atlaskit/editor-common/ui-react';
+export default ReactEditorViewContext;

package/dist/types-ts4.5/create-editor/ReactEditorViewInternal.d.ts

@@ -0,0 +1,116 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { EditorState } from 'prosemirror-state';
+import { DirectEditorProps, EditorView } from 'prosemirror-view';
+import { Node as PMNode } from 'prosemirror-model';
+import { WrappedComponentProps } from 'react-intl-next';
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { ErrorReporter } from '@atlaskit/editor-common/utils';
+import { ExperienceStore } from '@atlaskit/editor-common/ufo';
+import { Transformer, AllEditorPresetPluginTypes } from '@atlaskit/editor-common/types';
+import { Dispatch, EventDispatcher } from '../event-dispatcher';
+import { AnalyticsEventPayload, DispatchAnalyticsEvent, FULL_WIDTH_MODE } from '@atlaskit/editor-common/analytics';
+import { EditorAppearance, EditorConfig, EditorReactContext, EditorPlugin, EditorProps } from '../types';
+import type { EditorNextProps } from '../types/editor-props';
+import { PortalProviderAPI } from '../ui/PortalProvider';
+import { SEVERITY } from '@atlaskit/editor-common/utils';
+import { TransactionTracker } from '../utils/performance/track-transactions';
+import type { FireAnalyticsCallback } from '@atlaskit/editor-common/analytics';
+import { EditorPresetBuilder } from '@atlaskit/editor-common/preset';
+export interface EditorViewProps {
+    editorProps: EditorProps | EditorNextProps;
+    createAnalyticsEvent?: CreateUIAnalyticsEvent;
+    providerFactory: ProviderFactory;
+    portalProviderAPI: PortalProviderAPI;
+    allowAnalyticsGASV3?: boolean;
+    disabled?: boolean;
+    experienceStore?: ExperienceStore;
+    render?: (props: {
+        editor: JSX.Element;
+        view?: EditorView;
+        config: EditorConfig;
+        eventDispatcher: EventDispatcher;
+        transformer?: Transformer<string>;
+        dispatchAnalyticsEvent: DispatchAnalyticsEvent;
+        editorRef: React.RefObject<HTMLDivElement>;
+    }) => JSX.Element;
+    onEditorCreated: (instance: {
+        view: EditorView;
+        config: EditorConfig;
+        eventDispatcher: EventDispatcher;
+        transformer?: Transformer<string>;
+    }) => void;
+    onEditorDestroyed: (instance: {
+        view: EditorView;
+        config: EditorConfig;
+        eventDispatcher: EventDispatcher;
+        transformer?: Transformer<string>;
+    }) => void;
+    preset: EditorPresetBuilder<string[], AllEditorPresetPluginTypes[]>;
+}
+interface CreateEditorStateOptions {
+    props: EditorViewProps;
+    context: EditorReactContext;
+    doc?: string | Object | PMNode;
+    resetting?: boolean;
+    selectionAtStart?: boolean;
+}
+export declare const EDIT_AREA_ID = "ak-editor-textarea";
+export declare class ReactEditorView<T = {}> extends React.Component<EditorViewProps & WrappedComponentProps & T, {}, EditorReactContext> {
+    view?: EditorView;
+    eventDispatcher: EventDispatcher;
+    contentTransformer?: Transformer<string>;
+    config: EditorConfig;
+    editorState: EditorState;
+    errorReporter: ErrorReporter;
+    dispatch: Dispatch;
+    proseMirrorRenderedSeverity?: SEVERITY;
+    transactionTracker: TransactionTracker;
+    validTransactionCount: number;
+    experienceStore?: ExperienceStore;
+    editorRef: React.RefObject<HTMLDivElement>;
+    static contextTypes: {
+        getAtlaskitAnalyticsEventHandlers: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    private canDispatchTransactions;
+    private focusTimeoutId?;
+    private reliabilityInterval?;
+    private pluginPerformanceObserver;
+    private featureFlags;
+    private pluginInjectionAPI;
+    private onPluginObservation;
+    get transactionTracking(): import("@atlaskit/editor-common/types").TransactionTracking;
+    private getPluginNames;
+    private countNodes;
+    private isTransactionTrackingExplicitlyDisabled;
+    constructor(props: EditorViewProps & WrappedComponentProps & T, context: EditorReactContext);
+    getEditorState: () => EditorState<any> | undefined;
+    UNSAFE_componentWillReceiveProps(nextProps: EditorViewProps): void;
+    formatFullWidthAppearance: (appearance: EditorAppearance | undefined) => FULL_WIDTH_MODE;
+    resetEditorState: ({ doc, shouldScrollToBottom, }: {
+        doc: string;
+        shouldScrollToBottom: boolean;
+    }) => void;
+    blur: () => void;
+    reconfigureState(props: EditorViewProps): void;
+    handleAnalyticsEvent: FireAnalyticsCallback;
+    componentDidMount(): void;
+    /**
+     * Clean up any non-PM resources when the editor is unmounted
+     */
+    componentWillUnmount(): void;
+    private editorPlugins;
+    getPlugins(preset: EditorPresetBuilder<string[], AllEditorPresetPluginTypes[]>): EditorPlugin[];
+    createEditorState: (options: CreateEditorStateOptions) => EditorState<any>;
+    private onEditorViewStateUpdated;
+    private trackValidTransactions;
+    private dispatchTransaction;
+    getDirectEditorProps: (state?: EditorState) => DirectEditorProps;
+    private createEditorView;
+    handleEditorViewRef: (node: HTMLDivElement) => void;
+    dispatchAnalyticsEvent: (payload: AnalyticsEventPayload) => void;
+    private editor;
+    render(): JSX.Element;
+}
+export {};

package/dist/types-ts4.5/create-editor/ReactEditorViewNext.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { EditorViewProps } from './ReactEditorViewInternal';
+import { WrappedComponentProps } from 'react-intl-next';
+export declare function ReactEditorViewEditor<T = {}>(props: EditorViewProps & WrappedComponentProps & T): JSX.Element;
+declare const _default: React.FC<import("react-intl-next").WithIntlProps<EditorViewProps & WrappedComponentProps<"intl">>> & {
+    WrappedComponent: React.ComponentType<EditorViewProps & WrappedComponentProps<"intl">>;
+};
+export default _default;

package/dist/types-ts4.5/create-editor/WithEditorView.d.ts

@@ -0,0 +1,6 @@
+import React, { ComponentType } from 'react';
+import { EditorView } from 'prosemirror-view';
+export interface WithEditorViewInternalProps {
+    editorView?: EditorView | undefined;
+}
+export declare const WithEditorView: <P extends WithEditorViewInternalProps>(WrappedComponent: React.ComponentType<P>) => React.ComponentType<Omit<P, "editorView">>;

package/dist/types-ts4.5/create-editor/consts.d.ts

@@ -0,0 +1,3 @@
+export declare const PROSEMIRROR_RENDERED_NORMAL_SEVERITY_THRESHOLD = 2000;
+export declare const PROSEMIRROR_RENDERED_DEGRADED_SEVERITY_THRESHOLD = 3000;
+export declare const DEFAULT_SAMPLING_RATE_VALID_TRANSACTIONS = 100;

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

@@ -0,0 +1,18 @@
+import { MarkSpec } from 'prosemirror-model';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { ErrorReporter } from '@atlaskit/editor-common/utils';
+import type { ErrorReportingHandler } from '@atlaskit/editor-common/utils';
+import { EditorConfig, EditorPlugin, PMPluginCreateConfig } from '../types';
+export declare function sortByRank(a: {
+    rank: number;
+}, b: {
+    rank: number;
+}): number;
+export declare function fixExcludes(marks: {
+    [key: string]: MarkSpec;
+}): {
+    [key: string]: MarkSpec;
+};
+export declare function processPluginsList(plugins: EditorPlugin[]): EditorConfig;
+export declare function createPMPlugins(config: PMPluginCreateConfig): SafePlugin[];
+export declare function createErrorReporter(errorReporterHandler?: ErrorReportingHandler): ErrorReporter;

package/dist/types-ts4.5/create-editor/create-plugins-list.d.ts

@@ -0,0 +1,17 @@
+import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { EditorPlugin, EditorProps } from '../types';
+import { EditorPluginFeatureProps } from '../types/editor-props';
+import { ScrollGutterPluginOptions } from '../plugins/base/pm-plugins/scroll-gutter';
+import { DefaultPresetPluginOptions } from '../labs/next/presets/default';
+import { EditorPresetProps } from '../labs/next/presets/types';
+import type { EditorPresetBuilder } from '@atlaskit/editor-common/preset';
+export declare function getScrollGutterOptions(props: EditorProps): ScrollGutterPluginOptions | undefined;
+export declare function getDefaultPresetOptionsFromEditorProps(props: EditorProps, createAnalyticsEvent?: CreateUIAnalyticsEvent): EditorPresetProps & DefaultPresetPluginOptions & EditorPluginFeatureProps;
+/**
+ * Maps EditorProps to EditorPlugins
+ *
+ * Note: The order that presets are added determines
+ * their placement in the editor toolbar
+ */
+export default function createPluginsList(props: EditorProps, prevProps?: EditorProps, createAnalyticsEvent?: CreateUIAnalyticsEvent): EditorPlugin[];
+export declare function createPreset(props: EditorProps, prevProps?: EditorProps, createAnalyticsEvent?: CreateUIAnalyticsEvent): EditorPresetBuilder<any, any>;

package/dist/types-ts4.5/create-editor/create-schema.d.ts

@@ -0,0 +1,6 @@
+import { Schema } from 'prosemirror-model';
+import { MarkConfig, NodeConfig } from '../types/pm-config';
+export declare function createSchema(editorConfig: {
+    marks: MarkConfig[];
+    nodes: NodeConfig[];
+}): Schema<string, string>;

package/dist/types-ts4.5/create-editor/feature-flags-from-props.d.ts

@@ -0,0 +1,7 @@
+import { EditorProps } from '../types';
+import type { FeatureFlags } from '../types/feature-flags';
+/**
+ * Transforms EditorProps to an FeatureFlags object,
+ * which is used by both current and archv3 editors.
+ */
+export declare function createFeatureFlagsFromProps(props: EditorProps): FeatureFlags;

package/dist/types-ts4.5/create-editor/get-plugins.d.ts

@@ -0,0 +1,41 @@
+import { Schema } from 'prosemirror-model';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { Transaction, EditorState } from 'prosemirror-state';
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { EventDispatcher, Dispatch } from '../event-dispatcher';
+import { MarkConfig, NodeConfig } from '../types/pm-config';
+import { EditorReactContext } from '../types/editor-react-context';
+import { FeatureFlags } from '../types/feature-flags';
+import { IntlShape } from 'react-intl-next';
+export type LightPMPluginFactoryParams = {
+    schema: Schema;
+    dispatch: Dispatch;
+    eventDispatcher: EventDispatcher;
+    providerFactory: ProviderFactory;
+    props: {};
+    prevProps?: {};
+    portalProviderAPI: any;
+    reactContext: () => EditorReactContext;
+    dispatchAnalyticsEvent: any;
+    featureFlags: FeatureFlags;
+    getIntl: () => IntlShape;
+};
+export type LightPMPluginFactory = (params: LightPMPluginFactoryParams) => SafePlugin | undefined;
+export type LightPMPlugin = {
+    name: string;
+    plugin: LightPMPluginFactory;
+};
+export type OnEditorViewStateUpdated = (props: {
+    readonly originalTransaction: Readonly<Transaction>;
+    readonly transactions: Transaction[];
+    readonly oldEditorState: Readonly<EditorState>;
+    readonly newEditorState: Readonly<EditorState>;
+}) => void;
+export interface LightEditorPlugin {
+    name: string;
+    marks?: () => MarkConfig[];
+    nodes?: () => NodeConfig[];
+    pmPlugins?: (pluginOptions?: any) => Array<LightPMPlugin>;
+    pluginsOptions?: Record<string, any>;
+    onEditorViewStateUpdated?: OnEditorViewStateUpdated;
+}

package/dist/types-ts4.5/create-editor/get-ui-component.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { EditorAppearance, EditorAppearanceComponentProps } from '../types';
+export default function getUiComponent(appearance: EditorAppearance): React.ComponentClass<EditorAppearanceComponentProps> | React.FunctionComponent<EditorAppearanceComponentProps>;

package/dist/types-ts4.5/create-editor/index.d.ts

@@ -0,0 +1,3 @@
+export { default as ReactEditorView, ReactEditorView as BaseReactEditorView, } from './ReactEditorView';
+export { default as getUiComponent } from './get-ui-component';
+export { default as createPluginsList, getDefaultPresetOptionsFromEditorProps, } from './create-plugins-list';

package/dist/types-ts4.5/create-editor/messages.d.ts

@@ -0,0 +1,7 @@
+export declare const editorMessages: {
+    editorAssistiveLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/create-editor/preset-utils.d.ts

@@ -0,0 +1,2 @@
+import type { EditorProps } from '../types/editor-props';
+export declare function shouldRecreatePreset(props: EditorProps, nextProps: EditorProps): boolean;

package/dist/types-ts4.5/create-editor/sort-by-order.d.ts

@@ -0,0 +1,14 @@
+export declare function sortByOrder(item: 'plugins' | 'nodes' | 'marks'): (a: {
+    name: string;
+}, b: {
+    name: string;
+}) => number;
+export declare function sortByOrderWithTypeName(item: 'plugins' | 'nodes' | 'marks'): (a: {
+    type: {
+        name: string;
+    };
+}, b: {
+    type: {
+        name: string;
+    };
+}) => number;

package/dist/types-ts4.5/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-ts4.5/editor-next/editor-migration-component.d.ts

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

package/dist/types-ts4.5/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-ts4.5/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-ts4.5/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 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-ts4.5/editor-next/index.d.ts

@@ -0,0 +1,35 @@
+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 getFeatureFlags;
+    private unregisterEditorFromActions;
+    private getExperienceStore;
+    render(): jsx.JSX.Element;
+}

package/dist/types-ts4.5/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-ts4.5/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-ts4.5/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 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-ts4.5/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-ts4.5/editor-next/utils/getProvidersFromEditorProps.d.ts

@@ -0,0 +1,9 @@
+import { Providers } from '@atlaskit/editor-common/provider-factory';
+import { EditorProps } from '../../types/editor-props';
+type Complete<T> = {
+    [P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>> ? T[P] : T[P] | undefined;
+};
+type EditorProviderProps = Pick<EditorProps, 'linking' | 'smartLinks' | 'UNSAFE_cards' | 'autoformattingProvider' | 'media' | 'emojiProvider' | 'mentionProvider' | 'taskDecisionProvider' | 'contextIdentifierProvider' | 'searchProvider' | 'macroProvider' | 'activityProvider' | 'collabEdit' | 'collabEditProvider' | 'presenceProvider' | 'legacyImageUploadProvider'>;
+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-ts4.5/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-ts4.5/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-ts4.5/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-ts4.5/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;
+};