@vertigis/viewer-spec 47.2.0 → 47.4.1

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

@@ -1193,7 +1193,7 @@
         },
         "CreateFeatureArgs": {
             "additionalProperties": false,
-            "description": "Arguments for the \"edit.create-feature\" operation. Also may be supplied to augment an interactive editing session. A valid feature layer is required. The geometry is required for non-tabular features. Web only.",
+            "description": "Arguments for the \"edit.create-feature\" operation. A valid feature layer is required. The geometry is required for non-tabular features. Web only.",
             "properties": {
                 "featureAttributes": {
                     "description": "A collection of attributes to apply to the new feature."
@@ -1229,6 +1229,10 @@
                 "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"
+                },
+                "typeId": {
+                    "description": "A type id to use as a starting point for this feature. This may return one or more templates and requires a layer with types defined.",
+                    "type": "string"
                 }
             },
             "type": "object"
@@ -1371,13 +1375,6 @@
             "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"
@@ -1393,14 +1390,14 @@
                 "featureAttributes": {
                     "description": "A collection of attributes to apply to the new feature."
                 },
+                "formUITarget": {
+                    "$ref": "#/definitions/HasUITarget",
+                    "description": "Arguments for the display of the attribute editing form."
+                },
                 "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."
@@ -1417,10 +1414,6 @@
                     ],
                     "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"
@@ -1432,6 +1425,14 @@
                 "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"
+                },
+                "templateUITarget": {
+                    "$ref": "#/definitions/HasUITarget",
+                    "description": "Arguments for the display of the template picker."
+                },
+                "typeId": {
+                    "description": "A type id to use as a starting point for this feature. This may return one or more templates and requires a layer with types defined.",
+                    "type": "string"
                 }
             },
             "type": "object"
@@ -1478,8 +1479,11 @@
             "additionalProperties": false,
             "description": "Arguments for the \"edit.display-update-features\" operation. 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.",
+                    "description": "Whether to allow editing of feature attachments. Web only.",
                     "type": "boolean"
                 },
                 "editAttributes": {
@@ -1505,10 +1509,18 @@
                     "$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"
+                },
                 "maps": {
                     "$ref": "MapsLike",
                     "description": "Map(s) to use for the command/operation."
                 },
+                "parent": {
+                    "description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes.",
+                    "type": "string"
+                },
                 "showNotifications": {
                     "description": "Whether to show UI notifications.",
                     "type": "boolean"
@@ -4278,7 +4290,7 @@
                     "description": "The result component to update, referenced by results model or its ID."
                 },
                 "selector": {
-                    "description": "Sets the current selector for the results components to display results using `results.display`. Additionally, any components that do not match the current selector are deactivated.",
+                    "description": "Sets the selector, using CSS selector syntax, which queries for results components in the app layout XML, such as the Results List or Results Table components. The selector is used to determine which components will be activated when displaying results using `results.display`.",
                     "type": "string"
                 }
             },
@@ -5104,6 +5116,27 @@
             ],
             "type": "object"
         },
+        "UpdateSessionArgs": {
+            "additionalProperties": false,
+            "description": "Used to update an in-progress interactive feature editing session with new attributes, attachments or geometry. Web only.",
+            "properties": {
+                "attachments": {
+                    "description": "A collection of attachments that apply or are to be applied to the currently edited feature.",
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.Attachment.Attachment"
+                    },
+                    "type": "array"
+                },
+                "attributes": {
+                    "description": "A collection of attributes that apply or are to be applied to the currently edited feature."
+                },
+                "geometry": {
+                    "$ref": "#/definitions/GeometryLike",
+                    "description": "The geometry to use for the command/operation."
+                }
+            },
+            "type": "object"
+        },
         "Vector2D": {
             "additionalProperties": false,
             "description": "A representation of a 2D vector or point.",
@@ -5883,29 +5916,66 @@
             ]
         },
         "edit.add-feature": {
-            "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
+            "description": "Adds a feature to a particular layer. `Features` and `EditCommandArgs` are not supported on Mobile.",
             "enum": [
                 "edit.add-feature"
             ]
         },
         "edit.add-feature:input": {
             "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
+                },
                 {
                     "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
                 },
                 {
-                    "$ref": "#/definitions/EditCommandArgs"
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
                 },
                 {
                     "items": {
-                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                        "anyOf": [
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                            },
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+                            }
+                        ]
                     },
                     "type": "array"
+                },
+                {
+                    "$ref": "#/definitions/Results"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
                 }
             ]
         },
+        "edit.cancel": {
+            "description": "Cancels active editing sessions and discards any changes. If a feature is supplied only the sessions using that feature will be cancelled.",
+            "enum": [
+                "edit.cancel"
+            ]
+        },
+        "edit.cancel:input": {
+            "$ref": "#/definitions/Features"
+        },
+        "edit.complete": {
+            "description": "Completes active editing sessions and submits any changes made to the attributes, attachments or geometry to the feature source. If a feature is supplied, only sessions using that feature will close.",
+            "enum": [
+                "edit.complete"
+            ]
+        },
+        "edit.complete:input": {
+            "$ref": "#/definitions/Features"
+        },
         "edit.create-feature": {
-            "description": "Creates a new `Feature` for the supplied layer from the supplied data.",
+            "description": "Creates a new feature for the supplied feature source from the supplied configuration. This operation does not add the feature to the source, but returns the feature for further processing.",
             "enum": [
                 "edit.create-feature"
             ]
@@ -5933,22 +6003,41 @@
         },
         "edit.delete-features:input": {
             "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
+                },
                 {
                     "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
                 },
                 {
-                    "$ref": "#/definitions/EditCommandArgs"
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
                 },
                 {
                     "items": {
-                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                        "anyOf": [
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                            },
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+                            }
+                        ]
                     },
                     "type": "array"
+                },
+                {
+                    "$ref": "#/definitions/Results"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
                 }
             ]
         },
         "edit.display-add-feature": {
-            "description": "Display a form for adding a feature. `DisplayAddFeatureArgs` is not supported on Mobile.",
+            "description": "Begin an interactive feature editing session with a new feature. `DisplayAddFeatureArgs` is not supported on Mobile.",
             "enum": [
                 "edit.display-add-feature"
             ]
@@ -5964,7 +6053,7 @@
             ]
         },
         "edit.display-update-feature": {
-            "description": "Display a form for updating a feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.",
+            "description": "Begin an interactive feature editing session with an existing feature. `DisplayUpdateFeatureArgs` is not supported on Mobile.",
             "enum": [
                 "edit.display-update-feature"
             ]
@@ -5980,27 +6069,55 @@
             ]
         },
         "edit.update-feature": {
-            "description": "Updates a feature. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
+            "description": "Updates a layer feature or features. Edits to the geometry and attributes of the supplied features will be committed to their respective feature sources. `Features` and `EditCommandArgs` are not supported on Mobile.",
             "enum": [
                 "edit.update-feature"
             ]
         },
         "edit.update-feature:input": {
             "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
+                },
                 {
                     "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
                 },
                 {
-                    "$ref": "#/definitions/EditCommandArgs"
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
                 },
                 {
                     "items": {
-                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                        "anyOf": [
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                            },
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+                            }
+                        ]
                     },
                     "type": "array"
+                },
+                {
+                    "$ref": "#/definitions/Results"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
                 }
             ]
         },
+        "edit.update-session": {
+            "description": "Updates an in-progress interactive feature editing session with new attributes, attachments, or geometry. These will be immediately applied to the current session, if one is active.",
+            "enum": [
+                "edit.update-session"
+            ]
+        },
+        "edit.update-session:input": {
+            "$ref": "#/definitions/UpdateSessionArgs"
+        },
         "esri.Extent": {
             "$ref": "esri/geometry/Extent"
         },
@@ -16625,7 +16742,7 @@
             "$ref": "#/definitions/ShowResultsArgs"
         },
         "results.set-display-components": {
-            "description": "Sets the current selector for the results components to display results using `results.display`. Additionally, any components that do not match the current selector are deactivated.",
+            "description": "Sets the selector, using CSS selector syntax, which queries for results components in the app layout XML, such as the Results List or Results Table components. The selector is used to determine which components will be activated when displaying results using `results.display`. All other components that do not match the selector are deactivated after running this command.",
             "enum": [
                 "results.set-display-components"
             ]
@@ -17216,6 +17333,12 @@
         "ui.get-visual-state:output": {
             "type": "string"
         },
+        "ui.hide-notification": {
+            "description": "Hides a notification previously shown to the user.",
+            "enum": [
+                "ui.hide-notification"
+            ]
+        },
         "ui.narrate": {
             "description": "Forces assistive technology (screen readers) to narrate a translatable message to the end user.",
             "enum": [
@@ -17543,6 +17666,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.cancel:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.cancel"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.complete:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.complete"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -17623,6 +17778,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.update-session:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.update-session"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -19396,6 +19567,12 @@
                 {
                     "$ref": "#/definitions/edit.add-feature"
                 },
+                {
+                    "$ref": "#/definitions/edit.cancel"
+                },
+                {
+                    "$ref": "#/definitions/edit.complete"
+                },
                 {
                     "$ref": "#/definitions/edit.delete-attachment"
                 },
@@ -19411,6 +19588,9 @@
                 {
                     "$ref": "#/definitions/edit.update-feature"
                 },
+                {
+                    "$ref": "#/definitions/edit.update-session"
+                },
                 {
                     "$ref": "#/definitions/geocode.batch-geocode"
                 },
@@ -19735,6 +19915,9 @@
                 {
                     "$ref": "#/definitions/ui.focus"
                 },
+                {
+                    "$ref": "#/definitions/ui.hide-notification"
+                },
                 {
                     "$ref": "#/definitions/ui.narrate"
                 },