@vertigis/viewer-spec 45.2.0 → 46.2.0

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

@@ -302,6 +302,33 @@
         "auth.token-refreshed:input": {
             "type": "string"
         },
+        "edit.feature-added": {
+            "description": "Raised when a feature is added.",
+            "enum": [
+                "edit.feature-added"
+            ]
+        },
+        "edit.feature-added:input": {
+            "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+        },
+        "edit.feature-deleted": {
+            "description": "Raised when a feature is deleted.",
+            "enum": [
+                "edit.feature-deleted"
+            ]
+        },
+        "edit.feature-deleted:input": {
+            "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+        },
+        "edit.feature-updated": {
+            "description": "Raised when a feature is updated.",
+            "enum": [
+                "edit.feature-updated"
+            ]
+        },
+        "edit.feature-updated:input": {
+            "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+        },
         "esri.Point": {
             "$ref": "esri/geometry/Point"
         },
@@ -8844,6 +8871,15 @@
                 {
                     "$ref": "#/definitions/auth.token-refreshed"
                 },
+                {
+                    "$ref": "#/definitions/edit.feature-added"
+                },
+                {
+                    "$ref": "#/definitions/edit.feature-deleted"
+                },
+                {
+                    "$ref": "#/definitions/edit.feature-updated"
+                },
                 {
                     "$ref": "#/definitions/geolocation.accuracy-changed"
                 },

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

@@ -321,6 +321,29 @@
             },
             "type": "object"
         },
+        "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference": {
+            "additionalProperties": false,
+            "description": "Matches an existing layer.",
+            "properties": {
+                "id": {
+                    "description": "The layer's ID.",
+                    "type": "string"
+                },
+                "path": {
+                    "description": "The path to the geodatabase used by an MMAP layer. Mobile only.",
+                    "type": "string"
+                },
+                "subtype": {
+                    "description": "The Layer's type, used for Layer types with multiple possible layer extension mappings.",
+                    "type": "string"
+                },
+                "title": {
+                    "description": "The layer's title.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "@vertigis.arcgis-extensions.support.Action.Action": {
             "$ref": "#/definitions/viewer-spec.Action"
         },
@@ -476,7 +499,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",
@@ -872,12 +895,93 @@
             "description": "Arguments for the \"sketching.delete\" command.",
             "properties": {
                 "geometry": {
+                    "$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 delete from the active sketch. Not supported in Geocortex Mobile."
+                    "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"
+        },
+        "DisplayAddFeatureArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"edit.display-add-features\" command. Web only.",
+            "properties": {
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
+                "editAttachments": {
+                    "description": "Whether to allow editing of feature attachments.",
+                    "type": "boolean"
+                },
+                "editAttributes": {
+                    "description": "Whether to allow editing of feature attributes.",
+                    "type": "boolean"
+                },
+                "editGeometry": {
+                    "description": "Whether to allow editing of feature geometry.",
+                    "type": "boolean"
+                },
+                "editGeometryOptions": {
+                    "$ref": "#/definitions/EditGeometryOptions",
+                    "description": "Options for the geometry editing session."
+                },
+                "featureAttributes": {
+                    "description": "A collection of attributes to apply to the new feature."
+                },
+                "geometry": {
+                    "$ref": "#/definitions/GeometryLike",
+                    "description": "The geometry 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."
                 },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "Map(s) to use for the command/operation."
+                },
+                "orientation": {
+                    "description": "The orientation of the template picker.",
+                    "enum": [
+                        "horizontal",
+                        "vertical"
+                    ],
+                    "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"
+                },
+                "showNotifications": {
+                    "description": "Whether to show UI notifications.",
+                    "type": "boolean"
+                },
+                "showTitles": {
+                    "description": "Whether to show titles on the template picker.",
+                    "type": "boolean"
+                },
+                "templateName": {
+                    "description": "The template to use as a starting point for this feature. Requires a layer. The default or first template will be used if not set.",
+                    "type": "string"
                 }
             },
             "type": "object"
@@ -938,8 +1042,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.",
@@ -947,7 +1051,7 @@
                 },
                 "position": {
                     "$ref": "Position",
-                    "description": "The position of the notification on the screen."
+                    "description": "The position of the notification on the screen. Web only."
                 },
                 "title": {
                     "description": "The notification title - only shown for system notifications. Mobile only.",
@@ -990,6 +1094,63 @@
             ],
             "type": "object"
         },
+        "DisplayUpdateFeatureArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"edit.display-update-features\" operation. Web only.",
+            "properties": {
+                "editAttachments": {
+                    "description": "Whether to allow editing of feature attachments.",
+                    "type": "boolean"
+                },
+                "editAttributes": {
+                    "description": "Whether to allow editing of feature attributes.",
+                    "type": "boolean"
+                },
+                "editGeometry": {
+                    "description": "Whether to allow editing of feature geometry.",
+                    "type": "boolean"
+                },
+                "editGeometryOptions": {
+                    "$ref": "#/definitions/EditGeometryOptions",
+                    "description": "Options for the geometry editing session."
+                },
+                "featureAttributes": {
+                    "description": "A collection of attributes to automatically apply to the updated feature."
+                },
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                },
+                "geometry": {
+                    "$ref": "#/definitions/GeometryLike",
+                    "description": "The geometry to use for the command/operation."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "showNotifications": {
+                    "description": "Whether to show UI notifications.",
+                    "type": "boolean"
+                }
+            },
+            "type": "object"
+        },
+        "EditCommandArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"edit.add-features\", \"edit.update-features\" and \"edit.delete-features\" commands. Web only.",
+            "properties": {
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                },
+                "showNotifications": {
+                    "description": "Whether to show UI notifications.",
+                    "type": "boolean"
+                }
+            },
+            "type": "object"
+        },
         "EditGeometryArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.edit-geometry\" operation.",
@@ -1075,6 +1236,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": [
@@ -1082,6 +1247,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"
@@ -1710,6 +1879,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."
@@ -1755,6 +1928,54 @@
             ],
             "type": "object"
         },
+        "LayersLike": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/esri.Layer"
+                },
+                {
+                    "$ref": "esri.SublayerLike"
+                },
+                {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
+                },
+                {
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/esri.Layer"
+                            },
+                            {
+                                "$ref": "esri.SublayerLike"
+                            },
+                            {
+                                "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
+                            },
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerExtension"
+                            },
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
+                            },
+                            {
+                                "type": "string"
+                            }
+                        ]
+                    },
+                    "type": "array"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "One or more objects that are convertible to layer extensions."
+        },
         "LengthUnitsMobile": {
             "description": "The units for distance supported by Mobile.",
             "enum": [
@@ -2002,7 +2223,7 @@
                     "description": "An object containing arguments that this command was originally executed with. This property is populated automatically when using a bound action. The URL will be the configured value, and the context is automatically populated as the argument that was passed into the execute method when the command was executed in context."
                 },
                 "numberFormatterLocale": {
-                    "description": "The locale to use for number token substitution. Accepts a valid locale  code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
+                    "description": "The locale to use for number token substitution. Accepts a valid locale code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
                     "type": "string"
                 },
                 "url": {
@@ -2712,6 +2933,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"
+        },
         "UpdateResultsFeaturesArgs": {
             "additionalProperties": false,
             "description": "Arguments for various commands that affect a result component's features.",
@@ -2730,6 +3006,40 @@
             ],
             "type": "object"
         },
+        "WebOpenUrlArgs": {
+            "additionalProperties": false,
+            "description": "VertiGIS Studio Web's arguments for the system.open-url command.",
+            "properties": {
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                },
+                "geometry": {
+                    "$ref": "#/definitions/GeometryLike",
+                    "description": "The geometry to use for the command/operation."
+                },
+                "layers": {
+                    "$ref": "#/definitions/LayersLike",
+                    "description": "Layer(s) to use for the command/operation."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "numberFormatterLocale": {
+                    "description": "The locale to use for number token substitution. Accepts a valid locale code (example: \"en\", \"fr\" or \"de-AT\"), or \"device\" or \"invariant\" which will use the device's current culture or the invariant culture, respectively. Default is invariant culture.",
+                    "type": "string"
+                },
+                "url": {
+                    "description": "The URL to open.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "url"
+            ],
+            "type": "object"
+        },
         "ZoomToViewpointArgs": {
             "additionalProperties": false,
             "description": "Arguments for the map.zoom-to-viewpoint command.",
@@ -2888,16 +3198,29 @@
             "$ref": "#/definitions/AddAttachmentArgs"
         },
         "edit.add-feature": {
-            "description": "Adds a feature to a particular layer.",
+            "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
             "enum": [
                 "edit.add-feature"
             ]
         },
         "edit.add-feature:input": {
-            "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
+                },
+                {
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                    },
+                    "type": "array"
+                }
+            ]
         },
         "edit.delete-features": {
-            "description": "Deletes the given feature or features from their feature sources.",
+            "description": "Deletes the given feature or features from their feature sources. `EditCommandArgs` is not supported on Mobile.",
             "enum": [
                 "edit.delete-features"
             ]
@@ -2907,6 +3230,9 @@
                 {
                     "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
                 },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
+                },
                 {
                     "items": {
                         "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
@@ -2916,31 +3242,58 @@
             ]
         },
         "edit.display-add-feature": {
-            "description": "Display a form for adding a feature.",
+            "description": "Display a form for adding a feature. `DisplayAddFeatureArgs` is not supported on Mobile.",
             "enum": [
                 "edit.display-add-feature"
             ]
         },
         "edit.display-add-feature:input": {
-            "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                },
+                {
+                    "$ref": "#/definitions/DisplayAddFeatureArgs"
+                }
+            ]
         },
         "edit.display-update-feature": {
-            "description": "Display a form for updating a feature.",
+            "description": "Display a form for updating a feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.",
             "enum": [
                 "edit.display-update-feature"
             ]
         },
         "edit.display-update-feature:input": {
-            "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "#/definitions/DisplayUpdateFeatureArgs"
+                }
+            ]
         },
         "edit.update-feature": {
-            "description": "Updates a feature.",
+            "description": "Updates a feature. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
             "enum": [
                 "edit.update-feature"
             ]
         },
         "edit.update-feature:input": {
-            "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
+                },
+                {
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                    },
+                    "type": "array"
+                }
+            ]
         },
         "esri.Extent": {
             "$ref": "esri/geometry/Extent"
@@ -13050,7 +13403,7 @@
             "type": "string"
         },
         "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"
             ]
@@ -13062,7 +13415,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"
             ]
@@ -13110,13 +13463,20 @@
             "$ref": "#/definitions/ClearConstraintsArgs"
         },
         "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.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.",
@@ -13131,7 +13491,7 @@
             "$ref": "#/definitions/EditGeometryResult"
         },
         "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"
             ]
@@ -13206,7 +13566,7 @@
             "$ref": "#/definitions/StartStreamingArgs"
         },
         "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"
             ]
@@ -13252,13 +13612,16 @@
             "type": "boolean"
         },
         "system.open-url": {
-            "description": "Opens a URL, either in the system browser or whatever app is appropriate for the scheme of the URL. If the context is a {@link Features}, then the URL may contain substitution tokens in the format {FIELD_NAME} where FIELD_NAME is the name of a field in the first feature in the context. In this case, the {FIELD_NAME} is substituted with value of the FIELD_NAME field from the feature feature in the {@link Features}, e.g. https://www.google.com/search?q={NAME}, where the value of the NAME field in the first feature from the context is 'Jasper National Park' would produce the result https://www.google.com/search?q=Jasper National Park. Zero to many substitution tokens may be included.",
+            "description": "Opens a URL, either in the system browser or whatever app is appropriate for the scheme of the URL. If {@link Features} are included as context, then the URL may contain substitution tokens in the format {FIELD_NAME} where FIELD_NAME is the name of a field in the first feature in the context. In this case, the {FIELD_NAME} is substituted with value of the FIELD_NAME field from the feature feature in the {@link Features}, e.g. https://www.google.com/search?q={NAME}, where the value of the NAME field in the first feature from the context is 'Jasper National Park' would produce the result https://www.google.com/search?q=Jasper National Park. Zero to many substitution tokens may be included. If maps are included as context, {@link LocationToken} can be used to access properties on the first map's view. In Web, if both layers and maps are included as context, then {@link LayerToken} can be used to access properties on the first layer.",
             "enum": [
                 "system.open-url"
             ]
         },
         "system.open-url:input": {
             "anyOf": [
+                {
+                    "$ref": "#/definitions/WebOpenUrlArgs"
+                },
                 {
                     "$ref": "#/definitions/OpenUrlArgs"
                 },