@atlaskit/adf-schema 39.0.1 → 39.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 39.0.2
+
+### Patch Changes
+
+- 3d69cd2: clean up comments and remove validating pm spec unit tests as we have migrated pm spec
+
 ## 39.0.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "39.0.1",
+  "version": "39.0.2",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

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

@@ -1,307 +0,0 @@
-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 { 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';
-import {
-  MarkSpecFactory,
-  NodeSpecFactory,
-} from '../../../src/schema/createPMSpecFactory';
-
-const defaultSchema = getNodesAndMarksMap();
-
-/**
- * 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 SKIPPED_NODESPEC_TESTS = [];
-
-const newSpecNameReference = {
-  blockquote: 'blockquoteLegacy',
-  blockquoteWithList: 'blockquote',
-  extendedPanel: 'panel',
-  inlineExtension: 'inlineExtensionWithMarks',
-  listItem: 'listItemLegacy',
-  listItemWithTask: 'listItem',
-  mediaSingleWithCaption: 'mediaSingleCaption',
-  mediaSingleWithWidthType: 'mediaSingleWidthType',
-  orderedListWithOrder: 'orderedList',
-  panel: 'panelLegacy',
-  multiBodiedExtension: 'multiBodiedExtensionStage0',
-  extensionFrame: 'extensionFrameStage0',
-};
-
-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`,
-    'received',
-    'expected',
-  )}
-
-Expected nodeSpec${not ? ' not ' : ' '}to be equal:
-  
-Expected: ${printExpected(expected)}
-Received: ${printReceived(actual)}`;
-
-declare let expect: any;
-expect.extend({
-  toMatchNodeSpec(actual: NodeSpec, expected: NodeSpec) {
-    const formattedActual = {
-      ...actual,
-      ...(actual.content && { content: formatContent(actual.content) }),
-      ...(actual.marks && {
-        marks: filterAndSortMarks(actual.marks),
-      }),
-    };
-
-    const formattedExpected = {
-      ...expected,
-      ...(expected.content && {
-        content: formatContent(expected.content),
-      }),
-      ...(expected.marks && {
-        marks: filterAndSortMarks(expected.marks),
-      }),
-    };
-
-    // 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,
-      undefined,
-      true, // enable strict equal
-    );
-    return {
-      pass,
-      message: failMessage(formattedActual, formattedExpected, pass),
-    };
-  },
-});
-
-function isNodeSpec(_value: MarkSpec | NodeSpec): _value is NodeSpec {
-  return true;
-}
-
-/**
- * Custom omit function, mainly used to filter out parseDOM and toDOM from old spec
- * and some special logic to filter out certain field when compare spec
- * @param data
- * @param keys
- * @returns
- */
-function omit<T extends object>(data: T, keys = []): T {
-  const result = { ...data };
-  for (const k of keys) {
-    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-    delete result[k];
-  }
-  if (isNodeSpec(data)) {
-    // Treat inline: false same as no inline property
-    if (data.inline !== undefined && data.inline === false) {
-      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-      delete result['inline'];
-    }
-  }
-  return result;
-}
-
-describe('validate PM schema', () => {
-  describe('marks', () => {
-    const { marks } = defaultSchema;
-
-    const testCases = Object.entries(marks).map(([key, value]) => {
-      return {
-        name: key,
-        legacyMarkSpec: value,
-        newMarkSpecFn: newMarkSpecs[key] as MarkSpecFactory,
-        skip: key.startsWith('__'),
-      };
-    });
-
-    const getTestingMethod = (skip: boolean) => {
-      return skip ? it.skip : it;
-    };
-
-    testCases.forEach(({ name, legacyMarkSpec, newMarkSpecFn, skip }) => {
-      const testMethod = getTestingMethod(skip);
-
-      testMethod(`validate markSpec for mark ${name}`, () => {
-        // check if there's any missing markSpec
-        expect(newMarkSpecFn).toBeDefined();
-        const newMarkSpec = newMarkSpecFn<any>({});
-        expect(
-          omit(newMarkSpec, ['parseDOM', 'toDOM', 'toDebugString']),
-        ).toStrictEqual(
-          omit(legacyMarkSpec, ['parseDOM', 'toDOM', 'toDebugString']),
-        );
-      });
-    });
-  });
-
-  describe('nodes', () => {
-    const skipLists = SKIPPED_NODESPEC_TESTS;
-    const testCases = Object.entries(oldSpecReferences).map(([key, value]) => {
-      const newSpecName = getNewSpecName(key);
-      return {
-        name: key,
-        legacyNodeSpec: value,
-        newNodeSpecFn: newNodeSpecs[newSpecName] as NodeSpecFactory,
-        testingMethod: {
-          skip: skipLists.includes(key),
-        },
-      };
-    });
-
-    const getTestingMethod = ({ only = false, skip = false }) => {
-      if (skip) {
-        return it.skip;
-      }
-      if (only) {
-        return it.only;
-      }
-      return it;
-    };
-
-    testCases.forEach(
-      ({ name, legacyNodeSpec, newNodeSpecFn, testingMethod }) => {
-        const testMethod = getTestingMethod(testingMethod);
-        testMethod(`validate nodeSpec for node ${name}`, () => {
-          // check if there's any missing nodeSpec
-          expect(newNodeSpecFn).toBeDefined();
-          const newNodeSpec = newNodeSpecFn<any>({});
-          expect(
-            omit(newNodeSpec, ['parseDOM', 'toDOM', 'toDebugString']),
-          ).toMatchNodeSpec(
-            omit(legacyNodeSpec, ['parseDOM', 'toDOM', 'toDebugString']),
-          );
-        });
-      },
-    );
-  });
-});