@atlaskit/adf-schema 36.10.12 → 36.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.10.12",
+  "version": "36.11.0",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -29,7 +29,7 @@
     "build:jsontypes": "mkdir -p dist/types/json-schema && cp src/json-schema/index.ts dist/types/json-schema/index.d.ts",
     "build:all": "yarn build:cjs && yarn build:esm && yarn build:es2019 && yarn build:types",
     "build": "yarn clean:build && yarn workspace @atlaskit/editor-prosemirror build && yarn workspace @atlaskit/adf-schema-generator build && yarn run build:all && yarn run generate:json-schema && yarn run build:json-schema",
-    "build:pm:full": "yarn ts-node ./schema-generators/pm-full-schema.ts && prettier --write '../adf-schema-generator/src/generated/**/*.ts'",
+    "build:pm:full": "yarn ts-node ./schema-generators/pm-full-schema.ts && prettier --write './src/next-schema/generated/**/*.ts'",
     "build:json:full": "yarn ts-node ./schema-generators/json-full-schema.ts",
     "clean": "../../scripts/build-clean.sh",
     "link:afe": "yarn build:all && node ./copy-dist-to-afe.js"
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.15.0",
-    "@atlaskit/adf-schema-generator": "^1.8.6",
+    "@atlaskit/adf-schema-generator": "^1.10.0",
     "@babel/cli": "^7.22.9",
     "@babel/core": "^7.22.9",
     "@babel/plugin-proposal-class-properties": "^7.18.6",

package/schema-generators/__tests__/unit/adfToValidatorSpec.unit.ts

@@ -0,0 +1,69 @@
+import { adfToValidatorSpec } from '@atlaskit/adf-schema-generator';
+import adfNode from '@atlaskit/adf-schema/src/next-schema/full-schema.adf';
+
+test('should transform adfNode to validator spec', () => {
+  const result = adfToValidatorSpec(adfNode);
+
+  expect(result.heading_with_alignment.json.props).toEqual(
+    heading_with_alignment.props,
+  );
+});
+
+test('should be able to handle weird attrs', () => {
+  const result = adfToValidatorSpec(adfNode);
+
+  expect(result.mention.json.props.attrs).toEqual(mention);
+});
+
+const heading_with_alignment = {
+  props: {
+    attrs: {
+      level: {
+        default: 1,
+        maximum: 6,
+        minimum: 1,
+        type: 'number',
+      },
+    },
+    content: {
+      items: ['inline'],
+      minItems: 0,
+      type: 'array',
+    },
+    marks: {
+      items: [
+        'link',
+        'em',
+        'strong',
+        'strike',
+        'subsup',
+        'underline',
+        'textColor',
+        'annotation',
+        'backgroundColor',
+        'code',
+        'border',
+      ],
+      type: 'array',
+    },
+    type: {
+      type: 'enum',
+      values: ['heading'],
+    },
+  },
+};
+
+const mention = {
+  attrs: {
+    id: { type: 'string', default: '' },
+    localId: { type: 'string', optional: true },
+    text: { type: 'string', default: '', optional: true },
+    accessLevel: { type: 'string', default: '', optional: true },
+    userType: {
+      type: 'enum',
+      values: ['DEFAULT', 'SPECIAL', 'APP'],
+      default: null,
+      optional: true,
+    },
+  },
+};

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

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

@@ -702,7 +702,37 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            anyOf: [
+              {
+                $ref: '#/definitions/hardBreak_node',
+              },
+              {
+                $ref: '#/definitions/mention_node',
+              },
+              {
+                $ref: '#/definitions/emoji_node',
+              },
+              {
+                $ref: '#/definitions/date_node',
+              },
+              {
+                $ref: '#/definitions/placeholder_node',
+              },
+              {
+                $ref: '#/definitions/inlineCard_node',
+              },
+              {
+                $ref: '#/definitions/status_node',
+              },
+              {
+                $ref: '#/definitions/formatted_text_inline_node',
+              },
+              {
+                $ref: '#/definitions/code_inline_node',
+              },
+            ],
+          },
           minItems: 0,
         },
       },
@@ -1062,7 +1092,46 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            anyOf: [
+              {
+                $ref: '#/definitions/codeBlock_with_no_marks_node',
+              },
+              {
+                $ref: '#/definitions/blockCard_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',
+              },
+              {
+                $ref: '#/definitions/heading_with_no_marks_node',
+              },
+              {
+                $ref: '#/definitions/mediaGroup_node',
+              },
+              {
+                $ref: '#/definitions/decisionList_node',
+              },
+              {
+                $ref: '#/definitions/rule_node',
+              },
+            ],
+          },
           minItems: 1,
         },
       },
@@ -1075,7 +1144,19 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            anyOf: [
+              {
+                $ref: '#/definitions/paragraph_with_no_marks_node',
+              },
+              {
+                $ref: '#/definitions/bulletList_node',
+              },
+              {
+                $ref: '#/definitions/orderedList_node',
+              },
+            ],
+          },
           minItems: 1,
         },
       },
@@ -1228,7 +1309,16 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            anyOf: [
+              {
+                $ref: '#/definitions/table_cell_node',
+              },
+              {
+                $ref: '#/definitions/table_header_node',
+              },
+            ],
+          },
         },
       },
     },
@@ -1416,7 +1506,88 @@ const jsonWithTypes = {
         },
         content: {
           type: 'array',
-          items: {},
+          items: {
+            anyOf: [
+              {
+                $ref: '#/definitions/codeBlock_with_no_marks_node',
+              },
+              {
+                $ref: '#/definitions/codeBlock_with_marks_node',
+              },
+              {
+                $ref: '#/definitions/blockCard_node',
+              },
+              {
+                $ref: '#/definitions/paragraph_with_no_marks_node',
+              },
+              {
+                $ref: '#/definitions/paragraph_with_alignment_node',
+              },
+              {
+                $ref: '#/definitions/paragraph_with_indentation_node',
+              },
+              {
+                $ref: '#/definitions/mediaSingle_caption_node',
+              },
+              {
+                $ref: '#/definitions/mediaSingle_full_node',
+              },
+              {
+                $ref: '#/definitions/taskList_node',
+              },
+              {
+                $ref: '#/definitions/bulletList_node',
+              },
+              {
+                $ref: '#/definitions/orderedList_node',
+              },
+              {
+                $ref: '#/definitions/heading_with_no_marks_node',
+              },
+              {
+                $ref: '#/definitions/heading_with_alignment_node',
+              },
+              {
+                $ref: '#/definitions/heading_with_indentation_node',
+              },
+              {
+                $ref: '#/definitions/mediaGroup_node',
+              },
+              {
+                $ref: '#/definitions/decisionList_node',
+              },
+              {
+                $ref: '#/definitions/rule_node',
+              },
+              {
+                $ref: '#/definitions/panel_node',
+              },
+              {
+                $ref: '#/definitions/blockquote_node',
+              },
+              {
+                $ref: '#/definitions/extension_with_marks_node',
+              },
+              {
+                $ref: '#/definitions/embedCard_node',
+              },
+              {
+                $ref: '#/definitions/table_node',
+              },
+              {
+                $ref: '#/definitions/expand_with_no_mark_node',
+              },
+              {
+                $ref: '#/definitions/expand_with_breakout_mark_node',
+              },
+              {
+                $ref: '#/definitions/bodiedExtension_with_marks_node',
+              },
+              {
+                $ref: '#/definitions/layoutSection_full_node',
+              },
+            ],
+          },
         },
       },
     },
@@ -1426,18 +1597,312 @@ const jsonWithTypes = {
 // New JSON, different to the old JSON schema
 jsonWithTypes.definitions.nestedExpand_node.properties.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',
+      },
+      {
+        $ref: '#/definitions/taskList_node',
+      },
+      {
+        $ref: '#/definitions/bulletList_node',
+      },
+      {
+        $ref: '#/definitions/orderedList_node',
+      },
+      {
+        $ref: '#/definitions/heading_with_no_marks_node',
+      },
+      {
+        $ref: '#/definitions/mediaGroup_node',
+      },
+      {
+        $ref: '#/definitions/decisionList_node',
+      },
+      {
+        $ref: '#/definitions/rule_node',
+      },
+      {
+        $ref: '#/definitions/panel_node',
+      },
+      {
+        $ref: '#/definitions/blockquote_node',
+      },
+    ],
+  },
   minItems: 1,
 };
-jsonWithTypes.definitions.expand_node.properties.content.items = {};
-jsonWithTypes.definitions.bodiedExtension_node.properties.content.items = {};
+jsonWithTypes.definitions.expand_node.properties.content.items = {
+  anyOf: [
+    {
+      $ref: '#/definitions/codeBlock_with_no_marks_node',
+    },
+    {
+      $ref: '#/definitions/blockCard_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',
+    },
+    {
+      $ref: '#/definitions/heading_with_no_marks_node',
+    },
+    {
+      $ref: '#/definitions/mediaGroup_node',
+    },
+    {
+      $ref: '#/definitions/decisionList_node',
+    },
+    {
+      $ref: '#/definitions/rule_node',
+    },
+    {
+      $ref: '#/definitions/panel_node',
+    },
+    {
+      $ref: '#/definitions/blockquote_node',
+    },
+    {
+      $ref: '#/definitions/extension_with_marks_node',
+    },
+    {
+      $ref: '#/definitions/embedCard_node',
+    },
+    {
+      $ref: '#/definitions/table_node',
+    },
+  ],
+};
+jsonWithTypes.definitions.bodiedExtension_node.properties.content.items = {
+  anyOf: [
+    {
+      $ref: '#/definitions/codeBlock_with_no_marks_node',
+    },
+    {
+      $ref: '#/definitions/blockCard_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',
+    },
+    {
+      $ref: '#/definitions/heading_with_no_marks_node',
+    },
+    {
+      $ref: '#/definitions/mediaGroup_node',
+    },
+    {
+      $ref: '#/definitions/decisionList_node',
+    },
+    {
+      $ref: '#/definitions/rule_node',
+    },
+    {
+      $ref: '#/definitions/panel_node',
+    },
+    {
+      $ref: '#/definitions/blockquote_node',
+    },
+    {
+      $ref: '#/definitions/extension_with_marks_node',
+    },
+    {
+      $ref: '#/definitions/embedCard_node',
+    },
+    {
+      $ref: '#/definitions/table_node',
+    },
+  ],
+};
 jsonWithTypes.definitions.table_cell_node.properties.content = {
   type: 'array',
-  items: {},
+  items: {
+    anyOf: [
+      {
+        $ref: '#/definitions/codeBlock_with_no_marks_node',
+      },
+      {
+        $ref: '#/definitions/blockCard_node',
+      },
+      {
+        $ref: '#/definitions/paragraph_with_no_marks_node',
+      },
+      {
+        $ref: '#/definitions/paragraph_with_alignment_node',
+      },
+      {
+        $ref: '#/definitions/mediaSingle_caption_node',
+      },
+      {
+        $ref: '#/definitions/mediaSingle_full_node',
+      },
+      {
+        $ref: '#/definitions/taskList_node',
+      },
+      {
+        $ref: '#/definitions/bulletList_node',
+      },
+      {
+        $ref: '#/definitions/orderedList_node',
+      },
+      {
+        $ref: '#/definitions/heading_with_no_marks_node',
+      },
+      {
+        $ref: '#/definitions/heading_with_alignment_node',
+      },
+      {
+        $ref: '#/definitions/heading_with_indentation_node',
+      },
+      {
+        $ref: '#/definitions/mediaGroup_node',
+      },
+      {
+        $ref: '#/definitions/decisionList_node',
+      },
+      {
+        $ref: '#/definitions/rule_node',
+      },
+      {
+        $ref: '#/definitions/panel_node',
+      },
+      {
+        $ref: '#/definitions/blockquote_node',
+      },
+      {
+        $ref: '#/definitions/extension_with_marks_node',
+      },
+      {
+        $ref: '#/definitions/embedCard_node',
+      },
+      {
+        $ref: '#/definitions/nestedExpand_with_no_marks_node',
+      },
+    ],
+  },
   minItems: 1,
 };
 jsonWithTypes.definitions.table_header_node.properties.content = {
   type: 'array',
-  items: {},
+  items: {
+    anyOf: [
+      {
+        $ref: '#/definitions/codeBlock_with_no_marks_node',
+      },
+      {
+        $ref: '#/definitions/blockCard_node',
+      },
+      {
+        $ref: '#/definitions/paragraph_with_no_marks_node',
+      },
+      {
+        $ref: '#/definitions/paragraph_with_alignment_node',
+      },
+      {
+        $ref: '#/definitions/mediaSingle_caption_node',
+      },
+      {
+        $ref: '#/definitions/mediaSingle_full_node',
+      },
+      {
+        $ref: '#/definitions/taskList_node',
+      },
+      {
+        $ref: '#/definitions/bulletList_node',
+      },
+      {
+        $ref: '#/definitions/orderedList_node',
+      },
+      {
+        $ref: '#/definitions/heading_with_no_marks_node',
+      },
+      {
+        $ref: '#/definitions/heading_with_alignment_node',
+      },
+      {
+        $ref: '#/definitions/heading_with_indentation_node',
+      },
+      {
+        $ref: '#/definitions/mediaGroup_node',
+      },
+      {
+        $ref: '#/definitions/decisionList_node',
+      },
+      {
+        $ref: '#/definitions/rule_node',
+      },
+      {
+        $ref: '#/definitions/panel_node',
+      },
+      {
+        $ref: '#/definitions/blockquote_node',
+      },
+      {
+        $ref: '#/definitions/extension_with_marks_node',
+      },
+      {
+        $ref: '#/definitions/embedCard_node',
+      },
+      {
+        $ref: '#/definitions/nestedExpand_with_no_marks_node',
+      },
+    ],
+  },
   minItems: 1,
 };
+jsonWithTypes.definitions.doc_node.properties.content.items.anyOf = [
+  {
+    $ref: '#/definitions/block_content',
+  },
+  {
+    $ref: '#/definitions/layoutSection_node',
+  },
+  {
+    $ref: '#/definitions/layoutSection_full_node',
+  },
+  {
+    $ref: '#/definitions/nestedExpand_node',
+  },
+  // There was no where else to put paragraph, so I'm parking it here for now
+  {
+    $ref: '#/definitions/paragraph_node',
+  },
+];

package/schema-generators/__tests__/unit/validate-pm-schema.unit.ts

@@ -1,6 +1,6 @@
 import { MarkSpec, NodeSpec, Schema } from '@atlaskit/editor-prosemirror/model';
-import * as newMarkSpecs from '@atlaskit/adf-schema-generator/src/generated/markTypes';
-import * as newNodeSpecs from '@atlaskit/adf-schema-generator/src/generated/nodeTypes';
+import * as newMarkSpecs from '@atlaskit/adf-schema/src/next-schema/generated/markTypes';
+import * as newNodeSpecs from '@atlaskit/adf-schema/src/next-schema/generated/nodeTypes';
 import {
   MarkSpecFactory,
   NodeSpecFactory,