xlkit 1.0.5 → 1.2.0

package/dist/index.d.ts

@@ -1,3 +1,283 @@
-export * from './types';
-export * from './Sheetflow';
-//# sourceMappingURL=index.d.ts.map
+import ExcelJS, { Cell, Worksheet } from 'exceljs';
+
+declare class BrowserOutput {
+    private workbook;
+    constructor(workbook: ExcelJS.Workbook);
+    /**
+     * ブラウザでダウンロード
+     */
+    download(fileName: string): Promise<void>;
+}
+
+declare class NodeOutput {
+    private workbook;
+    constructor(workbook: ExcelJS.Workbook);
+    /**
+     * ファイルに保存
+     */
+    saveToFile(filePath: string): Promise<void>;
+    /**
+     * Bufferとして取得
+     */
+    toBuffer(): Promise<Buffer>;
+}
+
+type ImageSource = Buffer | string;
+type ImageOptions = {
+    source: ImageSource;
+    width?: number;
+    height?: number;
+    row?: number;
+    col?: number;
+};
+
+type AlignType = "left" | "center" | "right";
+type FormatType = "string" | "number" | "date";
+type CellStyle = {
+    fontFamily?: string;
+    fontSize?: number;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strike?: boolean;
+    color?: string;
+    fill?: string;
+    align?: AlignType;
+    format?: FormatType;
+    decimalPlaces?: number;
+    thousandsSeparator?: boolean;
+};
+type LineStyle = "thin" | "medium" | "thick" | "dotted" | "dashed" | "double";
+type BorderStyle = {
+    outline?: LineStyle;
+    headerBody?: LineStyle;
+    headerInner?: LineStyle;
+    bodyInner?: LineStyle;
+    borderColor?: string;
+};
+type TableStyle = {
+    header?: CellStyle;
+    body?: CellStyle;
+};
+
+type LeafColumn<T> = {
+    key: keyof T & string;
+    label: string;
+    style?: CellStyle;
+    mergeSameValues?: boolean;
+};
+type ParentColumn<T> = {
+    label: string;
+    children: Column<T>[];
+};
+type Column<T> = LeafColumn<T> | ParentColumn<T>;
+
+type TablePreset = "basic" | "minimal" | "striped";
+type AutoWidthOption = "all" | "body" | false;
+type TableOptions<T> = {
+    preset?: TablePreset;
+    columns: Column<T>[];
+    data: (T & {
+        _style?: Partial<Record<keyof T, CellStyle>>;
+    })[];
+    autoWidth?: AutoWidthOption;
+    mergeSameValues?: boolean;
+    style?: TableStyle;
+    border?: BorderStyle;
+    conditionalStyle?: (row: T, col: keyof T) => CellStyle | Record<string, never>;
+};
+
+type StyledCell = {
+    value: string | number | boolean;
+    style?: CellStyle;
+};
+type TextInput = string | StyledCell;
+
+type BlockType = "table" | "text" | "image" | "space";
+type Block = {
+    type: "table";
+    options: TableOptions<Record<string, unknown>>;
+} | {
+    type: "text";
+    input: TextInput;
+} | {
+    type: "image";
+    options: ImageOptions;
+} | {
+    type: "space";
+    lines: number;
+};
+type SheetState = {
+    name: string;
+    blocks: Block[];
+};
+type WorkbookState = {
+    sheets: SheetState[];
+};
+
+declare class SheetBuilder {
+    private workbook;
+    private sheetState;
+    constructor(workbook: WorkbookBuilder, sheetState: SheetState);
+    /**
+     * テーブルを追加
+     */
+    table<T>(options: TableOptions<T>): this;
+    /**
+     * テキストを追加
+     */
+    text(input: TextInput): this;
+    /**
+     * 画像を追加
+     */
+    image(options: ImageOptions): this;
+    /**
+     * 空行を追加
+     */
+    space(lines?: number): this;
+    /**
+     * 新しいシートを追加（WorkbookBuilderに委譲）
+     */
+    sheet(name?: string): SheetBuilder;
+    /**
+     * ブラウザ向け出力オブジェクトを取得（WorkbookBuilderに委譲）
+     */
+    getBrowser(): Promise<BrowserOutput>;
+    /**
+     * Node.js向け出力オブジェクトを取得（WorkbookBuilderに委譲）
+     */
+    getNode(): Promise<NodeOutput>;
+}
+
+declare class WorkbookBuilder {
+    private state;
+    constructor();
+    /**
+     * シートを追加する
+     * @param name シート名（省略時は "Sheet1", "Sheet2", ...）
+     */
+    sheet(name?: string): SheetBuilder;
+    /**
+     * ワークブックの状態を取得（内部用）
+     */
+    getState(): WorkbookState;
+    /**
+     * ブラウザ向け出力オブジェクトを取得
+     */
+    getBrowser(): Promise<BrowserOutput>;
+    /**
+     * Node.js向け出力オブジェクトを取得
+     */
+    getNode(): Promise<NodeOutput>;
+}
+/**
+ * xlkit ファクトリ関数
+ */
+declare function xlkit(): WorkbookBuilder;
+
+/**
+ * セルの値とスタイルを保持
+ */
+declare class CellReader {
+    private cell;
+    constructor(cell: Cell);
+    /**
+     * セルの値を取得
+     */
+    get value(): string | number | boolean | null;
+    /**
+     * セルのスタイルを取得
+     */
+    get style(): CellStyle | undefined;
+    /**
+     * 数値フォーマットから format を検出
+     */
+    private detectFormat;
+    /**
+     * セルの罫線情報を取得
+     */
+    get border(): CellBorder | undefined;
+}
+/**
+ * セルの罫線情報
+ */
+type CellBorder = {
+    top?: {
+        style: LineStyle;
+        color?: string;
+    };
+    bottom?: {
+        style: LineStyle;
+        color?: string;
+    };
+    left?: {
+        style: LineStyle;
+        color?: string;
+    };
+    right?: {
+        style: LineStyle;
+        color?: string;
+    };
+};
+
+/**
+ * シートの読み取り
+ */
+declare class SheetReader {
+    private worksheet;
+    constructor(worksheet: Worksheet);
+    /**
+     * シート名を取得
+     */
+    get name(): string;
+    /**
+     * セルを取得（A1形式）
+     */
+    cell(address: string): CellReader;
+    /**
+     * セルを取得（行・列番号）
+     */
+    cellAt(row: number, col: number): CellReader;
+    /**
+     * マージされたセル範囲を取得
+     */
+    get mergedCells(): string[];
+    /**
+     * 行数を取得
+     */
+    get rowCount(): number;
+    /**
+     * 列数を取得
+     */
+    get columnCount(): number;
+}
+
+/**
+ * ワークブックの読み取り
+ */
+declare class WorkbookReader {
+    private workbook;
+    constructor(workbook: ExcelJS.Workbook);
+    /**
+     * シート名の配列を取得
+     */
+    get sheetNames(): string[];
+    /**
+     * シートを取得（名前指定）
+     */
+    sheet(name: string): SheetReader;
+    /**
+     * シートを取得（インデックス指定、0-indexed）
+     */
+    sheetAt(index: number): SheetReader;
+    /**
+     * シート数を取得
+     */
+    get sheetCount(): number;
+}
+/**
+ * Excelファイルを読み取る
+ */
+declare function read(source: Buffer | string): Promise<WorkbookReader>;
+
+export { type AlignType, type AutoWidthOption, type Block, type BlockType, type BorderStyle, type CellBorder, CellReader, type CellStyle, type Column, type FormatType, type ImageOptions, type ImageSource, type LeafColumn, type LineStyle, type ParentColumn, SheetReader, type SheetState, type StyledCell, type TableOptions, type TablePreset, type TableStyle, type TextInput, WorkbookReader, type WorkbookState, read, xlkit };