@atlaskit/editor-core 185.1.2 → 185.1.3

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

@@ -7,7 +7,7 @@ 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';
-import { UIComponentFactory } from '@atlaskit/editor-common/types';
+import type { UIComponentFactory, ReactHookFactory } from '@atlaskit/editor-common/types';
 export type LightPMPluginFactoryParams = {
     schema: Schema;
     dispatch: Dispatch;
@@ -38,6 +38,7 @@ export interface LightEditorPlugin {
     nodes?: () => NodeConfig[];
     pmPlugins?: (pluginOptions?: any) => Array<LightPMPlugin>;
     contentComponent?: UIComponentFactory;
+    usePluginHook?: ReactHookFactory;
     pluginsOptions?: Record<string, any>;
     onEditorViewStateUpdated?: OnEditorViewStateUpdated;
 }

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

@@ -8,12 +8,13 @@ export type { LightEditorPlugin } from './create-editor/get-plugins';
 export type { DispatchAnalyticsEvent } from './plugins/analytics/types';
 export type { FeatureFlags } from './types/feature-flags';
 import { EditorPresetBuilder, type EditorPluginInjectionAPI } from '@atlaskit/editor-common/preset';
-import type { AllEditorPresetPluginTypes, UIComponentFactory } from '@atlaskit/editor-common/types';
+import type { AllEditorPresetPluginTypes, UIComponentFactory, ReactHookFactory } from '@atlaskit/editor-common/types';
 export interface LightEditorConfig {
     nodes: NodeConfig[];
     marks: MarkConfig[];
     plugins: Array<LightPMPlugin>;
     contentComponents: UIComponentFactory[];
+    pluginHooks: ReactHookFactory[];
     onEditorViewStateUpdatedCallbacks: Array<OnEditorViewStateUpdated>;
 }
 export declare function getFireAnalytics(editorView: EditorView): any;

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

@@ -8,11 +8,12 @@ import { UIComponentFactory } from '../types/ui-components';
 import { ReactComponents, PrimaryToolbarComponents, UseStickyToolbarType } from '../types/editor-props';
 import { ToolbarUIComponentFactory } from '../ui/Toolbar/types';
 import { CollabEditOptions } from '../plugins/collab-edit/types';
-import { DispatchAnalyticsEvent } from '../plugins/analytics';
+import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
 import { EditorAppearance } from './editor-appearance';
 import { MenuItem } from '../ui/DropdownMenu/types';
 import { ReactElement } from 'react';
 import { FeatureFlags } from './feature-flags';
+import type { ReactHookFactory } from '@atlaskit/editor-common/types';
 export interface EditorAppearanceComponentProps {
     appearance?: EditorAppearance;
     onSave?: (editorView: EditorView) => void;
@@ -26,6 +27,7 @@ export interface EditorAppearanceComponentProps {
     maxHeight?: number;
     minHeight?: number;
     contentComponents?: UIComponentFactory[];
+    pluginHooks?: ReactHookFactory[];
     primaryToolbarComponents?: ToolbarUIComponentFactory[];
     primaryToolbarIconBefore?: ReactElement;
     secondaryToolbarComponents?: UIComponentFactory[];

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

@@ -2,7 +2,7 @@ import { ToolbarUIComponentFactory } from '../ui/Toolbar/types';
 import { Transaction, EditorState } from 'prosemirror-state';
 import { PMPlugin } from './pm-plugin';
 import { MarkConfig, NodeConfig } from './pm-config';
-import { UIComponentFactory } from './ui-components';
+import type { UIComponentFactory, ReactHookFactory } from '@atlaskit/editor-common/types';
 type EditorViewStateUpdatedCallbackProps = {
     readonly originalTransaction: Readonly<Transaction>;
     readonly transactions: Transaction[];
@@ -14,6 +14,7 @@ export interface EditorConfig {
     marks: MarkConfig[];
     pmPlugins: Array<PMPlugin>;
     contentComponents: UIComponentFactory[];
+    pluginHooks: ReactHookFactory[];
     primaryToolbarComponents: ToolbarUIComponentFactory[];
     secondaryToolbarComponents: UIComponentFactory[];
     onEditorViewStateUpdatedCallbacks: Array<{

package/dist/types-ts4.5/ui/Appearance/FullPage/FullPageContentArea.d.ts

@@ -5,11 +5,13 @@ import { WrappedComponentProps } from 'react-intl-next';
 import EditorActions from '../../../actions';
 import { EventDispatcher } from '../../../event-dispatcher';
 import { ReactComponents, EditorAppearance, UIComponentFactory } from '../../../types';
-import { DispatchAnalyticsEvent } from '../../../plugins/analytics';
+import { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
+import type { ReactHookFactory } from '@atlaskit/editor-common/types';
 interface FullPageEditorContentAreaProps {
     appearance: EditorAppearance | undefined;
     contentArea: HTMLElement | undefined;
     contentComponents: UIComponentFactory[] | undefined;
+    pluginHooks: ReactHookFactory[] | undefined;
     contextPanel: ReactComponents | undefined;
     customContentComponents: ReactComponents | undefined;
     disabled: boolean | undefined;

package/dist/types-ts4.5/ui/Appearance/Mobile.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { EditorAppearanceComponentProps } from '../../types';
-export default function Mobile({ editorView, maxHeight, persistScrollGutter, editorDOMElement, disabled, }: EditorAppearanceComponentProps): JSX.Element;
+export default function Mobile({ editorView, maxHeight, persistScrollGutter, editorDOMElement, disabled, contentComponents, editorActions, eventDispatcher, dispatchAnalyticsEvent, providerFactory, appearance, popupsMountPoint, popupsBoundariesElement, popupsScrollableElement, innerRef, pluginHooks, }: EditorAppearanceComponentProps): JSX.Element;

package/dist/types-ts4.5/ui/AppearanceComponents/Mobile.d.ts

@@ -1,12 +1,12 @@
 /** @jsx jsx */
 import React from 'react';
-import { jsx } from '@emotion/react';
 import { EditorView } from 'prosemirror-view';
-type MobileAppearanceProps = React.PropsWithChildren<{
+export declare const MobileAppearance: React.ForwardRefExoticComponent<{
     editorView: EditorView | null;
-    maxHeight?: number;
-    persistScrollGutter?: boolean;
-    editorDisabled?: boolean;
-}>;
-export declare function MobileAppearance({ editorView, persistScrollGutter, children, editorDisabled, }: MobileAppearanceProps): jsx.JSX.Element;
-export {};
+    maxHeight?: number | undefined;
+    persistScrollGutter?: boolean | undefined;
+    editorDisabled?: boolean | undefined;
+    children?: React.ReactNode;
+} & {
+    children?: React.ReactNode;
+} & React.RefAttributes<HTMLDivElement>>;

package/dist/types-ts4.5/ui/ContextPanel/index.d.ts

@@ -10,6 +10,7 @@ export type Props = {
 };
 type EditorWidth = WidthPluginState & {
     contentBreakoutModes: BreakoutMarkAttrs['mode'][];
+    containerWidth?: number;
 };
 export declare const shouldPanelBePositionedOverEditor: (editorWidth: EditorWidth, panelWidth: number) => boolean;
 export declare const panel: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.5/ui/PluginSlot/index.d.ts

@@ -6,9 +6,11 @@ import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { EditorAppearance, UIComponentFactory } from '../../types';
 import { EventDispatcher } from '../../event-dispatcher';
 import EditorActions from '../../actions';
-import { DispatchAnalyticsEvent } from '../../plugins/analytics';
+import { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
+import type { ReactHookFactory } from '@atlaskit/editor-common/types';
 export interface Props {
     items?: UIComponentFactory[];
+    pluginHooks?: ReactHookFactory[];
     editorView?: EditorView;
     editorActions?: EditorActions;
     eventDispatcher?: EventDispatcher;

package/dist/types-ts4.5/ui/PluginSlot/mount-plugin-hooks.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import type { ReactHookFactory } from '@atlaskit/editor-common/types';
+import { EditorView } from 'prosemirror-view';
+interface MountPluginHooksProps {
+    editorView: EditorView | undefined;
+    pluginHooks: ReactHookFactory[] | undefined;
+    containerElement: HTMLElement | null;
+}
+export declare function MountPluginHooks({ pluginHooks, editorView, containerElement, }: MountPluginHooksProps): JSX.Element | null;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "185.1.2",
+  "version": "185.1.3",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -49,7 +49,7 @@
     "@atlaskit/code": "^14.6.0",
     "@atlaskit/date": "^0.10.0",
     "@atlaskit/datetime-picker": "^12.7.0",
-    "@atlaskit/editor-common": "^74.4.0",
+    "@atlaskit/editor-common": "^74.5.0",
     "@atlaskit/editor-json-transformer": "^8.9.0",
     "@atlaskit/editor-markdown-transformer": "^5.2.0",
     "@atlaskit/editor-palette": "1.4.2",
@@ -59,7 +59,7 @@
     "@atlaskit/editor-plugin-feature-flags": "^0.1.0",
     "@atlaskit/editor-plugin-grid": "^0.1.0",
     "@atlaskit/editor-plugin-table": "^1.5.0",
-    "@atlaskit/editor-plugin-width": "^0.0.1",
+    "@atlaskit/editor-plugin-width": "^0.1.0",
     "@atlaskit/editor-shared-styles": "^2.4.0",
     "@atlaskit/editor-tables": "^2.3.0",
     "@atlaskit/emoji": "^67.4.0",

package/report.api.md

@@ -131,6 +131,7 @@ import { QuickInsertItemId } from '@atlaskit/editor-common/provider-factory';
 import { QuickInsertProvider } from '@atlaskit/editor-common/provider-factory';
 import { default as React_2 } from 'react';
 import { ReactElement } from 'react';
+import type { ReactHookFactory } from '@atlaskit/editor-common/types';
 import { RefObject } from 'react';
 import { ReplaceRawValue } from '@atlaskit/editor-common/types';
 import type { ResolvedEditorState } from '@atlaskit/collab-provider';
@@ -745,6 +746,8 @@ interface EditorConfig {
     callback: (props: EditorViewStateUpdatedCallbackProps) => void;
   }>;
   // (undocumented)
+  pluginHooks: ReactHookFactory[];
+  // (undocumented)
   pmPlugins: Array<PMPlugin>;
   // (undocumented)
   primaryToolbarComponents: ToolbarUIComponentFactory[];

package/tmp/api-report-tmp.d.ts

@@ -120,6 +120,7 @@ import { QuickInsertItemId } from '@atlaskit/editor-common/provider-factory';
 import { QuickInsertProvider } from '@atlaskit/editor-common/provider-factory';
 import { default as React_2 } from 'react';
 import { ReactElement } from 'react';
+import type { ReactHookFactory } from '@atlaskit/editor-common/types';
 import { RefObject } from 'react';
 import { ReplaceRawValue } from '@atlaskit/editor-common/types';
 import type { ResolvedEditorState } from '@atlaskit/collab-provider';
@@ -678,6 +679,8 @@ interface EditorConfig {
         callback: (props: EditorViewStateUpdatedCallbackProps) => void;
     }>;
     // (undocumented)
+    pluginHooks: ReactHookFactory[];
+    // (undocumented)
     pmPlugins: Array<PMPlugin>;
     // (undocumented)
     primaryToolbarComponents: ToolbarUIComponentFactory[];

package/dist/cjs/ui/WidthEmitter/index.js

@@ -1,64 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _typeof = require("@babel/runtime/helpers/typeof");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _react = _interopRequireWildcard(require("react"));
-var _ui = require("@atlaskit/editor-common/ui");
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-// TODO: ED-17870 This workaround will be removed here.
-// @ts-ignore
-var widthPluginKey = {
-  key: 'widthPlugin$',
-  getState: function getState(state) {
-    return state['widthPlugin$'];
-  }
-};
-// Why do we need this? Why not just use the width from the context directly rather than this?
-// Well my friend - some of the VR tests break, seemingly due to the fact that existing behaviour
-// assumes the initial value is 0, the width from context may not start from 0 however.
-// We should investigate further if we can remove this entirely but for now we'll do this
-// awkward workaround to keep the behaviour consistent.
-var useListener = function useListener(contextValue) {
-  var _useState = (0, _react.useState)(0),
-    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-    value = _useState2[0],
-    setValue = _useState2[1];
-  (0, _react.useEffect)(function () {
-    setValue(contextValue);
-  }, [contextValue]);
-  return value;
-};
-var WidthEmitter = function WidthEmitter(_ref) {
-  var editorView = _ref.editorView;
-  var _useContext = (0, _react.useContext)(_ui.ContextPanel),
-    contextPanelWidthContext = _useContext.width;
-  var _useContext2 = (0, _react.useContext)(_ui.WidthContext),
-    containerWidthContext = _useContext2.width;
-  var containerWidth = useListener(containerWidthContext);
-  var contextPanelWidth = useListener(contextPanelWidthContext);
-  (0, _react.useEffect)(function () {
-    var width = containerWidth - contextPanelWidth;
-    if (width <= 0 || isNaN(width) || !editorView) {
-      return;
-    }
-    var dom = editorView.dom,
-      tr = editorView.state.tr,
-      dispatch = editorView.dispatch;
-    tr.setMeta(widthPluginKey, {
-      width: width,
-      containerWidth: containerWidth,
-      lineLength: dom ? dom.clientWidth : undefined
-    });
-    dispatch(tr);
-    return function () {};
-  }, [editorView, contextPanelWidth, containerWidth]);
-  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null);
-};
-var _default = WidthEmitter;
-exports.default = _default;

package/dist/es2019/ui/WidthEmitter/index.js

@@ -1,56 +0,0 @@
-import React, { useContext, useEffect, useState } from 'react';
-import { ContextPanel, WidthContext } from '@atlaskit/editor-common/ui';
-// TODO: ED-17870 This workaround will be removed here.
-// @ts-ignore
-const widthPluginKey = {
-  key: 'widthPlugin$',
-  getState: state => {
-    return state['widthPlugin$'];
-  }
-};
-// Why do we need this? Why not just use the width from the context directly rather than this?
-// Well my friend - some of the VR tests break, seemingly due to the fact that existing behaviour
-// assumes the initial value is 0, the width from context may not start from 0 however.
-// We should investigate further if we can remove this entirely but for now we'll do this
-// awkward workaround to keep the behaviour consistent.
-const useListener = contextValue => {
-  const [value, setValue] = useState(0);
-  useEffect(() => {
-    setValue(contextValue);
-  }, [contextValue]);
-  return value;
-};
-const WidthEmitter = ({
-  editorView
-}) => {
-  const {
-    width: contextPanelWidthContext
-  } = useContext(ContextPanel);
-  const {
-    width: containerWidthContext
-  } = useContext(WidthContext);
-  const containerWidth = useListener(containerWidthContext);
-  const contextPanelWidth = useListener(contextPanelWidthContext);
-  useEffect(() => {
-    const width = containerWidth - contextPanelWidth;
-    if (width <= 0 || isNaN(width) || !editorView) {
-      return;
-    }
-    const {
-      dom,
-      state: {
-        tr
-      },
-      dispatch
-    } = editorView;
-    tr.setMeta(widthPluginKey, {
-      width,
-      containerWidth,
-      lineLength: dom ? dom.clientWidth : undefined
-    });
-    dispatch(tr);
-    return () => {};
-  }, [editorView, contextPanelWidth, containerWidth]);
-  return /*#__PURE__*/React.createElement(React.Fragment, null);
-};
-export default WidthEmitter;

package/dist/esm/ui/WidthEmitter/index.js

@@ -1,53 +0,0 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import React, { useContext, useEffect, useState } from 'react';
-import { ContextPanel, WidthContext } from '@atlaskit/editor-common/ui';
-// TODO: ED-17870 This workaround will be removed here.
-// @ts-ignore
-var widthPluginKey = {
-  key: 'widthPlugin$',
-  getState: function getState(state) {
-    return state['widthPlugin$'];
-  }
-};
-// Why do we need this? Why not just use the width from the context directly rather than this?
-// Well my friend - some of the VR tests break, seemingly due to the fact that existing behaviour
-// assumes the initial value is 0, the width from context may not start from 0 however.
-// We should investigate further if we can remove this entirely but for now we'll do this
-// awkward workaround to keep the behaviour consistent.
-var useListener = function useListener(contextValue) {
-  var _useState = useState(0),
-    _useState2 = _slicedToArray(_useState, 2),
-    value = _useState2[0],
-    setValue = _useState2[1];
-  useEffect(function () {
-    setValue(contextValue);
-  }, [contextValue]);
-  return value;
-};
-var WidthEmitter = function WidthEmitter(_ref) {
-  var editorView = _ref.editorView;
-  var _useContext = useContext(ContextPanel),
-    contextPanelWidthContext = _useContext.width;
-  var _useContext2 = useContext(WidthContext),
-    containerWidthContext = _useContext2.width;
-  var containerWidth = useListener(containerWidthContext);
-  var contextPanelWidth = useListener(contextPanelWidthContext);
-  useEffect(function () {
-    var width = containerWidth - contextPanelWidth;
-    if (width <= 0 || isNaN(width) || !editorView) {
-      return;
-    }
-    var dom = editorView.dom,
-      tr = editorView.state.tr,
-      dispatch = editorView.dispatch;
-    tr.setMeta(widthPluginKey, {
-      width: width,
-      containerWidth: containerWidth,
-      lineLength: dom ? dom.clientWidth : undefined
-    });
-    dispatch(tr);
-    return function () {};
-  }, [editorView, contextPanelWidth, containerWidth]);
-  return /*#__PURE__*/React.createElement(React.Fragment, null);
-};
-export default WidthEmitter;

package/dist/types/ui/WidthEmitter/index.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-import { EditorView } from 'prosemirror-view';
-export interface Props {
-    editorView?: EditorView;
-}
-declare const WidthEmitter: ({ editorView }: Props) => JSX.Element;
-export default WidthEmitter;

package/dist/types-ts4.5/ui/WidthEmitter/index.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-import { EditorView } from 'prosemirror-view';
-export interface Props {
-    editorView?: EditorView;
-}
-declare const WidthEmitter: ({ editorView }: Props) => JSX.Element;
-export default WidthEmitter;