@atlaskit/adf-schema 42.3.1 → 42.5.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/adf-schema
 
+## 42.5.0
+
+### Minor Changes
+
+- 82af32e: Remove exception for minItems=0 from caption node, aligning JSON schema and Validator Spec with PM Spec
+
+## 42.4.0
+
+### Minor Changes
+
+- 6114d78: add attr.text to hr, in order to match it with json schema spec
+- 844e6bd: Filter out empty content groups in json and validator spec and improve min and max item calculation
+
 ## 42.3.1
 
 ### Patch Changes

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

@@ -397,6 +397,11 @@ var extensionFrameStage0 = exports.extensionFrameStage0 = (0, _createPMSpecFacto
 var hardBreak = exports.hardBreak = (0, _createPMSpecFactory.createPMNodeSpecFactory)({
   group: 'inline',
   inline: true,
+  attrs: {
+    text: {
+      default: '\n'
+    }
+  },
   selectable: false,
   linebreakReplacement: true
 });

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

@@ -21,17 +21,5 @@ var caption = exports.caption = (0, _adfSchemaGenerator.adfNode)('caption').defi
   selectable: false,
   marks: [_unsupportedMark.unsupportedMark, _unsupportedNodeAttribute.unsupportedNodeAttribute],
   allowAnyChildMark: true,
-  content: [(0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_hardBreak.hardBreak, _mention.mention, _emoji.emoji, _date.date, _placeholder.placeholder, _inlineCard.inlineCard, _status.status, _text.text.use('formatted'), _text.text.use('code_inline'), _unsupportedInline.unsupportedInline))],
-  DANGEROUS_MANUAL_OVERRIDE: {
-    'validator-spec': {
-      'props.content.optional': {
-        reason: '@DSLCompatibilityException - mismatch for caption',
-        remove: true
-      },
-      'props.content.minItems': {
-        reason: '@DSLCompatibilityException - mismatch for caption',
-        value: 0
-      }
-    }
-  }
+  content: [(0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_hardBreak.hardBreak, _mention.mention, _emoji.emoji, _date.date, _placeholder.placeholder, _inlineCard.inlineCard, _status.status, _text.text.use('formatted'), _text.text.use('code_inline'), _unsupportedInline.unsupportedInline))]
 });

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

@@ -30,7 +30,7 @@ var layoutSection = exports.layoutSection = (0, _adfSchemaGenerator.adfNode)('la
   }
 }).variant('with_single_column', {
   stage0: true,
-  content: [(0, _adfSchemaGenerator.$range)(1, 5, (0, _adfSchemaGenerator.$or)(_layoutColumn.layoutColumn, _unsupportedBlock.unsupportedBlock))],
+  content: [(0, _adfSchemaGenerator.$range)(1, 5, (0, _adfSchemaGenerator.$or)(_layoutColumn.layoutColumn, _unsupportedBlock.unsupportedBlock)), (0, _adfSchemaGenerator.$zeroPlus)((0, _adfSchemaGenerator.$or)(_unsupportedBlock.unsupportedBlock))],
   ignore: [],
   attrs: {
     columnRuleStyle: {
@@ -41,12 +41,6 @@ var layoutSection = exports.layoutSection = (0, _adfSchemaGenerator.adfNode)('la
     }
   },
   DANGEROUS_MANUAL_OVERRIDE: {
-    'pm-spec': {
-      content: {
-        value: '(layoutColumn | unsupportedBlock){1,5} unsupportedBlock*',
-        reason: "The content expression is not correct or redundant around 'unsupportedBlock*'. This case is not supported by the DSL. Also in JSON schema there is no range for the items, so theres a mismatch between JSON and PM."
-      }
-    },
     'validator-spec': {
       'props.type': {
         value: {

package/dist/cjs/validator-schema/generated/validatorSpec.js

@@ -669,8 +669,8 @@ var caption = exports.caption = {
     content: {
       type: 'array',
       items: [['hardBreak', 'mention', 'emoji', 'date', 'placeholder', 'inlineCard', 'status', 'text_formatted', 'text_code_inline']],
-      allowUnsupportedInline: true,
-      minItems: 0
+      optional: true,
+      allowUnsupportedInline: true
     }
   }
 };

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

@@ -391,6 +391,11 @@ export const extensionFrameStage0 = createPMNodeSpecFactory({
 export const hardBreak = createPMNodeSpecFactory({
   group: 'inline',
   inline: true,
+  attrs: {
+    text: {
+      default: '\n'
+    }
+  },
   selectable: false,
   linebreakReplacement: true
 });

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

@@ -15,17 +15,5 @@ export const caption = adfNode('caption').define({
   selectable: false,
   marks: [unsupportedMark, unsupportedNodeAttribute],
   allowAnyChildMark: true,
-  content: [$zeroPlus($or(hardBreak, mention, emoji, date, placeholder, inlineCard, status, text.use('formatted'), text.use('code_inline'), unsupportedInline))],
-  DANGEROUS_MANUAL_OVERRIDE: {
-    'validator-spec': {
-      'props.content.optional': {
-        reason: '@DSLCompatibilityException - mismatch for caption',
-        remove: true
-      },
-      'props.content.minItems': {
-        reason: '@DSLCompatibilityException - mismatch for caption',
-        value: 0
-      }
-    }
-  }
+  content: [$zeroPlus($or(hardBreak, mention, emoji, date, placeholder, inlineCard, status, text.use('formatted'), text.use('code_inline'), unsupportedInline))]
 });

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

@@ -1,4 +1,4 @@
-import { $or, $range, adfNode } from '@atlaskit/adf-schema-generator';
+import { $or, $range, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
 import { breakout } from '../marks/breakout';
 import { unsupportedMark } from '../marks/unsupportedMark';
 import { unsupportedNodeAttribute } from '../marks/unsupportedNodeAttribute';
@@ -24,7 +24,7 @@ export const layoutSection = adfNode('layoutSection').define({
   }
 }).variant('with_single_column', {
   stage0: true,
-  content: [$range(1, 5, $or(layoutColumn, unsupportedBlock))],
+  content: [$range(1, 5, $or(layoutColumn, unsupportedBlock)), $zeroPlus($or(unsupportedBlock))],
   ignore: [],
   attrs: {
     columnRuleStyle: {
@@ -35,12 +35,6 @@ export const layoutSection = adfNode('layoutSection').define({
     }
   },
   DANGEROUS_MANUAL_OVERRIDE: {
-    'pm-spec': {
-      content: {
-        value: '(layoutColumn | unsupportedBlock){1,5} unsupportedBlock*',
-        reason: `The content expression is not correct or redundant around 'unsupportedBlock*'. This case is not supported by the DSL. Also in JSON schema there is no range for the items, so theres a mismatch between JSON and PM.`
-      }
-    },
     'validator-spec': {
       'props.type': {
         value: {

package/dist/es2019/validator-schema/generated/validatorSpec.js

@@ -663,8 +663,8 @@ export const caption = {
     content: {
       type: 'array',
       items: [['hardBreak', 'mention', 'emoji', 'date', 'placeholder', 'inlineCard', 'status', 'text_formatted', 'text_code_inline']],
-      allowUnsupportedInline: true,
-      minItems: 0
+      optional: true,
+      allowUnsupportedInline: true
     }
   }
 };

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

@@ -391,6 +391,11 @@ export var extensionFrameStage0 = createPMNodeSpecFactory({
 export var hardBreak = createPMNodeSpecFactory({
   group: 'inline',
   inline: true,
+  attrs: {
+    text: {
+      default: '\n'
+    }
+  },
   selectable: false,
   linebreakReplacement: true
 });

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

@@ -15,17 +15,5 @@ export var caption = adfNode('caption').define({
   selectable: false,
   marks: [unsupportedMark, unsupportedNodeAttribute],
   allowAnyChildMark: true,
-  content: [$zeroPlus($or(hardBreak, mention, emoji, date, placeholder, inlineCard, status, text.use('formatted'), text.use('code_inline'), unsupportedInline))],
-  DANGEROUS_MANUAL_OVERRIDE: {
-    'validator-spec': {
-      'props.content.optional': {
-        reason: '@DSLCompatibilityException - mismatch for caption',
-        remove: true
-      },
-      'props.content.minItems': {
-        reason: '@DSLCompatibilityException - mismatch for caption',
-        value: 0
-      }
-    }
-  }
+  content: [$zeroPlus($or(hardBreak, mention, emoji, date, placeholder, inlineCard, status, text.use('formatted'), text.use('code_inline'), unsupportedInline))]
 });

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

@@ -1,4 +1,4 @@
-import { $or, $range, adfNode } from '@atlaskit/adf-schema-generator';
+import { $or, $range, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
 import { breakout } from '../marks/breakout';
 import { unsupportedMark } from '../marks/unsupportedMark';
 import { unsupportedNodeAttribute } from '../marks/unsupportedNodeAttribute';
@@ -24,7 +24,7 @@ export var layoutSection = adfNode('layoutSection').define({
   }
 }).variant('with_single_column', {
   stage0: true,
-  content: [$range(1, 5, $or(layoutColumn, unsupportedBlock))],
+  content: [$range(1, 5, $or(layoutColumn, unsupportedBlock)), $zeroPlus($or(unsupportedBlock))],
   ignore: [],
   attrs: {
     columnRuleStyle: {
@@ -35,12 +35,6 @@ export var layoutSection = adfNode('layoutSection').define({
     }
   },
   DANGEROUS_MANUAL_OVERRIDE: {
-    'pm-spec': {
-      content: {
-        value: '(layoutColumn | unsupportedBlock){1,5} unsupportedBlock*',
-        reason: "The content expression is not correct or redundant around 'unsupportedBlock*'. This case is not supported by the DSL. Also in JSON schema there is no range for the items, so theres a mismatch between JSON and PM."
-      }
-    },
     'validator-spec': {
       'props.type': {
         value: {

package/dist/esm/validator-schema/generated/validatorSpec.js

@@ -663,8 +663,8 @@ export var caption = {
     content: {
       type: 'array',
       items: [['hardBreak', 'mention', 'emoji', 'date', 'placeholder', 'inlineCard', 'status', 'text_formatted', 'text_code_inline']],
-      allowUnsupportedInline: true,
-      minItems: 0
+      optional: true,
+      allowUnsupportedInline: true
     }
   }
 };

package/dist/json-schema/v1/full.json

@@ -840,12 +840,11 @@
                 "$ref": "#/definitions/code_inline_node"
               }
             ]
-          },
-          "minItems": 0
+          }
         }
       },
       "additionalProperties": false,
-      "required": ["type", "content"]
+      "required": ["type"]
     },
     "mediaSingle_caption_node": {
       "allOf": [

package/dist/json-schema/v1/stage-0.json

@@ -870,12 +870,11 @@
                 "$ref": "#/definitions/code_inline_node"
               }
             ]
-          },
-          "minItems": 0
+          }
         }
       },
       "additionalProperties": false,
-      "required": ["type", "content"]
+      "required": ["type"]
     },
     "mediaSingle_caption_node": {
       "allOf": [

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

@@ -419,7 +419,7 @@ export type LayoutSectionFullNode = PMNode & LayoutSectionFullDefinition;
 export declare const layoutSectionFull: ({ parseDOM, toDOM, toDebugString }: import("../../schema/createPMSpecFactory").NodeSpecOptions<LayoutSectionFullNode>) => import("prosemirror-model").NodeSpec;
 export interface LayoutSectionWithSingleColumnStage0Definition {
     type: 'layoutSection';
-    content: Array<LayoutColumnDefinition | UnsupportedBlockDefinition>;
+    content: Array<LayoutColumnDefinition | UnsupportedBlockDefinition | UnsupportedBlockDefinition>;
     marks: Array<BreakoutMark | UnsupportedMarkMark | UnsupportedNodeAttributeMark>;
     attrs: {
         columnRuleStyle?: 'solid';

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

@@ -1,6 +1,6 @@
 export declare const layoutSection: import("@atlaskit/adf-schema-generator/dist/types/adfNode").ADFNode<[string, "with_single_column", "full"], import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFCommonNodeSpec & {
     stage0: true;
-    content: import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentRangeSpec[];
+    content: (import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentZeroOrMoreSpec | import("@atlaskit/adf-schema-generator/dist/types/types/ADFNodeSpec").ADFNodeContentRangeSpec)[];
     ignore: any[];
     attrs: {
         columnRuleStyle: {
@@ -11,12 +11,6 @@ export declare const layoutSection: import("@atlaskit/adf-schema-generator/dist/
         };
     };
     DANGEROUS_MANUAL_OVERRIDE: {
-        'pm-spec': {
-            content: {
-                value: string;
-                reason: string;
-            };
-        };
         'validator-spec': {
             'props.type': {
                 value: {

package/dist/types/validator-schema/generated/validatorSpec.d.ts

@@ -682,8 +682,8 @@ export declare const caption: {
         content: {
             type: string;
             items: string[][];
+            optional: boolean;
             allowUnsupportedInline: boolean;
-            minItems: number;
         };
     };
 };

package/json-schema/v1/full.json

@@ -840,12 +840,11 @@
                 "$ref": "#/definitions/code_inline_node"
               }
             ]
-          },
-          "minItems": 0
+          }
         }
       },
       "additionalProperties": false,
-      "required": ["type", "content"]
+      "required": ["type"]
     },
     "mediaSingle_caption_node": {
       "allOf": [

package/json-schema/v1/stage-0.json

@@ -870,12 +870,11 @@
                 "$ref": "#/definitions/code_inline_node"
               }
             ]
-          },
-          "minItems": 0
+          }
         }
       },
       "additionalProperties": false,
-      "required": ["type", "content"]
+      "required": ["type"]
     },
     "mediaSingle_caption_node": {
       "allOf": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "42.3.1",
+  "version": "42.5.0",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -46,7 +46,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.22.0",
-    "@atlaskit/adf-schema-generator": "^1.33.0",
+    "@atlaskit/adf-schema-generator": "^1.35.0",
     "@atlaskit/codemod-utils": "^4.2.4",
     "@babel/cli": "^7.22.9",
     "@babel/core": "^7.22.9",