@atlaskit/adf-schema 36.10.2 → 36.10.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/adf-schema
 
+## 36.10.4
+
+### Patch Changes
+
+- ec6b9e2: Add type field to content in JSON transformer for ADF DSL
+
+## 36.10.3
+
+### Patch Changes
+
+- b94c981: Add content field to JSON ADF transformer from ADF DSL
+
 ## 36.10.2
 
 ### Patch Changes

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

@@ -8,8 +8,6 @@ var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
 var _annotation = require("../marks/annotation");
 var _border = require("../marks/border");
 var _link = require("../marks/link");
-var _caption = require("./caption");
-var _media = require("./media");
 var mediaInline = exports.mediaInline = (0, _adfSchemaGenerator.adfNode)('mediaInline').define({
   selectable: true,
   atom: false,
@@ -78,6 +76,5 @@ var mediaInline = exports.mediaInline = (0, _adfSchemaGenerator.adfNode)('mediaI
       type: 'boolean',
       optional: true
     }
-  },
-  content: [(0, _adfSchemaGenerator.$or)(_media.media), (0, _adfSchemaGenerator.$or)(_caption.caption)]
+  }
 });

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

@@ -50,8 +50,7 @@ var mediaSingle = exports.mediaSingle = (0, _adfSchemaGenerator.adfNode)('mediaS
         optional: true
       }
     }]
-  },
-  content: [(0, _adfSchemaGenerator.$or)(_media.media)]
+  }
 }).variant('caption', {
   atom: false,
   content: [(0, _adfSchemaGenerator.$or)(_media.media), (0, _adfSchemaGenerator.$or)(_caption.caption)]

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

@@ -1,9 +1,7 @@
-import { $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { adfNode } from '@atlaskit/adf-schema-generator';
 import { annotation } from '../marks/annotation';
 import { border } from '../marks/border';
 import { link } from '../marks/link';
-import { caption } from './caption';
-import { media } from './media';
 export const mediaInline = adfNode('mediaInline').define({
   selectable: true,
   atom: false,
@@ -72,6 +70,5 @@ export const mediaInline = adfNode('mediaInline').define({
       type: 'boolean',
       optional: true
     }
-  },
-  content: [$or(media), $or(caption)]
+  }
 });

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

@@ -44,8 +44,7 @@ export const mediaSingle = adfNode('mediaSingle').define({
         optional: true
       }
     }]
-  },
-  content: [$or(media)]
+  }
 }).variant('caption', {
   atom: false,
   content: [$or(media), $or(caption)]

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

@@ -1,9 +1,7 @@
-import { $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { adfNode } from '@atlaskit/adf-schema-generator';
 import { annotation } from '../marks/annotation';
 import { border } from '../marks/border';
 import { link } from '../marks/link';
-import { caption } from './caption';
-import { media } from './media';
 export var mediaInline = adfNode('mediaInline').define({
   selectable: true,
   atom: false,
@@ -72,6 +70,5 @@ export var mediaInline = adfNode('mediaInline').define({
       type: 'boolean',
       optional: true
     }
-  },
-  content: [$or(media), $or(caption)]
+  }
 });

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

@@ -44,8 +44,7 @@ export var mediaSingle = adfNode('mediaSingle').define({
         optional: true
       }
     }]
-  },
-  content: [$or(media)]
+  }
 }).variant('caption', {
   atom: false,
   content: [$or(media), $or(caption)]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.10.2",
+  "version": "36.10.4",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.15.0",
-    "@atlaskit/adf-schema-generator": "^1.7.6",
+    "@atlaskit/adf-schema-generator": "^1.7.9",
     "@babel/cli": "^7.22.9",
     "@babel/core": "^7.22.9",
     "@babel/plugin-proposal-class-properties": "^7.18.6",

package/schema-generators/__tests__/unit/jqueries.md

@@ -75,3 +75,29 @@ A number of nodes have `marks` defined, yet the array is empty. Assuming this is
   .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node,
   .bodiedExtension_node.properties.marks, .codeBlock_node.properties.marks, .expand_node.properties.marks, .heading_node.properties.marks, .inlineExtension_node.properties.marks, .text_node.properties.marks, .extension_node.properties.marks, .paragraph_node.properties.marks) else . end)'
 ```
+
+Delete all subfields except for content, text, marks, attrs, anyOf, items, type and properties. Base level content objects (not nodes) are also deleted. `inline` is also deleted, as it is a content object for paragraph.
+
+All fields of content have been deleted as well.
+
+A number of nodes have `marks` defined, yet the array is empty. Assuming this is redundant, I've removed them.
+
+```sh
+ cat packages/adf-schema/json-schema/v1/full.json | jq 'walk(if type == "object" then del(
+  .version, .required, .additionalProperties, .allOf, .minItems, .content.items, .content.type, .content."$ref",
+  .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node,
+  .bodiedExtension_node.properties.marks, .codeBlock_node.properties.marks, .expand_node.properties.marks, .heading_node.properties.marks, .inlineExtension_node.properties.marks, .text_node.properties.marks, .extension_node.properties.marks, .paragraph_node.properties.marks) else . end)' | pbcopy
+```
+
+Delete all subfields except for content, text, marks, attrs, anyOf, items, type and properties. Base level content objects (not nodes) are also deleted. `inline` is also deleted, as it is a content object for paragraph.
+
+All fields of content except for type have been deleted as well.
+
+A number of nodes have `marks` defined, yet the array is empty. Assuming this is redundant, I've removed them.
+
+```sh
+ cat packages/adf-schema/json-schema/v1/full.json | jq 'walk(if type == "object" then del(
+  .version, .required, .additionalProperties, .allOf, .minItems, .content.items, .content."$ref",
+  .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node,
+  .bodiedExtension_node.properties.marks, .codeBlock_node.properties.marks, .expand_node.properties.marks, .heading_node.properties.marks, .inlineExtension_node.properties.marks, .text_node.properties.marks, .extension_node.properties.marks, .paragraph_node.properties.marks) else . end)' | pbcopy
+```

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

@@ -46,6 +46,9 @@ const jsonWithTypes = {
         type: {
           enum: ['codeBlock'],
         },
+        content: {
+          type: 'array',
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -677,6 +680,9 @@ const jsonWithTypes = {
         type: {
           enum: ['paragraph'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     paragraph_with_no_marks_node: {},
@@ -688,6 +694,9 @@ const jsonWithTypes = {
         type: {
           enum: ['caption'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     mediaSingle_node: {
@@ -763,6 +772,9 @@ const jsonWithTypes = {
         type: {
           enum: ['taskItem'],
         },
+        content: {
+          type: 'array',
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -782,6 +794,9 @@ const jsonWithTypes = {
         type: {
           enum: ['taskList'],
         },
+        content: {
+          type: 'array',
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -798,6 +813,9 @@ const jsonWithTypes = {
         type: {
           enum: ['listItem'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     bulletList_node: {
@@ -806,6 +824,9 @@ const jsonWithTypes = {
         type: {
           enum: ['bulletList'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     orderedList_node: {
@@ -814,6 +835,9 @@ const jsonWithTypes = {
         type: {
           enum: ['orderedList'],
         },
+        content: {
+          type: 'array',
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -831,6 +855,9 @@ const jsonWithTypes = {
         type: {
           enum: ['heading'],
         },
+        content: {
+          type: 'array',
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -852,6 +879,9 @@ const jsonWithTypes = {
         type: {
           enum: ['mediaGroup'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     decisionItem_node: {
@@ -860,6 +890,9 @@ const jsonWithTypes = {
         type: {
           enum: ['decisionItem'],
         },
+        content: {
+          type: 'array',
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -879,6 +912,9 @@ const jsonWithTypes = {
         type: {
           enum: ['decisionList'],
         },
+        content: {
+          type: 'array',
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -931,6 +967,9 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     blockquote_node: {
@@ -939,6 +978,9 @@ const jsonWithTypes = {
         type: {
           enum: ['blockquote'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     extension_node: {
@@ -1026,6 +1068,7 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {},
       },
     },
     nestedExpand_with_no_marks_node: {},
@@ -1063,6 +1106,9 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {
+          type: 'array',
+        },
         marks: {
           type: 'array',
           items: {
@@ -1077,6 +1123,9 @@ const jsonWithTypes = {
         type: {
           enum: ['tableRow'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     table_cell_node: {
@@ -1105,6 +1154,7 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {},
       },
     },
     table_header_node: {
@@ -1133,6 +1183,7 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {},
       },
     },
     expand_node: {
@@ -1149,6 +1200,9 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     expand_with_no_mark_node: {},
@@ -1183,6 +1237,9 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     bodiedExtension_with_marks_node: {},
@@ -1202,6 +1259,9 @@ const jsonWithTypes = {
             },
           },
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     layoutSection_node: {
@@ -1216,6 +1276,9 @@ const jsonWithTypes = {
             $ref: '#/definitions/breakout_mark',
           },
         },
+        content: {
+          type: 'array',
+        },
       },
     },
     layoutSection_full_node: {},
@@ -1225,7 +1288,22 @@ const jsonWithTypes = {
         type: {
           enum: ['doc'],
         },
+        content: {
+          type: 'array',
+        },
       },
     },
   },
 };
+
+// New JSON, different to the old JSON schema
+jsonWithTypes.definitions.heading_node.properties.content = { type: 'array' };
+jsonWithTypes.definitions.nestedExpand_node.properties.content = {
+  type: 'array',
+};
+jsonWithTypes.definitions.table_cell_node.properties.content = {
+  type: 'array',
+};
+jsonWithTypes.definitions.table_header_node.properties.content = {
+  type: 'array',
+};