@sukritt/pivot 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,101 @@
+import { Aggregator } from '@sukritt/pivot-core';
+import { BuiltInAggregator } from '@sukritt/pivot-core';
+import { computePivot } from '@sukritt/pivot-core';
+import { CSSProperties } from 'react';
+import { CustomAggregator } from '@sukritt/pivot-core';
+import { FilterCondition } from '@sukritt/pivot-core';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PivotCell } from '@sukritt/pivot-core';
+import { PivotConfig } from '@sukritt/pivot-core';
+import { PivotField } from '@sukritt/pivot-core';
+import { PivotHeaderNode } from '@sukritt/pivot-core';
+import { PivotResult } from '@sukritt/pivot-core';
+import { ValueFieldConfig } from '@sukritt/pivot-core';
+
+export { Aggregator }
+
+export { BuiltInAggregator }
+
+export { computePivot }
+
+export { CustomAggregator }
+
+export declare function exportPivotToCsv(result: PivotResult, fileName?: string): void;
+
+export declare function exportPivotToExcel(result: PivotResult, fileName?: string): void;
+
+export declare function FieldConfigPanel<TData extends Record<string, unknown>>({ data, fields, config, onConfigChange, }: FieldConfigPanelProps<TData>): JSX_2.Element;
+
+declare interface FieldConfigPanelProps<TData> {
+    data: TData[];
+    fields: PivotField[];
+    config: PivotConfig<TData>;
+    onConfigChange: (next: PivotConfig<TData>) => void;
+}
+
+export { FilterCondition }
+
+export { PivotCell }
+
+export { PivotConfig }
+
+export { PivotField }
+
+export declare function PivotGrid({ result }: PivotGridProps): JSX_2.Element;
+
+declare interface PivotGridProps {
+    result: PivotResult;
+}
+
+export { PivotHeaderNode }
+
+export { PivotResult }
+
+export declare const PivotTable: <TData extends Record<string, unknown> = Record<string, unknown>>(props: PivotTableProps<TData> & {
+    ref?: React.Ref<PivotTableRef>;
+}) => ReturnType<typeof PivotTableInner>;
+
+declare function PivotTableInner<TData extends Record<string, unknown>>(props: PivotTableProps<TData>, ref: React.Ref<PivotTableRef>): JSX_2.Element;
+
+export declare interface PivotTableProps<TData extends Record<string, unknown> = Record<string, unknown>> {
+    data: TData[];
+    fields: PivotField[];
+    /** Initial config when uncontrolled */
+    defaultConfig?: Partial<PivotConfig<TData>>;
+    /** Controlled config — when set, component is fully controlled */
+    config?: PivotConfig<TData>;
+    onConfigChange?: (config: PivotConfig<TData>) => void;
+    customAggregators?: Record<string, CustomAggregator<TData>>;
+    /** Show the drag-and-drop sidebar */
+    enableFieldConfig?: boolean;
+    showRowTotals?: boolean;
+    showColumnTotals?: boolean;
+    showGrandTotal?: boolean;
+    height?: number | string;
+    className?: string;
+    style?: CSSProperties;
+    onPivotComputed?: (result: PivotResult<TData>) => void;
+}
+
+export declare interface PivotTableRef {
+    exportToCsv: (fileName?: string) => void;
+    exportToExcel: (fileName?: string) => void;
+    getConfig: () => PivotConfig;
+    getResult: () => PivotResult | null;
+    resetConfig: () => void;
+}
+
+/**
+ * Flatten a PivotResult into a 2D array suitable for XLSX.utils.aoa_to_sheet.
+ *
+ * Layout:
+ *   - Top header rows: column tree (one row per level), each leaf header label
+ *   - Last header row: value field name(s) per column leaf
+ *   - Body rows: row tree expanded with row headers + cells
+ *   - Optional totals rows
+ */
+export declare function pivotToAOA(result: PivotResult): unknown[][];
+
+export { ValueFieldConfig }
+
+export { }