@vertigis/viewer-spec 43.6.0 → 45.2.0

package/messaging/Operation.d.ts

@@ -1,4 +1,5 @@
 import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { Event } from "./Event.js";
 import type { Message, MessageExecuteOptions } from "./Message.js";
 /**
  * A named operation. Operations compute a value, but don't generally alter the
@@ -9,6 +10,15 @@ export interface Operation<T = void, TResult = undefined> extends Message {
      * The name of the operation.
      */
     name: string;
+    /**
+     * An event that is published whenever canExecute might return a new value.
+     * Implementations are responsible for calling publish() as appropriate.
+     */
+    readonly canExecuteChanged: Event;
+    /**
+     * Indicates whether the operation has been initialized.
+     */
+    readonly isInitialized: boolean;
     /**
      * Executes the operation and returns its result.
      *
@@ -17,6 +27,18 @@ export interface Operation<T = void, TResult = undefined> extends Message {
      * behavior.
      */
     execute: (argument: T, options?: CancelToken | MessageExecuteOptions) => Promise<TResult>;
+    /**
+     * Determines whether the operation can execute with the given arguments.
+     *
+     * @param argument The operation arguments.
+     */
+    canExecute(argument?: T): boolean;
+    /**
+     * Initializes the operation if it is not already initialized. Attempting to
+     * execute an operation will automatically initialize it, however calling
+     * canExecute() will always return false until the operation is initialized.
+     */
+    initialize(): Promise<void>;
 }
 /**
  * Context that will be passed in to each behavior for an operation.

package/messaging/registry/Operations.d.ts

@@ -1,5 +1,6 @@
 import { OperationRegistry } from "../OperationRegistry.js";
 import { AppOperations } from "./app.js";
+import { ArcadeOperations } from "./arcade.js";
 import { AuthOperations } from "./auth.js";
 import { BasemapOperations } from "./basemap.js";
 import { ChartOperations } from "./charts.js";
@@ -24,6 +25,7 @@ import { TasksOperations } from "./tasks.js";
 import { UIOperations } from "./ui.js";
 import { ViewerOperations } from "./viewer.js";
 export declare class Operations extends OperationRegistry {
+    readonly arcade: ArcadeOperations;
     readonly auth: AuthOperations;
     readonly app: AppOperations;
     readonly basemap: BasemapOperations;

package/messaging/registry/Operations.js

@@ -1 +1 @@
-import{OperationRegistry}from"../OperationRegistry.js";import{AppOperations}from"./app.js";import{AuthOperations}from"./auth.js";import{BasemapOperations}from"./basemap.js";import{ChartOperations}from"./charts.js";import{DebugConsoleOperations}from"./debugConsole.js";import{DrawingOperations}from"./drawing.js";import{FileOperations}from"./file.js";import{GeocodeOperations}from"./geocode.js";import{GeolocationOperations}from"./geolocation.js";import{GeometryOperations}from"./geometry.js";import{HighlightsOperations}from"./highlights.js";import{KpiOperations}from"./kpi.js";import{LogViewerOperations}from"./logViewer.js";import{MapOperations}from"./map.js";import{MeasurementOperations}from"./measurement.js";import{MessagingOperations}from"./messaging.js";import{NetworkOperations}from"./network.js";import{OfflineOperations}from"./offline.js";import{ResultsOperations}from"./results.js";import{SketchingOperations}from"./sketching.js";import{SystemOperations}from"./system.js";import{TasksOperations}from"./tasks.js";import{UIOperations}from"./ui.js";import{ViewerOperations}from"./viewer.js";export class Operations extends OperationRegistry{constructor(){super(...arguments),this.auth=new AuthOperations(this._messages),this.app=new AppOperations(this._messages),this.basemap=new BasemapOperations(this._messages),this.charts=new ChartOperations(this._messages),this.drawing=new DrawingOperations(this._messages),this.file=new FileOperations(this._messages),this.geocode=new GeocodeOperations(this._messages),this.geolocation=new GeolocationOperations(this._messages),this.geometry=new GeometryOperations(this._messages),this.highlights=new HighlightsOperations(this._messages),this.kpi=new KpiOperations(this._messages),this.logViewer=new LogViewerOperations(this._messages),this.map=new MapOperations(this._messages),this.measurement=new MeasurementOperations(this._messages),this.messaging=new MessagingOperations(this._messages),this.network=new NetworkOperations(this._messages),this.offline=new OfflineOperations(this._messages),this.sketching=new SketchingOperations(this._messages),this.system=new SystemOperations(this._messages),this.results=new ResultsOperations(this._messages),this.tasks=new TasksOperations(this._messages),this.ui=new UIOperations(this._messages),this.viewer=new ViewerOperations(this._messages),this.debugConsole=new DebugConsoleOperations(this._messages)}}
+import{OperationRegistry}from"../OperationRegistry.js";import{AppOperations}from"./app.js";import{ArcadeOperations}from"./arcade.js";import{AuthOperations}from"./auth.js";import{BasemapOperations}from"./basemap.js";import{ChartOperations}from"./charts.js";import{DebugConsoleOperations}from"./debugConsole.js";import{DrawingOperations}from"./drawing.js";import{FileOperations}from"./file.js";import{GeocodeOperations}from"./geocode.js";import{GeolocationOperations}from"./geolocation.js";import{GeometryOperations}from"./geometry.js";import{HighlightsOperations}from"./highlights.js";import{KpiOperations}from"./kpi.js";import{LogViewerOperations}from"./logViewer.js";import{MapOperations}from"./map.js";import{MeasurementOperations}from"./measurement.js";import{MessagingOperations}from"./messaging.js";import{NetworkOperations}from"./network.js";import{OfflineOperations}from"./offline.js";import{ResultsOperations}from"./results.js";import{SketchingOperations}from"./sketching.js";import{SystemOperations}from"./system.js";import{TasksOperations}from"./tasks.js";import{UIOperations}from"./ui.js";import{ViewerOperations}from"./viewer.js";export class Operations extends OperationRegistry{constructor(){super(...arguments),this.arcade=new ArcadeOperations(this._messages),this.auth=new AuthOperations(this._messages),this.app=new AppOperations(this._messages),this.basemap=new BasemapOperations(this._messages),this.charts=new ChartOperations(this._messages),this.drawing=new DrawingOperations(this._messages),this.file=new FileOperations(this._messages),this.geocode=new GeocodeOperations(this._messages),this.geolocation=new GeolocationOperations(this._messages),this.geometry=new GeometryOperations(this._messages),this.highlights=new HighlightsOperations(this._messages),this.kpi=new KpiOperations(this._messages),this.logViewer=new LogViewerOperations(this._messages),this.map=new MapOperations(this._messages),this.measurement=new MeasurementOperations(this._messages),this.messaging=new MessagingOperations(this._messages),this.network=new NetworkOperations(this._messages),this.offline=new OfflineOperations(this._messages),this.sketching=new SketchingOperations(this._messages),this.system=new SystemOperations(this._messages),this.results=new ResultsOperations(this._messages),this.tasks=new TasksOperations(this._messages),this.ui=new UIOperations(this._messages),this.viewer=new ViewerOperations(this._messages),this.debugConsole=new DebugConsoleOperations(this._messages)}}

package/messaging/registry/arcade.d.ts

@@ -0,0 +1,100 @@
+import type { ItemRef } from "app-config/common/ItemRef.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Model } from "../common.js";
+/**
+ * The arguments for the arcade.run operation.
+ */
+export interface RunArcadeArgs {
+    /**
+     * The stringified Arcade script to run. If this property is included, the
+     * operation will return the result of the script.
+     */
+    executeScript?: string;
+    /**
+     * The stringified Arcade script used to determine whether or not the
+     * executeScript can/should be run. If no executeScript is provided and the
+     * canExecuteScript returns a truthy value, the operation will return its
+     * input arguments; otherwise, if the canEecuteScript returns a falsey
+     * value, it will throw a {@link Cancellation}.
+     */
+    canExecuteScript?: string;
+    /**
+     * An arguments object that provides named variables and associated values,
+     * which can be referenced from within the executeScript and
+     * canExecuteScript.
+     *
+     * NOTE: All variable keys must consist of only lowercase letters;
+     * camel-cased context variables will break the script when they are
+     * referenced at runtime.
+     */
+    arguments?: Record<string, unknown | ItemPropertyPath>;
+    /**
+     * Properties used to set a series of watch handles and/or event listeners
+     * on an item that will trigger the canExecuteChanged event for the
+     * 'arcade.run' operation.
+     */
+    watchHandles?: WatchEventHandleProperties[];
+}
+/**
+ * An object containing a propertyPath that used to retrieve a property value
+ * from the given item.
+ */
+export interface ItemPropertyPath {
+    /**
+     * The item from which to access a property value.
+     */
+    item: ItemRef | Model;
+    /**
+     * The path to a property on an item.
+     */
+    propertyPath: string;
+}
+export declare class ArcadeOperations extends OperationRegistry {
+    /**
+     * Runs a stringified Arcade script. If only a string is passed in as an
+     * argument, it is interpreted as an executeScript. If an executeSript is
+     * provided, the operation will return its result. If only a canExecute
+     * script is provided and it returns a truthy result, the operation will
+     * return its input arguments. If a canExecuteScript returns a falsey value,
+     * the operation will throw a {@link Cancellation}.
+     *
+     * @webOnly
+     *
+     */
+    get run(): Operation<RunArcadeArgs | string, unknown>;
+}
+/**
+ * Properties used to set a series of watch handles and/or event listeners on
+ * an item.
+ */
+export interface WatchEventHandleProperties {
+    /**
+     * The item whose properties will be watched for changes and/or events.
+     */
+    item: ItemRef | Model;
+    /**
+     * One or more properties on the item that will be watched for changes
+     * and/or events. Any strings will be used as propertyPaths that will be
+     * watched for changes; for this to work, the item and all properties
+     * referenced within the path (except for the last) must implement
+     * {@link Observable}.
+     */
+    watch: string | WatchEventProperty | (string | WatchEventProperty)[];
+}
+/**
+ * Properties on an item to watch, with an optional event name to listen for.
+ */
+export interface WatchEventProperty {
+    /**
+     * The path used to target a property on an item that will be watched for
+     * events. The watched property must implement {@link Evented}; this will
+     * effectively do `item[propertyPath].on(eventName)`.
+     */
+    propertyPath?: string;
+    /**
+     * The name of the event to listen for. If no propertyPath is included, the
+     * listener will go directly on the watched item.
+     */
+    eventName: string;
+}

package/messaging/registry/arcade.js

@@ -0,0 +1 @@
+import{OperationRegistry}from"../OperationRegistry.js";export class ArcadeOperations extends OperationRegistry{get run(){return this._messages.operation("arcade.run")}}

package/messaging/registry/geometry.d.ts

@@ -245,6 +245,13 @@ export declare class GeometryOperations extends OperationRegistry {
     get removePoint(): Operation<RemovePointArgs, Geometry>;
 }
 export declare class GeometryCommands extends CommandRegistry {
+    /**
+     * Display the geometry settings dialog. This allows you to configure buffer
+     * distance and buffer units.
+     *
+     * @webOnly
+     */
+    get displaySettings(): Command<HasUITarget>;
     /**
      * Sets the default buffer distance for the viewer session. The buffer
      * distance must be a number > 0.
@@ -258,11 +265,4 @@ export declare class GeometryCommands extends CommandRegistry {
      * @webOnly
      */
     get setBufferUnits(): Command<LengthUnits>;
-    /**
-     * Show the geometry settings dialog. This allows you to configure buffer
-     * distance and buffer units.
-     *
-     * @webOnly
-     */
-    get showSettings(): Command<HasUITarget>;
 }

package/messaging/registry/geometry.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class GeometryOperations extends OperationRegistry{get project(){return this._messages.operation("geometry.project")}get addPixelTolerance(){return this._messages.operation("geometry.add-pixel-tolerance")}get buffer(){return this._messages.operation("geometry.buffer")}get getBufferDistance(){return this._messages.operation("geometry.get-buffer-distance")}get getBufferUnits(){return this._messages.operation("geometry.get-buffer-units")}get addPoint(){return this._messages.operation("geometry.add-point")}get addPart(){return this._messages.operation("geometry.add-part")}get calculatePoint(){return this._messages.operation("geometry.calculate-point")}get removePoint(){return this._messages.operation("geometry.remove-point")}}export class GeometryCommands extends CommandRegistry{get setBufferDistance(){return this._messages.command("geometry.set-buffer-distance")}get setBufferUnits(){return this._messages.command("geometry.set-buffer-units")}get showSettings(){return this._messages.command("geometry.show-settings")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class GeometryOperations extends OperationRegistry{get project(){return this._messages.operation("geometry.project")}get addPixelTolerance(){return this._messages.operation("geometry.add-pixel-tolerance")}get buffer(){return this._messages.operation("geometry.buffer")}get getBufferDistance(){return this._messages.operation("geometry.get-buffer-distance")}get getBufferUnits(){return this._messages.operation("geometry.get-buffer-units")}get addPoint(){return this._messages.operation("geometry.add-point")}get addPart(){return this._messages.operation("geometry.add-part")}get calculatePoint(){return this._messages.operation("geometry.calculate-point")}get removePoint(){return this._messages.operation("geometry.remove-point")}}export class GeometryCommands extends CommandRegistry{get displaySettings(){return this._messages.command("geometry.display-settings")}get setBufferDistance(){return this._messages.command("geometry.set-buffer-distance")}get setBufferUnits(){return this._messages.command("geometry.set-buffer-units")}}

package/messaging/registry/map.d.ts

@@ -564,6 +564,11 @@ export interface StartSketchArgs {
      * The settings to be applied to the geometry editor.
      */
     editorSettings: GeometryEditorSettings;
+    /**
+     * The maximum number of segments permitted for a polyline or polygon
+     * sketch. Default is no limit. Mobile only.
+     */
+    maxSegments?: number;
 }
 /**
  * Result of the "map.get-coordinate-transformation" operation.

package/messaging/registry/measurement.d.ts

@@ -38,6 +38,13 @@ export interface GeometryModeArgs extends MapExtensionArgs {
 export interface CreateMeasurementGraphicsResult extends CreateGraphicsResult {
 }
 export declare class MeasurementCommands extends CommandRegistry {
+    /**
+     * Display the measurements settings dialog. This allows you to configure
+     * measurements system, area and length units.
+     *
+     * @webOnly
+     */
+    get displaySettings(): Command<HasUITarget>;
     /**
      * Sets the value of the default point, line, or polygon symbol. The symbol
      * can be configured with an instance of the Esri symbol or with the Esri
@@ -60,13 +67,6 @@ export declare class MeasurementCommands extends CommandRegistry {
      * @webOnly
      */
     get setLengthUnits(): Command<LengthMeasurementUnits | undefined>;
-    /**
-     * Show the measurements settings dialog. This allows you to configure
-     * measurements system, area and length units.
-     *
-     * @webOnly
-     */
-    get showSettings(): Command<HasUITarget>;
     /**
      * Starts drawing a measurement on the map. If a drawing has previously been
      * started and stopped it will be resumed.

package/messaging/registry/measurement.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";var GeometryMode;!function(e){e.LINE="line",e.AREA="area"}(GeometryMode||(GeometryMode={}));export class MeasurementCommands extends CommandRegistry{get setDefaultSymbol(){return this._messages.command("measurement.set-default-symbol")}get setAreaUnits(){return this._messages.command("measurement.set-area-units")}get setLengthUnits(){return this._messages.command("measurement.set-length-units")}get showSettings(){return this._messages.command("measurement.show-settings")}get start(){return this._messages.command("measurement.start")}get stop(){return this._messages.command("measurement.stop")}get clear(){return this._messages.command("measurement.clear")}get setGeometryMode(){return this._messages.command("measurement.set-geometry-mode")}}export class MeasurementOperations extends OperationRegistry{get createGraphics(){return this._messages.operation("measurement.create-graphics")}get captureGeometry(){return this._messages.operation("measurement.capture-geometry")}get getDefaultSymbol(){return this._messages.operation("measurement.get-default-symbol")}get getDefaultSymbol3D(){return this._messages.operation("measurement.get-default-symbol-3d")}get getAreaUnits(){return this._messages.operation("measurement.get-area-units")}get getLengthUnits(){return this._messages.operation("measurement.get-length-units")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";var GeometryMode;!function(e){e.LINE="line",e.AREA="area"}(GeometryMode||(GeometryMode={}));export class MeasurementCommands extends CommandRegistry{get displaySettings(){return this._messages.command("measurement.display-settings")}get setDefaultSymbol(){return this._messages.command("measurement.set-default-symbol")}get setAreaUnits(){return this._messages.command("measurement.set-area-units")}get setLengthUnits(){return this._messages.command("measurement.set-length-units")}get start(){return this._messages.command("measurement.start")}get stop(){return this._messages.command("measurement.stop")}get clear(){return this._messages.command("measurement.clear")}get setGeometryMode(){return this._messages.command("measurement.set-geometry-mode")}}export class MeasurementOperations extends OperationRegistry{get createGraphics(){return this._messages.operation("measurement.create-graphics")}get captureGeometry(){return this._messages.operation("measurement.capture-geometry")}get getDefaultSymbol(){return this._messages.operation("measurement.get-default-symbol")}get getDefaultSymbol3D(){return this._messages.operation("measurement.get-default-symbol-3d")}get getAreaUnits(){return this._messages.operation("measurement.get-area-units")}get getLengthUnits(){return this._messages.operation("measurement.get-length-units")}}

package/messaging/registry/sketching.d.ts

@@ -24,11 +24,13 @@ import type { Symbol as SymbolJson } from "@vertigis/arcgis-extensions/portal/Sy
 import type { ItemRef } from "../../app-config/common/ItemRef.js";
 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";
 import { OperationRegistry } from "../OperationRegistry.js";
 import type { FeaturesLike, GeometryLike, GraphicsLike, HasMaps, MapsLike } from "../common.js";
 import type { EditSymbolResult } from "./drawing.js";
-import type { LengthUnits } from "./geometry.js";
+import type { GeodeticCurveType, LengthUnits, LengthUnitsMobile, ReferenceLine } from "./geometry.js";
 /**
  * A representation of a 2D vector or point.
  */
@@ -145,6 +147,11 @@ export interface CaptureGeometryArgs {
      * Mobile.
      */
     symbol?: SymbolJson | SymbolSet;
+    /**
+     * The maximum number of segments permitted for a polyline or polygon
+     * sketch. Default is no limit. Mobile only.
+     */
+    maxSegments?: number;
 }
 /**
  * Result of the "sketching.capture-geometry" operation.
@@ -355,6 +362,15 @@ export interface SetInteractionModeArgs extends HasMaps {
      */
     editorInteractionMode: EditorInteractionMode;
 }
+/**
+ * Arguments for the "sketching.start-streaming" command.
+ */
+export interface StartStreamingArgs extends HasMaps {
+    /**
+     * An optional value indicating, in seconds, how often points should be recorded.
+     */
+    interval?: number;
+}
 /**
  * The editor geometry mode.
  */
@@ -399,6 +415,93 @@ export interface GetActiveSketchResult {
      */
     maps: MapExtension;
 }
+/**
+ * Arguments for the "sketching.set-constraints" command.
+ */
+export interface SetConstraintsArgs extends HasMaps {
+    /**
+     * The constraint for the length of the line between the selected vertex and
+     * the new point.
+     */
+    length?: number;
+    /**
+     * The constraint for the angle of the line between the selected vertex and
+     * the new point, relative to the reference line. Remains unchanged until
+     * set to a different value, or cleared.
+     */
+    angle?: number;
+    /**
+     * A reference line that the angle will be relative to. Defaults to 'north'.
+     * Remains unchanged until set again.
+     */
+    referenceLine?: ReferenceLine;
+    /**
+     * Indicates whether constraints will be automatically cleared after a
+     * vertex is added or updated. If not set (value is null), then the value
+     * will remain unchanged with this operation. If the value has never been
+     * set, the default is false. Remains unchanged until set to a different
+     * value.
+     */
+    autoClear?: boolean;
+    /**
+     * The units to be used for length. If not specified, the units of the map's
+     * spatial reference will be used.
+     */
+    units?: LengthUnitsMobile;
+    /**
+     * Indicates whether the distance calculations will be geodetic or planar.
+     * Default is true.
+     */
+    geodetic?: boolean;
+    /**
+     * The geodetic curve type used when calculating the new point. Only applies
+     * when geodetic is set to true. Defaults to geodesic.
+     * */
+    geodeticCurveType?: GeodeticCurveType;
+}
+/**
+ * Arguments for the "sketching.clear-constraints" command.
+ */
+export interface ClearConstraintsArgs extends HasMaps {
+    /**
+     * Indicates whether the length constraint should be cleared. Defaults to
+     * true if not specified.
+     */
+    clearLengthConstraint?: boolean;
+    /**
+     * Indicates whether the angle constraint should be cleared. Defaults to
+     * true if not specified.
+     */
+    clearAngleConstraint?: boolean;
+}
+/**
+ * Arguments for the "sketching.add-point" command.
+ */
+export interface AddPointArgs extends HasMaps {
+    /**
+     * The new point to be added.
+     */
+    newPoint: Point;
+}
+/**
+ * Arguments for the "sketching.insert-point" command.
+ */
+export interface InsertPointArgs extends HasMaps {
+    /**
+     * The index of the part to which the point will be added. If null, the last
+     * part will be used.
+     */
+    partIndex?: number;
+    /**
+     * The index at which the point will be added. If null, the point will be
+     * added as the last point.
+     */
+    pointIndex?: number;
+    /**
+     * The new point to be added.
+     */
+    newPoint: Point;
+}
 export declare class SketchingOperations extends OperationRegistry {
     /**
      * Allows the user to create geometry by sketching on a map. Returns the
@@ -472,6 +575,12 @@ export declare class SketchingOperations extends OperationRegistry {
      * @webOnly
      */
     get getActiveNode(): Operation<ItemRef, GetActiveSketchResult>;
+    /**
+     * Checks whether streaming is active.
+     *
+     * @mobileOnly
+     */
+    get isStreaming(): Operation<HasMaps, boolean>;
 }
 export declare class SketchingCommands extends CommandRegistry {
     /**
@@ -506,9 +615,10 @@ export declare class SketchingCommands extends CommandRegistry {
      */
     get addPointAtCurrentLocation(): Command<HasMaps>;
     /**
-     * Sets a point at the user's current location while editing a geometry. In this context, "set" means
-     * to either add a point at the current location, or update the currently selected point to be the user's
-     * current location, depending on what edit mode the user is in.
+     * Sets a point at the user's current location while editing a geometry. In
+     * this context, "set" means to either add a point at the current location,
+     * or update the currently selected point to be the user's current
+     * location, depending on what edit mode the user is in.
      *
      * @mobileOnly
      */
@@ -562,4 +672,54 @@ export declare class SketchingCommands extends CommandRegistry {
      * @webOnly
      */
     get disablePrecisionMode(): Command<void>;
+    /**
+     * Sets constraints on the active sketch.
+     *
+     * @mobileOnly
+     */
+    get setConstraints(): Command<SetConstraintsArgs>;
+    /**
+     * Clears constraints that have been previously set.
+     *
+     * @mobileOnly
+     */
+    get clearConstraints(): Command<ClearConstraintsArgs>;
+    /**
+     * Inserts a point into a polygon or polyline at the specified index. If the
+     * partIndex is null, then the last part is used. If the pointIndex is null,
+     * then the new point is inserted at the end.
+     */
+    get insertPoint(): Command<InsertPointArgs>;
+    /**
+     * Adds a point to polygon or polyline using the selected index as the point
+     * to insert after.
+     */
+    get addPoint(): Command<AddPointArgs>;
+    /**
+     * Starts streaming: recording your location at regular intervals and
+     * adding the collected points to the currently active geometry editor.
+     *
+     * @mobileOnly
+     */
+    get startStreaming(): Command<StartStreamingArgs>;
+    /**
+     * Stops streaming.
+     *
+     * @mobileOnly
+     */
+    get stopStreaming(): Command<HasMaps>;
+}
+export declare class SketchingEvents extends EventRegistry {
+    /**
+     * Raised when streaming has begun.
+     *
+     * @mobileOnly
+     */
+    get streamingStarted(): Event<HasMaps>;
+    /**
+     * Raised when streaming has stopped.
+     *
+     * @mobileOnly
+     */
+    get streamingStopped(): Event<HasMaps>;
 }

package/messaging/registry/sketching.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var SketchTool;!function(e){e.POINT="point",e.MULTIPOINT="multipoint",e.LINE="line",e.POLYLINE="polyline",e.POLYGON="polygon",e.EXTENT="extent",e.SQUARE="square",e.CIRCLE="circle"}(SketchTool||(SketchTool={}));export class SketchingOperations extends OperationRegistry{get captureGeometry(){return this._messages.operation("sketching.capture-geometry")}get editActiveSymbol(){return this._messages.operation("sketching.edit-active-symbol")}get editGeometry(){return this._messages.operation("sketching.edit-geometry")}get moveGeometry(){return this._messages.operation("sketching.move-geometry")}get scaleGeometry(){return this._messages.operation("sketching.scale-geometry")}get rotateGeometry(){return this._messages.operation("sketching.rotate-geometry")}get stop(){return this._messages.operation("sketching.stop")}get addNodeToGeometry(){return this._messages.operation("sketching.add-node-to-geometry")}get getActiveSketch(){return this._messages.operation("sketching.get-active-sketch")}get getActiveNode(){return this._messages.operation("sketching.get-active-node")}}export class SketchingCommands extends CommandRegistry{get cancel(){return this._messages.command("sketching.cancel")}get undo(){return this._messages.command("sketching.undo")}get redo(){return this._messages.command("sketching.redo")}get setGeometryMode(){return this._messages.command("sketching.set-geometry-mode")}get addPointAtCenter(){return this._messages.command("sketching.add-point-at-center")}get addPointAtCurrentLocation(){return this._messages.command("sketching.add-point-at-current-location")}get setPointAtCurrentLocation(){return this._messages.command("sketching.set-point-at-current-location")}get delete(){return this._messages.command("sketching.delete")}get moveNode(){return this._messages.command("sketching.move-node")}get switchActiveNode(){return this._messages.command("sketching.switch-active-node")}get setInteractionMode(){return this._messages.command("sketching.set-interaction-mode")}get enableFreeScaleMode(){return this._messages.command("sketching.enable-free-scale-mode")}get disableFreeScaleMode(){return this._messages.command("sketching.disable-free-scale-mode")}get enablePrecisionMode(){return this._messages.command("sketching.enable-precision-mode")}get disablePrecisionMode(){return this._messages.command("sketching.disable-precision-mode")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var SketchTool;!function(e){e.POINT="point",e.MULTIPOINT="multipoint",e.LINE="line",e.POLYLINE="polyline",e.POLYGON="polygon",e.EXTENT="extent",e.SQUARE="square",e.CIRCLE="circle"}(SketchTool||(SketchTool={}));export class SketchingOperations extends OperationRegistry{get captureGeometry(){return this._messages.operation("sketching.capture-geometry")}get editActiveSymbol(){return this._messages.operation("sketching.edit-active-symbol")}get editGeometry(){return this._messages.operation("sketching.edit-geometry")}get moveGeometry(){return this._messages.operation("sketching.move-geometry")}get scaleGeometry(){return this._messages.operation("sketching.scale-geometry")}get rotateGeometry(){return this._messages.operation("sketching.rotate-geometry")}get stop(){return this._messages.operation("sketching.stop")}get addNodeToGeometry(){return this._messages.operation("sketching.add-node-to-geometry")}get getActiveSketch(){return this._messages.operation("sketching.get-active-sketch")}get getActiveNode(){return this._messages.operation("sketching.get-active-node")}get isStreaming(){return this._messages.operation("sketching.is-streaming")}}export class SketchingCommands extends CommandRegistry{get cancel(){return this._messages.command("sketching.cancel")}get undo(){return this._messages.command("sketching.undo")}get redo(){return this._messages.command("sketching.redo")}get setGeometryMode(){return this._messages.command("sketching.set-geometry-mode")}get addPointAtCenter(){return this._messages.command("sketching.add-point-at-center")}get addPointAtCurrentLocation(){return this._messages.command("sketching.add-point-at-current-location")}get setPointAtCurrentLocation(){return this._messages.command("sketching.set-point-at-current-location")}get delete(){return this._messages.command("sketching.delete")}get moveNode(){return this._messages.command("sketching.move-node")}get switchActiveNode(){return this._messages.command("sketching.switch-active-node")}get setInteractionMode(){return this._messages.command("sketching.set-interaction-mode")}get enableFreeScaleMode(){return this._messages.command("sketching.enable-free-scale-mode")}get disableFreeScaleMode(){return this._messages.command("sketching.disable-free-scale-mode")}get enablePrecisionMode(){return this._messages.command("sketching.enable-precision-mode")}get disablePrecisionMode(){return this._messages.command("sketching.disable-precision-mode")}get setConstraints(){return this._messages.command("sketching.set-constraints")}get clearConstraints(){return this._messages.command("sketching.clear-constraints")}get insertPoint(){return this._messages.command("sketching.insert-point")}get addPoint(){return this._messages.command("sketching.add-point")}get startStreaming(){return this._messages.command("sketching.start-streaming")}get stopStreaming(){return this._messages.command("sketching.stop-streaming")}}export class SketchingEvents extends EventRegistry{get streamingStarted(){return this._messages.event("sketching.streaming-started")}get streamingStopped(){return this._messages.event("sketching.streaming-stopped")}}

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

@@ -493,6 +493,24 @@
             ],
             "type": "object"
         },
+        "AddPointArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.add-point\" command.",
+            "properties": {
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "newPoint": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The new point to be added."
+                }
+            },
+            "required": [
+                "newPoint"
+            ],
+            "type": "object"
+        },
         "AlertCommandArgs": {
             "additionalProperties": false,
             "description": "Arguments for the 'ui.alert' command.",
@@ -555,6 +573,10 @@
                     "$ref": "MapsLike",
                     "description": "The maps to activate drawing on. By default it will be all maps."
                 },
+                "maxSegments": {
+                    "description": "The maximum number of segments permitted for a polyline or polygon sketch. Default is no limit. Mobile only.",
+                    "type": "number"
+                },
                 "symbol": {
                     "anyOf": [
                         {
@@ -1220,6 +1242,32 @@
             ],
             "type": "object"
         },
+        "InsertPointArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"sketching.insert-point\" command.",
+            "properties": {
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
+                "newPoint": {
+                    "$ref": "#/definitions/esri.Point",
+                    "description": "The new point to be added."
+                },
+                "partIndex": {
+                    "description": "The index of the part to which the point will be added. If null, the last part will be used.",
+                    "type": "number"
+                },
+                "pointIndex": {
+                    "description": "The index at which the point will be added. If null, the point will be added as the last point.",
+                    "type": "number"
+                }
+            },
+            "required": [
+                "newPoint"
+            ],
+            "type": "object"
+        },
         "JobParameters": {
             "additionalProperties": false,
             "description": "A set of parameters used to run a job.",
@@ -11135,6 +11183,15 @@
         "sketching.add-node-to-geometry:output": {
             "$ref": "#/definitions/esri.Geometry"
         },
+        "sketching.add-point": {
+            "description": "Adds a point to polygon or polyline using the selected index as the point to insert after.",
+            "enum": [
+                "sketching.add-point"
+            ]
+        },
+        "sketching.add-point:input": {
+            "$ref": "#/definitions/AddPointArgs"
+        },
         "sketching.capture-geometry": {
             "description": "Allows the user to create geometry by sketching on a map. Returns the geometry that was drawn, along with the map that it was drawn on.",
             "enum": [
@@ -11168,6 +11225,15 @@
         "sketching.edit-geometry:output": {
             "$ref": "#/definitions/EditGeometryResult"
         },
+        "sketching.insert-point": {
+            "description": "Inserts a point into a polygon or polyline at the specified index. If the partIndex is null, then the last part is used. If the pointIndex is null, then the new point is inserted at the end.",
+            "enum": [
+                "sketching.insert-point"
+            ]
+        },
+        "sketching.insert-point:input": {
+            "$ref": "#/definitions/InsertPointArgs"
+        },
         "sketching.redo": {
             "description": "Redoes the last undone edit while editing a geometry.",
             "enum": [
@@ -11830,6 +11896,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.add-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.add-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -11846,6 +11928,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/sketching.insert-point:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/sketching.insert-point"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -12092,9 +12190,15 @@
                 {
                     "$ref": "#/definitions/search.clear"
                 },
+                {
+                    "$ref": "#/definitions/sketching.add-point"
+                },
                 {
                     "$ref": "#/definitions/sketching.delete"
                 },
+                {
+                    "$ref": "#/definitions/sketching.insert-point"
+                },
                 {
                     "$ref": "#/definitions/sketching.redo"
                 },