@conterra/ct-mapapps-typings 4.18.4-next.20241007040658 → 4.18.4-next.20241009040310

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 (87) hide show
  1. package/agssearch/api.d.ts +5 -4
  2. package/apprt/event/EventConstants.d.ts +1 -1
  3. package/apprt-core/AsyncTask.d.ts +4 -5
  4. package/apprt-core/BlockingTaskExecutor.d.ts +4 -6
  5. package/apprt-core/CancelablePromise.d.ts +6 -5
  6. package/apprt-core/Events.d.ts +23 -21
  7. package/apprt-core/Exception.d.ts +9 -9
  8. package/apprt-core/Logger.d.ts +7 -7
  9. package/apprt-core/Mutable.d.ts +35 -39
  10. package/apprt-core/Observable.d.ts +8 -6
  11. package/apprt-core/Observers.d.ts +40 -34
  12. package/apprt-core/Promise.d.ts +3 -3
  13. package/apprt-core/TaskExecutor.d.ts +3 -3
  14. package/apprt-core/assignWithPrototype.d.ts +23 -20
  15. package/apprt-core/async.d.ts +6 -6
  16. package/apprt-core/base64.d.ts +2 -2
  17. package/apprt-core/bindAsync.d.ts +9 -12
  18. package/apprt-core/clone.d.ts +13 -15
  19. package/apprt-core/comparators.d.ts +7 -7
  20. package/apprt-core/config.d.ts +5 -1
  21. package/apprt-core/delegate.d.ts +9 -9
  22. package/apprt-core/deprecate.d.ts +1 -1
  23. package/apprt-core/equals.d.ts +2 -2
  24. package/apprt-core/freeze.d.ts +1 -1
  25. package/apprt-core/global.d.ts +1 -1
  26. package/apprt-core/join.d.ts +14 -11
  27. package/apprt-core/load-css.d.ts +4 -4
  28. package/apprt-core/load-js.d.ts +5 -5
  29. package/apprt-core/promise-utils.d.ts +23 -23
  30. package/apprt-core/propertyToSymbol.d.ts +1 -1
  31. package/apprt-core/string-escape.d.ts +1 -1
  32. package/apprt-core/string-pattern.d.ts +1 -1
  33. package/apprt-core/string-replace.d.ts +10 -10
  34. package/apprt-core/url-utils.d.ts +2 -2
  35. package/apprt-core/when.d.ts +3 -3
  36. package/apprt-dom/index.d.ts +7 -7
  37. package/apprt-fetch/index.d.ts +17 -17
  38. package/apprt-streams/Stream.d.ts +34 -34
  39. package/coordinatetransformer/api/CoordinateTransformer.d.ts +15 -10
  40. package/coordinatetransformer/api/ProjectionStore.d.ts +7 -6
  41. package/coordinatetransformer/api/TransformationProvider.d.ts +11 -4
  42. package/coordinatetransformer/api/TransformerStrategy.d.ts +8 -5
  43. package/ct/util/css.d.ts +9 -8
  44. package/domains-system/api.d.ts +26 -30
  45. package/highlights/api.d.ts +6 -11
  46. package/integration-map/api.d.ts +38 -35
  47. package/map-actions/api.d.ts +9 -5
  48. package/map-config-api/api.d.ts +31 -3
  49. package/map-init/api.d.ts +5 -5
  50. package/map-widget/Constraints.d.ts +1 -1
  51. package/map-widget/LayerObserver.d.ts +6 -2
  52. package/map-widget/LayerTraverser.d.ts +4 -1
  53. package/map-widget/MapWidgetFactory.d.ts +1 -1
  54. package/map-widget/MapWidgetModel.d.ts +1 -1
  55. package/map-widget/ViewReadyWatcher.d.ts +1 -1
  56. package/map-widget/__internal__/{I0BOBZBz.d.ts → DFiGfJS1.d.ts} +3 -3
  57. package/map-widget/api/Constraints.d.ts +1 -1
  58. package/map-widget/api/MapWidget.d.ts +1 -1
  59. package/map-widget/api/MapWidgetFactory.d.ts +1 -1
  60. package/map-widget/api/MapWidgetModel.d.ts +1 -1
  61. package/map-widget/api/MapWidgetRegistration.d.ts +23 -12
  62. package/map-widget/api/SrsChangeService.d.ts +1 -1
  63. package/map-widget/api/index.d.ts +1 -1
  64. package/package.json +1 -1
  65. package/popups/ContentUpdateProxy.d.ts +61 -33
  66. package/popups/api.d.ts +35 -38
  67. package/portal-security/api.d.ts +48 -0
  68. package/portal-security/package.json +5 -0
  69. package/result-api/__internal__/{Cf0JLId0.d.ts → LZ4ypyEL.d.ts} +12 -12
  70. package/result-api/api/actions.d.ts +1 -1
  71. package/result-api/api/formatting.d.ts +1 -1
  72. package/result-api/api/index.d.ts +1 -1
  73. package/result-api/api/model.d.ts +1 -1
  74. package/result-api/api/service.d.ts +3 -3
  75. package/result-api/api/ui.d.ts +2 -2
  76. package/search-api/api.d.ts +8 -1
  77. package/search-ui/api.d.ts +2 -2
  78. package/selection-resultcenter/CachingStore.d.ts +3 -3
  79. package/store-api/ComplexQuery.d.ts +1 -1
  80. package/store-api/QueryExecution.d.ts +12 -11
  81. package/store-api/QueryExecutions.d.ts +3 -2
  82. package/store-api/SpatialQuery.d.ts +9 -9
  83. package/store-api/utils.d.ts +9 -9
  84. package/toc/api/Action.d.ts +3 -0
  85. package/toc/api/Item.d.ts +4 -1
  86. package/toc/api/StateChecker.d.ts +3 -0
  87. package/toc/api/index.d.ts +3 -0
package/popups/api.d.ts CHANGED
@@ -126,20 +126,20 @@ interface PopupTemplateResolver {
126
126
  * which will point to the layer where the feature originates from.
127
127
  *
128
128
  * @example Resolve for store
129
- * ```js
130
- * const { popupTemplate } = resolver.resolvePopupTemplate({store: store});
129
+ * ```ts
130
+ * const { popupTemplate } = await resolver.resolvePopupTemplate({store: store});
131
131
  * ```
132
132
  * @example Resolve for storeId
133
- * ```js
134
- * const { popupTemplate } = resolver.resolvePopupTemplate({storeId: "my-store"});
133
+ * ```ts
134
+ * const { popupTemplate } = await resolver.resolvePopupTemplate({storeId: "my-store"});
135
135
  * ```
136
136
  * @example Resolve for layerId
137
- * ```js
138
- * const { popupTemplate } = resolver.resolvePopupTemplate({layerId: "countries"});
137
+ * ```ts
138
+ * const { popupTemplate } = await resolver.resolvePopupTemplate({layerId: "countries"});
139
139
  * ```
140
140
  * @example Resolve for sub layerId
141
- * ```js
142
- * const { popupTemplate } = resolver.resolvePopupTemplate({layerId: "countries/2"});
141
+ * ```ts
142
+ * const { popupTemplate } = await resolver.resolvePopupTemplate({layerId: "countries/2"});
143
143
  * ```
144
144
  */
145
145
  resolvePopupTemplate(params: PopupTemplateResolverParams): Promise<UnknownPopupTemplate | ResolvedPopupTemplate>;
@@ -206,50 +206,47 @@ interface ActionFactory {
206
206
  *
207
207
  * @example
208
208
  * ActionFactory returning a properties object
209
- * ```js
210
- * export default function TweetActionFactory() {
211
- * return {
212
- * createAction(type) {
213
- * return {
214
- * id: "tweetablePopups.action.tweet",
215
- * type: "button",
216
- * title: "Tweet Feature",
217
- * className: "esri-icon-share2",
218
- * trigger(context) {
219
- * // Code to be performed, when the action is triggered,
220
- * // for example if someone clicks the link that is displayed in the popup.
209
+ * ```ts
210
+ * export class TweetActionFactory implements ActionFactory {
211
+ * createAction(type: string): Action | undefined {
212
+ * return {
213
+ * id: "tweetablePopups.action.tweet",
214
+ * type: "button",
215
+ * title: "Tweet Feature",
216
+ * className: "esri-icon-share2",
217
+ * trigger(context) {
218
+ * // Code to be performed, when the action is triggered,
219
+ * // for example if someone clicks the link that is displayed in the popup.
221
220
  *
222
- * const features = context.features; // All features that are hit by clicking on the map.
223
- * const selectedFeature = context.selectedFeature; // The selected and visible feature in the popup.
224
- * const location = context.location; // The point position where the popup is opened on the map.
221
+ * const features = context.features; // All features that are hit by clicking on the map.
222
+ * const selectedFeature = context.selectedFeature; // The selected and visible feature in the popup.
223
+ * const location = context.location; // The point position where the popup is opened on the map.
225
224
  *
226
- * // Tweet it: for example selectedFeature.attributes.description ...
227
- * }
228
- * };
229
- * },
230
- * getTypes() {
231
- * return ["tweet"];
232
- * }
233
- * };
225
+ * // Tweet it: for example selectedFeature.attributes.description ...
226
+ * }
227
+ * };
228
+ * }
229
+ * getTypes(): string[] | Promise<string[]> {
230
+ * return ["tweet"];
231
+ * }
234
232
  * }
235
233
  * ```
236
234
  *
237
235
  * @example
238
236
  * ActionFactory returning an instance from a class extending `popups/Action`
239
- * ```js
240
- * import Action from "popups/Action";
241
237
  *
242
- * class MyCustomAction extends Action {
243
- * trigger(context) {
238
+ * ```ts
239
+ * export class MyCustomAction extends Action {
240
+ * trigger(context: ActionContext) {
244
241
  * // Do something when action is clicked
245
242
  * }
246
243
  * }
247
244
  *
248
- * class MyCustomActionFactory {
249
- * getTypes() {
245
+ * export class MyCustomActionFactory implements ActionFactory {
246
+ * getTypes(): string[] | Promise<string[]> {
250
247
  * return ["mycustomaction"];
251
248
  * }
252
- * createAction(type) {
249
+ * createAction(type: string): Action | undefined {
253
250
  * return new MyCustomAction({
254
251
  * id: type,
255
252
  * title: "customAction"
@@ -0,0 +1,48 @@
1
+ /// <reference types="arcgis-js-api" />
2
+ import { Evented } from 'apprt-core/Events';
3
+ import Credential from 'esri/identity/Credential';
4
+
5
+ /**
6
+ * Events emitted from PortalLoginService.
7
+ */
8
+ interface PortalLoginServiceEvents {
9
+ /**
10
+ * Emitted when signed out.
11
+ */
12
+ "portal-sign-out": void;
13
+ /**
14
+ * Emitted when signed in.
15
+ */
16
+ "portal-sign-in": void;
17
+ }
18
+ /**
19
+ * Service to access security information of ArcGIS services like ArcGIS Enterprise portal.
20
+ */
21
+ interface PortalLoginService extends Evented<PortalLoginServiceEvents> {
22
+ /**
23
+ * Checks if the user is signed in to ArcGIS Online
24
+ */
25
+ isSignedIn(): boolean;
26
+ /**
27
+ * Forces a sign-in to ArcGIS Online. The user is prompted to enter credentials.
28
+ *
29
+ * @return The user's credentials, wrapped in a promise.
30
+ */
31
+ signIn(): Promise<Credential | undefined>;
32
+ /**
33
+ * Clears all ArcGIS Online Tokens.
34
+ */
35
+ signOut(): void;
36
+ /**
37
+ * Gets the token for the portal or undefined if user is not signed in.
38
+ *
39
+ * @returns The user's credentials.
40
+ */
41
+ getPortalCredential(): Credential | undefined;
42
+ /**
43
+ * Gets the response of the community/self endpoint of ArcGIS Online or undefined if user is not signed in.
44
+ */
45
+ getPortalUserSelfInfo(): Promise<Record<string, any>>;
46
+ }
47
+
48
+ export type { PortalLoginService, PortalLoginServiceEvents };
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "portal-security",
3
+ "version": "4.18.4-SNAPSHOT",
4
+ "types": ""
5
+ }
@@ -350,7 +350,7 @@ interface DataTableCollectionEvents {
350
350
  *
351
351
  * To access the items you can use for...of:
352
352
  *
353
- * ```js
353
+ * ```ts
354
354
  * const dataTables = ...;
355
355
  * for (const dataTable of dataTables) {
356
356
  * ...
@@ -358,28 +358,28 @@ interface DataTableCollectionEvents {
358
358
  * ```
359
359
  * If you need an array use the `tables` property
360
360
  *
361
- * ```js
361
+ * ```ts
362
362
  * const dataTables = ...;
363
363
  * const tables = dataTables.tables;
364
364
  * ```
365
365
  *
366
366
  * Use the `size` property to check how many data tables are available.
367
367
  *
368
- * ```js
368
+ * ```ts
369
369
  * const dataTables = ...;
370
370
  * const size = dataTables.size;
371
371
  * ```
372
372
  *
373
373
  * Use `getFirstSelectedTable` to access the first selected data table (the one shown in the result-ui).
374
374
  *
375
- * ```js
375
+ * ```ts
376
376
  * const dataTables = ...;
377
377
  * const dataTable = dataTables.getFirstSelectedTable();
378
378
  * ```
379
379
  *
380
380
  * You can watch the events `changed`, `selection-changed` and `destroyed`.
381
381
  *
382
- * ```js
382
+ * ```ts
383
383
  * const dataTables = ...;
384
384
  * dataTables.on("changed",({added, deleted, updated})=> { ... });
385
385
  * dataTables.on("selection-changed",({added, deleted, updated})=> { ... });
@@ -501,14 +501,14 @@ interface DataTableWatchProperties {
501
501
  *
502
502
  * You can watch for changes on the property `title`.
503
503
  *
504
- * ```js
504
+ * ```ts
505
505
  * const dataTable = ...;
506
506
  * dataTable.watch("title",({value})=> { ... });
507
507
  * ```
508
508
  *
509
509
  * You can watch the event `destroyed`.
510
510
  *
511
- * ```js
511
+ * ```ts
512
512
  * const dataTable = ...;
513
513
  * dataTable.on("destroyed",()=> { ... });
514
514
  * ```
@@ -584,7 +584,7 @@ type DataSource<IdType extends DatasetItemId = DatasetItemId, ItemType extends R
584
584
  *
585
585
  * You can watch the properties `title`, `itemCount`, `state`, `initError` and `updateError` for changes.
586
586
  *
587
- * ```js
587
+ * ```ts
588
588
  * const dataset = ...;
589
589
  * dataset.watch("state", ({value})=> {
590
590
  * const newState = value;
@@ -594,7 +594,7 @@ type DataSource<IdType extends DatasetItemId = DatasetItemId, ItemType extends R
594
594
  *
595
595
  * You can watch for the events `items-changed`, `destroyed`.
596
596
  *
597
- * ```js
597
+ * ```ts
598
598
  * const dataset = ...;
599
599
  * dataset.on("items-changed", ({added, deleted, updated})=> { ... });
600
600
  * dataset.on("destroyed",()=> { ... });
@@ -710,7 +710,7 @@ interface Dataset<IdType extends DatasetItemId = DatasetItemId> extends EventSou
710
710
  * It may completely re-fetch item data and drop no longer existing items.
711
711
  *
712
712
  * Equivalent to:
713
- * ```js
713
+ * ```ts
714
714
  * const allIds = await dataset.queryAllIds().toArray();
715
715
  * dataset.updateItemsById(allIds);
716
716
  * ```
@@ -919,7 +919,7 @@ type TableModelState = "disconnected" | "loading" | "loaded" | "load-error";
919
919
  *
920
920
  * You can watch the properties `columns`, `filterBy`, `sortBy`, `total`, `state` and `loadError` for changes.
921
921
  *
922
- * ```js
922
+ * ```ts
923
923
  * const dataset = ...;
924
924
  * dataset.watch("state", ({value})=> {
925
925
  * const newState = value;
@@ -929,7 +929,7 @@ type TableModelState = "disconnected" | "loading" | "loaded" | "load-error";
929
929
  *
930
930
  * You can watch for the events `selection-changed`, `focus-changed`, `rows-changed` and `destroyed`.
931
931
  *
932
- * ```js
932
+ * ```ts
933
933
  * const dataset = ...;
934
934
  * dataset.on("selection-changed", ({added, deleted })=> { ... });
935
935
  * dataset.on("focus-changed", ({focusedItemId})=> { ... });
@@ -1,4 +1,4 @@
1
- import { DataTable, TableItem, DataTableCollection } from '../__internal__/Cf0JLId0.js';
1
+ import { DataTable, TableItem, DataTableCollection } from '../__internal__/LZ4ypyEL.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__/Cf0JLId0.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__/LZ4ypyEL.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__/Cf0JLId0.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__/LZ4ypyEL.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__/Cf0JLId0.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__/LZ4ypyEL.js';
@@ -1,5 +1,5 @@
1
1
  import { Store, ComplexQueryExpression, QueryOptions } from 'store-api/api';
2
- import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/Cf0JLId0.js';
2
+ import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/LZ4ypyEL.js';
3
3
  import { EventSource, Handle } from 'apprt-core/Types';
4
4
  import 'esri/geometry';
5
5
 
@@ -31,7 +31,7 @@ interface ResultViewerServiceOpenOptions {
31
31
  *
32
32
  * Via the property `currentDataTables` the available data tables can be accessed.
33
33
  *
34
- * ```js
34
+ * ```ts
35
35
  * const resultViewerService = ...;
36
36
  * const currentlyAvailableDataTables = resultViewerService.currentDataTables;
37
37
  *
@@ -50,7 +50,7 @@ interface ResultViewerServiceOpenOptions {
50
50
  * ```
51
51
  *
52
52
  * It is possible to watch for the event `current-data-changed`:
53
- * ```js
53
+ * ```ts
54
54
  * const resultViewerService = ...;
55
55
  * resultViewerService.on("current-data-changed", ({shown, hidden})=>{
56
56
  * // shown is the new currentDataTables property
@@ -1,4 +1,4 @@
1
- import { DataTableCollection } from '../__internal__/Cf0JLId0.js';
1
+ import { DataTableCollection } from '../__internal__/LZ4ypyEL.js';
2
2
  import { EventSource } from 'apprt-core/Types';
3
3
  import 'esri/geometry';
4
4
  import 'store-api/api';
@@ -35,7 +35,7 @@ interface DataTableUiEvents {
35
35
  * Displays the data tables.
36
36
  *
37
37
  * It is possible to watch for the events `open-changed` and `destroyed` on the ui.
38
- * ```js
38
+ * ```ts
39
39
  * const ui = ...;
40
40
  * ui.on("open-changed",(open)=> { ... });
41
41
  * ui.on("destroyed",()=> { ... });
@@ -132,6 +132,13 @@ interface ResultSelectionHandle {
132
132
  */
133
133
  remove(): void;
134
134
  }
135
+ /**
136
+ * An event emitted via the Event Service using the topic name `search-api/QUERY`.
137
+ */
138
+ interface QueryEvent {
139
+ /** The original search query entered by the user. */
140
+ readonly query: string;
141
+ }
135
142
  /**
136
143
  * An event emitted via the Event Service using the topic name `search-api/SELECTED`.
137
144
  */
@@ -162,4 +169,4 @@ interface ItemSource {
162
169
  readonly storeProperties: Readonly<Record<string, unknown>>;
163
170
  }
164
171
 
165
- export type { ItemSource, ResultGroup, ResultItem, ResultSelectionHandle, ResultSet, Search, SearchOptions, SearchService, SearchStatus, SelectedEvent };
172
+ export type { ItemSource, QueryEvent, ResultGroup, ResultItem, ResultSelectionHandle, ResultSet, Search, SearchOptions, SearchService, SearchStatus, SelectedEvent };
@@ -25,7 +25,7 @@ interface SearchUiServiceEvents {
25
25
  * The service can be referenced via `search-ui.SearchUiService`.
26
26
  *
27
27
  * @example Reset the search
28
- * ```js
28
+ * ```ts
29
29
  * const service = this.searchUiService; // injected
30
30
  * service.reset();
31
31
  * // or
@@ -34,7 +34,7 @@ interface SearchUiServiceEvents {
34
34
  * ```
35
35
  *
36
36
  * @example Listen for reset event of the search ui
37
- * ```js
37
+ * ```ts
38
38
  * const service = this.searchUiService; // injected
39
39
  * service.on("reset", ()=>{
40
40
  * // react to the reset of the search ui
@@ -31,8 +31,8 @@ declare class ExtendedPromise<T> implements Promise<T> {
31
31
  * Creates Promise instances.
32
32
  * @param executor defined as (resolve,reject)=> \{\}
33
33
  * @example
34
- * ```js
35
- * new Promise((resolve,reject)=>{
34
+ * ```ts
35
+ * new Promise((resolve, reject)=>{
36
36
  * ...
37
37
  * });
38
38
  * ```
@@ -100,7 +100,7 @@ declare class ExtendedPromise<T> implements Promise<T> {
100
100
  * Allows to resolve/reject the promise manually after creating it.
101
101
  *
102
102
  * @example
103
- * ```js
103
+ * ```ts
104
104
  * const { promise, resolve, reject } = Promise.withResolvers();
105
105
  * ```
106
106
  * @returns {{ promise, resolve, reject }}
@@ -227,7 +227,7 @@ declare class ComplexQuery {
227
227
  * Internally used Parser.
228
228
  * Exported to allow new operations.
229
229
  * To add a new operator use:
230
- * ```js
230
+ * ```ts
231
231
  * ComplexQuery.Parser.prototype.operators[<name>] = <operator definition>
232
232
  * ```
233
233
  */
@@ -75,17 +75,18 @@ type QueryExecutionConstructorOptions<T> = Partial<Pick<QueryExecution<T>, "titl
75
75
  /**
76
76
  * Creates a QueryExecution instance
77
77
  *
78
- * ```js
79
- * import QueryExecution from "store-api/QueryExecution";
80
- * const execution = new QueryExecution({
81
- * title: "My Execution",
82
- * source: {
83
- * query(){
84
- * ...
85
- * }
86
- * },
87
- * parameters: []
88
- * })
78
+ * ```ts
79
+ * import QueryExecution from "store-api/QueryExecution";
80
+ *
81
+ * const execution = new QueryExecution({
82
+ * title: "My Execution",
83
+ * source: {
84
+ * query() {
85
+ * // ...
86
+ * }
87
+ * },
88
+ * parameters: []
89
+ * });
89
90
  * ```
90
91
  */
91
92
  type QueryExecutionConstructor<T> = new (options?: QueryExecutionConstructorOptions<T>) => QueryExecution<T>;
@@ -31,11 +31,12 @@ interface QueryExecutions extends Watchable {
31
31
  }
32
32
  /**
33
33
  * Creates QueryExecutions.
34
- * ```js
34
+ * ``ts
35
35
  * import QueryExecutions from "store-api/QueryExecutions";
36
+ * import QueryExecution from "store-api/QueryExecution";
36
37
  *
37
38
  * new QueryExecutions({
38
- * executions: [new QueryExecution({ source: ... })]
39
+ * executions: [new QueryExecution({ source: ... })]
39
40
  * })
40
41
  * ```
41
42
  * @param options Options that contain the query executions to add to the collection.
@@ -5,17 +5,17 @@ import 'esri/geometry/Geometry';
5
5
  /**
6
6
  * SpatialQuery registers and implements all SpatialOperators using the geometry engine of the esri js api.
7
7
  * @example
8
- * ```js
9
- * // This import ensures, that a ComplexQuery knows about the spatial operators.
10
- * import SpatialQuery from "store-api/SpatialQuery";
8
+ * ```ts
9
+ * // This import ensures, that a ComplexQuery knows about the spatial operators.
10
+ * import SpatialQuery from "store-api/SpatialQuery";
11
11
  *
12
- * const testGeom = ...;
13
- * const query = { "geometry": { $intersects: testGeom } };
14
- * const options = {};
15
- * if( SpatialQuery.isSpatialQuery(query)){
12
+ * const testGeom = {};
13
+ * const query = { geometry: { $intersects: testGeom } };
14
+ * const options = {};
15
+ * if (SpatialQuery.isSpatialQuery(query, options)) {
16
16
  * const complexQuery = SpatialQuery.parse(query, options);
17
- * ...
18
- * }
17
+ * // ...
18
+ * }
19
19
  * ```
20
20
  */
21
21
  type SpatialQueryType = (typeof ComplexQuery) & SpatialQueryExtension;
@@ -68,19 +68,19 @@ declare function toQueryResult<T extends {}>(result: undefined): ResultItems<T>;
68
68
  * This function creates a new function which can be used to implement
69
69
  * a Store.query method by evaluating and filtering data available in an iterable, e.g. array.
70
70
  *
71
- *
72
71
  * @example
73
- * ```js
72
+ * ```ts
74
73
  * import { createComplexQueryEngine } from "store-api/utils";
74
+ * import { AsyncStore, ComplexQueryExpression, QueryOptions } from "./api";
75
75
  *
76
- * class MyStore{
77
- *
78
- * items = [{a:1},{b:2}];
76
+ * type MyItemType = Record<string, any>;
79
77
  *
80
- * query(complexQuery, options){
81
- * // filter, sort, paginate the items array
82
- * return createComplexQueryEngine(complexQuery,options)(this.items);
83
- * }
78
+ * class MyStore implements AsyncStore<MyItemType> {
79
+ * items: MyItemType[] = [{ a: 1 }, { b: 2 }];
80
+ * async query(complexQuery?: ComplexQueryExpression, options?: QueryOptions) {
81
+ * // filter, sort, paginate the items array
82
+ * return createComplexQueryEngine(complexQuery, options)(this.items);
83
+ * }
84
84
  * }
85
85
  * ```
86
86
  * @param query a complex query expression
@@ -2,6 +2,9 @@ import { TocItem } from './Item.js';
2
2
  import 'esri/layers/Layer';
3
3
  import 'esri/layers/support/Sublayer';
4
4
  import 'esri/layers/support/WMSSublayer';
5
+ import 'esri/layers/buildingSublayers/BuildingGroupSublayer';
6
+ import 'esri/layers/buildingSublayers/BuildingComponentSublayer';
7
+ import 'esri/layers/BuildingSceneLayer';
5
8
  import 'esri/Map';
6
9
 
7
10
  /**
package/toc/api/Item.d.ts CHANGED
@@ -2,10 +2,13 @@
2
2
  import Layer from 'esri/layers/Layer';
3
3
  import Sublayer from 'esri/layers/support/Sublayer';
4
4
  import WMSSublayer from 'esri/layers/support/WMSSublayer';
5
+ import BuildingGroupSublayer from 'esri/layers/buildingSublayers/BuildingGroupSublayer';
6
+ import BuildingComponentSublayer from 'esri/layers/buildingSublayers/BuildingComponentSublayer';
7
+ import BuildingSceneLayer from 'esri/layers/BuildingSceneLayer';
5
8
  import EsriMap from 'esri/Map';
6
9
 
7
10
  type SublayerType = Sublayer | WMSSublayer;
8
- type RefType = EsriMap | Layer | SublayerType;
11
+ type RefType = EsriMap | Layer | SublayerType | BuildingGroupSublayer | BuildingSceneLayer | BuildingComponentSublayer;
9
12
  /**
10
13
  * Represents an item within the toc.
11
14
  */
@@ -3,6 +3,9 @@ import { TocItem } from './Item.js';
3
3
  import 'esri/layers/Layer';
4
4
  import 'esri/layers/support/Sublayer';
5
5
  import 'esri/layers/support/WMSSublayer';
6
+ import 'esri/layers/buildingSublayers/BuildingGroupSublayer';
7
+ import 'esri/layers/buildingSublayers/BuildingComponentSublayer';
8
+ import 'esri/layers/BuildingSceneLayer';
6
9
  import 'esri/Map';
7
10
 
8
11
  /**
@@ -4,5 +4,8 @@ export { CheckStateMessages, CheckStateOptions, CheckStateResult, StateChecker }
4
4
  import 'esri/layers/Layer';
5
5
  import 'esri/layers/support/Sublayer';
6
6
  import 'esri/layers/support/WMSSublayer';
7
+ import 'esri/layers/buildingSublayers/BuildingGroupSublayer';
8
+ import 'esri/layers/buildingSublayers/BuildingComponentSublayer';
9
+ import 'esri/layers/BuildingSceneLayer';
7
10
  import 'esri/Map';
8
11
  import 'map-widget/api';