@atlaskit/adf-schema 36.10.9 → 36.10.11

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

@@ -1,6 +1,7 @@
 export declare const inlineExtension: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_marks"], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const layoutColumn: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const layoutSection: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "full"], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const orderedList: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;
@@ -18,6 +19,7 @@ export declare const orderedList: import("@atlaskit/adf-schema-generator/dist/ty
 export declare const bulletList: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const media: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const mediaGroup: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const mediaInline: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const mediaSingle: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "caption", "full"], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const mention: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const multiBodiedExtension: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const nestedExpand: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_no_marks"], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const panel: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const paragraph: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_alignment", "with_indentation", "with_marks", "with_no_marks"], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const placeholder: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const rule: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const status: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const table: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const tableCell: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const tableHeader: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const tableRow: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const taskItem: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;
@@ -18,6 +19,7 @@ export declare const taskItem: import("@atlaskit/adf-schema-generator/dist/types
 export declare const taskList: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

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

@@ -1,6 +1,7 @@
 export declare const text: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "formatted", "code_inline"], {
     root?: boolean;
     atom?: boolean;
+    version?: 1;
     attrs?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFAttribute").ADFAttributes;
     inline?: true;
     code?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.10.9",
+  "version": "36.10.11",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -21,7 +21,7 @@
     "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=adf-schema/src --config=../../jest.config.js",
+    "test:unit": "yarn workspace @atlaskit/editor-prosemirror build && jest --testPathPattern=packages/adf-schema/ --config=../../jest.config.js",
     "build:cjs": "NODE_ENV=production BABEL_ENV=production:node-cjs babel --config-file ../../babel.config.js src --out-dir dist/cjs -x .ts,.tsx",
     "build:esm": "NODE_ENV=production BABEL_ENV=production:esm babel --config-file ../../babel.config.js src -d dist/esm -x .ts,.tsx",
     "build:es2019": "NODE_ENV=production BABEL_ENV=production:es2019 babel --config-file ../../babel.config.js src -d dist/es2019 -x .ts,.tsx",
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.15.0",
-    "@atlaskit/adf-schema-generator": "^1.8.2",
+    "@atlaskit/adf-schema-generator": "^1.8.4",
     "@babel/cli": "^7.22.9",
     "@babel/core": "^7.22.9",
     "@babel/plugin-proposal-class-properties": "^7.18.6",

package/schema-generators/__tests__/unit/jqueries.md

@@ -127,3 +127,16 @@ A number of nodes have `marks` defined, yet the array is empty. Assuming this is
   .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node,
   .bodiedExtension_node.properties.marks, .codeBlock_node.properties.marks, .expand_node.properties.marks, .heading_node.properties.marks, .inlineExtension_node.properties.marks, .text_node.properties.marks, .extension_node.properties.marks, .paragraph_node.properties.marks) else . end)' | pbcopy
 ```
+
+Base level content objects (not nodes) are deleted. `inline` is also deleted, as it is a content object for paragraph.
+
+All fields of content except for type and items have been deleted as well.
+
+A number of nodes have `marks` defined, yet the array is empty. Assuming this is redundant, I've removed them.
+
+```sh
+ cat packages/adf-schema/json-schema/v1/full.json | jq 'walk(if type == "object" then del(
+  .required, .additionalProperties, .allOf, .content.items.anyOf?, .content.items."$ref"?, .content.items[]?, .content."$ref",
+  .block_content, .nestedExpand_content, .non_nestable_block_content, .table_cell_content, .inline_node,
+  .bodiedExtension_node.properties.marks, .codeBlock_node.properties.marks, .expand_node.properties.marks, .heading_node.properties.marks, .inlineExtension_node.properties.marks, .text_node.properties.marks, .extension_node.properties.marks, .paragraph_node.properties.marks) else . end)' | pbcopy
+```

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

@@ -1320,6 +1320,9 @@ const jsonWithTypes = {
     doc_node: {
       type: 'object',
       properties: {
+        version: {
+          enum: [1],
+        },
         type: {
           enum: ['doc'],
         },

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

@@ -0,0 +1,110 @@
+import { MarkSpec, NodeSpec, Schema } from '@atlaskit/editor-prosemirror/model';
+import * as newMarkSpecs from '@atlaskit/adf-schema-generator/src/generated/markTypes';
+import * as newNodeSpecs from '@atlaskit/adf-schema-generator/src/generated/nodeTypes';
+import {
+  MarkSpecFactory,
+  NodeSpecFactory,
+} from '@atlaskit/adf-schema-generator/src/transforms/adfToPm/createPMSpecFactory';
+import { defaultSchema } from '../../../src/schema/default-schema';
+
+function isMarkSpec(value: MarkSpec | NodeSpec): value is MarkSpec {
+  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: (keyof T)[]): T {
+  const result = { ...data };
+  for (const k of keys) {
+    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+    delete result[k];
+  }
+  if (isMarkSpec(data)) {
+    // Treat excludes: '' same as no excludes property
+    if (data.excludes !== undefined && data.excludes === '') {
+      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+      delete result['excludes'];
+    }
+  }
+  return result;
+}
+
+describe('validate PM schema', () => {
+  describe('marks', () => {
+    const { marks } = defaultSchema as Schema;
+    const skipLists = [
+      'link', // TODO: new link mark is not matching old link mark
+      'confluenceInlineComment', // TODO: not exist in ADF DSL
+      'unsupportedMark', // TODO: not exist in ADF DSL
+      'unsupportedNodeAttribute', // TODO: not exist in ADF DSL
+      'typeAheadQuery', // TODO: not exist in ADF DSL
+      // Following marks not exported in adf-schema
+      '__colorGroupDeclaration',
+      '__fontStyleGroupDeclaration',
+      '__searchQueryGroupDeclaration',
+      '__linkGroupDeclaration',
+    ];
+
+    const testCases = Object.entries(marks).map(([key, value]) => {
+      return {
+        name: key,
+        legacyMarkSpec: value.spec,
+        newMarkSpecFn: newMarkSpecs[`${key}`] as MarkSpecFactory,
+        skip: skipLists.includes(key),
+      };
+    });
+
+    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({});
+        expect(omit(newMarkSpec, ['parseDOM', 'toDOM'])).toEqual(
+          omit(legacyMarkSpec, ['parseDOM', 'toDOM']),
+        );
+      });
+    });
+  });
+
+  // TODO: content from node is too strict, need a custom comparor
+  // TODO: marks are not matching, especially missing unsupportedBlock, unsupportedNodeAttribute
+  describe.skip('nodes', () => {
+    const { nodes } = defaultSchema as Schema;
+    const skipLists = ['unknownBlock', 'unsupportedBlock', 'unsupportedInline'];
+    const testCases = Object.entries(nodes).map(([key, value]) => {
+      return {
+        name: key,
+        legacyNodeSpec: value.spec,
+        newNodeSpecFn: newNodeSpecs[`${key}`] as NodeSpecFactory,
+        skip: skipLists.includes(key),
+      };
+    });
+
+    const getTestingMethod = (skip: boolean) => {
+      return skip ? it.skip : it;
+    };
+
+    testCases.forEach(({ name, legacyNodeSpec, newNodeSpecFn, skip }) => {
+      const testMethod = getTestingMethod(skip);
+      testMethod(`validate nodeSpec for node ${name}`, () => {
+        // check if there's any missing nodeSpec
+        expect(newNodeSpecFn).toBeDefined();
+        const newNodeSpec = newNodeSpecFn({});
+        expect(omit(newNodeSpec, ['parseDOM', 'toDOM'])).toEqual(
+          omit(legacyNodeSpec, ['parseDOM', 'toDOM']),
+        );
+      });
+    });
+  });
+});

package/dist/cjs/next-schema/groups/annotationGroup.js

@@ -1,8 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.annotationGroup = void 0;
-var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
-var annotationGroup = exports.annotationGroup = (0, _adfSchemaGenerator.adfMarkGroup)('annotation');

package/dist/cjs/next-schema/groups/colorGroup.js

@@ -1,9 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.colorGroup = void 0;
-var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
-var _textColor = require("../marks/textColor");
-var colorGroup = exports.colorGroup = (0, _adfSchemaGenerator.adfMarkGroup)('color', [_textColor.textColor]);

package/dist/cjs/next-schema/marks/backgroundColor.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.backgroundColor = void 0;
-var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
-var backgroundColor = exports.backgroundColor = (0, _adfSchemaGenerator.adfMark)('backgroundColor').define({
-  attrs: {
-    color: {
-      pattern: '^#[0-9a-fA-F]{6}$',
-      type: 'string'
-    }
-  }
-});

package/dist/cjs/next-schema/marks/textColor.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.textColor = void 0;
-var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
-var textColor = exports.textColor = (0, _adfSchemaGenerator.adfMark)('textColor').define({
-  inclusive: true,
-  attrs: {
-    color: {
-      type: 'string',
-      pattern: '^#[0-9a-fA-F]{6}$'
-    }
-  }
-});

package/dist/es2019/next-schema/groups/annotationGroup.js

@@ -1,2 +0,0 @@
-import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
-export const annotationGroup = adfMarkGroup('annotation');

package/dist/es2019/next-schema/groups/colorGroup.js

@@ -1,3 +0,0 @@
-import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
-import { textColor } from '../marks/textColor';
-export const colorGroup = adfMarkGroup('color', [textColor]);

package/dist/es2019/next-schema/marks/backgroundColor.js

@@ -1,9 +0,0 @@
-import { adfMark } from '@atlaskit/adf-schema-generator';
-export const backgroundColor = adfMark('backgroundColor').define({
-  attrs: {
-    color: {
-      pattern: '^#[0-9a-fA-F]{6}$',
-      type: 'string'
-    }
-  }
-});

package/dist/es2019/next-schema/marks/textColor.js

@@ -1,10 +0,0 @@
-import { adfMark } from '@atlaskit/adf-schema-generator';
-export const textColor = adfMark('textColor').define({
-  inclusive: true,
-  attrs: {
-    color: {
-      type: 'string',
-      pattern: '^#[0-9a-fA-F]{6}$'
-    }
-  }
-});

package/dist/esm/next-schema/groups/annotationGroup.js

@@ -1,2 +0,0 @@
-import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
-export var annotationGroup = adfMarkGroup('annotation');

package/dist/esm/next-schema/groups/colorGroup.js

@@ -1,3 +0,0 @@
-import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
-import { textColor } from '../marks/textColor';
-export var colorGroup = adfMarkGroup('color', [textColor]);

package/dist/esm/next-schema/marks/backgroundColor.js

@@ -1,9 +0,0 @@
-import { adfMark } from '@atlaskit/adf-schema-generator';
-export var backgroundColor = adfMark('backgroundColor').define({
-  attrs: {
-    color: {
-      pattern: '^#[0-9a-fA-F]{6}$',
-      type: 'string'
-    }
-  }
-});

package/dist/esm/next-schema/marks/textColor.js

@@ -1,10 +0,0 @@
-import { adfMark } from '@atlaskit/adf-schema-generator';
-export var textColor = adfMark('textColor').define({
-  inclusive: true,
-  attrs: {
-    color: {
-      type: 'string',
-      pattern: '^#[0-9a-fA-F]{6}$'
-    }
-  }
-});

package/dist/types/next-schema/groups/annotationGroup.d.ts

@@ -1 +0,0 @@
-export declare const annotationGroup: import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkGroup").ADFMarkGroup;

package/dist/types/next-schema/groups/colorGroup.d.ts

@@ -1 +0,0 @@
-export declare const colorGroup: import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkGroup").ADFMarkGroup;

package/dist/types/next-schema/marks/backgroundColor.d.ts

@@ -1 +0,0 @@
-export declare const backgroundColor: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>;

package/dist/types/next-schema/marks/textColor.d.ts

@@ -1 +0,0 @@
-export declare const textColor: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>;