@atlaskit/editor-plugin-show-diff 6.2.1 → 6.2.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-show-diff
 
+## 6.2.3
+
+### Patch Changes
+
+- [`c2b3bd8f1e4cb`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c2b3bd8f1e4cb) -
+  Enforce custom step registers for show diff plugin for consistency.
+
+## 6.2.2
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 6.2.1
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -21,6 +21,9 @@
 		{
 			"path": "../../adf-schema/afm-cc/tsconfig.json"
 		},
+		{
+			"path": "../../custom-steps/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-analytics/afm-cc/tsconfig.json"
 		},

package/afm-jira/tsconfig.json

@@ -21,6 +21,9 @@
 		{
 			"path": "../../adf-schema/afm-jira/tsconfig.json"
 		},
+		{
+			"path": "../../custom-steps/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-analytics/afm-jira/tsconfig.json"
 		},

package/afm-products/tsconfig.json

@@ -21,6 +21,9 @@
 		{
 			"path": "../../adf-schema/afm-products/tsconfig.json"
 		},
+		{
+			"path": "../../custom-steps/afm-products/tsconfig.json"
+		},
 		{
 			"path": "../../editor-plugin-analytics/afm-products/tsconfig.json"
 		},

package/dist/cjs/pm-plugins/enforceCustomStepRegisters.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.enforceCustomStepRegisters = void 0;
+var adfCustomSteps = _interopRequireWildcard(require("@atlaskit/adf-schema/steps"));
+var atlaskKitCustomSteps = _interopRequireWildcard(require("@atlaskit/custom-steps"));
+var _transform = require("@atlaskit/editor-prosemirror/transform");
+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); }
+// It is important to get all steps in that package
+// Ignored via go/ees005
+// eslint-disable-next-line import/no-namespace
+
+// It is important to get all steps in that package
+// Ignored via go/ees005
+// eslint-disable-next-line import/no-namespace
+
+var enforceCustomStepRegisters = exports.enforceCustomStepRegisters = function enforceCustomStepRegisters() {
+  var tryToRegisterStep = function tryToRegisterStep(obj) {
+    for (var _i = 0, _Object$values = Object.values(obj); _i < _Object$values.length; _i++) {
+      var _customStep$prototype;
+      var customStep = _Object$values[_i];
+      // @ts-expect-error ProseMirror step classes expose jsonID on prototype.
+      var id = customStep === null || customStep === void 0 || (_customStep$prototype = customStep.prototype) === null || _customStep$prototype === void 0 ? void 0 : _customStep$prototype.jsonID;
+      if (typeof id === 'string') {
+        try {
+          // Re-register if needed; ignore if already registered.
+          // @ts-expect-error Step.jsonID expects a step constructor.
+          _transform.Step.jsonID(id, customStep);
+        } catch (_unused) {
+          // Step already registered.
+        }
+      }
+    }
+  };
+
+  // @ts-expect-error Step modules export non-step symbols too.
+  tryToRegisterStep(atlaskKitCustomSteps);
+  // @ts-expect-error Step modules export non-step symbols too.
+  tryToRegisterStep(adfCustomSteps);
+};

package/dist/cjs/pm-plugins/main.js

@@ -14,6 +14,7 @@ var _view = require("@atlaskit/editor-prosemirror/view");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _calculateDiffDecorations = require("./calculateDiff/calculateDiffDecorations");
+var _enforceCustomStepRegisters = require("./enforceCustomStepRegisters");
 var _NodeViewSerializer = require("./NodeViewSerializer");
 var _scrollToActiveDecoration = require("./scrollToActiveDecoration");
 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; }
@@ -42,6 +43,9 @@ var getScrollableDecorations = exports.getScrollableDecorations = function getSc
   });
 };
 var createPlugin = exports.createPlugin = function createPlugin(config, getIntl, api) {
+  if ((0, _platformFeatureFlags.fg)('platform_editor_show_diff_equality_fallback')) {
+    (0, _enforceCustomStepRegisters.enforceCustomStepRegisters)();
+  }
   var nodeViewSerializer = new _NodeViewSerializer.NodeViewSerializer({});
   var setNodeViewSerializer = function setNodeViewSerializer(editorView) {
     nodeViewSerializer.init({

package/dist/es2019/pm-plugins/enforceCustomStepRegisters.js

@@ -0,0 +1,32 @@
+// It is important to get all steps in that package
+// Ignored via go/ees005
+// eslint-disable-next-line import/no-namespace
+import * as adfCustomSteps from '@atlaskit/adf-schema/steps';
+// It is important to get all steps in that package
+// Ignored via go/ees005
+// eslint-disable-next-line import/no-namespace
+import * as atlaskKitCustomSteps from '@atlaskit/custom-steps';
+import { Step } from '@atlaskit/editor-prosemirror/transform';
+export const enforceCustomStepRegisters = () => {
+  const tryToRegisterStep = obj => {
+    for (const customStep of Object.values(obj)) {
+      var _customStep$prototype;
+      // @ts-expect-error ProseMirror step classes expose jsonID on prototype.
+      const id = customStep === null || customStep === void 0 ? void 0 : (_customStep$prototype = customStep.prototype) === null || _customStep$prototype === void 0 ? void 0 : _customStep$prototype.jsonID;
+      if (typeof id === 'string') {
+        try {
+          // Re-register if needed; ignore if already registered.
+          // @ts-expect-error Step.jsonID expects a step constructor.
+          Step.jsonID(id, customStep);
+        } catch {
+          // Step already registered.
+        }
+      }
+    }
+  };
+
+  // @ts-expect-error Step modules export non-step symbols too.
+  tryToRegisterStep(atlaskKitCustomSteps);
+  // @ts-expect-error Step modules export non-step symbols too.
+  tryToRegisterStep(adfCustomSteps);
+};

package/dist/es2019/pm-plugins/main.js

@@ -6,6 +6,7 @@ import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { calculateDiffDecorations } from './calculateDiff/calculateDiffDecorations';
+import { enforceCustomStepRegisters } from './enforceCustomStepRegisters';
 import { NodeViewSerializer } from './NodeViewSerializer';
 import { scrollToActiveDecoration } from './scrollToActiveDecoration';
 export const showDiffPluginKey = new PluginKey('showDiffPlugin');
@@ -30,6 +31,9 @@ export const getScrollableDecorations = set => {
   }).sort((a, b) => a.from === b.from ? a.to - b.to : a.from - b.from);
 };
 export const createPlugin = (config, getIntl, api) => {
+  if (fg('platform_editor_show_diff_equality_fallback')) {
+    enforceCustomStepRegisters();
+  }
   const nodeViewSerializer = new NodeViewSerializer({});
   const setNodeViewSerializer = editorView => {
     nodeViewSerializer.init({

package/dist/esm/pm-plugins/enforceCustomStepRegisters.js

@@ -0,0 +1,33 @@
+// It is important to get all steps in that package
+// Ignored via go/ees005
+// eslint-disable-next-line import/no-namespace
+import * as adfCustomSteps from '@atlaskit/adf-schema/steps';
+// It is important to get all steps in that package
+// Ignored via go/ees005
+// eslint-disable-next-line import/no-namespace
+import * as atlaskKitCustomSteps from '@atlaskit/custom-steps';
+import { Step } from '@atlaskit/editor-prosemirror/transform';
+export var enforceCustomStepRegisters = function enforceCustomStepRegisters() {
+  var tryToRegisterStep = function tryToRegisterStep(obj) {
+    for (var _i = 0, _Object$values = Object.values(obj); _i < _Object$values.length; _i++) {
+      var _customStep$prototype;
+      var customStep = _Object$values[_i];
+      // @ts-expect-error ProseMirror step classes expose jsonID on prototype.
+      var id = customStep === null || customStep === void 0 || (_customStep$prototype = customStep.prototype) === null || _customStep$prototype === void 0 ? void 0 : _customStep$prototype.jsonID;
+      if (typeof id === 'string') {
+        try {
+          // Re-register if needed; ignore if already registered.
+          // @ts-expect-error Step.jsonID expects a step constructor.
+          Step.jsonID(id, customStep);
+        } catch (_unused) {
+          // Step already registered.
+        }
+      }
+    }
+  };
+
+  // @ts-expect-error Step modules export non-step symbols too.
+  tryToRegisterStep(atlaskKitCustomSteps);
+  // @ts-expect-error Step modules export non-step symbols too.
+  tryToRegisterStep(adfCustomSteps);
+};

package/dist/esm/pm-plugins/main.js

@@ -9,6 +9,7 @@ import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { calculateDiffDecorations } from './calculateDiff/calculateDiffDecorations';
+import { enforceCustomStepRegisters } from './enforceCustomStepRegisters';
 import { NodeViewSerializer } from './NodeViewSerializer';
 import { scrollToActiveDecoration } from './scrollToActiveDecoration';
 export var showDiffPluginKey = new PluginKey('showDiffPlugin');
@@ -35,6 +36,9 @@ export var getScrollableDecorations = function getScrollableDecorations(set) {
   });
 };
 export var createPlugin = function createPlugin(config, getIntl, api) {
+  if (fg('platform_editor_show_diff_equality_fallback')) {
+    enforceCustomStepRegisters();
+  }
   var nodeViewSerializer = new NodeViewSerializer({});
   var setNodeViewSerializer = function setNodeViewSerializer(editorView) {
     nodeViewSerializer.init({

package/dist/types/pm-plugins/enforceCustomStepRegisters.d.ts

@@ -0,0 +1 @@
+export declare const enforceCustomStepRegisters: () => void;

package/dist/types-ts4.5/pm-plugins/enforceCustomStepRegisters.d.ts

@@ -0,0 +1 @@
+export declare const enforceCustomStepRegisters: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-show-diff",
-	"version": "6.2.1",
+	"version": "6.2.3",
 	"description": "ShowDiff plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,12 +29,13 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/adf-schema": "^52.4.0",
+		"@atlaskit/custom-steps": "^0.16.0",
 		"@atlaskit/editor-plugin-analytics": "^8.0.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^46.0.0",
-		"@atlaskit/tokens": "^11.2.0",
+		"@atlaskit/tmp-editor-statsig": "^47.0.0",
+		"@atlaskit/tokens": "^11.3.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21",
 		"memoize-one": "^6.0.0",
@@ -45,7 +46,7 @@
 		"@atlassian/content-reconciliation": "^0.1.3506"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.9.0",
+		"@atlaskit/editor-common": "^112.10.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {