@pep/term-deck 1.0.13 → 1.0.15

package/dist/index.d.ts

@@ -0,0 +1,670 @@
+import { z } from 'zod';
+
+/**
+ * Schema for validating deck configuration (deck.config.ts).
+ * Defines the complete configuration for a presentation deck.
+ */
+declare const DeckConfigSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodString>;
+    date: z.ZodOptional<z.ZodString>;
+    theme: z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        author: z.ZodOptional<z.ZodString>;
+        version: z.ZodOptional<z.ZodString>;
+        colors: z.ZodObject<{
+            primary: z.ZodString;
+            secondary: z.ZodOptional<z.ZodString>;
+            accent: z.ZodString;
+            background: z.ZodString;
+            text: z.ZodString;
+            muted: z.ZodString;
+            success: z.ZodOptional<z.ZodString>;
+            warning: z.ZodOptional<z.ZodString>;
+            error: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            primary?: string;
+            secondary?: string;
+            accent?: string;
+            background?: string;
+            text?: string;
+            muted?: string;
+            success?: string;
+            warning?: string;
+            error?: string;
+        }, {
+            primary?: string;
+            secondary?: string;
+            accent?: string;
+            background?: string;
+            text?: string;
+            muted?: string;
+            success?: string;
+            warning?: string;
+            error?: string;
+        }>;
+        gradients: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>, Record<string, string[]>, Record<string, string[]>>;
+        glyphs: z.ZodString;
+        animations: z.ZodObject<{
+            revealSpeed: z.ZodDefault<z.ZodNumber>;
+            matrixDensity: z.ZodDefault<z.ZodNumber>;
+            glitchIterations: z.ZodDefault<z.ZodNumber>;
+            lineDelay: z.ZodDefault<z.ZodNumber>;
+            matrixInterval: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            revealSpeed?: number;
+            matrixDensity?: number;
+            glitchIterations?: number;
+            lineDelay?: number;
+            matrixInterval?: number;
+        }, {
+            revealSpeed?: number;
+            matrixDensity?: number;
+            glitchIterations?: number;
+            lineDelay?: number;
+            matrixInterval?: number;
+        }>;
+        window: z.ZodOptional<z.ZodObject<{
+            borderStyle: z.ZodDefault<z.ZodEnum<["line", "double", "rounded", "none"]>>;
+            shadow: z.ZodDefault<z.ZodBoolean>;
+            padding: z.ZodOptional<z.ZodObject<{
+                top: z.ZodDefault<z.ZodNumber>;
+                bottom: z.ZodDefault<z.ZodNumber>;
+                left: z.ZodDefault<z.ZodNumber>;
+                right: z.ZodDefault<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            }, {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            borderStyle?: "line" | "double" | "rounded" | "none";
+            shadow?: boolean;
+            padding?: {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            };
+        }, {
+            borderStyle?: "line" | "double" | "rounded" | "none";
+            shadow?: boolean;
+            padding?: {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            };
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        description?: string;
+        author?: string;
+        version?: string;
+        colors?: {
+            primary?: string;
+            secondary?: string;
+            accent?: string;
+            background?: string;
+            text?: string;
+            muted?: string;
+            success?: string;
+            warning?: string;
+            error?: string;
+        };
+        gradients?: Record<string, string[]>;
+        glyphs?: string;
+        animations?: {
+            revealSpeed?: number;
+            matrixDensity?: number;
+            glitchIterations?: number;
+            lineDelay?: number;
+            matrixInterval?: number;
+        };
+        window?: {
+            borderStyle?: "line" | "double" | "rounded" | "none";
+            shadow?: boolean;
+            padding?: {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            };
+        };
+    }, {
+        name?: string;
+        description?: string;
+        author?: string;
+        version?: string;
+        colors?: {
+            primary?: string;
+            secondary?: string;
+            accent?: string;
+            background?: string;
+            text?: string;
+            muted?: string;
+            success?: string;
+            warning?: string;
+            error?: string;
+        };
+        gradients?: Record<string, string[]>;
+        glyphs?: string;
+        animations?: {
+            revealSpeed?: number;
+            matrixDensity?: number;
+            glitchIterations?: number;
+            lineDelay?: number;
+            matrixInterval?: number;
+        };
+        window?: {
+            borderStyle?: "line" | "double" | "rounded" | "none";
+            shadow?: boolean;
+            padding?: {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            };
+        };
+    }>;
+    settings: z.ZodOptional<z.ZodObject<{
+        startSlide: z.ZodDefault<z.ZodNumber>;
+        loop: z.ZodDefault<z.ZodBoolean>;
+        autoAdvance: z.ZodDefault<z.ZodNumber>;
+        showSlideNumbers: z.ZodDefault<z.ZodBoolean>;
+        showProgress: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        startSlide?: number;
+        loop?: boolean;
+        autoAdvance?: number;
+        showSlideNumbers?: boolean;
+        showProgress?: boolean;
+    }, {
+        startSlide?: number;
+        loop?: boolean;
+        autoAdvance?: number;
+        showSlideNumbers?: boolean;
+        showProgress?: boolean;
+    }>>;
+    export: z.ZodOptional<z.ZodObject<{
+        width: z.ZodDefault<z.ZodNumber>;
+        height: z.ZodDefault<z.ZodNumber>;
+        fps: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        width?: number;
+        height?: number;
+        fps?: number;
+    }, {
+        width?: number;
+        height?: number;
+        fps?: number;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    export?: {
+        width?: number;
+        height?: number;
+        fps?: number;
+    };
+    title?: string;
+    date?: string;
+    theme?: {
+        name?: string;
+        description?: string;
+        author?: string;
+        version?: string;
+        colors?: {
+            primary?: string;
+            secondary?: string;
+            accent?: string;
+            background?: string;
+            text?: string;
+            muted?: string;
+            success?: string;
+            warning?: string;
+            error?: string;
+        };
+        gradients?: Record<string, string[]>;
+        glyphs?: string;
+        animations?: {
+            revealSpeed?: number;
+            matrixDensity?: number;
+            glitchIterations?: number;
+            lineDelay?: number;
+            matrixInterval?: number;
+        };
+        window?: {
+            borderStyle?: "line" | "double" | "rounded" | "none";
+            shadow?: boolean;
+            padding?: {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            };
+        };
+    };
+    author?: string;
+    settings?: {
+        startSlide?: number;
+        loop?: boolean;
+        autoAdvance?: number;
+        showSlideNumbers?: boolean;
+        showProgress?: boolean;
+    };
+}, {
+    export?: {
+        width?: number;
+        height?: number;
+        fps?: number;
+    };
+    title?: string;
+    date?: string;
+    theme?: {
+        name?: string;
+        description?: string;
+        author?: string;
+        version?: string;
+        colors?: {
+            primary?: string;
+            secondary?: string;
+            accent?: string;
+            background?: string;
+            text?: string;
+            muted?: string;
+            success?: string;
+            warning?: string;
+            error?: string;
+        };
+        gradients?: Record<string, string[]>;
+        glyphs?: string;
+        animations?: {
+            revealSpeed?: number;
+            matrixDensity?: number;
+            glitchIterations?: number;
+            lineDelay?: number;
+            matrixInterval?: number;
+        };
+        window?: {
+            borderStyle?: "line" | "double" | "rounded" | "none";
+            shadow?: boolean;
+            padding?: {
+                top?: number;
+                bottom?: number;
+                left?: number;
+                right?: number;
+            };
+        };
+    };
+    author?: string;
+    settings?: {
+        startSlide?: number;
+        loop?: boolean;
+        autoAdvance?: number;
+        showSlideNumbers?: boolean;
+        showProgress?: boolean;
+    };
+}>;
+type DeckConfig = z.infer<typeof DeckConfigSchema>;
+
+/**
+ * Schema for validating theme objects.
+ * Defines the visual appearance of the presentation deck.
+ */
+declare const ThemeSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodString>;
+    colors: z.ZodObject<{
+        primary: z.ZodString;
+        secondary: z.ZodOptional<z.ZodString>;
+        accent: z.ZodString;
+        background: z.ZodString;
+        text: z.ZodString;
+        muted: z.ZodString;
+        success: z.ZodOptional<z.ZodString>;
+        warning: z.ZodOptional<z.ZodString>;
+        error: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        primary?: string;
+        secondary?: string;
+        accent?: string;
+        background?: string;
+        text?: string;
+        muted?: string;
+        success?: string;
+        warning?: string;
+        error?: string;
+    }, {
+        primary?: string;
+        secondary?: string;
+        accent?: string;
+        background?: string;
+        text?: string;
+        muted?: string;
+        success?: string;
+        warning?: string;
+        error?: string;
+    }>;
+    gradients: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>, Record<string, string[]>, Record<string, string[]>>;
+    glyphs: z.ZodString;
+    animations: z.ZodObject<{
+        revealSpeed: z.ZodDefault<z.ZodNumber>;
+        matrixDensity: z.ZodDefault<z.ZodNumber>;
+        glitchIterations: z.ZodDefault<z.ZodNumber>;
+        lineDelay: z.ZodDefault<z.ZodNumber>;
+        matrixInterval: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        revealSpeed?: number;
+        matrixDensity?: number;
+        glitchIterations?: number;
+        lineDelay?: number;
+        matrixInterval?: number;
+    }, {
+        revealSpeed?: number;
+        matrixDensity?: number;
+        glitchIterations?: number;
+        lineDelay?: number;
+        matrixInterval?: number;
+    }>;
+    window: z.ZodOptional<z.ZodObject<{
+        borderStyle: z.ZodDefault<z.ZodEnum<["line", "double", "rounded", "none"]>>;
+        shadow: z.ZodDefault<z.ZodBoolean>;
+        padding: z.ZodOptional<z.ZodObject<{
+            top: z.ZodDefault<z.ZodNumber>;
+            bottom: z.ZodDefault<z.ZodNumber>;
+            left: z.ZodDefault<z.ZodNumber>;
+            right: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            top?: number;
+            bottom?: number;
+            left?: number;
+            right?: number;
+        }, {
+            top?: number;
+            bottom?: number;
+            left?: number;
+            right?: number;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        borderStyle?: "line" | "double" | "rounded" | "none";
+        shadow?: boolean;
+        padding?: {
+            top?: number;
+            bottom?: number;
+            left?: number;
+            right?: number;
+        };
+    }, {
+        borderStyle?: "line" | "double" | "rounded" | "none";
+        shadow?: boolean;
+        padding?: {
+            top?: number;
+            bottom?: number;
+            left?: number;
+            right?: number;
+        };
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    name?: string;
+    description?: string;
+    author?: string;
+    version?: string;
+    colors?: {
+        primary?: string;
+        secondary?: string;
+        accent?: string;
+        background?: string;
+        text?: string;
+        muted?: string;
+        success?: string;
+        warning?: string;
+        error?: string;
+    };
+    gradients?: Record<string, string[]>;
+    glyphs?: string;
+    animations?: {
+        revealSpeed?: number;
+        matrixDensity?: number;
+        glitchIterations?: number;
+        lineDelay?: number;
+        matrixInterval?: number;
+    };
+    window?: {
+        borderStyle?: "line" | "double" | "rounded" | "none";
+        shadow?: boolean;
+        padding?: {
+            top?: number;
+            bottom?: number;
+            left?: number;
+            right?: number;
+        };
+    };
+}, {
+    name?: string;
+    description?: string;
+    author?: string;
+    version?: string;
+    colors?: {
+        primary?: string;
+        secondary?: string;
+        accent?: string;
+        background?: string;
+        text?: string;
+        muted?: string;
+        success?: string;
+        warning?: string;
+        error?: string;
+    };
+    gradients?: Record<string, string[]>;
+    glyphs?: string;
+    animations?: {
+        revealSpeed?: number;
+        matrixDensity?: number;
+        glitchIterations?: number;
+        lineDelay?: number;
+        matrixInterval?: number;
+    };
+    window?: {
+        borderStyle?: "line" | "double" | "rounded" | "none";
+        shadow?: boolean;
+        padding?: {
+            top?: number;
+            bottom?: number;
+            left?: number;
+            right?: number;
+        };
+    };
+}>;
+type Theme = z.infer<typeof ThemeSchema>;
+/**
+ * Deep partial utility type that makes all nested properties optional.
+ * Used for theme extension where only specific fields need to be overridden.
+ */
+type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+/**
+ * Partial theme type for use with theme.extend() functionality.
+ * All fields (including nested) become optional.
+ */
+type PartialTheme = DeepPartial<Theme>;
+
+/**
+ * Schema for validating slide frontmatter.
+ * Defines the metadata for a single slide.
+ */
+declare const SlideFrontmatterSchema: z.ZodObject<{
+    title: z.ZodString;
+    bigText: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+    gradient: z.ZodOptional<z.ZodString>;
+    theme: z.ZodOptional<z.ZodString>;
+    transition: z.ZodDefault<z.ZodEnum<["glitch", "fade", "instant", "typewriter"]>>;
+    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    title?: string;
+    bigText?: string | string[];
+    gradient?: string;
+    theme?: string;
+    transition?: "glitch" | "fade" | "instant" | "typewriter";
+    meta?: Record<string, unknown>;
+}, {
+    title?: string;
+    bigText?: string | string[];
+    gradient?: string;
+    theme?: string;
+    transition?: "glitch" | "fade" | "instant" | "typewriter";
+    meta?: Record<string, unknown>;
+}>;
+type SlideFrontmatter = z.infer<typeof SlideFrontmatterSchema>;
+/**
+ * Schema for a complete slide after parsing.
+ * Includes the parsed frontmatter, body content, optional notes, and metadata.
+ */
+declare const SlideSchema: z.ZodObject<{
+    frontmatter: z.ZodObject<{
+        title: z.ZodString;
+        bigText: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+        gradient: z.ZodOptional<z.ZodString>;
+        theme: z.ZodOptional<z.ZodString>;
+        transition: z.ZodDefault<z.ZodEnum<["glitch", "fade", "instant", "typewriter"]>>;
+        meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        title?: string;
+        bigText?: string | string[];
+        gradient?: string;
+        theme?: string;
+        transition?: "glitch" | "fade" | "instant" | "typewriter";
+        meta?: Record<string, unknown>;
+    }, {
+        title?: string;
+        bigText?: string | string[];
+        gradient?: string;
+        theme?: string;
+        transition?: "glitch" | "fade" | "instant" | "typewriter";
+        meta?: Record<string, unknown>;
+    }>;
+    body: z.ZodString;
+    notes: z.ZodOptional<z.ZodString>;
+    sourcePath: z.ZodString;
+    index: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    frontmatter?: {
+        title?: string;
+        bigText?: string | string[];
+        gradient?: string;
+        theme?: string;
+        transition?: "glitch" | "fade" | "instant" | "typewriter";
+        meta?: Record<string, unknown>;
+    };
+    body?: string;
+    notes?: string;
+    sourcePath?: string;
+    index?: number;
+}, {
+    frontmatter?: {
+        title?: string;
+        bigText?: string | string[];
+        gradient?: string;
+        theme?: string;
+        transition?: "glitch" | "fade" | "instant" | "typewriter";
+        meta?: Record<string, unknown>;
+    };
+    body?: string;
+    notes?: string;
+    sourcePath?: string;
+    index?: number;
+}>;
+type Slide = z.infer<typeof SlideSchema>;
+
+/**
+ * Theme object with extension capability.
+ * Extends the base Theme type with an extend() method that allows
+ * Tailwind-style theme customization.
+ */
+interface ThemeObject extends Theme {
+    /**
+     * Create a new theme by merging overrides into this theme.
+     * Uses deep merge with array replacement strategy.
+     *
+     * @param overrides - Partial theme object with values to override
+     * @returns A new ThemeObject with the merged values
+     *
+     * @example
+     * const custom = matrix.extend({
+     *   colors: { primary: '#ff0066' }
+     * })
+     *
+     * @example
+     * // Chained extensions
+     * const custom = matrix
+     *   .extend({ colors: { primary: '#ff0066' } })
+     *   .extend({ animations: { revealSpeed: 0.5 } })
+     */
+    extend(overrides: PartialTheme): ThemeObject;
+}
+/**
+ * Create a theme from a YAML string.
+ * Parses the YAML, validates it against ThemeSchema, and returns a ThemeObject
+ * with extension capability.
+ *
+ * @param yaml - The YAML string containing the theme definition
+ * @returns A validated ThemeObject with extend() method
+ * @throws {Error} If the YAML syntax is invalid
+ * @throws {ValidationError} If the parsed data doesn't match ThemeSchema
+ *
+ * @example
+ * const theme = createTheme(`
+ * name: custom
+ * colors:
+ *   primary: "#ff0066"
+ *   accent: "#00ff66"
+ *   background: "#000000"
+ *   text: "#ffffff"
+ *   muted: "#666666"
+ * gradients:
+ *   main:
+ *     - "#ff0066"
+ *     - "#00ff66"
+ * glyphs: "0123456789ABCDEF"
+ * animations:
+ *   revealSpeed: 1.0
+ *   matrixDensity: 30
+ *   glitchIterations: 3
+ *   lineDelay: 20
+ *   matrixInterval: 100
+ * `)
+ */
+declare function createTheme(yaml: string): ThemeObject;
+
+/**
+ * Public API for term-deck
+ *
+ * Exports functions and types for use in deck.config.ts files
+ * and external integrations.
+ */
+
+/**
+ * Define deck configuration with validation
+ *
+ * Usage in deck.config.ts:
+ * ```typescript
+ * import { defineConfig } from 'term-deck'
+ * import matrix from '@term-deck/theme-matrix'
+ *
+ * export default defineConfig({
+ *   title: 'My Presentation',
+ *   theme: matrix,
+ * })
+ * ```
+ */
+declare function defineConfig(config: DeckConfig): DeckConfig;
+
+export { type DeckConfig, type Slide, type SlideFrontmatter, type Theme, type ThemeObject, createTheme, defineConfig };