@prismiq/react 0.1.0

package/dist/export/index.d.cts

@@ -0,0 +1,197 @@
+import { Q as QueryResult } from '../types-WrCbOeAV.cjs';
+
+/**
+ * Types for export functionality.
+ */
+
+/**
+ * Options for CSV export.
+ */
+interface ExportOptions {
+    /** Custom filename (without extension) */
+    filename?: string;
+    /** Subset of columns to export (defaults to all) */
+    columns?: string[];
+    /** Custom column header names */
+    headers?: Record<string, string>;
+    /** Date format string (default: ISO) */
+    dateFormat?: string;
+    /** Number format options */
+    numberFormat?: Intl.NumberFormatOptions;
+}
+/**
+ * Options for Excel export.
+ */
+interface ExcelExportOptions extends ExportOptions {
+    /** Sheet name (default: "Sheet1") */
+    sheetName?: string;
+    /** Column width overrides */
+    columnWidths?: Record<string, number>;
+    /** Freeze the header row */
+    freezeHeader?: boolean;
+    /** Header cell style */
+    headerStyle?: ExcelCellStyle;
+    /** Data cell style */
+    dataStyle?: ExcelCellStyle;
+}
+/**
+ * Excel cell style options.
+ */
+interface ExcelCellStyle {
+    /** Bold text */
+    bold?: boolean;
+    /** Background color (hex) */
+    fill?: string;
+    /** Text alignment */
+    align?: 'left' | 'center' | 'right';
+}
+/**
+ * Data that can be exported (QueryResult or array of objects).
+ */
+type ExportData = QueryResult | Record<string, unknown>[];
+
+/**
+ * CSV export functionality.
+ */
+
+/**
+ * Generate CSV content from data.
+ *
+ * @param data - Array of row objects
+ * @param columns - Column names
+ * @param headers - Custom header names
+ * @param options - Export options
+ * @returns CSV string
+ */
+declare function generateCSV(data: Record<string, unknown>[], columns: string[], headers?: Record<string, string>, options?: ExportOptions): string;
+/**
+ * Trigger a file download in the browser.
+ *
+ * @param content - File content
+ * @param filename - File name with extension
+ * @param mimeType - MIME type
+ */
+declare function downloadFile(content: string, filename: string, mimeType: string): void;
+/**
+ * Export data to CSV and trigger download.
+ *
+ * @param data - QueryResult or array of objects
+ * @param options - Export options
+ *
+ * @example
+ * ```tsx
+ * // Export query result
+ * exportToCSV(queryResult, { filename: 'sales-report' });
+ *
+ * // Export with custom columns
+ * exportToCSV(data, {
+ *   columns: ['id', 'name', 'value'],
+ *   headers: { id: 'ID', name: 'Name', value: 'Value' }
+ * });
+ * ```
+ */
+declare function exportToCSV(data: ExportData, options?: ExportOptions): void;
+
+/**
+ * Excel export functionality.
+ *
+ * Uses the xlsx library (SheetJS) for Excel file generation.
+ */
+
+/**
+ * Export data to Excel and trigger download.
+ *
+ * @param data - QueryResult or array of objects
+ * @param options - Export options
+ *
+ * @example
+ * ```tsx
+ * // Basic export
+ * exportToExcel(queryResult, { filename: 'sales-report' });
+ *
+ * // With styling
+ * exportToExcel(data, {
+ *   filename: 'report',
+ *   sheetName: 'Sales Data',
+ *   freezeHeader: true,
+ *   headerStyle: { bold: true, fill: '#e3f2fd', align: 'center' }
+ * });
+ * ```
+ */
+declare function exportToExcel(data: ExportData, options?: ExcelExportOptions): void;
+/**
+ * Export multiple sheets to a single Excel file.
+ *
+ * @param sheets - Object mapping sheet names to data
+ * @param filename - Output filename
+ *
+ * @example
+ * ```tsx
+ * exportMultipleSheets({
+ *   'Sales': salesData,
+ *   'Customers': customerData,
+ *   'Products': productData,
+ * }, 'full-report');
+ * ```
+ */
+declare function exportMultipleSheets(sheets: Record<string, ExportData>, filename: string): void;
+
+/**
+ * Options for the useExport hook.
+ */
+interface UseExportOptions {
+    /** Data to export */
+    data: QueryResult | null;
+    /** Default filename for exports */
+    filename?: string;
+    /** Columns to export (defaults to all) */
+    columns?: string[];
+    /** Custom column headers */
+    headers?: Record<string, string>;
+}
+/**
+ * Result of the useExport hook.
+ */
+interface UseExportResult {
+    /** Export to CSV file */
+    exportCSV: () => void;
+    /** Export to Excel file */
+    exportExcel: (options?: ExcelExportOptions) => void;
+    /** Whether an export is in progress */
+    isExporting: boolean;
+    /** Whether export is possible (data is available) */
+    canExport: boolean;
+}
+/**
+ * Hook for exporting query data to CSV or Excel.
+ *
+ * @param options - Export options
+ * @returns Export functions and state
+ *
+ * @example
+ * ```tsx
+ * function DataTable({ data }) {
+ *   const { exportCSV, exportExcel, canExport, isExporting } = useExport({
+ *     data,
+ *     filename: 'sales-report',
+ *     columns: ['id', 'name', 'amount'],
+ *     headers: { id: 'ID', name: 'Name', amount: 'Amount' }
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={exportCSV} disabled={!canExport || isExporting}>
+ *         Export CSV
+ *       </button>
+ *       <button onClick={() => exportExcel()} disabled={!canExport || isExporting}>
+ *         Export Excel
+ *       </button>
+ *       {isExporting && <span>Exporting...</span>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useExport(options: UseExportOptions): UseExportResult;
+
+export { type ExcelCellStyle, type ExcelExportOptions, type ExportData, type ExportOptions, type UseExportOptions, type UseExportResult, downloadFile, exportMultipleSheets, exportToCSV, exportToExcel, generateCSV, useExport };

package/dist/export/index.d.ts

@@ -0,0 +1,197 @@
+import { Q as QueryResult } from '../types-WrCbOeAV.js';
+
+/**
+ * Types for export functionality.
+ */
+
+/**
+ * Options for CSV export.
+ */
+interface ExportOptions {
+    /** Custom filename (without extension) */
+    filename?: string;
+    /** Subset of columns to export (defaults to all) */
+    columns?: string[];
+    /** Custom column header names */
+    headers?: Record<string, string>;
+    /** Date format string (default: ISO) */
+    dateFormat?: string;
+    /** Number format options */
+    numberFormat?: Intl.NumberFormatOptions;
+}
+/**
+ * Options for Excel export.
+ */
+interface ExcelExportOptions extends ExportOptions {
+    /** Sheet name (default: "Sheet1") */
+    sheetName?: string;
+    /** Column width overrides */
+    columnWidths?: Record<string, number>;
+    /** Freeze the header row */
+    freezeHeader?: boolean;
+    /** Header cell style */
+    headerStyle?: ExcelCellStyle;
+    /** Data cell style */
+    dataStyle?: ExcelCellStyle;
+}
+/**
+ * Excel cell style options.
+ */
+interface ExcelCellStyle {
+    /** Bold text */
+    bold?: boolean;
+    /** Background color (hex) */
+    fill?: string;
+    /** Text alignment */
+    align?: 'left' | 'center' | 'right';
+}
+/**
+ * Data that can be exported (QueryResult or array of objects).
+ */
+type ExportData = QueryResult | Record<string, unknown>[];
+
+/**
+ * CSV export functionality.
+ */
+
+/**
+ * Generate CSV content from data.
+ *
+ * @param data - Array of row objects
+ * @param columns - Column names
+ * @param headers - Custom header names
+ * @param options - Export options
+ * @returns CSV string
+ */
+declare function generateCSV(data: Record<string, unknown>[], columns: string[], headers?: Record<string, string>, options?: ExportOptions): string;
+/**
+ * Trigger a file download in the browser.
+ *
+ * @param content - File content
+ * @param filename - File name with extension
+ * @param mimeType - MIME type
+ */
+declare function downloadFile(content: string, filename: string, mimeType: string): void;
+/**
+ * Export data to CSV and trigger download.
+ *
+ * @param data - QueryResult or array of objects
+ * @param options - Export options
+ *
+ * @example
+ * ```tsx
+ * // Export query result
+ * exportToCSV(queryResult, { filename: 'sales-report' });
+ *
+ * // Export with custom columns
+ * exportToCSV(data, {
+ *   columns: ['id', 'name', 'value'],
+ *   headers: { id: 'ID', name: 'Name', value: 'Value' }
+ * });
+ * ```
+ */
+declare function exportToCSV(data: ExportData, options?: ExportOptions): void;
+
+/**
+ * Excel export functionality.
+ *
+ * Uses the xlsx library (SheetJS) for Excel file generation.
+ */
+
+/**
+ * Export data to Excel and trigger download.
+ *
+ * @param data - QueryResult or array of objects
+ * @param options - Export options
+ *
+ * @example
+ * ```tsx
+ * // Basic export
+ * exportToExcel(queryResult, { filename: 'sales-report' });
+ *
+ * // With styling
+ * exportToExcel(data, {
+ *   filename: 'report',
+ *   sheetName: 'Sales Data',
+ *   freezeHeader: true,
+ *   headerStyle: { bold: true, fill: '#e3f2fd', align: 'center' }
+ * });
+ * ```
+ */
+declare function exportToExcel(data: ExportData, options?: ExcelExportOptions): void;
+/**
+ * Export multiple sheets to a single Excel file.
+ *
+ * @param sheets - Object mapping sheet names to data
+ * @param filename - Output filename
+ *
+ * @example
+ * ```tsx
+ * exportMultipleSheets({
+ *   'Sales': salesData,
+ *   'Customers': customerData,
+ *   'Products': productData,
+ * }, 'full-report');
+ * ```
+ */
+declare function exportMultipleSheets(sheets: Record<string, ExportData>, filename: string): void;
+
+/**
+ * Options for the useExport hook.
+ */
+interface UseExportOptions {
+    /** Data to export */
+    data: QueryResult | null;
+    /** Default filename for exports */
+    filename?: string;
+    /** Columns to export (defaults to all) */
+    columns?: string[];
+    /** Custom column headers */
+    headers?: Record<string, string>;
+}
+/**
+ * Result of the useExport hook.
+ */
+interface UseExportResult {
+    /** Export to CSV file */
+    exportCSV: () => void;
+    /** Export to Excel file */
+    exportExcel: (options?: ExcelExportOptions) => void;
+    /** Whether an export is in progress */
+    isExporting: boolean;
+    /** Whether export is possible (data is available) */
+    canExport: boolean;
+}
+/**
+ * Hook for exporting query data to CSV or Excel.
+ *
+ * @param options - Export options
+ * @returns Export functions and state
+ *
+ * @example
+ * ```tsx
+ * function DataTable({ data }) {
+ *   const { exportCSV, exportExcel, canExport, isExporting } = useExport({
+ *     data,
+ *     filename: 'sales-report',
+ *     columns: ['id', 'name', 'amount'],
+ *     headers: { id: 'ID', name: 'Name', amount: 'Amount' }
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={exportCSV} disabled={!canExport || isExporting}>
+ *         Export CSV
+ *       </button>
+ *       <button onClick={() => exportExcel()} disabled={!canExport || isExporting}>
+ *         Export Excel
+ *       </button>
+ *       {isExporting && <span>Exporting...</span>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useExport(options: UseExportOptions): UseExportResult;
+
+export { type ExcelCellStyle, type ExcelExportOptions, type ExportData, type ExportOptions, type UseExportOptions, type UseExportResult, downloadFile, exportMultipleSheets, exportToCSV, exportToExcel, generateCSV, useExport };

package/dist/export/index.js

@@ -0,0 +1,3 @@
+export { downloadFile, exportMultipleSheets, exportToCSV, exportToExcel, generateCSV, useExport } from '../chunk-WWTT2OJ5.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/export/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}