@svgrid/grid 2.7.0 → 3.0.1

package/src/subscribe.ts

@@ -1,38 +1,38 @@
-import type { RowData, SvGrid, TableFeatures } from './core'
-
-const shallowCompare = (a: unknown, b: unknown) => {
-  if (Object.is(a, b)) return true
-  if (!a || !b || typeof a !== 'object' || typeof b !== 'object') return false
-  const aObj = a as Record<string, unknown>
-  const bObj = b as Record<string, unknown>
-  const aKeys = Object.keys(aObj)
-  const bKeys = Object.keys(bObj)
-  if (aKeys.length !== bKeys.length) return false
-  return aKeys.every((key) => Object.is(aObj[key], bObj[key]))
-}
-
-/**
- * Fine-grained subscription to `table.store` using `useSelector` with shallow
- * comparison. Call from `<script>` so the selector is contextually typed.
- */
-export function subscribeGrid<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-  TSelected,
->(
-  grid: SvGrid<TData>,
-  selector: (state: Record<string, any>) => TSelected,
-) {
-  let current = selector(grid.store.state)
-  grid.store.subscribe(() => {
-    const next = selector(grid.store.state)
-    if (!shallowCompare(current, next)) current = next
-  })
-  return {
-    get current() {
-      return current
-    },
-  }
-}
-
-export const subscribeSvGrid = subscribeGrid
+import type { RowData, SvGrid, TableFeatures } from './core'
+
+const shallowCompare = (a: unknown, b: unknown) => {
+  if (Object.is(a, b)) return true
+  if (!a || !b || typeof a !== 'object' || typeof b !== 'object') return false
+  const aObj = a as Record<string, unknown>
+  const bObj = b as Record<string, unknown>
+  const aKeys = Object.keys(aObj)
+  const bKeys = Object.keys(bObj)
+  if (aKeys.length !== bKeys.length) return false
+  return aKeys.every((key) => Object.is(aObj[key], bObj[key]))
+}
+
+/**
+ * Fine-grained subscription to `table.store` using `useSelector` with shallow
+ * comparison. Call from `<script>` so the selector is contextually typed.
+ */
+export function subscribeGrid<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TSelected,
+>(
+  grid: SvGrid<TData>,
+  selector: (state: Record<string, any>) => TSelected,
+) {
+  let current = selector(grid.store.state)
+  grid.store.subscribe(() => {
+    const next = selector(grid.store.state)
+    if (!shallowCompare(current, next)) current = next
+  })
+  return {
+    get current() {
+      return current
+    },
+  }
+}
+
+export const subscribeSvGrid = subscribeGrid

package/src/summaries.ts

@@ -1,113 +1,113 @@
-// summaries handlers extracted from the controller. Imperative event handlers
-// reading/writing controller state via the `ctx` handle; the reactive core
-// ($state/$derived/$effect) stays in the controller.
-import {
-  applyGroupAggregate,
-  type Column,
-  type Row,
-  type RowData,
-  type TableFeatures,
-} from "./index";
-import "./sv-grid-scrollbar";
-import {
-  getCellKey,
-} from "./SvGrid.helpers";
-import {
-  formatSummaryNumeric,
-} from "./cell-values";
-
-export function createSummaries<
-  TFeatures extends TableFeatures = TableFeatures,
-  TData extends RowData = RowData,
->(ctx: any) {
-  /**
-   * Aggregate every row into a per-column footer summary (sum for numeric
-   * columns, `Count: N` otherwise). This loop is the hottest path on a
-   * large grid - it is rows x columns iterations - so two things keep the
-   * constant factor down:
-   *
-   *   1. The edited-cell overlay is only consulted when an edit actually
-   *      exists. `key in editedCellValues` hits a reactive-proxy `has`
-   *      trap for every cell otherwise - 5M no-op trap calls on a
-   *      100k x 50 grid. Skipping it when the map is empty is the single
-   *      biggest win here.
-   *   2. The column's accessor (`fieldFn` / `field`) is resolved once
-   *      per column, not re-read off `columnDef` for every cell.
-   */
-  function computeSummaries(
-    rows: ReadonlyArray<Row<TData>>,
-    columns: ReadonlyArray<Column<TData>>,
-  ): Record<string, string> {
-    const summary: Record<string, string> = {};
-    const rowCount = rows.length;
-    const hasEdits = Object.keys(ctx.editedCellValues).length > 0;
-    for (const column of columns) {
-      const def = column.columnDef;
-      const fieldFn = def.fieldFn;
-      const field = def.field;
-      const columnId = column.id;
-
-      // A column that declares its own `summary` opts out of the default
-      // sum/count below. Only that column pays for the aggregator dispatch, so
-      // a grid that declares none keeps the original hot loop exactly as it was.
-      const declared = def.summary;
-      if (declared !== undefined) {
-        if (declared === false) {
-          summary[columnId] = "";
-          continue;
-        }
-        const value = applyGroupAggregate(declared, columnId, rows);
-        summary[columnId] =
-          typeof value === "number" && Number.isFinite(value)
-            ? formatSummaryNumeric(column, value)
-            : value == null
-              ? ""
-              : String(value);
-        continue;
-      }
-
-      let numericSum = 0;
-      let numericCount = 0;
-      for (let i = 0; i < rowCount; i += 1) {
-        const row = rows[i]!;
-        let value: unknown;
-        const base = fieldFn
-          ? fieldFn(row.original)
-          : field
-            ? (row.original as Record<string, unknown>)[field]
-            : row.getCellValueByColumnId(columnId);
-        if (hasEdits) {
-          const key = getCellKey(row.id, columnId);
-          value = key in ctx.editedCellValues ? ctx.editedCellValues[key] : base;
-        } else {
-          value = base;
-        }
-        const asNumber = Number(value);
-        if (Number.isFinite(asNumber)) {
-          numericSum += asNumber;
-          numericCount += 1;
-        }
-      }
-      summary[columnId] =
-        numericCount > 0
-          ? formatSummaryNumeric(column, numericSum)
-          : `Count: ${rowCount}`;
-    }
-    return summary;
-  }
-
-  function hasRenderedColumn(entry: {
-    item: (typeof ctx.renderedColumnItems)[number];
-    column: (typeof ctx.allColumns)[number] | undefined;
-  }): entry is {
-    item: (typeof ctx.renderedColumnItems)[number];
-    column: (typeof ctx.allColumns)[number];
-  } {
-    return entry.column !== undefined;
-  }
-
-  return {
-    computeSummaries,
-    hasRenderedColumn,
-  };
-}
+// summaries handlers extracted from the controller. Imperative event handlers
+// reading/writing controller state via the `ctx` handle; the reactive core
+// ($state/$derived/$effect) stays in the controller.
+import {
+  applyGroupAggregate,
+  type Column,
+  type Row,
+  type RowData,
+  type TableFeatures,
+} from "./index";
+import "./sv-grid-scrollbar";
+import {
+  getCellKey,
+} from "./SvGrid.helpers";
+import {
+  formatSummaryNumeric,
+} from "./cell-values";
+
+export function createSummaries<
+  TFeatures extends TableFeatures = TableFeatures,
+  TData extends RowData = RowData,
+>(ctx: any) {
+  /**
+   * Aggregate every row into a per-column footer summary (sum for numeric
+   * columns, `Count: N` otherwise). This loop is the hottest path on a
+   * large grid - it is rows x columns iterations - so two things keep the
+   * constant factor down:
+   *
+   *   1. The edited-cell overlay is only consulted when an edit actually
+   *      exists. `key in editedCellValues` hits a reactive-proxy `has`
+   *      trap for every cell otherwise - 5M no-op trap calls on a
+   *      100k x 50 grid. Skipping it when the map is empty is the single
+   *      biggest win here.
+   *   2. The column's accessor (`fieldFn` / `field`) is resolved once
+   *      per column, not re-read off `columnDef` for every cell.
+   */
+  function computeSummaries(
+    rows: ReadonlyArray<Row<TData>>,
+    columns: ReadonlyArray<Column<TData>>,
+  ): Record<string, string> {
+    const summary: Record<string, string> = {};
+    const rowCount = rows.length;
+    const hasEdits = Object.keys(ctx.editedCellValues).length > 0;
+    for (const column of columns) {
+      const def = column.columnDef;
+      const fieldFn = def.fieldFn;
+      const field = def.field;
+      const columnId = column.id;
+
+      // A column that declares its own `summary` opts out of the default
+      // sum/count below. Only that column pays for the aggregator dispatch, so
+      // a grid that declares none keeps the original hot loop exactly as it was.
+      const declared = def.summary;
+      if (declared !== undefined) {
+        if (declared === false) {
+          summary[columnId] = "";
+          continue;
+        }
+        const value = applyGroupAggregate(declared, columnId, rows);
+        summary[columnId] =
+          typeof value === "number" && Number.isFinite(value)
+            ? formatSummaryNumeric(column, value)
+            : value == null
+              ? ""
+              : String(value);
+        continue;
+      }
+
+      let numericSum = 0;
+      let numericCount = 0;
+      for (let i = 0; i < rowCount; i += 1) {
+        const row = rows[i]!;
+        let value: unknown;
+        const base = fieldFn
+          ? fieldFn(row.original)
+          : field
+            ? (row.original as Record<string, unknown>)[field]
+            : row.getCellValueByColumnId(columnId);
+        if (hasEdits) {
+          const key = getCellKey(row.id, columnId);
+          value = key in ctx.editedCellValues ? ctx.editedCellValues[key] : base;
+        } else {
+          value = base;
+        }
+        const asNumber = Number(value);
+        if (Number.isFinite(asNumber)) {
+          numericSum += asNumber;
+          numericCount += 1;
+        }
+      }
+      summary[columnId] =
+        numericCount > 0
+          ? formatSummaryNumeric(column, numericSum)
+          : `Count: ${rowCount}`;
+    }
+    return summary;
+  }
+
+  function hasRenderedColumn(entry: {
+    item: (typeof ctx.renderedColumnItems)[number];
+    column: (typeof ctx.allColumns)[number] | undefined;
+  }): entry is {
+    item: (typeof ctx.renderedColumnItems)[number];
+    column: (typeof ctx.allColumns)[number];
+  } {
+    return entry.column !== undefined;
+  }
+
+  return {
+    computeSummaries,
+    hasRenderedColumn,
+  };
+}