@cesarandreslopez/occ 0.4.0 → 0.4.1

package/dist/src/sheet/types.d.ts

@@ -1,117 +1,472 @@
-export type SheetVisibility = 'visible' | 'hidden' | 'very_hidden';
-export type HeaderSelectionMode = 'auto' | 'none' | 'explicit';
-export type ColumnValueType = 'string' | 'number' | 'boolean' | 'date' | 'error' | 'blank_stub' | 'unknown';
-export interface InspectSheetOptions {
-    sheet?: string;
-    sampleRows: number;
-    headerRow: 'auto' | 'none' | number;
-    maxColumns: number;
-}
-export interface DefinedNameInfo {
-    name: string;
-    ref: string;
-    scope: 'workbook' | 'sheet';
-    sheetIndex?: number;
-    sheetName?: string;
-    external: boolean;
-}
-export interface WorkbookProperties {
-    title?: string;
-    subject?: string;
-    author?: string;
-    company?: string;
-    manager?: string;
-    createdDate?: string;
-    modifiedDate?: string;
-}
-export interface WorkbookRiskFlags {
-    hiddenSheets: boolean;
-    formulas: boolean;
-    comments: boolean;
-    hyperlinks: boolean;
-    mergedCells: boolean;
-    protectedSheets: boolean;
-    externalFormulaRefs: boolean;
-}
-export interface CellTypeCounts {
-    string: number;
-    number: number;
-    boolean: number;
-    date: number;
-    error: number;
-    blankStub: number;
-}
-export interface ColumnProfile {
-    index: number;
-    letter: string;
-    name: string;
-    dominantType: ColumnValueType;
-    nonEmptyCount: number;
-    nonEmptyRatio: number;
-    examples: string[];
-}
-export interface SampleRow {
-    rowNumber: number;
-    values: Record<string, string>;
-}
-export interface SheetProfile {
-    index: number;
-    name: string;
-    visibility: SheetVisibility;
-    usedRange: string | null;
-    totalRows: number;
-    totalCols: number;
-    rectangularRangeCellCount: number;
-    nonEmptyCellCount: number;
-    cellTypeCounts: CellTypeCounts;
-    formulaCellCount: number;
-    commentCellCount: number;
-    hyperlinkCellCount: number;
-    mergedRangeCount: number;
-    hiddenRowCount: number;
-    hiddenColumnCount: number;
-    autoFilterRef: string | null;
-    protected: boolean;
-    definedNames: DefinedNameInfo[];
-    externalFormulaRefCount: number;
-    headerSelection: {
-        requested: 'auto' | 'none' | number;
-        mode: HeaderSelectionMode;
-        rowNumber: number | null;
-    };
-    schema: {
-        truncated: boolean;
-        columns: ColumnProfile[];
-    };
-    sample: {
-        truncatedRows: boolean;
-        truncatedColumns: boolean;
-        rows: SampleRow[];
-    };
-    sampleTokenEstimate: number;
-    fullTokenEstimate: number;
-    estimateMethod: 'full_scan';
-}
-export interface WorkbookInspection {
-    file: string;
-    format: 'xlsx';
-    size: number;
-    properties: WorkbookProperties;
-    customPropertyCount: number;
-    customProperties: Record<string, unknown>;
-    sheetCount: number;
-    visibleSheetCount: number;
-    hiddenSheetCount: number;
-    veryHiddenSheetCount: number;
-    definedNames: DefinedNameInfo[];
-    riskFlags: WorkbookRiskFlags;
-}
-export interface SheetInspectionResult {
-    workbook: WorkbookInspection;
-    sheets: SheetProfile[];
-}
-export interface SheetInspectPayload {
-    file: string;
-    query: Record<string, unknown>;
-    results: SheetInspectionResult;
-}
+import { z } from 'zod';
+export declare const SheetVisibilitySchema: z.ZodEnum<{
+    visible: "visible";
+    hidden: "hidden";
+    very_hidden: "very_hidden";
+}>;
+export type SheetVisibility = z.infer<typeof SheetVisibilitySchema>;
+export declare const HeaderSelectionModeSchema: z.ZodEnum<{
+    auto: "auto";
+    none: "none";
+    explicit: "explicit";
+}>;
+export type HeaderSelectionMode = z.infer<typeof HeaderSelectionModeSchema>;
+export declare const ColumnValueTypeSchema: z.ZodEnum<{
+    string: "string";
+    number: "number";
+    boolean: "boolean";
+    unknown: "unknown";
+    date: "date";
+    error: "error";
+    blank_stub: "blank_stub";
+}>;
+export type ColumnValueType = z.infer<typeof ColumnValueTypeSchema>;
+export declare const InspectSheetOptionsSchema: z.ZodObject<{
+    sheet: z.ZodOptional<z.ZodString>;
+    sampleRows: z.ZodNumber;
+    headerRow: z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodLiteral<"none">, z.ZodNumber]>;
+    maxColumns: z.ZodNumber;
+}, z.core.$strip>;
+export type InspectSheetOptions = z.infer<typeof InspectSheetOptionsSchema>;
+export declare const DefinedNameInfoSchema: z.ZodObject<{
+    name: z.ZodString;
+    ref: z.ZodString;
+    scope: z.ZodEnum<{
+        sheet: "sheet";
+        workbook: "workbook";
+    }>;
+    sheetIndex: z.ZodOptional<z.ZodNumber>;
+    sheetName: z.ZodOptional<z.ZodString>;
+    external: z.ZodBoolean;
+}, z.core.$strip>;
+export type DefinedNameInfo = z.infer<typeof DefinedNameInfoSchema>;
+export declare const WorkbookPropertiesSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    subject: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodString>;
+    company: z.ZodOptional<z.ZodString>;
+    manager: z.ZodOptional<z.ZodString>;
+    createdDate: z.ZodOptional<z.ZodString>;
+    modifiedDate: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type WorkbookProperties = z.infer<typeof WorkbookPropertiesSchema>;
+export declare const WorkbookRiskFlagsSchema: z.ZodObject<{
+    hiddenSheets: z.ZodBoolean;
+    formulas: z.ZodBoolean;
+    comments: z.ZodBoolean;
+    hyperlinks: z.ZodBoolean;
+    mergedCells: z.ZodBoolean;
+    protectedSheets: z.ZodBoolean;
+    externalFormulaRefs: z.ZodBoolean;
+}, z.core.$strip>;
+export type WorkbookRiskFlags = z.infer<typeof WorkbookRiskFlagsSchema>;
+export declare const CellTypeCountsSchema: z.ZodObject<{
+    string: z.ZodNumber;
+    number: z.ZodNumber;
+    boolean: z.ZodNumber;
+    date: z.ZodNumber;
+    error: z.ZodNumber;
+    blankStub: z.ZodNumber;
+}, z.core.$strip>;
+export type CellTypeCounts = z.infer<typeof CellTypeCountsSchema>;
+export declare const ColumnProfileSchema: z.ZodObject<{
+    index: z.ZodNumber;
+    letter: z.ZodString;
+    name: z.ZodString;
+    dominantType: z.ZodEnum<{
+        string: "string";
+        number: "number";
+        boolean: "boolean";
+        unknown: "unknown";
+        date: "date";
+        error: "error";
+        blank_stub: "blank_stub";
+    }>;
+    nonEmptyCount: z.ZodNumber;
+    nonEmptyRatio: z.ZodNumber;
+    examples: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type ColumnProfile = z.infer<typeof ColumnProfileSchema>;
+export declare const SampleRowSchema: z.ZodObject<{
+    rowNumber: z.ZodNumber;
+    values: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strip>;
+export type SampleRow = z.infer<typeof SampleRowSchema>;
+export declare const SheetProfileSchema: z.ZodObject<{
+    index: z.ZodNumber;
+    name: z.ZodString;
+    visibility: z.ZodEnum<{
+        visible: "visible";
+        hidden: "hidden";
+        very_hidden: "very_hidden";
+    }>;
+    usedRange: z.ZodNullable<z.ZodString>;
+    totalRows: z.ZodNumber;
+    totalCols: z.ZodNumber;
+    rectangularRangeCellCount: z.ZodNumber;
+    nonEmptyCellCount: z.ZodNumber;
+    cellTypeCounts: z.ZodObject<{
+        string: z.ZodNumber;
+        number: z.ZodNumber;
+        boolean: z.ZodNumber;
+        date: z.ZodNumber;
+        error: z.ZodNumber;
+        blankStub: z.ZodNumber;
+    }, z.core.$strip>;
+    formulaCellCount: z.ZodNumber;
+    commentCellCount: z.ZodNumber;
+    hyperlinkCellCount: z.ZodNumber;
+    mergedRangeCount: z.ZodNumber;
+    hiddenRowCount: z.ZodNumber;
+    hiddenColumnCount: z.ZodNumber;
+    autoFilterRef: z.ZodNullable<z.ZodString>;
+    protected: z.ZodBoolean;
+    definedNames: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        ref: z.ZodString;
+        scope: z.ZodEnum<{
+            sheet: "sheet";
+            workbook: "workbook";
+        }>;
+        sheetIndex: z.ZodOptional<z.ZodNumber>;
+        sheetName: z.ZodOptional<z.ZodString>;
+        external: z.ZodBoolean;
+    }, z.core.$strip>>;
+    externalFormulaRefCount: z.ZodNumber;
+    headerSelection: z.ZodObject<{
+        requested: z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodLiteral<"none">, z.ZodNumber]>;
+        mode: z.ZodEnum<{
+            auto: "auto";
+            none: "none";
+            explicit: "explicit";
+        }>;
+        rowNumber: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>;
+    schema: z.ZodObject<{
+        truncated: z.ZodBoolean;
+        columns: z.ZodArray<z.ZodObject<{
+            index: z.ZodNumber;
+            letter: z.ZodString;
+            name: z.ZodString;
+            dominantType: z.ZodEnum<{
+                string: "string";
+                number: "number";
+                boolean: "boolean";
+                unknown: "unknown";
+                date: "date";
+                error: "error";
+                blank_stub: "blank_stub";
+            }>;
+            nonEmptyCount: z.ZodNumber;
+            nonEmptyRatio: z.ZodNumber;
+            examples: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    sample: z.ZodObject<{
+        truncatedRows: z.ZodBoolean;
+        truncatedColumns: z.ZodBoolean;
+        rows: z.ZodArray<z.ZodObject<{
+            rowNumber: z.ZodNumber;
+            values: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    sampleTokenEstimate: z.ZodNumber;
+    fullTokenEstimate: z.ZodNumber;
+    estimateMethod: z.ZodLiteral<"full_scan">;
+}, z.core.$strip>;
+export type SheetProfile = z.infer<typeof SheetProfileSchema>;
+export declare const WorkbookInspectionSchema: z.ZodObject<{
+    file: z.ZodString;
+    format: z.ZodLiteral<"xlsx">;
+    size: z.ZodNumber;
+    properties: z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        subject: z.ZodOptional<z.ZodString>;
+        author: z.ZodOptional<z.ZodString>;
+        company: z.ZodOptional<z.ZodString>;
+        manager: z.ZodOptional<z.ZodString>;
+        createdDate: z.ZodOptional<z.ZodString>;
+        modifiedDate: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    customPropertyCount: z.ZodNumber;
+    customProperties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    sheetCount: z.ZodNumber;
+    visibleSheetCount: z.ZodNumber;
+    hiddenSheetCount: z.ZodNumber;
+    veryHiddenSheetCount: z.ZodNumber;
+    definedNames: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        ref: z.ZodString;
+        scope: z.ZodEnum<{
+            sheet: "sheet";
+            workbook: "workbook";
+        }>;
+        sheetIndex: z.ZodOptional<z.ZodNumber>;
+        sheetName: z.ZodOptional<z.ZodString>;
+        external: z.ZodBoolean;
+    }, z.core.$strip>>;
+    riskFlags: z.ZodObject<{
+        hiddenSheets: z.ZodBoolean;
+        formulas: z.ZodBoolean;
+        comments: z.ZodBoolean;
+        hyperlinks: z.ZodBoolean;
+        mergedCells: z.ZodBoolean;
+        protectedSheets: z.ZodBoolean;
+        externalFormulaRefs: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type WorkbookInspection = z.infer<typeof WorkbookInspectionSchema>;
+export declare const SheetInspectionResultSchema: z.ZodObject<{
+    workbook: z.ZodObject<{
+        file: z.ZodString;
+        format: z.ZodLiteral<"xlsx">;
+        size: z.ZodNumber;
+        properties: z.ZodObject<{
+            title: z.ZodOptional<z.ZodString>;
+            subject: z.ZodOptional<z.ZodString>;
+            author: z.ZodOptional<z.ZodString>;
+            company: z.ZodOptional<z.ZodString>;
+            manager: z.ZodOptional<z.ZodString>;
+            createdDate: z.ZodOptional<z.ZodString>;
+            modifiedDate: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        customPropertyCount: z.ZodNumber;
+        customProperties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        sheetCount: z.ZodNumber;
+        visibleSheetCount: z.ZodNumber;
+        hiddenSheetCount: z.ZodNumber;
+        veryHiddenSheetCount: z.ZodNumber;
+        definedNames: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            ref: z.ZodString;
+            scope: z.ZodEnum<{
+                sheet: "sheet";
+                workbook: "workbook";
+            }>;
+            sheetIndex: z.ZodOptional<z.ZodNumber>;
+            sheetName: z.ZodOptional<z.ZodString>;
+            external: z.ZodBoolean;
+        }, z.core.$strip>>;
+        riskFlags: z.ZodObject<{
+            hiddenSheets: z.ZodBoolean;
+            formulas: z.ZodBoolean;
+            comments: z.ZodBoolean;
+            hyperlinks: z.ZodBoolean;
+            mergedCells: z.ZodBoolean;
+            protectedSheets: z.ZodBoolean;
+            externalFormulaRefs: z.ZodBoolean;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    sheets: z.ZodArray<z.ZodObject<{
+        index: z.ZodNumber;
+        name: z.ZodString;
+        visibility: z.ZodEnum<{
+            visible: "visible";
+            hidden: "hidden";
+            very_hidden: "very_hidden";
+        }>;
+        usedRange: z.ZodNullable<z.ZodString>;
+        totalRows: z.ZodNumber;
+        totalCols: z.ZodNumber;
+        rectangularRangeCellCount: z.ZodNumber;
+        nonEmptyCellCount: z.ZodNumber;
+        cellTypeCounts: z.ZodObject<{
+            string: z.ZodNumber;
+            number: z.ZodNumber;
+            boolean: z.ZodNumber;
+            date: z.ZodNumber;
+            error: z.ZodNumber;
+            blankStub: z.ZodNumber;
+        }, z.core.$strip>;
+        formulaCellCount: z.ZodNumber;
+        commentCellCount: z.ZodNumber;
+        hyperlinkCellCount: z.ZodNumber;
+        mergedRangeCount: z.ZodNumber;
+        hiddenRowCount: z.ZodNumber;
+        hiddenColumnCount: z.ZodNumber;
+        autoFilterRef: z.ZodNullable<z.ZodString>;
+        protected: z.ZodBoolean;
+        definedNames: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            ref: z.ZodString;
+            scope: z.ZodEnum<{
+                sheet: "sheet";
+                workbook: "workbook";
+            }>;
+            sheetIndex: z.ZodOptional<z.ZodNumber>;
+            sheetName: z.ZodOptional<z.ZodString>;
+            external: z.ZodBoolean;
+        }, z.core.$strip>>;
+        externalFormulaRefCount: z.ZodNumber;
+        headerSelection: z.ZodObject<{
+            requested: z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodLiteral<"none">, z.ZodNumber]>;
+            mode: z.ZodEnum<{
+                auto: "auto";
+                none: "none";
+                explicit: "explicit";
+            }>;
+            rowNumber: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>;
+        schema: z.ZodObject<{
+            truncated: z.ZodBoolean;
+            columns: z.ZodArray<z.ZodObject<{
+                index: z.ZodNumber;
+                letter: z.ZodString;
+                name: z.ZodString;
+                dominantType: z.ZodEnum<{
+                    string: "string";
+                    number: "number";
+                    boolean: "boolean";
+                    unknown: "unknown";
+                    date: "date";
+                    error: "error";
+                    blank_stub: "blank_stub";
+                }>;
+                nonEmptyCount: z.ZodNumber;
+                nonEmptyRatio: z.ZodNumber;
+                examples: z.ZodArray<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+        sample: z.ZodObject<{
+            truncatedRows: z.ZodBoolean;
+            truncatedColumns: z.ZodBoolean;
+            rows: z.ZodArray<z.ZodObject<{
+                rowNumber: z.ZodNumber;
+                values: z.ZodRecord<z.ZodString, z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+        sampleTokenEstimate: z.ZodNumber;
+        fullTokenEstimate: z.ZodNumber;
+        estimateMethod: z.ZodLiteral<"full_scan">;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SheetInspectionResult = z.infer<typeof SheetInspectionResultSchema>;
+export declare const SheetInspectPayloadSchema: z.ZodObject<{
+    file: z.ZodString;
+    query: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    results: z.ZodObject<{
+        workbook: z.ZodObject<{
+            file: z.ZodString;
+            format: z.ZodLiteral<"xlsx">;
+            size: z.ZodNumber;
+            properties: z.ZodObject<{
+                title: z.ZodOptional<z.ZodString>;
+                subject: z.ZodOptional<z.ZodString>;
+                author: z.ZodOptional<z.ZodString>;
+                company: z.ZodOptional<z.ZodString>;
+                manager: z.ZodOptional<z.ZodString>;
+                createdDate: z.ZodOptional<z.ZodString>;
+                modifiedDate: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            customPropertyCount: z.ZodNumber;
+            customProperties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            sheetCount: z.ZodNumber;
+            visibleSheetCount: z.ZodNumber;
+            hiddenSheetCount: z.ZodNumber;
+            veryHiddenSheetCount: z.ZodNumber;
+            definedNames: z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                ref: z.ZodString;
+                scope: z.ZodEnum<{
+                    sheet: "sheet";
+                    workbook: "workbook";
+                }>;
+                sheetIndex: z.ZodOptional<z.ZodNumber>;
+                sheetName: z.ZodOptional<z.ZodString>;
+                external: z.ZodBoolean;
+            }, z.core.$strip>>;
+            riskFlags: z.ZodObject<{
+                hiddenSheets: z.ZodBoolean;
+                formulas: z.ZodBoolean;
+                comments: z.ZodBoolean;
+                hyperlinks: z.ZodBoolean;
+                mergedCells: z.ZodBoolean;
+                protectedSheets: z.ZodBoolean;
+                externalFormulaRefs: z.ZodBoolean;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        sheets: z.ZodArray<z.ZodObject<{
+            index: z.ZodNumber;
+            name: z.ZodString;
+            visibility: z.ZodEnum<{
+                visible: "visible";
+                hidden: "hidden";
+                very_hidden: "very_hidden";
+            }>;
+            usedRange: z.ZodNullable<z.ZodString>;
+            totalRows: z.ZodNumber;
+            totalCols: z.ZodNumber;
+            rectangularRangeCellCount: z.ZodNumber;
+            nonEmptyCellCount: z.ZodNumber;
+            cellTypeCounts: z.ZodObject<{
+                string: z.ZodNumber;
+                number: z.ZodNumber;
+                boolean: z.ZodNumber;
+                date: z.ZodNumber;
+                error: z.ZodNumber;
+                blankStub: z.ZodNumber;
+            }, z.core.$strip>;
+            formulaCellCount: z.ZodNumber;
+            commentCellCount: z.ZodNumber;
+            hyperlinkCellCount: z.ZodNumber;
+            mergedRangeCount: z.ZodNumber;
+            hiddenRowCount: z.ZodNumber;
+            hiddenColumnCount: z.ZodNumber;
+            autoFilterRef: z.ZodNullable<z.ZodString>;
+            protected: z.ZodBoolean;
+            definedNames: z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                ref: z.ZodString;
+                scope: z.ZodEnum<{
+                    sheet: "sheet";
+                    workbook: "workbook";
+                }>;
+                sheetIndex: z.ZodOptional<z.ZodNumber>;
+                sheetName: z.ZodOptional<z.ZodString>;
+                external: z.ZodBoolean;
+            }, z.core.$strip>>;
+            externalFormulaRefCount: z.ZodNumber;
+            headerSelection: z.ZodObject<{
+                requested: z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodLiteral<"none">, z.ZodNumber]>;
+                mode: z.ZodEnum<{
+                    auto: "auto";
+                    none: "none";
+                    explicit: "explicit";
+                }>;
+                rowNumber: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strip>;
+            schema: z.ZodObject<{
+                truncated: z.ZodBoolean;
+                columns: z.ZodArray<z.ZodObject<{
+                    index: z.ZodNumber;
+                    letter: z.ZodString;
+                    name: z.ZodString;
+                    dominantType: z.ZodEnum<{
+                        string: "string";
+                        number: "number";
+                        boolean: "boolean";
+                        unknown: "unknown";
+                        date: "date";
+                        error: "error";
+                        blank_stub: "blank_stub";
+                    }>;
+                    nonEmptyCount: z.ZodNumber;
+                    nonEmptyRatio: z.ZodNumber;
+                    examples: z.ZodArray<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+            sample: z.ZodObject<{
+                truncatedRows: z.ZodBoolean;
+                truncatedColumns: z.ZodBoolean;
+                rows: z.ZodArray<z.ZodObject<{
+                    rowNumber: z.ZodNumber;
+                    values: z.ZodRecord<z.ZodString, z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+            sampleTokenEstimate: z.ZodNumber;
+            fullTokenEstimate: z.ZodNumber;
+            estimateMethod: z.ZodLiteral<"full_scan">;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type SheetInspectPayload = z.infer<typeof SheetInspectPayloadSchema>;