@knpkv/atlassian-common 0.2.0

package/dist/ast/BlockNode.js

@@ -0,0 +1,279 @@
+/**
+ * Block-level AST nodes for Atlassian content (headings, paragraphs, tables, lists, etc.).
+ *
+ * **Mental model**
+ *
+ * - **Schema-driven ADT**: Each node is an Effect `Schema.Struct` with a `_tag` discriminant,
+ *   composed into the {@link BlockNode} union via `Schema.Union`.
+ * - **Recursive via suspend**: `List` → `ListItem` → `BlockNode` cycles use `Schema.suspend`
+ *   to break infinite type recursion.
+ * - **Inline children**: Most blocks contain `InlineNode` children for text-level content.
+ *
+ * @module
+ */
+import * as Schema from "effect/Schema";
+import { InlineNode } from "./InlineNode.js";
+/**
+ * Schema version for migration support.
+ *
+ * @category Version
+ */
+export const SchemaVersion = Schema.Number.pipe(Schema.int(), Schema.positive(), Schema.optionalWith({ default: () => 1 }));
+/**
+ * Optional raw source for exact roundtrip preservation.
+ *
+ * @category BlockNode
+ */
+export const RawSource = Schema.optional(Schema.String);
+/**
+ * Heading element (h1-h6).
+ *
+ * @example
+ * ```typescript
+ * import { Heading, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const h1 = new Heading({
+ *   level: 1,
+ *   children: [new Text({ value: "Introduction" })]
+ * })
+ * ```
+ *
+ * @category BlockNode
+ */
+export class Heading extends Schema.TaggedClass()("Heading", {
+    version: SchemaVersion,
+    level: Schema.Literal(1, 2, 3, 4, 5, 6),
+    children: Schema.Array(InlineNode),
+    rawSource: RawSource
+}) {
+}
+/**
+ * Text alignment options.
+ *
+ * @category BlockNode
+ */
+export const TextAlignment = Schema.Literal("left", "center", "right");
+/**
+ * Paragraph element with optional alignment and indentation.
+ *
+ * @example
+ * ```typescript
+ * import { Paragraph, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const para = new Paragraph({
+ *   children: [new Text({ value: "Hello world" })]
+ * })
+ * ```
+ *
+ * @category BlockNode
+ */
+export class Paragraph extends Schema.TaggedClass()("Paragraph", {
+    version: SchemaVersion,
+    alignment: Schema.optional(TextAlignment),
+    indent: Schema.optional(Schema.Number),
+    children: Schema.Array(InlineNode),
+    rawSource: RawSource
+}) {
+}
+/**
+ * Code block with optional language.
+ *
+ * @example
+ * ```typescript
+ * import { CodeBlock } from "@knpkv/atlassian-common/ast"
+ *
+ * const code = new CodeBlock({
+ *   language: "typescript",
+ *   code: "const x = 1"
+ * })
+ * ```
+ *
+ * @category BlockNode
+ */
+export class CodeBlock extends Schema.TaggedClass()("CodeBlock", {
+    version: SchemaVersion,
+    language: Schema.optional(Schema.String),
+    code: Schema.String,
+    rawSource: RawSource
+}) {
+}
+/**
+ * Thematic break / horizontal rule.
+ *
+ * @example
+ * ```typescript
+ * import { ThematicBreak } from "@knpkv/atlassian-common/ast"
+ *
+ * const hr = new ThematicBreak({})
+ * ```
+ *
+ * @category BlockNode
+ */
+export class ThematicBreak extends Schema.TaggedClass()("ThematicBreak", {
+    rawSource: RawSource
+}) {
+}
+/**
+ * Attachment reference for images.
+ *
+ * @category BlockNode
+ */
+export const ImageAttachment = Schema.Struct({
+    filename: Schema.String,
+    version: Schema.optional(Schema.Number)
+});
+/**
+ * Image element with support for both URL and attachments.
+ *
+ * @example
+ * ```typescript
+ * import { Image } from "@knpkv/atlassian-common/ast"
+ *
+ * const img = new Image({
+ *   src: "https://example.com/image.png",
+ *   alt: "Example image"
+ * })
+ * ```
+ *
+ * @category BlockNode
+ */
+export class Image extends Schema.TaggedClass()("Image", {
+    version: SchemaVersion,
+    src: Schema.optional(Schema.String),
+    attachment: Schema.optional(ImageAttachment),
+    alt: Schema.optional(Schema.String),
+    title: Schema.optional(Schema.String),
+    align: Schema.optional(Schema.String),
+    width: Schema.optional(Schema.Number),
+    rawSource: RawSource
+}) {
+}
+/**
+ * Table cell element.
+ *
+ * @example
+ * ```typescript
+ * import { TableCell, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const cell = new TableCell({
+ *   isHeader: true,
+ *   children: [new Text({ value: "Header" })]
+ * })
+ * ```
+ *
+ * @category BlockNode
+ */
+export class TableCell extends Schema.TaggedClass()("TableCell", {
+    isHeader: Schema.optionalWith(Schema.Boolean, { default: () => false }),
+    children: Schema.Array(InlineNode),
+    rawSource: RawSource
+}) {
+}
+/**
+ * Table row element.
+ *
+ * @category BlockNode
+ */
+export class TableRow extends Schema.TaggedClass()("TableRow", {
+    cells: Schema.Array(TableCell),
+    rawSource: RawSource
+}) {
+}
+/**
+ * Table element with optional header row.
+ *
+ * @category BlockNode
+ */
+export class Table extends Schema.TaggedClass()("Table", {
+    version: SchemaVersion,
+    header: Schema.optional(TableRow),
+    rows: Schema.Array(TableRow),
+    rawSource: RawSource
+}) {
+}
+/**
+ * Unsupported block element - preserves raw content for round-tripping.
+ *
+ * @category BlockNode
+ */
+export class UnsupportedBlock extends Schema.TaggedClass()("UnsupportedBlock", {
+    rawHtml: Schema.optional(Schema.String),
+    rawMarkdown: Schema.optional(Schema.String),
+    rawAdf: Schema.optional(Schema.String),
+    source: Schema.Literal("confluence", "markdown", "adf")
+}) {
+}
+// Non-recursive block nodes
+const SimpleBlockNode = Schema.Union(Heading, Paragraph, CodeBlock, ThematicBreak, Image, Table, UnsupportedBlock);
+/**
+ * Block quote element with nested block content.
+ *
+ * @category BlockNode
+ */
+export const BlockQuote = Schema.Struct({
+    _tag: Schema.Literal("BlockQuote"),
+    version: SchemaVersion,
+    children: Schema.Array(SimpleBlockNode),
+    rawSource: RawSource
+});
+/**
+ * List item with nested block content.
+ *
+ * @category BlockNode
+ */
+export const ListItem = Schema.Struct({
+    _tag: Schema.Literal("ListItem"),
+    checked: Schema.optional(Schema.Boolean),
+    children: Schema.Array(SimpleBlockNode),
+    rawSource: RawSource
+});
+/**
+ * List element (ordered or unordered).
+ *
+ * @category BlockNode
+ */
+export const List = Schema.Struct({
+    _tag: Schema.Literal("List"),
+    version: SchemaVersion,
+    ordered: Schema.Boolean,
+    start: Schema.optional(Schema.Number),
+    children: Schema.Array(ListItem),
+    rawSource: RawSource
+});
+/**
+ * Task item with status.
+ *
+ * @category BlockNode
+ */
+export const TaskItem = Schema.Struct({
+    _tag: Schema.Literal("TaskItem"),
+    id: Schema.String,
+    uuid: Schema.String,
+    status: Schema.Literal("incomplete", "complete"),
+    body: Schema.Array(InlineNode),
+    rawSource: RawSource
+});
+/**
+ * Task list.
+ *
+ * @category BlockNode
+ */
+export const TaskList = Schema.Struct({
+    _tag: Schema.Literal("TaskList"),
+    version: SchemaVersion,
+    children: Schema.Array(TaskItem),
+    rawSource: RawSource
+});
+/**
+ * Union of all block node types.
+ *
+ * @category BlockNode
+ */
+export const BlockNode = Schema.Union(Heading, Paragraph, CodeBlock, ThematicBreak, BlockQuote, Image, Table, List, TaskList, UnsupportedBlock);
+/**
+ * Simple block nodes (non-recursive).
+ *
+ * @category BlockNode
+ */
+export { SimpleBlockNode };
+//# sourceMappingURL=BlockNode.js.map

package/dist/ast/BlockNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockNode.js","sourceRoot":"","sources":["../../src/ast/BlockNode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,UAAU,EAAqC,MAAM,iBAAiB,CAAA;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAC7C,MAAM,CAAC,GAAG,EAAE,EACZ,MAAM,CAAC,QAAQ,EAAE,EACjB,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAC1C,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;AAEvD;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,OAAQ,SAAQ,MAAM,CAAC,WAAW,EAAW,CAAC,SAAS,EAAE;IACpE,OAAO,EAAE,aAAa;IACtB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;IAClC,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;AAStE;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,SAAU,SAAQ,MAAM,CAAC,WAAW,EAAa,CAAC,WAAW,EAAE;IAC1E,OAAO,EAAE,aAAa;IACtB,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;IAClC,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,SAAU,SAAQ,MAAM,CAAC,WAAW,EAAa,CAAC,WAAW,EAAE;IAC1E,OAAO,EAAE,aAAa;IACtB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,aAAc,SAAQ,MAAM,CAAC,WAAW,EAAiB,CAAC,eAAe,EAAE;IACtF,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC,MAAM;IACvB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;CACxC,CAAC,CAAA;AASF;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,KAAM,SAAQ,MAAM,CAAC,WAAW,EAAS,CAAC,OAAO,EAAE;IAC9D,OAAO,EAAE,aAAa;IACtB,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC5C,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACnC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACrC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACrC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACrC,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,SAAU,SAAQ,MAAM,CAAC,WAAW,EAAa,CAAC,WAAW,EAAE;IAC1E,QAAQ,EAAE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;IACvE,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;IAClC,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;GAIG;AACH,MAAM,OAAO,QAAS,SAAQ,MAAM,CAAC,WAAW,EAAY,CAAC,UAAU,EAAE;IACvE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;IAC9B,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;GAIG;AACH,MAAM,OAAO,KAAM,SAAQ,MAAM,CAAC,WAAW,EAAS,CAAC,OAAO,EAAE;IAC9D,OAAO,EAAE,aAAa;IACtB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC5B,SAAS,EAAE,SAAS;CACrB,CAAC;CAAG;AAEL;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC,WAAW,EAAoB,CAAC,kBAAkB,EAAE;IAC/F,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC;CACxD,CAAC;CAAG;AAEL,4BAA4B;AAC5B,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,CAClC,OAAO,EACP,SAAS,EACT,SAAS,EACT,aAAa,EACb,KAAK,EACL,KAAK,EACL,gBAAgB,CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;IAClC,OAAO,EAAE,aAAa;IACtB,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC;IACvC,SAAS,EAAE,SAAS;CACrB,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC;IACvC,SAAS,EAAE,SAAS;CACrB,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,MAAM,CAAC,OAAO;IACvB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACrC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;IAChC,SAAS,EAAE,SAAS;CACrB,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;IAChC,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,UAAU,CAAC;IAChD,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;IAC9B,SAAS,EAAE,SAAS;CACrB,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;IAChC,OAAO,EAAE,aAAa;IACtB,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;IAChC,SAAS,EAAE,SAAS;CACrB,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CACnC,OAAO,EACP,SAAS,EACT,SAAS,EACT,aAAa,EACb,UAAU,EACV,KAAK,EACL,KAAK,EACL,IAAI,EACJ,QAAQ,EACR,gBAAgB,CACjB,CAAA;AA0BD;;;;GAIG;AACH,OAAO,EAAE,eAAe,EAAE,CAAA"}

package/dist/ast/Document.d.ts

@@ -0,0 +1,255 @@
+/**
+ * Root AST node wrapping a sequence of {@link DocumentNode} children.
+ *
+ * **Mental model**
+ *
+ * - **Document = version + children**: The top-level container for parsed Atlassian content.
+ *   `children` is a union of `BlockNode | MacroNode`.
+ * - **Raw source preservation**: Optional `rawSource` field enables lossless roundtripping.
+ *
+ * **Common tasks**
+ *
+ * - Construct a document: {@link makeDocument}
+ * - Type-guard check: {@link isDocument}
+ *
+ * @module
+ */
+import * as Schema from "effect/Schema";
+import { type BlockNode as BlockNodeType } from "./BlockNode.js";
+import { type MacroNode as MacroNodeType } from "./MacroNode.js";
+/**
+ * Document node - represents a Block or Macro node.
+ *
+ * @category Document
+ */
+export declare const DocumentNode: Schema.Union<[Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, Schema.Struct<{
+    _tag: Schema.Literal<["BlockQuote"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, Schema.Struct<{
+    _tag: Schema.Literal<["List"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    ordered: typeof Schema.Boolean;
+    start: Schema.optional<typeof Schema.Number>;
+    children: Schema.Array$<Schema.Struct<{
+        _tag: Schema.Literal<["ListItem"]>;
+        checked: Schema.optional<typeof Schema.Boolean>;
+        children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>, Schema.Struct<{
+    _tag: Schema.Literal<["TaskList"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    children: Schema.Array$<Schema.Struct<{
+        _tag: Schema.Literal<["TaskItem"]>;
+        id: typeof Schema.String;
+        uuid: typeof Schema.String;
+        status: Schema.Literal<["incomplete", "complete"]>;
+        body: Schema.Array$<Schema.Union<[typeof import("./InlineNode.ts").Text, typeof import("./InlineNode.ts").Strong, typeof import("./InlineNode.ts").Emphasis, typeof import("./InlineNode.ts").InlineCode, typeof import("./InlineNode.ts").Link, typeof import("./InlineNode.ts").LineBreak, typeof import("./InlineNode.ts").Emoticon, typeof import("./InlineNode.ts").UserMention, typeof import("./InlineNode.ts").DateTime, typeof import("./InlineNode.ts").Underline, typeof import("./InlineNode.ts").Subscript, typeof import("./InlineNode.ts").Superscript, typeof import("./InlineNode.ts").Strikethrough, typeof import("./InlineNode.ts").ColoredText, typeof import("./InlineNode.ts").Highlight, typeof import("./InlineNode.ts").UnsupportedInline]>>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>, typeof import("./BlockNode.js").UnsupportedBlock]>, Schema.Union<[Schema.Struct<{
+    _tag: Schema.Literal<["InfoPanel"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    panelType: Schema.Literal<["info", "warning", "note", "tip", "error", "panel"]>;
+    title: Schema.optional<typeof Schema.String>;
+    children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>, Schema.Struct<{
+    _tag: Schema.Literal<["ExpandMacro"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    title: Schema.optional<typeof Schema.String>;
+    children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>, Schema.Struct<{
+    _tag: Schema.Literal<["TocMacro"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    minLevel: Schema.optional<typeof Schema.Number>;
+    maxLevel: Schema.optional<typeof Schema.Number>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>, Schema.Struct<{
+    _tag: Schema.Literal<["CodeMacro"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    language: Schema.optional<typeof Schema.String>;
+    title: Schema.optional<typeof Schema.String>;
+    code: typeof Schema.String;
+    lineNumbers: Schema.optionalWith<typeof Schema.Boolean, {
+        default: () => false;
+    }>;
+    collapse: Schema.optionalWith<typeof Schema.Boolean, {
+        default: () => false;
+    }>;
+    firstLine: Schema.optional<typeof Schema.Number>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>, Schema.Struct<{
+    _tag: Schema.Literal<["StatusMacro"]>;
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    text: typeof Schema.String;
+    color: Schema.Literal<["Grey", "Red", "Yellow", "Green", "Blue"]>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>]>]>;
+/**
+ * Type for document nodes.
+ *
+ * @category Types
+ */
+export type DocumentNode = BlockNodeType | MacroNodeType;
+/**
+ * Document schema - the root AST node.
+ *
+ * @example
+ * ```typescript
+ * import { Document, Heading, Paragraph, Text } from "@knpkv/atlassian-common/ast"
+ * import * as Schema from "effect/Schema"
+ *
+ * const doc = {
+ *   version: 1,
+ *   children: [
+ *     new Heading({ level: 1, children: [new Text({ value: "Title" })] }),
+ *     new Paragraph({ children: [new Text({ value: "Content" })] })
+ *   ]
+ * }
+ *
+ * const validated = Schema.decodeUnknownSync(Document)(doc)
+ * ```
+ *
+ * @category Document
+ */
+export declare const Document: Schema.Struct<{
+    version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+        default: () => number;
+    }>;
+    children: Schema.Array$<Schema.Union<[Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, Schema.Struct<{
+        _tag: Schema.Literal<["BlockQuote"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, Schema.Struct<{
+        _tag: Schema.Literal<["List"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        ordered: typeof Schema.Boolean;
+        start: Schema.optional<typeof Schema.Number>;
+        children: Schema.Array$<Schema.Struct<{
+            _tag: Schema.Literal<["ListItem"]>;
+            checked: Schema.optional<typeof Schema.Boolean>;
+            children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+            rawSource: Schema.optional<typeof Schema.String>;
+        }>>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>, Schema.Struct<{
+        _tag: Schema.Literal<["TaskList"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        children: Schema.Array$<Schema.Struct<{
+            _tag: Schema.Literal<["TaskItem"]>;
+            id: typeof Schema.String;
+            uuid: typeof Schema.String;
+            status: Schema.Literal<["incomplete", "complete"]>;
+            body: Schema.Array$<Schema.Union<[typeof import("./InlineNode.ts").Text, typeof import("./InlineNode.ts").Strong, typeof import("./InlineNode.ts").Emphasis, typeof import("./InlineNode.ts").InlineCode, typeof import("./InlineNode.ts").Link, typeof import("./InlineNode.ts").LineBreak, typeof import("./InlineNode.ts").Emoticon, typeof import("./InlineNode.ts").UserMention, typeof import("./InlineNode.ts").DateTime, typeof import("./InlineNode.ts").Underline, typeof import("./InlineNode.ts").Subscript, typeof import("./InlineNode.ts").Superscript, typeof import("./InlineNode.ts").Strikethrough, typeof import("./InlineNode.ts").ColoredText, typeof import("./InlineNode.ts").Highlight, typeof import("./InlineNode.ts").UnsupportedInline]>>;
+            rawSource: Schema.optional<typeof Schema.String>;
+        }>>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>, typeof import("./BlockNode.js").UnsupportedBlock]>, Schema.Union<[Schema.Struct<{
+        _tag: Schema.Literal<["InfoPanel"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        panelType: Schema.Literal<["info", "warning", "note", "tip", "error", "panel"]>;
+        title: Schema.optional<typeof Schema.String>;
+        children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>, Schema.Struct<{
+        _tag: Schema.Literal<["ExpandMacro"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        title: Schema.optional<typeof Schema.String>;
+        children: Schema.Array$<Schema.Union<[typeof import("./BlockNode.js").Heading, typeof import("./BlockNode.js").Paragraph, typeof import("./BlockNode.js").CodeBlock, typeof import("./BlockNode.js").ThematicBreak, typeof import("./BlockNode.js").Image, typeof import("./BlockNode.js").Table, typeof import("./BlockNode.js").UnsupportedBlock]>>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>, Schema.Struct<{
+        _tag: Schema.Literal<["TocMacro"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        minLevel: Schema.optional<typeof Schema.Number>;
+        maxLevel: Schema.optional<typeof Schema.Number>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>, Schema.Struct<{
+        _tag: Schema.Literal<["CodeMacro"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        language: Schema.optional<typeof Schema.String>;
+        title: Schema.optional<typeof Schema.String>;
+        code: typeof Schema.String;
+        lineNumbers: Schema.optionalWith<typeof Schema.Boolean, {
+            default: () => false;
+        }>;
+        collapse: Schema.optionalWith<typeof Schema.Boolean, {
+            default: () => false;
+        }>;
+        firstLine: Schema.optional<typeof Schema.Number>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>, Schema.Struct<{
+        _tag: Schema.Literal<["StatusMacro"]>;
+        version: Schema.optionalWith<Schema.filter<Schema.filter<typeof Schema.Number>>, {
+            default: () => number;
+        }>;
+        text: typeof Schema.String;
+        color: Schema.Literal<["Grey", "Red", "Yellow", "Green", "Blue"]>;
+        rawSource: Schema.optional<typeof Schema.String>;
+    }>]>]>>;
+    rawSource: Schema.optional<typeof Schema.String>;
+}>;
+/**
+ * Type for Document.
+ *
+ * @category Types
+ */
+export type Document = Schema.Schema.Type<typeof Document>;
+/**
+ * Create a new Document with default version.
+ *
+ * @example
+ * ```typescript
+ * import { makeDocument, Heading, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const doc = makeDocument([
+ *   new Heading({ level: 1, children: [new Text({ value: "Hello" })] })
+ * ])
+ * ```
+ *
+ * @category Constructors
+ */
+export declare const makeDocument: (children: ReadonlyArray<DocumentNode>, rawSource?: string) => Document;
+/**
+ * Check if a node is a Document.
+ *
+ * @category Guards
+ */
+export declare const isDocument: (value: unknown) => value is Document;
+//# sourceMappingURL=Document.d.ts.map

package/dist/ast/Document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../../src/ast/Document.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAa,KAAK,SAAS,IAAI,aAAa,EAA4B,MAAM,gBAAgB,CAAA;AACrG,OAAO,EAAa,KAAK,SAAS,IAAI,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE3E;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAqC,CAAA;AAE9D;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,aAAa,CAAA;AAExD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAInB,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAA;AAE1D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,GACvB,UAAU,aAAa,CAAC,YAAY,CAAC,EACrC,YAAY,MAAM,KACjB,QAID,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,QAIR,CAAA"}

package/dist/ast/Document.js

@@ -0,0 +1,80 @@
+/**
+ * Root AST node wrapping a sequence of {@link DocumentNode} children.
+ *
+ * **Mental model**
+ *
+ * - **Document = version + children**: The top-level container for parsed Atlassian content.
+ *   `children` is a union of `BlockNode | MacroNode`.
+ * - **Raw source preservation**: Optional `rawSource` field enables lossless roundtripping.
+ *
+ * **Common tasks**
+ *
+ * - Construct a document: {@link makeDocument}
+ * - Type-guard check: {@link isDocument}
+ *
+ * @module
+ */
+import * as Schema from "effect/Schema";
+import { BlockNode, RawSource, SchemaVersion } from "./BlockNode.js";
+import { MacroNode } from "./MacroNode.js";
+/**
+ * Document node - represents a Block or Macro node.
+ *
+ * @category Document
+ */
+export const DocumentNode = Schema.Union(BlockNode, MacroNode);
+/**
+ * Document schema - the root AST node.
+ *
+ * @example
+ * ```typescript
+ * import { Document, Heading, Paragraph, Text } from "@knpkv/atlassian-common/ast"
+ * import * as Schema from "effect/Schema"
+ *
+ * const doc = {
+ *   version: 1,
+ *   children: [
+ *     new Heading({ level: 1, children: [new Text({ value: "Title" })] }),
+ *     new Paragraph({ children: [new Text({ value: "Content" })] })
+ *   ]
+ * }
+ *
+ * const validated = Schema.decodeUnknownSync(Document)(doc)
+ * ```
+ *
+ * @category Document
+ */
+export const Document = Schema.Struct({
+    version: SchemaVersion,
+    children: Schema.Array(DocumentNode),
+    rawSource: RawSource
+});
+/**
+ * Create a new Document with default version.
+ *
+ * @example
+ * ```typescript
+ * import { makeDocument, Heading, Text } from "@knpkv/atlassian-common/ast"
+ *
+ * const doc = makeDocument([
+ *   new Heading({ level: 1, children: [new Text({ value: "Hello" })] })
+ * ])
+ * ```
+ *
+ * @category Constructors
+ */
+export const makeDocument = (children, rawSource) => ({
+    version: 1,
+    children,
+    ...(rawSource !== undefined ? { rawSource } : {})
+});
+/**
+ * Check if a node is a Document.
+ *
+ * @category Guards
+ */
+export const isDocument = (value) => typeof value === "object" &&
+    value !== null &&
+    "children" in value &&
+    Array.isArray(value.children);
+//# sourceMappingURL=Document.js.map

package/dist/ast/Document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document.js","sourceRoot":"","sources":["../../src/ast/Document.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,SAAS,EAAmC,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACrG,OAAO,EAAE,SAAS,EAAmC,MAAM,gBAAgB,CAAA;AAE3E;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;AAS9D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,aAAa;IACtB,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC;IACpC,SAAS,EAAE,SAAS;CACrB,CAAC,CAAA;AASF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,QAAqC,EACrC,SAAkB,EACR,EAAE,CAAC,CAAC;IACd,OAAO,EAAE,CAAC;IACV,QAAQ;IACR,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;CAClD,CAAC,CAAA;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAc,EAAqB,EAAE,CAC9D,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACd,UAAU,IAAI,KAAK;IACnB,KAAK,CAAC,OAAO,CAAE,KAAkB,CAAC,QAAQ,CAAC,CAAA"}