@vertigis/viewer-spec 58.10.1 → 58.10.2

package/app-config/web/FeatureSetProperties.d.ts

@@ -1,6 +1,6 @@
 import type { FeatureProperties } from "@vertigis/arcgis-extensions/data/Feature";
 import type { FeatureSetProperties as ApiFeatureSetProperties } from "@vertigis/arcgis-extensions/data/FeatureSet";
-import type { ItemRef } from "app-config/common/ItemRef";
+import type { ItemRef } from "../common/ItemRef";
 /**
  * Properties for a FeatureSet.
  */

package/app-config/web/ResultsModelProperties.d.ts

@@ -1,5 +1,5 @@
 import type { Action } from "@vertigis/arcgis-extensions/support/Action";
-import type { ItemRef } from "app-config/common/ItemRef.js";
+import type { ItemRef } from "../common/ItemRef.js";
 import type { ResultsModelProperties as CommonResultsModelProperties } from "../common/ResultsModelProperties.js";
 import type { ComponentModelProperties } from "./ComponentModelProperties.js";
 import type { FeatureListProperties } from "./FeatureListProperties.js";

package/messaging/common.d.ts

@@ -31,8 +31,12 @@ import type { LayerExtension, LayerReference as LayerReferenceObject } from "@ve
 import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
 import type { SublayerExtension } from "@vertigis/arcgis-extensions/mapping/SublayerExtension";
 import type { SublayerLike } from "@vertigis/arcgis-extensions/support/esri";
-import type { ItemRef } from "app-config/common/ItemRef";
+import type { ItemRef } from "../app-config/common/ItemRef";
 import type { TimeSpan } from "./DotNetTypes";
+/**
+ * A component's ID in the layout.
+ */
+export type ComponentId = string;
 /**
  * A model belonging to a component.
  */
@@ -41,7 +45,7 @@ export interface Model extends Entity {
 /**
  * A reference to a model (using its ID or model instance).
  */
-export type ModelRef = string | Model;
+export type ModelRef = ItemRef | Model;
 /**
  * Result of the "drawing.create-graphics" and "measurement.create-graphics"
  * operations.
@@ -217,7 +221,7 @@ export interface HasUITarget {
      * component will be the parent of the temporary UI that will be removed
      * after the command/operation completes.
      */
-    parent?: string | ItemRef;
+    parent?: ComponentId | ModelRef;
     /**
      * Optional layout XML attributes to be used for the transient UI container.
      */

package/messaging/registry/arcade.d.ts

@@ -1,7 +1,6 @@
-import type { ItemRef } from "app-config/common/ItemRef.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { HasFeatures, HasLayers, HasMaps, Model } from "../common.js";
+import type { HasFeatures, HasLayers, HasMaps, ModelRef } from "../common.js";
 /**
  * The arguments for the arcade.run operation.
  */
@@ -59,7 +58,7 @@ export interface ItemPropertyPath {
     /**
      * The item from which to access a property value.
      */
-    item: ItemRef | Model;
+    item: ModelRef;
     /**
      * The path to a property on an item.
      */
@@ -102,7 +101,7 @@ export interface WatchEventHandleProperties {
     /**
      * The item whose properties will be watched for changes and/or events.
      */
-    item: ItemRef | Model;
+    item: ModelRef;
     /**
      * One or more properties on the item that will be watched for changes
      * and/or events. Any strings will be used as propertyPaths that will be

package/messaging/registry/system.d.ts

@@ -1,14 +1,13 @@
 import type Point from "@arcgis/core/geometry/Point.js";
 import type { Action } from "@vertigis/arcgis-extensions/support/Action.js";
-import type { ItemRef } from "app-config/common/ItemRef.js";
-import type { CoordinateOptionProperties } from "app-config/web/CoordinateModelProperties.js";
+import type { CoordinateOptionProperties } from "../../app-config/web/CoordinateModelProperties.js";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Blob, File, HasFeatures, HasFiles, HasGeometry, HasLayers, HasMaps, HasUITarget } from "../common.js";
+import type { Blob, File, HasFeatures, HasFiles, HasGeometry, HasLayers, HasMaps, HasUITarget, ModelRef } from "../common.js";
 /**
  * Arguments for the system.download-file operation.
  */
@@ -117,7 +116,7 @@ export interface OpenUrlArgs {
      * existing 'coordinate-option' item, or inline JSON defining a coordinate
      * option item.
      */
-    coordinateOption?: ItemRef | CoordinateOptionProperties;
+    coordinateOption?: ModelRef | CoordinateOptionProperties;
     /**
      * An object containing arguments that this command was originally executed
      * with. This property is populated automatically when using a bound action.

package/messaging/registry/ui.d.ts

@@ -1,4 +1,3 @@
-import type { ItemRef } from "app-config/common/ItemRef.js";
 import type { UIDensity } from "../../app-config/common/BrandingModelProperties.js";
 import type { TranslatableText, TranslateOptions } from "../../app-config/common/TranslatableText.js";
 import type { Command } from "../Command.js";
@@ -7,7 +6,8 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Model } from "../common.js";
+import type { ComponentId, Model } from "../common.js";
+export type { ComponentId };
 /**
  * A category for a notification that affects the color and icon used.
  */
@@ -211,10 +211,6 @@ export interface DisplayBusyStateArgs {
      */
     maximumDisplayDurationMs?: number;
 }
-/**
- * A component's ID in the layout.
- */
-export type ComponentId = string;
 /**
  * Arguments for the "ui.focus" command.
  */
@@ -430,7 +426,7 @@ export declare class UIOperations extends OperationRegistry {
      *
      * @webOnly
      */
-    get getComponentIds(): Operation<ItemRef, string[]>;
+    get getComponentIds(): Operation<ComponentId | Model, string[]>;
     /**
      * Gets the current locale code for the application. (example: "en", "fr" or
      * "de-AT"). Web only.
@@ -457,13 +453,13 @@ export declare class UIOperations extends OperationRegistry {
      *
      * @webOnly
      */
-    get getVisualState(): Operation<ComponentId, VisualState | undefined>;
+    get getVisualState(): Operation<ComponentId | Model, VisualState | undefined>;
     /**
      * Gets the state of a component. Web only.
      *
      * @webOnly
      */
-    get getComponentState(): Operation<ComponentId, State | undefined>;
+    get getComponentState(): Operation<ComponentId | Model, State | undefined>;
     /**
      * Prompts the user to enter a value in a popup box. Web only.
      *

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

@@ -1566,8 +1566,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 },
                 "pluginSettings": {
                     "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
@@ -2233,8 +2233,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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": "object"
@@ -2537,6 +2537,9 @@
                         {
                             "$ref": "#/definitions/CoordinateOptionProperties"
                         },
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
                         {
                             "type": "string"
                         }
@@ -3586,6 +3589,9 @@
                         {
                             "$ref": "#/definitions/CoordinateOptionProperties"
                         },
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
                         {
                             "type": "string"
                         }

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

@@ -1821,8 +1821,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 },
                 "pluginSettings": {
                     "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
@@ -2689,8 +2689,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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": "object"
@@ -3224,6 +3224,9 @@
                         {
                             "$ref": "#/definitions/CoordinateOptionProperties"
                         },
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
                         {
                             "type": "string"
                         }
@@ -4608,6 +4611,9 @@
                         {
                             "$ref": "#/definitions/CoordinateOptionProperties"
                         },
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
                         {
                             "type": "string"
                         }

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

@@ -1533,8 +1533,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 },
                 "sources": {
                     "description": "Optionally specify the sources that we want to expose. If specified this will overwrite the configured default in the Portal Model.",
@@ -1946,8 +1946,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 }
             },
             "required": [
@@ -2425,8 +2425,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 },
                 "pluginSettings": {
                     "description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
@@ -2747,8 +2747,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 }
             },
             "required": [
@@ -2788,8 +2788,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 },
                 "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.",
@@ -4156,8 +4156,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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": "object"
@@ -4472,8 +4472,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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": "object"
@@ -5309,6 +5309,9 @@
                         {
                             "$ref": "#/definitions/CoordinateOptionProperties"
                         },
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
                         {
                             "type": "string"
                         }
@@ -5713,8 +5716,8 @@
                     "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"
+                    "$ref": "#/definitions/ModelRef",
+                    "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."
                 },
                 "promptMessage": {
                     "description": "If present, overrides the default message of the dialog that prompts the user for a file.",
@@ -8273,14 +8276,7 @@
             "description": "Properties used to set a series of watch handles and/or event listeners on an item.",
             "properties": {
                 "item": {
-                    "anyOf": [
-                        {
-                            "$ref": "#/definitions/Model"
-                        },
-                        {
-                            "type": "string"
-                        }
-                    ],
+                    "$ref": "#/definitions/ModelRef",
                     "description": "The item whose properties will be watched for changes and/or events."
                 },
                 "watch": {
@@ -8370,6 +8366,9 @@
                         {
                             "$ref": "#/definitions/CoordinateOptionProperties"
                         },
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
                         {
                             "type": "string"
                         }
@@ -22736,7 +22735,14 @@
             ]
         },
         "ui.get-component-ids:input": {
-            "type": "string"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": "string"
+                }
+            ]
         },
         "ui.get-component-ids:output": {
             "items": {
@@ -22751,7 +22757,14 @@
             ]
         },
         "ui.get-component-state:input": {
-            "type": "string"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": "string"
+                }
+            ]
         },
         "ui.get-component-state:output": {
             "$ref": "#/definitions/State"
@@ -22793,7 +22806,14 @@
             ]
         },
         "ui.get-visual-state:input": {
-            "type": "string"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": "string"
+                }
+            ]
         },
         "ui.get-visual-state:output": {
             "type": "string"

package/package.json

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

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "58.10.1";
+export declare const version = "58.10.2";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "58.10.1";
+export const version = "58.10.2";