@atlaskit/adf-schema 57.0.3 → 57.0.5

package/CHANGELOG.md

@@ -1,5 +1,70 @@
 # @atlaskit/adf-schema
 
+## 57.0.5
+
+### Patch Changes
+
+- [`249ac5d9191e0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/249ac5d9191e0) -
+  Behind `platform_editor_adf_validator_empty_marks`, accept an explicitly empty `marks` array on a
+  node that ADF gives a `marks` property no mark type may go into.
+
+  ADF spells that property `marks: { type: 'array', maxItems: 0 }`, and the JSON schema accordingly
+  accepts `"marks": []` on `paragraph`, `heading`, `extension`, `codeBlock` and `expand`. The
+  spec-based validator rejected it: mark validation has nothing to reject in an empty array, so it
+  reported the node valid with an empty `marksValidationOutput`, which reads to the parent's
+  `validateChildMarks` as every mark on the child having been rejected, and the candidate spec was
+  declined. Without an error callback that surfaced as a thrown `undefined`; with one the document
+  was silently repaired and no error was reported. The five reference documents that carry
+  `marks: []` (`paragraph-with-empty-marks`, `heading-with-empty-marks`,
+  `extension-with-empty-marks`, `nestedExpand-with-codeBlock`, `panel-with-codeBlock`) were on an
+  ignore list in `src/validator/__tests__/unit/validate.ts` because of it, and are now validated.
+
+  A node with no `marks` property at all keeps rejecting an empty array as `REDUNDANT_MARKS`,
+  because `marks` is then a property ADF does not define on it: `rule`, `panel`, `mediaGroup`,
+  `hardBreak`, `doc`, `blockquote` and the list nodes all stay invalid, as do `mention` and `emoji`,
+  which declare a mark rather than an empty list. The declaration is read off the node's base spec,
+  since a variant only widens the mark types — `doc` offers a root `extension` as
+  `extension_with_marks`, which adds `dataConsumer` and `fragment`, and that cannot make the empty
+  list illegal.
+
+  `codeBlock` and `expand` declare `noMarks` without listing any marks, and `adfToValidatorSpec`
+  compared mark lists alone, so the flag was dropped and their validator specs read as taking no
+  `marks` property — the same thing `rule` means, which is why an empty array on them was reported
+  as redundant. The generator now honours `noMarks` on its own, so both emit
+  `marks: { type: 'array', items: [], maxItems: 0, optional: true }`, matching their JSON schema.
+  That part is generated data and is not gated: a real mark on a `codeBlock` or an `expand` is still
+  rejected, now as an unsupported mark type rather than as a redundant `marks` property, so the
+  error code reported for an already-invalid document changes.
+
+  Gate off preserves today's acceptance behaviour. Covered by
+  `src/validator/__tests__/unit/empty-marks.ts`.
+
+- Updated dependencies
+
+## 57.0.4
+
+### Patch Changes
+
+- [`da678c24b2eb7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/da678c24b2eb7) -
+  `adfToValidatorSpec` now emits `meta: { stage0: true }` on the validator spec of any node that
+  exists only in stage 0 (`ADFNode.isStage0Only()`), and the generated validator spec is regenerated
+  so 10 specs carry the flag: `bodiedExtension_root_only`, `extension_root_only`, `extensionFrame`,
+  `layoutSection_with_single_column`, `multiBodiedExtension`, `multiBodiedExtension_root_only`,
+  `panel_c1`, `panel_c1_root_only`, `panel_root_only` and `rule_root_only`.
+
+  The predicate is `isStage0Only()` rather than `hasStage0()` because consumers read the flag as
+  "this whole spec is stage-0 only". `hasStage0()` is also true for a stable node carrying a partial
+  stage-0 override, so it flagged `date`, `emoji`, `inlineCard`, `mention` and `status`, whose only
+  stage-0 delta is an optional `annotation` mark. A per-spec boolean cannot say "the node is fine,
+  one of its marks is not", so flagging those said something false about stable nodes.
+
+  `meta` is additive metadata that sits beside `props`, so the validated shape of every spec is
+  unchanged and consumers that ignore the field see no difference. Emission is not gated. The only
+  consumer that reads the flag is `@atlaskit/adf-utils`, behind
+  `platform_editor_adf_validator_stage0`.
+
+- Updated dependencies
+
 ## 57.0.3
 
 ### Patch Changes

package/dist/cjs/validator-schema/generated/validatorSpec.js

@@ -232,6 +232,9 @@ var bodiedExtension = exports.bodiedExtension = {
   }
 };
 var bodiedExtension_root_only = exports.bodiedExtension_root_only = ['bodiedExtension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: [['breakout', 'dataConsumer', 'fragment']],
@@ -405,6 +408,12 @@ var codeBlock = exports.codeBlock = {
       optional: true,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['codeBlock']
@@ -640,6 +649,12 @@ var expand = exports.expand = {
       minItems: 1,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['expand']
@@ -699,6 +714,9 @@ var extension = exports.extension = {
   }
 };
 var extension_root_only = exports.extension_root_only = ['extension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: [['breakout', 'dataConsumer', 'fragment']],
@@ -717,6 +735,9 @@ var extension_with_marks = exports.extension_with_marks = ['extension', {
   }
 }];
 var extensionFrame = exports.extensionFrame = {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       items: [['paragraph_with_no_marks', 'paragraph_with_font_size', 'panel', 'blockquote', 'orderedList', 'bulletList', 'rule', 'heading_with_no_marks', 'codeBlock', 'mediaGroup', 'mediaSingle_full', 'mediaSingle_caption', 'decisionList', 'taskList', 'table', 'extension_with_marks', 'bodiedExtension_with_marks', 'blockCard', 'embedCard']],
@@ -1031,6 +1052,9 @@ var layoutSection_full = exports.layoutSection_full = ['layoutSection', {
   }
 }];
 var layoutSection_with_single_column = exports.layoutSection_with_single_column = ['layoutSection', {
+  meta: {
+    stage0: true
+  },
   props: {
     attrs: {
       optional: true,
@@ -1390,6 +1414,9 @@ var mention = exports.mention = {
   }
 };
 var multiBodiedExtension = exports.multiBodiedExtension = {
+  meta: {
+    stage0: true
+  },
   props: {
     attrs: {
       props: {
@@ -1437,6 +1464,9 @@ var multiBodiedExtension = exports.multiBodiedExtension = {
   }
 };
 var multiBodiedExtension_root_only = exports.multiBodiedExtension_root_only = ['multiBodiedExtension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],
@@ -1554,6 +1584,9 @@ var panel = exports.panel = {
   }
 };
 var panel_c1 = exports.panel_c1 = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       allowUnsupportedBlock: true,
@@ -1564,6 +1597,9 @@ var panel_c1 = exports.panel_c1 = ['panel', {
   }
 }];
 var panel_c1_root_only = exports.panel_c1_root_only = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       allowUnsupportedBlock: true,
@@ -1579,6 +1615,9 @@ var panel_c1_root_only = exports.panel_c1_root_only = ['panel', {
   }
 }];
 var panel_root_only = exports.panel_root_only = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],
@@ -1689,6 +1728,9 @@ var rule = exports.rule = {
   }
 };
 var rule_root_only = exports.rule_root_only = ['rule', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],

package/dist/es2019/validator-schema/generated/validatorSpec.js

@@ -226,6 +226,9 @@ export const bodiedExtension = {
   }
 };
 export const bodiedExtension_root_only = ['bodiedExtension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: [['breakout', 'dataConsumer', 'fragment']],
@@ -399,6 +402,12 @@ export const codeBlock = {
       optional: true,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['codeBlock']
@@ -634,6 +643,12 @@ export const expand = {
       minItems: 1,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['expand']
@@ -693,6 +708,9 @@ export const extension = {
   }
 };
 export const extension_root_only = ['extension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: [['breakout', 'dataConsumer', 'fragment']],
@@ -711,6 +729,9 @@ export const extension_with_marks = ['extension', {
   }
 }];
 export const extensionFrame = {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       items: [['paragraph_with_no_marks', 'paragraph_with_font_size', 'panel', 'blockquote', 'orderedList', 'bulletList', 'rule', 'heading_with_no_marks', 'codeBlock', 'mediaGroup', 'mediaSingle_full', 'mediaSingle_caption', 'decisionList', 'taskList', 'table', 'extension_with_marks', 'bodiedExtension_with_marks', 'blockCard', 'embedCard']],
@@ -1025,6 +1046,9 @@ export const layoutSection_full = ['layoutSection', {
   }
 }];
 export const layoutSection_with_single_column = ['layoutSection', {
+  meta: {
+    stage0: true
+  },
   props: {
     attrs: {
       optional: true,
@@ -1384,6 +1408,9 @@ export const mention = {
   }
 };
 export const multiBodiedExtension = {
+  meta: {
+    stage0: true
+  },
   props: {
     attrs: {
       props: {
@@ -1431,6 +1458,9 @@ export const multiBodiedExtension = {
   }
 };
 export const multiBodiedExtension_root_only = ['multiBodiedExtension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],
@@ -1548,6 +1578,9 @@ export const panel = {
   }
 };
 export const panel_c1 = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       allowUnsupportedBlock: true,
@@ -1558,6 +1591,9 @@ export const panel_c1 = ['panel', {
   }
 }];
 export const panel_c1_root_only = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       allowUnsupportedBlock: true,
@@ -1573,6 +1609,9 @@ export const panel_c1_root_only = ['panel', {
   }
 }];
 export const panel_root_only = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],
@@ -1683,6 +1722,9 @@ export const rule = {
   }
 };
 export const rule_root_only = ['rule', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],

package/dist/esm/validator-schema/generated/validatorSpec.js

@@ -226,6 +226,9 @@ export var bodiedExtension = {
   }
 };
 export var bodiedExtension_root_only = ['bodiedExtension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: [['breakout', 'dataConsumer', 'fragment']],
@@ -399,6 +402,12 @@ export var codeBlock = {
       optional: true,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['codeBlock']
@@ -634,6 +643,12 @@ export var expand = {
       minItems: 1,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['expand']
@@ -693,6 +708,9 @@ export var extension = {
   }
 };
 export var extension_root_only = ['extension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: [['breakout', 'dataConsumer', 'fragment']],
@@ -711,6 +729,9 @@ export var extension_with_marks = ['extension', {
   }
 }];
 export var extensionFrame = {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       items: [['paragraph_with_no_marks', 'paragraph_with_font_size', 'panel', 'blockquote', 'orderedList', 'bulletList', 'rule', 'heading_with_no_marks', 'codeBlock', 'mediaGroup', 'mediaSingle_full', 'mediaSingle_caption', 'decisionList', 'taskList', 'table', 'extension_with_marks', 'bodiedExtension_with_marks', 'blockCard', 'embedCard']],
@@ -1025,6 +1046,9 @@ export var layoutSection_full = ['layoutSection', {
   }
 }];
 export var layoutSection_with_single_column = ['layoutSection', {
+  meta: {
+    stage0: true
+  },
   props: {
     attrs: {
       optional: true,
@@ -1384,6 +1408,9 @@ export var mention = {
   }
 };
 export var multiBodiedExtension = {
+  meta: {
+    stage0: true
+  },
   props: {
     attrs: {
       props: {
@@ -1431,6 +1458,9 @@ export var multiBodiedExtension = {
   }
 };
 export var multiBodiedExtension_root_only = ['multiBodiedExtension', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],
@@ -1548,6 +1578,9 @@ export var panel = {
   }
 };
 export var panel_c1 = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       allowUnsupportedBlock: true,
@@ -1558,6 +1591,9 @@ export var panel_c1 = ['panel', {
   }
 }];
 export var panel_c1_root_only = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     content: {
       allowUnsupportedBlock: true,
@@ -1573,6 +1609,9 @@ export var panel_c1_root_only = ['panel', {
   }
 }];
 export var panel_root_only = ['panel', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],
@@ -1683,6 +1722,9 @@ export var rule = {
   }
 };
 export var rule_root_only = ['rule', {
+  meta: {
+    stage0: true
+  },
   props: {
     marks: {
       items: ['breakout'],

package/dist/types/validator-schema/generated/validatorSpec.d.ts

@@ -236,6 +236,9 @@ export declare const bodiedExtension: {
     };
 };
 export declare const bodiedExtension_root_only: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         marks: {
             items: string[][];
@@ -409,6 +412,12 @@ export declare const codeBlock: {
             optional: boolean;
             type: string;
         };
+        marks: {
+            items: unknown[];
+            maxItems: number;
+            optional: boolean;
+            type: string;
+        };
         type: {
             type: string;
             values: string[];
@@ -644,6 +653,12 @@ export declare const expand: {
             minItems: number;
             type: string;
         };
+        marks: {
+            items: unknown[];
+            maxItems: number;
+            optional: boolean;
+            type: string;
+        };
         type: {
             type: string;
             values: string[];
@@ -703,6 +718,9 @@ export declare const extension: {
     };
 };
 export declare const extension_root_only: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         marks: {
             items: string[][];
@@ -721,6 +739,9 @@ export declare const extension_with_marks: (string | {
     };
 })[];
 export declare const extensionFrame: {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         content: {
             items: string[][];
@@ -1037,6 +1058,9 @@ export declare const layoutSection_full: (string | {
     };
 })[];
 export declare const layoutSection_with_single_column: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         attrs: {
             optional: boolean;
@@ -1403,6 +1427,9 @@ export declare const mention: {
     };
 };
 export declare const multiBodiedExtension: {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         attrs: {
             props: {
@@ -1450,6 +1477,9 @@ export declare const multiBodiedExtension: {
     };
 };
 export declare const multiBodiedExtension_root_only: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         marks: {
             items: string[];
@@ -1567,6 +1597,9 @@ export declare const panel: {
     };
 };
 export declare const panel_c1: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         content: {
             allowUnsupportedBlock: boolean;
@@ -1577,6 +1610,9 @@ export declare const panel_c1: (string | {
     };
 })[];
 export declare const panel_c1_root_only: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         content: {
             allowUnsupportedBlock: boolean;
@@ -1592,6 +1628,9 @@ export declare const panel_c1_root_only: (string | {
     };
 })[];
 export declare const panel_root_only: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         marks: {
             items: string[];
@@ -1702,6 +1741,9 @@ export declare const rule: {
     };
 };
 export declare const rule_root_only: (string | {
+    meta: {
+        stage0: boolean;
+    };
     props: {
         marks: {
             items: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "57.0.3",
+	"version": "57.0.5",
 	"description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -40,7 +40,7 @@
 		"@atlaskit/adf-schema-generator": "^4.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
-		"@atlaskit/tmp-editor-statsig": "^149.0.0",
+		"@atlaskit/tmp-editor-statsig": "^150.0.0",
 		"@babel/runtime": "^7.0.0",
 		"css-color-names": "0.0.4",
 		"linkify-it": "^5.0.2",