@atlaskit/adf-utils 18.4.2 → 19.0.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/adf-utils
 
+## 19.0.0
+
+### Major Changes
+
+- [`68ef7e6146c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/68ef7e6146c) - [ADF change] added widthType attribute to mediaSingle node, to support fixed width media node.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 18.4.3
+
+### Patch Changes
+
+- [`c630941e8ca`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c630941e8ca) - Fix validation spec and modify default card node replacement where rest of the attributes are spread on top of replaced URL
+
 ## 18.4.2
 
 ### Patch Changes

package/dist/cjs/scrub/default-node-replacements.js

@@ -14,9 +14,9 @@ var card = function card(node, _ref) {
   var valueReplacements = _ref.valueReplacements;
   return {
     type: node.type,
-    attrs: {
+    attrs: _objectSpread(_objectSpread({}, node.attrs || {}), {}, {
       url: valueReplacements.href((_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.url)
-    }
+    })
   };
 };
 var mediaParent = function mediaParent(node) {

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

@@ -23,7 +23,7 @@ var BYPASS_ATTR_LIST = {
   inlineExtension: ['extensionKey', 'extensionType', 'layout'],
   layoutColumn: ['width'],
   media: ['__fileMimeType', '__fileSize', 'height', 'width', 'type'],
-  mediaSingle: ['layout', 'width'],
+  mediaSingle: ['layout', 'width', 'widthType'],
   orderedList: ['order'],
   panel: ['panelType'],
   status: ['color', 'style'],

package/dist/cjs/validator/specs/blockCard.js

@@ -11,19 +11,6 @@ var _default = {
       values: ['blockCard']
     },
     attrs: [{
-      props: {
-        url: {
-          type: 'string',
-          validatorFn: 'safeUrl'
-        }
-      }
-    }, {
-      props: {
-        data: {
-          type: 'object'
-        }
-      }
-    }, {
       props: {
         url: {
           type: 'string',
@@ -65,6 +52,19 @@ var _default = {
           optional: true
         }
       }
+    }, {
+      props: {
+        url: {
+          type: 'string',
+          validatorFn: 'safeUrl'
+        }
+      }
+    }, {
+      props: {
+        data: {
+          type: 'object'
+        }
+      }
     }]
   },
   required: ['attrs']

package/dist/cjs/validator/specs/mediaSingle.js

@@ -10,8 +10,13 @@ var _default = {
       type: 'enum',
       values: ['mediaSingle']
     },
-    attrs: {
+    attrs: [{
       props: {
+        widthType: {
+          type: 'enum',
+          values: ['percentage'],
+          optional: true
+        },
         width: {
           type: 'number',
           minimum: 0,
@@ -22,9 +27,23 @@ var _default = {
           type: 'enum',
           values: ['wide', 'full-width', 'center', 'wrap-right', 'wrap-left', 'align-end', 'align-start']
         }
-      },
-      optional: true
-    },
+      }
+    }, {
+      props: {
+        width: {
+          type: 'number',
+          minimum: 0
+        },
+        widthType: {
+          type: 'enum',
+          values: ['pixel']
+        },
+        layout: {
+          type: 'enum',
+          values: ['wide', 'full-width', 'center', 'wrap-right', 'wrap-left', 'align-end', 'align-start']
+        }
+      }
+    }],
     marks: {
       type: 'array',
       items: ['link'],

package/dist/cjs/validator/validator.js

@@ -708,7 +708,11 @@ function validator(nodes, marks, options) {
     // Required Props
     // For object format based on `optional` property
     var _partitionObject7 = partitionObject(validatorSpec.props, function (k, v) {
-        return v.optional || (0, _utils.isDefined)(prevEntity[k]);
+        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;
+        return isOptional || (0, _utils.isDefined)(prevEntity[k]);
       }),
       _partitionObject8 = (0, _slicedToArray2.default)(_partitionObject7, 2),
       missingProps = _partitionObject8[1];

package/dist/cjs/version.json

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

package/dist/es2019/scrub/default-node-replacements.js

@@ -6,6 +6,7 @@ const card = (node, {
   return {
     type: node.type,
     attrs: {
+      ...(node.attrs || {}),
       url: valueReplacements.href((_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.url)
     }
   };

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

@@ -10,7 +10,7 @@ const BYPASS_ATTR_LIST = {
   inlineExtension: ['extensionKey', 'extensionType', 'layout'],
   layoutColumn: ['width'],
   media: ['__fileMimeType', '__fileSize', 'height', 'width', 'type'],
-  mediaSingle: ['layout', 'width'],
+  mediaSingle: ['layout', 'width', 'widthType'],
   orderedList: ['order'],
   panel: ['panelType'],
   status: ['color', 'style'],

package/dist/es2019/validator/specs/blockCard.js

@@ -5,19 +5,6 @@ export default {
       values: ['blockCard']
     },
     attrs: [{
-      props: {
-        url: {
-          type: 'string',
-          validatorFn: 'safeUrl'
-        }
-      }
-    }, {
-      props: {
-        data: {
-          type: 'object'
-        }
-      }
-    }, {
       props: {
         url: {
           type: 'string',
@@ -59,6 +46,19 @@ export default {
           optional: true
         }
       }
+    }, {
+      props: {
+        url: {
+          type: 'string',
+          validatorFn: 'safeUrl'
+        }
+      }
+    }, {
+      props: {
+        data: {
+          type: 'object'
+        }
+      }
     }]
   },
   required: ['attrs']

package/dist/es2019/validator/specs/mediaSingle.js

@@ -4,8 +4,13 @@ export default {
       type: 'enum',
       values: ['mediaSingle']
     },
-    attrs: {
+    attrs: [{
       props: {
+        widthType: {
+          type: 'enum',
+          values: ['percentage'],
+          optional: true
+        },
         width: {
           type: 'number',
           minimum: 0,
@@ -16,9 +21,23 @@ export default {
           type: 'enum',
           values: ['wide', 'full-width', 'center', 'wrap-right', 'wrap-left', 'align-end', 'align-start']
         }
-      },
-      optional: true
-    },
+      }
+    }, {
+      props: {
+        width: {
+          type: 'number',
+          minimum: 0
+        },
+        widthType: {
+          type: 'enum',
+          values: ['pixel']
+        },
+        layout: {
+          type: 'enum',
+          values: ['wide', 'full-width', 'center', 'wrap-right', 'wrap-left', 'align-end', 'align-start']
+        }
+      }
+    }],
     marks: {
       type: 'array',
       items: ['link'],

package/dist/es2019/validator/validator.js

@@ -672,7 +672,13 @@ export function validator(nodes, marks, options) {
 
     // Required Props
     // For object format based on `optional` property
-    const [, missingProps] = partitionObject(validatorSpec.props, (k, v) => v.optional || isDefined(prevEntity[k]));
+    const [, missingProps] = partitionObject(validatorSpec.props, (k, v) => {
+      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;
+      return isOptional || isDefined(prevEntity[k]);
+    });
     if (missingProps.length) {
       return {
         hasValidated: true,

package/dist/es2019/version.json

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

package/dist/esm/scrub/default-node-replacements.js

@@ -7,9 +7,9 @@ var card = function card(node, _ref) {
   var valueReplacements = _ref.valueReplacements;
   return {
     type: node.type,
-    attrs: {
+    attrs: _objectSpread(_objectSpread({}, node.attrs || {}), {}, {
       url: valueReplacements.href((_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.url)
-    }
+    })
   };
 };
 var mediaParent = function mediaParent(node) {

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

@@ -16,7 +16,7 @@ var BYPASS_ATTR_LIST = {
   inlineExtension: ['extensionKey', 'extensionType', 'layout'],
   layoutColumn: ['width'],
   media: ['__fileMimeType', '__fileSize', 'height', 'width', 'type'],
-  mediaSingle: ['layout', 'width'],
+  mediaSingle: ['layout', 'width', 'widthType'],
   orderedList: ['order'],
   panel: ['panelType'],
   status: ['color', 'style'],

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

@@ -5,19 +5,6 @@ export default {
       values: ['blockCard']
     },
     attrs: [{
-      props: {
-        url: {
-          type: 'string',
-          validatorFn: 'safeUrl'
-        }
-      }
-    }, {
-      props: {
-        data: {
-          type: 'object'
-        }
-      }
-    }, {
       props: {
         url: {
           type: 'string',
@@ -59,6 +46,19 @@ export default {
           optional: true
         }
       }
+    }, {
+      props: {
+        url: {
+          type: 'string',
+          validatorFn: 'safeUrl'
+        }
+      }
+    }, {
+      props: {
+        data: {
+          type: 'object'
+        }
+      }
     }]
   },
   required: ['attrs']

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

@@ -4,8 +4,13 @@ export default {
       type: 'enum',
       values: ['mediaSingle']
     },
-    attrs: {
+    attrs: [{
       props: {
+        widthType: {
+          type: 'enum',
+          values: ['percentage'],
+          optional: true
+        },
         width: {
           type: 'number',
           minimum: 0,
@@ -16,9 +21,23 @@ export default {
           type: 'enum',
           values: ['wide', 'full-width', 'center', 'wrap-right', 'wrap-left', 'align-end', 'align-start']
         }
-      },
-      optional: true
-    },
+      }
+    }, {
+      props: {
+        width: {
+          type: 'number',
+          minimum: 0
+        },
+        widthType: {
+          type: 'enum',
+          values: ['pixel']
+        },
+        layout: {
+          type: 'enum',
+          values: ['wide', 'full-width', 'center', 'wrap-right', 'wrap-left', 'align-end', 'align-start']
+        }
+      }
+    }],
     marks: {
       type: 'array',
       items: ['link'],

package/dist/esm/validator/validator.js

@@ -697,7 +697,11 @@ export function validator(nodes, marks, options) {
     // Required Props
     // For object format based on `optional` property
     var _partitionObject7 = partitionObject(validatorSpec.props, function (k, v) {
-        return v.optional || isDefined(prevEntity[k]);
+        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;
+        return isOptional || isDefined(prevEntity[k]);
       }),
       _partitionObject8 = _slicedToArray(_partitionObject7, 2),
       missingProps = _partitionObject8[1];

package/dist/esm/version.json

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

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

@@ -1,2 +1,2 @@
-import { MediaSingleDefinition, MediaDefinition, RichMediaAttributes as MediaSingleAttributes, CaptionDefinition } from '@atlaskit/adf-schema';
+import { MediaSingleDefinition, MediaDefinition, ExtendedMediaAttributes as MediaSingleAttributes, CaptionDefinition } from '@atlaskit/adf-schema';
 export declare const mediaSingle: (attrs: MediaSingleAttributes | undefined) => (content: MediaDefinition | [MediaDefinition] | [MediaDefinition, CaptionDefinition]) => MediaSingleDefinition;

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

@@ -5,28 +5,6 @@ declare const _default: {
             values: string[];
         };
         attrs: ({
-            props: {
-                url: {
-                    type: string;
-                    validatorFn: string;
-                    optional?: undefined;
-                };
-                data?: undefined;
-                datasource?: undefined;
-                width?: undefined;
-                layout?: undefined;
-            };
-        } | {
-            props: {
-                data: {
-                    type: string;
-                };
-                url?: undefined;
-                datasource?: undefined;
-                width?: undefined;
-                layout?: undefined;
-            };
-        } | {
             props: {
                 url: {
                     type: string;
@@ -69,6 +47,28 @@ declare const _default: {
                 };
                 data?: undefined;
             };
+        } | {
+            props: {
+                url: {
+                    type: string;
+                    validatorFn: string;
+                    optional?: undefined;
+                };
+                datasource?: undefined;
+                width?: undefined;
+                layout?: undefined;
+                data?: undefined;
+            };
+        } | {
+            props: {
+                data: {
+                    type: string;
+                };
+                url?: undefined;
+                datasource?: undefined;
+                width?: undefined;
+                layout?: undefined;
+            };
         })[];
     };
     required: string[];

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

@@ -4,8 +4,13 @@ declare const _default: {
             type: string;
             values: string[];
         };
-        attrs: {
+        attrs: ({
             props: {
+                widthType: {
+                    type: string;
+                    values: string[];
+                    optional: boolean;
+                };
                 width: {
                     type: string;
                     minimum: number;
@@ -17,8 +22,25 @@ declare const _default: {
                     values: string[];
                 };
             };
-            optional: boolean;
-        };
+        } | {
+            props: {
+                width: {
+                    type: string;
+                    minimum: number;
+                    maximum?: undefined;
+                    optional?: undefined;
+                };
+                widthType: {
+                    type: string;
+                    values: string[];
+                    optional?: undefined;
+                };
+                layout: {
+                    type: string;
+                    values: string[];
+                };
+            };
+        })[];
         marks: {
             type: string;
             items: string[];

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

@@ -1,4 +1,4 @@
-import { MediaSingleDefinition, MediaDefinition, RichMediaAttributes as MediaSingleAttributes, CaptionDefinition } from '@atlaskit/adf-schema';
+import { MediaSingleDefinition, MediaDefinition, ExtendedMediaAttributes as MediaSingleAttributes, CaptionDefinition } from '@atlaskit/adf-schema';
 export declare const mediaSingle: (attrs: MediaSingleAttributes | undefined) => (content: MediaDefinition | [
     MediaDefinition
 ] | [

package/dist/types-ts4.5/validator/specs/blockCard.d.ts

@@ -5,28 +5,6 @@ declare const _default: {
             values: string[];
         };
         attrs: ({
-            props: {
-                url: {
-                    type: string;
-                    validatorFn: string;
-                    optional?: undefined;
-                };
-                data?: undefined;
-                datasource?: undefined;
-                width?: undefined;
-                layout?: undefined;
-            };
-        } | {
-            props: {
-                data: {
-                    type: string;
-                };
-                url?: undefined;
-                datasource?: undefined;
-                width?: undefined;
-                layout?: undefined;
-            };
-        } | {
             props: {
                 url: {
                     type: string;
@@ -69,6 +47,28 @@ declare const _default: {
                 };
                 data?: undefined;
             };
+        } | {
+            props: {
+                url: {
+                    type: string;
+                    validatorFn: string;
+                    optional?: undefined;
+                };
+                datasource?: undefined;
+                width?: undefined;
+                layout?: undefined;
+                data?: undefined;
+            };
+        } | {
+            props: {
+                data: {
+                    type: string;
+                };
+                url?: undefined;
+                datasource?: undefined;
+                width?: undefined;
+                layout?: undefined;
+            };
         })[];
     };
     required: string[];

package/dist/types-ts4.5/validator/specs/mediaSingle.d.ts

@@ -4,8 +4,13 @@ declare const _default: {
             type: string;
             values: string[];
         };
-        attrs: {
+        attrs: ({
             props: {
+                widthType: {
+                    type: string;
+                    values: string[];
+                    optional: boolean;
+                };
                 width: {
                     type: string;
                     minimum: number;
@@ -17,8 +22,25 @@ declare const _default: {
                     values: string[];
                 };
             };
-            optional: boolean;
-        };
+        } | {
+            props: {
+                width: {
+                    type: string;
+                    minimum: number;
+                    maximum?: undefined;
+                    optional?: undefined;
+                };
+                widthType: {
+                    type: string;
+                    values: string[];
+                    optional?: undefined;
+                };
+                layout: {
+                    type: string;
+                    values: string[];
+                };
+            };
+        })[];
         marks: {
             type: string;
             items: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-utils",
-  "version": "18.4.2",
+  "version": "19.0.0",
   "description": "Set of utilities to traverse, modify and create ADF documents.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -41,7 +41,7 @@
     "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": "^25.9.0",
+    "@atlaskit/adf-schema": "^26.0.0",
     "@atlaskit/codemod-utils": "^4.2.0",
     "@babel/runtime": "^7.0.0"
   },