@conterra/ct-mapapps-typings 4.19.0-next.20241101051158 → 4.19.0-next.20241104050348

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@conterra/ct-mapapps-typings",
-"version": "4.19.0-next.20241101051158",
+"version": "4.19.0-next.20241104050348",
     "description": "TypeDefinitions for ct-mapapps",
     "author": "conterra",
     "license": "Apache-2.0"

package/selection-services/api/index.d.ts

@@ -14,7 +14,7 @@ import { ServiceProperties } from 'apprt/api';
  */
 interface SpatialInputAction {
     /**
-     * The id of this action. Required.
+     * The ID of this action. Required.
      */
     readonly id: string;
     /**
@@ -24,7 +24,7 @@ interface SpatialInputAction {
     readonly title: string;
     /**
      * The description of this action.
-     * Currently not used, but it is in the future intended to provide the user a hint about this action.
+     * Currently not used, but it is intended to provide the user a hint about this action in the future.
      * Optional.
      */
     readonly description?: string;
@@ -34,16 +34,16 @@ interface SpatialInputAction {
     readonly iconClass: string;
     /**
      * By default a SpatialInputAction is assumed to be interactive.
-     * But this can set to false explicitly.
+     * But this can set to `false` explicitly.
      */
     readonly interactive?: boolean;
     /**
-     * Hook triggered before the trigger function is used, e.g. to show supporting widgets.
-     * The trigger function maybe invoked multiple times after that method is invoked.
+     * Hook triggered before the {@link trigger} function is used, e.g. to show supporting widgets.
+     * The {@link trigger} function maybe invoked multiple times after that method is invoked.
      */
     enable?(): void;
     /**
-     * Hook triggered after `enable` and after maybe 0 to n invocations of the `trigger` function
+     * Hook triggered after {@link enable} and after maybe 0 to n invocations of the {@link trigger} function
      * to indicate that this action is not longer in use e.g. to hide supporting widgets.
      * The trigger function may invoked multiple times after that method is invoked.
      */
@@ -70,7 +70,7 @@ interface SpatialInputActionService extends Watchable<{
      */
     getIds(): ReadonlyArray<string>;
     /**
-     * Gets action by id or undefined if not found.
+     * Gets action by ID or `undefined` if not found.
      * @param id ID of a {@link SpatialInputAction} to be returned.
      */
     getById(id: string): SpatialInputAction | undefined;
@@ -97,7 +97,7 @@ interface SpatialSearchService {
  */
 interface SearchSource {
     /**
-     * The id of the source.
+     * The ID of the source.
      */
     id: string;
     /**
@@ -109,7 +109,7 @@ interface SearchSource {
      */
     description?: string;
     /**
-     * The layerId of the layer if this store is backed by a map layer.
+     * The layer ID of the layer if this store is backed by a map layer.
      */
     layerId: string;
     /**
@@ -154,7 +154,7 @@ interface SearchSourceModel extends Watchable<{
     hasSources: boolean;
 }> {
     /**
-     * Gets sources which fulfill visibility constrains.
+     * Gets sources which fulfill visibility constraints.
      */
     readonly effectiveSources: ReadonlyArray<SearchSource>;
     /**
@@ -170,7 +170,7 @@ interface SearchSourceModel extends Watchable<{
      */
     readonly hasSources: boolean;
     /**
-     * Gets source by id or undefined if not found.
+     * Gets source by id or `undefined` if not found.
      */
     getSourceById(id: string): SearchSource | undefined;
     /**
@@ -195,7 +195,7 @@ interface SelectionTrigger extends Watchable<{
 }> {
     /**
      * A selection is currently active.
-     * Only if the ui sets this to true a selection action activated to perform a selection.
+     * Only if the ui sets this to `true` a selection action activated to perform a selection.
      */
     active: boolean;
     /**
@@ -216,13 +216,14 @@ interface SelectionTrigger extends Watchable<{
      */
     actionId: string | undefined;
     /**
-     * Flag if the selection receiver should overwrite the last selection state of try to to merge it.
-     * Undefined means that the behavior should use the default of the receiver.
+     * Flag to signal that the selection receiver should replace the last selection state
+     * (if set to `true`) or try to to add it (if set to `false`).
+     * If set to `undefined` the default behavior of the receiver should be used.
      */
     replaceExistingSelection: boolean | undefined;
     /**
      * Flag if selection was finished successful or not.
-     * undefined if no selection is running.
+     * `undefined` if no selection is running.
      */
     selectionFinishedNonEmpty: boolean | undefined;
     /**
@@ -239,12 +240,12 @@ interface SelectionTriggerOptions {
      */
     sourceIds?: string[];
     /**
-     * Flag if all stores should be searched.
-     * If true the sourceId list is ignored.
+     * Flag to signal whether all stores should be searched.
+     * If `true` the {@link sourceIds} list is ignored.
      */
     searchAllSources?: boolean;
     /**
-     * Current selected spatial input action.
+     * Currently selected spatial input action.
      */
     actionId?: string | undefined;
     /**
@@ -253,8 +254,9 @@ interface SelectionTriggerOptions {
      */
     actionOptions?: Record<string, Record<string, any>>;
     /**
-     * Flag if the selection receiver should overwrite the last selection state of try to to merge it.
-     * Undefined means that the behavior should use the default of the receiver.
+     * Flag to signal whether the selection receiver should replace the last selection state
+     * (if set to `true`) or try to add it (if set to `false`).
+     * If set to `undefined` the default behavior of the receiver should be used.
      */
     replaceExistingSelection?: boolean | undefined;
 }
@@ -268,7 +270,7 @@ interface SelectionTriggerFactory {
      * This is introduced, to allow the selection ui to detect if the user can choose
      * between adding and overwriting of selection results.
      *
-     * Note the result of undefined means that there is no SelectionReceiver available.
+     * Note: If `undefined` is returned, there is no SelectionReceiver available.
      */
     selectionReceiverSupportsAdding: boolean | undefined;
     /**
@@ -278,7 +280,7 @@ interface SelectionTriggerFactory {
     create(options: SelectionTriggerOptions): SelectionTrigger;
 }
 /**
- * Result transported a topic event `selection/EXECUTING` or directly transported to a SelectionReceiver.
+ * Result transported as topic event `selection/EXECUTING` or directly transported to a SelectionReceiver.
  */
 interface SelectionResult {
     /**
@@ -286,17 +288,16 @@ interface SelectionResult {
      */
     executions: QueryExecutions;
     /**
-     * optional flag if existing selections should be replaced or added.
+     * Flag to signal whether existing selections should be replaced (if set to `true`) or added (if set to `false`).
      */
     replaceExistingSelection?: boolean;
 }
 /**
- * A SelectionReceiver.
- * A instance of this interface must be registered as `selection-services.SelectionReceiver`.
+ * An instance of this interface must be registered as `selection-services.SelectionReceiver`.
  */
 interface SelectionReceiver {
     /**
-     * Flag if the receiver supports adding/merging of new selection results into existing once.
+     * Flag if the receiver supports adding new selection results to existing ones.
      */
     supportsAdding?: boolean;
     /**