exploreda 0.0.5 → 0.1.0

package/dist/ExplorEda.d.cts

@@ -1,287 +1,83 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as THREE from 'three';
+import { d as datum, C as ChartSettings, T as ThreeDScatterSettings, F as Filter } from './dataLayerState-B4XmQjQN.cjs';
+import 'three';
 
-interface FilterBase {
-    type: string;
-    field: string;
-}
-interface ValueFilter extends FilterBase {
-    type: "value";
-    values: Array<datum$1>;
-}
-interface RangeFilter extends FilterBase {
-    type: "range";
-    min?: number;
-    max?: number;
-}
-interface TextFilter extends FilterBase {
-    type: "text";
-    operator: "contains" | "equals" | "startsWith" | "endsWith";
-    value: string;
-}
-type Filter = ValueFilter | RangeFilter | TextFilter;
-type datum$1 = string | number | boolean | undefined;
+type DataType = "numeric" | "categorical" | "datetime" | "boolean";
 
-interface BarChartSettings extends BaseChartSettings {
-    type: "bar";
-    binCount?: number;
-    forceString?: boolean;
-    filters: Filter[];
-}
-
-interface DataTableSettings extends BaseChartSettings {
-    type: "data-table";
-    columns: Array<{
-        id: string;
-        field: string;
-        width?: number;
-    }>;
-    pageSize: number;
-    currentPage: number;
-    sortBy?: string;
-    sortDirection: "asc" | "desc";
-    filters: Filter[];
-    globalSearch: string;
-    tableHeight: number;
-}
-
-interface MarkdownSettings extends BaseChartSettings {
-    type: "markdown";
-    content: string;
-}
-
-interface PivotTableSettings extends BaseChartSettings {
-    type: "pivot";
-    rowFields: string[];
-    columnField: string;
-    valueFields: Array<{
-        field: string;
-        aggregation: "sum" | "count" | "avg" | "min" | "max" | "median" | "mode" | "stddev" | "variance" | "countUnique" | "singleValue";
-        formula?: string;
-        label?: string;
-    }>;
-    showTotals: {
-        row: boolean;
-        column: boolean;
-        grand: boolean;
-    };
-    dateBinning?: {
-        field: string;
-        type: "day" | "month" | "year";
-    };
-}
-
-interface ScatterPlotSettings extends BaseChartSettings {
-    type: "scatter";
-    xField: string;
-    yField: string;
-    filters: Filter[];
-}
-
-interface SummaryTableSettings extends BaseChartSettings {
-    type: "summary";
-}
-
-interface ThreeDScatterSettings extends BaseChartSettings {
-    type: "3d-scatter";
-    xField: string;
-    yField: string;
-    zField: string;
-    colorField: string | undefined;
-    sizeField?: string;
-    cameraPosition: THREE.Vector3;
-    cameraTarget: THREE.Vector3;
-    pointSize: number;
-    pointOpacity: number;
-    showGrid: boolean;
-    showAxes: boolean;
-    xAxis: AxisSettings & {
-        zoomLevel: number;
-    };
-    yAxis: AxisSettings & {
-        zoomLevel: number;
-    };
-    zAxis: AxisSettings & {
-        zoomLevel: number;
-    };
-}
-
-interface BoxPlotStyleSettings {
-    boxFill: string;
-    boxStroke: string;
-    boxStrokeWidth: number;
-    medianStroke: string;
-    medianStrokeWidth: number;
-    whiskerStroke: string;
-    whiskerStrokeWidth: number;
-    outlierSize: number;
-    outlierStroke: string;
-    outlierFill: string;
-}
-interface BoxPlotSettings extends BaseChartSettings {
-    type: "boxplot";
-    whiskerType: "tukey" | "minmax" | "stdDev";
-    showOutliers: boolean;
-    violinOverlay: boolean;
-    beeSwarmOverlay: boolean;
-    styles: BoxPlotStyleSettings;
-    filters: Filter[];
-    sortBy: "median" | "label";
-    violinBandwidth: number;
-    autoBandwidth: boolean;
-}
-
-interface SeriesSettings {
-    showPoints: boolean;
-    pointSize: number;
-    pointOpacity: number;
-    lineWidth: number;
-    lineOpacity: number;
-    lineColor?: string;
-    lineStyle: "solid" | "dashed" | "dotted";
-    useRightAxis: boolean;
-}
-interface LineChartSettings extends BaseChartSettings {
-    type: "line";
-    xField: string;
-    seriesField: string[];
-    seriesSettings: Record<string, SeriesSettings>;
-    styles: {
-        curveType: "linear" | "monotoneX" | "step";
-    };
-    showXGrid: boolean;
-    showYGrid: boolean;
-    showLegend: boolean;
-    legendPosition: "top" | "right" | "bottom" | "left";
-}
-
-interface ChartLayout {
-    x: number;
-    y: number;
-    w: number;
-    h: number;
-}
-interface BaseFacetSettings {
-    enabled: boolean;
-    type: "grid" | "wrap";
-}
-interface GridFacetSettings extends BaseFacetSettings {
-    type: "grid";
-    rowVariable: string;
-    columnVariable: string;
-}
-interface WrapFacetSettings extends BaseFacetSettings {
-    type: "wrap";
-    rowVariable: string;
-    columnCount: number;
-}
-type FacetSettings = GridFacetSettings | WrapFacetSettings;
-interface AxisSettings {
-    title?: string;
-    scaleType?: "linear" | "log" | "time" | "band";
-    grid?: boolean;
-    min?: number;
-    max?: number;
-}
-interface MarginSettings {
-    top?: number;
-    right?: number;
-    bottom?: number;
-    left?: number;
-}
-interface BaseChartSettings {
-    id: string;
-    title: string;
-    type: string;
-    field: string;
-    layout: ChartLayout;
-    colorScaleId: string | undefined;
-    colorField: string | undefined;
-    facet: FacetSettings;
-    xAxis: AxisSettings;
-    yAxis: AxisSettings;
-    margin: MarginSettings;
-    filters: Filter[];
-    xAxisLabel: string;
-    yAxisLabel: string;
-    xGridLines: number;
-    yGridLines: number;
-}
-interface RowChartSettings extends BaseChartSettings {
-    type: "row";
-    minRowHeight: number;
-    maxRowHeight: number;
-}
-type ChartSettings = RowChartSettings | BarChartSettings | ScatterPlotSettings | PivotTableSettings | ThreeDScatterSettings | SummaryTableSettings | DataTableSettings | MarkdownSettings | BoxPlotSettings | LineChartSettings;
-type datum = string | number | boolean | undefined;
-
-type AggregationType = "sum" | "count" | "min" | "max" | "average" | "countUnique" | "percentile" | "median" | "stddev" | "variance";
-interface BaseExpression {
+type AggregateAggregation = "count" | "sum" | "average";
+interface AggregateSpec {
     id: string;
     name: string;
-    expression: string;
-    dependencies: string[];
-    rawInput: string;
-}
-interface BasicExpression extends BaseExpression {
-    type: "basic";
-    left: Expression;
-    right: Expression;
-    operator: string;
-}
-interface FunctionExpression extends BaseExpression {
-    type: "function";
-    functionName: string;
-    arguments: Expression[];
-    functionCategory?: string;
-    returnType?: string;
-    parameterTypes?: string[];
-}
-interface GroupExpression extends BaseExpression {
-    type: "group";
-    groupBy: string[];
-    aggregation: AggregationType;
-}
-interface RankExpression extends BaseExpression {
-    type: "rank";
-    rankBy: string[];
-    isNormalized: boolean;
-    isCumulative: boolean;
-}
-interface AdvancedExpression extends BaseExpression {
-    type: "advanced";
-    algorithm: "pca" | "tsne" | "umap" | "som";
-    parameters?: Record<string, any>;
-    regressionType?: "linear" | "polynomial";
-    degree?: number;
-    predictors?: string[];
-    response?: string;
-}
-interface TernaryExpression extends BaseExpression {
-    type: "ternary";
-    condition: Expression;
-    trueBranch: Expression;
-    falseBranch: Expression;
-}
-interface UnaryExpression extends BaseExpression {
-    type: "unary";
-    operand: Expression;
-    operator: string;
-}
-interface LiteralExpression extends BaseExpression {
-    type: "literal";
-    value: any;
-}
-type Expression = BasicExpression | FunctionExpression | GroupExpression | RankExpression | AdvancedExpression | TernaryExpression | UnaryExpression | LiteralExpression;
-
-interface CalculationDefinition {
-    expression: Expression;
-    resultColumnName: string;
+    groupField: string;
+    measureField?: string;
+    aggregation: AggregateAggregation;
+}
+interface AggregateContributor {
+    sourceId: number;
+    input: datum;
+    rawInput?: datum;
+    included: boolean;
+    exclusionReason?: string;
+}
+interface AggregateResultRow {
+    id: string;
+    groupValue: datum;
+    groupLabel: string;
+    value: number | undefined;
+    rowCount: number;
+    contributors: AggregateContributor[];
+}
+interface AggregateResult {
+    spec: AggregateSpec;
+    rows: AggregateResultRow[];
+    sourceRowCount: number;
+}
+
+type DatePreset = "iso" | "month-day-year" | "day-month-year";
+type FieldFormat = "auto" | "number" | "currency" | "percent" | "date" | "datetime";
+interface FieldSettings {
+    type?: DataType;
+    label?: string;
+    description?: string;
+    format?: FieldFormat;
+    precision?: number;
+    unit?: string;
+    currency?: string;
+    datePreset?: DatePreset;
+    nullTokens?: string[];
+}
+type FieldSettingsMap = Record<string, FieldSettings>;
+interface ConversionFailure {
+    row: number;
+    raw: datum;
+    reason: string;
+}
+interface ConversionPreview {
+    field: string;
+    inferredType: DataType;
+    effectiveType: DataType;
+    totalCount: number;
+    validCount: number;
+    missingCount: number;
+    failedCount: number;
+    examples: Array<{
+        row: number;
+        raw: datum;
+        value: datum;
+    }>;
+    failures: ConversionFailure[];
 }
+/** Return the validation error shown before settings are saved. */
+declare function getFieldSettingsError(settings: FieldSettings): string | undefined;
+declare function getFieldLabel(field: string, settings?: FieldSettings): string;
+declare function hasFieldDisplayFormat(settings?: FieldSettings): boolean;
+declare function formatFieldValue(field: string, value: datum, settings?: FieldSettings): string;
 
 interface BaseColorScale {
     id: string;
     name: string;
+    /** Source field used to create this scale. Display names may change. */
+    sourceField?: string;
 }
 interface NumericalColorScale extends BaseColorScale {
     type: "numerical";
@@ -295,6 +91,18 @@ interface CategoricalColorScale extends BaseColorScale {
     mapping: Map<string, string>;
 }
 
+interface SavedColumnSettings {
+    id: string;
+    field: string;
+    width?: number;
+}
+interface SavedRowsSettings {
+    columns: SavedColumnSettings[];
+    sortBy?: string;
+    sortDirection: "asc" | "desc";
+    filters: Filter[];
+    globalSearch: string;
+}
 interface GridSettings {
     columnCount: number;
     rowHeight: number;
@@ -312,21 +120,60 @@ interface SerializedCategoricalColorScale extends Omit<CategoricalColorScale, "m
     mapping: [string, string][];
 }
 type SerializedColorScale = NumericalColorScale | SerializedCategoricalColorScale;
+interface SerializedVector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+type SerializedThreeDScatterSettings = Omit<ThreeDScatterSettings, "cameraPosition" | "cameraTarget"> & {
+    cameraPosition: SerializedVector3;
+    cameraTarget: SerializedVector3;
+};
+type SavedChartSettings = Exclude<ChartSettings, ThreeDScatterSettings> | SerializedThreeDScatterSettings;
+
+interface SavedCalculation {
+    resultColumnName: string;
+    expression: string;
+}
+type SavedDatum = string | number | boolean | null | undefined;
+type SavedRow = Record<string, SavedDatum>;
+type SavedSpecialValue = "undefined" | "NaN" | "Infinity" | "-Infinity";
 interface SavedDataStructure {
-    charts: ChartSettings[];
-    calculations: CalculationDefinition[];
+    charts: SavedChartSettings[];
+    calculations: SavedCalculation[];
     gridSettings: GridSettings;
     metadata: ViewMetadata;
     colorScales: SerializedColorScale[];
+    rowsSettings?: SavedRowsSettings;
+    fieldSettings?: FieldSettingsMap;
+    aggregates?: AggregateSpec[];
+}
+interface SavedAnalysisStructure {
+    format: "exploreda-analysis";
+    version: 1;
+    data: SavedRow[];
+    settings: SavedDataStructure;
+    specialValues?: Record<string, SavedSpecialValue>;
 }
 
 type DatumObject = {
     [key: string]: datum;
 };
 
-declare function ExplorEda({ data, savedData, }: {
+declare function saveToClipboard(data: SavedDataStructure): Promise<void>;
+declare function stringifySavedData(data: SavedDataStructure): string;
+declare function parseSavedData(text: string): SavedDataStructure;
+declare function stringifySavedAnalysis(data: SavedAnalysisStructure): string;
+declare function parseSavedAnalysis(text: string): SavedAnalysisStructure;
+declare function saveAnalysisToClipboard(data: SavedAnalysisStructure): Promise<void>;
+declare function validateSavedData(data: unknown): data is SavedDataStructure;
+declare function validateSavedAnalysis(data: unknown): data is SavedAnalysisStructure;
+declare function validateSavedAnalysisForData(analysis: SavedAnalysisStructure): boolean;
+
+declare function ExplorEda({ data, savedData, onStateChange, }: {
     data: DatumObject[];
     savedData: SavedDataStructure | undefined;
+    onStateChange?: (state: SavedDataStructure) => void;
 }): react_jsx_runtime.JSX.Element;
 
-export { ExplorEda };
+export { type AggregateResult, type AggregateSpec, type ConversionPreview, type DatePreset, ExplorEda, type FieldFormat, type FieldSettings, type FieldSettingsMap, type SavedAnalysisStructure, type SavedCalculation, type SavedColumnSettings, type SavedDataStructure, type SavedDatum, type SavedRow, type SavedRowsSettings, type SavedSpecialValue, type ViewMetadata, formatFieldValue, getFieldLabel, getFieldSettingsError, hasFieldDisplayFormat, parseSavedAnalysis, parseSavedData, saveAnalysisToClipboard, saveToClipboard, stringifySavedAnalysis, stringifySavedData, validateSavedAnalysis, validateSavedAnalysisForData, validateSavedData };