@atlaskit/editor-common 115.2.2 → 115.4.0

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

@@ -1,13 +1,12 @@
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorAnalyticsAPI } from '../analytics';
-import type { Command, Predicate } from '../types';
+import type { Command } from '../types';
+import { filter } from './filter';
 export type WalkNode = {
     $pos: ResolvedPos;
     foundNode: boolean;
 };
-export declare const filter: (predicates: Predicate[] | Predicate, cmd: Command) => Command;
 /**
  * Walk forwards from a position until we encounter the (inside) start of
  * the next node, or reach the end of the document.
@@ -22,13 +21,10 @@ export declare const walkNextNode: ($startPos: ResolvedPos) => WalkNode;
  * @param $startPos Position to start walking from.
  */
 export declare const walkPrevNode: ($startPos: ResolvedPos) => WalkNode;
-export declare function insertNewLine(): Command;
 export declare const insertNewLineWithAnalytics: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => Command;
 export declare const createNewParagraphAbove: Command;
 export declare const createNewParagraphBelow: Command;
 export declare function createParagraphNear(append?: boolean): Command;
-export declare function atTheEndOfDoc(state: EditorState): boolean;
-export declare function atTheBeginningOfDoc(state: EditorState): boolean;
 /**
  * If the selection is empty, is inside a paragraph node and `canNextNodeMoveUp` is true then delete current paragraph
  * and move the node below it up. The selection will be retained, to be placed in the moved node.
@@ -37,7 +33,6 @@ export declare function atTheBeginningOfDoc(state: EditorState): boolean;
  * @returns PM Command
  */
 export declare const deleteEmptyParagraphAndMoveBlockUp: (canNextNodeMoveUp: (nextNode: PMNode) => boolean) => Command;
-export declare const insertContentDeleteRange: (tr: Transaction, getSelectionResolvedPos: (tr: Transaction) => ResolvedPos, insertions: [Fragment, number][], deletions: [number, number][]) => void;
 /**
  * Check if the selection is empty and at the start of a task or list item
  * @param state Editor state
@@ -46,3 +41,8 @@ export declare const insertContentDeleteRange: (tr: Transaction, getSelectionRes
 export declare const isEmptySelectionAtStart: (state: EditorState) => boolean;
 export declare const isEmptySelectionAtEnd: (state: EditorState) => boolean;
 export { filter as filterCommand };
+export { filter } from './filter';
+export { insertNewLine } from './insertNewLine';
+export { atTheEndOfDoc } from './atTheEndOfDoc';
+export { atTheBeginningOfDoc } from './atTheBeginningOfDoc';
+export { insertContentDeleteRange } from './insertContentDeleteRange';

package/dist/types/utils/compare-props.d.ts

@@ -17,16 +17,12 @@ export type ShallowPropsDifference<T> = {
     changed: Array<keyof T>;
     removed: Array<keyof T>;
 };
-export declare const getKeys: <T>(obj: T) => Array<keyof T>;
 export declare const getKeysAddedRemovedCommon: <T>(object1: T, object2: T) => {
     added: (keyof T & keyof (T & {}))[];
     common: (keyof T & keyof (T & {}))[];
     removed: (keyof T & keyof (T & {}))[];
 };
-export declare const serializeValue: <T>(value: T[keyof T]) => string | (T[keyof T] & {}) | {
-    type: string;
-    keys: string[];
-} | undefined;
 export declare const getPropsDifference: <T>(object1: T, object2: T, curDepth?: number, maxDepth?: number, keysToIgnore?: Array<keyof T>) => PropsDifference<T>;
 export declare const getShallowPropsDifference: <T>(object1: T, object2: T) => ShallowPropsDifference<T>;
-export {};
+export { getKeys } from './getKeys';
+export { serializeValue } from './serializeValue';

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

@@ -1,14 +1,7 @@
 import type { CardAttributes } from '@atlaskit/adf-schema';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { SortOrder } from '../types';
-export declare enum ContentType {
-    NUMBER = 0,
-    TEXT = 5,
-    MENTION = 10,
-    DATE = 15,
-    STATUS = 20,
-    LINK = 25
-}
+import { ContentType } from './ContentType';
 interface CompareOptions {
     getInlineCardTextFromStore: (attrs: CardAttributes) => string | null;
 }
@@ -46,4 +39,4 @@ export declare function extractMetaFromTextNode(textNode: PMNode, normalizeTextP
  * like a regular JS sort method.
  */
 export declare const createCompareNodes: (options: CompareOptions, order?: SortOrder) => Function;
-export {};
+export { ContentType } from './ContentType';

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

@@ -0,0 +1,4 @@
+/**
+ * IE11 doesn't support classList to SVGElements
+ **/
+export declare const containsClassName: (node: HTMLElement | SVGElement | null, className: string) => boolean;

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

@@ -0,0 +1,7 @@
+import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
+/**
+ *
+ * @param tableNode
+ * @example
+ */
+export declare function convertProsemirrorTableNodeToArrayOfRows(tableNode: PmNode): Array<Array<PmNode | null>>;

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

@@ -0,0 +1,2 @@
+import type { InputRuleHandler, InputRuleWrapper } from '../types';
+export declare const createRule: (match: RegExp, handler: InputRuleHandler, allowsBackwardMatch?: boolean) => InputRuleWrapper;

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

@@ -1,3 +1,2 @@
-import type { DatasourceModalType } from '../types';
-export declare const getDatasourceType: (datasourceId: string) => DatasourceModalType | undefined;
 export declare const canRenderDatasource: (datasourceId: string, defaultValue?: boolean) => boolean;
+export { getDatasourceType } from './getDatasourceType';

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

@@ -1,22 +1,8 @@
-import type { Node, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import type { Node } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, ReadonlyTransaction, Transaction } from '@atlaskit/editor-prosemirror/state';
 type ChangedFn = (node: Node, pos: number, parent: Node | null, index: number) => boolean | void;
-export declare const getStepRange: (transaction: Transaction | ReadonlyTransaction) => {
-    from: number;
-    to: number;
-} | null;
-export declare function hasDocAsParent($anchor: ResolvedPos): boolean;
-/**
- * Checks if a node looks like an empty document
- */
-export declare function isEmptyDocument(node: Node): boolean;
 export declare function bracketTyped(state: EditorState): boolean;
 export declare function nodesBetweenChanged(tr: Transaction | ReadonlyTransaction, f: ChangedFn, startPos?: number): void;
-/**
- * Returns false if node contains only empty inline nodes and hardBreaks.
- */
-export declare function hasVisibleContent(node: Node): boolean;
-export declare const isSelectionEndOfParagraph: (state: EditorState) => boolean;
 export declare function getChangedNodes(tr: ReadonlyTransaction | Transaction): {
     node: Node;
     pos: number;
@@ -37,4 +23,8 @@ export declare const isReplaceDocOperation: (transactions: readonly Transaction[
 export declare function areNodesEqualIgnoreAttrs(node1: Node, node2: Node, attributesToIgnore?: string[], opts?: {
     ignoreMarkOrder?: boolean;
 }): boolean;
-export {};
+export { getStepRange } from './getStepRange';
+export { hasDocAsParent } from './hasDocAsParent';
+export { isEmptyDocument } from './isEmptyDocument';
+export { hasVisibleContent } from './hasVisibleContent';
+export { isSelectionEndOfParagraph } from './isSelectionEndOfParagraph';

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

@@ -1,40 +1,10 @@
-/**
- * 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;
-/**
- * Util for converting a css pixel size value to a number (of pixels).
- *
- * ie.
- * ```ts
- * const pixels = parsePx('10px')
- * //    ^$ const pixels: number
- * ```
- * * ```ts
- * const pixels = parsePx('10')
- * //    ^$ const pixels: number | undefined
- * ```
- */
-export declare function parsePx<PXString extends `${number}px`>(pxStr: PXString): number;
-export declare function parsePx<PXString extends string>(pxStr: PXString): number | undefined;
 export 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>;
+export { walkUpTreeUntil } from './walkUpTreeUntil';
+export { unwrap } from './unwrap';
+export { removeNestedEmptyEls } from './removeNestedEmptyEls';
+export { containsClassName } from './containsClassName';
+export { parsePx } from './parsePx';

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

@@ -1,17 +1,6 @@
-import type { MarkType, Node, NodeType, Slice } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
-import { TextSelection } from '@atlaskit/editor-prosemirror/state';
+import type { MarkType, NodeType } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-/**
- * Checks if node is an empty paragraph.
- */
-export declare function isEmptyParagraph(node?: Node | null): boolean;
-export declare const stepHasSlice: (step: Step) => step is Step & {
-    from: number;
-    slice: Slice;
-    to: number;
-};
 /**
  * Checks whether a given step is adding nodes of given nodeTypes
  *
@@ -19,19 +8,18 @@ export declare const stepHasSlice: (step: Step) => step is Step & {
  * @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;
-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 setTextSelection(view: EditorView, anchor: number, head?: number): void;
-export declare function setAllSelection(view: EditorView): void;
-export declare function setCellSelection(view: EditorView, anchor: number, head?: number): void;
-export declare function nonNullable<T>(value: T): value is NonNullable<T>;
-export declare const isValidPosition: (pos: number | undefined, state: EditorState) => boolean;
-export declare const isInLayoutColumn: (state: EditorState) => boolean;
-export declare function filterChildrenBetween(doc: Node, from: number, to: number, predicate: (node: Node, pos: number, parent: Node | null) => boolean | undefined): {
-    node: Node;
-    pos: number;
-}[];
 export declare const removeBlockMarks: (state: EditorState, marks: Array<MarkType | undefined>) => Transaction | undefined;
+export { isEmptyParagraph } from './isEmptyParagraph';
+export { stepHasSlice } from './stepHasSlice';
+export { extractSliceFromStep } from './extractSliceFromStep';
+export { isTextSelection } from './isTextSelection';
+export { isElementInTableCell } from './isElementInTableCell';
+export { isLastItemMediaGroup } from './isLastItemMediaGroup';
+export { setNodeSelection } from './setNodeSelection';
+export { setTextSelection } from './setTextSelection';
+export { setAllSelection } from './setAllSelection';
+export { setCellSelection } from './setCellSelection';
+export { nonNullable } from './nonNullable';
+export { isValidPosition } from './isValidPosition';
+export { isInLayoutColumn } from './isInLayoutColumn';
+export { filterChildrenBetween } from './filterChildrenBetween';

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

@@ -0,0 +1,3 @@
+import type { Slice } from '@atlaskit/editor-prosemirror/model';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
+export declare const extractSliceFromStep: (step: Step) => Slice | null;

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

@@ -0,0 +1,2 @@
+import type { Command, Predicate } from '../types';
+export declare const filter: (predicates: Predicate[] | Predicate, cmd: Command) => Command;

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

@@ -0,0 +1,5 @@
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+export declare function filterChildrenBetween(doc: Node, from: number, to: number, predicate: (node: Node, pos: number, parent: Node | null) => boolean | undefined): {
+    node: Node;
+    pos: number;
+}[];

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

@@ -0,0 +1,8 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+/**
+ * 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[];

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

@@ -0,0 +1,2 @@
+import type { Selection } from '@atlaskit/editor-prosemirror/state';
+export declare function findInsertLocation(selection: Selection): string;

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

@@ -0,0 +1 @@
+export declare const floatingLayouts: string[];

package/dist/types/utils/get-performance-options.d.ts

@@ -5,12 +5,10 @@ export declare function getPerformanceOptions(view: EditorView): {
     slowThreshold: number;
     trackingEnabled: boolean;
 };
-export declare function startMeasureReactNodeViewRendered({ nodeTypeName, }: {
-    nodeTypeName: string;
-}): void;
 export declare function stopMeasureReactNodeViewRendered({ nodeTypeName, dispatchAnalyticsEvent, samplingRate, slowThreshold, }: {
     dispatchAnalyticsEvent: (payload: AnalyticsEventPayload) => void;
     nodeTypeName: string;
     samplingRate: number;
     slowThreshold: number;
 }): void;
+export { startMeasureReactNodeViewRendered } from './startMeasureReactNodeViewRendered';

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

@@ -0,0 +1,2 @@
+import { EDITOR_APPEARANCE_CONTEXT } from '@atlaskit/analytics-namespaced-context/FabricEditorAnalyticsContext';
+export declare const getAnalyticsAppearance: (appearance?: string) => EDITOR_APPEARANCE_CONTEXT | undefined;

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

@@ -0,0 +1,2 @@
+import type { NodeType, Schema } from '@atlaskit/editor-prosemirror/model';
+export declare const getBreakoutResizableNodeTypes: (schema: Schema) => Set<NodeType>;

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

@@ -0,0 +1,2 @@
+import type { DatasourceModalType } from '../types';
+export declare const getDatasourceType: (datasourceId: string) => DatasourceModalType | undefined;

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

@@ -0,0 +1,5 @@
+import type { Fragment, Node } from '@atlaskit/editor-prosemirror/model';
+/**
+ * A helper to get the underlying array of a fragment.
+ */
+export declare function getFragmentBackingArray(fragment: Fragment): ReadonlyArray<Node>;

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

@@ -0,0 +1 @@
+export declare const getKeys: <T>(obj: T) => Array<keyof T>;

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

@@ -0,0 +1 @@
+export declare function getLinkDomain(url: string): string;

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

@@ -0,0 +1 @@
+export declare const getNestingRulesFromSchema: () => Record<string, string[]>;

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

@@ -0,0 +1,2 @@
+import type { BreakoutMode } from '../types/breakout';
+export declare const getNextBreakoutMode: (currentMode?: BreakoutMode) => Exclude<BreakoutMode, "max">;

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

@@ -0,0 +1,3 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export declare const getNodeName: (state: EditorState, node?: PMNode) => string;

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

@@ -0,0 +1,5 @@
+import type { ReadonlyTransaction, Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const getStepRange: (transaction: Transaction | ReadonlyTransaction) => {
+    from: number;
+    to: number;
+} | null;

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

@@ -0,0 +1,6 @@
+import type { BreakoutMode } from '../types/breakout';
+export declare const getTitle: (layout?: BreakoutMode) => {
+    id: string;
+    defaultMessage: string;
+    description: string;
+};

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

@@ -0,0 +1,2 @@
+import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+export declare function hasDocAsParent($anchor: ResolvedPos): boolean;

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

@@ -0,0 +1,7 @@
+import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
+/**
+ *
+ * @param tableNode
+ * @example
+ */
+export declare function hasMergedCell(tableNode: PmNode): boolean;

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

@@ -0,0 +1,5 @@
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+/**
+ * Returns false if node contains only empty inline nodes and hardBreaks.
+ */
+export declare function hasVisibleContent(node: Node): boolean;

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

@@ -1,26 +1,11 @@
 import type { Schema, Slice } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { AnalyticsEventPayload } from '../analytics/types/events';
 import type { InputMethodInsertLink } from '../analytics/types/insert-events';
-export declare const FILEPATH_REGEXP: RegExp;
 export declare const DONTLINKIFY_REGEXP: RegExp;
-/**
- * Instance of class LinkMatcher are used in autoformatting in place of Regex.
- * Hence it has been made similar to regex with an exec method.
- * Extending it directly from class Regex was introducing some issues, thus that has been avoided.
- */
-export declare class LinkMatcher {
-    static create(): RegExp;
-}
-/**
- * Adds protocol to url if needed.
- */
-export declare function normalizeUrl(url?: string | null): string;
 /**
  * Linkify content in a slice (eg. after a rich text paste)
  */
 export declare function linkifyContent(schema: Schema): (slice: Slice) => Slice;
-export declare function getLinkDomain(url: string): string;
 export declare function isFromCurrentDomain(url: string): boolean;
 interface filepathMatch {
     endIndex: number;
@@ -29,5 +14,8 @@ interface filepathMatch {
 export declare const findFilepaths: (text: string, offset?: number) => Array<filepathMatch>;
 export declare const isLinkInMatches: (linkStart: number, matchesList: Array<filepathMatch>) => boolean;
 export declare function getLinkCreationAnalyticsEvent(inputMethod: InputMethodInsertLink, url: string): AnalyticsEventPayload;
-export declare const canLinkBeCreatedInRange: (from: number, to: number) => (state: EditorState) => boolean;
-export {};
+export { FILEPATH_REGEXP } from './FILEPATH_REGEXP';
+export { LinkMatcher } from './LinkMatcher';
+export { normalizeUrl } from './normalizeUrl';
+export { getLinkDomain } from './getLinkDomain';
+export { canLinkBeCreatedInRange } from './canLinkBeCreatedInRange';