@datarecce/ui 0.1.41 → 0.2.1-nightly.20260402

package/recce-source/js/src/lib/dataGrid/shared/gridUtils.ts

@@ -1,370 +0,0 @@
-/**
- * @file gridUtils.ts
- * @description Shared utilities for data grid generation
- *
- * This module contains common functions used across all grid generation methods.
- */
-
-import _ from "lodash";
-import {
-  ColumnRenderMode,
-  ColumnType,
-  DataFrame,
-  RowObjectType,
-} from "@/lib/api/types";
-import { mergeKeysWithStatus } from "@/lib/mergeKeys";
-import { formatNumber } from "@/utils/formatters";
-import { getCaseInsensitive } from "@/utils/transforms";
-
-// ============================================================================
-// Types
-// ============================================================================
-
-export interface ColumnMapEntry {
-  key: string;
-  colType: ColumnType;
-  status?: string;
-  index?: number;
-}
-
-export interface MergeColumnMapEntry extends ColumnMapEntry {
-  baseColumnKey: string;
-  currentColumnKey: string;
-}
-
-export interface RowStats {
-  added: number;
-  removed: number;
-  modified: number;
-}
-
-// ============================================================================
-// Column Map Builders
-// ============================================================================
-
-/**
- * Builds a column map from a single DataFrame
- */
-export function buildColumnMap(df: DataFrame): Record<string, ColumnMapEntry> {
-  const result: Record<string, ColumnMapEntry> = {};
-  df.columns.forEach((col, index) => {
-    result[col.name] = {
-      key: col.key,
-      index,
-      colType: col.type,
-    };
-  });
-  return result;
-}
-
-/**
- * Builds a column map for joined data (with in_a/in_b columns)
- *
- * NOTE: Backend now guarantees in_a/in_b are always lowercase,
- * so we only need to register them as-is.
- *
- * @throws {Error} If required in_a or in_b columns are missing
- */
-export function buildJoinedColumnMap(
-  df: DataFrame,
-): Record<string, ColumnMapEntry> {
-  const result: Record<string, ColumnMapEntry> = {};
-
-  df.columns.forEach((col, index) => {
-    result[col.key] = {
-      key: col.key,
-      index,
-      colType: col.type,
-    };
-  });
-
-  // Verify required columns exist (while backend guarantees "in_a" and "in_b" as lowercase, we need to verify their presence)
-  if (!result.in_a) {
-    throw new Error("Joined DataFrame missing required 'in_a' column");
-  }
-  if (!result.in_b) {
-    throw new Error("Joined DataFrame missing required 'in_b' column");
-  }
-
-  return result;
-}
-
-/**
- * Builds a merged column map from two DataFrames
- * Tracks status (added/removed/unchanged) for each column
- */
-export function buildMergedColumnMap(
-  base: DataFrame,
-  current: DataFrame,
-): Record<string, MergeColumnMapEntry> {
-  const result: Record<string, MergeColumnMapEntry> = {};
-
-  const mapStatus = mergeKeysWithStatus(
-    base.columns.map((col) => col.key),
-    current.columns.map((col) => col.key),
-  ) as Record<string, string>;
-
-  Object.entries(mapStatus).forEach(([key, status]) => {
-    const baseColumn = base.columns.find((c) => c.key === key);
-    const currentColumn = current.columns.find((c) => c.key === key);
-    result[key] = {
-      status,
-      baseColumnKey: baseColumn?.key ?? "unknown",
-      currentColumnKey: currentColumn?.key ?? "unknown",
-      colType: baseColumn?.type ?? currentColumn?.type ?? "unknown",
-      key: baseColumn?.key ?? currentColumn?.key ?? "unknown",
-    };
-  });
-
-  return result;
-}
-
-// ============================================================================
-// Primary Key Utilities
-// ============================================================================
-
-/**
- * Validates that all primary keys exist in the columns (exact matching)
- */
-export function validatePrimaryKeys(
-  columns: DataFrame["columns"],
-  primaryKeys: string[],
-): string[] {
-  const keys: string[] = [];
-  for (const key of primaryKeys) {
-    const found = columns.find((col) => col.key === key);
-
-    if (!found) {
-      throw new Error(`Column ${key} not found`);
-    }
-    keys.push(found.key);
-  }
-  return keys;
-}
-
-/**
- * Generates a unique key string from primary key values in a row (exact matching)
- */
-export function getPrimaryKeyValue(
-  columns: DataFrame["columns"],
-  primaryKeys: string[],
-  row: RowObjectType,
-): string {
-  if (primaryKeys.length === 0) {
-    return String(row._index);
-  }
-
-  const result: string[] = [];
-  for (const key of primaryKeys) {
-    const col = columns.find((c) => c.key === key);
-
-    if (!col) {
-      throw new Error(`Primary Column ${key} not found`);
-    }
-
-    const value = row[key];
-    result.push(`${col.name}=${value}`);
-  }
-  return result.join("|");
-}
-
-// ============================================================================
-// Row Status Detection
-// ============================================================================
-
-/**
- * Determines the status of a row (added/removed/modified/unchanged)
- *
- * Supports two modes:
- * 1. Separate rows: baseRow and currentRow are different objects
- * 2. Merged rows: baseRow === currentRow, with values stored as base__key and current__key
- */
-export function determineRowStatus(
-  baseRow: RowObjectType | undefined,
-  currentRow: RowObjectType | undefined,
-  columnMap: Record<string, ColumnMapEntry>,
-  primaryKeys: string[],
-): "added" | "removed" | "modified" | undefined {
-  if (!baseRow) return "added";
-  if (!currentRow) return "removed";
-
-  // Check if this is a merged row (same object passed for both)
-  const isMergedRow = baseRow === currentRow;
-
-  // Check for modifications in non-PK columns
-  for (const [name, column] of Object.entries(columnMap)) {
-    if (name === "index") continue;
-
-    if (primaryKeys.includes(name)) continue;
-
-    let baseVal: unknown;
-    let currentVal: unknown;
-
-    if (isMergedRow) {
-      // Merged row: compare base__key vs current__key
-      const baseKey = `base__${column.key}`;
-      const currentKey = `current__${column.key}`;
-      baseVal = baseRow[baseKey];
-      currentVal = currentRow[currentKey];
-    } else {
-      // Separate rows: compare same key in different row objects
-      baseVal = baseRow[column.key];
-      currentVal = currentRow[column.key];
-    }
-
-    if (!_.isEqual(baseVal, currentVal)) {
-      return "modified";
-    }
-  }
-
-  return undefined;
-}
-
-// ============================================================================
-// Value Rendering Utilities
-// ============================================================================
-
-/**
- * Formats a numeric value based on render mode
- *
- * Handles special values:
- * - NaN: Returns "NaN" (no formatting applied)
- * - Infinity: Returns "∞" or "-∞" (no formatting applied)
- */
-/**
- * Formats a number with up to maxDecimals decimal places, without trailing zeros
- * Uses banker's rounding (round half to even) for unbiased rounding.
- *
- * e.g., formatSmartDecimal(123, 2) => "123"
- *       formatSmartDecimal(123.4, 2) => "123.4"
- *       formatSmartDecimal(123.456, 2) => "123.46"
- *       formatSmartDecimal(123.445, 2) => "123.44" (banker's rounding)
- */
-export function formatSmartDecimal(value: number, maxDecimals = 2): string {
-  // Normalize -0 to 0 (Intl.NumberFormat renders -0 as "-0" per ECMA-402)
-  const normalizedValue = Object.is(value, -0) ? 0 : value;
-
-  const result =
-    formatNumber(normalizedValue, "en-US", {
-      maximumFractionDigits: maxDecimals,
-      roundingMode: "halfEven",
-    } as Intl.NumberFormatOptions) ?? String(value);
-
-  // Normalize "-0" to "0" (can happen when small negative numbers round to zero)
-  return result === "-0" ? "0" : result;
-}
-
-export function columnRenderedValue(
-  value: number,
-  renderMode?: ColumnRenderMode,
-): string {
-  // Handle special numeric values first
-  if (Number.isNaN(value)) {
-    return "NaN";
-  }
-
-  if (!Number.isFinite(value)) {
-    return value > 0 ? "∞" : "-∞";
-  }
-
-  const locale = "en-US";
-
-  if (renderMode === "raw") {
-    return String(value);
-  }
-
-  if (typeof renderMode === "number") {
-    // Smart formatting: up to N decimals, no trailing zeros
-    return formatSmartDecimal(value, renderMode);
-  }
-
-  if (renderMode === "percent") {
-    return (
-      formatNumber(value, locale, {
-        style: "percent",
-        maximumFractionDigits: 2,
-      }) ?? String(value)
-    );
-  }
-
-  // Default: smart 2-decimal formatting
-  return formatSmartDecimal(value, 2);
-}
-
-/**
- * Converts a row value to a rendered string with gray-out indicator
- */
-export function toRenderedValue(
-  row: RowObjectType,
-  key: string,
-  columnType?: ColumnType,
-  columnRenderMode?: ColumnRenderMode,
-): [string, boolean] {
-  const value = getCaseInsensitive(row, key);
-
-  if (value == null) {
-    return ["-", true];
-  }
-
-  let renderedValue: string;
-  let grayOut = false;
-
-  // noinspection SuspiciousTypeOfGuard
-  if (typeof value === "boolean") {
-    // workaround for https://github.com/adazzle/react-data-grid/issues/882
-    renderedValue = value.toString();
-  } else if (value === "") {
-    renderedValue = "(empty)";
-    grayOut = true;
-  } else if (typeof value === "number") {
-    renderedValue = columnRenderedValue(value, columnRenderMode);
-  } else {
-    if (columnType === "number") {
-      renderedValue = columnRenderedValue(parseFloat(value), columnRenderMode);
-    } else {
-      renderedValue = String(value);
-    }
-  }
-
-  return [renderedValue, grayOut];
-}
-
-// ============================================================================
-// Cell Class Utilities
-// ============================================================================
-
-/**
- * Gets the CSS class for a cell based on row and column status
- */
-export function getCellClass(
-  row: RowObjectType,
-  columnStatus: string | undefined,
-  columnKey: string,
-  isBase: boolean,
-): string | undefined {
-  const rowStatus = row.__status;
-
-  if (rowStatus === "removed") return "diff-cell-removed";
-  if (rowStatus === "added") return "diff-cell-added";
-  if (columnStatus === "added" || columnStatus === "removed") return undefined;
-
-  const baseKey = `base__${columnKey}`.toLowerCase();
-  const currentKey = `current__${columnKey}`.toLowerCase();
-
-  if (!_.isEqual(row[baseKey], row[currentKey])) {
-    return isBase ? "diff-cell-removed" : "diff-cell-added";
-  }
-
-  return undefined;
-}
-
-/**
- * Gets the CSS class for a header cell based on column status
- */
-export function getHeaderCellClass(
-  columnStatus: string | undefined,
-): string | undefined {
-  if (columnStatus === "added") return "diff-header-added";
-  if (columnStatus === "removed") return "diff-header-removed";
-  return undefined;
-}

package/recce-source/js/src/lib/dataGrid/shared/index.ts

@@ -1,81 +0,0 @@
-/**
- * @file shared/index.ts
- * @description Exports for shared data grid utilities
- */
-
-// Column builders
-export {
-  // Functions
-  buildColumnOrder,
-  // Types
-  type ColumnConfig,
-  type ColumnOrderConfig,
-  type GridColumnsConfig,
-  getDisplayColumns,
-  getSimpleDisplayColumns,
-  isExcludedColumn,
-  isPinnedColumn,
-  isPrimaryKeyColumn,
-  shouldIncludeColumn,
-} from "./columnBuilders";
-// Diff column definitions (high-level, with JSX)
-export {
-  type BuildDiffColumnDefinitionsConfig,
-  type BuildDiffColumnDefinitionsResult,
-  buildDiffColumnDefinitions,
-  type DiffColumnDefinition,
-} from "./diffColumnBuilder";
-// Grid utilities
-export {
-  // Column map builders
-  buildColumnMap,
-  buildJoinedColumnMap,
-  buildMergedColumnMap,
-  // Types
-  type ColumnMapEntry,
-  // Value rendering
-  columnRenderedValue,
-  // Row status
-  determineRowStatus,
-  formatSmartDecimal,
-  // Cell class utilities
-  getCellClass,
-  getHeaderCellClass,
-  getPrimaryKeyValue,
-  // Types
-  type MergeColumnMapEntry,
-  type RowStats,
-  toRenderedValue,
-  // Primary key utilities
-  validatePrimaryKeys,
-} from "./gridUtils";
-export {
-  type BuildDiffRowsConfig,
-  type BuildDiffRowsResult,
-  buildDiffRows,
-  type DiffColumnMapEntry,
-} from "./rowBuilders";
-export {
-  type BuildSimpleColumnDefinitionsConfig,
-  type BuildSimpleColumnDefinitionsResult,
-  buildSimpleColumnDefinitions,
-  type SimpleColumnDefinition,
-} from "./simpleColumnBuilder";
-// Diff column builder (low-level)
-export {
-  createCellClassBase,
-  createCellClassCurrent,
-  type DiffColumnConfig,
-  type DiffColumnResult,
-  toDiffColumn,
-} from "./toDiffColumn";
-export {
-  DataGridValidationError,
-  validateColumnDataAlignment,
-  validateColumns,
-  validateDataFrame,
-  validatePrimaryKeyConfig,
-  validateToDataDiffGridInputs,
-  validateToDataGridInputs,
-  validateToValueDiffGridInputs,
-} from "./validation";