@atlaskit/adf-schema 37.2.1 → 39.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "37.2.1",
+  "version": "39.0.0",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -18,10 +18,6 @@
   "sideEffects": false,
   "scripts": {
     "clean:build": "rm -rf dist",
-    "build:json-schema": "mkdir -p dist && cp -r json-schema dist",
-    "generate:json-schema": "mkdir -p json-schema/v1/ && yarn generate:json-schema:full && yarn generate:json-schema:stage-0",
-    "generate:json-schema:stage-0": "json-schema-generator --outDir=./json-schema/v1/ --stage=0 ./src/schema/nodes/doc.ts",
-    "generate:json-schema:full": "json-schema-generator --outDir=./json-schema/v1/ ./src/schema/nodes/doc.ts",
     "ak-postbuild": "yarn build:json-schema",
     "test": "yarn test:unit",
     "test:unit": "yarn workspace @atlaskit/editor-prosemirror build && jest --testPathPattern=packages/adf-schema/ --config=../../jest.config.js",
@@ -32,11 +28,12 @@
     "build:types": "NODE_ENV=production tsc --project ./build/tsconfig.json --emitDeclarationOnly --outDir ./dist/types --rootDir ./src && yarn build:jsontypes",
     "build:jsontypes": "mkdir -p dist/types/json-schema && cp src/json-schema/index.ts dist/types/json-schema/index.d.ts",
     "build:all": "yarn build:cjs && yarn build:esm && yarn build:es2019 && yarn build:types",
-    "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 && prettier --write './src/next-schema/generated/**/*.json'",
-    "build:validator:full": "yarn ts-node ./schema-generators/validator-full-schema.ts && prettier --write './src/validator-schema/generated/**/*.ts'",
-    "build:generated:full": "yarn build:pm:full && yarn build:json:full && yarn build:validator:full",
+    "build": "yarn clean:build && yarn workspace @atlaskit/editor-prosemirror build && yarn workspace @atlaskit/adf-schema-generator build && yarn run build:all && yarn run build:schema:all",
+    "build:move:json-schema": "mkdir -p dist && cp -r json-schema dist",
+    "build:schema:pm": "yarn ts-node ./schema-generators/pm-full-schema.ts && prettier --write './src/next-schema/generated/**/*.ts'",
+    "build:schema:json": "mkdir -p json-schema/v1/ && yarn ts-node ./schema-generators/json-full-schema.ts && prettier --write './json-schema/v1/*.json' && yarn run build:move:json-schema",
+    "build:schema:validator": "yarn ts-node ./schema-generators/validator-full-schema.ts && prettier --write './src/validator-schema/generated/**/*.ts'",
+    "build:schema:all": "yarn build:schema:pm && yarn build:schema:json && yarn build:schema:validator",
     "clean": "../../scripts/build-clean.sh",
     "link:afe": "yarn build:all && node ./copy-dist-to-afe.js"
   },
@@ -51,10 +48,9 @@
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.16.0",
     "@atlassian/feature-flags-test-utils": "^0.2.0",
-    "@atlaskit/adf-schema-generator": "^1.27.0",
+    "@atlaskit/adf-schema-generator": "^1.28.0",
     "@atlaskit/adf-utils": "^19.2.2",
     "@atlaskit/codemod-utils": "^4.2.4",
-    "@atlaskit/json-schema-generator": "^3.3.9",
     "@babel/cli": "^7.22.9",
     "@babel/core": "^7.22.9",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
@@ -67,6 +63,7 @@
     "@babel/preset-react": "^7.18.6",
     "@babel/preset-typescript": "^7.22.5",
     "@compiled/babel-plugin": "0.15.0",
+    "@manypkg/find-root": "^1.1.0",
     "@types/jest": "^29.5.3",
     "@types/json-schema": "^7.0.15",
     "@types/linkify-it": "^2.0.4",

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

@@ -69,18 +69,18 @@ const panel = {
       type: 'array',
       items: [
         [
-          'codeBlock_with_no_marks',
-          'blockCard',
           'paragraph_with_no_marks',
-          'mediaSingle_caption',
-          'mediaSingle_full',
-          'taskList',
+          'heading_with_no_marks',
           'bulletList',
           'orderedList',
-          'heading_with_no_marks',
+          'blockCard',
           'mediaGroup',
-          'decisionList',
+          'mediaSingle_caption',
+          'mediaSingle_full',
+          'codeBlock_with_no_marks',
+          'taskList',
           'rule',
+          'decisionList',
         ],
       ],
       minItems: 1,

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

@@ -1,10 +1,6 @@
 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 {
-  MarkSpecFactory,
-  NodeSpecFactory,
-} from '@atlaskit/adf-schema-generator/src/transforms/adfToPm/createPMSpecFactory';
 import { getNodesAndMarksMap } from '../../../src/schema/create-schema';
 import { printExpected, printReceived, matcherHint } from 'jest-matcher-utils';
 import { filterAndSortMarks, formatContent } from '../helpers/_utils';
@@ -65,6 +61,10 @@ import {
   unsupportedBlock,
   unsupportedInline,
 } from '../../../src/schema/nodes';
+import {
+  MarkSpecFactory,
+  NodeSpecFactory,
+} from '../../../src/schema/createPMSpecFactory';
 
 const defaultSchema = getNodesAndMarksMap();
 

package/schema-generators/helpers/writeToFile.ts

@@ -0,0 +1,24 @@
+import fs from 'fs';
+import path from 'path';
+import { findRootSync } from '@manypkg/find-root';
+
+/**
+ * Writes a string to a file in `packages/adf-schema/src/${subfolder}/generated/${fileName}`
+ * @param fileName The name of the file - including file extension
+ * @param content The string containing the content of the file
+ * @param subpath The subfolder to use, by default it is `next-schema`
+ */
+export function writeToFile(
+  fileName: string,
+  content: string,
+  subpath: string = 'next-schema',
+): void {
+  const filePath = path.join(
+    findRootSync(process.cwd()),
+    'packages',
+    'adf-schema',
+    subpath,
+    fileName,
+  );
+  fs.writeFileSync(filePath, content);
+}

package/schema-generators/json-full-schema.ts

@@ -1,12 +1,16 @@
-import { adfToJSON, writeToFile } from '@atlaskit/adf-schema-generator';
-import adfNode from 'src/next-schema/full-schema.adf';
+import path from 'path';
+import { adfToJSON } from '@atlaskit/adf-schema-generator';
+import adfNode from '../src/next-schema/full-schema.adf';
+import { writeToFile } from './helpers/writeToFile';
+
+const outputPath = path.join('json-schema', 'v1');
 
 function main() {
   const fullSchema = adfToJSON(adfNode, true);
   const stage0 = adfToJSON(adfNode, false);
 
-  writeToFile('full.json', JSON.stringify(fullSchema));
-  writeToFile('stage0.json', JSON.stringify(stage0));
+  writeToFile('full.json', JSON.stringify(fullSchema, null, 2), outputPath);
+  writeToFile('stage-0.json', JSON.stringify(stage0, null, 2), outputPath);
 }
 
 main();

package/schema-generators/pm-full-schema.ts

@@ -1,12 +1,16 @@
-import { adfToPm, writeToFile } from '@atlaskit/adf-schema-generator';
+import path from 'path';
+import { adfToPm } from '@atlaskit/adf-schema-generator';
 import adfNode from 'src/next-schema/full-schema.adf';
+import { writeToFile } from './helpers/writeToFile';
+
+const outputPath = path.join('src', 'next-schema', 'generated');
 
 function main() {
   const output = adfToPm(adfNode);
 
-  writeToFile('nodeTypes.ts', output.pmNodes);
-  writeToFile('markTypes.ts', output.pmMarks);
-  writeToFile('nodeGroupTypes.ts', output.pmNodeGroups);
+  writeToFile('nodeTypes.ts', output.pmNodes, outputPath);
+  writeToFile('markTypes.ts', output.pmMarks, outputPath);
+  writeToFile('nodeGroupTypes.ts', output.pmNodeGroups, outputPath);
 }
 
 main();

package/schema-generators/validator-full-schema.ts

@@ -1,9 +1,10 @@
-import {
-  adfToValidatorSpec,
-  writeToFile,
-} from '@atlaskit/adf-schema-generator';
+import path from 'path';
+import { adfToValidatorSpec } from '@atlaskit/adf-schema-generator';
 import adfNode from 'src/next-schema/full-schema.adf';
 import { sortNestedArrays } from 'src/validator-schema/utils/sortNestedArrays';
+import { writeToFile } from './helpers/writeToFile';
+
+const outputPath = path.join('src', 'validator-schema', 'generated');
 
 function generateValidatorSpec() {
   const output = sortNestedArrays(adfToValidatorSpec(adfNode));
@@ -16,7 +17,7 @@ function generateValidatorSpec() {
 
 function main() {
   const spec = generateValidatorSpec();
-  writeToFile('validatorSpec.ts', spec, 'validator-schema');
+  writeToFile('validatorSpec.ts', spec, outputPath);
 }
 
 main();