@vertigis/viewer-spec 55.0.0 → 55.2.0

package/messaging/registry/results.d.ts

@@ -400,6 +400,14 @@ export declare class ResultsCommands extends CommandRegistry {
      * Removes features from a currently shown set of features.
      */
     get remove(): Command<ShowResultsArgs>;
+    /**
+     * Replaces feature(s) in the shown set of features. If a feature is not
+     * contained in the current set it is ignored. Features are uniquely
+     * identified by ID and not by object quality. Web only.
+     *
+     * @webOnly
+     */
+    get replace(): Command<ShowResultsArgs>;
     /**
      * Clear features from results list, results table, and results details. If
      * a component model or model ID is given, then only the specified component

package/messaging/registry/results.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends e{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends s{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends t{get configureUploadData(){return this._messages.operation("results.configure-upload-data")}get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromFiles(){return this._messages.operation("results.from-files")}get uploadDataFromFiles(){return this._messages.operation("results.upload-data-from-files")}get uploadDataToFeatures(){return this._messages.operation("results.upload-data-to-features")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends e{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get replace(){return this._messages.command("results.replace")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends s{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends t{get configureUploadData(){return this._messages.operation("results.configure-upload-data")}get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromFiles(){return this._messages.operation("results.from-files")}get uploadDataFromFiles(){return this._messages.operation("results.upload-data-from-files")}get uploadDataToFeatures(){return this._messages.operation("results.upload-data-to-features")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}

package/messaging/registry/ui.d.ts

@@ -22,13 +22,22 @@ export declare enum NotificationCategory {
  */
 export interface MessageBoxArgs {
     /**
-     * The title of the Dialog.
+     * The title of the dialog.
      */
     title?: string;
     /**
-     * The message to be displayed in the Dialog.
+     * The message to be displayed in the dialog.
      */
     message?: string;
+    /**
+     * Whether the dialog is draggable or not. Defaults to true. Web only.
+     */
+    isDraggable?: boolean;
+    /**
+     * Where the dialog appears in the app when it is created. Defaults to
+     * center position. Web only.
+     */
+    initialPosition?: MessageBoxPosition;
 }
 /**
  * Arguments for the 'ui.alert' command.
@@ -225,6 +234,10 @@ export declare enum Position {
     RIGHT = "right",
     TOP = "top"
 }
+/**
+ * A position for the MessageBox dialog.
+ */
+export type MessageBoxPosition = "bottom" | "start" | "end" | "top" | "bottom-start" | "bottom-end" | "top-start" | "top-end" | "center";
 /**
  * Arguments for the ui.narrate command.
  */

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

@@ -821,12 +821,20 @@
                     "description": "The text to display on the dismiss button.",
                     "type": "string"
                 },
+                "initialPosition": {
+                    "$ref": "MessageBoxPosition",
+                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                },
+                "isDraggable": {
+                    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
+                    "type": "boolean"
+                },
                 "message": {
-                    "description": "The message to be displayed in the Dialog.",
+                    "description": "The message to be displayed in the dialog.",
                     "type": "string"
                 },
                 "title": {
-                    "description": "The title of the Dialog.",
+                    "description": "The title of the dialog.",
                     "type": "string"
                 }
             },
@@ -964,8 +972,16 @@
                     "description": "The text to display on the cancel button.",
                     "type": "string"
                 },
+                "initialPosition": {
+                    "$ref": "MessageBoxPosition",
+                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                },
+                "isDraggable": {
+                    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
+                    "type": "boolean"
+                },
                 "message": {
-                    "description": "The message to be displayed in the Dialog.",
+                    "description": "The message to be displayed in the dialog.",
                     "type": "string"
                 },
                 "okButtonText": {
@@ -973,7 +989,7 @@
                     "type": "string"
                 },
                 "title": {
-                    "description": "The title of the Dialog.",
+                    "description": "The title of the dialog.",
                     "type": "string"
                 }
             },

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

@@ -846,12 +846,20 @@
                     "description": "The text to display on the dismiss button.",
                     "type": "string"
                 },
+                "initialPosition": {
+                    "$ref": "MessageBoxPosition",
+                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                },
+                "isDraggable": {
+                    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
+                    "type": "boolean"
+                },
                 "message": {
-                    "description": "The message to be displayed in the Dialog.",
+                    "description": "The message to be displayed in the dialog.",
                     "type": "string"
                 },
                 "title": {
-                    "description": "The title of the Dialog.",
+                    "description": "The title of the dialog.",
                     "type": "string"
                 }
             },
@@ -1084,8 +1092,16 @@
                     "description": "The text to display on the cancel button.",
                     "type": "string"
                 },
+                "initialPosition": {
+                    "$ref": "MessageBoxPosition",
+                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                },
+                "isDraggable": {
+                    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
+                    "type": "boolean"
+                },
                 "message": {
-                    "description": "The message to be displayed in the Dialog.",
+                    "description": "The message to be displayed in the dialog.",
                     "type": "string"
                 },
                 "okButtonText": {
@@ -1093,7 +1109,7 @@
                     "type": "string"
                 },
                 "title": {
-                    "description": "The title of the Dialog.",
+                    "description": "The title of the dialog.",
                     "type": "string"
                 }
             },

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

@@ -1069,12 +1069,20 @@
                     "description": "The text to display on the dismiss button.",
                     "type": "string"
                 },
+                "initialPosition": {
+                    "$ref": "MessageBoxPosition",
+                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                },
+                "isDraggable": {
+                    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
+                    "type": "boolean"
+                },
                 "message": {
-                    "description": "The message to be displayed in the Dialog.",
+                    "description": "The message to be displayed in the dialog.",
                     "type": "string"
                 },
                 "title": {
-                    "description": "The title of the Dialog.",
+                    "description": "The title of the dialog.",
                     "type": "string"
                 }
             },
@@ -1411,8 +1419,16 @@
                     "description": "The text to display on the cancel button.",
                     "type": "string"
                 },
+                "initialPosition": {
+                    "$ref": "MessageBoxPosition",
+                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                },
+                "isDraggable": {
+                    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
+                    "type": "boolean"
+                },
                 "message": {
-                    "description": "The message to be displayed in the Dialog.",
+                    "description": "The message to be displayed in the dialog.",
                     "type": "string"
                 },
                 "okButtonText": {
@@ -1420,7 +1436,7 @@
                     "type": "string"
                 },
                 "title": {
-                    "description": "The title of the Dialog.",
+                    "description": "The title of the dialog.",
                     "type": "string"
                 }
             },
@@ -4918,8 +4934,16 @@
                     "description": "The default value to display in the input box.",
                     "type": "string"
                 },
+                "initialPosition": {
+                    "$ref": "MessageBoxPosition",
+                    "description": "Where the dialog appears in the app when it is created. Defaults to center position. Web only."
+                },
+                "isDraggable": {
+                    "description": "Whether the dialog is draggable or not. Defaults to true. Web only.",
+                    "type": "boolean"
+                },
                 "message": {
-                    "description": "The message to be displayed in the Dialog.",
+                    "description": "The message to be displayed in the dialog.",
                     "type": "string"
                 },
                 "okButtonText": {
@@ -4927,7 +4951,7 @@
                     "type": "string"
                 },
                 "title": {
-                    "description": "The title of the Dialog.",
+                    "description": "The title of the dialog.",
                     "type": "string"
                 }
             },
@@ -20069,6 +20093,15 @@
         "results.remove:input": {
             "$ref": "#/definitions/ShowResultsArgs"
         },
+        "results.replace": {
+            "description": "Replaces feature(s) in the shown set of features. If a feature is not contained in the current set it is ignored. Features are uniquely identified by ID and not by object quality. Web only.",
+            "enum": [
+                "results.replace"
+            ]
+        },
+        "results.replace:input": {
+            "$ref": "#/definitions/ShowResultsArgs"
+        },
         "results.set-display-components": {
             "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. Web only.",
             "enum": [
@@ -22860,6 +22893,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/results.replace:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/results.replace"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -23750,6 +23799,9 @@
                 {
                     "$ref": "#/definitions/results.remove"
                 },
+                {
+                    "$ref": "#/definitions/results.replace"
+                },
                 {
                     "$ref": "#/definitions/results.set-display-components"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "55.0.0",
+  "version": "55.2.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -43,7 +43,7 @@
   ],
   "peerDependencies": {
     "@arcgis/core": "*",
-    "@vertigis/arcgis-extensions": ">= 40.5.0  < 41.0.0"
+    "@vertigis/arcgis-extensions": ">= 40.6.1  < 41.0.0"
   },
   "devDependencies": {
     "@prettier/plugin-xml": "2.2.0",

package/version.d.ts

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

package/version.js

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