@atlaskit/adf-utils 16.0.2 → 17.1.1

package/dist/esm/transforms/nodes-missing-content-transform.js

@@ -0,0 +1,192 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+import { traverse } from '../traverse/traverse';
+import { tableRow, tableCell, paragraph, listItem } from '../builders';
+
+var getMaxColumnsCountForTable = function getMaxColumnsCountForTable(tableNode) {
+  var _tableNode$content;
+
+  var colsInRow = 1;
+  (_tableNode$content = tableNode.content) === null || _tableNode$content === void 0 ? void 0 : _tableNode$content.forEach(function (childNode) {
+    var _childNode$content;
+
+    if ((childNode === null || childNode === void 0 ? void 0 : childNode.type) === 'tableRow' && typeof ((_childNode$content = childNode.content) === null || _childNode$content === void 0 ? void 0 : _childNode$content.length) === 'number' && childNode.content.length > colsInRow) {
+      colsInRow = childNode.content.length;
+    }
+  });
+  return colsInRow;
+};
+
+var createValidEmptyContent = function createValidEmptyContent(node) {
+  switch (node.type) {
+    case 'tableCell':
+      return [paragraph()];
+
+    default:
+      return [];
+  }
+};
+
+var isEmpty = function isEmpty(node) {
+  var _node$content;
+
+  return ((_node$content = node.content) === null || _node$content === void 0 ? void 0 : _node$content.length) === 0;
+};
+
+var fixIfTableCellInvalidEmpty = function fixIfTableCellInvalidEmpty(reportTransform) {
+  return function (node) {
+    if (isEmpty(node)) {
+      reportTransform();
+      return _objectSpread(_objectSpread({}, node), {}, {
+        content: createValidEmptyContent(node)
+      });
+    }
+  };
+};
+
+var hasNonListItemChildren = function hasNonListItemChildren(node) {
+  var _node$content2;
+
+  return (_node$content2 = node.content) === null || _node$content2 === void 0 ? void 0 : _node$content2.some(function (node) {
+    return (node === null || node === void 0 ? void 0 : node.type) !== 'listItem';
+  });
+};
+
+var hasEmptyListItemChildren = function hasEmptyListItemChildren(node) {
+  var _node$content3;
+
+  return (_node$content3 = node.content) === null || _node$content3 === void 0 ? void 0 : _node$content3.some(function (childNode) {
+    var _childNode$content2;
+
+    return (childNode === null || childNode === void 0 ? void 0 : childNode.type) === 'listItem' && !((_childNode$content2 = childNode.content) !== null && _childNode$content2 !== void 0 && _childNode$content2.length);
+  });
+};
+
+var tryCreateValidListItemWrappedChildren = function tryCreateValidListItemWrappedChildren(parentListNode) {
+  var _parentListNode$conte;
+
+  return (_parentListNode$conte = parentListNode.content) === null || _parentListNode$conte === void 0 ? void 0 : _parentListNode$conte.map(function (childNode) {
+    if (childNode) {
+      switch (childNode.type) {
+        case 'listItem':
+          {
+            if (isEmpty(childNode)) {
+              var result = listItem([paragraph()]);
+              return result;
+            }
+
+            return childNode;
+          }
+
+        case 'text':
+          return listItem([paragraph(childNode)]);
+
+        default:
+          return listItem([childNode]);
+      }
+    }
+
+    return childNode;
+  });
+};
+
+var fixIfListParentWithInvalidListItemChildren = function fixIfListParentWithInvalidListItemChildren(reportTransform) {
+  return function (node) {
+    if (hasNonListItemChildren(node) || hasEmptyListItemChildren(node)) {
+      reportTransform();
+      return _objectSpread(_objectSpread({}, node), {}, {
+        content: tryCreateValidListItemWrappedChildren(node)
+      });
+    }
+  };
+};
+
+var hasNonTableRowChildren = function hasNonTableRowChildren(node) {
+  var _node$content4;
+
+  return (_node$content4 = node.content) === null || _node$content4 === void 0 ? void 0 : _node$content4.some(function (node) {
+    return (node === null || node === void 0 ? void 0 : node.type) !== 'tableRow';
+  });
+};
+
+var tryCreateValidTableRowWrappedChildren = function tryCreateValidTableRowWrappedChildren(parentTableNode) {
+  var _parentTableNode$cont;
+
+  var maxColsCount = getMaxColumnsCountForTable(parentTableNode);
+  return (_parentTableNode$cont = parentTableNode.content) === null || _parentTableNode$cont === void 0 ? void 0 : _parentTableNode$cont.map(function (childNode) {
+    if (childNode) {
+      switch (childNode.type) {
+        case 'text':
+          {
+            return tableRow([tableCell({})(paragraph(childNode))].concat(_toConsumableArray(new Array(maxColsCount - 1).fill(tableCell({})(paragraph())))));
+          }
+
+        case 'tableCell':
+          {
+            return tableRow([childNode]);
+          }
+
+        case 'tableRow':
+          {
+            if (isEmpty(childNode)) {
+              return tableRow(_toConsumableArray(new Array(maxColsCount).fill(tableCell({})(paragraph()))));
+            }
+
+            return childNode;
+          }
+
+        default:
+          return childNode;
+      }
+    }
+
+    return childNode;
+  });
+};
+
+var hasEmptyTableRowChildren = function hasEmptyTableRowChildren(node) {
+  var _node$content5;
+
+  return node === null || node === void 0 ? void 0 : (_node$content5 = node.content) === null || _node$content5 === void 0 ? void 0 : _node$content5.some(function (node) {
+    var _node$content6;
+
+    return (node === null || node === void 0 ? void 0 : node.type) === 'tableRow' && (node === null || node === void 0 ? void 0 : (_node$content6 = node.content) === null || _node$content6 === void 0 ? void 0 : _node$content6.length) === 0;
+  });
+};
+
+var fixIfTableParentWithInvalidTableRowChildren = function fixIfTableParentWithInvalidTableRowChildren(reportTransform) {
+  return function (node) {
+    if (hasEmptyTableRowChildren(node) || hasNonTableRowChildren(node)) {
+      reportTransform();
+      return _objectSpread(_objectSpread({}, node), {}, {
+        content: tryCreateValidTableRowWrappedChildren(node)
+      });
+    }
+  };
+};
+
+export var transformNodesMissingContent = function transformNodesMissingContent(adf) {
+  var isTransformed = false;
+
+  var reportTransform = function reportTransform() {
+    isTransformed = true;
+  };
+
+  var transformedAdf = traverse(adf, {
+    tableCell: fixIfTableCellInvalidEmpty(reportTransform)
+  });
+  transformedAdf = traverse(transformedAdf || adf, {
+    bulletList: fixIfListParentWithInvalidListItemChildren(reportTransform),
+    orderedList: fixIfListParentWithInvalidListItemChildren(reportTransform),
+    table: fixIfTableParentWithInvalidTableRowChildren(reportTransform)
+  });
+  return {
+    transformedAdf: transformedAdf,
+    isTransformed: isTransformed
+  };
+};

package/dist/esm/transforms.js

@@ -0,0 +1,5 @@
+export { transformMediaLinkMarks } from './transforms/media-link-transform';
+export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';
+export { transformDedupeMarks } from './transforms/dedupe-marks-transform';
+export { transformNodesMissingContent } from './transforms/nodes-missing-content-transform';
+export { transformIndentationMarks } from './transforms/indentation-marks-transform';

package/dist/esm/validator/specs/block_content.js

@@ -1 +1 @@
-export default ['blockCard', 'paragraph_with_no_marks', 'paragraph_with_alignment', 'bulletList', 'mediaSingle_full', 'mediaSingle_caption', 'codeBlock_with_no_marks', 'orderedList', 'heading_with_no_marks', 'heading_with_alignment', 'heading_with_indentation', 'panel', 'blockquote', 'rule', 'mediaGroup', 'decisionList', 'taskList', 'extension_with_marks', 'embedCard', 'table', 'expand_with_no_mark', 'bodiedExtension_with_marks'];
+export default ['blockCard', 'paragraph_with_no_marks', 'paragraph_with_alignment', 'paragraph_with_indentation', 'bulletList', 'mediaSingle_full', 'mediaSingle_caption', 'codeBlock_with_no_marks', 'orderedList', 'heading_with_no_marks', 'heading_with_alignment', 'heading_with_indentation', 'panel', 'blockquote', 'rule', 'mediaGroup', 'decisionList', 'taskList', 'extension_with_marks', 'embedCard', 'table', 'expand_with_no_mark', 'bodiedExtension_with_marks'];

package/dist/esm/validator/specs/mediaInline.js

@@ -10,6 +10,11 @@ export default {
           type: 'object',
           optional: true
         },
+        type: {
+          type: 'enum',
+          values: ['link', 'file'],
+          optional: true
+        },
         id: {
           type: 'string',
           minLength: 1

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-utils",
-	"version": "16.0.2",
+	"version": "17.1.1",
 	"sideEffects": false
 }

package/dist/types/index.d.ts

@@ -1,9 +1 @@
-export { a, alignment, b, blockCard, blockQuote, bodiedExtension, br, breakout, bulletList, code, codeBlock, date, decisionItem, decisionList, doc, em, embedCard, emoji, expand, extension, hardBreak, heading, hr, indentation, inlineCard, inlineExtension, layoutColumn, layoutSection, li, link, listItem, media, mediaGroup, mediaSingle, mention, nestedExpand, ol, orderedList, p, panel, paragraph, placeholder, rule, status, strike, strong, subsup, table, tableCell, tableHeader, tableRow, taskItem, taskList, td, text, textColor, th, tr, u, ul, underline, dataConsumer, } from './builders';
-export { filter, map, reduce, traverse } from './traverse';
-export { scrubAdf } from './scrub';
-export { validateAttrs, validator } from './validator';
-export type { Content, ErrorCallback, Output, ValidationError, ValidationErrorMap, ValidationErrorType, ValidationMode, ValidationOptions, ErrorCallbackOptions, Validate, } from './types/validatorTypes';
-export type { ADFEntity, ADFEntityMark, Visitor, VisitorCollection, } from './types';
-export { getEmptyADF } from './empty-adf';
-export { transformMediaLinkMarks } from './media-link-transform';
-export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';
+export {};

package/dist/types/transforms/dedupe-marks-transform.d.ts

@@ -0,0 +1,8 @@
+import { ADFEntity, ADFEntityMark } from '../types';
+interface TransformDedupeMarksResult {
+    transformedAdf: ADFEntity;
+    isTransformed: boolean;
+    discardedMarks: ADFEntityMark[];
+}
+export declare const transformDedupeMarks: (adf: ADFEntity) => TransformDedupeMarksResult;
+export {};

package/dist/types/transforms/indentation-marks-transform.d.ts

@@ -0,0 +1,7 @@
+import { ADFEntity } from '../types';
+interface TransformIndentationMarksResult {
+    transformedAdf: ADFEntity;
+    isTransformed: boolean;
+}
+export declare const transformIndentationMarks: (adf: ADFEntity) => TransformIndentationMarksResult;
+export {};

package/dist/types/{media-link-transform.d.ts → transforms/media-link-transform.d.ts}

@@ -1,4 +1,4 @@
-import { ADFEntity } from './types';
+import { ADFEntity } from '../types';
 export declare const transformMediaLinkMarks: (adf: ADFEntity) => {
     transformedAdf: false | ADFEntity;
     isTransformed: boolean;

package/dist/types/transforms/nodes-missing-content-transform.d.ts

@@ -0,0 +1,7 @@
+import { ADFEntity } from '../types';
+interface TransformNodesMissingContentResult {
+    transformedAdf: ADFEntity;
+    isTransformed: boolean;
+}
+export declare const transformNodesMissingContent: (adf: ADFEntity) => TransformNodesMissingContentResult;
+export {};

package/dist/types/transforms.d.ts

@@ -0,0 +1,5 @@
+export { transformMediaLinkMarks } from './transforms/media-link-transform';
+export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';
+export { transformDedupeMarks } from './transforms/dedupe-marks-transform';
+export { transformNodesMissingContent } from './transforms/nodes-missing-content-transform';
+export { transformIndentationMarks } from './transforms/indentation-marks-transform';

package/dist/types/validator/specs/mediaInline.d.ts

@@ -10,6 +10,11 @@ declare const _default: {
                     type: string;
                     optional: boolean;
                 };
+                type: {
+                    type: string;
+                    values: string[];
+                    optional: boolean;
+                };
                 id: {
                     type: string;
                     minLength: number;

package/dist/types/validator.d.ts

@@ -1,2 +1 @@
 export { validateAttrs, validator } from './validator/validator';
-export type { Content, ErrorCallback, Output, ValidationError, ValidationErrorType, ValidationMode, ValidationOptions, } from './types/validatorTypes';

package/empty-adf/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/empty-adf.js",
   "module": "../dist/esm/empty-adf.js",
   "module:es2019": "../dist/es2019/empty-adf.js",
+  "sideEffects": false,
   "types": "../dist/types/empty-adf.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-utils",
-  "version": "16.0.2",
+  "version": "17.1.1",
   "description": "Set of utilities to traverse, modify and create ADF documents.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -16,21 +16,32 @@
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "team": "Editor",
-    "deprecatedAutoEntryPoints": true,
     "inPublicMirror": true,
     "releaseModel": "scheduled"
   },
+  "af:exports": {
+    "./builders": "./src/builders.ts",
+    "./empty-adf": "./src/empty-adf.ts",
+    "./scrub": "./src/scrub.ts",
+    "./transforms": "./src/transforms.ts",
+    "./traverse": "./src/traverse.ts",
+    "./validator": "./src/validator.ts",
+    "./types": "./src/types/index.ts",
+    "./validatorTypes": "./src/types/validatorTypes.ts"
+  },
   "scripts": {
     "generate:spec": "rm -rf ./src/validator/specs/ && ../json-schema-generator/bin.js --outDir=./src/validator/specs/ --mode=Spec --stage=0 ./src/validator/entry.ts"
   },
   "dependencies": {
-    "@atlaskit/adf-schema": "^23.0.0",
+    "@atlaskit/adf-schema": "^23.3.0",
+    "@atlaskit/codemod-utils": "^4.1.0",
     "@babel/runtime": "^7.0.0"
   },
   "devDependencies": {
     "@atlaskit/docs": "*",
     "@atlaskit/json-schema-generator": "^3.2.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
+    "jscodeshift": "^0.13.0",
     "react": "^16.8.0",
     "typescript": "4.2.4",
     "wait-for-expect": "^1.2.0"

package/report.api.md

@@ -0,0 +1,7 @@
+## API Report File for "@atlaskit/adf-utils"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+export {};
+```

package/scrub/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/scrub.js",
   "module": "../dist/esm/scrub.js",
   "module:es2019": "../dist/es2019/scrub.js",
+  "sideEffects": false,
   "types": "../dist/types/scrub.d.ts"
 }

package/transforms/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/adf-utils/transforms",
+  "main": "../dist/cjs/transforms.js",
+  "module": "../dist/esm/transforms.js",
+  "module:es2019": "../dist/es2019/transforms.js",
+  "sideEffects": false,
+  "types": "../dist/types/transforms.d.ts"
+}

package/traverse/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/traverse.js",
   "module": "../dist/esm/traverse.js",
   "module:es2019": "../dist/es2019/traverse.js",
+  "sideEffects": false,
   "types": "../dist/types/traverse.d.ts"
 }

package/tsconfig.json

@@ -9,6 +9,7 @@
     "./docs/**/*.ts",
     "./docs/**/*.tsx",
     "./examples/**/*.ts",
-    "./examples/**/*.tsx"
+    "./examples/**/*.tsx",
+    "codemods"
   ]
 }

package/types/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/adf-utils/types",
+  "main": "../dist/cjs/types/index.js",
+  "module": "../dist/esm/types/index.js",
+  "module:es2019": "../dist/es2019/types/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/types/index.d.ts"
+}

package/validator/package.json

@@ -3,5 +3,6 @@
   "main": "../dist/cjs/validator.js",
   "module": "../dist/esm/validator.js",
   "module:es2019": "../dist/es2019/validator.js",
+  "sideEffects": false,
   "types": "../dist/types/validator.d.ts"
 }

package/validatorTypes/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/adf-utils/validatorTypes",
+  "main": "../dist/cjs/types/validatorTypes.js",
+  "module": "../dist/esm/types/validatorTypes.js",
+  "module:es2019": "../dist/es2019/types/validatorTypes.js",
+  "sideEffects": false,
+  "types": "../dist/types/types/validatorTypes.d.ts"
+}

package/media-link-transform/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "@atlaskit/adf-utils/media-link-transform",
-  "main": "../dist/cjs/media-link-transform.js",
-  "module": "../dist/esm/media-link-transform.js",
-  "module:es2019": "../dist/es2019/media-link-transform.js",
-  "types": "../dist/types/media-link-transform.d.ts"
-}