@niicojs/excel 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -130,6 +130,32 @@ interface PivotCacheField {
  * Pivot field axis assignment
  */
 type PivotFieldAxis = 'row' | 'column' | 'filter' | 'value';
+/**
+ * Configuration for creating a sheet from an array of objects
+ */
+interface SheetFromDataConfig<T extends object = Record<string, unknown>> {
+    /** Name of the sheet to create */
+    name: string;
+    /** Array of objects with the same structure */
+    data: T[];
+    /** Column definitions (optional - defaults to all keys from first object) */
+    columns?: ColumnConfig<T>[];
+    /** Apply header styling (bold text) (default: true) */
+    headerStyle?: boolean;
+    /** Starting cell address (default: 'A1') */
+    startCell?: string;
+}
+/**
+ * Column configuration for sheet data
+ */
+interface ColumnConfig<T = Record<string, unknown>> {
+    /** Key from the object to use for this column */
+    key: keyof T;
+    /** Header text (optional - defaults to key name) */
+    header?: string;
+    /** Cell style for data cells in this column */
+    style?: CellStyle;
+}
 
 /**
  * Represents a single cell in a worksheet
@@ -665,6 +691,49 @@ declare class Workbook {
      * Copy a worksheet
      */
     copySheet(sourceName: string, newName: string): Worksheet;
+    /**
+     * Create a new worksheet from an array of objects.
+     *
+     * The first row contains headers (object keys or custom column headers),
+     * and subsequent rows contain the object values.
+     *
+     * @param config - Configuration for the sheet creation
+     * @returns The created Worksheet
+     *
+     * @example
+     * ```typescript
+     * const data = [
+     *   { name: 'Alice', age: 30, city: 'Paris' },
+     *   { name: 'Bob', age: 25, city: 'London' },
+     *   { name: 'Charlie', age: 35, city: 'Berlin' },
+     * ];
+     *
+     * // Simple usage - all object keys become columns
+     * const sheet = wb.addSheetFromData({
+     *   name: 'People',
+     *   data: data,
+     * });
+     *
+     * // With custom column configuration
+     * const sheet2 = wb.addSheetFromData({
+     *   name: 'People Custom',
+     *   data: data,
+     *   columns: [
+     *     { key: 'name', header: 'Full Name' },
+     *     { key: 'age', header: 'Age (years)' },
+     *   ],
+     * });
+     * ```
+     */
+    addSheetFromData<T extends object>(config: SheetFromDataConfig<T>): Worksheet;
+    /**
+     * Infer column configuration from the first data object
+     */
+    private _inferColumns;
+    /**
+     * Convert an unknown value to a CellValue
+     */
+    private _toCellValue;
     /**
      * Create a pivot table from source data.
      *
@@ -741,5 +810,5 @@ declare const parseRange: (range: string) => RangeAddress;
 declare const toRange: (range: RangeAddress) => string;
 
 export { Cell, PivotCache, PivotTable, Range, SharedStrings, Styles, Workbook, Worksheet, parseAddress, parseRange, toAddress, toRange };
-export type { AggregationType, Alignment, BorderStyle, BorderType, CellAddress, CellError, CellStyle, CellType, CellValue, ErrorType, PivotFieldAxis, PivotTableConfig, PivotValueConfig, RangeAddress };
+export type { AggregationType, Alignment, BorderStyle, BorderType, CellAddress, CellError, CellStyle, CellType, CellValue, ColumnConfig, ErrorType, PivotFieldAxis, PivotTableConfig, PivotValueConfig, RangeAddress, SheetFromDataConfig };
 //# sourceMappingURL=index.d.ts.map