@vertigis/viewer-spec 42.10.0

package/messaging/registry/sketching.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var SketchTool;!function(e){e.POINT="point",e.MULTIPOINT="multipoint",e.LINE="line",e.POLYLINE="polyline",e.POLYGON="polygon",e.EXTENT="extent",e.SQUARE="square",e.CIRCLE="circle"}(SketchTool||(SketchTool={}));export class SketchingOperations extends OperationRegistry{get captureGeometry(){return this._messages.operation("sketching.capture-geometry")}get editGeometry(){return this._messages.operation("sketching.edit-geometry")}get moveGeometry(){return this._messages.operation("sketching.move-geometry")}get scaleGeometry(){return this._messages.operation("sketching.scale-geometry")}get rotateGeometry(){return this._messages.operation("sketching.rotate-geometry")}get stop(){return this._messages.operation("sketching.stop")}get addNodeToGeometry(){return this._messages.operation("sketching.add-node-to-geometry")}get getActiveSketch(){return this._messages.operation("sketching.get-active-sketch")}get getActiveNode(){return this._messages.operation("sketching.get-active-node")}}export class SketchingCommands extends CommandRegistry{get undo(){return this._messages.command("sketching.undo")}get redo(){return this._messages.command("sketching.redo")}get setGeometryMode(){return this._messages.command("sketching.set-geometry-mode")}get addPointAtCenter(){return this._messages.command("sketching.add-point-at-center")}get addPointAtCurrentLocation(){return this._messages.command("sketching.add-point-at-current-location")}get setPointAtCurrentLocation(){return this._messages.command("sketching.set-point-at-current-location")}get delete(){return this._messages.command("sketching.delete")}get moveNode(){return this._messages.command("sketching.move-node")}get switchActiveNode(){return this._messages.command("sketching.switch-active-node")}get setInteractionMode(){return this._messages.command("sketching.set-interaction-mode")}}

package/messaging/registry/system.d.ts

@@ -0,0 +1,117 @@
+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 } from "../common.js";
+/**
+ * Arguments for the system.download-file operation.
+ */
+export interface DownloadArgs {
+    /**
+     * The blob to download.
+     */
+    result: Blob | Record<string, unknown> | string;
+    /**
+     * A filename for the download.
+     */
+    name: string;
+}
+/**
+ * Arguments for the system.read-file operation.
+ */
+export interface ReadFileArgs {
+    /**
+     * The accept parameter for the file input.
+     * {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept}.
+     */
+    accept?: string;
+    /**
+     * If present, indicates that the user may choose more than one file.
+     */
+    multiple?: boolean;
+    /**
+     * If present, overrides the default title of the dialog that prompts the
+     * user for a file.
+     */
+    promptTitle?: string;
+    /**
+     * If present, overrides the default message of the dialog that prompts the
+     * user for a file.
+     */
+    promptMessage?: string;
+}
+/**
+ * Arguments for the system.open-url command.
+ */
+export interface OpenUrlArgs {
+    /**
+     * The URL to open.
+     */
+    url: string;
+    /**
+     * An object containing arguments that this command was originally executed
+     * with. This property is populated automatically when using a bound action.
+     * The URL will be the configured value, and the context is automatically
+     * populated as the argument that was passed into the execute method when
+     * the command was executed in context.
+     */
+    context?: unknown;
+}
+export declare class SystemCommands extends CommandRegistry {
+    /**
+     * Displays a sharing link to the user.
+     *
+     * @webOnly
+     */
+    get displaySharingLink(): Command<string>;
+    /**
+     * Initiates a file download of the specified Blob to the user.
+     *
+     * @webOnly
+     */
+    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.
+     * 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.
+     *
+     * @mobileOnly
+     */
+    get openUrl(): Command<OpenUrlArgs | 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.
+     * Passing false as parameter will make the app respect system settings again.
+     *
+     * @mobileOnly
+     */
+    get keepScreenOn(): Command<boolean>;
+}
+export declare class SystemOperations extends OperationRegistry {
+    /**
+     * Fetch a file from the specified URL.
+     *
+     * @webOnly
+     */
+    get readUrl(): Operation<string, File[]>;
+    /**
+     * Initiates a file read, using the native browser file input.
+     *
+     * @webOnly
+     */
+    get readFile(): Operation<ReadFileArgs, File[]>;
+    /**
+     * Creates a link to share the shallow state of the application, including
+     * map position and scale, layer visibility and current basemap.
+     *
+     * @webOnly
+     */
+    get getSharingLink(): Operation<void, string>;
+}

package/messaging/registry/system.js

@@ -0,0 +1 @@
+import{CommandRegistry}from"../CommandRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class SystemCommands extends CommandRegistry{get displaySharingLink(){return this._messages.command("system.display-sharing-link")}get downloadFile(){return this._messages.command("system.download-file")}get openUrl(){return this._messages.command("system.open-url")}get keepScreenOn(){return this._messages.command("system.keep-screen-on")}}export class SystemOperations extends OperationRegistry{get readUrl(){return this._messages.operation("system.read-url")}get readFile(){return this._messages.operation("system.read-file")}get getSharingLink(){return this._messages.operation("system.get-sharing-link")}}

package/messaging/registry/tasks.d.ts

@@ -0,0 +1,178 @@
+import type Geometry from "@arcgis/core/geometry/Geometry";
+import type Point from "@arcgis/core/geometry/Point";
+import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
+import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
+import type { FeatureStream } from "@vertigis/arcgis-extensions/data/FeatureStream";
+import type { IdentifyOptions } from "@vertigis/arcgis-extensions/tasks/identify/IdentifyOptions";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Features, GeometryLike, MapsLike } from "../common.js";
+/**
+ * Arguments for search operations.
+ */
+export interface SearchArgs {
+    /**
+     * By default the search area will be expanded to try and return the
+     * specified maxResults. Set to true to disable this behavior. Not supported
+     * in Geocortex Mobile Viewer.
+     */
+    disableSearchAreaExpansion?: boolean;
+    /**
+     * The text to search for. Required.
+     */
+    searchText: string;
+    /**
+     * The feature sources to search. Can be used instead of or in addition to
+     * "maps". Not supported in Geocortex Mobile Viewer (use "maps").
+     */
+    sources?: FeatureSource[];
+    /**
+     * The map(s) to search. Can be used instead of or in addition to "sources".
+     */
+    maps?: MapsLike;
+    /**
+     * Id of source to filter for.
+     */
+    sourceId?: string;
+    /**
+     * The maximum number of results to return per source.
+     */
+    maxResults?: number;
+    /**
+     * The maximum number of results to query per source, the results
+     * per source will still be limited by maxResults.
+     */
+    maxQueryResults?: number;
+    /**
+     * If specified, results are limited to features that intersect the
+     * geometry.
+     */
+    searchArea?: Geometry;
+    /**
+     * If specified, this will influence the score of spatial features based on
+     * their proximity to this point. Most commonly this would be the user's
+     * current location, but can be any point of interest. This option requires
+     * searchArea to also be specified. Not supported in Geocortex Mobile
+     * Viewer.
+     */
+    near?: Point;
+    /**
+     * The spatial reference for the returned geometry. Not supported in
+     * Geocortex Mobile Viewer.
+     */
+    outSpatialReference?: SpatialReference;
+}
+/**
+ * Arguments for the tasks.identify operation.
+ */
+export interface IdentifyArgs {
+    /**
+     * The geometry to identify by.
+     */
+    geometry: GeometryLike;
+    /**
+     * The feature sources to identify. Can be used instead of or in addition to
+     * "maps". Not supported in Geocortex Mobile Viewer (use "maps").
+     */
+    sources?: FeatureSource[];
+    /**
+     * Whether geometry for features should be returned. Not supported in
+     * Geocortex Mobile Viewer.
+     */
+    returnGeometry?: boolean;
+    /**
+     * The spatial reference for the returned geometry. Not supported in
+     * Geocortex Mobile Viewer.
+     */
+    outSpatialReference?: SpatialReference;
+    /**
+     * The maximum allowable offset used for generalizing returned geometries.
+     * Not supported in Geocortex Mobile Viewer.
+     */
+    maxAllowableOffset?: number;
+    /**
+     * The maximum number of results to return per source. Not supported in
+     * Geocortex Mobile Viewer.
+     */
+    maxResults?: number;
+    /**
+     * The map to identify. Can be used instead of or in addition to "sources".
+     * Layers on the map will be used as sources according to the
+     * "layersInScaleRangeOnly" and "visibleLayersOnly" flags.
+     */
+    maps?: MapsLike;
+    /**
+     * When "map" is specified, this determines whether to include only layers
+     * that are in visible scale range. The default is false. Not supported in
+     * Geocortex Mobile Viewer.
+     */
+    layersInScaleRangeOnly?: boolean;
+    /**
+     * When "map" is specified, this determines whether to include only visible
+     * layers. The default is true. Not supported in Geocortex Mobile Viewer.
+     */
+    visibleLayersOnly?: boolean;
+    /**
+     * A tolerance value to use for point identify operations. All features
+     * falling within a buffer of this many logical pixels around the point will
+     * be returned by the identify operation. The default is 10. Not supported
+     * in Geocortex Mobile Viewer.
+     */
+    pointTolerance?: number;
+    /**
+     * A tolerance value to use for polyline and polygon identify operations.
+     * All features falling within a buffer of this many logical pixels around
+     * the geometry will be returned by the identify operation. The default is
+     * 2. Not supported in Geocortex Mobile Viewer.
+     */
+    polyTolerance?: number;
+}
+/**
+ * The arguments for the tasks.supports-identify operation.
+ */
+export interface SupportsIdentifyArgs {
+    /**
+     * The geometry to identify by.
+     */
+    geometry?: Geometry;
+    /**
+     * The feature source to identify.
+     */
+    source: FeatureSource;
+    /**
+     * The options for the identify operation.
+     */
+    options?: IdentifyOptions;
+}
+export declare class TasksEvents extends EventRegistry {
+    /**
+     * Raised when an identify task has been executed.
+     *
+     * @mobileOnly
+     */
+    get identified(): Event<FeatureStream>;
+}
+export declare class TasksOperations extends OperationRegistry {
+    /**
+     * Returns features that intersect a given geometry.
+     */
+    get identify(): Operation<IdentifyArgs, Features>;
+    /**
+     * Returns a boolean depicting whether a FeatureSource supports identify.
+     *
+     * @webOnly
+     */
+    get supportsIdentify(): Operation<FeatureSource | SupportsIdentifyArgs, boolean>;
+    /**
+     * Returns features that match the given search text.
+     */
+    get search(): Operation<SearchArgs, Features>;
+    /**
+     * Returns a boolean depicting whether a FeatureSource supports search.
+     *
+     * @webOnly
+     */
+    get supportsSearch(): Operation<FeatureSource, boolean>;
+}

package/messaging/registry/tasks.js

@@ -0,0 +1 @@
+import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class TasksEvents extends EventRegistry{get identified(){return this._messages.event("tasks.identified")}}export class TasksOperations extends OperationRegistry{get identify(){return this._messages.operation("tasks.identify")}get supportsIdentify(){return this._messages.operation("tasks.supports-identify")}get search(){return this._messages.operation("tasks.search")}get supportsSearch(){return this._messages.operation("tasks.supports-search")}}

package/messaging/registry/ui.d.ts

@@ -0,0 +1,361 @@
+import type { UIDensity } from "../../app-config/common/BrandingModelProperties.js";
+import type { TranslateOptions } from "../../app-config/common/TranslatableText.js";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Model } from "../common.js";
+/**
+ * A category for a notification that affects the color and icon used.
+ */
+export declare enum NotificationCategory {
+    ERROR = "error",
+    INFO = "info",
+    SUCCESS = "success",
+    WARNING = "warning"
+}
+/**
+ * The base args for a command/operation showing a message box.
+ */
+export interface MessageBoxArgs {
+    /**
+     * The title of the Dialog.
+     */
+    title?: string;
+    /**
+     * The message to be displayed in the Dialog.
+     */
+    message?: string;
+}
+/**
+ * Arguments for the 'ui.alert' command.
+ */
+export interface AlertCommandArgs extends MessageBoxArgs {
+    /**
+     * The text to display on the dismiss button.
+     */
+    buttonText?: string;
+}
+/**
+ * Arguments for the 'ui.confirm' operation.
+ */
+export interface ConfirmOperationArgs extends MessageBoxArgs {
+    /**
+     * The text to display on the ok button.
+     */
+    okButtonText?: string;
+    /**
+     * The text to display on the cancel button.
+     */
+    cancelButtonText?: string;
+}
+/**
+ * Arguments for the 'ui.prompt' operation.
+ */
+export interface PromptOperationArgs extends MessageBoxArgs {
+    /**
+     * The default value to display in the input box.
+     */
+    defaultInputValue?: string;
+    /**
+     * The text to display on the ok button.
+     */
+    okButtonText?: string;
+    /**
+     * The text to display on the cancel button.
+     */
+    cancelButtonText?: string;
+}
+/**
+ * The arguments for the `ui.display-notification` command.
+ */
+export interface DisplayNotificationArgs {
+    /**
+     * The category of notification, i.e. "error" (default is "info").
+     */
+    category?: NotificationCategory;
+    /**
+     * The message to be displayed in the notification.
+     */
+    message: string;
+    /**
+     * The position of the notification on the screen.
+     */
+    position?: Position;
+    /**
+     * Disable notification timeouts. Timeouts only apply to "info" and "success"
+     * categories. Web only.
+     */
+    disableTimeouts?: boolean;
+}
+/**
+ * Arguments for the "ui.set-visual-state" command.
+ */
+export interface SetVisualStateArgs {
+    /**
+     * The component ID.
+     */
+    id: ComponentId;
+    /**
+     * The visual state of the component. The set of visual states is specific
+     * to the type of component.
+     */
+    visualState: VisualState;
+}
+/**
+ * Arguments for the "ui.display-busy-state" args.
+ */
+export interface DisplayBusyStateArgs {
+    /**
+     * The title to display.
+     */
+    title?: string;
+    /**
+     * The message to display.
+     */
+    message?: string;
+    /**
+     * The minimum duration, in milliseconds, that the busy state will be
+     * displayed. Defaults to 500.
+     */
+    minimumDisplayDurationMs?: number;
+}
+/**
+ * A component's ID in the layout.
+ */
+export declare type ComponentId = string;
+/**
+ * Arguments for the "ui.focus" command.
+ */
+export interface FocusArgs {
+    /**
+     * The component to focus. If the selector property is not defined, the
+     * first focusable element within the component will receieve focus. If this
+     * property is not defined, only the selector will be used.
+     */
+    component?: ComponentId | Model;
+    /**
+     * The CSS selector used to find an HTML Element in the DOM. If a component
+     * is also provided, the selector will only look within the component's
+     * element tree in the DOM.
+     */
+    selector?: string;
+    /**
+     * The maximum number of milliseconds the command will spend attempting to
+     * focus the element. This may be useful in cases where the target
+     * component/element requires time to load or render. Defaults to 0.
+     */
+    timeout?: number;
+}
+/**
+ * A component's visual state. The values will vary based on the component type.
+ */
+export declare type VisualState = string;
+/**
+ * A position for a display notification.
+ */
+export declare enum Position {
+    BOTTOM = "bottom",
+    LEFT = "left",
+    RIGHT = "right",
+    TOP = "top"
+}
+/**
+ * Arguments for the ui.narrate command.
+ */
+export declare type NarrateArgs = string | NarrateOptions;
+/**
+ * Translate options for the ui.narrate command.
+ */
+export interface NarrateOptions extends TranslateOptions {
+    /**
+     * A timeout before the narration is excecuted. This can be used to avoid
+     * focus changes that can interrupt the screen reader. Defaults to 50ms.
+     */
+    timeout?: number;
+}
+export declare class UICommands extends CommandRegistry {
+    /**
+     * Activates a component with the given ID or model, causing it to become
+     * visible. For Geocortex Mobile Viewer, only ID is supported.
+     */
+    get activate(): Command<ComponentId | Model>;
+    /**
+     * Toggles the active state on a component with the given ID.
+     *
+     * @mobileOnly
+     */
+    get activeToggle(): Command<ComponentId>;
+    /**
+     * Shows an alert to the user.
+     */
+    get alert(): Command<AlertCommandArgs>;
+    /**
+     * Waits (does nothing) for the specified period. The UI will remain active
+     * during this period. This is primarily intended to be used for testing and
+     * troubleshooting.
+     *
+     * @mobileOnly
+     */
+    get await(): Command<number>;
+    /**
+     * Deactivates a component with the given ID, causing it to disappear. For
+     * Geocortex Mobile Viewer, only ID is supported.
+     */
+    get deactivate(): Command<ComponentId | Model>;
+    /**
+     * Displays a spinner and custom message to the user to indicate that the UI
+     * is busy.
+     *
+     * @mobileOnly
+     */
+    get displayBusyState(): Command<DisplayBusyStateArgs>;
+    /**
+     * Shows a notification to the user.
+     */
+    get displayNotification(): Command<DisplayNotificationArgs>;
+    /**
+     * Focuses on a component or DOM element.
+     *
+     * @webOnly
+     */
+    get focus(): Command<FocusArgs>;
+    /**
+     * Hides the busy state if currently shown.
+     *
+     * @mobileOnly
+     */
+    get hideBusyState(): Command;
+    /**
+     * Hides a notification previously shown to the user.
+     *
+     * @mobileOnly
+     */
+    get hideNotification(): Command;
+    /**
+     * Forces assistive technology (screen readers) to narrate a
+     * translatable message to the end user.
+     *
+     * @webOnly
+     */
+    get narrate(): Command<NarrateArgs>;
+    /**
+     * Sets the density level for the UI.
+     *
+     * @webOnly
+     */
+    get setDensity(): Command<UIDensity>;
+    /**
+     * Sets the locale for the application and loads any locale-specific
+     * resources. Accepts a valid locale code (example: "en", "fr" or "de-AT").
+     *
+     * @webOnly
+     */
+    get setLocale(): Command<string>;
+    /**
+     * Sets the color theme of the viewer. The required argument is the new
+     * theme's ID.
+     */
+    get setTheme(): Command<string>;
+    /**
+     * Sets the visual state of a component.
+     *
+     * @webOnly
+     */
+    get setVisualState(): Command<SetVisualStateArgs>;
+}
+export declare class UIOperations extends OperationRegistry {
+    /**
+     * Gets user confirmation by way of a popup box.
+     */
+    get confirm(): Operation<ConfirmOperationArgs, boolean>;
+    /**
+     * Prompts the user to enter a value in a popup box.
+     *
+     * @webOnly
+     */
+    get prompt(): Operation<PromptOperationArgs, string>;
+    /**
+     * Gets the visual state of a component.
+     *
+     * @webOnly
+     */
+    get getVisualState(): Operation<ComponentId, VisualState | undefined>;
+}
+export declare class UIEvents extends EventRegistry {
+    /**
+     * Raised when a component is activated. The argument is the component ID.
+     */
+    get activated(): Event<ComponentId>;
+    /**
+     * Raised when a component is added to the layout.
+     *
+     * @webOnly
+     */
+    get added(): Event<ComponentId>;
+    /**
+     * Raised when a component's ancestor becomes activated. The argument is the
+     * descendant component's ID.
+     *
+     * @webOnly
+     */
+    get ancestorActivated(): Event<ComponentId>;
+    /**
+     * Raised when a component's ancestor becomes deactivated. The argument is
+     * the descendant component's ID.
+     *
+     * @webOnly
+     */
+    get ancestorDeactivated(): Event<ComponentId>;
+    /**
+     * Raised when a component is deactivated. The argument is the component ID.
+     */
+    get deactivated(): Event<ComponentId>;
+    /**
+     * Raised when the UI density setting is changed.
+     *
+     * @webOnly
+     */
+    get densityChanged(): Event<UIDensity>;
+    /**
+     * Raised when the locale is changed by the user. The argument is the locale
+     * code.
+     *
+     * @webOnly
+     */
+    get localeChanged(): Event<string>;
+    /**
+     * Raised when a component begins initialization. The argument is the
+     * component ID.
+     *
+     * @webOnly
+     */
+    get initializing(): Event<ComponentId>;
+    /**
+     * Raised when a component and its descendants have been initially
+     * activated. The argument is the component ID.
+     *
+     * @webOnly
+     */
+    get initialized(): Event<ComponentId>;
+    /**
+     * Raised when a component is removed from the layout.
+     *
+     * @webOnly
+     */
+    get removed(): Event<ComponentId>;
+    /**
+     * Raised when a component is reordered in the layout relative to its siblings.
+     *
+     * @webOnly
+     */
+    get reordered(): Event<ComponentId>;
+    /**
+     * Raised when the app's theme is changed.
+     *
+     * @mobileOnly
+     */
+    get themeChanged(): Event;
+}