@atlaskit/adf-utils 19.25.4 → 19.26.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/adf-utils
 
+## 19.26.1
+
+### Patch Changes
+
+- [`97ab189b05912`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/97ab189b05912) -
+  Fix bug causing the ADF scrubber to throw an error when document contains very long words
+
+## 19.26.0
+
+### Minor Changes
+
+- [`3ff7946f17075`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3ff7946f17075) -
+  EDF-2768 add adf width validation transform
+
 ## 19.25.4
 
 ### Patch Changes

package/dist/cjs/scrub/scrub-content.js

@@ -9,6 +9,7 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 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 DUMMY_TEXT = "Lorem ipsum dolor sit amet consectetur adipiscing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua Ut enim ad minim veniam quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur Excepteur sint occaecat cupidatat non proident sunt in culpa qui officia deserunt mollit anim id est laborum";
@@ -83,8 +84,10 @@ var scrubStr = exports.scrubStr = function scrubStr(val) {
       return '';
     } else {
       // Everything else
-      var correction = base[offset] === ' ' ? 1 : 0;
-      var raw = base[offset + correction];
+
+      // modulo to ensure wrapping occurs around base string (no OOB access)
+      var correction = base[offset % base.length] === ' ' ? 1 : 0;
+      var raw = (0, _platformFeatureFlags.fg)('platform_adf-utils_fix-dummy-text-index-oob') ? base[(offset + correction) % base.length] : base[offset + correction];
       var isLower = char.toLowerCase() === char;
       var result = isLower ? raw.toLowerCase() : raw.toUpperCase();
       offset += 1 + correction;

package/dist/cjs/transforms/transform-media-single-width.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.transformMediaSingleWidth = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _traverse = require("../traverse/traverse");
+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; }
+// when media single has a invalid width, we fallback to default width
+// this the last resort when revert the pixel width, we couldnt determine the correct width value
+var transformMediaSingleWidth = exports.transformMediaSingleWidth = function transformMediaSingleWidth(adf) {
+  var isTransformed = false;
+  var transformedAdf = (0, _traverse.traverse)(adf, {
+    mediaSingle: function mediaSingle(node) {
+      var _ref = node.attrs || {},
+        width = _ref.width,
+        widthType = _ref.widthType;
+
+      // if width is not a number or greater than 100, and widthType is not set, we set width to 100
+      if (typeof width === 'number' && width > 100 && !widthType) {
+        isTransformed = true;
+        var newAttrs = _objectSpread(_objectSpread({}, node.attrs), {}, {
+          width: 100
+        });
+        return _objectSpread(_objectSpread({}, node), {}, {
+          attrs: newAttrs
+        });
+      }
+      return node;
+    }
+  });
+  return {
+    transformedAdf: transformedAdf,
+    isTransformed: isTransformed
+  };
+};

package/dist/cjs/transforms.js

@@ -45,6 +45,12 @@ Object.defineProperty(exports, "transformMediaLinkMarks", {
     return _mediaLinkTransform.transformMediaLinkMarks;
   }
 });
+Object.defineProperty(exports, "transformMediaSingleWidth", {
+  enumerable: true,
+  get: function get() {
+    return _transformMediaSingleWidth.transformMediaSingleWidth;
+  }
+});
 Object.defineProperty(exports, "transformNestedTableNodeOutgoingDocument", {
   enumerable: true,
   get: function get() {
@@ -71,6 +77,7 @@ Object.defineProperty(exports, "transformTextLinkCodeMarks", {
 });
 var _mediaLinkTransform = require("./transforms/media-link-transform");
 var _textLinkCodeTransform = require("./transforms/text-link-code-transform");
+var _transformMediaSingleWidth = require("./transforms/transform-media-single-width");
 var _dedupeMarksTransform = require("./transforms/dedupe-marks-transform");
 var _nodesMissingContentTransform = require("./transforms/nodes-missing-content-transform");
 var _indentationMarksTransform = require("./transforms/indentation-marks-transform");

package/dist/es2019/scrub/scrub-content.js

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 const DUMMY_TEXT = `Lorem ipsum dolor sit amet consectetur adipiscing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua Ut enim ad minim veniam quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur Excepteur sint occaecat cupidatat non proident sunt in culpa qui officia deserunt mollit anim id est laborum`;
 const DUMMY_DIGITS = ['2', '7', '4', '3', '5', '9', '1', '8', '0', '5'];
 const BYPASS_ATTR_LIST = {
@@ -65,8 +66,10 @@ export const scrubStr = (val, offset = 0) => {
       return '';
     } else {
       // Everything else
-      const correction = base[offset] === ' ' ? 1 : 0;
-      const raw = base[offset + correction];
+
+      // modulo to ensure wrapping occurs around base string (no OOB access)
+      const correction = base[offset % base.length] === ' ' ? 1 : 0;
+      const raw = fg('platform_adf-utils_fix-dummy-text-index-oob') ? base[(offset + correction) % base.length] : base[offset + correction];
       const isLower = char.toLowerCase() === char;
       const result = isLower ? raw.toLowerCase() : raw.toUpperCase();
       offset += 1 + correction;

package/dist/es2019/transforms/transform-media-single-width.js

@@ -0,0 +1,32 @@
+import { traverse } from '../traverse/traverse';
+// when media single has a invalid width, we fallback to default width
+// this the last resort when revert the pixel width, we couldnt determine the correct width value
+export const transformMediaSingleWidth = adf => {
+  let isTransformed = false;
+  const transformedAdf = traverse(adf, {
+    mediaSingle: node => {
+      const {
+        width,
+        widthType
+      } = node.attrs || {};
+
+      // if width is not a number or greater than 100, and widthType is not set, we set width to 100
+      if (typeof width === 'number' && width > 100 && !widthType) {
+        isTransformed = true;
+        const newAttrs = {
+          ...node.attrs,
+          width: 100
+        };
+        return {
+          ...node,
+          attrs: newAttrs
+        };
+      }
+      return node;
+    }
+  });
+  return {
+    transformedAdf,
+    isTransformed
+  };
+};

package/dist/es2019/transforms.js

@@ -3,6 +3,7 @@
 
 export { transformMediaLinkMarks } from './transforms/media-link-transform';
 export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';
+export { transformMediaSingleWidth } from './transforms/transform-media-single-width';
 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/scrub/scrub-content.js

@@ -4,6 +4,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 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 { fg } from '@atlaskit/platform-feature-flags';
 var DUMMY_TEXT = "Lorem ipsum dolor sit amet consectetur adipiscing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua Ut enim ad minim veniam quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur Excepteur sint occaecat cupidatat non proident sunt in culpa qui officia deserunt mollit anim id est laborum";
 var DUMMY_DIGITS = ['2', '7', '4', '3', '5', '9', '1', '8', '0', '5'];
 var BYPASS_ATTR_LIST = {
@@ -76,8 +77,10 @@ export var scrubStr = function scrubStr(val) {
       return '';
     } else {
       // Everything else
-      var correction = base[offset] === ' ' ? 1 : 0;
-      var raw = base[offset + correction];
+
+      // modulo to ensure wrapping occurs around base string (no OOB access)
+      var correction = base[offset % base.length] === ' ' ? 1 : 0;
+      var raw = fg('platform_adf-utils_fix-dummy-text-index-oob') ? base[(offset + correction) % base.length] : base[offset + correction];
       var isLower = char.toLowerCase() === char;
       var result = isLower ? raw.toLowerCase() : raw.toUpperCase();
       offset += 1 + correction;

package/dist/esm/transforms/transform-media-single-width.js

@@ -0,0 +1,32 @@
+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';
+// when media single has a invalid width, we fallback to default width
+// this the last resort when revert the pixel width, we couldnt determine the correct width value
+export var transformMediaSingleWidth = function transformMediaSingleWidth(adf) {
+  var isTransformed = false;
+  var transformedAdf = traverse(adf, {
+    mediaSingle: function mediaSingle(node) {
+      var _ref = node.attrs || {},
+        width = _ref.width,
+        widthType = _ref.widthType;
+
+      // if width is not a number or greater than 100, and widthType is not set, we set width to 100
+      if (typeof width === 'number' && width > 100 && !widthType) {
+        isTransformed = true;
+        var newAttrs = _objectSpread(_objectSpread({}, node.attrs), {}, {
+          width: 100
+        });
+        return _objectSpread(_objectSpread({}, node), {}, {
+          attrs: newAttrs
+        });
+      }
+      return node;
+    }
+  });
+  return {
+    transformedAdf: transformedAdf,
+    isTransformed: isTransformed
+  };
+};

package/dist/esm/transforms.js

@@ -3,6 +3,7 @@
 
 export { transformMediaLinkMarks } from './transforms/media-link-transform';
 export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';
+export { transformMediaSingleWidth } from './transforms/transform-media-single-width';
 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/transforms/transform-media-single-width.d.ts

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

package/dist/types/transforms.d.ts

@@ -1,5 +1,6 @@
 export { transformMediaLinkMarks } from './transforms/media-link-transform';
 export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';
+export { transformMediaSingleWidth } from './transforms/transform-media-single-width';
 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-ts4.5/transforms/transform-media-single-width.d.ts

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/adf-utils",
-	"version": "19.25.4",
+	"version": "19.26.1",
 	"description": "Set of utilities to traverse, modify and create ADF documents.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -27,10 +27,12 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^51.3.2",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"devDependencies": {
 		"@atlassian/adf-schema-json": "^1.31.0",
+		"@atlassian/feature-flags-test-utils": "^1.0.0",
 		"react": "^18.2.0",
 		"wait-for-expect": "^1.2.0"
 	},
@@ -47,5 +49,9 @@
 			]
 		}
 	},
-	"platform-feature-flags": {}
+	"platform-feature-flags": {
+		"platform_adf-utils_fix-dummy-text-index-oob": {
+			"type": "boolean"
+		}
+	}
 }