@vertigis/viewer-spec 49.7.0 → 49.9.0

package/messaging/Command.d.ts

@@ -1,4 +1,5 @@
 import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { AnalyticsContext } from "../analytics/AnalyticsContext.js";
 import type { Event } from "./Event.js";
 import type { Message, MessageExecuteOptions } from "./Message.js";
 /**
@@ -41,7 +42,7 @@ export interface Command<T = void> extends Message {
 /**
  * Execution context that will be passed in to each of the command's behaviors.
  */
-export interface CommandContext<T> {
+export interface CommandContext<T> extends AnalyticsContext {
     /**
      * The name of the command that is currently executing.
      */

package/messaging/Message.d.ts

@@ -20,4 +20,30 @@ export interface MessageExecuteOptions {
      * Specify if the message was executed from a trusted source.
      */
     trusted?: boolean;
+    /**
+     * The XML name of the layout component that initiated the action, if
+     * applicable. This will be available in the command context and can be used
+     * by message handlers for capturing analytics. Examples: "layer-list", "map", etc.
+     */
+    analyticsComponentType?: string;
+    /**
+     * The human-readable name of the layout component that initiated the
+     * action, if applicable. This will be available in the command context and
+     * can be used by message handlers for capturing analytics. Examples: "Layer
+     * List", "Basemap Picker", , "Left Panel", etc.
+     */
+    analyticsComponentName?: string;
+    /**
+     * Additional component-specific data indicating such things as the name of
+     * an item or area within a component that the user interacted with to
+     * trigger the command, if applicable. This will be available in the command
+     * context and can be used by message handlers for capturing analytics.
+     *
+     * Examples:
+     *
+     * - The name of a basemap selection.
+     * - The name of a button.
+     * - The name of a context menu item.
+     */
+    analyticsComponentData?: string | number | boolean | string[];
 }

package/messaging/Operation.d.ts

@@ -1,4 +1,5 @@
 import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { AnalyticsContext } from "../analytics/AnalyticsContext.js";
 import type { Event } from "./Event.js";
 import type { Message, MessageExecuteOptions } from "./Message.js";
 /**
@@ -42,7 +43,7 @@ export interface Operation<T = void, TResult = undefined> extends Message {
 /**
  * Context that will be passed in to each behavior for an operation.
  */
-export interface OperationContext<T = void, TResult = undefined> {
+export interface OperationContext<T = void, TResult = undefined> extends AnalyticsContext {
     /**
      * The name of the operation that is currently executing.
      */

package/messaging/registry/Commands.d.ts

@@ -8,6 +8,7 @@ import { EditCommands } from "./edit.js";
 import { FileCommands } from "./file.js";
 import { GeolocationCommands } from "./geolocation.js";
 import { GeometryToolbarCommands } from "./geometry-toolbar.js";
+import { GeometryCommands } from "./geometry.js";
 import { HighlightsCommands } from "./highlights.js";
 import { IwtmCommands } from "./iwtm.js";
 import { KpiCommands } from "./kpi.js";
@@ -26,6 +27,7 @@ import { ReportsCommands } from "./reports.js";
 import { ResultsCommands } from "./results.js";
 import { SearchCommands } from "./search.js";
 import { SketchingCommands } from "./sketching.js";
+import { StudioAnalyticsCommands } from "./studioAnalytics.js";
 import { SystemCommands } from "./system.js";
 import { UICommands } from "./ui.js";
 import { ViewerCommands } from "./viewer.js";
@@ -39,6 +41,7 @@ export declare class Commands extends CommandRegistry {
     readonly edit: EditCommands;
     readonly file: FileCommands;
     readonly geolocation: GeolocationCommands;
+    readonly geometry: GeometryCommands;
     readonly geometryToolbar: GeometryToolbarCommands;
     readonly highlights: HighlightsCommands;
     readonly iwtm: IwtmCommands;
@@ -58,6 +61,7 @@ export declare class Commands extends CommandRegistry {
     readonly results: ResultsCommands;
     readonly search: SearchCommands;
     readonly sketching: SketchingCommands;
+    readonly studioAnalytics: StudioAnalyticsCommands;
     readonly system: SystemCommands;
     readonly ui: UICommands;
     readonly viewer: ViewerCommands;

package/messaging/registry/Commands.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{AppCommands}from"./app.js";import{AuthCommands}from"./auth.js";import{BasemapCommands}from"./basemap.js";import{ChartsCommands}from"./charts.js";import{DrawingCommands}from"./drawing.js";import{EditCommands}from"./edit.js";import{FileCommands}from"./file.js";import{GeolocationCommands}from"./geolocation.js";import{GeometryToolbarCommands}from"./geometry-toolbar.js";import{HighlightsCommands}from"./highlights.js";import{IwtmCommands}from"./iwtm.js";import{KpiCommands}from"./kpi.js";import{LayerComparisonCommands}from"./layer-comparison.js";import{LayerPresetsCommands}from"./layer-presets.js";import{LayersCommands}from"./layers.js";import{LocationMarkerCommands}from"./location-marker.js";import{MapCommands}from"./map.js";import{MeasurementCommands}from"./measurement.js";import{OfflineCommands}from"./offline.js";import{PanelCommands}from"./panel.js";import{PhotosCommands}from"./photos.js";import{PrintCommands}from"./printing.js";import{RegionCommands}from"./region.js";import{ReportsCommands}from"./reports.js";import{ResultsCommands}from"./results.js";import{SearchCommands}from"./search.js";import{SketchingCommands}from"./sketching.js";import{SystemCommands}from"./system.js";import{UICommands}from"./ui.js";import{ViewerCommands}from"./viewer.js";import{WorkflowCommands}from"./workflow.js";export class Commands extends CommandRegistry{constructor(){super(...arguments),this.app=new AppCommands(this._messages),this.auth=new AuthCommands(this._messages),this.basemap=new BasemapCommands(this._messages),this.charts=new ChartsCommands(this._messages),this.drawing=new DrawingCommands(this._messages),this.edit=new EditCommands(this._messages),this.file=new FileCommands(this._messages),this.geolocation=new GeolocationCommands(this._messages),this.geometryToolbar=new GeometryToolbarCommands(this._messages),this.highlights=new HighlightsCommands(this._messages),this.iwtm=new IwtmCommands(this._messages),this.kpi=new KpiCommands(this._messages),this.layers=new LayersCommands(this._messages),this.layerComparison=new LayerComparisonCommands(this._messages),this.layerPresets=new LayerPresetsCommands(this._messages),this.locationMarker=new LocationMarkerCommands(this._messages),this.map=new MapCommands(this._messages),this.measurement=new MeasurementCommands(this._messages),this.offline=new OfflineCommands(this._messages),this.panel=new PanelCommands(this._messages),this.photos=new PhotosCommands(this._messages),this.printing=new PrintCommands(this._messages),this.region=new RegionCommands(this._messages),this.reports=new ReportsCommands(this._messages),this.results=new ResultsCommands(this._messages),this.search=new SearchCommands(this._messages),this.sketching=new SketchingCommands(this._messages),this.system=new SystemCommands(this._messages),this.ui=new UICommands(this._messages),this.viewer=new ViewerCommands(this._messages),this.workflow=new WorkflowCommands(this._messages)}}
+import{CommandRegistry}from"../CommandRegistry.js";import{AppCommands}from"./app.js";import{AuthCommands}from"./auth.js";import{BasemapCommands}from"./basemap.js";import{ChartsCommands}from"./charts.js";import{DrawingCommands}from"./drawing.js";import{EditCommands}from"./edit.js";import{FileCommands}from"./file.js";import{GeolocationCommands}from"./geolocation.js";import{GeometryToolbarCommands}from"./geometry-toolbar.js";import{GeometryCommands}from"./geometry.js";import{HighlightsCommands}from"./highlights.js";import{IwtmCommands}from"./iwtm.js";import{KpiCommands}from"./kpi.js";import{LayerComparisonCommands}from"./layer-comparison.js";import{LayerPresetsCommands}from"./layer-presets.js";import{LayersCommands}from"./layers.js";import{LocationMarkerCommands}from"./location-marker.js";import{MapCommands}from"./map.js";import{MeasurementCommands}from"./measurement.js";import{OfflineCommands}from"./offline.js";import{PanelCommands}from"./panel.js";import{PhotosCommands}from"./photos.js";import{PrintCommands}from"./printing.js";import{RegionCommands}from"./region.js";import{ReportsCommands}from"./reports.js";import{ResultsCommands}from"./results.js";import{SearchCommands}from"./search.js";import{SketchingCommands}from"./sketching.js";import{StudioAnalyticsCommands}from"./studioAnalytics.js";import{SystemCommands}from"./system.js";import{UICommands}from"./ui.js";import{ViewerCommands}from"./viewer.js";import{WorkflowCommands}from"./workflow.js";export class Commands extends CommandRegistry{constructor(){super(...arguments),this.app=new AppCommands(this._messages),this.auth=new AuthCommands(this._messages),this.basemap=new BasemapCommands(this._messages),this.charts=new ChartsCommands(this._messages),this.drawing=new DrawingCommands(this._messages),this.edit=new EditCommands(this._messages),this.file=new FileCommands(this._messages),this.geolocation=new GeolocationCommands(this._messages),this.geometry=new GeometryCommands(this._messages),this.geometryToolbar=new GeometryToolbarCommands(this._messages),this.highlights=new HighlightsCommands(this._messages),this.iwtm=new IwtmCommands(this._messages),this.kpi=new KpiCommands(this._messages),this.layers=new LayersCommands(this._messages),this.layerComparison=new LayerComparisonCommands(this._messages),this.layerPresets=new LayerPresetsCommands(this._messages),this.locationMarker=new LocationMarkerCommands(this._messages),this.map=new MapCommands(this._messages),this.measurement=new MeasurementCommands(this._messages),this.offline=new OfflineCommands(this._messages),this.panel=new PanelCommands(this._messages),this.photos=new PhotosCommands(this._messages),this.printing=new PrintCommands(this._messages),this.region=new RegionCommands(this._messages),this.reports=new ReportsCommands(this._messages),this.results=new ResultsCommands(this._messages),this.search=new SearchCommands(this._messages),this.sketching=new SketchingCommands(this._messages),this.studioAnalytics=new StudioAnalyticsCommands(this._messages),this.system=new SystemCommands(this._messages),this.ui=new UICommands(this._messages),this.viewer=new ViewerCommands(this._messages),this.workflow=new WorkflowCommands(this._messages)}}

package/messaging/registry/app.d.ts

@@ -206,8 +206,8 @@ export declare class AppOperations extends OperationRegistry {
     get getPersistentData(): Operation<StorageDataArgs, unknown>;
 }
 /**
- * Arguments for the reading app.*-persistent-data operations. Only available in the
- * Geocortex Mobile Viewer.
+ * Arguments for the reading app.*-persistent-data operations. Only available in
+ * the Geocortex Mobile Viewer.
  */
 export interface StorageDataArgs {
     /**

package/messaging/registry/map.d.ts

@@ -552,6 +552,15 @@ export interface ReplaceMapArgs {
      */
     mapExtension: MapExtension;
 }
+/**
+ * Arguments for the "map.set-view-mode" command.
+ */
+export interface SetViewModeArgs extends HasMaps {
+    /**
+     * The new view mode for the specified map(s).
+     */
+    viewMode: ViewMode;
+}
 /**
  * Arguments for the "map.start-sketch" operation.
  */
@@ -825,6 +834,13 @@ export declare class MapCommands extends CommandRegistry {
      * @mobileOnly
      */
     get refresh(): Command<MapExtensionArgs>;
+    /**
+     * Changes the view mode of a map to the specified mode, if supported. If no
+     * maps are specified, all maps will be targeted.
+     *
+     * @webOnly
+     */
+    get setViewMode(): Command<ViewMode | SetViewModeArgs>;
     /**
      * Updates a layer in the map.
      *

package/messaging/registry/map.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class MapCommands extends CommandRegistry{get addMarkup(){return this._messages.command("map.add-markup")}get addLayers(){return this._messages.command("map.add-layers")}get applyFilterEffect(){return this._messages.command("map.apply-filter-effect")}get applyLayerPreset(){return this._messages.command("map.apply-layer-preset")}get createNote(){return this._messages.command("map.create-note")}get editNote(){return this._messages.command("map.edit-note")}get removeFilterEffects(){return this._messages.command("map.remove-filter-effects")}get clearFilterEffects(){return this._messages.command("map.clear-filter-effects")}get clearMarkup(){return this._messages.command("map.clear-markup")}get disableMapClick(){return this._messages.command("map.disable-map-click")}get displayExtentSelector(){return this._messages.command("map.display-extent-selector")}get enableMapClick(){return this._messages.command("map.enable-map-click")}get goToFeatures(){return this._messages.command("map.go-to-features")}get goToGeometry(){return this._messages.command("map.go-to-geometry")}get goToViewpoint(){return this._messages.command("map.go-to-viewpoint")}get goToScale(){return this._messages.command("map.go-to-scale")}get goToInitialViewpoint(){return this._messages.command("map.go-to-initial-viewpoint")}get goToLayerExtent(){return this._messages.command("map.go-to-layer-extent")}get hideExtentSelector(){return this._messages.command("map.hide-extent-selector")}get panToFeatures(){return this._messages.command("map.pan-to-features")}get panToGeometry(){return this._messages.command("map.pan-to-geometry")}get pauseSketch(){return this._messages.command("map.pause-sketch")}get removeLayers(){return this._messages.command("map.remove-layers")}get replace(){return this._messages.command("map.replace")}get replaceAdditionalLayers(){return this._messages.command("map.replace-additional-layers")}get replaceMmpk(){return this._messages.command("map.replace-mmpk")}get resumeSketch(){return this._messages.command("map.resume-sketch")}get rotateBy(){return this._messages.command("map.rotate-by")}get rotateTo(){return this._messages.command("map.rotate-to")}get refresh(){return this._messages.command("map.refresh")}get updateLayer(){return this._messages.command("map.update-layer")}get zoomToFeatures(){return this._messages.command("map.zoom-to-features")}get zoomToGeometry(){return this._messages.command("map.zoom-to-geometry")}get zoomIn(){return this._messages.command("map.zoom-in")}get zoomOut(){return this._messages.command("map.zoom-out")}get zoomToScale(){return this._messages.command("map.zoom-to-scale")}get zoomToInitialViewpoint(){return this._messages.command("map.zoom-to-initial-viewpoint")}get zoomToViewpoint(){return this._messages.command("map.zoom-to-viewpoint")}get zoomToLayerExtent(){return this._messages.command("map.zoom-to-layer-extent")}get zoomToLayerVisibleScale(){return this._messages.command("map.zoom-to-layer-visible-scale")}}export class MapEvents extends EventRegistry{get initialized(){return this._messages.event("map.initialized")}get initializing(){return this._messages.event("map.initializing")}get navigationCompleted(){return this._messages.event("map.navigation-completed")}get refreshed(){return this._messages.event("map.refreshed")}get refreshing(){return this._messages.event("map.refreshing")}get rotated(){return this._messages.event("map.rotated")}get rotating(){return this._messages.event("map.rotating")}get viewModeChanged(){return this._messages.event("map.view-mode-changed")}get viewpointChanged(){return this._messages.event("map.viewpoint-changed")}}export class MapOperations extends OperationRegistry{get getUserCoordinatesInput(){return this._messages.operation("map.get-user-coordinates-input")}get getCoordinateTransformation(){return this._messages.operation("map.get-coordinate-transformation")}get exportImage(){return this._messages.operation("map.export-image")}get exportWebMapOrScene(){return this._messages.operation("map.export-web-map-or-scene")}get getMarkup(){return this._messages.operation("map.get-markup")}get getExtent(){return this._messages.operation("map.get-extent")}get getGeometryFromSelector(){return this._messages.operation("map.get-geometry-from-selector")}get getInitialViewpoint(){return this._messages.operation("map.get-initial-viewpoint")}get getViewpoint(){return this._messages.operation("map.get-viewpoint")}get getSpatialReference(){return this._messages.operation("map.get-spatial-reference")}get getVisibleCenter(){return this._messages.operation("map.get-visible-center")}get hide(){return this._messages.operation("map.hide")}get show(){return this._messages.operation("map.show")}get startSketch(){return this._messages.operation("map.start-sketch")}get stopSketch(){return this._messages.operation("map.stop-sketch")}get getViewInsets(){return this._messages.operation("map.get-view-insets")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class MapCommands extends CommandRegistry{get addMarkup(){return this._messages.command("map.add-markup")}get addLayers(){return this._messages.command("map.add-layers")}get applyFilterEffect(){return this._messages.command("map.apply-filter-effect")}get applyLayerPreset(){return this._messages.command("map.apply-layer-preset")}get createNote(){return this._messages.command("map.create-note")}get editNote(){return this._messages.command("map.edit-note")}get removeFilterEffects(){return this._messages.command("map.remove-filter-effects")}get clearFilterEffects(){return this._messages.command("map.clear-filter-effects")}get clearMarkup(){return this._messages.command("map.clear-markup")}get disableMapClick(){return this._messages.command("map.disable-map-click")}get displayExtentSelector(){return this._messages.command("map.display-extent-selector")}get enableMapClick(){return this._messages.command("map.enable-map-click")}get goToFeatures(){return this._messages.command("map.go-to-features")}get goToGeometry(){return this._messages.command("map.go-to-geometry")}get goToViewpoint(){return this._messages.command("map.go-to-viewpoint")}get goToScale(){return this._messages.command("map.go-to-scale")}get goToInitialViewpoint(){return this._messages.command("map.go-to-initial-viewpoint")}get goToLayerExtent(){return this._messages.command("map.go-to-layer-extent")}get hideExtentSelector(){return this._messages.command("map.hide-extent-selector")}get panToFeatures(){return this._messages.command("map.pan-to-features")}get panToGeometry(){return this._messages.command("map.pan-to-geometry")}get pauseSketch(){return this._messages.command("map.pause-sketch")}get removeLayers(){return this._messages.command("map.remove-layers")}get replace(){return this._messages.command("map.replace")}get replaceAdditionalLayers(){return this._messages.command("map.replace-additional-layers")}get replaceMmpk(){return this._messages.command("map.replace-mmpk")}get resumeSketch(){return this._messages.command("map.resume-sketch")}get rotateBy(){return this._messages.command("map.rotate-by")}get rotateTo(){return this._messages.command("map.rotate-to")}get refresh(){return this._messages.command("map.refresh")}get setViewMode(){return this._messages.command("map.set-view-mode")}get updateLayer(){return this._messages.command("map.update-layer")}get zoomToFeatures(){return this._messages.command("map.zoom-to-features")}get zoomToGeometry(){return this._messages.command("map.zoom-to-geometry")}get zoomIn(){return this._messages.command("map.zoom-in")}get zoomOut(){return this._messages.command("map.zoom-out")}get zoomToScale(){return this._messages.command("map.zoom-to-scale")}get zoomToInitialViewpoint(){return this._messages.command("map.zoom-to-initial-viewpoint")}get zoomToViewpoint(){return this._messages.command("map.zoom-to-viewpoint")}get zoomToLayerExtent(){return this._messages.command("map.zoom-to-layer-extent")}get zoomToLayerVisibleScale(){return this._messages.command("map.zoom-to-layer-visible-scale")}}export class MapEvents extends EventRegistry{get initialized(){return this._messages.event("map.initialized")}get initializing(){return this._messages.event("map.initializing")}get navigationCompleted(){return this._messages.event("map.navigation-completed")}get refreshed(){return this._messages.event("map.refreshed")}get refreshing(){return this._messages.event("map.refreshing")}get rotated(){return this._messages.event("map.rotated")}get rotating(){return this._messages.event("map.rotating")}get viewModeChanged(){return this._messages.event("map.view-mode-changed")}get viewpointChanged(){return this._messages.event("map.viewpoint-changed")}}export class MapOperations extends OperationRegistry{get getUserCoordinatesInput(){return this._messages.operation("map.get-user-coordinates-input")}get getCoordinateTransformation(){return this._messages.operation("map.get-coordinate-transformation")}get exportImage(){return this._messages.operation("map.export-image")}get exportWebMapOrScene(){return this._messages.operation("map.export-web-map-or-scene")}get getMarkup(){return this._messages.operation("map.get-markup")}get getExtent(){return this._messages.operation("map.get-extent")}get getGeometryFromSelector(){return this._messages.operation("map.get-geometry-from-selector")}get getInitialViewpoint(){return this._messages.operation("map.get-initial-viewpoint")}get getViewpoint(){return this._messages.operation("map.get-viewpoint")}get getSpatialReference(){return this._messages.operation("map.get-spatial-reference")}get getVisibleCenter(){return this._messages.operation("map.get-visible-center")}get hide(){return this._messages.operation("map.hide")}get show(){return this._messages.operation("map.show")}get startSketch(){return this._messages.operation("map.start-sketch")}get stopSketch(){return this._messages.operation("map.stop-sketch")}get getViewInsets(){return this._messages.operation("map.get-view-insets")}}

package/messaging/registry/studioAnalytics.d.ts

@@ -0,0 +1,24 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+/**
+ * Arguments for the 'studio-analytics.track-custom-event' command.
+ */
+export interface TrackCustomEventArgs {
+    /**
+     * The name of the event. The event name should be in kebab-case, present
+     * tense, and follow a `{noun phrase}-{verb}` pattern, where `{verb}` is a
+     * single word without hyphens. Example: "parcel-boundary-move".
+     */
+    name: string;
+    /**
+     * Optional. Additional event-specific data of interest.
+     */
+    payload?: string;
+}
+export declare class StudioAnalyticsCommands extends CommandRegistry {
+    /**
+     * Sends a custom event to VertiGIS Studio Analytics. If the app is not
+     * configured to use Analytics, then nothing will happen.
+     */
+    get trackCustomEvent(): Command<TrackCustomEventArgs>;
+}

package/messaging/registry/studioAnalytics.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";export class StudioAnalyticsCommands extends CommandRegistry{get trackCustomEvent(){return this._messages.command("studio-analytics.track-custom-event")}}