|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from dataclasses import dataclass, field |
| 4 | +from typing import Any, Optional, Union |
| 5 | + |
| 6 | + |
| 7 | +@dataclass |
| 8 | +class TextNode: |
| 9 | + text: str |
| 10 | + marks: list[dict[str, Any]] = field(default_factory=list) |
| 11 | + |
| 12 | + def bold(self) -> TextNode: |
| 13 | + self.marks.append({"type": "strong"}) |
| 14 | + return self |
| 15 | + |
| 16 | + def italic(self) -> TextNode: |
| 17 | + self.marks.append({"type": "em"}) |
| 18 | + return self |
| 19 | + |
| 20 | + def code(self) -> TextNode: |
| 21 | + self.marks.append({"type": "code"}) |
| 22 | + return self |
| 23 | + |
| 24 | + def link(self, href: str) -> TextNode: |
| 25 | + self.marks.append({"type": "link", "attrs": {"href": href}}) |
| 26 | + return self |
| 27 | + |
| 28 | + def strike(self) -> TextNode: |
| 29 | + self.marks.append({"type": "strike"}) |
| 30 | + return self |
| 31 | + |
| 32 | + def to_dict(self) -> dict[str, Any]: |
| 33 | + node: dict[str, Any] = {"type": "text", "text": self.text} |
| 34 | + if self.marks: |
| 35 | + node["marks"] = [dict(m) for m in self.marks] |
| 36 | + return node |
| 37 | + |
| 38 | + |
| 39 | +@dataclass(frozen=True) |
| 40 | +class MentionNode: |
| 41 | + account_id: str |
| 42 | + display_text: str = "" |
| 43 | + |
| 44 | + def to_dict(self) -> dict[str, Any]: |
| 45 | + return { |
| 46 | + "type": "mention", |
| 47 | + "attrs": {"id": self.account_id, "text": self.display_text}, |
| 48 | + } |
| 49 | + |
| 50 | + |
| 51 | +InlineNode = Union[TextNode, MentionNode] |
| 52 | + |
| 53 | + |
| 54 | +class ADFBuilder: |
| 55 | + """Fluent builder that produces an Atlassian Document Format dict.""" |
| 56 | + |
| 57 | + def __init__(self) -> None: |
| 58 | + """Initialize an empty ADF document builder.""" |
| 59 | + self._content: list[dict[str, Any]] = [] |
| 60 | + |
| 61 | + def paragraph(self, *nodes: InlineNode) -> ADFBuilder: |
| 62 | + self._content.append( |
| 63 | + { |
| 64 | + "type": "paragraph", |
| 65 | + "content": [n.to_dict() for n in nodes], |
| 66 | + } |
| 67 | + ) |
| 68 | + return self |
| 69 | + |
| 70 | + def text_paragraph(self, text: str) -> ADFBuilder: |
| 71 | + return self.paragraph(TextNode(text)) |
| 72 | + |
| 73 | + def heading(self, text: str, level: int = 1) -> ADFBuilder: |
| 74 | + if level not in range(1, 7): |
| 75 | + raise ValueError(f"Heading level must be 1-6, got {level}") |
| 76 | + self._content.append( |
| 77 | + { |
| 78 | + "type": "heading", |
| 79 | + "attrs": {"level": level}, |
| 80 | + "content": [{"type": "text", "text": text}], |
| 81 | + } |
| 82 | + ) |
| 83 | + return self |
| 84 | + |
| 85 | + def _list_node(self, list_type: str, items: list[str]) -> ADFBuilder: |
| 86 | + list_items = [ |
| 87 | + { |
| 88 | + "type": "listItem", |
| 89 | + "content": [ |
| 90 | + { |
| 91 | + "type": "paragraph", |
| 92 | + "content": [{"type": "text", "text": item}], |
| 93 | + } |
| 94 | + ], |
| 95 | + } |
| 96 | + for item in items |
| 97 | + ] |
| 98 | + self._content.append({"type": list_type, "content": list_items}) |
| 99 | + return self |
| 100 | + |
| 101 | + def bullet_list(self, items: list[str]) -> ADFBuilder: |
| 102 | + return self._list_node("bulletList", items) |
| 103 | + |
| 104 | + def ordered_list(self, items: list[str]) -> ADFBuilder: |
| 105 | + return self._list_node("orderedList", items) |
| 106 | + |
| 107 | + def code_block(self, code: str, language: Optional[str] = None) -> ADFBuilder: |
| 108 | + node: dict[str, Any] = { |
| 109 | + "type": "codeBlock", |
| 110 | + "content": [{"type": "text", "text": code}], |
| 111 | + } |
| 112 | + if language: |
| 113 | + node["attrs"] = {"language": language} |
| 114 | + self._content.append(node) |
| 115 | + return self |
| 116 | + |
| 117 | + def rule(self) -> ADFBuilder: |
| 118 | + self._content.append({"type": "rule"}) |
| 119 | + return self |
| 120 | + |
| 121 | + def blockquote(self, *nodes: InlineNode) -> ADFBuilder: |
| 122 | + self._content.append( |
| 123 | + { |
| 124 | + "type": "blockquote", |
| 125 | + "content": [ |
| 126 | + { |
| 127 | + "type": "paragraph", |
| 128 | + "content": [n.to_dict() for n in nodes], |
| 129 | + } |
| 130 | + ], |
| 131 | + } |
| 132 | + ) |
| 133 | + return self |
| 134 | + |
| 135 | + def table(self, headers: list[str], rows: list[list[str]]) -> ADFBuilder: |
| 136 | + header_row = { |
| 137 | + "type": "tableRow", |
| 138 | + "content": [ |
| 139 | + { |
| 140 | + "type": "tableHeader", |
| 141 | + "content": [{"type": "paragraph", "content": [{"type": "text", "text": h}]}], |
| 142 | + } |
| 143 | + for h in headers |
| 144 | + ], |
| 145 | + } |
| 146 | + data_rows = [ |
| 147 | + { |
| 148 | + "type": "tableRow", |
| 149 | + "content": [ |
| 150 | + { |
| 151 | + "type": "tableCell", |
| 152 | + "content": [{"type": "paragraph", "content": [{"type": "text", "text": cell}]}], |
| 153 | + } |
| 154 | + for cell in row |
| 155 | + ], |
| 156 | + } |
| 157 | + for row in rows |
| 158 | + ] |
| 159 | + self._content.append( |
| 160 | + { |
| 161 | + "type": "table", |
| 162 | + "attrs": {"isNumberColumnEnabled": False, "layout": "default"}, |
| 163 | + "content": [header_row] + data_rows, |
| 164 | + } |
| 165 | + ) |
| 166 | + return self |
| 167 | + |
| 168 | + def raw_node(self, node: dict[str, Any]) -> ADFBuilder: |
| 169 | + """Escape hatch for ADF node types not covered by dedicated methods.""" |
| 170 | + self._content.append(node) |
| 171 | + return self |
| 172 | + |
| 173 | + def build(self) -> dict[str, Any]: |
| 174 | + return { |
| 175 | + "version": 1, |
| 176 | + "type": "doc", |
| 177 | + "content": list(self._content), |
| 178 | + } |
0 commit comments