@vertigis/viewer-spec 58.24.1 → 59.0.0

package/messaging/registry/licensing.d.ts

@@ -5,6 +5,9 @@ import { OperationRegistry } from "../OperationRegistry.js";
 export declare class LicenseRequestArgs {
     /**
      * The human readable application name, used for any licensing related ui.
+     * Web only.
+     *
+     * @webOnly
      */
     applicationName?: string;
     /**
@@ -30,9 +33,7 @@ export declare class LicensingOperations extends OperationRegistry {
     protected readonly _prefix = "licensing";
     /**
      * Retrieve the license state for the specified account and SKU. Defaults to
-     * returning Web current state. Web only.
-     *
-     * @webOnly
+     * returning the current state.
      */
     get getLicenseState(): Operation<LicenseRequestArgs, string>;
 }

package/messaging/registry/network.d.ts

@@ -4,13 +4,21 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-/** The status of a connection to a network host. */
+/**
+ * The status of a connection to a network host.
+ */
 export type NetworkStatus = "NoConnection" | "ConnectedToCarrierDataNetwork" | "ConnectedToWiFiOrEthernet" | "Restricted";
-/** Arguments for the network.can-reach-host operation. */
+/**
+ * Arguments for the network.can-reach-host operation.
+ */
 export interface HostAndPortArgs {
-    /** The host to connect to. */
+    /**
+     * The host to connect to.
+     */
     host: string;
-    /** The port number to connect to. Must be an integer. */
+    /**
+     * The port number to connect to. Must be an integer.
+     */
     port: number;
 }
 export declare class NetworkCommands extends CommandRegistry {

package/messaging/registry/utility-network.d.ts

@@ -20,7 +20,7 @@ export interface HasUtilityNetwork {
 /**
  * Results from a completed trace.
  */
-export interface TraceCompletedArgs extends MapsFeatureResultArgs, HasUtilityNetwork {
+export interface TraceCompletedArgs extends UtilityNetworkArgs {
     /**
      * Results from the trace.
      */
@@ -89,6 +89,13 @@ export declare class UtilityNetworkOperations extends OperationRegistry {
      * @mobileOnly
      */
     get getUtilityElementsFromFeatures(): Operation<GetUtilityElementsArgs, UtilityElement[]>;
+    /**
+     * Gets feature results args from trace results, to display in the results
+     * list for example.
+     *
+     * @mobileOnly
+     */
+    get featureResultsFromTrace(): Operation<TraceCompletedArgs, MapsFeatureResultArgs>;
     /**
      * Returns a list of available named traces from the specified network.
      * Mobile only. Only available to VertiGIS Networks customers.

package/messaging/registry/utility-network.js

@@ -1 +1 @@
-import{CommandRegistry as t}from"../CommandRegistry.js";import{OperationRegistry as e}from"../OperationRegistry.js";export class UtilityNetworkCommands extends t{_prefix="utility-network";get showTracePanel(){return this._get("show-network-trace-panel")}}export class UtilityNetworkOperations extends e{_prefix="utility-network";get runTrace(){return this._get("run-trace")}get getUtilityElementsFromFeatures(){return this._get("get-elements-from-features")}get getNamedTraces(){return this._get("get-trace-configurations")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class UtilityNetworkCommands extends e{_prefix="utility-network";get showTracePanel(){return this._get("show-network-trace-panel")}}export class UtilityNetworkOperations extends t{_prefix="utility-network";get runTrace(){return this._get("run-trace")}get getUtilityElementsFromFeatures(){return this._get("get-elements-from-features")}get featureResultsFromTrace(){return this._get("feature-results-from-trace")}get getNamedTraces(){return this._get("get-trace-configurations")}}

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

@@ -2838,6 +2838,24 @@
             ],
             "type": "string"
         },
+        "LicenseRequestArgs": {
+            "additionalProperties": false,
+            "properties": {
+                "accountId": {
+                    "description": "The accountId (orgId) that we want to check licensing.",
+                    "type": "string"
+                },
+                "applicationName": {
+                    "description": "The human readable application name, used for any licensing related ui. Web only.",
+                    "type": "string"
+                },
+                "sku": {
+                    "description": "Overwrite the SKU for license check.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "MapRotateArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"map.rotate-by\" and \"map.rotate-to\" commands.",
@@ -14096,6 +14114,18 @@
         "highlights.remove:input": {
             "$ref": "#/definitions/Features"
         },
+        "licensing.get-license-state": {
+            "description": "Retrieve the license state for the specified account and SKU. Defaults to returning the current state.",
+            "enum": [
+                "licensing.get-license-state"
+            ]
+        },
+        "licensing.get-license-state:input": {
+            "$ref": "#/definitions/LicenseRequestArgs"
+        },
+        "licensing.get-license-state:output": {
+            "type": "string"
+        },
         "map.add-markup": {
             "description": "Adds markup to the map(s).\n\n**Example:** Adding markup to a custom collection using `AddMarkupArgs`.\n\n```\n{\n    \"collection\": \"my-custom-markup\",\n    \"graphics\": [\n        {\n            \"geometry\": {\n                \"x\": -13733416.69,\n                \"y\": 6177670.86,\n                \"spatialReference\": {\n                    \"wkid\": 3857\n                },\n                \"type\": \"point\"\n            },\n            \"symbol\": {\n                \"color\": [76, 115, 0, 255],\n                \"size\": 16,\n                \"style\": \"esriSMSCircle\",\n                \"type\": \"simple-marker\"\n            }\n        }\n    ]\n}\n```",
             "enum": [
@@ -15985,6 +16015,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/licensing.get-license-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/licensing.get-license-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -16213,6 +16259,9 @@
                 {
                     "$ref": "#/definitions/geolocation.get-position"
                 },
+                {
+                    "$ref": "#/definitions/licensing.get-license-state"
+                },
                 {
                     "$ref": "#/definitions/map.get-spatial-reference"
                 },

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

@@ -3374,6 +3374,24 @@
             ],
             "type": "string"
         },
+        "LicenseRequestArgs": {
+            "additionalProperties": false,
+            "properties": {
+                "accountId": {
+                    "description": "The accountId (orgId) that we want to check licensing.",
+                    "type": "string"
+                },
+                "applicationName": {
+                    "description": "The human readable application name, used for any licensing related ui. Web only.",
+                    "type": "string"
+                },
+                "sku": {
+                    "description": "Overwrite the SKU for license check.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "MapsLike": {
             "anyOf": [
                 {
@@ -15503,6 +15521,18 @@
         "layer-presets.apply:input": {
             "$ref": "#/definitions/LayerPresetsArgs"
         },
+        "licensing.get-license-state": {
+            "description": "Retrieve the license state for the specified account and SKU. Defaults to returning the current state.",
+            "enum": [
+                "licensing.get-license-state"
+            ]
+        },
+        "licensing.get-license-state:input": {
+            "$ref": "#/definitions/LicenseRequestArgs"
+        },
+        "licensing.get-license-state:output": {
+            "type": "string"
+        },
         "log-viewer.close": {
             "description": "Closes the Log Viewer. Mobile only.",
             "enum": [
@@ -19630,6 +19660,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/licensing.get-license-state:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/licensing.get-license-state"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -20224,6 +20270,9 @@
                 {
                     "$ref": "#/definitions/geometry.remove-point"
                 },
+                {
+                    "$ref": "#/definitions/licensing.get-license-state"
+                },
                 {
                     "$ref": "#/definitions/map.export-image"
                 },

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

@@ -5387,7 +5387,7 @@
                     "type": "string"
                 },
                 "applicationName": {
-                    "description": "The human readable application name, used for any licensing related ui.",
+                    "description": "The human readable application name, used for any licensing related ui. Web only.",
                     "type": "string"
                 },
                 "sku": {
@@ -20289,7 +20289,7 @@
             "$ref": "#/definitions/SetLabelVisibilityArgs"
         },
         "licensing.get-license-state": {
-            "description": "Retrieve the license state for the specified account and SKU. Defaults to returning Web current state. Web only.",
+            "description": "Retrieve the license state for the specified account and SKU. Defaults to returning the current state.",
             "enum": [
                 "licensing.get-license-state"
             ]

package/package.json

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

package/version.js

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