@atlaskit/editor-json-transformer 9.3.0 → 9.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-json-transformer
 
+## 9.4.0
+
+### Minor Changes
+
+- [`710e3d9ec4c65`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/710e3d9ec4c65) -
+  Add `upgradeContainerNodes` to `@atlaskit/adf-utils/transforms` — a schema-driven, flag-free
+  transform that promotes `panel` nodes to their table-allowing `panel_c1` variant wherever the
+  schema allows it (document root, layout column, synced block), regardless of the panel's content.
+
+  `JSONTransformer.parse` now applies it so table-in-panel deserialises consistently for all
+  `JSONTransformer` consumers. It is a no-op for schemas that do not declare `panel_c1`, and it is
+  best-effort (malformed input still surfaces the canonical `nodeFromJSON` validation error).
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.3.0
 
 ### Minor Changes

package/dist/cjs/JSONTransformer-2.js

@@ -9,6 +9,7 @@ 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) {
@@ -53,7 +54,21 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "internalParse",
     value: function internalParse(content, schema) {
-      var doc = schema.nodeFromJSON(content);
+      // 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);
       doc.check();
       return doc;
     }

package/dist/es2019/JSONTransformer-2.js

@@ -1,5 +1,6 @@
 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 => {
@@ -35,7 +36,22 @@ export class JSONTransformer {
     return createDocFromContent(content);
   }
   internalParse(content, schema) {
-    const doc = schema.nodeFromJSON(content);
+    // 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);
     doc.check();
     return doc;
   }

package/dist/esm/JSONTransformer-2.js

@@ -2,6 +2,7 @@ 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) {
@@ -46,7 +47,21 @@ export var JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "internalParse",
     value: function internalParse(content, schema) {
-      var doc = schema.nodeFromJSON(content);
+      // 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);
       doc.check();
       return doc;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "9.3.0",
+	"version": "9.4.0",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -21,8 +21,8 @@
 		}
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^56.7.0",
-		"@atlaskit/adf-utils": "^20.5.0",
+		"@atlaskit/adf-schema": "^57.0.0",
+		"@atlaskit/adf-utils": "^20.6.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21"