@atlaskit/adf-schema 37.1.32 → 37.1.33

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 37.1.33
+
+### Patch Changes
+
+- 755765e: Align doc node to existing validator spec
+
 ## 37.1.32
 
 ### Patch Changes

package/dist/cjs/next-schema/full-schema.adf.js

@@ -9,9 +9,19 @@ var _blockGroup = require("./groups/blockGroup");
 var _layoutSection = require("./nodes/layoutSection");
 var _blockRootOnlyGroup = require("./groups/blockRootOnlyGroup");
 var _blockContentGroup = require("./groups/blockContentGroup");
+var _codeBlock = require("./nodes/codeBlock");
+var _expand = require("./nodes/expand");
 var doc = (0, _adfSchemaGenerator.adfNode)('doc').define({
   root: true,
   version: 1,
-  content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_blockGroup.blockGroup, _blockContentGroup.blockContentGroup, _layoutSection.layoutSection, _layoutSection.layoutSection.use('full'), _blockRootOnlyGroup.blockRootOnlyGroup))]
+  content: [(0, _adfSchemaGenerator.$onePlus)((0, _adfSchemaGenerator.$or)(_blockGroup.blockGroup, _blockContentGroup.blockContentGroup, _codeBlock.codeBlock.use('with_marks'), _layoutSection.layoutSection, _layoutSection.layoutSection.use('full'), _layoutSection.layoutSection.use('with_single_column'), _blockRootOnlyGroup.blockRootOnlyGroup, _expand.expand.use('with_breakout_mark')))],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.content.minItems': {
+        remove: true,
+        reason: "@DSLCompatibilityException - The content expression and minItems don't match in the current validator schema."
+      }
+    }
+  }
 });
 var _default = exports.default = doc;

package/dist/cjs/next-schema/generated/nodeTypes.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.unsupportedInline = exports.unsupportedBlock = exports.textFormatted = exports.textCodeInline = exports.text = exports.taskList = exports.taskItem = exports.tableRow = exports.tableHeader = exports.tableCell = exports.table = exports.status = exports.rule = exports.placeholder = exports.paragraphWithNoMarks = exports.paragraphWithIndentation = exports.paragraphWithAlignment = exports.paragraph = exports.panelLegacy = exports.panel = exports.orderedList = exports.nestedExpandWithNoMarks = exports.nestedExpand = exports.multiBodiedExtension = exports.mention = exports.mediaSingleWidthType = exports.mediaSingleFull = exports.mediaSingleCaption = exports.mediaSingle = exports.mediaInline = exports.mediaGroup = exports.media = exports.listItemLegacy = exports.listItem = exports.layoutSectionFull = exports.layoutSection = exports.layoutColumn = exports.inlineExtensionWithMarks = exports.inlineExtension = exports.inlineCard = exports.image = exports.headingWithNoMarks = exports.headingWithIndentation = exports.headingWithAlignment = exports.heading = exports.hardBreak = exports.extensionWithMarks = exports.extensionFrame = exports.extension = exports.expandWithNoMark = exports.expand = exports.emoji = exports.embedCard = exports.doc = exports.decisionList = exports.decisionItem = exports.date = exports.confluenceUnsupportedInline = exports.confluenceUnsupportedBlock = exports.confluenceJiraIssue = exports.codeBlockWithNoMarks = exports.codeBlock = exports.caption = exports.bulletList = exports.bodiedExtensionWithMarks = exports.bodiedExtension = exports.blockquoteLegacy = exports.blockquote = exports.blockCard = void 0;
+exports.unsupportedInline = exports.unsupportedBlock = exports.textFormatted = exports.textCodeInline = exports.text = exports.taskList = exports.taskItem = exports.tableRow = exports.tableHeader = exports.tableCell = exports.table = exports.status = exports.rule = exports.placeholder = exports.paragraphWithNoMarks = exports.paragraphWithIndentation = exports.paragraphWithAlignment = exports.paragraph = exports.panelLegacy = exports.panel = exports.orderedList = exports.nestedExpandWithNoMarks = exports.nestedExpand = exports.multiBodiedExtension = exports.mention = exports.mediaSingleWidthType = exports.mediaSingleFull = exports.mediaSingleCaption = exports.mediaSingle = exports.mediaInline = exports.mediaGroup = exports.media = exports.listItemLegacy = exports.listItem = exports.layoutSectionWithSingleColumn = exports.layoutSectionFull = exports.layoutSection = exports.layoutColumn = exports.inlineExtensionWithMarks = exports.inlineExtension = exports.inlineCard = exports.image = exports.headingWithNoMarks = exports.headingWithIndentation = exports.headingWithAlignment = exports.heading = exports.hardBreak = exports.extensionWithMarks = exports.extensionFrame = exports.extension = exports.expandWithNoMark = exports.expand = exports.emoji = exports.embedCard = exports.doc = exports.decisionList = exports.decisionItem = exports.date = exports.confluenceUnsupportedInline = exports.confluenceUnsupportedBlock = exports.confluenceJiraIssue = exports.codeBlockWithNoMarks = exports.codeBlock = exports.caption = exports.bulletList = exports.bodiedExtensionWithMarks = exports.bodiedExtension = exports.blockquoteLegacy = exports.blockquote = exports.blockCard = void 0;
 var _adfSchemaGenerator = require("@atlaskit/adf-schema-generator");
 /**
  * This file was automatically generated by @atlaskit/adf-schema-generator
@@ -497,6 +497,11 @@ var layoutSectionFull = exports.layoutSectionFull = (0, _adfSchemaGenerator.crea
   marks: 'unsupportedNodeAttribute unsupportedMark',
   isolating: true
 });
+var layoutSectionWithSingleColumn = exports.layoutSectionWithSingleColumn = (0, _adfSchemaGenerator.createPMNodeSpecFactory)({
+  content: '(layoutColumn | unsupportedBlock){1,3}',
+  marks: 'unsupportedNodeAttribute unsupportedMark',
+  isolating: true
+});
 var listItem = exports.listItem = (0, _adfSchemaGenerator.createPMNodeSpecFactory)({
   content: '(codeBlock | paragraph | mediaSingle | unsupportedBlock) (codeBlock | paragraph | mediaSingle | taskList | bulletList | orderedList | unsupportedBlock)*',
   marks: 'unsupportedNodeAttribute unsupportedMark',

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

@@ -28,6 +28,9 @@ 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']
 }).variant('full', {
   marks: [_breakout.breakout, _unsupportedNodeAttribute.unsupportedNodeAttribute, _unsupportedMark.unsupportedMark],
   content: [(0, _adfSchemaGenerator.$range)(2, 3, (0, _adfSchemaGenerator.$or)(_layoutColumn.layoutColumn, _unsupportedBlock.unsupportedBlock))],

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

@@ -108,8 +108,7 @@ var media = exports.media = (0, _adfSchemaGenerator.adfNode)('media').define({
       },
       url: {
         type: 'string',
-        default: null,
-        optional: false
+        default: null
       }
     }]
   }

package/dist/es2019/next-schema/full-schema.adf.js

@@ -3,9 +3,19 @@ import { blockGroup } from './groups/blockGroup';
 import { layoutSection } from './nodes/layoutSection';
 import { blockRootOnlyGroup } from './groups/blockRootOnlyGroup';
 import { blockContentGroup } from './groups/blockContentGroup';
+import { codeBlock } from './nodes/codeBlock';
+import { expand } from './nodes/expand';
 const doc = adfNode('doc').define({
   root: true,
   version: 1,
-  content: [$onePlus($or(blockGroup, blockContentGroup, layoutSection, layoutSection.use('full'), blockRootOnlyGroup))]
+  content: [$onePlus($or(blockGroup, blockContentGroup, codeBlock.use('with_marks'), layoutSection, layoutSection.use('full'), layoutSection.use('with_single_column'), blockRootOnlyGroup, expand.use('with_breakout_mark')))],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.content.minItems': {
+        remove: true,
+        reason: "@DSLCompatibilityException - The content expression and minItems don't match in the current validator schema."
+      }
+    }
+  }
 });
 export default doc;

package/dist/es2019/next-schema/generated/nodeTypes.js

@@ -491,6 +491,11 @@ export const layoutSectionFull = createPMNodeSpecFactory({
   marks: 'unsupportedNodeAttribute unsupportedMark',
   isolating: true
 });
+export const layoutSectionWithSingleColumn = createPMNodeSpecFactory({
+  content: '(layoutColumn | unsupportedBlock){1,3}',
+  marks: 'unsupportedNodeAttribute unsupportedMark',
+  isolating: true
+});
 export const listItem = createPMNodeSpecFactory({
   content: '(codeBlock | paragraph | mediaSingle | unsupportedBlock) (codeBlock | paragraph | mediaSingle | taskList | bulletList | orderedList | unsupportedBlock)*',
   marks: 'unsupportedNodeAttribute unsupportedMark',

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

@@ -22,6 +22,9 @@ export const layoutSection = adfNode('layoutSection').define({
       }
     }
   }
+}).variant('with_single_column', {
+  content: [$range(1, 3, $or(layoutColumn, unsupportedBlock))],
+  ignore: ['json-schema']
 }).variant('full', {
   marks: [breakout, unsupportedNodeAttribute, unsupportedMark],
   content: [$range(2, 3, $or(layoutColumn, unsupportedBlock))],

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

@@ -102,8 +102,7 @@ export const media = adfNode('media').define({
       },
       url: {
         type: 'string',
-        default: null,
-        optional: false
+        default: null
       }
     }]
   }

package/dist/esm/next-schema/full-schema.adf.js

@@ -3,9 +3,19 @@ import { blockGroup } from './groups/blockGroup';
 import { layoutSection } from './nodes/layoutSection';
 import { blockRootOnlyGroup } from './groups/blockRootOnlyGroup';
 import { blockContentGroup } from './groups/blockContentGroup';
+import { codeBlock } from './nodes/codeBlock';
+import { expand } from './nodes/expand';
 var doc = adfNode('doc').define({
   root: true,
   version: 1,
-  content: [$onePlus($or(blockGroup, blockContentGroup, layoutSection, layoutSection.use('full'), blockRootOnlyGroup))]
+  content: [$onePlus($or(blockGroup, blockContentGroup, codeBlock.use('with_marks'), layoutSection, layoutSection.use('full'), layoutSection.use('with_single_column'), blockRootOnlyGroup, expand.use('with_breakout_mark')))],
+  DANGEROUS_MANUAL_OVERRIDE: {
+    'validator-spec': {
+      'props.content.minItems': {
+        remove: true,
+        reason: "@DSLCompatibilityException - The content expression and minItems don't match in the current validator schema."
+      }
+    }
+  }
 });
 export default doc;

package/dist/esm/next-schema/generated/nodeTypes.js

@@ -491,6 +491,11 @@ export var layoutSectionFull = createPMNodeSpecFactory({
   marks: 'unsupportedNodeAttribute unsupportedMark',
   isolating: true
 });
+export var layoutSectionWithSingleColumn = createPMNodeSpecFactory({
+  content: '(layoutColumn | unsupportedBlock){1,3}',
+  marks: 'unsupportedNodeAttribute unsupportedMark',
+  isolating: true
+});
 export var listItem = createPMNodeSpecFactory({
   content: '(codeBlock | paragraph | mediaSingle | unsupportedBlock) (codeBlock | paragraph | mediaSingle | taskList | bulletList | orderedList | unsupportedBlock)*',
   marks: 'unsupportedNodeAttribute unsupportedMark',

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

@@ -22,6 +22,9 @@ export var layoutSection = adfNode('layoutSection').define({
       }
     }
   }
+}).variant('with_single_column', {
+  content: [$range(1, 3, $or(layoutColumn, unsupportedBlock))],
+  ignore: ['json-schema']
 }).variant('full', {
   marks: [breakout, unsupportedNodeAttribute, unsupportedMark],
   content: [$range(2, 3, $or(layoutColumn, unsupportedBlock))],

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

@@ -102,8 +102,7 @@ export var media = adfNode('media').define({
       },
       url: {
         type: 'string',
-        default: null,
-        optional: false
+        default: null
       }
     }]
   }

package/dist/types/next-schema/generated/nodeTypes.d.ts

@@ -162,7 +162,7 @@ export type DecisionListNode = PMNode & DecisionListDefinition;
 export declare const decisionList: ({ parseDOM, toDOM, toDebugString }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<DecisionListNode>) => import("prosemirror-model").NodeSpec;
 export interface DocDefinition {
     type: 'doc';
-    content: Array<BlockDefinition | BlockRootOnlyDefinition | LayoutSectionDefinition | LayoutSectionFullDefinition>;
+    content: Array<BlockDefinition | BlockRootOnlyDefinition | LayoutSectionDefinition | LayoutSectionFullDefinition | LayoutSectionWithSingleColumnDefinition>;
 }
 export type DocNode = PMNode & DocDefinition;
 export declare const doc: ({ parseDOM, toDOM, toDebugString }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<DocNode>) => import("prosemirror-model").NodeSpec;
@@ -367,6 +367,13 @@ export interface LayoutSectionFullDefinition {
 }
 export type LayoutSectionFullNode = PMNode & LayoutSectionFullDefinition;
 export declare const layoutSectionFull: ({ parseDOM, toDOM, toDebugString }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<LayoutSectionFullNode>) => import("prosemirror-model").NodeSpec;
+export interface LayoutSectionWithSingleColumnDefinition {
+    type: 'layoutSection';
+    content: Array<LayoutColumnDefinition | UnsupportedBlockDefinition>;
+    marks: Array<BreakoutMark | UnsupportedMarkMark | UnsupportedNodeAttributeMark>;
+}
+export type LayoutSectionWithSingleColumnNode = PMNode & LayoutSectionWithSingleColumnDefinition;
+export declare const layoutSectionWithSingleColumn: ({ parseDOM, toDOM, toDebugString }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<LayoutSectionWithSingleColumnNode>) => import("prosemirror-model").NodeSpec;
 export interface ListItemDefinition {
     type: 'listItem';
     content: Array<BulletListDefinition | CodeBlockWithNoMarksDefinition | CodeBlockWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | MediaSingleFullDefinition | OrderedListDefinition | ParagraphWithNoMarksDefinition | ParagraphWithNoMarksDefinition | TaskListDefinition | UnsupportedBlockDefinition | UnsupportedBlockDefinition>;

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

@@ -1,4 +1,4 @@
-export declare const layoutSection: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "full"], {
+export declare const layoutSection: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_single_column", "full"], {
     ignore?: import("@atlaskit/adf-schema-generator/dist/types/transforms/transformerNames").TransformerNames[];
     root?: boolean;
     atom?: boolean;
@@ -27,6 +27,9 @@ export declare const layoutSection: import("@atlaskit/adf-schema-generator/dist/
         'pm-spec'?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").DangerousManualOverride;
         'validator-spec'?: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").DangerousManualOverride;
     };
+} & {
+    content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentRangeSpec[];
+    ignore: "json-schema"[];
 } & {
     marks: import("@atlaskit/adf-schema-generator/dist/types/adfMark").ADFMark<import("@atlaskit/adf-schema-generator/dist/types/types/ADFMarkSpec").ADFMarkSpec>[];
     content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentRangeSpec[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "37.1.32",
+  "version": "37.1.33",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -47,7 +47,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.16.0",
-    "@atlaskit/adf-schema-generator": "^1.25.5",
+    "@atlaskit/adf-schema-generator": "^1.25.6",
     "@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

@@ -5,7 +5,6 @@ import adfNode from '../../../src/next-schema/full-schema.adf';
 const newSpecs = sortNestedArrays(adfToValidatorSpec(adfNode));
 const SKIP_LIST = [
   'codeBlock', // doesn't match existing spec
-  'doc', // doesn't match existing spec, need to flatten groups
   'inline_comment_marker', // doesn't exist in the output
   'layoutSection_full', // doesn't match existing spec, allowUnsupportedBlock, extra marks
   'layoutSection_with_single_column', // doesn't exist in the output