@repo-toolkit/confluence 0.8.0

package/index.d.ts

@@ -0,0 +1,179 @@
+import { FlagSpec } from '@repo-toolkit/publish-package';
+export { FlagSpec, isPlainObject, parseFlags, resolveCliOptions } from '@repo-toolkit/publish-package';
+
+interface ConfluenceClientOptions {
+    baseUrl: string;
+    username: string;
+    apiToken: string;
+    fetch?: typeof fetch;
+    userAgent?: string;
+}
+interface PageBody {
+    representation: 'storage' | 'atlas_doc' | 'wiki' | 'view' | 'export_view';
+    value: string;
+}
+interface PageVersion {
+    number: number;
+    message?: string;
+}
+interface CreatePageInput {
+    spaceId: string;
+    title: string;
+    body: PageBody;
+    parentId?: string;
+    status?: 'current' | 'draft';
+}
+interface UpdatePageInput {
+    id: string;
+    title: string;
+    body: PageBody;
+    version: PageVersion;
+    status?: 'current' | 'draft';
+}
+interface Page {
+    id: string;
+    status: string;
+    title: string;
+    spaceId: string;
+    parentId?: string;
+    body?: {
+        storage?: {
+            value: string;
+            representation: string;
+        };
+    };
+    version: {
+        number: number;
+        createdAt?: string;
+        message?: string;
+    };
+    _links: {
+        webui: string;
+        self?: string;
+        base?: string;
+    };
+}
+interface Attachment {
+    id: string;
+    title: string;
+    filename?: string;
+    mediaType?: string;
+    fileSize?: number;
+    pageId?: string;
+    spaceId?: string;
+    version: {
+        number: number;
+        createdAt?: string;
+        message?: string;
+    };
+    _links: {
+        webui: string;
+        download?: string;
+        self?: string;
+    };
+}
+declare class ConfluenceApiError extends Error {
+    readonly status: number;
+    readonly endpoint: string;
+    readonly responseBody: string;
+    constructor(message: string, status: number, endpoint: string, responseBody: string);
+}
+declare class ConfluenceClient {
+    private readonly baseUrl;
+    private readonly authHeader;
+    private readonly fetchFn;
+    private readonly userAgent;
+    constructor(options: ConfluenceClientOptions);
+    getSpaceIdByKey(spaceKey: string): Promise<string>;
+    getPageByTitle(spaceId: string, title: string): Promise<Page | undefined>;
+    getPage(pageId: string): Promise<Page>;
+    createPage(input: CreatePageInput): Promise<Page>;
+    updatePage(input: UpdatePageInput): Promise<Page>;
+    getAttachments(pageId: string): Promise<Attachment[]>;
+    uploadAttachment(pageId: string, filePath: string, comment?: string): Promise<Attachment>;
+    updateAttachmentData(pageId: string, attachmentId: string, filePath: string, comment?: string): Promise<Attachment>;
+    private sendAttachmentMultipart;
+    private requestJson;
+    private v2Url;
+    private v1Url;
+}
+
+interface DocEntry {
+    /** Path segments relative to the root, e.g. ['guide', 'intro.md']. Always uses `/` separators. */
+    segments: string[];
+    /** Absolute path to the file on disk. */
+    absolute: string;
+}
+interface DocTree {
+    entries: DocEntry[];
+}
+declare function readDocTree(root: string, depth?: number): Promise<DocTree>;
+declare function isMarkdownName(name: string): boolean;
+declare function titleFromSegment(segment: string): string;
+
+interface MarkdownConvertResult {
+    html: string;
+}
+declare function markdownToStorage(markdown: string): MarkdownConvertResult;
+declare function renderInline(text: string): string;
+declare const LOCAL_IMAGE_PLACEHOLDER_RE: RegExp;
+declare function isRemoteUrl(src: string): boolean;
+declare function escapeXmlAttribute(text: string): string;
+declare function escapeAttachmentFilename(filename: string): string;
+
+interface RewriteResult {
+    html: string;
+    uploaded: ReadonlyArray<{
+        src: string;
+        attachment: Attachment;
+    }>;
+}
+interface RewriteOptions {
+    /** Directory used to resolve relative image src values. The markdown file's own dir. */
+    markdownDir: string;
+}
+declare function rewriteImagesToAttachments(html: string, pageId: string, client: ConfluenceClient, options: RewriteOptions): Promise<RewriteResult>;
+
+declare const INTERACTIVE_FLAG: FlagSpec;
+interface ConfluenceSyncOptions {
+    /** Documentation root folder (relative to `cwd`, or absolute). Required. */
+    folder?: string;
+    /** Confluence username or email. Required. */
+    username?: string;
+    /** Confluence API token (NOT account password). Required. */
+    apiToken?: string;
+    /** Confluence base URL ending with `/wiki`, e.g. `https://mydomain.atlassian.net/wiki`. Required. */
+    baseUrl?: string;
+    /** Confluence space key (e.g. `ENG` or `~1234`). Required; resolved to a spaceId via the API. */
+    spaceKey?: string;
+    /** Numeric Confluence page id of the parent under which docs will be published. Required. */
+    parentPageId?: string;
+    /** Working directory. Defaults to `process.cwd()`. */
+    cwd?: string;
+    /** Version-message suffix appended to every page/attachment PUT. */
+    versionMessage?: string;
+    /** Skip uploads that would have no markdown changes (default: true). */
+    skipUnchanged?: boolean;
+    /** Dry-run: walk the tree and print the plan but make no API calls. */
+    dryRun?: boolean;
+    /** Custom Confluence client instance (testing). When supplied, `username`/`apiToken`/`baseUrl` are ignored. */
+    client?: ConfluenceClient;
+    /** Logger sink; defaults to `console`. */
+    log?: (message: string) => void;
+}
+interface ConfluenceSyncPlan {
+    cwd: string;
+    folder: string;
+    username: string;
+    apiToken: string;
+    baseUrl: string;
+    spaceKey: string;
+    parentPageId: string;
+    versionMessage: string;
+    skipUnchanged: boolean;
+    dryRun: boolean;
+}
+declare function resolveConfluenceSyncPlan(options?: ConfluenceSyncOptions): ConfluenceSyncPlan;
+declare function syncConfluenceToDocs(options?: ConfluenceSyncOptions): Promise<void>;
+
+export { type Attachment, ConfluenceApiError, ConfluenceClient, type ConfluenceClientOptions, type ConfluenceSyncOptions, type ConfluenceSyncPlan, type DocEntry, type DocTree, INTERACTIVE_FLAG, LOCAL_IMAGE_PLACEHOLDER_RE, type Page, type PageBody, type PageVersion, escapeAttachmentFilename, escapeXmlAttribute, isMarkdownName, isRemoteUrl, markdownToStorage, readDocTree, renderInline, resolveConfluenceSyncPlan, resolveConfluenceSyncPlan as resolveSyncPlan, rewriteImagesToAttachments, syncConfluenceToDocs, titleFromSegment };