@atlaskit/adf-schema 37.1.40 → 37.1.42

package/dist/types/validator-schema/utils/sortNestedArrays.d.ts

@@ -0,0 +1 @@
+export declare function sortNestedArrays<T>(obj: T): T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "37.1.40",
+  "version": "37.1.42",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -35,6 +35,7 @@
     "build": "yarn clean:build && yarn workspace @atlaskit/editor-prosemirror build && yarn workspace @atlaskit/adf-schema-generator build && yarn run build:all && yarn run generate:json-schema && yarn run build:json-schema",
     "build:pm:full": "yarn ts-node ./schema-generators/pm-full-schema.ts && prettier --write './src/next-schema/generated/**/*.ts'",
     "build:json:full": "yarn ts-node ./schema-generators/json-full-schema.ts",
+    "build:validator:full": "yarn ts-node ./schema-generators/validator-full-schema.ts && prettier --write './src/validator-schema/generated/**/*.ts'",
     "clean": "../../scripts/build-clean.sh",
     "link:afe": "yarn build:all && node ./copy-dist-to-afe.js"
   },
@@ -47,7 +48,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.16.0",
-    "@atlaskit/adf-schema-generator": "^1.25.9",
+    "@atlaskit/adf-schema-generator": "^1.25.11",
     "@atlaskit/adf-utils": "^19.2.2",
     "@atlaskit/codemod-utils": "^4.2.4",
     "@atlaskit/json-schema-generator": "^3.3.9",

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

@@ -1,13 +1,9 @@
 import { adfToValidatorSpec } from '@atlaskit/adf-schema-generator';
 import * as currentSpecs from '@atlaskit/adf-utils/dist/cjs/validator/specs';
 import adfNode from '../../../src/next-schema/full-schema.adf';
+import { sortNestedArrays } from '../../../src/validator-schema/utils/sortNestedArrays';
 
 const newSpecs = sortNestedArrays(adfToValidatorSpec(adfNode));
-const SKIP_LIST = [
-  'atomic_inline', // doesn't exist in the output, not even used anywhere...
-  'nestedExpand_content', // doesn't exist in the output, completely different format from other groups
-  'tableCell_content', // doesn't exist in the output, completely different format from other groups
-];
 
 const testCases = Object.entries(currentSpecs).map(([key, value]) => {
   return {
@@ -18,43 +14,7 @@ const testCases = Object.entries(currentSpecs).map(([key, value]) => {
 });
 
 testCases.forEach(({ name, currentSpec, newSpec }) => {
-  const testMethod = SKIP_LIST.includes(name) ? it.skip : it;
-  testMethod(`should be able to handle ${name}`, () => {
+  it(`should be able to handle ${name}`, () => {
     expect(newSpec).toEqual(currentSpec);
   });
 });
-
-function sortNestedArrays(obj: any): any {
-  if (obj === null || obj === undefined) {
-    return obj;
-  }
-
-  if (
-    Array.isArray(obj) &&
-    typeof obj[0] === 'string' &&
-    typeof obj[1] === 'object'
-  ) {
-    // 1. tuple of object + string
-    obj[1] = sortNestedArrays(obj[1]);
-  } else if (Array.isArray(obj) && Array.isArray(obj[0])) {
-    // 2. array of arrays
-    for (let i = 0; i < obj.length; i++) {
-      obj[i] = sortNestedArrays(obj[i]);
-    }
-  } else if (
-    Array.isArray(obj) &&
-    !Array.isArray(obj[0]) &&
-    typeof obj[0] !== 'object'
-  ) {
-    // 3. simple array
-    obj.sort();
-  }
-  if (typeof obj === 'object') {
-    // 4. object
-    for (const key of Object.keys(obj)) {
-      obj[key] = sortNestedArrays(obj[key]);
-    }
-  }
-
-  return obj;
-}

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

@@ -101,63 +101,40 @@ test('JSON Schema to ADF DSL backwards compatibility for full schema', () => {
   expect(currentSchema).toBeBackwardsCompatibleWith(nextSchema);
 });
 
-const DEFINITIONS_TO_SKIP_STAGE_0 = [
-  'blockCard_node',
-  'block_content',
-  'bodiedExtension_node',
-  'bodiedExtension_with_marks_node',
-  'codeBlock_node',
-  'codeBlock_with_marks_node',
-  'codeBlock_with_no_marks_node',
-  'code_inline_node',
-  'date_node',
+const DEFINITIONS_TO_SKIP_STAGE_0_BACKWARDS = [
   'doc_node',
-  'emoji_node',
-  'expand_node',
-  'expand_with_breakout_mark_node',
-  'expand_with_no_mark_node',
-  'extensionFrame_node',
-  'extension_node',
-  'extension_with_marks_node',
-  'formatted_text_inline_node',
-  'heading_node',
-  'heading_with_alignment_node',
-  'heading_with_indentation_node',
-  'heading_with_no_marks_node',
   'inlineCard_node',
-  'inlineExtension_node',
-  'inlineExtension_with_marks_node',
-  'inline_node',
-  'layoutSection_node',
-  'layoutSection_full_node',
   'layoutSection_with_single_column_node',
-  'mediaInline_node',
-  'mediaSingle_caption_node',
-  'mediaSingle_full_node',
-  'mediaSingle_node',
-  'mention_node',
   'multiBodiedExtension_node',
-  'nestedExpand_content',
-  'nestedExpand_node',
-  'nestedExpand_with_no_marks_node',
-  'non_nestable_block_content',
-  'paragraph_node',
-  'paragraph_with_alignment_node',
-  'paragraph_with_indentation_node',
-  'paragraph_with_no_marks_node',
-  'status_node',
-  'table_cell_content',
-  'table_cell_node',
-  'table_header_node',
-  'text_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.forEach((definition) => {
+  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/validator-full-schema.ts

@@ -0,0 +1,22 @@
+import {
+  adfToValidatorSpec,
+  writeToFile,
+} from '@atlaskit/adf-schema-generator';
+import adfNode from 'src/next-schema/full-schema.adf';
+import { sortNestedArrays } from 'src/validator-schema/utils/sortNestedArrays';
+
+function generateValidatorSpec() {
+  const output = sortNestedArrays(adfToValidatorSpec(adfNode));
+  return Object.entries(output)
+    .map(
+      ([key, value]) => `export const ${key} = ${JSON.stringify(value.json)};`,
+    )
+    .join('\n\n');
+}
+
+function main() {
+  const spec = generateValidatorSpec();
+  writeToFile('validatorSpec', spec, 'validator-schema');
+}
+
+main();