@atlaskit/adf-schema 36.12.2 → 36.12.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 36.12.3
+
+### Patch Changes
+
+- 9e4b045: Add additional properties field
+
 ## 36.12.2
 
 ### Patch Changes

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

@@ -16,6 +16,7 @@ var blockCard = exports.blockCard = (0, _adfSchemaGenerator.adfNode)('blockCard'
       },
       datasource: {
         type: 'object',
+        additionalProperties: false,
         properties: {
           id: {
             type: 'string'
@@ -24,6 +25,7 @@ var blockCard = exports.blockCard = (0, _adfSchemaGenerator.adfNode)('blockCard'
           parameters: {},
           views: {
             items: {
+              additionalProperties: false,
               properties: {
                 // Empty properties object carried over from original JSON Schema
                 properties: {},

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

@@ -10,6 +10,7 @@ export const blockCard = adfNode('blockCard').define({
       },
       datasource: {
         type: 'object',
+        additionalProperties: false,
         properties: {
           id: {
             type: 'string'
@@ -18,6 +19,7 @@ export const blockCard = adfNode('blockCard').define({
           parameters: {},
           views: {
             items: {
+              additionalProperties: false,
               properties: {
                 // Empty properties object carried over from original JSON Schema
                 properties: {},

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

@@ -10,6 +10,7 @@ export var blockCard = adfNode('blockCard').define({
       },
       datasource: {
         type: 'object',
+        additionalProperties: false,
         properties: {
           id: {
             type: 'string'
@@ -18,6 +19,7 @@ export var blockCard = adfNode('blockCard').define({
           parameters: {},
           views: {
             items: {
+              additionalProperties: false,
               properties: {
                 // Empty properties object carried over from original JSON Schema
                 properties: {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.12.2",
+  "version": "36.12.3",
   "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.11.1",
+    "@atlaskit/adf-schema-generator": "^1.11.2",
     "@atlaskit/codemod-utils": "^4.2.4",
     "@atlaskit/json-schema-generator": "^3.3.9",
     "@babel/cli": "^7.22.9",

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

@@ -179,3 +179,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.
+
+`additionalProperties` and `allOf` are 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(
+  .allOf,
+  .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

@@ -24,6 +24,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'text'],
+      additionalProperties: false,
     },
     breakout_mark: {
       type: 'object',
@@ -39,9 +40,11 @@ const jsonWithTypes = {
             },
           },
           required: ['mode'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     codeBlock_node: {
       type: 'object',
@@ -60,9 +63,11 @@ const jsonWithTypes = {
               type: 'string',
             },
           },
+          additionalProperties: false,
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     codeBlock_with_no_marks_node: {},
     codeBlock_with_marks_node: {},
@@ -74,6 +79,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     code_mark: {
       type: 'object',
@@ -83,6 +89,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     strike_mark: {
       type: 'object',
@@ -92,6 +99,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     strong_mark: {
       type: 'object',
@@ -101,6 +109,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     underline_mark: {
       type: 'object',
@@ -110,6 +119,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     link_mark: {
       type: 'object',
@@ -137,9 +147,11 @@ const jsonWithTypes = {
             },
           },
           required: ['href'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     subsup_mark: {
       type: 'object',
@@ -155,9 +167,11 @@ const jsonWithTypes = {
             },
           },
           required: ['type'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     textColor_mark: {
       type: 'object',
@@ -174,9 +188,11 @@ const jsonWithTypes = {
             },
           },
           required: ['color'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     alignment_mark: {
       type: 'object',
@@ -192,9 +208,11 @@ const jsonWithTypes = {
             },
           },
           required: ['align'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     indentation_mark: {
       type: 'object',
@@ -212,9 +230,11 @@ const jsonWithTypes = {
             },
           },
           required: ['level'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     annotation_mark: {
       type: 'object',
@@ -233,9 +253,11 @@ const jsonWithTypes = {
             },
           },
           required: ['id', 'annotationType'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     dataConsumer_mark: {
       type: 'object',
@@ -255,9 +277,11 @@ const jsonWithTypes = {
             },
           },
           required: ['sources'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     fragment_mark: {
       type: 'object',
@@ -277,9 +301,11 @@ const jsonWithTypes = {
             },
           },
           required: ['localId'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     border_mark: {
       type: 'object',
@@ -301,9 +327,11 @@ const jsonWithTypes = {
             },
           },
           required: ['size', 'color'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     backgroundColor_mark: {
       type: 'object',
@@ -320,9 +348,11 @@ const jsonWithTypes = {
             },
           },
           required: ['color'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     hardBreak_node: {
       type: 'object',
@@ -337,9 +367,11 @@ const jsonWithTypes = {
               enum: ['\n'],
             },
           },
+          additionalProperties: false,
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     mention_node: {
       type: 'object',
@@ -367,9 +399,11 @@ const jsonWithTypes = {
             },
           },
           required: ['id'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     emoji_node: {
       type: 'object',
@@ -390,10 +424,12 @@ const jsonWithTypes = {
               type: 'string',
             },
           },
+          additionalProperties: false,
           required: ['shortName'],
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     inlineExtension_node: {
       type: 'object',
@@ -422,9 +458,11 @@ const jsonWithTypes = {
             },
           },
           required: ['extensionKey', 'extensionType'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     inlineExtension_with_marks_node: {},
     date_node: {
@@ -442,9 +480,11 @@ const jsonWithTypes = {
             },
           },
           required: ['timestamp'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     placeholder_node: {
       type: 'object',
@@ -460,9 +500,11 @@ const jsonWithTypes = {
             },
           },
           required: ['text'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     blockCard_node: {
       type: 'object',
@@ -496,11 +538,13 @@ const jsonWithTypes = {
                           properties: {},
                         },
                         required: ['type'],
+                        additionalProperties: false,
                       },
                       minItems: 1,
                     },
                   },
                   required: ['id', 'parameters', 'views'],
+                  additionalProperties: false,
                 },
                 width: {
                   type: 'number',
@@ -517,6 +561,7 @@ const jsonWithTypes = {
                   ],
                 },
               },
+              additionalProperties: false,
               required: ['datasource'],
             },
             {
@@ -527,6 +572,7 @@ const jsonWithTypes = {
                 },
               },
               required: ['url'],
+              additionalProperties: false,
             },
             {
               type: 'object',
@@ -534,11 +580,13 @@ const jsonWithTypes = {
                 data: {},
               },
               required: ['data'],
+              additionalProperties: false,
             },
           ],
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     inlineCard_node: {
       type: 'object',
@@ -556,6 +604,7 @@ const jsonWithTypes = {
                 },
               },
               required: ['url'],
+              additionalProperties: false,
             },
             {
               type: 'object',
@@ -563,11 +612,13 @@ const jsonWithTypes = {
                 data: {},
               },
               required: ['data'],
+              additionalProperties: false,
             },
           ],
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     status_node: {
       type: 'object',
@@ -593,9 +644,11 @@ const jsonWithTypes = {
             },
           },
           required: ['text', 'color'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     media_node: {
       type: 'object',
@@ -633,6 +686,7 @@ const jsonWithTypes = {
                 },
               },
               required: ['type', 'id', 'collection'],
+              additionalProperties: false,
             },
             {
               type: 'object',
@@ -654,6 +708,7 @@ const jsonWithTypes = {
                 },
               },
               required: ['type', 'url'],
+              additionalProperties: false,
             },
           ],
         },
@@ -675,6 +730,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     mediaInline_node: {
       type: 'object',
@@ -710,6 +766,7 @@ const jsonWithTypes = {
               type: 'string',
             },
           },
+          additionalProperties: false,
           required: ['id', 'collection'],
         },
         marks: {
@@ -730,6 +787,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     formatted_text_inline_node: {},
     code_inline_node: {},
@@ -747,6 +805,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     paragraph_with_no_marks_node: {},
     paragraph_with_alignment_node: {},
@@ -794,6 +853,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     mediaSingle_node: {
       type: 'object',
@@ -826,6 +886,7 @@ const jsonWithTypes = {
                   ],
                 },
               },
+              additionalProperties: false,
               required: ['layout'],
             },
             {
@@ -851,6 +912,7 @@ const jsonWithTypes = {
                 },
               },
               required: ['width', 'widthType', 'layout'],
+              additionalProperties: false,
             },
           ],
         },
@@ -862,6 +924,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: true,
     },
     mediaSingle_caption_node: {},
     mediaSingle_full_node: {},
@@ -888,9 +951,11 @@ const jsonWithTypes = {
             },
           },
           required: ['localId', 'state'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     taskList_node: {
       type: 'object',
@@ -925,9 +990,11 @@ const jsonWithTypes = {
             },
           },
           required: ['localId'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'content', 'attrs'],
+      additionalProperties: false,
     },
     listItem_node: {
       type: 'object',
@@ -984,6 +1051,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     bulletList_node: {
       type: 'object',
@@ -1000,6 +1068,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     orderedList_node: {
       type: 'object',
@@ -1022,9 +1091,11 @@ const jsonWithTypes = {
               minimum: 0,
             },
           },
+          additionalProperties: false,
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     heading_node: {
       type: 'object',
@@ -1048,9 +1119,11 @@ const jsonWithTypes = {
             },
           },
           required: ['level'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     heading_with_no_marks_node: {},
     heading_with_alignment_node: {},
@@ -1070,6 +1143,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     decisionItem_node: {
       type: 'object',
@@ -1094,9 +1168,11 @@ const jsonWithTypes = {
             },
           },
           required: ['localId', 'state'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     decisionList_node: {
       type: 'object',
@@ -1119,9 +1195,11 @@ const jsonWithTypes = {
             },
           },
           required: ['localId'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'content', 'attrs'],
+      additionalProperties: false,
     },
     rule_node: {
       type: 'object',
@@ -1131,6 +1209,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type'],
+      additionalProperties: false,
     },
     panel_node: {
       type: 'object',
@@ -1166,6 +1245,7 @@ const jsonWithTypes = {
             },
           },
           required: ['panelType'],
+          additionalProperties: false,
         },
         content: {
           type: 'array',
@@ -1213,6 +1293,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'attrs', 'content'],
+      additionalProperties: false,
     },
     blockquote_node: {
       type: 'object',
@@ -1239,6 +1320,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     extension_node: {
       type: 'object',
@@ -1270,9 +1352,11 @@ const jsonWithTypes = {
             },
           },
           required: ['extensionKey', 'extensionType'],
+          additionalProperties: false,
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     extension_with_marks_node: {},
     embedCard_node: {
@@ -1310,10 +1394,12 @@ const jsonWithTypes = {
               ],
             },
           },
+          additionalProperties: false,
           required: ['url', 'layout'],
         },
       },
       required: ['type', 'attrs'],
+      additionalProperties: false,
     },
     nestedExpand_node: {
       type: 'object',
@@ -1328,12 +1414,14 @@ const jsonWithTypes = {
               type: 'string',
             },
           },
+          additionalProperties: false,
         },
         content: {
           $ref: '#/definitions/nestedExpand_content',
         },
       },
       required: ['type', 'attrs', 'content'],
+      additionalProperties: false,
     },
     nestedExpand_with_no_marks_node: {},
     table_node: {
@@ -1369,6 +1457,7 @@ const jsonWithTypes = {
               enum: ['default', 'fixed'],
             },
           },
+          additionalProperties: false,
         },
         content: {
           type: 'array',
@@ -1385,6 +1474,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     table_row_node: {
       type: 'object',
@@ -1407,6 +1497,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     table_cell_node: {
       type: 'object',
@@ -1433,12 +1524,14 @@ const jsonWithTypes = {
               type: 'string',
             },
           },
+          additionalProperties: false,
         },
         content: {
           $ref: '#/definitions/table_cell_content',
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     table_header_node: {
       type: 'object',
@@ -1465,12 +1558,14 @@ const jsonWithTypes = {
               type: 'string',
             },
           },
+          additionalProperties: false,
         },
         content: {
           $ref: '#/definitions/table_cell_content',
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     expand_node: {
       type: 'object',
@@ -1485,6 +1580,7 @@ const jsonWithTypes = {
               type: 'string',
             },
           },
+          additionalProperties: false,
         },
         content: {
           type: 'array',
@@ -1495,6 +1591,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'attrs', 'content'],
+      additionalProperties: false,
     },
     expand_with_no_mark_node: {},
     expand_with_breakout_mark_node: {},
@@ -1528,6 +1625,7 @@ const jsonWithTypes = {
             },
           },
           required: ['extensionKey', 'extensionType'],
+          additionalProperties: false,
         },
         content: {
           type: 'array',
@@ -1538,6 +1636,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'attrs', 'content'],
+      additionalProperties: false,
     },
     bodiedExtension_with_marks_node: {},
     layoutColumn_node: {
@@ -1556,6 +1655,7 @@ const jsonWithTypes = {
             },
           },
           required: ['width'],
+          additionalProperties: false,
         },
         content: {
           type: 'array',
@@ -1566,6 +1666,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'attrs', 'content'],
+      additionalProperties: false,
     },
     layoutSection_node: {
       type: 'object',
@@ -1587,6 +1688,7 @@ const jsonWithTypes = {
         },
       },
       required: ['type', 'content'],
+      additionalProperties: false,
     },
     layoutSection_full_node: {},
     doc_node: {
@@ -1685,6 +1787,7 @@ const jsonWithTypes = {
         },
       },
       required: ['version', 'type', 'content'],
+      additionalProperties: false,
     },
   },
 };