@atlaskit/adf-schema 37.1.43 → 37.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 37.2.0
+
+### Minor Changes
+
+- 5f92d0b: Added entry-point for validator spec from adf-schema package at `./schema-validator`
+
 ## 37.1.43
 
 ### Patch Changes

package/dist/cjs/next-schema/nodes/layoutSection.js

@@ -30,7 +30,7 @@ var layoutSection = exports.layoutSection = (0, _adfSchemaGenerator.adfNode)('la
   }
 }).variant('with_single_column', {
   content: [(0, _adfSchemaGenerator.$range)(1, 3, (0, _adfSchemaGenerator.$or)(_layoutColumn.layoutColumn, _unsupportedBlock.unsupportedBlock))],
-  ignore: ['json-schema'],
+  ignore: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'validator-spec': {
       'props.type': {

package/dist/cjs/next-schema/nodes/multiBodiedExtension.js

@@ -50,7 +50,7 @@ var multiBodiedExtension = exports.multiBodiedExtension = (0, _adfSchemaGenerato
     }
   },
   content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_extensionFrame.extensionFrame))],
-  ignore: ['json-schema'],
+  ignore: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'validator-spec': {
       'props.content.minItems': {

package/dist/es2019/next-schema/nodes/layoutSection.js

@@ -24,7 +24,7 @@ export const layoutSection = adfNode('layoutSection').define({
   }
 }).variant('with_single_column', {
   content: [$range(1, 3, $or(layoutColumn, unsupportedBlock))],
-  ignore: ['json-schema'],
+  ignore: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'validator-spec': {
       'props.type': {

package/dist/es2019/next-schema/nodes/multiBodiedExtension.js

@@ -44,7 +44,7 @@ export const multiBodiedExtension = adfNode('multiBodiedExtension').define({
     }
   },
   content: [$onePlus($or(extensionFrame))],
-  ignore: ['json-schema'],
+  ignore: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'validator-spec': {
       'props.content.minItems': {

package/dist/esm/next-schema/nodes/layoutSection.js

@@ -24,7 +24,7 @@ export var layoutSection = adfNode('layoutSection').define({
   }
 }).variant('with_single_column', {
   content: [$range(1, 3, $or(layoutColumn, unsupportedBlock))],
-  ignore: ['json-schema'],
+  ignore: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'validator-spec': {
       'props.type': {

package/dist/esm/next-schema/nodes/multiBodiedExtension.js

@@ -44,7 +44,7 @@ export var multiBodiedExtension = adfNode('multiBodiedExtension').define({
     }
   },
   content: [$onePlus($or(extensionFrame))],
-  ignore: ['json-schema'],
+  ignore: [],
   DANGEROUS_MANUAL_OVERRIDE: {
     'validator-spec': {
       'props.content.minItems': {

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

@@ -29,7 +29,7 @@ export declare const layoutSection: import("@atlaskit/adf-schema-generator/dist/
     };
 } & {
     content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentRangeSpec[];
-    ignore: "json-schema"[];
+    ignore: any[];
     DANGEROUS_MANUAL_OVERRIDE: {
         'validator-spec': {
             'props.type': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "37.1.43",
+  "version": "37.2.0",
   "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/json-full-schema-backwards-compat.unit.ts

@@ -40,101 +40,27 @@ expect.extend({
 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);
+  const nextSchema = adfToJSON(adfNode, true);
   expect(nextSchema).toBeBackwardsCompatibleWith(currentSchema);
 });
 
-// The end goal is to be able to remove all transformation for known failures
-function transformFullFixtureForKnownFailures(json) {
-  const definitions = json.definitions;
-
-  // Extra nodes in anyOf
-  definitions.inline_node.anyOf = definitions.inline_node.anyOf.filter(
-    (v) =>
-      ![
-        '#/definitions/confluenceJiraIssue_node',
-        '#/definitions/confluenceUnsupportedInline_node',
-        '#/definitions/image_node',
-        '#/definitions/inlineExtension_node',
-        '#/definitions/text_link_inline_node',
-        '#/definitions/text_node',
-        '#/definitions/unsupportedInline_node',
-      ].includes(v.$ref),
-  );
-
-  // Extra nodes in content.items.anyOf
-  definitions.table_row_node.properties.content.items.anyOf =
-    definitions.table_row_node.properties.content.items.anyOf.filter(
-      (v) => v.$ref !== '#/definitions/table_cell_content',
-    );
-
-  // Extra definitions
-  delete definitions.extensionFrame_node;
-
-  // // Extra marks
-  delete definitions.date_node.properties.marks;
-  delete definitions.emoji_node.properties.marks;
-  delete definitions.mention_node.properties.marks;
-  delete definitions.status_node.properties.marks;
-
-  // // Extra properties
-  delete definitions.codeBlock_node.properties.attrs.properties.uniqueId;
-  delete definitions.codeBlock_with_marks_node.allOf.find(
-    (v) => v.type === 'object',
-  ).properties.content;
-  delete definitions.mediaGroup_node.properties.attrs;
-  delete definitions.mediaInline_node.properties.attrs.properties.url;
-
-  // Special case for table_cell_content
-  definitions.table_cell_content.items.anyOf =
-    definitions.table_cell_content.items.anyOf.filter(
-      (v) => v.$ref !== '#/definitions/nestedExpand_content',
-    );
-
-  return json;
-}
-
 test('JSON Schema to ADF DSL backwards compatibility for full schema', () => {
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const currentSchema = require('../../../json-schema/v1/full.json');
-  const nextSchema = transformFullFixtureForKnownFailures(adfToJSON(adfNode));
+  const nextSchema = adfToJSON(adfNode, true);
   expect(currentSchema).toBeBackwardsCompatibleWith(nextSchema);
 });
 
-const DEFINITIONS_TO_SKIP_STAGE_0_BACKWARDS = [
-  'doc_node',
-  'inlineCard_node',
-  'layoutSection_with_single_column_node',
-  'multiBodiedExtension_node',
-];
 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);
-  DEFINITIONS_TO_SKIP_STAGE_0_BACKWARDS.forEach((definition) => {
-    nextSchema.definitions[definition] = currentSchema.definitions[definition];
-  });
-
   expect(nextSchema).toBeBackwardsCompatibleWith(currentSchema);
 });
 
-const DEFINITIONS_TO_SKIP_STAGE_0_FORWARDS = [
-  'extensionFrame_node',
-  'inline_node',
-  'table_row_node',
-  'table_cell_content',
-  'codeBlock_node',
-  'codeBlock_with_marks_node',
-  'mediaInline_node',
-  'mediaGroup_node',
-];
 test('JSON Schema to ADF DSL 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);
-  DEFINITIONS_TO_SKIP_STAGE_0_FORWARDS.forEach((definition) => {
-    currentSchema.definitions[definition] = nextSchema.definitions[definition];
-  });
-
   expect(currentSchema).toBeBackwardsCompatibleWith(nextSchema);
 });

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

@@ -0,0 +1,7 @@
+import { doc } from '@atlaskit/adf-schema/schema-validator';
+
+describe('ADF Validator schema entry-point', () => {
+  it('should have the doc node', function () {
+    expect(doc.props.type.values).toEqual(['doc']);
+  });
+});

package/schema-validator/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@atlaskit/adf-schema/schema-validator",
+  "description": "Validator schema generated from ADF DSL",
+  "main": "../dist/cjs/validator-schema/generated/validatorSpec.js",
+  "module": "../dist/esm/validator-schema/generated/validatorSpec.js",
+  "module:es2019": "../dist/es2019/validator-schema/generated/validatorSpec.js",
+  "sideEffects": false,
+  "types": "../dist/types/validator-schema/generated/validatorSpec.d.ts"
+}