@chrisflippen/blueprint-document-assembly 1.0.0 → 3.0.0

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import * as react from 'react';
+import { ComponentType, CSSProperties, ReactNode, RefObject } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 interface LogEntry {
@@ -20,6 +22,9 @@ interface Step {
     substeps?: SubStep[];
     documentSection?: string;
     logs: LogEntry[];
+    icon?: ComponentType<{
+        className?: string;
+    }>;
 }
 interface DocumentMetrics {
     tokens: number;
@@ -30,6 +35,262 @@ interface DocumentIds {
     caseNumber: string;
     fileNumber: string;
 }
+interface DocumentSubsection {
+    revealOnSubstep: string;
+    content: string | ReactNode;
+    className?: string;
+    animation?: 'typewriter' | 'fade' | 'slide';
+}
+interface DocumentSection {
+    id: string;
+    title: string;
+    borderColor: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+    className?: string;
+    style?: CSSProperties;
+    subsections: DocumentSubsection[];
+}
+interface ClassNameSlots {
+    root?: string;
+    progressBar?: string;
+    leftPanel?: string;
+    rightPanel?: string;
+    header?: string;
+    footer?: string;
+    step?: string;
+    stepIcon?: string;
+    substep?: string;
+    log?: string;
+    logContainer?: string;
+    documentPreview?: string;
+    documentPaper?: string;
+    documentSection?: string;
+    wholeDocumentView?: string;
+    wholeDocumentContent?: string;
+    metricsBar?: string;
+    metricsItem?: string;
+}
+interface ThemeConfig {
+    primary?: string;
+    secondary?: string;
+    success?: string;
+    processing?: string;
+    warning?: string;
+}
+interface AnimationTimings {
+    stepActivation?: number;
+    substepDelay?: number;
+    logStreamBase?: number;
+    logStreamVariance?: number;
+    typewriterSpeed?: number;
+    sectionRevealDuration?: number;
+    completionDelay?: number;
+}
+interface LabelConfig {
+    title?: string;
+    statusProcessing?: string;
+    statusComplete?: string;
+    documentTitle?: string;
+    documentPrefix?: string;
+    documentSuffix?: string;
+    completionTitle?: string;
+    completionBadge?: string;
+    metricsTokens?: string;
+    metricsCost?: string;
+    metricsElapsed?: string;
+    stepPrefix?: string;
+    stepDone?: string;
+    substepCount?: (completed: number, total: number) => string;
+    logLabel?: string;
+    logLabelCompact?: string;
+    logEntriesSuffix?: string;
+    watermarkText?: string;
+}
+interface LayoutConfig {
+    leftWidth?: string;
+    rightWidth?: string;
+    direction?: 'horizontal' | 'vertical';
+}
+interface ResolvedThemeColors {
+    bg: string;
+    border: string;
+    text: string;
+    icon: string;
+    accent: string;
+}
+interface ResolvedTheme {
+    primary: ResolvedThemeColors;
+    secondary: ResolvedThemeColors;
+    success: ResolvedThemeColors;
+    processing: ResolvedThemeColors;
+    warning: ResolvedThemeColors;
+    stepStatus: Record<Step['status'], {
+        cardBg: string;
+        border: string;
+        iconBg: string;
+        textColor: string;
+    }>;
+    gradients: {
+        progress: string;
+        title: string;
+        completion: string;
+    };
+}
+interface AnimationPreset {
+    name: string;
+    durations: {
+        fast: number;
+        normal: number;
+        slow: number;
+    };
+    springs: {
+        stiff: {
+            type: 'spring';
+            stiffness: number;
+            damping: number;
+        };
+        gentle: {
+            type: 'spring';
+            stiffness: number;
+            damping: number;
+        };
+        bouncy: {
+            type: 'spring';
+            stiffness: number;
+            damping: number;
+            bounce: number;
+        };
+    };
+    stagger: {
+        step: number;
+        substep: number;
+        log: number;
+        sparkle: number;
+    };
+    typewriter: {
+        charDelay: number;
+        cursorBlink: number;
+    };
+    entrance: {
+        x: number;
+        y: number;
+        scale: number;
+    };
+    hookTimings: Required<AnimationTimings>;
+}
+interface UseDocumentAssemblyOptions {
+    steps?: Step[];
+    stepLogs?: Record<string, string[][]>;
+    substepLogs?: Record<string, string[][]>;
+    autoStart?: boolean;
+    autoScroll?: boolean;
+    showWholeDocumentView?: boolean;
+    documentIds?: DocumentIds;
+    animationSpeed?: number;
+    animationTimings?: AnimationTimings;
+    onStepStart?: (step: Step, index: number) => void;
+    onStepComplete?: (step: Step, metrics: DocumentMetrics) => void;
+    onSubstepComplete?: (substepId: string, stepIndex: number) => void;
+    onSectionReveal?: (sectionId: string) => void;
+    onLogEntry?: (log: LogEntry) => void;
+    onComplete?: (metrics: DocumentMetrics) => void;
+    onPause?: () => void;
+    onResume?: () => void;
+    onReset?: () => void;
+}
+interface UseDocumentAssemblyReturn {
+    steps: Step[];
+    completedSections: Set<string>;
+    completedSubsteps: Set<string>;
+    metrics: DocumentMetrics;
+    showRipple: string | null;
+    currentStep: number;
+    showWholeDocument: boolean;
+    isRunning: boolean;
+    isPaused: boolean;
+    isComplete: boolean;
+    progress: number;
+    documentIds: DocumentIds;
+    documentScrollRef: RefObject<HTMLDivElement | null>;
+    start: () => void;
+    pause: () => void;
+    resume: () => void;
+    reset: () => void;
+    goToStep: (stepIndex: number) => void;
+    setShowWholeDocument: (show: boolean) => void;
+}
+interface BlueprintDocumentAssemblyRef {
+    start: () => void;
+    pause: () => void;
+    resume: () => void;
+    reset: () => void;
+    goToStep: (stepIndex: number) => void;
+}
+interface StepItemProps$1 {
+    step: Step;
+    isLast: boolean;
+    showRipple: boolean;
+    classNames?: ClassNameSlots;
+    theme?: ThemeConfig;
+    labels?: LabelConfig;
+    renderStep?: (step: Step, defaultRender: ReactNode) => ReactNode;
+}
+interface SubStepItemProps$1 {
+    substep: SubStep;
+    delay: number;
+    classNames?: ClassNameSlots;
+    renderSubstep?: (substep: SubStep, defaultRender: ReactNode) => ReactNode;
+}
+interface LogLineProps$1 {
+    log: LogEntry;
+    compact?: boolean;
+    classNames?: ClassNameSlots;
+}
+interface LogContainerProps$1 {
+    logs: LogEntry[];
+    expanded: boolean;
+    onToggle: () => void;
+    compact?: boolean;
+    classNames?: ClassNameSlots;
+    labels?: LabelConfig;
+    renderLog?: (log: LogEntry, defaultRender: ReactNode) => ReactNode;
+}
+interface DocumentLineProps$1 {
+    text: string;
+    delay: number;
+    className?: string;
+}
+interface DocumentPreviewProps$1 {
+    completedSections: Set<string>;
+    completedSubsteps: Set<string>;
+    documentIds: DocumentIds;
+    sections?: DocumentSection[];
+    classNames?: ClassNameSlots;
+    watermarkText?: string;
+    paperTexture?: boolean;
+    fontFamily?: string;
+    renderSection?: (section: DocumentSection, completedSubsteps: Set<string>) => ReactNode;
+}
+interface WholeDocumentViewProps$1 {
+    show: boolean;
+    onClose: () => void;
+    documentIds: DocumentIds;
+    metrics: DocumentMetrics;
+    classNames?: ClassNameSlots;
+    labels?: LabelConfig;
+    celebrationTitle?: string;
+    sparkleCount?: number;
+    celebrationEnabled?: boolean;
+    children?: ReactNode;
+}
+interface WholeDocumentContentProps$1 {
+    documentIds: DocumentIds;
+    sections?: DocumentSection[];
+    classNames?: ClassNameSlots;
+    renderSection?: (section: DocumentSection) => ReactNode;
+}
 interface BlueprintDocumentAssemblyProps {
     /**
      * Array of steps to process in the document assembly
@@ -77,13 +338,274 @@ interface BlueprintDocumentAssemblyProps {
      * Custom className for the root container
      */
     className?: string;
+    /**
+     * CSS class name overrides for internal slots
+     */
+    classNames?: ClassNameSlots;
+    /**
+     * Theme color configuration
+     */
+    theme?: ThemeConfig;
+    /**
+     * Animation timing overrides
+     */
+    animationTimings?: AnimationTimings;
+    /**
+     * Animation preset configuration (v3.0.0)
+     */
+    animationPreset?: AnimationPreset;
+    /**
+     * UI string overrides
+     */
+    labels?: LabelConfig;
+    /**
+     * Layout configuration
+     */
+    layout?: LayoutConfig;
+    /**
+     * Whether to auto-start the assembly on mount
+     * @default true
+     */
+    autoStart?: boolean;
+    /**
+     * Custom document sections (replaces legal preset)
+     */
+    documentSections?: DocumentSection[];
+    /**
+     * Render prop for custom step rendering
+     */
+    renderStep?: (step: Step, defaultRender: ReactNode) => ReactNode;
+    /**
+     * Render prop for custom substep rendering
+     */
+    renderSubstep?: (substep: SubStep, defaultRender: ReactNode) => ReactNode;
+    /**
+     * Render prop for custom log rendering
+     */
+    renderLog?: (log: LogEntry, defaultRender: ReactNode) => ReactNode;
+    /**
+     * Render prop for custom document section rendering
+     */
+    renderDocumentSection?: (section: DocumentSection, completedSubsteps: Set<string>) => ReactNode;
+    /**
+     * Callback when a step starts processing
+     */
+    onStepStart?: (step: Step, index: number) => void;
+    /**
+     * Callback when a substep completes
+     */
+    onSubstepComplete?: (substepId: string, stepIndex: number) => void;
+    /**
+     * Callback when a document section is revealed
+     */
+    onSectionReveal?: (sectionId: string) => void;
+    /**
+     * Callback when a log entry is added
+     */
+    onLogEntry?: (log: LogEntry) => void;
+    /**
+     * Callback when assembly is paused
+     */
+    onPause?: () => void;
+    /**
+     * Callback when assembly is resumed
+     */
+    onResume?: () => void;
+    /**
+     * Callback when assembly is reset
+     */
+    onReset?: () => void;
+}
+
+declare const BlueprintDocumentAssembly: react.ForwardRefExoticComponent<BlueprintDocumentAssemblyProps & react.RefAttributes<BlueprintDocumentAssemblyRef>>;
+
+declare function useDocumentAssembly(options?: UseDocumentAssemblyOptions): UseDocumentAssemblyReturn;
+
+declare function useReducedMotion(): boolean;
+
+interface ResponsiveLayout {
+    isMobile: boolean;
+    isTablet: boolean;
+    direction: 'horizontal' | 'vertical';
+}
+declare function useResponsiveLayout(): ResponsiveLayout;
+
+interface StepItemProps {
+    step: Step;
+    isLast: boolean;
+    showRipple: boolean;
+    classNames?: ClassNameSlots;
+    theme?: ThemeConfig;
+    labels?: LabelConfig;
+    renderStep?: (step: Step, defaultRender: ReactNode) => ReactNode;
+}
+declare const StepItem: react.NamedExoticComponent<StepItemProps>;
+
+interface SubStepItemProps {
+    substep: SubStep;
+    delay: number;
+    classNames?: ClassNameSlots;
+    renderSubstep?: (substep: SubStep, defaultRender: ReactNode) => ReactNode;
+}
+declare const SubStepItem: react.NamedExoticComponent<SubStepItemProps>;
+
+interface LogLineProps {
+    log: LogEntry;
+    compact?: boolean;
+    classNames?: ClassNameSlots;
+}
+declare const LogLine: react.NamedExoticComponent<LogLineProps>;
+interface LogContainerProps {
+    logs: LogEntry[];
+    expanded: boolean;
+    onToggle: () => void;
+    compact?: boolean;
+    classNames?: ClassNameSlots;
+    labels?: LabelConfig;
+    renderLog?: (log: LogEntry, defaultRender: ReactNode) => ReactNode;
+}
+declare const LogContainer: react.NamedExoticComponent<LogContainerProps>;
+
+interface DocumentPreviewProps {
+    completedSections: Set<string>;
+    completedSubsteps: Set<string>;
+    documentIds: DocumentIds;
+    sections?: DocumentSection[];
+    classNames?: ClassNameSlots;
+    watermarkText?: string;
+    paperTexture?: boolean;
+    fontFamily?: string;
+    renderSection?: (section: DocumentSection, completedSubsteps: Set<string>) => React.ReactNode;
+}
+declare function DocumentPreview({ completedSubsteps, documentIds, sections, classNames, watermarkText, paperTexture, fontFamily, renderSection, }: DocumentPreviewProps): react_jsx_runtime.JSX.Element;
+
+interface DocumentLineProps {
+    text: string;
+    delay: number;
+    className?: string;
 }
+declare function DocumentLine({ text, delay, className }: DocumentLineProps): react_jsx_runtime.JSX.Element;
 
-declare function BlueprintDocumentAssembly({ steps: initialSteps, stepLogs: customStepLogs, substepLogs: customSubstepLogs, autoScroll, showWholeDocumentView, documentIds: customDocumentIds, animationSpeed, onComplete, onStepComplete, className, }: BlueprintDocumentAssemblyProps): react_jsx_runtime.JSX.Element;
+interface WholeDocumentViewProps {
+    show: boolean;
+    onClose: () => void;
+    documentIds: DocumentIds;
+    metrics: DocumentMetrics;
+    classNames?: ClassNameSlots;
+    labels?: LabelConfig;
+    celebrationTitle?: string;
+    sparkleCount?: number;
+    celebrationEnabled?: boolean;
+    children?: React.ReactNode;
+}
+declare function WholeDocumentView({ show, onClose, documentIds, metrics, classNames, labels, celebrationTitle, sparkleCount, celebrationEnabled, }: WholeDocumentViewProps): react_jsx_runtime.JSX.Element;
+
+interface WholeDocumentContentProps {
+    documentIds: DocumentIds;
+    sections?: DocumentSection[];
+    classNames?: ClassNameSlots;
+    renderSection?: (section: DocumentSection) => React.ReactNode;
+}
+declare function WholeDocumentContent({ documentIds, sections, classNames, renderSection, }: WholeDocumentContentProps): react_jsx_runtime.JSX.Element;
+
+declare function resolveTheme(config?: ThemeConfig): ResolvedTheme;
+declare function getThemeSafelist(config?: ThemeConfig): string[];
+interface ThemeProviderProps {
+    theme?: ThemeConfig;
+    children: ReactNode;
+}
+declare function ThemeProvider({ theme, children }: ThemeProviderProps): react_jsx_runtime.JSX.Element;
+declare function useTheme(): ResolvedTheme;
+declare function useThemeOptional(): ResolvedTheme | null;
+
+interface AnimationContextValue {
+    preset: AnimationPreset;
+    reducedMotion: boolean;
+    getTransition: (type: 'fast' | 'normal' | 'slow') => {
+        duration: number;
+    };
+    getSpring: (type: 'stiff' | 'gentle' | 'bouncy') => object;
+}
+interface AnimationProviderProps {
+    preset?: AnimationPreset;
+    children: ReactNode;
+}
+declare function AnimationProvider({ preset, children }: AnimationProviderProps): react_jsx_runtime.JSX.Element;
+declare function useAnimation(): AnimationContextValue;
+declare function useAnimationOptional(): AnimationContextValue | null;
+
+declare const SMOOTH_PRESET: AnimationPreset;
+declare const SNAPPY_PRESET: AnimationPreset;
+declare const CINEMATIC_PRESET: AnimationPreset;
+declare const MINIMAL_PRESET: AnimationPreset;
 
 declare const DEFAULT_STEP_LOGS: Record<string, string[][]>;
 declare const DEFAULT_SUBSTEP_LOGS: Record<string, string[][]>;
 
 declare const DEFAULT_STEPS: Step[];
+declare const STEP_ICON_MAP: Record<string, any>;
+
+declare const DEFAULT_LABELS: Required<LabelConfig>;
+
+declare const DEFAULT_THEME: Required<ThemeConfig>;
+
+/**
+ * Legal sworn affidavit document sections preset.
+ * Each section corresponds to a step in the default assembly process,
+ * and each subsection is revealed when its trigger substep completes.
+ */
+declare const LEGAL_DOCUMENT_SECTIONS: DocumentSection[];
+
+/**
+ * Legal sworn affidavit whole document content preset.
+ * Used for the completion view when the full assembled document is shown.
+ */
+declare const LEGAL_WHOLE_DOCUMENT_SECTIONS: DocumentSection[];
+
+/**
+ * Generic squiggle text document sections preset.
+ * Uses tilde characters (~~~~) to simulate word shapes without real content.
+ * Drop-in replacement for LEGAL_DOCUMENT_SECTIONS with same section IDs and substep triggers.
+ */
+declare const SQUIGGLE_DOCUMENT_SECTIONS: DocumentSection[];
+/**
+ * Squiggle whole-document sections for completion view.
+ * Same structure but uses 'all' for revealOnSubstep triggers and smaller text.
+ */
+declare const SQUIGGLE_WHOLE_DOCUMENT_SECTIONS: DocumentSection[];
+
+/**
+ * Generic squiggle steps preset.
+ * Same IDs and structure as DEFAULT_STEPS but with generic labels.
+ * Pair with SQUIGGLE_DOCUMENT_SECTIONS for a fully generic demo.
+ */
+declare const SQUIGGLE_STEPS: Step[];
+/**
+ * Squiggle step-level logs. Uses same step IDs as SQUIGGLE_STEPS.
+ */
+declare const SQUIGGLE_STEP_LOGS: Record<string, string[][]>;
+/**
+ * Squiggle substep-level logs. Uses same substep IDs as SQUIGGLE_STEPS.
+ */
+declare const SQUIGGLE_SUBSTEP_LOGS: Record<string, string[][]>;
+
+/**
+ * Create a Step with sensible defaults.
+ * Auto-increments `number` if not provided.
+ */
+declare function createStep(partial: Partial<Step> & Pick<Step, 'id' | 'title'>): Step;
+/**
+ * Create a SubStep with sensible defaults.
+ */
+declare function createSubStep(partial: Partial<SubStep> & Pick<SubStep, 'id' | 'label'>): SubStep;
+/**
+ * Create a DocumentSection with sensible defaults.
+ */
+declare function createDocumentSection(partial: Partial<DocumentSection> & Pick<DocumentSection, 'id' | 'title' | 'borderColor'>): DocumentSection;
+/**
+ * Reset the auto-incrementing step counter.
+ * Useful when creating multiple independent step sequences.
+ */
+declare function resetStepCounter(): void;
 
-export { BlueprintDocumentAssembly, type BlueprintDocumentAssemblyProps, DEFAULT_STEPS, DEFAULT_STEP_LOGS, DEFAULT_SUBSTEP_LOGS, type DocumentIds, type DocumentMetrics, type LogEntry, type Step, type SubStep };
+export { type AnimationPreset, AnimationProvider, type AnimationTimings, BlueprintDocumentAssembly, type BlueprintDocumentAssemblyProps, type BlueprintDocumentAssemblyRef, CINEMATIC_PRESET, type ClassNameSlots, DEFAULT_LABELS, DEFAULT_STEPS, DEFAULT_STEP_LOGS, DEFAULT_SUBSTEP_LOGS, DEFAULT_THEME, type DocumentIds, DocumentLine, type DocumentLineProps$1 as DocumentLineProps, type DocumentMetrics, DocumentPreview, type DocumentPreviewProps$1 as DocumentPreviewProps, type DocumentSection, type DocumentSubsection, LEGAL_DOCUMENT_SECTIONS, LEGAL_WHOLE_DOCUMENT_SECTIONS, type LabelConfig, type LayoutConfig, LogContainer, type LogContainerProps$1 as LogContainerProps, type LogEntry, LogLine, type LogLineProps$1 as LogLineProps, MINIMAL_PRESET, type ResolvedTheme, type ResolvedThemeColors, SMOOTH_PRESET, SNAPPY_PRESET, SQUIGGLE_DOCUMENT_SECTIONS, SQUIGGLE_STEPS, SQUIGGLE_STEP_LOGS, SQUIGGLE_SUBSTEP_LOGS, SQUIGGLE_WHOLE_DOCUMENT_SECTIONS, STEP_ICON_MAP, type Step, StepItem, type StepItemProps$1 as StepItemProps, type SubStep, SubStepItem, type SubStepItemProps$1 as SubStepItemProps, type ThemeConfig, ThemeProvider, type UseDocumentAssemblyOptions, type UseDocumentAssemblyReturn, WholeDocumentContent, type WholeDocumentContentProps$1 as WholeDocumentContentProps, WholeDocumentView, type WholeDocumentViewProps$1 as WholeDocumentViewProps, createDocumentSection, createStep, createSubStep, getThemeSafelist, resetStepCounter, resolveTheme, useAnimation, useAnimationOptional, useDocumentAssembly, useReducedMotion, useResponsiveLayout, useTheme, useThemeOptional };