@atlaskit/adf-schema 35.12.2 → 35.13.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 35.13.0
+
+### Minor Changes
+
+- cac3a5b: Add optional localId attribute to paragraph and heading nodes
+
 ## 35.12.2
 
 ### Patch Changes

package/dist/cjs/schema/nodes/heading.js

@@ -21,10 +21,19 @@ exports.heading = void 0;
  * @name heading_with_indentation_node
  */
 
+var _getAttrs = function getAttrs(level, domNode) {
+  return {
+    level: level,
+    localId: domNode.getAttribute('data-local-id') || heading.attrs.localId.default
+  };
+};
 var heading = exports.heading = {
   attrs: {
     level: {
       default: 1
+    },
+    localId: {
+      default: null
     }
   },
   content: "inline*",
@@ -33,36 +42,40 @@ var heading = exports.heading = {
   selectable: false,
   parseDOM: [{
     tag: 'h1',
-    attrs: {
-      level: 1
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(1, domNode);
     }
   }, {
     tag: 'h2',
-    attrs: {
-      level: 2
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(2, domNode);
     }
   }, {
     tag: 'h3',
-    attrs: {
-      level: 3
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(3, domNode);
     }
   }, {
     tag: 'h4',
-    attrs: {
-      level: 4
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(4, domNode);
     }
   }, {
     tag: 'h5',
-    attrs: {
-      level: 5
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(5, domNode);
     }
   }, {
     tag: 'h6',
-    attrs: {
-      level: 6
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(6, domNode);
     }
   }],
   toDOM: function toDOM(node) {
-    return ['h' + node.attrs['level'], 0];
+    var localId = node.attrs.localId;
+    var attrs = localId !== undefined ? {
+      'data-local-id': localId
+    } : undefined;
+    return ['h' + node.attrs['level'], attrs, 0];
   }
 };

package/dist/cjs/schema/nodes/paragraph.js

@@ -29,16 +29,31 @@ exports.paragraph = void 0;
  * @name paragraph_with_indentation_node
  */
 
-var pDOM = ['p', 0];
 var paragraph = exports.paragraph = {
   selectable: false,
   content: 'inline*',
   group: 'block',
+  attrs: {
+    localId: {
+      default: null
+    }
+  },
   marks: 'strong code em link border strike subsup textColor backgroundColor typeAheadQuery underline confluenceInlineComment action annotation unsupportedMark unsupportedNodeAttribute dataConsumer fragment',
   parseDOM: [{
-    tag: 'p'
+    tag: 'p',
+    getAttrs: function getAttrs(domNode) {
+      var dom = domNode;
+      var attrs = {
+        localId: dom.getAttribute('data-local-id') || paragraph.attrs.localId.default
+      };
+      return attrs;
+    }
   }],
-  toDOM: function toDOM() {
-    return pDOM;
+  toDOM: function toDOM(node) {
+    var localId = node.attrs.localId;
+    var attrs = localId !== undefined ? {
+      'data-local-id': localId
+    } : undefined;
+    return ['p', attrs, 0];
   }
 };

package/dist/es2019/schema/nodes/heading.js

@@ -15,10 +15,17 @@
  * @name heading_with_indentation_node
  */
 
+const getAttrs = (level, domNode) => ({
+  level,
+  localId: domNode.getAttribute('data-local-id') || heading.attrs.localId.default
+});
 export const heading = {
   attrs: {
     level: {
       default: 1
+    },
+    localId: {
+      default: null
     }
   },
   content: `inline*`,
@@ -27,36 +34,30 @@ export const heading = {
   selectable: false,
   parseDOM: [{
     tag: 'h1',
-    attrs: {
-      level: 1
-    }
+    getAttrs: domNode => getAttrs(1, domNode)
   }, {
     tag: 'h2',
-    attrs: {
-      level: 2
-    }
+    getAttrs: domNode => getAttrs(2, domNode)
   }, {
     tag: 'h3',
-    attrs: {
-      level: 3
-    }
+    getAttrs: domNode => getAttrs(3, domNode)
   }, {
     tag: 'h4',
-    attrs: {
-      level: 4
-    }
+    getAttrs: domNode => getAttrs(4, domNode)
   }, {
     tag: 'h5',
-    attrs: {
-      level: 5
-    }
+    getAttrs: domNode => getAttrs(5, domNode)
   }, {
     tag: 'h6',
-    attrs: {
-      level: 6
-    }
+    getAttrs: domNode => getAttrs(6, domNode)
   }],
   toDOM(node) {
-    return ['h' + node.attrs['level'], 0];
+    const {
+      localId
+    } = node.attrs;
+    const attrs = localId !== undefined ? {
+      'data-local-id': localId
+    } : undefined;
+    return ['h' + node.attrs['level'], attrs, 0];
   }
 };

package/dist/es2019/schema/nodes/paragraph.js

@@ -23,16 +23,33 @@
  * @name paragraph_with_indentation_node
  */
 
-const pDOM = ['p', 0];
 export const paragraph = {
   selectable: false,
   content: 'inline*',
   group: 'block',
+  attrs: {
+    localId: {
+      default: null
+    }
+  },
   marks: 'strong code em link border strike subsup textColor backgroundColor typeAheadQuery underline confluenceInlineComment action annotation unsupportedMark unsupportedNodeAttribute dataConsumer fragment',
   parseDOM: [{
-    tag: 'p'
+    tag: 'p',
+    getAttrs: domNode => {
+      const dom = domNode;
+      const attrs = {
+        localId: dom.getAttribute('data-local-id') || paragraph.attrs.localId.default
+      };
+      return attrs;
+    }
   }],
-  toDOM() {
-    return pDOM;
+  toDOM(node) {
+    const {
+      localId
+    } = node.attrs;
+    const attrs = localId !== undefined ? {
+      'data-local-id': localId
+    } : undefined;
+    return ['p', attrs, 0];
   }
 };

package/dist/esm/schema/nodes/heading.js

@@ -15,10 +15,19 @@
  * @name heading_with_indentation_node
  */
 
+var _getAttrs = function getAttrs(level, domNode) {
+  return {
+    level: level,
+    localId: domNode.getAttribute('data-local-id') || heading.attrs.localId.default
+  };
+};
 export var heading = {
   attrs: {
     level: {
       default: 1
+    },
+    localId: {
+      default: null
     }
   },
   content: "inline*",
@@ -27,36 +36,40 @@ export var heading = {
   selectable: false,
   parseDOM: [{
     tag: 'h1',
-    attrs: {
-      level: 1
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(1, domNode);
     }
   }, {
     tag: 'h2',
-    attrs: {
-      level: 2
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(2, domNode);
     }
   }, {
     tag: 'h3',
-    attrs: {
-      level: 3
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(3, domNode);
     }
   }, {
     tag: 'h4',
-    attrs: {
-      level: 4
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(4, domNode);
     }
   }, {
     tag: 'h5',
-    attrs: {
-      level: 5
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(5, domNode);
     }
   }, {
     tag: 'h6',
-    attrs: {
-      level: 6
+    getAttrs: function getAttrs(domNode) {
+      return _getAttrs(6, domNode);
     }
   }],
   toDOM: function toDOM(node) {
-    return ['h' + node.attrs['level'], 0];
+    var localId = node.attrs.localId;
+    var attrs = localId !== undefined ? {
+      'data-local-id': localId
+    } : undefined;
+    return ['h' + node.attrs['level'], attrs, 0];
   }
 };

package/dist/esm/schema/nodes/paragraph.js

@@ -23,16 +23,31 @@
  * @name paragraph_with_indentation_node
  */
 
-var pDOM = ['p', 0];
 export var paragraph = {
   selectable: false,
   content: 'inline*',
   group: 'block',
+  attrs: {
+    localId: {
+      default: null
+    }
+  },
   marks: 'strong code em link border strike subsup textColor backgroundColor typeAheadQuery underline confluenceInlineComment action annotation unsupportedMark unsupportedNodeAttribute dataConsumer fragment',
   parseDOM: [{
-    tag: 'p'
+    tag: 'p',
+    getAttrs: function getAttrs(domNode) {
+      var dom = domNode;
+      var attrs = {
+        localId: dom.getAttribute('data-local-id') || paragraph.attrs.localId.default
+      };
+      return attrs;
+    }
   }],
-  toDOM: function toDOM() {
-    return pDOM;
+  toDOM: function toDOM(node) {
+    var localId = node.attrs.localId;
+    var attrs = localId !== undefined ? {
+      'data-local-id': localId
+    } : undefined;
+    return ['p', attrs, 0];
   }
 };

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

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

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

@@ -18,6 +18,10 @@ export interface HeadingBaseDefinition {
          * @maximum 6
          */
         level: number;
+        /**
+         * @stage 0
+         */
+        localId?: string;
     };
 }
 /**

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

@@ -2,6 +2,12 @@ import { NodeSpec } from '@atlaskit/editor-prosemirror/model';
 import { AlignmentMarkDefinition, IndentationMarkDefinition } from '../marks';
 import { MarksObject, NoMark } from './types/mark';
 import { Inline } from './types/inline-content';
+export interface ParagraphAttributes {
+    /**
+     * @stage 0
+     */
+    localId?: string;
+}
 /**
  * @name paragraph_node
  */
@@ -11,6 +17,10 @@ export interface ParagraphBaseDefinition {
      * @allowUnsupportedInline true
      */
     content?: Array<Inline>;
+    /**
+     * @stage 0
+     */
+    attrs?: ParagraphAttributes;
     marks?: Array<any>;
 }
 /**

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "35.12.2",
+  "version": "35.13.0",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -41,7 +41,7 @@
     "memoize-one": "^6.0.0"
   },
   "devDependencies": {
-    "@atlassian/adf-schema-json": "^1.10.0",
+    "@atlassian/adf-schema-json": "^1.11.0",
     "@babel/cli": "^7.22.9",
     "@babel/core": "^7.22.9",
     "@babel/plugin-proposal-class-properties": "^7.18.6",