@atlaskit/editor-json-transformer 9.4.0 → 9.6.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @atlaskit/editor-json-transformer
 
+## 9.6.0
+
+### Minor Changes
+
+- [`1ba964c23baef`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1ba964c23baef) -
+  `JSONTransformer.parse` no longer upgrades container nodes (`panel` -> `panel_c1`) while
+  deserialising — it is again a plain `schema.nodeFromJSON`, so the ProseMirror node types it
+  produces match the input ADF exactly.
+
+  Removed under HOT-305774, which impacted FedRAMP customers. The upgrade was unconditional: a
+  `panel` at the root of the document became a `panel_c1` whenever the supplied schema declared that
+  node. That is unsafe across a service boundary, because the two sides do not agree on the schema —
+  pf-collab-service (NCS) unconditionally uses the stage-0 schema, which does declare `panel_c1`,
+  while the editor does not support `panel_c1` unless the `platform_editor_nest_table_in_panel`
+  experiment is enabled. NCS therefore produced drafts whose panels had been converted to
+  `panel_c1`, which the editor does not unconditionally support.
+
+  Consumers that need to deserialise table-in-panel ADF (`{ type: 'panel' }` containing a `table`,
+  which ProseMirror models as the separate `panel_c1` node) should apply `transformContainerNodes`
+  from `@atlaskit/adf-utils/transforms` to the document before calling `parse`, as the editor and
+  renderer already do.
+
+## 9.5.0
+
+### Minor Changes
+
+- [`52e80c8d44e5f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/52e80c8d44e5f) -
+  Behind `platform_editor_sanitize_selection_fragments`, `getFragmentsFromSelection` now sanitises
+  selection fragments via `JSONTransformer.encodeNode` instead of the raw `nodeToJSON`, so the
+  schema-only `panel_c1` container variant no longer leaks to Remix and other AI selection-context
+  consumers when `platform_editor_nest_table_in_panel` is enabled. `keepNestedTables: true` is
+  passed to keep nested tables intact. `encodeNode` and editor-common's `nodeToJSON` now accept
+  `SanitizeNodeOptions`, matching `encode`.
+
 ## 9.4.0
 
 ### Minor Changes

package/dist/cjs/JSONTransformer-2.js

@@ -9,7 +9,6 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 var _schemaDefault = require("@atlaskit/adf-schema/schema-default");
-var _transforms = require("@atlaskit/adf-utils/transforms");
 var _sanitizeNode = require("./sanitize/sanitize-node");
 var _toJSON = require("./toJSON");
 var createDocFromContent = function createDocFromContent(content) {
@@ -54,21 +53,7 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "internalParse",
     value: function internalParse(content, schema) {
-      // Upgrade container nodes (e.g. `panel` -> `panel_c1`) wherever the schema allows it, so
-      // table-in-panel deserialises consistently for JSONTransformer consumers. Schema-driven and
-      // flag-free, and best-effort: malformed input falls through to `nodeFromJSON`, which stays
-      // the source of truth for validation errors.
-      var promoted = content;
-      try {
-        var _upgradeContainerNode = (0, _transforms.upgradeContainerNodes)(content, schema),
-          transformedAdf = _upgradeContainerNode.transformedAdf;
-        if (transformedAdf) {
-          promoted = transformedAdf;
-        }
-      } catch (_unused) {
-        // Malformed input — leave `promoted` as the original `content`.
-      }
-      var doc = schema.nodeFromJSON(promoted);
+      var doc = schema.nodeFromJSON(content);
       doc.check();
       return doc;
     }
@@ -91,7 +76,8 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "encodeNode",
     value: function encodeNode(node) {
-      return (0, _sanitizeNode.sanitizeNode)((0, _toJSON.toJSON)(node, this.mentionMap));
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return (0, _sanitizeNode.sanitizeNode)((0, _toJSON.toJSON)(node, this.mentionMap), options);
     }
   }]);
 }();

package/dist/es2019/JSONTransformer-2.js

@@ -1,6 +1,5 @@
 import isEqual from 'lodash/isEqual';
 import { defaultSchema, getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
-import { upgradeContainerNodes } from '@atlaskit/adf-utils/transforms';
 import { sanitizeNode } from './sanitize/sanitize-node';
 import { toJSON } from './toJSON';
 const createDocFromContent = content => {
@@ -36,22 +35,7 @@ export class JSONTransformer {
     return createDocFromContent(content);
   }
   internalParse(content, schema) {
-    // Upgrade container nodes (e.g. `panel` -> `panel_c1`) wherever the schema allows it, so
-    // table-in-panel deserialises consistently for JSONTransformer consumers. Schema-driven and
-    // flag-free, and best-effort: malformed input falls through to `nodeFromJSON`, which stays
-    // the source of truth for validation errors.
-    let promoted = content;
-    try {
-      const {
-        transformedAdf
-      } = upgradeContainerNodes(content, schema);
-      if (transformedAdf) {
-        promoted = transformedAdf;
-      }
-    } catch {
-      // Malformed input — leave `promoted` as the original `content`.
-    }
-    const doc = schema.nodeFromJSON(promoted);
+    const doc = schema.nodeFromJSON(content);
     doc.check();
     return doc;
   }
@@ -69,7 +53,7 @@ export class JSONTransformer {
   /**
    * This method is used to encode a single node
    */
-  encodeNode(node) {
-    return sanitizeNode(toJSON(node, this.mentionMap));
+  encodeNode(node, options = {}) {
+    return sanitizeNode(toJSON(node, this.mentionMap), options);
   }
 }

package/dist/esm/JSONTransformer-2.js

@@ -2,7 +2,6 @@ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import isEqual from 'lodash/isEqual';
 import { defaultSchema, getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
-import { upgradeContainerNodes } from '@atlaskit/adf-utils/transforms';
 import { sanitizeNode } from './sanitize/sanitize-node';
 import { toJSON } from './toJSON';
 var createDocFromContent = function createDocFromContent(content) {
@@ -47,21 +46,7 @@ export var JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "internalParse",
     value: function internalParse(content, schema) {
-      // Upgrade container nodes (e.g. `panel` -> `panel_c1`) wherever the schema allows it, so
-      // table-in-panel deserialises consistently for JSONTransformer consumers. Schema-driven and
-      // flag-free, and best-effort: malformed input falls through to `nodeFromJSON`, which stays
-      // the source of truth for validation errors.
-      var promoted = content;
-      try {
-        var _upgradeContainerNode = upgradeContainerNodes(content, schema),
-          transformedAdf = _upgradeContainerNode.transformedAdf;
-        if (transformedAdf) {
-          promoted = transformedAdf;
-        }
-      } catch (_unused) {
-        // Malformed input — leave `promoted` as the original `content`.
-      }
-      var doc = schema.nodeFromJSON(promoted);
+      var doc = schema.nodeFromJSON(content);
       doc.check();
       return doc;
     }
@@ -84,7 +69,8 @@ export var JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "encodeNode",
     value: function encodeNode(node) {
-      return sanitizeNode(toJSON(node, this.mentionMap));
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return sanitizeNode(toJSON(node, this.mentionMap), options);
     }
   }]);
 }();

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

@@ -22,6 +22,6 @@ export declare class JSONTransformer implements Transformer<JSONDocNode> {
     /**
      * This method is used to encode a single node
      */
-    encodeNode(node: PMNode): JSONNode;
+    encodeNode(node: PMNode, options?: SanitizeNodeOptions): JSONNode;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "9.4.0",
+	"version": "9.6.0",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -22,13 +22,13 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^57.0.0",
-		"@atlaskit/adf-utils": "^20.6.0",
+		"@atlaskit/adf-utils": "^20.7.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21"
 	},
 	"devDependencies": {
-		"@atlassian/a11y-jest-testing": "^0.15.0",
+		"@atlassian/a11y-jest-testing": "^0.16.0",
 		"@atlassian/structured-docs-types": "workspace:^",
 		"react": "^19.2.0"
 	},