captide/dist/types/index.d.ts

Get hundreds of thousands of financial documents into your AI app 🚀

/**
 * Source document information
 */
/**
 * Defines the possible types of source documents
 * Updated to match the new API response format exactly
 */
export type SourceType = '10-K' | '10-Q' | '8-K' | 'transcript' | 'DEF 14A' | 'DEFM14A' | 'DEF 14C' | 'DEFM14C' | '20-F' | '40-F' | '6-K' | 'S-1' | 'ir';
/**
 * Document file types for binary documents
 * Updated to remove null since the API always provides this for blob documents
 */
export type FileType = 'pdf' | 'xlsx';
declare global {
    interface Window {
        highlightCaptidePage?: (pageNumber: number) => boolean;
    }
}
/**
 * Base source document information
 * Contains the minimal information needed for tab management
 */
export interface SourceDocumentBase {
    /** Source link (URL identifying this document) */
    sourceLink: string;
    /** Type of document */
    sourceType: SourceType;
    /** Stock ticker symbol - nullable in base but required in concrete implementations */
    ticker: string | null;
    /** Fiscal period (e.g., 'Q1 2023') - nullable in base but required in concrete implementations */
    fiscalPeriod: string | null;
}
export interface TabInfo extends SourceDocumentBase {
    /** Whether the tab is currently loading */
    isLoading: boolean;
}
/**
 * Complete source document with HTML content and additional metadata
 * Used for standard HTML-based documents
 * Updated to match new API response format
 */
export interface HtmlSourceDocument extends SourceDocumentBase {
    /** HTML content of the document */
    htmlContent: string;
    /** Document date - can be null per API */
    date: string | null;
    /** Company name - always present per API */
    companyName: string;
    /** ID of element to highlight, for 8-K documents, the last 4 digits indicate page number */
    highlightedElementId?: string | null;
    /** Override ticker to make it required and non-null per API */
    ticker: string;
    /** Override fiscalPeriod but keep it nullable per API */
    fiscalPeriod: string | null;
    /** Additional metadata - always present per API (may be empty object) */
    metadata: {
        /** URL to the original source webpage where the document was obtained */
        webpageUrl?: string;
        /** Any other metadata properties */
        [key: string]: any;
    };
}
/**
 * Binary document response for PDF or XLSX files
 * Used for non-HTML documents like PDF or Excel files
 * Updated to match new API response format
 */
export interface BinarySourceDocument extends SourceDocumentBase {
    /** Document date - can be null per API */
    date: string | null;
    /** Company name - always present per API */
    companyName: string;
    /** Override ticker to make it required and non-null per API */
    ticker: string;
    /** Override fiscalPeriod but keep it nullable per API */
    fiscalPeriod: string | null;
    /** Type of binary file - always present per API */
    fileType: FileType;
    /** SAS URL for the document (Azure storage shared access signature) */
    sasUrl: string;
    /** Content type of the document - always present per API */
    contentType: string;
    /** File name of the document - always present per API */
    fileName: string;
    /** Additional metadata - always present per API (may be empty object) */
    metadata: {
        /** URL to the original source webpage where the document was obtained */
        webpageUrl?: string;
        /** Any other metadata properties */
        [key: string]: any;
    };
}
/**
 * Union type for all source document types
 */
export type SourceDocument = HtmlSourceDocument | BinarySourceDocument;
/**
 * Internal document type used by the viewer
 * This shouldn't be directly exposed to users
 */
export interface InternalDocument extends HtmlSourceDocument {
    /** File type for binary documents */
    fileType?: FileType;
    /** Original SAS URL if provided */
    sasUrl?: string;
    /** Content type of the document */
    contentType?: string;
    /** File name of the document */
    fileName?: string;
}
/**
 * Context state for the DocumentViewer
 */
export interface DocumentViewerState {
    /** The document being displayed */
    document: InternalDocument | null;
    /** Whether document is currently loading */
    isLoading: boolean;
    /** Whether the document viewer is open */
    isOpen: boolean;
    /** ID of element to highlight (should start with # and then an UUID of length 8) */
    highlightedElementId: string | null;
    /** Array of tabs in the document viewer */
    tabs: TabInfo[];
    /** Current zoom level (1.0 = 100%) */
    zoomLevel: number;
}
/**
 * Function to fetch document content from the API
 * Can return either an HTML document or a binary document
 */
export type FetchDocumentFn = (sourceLink: string) => Promise<SourceDocument>;
/**
 * DocumentViewer context value
 */
export interface DocumentViewerContextValue extends DocumentViewerState {
    /** Updates the DocumentViewer state */
    updateDocumentViewer: (updates: Partial<DocumentViewerState>) => void;
    /** Sets document, source type, and handles loading state */
    setDocument: (document: InternalDocument | null) => void;
    /** Highlights an element in the current document */
    highlightElement: (elementId: string) => void;
    /** Fetches and displays a document with optional element highlighting */
    loadDocument: (sourceLink: string, elementId?: string) => Promise<void>;
    /** Sets the fetch document function to be used */
    setFetchDocumentFn: (fn: FetchDocumentFn) => void;
    /** Open the document viewer */
    openViewer: () => void;
    /** Close the document viewer */
    closeViewer: () => void;
    /** Add a new tab or switch to existing tab */
    selectTab: (sourceLink: string) => void;
    /** Close a tab */
    closeTab: (sourceLink: string) => void;
    /** Set zoom level to a specific value (1.0 = 100%) */
    setZoomLevel: (level: number) => void;
    /** Increase zoom level */
    zoomIn: () => void;
    /** Decrease zoom level */
    zoomOut: () => void;
    /** Reset zoom to default (100%) */
    resetZoom: () => void;
}