@atlaskit/adf-schema/schema-generators/__tests__/unit/json-full-schema-backwards-compat.unit.ts

Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs

import { validateSchemaCompatibility } from 'json-schema-diff-validator';
import { adfToJSON } from '@atlaskit/adf-schema-generator';
import adfNode from '@atlaskit/adf-schema/src/next-schema/full-schema.adf';

declare let expect: any;
expect.extend({
  toBeBackwardsCompatibleWith(received, expected) {
    try {
      validateSchemaCompatibility(expected, received, {
        allowNewOneOf: true,
        allowNewEnumValue: true,
        allowReorder: true,
      });
    } catch (e) {
      if (e.name === 'AssertionError') {
        return {
          pass: false,
          message: () =>
            JSON.stringify(
              JSON.parse(
                e.message.replace(
                  'The schema is not backward compatible. Difference include breaking change = ',
                  '',
                ),
              ),
              null,
              4,
            ),
        };
      }
      return {
        pass: false,
        message: () => e.message,
      };
    }
    return { pass: true, message: 'Schemas are compatible' };
  },
});

test('ADF DSL to JSON Schema backwards compatibility for full schema', () => {
  // eslint-disable-next-line @typescript-eslint/no-var-requires
  const currentSchema = require('../../../json-schema/v1/full.json');
  const nextSchema = adfToJSON(adfNode, true);
  expect(nextSchema).toBeBackwardsCompatibleWith(currentSchema);
});

test('ADF DSL to JSON Schema backwards compatibility for stage0 schema', () => {
  // eslint-disable-next-line @typescript-eslint/no-var-requires
  const currentSchema = require('../../../json-schema/v1/stage-0.json');
  const nextSchema = adfToJSON(adfNode);
  expect(nextSchema).toBeBackwardsCompatibleWith(currentSchema);
});