@atlaskit/adf-schema 36.10.11 → 36.10.12

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 36.10.12
+
+### Patch Changes
+
+- cc7c8bf: Add content list field and $ref field to JSON Schema transformer from ADF DSL
+
 ## 36.10.11
 
 ### Patch Changes

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

@@ -10,7 +10,7 @@ var _paragraph = require("./paragraph");
 var blockquote = exports.blockquote = (0, _adfSchemaGenerator.adfNode)('blockquote').define({
   defining: true,
   selectable: false,
-  content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_paragraph.paragraph))]
+  content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_paragraph.paragraph.use('with_no_marks'), _list.bulletList, _list.orderedList))]
 }).variant('with_list', {
   content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_paragraph.paragraph, _list.orderedList, _list.bulletList))]
 });

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

@@ -30,5 +30,5 @@ bulletList.define({
 listItem.define({
   defining: true,
   selectable: false,
-  content: [(0, _adfSchemaGenerator.$or)(_paragraph.paragraph, _mediaSingle.mediaSingle, _codeBlock.codeBlock), (0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_paragraph.paragraph, orderedList, bulletList, _mediaSingle.mediaSingle, _codeBlock.codeBlock, _task.taskList))]
+  content: [(0, _adfSchemaGenerator.$or)(_codeBlock.codeBlock.use('with_no_marks'), _paragraph.paragraph.use('with_no_marks'), _mediaSingle.mediaSingle.use('caption'), _mediaSingle.mediaSingle.use('full')), (0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_codeBlock.codeBlock.use('with_no_marks'), _paragraph.paragraph.use('with_no_marks'), _mediaSingle.mediaSingle.use('caption'), _mediaSingle.mediaSingle.use('full'), _task.taskList, bulletList, orderedList))]
 });

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

@@ -4,7 +4,7 @@ import { paragraph } from './paragraph';
 export const blockquote = adfNode('blockquote').define({
   defining: true,
   selectable: false,
-  content: [$onePlus($or(paragraph))]
+  content: [$onePlus($or(paragraph.use('with_no_marks'), bulletList, orderedList))]
 }).variant('with_list', {
   content: [$onePlus($or(paragraph, orderedList, bulletList))]
 });

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

@@ -24,5 +24,5 @@ bulletList.define({
 listItem.define({
   defining: true,
   selectable: false,
-  content: [$or(paragraph, mediaSingle, codeBlock), $zeroPlus($or(paragraph, orderedList, bulletList, mediaSingle, codeBlock, taskList))]
+  content: [$or(codeBlock.use('with_no_marks'), paragraph.use('with_no_marks'), mediaSingle.use('caption'), mediaSingle.use('full')), $zeroPlus($or(codeBlock.use('with_no_marks'), paragraph.use('with_no_marks'), mediaSingle.use('caption'), mediaSingle.use('full'), taskList, bulletList, orderedList))]
 });

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

@@ -4,7 +4,7 @@ import { paragraph } from './paragraph';
 export var blockquote = adfNode('blockquote').define({
   defining: true,
   selectable: false,
-  content: [$onePlus($or(paragraph))]
+  content: [$onePlus($or(paragraph.use('with_no_marks'), bulletList, orderedList))]
 }).variant('with_list', {
   content: [$onePlus($or(paragraph, orderedList, bulletList))]
 });

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

@@ -24,5 +24,5 @@ bulletList.define({
 listItem.define({
   defining: true,
   selectable: false,
-  content: [$or(paragraph, mediaSingle, codeBlock), $zeroPlus($or(paragraph, orderedList, bulletList, mediaSingle, codeBlock, taskList))]
+  content: [$or(codeBlock.use('with_no_marks'), paragraph.use('with_no_marks'), mediaSingle.use('caption'), mediaSingle.use('full')), $zeroPlus($or(codeBlock.use('with_no_marks'), paragraph.use('with_no_marks'), mediaSingle.use('caption'), mediaSingle.use('full'), taskList, bulletList, orderedList))]
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.10.11",
+  "version": "36.10.12",
   "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.8.4",
+    "@atlaskit/adf-schema-generator": "^1.8.6",
     "@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

@@ -140,3 +140,16 @@ 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
 ```
+
+Base level content objects (not nodes) are deleted. `inline` is also deleted, as it is a content object for paragraph.
+
+All fields of content except for type, items, items.$ref and $ref 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(
+  .required, .additionalProperties, .allOf, .content.items.anyOf?,
+  .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

@@ -685,7 +685,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/inline_node',
+          },
         },
       },
     },
@@ -780,7 +782,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/inline_node',
+          },
         },
         attrs: {
           type: 'object',
@@ -803,7 +807,21 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: [],
+          items: [
+            {
+              $ref: '#/definitions/taskItem_node',
+            },
+            {
+              anyOf: [
+                {
+                  $ref: '#/definitions/taskItem_node',
+                },
+                {
+                  $ref: '#/definitions/taskList_node',
+                },
+              ],
+            },
+          ],
           minItems: 1,
         },
         attrs: {
@@ -824,7 +842,49 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: [],
+          items: [
+            {
+              anyOf: [
+                {
+                  $ref: '#/definitions/codeBlock_with_no_marks_node',
+                },
+                {
+                  $ref: '#/definitions/paragraph_with_no_marks_node',
+                },
+                {
+                  $ref: '#/definitions/mediaSingle_caption_node',
+                },
+                {
+                  $ref: '#/definitions/mediaSingle_full_node',
+                },
+              ],
+            },
+            {
+              anyOf: [
+                {
+                  $ref: '#/definitions/codeBlock_with_no_marks_node',
+                },
+                {
+                  $ref: '#/definitions/paragraph_with_no_marks_node',
+                },
+                {
+                  $ref: '#/definitions/mediaSingle_caption_node',
+                },
+                {
+                  $ref: '#/definitions/mediaSingle_full_node',
+                },
+                {
+                  $ref: '#/definitions/taskList_node',
+                },
+                {
+                  $ref: '#/definitions/bulletList_node',
+                },
+                {
+                  $ref: '#/definitions/orderedList_node',
+                },
+              ],
+            },
+          ],
           minItems: 1,
         },
       },
@@ -837,7 +897,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/listItem_node',
+          },
           minItems: 1,
         },
       },
@@ -850,7 +912,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/listItem_node',
+          },
           minItems: 1,
         },
         attrs: {
@@ -872,7 +936,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/inline_node',
+          },
         },
         attrs: {
           type: 'object',
@@ -897,7 +963,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/media_node',
+          },
           minItems: 1,
         },
       },
@@ -910,7 +978,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/inline_node',
+          },
         },
         attrs: {
           type: 'object',
@@ -933,7 +1003,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/decisionItem_node',
+          },
           minItems: 1,
         },
         attrs: {
@@ -1093,7 +1165,9 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          $ref: '#/definitions/nestedExpand_content',
+        },
       },
     },
     nestedExpand_with_no_marks_node: {},
@@ -1133,7 +1207,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/table_row_node',
+          },
           minItems: 1,
         },
         marks: {
@@ -1182,7 +1258,9 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          $ref: '#/definitions/table_cell_content',
+        },
       },
     },
     table_header_node: {
@@ -1211,7 +1289,9 @@ const jsonWithTypes = {
             },
           },
         },
-        content: {},
+        content: {
+          $ref: '#/definitions/table_cell_content',
+        },
       },
     },
     expand_node: {
@@ -1230,7 +1310,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/non_nestable_block_content',
+          },
           minItems: 1,
         },
       },
@@ -1269,7 +1351,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/non_nestable_block_content',
+          },
           minItems: 1,
         },
       },
@@ -1293,7 +1377,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/block_content',
+          },
           minItems: 1,
         },
       },
@@ -1312,7 +1398,9 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            $ref: '#/definitions/layoutColumn_node',
+          },
         },
       },
     },
@@ -1336,15 +1424,13 @@ const jsonWithTypes = {
 };
 
 // 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: {},
   minItems: 1,
 };
+jsonWithTypes.definitions.expand_node.properties.content.items = {};
+jsonWithTypes.definitions.bodiedExtension_node.properties.content.items = {};
 jsonWithTypes.definitions.table_cell_node.properties.content = {
   type: 'array',
   items: {},