@atlaskit/editor-common 78.27.1 → 78.28.1

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

@@ -1,8 +1,9 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
-import { ExtensionModuleActionHandler, ExtensionType, Icon } from './extension-manifest';
+import type { ExtensionKey, ExtensionModuleActionHandler, ExtensionType, Icon } from './extension-manifest';
 export type MenuItem = {
     key: string;
     extensionType: ExtensionType;
+    extensionKey: ExtensionKey;
     title: string;
     description?: string;
     summary?: string;

package/dist/types-ts4.5/media-single/CommentBadge.d.ts

@@ -5,8 +5,11 @@ export type CommentBadgeProps = {
     intl: IntlShape;
     width?: number;
     height?: number;
+    status?: 'default' | 'entered' | 'active';
     mediaElement?: HTMLElement | null;
     onClick: (e: React.MouseEvent) => void;
+    onMouseEnter?: (e: React.MouseEvent) => void;
+    onMouseLeave?: (e: React.MouseEvent) => void;
     isEditor?: boolean;
 };
-export declare const CommentBadge: ({ intl, width, height, mediaElement, onClick, isEditor, }: CommentBadgeProps) => jsx.JSX.Element;
+export declare const CommentBadge: ({ intl, width, height, status, mediaElement, onClick, onMouseEnter, onMouseLeave, isEditor, }: CommentBadgeProps) => jsx.JSX.Element;

package/dist/types-ts4.5/preset/core-plugin/index.d.ts

@@ -0,0 +1,6 @@
+import type { CorePlugin } from './types';
+/**
+ * Core plugin that is always included in the preset.
+ * Allows for executing `EditorCommand` and other core functionality.
+ */
+export declare const corePlugin: CorePlugin;

package/dist/types-ts4.5/preset/core-plugin/requestDocument.d.ts

@@ -0,0 +1,7 @@
+import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+import { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { Transformer } from '../../types';
+import type { InferTransformerResultCallback } from './types';
+export declare function toJSON(node: PMNode): JSONDocNode;
+export declare const scheduleDocumentRequest: <GenericTransformer extends Transformer<any> | undefined>(editorView: EditorView | null, callback: InferTransformerResultCallback<Transformer<any>>, transformer?: Transformer<any> | undefined) => void;

package/dist/types-ts4.5/preset/core-plugin/types.d.ts

@@ -0,0 +1,59 @@
+import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+import type { Schema } from '@atlaskit/editor-prosemirror/model';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { EditorCommand, NextEditorPlugin, Transformer } from '../../types';
+export type CorePlugin = NextEditorPlugin<'core', {
+    pluginConfiguration: {
+        getEditorView: () => EditorView | undefined;
+    };
+    actions: {
+        /**
+         * Dispatches an EditorCommand to ProseMirror
+         *
+         * @param command A function (EditorCommand | undefined) that takes an object containing a `Transaction` and returns a `Transaction` if it
+         * is successful or `null` if it shouldn't be dispatched.
+         * @returns (boolean) if the command was successful in dispatching
+         */
+        execute: (command: EditorCommand | undefined) => boolean;
+        /**
+         * Focuses the editor.
+         *
+         * Calls the focus method of the `EditorView` and scrolls the
+         * current selection into view.
+         *
+         * @returns (boolean) if the focus was successful
+         */
+        focus: () => boolean;
+        /**
+         * Blurs the editor.
+         *
+         * Calls blur on the editor DOM element.
+         *
+         * @returns (boolean) if the blur was successful
+         */
+        blur: () => boolean;
+        /**
+         * Request the editor document.
+         * The document will return when available. If called multiple times it will throttle and return the
+         * latest document when ready.
+         *
+         * A transformer can be created using `createTransformer`.
+         *
+         * @param onReceive Callback to handle the document. Document type based on the transformer.
+         * @param options Pass a transformer for the document to be transformed into a different format.
+         */
+        requestDocument<GenericTransformer extends Transformer<any> = Transformer<JSONDocNode>>(onReceive: (document: TransformerResult<GenericTransformer> | undefined) => void, options?: {
+            transformer?: GenericTransformer;
+        }): void;
+        /**
+         * Create a transformer
+         *
+         * @param schema Schema of the document
+         * @returns Transformer which can be used to request a document
+         */
+        createTransformer<Format>(cb: (schema: Schema) => Transformer<Format>): Transformer<Format> | undefined;
+    };
+}>;
+export type TransformerResult<GenericTransformer = Transformer<JSONDocNode>> = GenericTransformer extends Transformer<infer Content> ? Content : JSONDocNode;
+export type InferTransformerResultCallback<T extends Transformer<any> | undefined> = (doc: T extends Transformer<infer U> ? TransformerResult<U> : TransformerResult<JSONDocNode>) => void;
+export type DefaultTransformerResultCallback = (doc: TransformerResult<JSONDocNode> | undefined) => void;

package/dist/types-ts4.5/preset/plugin-injection-api.d.ts

@@ -40,8 +40,8 @@ export declare class EditorPluginInjectionAPI implements PluginInjectionAPIDefin
     private plugins;
     constructor({ getEditorState, getEditorView }: PluginInjectionAPIProps);
     api<T extends NextEditorPlugin<any, any>>(): import("../types/next-editor-plugin").PublicPluginAPI<[
-        NextEditorPlugin<T extends import("./core-plugin").CorePlugin<infer Name extends string, any, any> ? Name : never, T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never>,
-        ..."dependencies" extends keyof (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never) ? (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"] extends (import("./core-plugin").CorePlugin<any, any, any> | import("../types/next-editor-plugin").OptionalPlugin<import("./core-plugin").CorePlugin<any, any, any>>)[] ? Exclude<(T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"], undefined> : [
+        NextEditorPlugin<T extends import("../types/next-editor-plugin").NextEditorPluginFunctionOptionalConfigDefinition<infer Name extends string, any, any> ? Name : never, T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never>,
+        ..."dependencies" extends keyof (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never) ? (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"] extends (import("../types/next-editor-plugin").NextEditorPluginFunctionOptionalConfigDefinition<any, any, any> | import("../types/next-editor-plugin").OptionalPlugin<import("../types/next-editor-plugin").NextEditorPluginFunctionOptionalConfigDefinition<any, any, any>>)[] ? Exclude<(T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"], undefined> : [
         ] : [
         ]
     ]>;

package/dist/types-ts4.5/types/next-editor-plugin.d.ts

@@ -5,7 +5,7 @@
  * are put together - but for now `Builder` & `Preset` aim to beinterchangeable.
  */
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { CorePlugin } from '../preset/core-plugin';
+import type { CorePlugin } from '../preset/core-plugin/types';
 import type { EditorCommand, EditorCommandWithMetadata } from './editor-command';
 import type { EditorPlugin } from './editor-plugin';
 type IsAny<T> = 0 extends 1 & T ? true : false;
@@ -103,7 +103,7 @@ export type PluginDependenciesAPI<Plugin extends NextEditorPlugin<any, any>> = {
     commands: Plugin extends NextEditorPlugin<any, infer Metadata> ? ExtractCommandsFromMetadata<Metadata> : never;
 };
 export type CreatePluginDependenciesAPI<PluginList extends NextEditorPlugin<any, any>[]> = {
-    [Plugin in PluginList[number] as `${ExtractPluginName<Plugin>}`]: Plugin extends OptionalPlugin<NextEditorPlugin<any, any>> ? PluginDependenciesAPI<Plugin> | undefined : Plugin extends NextEditorPlugin<any, any> ? PluginDependenciesAPI<Plugin> | undefined : never;
+    [Plugin in PluginList[number] as `${ExtractPluginName<Plugin>}`]: Plugin extends OptionalPlugin<NextEditorPlugin<any, any>> ? PluginDependenciesAPI<Plugin> | undefined : Plugin extends NextEditorPlugin<'core', any> ? PluginDependenciesAPI<Plugin> : Plugin extends NextEditorPlugin<any, any> ? PluginDependenciesAPI<Plugin> | undefined : never;
 };
 export type PluginWithConfiguration<Plugin> = undefined extends ExtractPluginConfiguration<Plugin> ? [
     Plugin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "78.27.1",
+  "version": "78.28.1",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -94,7 +94,7 @@
   },
   "dependencies": {
     "@atlaskit/activity-provider": "^2.4.0",
-    "@atlaskit/adf-schema": "^35.8.0",
+    "@atlaskit/adf-schema": "^35.9.0",
     "@atlaskit/adf-utils": "^19.0.0",
     "@atlaskit/analytics-listeners": "^8.9.0",
     "@atlaskit/analytics-namespaced-context": "^6.9.0",
@@ -103,7 +103,7 @@
     "@atlaskit/button": "^17.12.0",
     "@atlaskit/code": "^15.1.0",
     "@atlaskit/codemod-utils": "^4.2.0",
-    "@atlaskit/custom-steps": "^0.0.17",
+    "@atlaskit/custom-steps": "^0.0.18",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-palette": "1.5.3",
     "@atlaskit/editor-prosemirror": "3.0.0",
@@ -129,7 +129,7 @@
     "@atlaskit/primitives": "^5.5.0",
     "@atlaskit/profilecard": "^19.11.0",
     "@atlaskit/section-message": "^6.4.0",
-    "@atlaskit/smart-card": "^26.55.0",
+    "@atlaskit/smart-card": "^26.56.0",
     "@atlaskit/smart-user-picker": "^6.9.0",
     "@atlaskit/spinner": "^16.0.0",
     "@atlaskit/task-decision": "^17.9.0",

package/dist/types/preset/core-plugin.d.ts

@@ -1,39 +0,0 @@
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { EditorCommand, NextEditorPlugin } from '../types';
-export type CorePlugin = NextEditorPlugin<'core', {
-    pluginConfiguration: {
-        getEditorView: () => EditorView | undefined;
-    };
-    actions: {
-        /**
-         * Dispatches an EditorCommand to ProseMirror
-         *
-         * @param command A function (EditorCommand | undefined) that takes an object containing a `Transaction` and returns a `Transaction` if it
-         * is successful or `null` if it shouldn't be dispatched.
-         * @returns (boolean) if the command was successful in dispatching
-         */
-        execute: (command: EditorCommand | undefined) => boolean;
-        /**
-         * Focuses the editor.
-         *
-         * Calls the focus method of the `EditorView` and scrolls the
-         * current selection into view.
-         *
-         * @returns (boolean) if the focus was successful
-         */
-        focus: () => boolean;
-        /**
-         * Blurs the editor.
-         *
-         * Calls blur on the editor DOM element.
-         *
-         * @returns (boolean) if the blur was successful
-         */
-        blur: () => boolean;
-    };
-}>;
-/**
- * Core plugin that is always included in the preset.
- * Allows for executing `EditorCommand` and other core functionality.
- */
-export declare const corePlugin: CorePlugin;

package/dist/types-ts4.5/preset/core-plugin.d.ts

@@ -1,39 +0,0 @@
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { EditorCommand, NextEditorPlugin } from '../types';
-export type CorePlugin = NextEditorPlugin<'core', {
-    pluginConfiguration: {
-        getEditorView: () => EditorView | undefined;
-    };
-    actions: {
-        /**
-         * Dispatches an EditorCommand to ProseMirror
-         *
-         * @param command A function (EditorCommand | undefined) that takes an object containing a `Transaction` and returns a `Transaction` if it
-         * is successful or `null` if it shouldn't be dispatched.
-         * @returns (boolean) if the command was successful in dispatching
-         */
-        execute: (command: EditorCommand | undefined) => boolean;
-        /**
-         * Focuses the editor.
-         *
-         * Calls the focus method of the `EditorView` and scrolls the
-         * current selection into view.
-         *
-         * @returns (boolean) if the focus was successful
-         */
-        focus: () => boolean;
-        /**
-         * Blurs the editor.
-         *
-         * Calls blur on the editor DOM element.
-         *
-         * @returns (boolean) if the blur was successful
-         */
-        blur: () => boolean;
-    };
-}>;
-/**
- * Core plugin that is always included in the preset.
- * Allows for executing `EditorCommand` and other core functionality.
- */
-export declare const corePlugin: CorePlugin;