@genspectrum/dashboard-components 0.16.1 → 0.16.3

package/custom-elements.json

@@ -66,6 +66,12 @@
       "declarations": [],
       "exports": []
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/web-components/gs-app.spec-d.ts",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "src/web-components/gs-app.stories.ts",
@@ -82,15 +88,15 @@
           "kind": "variable",
           "name": "Default",
           "type": {
-            "text": "StoryObj<{ lapis: string }>"
+            "text": "StoryObj<StoryProps>"
           },
-          "default": "{ ...Template, play: async ({ canvasElement }) => { const canvas = within(canvasElement); await waitFor(async () => { await expect(canvas.getByText(LAPIS_URL)).toBeVisible(); await expect(canvas.getByText('\"name\": \"ORF1a\",', { exact: false })).toBeVisible(); }); }, }"
+          "default": "{ ...Template, play: async ({ canvasElement }) => { const canvas = within(canvasElement); await waitFor(async () => { await expect(canvas.getByText(LAPIS_URL)).toBeVisible(); await expect(canvas.getByText('\"name\": \"ORF1a\",', { exact: false })).toBeVisible(); await expect(canvas.getByText('I am an annotation!', { exact: false })).toBeVisible(); }); }, }"
         },
         {
           "kind": "variable",
           "name": "WithNoLapisUrl",
           "type": {
-            "text": "StoryObj<{ lapis: string }>"
+            "text": "StoryObj<StoryProps>"
           },
           "default": "{ ...Default, args: { ...Default.args, lapis: 'notAValidUrl', }, play: async ({ canvasElement }) => { const canvas = within(canvasElement); await waitFor(async () => { await expect(canvas.getByText(\"Error: Invalid LAPIS URL: 'notAValidUrl'\", { exact: false })).toBeVisible(); }); }, }"
         },
@@ -98,7 +104,7 @@
           "kind": "variable",
           "name": "DelayFetchingReferenceGenome",
           "type": {
-            "text": "StoryObj<{ lapis: string }>"
+            "text": "StoryObj<StoryProps>"
           },
           "default": "{ ...Template, parameters: { fetchMock: { mocks: [ { matcher: { name: 'referenceGenome', url: REFERENCE_GENOME_ENDPOINT, }, response: { status: 200, body: referenceGenome, }, options: { delay: 5000, }, }, ], }, }, }"
         },
@@ -106,7 +112,7 @@
           "kind": "variable",
           "name": "FailsToFetchReferenceGenome",
           "type": {
-            "text": "StoryObj<{ lapis: string }>"
+            "text": "StoryObj<StoryProps>"
           },
           "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: Cannot fetch reference genome.', { exact: false })).toBeVisible(); }); }, }"
         },
@@ -130,6 +136,14 @@
                 "text": "ReferenceGenome"
               },
               "default": "{ nucleotideSequences: [], genes: [], }"
+            },
+            {
+              "kind": "field",
+              "name": "mutationAnnotations",
+              "type": {
+                "text": "MutationAnnotations"
+              },
+              "default": "[]"
             }
           ],
           "superclass": {
@@ -197,7 +211,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "## Context\n\nThis component provides the main application context.\nAll other `gs-*` components must be (possibly nested) children of this component.\nIt makes use of the [Lit Context](https://lit.dev/docs/data/context/) to\n- provide the URL to the LAPIS instance to all its children\n- fetch the reference genomes from LAPIS and provide it to all its children\n\nThis will show an error message if the reference genome cannot be fetched\n(e.g., due to an invalid LAPIS URL).\n\n## Shadow DOM\n\nThis component does __not__ use a shadow DOM. Children of this component will be rendered directly in the light DOM.",
+          "description": "## Context\n\nThis component provides the main application context.\nAll other `gs-*` components must be (possibly nested) children of this component.\nIt makes use of the [Lit Context](https://lit.dev/docs/data/context/) to\n- provide the URL to the LAPIS instance to all its children\n- fetch the reference genomes from LAPIS and provide it to all its children\n- distribute the mutation annotations config to its children\n\nThis will show an error message if the reference genome cannot be fetched\n(e.g., due to an invalid LAPIS URL).\n\n## Shadow DOM\n\nThis component does __not__ use a shadow DOM. Children of this component will be rendered directly in the light DOM.",
           "name": "AppComponent",
           "members": [
             {
@@ -209,6 +223,16 @@
               "default": "''",
               "description": "Required.\n\nThe URL of the LAPIS instance that all children of this component will use.",
               "attribute": "lapis"
+            },
+            {
+              "kind": "field",
+              "name": "mutationAnnotations",
+              "type": {
+                "text": "{\n        name: string;\n        description: string;\n        symbol: string;\n        nucleotideMutations: string[];\n        aminoAcidMutations: string[];\n    }[]"
+              },
+              "default": "[]",
+              "description": "Supply lists of mutations that are especially relevant for the current organism.\nWhenever other components display mutations, matching mutations will be highlighted by appending the `symbol`.\nOn hover, a tooltip with the `name` and `description` will be shown.",
+              "attribute": "mutationAnnotations"
             }
           ],
           "attributes": [
@@ -220,6 +244,15 @@
               "default": "''",
               "description": "Required.\n\nThe URL of the LAPIS instance that all children of this component will use.",
               "fieldName": "lapis"
+            },
+            {
+              "name": "mutationAnnotations",
+              "type": {
+                "text": "{\n        name: string;\n        description: string;\n        symbol: string;\n        nucleotideMutations: string[];\n        aminoAcidMutations: string[];\n    }[]"
+              },
+              "default": "[]",
+              "description": "Supply lists of mutations that are especially relevant for the current organism.\nWhenever other components display mutations, matching mutations will be highlighted by appending the `symbol`.\nOn hover, a tooltip with the `name` and `description` will be shown.",
+              "fieldName": "mutationAnnotations"
             }
           ],
           "superclass": {
@@ -1424,6 +1457,38 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/web-components/mutation-annotations-context.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "mutationAnnotationsSchema"
+        },
+        {
+          "kind": "variable",
+          "name": "mutationAnnotationsContext"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "mutationAnnotationsSchema",
+          "declaration": {
+            "name": "mutationAnnotationsSchema",
+            "module": "src/web-components/mutation-annotations-context.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "mutationAnnotationsContext",
+          "declaration": {
+            "name": "mutationAnnotationsContext",
+            "module": "src/web-components/mutation-annotations-context.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/web-components/reference-genome-context.ts",
@@ -4147,7 +4212,7 @@
           "type": {
             "text": "StoryObj<WastewaterMutationsOverTimeProps & { infoText: string }>"
           },
-          "default": "{ render: (args) => html` <gs-app lapis=\"${WISE_LAPIS_URL}\"> <gs-wastewater-mutations-over-time .lapisFilter=${args.lapisFilter} .sequenceType=${args.sequenceType} .width=${args.width} .height=${args.height} .maxNumberOfGridRows=${args.maxNumberOfGridRows} > <span slot=\"infoText\">${args.infoText}</span> </gs-wastewater-mutations-over-time> </gs-app> `, parameters: { fetchMock: { mocks: [ { matcher: { name: 'details', url: WISE_DETAILS_ENDPOINT, body: { fields: ['date', 'location', 'nucleotideMutationFrequency', 'aminoAcidMutationFrequency'], versionStatus: 'LATEST_VERSION', isRevocation: false, }, }, response: { status: 200, body: details, }, }, ], }, }, }"
+          "default": "{ render: (args) => html` <gs-app lapis=\"${WISE_LAPIS_URL}\" .mutationAnnotations=${mutationAnnotations}> <gs-wastewater-mutations-over-time .lapisFilter=${args.lapisFilter} .sequenceType=${args.sequenceType} .width=${args.width} .height=${args.height} .maxNumberOfGridRows=${args.maxNumberOfGridRows} > <span slot=\"infoText\">${args.infoText}</span> </gs-wastewater-mutations-over-time> </gs-app> `, parameters: { fetchMock: { mocks: [ { matcher: { name: 'details', url: WISE_DETAILS_ENDPOINT, body: { fields: ['date', 'location', 'nucleotideMutationFrequency', 'aminoAcidMutationFrequency'], versionStatus: 'LATEST_VERSION', isRevocation: false, }, }, response: { status: 200, body: details, }, }, ], }, }, }"
         },
         {
           "kind": "variable",