@vertigis/viewer-spec 51.0.0 → 51.2.0

package/messaging/registry/offline.d.ts

@@ -43,6 +43,11 @@ export interface OfflineCommandArgs {
      * The associated map for the offline command/operation.
      */
     maps: MapsLike;
+    /**
+     * Whether a prelanned map area should update after download. Defaults to
+     * false.
+     */
+    updatePreplannedAreaOnDownload: boolean;
 }
 /**
  * Arguments for the "offline.area-activated" event.
@@ -238,6 +243,11 @@ export interface OfflineOperationResult {
      * update) operation.
      */
     syncTableErrors: IDictionary<FeatureTable, Exception>;
+    /**
+     * An OfflineOperationResult. Can be used to capture multiple results from a
+     * chain of offline operations.
+     */
+    nextResult: OfflineOperationResult;
 }
 /**
  * An error code for a known offline operation error.

package/messaging/registry/ui.d.ts

@@ -344,11 +344,12 @@ export declare class UIOperations extends OperationRegistry {
      */
     get confirm(): Operation<ConfirmOperationArgs, boolean>;
     /**
-     * Prompts the user to enter a value in a popup box.
+     * Gets the current locale code for the application. (example: "en", "fr" or
+     * "de-AT").
      *
      * @webOnly
      */
-    get prompt(): Operation<PromptOperationArgs, string>;
+    get getLocale(): Operation<void, string>;
     /**
      * Gets the active color theme of the viewer. Returns the theme's ID.
      *
@@ -367,6 +368,12 @@ export declare class UIOperations extends OperationRegistry {
      * @webOnly
      */
     get getVisualState(): Operation<ComponentId, VisualState | undefined>;
+    /**
+     * Prompts the user to enter a value in a popup box.
+     *
+     * @webOnly
+     */
+    get prompt(): Operation<PromptOperationArgs, string>;
 }
 export declare class UIEvents extends EventRegistry {
     /**

package/messaging/registry/ui.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends CommandRegistry{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get prompt(){return this._messages.operation("ui.prompt")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}}export class UIEvents extends EventRegistry{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends CommandRegistry{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get getLocale(){return this._messages.operation("ui.get-locale")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}get prompt(){return this._messages.operation("ui.prompt")}}export class UIEvents extends EventRegistry{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}

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

@@ -2479,11 +2479,16 @@
                 "offlineArea": {
                     "$ref": "OfflineAreaBase",
                     "description": "The offline area to use."
+                },
+                "updatePreplannedAreaOnDownload": {
+                    "description": "Whether a prelanned map area should update after download. Defaults to false.",
+                    "type": "boolean"
                 }
             },
             "required": [
                 "maps",
-                "offlineArea"
+                "offlineArea",
+                "updatePreplannedAreaOnDownload"
             ],
             "type": "object"
         },
@@ -2532,6 +2537,10 @@
                     "description": "A localized, end-user presentable error message, or null if the operation was successful.",
                     "type": "string"
                 },
+                "nextResult": {
+                    "$ref": "#/definitions/OfflineOperationResult",
+                    "description": "An OfflineOperationResult. Can be used to capture multiple results from a chain of offline operations."
+                },
                 "success": {
                     "description": "Whether or not the operation was successful.",
                     "type": "boolean"
@@ -2567,6 +2576,7 @@
                 "errorCode",
                 "errorCodeString",
                 "errorMessage",
+                "nextResult",
                 "success",
                 "syncLayerErrors",
                 "syncLayerResults",

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

@@ -18824,6 +18824,15 @@
         "ui.focus:input": {
             "$ref": "#/definitions/FocusArgs"
         },
+        "ui.get-locale": {
+            "description": "Gets the current locale code for the application. (example: \"en\", \"fr\" or \"de-AT\").",
+            "enum": [
+                "ui.get-locale"
+            ]
+        },
+        "ui.get-locale:output": {
+            "type": "string"
+        },
         "ui.get-theme": {
             "description": "Gets the active color theme of the viewer. Returns the theme's ID.",
             "enum": [
@@ -22845,6 +22854,9 @@
                 {
                     "$ref": "#/definitions/ui.confirm"
                 },
+                {
+                    "$ref": "#/definitions/ui.get-locale"
+                },
                 {
                     "$ref": "#/definitions/ui.get-theme"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "51.0.0",
+  "version": "51.2.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 = "51.0.0";
+export declare const version = "51.2.0";

package/version.js

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