@atlaskit/editor-common 74.0.1 → 74.1.1

package/dist/esm/utils/hyperlink.js

@@ -0,0 +1,184 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+// File has been copied to packages/editor/editor-plugin-ai/src/provider/markdown-transformer/utils/hyperlink.ts
+// If changes are made to this file, please make the same update in the linked file.
+
+import { isSafeUrl, linkify, normalizeUrl as normaliseLinkHref } from '@atlaskit/adf-schema';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '../analytics/types';
+import { mapSlice } from './slice';
+
+// Regular expression for a windows filepath in the format <DRIVE LETTER>:\<folder name>\
+export var FILEPATH_REGEXP = /([a-zA-Z]:|\\)([^\/:*?<>"|]+\\)?([^\/:*?<>"| ]+(?=\s?))?/gim;
+
+// Don't linkify if starts with $ or {
+export var DONTLINKIFY_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 var LinkMatcher = /*#__PURE__*/function () {
+  function LinkMatcher() {
+    _classCallCheck(this, LinkMatcher);
+  }
+  _createClass(LinkMatcher, null, [{
+    key: "create",
+    value: function create() {
+      var LinkMatcherRegex = /*#__PURE__*/function () {
+        function LinkMatcherRegex() {
+          _classCallCheck(this, LinkMatcherRegex);
+        }
+        _createClass(LinkMatcherRegex, [{
+          key: "exec",
+          value: function exec(str) {
+            var stringsBySpace = str.slice(0, str.length - 1).split(' ');
+            var lastStringBeforeSpace = stringsBySpace[stringsBySpace.length - 1];
+            var isLastStringValid = lastStringBeforeSpace.length > 0;
+            if (!str.endsWith(' ') || !isLastStringValid) {
+              return null;
+            }
+            if (DONTLINKIFY_REGEXP.test(lastStringBeforeSpace)) {
+              return null;
+            }
+            var links = linkify.match(lastStringBeforeSpace);
+            if (!links || links.length === 0) {
+              return null;
+            }
+            var lastMatch = links[links.length - 1];
+            var lastLink = links[links.length - 1];
+            lastLink.input = str.substring(lastMatch.index);
+            lastLink.length = lastLink.lastIndex - lastLink.index + 1;
+            lastLink.index = str.lastIndexOf(lastStringBeforeSpace) + lastMatch.index;
+            return lastLink;
+          }
+        }]);
+        return LinkMatcherRegex;
+      }();
+      return new LinkMatcherRegex();
+    }
+  }]);
+  return LinkMatcher;
+}();
+
+/**
+ * Adds protocol to url if needed.
+ */
+export function normalizeUrl(url) {
+  if (!url) {
+    return '';
+  }
+  if (isSafeUrl(url)) {
+    return url;
+  }
+  return normaliseLinkHref(url);
+}
+export function linkifyContent(schema) {
+  return function (slice) {
+    return mapSlice(slice, function (node, parent) {
+      var isAllowedInParent = !parent || parent.type !== schema.nodes.codeBlock;
+      var link = node.type.schema.marks.link;
+      if (link === undefined) {
+        throw new Error('Link not in schema - unable to linkify content');
+      }
+      if (isAllowedInParent && node.isText && !link.isInSet(node.marks)) {
+        var linkified = [];
+        var text = node.text;
+        var matches = findLinkMatches(text);
+        var pos = 0;
+        var filepaths = findFilepaths(text);
+        matches.forEach(function (match) {
+          if (isLinkInMatches(match.start, filepaths)) {
+            return;
+          }
+          if (match.start > 0) {
+            linkified.push(node.cut(pos, match.start));
+          }
+          linkified.push(node.cut(match.start, match.end).mark(link.create({
+            href: normalizeUrl(match.href)
+          }).addToSet(node.marks)));
+          pos = match.end;
+        });
+        if (pos < text.length) {
+          linkified.push(node.cut(pos));
+        }
+        return linkified;
+      }
+      return node;
+    });
+  };
+}
+export function getLinkDomain(url) {
+  // Remove protocol and www., if either exists
+  var withoutProtocol = url.toLowerCase().replace(/^(.*):\/\//, '');
+  var withoutWWW = withoutProtocol.replace(/^(www\.)/, '');
+
+  // Remove port, fragment, path, query string
+  return withoutWWW.replace(/[:\/?#](.*)$/, '');
+}
+export function isFromCurrentDomain(url) {
+  if (!window || !window.location) {
+    return false;
+  }
+  var currentDomain = window.location.hostname;
+  var linkDomain = getLinkDomain(url);
+  return currentDomain === linkDomain;
+}
+function findLinkMatches(text) {
+  var matches = [];
+  var linkMatches = text && linkify.match(text);
+  if (linkMatches && linkMatches.length > 0) {
+    linkMatches.forEach(function (match) {
+      matches.push({
+        start: match.index,
+        end: match.lastIndex,
+        title: match.raw,
+        href: match.url
+      });
+    });
+  }
+  return matches;
+}
+export var findFilepaths = function findFilepaths(text) {
+  var offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+  // Creation of a copy of the RegExp is necessary as lastIndex is stored on it when we run .exec()
+  var localRegExp = new RegExp(FILEPATH_REGEXP);
+  var match;
+  var matchesList = [];
+  var maxFilepathSize = 260;
+  while ((match = localRegExp.exec(text)) !== null) {
+    var start = match.index + offset;
+    var end = localRegExp.lastIndex + offset;
+    if (end - start > maxFilepathSize) {
+      end = start + maxFilepathSize;
+    } // We don't care about big strings of text that are pretending to be filepaths!!
+    matchesList.push({
+      startIndex: start,
+      endIndex: end
+    });
+  }
+  return matchesList;
+};
+export var isLinkInMatches = function isLinkInMatches(linkStart, matchesList) {
+  for (var i = 0; i < matchesList.length; i++) {
+    if (linkStart >= matchesList[i].startIndex && linkStart < matchesList[i].endIndex) {
+      return true;
+    }
+  }
+  return false;
+};
+export function getLinkCreationAnalyticsEvent(inputMethod, url) {
+  return {
+    action: ACTION.INSERTED,
+    actionSubject: ACTION_SUBJECT.DOCUMENT,
+    actionSubjectId: ACTION_SUBJECT_ID.LINK,
+    attributes: {
+      inputMethod: inputMethod,
+      fromCurrentDomain: isFromCurrentDomain(url)
+    },
+    eventType: EVENT_TYPE.TRACK,
+    nonPrivacySafeAttributes: {
+      linkDomain: getLinkDomain(url)
+    }
+  };
+}

package/dist/esm/utils/index.js

@@ -3,7 +3,7 @@ export { getExtensionLozengeData } from './macro';
 export { default as browser } from './browser';
 export { default as ErrorReporter } from './error-reporter';
 export { isPastDate, timestampToIsoFormat, timestampToString, timestampToTaskContext, timestampToUTCDate, todayTimestampInUTC } from './date';
-export { isElementInTableCell, isTextSelection, isLastItemMediaGroup, setNodeSelection, setTextSelection, nonNullable, stepAddsOneOf, stepHasSlice, extractSliceFromStep, isValidPosition } from './editor-core-utils';
+export { isElementInTableCell, isTextSelection, isLastItemMediaGroup, setNodeSelection, setTextSelection, nonNullable, stepAddsOneOf, stepHasSlice, extractSliceFromStep, isValidPosition, isEmptyParagraph } from './editor-core-utils';
 export { withImageLoader } from './imageLoader';
 export { absoluteBreakoutWidth, calcBreakoutWidth, calcWideWidth, breakoutConsts, calculateBreakoutStyles, calcBreakoutWidthPx } from './breakout';
 export { findChangedNodesFromTransaction, validNode, validateNodes, isType, isParagraph, isText, isLinkMark, SelectedState, isNodeSelectedOrInRange, isSupportedInParent, isMediaNode, isNodeBeforeMediaNode } from './nodes';
@@ -34,5 +34,8 @@ export { getShallowPropsDifference, getPropsDifference } from './compare-props';
 export { useComponentRenderTracking } from './performance/hooks/use-component-render-tracking';
 export { isOutdatedBrowser } from './outdated-browsers';
 export { isReferencedSource, removeConnectedNodes, getChildrenInfo, getNodeName } from './referentiality';
-export { sendLogs } from './sendLogs';
-export { getItemCounterDigitsSize, getOrderFromOrderedListNode, resolveOrder } from './list';
+export { getItemCounterDigitsSize, getOrderFromOrderedListNode, resolveOrder, isListNode, isParagraphNode, isListItemNode, isBulletList } from './list';
+export { isFromCurrentDomain, LinkMatcher, normalizeUrl, linkifyContent, getLinkDomain, findFilepaths, isLinkInMatches, FILEPATH_REGEXP, DONTLINKIFY_REGEXP, getLinkCreationAnalyticsEvent } from './hyperlink';
+
+// prosemirror-history does not export its plugin key
+export var pmHistoryPluginKey = 'history$';

package/dist/esm/utils/list.js

@@ -27,4 +27,16 @@ export var getItemCounterDigitsSize = function getItemCounterDigitsSize(options)
   var itemsCount = typeof options.itemsCount === 'number' ? options.itemsCount : 0;
   var largestCounter = order + (itemsCount - 1);
   return (_String = String(largestCounter)) === null || _String === void 0 ? void 0 : (_String$split = _String.split('.')) === null || _String$split === void 0 ? void 0 : (_String$split$ = _String$split[0]) === null || _String$split$ === void 0 ? void 0 : _String$split$.length;
-};
+};
+export function isListNode(node) {
+  return Boolean(node && node.type && ['orderedList', 'bulletList'].includes(node.type.name));
+}
+export function isParagraphNode(node) {
+  return Boolean(node && node.type && 'paragraph' === node.type.name);
+}
+export function isListItemNode(node) {
+  return Boolean(node && node.type && 'listItem' === node.type.name);
+}
+export function isBulletList(node) {
+  return Boolean(node && node.type && 'bulletList' === node.type.name);
+}

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.0.1",
+	"version": "74.1.1",
 	"sideEffects": false
 }

package/dist/types/analytics/api.d.ts

@@ -1,5 +1,5 @@
 import type { Transaction } from 'prosemirror-state';
 import type { AnalyticsEventPayload } from './types';
 export type EditorAnalyticsAPI = {
-    attachAnalyticsEvent: (payload: AnalyticsEventPayload) => (tr: Transaction) => boolean;
+    attachAnalyticsEvent: (payload: AnalyticsEventPayload, channel?: string) => (tr: Transaction) => boolean;
 };

package/dist/types/event-dispatcher/index.d.ts

@@ -3,7 +3,8 @@ export interface Listeners {
     [name: string]: Set<Listener>;
 }
 export type Listener<T = any> = (data: T) => void;
-export type Dispatch<T = any> = (eventName: PluginKey | string, data: T) => void;
+type EventName = PluginKey | string;
+export type Dispatch<T = any> = (eventName: EventName, data: T) => void;
 export declare class EventDispatcher<T = any> {
     private listeners;
     on(event: string, cb: Listener<T>): void;
@@ -17,3 +18,4 @@ export declare class EventDispatcher<T = any> {
  * to notify listeners about that plugin's state change.
  */
 export declare function createDispatch<T>(eventDispatcher: EventDispatcher<T>): Dispatch<T>;
+export {};

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

@@ -0,0 +1,25 @@
+import { Fragment, Node, NodeType } from 'prosemirror-model';
+import { EditorState, Transaction } from 'prosemirror-state';
+export type InsertableContent = Node | Fragment;
+export declare enum LookDirection {
+    Before = "before",
+    After = "after"
+}
+export declare const normaliseNestedLayout: ({ selection, doc }: EditorState | Transaction, node: Node) => Node<any>;
+export declare const safeInsert: (content: InsertableContent, position?: number) => (tr: Transaction) => Transaction<any> | null;
+/**
+ * Method extracted from typeahed plugin to be shared with the element browser on handling element insertion.
+ */
+export declare const insertSelectedItem: (maybeNode?: Node | Object | string | Fragment, opts?: {
+    selectInlineNode?: boolean;
+}) => (state: EditorState, tr: Transaction<any>, start: number) => Transaction<any>;
+/**
+ * ED-14584: Util to check if the destination node is a paragraph & the
+ * content being inserted is a valid child of the grandparent node.
+ * In this case, the destination node should split
+ */
+export declare const shouldSplitSelectedNodeOnNodeInsertion: ({ parentNodeType, grandParentNodeType, content, }: {
+    parentNodeType: NodeType<any>;
+    grandParentNodeType: NodeType<any>;
+    content: Node;
+}) => boolean;

package/dist/types/monitoring/error.d.ts

@@ -0,0 +1,4 @@
+import type { Primitive } from '@sentry/types';
+export declare const logException: (error: Error, tags?: {
+    [key: string]: Primitive;
+} | undefined) => Promise<boolean | undefined>;

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

@@ -0,0 +1 @@
+export { logException } from './error';

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

@@ -0,0 +1 @@
+export { md } from './md';

package/dist/types/paste/md-plugins/ignore-list-heading-md-plugin.d.ts

@@ -0,0 +1,2 @@
+import type MarkdownIt from 'markdown-it';
+export default function (md: MarkdownIt): void;

package/dist/types/paste/md-plugins/linkify-md-plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (md: any) => any;
+export default _default;

package/dist/types/paste/md-plugins/newline-md-plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (md: any) => any;
+export default _default;

package/dist/types/paste/md-plugins/paragraph-md-plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (md: any) => any;
+export default _default;

package/dist/types/paste/md.d.ts

@@ -0,0 +1,2 @@
+import MarkdownIt from 'markdown-it';
+export declare const md: MarkdownIt;

package/dist/types/resizer.d.ts

@@ -0,0 +1 @@
+export { default as ResizerNext } from './ui/Resizer';

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

@@ -22,3 +22,4 @@ export { DropdownMenuSharedCssClassName } from './shared/dropdown-menu';
 export { CodeBlockSharedCssClassName, codeBlockSharedStyles, codeBlockInListSafariFix, } from './shared/code-block';
 export { LAYOUT_SECTION_MARGIN, LAYOUT_COLUMN_PADDING } from './shared/layout';
 export { EXTENSION_PADDING, BODIED_EXT_PADDING } from './shared/extension';
+export { resizerStyles } from './shared/resizer';

package/dist/types/styles/shared/resizer.d.ts

@@ -0,0 +1,6 @@
+export declare const resizerItemClassName = "resizer-item";
+export declare const resizerHandleRightClassName = "resizer-handle-right";
+export declare const resizerHandleLeftClassName = "resizer-handle-left";
+export declare const resizerHandlePadding = 13;
+export declare const resizerHandleZIndex = 99;
+export declare const resizerStyles: import("@emotion/react").SerializedStyles;

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

@@ -29,7 +29,8 @@ export type { EditorReactContext } from './editor-react-context';
 export type { PMPluginFactoryParams, PMPluginFactory, PMPlugin, } from './plugin-factory';
 export type { NodeConfig, MarkConfig, NodeViewConfig, } from './prosemirror-config';
 export type { PluginsOptions, EditorPlugin, getPosHandler, getPosHandlerNode, } from './editor-plugin';
-export type { NextEditorPlugin, AllEditorPresetPluginTypes, PluginDependenciesAPI, ExtractPluginNameFromAllBuilderPlugins, SafePresetCheck, DefaultEditorPlugin, OptionalPlugin, PluginInjectionAPI, CreatePluginDependenciesAPI, NextEditorPluginMetadata, ExtractInjectionAPI, } from './next-editor-plugin';
+export type { NextEditorPlugin, AllEditorPresetPluginTypes, PluginDependenciesAPI, ExtractPluginNameFromAllBuilderPlugins, SafePresetCheck, DefaultEditorPlugin, OptionalPlugin, PluginInjectionAPI, CreatePluginDependenciesAPI, NextEditorPluginMetadata, ExtractInjectionAPI, ExtractPluginActions, } from './next-editor-plugin';
 export type IconProps = {
     label?: string;
 };
+export type { TTITracking, TransactionTracking, UITracking, CatchAllTracking, NodeViewTracking, BrowserFreezetracking, ProseMirrorRenderedTracking, InputTracking, ContentRetrievalTracking, OnChangeCallbackTracking, OnEditorReadyCallbackTracking, PasteTracking, RenderTracking, PerformanceTracking, } from './performance-tracking';

package/dist/types/types/next-editor-plugin.d.ts

@@ -52,7 +52,7 @@ type ExtractPluginConfigurationFromMetadata<Metadata> = 'pluginConfiguration' ex
 export type ExtractPluginDependencies<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginDependenciesFromMetadataWithoutOptionals<Metadata> : never : never;
 type ExtractPluginConfiguration<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginConfigurationFromMetadata<Metadata> : never : never;
 export type ExtractPluginSharedState<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractSharedStateFromMetadata<Metadata> : never : never;
-type ExtractPluginActions<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractActionsFromMetadata<Metadata> : never : never;
+export type ExtractPluginActions<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractActionsFromMetadata<Metadata> : never : never;
 type ExtractPluginName<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (...args: any) => DefaultEditorPlugin<infer PluginName, any> ? PluginName : never : never;
 type Unsubscribe = () => void;
 export type PluginDependenciesAPI<Plugin extends NextEditorPlugin<any, any>> = {