@telefonica/markdown-confluence-sync/dist/lib/confluence/ConfluenceSync.types.d.ts

Creates/updates/deletes Confluence pages based on markdown files in a directory. Supports Mermaid diagrams and per-page configuration using frontmatter metadata. Works great with Docusaurus

import type { ConfigNamespaceInterface, OptionInterfaceOfType, OptionDefinition } from "@mocks-server/config";
import type { LoggerInterface } from "@mocks-server/logger";
import type { ConfluenceInputPage, ConfluenceClientAuthenticationConfig } from "@telefonica/confluence-sync";
import type { ModeOption } from "../MarkdownConfluenceSync.types";
type UrlOptionValue = string;
type ApiPrefixOptionValue = string;
type PersonalAccessTokenOptionValue = string;
type SpaceKeyOptionValue = string;
type RootPageIdOptionValue = string;
type RootPageNameOptionValue = string;
type NoticeMessageOptionValue = string;
type NoticeTemplateOptionValue = string;
type DryRunOptionValue = boolean;
type RehypeCodeBlocksOptionValue = boolean;
type RehypeGithubAlertsOptionValue = boolean;
declare global {
    namespace MarkdownConfluenceSync {
        interface Config {
            confluence?: {
                /** Confluence URL */
                url?: UrlOptionValue;
                /** Optional prefix for the Confluence API urls. Default is `/rest/`. */
                apiPrefix?: string;
                /**
                 * Confluence personal access token
                 * @deprecated Use authentication.oauth2.accessToken instead
                 **/
                personalAccessToken?: PersonalAccessTokenOptionValue;
                /** Confluence authentication */
                authentication?: ConfluenceClientAuthenticationConfig;
                /** Confluence space key */
                spaceKey?: SpaceKeyOptionValue;
                /** Confluence root page id */
                rootPageId?: RootPageIdOptionValue;
                /** Customize Confluence page titles by adding a prefix to all of them for improved organization and clarity */
                rootPageName?: RootPageNameOptionValue;
                /** Notice message to add at the beginning of the Confluence pages */
                noticeMessage?: NoticeMessageOptionValue;
                /** Template string to use for the notice message. */
                noticeTemplate?: NoticeTemplateOptionValue;
                /** Confluence dry run */
                dryRun?: DryRunOptionValue;
            };
            rehype?: {
                /** Enable code blocks transformation to Confluence code macro */
                codeBlocks?: RehypeCodeBlocksOptionValue;
                /** Enable GitHub alerts transformation to Confluence info/note/warning/tip macros */
                githubAlerts?: RehypeGithubAlertsOptionValue;
            };
        }
    }
}
export type UrlOptionDefinition = OptionDefinition<UrlOptionValue>;
export type ApiPrefixOptionDefinition = OptionDefinition<ApiPrefixOptionValue>;
export type PersonalAccessTokenOptionDefinition = OptionDefinition<PersonalAccessTokenOptionValue>;
export type SpaceKeyOptionDefinition = OptionDefinition<SpaceKeyOptionValue>;
export type RootPageIdOptionDefinition = OptionDefinition<RootPageIdOptionValue>;
export type RootPageNameOptionDefinition = OptionDefinition<RootPageNameOptionValue>;
export type NoticeMessageOptionDefinition = OptionDefinition<NoticeMessageOptionValue>;
export type NoticeTemplateOptionDefinition = OptionDefinition<NoticeTemplateOptionValue>;
export type DryRunOptionDefinition = OptionDefinition<DryRunOptionValue, {
    hasDefault: true;
}>;
export type RehypeCodeBlocksOptionDefinition = OptionDefinition<RehypeCodeBlocksOptionValue>;
export type RehypeGithubAlertsOptionDefinition = OptionDefinition<RehypeGithubAlertsOptionValue>;
export type AuthenticationOptionDefinition = OptionDefinition<ConfluenceClientAuthenticationConfig>;
export type AuthenticationOption = OptionInterfaceOfType<ConfluenceClientAuthenticationConfig>;
export type UrlOption = OptionInterfaceOfType<UrlOptionValue>;
export type ApiPrefixOption = OptionInterfaceOfType<ApiPrefixOptionValue>;
export type PersonalAccessTokenOption = OptionInterfaceOfType<PersonalAccessTokenOptionValue>;
export type SpaceKeyOption = OptionInterfaceOfType<SpaceKeyOptionValue>;
export type RootPageIdOption = OptionInterfaceOfType<RootPageIdOptionValue>;
export type RootPageNameOption = OptionInterfaceOfType<RootPageNameOptionValue>;
export type NoticeMessageOption = OptionInterfaceOfType<NoticeMessageOptionValue>;
export type NoticeTemplateOption = OptionInterfaceOfType<NoticeTemplateOptionValue>;
export type DryRunOption = OptionInterfaceOfType<DryRunOptionValue, {
    hasDefault: true;
}>;
export type RehypeCodeBlocksOption = OptionInterfaceOfType<RehypeCodeBlocksOptionValue, {
    hasDefault: true;
}>;
export type RehypeGithubAlertsOption = OptionInterfaceOfType<RehypeGithubAlertsOptionValue, {
    hasDefault: true;
}>;
export interface ConfluenceSyncOptions {
    /** Configuration interface */
    config: ConfigNamespaceInterface;
    /** Logger interface */
    logger: LoggerInterface;
    /** Sync mode option */
    mode: ModeOption;
    /** Rehype configuration namespace */
    rehypeConfig: ConfigNamespaceInterface;
}
/** Creates a ConfluenceSyncInterface interface */
export interface ConfluenceSyncConstructor {
    /** Returns ConfluenceSyncInterface interface
     * @returns ConfluenceSync instance {@link ConfluenceSyncInterface}.
     */
    new (options: ConfluenceSyncOptions): ConfluenceSyncInterface;
}
export interface ConfluenceSyncInterface {
    /** Sync pages to Confluence */
    sync(pages: ConfluenceSyncPage[]): Promise<void>;
}
/** Represents a Confluence page with its path */
export interface ConfluenceSyncPage extends ConfluenceInputPage {
    /**
     * Confluence page ancestors
     * @override
     * @see {@link MarkdownDocument}
     */
    ancestors: string[];
    /** Confluence page path */
    path: string;
    /** Confluence page path relative to docs root dir */
    relativePath: string;
    /**
     * Confluence page name
     *
     * Forces the confluence page title in child pages' title.
     */
    name?: string;
}
export {};