@atlaskit/adf-schema 57.0.4 → 57.0.5

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @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

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

@@ -408,6 +408,12 @@ var codeBlock = exports.codeBlock = {
       optional: true,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['codeBlock']
@@ -643,6 +649,12 @@ var expand = exports.expand = {
       minItems: 1,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['expand']

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

@@ -402,6 +402,12 @@ export const codeBlock = {
       optional: true,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['codeBlock']
@@ -637,6 +643,12 @@ export const expand = {
       minItems: 1,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['expand']

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

@@ -402,6 +402,12 @@ export var codeBlock = {
       optional: true,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['codeBlock']
@@ -637,6 +643,12 @@ export var expand = {
       minItems: 1,
       type: 'array'
     },
+    marks: {
+      items: [],
+      maxItems: 0,
+      optional: true,
+      type: 'array'
+    },
     type: {
       type: 'enum',
       values: ['expand']

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

@@ -412,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[];
@@ -647,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[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "57.0.4",
+	"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",