react-auto-smart-table 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,164 @@
+import React$1, { ReactNode } from 'react';
+
+type Dataset = Record<string, any>[];
+type ColumnType = 'string' | 'number' | 'boolean' | 'date' | 'email' | 'url' | 'currency' | 'percentage' | 'image';
+interface ColumnSchema {
+    key: string;
+    type: ColumnType;
+    nullable: boolean;
+    uniqueValues?: number;
+    min?: number;
+    max?: number;
+}
+type TableSchema = Record<string, ColumnSchema>;
+interface InsightWidget$1 {
+    title: string;
+    type: string;
+    data: any[];
+}
+
+interface SmartTablePlugin {
+    detect?: (columnKey: string, sample: any[]) => ColumnType | null;
+    render?: (value: any) => ReactNode;
+    insights?: (dataset: Dataset) => InsightWidget$1[];
+}
+
+/**
+ * Priority: 1 email 2 url 3 image 4 date 5 currency 6 percentage 7 number 8 boolean 9 string
+ */
+declare const detectValueType: (value: any) => ColumnType;
+
+/**
+ * Samples up to maxSampleSize rows from the dataset without scanning the whole array
+ * sampleSize = min(200, dataset.length)
+ */
+declare function sampleDataset(dataset: Dataset, maxSampleSize?: number): Dataset;
+
+interface ColumnStats {
+    uniqueValues?: number;
+    min?: number;
+    max?: number;
+}
+declare const computeColumnStats: (columnKey: string, dataset: Dataset, type: ColumnType) => ColumnStats;
+
+declare class PluginRegistry {
+    private plugins;
+    register(pluginOrPlugins: SmartTablePlugin | SmartTablePlugin[]): void;
+    clear(): void;
+    runDetectors(columnKey: string, sample: any[]): ColumnType | null;
+    getRenderers(): Record<string, React.FC<{
+        value: any;
+    }>>;
+    getPlugins(): SmartTablePlugin[];
+}
+declare const globalPluginRegistry: PluginRegistry;
+
+declare const buildSchema: (dataset: Dataset, registry?: PluginRegistry) => TableSchema;
+
+type SortDirection = 'asc' | 'desc';
+interface UseSortingResult {
+    sortedData: Dataset;
+    sortColumn: string | null;
+    sortDirection: SortDirection;
+    handleSort: (columnKey: string) => void;
+}
+declare const useSorting: (data: Dataset, schema: TableSchema, initialSortColumn?: string | null, initialSortDirection?: SortDirection) => UseSortingResult;
+
+type FilterStateValue = string | {
+    min?: number;
+    max?: number;
+} | {
+    start?: string;
+    end?: string;
+} | boolean | null;
+interface FilterState {
+    [key: string]: FilterStateValue;
+}
+interface UseFiltersResult {
+    filteredData: Dataset;
+    filters: FilterState;
+    setFilter: (columnKey: string, value: FilterStateValue) => void;
+    clearFilters: () => void;
+}
+declare const useFilters: (data: Dataset, schema: TableSchema) => UseFiltersResult;
+
+interface UsePaginationResult {
+    paginatedData: Dataset;
+    currentPage: number;
+    pageSize: number;
+    totalPages: number;
+    setPage: (page: number) => void;
+    setPageSize: (size: number) => void;
+}
+declare const usePagination: (data: Dataset, initialPageSize?: number) => UsePaginationResult;
+
+interface AggregatedDataPoint {
+    [key: string]: any;
+}
+/**
+ * Groups dataset by a specific dimension and sums the metrics
+ */
+declare const aggregateData: (dataset: Dataset, dimension: string, metrics: string[]) => AggregatedDataPoint[];
+/**
+ * Groups dataset by a dimension and simply counts occurrences
+ * (useful when there are no metrics)
+ */
+declare const aggregateDataByCount: (dataset: Dataset, dimension: string) => AggregatedDataPoint[];
+
+type FieldRole = 'dimension' | 'metric' | 'discard';
+interface ChartDetectionResult {
+    dimensions: string[];
+    metrics: string[];
+}
+/**
+ * Analyzes the schema to categorize fields into dimensions (x-axis/groups) and metrics (y-axis/values)
+ */
+declare const detectChartFields: (schema: TableSchema) => ChartDetectionResult;
+
+type ChartType = 'bar' | 'pie' | 'line';
+interface InsightWidget {
+    id: string;
+    title: string;
+    type: ChartType;
+    data: AggregatedDataPoint[];
+    xAxisKey: string;
+    yAxisKeys: string[];
+}
+/**
+ * Generates an array of insightful charts based on the dataset and its schema.
+ */
+declare const generateInsights: (dataset: Dataset, schema: TableSchema) => InsightWidget[];
+
+interface SmartTableProps {
+    data: Dataset;
+    sortable?: boolean;
+    filterable?: boolean;
+    pagination?: boolean;
+    insights?: boolean;
+    plugins?: SmartTablePlugin[];
+}
+declare const SmartTable: React$1.FC<SmartTableProps>;
+
+interface FilterPanelProps {
+    schema: TableSchema;
+    filters: FilterState;
+    onFilterChange: (columnKey: string, value: FilterStateValue) => void;
+    onClear: () => void;
+}
+declare const FilterPanel: React$1.FC<FilterPanelProps>;
+
+interface InsightsPanelProps {
+    data: Dataset;
+    schema: TableSchema;
+}
+declare const InsightsPanel: React$1.FC<InsightsPanelProps>;
+
+declare const getCellRenderer: (type: ColumnType | string, registry?: PluginRegistry) => React$1.FC<{
+    value: any;
+}>;
+
+declare const currencyPlugin: SmartTablePlugin;
+
+declare const percentagePlugin: SmartTablePlugin;
+
+export { type AggregatedDataPoint, type ChartDetectionResult, type ChartType, type ColumnSchema, type ColumnType, type Dataset, type FieldRole, FilterPanel, type FilterPanelProps, type FilterState, type FilterStateValue, type InsightWidget$1 as InsightWidget, InsightsPanel, type InsightsPanelProps, PluginRegistry, SmartTable, type SmartTablePlugin, type SmartTableProps, type SortDirection, type TableSchema, type UseFiltersResult, type UsePaginationResult, type UseSortingResult, aggregateData, aggregateDataByCount, buildSchema, computeColumnStats, currencyPlugin, detectChartFields, detectValueType, generateInsights, getCellRenderer, globalPluginRegistry, percentagePlugin, sampleDataset, useFilters, usePagination, useSorting };

package/dist/index.d.ts

@@ -0,0 +1,164 @@
+import React$1, { ReactNode } from 'react';
+
+type Dataset = Record<string, any>[];
+type ColumnType = 'string' | 'number' | 'boolean' | 'date' | 'email' | 'url' | 'currency' | 'percentage' | 'image';
+interface ColumnSchema {
+    key: string;
+    type: ColumnType;
+    nullable: boolean;
+    uniqueValues?: number;
+    min?: number;
+    max?: number;
+}
+type TableSchema = Record<string, ColumnSchema>;
+interface InsightWidget$1 {
+    title: string;
+    type: string;
+    data: any[];
+}
+
+interface SmartTablePlugin {
+    detect?: (columnKey: string, sample: any[]) => ColumnType | null;
+    render?: (value: any) => ReactNode;
+    insights?: (dataset: Dataset) => InsightWidget$1[];
+}
+
+/**
+ * Priority: 1 email 2 url 3 image 4 date 5 currency 6 percentage 7 number 8 boolean 9 string
+ */
+declare const detectValueType: (value: any) => ColumnType;
+
+/**
+ * Samples up to maxSampleSize rows from the dataset without scanning the whole array
+ * sampleSize = min(200, dataset.length)
+ */
+declare function sampleDataset(dataset: Dataset, maxSampleSize?: number): Dataset;
+
+interface ColumnStats {
+    uniqueValues?: number;
+    min?: number;
+    max?: number;
+}
+declare const computeColumnStats: (columnKey: string, dataset: Dataset, type: ColumnType) => ColumnStats;
+
+declare class PluginRegistry {
+    private plugins;
+    register(pluginOrPlugins: SmartTablePlugin | SmartTablePlugin[]): void;
+    clear(): void;
+    runDetectors(columnKey: string, sample: any[]): ColumnType | null;
+    getRenderers(): Record<string, React.FC<{
+        value: any;
+    }>>;
+    getPlugins(): SmartTablePlugin[];
+}
+declare const globalPluginRegistry: PluginRegistry;
+
+declare const buildSchema: (dataset: Dataset, registry?: PluginRegistry) => TableSchema;
+
+type SortDirection = 'asc' | 'desc';
+interface UseSortingResult {
+    sortedData: Dataset;
+    sortColumn: string | null;
+    sortDirection: SortDirection;
+    handleSort: (columnKey: string) => void;
+}
+declare const useSorting: (data: Dataset, schema: TableSchema, initialSortColumn?: string | null, initialSortDirection?: SortDirection) => UseSortingResult;
+
+type FilterStateValue = string | {
+    min?: number;
+    max?: number;
+} | {
+    start?: string;
+    end?: string;
+} | boolean | null;
+interface FilterState {
+    [key: string]: FilterStateValue;
+}
+interface UseFiltersResult {
+    filteredData: Dataset;
+    filters: FilterState;
+    setFilter: (columnKey: string, value: FilterStateValue) => void;
+    clearFilters: () => void;
+}
+declare const useFilters: (data: Dataset, schema: TableSchema) => UseFiltersResult;
+
+interface UsePaginationResult {
+    paginatedData: Dataset;
+    currentPage: number;
+    pageSize: number;
+    totalPages: number;
+    setPage: (page: number) => void;
+    setPageSize: (size: number) => void;
+}
+declare const usePagination: (data: Dataset, initialPageSize?: number) => UsePaginationResult;
+
+interface AggregatedDataPoint {
+    [key: string]: any;
+}
+/**
+ * Groups dataset by a specific dimension and sums the metrics
+ */
+declare const aggregateData: (dataset: Dataset, dimension: string, metrics: string[]) => AggregatedDataPoint[];
+/**
+ * Groups dataset by a dimension and simply counts occurrences
+ * (useful when there are no metrics)
+ */
+declare const aggregateDataByCount: (dataset: Dataset, dimension: string) => AggregatedDataPoint[];
+
+type FieldRole = 'dimension' | 'metric' | 'discard';
+interface ChartDetectionResult {
+    dimensions: string[];
+    metrics: string[];
+}
+/**
+ * Analyzes the schema to categorize fields into dimensions (x-axis/groups) and metrics (y-axis/values)
+ */
+declare const detectChartFields: (schema: TableSchema) => ChartDetectionResult;
+
+type ChartType = 'bar' | 'pie' | 'line';
+interface InsightWidget {
+    id: string;
+    title: string;
+    type: ChartType;
+    data: AggregatedDataPoint[];
+    xAxisKey: string;
+    yAxisKeys: string[];
+}
+/**
+ * Generates an array of insightful charts based on the dataset and its schema.
+ */
+declare const generateInsights: (dataset: Dataset, schema: TableSchema) => InsightWidget[];
+
+interface SmartTableProps {
+    data: Dataset;
+    sortable?: boolean;
+    filterable?: boolean;
+    pagination?: boolean;
+    insights?: boolean;
+    plugins?: SmartTablePlugin[];
+}
+declare const SmartTable: React$1.FC<SmartTableProps>;
+
+interface FilterPanelProps {
+    schema: TableSchema;
+    filters: FilterState;
+    onFilterChange: (columnKey: string, value: FilterStateValue) => void;
+    onClear: () => void;
+}
+declare const FilterPanel: React$1.FC<FilterPanelProps>;
+
+interface InsightsPanelProps {
+    data: Dataset;
+    schema: TableSchema;
+}
+declare const InsightsPanel: React$1.FC<InsightsPanelProps>;
+
+declare const getCellRenderer: (type: ColumnType | string, registry?: PluginRegistry) => React$1.FC<{
+    value: any;
+}>;
+
+declare const currencyPlugin: SmartTablePlugin;
+
+declare const percentagePlugin: SmartTablePlugin;
+
+export { type AggregatedDataPoint, type ChartDetectionResult, type ChartType, type ColumnSchema, type ColumnType, type Dataset, type FieldRole, FilterPanel, type FilterPanelProps, type FilterState, type FilterStateValue, type InsightWidget$1 as InsightWidget, InsightsPanel, type InsightsPanelProps, PluginRegistry, SmartTable, type SmartTablePlugin, type SmartTableProps, type SortDirection, type TableSchema, type UseFiltersResult, type UsePaginationResult, type UseSortingResult, aggregateData, aggregateDataByCount, buildSchema, computeColumnStats, currencyPlugin, detectChartFields, detectValueType, generateInsights, getCellRenderer, globalPluginRegistry, percentagePlugin, sampleDataset, useFilters, usePagination, useSorting };