@vertigis/viewer-spec 45.2.0 → 46.2.0

package/messaging/registry/system.d.ts

@@ -2,7 +2,7 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Blob, File, HasUITarget } from "../common.js";
+import type { Blob, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget } from "../common.js";
 /**
  * Arguments for the system.download-file operation.
  */
@@ -40,6 +40,24 @@ export interface ReadFileArgs extends HasUITarget {
      */
     promptMessage?: string;
 }
+/**
+ * Well-known location-based tokens that can be used in the system.open-url
+ * command arguments. Location.Map.ZoomLevel is not supported by Mobile; the
+ * supported levels and their associated numeric values can be found here:
+ * https://developers.arcgis.com/documentation/mapping-apis-and-services/reference/zoom-levels-and-scale/.
+ */
+export declare type LocationToken = "Location.Geolocation.Latitude" | "Location.Geolocation.Longitude" | "Location.Feature.Latitude" | "Location.Feature.Longitude" | "Location.Map.Center.Latitude" | "Location.Map.Center.Longitude" | "Location.Map.Scale" | "Location.Map.ZoomLevel" | "Location.Map.TopLeft.Latitude" | "Location.Map.TopLeft.Longitude" | "Location.Map.TopRight.Latitude" | "Location.Map.TopRight.Longitude" | "Location.Map.BottomLeft.Latitude" | "Location.Map.BottomLeft.Longitude" | "Location.Map.BottomRight.Latitude" | "Location.Map.BottomRight.Longitude";
+/**
+ * Well-known layer-based tokens that can be used in the system.open-url command
+ * arguments. NOTE: Not all layer types support extents, urls, min/max scales,
+ * and/or min/max zoom levels.
+ */
+export declare type LayerToken = "Layer.Extent.TopLeft.Latitude" | "Layer.Extent.TopLeft.Longitude" | "Layer.Extent.TopRight.Latitude" | "Layer.Extent.TopRight.Longitude" | "Layer.Extent.BottomLeft.Latitude" | "Layer.Extent.BottomLeft.Longitude" | "Layer.Extent.BottomRight.Latitude" | "Layer.Extent.BottomRight.Longitude" | "Layer.Extent.MaxScale" | "Layer.Extent.MinScale" | "Layer.Extent.MaxZoomLevel" | "Layer.Extent.MinZoomLevel" | "Layer.ID" | "Layer.Title" | "Layer.URL";
+/**
+ * VertiGIS Studio Web's arguments for the system.open-url command.
+ */
+export interface WebOpenUrlArgs extends Omit<OpenUrlArgs, "context">, HasMaps, HasFeatures, HasGeometry, HasLayers {
+}
 /**
  * Arguments for the system.open-url command.
  */
@@ -79,19 +97,22 @@ export declare class SystemCommands extends CommandRegistry {
     get downloadFile(): Command<DownloadArgs | Record<string, unknown> | string>;
     /**
      * Opens a URL, either in the system browser or whatever app is appropriate
-     * for the scheme of the URL. If the context is a {@link Features}, 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.
+     * 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.
+     * 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.
      *
-     * @mobileOnly
      */
-    get openUrl(): Command<OpenUrlArgs | string>;
+    get openUrl(): Command<OpenUrlArgs | WebOpenUrlArgs | string>;
     /**
      * Allows to control if the screen should be kept on. Passing true as parameter
      * will keep the screen on, ignoring possible system settings for screen timeouts.

package/messaging/registry/ui.d.ts

@@ -1,5 +1,5 @@
 import type { UIDensity } from "../../app-config/common/BrandingModelProperties.js";
-import type { TranslateOptions } from "../../app-config/common/TranslatableText.js";
+import type { TranslatableText, TranslateOptions } from "../../app-config/common/TranslatableText.js";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
@@ -77,11 +77,12 @@ export interface DisplayNotificationArgs {
      */
     category?: NotificationCategory;
     /**
-     * The message to be displayed in the notification.
+     * The message to be displayed in the notification. Mobile only supports a
+     * string for this property.
      */
-    message: string;
+    message: TranslatableText;
     /**
-     * The position of the notification on the screen.
+     * The position of the notification on the screen. Web only.
      */
     position?: Position;
     /**