@conterra/ct-mapapps-typings 4.18.4-next.20241022040802 → 4.19.0-RC-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/README.md +1 -1
  2. package/agssearch/api.d.ts +0 -1
  3. package/agssearch/package.json +1 -1
  4. package/apprt/BundleEvent.d.ts +15 -9
  5. package/apprt/Constants.d.ts +6 -5
  6. package/apprt/FrameworkEvent.d.ts +11 -5
  7. package/apprt/ServiceEvent.d.ts +11 -5
  8. package/apprt/api/index.d.ts +1 -1
  9. package/apprt/event/EventConstants.d.ts +3 -2
  10. package/apprt/launch/FrameworkEvent.d.ts +2 -0
  11. package/apprt/package.json +1 -1
  12. package/apprt/semver.d.ts +2 -2
  13. package/apprt-binding/package.json +1 -1
  14. package/apprt-core/Promise.d.ts +2 -2
  15. package/apprt-core/Types.d.ts +18 -1
  16. package/apprt-core/package.json +1 -1
  17. package/apprt-dom/package.json +1 -1
  18. package/apprt-fetch/index.d.ts +10 -2
  19. package/apprt-fetch/package.json +1 -1
  20. package/apprt-request/package.json +1 -1
  21. package/apprt-streams/package.json +1 -1
  22. package/apprt-tokens/package.json +1 -1
  23. package/apprt-vue/package.json +1 -1
  24. package/apprt-vuetify/package.json +1 -1
  25. package/coordinatetransformer/api/CoordinateTransformer.d.ts +3 -3
  26. package/coordinatetransformer/api/ProjectionStore.d.ts +1 -0
  27. package/coordinatetransformer/api/TransformationProvider.d.ts +1 -1
  28. package/coordinatetransformer/api/TransformerStrategy.d.ts +1 -1
  29. package/coordinatetransformer/api/index.d.ts +1 -0
  30. package/coordinatetransformer/package.json +1 -1
  31. package/ct/Exception.d.ts +3 -0
  32. package/ct/Locale.d.ts +3 -0
  33. package/ct/mapping/geometry.d.ts +1 -2
  34. package/ct/package.json +1 -1
  35. package/ct/request.d.ts +5 -2
  36. package/ct/util/css.d.ts +2 -2
  37. package/dataform/package.json +1 -1
  38. package/dataview/package.json +1 -1
  39. package/domains-system/package.json +1 -1
  40. package/editing/api.d.ts +0 -1
  41. package/editing/package.json +1 -1
  42. package/esri-widgets/package.json +1 -1
  43. package/geojson/api.d.ts +0 -1
  44. package/geojson/package.json +1 -1
  45. package/geometryservice/api.d.ts +0 -1
  46. package/geometryservice/package.json +1 -1
  47. package/graphics/package.json +1 -1
  48. package/highlights/api.d.ts +4 -1
  49. package/highlights/package.json +1 -1
  50. package/integration-map/package.json +1 -1
  51. package/managementlayout/package.json +1 -1
  52. package/map-actions/api.d.ts +1 -2
  53. package/map-actions/package.json +1 -1
  54. package/map-basemaps-api/BasemapItem.d.ts +1 -1
  55. package/map-basemaps-api/BasemapsModel.d.ts +5 -3
  56. package/map-basemaps-api/api.d.ts +13 -1
  57. package/map-basemaps-api/package.json +1 -1
  58. package/map-config-api/api.d.ts +2 -1
  59. package/map-config-api/package.json +1 -1
  60. package/map-init/api.d.ts +0 -1
  61. package/map-init/package.json +1 -1
  62. package/map-widget/Constraints.d.ts +4 -2
  63. package/map-widget/LayerObserver.d.ts +0 -1
  64. package/map-widget/LayerTraverser.d.ts +0 -1
  65. package/map-widget/MapWidgetFactory.d.ts +4 -3
  66. package/map-widget/MapWidgetModel.d.ts +7 -3
  67. package/map-widget/ViewReadyWatcher.d.ts +4 -2
  68. package/map-widget/__internal__/{DFiGfJS1.d.ts → DiM79c03.d.ts} +55 -3
  69. package/map-widget/api/Constraints.d.ts +4 -2
  70. package/map-widget/api/MapWidget.d.ts +4 -2
  71. package/map-widget/api/MapWidgetFactory.d.ts +4 -3
  72. package/map-widget/api/MapWidgetModel.d.ts +4 -2
  73. package/map-widget/api/MapWidgetRegistration.d.ts +4 -3
  74. package/map-widget/api/SrsChangeService.d.ts +4 -3
  75. package/map-widget/api/index.d.ts +4 -2
  76. package/map-widget/package.json +1 -1
  77. package/mapdraw-api/api.d.ts +0 -1
  78. package/mapdraw-api/package.json +1 -1
  79. package/mapnavigation/package.json +1 -1
  80. package/maptips/api.d.ts +0 -1
  81. package/maptips/package.json +1 -1
  82. package/measurement-2d/api.d.ts +84 -0
  83. package/measurement-2d/package.json +5 -0
  84. package/measurement-3d/api.d.ts +71 -0
  85. package/measurement-3d/package.json +5 -0
  86. package/omnisearch/package.json +1 -1
  87. package/package.json +1 -1
  88. package/parametermanager/package.json +1 -1
  89. package/popups/BaseAction.d.ts +0 -1
  90. package/popups/ContentUpdateProxy.d.ts +0 -1
  91. package/popups/api.d.ts +0 -1
  92. package/popups/package.json +1 -1
  93. package/portal-security/api.d.ts +0 -1
  94. package/portal-security/package.json +1 -1
  95. package/result-api/__internal__/{LZ4ypyEL.d.ts → DfubgY1k.d.ts} +1 -2
  96. package/result-api/api/actions.d.ts +1 -1
  97. package/result-api/api/formatting.d.ts +1 -1
  98. package/result-api/api/index.d.ts +1 -1
  99. package/result-api/api/model.d.ts +1 -1
  100. package/result-api/api/service.d.ts +1 -1
  101. package/result-api/api/ui.d.ts +1 -1
  102. package/result-api/package.json +1 -1
  103. package/resultcenter/package.json +1 -1
  104. package/search-api/api.d.ts +62 -6
  105. package/search-api/package.json +1 -1
  106. package/search-ui/api.d.ts +2 -5
  107. package/search-ui/package.json +1 -1
  108. package/selection-resultcenter/CachingStore.d.ts +2 -2
  109. package/selection-resultcenter/package.json +1 -1
  110. package/selection-services/DrawingSpatialInputAction.d.ts +0 -1
  111. package/selection-services/SpatialInputAction.d.ts +0 -1
  112. package/selection-services/TolerancePointDrawingInputAction.d.ts +0 -1
  113. package/selection-services/api/index.d.ts +27 -27
  114. package/selection-services/package.json +1 -1
  115. package/store-api/api/ComplexQueryLang.d.ts +0 -1
  116. package/store-api/package.json +1 -1
  117. package/store-api/rest/BaseRestStore.d.ts +16 -21
  118. package/store-api/rest/BaseWriteableRestStore.d.ts +1 -0
  119. package/store-api/rest/RQLStore.d.ts +1 -0
  120. package/store-api/rest/SQLStore.d.ts +1 -0
  121. package/style-guide/package.json +1 -1
  122. package/style-guide/style-guide-layout/template.d.ts +0 -1
  123. package/system/api/index.d.ts +1 -1
  124. package/system/package.json +1 -1
  125. package/templatelayout/package.json +1 -1
  126. package/test-utils/package.json +1 -1
  127. package/theme-tester/package.json +1 -1
  128. package/theme-tester/test-layout/test-layout.d.ts +0 -1
  129. package/toc/api/Item.d.ts +0 -1
  130. package/toc/package.json +1 -1
  131. package/toolrules/package.json +1 -1
  132. package/vuetify-component-overview/component-overview-layout/template.d.ts +0 -1
  133. package/vuetify-component-overview/package.json +1 -1
  134. package/windowmanager/package.json +1 -1
  135. package/wizard/package.json +1 -1
  136. package/toolset/Drawer.d.ts +0 -3
  137. package/toolset/package.json +0 -5
@@ -0,0 +1,71 @@
1
+ import { Watchable } from 'apprt-core/Types';
2
+ import { SystemOrAreaUnit, SystemOrLengthUnit } from 'esri/core/units';
3
+
4
+ /**
5
+ * Measurement mode.
6
+ * - `off`: Measurement is disabled.
7
+ * - `area`: Area measurement is enabled.
8
+ * - `distance`: Distance measurement is enabled.
9
+ */
10
+ type Measurement3DMode = "off" | "area" | "distance";
11
+ /**
12
+ * Measurement state.
13
+ * - `disabled`: Measurement is disabled.
14
+ * - `ready`: Measurement is enabled and ready to start.
15
+ * - `measuring`: Measurement is in progress.
16
+ * - `measured`: Measurement is finished.
17
+ */
18
+ type Measurement3DState = "disabled" | "ready" | "measuring" | "measured";
19
+ /**
20
+ * {@link Watchable} properties of {@link Measurement3DModel}.
21
+ */
22
+ interface Measurement3DModelProperties {
23
+ /**
24
+ * Measurement mode.
25
+ */
26
+ readonly mode: Measurement3DMode;
27
+ /**
28
+ * Measurement state.
29
+ */
30
+ readonly state: Measurement3DState;
31
+ /**
32
+ * Measurement unit is either unit system (metric, imperial) or a specific unit.
33
+ * Available if the {@link mode} is set to `area` or `distance`.
34
+ */
35
+ readonly unit: SystemOrAreaUnit | SystemOrLengthUnit;
36
+ /**
37
+ * Locale specific representation of the direct distance including the unit.
38
+ * Available if the {@link mode} is set to `distance`.
39
+ */
40
+ directDistance: string;
41
+ /**
42
+ * Locale specific representation of the horizontal distance including the unit.
43
+ * Available if the {@link mode} is set to `distance`.
44
+ */
45
+ horizontalDistance: string;
46
+ /**
47
+ * Locale specific representation of the vertical distance including the unit.
48
+ * Available if the {@link mode} is set to `distance`.
49
+ */
50
+ verticalDistance: string;
51
+ /**
52
+ * Locale specific representation of the area including the unit.
53
+ * Available if the {@link mode} is set to `area`.
54
+ */
55
+ readonly area: string;
56
+ /**
57
+ * Locale specific representation of the perimeter including the unit.
58
+ * Available if the {@link mode} is set to `area`.
59
+ */
60
+ readonly perimeter: string;
61
+ }
62
+ /**
63
+ * A model, providing access to the current measurement state.
64
+ * It is available as service `measurement-3d.Model`.
65
+ *
66
+ * See {@link Measurement3DModelProperties} for documentation of class members.
67
+ */
68
+ interface Measurement3DModel extends Measurement3DModelProperties, Watchable<Measurement3DModelProperties> {
69
+ }
70
+
71
+ export type { Measurement3DMode, Measurement3DModel, Measurement3DModelProperties, Measurement3DState };
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "measurement-3d",
3
+ "version": "4.19.0-RC-1",
4
+ "types": ""
5
+ }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "omnisearch",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@conterra/ct-mapapps-typings",
3
- "version": "4.18.4-next.20241022040802",
3
+ "version": "4.19.0-RC-1",
4
4
  "description": "TypeDefinitions for ct-mapapps",
5
5
  "author": "conterra",
6
6
  "license": "Apache-2.0"
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "parametermanager",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import ActionButton from 'esri/support/actions/ActionButton';
3
2
  import ActionToggle from 'esri/support/actions/ActionToggle';
4
3
  import { Action } from './api.js';
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import Graphic from 'esri/Graphic';
3
2
 
4
3
  /**
package/popups/api.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import { Point } from 'esri/geometry';
3
2
  import Graphic from 'esri/Graphic';
4
3
  import Layer from 'esri/layers/Layer';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "popups",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": "./main.d.ts"
5
5
  }
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import { EventSource } from 'apprt-core/Events';
3
2
  import Credential from 'esri/identity/Credential';
4
3
 
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "portal-security",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import { EventSource, Watchable, DeepReadonly } from 'apprt-core/Types';
3
2
  import { SpatialReference, Geometry } from 'esri/geometry';
4
3
  import { AllowedIdTypes, Store, FieldData } from 'store-api/api';
@@ -804,7 +803,7 @@ interface DatasetItem<IdType extends DatasetItemId = DatasetItemId> {
804
803
  */
805
804
  readonly attributes: DeepReadonly<Record<string, unknown>>;
806
805
  /** Item geometry, if available */
807
- readonly geometry?: DeepReadonly<Geometry>;
806
+ readonly geometry?: Readonly<Geometry>;
808
807
  }
809
808
  /** Holds information about the number of items. */
810
809
  interface ItemCount {
@@ -1,4 +1,4 @@
1
- import { DataTable, TableItem, DataTableCollection } from '../__internal__/LZ4ypyEL.js';
1
+ import { DataTable, TableItem, DataTableCollection } from '../__internal__/DfubgY1k.js';
2
2
  import { EventSource } from 'apprt-core/Events';
3
3
  import 'apprt-core/Types';
4
4
  import 'esri/geometry';
@@ -1,4 +1,4 @@
1
- export { ArcadeFormatOptions, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, NumberFormatOptions, WellKnownFormatterOptions } from '../__internal__/LZ4ypyEL.js';
1
+ export { ArcadeFormatOptions, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, NumberFormatOptions, WellKnownFormatterOptions } from '../__internal__/DfubgY1k.js';
2
2
  import 'apprt-core/Types';
3
3
  import 'esri/geometry';
4
4
  import 'store-api/api';
@@ -1,4 +1,4 @@
1
- export { ArcadeFormatOptions, CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Filter, FocusChangedEvent, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, ItemCount, NumberFormatOptions, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties, WellKnownFormatterOptions } from '../__internal__/LZ4ypyEL.js';
1
+ export { ArcadeFormatOptions, CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Filter, FocusChangedEvent, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, ItemCount, NumberFormatOptions, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties, WellKnownFormatterOptions } from '../__internal__/DfubgY1k.js';
2
2
  export { DataTableFactory, ResultViewerService, ResultViewerServiceEvents, ResultViewerServiceOpenOptions } from './service.js';
3
3
  export { DataTableUi, DataTableUiConfig, DataTableUiEvents, DataTableUiFactory } from './ui.js';
4
4
  export { BulkActionContext, BulkButtonTableAction, BulkTableAction, RowActionContext, RowButtonTableAction, RowTableAction, TableAction, TableActionDisplayState, TableActionDisplayStateProvider, TableActionItem, TableActionResolver, TableActionResolverContext, TableActionResolverContextEvents, TableActionResolverContextOptions, TableActionUIType } from './actions.js';
@@ -1,4 +1,4 @@
1
1
  import 'apprt-core/Types';
2
2
  import 'esri/geometry';
3
3
  import 'store-api/api';
4
- export { CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, Filter, FocusChangedEvent, ItemCount, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties } from '../__internal__/LZ4ypyEL.js';
4
+ export { CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, Filter, FocusChangedEvent, ItemCount, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties } from '../__internal__/DfubgY1k.js';
@@ -1,5 +1,5 @@
1
1
  import { Store, ComplexQueryExpression, QueryOptions } from 'store-api/api';
2
- import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/LZ4ypyEL.js';
2
+ import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/DfubgY1k.js';
3
3
  import { EventSource, Handle } from 'apprt-core/Types';
4
4
  import 'esri/geometry';
5
5
 
@@ -1,4 +1,4 @@
1
- import { DataTableCollection } from '../__internal__/LZ4ypyEL.js';
1
+ import { DataTableCollection } from '../__internal__/DfubgY1k.js';
2
2
  import { EventSource } from 'apprt-core/Types';
3
3
  import 'esri/geometry';
4
4
  import 'store-api/api';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "result-api",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "resultcenter",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -4,6 +4,10 @@ import { Store } from 'store-api/api';
4
4
  * Provides search functionality (use `search-api.SearchService` OSGi service name).
5
5
  */
6
6
  interface SearchService {
7
+ /**
8
+ * Returns `true` if the service knows a store with the given ID.
9
+ */
10
+ hasStore(storeId: string): boolean;
7
11
  /**
8
12
  * Searches items on one or more data sources using the given query.
9
13
  *
@@ -25,6 +29,17 @@ interface SearchOptions {
25
29
  * See https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal.
26
30
  */
27
31
  signal?: AbortSignal;
32
+ /**
33
+ * IDs of stores to search. If not provided, all available stores are searched.
34
+ */
35
+ stores?: string[];
36
+ /**
37
+ * Optional context parameter that is passed through the search-api.
38
+ * This value can be used to indicate the origin of the search (e.g. a UI widget or bundle).
39
+ *
40
+ * See also {@link QueryEvent.context} and {@link SelectedEvent.context}.
41
+ */
42
+ context?: string;
28
43
  /**
29
44
  * An optional number of items requested from each store.
30
45
  * Note that the implementation may return fewer results if the
@@ -36,10 +51,11 @@ interface SearchOptions {
36
51
  */
37
52
  count?: number;
38
53
  /**
39
- * An optional array of map-actions to trigger when an item is selected (see {@link ResultItem.select}).
54
+ * An optional array of map action IDs.
55
+ * The associated map actions are triggered when an item is selected (see {@link ResultItem.select}).
40
56
  * This option corresponds to the `actionIds` parameter of the `map-actions.ActionService.trigger()` method.
41
57
  *
42
- * Defaults to the actions `"highlight"`, `"zoomto"` and `"openpopup"` defined by the `map-actions` bundle.
58
+ * Defaults to the action IDs `"highlight"`, `"zoomto"` and `"openpopup"` defined by the `map-actions` bundle.
43
59
  */
44
60
  actions?: string[];
45
61
  /**
@@ -99,6 +115,16 @@ interface ResultSet {
99
115
  readonly items: ResultItem[];
100
116
  /** Total number of available results */
101
117
  readonly total: number;
118
+ /**
119
+ * Selects multiple items at once.
120
+ * The items must belong to this result set (from `this.items`).
121
+ *
122
+ * When using this method, make sure that the configured map actions
123
+ * can handle multiple items at once.
124
+ *
125
+ * See also {@link ResultItem.select} for more details.
126
+ */
127
+ select(items: ResultItem[]): ResultSelectionHandle;
102
128
  }
103
129
  /**
104
130
  * A single result item, for example describing a feature.
@@ -120,6 +146,8 @@ interface ResultItem {
120
146
  * that will clear side effects made by the selection, if applicable (e.g. highlights).
121
147
  *
122
148
  * Note that selections may also be removed automatically (e.g. when a new selection is made).
149
+ *
150
+ * To select multiple items at once, see {@link ResultGroup.select}.
123
151
  */
124
152
  select(): ResultSelectionHandle;
125
153
  }
@@ -136,15 +164,35 @@ interface ResultSelectionHandle {
136
164
  * An event emitted via the Event Service using the topic name `search-api/QUERY`.
137
165
  */
138
166
  interface QueryEvent {
139
- /** The original search query entered by the user. */
167
+ /**
168
+ * The original search query entered by the user.
169
+ */
140
170
  readonly query: string;
171
+ /**
172
+ * Context parameter that was specified when the search was started.
173
+ *
174
+ * May indicate the UI widget or bundle where the search was originally triggered.
175
+ *
176
+ * See also {@link SearchOptions.context}.
177
+ */
178
+ readonly context: string | undefined;
141
179
  }
142
180
  /**
143
181
  * An event emitted via the Event Service using the topic name `search-api/SELECTED`.
144
182
  */
145
183
  interface SelectedEvent {
146
- /** The original search query entered by the user. */
184
+ /**
185
+ * The original search query entered by the user.
186
+ */
147
187
  readonly query: string;
188
+ /**
189
+ * Context parameter that was specified when the search was started.
190
+ *
191
+ * May indicate the UI widget or bundle where the search was originally triggered.
192
+ *
193
+ * See also {@link SearchOptions.context}.
194
+ */
195
+ readonly context: string | undefined;
148
196
  /**
149
197
  * The source of the selected item.
150
198
  * Currently all sources are stores, but different source types may be added in the future.
@@ -152,9 +200,17 @@ interface SelectedEvent {
152
200
  */
153
201
  readonly source: ItemSource;
154
202
  /**
155
- * The selected item.
203
+ * The selected item (for single selection).
204
+ *
205
+ * Mutually exclusive with {@link items}.
206
+ */
207
+ readonly item?: Record<string, unknown>;
208
+ /**
209
+ * The selected items (for multi selection).
210
+ *
211
+ * Mutually exclusive with {@link item}.
156
212
  */
157
- readonly item: Readonly<Record<string, unknown>>;
213
+ readonly items?: Record<string, unknown>[];
158
214
  }
159
215
  /** Describes the item source for a selection event. */
160
216
  interface ItemSource {
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "search-api",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -52,11 +52,8 @@ interface SearchUiService extends EventSource<SearchUiServiceEvents> {
52
52
  }): void;
53
53
  }
54
54
  /**
55
- * Special interface provided for the product `smart.finder` to react on the 'Enter' key pressed event
56
- * of the search-ui input field. It will provide the current text from the input field to another component.
57
- *
58
- * This interface is subject to change and strictly coupled with the requirements of the `smart.finder`.
59
- *
55
+ * Interface to react on the 'Enter' key pressed event of the search-ui input field. It will provide the
56
+ * current text from the input field to another component. This interface is used by the product `smart.finder`
60
57
  * Only one action is allowed. It must be registered as a service which provides `search-ui.EnterKeyAction`.
61
58
  */
62
59
  interface SearchUiEnterKeyAction {
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "search-ui",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -17,7 +17,7 @@ interface StateQueryable {
17
17
  type State = "pending" | "fulfilled" | "rejected" | "cancelled";
18
18
  declare const PROMISE: unique symbol;
19
19
  declare const STATE: unique symbol;
20
- declare const PRIVATE_CONSTUCTOR_TAG: unique symbol;
20
+ declare const PRIVATE_CONSTRUCTOR_TAG: unique symbol;
21
21
  /**
22
22
  * Wrapper of global.Promise class.
23
23
  * Read more about [Promises](./PROMISES.md).
@@ -41,7 +41,7 @@ declare class ExtendedPromise<T> implements Promise<T> {
41
41
  /**
42
42
  * Internal constructor. Do not call.
43
43
  */
44
- constructor(promise: PromiseLike<T> | LegacyDojoDeferred, state: State | undefined, tag: typeof PRIVATE_CONSTUCTOR_TAG);
44
+ constructor(promise: PromiseLike<T> | LegacyDojoDeferred, state: State | undefined, tag: typeof PRIVATE_CONSTRUCTOR_TAG);
45
45
  /** Creates a new resolved promise */
46
46
  static resolve(): ExtendedPromise<void>;
47
47
  /**
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "selection-resultcenter",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import CancelablePromise from 'apprt-core/CancelablePromise';
3
2
  import SpatialInputActionImpl, { CommonSpatialInputActionOptions } from './SpatialInputAction.js';
4
3
  import { MapWidgetModel } from 'map-widget/api';
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import CancelablePromise from 'apprt-core/CancelablePromise';
3
2
  import { SpatialInputAction } from './api/index.js';
4
3
  import { Geometry } from 'esri/geometry';
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import { Geometry } from 'esri/geometry';
3
2
  import DrawingSpatialInputAction, { DrawingSpatialInputActionOptions } from './DrawingSpatialInputAction.js';
4
3
  import 'apprt-core/CancelablePromise';
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import CancelablePromise from 'apprt-core/CancelablePromise';
3
2
  import { Geometry } from 'esri/geometry';
4
3
  import { QueryExecutions } from 'store-api/QueryExecutions';
@@ -15,7 +14,7 @@ import { ServiceProperties } from 'apprt/api';
15
14
  */
16
15
  interface SpatialInputAction {
17
16
  /**
18
- * The id of this action. Required.
17
+ * The ID of this action. Required.
19
18
  */
20
19
  readonly id: string;
21
20
  /**
@@ -25,7 +24,7 @@ interface SpatialInputAction {
25
24
  readonly title: string;
26
25
  /**
27
26
  * The description of this action.
28
- * Currently not used, but it is in the future intended to provide the user a hint about this action.
27
+ * Currently not used, but it is intended to provide the user a hint about this action in the future.
29
28
  * Optional.
30
29
  */
31
30
  readonly description?: string;
@@ -35,16 +34,16 @@ interface SpatialInputAction {
35
34
  readonly iconClass: string;
36
35
  /**
37
36
  * By default a SpatialInputAction is assumed to be interactive.
38
- * But this can set to false explicitly.
37
+ * But this can set to `false` explicitly.
39
38
  */
40
39
  readonly interactive?: boolean;
41
40
  /**
42
- * Hook triggered before the trigger function is used, e.g. to show supporting widgets.
43
- * The trigger function maybe invoked multiple times after that method is invoked.
41
+ * Hook triggered before the {@link trigger} function is used, e.g. to show supporting widgets.
42
+ * The {@link trigger} function maybe invoked multiple times after that method is invoked.
44
43
  */
45
44
  enable?(): void;
46
45
  /**
47
- * Hook triggered after `enable` and after maybe 0 to n invocations of the `trigger` function
46
+ * Hook triggered after {@link enable} and after maybe 0 to n invocations of the {@link trigger} function
48
47
  * to indicate that this action is not longer in use e.g. to hide supporting widgets.
49
48
  * The trigger function may invoked multiple times after that method is invoked.
50
49
  */
@@ -71,7 +70,7 @@ interface SpatialInputActionService extends Watchable<{
71
70
  */
72
71
  getIds(): ReadonlyArray<string>;
73
72
  /**
74
- * Gets action by id or undefined if not found.
73
+ * Gets action by ID or `undefined` if not found.
75
74
  * @param id ID of a {@link SpatialInputAction} to be returned.
76
75
  */
77
76
  getById(id: string): SpatialInputAction | undefined;
@@ -98,7 +97,7 @@ interface SpatialSearchService {
98
97
  */
99
98
  interface SearchSource {
100
99
  /**
101
- * The id of the source.
100
+ * The ID of the source.
102
101
  */
103
102
  id: string;
104
103
  /**
@@ -110,7 +109,7 @@ interface SearchSource {
110
109
  */
111
110
  description?: string;
112
111
  /**
113
- * The layerId of the layer if this store is backed by a map layer.
112
+ * The layer ID of the layer if this store is backed by a map layer.
114
113
  */
115
114
  layerId: string;
116
115
  /**
@@ -155,7 +154,7 @@ interface SearchSourceModel extends Watchable<{
155
154
  hasSources: boolean;
156
155
  }> {
157
156
  /**
158
- * Gets sources which fulfill visibility constrains.
157
+ * Gets sources which fulfill visibility constraints.
159
158
  */
160
159
  readonly effectiveSources: ReadonlyArray<SearchSource>;
161
160
  /**
@@ -171,7 +170,7 @@ interface SearchSourceModel extends Watchable<{
171
170
  */
172
171
  readonly hasSources: boolean;
173
172
  /**
174
- * Gets source by id or undefined if not found.
173
+ * Gets source by id or `undefined` if not found.
175
174
  */
176
175
  getSourceById(id: string): SearchSource | undefined;
177
176
  /**
@@ -196,7 +195,7 @@ interface SelectionTrigger extends Watchable<{
196
195
  }> {
197
196
  /**
198
197
  * A selection is currently active.
199
- * Only if the ui sets this to true a selection action activated to perform a selection.
198
+ * Only if the ui sets this to `true` a selection action activated to perform a selection.
200
199
  */
201
200
  active: boolean;
202
201
  /**
@@ -217,13 +216,14 @@ interface SelectionTrigger extends Watchable<{
217
216
  */
218
217
  actionId: string | undefined;
219
218
  /**
220
- * Flag if the selection receiver should overwrite the last selection state of try to to merge it.
221
- * Undefined means that the behavior should use the default of the receiver.
219
+ * Flag to signal that the selection receiver should replace the last selection state
220
+ * (if set to `true`) or try to to add it (if set to `false`).
221
+ * If set to `undefined` the default behavior of the receiver should be used.
222
222
  */
223
223
  replaceExistingSelection: boolean | undefined;
224
224
  /**
225
225
  * Flag if selection was finished successful or not.
226
- * undefined if no selection is running.
226
+ * `undefined` if no selection is running.
227
227
  */
228
228
  selectionFinishedNonEmpty: boolean | undefined;
229
229
  /**
@@ -240,12 +240,12 @@ interface SelectionTriggerOptions {
240
240
  */
241
241
  sourceIds?: string[];
242
242
  /**
243
- * Flag if all stores should be searched.
244
- * If true the sourceId list is ignored.
243
+ * Flag to signal whether all stores should be searched.
244
+ * If `true` the {@link sourceIds} list is ignored.
245
245
  */
246
246
  searchAllSources?: boolean;
247
247
  /**
248
- * Current selected spatial input action.
248
+ * Currently selected spatial input action.
249
249
  */
250
250
  actionId?: string | undefined;
251
251
  /**
@@ -254,8 +254,9 @@ interface SelectionTriggerOptions {
254
254
  */
255
255
  actionOptions?: Record<string, Record<string, any>>;
256
256
  /**
257
- * Flag if the selection receiver should overwrite the last selection state of try to to merge it.
258
- * Undefined means that the behavior should use the default of the receiver.
257
+ * Flag to signal whether the selection receiver should replace the last selection state
258
+ * (if set to `true`) or try to add it (if set to `false`).
259
+ * If set to `undefined` the default behavior of the receiver should be used.
259
260
  */
260
261
  replaceExistingSelection?: boolean | undefined;
261
262
  }
@@ -269,7 +270,7 @@ interface SelectionTriggerFactory {
269
270
  * This is introduced, to allow the selection ui to detect if the user can choose
270
271
  * between adding and overwriting of selection results.
271
272
  *
272
- * Note the result of undefined means that there is no SelectionReceiver available.
273
+ * Note: If `undefined` is returned, there is no SelectionReceiver available.
273
274
  */
274
275
  selectionReceiverSupportsAdding: boolean | undefined;
275
276
  /**
@@ -279,7 +280,7 @@ interface SelectionTriggerFactory {
279
280
  create(options: SelectionTriggerOptions): SelectionTrigger;
280
281
  }
281
282
  /**
282
- * Result transported a topic event `selection/EXECUTING` or directly transported to a SelectionReceiver.
283
+ * Result transported as topic event `selection/EXECUTING` or directly transported to a SelectionReceiver.
283
284
  */
284
285
  interface SelectionResult {
285
286
  /**
@@ -287,17 +288,16 @@ interface SelectionResult {
287
288
  */
288
289
  executions: QueryExecutions;
289
290
  /**
290
- * optional flag if existing selections should be replaced or added.
291
+ * Flag to signal whether existing selections should be replaced (if set to `true`) or added (if set to `false`).
291
292
  */
292
293
  replaceExistingSelection?: boolean;
293
294
  }
294
295
  /**
295
- * A SelectionReceiver.
296
- * A instance of this interface must be registered as `selection-services.SelectionReceiver`.
296
+ * An instance of this interface must be registered as `selection-services.SelectionReceiver`.
297
297
  */
298
298
  interface SelectionReceiver {
299
299
  /**
300
- * Flag if the receiver supports adding/merging of new selection results into existing once.
300
+ * Flag if the receiver supports adding new selection results to existing ones.
301
301
  */
302
302
  supportsAdding?: boolean;
303
303
  /**
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "selection-services",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }
@@ -1,4 +1,3 @@
1
- /// <reference types="arcgis-js-api" />
2
1
  import Geometry from 'esri/geometry/Geometry';
3
2
 
4
3
  /**
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "store-api",
3
- "version": "4.18.4-SNAPSHOT",
3
+ "version": "4.19.0-RC-1",
4
4
  "types": ""
5
5
  }