@atlaskit/adf-schema 36.11.0 → 36.12.1

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

@@ -1,7 +1,7 @@
-import { $or, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
 import { tableCell } from './tableCell';
 import { tableHeader } from './tableHeader';
 export var tableRow = adfNode('tableRow').define({
   selectable: false,
-  content: [$zeroPlus($or(tableCell, tableHeader))]
+  content: [$onePlus($or(tableCell, tableHeader))]
 });

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

@@ -79,12 +79,6 @@ export interface MediaDefinition {
 }
 export type MediaNode = PMNode & MediaDefinition;
 export declare const media: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<MediaNode>) => import("prosemirror-model").NodeSpec;
-export interface TextFormattedDefinition {
-    type: 'text';
-    marks: Array<LinkMark | EmMark | StrongMark | StrikeMark | SubsupMark | UnderlineMark | TextColorMark | AnnotationMark | BackgroundColorMark>;
-}
-export type TextFormattedNode = PMNode & TextFormattedDefinition;
-export declare const textFormatted: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<TextFormattedNode>) => import("prosemirror-model").NodeSpec;
 export interface HardBreakDefinition {
     type: 'hardBreak';
     attrs: {
@@ -150,9 +144,21 @@ export interface StatusDefinition {
 }
 export type StatusNode = PMNode & StatusDefinition;
 export declare const status: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<StatusNode>) => import("prosemirror-model").NodeSpec;
+export interface TextFormattedDefinition {
+    type: 'text';
+    marks: Array<LinkMark | EmMark | StrongMark | StrikeMark | SubsupMark | UnderlineMark | TextColorMark | AnnotationMark | BackgroundColorMark>;
+}
+export type TextFormattedNode = PMNode & TextFormattedDefinition;
+export declare const textFormatted: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<TextFormattedNode>) => import("prosemirror-model").NodeSpec;
+export interface TextCodeInlineDefinition {
+    type: 'text';
+    marks: Array<CodeMark | LinkMark | AnnotationMark>;
+}
+export type TextCodeInlineNode = PMNode & TextCodeInlineDefinition;
+export declare const textCodeInline: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<TextCodeInlineNode>) => import("prosemirror-model").NodeSpec;
 export interface CaptionDefinition {
     type: 'caption';
-    content: Array<TextFormattedDefinition | HardBreakDefinition | MentionDefinition | EmojiDefinition | DateDefinition | PlaceholderDefinition | InlineCardDefinition | StatusDefinition>;
+    content: Array<HardBreakDefinition | MentionDefinition | EmojiDefinition | DateDefinition | PlaceholderDefinition | InlineCardDefinition | StatusDefinition | TextFormattedDefinition | TextCodeInlineDefinition>;
 }
 export type CaptionNode = PMNode & CaptionDefinition;
 export declare const caption: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<CaptionNode>) => import("prosemirror-model").NodeSpec;
@@ -179,12 +185,6 @@ export interface MediaSingleFullDefinition {
 }
 export type MediaSingleFullNode = PMNode & MediaSingleFullDefinition;
 export declare const mediaSingleFull: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<MediaSingleFullNode>) => import("prosemirror-model").NodeSpec;
-export interface TextCodeInlineDefinition {
-    type: 'text';
-    marks: Array<CodeMark | LinkMark | AnnotationMark>;
-}
-export type TextCodeInlineNode = PMNode & TextCodeInlineDefinition;
-export declare const textCodeInline: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<TextCodeInlineNode>) => import("prosemirror-model").NodeSpec;
 export interface InlineExtensionDefinition {
     type: 'inlineExtension';
     attrs: {
@@ -380,15 +380,9 @@ export interface RuleDefinition {
 }
 export type RuleNode = PMNode & RuleDefinition;
 export declare const rule: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<RuleNode>) => import("prosemirror-model").NodeSpec;
-export interface ParagraphDefinition {
-    type: 'paragraph';
-    content: Array<InlineDefinition>;
-}
-export type ParagraphNode = PMNode & ParagraphDefinition;
-export declare const paragraph: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<ParagraphNode>) => import("prosemirror-model").NodeSpec;
 export interface PanelDefinition {
     type: 'panel';
-    content: Array<ParagraphDefinition | HeadingDefinition | BulletListDefinition | OrderedListDefinition | BlockCardDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | RuleDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition>;
     attrs: {
         panelType: 'info' | 'note' | 'tip' | 'warning' | 'error' | 'success' | 'custom';
         panelIcon?: string;
@@ -419,19 +413,19 @@ export interface HeadingWithIndentationDefinition {
 }
 export type HeadingWithIndentationNode = PMNode & HeadingWithIndentationDefinition;
 export declare const headingWithIndentation: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<HeadingWithIndentationNode>) => import("prosemirror-model").NodeSpec;
-export interface NestedExpandDefinition {
+export interface NestedExpandWithNoMarksDefinition {
     type: 'nestedExpand';
-    content: Array<ParagraphDefinition | HeadingDefinition | MediaSingleDefinition | MediaGroupDefinition | CodeBlockDefinition | BulletListDefinition | OrderedListDefinition | TaskListDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition>;
     attrs: {
         title?: string;
         __expanded?: boolean;
     };
 }
-export type NestedExpandNode = PMNode & NestedExpandDefinition;
-export declare const nestedExpand: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<NestedExpandNode>) => import("prosemirror-model").NodeSpec;
+export type NestedExpandWithNoMarksNode = PMNode & NestedExpandWithNoMarksDefinition;
+export declare const nestedExpandWithNoMarks: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<NestedExpandWithNoMarksNode>) => import("prosemirror-model").NodeSpec;
 export interface TableCellDefinition {
     type: 'tableCell';
-    content: Array<PanelDefinition | ParagraphDefinition | BlockquoteDefinition | OrderedListDefinition | BulletListDefinition | RuleDefinition | HeadingDefinition | HeadingWithAlignmentDefinition | HeadingWithIndentationDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | ExtensionDefinition | BlockCardDefinition | NestedExpandDefinition | EmbedCardDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | ParagraphWithAlignmentDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | HeadingWithAlignmentDefinition | HeadingWithIndentationDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition | ExtensionWithMarksDefinition | EmbedCardDefinition | NestedExpandWithNoMarksDefinition>;
     attrs: {
         colspan?: number;
         rowspan?: number;
@@ -441,19 +435,9 @@ export interface TableCellDefinition {
 }
 export type TableCellNode = PMNode & TableCellDefinition;
 export declare const tableCell: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<TableCellNode>) => import("prosemirror-model").NodeSpec;
-export interface NestedExpandWithNoMarksDefinition {
-    type: 'nestedExpand';
-    content: Array<ParagraphDefinition | HeadingDefinition | MediaSingleDefinition | MediaGroupDefinition | CodeBlockDefinition | BulletListDefinition | OrderedListDefinition | TaskListDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition>;
-    attrs: {
-        title?: string;
-        __expanded?: boolean;
-    };
-}
-export type NestedExpandWithNoMarksNode = PMNode & NestedExpandWithNoMarksDefinition;
-export declare const nestedExpandWithNoMarks: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<NestedExpandWithNoMarksNode>) => import("prosemirror-model").NodeSpec;
 export interface TableHeaderDefinition {
     type: 'tableHeader';
-    content: Array<PanelDefinition | ParagraphDefinition | BlockquoteDefinition | OrderedListDefinition | BulletListDefinition | RuleDefinition | HeadingDefinition | HeadingWithAlignmentDefinition | HeadingWithIndentationDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | ExtensionDefinition | BlockCardDefinition | NestedExpandDefinition | NestedExpandWithNoMarksDefinition | EmbedCardDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | ParagraphWithAlignmentDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | HeadingWithAlignmentDefinition | HeadingWithIndentationDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition | ExtensionWithMarksDefinition | EmbedCardDefinition | NestedExpandWithNoMarksDefinition>;
     attrs: {
         colspan?: number;
         rowspan?: number;
@@ -486,7 +470,7 @@ export type TableNode = PMNode & TableDefinition;
 export declare const table: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<TableNode>) => import("prosemirror-model").NodeSpec;
 export interface BodiedExtensionDefinition {
     type: 'bodiedExtension';
-    content: Array<PanelDefinition | ParagraphDefinition | BlockquoteDefinition | OrderedListDefinition | BulletListDefinition | RuleDefinition | HeadingDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | TableDefinition | ExtensionDefinition | BlockCardDefinition | EmbedCardDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition | ExtensionWithMarksDefinition | EmbedCardDefinition | TableDefinition>;
     attrs: {
         extensionType: string;
         extensionKey: string;
@@ -499,7 +483,7 @@ export type BodiedExtensionNode = PMNode & BodiedExtensionDefinition;
 export declare const bodiedExtension: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<BodiedExtensionNode>) => import("prosemirror-model").NodeSpec;
 export interface BodiedExtensionWithMarksDefinition {
     type: 'bodiedExtension';
-    content: Array<PanelDefinition | ParagraphDefinition | BlockquoteDefinition | OrderedListDefinition | BulletListDefinition | RuleDefinition | HeadingDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | TableDefinition | ExtensionDefinition | BlockCardDefinition | EmbedCardDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition | ExtensionWithMarksDefinition | EmbedCardDefinition | TableDefinition>;
     marks: Array<DataConsumerMark | FragmentMark>;
     attrs: {
         extensionType: string;
@@ -513,7 +497,7 @@ export type BodiedExtensionWithMarksNode = PMNode & BodiedExtensionWithMarksDefi
 export declare const bodiedExtensionWithMarks: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<BodiedExtensionWithMarksNode>) => import("prosemirror-model").NodeSpec;
 export interface ExpandDefinition {
     type: 'expand';
-    content: Array<PanelDefinition | ParagraphDefinition | BlockquoteDefinition | OrderedListDefinition | BulletListDefinition | RuleDefinition | HeadingDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | TableDefinition | ExtensionDefinition | BlockCardDefinition | EmbedCardDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition | ExtensionWithMarksDefinition | EmbedCardDefinition | TableDefinition>;
     attrs: {
         title?: string;
         __expanded?: boolean;
@@ -523,7 +507,7 @@ export type ExpandNode = PMNode & ExpandDefinition;
 export declare const expand: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<ExpandNode>) => import("prosemirror-model").NodeSpec;
 export interface ExpandWithBreakoutMarkDefinition {
     type: 'expand';
-    content: Array<PanelDefinition | ParagraphDefinition | BlockquoteDefinition | OrderedListDefinition | BulletListDefinition | RuleDefinition | HeadingDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | TableDefinition | ExtensionDefinition | BlockCardDefinition | EmbedCardDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition | ExtensionWithMarksDefinition | EmbedCardDefinition | TableDefinition>;
     marks: Array<BreakoutMark>;
     attrs: {
         title?: string;
@@ -534,7 +518,7 @@ export type ExpandWithBreakoutMarkNode = PMNode & ExpandWithBreakoutMarkDefiniti
 export declare const expandWithBreakoutMark: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<ExpandWithBreakoutMarkNode>) => import("prosemirror-model").NodeSpec;
 export interface ExpandWithNoMarkDefinition {
     type: 'expand';
-    content: Array<PanelDefinition | ParagraphDefinition | BlockquoteDefinition | OrderedListDefinition | BulletListDefinition | RuleDefinition | HeadingDefinition | CodeBlockDefinition | MediaGroupDefinition | MediaSingleDefinition | DecisionListDefinition | TaskListDefinition | TableDefinition | ExtensionDefinition | BlockCardDefinition | EmbedCardDefinition>;
+    content: Array<CodeBlockWithNoMarksDefinition | BlockCardDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition | ExtensionWithMarksDefinition | EmbedCardDefinition | TableDefinition>;
     attrs: {
         title?: string;
         __expanded?: boolean;
@@ -565,9 +549,25 @@ export interface LayoutSectionFullDefinition {
 }
 export type LayoutSectionFullNode = PMNode & LayoutSectionFullDefinition;
 export declare const layoutSectionFull: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<LayoutSectionFullNode>) => import("prosemirror-model").NodeSpec;
+export interface NestedExpandDefinition {
+    type: 'nestedExpand';
+    content: Array<CodeBlockWithNoMarksDefinition | ParagraphWithNoMarksDefinition | MediaSingleCaptionDefinition | MediaSingleFullDefinition | TaskListDefinition | BulletListDefinition | OrderedListDefinition | HeadingWithNoMarksDefinition | MediaGroupDefinition | DecisionListDefinition | RuleDefinition | PanelDefinition | BlockquoteDefinition>;
+    attrs: {
+        title?: string;
+        __expanded?: boolean;
+    };
+}
+export type NestedExpandNode = PMNode & NestedExpandDefinition;
+export declare const nestedExpand: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<NestedExpandNode>) => import("prosemirror-model").NodeSpec;
+export interface ParagraphDefinition {
+    type: 'paragraph';
+    content: Array<InlineDefinition>;
+}
+export type ParagraphNode = PMNode & ParagraphDefinition;
+export declare const paragraph: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<ParagraphNode>) => import("prosemirror-model").NodeSpec;
 export interface DocDefinition {
     type: 'doc';
-    content: Array<BlockDefinition | LayoutSectionDefinition | LayoutSectionFullDefinition>;
+    content: Array<BlockDefinition | LayoutSectionDefinition | LayoutSectionFullDefinition | NestedExpandDefinition | ParagraphDefinition>;
 }
 export type DocNode = PMNode & DocDefinition;
 export declare const doc: ({ parseDOM, toDOM }: import("@atlaskit/adf-schema-generator").NodeSpecOptions<DocNode>) => import("prosemirror-model").NodeSpec;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.11.0",
+  "version": "36.12.1",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -22,6 +22,7 @@
     "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",
+    "test:json-schema": "yarn run jest --expand --testPathPattern=packages/adf-schema/schema-generators/__tests__/unit/json-full-schema.unit.ts --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 +46,7 @@
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.15.0",
-    "@atlaskit/adf-schema-generator": "^1.10.0",
+    "@atlaskit/adf-schema-generator": "^1.10.1",
     "@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

@@ -166,3 +166,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.
+
+`additionalProperties` and `allOf` are 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(
+  .additionalProperties, .allOf, .properties.required,
+  .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
+```