@atlaskit/editor-common 69.2.1 → 69.3.0

package/dist/types/utils/dom.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Walks a DOM tree up to the provided `stopElement`, or if falsy before.
+ * @param element
+ * @param stopElement
+ */
+export declare function walkUpTreeUntil(element: HTMLElement, shouldStop: (element: HTMLElement) => boolean): HTMLElement;
+/**
+ * Takes all children out from wrapped el and puts them directly inside
+ * the parent el, at the wrapped el's position
+ */
+export declare function unwrap(parent: HTMLElement, wrapped: HTMLElement): void;
+/**
+ * Walks up DOM removing elements if they are empty until it finds
+ * one that is not
+ */
+export declare function removeNestedEmptyEls(el: HTMLElement): void;
+/**
+ * IE11 doesn't support classList to SVGElements
+ **/
+export declare const containsClassName: (node: HTMLElement | SVGElement | null, className: string) => boolean;
+export declare function closest(node: HTMLElement | null | undefined, s: string): HTMLElement | null;
+export declare function closestElement(node: HTMLElement | null | undefined, s: string): HTMLElement | null;
+export declare function parsePx(pxStr: string): number | undefined;
+export declare type MapCallback<T, S> = (elem: S, idx: number, parent: Element) => T;
+export declare function mapElem<T>(elem: Element, callback: MapCallback<T, Element>): Array<T>;
+export declare function maphElem<T, U extends HTMLElement>(elem: U, callback: MapCallback<T, U>): Array<T>;

package/dist/types/utils/editor-core-utils.d.ts

@@ -0,0 +1,23 @@
+import { Node, NodeType, Slice } from 'prosemirror-model';
+import { EditorState, Selection, TextSelection } from 'prosemirror-state';
+import { Step } from 'prosemirror-transform';
+import { EditorView } from 'prosemirror-view';
+export declare const stepHasSlice: (step: Step) => step is Step<any> & {
+    from: number;
+    to: number;
+    slice: Slice;
+};
+/**
+ * Checks whether a given step is adding nodes of given nodeTypes
+ *
+ * @param step Step to check
+ * @param nodeTypes NodeTypes being added
+ */
+export declare function stepAddsOneOf(step: Step, nodeTypes: Set<NodeType>): boolean;
+export declare const extractSliceFromStep: (step: Step) => Slice | null;
+export declare const isTextSelection: (selection: Selection) => selection is TextSelection<any>;
+export declare const isElementInTableCell: (element: HTMLElement | null) => HTMLElement | null;
+export declare const isLastItemMediaGroup: (node: Node) => boolean;
+export declare const setNodeSelection: (view: EditorView, pos: number) => void;
+export declare function nonNullable<T>(value: T): value is NonNullable<T>;
+export declare const isValidPosition: (pos: number, state: EditorState) => boolean;

package/dist/types/utils/getModeFromTheme.d.ts

@@ -1 +1 @@
-export declare function getModeFromTheme(theme: string): "light" | "dark";
+export declare function getModeFromTheme(theme: string): "dark" | "light";

package/dist/types/utils/index.d.ts

@@ -6,9 +6,17 @@ export { default as ErrorReporter } from './error-reporter';
 export type { ErrorReportingHandler } from './error-reporter';
 export { isPastDate, timestampToIsoFormat, timestampToString, timestampToTaskContext, timestampToUTCDate, todayTimestampInUTC, } from './date';
 export type { Date } from './date';
+export { isElementInTableCell, isTextSelection, isLastItemMediaGroup, setNodeSelection, nonNullable, stepAddsOneOf, stepHasSlice, extractSliceFromStep, isValidPosition, } from './editor-core-utils';
 export { withImageLoader } from './imageLoader';
 export type { ImageLoaderProps, ImageLoaderState, ImageStatus, } from './imageLoader';
 export { absoluteBreakoutWidth, calcBreakoutWidth, calcWideWidth, breakoutConsts, } from './breakout';
+export { findChangedNodesFromTransaction, validNode, validateNodes, isType, isParagraph, isText, isLinkMark, SelectedState, isNodeSelectedOrInRange, isSupportedInParent, } from './nodes';
+export type { Reducer } from './plugin-state-factory';
+export { pluginFactory } from './plugin-state-factory';
+export { getFragmentBackingArray, mapFragment, mapSlice, flatmap, mapChildren, } from './slice';
+export type { FlatMapCallback, MapWithCallback } from './slice';
+export { walkUpTreeUntil, unwrap, removeNestedEmptyEls, containsClassName, closest, closestElement, parsePx, mapElem, maphElem, } from './dom';
+export type { MapCallback } from './dom';
 export { default as ADFTraversor } from './traversor';
 export { analyticsEventKey, getAnalyticsAppearance, getAnalyticsEventSeverity, SEVERITY, getUnsupportedContentLevelData, UNSUPPORTED_CONTENT_LEVEL_SEVERITY, UNSUPPORTED_CONTENT_LEVEL_SEVERITY_THRESHOLD_DEFAULTS, } from './analytics';
 export type { UnsupportedContentTooltipPayload, UnsupportedContentPayload, UnsupportedContentLevelsTracking, } from './analytics';
@@ -22,6 +30,7 @@ export { getExtensionRenderer } from './extension-handler';
 export { hasMergedCell, calcTableColumnWidths, convertProsemirrorTableNodeToArrayOfRows, } from './table';
 export { createCompareNodes } from './compareNodes';
 export { compose } from './compose';
+export { isTextInput } from './is-text-input';
 export { ZERO_WIDTH_SPACE } from './whitespace';
 export type { Diff } from './types';
 export { shouldForceTracking } from './should-force-tracking';

package/dist/types/utils/is-text-input.d.ts

@@ -0,0 +1,2 @@
+import { ReadonlyTransaction, Transaction } from 'prosemirror-state';
+export declare const isTextInput: (tr: Transaction | ReadonlyTransaction) => boolean;

package/dist/types/utils/nodes.d.ts

@@ -0,0 +1,35 @@
+import { Fragment, MarkType, NodeType, Mark as PMMark, Node as PMNode, Schema } from 'prosemirror-model';
+import { EditorState, Transaction } from 'prosemirror-state';
+import { CardAppearance } from '@atlaskit/smart-card';
+/**
+ * Finds all top level nodes affected by the transaction
+ * Uses from/to positions in transaction's steps to work out which nodes will
+ * be changed by the transaction
+ */
+export declare const findChangedNodesFromTransaction: (tr: Transaction) => PMNode[];
+export declare const validNode: (node: PMNode) => boolean;
+/** Validates prosemirror nodes, and returns true only if all nodes are valid */
+export declare const validateNodes: (nodes: PMNode[]) => boolean;
+declare type PMEntities = PMNode | PMMark | null | undefined;
+export declare const isType: (node: PMEntities, type: NodeType | MarkType | undefined) => boolean | null | undefined;
+export declare const isParagraph: (node: PMEntities, schema: Schema) => boolean | null | undefined;
+export declare const isText: (node: PMEntities, schema: Schema) => boolean | null | undefined;
+export declare const isLinkMark: (node: PMEntities, schema: Schema) => boolean | null | undefined;
+export declare enum SelectedState {
+    selectedInRange = 0,
+    selectedInside = 1
+}
+/**
+ * Returns if the current selection from achor-head is selecting the node.
+ * If the node is not selected then null is returned.
+ * If the node is selected then an enum is returned that describes weather the node
+ * is fully selected by a range or if the "inside" of the node has been selected or clicked.
+ */
+export declare const isNodeSelectedOrInRange: (anchorPosition: number, headPosition: number, nodePosition: number, nodeSize: number) => SelectedState | null;
+/**
+ * Checks if a particular node fragment is supported in the parent
+ * @param state EditorState
+ * @param fragment The fragment to be checked for
+ */
+export declare const isSupportedInParent: (state: EditorState, fragment: Fragment, currentAppearance?: CardAppearance | undefined) => boolean;
+export {};

package/dist/types/utils/plugin-state-factory.d.ts

@@ -0,0 +1,16 @@
+import { EditorState, PluginKey, ReadonlyTransaction, SafeStateField, Transaction } from 'prosemirror-state';
+import { Dispatch } from '../event-dispatcher';
+import { Command } from '../types';
+export declare type Reducer<PluginState, Action> = (state: PluginState, action: Action) => PluginState;
+declare type MapState<PluginState> = (tr: ReadonlyTransaction, pluginState: PluginState) => PluginState;
+declare type SafePlugin<PluginState, Action, InitialState extends PluginState> = {
+    createPluginState: (dispatch: Dispatch, initialState: InitialState | ((state: EditorState) => InitialState)) => SafeStateField<PluginState>;
+    createCommand: <A = Action>(action: A | ((state: Readonly<EditorState>) => A | false), transform?: (tr: Transaction, state: EditorState) => Transaction) => Command;
+    getPluginState: (state: EditorState) => PluginState;
+};
+export declare function pluginFactory<PluginState, Action, InitialState extends PluginState>(pluginKey: PluginKey, reducer: Reducer<PluginState, Action>, options?: {
+    mapping?: MapState<PluginState>;
+    onDocChanged?: MapState<PluginState>;
+    onSelectionChanged?: MapState<PluginState>;
+}): SafePlugin<PluginState, Action, InitialState>;
+export {};

package/dist/types/utils/slice.d.ts

@@ -0,0 +1,11 @@
+import { Fragment, Node, Slice } from 'prosemirror-model';
+/**
+ * A helper to get the underlying array of a fragment.
+ */
+export declare function getFragmentBackingArray(fragment: Fragment): ReadonlyArray<Node>;
+export declare function mapFragment(content: Fragment, callback: (node: Node, parent: Node | null, index: number) => Node | Node[] | Fragment | null, parent?: Node | null): Fragment<any>;
+export declare function mapSlice(slice: Slice, callback: (node: Node, parent: Node | null, index: number) => Node | Node[] | Fragment | null): Slice;
+export declare type FlatMapCallback = (node: Node, index: number, fragment: Fragment) => Node | Node[];
+export declare function flatmap(fragment: Fragment, callback: FlatMapCallback): Fragment;
+export declare type MapWithCallback<T> = (node: Node, index: number, fragment: Fragment) => T;
+export declare function mapChildren<T>(node: Node | Fragment, callback: MapWithCallback<T>): Array<T>;

package/dist/types/with-plugin-state/index.d.ts

@@ -0,0 +1,86 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { PluginKey } from 'prosemirror-state';
+import { EditorView } from 'prosemirror-view';
+import type { EventDispatcher } from '../event-dispatcher';
+import type { NamedPluginKeys, NamedPluginStates } from './types';
+export declare type PerformanceOptions = {
+    samplingRate: number;
+    slowThreshold: number;
+    trackingEnabled: boolean;
+};
+export interface State {
+    [name: string]: any;
+}
+declare type ContextUpdateHandler = (editorView: EditorView, eventDispatcher: EventDispatcher) => void;
+declare type EditorActionsPrivateAccess = {
+    _privateGetEditorView: () => EditorView;
+    _privateGetEventDispatcher: () => EventDispatcher;
+    _privateSubscribe: (cb: ContextUpdateHandler) => void;
+    _privateUnsubscribe: (cb: ContextUpdateHandler) => void;
+};
+declare type EditorSharedConfigPrivateAccess = {
+    editorView: EditorView;
+    eventDispatcher: EventDispatcher;
+};
+export declare type PluginsConfig = {
+    [name: string]: PluginKey;
+};
+declare type Context = {
+    editorActions?: EditorActionsPrivateAccess;
+    editorSharedConfig?: EditorSharedConfigPrivateAccess;
+};
+export interface Props<P extends NamedPluginKeys> {
+    debounce?: boolean;
+    eventDispatcher?: EventDispatcher;
+    editorView?: EditorView;
+    plugins: P;
+    render: (pluginState: NamedPluginStates<P>) => React.ReactElement | null;
+}
+/**
+ * Wraps component in a high order component that watches state changes of given plugins
+ * and passes those states to the wrapped component.
+ *
+ * Example:
+ * <WithPluginState
+ *   eventDispatcher={eventDispatcher}
+ *   editorView={editorView}
+ *   plugins={{
+ *     hyperlink: hyperlinkPluginKey
+ *   }}
+ *   render={renderComponent}
+ * />
+ *
+ * renderComponent: ({ hyperlink }) => React.Component;
+ */
+declare class WithPluginState<P extends NamedPluginKeys> extends React.Component<Props<P>, State> {
+    static displayName: string;
+    private listeners;
+    private debounce;
+    private notAppliedState;
+    private isSubscribed;
+    static contextTypes: {
+        editorActions: PropTypes.Requireable<object>;
+        editorSharedConfig: PropTypes.Requireable<object>;
+    };
+    context: Context;
+    state: NamedPluginStates<P>;
+    private getEditorView;
+    private getEventDispatcher;
+    private handlePluginStateChange;
+    /**
+     * Debounces setState calls in order to reduce number of re-renders caused by several plugin state changes.
+     */
+    private updateState;
+    private getPluginsStates;
+    private subscribe;
+    private unsubscribe;
+    private onContextUpdate;
+    private subscribeToContextUpdates;
+    private unsubscribeFromContextUpdates;
+    componentDidMount(): void;
+    UNSAFE_componentWillReceiveProps(nextProps: Props<P>): void;
+    componentWillUnmount(): void;
+    render(): React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
+}
+export { WithPluginState };

package/dist/types/with-plugin-state/types.d.ts

@@ -0,0 +1,10 @@
+import { PluginKey } from 'prosemirror-state';
+export declare type NamedPluginKeys = Readonly<{
+    [stateName: string]: PluginKey;
+}>;
+export declare type NamedPluginStates<P extends NamedPluginKeys> = Readonly<Partial<{
+    [K in keyof P]: P[K] extends PluginKey<infer T> ? T : never;
+}>>;
+export declare type Writeable<T> = {
+    -readonly [P in keyof T]: T[P];
+};

package/error-boundary/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/error-boundary",
+  "main": "../dist/cjs/ui/ErrorBoundary/index.js",
+  "module": "../dist/esm/ui/ErrorBoundary/index.js",
+  "module:es2019": "../dist/es2019/ui/ErrorBoundary/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/ui/ErrorBoundary/index.d.ts"
+}

package/event-dispatcher/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/event-dispatcher",
+  "main": "../dist/cjs/event-dispatcher/index.js",
+  "module": "../dist/esm/event-dispatcher/index.js",
+  "module:es2019": "../dist/es2019/event-dispatcher/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/event-dispatcher/index.d.ts"
+}

package/keymaps/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/keymaps",
+  "main": "../dist/cjs/keymaps/index.js",
+  "module": "../dist/esm/keymaps/index.js",
+  "module:es2019": "../dist/es2019/keymaps/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/keymaps/index.d.ts"
+}

package/node-width/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/node-width",
+  "main": "../dist/cjs/node-width/index.js",
+  "module": "../dist/esm/node-width/index.js",
+  "module:es2019": "../dist/es2019/node-width/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/node-width/index.d.ts"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "69.2.1",
+  "version": "69.3.0",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -21,6 +21,7 @@
   },
   "af:exports": {
     "./collab": "./src/collab.ts",
+    "./event-dispatcher": "./src/event-dispatcher/index.ts",
     "./extensions": "./src/extensions.ts",
     "./normalize-feature-flags": "./src/normalize-feature-flags.ts",
     "./messages": "./src/messages/index.ts",
@@ -40,18 +41,34 @@
     "./provider-helpers": "./src/provider-helpers/index.ts",
     "./icons": "./src/icons/index.ts",
     "./safe-plugin": "./src/safe-plugin/index.ts",
-    "./panel": "./src/panel.ts"
+    "./panel": "./src/panel.ts",
+    "./analytics": "./src/analytics/index.ts",
+    "./error-boundary": "./src/ui/ErrorBoundary/index.tsx",
+    "./portal-provider": "./src/ui/PortalProvider/index.tsx",
+    "./react-node-view": "./src/react-node-view/index.tsx",
+    "./with-plugin-state": "./src/with-plugin-state/index.tsx",
+    "./node-width": "./src/node-width/index.ts",
+    "./keymaps": "./src/keymaps/index.tsx",
+    "./ui-menu": "./src/ui-menu/index.tsx",
+    "./ui-react": "./src/ui-react/index.ts",
+    "./ui-color": "./src/ui-color/index.ts",
+    "./transforms": "./src/transforms/index.ts",
+    "./core-utils": "./src/core-utils/index.ts",
+    "./selection": "./src/selection/index.ts"
   },
   "dependencies": {
     "@atlaskit/activity-provider": "^2.3.0",
     "@atlaskit/adf-schema": "^24.0.0",
     "@atlaskit/adf-utils": "^17.1.0",
+    "@atlaskit/analytics-listeners": "^8.3.0",
     "@atlaskit/analytics-namespaced-context": "^6.5.0",
     "@atlaskit/analytics-next": "^8.2.0",
+    "@atlaskit/analytics-next-stable-react-context": "1.0.1",
+    "@atlaskit/button": "^16.3.0",
     "@atlaskit/code": "^14.3.0",
     "@atlaskit/codemod-utils": "^4.1.0",
     "@atlaskit/editor-json-transformer": "^8.8.0",
-    "@atlaskit/editor-shared-styles": "^2.1.0",
+    "@atlaskit/editor-shared-styles": "^2.2.0",
     "@atlaskit/emoji": "^65.2.0",
     "@atlaskit/icon": "^21.10.0",
     "@atlaskit/in-product-testing": "^0.1.0",
@@ -59,8 +76,9 @@
     "@atlaskit/media-client": "^17.1.0",
     "@atlaskit/media-picker": "^63.0.0",
     "@atlaskit/mention": "^21.0.0",
-    "@atlaskit/profilecard": "^17.0.0",
-    "@atlaskit/smart-card": "^22.1.0",
+    "@atlaskit/menu": "^1.3.0",
+    "@atlaskit/profilecard": "^17.1.0",
+    "@atlaskit/smart-card": "^22.2.0",
     "@atlaskit/smart-user-picker": "^6.0.0",
     "@atlaskit/task-decision": "^17.5.0",
     "@atlaskit/theme": "^12.2.0",
@@ -74,13 +92,17 @@
     "@types/prosemirror-state": "^1.2.0",
     "@types/prosemirror-transform": "^1.1.0",
     "@types/prosemirror-view": "^1.9.0",
+    "chromatism": "^2.6.0",
     "classnames": "^2.2.5",
     "cypress-file-upload": "^5.0.2",
     "date-fns": "^2.17.0",
     "lodash": "^4.17.21",
+    "popper.js": "^1.14.1",
+    "prop-types": "^15.5.10",
     "prosemirror-model": "1.14.3",
     "prosemirror-state": "1.3.4",
     "prosemirror-transform": "1.3.2",
+    "prosemirror-utils": "^1.0.0-0",
     "prosemirror-view": "1.23.2",
     "raf-schd": "^4.0.3",
     "react-loadable": "^5.1.0"
@@ -99,11 +121,10 @@
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@testing-library/react": "^8.0.1",
+    "@testing-library/react": "^12.1.5",
     "@types/raf-schd": "^4.0.1",
     "cypress-file-upload": "^5.0.2",
     "enzyme": "^3.10.0",
-    "local-cypress": "^1.2.1",
     "raf-stub": "^2.0.1",
     "react": "^16.8.0",
     "react-test-renderer": "^16.8.0",

package/portal-provider/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/portal-provider",
+  "main": "../dist/cjs/ui/PortalProvider/index.js",
+  "module": "../dist/esm/ui/PortalProvider/index.js",
+  "module:es2019": "../dist/es2019/ui/PortalProvider/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/ui/PortalProvider/index.d.ts"
+}

package/react-node-view/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/react-node-view",
+  "main": "../dist/cjs/react-node-view/index.js",
+  "module": "../dist/esm/react-node-view/index.js",
+  "module:es2019": "../dist/es2019/react-node-view/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/react-node-view/index.d.ts"
+}

package/selection/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/selection",
+  "main": "../dist/cjs/selection/index.js",
+  "module": "../dist/esm/selection/index.js",
+  "module:es2019": "../dist/es2019/selection/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/selection/index.d.ts"
+}

package/transforms/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/transforms",
+  "main": "../dist/cjs/transforms/index.js",
+  "module": "../dist/esm/transforms/index.js",
+  "module:es2019": "../dist/es2019/transforms/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/transforms/index.d.ts"
+}

package/ui-color/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/ui-color",
+  "main": "../dist/cjs/ui-color/index.js",
+  "module": "../dist/esm/ui-color/index.js",
+  "module:es2019": "../dist/es2019/ui-color/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/ui-color/index.d.ts"
+}

package/ui-menu/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/ui-menu",
+  "main": "../dist/cjs/ui-menu/index.js",
+  "module": "../dist/esm/ui-menu/index.js",
+  "module:es2019": "../dist/es2019/ui-menu/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/ui-menu/index.d.ts"
+}

package/ui-react/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/ui-react",
+  "main": "../dist/cjs/ui-react/index.js",
+  "module": "../dist/esm/ui-react/index.js",
+  "module:es2019": "../dist/es2019/ui-react/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/ui-react/index.d.ts"
+}

package/with-plugin-state/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-common/with-plugin-state",
+  "main": "../dist/cjs/with-plugin-state/index.js",
+  "module": "../dist/esm/with-plugin-state/index.js",
+  "module:es2019": "../dist/es2019/with-plugin-state/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/with-plugin-state/index.d.ts"
+}