@graphysdk/data-import-utils 1.8.0 → 1.8.1-beta.1786025839240

package/dist/file.d.ts

@@ -1,42 +0,0 @@
-import { VizLocale, GraphConfig } from '@graphysdk/core/node';
-
-/** The `data` shape returned by all parsers — same as `GraphConfig['data']`. */
-type Data = GraphConfig['data'];
-/** Shared base options for all parsers. */
-interface BaseParseOptions {
-    /** Locale for number parsing. Determines thousand/decimal separator conventions. @default 'EN_US' */
-    locale?: VizLocale;
-    /** Maximum allowed input size in megabytes. @default 5 */
-    maxFileSize?: number;
-}
-/** Options for CSV / TSV parsing. */
-interface DelimitedParseOptions extends BaseParseOptions {
-    /** Whether the first row contains column headers. @default true */
-    hasHeader?: boolean;
-}
-/** Options for XLSX / XLS / ODS parsing. */
-interface SpreadsheetParseOptions extends BaseParseOptions {
-    /** Sheet to parse — name (string) or 0-based index (number). @default 0 (first sheet) */
-    sheet?: string | number;
-    /** Maximum number of data rows to process. @default 100_000 */
-    maxRows?: number;
-    /** Maximum total cells to process. @default 5_000_000 */
-    maxCells?: number;
-}
-/** Options for `fromFile` — covers both delimited and spreadsheet formats. */
-type FileParseOptions = SpreadsheetParseOptions & Pick<DelimitedParseOptions, 'hasHeader'>;
-
-/**
- * Reads a file from disk and parses it into the `Data` shape expected by
- * `generateGraph()`. The format is auto-detected from the file extension.
- *
- * @example
- * ```ts
- * const data = await fromFile('sales.csv');
- * const data = await fromFile('report.xlsx', { sheet: 'Revenue' });
- * ```
- */
-declare const fromFile: (filePath: string, options?: FileParseOptions) => Promise<Data>;
-
-export { fromFile };
-export type { BaseParseOptions, Data, FileParseOptions, SpreadsheetParseOptions };

package/dist/ods.d.ts

@@ -1,31 +0,0 @@
-import { VizLocale, GraphConfig } from '@graphysdk/core/node';
-
-/** The `data` shape returned by all parsers — same as `GraphConfig['data']`. */
-type Data = GraphConfig['data'];
-/** Shared base options for all parsers. */
-interface BaseParseOptions {
-    /** Locale for number parsing. Determines thousand/decimal separator conventions. @default 'EN_US' */
-    locale?: VizLocale;
-    /** Maximum allowed input size in megabytes. @default 5 */
-    maxFileSize?: number;
-}
-/** Options for XLSX / XLS / ODS parsing. */
-interface SpreadsheetParseOptions extends BaseParseOptions {
-    /** Sheet to parse — name (string) or 0-based index (number). @default 0 (first sheet) */
-    sheet?: string | number;
-    /** Maximum number of data rows to process. @default 100_000 */
-    maxRows?: number;
-    /** Maximum total cells to process. @default 5_000_000 */
-    maxCells?: number;
-}
-
-/**
- * Parses an ODS (OpenDocument Spreadsheet) file into the `Data` shape expected by `generateGraph()`.
- *
- * **Note:** Uses ExcelJS which natively supports XLSX format. ODS files that are
- * saved in XLSX-compatible format will parse correctly. Native ODS format is not supported.
- */
-declare const fromODS: (input: ArrayBuffer, options?: SpreadsheetParseOptions) => Promise<Data>;
-
-export { fromODS };
-export type { BaseParseOptions, SpreadsheetParseOptions };

package/dist/text.d.ts

@@ -1,32 +0,0 @@
-import { VizLocale, GraphConfig } from '@graphysdk/core/node';
-
-/** The `data` shape returned by all parsers — same as `GraphConfig['data']`. */
-type Data = GraphConfig['data'];
-/** Text-based formats that accept string input. */
-type TextFileFormat = 'csv' | 'tsv' | 'json';
-/** Shared base options for all parsers. */
-interface BaseParseOptions {
-    /** Locale for number parsing. Determines thousand/decimal separator conventions. @default 'EN_US' */
-    locale?: VizLocale;
-    /** Maximum allowed input size in megabytes. @default 5 */
-    maxFileSize?: number;
-}
-/** Options for CSV / TSV parsing. */
-interface DelimitedParseOptions extends BaseParseOptions {
-    /** Whether the first row contains column headers. @default true */
-    hasHeader?: boolean;
-}
-
-/**
- * Parses a text string (CSV or TSV) into the `Data` shape expected by `generateGraph()`.
- *
- * @example
- * ```ts
- * const data = fromText(csvContent, 'csv');
- * const data = fromText(tsvContent, 'tsv', { hasHeader: false });
- * ```
- */
-declare const fromText: (input: string, format: TextFileFormat, options?: DelimitedParseOptions) => Data;
-
-export { fromText };
-export type { BaseParseOptions, Data, DelimitedParseOptions, TextFileFormat };

package/dist/tsv.d.ts

@@ -1,30 +0,0 @@
-import { VizLocale, GraphConfig } from '@graphysdk/core/node';
-
-/** The `data` shape returned by all parsers — same as `GraphConfig['data']`. */
-type Data = GraphConfig['data'];
-/** Shared base options for all parsers. */
-interface BaseParseOptions {
-    /** Locale for number parsing. Determines thousand/decimal separator conventions. @default 'EN_US' */
-    locale?: VizLocale;
-    /** Maximum allowed input size in megabytes. @default 5 */
-    maxFileSize?: number;
-}
-/** Options for CSV / TSV parsing. */
-interface DelimitedParseOptions extends BaseParseOptions {
-    /** Whether the first row contains column headers. @default true */
-    hasHeader?: boolean;
-}
-
-/**
- * Parses a TSV string into the `Data` shape expected by `generateGraph()`.
- *
- * @example
- * ```ts
- * const data = fromTSV('Name\tRevenue\nAcme\t1000');
- * sdk.generateGraph({ config: { data }, userPrompt: 'bar chart' });
- * ```
- */
-declare const fromTSV: (input: string, options?: DelimitedParseOptions) => Data;
-
-export { fromTSV };
-export type { BaseParseOptions, DelimitedParseOptions };

package/dist/xls.d.ts

@@ -1,32 +0,0 @@
-import { VizLocale, GraphConfig } from '@graphysdk/core/node';
-
-/** The `data` shape returned by all parsers — same as `GraphConfig['data']`. */
-type Data = GraphConfig['data'];
-/** Shared base options for all parsers. */
-interface BaseParseOptions {
-    /** Locale for number parsing. Determines thousand/decimal separator conventions. @default 'EN_US' */
-    locale?: VizLocale;
-    /** Maximum allowed input size in megabytes. @default 5 */
-    maxFileSize?: number;
-}
-/** Options for XLSX / XLS / ODS parsing. */
-interface SpreadsheetParseOptions extends BaseParseOptions {
-    /** Sheet to parse — name (string) or 0-based index (number). @default 0 (first sheet) */
-    sheet?: string | number;
-    /** Maximum number of data rows to process. @default 100_000 */
-    maxRows?: number;
-    /** Maximum total cells to process. @default 5_000_000 */
-    maxCells?: number;
-}
-
-/**
- * Parses an XLS file into the `Data` shape expected by `generateGraph()`.
- *
- * **Note:** Uses ExcelJS which natively supports XLSX format. Modern `.xls` files
- * (produced by Excel 2007+) that are actually XLSX will parse correctly.
- * Genuine legacy binary XLS (BIFF) files are not supported.
- */
-declare const fromXLS: (input: ArrayBuffer, options?: SpreadsheetParseOptions) => Promise<Data>;
-
-export { fromXLS };
-export type { BaseParseOptions, SpreadsheetParseOptions };

package/dist/xlsx.d.ts

@@ -1,127 +0,0 @@
-import { VizLocale, GraphConfig } from '@graphysdk/core/node';
-import ExcelJS from 'exceljs';
-
-/** The `data` shape returned by all parsers — same as `GraphConfig['data']`. */
-type Data = GraphConfig['data'];
-/** Shared base options for all parsers. */
-interface BaseParseOptions {
-    /** Locale for number parsing. Determines thousand/decimal separator conventions. @default 'EN_US' */
-    locale?: VizLocale;
-    /** Maximum allowed input size in megabytes. @default 5 */
-    maxFileSize?: number;
-}
-/** Options for XLSX / XLS / ODS parsing. */
-interface SpreadsheetParseOptions extends BaseParseOptions {
-    /** Sheet to parse — name (string) or 0-based index (number). @default 0 (first sheet) */
-    sheet?: string | number;
-    /** Maximum number of data rows to process. @default 100_000 */
-    maxRows?: number;
-    /** Maximum total cells to process. @default 5_000_000 */
-    maxCells?: number;
-}
-
-/**
- * Parses an XLSX file into the `Data` shape expected by `generateGraph()`.
- */
-declare const fromXLSX: (input: ArrayBuffer, options?: SpreadsheetParseOptions) => Promise<Data>;
-
-/**
- * Extracts a primitive value (`string | number | null`) from an ExcelJS cell.
- * Handles numbers, strings, booleans, dates, formulas, rich text, hyperlinks, and errors.
- * Shared by chart-oriented parsing (`fromXLSX`) and extract-oriented region reads.
- */
-declare const extractCellPrimitive: (cell: ExcelJS.Cell) => string | number | null;
-
-/** Loads an OOXML `.xlsx` buffer into an ExcelJS workbook (single-file extract pipeline). */
-declare function loadWorkbookFromXlsxBuffer(input: ArrayBuffer): Promise<ExcelJS.Workbook>;
-
-/** Bump when island rules or index shape changes (extract API stability). */
-declare const WORKBOOK_INDEX_SCHEMA_VERSION: 1;
-/** Default cap on total non-empty cells indexed across the workbook (aligns with {@link DEFAULT_MAX_CELLS}). */
-declare const DEFAULT_MAX_WORKBOOK_INDEX_NON_EMPTY_CELLS = 5000000;
-interface BuildWorkbookIndexOptions {
-    /**
-     * Abort if the workbook would exceed this many non-empty cells in total (memory / DoS guard).
-     * @default {@link DEFAULT_MAX_WORKBOOK_INDEX_NON_EMPTY_CELLS}
-     */
-    maxNonEmptyCells?: number;
-}
-interface SheetIndexEntry {
-    sheetName: string;
-    /** 0-based order in the workbook. */
-    sheetIndex: number;
-    /** Inclusive 1-based Excel row/column indices; `null` when the sheet has no data cells. */
-    rowMin: number | null;
-    rowMax: number | null;
-    colMin: number | null;
-    colMax: number | null;
-    nonEmptyCellCount: number;
-}
-interface IslandEntry {
-    /**
-     * Stable within a single file: `${sheetIndex}:${islandOrdinalOnSheet}`.
-     * Consumers prefix with request-level `fileIndex` for multi-file UX.
-     */
-    localId: string;
-    sheetIndex: number;
-    sheetName: string;
-    rowMin: number;
-    rowMax: number;
-    colMin: number;
-    colMax: number;
-    /** Number of non-empty cells in this island (4-connected region). */
-    cellCount: number;
-}
-interface WorkbookIndex {
-    schemaVersion: typeof WORKBOOK_INDEX_SCHEMA_VERSION;
-    sheets: SheetIndexEntry[];
-    islands: IslandEntry[];
-}
-/**
- * Deterministic structural index for one loaded workbook: per-sheet used bounds and
- * 4-connected **islands** of non-empty cells (using the same empty rules as {@link extractCellPrimitive}).
- */
-declare function buildWorkbookIndex(workbook: ExcelJS.Workbook, options?: BuildWorkbookIndexOptions): WorkbookIndex;
-/** Loads an `.xlsx` buffer and returns its structural index (no retained workbook handle). */
-declare function buildWorkbookIndexFromXlsxBuffer(input: ArrayBuffer, options?: BuildWorkbookIndexOptions): Promise<WorkbookIndex>;
-
-/** Default max cells returned by {@link readSheetRegion} (row-major fill). */
-declare const DEFAULT_READ_REGION_MAX_CELLS = 50000;
-interface ReadSheetRegionOptions {
-    /** Stop after this many cells (complete rows only — no partial trailing row). @default {@link DEFAULT_READ_REGION_MAX_CELLS} */
-    maxCells?: number;
-}
-interface ReadSheetRegionResult {
-    sheetIndex: number;
-    sheetName: string;
-    /**
-     * Inclusive 1-based Excel row for the first row in {@link rows} (always the requested `rowMin`).
-     */
-    rowMin: number;
-    /**
-     * Inclusive 1-based Excel row for the last row in {@link rows} (`rowMin + rows.length - 1`).
-     * When {@link truncated} is false, this equals the requested `rowMax`.
-     */
-    rowMax: number;
-    colMin: number;
-    colMax: number;
-    /** Row-major grid aligned to Excel indices; `rows[i]` is Excel row `rowMin + i`. */
-    rows: Array<Array<string | number | null>>;
-    truncated: boolean;
-    returnedCellCount: number;
-}
-/**
- * Reads a rectangular region (1-based inclusive Excel row/column indices) using the same cell rules as {@link extractCellPrimitive}.
- * Enforces {@link ReadSheetRegionOptions.maxCells}; when exceeded, returns complete rows only and sets `truncated`.
- */
-declare function readSheetRegion(workbook: ExcelJS.Workbook, sheetIndex: number, bounds: {
-    rowMin: number;
-    rowMax: number;
-    colMin: number;
-    colMax: number;
-}, options?: ReadSheetRegionOptions): ReadSheetRegionResult;
-/** Reads exactly the bounding box of an island entry from {@link buildWorkbookIndex}. */
-declare function readIslandRegion(workbook: ExcelJS.Workbook, island: IslandEntry, options?: ReadSheetRegionOptions): ReadSheetRegionResult;
-
-export { DEFAULT_MAX_WORKBOOK_INDEX_NON_EMPTY_CELLS, DEFAULT_READ_REGION_MAX_CELLS, WORKBOOK_INDEX_SCHEMA_VERSION, buildWorkbookIndex, buildWorkbookIndexFromXlsxBuffer, extractCellPrimitive, fromXLSX, loadWorkbookFromXlsxBuffer, readIslandRegion, readSheetRegion };
-export type { BaseParseOptions, BuildWorkbookIndexOptions, IslandEntry, ReadSheetRegionOptions, ReadSheetRegionResult, SheetIndexEntry, SpreadsheetParseOptions, WorkbookIndex };