@atlaskit/editor-common 76.9.1 → 76.10.0

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

@@ -0,0 +1,40 @@
+import { Node } from '@atlaskit/editor-prosemirror/model';
+import { INPUT_METHOD } from '../analytics';
+import type { EditorAppearance } from '../types';
+export declare enum LinkAction {
+    SHOW_INSERT_TOOLBAR = "SHOW_INSERT_TOOLBAR",
+    HIDE_TOOLBAR = "HIDE_TOOLBAR",
+    SELECTION_CHANGE = "SELECTION_CHANGE",
+    INSERT_LINK_TOOLBAR = "INSERT",
+    EDIT_INSERTED_TOOLBAR = "EDIT_INSERTED_TOOLBAR"
+}
+export declare enum InsertStatus {
+    EDIT_LINK_TOOLBAR = "EDIT",
+    INSERT_LINK_TOOLBAR = "INSERT",
+    EDIT_INSERTED_TOOLBAR = "EDIT_INSERTED"
+}
+export type InsertState = {
+    type: InsertStatus.INSERT_LINK_TOOLBAR;
+    from: number;
+    to: number;
+};
+export type EditInsertedState = {
+    type: InsertStatus.EDIT_INSERTED_TOOLBAR;
+    node: Node;
+    pos: number;
+};
+export type EditState = {
+    type: InsertStatus.EDIT_LINK_TOOLBAR;
+    node: Node;
+    pos: number;
+};
+export type LinkToolbarState = EditState | EditInsertedState | InsertState | undefined;
+export interface HyperlinkState {
+    activeText?: string;
+    activeLinkMark?: LinkToolbarState;
+    timesViewed: number;
+    canInsertLink: boolean;
+    searchSessionId?: string;
+    inputMethod?: INPUT_METHOD;
+    editorAppearance?: EditorAppearance;
+}

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

@@ -0,0 +1,3 @@
+import type { Predicate } from '../types';
+export declare function isTextAtPos(pos: number): Predicate;
+export declare function isLinkAtPos(pos: number): Predicate;

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

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

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

@@ -0,0 +1,5 @@
+import type { 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 type { 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/mark/commands.d.ts

@@ -0,0 +1,18 @@
+import type { Mark, MarkType, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { EditorCommand } from '../types';
+export declare function filterChildrenBetween(doc: PMNode, from: number, to: number, predicate: (node: PMNode, pos: number, parent: PMNode | null) => boolean | undefined): {
+    node: PMNode;
+    pos: number;
+}[];
+export declare const transformSmartCharsMentionsAndEmojis: (from: number, to: number, tr: Transaction) => void;
+export declare const applyMarkOnRange: (from: number, to: number, removeMark: boolean, mark: Mark, tr: Transaction) => Transaction;
+/**
+ * A custom version of the ProseMirror toggleMark, where we only toggle marks
+ * on text nodes in the selection rather than all inline nodes.
+ * @param markType
+ * @param attrs
+ */
+export declare const toggleMark: (markType: MarkType, attrs?: {
+    [key: string]: any;
+} | undefined) => EditorCommand;

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

@@ -0,0 +1,2 @@
+export { transformSmartCharsMentionsAndEmojis, applyMarkOnRange, filterChildrenBetween, toggleMark, } from './commands';
+export { anyMarkActive, isMarkAllowedInRange, isMarkExcluded, } from './text-formatting';

package/dist/types-ts4.5/mark/text-formatting.d.ts

@@ -0,0 +1,8 @@
+import type { Mark, MarkType, Node } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, SelectionRange } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Determine if a mark of a specific type exists anywhere in the selection.
+ */
+export declare const anyMarkActive: (state: EditorState, markType: Mark | MarkType) => boolean;
+export declare const isMarkAllowedInRange: (doc: Node, ranges: readonly SelectionRange[], type: MarkType) => boolean;
+export declare const isMarkExcluded: (type: MarkType, marks?: readonly Mark[] | null) => boolean;

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

@@ -0,0 +1,22 @@
+import type { RichMediaLayout } from '@atlaskit/adf-schema';
+export declare const MEDIA_SINGLE_DEFAULT_MIN_PIXEL_WIDTH = 24;
+export declare const MEDIA_SINGLE_VIDEO_MIN_PIXEL_WIDTH = 320;
+export declare const MEDIA_SINGLE_SNAP_GAP = 3;
+export declare const MEDIA_SINGLE_HIGHLIGHT_GAP = 10;
+export declare const MEDIA_SINGLE_HANDLE_MARGIN = 12;
+export declare const MEDIA_SINGLE_GUTTER_SIZE: number;
+export declare const DEFAULT_IMAGE_WIDTH = 250;
+export declare const DEFAULT_IMAGE_HEIGHT = 200;
+export declare const MEDIA_SINGLE_RESIZE_THROTTLE_TIME = 100;
+export declare enum Layout {
+    FULL_WIDTH = "full-width",
+    WIDE = "wide",
+    CENTER = "center",
+    ALIGN_START = "align-start",
+    ALIGN_END = "align-end",
+    WRAP_RIGHT = "wrap-right",
+    WRAP_LEFT = "wrap-left"
+}
+export declare const wrappedLayouts: RichMediaLayout[];
+export declare const DEFAULT_ROUNDING_INTERVAL = 0.5;
+export declare const CAPTION_PLACEHOLDER_ID = "caption-placeholder";

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

@@ -0,0 +1,2 @@
+export { MEDIA_SINGLE_DEFAULT_MIN_PIXEL_WIDTH, MEDIA_SINGLE_VIDEO_MIN_PIXEL_WIDTH, MEDIA_SINGLE_SNAP_GAP, MEDIA_SINGLE_HIGHLIGHT_GAP, MEDIA_SINGLE_GUTTER_SIZE, MEDIA_SINGLE_RESIZE_THROTTLE_TIME, Layout as MediaSingleLayout, DEFAULT_IMAGE_WIDTH, DEFAULT_IMAGE_HEIGHT, wrappedLayouts, CAPTION_PLACEHOLDER_ID, } from './constants';
+export { getMediaSinglePixelWidth, calcMediaSinglePixelWidth, calcMediaSingleMaxWidth, getMediaSingleInitialWidth, calculateOffsetLeft, roundToNearest, calcMinWidth, getMaxWidthForNestedNode, getMaxWidthForNestedNodeNext, } from './utils';

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

@@ -0,0 +1,92 @@
+import type { RichMediaLayout } from '@atlaskit/adf-schema';
+import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * Convert media node width to pixel
+ *
+ * for legacy experience, image is aligned inside resize handle bar with a gap. So gutterOffset is used to for this use case.
+ * for new experience, image is aligned with resize handle bar, so gutterOffset is 0
+ *
+ * @param width - media single node width
+ * @param editorWidth - width of editor
+ * @param widthType - width type is defined in the adf document for mediaSingle node, and it is associated with the `width`
+ * @param gutterOffset - resize handle bar offset, determines whether align with resize handle bar
+ * @returns pixel number for media single node
+ */
+export declare function getMediaSinglePixelWidth(width: number, editorWidth: number, widthType?: string, gutterOffset?: number): number;
+export interface calcMediaSinglePixelWidthProps {
+    width?: number;
+    widthType?: 'percentage' | 'pixel';
+    origWidth: number;
+    layout: RichMediaLayout;
+    contentWidth?: number;
+    containerWidth: number;
+    gutterOffset: number;
+}
+/**
+ * Convert width attribute to pixel value for legacy (resized or not resisized) and new media single node for new experience
+ * @param width node width attribute
+ * @param widthType node widthType attribute
+ * @param origWidth original media width
+ * @param layout node layout attribute
+ * @param contentWidth editor content width
+ * @param containerWidth editor container width
+ * @param gutterOffset gap between resizer handle and media
+ * @returns pixel width of the node
+ */
+export declare const calcMediaSinglePixelWidth: ({ width, widthType, origWidth, layout, contentWidth, containerWidth, gutterOffset, }: calcMediaSinglePixelWidthProps) => number;
+/**
+ * Calculate maximum width allowed for media single node in fix-width editor in new experience
+ * @param containerWidth width of editor container
+ */
+export declare const calcMediaSingleMaxWidth: (containerWidth: number) => number;
+/**
+ * Calculate initial media single pixel width.
+ * Make it fall between max width and min width
+ * @param origWidth original width of image (media node width)
+ * @param maxWidth default to akEditorDefaultLayoutWidth (760)
+ * @param minWidth default to MEDIA_SINGLE_DEFAULT_MIN_PIXEL_WIDTH (24)
+ */
+export declare const getMediaSingleInitialWidth: (origWidth?: number, maxWidth?: number, minWidth?: number) => number;
+export declare function calculateOffsetLeft(insideInlineLike: boolean, insideLayout: boolean, pmViewDom: Element, wrapper?: HTMLElement): number;
+/**
+ * Returns the number rounded to the nearest interval.
+ * @param {number} value    The number to round
+ * @param {number} interval The numeric interval to round to, default to 0.5
+ * @return {number} the rounded number
+ */
+export declare const roundToNearest: (value: number, interval?: number) => number;
+/**
+ * Retuns minimum value for media single node
+ * @param isVideoFile is child media of video type
+ * @param contentWidth parent content width
+ */
+export declare const calcMinWidth: (isVideoFile: boolean, contentWidth: number) => number;
+/**
+ * Get parent width for a nested media single node
+ * @param view Editor view
+ * @param pos node position
+ */
+export declare const getMaxWidthForNestedNode: (view: EditorView, pos: number | undefined) => number | null;
+/**
+ * Get parent width for a nested media single node for new experience
+ * We don't check for mediaSingle selection in this function.
+ * @param view Editor view
+ * @param pos node position
+ * @param forInsertion for insertion
+ */
+export declare const getMaxWidthForNestedNodeNext: (view: EditorView, pos: number | undefined, forInsertion?: boolean) => number | null;
+/**
+ * Get parent content width for nested media single node.
+ * @param resolvedPos resolved Position of the node
+ * @param view editor view
+ * @returns parent content width for nested node
+ */
+export declare const getParentWidthForNestedMediaSingleNode: (resolvedPos: ResolvedPos, view: EditorView) => number | null;
+/**
+ * Get parent width for nested media single nodes
+ * @param resolvedPos resolved Position of the node
+ * @param view editor view
+ * @returns parent width used for media single initial width on insertion
+ */
+export declare const getParentWidthForNestedMediaSingleNodeForInsertion: (resolvedPos: ResolvedPos, view: EditorView) => number | null;

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

@@ -0,0 +1,2 @@
+export { default as Mention } from './ui/Mention';
+export { MentionSharedCssClassName } from './styles/shared/mention';

package/dist/types-ts4.5/messages/alignment.d.ts

@@ -0,0 +1,17 @@
+export declare const alignmentMessages: {
+    alignLeft: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    alignCenter: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    alignRight: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/messages/annotation.d.ts

@@ -0,0 +1,17 @@
+export declare const annotationMessages: {
+    createComment: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    createCommentInvalid: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    toolbar: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/messages/block-type.d.ts

@@ -0,0 +1,152 @@
+export declare const messages: {
+    normal: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading1: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading1Description: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading2: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading2Description: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading3: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading3Description: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading4: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading4Description: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading5: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading5Description: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading6: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    heading6Description: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    blockquote: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    blockquoteDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    codeblock: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    codeblockDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    infoPanel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    infoPanelDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    notePanel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    notePanelDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    successPanel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    successPanelDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    warningPanel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    warningPanelDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    errorPanel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    errorPanelDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    customPanel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    customPanelDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    other: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/messages/card.d.ts

@@ -0,0 +1,87 @@
+export declare const messages: {
+    url: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    block: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    inline: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    embed: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    link: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    card: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    blockCardUnavailable: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    displayOptionUnavailableInParentNode: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    urlTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    blockTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    inlineTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    embedTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    urlDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    blockDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    inlineDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    embedDescription: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    datasourceTitle: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/messages/codeBidiWarning.d.ts

@@ -0,0 +1,11 @@
+export declare const codeBidiWarningMessages: {
+    /**
+     * Message taken from
+     * https://hello.atlassian.net/wiki/spaces/~tswan/pages/1366555782/PSHELP-2943+Investigate+Trojan+Source+Attack+Vulnerability+design
+     */
+    label: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/messages/codeBlockButton.d.ts

@@ -0,0 +1,22 @@
+export declare const codeBlockButtonMessages: {
+    copyCodeToClipboard: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    copiedCodeToClipboard: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    wrapCode: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    unwrapCode: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};

package/dist/types-ts4.5/messages/full-page.d.ts

@@ -0,0 +1,17 @@
+export declare const messages: {
+    toolbarLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    pageActionsLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+    editableContentLabel: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};