@genspectrum/dashboard-components 0.16.1 → 0.16.3

package/dist/components.d.ts

@@ -97,6 +97,7 @@ export declare class AggregateComponent extends PreactLitAdapterWithGridJsStyles
  * It makes use of the [Lit Context](https://lit.dev/docs/data/context/) to
  * - provide the URL to the LAPIS instance to all its children
  * - fetch the reference genomes from LAPIS and provide it to all its children
+ * - distribute the mutation annotations config to its children
  *
  * This will show an error message if the reference genome cannot be fetched
  * (e.g., due to an invalid LAPIS URL).
@@ -112,6 +113,18 @@ export declare class AppComponent extends LitElement {
      * The URL of the LAPIS instance that all children of this component will use.
      */
     lapis: string;
+    /**
+     * Supply lists of mutations that are especially relevant for the current organism.
+     * Whenever other components display mutations, matching mutations will be highlighted by appending the `symbol`.
+     * On hover, a tooltip with the `name` and `description` will be shown.
+     */
+    mutationAnnotations: {
+        name: string;
+        description: string;
+        symbol: string;
+        nucleotideMutations: string[];
+        aminoAcidMutations: string[];
+    }[];
     /* Excluded from this release type: referenceGenome */
     /* Excluded from this release type: updateReferenceGenome */
     render(): TemplateResult<1> | undefined;
@@ -332,6 +345,28 @@ export declare class LocationFilterComponent extends PreactLitAdapter {
     render(): JSX_2.Element;
 }
 
+declare type MutationAnnotations = default_2.infer<typeof mutationAnnotationsSchema>;
+
+declare const mutationAnnotationsSchema: default_2.ZodArray<default_2.ZodObject<{
+    name: default_2.ZodString;
+    description: default_2.ZodString;
+    symbol: default_2.ZodString;
+    nucleotideMutations: default_2.ZodArray<default_2.ZodString, "many">;
+    aminoAcidMutations: default_2.ZodArray<default_2.ZodString, "many">;
+}, "strip", default_2.ZodTypeAny, {
+    symbol: string;
+    name: string;
+    description: string;
+    nucleotideMutations: string[];
+    aminoAcidMutations: string[];
+}, {
+    symbol: string;
+    name: string;
+    description: string;
+    nucleotideMutations: string[];
+    aminoAcidMutations: string[];
+}>, "many">;
+
 /**
  * ## Context
  *
@@ -567,6 +602,7 @@ export declare class MutationsComponent extends PreactLitAdapterWithGridJsStyles
      * Set to `false` to disable pagination. Set to `true` to enable pagination with a default limit (10).
      */
     pageSize: boolean | number;
+    /* Excluded from this release type: mutationAnnotations */
     render(): JSX_2.Element;
 }
 
@@ -654,6 +690,7 @@ export declare class MutationsOverTimeComponent extends PreactLitAdapterWithGrid
         min: number;
         max: number;
     };
+    /* Excluded from this release type: mutationAnnotations */
     render(): JSX_2.Element;
 }
 
@@ -1328,6 +1365,7 @@ export declare class WastewaterMutationsOverTimeComponent extends PreactLitAdapt
      * The maximum number of grid rows to display.
      */
     maxNumberOfGridRows: number;
+    /* Excluded from this release type: mutationAnnotations */
     render(): JSX_2.Element;
 }
 
@@ -1391,7 +1429,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-prevalence-over-time': PrevalenceOverTimeComponent;
+        'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
     }
 }
 
@@ -1399,7 +1437,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-prevalence-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-relative-growth-advantage': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1407,7 +1445,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-aggregate': AggregateComponent;
+        'gs-prevalence-over-time': PrevalenceOverTimeComponent;
     }
 }
 
@@ -1415,7 +1453,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-aggregate': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-prevalence-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1423,7 +1461,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
+        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
     }
 }
 
@@ -1431,7 +1469,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-relative-growth-advantage': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-number-sequences-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1439,7 +1477,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
+        'gs-mutations-over-time': MutationsOverTimeComponent;
     }
 }
 
@@ -1447,7 +1485,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-number-sequences-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1455,7 +1493,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutations-over-time': MutationsOverTimeComponent;
+        'gs-aggregate': AggregateComponent;
     }
 }
 
@@ -1463,7 +1501,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-aggregate': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1471,7 +1509,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-sequences-by-location': SequencesByLocationComponent;
+        'gs-statistics': StatisticsComponent;
     }
 }
 
@@ -1479,7 +1517,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-sequences-by-location': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-statistics': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1487,7 +1525,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-statistics': StatisticsComponent;
+        'gs-location-filter': LocationFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        'gs-location-changed': LocationChangedEvent;
     }
 }
 
@@ -1495,7 +1536,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-statistics': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1503,7 +1544,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+        'gs-sequences-by-location': SequencesByLocationComponent;
     }
 }
 
@@ -1511,7 +1552,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-wastewater-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-sequences-by-location': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1519,11 +1560,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-date-range-filter': DateRangeFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        'gs-date-range-filter-changed': CustomEvent<Record<string, string>>;
-        'gs-date-range-option-changed': DateRangeOptionChangedEvent;
+        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
     }
 }
 
@@ -1531,7 +1568,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-date-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-wastewater-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1539,10 +1576,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-location-filter': LocationFilterComponent;
+        'gs-date-range-filter': DateRangeFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-location-changed': LocationChangedEvent;
+        'gs-date-range-filter-changed': CustomEvent<Record<string, string>>;
+        'gs-date-range-option-changed': DateRangeOptionChangedEvent;
     }
 }
 
@@ -1550,7 +1588,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-date-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }