@vertigis/viewer-spec 43.4.1 → 45.0.0

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

@@ -3480,6 +3480,31 @@
             ],
             "type": "object"
         },
+        "RunArcadeArgs": {
+            "additionalProperties": false,
+            "description": "The arguments for the arcade.run operation.",
+            "properties": {
+                "arguments": {
+                    "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. NOTE: All variable keys must consist of only lowercase letters; camel-cased context variables will break the script when they are referenced at runtime."
+                },
+                "canExecuteScript": {
+                    "description": "The stringified Arcade script used to determine whether or not the executeScript can/should be run. If no executeScript is provided and the canExecuteScript returns a truthy value, the operation will return its input arguments; otherwise, if the canEecuteScript returns a falsey value, it will throw a {@link Cancellation}.",
+                    "type": "string"
+                },
+                "executeScript": {
+                    "description": "The stringified Arcade script to run. If this property is included, the operation will return the result of the script.",
+                    "type": "string"
+                },
+                "watchHandles": {
+                    "description": "Properties used to set a series of watch handles and/or event listeners on an item that will trigger the canExecuteChanged event for the 'arcade.run' operation.",
+                    "items": {
+                        "$ref": "#/definitions/WatchEventHandleProperties"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "RunPrintArgs": {
             "additionalProperties": false,
             "description": "The arguments required by the printing.run command.",
@@ -4770,6 +4795,70 @@
             "description": "A component's visual state. The values will vary based on the component type.",
             "type": "string"
         },
+        "WatchEventHandleProperties": {
+            "additionalProperties": false,
+            "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"
+                        }
+                    ],
+                    "description": "The item whose properties will be watched for changes and/or events."
+                },
+                "watch": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/WatchEventProperty"
+                        },
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/WatchEventProperty"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "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 watched for changes; for this to work, the item and all properties referenced within the path (except for the last) must implement {@link Observable}."
+                }
+            },
+            "required": [
+                "item",
+                "watch"
+            ],
+            "type": "object"
+        },
+        "WatchEventProperty": {
+            "additionalProperties": false,
+            "description": "Properties on an item to watch, with an optional event name to listen for.",
+            "properties": {
+                "eventName": {
+                    "description": "The name of the event to listen for. If no propertyPath is included, the listener will go directly on the watched item.",
+                    "type": "string"
+                },
+                "propertyPath": {
+                    "description": "The path used to target a property on an item that will be watched for events. The watched property must implement {@link Evented}; this will effectively do `item[propertyPath].on(eventName)`.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "eventName"
+            ],
+            "type": "object"
+        },
         "ZoomToLayerArgs": {
             "additionalProperties": false,
             "description": "Arguments for the map.zoom-to-layer-extent and map.zoom-to-layer-visible-scale commands.",
@@ -4880,6 +4969,22 @@
                 }
             ]
         },
+        "arcade.run": {
+            "description": "Runs a stringified Arcade script. If only a string is passed in as an argument, it is interpreted as an executeScript. If an executeSript is provided, the operation will return its result. If only a canExecute script is provided and it returns a truthy result, the operation will return its input arguments. If a canExecuteScript returns a falsey value, the operation will throw a {@link Cancellation}.",
+            "enum": [
+                "arcade.run"
+            ]
+        },
+        "arcade.run:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/RunArcadeArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
         "auth.get-current-user": {
             "description": "Gets the user that is currently signed into the application.",
             "enum": [
@@ -15698,6 +15803,15 @@
         "measurement.create-graphics:output": {
             "$ref": "#/definitions/CreateMeasurementGraphicsResult"
         },
+        "measurement.display-settings": {
+            "description": "Display the measurements settings dialog. This allows you to configure measurements system, area and length units.",
+            "enum": [
+                "measurement.display-settings"
+            ]
+        },
+        "measurement.display-settings:input": {
+            "$ref": "#/definitions/HasUITarget"
+        },
         "measurement.get-area-units": {
             "description": "Gets the area units used for measurements. If undefined the units will be selected intelligently based on dimensions.",
             "enum": [
@@ -15903,15 +16017,6 @@
                 }
             ]
         },
-        "measurement.show-settings": {
-            "description": "Show the measurements settings dialog. This allows you to configure measurements system, area and length units.",
-            "enum": [
-                "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": [
@@ -16543,7 +16648,7 @@
             ]
         },
         "sketching.add-node-to-geometry": {
-            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry.",
+            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
             "enum": [
                 "sketching.add-node-to-geometry"
             ]
@@ -16554,6 +16659,12 @@
         "sketching.add-node-to-geometry:output": {
             "$ref": "#/definitions/esri.Geometry"
         },
+        "sketching.cancel": {
+            "description": "Cancels the current geometry edit or capture operation.",
+            "enum": [
+                "sketching.cancel"
+            ]
+        },
         "sketching.capture-geometry": {
             "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.",
             "enum": [
@@ -16567,7 +16678,7 @@
             "$ref": "#/definitions/CaptureGeometryResult"
         },
         "sketching.delete": {
-            "description": "Deletes a point or the entire geometry, depending on which is selected while editing a geometry. If a point is specified in the arguments, it will be deleted (Web only).",
+            "description": "If a point is supplied while a sketching or editing operation is active, the vertex at that point will be deleted from the current geometry. If no point is supplied and a geometry editing session is active, the entire geometry will be deleted.",
             "enum": [
                 "sketching.delete"
             ]
@@ -16575,6 +16686,27 @@
         "sketching.delete:input": {
             "$ref": "#/definitions/DeleteGeometryArgs"
         },
+        "sketching.disable-free-scale-mode": {
+            "description": "Disables free scaling while editing geometries.",
+            "enum": [
+                "sketching.disable-free-scale-mode"
+            ]
+        },
+        "sketching.disable-precision-mode": {
+            "description": "Disables more precise inputs while editing geometries.",
+            "enum": [
+                "sketching.disable-precision-mode"
+            ]
+        },
+        "sketching.edit-active-symbol": {
+            "description": "Allows the user to edit the symbology used by the graphics actively being edited.",
+            "enum": [
+                "sketching.edit-active-symbol"
+            ]
+        },
+        "sketching.edit-active-symbol:output": {
+            "$ref": "#/definitions/EditSymbolResult"
+        },
         "sketching.edit-geometry": {
             "description": "Allows the user to edit an existing geometry by drawing on a map. Returns the geometry that was edited, or the supplied feature with the altered geometry applied, along with the map that it was drawn on.",
             "enum": [
@@ -16587,6 +16719,18 @@
         "sketching.edit-geometry:output": {
             "$ref": "#/definitions/EditGeometryResult"
         },
+        "sketching.enable-free-scale-mode": {
+            "description": "Enables free scaling while editing geometries.",
+            "enum": [
+                "sketching.enable-free-scale-mode"
+            ]
+        },
+        "sketching.enable-precision-mode": {
+            "description": "Enables more precise inputs while editing geometries.",
+            "enum": [
+                "sketching.enable-precision-mode"
+            ]
+        },
         "sketching.get-active-node": {
             "description": "Returns the active point graphic of the active sketch on a map.",
             "enum": [
@@ -16678,7 +16822,14 @@
             ]
         },
         "sketching.stop:input": {
-            "$ref": "#/definitions/StopGeometryEditArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/StopGeometryEditArgs"
+                },
+                {
+                    "type": "null"
+                }
+            ]
         },
         "sketching.stop:output": {
             "$ref": "#/definitions/CaptureGeometryResult"
@@ -17029,6 +17180,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/arcade.run:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/arcade.run"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -18217,10 +18384,10 @@
                     "additionalProperties": false,
                     "properties": {
                         "arguments": {
-                            "$ref": "#/definitions/measurement.set-area-units:input"
+                            "$ref": "#/definitions/measurement.display-settings:input"
                         },
                         "name": {
-                            "$ref": "#/definitions/measurement.set-area-units"
+                            "$ref": "#/definitions/measurement.display-settings"
                         }
                     },
                     "required": [
@@ -18233,10 +18400,10 @@
                     "additionalProperties": false,
                     "properties": {
                         "arguments": {
-                            "$ref": "#/definitions/measurement.set-default-symbol:input"
+                            "$ref": "#/definitions/measurement.set-area-units:input"
                         },
                         "name": {
-                            "$ref": "#/definitions/measurement.set-default-symbol"
+                            "$ref": "#/definitions/measurement.set-area-units"
                         }
                     },
                     "required": [
@@ -18249,10 +18416,10 @@
                     "additionalProperties": false,
                     "properties": {
                         "arguments": {
-                            "$ref": "#/definitions/measurement.set-length-units:input"
+                            "$ref": "#/definitions/measurement.set-default-symbol:input"
                         },
                         "name": {
-                            "$ref": "#/definitions/measurement.set-length-units"
+                            "$ref": "#/definitions/measurement.set-default-symbol"
                         }
                     },
                     "required": [
@@ -18265,10 +18432,10 @@
                     "additionalProperties": false,
                     "properties": {
                         "arguments": {
-                            "$ref": "#/definitions/measurement.show-settings:input"
+                            "$ref": "#/definitions/measurement.set-length-units:input"
                         },
                         "name": {
-                            "$ref": "#/definitions/measurement.show-settings"
+                            "$ref": "#/definitions/measurement.set-length-units"
                         }
                     },
                     "required": [
@@ -18856,6 +19023,9 @@
                 {
                     "$ref": "#/definitions/app.load-project"
                 },
+                {
+                    "$ref": "#/definitions/arcade.run"
+                },
                 {
                     "$ref": "#/definitions/auth.sign-in"
                 },
@@ -19084,6 +19254,9 @@
                 {
                     "$ref": "#/definitions/map.zoom-to-viewpoint"
                 },
+                {
+                    "$ref": "#/definitions/measurement.display-settings"
+                },
                 {
                     "$ref": "#/definitions/measurement.set-area-units"
                 },
@@ -19093,9 +19266,6 @@
                 {
                     "$ref": "#/definitions/measurement.set-length-units"
                 },
-                {
-                    "$ref": "#/definitions/measurement.show-settings"
-                },
                 {
                     "$ref": "#/definitions/messaging.mix-in-args"
                 },
@@ -19144,9 +19314,24 @@
                 {
                     "$ref": "#/definitions/search.clear"
                 },
+                {
+                    "$ref": "#/definitions/sketching.cancel"
+                },
                 {
                     "$ref": "#/definitions/sketching.delete"
                 },
+                {
+                    "$ref": "#/definitions/sketching.disable-free-scale-mode"
+                },
+                {
+                    "$ref": "#/definitions/sketching.disable-precision-mode"
+                },
+                {
+                    "$ref": "#/definitions/sketching.enable-free-scale-mode"
+                },
+                {
+                    "$ref": "#/definitions/sketching.enable-precision-mode"
+                },
                 {
                     "$ref": "#/definitions/sketching.move-node"
                 },
@@ -20206,6 +20391,9 @@
                 {
                     "$ref": "#/definitions/sketching.capture-geometry"
                 },
+                {
+                    "$ref": "#/definitions/sketching.edit-active-symbol"
+                },
                 {
                     "$ref": "#/definitions/sketching.edit-geometry"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "43.4.1",
+  "version": "45.0.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -34,11 +34,11 @@
   },
   "author": "VertiGIS Ltd.",
   "peerDependencies": {
-    "@vertigis/arcgis-extensions": ">= 33.5.4  < 34.0.0"
+    "@vertigis/arcgis-extensions": ">= 34.1.0  < 35.0.0"
   },
   "devDependencies": {
     "@arcgis/core": "4.21.2",
-    "@vertigis/arcgis-extensions": "33.5.4 ",
+    "@vertigis/arcgis-extensions": "34.1.0 ",
     "@types/glob": "7.1.4",
     "@types/json-stable-stringify": "1.0.33",
     "@types/node": "14.14.41",

package/version.d.ts

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

package/version.js

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