@atlaskit/adf-schema 36.10.3 → 36.10.5

package/CHANGELOG.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.10.3",
+  "version": "36.10.5",
   "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.8",
+    "@atlaskit/adf-schema-generator": "^1.7.10",
     "@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

@@ -88,3 +88,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)' | 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
+```
+
+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 and items 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.anyOf?, .content.items."$ref"?, .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,7 +46,10 @@ const jsonWithTypes = {
         type: {
           enum: ['codeBlock'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -678,7 +681,10 @@ const jsonWithTypes = {
         type: {
           enum: ['paragraph'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     paragraph_with_no_marks_node: {},
@@ -690,7 +696,10 @@ const jsonWithTypes = {
         type: {
           enum: ['caption'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     mediaSingle_node: {
@@ -766,7 +775,10 @@ const jsonWithTypes = {
         type: {
           enum: ['taskItem'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -786,7 +798,10 @@ const jsonWithTypes = {
         type: {
           enum: ['taskList'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: [],
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -803,7 +818,10 @@ const jsonWithTypes = {
         type: {
           enum: ['listItem'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: [],
+        },
       },
     },
     bulletList_node: {
@@ -812,7 +830,10 @@ const jsonWithTypes = {
         type: {
           enum: ['bulletList'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     orderedList_node: {
@@ -821,7 +842,10 @@ const jsonWithTypes = {
         type: {
           enum: ['orderedList'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -839,7 +863,10 @@ const jsonWithTypes = {
         type: {
           enum: ['heading'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -861,7 +888,10 @@ const jsonWithTypes = {
         type: {
           enum: ['mediaGroup'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     decisionItem_node: {
@@ -870,7 +900,10 @@ const jsonWithTypes = {
         type: {
           enum: ['decisionItem'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -890,7 +923,10 @@ const jsonWithTypes = {
         type: {
           enum: ['decisionList'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
         attrs: {
           type: 'object',
           properties: {
@@ -943,7 +979,10 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     blockquote_node: {
@@ -952,7 +991,10 @@ const jsonWithTypes = {
         type: {
           enum: ['blockquote'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     extension_node: {
@@ -1078,7 +1120,10 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
         marks: {
           type: 'array',
           items: {
@@ -1093,7 +1138,10 @@ const jsonWithTypes = {
         type: {
           enum: ['tableRow'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     table_cell_node: {
@@ -1168,7 +1216,10 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     expand_with_no_mark_node: {},
@@ -1203,7 +1254,10 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     bodiedExtension_with_marks_node: {},
@@ -1223,7 +1277,10 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     layoutSection_node: {
@@ -1238,7 +1295,10 @@ const jsonWithTypes = {
             $ref: '#/definitions/breakout_mark',
           },
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     layoutSection_full_node: {},
@@ -1248,8 +1308,29 @@ const jsonWithTypes = {
         type: {
           enum: ['doc'],
         },
-        content: {},
+        content: {
+          type: 'array',
+          items: {},
+        },
       },
     },
   },
 };
+
+// New JSON, different to the old JSON schema
+jsonWithTypes.definitions.heading_node.properties.content = {
+  type: 'array',
+  items: {},
+};
+jsonWithTypes.definitions.nestedExpand_node.properties.content = {
+  type: 'array',
+  items: {},
+};
+jsonWithTypes.definitions.table_cell_node.properties.content = {
+  type: 'array',
+  items: {},
+};
+jsonWithTypes.definitions.table_header_node.properties.content = {
+  type: 'array',
+  items: {},
+};