@atlaskit/adf-schema 36.15.0 → 36.17.0

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

@@ -0,0 +1,22 @@
+export declare const confluenceJiraIssue: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
+    ignore?: import("@atlaskit/adf-schema-generator/dist/types/transforms/transformerNames").TransformerNames[];
+    root?: boolean;
+    atom?: boolean;
+    version?: 1;
+    attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
+    inline?: true;
+    code?: boolean;
+    content?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentSpec[];
+    defining?: boolean;
+    definingAsContext?: boolean;
+    definingForContent?: boolean;
+    draggable?: boolean;
+    group?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeGroup").ADFNodeGroup;
+    isolating?: boolean;
+    marks?: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<unknown>[];
+    allowAnyChildMark?: boolean;
+    allowNoChildMark?: boolean;
+    selectable?: boolean;
+    whitespace?: "pre" | "normal";
+    tableRole?: "table" | "row" | "cell" | "header_cell";
+}>;

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

@@ -0,0 +1,22 @@
+export declare const image: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
+    ignore?: import("@atlaskit/adf-schema-generator/dist/types/transforms/transformerNames").TransformerNames[];
+    root?: boolean;
+    atom?: boolean;
+    version?: 1;
+    attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
+    inline?: true;
+    code?: boolean;
+    content?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentSpec[];
+    defining?: boolean;
+    definingAsContext?: boolean;
+    definingForContent?: boolean;
+    draggable?: boolean;
+    group?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeGroup").ADFNodeGroup;
+    isolating?: boolean;
+    marks?: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<unknown>[];
+    allowAnyChildMark?: boolean;
+    allowNoChildMark?: boolean;
+    selectable?: boolean;
+    whitespace?: "pre" | "normal";
+    tableRole?: "table" | "row" | "cell" | "header_cell";
+}>;

package/dist/types/schema/create-schema.d.ts

@@ -1,4 +1,8 @@
 import { NodeSpec, MarkSpec, Schema } from '@atlaskit/editor-prosemirror/model';
+export declare function getNodesAndMarksMap(): {
+    nodes: Record<string, NodeSpec>;
+    marks: Record<string, MarkSpec>;
+};
 /**
  * Creates a schema preserving order of marks and nodes.
  */

package/package.json

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

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

@@ -144,7 +144,9 @@ const jsonWithTypes = {
             {
               additionalProperties: false,
               properties: {
-                data: {},
+                data: {
+                  type: 'object',
+                },
               },
               required: ['data'],
               type: 'object',
@@ -186,6 +188,103 @@ const jsonWithTypes = {
       type: 'object',
     },
     blockquote_with_list_node: {},
+    bodiedExtension_node: {
+      additionalProperties: false,
+      properties: {
+        attrs: {
+          additionalProperties: false,
+          properties: {
+            extensionKey: {
+              minLength: 1,
+              type: 'string',
+            },
+            extensionType: {
+              minLength: 1,
+              type: 'string',
+            },
+            layout: {
+              enum: ['wide', 'full-width', 'default'],
+            },
+            localId: {
+              minLength: 1,
+              type: 'string',
+            },
+            parameters: {
+              type: 'object',
+            },
+            text: {
+              type: 'string',
+            },
+          },
+          required: ['extensionKey', 'extensionType'],
+          type: 'object',
+        },
+        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',
+              },
+            ],
+          },
+          minItems: 1,
+          type: 'array',
+        },
+        type: {
+          enum: ['bodiedExtension'],
+        },
+      },
+      required: ['type', 'attrs', 'content'],
+      type: 'object',
+    },
     bodiedExtension_with_marks_node: {},
     border_mark: {
       additionalProperties: false,
@@ -295,7 +394,32 @@ const jsonWithTypes = {
       required: ['type', 'content'],
       type: 'object',
     },
-    codeBlock_with_marks_node: {},
+    codeBlock_node: {
+      additionalProperties: false,
+      properties: {
+        attrs: {
+          additionalProperties: false,
+          properties: {
+            language: {
+              type: 'string',
+            },
+            uniqueId: {
+              type: 'string',
+            },
+          },
+          type: 'object',
+        },
+        content: {
+          items: {},
+          type: 'array',
+        },
+        type: {
+          enum: ['codeBlock'],
+        },
+      },
+      required: ['type'],
+      type: 'object',
+    },
     codeBlock_with_no_marks_node: {},
     code_inline_node: {},
     code_mark: {
@@ -422,19 +546,7 @@ const jsonWithTypes = {
                 $ref: '#/definitions/layoutSection_node',
               },
               {
-                $ref: '#/definitions/layoutSection_full_node',
-              },
-              {
-                $ref: '#/definitions/expand_with_breakout_mark_node',
-              },
-              {
-                $ref: '#/definitions/codeBlock_with_no_marks_node',
-              },
-              {
-                $ref: '#/definitions/codeBlock_with_marks_node',
-              },
-              {
-                $ref: '#/definitions/paragraph_with_indentation_node',
+                $ref: '#/definitions/blockRootOnly_node',
               },
             ],
           },
@@ -528,8 +640,132 @@ const jsonWithTypes = {
       required: ['type', 'attrs'],
       type: 'object',
     },
-    expand_with_breakout_mark_node: {},
     expand_with_no_mark_node: {},
+    extensionFrame_node: {
+      additionalProperties: false,
+      properties: {
+        attrs: {
+          additionalProperties: false,
+          properties: {},
+          type: 'object',
+        },
+        content: {
+          items: {
+            anyOf: [
+              {
+                $ref: '#/definitions/bodiedExtension_node',
+              },
+              {
+                $ref: '#/definitions/panel_node',
+              },
+              {
+                $ref: '#/definitions/paragraph_node',
+              },
+              {
+                $ref: '#/definitions/blockquote_node',
+              },
+              {
+                $ref: '#/definitions/orderedList_node',
+              },
+              {
+                $ref: '#/definitions/bulletList_node',
+              },
+              {
+                $ref: '#/definitions/rule_node',
+              },
+              {
+                $ref: '#/definitions/heading_node',
+              },
+              {
+                $ref: '#/definitions/codeBlock_node',
+              },
+              {
+                $ref: '#/definitions/mediaGroup_node',
+              },
+              {
+                $ref: '#/definitions/mediaSingle_node',
+              },
+              {
+                $ref: '#/definitions/decisionList_node',
+              },
+              {
+                $ref: '#/definitions/taskList_node',
+              },
+              {
+                $ref: '#/definitions/table_node',
+              },
+              {
+                $ref: '#/definitions/extension_node',
+              },
+              {
+                $ref: '#/definitions/blockCard_node',
+              },
+              {
+                $ref: '#/definitions/embedCard_node',
+              },
+            ],
+          },
+          minItems: 1,
+          type: 'array',
+        },
+        marks: {
+          items: {
+            anyOf: [
+              {
+                $ref: '#/definitions/dataConsumer_mark',
+              },
+              {
+                $ref: '#/definitions/fragment_mark',
+              },
+            ],
+          },
+          type: 'array',
+        },
+        type: {
+          enum: ['extensionFrame'],
+        },
+      },
+      required: ['type', 'content'],
+      type: 'object',
+    },
+    extension_node: {
+      additionalProperties: false,
+      properties: {
+        attrs: {
+          additionalProperties: false,
+          properties: {
+            extensionKey: {
+              minLength: 1,
+              type: 'string',
+            },
+            extensionType: {
+              minLength: 1,
+              type: 'string',
+            },
+            layout: {
+              enum: ['wide', 'full-width', 'default'],
+            },
+            localId: {
+              minLength: 1,
+              type: 'string',
+            },
+            parameters: {
+              type: 'object',
+            },
+            text: {
+              type: 'string',
+            },
+          },
+          required: ['extensionKey', 'extensionType'],
+          type: 'object',
+        },
+        type: {
+          enum: ['extension'],
+        },
+      },
+      required: ['type', 'attrs'],
+      type: 'object',
+    },
     extension_with_marks_node: {},
     formatted_text_inline_node: {},
     fragment_mark: {
@@ -646,7 +882,9 @@ const jsonWithTypes = {
             {
               additionalProperties: false,
               properties: {
-                data: {},
+                data: {
+                  type: 'object',
+                },
               },
               required: ['data'],
               type: 'object',
@@ -690,7 +928,6 @@ const jsonWithTypes = {
       required: ['type', 'attrs', 'content'],
       type: 'object',
     },
-    layoutSection_full_node: {},
     layoutSection_node: {
       additionalProperties: false,
       properties: {
@@ -805,6 +1042,11 @@ const jsonWithTypes = {
     mediaGroup_node: {
       additionalProperties: false,
       properties: {
+        attrs: {
+          additionalProperties: false,
+          properties: {},
+          type: 'object',
+        },
         content: {
           items: {
             $ref: '#/definitions/media_node',
@@ -831,7 +1073,6 @@ const jsonWithTypes = {
             collection: {
               type: 'string',
             },
-            data: {},
             height: {
               type: 'number',
             },
@@ -1073,6 +1314,48 @@ const jsonWithTypes = {
       required: ['type', 'attrs'],
       type: 'object',
     },
+    multiBodiedExtension_node: {
+      additionalProperties: false,
+      properties: {
+        attrs: {
+          additionalProperties: false,
+          properties: {
+            extensionKey: {
+              type: 'string',
+            },
+            extensionType: {
+              type: 'string',
+            },
+            layout: {
+              enum: ['default', 'wide', 'full-width'],
+            },
+            localId: {
+              type: 'string',
+            },
+            parameters: {
+              type: 'object',
+            },
+            text: {
+              type: 'string',
+            },
+          },
+          required: ['extensionKey', 'extensionType'],
+          type: 'object',
+        },
+        content: {
+          items: {
+            $ref: '#/definitions/extensionFrame_node',
+          },
+          minItems: 1,
+          type: 'array',
+        },
+        type: {
+          enum: ['multiBodiedExtension'],
+        },
+      },
+      required: ['type', 'attrs', 'content'],
+      type: 'object',
+    },
     nestedExpand_with_no_marks_node: {},
     orderedList_node: {
       additionalProperties: false,
@@ -1202,7 +1485,7 @@ const jsonWithTypes = {
       type: 'object',
     },
     paragraph_with_alignment_node: {},
-    paragraph_with_indentation_node: {},
+    paragraph_with_marks_node: {},
     paragraph_with_no_marks_node: {},
     placeholder_node: {
       additionalProperties: false,

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

@@ -1,14 +1,16 @@
-import { MarkSpec, NodeSpec, Schema } from '@atlaskit/editor-prosemirror/model';
+import { MarkSpec, NodeSpec } from '@atlaskit/editor-prosemirror/model';
 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,
 } from '@atlaskit/adf-schema-generator/src/transforms/adfToPm/createPMSpecFactory';
-import { defaultSchema } from '../../../src/schema/default-schema';
+import { getNodesAndMarksMap } from '../../../src/schema/create-schema';
 import { printExpected, printReceived, matcherHint } from 'jest-matcher-utils';
 import { filterAndSortMarks, formatContent } from '../helpers/_utils';
 
+const defaultSchema = getNodesAndMarksMap();
+
 /**
  * TODO: The EXCLUDE and SKIPPED consts are defined to pass the test
  * Once following ticket is done, will need to remove exclude and unskip tests.
@@ -29,28 +31,9 @@ const SKIPPED_MARKSPEC_TESTS = [
   'typeAheadQuery', // not exist in ADF DSL
 ];
 const SKIPPED_NODESPEC_TESTS = [
-  'doc', // defined in ADF DSL, but not matching old spec
-  'unknownBlock', // not exist in new ADF DSL
-  'confluenceUnsupportedBlock', // not exist in new ADF DSL
-  'confluenceUnsupportedInline', // not exist in new ADF DSL
-  'confluenceJiraIssue', // not exist in new ADF DSL
-  'expand', // in ADF DSL, only expand.use('with_no_marks') is in use. Old spec have marks with 'dataConsumer, fragment'
-  'status', // has uuid localId in old spec
-  'nestedExpandWithNoMarks', // old nodeSpec have blockCard, but not in type NestedExpandContent, new DSL doesn't have blockCard as to match NestedExpandContent.
-  'hardBreak', // not aligned with old spec due to attr.text
-  'mediaInline', // not aligned with old spec due to attr.data
-  'image', // not exist in new ADF DSL
-  'mediaSingleFull', // not aligned with old spec - content is different
-  'table', // displayMode is default in new ADF DSL, but having null in old spec
-  'codeBlockWithNoMarks', // codeBlock doesn't have uniqueID in new ADF DSL, but have it in old spec.
-  'bodiedExtensionWithMarks', // old spec defaults to use bodiedExtension_with_marks_node, new DSL
-  'paragraph', // new ADF DSL have unsupporedInline, but not in old nodeSpec
-  'decisionItem', // new ADF DSL have unsupporedInline, but not in old nodeSpec
-  'taskItem', // new ADF DSL have unsupporedInline, but not in old nodeSpec
-  'heading', // new ADF DSL have unsupporedInline, but not in old nodeSpec
-  'blockquoteWithList', // new ADF DSL have unsupportedMark unsupportedNodeAttribute, but not in old nodeSpec
-  'layoutSection', // new ADF DSL doesn't have unsupportedBlock*|unsupportedBlock+ in content
-  'mediaGroup', // old spec have attrs: {}, but not in new ADF DSL.
+  'unknownBlock', // unused node
+  'mediaSingleFull', // not aligned with old spec - content is different, another case similar to layoutSection
+  'layoutSection', // new ADF DSL doesn't have unsupportedBlock*|unsupportedBlock+ in content, it's not supported in DSL and doesn't make much sense, might have to hard code this one
 ];
 
 /**
@@ -70,6 +53,9 @@ const defaultSchemaNodeSpecMap = () => {
     mediaSingle: 'mediaSingleFull',
     nestedExpand: 'nestedExpandWithNoMarks',
     codeBlock: 'codeBlockWithNoMarks',
+    heading: 'headingWithNoMarks',
+    // Base variant is not used anywhere
+    expand: 'expandWithNoMark',
   };
 };
 
@@ -111,6 +97,11 @@ expect.extend({
       }),
     };
 
+    // TODO: why
+    if (formattedExpected?.attrs?.localId?.default) {
+      formattedExpected.attrs.localId.default = '';
+    }
+
     const pass = this.equals(formattedActual, formattedExpected);
     return {
       pass,
@@ -119,11 +110,11 @@ expect.extend({
   },
 });
 
-function isMarkSpec(value: MarkSpec | NodeSpec): value is MarkSpec {
+function isMarkSpec(_value: MarkSpec | NodeSpec): _value is MarkSpec {
   return true;
 }
 
-function isNodeSpec(value: MarkSpec | NodeSpec): value is NodeSpec {
+function isNodeSpec(_value: MarkSpec | NodeSpec): _value is NodeSpec {
   return true;
 }
 
@@ -159,13 +150,13 @@ function omit<T extends object>(data: T, keys = []): T {
 
 describe('validate PM schema', () => {
   describe('marks', () => {
-    const { marks } = defaultSchema as Schema;
+    const { marks } = defaultSchema;
     const skipLists = SKIPPED_MARKSPEC_TESTS;
 
     const testCases = Object.entries(marks).map(([key, value]) => {
       return {
         name: key,
-        legacyMarkSpec: value.spec,
+        legacyMarkSpec: value,
         newMarkSpecFn: newMarkSpecs[key] as MarkSpecFactory,
         skip: skipLists.includes(key) || key.startsWith('__'),
       };
@@ -190,13 +181,13 @@ describe('validate PM schema', () => {
   });
 
   describe('nodes', () => {
-    const { nodes } = defaultSchema as Schema;
+    const { nodes } = defaultSchema;
     const skipLists = SKIPPED_NODESPEC_TESTS;
     const testCases = Object.entries(nodes).map(([key, value]) => {
       const specName = getDefaultSpecName(key);
       return {
         name: specName,
-        legacyNodeSpec: value.spec,
+        legacyNodeSpec: value,
         newNodeSpecFn: newNodeSpecs[specName] as NodeSpecFactory,
         testingMethod: {
           skip: skipLists.includes(specName),