markdownfly 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,217 @@
+/**
+ * Configuration type definitions
+ */
+interface MarkdownFlyConfig {
+    theme: string;
+    author?: string;
+    date?: string;
+    footer?: string;
+    /** Base directory for relative image paths (defaults to the .md file's dir) */
+    resourceDir?: string;
+    /** Default layout for slides without @(layout=...) (auto-detection used when unset) */
+    layout?: string;
+}
+
+/**
+ * Slide IR (Intermediate Representation)
+ * Core data structures for the MarkdownFly pipeline
+ */
+
+/** Available slide layouts */
+type SlideLayout = 'title' | 'section' | 'content' | 'two-column' | 'code' | 'quote' | 'blank' | 'closing';
+/** A layout marker inside a slide: starts a new row (===) or column (<->) */
+interface BreakElement {
+    type: 'break';
+    direction: 'row' | 'col';
+}
+/** Callout box (> [!NOTE]/[!TIP]/[...]) */
+interface CalloutElement {
+    type: 'callout';
+    variant: string;
+    /** Custom title from "> [!WARNING] my title"; defaults to variant name */
+    title?: string;
+    content: string;
+}
+/** Slide-level directives parsed from @(key=value, ...) */
+interface SlideDirectives {
+    layout?: string;
+    notes?: string;
+    chart?: string;
+    highlight?: string;
+    background?: string;
+    steps?: boolean;
+}
+interface TextElement {
+    type: 'text';
+    content: string;
+    bold?: boolean;
+    italic?: boolean;
+}
+interface HeadingElement {
+    type: 'heading';
+    content: string;
+    level: number;
+}
+interface ListElement {
+    type: 'list';
+    items: string[];
+    ordered: boolean;
+    /** Parallel to items; present only for task lists (- [x] / - [ ]) */
+    checked?: boolean[];
+}
+interface CodeElement {
+    type: 'code';
+    content: string;
+    language?: string;
+    /** 1-based line numbers to highlight (from @(highlight=...)) */
+    highlightLines?: number[];
+}
+type ImageAlign = 'left' | 'center' | 'right';
+interface ImageElement {
+    type: 'image';
+    src: string;
+    alt?: string;
+    /**
+     * Optional size from `![alt](src){w=6in}` — normalized to inches
+     * (e.g. '6in') or percentage of the column (e.g. '60%')
+     */
+    width?: string;
+    height?: string;
+    /** Horizontal alignment inside the column (default 'center') */
+    align?: ImageAlign;
+}
+interface TableElement {
+    type: 'table';
+    headers: string[];
+    rows: string[][];
+}
+interface BlockquoteElement {
+    type: 'blockquote';
+    content: string;
+}
+interface DiagramElement {
+    type: 'diagram';
+    diagramType: string;
+    content: string;
+}
+type SlideElement = TextElement | HeadingElement | ListElement | CodeElement | ImageElement | TableElement | BlockquoteElement | DiagramElement | BreakElement | CalloutElement;
+/** A single slide in the presentation */
+interface SlideNode {
+    layout: SlideLayout;
+    title?: string;
+    subtitle?: string;
+    elements: SlideElement[];
+    notes?: string;
+    directives?: SlideDirectives;
+    metadata?: Record<string, unknown>;
+}
+/** The complete presentation */
+interface Presentation {
+    config: MarkdownFlyConfig;
+    slides: SlideNode[];
+}
+
+/**
+ * Markdown Parser
+ * Main entry point: markdown string → Presentation
+ */
+
+/**
+ * Parse a markdown string into a Presentation
+ */
+declare function parseMarkdown(markdown: string): Presentation;
+
+/**
+ * Theme type definitions
+ */
+interface ThemeGradient {
+    /** Gradient start color (hex, without '#') */
+    from: string;
+    /** Gradient end color (hex, without '#') */
+    to: string;
+    /** CSS-style angle: 0 = to top, 90 = to right, 180 = to bottom, 135 = to bottom-right */
+    angle?: number;
+}
+interface ThemeColors {
+    primary: string;
+    secondary: string;
+    background: string;
+    text: string;
+    accent: string;
+    codeBackground: string;
+    codeText: string;
+    titleBackground?: string;
+    titleText?: string;
+    /** Background color used to mark @(highlight=...) lines in code blocks */
+    highlightBackground?: string;
+    /**
+     * Optional linear gradient stretched over the whole slide.
+     * When set it wins over `background` (and over `titleBackground` on cover slides);
+     * `background` stays as the flat fallback and drives dark/light detection for diagrams.
+     */
+    backgroundGradient?: ThemeGradient;
+}
+interface ThemeFonts {
+    heading: string;
+    body: string;
+    code: string;
+    cjk: string;
+}
+interface ThemeFontSizes {
+    title: number;
+    heading: number;
+    body: number;
+    code: number;
+    small: number;
+}
+interface Theme {
+    name: string;
+    colors: ThemeColors;
+    fonts: ThemeFonts;
+    fontSize: ThemeFontSizes;
+    shikiTheme?: string;
+}
+
+declare const cleanTheme: Theme;
+
+declare const academicTheme: Theme;
+
+declare const darkTheme: Theme;
+
+declare const businessTheme: Theme;
+
+declare const warmTheme: Theme;
+
+declare const defaultTheme: Theme;
+
+declare const themes: Record<string, Theme>;
+declare function getTheme(name?: string): Theme;
+
+/**
+ * Diagram Registry
+ * Unified entry point for all diagram renderers
+ */
+
+/** Check if a code block language is a diagram type */
+declare function isDiagramLanguage(language: string): boolean;
+/**
+ * Render a diagram code block to PNG
+ * @returns PNG image as Buffer
+ */
+declare function renderDiagram(language: string, code: string, theme?: Theme): Promise<Buffer>;
+
+/**
+ * MarkdownFly — Main orchestration
+ * Public API: convert(inputPath, options) → outputPath
+ */
+interface ConvertOptions {
+    output?: string;
+    theme?: string;
+}
+/**
+ * Convert a Markdown file to PPTX
+ * @returns Absolute path of the generated .pptx file
+ */
+declare function convert(inputPath: string, options?: ConvertOptions): Promise<string>;
+
+export { type ConvertOptions, type MarkdownFlyConfig, type Presentation, type SlideElement, type SlideNode, type Theme, academicTheme, businessTheme, cleanTheme, convert, darkTheme, defaultTheme, getTheme, isDiagramLanguage, parseMarkdown, renderDiagram, themes, warmTheme };