@vertigis/viewer-spec 46.0.0 → 46.3.0

package/messaging/registry/Operations.d.ts

@@ -6,6 +6,7 @@ import { BasemapOperations } from "./basemap.js";
 import { ChartOperations } from "./charts.js";
 import { DebugConsoleOperations } from "./debugConsole.js";
 import { DrawingOperations } from "./drawing.js";
+import { EditOperations } from "./edit.js";
 import { FileOperations } from "./file.js";
 import { GeocodeOperations } from "./geocode.js";
 import { GeolocationOperations } from "./geolocation.js";
@@ -30,6 +31,7 @@ export declare class Operations extends OperationRegistry {
     readonly app: AppOperations;
     readonly basemap: BasemapOperations;
     readonly charts: ChartOperations;
+    readonly edit: EditOperations;
     readonly drawing: DrawingOperations;
     readonly file: FileOperations;
     readonly geocode: GeocodeOperations;

package/messaging/registry/Operations.js

@@ -1 +1 @@
-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)}}
+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{EditOperations}from"./edit.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.edit=new EditOperations(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/app.d.ts

@@ -57,6 +57,18 @@ export declare class AppCommands extends CommandRegistry {
      * @mobileOnly
      */
     get refresh(): Command;
+    /**
+     * Adds the currently loaded app to the user's Favorites collection.
+     *
+     * @mobileOnly
+     */
+    get favorite(): Command;
+    /**
+     * Removes the currently loaded app from the user's Favorites collection.
+     *
+     * @mobileOnly
+     */
+    get unfavorite(): Command;
     /**
      * Loads a project's app config and updates the application's current state,
      * accordingly. If more than one file is provided, only the first will be

package/messaging/registry/app.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class AppCommands extends CommandRegistry{get goToAppSelector(){return this._messages.command("app.go-to-app-selector")}get refresh(){return this._messages.command("app.refresh")}get loadProject(){return this._messages.command("app.load-project")}}export class AppEvents extends EventRegistry{constructor(){super(...arguments),this.custom=new AppCustomEvents(this._messages),this.generic=new AppGenericEvents(this._messages)}get activated(){return this._messages.event("app.activated")}get backgrounded(){return this._messages.event("app.backgrounded")}get specificAppStarted(){return this._messages.event("app.specific-app-started")}get interrupted(){return this._messages.event("app.interrupted")}}export class AppCustomEvents extends EventRegistry{get started(){return this._messages.event("app.custom.started")}}export class AppGenericEvents extends EventRegistry{get started(){return this._messages.event("app.generic.started")}get appsListed(){return this._messages.event("app.generic.apps-listed")}}export class AppOperations extends OperationRegistry{get getVersion(){return this._messages.operation("app.get-version")}get createProject(){return this._messages.operation("app.create-project")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class AppCommands extends CommandRegistry{get goToAppSelector(){return this._messages.command("app.go-to-app-selector")}get refresh(){return this._messages.command("app.refresh")}get favorite(){return this._messages.command("app.favorite")}get unfavorite(){return this._messages.command("app.unfavorite")}get loadProject(){return this._messages.command("app.load-project")}}export class AppEvents extends EventRegistry{constructor(){super(...arguments),this.custom=new AppCustomEvents(this._messages),this.generic=new AppGenericEvents(this._messages)}get activated(){return this._messages.event("app.activated")}get backgrounded(){return this._messages.event("app.backgrounded")}get specificAppStarted(){return this._messages.event("app.specific-app-started")}get interrupted(){return this._messages.event("app.interrupted")}}export class AppCustomEvents extends EventRegistry{get started(){return this._messages.event("app.custom.started")}}export class AppGenericEvents extends EventRegistry{get started(){return this._messages.event("app.generic.started")}get appsListed(){return this._messages.event("app.generic.apps-listed")}}export class AppOperations extends OperationRegistry{get getVersion(){return this._messages.operation("app.get-version")}get createProject(){return this._messages.operation("app.create-project")}}

package/messaging/registry/edit.d.ts

@@ -5,7 +5,10 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
-import type { MapsLike } from "../common.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
+import type { EditGeometryOptions } from "./sketching.js";
 /**
  * Arguments for the "edit.add-attachment" command.
  */
@@ -44,6 +47,85 @@ export interface AttachmentEventArgs {
      */
     attachment: Attachment;
 }
+/**
+ * Options for editing operations that display a UI.
+ */
+export interface EditUIOptions {
+    /**
+     * Whether to show UI notifications.
+     */
+    showNotifications?: boolean;
+    /**
+     * The orientation of the template picker.
+     */
+    orientation?: "horizontal" | "vertical";
+    /**
+     * Whether to show titles on the template picker.
+     */
+    showTitles?: boolean;
+}
+/**
+ * A collection of options common to interactive feature editing sessions. Web
+ * only.
+ */
+export interface EditOptions {
+    /**
+     * Whether to allow editing of feature geometry.
+     */
+    editGeometry?: boolean;
+    /**
+     * Whether to allow editing of feature attributes.
+     */
+    editAttributes?: boolean;
+    /**
+     * Whether to allow editing of feature attachments.
+     */
+    editAttachments?: boolean;
+    /**
+     * Options for the geometry editing session.
+     */
+    editGeometryOptions?: EditGeometryOptions;
+}
+/**
+ * Arguments for the "edit.create-feature" operation. Also may be supplied to
+ * augment an interactive editing session. A valid feature layer is required.
+ * The geometry is required for non-tabular features. Web only.
+ */
+export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps, EditUIOptions {
+    /**
+     * A collection of attributes to apply to the new feature.
+     */
+    featureAttributes?: Record<string, unknown>;
+    /**
+     * The template to use as a starting point for this feature. Requires a
+     * layer. The default or first template will be used if not set.
+     */
+    templateName?: string;
+}
+/**
+ * Arguments for the "edit.display-add-features" command. Web only.
+ */
+export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, HasUITarget, EditOptions, EditUIOptions {
+}
+/**
+ * Arguments for the "edit.display-update-features" operation. Web only.
+ */
+export interface DisplayUpdateFeatureArgs extends EditCommandArgs, HasGeometry, HasMaps, EditOptions {
+    /**
+     * A collection of attributes to automatically apply to the updated feature.
+     */
+    featureAttributes?: Record<string, unknown>;
+}
+/**
+ * Arguments for the "edit.add-features", "edit.update-features" and
+ * "edit.delete-features" commands. Web only.
+ */
+export interface EditCommandArgs extends HasFeatures {
+    /**
+     * Whether to show UI notifications.
+     */
+    showNotifications?: boolean;
+}
 export declare class EditCommands extends CommandRegistry {
     /**
      * Create and add an attachment to a provided feature, using the given
@@ -53,35 +135,38 @@ export declare class EditCommands extends CommandRegistry {
      */
     get addAttachment(): Command<AddAttachmentArgs>;
     /**
-     * Adds a feature to a particular layer.
-     *
-     * @mobileOnly
+     * Adds a feature to a particular layer. `Feature[]` and
+     * `EditCommandArgs` are not supported on Mobile.
      */
-    get addFeature(): Command<Feature>;
+    get addFeature(): Command<Feature | Feature[] | EditCommandArgs>;
     /**
      * Deletes the given feature or features from their feature sources.
-     *
-     * @mobileOnly
+     * `EditCommandArgs` is not supported on Mobile.
      */
-    get deleteFeatures(): Command<Feature | Feature[]>;
+    get deleteFeatures(): Command<Feature | Feature[] | EditCommandArgs>;
     /**
-     * Display a form for adding a feature.
-     *
-     * @mobileOnly
+     * Display a form for adding a feature. `DisplayAddFeatureArgs` is not
+     * supported on Mobile.
      */
-    get displayAddFeature(): Command<FeatureSource>;
+    get displayAddFeature(): Command<FeatureSource | DisplayAddFeatureArgs>;
     /**
-     * Display a form for updating a feature.
-     *
-     * @mobileOnly
+     * Display a form for updating a feature. `DisplayUpdateFeatureArgs` is not
+     * supported on Mobile.
      */
-    get displayUpdateFeature(): Command<Feature>;
+    get displayUpdateFeature(): Command<Feature | DisplayUpdateFeatureArgs>;
+    /**
+     * Updates a feature. `Feature[]` and `EditCommandArgs` are not
+     * supported on Mobile.
+     */
+    get updateFeature(): Command<Feature | Feature[] | EditCommandArgs>;
+}
+export declare class EditOperations extends OperationRegistry {
     /**
-     * Updates a feature.
+     * Creates a new `Feature` for the supplied layer from the supplied data.
      *
-     * @mobileOnly
+     * @webOnly
      */
-    get updateFeature(): Command<Feature>;
+    get createFeature(): Operation<CreateFeatureArgs, HasFeatures>;
 }
 export declare class EditEvents extends EventRegistry {
     /**
@@ -104,20 +189,14 @@ export declare class EditEvents extends EventRegistry {
     get attachmentDeleted(): Event<AttachmentEventArgs>;
     /**
      * Raised when a feature is added.
-     *
-     * @mobileOnly
      */
     get featureAdded(): Event<Feature>;
     /**
      * Raised when a feature is deleted.
-     *
-     * @mobileOnly
      */
     get featureDeleted(): Event<Feature>;
     /**
      * Raised when a feature is updated.
-     *
-     * @mobileOnly
      */
     get featureUpdated(): Event<Feature>;
 }

package/messaging/registry/edit.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export class EditCommands extends CommandRegistry{get addAttachment(){return this._messages.command("edit.add-attachment")}get addFeature(){return this._messages.command("edit.add-feature")}get deleteFeatures(){return this._messages.command("edit.delete-features")}get displayAddFeature(){return this._messages.command("edit.display-add-feature")}get displayUpdateFeature(){return this._messages.command("edit.display-update-feature")}get updateFeature(){return this._messages.command("edit.update-feature")}}export class EditEvents extends EventRegistry{get attachmentAdded(){return this._messages.event("edit.attachment-added")}get attachmentUpdated(){return this._messages.event("edit.attachment-updated")}get attachmentDeleted(){return this._messages.event("edit.attachment-deleted")}get featureAdded(){return this._messages.event("edit.feature-added")}get featureDeleted(){return this._messages.event("edit.feature-deleted")}get featureUpdated(){return this._messages.event("edit.feature-updated")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class EditCommands extends CommandRegistry{get addAttachment(){return this._messages.command("edit.add-attachment")}get addFeature(){return this._messages.command("edit.add-feature")}get deleteFeatures(){return this._messages.command("edit.delete-features")}get displayAddFeature(){return this._messages.command("edit.display-add-feature")}get displayUpdateFeature(){return this._messages.command("edit.display-update-feature")}get updateFeature(){return this._messages.command("edit.update-feature")}}export class EditOperations extends OperationRegistry{get createFeature(){return this._messages.operation("edit.create-feature")}}export class EditEvents extends EventRegistry{get attachmentAdded(){return this._messages.event("edit.attachment-added")}get attachmentUpdated(){return this._messages.event("edit.attachment-updated")}get attachmentDeleted(){return this._messages.event("edit.attachment-deleted")}get featureAdded(){return this._messages.event("edit.feature-added")}get featureDeleted(){return this._messages.event("edit.feature-deleted")}get featureUpdated(){return this._messages.event("edit.feature-updated")}}

package/messaging/registry/system.d.ts

@@ -2,7 +2,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 { Blob, File, HasUITarget } from "../common.js";
+import type { Blob, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget } from "../common.js";
 /**
  * Arguments for the system.download-file operation.
  */
@@ -40,6 +40,24 @@ export interface ReadFileArgs extends HasUITarget {
      */
     promptMessage?: string;
 }
+/**
+ * Well-known location-based tokens that can be used in the system.open-url
+ * command arguments. Location.Map.ZoomLevel is not supported by Mobile; the
+ * supported levels and their associated numeric values can be found here:
+ * https://developers.arcgis.com/documentation/mapping-apis-and-services/reference/zoom-levels-and-scale/.
+ */
+export declare type LocationToken = "Location.Geolocation.Latitude" | "Location.Geolocation.Longitude" | "Location.Feature.Latitude" | "Location.Feature.Longitude" | "Location.Map.Center.Latitude" | "Location.Map.Center.Longitude" | "Location.Map.Scale" | "Location.Map.ZoomLevel" | "Location.Map.TopLeft.Latitude" | "Location.Map.TopLeft.Longitude" | "Location.Map.TopRight.Latitude" | "Location.Map.TopRight.Longitude" | "Location.Map.BottomLeft.Latitude" | "Location.Map.BottomLeft.Longitude" | "Location.Map.BottomRight.Latitude" | "Location.Map.BottomRight.Longitude";
+/**
+ * Well-known layer-based tokens that can be used in the system.open-url command
+ * arguments. NOTE: Not all layer types support extents, urls, min/max scales,
+ * and/or min/max zoom levels.
+ */
+export declare type LayerToken = "Layer.Extent.TopLeft.Latitude" | "Layer.Extent.TopLeft.Longitude" | "Layer.Extent.TopRight.Latitude" | "Layer.Extent.TopRight.Longitude" | "Layer.Extent.BottomLeft.Latitude" | "Layer.Extent.BottomLeft.Longitude" | "Layer.Extent.BottomRight.Latitude" | "Layer.Extent.BottomRight.Longitude" | "Layer.Extent.MaxScale" | "Layer.Extent.MinScale" | "Layer.Extent.MaxZoomLevel" | "Layer.Extent.MinZoomLevel" | "Layer.ID" | "Layer.Title" | "Layer.URL";
+/**
+ * VertiGIS Studio Web's arguments for the system.open-url command.
+ */
+export interface WebOpenUrlArgs extends Omit<OpenUrlArgs, "context">, HasMaps, HasFeatures, HasGeometry, HasLayers {
+}
 /**
  * Arguments for the system.open-url command.
  */
@@ -79,19 +97,22 @@ export declare class SystemCommands extends CommandRegistry {
     get downloadFile(): Command<DownloadArgs | Record<string, unknown> | string>;
     /**
      * Opens a URL, either in the system browser or whatever app is appropriate
-     * for the scheme of the URL. If the context is a {@link Features}, then the
-     * URL may contain substitution tokens in the format {FIELD_NAME} where
-     * FIELD_NAME is the name of a field in the first feature in the context. In
-     * this case, the {FIELD_NAME} is substituted with value of the FIELD_NAME
-     * field from the feature feature in the {@link Features}, e.g.
+     * for the scheme of the URL. If {@link Features} are included as context,
+     * then the URL may contain substitution tokens in the format {FIELD_NAME}
+     * where FIELD_NAME is the name of a field in the first feature in the
+     * context. In this case, the {FIELD_NAME} is substituted with value of the
+     * FIELD_NAME field from the feature feature in the {@link Features}, e.g.
      * https://www.google.com/search?q={NAME}, where the value of the NAME field
      * in the first feature from the context is 'Jasper National Park' would
      * produce the result https://www.google.com/search?q=Jasper National Park.
-     * Zero to many substitution tokens may be included.
+     * Zero to many substitution tokens may be included. If maps are included as
+     * context, {@link LocationToken} can be used to access properties on the
+     * first map's view. In Web, if both layers and maps are included as
+     * context, then {@link LayerToken} can be used to access properties on the
+     * first layer.
      *
-     * @mobileOnly
      */
-    get openUrl(): Command<OpenUrlArgs | string>;
+    get openUrl(): Command<OpenUrlArgs | WebOpenUrlArgs | string>;
     /**
      * Allows to control if the screen should be kept on. Passing true as parameter
      * will keep the screen on, ignoring possible system settings for screen timeouts.

package/messaging/registry/ui.d.ts

@@ -82,7 +82,7 @@ export interface DisplayNotificationArgs {
      */
     message: TranslatableText;
     /**
-     * The position of the notification on the screen.
+     * The position of the notification on the screen. Web only.
      */
     position?: Position;
     /**