@vertigis/viewer-spec 42.10.0

package/messaging/registry/auth.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var AuthenticationType;!function(e){e.UNKNOWN="Unknown",e.OAUTH_2="OAuth2",e.NETWORK="Network",e.TOKEN="Token"}(AuthenticationType||(AuthenticationType={}));export class AuthCommands extends CommandRegistry{get signIn(){return this._messages.command("auth.sign-in")}get signOut(){return this._messages.command("auth.sign-out")}}export class AuthOperations extends OperationRegistry{get getCurrentUser(){return this._messages.operation("auth.get-current-user")}get getExistingCredential(){return this._messages.operation("auth.get-existing-credential")}get isSignInAvailable(){return this._messages.operation("auth.is-sign-in-available")}}export class AuthEvents extends EventRegistry{get signInCancelled(){return this._messages.event("auth.sign-in-cancelled")}get signInCompleted(){return this._messages.event("auth.sign-in-completed")}get signInFailed(){return this._messages.event("auth.sign-in-failed")}get signInRequested(){return this._messages.event("auth.sign-in-requested")}get signOutCompleted(){return this._messages.event("auth.sign-out-completed")}get signOutRequested(){return this._messages.event("auth.sign-out-requested")}get tokenRefreshed(){return this._messages.event("auth.token-refreshed")}}

package/messaging/registry/basemap.d.ts

@@ -0,0 +1,52 @@
+import type { BasemapExtension } from "@vertigis/arcgis-extensions/mapping/BasemapExtension";
+import type { Command } from "../Command.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import { CommandRegistry } from "./../CommandRegistry.js";
+import type { BasemapsLike, MapsLike } from "./../common.js";
+export declare class BasemapCommands extends CommandRegistry {
+    /**
+     * Switch to a configured basemap.
+     */
+    get set(): Command<SetBasemapArgs>;
+}
+export declare class BasemapOperations extends OperationRegistry {
+    /**
+     * Gets all configured basemaps.
+     *
+     * Having argument:
+     * - Multiple maps: the union of all basemap options from each
+     * - No maps: the union of all basemap options for every map in the application.
+     */
+    get getAll(): Operation<MapsLike, BasemapExtension[]>;
+    /**
+     * Gets currently selected basemap for the given map.
+     * If more than one map is specified, only the first map is used.
+     */
+    get getCurrent(): Operation<MapsLike, BasemapExtension>;
+}
+/**
+ * Argument used in case when we have only 1 map in the app
+ * or when the first active map should be used.
+ * Basemap extension ID or the basemap self.
+ * If more than one basemap is specified, only the first one is used.
+ */
+export declare type SetBasemapArg = string | BasemapsLike;
+/**
+ * Argument used in case when we have more than 1 map in the app,
+ * and we need to pass the target map from outside (eg basemap picker in web viewer).
+ */
+export interface SetBasemapWithTargetMapArg {
+    /**
+     * Basemap to be set.
+     */
+    basemap: SetBasemapArg;
+    /**
+     * Target map.
+     */
+    map: MapsLike;
+}
+/**
+ * Argument used when setting current basemap in the app.
+ */
+export declare type SetBasemapArgs = SetBasemapArg | SetBasemapWithTargetMapArg;

package/messaging/registry/basemap.js

@@ -0,0 +1 @@
+import{OperationRegistry}from"../OperationRegistry.js";import{CommandRegistry}from"./../CommandRegistry.js";export class BasemapCommands extends CommandRegistry{get set(){return this._messages.command("basemap.set")}}export class BasemapOperations extends OperationRegistry{get getAll(){return this._messages.operation("basemap.get-all")}get getCurrent(){return this._messages.operation("basemap.get-current")}}

package/messaging/registry/charts.d.ts

@@ -0,0 +1,78 @@
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Features, HasFeatures, ModelRef } from "../common.js";
+/**
+ * Arguments for the charts.update-definition command.
+ */
+export interface UpdateChartDefinitionArgs {
+    /**
+     * The chart to update, referenced by chart model or its ID.
+     */
+    chart: ModelRef;
+    /**
+     * The Highcharts definition with which to update the chart.
+     */
+    definition: Highcharts.Options;
+}
+/**
+ * Arguments for various commands that affect a chart's features.
+ */
+export interface UpdateChartFeaturesArgs extends HasFeatures {
+    /**
+     * The chart(s) to update, referenced by layout ID or chart model.
+     */
+    chart: ModelRef;
+}
+export declare class ChartsCommands extends CommandRegistry {
+    /**
+     * Updates charts with provided features. Only activated charts that receive
+     * features from all required feature sources will displayed.
+     *
+     * @webOnly
+     */
+    get display(): Command<Features | UpdateChartFeaturesArgs>;
+    /**
+     * Adds one or more features to charts. If `chart` is specified, then only
+     * the given chart will be updated, otherwise all charts will.
+     *
+     * @webOnly
+     */
+    get addFeatures(): Command<Features | UpdateChartFeaturesArgs>;
+    /**
+     * Remove one or more features from active charts. If `chart` is specified,
+     * then only the given chart will be updated, otherwise all charts will.
+     *
+     * @webOnly
+     */
+    get removeFeatures(): Command<Features | UpdateChartFeaturesArgs>;
+    /**
+     * Clear features from active charts. If a chart is specified, then only
+     * the given chart will be updated, otherwise all charts will.
+     *
+     * @webOnly
+     */
+    get clear(): Command<ModelRef | void>;
+    /**
+     * Updates the definition of a chart.
+     *
+     * @webOnly
+     */
+    get updateDefinition(): Command<UpdateChartDefinitionArgs>;
+}
+export declare class ChartOperations extends OperationRegistry {
+    /**
+     * Returns the current set of features from all active charts.
+     *
+     * @webOnly
+     */
+    get getFeatures(): Operation<ModelRef | void, Features>;
+    /**
+     * Gets the definition of a chart that corresponds to the ID or the
+     * ChartModel instance that's passed in as an argument.
+     *
+     * @webOnly
+     */
+    get getDefinition(): Operation<ModelRef, Highcharts.Options>;
+}

package/messaging/registry/charts.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class ChartsCommands extends CommandRegistry{get display(){return this._messages.command("charts.display")}get addFeatures(){return this._messages.command("charts.add-features")}get removeFeatures(){return this._messages.command("charts.remove-features")}get clear(){return this._messages.command("charts.clear")}get updateDefinition(){return this._messages.command("charts.update-definition")}}export class ChartOperations extends OperationRegistry{get getFeatures(){return this._messages.operation("charts.get-features")}get getDefinition(){return this._messages.operation("charts.get-definition")}}

package/messaging/registry/debugConsole.d.ts

@@ -0,0 +1,24 @@
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+/**
+ * Deprecated; use LogViewerOperations instead.
+ *
+ *  @deprecated
+ *
+ */
+export declare class DebugConsoleOperations extends OperationRegistry {
+    /**
+     * Displays the Debug Console. Deprecated; use log-viewer.display instead.
+     *
+     * @mobileOnly
+     * @deprecated
+     */
+    get display(): Operation<void>;
+    /**
+     * Closes the Debug Console. Deprecated; use log-viewer.close instead.
+     *
+     * @mobileOnly
+     * @deprecated
+     */
+    get close(): Operation<void>;
+}

package/messaging/registry/debugConsole.js

@@ -0,0 +1 @@
+import{OperationRegistry}from"../OperationRegistry.js";export class DebugConsoleOperations extends OperationRegistry{get display(){return this._messages.operation("debug-console.display")}get close(){return this._messages.operation("debug-console.close")}}

package/messaging/registry/device.d.ts

@@ -0,0 +1,15 @@
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+/**
+ * Arguments for the "device.orientation-changed" event.
+ */
+export interface DeviceOrientationChangedEventArgs {
+}
+export declare class DeviceEvents extends EventRegistry {
+    /**
+     * Raised when the device's orientation changes.
+     *
+     * @mobileOnly
+     */
+    get orientationChanged(): Event<DeviceOrientationChangedEventArgs>;
+}

package/messaging/registry/device.js

@@ -0,0 +1 @@
+import{EventRegistry}from"../EventRegistry.js";export class DeviceEvents extends EventRegistry{get orientationChanged(){return this._messages.event("device.orientation-changed")}}

package/messaging/registry/display.d.ts

@@ -0,0 +1,16 @@
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+/**
+ * Arguments for the "display.overlap-element-translate-started" event.
+ */
+export interface ElementTranslationStartedArgs {
+}
+export declare class DisplayEvents extends EventRegistry {
+    /**
+     * Raised when one UI element is being moved overtop of another, such that
+     * the element underneath is partially or fully obscured.
+     *
+     * @mobileOnly
+     */
+    get overlapElementTranslateStarted(): Event<ElementTranslationStartedArgs>;
+}

package/messaging/registry/display.js

@@ -0,0 +1 @@
+import{EventRegistry}from"../EventRegistry.js";export class DisplayEvents extends EventRegistry{get overlapElementTranslateStarted(){return this._messages.event("display.overlap-element-translate-started")}}

package/messaging/registry/drawing.d.ts

@@ -0,0 +1,126 @@
+import type LineSymbol3D from "@arcgis/core/symbols/LineSymbol3D";
+import type PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol";
+import type PictureMarkerSymbol from "@arcgis/core/symbols/PictureMarkerSymbol";
+import type PointSymbol3D from "@arcgis/core/symbols/PointSymbol3D";
+import type PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D";
+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 Symbol from "@arcgis/core/symbols/Symbol";
+import type { LineSymbol3D as LineSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/LineSymbol3D";
+import type { PictureFillSymbol as PictureFillSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureFillSymbol";
+import type { PictureMarkerSymbol as PictureMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/PictureMarkerSymbol";
+import type { PointSymbol3D as PointSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/PointSymbol3D";
+import type { PolygonSymbol3D as PolygonSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/PolygonSymbol3D";
+import type { SimpleFillSymbol as SimpleFillSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleFillSymbol";
+import type { SimpleLineSymbol as SimpleLineSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleLineSymbol";
+import type { SimpleMarkerSymbol as SimpleMarkerSymbolProperties } from "@vertigis/arcgis-extensions/portal/SimpleMarkerSymbol";
+import type { GeometryType } from "@vertigis/arcgis-extensions/support/esri";
+import type { SymbolPresetProperties } from "../../app-config/web/DrawModelProperties.js";
+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, GeometryLike, HasFeatures, HasGraphics, HasLayers, HasMaps, HasSymbol, SymbolLike } from "../common.js";
+/**
+ * Symbols supported for drawing.
+ */
+export declare type DrawingSymbolConfig = SimpleMarkerSymbol | SimpleMarkerSymbolProperties | PictureMarkerSymbol | PictureMarkerSymbolProperties | SimpleLineSymbol | SimpleLineSymbolProperties | SimpleFillSymbol | SimpleFillSymbolProperties | PictureFillSymbol | PictureFillSymbolProperties | PointSymbol3D | PointSymbol3DProperties | LineSymbol3D | LineSymbol3DProperties | PolygonSymbol3D | PolygonSymbol3DProperties;
+/**
+ * Arguments for the drawing.get-symbol operation. Only available in Geocortex
+ * Web.
+ */
+export interface GetDefaultSymbolArgs {
+    /**
+     * The geometry type for the default symbol to retrieve.
+     */
+    geometryType?: GeometryType;
+}
+/**
+ * Arguments for the drawing.edit-symbol operation. Only available in Geocortex
+ * Web.
+ */
+export interface EditSymbolArgs extends HasMaps, HasLayers, HasGraphics, HasFeatures {
+    /**
+     * The geometry type for the symbol to create.
+     */
+    geometryType?: GeometryType;
+    /**
+     * The symbol to edit. (Currently supports only SimpleLineSymbol and
+     * SimpleFillSymbol).
+     */
+    symbol?: Symbol;
+    /**
+     * Symbol presets that can be assigned to a graphic. If defined, these
+     * presets will override any that are configured in the DrawService.
+     */
+    symbolPresets?: SymbolPresetProperties[];
+    /**
+     * If the fine-grain controls should be hidden and only the symbol presets
+     * should be shown. If no valid symbol presets are configured, this property
+     * will be ignored. Default is false. If defined, this will override the
+     * value of the DrawService's 'showOnlySymbolPresets' property.
+     */
+    showOnlySymbolPresets?: boolean;
+}
+/**
+ * Arguments for the drawing.edit-symbol operation. Only available in Geocortex
+ * Web.
+ */
+export interface EditSymbolResult extends HasMaps, HasLayers, HasGraphics, HasFeatures {
+    /**
+     * The symbol that is the result of the operation.
+     */
+    symbol: Symbol;
+}
+export declare class DrawingCommands extends CommandRegistry {
+    /**
+     * Sets a value that determines whether drawings will be synced
+     * automatically across maps.
+     */
+    get setSync(): Command<boolean>;
+    /**
+     * 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
+     * WebMap JSON.
+     *
+     * @webOnly
+     */
+    get setDefaultSymbol(): Command<SymbolLike | HasSymbol>;
+    /**
+     * Sets the symbol on a collection of Graphics. The symbol can be configured
+     * with an instance of the Esri symbol or with the Esri WebMap JSON.
+     *
+     * @webOnly
+     */
+    get setSymbol(): Command<HasSymbol & HasGraphics>;
+}
+export declare class DrawingOperations extends OperationRegistry {
+    /**
+     * Creates graphics out of geometries with the current symbols that are set
+     * on the DrawManager.
+     *
+     * @webOnly
+     */
+    get createGraphics(): Operation<GeometryLike, CreateGraphicsResult>;
+    /**
+     * Gets the value of the default point, line, or polygon symbol for the
+     * provided geometry type.
+     *
+     * @webOnly
+     */
+    get getDefaultSymbol(): Operation<GetDefaultSymbolArgs | GeometryType, DrawingSymbolConfig>;
+    /**
+     * Gets the value of the default 3D point, line, or polygon symbol for the
+     * provided geometry type.
+     *
+     * @webOnly
+     */
+    get getDefaultSymbol3D(): Operation<GetDefaultSymbolArgs | GeometryType, DrawingSymbolConfig>;
+    /**
+     * Opens the symbol editor toolbox for the specified geometry or type.
+     *
+     * @webOnly
+     */
+    get editSymbol(): Operation<EditSymbolArgs | Symbol, EditSymbolResult>;
+}

package/messaging/registry/drawing.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class DrawingCommands extends CommandRegistry{get setSync(){return this._messages.command("drawing.set-sync")}get setDefaultSymbol(){return this._messages.command("drawing.set-default-symbol")}get setSymbol(){return this._messages.command("drawing.set-symbol")}}export class DrawingOperations extends OperationRegistry{get createGraphics(){return this._messages.operation("drawing.create-graphics")}get getDefaultSymbol(){return this._messages.operation("drawing.get-default-symbol")}get getDefaultSymbol3D(){return this._messages.operation("drawing.get-default-symbol-3d")}get editSymbol(){return this._messages.operation("drawing.edit-symbol")}}

package/messaging/registry/edit.d.ts

@@ -0,0 +1,123 @@
+import type { Attachment } from "@vertigis/arcgis-extensions/data/Attachment";
+import type { Feature } from "@vertigis/arcgis-extensions/data/Feature";
+import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
+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";
+/**
+ * Arguments for the "edit.add-attachment" command.
+ */
+export interface AddAttachmentArgs {
+    /**
+     * The map.
+     */
+    maps: MapsLike;
+    /**
+     * The feature(s) to add the attachment to.
+     */
+    features: Feature[];
+    /**
+     * The name of the attachment.
+     */
+    name: string;
+    /**
+     * The MIME content type of the attachment.
+     */
+    contentType: string;
+    /**
+     * The binary data for the attachment.
+     */
+    data: number[];
+}
+/**
+ * Arguments for various attachment events.
+ */
+export interface AttachmentEventArgs {
+    /**
+     * The feature that had an attachment added/updated/deleted.
+     */
+    feature: Feature;
+    /**
+     * The attachment that was added/updated/deleted.
+     */
+    attachment: Attachment;
+}
+export declare class EditCommands extends CommandRegistry {
+    /**
+     * Create and add an attachment to a provided feature, using the given
+     * attachment data.
+     *
+     * @mobileOnly
+     */
+    get addAttachment(): Command<AddAttachmentArgs>;
+    /**
+     * Adds a feature to a particular layer.
+     *
+     * @mobileOnly
+     */
+    get addFeature(): Command<Feature>;
+    /**
+     * Deletes the given feature or features from their feature sources.
+     *
+     * @mobileOnly
+     */
+    get deleteFeatures(): Command<Feature | Feature[]>;
+    /**
+     * Display a form for adding a feature.
+     *
+     * @mobileOnly
+     */
+    get displayAddFeature(): Command<FeatureSource>;
+    /**
+     * Display a form for updating a feature.
+     *
+     * @mobileOnly
+     */
+    get displayUpdateFeature(): Command<Feature>;
+    /**
+     * Updates a feature.
+     *
+     * @mobileOnly
+     */
+    get updateFeature(): Command<Feature>;
+}
+export declare class EditEvents extends EventRegistry {
+    /**
+     * Raised when an attachment is added to a feature.
+     *
+     * @mobileOnly
+     */
+    get attachmentAdded(): Event<AttachmentEventArgs>;
+    /**
+     * Raised when an attachment is updated.
+     *
+     * @mobileOnly
+     */
+    get attachmentUpdated(): Event<AttachmentEventArgs>;
+    /**
+     * Raised when an attachment is deleted from a feature.
+     *
+     * @mobileOnly
+     */
+    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>;
+}