@vertigis/viewer-spec 43.2.0 → 43.3.0

package/messaging/common.d.ts

@@ -33,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.
  */
@@ -143,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.

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/schema/web-action.schema.json

@@ -1247,6 +1247,9 @@
             "additionalProperties": false,
             "description": "Arguments for the map.create-note command.",
             "properties": {
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
                 "features": {
                     "$ref": "#/definitions/FeaturesLike",
                     "description": "Optionally the features that can be referenced for inserting snippets."
@@ -1255,9 +1258,17 @@
                     "$ref": "#/definitions/esri.Point",
                     "description": "The location for the map note."
                 },
+                "icon": {
+                    "description": "Optional icon that may be used by the transient UI container.",
+                    "type": "string"
+                },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "The map that should show the created note."
+                },
+                "parent": {
+                    "description": "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.",
+                    "type": "string"
                 }
             },
             "required": [
@@ -1566,6 +1577,9 @@
             "additionalProperties": false,
             "description": "Arguments for the map.edit-note command.",
             "properties": {
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
                 "features": {
                     "$ref": "#/definitions/FeaturesLike",
                     "description": "Optionally the features that can be referenced for inserting snippets."
@@ -1574,9 +1588,17 @@
                     "$ref": "#/definitions/esri.Point",
                     "description": "The geometry from which to attempt to select the Note."
                 },
+                "icon": {
+                    "description": "Optional icon that may be used by the transient UI container.",
+                    "type": "string"
+                },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "The map on which to edit the result."
+                },
+                "parent": {
+                    "description": "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.",
+                    "type": "string"
                 }
             },
             "required": [
@@ -1588,6 +1610,9 @@
             "additionalProperties": false,
             "description": "Arguments for the drawing.edit-symbol operation. Only available in Geocortex Web.",
             "properties": {
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
                 "features": {
                     "$ref": "#/definitions/FeaturesLike",
                     "description": "Features to use for the command/operation."
@@ -1600,6 +1625,10 @@
                     "$ref": "#/definitions/GraphicsLike",
                     "description": "Graphics to use for the command/operation."
                 },
+                "icon": {
+                    "description": "Optional icon that may be used by the transient UI container.",
+                    "type": "string"
+                },
                 "layers": {
                     "$ref": "#/definitions/LayersLike",
                     "description": "Layer(s) to use for the command/operation."
@@ -1608,6 +1637,10 @@
                     "$ref": "MapsLike",
                     "description": "Map(s) to use for the command/operation."
                 },
+                "parent": {
+                    "description": "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.",
+                    "type": "string"
+                },
                 "showOnlySymbolPresets": {
                     "description": "If the fine-grain controls should be hidden and only the symbol presets should be shown. If no valid symbol presets are configured, this property will be ignored. Default is false. If defined, this will override the value of the DrawService's 'showOnlySymbolPresets' property.",
                     "type": "boolean"
@@ -2476,13 +2509,24 @@
                     "description": "Indicates if the user should be given the option to select a point from the map.",
                     "type": "boolean"
                 },
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
                 "geometry": {
                     "$ref": "#/definitions/esri.Point",
                     "description": "An optional starting coordinate."
                 },
+                "icon": {
+                    "description": "Optional icon that may be used by the transient UI container.",
+                    "type": "string"
+                },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "The map on which to select the result."
+                },
+                "parent": {
+                    "description": "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.",
+                    "type": "string"
                 }
             },
             "type": "object"
@@ -2713,6 +2757,24 @@
             },
             "type": "object"
         },
+        "HasUITarget": {
+            "additionalProperties": false,
+            "description": "An object with arguments for a command or operation that can display temporary UI.",
+            "properties": {
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
+                "icon": {
+                    "description": "Optional icon that may be used by the transient UI container.",
+                    "type": "string"
+                },
+                "parent": {
+                    "description": "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.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "IdentifyArgs": {
             "additionalProperties": false,
             "description": "Arguments for the tasks.identify operation.",
@@ -3244,10 +3306,21 @@
                     "description": "The accept parameter for the file input. {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept}.",
                     "type": "string"
                 },
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
+                "icon": {
+                    "description": "Optional icon that may be used by the transient UI container.",
+                    "type": "string"
+                },
                 "multiple": {
                     "description": "If present, indicates that the user may choose more than one file.",
                     "type": "boolean"
                 },
+                "parent": {
+                    "description": "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.",
+                    "type": "string"
+                },
                 "promptMessage": {
                     "description": "If present, overrides the default message of the dialog that prompts the user for a file.",
                     "type": "string"
@@ -15819,6 +15892,9 @@
                 "measurement.show-settings"
             ]
         },
+        "measurement.show-settings:input": {
+            "$ref": "#/definitions/HasUITarget"
+        },
         "messaging.mix-in-args": {
             "description": "Attempts to merge an array of values into a single value that can be used as an argument for a command or operation. For example: ``` [features, { chart: \"average-household-income\" }] ``` This would mix `features` obtained from some other source into arguments intended for the \"charts.display\" command. If the values cannot be merged, then the leftmost value is returned. Note that argument merging already occurs automatically in command chains; this explicit operation exists for advanced scenarios like Geocortex Workflow or custom code written using the SDK.",
             "enum": [
@@ -18168,6 +18244,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/measurement.show-settings:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/measurement.show-settings"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "43.2.0",
+  "version": "43.3.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export declare const version = "43.2.0";
+export declare const version = "43.3.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export const version = "43.2.0";
+export const version = "43.3.0";