@atlaskit/adf-schema 36.18.3 → 37.0.1

package/dist/types/schema/index.d.ts

@@ -1,4 +1,4 @@
-export { PanelType, blockCard, blockquote, blockquoteWithList, bodiedExtension, bulletList, bulletListSelector, caption, codeBlock, codeBlockToJSON, confluenceJiraIssue, confluenceUnsupportedBlock, confluenceUnsupportedInline, copyPrivateMediaAttributes, date, decisionItem, decisionList, decisionListSelector, doc, embedCard, emoji, expand, expandToJSON, extension, hardBreak, heading, headingNodeSpec, headingStage0, image, inlineCard, inlineExtension, layoutColumn, layoutSection, layoutSectionWithSingleColumn, listItem, listItemWithTask, media, mediaGroup, mediaSingle, mediaSingleSpec, mediaInline, mediaSingleWithCaption, mediaSingleWithWidthType, mediaSingleFull, mediaSingleToJSON, mediaToJSON, mention, mentionToJSON, nestedExpand, orderedList, orderedListSelector, orderedListWithOrder, panel, extendedPanel, paragraph, paragraphStage0, paragraphNodeSpec, placeholder, rule, getCellAttrs, getCellDomAttrs, status, table, tableStage0, tableWithCustomWidth, tableBackgroundBorderColor, tableBackgroundColorNames, tableBackgroundColorPalette, tableCell, tableCellContentDomSelector, tableCellContentWrapperSelector, tableCellSelector, tableHeader, tableHeaderSelector, tablePrefixSelector, tableRow, tableToJSON, taskItem, taskList, taskListSelector, text, toJSONTableCell, toJSONTableHeader, unknownBlock, unsupportedBlock, unsupportedInline, extensionFrame, multiBodiedExtension, } from './nodes';
+export { PanelType, blockCard, blockquote, blockquoteWithList, bodiedExtension, bulletList, bulletListSelector, caption, codeBlock, codeBlockToJSON, confluenceJiraIssue, confluenceUnsupportedBlock, confluenceUnsupportedInline, copyPrivateMediaAttributes, date, decisionItem, decisionList, decisionListSelector, doc, embedCard, emoji, expand, expandToJSON, extension, hardBreak, heading, image, inlineCard, inlineExtension, layoutColumn, layoutSection, layoutSectionWithSingleColumn, listItem, listItemWithTask, media, mediaGroup, mediaSingle, mediaSingleSpec, mediaInline, mediaSingleWithCaption, mediaSingleWithWidthType, mediaSingleFull, mediaSingleToJSON, mediaToJSON, mention, mentionToJSON, nestedExpand, orderedList, orderedListSelector, orderedListWithOrder, panel, extendedPanel, paragraph, placeholder, rule, getCellAttrs, getCellDomAttrs, status, table, tableStage0, tableWithCustomWidth, tableBackgroundBorderColor, tableBackgroundColorNames, tableBackgroundColorPalette, tableCell, tableCellContentDomSelector, tableCellContentWrapperSelector, tableCellSelector, tableHeader, tableHeaderSelector, tablePrefixSelector, tableRow, tableToJSON, taskItem, taskList, taskListSelector, text, toJSONTableCell, toJSONTableHeader, unknownBlock, unsupportedBlock, unsupportedInline, extensionFrame, multiBodiedExtension, } from './nodes';
 export type { BlockCardDefinition, BlockContent, BlockQuoteDefinition, BodiedExtensionDefinition, BulletListDefinition, CaptionDefinition, CardAttributes, CellAttributes, CodeBlockAttrs, CodeBlockBaseDefinition, CodeBlockDefinition, CodeBlockWithMarksDefinition, DatasourceAttributes, DatasourceAttributeProperties, DataType, DateDefinition, DecisionItemDefinition, DecisionListDefinition, DocNode, EmbedCardDefinition, EmbedCardAttributes, EmojiAttributes, EmojiDefinition, ExpandDefinition, ExtensionDefinition, ExtensionLayout, ExternalMediaAttributes, HardBreakDefinition, HeadingBaseDefinition, HeadingDefinition, HeadingWithAlignmentDefinition, HeadingWithIndentationDefinition, HeadingWithMarksDefinition, Inline, InlineAtomic, InlineCardDefinition, InlineCode, InlineExtensionDefinition, InlineFormattedText, InlineLinkText, LayoutColumnDefinition, LayoutSectionDefinition, LayoutSectionBaseDefinition, LayoutSectionFullDefinition, LayoutSectionWithSingleColumnDefinition, ListItemArray, ListItemDefinition, MarksObject, MediaADFAttrs, MediaAttributes, MediaInlineAttributes, MediaInlineDefinition, MediaBaseAttributes, MediaDefinition, MediaDisplayType, MediaGroupDefinition, MediaSingleDefinition, MediaType, MentionAttributes, MentionDefinition, MentionUserType, NestedExpandContent, NestedExpandDefinition, NoMark, NonNestableBlockContent, OrderedListDefinition, PanelAttributes, PanelDefinition, ParagraphBaseDefinition, ParagraphDefinition, ParagraphWithAlignmentDefinition, ParagraphWithIndentationDefinition, ParagraphWithMarksDefinition, PlaceholderDefinition, RuleDefinition, StatusDefinition, TableAttributes, TableCellDefinition, TableDefinition, TableDisplayMode, TableHeaderDefinition, TableLayout, TableRowDefinition, TaskItemDefinition, TaskListContent, TaskListDefinition, TextDefinition, UrlType, RichMediaAttributes, ExtendedMediaAttributes, RichMediaLayout, CellDomAttrs, ExtensionFrameDefinition, MultiBodiedExtensionDefinition, } from './nodes';
 export { AnnotationTypes, alignment, alignmentPositionMap, annotation, breakout, code, colorPalette, 
 /** @deprecated [ED-15849] The extended palette is now rolled into the main one. Use `colorPalette` instead. */

package/dist/types/schema/nodes/heading.d.ts

@@ -19,7 +19,7 @@ export interface HeadingBaseDefinition {
          */
         level: number;
         /**
-         * @stage 0
+         * An optional UUID for unique identification of the node
          */
         localId?: string;
     };
@@ -37,6 +37,4 @@ export type HeadingWithAlignmentDefinition = HeadingBaseDefinition & MarksObject
  */
 export type HeadingWithIndentationDefinition = HeadingBaseDefinition & MarksObject<IndentationMarkDefinition>;
 export type HeadingWithMarksDefinition = HeadingWithAlignmentDefinition | HeadingWithIndentationDefinition;
-export declare const headingStage0: NodeSpec;
 export declare const heading: NodeSpec;
-export declare const headingNodeSpec: (adfStage?: string) => NodeSpec;

package/dist/types/schema/nodes/index.d.ts

@@ -14,13 +14,13 @@ export { codeBlock, toJSON as codeBlockToJSON } from './code-block';
 export type { CodeBlockDefinition, CodeBlockAttrs, CodeBlockBaseDefinition, CodeBlockWithMarksDefinition, } from './code-block';
 export { hardBreak } from './hard-break';
 export type { HardBreakDefinition } from './hard-break';
-export { headingNodeSpec, heading, headingStage0 } from './heading';
+export { heading } from './heading';
 export type { HeadingDefinition, HeadingBaseDefinition, HeadingWithAlignmentDefinition, HeadingWithIndentationDefinition, HeadingWithMarksDefinition, } from './heading';
 export { rule } from './rule';
 export type { RuleDefinition } from './rule';
 export { orderedList, orderedListSelector, orderedListWithOrder, } from './ordered-list';
 export type { OrderedListDefinition } from './types/list';
-export { paragraph, paragraphStage0, paragraphNodeSpec } from './paragraph';
+export { paragraph } from './paragraph';
 export type { ParagraphDefinition, ParagraphBaseDefinition, ParagraphWithAlignmentDefinition, ParagraphWithIndentationDefinition, ParagraphWithMarksDefinition, } from './paragraph';
 export { emoji } from './emoji';
 export type { EmojiAttributes, EmojiDefinition } from './emoji';

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

@@ -4,7 +4,7 @@ import { MarksObject, NoMark } from './types/mark';
 import { Inline } from './types/inline-content';
 export interface ParagraphAttributes {
     /**
-     * @stage 0
+     * An optional UUID for unique identification of the node
      */
     localId?: string;
 }
@@ -17,9 +17,6 @@ export interface ParagraphBaseDefinition {
      * @allowUnsupportedInline true
      */
     content?: Array<Inline>;
-    /**
-     * @stage 0
-     */
     attrs?: ParagraphAttributes;
     marks?: Array<any>;
 }
@@ -44,6 +41,4 @@ export type ParagraphWithAlignmentDefinition = ParagraphBaseDefinition & MarksOb
  */
 export type ParagraphWithIndentationDefinition = ParagraphBaseDefinition & MarksObject<IndentationMarkDefinition>;
 export type ParagraphWithMarksDefinition = ParagraphWithAlignmentDefinition | ParagraphWithIndentationDefinition;
-export declare const paragraphStage0: NodeSpec;
 export declare const paragraph: NodeSpec;
-export declare const paragraphNodeSpec: (adfStage?: string) => NodeSpec;

package/json-schema/v1/full.json

@@ -1226,6 +1226,15 @@
             "$ref": "#/definitions/inline_node"
           }
         },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "localId": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        },
         "marks": {
           "type": "array"
         }
@@ -1705,6 +1714,9 @@
               "type": "number",
               "minimum": 1,
               "maximum": 6
+            },
+            "localId": {
+              "type": "string"
             }
           },
           "required": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "36.18.3",
+  "version": "37.0.1",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -43,8 +43,8 @@
     "memoize-one": "^6.0.0"
   },
   "devDependencies": {
-    "@atlassian/adf-schema-json": "^1.15.0",
-    "@atlaskit/adf-schema-generator": "^1.17.2",
+    "@atlassian/adf-schema-json": "^1.16.0",
+    "@atlaskit/adf-schema-generator": "^1.17.3",
     "@atlaskit/codemod-utils": "^4.2.4",
     "@atlaskit/json-schema-generator": "^3.3.9",
     "@babel/cli": "^7.22.9",

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

@@ -64,6 +64,7 @@ const paragraph = {
       optional: true,
     },
     marks: { type: 'array', items: [], optional: true },
+    attrs: { props: { localId: { type: 'string', optional: true } } },
   },
 };
 
@@ -142,6 +143,11 @@ const heading = {
       optional: true,
     },
     marks: { type: 'array', items: [], optional: true },
-    attrs: { props: { level: { type: 'number', minimum: 1, maximum: 6 } } },
+    attrs: {
+      props: {
+        level: { type: 'number', minimum: 1, maximum: 6 },
+        localId: { type: 'string', optional: true },
+      },
+    },
   },
 };

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

@@ -822,6 +822,9 @@ const jsonWithTypes = {
               minimum: 1,
               type: 'number',
             },
+            localId: {
+              type: 'string',
+            },
           },
           required: ['level'],
           type: 'object',
@@ -1480,6 +1483,15 @@ const jsonWithTypes = {
         type: {
           enum: ['paragraph'],
         },
+        attrs: {
+          additionalProperties: false,
+          properties: {
+            localId: {
+              type: 'string',
+            },
+          },
+          type: 'object',
+        },
       },
       required: ['type'],
       type: 'object',