@vertigis/viewer-spec 58.21.1 → 58.22.0

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/package.json

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