@atlaskit/adf-utils 19.19.0 → 19.20.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/adf-utils
 
+## 19.20.0
+
+### Minor Changes
+
+- [#160422](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/160422)
+  [`83606959c73cd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/83606959c73cd) -
+  EDITOR-719 Overrides adf validation of nested tables for nested renderers inside bodied extensions
+  and reverts a previous change to transformNestedTablesIncomingDocument which prevented nested
+  tables inside bodied extensions from being transformed by their parent renderer. This was due to a
+  bug with comment positions of nested tables inside bodied extensions which meant their positions
+  were not being calculated correctly due to not being transformed in the parent renderer.
+
 ## 19.19.0
 
 ### Minor Changes

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

@@ -34,6 +34,8 @@ var transformNestedTableExtension = function transformNestedTableExtension(neste
     throw new _errors.NodeNestingTransformError('Failed to parse nested table content');
   }
 };
+
+// TODO: EDITOR-806 - Remove when cleaning feature gate platform_editor_nested_table_extension_comment_fix
 function isInsideBodiedExtension(parent) {
   var _parent$parent;
   if (parent.node === undefined) {
@@ -53,11 +55,12 @@ var transformNestedTablesIncomingDocument = exports.transformNestedTablesIncomin
   var transformedAdf = (0, _traverse.traverse)(adf, {
     extension: function extension(node, parent) {
       if (isNestedTableExtension(node)) {
+        // TODO: EDITOR-806 - Remove this block when cleaning feature gate platform_editor_nested_table_extension_comment_fix
         // Bodied extensions in renderer use their own nested renderer to render the content.
         // This results in the document being validated/transformed twice, once with untransformed content and again with transformed content.
         // Since the untransformed content is valid ADF (table as extension in table) but the transformed content is not valid ADF, (table in table)
         // we need to skip transforming nested tables inside bodied extensions in renderer on the first pass or else it will fail validation and render an unsupported block.
-        if (options.environment === 'renderer' && isInsideBodiedExtension(parent)) {
+        if (options.environment === 'renderer' && isInsideBodiedExtension(parent) && !options.disableNestedRendererTreatment) {
           return undefined;
         }
         isTransformed = true;

package/dist/cjs/validator/validator.js

@@ -1,12 +1,13 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _typeof = require("@babel/runtime/helpers/typeof");
+var _typeof3 = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.validateAttrs = validateAttrs;
 exports.validator = validator;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
@@ -16,7 +17,7 @@ var _rules = require("./rules");
 var _excluded = ["items"]; // Ignored via go/ees005
 // eslint-disable-next-line import/no-namespace
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof3(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 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; }
 // Ignored via go/ees005
@@ -277,9 +278,13 @@ var invalidChildContent = function invalidChildContent(child, errorCallback, par
   if (!errorCallback) {
     throw new Error(message);
   } else {
+    var _parentSpec$props;
     return errorCallback(_objectSpread({}, child), {
       code: 'INVALID_CONTENT',
-      message: message
+      message: message,
+      meta: {
+        parentType: parentSpec === null || parentSpec === void 0 || (_parentSpec$props = parentSpec.props) === null || _parentSpec$props === void 0 || (_parentSpec$props = _parentSpec$props.type) === null || _parentSpec$props === void 0 ? void 0 : _parentSpec$props.values[0]
+      }
     }, getUnsupportedOptions(parentSpec));
   }
 };
@@ -785,7 +790,7 @@ function validator(nodes, marks, options) {
         var _validatorSpec$requir;
         // if the validator is an array, then check
         // if the `required` field contains the key.
-        var isOptional = Array.isArray(v) ? !((_validatorSpec$requir = validatorSpec.required) !== null && _validatorSpec$requir !== void 0 && _validatorSpec$requir.includes(k)) : v.optional;
+        var isOptional = Array.isArray(v) ? !((_validatorSpec$requir = validatorSpec.required) !== null && _validatorSpec$requir !== void 0 && _validatorSpec$requir.includes(k)) : (0, _typeof2.default)(v) === 'object' && v !== null && 'optional' in v ? v.optional : false;
         return isOptional || (0, _utils.isDefined)(prevEntity[k]);
       }),
       _partitionObject8 = (0, _slicedToArray2.default)(_partitionObject7, 2),

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

@@ -24,6 +24,8 @@ const transformNestedTableExtension = nestedTableExtension => {
     throw new NodeNestingTransformError('Failed to parse nested table content');
   }
 };
+
+// TODO: EDITOR-806 - Remove when cleaning feature gate platform_editor_nested_table_extension_comment_fix
 function isInsideBodiedExtension(parent) {
   var _parent$parent;
   if (parent.node === undefined) {
@@ -37,16 +39,19 @@ function isInsideBodiedExtension(parent) {
   }
   return false;
 }
-export const transformNestedTablesIncomingDocument = (adf, options = {}) => {
+export const transformNestedTablesIncomingDocument = (adf,
+// TODO: EDITOR-806 - Remove options when cleaning feature gate platform_editor_nested_table_extension_comment_fix as no longer needed
+options = {}) => {
   let isTransformed = false;
   const transformedAdf = traverse(adf, {
     extension: (node, parent) => {
       if (isNestedTableExtension(node)) {
+        // TODO: EDITOR-806 - Remove this block when cleaning feature gate platform_editor_nested_table_extension_comment_fix
         // Bodied extensions in renderer use their own nested renderer to render the content.
         // This results in the document being validated/transformed twice, once with untransformed content and again with transformed content.
         // Since the untransformed content is valid ADF (table as extension in table) but the transformed content is not valid ADF, (table in table)
         // we need to skip transforming nested tables inside bodied extensions in renderer on the first pass or else it will fail validation and render an unsupported block.
-        if (options.environment === 'renderer' && isInsideBodiedExtension(parent)) {
+        if (options.environment === 'renderer' && isInsideBodiedExtension(parent) && !options.disableNestedRendererTreatment) {
           return undefined;
         }
         isTransformed = true;

package/dist/es2019/validator/validator.js

@@ -238,11 +238,15 @@ const invalidChildContent = (child, errorCallback, parentSpec) => {
   if (!errorCallback) {
     throw new Error(message);
   } else {
+    var _parentSpec$props, _parentSpec$props$typ;
     return errorCallback({
       ...child
     }, {
       code: 'INVALID_CONTENT',
-      message
+      message,
+      meta: {
+        parentType: parentSpec === null || parentSpec === void 0 ? void 0 : (_parentSpec$props = parentSpec.props) === null || _parentSpec$props === void 0 ? void 0 : (_parentSpec$props$typ = _parentSpec$props.type) === null || _parentSpec$props$typ === void 0 ? void 0 : _parentSpec$props$typ.values[0]
+      }
     }, getUnsupportedOptions(parentSpec));
   }
 };
@@ -749,7 +753,7 @@ export function validator(nodes, marks, options) {
       var _validatorSpec$requir;
       // if the validator is an array, then check
       // if the `required` field contains the key.
-      const isOptional = Array.isArray(v) ? !((_validatorSpec$requir = validatorSpec.required) !== null && _validatorSpec$requir !== void 0 && _validatorSpec$requir.includes(k)) : v.optional;
+      const isOptional = Array.isArray(v) ? !((_validatorSpec$requir = validatorSpec.required) !== null && _validatorSpec$requir !== void 0 && _validatorSpec$requir.includes(k)) : typeof v === 'object' && v !== null && 'optional' in v ? v.optional : false;
       return isOptional || isDefined(prevEntity[k]);
     });
     if (missingProps.length) {

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

@@ -27,6 +27,8 @@ var transformNestedTableExtension = function transformNestedTableExtension(neste
     throw new NodeNestingTransformError('Failed to parse nested table content');
   }
 };
+
+// TODO: EDITOR-806 - Remove when cleaning feature gate platform_editor_nested_table_extension_comment_fix
 function isInsideBodiedExtension(parent) {
   var _parent$parent;
   if (parent.node === undefined) {
@@ -46,11 +48,12 @@ export var transformNestedTablesIncomingDocument = function transformNestedTable
   var transformedAdf = traverse(adf, {
     extension: function extension(node, parent) {
       if (isNestedTableExtension(node)) {
+        // TODO: EDITOR-806 - Remove this block when cleaning feature gate platform_editor_nested_table_extension_comment_fix
         // Bodied extensions in renderer use their own nested renderer to render the content.
         // This results in the document being validated/transformed twice, once with untransformed content and again with transformed content.
         // Since the untransformed content is valid ADF (table as extension in table) but the transformed content is not valid ADF, (table in table)
         // we need to skip transforming nested tables inside bodied extensions in renderer on the first pass or else it will fail validation and render an unsupported block.
-        if (options.environment === 'renderer' && isInsideBodiedExtension(parent)) {
+        if (options.environment === 'renderer' && isInsideBodiedExtension(parent) && !options.disableNestedRendererTreatment) {
           return undefined;
         }
         isTransformed = true;

package/dist/esm/validator/validator.js

@@ -1,3 +1,4 @@
+import _typeof from "@babel/runtime/helpers/typeof";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
@@ -268,9 +269,13 @@ var invalidChildContent = function invalidChildContent(child, errorCallback, par
   if (!errorCallback) {
     throw new Error(message);
   } else {
+    var _parentSpec$props;
     return errorCallback(_objectSpread({}, child), {
       code: 'INVALID_CONTENT',
-      message: message
+      message: message,
+      meta: {
+        parentType: parentSpec === null || parentSpec === void 0 || (_parentSpec$props = parentSpec.props) === null || _parentSpec$props === void 0 || (_parentSpec$props = _parentSpec$props.type) === null || _parentSpec$props === void 0 ? void 0 : _parentSpec$props.values[0]
+      }
     }, getUnsupportedOptions(parentSpec));
   }
 };
@@ -776,7 +781,7 @@ export function validator(nodes, marks, options) {
         var _validatorSpec$requir;
         // if the validator is an array, then check
         // if the `required` field contains the key.
-        var isOptional = Array.isArray(v) ? !((_validatorSpec$requir = validatorSpec.required) !== null && _validatorSpec$requir !== void 0 && _validatorSpec$requir.includes(k)) : v.optional;
+        var isOptional = Array.isArray(v) ? !((_validatorSpec$requir = validatorSpec.required) !== null && _validatorSpec$requir !== void 0 && _validatorSpec$requir.includes(k)) : _typeof(v) === 'object' && v !== null && 'optional' in v ? v.optional : false;
         return isOptional || isDefined(prevEntity[k]);
       }),
       _partitionObject8 = _slicedToArray(_partitionObject7, 2),

package/dist/types/builders/nodes/media.d.ts

@@ -1,2 +1,2 @@
-import { type MediaDefinition, type MediaAttributes } from '@atlaskit/adf-schema';
-export declare const media: (attrs: MediaAttributes) => MediaDefinition;
+import { type MediaDefinition, type MediaADFAttrs } from '@atlaskit/adf-schema';
+export declare const media: (attrs: MediaADFAttrs) => MediaDefinition;

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

@@ -2,6 +2,7 @@ import type { ADFEntity } from '../types';
 export declare const isNestedTableExtension: (extensionNode: ADFEntity) => boolean;
 export declare const transformNestedTablesIncomingDocument: (adf: ADFEntity, options?: {
     environment?: 'renderer' | 'editor';
+    disableNestedRendererTreatment?: boolean;
 }) => {
     transformedAdf: ADFEntity;
     isTransformed: boolean;

package/dist/types/types/validatorTypes.d.ts

@@ -67,6 +67,10 @@ export interface ValidatorSpecAttrs {
 }
 export interface ValidatorSpec {
     props?: {
+        type?: {
+            type: 'enum';
+            values: Array<string>;
+        };
         attrs?: ValidatorSpecAttrs;
         content?: ValidatorContent;
         text?: AttributesSpec;
@@ -96,7 +100,9 @@ export interface ValidationErrorMap {
     };
     INVALID_TYPE: never;
     INVALID_TEXT: never;
-    INVALID_CONTENT: never;
+    INVALID_CONTENT: {
+        parentType?: string;
+    };
     INVALID_CONTENT_LENGTH: {
         length: number;
         requiredLength: number;
@@ -134,5 +140,6 @@ export interface ErrorCallbackOptions {
     isMark?: any;
     allowUnsupportedBlock?: boolean;
     allowUnsupportedInline?: boolean;
+    allowNestedTables?: boolean;
 }
 export type Validate = (entity: ADFEntity, errorCallback?: ErrorCallback, allowed?: Content, parentSpec?: ValidatorSpec) => Output;

package/dist/types-ts4.5/builders/nodes/media.d.ts

@@ -1,2 +1,2 @@
-import { type MediaDefinition, type MediaAttributes } from '@atlaskit/adf-schema';
-export declare const media: (attrs: MediaAttributes) => MediaDefinition;
+import { type MediaDefinition, type MediaADFAttrs } from '@atlaskit/adf-schema';
+export declare const media: (attrs: MediaADFAttrs) => MediaDefinition;

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

@@ -2,6 +2,7 @@ import type { ADFEntity } from '../types';
 export declare const isNestedTableExtension: (extensionNode: ADFEntity) => boolean;
 export declare const transformNestedTablesIncomingDocument: (adf: ADFEntity, options?: {
     environment?: 'renderer' | 'editor';
+    disableNestedRendererTreatment?: boolean;
 }) => {
     transformedAdf: ADFEntity;
     isTransformed: boolean;

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

@@ -67,6 +67,10 @@ export interface ValidatorSpecAttrs {
 }
 export interface ValidatorSpec {
     props?: {
+        type?: {
+            type: 'enum';
+            values: Array<string>;
+        };
         attrs?: ValidatorSpecAttrs;
         content?: ValidatorContent;
         text?: AttributesSpec;
@@ -96,7 +100,9 @@ export interface ValidationErrorMap {
     };
     INVALID_TYPE: never;
     INVALID_TEXT: never;
-    INVALID_CONTENT: never;
+    INVALID_CONTENT: {
+        parentType?: string;
+    };
     INVALID_CONTENT_LENGTH: {
         length: number;
         requiredLength: number;
@@ -137,5 +143,6 @@ export interface ErrorCallbackOptions {
     isMark?: any;
     allowUnsupportedBlock?: boolean;
     allowUnsupportedInline?: boolean;
+    allowNestedTables?: boolean;
 }
 export type Validate = (entity: ADFEntity, errorCallback?: ErrorCallback, allowed?: Content, parentSpec?: ValidatorSpec) => Output;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/adf-utils",
-	"version": "19.19.0",
+	"version": "19.20.0",
 	"description": "Set of utilities to traverse, modify and create ADF documents.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -23,7 +23,7 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"atlassian": {
-		"team": "Editor: ADF"
+		"team": "Editor: Collaboration"
 	},
 	"af:exports": {
 		"./builders": "./src/builders.ts",