@vertigis/viewer-spec 45.2.0 → 46.0.0

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

@@ -740,7 +740,7 @@
         },
         "AddNodeToGeometryArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the \"sketching.add-node-to-geometry\" operation.",
+            "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" with {@link AddPointArgs} or \"sketching.insert-point\" with {@link InsertPointArgs} instead.",
             "properties": {
                 "geometry": {
                     "$ref": "#/definitions/esri.Geometry",
@@ -774,6 +774,10 @@
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.add-point\" command.",
             "properties": {
+                "geometry": {
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
+                },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "Map(s) to use for the command/operation."
@@ -1325,12 +1329,24 @@
             "description": "Arguments for the \"sketching.delete\" command.",
             "properties": {
                 "geometry": {
-                    "$ref": "#/definitions/esri.Point",
-                    "description": "The point to delete from the active sketch. Not supported in Geocortex Mobile."
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry to remove a point from. If this property is not specified, any active vertices will be deleted."
                 },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "Map(s) to use for the command/operation."
+                },
+                "partIndex": {
+                    "description": "The index of the part of the geometry that the point should be removed from. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.",
+                    "type": "number"
+                },
+                "point": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The point to remove from the geometry. If this property is defined, the 'pointIndex' and 'partIndex' properties are ignored. If no point nor pointIndex/partIndex are specified, any active points will be deleted. If there are no active points, the entire geometry will be deleted."
+                },
+                "pointIndex": {
+                    "description": "The index of the point that should be removed from the geometry. If this property is defined, the geometry property must also be defined.",
+                    "type": "number"
                 }
             },
             "type": "object"
@@ -1348,8 +1364,8 @@
                     "type": "boolean"
                 },
                 "message": {
-                    "description": "The message to be displayed in the notification.",
-                    "type": "string"
+                    "$ref": "#/definitions/TranslatableText",
+                    "description": "The message to be displayed in the notification. Mobile only supports a string for this property."
                 },
                 "notificationGroup": {
                     "description": "Notifications in the same notification group are mutually exclusive, and will supersede one another. Mobile only.",
@@ -1539,6 +1555,10 @@
                     "description": "Whether to allow scaling of the edited geometry. Defaults to true.",
                     "type": "boolean"
                 },
+                "enableVertexEditing": {
+                    "description": "Whether to allow the user to add, move, and remove vertices from a geometry. Defaults to true.",
+                    "type": "boolean"
+                },
                 "scaleMode": {
                     "description": "Setting \"free\" allows independent scaling on the x and y axis, \"preserve-aspect-ratio\" constrains scaling to the original aspect ratio. Defaults to \"preserve-aspect-ratio\".",
                     "enum": [
@@ -1546,6 +1566,10 @@
                         "preserve-aspect-ratio"
                     ],
                     "type": "string"
+                },
+                "validateGeometry": {
+                    "description": "Whether the resulting geometry is validated before it's returned from the operation. If the geometry is invalid upon completion, an error is thrown. Defaults to true.",
+                    "type": "boolean"
                 }
             },
             "type": "object"
@@ -2509,9 +2533,31 @@
             },
             "type": "object"
         },
+        "GetActivePointsResult": {
+            "additionalProperties": false,
+            "description": "Result returned from the 'sketching.get-active-points' operation.",
+            "properties": {
+                "graphics": {
+                    "description": "The active graphic(s).",
+                    "items": {
+                        "$ref": "#/definitions/esri.Graphic"
+                    },
+                    "type": "array"
+                },
+                "maps": {
+                    "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
+                    "description": "The map associated with the graphics."
+                }
+            },
+            "required": [
+                "graphics",
+                "maps"
+            ],
+            "type": "object"
+        },
         "GetActiveSketchResult": {
             "additionalProperties": false,
-            "description": "Result returned from the 'sketching.get-active-sketch' and 'sketching.get-active-node' operations.",
+            "description": "Result returned from the 'sketching.get-active-sketch' operation.",
             "properties": {
                 "graphics": {
                     "description": "The active graphic(s).",
@@ -2531,6 +2577,28 @@
             ],
             "type": "object"
         },
+        "GetAdjacentPointArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the 'sketching.get-adjacent-point' operation.",
+            "properties": {
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "referencePoint": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "A point geometry that represents a vertex within an active editing graphic."
+                },
+                "relativeOffset": {
+                    "$ref": "#/definitions/PointOffset",
+                    "description": "Specifies if the desired point comes before or after the referencePoint. Defaults to 'after'."
+                }
+            },
+            "required": [
+                "referencePoint"
+            ],
+            "type": "object"
+        },
         "GetCoordinateArgs": {
             "additionalProperties": false,
             "description": "Arguments for the map.get-user-coordinates-input operation.",
@@ -2866,6 +2934,10 @@
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.insert-point\" command.",
             "properties": {
+                "geometry": {
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry to add the point to, if multiple are present in an active editing session. Not supported by Mobile."
+                },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "Map(s) to use for the command/operation."
@@ -3054,6 +3126,23 @@
             ],
             "type": "string"
         },
+        "Maps": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
+                },
+                {
+                    "$ref": "#/definitions/HasMaps"
+                },
+                {
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
+                    },
+                    "type": "array"
+                }
+            ],
+            "description": "One or more map extensions, or an object that has map extensions."
+        },
         "MapsLike": {
             "anyOf": [
                 {
@@ -3197,7 +3286,7 @@
         },
         "MoveNodeArgs": {
             "additionalProperties": false,
-            "description": "The arguments for the \"sketching.move-node\" command.",
+            "description": "Deprecated - use \"sketching.move-point\" with {@link MovePointArgs}.",
             "properties": {
                 "maps": {
                     "$ref": "MapsLike",
@@ -3217,6 +3306,45 @@
             ],
             "type": "object"
         },
+        "MovePointArgs": {
+            "additionalProperties": false,
+            "description": "The arguments for the \"sketching.move-point\" command.",
+            "properties": {
+                "distance": {
+                    "$ref": "#/definitions/Vector2D",
+                    "description": "An amount to move the point(s) on the X and Y axes. If the newPoint property is defined, this property will be ignored."
+                },
+                "geometry": {
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry where the point exists, if multiple are present in an active editing session. This property is required if pointIndex and/or partIndex are defined."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "newPoint": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The new point that will replace the target point within an active sketch or edit geometry. If this property is defined, the distance property will be ignored."
+                },
+                "partIndex": {
+                    "description": "The part of the geometry where the point exists. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.",
+                    "type": "number"
+                },
+                "point": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The point to move, which must already exist within the active sketch. If this property is undefined and no geometry and pointIndex are specified, the active point(s) will be moved."
+                },
+                "pointIndex": {
+                    "description": "The index of the point. If this property is defined, the 'geometry' property must also be defined.",
+                    "type": "number"
+                },
+                "units": {
+                    "$ref": "#/definitions/LengthUnits",
+                    "description": "The units of the above distance. Optional, will default to the units used by the measurement service associated with the map."
+                }
+            },
+            "type": "object"
+        },
         "NarrateArgs": {
             "anyOf": [
                 {
@@ -3303,6 +3431,14 @@
             ],
             "type": "string"
         },
+        "PointOffset": {
+            "description": "Specifies if a desired point comes before or after a given reference point.",
+            "enum": [
+                "after",
+                "before"
+            ],
+            "type": "string"
+        },
         "ProjectArgs": {
             "additionalProperties": false,
             "description": "Arguments for the geometry.project operation.",
@@ -3806,6 +3942,43 @@
             ],
             "type": "object"
         },
+        "SetActivePointsArgs": {
+            "additionalProperties": false,
+            "description": "The arguments for the \"sketching.set-active-points\" command.",
+            "properties": {
+                "geometry": {
+                    "$ref": "#/definitions/esri.Geometry",
+                    "description": "The geometry where the new active point exists, if multiple are present in an active editing session. This property is required if pointIndex and/or partIndex are defined."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "partIndex": {
+                    "description": "The part of the geometry where the new active point exists. Required for polyline and polygon geometry types when the geometry and pointIndex properties are defined.",
+                    "type": "number"
+                },
+                "pointIndex": {
+                    "description": "The index of the new active point. If this property is defined, the geometry property must be defined.",
+                    "type": "number"
+                },
+                "points": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/esri.Point"
+                        },
+                        {
+                            "items": {
+                                "$ref": "#/definitions/esri.Point"
+                            },
+                            "type": "array"
+                        }
+                    ],
+                    "description": "The new point(s) that will become active in the sketch or editing session. Sketching only supports one active point; if multiple are specified, then only the first will be set as active."
+                }
+            },
+            "type": "object"
+        },
         "SetBasemapArg": {
             "anyOf": [
                 {
@@ -4150,7 +4323,7 @@
         },
         "SwitchActiveNodeArgs": {
             "additionalProperties": false,
-            "description": "The arguments for the \"sketching.switch-active-node\" command.",
+            "description": "Deprecated - use \"sketching.set-active-points\" with {@link SetActivePointsArgs}.",
             "properties": {
                 "maps": {
                     "$ref": "MapsLike",
@@ -4557,6 +4730,61 @@
             ],
             "type": "object"
         },
+        "TranslatableText": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/TranslateOptions"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "A translatable string, either a language string or a language string with arguments to pass into it."
+        },
+        "TranslateOptions": {
+            "additionalProperties": false,
+            "description": "The available options for the Locale Service translate function.",
+            "properties": {
+                "args": {
+                    "description": "The values to substitute into the format string if it contains substitution placeholders (see utilities/string/format in Geocortex API).",
+                    "items": {
+                    },
+                    "type": "array"
+                },
+                "currency": {
+                    "description": "The default unit of currency to use when formatting currency. See {@link NumberSettings.currency}.",
+                    "type": "string"
+                },
+                "dateFormat": {
+                    "description": "The default format to use when formatting dates. See {@link DateFormatter.format}.",
+                    "type": "string"
+                },
+                "fractionalDigits": {
+                    "description": "The default number of digits to show after the decimal point when formatting numbers. See {@link NumberSettings.fractionalDigits}.",
+                    "type": "number"
+                },
+                "locale": {
+                    "description": "The locale to use for translation. If not specified, the current locale will be used.",
+                    "type": "string"
+                },
+                "numberFormat": {
+                    "description": "The default format to use when formatting numbers. See {@link NumberFormatter.format}.",
+                    "type": "string"
+                },
+                "text": {
+                    "description": "The string to translate. If the text is a language resource key, then a localized version of that resource will be used if one exists, otherwise the original text is returned.",
+                    "type": "string"
+                },
+                "timeZone": {
+                    "description": "The time zone of a date being formatted.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "text"
+            ],
+            "type": "object"
+        },
         "UpdateChartDefinitionArgs": {
             "additionalProperties": false,
             "description": "Arguments for the charts.update-definition command.",
@@ -16696,7 +16924,7 @@
             ]
         },
         "sketching.add-node-to-geometry": {
-            "description": "Adds a point to a given polyline or polygon geometry. Returns the resulting geometry. Deprecated in Mobile, use geometry.add-point instead.",
+            "description": "Deprecated - Mobile users should rather use \"geometry.add-point\"; Web users should use \"sketching.add-point\" or \"sketching.insert-point\" instead.",
             "enum": [
                 "sketching.add-node-to-geometry"
             ]
@@ -16708,7 +16936,7 @@
             "$ref": "#/definitions/esri.Geometry"
         },
         "sketching.add-point": {
-            "description": "Adds a point to polygon or polyline using the selected index as the point to insert after.",
+            "description": "Adds a point to polygon, polyline, or multipoint using the selected index as the point to insert after.",
             "enum": [
                 "sketching.add-point"
             ]
@@ -16735,13 +16963,20 @@
             "$ref": "#/definitions/CaptureGeometryResult"
         },
         "sketching.delete": {
-            "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.",
+            "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, any active points in the session will be deleted. If there are no active points in the session, the entire geometry will be deleted.",
             "enum": [
                 "sketching.delete"
             ]
         },
         "sketching.delete:input": {
-            "$ref": "#/definitions/DeleteGeometryArgs"
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/DeleteGeometryArgs"
+                },
+                {
+                    "type": "null"
+                }
+            ]
         },
         "sketching.disable-free-scale-mode": {
             "description": "Disables free scaling while editing geometries.",
@@ -16789,16 +17024,28 @@
             ]
         },
         "sketching.get-active-node": {
-            "description": "Returns the active point graphic of the active sketch on a map.",
+            "description": "Deprecated - use 'sketching.get-active-points' instead.",
             "enum": [
                 "sketching.get-active-node"
             ]
         },
         "sketching.get-active-node:input": {
-            "type": "string"
+            "$ref": "Maps"
         },
         "sketching.get-active-node:output": {
-            "$ref": "#/definitions/GetActiveSketchResult"
+            "$ref": "#/definitions/GetActivePointsResult"
+        },
+        "sketching.get-active-points": {
+            "description": "Returns the active point graphics of the active sketch or edit session on a map.",
+            "enum": [
+                "sketching.get-active-points"
+            ]
+        },
+        "sketching.get-active-points:input": {
+            "$ref": "Maps"
+        },
+        "sketching.get-active-points:output": {
+            "$ref": "#/definitions/GetActivePointsResult"
         },
         "sketching.get-active-sketch": {
             "description": "Returns the active sketch graphic from a map.",
@@ -16809,8 +17056,20 @@
         "sketching.get-active-sketch:output": {
             "$ref": "#/definitions/GetActiveSketchResult"
         },
+        "sketching.get-adjacent-point": {
+            "description": "Return the adjacent point graphic(s), relative to a given vertex that's a part of an active editing or sketching session. This operation is only supported for Polyline and Polygon geometries.",
+            "enum": [
+                "sketching.get-adjacent-point"
+            ]
+        },
+        "sketching.get-adjacent-point:input": {
+            "$ref": "#/definitions/GetAdjacentPointArgs"
+        },
+        "sketching.get-adjacent-point:output": {
+            "$ref": "#/definitions/GetActiveSketchResult"
+        },
         "sketching.insert-point": {
-            "description": "Inserts a point into a polygon or polyline at the specified index. If the partIndex is null, then the last part is used. If the pointIndex is null, then the new point is inserted at the end.",
+            "description": "Inserts a point into a polygon, polyline, or multipoint at the specified index. If the partIndex is null, then the last part is used. If the pointIndex is null, then the new point is inserted at the end.",
             "enum": [
                 "sketching.insert-point"
             ]
@@ -16831,7 +17090,7 @@
             "$ref": "#/definitions/GeometryOperationBase"
         },
         "sketching.move-node": {
-            "description": "Moves a point within an active sketch to a new location.",
+            "description": "Deprecated - use 'sketching.move-point' instead.",
             "enum": [
                 "sketching.move-node"
             ]
@@ -16839,6 +17098,15 @@
         "sketching.move-node:input": {
             "$ref": "#/definitions/MoveNodeArgs"
         },
+        "sketching.move-point": {
+            "description": "Moves a point within an active sketch to a new location.",
+            "enum": [
+                "sketching.move-point"
+            ]
+        },
+        "sketching.move-point:input": {
+            "$ref": "#/definitions/MovePointArgs"
+        },
         "sketching.redo": {
             "description": "Redoes the last undone edit while editing a geometry.",
             "enum": [
@@ -16872,6 +17140,15 @@
         "sketching.scale-geometry:output": {
             "$ref": "#/definitions/GeometryOperationBase"
         },
+        "sketching.set-active-points": {
+            "description": "Switches the active point of an active sketch.",
+            "enum": [
+                "sketching.set-active-points"
+            ]
+        },
+        "sketching.set-active-points:input": {
+            "$ref": "#/definitions/SetActivePointsArgs"
+        },
         "sketching.set-geometry-mode": {
             "description": "Sets the geometry mode of the geometry editor.",
             "enum": [
@@ -16882,7 +17159,7 @@
             "$ref": "#/definitions/SetGeometryModeArgs"
         },
         "sketching.stop": {
-            "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, returns null.",
+            "description": "Stops geometry capturing or editing on a given map. Returns the current geometry. If validateGeometry parameter is true and geometry is invalid, the operation will return null.",
             "enum": [
                 "sketching.stop"
             ]
@@ -16901,7 +17178,7 @@
             "$ref": "#/definitions/CaptureGeometryResult"
         },
         "sketching.switch-active-node": {
-            "description": "Switches the active point of an active sketch.",
+            "description": "Deprecated - use 'sketching.set-active-points' instead.",
             "enum": [
                 "sketching.switch-active-node"
             ]
@@ -18814,6 +19091,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.move-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.move-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -18830,6 +19123,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.set-active-points:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.set-active-points"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -19439,9 +19748,15 @@
                 {
                     "$ref": "#/definitions/sketching.move-node"
                 },
+                {
+                    "$ref": "#/definitions/sketching.move-point"
+                },
                 {
                     "$ref": "#/definitions/sketching.redo"
                 },
+                {
+                    "$ref": "#/definitions/sketching.set-active-points"
+                },
                 {
                     "$ref": "#/definitions/sketching.set-geometry-mode"
                 },
@@ -20143,6 +20458,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.get-active-points:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.get-active-points"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.get-adjacent-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.get-adjacent-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -20504,9 +20851,15 @@
                 {
                     "$ref": "#/definitions/sketching.get-active-node"
                 },
+                {
+                    "$ref": "#/definitions/sketching.get-active-points"
+                },
                 {
                     "$ref": "#/definitions/sketching.get-active-sketch"
                 },
+                {
+                    "$ref": "#/definitions/sketching.get-adjacent-point"
+                },
                 {
                     "$ref": "#/definitions/sketching.move-geometry"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "45.2.0",
+  "version": "46.0.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -34,11 +34,11 @@
   },
   "author": "VertiGIS Ltd.",
   "peerDependencies": {
-    "@vertigis/arcgis-extensions": ">= 34.1.0  < 35.0.0"
+    "@vertigis/arcgis-extensions": ">= 34.2.2  < 35.0.0"
   },
   "devDependencies": {
     "@arcgis/core": "4.21.2",
-    "@vertigis/arcgis-extensions": "34.1.0 ",
+    "@vertigis/arcgis-extensions": "34.2.2",
     "@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 = "45.2.0";
+export declare const version = "46.0.0";

package/version.js

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