@atlaskit/editor-common 74.30.0 → 74.32.0

package/dist/types/lists/selection.d.ts

@@ -0,0 +1,13 @@
+import { Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import { Selection } from '@atlaskit/editor-prosemirror/state';
+export declare const numberNestedLists: (resolvedPos: ResolvedPos) => number;
+export declare const getListItemAttributes: ($pos: ResolvedPos) => {
+    indentLevel: number;
+    itemIndex: number;
+};
+type NormalizeListItemsSelection = (props: {
+    selection: Selection;
+    doc: PMNode;
+}) => Selection;
+export declare const normalizeListItemsSelection: NormalizeListItemsSelection;
+export {};

package/dist/types/node-width/index.d.ts

@@ -12,3 +12,4 @@ export declare const layoutToWidth: {
  */
 export declare const getParentNodeWidth: (pos: number | undefined, state: EditorState, containerWidth: EditorContainerWidth, isFullWidthModeEnabled?: boolean) => any;
 export declare const getTableContainerWidth: (node: PMNode) => number;
+export declare const getTableWidthWithNumberColumn: (node: PMNode, offset: number) => number;

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

@@ -41,3 +41,4 @@ export type { DatasourceModalType } from './datasource';
 export type { ImageUploadPluginReferenceEventBase, ImageUploadPluginReferenceEventDragEvent, ImageUploadPluginReferenceEventClipboardEvent, ImageUploadPluginReferenceEvent, } from './image-upload-reference-event';
 export type { HeadingLevels, NormalTextLevel, HeadingLevelsAndNormalText, } from './block-type';
 export type { ColumnResizingPluginState } from './tables';
+export type { InputRuleHandler, OnHandlerApply, InputRuleWrapper, } from './input-rules';

package/dist/types/types/input-rules.d.ts

@@ -0,0 +1,8 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
+export type OnHandlerApply = (state: EditorState, tr: Transaction, matchResult: RegExpExecArray) => void;
+export interface InputRuleWrapper {
+    match: RegExp;
+    handler: InputRuleHandler;
+    onHandlerApply?: OnHandlerApply;
+}

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

@@ -1,2 +1,36 @@
-import type { Command, Predicate } from '../types';
-export declare const filter: (predicates: Predicate[] | Predicate, cmd: Command) => Command;
+import type { Fragment, Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { Command } from '../types';
+export type WalkNode = {
+    $pos: ResolvedPos;
+    foundNode: boolean;
+};
+type Predicate = (state: EditorState, view?: EditorView) => boolean;
+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.
+ *
+ * @param $startPos Position to start walking from.
+ */
+export declare const walkNextNode: ($startPos: ResolvedPos) => WalkNode;
+/**
+ * Walk backwards from a position until we encounter the (inside) end of
+ * the previous node, or reach the start of the document.
+ *
+ * @param $startPos Position to start walking from.
+ */
+export declare const walkPrevNode: ($startPos: ResolvedPos) => WalkNode;
+/**
+ * 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.
+ *
+ * @param canNextNodeMoveUp check if node directly after the selection is able to be brought up to selection
+ * @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;
+export declare const isEmptySelectionAtStart: (state: EditorState) => boolean;
+export declare const isEmptySelectionAtEnd: (state: EditorState) => boolean;
+export { filter as filterCommand };

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

@@ -16,4 +16,8 @@ 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;
 export declare function processRawValue(schema: Schema, value?: ReplaceRawValue, providerFactory?: ProviderFactory, sanitizePrivateContent?: boolean, contentTransformer?: Transformer<string>, dispatchAnalyticsEvent?: DispatchAnalyticsEvent): Node | undefined;
+/**
+ * Returns false if node contains only empty inline nodes and hardBreaks.
+ */
+export declare function hasVisibleContent(node: Node): boolean;
 export {};

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

@@ -45,14 +45,17 @@ export type { ShallowPropsDifference, PropsDifference } from './compare-props';
 export { useComponentRenderTracking } from './performance/hooks/use-component-render-tracking';
 export type { UseComponentRenderTrackingArgs } from './performance/hooks/use-component-render-tracking';
 export { isOutdatedBrowser } from './outdated-browsers';
+export { autoJoinTr } from './prosemirror/autojoin';
 export { isReferencedSource, removeConnectedNodes, getChildrenInfo, getNodeName, } from './referentiality';
 export { getItemCounterDigitsSize, getOrderFromOrderedListNode, resolveOrder, isListNode, isParagraphNode, isListItemNode, isBulletList, } from './list';
 export { isFromCurrentDomain, LinkMatcher, normalizeUrl, linkifyContent, getLinkDomain, findFilepaths, isLinkInMatches, FILEPATH_REGEXP, DONTLINKIFY_REGEXP, getLinkCreationAnalyticsEvent, canLinkBeCreatedInRange, } from './hyperlink';
 export declare const pmHistoryPluginKey = "history$";
 export { gridTypeForLayout } from './grid';
-export { nodesBetweenChanged, getStepRange, isEmptyDocument, processRawValue, hasDocAsParent, bracketTyped, } from './document';
+export { nodesBetweenChanged, getStepRange, isEmptyDocument, processRawValue, hasDocAsParent, bracketTyped, hasVisibleContent, } from './document';
 export { floatingLayouts, isRichMediaInsideOfBlockNode, calculateSnapPoints, alignAttributes, } from './rich-media-utils';
 export { sanitizeNodeForPrivacy } from './filter/privacy-filter';
 export { canRenderDatasource } from './datasource';
-export { filter as filterCommands } from './commands';
+export { filterCommand, walkPrevNode, walkNextNode, isEmptySelectionAtStart, isEmptySelectionAtEnd, insertContentDeleteRange, deleteEmptyParagraphAndMoveBlockUp, } from './commands';
+export type { WalkNode } from './commands';
 export declare function shallowEqual(obj1?: any, obj2?: any): boolean;
+export { inputRuleWithAnalytics } from './input-rules';

package/dist/types/utils/input-rules.d.ts

@@ -0,0 +1,7 @@
+import type { EditorState } from 'prosemirror-state';
+import type { EditorAnalyticsAPI } from '../analytics';
+import type { AnalyticsEventPayload } from '../analytics/types';
+import type { InputRuleWrapper } from '../types/input-rules';
+type GetPayload = AnalyticsEventPayload | ((state: EditorState, matchResult: RegExpExecArray) => AnalyticsEventPayload);
+export declare const inputRuleWithAnalytics: (getPayload: GetPayload, analyticsApi: EditorAnalyticsAPI | undefined) => (originalRule: InputRuleWrapper) => InputRuleWrapper;
+export {};

package/dist/types/utils/prosemirror/autojoin.d.ts

@@ -0,0 +1,13 @@
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Checks whether two adjacent nodes can be joined. If so, the document
+ * will be updated to join those nodes. If not, the original transaction
+ * remains untouched.
+ *
+ * Nodes are considered joinable if the `isJoinable` predicate returns true or,
+ * if an array of strings was passed, if their node type name is in that array.
+ *
+ * Adapted from https://github.com/ProseMirror/prosemirror-commands/blob/master/src/commands.js#L597-L610
+ */
+export declare function autoJoinTr(tr: Transaction, isJoinable: ((before: Node, after: Node) => boolean) | string[]): void;

package/dist/types-ts4.5/lists/analytics.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { CommonListAnalyticsAttributes } from '../analytics';
+export declare const getCommonListAnalyticsAttributes: (state: EditorState) => CommonListAnalyticsAttributes;
+export declare const countListItemsInSelection: (state: EditorState) => number;

package/dist/types-ts4.5/lists/indentation.d.ts

@@ -0,0 +1,5 @@
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const hasValidListIndentationLevel: ({ tr, maxIndentation, }: {
+    tr: Transaction;
+    maxIndentation: number;
+}) => boolean;

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

@@ -0,0 +1,6 @@
+export { getListItemAttributes, normalizeListItemsSelection, } from './selection';
+export { moveTargetIntoList } from './replace-content';
+export { JoinDirection, isListNodeValidContent, joinSiblingLists, } from './node';
+export { getCommonListAnalyticsAttributes, countListItemsInSelection, } from './analytics';
+export { hasValidListIndentationLevel } from './indentation';
+export { isListNode, isListItemNode, isBulletList, isParagraphNode, } from '../utils';

package/dist/types-ts4.5/lists/node.d.ts

@@ -0,0 +1,18 @@
+import { NodeType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare function isListNodeValidContent(node: PMNode): boolean;
+export declare enum JoinDirection {
+    LEFT = 1,
+    RIGHT = -1
+}
+type JoinSiblingListsProps = {
+    tr: Transaction;
+    direction?: JoinDirection;
+    forceListType?: NodeType;
+};
+type ListsJoined = {
+    orderedList: number;
+    bulletList: number;
+};
+export declare const joinSiblingLists: ({ tr, direction, forceListType, }: JoinSiblingListsProps) => ListsJoined;
+export {};

package/dist/types-ts4.5/lists/replace-content.d.ts

@@ -0,0 +1,8 @@
+import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import { Step } from '@atlaskit/editor-prosemirror/transform';
+type Params = {
+    insertPosition: number;
+    $target: ResolvedPos;
+};
+export declare const moveTargetIntoList: ({ insertPosition, $target, }: Params) => Step;
+export {};

package/dist/types-ts4.5/lists/selection.d.ts

@@ -0,0 +1,13 @@
+import { Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import { Selection } from '@atlaskit/editor-prosemirror/state';
+export declare const numberNestedLists: (resolvedPos: ResolvedPos) => number;
+export declare const getListItemAttributes: ($pos: ResolvedPos) => {
+    indentLevel: number;
+    itemIndex: number;
+};
+type NormalizeListItemsSelection = (props: {
+    selection: Selection;
+    doc: PMNode;
+}) => Selection;
+export declare const normalizeListItemsSelection: NormalizeListItemsSelection;
+export {};

package/dist/types-ts4.5/node-width/index.d.ts

@@ -12,3 +12,4 @@ export declare const layoutToWidth: {
  */
 export declare const getParentNodeWidth: (pos: number | undefined, state: EditorState, containerWidth: EditorContainerWidth, isFullWidthModeEnabled?: boolean) => any;
 export declare const getTableContainerWidth: (node: PMNode) => number;
+export declare const getTableWidthWithNumberColumn: (node: PMNode, offset: number) => number;

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

@@ -41,3 +41,4 @@ export type { DatasourceModalType } from './datasource';
 export type { ImageUploadPluginReferenceEventBase, ImageUploadPluginReferenceEventDragEvent, ImageUploadPluginReferenceEventClipboardEvent, ImageUploadPluginReferenceEvent, } from './image-upload-reference-event';
 export type { HeadingLevels, NormalTextLevel, HeadingLevelsAndNormalText, } from './block-type';
 export type { ColumnResizingPluginState } from './tables';
+export type { InputRuleHandler, OnHandlerApply, InputRuleWrapper, } from './input-rules';

package/dist/types-ts4.5/types/input-rules.d.ts

@@ -0,0 +1,8 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+export type InputRuleHandler = (state: EditorState, matchResult: RegExpExecArray, start: number, end: number) => Transaction | null;
+export type OnHandlerApply = (state: EditorState, tr: Transaction, matchResult: RegExpExecArray) => void;
+export interface InputRuleWrapper {
+    match: RegExp;
+    handler: InputRuleHandler;
+    onHandlerApply?: OnHandlerApply;
+}

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

@@ -1,2 +1,42 @@
-import type { Command, Predicate } from '../types';
-export declare const filter: (predicates: Predicate[] | Predicate, cmd: Command) => Command;
+import type { Fragment, Node as PMNode, ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { Command } from '../types';
+export type WalkNode = {
+    $pos: ResolvedPos;
+    foundNode: boolean;
+};
+type Predicate = (state: EditorState, view?: EditorView) => boolean;
+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.
+ *
+ * @param $startPos Position to start walking from.
+ */
+export declare const walkNextNode: ($startPos: ResolvedPos) => WalkNode;
+/**
+ * Walk backwards from a position until we encounter the (inside) end of
+ * the previous node, or reach the start of the document.
+ *
+ * @param $startPos Position to start walking from.
+ */
+export declare const walkPrevNode: ($startPos: ResolvedPos) => WalkNode;
+/**
+ * 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.
+ *
+ * @param canNextNodeMoveUp check if node directly after the selection is able to be brought up to selection
+ * @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;
+export declare const isEmptySelectionAtStart: (state: EditorState) => boolean;
+export declare const isEmptySelectionAtEnd: (state: EditorState) => boolean;
+export { filter as filterCommand };

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

@@ -16,4 +16,8 @@ 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;
 export declare function processRawValue(schema: Schema, value?: ReplaceRawValue, providerFactory?: ProviderFactory, sanitizePrivateContent?: boolean, contentTransformer?: Transformer<string>, dispatchAnalyticsEvent?: DispatchAnalyticsEvent): Node | undefined;
+/**
+ * Returns false if node contains only empty inline nodes and hardBreaks.
+ */
+export declare function hasVisibleContent(node: Node): boolean;
 export {};

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

@@ -45,14 +45,17 @@ export type { ShallowPropsDifference, PropsDifference } from './compare-props';
 export { useComponentRenderTracking } from './performance/hooks/use-component-render-tracking';
 export type { UseComponentRenderTrackingArgs } from './performance/hooks/use-component-render-tracking';
 export { isOutdatedBrowser } from './outdated-browsers';
+export { autoJoinTr } from './prosemirror/autojoin';
 export { isReferencedSource, removeConnectedNodes, getChildrenInfo, getNodeName, } from './referentiality';
 export { getItemCounterDigitsSize, getOrderFromOrderedListNode, resolveOrder, isListNode, isParagraphNode, isListItemNode, isBulletList, } from './list';
 export { isFromCurrentDomain, LinkMatcher, normalizeUrl, linkifyContent, getLinkDomain, findFilepaths, isLinkInMatches, FILEPATH_REGEXP, DONTLINKIFY_REGEXP, getLinkCreationAnalyticsEvent, canLinkBeCreatedInRange, } from './hyperlink';
 export declare const pmHistoryPluginKey = "history$";
 export { gridTypeForLayout } from './grid';
-export { nodesBetweenChanged, getStepRange, isEmptyDocument, processRawValue, hasDocAsParent, bracketTyped, } from './document';
+export { nodesBetweenChanged, getStepRange, isEmptyDocument, processRawValue, hasDocAsParent, bracketTyped, hasVisibleContent, } from './document';
 export { floatingLayouts, isRichMediaInsideOfBlockNode, calculateSnapPoints, alignAttributes, } from './rich-media-utils';
 export { sanitizeNodeForPrivacy } from './filter/privacy-filter';
 export { canRenderDatasource } from './datasource';
-export { filter as filterCommands } from './commands';
+export { filterCommand, walkPrevNode, walkNextNode, isEmptySelectionAtStart, isEmptySelectionAtEnd, insertContentDeleteRange, deleteEmptyParagraphAndMoveBlockUp, } from './commands';
+export type { WalkNode } from './commands';
 export declare function shallowEqual(obj1?: any, obj2?: any): boolean;
+export { inputRuleWithAnalytics } from './input-rules';

package/dist/types-ts4.5/utils/input-rules.d.ts

@@ -0,0 +1,7 @@
+import type { EditorState } from 'prosemirror-state';
+import type { EditorAnalyticsAPI } from '../analytics';
+import type { AnalyticsEventPayload } from '../analytics/types';
+import type { InputRuleWrapper } from '../types/input-rules';
+type GetPayload = AnalyticsEventPayload | ((state: EditorState, matchResult: RegExpExecArray) => AnalyticsEventPayload);
+export declare const inputRuleWithAnalytics: (getPayload: GetPayload, analyticsApi: EditorAnalyticsAPI | undefined) => (originalRule: InputRuleWrapper) => InputRuleWrapper;
+export {};

package/dist/types-ts4.5/utils/prosemirror/autojoin.d.ts

@@ -0,0 +1,13 @@
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Checks whether two adjacent nodes can be joined. If so, the document
+ * will be updated to join those nodes. If not, the original transaction
+ * remains untouched.
+ *
+ * Nodes are considered joinable if the `isJoinable` predicate returns true or,
+ * if an array of strings was passed, if their node type name is in that array.
+ *
+ * Adapted from https://github.com/ProseMirror/prosemirror-commands/blob/master/src/commands.js#L597-L610
+ */
+export declare function autoJoinTr(tr: Transaction, isJoinable: ((before: Node, after: Node) => boolean) | string[]): void;

package/lists/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/editor-common/lists",
+  "main": "../dist/cjs/lists/index.js",
+  "module": "../dist/esm/lists/index.js",
+  "module:es2019": "../dist/es2019/lists/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/lists/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "../dist/types-ts4.5/lists/index.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "74.30.0",
+  "version": "74.32.0",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -75,7 +75,8 @@
     "./guideline": "./src/guideline/index.ts",
     "./quick-insert": "./src/quick-insert/index.ts",
     "./link": "./src/link/index.ts",
-    "./mark": "./src/mark/index.ts"
+    "./mark": "./src/mark/index.ts",
+    "./lists": "./src/lists/index.ts"
   },
   "dependencies": {
     "@atlaskit/activity-provider": "^2.4.0",