Allow setting a note to show with layer filters (#11)

* docs(changeset): Allow setting a note to show with layer filters * Add optional note when setting layer filter
felt · Dec 2, 2024 · 4bbde62 · 4bbde62
1 parent 6e911d9
commit 4bbde62
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 12 deletions.
diff --git a/.changeset/weak-flowers-teach.md b/.changeset/weak-flowers-teach.md
@@ -0,0 +1,5 @@
+---
+"@feltmaps/js-sdk": minor
+---
+
+Allow setting a note to show with layer filters
diff --git a/docs/Layers/LayersController.md b/docs/Layers/LayersController.md
@@ -332,17 +332,18 @@ console.log(filters.combined, filters.style, filters.ephemeral, filters.componen
 
 ### setLayerFilters()
 
-> **setLayerFilters**(`params`: \{`layerId`: `string`;`filters`: [`Filters`](Filters.md); }): `Promise`\<`void`>
+> **setLayerFilters**(`params`: \{`layerId`: `string`;`filters`: [`Filters`](Filters.md);`note`: `string`; }): `Promise`\<`void`>
 
 Sets the **ephemeral** filters for a layer.
 
 #### Parameters
 
-| Parameter        | Type                    | Description                                                                                                     |
-| ---------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------- |
-| `params`         | `object`                | -                                                                                                               |
-| `params.layerId` | `string`                | The layer that you want to set the filters for.                                                                 |
-| `params.filters` | [`Filters`](Filters.md) | The filters to set for the layer. This will replace any ephemeral filters that are currently set for the layer. |
+| Parameter        | Type                    | Description                                                                                                                                                          |
+| ---------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `params`         | `object`                | -                                                                                                                                                                    |
+| `params.layerId` | `string`                | The layer that you want to set the filters for.                                                                                                                      |
+| `params.filters` | [`Filters`](Filters.md) | The filters to set for the layer. This will replace any ephemeral filters that are currently set for the layer.                                                      |
+| `params.note`?   | `string`                | A note to display on the layer legend when this filter is applied. When the note is shown, a reset button will also be shown, allowing the user to clear the filter. |
 
 #### Returns
 

diff --git a/docs/Main/FeltController.md b/docs/Main/FeltController.md
@@ -503,17 +503,18 @@ console.log(filters.combined, filters.style, filters.ephemeral, filters.componen
 
 ### setLayerFilters()
 
-> **setLayerFilters**(`params`: \{`layerId`: `string`;`filters`: [`Filters`](../Layers/Filters.md); }): `Promise`\<`void`>
+> **setLayerFilters**(`params`: \{`layerId`: `string`;`filters`: [`Filters`](../Layers/Filters.md);`note`: `string`; }): `Promise`\<`void`>
 
 Sets the **ephemeral** filters for a layer.
 
 #### Parameters
 
-| Parameter        | Type                              | Description                                                                                                     |
-| ---------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------- |
-| `params`         | `object`                          | -                                                                                                               |
-| `params.layerId` | `string`                          | The layer that you want to set the filters for.                                                                 |
-| `params.filters` | [`Filters`](../Layers/Filters.md) | The filters to set for the layer. This will replace any ephemeral filters that are currently set for the layer. |
+| Parameter        | Type                              | Description                                                                                                                                                          |
+| ---------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `params`         | `object`                          | -                                                                                                                                                                    |
+| `params.layerId` | `string`                          | The layer that you want to set the filters for.                                                                                                                      |
+| `params.filters` | [`Filters`](../Layers/Filters.md) | The filters to set for the layer. This will replace any ephemeral filters that are currently set for the layer.                                                      |
+| `params.note`?   | `string`                          | A note to display on the layer legend when this filter is applied. When the note is shown, a reset button will also be shown, allowing the user to clear the filter. |
 
 #### Returns
 

diff --git a/etc/js-sdk.api.md b/etc/js-sdk.api.md
@@ -296,6 +296,7 @@ export interface LayersController {
     setLayerFilters(params: {
         layerId: string;
         filters: Filters;
+        note?: string;
     }): Promise<void>;
     setLayerGroupVisibility(visibility: SetVisibilityRequest): Promise<void>;
     setLayerStyle(params: {

diff --git a/src/modules/layers/controller.ts b/src/modules/layers/controller.ts
@@ -352,6 +352,13 @@ export interface LayersController {
      * that are currently set for the layer.
      */
     filters: Filters;
+
+    /**
+     * A note to display on the layer legend when this filter is applied. When the
+     * note is shown, a reset button will also be shown, allowing the user to clear
+     * the filter.
+     */
+    note?: string;
   }): Promise<void>;
 
   /**

diff --git a/src/modules/layers/schema.ts b/src/modules/layers/schema.ts
@@ -86,6 +86,7 @@ const SetFiltersMessage = methodMessage(
   z.object({
     layerId: z.string(),
     filters: FiltersSchema,
+    note: z.string().optional(),
   }),
 );