@atlaskit/adf-schema 36.8.2 → 36.8.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/adf-schema
 
+## 36.8.4
+
+### Patch Changes
+
+- 9323c96: Add mark items
+
+## 36.8.3
+
+### Patch Changes
+
+- 3d6a62a: Add properties, marks, and mark array type
+
 ## 36.8.2
 
 ### Patch Changes

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

@@ -10,7 +10,6 @@ var _fragment = require("../marks/fragment");
 var extension = exports.extension = (0, _adfSchemaGenerator.adfNode)('extension').define({
   atom: true,
   selectable: true,
-  marks: [_dataConsumer.dataConsumer, _fragment.fragment],
   attrs: {
     extensionType: {
       type: 'string',
@@ -42,4 +41,6 @@ var extension = exports.extension = (0, _adfSchemaGenerator.adfNode)('extension'
       default: null
     }
   }
-}).variant('with_marks', {});
+}).variant('with_marks', {
+  marks: [_dataConsumer.dataConsumer, _fragment.fragment]
+});

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

@@ -9,7 +9,6 @@ var _inlineGroup = require("../groups/inlineGroup");
 var _alignmentAndIndentation = require("../marks/alignmentAndIndentation");
 var paragraph = exports.paragraph = (0, _adfSchemaGenerator.adfNode)('paragraph').define({
   selectable: false,
-  marks: [_alignmentAndIndentation.alignment],
   content: [(0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_inlineGroup.inlineGroup))]
 }).variant('with_alignment', {
   marks: [_alignmentAndIndentation.alignment]

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

@@ -4,7 +4,6 @@ import { fragment } from '../marks/fragment';
 export const extension = adfNode('extension').define({
   atom: true,
   selectable: true,
-  marks: [dataConsumer, fragment],
   attrs: {
     extensionType: {
       type: 'string',
@@ -36,4 +35,6 @@ export const extension = adfNode('extension').define({
       default: null
     }
   }
-}).variant('with_marks', {});
+}).variant('with_marks', {
+  marks: [dataConsumer, fragment]
+});

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

@@ -3,7 +3,6 @@ import { inlineGroup } from '../groups/inlineGroup';
 import { alignment, indentation } from '../marks/alignmentAndIndentation';
 export const paragraph = adfNode('paragraph').define({
   selectable: false,
-  marks: [alignment],
   content: [$zeroPlus($or(inlineGroup))]
 }).variant('with_alignment', {
   marks: [alignment]

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

@@ -4,7 +4,6 @@ import { fragment } from '../marks/fragment';
 export var extension = adfNode('extension').define({
   atom: true,
   selectable: true,
-  marks: [dataConsumer, fragment],
   attrs: {
     extensionType: {
       type: 'string',
@@ -36,4 +35,6 @@ export var extension = adfNode('extension').define({
       default: null
     }
   }
-}).variant('with_marks', {});
+}).variant('with_marks', {
+  marks: [dataConsumer, fragment]
+});

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

@@ -3,7 +3,6 @@ import { inlineGroup } from '../groups/inlineGroup';
 import { alignment, indentation } from '../marks/alignmentAndIndentation';
 export var paragraph = adfNode('paragraph').define({
   selectable: false,
-  marks: [alignment],
   content: [$zeroPlus($or(inlineGroup))]
 }).variant('with_alignment', {
   marks: [alignment]

package/dist/types/next-schema/groups/nonNestableBlockContentGroup.d.ts

@@ -51,7 +51,7 @@ export declare const nonNestableBlockContent: (import("@atlaskit/adf-schema-gene
 } & {
     atom: false;
     content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentOrSpec[];
-}> | import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_marks"], {
+}> | import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_alignment", "with_indentation", "with_marks", "with_no_marks"], {
     root?: boolean;
     atom?: boolean;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
@@ -67,7 +67,13 @@ export declare const nonNestableBlockContent: (import("@atlaskit/adf-schema-gene
     marks?: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<unknown>[];
     selectable?: boolean;
     whitespace?: "pre" | "normal";
-}> | import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_alignment", "with_indentation", "with_marks", "with_no_marks"], {
+} & {
+    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
+} & {
+    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
+} & {
+    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
+}> | import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_list"], {
     root?: boolean;
     atom?: boolean;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
@@ -84,12 +90,8 @@ export declare const nonNestableBlockContent: (import("@atlaskit/adf-schema-gene
     selectable?: boolean;
     whitespace?: "pre" | "normal";
 } & {
-    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
-} & {
-    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
-} & {
-    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
-}> | import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_list"], {
+    content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentOneOrMoreSpec[];
+}> | import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_marks"], {
     root?: boolean;
     atom?: boolean;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
@@ -106,7 +108,7 @@ export declare const nonNestableBlockContent: (import("@atlaskit/adf-schema-gene
     selectable?: boolean;
     whitespace?: "pre" | "normal";
 } & {
-    content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentOneOrMoreSpec[];
+    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
 }> | import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_alignment", "with_indentation", "with_no_marks"], {
     root?: boolean;
     atom?: boolean;

package/dist/types/next-schema/nodes/extension.d.ts

@@ -14,4 +14,6 @@ export declare const extension: import("@atlaskit/adf-schema-generator/dist/type
     marks?: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<unknown>[];
     selectable?: boolean;
     whitespace?: "pre" | "normal";
+} & {
+    marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
 }>;

package/package.json

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

@@ -25,3 +25,31 @@ Delete all subfields except for type and properties. Content objects are also de
 ```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)'
+```
+
+Delete all subfields except for marks, items, 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, .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, .extension_node.properties.marks, .paragraph_node.properties.marks) else . end)'
+```

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

@@ -4,7 +4,6 @@ import adfNode from '@atlaskit/adf-schema/src/next-schema/full-schema.adf';
 test('It should match the existing schema', () => {
   const result = adfToJSON(adfNode);
 
-  // TODO Compare this to the real ADF Schema as it becomes ready
   expect(result).toEqual(jsonWithTypes);
 });
 
@@ -238,6 +237,10 @@ const jsonWithTypes = {
         type: {
           enum: ['media'],
         },
+        marks: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     mediaInline_node: {
@@ -246,6 +249,10 @@ const jsonWithTypes = {
         type: {
           enum: ['mediaInline'],
         },
+        marks: {
+          type: 'array',
+          items: {},
+        },
       },
     },
     formatted_text_inline_node: {},
@@ -275,6 +282,12 @@ const jsonWithTypes = {
         type: {
           enum: ['mediaSingle'],
         },
+        marks: {
+          type: 'array',
+          items: {
+            $ref: '#/definitions/link_mark',
+          },
+        },
       },
     },
     mediaSingle_caption_node: {},
@@ -410,6 +423,12 @@ const jsonWithTypes = {
         type: {
           enum: ['table'],
         },
+        marks: {
+          type: 'array',
+          items: {
+            $ref: '#/definitions/fragment_mark',
+          },
+        },
       },
     },
     table_row_node: {
@@ -469,6 +488,12 @@ const jsonWithTypes = {
         type: {
           enum: ['layoutSection'],
         },
+        marks: {
+          type: 'array',
+          items: {
+            $ref: '#/definitions/breakout_mark',
+          },
+        },
       },
     },
     layoutSection_full_node: {},