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

package/integration-map/api.d.ts

@@ -38,10 +38,10 @@ interface IntegrationExtension {
      * @param callback function to be informed when map is ready for change
      *
      * @example <caption>wait until map is ready</caption>
-     * ```js
-     *    api.whenMapReady(function(){
-     *       api.zoomTo(...)
-     *    });
+     * ```ts
+     * api.whenMapReady(function () {
+     *     api.zoomTo(geom);
+     * });
      * ```
      */
     whenMapReady(callback: () => any): Promise<void>;
@@ -52,13 +52,16 @@ interface IntegrationExtension {
      * @param options Options used to zoom
      *
      * @example <caption>zoom to point</caption>
-     * ```js
-     *    api.zoomTo({
-     *          x: 7,
-     *          y: 52
-     *    },{
-     *      scale: 5000
-     *    });
+     * ```ts
+     * api.zoomTo(
+     *     {
+     *         x: 7,
+     *         y: 52
+     *     },
+     *     {
+     *         scale: 5000
+     *     }
+     * );
      * ```
      */
     zoomTo(geom: any, options?: ZoomOptions): Promise<void>;
@@ -75,7 +78,7 @@ interface IntegrationExtension {
      *
      * @example <caption>Highlight geometry</caption>
      *
-     * ```js
+     * ```ts
      * api.highlight({
      *     x: 7,
      *     y: 52
@@ -84,36 +87,36 @@ interface IntegrationExtension {
      *
      * @example <caption>Highlight geometry with custom symbol</caption>
      *
-     * ```js
-     *   api.highlight({
-     *      geometry: {
-     *        x: 7,
-     *        y: 52
-     *      },
-     *      symbol: {
-     *          type: "simple-marker",
-     *          color: [0, 255, 255, 0.25],
-     *          size: 16,
-     *          outline: {
+     * ```ts
+     * api.highlight({
+     *     geometry: {
+     *         x: 7,
+     *         y: 52
+     *     },
+     *     symbol: {
+     *         type: "simple-marker",
+     *         color: [0, 255, 255, 0.25],
+     *         size: 16,
+     *         outline: {
      *             color: [0, 255, 255, 1],
      *             width: 2
-     *          }
-     *      }
-     *    });
+     *         }
+     *     }
+     * });
      * ```
      *
      * @example <caption>Highlight geometry with custom popupTemplate</caption>
      *
-     * ```js
-     *   api.highlight({
-     *      geometry: {
-     *        x: 7,
-     *        y: 52
-     *      },
-     *      popupTemplate: {
+     * ```ts
+     * api.highlight({
+     *     geometry: {
+     *         x: 7,
+     *         y: 52
+     *     },
+     *     popupTemplate: {
      *         title: "My City"
-     *      }
-     *    });
+     *     }
+     * });
      * ```
      */
     highlight(geomOrGraphic: any): Promise<void>;

package/map-actions/api.d.ts

@@ -57,12 +57,16 @@ interface OpenPopupActionOptions extends ActionOptions {
  *
  * @example
  *
- * ```js
+ * ```ts
  * actionService.trigger(["zoomto"], {
- *     items: [{geometry: new Point({
- *          x: 7.5,
- *          y: 52
- *     })}],
+ *     items: [
+ *         {
+ *             geometry: new Point({
+ *                 x: 7.5,
+ *                 y: 52
+ *             })
+ *         }
+ *     ],
  *     "zoomto-point-scale": 5000
  * });
  * ```

package/map-config-api/api.d.ts

@@ -18,6 +18,8 @@ import MapImageLayer from 'esri/layers/MapImageLayer';
 import OGCFeatureLayer from 'esri/layers/OGCFeatureLayer';
 import OpenStreetMapLayer from 'esri/layers/OpenStreetMapLayer';
 import SceneLayer from 'esri/layers/SceneLayer';
+import BuildingSceneLayer from 'esri/layers/BuildingSceneLayer';
+import PointCloudLayer from 'esri/layers/PointCloudLayer';
 import StreamLayer from 'esri/layers/StreamLayer';
 import TileLayer from 'esri/layers/TileLayer';
 import VectorTileLayer from 'esri/layers/VectorTileLayer';
@@ -44,6 +46,8 @@ interface LayerTypesLookup {
     AGS_VECTORTILE: [VectorTileLayer, __esri.VectorTileLayerProperties];
     AGS_ELEVATION: [ElevationLayer, __esri.ElevationLayerProperties];
     AGS_SCENE: [SceneLayer, __esri.SceneLayerProperties];
+    AGS_BUILDING: [BuildingSceneLayer, __esri.BuildingSceneLayerProperties];
+    AGS_POINTCLOUD: [PointCloudLayer, __esri.PointCloudLayerProperties];
     AGS_STREAM: [StreamLayer, __esri.StreamLayerProperties];
     WFS: [WFSLayer, __esri.WFSLayerProperties];
     WMS: [WMSLayer, __esri.WMSLayerProperties];
@@ -89,6 +93,24 @@ type LayerType = ExtensibleUnion<WellKnownLayerType, string>;
  * Properties supported by a group layer.
  */
 type GroupLayerProperties = LayerPropertiesForType<"GROUP">;
+/**
+ * Factory for layer types.
+ */
+interface LayerTypeFactory {
+    /**
+     * Esri type of the layer produced e.g. "web-tiled".
+     * Transports the value of the layerInstance.type property
+     */
+    esriType?: string;
+    /**
+     * Creates instances of layers of a certain type.
+     */
+    create(opts: Record<string, any>): Promise<{
+        instance: any;
+    }> | {
+        instance: any;
+    };
+}
 /**
  * Creates instances of layers of different types.
  *
@@ -149,7 +171,7 @@ interface BasemapConfigObject {
     /**
      * A well known Basemap id, such as `"streets-vector"`.
      *
-     * Cannot be combined with {@link baseLayers}.
+     * Cannot be combined with {@link baseLayers} or {@link style}.
      */
     id?: string;
     /** @deprecated Use {@link baseLayers} instead. */
@@ -157,9 +179,15 @@ interface BasemapConfigObject {
     /**
      * Layers to use when constructed the new base map.
      *
-     * Cannot be combined with {@link id}.
+     * Cannot be combined with {@link id} or {@link style}.
      */
     baseLayers?: LayerProperties[];
+    /**
+     * Basemap style to use when constructing the new basemap.
+     *
+     * Cannot be combined with {@link id} or {@link baseLayers}.
+     */
+    style?: __esri.BasemapStyleProperties;
     /**
      * Optional title for the new Basemap.
      */
@@ -307,4 +335,4 @@ interface GroundConfigParser {
     }>;
 }
 
-export type { BasemapConfigObject, BasemapConfigParser, BasemapParserOptions, ElevationLayerProperties, ExtendedLayerProperties, GroundConfigParser, GroundProperties, GroupLayerProperties, LayerClassForType, LayerConfigParser, LayerFactory, LayerProperties, LayerPropertiesForType, LayerType, WellKnownLayerType };
+export type { BasemapConfigObject, BasemapConfigParser, BasemapParserOptions, ElevationLayerProperties, ExtendedLayerProperties, GroundConfigParser, GroundProperties, GroupLayerProperties, LayerClassForType, LayerConfigParser, LayerFactory, LayerProperties, LayerPropertiesForType, LayerType, LayerTypeFactory, WellKnownLayerType };

package/map-init/api.d.ts

@@ -15,13 +15,13 @@ interface ConfigInterpreter {
      * @param config the json config input.
      * @example
      *
-     * ```js
-     * let interpreter = ...;
-     * let result = interpreter.interpret({map: {basemap: "streets"}});
+     * ```ts
+     * const interpreter = ...;
+     * const result = interpreter.interpret({map: {basemap: "streets"}});
      * // create widget and model classes
-     * let {mapWidget, mapWidgetModel, map, basemapsModel} = await result.toMapWidget();
+     * const {mapWidget, mapWidgetModel, map, basemapsModel} = await result.toMapWidget();
      * // alternative is to only create the model classes
-     * let {mapWidgetModel, map, basemapsModel} = await result.toMapWidgetModel();
+     * const {mapWidgetModel, map, basemapsModel} = await result.toMapWidgetModel();
      * ```
      */
     interpret(config: Record<string, any>): InterpreterResult;

package/map-widget/Constraints.d.ts

@@ -1,5 +1,5 @@
 import * as apprt_core_Mutable from 'apprt-core/Mutable';
-import { ViewMode, Constraints as Constraints$1 } from './__internal__/I0BOBZBz.js';
+import { ViewMode, Constraints as Constraints$1 } from './__internal__/DFiGfJS1.js';
 import 'esri/geometry';
 import 'esri/layers/support/LOD';
 import 'esri/Camera';

package/map-widget/LayerObserver.d.ts

@@ -6,6 +6,9 @@ import Map from 'esri/Map';
 import Collection from 'esri/core/Collection';
 import Sublayer from 'esri/layers/support/Sublayer';
 import WMSSublayer from 'esri/layers/support/WMSSublayer';
+import BuildingGroupSublayer from 'esri/layers/buildingSublayers/BuildingGroupSublayer';
+import BuildingComponentSublayer from 'esri/layers/buildingSublayers/BuildingComponentSublayer';
+import BuildingSceneLayer from 'esri/layers/BuildingSceneLayer';
 
 type NotifyReason = "added" | "removed" | "moved";
 type Context = Context$1<LayerNode> & {
@@ -25,16 +28,17 @@ type Context = Context$1<LayerNode> & {
         moved: true;
     });
 };
+type LayerType = Layer | Sublayer | WMSSublayer | BuildingGroupSublayer | BuildingSceneLayer | BuildingComponentSublayer;
 interface LayerObserverOptions {
     map: Map;
-    layers: Collection<Layer | Sublayer | WMSSublayer>;
+    layers: Collection<LayerType>;
     onlyWatching: boolean;
     notify(layer: LayerNode, context: Context): void;
     filter(layer: LayerNode, context: Context): undefined | boolean | VisitCodes;
 }
 interface LayerObserver {
     map: Map | undefined;
-    layers: Collection<Layer | Sublayer | WMSSublayer> | undefined;
+    layers: Collection<LayerType> | undefined;
     start(skipInitial?: boolean): void;
     stop(skipCleanup?: boolean): void;
 }

package/map-widget/LayerTraverser.d.ts

@@ -4,12 +4,15 @@ import Collection from 'esri/core/Collection';
 import Layer from 'esri/layers/Layer';
 import Sublayer from 'esri/layers/support/Sublayer';
 import WMSSublayer from 'esri/layers/support/WMSSublayer';
+import BuildingGroupSublayer from 'esri/layers/buildingSublayers/BuildingGroupSublayer';
+import BuildingComponentSublayer from 'esri/layers/buildingSublayers/BuildingComponentSublayer';
+import BuildingSceneLayer from 'esri/layers/BuildingSceneLayer';
 import Map from 'esri/Map';
 
 interface LayerTraverser {
     traverse(localOptions?: Partial<LayerTraverserOptions>): void;
 }
-type LayerLike = Layer | Sublayer | WMSSublayer | Map | {
+type LayerLike = Layer | Sublayer | WMSSublayer | BuildingGroupSublayer | BuildingSceneLayer | BuildingComponentSublayer | Map | {
     layers: LayerNode[] | Collection<LayerNode>;
 };
 type LayerNode = LayerLike & {

package/map-widget/MapWidgetFactory.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="arcgis-js-api" />
 import Map from 'esri/Map';
-import { MapWidgetModel } from './__internal__/I0BOBZBz.js';
+import { MapWidgetModel } from './__internal__/DFiGfJS1.js';
 import { MapWidget } from './api/MapWidget.js';
 import { MapWidgetFactory as MapWidgetFactory$1 } from './api/MapWidgetFactory.js';
 import 'apprt-core/Mutable';

package/map-widget/MapWidgetModel.d.ts

@@ -1,4 +1,4 @@
-import { MapWidgetModelMembers, MapWidgetModel as MapWidgetModel$1 } from './__internal__/I0BOBZBz.js';
+import { MapWidgetModelMembers, MapWidgetModel as MapWidgetModel$1 } from './__internal__/DFiGfJS1.js';
 import 'apprt-core/Mutable';
 import 'esri/geometry';
 import 'esri/layers/support/LOD';

package/map-widget/ViewReadyWatcher.d.ts

@@ -1,4 +1,4 @@
-import { MapWidgetModel } from './__internal__/I0BOBZBz.js';
+import { MapWidgetModel } from './__internal__/DFiGfJS1.js';
 import 'apprt-core/Mutable';
 import 'esri/geometry';
 import 'esri/layers/support/LOD';

package/map-widget/__internal__/{I0BOBZBz.d.ts → DFiGfJS1.d.ts}

@@ -244,7 +244,7 @@ interface ConstraintsMembers {
      * Specifies a constraint on the minimum and maximum allowed camera altitude. Only valid for 3D.
      *
      * @example
-     * ```js
+     * ```ts
      * constraints.altitude = {
      *   // The minimum allowed camera altitude (in meters).
      *   min: 1000,
@@ -258,7 +258,7 @@ interface ConstraintsMembers {
      * Specifies the near and far webgl clip distances. Only valid for 3D.
      *
      * @example
-     * ```js
+     * ```ts
      * constraints.clipDistance  = {
      *   // The near clip distance.
      *   near: 100,
@@ -278,7 +278,7 @@ interface ConstraintsMembers {
      * Specifies a constraint on the amount of allowed tilting of the view. Only valid for 3D.
      *
      * @example
-     * ```js
+     * ```ts
      * constraints.tilt  = {
      *   // Specifies the maximum amount of tilt (in degrees) allowed in the view and may range from 0.5 to 179.5
      *   // degrees.

package/map-widget/api/Constraints.d.ts

@@ -1,7 +1,7 @@
 import 'apprt-core/Mutable';
 import 'esri/geometry';
 import 'esri/layers/support/LOD';
-export { Constraints, ConstraintsMembers } from '../__internal__/I0BOBZBz.js';
+export { Constraints, ConstraintsMembers } from '../__internal__/DFiGfJS1.js';
 import 'esri/Camera';
 import 'esri/Map';
 import 'esri/TimeExtent';

package/map-widget/api/MapWidget.d.ts

@@ -1,4 +1,4 @@
-import { MapWidgetModel } from '../__internal__/I0BOBZBz.js';
+import { MapWidgetModel } from '../__internal__/DFiGfJS1.js';
 import 'apprt-core/Mutable';
 import 'esri/geometry';
 import 'esri/layers/support/LOD';

package/map-widget/api/MapWidgetFactory.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="arcgis-js-api" />
 import Map from 'esri/Map';
 import { MapWidget } from './MapWidget.js';
-import { MapWidgetModelMembers, MapWidgetModel } from '../__internal__/I0BOBZBz.js';
+import { MapWidgetModelMembers, MapWidgetModel } from '../__internal__/DFiGfJS1.js';
 import 'apprt-core/Mutable';
 import 'esri/geometry';
 import 'esri/layers/support/LOD';

package/map-widget/api/MapWidgetModel.d.ts

@@ -6,6 +6,6 @@ import 'esri/TimeExtent';
 import 'esri/Viewpoint';
 import 'esri/views/MapView';
 import 'esri/views/SceneView';
-export { MapWidgetModel, MapWidgetModelMembers, View, ViewMode, ViewPadding } from '../__internal__/I0BOBZBz.js';
+export { MapWidgetModel, MapWidgetModelMembers, View, ViewMode, ViewPadding } from '../__internal__/DFiGfJS1.js';
 import './Navigation.js';
 import 'esri/layers/support/LOD';

package/map-widget/api/MapWidgetRegistration.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="arcgis-js-api" />
 import Map from 'esri/Map';
 import { MapWidget } from './MapWidget.js';
-import { MapWidgetModel } from '../__internal__/I0BOBZBz.js';
+import { MapWidgetModel } from '../__internal__/DFiGfJS1.js';
 import 'apprt-core/Mutable';
 import 'esri/geometry';
 import 'esri/layers/support/LOD';
@@ -34,17 +34,28 @@ interface MapWidgetRegistration {
      * @param params components to register `{ map, mapWidgetModel, mapWidget }`
      *
      * @example
-     * ```js
-     * let mapregistration = this._mapregistration;
-     * let mapfactory = this._mapfactory;
-     * let map = mapfactory.createMap({...});
-     * let model = mapfactory.createWidgetModel({map, ...});
-     * let widget = mapfactory.createWidget({model});
-     * mapregistration.register({
-     *      map : map,
-     *      mapWidgetModel : model,
-     *      mapWidget: widget
-     * });
+     * ```ts
+     * import { InjectedReference } from "apprt-core/InjectedReference";
+     * import { MapWidgetRegistration } from "map-widget/MapWidgetRegistration";
+     * import MapWidgetFactory from "map-widget/MapWidgetFactory";
+     *
+     * class MyComponent {
+     *     private _mapregistration: InjectedReference<MapWidgetRegistration>;
+     *     private _mapfactory: InjectedReference<MapWidgetFactory>;
+     *
+     *     activate() {
+     *         const mapregistration = this._mapregistration!;
+     *         const mapfactory = this._mapfactory!;
+     *         const map = mapfactory.createMap({...});
+     *         const model = mapfactory.createWidgetModel({map, ...});
+     *         const widget = mapfactory.createWidget({model});
+     *         mapregistration.register({
+     *             map: map,
+     *             mapWidgetModel: model,
+     *             mapWidget: widget
+     *         });
+     *     }
+     * }
      * ```
      */
     register(params: {

package/map-widget/api/SrsChangeService.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="arcgis-js-api" />
 import { SpatialReference } from 'esri/geometry';
 import { MapWidget } from './MapWidget.js';
-import '../__internal__/I0BOBZBz.js';
+import '../__internal__/DFiGfJS1.js';
 import 'apprt-core/Mutable';
 import 'esri/layers/support/LOD';
 import 'esri/Camera';

package/map-widget/api/index.d.ts

@@ -1,4 +1,4 @@
-export { Constraints, ConstraintsMembers, MapWidgetModel, MapWidgetModelMembers, View, ViewMode, ViewPadding } from '../__internal__/I0BOBZBz.js';
+export { Constraints, ConstraintsMembers, MapWidgetModel, MapWidgetModelMembers, View, ViewMode, ViewPadding } from '../__internal__/DFiGfJS1.js';
 export { Navigation, NavigationMembers } from './Navigation.js';
 export { MapWidget } from './MapWidget.js';
 export { MapWidgetFactory } from './MapWidgetFactory.js';

package/package.json

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

package/popups/ContentUpdateProxy.d.ts

@@ -23,43 +23,71 @@ interface WidgetProxy {
  * if the popup handles multiple feature hits.
  *
  * @example
- * ```js
- * import ContentUpdateProxy from "./ContentUpdateProxy";
+ * ```ts
+ * import VueDijit from "apprt-vue/VueDijit";
+ * import Graphic from "esri/Graphic";
+ * import Layer from "esri/layers/Layer";
+ * import { PopupDefinition, PopupTemplateDefinition } from "popups/api";
+ * import ContentUpdateProxy, { WidgetProxy } from "popups/ContentUpdateProxy";
+ * import { Store } from "store-api/api";
+ * import Vue from "vue/types/umd.js";
+ * import { CustomPopupWidget } from "./CustomPopupWidget.vue";
  *
- * export default function CustomWidgetPopupDefinition() {
- *     return {
- *         resolvePopupTemplate(layer) {
- *             return {
- *                 outFields: ["objectid", "Name", "Description"],
- *                 title: "This is {Name}",
+ * /**
+ *  * Type allowing to access the popup widget of a layer or store.
+ *  *\/
+ * type PopupWidgetAware<T> = T & {
+ *     _$popup_widget?: any;
+ * }
+ *
+ * function createWidget() {
+ *     return VueDijit(new Vue(CustomPopupWidget));
+ * }
  *
- *                 // Define a content function
- *                 content({graphic}) {
- *                     let widget = layer._$popup_widget;
- *                     if (!widget) {
- *                         widget = layer._$popup_widget = createWidget();
- *                         // widget is a dijit Widget
- *                         widget.startup();
- *                     }
+ * export class CustomWidgetPopupDefinition implements PopupDefinition {
+ *     resolvePopupTemplate(layerArg: Layer): PopupTemplateDefinition | undefined {
+ *         const layer = layerArg as PopupWidgetAware<Layer>;
+ *         return {
+ *             // Declare which fields should be fetched
+ *             // These are provided as attributes inside the graphic
+ *             outFields: ["objectid", "Name", "Description"],
  *
- *                     // Use the proxy to handle content updates
- *                     // This ensures, that the correct content for every feature is shown,
- *                     // if the popup handles multiple feature hits
- *                     return ContentUpdateProxy(graphic, widget, (graphic) => {
- *                         updateWidgetContent(widget, graphic);
- *                     });
+ *             // title may contain attributes from the fields array
+ *             title: "This is {Name}",
+ *
+ *             // Define a content function
+ *             // NOTE:
+ *             //  * Can return a Promise(dojo/Deferred required in 4.7)
+ *             //  * This is global window, be careful about that!
+ *             content({graphic}: {graphic: Graphic}): WidgetProxy {
+ *                 let widget = layer._$popup_widget;
+ *                 if (!widget) {
+ *                     widget = layer._$popup_widget = createWidget();
+ *                     // widget is a dijit Widget
+ *                     widget.startup();
  *                 }
- *             };
- *         }
- *         resolvePopupTemplateForStore(store) {
- *             // analogue to resolvePopupTemplate(layer)
- *         }
- *         cleanupPopupTemplate(layerOrStore) {
- *             let widget = layerOrStore._$popup_widget;
- *             delete layerOrStore._$popup_widget;
- *             widget && widget.destroyRecursive();
- *         }
- *     };
+ *
+ *                 // Use the proxy to handle content updates
+ *                 // This ensures, that the correct content for every feature is shown,
+ *                 // if the popup handles multiple feature hits
+ *                 return ContentUpdateProxy(graphic, widget, (graphic) => {
+ *                     // update the widget content
+ *                 });
+ *             }
+ *         };
+ *     }
+ *     resolvePopupTemplateForStore(
+ *         store: Store,
+ *         storeProperties: Record<string, any>
+ *     ): PopupTemplateDefinition | undefined | Promise<PopupTemplateDefinition | undefined> {
+ *         // analogue to resolvePopupTemplate(layer)
+ *     }
+ *     cleanupPopupTemplate?(layerOrStoreArg: Layer | Store): void {
+ *         const layerOrStore = layerOrStoreArg as PopupWidgetAware<Layer | Store>;
+ *         const widget = layerOrStore._$popup_widget;
+ *         delete layerOrStore._$popup_widget;
+ *         widget && widget.destroyRecursive();
+ *     }
  * }
  * ```
  */