@atlaskit/editor-json-transformer 9.8.0 → 9.8.2

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @atlaskit/editor-json-transformer
 
+## 9.8.2
+
+### Patch Changes
+
+- [`8e4fd6774f6ec`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8e4fd6774f6ec) -
+  Add Stage-0 ADF schema support for the `annotation` mark on `extension` nodes (ADF Change 111).
+  Adds the `with_annotation` and `root_only_with_annotation` Stage-0 variants and wires them into
+  the approved root and nested placements (doc root, panel, blockquote, expand, nestedExpand,
+  listItem, blockTaskItem, table cells), registers the matching validator specs, and adds
+  valid/invalid reference fixtures, with regenerated PM/JSON/validator artifacts. Scoped to
+  `extension` only (not `bodiedExtension`/`multiBodiedExtension`); the full schema is unchanged.
+  Editor/renderer acceptance of the mark is gated by `cc_maui_annotations_on_extensions`.
+
+  Allowing the `annotation` mark on `extension` requires its container nodes (panel, table cells,
+  list items, etc.) to permit the mark too, so they can hold an annotated extension child. This made
+  the renderer's `getIndexMatch` double-count text inside those containers, corrupting inline
+  text-comment anchoring. Fixed by skipping block containers during serialisation (they are still
+  walked through so their inner text is counted once); leaf nodes and media are unaffected.
+
+- Updated dependencies
+
+## 9.8.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.8.0
 
 ### Minor Changes

package/SchemaStage/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-json-transformer/SchemaStage",
+  "main": "../dist/cjs/SchemaStage.js",
+  "module": "../dist/esm/SchemaStage.js",
+  "module:es2019": "../dist/es2019/SchemaStage.js",
+  "sideEffects": false,
+  "types": "../dist/types/SchemaStage.d.ts"
+}

package/dist/cjs/toJSON.js

@@ -10,6 +10,14 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _adfSchema = require("@atlaskit/adf-schema");
+var _codeBlock = require("@atlaskit/adf-schema/code-block");
+var _dataConsumer = require("@atlaskit/adf-schema/data-consumer");
+var _expand = require("@atlaskit/adf-schema/expand");
+var _fragment = require("@atlaskit/adf-schema/fragment");
+var _mention = require("@atlaskit/adf-schema/mention");
+var _tableNodes = require("@atlaskit/adf-schema/tableNodes");
+var _toJson = require("@atlaskit/adf-schema/to-json");
+var _toJson2 = require("@atlaskit/adf-schema/to-json-2");
 var _markOverrideRules = require("./markOverrideRules");
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof3(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof3(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof3(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
@@ -38,11 +46,16 @@ var isUnsupportedMark = isType('unsupportedMark');
 var isUnsupportedNodeAttributeMark = isType('unsupportedNodeAttribute');
 var isExpand = isType('expand');
 var isNestedExpand = isType('nestedExpand');
+var isExtensionNode = isType('extension');
 var isUnsupportedNode = function isUnsupportedNode(node) {
   return isType('unsupportedBlock')(node) || isType('unsupportedInline')(node);
 };
 var isDataConsumer = isType('dataConsumer');
 var isFragmentMark = isType('fragment');
+var isAnnotationMark = isType('annotation');
+var isAllowedNodeForAnnotation = function isAllowedNodeForAnnotation(node) {
+  return !node.type.isBlock || isMediaNode(node) || isExtensionNode(node);
+};
 var isHardBreak = isType('hardBreak');
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -103,23 +116,23 @@ var _toJSON = exports.toJSON = function toJSON(node, mentionMap) {
   if (isUnsupportedNode(node)) {
     return node.attrs.originalValue;
   } else if (isMediaNode(node)) {
-    obj.attrs = (0, _adfSchema.mediaToJSON)(node).attrs;
+    obj.attrs = (0, _toJson2.toJSON)(node).attrs;
   } else if (isMediaSingleNode(node)) {
-    obj.attrs = (0, _adfSchema.mediaSingleToJSON)(node).attrs;
+    obj.attrs = (0, _toJson.toJSON)(node).attrs;
   } else if (isMediaInline(node)) {
-    obj.attrs = (0, _adfSchema.mediaToJSON)(node).attrs;
+    obj.attrs = (0, _toJson2.toJSON)(node).attrs;
   } else if (isMentionNode(node)) {
-    obj.attrs = (0, _adfSchema.mentionToJSON)(node).attrs;
+    obj.attrs = (0, _mention.toJSON)(node).attrs;
   } else if (isCodeBlock(node)) {
-    obj.attrs = (0, _adfSchema.codeBlockToJSON)(node).attrs;
+    obj.attrs = (0, _codeBlock.toJSON)(node).attrs;
   } else if (isTable(node)) {
-    obj.attrs = (0, _adfSchema.tableToJSON)(node).attrs;
+    obj.attrs = (0, _tableNodes.tableToJSON)(node).attrs;
   } else if (isTableCell(node)) {
-    obj.attrs = (0, _adfSchema.toJSONTableCell)(node).attrs;
+    obj.attrs = (0, _tableNodes.toJSONTableCell)(node).attrs;
   } else if (isTableHeader(node)) {
-    obj.attrs = (0, _adfSchema.toJSONTableHeader)(node).attrs;
+    obj.attrs = (0, _tableNodes.toJSONTableHeader)(node).attrs;
   } else if (isExpand(node) || isNestedExpand(node)) {
-    obj.attrs = (0, _adfSchema.expandToJSON)(node).attrs;
+    obj.attrs = (0, _expand.toJSON)(node).attrs;
   } else if (node.attrs && Object.keys(node.attrs).length) {
     obj.attrs = node.attrs;
   }
@@ -155,7 +168,9 @@ var _toJSON = exports.toJSON = function toJSON(node, mentionMap) {
   if (node.marks.length) {
     // Run any custom mark serialisers
     var parsedMarks = node.marks.map(function (mark) {
-      if (isUnsupportedMark(mark)) {
+      if (isAnnotationMark(mark) && !isAllowedNodeForAnnotation(node)) {
+        return null;
+      } else if (isUnsupportedMark(mark)) {
         return canOverrideMark(mark, node.marks) ? null : mark.attrs.originalValue;
       } else if (isUnsupportedNodeAttributeMark(mark)) {
         return null;
@@ -163,10 +178,10 @@ var _toJSON = exports.toJSON = function toJSON(node, mentionMap) {
         return (0, _adfSchema.linkToJSON)(mark);
       } else if (isDataConsumer(mark)) {
         var _serialised$attrs$sou;
-        var serialised = (0, _adfSchema.dataConsumerToJSON)(mark);
+        var serialised = (0, _dataConsumer.toJSON)(mark);
         return !serialised.attrs.sources || ((_serialised$attrs$sou = serialised.attrs.sources) === null || _serialised$attrs$sou === void 0 ? void 0 : _serialised$attrs$sou.length) === 0 ? null : serialised;
       } else if (isFragmentMark(mark)) {
-        var fragmentMark = (0, _adfSchema.fragmentToJSON)(mark);
+        var fragmentMark = (0, _fragment.toJSON)(mark);
         if (!fragmentMark.attrs.localId) {
           return null;
         }

package/dist/es2019/jsonTransformer.js

@@ -5,6 +5,7 @@
 /**
  * @deprecated Use `import { SchemaStage } from '@atlaskit/editor-json-transformer'` instead.
  */
+
 export { SchemaStage } from './SchemaStage';
 /**
  * @deprecated Use `import { toJSON } from '@atlaskit/editor-json-transformer/jsonTransformer'` instead.

package/dist/es2019/sanitize.js

@@ -5,6 +5,7 @@
 /**
  * @deprecated Use `import { sanitizeNode } from '@atlaskit/editor-json-transformer/sanitize/sanitize-node'` instead.
  */
+
 export { sanitizeNode } from './sanitize/sanitize-node';
 /**
  * @deprecated Use `import { removeMarks } from '@atlaskit/editor-json-transformer/sanitize/remove-marks'` instead.

package/dist/es2019/toJSON.js

@@ -1,4 +1,12 @@
-import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
+import { linkToJSON } from '@atlaskit/adf-schema';
+import { toJSON as codeBlockToJSON } from '@atlaskit/adf-schema/code-block';
+import { toJSON as dataConsumerToJSON } from '@atlaskit/adf-schema/data-consumer';
+import { toJSON as expandToJSON } from '@atlaskit/adf-schema/expand';
+import { toJSON as fragmentToJSON } from '@atlaskit/adf-schema/fragment';
+import { toJSON as mentionToJSON } from '@atlaskit/adf-schema/mention';
+import { tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema/tableNodes';
+import { toJSON as mediaSingleToJSON } from '@atlaskit/adf-schema/to-json';
+import { toJSON as mediaToJSON } from '@atlaskit/adf-schema/to-json-2';
 import { markOverrideRuleFor } from './markOverrideRules';
 const isType = type => node => node.type.name === type;
 
@@ -19,9 +27,12 @@ const isUnsupportedMark = isType('unsupportedMark');
 const isUnsupportedNodeAttributeMark = isType('unsupportedNodeAttribute');
 const isExpand = isType('expand');
 const isNestedExpand = isType('nestedExpand');
+const isExtensionNode = isType('extension');
 const isUnsupportedNode = node => isType('unsupportedBlock')(node) || isType('unsupportedInline')(node);
 const isDataConsumer = isType('dataConsumer');
 const isFragmentMark = isType('fragment');
+const isAnnotationMark = isType('annotation');
+const isAllowedNodeForAnnotation = node => !node.type.isBlock || isMediaNode(node) || isExtensionNode(node);
 const isHardBreak = isType('hardBreak');
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -142,7 +153,9 @@ export const toJSON = (node, mentionMap) => {
   if (node.marks.length) {
     // Run any custom mark serialisers
     const parsedMarks = node.marks.map(mark => {
-      if (isUnsupportedMark(mark)) {
+      if (isAnnotationMark(mark) && !isAllowedNodeForAnnotation(node)) {
+        return null;
+      } else if (isUnsupportedMark(mark)) {
         return canOverrideMark(mark, node.marks) ? null : mark.attrs.originalValue;
       } else if (isUnsupportedNodeAttributeMark(mark)) {
         return null;

package/dist/esm/jsonTransformer.js

@@ -5,6 +5,7 @@
 /**
  * @deprecated Use `import { SchemaStage } from '@atlaskit/editor-json-transformer'` instead.
  */
+
 export { SchemaStage } from './SchemaStage';
 /**
  * @deprecated Use `import { toJSON } from '@atlaskit/editor-json-transformer/jsonTransformer'` instead.

package/dist/esm/sanitize.js

@@ -5,6 +5,7 @@
 /**
  * @deprecated Use `import { sanitizeNode } from '@atlaskit/editor-json-transformer/sanitize/sanitize-node'` instead.
  */
+
 export { sanitizeNode } from './sanitize/sanitize-node';
 /**
  * @deprecated Use `import { removeMarks } from '@atlaskit/editor-json-transformer/sanitize/remove-marks'` instead.

package/dist/esm/toJSON.js

@@ -5,7 +5,15 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 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) { _defineProperty(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; }
-import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
+import { linkToJSON } from '@atlaskit/adf-schema';
+import { toJSON as codeBlockToJSON } from '@atlaskit/adf-schema/code-block';
+import { toJSON as dataConsumerToJSON } from '@atlaskit/adf-schema/data-consumer';
+import { toJSON as expandToJSON } from '@atlaskit/adf-schema/expand';
+import { toJSON as fragmentToJSON } from '@atlaskit/adf-schema/fragment';
+import { toJSON as mentionToJSON } from '@atlaskit/adf-schema/mention';
+import { tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema/tableNodes';
+import { toJSON as mediaSingleToJSON } from '@atlaskit/adf-schema/to-json';
+import { toJSON as mediaToJSON } from '@atlaskit/adf-schema/to-json-2';
 import { markOverrideRuleFor } from './markOverrideRules';
 var isType = function isType(type) {
   return function (node) {
@@ -30,11 +38,16 @@ var isUnsupportedMark = isType('unsupportedMark');
 var isUnsupportedNodeAttributeMark = isType('unsupportedNodeAttribute');
 var isExpand = isType('expand');
 var isNestedExpand = isType('nestedExpand');
+var isExtensionNode = isType('extension');
 var isUnsupportedNode = function isUnsupportedNode(node) {
   return isType('unsupportedBlock')(node) || isType('unsupportedInline')(node);
 };
 var isDataConsumer = isType('dataConsumer');
 var isFragmentMark = isType('fragment');
+var isAnnotationMark = isType('annotation');
+var isAllowedNodeForAnnotation = function isAllowedNodeForAnnotation(node) {
+  return !node.type.isBlock || isMediaNode(node) || isExtensionNode(node);
+};
 var isHardBreak = isType('hardBreak');
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -147,7 +160,9 @@ var _toJSON = function toJSON(node, mentionMap) {
   if (node.marks.length) {
     // Run any custom mark serialisers
     var parsedMarks = node.marks.map(function (mark) {
-      if (isUnsupportedMark(mark)) {
+      if (isAnnotationMark(mark) && !isAllowedNodeForAnnotation(node)) {
+        return null;
+      } else if (isUnsupportedMark(mark)) {
         return canOverrideMark(mark, node.marks) ? null : mark.attrs.originalValue;
       } else if (isUnsupportedNodeAttributeMark(mark)) {
         return null;

package/dist/types/JSONTransformer-2.d.ts

@@ -1,6 +1,6 @@
 import type { Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
-import type { SchemaStage } from './SchemaStage';
 import type { SanitizeNodeOptions } from './sanitize/sanitize-node';
+import type { SchemaStage } from './SchemaStage';
 import type { JSONDocNode, JSONNode } from './types';
 interface Transformer<T> {
     encode: (node: PMNode) => T;

package/dist/types/sanitize/remove-marks.d.ts

@@ -1,4 +1,4 @@
-import type { JSONNode } from '../index';
+import type { JSONNode } from '../types';
 export declare function removeMarks(node: JSONNode): {
     attrs?: object;
     content?: Array<JSONNode | undefined>;

package/dist/types/sanitize/remove-non-annotation-marks.d.ts

@@ -1,4 +1,4 @@
-import type { JSONNode } from '../index';
+import type { JSONNode } from '../types';
 export declare function removeNonAnnotationMarks(node: JSONNode): {
     attrs?: object;
     content?: Array<JSONNode | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "9.8.0",
+	"version": "9.8.2",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -17,33 +17,32 @@
 	"atlassian": {
 		"team": "Editor: Collaboration",
 		"website": {
+			"tags": [
+				"platform-labs"
+			],
 			"name": "Editor Json Transformer"
 		}
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^57.2.0",
-		"@atlaskit/adf-utils": "^20.8.0",
-		"@atlaskit/editor-prosemirror": "^8.0.0",
+		"@atlaskit/adf-schema": "^57.6.0",
+		"@atlaskit/adf-utils": "^20.9.0",
+		"@atlaskit/editor-prosemirror": "^9.0.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21"
 	},
 	"devDependencies": {
+		"@atlaskit/editor-common": "^123.4.0",
+		"@atlaskit/editor-core": "^229.1.0",
+		"@atlaskit/editor-plugin-grid": "^19.0.0",
+		"@atlaskit/editor-plugin-media": "^21.0.0",
+		"@atlaskit/editor-plugins": "^16.1.0",
+		"@atlaskit/editor-test-helpers": "workspace:^",
+		"@atlaskit/platform-feature-flags": "^2.2.0",
+		"@atlaskit/tokens": "^18.2.0",
+		"@atlaskit/util-data-test": "^19.1.0",
 		"@atlassian/a11y-jest-testing": "^0.17.0",
 		"@atlassian/structured-docs-types": "workspace:^",
+		"@atlassian/workbench": "workspace:*",
 		"react": "^19.2.0"
-	},
-	"techstack": {
-		"@atlassian/frontend": {
-			"import-structure": "atlassian-conventions"
-		},
-		"@repo/internal": {
-			"deprecation": "no-deprecated-imports",
-			"design-tokens": [
-				"color"
-			],
-			"styling": [
-				"emotion"
-			]
-		}
 	}
 }

package/remove-non-annotation-marks/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-json-transformer/remove-non-annotation-marks",
+  "main": "../dist/cjs/sanitize/remove-non-annotation-marks.js",
+  "module": "../dist/esm/sanitize/remove-non-annotation-marks.js",
+  "module:es2019": "../dist/es2019/sanitize/remove-non-annotation-marks.js",
+  "sideEffects": false,
+  "types": "../dist/types/sanitize/remove-non-annotation-marks.d.ts"
+}

package/afm-cc/tsconfig.json

@@ -1,35 +0,0 @@
-{
-	"extends": "../../../../tsconfig.local-consumption.json",
-	"compilerOptions": {
-		"outDir": "../../../../../confluence/tsDist/@atlaskit__editor-json-transformer",
-		"rootDir": "../",
-		"composite": true,
-		"noCheck": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": [
-		{
-			"path": "../../adf-schema/afm-cc/tsconfig.json"
-		},
-		{
-			"path": "../../adf-utils/afm-cc/tsconfig.json"
-		},
-		{
-			"path": "../../editor-prosemirror/afm-cc/tsconfig.json"
-		}
-	]
-}