@atlaskit/adf-schema 37.1.34 → 37.1.36

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/adf-schema
 
+## 37.1.36
+
+### Patch Changes
+
+- 3faf4f8: Reverse compatability for doc, blockRootOnly and block in full JSON Schema
+
+## 37.1.35
+
+### Patch Changes
+
+- 9132a0c: Fix media and mediaInline nodes with the validator spec.
+- 20fadb8: align codeBlock node to existing validator spec
+
 ## 37.1.34
 
 ### 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/nodes/codeBlock.js

@@ -27,7 +27,28 @@ var codeBlock = exports.codeBlock = (0, _adfSchemaGenerator.adfNode)('codeBlock'
       optional: true
     }
   },
-  content: [(0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_text.text, _unsupportedInline.unsupportedInline))]
+  content: [(0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_text.text, _unsupportedInline.unsupportedInline))],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs.props.uniqueId': {
+        remove: true,
+        reason: '@DSLCompatibilityException - uniqueId is missing in the existing validator spec'
+      },
+      'props.content.items': {
+        value: [['text', {
+          props: {
+            marks: {
+              items: [],
+              maxItems: 0,
+              optional: true,
+              type: 'array'
+            }
+          }
+        }]],
+        reason: '@DSLCompatibilityException - text variant is inlined, which is not supported by current transformation'
+      }
+    }
+  }
 }).variant('with_marks', {
   marks: [_breakout.breakout, _unsupportedNodeAttribute.unsupportedNodeAttribute, _unsupportedMark.unsupportedMark],
   ignore: ['pm-spec']

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

@@ -111,5 +111,13 @@ var media = exports.media = (0, _adfSchemaGenerator.adfNode)('media').define({
         default: null
       }
     }]
+  },
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs[1].props.url.optional': {
+        remove: true,
+        reason: '@DSLCompatibilityException - mismatch for validator spec as optional is not specified'
+      }
+    }
   }
 });

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

@@ -92,6 +92,18 @@ var mediaInline = exports.mediaInline = (0, _adfSchemaGenerator.adfNode)('mediaI
       type: 'boolean',
       optional: true,
       default: false
+    },
+    data: {
+      type: 'object',
+      optional: true
+    }
+  },
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs.props.url': {
+        remove: true,
+        reason: '@DSLCompatibilityException - url is not specified on the validator spec (but it probably should be)'
+      }
     }
   }
 });

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/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/nodes/codeBlock.js

@@ -21,7 +21,28 @@ export const codeBlock = adfNode('codeBlock').define({
       optional: true
     }
   },
-  content: [$zeroPlus($or(text, unsupportedInline))]
+  content: [$zeroPlus($or(text, unsupportedInline))],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs.props.uniqueId': {
+        remove: true,
+        reason: '@DSLCompatibilityException - uniqueId is missing in the existing validator spec'
+      },
+      'props.content.items': {
+        value: [['text', {
+          props: {
+            marks: {
+              items: [],
+              maxItems: 0,
+              optional: true,
+              type: 'array'
+            }
+          }
+        }]],
+        reason: '@DSLCompatibilityException - text variant is inlined, which is not supported by current transformation'
+      }
+    }
+  }
 }).variant('with_marks', {
   marks: [breakout, unsupportedNodeAttribute, unsupportedMark],
   ignore: ['pm-spec']

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

@@ -105,5 +105,13 @@ export const media = adfNode('media').define({
         default: null
       }
     }]
+  },
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs[1].props.url.optional': {
+        remove: true,
+        reason: '@DSLCompatibilityException - mismatch for validator spec as optional is not specified'
+      }
+    }
   }
 });

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

@@ -86,6 +86,18 @@ export const mediaInline = adfNode('mediaInline').define({
       type: 'boolean',
       optional: true,
       default: false
+    },
+    data: {
+      type: 'object',
+      optional: true
+    }
+  },
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs.props.url': {
+        remove: true,
+        reason: '@DSLCompatibilityException - url is not specified on the validator spec (but it probably should be)'
+      }
     }
   }
 });

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/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/nodes/codeBlock.js

@@ -21,7 +21,28 @@ export var codeBlock = adfNode('codeBlock').define({
       optional: true
     }
   },
-  content: [$zeroPlus($or(text, unsupportedInline))]
+  content: [$zeroPlus($or(text, unsupportedInline))],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs.props.uniqueId': {
+        remove: true,
+        reason: '@DSLCompatibilityException - uniqueId is missing in the existing validator spec'
+      },
+      'props.content.items': {
+        value: [['text', {
+          props: {
+            marks: {
+              items: [],
+              maxItems: 0,
+              optional: true,
+              type: 'array'
+            }
+          }
+        }]],
+        reason: '@DSLCompatibilityException - text variant is inlined, which is not supported by current transformation'
+      }
+    }
+  }
 }).variant('with_marks', {
   marks: [breakout, unsupportedNodeAttribute, unsupportedMark],
   ignore: ['pm-spec']

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

@@ -105,5 +105,13 @@ export var media = adfNode('media').define({
         default: null
       }
     }]
+  },
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs[1].props.url.optional': {
+        remove: true,
+        reason: '@DSLCompatibilityException - mismatch for validator spec as optional is not specified'
+      }
+    }
   }
 });

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

@@ -86,6 +86,18 @@ export var mediaInline = adfNode('mediaInline').define({
       type: 'boolean',
       optional: true,
       default: false
+    },
+    data: {
+      type: 'object',
+      optional: true
+    }
+  },
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.attrs.props.url': {
+        remove: true,
+        reason: '@DSLCompatibilityException - url is not specified on the validator spec (but it probably should be)'
+      }
     }
   }
 });

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/types/next-schema/generated/nodeTypes.d.ts

@@ -444,6 +444,7 @@ export interface MediaInlineDefinition {
         __contextId?: string;
         __mediaTraceId?: string;
         __external?: boolean;
+        data?: Record<string, unknown>;
     };
 }
 export type MediaInlineNode = PMNode & MediaInlineDefinition;

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "37.1.34",
+  "version": "37.1.36",
   "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.7",
     "@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,11 +4,8 @@ import adfNode from '../../../src/next-schema/full-schema.adf';
 
 const newSpecs = sortNestedArrays(adfToValidatorSpec(adfNode));
 const SKIP_LIST = [
-  'codeBlock', // doesn't match existing spec
   'inline_comment_marker', // doesn't exist in the output
   'layoutSection_with_single_column', // doesn't exist in the output
-  'media', // doesn't match existing spec
-  'mediaInline', // doesn't match existing spec
   'multiBodiedExtension', // doesn't match existing spec
   'nestedExpand', // doesn't match existing spec
   'tableCell', // doesn't match existing spec

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

@@ -48,10 +48,7 @@ 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;
   delete definitions.extensionFrame_node;
-  delete definitions.block_content;
   delete definitions.non_nestable_block_content;
   delete definitions.table_row_node;
   delete definitions.table_cell_content;