@vertigis/viewer-spec 47.3.0 → 47.4.0

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

@@ -10,6 +10,11 @@ export interface FeatureInfoModelProperties extends CommonFeatureDetailsModelPro
      * collection.
      */
     onFeatureAdd?: Action;
+    /**
+     * A command or set of commands to execute when an interactive feature
+     * editing session begins.
+     */
+    onFeatureEdit?: Action;
     /**
      * A command or set of commands to execute when a feature is removed from
      * the collection.
@@ -19,4 +24,14 @@ export interface FeatureInfoModelProperties extends CommonFeatureDetailsModelPro
      * A command or set of commands to execute when a related record is clicked.
      */
     onRelatedRecordClick?: Action;
+    /**
+     * If true, the feature details instance will show a button that runs the
+     * action that places the feature in edit mode.
+     */
+    showEditButton?: boolean;
+    /**
+     * If true, the feature details instance will show a button that deletes the
+     * feature permanently.
+     */
+    showDeleteButton?: boolean;
 }

package/messaging/registry/edit.d.ts

@@ -85,7 +85,7 @@ export interface AttachmentEventArgs {
     attachment: Attachment;
 }
 /**
- * Options for editing operations that display a UI.
+ * Options for interactive feature editing sessions.
  */
 export interface EditUIOptions {
     /**
@@ -114,18 +114,29 @@ export interface EditOptions {
      * Whether to allow editing of feature attributes.
      */
     editAttributes?: boolean;
-    /**
-     * Whether to allow editing of feature attachments.
-     */
-    editAttachments?: boolean;
     /**
      * Options for the geometry editing session.
      */
     editGeometryOptions?: EditGeometryOptions;
 }
 /**
- * Arguments for the "edit.create-feature" operation. Also may be supplied to
- * augment an interactive editing session. A valid feature layer is required.
+ * Used to update an in-progress interactive feature editing session with new
+ * attributes, attachments or geometry. Web only.
+ */
+export interface UpdateSessionArgs extends HasGeometry {
+    /**
+     * A collection of attributes that apply or are to be applied to the
+     * currently edited feature.
+     */
+    attributes?: Record<string, string | number>;
+    /**
+     * A collection of attachments that apply or are to be applied to the
+     * currently edited feature.
+     */
+    attachments?: Attachment[];
+}
+/**
+ * Arguments for the "edit.create-feature" operation. A valid feature layer is required.
  * The geometry is required for non-tabular features. Web only.
  */
 export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps, EditUIOptions {
@@ -138,20 +149,37 @@ export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps, Edit
      * layer. The default or first template will be used if not set.
      */
     templateName?: string;
+    /**
+     * 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.
+     */
+    typeId?: string;
 }
 /**
  * Arguments for the "edit.display-add-features" command. Web only.
  */
-export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, HasUITarget, EditOptions, EditUIOptions {
+export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, EditOptions, EditUIOptions {
+    /**
+     * Arguments for the display of the attribute editing form.
+     */
+    formUITarget?: HasUITarget;
+    /**
+     * Arguments for the display of the template picker.
+     */
+    templateUITarget?: HasUITarget;
 }
 /**
  * Arguments for the "edit.display-update-features" operation. Web only.
  */
-export interface DisplayUpdateFeatureArgs extends EditCommandArgs, HasGeometry, HasMaps, EditOptions {
+export interface DisplayUpdateFeatureArgs extends EditCommandArgs, HasGeometry, HasMaps, HasUITarget, EditOptions {
     /**
      * A collection of attributes to automatically apply to the updated feature.
      */
     featureAttributes?: Record<string, unknown>;
+    /**
+     * Whether to allow editing of feature attachments. Web only.
+     */
+    editAttachments?: boolean;
 }
 /**
  * Arguments for the "edit.add-features", "edit.update-features" and
@@ -176,34 +204,60 @@ export declare class EditCommands extends CommandRegistry {
      */
     get deleteAttachment(): Command<DeleteAttachmentArgs>;
     /**
-     * Adds a feature to a particular layer. `Feature[]` and
+     * Adds a feature to a particular layer. `Features` and
      * `EditCommandArgs` are not supported on Mobile.
      */
-    get addFeature(): Command<Feature | Feature[] | EditCommandArgs>;
+    get addFeature(): Command<Feature | Features | EditCommandArgs>;
+    /**
+     * Cancels active editing sessions and discards any changes. If a feature is
+     * supplied only the sessions using that feature will be cancelled.
+     *
+     * @webOnly
+     */
+    get cancel(): Command<Features>;
+    /**
+     * 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.
+     *
+     * @webOnly
+     */
+    get complete(): Command<Features>;
     /**
      * Deletes the given feature or features from their feature sources.
      * `EditCommandArgs` is not supported on Mobile.
      */
-    get deleteFeatures(): Command<Feature | Feature[] | EditCommandArgs>;
+    get deleteFeatures(): Command<Features | EditCommandArgs>;
     /**
-     * Display a form for adding a feature. `DisplayAddFeatureArgs` is not
-     * supported on Mobile.
+     * Begin an interactive feature editing session with a new feature.
+     * `DisplayAddFeatureArgs` is not supported on Mobile.
      */
     get displayAddFeature(): Command<FeatureSource | DisplayAddFeatureArgs>;
     /**
-     * Display a form for updating a feature. `DisplayUpdateFeatureArgs` is not
-     * supported on Mobile.
+     * Begin an interactive feature editing session with an existing feature.
+     * `DisplayUpdateFeatureArgs` is not supported on Mobile.
      */
     get displayUpdateFeature(): Command<Feature | DisplayUpdateFeatureArgs>;
     /**
-     * Updates a feature. `Feature[]` and `EditCommandArgs` are not
-     * supported on Mobile.
+     * 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.
      */
-    get updateFeature(): Command<Feature | Feature[] | EditCommandArgs>;
+    get updateFeature(): Command<Feature | Features | EditCommandArgs>;
+    /**
+     * 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.
+     *
+     * @webOnly
+     */
+    get updateSession(): Command<UpdateSessionArgs>;
 }
 export declare class EditOperations extends OperationRegistry {
     /**
-     * Creates a new `Feature` for the supplied layer from the supplied data.
+     * 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.
      *
      * @webOnly
      */
@@ -229,15 +283,25 @@ export declare class EditEvents extends EventRegistry {
      */
     get attachmentDeleted(): Event<AttachmentEventArgs>;
     /**
-     * Raised when a feature is added.
+     * Raised when a new feature is added to a feature source.
      */
     get featureAdded(): Event<Feature>;
     /**
-     * Raised when a feature is deleted.
+     * Raised when a feature is deleted from a feature source.
      */
     get featureDeleted(): Event<Feature>;
     /**
-     * Raised when a feature is updated.
+     * Raised when the attributes or geometry of a feature from a feature source
+     * are updated.
      */
     get featureUpdated(): Event<Feature>;
+    /**
+     * Raised when an interactive feature editing session is updated with new
+     * attributes, attachments, or feature geometry. The payload of this event
+     * represents the current state of that session and has not yet been applied
+     * to the feature.
+     *
+     * @webOnly
+     */
+    get sessionUpdated(): Event<UpdateSessionArgs>;
 }

package/messaging/registry/edit.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class EditCommands extends CommandRegistry{get addAttachment(){return this._messages.command("edit.add-attachment")}get deleteAttachment(){return this._messages.command("edit.delete-attachment")}get addFeature(){return this._messages.command("edit.add-feature")}get deleteFeatures(){return this._messages.command("edit.delete-features")}get displayAddFeature(){return this._messages.command("edit.display-add-feature")}get displayUpdateFeature(){return this._messages.command("edit.display-update-feature")}get updateFeature(){return this._messages.command("edit.update-feature")}}export class EditOperations extends OperationRegistry{get createFeature(){return this._messages.operation("edit.create-feature")}}export class EditEvents extends EventRegistry{get attachmentAdded(){return this._messages.event("edit.attachment-added")}get attachmentUpdated(){return this._messages.event("edit.attachment-updated")}get attachmentDeleted(){return this._messages.event("edit.attachment-deleted")}get featureAdded(){return this._messages.event("edit.feature-added")}get featureDeleted(){return this._messages.event("edit.feature-deleted")}get featureUpdated(){return this._messages.event("edit.feature-updated")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class EditCommands extends CommandRegistry{get addAttachment(){return this._messages.command("edit.add-attachment")}get deleteAttachment(){return this._messages.command("edit.delete-attachment")}get addFeature(){return this._messages.command("edit.add-feature")}get cancel(){return this._messages.command("edit.cancel")}get complete(){return this._messages.command("edit.complete")}get deleteFeatures(){return this._messages.command("edit.delete-features")}get displayAddFeature(){return this._messages.command("edit.display-add-feature")}get displayUpdateFeature(){return this._messages.command("edit.display-update-feature")}get updateFeature(){return this._messages.command("edit.update-feature")}get updateSession(){return this._messages.command("edit.update-session")}}export class EditOperations extends OperationRegistry{get createFeature(){return this._messages.operation("edit.create-feature")}}export class EditEvents extends EventRegistry{get attachmentAdded(){return this._messages.event("edit.attachment-added")}get attachmentUpdated(){return this._messages.event("edit.attachment-updated")}get attachmentDeleted(){return this._messages.event("edit.attachment-deleted")}get featureAdded(){return this._messages.event("edit.feature-added")}get featureDeleted(){return this._messages.event("edit.feature-deleted")}get featureUpdated(){return this._messages.event("edit.feature-updated")}get sessionUpdated(){return this._messages.event("edit.session-updated")}}

package/messaging/registry/ui.d.ts

@@ -282,8 +282,6 @@ export declare class UICommands extends CommandRegistry {
     get hideBusyState(): Command;
     /**
      * Hides a notification previously shown to the user.
-     *
-     * @mobileOnly
      */
     get hideNotification(): Command;
     /**

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

@@ -798,13 +798,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"
@@ -820,14 +813,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."
@@ -844,10 +837,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"
@@ -859,6 +848,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"
@@ -905,8 +902,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": {
@@ -932,10 +932,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"
@@ -1421,6 +1429,24 @@
             },
             "type": "object"
         },
+        "HasUITarget": {
+            "additionalProperties": false,
+            "description": "An object with arguments for a command or operation that can display temporary UI.",
+            "properties": {
+                "attributes": {
+                    "description": "Optional layout XML attributes to be used for the transient UI container."
+                },
+                "icon": {
+                    "description": "Optional icon that may be used by the transient UI container.",
+                    "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"
+                }
+            },
+            "type": "object"
+        },
         "IdentifyArgs": {
             "additionalProperties": false,
             "description": "Arguments for the tasks.identify operation.",
@@ -2425,24 +2451,43 @@
             ]
         },
         "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"
                 }
             ]
         },
@@ -2463,22 +2508,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"
             ]
@@ -2494,7 +2558,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"
             ]
@@ -2510,24 +2574,43 @@
             ]
         },
         "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"
                 }
             ]
         },
@@ -11485,6 +11568,12 @@
         "ui.display-notification:input": {
             "$ref": "#/definitions/DisplayNotificationArgs"
         },
+        "ui.hide-notification": {
+            "description": "Hides a notification previously shown to the user.",
+            "enum": [
+                "ui.hide-notification"
+            ]
+        },
         "ui.set-theme": {
             "description": "Sets the color theme of the viewer. The required argument is the new theme's ID.",
             "enum": [
@@ -12491,6 +12580,9 @@
                 {
                     "$ref": "#/definitions/ui.display-notification"
                 },
+                {
+                    "$ref": "#/definitions/ui.hide-notification"
+                },
                 {
                     "$ref": "#/definitions/ui.set-theme"
                 },

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

@@ -365,7 +365,7 @@
             "type": "string"
         },
         "edit.feature-added": {
-            "description": "Raised when a feature is added.",
+            "description": "Raised when a new feature is added to a feature source.",
             "enum": [
                 "edit.feature-added"
             ]
@@ -374,7 +374,7 @@
             "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
         },
         "edit.feature-deleted": {
-            "description": "Raised when a feature is deleted.",
+            "description": "Raised when a feature is deleted from a feature source.",
             "enum": [
                 "edit.feature-deleted"
             ]
@@ -383,7 +383,7 @@
             "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
         },
         "edit.feature-updated": {
-            "description": "Raised when a feature is updated.",
+            "description": "Raised when the attributes or geometry of a feature from a feature source are updated.",
             "enum": [
                 "edit.feature-updated"
             ]