@atlaskit/editor-common 82.10.0 → 82.11.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-common
 
+## 82.11.0
+
+### Minor Changes
+
+- [#112275](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/112275)
+  [`6f3058e0347a3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/6f3058e0347a3) -
+  ED-23734 - add `getInlineNodeTypes` function to `InlineCommentViewComponentProps`
+
 ## 82.10.0
 
 ### Minor Changes

package/dist/cjs/monitoring/error.js

@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 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 = "82.10.0";
+var packageVersion = "82.11.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -20,7 +20,7 @@ var _Layer = _interopRequireDefault(require("../Layer"));
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } /** @jsx jsx */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "82.10.0";
+var packageVersion = "82.11.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

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

@@ -7,9 +7,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.canApplyAnnotationOnRange = void 0;
 exports.containsAnyAnnotations = containsAnyAnnotations;
 exports.getAnnotationIdsFromRange = void 0;
+exports.getAnnotationInlineNodeTypes = getAnnotationInlineNodeTypes;
 exports.getRangeInlineNodeNames = getRangeInlineNodeNames;
 exports.hasAnnotationMark = hasAnnotationMark;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _adfSchema = require("@atlaskit/adf-schema");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var canApplyAnnotationOnRange = exports.canApplyAnnotationOnRange = function canApplyAnnotationOnRange(rangeSelection, doc, schema) {
   var from = rangeSelection.from,
@@ -122,4 +124,32 @@ function getRangeInlineNodeNames(_ref) {
   // We sort the list alphabetically to make human consumption of the list easier (in tools like the analytics extension)
   var sortedNames = (0, _toConsumableArray2.default)(nodeNames).sort();
   return sortedNames;
+}
+
+/**
+ * This function returns a list of node types that are wrapped by an annotation mark.
+ *
+ * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+ *
+ * @todo: Do not forget to remove `undefined` when the
+ *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+ */
+function getAnnotationInlineNodeTypes(state, annotationId) {
+  if (!(0, _platformFeatureFlags.getBooleanFF)('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+    return undefined;
+  }
+  var mark = state.schema.marks.annotation.create({
+    id: annotationId,
+    annotationType: _adfSchema.AnnotationTypes.INLINE_COMMENT
+  });
+  var inlineNodeNames = new Set();
+  state.doc.descendants(function (node, pos) {
+    if (mark.isInSet(node.marks)) {
+      inlineNodeNames.add(node.type.name);
+    }
+    return true;
+  });
+
+  // This sorting is done to make human consumption easier (ie. in dev tools, test snapshots, analytics events, ...)
+  return (0, _toConsumableArray2.default)(inlineNodeNames).sort();
 }

package/dist/cjs/utils/index.js

@@ -402,6 +402,12 @@ Object.defineProperty(exports, "getAnnotationIdsFromRange", {
     return _annotation.getAnnotationIdsFromRange;
   }
 });
+Object.defineProperty(exports, "getAnnotationInlineNodeTypes", {
+  enumerable: true,
+  get: function get() {
+    return _annotation.getAnnotationInlineNodeTypes;
+  }
+});
 Object.defineProperty(exports, "getChangedNodes", {
   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 = "82.10.0";
+const packageVersion = "82.11.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -9,7 +9,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "82.10.0";
+const packageVersion = "82.11.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 class DropList extends Component {

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

@@ -1,3 +1,4 @@
+import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 export const canApplyAnnotationOnRange = (rangeSelection, doc, schema) => {
   const {
@@ -123,4 +124,32 @@ export function getRangeInlineNodeNames({
   // We sort the list alphabetically to make human consumption of the list easier (in tools like the analytics extension)
   const sortedNames = [...nodeNames].sort();
   return sortedNames;
+}
+
+/**
+ * This function returns a list of node types that are wrapped by an annotation mark.
+ *
+ * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+ *
+ * @todo: Do not forget to remove `undefined` when the
+ *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+ */
+export function getAnnotationInlineNodeTypes(state, annotationId) {
+  if (!getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+    return undefined;
+  }
+  const mark = state.schema.marks.annotation.create({
+    id: annotationId,
+    annotationType: AnnotationTypes.INLINE_COMMENT
+  });
+  const inlineNodeNames = new Set();
+  state.doc.descendants((node, pos) => {
+    if (mark.isInSet(node.marks)) {
+      inlineNodeNames.add(node.type.name);
+    }
+    return true;
+  });
+
+  // This sorting is done to make human consumption easier (ie. in dev tools, test snapshots, analytics events, ...)
+  return [...inlineNodeNames].sort();
 }

package/dist/es2019/utils/index.js

@@ -2,7 +2,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 { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, getRangeInlineNodeNames } from './annotation';
+export { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export { default as browser } from './browser';
 export { default as ErrorReporter } from './error-reporter';

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 = "82.10.0";
+var packageVersion = "82.11.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

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

@@ -17,7 +17,7 @@ import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@
 import { N0, N50A, N60A, N900 } from '@atlaskit/theme/colors';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "82.10.0";
+var packageVersion = "82.11.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

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

@@ -1,4 +1,5 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import { AnnotationTypes } from '@atlaskit/adf-schema';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 export var canApplyAnnotationOnRange = function canApplyAnnotationOnRange(rangeSelection, doc, schema) {
   var from = rangeSelection.from,
@@ -111,4 +112,32 @@ export function getRangeInlineNodeNames(_ref) {
   // We sort the list alphabetically to make human consumption of the list easier (in tools like the analytics extension)
   var sortedNames = _toConsumableArray(nodeNames).sort();
   return sortedNames;
+}
+
+/**
+ * This function returns a list of node types that are wrapped by an annotation mark.
+ *
+ * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+ *
+ * @todo: Do not forget to remove `undefined` when the
+ *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+ */
+export function getAnnotationInlineNodeTypes(state, annotationId) {
+  if (!getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz')) {
+    return undefined;
+  }
+  var mark = state.schema.marks.annotation.create({
+    id: annotationId,
+    annotationType: AnnotationTypes.INLINE_COMMENT
+  });
+  var inlineNodeNames = new Set();
+  state.doc.descendants(function (node, pos) {
+    if (mark.isInSet(node.marks)) {
+      inlineNodeNames.add(node.type.name);
+    }
+    return true;
+  });
+
+  // This sorting is done to make human consumption easier (ie. in dev tools, test snapshots, analytics events, ...)
+  return _toConsumableArray(inlineNodeNames).sort();
 }

package/dist/esm/utils/index.js

@@ -2,7 +2,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 { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, getRangeInlineNodeNames } from './annotation';
+export { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export { default as browser } from './browser';
 export { default as ErrorReporter } from './error-reporter';

package/dist/types/extensibility/ExtensionNodeWrapper.d.ts

@@ -1,7 +1,7 @@
 /** @jsx jsx */
 import React from 'react';
 import { jsx } from '@emotion/react';
-import type { MacroInteractionDesignFeatureFlags } from "./types";
+import type { MacroInteractionDesignFeatureFlags } from './types';
 type Props = {
     children: React.ReactNode;
     nodeType: string;

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

@@ -79,6 +79,16 @@ export type InlineCommentViewComponentProps = {
      */
     clickElementTarget?: HTMLElement;
     deleteAnnotation: (annotationInfo: AnnotationInfo) => ActionResult;
+    /**
+     * Return a list of inline node types, which are wrapped by the annotation,
+     * for annotation with given ID.
+     *
+     * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+     *
+     * @todo: Do not forget to remove `undefined` when the
+     *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+     */
+    getInlineNodeTypes: (annotationId: string) => string[] | undefined;
 };
 export type InlineCommentHoverComponentProps = {
     /**

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

@@ -18,4 +18,16 @@ export declare function getRangeInlineNodeNames({ doc, pos, }: {
         to: number;
     };
 }): string[] | undefined;
+/**
+ * This function returns a list of node types that are wrapped by an annotation mark.
+ *
+ * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+ *
+ * @todo: Do not forget to remove `undefined` when the
+ *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+ */
+export declare function getAnnotationInlineNodeTypes(state: {
+    doc: PMNode;
+    schema: Schema;
+}, annotationId: string): string[] | undefined;
 export {};

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 { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, getRangeInlineNodeNames, } from './annotation';
+export { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export type { Params } from './macro';
 export { default as browser } from './browser';

package/dist/types-ts4.5/extensibility/ExtensionNodeWrapper.d.ts

@@ -1,7 +1,7 @@
 /** @jsx jsx */
 import React from 'react';
 import { jsx } from '@emotion/react';
-import type { MacroInteractionDesignFeatureFlags } from "./types";
+import type { MacroInteractionDesignFeatureFlags } from './types';
 type Props = {
     children: React.ReactNode;
     nodeType: string;

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

@@ -79,6 +79,16 @@ export type InlineCommentViewComponentProps = {
      */
     clickElementTarget?: HTMLElement;
     deleteAnnotation: (annotationInfo: AnnotationInfo) => ActionResult;
+    /**
+     * Return a list of inline node types, which are wrapped by the annotation,
+     * for annotation with given ID.
+     *
+     * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+     *
+     * @todo: Do not forget to remove `undefined` when the
+     *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+     */
+    getInlineNodeTypes: (annotationId: string) => string[] | undefined;
 };
 export type InlineCommentHoverComponentProps = {
     /**

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

@@ -18,4 +18,16 @@ export declare function getRangeInlineNodeNames({ doc, pos, }: {
         to: number;
     };
 }): string[] | undefined;
+/**
+ * This function returns a list of node types that are wrapped by an annotation mark.
+ *
+ * The `undefined` will be returned if `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is off.
+ *
+ * @todo: Do not forget to remove `undefined` when the
+ *        `platform.editor.allow-inline-comments-for-inline-nodes-round-2_ctuxz` is removed.
+ */
+export declare function getAnnotationInlineNodeTypes(state: {
+    doc: PMNode;
+    schema: Schema;
+}, annotationId: string): string[] | undefined;
 export {};

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 { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, hasAnnotationMark, getRangeInlineNodeNames, } from './annotation';
+export { canApplyAnnotationOnRange, containsAnyAnnotations, getAnnotationIdsFromRange, getAnnotationInlineNodeTypes, hasAnnotationMark, getRangeInlineNodeNames, } from './annotation';
 export { getExtensionLozengeData } from './macro';
 export type { Params } from './macro';
 export { default as browser } from './browser';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "82.10.0",
+	"version": "82.11.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -136,7 +136,7 @@
 		"@atlaskit/task-decision": "^17.10.0",
 		"@atlaskit/textfield": "^6.4.0",
 		"@atlaskit/theme": "^12.11.0",
-		"@atlaskit/tokens": "^1.51.0",
+		"@atlaskit/tokens": "^1.52.0",
 		"@atlaskit/tooltip": "^18.5.0",
 		"@atlaskit/ufo": "^0.2.0",
 		"@atlaskit/width-detector": "^4.2.0",