@knpkv/confluence-to-markdown 0.2.0

package/dist/MarkdownConverter.d.ts

@@ -0,0 +1,50 @@
+/**
+ * HTML to Markdown conversion service using unified/remark/rehype.
+ *
+ * @module
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import { ConversionError } from "./ConfluenceError.js";
+declare const MarkdownConverter_base: Context.TagClass<MarkdownConverter, "@knpkv/confluence-to-markdown/MarkdownConverter", {
+    /**
+     * Convert Confluence storage format (HTML) to GitHub Flavored Markdown.
+     */
+    readonly htmlToMarkdown: (html: string) => Effect.Effect<string, ConversionError>;
+    /**
+     * Convert GitHub Flavored Markdown to HTML (Confluence storage format).
+     */
+    readonly markdownToHtml: (markdown: string) => Effect.Effect<string, ConversionError>;
+}>;
+/**
+ * Markdown conversion service for HTML <-> GFM conversion.
+ *
+ * @example
+ * ```typescript
+ * import { MarkdownConverter } from "@knpkv/confluence-to-markdown/MarkdownConverter"
+ * import { Effect } from "effect"
+ *
+ * const program = Effect.gen(function* () {
+ *   const converter = yield* MarkdownConverter
+ *   const md = yield* converter.htmlToMarkdown("<h1>Hello</h1><p>World</p>")
+ *   console.log(md) // # Hello\n\nWorld
+ * })
+ *
+ * Effect.runPromise(
+ *   program.pipe(Effect.provide(MarkdownConverter.layer))
+ * )
+ * ```
+ *
+ * @category Conversion
+ */
+export declare class MarkdownConverter extends MarkdownConverter_base {
+}
+/**
+ * Layer that provides the MarkdownConverter service.
+ *
+ * @category Layers
+ */
+export declare const layer: Layer.Layer<MarkdownConverter>;
+export {};
+//# sourceMappingURL=MarkdownConverter.d.ts.map

package/dist/MarkdownConverter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownConverter.d.ts","sourceRoot":"","sources":["../src/MarkdownConverter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AASrC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;;IA4BlD;;OAEG;6BACsB,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;IAEjF;;OAEG;6BACsB,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC;;AAlCzF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,iBAAkB,SAAQ,sBAepC;CAAG;AAuGN;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAwBhD,CAAA"}

package/dist/MarkdownConverter.js

@@ -0,0 +1,151 @@
+/**
+ * HTML to Markdown conversion service using unified/remark/rehype.
+ *
+ * @module
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import rehypeParse from "rehype-parse";
+import rehypeRemark from "rehype-remark";
+import rehypeStringify from "rehype-stringify";
+import remarkGfm from "remark-gfm";
+import remarkParse from "remark-parse";
+import remarkRehype from "remark-rehype";
+import remarkStringify from "remark-stringify";
+import { unified } from "unified";
+import { ConversionError } from "./ConfluenceError.js";
+/**
+ * Markdown conversion service for HTML <-> GFM conversion.
+ *
+ * @example
+ * ```typescript
+ * import { MarkdownConverter } from "@knpkv/confluence-to-markdown/MarkdownConverter"
+ * import { Effect } from "effect"
+ *
+ * const program = Effect.gen(function* () {
+ *   const converter = yield* MarkdownConverter
+ *   const md = yield* converter.htmlToMarkdown("<h1>Hello</h1><p>World</p>")
+ *   console.log(md) // # Hello\n\nWorld
+ * })
+ *
+ * Effect.runPromise(
+ *   program.pipe(Effect.provide(MarkdownConverter.layer))
+ * )
+ * ```
+ *
+ * @category Conversion
+ */
+export class MarkdownConverter extends Context.Tag("@knpkv/confluence-to-markdown/MarkdownConverter")() {
+}
+/** Maximum HTML input size (1MB) to prevent ReDoS attacks */
+const MAX_HTML_SIZE = 1024 * 1024;
+/**
+ * Strip Confluence-specific macros while preserving text content.
+ * Uses iterative approach to avoid ReDoS with nested content.
+ */
+const stripConfluenceMacros = (html) => Effect.gen(function* () {
+    // Limit input size to prevent ReDoS
+    if (html.length > MAX_HTML_SIZE) {
+        return yield* Effect.fail(new ConversionError({
+            direction: "htmlToMarkdown",
+            cause: `HTML input too large: ${html.length} bytes (max ${MAX_HTML_SIZE})`
+        }));
+    }
+    let result = html;
+    // Process structured macros iteratively to handle nesting safely
+    let iterations = 0;
+    const maxIterations = 100; // Prevent infinite loops
+    while (iterations < maxIterations) {
+        const macroStart = result.indexOf("<ac:structured-macro");
+        if (macroStart === -1)
+            break;
+        // Find matching closing tag by counting nesting
+        let depth = 1;
+        let pos = macroStart + 20; // Skip past opening tag start
+        let endPos = -1;
+        while (pos < result.length && depth > 0) {
+            if (result.slice(pos, pos + 20) === "<ac:structured-macro") {
+                depth++;
+                pos += 20;
+            }
+            else if (result.slice(pos, pos + 21) === "</ac:structured-macro") {
+                depth--;
+                if (depth === 0) {
+                    endPos = result.indexOf(">", pos) + 1;
+                }
+                pos += 21;
+            }
+            else {
+                pos++;
+            }
+        }
+        if (endPos === -1)
+            break; // Malformed HTML, stop processing
+        const macroContent = result.slice(macroStart, endPos);
+        // Extract content from macro
+        let replacement = "";
+        const plainBodyStart = macroContent.indexOf("<ac:plain-text-body><![CDATA[");
+        const plainBodyEnd = macroContent.indexOf("]]></ac:plain-text-body>");
+        if (plainBodyStart !== -1 && plainBodyEnd !== -1) {
+            const content = macroContent.slice(plainBodyStart + 29, plainBodyEnd);
+            replacement = `<pre><code>${content}</code></pre>`;
+        }
+        else {
+            const richBodyStart = macroContent.indexOf("<ac:rich-text-body>");
+            const richBodyEnd = macroContent.indexOf("</ac:rich-text-body>");
+            if (richBodyStart !== -1 && richBodyEnd !== -1) {
+                replacement = macroContent.slice(richBodyStart + 19, richBodyEnd);
+            }
+        }
+        result = result.slice(0, macroStart) + replacement + result.slice(endPos);
+        iterations++;
+    }
+    // Remove remaining simple tags with non-greedy bounded patterns
+    result = result
+        .replace(/<ac:parameter[^>]{0,1000}>[^<]{0,10000}<\/ac:parameter>/gi, "")
+        .replace(/<\/?ac:[a-z-]{1,50}[^>]{0,1000}>/gi, "")
+        .replace(/<\/?ri:[a-z-]{1,50}[^>]{0,1000}\/?>/gi, "");
+    return result;
+});
+/**
+ * Create the markdown converter processor for HTML -> Markdown.
+ */
+const createHtmlToMdProcessor = () => unified()
+    .use(rehypeParse, { fragment: true })
+    .use(rehypeRemark)
+    .use(remarkGfm)
+    .use(remarkStringify);
+/**
+ * Create the markdown converter processor for Markdown -> HTML.
+ */
+const createMdToHtmlProcessor = () => unified()
+    .use(remarkParse)
+    .use(remarkGfm)
+    .use(remarkRehype)
+    .use(rehypeStringify);
+/**
+ * Layer that provides the MarkdownConverter service.
+ *
+ * @category Layers
+ */
+export const layer = Layer.succeed(MarkdownConverter, MarkdownConverter.of({
+    htmlToMarkdown: (html) => Effect.gen(function* () {
+        const cleaned = yield* stripConfluenceMacros(html);
+        return yield* Effect.try({
+            try: () => {
+                const result = createHtmlToMdProcessor().processSync(cleaned);
+                return String(result).trim();
+            },
+            catch: (cause) => new ConversionError({ direction: "htmlToMarkdown", cause })
+        });
+    }),
+    markdownToHtml: (markdown) => Effect.try({
+        try: () => {
+            const result = createMdToHtmlProcessor().processSync(markdown);
+            return String(result).trim();
+        },
+        catch: (cause) => new ConversionError({ direction: "markdownToHtml", cause })
+    })
+}));
+//# sourceMappingURL=MarkdownConverter.js.map

package/dist/MarkdownConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownConverter.js","sourceRoot":"","sources":["../src/MarkdownConverter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,WAAW,MAAM,cAAc,CAAA;AACtC,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,eAAe,MAAM,kBAAkB,CAAA;AAC9C,OAAO,SAAS,MAAM,YAAY,CAAA;AAClC,OAAO,WAAW,MAAM,cAAc,CAAA;AACtC,OAAO,YAAY,MAAM,eAAe,CAAA;AACxC,OAAO,eAAe,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,iBAAkB,SAAQ,OAAO,CAAC,GAAG,CAChD,iDAAiD,CAClD,EAaE;CAAG;AAEN,6DAA6D;AAC7D,MAAM,aAAa,GAAG,IAAI,GAAG,IAAI,CAAA;AAEjC;;;GAGG;AACH,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAA0C,EAAE,CACrF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,oCAAoC;IACpC,IAAI,IAAI,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CACvB,IAAI,eAAe,CAAC;YAClB,SAAS,EAAE,gBAAgB;YAC3B,KAAK,EAAE,yBAAyB,IAAI,CAAC,MAAM,eAAe,aAAa,GAAG;SAC3E,CAAC,CACH,CAAA;IACH,CAAC;IAED,IAAI,MAAM,GAAG,IAAI,CAAA;IAEjB,iEAAiE;IACjE,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,MAAM,aAAa,GAAG,GAAG,CAAA,CAAC,yBAAyB;IAEnD,OAAO,UAAU,GAAG,aAAa,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAA;QACzD,IAAI,UAAU,KAAK,CAAC,CAAC;YAAE,MAAK;QAE5B,gDAAgD;QAChD,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,IAAI,GAAG,GAAG,UAAU,GAAG,EAAE,CAAA,CAAC,8BAA8B;QACxD,IAAI,MAAM,GAAG,CAAC,CAAC,CAAA;QAEf,OAAO,GAAG,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACxC,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,KAAK,sBAAsB,EAAE,CAAC;gBAC3D,KAAK,EAAE,CAAA;gBACP,GAAG,IAAI,EAAE,CAAA;YACX,CAAC;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,KAAK,uBAAuB,EAAE,CAAC;gBACnE,KAAK,EAAE,CAAA;gBACP,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oBAChB,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;gBACvC,CAAC;gBACD,GAAG,IAAI,EAAE,CAAA;YACX,CAAC;iBAAM,CAAC;gBACN,GAAG,EAAE,CAAA;YACP,CAAC;QACH,CAAC;QAED,IAAI,MAAM,KAAK,CAAC,CAAC;YAAE,MAAK,CAAC,kCAAkC;QAE3D,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QAErD,6BAA6B;QAC7B,IAAI,WAAW,GAAG,EAAE,CAAA;QACpB,MAAM,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAA;QAC5E,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAA;QACrE,IAAI,cAAc,KAAK,CAAC,CAAC,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;YACjD,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,cAAc,GAAG,EAAE,EAAE,YAAY,CAAC,CAAA;YACrE,WAAW,GAAG,cAAc,OAAO,eAAe,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;YACjE,MAAM,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAA;YAChE,IAAI,aAAa,KAAK,CAAC,CAAC,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC/C,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,GAAG,EAAE,EAAE,WAAW,CAAC,CAAA;YACnE,CAAC;QACH,CAAC;QAED,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACzE,UAAU,EAAE,CAAA;IACd,CAAC;IAED,gEAAgE;IAChE,MAAM,GAAG,MAAM;SACZ,OAAO,CAAC,2DAA2D,EAAE,EAAE,CAAC;SACxE,OAAO,CAAC,oCAAoC,EAAE,EAAE,CAAC;SACjD,OAAO,CAAC,uCAAuC,EAAE,EAAE,CAAC,CAAA;IAEvD,OAAO,MAAM,CAAA;AACf,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,uBAAuB,GAAG,GAAG,EAAE,CACnC,OAAO,EAAE;KACN,GAAG,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;KACpC,GAAG,CAAC,YAAY,CAAC;KACjB,GAAG,CAAC,SAAS,CAAC;KACd,GAAG,CAAC,eAAe,CAAC,CAAA;AAEzB;;GAEG;AACH,MAAM,uBAAuB,GAAG,GAAG,EAAE,CACnC,OAAO,EAAE;KACN,GAAG,CAAC,WAAW,CAAC;KAChB,GAAG,CAAC,SAAS,CAAC;KACd,GAAG,CAAC,YAAY,CAAC;KACjB,GAAG,CAAC,eAAe,CAAC,CAAA;AAEzB;;;;GAIG;AACH,MAAM,CAAC,MAAM,KAAK,GAAmC,KAAK,CAAC,OAAO,CAChE,iBAAiB,EACjB,iBAAiB,CAAC,EAAE,CAAC;IACnB,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE,CACvB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;QAClD,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;YACvB,GAAG,EAAE,GAAG,EAAE;gBACR,MAAM,MAAM,GAAG,uBAAuB,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;gBAC7D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAA;YAC9B,CAAC;YACD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;SAC9E,CAAC,CAAA;IACJ,CAAC,CAAC;IAEJ,cAAc,EAAE,CAAC,QAAQ,EAAE,EAAE,CAC3B,MAAM,CAAC,GAAG,CAAC;QACT,GAAG,EAAE,GAAG,EAAE;YACR,MAAM,MAAM,GAAG,uBAAuB,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAC9D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAA;QAC9B,CAAC;QACD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,eAAe,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC;KAC9E,CAAC;CACL,CAAC,CACH,CAAA"}

package/dist/Schemas.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Schema definitions for configuration and data structures.
+ *
+ * @module
+ */
+import * as Schema from "effect/Schema";
+/**
+ * Schema for .confluence.json configuration file.
+ *
+ * @example
+ * ```typescript
+ * import { ConfluenceConfigFileSchema } from "@knpkv/confluence-to-markdown/Schemas"
+ * import * as Schema from "effect/Schema"
+ *
+ * const config = Schema.decodeUnknownSync(ConfluenceConfigFileSchema)({
+ *   rootPageId: "12345",
+ *   baseUrl: "https://mysite.atlassian.net"
+ * })
+ * ```
+ *
+ * @category Schema
+ */
+export declare const ConfluenceConfigFileSchema: Schema.Struct<{
+    /** Root page ID to sync from */
+    rootPageId: Schema.brand<Schema.filter<typeof Schema.String>, "PageId">;
+    /** Confluence Cloud base URL */
+    baseUrl: Schema.filter<typeof Schema.String>;
+    /** Optional space key */
+    spaceKey: Schema.optional<Schema.brand<Schema.filter<Schema.filter<typeof Schema.String>>, "SpaceKey">>;
+    /** Local docs path (default: .docs/confluence) */
+    docsPath: Schema.optionalWith<typeof Schema.String, {
+        default: () => string;
+    }>;
+    /** Glob patterns to exclude from sync */
+    excludePatterns: Schema.optionalWith<Schema.Array$<typeof Schema.String>, {
+        default: () => never[];
+    }>;
+}>;
+/**
+ * Type for .confluence.json configuration file.
+ *
+ * @category Types
+ */
+export type ConfluenceConfigFile = Schema.Schema.Type<typeof ConfluenceConfigFileSchema>;
+/**
+ * Schema for page front-matter in markdown files.
+ *
+ * @example
+ * ```typescript
+ * import { PageFrontMatterSchema } from "@knpkv/confluence-to-markdown/Schemas"
+ * import * as Schema from "effect/Schema"
+ *
+ * const frontMatter = Schema.decodeUnknownSync(PageFrontMatterSchema)({
+ *   pageId: "12345",
+ *   version: 3,
+ *   title: "My Page",
+ *   updated: "2025-01-15T10:30:00Z",
+ *   contentHash: "a".repeat(64)
+ * })
+ * ```
+ *
+ * @category Schema
+ */
+export declare const PageFrontMatterSchema: Schema.Struct<{
+    /** Confluence page ID */
+    pageId: Schema.brand<Schema.filter<typeof Schema.String>, "PageId">;
+    /** Page version number */
+    version: Schema.filter<Schema.filter<typeof Schema.Number>>;
+    /** Page title */
+    title: Schema.filter<typeof Schema.String>;
+    /** Last updated timestamp (ISO8601) */
+    updated: typeof Schema.DateFromString;
+    /** Parent page ID (optional) */
+    parentId: Schema.optional<Schema.brand<Schema.filter<typeof Schema.String>, "PageId">>;
+    /** Position among siblings (optional) */
+    position: Schema.optional<typeof Schema.Number>;
+    /** SHA256 hash of content for change detection */
+    contentHash: Schema.brand<Schema.filter<typeof Schema.String>, "ContentHash">;
+}>;
+/**
+ * Type for page front-matter.
+ *
+ * @category Types
+ */
+export type PageFrontMatter = Schema.Schema.Type<typeof PageFrontMatterSchema>;
+/**
+ * Schema for new page front-matter (no pageId yet).
+ *
+ * @category Schema
+ */
+export declare const NewPageFrontMatterSchema: Schema.Struct<{
+    /** Page title */
+    title: Schema.filter<typeof Schema.String>;
+    /** Parent page ID (optional, determined by directory structure) */
+    parentId: Schema.optional<Schema.brand<Schema.filter<typeof Schema.String>, "PageId">>;
+}>;
+/**
+ * Type for new page front-matter.
+ *
+ * @category Types
+ */
+export type NewPageFrontMatter = Schema.Schema.Type<typeof NewPageFrontMatterSchema>;
+/**
+ * Schema for sync state file (.sync-state.json).
+ *
+ * @category Schema
+ */
+export declare const SyncStateSchema: Schema.Struct<{
+    /** Last sync timestamp */
+    lastSync: typeof Schema.DateFromString;
+    /** Map of page ID to sync info */
+    pages: Schema.Record$<typeof Schema.String, Schema.Struct<{
+        /** Local file path */
+        localPath: typeof Schema.String;
+        /** Last synced version */
+        version: typeof Schema.Number;
+        /** Content hash at last sync */
+        contentHash: Schema.brand<Schema.filter<typeof Schema.String>, "ContentHash">;
+    }>>;
+}>;
+/**
+ * Type for sync state.
+ *
+ * @category Types
+ */
+export type SyncState = Schema.Schema.Type<typeof SyncStateSchema>;
+/**
+ * Schema for Confluence page API response (full, from getPage).
+ *
+ * @category Schema
+ */
+export declare const PageResponseSchema: Schema.Struct<{
+    id: typeof Schema.String;
+    title: typeof Schema.String;
+    status: Schema.optional<typeof Schema.String>;
+    version: Schema.Struct<{
+        number: typeof Schema.Number;
+        createdAt: Schema.optional<typeof Schema.String>;
+    }>;
+    body: Schema.optional<Schema.Struct<{
+        storage: Schema.optional<Schema.Struct<{
+            value: typeof Schema.String;
+            representation: Schema.optional<typeof Schema.String>;
+        }>>;
+    }>>;
+    parentId: Schema.optional<typeof Schema.String>;
+    position: Schema.optional<typeof Schema.Number>;
+    _links: Schema.optional<Schema.Struct<{
+        webui: Schema.optional<typeof Schema.String>;
+    }>>;
+}>;
+/**
+ * Type for page API response.
+ *
+ * @category Types
+ */
+export type PageResponse = Schema.Schema.Type<typeof PageResponseSchema>;
+/**
+ * Schema for page list item (children list, version optional).
+ *
+ * @category Schema
+ */
+export declare const PageListItemSchema: Schema.Struct<{
+    id: typeof Schema.String;
+    title: typeof Schema.String;
+    status: Schema.optional<typeof Schema.String>;
+    version: Schema.optional<Schema.Struct<{
+        number: typeof Schema.Number;
+        createdAt: Schema.optional<typeof Schema.String>;
+    }>>;
+    body: Schema.optional<Schema.Struct<{
+        storage: Schema.optional<Schema.Struct<{
+            value: typeof Schema.String;
+            representation: Schema.optional<typeof Schema.String>;
+        }>>;
+    }>>;
+    parentId: Schema.optional<typeof Schema.String>;
+    position: Schema.optional<typeof Schema.Number>;
+    _links: Schema.optional<Schema.Struct<{
+        webui: Schema.optional<typeof Schema.String>;
+    }>>;
+}>;
+/**
+ * Type for page list item.
+ *
+ * @category Types
+ */
+export type PageListItem = Schema.Schema.Type<typeof PageListItemSchema>;
+/**
+ * Schema for page children API response.
+ *
+ * @category Schema
+ */
+export declare const PageChildrenResponseSchema: Schema.Struct<{
+    results: Schema.Array$<Schema.Struct<{
+        id: typeof Schema.String;
+        title: typeof Schema.String;
+        status: Schema.optional<typeof Schema.String>;
+        version: Schema.optional<Schema.Struct<{
+            number: typeof Schema.Number;
+            createdAt: Schema.optional<typeof Schema.String>;
+        }>>;
+        body: Schema.optional<Schema.Struct<{
+            storage: Schema.optional<Schema.Struct<{
+                value: typeof Schema.String;
+                representation: Schema.optional<typeof Schema.String>;
+            }>>;
+        }>>;
+        parentId: Schema.optional<typeof Schema.String>;
+        position: Schema.optional<typeof Schema.Number>;
+        _links: Schema.optional<Schema.Struct<{
+            webui: Schema.optional<typeof Schema.String>;
+        }>>;
+    }>>;
+    _links: Schema.optional<Schema.Struct<{
+        next: Schema.optional<typeof Schema.String>;
+    }>>;
+}>;
+/**
+ * Type for page children response.
+ *
+ * @category Types
+ */
+export type PageChildrenResponse = Schema.Schema.Type<typeof PageChildrenResponseSchema>;
+//# sourceMappingURL=Schemas.d.ts.map

package/dist/Schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schemas.d.ts","sourceRoot":"","sources":["../src/Schemas.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,0BAA0B;IACrC,gCAAgC;;IAEhC,gCAAgC;;IAIhC,yBAAyB;;IAEzB,kDAAkD;;;;IAElD,yCAAyC;;;;EAEzC,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAExF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,qBAAqB;IAChC,yBAAyB;;IAEzB,0BAA0B;;IAE1B,iBAAiB;;IAEjB,uCAAuC;;IAEvC,gCAAgC;;IAEhC,yCAAyC;;IAEzC,kDAAkD;;EAElD,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAE9E;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;IACnC,iBAAiB;;IAEjB,mEAAmE;;EAEnE,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAEpF;;;;GAIG;AACH,eAAO,MAAM,eAAe;IAC1B,0BAA0B;;IAE1B,kCAAkC;;QAI9B,sBAAsB;;QAEtB,0BAA0B;;QAE1B,gCAAgC;;;EAIpC,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAA;AAElE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;EAyB7B,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAExE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;EAyB7B,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAExE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;EAOrC,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,0BAA0B,CAAC,CAAA"}

package/dist/Schemas.js

@@ -0,0 +1,164 @@
+/**
+ * Schema definitions for configuration and data structures.
+ *
+ * @module
+ */
+import * as Schema from "effect/Schema";
+import { ContentHashSchema, PageIdSchema, SpaceKeySchema } from "./Brand.js";
+/**
+ * Schema for .confluence.json configuration file.
+ *
+ * @example
+ * ```typescript
+ * import { ConfluenceConfigFileSchema } from "@knpkv/confluence-to-markdown/Schemas"
+ * import * as Schema from "effect/Schema"
+ *
+ * const config = Schema.decodeUnknownSync(ConfluenceConfigFileSchema)({
+ *   rootPageId: "12345",
+ *   baseUrl: "https://mysite.atlassian.net"
+ * })
+ * ```
+ *
+ * @category Schema
+ */
+export const ConfluenceConfigFileSchema = Schema.Struct({
+    /** Root page ID to sync from */
+    rootPageId: PageIdSchema,
+    /** Confluence Cloud base URL */
+    baseUrl: Schema.String.pipe(Schema.pattern(/^https:\/\/[a-z0-9-]+\.atlassian\.net$/)),
+    /** Optional space key */
+    spaceKey: Schema.optional(SpaceKeySchema),
+    /** Local docs path (default: .docs/confluence) */
+    docsPath: Schema.optionalWith(Schema.String, { default: () => ".docs/confluence" }),
+    /** Glob patterns to exclude from sync */
+    excludePatterns: Schema.optionalWith(Schema.Array(Schema.String), { default: () => [] })
+});
+/**
+ * Schema for page front-matter in markdown files.
+ *
+ * @example
+ * ```typescript
+ * import { PageFrontMatterSchema } from "@knpkv/confluence-to-markdown/Schemas"
+ * import * as Schema from "effect/Schema"
+ *
+ * const frontMatter = Schema.decodeUnknownSync(PageFrontMatterSchema)({
+ *   pageId: "12345",
+ *   version: 3,
+ *   title: "My Page",
+ *   updated: "2025-01-15T10:30:00Z",
+ *   contentHash: "a".repeat(64)
+ * })
+ * ```
+ *
+ * @category Schema
+ */
+export const PageFrontMatterSchema = Schema.Struct({
+    /** Confluence page ID */
+    pageId: PageIdSchema,
+    /** Page version number */
+    version: Schema.Number.pipe(Schema.int(), Schema.positive()),
+    /** Page title */
+    title: Schema.String.pipe(Schema.nonEmptyString()),
+    /** Last updated timestamp (ISO8601) */
+    updated: Schema.DateFromString,
+    /** Parent page ID (optional) */
+    parentId: Schema.optional(PageIdSchema),
+    /** Position among siblings (optional) */
+    position: Schema.optional(Schema.Number),
+    /** SHA256 hash of content for change detection */
+    contentHash: ContentHashSchema
+});
+/**
+ * Schema for new page front-matter (no pageId yet).
+ *
+ * @category Schema
+ */
+export const NewPageFrontMatterSchema = Schema.Struct({
+    /** Page title */
+    title: Schema.String.pipe(Schema.nonEmptyString()),
+    /** Parent page ID (optional, determined by directory structure) */
+    parentId: Schema.optional(PageIdSchema)
+});
+/**
+ * Schema for sync state file (.sync-state.json).
+ *
+ * @category Schema
+ */
+export const SyncStateSchema = Schema.Struct({
+    /** Last sync timestamp */
+    lastSync: Schema.DateFromString,
+    /** Map of page ID to sync info */
+    pages: Schema.Record({
+        key: Schema.String,
+        value: Schema.Struct({
+            /** Local file path */
+            localPath: Schema.String,
+            /** Last synced version */
+            version: Schema.Number,
+            /** Content hash at last sync */
+            contentHash: ContentHashSchema
+        })
+    })
+});
+/**
+ * Schema for Confluence page API response (full, from getPage).
+ *
+ * @category Schema
+ */
+export const PageResponseSchema = Schema.Struct({
+    id: Schema.String,
+    title: Schema.String,
+    status: Schema.optional(Schema.String),
+    version: Schema.Struct({
+        number: Schema.Number,
+        createdAt: Schema.optional(Schema.String)
+    }),
+    body: Schema.optional(Schema.Struct({
+        storage: Schema.optional(Schema.Struct({
+            value: Schema.String,
+            representation: Schema.optional(Schema.String)
+        }))
+    })),
+    parentId: Schema.optional(Schema.String),
+    position: Schema.optional(Schema.Number),
+    _links: Schema.optional(Schema.Struct({
+        webui: Schema.optional(Schema.String)
+    }))
+});
+/**
+ * Schema for page list item (children list, version optional).
+ *
+ * @category Schema
+ */
+export const PageListItemSchema = Schema.Struct({
+    id: Schema.String,
+    title: Schema.String,
+    status: Schema.optional(Schema.String),
+    version: Schema.optional(Schema.Struct({
+        number: Schema.Number,
+        createdAt: Schema.optional(Schema.String)
+    })),
+    body: Schema.optional(Schema.Struct({
+        storage: Schema.optional(Schema.Struct({
+            value: Schema.String,
+            representation: Schema.optional(Schema.String)
+        }))
+    })),
+    parentId: Schema.optional(Schema.String),
+    position: Schema.optional(Schema.Number),
+    _links: Schema.optional(Schema.Struct({
+        webui: Schema.optional(Schema.String)
+    }))
+});
+/**
+ * Schema for page children API response.
+ *
+ * @category Schema
+ */
+export const PageChildrenResponseSchema = Schema.Struct({
+    results: Schema.Array(PageListItemSchema),
+    _links: Schema.optional(Schema.Struct({
+        next: Schema.optional(Schema.String)
+    }))
+});
+//# sourceMappingURL=Schemas.js.map

package/dist/Schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schemas.js","sourceRoot":"","sources":["../src/Schemas.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE5E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,CAAC;IACtD,gCAAgC;IAChC,UAAU,EAAE,YAAY;IACxB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CACzB,MAAM,CAAC,OAAO,CAAC,wCAAwC,CAAC,CACzD;IACD,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC;IACzC,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,kBAAkB,EAAE,CAAC;IACnF,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;CACzF,CAAC,CAAA;AASF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjD,yBAAyB;IACzB,MAAM,EAAE,YAAY;IACpB,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC5D,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IAClD,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC,cAAc;IAC9B,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC;IACvC,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,kDAAkD;IAClD,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IAClD,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC;CACxC,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC,cAAc;IAC/B,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC,MAAM;QAClB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACnB,sBAAsB;YACtB,SAAS,EAAE,MAAM,CAAC,MAAM;YACxB,0BAA0B;YAC1B,OAAO,EAAE,MAAM,CAAC,MAAM;YACtB,gCAAgC;YAChC,WAAW,EAAE,iBAAiB;SAC/B,CAAC;KACH,CAAC;CACH,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM;IACpB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;KAC1C,CAAC;IACF,IAAI,EAAE,MAAM,CAAC,QAAQ,CACnB,MAAM,CAAC,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC,QAAQ,CACtB,MAAM,CAAC,MAAM,CAAC;YACZ,KAAK,EAAE,MAAM,CAAC,MAAM;YACpB,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;SAC/C,CAAC,CACH;KACF,CAAC,CACH;IACD,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC,QAAQ,CACrB,MAAM,CAAC,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM;IACpB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;QACrC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;KAC1C,CAAC,CAAC;IACH,IAAI,EAAE,MAAM,CAAC,QAAQ,CACnB,MAAM,CAAC,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC,QAAQ,CACtB,MAAM,CAAC,MAAM,CAAC;YACZ,KAAK,EAAE,MAAM,CAAC,MAAM;YACpB,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;SAC/C,CAAC,CACH;KACF,CAAC,CACH;IACD,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC,QAAQ,CACrB,MAAM,CAAC,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;KACtC,CAAC,CACH;CACF,CAAC,CAAA;AASF;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,CAAC;IACtD,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC,QAAQ,CACrB,MAAM,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;KACrC,CAAC,CACH;CACF,CAAC,CAAA"}