@genspectrum/dashboard-components 1.7.0 → 1.8.0

package/custom-elements.json

@@ -110,6 +110,14 @@
           },
           "default": "{ ...Template, args: { lapis: 'https://url.to.lapis-definitely-not-a-valid-url', }, play: async ({ canvasElement }) => { const canvas = within(canvasElement); await waitFor(async () => { await expect( canvas.getByText('Error in gs-app: Cannot fetch reference genome.', { exact: false }), ).toBeVisible(); }); }, }"
         },
+        {
+          "kind": "variable",
+          "name": "ProvidesMutationLinkTemplateToChildren",
+          "type": {
+            "text": "StoryObj<StoryProps>"
+          },
+          "default": "{ ...Template, play: async ({ canvasElement }) => { const canvas = within(canvasElement); await waitFor(async () => { await expect(canvas.getByText('http://foo.com/query?nucMut={{mutation}}', { exact: false })).toBeVisible(); await expect(canvas.getByText('http://foo.com/query?aaMut={{mutation}}', { exact: false })).toBeVisible(); }); }, }"
+        },
         {
           "kind": "class",
           "description": "",
@@ -138,6 +146,14 @@
                 "text": "MutationAnnotations"
               },
               "default": "[]"
+            },
+            {
+              "kind": "field",
+              "name": "mutationLinkTemplate",
+              "type": {
+                "text": "MutationLinkTemplate"
+              },
+              "default": "{}"
             }
           ],
           "superclass": {
@@ -189,6 +205,14 @@
             "module": "src/web-components/gs-app.stories.ts"
           }
         },
+        {
+          "kind": "js",
+          "name": "ProvidesMutationLinkTemplateToChildren",
+          "declaration": {
+            "name": "ProvidesMutationLinkTemplateToChildren",
+            "module": "src/web-components/gs-app.stories.ts"
+          }
+        },
         {
           "kind": "custom-element-definition",
           "name": "gs-app-display",
@@ -227,6 +251,16 @@
               "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.",
               "attribute": "mutationAnnotations"
+            },
+            {
+              "kind": "field",
+              "name": "mutationLinkTemplate",
+              "type": {
+                "text": "{\n        nucleotideMutation?: string;\n        aminoAcidMutation?: string;\n    }"
+              },
+              "default": "{ nucleotideMutation: undefined, aminoAcidMutation: undefined, }",
+              "description": "Supply a link template for nucleotide and amino acid mutations.\nThe template should include '{{mutation}}' where the mutation code will be inserted, for example:\n\n    https://my-site.org/query?nucleotideMutation={{mutation}}",
+              "attribute": "mutationLinkTemplate"
             }
           ],
           "attributes": [
@@ -247,6 +281,15 @@
               "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.",
               "fieldName": "mutationAnnotations"
+            },
+            {
+              "name": "mutationLinkTemplate",
+              "type": {
+                "text": "{\n        nucleotideMutation?: string;\n        aminoAcidMutation?: string;\n    }"
+              },
+              "default": "{ nucleotideMutation: undefined, aminoAcidMutation: undefined, }",
+              "description": "Supply a link template for nucleotide and amino acid mutations.\nThe template should include '{{mutation}}' where the mutation code will be inserted, for example:\n\n    https://my-site.org/query?nucleotideMutation={{mutation}}",
+              "fieldName": "mutationLinkTemplate"
             }
           ],
           "superclass": {
@@ -1798,12 +1841,50 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/web-components/mutation-link-template-context.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "mutationLinkTemplateSchema"
+        },
+        {
+          "kind": "variable",
+          "name": "mutationLinkTemplateContext"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "mutationLinkTemplateSchema",
+          "declaration": {
+            "name": "mutationLinkTemplateSchema",
+            "module": "src/web-components/mutation-link-template-context.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "mutationLinkTemplateContext",
+          "declaration": {
+            "name": "mutationLinkTemplateContext",
+            "module": "src/web-components/mutation-link-template-context.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/web-components/mutationAnnotations.mdx",
       "declarations": [],
       "exports": []
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/web-components/mutationLinks.mdx",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "src/web-components/reference-genome-context.ts",

package/dist/components.d.ts

@@ -130,6 +130,16 @@ export declare class AppComponent extends LitElement {
         aminoAcidMutations?: string[];
         aminoAcidPositions?: string[];
     }[];
+    /**
+     * Supply a link template for nucleotide and amino acid mutations.
+     * The template should include '{{mutation}}' where the mutation code will be inserted, for example:
+     *
+     *     https://my-site.org/query?nucleotideMutation={{mutation}}
+     */
+    mutationLinkTemplate: {
+        nucleotideMutation?: string;
+        aminoAcidMutation?: string;
+    };
     /* Excluded from this release type: referenceGenome */
     /* Excluded from this release type: updateReferenceGenome */
     render(): TemplateResult<1> | undefined;
@@ -499,6 +509,7 @@ export declare class MutationComparisonComponent extends PreactLitAdapterWithGri
      */
     pageSize: boolean | number;
     /* Excluded from this release type: mutationAnnotations */
+    /* Excluded from this release type: mutationLinkTemplate */
     render(): JSX_2.Element;
 }
 
@@ -585,6 +596,19 @@ export declare class MutationFilterComponent extends PreactLitAdapter {
     render(): JSX_2.Element;
 }
 
+declare type MutationLinkTemplate = default_2.infer<typeof mutationLinkTemplateSchema>;
+
+declare const mutationLinkTemplateSchema: default_2.ZodObject<{
+    nucleotideMutation: default_2.ZodOptional<default_2.ZodString>;
+    aminoAcidMutation: default_2.ZodOptional<default_2.ZodString>;
+}, "strip", default_2.ZodTypeAny, {
+    nucleotideMutation?: string | undefined;
+    aminoAcidMutation?: string | undefined;
+}, {
+    nucleotideMutation?: string | undefined;
+    aminoAcidMutation?: string | undefined;
+}>;
+
 /**
  * ## Context
  *
@@ -687,6 +711,7 @@ export declare class MutationsComponent extends PreactLitAdapterWithGridJsStyles
      */
     pageSize: boolean | number;
     /* Excluded from this release type: mutationAnnotations */
+    /* Excluded from this release type: mutationLinkTemplate */
     render(): JSX_2.Element;
 }
 
@@ -796,6 +821,7 @@ export declare class MutationsOverTimeComponent extends PreactLitAdapterWithGrid
      */
     pageSizes: number[] | number;
     /* Excluded from this release type: mutationAnnotations */
+    /* Excluded from this release type: mutationLinkTemplate */
     render(): JSX_2.Element;
 }
 
@@ -1595,6 +1621,7 @@ export declare class WastewaterMutationsOverTimeComponent extends PreactLitAdapt
      */
     pageSizes: number[] | number;
     /* Excluded from this release type: mutationAnnotations */
+    /* Excluded from this release type: mutationLinkTemplate */
     render(): JSX_2.Element;
 }
 
@@ -1674,7 +1701,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
+        'gs-prevalence-over-time': PrevalenceOverTimeComponent;
     }
 }
 
@@ -1682,7 +1709,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-relative-growth-advantage': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-prevalence-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1690,7 +1717,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-prevalence-over-time': PrevalenceOverTimeComponent;
+        'gs-relative-growth-advantage': RelativeGrowthAdvantageComponent;
     }
 }
 
@@ -1698,7 +1725,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>;
         }
     }
 }
@@ -1786,11 +1813,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-date-range-filter': DateRangeFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        [gsEventNames.dateRangeFilterChanged]: CustomEvent<Record<string, string>>;
-        [gsEventNames.dateRangeOptionChanged]: DateRangeOptionChangedEvent;
+        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
     }
 }
 
@@ -1798,7 +1821,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>;
         }
     }
 }
@@ -1806,10 +1829,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;
     }
 }
 
@@ -1817,7 +1841,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-date-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1844,10 +1868,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutation-filter': MutationFilterComponent;
+        'gs-location-filter': LocationFilterComponent;
     }
     interface HTMLElementEventMap {
-        [gsEventNames.mutationFilterChanged]: CustomEvent<MutationsFilter>;
+        [gsEventNames.locationChanged]: LocationChangedEvent;
     }
 }
 
@@ -1855,7 +1879,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-mutation-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1863,10 +1887,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-lineage-filter': LineageFilterComponent;
+        'gs-mutation-filter': MutationFilterComponent;
     }
     interface HTMLElementEventMap {
-        [gsEventNames.lineageFilterChanged]: LineageFilterChangedEvent;
+        [gsEventNames.mutationFilterChanged]: CustomEvent<MutationsFilter>;
     }
 }
 
@@ -1874,7 +1898,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-lineage-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-mutation-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1882,11 +1906,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-number-range-filter': NumberRangeFilterComponent;
+        'gs-lineage-filter': LineageFilterComponent;
     }
     interface HTMLElementEventMap {
-        [gsEventNames.numberRangeFilterChanged]: NumberRangeFilterChangedEvent;
-        [gsEventNames.numberRangeValueChanged]: NumberRangeValueChangedEvent;
+        [gsEventNames.lineageFilterChanged]: LineageFilterChangedEvent;
     }
 }
 
@@ -1894,7 +1917,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-number-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-lineage-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1902,7 +1925,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+        'gs-number-range-filter': NumberRangeFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.numberRangeFilterChanged]: NumberRangeFilterChangedEvent;
+        [gsEventNames.numberRangeValueChanged]: NumberRangeValueChangedEvent;
     }
 }
 
@@ -1910,7 +1937,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-wastewater-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-number-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }