Reduce reliance on ArrayShape type

Author: axelboc

packages/app/src/dim-mapping-store.tsx

@@ -1,5 +1,4 @@
 import { type DimensionMapping, initDimMapping } from '@h5web/lib';
-import { type ArrayShape } from '@h5web/shared/hdf5-models';
 import { type NoProps } from '@h5web/shared/vis-models';
 import {
   createContext,
@@ -15,7 +14,7 @@ import { type DefaultSlice } from './vis-packs/nexus/models';
 import { applyDefaultSlice, areSameDims } from './vis-packs/nexus/utils';
 
 interface DimMappingState {
-  dims: ArrayShape;
+  dims: number[];
   axesCount: number;
   lockedDimsCount: number;
   mapping: DimensionMapping;

packages/app/src/index.ts

@@ -125,6 +125,7 @@ export {
   assertDatatype,
   isScalarShape,
   isArrayShape,
+  isNonNullShape,
   hasScalarShape,
   hasArrayShape,
   hasNonNullShape,

packages/app/src/metadata-viewer/EntityInfo.tsx

@@ -1,10 +1,10 @@
-import { isDataset, isDatatype } from '@h5web/shared/guards';
+import { isDataset, isDatatype, isNonNullShape } from '@h5web/shared/guards';
 import { type ProvidedEntity } from '@h5web/shared/hdf5-models';
 
 import { useDataContext } from '../providers/DataProvider';
 import styles from './MetadataViewer.module.css';
 import RawInspector from './RawInspector';
-import { renderShape, renderType } from './utils';
+import { renderDims, renderType } from './utils';
 
 interface Props {
   entity: ProvidedEntity;
@@ -36,13 +36,15 @@ function EntityInfo(props: Props) {
       {isDataset(entity) && (
         <tr>
           <th scope="row">Shape</th>
-          <td>{renderShape(entity.shape)}</td>
+          <td>
+            {isNonNullShape(entity.shape) ? renderDims(entity.shape) : 'None'}
+          </td>
         </tr>
       )}
       {isDataset(entity) && entity.chunks && (
         <tr>
           <th scope="row">Chunk shape</th>
-          <td>{renderShape(entity.chunks)}</td>
+          <td>{renderDims(entity.chunks)}</td>
         </tr>
       )}
       {entity.link?.path && (

packages/app/src/metadata-viewer/utils.test.ts

@@ -1,21 +1,17 @@
 import { describe, expect, it } from 'vitest';
 
-import { renderShape } from './utils';
+import { renderDims } from './utils';
 
-describe('renderShape', () => {
-  it('should render scalar shape', () => {
-    expect(renderShape([])).toBe('Scalar');
+describe('renderDims', () => {
+  it('should render zero dimension', () => {
+    expect(renderDims([])).toBe('Scalar');
   });
 
-  it('should render shape with one dimension', () => {
-    expect(renderShape([5])).toBe('5');
+  it('should render single dimension', () => {
+    expect(renderDims([5])).toBe('5');
   });
 
-  it('should render shape with multiple dimensions', () => {
-    expect(renderShape([10, 2, 6])).toBe('10 x 2 x 6 = 120');
-  });
-
-  it('should render null shape', () => {
-    expect(renderShape(null)).toBe('None');
+  it('should render multiple dimensions', () => {
+    expect(renderDims([10, 2, 6])).toBe('10 x 2 x 6 = 120');
   });
 });

packages/app/src/metadata-viewer/utils.ts

@@ -2,29 +2,25 @@ import {
   isFloatType,
   isH5WebComplex,
   isIntegerType,
-  isScalarShape,
 } from '@h5web/shared/guards';
 import {
   type ComplexArray,
   type DType,
   DTypeClass,
   type H5WebComplex,
-  type Shape,
 } from '@h5web/shared/hdf5-models';
 import { formatScalarComplex } from '@h5web/shared/vis-utils';
 
-export function renderShape(shape: Shape): string {
-  if (shape === null) {
-    return 'None';
+export function renderDims(dims: number[]): string {
+  if (dims.length === 0) {
+    return 'Scalar';
   }
 
-  if (isScalarShape(shape)) {
-    return 'Scalar';
+  if (dims.length === 1) {
+    dims.toString();
   }
 
-  return shape.length === 1
-    ? shape.toString()
-    : `${shape.join(' x ')} = ${shape.reduce((acc, value) => acc * value)}`;
+  return `${dims.join(' x ')} = ${dims.reduce((acc, value) => acc * value)}`;
 }
 
 export function renderType(type: DType): string {

packages/app/src/vis-packs/nexus/utils.ts

@@ -340,7 +340,7 @@ export function guessKeepRatio(
   return xAxisDef?.unit === yAxisDef?.unit;
 }
 
-export function areSameDims(dims1: ArrayShape, dims2: ArrayShape): boolean {
+export function areSameDims(dims1: number[], dims2: number[]): boolean {
   return (
     dims1.length === dims2.length &&
     dims1.every((dim, index) => dim === dims2[index])

packages/lib/src/vis/matrix/MatrixVis.tsx

@@ -1,4 +1,4 @@
-import { type ArrayShape } from '@h5web/shared/hdf5-models';
+import { assertNonEmptyArray } from '@h5web/shared/guards';
 import { useMemo, useState } from 'react';
 import { Grid } from 'react-window';
 import { useStore } from 'zustand';
@@ -11,7 +11,7 @@ import { createRenderedCellsStore } from './store';
 import { CELL_HEIGHT } from './utils';
 
 interface Props extends ClassStyleAttrs {
-  dims: ArrayShape;
+  dims: number[];
   cellFormatter: (row: number, col: number) => string;
   cellWidth: number;
   columnHeaders?: string[];
@@ -26,6 +26,8 @@ function MatrixVis(props: Props) {
     className = '',
     style,
   } = props;
+
+  assertNonEmptyArray(dims);
   const [rowCount, columnCount = 1] = dims;
 
   const [store] = useState(createRenderedCellsStore);

packages/shared/src/guards.ts

@@ -146,6 +146,19 @@ export function assertArray(
   }
 }
 
+export function isNonEmptyArray<T>(val: T[]): val is [T, ...T[]] {
+  return val.length > 0;
+}
+
+export function assertNonEmptyArray<T>(
+  val: T[],
+  message = 'Expected non-empty array',
+): asserts val is [T, ...T[]] {
+  if (!isNonEmptyArray(val)) {
+    throw new Error(message);
+  }
+}
+
 export function isComplexArray(val: unknown): val is H5WebComplex[] {
   return Array.isArray(val) && isComplex(val[0]);
 }
@@ -309,10 +322,16 @@ export function assertArrayShape<O extends HasShape>(
   }
 }
 
+export function isNonNullShape(
+  shape: Shape,
+): shape is ScalarShape | ArrayShape {
+  return isNonNull(shape);
+}
+
 export function hasNonNullShape<O extends HasShape>(
   obj: O,
 ): obj is O & HasShape<ScalarShape | ArrayShape> {
-  return isNonNull(obj.shape);
+  return isNonNullShape(obj.shape);
 }
 
 export function assertNonNullShape<O extends HasShape>(