@vertigis/viewer-spec 49.9.0 → 50.1.0

package/app-config/web/ResultsModelProperties.d.ts

@@ -8,7 +8,7 @@ import type { FeatureListProperties } from "./FeatureListProperties.js";
 export interface ResultsModelProperties extends CommonResultsModelProperties, ComponentModelProperties {
     /**
      * A command or set of commands to execute when all features have been
-     * removed. This action is only supported in Geocortex Mobile Viewer.
+     * removed. This action is only supported in VertiGIS Studio Mobile.
      */
     onAllFeaturesRemoved?: Action;
     /**

package/app-config/web/VertigisWebModelProperties.d.ts

@@ -53,12 +53,11 @@ export interface VertigisWebModelProperties extends ApplicationModelProperties {
      */
     trustedServers?: string[];
     /**
-     * The version of the Geocortex Web Viewer that was used to create this app
-     * configuration.
+     * The version of VertiGIS Studio Web that was used to create this app configuration.
      */
     version?: string;
     /**
-     * The active layout of the Geocortex Web Viewer. This property is only
+     * The active layout of VertiGIS Studio Web. This property is only
      * serialized to saved projects.
      */
     layout?: ItemRef;

package/docs/presentation.md

@@ -1,13 +1,14 @@
 # Presentation
 
 This document describes the syntax and semantics for presentation attributes:
-* Margin
-* Padding
-* Width
-* Height
-* Grow
-* Horizontal alignment
-* Vertical alignment
+
+-   Margin
+-   Padding
+-   Width
+-   Height
+-   Grow
+-   Horizontal alignment
+-   Vertical alignment
 
 ## Applicability
 
@@ -15,15 +16,16 @@ All attributes apply to all components unless otherwise stated.
 
 ## Units
 
-All dimensional units are expressed in 'em's, unless specified otherwise, where 1 em is equal to the current font size. 
+All dimensional units are expressed in 'em's, unless specified otherwise, where 1 em is equal to the current font size.
 
 ## Margin
 
 **Attribute name**: "margin".  
 **Expected value**: Either 0 or a positive number (integer or floating point).  
-**Description**: Sets the size of the white space outside of the component.  
+**Description**: Sets the size of the white space outside of the component.
 
 **Example**:
+
 ```
 <map margin="1.5"/> <!-- Sets the margin on a map to be equal to 1.5x the current font size -->
 ```
@@ -33,9 +35,10 @@ All dimensional units are expressed in 'em's, unless specified otherwise, where
 **Attribute name**: "padding".  
 **Expected value**: Either 0 or a positive number (integer or floating point).  
 **Description**: Sets the size of the white space between a component and its content.  
-**Applies to**: In the Geocortex Mobile Viewer, this attribute will only apply to components with children, due to technical restrictions.  
+**Applies to**: In VertiGIS Studio Mobile, this attribute will only apply to components with children, due to technical restrictions.
 
 **Example**:
+
 ```
 <stack padding="0.5"/> <!-- Sets the padding on a stack to be equal to 0.5x the current font size -->
 ```
@@ -43,35 +46,38 @@ All dimensional units are expressed in 'em's, unless specified otherwise, where
 ## Width and Height
 
 **Attribute name**: "width".  
-**Expected value**: Em units: Either 0 or a positive number (integer or floating point). Example: 12.  
+**Expected value**: Em units: Either 0 or a positive number (integer or floating point). Example: 12.
 
 **Default value**: If a width is not set, then the width shall be the natural width of the component (however much space it needs).  
-**Description**: Sets the width of a component. If em units, then the width is a literal value.  
+**Description**: Sets the width of a component. If em units, then the width is a literal value.
 
 **Attribute name**: "height".  
-**Expected value**: Em units: Either 0 or a positive number (integer or floating point). Example: 12.  
+**Expected value**: Em units: Either 0 or a positive number (integer or floating point). Example: 12.
 
-**Description**: Sets the height of a component. If em units, then the height is a literal value.  
+**Description**: Sets the height of a component. If em units, then the height is a literal value.
 
 **Example**:
+
 ```
 <!-- Sets the width of a map to 30em, and the height to 20em. -->
-<map width="30em" height="20"/> 
+<map width="30em" height="20"/>
 ```
 
 ## Grow
 
 **Attribute name**: "grow".  
 **Expected value**: Either 0 or a positive number (integer or floating point).  
-**Description**: Sets whether or not a component's width or height will grow over its parents primary axis. Components with a grow of 0 will fill to their natural or requested height. Components with a specified grow will fill up a  percentage of the remaining space equal to their grow value divided by the total grow of all sibling components  (including the component in question).  
+**Description**: Sets whether or not a component's width or height will grow over its parents primary axis. Components with a grow of 0 will fill to their natural or requested height. Components with a specified grow will fill up a percentage of the remaining space equal to their grow value divided by the total grow of all sibling components (including the component in question).  
 The default value for a component varies by component. For most components, if no grow value is specified, they will default to a grow value of "0". The following components however will have a default grow value of "1":
-* Map 
-* Stack
-* Split
+
+-   Map
+-   Stack
+-   Split
 
 **Applies to**: All components may specify this value, but it will only take effect if the component is a child of a split or a stack. For stacks, grow indicates how the child grows along the vertical axis. For splits, grow indicates how the child grows along the horizontal axis.
 
 **Example**:
+
 ```
 <stack>
     <!-- Heading will take up whatever vertical space it requires, and will occupy its natural width. -->
@@ -83,16 +89,17 @@ The default value for a component varies by component. For most components, if n
 </stack>
 ```
 
-## Alignment 
+## Alignment
 
 **Attribute name**: "halign".  
 **Expected value**: One of: "start", "center", or "end"  
-**Description**: Describes how the content of a component is aligned. For stacks and splits, the content is the child components. For a component like text, the content is the text itself.    
+**Description**: Describes how the content of a component is aligned. For stacks and splits, the content is the child components. For a component like text, the content is the text itself.
 
 **Attribute name**: "valign".  
 **Expected value**: One of: "start", "center", or "end"  
-**Description**: Describes how the content of a component is aligned. For stacks and splits, the content is the child components. For a component like text, the content is the text itself.  
+**Description**: Describes how the content of a component is aligned. For stacks and splits, the content is the child components. For a component like text, the content is the text itself.
 
 ### Effect on cross-axis stretching
+
 All components will stretch across the cross-axis if the corresponding alignment attribute (halign for stacks, valign for splits) is not set on the parent of that componet. But if a cross-axis alignment is set, then they will no longer stretch across the cross axis (otherwise the effect of alignment would not be observed).  
-Some components will stretch across the cross-axis even if the cross-axis alignment is set on the parent: map, stack, split.  
+Some components will stretch across the cross-axis even if the cross-axis alignment is set on the parent: map, stack, split.

package/messaging/DotNetTypes.d.ts

@@ -0,0 +1,4 @@
+export interface TimeSpan {
+}
+export interface ConsoleKeyInfo {
+}

package/messaging/DotNetTypes.js

@@ -0,0 +1 @@
+export{};

package/messaging/common.d.ts

@@ -15,6 +15,7 @@ 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";
 import type { FeatureSet } from "@vertigis/arcgis-extensions/data/FeatureSet";
+import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
 import type { FeatureStream } from "@vertigis/arcgis-extensions/data/FeatureStream";
 import type { BasemapExtension } from "@vertigis/arcgis-extensions/mapping/BasemapExtension";
 import type { Bookmark, BookmarkProperties } from "@vertigis/arcgis-extensions/mapping/Bookmark";
@@ -34,6 +35,7 @@ import type { SimpleMarkerSymbol as SimpleMarkerSymbolProperties } from "@vertig
 import type { Viewpoint as ViewpointJson } from "@vertigis/arcgis-extensions/portal/Viewpoint";
 import type { SublayerLike } from "@vertigis/arcgis-extensions/support/esri";
 import type { ItemRef } from "app-config/common/ItemRef";
+import type { TimeSpan } from "./DotNetTypes";
 /**
  * A model belonging to a component.
  */
@@ -60,6 +62,11 @@ export interface CreateGraphicsResult {
  * Represents one or more features.
  */
 export declare type FeaturesLike = Feature | FeatureSet | FeatureList | FeatureStream | (Feature | FeatureProperties)[];
+/**
+ * Feature results from an operation.
+ */
+export interface Results extends HasFeatures, HasMaps {
+}
 /**
  * Defines an object that has a `features` property.
  */
@@ -70,9 +77,53 @@ export interface HasFeatures {
     features?: FeaturesLike;
 }
 /**
- * Feature results from an operation.
+ * Defines an object that has a `maps` property and a `features` property.
  */
-export interface Results extends HasFeatures, HasMaps {
+export interface HasMapsAndFeatures extends HasMaps, HasFeatures {
+}
+/**
+ * Event args for any events that contain results that were obtained for from a
+ * map operation.
+ */
+export interface MapsFeatureResultArgs extends HasMapsAndFeatures {
+    /**
+     * The type of operation that created these results.
+     */
+    sourceOperation: SourceOperation;
+    /**
+     * The error associated with these results if there is one.
+     */
+    error: Error;
+    /**
+     * The original geometry associated with the event. The original geometry
+     * pertains to the original input geometry that was passed into the
+     * operation before the event was generated.
+     */
+    originalGeometry: Geometry;
+    /**
+     * The geometry associated with the event. This may be an alteration of the
+     * original geometry (eg. Buffered).
+     */
+    geometry: Geometry;
+    /**
+     * The feature sources that were used to produce the result.
+     */
+    sources: FeatureSource[];
+    /**
+     * The amount of time that it took to perform the operation.
+     */
+    duration: TimeSpan;
+}
+/**
+ * Describes the source of results.
+ */
+export declare enum SourceOperation {
+    UNKNOWN = "Unknown",
+    IDENTIFY = "Identify",
+    SEARCH = "Search",
+    ADD = "Add",
+    WORKFLOW = "Workflow",
+    GEOCODE = "Geocode"
 }
 /**
  * One or more features, or an object that has features.

package/messaging/common.js

@@ -1 +1 @@
-export{};
+export var SourceOperation;!function(o){o.UNKNOWN="Unknown",o.IDENTIFY="Identify",o.SEARCH="Search",o.ADD="Add",o.WORKFLOW="Workflow",o.GEOCODE="Geocode"}(SourceOperation||(SourceOperation={}));

package/messaging/mobile.d.ts

@@ -1,13 +1,6 @@
-import type { MapsLike } from "./common.js";
 export interface Photo {
 }
 export interface VisualElement {
 }
-/**
- * One or more map extensions.
- */
-export interface MapExtensionArgs {
-    maps: MapsLike;
-}
-export interface MapExtensionFeatureArgs {
+export interface ArcGISPortalIdentity {
 }

package/messaging/registry/Events.d.ts

@@ -2,6 +2,7 @@ import { EventRegistry } from "../EventRegistry.js";
 import { AppConfigEvents } from "./app-config.js";
 import { AppEvents } from "./app.js";
 import { AuthEvents } from "./auth.js";
+import { BookmarkEvents } from "./bookmark.js";
 import { DeviceEvents } from "./device.js";
 import { DisplayEvents } from "./display.js";
 import { EditEvents } from "./edit.js";
@@ -20,6 +21,8 @@ import { RegionEvents } from "./region.js";
 import { ReportEvents } from "./reports.js";
 import { ResultsEvents } from "./results.js";
 import { SearchEvents } from "./search.js";
+import { SettingsEvents } from "./settings.js";
+import { ShortcutEvents } from "./shortcut.js";
 import { TasksEvents } from "./tasks.js";
 import { UIEvents } from "./ui.js";
 import { ViewerEvents } from "./viewer.js";
@@ -28,6 +31,7 @@ export declare class Events extends EventRegistry {
     readonly app: AppEvents;
     readonly appConfig: AppConfigEvents;
     readonly auth: AuthEvents;
+    readonly bookmarks: BookmarkEvents;
     readonly device: DeviceEvents;
     readonly display: DisplayEvents;
     readonly edit: EditEvents;
@@ -46,6 +50,8 @@ export declare class Events extends EventRegistry {
     readonly reports: ReportEvents;
     readonly results: ResultsEvents;
     readonly search: SearchEvents;
+    readonly settings: SettingsEvents;
+    readonly shortcuts: ShortcutEvents;
     readonly tasks: TasksEvents;
     readonly ui: UIEvents;
     readonly viewer: ViewerEvents;

package/messaging/registry/Events.js

@@ -1 +1 @@
-import{EventRegistry}from"../EventRegistry.js";import{AppConfigEvents}from"./app-config.js";import{AppEvents}from"./app.js";import{AuthEvents}from"./auth.js";import{DeviceEvents}from"./device.js";import{DisplayEvents}from"./display.js";import{EditEvents}from"./edit.js";import{GeolocationEvents}from"./geolocation.js";import{InputEvents}from"./input.js";import{LayersEvents}from"./layers.js";import{LayoutEvents}from"./layout.js";import{LocationMarkerEvents}from"./location-marker.js";import{MapEvents}from"./map.js";import{OfflineEvents}from"./offline.js";import{PanelEvents}from"./panel.js";import{PhotosEvents}from"./photos.js";import{PortalEvents}from"./portal.js";import{PrintEvents}from"./printing.js";import{RegionEvents}from"./region.js";import{ReportEvents}from"./reports.js";import{ResultsEvents}from"./results.js";import{SearchEvents}from"./search.js";import{TasksEvents}from"./tasks.js";import{UIEvents}from"./ui.js";import{ViewerEvents}from"./viewer.js";import{WorkflowEvents}from"./workflow.js";export class Events extends EventRegistry{constructor(){super(...arguments),this.app=new AppEvents(this._messages),this.appConfig=new AppConfigEvents(this._messages),this.auth=new AuthEvents(this._messages),this.device=new DeviceEvents(this._messages),this.display=new DisplayEvents(this._messages),this.edit=new EditEvents(this._messages),this.geolocation=new GeolocationEvents(this._messages),this.input=new InputEvents(this._messages),this.layers=new LayersEvents(this._messages),this.layout=new LayoutEvents(this._messages),this.locationMarker=new LocationMarkerEvents(this._messages),this.map=new MapEvents(this._messages),this.offline=new OfflineEvents(this._messages),this.panel=new PanelEvents(this._messages),this.photos=new PhotosEvents(this._messages),this.portal=new PortalEvents(this._messages),this.printing=new PrintEvents(this._messages),this.region=new RegionEvents(this._messages),this.reports=new ReportEvents(this._messages),this.results=new ResultsEvents(this._messages),this.search=new SearchEvents(this._messages),this.tasks=new TasksEvents(this._messages),this.ui=new UIEvents(this._messages),this.viewer=new ViewerEvents(this._messages),this.workflow=new WorkflowEvents(this._messages)}}
+import{EventRegistry}from"../EventRegistry.js";import{AppConfigEvents}from"./app-config.js";import{AppEvents}from"./app.js";import{AuthEvents}from"./auth.js";import{BookmarkEvents}from"./bookmark.js";import{DeviceEvents}from"./device.js";import{DisplayEvents}from"./display.js";import{EditEvents}from"./edit.js";import{GeolocationEvents}from"./geolocation.js";import{InputEvents}from"./input.js";import{LayersEvents}from"./layers.js";import{LayoutEvents}from"./layout.js";import{LocationMarkerEvents}from"./location-marker.js";import{MapEvents}from"./map.js";import{OfflineEvents}from"./offline.js";import{PanelEvents}from"./panel.js";import{PhotosEvents}from"./photos.js";import{PortalEvents}from"./portal.js";import{PrintEvents}from"./printing.js";import{RegionEvents}from"./region.js";import{ReportEvents}from"./reports.js";import{ResultsEvents}from"./results.js";import{SearchEvents}from"./search.js";import{SettingsEvents}from"./settings.js";import{ShortcutEvents}from"./shortcut.js";import{TasksEvents}from"./tasks.js";import{UIEvents}from"./ui.js";import{ViewerEvents}from"./viewer.js";import{WorkflowEvents}from"./workflow.js";export class Events extends EventRegistry{constructor(){super(...arguments),this.app=new AppEvents(this._messages),this.appConfig=new AppConfigEvents(this._messages),this.auth=new AuthEvents(this._messages),this.bookmarks=new BookmarkEvents(this._messages),this.device=new DeviceEvents(this._messages),this.display=new DisplayEvents(this._messages),this.edit=new EditEvents(this._messages),this.geolocation=new GeolocationEvents(this._messages),this.input=new InputEvents(this._messages),this.layers=new LayersEvents(this._messages),this.layout=new LayoutEvents(this._messages),this.locationMarker=new LocationMarkerEvents(this._messages),this.map=new MapEvents(this._messages),this.offline=new OfflineEvents(this._messages),this.panel=new PanelEvents(this._messages),this.photos=new PhotosEvents(this._messages),this.portal=new PortalEvents(this._messages),this.printing=new PrintEvents(this._messages),this.region=new RegionEvents(this._messages),this.reports=new ReportEvents(this._messages),this.results=new ResultsEvents(this._messages),this.search=new SearchEvents(this._messages),this.settings=new SettingsEvents(this._messages),this.shortcuts=new ShortcutEvents(this._messages),this.tasks=new TasksEvents(this._messages),this.ui=new UIEvents(this._messages),this.viewer=new ViewerEvents(this._messages),this.workflow=new WorkflowEvents(this._messages)}}

package/messaging/registry/app.d.ts

@@ -1,28 +1,33 @@
 import type { AppConfig } from "../../app-config/index.js";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
+import type * as DotNetTypes from "../DotNetTypes.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 { Blob } from "../common.js";
 /**
- * Information about a specific app. Only available in the Geocortex Mobile Viewer.
+ * Information about a specific app. Only available in VertiGIS Studio Mobile.
  */
 export interface GcxAppInfo {
 }
 /**
- * Arguments for the app started events. Only available in the Geocortex Mobile Viewer.
+ * Arguments for the app started events. Only available in VertiGIS Studio Mobile.
  */
 export interface SpecificAppArgs {
     /**
      * A unique identifier for the app.
      */
     uniqueKey: string;
+    /**
+     * The amount of time that the app took to load.
+     */
+    loadTime: DotNetTypes.TimeSpan;
 }
 /**
- * Arguments for the app.generic.apps-listed event. Only available in the
- * Geocortex Mobile Viewer.
+ * Arguments for the app.generic.apps-listed event. Only available in VertiGIS
+ * Studio Mobile.
  */
 export interface GenericAppsListedArgs {
     /**
@@ -48,8 +53,8 @@ export interface GenericAppsListedArgs {
 }
 export declare class AppCommands extends CommandRegistry {
     /**
-     * Returns to the Geocortex Go view where the user can select a different
-     * app. Only enabled if the current app was launched through Geocortex Go.
+     * Returns to the app selector view where the user can select a different
+     * app. Only enabled if the current app was launched through VertiGIS Studio Go.
      *
      * @mobileOnly
      */
@@ -116,25 +121,8 @@ export declare class AppEvents extends EventRegistry {
      */
     get interrupted(): Event;
     /**
-     * Raised when a custom app is started.
-     *
-     * @mobileOnly
-     */
-    get customStarted(): Event<SpecificAppArgs>;
-    /**
-     * Raised when a generic app is started.
-     *
-     * @mobileOnly
-     */
-    get genericAppStarted(): Event;
-    /**
-     * Raised when a specific app is started within the generic app.
-     *
-     * @mobileOnly
-     */
-    get specificAppStarted(): Event<SpecificAppArgs>;
-    /**
-     * Raised when returning to the app selector screen from a specific app in Go.
+     * Raised when returning to the app selector screen from a specific app in
+     * VertiGIS Studio Go.
      *
      * @mobileOnly
      */
@@ -174,17 +162,29 @@ export declare class AppCustomEvents extends EventRegistry {
 }
 export declare class AppGenericEvents extends EventRegistry {
     /**
-     * Raised when a generic app is started.
+     * Raised when apps are listed within VertiGIS Studio Go.
      *
      * @mobileOnly
      */
-    get started(): Event;
+    get appsListed(): Event<GenericAppsListedArgs>;
     /**
-     * Raised when apps are listed within the generic app.
+     * Raised before a specific app starts within VertiGIS Studio Go.
      *
      * @mobileOnly
      */
-    get appsListed(): Event<GenericAppsListedArgs>;
+    get specificAppStarting(): Event<SpecificAppArgs>;
+    /**
+     * Raised when a specific app is started within VertiGIS Studio Go.
+     *
+     * @mobileOnly
+     */
+    get specificAppStarted(): Event<SpecificAppArgs>;
+    /**
+     * Raised when a generic app is started.
+     *
+     * @mobileOnly
+     */
+    get started(): Event;
 }
 export declare class AppOperations extends OperationRegistry {
     /**
@@ -207,7 +207,7 @@ export declare class AppOperations extends OperationRegistry {
 }
 /**
  * Arguments for the reading app.*-persistent-data operations. Only available in
- * the Geocortex Mobile Viewer.
+ * VertiGIS Studio Mobile.
  */
 export interface StorageDataArgs {
     /**
@@ -220,8 +220,8 @@ export interface StorageDataArgs {
     scope?: StorageScope;
 }
 /**
- * Arguments for the app.set-persistent-data operations. Only available in the
- * Geocortex Mobile Viewer.
+ * Arguments for the app.set-persistent-data operations. Only available in
+ * VertiGIS Studio Mobile.
  */
 export interface SaveStorageDataArgs extends StorageDataArgs {
     /**

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 setPersistentData(){return this._messages.command("app.set-persistent-data")}get removePersistentData(){return this._messages.command("app.remove-persistent-data")}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 interrupted(){return this._messages.event("app.interrupted")}get customStarted(){return this._messages.event("app.custom.started")}get genericAppStarted(){return this._messages.event("app.generic.started")}get specificAppStarted(){return this._messages.event("app.generic.specific-app-started")}get goingToAppSelector(){return this._messages.event("app.navigating-to-app-selector")}get refreshed(){return this._messages.event("app.refreshed")}get refreshing(){return this._messages.event("app.refreshing")}get favorited(){return this._messages.event("app.favorited")}get unfavorited(){return this._messages.event("app.unfavorited")}}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")}get getPersistentData(){return this._messages.operation("app.get-persistent-data")}}var StorageScope;!function(e){e.GLOBAL="global",e.APP="app",e.MEMORY="memory"}(StorageScope||(StorageScope={}));
+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 setPersistentData(){return this._messages.command("app.set-persistent-data")}get removePersistentData(){return this._messages.command("app.remove-persistent-data")}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 interrupted(){return this._messages.event("app.interrupted")}get goingToAppSelector(){return this._messages.event("app.navigating-to-app-selector")}get refreshed(){return this._messages.event("app.refreshed")}get refreshing(){return this._messages.event("app.refreshing")}get favorited(){return this._messages.event("app.favorited")}get unfavorited(){return this._messages.event("app.unfavorited")}}export class AppCustomEvents extends EventRegistry{get started(){return this._messages.event("app.custom.started")}}export class AppGenericEvents extends EventRegistry{get appsListed(){return this._messages.event("app.generic.apps-listed")}get specificAppStarting(){return this._messages.event("app.generic.specific-app-starting")}get specificAppStarted(){return this._messages.event("app.generic.specific-app-started")}get started(){return this._messages.event("app.generic.started")}}export class AppOperations extends OperationRegistry{get getVersion(){return this._messages.operation("app.get-version")}get createProject(){return this._messages.operation("app.create-project")}get getPersistentData(){return this._messages.operation("app.get-persistent-data")}}var StorageScope;!function(e){e.GLOBAL="global",e.APP="app",e.MEMORY="memory"}(StorageScope||(StorageScope={}));

package/messaging/registry/auth.d.ts

@@ -8,6 +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 { ArcGISPortalIdentity } from "../mobile.js";
 /**
  * A type of authentication.
  */
@@ -27,20 +28,45 @@ export interface Principal {
     portalUser: PortalUser;
 }
 /**
- * Arguments for the auth.sign-in events. Only available in the Geocortex Mobile Viewer.
+ * Arguments for the auth.sign-in events. Only available in VertiGIS Studio Mobile.
  */
 export interface SignInEventArgs {
     /**
      * The authentication method used for the sign in process. Not available in
-     * Geocortex Web Viewer.
+     * VertiGIS Studio Web.
      */
     authenticationType: AuthenticationType;
     /**
      * Information about the resource that is required to sign in. Not available
-     * in Geocortex Web Viewer. Will be an instance of
-     * esri.security.CredentialRequestInfo for the Geocortex Mobile Viewer.
+     * in VertiGIS Studio Web. Will be an instance of
+     * esri.security.CredentialRequestInfo for VertiGIS Studio Mobile.
      */
     requestInfo: unknown;
+    /**
+     * The type of Portal: AGOL or Enterprise.
+     */
+    portalType: PortalType;
+}
+/**
+ * The type of Portal.
+ */
+export declare enum PortalType {
+    ARCGIS_ENTERPRISE = "ArcGISEnterprise",
+    AGOL = "AGOL"
+}
+/**
+ * Arguments for the auth.sign-in-completed and auth.portal-sign-in-completed
+ * events. Only available in VertiGIS Studio Mobile.
+ */
+export interface SignInCompletedEventArgs {
+    /**
+     * The credential resulting from the sign in.
+     */
+    credential: Credential;
+    /**
+     * The identity that was obtained from the sign in.
+     */
+    identity: ArcGISPortalIdentity;
 }
 /**
  * Arguments for the auth.sign-in-failed event. Only available in the Geocortex
@@ -48,8 +74,8 @@ export interface SignInEventArgs {
  */
 export interface SignInFailedEventArgs extends SignInEventArgs {
     /**
-     * The exception that occurred during the sign in. Not available in
-     * Geocortex Web Viewer.
+     * The exception that occurred during the sign in. Not available in VertiGIS
+     * Studio Web.
      */
     exception: unknown;
 }
@@ -57,13 +83,13 @@ export declare class AuthCommands extends CommandRegistry {
     /**
      * Initiates user sign-in if they aren't already signed in. The argument
      * indicates whether or not the map should be reloaded when the sign-in is
-     * complete. This argument is optional and only supported by Geocortex Mobile Viewer.
+     * complete. This argument is optional and only supported by VertiGIS Studio Mobile.
      */
     get signIn(): Command<boolean | void>;
     /**
      * Signs the user out. The argument indicates whether or not the map should
      * be reloaded when the sign-out is complete. This argument is optional and
-     * only supported by Geocortex Mobile Viewer.
+     * only supported by VertiGIS Studio Mobile.
      */
     get signOut(): Command<boolean | void>;
 }
@@ -94,9 +120,16 @@ export declare class AuthEvents extends EventRegistry {
      */
     get signInCancelled(): Event<SignInEventArgs>;
     /**
-     * Raised when successfully signed in.
+     * Raised when successfully signed in. Principal event type used in Web,
+     * SignInCompletedEventArgs used in Mobile.
+     */
+    get signInCompleted(): Event<Principal | SignInCompletedEventArgs>;
+    /**
+     * Raised when the user has signed into a Portal (AGOL or Portal for ArcGIS).
+     *
+     * @mobileOnly
      */
-    get signInCompleted(): Event<Principal>;
+    get portalSignInCompleted(): Event<SignInCompletedEventArgs>;
     /**
      * Raised when a sign-in attempt fails.
      */
@@ -115,7 +148,7 @@ export declare class AuthEvents extends EventRegistry {
     get signOutRequested(): Event;
     /**
      * Raised when the user's token is refreshed. Will be the new token in the
-     * Geocortex Web Viewer, and a TokenCredential object in the Geocortex Mobile Viewer.
+     * VertiGIS Studio Web, and a TokenCredential object in VertiGIS Studio Mobile.
      */
     get tokenRefreshed(): Event<string>;
 }

package/messaging/registry/auth.js

@@ -1 +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")}}
+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 var PortalType;!function(e){e.ARCGIS_ENTERPRISE="ArcGISEnterprise",e.AGOL="AGOL"}(PortalType||(PortalType={}));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 portalSignInCompleted(){return this._messages.event("auth.portal-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

@@ -1,9 +1,12 @@
 import type { BasemapExtension } from "@vertigis/arcgis-extensions/mapping/BasemapExtension";
 import type { Command } from "../Command.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 import { CommandRegistry } from "./../CommandRegistry.js";
 import type { BasemapsLike, MapsLike } from "./../common.js";
+import type { MapEvent } from "./map.js";
 export declare class BasemapCommands extends CommandRegistry {
     /**
      * Switch to a configured basemap.
@@ -34,7 +37,7 @@ export declare class BasemapOperations extends OperationRegistry {
 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).
+ * pass the target map from outside (eg basemap picker in VertiGIS Studio Web).
  */
 export interface SetBasemapWithTargetMapArg {
     /**
@@ -50,3 +53,18 @@ export interface SetBasemapWithTargetMapArg {
  * Argument used when setting current basemap in the app.
  */
 export declare type SetBasemapArgs = SetBasemapArg | SetBasemapWithTargetMapArg;
+export declare class BasemapEvents extends EventRegistry {
+    /**
+     * Raised when the basemap is changed by any means.
+     *
+     * @mobileOnly
+     */
+    get changed(): Event<MapEvent>;
+    /**
+     * Raised when the basemap is explicitly changed via the 'basemap.set'
+     * command or the 'layer-presets.apply' command.
+     *
+     * @mobileOnly
+     */
+    get set(): Event<MapEvent>;
+}

package/messaging/registry/basemap.js

@@ -1 +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")}}
+import{EventRegistry}from"../EventRegistry.js";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")}}export class BasemapEvents extends EventRegistry{get changed(){return this._messages.event("basemap.changed")}get set(){return this._messages.event("basemap.set")}}