@atlaskit/editor-common 108.3.1 → 108.4.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-common
 
+## 108.4.0
+
+### Minor Changes
+
+- [`d9be3a6937275`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d9be3a6937275) -
+  Add the list of ancestor node types to the result of applyAnnotation, to make it easier to debug
+  comments errors
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 108.3.1
 
 ### Patch Changes

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "108.3.0";
+var packageVersion = "108.3.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "108.3.0";
+var packageVersion = "108.3.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/cjs/utils/annotation/index.js

@@ -9,6 +9,7 @@ exports.containsAnyAnnotations = containsAnyAnnotations;
 exports.getAnnotationIdsFromRange = void 0;
 exports.getAnnotationInlineNodeTypes = getAnnotationInlineNodeTypes;
 exports.getAnnotationMarksForPos = getAnnotationMarksForPos;
+exports.getRangeAncestorNodeNames = getRangeAncestorNodeNames;
 exports.getRangeInlineNodeNames = getRangeInlineNodeNames;
 exports.hasAnnotationMark = hasAnnotationMark;
 exports.isEmptyTextSelection = isEmptyTextSelection;
@@ -129,6 +130,62 @@ function getRangeInlineNodeNames(_ref) {
   }
 }
 
+/**
+ * This returns a list of ancestor node names that contain the given position.
+ */
+function getRangeAncestorNodeNames(_ref2) {
+  var doc = _ref2.doc,
+    pos = _ref2.pos;
+  if (!(0, _platformFeatureFlags.fg)('cc_comments_log_draft_annotation_ancestor_nodes')) {
+    return undefined;
+  }
+  var nodeNames = new Set();
+  try {
+    // For a range, we can get ancestors at both from and to positions
+    // or just use the from position if you want ancestors at the start
+    var resolvedFromPos = doc.resolve(pos.from);
+    var resolvedToPos = doc.resolve(pos.to);
+
+    // Collect ancestors at the 'from' position
+    for (var depth = resolvedFromPos.depth; depth > 0; depth--) {
+      var ancestorNode = resolvedFromPos.node(depth);
+      nodeNames.add(ancestorNode.type.name);
+    }
+
+    // Use nodesBetween to collect parent types without additional resolve() calls
+    // This isn't as precise as calling resolve() on each parent, but it's a lot faster
+    // and should hopefully provide a good approximation of the ancestor nodes
+    var seenParents = new Set();
+    doc.nodesBetween(pos.from, pos.to, function (node, nodePos, parent) {
+      // Collect parent chain using the parent parameter
+      var currentParent = parent;
+      if (!!currentParent && !seenParents.has(currentParent)) {
+        seenParents.add(currentParent);
+        nodeNames.add(currentParent.type.name);
+        // Note: We can't easily get the parent's parent from this context
+        // without additional resolve calls, so this approach has limitations
+      }
+      return true;
+    });
+
+    // Optionally collect ancestors at the 'to' position if different
+    // This ensures we capture all ancestor contexts across the range
+    if (pos.from !== pos.to) {
+      for (var _depth = resolvedToPos.depth; _depth > 0; _depth--) {
+        var _ancestorNode = resolvedToPos.node(_depth);
+        nodeNames.add(_ancestorNode.type.name);
+      }
+    }
+    return (0, _toConsumableArray2.default)(nodeNames);
+  } catch (_unused2) {
+    // Some callers have existing gaps where the positions are not valid,
+    // and so when called in the current document can throw an error if out of range.
+    //
+    // This is a defensive check to ensure we don't throw an error in those cases.
+    return undefined;
+  }
+}
+
 /**
  * This function returns a list of node types that are wrapped by an annotation mark.
  *

package/dist/cjs/utils/index.js

@@ -534,6 +534,12 @@ Object.defineProperty(exports, "getPropsDifference", {
     return _compareProps.getPropsDifference;
   }
 });
+Object.defineProperty(exports, "getRangeAncestorNodeNames", {
+  enumerable: true,
+  get: function get() {
+    return _annotation.getRangeAncestorNodeNames;
+  }
+});
 Object.defineProperty(exports, "getRangeInlineNodeNames", {
   enumerable: true,
   get: function get() {

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "108.3.0";
+const packageVersion = "108.3.1";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/ui/DropList/index.js

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "108.3.0";
+const packageVersion = "108.3.1";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/es2019/utils/annotation/index.js

@@ -124,6 +124,63 @@ export function getRangeInlineNodeNames({
   }
 }
 
+/**
+ * This returns a list of ancestor node names that contain the given position.
+ */
+export function getRangeAncestorNodeNames({
+  doc,
+  pos
+}) {
+  if (!fg('cc_comments_log_draft_annotation_ancestor_nodes')) {
+    return undefined;
+  }
+  const nodeNames = new Set();
+  try {
+    // For a range, we can get ancestors at both from and to positions
+    // or just use the from position if you want ancestors at the start
+    const resolvedFromPos = doc.resolve(pos.from);
+    const resolvedToPos = doc.resolve(pos.to);
+
+    // Collect ancestors at the 'from' position
+    for (let depth = resolvedFromPos.depth; depth > 0; depth--) {
+      const ancestorNode = resolvedFromPos.node(depth);
+      nodeNames.add(ancestorNode.type.name);
+    }
+
+    // Use nodesBetween to collect parent types without additional resolve() calls
+    // This isn't as precise as calling resolve() on each parent, but it's a lot faster
+    // and should hopefully provide a good approximation of the ancestor nodes
+    const seenParents = new Set();
+    doc.nodesBetween(pos.from, pos.to, (node, nodePos, parent) => {
+      // Collect parent chain using the parent parameter
+      const currentParent = parent;
+      if (!!currentParent && !seenParents.has(currentParent)) {
+        seenParents.add(currentParent);
+        nodeNames.add(currentParent.type.name);
+        // Note: We can't easily get the parent's parent from this context
+        // without additional resolve calls, so this approach has limitations
+      }
+      return true;
+    });
+
+    // Optionally collect ancestors at the 'to' position if different
+    // This ensures we capture all ancestor contexts across the range
+    if (pos.from !== pos.to) {
+      for (let depth = resolvedToPos.depth; depth > 0; depth--) {
+        const ancestorNode = resolvedToPos.node(depth);
+        nodeNames.add(ancestorNode.type.name);
+      }
+    }
+    return [...nodeNames];
+  } catch {
+    // Some callers have existing gaps where the positions are not valid,
+    // and so when called in the current document can throw an error if out of range.
+    //
+    // This is a defensive check to ensure we don't throw an error in those cases.
+    return undefined;
+  }
+}
+
 /**
  * This function returns a list of node types that are wrapped by an annotation mark.
  *

package/dist/es2019/utils/index.js

@@ -5,7 +5,7 @@ import { hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { hasDocAsParent } from './document';
 import { isEmptyParagraph } from './editor-core-utils';
 export { shouldAutoLinkifyMatch } from './should-auto-linkify-tld';
-export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer } from './annotation';
+export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, getRangeAncestorNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export {
 /**

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "108.3.0";
+var packageVersion = "108.3.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/ui/DropList/index.js

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "108.3.0";
+var packageVersion = "108.3.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/esm/utils/annotation/index.js

@@ -114,6 +114,62 @@ export function getRangeInlineNodeNames(_ref) {
   }
 }
 
+/**
+ * This returns a list of ancestor node names that contain the given position.
+ */
+export function getRangeAncestorNodeNames(_ref2) {
+  var doc = _ref2.doc,
+    pos = _ref2.pos;
+  if (!fg('cc_comments_log_draft_annotation_ancestor_nodes')) {
+    return undefined;
+  }
+  var nodeNames = new Set();
+  try {
+    // For a range, we can get ancestors at both from and to positions
+    // or just use the from position if you want ancestors at the start
+    var resolvedFromPos = doc.resolve(pos.from);
+    var resolvedToPos = doc.resolve(pos.to);
+
+    // Collect ancestors at the 'from' position
+    for (var depth = resolvedFromPos.depth; depth > 0; depth--) {
+      var ancestorNode = resolvedFromPos.node(depth);
+      nodeNames.add(ancestorNode.type.name);
+    }
+
+    // Use nodesBetween to collect parent types without additional resolve() calls
+    // This isn't as precise as calling resolve() on each parent, but it's a lot faster
+    // and should hopefully provide a good approximation of the ancestor nodes
+    var seenParents = new Set();
+    doc.nodesBetween(pos.from, pos.to, function (node, nodePos, parent) {
+      // Collect parent chain using the parent parameter
+      var currentParent = parent;
+      if (!!currentParent && !seenParents.has(currentParent)) {
+        seenParents.add(currentParent);
+        nodeNames.add(currentParent.type.name);
+        // Note: We can't easily get the parent's parent from this context
+        // without additional resolve calls, so this approach has limitations
+      }
+      return true;
+    });
+
+    // Optionally collect ancestors at the 'to' position if different
+    // This ensures we capture all ancestor contexts across the range
+    if (pos.from !== pos.to) {
+      for (var _depth = resolvedToPos.depth; _depth > 0; _depth--) {
+        var _ancestorNode = resolvedToPos.node(_depth);
+        nodeNames.add(_ancestorNode.type.name);
+      }
+    }
+    return _toConsumableArray(nodeNames);
+  } catch (_unused2) {
+    // Some callers have existing gaps where the positions are not valid,
+    // and so when called in the current document can throw an error if out of range.
+    //
+    // This is a defensive check to ensure we don't throw an error in those cases.
+    return undefined;
+  }
+}
+
 /**
  * This function returns a list of node types that are wrapped by an annotation mark.
  *

package/dist/esm/utils/index.js

@@ -5,7 +5,7 @@ import { hasParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
 import { hasDocAsParent } from './document';
 import { isEmptyParagraph } from './editor-core-utils';
 export { shouldAutoLinkifyMatch } from './should-auto-linkify-tld';
-export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer } from './annotation';
+export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, getRangeAncestorNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export {
 /**

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

@@ -18,6 +18,8 @@ type AnnotationByMatches = {
     pos?: number;
 };
 export type ActionResult = {
+    /** The list of types of all nodes, which wrap the annotation. */
+    ancestorNodeTypes?: string[];
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

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

@@ -15,6 +15,8 @@ type ActionResult = {
     step: RemoveMarkStep | RemoveNodeMarkStep;
 } | false;
 export type AnnotationActionResult = ({
+    /** The list of types of all nodes, which wrap the annotation. */
+    ancestorNodeTypes?: string[];
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

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

@@ -18,6 +18,16 @@ export declare function getRangeInlineNodeNames({ doc, pos, }: {
         to: number;
     };
 }): string[] | undefined;
+/**
+ * This returns a list of ancestor node names that contain the given position.
+ */
+export declare function getRangeAncestorNodeNames({ doc, pos, }: {
+    doc: PMNode;
+    pos: {
+        from: number;
+        to: number;
+    };
+}): string[] | undefined;
 /**
  * This function returns a list of node types that are wrapped by an annotation mark.
  *

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

@@ -2,7 +2,7 @@ import type { Node as PMNode, ResolvedPos, Schema } from '@atlaskit/editor-prose
 import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
 import type { ContentNodeWithPos } from '@atlaskit/editor-prosemirror/utils';
 export { shouldAutoLinkifyMatch } from './should-auto-linkify-tld';
-export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer, } from './annotation';
+export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, getRangeAncestorNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer, } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export type { Params } from './macro';
 export { 

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

@@ -18,6 +18,8 @@ type AnnotationByMatches = {
     pos?: number;
 };
 export type ActionResult = {
+    /** The list of types of all nodes, which wrap the annotation. */
+    ancestorNodeTypes?: string[];
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

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

@@ -15,6 +15,8 @@ type ActionResult = {
     step: RemoveMarkStep | RemoveNodeMarkStep;
 } | false;
 export type AnnotationActionResult = ({
+    /** The list of types of all nodes, which wrap the annotation. */
+    ancestorNodeTypes?: string[];
     doc: JSONDocNode;
     /** The list of types of all inline nodes, which were wrapped by annotation. */
     inlineNodeTypes?: string[];

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

@@ -18,6 +18,16 @@ export declare function getRangeInlineNodeNames({ doc, pos, }: {
         to: number;
     };
 }): string[] | undefined;
+/**
+ * This returns a list of ancestor node names that contain the given position.
+ */
+export declare function getRangeAncestorNodeNames({ doc, pos, }: {
+    doc: PMNode;
+    pos: {
+        from: number;
+        to: number;
+    };
+}): string[] | undefined;
 /**
  * This function returns a list of node types that are wrapped by an annotation mark.
  *

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

@@ -2,7 +2,7 @@ import type { Node as PMNode, ResolvedPos, Schema } from '@atlaskit/editor-prose
 import type { EditorState, Selection } from '@atlaskit/editor-prosemirror/state';
 import type { ContentNodeWithPos } from '@atlaskit/editor-prosemirror/utils';
 export { shouldAutoLinkifyMatch } from './should-auto-linkify-tld';
-export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer, } from './annotation';
+export { getAnnotationMarksForPos, canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, getRangeAncestorNodeNames, isEmptyTextSelection, isEmptyTextSelectionRenderer, } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export type { Params } from './macro';
 export { 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "108.3.1",
+	"version": "108.4.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -169,7 +169,7 @@
 		"@atlaskit/profilecard": "^24.10.0",
 		"@atlaskit/react-ufo": "^4.5.0",
 		"@atlaskit/section-message": "^8.7.0",
-		"@atlaskit/smart-card": "^40.19.0",
+		"@atlaskit/smart-card": "^40.20.0",
 		"@atlaskit/smart-user-picker": "^8.2.0",
 		"@atlaskit/spinner": "^19.0.0",
 		"@atlaskit/status": "^3.0.0",
@@ -339,6 +339,9 @@
 		"confluence_connect_macro_preset_height": {
 			"type": "boolean"
 		},
+		"cc_comments_log_draft_annotation_ancestor_nodes": {
+			"type": "boolean"
+		},
 		"platform_editor_breakout_resizing_hello_release": {
 			"type": "boolean"
 		},