@krutai/excel-comparison 0.0.6

package/dist/index.d.ts

@@ -0,0 +1,187 @@
+interface ComparisonClientConfig {
+    /**
+     * KrutAI API key.
+     * Optional: defaults to process.env.KRUTAI_API_KEY
+     */
+    apiKey?: string;
+    /**
+     * Base URL of your deployed comparison backend server.
+     * @default "http://localhost:8000"
+     * @example "https://api.krut.ai"
+     */
+    serverUrl?: string;
+    /**
+     * Request timeout in milliseconds.
+     * @default 60000
+     */
+    timeout?: number;
+    /**
+     * Whether to validate the API key against the server on initialization.
+     * @default true
+     */
+    validateOnInit?: boolean;
+}
+interface CompareFilesOptions {
+    matchColumn?: string;
+    ignoreColumns?: string[];
+    tolerance?: number;
+    caseSensitive?: boolean;
+}
+interface FilePreview {
+    name: string;
+    rowCount: number;
+    columns: string[];
+    sample: Record<string, unknown>[];
+}
+interface PreviewResponse {
+    success: boolean;
+    file1?: FilePreview;
+    file2?: FilePreview;
+    suggestedMatchColumn?: string;
+    error?: string;
+}
+interface ComparisonApiResponse {
+    success: boolean;
+    result?: {
+        summary: {
+            totalRows: number;
+            matchesFound: number;
+            differencesFound: number;
+            uniqueToFile1: number;
+            uniqueToFile2: number;
+            status: 'SUCCESS' | 'PARTIAL' | 'NO_MATCH';
+        };
+        matchColumn: string;
+        metadata: {
+            file1Name: string;
+            file1Columns: string[];
+            file1RowCount: number;
+            file2Name: string;
+            file2Columns: string[];
+            file2RowCount: number;
+        };
+    };
+    downloadUrl?: string;
+    fileName?: string;
+    error?: string;
+}
+declare class ComparisonApiClient {
+    private serverUrl;
+    private apiKey?;
+    private timeout;
+    private initialized;
+    private validateOnInit;
+    private initializationPromise;
+    constructor(config: ComparisonClientConfig);
+    /**
+     * Initialize the client.
+     * Validates the API key against the server if validateOnInit is true.
+     * @throws {Error} If validation fails or API key is missing
+     */
+    initialize(): Promise<void>;
+    private getHeaders;
+    private request;
+    compareFiles(file1Buffer: Buffer, file1Name: string, file2Buffer: Buffer, file2Name: string, compareOptions?: CompareFilesOptions): Promise<ComparisonApiResponse>;
+    compareFilesFromFileObjects(file1: File, file2: File, compareOptions?: CompareFilesOptions): Promise<ComparisonApiResponse>;
+    previewFiles(file1: File, file2: File): Promise<PreviewResponse>;
+    previewFilesFromBuffers(file1Buffer: Buffer, file1Name: string, file2Buffer: Buffer, file2Name: string): Promise<PreviewResponse>;
+}
+declare function createComparisonClient(config: ComparisonClientConfig): ComparisonApiClient;
+
+interface DataRecord {
+    [key: string]: unknown;
+}
+interface ComparisonResult {
+    data: DataRecord[];
+    summary: {
+        totalRows: number;
+        differencesFound: number;
+        matchesFound: number;
+        status: 'SUCCESS' | 'PARTIAL' | 'NO_MATCH';
+    };
+    metadata?: {
+        file1Columns?: string[];
+        file2Columns?: string[];
+        executionTime?: number;
+    };
+}
+interface ExcelLoaderOptions {
+    sheetIndex?: number;
+    sheetName?: string;
+    headerRow?: number;
+    skipRows?: number;
+    sampleRows?: number;
+}
+interface LoaderOptions {
+    sheetName?: string;
+    headerRow?: number;
+    skipRows?: number;
+}
+interface ReporterOptions {
+    headerColor?: string;
+    differenceColor?: string;
+    matchColor?: string;
+    sheetName?: string;
+    includeSummary?: boolean;
+}
+interface EngineOptions {
+    timeout?: number;
+    maxMemory?: number;
+}
+interface CodeGenerationResult {
+    code: string;
+    humanExplanation: string[];
+    constants?: Record<string, unknown>;
+}
+interface ComparisonRequest {
+    file1Data: DataRecord[];
+    file2Data: DataRecord[];
+    file1Columns?: string[];
+    file2Columns?: string[];
+    file1Sample?: DataRecord[];
+    file2Sample?: DataRecord[];
+    prompt?: string;
+}
+interface ExcelSchema {
+    headers: string[];
+    rowCount: number;
+    columnCount: number;
+    sample: DataRecord[];
+    data: DataRecord[];
+}
+
+declare class StyledReporter {
+    private options;
+    constructor(options?: ReporterOptions);
+    generateReport(result: ComparisonResult, _file1Columns?: string[], _file2Columns?: string[]): Promise<Buffer>;
+    private addSummarySheet;
+    private addResultSheet;
+    private formatValue;
+    generateDetailedReport(result: ComparisonResult, file1Columns?: string[], file2Columns?: string[]): Promise<Buffer>;
+    private addDataSheet;
+}
+
+interface ExcelDataFrame {
+    headers: string[];
+    data: DataRecord[];
+    rowCount: number;
+    columnCount: number;
+    sample: DataRecord[];
+}
+declare class DataLoader {
+    static loadFromBuffer(buffer: Buffer, fileName: string, options?: ExcelLoaderOptions): Promise<ExcelDataFrame>;
+    static getColumnNames(data: DataRecord[]): string[];
+    static getSampleData(data: DataRecord[], count?: number): DataRecord[];
+}
+
+/**
+ * krutExcelComparison — convenience factory.
+ *
+ * Creates a `ComparisonApiClient` instance configured to call the Krut comparison server.
+ *
+ * @param config - Client configuration (apiKey and serverUrl)
+ * @returns A `ComparisonApiClient` instance
+ */
+declare function krutExcelComparison(config: ComparisonClientConfig): ComparisonApiClient;
+
+export { type FilePreview as ApiFilePreview, type CodeGenerationResult, type CompareFilesOptions, ComparisonApiClient, type ComparisonApiResponse, type ComparisonClientConfig, type ComparisonRequest, type ComparisonResult, DataLoader, type DataRecord, type EngineOptions, type ExcelLoaderOptions, type ExcelSchema, type LoaderOptions, type PreviewResponse, type ReporterOptions, StyledReporter, createComparisonClient, krutExcelComparison };