@vertigis/viewer-spec 46.0.0 → 46.3.0

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

@@ -1154,6 +1154,48 @@
             ],
             "type": "object"
         },
+        "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.",
+            "properties": {
+                "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."
+                },
+                "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"
+                },
+                "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"
+        },
         "CreateGraphicsResult": {
             "additionalProperties": false,
             "description": "Result of the \"drawing.create-graphics\" and \"measurement.create-graphics\" operations.",
@@ -1351,6 +1393,75 @@
             },
             "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"
+        },
         "DisplayNotificationArgs": {
             "additionalProperties": false,
             "description": "The arguments for the `ui.display-notification` command.",
@@ -1373,7 +1484,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.",
@@ -1389,6 +1500,48 @@
             ],
             "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"
+        },
         "DownloadArgs": {
             "additionalProperties": false,
             "description": "Arguments for the system.download-file operation.",
@@ -1470,6 +1623,21 @@
             ],
             "description": "Symbols supported for drawing."
         },
+        "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.",
@@ -3423,6 +3591,27 @@
             ],
             "type": "string"
         },
+        "OpenUrlArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the system.open-url command.",
+            "properties": {
+                "context": {
+                    "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.",
+                    "type": "string"
+                },
+                "url": {
+                    "description": "The URL to open.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "url"
+            ],
+            "type": "object"
+        },
         "Orientation": {
             "description": "An orientation for the layout.",
             "enum": [
@@ -5135,6 +5324,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"
+        },
         "ZoomToLayerArgs": {
             "additionalProperties": false,
             "description": "Arguments for the map.zoom-to-layer-extent and map.zoom-to-layer-visible-scale commands.",
@@ -5699,6 +5922,116 @@
         "drawing.set-sync:input": {
             "type": "boolean"
         },
+        "edit.add-feature": {
+            "description": "Adds a feature to a particular layer. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
+            "enum": [
+                "edit.add-feature"
+            ]
+        },
+        "edit.add-feature:input": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
+                },
+                {
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                    },
+                    "type": "array"
+                }
+            ]
+        },
+        "edit.create-feature": {
+            "description": "Creates a new `Feature` for the supplied layer from the supplied data.",
+            "enum": [
+                "edit.create-feature"
+            ]
+        },
+        "edit.create-feature:input": {
+            "$ref": "#/definitions/CreateFeatureArgs"
+        },
+        "edit.create-feature:output": {
+            "$ref": "#/definitions/HasFeatures"
+        },
+        "edit.delete-features": {
+            "description": "Deletes the given feature or features from their feature sources. `EditCommandArgs` is not supported on Mobile.",
+            "enum": [
+                "edit.delete-features"
+            ]
+        },
+        "edit.delete-features:input": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
+                },
+                {
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                    },
+                    "type": "array"
+                }
+            ]
+        },
+        "edit.display-add-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": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                },
+                {
+                    "$ref": "#/definitions/DisplayAddFeatureArgs"
+                }
+            ]
+        },
+        "edit.display-update-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": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "#/definitions/DisplayUpdateFeatureArgs"
+                }
+            ]
+        },
+        "edit.update-feature": {
+            "description": "Updates a feature. `Feature[]` and `EditCommandArgs` are not supported on Mobile.",
+            "enum": [
+                "edit.update-feature"
+            ]
+        },
+        "edit.update-feature:input": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                },
+                {
+                    "$ref": "#/definitions/EditCommandArgs"
+                },
+                {
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
+                    },
+                    "type": "array"
+                }
+            ]
+        },
         "esri.Color": {
             "$ref": "esri/Color"
         },
@@ -17231,6 +17564,25 @@
         "system.get-sharing-link:output": {
             "type": "string"
         },
+        "system.open-url": {
+            "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"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
         "system.read-file": {
             "description": "Initiates a file read, using the native browser file input.",
             "enum": [
@@ -17715,6 +18067,86 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.add-feature:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.add-feature"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.delete-features:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.delete-features"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.display-add-feature:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.display-add-feature"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.display-update-feature:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.display-update-feature"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.update-feature:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.update-feature"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -19219,6 +19651,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/system.open-url:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/system.open-url"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -19466,6 +19914,21 @@
                 {
                     "$ref": "#/definitions/drawing.set-sync"
                 },
+                {
+                    "$ref": "#/definitions/edit.add-feature"
+                },
+                {
+                    "$ref": "#/definitions/edit.delete-features"
+                },
+                {
+                    "$ref": "#/definitions/edit.display-add-feature"
+                },
+                {
+                    "$ref": "#/definitions/edit.display-update-feature"
+                },
+                {
+                    "$ref": "#/definitions/edit.update-feature"
+                },
                 {
                     "$ref": "#/definitions/geocode.batch-geocode"
                 },
@@ -19772,6 +20235,9 @@
                 {
                     "$ref": "#/definitions/system.download-file"
                 },
+                {
+                    "$ref": "#/definitions/system.open-url"
+                },
                 {
                     "$ref": "#/definitions/ui.activate"
                 },
@@ -19946,6 +20412,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/edit.create-feature:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/edit.create-feature"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -20734,6 +21216,9 @@
                 {
                     "$ref": "#/definitions/drawing.get-default-symbol3-d"
                 },
+                {
+                    "$ref": "#/definitions/edit.create-feature"
+                },
                 {
                     "$ref": "#/definitions/geolocation.get-current-state"
                 },

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

@@ -558,6 +558,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.Color": {
             "$ref": "esri/Color"
         },
@@ -9299,6 +9326,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "46.0.0",
+  "version": "46.3.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -34,11 +34,11 @@
   },
   "author": "VertiGIS Ltd.",
   "peerDependencies": {
-    "@vertigis/arcgis-extensions": ">= 34.2.2  < 35.0.0"
+    "@vertigis/arcgis-extensions": ">= 34.2.3  < 35.0.0"
   },
   "devDependencies": {
     "@arcgis/core": "4.21.2",
-    "@vertigis/arcgis-extensions": "34.2.2",
+    "@vertigis/arcgis-extensions": "34.2.3",
     "@types/glob": "7.1.4",
     "@types/json-stable-stringify": "1.0.33",
     "@types/node": "14.14.41",

package/version.d.ts

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

package/version.js

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