@atlaskit/adf-schema 36.8.1 → 36.8.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/adf-schema
 
+## 36.8.3
+
+### Patch Changes
+
+- 3d6a62a: Add properties, marks, and mark array type
+
+## 36.8.2
+
+### Patch Changes
+
+- f80bbc4: Process type for json schema generator from ADF DSL
+
 ## 36.8.1
 
 ### Patch Changes

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

@@ -20,7 +20,7 @@ var _panel = require("./panel");
 var _paragraph = require("./paragraph");
 var _rule = require("./rule");
 var _task = require("./task");
-var tableCell = exports.tableCell = (0, _adfSchemaGenerator.adfNode)('table_cell').define({
+var tableCell = exports.tableCell = (0, _adfSchemaGenerator.adfNode)('tableCell').define({
   isolating: true,
   selectable: false,
   tableRole: 'cell',

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

@@ -20,7 +20,7 @@ var _panel = require("./panel");
 var _paragraph = require("./paragraph");
 var _rule = require("./rule");
 var _task = require("./task");
-var tableHeader = exports.tableHeader = (0, _adfSchemaGenerator.adfNode)('table_header').define({
+var tableHeader = exports.tableHeader = (0, _adfSchemaGenerator.adfNode)('tableHeader').define({
   isolating: true,
   selectable: false,
   tableRole: 'header_cell',

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

@@ -7,7 +7,7 @@ exports.tableRow = void 0;
 var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
 var _tableCell = require("./tableCell");
 var _tableHeader = require("./tableHeader");
-var tableRow = exports.tableRow = (0, _adfSchemaGenerator.adfNode)('table_row').define({
+var tableRow = exports.tableRow = (0, _adfSchemaGenerator.adfNode)('tableRow').define({
   selectable: false,
   content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_tableCell.tableCell, _tableHeader.tableHeader))]
 });

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

@@ -14,7 +14,7 @@ import { panel } from './panel';
 import { paragraph } from './paragraph';
 import { rule } from './rule';
 import { taskList } from './task';
-export const tableCell = adfNode('table_cell').define({
+export const tableCell = adfNode('tableCell').define({
   isolating: true,
   selectable: false,
   tableRole: 'cell',

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

@@ -14,7 +14,7 @@ import { panel } from './panel';
 import { paragraph } from './paragraph';
 import { rule } from './rule';
 import { taskList } from './task';
-export const tableHeader = adfNode('table_header').define({
+export const tableHeader = adfNode('tableHeader').define({
   isolating: true,
   selectable: false,
   tableRole: 'header_cell',

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

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

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

@@ -14,7 +14,7 @@ import { panel } from './panel';
 import { paragraph } from './paragraph';
 import { rule } from './rule';
 import { taskList } from './task';
-export var tableCell = adfNode('table_cell').define({
+export var tableCell = adfNode('tableCell').define({
   isolating: true,
   selectable: false,
   tableRole: 'cell',

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

@@ -14,7 +14,7 @@ import { panel } from './panel';
 import { paragraph } from './paragraph';
 import { rule } from './rule';
 import { taskList } from './task';
-export var tableHeader = adfNode('table_header').define({
+export var tableHeader = adfNode('tableHeader').define({
   isolating: true,
   selectable: false,
   tableRole: 'header_cell',

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.8.1",
+  "version": "36.8.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.7.0",
+    "@atlaskit/adf-schema-generator": "^1.7.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

@@ -19,3 +19,26 @@ Delete all subfields except for type. Content objects are also deleted. Inline i
 ```sh
  cat packages/adf-schema/json-schema/v1/full.json | jq 'walk(if type == "object" then del(.content, .properties, .text, .marks, .attrs, .version, .required, .additionalProperties, .allOf, .anyOf, .items, .minItems, .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node) else . end)'
 ```
+
+Delete all subfields except for type and properties. Content objects are also deleted. Inline is also deleted, as it is a content object for paragraph.
+
+```sh
+ cat packages/adf-schema/json-schema/v1/full.json | jq 'walk(if type == "object" then del(.content, .text, .marks, .attrs, .version, .required, .additionalProperties, .allOf, .anyOf, .items, .minItems, .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node) else . end)'
+```
+
+Delete all subfields except for marks, type and properties. Content objects are also deleted. Inline is also deleted, as it is a content object for paragraph.
+
+```sh
+ cat packages/adf-schema/json-schema/v1/full.json | jq 'walk(if type == "object" then del(.content, .text, .attrs, .version, .required, .additionalProperties, .allOf, .anyOf, .items, .minItems, .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node) else . end)'
+```
+
+Delete all subfields except for marks, type and properties. Content objects are also deleted. Inline is also deleted, as it is a content object for paragraph.
+
+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(
+  .content, .text, .attrs, .version, .required, .additionalProperties, .allOf, .anyOf, .items, .minItems,
+  .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) else . end)'
+```

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

@@ -15,190 +15,491 @@ const jsonWithTypes = {
   definitions: {
     text_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['text'],
+        },
+      },
     },
     breakout_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['breakout'],
+        },
+      },
     },
     codeBlock_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['codeBlock'],
+        },
+      },
     },
     codeBlock_with_no_marks_node: {},
     codeBlock_with_marks_node: {},
     em_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['em'],
+        },
+      },
     },
     code_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['code'],
+        },
+      },
     },
     strike_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['strike'],
+        },
+      },
     },
     strong_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['strong'],
+        },
+      },
     },
     underline_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['underline'],
+        },
+      },
     },
     link_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['link'],
+        },
+      },
     },
     subsup_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['subsup'],
+        },
+      },
     },
     textColor_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['textColor'],
+        },
+      },
     },
     alignment_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['alignment'],
+        },
+      },
     },
     indentation_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['indentation'],
+        },
+      },
     },
     annotation_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['annotation'],
+        },
+      },
     },
     dataConsumer_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['dataConsumer'],
+        },
+      },
     },
     fragment_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['fragment'],
+        },
+      },
     },
     border_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['border'],
+        },
+      },
     },
     backgroundColor_mark: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['backgroundColor'],
+        },
+      },
     },
     hardBreak_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['hardBreak'],
+        },
+      },
     },
     mention_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['mention'],
+        },
+      },
     },
     emoji_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['emoji'],
+        },
+      },
     },
     inlineExtension_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['inlineExtension'],
+        },
+      },
     },
     inlineExtension_with_marks_node: {},
     date_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['date'],
+        },
+      },
     },
     placeholder_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['placeholder'],
+        },
+      },
     },
     blockCard_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['blockCard'],
+        },
+      },
     },
     inlineCard_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['inlineCard'],
+        },
+      },
     },
     status_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['status'],
+        },
+      },
     },
     media_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['media'],
+        },
+        marks: {
+          type: 'array',
+        },
+      },
     },
     mediaInline_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['mediaInline'],
+        },
+        marks: {
+          type: 'array',
+        },
+      },
     },
     formatted_text_inline_node: {},
     code_inline_node: {},
     paragraph_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['paragraph'],
+        },
+        marks: {
+          type: 'array',
+        },
+      },
     },
     paragraph_with_no_marks_node: {},
     paragraph_with_alignment_node: {},
     paragraph_with_indentation_node: {},
     caption_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['caption'],
+        },
+      },
     },
     mediaSingle_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['mediaSingle'],
+        },
+        marks: {
+          type: 'array',
+        },
+      },
     },
     mediaSingle_caption_node: {},
     mediaSingle_full_node: {},
     taskItem_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['taskItem'],
+        },
+      },
     },
     taskList_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['taskList'],
+        },
+      },
     },
     listItem_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['listItem'],
+        },
+      },
     },
     bulletList_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['bulletList'],
+        },
+      },
     },
     orderedList_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['orderedList'],
+        },
+      },
     },
     heading_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['heading'],
+        },
+      },
     },
     heading_with_no_marks_node: {},
     heading_with_alignment_node: {},
     heading_with_indentation_node: {},
     mediaGroup_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['mediaGroup'],
+        },
+      },
     },
     decisionItem_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['decisionItem'],
+        },
+      },
     },
     decisionList_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['decisionList'],
+        },
+      },
     },
     rule_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['rule'],
+        },
+      },
     },
     panel_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['panel'],
+        },
+      },
     },
     blockquote_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['blockquote'],
+        },
+      },
     },
     extension_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['extension'],
+        },
+        marks: {
+          type: 'array',
+        },
+      },
     },
     extension_with_marks_node: {},
     embedCard_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['embedCard'],
+        },
+      },
     },
     nestedExpand_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['nestedExpand'],
+        },
+      },
     },
     nestedExpand_with_no_marks_node: {},
     table_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['table'],
+        },
+        marks: {
+          type: 'array',
+        },
+      },
     },
     table_row_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['tableRow'],
+        },
+      },
     },
     table_cell_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['tableCell'],
+        },
+      },
     },
     table_header_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['tableHeader'],
+        },
+      },
     },
     expand_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['expand'],
+        },
+      },
     },
     expand_with_no_mark_node: {},
     expand_with_breakout_mark_node: {},
     bodiedExtension_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['bodiedExtension'],
+        },
+      },
     },
     bodiedExtension_with_marks_node: {},
     layoutColumn_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['layoutColumn'],
+        },
+      },
     },
     layoutSection_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['layoutSection'],
+        },
+        marks: {
+          type: 'array',
+        },
+      },
     },
     layoutSection_full_node: {},
     doc_node: {
       type: 'object',
+      properties: {
+        type: {
+          enum: ['doc'],
+        },
+      },
     },
   },
 };