@atlaskit/adf-schema 36.10.8 → 36.10.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 36.10.9
+
+### Patch Changes
+
+- 7579d7a: Add minItems field to ADF JSON Schema transformer from ADF DSL
+
 ## 36.10.8
 
 ### Patch Changes

package/dist/cjs/next-schema/full-schema.adf.js

@@ -10,6 +10,6 @@ var _layoutSection = require("./nodes/layoutSection");
 var _blockRootOnlyGroup = require("./groups/blockRootOnlyGroup");
 var doc = (0, _adfSchemaGenerator.adfNode)('doc').define({
   root: true,
-  content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_blockGroup.blockGroup, _layoutSection.layoutSection, _layoutSection.layoutSection.use('full'), _blockRootOnlyGroup.blockRootOnlyGroup))]
+  content: [(0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_blockGroup.blockGroup, _layoutSection.layoutSection, _layoutSection.layoutSection.use('full'), _blockRootOnlyGroup.blockRootOnlyGroup))]
 });
 var _default = exports.default = doc;

package/dist/cjs/next-schema/marks/dataConsumer.js

@@ -11,7 +11,8 @@ var dataConsumer = exports.dataConsumer = (0, _adfSchemaGenerator.adfMark)('data
       type: 'array',
       items: {
         type: 'string'
-      }
+      },
+      minItems: 1
     }
   }
 });

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

@@ -34,6 +34,7 @@ var blockCard = exports.blockCard = (0, _adfSchemaGenerator.adfNode)('blockCard'
               },
               type: 'object'
             },
+            minItems: 1,
             type: 'array'
           }
         }

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

@@ -9,5 +9,5 @@ var _tableCell = require("./tableCell");
 var _tableHeader = require("./tableHeader");
 var tableRow = exports.tableRow = (0, _adfSchemaGenerator.adfNode)('tableRow').define({
   selectable: false,
-  content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_tableCell.tableCell, _tableHeader.tableHeader))]
+  content: [(0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_tableCell.tableCell, _tableHeader.tableHeader))]
 });

package/dist/es2019/next-schema/full-schema.adf.js

@@ -1,9 +1,9 @@
-import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { $or, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
 import { blockGroup } from './groups/blockGroup';
 import { layoutSection } from './nodes/layoutSection';
 import { blockRootOnlyGroup } from './groups/blockRootOnlyGroup';
 const doc = adfNode('doc').define({
   root: true,
-  content: [$onePlus($or(blockGroup, layoutSection, layoutSection.use('full'), blockRootOnlyGroup))]
+  content: [$zeroPlus($or(blockGroup, layoutSection, layoutSection.use('full'), blockRootOnlyGroup))]
 });
 export default doc;

package/dist/es2019/next-schema/marks/dataConsumer.js

@@ -5,7 +5,8 @@ export const dataConsumer = adfMark('dataConsumer').define({
       type: 'array',
       items: {
         type: 'string'
-      }
+      },
+      minItems: 1
     }
   }
 });

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

@@ -28,6 +28,7 @@ export const blockCard = adfNode('blockCard').define({
               },
               type: 'object'
             },
+            minItems: 1,
             type: 'array'
           }
         }

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

@@ -1,7 +1,7 @@
-import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { $or, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
 import { tableCell } from './tableCell';
 import { tableHeader } from './tableHeader';
 export const tableRow = adfNode('tableRow').define({
   selectable: false,
-  content: [$onePlus($or(tableCell, tableHeader))]
+  content: [$zeroPlus($or(tableCell, tableHeader))]
 });

package/dist/esm/next-schema/full-schema.adf.js

@@ -1,9 +1,9 @@
-import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { $or, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
 import { blockGroup } from './groups/blockGroup';
 import { layoutSection } from './nodes/layoutSection';
 import { blockRootOnlyGroup } from './groups/blockRootOnlyGroup';
 var doc = adfNode('doc').define({
   root: true,
-  content: [$onePlus($or(blockGroup, layoutSection, layoutSection.use('full'), blockRootOnlyGroup))]
+  content: [$zeroPlus($or(blockGroup, layoutSection, layoutSection.use('full'), blockRootOnlyGroup))]
 });
 export default doc;

package/dist/esm/next-schema/marks/dataConsumer.js

@@ -5,7 +5,8 @@ export var dataConsumer = adfMark('dataConsumer').define({
       type: 'array',
       items: {
         type: 'string'
-      }
+      },
+      minItems: 1
     }
   }
 });

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

@@ -28,6 +28,7 @@ export var blockCard = adfNode('blockCard').define({
               },
               type: 'object'
             },
+            minItems: 1,
             type: 'array'
           }
         }

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

@@ -1,7 +1,7 @@
-import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { $or, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
 import { tableCell } from './tableCell';
 import { tableHeader } from './tableHeader';
 export var tableRow = adfNode('tableRow').define({
   selectable: false,
-  content: [$onePlus($or(tableCell, tableHeader))]
+  content: [$zeroPlus($or(tableCell, tableHeader))]
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.10.8",
+  "version": "36.10.9",
   "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.1",
+    "@atlaskit/adf-schema-generator": "^1.8.2",
     "@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

@@ -114,3 +114,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 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, .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

@@ -230,6 +230,7 @@ const jsonWithTypes = {
               items: {
                 type: 'string',
               },
+              minItems: 1,
             },
           },
         },
@@ -455,6 +456,7 @@ const jsonWithTypes = {
                           properties: {},
                         },
                       },
+                      minItems: 1,
                     },
                   },
                 },
@@ -699,6 +701,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 0,
         },
       },
     },
@@ -801,6 +804,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: [],
+          minItems: 1,
         },
         attrs: {
           type: 'object',
@@ -821,6 +825,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: [],
+          minItems: 1,
         },
       },
     },
@@ -833,6 +838,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
       },
     },
@@ -845,6 +851,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
         attrs: {
           type: 'object',
@@ -891,6 +898,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
       },
     },
@@ -926,6 +934,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
         attrs: {
           type: 'object',
@@ -982,6 +991,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
       },
     },
@@ -994,6 +1004,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
       },
     },
@@ -1123,6 +1134,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
         marks: {
           type: 'array',
@@ -1219,6 +1231,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
       },
     },
@@ -1257,6 +1270,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
       },
     },
@@ -1280,6 +1294,7 @@ const jsonWithTypes = {
         content: {
           type: 'array',
           items: {},
+          minItems: 1,
         },
       },
     },
@@ -1325,12 +1340,15 @@ jsonWithTypes.definitions.heading_node.properties.content = {
 jsonWithTypes.definitions.nestedExpand_node.properties.content = {
   type: 'array',
   items: {},
+  minItems: 1,
 };
 jsonWithTypes.definitions.table_cell_node.properties.content = {
   type: 'array',
   items: {},
+  minItems: 1,
 };
 jsonWithTypes.definitions.table_header_node.properties.content = {
   type: 'array',
   items: {},
+  minItems: 1,
 };