Feature Contextual Action

.changeset/empty-camels-pay.md

@@ -0,0 +1,5 @@
+---
+"@feltmaps/js-sdk": minor
+---
+
+Add feature actions

docs/Main/FeltController.md

@@ -1749,6 +1749,96 @@ await felt.deleteActionTrigger("enablePolygonTool");
 
 ***
 
+## createFeatureAction()
+
+> **createFeatureAction**(`args`: [`CreateFeatureActionParams`](../UI/CreateFeatureActionParams.md)): `Promise`\<[`uiFeatureAction`](../UI/uiFeatureAction.md)>
+
+Creates a feature contextual action.
+
+### Parameters
+
+| Parameter | Type                                                              | Description                   |
+| --------- | ----------------------------------------------------------------- | ----------------------------- |
+| `args`    | [`CreateFeatureActionParams`](../UI/CreateFeatureActionParams.md) | The arguments for the method. |
+
+### Returns
+
+`Promise`\<[`uiFeatureAction`](../UI/uiFeatureAction.md)>
+
+### Example
+
+```typescript
+const myAction = await felt.createFeatureAction({
+  action: {
+    label: "Edit feature",
+    onTrigger: async ({ featureId, layerId }) => {
+      console.log(`Editing feature ${featureId} in layer ${layerId}`);
+    },
+    layerIds: ["layer-1", "layer-2"],
+  },
+  placement: { at: "start" }, // optional, defaults to { at: "end" }
+});
+```
+
+***
+
+## updateFeatureAction()
+
+> **updateFeatureAction**(`args`: [`UpdateFeatureActionParams`](../UI/UpdateFeatureActionParams.md)): `Promise`\<[`uiFeatureAction`](../UI/uiFeatureAction.md)>
+
+Updates a feature contextual action.
+
+Feature contextual action to update is identified by the `id` property.
+
+### Parameters
+
+| Parameter | Type                                                              | Description                              |
+| --------- | ----------------------------------------------------------------- | ---------------------------------------- |
+| `args`    | [`UpdateFeatureActionParams`](../UI/UpdateFeatureActionParams.md) | The feature contextual action to update. |
+
+### Returns
+
+`Promise`\<[`uiFeatureAction`](../UI/uiFeatureAction.md)>
+
+### Remarks
+
+Properties provided will override the existing properties.
+
+### Example
+
+```typescript
+await felt.updateFeatureAction({
+  id: "my-action",
+  label: "Updated action label", // only label changes
+});
+```
+
+***
+
+## deleteFeatureAction()
+
+> **deleteFeatureAction**(`id`: `string`): `void`
+
+Deletes a feature contextual action.
+
+### Parameters
+
+| Parameter | Type     | Description                                        |
+| --------- | -------- | -------------------------------------------------- |
+| `id`      | `string` | The id of the feature contextual action to delete. |
+
+### Returns
+
+`void`
+
+### Example
+
+```typescript
+await felt.deleteFeatureAction("my-action");
+```
+
+***
+
 ## createPanelId()
 
 > **createPanelId**(): `Promise`\<`string`>

docs/UI/CreateFeatureActionParams.md

@@ -0,0 +1,13 @@
+***
+
+# Properties
+
+## action
+
+> **action**: [`uiFeatureActionCreate`](uiFeatureActionCreate.md)
+
+***
+
+## placement?
+
+> `optional` **placement**: \{ `after`: `string`; } | \{ `before`: `string`; } | \{ `at`: `"start"` | `"end"`; }

docs/UI/README.md

@@ -11,6 +11,8 @@ UI features such as the legend and the full screen button.
 
 * [CreateActionTriggerParams](CreateActionTriggerParams.md)
 * [UpdateActionTriggerParams](UpdateActionTriggerParams.md)
+* [CreateFeatureActionParams](CreateFeatureActionParams.md)
+* [UpdateFeatureActionParams](UpdateFeatureActionParams.md)
 * [CreateOrUpdatePanelParams](CreateOrUpdatePanelParams.md)
 * [CreatePanelElementsParams](CreatePanelElementsParams.md)
 * [UpdatePanelElementsParams](UpdatePanelElementsParams.md)
@@ -30,6 +32,7 @@ UI features such as the legend and the full screen button.
 * [UIDividerElement](UIDividerElement.md)
 * [UIDividerElementCreate](UIDividerElementCreate.md)
 * [UIDividerElementUpdate](UIDividerElementUpdate.md)
+* [uiFeatureActionCreate](uiFeatureActionCreate.md)
 * [UIFlexibleSpaceElement](UIFlexibleSpaceElement.md)
 * [UIFlexibleSpaceElementCreate](UIFlexibleSpaceElementCreate.md)
 * [UIFlexibleSpaceElementUpdate](UIFlexibleSpaceElementUpdate.md)
@@ -60,6 +63,7 @@ UI features such as the legend and the full screen button.
 
 # Type Aliases
 
+* [uiFeatureAction](uiFeatureAction.md)
 * [PlacementForUIElement](PlacementForUIElement.md)
 * [UIPanelElement](UIPanelElement.md)
 * [UIPanelElementCreate](UIPanelElementCreate.md)

docs/UI/UiController.md

@@ -107,6 +107,96 @@ await felt.deleteActionTrigger("enablePolygonTool");
 
 ***
 
+## createFeatureAction()
+
+> **createFeatureAction**(`args`: [`CreateFeatureActionParams`](CreateFeatureActionParams.md)): `Promise`\<[`uiFeatureAction`](uiFeatureAction.md)>
+
+Creates a feature contextual action.
+
+### Parameters
+
+| Parameter | Type                                                        | Description                   |
+| --------- | ----------------------------------------------------------- | ----------------------------- |
+| `args`    | [`CreateFeatureActionParams`](CreateFeatureActionParams.md) | The arguments for the method. |
+
+### Returns
+
+`Promise`\<[`uiFeatureAction`](uiFeatureAction.md)>
+
+### Example
+
+```typescript
+const myAction = await felt.createFeatureAction({
+  action: {
+    label: "Edit feature",
+    onTrigger: async ({ featureId, layerId }) => {
+      console.log(`Editing feature ${featureId} in layer ${layerId}`);
+    },
+    layerIds: ["layer-1", "layer-2"],
+  },
+  placement: { at: "start" }, // optional, defaults to { at: "end" }
+});
+```
+
+***
+
+## updateFeatureAction()
+
+> **updateFeatureAction**(`args`: [`UpdateFeatureActionParams`](UpdateFeatureActionParams.md)): `Promise`\<[`uiFeatureAction`](uiFeatureAction.md)>
+
+Updates a feature contextual action.
+
+Feature contextual action to update is identified by the `id` property.
+
+### Parameters
+
+| Parameter | Type                                                        | Description                              |
+| --------- | ----------------------------------------------------------- | ---------------------------------------- |
+| `args`    | [`UpdateFeatureActionParams`](UpdateFeatureActionParams.md) | The feature contextual action to update. |
+
+### Returns
+
+`Promise`\<[`uiFeatureAction`](uiFeatureAction.md)>
+
+### Remarks
+
+Properties provided will override the existing properties.
+
+### Example
+
+```typescript
+await felt.updateFeatureAction({
+  id: "my-action",
+  label: "Updated action label", // only label changes
+});
+```
+
+***
+
+## deleteFeatureAction()
+
+> **deleteFeatureAction**(`id`: `string`): `void`
+
+Deletes a feature contextual action.
+
+### Parameters
+
+| Parameter | Type     | Description                                        |
+| --------- | -------- | -------------------------------------------------- |
+| `id`      | `string` | The id of the feature contextual action to delete. |
+
+### Returns
+
+`void`
+
+### Example
+
+```typescript
+await felt.deleteFeatureAction("my-action");
+```
+
+***
+
 ## createPanelId()
 
 > **createPanelId**(): `Promise`\<`string`>

docs/UI/UpdateFeatureActionParams.md

@@ -0,0 +1,42 @@
+***
+
+# Properties
+
+## id
+
+> **id**: `string`
+
+***
+
+## label?
+
+> `optional` **label**: `string`
+
+***
+
+## layerIds?
+
+> `optional` **layerIds**: `string`\[]
+
+***
+
+## geometryTypes?
+
+> `optional` **geometryTypes**: (`"Polygon"` | `"Point"` | `"Line"` | `"Raster"`)\[]
+
+***
+
+## onTrigger()?
+
+> `optional` **onTrigger**: (`args`: \{ `feature`: [`LayerFeature`](../Layers/LayerFeature.md); }) => `void`
+
+### Parameters
+
+| Parameter      | Type                                                         |
+| -------------- | ------------------------------------------------------------ |
+| `args`         | \{ `feature`: [`LayerFeature`](../Layers/LayerFeature.md); } |
+| `args.feature` | [`LayerFeature`](../Layers/LayerFeature.md)                  |
+
+### Returns
+
+`void`

docs/UI/uiFeatureAction.md

@@ -0,0 +1,38 @@
+***
+
+> **uiFeatureAction**: \{ `id`: `string`; `label`: `string`; `onTrigger`: (`args`: \{ `feature`: [`LayerFeature`](../Layers/LayerFeature.md); }) => `void`; `layerIds`: `string`\[]; `geometryTypes`: (`"Polygon"` | `"Point"` | `"Line"` | `"Raster"`)\[]; }
+
+Represents a feature action after creation (with generated id).
+
+# Type declaration
+
+## id
+
+> **id**: `string`
+
+## label
+
+> **label**: `string`
+
+## onTrigger()
+
+> **onTrigger**: (`args`: \{ `feature`: [`LayerFeature`](../Layers/LayerFeature.md); }) => `void`
+
+### Parameters
+
+| Parameter      | Type                                                         |
+| -------------- | ------------------------------------------------------------ |
+| `args`         | \{ `feature`: [`LayerFeature`](../Layers/LayerFeature.md); } |
+| `args.feature` | [`LayerFeature`](../Layers/LayerFeature.md)                  |
+
+### Returns
+
+`void`
+
+## layerIds?
+
+> `optional` **layerIds**: `string`\[]
+
+## geometryTypes?
+
+> `optional` **geometryTypes**: (`"Polygon"` | `"Point"` | `"Line"` | `"Raster"`)\[]