@atlaskit/adf-utils 18.3.0 → 18.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-utils
 
+## 18.4.0
+
+### Minor Changes
+
+- [`55d241a3794`](https://bitbucket.org/atlassian/atlassian-frontend/commits/55d241a3794) - Improve ADF validation by making deeper and stricter array checks as well as ability to have deep attribute structures.
+
 ## 18.3.0
 
 ### Minor Changes

package/dist/cjs/validator/validator.js

@@ -43,7 +43,8 @@ function mapMarksItems(spec) {
 }
 var partitionObject = function partitionObject(obj, predicate) {
   return Object.keys(obj).reduce(function (acc, key) {
-    acc[predicate(key, obj[key], obj) ? 0 : 1].push(key);
+    var result = predicate(key, obj[key], obj);
+    acc[result ? 0 : 1].push(key);
     return acc;
   }, [[], []]);
 };
@@ -152,12 +153,25 @@ function getOptionsForType(type, list) {
   }
   return false;
 }
+var isValidatorSpecAttrs = function isValidatorSpecAttrs(spec) {
+  return !!spec.props;
+};
 function validateAttrs(spec, value) {
-  // extension_node parameters has no type
-  if (!(0, _utils.isDefined)(spec.type)) {
+  if (!(0, _utils.isDefined)(value)) {
     return !!spec.optional;
   }
-  if (!(0, _utils.isDefined)(value)) {
+  if (isValidatorSpecAttrs(spec)) {
+    // If spec has ".props" it is ValidatorSpecAttrs and need to pipe back in recursively
+    var _partitionObject = partitionObject(spec.props, function (key, subSpec) {
+        return validateAttrs(subSpec, value[key]);
+      }),
+      _partitionObject2 = (0, _slicedToArray2.default)(_partitionObject, 2),
+      _ = _partitionObject2[0],
+      invalidKeys = _partitionObject2[1];
+    return invalidKeys.length === 0;
+  }
+  // extension_node parameters has no type
+  if (!(0, _utils.isDefined)(spec.type)) {
     return !!spec.optional;
   }
   switch (spec.type) {
@@ -175,14 +189,29 @@ function validateAttrs(spec, value) {
     case 'object':
       return (0, _utils.isPlainObject)(value);
     case 'array':
-      var types = spec.items;
-      var lastTypeIndex = types.length - 1;
       if (Array.isArray(value)) {
-        // We are doing this to support tuple which can be defined as [number, string]
-        // NOTE: Not validating tuples strictly
-        return value.every(function (x, i) {
-          return validateAttrs(types[Math.min(i, lastTypeIndex)], x);
-        });
+        var isTuple = !!spec.isTupleLike;
+        var minItems = spec.minItems,
+          maxItems = spec.maxItems;
+        if (minItems !== undefined && value.length < minItems || maxItems !== undefined && value.length > maxItems) {
+          return false;
+        }
+        if (isTuple) {
+          // If value has fewer items than tuple has specs - we are fine with that.
+          var numberOfItemsToCheck = Math.min(spec.items.length, value.length);
+          return Array(numberOfItemsToCheck).fill(null).every(function (_, i) {
+            return validateAttrs(spec.items[i], value[i]);
+          });
+        } else {
+          return value.every(function (valueItem) {
+            return (
+              // We check that at least one of the specs in the list (spec.items) matches each value from
+              spec.items.some(function (itemSpec) {
+                return validateAttrs(itemSpec, valueItem);
+              })
+            );
+          });
+        }
       }
       return false;
     case 'enum':
@@ -458,11 +487,12 @@ function validator(nodes, marks, options) {
       for (var i = 0, length = attrOptions.length; i < length; ++i) {
         var attrOption = attrOptions[i];
         if (attrOption && attrOption.props) {
-          var _partitionObject = partitionObject(attrOption.props, function (k, v) {
-            return validateAttrs(v, prevEntity.attrs[k]);
+          var _partitionObject3 = partitionObject(attrOption.props, function (key, spec) {
+            var valueToValidate = prevEntity.attrs[key];
+            return validateAttrs(spec, valueToValidate);
           });
-          var _partitionObject2 = (0, _slicedToArray2.default)(_partitionObject, 2);
-          invalidAttrs = _partitionObject2[1];
+          var _partitionObject4 = (0, _slicedToArray2.default)(_partitionObject3, 2);
+          invalidAttrs = _partitionObject4[1];
         }
         validatorAttrs = attrOption;
         if (!invalidAttrs.length) {
@@ -602,12 +632,12 @@ function validator(nodes, marks, options) {
       valid: true,
       entity: prevEntity
     };
-    var _partitionObject3 = partitionObject(prevEntity, function (k) {
+    var _partitionObject5 = partitionObject(prevEntity, function (k) {
         return (0, _utils.isDefined)(validatorSpec.props[k]);
       }),
-      _partitionObject4 = (0, _slicedToArray2.default)(_partitionObject3, 2),
-      requiredProps = _partitionObject4[0],
-      redundantProps = _partitionObject4[1];
+      _partitionObject6 = (0, _slicedToArray2.default)(_partitionObject5, 2),
+      requiredProps = _partitionObject6[0],
+      redundantProps = _partitionObject6[1];
     if (redundantProps.length) {
       if (mode === 'loose') {
         newEntity = {
@@ -677,11 +707,11 @@ function validator(nodes, marks, options) {
 
     // Required Props
     // For object format based on `optional` property
-    var _partitionObject5 = partitionObject(validatorSpec.props, function (k, v) {
+    var _partitionObject7 = partitionObject(validatorSpec.props, function (k, v) {
         return v.optional || (0, _utils.isDefined)(prevEntity[k]);
       }),
-      _partitionObject6 = (0, _slicedToArray2.default)(_partitionObject5, 2),
-      missingProps = _partitionObject6[1];
+      _partitionObject8 = (0, _slicedToArray2.default)(_partitionObject7, 2),
+      missingProps = _partitionObject8[1];
     if (missingProps.length) {
       return {
         hasValidated: true,

package/dist/cjs/version.json

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

package/dist/es2019/validator/validator.js

@@ -26,7 +26,8 @@ function mapMarksItems(spec, fn = x => x) {
   }
 }
 const partitionObject = (obj, predicate) => Object.keys(obj).reduce((acc, key) => {
-  acc[predicate(key, obj[key], obj) ? 0 : 1].push(key);
+  const result = predicate(key, obj[key], obj);
+  acc[result ? 0 : 1].push(key);
   return acc;
 }, [[], []]);
 
@@ -126,12 +127,20 @@ function getOptionsForType(type, list) {
   }
   return false;
 }
+const isValidatorSpecAttrs = spec => {
+  return !!spec.props;
+};
 export function validateAttrs(spec, value) {
-  // extension_node parameters has no type
-  if (!isDefined(spec.type)) {
+  if (!isDefined(value)) {
     return !!spec.optional;
   }
-  if (!isDefined(value)) {
+  if (isValidatorSpecAttrs(spec)) {
+    // If spec has ".props" it is ValidatorSpecAttrs and need to pipe back in recursively
+    const [_, invalidKeys] = partitionObject(spec.props, (key, subSpec) => validateAttrs(subSpec, value[key]));
+    return invalidKeys.length === 0;
+  }
+  // extension_node parameters has no type
+  if (!isDefined(spec.type)) {
     return !!spec.optional;
   }
   switch (spec.type) {
@@ -147,12 +156,24 @@ export function validateAttrs(spec, value) {
     case 'object':
       return isPlainObject(value);
     case 'array':
-      const types = spec.items;
-      const lastTypeIndex = types.length - 1;
       if (Array.isArray(value)) {
-        // We are doing this to support tuple which can be defined as [number, string]
-        // NOTE: Not validating tuples strictly
-        return value.every((x, i) => validateAttrs(types[Math.min(i, lastTypeIndex)], x));
+        const isTuple = !!spec.isTupleLike;
+        const {
+          minItems,
+          maxItems
+        } = spec;
+        if (minItems !== undefined && value.length < minItems || maxItems !== undefined && value.length > maxItems) {
+          return false;
+        }
+        if (isTuple) {
+          // If value has fewer items than tuple has specs - we are fine with that.
+          const numberOfItemsToCheck = Math.min(spec.items.length, value.length);
+          return Array(numberOfItemsToCheck).fill(null).every((_, i) => validateAttrs(spec.items[i], value[i]));
+        } else {
+          return value.every(valueItem =>
+          // We check that at least one of the specs in the list (spec.items) matches each value from
+          spec.items.some(itemSpec => validateAttrs(itemSpec, valueItem)));
+        }
       }
       return false;
     case 'enum':
@@ -441,8 +462,9 @@ export function validator(nodes, marks, options) {
       for (let i = 0, length = attrOptions.length; i < length; ++i) {
         const attrOption = attrOptions[i];
         if (attrOption && attrOption.props) {
-          [, invalidAttrs] = partitionObject(attrOption.props, (k, v) => {
-            return validateAttrs(v, prevEntity.attrs[k]);
+          [, invalidAttrs] = partitionObject(attrOption.props, (key, spec) => {
+            const valueToValidate = prevEntity.attrs[key];
+            return validateAttrs(spec, valueToValidate);
           });
         }
         validatorAttrs = attrOption;

package/dist/es2019/version.json

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

package/dist/esm/validator/validator.js

@@ -32,7 +32,8 @@ function mapMarksItems(spec) {
 }
 var partitionObject = function partitionObject(obj, predicate) {
   return Object.keys(obj).reduce(function (acc, key) {
-    acc[predicate(key, obj[key], obj) ? 0 : 1].push(key);
+    var result = predicate(key, obj[key], obj);
+    acc[result ? 0 : 1].push(key);
     return acc;
   }, [[], []]);
 };
@@ -141,12 +142,25 @@ function getOptionsForType(type, list) {
   }
   return false;
 }
+var isValidatorSpecAttrs = function isValidatorSpecAttrs(spec) {
+  return !!spec.props;
+};
 export function validateAttrs(spec, value) {
-  // extension_node parameters has no type
-  if (!isDefined(spec.type)) {
+  if (!isDefined(value)) {
     return !!spec.optional;
   }
-  if (!isDefined(value)) {
+  if (isValidatorSpecAttrs(spec)) {
+    // If spec has ".props" it is ValidatorSpecAttrs and need to pipe back in recursively
+    var _partitionObject = partitionObject(spec.props, function (key, subSpec) {
+        return validateAttrs(subSpec, value[key]);
+      }),
+      _partitionObject2 = _slicedToArray(_partitionObject, 2),
+      _ = _partitionObject2[0],
+      invalidKeys = _partitionObject2[1];
+    return invalidKeys.length === 0;
+  }
+  // extension_node parameters has no type
+  if (!isDefined(spec.type)) {
     return !!spec.optional;
   }
   switch (spec.type) {
@@ -164,14 +178,29 @@ export function validateAttrs(spec, value) {
     case 'object':
       return isPlainObject(value);
     case 'array':
-      var types = spec.items;
-      var lastTypeIndex = types.length - 1;
       if (Array.isArray(value)) {
-        // We are doing this to support tuple which can be defined as [number, string]
-        // NOTE: Not validating tuples strictly
-        return value.every(function (x, i) {
-          return validateAttrs(types[Math.min(i, lastTypeIndex)], x);
-        });
+        var isTuple = !!spec.isTupleLike;
+        var minItems = spec.minItems,
+          maxItems = spec.maxItems;
+        if (minItems !== undefined && value.length < minItems || maxItems !== undefined && value.length > maxItems) {
+          return false;
+        }
+        if (isTuple) {
+          // If value has fewer items than tuple has specs - we are fine with that.
+          var numberOfItemsToCheck = Math.min(spec.items.length, value.length);
+          return Array(numberOfItemsToCheck).fill(null).every(function (_, i) {
+            return validateAttrs(spec.items[i], value[i]);
+          });
+        } else {
+          return value.every(function (valueItem) {
+            return (
+              // We check that at least one of the specs in the list (spec.items) matches each value from
+              spec.items.some(function (itemSpec) {
+                return validateAttrs(itemSpec, valueItem);
+              })
+            );
+          });
+        }
       }
       return false;
     case 'enum':
@@ -447,11 +476,12 @@ export function validator(nodes, marks, options) {
       for (var i = 0, length = attrOptions.length; i < length; ++i) {
         var attrOption = attrOptions[i];
         if (attrOption && attrOption.props) {
-          var _partitionObject = partitionObject(attrOption.props, function (k, v) {
-            return validateAttrs(v, prevEntity.attrs[k]);
+          var _partitionObject3 = partitionObject(attrOption.props, function (key, spec) {
+            var valueToValidate = prevEntity.attrs[key];
+            return validateAttrs(spec, valueToValidate);
           });
-          var _partitionObject2 = _slicedToArray(_partitionObject, 2);
-          invalidAttrs = _partitionObject2[1];
+          var _partitionObject4 = _slicedToArray(_partitionObject3, 2);
+          invalidAttrs = _partitionObject4[1];
         }
         validatorAttrs = attrOption;
         if (!invalidAttrs.length) {
@@ -591,12 +621,12 @@ export function validator(nodes, marks, options) {
       valid: true,
       entity: prevEntity
     };
-    var _partitionObject3 = partitionObject(prevEntity, function (k) {
+    var _partitionObject5 = partitionObject(prevEntity, function (k) {
         return isDefined(validatorSpec.props[k]);
       }),
-      _partitionObject4 = _slicedToArray(_partitionObject3, 2),
-      requiredProps = _partitionObject4[0],
-      redundantProps = _partitionObject4[1];
+      _partitionObject6 = _slicedToArray(_partitionObject5, 2),
+      requiredProps = _partitionObject6[0],
+      redundantProps = _partitionObject6[1];
     if (redundantProps.length) {
       if (mode === 'loose') {
         newEntity = {
@@ -666,11 +696,11 @@ export function validator(nodes, marks, options) {
 
     // Required Props
     // For object format based on `optional` property
-    var _partitionObject5 = partitionObject(validatorSpec.props, function (k, v) {
+    var _partitionObject7 = partitionObject(validatorSpec.props, function (k, v) {
         return v.optional || isDefined(prevEntity[k]);
       }),
-      _partitionObject6 = _slicedToArray(_partitionObject5, 2),
-      missingProps = _partitionObject6[1];
+      _partitionObject8 = _slicedToArray(_partitionObject7, 2),
+      missingProps = _partitionObject8[1];
     if (missingProps.length) {
       return {
         hasValidated: true,

package/dist/esm/version.json

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

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

@@ -55,15 +55,19 @@ export type AttributesSpec = {
     type: 'array';
     items: Array<AttributesSpec>;
     optional?: boolean;
-};
+    minItems?: number;
+    maxItems?: number;
+    isTupleLike?: boolean;
+} | ValidatorSpecAttrs;
+export interface ValidatorSpecAttrs {
+    props: {
+        [key: string]: AttributesSpec;
+    };
+    optional?: boolean;
+}
 export interface ValidatorSpec {
     props?: {
-        attrs?: {
-            props: {
-                [key: string]: AttributesSpec;
-            };
-            optional?: boolean;
-        };
+        attrs?: ValidatorSpecAttrs;
         content?: ValidatorContent;
         text?: AttributesSpec;
         marks?: {

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

@@ -55,15 +55,19 @@ export type AttributesSpec = {
     type: 'array';
     items: Array<AttributesSpec>;
     optional?: boolean;
-};
+    minItems?: number;
+    maxItems?: number;
+    isTupleLike?: boolean;
+} | ValidatorSpecAttrs;
+export interface ValidatorSpecAttrs {
+    props: {
+        [key: string]: AttributesSpec;
+    };
+    optional?: boolean;
+}
 export interface ValidatorSpec {
     props?: {
-        attrs?: {
-            props: {
-                [key: string]: AttributesSpec;
-            };
-            optional?: boolean;
-        };
+        attrs?: ValidatorSpecAttrs;
         content?: ValidatorContent;
         text?: AttributesSpec;
         marks?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-utils",
-  "version": "18.3.0",
+  "version": "18.4.0",
   "description": "Set of utilities to traverse, modify and create ADF documents.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
   "atlassian": {
     "team": "Editor",
     "inPublicMirror": true,
-    "releaseModel": "scheduled"
+    "releaseModel": "continuous"
   },
   "af:exports": {
     "./builders": "./src/builders.ts",
@@ -47,7 +47,6 @@
   },
   "devDependencies": {
     "@atlaskit/docs": "*",
-    "@atlaskit/json-schema-generator": "^3.3.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",

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,9 @@
+## 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
+
+// (No @packageDocumentation comment for this package)
+
+```