Merge pull request #379 from silx-kit/clean-up

Remove obsolete type guards and fix `axes` attribute creation

Author: axelboc

Diff for: src/h5web/metadata-viewer/EntityTable.tsx

@@ -2,7 +2,7 @@ import React, { ReactElement } from 'react';
 import type { MyHDF5Entity } from '../providers/models';
 import styles from './MetadataViewer.module.css';
 import {
-  hasMySimpleShape,
+  hasSimpleShape,
   isDataset,
   isDatatype,
   isLink,
@@ -64,7 +64,7 @@ function EntityTable(props: Props): ReactElement {
           <tr>
             <th scope="row">Shape</th>
             <td>
-              {hasMySimpleShape(entity)
+              {hasSimpleShape(entity)
                 ? renderShapeDims(entity.shape.dims)
                 : entity.shape.class}
             </td>

Diff for: src/h5web/providers/mock/utils.ts

@@ -1,9 +1,5 @@
 import { mockValues, mockMetadata } from './data';
-import {
-  assertDataset,
-  assertMySimpleShape,
-  assertNumericType,
-} from '../utils';
+import { assertDataset, assertSimpleShape, assertNumericType } from '../utils';
 import { assertArray, assertDefined } from '../../visualizations/shared/utils';
 import ndarray from 'ndarray';
 import { getEntityAtPath } from '../../explorer/utils';
@@ -13,7 +9,7 @@ export function getMockDataArray(path: string): ndarray {
   assertDefined(dataset, `Expected entity at path "${path}"`);
   assertDataset(dataset, `Expected group at path "${path}"`);
   assertNumericType(dataset);
-  assertMySimpleShape(dataset);
+  assertSimpleShape(dataset);
 
   const value = mockValues[dataset.id as keyof typeof mockValues];
   assertArray<number>(value);

Diff for: src/h5web/providers/my-utils.ts

@@ -20,13 +20,12 @@ import {
   MyHDF5ResolvedEntity,
 } from '../providers/models';
 import { NxInterpretation, SilxStyle } from '../visualizations/nexus/models';
-import { makeSimpleShape, makeStrAttr } from './raw-utils';
+import { makeNxAxesAttr, makeSimpleShape, makeStrAttr } from './raw-utils';
 
 type EntityOpts = Partial<
   Pick<MyHDF5ResolvedEntity, 'id' | 'attributes' | 'rawLink'>
 >;
 type GroupOpts = EntityOpts & { children?: MyHDF5Entity[] };
-type AllOrNone<T> = T | { [K in keyof T]?: never };
 
 export function makeMyGroup(
   name: string,
@@ -149,7 +148,10 @@ export function makeMyNxDataGroup<
     errors?: MyHDF5Dataset<HDF5SimpleShape, HDF5NumericType>;
     title?: MyHDF5Dataset<HDF5ScalarShape, HDF5StringType>;
     silxStyle?: SilxStyle;
-  } & AllOrNone<{ axes: T; axesAttr: (keyof T | '.')[] }> &
+  } & (
+    | { axes: T; axesAttr: (Extract<keyof T, string> | '.')[] }
+    | { axes?: never; axesAttr?: never }
+  ) &
     GroupOpts
 ): MyHDF5Group {
   const {
@@ -176,7 +178,7 @@ export function makeMyNxDataGroup<
         ...(groupOpts.attributes || []),
         makeStrAttr('NX_class', 'NXdata'),
         makeStrAttr('signal', signal.name),
-        makeStrAttr('axes', axesAttr),
+        ...(axesAttr ? [makeNxAxesAttr(axesAttr)] : []),
         ...(silxStyle
           ? [makeStrAttr('SILX_style', JSON.stringify(silxStyle))]
           : []),

Diff for: src/h5web/providers/raw-utils.ts

@@ -70,7 +70,7 @@ export function makeAttr(
   return { name, type, shape, value };
 }
 
-export function makeStrAttr(name: string, value: HDF5Value): HDF5Attribute {
+export function makeStrAttr(name: string, value: string): HDF5Attribute {
   return makeAttr(name, scalarShape, stringType, value);
 }
 

Diff for: src/h5web/providers/utils.ts

@@ -9,7 +9,6 @@ import {
   HDF5Type,
   HDF5TypeClass,
   HDF5RootLink,
-  HDF5Dataset,
   HDF5ScalarShape,
   HDF5NumericType,
   MyHDF5Entity,
@@ -58,13 +57,7 @@ export function isLink(entity: MyHDF5Entity): entity is MyHDF5Link {
   return entity.kind === MyHDF5EntityKind.Link;
 }
 
-function hasSimpleShape<T extends HDF5Type>(
-  dataset: HDF5Dataset<HDF5Shape, T>
-): dataset is HDF5Dataset<HDF5SimpleShape, T> {
-  return dataset.shape.class === HDF5ShapeClass.Simple;
-}
-
-export function hasMySimpleShape<T extends HDF5Type>(
+export function hasSimpleShape<T extends HDF5Type>(
   dataset: MyHDF5Dataset<HDF5Shape, T>
 ): dataset is MyHDF5Dataset<HDF5SimpleShape, T> {
   return dataset.shape.class === HDF5ShapeClass.Simple;
@@ -123,21 +116,9 @@ export function assertNumericType<S extends HDF5Shape>(
 }
 
 export function assertSimpleShape<T extends HDF5Type>(
-  dataset: HDF5Dataset<HDF5Shape, T>
-): asserts dataset is HDF5Dataset<HDF5SimpleShape, T> {
-  if (!hasSimpleShape(dataset)) {
-    throw new Error('Expected dataset to have simple shape');
-  }
-
-  if (dataset.shape.dims.length === 0) {
-    throw new Error('Expected dataset with simple shape to have dimensions');
-  }
-}
-
-export function assertMySimpleShape<T extends HDF5Type>(
   dataset: MyHDF5Dataset<HDF5Shape, T>
 ): asserts dataset is MyHDF5Dataset<HDF5SimpleShape, T> {
-  if (!hasMySimpleShape(dataset)) {
+  if (!hasSimpleShape(dataset)) {
     throw new Error('Expected dataset to have simple shape');
   }
 

Diff for: src/h5web/visualizations/containers/HeatmapVisContainer.tsx

@@ -3,15 +3,15 @@ import { useDatasetValue } from './hooks';
 import {
   assertDataset,
   assertNumericType,
-  assertMySimpleShape,
+  assertSimpleShape,
 } from '../../providers/utils';
 import MappedHeatmapVis from '../heatmap/MappedHeatmapVis';
 import type { VisContainerProps } from './models';
 
 function HeatmapVisContainer(props: VisContainerProps): ReactElement {
   const { entity } = props;
   assertDataset(entity);
-  assertMySimpleShape(entity);
+  assertSimpleShape(entity);
   assertNumericType(entity);
 
   const { dims } = entity.shape;

Diff for: src/h5web/visualizations/containers/LineVisContainer.tsx

@@ -3,15 +3,15 @@ import { useDatasetValue } from './hooks';
 import {
   assertDataset,
   assertNumericType,
-  assertMySimpleShape,
+  assertSimpleShape,
 } from '../../providers/utils';
 import MappedLineVis from '../line/MappedLineVis';
 import type { VisContainerProps } from './models';
 
 function LineVisContainer(props: VisContainerProps): ReactElement {
   const { entity } = props;
   assertDataset(entity);
-  assertMySimpleShape(entity);
+  assertSimpleShape(entity);
   assertNumericType(entity);
 
   const value = useDatasetValue(entity.id);

Diff for: src/h5web/visualizations/containers/MatrixVisContainer.tsx

@@ -1,13 +1,13 @@
 import React, { ReactElement } from 'react';
 import { useDatasetValue } from './hooks';
-import { assertDataset, assertMySimpleShape } from '../../providers/utils';
+import { assertDataset, assertSimpleShape } from '../../providers/utils';
 import MappedMatrixVis from '../matrix/MappedMatrixVis';
 import type { VisContainerProps } from './models';
 
 function MatrixVisContainer(props: VisContainerProps): ReactElement {
   const { entity } = props;
   assertDataset(entity);
-  assertMySimpleShape(entity);
+  assertSimpleShape(entity);
 
   const value = useDatasetValue(entity.id);
   if (!value) {

Diff for: src/h5web/visualizations/index.tsx

@@ -7,7 +7,7 @@ import type { MyHDF5Entity } from '../providers/models';
 import {
   hasScalarShape,
   hasBaseType,
-  hasMySimpleShape,
+  hasSimpleShape,
   hasNumericType,
   isDataset,
   isGroup,
@@ -72,7 +72,7 @@ export const VIS_DEFS: Record<Vis, VisDef> = {
       return (
         isDataset(entity) &&
         hasBaseType(entity) &&
-        hasMySimpleShape(entity) &&
+        hasSimpleShape(entity) &&
         entity.shape.dims.length >= 1
       );
     },
@@ -86,7 +86,7 @@ export const VIS_DEFS: Record<Vis, VisDef> = {
       return (
         isDataset(entity) &&
         hasNumericType(entity) &&
-        hasMySimpleShape(entity) &&
+        hasSimpleShape(entity) &&
         entity.shape.dims.length >= 1
       );
     },
@@ -100,7 +100,7 @@ export const VIS_DEFS: Record<Vis, VisDef> = {
       return (
         isDataset(entity) &&
         hasNumericType(entity) &&
-        hasMySimpleShape(entity) &&
+        hasSimpleShape(entity) &&
         entity.shape.dims.length >= 2
       );
     },

Diff for: src/h5web/visualizations/nexus/utils.ts

@@ -12,7 +12,7 @@ import {
   assertGroup,
   assertDataset,
   assertNumericType,
-  assertMySimpleShape,
+  assertSimpleShape,
 } from '../../providers/utils';
 import {
   NxAttribute,
@@ -85,7 +85,7 @@ export function findSignalDataset(
   assertDefined(dataset, `Expected "${signalName}" signal entity to exist`);
   assertDataset(dataset, `Expected "${signalName}" signal to be a dataset`);
   assertNumericType(dataset);
-  assertMySimpleShape(dataset);
+  assertSimpleShape(dataset);
 
   return dataset;
 }