@atlaskit/adf-schema 36.18.0 → 36.18.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/adf-schema
 
+## 36.18.2
+
+### Patch Changes
+
+- 4126ead: json schema validation for the next schema produced by adf-schema-generator
+
+## 36.18.1
+
+### Patch Changes
+
+- 53dce02: Add autogenerated warning to the top of the autogenerated files
+
 ## 36.18.0
 
 ### Minor Changes

package/dist/cjs/next-schema/generated/markTypes.js

@@ -5,6 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.unsupportedNodeAttribute = exports.unsupportedMark = exports.underline = exports.textColor = exports.subsup = exports.strong = exports.strike = exports.link = exports.indentation = exports.fragment = exports.em = exports.dataConsumer = exports.code = exports.breakout = exports.border = exports.backgroundColor = exports.annotation = exports.alignment = void 0;
 var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
+
 var unsupportedNodeAttribute = exports.unsupportedNodeAttribute = (0, _adfSchemaGenerator.createPMMarkSpecFactory)({
   attrs: {
     type: {

package/dist/cjs/next-schema/generated/nodeTypes.js

@@ -5,6 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.unsupportedInline = exports.unsupportedBlock = exports.textFormatted = exports.textCodeInline = exports.text = exports.taskList = exports.taskItem = exports.tableRow = exports.tableHeader = exports.tableCell = exports.table = exports.status = exports.rule = exports.placeholder = exports.paragraphWithNoMarks = exports.paragraphWithMarks = exports.paragraphWithAlignment = exports.paragraph = exports.panel = exports.orderedList = exports.nestedExpandWithNoMarks = exports.multiBodiedExtension = exports.mention = exports.mediaSingleFull = exports.mediaSingleCaption = exports.mediaSingle = exports.mediaInline = exports.mediaGroup = exports.media = exports.listItem = exports.layoutSection = exports.layoutColumn = exports.inlineExtensionWithMarks = exports.inlineCard = exports.image = exports.headingWithNoMarks = exports.headingWithIndentation = exports.headingWithAlignment = exports.heading = exports.hardBreak = exports.extensionWithMarks = exports.extensionFrame = exports.extension = exports.expandWithNoMark = exports.emoji = exports.embedCard = exports.doc = exports.decisionList = exports.decisionItem = exports.date = exports.confluenceUnsupportedInline = exports.confluenceUnsupportedBlock = exports.confluenceJiraIssue = exports.codeBlockWithNoMarks = exports.codeBlock = exports.caption = exports.bulletList = exports.bodiedExtensionWithMarks = exports.bodiedExtension = exports.blockquoteWithList = exports.blockquote = exports.blockCard = void 0;
 var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
+
 var text = exports.text = (0, _adfSchemaGenerator.createPMNodeSpecFactory)({
   group: 'inline'
 });

package/dist/es2019/next-schema/generated/markTypes.js

@@ -1,3 +1,9 @@
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
+
 import { createPMMarkSpecFactory } from '@atlaskit/adf-schema-generator';
 export const unsupportedNodeAttribute = createPMMarkSpecFactory({
   attrs: {

package/dist/es2019/next-schema/generated/nodeTypes.js

@@ -1,3 +1,9 @@
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
+
 import { createPMNodeSpecFactory } from '@atlaskit/adf-schema-generator';
 export const text = createPMNodeSpecFactory({
   group: 'inline'

package/dist/esm/next-schema/generated/markTypes.js

@@ -1,3 +1,9 @@
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
+
 import { createPMMarkSpecFactory } from '@atlaskit/adf-schema-generator';
 export var unsupportedNodeAttribute = createPMMarkSpecFactory({
   attrs: {

package/dist/esm/next-schema/generated/nodeTypes.js

@@ -1,3 +1,9 @@
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
+
 import { createPMNodeSpecFactory } from '@atlaskit/adf-schema-generator';
 export var text = createPMNodeSpecFactory({
   group: 'inline'

package/dist/types/next-schema/generated/markTypes.d.ts

@@ -1,3 +1,8 @@
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
 import { Mark } from '@atlaskit/editor-prosemirror/model';
 export interface UnsupportedNodeAttributeMarkAttributes {
     type: string;

package/dist/types/next-schema/generated/nodeGroupTypes.d.ts

@@ -1,3 +1,8 @@
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
 import { TextDefinition, TextFormattedDefinition, TextCodeInlineDefinition, DateDefinition, EmojiDefinition, HardBreakDefinition, InlineCardDefinition, MentionDefinition, PlaceholderDefinition, StatusDefinition, InlineExtensionWithMarksDefinition, MediaInlineDefinition, ImageDefinition, ConfluenceJiraIssueDefinition, ConfluenceUnsupportedInlineDefinition, UnsupportedInlineDefinition } from './nodeTypes';
 export type InlineDefinition = Array<TextDefinition | TextFormattedDefinition | TextCodeInlineDefinition | DateDefinition | EmojiDefinition | HardBreakDefinition | InlineCardDefinition | MentionDefinition | PlaceholderDefinition | StatusDefinition | InlineExtensionWithMarksDefinition | MediaInlineDefinition | ImageDefinition | ConfluenceJiraIssueDefinition | ConfluenceUnsupportedInlineDefinition | UnsupportedInlineDefinition>;
 import { PanelDefinition, ParagraphDefinition, ParagraphWithMarksDefinition, BlockquoteWithListDefinition, OrderedListDefinition, BulletListDefinition, RuleDefinition, HeadingWithNoMarksDefinition, HeadingWithAlignmentDefinition, HeadingWithIndentationDefinition, CodeBlockWithNoMarksDefinition, MediaGroupDefinition, MediaSingleCaptionDefinition, MediaSingleFullDefinition, DecisionListDefinition, TaskListDefinition, TableDefinition, ExpandWithNoMarkDefinition, ExtensionWithMarksDefinition, BodiedExtensionWithMarksDefinition, BlockCardDefinition, EmbedCardDefinition, ConfluenceUnsupportedBlockDefinition, UnsupportedBlockDefinition } from './nodeTypes';

package/dist/types/next-schema/generated/nodeTypes.d.ts

@@ -1,3 +1,8 @@
+/**
+ * This file was automatically generated by @atlaskit/adf-schema-generator
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source files in "packages/adf-schema/src/next-schema" ,
+ * and run "yarn workspace @atlaskit/adf-schema build:pm:full" to regenerate this file.
+ */
 import { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { InlineDefinition, BlockDefinition, BlockRootOnlyDefinition } from './nodeGroupTypes';
 import { UnsupportedNodeAttributeMark, UnsupportedMarkMark, LinkMark, EmMark, StrongMark, StrikeMark, SubsupMark, UnderlineMark, TextColorMark, AnnotationMark, BackgroundColorMark, CodeMark, DataConsumerMark, FragmentMark, BorderMark, AlignmentMark, IndentationMark, BreakoutMark } from './markTypes';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.18.0",
+  "version": "36.18.2",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -44,7 +44,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.15.0",
-    "@atlaskit/adf-schema-generator": "^1.17.0",
+    "@atlaskit/adf-schema-generator": "^1.17.1",
     "@atlaskit/codemod-utils": "^4.2.4",
     "@atlaskit/json-schema-generator": "^3.3.9",
     "@babel/cli": "^7.22.9",
@@ -66,6 +66,7 @@
     "cross-env": "^7.0.3",
     "jest": "^29.6.2",
     "jest-environment-jsdom": "^29.6.2",
+    "json-schema-diff-validator": "^0.4.1",
     "prop-types": "^15.5.4",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",

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

@@ -0,0 +1,129 @@
+import { validateSchemaCompatibility } from 'json-schema-diff-validator';
+import { adfToJSON } from '@atlaskit/adf-schema-generator';
+import adfNode from '@atlaskit/adf-schema/src/next-schema/full-schema.adf';
+
+const DEFINITIONS_TO_SKIP_FULL = [
+  'blockCard_node',
+  'block_content',
+  'bodiedExtension_node',
+  'bodiedExtension_with_marks_node',
+  'codeBlock_node',
+  'codeBlock_with_marks_node',
+  'codeBlock_with_no_marks_node',
+  'code_inline_node',
+  'doc_node',
+  'expand_node',
+  'expand_with_breakout_mark_node',
+  'expand_with_no_mark_node',
+  'extension_node',
+  'extension_with_marks_node',
+  'formatted_text_inline_node',
+  'heading_node',
+  'heading_with_alignment_node',
+  'heading_with_indentation_node',
+  'heading_with_no_marks_node',
+  'inlineCard_node',
+  'inlineExtension_node',
+  'inlineExtension_with_marks_node',
+  'inline_node',
+  'layoutSection_full_node',
+  'mediaInline_node',
+  'mediaSingle_caption_node',
+  'mediaSingle_full_node',
+  'mediaSingle_node',
+  'nestedExpand_content',
+  'nestedExpand_node',
+  'nestedExpand_with_no_marks_node',
+  'non_nestable_block_content',
+  'paragraph_node',
+  'paragraph_with_alignment_node',
+  'paragraph_with_indentation_node',
+  'paragraph_with_no_marks_node',
+  'table_cell_content',
+  'table_cell_node',
+  'table_header_node',
+  'text_node',
+];
+
+test('ADF DSL to JSON Schema backwards compatibility for full schema', () => {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const currentSchema = require('../../../json-schema/v1/full.json');
+  const nextSchema = adfToJSON(adfNode);
+  DEFINITIONS_TO_SKIP_FULL.forEach((definition) => {
+    nextSchema.definitions[definition] = currentSchema.definitions[definition];
+  });
+
+  expect(() => {
+    validateSchemaCompatibility(currentSchema, nextSchema, {
+      allowNewOneOf: true,
+      allowNewEnumValue: true,
+      allowReorder: true,
+    });
+  }).not.toThrow();
+});
+
+const DEFINITIONS_TO_SKIP_STAGE_0 = [
+  'blockCard_node',
+  'block_content',
+  'bodiedExtension_node',
+  'bodiedExtension_with_marks_node',
+  'codeBlock_node',
+  'codeBlock_with_marks_node',
+  'codeBlock_with_no_marks_node',
+  'code_inline_node',
+  'date_node',
+  'doc_node',
+  'emoji_node',
+  'expand_node',
+  'expand_with_breakout_mark_node',
+  'expand_with_no_mark_node',
+  'extensionFrame_node',
+  'extension_node',
+  'extension_with_marks_node',
+  'formatted_text_inline_node',
+  'heading_node',
+  'heading_with_alignment_node',
+  'heading_with_indentation_node',
+  'heading_with_no_marks_node',
+  'inlineCard_node',
+  'inlineExtension_node',
+  'inlineExtension_with_marks_node',
+  'inline_node',
+  'layoutSection_full_node',
+  'layoutSection_with_single_column_node',
+  'mediaInline_node',
+  'mediaSingle_caption_node',
+  'mediaSingle_full_node',
+  'mediaSingle_node',
+  'mention_node',
+  'multiBodiedExtension_node',
+  'nestedExpand_content',
+  'nestedExpand_node',
+  'nestedExpand_with_no_marks_node',
+  'non_nestable_block_content',
+  'paragraph_node',
+  'paragraph_with_alignment_node',
+  'paragraph_with_indentation_node',
+  'paragraph_with_no_marks_node',
+  'status_node',
+  'table_cell_content',
+  'table_cell_node',
+  'table_header_node',
+  'text_node',
+];
+test('ADF DSL to JSON Schema backwards compatibility for stage0 schema', () => {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const currentSchema = require('../../../json-schema/v1/stage-0.json');
+  const nextSchema = adfToJSON(adfNode);
+  DEFINITIONS_TO_SKIP_STAGE_0.forEach((definition) => {
+    nextSchema.definitions[definition] = currentSchema.definitions[definition];
+  });
+
+  expect(() => {
+    validateSchemaCompatibility(currentSchema, nextSchema, {
+      allowNewOneOf: true,
+      allowNewEnumValue: true,
+      allowReorder: true,
+    });
+  }).not.toThrow();
+});