@knpkv/atlassian-common 0.2.0

package/dist/serializers/MarkdownSerializer.js

@@ -0,0 +1,367 @@
+/**
+ * AST-to-Markdown serializer with roundtrip comment encoding for non-Markdown features.
+ *
+ * **Mental model**
+ *
+ * - **Visitor over DocumentNode union**: {@link serializeToMarkdown} walks the AST, dispatching
+ *   on `_tag` to emit Markdown. Effect-based for composability with the rest of the pipeline.
+ * - **Roundtrip via HTML comments**: Confluence-specific data (panel types, task status,
+ *   image alignment) is encoded in `<!-- ... -->` comments with base64/URL encoding so
+ *   a future parser can reconstruct the original.
+ *
+ * **Common tasks**
+ *
+ * - Serialize a document: {@link serializeToMarkdown}
+ * - Serialize inline nodes only: {@link serializeInlineNodes}
+ *
+ * **Gotchas**
+ *
+ * - Comment-encoded data is fragile if users hand-edit the Markdown — edits inside
+ *   `<!-- -->` blocks will break roundtripping.
+ *
+ * @module
+ */
+import * as Effect from "effect/Effect";
+/**
+ * Serialize Document AST to GitHub Flavored Markdown.
+ *
+ * @example
+ * ```typescript
+ * import { serializeToMarkdown, makeDocument, Heading, Text } from "@knpkv/atlassian-common"
+ * import { Effect } from "effect"
+ *
+ * Effect.gen(function* () {
+ *   const doc = makeDocument([
+ *     new Heading({ level: 1, children: [new Text({ value: "Title" })] })
+ *   ])
+ *   const md = yield* serializeToMarkdown(doc)
+ *   console.log(md) // # Title
+ * })
+ * ```
+ *
+ * @category Serializers
+ */
+export const serializeToMarkdown = (doc, options = {}) => Effect.gen(function* () {
+    const parts = [];
+    for (const node of doc.children) {
+        const serialized = yield* serializeDocumentNode(node, options);
+        parts.push(serialized);
+    }
+    const content = parts.join("\n\n");
+    // Embed rawSource in comment for roundtrip preservation
+    if (options.includeRawSource && doc.rawSource !== undefined) {
+        const prefix = options.commentPrefix ?? "src";
+        const encoded = Buffer.from(doc.rawSource, "utf-8").toString("base64");
+        return `${content}\n\n<!--${prefix}:raw:${encoded}-->`;
+    }
+    return content;
+});
+/**
+ * Serialize a document node to Markdown.
+ */
+const serializeDocumentNode = (node, options) => Effect.gen(function* () {
+    switch (node._tag) {
+        // Block nodes
+        case "Heading":
+            return yield* serializeHeading(node);
+        case "Paragraph":
+            return yield* serializeParagraph(node);
+        case "CodeBlock":
+            return serializeCodeBlock(node);
+        case "ThematicBreak":
+            return "---";
+        case "Image":
+            return serializeImage(node, options);
+        case "Table":
+            return yield* serializeTable(node);
+        case "List":
+            return yield* serializeList(node, options);
+        case "BlockQuote":
+            return yield* serializeBlockQuote(node, options);
+        case "UnsupportedBlock":
+            return node.rawMarkdown ?? node.rawHtml ?? node.rawAdf ?? "";
+        // Macro nodes
+        case "InfoPanel":
+            return yield* serializeInfoPanel(node, options);
+        case "ExpandMacro":
+            return yield* serializeExpandMacro(node, options);
+        case "TocMacro":
+            return "[[toc]]";
+        case "CodeMacro":
+            return serializeCodeMacro(node);
+        case "StatusMacro":
+            return `**[${node.text}]**`;
+        case "TaskList":
+            return yield* serializeTaskList(node.children, options);
+        default:
+            return "";
+    }
+});
+/**
+ * Serialize heading.
+ */
+const serializeHeading = (node) => Effect.gen(function* () {
+    const prefix = "#".repeat(node.level);
+    const content = yield* serializeInlineNodes(node.children);
+    return `${prefix} ${content}`;
+});
+/**
+ * Serialize paragraph.
+ */
+const serializeParagraph = (node) => Effect.gen(function* () {
+    const content = yield* serializeInlineNodes(node.children);
+    // If has alignment or indent, wrap in HTML for roundtrip
+    if (node.alignment || node.indent) {
+        const styles = [];
+        if (node.alignment)
+            styles.push(`text-align: ${node.alignment};`);
+        if (node.indent)
+            styles.push(`margin-left: ${node.indent}px;`);
+        return `<p style="${styles.join(" ")}">${content}</p>`;
+    }
+    return content;
+});
+/**
+ * Serialize code block.
+ */
+const serializeCodeBlock = (node) => {
+    const lang = node.language ?? "";
+    return `\`\`\`${lang}\n${node.code}\n\`\`\``;
+};
+/**
+ * Serialize image.
+ */
+const serializeImage = (node, options) => {
+    const prefix = options.commentPrefix ?? "src";
+    // If image has attachment or align/width, use comment encoding for roundtrip
+    if (node.attachment || node.align || node.width) {
+        const parts = [];
+        if (node.attachment) {
+            parts.push(`f=${encodeURIComponent(node.attachment.filename)}`);
+            if (node.attachment.version)
+                parts.push(`v=${node.attachment.version}`);
+        }
+        if (node.src)
+            parts.push(`s=${encodeURIComponent(node.src)}`);
+        if (node.alt)
+            parts.push(`a=${encodeURIComponent(node.alt)}`);
+        if (node.title)
+            parts.push(`t=${encodeURIComponent(node.title)}`);
+        if (node.align)
+            parts.push(`al=${node.align}`);
+        if (node.width)
+            parts.push(`w=${node.width}`);
+        return `<!--${prefix}:image:${parts.join("|")}-->`;
+    }
+    // Simple external image - use markdown syntax
+    const alt = node.alt ?? "";
+    const title = node.title ? ` "${node.title}"` : "";
+    const src = node.src ?? "";
+    return `![${alt}](${src}${title})`;
+};
+/**
+ * Serialize table.
+ */
+const serializeTable = (node) => Effect.gen(function* () {
+    const lines = [];
+    // Header
+    if (node.header) {
+        const headerCells = [];
+        for (const cell of node.header.cells) {
+            headerCells.push(yield* serializeInlineNodes(cell.children));
+        }
+        lines.push(`| ${headerCells.join(" | ")} |`);
+        lines.push(`| ${headerCells.map(() => "---").join(" | ")} |`);
+    }
+    // Body rows
+    for (const row of node.rows) {
+        const cells = [];
+        for (const cell of row.cells) {
+            cells.push(yield* serializeInlineNodes(cell.children));
+        }
+        lines.push(`| ${cells.join(" | ")} |`);
+    }
+    return lines.join("\n");
+});
+/**
+ * Serialize list.
+ */
+const serializeList = (node, options) => Effect.gen(function* () {
+    const lines = [];
+    let counter = node.start ?? 1;
+    for (const item of node.children) {
+        const prefix = node.ordered ? `${counter}.` : "-";
+        const checkbox = item.checked !== undefined ? (item.checked ? "[x] " : "[ ] ") : "";
+        // Serialize item content
+        const itemParts = [];
+        for (const child of item.children) {
+            const serialized = yield* serializeSimpleBlock(child, options);
+            itemParts.push(serialized);
+        }
+        const content = itemParts.join("\n");
+        const indentedContent = content
+            .split("\n")
+            .map((line, i) => (i === 0 ? `${prefix} ${checkbox}${line}` : `   ${line}`))
+            .join("\n");
+        lines.push(indentedContent);
+        counter++;
+    }
+    return lines.join("\n");
+});
+/**
+ * Serialize simple block (for nested content).
+ */
+const serializeSimpleBlock = (node, options) => Effect.gen(function* () {
+    const tagged = node;
+    switch (tagged._tag) {
+        case "Heading":
+            return yield* serializeHeading(node);
+        case "Paragraph":
+            return yield* serializeParagraph(node);
+        case "CodeBlock":
+            return serializeCodeBlock(node);
+        case "ThematicBreak":
+            return "---";
+        case "Image":
+            return serializeImage(node, options);
+        case "Table":
+            return yield* serializeTable(node);
+        case "UnsupportedBlock": {
+            const unsupported = node;
+            return unsupported.rawMarkdown ?? unsupported.rawHtml ?? unsupported.rawAdf ?? "";
+        }
+        default:
+            return "";
+    }
+});
+/**
+ * Serialize block quote.
+ */
+const serializeBlockQuote = (node, options) => Effect.gen(function* () {
+    const lines = [];
+    for (const child of node.children) {
+        const serialized = yield* serializeSimpleBlock(child, options);
+        const quoted = serialized.split("\n").map((line) => `> ${line}`).join("\n");
+        lines.push(quoted);
+    }
+    return lines.join("\n>\n");
+});
+/**
+ * Serialize info panel to container syntax.
+ */
+const serializeInfoPanel = (node, options) => Effect.gen(function* () {
+    const type = node.panelType;
+    const title = node.title ? ` ${node.title}` : "";
+    const lines = [`:::${type}${title}`];
+    for (const child of node.children) {
+        const serialized = yield* serializeSimpleBlock(child, options);
+        lines.push(serialized);
+    }
+    lines.push(":::");
+    return lines.join("\n");
+});
+/**
+ * Serialize expand macro.
+ */
+const serializeExpandMacro = (node, options) => Effect.gen(function* () {
+    const prefix = options.commentPrefix ?? "src";
+    const title = node.title ?? "";
+    const contentParts = [];
+    for (const child of node.children) {
+        const serialized = yield* serializeSimpleBlock(child, options);
+        contentParts.push(serialized);
+    }
+    const content = contentParts.join("\n");
+    return `<!--${prefix}:expand:${encodeURIComponent(title)}:${encodeURIComponent(content)}-->`;
+});
+/**
+ * Serialize code macro (similar to code block but may have title).
+ */
+const serializeCodeMacro = (node) => {
+    const lang = node.language ?? "";
+    const title = node.title ? ` title="${node.title}"` : "";
+    return `\`\`\`${lang}${title}\n${node.code}\n\`\`\``;
+};
+/**
+ * Serialize task list.
+ */
+const serializeTaskList = (children, options) => Effect.gen(function* () {
+    const prefix = options.commentPrefix ?? "src";
+    const items = [];
+    for (const item of children) {
+        const body = yield* serializeInlineNodes(item.body);
+        items.push(`${item.id}|${item.uuid}|${item.status}|${encodeURIComponent(body)}`);
+    }
+    return `<!--${prefix}:tasklist:${items.join(";")}-->`;
+});
+/**
+ * Serialize inline nodes to Markdown.
+ */
+export const serializeInlineNodes = (nodes) => Effect.gen(function* () {
+    const parts = [];
+    for (const node of nodes) {
+        parts.push(yield* serializeInlineNode(node));
+    }
+    return parts.join("");
+});
+/**
+ * Serialize inline node to Markdown.
+ */
+const serializeInlineNode = (node) => Effect.gen(function* () {
+    switch (node._tag) {
+        case "Text":
+            return node.value;
+        case "Strong": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `**${content}**`;
+        }
+        case "Emphasis": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `*${content}*`;
+        }
+        case "Underline": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `<u>${content}</u>`;
+        }
+        case "Strikethrough": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `~~${content}~~`;
+        }
+        case "Subscript": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `<sub>${content}</sub>`;
+        }
+        case "Superscript": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `<sup>${content}</sup>`;
+        }
+        case "InlineCode":
+            return `\`${node.value}\``;
+        case "Link": {
+            const content = yield* serializeInlineNodes(node.children);
+            const title = node.title ? ` "${node.title}"` : "";
+            return `[${content}](${node.href}${title})`;
+        }
+        case "LineBreak":
+            return "  \n";
+        case "Emoticon":
+            return node.fallback;
+        case "UserMention":
+            return `@${node.accountId}`;
+        case "DateTime":
+            return node.datetime;
+        case "ColoredText": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `<span style="color: ${node.color};">${content}</span>`;
+        }
+        case "Highlight": {
+            const content = yield* serializeInlineNodes(node.children);
+            return `<span style="background-color: ${node.backgroundColor};">${content}</span>`;
+        }
+        case "UnsupportedInline":
+            return node.raw;
+        default:
+            return "";
+    }
+});
+//# sourceMappingURL=MarkdownSerializer.js.map

package/dist/serializers/MarkdownSerializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownSerializer.js","sourceRoot":"","sources":["../../src/serializers/MarkdownSerializer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAiBvC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,GAAa,EACb,UAA4B,EAAE,EACS,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QAChC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAC9D,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACxB,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAElC,wDAAwD;IACxD,IAAI,OAAO,CAAC,gBAAgB,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5D,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;QAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QACtE,OAAO,GAAG,OAAO,WAAW,MAAM,QAAQ,OAAO,KAAK,CAAA;IACxD,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAC5B,IAAkB,EAClB,OAAyB,EACc,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,cAAc;QACd,KAAK,SAAS;YACZ,OAAO,KAAK,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACtC,KAAK,WAAW;YACd,OAAO,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACxC,KAAK,WAAW;YACd,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACjC,KAAK,eAAe;YAClB,OAAO,KAAK,CAAA;QACd,KAAK,OAAO;YACV,OAAO,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACtC,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QACpC,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAC5C,KAAK,YAAY;YACf,OAAO,KAAK,CAAC,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAClD,KAAK,kBAAkB;YACrB,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,CAAA;QAE9D,cAAc;QACd,KAAK,WAAW;YACd,OAAO,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACjD,KAAK,aAAa;YAChB,OAAO,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACnD,KAAK,UAAU;YACb,OAAO,SAAS,CAAA;QAClB,KAAK,WAAW;YACd,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACjC,KAAK,aAAa;YAChB,OAAO,MAAM,IAAI,CAAC,IAAI,KAAK,CAAA;QAC7B,KAAK,UAAU;YACb,OAAO,KAAK,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAEzD;YACE,OAAO,EAAE,CAAA;IACb,CAAC;AACH,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,gBAAgB,GAAG,CACvB,IAA2E,EACpC,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC1D,OAAO,GAAG,MAAM,IAAI,OAAO,EAAE,CAAA;AAC/B,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,kBAAkB,GAAG,CACzB,IAIC,EACsC,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC1D,yDAAyD;IACzD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,MAAM,GAAkB,EAAE,CAAA;QAChC,IAAI,IAAI,CAAC,SAAS;YAAE,MAAM,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QACjE,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,KAAK,CAAC,CAAA;QAC9D,OAAO,aAAa,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,MAAM,CAAA;IACxD,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,IAAqD,EAAU,EAAE;IAC3F,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAA;IAChC,OAAO,SAAS,IAAI,KAAK,IAAI,CAAC,IAAI,UAAU,CAAA;AAC9C,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,cAAc,GAAG,CACrB,IAOC,EACD,OAAyB,EACjB,EAAE;IACV,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;IAE7C,6EAA6E;IAC7E,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAChD,MAAM,KAAK,GAAkB,EAAE,CAAA;QAC/B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,KAAK,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YAC/D,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO;gBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;QACzE,CAAC;QACD,IAAI,IAAI,CAAC,GAAG;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAC7D,IAAI,IAAI,CAAC,GAAG;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAC7D,IAAI,IAAI,CAAC,KAAK;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QACjE,IAAI,IAAI,CAAC,KAAK;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;QAC9C,IAAI,IAAI,CAAC,KAAK;YAAE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;QAC7C,OAAO,OAAO,MAAM,UAAU,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;IACpD,CAAC;IAED,8CAA8C;IAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,EAAE,CAAA;IAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IAClD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,EAAE,CAAA;IAC1B,OAAO,KAAK,GAAG,KAAK,GAAG,GAAG,KAAK,GAAG,CAAA;AACpC,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,cAAc,GAAG,CACrB,IAGC,EACsC,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAkB,EAAE,CAAA;IAE/B,SAAS;IACT,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,WAAW,GAAkB,EAAE,CAAA;QACrC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACrC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC9D,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC5C,KAAK,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC/D,CAAC;IAED,YAAY;IACZ,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAkB,EAAE,CAAA;QAC/B,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;QACxD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC,CAAC,CAAA;AAYJ;;GAEG;AACH,MAAM,aAAa,GAAG,CACpB,IAAwF,EACxF,OAAyB,EACc,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;IAE7B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAuC,EAAE,CAAC;QAChE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAA;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAEnF,yBAAyB;QACzB,MAAM,SAAS,GAAkB,EAAE,CAAA;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;YAC9D,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC5B,CAAC;QAED,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpC,MAAM,eAAe,GAAG,OAAO;aAC5B,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,QAAQ,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;aAC3E,IAAI,CAAC,IAAI,CAAC,CAAA;QAEb,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAC3B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAC3B,IAAiB,EACjB,OAAyB,EACc,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,MAAM,GAAG,IAAiC,CAAA;IAChD,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,SAAS;YACZ,OAAO,KAAK,CAAC,CAAC,gBAAgB,CAC5B,IAAwF,CACzF,CAAA;QACH,KAAK,WAAW;YACd,OAAO,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAA0D,CAAC,CAAA;QAC9F,KAAK,WAAW;YACd,OAAO,kBAAkB,CAAC,IAAkE,CAAC,CAAA;QAC/F,KAAK,eAAe;YAClB,OAAO,KAAK,CAAA;QACd,KAAK,OAAO;YACV,OAAO,cAAc,CACnB,IAAwF,EACxF,OAAO,CACR,CAAA;QACH,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,CAAC,cAAc,CAC1B,IAGC,CACF,CAAA;QACH,KAAK,kBAAkB,CAAC,CAAC,CAAC;YACxB,MAAM,WAAW,GAAG,IAA8E,CAAA;YAClG,OAAO,WAAW,CAAC,WAAW,IAAI,WAAW,CAAC,OAAO,IAAI,WAAW,CAAC,MAAM,IAAI,EAAE,CAAA;QACnF,CAAC;QACD;YACE,OAAO,EAAE,CAAA;IACb,CAAC;AACH,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,mBAAmB,GAAG,CAC1B,IAA0C,EAC1C,OAAyB,EACc,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC9D,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3E,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACpB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,kBAAkB,GAAG,CACzB,IAAyF,EACzF,OAAyB,EACc,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAA;IAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IAChD,MAAM,KAAK,GAAkB,CAAC,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,CAAA;IAEnD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC9D,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAC3B,IAAsE,EACtE,OAAyB,EACc,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;IAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAA;IAC9B,MAAM,YAAY,GAAkB,EAAE,CAAA;IAEtC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC9D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvC,OAAO,OAAO,MAAM,WAAW,kBAAkB,CAAC,KAAK,CAAC,IAAI,kBAAkB,CAAC,OAAO,CAAC,KAAK,CAAA;AAC9F,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,kBAAkB,GAAG,CACzB,IAAiF,EACzE,EAAE;IACV,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAA;IAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACxD,OAAO,SAAS,IAAI,GAAG,KAAK,KAAK,IAAI,CAAC,IAAI,UAAU,CAAA;AACtD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,iBAAiB,GAAG,CACxB,QAME,EACF,OAAyB,EACc,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAA;IAC7C,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnD,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAClF,CAAC;IACD,OAAO,OAAO,MAAM,aAAa,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;AACvD,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,KAAgC,EACO,EAAE,CACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAA;IAC9C,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACvB,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,mBAAmB,GAAG,CAAC,IAAgB,EAAyC,EAAE,CACtF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,KAAK,OAAO,IAAI,CAAA;QACzB,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,IAAI,OAAO,GAAG,CAAA;QACvB,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,MAAM,OAAO,MAAM,CAAA;QAC5B,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,KAAK,OAAO,IAAI,CAAA;QACzB,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,QAAQ,OAAO,QAAQ,CAAA;QAChC,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,QAAQ,OAAO,QAAQ,CAAA;QAChC,CAAC;QACD,KAAK,YAAY;YACf,OAAO,KAAK,IAAI,CAAC,KAAK,IAAI,CAAA;QAC5B,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;YAClD,OAAO,IAAI,OAAO,KAAK,IAAI,CAAC,IAAI,GAAG,KAAK,GAAG,CAAA;QAC7C,CAAC;QACD,KAAK,WAAW;YACd,OAAO,MAAM,CAAA;QACf,KAAK,UAAU;YACb,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,KAAK,aAAa;YAChB,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAA;QAC7B,KAAK,UAAU;YACb,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,uBAAuB,IAAI,CAAC,KAAK,MAAM,OAAO,SAAS,CAAA;QAChE,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC1D,OAAO,kCAAkC,IAAI,CAAC,eAAe,MAAM,OAAO,SAAS,CAAA;QACrF,CAAC;QACD,KAAK,mBAAmB;YACtB,OAAO,IAAI,CAAC,GAAG,CAAA;QACjB;YACE,OAAO,EAAE,CAAA;IACb,CAAC;AACH,CAAC,CAAC,CAAA"}

package/dist/serializers/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Barrel export for AST serializers.
+ *
+ * @module
+ */
+export { serializeInlineNodes, type SerializeOptions, serializeToMarkdown } from "./MarkdownSerializer.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/serializers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/serializers/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,KAAK,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA"}

package/dist/serializers/index.js

@@ -0,0 +1,7 @@
+/**
+ * Barrel export for AST serializers.
+ *
+ * @module
+ */
+export { serializeInlineNodes, serializeToMarkdown } from "./MarkdownSerializer.js";
+//# sourceMappingURL=index.js.map

package/dist/serializers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/serializers/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAyB,mBAAmB,EAAE,MAAM,yBAAyB,CAAA"}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@knpkv/atlassian-common",
+  "version": "0.2.0",
+  "description": "Shared utilities for Atlassian tools (AST, serializers, auth, config)",
+  "license": "MIT",
+  "author": "knpkv",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/knpkv/npm.git",
+    "directory": "packages/atlassian-common"
+  },
+  "bugs": {
+    "url": "https://github.com/knpkv/npm/issues"
+  },
+  "homepage": "https://github.com/knpkv/npm/tree/main/packages/atlassian-common#readme",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./ast": {
+      "import": "./dist/ast/index.js",
+      "types": "./dist/ast/index.d.ts"
+    },
+    "./serializers": {
+      "import": "./dist/serializers/index.js",
+      "types": "./dist/serializers/index.d.ts"
+    },
+    "./parsers": {
+      "import": "./dist/parsers/index.js",
+      "types": "./dist/parsers/index.d.ts"
+    },
+    "./auth": {
+      "import": "./dist/auth/index.js",
+      "types": "./dist/auth/index.d.ts"
+    },
+    "./config": {
+      "import": "./dist/config/index.js",
+      "types": "./dist/config/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@effect/platform": ">=0.93.0 <0.96.0",
+    "effect": ">=3.19.3"
+  },
+  "dependencies": {
+    "remark-gfm": "^4.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-stringify": "^11.0.0",
+    "unified": "^11.0.5"
+  },
+  "devDependencies": {
+    "@effect/platform": "latest",
+    "@effect/platform-node": "latest",
+    "@effect/vitest": "latest",
+    "@types/node": "latest",
+    "effect": "latest",
+    "typescript": "~5.9.0",
+    "vitest": "^4.0.13"
+  },
+  "keywords": [
+    "effect",
+    "effect-ts",
+    "atlassian",
+    "confluence",
+    "jira",
+    "ast",
+    "markdown"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist dist-test .tsbuildinfo",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "check": "tsc --noEmit"
+  }
+}

package/src/Brand.ts

@@ -0,0 +1,142 @@
+/**
+ * Branded string types for type-safe Atlassian domain values.
+ *
+ * **Mental model**
+ *
+ * - **Brand = runtime validation + compile-time narrowing**: Each brand combines
+ *   an Effect `Brand.refined` (throws on invalid values) with an Effect `Schema`
+ *   (composable validation). The `Type` property exposes the branded type for use
+ *   in type annotations.
+ * - **Pattern-guarded strings**: `SpaceKey`, `IssueKey`, `ProjectKey` are regex-branded;
+ *   `PageId` is non-empty branded; `ContentHash` is SHA256 hex branded.
+ *
+ * **Common tasks**
+ *
+ * - Create a custom brand: {@link makeBrandedString}, {@link makeBrandedNonEmptyString}
+ * - Validate a Jira ticket key: {@link IssueKey}
+ * - Validate a content hash: {@link ContentHash}
+ *
+ * **Gotchas**
+ *
+ * - Brand constructors throw synchronously on invalid input — wrap in `Effect.try` if
+ *   the input is untrusted.
+ *
+ * @module
+ */
+import * as Brand from "effect/Brand"
+import * as Schema from "effect/Schema"
+
+/**
+ * Create a branded string type with pattern validation.
+ *
+ * @example
+ * ```typescript
+ * import { makeBrandedString } from "@knpkv/atlassian-common"
+ *
+ * const IssueKey = makeBrandedString("IssueKey", /^[A-Z]+-\d+$/)
+ * type IssueKey = typeof IssueKey.Type
+ *
+ * const key = IssueKey("PROJ-123") // OK
+ * const bad = IssueKey("invalid")  // Throws
+ * ```
+ *
+ * @category Brand
+ */
+export const makeBrandedString = <B extends string>(
+  name: B,
+  pattern: RegExp
+) => {
+  type BrandedType = string & Brand.Brand<B>
+
+  const brand = Brand.refined<BrandedType>(
+    (s) => pattern.test(s),
+    (s) => Brand.error(`Invalid ${name}: ${s} does not match ${pattern}`)
+  )
+
+  const schema = Schema.String.pipe(
+    Schema.pattern(pattern),
+    Schema.brand(name)
+  )
+
+  return Object.assign(brand, {
+    schema,
+    Type: undefined as unknown as BrandedType
+  })
+}
+
+/**
+ * Create a branded non-empty string type.
+ *
+ * @example
+ * ```typescript
+ * import { makeBrandedNonEmptyString } from "@knpkv/atlassian-common"
+ *
+ * const PageId = makeBrandedNonEmptyString("PageId")
+ * type PageId = typeof PageId.Type
+ *
+ * const id = PageId("12345") // OK
+ * const bad = PageId("")     // Throws
+ * ```
+ *
+ * @category Brand
+ */
+export const makeBrandedNonEmptyString = <B extends string>(name: B) => {
+  type BrandedType = string & Brand.Brand<B>
+
+  const brand = Brand.refined<BrandedType>(
+    (s) => s.length > 0,
+    (_s) => Brand.error(`${name} cannot be empty`)
+  )
+
+  const schema = Schema.String.pipe(
+    Schema.nonEmptyString(),
+    Schema.brand(name)
+  )
+
+  return Object.assign(brand, {
+    schema,
+    Type: undefined as unknown as BrandedType
+  })
+}
+
+// Common branded types for Atlassian products
+
+/**
+ * Confluence Page ID (non-empty string).
+ *
+ * @category Brand
+ */
+export const PageId = makeBrandedNonEmptyString("PageId")
+export type PageId = typeof PageId.Type
+
+/**
+ * Confluence Space Key (uppercase alphanumeric).
+ *
+ * @category Brand
+ */
+export const SpaceKey = makeBrandedString("SpaceKey", /^[A-Z][A-Z0-9]*$/)
+export type SpaceKey = typeof SpaceKey.Type
+
+/**
+ * Jira Issue Key (PROJECT-123 format).
+ *
+ * @category Brand
+ */
+export const IssueKey = makeBrandedString("IssueKey", /^[A-Z][A-Z0-9]*-\d+$/)
+export type IssueKey = typeof IssueKey.Type
+
+/**
+ * Jira Project Key (uppercase alphanumeric).
+ *
+ * @category Brand
+ */
+export const ProjectKey = makeBrandedString("ProjectKey", /^[A-Z][A-Z0-9]*$/)
+export type ProjectKey = typeof ProjectKey.Type
+
+/**
+ * Content hash (SHA256 hex string).
+ *
+ * @category Brand
+ */
+export const ContentHash = makeBrandedString("ContentHash", /^[a-f0-9]{64}$/)
+export type ContentHash = typeof ContentHash.Type