@atlaskit/adf-schema 37.1.35 → 37.1.37

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/adf-schema
 
+## 37.1.37
+
+### Patch Changes
+
+- 407f5d1: Align table cell and table header to validator spec.
+- e596783: Align confluence inline comment mark to validator spec.
+
+## 37.1.36
+
+### Patch Changes
+
+- 3faf4f8: Reverse compatability for doc, blockRootOnly and block in full JSON Schema
+
 ## 37.1.35
 
 ### Patch Changes

package/dist/cjs/next-schema/groups/blockRootOnlyGroup.js

@@ -6,4 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.blockRootOnlyGroup = void 0;
 var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
 var _multiBodiedExtension = require("../nodes/multiBodiedExtension");
-var blockRootOnlyGroup = exports.blockRootOnlyGroup = (0, _adfSchemaGenerator.adfNodeGroup)('blockRootOnly', [_multiBodiedExtension.multiBodiedExtension]);
+var blockRootOnlyGroup = exports.blockRootOnlyGroup = (0, _adfSchemaGenerator.adfNodeGroup)('blockRootOnly', [_multiBodiedExtension.multiBodiedExtension], {
+  // @DSLCompatibilityException - Generated JSON Schema does not have this.
+  // We should introduce this to the JSON Schema since it is in PM Spec
+  ignore: ['json-schema']
+});

package/dist/cjs/next-schema/marks/confluenceInlineComment.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.confluenceInlineComment = void 0;
 var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
 var confluenceInlineComment = exports.confluenceInlineComment = (0, _adfSchemaGenerator.adfMark)('confluenceInlineComment').define({
-  ignore: [_adfSchemaGenerator.JSONSchemaTransformerName, _adfSchemaGenerator.ValidatorSpecTransformerName],
+  ignore: [_adfSchemaGenerator.JSONSchemaTransformerName],
   inclusive: false,
   excludes: _adfSchemaGenerator.MarkExcludesNone,
   attrs: {

package/dist/cjs/next-schema/nodes/mediaSingle.js

@@ -123,7 +123,9 @@ var mediaSingle = exports.mediaSingle = (0, _adfSchemaGenerator.adfNode)('mediaS
   }
 }).variant('width_type', {
   content: [(0, _adfSchemaGenerator.$range)(1, 1, (0, _adfSchemaGenerator.$or)(_media.media, _unsupportedBlock.unsupportedBlock))],
-  ignore: [],
+  // @DSLCompatibilityException - Generated JSON Schema does not have this.
+  // We should introduce this to the JSON Schema since it is in PM Spec
+  ignore: ['json-schema'],
   marks: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'pm-spec': {

package/dist/cjs/next-schema/nodes/tableCell.js

@@ -44,6 +44,10 @@ var tableCell = exports.tableCell = (0, _adfSchemaGenerator.adfNode)('tableCell'
       required: {
         reason: '@DSLCompatibilityException - required for tableHeader validator spec',
         value: ['content']
+      },
+      'props.content': {
+        reason: '@DSLCompatibilityException - required for tableHeader validator spec',
+        value: 'tableCell_content'
       }
     }
   }

package/dist/cjs/next-schema/nodes/tableHeader.js

@@ -44,6 +44,10 @@ var tableHeader = exports.tableHeader = (0, _adfSchemaGenerator.adfNode)('tableH
       required: {
         reason: '@DSLCompatibilityException - required for tableHeader validator spec',
         value: ['content']
+      },
+      'props.content': {
+        reason: '@DSLCompatibilityException - required for tableHeader validator spec',
+        value: 'tableCell_content'
       }
     }
   }

package/dist/cjs/next-schema/nodes/text.js

@@ -25,7 +25,16 @@ var text = exports.text = (0, _adfSchemaGenerator.adfNode)('text').define({
   marks: [_link.link],
   ignore: ['pm-spec', 'json-schema']
 }).variant('formatted', {
-  marks: [_link.link, _em.em, _strong.strong, _strike.strike, _subsup.subsup, _underline.underline, _color.textColor, _annotation.annotation, _color.backgroundColor, _typeAheadQuery.typeAheadQuery, _confluenceInlineComment.confluenceInlineComment, _unsupportedNodeAttribute.unsupportedNodeAttribute, _unsupportedMark.unsupportedMark]
+  marks: [_link.link, _em.em, _strong.strong, _strike.strike, _subsup.subsup, _underline.underline, _color.textColor, _annotation.annotation, _color.backgroundColor, _typeAheadQuery.typeAheadQuery, _confluenceInlineComment.confluenceInlineComment, _unsupportedNodeAttribute.unsupportedNodeAttribute, _unsupportedMark.unsupportedMark],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      // Refers to confluence inline comment value (9th on list)
+      'props.marks.items[0][9]': {
+        remove: true,
+        reason: '@DSLCompatibilityException - Confluence inline comment is not matched on the validator'
+      }
+    }
+  }
 }).variant('code_inline', {
   marks: [_code.code, _link.link, _annotation.annotation, _unsupportedNodeAttribute.unsupportedNodeAttribute, _unsupportedMark.unsupportedMark]
 });

package/dist/es2019/next-schema/groups/blockRootOnlyGroup.js

@@ -1,3 +1,7 @@
 import { adfNodeGroup } from '@atlaskit/adf-schema-generator';
 import { multiBodiedExtension } from '../nodes/multiBodiedExtension';
-export const blockRootOnlyGroup = adfNodeGroup('blockRootOnly', [multiBodiedExtension]);
+export const blockRootOnlyGroup = adfNodeGroup('blockRootOnly', [multiBodiedExtension], {
+  // @DSLCompatibilityException - Generated JSON Schema does not have this.
+  // We should introduce this to the JSON Schema since it is in PM Spec
+  ignore: ['json-schema']
+});

package/dist/es2019/next-schema/marks/confluenceInlineComment.js

@@ -1,6 +1,6 @@
-import { ValidatorSpecTransformerName, JSONSchemaTransformerName, adfMark, MarkExcludesNone } from '@atlaskit/adf-schema-generator';
+import { JSONSchemaTransformerName, adfMark, MarkExcludesNone } from '@atlaskit/adf-schema-generator';
 export const confluenceInlineComment = adfMark('confluenceInlineComment').define({
-  ignore: [JSONSchemaTransformerName, ValidatorSpecTransformerName],
+  ignore: [JSONSchemaTransformerName],
   inclusive: false,
   excludes: MarkExcludesNone,
   attrs: {

package/dist/es2019/next-schema/nodes/mediaSingle.js

@@ -117,7 +117,9 @@ export const mediaSingle = adfNode('mediaSingle').define({
   }
 }).variant('width_type', {
   content: [$range(1, 1, $or(media, unsupportedBlock))],
-  ignore: [],
+  // @DSLCompatibilityException - Generated JSON Schema does not have this.
+  // We should introduce this to the JSON Schema since it is in PM Spec
+  ignore: ['json-schema'],
   marks: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'pm-spec': {

package/dist/es2019/next-schema/nodes/tableCell.js

@@ -38,6 +38,10 @@ export const tableCell = adfNode('tableCell').define({
       required: {
         reason: '@DSLCompatibilityException - required for tableHeader validator spec',
         value: ['content']
+      },
+      'props.content': {
+        reason: '@DSLCompatibilityException - required for tableHeader validator spec',
+        value: 'tableCell_content'
       }
     }
   }

package/dist/es2019/next-schema/nodes/tableHeader.js

@@ -38,6 +38,10 @@ export const tableHeader = adfNode('tableHeader').define({
       required: {
         reason: '@DSLCompatibilityException - required for tableHeader validator spec',
         value: ['content']
+      },
+      'props.content': {
+        reason: '@DSLCompatibilityException - required for tableHeader validator spec',
+        value: 'tableCell_content'
       }
     }
   }

package/dist/es2019/next-schema/nodes/text.js

@@ -19,7 +19,16 @@ export const text = adfNode('text').define({
   marks: [link],
   ignore: ['pm-spec', 'json-schema']
 }).variant('formatted', {
-  marks: [link, em, strong, strike, subsup, underline, textColor, annotation, backgroundColor, typeAheadQuery, confluenceInlineComment, unsupportedNodeAttribute, unsupportedMark]
+  marks: [link, em, strong, strike, subsup, underline, textColor, annotation, backgroundColor, typeAheadQuery, confluenceInlineComment, unsupportedNodeAttribute, unsupportedMark],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      // Refers to confluence inline comment value (9th on list)
+      'props.marks.items[0][9]': {
+        remove: true,
+        reason: '@DSLCompatibilityException - Confluence inline comment is not matched on the validator'
+      }
+    }
+  }
 }).variant('code_inline', {
   marks: [code, link, annotation, unsupportedNodeAttribute, unsupportedMark]
 });

package/dist/esm/next-schema/groups/blockRootOnlyGroup.js

@@ -1,3 +1,7 @@
 import { adfNodeGroup } from '@atlaskit/adf-schema-generator';
 import { multiBodiedExtension } from '../nodes/multiBodiedExtension';
-export var blockRootOnlyGroup = adfNodeGroup('blockRootOnly', [multiBodiedExtension]);
+export var blockRootOnlyGroup = adfNodeGroup('blockRootOnly', [multiBodiedExtension], {
+  // @DSLCompatibilityException - Generated JSON Schema does not have this.
+  // We should introduce this to the JSON Schema since it is in PM Spec
+  ignore: ['json-schema']
+});

package/dist/esm/next-schema/marks/confluenceInlineComment.js

@@ -1,6 +1,6 @@
-import { ValidatorSpecTransformerName, JSONSchemaTransformerName, adfMark, MarkExcludesNone } from '@atlaskit/adf-schema-generator';
+import { JSONSchemaTransformerName, adfMark, MarkExcludesNone } from '@atlaskit/adf-schema-generator';
 export var confluenceInlineComment = adfMark('confluenceInlineComment').define({
-  ignore: [JSONSchemaTransformerName, ValidatorSpecTransformerName],
+  ignore: [JSONSchemaTransformerName],
   inclusive: false,
   excludes: MarkExcludesNone,
   attrs: {

package/dist/esm/next-schema/nodes/mediaSingle.js

@@ -117,7 +117,9 @@ export var mediaSingle = adfNode('mediaSingle').define({
   }
 }).variant('width_type', {
   content: [$range(1, 1, $or(media, unsupportedBlock))],
-  ignore: [],
+  // @DSLCompatibilityException - Generated JSON Schema does not have this.
+  // We should introduce this to the JSON Schema since it is in PM Spec
+  ignore: ['json-schema'],
   marks: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'pm-spec': {

package/dist/esm/next-schema/nodes/tableCell.js

@@ -38,6 +38,10 @@ export var tableCell = adfNode('tableCell').define({
       required: {
         reason: '@DSLCompatibilityException - required for tableHeader validator spec',
         value: ['content']
+      },
+      'props.content': {
+        reason: '@DSLCompatibilityException - required for tableHeader validator spec',
+        value: 'tableCell_content'
       }
     }
   }

package/dist/esm/next-schema/nodes/tableHeader.js

@@ -38,6 +38,10 @@ export var tableHeader = adfNode('tableHeader').define({
       required: {
         reason: '@DSLCompatibilityException - required for tableHeader validator spec',
         value: ['content']
+      },
+      'props.content': {
+        reason: '@DSLCompatibilityException - required for tableHeader validator spec',
+        value: 'tableCell_content'
       }
     }
   }

package/dist/esm/next-schema/nodes/text.js

@@ -19,7 +19,16 @@ export var text = adfNode('text').define({
   marks: [link],
   ignore: ['pm-spec', 'json-schema']
 }).variant('formatted', {
-  marks: [link, em, strong, strike, subsup, underline, textColor, annotation, backgroundColor, typeAheadQuery, confluenceInlineComment, unsupportedNodeAttribute, unsupportedMark]
+  marks: [link, em, strong, strike, subsup, underline, textColor, annotation, backgroundColor, typeAheadQuery, confluenceInlineComment, unsupportedNodeAttribute, unsupportedMark],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      // Refers to confluence inline comment value (9th on list)
+      'props.marks.items[0][9]': {
+        remove: true,
+        reason: '@DSLCompatibilityException - Confluence inline comment is not matched on the validator'
+      }
+    }
+  }
 }).variant('code_inline', {
   marks: [code, link, annotation, unsupportedNodeAttribute, unsupportedMark]
 });

package/dist/types/next-schema/groups/nonNestableBlockContentGroup.d.ts

@@ -97,7 +97,7 @@ export declare const nonNestableBlockContent: (import("@atlaskit/adf-schema-gene
     };
 } & {
     content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentRangeSpec[];
-    ignore: any[];
+    ignore: "json-schema"[];
     marks: any[];
     DANGEROUS_MANUAL_OVERRIDE: {
         'pm-spec': {

package/dist/types/next-schema/nodes/mediaSingle.d.ts

@@ -68,7 +68,7 @@ export declare const mediaSingle: import("@atlaskit/adf-schema-generator/dist/ty
     };
 } & {
     content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentRangeSpec[];
-    ignore: any[];
+    ignore: "json-schema"[];
     marks: any[];
     DANGEROUS_MANUAL_OVERRIDE: {
         'pm-spec': {

package/dist/types/next-schema/nodes/text.d.ts

@@ -32,6 +32,14 @@ export declare const text: import("@atlaskit/adf-schema-generator/dist/types/adf
     ignore: ("pm-spec" | "json-schema")[];
 } & {
     marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
+    DANGEROUS_MANUAL_OVERRIDE: {
+        'validator-spec': {
+            'props.marks.items[0][9]': {
+                remove: true;
+                reason: string;
+            };
+        };
+    };
 } & {
     marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "37.1.35",
+  "version": "37.1.37",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -47,7 +47,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.16.0",
-    "@atlaskit/adf-schema-generator": "^1.25.6",
+    "@atlaskit/adf-schema-generator": "^1.25.8",
     "@atlaskit/adf-utils": "^19.2.2",
     "@atlaskit/codemod-utils": "^4.2.4",
     "@atlaskit/json-schema-generator": "^3.3.9",

package/schema-generators/__tests__/unit/adfToValidatorSpecValidation.unit.ts

@@ -4,12 +4,9 @@ import adfNode from '../../../src/next-schema/full-schema.adf';
 
 const newSpecs = sortNestedArrays(adfToValidatorSpec(adfNode));
 const SKIP_LIST = [
-  'inline_comment_marker', // doesn't exist in the output
   'layoutSection_with_single_column', // doesn't exist in the output
   'multiBodiedExtension', // doesn't match existing spec
   'nestedExpand', // doesn't match existing spec
-  'tableCell', // doesn't match existing spec
-  'tableHeader', // doesn't match existing spec
 
   'atomic_inline', // doesn't exist in the output, not even used anywhere...
   'nestedExpand_content', // doesn't exist in the output, completely different format from other groups

package/schema-generators/__tests__/unit/json-full-schema-backwards-compat.unit.ts

@@ -48,23 +48,48 @@ test('ADF DSL to JSON Schema backwards compatibility for full schema', () => {
 function transformFullFixtureForKnownFailures(json) {
   const definitions = json.definitions;
 
-  delete definitions.doc_node;
-  delete definitions.blockRootOnly_node;
+  // Extra nodes in anyOf
+  definitions.inline_node.anyOf = definitions.inline_node.anyOf.filter(
+    (v) =>
+      ![
+        '#/definitions/confluenceJiraIssue_node',
+        '#/definitions/confluenceUnsupportedInline_node',
+        '#/definitions/image_node',
+        '#/definitions/inlineExtension_node',
+        '#/definitions/text_link_inline_node',
+        '#/definitions/text_node',
+        '#/definitions/unsupportedInline_node',
+      ].includes(v.$ref),
+  );
+
+  // Extra nodes in content.items.anyOf
+  definitions.table_row_node.properties.content.items.anyOf =
+    definitions.table_row_node.properties.content.items.anyOf.filter(
+      (v) => v.$ref !== '#/definitions/table_cell_content',
+    );
+
+  // Extra definitions
   delete definitions.extensionFrame_node;
-  delete definitions.block_content;
-  delete definitions.non_nestable_block_content;
-  delete definitions.table_row_node;
-  delete definitions.table_cell_content;
-  delete definitions.mediaGroup_node;
-  delete definitions.inline_node;
-  delete definitions.mediaInline_node;
-  delete definitions.mediaSingle_width_type_node;
-  delete definitions.status_node;
-  delete definitions.date_node;
-  delete definitions.emoji_node;
-  delete definitions.mention_node;
-  delete definitions.codeBlock_with_marks_node;
-  delete definitions.codeBlock_node;
+
+  // // Extra marks
+  delete definitions.date_node.properties.marks;
+  delete definitions.emoji_node.properties.marks;
+  delete definitions.mention_node.properties.marks;
+  delete definitions.status_node.properties.marks;
+
+  // // Extra properties
+  delete definitions.codeBlock_node.properties.attrs.properties.uniqueId;
+  delete definitions.codeBlock_with_marks_node.allOf.find(
+    (v) => v.type === 'object',
+  ).properties.content;
+  delete definitions.mediaGroup_node.properties.attrs;
+  delete definitions.mediaInline_node.properties.attrs.properties.url;
+
+  // Special case for table_cell_content
+  definitions.table_cell_content.items.anyOf =
+    definitions.table_cell_content.items.anyOf.filter(
+      (v) => v.$ref !== '#/definitions/nestedExpand_content',
+    );
 
   return json;
 }