@vertigis/viewer-spec 58.21.0 → 58.22.0

package/messaging/registry/Commands.d.ts

@@ -20,6 +20,7 @@ import { LicensingCommands } from "./licensing.js";
 import { LocationMarkerCommands } from "./location-marker.js";
 import { MapCommands } from "./map.js";
 import { MeasurementCommands } from "./measurement.js";
+import { NetworkCommands } from "./network.js";
 import { OfflineCommands } from "./offline.js";
 import { PanelCommands } from "./panel.js";
 import { PhotosCommands } from "./photos.js";
@@ -58,6 +59,7 @@ export declare class Commands extends CommandRegistry {
     readonly locationMarker: LocationMarkerCommands;
     readonly map: MapCommands;
     readonly measurement: MeasurementCommands;
+    readonly network: NetworkCommands;
     readonly offline: OfflineCommands;
     readonly panel: PanelCommands;
     readonly project: ProjectCommands;

package/messaging/registry/Commands.js

@@ -1 +1 @@
-import{CommandRegistry as s}from"../CommandRegistry.js";import{AppCommands as e}from"./app.js";import{AuthCommands as m}from"./auth.js";import{BasemapCommands as r}from"./basemap.js";import{ChartsCommands as i}from"./charts.js";import{DrawingCommands as t}from"./drawing.js";import{EditCommands as o}from"./edit.js";import{FileCommands as a}from"./file.js";import{FilterBuilderCommands as n}from"./filter-builder.js";import{GeolocationCommands as p}from"./geolocation.js";import{GeometryToolbarCommands as g}from"./geometry-toolbar.js";import{GeometryCommands as h}from"./geometry.js";import{HighlightsCommands as f}from"./highlights.js";import{IwtmCommands as w}from"./iwtm.js";import{KpiCommands as j}from"./kpi.js";import{LayerComparisonCommands as _}from"./layer-comparison.js";import{LayerPresetsCommands as l}from"./layer-presets.js";import{LayersCommands as c}from"./layers.js";import{LicensingCommands as y}from"./licensing.js";import{LocationMarkerCommands as u}from"./location-marker.js";import{MapCommands as d}from"./map.js";import{MeasurementCommands as k}from"./measurement.js";import{OfflineCommands as b}from"./offline.js";import{PanelCommands as x}from"./panel.js";import{PhotosCommands as C}from"./photos.js";import{PrintCommands as q}from"./printing.js";import{ProjectCommands as v}from"./project.js";import{QueryBuilderCommands as A}from"./query-builder.js";import{RegionCommands as B}from"./region.js";import{ReportsCommands as M}from"./reports.js";import{ResultsCommands as P}from"./results.js";import{SearchCommands as R}from"./search.js";import{SketchingCommands as T}from"./sketching.js";import{StudioAnalyticsCommands as z}from"./studioAnalytics.js";import{SystemCommands as D}from"./system.js";import{UICommands as E}from"./ui.js";import{ViewerCommands as F}from"./viewer.js";import{WorkflowCommands as G}from"./workflow.js";export class Commands extends s{app=new e(this._messages);auth=new m(this._messages);basemap=new r(this._messages);charts=new i(this._messages);drawing=new t(this._messages);edit=new o(this._messages);file=new a(this._messages);filterBuilder=new n(this._messages);geolocation=new p(this._messages);geometry=new h(this._messages);geometryToolbar=new g(this._messages);highlights=new f(this._messages);iwtm=new w(this._messages);kpi=new j(this._messages);layers=new c(this._messages);layerComparison=new _(this._messages);layerPresets=new l(this._messages);licensing=new y(this._messages);locationMarker=new u(this._messages);map=new d(this._messages);measurement=new k(this._messages);offline=new b(this._messages);panel=new x(this._messages);project=new v(this._messages);photos=new C(this._messages);printing=new q(this._messages);queryBuilder=new A(this._messages);region=new B(this._messages);reports=new M(this._messages);results=new P(this._messages);search=new R(this._messages);sketching=new T(this._messages);studioAnalytics=new z(this._messages);system=new D(this._messages);ui=new E(this._messages);viewer=new F(this._messages);workflow=new G(this._messages);_prefix=""}
+import{CommandRegistry as s}from"../CommandRegistry.js";import{AppCommands as e}from"./app.js";import{AuthCommands as m}from"./auth.js";import{BasemapCommands as r}from"./basemap.js";import{ChartsCommands as i}from"./charts.js";import{DrawingCommands as t}from"./drawing.js";import{EditCommands as o}from"./edit.js";import{FileCommands as a}from"./file.js";import{FilterBuilderCommands as n}from"./filter-builder.js";import{GeolocationCommands as p}from"./geolocation.js";import{GeometryToolbarCommands as g}from"./geometry-toolbar.js";import{GeometryCommands as h}from"./geometry.js";import{HighlightsCommands as f}from"./highlights.js";import{IwtmCommands as w}from"./iwtm.js";import{KpiCommands as j}from"./kpi.js";import{LayerComparisonCommands as _}from"./layer-comparison.js";import{LayerPresetsCommands as l}from"./layer-presets.js";import{LayersCommands as c}from"./layers.js";import{LicensingCommands as y}from"./licensing.js";import{LocationMarkerCommands as u}from"./location-marker.js";import{MapCommands as d}from"./map.js";import{MeasurementCommands as k}from"./measurement.js";import{NetworkCommands as b}from"./network.js";import{OfflineCommands as x}from"./offline.js";import{PanelCommands as C}from"./panel.js";import{PhotosCommands as q}from"./photos.js";import{PrintCommands as v}from"./printing.js";import{ProjectCommands as A}from"./project.js";import{QueryBuilderCommands as B}from"./query-builder.js";import{RegionCommands as M}from"./region.js";import{ReportsCommands as P}from"./reports.js";import{ResultsCommands as R}from"./results.js";import{SearchCommands as T}from"./search.js";import{SketchingCommands as z}from"./sketching.js";import{StudioAnalyticsCommands as D}from"./studioAnalytics.js";import{SystemCommands as E}from"./system.js";import{UICommands as F}from"./ui.js";import{ViewerCommands as G}from"./viewer.js";import{WorkflowCommands as H}from"./workflow.js";export class Commands extends s{app=new e(this._messages);auth=new m(this._messages);basemap=new r(this._messages);charts=new i(this._messages);drawing=new t(this._messages);edit=new o(this._messages);file=new a(this._messages);filterBuilder=new n(this._messages);geolocation=new p(this._messages);geometry=new h(this._messages);geometryToolbar=new g(this._messages);highlights=new f(this._messages);iwtm=new w(this._messages);kpi=new j(this._messages);layers=new c(this._messages);layerComparison=new _(this._messages);layerPresets=new l(this._messages);licensing=new y(this._messages);locationMarker=new u(this._messages);map=new d(this._messages);measurement=new k(this._messages);network=new b(this._messages);offline=new x(this._messages);panel=new C(this._messages);project=new A(this._messages);photos=new q(this._messages);printing=new v(this._messages);queryBuilder=new B(this._messages);region=new M(this._messages);reports=new P(this._messages);results=new R(this._messages);search=new T(this._messages);sketching=new z(this._messages);studioAnalytics=new D(this._messages);system=new E(this._messages);ui=new F(this._messages);viewer=new G(this._messages);workflow=new H(this._messages);_prefix=""}

package/messaging/registry/Events.d.ts

@@ -12,6 +12,7 @@ import { LayersEvents } from "./layers.js";
 import { LayoutEvents } from "./layout.js";
 import { LocationMarkerEvents } from "./location-marker.js";
 import { MapEvents } from "./map.js";
+import { NetworkEvents } from "./network.js";
 import { OfflineEvents } from "./offline.js";
 import { PanelEvents } from "./panel.js";
 import { PhotosEvents } from "./photos.js";
@@ -42,6 +43,7 @@ export declare class Events extends EventRegistry {
     readonly layout: LayoutEvents;
     readonly locationMarker: LocationMarkerEvents;
     readonly map: MapEvents;
+    readonly network: NetworkEvents;
     readonly offline: OfflineEvents;
     readonly panel: PanelEvents;
     readonly project: ProjectEvents;

package/messaging/registry/Events.js

@@ -1 +1 @@
-import{EventRegistry as s}from"../EventRegistry.js";import{AppConfigEvents as e}from"./app-config.js";import{AppEvents as o}from"./app.js";import{AuthEvents as t}from"./auth.js";import{BookmarkEvents as m}from"./bookmark.js";import{DeviceEvents as r}from"./device.js";import{DisplayEvents as i}from"./display.js";import{EditEvents as a}from"./edit.js";import{GeolocationEvents as p}from"./geolocation.js";import{InputEvents as n}from"./input.js";import{LayersEvents as g}from"./layers.js";import{LayoutEvents as f}from"./layout.js";import{LocationMarkerEvents as h}from"./location-marker.js";import{MapEvents as w}from"./map.js";import{OfflineEvents as j}from"./offline.js";import{PanelEvents as _}from"./panel.js";import{PhotosEvents as l}from"./photos.js";import{PortalEvents as c}from"./portal.js";import{PrintEvents as u}from"./printing.js";import{ProjectEvents as k}from"./project.js";import{RegionEvents as d}from"./region.js";import{ReportEvents as y}from"./reports.js";import{ResultsEvents as v}from"./results.js";import{SearchEvents as x}from"./search.js";import{SettingsEvents as b}from"./settings.js";import{ShortcutEvents as E}from"./shortcut.js";import{TasksEvents as C}from"./tasks.js";import{UIEvents as M}from"./ui.js";import{ViewerEvents as R}from"./viewer.js";import{WorkflowEvents as q}from"./workflow.js";export class Events extends s{app=new o(this._messages);appConfig=new e(this._messages);auth=new t(this._messages);bookmark=new m(this._messages);device=new r(this._messages);display=new i(this._messages);edit=new a(this._messages);geolocation=new p(this._messages);input=new n(this._messages);layers=new g(this._messages);layout=new f(this._messages);locationMarker=new h(this._messages);map=new w(this._messages);offline=new j(this._messages);panel=new _(this._messages);project=new k(this._messages);photos=new l(this._messages);portal=new c(this._messages);printing=new u(this._messages);region=new d(this._messages);reports=new y(this._messages);results=new v(this._messages);search=new x(this._messages);settings=new b(this._messages);shortcuts=new E(this._messages);tasks=new C(this._messages);ui=new M(this._messages);viewer=new R(this._messages);workflow=new q(this._messages);_prefix=""}
+import{EventRegistry as s}from"../EventRegistry.js";import{AppConfigEvents as e}from"./app-config.js";import{AppEvents as o}from"./app.js";import{AuthEvents as t}from"./auth.js";import{BookmarkEvents as m}from"./bookmark.js";import{DeviceEvents as r}from"./device.js";import{DisplayEvents as i}from"./display.js";import{EditEvents as a}from"./edit.js";import{GeolocationEvents as p}from"./geolocation.js";import{InputEvents as n}from"./input.js";import{LayersEvents as g}from"./layers.js";import{LayoutEvents as f}from"./layout.js";import{LocationMarkerEvents as h}from"./location-marker.js";import{MapEvents as w}from"./map.js";import{NetworkEvents as j}from"./network.js";import{OfflineEvents as _}from"./offline.js";import{PanelEvents as l}from"./panel.js";import{PhotosEvents as c}from"./photos.js";import{PortalEvents as k}from"./portal.js";import{PrintEvents as u}from"./printing.js";import{ProjectEvents as d}from"./project.js";import{RegionEvents as y}from"./region.js";import{ReportEvents as v}from"./reports.js";import{ResultsEvents as x}from"./results.js";import{SearchEvents as b}from"./search.js";import{SettingsEvents as E}from"./settings.js";import{ShortcutEvents as C}from"./shortcut.js";import{TasksEvents as M}from"./tasks.js";import{UIEvents as R}from"./ui.js";import{ViewerEvents as q}from"./viewer.js";import{WorkflowEvents as z}from"./workflow.js";export class Events extends s{app=new o(this._messages);appConfig=new e(this._messages);auth=new t(this._messages);bookmark=new m(this._messages);device=new r(this._messages);display=new i(this._messages);edit=new a(this._messages);geolocation=new p(this._messages);input=new n(this._messages);layers=new g(this._messages);layout=new f(this._messages);locationMarker=new h(this._messages);map=new w(this._messages);network=new j(this._messages);offline=new _(this._messages);panel=new l(this._messages);project=new d(this._messages);photos=new c(this._messages);portal=new k(this._messages);printing=new u(this._messages);region=new y(this._messages);reports=new v(this._messages);results=new x(this._messages);search=new b(this._messages);settings=new E(this._messages);shortcuts=new C(this._messages);tasks=new M(this._messages);ui=new R(this._messages);viewer=new q(this._messages);workflow=new z(this._messages);_prefix=""}

package/messaging/registry/network.d.ts

@@ -1,4 +1,5 @@
 import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
@@ -12,39 +13,42 @@ export interface HostAndPortArgs {
     /** The port number to connect to. Must be an integer. */
     port: number;
 }
-export declare class NetworkEvents extends EventRegistry {
+export declare class NetworkCommands extends CommandRegistry {
     protected readonly _prefix = "network";
     /**
-     * Raised when the user has blocked the app from making web requests. Mobile
-     * only.
+     * Turns on Disconnected Mode which prevents the app from making web
+     * requests independent of the device's network connectivity.
      *
      * @mobileOnly
      */
-    get webRequestsDisabled(): Event;
+    get disableWebRequests(): Command<void>;
     /**
-     * Raised when the user has allowed the app to make web requests. Mobile
-     * only.
+     * Turns off Disconnected Mode allowing the device to make web requests if
+     * it has a network connection.
      *
      * @mobileOnly
      */
-    get webRequestsEnabled(): Event;
+    get enableWebRequests(): Command<void>;
 }
-export declare class NetworkOperations extends OperationRegistry {
+export declare class NetworkEvents extends EventRegistry {
     protected readonly _prefix = "network";
     /**
-     * Turns on Disconnected Mode which prevents the app from making web
-     * requests independent of the device's network connectivity.
+     * Raised when the user has blocked the app from making web requests. Mobile
+     * only.
      *
      * @mobileOnly
      */
-    get disableWebRequests(): Command<void>;
+    get webRequestsDisabled(): Event;
     /**
-     * Turns off Disconnected Mode allowing the device to make web requests if
-     * it has a network connection.
+     * Raised when the user has allowed the app to make web requests. Mobile
+     * only.
      *
      * @mobileOnly
      */
-    get enableWebRequests(): Command<void>;
+    get webRequestsEnabled(): Event;
+}
+export declare class NetworkOperations extends OperationRegistry {
+    protected readonly _prefix = "network";
     /**
      * Determines if Disconnected Mode is enabled and web requests can be sent
      * by the app.

package/messaging/registry/network.js

@@ -1 +1 @@
-import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class NetworkEvents extends e{_prefix="network";get webRequestsDisabled(){return this._get("web-requests-disabled")}get webRequestsEnabled(){return this._get("web-requests-enabled")}}export class NetworkOperations extends t{_prefix="network";get disableWebRequests(){return this._get("disable-web-requests")}get enableWebRequests(){return this._get("enable-web-requests")}get areWebRequestsDisabled(){return this._get("are-web-requests-disabled")}get hasConnection(){return this._get("has-connection")}get getStatus(){return this._get("get-status")}get canReachHost(){return this._get("can-reach-host")}get canReachUrl(){return this._get("can-reach-url")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class NetworkCommands extends e{_prefix="network";get disableWebRequests(){return this._get("disable-web-requests")}get enableWebRequests(){return this._get("enable-web-requests")}}export class NetworkEvents extends t{_prefix="network";get webRequestsDisabled(){return this._get("web-requests-disabled")}get webRequestsEnabled(){return this._get("web-requests-enabled")}}export class NetworkOperations extends s{_prefix="network";get areWebRequestsDisabled(){return this._get("are-web-requests-disabled")}get hasConnection(){return this._get("has-connection")}get getStatus(){return this._get("get-status")}get canReachHost(){return this._get("can-reach-host")}get canReachUrl(){return this._get("can-reach-url")}}

package/messaging/registry/tracing.d.ts

@@ -0,0 +1,15 @@
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { TraceCompletedArgs } from "./utility-network.js";
+/**
+ * Events relating to utility network tracing.
+ */
+export declare class TracingEvents extends EventRegistry {
+    protected readonly _prefix = "tracing";
+    /**
+     * Raised when a utility network trace is succesfully completed.
+     *
+     * @mobileOnly
+     */
+    get completed(): Event<TraceCompletedArgs>;
+}

package/messaging/registry/tracing.js

@@ -0,0 +1 @@
+import{EventRegistry as e}from"../EventRegistry.js";export class TracingEvents extends e{_prefix="tracing";get completed(){return this._get("trace-completed")}}

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

@@ -0,0 +1,99 @@
+/// <reference types="esri-runtime-sdk" />
+import type UtilityElement from "esri-runtime-sdk/UtilityElement";
+import type UtilityNamedTraceConfiguration from "esri-runtime-sdk/UtilityNamedTraceConfiguration";
+import type UtilityNetwork from "esri-runtime-sdk/UtilityNetwork";
+import type UtilityTraceResult from "esri-runtime-sdk/UtilityTraceResult";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { HasMaps, MapsFeatureResultArgs, HasMapsAndFeatures } from "../common.js";
+/**
+ * Arguments relating to a utility network.
+ */
+export interface HasUtilityNetwork {
+    /**
+     * The utility network involved in the operation.
+     */
+    utilityNetwork: UtilityNetwork;
+}
+/**
+ * Results from a completed trace.
+ */
+export interface TraceCompletedArgs extends MapsFeatureResultArgs, HasUtilityNetwork {
+    /**
+     * Results from the trace.
+     */
+    traceResults: UtilityTraceResult[];
+    /**
+     * The configuration that was used to get these results.
+     */
+    traceConfiguration: UtilityNamedTraceConfiguration;
+}
+/**
+ * Arguments for the runTrace operation.
+ */
+export interface NetworkTraceArgs extends UtilityNetworkArgs {
+    /**
+     * The start point(s) to use for the trace.
+     */
+    startPoints: UtilityElement[];
+    /**
+     * The barriers to use for the trace (optional).
+     */
+    barriers?: UtilityElement[];
+    /**
+     * The configuration to use for the trace.
+     */
+    traceConfiguration: UtilityNamedTraceConfiguration;
+}
+/**
+ * Arguments for the getUtilityElementsFromFeatures operation.
+ */
+export interface GetUtilityElementsArgs extends HasUtilityNetwork, HasMapsAndFeatures {
+}
+/**
+ * Arguments relating to a utility network.
+ */
+export interface UtilityNetworkArgs extends HasUtilityNetwork, HasMaps {
+}
+/**
+ * Commands relating to utility networks.
+ */
+export declare class UtilityNetworkCommands extends CommandRegistry {
+    protected readonly _prefix = "utility-network";
+    /**
+     * Displays the UI panel to perform a named trace. Mobile only. Only
+     * available to VertiGIS Networks customers.
+     *
+     * @mobileOnly
+     */
+    get showTracePanel(): Command;
+}
+/**
+ * Operations relating to utility networks.
+ */
+export declare class UtilityNetworkOperations extends OperationRegistry {
+    protected readonly _prefix = "utility-network";
+    /**
+     * Runs a trace on a utility network. Mobile only. Only available to
+     * VertiGIS Networks customers.
+     *
+     * @mobileOnly
+     */
+    get runTrace(): Operation<NetworkTraceArgs, TraceCompletedArgs>;
+    /**
+     * Gets a list of UtilityElements from a list of Features. Mobile only. Only
+     * available to VertiGIS Networks customers.
+     *
+     * @mobileOnly
+     */
+    get getUtilityElementsFromFeatures(): Operation<GetUtilityElementsArgs, UtilityElement[]>;
+    /**
+     * Returns a list of available named traces from the specified network.
+     * Mobile only. Only available to VertiGIS Networks customers.
+     *
+     * @mobileOnly
+     */
+    get getNamedTraces(): Operation<UtilityNetworkArgs, UtilityNamedTraceConfiguration[]>;
+}

package/messaging/registry/utility-network.js

@@ -0,0 +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")}}

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

@@ -15687,6 +15687,18 @@
         "network.can-reach-url:output": {
             "type": "boolean"
         },
+        "network.disable-web-requests": {
+            "description": "Turns on Disconnected Mode which prevents the app from making web requests independent of the device's network connectivity.",
+            "enum": [
+                "network.disable-web-requests"
+            ]
+        },
+        "network.enable-web-requests": {
+            "description": "Turns off Disconnected Mode allowing the device to make web requests if it has a network connection.",
+            "enum": [
+                "network.enable-web-requests"
+            ]
+        },
         "network.get-status": {
             "description": "Returns the network status. Mobile only.",
             "enum": [
@@ -18795,6 +18807,12 @@
                 {
                     "$ref": "#/definitions/measurement.stop"
                 },
+                {
+                    "$ref": "#/definitions/network.disable-web-requests"
+                },
+                {
+                    "$ref": "#/definitions/network.enable-web-requests"
+                },
                 {
                     "$ref": "#/definitions/offline.cancel-create-area"
                 },

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

@@ -11697,6 +11697,18 @@
         "map.viewpoint-changed:input": {
             "$ref": "MapEvent"
         },
+        "network.web-requests-disabled": {
+            "description": "Raised when the user has blocked the app from making web requests. Mobile only.",
+            "enum": [
+                "network.web-requests-disabled"
+            ]
+        },
+        "network.web-requests-enabled": {
+            "description": "Raised when the user has allowed the app to make web requests. Mobile only.",
+            "enum": [
+                "network.web-requests-enabled"
+            ]
+        },
         "offline.area-activated": {
             "description": "Raised when an offline area is activated. Mobile only.",
             "enum": [
@@ -12269,6 +12281,12 @@
                 {
                     "$ref": "#/definitions/map.viewpoint-changed"
                 },
+                {
+                    "$ref": "#/definitions/network.web-requests-disabled"
+                },
+                {
+                    "$ref": "#/definitions/network.web-requests-enabled"
+                },
                 {
                     "$ref": "#/definitions/offline.area-activated"
                 },

package/package.json

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

package/version.js

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