h2o-library 2.2.0 → 2.2.1

package/dist/types/charts/src/waterfall/chart-waterfall.d.ts

@@ -12,7 +12,31 @@ export interface WaterfallFeature {
     value?: number | string;
     contribution: number;
 }
-export type ShapRecord = Record<string, number | string>;
+/** One feature entry inside a {@link ShapExplanation}. */
+export interface ShapFeature {
+    name: string;
+    prob: number;
+    value?: number | string;
+}
+/**
+ * The structured SHAP explanation object. Passed straight to
+ * {@link WaterfallChartProps.data} with no transform.
+ */
+export interface ShapExplanation {
+    recordId?: number;
+    losRecordId?: number;
+    probabilityDischargeNext2Days?: number;
+    /** f(x) — model output probability. */
+    fx: number;
+    /** E(f(x)) — baseline (expected) probability. */
+    efx: number;
+    /** Summed contribution of all features not individually listed. */
+    otherFactorsProb?: number;
+    /** Count of features grouped into otherFactors. */
+    otherFactorsValue?: number;
+    text?: string;
+    features: ShapFeature[];
+}
 export interface WaterfallColors {
     positive?: string;
     negative?: string;
@@ -25,16 +49,12 @@ export interface WaterfallBarDatum {
     contribution: number;
 }
 export interface WaterfallChartProps {
-    data: WaterfallFeature[] | ShapRecord;
-    baseValue?: number;
-    prediction?: number;
+    data: ShapExplanation;
     maxFeatures?: number;
     colors?: WaterfallColors;
     compact?: boolean;
     height?: number;
     className?: string;
-    probSuffix?: string;
-    valueSuffix?: string;
     onBarClick?: (datum: WaterfallBarDatum, index: number, event: React.MouseEvent<SVGElement>) => void;
 }
-export declare const WaterfallChart: ({ data, baseValue, prediction, maxFeatures, colors, compact, height, className, probSuffix, valueSuffix, onBarClick, }: WaterfallChartProps) => import("react/jsx-runtime").JSX.Element;
+export declare const WaterfallChart: ({ data, maxFeatures, colors, compact, height, className, onBarClick, }: WaterfallChartProps) => import("react/jsx-runtime").JSX.Element;

package/dist/utils/charts/src/chart/chart.d.ts

@@ -29,7 +29,7 @@ type BarChartSpecificProps = {
     layout?: "single" | "grouped" | "stacked" | "grouped-stacked";
     orientation?: "vertical" | "horizontal";
 };
-type WaterfallSpecificProps = Pick<WaterfallChartProps, "baseValue" | "prediction" | "maxFeatures" | "colors" | "compact" | "probSuffix" | "valueSuffix" | "onBarClick">;
+type WaterfallSpecificProps = Pick<WaterfallChartProps, "maxFeatures" | "colors" | "compact" | "onBarClick">;
 type ChartTypeSpecificProps<T extends ChartType> = T extends "bar" ? BarChartSpecificProps : T extends "waterfall" ? WaterfallSpecificProps : Record<string, never>;
 export type ChartProps<T extends ChartType> = BaseChartProps & {
     data: BaseChartData[T];

package/dist/utils/charts/src/waterfall/chart-waterfall.d.ts

@@ -12,7 +12,31 @@ export interface WaterfallFeature {
     value?: number | string;
     contribution: number;
 }
-export type ShapRecord = Record<string, number | string>;
+/** One feature entry inside a {@link ShapExplanation}. */
+export interface ShapFeature {
+    name: string;
+    prob: number;
+    value?: number | string;
+}
+/**
+ * The structured SHAP explanation object. Passed straight to
+ * {@link WaterfallChartProps.data} with no transform.
+ */
+export interface ShapExplanation {
+    recordId?: number;
+    losRecordId?: number;
+    probabilityDischargeNext2Days?: number;
+    /** f(x) — model output probability. */
+    fx: number;
+    /** E(f(x)) — baseline (expected) probability. */
+    efx: number;
+    /** Summed contribution of all features not individually listed. */
+    otherFactorsProb?: number;
+    /** Count of features grouped into otherFactors. */
+    otherFactorsValue?: number;
+    text?: string;
+    features: ShapFeature[];
+}
 export interface WaterfallColors {
     positive?: string;
     negative?: string;
@@ -25,16 +49,12 @@ export interface WaterfallBarDatum {
     contribution: number;
 }
 export interface WaterfallChartProps {
-    data: WaterfallFeature[] | ShapRecord;
-    baseValue?: number;
-    prediction?: number;
+    data: ShapExplanation;
     maxFeatures?: number;
     colors?: WaterfallColors;
     compact?: boolean;
     height?: number;
     className?: string;
-    probSuffix?: string;
-    valueSuffix?: string;
     onBarClick?: (datum: WaterfallBarDatum, index: number, event: React.MouseEvent<SVGElement>) => void;
 }
-export declare const WaterfallChart: ({ data, baseValue, prediction, maxFeatures, colors, compact, height, className, probSuffix, valueSuffix, onBarClick, }: WaterfallChartProps) => import("react/jsx-runtime").JSX.Element;
+export declare const WaterfallChart: ({ data, maxFeatures, colors, compact, height, className, onBarClick, }: WaterfallChartProps) => import("react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h2o-library",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "A set of components for H2O Apps development",
   "main": "dist/index.cjs.js",
   "module": "dist/esm/index.js",