@vertigis/viewer-spec 46.1.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

@@ -82,7 +82,7 @@ export interface DisplayNotificationArgs {
      */
     message: TranslatableText;
     /**
-     * The position of the notification on the screen.
+     * The position of the notification on the screen. Web only.
      */
     position?: Position;
     /**

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

@@ -822,7 +822,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.",
@@ -1579,6 +1579,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"
+        },
         "Results": {
             "additionalProperties": false,
             "description": "Feature results from an operation.",
@@ -2106,6 +2127,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"
+        },
         "ZoomToViewpointArgs": {
             "additionalProperties": false,
             "description": "Arguments for the map.zoom-to-viewpoint command.",
@@ -11665,6 +11720,25 @@
         "sketching.undo:input": {
             "$ref": "#/definitions/HasMaps"
         },
+        "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"
+                }
+            ]
+        },
         "tasks.identify": {
             "description": "Returns features that intersect a given geometry.",
             "enum": [
@@ -12457,6 +12531,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": {
@@ -12688,6 +12778,9 @@
                 {
                     "$ref": "#/definitions/sketching.undo"
                 },
+                {
+                    "$ref": "#/definitions/system.open-url"
+                },
                 {
                     "$ref": "#/definitions/ui.activate"
                 },

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

@@ -1051,7 +1051,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.",
@@ -2223,7 +2223,7 @@
                     "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.",
+                    "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": {
@@ -3006,6 +3006,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"
+        },
         "ZoomToViewpointArgs": {
             "additionalProperties": false,
             "description": "Arguments for the map.zoom-to-viewpoint command.",
@@ -13578,13 +13612,16 @@
             "type": "boolean"
         },
         "system.open-url": {
-            "description": "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. 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.",
+            "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"
                 },

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

@@ -1484,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.",
@@ -3591,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": [
@@ -5303,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.",
@@ -17509,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": [
@@ -19577,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": {
@@ -20145,6 +20235,9 @@
                 {
                     "$ref": "#/definitions/system.download-file"
                 },
+                {
+                    "$ref": "#/definitions/system.open-url"
+                },
                 {
                     "$ref": "#/definitions/ui.activate"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "46.1.0",
+  "version": "46.2.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -34,7 +34,7 @@
   },
   "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",

package/version.d.ts

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

package/version.js

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