@vertigis/viewer-spec 59.3.0 → 59.4.0

package/layout/schema/layout-web.xsd

@@ -25,6 +25,20 @@
         </complexType>
     </element>
 
+    <element name="bulk-editing" substitutionGroup="base:component">
+        <annotation>
+            <documentation xml:lang="en">
+                A component that enables bulk editing of multiple features' attributes
+                simultaneously.
+            </documentation>
+        </annotation>
+        <complexType>
+            <complexContent>
+                <extension base="base:Component" />
+            </complexContent>
+        </complexType>
+    </element>
+
     <element name="chart" substitutionGroup="base:component">
         <annotation>
             <documentation xml:lang="en">A component that shows a chart.</documentation>

package/messaging/registry/bulk-editing.d.ts

@@ -0,0 +1,35 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Features, HasFeatures } from "../common.js";
+/**
+ * Arguments for the "bulk-editing" commands. Web only.
+ */
+export type BulkEditingArgs = Features | HasFeatures;
+/**
+ * Commands for managing bulk editing functionality in ViewerSpec.
+ *
+ * Core bulk editing functionality is handled by the edit registry.
+ */
+export declare class BulkEditingCommands extends CommandRegistry {
+    protected readonly _prefix = "bulk-editing";
+    /**
+     * Adds features to the bulk editing session. Typically used to stage
+     * features for later bulk updates. Web only.
+     *
+     * @webOnly
+     */
+    get add(): Command<BulkEditingArgs>;
+    /**
+     * Displays the bulk editing interface for a given set of features. Updates
+     * the UI to show editable attributes for the provided features. Web only.
+     *
+     * @webOnly
+     */
+    get display(): Command<BulkEditingArgs>;
+    /**
+     * Removes features from the bulk editing session. Web only.
+     *
+     * @webOnly
+     */
+    get remove(): Command<BulkEditingArgs>;
+}

package/messaging/registry/bulk-editing.js

@@ -0,0 +1 @@
+import{CommandRegistry as e}from"../CommandRegistry.js";export class BulkEditingCommands extends e{_prefix="bulk-editing";get add(){return this._get("add")}get display(){return this._get("display")}get remove(){return this._get("remove")}}

package/messaging/registry/edit.d.ts

@@ -207,10 +207,6 @@ export interface DisplayAddRelatedFeatureArgs extends Omit<DisplayAddFeatureArgs
      */
     relatedFeatureSource: FeatureSource;
 }
-/**
- * Override settings for a field element.
- */
-export type FieldElementOverride = Partial<FieldElement>;
 /**
  * Arguments for the "edit.display-update-features" operation. Web only.
  */
@@ -234,6 +230,64 @@ export interface EditCommandArgs extends HasFeatures {
      */
     showNotifications?: boolean;
 }
+/**
+ * Arguments for the "edit.bulk-attribute-update" command. Web only.
+ */
+export interface BulkAttributeUpdateArgs extends HasFeatures {
+    /**
+     * The attributes to update on all features.
+     */
+    attributes: Record<string, unknown>;
+}
+/**
+ * Result of a bulk attribute validation. Web only.
+ */
+export interface ValidationResult {
+    /**
+     * Whether this validation passed or failed.
+     */
+    isValid: boolean;
+    /**
+     * Optional validation message or error details.
+     */
+    message?: string;
+}
+/**
+ * Arguments for bulk attribute validation events. Web only.
+ */
+export interface BulkAttributeValidationEventArgs extends HasFeatures {
+    /**
+     * Array of validation results from different validators. The bulk edit
+     * operation is considered valid only if all results are valid.
+     */
+    validationResults: ValidationResult[];
+}
+/**
+ * Arguments for bulk attribute completion event. Web only.
+ */
+export interface BulkAttributeCompleteEventArgs extends HasFeatures {
+    /**
+     * Whether the bulk attribute update was successful.
+     */
+    success: boolean;
+    /**
+     * Optional error message if the update failed.
+     */
+    error?: string;
+}
+/**
+ * Arguments for bulk attribute pre-validation event. Web only.
+ */
+export interface BulkAttributePreValidationEventArgs extends HasFeatures {
+    /**
+     * The attributes that will be applied to the features.
+     */
+    attributes: Record<string, unknown>;
+}
+/**
+ * Override settings for a field element.
+ */
+export type FieldElementOverride = Partial<FieldElement>;
 export declare class EditCommands extends CommandRegistry {
     protected readonly _prefix = "edit";
     /**
@@ -352,6 +406,14 @@ export declare class EditCommands extends CommandRegistry {
      * @webOnly
      */
     get updateSession(): Command<UpdateSessionArgs>;
+    /**
+     * Updates multiple features from multiple sources simultaneously. This
+     * command commits the bulk attribute changes directly to the feature
+     * source. Web only.
+     *
+     * @webOnly
+     */
+    get bulkAttributeUpdate(): Command<BulkAttributeUpdateArgs>;
     /**
      * Clears a feature's GNSS metadata. This command will clear the well known
      * GNSS attributes, such as "esrignss_longitude" and "esrignss_latitude".
@@ -401,6 +463,25 @@ export declare class EditEvents extends EventRegistry {
      * @mobileOnly
      */
     get attachmentDeleted(): Event<AttachmentEventArgs>;
+    /**
+     * Raised before bulk attribute update validation occurs, allowing for
+     * modifications to the features. Web only.
+     *
+     * @webOnly
+     */
+    get bulkAttributeUpdatePreValidation(): Event<BulkAttributePreValidationEventArgs>;
+    /**
+     * Raised when bulk attribute update validation is complete. Web only.
+     *
+     * @webOnly
+     */
+    get bulkAttributeUpdateValidation(): Event<BulkAttributeValidationEventArgs>;
+    /**
+     * Raised when a bulk attribute update is complete. Web only.
+     *
+     * @webOnly
+     */
+    get bulkAttributeUpdateComplete(): Event<BulkAttributeCompleteEventArgs>;
     /**
      * Raised when a new feature is added to a feature source.
      */

package/messaging/registry/edit.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as a}from"../OperationRegistry.js";export class EditCommands extends e{_prefix="edit";get addAttachment(){return this._get("add-attachment")}get deleteAttachment(){return this._get("delete-attachment")}get addFeature(){return this._get("add-feature")}get cancel(){return this._get("cancel")}get complete(){return this._get("complete")}get deleteFeatures(){return this._get("delete-features")}get displayAddFeature(){return this._get("display-add-feature")}get displayAddRelatedFeature(){return this._get("display-add-related-feature")}get displayUpdateFeature(){return this._get("display-update-feature")}get updateFeature(){return this._get("update-feature")}get updateSession(){return this._get("update-session")}get clearGnssMetadata(){return this._get("clear-gnss-metadata")}}export class EditOperations extends a{_prefix="edit";get createFeature(){return this._get("create-feature")}get updateGnssMetadata(){return this._get("update-gnss-metadata")}}export class EditEvents extends t{_prefix="edit";get attachmentAdded(){return this._get("attachment-added")}get attachmentUpdated(){return this._get("attachment-updated")}get attachmentDeleted(){return this._get("attachment-deleted")}get featureAdded(){return this._get("feature-added")}get featureDeleted(){return this._get("feature-deleted")}get featureUpdated(){return this._get("feature-updated")}get sessionUpdated(){return this._get("session-updated")}}
+import{CommandRegistry as t}from"../CommandRegistry.js";import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as a}from"../OperationRegistry.js";export class EditCommands extends t{_prefix="edit";get addAttachment(){return this._get("add-attachment")}get deleteAttachment(){return this._get("delete-attachment")}get addFeature(){return this._get("add-feature")}get cancel(){return this._get("cancel")}get complete(){return this._get("complete")}get deleteFeatures(){return this._get("delete-features")}get displayAddFeature(){return this._get("display-add-feature")}get displayAddRelatedFeature(){return this._get("display-add-related-feature")}get displayUpdateFeature(){return this._get("display-update-feature")}get updateFeature(){return this._get("update-feature")}get updateSession(){return this._get("update-session")}get bulkAttributeUpdate(){return this._get("bulk-attribute-update")}get clearGnssMetadata(){return this._get("clear-gnss-metadata")}}export class EditOperations extends a{_prefix="edit";get createFeature(){return this._get("create-feature")}get updateGnssMetadata(){return this._get("update-gnss-metadata")}}export class EditEvents extends e{_prefix="edit";get attachmentAdded(){return this._get("attachment-added")}get attachmentUpdated(){return this._get("attachment-updated")}get attachmentDeleted(){return this._get("attachment-deleted")}get bulkAttributeUpdatePreValidation(){return this._get("bulk-attribute-update-pre-validation")}get bulkAttributeUpdateValidation(){return this._get("bulk-attribute-update-validation")}get bulkAttributeUpdateComplete(){return this._get("bulk-attribute-update-complete")}get featureAdded(){return this._get("feature-added")}get featureDeleted(){return this._get("feature-deleted")}get featureUpdated(){return this._get("feature-updated")}get sessionUpdated(){return this._get("session-updated")}}

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

@@ -1511,6 +1511,23 @@
             ],
             "type": "object"
         },
+        "BulkAttributeUpdateArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"edit.bulk-attribute-update\" command. Web only.",
+            "properties": {
+                "attributes": {
+                    "description": "The attributes to update on all features."
+                },
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                }
+            },
+            "required": [
+                "attributes"
+            ],
+            "type": "object"
+        },
         "CaptureGeometryArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.capture-geometry\" operation.",
@@ -9802,6 +9819,15 @@
                 }
             ]
         },
+        "edit.bulk-attribute-update": {
+            "description": "Updates multiple features from multiple sources simultaneously. This command commits the bulk attribute changes directly to the feature source. Web only.",
+            "enum": [
+                "edit.bulk-attribute-update"
+            ]
+        },
+        "edit.bulk-attribute-update:input": {
+            "$ref": "#/definitions/BulkAttributeUpdateArgs"
+        },
         "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. Web only.",
             "enum": [
@@ -23813,6 +23839,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.bulk-attribute-update:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.bulk-attribute-update"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -26335,6 +26377,9 @@
                 {
                     "$ref": "#/definitions/edit.add-feature"
                 },
+                {
+                    "$ref": "#/definitions/edit.bulk-attribute-update"
+                },
                 {
                     "$ref": "#/definitions/edit.cancel"
                 },

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

@@ -595,6 +595,66 @@
             ],
             "type": "string"
         },
+        "BulkAttributeCompleteEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for bulk attribute completion event. Web only.",
+            "properties": {
+                "error": {
+                    "description": "Optional error message if the update failed.",
+                    "type": "string"
+                },
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                },
+                "success": {
+                    "description": "Whether the bulk attribute update was successful.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "success"
+            ],
+            "type": "object"
+        },
+        "BulkAttributePreValidationEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for bulk attribute pre-validation event. Web only.",
+            "properties": {
+                "attributes": {
+                    "description": "The attributes that will be applied to the features."
+                },
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                }
+            },
+            "required": [
+                "attributes"
+            ],
+            "type": "object"
+        },
+        "BulkAttributeValidationEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for bulk attribute validation events. Web only.",
+            "properties": {
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                },
+                "validationResults": {
+                    "description": "Array of validation results from different validators. The bulk edit operation is considered valid only if all results are valid.",
+                    "items": {
+                        "$ref": "#/definitions/ValidationResult"
+                    },
+                    "type": "array"
+                }
+            },
+            "required": [
+                "validationResults"
+            ],
+            "type": "object"
+        },
         "ComponentId": {
             "description": "A component's ID in the layout.",
             "type": "string"
@@ -749,6 +809,36 @@
             ],
             "description": "Feature reductions declutter the screen by hiding features that would otherwise intersect with other features on screen."
         },
+        "FeaturesLike": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSet.FeatureSet"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureList.FeatureList"
+                },
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureStream.FeatureStream"
+                },
+                {
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.FeatureProperties"
+                            },
+                            {
+                                "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                            }
+                        ]
+                    },
+                    "type": "array"
+                }
+            ],
+            "description": "Represents one or more features."
+        },
         "FilterModeJson": {
             "anyOf": [
                 {
@@ -1770,6 +1860,50 @@
             ],
             "description": "Symbol types used in web scenes."
         },
+        "SymbolJson": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.CIMSymbolJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.PictureFillSymbolJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.PictureMarkerSymbolJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleFillSymbolJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleLineSymbolJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.SimpleMarkerSymbolJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.TextSymbolJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.LabelSymbol3DJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.LineSymbol3DJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.MeshSymbol3DJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.PointSymbol3DJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.PolygonSymbol3DJson"
+                },
+                {
+                    "$ref": "#/definitions/esri.rest-api.SymbolJson.StyleSymbolReferenceJson"
+                }
+            ],
+            "description": "A symbol representing a feature on the map.\n\nPart of the Esri ArcGIS REST API (see http://resources.arcgis.com/en/help/rest/apiref/symbol.html). See {@link https://developers.arcgis.com/web-map-specification/objects/symbol/}."
+        },
         "TargetsResultsSetArgs": {
             "additionalProperties": false,
             "description": "Arguments for various commands that target a result set of features.",
@@ -1814,6 +1948,24 @@
             },
             "type": "object"
         },
+        "ValidationResult": {
+            "additionalProperties": false,
+            "description": "Result of a bulk attribute validation. Web only.",
+            "properties": {
+                "isValid": {
+                    "description": "Whether this validation passed or failed.",
+                    "type": "boolean"
+                },
+                "message": {
+                    "description": "Optional validation message or error details.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "isValid"
+            ],
+            "type": "object"
+        },
         "ViewModeChangedEvent": {
             "additionalProperties": false,
             "description": "Arguments for the ViewModeChanged event.",
@@ -1997,6 +2149,33 @@
         "auth.token-refreshed:input": {
             "type": "string"
         },
+        "edit.bulk-attribute-update-complete": {
+            "description": "Raised when a bulk attribute update is complete. Web only.",
+            "enum": [
+                "edit.bulk-attribute-update-complete"
+            ]
+        },
+        "edit.bulk-attribute-update-complete:input": {
+            "$ref": "#/definitions/BulkAttributeCompleteEventArgs"
+        },
+        "edit.bulk-attribute-update-pre-validation": {
+            "description": "Raised before bulk attribute update validation occurs, allowing for modifications to the features. Web only.",
+            "enum": [
+                "edit.bulk-attribute-update-pre-validation"
+            ]
+        },
+        "edit.bulk-attribute-update-pre-validation:input": {
+            "$ref": "#/definitions/BulkAttributePreValidationEventArgs"
+        },
+        "edit.bulk-attribute-update-validation": {
+            "description": "Raised when bulk attribute update validation is complete. Web only.",
+            "enum": [
+                "edit.bulk-attribute-update-validation"
+            ]
+        },
+        "edit.bulk-attribute-update-validation:input": {
+            "$ref": "#/definitions/BulkAttributeValidationEventArgs"
+        },
         "edit.feature-added": {
             "description": "Raised when a new feature is added to a feature source.",
             "enum": [
@@ -3130,7 +3309,7 @@
                     "description": "A popupInfo object defining the content of popup window when you click a feature on the map. Applicable to features in a map notes feature layer only."
                 },
                 "symbol": {
-                    "$ref": "#/definitions/esri.rest-api.SymbolJson.SymbolJson",
+                    "$ref": "#/definitions/SymbolJson",
                     "description": "Symbol used for drawing the feature."
                 }
             },
@@ -9390,8 +9569,23 @@
                     "description": "Callout configuration for a symbol."
                 },
                 "styleOrigin": {
-                    "$ref": "__type",
-                    "description": "The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). It may be used to understand where a symbol was originally sourced from, but does not affect actual appearance or rendering of the symbol. See {@link https://developers.arcgis.com/web-scene-specification/objects/styleOrigin/}."
+                    "additionalProperties": false,
+                    "description": "The origin of the style from which the symbol was originally referenced. A reference to the style origin can be either by styleName or by styleUrl (but not both). It may be used to understand where a symbol was originally sourced from, but does not affect actual appearance or rendering of the symbol. See {@link https://developers.arcgis.com/web-scene-specification/objects/styleOrigin/}.",
+                    "properties": {
+                        "name": {
+                            "description": "Name of the symbol in the style referenced by styleName or styleUrl.",
+                            "type": "string"
+                        },
+                        "styleName": {
+                            "description": "A well-known esri-provided style, such as EsriThematicShapesStyle.",
+                            "type": "string"
+                        },
+                        "styleUrl": {
+                            "description": "URL to a style definition Must be one of the following values: String An absolute URL String A relative path starting with \"./\".",
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
                 },
                 "symbolLayers": {
                     "description": "A Collection of Symbol3DLayer objects used to visualize the graphic or feature.",
@@ -11464,6 +11658,15 @@
                 {
                     "$ref": "#/definitions/auth.token-refreshed"
                 },
+                {
+                    "$ref": "#/definitions/edit.bulk-attribute-update-complete"
+                },
+                {
+                    "$ref": "#/definitions/edit.bulk-attribute-update-pre-validation"
+                },
+                {
+                    "$ref": "#/definitions/edit.bulk-attribute-update-validation"
+                },
                 {
                     "$ref": "#/definitions/edit.feature-added"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "59.3.0",
+  "version": "59.4.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "59.3.0";
+export declare const version = "59.4.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "59.3.0";
+export const version = "59.4.0";