@atlaskit/editor-json-transformer 8.24.4 → 8.25.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-json-transformer
 
+## 8.25.0
+
+### Minor Changes
+
+- [#193192](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/193192)
+  [`8e0b7ecbc293f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8e0b7ecbc293f) -
+  [ux] EDITOR-1186 - keep nested table in adf
+
+## 8.24.5
+
+### Patch Changes
+
+- [#191913](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/191913)
+  [`6d1e56695e91d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6d1e56695e91d) -
+  EDITOR-1131 Bump adf-schema package to 50.0.0
+- Updated dependencies
+
 ## 8.24.4
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -1,24 +1,24 @@
 {
-    "extends": "../../../../tsconfig.entry-points.confluence.json",
-    "compilerOptions": {
-        "declaration": true,
-        "target": "es5",
-        "composite": true,
-        "outDir": "../../../../../confluence/tsDist/@atlaskit__editor-json-transformer",
-        "rootDir": "../"
-    },
-    "include": [
-        "../src/**/*.ts",
-        "../src/**/*.tsx"
-    ],
-    "exclude": [
-        "../src/**/__tests__/*",
-        "../src/**/*.test.*",
-        "../src/**/test.*"
-    ],
-    "references": [
-        {
-            "path": "../../adf-utils/afm-cc/tsconfig.json"
-        }
-    ]
+	"extends": "../../../../tsconfig.entry-points.confluence.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"composite": true,
+		"outDir": "../../../../../confluence/tsDist/@atlaskit__editor-json-transformer",
+		"rootDir": "../"
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*"
+	],
+	"references": [
+		{
+			"path": "../../adf-utils/afm-cc/tsconfig.json"
+		}
+	]
 }

package/afm-townsquare/tsconfig.json

@@ -0,0 +1,24 @@
+{
+	"extends": "../../../../tsconfig.entry-points.townsquare.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../townsquare/tsDist/@atlaskit__editor-json-transformer/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*"
+	],
+	"references": [
+		{
+			"path": "../../adf-utils/afm-townsquare/tsconfig.json"
+		}
+	]
+}

package/dist/cjs/index.js

@@ -31,6 +31,9 @@ var isType = function isType(type) {
     return node.type.name === type;
   };
 };
+
+// Create a Set of node types that should have empty attrs removed
+var NODES_WITH_EMPTY_ATTRS_REMOVAL = new Set(['paragraph', 'layoutSection', 'blockquote', 'nestedExpand', 'bulletList', 'listItem', 'orderedList', 'rule', 'caption', 'tableRow', 'media', 'mediaSingle', 'mediaInline']);
 var isCodeBlock = isType('codeBlock');
 var isMediaNode = isType('media');
 var isMediaInline = isType('mediaInline');
@@ -123,15 +126,7 @@ var _toJSON = function toJSON(node, mentionMap) {
       text: !!text ? text : name
     });
   }
-
-  // Remove the attrs property if it's empty, this is currently limited to paragraph nodes.
-  if (isParagraph(node) && obj.attrs && !Object.keys(obj.attrs).length) {
-    delete obj.attrs;
-  }
-
-  // Hard break has optional attr.text which was added for PM <-> ADF compatibility.
-  // No need to preserve it.
-  if (isHardBreak(node)) {
+  if (NODES_WITH_EMPTY_ATTRS_REMOVAL.has(node.type.name) && obj.attrs && !Object.keys(obj.attrs).length || isHardBreak(node)) {
     delete obj.attrs;
   }
   if (node.isText) {
@@ -222,9 +217,10 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
     key: "encode",
     value: function encode(node) {
       var _this = this;
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       var content = [];
       node.content.forEach(function (child) {
-        content.push((0, _sanitizeNode.sanitizeNode)(_toJSON(child, _this.mentionMap)));
+        content.push((0, _sanitizeNode.sanitizeNode)(_toJSON(child, _this.mentionMap), options));
       });
       if (!content || (0, _isEqual.default)(content, emptyDoc.content)) {
         return createDocFromContent([]);

package/dist/cjs/sanitize/sanitize-node.js

@@ -18,6 +18,9 @@ var hasNestedTable = function hasNestedTable(tableCellNode) {
   });
 };
 function sanitizeNode(json) {
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var _options$keepNestedTa = options.keepNestedTables,
+    keepNestedTables = _options$keepNestedTa === void 0 ? false : _options$keepNestedTa;
   var sanitizedJSON = (0, _traverse.traverse)(json, {
     text: function text(node) {
       if (!node || !Array.isArray(node.marks)) {
@@ -43,12 +46,12 @@ function sanitizeNode(json) {
     },
     tableCell: function tableCell(node) {
       if (hasNestedTable(node)) {
-        return (0, _transforms.transformNestedTableNodeOutgoingDocument)(node);
+        return keepNestedTables ? node : (0, _transforms.transformNestedTableNodeOutgoingDocument)(node);
       }
     },
     tableHeader: function tableHeader(node) {
       if (hasNestedTable(node)) {
-        return (0, _transforms.transformNestedTableNodeOutgoingDocument)(node);
+        return keepNestedTables ? node : (0, _transforms.transformNestedTableNodeOutgoingDocument)(node);
       }
     },
     emoji: _removeMarks.removeNonAnnotationMarks,

package/dist/es2019/index.js

@@ -12,6 +12,9 @@ export let SchemaStage = /*#__PURE__*/function (SchemaStage) {
   return SchemaStage;
 }({});
 const isType = type => node => node.type.name === type;
+
+// Create a Set of node types that should have empty attrs removed
+const NODES_WITH_EMPTY_ATTRS_REMOVAL = new Set(['paragraph', 'layoutSection', 'blockquote', 'nestedExpand', 'bulletList', 'listItem', 'orderedList', 'rule', 'caption', 'tableRow', 'media', 'mediaSingle', 'mediaInline']);
 const isCodeBlock = isType('codeBlock');
 const isMediaNode = isType('media');
 const isMediaInline = isType('mediaInline');
@@ -106,15 +109,7 @@ const toJSON = (node, mentionMap) => {
       text: !!text ? text : name
     };
   }
-
-  // Remove the attrs property if it's empty, this is currently limited to paragraph nodes.
-  if (isParagraph(node) && obj.attrs && !Object.keys(obj.attrs).length) {
-    delete obj.attrs;
-  }
-
-  // Hard break has optional attr.text which was added for PM <-> ADF compatibility.
-  // No need to preserve it.
-  if (isHardBreak(node)) {
+  if (NODES_WITH_EMPTY_ATTRS_REMOVAL.has(node.type.name) && obj.attrs && !Object.keys(obj.attrs).length || isHardBreak(node)) {
     delete obj.attrs;
   }
   if (node.isText) {
@@ -202,10 +197,10 @@ export class JSONTransformer {
     this.schema = schema;
     this.mentionMap = mentionMap;
   }
-  encode(node) {
+  encode(node, options = {}) {
     const content = [];
     node.content.forEach(child => {
-      content.push(sanitizeNode(toJSON(child, this.mentionMap)));
+      content.push(sanitizeNode(toJSON(child, this.mentionMap), options));
     });
     if (!content || isEqual(content, emptyDoc.content)) {
       return createDocFromContent([]);

package/dist/es2019/sanitize/sanitize-node.js

@@ -5,7 +5,10 @@ const hasNestedTable = tableCellNode => {
   var _tableCellNode$conten;
   return (_tableCellNode$conten = tableCellNode.content) === null || _tableCellNode$conten === void 0 ? void 0 : _tableCellNode$conten.some(node => (node === null || node === void 0 ? void 0 : node.type) === 'table');
 };
-export function sanitizeNode(json) {
+export function sanitizeNode(json, options = {}) {
+  const {
+    keepNestedTables = false
+  } = options;
   const sanitizedJSON = traverse(json, {
     text: node => {
       if (!node || !Array.isArray(node.marks)) {
@@ -30,12 +33,12 @@ export function sanitizeNode(json) {
     },
     tableCell: node => {
       if (hasNestedTable(node)) {
-        return transformNestedTableNodeOutgoingDocument(node);
+        return keepNestedTables ? node : transformNestedTableNodeOutgoingDocument(node);
       }
     },
     tableHeader: node => {
       if (hasNestedTable(node)) {
-        return transformNestedTableNodeOutgoingDocument(node);
+        return keepNestedTables ? node : transformNestedTableNodeOutgoingDocument(node);
       }
     },
     emoji: removeNonAnnotationMarks,

package/dist/esm/index.js

@@ -25,6 +25,9 @@ var isType = function isType(type) {
     return node.type.name === type;
   };
 };
+
+// Create a Set of node types that should have empty attrs removed
+var NODES_WITH_EMPTY_ATTRS_REMOVAL = new Set(['paragraph', 'layoutSection', 'blockquote', 'nestedExpand', 'bulletList', 'listItem', 'orderedList', 'rule', 'caption', 'tableRow', 'media', 'mediaSingle', 'mediaInline']);
 var isCodeBlock = isType('codeBlock');
 var isMediaNode = isType('media');
 var isMediaInline = isType('mediaInline');
@@ -117,15 +120,7 @@ var _toJSON = function toJSON(node, mentionMap) {
       text: !!text ? text : name
     });
   }
-
-  // Remove the attrs property if it's empty, this is currently limited to paragraph nodes.
-  if (isParagraph(node) && obj.attrs && !Object.keys(obj.attrs).length) {
-    delete obj.attrs;
-  }
-
-  // Hard break has optional attr.text which was added for PM <-> ADF compatibility.
-  // No need to preserve it.
-  if (isHardBreak(node)) {
+  if (NODES_WITH_EMPTY_ATTRS_REMOVAL.has(node.type.name) && obj.attrs && !Object.keys(obj.attrs).length || isHardBreak(node)) {
     delete obj.attrs;
   }
   if (node.isText) {
@@ -216,9 +211,10 @@ export var JSONTransformer = /*#__PURE__*/function () {
     key: "encode",
     value: function encode(node) {
       var _this = this;
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       var content = [];
       node.content.forEach(function (child) {
-        content.push(sanitizeNode(_toJSON(child, _this.mentionMap)));
+        content.push(sanitizeNode(_toJSON(child, _this.mentionMap), options));
       });
       if (!content || isEqual(content, emptyDoc.content)) {
         return createDocFromContent([]);

package/dist/esm/sanitize/sanitize-node.js

@@ -11,6 +11,9 @@ var hasNestedTable = function hasNestedTable(tableCellNode) {
   });
 };
 export function sanitizeNode(json) {
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var _options$keepNestedTa = options.keepNestedTables,
+    keepNestedTables = _options$keepNestedTa === void 0 ? false : _options$keepNestedTa;
   var sanitizedJSON = traverse(json, {
     text: function text(node) {
       if (!node || !Array.isArray(node.marks)) {
@@ -36,12 +39,12 @@ export function sanitizeNode(json) {
     },
     tableCell: function tableCell(node) {
       if (hasNestedTable(node)) {
-        return transformNestedTableNodeOutgoingDocument(node);
+        return keepNestedTables ? node : transformNestedTableNodeOutgoingDocument(node);
       }
     },
     tableHeader: function tableHeader(node) {
       if (hasNestedTable(node)) {
-        return transformNestedTableNodeOutgoingDocument(node);
+        return keepNestedTables ? node : transformNestedTableNodeOutgoingDocument(node);
       }
     },
     emoji: removeNonAnnotationMarks,

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 import type { Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
+import { type SanitizeNodeOptions } from './sanitize/sanitize-node';
 import type { JSONDocNode, JSONNode } from './types';
 export type { JSONDocNode, JSONNode } from './types';
 interface Transformer<T> {
@@ -18,7 +19,7 @@ export declare class JSONTransformer implements Transformer<JSONDocNode> {
      * mention node.attr.text values with mapped names.
      */
     constructor(schema?: Schema, mentionMap?: Record<string, string | undefined>);
-    encode(node: PMNode): JSONDocNode;
+    encode(node: PMNode, options?: SanitizeNodeOptions): JSONDocNode;
     private internalParse;
     parse(content: JSONDocNode, stage?: SchemaStage): PMNode;
     /**

package/dist/types/sanitize/sanitize-node.d.ts

@@ -1,2 +1,9 @@
 import { type JSONNode } from '../types';
-export declare function sanitizeNode(json: JSONNode): JSONNode;
+export interface SanitizeNodeOptions {
+    /**
+     * If true, nested tables will not be transformed to a extension.
+     * This is useful when you want to keep the nested structure for further processing.
+     */
+    keepNestedTables?: boolean;
+}
+export declare function sanitizeNode(json: JSONNode, options?: SanitizeNodeOptions): JSONNode;

package/dist/types-ts4.5/index.d.ts

@@ -1,4 +1,5 @@
 import type { Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
+import { type SanitizeNodeOptions } from './sanitize/sanitize-node';
 import type { JSONDocNode, JSONNode } from './types';
 export type { JSONDocNode, JSONNode } from './types';
 interface Transformer<T> {
@@ -18,7 +19,7 @@ export declare class JSONTransformer implements Transformer<JSONDocNode> {
      * mention node.attr.text values with mapped names.
      */
     constructor(schema?: Schema, mentionMap?: Record<string, string | undefined>);
-    encode(node: PMNode): JSONDocNode;
+    encode(node: PMNode, options?: SanitizeNodeOptions): JSONDocNode;
     private internalParse;
     parse(content: JSONDocNode, stage?: SchemaStage): PMNode;
     /**

package/dist/types-ts4.5/sanitize/sanitize-node.d.ts

@@ -1,2 +1,9 @@
 import { type JSONNode } from '../types';
-export declare function sanitizeNode(json: JSONNode): JSONNode;
+export interface SanitizeNodeOptions {
+    /**
+     * If true, nested tables will not be transformed to a extension.
+     * This is useful when you want to keep the nested structure for further processing.
+     */
+    keepNestedTables?: boolean;
+}
+export declare function sanitizeNode(json: JSONNode, options?: SanitizeNodeOptions): JSONNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.24.4",
+	"version": "8.25.0",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -35,7 +35,7 @@
 		"./types": "./src/types.ts"
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^49.0.6",
+		"@atlaskit/adf-schema": "^50.0.1",
 		"@atlaskit/adf-utils": "^19.20.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@babel/runtime": "^7.0.0",