@atlaskit/editor-plugin-show-diff 20.0.10 → 20.0.11

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 20.0.11
+
+### Patch Changes
+
+- [`d9cd5128c24dc`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d9cd5128c24dc) -
+  Add gated Include excerpt attribute comparison for platform_editor_normalize_excerpt_diff without
+  changing source documents
+- Updated dependencies
+
 ## 20.0.10
 
 ### Patch Changes

package/dist/cjs/pm-plugins/calculateDiff/attrAwareTokenEncoder.js

@@ -5,7 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.attrAwareTokenEncoder = void 0;
 var _nodeTypeUtils = require("@atlaskit/editor-common/utils/node-type-utils");
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _diffableAttrs = require("../decorations/utils/diffableAttrs");
+var _excerptIncludeAttrs = require("../decorations/utils/excerptIncludeAttrs");
 var _encodeCharacterWithMarks = require("./encodeCharacterWithMarks");
 /**
  * Attribute-aware token encoder for `prosemirror-changeset`. The default encoder
@@ -16,14 +18,12 @@ var _encodeCharacterWithMarks = require("./encodeCharacterWithMarks");
  */
 
 // Stable composite token; attr names are pre-ordered by the caller.
-var encodeNodeWithAttrs = function encodeNodeWithAttrs(node, attrNames) {
-  var _node$attrs;
-  var attrs = (_node$attrs = node.attrs) !== null && _node$attrs !== void 0 ? _node$attrs : {};
+var encodeNodeWithAttrs = function encodeNodeWithAttrs(nodeTypeName, attrs, attrNames) {
   var parts = attrNames.map(function (name) {
     var _attrs$name;
     return "".concat(name, "=").concat(JSON.stringify((_attrs$name = attrs[name]) !== null && _attrs$name !== void 0 ? _attrs$name : null));
   });
-  return "".concat(node.type.name, "|").concat(parts.join('|'));
+  return "".concat(nodeTypeName, "|").concat(parts.join('|'));
 };
 
 // Like the library default, but node types with a `diffableAttrs` rule fold their
@@ -34,11 +34,13 @@ var attrAwareTokenEncoder = exports.attrAwareTokenEncoder = {
     return (0, _encodeCharacterWithMarks.encodeCharacterWithMarks)(char, marks);
   },
   encodeNodeStart: function encodeNodeStart(node) {
-    var _node$attrs2;
+    // A one-sided reference is not comparable from an isolated token. Attribute-step comparison
+    // checks the reference when both versions have one.
+    var attrs = (0, _fg.fg)('platform_editor_normalize_excerpt_diff') && node.type.name === 'extension' && (0, _excerptIncludeAttrs.isExcerptInclude)(node.attrs) ? (0, _excerptIncludeAttrs.getComparableExcerptIncludeAttrs)(node.attrs) : node.attrs;
     // Normalise variants (e.g. `panel_c1` → `panel`) so `diffableAttrs` needs one entry.
-    var attrNames = (0, _diffableAttrs.getDiffableAttrNames)((0, _nodeTypeUtils.getBaseNodeTypeName)(node.type), (_node$attrs2 = node.attrs) !== null && _node$attrs2 !== void 0 ? _node$attrs2 : {});
+    var attrNames = (0, _diffableAttrs.getDiffableAttrNames)((0, _nodeTypeUtils.getBaseNodeTypeName)(node.type), attrs !== null && attrs !== void 0 ? attrs : {});
     if (attrNames && attrNames.length > 0) {
-      return encodeNodeWithAttrs(node, attrNames);
+      return encodeNodeWithAttrs(node.type.name, attrs, attrNames);
     }
     return node.type.name;
   },

package/dist/cjs/pm-plugins/decorations/utils/excerptIncludeAttrs.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isExcerptInclude = exports.getReferencedContentId = exports.getComparableExcerptIncludeAttrs = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _pick = _interopRequireDefault(require("lodash/pick"));
+var asRecord = function asRecord(value) {
+  return value !== null && (0, _typeof2.default)(value) === 'object' && !Array.isArray(value) ? value : undefined;
+};
+var isExcerptInclude = exports.isExcerptInclude = function isExcerptInclude(attrs) {
+  return attrs.extensionKey === 'excerpt-include';
+};
+var getReferencedContentId = exports.getReferencedContentId = function getReferencedContentId(attrs) {
+  var _asRecord;
+  var parameters = asRecord(attrs.parameters);
+  var macroParams = asRecord(parameters === null || parameters === void 0 ? void 0 : parameters.macroParams);
+  var value = (_asRecord = asRecord(macroParams === null || macroParams === void 0 ? void 0 : macroParams._referencedContentId)) === null || _asRecord === void 0 ? void 0 : _asRecord.value;
+  return typeof value === 'string' ? value : undefined;
+};
+
+/** Compare macro identity and authored options, excluding publish-time rendering metadata. */
+var getComparableExcerptIncludeAttrs = exports.getComparableExcerptIncludeAttrs = function getComparableExcerptIncludeAttrs(attrs) {
+  return (0, _pick.default)(attrs, ['extensionType', 'layout', 'parameters.macroMetadata.macroId.value', 'parameters.macroParams[""].value', 'parameters.macroParams.name.value', 'parameters.macroParams.nopanel.value', 'parameters.macroParams.inline.value']);
+};

package/dist/cjs/pm-plugins/decorations/utils/getAttrChangeRanges.js

@@ -11,7 +11,9 @@ var _omit = _interopRequireDefault(require("lodash/omit"));
 var _setAttrs = require("@atlaskit/adf-schema/steps/set-attrs");
 var _nodeTypeUtils = require("@atlaskit/editor-common/utils/node-type-utils");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _diffableAttrs = require("./diffableAttrs");
+var _excerptIncludeAttrs = require("./excerptIncludeAttrs");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var filterUndefined = function filterUndefined(x) {
@@ -51,6 +53,11 @@ var getComparableExtensionAttrs = function getComparableExtensionAttrs(node) {
   return (0, _omit.default)(node.attrs, transientExtensionAttrPaths);
 };
 var haveSameRelevantExtensionAttrs = function haveSameRelevantExtensionAttrs(beforeNode, afterNode) {
+  if ((0, _fg.fg)('platform_editor_normalize_excerpt_diff') && (0, _excerptIncludeAttrs.isExcerptInclude)(beforeNode.attrs) && (0, _excerptIncludeAttrs.isExcerptInclude)(afterNode.attrs)) {
+    var beforeReference = (0, _excerptIncludeAttrs.getReferencedContentId)(beforeNode.attrs);
+    var afterReference = (0, _excerptIncludeAttrs.getReferencedContentId)(afterNode.attrs);
+    return (0, _isEqual.default)((0, _excerptIncludeAttrs.getComparableExcerptIncludeAttrs)(beforeNode.attrs), (0, _excerptIncludeAttrs.getComparableExcerptIncludeAttrs)(afterNode.attrs)) && (beforeReference === undefined || afterReference === undefined || beforeReference === afterReference);
+  }
   return (0, _isEqual.default)(getComparableExtensionAttrs(beforeNode), getComparableExtensionAttrs(afterNode));
 };
 var getStepAttrs = function getStepAttrs(step) {

package/dist/es2019/pm-plugins/calculateDiff/attrAwareTokenEncoder.js

@@ -1,5 +1,7 @@
 import { getBaseNodeTypeName } from '@atlaskit/editor-common/utils/node-type-utils';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { getDiffableAttrNames } from '../decorations/utils/diffableAttrs';
+import { getComparableExcerptIncludeAttrs, isExcerptInclude } from '../decorations/utils/excerptIncludeAttrs';
 import { encodeCharacterWithMarks } from './encodeCharacterWithMarks';
 
 /**
@@ -11,14 +13,12 @@ import { encodeCharacterWithMarks } from './encodeCharacterWithMarks';
  */
 
 // Stable composite token; attr names are pre-ordered by the caller.
-const encodeNodeWithAttrs = (node, attrNames) => {
-  var _node$attrs;
-  const attrs = (_node$attrs = node.attrs) !== null && _node$attrs !== void 0 ? _node$attrs : {};
+const encodeNodeWithAttrs = (nodeTypeName, attrs, attrNames) => {
   const parts = attrNames.map(name => {
     var _attrs$name;
     return `${name}=${JSON.stringify((_attrs$name = attrs[name]) !== null && _attrs$name !== void 0 ? _attrs$name : null)}`;
   });
-  return `${node.type.name}|${parts.join('|')}`;
+  return `${nodeTypeName}|${parts.join('|')}`;
 };
 
 // Like the library default, but node types with a `diffableAttrs` rule fold their
@@ -27,11 +27,13 @@ const encodeNodeWithAttrs = (node, attrNames) => {
 export const attrAwareTokenEncoder = {
   encodeCharacter: (char, marks) => encodeCharacterWithMarks(char, marks),
   encodeNodeStart: node => {
-    var _node$attrs2;
+    // A one-sided reference is not comparable from an isolated token. Attribute-step comparison
+    // checks the reference when both versions have one.
+    const attrs = fg('platform_editor_normalize_excerpt_diff') && node.type.name === 'extension' && isExcerptInclude(node.attrs) ? getComparableExcerptIncludeAttrs(node.attrs) : node.attrs;
     // Normalise variants (e.g. `panel_c1` → `panel`) so `diffableAttrs` needs one entry.
-    const attrNames = getDiffableAttrNames(getBaseNodeTypeName(node.type), (_node$attrs2 = node.attrs) !== null && _node$attrs2 !== void 0 ? _node$attrs2 : {});
+    const attrNames = getDiffableAttrNames(getBaseNodeTypeName(node.type), attrs !== null && attrs !== void 0 ? attrs : {});
     if (attrNames && attrNames.length > 0) {
-      return encodeNodeWithAttrs(node, attrNames);
+      return encodeNodeWithAttrs(node.type.name, attrs, attrNames);
     }
     return node.type.name;
   },

package/dist/es2019/pm-plugins/decorations/utils/excerptIncludeAttrs.js

@@ -0,0 +1,13 @@
+import pick from 'lodash/pick';
+const asRecord = value => value !== null && typeof value === 'object' && !Array.isArray(value) ? value : undefined;
+export const isExcerptInclude = attrs => attrs.extensionKey === 'excerpt-include';
+export const getReferencedContentId = attrs => {
+  var _asRecord;
+  const parameters = asRecord(attrs.parameters);
+  const macroParams = asRecord(parameters === null || parameters === void 0 ? void 0 : parameters.macroParams);
+  const value = (_asRecord = asRecord(macroParams === null || macroParams === void 0 ? void 0 : macroParams._referencedContentId)) === null || _asRecord === void 0 ? void 0 : _asRecord.value;
+  return typeof value === 'string' ? value : undefined;
+};
+
+/** Compare macro identity and authored options, excluding publish-time rendering metadata. */
+export const getComparableExcerptIncludeAttrs = attrs => pick(attrs, ['extensionType', 'layout', 'parameters.macroMetadata.macroId.value', 'parameters.macroParams[""].value', 'parameters.macroParams.name.value', 'parameters.macroParams.nopanel.value', 'parameters.macroParams.inline.value']);

package/dist/es2019/pm-plugins/decorations/utils/getAttrChangeRanges.js

@@ -3,7 +3,9 @@ import omit from 'lodash/omit';
 import { SetAttrsStep } from '@atlaskit/adf-schema/steps/set-attrs';
 import { getBaseNodeTypeName } from '@atlaskit/editor-common/utils/node-type-utils';
 import { AttrStep } from '@atlaskit/editor-prosemirror/transform';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { getRequiredIncludedDiffableAttrs, isDiffableAttr } from './diffableAttrs';
+import { getComparableExcerptIncludeAttrs, getReferencedContentId, isExcerptInclude } from './excerptIncludeAttrs';
 const filterUndefined = x => !!x;
 
 // Attr lists sourced from the shared `diffableAttrs` map (shared with the encoder).
@@ -34,7 +36,14 @@ const transientExtensionAttrPaths = ['localId', 'parameters.macroParams._parentI
  * extension's user-visible configuration.
  */
 const getComparableExtensionAttrs = node => omit(node.attrs, transientExtensionAttrPaths);
-const haveSameRelevantExtensionAttrs = (beforeNode, afterNode) => isEqual(getComparableExtensionAttrs(beforeNode), getComparableExtensionAttrs(afterNode));
+const haveSameRelevantExtensionAttrs = (beforeNode, afterNode) => {
+  if (fg('platform_editor_normalize_excerpt_diff') && isExcerptInclude(beforeNode.attrs) && isExcerptInclude(afterNode.attrs)) {
+    const beforeReference = getReferencedContentId(beforeNode.attrs);
+    const afterReference = getReferencedContentId(afterNode.attrs);
+    return isEqual(getComparableExcerptIncludeAttrs(beforeNode.attrs), getComparableExcerptIncludeAttrs(afterNode.attrs)) && (beforeReference === undefined || afterReference === undefined || beforeReference === afterReference);
+  }
+  return isEqual(getComparableExtensionAttrs(beforeNode), getComparableExtensionAttrs(afterNode));
+};
 const getStepAttrs = step => {
   if (step instanceof AttrStep) {
     return [step.attr];

package/dist/esm/pm-plugins/calculateDiff/attrAwareTokenEncoder.js

@@ -1,5 +1,7 @@
 import { getBaseNodeTypeName } from '@atlaskit/editor-common/utils/node-type-utils';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { getDiffableAttrNames } from '../decorations/utils/diffableAttrs';
+import { getComparableExcerptIncludeAttrs, isExcerptInclude } from '../decorations/utils/excerptIncludeAttrs';
 import { encodeCharacterWithMarks } from './encodeCharacterWithMarks';
 
 /**
@@ -11,14 +13,12 @@ import { encodeCharacterWithMarks } from './encodeCharacterWithMarks';
  */
 
 // Stable composite token; attr names are pre-ordered by the caller.
-var encodeNodeWithAttrs = function encodeNodeWithAttrs(node, attrNames) {
-  var _node$attrs;
-  var attrs = (_node$attrs = node.attrs) !== null && _node$attrs !== void 0 ? _node$attrs : {};
+var encodeNodeWithAttrs = function encodeNodeWithAttrs(nodeTypeName, attrs, attrNames) {
   var parts = attrNames.map(function (name) {
     var _attrs$name;
     return "".concat(name, "=").concat(JSON.stringify((_attrs$name = attrs[name]) !== null && _attrs$name !== void 0 ? _attrs$name : null));
   });
-  return "".concat(node.type.name, "|").concat(parts.join('|'));
+  return "".concat(nodeTypeName, "|").concat(parts.join('|'));
 };
 
 // Like the library default, but node types with a `diffableAttrs` rule fold their
@@ -29,11 +29,13 @@ export var attrAwareTokenEncoder = {
     return encodeCharacterWithMarks(char, marks);
   },
   encodeNodeStart: function encodeNodeStart(node) {
-    var _node$attrs2;
+    // A one-sided reference is not comparable from an isolated token. Attribute-step comparison
+    // checks the reference when both versions have one.
+    var attrs = fg('platform_editor_normalize_excerpt_diff') && node.type.name === 'extension' && isExcerptInclude(node.attrs) ? getComparableExcerptIncludeAttrs(node.attrs) : node.attrs;
     // Normalise variants (e.g. `panel_c1` → `panel`) so `diffableAttrs` needs one entry.
-    var attrNames = getDiffableAttrNames(getBaseNodeTypeName(node.type), (_node$attrs2 = node.attrs) !== null && _node$attrs2 !== void 0 ? _node$attrs2 : {});
+    var attrNames = getDiffableAttrNames(getBaseNodeTypeName(node.type), attrs !== null && attrs !== void 0 ? attrs : {});
     if (attrNames && attrNames.length > 0) {
-      return encodeNodeWithAttrs(node, attrNames);
+      return encodeNodeWithAttrs(node.type.name, attrs, attrNames);
     }
     return node.type.name;
   },

package/dist/esm/pm-plugins/decorations/utils/excerptIncludeAttrs.js

@@ -0,0 +1,20 @@
+import _typeof from "@babel/runtime/helpers/typeof";
+import pick from 'lodash/pick';
+var asRecord = function asRecord(value) {
+  return value !== null && _typeof(value) === 'object' && !Array.isArray(value) ? value : undefined;
+};
+export var isExcerptInclude = function isExcerptInclude(attrs) {
+  return attrs.extensionKey === 'excerpt-include';
+};
+export var getReferencedContentId = function getReferencedContentId(attrs) {
+  var _asRecord;
+  var parameters = asRecord(attrs.parameters);
+  var macroParams = asRecord(parameters === null || parameters === void 0 ? void 0 : parameters.macroParams);
+  var value = (_asRecord = asRecord(macroParams === null || macroParams === void 0 ? void 0 : macroParams._referencedContentId)) === null || _asRecord === void 0 ? void 0 : _asRecord.value;
+  return typeof value === 'string' ? value : undefined;
+};
+
+/** Compare macro identity and authored options, excluding publish-time rendering metadata. */
+export var getComparableExcerptIncludeAttrs = function getComparableExcerptIncludeAttrs(attrs) {
+  return pick(attrs, ['extensionType', 'layout', 'parameters.macroMetadata.macroId.value', 'parameters.macroParams[""].value', 'parameters.macroParams.name.value', 'parameters.macroParams.nopanel.value', 'parameters.macroParams.inline.value']);
+};

package/dist/esm/pm-plugins/decorations/utils/getAttrChangeRanges.js

@@ -6,7 +6,9 @@ import omit from 'lodash/omit';
 import { SetAttrsStep } from '@atlaskit/adf-schema/steps/set-attrs';
 import { getBaseNodeTypeName } from '@atlaskit/editor-common/utils/node-type-utils';
 import { AttrStep } from '@atlaskit/editor-prosemirror/transform';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { getRequiredIncludedDiffableAttrs, isDiffableAttr } from './diffableAttrs';
+import { getComparableExcerptIncludeAttrs, getReferencedContentId, isExcerptInclude } from './excerptIncludeAttrs';
 var filterUndefined = function filterUndefined(x) {
   return !!x;
 };
@@ -44,6 +46,11 @@ var getComparableExtensionAttrs = function getComparableExtensionAttrs(node) {
   return omit(node.attrs, transientExtensionAttrPaths);
 };
 var haveSameRelevantExtensionAttrs = function haveSameRelevantExtensionAttrs(beforeNode, afterNode) {
+  if (fg('platform_editor_normalize_excerpt_diff') && isExcerptInclude(beforeNode.attrs) && isExcerptInclude(afterNode.attrs)) {
+    var beforeReference = getReferencedContentId(beforeNode.attrs);
+    var afterReference = getReferencedContentId(afterNode.attrs);
+    return isEqual(getComparableExcerptIncludeAttrs(beforeNode.attrs), getComparableExcerptIncludeAttrs(afterNode.attrs)) && (beforeReference === undefined || afterReference === undefined || beforeReference === afterReference);
+  }
   return isEqual(getComparableExtensionAttrs(beforeNode), getComparableExtensionAttrs(afterNode));
 };
 var getStepAttrs = function getStepAttrs(step) {

package/dist/types/pm-plugins/decorations/utils/excerptIncludeAttrs.d.ts

@@ -0,0 +1,6 @@
+type ExtensionAttrs = Record<string, unknown>;
+export declare const isExcerptInclude: (attrs: ExtensionAttrs) => boolean;
+export declare const getReferencedContentId: (attrs: ExtensionAttrs) => string | undefined;
+/** Compare macro identity and authored options, excluding publish-time rendering metadata. */
+export declare const getComparableExcerptIncludeAttrs: (attrs: ExtensionAttrs) => ExtensionAttrs;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "20.0.10",
+	"version": "20.0.11",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -99,6 +99,9 @@
 		"confluence_ncs_step_diffing_version_history": {
 			"type": "boolean"
 		},
+		"platform_editor_normalize_excerpt_diff": {
+			"type": "boolean"
+		},
 		"platform_editor_diff_inline_mark_changes": {
 			"type": "boolean"
 		}