@atlaskit/adf-utils 19.10.1 → 19.12.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @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
+
+- [#161679](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/161679)
+  [`27c4a6d9b2fb1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/27c4a6d9b2fb1) -
+  ED-25498 Add nested table incoming transform for adf-utils
+
 ## 19.10.1
 
 ### Patch Changes

package/afm-jira/tsconfig.json

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

package/afm-post-office/tsconfig.json

@@ -1,24 +1,24 @@
 {
-  "extends": "../../../../tsconfig.entry-points.post-office.json",
-  "compilerOptions": {
-    "declaration": true,
-    "target": "es5",
-    "outDir": "../../../../../tsDist/@atlaskit__adf-utils/app",
-    "composite": true,
-    "rootDir": "../"
-  },
-  "include": [
-    "../src/**/*.ts",
-    "../src/**/*.tsx"
-  ],
-  "exclude": [
-    "../src/**/__tests__/*",
-    "../src/**/*.test.*",
-    "../src/**/test.*"
-  ],
-  "references": [
-    {
-      "path": "../../../monorepo-tooling/codemod-utils/afm-post-office/tsconfig.json"
-    }
-  ]
-}
+	"extends": "../../../../tsconfig.entry-points.post-office.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../tsDist/@atlaskit__adf-utils/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*"
+	],
+	"references": [
+		{
+			"path": "../../../monorepo-tooling/codemod-utils/afm-post-office/tsconfig.json"
+		}
+	]
+}

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

@@ -0,0 +1,68 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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) {
+  var _extensionNode$attrs, _extensionNode$attrs2;
+  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;
+  // 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 false;
+  }
+  try {
+    var _nestedTableExtension2;
+    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');
+  }
+};
+var transformNestedTablesIncomingDocument = exports.transformNestedTablesIncomingDocument = function transformNestedTablesIncomingDocument(adf) {
+  var isTransformed = false;
+  var transformedAdf = (0, _traverse.traverse)(adf, {
+    extension: function extension(node) {
+      if (isNestedTableExtension(node)) {
+        isTransformed = true;
+        return transformNestedTableExtension(node);
+      }
+    }
+  });
+  return {
+    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,18 @@ 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() {
+    return _nestedTableTransform.transformNestedTablesIncomingDocument;
+  }
+});
 Object.defineProperty(exports, "transformNodesMissingContent", {
   enumerable: true,
   get: function get() {
@@ -44,4 +56,5 @@ var _textLinkCodeTransform = require("./transforms/text-link-code-transform");
 var _dedupeMarksTransform = require("./transforms/dedupe-marks-transform");
 var _nodesMissingContentTransform = require("./transforms/nodes-missing-content-transform");
 var _indentationMarksTransform = require("./transforms/indentation-marks-transform");
-var _invalidMediaContentTransform = require("./transforms/invalid-media-content-transform");
+var _invalidMediaContentTransform = require("./transforms/invalid-media-content-transform");
+var _nestedTableTransform = require("./transforms/nested-table-transform");

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

@@ -0,0 +1,59 @@
+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 => {
+  var _extensionNode$attrs, _extensionNode$attrs2;
+  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;
+  // 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 false;
+  }
+  try {
+    var _nestedTableExtension4, _nestedTableExtension5, _nestedTableExtension6;
+    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');
+  }
+};
+export const transformNestedTablesIncomingDocument = adf => {
+  let isTransformed = false;
+  const transformedAdf = traverse(adf, {
+    extension: node => {
+      if (isNestedTableExtension(node)) {
+        isTransformed = true;
+        return transformNestedTableExtension(node);
+      }
+    }
+  });
+  return {
+    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

@@ -3,4 +3,6 @@ export { transformTextLinkCodeMarks } from './transforms/text-link-code-transfor
 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 { transformInvalidMediaContent } from './transforms/invalid-media-content-transform';
+export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

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

@@ -0,0 +1,61 @@
+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) {
+  var _extensionNode$attrs, _extensionNode$attrs2;
+  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;
+  // 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 false;
+  }
+  try {
+    var _nestedTableExtension2;
+    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');
+  }
+};
+export var transformNestedTablesIncomingDocument = function transformNestedTablesIncomingDocument(adf) {
+  var isTransformed = false;
+  var transformedAdf = traverse(adf, {
+    extension: function extension(node) {
+      if (isNestedTableExtension(node)) {
+        isTransformed = true;
+        return transformNestedTableExtension(node);
+      }
+    }
+  });
+  return {
+    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

@@ -3,4 +3,6 @@ export { transformTextLinkCodeMarks } from './transforms/text-link-code-transfor
 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 { transformInvalidMediaContent } from './transforms/invalid-media-content-transform';
+export { transformNestedTablesIncomingDocument } from './transforms/nested-table-transform';
+export { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

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

@@ -0,0 +1,6 @@
+import type { ADFEntity } from '../types';
+export declare const transformNestedTablesIncomingDocument: (adf: ADFEntity) => {
+    transformedAdf: ADFEntity;
+    isTransformed: boolean;
+};
+export declare const transformNestedTableNodeOutgoingDocument: (tableCellNode: ADFEntity) => ADFEntity;

package/dist/types/transforms.d.ts

@@ -4,3 +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 { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

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

@@ -0,0 +1,6 @@
+import type { ADFEntity } from '../types';
+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

@@ -4,3 +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 { transformNestedTableNodeOutgoingDocument } from './transforms/nested-table-transform';

package/package.json

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