@atlaskit/adf-utils 19.11.0 → 19.12.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/adf-utils
 
+## 19.12.0
+
+### Minor Changes
+
+- [#156454](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/156454)
+  [`8dfa896f600a2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8dfa896f600a2) -
+  [ED-25499] this change adds a transformer for converting nested tables to extensions in outgoing
+  documents
+
 ## 19.11.0
 
 ### Minor Changes

package/dist/cjs/transforms/nested-table-transform.js

@@ -1,10 +1,15 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.transformNestedTablesIncomingDocument = void 0;
+exports.transformNestedTablesIncomingDocument = exports.transformNestedTableNodeOutgoingDocument = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _traverse = require("../traverse/traverse");
+var _builders = require("../builders");
+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) { (0, _defineProperty2.default)(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; }
 var NESTED_TABLE_EXTENSION_TYPE = 'com.atlassian.nesting',
   NESTED_TABLE_EXTENSION_KEY = 'nested-table';
 var isNestedTableExtension = function isNestedTableExtension(extensionNode) {
@@ -12,42 +17,25 @@ var isNestedTableExtension = function isNestedTableExtension(extensionNode) {
   return ((_extensionNode$attrs = extensionNode.attrs) === null || _extensionNode$attrs === void 0 ? void 0 : _extensionNode$attrs.extensionType) === NESTED_TABLE_EXTENSION_TYPE && ((_extensionNode$attrs2 = extensionNode.attrs) === null || _extensionNode$attrs2 === void 0 ? void 0 : _extensionNode$attrs2.extensionKey) === NESTED_TABLE_EXTENSION_KEY;
 };
 var transformNestedTableExtension = function transformNestedTableExtension(nestedTableExtension) {
-  var _nestedTableExtension, _transformedNestedTab;
-  // No content - nothing to transform
+  var _nestedTableExtension;
+  // No content - drop the extension node
   if (!((_nestedTableExtension = nestedTableExtension.attrs) !== null && _nestedTableExtension !== void 0 && (_nestedTableExtension = _nestedTableExtension.parameters) !== null && _nestedTableExtension !== void 0 && (_nestedTableExtension = _nestedTableExtension.macroParams) !== null && _nestedTableExtension !== void 0 && _nestedTableExtension.nestedContent)) {
-    return {
-      adf: nestedTableExtension,
-      isTransformed: false
-    };
+    return false;
   }
-  var transformedNestedTable;
   try {
     var _nestedTableExtension2;
-    transformedNestedTable = JSON.parse((_nestedTableExtension2 = nestedTableExtension.attrs) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.parameters) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.macroParams) === null || _nestedTableExtension2 === void 0 ? void 0 : _nestedTableExtension2.nestedContent.value);
+    return JSON.parse((_nestedTableExtension2 = nestedTableExtension.attrs) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.parameters) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.macroParams) === null || _nestedTableExtension2 === void 0 ? void 0 : _nestedTableExtension2.nestedContent.value);
   } catch (e) {
     throw new Error('Failed to parse nested table content');
   }
-  if (!Array.isArray(transformedNestedTable) && ((_transformedNestedTab = transformedNestedTable) === null || _transformedNestedTab === void 0 ? void 0 : _transformedNestedTab.type) === 'table') {
-    return {
-      adf: transformedNestedTable,
-      isTransformed: true
-    };
-  } else {
-    throw new Error('Invalid nested table content');
-  }
 };
 var transformNestedTablesIncomingDocument = exports.transformNestedTablesIncomingDocument = function transformNestedTablesIncomingDocument(adf) {
   var isTransformed = false;
   var transformedAdf = (0, _traverse.traverse)(adf, {
     extension: function extension(node) {
       if (isNestedTableExtension(node)) {
-        var transformResult = transformNestedTableExtension(node);
-        if (transformResult.isTransformed) {
-          isTransformed = true;
-          return transformResult.adf;
-        } else {
-          return false;
-        }
+        isTransformed = true;
+        return transformNestedTableExtension(node);
       }
     }
   });
@@ -55,4 +43,26 @@ var transformNestedTablesIncomingDocument = exports.transformNestedTablesIncomin
     transformedAdf: transformedAdf,
     isTransformed: isTransformed
   };
+};
+var transformNestedTableNodeOutgoingDocument = exports.transformNestedTableNodeOutgoingDocument = function transformNestedTableNodeOutgoingDocument(tableCellNode) {
+  var _tableCellNode$conten;
+  return _objectSpread(_objectSpread({}, tableCellNode), {}, {
+    content: (_tableCellNode$conten = tableCellNode.content) === null || _tableCellNode$conten === void 0 ? void 0 : _tableCellNode$conten.map(function (childNode) {
+      // wrap nested table in an extension node
+      if ((childNode === null || childNode === void 0 ? void 0 : childNode.type) === 'table') {
+        return (0, _builders.extension)({
+          extensionType: NESTED_TABLE_EXTENSION_TYPE,
+          extensionKey: NESTED_TABLE_EXTENSION_KEY,
+          parameters: {
+            macroParams: {
+              nestedContent: {
+                value: JSON.stringify(childNode)
+              }
+            }
+          }
+        });
+      }
+      return childNode;
+    })
+  });
 };

package/dist/cjs/transforms.js

@@ -27,6 +27,12 @@ Object.defineProperty(exports, "transformMediaLinkMarks", {
     return _mediaLinkTransform.transformMediaLinkMarks;
   }
 });
+Object.defineProperty(exports, "transformNestedTableNodeOutgoingDocument", {
+  enumerable: true,
+  get: function get() {
+    return _nestedTableTransform.transformNestedTableNodeOutgoingDocument;
+  }
+});
 Object.defineProperty(exports, "transformNestedTablesIncomingDocument", {
   enumerable: true,
   get: function get() {

package/dist/es2019/transforms/nested-table-transform.js

@@ -1,4 +1,5 @@
 import { traverse } from '../traverse/traverse';
+import { extension } from '../builders';
 const NESTED_TABLE_EXTENSION_TYPE = 'com.atlassian.nesting',
   NESTED_TABLE_EXTENSION_KEY = 'nested-table';
 const isNestedTableExtension = extensionNode => {
@@ -6,42 +7,25 @@ const isNestedTableExtension = extensionNode => {
   return ((_extensionNode$attrs = extensionNode.attrs) === null || _extensionNode$attrs === void 0 ? void 0 : _extensionNode$attrs.extensionType) === NESTED_TABLE_EXTENSION_TYPE && ((_extensionNode$attrs2 = extensionNode.attrs) === null || _extensionNode$attrs2 === void 0 ? void 0 : _extensionNode$attrs2.extensionKey) === NESTED_TABLE_EXTENSION_KEY;
 };
 const transformNestedTableExtension = nestedTableExtension => {
-  var _nestedTableExtension, _nestedTableExtension2, _nestedTableExtension3, _transformedNestedTab;
-  // No content - nothing to transform
+  var _nestedTableExtension, _nestedTableExtension2, _nestedTableExtension3;
+  // No content - drop the extension node
   if (!((_nestedTableExtension = nestedTableExtension.attrs) !== null && _nestedTableExtension !== void 0 && (_nestedTableExtension2 = _nestedTableExtension.parameters) !== null && _nestedTableExtension2 !== void 0 && (_nestedTableExtension3 = _nestedTableExtension2.macroParams) !== null && _nestedTableExtension3 !== void 0 && _nestedTableExtension3.nestedContent)) {
-    return {
-      adf: nestedTableExtension,
-      isTransformed: false
-    };
+    return false;
   }
-  let transformedNestedTable;
   try {
     var _nestedTableExtension4, _nestedTableExtension5, _nestedTableExtension6;
-    transformedNestedTable = JSON.parse((_nestedTableExtension4 = nestedTableExtension.attrs) === null || _nestedTableExtension4 === void 0 ? void 0 : (_nestedTableExtension5 = _nestedTableExtension4.parameters) === null || _nestedTableExtension5 === void 0 ? void 0 : (_nestedTableExtension6 = _nestedTableExtension5.macroParams) === null || _nestedTableExtension6 === void 0 ? void 0 : _nestedTableExtension6.nestedContent.value);
+    return JSON.parse((_nestedTableExtension4 = nestedTableExtension.attrs) === null || _nestedTableExtension4 === void 0 ? void 0 : (_nestedTableExtension5 = _nestedTableExtension4.parameters) === null || _nestedTableExtension5 === void 0 ? void 0 : (_nestedTableExtension6 = _nestedTableExtension5.macroParams) === null || _nestedTableExtension6 === void 0 ? void 0 : _nestedTableExtension6.nestedContent.value);
   } catch (e) {
     throw new Error('Failed to parse nested table content');
   }
-  if (!Array.isArray(transformedNestedTable) && ((_transformedNestedTab = transformedNestedTable) === null || _transformedNestedTab === void 0 ? void 0 : _transformedNestedTab.type) === 'table') {
-    return {
-      adf: transformedNestedTable,
-      isTransformed: true
-    };
-  } else {
-    throw new Error('Invalid nested table content');
-  }
 };
 export const transformNestedTablesIncomingDocument = adf => {
   let isTransformed = false;
   const transformedAdf = traverse(adf, {
     extension: node => {
       if (isNestedTableExtension(node)) {
-        const transformResult = transformNestedTableExtension(node);
-        if (transformResult.isTransformed) {
-          isTransformed = true;
-          return transformResult.adf;
-        } else {
-          return false;
-        }
+        isTransformed = true;
+        return transformNestedTableExtension(node);
       }
     }
   });
@@ -49,4 +33,27 @@ export const transformNestedTablesIncomingDocument = adf => {
     transformedAdf,
     isTransformed
   };
+};
+export const transformNestedTableNodeOutgoingDocument = tableCellNode => {
+  var _tableCellNode$conten;
+  return {
+    ...tableCellNode,
+    content: (_tableCellNode$conten = tableCellNode.content) === null || _tableCellNode$conten === void 0 ? void 0 : _tableCellNode$conten.map(childNode => {
+      // wrap nested table in an extension node
+      if ((childNode === null || childNode === void 0 ? void 0 : childNode.type) === 'table') {
+        return extension({
+          extensionType: NESTED_TABLE_EXTENSION_TYPE,
+          extensionKey: NESTED_TABLE_EXTENSION_KEY,
+          parameters: {
+            macroParams: {
+              nestedContent: {
+                value: JSON.stringify(childNode)
+              }
+            }
+          }
+        });
+      }
+      return childNode;
+    })
+  };
 };

package/dist/es2019/transforms.js

@@ -4,4 +4,5 @@ export { transformDedupeMarks } from './transforms/dedupe-marks-transform';
 export { transformNodesMissingContent } from './transforms/nodes-missing-content-transform';
 export { transformIndentationMarks } from './transforms/indentation-marks-transform';
 export { transformInvalidMediaContent } from './transforms/invalid-media-content-transform';
-export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

package/dist/esm/transforms/nested-table-transform.js

@@ -1,4 +1,8 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 { traverse } from '../traverse/traverse';
+import { extension } from '../builders';
 var NESTED_TABLE_EXTENSION_TYPE = 'com.atlassian.nesting',
   NESTED_TABLE_EXTENSION_KEY = 'nested-table';
 var isNestedTableExtension = function isNestedTableExtension(extensionNode) {
@@ -6,42 +10,25 @@ var isNestedTableExtension = function isNestedTableExtension(extensionNode) {
   return ((_extensionNode$attrs = extensionNode.attrs) === null || _extensionNode$attrs === void 0 ? void 0 : _extensionNode$attrs.extensionType) === NESTED_TABLE_EXTENSION_TYPE && ((_extensionNode$attrs2 = extensionNode.attrs) === null || _extensionNode$attrs2 === void 0 ? void 0 : _extensionNode$attrs2.extensionKey) === NESTED_TABLE_EXTENSION_KEY;
 };
 var transformNestedTableExtension = function transformNestedTableExtension(nestedTableExtension) {
-  var _nestedTableExtension, _transformedNestedTab;
-  // No content - nothing to transform
+  var _nestedTableExtension;
+  // No content - drop the extension node
   if (!((_nestedTableExtension = nestedTableExtension.attrs) !== null && _nestedTableExtension !== void 0 && (_nestedTableExtension = _nestedTableExtension.parameters) !== null && _nestedTableExtension !== void 0 && (_nestedTableExtension = _nestedTableExtension.macroParams) !== null && _nestedTableExtension !== void 0 && _nestedTableExtension.nestedContent)) {
-    return {
-      adf: nestedTableExtension,
-      isTransformed: false
-    };
+    return false;
   }
-  var transformedNestedTable;
   try {
     var _nestedTableExtension2;
-    transformedNestedTable = JSON.parse((_nestedTableExtension2 = nestedTableExtension.attrs) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.parameters) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.macroParams) === null || _nestedTableExtension2 === void 0 ? void 0 : _nestedTableExtension2.nestedContent.value);
+    return JSON.parse((_nestedTableExtension2 = nestedTableExtension.attrs) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.parameters) === null || _nestedTableExtension2 === void 0 || (_nestedTableExtension2 = _nestedTableExtension2.macroParams) === null || _nestedTableExtension2 === void 0 ? void 0 : _nestedTableExtension2.nestedContent.value);
   } catch (e) {
     throw new Error('Failed to parse nested table content');
   }
-  if (!Array.isArray(transformedNestedTable) && ((_transformedNestedTab = transformedNestedTable) === null || _transformedNestedTab === void 0 ? void 0 : _transformedNestedTab.type) === 'table') {
-    return {
-      adf: transformedNestedTable,
-      isTransformed: true
-    };
-  } else {
-    throw new Error('Invalid nested table content');
-  }
 };
 export var transformNestedTablesIncomingDocument = function transformNestedTablesIncomingDocument(adf) {
   var isTransformed = false;
   var transformedAdf = traverse(adf, {
     extension: function extension(node) {
       if (isNestedTableExtension(node)) {
-        var transformResult = transformNestedTableExtension(node);
-        if (transformResult.isTransformed) {
-          isTransformed = true;
-          return transformResult.adf;
-        } else {
-          return false;
-        }
+        isTransformed = true;
+        return transformNestedTableExtension(node);
       }
     }
   });
@@ -49,4 +36,26 @@ export var transformNestedTablesIncomingDocument = function transformNestedTable
     transformedAdf: transformedAdf,
     isTransformed: isTransformed
   };
+};
+export var transformNestedTableNodeOutgoingDocument = function transformNestedTableNodeOutgoingDocument(tableCellNode) {
+  var _tableCellNode$conten;
+  return _objectSpread(_objectSpread({}, tableCellNode), {}, {
+    content: (_tableCellNode$conten = tableCellNode.content) === null || _tableCellNode$conten === void 0 ? void 0 : _tableCellNode$conten.map(function (childNode) {
+      // wrap nested table in an extension node
+      if ((childNode === null || childNode === void 0 ? void 0 : childNode.type) === 'table') {
+        return extension({
+          extensionType: NESTED_TABLE_EXTENSION_TYPE,
+          extensionKey: NESTED_TABLE_EXTENSION_KEY,
+          parameters: {
+            macroParams: {
+              nestedContent: {
+                value: JSON.stringify(childNode)
+              }
+            }
+          }
+        });
+      }
+      return childNode;
+    })
+  });
 };

package/dist/esm/transforms.js

@@ -4,4 +4,5 @@ export { transformDedupeMarks } from './transforms/dedupe-marks-transform';
 export { transformNodesMissingContent } from './transforms/nodes-missing-content-transform';
 export { transformIndentationMarks } from './transforms/indentation-marks-transform';
 export { transformInvalidMediaContent } from './transforms/invalid-media-content-transform';
-export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

package/dist/types/transforms/nested-table-transform.d.ts

@@ -3,3 +3,4 @@ export declare const transformNestedTablesIncomingDocument: (adf: ADFEntity) =>
     transformedAdf: ADFEntity;
     isTransformed: boolean;
 };
+export declare const transformNestedTableNodeOutgoingDocument: (tableCellNode: ADFEntity) => ADFEntity;

package/dist/types/transforms.d.ts

@@ -5,3 +5,4 @@ export { transformNodesMissingContent } from './transforms/nodes-missing-content
 export { transformIndentationMarks } from './transforms/indentation-marks-transform';
 export { transformInvalidMediaContent } from './transforms/invalid-media-content-transform';
 export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

package/dist/types-ts4.5/transforms/nested-table-transform.d.ts

@@ -3,3 +3,4 @@ export declare const transformNestedTablesIncomingDocument: (adf: ADFEntity) =>
     transformedAdf: ADFEntity;
     isTransformed: boolean;
 };
+export declare const transformNestedTableNodeOutgoingDocument: (tableCellNode: ADFEntity) => ADFEntity;

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

@@ -5,3 +5,4 @@ export { transformNodesMissingContent } from './transforms/nodes-missing-content
 export { transformIndentationMarks } from './transforms/indentation-marks-transform';
 export { transformInvalidMediaContent } from './transforms/invalid-media-content-transform';
 export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/adf-utils",
-	"version": "19.11.0",
+	"version": "19.12.0",
 	"description": "Set of utilities to traverse, modify and create ADF documents.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"