@atlaskit/adf-schema 37.0.2 → 37.1.19

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

@@ -8,52 +8,149 @@ import {
 import { getNodesAndMarksMap } from '../../../src/schema/create-schema';
 import { printExpected, printReceived, matcherHint } from 'jest-matcher-utils';
 import { filterAndSortMarks, formatContent } from '../helpers/_utils';
+import {
+  blockCard,
+  blockquote,
+  blockquoteWithList,
+  bodiedExtension,
+  bulletList,
+  caption,
+  codeBlock,
+  confluenceJiraIssue,
+  confluenceUnsupportedBlock,
+  confluenceUnsupportedInline,
+  date,
+  decisionItem,
+  decisionList,
+  doc,
+  embedCard,
+  emoji,
+  expand,
+  extendedPanel,
+  extension,
+  extensionFrame,
+  hardBreak,
+  heading,
+  image,
+  inlineCard,
+  inlineExtension,
+  layoutColumn,
+  layoutSection,
+  listItem,
+  listItemWithTask,
+  media,
+  mediaGroup,
+  mediaInline,
+  mediaSingle,
+  mediaSingleFull,
+  mediaSingleWithCaption,
+  mediaSingleWithWidthType,
+  mention,
+  multiBodiedExtension,
+  nestedExpand,
+  orderedList,
+  orderedListWithOrder,
+  panel,
+  paragraph,
+  placeholder,
+  rule,
+  status,
+  taskItem,
+  taskList,
+  table,
+  tableCell,
+  tableHeader,
+  tableRow,
+  text,
+  unsupportedBlock,
+  unsupportedInline,
+} from '../../../src/schema/nodes';
 
 const defaultSchema = getNodesAndMarksMap();
 
 /**
- * TODO: The EXCLUDE and SKIPPED consts are defined to pass the test
+ * TODO: The SKIPPED consts are defined to pass the test
  * Once following ticket is done, will need to remove exclude and unskip tests.
  * https://product-fabric.atlassian.net/browse/ED-23488
  */
-const EXCLUDE_CONTENT_FROM_NODESPEC = [
-  'uknownBlock', // We won't have it in DSL
-];
-
-const SKIPPED_NODESPEC_TESTS = [
-  '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
-];
+const SKIPPED_NODESPEC_TESTS = [];
 
-/**
- *
- * When the default schema is created, there's a nodesInOrder map being used to map node name to a node spec
- * The mapped node spec could be a different variant, rather than the base one.
- * https://bitbucket.org/atlassian/adf-schema/src/main/packages/adf-schema/src/schema/create-schema.ts#lines-143
- *
- * TODO: consider stage0 as well
- */
-const defaultSchemaNodeSpecMap = () => {
-  return {
-    blockquote: 'blockquoteWithList',
-    extension: 'extensionWithMarks',
-    bodiedExtension: 'bodiedExtensionWithMarks',
-    inlineExtension: 'inlineExtensionWithMarks',
-    mediaSingle: 'mediaSingleFull',
-    nestedExpand: 'nestedExpandWithNoMarks',
-    codeBlock: 'codeBlockWithNoMarks',
-    heading: 'headingWithNoMarks',
-    // Base variant is not used anywhere
-    expand: 'expandWithNoMark',
-  };
+const newSpecNameReference = {
+  blockquote: 'blockquoteLegacy',
+  blockquoteWithList: 'blockquote',
+  extendedPanel: 'panel',
+  inlineExtension: 'inlineExtensionWithMarks',
+  listItem: 'listItemLegacy',
+  listItemWithTask: 'listItem',
+  mediaSingleWithCaption: 'mediaSingleCaption',
+  mediaSingleWithWidthType: 'mediaSingleWidthType',
+  orderedListWithOrder: 'orderedList',
+  panel: 'panelLegacy',
 };
 
-const getDefaultSpecName = (nodeName: string) => {
-  const customNodeSpecName = defaultSchemaNodeSpecMap()[nodeName];
+const getNewSpecName = (nodeName: string) => {
+  const customNodeSpecName = newSpecNameReference[nodeName];
   return customNodeSpecName ? customNodeSpecName : nodeName;
 };
 
+const oldSpecReferences = {
+  blockCard,
+  blockquote,
+  blockquoteWithList,
+  bodiedExtension,
+  bulletList,
+  caption,
+  codeBlock,
+  confluenceJiraIssue,
+  confluenceUnsupportedBlock,
+  confluenceUnsupportedInline,
+  date,
+  decisionItem,
+  decisionList,
+  doc,
+  embedCard,
+  emoji,
+  expand,
+  extendedPanel: extendedPanel(true),
+  extension,
+  extensionFrame,
+  hardBreak,
+  heading,
+  image,
+  inlineCard,
+  inlineExtension,
+  layoutColumn,
+  layoutSection,
+  listItem,
+  listItemWithTask,
+  media,
+  mediaGroup,
+  mediaInline,
+  mediaSingle,
+  mediaSingleFull,
+  mediaSingleWithCaption,
+  mediaSingleWithWidthType,
+  mention,
+  multiBodiedExtension,
+  nestedExpand,
+  orderedList,
+  orderedListWithOrder,
+  panel: panel(true),
+  paragraph,
+  placeholder,
+  rule,
+  status,
+  taskItem,
+  taskList,
+  table,
+  tableCell,
+  tableHeader,
+  tableRow,
+  text,
+  unsupportedBlock,
+  unsupportedInline,
+};
+
 const failMessage = (actual, expected, not) => () =>
   `${matcherHint(
     `${not ? '.not' : ''}.toMatchNodeSpec`,
@@ -80,19 +177,24 @@ expect.extend({
     const formattedExpected = {
       ...expected,
       ...(expected.content && {
-        content: formatContent(expected.content, EXCLUDE_CONTENT_FROM_NODESPEC),
+        content: formatContent(expected.content),
       }),
       ...(expected.marks && {
         marks: filterAndSortMarks(expected.marks),
       }),
     };
 
-    // TODO: why
+    // status node used uuid for localId, which is incorrect, and not supported in DSL.
     if (formattedExpected?.attrs?.localId?.default) {
       formattedExpected.attrs.localId.default = '';
     }
 
-    const pass = this.equals(formattedActual, formattedExpected);
+    const pass = this.equals(
+      formattedActual,
+      formattedExpected,
+      undefined,
+      true, // enable strict equal
+    );
     return {
       pass,
       message: failMessage(formattedActual, formattedExpected, pass),
@@ -151,24 +253,26 @@ describe('validate PM schema', () => {
         // check if there's any missing markSpec
         expect(newMarkSpecFn).toBeDefined();
         const newMarkSpec = newMarkSpecFn<any>({});
-        expect(omit(newMarkSpec, ['parseDOM', 'toDOM'])).toEqual(
-          omit(legacyMarkSpec, ['parseDOM', 'toDOM']),
+        expect(
+          omit(newMarkSpec, ['parseDOM', 'toDOM', 'toDebugString']),
+        ).toStrictEqual(
+          omit(legacyMarkSpec, ['parseDOM', 'toDOM', 'toDebugString']),
         );
       });
     });
   });
 
   describe('nodes', () => {
-    const { nodes } = defaultSchema;
     const skipLists = SKIPPED_NODESPEC_TESTS;
-    const testCases = Object.entries(nodes).map(([key, value]) => {
-      const specName = getDefaultSpecName(key);
+    const testCases = Object.entries(oldSpecReferences).map(([key, value]) => {
+      const newSpecName = getNewSpecName(key);
+      console.log('newSpecName', newSpecName, newNodeSpecs[newSpecName]);
       return {
-        name: specName,
+        name: key,
         legacyNodeSpec: value,
-        newNodeSpecFn: newNodeSpecs[specName] as NodeSpecFactory,
+        newNodeSpecFn: newNodeSpecs[newSpecName] as NodeSpecFactory,
         testingMethod: {
-          skip: skipLists.includes(specName),
+          skip: skipLists.includes(key),
         },
       };
     });
@@ -190,8 +294,10 @@ describe('validate PM schema', () => {
           // check if there's any missing nodeSpec
           expect(newNodeSpecFn).toBeDefined();
           const newNodeSpec = newNodeSpecFn<any>({});
-          expect(omit(newNodeSpec, ['parseDOM', 'toDOM'])).toMatchNodeSpec(
-            omit(legacyNodeSpec, ['parseDOM', 'toDOM']),
+          expect(
+            omit(newNodeSpec, ['parseDOM', 'toDOM', 'toDebugString']),
+          ).toMatchNodeSpec(
+            omit(legacyNodeSpec, ['parseDOM', 'toDOM', 'toDebugString']),
           );
         });
       },

package/schema-next/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@atlaskit/adf-schema/schema-next",
+  "description": "Schema generated from ADF DSL (Experimental)",
+  "main": "../dist/cjs/next-schema/index.js",
+  "module": "../dist/esm/next-schema/index.js",
+  "module:es2019": "../dist/es2019/next-schema/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/next-schema/index.d.ts"
+}

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

@@ -1,194 +0,0 @@
-# Jqueries
-
-Temp file to hold jqueries for whittling down the json spec
-
-Delete all subfields:
-
-```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, .type, .items, .minItems) else . end)'
-```
-
-Delete all subfields and content objects:
-
-```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, .type, .items, .minItems, .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content) else . end)'
-```
-
-Delete all subfields except for type. 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, .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)'
-```
-
-Delete all subfields except for marks, anyOf, 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, .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)'
-```
-
-Delete all subfields except for marks, attrs, anyOf, 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, .version, .required, .additionalProperties, .allOf, .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)'
-```
-
-Delete all subfields except for text, marks, attrs, anyOf, 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, .version, .required, .additionalProperties, .allOf, .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)'
-```
-
-Delete all subfields except for content, text, marks, attrs, anyOf, items, type and properties. Base level content objects (not nodes) are also deleted. `inline` is also deleted, as it is a content object for paragraph.
-
-All fields of content 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(
-  .version, .required, .additionalProperties, .allOf, .minItems, .content.items, .content.type, .content."$ref",
-  .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
-```
-
-Delete all subfields except for content, text, marks, attrs, anyOf, items, type and properties. Base level content objects (not nodes) are also deleted. `inline` is also deleted, as it is a content object for paragraph.
-
-All fields of content except for type 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(
-  .version, .required, .additionalProperties, .allOf, .minItems, .content.items, .content."$ref",
-  .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
-```
-
-Delete all subfields except for content, text, marks, attrs, anyOf, items, type and properties. Base level content objects (not nodes) are also deleted. `inline` is also deleted, as it is a content object for paragraph.
-
-All fields of content except for type and items 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(
-  .version, .required, .additionalProperties, .allOf, .minItems, .content.items.anyOf?, .content.items."$ref"?, .content.items[]?, .content."$ref",
-  .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 and items 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(
-  .version, .required, .additionalProperties, .allOf, .content.items.anyOf?, .content.items."$ref"?, .content.items[]?, .content."$ref",
-  .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 and items 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, .content.items.anyOf?, .content.items."$ref"?, .content.items[]?, .content."$ref",
-  .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, .content.items.anyOf?,
-  .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
-```
-
-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(
-  .additionalProperties, .allOf, .properties.required,
-  .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
-```