@vertigis/viewer-spec 59.25.0 → 59.27.0

package/messaging/common.d.ts

@@ -13,7 +13,7 @@ import type SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol";
 import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol";
 import type SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
 import type TextSymbol from "@arcgis/core/symbols/TextSymbol";
-import type { GeometryUnion } from "@arcgis/core/unionTypes";
+import type { GeometryUnion, RendererUnion } from "@arcgis/core/unionTypes";
 import type { Entity } from "@vertigis/arcgis-extensions/Entity";
 import type { Feature, FeatureProperties } from "@vertigis/arcgis-extensions/data/Feature";
 import type { FeatureList } from "@vertigis/arcgis-extensions/data/FeatureList";
@@ -24,6 +24,7 @@ import type { TableExtension, TableReference as TableReferenceObject } from "@ve
 import type { LabelingInfoJson } from "@vertigis/arcgis-extensions/json/DrawingInfoJson";
 import type { FeatureJson } from "@vertigis/arcgis-extensions/json/FeatureJson";
 import type { GeometryJson } from "@vertigis/arcgis-extensions/json/GeometryJson";
+import type { RendererJson } from "@vertigis/arcgis-extensions/json/RendererJson";
 import type { CIMSymbolReferenceJson, LineSymbol3DJson, PictureFillSymbolJson, PictureMarkerSymbolJson, PointSymbol3DJson, PolygonSymbol3DJson, SimpleFillSymbolJson, SimpleLineSymbolJson, SimpleMarkerSymbolJson, TextSymbolJson } from "@vertigis/arcgis-extensions/json/SymbolJson";
 import type { ViewpointJson } from "@vertigis/arcgis-extensions/json/ViewpointJson";
 import type { BasemapExtension } from "@vertigis/arcgis-extensions/mapping/BasemapExtension";
@@ -290,6 +291,19 @@ export interface HasSymbols {
      */
     symbols?: SymbolLike | SymbolLike[];
 }
+/**
+ * Renderers supported for styling features.
+ */
+export type RendererLike = RendererJson | RendererUnion;
+/**
+ * An object that has a `renderer` property.
+ */
+export interface HasRenderer {
+    /**
+     * The renderer configuration to use for the command/operation.
+     */
+    renderer?: RendererLike;
+}
 /**
  * An object that is convertible to an Esri Viewpoint, or that has a viewpoint
  * property.

package/messaging/registry/Operations.d.ts

@@ -23,6 +23,7 @@ import { MessagingOperations } from "./messaging.js";
 import { NetworkOperations } from "./network.js";
 import { OfflineOperations } from "./offline.js";
 import { PortalOperations } from "./portal.js";
+import { PrintOperations } from "./printing.js";
 import { ProjectOperations } from "./project.js";
 import { QueryBuilderOperations } from "./query-builder.js";
 import { ResultsOperations } from "./results.js";
@@ -57,6 +58,7 @@ export declare class Operations extends OperationRegistry {
     readonly network: NetworkOperations;
     readonly offline: OfflineOperations;
     readonly portal: PortalOperations;
+    readonly printing: PrintOperations;
     readonly project: ProjectOperations;
     readonly queryBuilder: QueryBuilderOperations;
     readonly sketching: SketchingOperations;

package/messaging/registry/Operations.js

@@ -1 +1 @@
-import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as m}from"./arcade.js";import{AuthOperations as i}from"./auth.js";import{BasemapOperations as r}from"./basemap.js";import{ChartOperations as t}from"./charts.js";import{DebugConsoleOperations as o}from"./debugConsole.js";import{DrawingOperations as a}from"./drawing.js";import{EditOperations as g}from"./edit.js";import{FileOperations as n}from"./file.js";import{FilterBuilderOperations as p}from"./filter-builder.js";import{GeocodeOperations as w}from"./geocode.js";import{GeolocationOperations as f}from"./geolocation.js";import{GeometryOperations as h}from"./geometry.js";import{HighlightsOperations as j}from"./highlights.js";import{KpiOperations as _}from"./kpi.js";import{LayersOperations as l}from"./layers.js";import{LicensingOperations as u}from"./licensing.js";import{LogViewerOperations as c}from"./logViewer.js";import{MapOperations as d}from"./map.js";import{MeasurementOperations as k}from"./measurement.js";import{MessagingOperations as y}from"./messaging.js";import{NetworkOperations as b}from"./network.js";import{OfflineOperations as x}from"./offline.js";import{PortalOperations as q}from"./portal.js";import{ProjectOperations as v}from"./project.js";import{QueryBuilderOperations as B}from"./query-builder.js";import{ResultsOperations as C}from"./results.js";import{SketchingOperations as O}from"./sketching.js";import{SystemOperations as V}from"./system.js";import{TasksOperations as N}from"./tasks.js";import{UIOperations as R}from"./ui.js";import{UtilityNetworkOperations as z}from"./utility-network.js";import{ViewerOperations as A}from"./viewer.js";import{WorkflowOperations as D}from"./workflow.js";export class Operations extends s{arcade=new m(this._messages);auth=new i(this._messages);app=new e(this._messages);basemap=new r(this._messages);charts=new t(this._messages);edit=new g(this._messages);drawing=new a(this._messages);file=new n(this._messages);filterBuilder=new p(this._messages);geocode=new w(this._messages);geolocation=new f(this._messages);geometry=new h(this._messages);highlights=new j(this._messages);kpi=new _(this._messages);layers=new l(this._messages);licensing=new u(this._messages);logViewer=new c(this._messages);map=new d(this._messages);measurement=new k(this._messages);messaging=new y(this._messages);network=new b(this._messages);offline=new x(this._messages);portal=new q(this._messages);project=new v(this._messages);queryBuilder=new B(this._messages);sketching=new O(this._messages);system=new V(this._messages);results=new C(this._messages);tasks=new N(this._messages);ui=new R(this._messages);utilityNetwork=new z(this._messages);viewer=new A(this._messages);workflow=new D(this._messages);debugConsole=new o(this._messages);_prefix=""}
+import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as m}from"./arcade.js";import{AuthOperations as i}from"./auth.js";import{BasemapOperations as r}from"./basemap.js";import{ChartOperations as t}from"./charts.js";import{DebugConsoleOperations as o}from"./debugConsole.js";import{DrawingOperations as a}from"./drawing.js";import{EditOperations as n}from"./edit.js";import{FileOperations as g}from"./file.js";import{FilterBuilderOperations as p}from"./filter-builder.js";import{GeocodeOperations as w}from"./geocode.js";import{GeolocationOperations as f}from"./geolocation.js";import{GeometryOperations as h}from"./geometry.js";import{HighlightsOperations as j}from"./highlights.js";import{KpiOperations as _}from"./kpi.js";import{LayersOperations as l}from"./layers.js";import{LicensingOperations as u}from"./licensing.js";import{LogViewerOperations as c}from"./logViewer.js";import{MapOperations as d}from"./map.js";import{MeasurementOperations as k}from"./measurement.js";import{MessagingOperations as y}from"./messaging.js";import{NetworkOperations as b}from"./network.js";import{OfflineOperations as x}from"./offline.js";import{PortalOperations as q}from"./portal.js";import{PrintOperations as v}from"./printing.js";import{ProjectOperations as B}from"./project.js";import{QueryBuilderOperations as C}from"./query-builder.js";import{ResultsOperations as O}from"./results.js";import{SketchingOperations as V}from"./sketching.js";import{SystemOperations as N}from"./system.js";import{TasksOperations as R}from"./tasks.js";import{UIOperations as z}from"./ui.js";import{UtilityNetworkOperations as A}from"./utility-network.js";import{ViewerOperations as D}from"./viewer.js";import{WorkflowOperations as E}from"./workflow.js";export class Operations extends s{arcade=new m(this._messages);auth=new i(this._messages);app=new e(this._messages);basemap=new r(this._messages);charts=new t(this._messages);edit=new n(this._messages);drawing=new a(this._messages);file=new g(this._messages);filterBuilder=new p(this._messages);geocode=new w(this._messages);geolocation=new f(this._messages);geometry=new h(this._messages);highlights=new j(this._messages);kpi=new _(this._messages);layers=new l(this._messages);licensing=new u(this._messages);logViewer=new c(this._messages);map=new d(this._messages);measurement=new k(this._messages);messaging=new y(this._messages);network=new b(this._messages);offline=new x(this._messages);portal=new q(this._messages);printing=new v(this._messages);project=new B(this._messages);queryBuilder=new C(this._messages);sketching=new V(this._messages);system=new N(this._messages);results=new O(this._messages);tasks=new R(this._messages);ui=new z(this._messages);utilityNetwork=new A(this._messages);viewer=new D(this._messages);workflow=new E(this._messages);debugConsole=new o(this._messages);_prefix=""}

package/messaging/registry/drawing.d.ts

@@ -15,7 +15,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 { CreateGraphicsResult, FeaturesLike, GeometryLike, HasFeatures, HasGraphics, HasLayers, HasMaps, HasSymbol, HasSymbols, HasUITarget, SymbolLike } from "../common.js";
+import type { CreateGraphicsResult, FeaturesLike, GeometryLike, HasFeatures, HasGraphics, HasLayers, HasMaps, HasRenderer, HasSymbol, HasSymbols, HasUITarget, SymbolLike } from "../common.js";
 import type { CaptureGeometryArgs } from "./sketching.js";
 /**
  * Symbols supported for drawing.
@@ -57,7 +57,7 @@ export interface EditSymbolArgs extends HasSymbol, HasSymbols, HasMaps, HasLayer
  * Arguments for the drawing.edit-symbol operation. Only available in VertiGIS
  * Studio Web.
  */
-export interface EditSymbolResult extends HasMaps, HasLayers, HasGraphics, HasFeatures, HasSymbols, HasSymbol {
+export interface EditSymbolResult extends HasMaps, HasLayers, HasGraphics, HasFeatures, HasSymbols, HasSymbol, HasRenderer {
 }
 /**
  * Arguments for the "drawing.create-graphics" operation. `GeometryLike`,

package/messaging/registry/layers.d.ts

@@ -8,7 +8,7 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { HasFiles, HasLayers, HasMaps, HasSymbol, HasSymbols, LayersLike } from "../common.js";
+import type { HasFiles, HasLayers, HasMaps, HasRenderer, HasSymbol, HasSymbols, LayersLike } from "../common.js";
 /**
  * Arguments for the "layers.visibility-changed" event.
  */
@@ -43,7 +43,7 @@ export interface SetLabelVisibilityArgs extends HasLayers, HasMaps {
 /**
  * Arguments for the layers.set-symbol command.
  */
-export type SetSymbolArgs = HasSymbol & HasSymbols & HasLayers & HasMaps;
+export type SetSymbolArgs = HasSymbol & HasSymbols & HasLayers & HasMaps & HasRenderer;
 /**
  * Arguments for the layers.set-visibility command. If no 'maps' are specified,
  * all active maps in the layout will be targeted. If no 'layers' are specified,

package/messaging/registry/printing.d.ts

@@ -9,6 +9,8 @@ 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 { MapsLike } from "../common.js";
 /**
  * A set of parameters used to run a job.
@@ -747,9 +749,9 @@ export interface AdditionalSettings {
     dynamicElements?: DynamicElement[];
 }
 /**
- * Prepared print job arguments (printing gen2).
+ * Print job arguments (printing gen2).
  */
-export interface PreparedPrintJobArgs {
+export interface PrintJobArgs {
     /**
      * Export web map.
      */
@@ -763,6 +765,10 @@ export interface PreparedPrintJobArgs {
      */
     additionalWebMaps?: AdditionalExportWebMap[];
 }
+/**
+ * Prepared print job arguments (printing gen2).
+ */
+export type PreparedPrintJobArgs = PrintJobArgs;
 /**
  * The arguments required by the printing.run command when printing with
  * VertiGIS Studio ArcGIS Pro layouts, -layout packages or MAP ONLY (printing
@@ -935,10 +941,23 @@ export interface PrintPreparingEventArgs extends PrintEventArgsBase {
  */
 export interface PrintPreparedEventArgs extends PrintEventArgsBase {
     /**
-     * The print job arguments.
+     * The prepared print job arguments.
      */
     printJobArgs?: PreparedPrintJobArgs;
 }
+/**
+ * Prepared print job update arguments for the printing.update-args operation.
+ */
+export interface PreparedPrintJobUpdateArgs {
+    /**
+     * The prepared print job arguments.
+     */
+    printJobArgs: PreparedPrintJobArgs;
+    /**
+     * The print job update arguments.
+     */
+    update?: PrintJobArgs;
+}
 /**
  * Arguments for the printing.print-started event.
  */
@@ -955,6 +974,16 @@ export declare class PrintCommands extends CommandRegistry {
      */
     get run(): Command<RunPrintArgs | RunLayoutPrintArgs>;
 }
+export declare class PrintOperations extends OperationRegistry {
+    protected readonly _prefix = "printing";
+    /**
+     * Allows the user to update the intercepted prepared print request
+     * arguments.
+     *
+     * @webOnly
+     */
+    get updateArgs(): Operation<PreparedPrintJobUpdateArgs, PreparedPrintJobArgs>;
+}
 export declare class PrintEvents extends EventRegistry {
     protected readonly _prefix = "printing";
     /**

package/messaging/registry/printing.js

@@ -1 +1 @@
-import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export const printOutputFormats=["AIX","BMP","EMF","EPS","GIF","JPG","PDF","PNG","PNG32","SVG","SVGZ","TGA","TIFF"];export class PrintCommands extends r{_prefix="printing";get run(){return this._get("run")}}export class PrintEvents extends t{_prefix="printing";get printPreparing(){return this._get("print-preparing")}get printPrepared(){return this._get("print-prepared")}get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}
+import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as e}from"../OperationRegistry.js";export const printOutputFormats=["AIX","BMP","EMF","EPS","GIF","JPG","PDF","PNG","PNG32","SVG","SVGZ","TGA","TIFF"];export class PrintCommands extends r{_prefix="printing";get run(){return this._get("run")}}export class PrintOperations extends e{_prefix="printing";get updateArgs(){return this._get("update-args")}}export class PrintEvents extends t{_prefix="printing";get printPreparing(){return this._get("print-preparing")}get printPrepared(){return this._get("print-prepared")}get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}