@atlaskit/adf-schema 49.1.0 → 50.0.1

package/dist/types/steps/types.d.ts

@@ -0,0 +1,96 @@
+/**
+ * These types are taken from adf-utils, but not imported to avoid circular dependencies.
+ * They can be seen here:
+ * https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/editor/adf-utils/src/types/index.ts
+ */
+/**
+ * Represents a mark in the Atlassian Document Format (ADF).
+ * Marks are used to apply formatting or metadata to content, such as bold, italic, links, etc.
+ *
+ * @example
+ * ```typescript
+ * const boldMark: ADFEntityMark = {
+ *   type: 'strong'
+ * };
+ *
+ * const linkMark: ADFEntityMark = {
+ *   type: 'link',
+ *   attrs: {
+ *     href: 'https://example.com',
+ *     title: 'Example Link'
+ *   }
+ * };
+ * ```
+ */
+export interface ADFEntityMark {
+    /** The type of mark (e.g., 'strong', 'em', 'link', 'code', etc.) */
+    type: string;
+    /**
+     * Optional attributes for the mark, containing mark-specific properties.
+     * For example, a link mark would have 'href' and optionally 'title' attributes.
+     */
+    attrs?: {
+        [name: string]: any;
+    };
+}
+/**
+ * Represents a node or entity in the Atlassian Document Format (ADF).
+ * This is the core building block of ADF documents, representing elements like
+ * paragraphs, headings, images, tables, and other content types.
+ *
+ * @example
+ * ```typescript
+ * const paragraph: ADFEntity = {
+ *   type: 'paragraph',
+ *   content: [
+ *     {
+ *       type: 'text',
+ *       text: 'Hello world!',
+ *       marks: [{ type: 'strong' }]
+ *     }
+ *   ]
+ * };
+ *
+ * const heading: ADFEntity = {
+ *   type: 'heading',
+ *   attrs: { level: 1 },
+ *   content: [
+ *     {
+ *       type: 'text',
+ *       text: 'Document Title'
+ *     }
+ *   ]
+ * };
+ * ```
+ */
+export interface ADFEntity {
+    /** The type of ADF node (e.g., 'doc', 'paragraph', 'heading', 'text', 'image', etc.) */
+    type: string;
+    /**
+     * Optional attributes for the entity, containing node-specific properties.
+     * For example, a heading node would have a 'level' attribute, an image would have 'src', etc.
+     */
+    attrs?: {
+        [name: string]: any;
+    };
+    /**
+     * Optional array of child entities. Used for container nodes like paragraphs, headings, etc.
+     * Can contain undefined values to handle cases where content might be filtered or removed.
+     */
+    content?: Array<ADFEntity | undefined>;
+    /**
+     * Optional array of marks applied to this entity.
+     * Marks provide formatting and metadata like bold, italic, links, etc.
+     */
+    marks?: Array<ADFEntityMark>;
+    /**
+     * Optional text content for text nodes.
+     * Only present on nodes of type 'text'.
+     */
+    text?: string;
+    /**
+     * Index signature to allow additional properties that may be specific to certain node types
+     * or used for extensions and custom functionality.
+     */
+    [key: string]: any;
+}

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

@@ -1698,6 +1698,10 @@ export declare const tableCell: {
                     type: string;
                     optional: boolean;
                 };
+                localId: {
+                    type: string;
+                    optional: boolean;
+                };
             };
             optional: boolean;
         };
@@ -1737,6 +1741,10 @@ export declare const tableHeader: {
                     type: string;
                     optional: boolean;
                 };
+                localId: {
+                    type: string;
+                    optional: boolean;
+                };
             };
             optional: boolean;
         };
@@ -1754,6 +1762,15 @@ export declare const tableRow: {
             type: string;
             values: string[];
         };
+        attrs: {
+            props: {
+                localId: {
+                    type: string;
+                    optional: boolean;
+                };
+            };
+            optional: boolean;
+        };
         content: {
             type: string;
             items: string[][];

package/json-schema/v1/full.json

@@ -2438,6 +2438,9 @@
             },
             "background": {
               "type": "string"
+            },
+            "localId": {
+              "type": "string"
             }
           },
           "additionalProperties": false
@@ -2472,6 +2475,9 @@
             },
             "background": {
               "type": "string"
+            },
+            "localId": {
+              "type": "string"
             }
           },
           "additionalProperties": false
@@ -2541,6 +2547,15 @@
         "type": {
           "enum": ["tableRow"]
         },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "localId": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        },
         "content": {
           "type": "array",
           "items": {

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

@@ -2733,6 +2733,9 @@
             },
             "background": {
               "type": "string"
+            },
+            "localId": {
+              "type": "string"
             }
           },
           "additionalProperties": false
@@ -2767,6 +2770,9 @@
             },
             "background": {
               "type": "string"
+            },
+            "localId": {
+              "type": "string"
             }
           },
           "additionalProperties": false
@@ -2836,6 +2842,15 @@
         "type": {
           "enum": ["tableRow"]
         },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "localId": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        },
         "content": {
           "type": "array",
           "items": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "49.1.0",
+  "version": "50.0.1",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"