@vertigis/viewer-spec 43.0.0 → 43.3.1

package/messaging/common.d.ts

@@ -22,6 +22,7 @@ import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtens
 import type { SublayerExtension } from "@vertigis/arcgis-extensions/mapping/SublayerExtension";
 import type { LayerExtension, LayerReference as LayerReferenceObject } from "@vertigis/arcgis-extensions/mapping/_LayerExtension";
 import type { Feature as GraphicJson } from "@vertigis/arcgis-extensions/portal/Feature";
+import type { Geometry as GeometryJson } from "@vertigis/arcgis-extensions/portal/Geometry";
 import type { LineSymbol3D as LineSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/LineSymbol3D";
 import type { PictureFillSymbol as PictureFillSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureFillSymbol";
 import type { PictureMarkerSymbol as PictureMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureMarkerSymbol";
@@ -32,6 +33,7 @@ import type { SimpleLineSymbol as SimpleLineSymbolProperties } from "@vertigis/a
 import type { SimpleMarkerSymbol as SimpleMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleMarkerSymbol";
 import type { Viewpoint as ViewpointJson } from "@vertigis/arcgis-extensions/portal/Viewpoint";
 import type { SublayerLike } from "@vertigis/arcgis-extensions/support/esri";
+import type { ItemRef } from "app-config/common/ItemRef";
 /**
  * A model belonging to a component.
  */
@@ -142,6 +144,26 @@ export interface HasGraphics {
      */
     graphics?: GraphicsLike;
 }
+/**
+ * An object with arguments for a command or operation that can display
+ * temporary UI.
+ */
+export interface HasUITarget {
+    /**
+     * The layout ID or ItemRef to target for the command/operation. This
+     * component will be the parent of the temporary UI that will be removed
+     * after the command/operation completes.
+     */
+    parent?: string | ItemRef;
+    /**
+     * Optional layout XML attributes to be used for the transient UI container.
+     */
+    attributes?: Record<string, string | number | boolean | undefined>;
+    /**
+     * Optional icon that may be used by the transient UI container.
+     */
+    icon?: string;
+}
 /**
  * An object that is convertible to Esri Graphic or set of graphics, or an
  * object that has graphics.
@@ -150,7 +172,7 @@ export declare type Graphics = GraphicsLike | HasGraphics;
 /**
  * An object that is convertible to one or more geometries.
  */
-export declare type GeometryLike = Geometry | Geometry[] | FeaturesLike | GraphicsLike;
+export declare type GeometryLike = GeometryJson | Geometry | (GeometryJson | Geometry)[] | FeaturesLike | GraphicsLike;
 /**
  * An object that has a `geometry` property.
  */

package/messaging/registry/drawing.d.ts

@@ -21,7 +21,7 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { CreateGraphicsResult, GeometryLike, HasFeatures, HasGraphics, HasLayers, HasMaps, HasSymbol, SymbolLike } from "../common.js";
+import type { CreateGraphicsResult, GeometryLike, HasFeatures, HasGraphics, HasLayers, HasMaps, HasSymbol, HasUITarget, SymbolLike } from "../common.js";
 /**
  * Symbols supported for drawing.
  */
@@ -40,7 +40,7 @@ export interface GetDefaultSymbolArgs {
  * Arguments for the drawing.edit-symbol operation. Only available in Geocortex
  * Web.
  */
-export interface EditSymbolArgs extends HasMaps, HasLayers, HasGraphics, HasFeatures {
+export interface EditSymbolArgs extends HasMaps, HasLayers, HasGraphics, HasFeatures, HasUITarget {
     /**
      * The geometry type for the symbol to create.
      */

package/messaging/registry/geometry.d.ts

@@ -5,7 +5,7 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Geometries, HasFeatures, HasGeometry, HasMaps, MapsLike } from "../common.js";
+import type { Geometries, HasFeatures, HasGeometry, HasMaps, HasUITarget, MapsLike } from "../common.js";
 import type { CaptureGeometryResult } from "./sketching.js";
 /**
  * Arguments for the geometry.project operation.
@@ -97,5 +97,5 @@ export declare class GeometryCommands extends CommandRegistry {
      *
      * @webOnly
      */
-    get showSettings(): Command<void>;
+    get showSettings(): Command<HasUITarget>;
 }

package/messaging/registry/map.d.ts

@@ -19,7 +19,7 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Features, FeaturesLike, Geometries, GeometryLike, GraphicsLike, Layers, LayersLike, Maps, MapsLike, ViewpointLike } from "../common.js";
+import type { Features, FeaturesLike, Geometries, GeometryLike, GraphicsLike, HasUITarget, Layers, LayersLike, Maps, MapsLike, ViewpointLike } from "../common.js";
 import type { MapExtensionArgs } from "../mobile.js";
 import type { EnhancedFileData } from "./file.js";
 import type { GeometryEditorSettings } from "./sketching.js";
@@ -200,7 +200,7 @@ export interface UpdateLayerArgs {
 /**
  * Arguments for the map.create-note command.
  */
-export interface CreateMapNoteArgs {
+export interface CreateMapNoteArgs extends HasUITarget {
     /**
      * Optionally the features that can be referenced for inserting snippets.
      */
@@ -217,7 +217,7 @@ export interface CreateMapNoteArgs {
 /**
  * Arguments for the map.edit-note command.
  */
-export interface EditMapNotesArgs {
+export interface EditMapNotesArgs extends HasUITarget {
     /**
      * Optionally the features that can be referenced for inserting snippets.
      */
@@ -234,7 +234,7 @@ export interface EditMapNotesArgs {
 /**
  * Arguments for the map.get-user-coordinates-input operation.
  */
-export interface GetCoordinateArgs {
+export interface GetCoordinateArgs extends HasUITarget {
     /**
      * The map on which to select the result.
      */

package/messaging/registry/measurement.d.ts

@@ -4,7 +4,7 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { CreateGraphicsResult, Geometries, HasSymbol, Maps, SymbolLike } from "../common.js";
+import type { CreateGraphicsResult, Geometries, HasSymbol, HasUITarget, Maps, SymbolLike } from "../common.js";
 import type { MapExtensionArgs } from "../mobile.js";
 import type { DrawingSymbolConfig } from "./drawing.js";
 import type { CaptureGeometryArgs, CaptureGeometryResult } from "./sketching.js";
@@ -66,7 +66,7 @@ export declare class MeasurementCommands extends CommandRegistry {
      *
      * @webOnly
      */
-    get showSettings(): Command<void>;
+    get showSettings(): Command<HasUITarget>;
     /**
      * Starts drawing a measurement on the map. If a drawing has previously been
      * started and stopped it will be resumed.

package/messaging/registry/portal.d.ts

@@ -2,7 +2,7 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { HasMaps, LayersLike } from "../common.js";
+import type { HasMaps, HasUITarget, LayersLike } from "../common.js";
 /**
  * Corresponds to `VertiGIS.Mobile.Infrastructure.Portal.ArcGISPortalExtension`
  * in the VertiGIS.Mobile SDK.
@@ -12,7 +12,7 @@ export interface ArcGISPortalExtension {
 /**
  * Arguments for the "portal.choose-layers" operation.
  */
-export interface ChooseLayersOptions extends HasMaps {
+export interface ChooseLayersOptions extends HasMaps, HasUITarget {
     /**
      * Whether the user can choose multiple layers, or just one. Default is
      * `false`.

package/messaging/registry/system.d.ts

@@ -2,7 +2,7 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Blob, File } from "../common.js";
+import type { Blob, File, HasUITarget } from "../common.js";
 /**
  * Arguments for the system.download-file operation.
  */
@@ -19,7 +19,7 @@ export interface DownloadArgs {
 /**
  * Arguments for the system.read-file operation.
  */
-export interface ReadFileArgs {
+export interface ReadFileArgs extends HasUITarget {
     /**
      * The accept parameter for the file input.
      * {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept}.

package/messaging/registry/ui.d.ts

@@ -294,6 +294,18 @@ export declare class UIOperations extends OperationRegistry {
      * @webOnly
      */
     get prompt(): Operation<PromptOperationArgs, string>;
+    /**
+     * Gets the active color theme of the viewer. Returns the theme's ID.
+     *
+     * @webOnly
+     */
+    get getTheme(): Operation<void, string>;
+    /**
+     * Gets all color themes available to the viewer. Returns the theme IDs.
+     *
+     * @webOnly
+     */
+    get getThemes(): Operation<void, string[]>;
     /**
      * Gets the visual state of a component.
      *

package/messaging/registry/ui.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends CommandRegistry{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get prompt(){return this._messages.operation("ui.prompt")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}}export class UIEvents extends EventRegistry{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends CommandRegistry{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get prompt(){return this._messages.operation("ui.prompt")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}}export class UIEvents extends EventRegistry{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}}

package/messaging/schema/common-action.schema.json

@@ -1028,10 +1028,19 @@
                     "$ref": "#/definitions/esri.FeatureSet"
                 },
                 {
-                    "items": {
-                        "$ref": "#/definitions/esri.Geometry"
-                    },
-                    "type": "array"
+                    "$ref": "#/definitions/esri.rest-api.Extent.Extent"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Multipoint.Multipoint"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Polygon.Polygon"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Polyline.Polyline"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Point.Point"
                 },
                 {
                     "$ref": "#/definitions/esri.rest-api.Feature.Feature"
@@ -1076,6 +1085,31 @@
                         ]
                     },
                     "type": "array"
+                },
+                {
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/esri.Geometry"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Extent.Extent"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Multipoint.Multipoint"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Polygon.Polygon"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Polyline.Polyline"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Point.Point"
+                            }
+                        ]
+                    },
+                    "type": "array"
                 }
             ],
             "description": "An object that is convertible to one or more geometries."

package/messaging/schema/mobile-action.schema.json

@@ -1241,10 +1241,19 @@
                     "$ref": "#/definitions/esri.FeatureSet"
                 },
                 {
-                    "items": {
-                        "$ref": "#/definitions/esri.Geometry"
-                    },
-                    "type": "array"
+                    "$ref": "#/definitions/esri.rest-api.Extent.Extent"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Multipoint.Multipoint"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Polygon.Polygon"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Polyline.Polyline"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.Point.Point"
                 },
                 {
                     "$ref": "#/definitions/esri.rest-api.Feature.Feature"
@@ -1289,6 +1298,31 @@
                         ]
                     },
                     "type": "array"
+                },
+                {
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/esri.Geometry"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Extent.Extent"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Multipoint.Multipoint"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Polygon.Polygon"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Polyline.Polyline"
+                            },
+                            {
+                                "$ref": "#/definitions/esri.rest-api.Point.Point"
+                            }
+                        ]
+                    },
+                    "type": "array"
                 }
             ],
             "description": "An object that is convertible to one or more geometries."