@conterra/ct-mapapps-typings 4.17.1-next.20240402050329 → 4.18.0-RC-2

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 (111) hide show
  1. package/agssearch/api.d.ts +28 -1
  2. package/agssearch/package.json +1 -1
  3. package/apprt/package.json +1 -1
  4. package/apprt-binding/package.json +1 -1
  5. package/apprt-core/Promise.d.ts +3 -1
  6. package/apprt-core/config.d.ts +0 -8
  7. package/apprt-core/package.json +1 -1
  8. package/apprt-core/parallel.d.ts +23 -0
  9. package/apprt-core/reactivity.d.ts +1 -0
  10. package/apprt-dom/package.json +1 -1
  11. package/apprt-fetch/package.json +1 -1
  12. package/apprt-request/package.json +1 -1
  13. package/apprt-streams/package.json +1 -1
  14. package/apprt-tokens/package.json +1 -1
  15. package/apprt-vue/VueDijit.d.ts +3 -5
  16. package/apprt-vue/index.d.ts +16 -0
  17. package/apprt-vue/mixins/Bindable.d.ts +12 -7
  18. package/apprt-vue/package.json +2 -2
  19. package/apprt-vuetify/package.json +1 -1
  20. package/coordinatetransformer/api/CoordinateTransformer.d.ts +1 -0
  21. package/coordinatetransformer/api/TransformationProvider.d.ts +1 -0
  22. package/coordinatetransformer/api/TransformerStrategy.d.ts +1 -0
  23. package/coordinatetransformer/package.json +1 -1
  24. package/ct/package.json +1 -1
  25. package/ct/util/css.d.ts +3 -1
  26. package/dataform/package.json +1 -1
  27. package/dataview/package.json +1 -1
  28. package/domains-system/package.json +1 -1
  29. package/editing/api.d.ts +1 -0
  30. package/editing/package.json +1 -1
  31. package/esri-widgets/package.json +1 -1
  32. package/geojson/api.d.ts +2 -1
  33. package/geojson/package.json +1 -1
  34. package/geometryservice/api.d.ts +1 -0
  35. package/geometryservice/package.json +1 -1
  36. package/graphics/package.json +1 -1
  37. package/highlights/api.d.ts +1 -0
  38. package/highlights/package.json +1 -1
  39. package/integration-map/package.json +1 -1
  40. package/managementlayout/package.json +1 -1
  41. package/map-actions/api.d.ts +1 -0
  42. package/map-actions/package.json +1 -1
  43. package/map-basemaps-api/BasemapItem.d.ts +9 -9
  44. package/map-basemaps-api/BasemapsModel.d.ts +8 -9
  45. package/map-basemaps-api/api.d.ts +110 -0
  46. package/map-basemaps-api/package.json +1 -1
  47. package/map-config-api/api.d.ts +1 -0
  48. package/map-config-api/package.json +1 -1
  49. package/map-init/api.d.ts +69 -0
  50. package/map-init/package.json +5 -0
  51. package/map-widget/Constraints.d.ts +1 -1
  52. package/map-widget/LayerObserver.d.ts +1 -0
  53. package/map-widget/LayerTraverser.d.ts +1 -0
  54. package/map-widget/MapWidgetFactory.d.ts +2 -1
  55. package/map-widget/MapWidgetModel.d.ts +1 -1
  56. package/map-widget/ViewReadyWatcher.d.ts +1 -1
  57. package/map-widget/__internal__/{WNZbl61F.d.ts → I0BOBZBz.d.ts} +1 -0
  58. package/map-widget/api/Constraints.d.ts +1 -1
  59. package/map-widget/api/MapWidget.d.ts +1 -1
  60. package/map-widget/api/MapWidgetFactory.d.ts +2 -1
  61. package/map-widget/api/MapWidgetModel.d.ts +1 -1
  62. package/map-widget/api/MapWidgetRegistration.d.ts +2 -1
  63. package/map-widget/api/SrsChangeService.d.ts +2 -1
  64. package/map-widget/api/index.d.ts +1 -1
  65. package/map-widget/package.json +1 -1
  66. package/mapdraw-api/api.d.ts +1 -0
  67. package/mapdraw-api/package.json +1 -1
  68. package/mapnavigation/package.json +1 -1
  69. package/maptips/api.d.ts +1 -0
  70. package/maptips/package.json +1 -1
  71. package/omnisearch/ActionsHandler.d.ts +1 -1
  72. package/omnisearch/package.json +1 -1
  73. package/package.json +1 -1
  74. package/parametermanager/package.json +1 -1
  75. package/popups/BaseAction.d.ts +1 -0
  76. package/popups/ContentUpdateProxy.d.ts +1 -0
  77. package/popups/api.d.ts +1 -0
  78. package/popups/package.json +1 -1
  79. package/result-api/__internal__/{XYqJysD8.d.ts → Cf0JLId0.d.ts} +7 -1
  80. package/result-api/api/actions.d.ts +1 -1
  81. package/result-api/api/formatting.d.ts +1 -1
  82. package/result-api/api/index.d.ts +1 -1
  83. package/result-api/api/model.d.ts +1 -1
  84. package/result-api/api/service.d.ts +1 -1
  85. package/result-api/api/ui.d.ts +1 -1
  86. package/result-api/package.json +1 -1
  87. package/resultcenter/package.json +1 -1
  88. package/search-api/package.json +1 -1
  89. package/search-ui/package.json +1 -1
  90. package/selection-resultcenter/CachingStore.d.ts +3 -1
  91. package/selection-resultcenter/package.json +1 -1
  92. package/selection-services/DrawingSpatialInputAction.d.ts +1 -0
  93. package/selection-services/SpatialInputAction.d.ts +1 -0
  94. package/selection-services/TolerancePointDrawingInputAction.d.ts +1 -0
  95. package/selection-services/api/index.d.ts +1 -0
  96. package/selection-services/package.json +1 -1
  97. package/store-api/api/ComplexQueryLang.d.ts +1 -0
  98. package/store-api/api/Store.d.ts +6 -0
  99. package/store-api/package.json +1 -1
  100. package/style-guide/package.json +1 -1
  101. package/system/package.json +1 -1
  102. package/templatelayout/package.json +1 -1
  103. package/test-utils/package.json +1 -1
  104. package/theme-tester/package.json +1 -1
  105. package/toc/api/Item.d.ts +1 -0
  106. package/toc/package.json +1 -1
  107. package/toolrules/package.json +1 -1
  108. package/toolset/package.json +1 -1
  109. package/vuetify-component-overview/package.json +1 -1
  110. package/windowmanager/package.json +1 -1
  111. package/wizard/package.json +1 -1
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import Layer from 'esri/layers/Layer';
2
3
  import Sublayer from 'esri/layers/support/Sublayer';
3
4
  import { AsyncStore } from 'store-api/api';
@@ -84,7 +85,7 @@ interface AGSStoreFromURLOptions extends AGSStoreCommonOptions {
84
85
  /**
85
86
  * The type of the service. Defaults to "feature".
86
87
  */
87
- type?: "feature" | "geojson" | "csv" | "wfs";
88
+ type?: "feature" | "geojson" | "csv" | "wfs" | "ogc-feature";
88
89
  /**
89
90
  * An API key (or token) required to access the service.
90
91
  *
@@ -99,6 +100,32 @@ interface AGSStoreFromURLOptions extends AGSStoreCommonOptions {
99
100
  * A list of URL parameters which will be appended during fetching of the layer.
100
101
  */
101
102
  customParameters?: object;
103
+ /**
104
+ * Specifies the collectionId of a ogc-feature layer.
105
+ */
106
+ collectionId?: string;
107
+ /**
108
+ * Specifies the objectIdField of a ogc-feature layer.
109
+ * Default is 'id'
110
+ */
111
+ objectIdField?: string;
112
+ /**
113
+ * Flag for ogc-feature layer, to enable queries for features using the objectIdField property.
114
+ * Default is false.
115
+ */
116
+ supportsIdQueries?: boolean;
117
+ /**
118
+ * Flag to indicate that the layer supports filtering using POST requests.
119
+ * Default is `false` for non ArcGIS OGCFeaturesServices,
120
+ * which means that requests with long query strings will fail.
121
+ * If `supportsIdQueries` is `true` and `supportsPostQueries` is `false`
122
+ * then these id queries are split to ensure GET requests are used for feature lookup by ids.
123
+ */
124
+ supportsPostQueries?: boolean;
125
+ /**
126
+ * Name of the geometry field for polygon queries against OGCFeatureServices.
127
+ */
128
+ geometryFieldName?: string;
102
129
  }
103
130
  /**
104
131
  * The type of stores created by the {@link AGSStoreFactory}.
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "agssearch",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-binding",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -59,7 +59,9 @@ declare class ExtendedPromise<T> implements Promise<T> {
59
59
  *
60
60
  * @param iterable Iterable of Promise instances
61
61
  */
62
- static all<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T[]>;
62
+ static all<T extends readonly unknown[] | []>(iterable: T): ExtendedPromise<{
63
+ -readonly [P in keyof T]: Awaited<T[P]>;
64
+ }>;
63
65
  /**
64
66
  * Creates promise which fulfills if one of the other promises fulfills.
65
67
  * Or rejects if one of the promises rejects.
@@ -126,10 +126,6 @@ interface WellknownConfigKeys {
126
126
  * The client-id or app-id to authenticated with.
127
127
  */
128
128
  "oauth-app-id": string;
129
- /**
130
- * A special namespace value.
131
- * Experimental, ignore that.
132
- */
133
129
  "oauth-namespace": string;
134
130
  /**
135
131
  * Should the login dialog be shown inside a popup.
@@ -140,10 +136,6 @@ interface WellknownConfigKeys {
140
136
  * Only of interest if oauth-use-popup is true.
141
137
  */
142
138
  "oauth-popup-callback-page": string;
143
- /**
144
- * Flag to enforce a login,
145
- * Experimental, ignore that.
146
- */
147
139
  "oauth-force-login": string;
148
140
  /**
149
141
  * Refresh interval for geo-location updates.
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-core",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -0,0 +1,23 @@
1
+ /**
2
+ * An asynchronous function.
3
+ */
4
+ type Task<T> = () => Promise<T>;
5
+ /**
6
+ * Options for {@link runParallel}.
7
+ */
8
+ interface RunParallelOptions {
9
+ /**
10
+ * The number of tasks that can be executed in parallel.
11
+ * Defaults to 4.
12
+ */
13
+ parallelTasks?: number;
14
+ }
15
+ /**
16
+ * Runs the given array of tasks in parallel.
17
+ * @param tasks The tasks the execute.
18
+ * @param options Additional options.
19
+ * @returns An array of promises that resolve to results, in the same order as `tasks`.
20
+ */
21
+ declare function runParallel<T>(tasks: Task<T>[], options?: RunParallelOptions): Promise<T>[];
22
+
23
+ export { type RunParallelOptions, type Task, runParallel };
@@ -0,0 +1 @@
1
+ export * from '@conterra/reactivity-core';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-dom",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": "./index.d.ts"
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-fetch",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": "./index.d.ts"
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-request",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": "./main.d.ts"
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-streams",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-tokens",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,14 +1,12 @@
1
1
  /**
2
2
  * Wraps a vue instance inside a Dijit Widget.
3
3
  *
4
- * @alias module:VueDijit
5
- * @param {Object} defOrVueInstance
6
- * @param {Object} [options]
4
+ * @param defOrVueInstance
7
5
  * @returns The Dijit Widget instance.
8
6
  */
9
- declare function createWidget(defOrVueInstance: Object, options?: Object | undefined): any;
7
+ declare function createWidget(defOrVueInstance: any, options?: any): any;
10
8
  declare namespace createWidget {
11
- function fromVueObj(obj: any, options?: {}): any;
9
+ var fromVueObj: (obj: any, options?: any) => any;
12
10
  }
13
11
 
14
12
  export { createWidget as default };
@@ -0,0 +1,16 @@
1
+ import { ShallowRef } from 'vue';
2
+
3
+ /**
4
+ * This composable integrates reactive values into the vue reactivity system.
5
+ * From within `compute`, you can reference any reactive values and return some derived value.
6
+ * That value will refresh (for your vue component) whenever any of its reactive dependencies change.
7
+ *
8
+ * Because `compute` may be called very often (if there are many updates), it should be fast.
9
+ *
10
+ * @param compute A function that may access reactive data and returns some derived result.
11
+ * @typeParam T The return type of `compute`.
12
+ * @returns A readonly vue reference (the snapshot). `snapshot.value` is the current value of `compute()`.
13
+ */
14
+ declare function useReactiveSnapshot<T>(compute: () => T): Readonly<ShallowRef<T>>;
15
+
16
+ export { useReactiveSnapshot };
@@ -1,9 +1,14 @@
1
- declare namespace Bindable {
2
- namespace methods {
3
- function get(vmProp: any): any;
4
- function set(vmProp: any, value: any): void;
5
- function watch(vmProp: any, callback: any): any;
6
- }
7
- }
1
+ /**
2
+ * Bindable Mixin for use in .vue files.
3
+ */
4
+ declare const Bindable: {
5
+ methods: {
6
+ get(this: any, vmProp: string): any;
7
+ set(this: any, vmProp: string, value: any): void;
8
+ watch(this: any, vmProp: string, callback: (...args: any[]) => void): {
9
+ remove(): void;
10
+ };
11
+ };
12
+ };
8
13
 
9
14
  export { Bindable as default };
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-vue",
3
- "version": "4.17.1-SNAPSHOT",
4
- "types": ""
3
+ "version": "4.18.0-RC-2",
4
+ "types": "./index.d.ts"
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "apprt-vuetify",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import { SpatialReference, Geometry, Extent } from 'esri/geometry';
2
3
 
3
4
  /** Helper type to represent an item or an array of items. */
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import { SpatialReference } from 'esri/geometry';
2
3
  import GeographicTransformation from 'esri/geometry/support/GeographicTransformation';
3
4
  import GeographicTransformationStep from 'esri/geometry/support/GeographicTransformationStep';
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import { Geometry, SpatialReference } from 'esri/geometry';
2
3
  import { Items } from './CoordinateTransformer.js';
3
4
 
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "coordinatetransformer",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
package/ct/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "ct",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": "./main.d.ts"
5
5
  }
package/ct/util/css.d.ts CHANGED
@@ -61,7 +61,9 @@ declare class ExtendedPromise<T> implements Promise<T> {
61
61
  *
62
62
  * @param iterable Iterable of Promise instances
63
63
  */
64
- static all<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T[]>;
64
+ static all<T extends readonly unknown[] | []>(iterable: T): ExtendedPromise<{
65
+ -readonly [P in keyof T]: Awaited<T[P]>;
66
+ }>;
65
67
  /**
66
68
  * Creates promise which fulfills if one of the other promises fulfills.
67
69
  * Or rejects if one of the promises rejects.
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "dataform",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "dataview",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "domains-system",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
package/editing/api.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import Graphic from 'esri/Graphic';
2
3
  import FeatureLayer from 'esri/layers/FeatureLayer';
3
4
  import Editor from 'esri/widgets/Editor';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "editing",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "esri-widgets",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
package/geojson/api.d.ts CHANGED
@@ -1,4 +1,5 @@
1
- import { Geometry } from 'esri/geometry';
1
+ /// <reference types="arcgis-js-api" />
2
+ import Geometry from 'esri/geometry/Geometry';
2
3
 
3
4
  /**
4
5
  * Provides the means to transform between WKT strings, GeoJSON and `esri/Geometry` objects.
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "geojson",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import { Geometry } from 'esri/geometry';
2
3
  import Point from 'esri/geometry/Point';
3
4
  import Polygon from 'esri/geometry/Polygon';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "geometryservice",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "graphics",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import Collection from 'esri/core/Collection';
2
3
  import Graphic from 'esri/Graphic';
3
4
  import esriSymbol from 'esri/symbols/Symbol';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "highlights",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "integration-map",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "managementlayout",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import { EventSource } from 'apprt-core/Events';
2
3
  import { Geometry } from 'esri/geometry';
3
4
  import { PopupTemplateDefinition } from 'popups/api';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "map-actions",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,15 +1,15 @@
1
- import * as apprt_core_Mutable from 'apprt-core/Mutable';
1
+ /// <reference types="arcgis-js-api" />
2
+ import { MutableConstructor } from 'apprt-core/Mutable';
3
+ import { BasemapItem as BasemapItem$1 } from './api.js';
4
+ import Basemap from 'esri/Basemap';
2
5
 
3
- /**
4
- * @class Items within BasemapsModel.
5
- * @alias module:BasemapItem
6
- */
7
- declare const BasemapItem: apprt_core_Mutable.MutableConstructor<{
8
- id: string | undefined;
6
+ declare const BasemapItem: MutableConstructor<{
7
+ id: string;
9
8
  title: string | undefined;
10
9
  description: string | undefined;
11
- basemap: any;
10
+ basemap: Basemap | undefined;
12
11
  thumbnailUrl: string | undefined;
13
12
  }>;
13
+ type BasemapItem = BasemapItem$1;
14
14
 
15
- export { BasemapItem as default };
15
+ export { BasemapItem, BasemapItem as default };
@@ -1,11 +1,10 @@
1
- import * as apprt_core_Mutable from 'apprt-core/Mutable';
1
+ import { BasemapsModelMembers, BasemapItem, BasemapItemProps, BasemapsModel as BasemapsModel$1 } from './api.js';
2
+ import 'apprt-core/Mutable';
3
+ import 'esri/Basemap';
2
4
 
3
- /**
4
- * @class BasemapsModel contains list of BasemapItems.
5
- * @alias module:BasemapsModel
6
- */
7
- declare const BasemapsModel: apprt_core_Mutable.MutableConstructor<{
8
- [x: string]: any;
9
- }>;
5
+ declare const BasemapsModel: new (options?: Partial<Omit<BasemapsModelMembers, "basemaps"> & {
6
+ basemaps: (BasemapItem | BasemapItemProps)[];
7
+ }>) => BasemapsModel$1;
8
+ type BasemapsModel = BasemapsModel$1;
10
9
 
11
- export { BasemapsModel as default };
10
+ export { BasemapsModel, BasemapsModel as default };
@@ -0,0 +1,110 @@
1
+ /// <reference types="arcgis-js-api" />
2
+ import { Mutable } from 'apprt-core/Mutable';
3
+ import Basemap from 'esri/Basemap';
4
+
5
+ /**
6
+ * Documentation for the members of {@link BasemapsModel}.
7
+ */
8
+ interface BasemapsModelMembers {
9
+ /**
10
+ * Id of selected basemap item.
11
+ */
12
+ selectedId: string | undefined;
13
+ /**
14
+ * Getter for the selected basemap item.
15
+ */
16
+ readonly selected: BasemapItem | undefined;
17
+ /**
18
+ * Array of basemap items.
19
+ */
20
+ get basemaps(): BasemapItem[];
21
+ /**
22
+ * Setter for the basemap items array.
23
+ */
24
+ set basemaps(value: (BasemapItem | BasemapItemProps)[]);
25
+ /**
26
+ * Object lookup for style classes.
27
+ */
28
+ styleLookup: Record<string, any> | undefined;
29
+ /**
30
+ * Adds the basemap item to the basemaps array.
31
+ */
32
+ add(item: BasemapItem | BasemapItemProps): BasemapsModel;
33
+ /**
34
+ * Removes basemap item from the basemaps array.
35
+ */
36
+ remove(item: Pick<BasemapItem, "id">): BasemapsModel;
37
+ /**
38
+ * Removes the basemap item with the given `id` from the basemaps array.
39
+ */
40
+ removeById(id: string): BasemapsModel;
41
+ /**
42
+ * Removes all basemap items and selectedId state.
43
+ */
44
+ clear(): BasemapsModel;
45
+ /**
46
+ * Returns `true` if basemaps are empty.
47
+ */
48
+ isEmpty(): boolean;
49
+ /**
50
+ * Finds the first item with the given id.
51
+ */
52
+ findItemById(id: string): BasemapItem | undefined;
53
+ /**
54
+ * Finds the first item referencing the given Basemap.
55
+ */
56
+ findItemByBasemap(basemap: Basemap): BasemapItem | undefined;
57
+ }
58
+ /**
59
+ * The `BasemapsModel` contains a list of BasemapItems.
60
+ */
61
+ type BasemapsModel = Mutable<BasemapsModelMembers>;
62
+ /**
63
+ * Documentation for the members of {@link BasemapItem}.
64
+ */
65
+ interface BasemapItemMembers {
66
+ /**
67
+ * A basemap item needs an id.
68
+ */
69
+ id: string;
70
+ /**
71
+ * The title of the item.
72
+ */
73
+ title: string | undefined;
74
+ /**
75
+ * The description of the item.
76
+ */
77
+ description: string | undefined;
78
+ /**
79
+ * The esri.Basemap instance.
80
+ */
81
+ basemap: Basemap | undefined;
82
+ /**
83
+ * An optional thumbnail url.
84
+ */
85
+ thumbnailUrl: string | undefined;
86
+ }
87
+ /**
88
+ * Represents a basemap in the {@link BasemapsModel}.
89
+ */
90
+ type BasemapItem = Mutable<BasemapItemMembers>;
91
+ type BasemapItemProps = Partial<BasemapItemMembers>;
92
+ /**
93
+ * Registers {@link BasemapsModel | BasemapsModels} with the system.
94
+ *
95
+ * Use `"map-basemaps-api.BasemapsModelRegistration"` to inject an instance of this service.
96
+ */
97
+ interface BasemapModelRegistration {
98
+ /**
99
+ * Registers a given BasemapsModel with the system.
100
+ */
101
+ register(options: {
102
+ basemaps: BasemapsModel;
103
+ }): void;
104
+ /**
105
+ * Unregister the BasemapsModel instance.
106
+ */
107
+ unregister(keepInstances?: boolean): void;
108
+ }
109
+
110
+ export type { BasemapItem, BasemapItemMembers, BasemapItemProps, BasemapModelRegistration, BasemapsModel, BasemapsModelMembers };
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "map-basemaps-api",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }
@@ -1,3 +1,4 @@
1
+ /// <reference types="arcgis-js-api" />
1
2
  import { ExtensibleUnion } from 'apprt-core/Types';
2
3
  import Basemap from 'esri/Basemap';
3
4
  import Ground from 'esri/Ground';
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "map-config-api",
3
- "version": "4.17.1-SNAPSHOT",
3
+ "version": "4.18.0-RC-2",
4
4
  "types": ""
5
5
  }