@genspectrum/dashboard-components 1.17.0 → 1.18.1

package/custom-elements.json

@@ -246,10 +246,10 @@
               "kind": "field",
               "name": "mutationAnnotations",
               "type": {
-                "text": "{\n        name: string;\n        description: string;\n        symbol: string;\n        nucleotideMutations?: string[];\n        nucleotidePositions?: string[];\n        aminoAcidMutations?: string[];\n        aminoAcidPositions?: string[];\n    }[]"
+                "text": "{\n        name: string;\n        description: string;\n        symbol: string;\n        nucleotideMutations?: (string | { mutation: string; name?: string; description?: string })[];\n        nucleotidePositions?: (string | { position: string; name?: string; description?: string })[];\n        aminoAcidMutations?: (string | { mutation: string; name?: string; description?: string })[];\n        aminoAcidPositions?: (string | { position: string; name?: string; description?: string })[];\n    }[]"
               },
               "default": "[]",
-              "description": "Supply lists of mutations that are especially relevant for the current organism.\n\nVisit https://genspectrum.github.io/dashboard-components/?path=/docs/concepts-mutation-annotations--docs for more information.",
+              "description": "Supply lists of mutations that are especially relevant for the current organism.\n\nEach entry in `nucleotideMutations`, `aminoAcidMutations`, `nucleotidePositions`, and `aminoAcidPositions`\ncan be either a plain string or an object with an optional `name` and `description` that override the\ngroup-level values in the annotation popup for that specific mutation or position.\n\nVisit https://genspectrum.github.io/dashboard-components/?path=/docs/concepts-mutation-annotations--docs for more information.",
               "attribute": "mutationAnnotations"
             },
             {
@@ -276,10 +276,10 @@
             {
               "name": "mutationAnnotations",
               "type": {
-                "text": "{\n        name: string;\n        description: string;\n        symbol: string;\n        nucleotideMutations?: string[];\n        nucleotidePositions?: string[];\n        aminoAcidMutations?: string[];\n        aminoAcidPositions?: string[];\n    }[]"
+                "text": "{\n        name: string;\n        description: string;\n        symbol: string;\n        nucleotideMutations?: (string | { mutation: string; name?: string; description?: string })[];\n        nucleotidePositions?: (string | { position: string; name?: string; description?: string })[];\n        aminoAcidMutations?: (string | { mutation: string; name?: string; description?: string })[];\n        aminoAcidPositions?: (string | { position: string; name?: string; description?: string })[];\n    }[]"
               },
               "default": "[]",
-              "description": "Supply lists of mutations that are especially relevant for the current organism.\n\nVisit https://genspectrum.github.io/dashboard-components/?path=/docs/concepts-mutation-annotations--docs for more information.",
+              "description": "Supply lists of mutations that are especially relevant for the current organism.\n\nEach entry in `nucleotideMutations`, `aminoAcidMutations`, `nucleotidePositions`, and `aminoAcidPositions`\ncan be either a plain string or an object with an optional `name` and `description` that override the\ngroup-level values in the annotation popup for that specific mutation or position.\n\nVisit https://genspectrum.github.io/dashboard-components/?path=/docs/concepts-mutation-annotations--docs for more information.",
               "fieldName": "mutationAnnotations"
             },
             {

package/dist/components.d.ts

@@ -118,16 +118,36 @@ export declare class AppComponent extends LitElement {
     /**
      * Supply lists of mutations that are especially relevant for the current organism.
      *
+     * Each entry in `nucleotideMutations`, `aminoAcidMutations`, `nucleotidePositions`, and `aminoAcidPositions`
+     * can be either a plain string or an object with an optional `name` and `description` that override the
+     * group-level values in the annotation popup for that specific mutation or position.
+     *
      * Visit https://genspectrum.github.io/dashboard-components/?path=/docs/concepts-mutation-annotations--docs for more information.
      */
     mutationAnnotations: {
         name: string;
         description: string;
         symbol: string;
-        nucleotideMutations?: string[];
-        nucleotidePositions?: string[];
-        aminoAcidMutations?: string[];
-        aminoAcidPositions?: string[];
+        nucleotideMutations?: (string | {
+            mutation: string;
+            name?: string;
+            description?: string;
+        })[];
+        nucleotidePositions?: (string | {
+            position: string;
+            name?: string;
+            description?: string;
+        })[];
+        aminoAcidMutations?: (string | {
+            mutation: string;
+            name?: string;
+            description?: string;
+        })[];
+        aminoAcidPositions?: (string | {
+            position: string;
+            name?: string;
+            description?: string;
+        })[];
     }[];
     /**
      * Supply a link template for nucleotide and amino acid mutations.
@@ -428,26 +448,106 @@ 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">;
 
 /**
@@ -1776,7 +1876,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-genome-data-viewer': GenomeDataViewerComponent;
+        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
     }
 }
 
@@ -1784,7 +1884,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-genome-data-viewer': GenomeDataViewerComponent;
+            'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
         }
     }
 }
@@ -1792,7 +1892,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutation-comparison': MutationComparisonComponent;
+        'gs-date-range-filter': DateRangeFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.dateRangeFilterChanged]: CustomEvent<Record<string, string>>;
+        [gsEventNames.dateRangeOptionChanged]: DateRangeOptionChangedEvent;
     }
 }
 
@@ -1800,7 +1904,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-mutation-comparison': MutationComparisonComponent;
+            'gs-date-range-filter': DateRangeFilterComponent;
         }
     }
 }
@@ -1808,7 +1912,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutations': MutationsComponent;
+        'gs-text-filter': TextFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.textFilterChanged]: TextFilterChangedEvent;
     }
 }
 
@@ -1816,7 +1923,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-mutations': MutationsComponent;
+            'gs-text-filter': TextFilterComponent;
         }
     }
 }
@@ -1824,7 +1931,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-prevalence-over-time': PrevalenceOverTimeComponent;
+        'gs-location-filter': LocationFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.locationChanged]: LocationChangedEvent;
     }
 }
 
@@ -1832,7 +1942,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-prevalence-over-time': PrevalenceOverTimeComponent;
+            'gs-location-filter': LocationFilterComponent;
         }
     }
 }
@@ -1840,7 +1950,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
+        'gs-mutation-filter': MutationFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.mutationFilterChanged]: CustomEvent<MutationsFilter>;
     }
 }
 
@@ -1848,7 +1961,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
+            'gs-mutation-filter': MutationFilterComponent;
         }
     }
 }
@@ -1856,7 +1969,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-aggregate': AggregateComponent;
+        'gs-lineage-filter': LineageFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.lineageFilterChanged]: LineageFilterChangedEvent;
+        [gsEventNames.lineageFilterMultiChanged]: LineageMultiFilterChangedEvent;
     }
 }
 
@@ -1864,7 +1981,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-aggregate': AggregateComponent;
+            'gs-lineage-filter': LineageFilterComponent;
         }
     }
 }
@@ -1872,7 +1989,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
+        'gs-number-range-filter': NumberRangeFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.numberRangeFilterChanged]: NumberRangeFilterChangedEvent;
+        [gsEventNames.numberRangeValueChanged]: NumberRangeValueChangedEvent;
     }
 }
 
@@ -1880,7 +2001,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
+            'gs-number-range-filter': NumberRangeFilterComponent;
         }
     }
 }
@@ -1888,7 +2009,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutations-over-time': MutationsOverTimeComponent;
+        'gs-genome-data-viewer': GenomeDataViewerComponent;
     }
 }
 
@@ -1896,7 +2017,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-mutations-over-time': MutationsOverTimeComponent;
+            'gs-genome-data-viewer': GenomeDataViewerComponent;
         }
     }
 }
@@ -1904,7 +2025,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-queries-over-time': QueriesOverTimeComponent;
+        'gs-mutations': MutationsComponent;
     }
 }
 
@@ -1912,7 +2033,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-queries-over-time': QueriesOverTimeComponent;
+            'gs-mutations': MutationsComponent;
         }
     }
 }
@@ -1920,7 +2041,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-statistics': StatisticsComponent;
+        'gs-mutation-comparison': MutationComparisonComponent;
     }
 }
 
@@ -1928,7 +2049,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-statistics': StatisticsComponent;
+            'gs-mutation-comparison': MutationComparisonComponent;
         }
     }
 }
@@ -1936,7 +2057,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-sequences-by-location': SequencesByLocationComponent;
+        'gs-prevalence-over-time': PrevalenceOverTimeComponent;
     }
 }
 
@@ -1944,7 +2065,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-sequences-by-location': SequencesByLocationComponent;
+            'gs-prevalence-over-time': PrevalenceOverTimeComponent;
         }
     }
 }
@@ -1952,7 +2073,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+        'gs-aggregate': AggregateComponent;
     }
 }
 
@@ -1960,7 +2081,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+            'gs-aggregate': AggregateComponent;
         }
     }
 }
@@ -1968,11 +2089,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-date-range-filter': DateRangeFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.dateRangeFilterChanged]: CustomEvent<Record<string, string>>;
-        [gsEventNames.dateRangeOptionChanged]: DateRangeOptionChangedEvent;
+        'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
     }
 }
 
@@ -1980,7 +2097,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-date-range-filter': DateRangeFilterComponent;
+            'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
         }
     }
 }
@@ -1988,10 +2105,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-location-filter': LocationFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.locationChanged]: LocationChangedEvent;
+        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
     }
 }
 
@@ -1999,7 +2113,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-location-filter': LocationFilterComponent;
+            'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
         }
     }
 }
@@ -2007,10 +2121,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-text-filter': TextFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.textFilterChanged]: TextFilterChangedEvent;
+        'gs-mutations-over-time': MutationsOverTimeComponent;
     }
 }
 
@@ -2018,7 +2129,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-text-filter': TextFilterComponent;
+            'gs-mutations-over-time': MutationsOverTimeComponent;
         }
     }
 }
@@ -2026,10 +2137,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutation-filter': MutationFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.mutationFilterChanged]: CustomEvent<MutationsFilter>;
+        'gs-queries-over-time': QueriesOverTimeComponent;
     }
 }
 
@@ -2037,7 +2145,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-mutation-filter': MutationFilterComponent;
+            'gs-queries-over-time': QueriesOverTimeComponent;
         }
     }
 }
@@ -2045,11 +2153,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-lineage-filter': LineageFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.lineageFilterChanged]: LineageFilterChangedEvent;
-        [gsEventNames.lineageFilterMultiChanged]: LineageMultiFilterChangedEvent;
+        'gs-statistics': StatisticsComponent;
     }
 }
 
@@ -2057,7 +2161,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-lineage-filter': LineageFilterComponent;
+            'gs-statistics': StatisticsComponent;
         }
     }
 }
@@ -2065,11 +2169,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-number-range-filter': NumberRangeFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.numberRangeFilterChanged]: NumberRangeFilterChangedEvent;
-        [gsEventNames.numberRangeValueChanged]: NumberRangeValueChangedEvent;
+        'gs-sequences-by-location': SequencesByLocationComponent;
     }
 }
 
@@ -2077,7 +2177,7 @@ declare global {
 declare global {
     namespace React.JSX {
         interface IntrinsicElements {
-            'gs-number-range-filter': NumberRangeFilterComponent;
+            'gs-sequences-by-location': SequencesByLocationComponent;
         }
     }
 }