@genspectrum/dashboard-components 1.17.0 → 1.18.0

package/dist/util.d.ts

@@ -248,52 +248,212 @@ declare const mutationAnnotationSchema: default_2.ZodObject<{
     name: default_2.ZodString;
     description: default_2.ZodString;
     symbol: default_2.ZodString;
-    nucleotideMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
-    nucleotidePositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
-    aminoAcidMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
-    aminoAcidPositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
+    nucleotideMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        mutation: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
+    nucleotidePositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        position: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
+    aminoAcidMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        mutation: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
+    aminoAcidPositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        position: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
 }, "strip", default_2.ZodTypeAny, {
     symbol: string;
     name: string;
     description: string;
-    nucleotideMutations?: string[] | undefined;
-    nucleotidePositions?: string[] | undefined;
-    aminoAcidMutations?: string[] | undefined;
-    aminoAcidPositions?: string[] | undefined;
+    nucleotideMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    nucleotidePositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidPositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
 }, {
     symbol: string;
     name: string;
     description: string;
-    nucleotideMutations?: string[] | undefined;
-    nucleotidePositions?: string[] | undefined;
-    aminoAcidMutations?: string[] | undefined;
-    aminoAcidPositions?: string[] | undefined;
+    nucleotideMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    nucleotidePositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidPositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
 }>;
 
 declare const mutationAnnotationsSchema: default_2.ZodArray<default_2.ZodObject<{
     name: default_2.ZodString;
     description: default_2.ZodString;
     symbol: default_2.ZodString;
-    nucleotideMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
-    nucleotidePositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
-    aminoAcidMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
-    aminoAcidPositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodString, "many">>;
+    nucleotideMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        mutation: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
+    nucleotidePositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        position: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
+    aminoAcidMutations: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        mutation: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
+    aminoAcidPositions: default_2.ZodOptional<default_2.ZodArray<default_2.ZodUnion<[default_2.ZodString, default_2.ZodObject<{
+        position: default_2.ZodString;
+        name: default_2.ZodOptional<default_2.ZodString>;
+        description: default_2.ZodOptional<default_2.ZodString>;
+    }, "strip", default_2.ZodTypeAny, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }, {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    }>]>, "many">>;
 }, "strip", default_2.ZodTypeAny, {
     symbol: string;
     name: string;
     description: string;
-    nucleotideMutations?: string[] | undefined;
-    nucleotidePositions?: string[] | undefined;
-    aminoAcidMutations?: string[] | undefined;
-    aminoAcidPositions?: string[] | undefined;
+    nucleotideMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    nucleotidePositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidPositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
 }, {
     symbol: string;
     name: string;
     description: string;
-    nucleotideMutations?: string[] | undefined;
-    nucleotidePositions?: string[] | undefined;
-    aminoAcidMutations?: string[] | undefined;
-    aminoAcidPositions?: string[] | undefined;
+    nucleotideMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    nucleotidePositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidMutations?: (string | {
+        mutation: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
+    aminoAcidPositions?: (string | {
+        position: string;
+        name?: string | undefined;
+        description?: string | undefined;
+    })[] | undefined;
 }>, "many">;
 
 export declare type MutationComparisonProps = default_2.infer<typeof mutationComparisonPropsSchema>;
@@ -1252,7 +1412,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-statistics': StatisticsComponent;
+        'gs-sequences-by-location': SequencesByLocationComponent;
     }
 }
 
@@ -1260,7 +1420,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-statistics': StatisticsComponent;
+            'gs-sequences-by-location': SequencesByLocationComponent;
         }
     }
 }
@@ -1268,7 +1428,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-sequences-by-location': SequencesByLocationComponent;
+        'gs-statistics': StatisticsComponent;
     }
 }
 
@@ -1276,7 +1436,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-sequences-by-location': SequencesByLocationComponent;
+            'gs-statistics': StatisticsComponent;
         }
     }
 }
@@ -1284,7 +1444,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+        'gs-location-filter': LocationFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.locationChanged]: LocationChangedEvent;
     }
 }
 
@@ -1292,7 +1455,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+            'gs-location-filter': LocationFilterComponent;
         }
     }
 }
@@ -1300,11 +1463,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-date-range-filter': DateRangeFilterComponent;
+        'gs-text-filter': TextFilterComponent;
     }
     interface HTMLElementEventMap {
-        [gsEventNames.dateRangeFilterChanged]: CustomEvent<Record<string, string>>;
-        [gsEventNames.dateRangeOptionChanged]: DateRangeOptionChangedEvent;
+        [gsEventNames.textFilterChanged]: TextFilterChangedEvent;
     }
 }
 
@@ -1312,7 +1474,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-date-range-filter': DateRangeFilterComponent;
+            'gs-text-filter': TextFilterComponent;
         }
     }
 }
@@ -1320,10 +1482,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-location-filter': LocationFilterComponent;
+        'gs-date-range-filter': DateRangeFilterComponent;
     }
     interface HTMLElementEventMap {
-        [gsEventNames.locationChanged]: LocationChangedEvent;
+        [gsEventNames.dateRangeFilterChanged]: CustomEvent<Record<string, string>>;
+        [gsEventNames.dateRangeOptionChanged]: DateRangeOptionChangedEvent;
     }
 }
 
@@ -1331,7 +1494,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-location-filter': LocationFilterComponent;
+            'gs-date-range-filter': DateRangeFilterComponent;
         }
     }
 }
@@ -1339,10 +1502,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-text-filter': TextFilterComponent;
+        'gs-mutation-filter': MutationFilterComponent;
     }
     interface HTMLElementEventMap {
-        [gsEventNames.textFilterChanged]: TextFilterChangedEvent;
+        [gsEventNames.mutationFilterChanged]: CustomEvent<MutationsFilter>;
     }
 }
 
@@ -1350,7 +1513,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-text-filter': TextFilterComponent;
+            'gs-mutation-filter': MutationFilterComponent;
         }
     }
 }
@@ -1358,10 +1521,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutation-filter': MutationFilterComponent;
+        'gs-number-range-filter': NumberRangeFilterComponent;
     }
     interface HTMLElementEventMap {
-        [gsEventNames.mutationFilterChanged]: CustomEvent<MutationsFilter>;
+        [gsEventNames.numberRangeFilterChanged]: NumberRangeFilterChangedEvent;
+        [gsEventNames.numberRangeValueChanged]: NumberRangeValueChangedEvent;
     }
 }
 
@@ -1369,7 +1533,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-mutation-filter': MutationFilterComponent;
+            'gs-number-range-filter': NumberRangeFilterComponent;
         }
     }
 }
@@ -1397,11 +1561,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-number-range-filter': NumberRangeFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.numberRangeFilterChanged]: NumberRangeFilterChangedEvent;
-        [gsEventNames.numberRangeValueChanged]: NumberRangeValueChangedEvent;
+        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
     }
 }
 
@@ -1409,7 +1569,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-number-range-filter': NumberRangeFilterComponent;
+            'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@genspectrum/dashboard-components",
-    "version": "1.17.0",
+    "version": "1.18.0",
     "description": "GenSpectrum web components for building dashboards",
     "type": "module",
     "license": "AGPL-3.0-only",

package/src/preact/MutationAnnotationsContext.spec.tsx

@@ -2,9 +2,17 @@ import { renderHook } from '@testing-library/preact';
 import { type FunctionalComponent } from 'preact';
 import { describe, expect, it } from 'vitest';
 
-import { MutationAnnotationsContextProvider, useMutationAnnotationsProvider } from './MutationAnnotationsContext';
+import {
+    MutationAnnotationsContextProvider,
+    type ResolvedMutationAnnotation,
+    useMutationAnnotationsProvider,
+} from './MutationAnnotationsContext';
 import { SubstitutionClass } from '../utils/mutations';
-import { type MutationAnnotations } from '../web-components/mutation-annotations-context';
+import { type MutationAnnotation, type MutationAnnotations } from '../web-components/mutation-annotations-context';
+
+function resolved(annotation: MutationAnnotation): ResolvedMutationAnnotation {
+    return { annotation, name: annotation.name, description: annotation.description };
+}
 
 describe('useMutationAnnotation', () => {
     function renderAnnotationsHook(mockAnnotations: MutationAnnotations) {
@@ -35,13 +43,13 @@ describe('useMutationAnnotation', () => {
         it('should return the correct annotation for a given mutation', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A123')!, 'nucleotide');
 
-            expect(result).toEqual([mockAnnotations[0]]);
+            expect(result).toEqual([resolved(mockAnnotations[0])]);
         });
 
         it('should return the correct annotations if multiple contain a mutation', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A456')!, 'nucleotide');
 
-            expect(result).toEqual([mockAnnotations[0], mockAnnotations[1]]);
+            expect(result).toEqual([resolved(mockAnnotations[0]), resolved(mockAnnotations[1])]);
         });
     });
 
@@ -58,7 +66,7 @@ describe('useMutationAnnotation', () => {
         it('should return the correct mutation annotation for a given mutations', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('B456')!, 'amino acid');
 
-            expect(result).toEqual([mockAnnotations[0]]);
+            expect(result).toEqual([resolved(mockAnnotations[0])]);
         });
     });
 
@@ -81,17 +89,17 @@ describe('useMutationAnnotation', () => {
 
         it('should return the correct mutation annotation covered by position only', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A543T')!, 'nucleotide');
-            expect(result).toEqual([mockAnnotations[0]]);
+            expect(result).toEqual([resolved(mockAnnotations[0])]);
         });
 
         it('should return the correct mutation annotation covered both by position and mutation', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A321T')!, 'nucleotide');
-            expect(result).toEqual([mockAnnotations[0]]);
+            expect(result).toEqual([resolved(mockAnnotations[0])]);
         });
 
         it('should return both annotations if one matches the mutations and the other the position', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A432T')!, 'nucleotide');
-            expect(result).toEqual([mockAnnotations[1], mockAnnotations[0]]);
+            expect(result).toEqual([resolved(mockAnnotations[0]), resolved(mockAnnotations[1])]);
         });
     });
 
@@ -108,12 +116,12 @@ describe('useMutationAnnotation', () => {
 
         it('should return the correct mutation annotation covered both by position and mutation', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('Gene:B432G')!, 'amino acid');
-            expect(result).toEqual([mockAnnotations[0]]);
+            expect(result).toEqual([resolved(mockAnnotations[0])]);
         });
 
         it('should return the correct mutation annotation covered both by position only', () => {
             const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('Gene:B543G')!, 'amino acid');
-            expect(result).toEqual([mockAnnotations[0]]);
+            expect(result).toEqual([resolved(mockAnnotations[0])]);
         });
 
         it('should return no mutation annotation for an amino acid position of wrong gene', () => {
@@ -124,4 +132,68 @@ describe('useMutationAnnotation', () => {
             expect(result).toBeUndefined();
         });
     });
+
+    describe('per-mutation name and description overrides', () => {
+        it('should use overridden name and description when both are provided on a mutation entry', () => {
+            const mockAnnotations: MutationAnnotations = [
+                {
+                    name: 'Group name',
+                    description: 'Group description',
+                    symbol: 'X',
+                    nucleotideMutations: [
+                        { mutation: 'A123T', name: 'Override name', description: 'Override description' },
+                    ],
+                },
+            ];
+            const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A123T')!, 'nucleotide');
+            expect(result).toEqual([
+                { annotation: mockAnnotations[0], name: 'Override name', description: 'Override description' },
+            ]);
+        });
+
+        it('should fall back to group name when only description is overridden', () => {
+            const mockAnnotations: MutationAnnotations = [
+                {
+                    name: 'Group name',
+                    description: 'Group description',
+                    symbol: 'X',
+                    nucleotideMutations: [{ mutation: 'A123T', description: 'Override description' }],
+                },
+            ];
+            const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A123T')!, 'nucleotide');
+            expect(result).toEqual([
+                { annotation: mockAnnotations[0], name: 'Group name', description: 'Override description' },
+            ]);
+        });
+
+        it('should fall back to group description when only name is overridden', () => {
+            const mockAnnotations: MutationAnnotations = [
+                {
+                    name: 'Group name',
+                    description: 'Group description',
+                    symbol: 'X',
+                    nucleotideMutations: [{ mutation: 'A123T', name: 'Override name' }],
+                },
+            ];
+            const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A123T')!, 'nucleotide');
+            expect(result).toEqual([
+                { annotation: mockAnnotations[0], name: 'Override name', description: 'Group description' },
+            ]);
+        });
+
+        it('should use position-level override for position entries', () => {
+            const mockAnnotations: MutationAnnotations = [
+                {
+                    name: 'Group name',
+                    description: 'Group description',
+                    symbol: 'X',
+                    nucleotidePositions: [{ position: '123', name: 'Position override name' }],
+                },
+            ];
+            const result = renderAnnotationsHook(mockAnnotations)(SubstitutionClass.parse('A123T')!, 'nucleotide');
+            expect(result).toEqual([
+                { annotation: mockAnnotations[0], name: 'Position override name', description: 'Group description' },
+            ]);
+        });
+    });
 });