@genspectrum/dashboard-components 0.10.4 → 0.11.0

package/dist/components.d.ts

@@ -35,12 +35,17 @@ export declare class AggregateComponent extends PreactLitAdapterWithGridJsStyles
     /**
      * A list of tabs with views that this component should provide.
      */
-    views: View[];
+    views: AggregateView[];
     /**
      * The filter to apply to the data.
      * It must be a valid LAPIS filter object.
      */
-    filter: LapisFilter;
+    lapisFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * The width of the component.
      *
@@ -70,6 +75,10 @@ export declare class AggregateComponent extends PreactLitAdapterWithGridJsStyles
     render(): JSX_2.Element;
 }
 
+declare type AggregateView = default_2.infer<typeof aggregateViewSchema>;
+
+declare const aggregateViewSchema: default_2.ZodLiteral<"table">;
+
 /**
  * ## Context
  *
@@ -187,9 +196,9 @@ export declare class DateRangeSelectorComponent extends PreactLitAdapter {
      */
     width: string;
     /**
-     * The name of the column in LAPIS that contains the date information.
+     * The name of the metadata field in LAPIS that contains the date information.
      */
-    dateColumn: string;
+    lapisDateField: string;
     render(): JSX_2.Element;
 }
 
@@ -199,10 +208,6 @@ declare class ErrorEvent_2 extends Event {
 }
 export { ErrorEvent_2 as ErrorEvent }
 
-declare type LapisFilter = default_2.infer<typeof lapisFilterSchema>;
-
-declare const lapisFilterSchema: default_2.ZodRecord<default_2.ZodString, default_2.ZodUnion<[default_2.ZodString, default_2.ZodNumber, default_2.ZodNull, default_2.ZodBoolean]>>;
-
 /**
  *
  * ## Context
@@ -343,7 +348,12 @@ export declare class MutationComparisonComponent extends PreactLitAdapterWithGri
      * It should be human-readable.
      */
     lapisFilters: {
-        lapisFilter: Record<string, string | number | null | boolean>;
+        lapisFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+            nucleotideMutations?: string[];
+            aminoAcidMutations?: string[];
+            nucleotideInsertions?: string[];
+            aminoAcidInsertions?: string[];
+        };
         displayName: string;
     }[];
     /**
@@ -471,7 +481,12 @@ export declare class MutationsComponent extends PreactLitAdapterWithGridJsStyles
     /**
      * LAPIS filter to select the displayed data. If not provided, all data is displayed.
      */
-    lapisFilter: Record<string, string | number | null | boolean>;
+    lapisFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * The type of the sequence for which the mutations should be shown.
      */
@@ -529,7 +544,12 @@ export declare class MutationsOverTimeComponent extends PreactLitAdapterWithGrid
     /**
      * LAPIS filter to select the displayed data. If not provided, all data is displayed.
      */
-    lapisFilter: Record<string, string | number | null | boolean>;
+    lapisFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * The type of the sequence for which the mutations should be shown.
      */
@@ -587,11 +607,13 @@ export declare class NumberSequencesOverTimeComponent extends PreactLitAdapterWi
      * The `displayName` will be used to label the component views.
      * It should be human-readable.
      *
-     */ lapisFilter: {
-        lapisFilter: Record<string, string | number | null | boolean>;
-        displayName: string;
-    } | {
-        lapisFilter: Record<string, string | number | null | boolean>;
+     */ lapisFilters: {
+        lapisFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+            nucleotideMutations?: string[];
+            aminoAcidMutations?: string[];
+            nucleotideInsertions?: string[];
+            aminoAcidInsertions?: string[];
+        };
         displayName: string;
     }[];
     /**
@@ -700,18 +722,25 @@ export declare class PrevalenceOverTimeComponent extends PreactLitAdapterWithGri
      * It should be human-readable.
      *
      */
-    numeratorFilter: {
-        lapisFilter: Record<string, string | number | null | boolean>;
-        displayName: string;
-    } | {
-        lapisFilter: Record<string, string | number | null | boolean>;
+    numeratorFilters: {
+        lapisFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+            nucleotideMutations?: string[];
+            aminoAcidMutations?: string[];
+            nucleotideInsertions?: string[];
+            aminoAcidInsertions?: string[];
+        };
         displayName: string;
     }[];
     /**
      * The LAPIS filter, to select the data of the reference.
      * It must be a valid LAPIS filter object.
      */
-    denominatorFilter: Record<string, string | number | null | boolean>;
+    denominatorFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * The granularity of the time axis.
      */
@@ -854,12 +883,22 @@ export declare class RelativeGrowthAdvantageComponent extends PreactLitAdapter {
      * LAPIS filter to select the data of the focal variant.
      * It must be a valid LAPIS filter object.
      */
-    numeratorFilter: Record<string, string | number | null | boolean>;
+    numeratorFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * LAPIS filter to select the data of the baseline variant.
      * It must be a valid LAPIS filter object.
      */
-    denominatorFilter: Record<string, string | number | null | boolean>;
+    denominatorFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * The generation time represents the number of days over which the variant's relative growth advantage is measured.
      * For example, if we set a generation time of 7 days, then we estimate the growth advantage per week.
@@ -996,7 +1035,12 @@ export declare class SequencesByLocationComponent extends PreactLitAdapterWithGr
      * If you want to display the distribution over the states of a certain country,
      * you should usually filter by that country here (e.g. { country: 'USA' }).
      */
-    lapisFilter: Record<string, string | number | null | boolean>;
+    lapisFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * Required.
      *
@@ -1072,12 +1116,22 @@ export declare class StatisticsComponent extends PreactLitAdapterWithGridJsStyle
      * The filter to apply to the data for the overall number of sequences and as the numerator for the proportion.
      * It must be a valid LAPIS filter object.
      */
-    numeratorFilter: LapisFilter;
+    numeratorFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * The filter to apply to the data for the denominator of the proportion.
      * It must be a valid LAPIS filter object.
      */
-    denominatorFilter: LapisFilter;
+    denominatorFilter: Record<string, string | string[] | number | null | boolean | undefined> & {
+        nucleotideMutations?: string[];
+        aminoAcidMutations?: string[];
+        nucleotideInsertions?: string[];
+        aminoAcidInsertions?: string[];
+    };
     /**
      * The width of the component.
      *
@@ -1139,10 +1193,6 @@ export declare class UserFacingError extends Error {
     constructor(headline: string, message: string);
 }
 
-declare type View = default_2.infer<typeof viewSchema>;
-
-declare const viewSchema: default_2.ZodLiteral<"table">;
-
 export { }
 
 
@@ -1235,7 +1285,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-aggregate': AggregateComponent;
+        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
     }
 }
 
@@ -1243,7 +1293,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-aggregate': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-number-sequences-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1251,7 +1301,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
+        'gs-aggregate': AggregateComponent;
     }
 }
 
@@ -1259,7 +1309,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-number-sequences-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-aggregate': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1267,7 +1317,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-sequences-by-location': SequencesByLocationComponent;
+        'gs-mutations-over-time': MutationsOverTimeComponent;
     }
 }
 
@@ -1275,7 +1325,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-sequences-by-location': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1283,7 +1333,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutations-over-time': MutationsOverTimeComponent;
+        'gs-sequences-by-location': SequencesByLocationComponent;
     }
 }
 
@@ -1291,7 +1341,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-sequences-by-location': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1315,10 +1365,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-location-filter': LocationFilterComponent;
+        'gs-date-range-selector': DateRangeSelectorComponent;
     }
     interface HTMLElementEventMap {
-        'gs-location-changed': CustomEvent<Record<string, string>>;
+        'gs-date-range-filter-changed': CustomEvent<Record<string, string>>;
+        'gs-date-range-option-changed': DateRangeOptionChangedEvent;
     }
 }
 
@@ -1326,7 +1377,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-date-range-selector': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1334,11 +1385,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-date-range-selector': DateRangeSelectorComponent;
+        'gs-location-filter': LocationFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-date-range-filter-changed': CustomEvent<Record<string, string>>;
-        'gs-date-range-option-changed': DateRangeOptionChangedEvent;
+        'gs-location-changed': CustomEvent<Record<string, string>>;
     }
 }
 
@@ -1346,7 +1396,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-date-range-selector': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1376,7 +1426,7 @@ declare global {
         'gs-mutation-filter': MutationFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-mutation-filter-changed': CustomEvent<SelectedMutationFilterStrings>;
+        'gs-mutation-filter-changed': CustomEvent<MutationsFilter>;
     }
 }