@knpkv/confluence-to-markdown 0.5.0 → 0.7.0

package/src/ast/BlockNode.ts

@@ -1,469 +0,0 @@
-/**
- * Block-level AST node types for structural content.
- *
- * @module
- */
-import * as Schema from "effect/Schema"
-import { InlineNode, type InlineNode as InlineNodeType } 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 Confluence HTML for exact roundtrip preservation.
- * When present, the Confluence serializer will output this instead of reconstructing.
- *
- * @category BlockNode
- */
-export const RawConfluence = Schema.optional(Schema.String)
-
-/**
- * Heading element (h1-h6).
- *
- * @example
- * ```typescript
- * import { Heading, Text } from "@knpkv/confluence-to-markdown/ast"
- *
- * const h1 = new Heading({
- *   level: 1,
- *   children: [new Text({ value: "Introduction" })]
- * })
- * ```
- *
- * @category BlockNode
- */
-export class Heading extends Schema.TaggedClass<Heading>()("Heading", {
-  version: SchemaVersion,
-  level: Schema.Literal(1, 2, 3, 4, 5, 6),
-  children: Schema.Array(InlineNode),
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Text alignment options.
- *
- * @category BlockNode
- */
-export const TextAlignment = Schema.Literal("left", "center", "right")
-
-/**
- * Type for TextAlignment.
- *
- * @category Types
- */
-export type TextAlignment = Schema.Schema.Type<typeof TextAlignment>
-
-/**
- * Paragraph element with optional alignment and indentation.
- *
- * @example
- * ```typescript
- * import { Paragraph, Text } from "@knpkv/confluence-to-markdown/ast"
- *
- * const para = new Paragraph({
- *   children: [new Text({ value: "Hello world" })]
- * })
- *
- * // With alignment
- * const centered = new Paragraph({
- *   alignment: "center",
- *   children: [new Text({ value: "Centered text" })]
- * })
- *
- * // With indentation (in pixels)
- * const indented = new Paragraph({
- *   indent: 30,
- *   children: [new Text({ value: "Indented text" })]
- * })
- * ```
- *
- * @category BlockNode
- */
-export class Paragraph extends Schema.TaggedClass<Paragraph>()("Paragraph", {
-  version: SchemaVersion,
-  alignment: Schema.optional(TextAlignment),
-  indent: Schema.optional(Schema.Number),
-  children: Schema.Array(InlineNode),
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Code block with optional language.
- *
- * @example
- * ```typescript
- * import { CodeBlock } from "@knpkv/confluence-to-markdown/ast"
- *
- * const code = new CodeBlock({
- *   language: "typescript",
- *   code: "const x = 1"
- * })
- * ```
- *
- * @category BlockNode
- */
-export class CodeBlock extends Schema.TaggedClass<CodeBlock>()("CodeBlock", {
-  version: SchemaVersion,
-  language: Schema.optional(Schema.String),
-  code: Schema.String,
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Thematic break / horizontal rule.
- *
- * @example
- * ```typescript
- * import { ThematicBreak } from "@knpkv/confluence-to-markdown/ast"
- *
- * const hr = new ThematicBreak({})
- * ```
- *
- * @category BlockNode
- */
-export class ThematicBreak extends Schema.TaggedClass<ThematicBreak>()("ThematicBreak", {
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Attachment reference for images stored in Confluence.
- *
- * @category BlockNode
- */
-export const ImageAttachment = Schema.Struct({
-  filename: Schema.String,
-  version: Schema.optional(Schema.Number)
-})
-
-/**
- * Type for ImageAttachment.
- *
- * @category Types
- */
-export type ImageAttachment = Schema.Schema.Type<typeof ImageAttachment>
-
-/**
- * Image element with support for both URL and Confluence attachments.
- *
- * @example
- * ```typescript
- * import { Image } from "@knpkv/confluence-to-markdown/ast"
- *
- * // URL-based image
- * const img = new Image({
- *   src: "https://example.com/image.png",
- *   alt: "Example image"
- * })
- *
- * // Confluence attachment
- * const attachment = new Image({
- *   attachment: { filename: "logo.svg" },
- *   align: "center",
- *   width: 250
- * })
- * ```
- *
- * @category BlockNode
- */
-export class Image extends Schema.TaggedClass<Image>()("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),
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Table cell element.
- *
- * @example
- * ```typescript
- * import { TableCell, Text } from "@knpkv/confluence-to-markdown/ast"
- *
- * const cell = new TableCell({
- *   isHeader: true,
- *   children: [new Text({ value: "Header" })]
- * })
- * ```
- *
- * @category BlockNode
- */
-export class TableCell extends Schema.TaggedClass<TableCell>()("TableCell", {
-  isHeader: Schema.optionalWith(Schema.Boolean, { default: () => false }),
-  children: Schema.Array(InlineNode),
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Table row element.
- *
- * @example
- * ```typescript
- * import { TableRow, TableCell, Text } from "@knpkv/confluence-to-markdown/ast"
- *
- * const row = new TableRow({
- *   cells: [
- *     new TableCell({ children: [new Text({ value: "A" })] }),
- *     new TableCell({ children: [new Text({ value: "B" })] })
- *   ]
- * })
- * ```
- *
- * @category BlockNode
- */
-export class TableRow extends Schema.TaggedClass<TableRow>()("TableRow", {
-  cells: Schema.Array(TableCell),
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Table element with optional header row.
- *
- * @example
- * ```typescript
- * import { Table, TableRow, TableCell, Text } from "@knpkv/confluence-to-markdown/ast"
- *
- * const table = new Table({
- *   header: new TableRow({
- *     cells: [new TableCell({ isHeader: true, children: [new Text({ value: "Col" })] })]
- *   }),
- *   rows: []
- * })
- * ```
- *
- * @category BlockNode
- */
-export class Table extends Schema.TaggedClass<Table>()("Table", {
-  version: SchemaVersion,
-  header: Schema.optional(TableRow),
-  rows: Schema.Array(TableRow),
-  rawConfluence: RawConfluence
-}) {}
-
-/**
- * Unsupported block element - preserves raw content for round-tripping.
- *
- * @example
- * ```typescript
- * import { UnsupportedBlock } from "@knpkv/confluence-to-markdown/ast"
- *
- * const unknown = new UnsupportedBlock({
- *   rawHtml: "<custom-block>content</custom-block>",
- *   source: "confluence"
- * })
- * ```
- *
- * @category BlockNode
- */
-export class UnsupportedBlock extends Schema.TaggedClass<UnsupportedBlock>()("UnsupportedBlock", {
-  rawHtml: Schema.optional(Schema.String),
-  rawMarkdown: Schema.optional(Schema.String),
-  source: Schema.Literal("confluence", "markdown")
-}) {}
-
-// 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),
-  rawConfluence: RawConfluence
-})
-
-/**
- * Type for BlockQuote.
- *
- * @category Types
- */
-export type BlockQuote = Schema.Schema.Type<typeof BlockQuote>
-
-/**
- * List item with nested block content.
- *
- * Children may include any simple block as well as nested {@link List} elements.
- *
- * @category BlockNode
- */
-export interface ListItem {
-  readonly _tag: "ListItem"
-  readonly checked?: boolean | undefined
-  readonly children: ReadonlyArray<
-    Heading | Paragraph | CodeBlock | ThematicBreak | Image | Table | UnsupportedBlock | List
-  >
-  readonly rawConfluence?: string | undefined
-}
-
-/**
- * List element (ordered or unordered).
- *
- * @category BlockNode
- */
-export interface List {
-  readonly _tag: "List"
-  readonly version: number
-  readonly ordered: boolean
-  readonly start?: number | undefined
-  readonly children: ReadonlyArray<ListItem>
-  readonly rawConfluence?: string | undefined
-}
-
-// Encoded shapes (input to decode): `version` is optional via SchemaVersion's
-// optionalWith({ default }), and the recursive cycle is List → ListItem → List.
-export interface ListEncoded {
-  readonly _tag: "List"
-  readonly version?: number | undefined
-  readonly ordered: boolean
-  readonly start?: number | undefined
-  readonly children: ReadonlyArray<ListItemEncoded>
-  readonly rawConfluence?: string | undefined
-}
-
-export interface ListItemEncoded {
-  readonly _tag: "ListItem"
-  readonly checked?: boolean | undefined
-  readonly children: ReadonlyArray<
-    | Schema.Schema.Encoded<typeof Heading>
-    | Schema.Schema.Encoded<typeof Paragraph>
-    | Schema.Schema.Encoded<typeof CodeBlock>
-    | Schema.Schema.Encoded<typeof ThematicBreak>
-    | Schema.Schema.Encoded<typeof Image>
-    | Schema.Schema.Encoded<typeof Table>
-    | Schema.Schema.Encoded<typeof UnsupportedBlock>
-    | ListEncoded
-  >
-  readonly rawConfluence?: string | undefined
-}
-
-const ListItemChild = Schema.Union(
-  Heading,
-  Paragraph,
-  CodeBlock,
-  ThematicBreak,
-  Image,
-  Table,
-  UnsupportedBlock,
-  Schema.suspend((): Schema.Schema<List, ListEncoded> => List)
-)
-
-export const ListItem: Schema.Schema<ListItem, ListItemEncoded> = Schema.Struct({
-  _tag: Schema.Literal("ListItem"),
-  checked: Schema.optional(Schema.Boolean),
-  children: Schema.Array(ListItemChild),
-  rawConfluence: RawConfluence
-})
-
-export const List: Schema.Schema<List, ListEncoded> = Schema.Struct({
-  _tag: Schema.Literal("List"),
-  version: SchemaVersion,
-  ordered: Schema.Boolean,
-  start: Schema.optional(Schema.Number),
-  children: Schema.Array(ListItem),
-  rawConfluence: RawConfluence
-})
-
-/**
- * Task item with status for Confluence task lists.
- *
- * @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),
-  rawConfluence: RawConfluence
-})
-
-/**
- * Type for TaskItem.
- *
- * @category Types
- */
-export type TaskItem = Schema.Schema.Type<typeof TaskItem>
-
-/**
- * Task list (Confluence action items).
- *
- * @category BlockNode
- */
-export const TaskList = Schema.Struct({
-  _tag: Schema.Literal("TaskList"),
-  version: SchemaVersion,
-  children: Schema.Array(TaskItem),
-  rawConfluence: RawConfluence
-})
-
-/**
- * Type for TaskList.
- *
- * @category Types
- */
-export type TaskList = Schema.Schema.Type<typeof TaskList>
-
-/**
- * Union of all block node types.
- *
- * @category BlockNode
- */
-export const BlockNode = Schema.Union(
-  Heading,
-  Paragraph,
-  CodeBlock,
-  ThematicBreak,
-  BlockQuote,
-  Image,
-  Table,
-  List,
-  TaskList,
-  UnsupportedBlock
-)
-
-/**
- * Type for block nodes.
- *
- * @category Types
- */
-export type BlockNode =
-  | Heading
-  | Paragraph
-  | CodeBlock
-  | ThematicBreak
-  | BlockQuote
-  | Image
-  | Table
-  | List
-  | TaskList
-  | UnsupportedBlock
-
-/**
- * Type helper for inline node children in blocks.
- *
- * @category Types
- */
-export type { InlineNodeType as InlineNode }

package/src/ast/Document.ts

@@ -1,90 +0,0 @@
-/**
- * Document AST node - the root of the AST tree.
- *
- * @module
- */
-import * as Schema from "effect/Schema"
-import { BlockNode, type BlockNode as BlockNodeType, RawConfluence, SchemaVersion } from "./BlockNode.js"
-import { MacroNode, type MacroNode as MacroNodeType } from "./MacroNode.js"
-
-/**
- * Document node - represents a Block or Macro node.
- *
- * @category Document
- */
-export const DocumentNode = Schema.Union(BlockNode, MacroNode)
-
-/**
- * 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/confluence-to-markdown/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),
-  rawConfluence: RawConfluence
-})
-
-/**
- * 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/confluence-to-markdown/ast"
- *
- * const doc = makeDocument([
- *   new Heading({ level: 1, children: [new Text({ value: "Hello" })] })
- * ])
- * ```
- *
- * @category Constructors
- */
-export const makeDocument = (
-  children: ReadonlyArray<DocumentNode>,
-  rawConfluence?: string
-): Document => ({
-  version: 1,
-  children,
-  ...(rawConfluence !== undefined ? { rawConfluence } : {})
-})
-
-/**
- * Check if a node is a Document.
- *
- * @category Guards
- */
-export const isDocument = (value: unknown): value is Document =>
-  typeof value === "object" &&
-  value !== null &&
-  "children" in value &&
-  Array.isArray((value as Document).children)