@genspectrum/dashboard-components 0.1.1

package/dist/genspectrum-components.d.ts

@@ -0,0 +1,298 @@
+import { CSSResult } from 'lit';
+import { default as default_2 } from 'zod';
+import { JSX as JSX_2 } from 'preact';
+import { JSXInternal } from 'preact/src/jsx';
+import { LitElement } from 'lit';
+import { PropertyValues } from '@lit/reactive-element';
+import { ReactiveElement } from '@lit/reactive-element';
+import { TemplateResult } from 'lit-html';
+
+export declare class App extends LitElement {
+    lapis: string;
+    referenceGenome: ReferenceGenome;
+    private updateReferenceGenome;
+    render(): TemplateResult<1> | undefined;
+    createRenderRoot(): this;
+}
+
+declare type ConfidenceIntervalMethod = 'wilson' | 'none';
+
+declare type CustomSelectOption = {
+    label: string;
+    dateFrom: string;
+    dateTo: string;
+};
+
+/**
+ * @fires {CustomEvent<{ dateFrom: string; dateTo: string; }>} gs-date-range-changed - When the date range has changed
+ */
+export declare class DateRangeSelectorComponent extends PreactLitAdapter {
+    customSelectOptions: CustomSelectOption[];
+    earliestDate: string | undefined;
+    render(): JSX_2.Element;
+}
+
+declare type LapisFilter = Record<string, string | number | null | boolean>;
+
+/**
+ * ## Tag
+ *
+ * `gs-location-filter`
+ *
+ * ## Context
+ *
+ * This component provides an input field to specify filters for locations.
+ *
+ * It expects a list of fields that form a strict hierarchical order, such as continent, country, and city.
+ * The component retrieves a list of all possible values for these fields from the Lapis instance.
+ * This list is then utilized to display autocomplete suggestions and to validate the input.
+ *
+ * Given `fields` are `['field1', 'field2', ..., 'fieldN']`,
+ * then valid values for the location filter must be in the form `valueForField1 / valueForField2 / ... / valueForFieldK`,
+ * where `1 <= K <= N`.
+ * Values for the fields `i > K` are considered `undefined`.
+ *
+ * @fires {CustomEvent<Record<string, string>>} gs-location-changed
+ * Fired when the field is submitted with a valid location value.
+ * The `details` of this event contain an object with all `fields` as keys
+ * and the corresponding values as values, if they are not `undefined`.
+ * Example:
+ * ```
+ * {
+ *   continent: "Asia",
+ *   country: "China",
+ *   city: "Beijing"
+ * }
+ * ```
+ */
+export declare class LocationFilterComponent extends PreactLitAdapter {
+    /**
+     * The initial value to use for this location filter.
+     * Must be of the form `valueForField1 / valueForField2 / ... / valueForFieldN`.
+     */
+    value: string;
+    /**
+     * The fields to display in the location filter, in hierarchical order.
+     * The top-level field should be the first entry in the array.
+     * This component assumes that the values for each field form a strict hierarchy
+     * (e.g., `fields = ['continent', 'country', 'city']`).
+     */
+    fields: string[];
+    render(): JSX_2.Element;
+}
+
+export declare class MutationComparisonComponent extends PreactLitAdapterWithGridJsStyles {
+    variants: MutationComparisonVariant[];
+    sequenceType: SequenceType;
+    views: View[];
+    render(): JSX_2.Element;
+}
+
+declare interface MutationComparisonVariant {
+    lapisFilter: LapisFilter;
+    displayName: string;
+}
+
+/**
+ * @fires {CustomEvent<SelectedMutationFilterStrings>} gs-mutation-filter-changed - When the mutation filter values have changed
+ * @fires {CustomEvent<SelectedMutationFilterStrings>} gs-mutation-filter-on-blur - When the mutation filter has lost focus
+ */
+export declare class MutationFilterComponent extends PreactLitAdapter {
+    render(): JSX_2.Element;
+}
+
+export declare class MutationsComponent extends PreactLitAdapterWithGridJsStyles {
+    variant: LapisFilter;
+    sequenceType: SequenceType;
+    views: View_2[];
+    render(): JSX_2.Element;
+}
+
+declare type NamedLapisFilter = LapisFilter & {
+    displayName: string;
+};
+
+declare abstract class PreactLitAdapter extends ReactiveElement {
+    static styles: CSSResult[];
+    /* Excluded from this release type: lapis */
+    /* Excluded from this release type: referenceGenome */
+    update(changedProperties: PropertyValues): void;
+    protected abstract render(): JSXInternal.Element;
+}
+
+declare abstract class PreactLitAdapterWithGridJsStyles extends PreactLitAdapter {
+    static styles: CSSResult[];
+}
+
+export declare class PrevalenceOverTimeComponent extends PreactLitAdapterWithGridJsStyles {
+    numerator: NamedLapisFilter | NamedLapisFilter[];
+    denominator: NamedLapisFilter;
+    granularity: TemporalGranularity;
+    smoothingWindow: number;
+    views: View_3[];
+    confidenceIntervalMethods: ConfidenceIntervalMethod[];
+    render(): JSX_2.Element;
+}
+
+declare type ReferenceGenome = default_2.infer<typeof referenceGenomeResponse>;
+
+declare const referenceGenomeResponse: default_2.ZodObject<{
+    nucleotideSequences: default_2.ZodArray<default_2.ZodObject<{
+        name: default_2.ZodString;
+        sequence: default_2.ZodString;
+    }, "strip", default_2.ZodTypeAny, {
+        name: string;
+        sequence: string;
+    }, {
+        name: string;
+        sequence: string;
+    }>, "many">;
+    genes: default_2.ZodArray<default_2.ZodObject<{
+        name: default_2.ZodString;
+        sequence: default_2.ZodString;
+    }, "strip", default_2.ZodTypeAny, {
+        name: string;
+        sequence: string;
+    }, {
+        name: string;
+        sequence: string;
+    }>, "many">;
+}, "strip", default_2.ZodTypeAny, {
+    nucleotideSequences: {
+        name: string;
+        sequence: string;
+    }[];
+    genes: {
+        name: string;
+        sequence: string;
+    }[];
+}, {
+    nucleotideSequences: {
+        name: string;
+        sequence: string;
+    }[];
+    genes: {
+        name: string;
+        sequence: string;
+    }[];
+}>;
+
+export declare class RelativeGrowthAdvantageComponent extends PreactLitAdapter {
+    numerator: LapisFilter;
+    denominator: LapisFilter;
+    generationTime: number;
+    views: View_4[];
+    render(): JSX_2.Element;
+}
+
+declare type SequenceType = 'nucleotide' | 'amino acid';
+
+declare type TemporalGranularity = 'day' | 'week' | 'month' | 'year';
+
+/**
+ * @fires {CustomEvent<Record<string, string>>} gs-text-input-changed - When the text input has changed
+ */
+export declare class TextInputComponent extends PreactLitAdapter {
+    lapisField: string;
+    placeholderText: string;
+    render(): JSX_2.Element;
+}
+
+declare type View = 'table' | 'venn';
+
+declare type View_2 = 'table' | 'grid' | 'insertions';
+
+declare type View_3 = 'bar' | 'line' | 'bubble' | 'table';
+
+declare type View_4 = 'line';
+
+export { }
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-app': App;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-date-range-selector': DateRangeSelectorComponent;
+    }
+    interface HTMLElementEventMap {
+        'gs-date-range-changed': CustomEvent<{
+            dateFrom: string;
+            dateTo: string;
+        }>;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-mutation-filter': TextInputComponent;
+    }
+    interface HTMLElementEventMap {
+        'gs-mutation-filter-changed': CustomEvent<SelectedMutationFilterStrings>;
+        'gs-mutation-filter-on-blur': CustomEvent<SelectedMutationFilterStrings>;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-text-input': TextInputComponent;
+    }
+    interface HTMLElementEventMap {
+        'gs-text-input-changed': CustomEvent<Record<string, string>>;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-location-filter': LocationFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        'gs-location-changed': CustomEvent<Record<string, string>>;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-mutation-comparison-component': MutationComparisonComponent;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-mutations-component': MutationsComponent;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-prevalence-over-time': PrevalenceOverTimeComponent;
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
+    }
+}
+
+
+declare module 'chart.js' {
+    interface CartesianScaleTypeRegistry {
+        logit: {
+            options: CoreScaleOptions;
+        };
+    }
+}
+