@vertigis/viewer-spec 42.10.0

package/layout/schema/schema-reference-example.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<layout
+    xmlns="https://geocortex.com/layout/v1"
+    xmlns:web="https://geocortex.com/layout/web/v1"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://geocortex.com/layout/web/v1 layout-web.xsd">
+  <split>
+    <web:tabs>
+      <layer-list/>
+      <search/>
+    </web:tabs>
+    <map></map>
+  </split>
+</layout>

package/messaging/Command.d.ts

@@ -0,0 +1,74 @@
+import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { Event } from "./Event.js";
+import type { Message, MessageExecuteOptions } from "./Message.js";
+/**
+ * A named command.
+ */
+export interface Command<T = void> extends Message {
+    /**
+     * The name of the command.
+     */
+    readonly name: string;
+    /**
+     * An event that is published whenever canExecute might return a new value.
+     * Implementations are responsible for calling publish() as appropriate.
+     */
+    readonly canExecuteChanged: Event;
+    /**
+     * Indicates whether the command has been initialized.
+     */
+    readonly isInitialized: boolean;
+    /**
+     * Executes the command.
+     *
+     * @param argument The command arguments.
+     * @param options CancelToken or options to apply to the commands execute behavior.
+     */
+    execute(argument: T, options?: CancelToken | MessageExecuteOptions): Promise<void>;
+    /**
+     * Determines whether the command can execute with the given arguments.
+     *
+     * @param argument The command arguments.
+     */
+    canExecute(argument?: T): boolean;
+    /**
+     * Initializes the command if it is not already initialized. Attempting to
+     * execute a command will automatically initialize it, however calling
+     * canExecute() will always return false until the command is initialized.
+     */
+    initialize(): Promise<void>;
+}
+/**
+ * Execution context that will be passed in to each of the command's behaviors.
+ */
+export interface CommandContext<T> {
+    /**
+     * The name of the command that is currently executing.
+     */
+    readonly name: string;
+    /**
+     * Used to cancel execution of the command.
+     */
+    cancelToken?: CancelToken;
+    /**
+     * Determines if the command was executed from a trusted source. For
+     * example, a command launched via a URL parameter should likely be
+     * considered as untrusted.
+     */
+    trusted?: boolean;
+    /**
+     * Invokes the next behavior in the chain. If it isn't invoked explicitly,
+     * then the next behavior will run after the current one is finished. Note
+     * that this is not supported for behaviors that are added at runtime via
+     * registerParallel(), which have no explicit sequence as they are run
+     * concurrently.
+     */
+    next: (argument?: T) => Promise<void>;
+    /**
+     * Indicates that no more behaviors should run after the current one is
+     * complete. Note that this is only supported for configured behaviors --
+     * behaviors that are added at runtime via register() have no explicit
+     * sequence as they are run concurrently.
+     */
+    finish: () => void;
+}

package/messaging/Command.js

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

package/messaging/CommandRegistry.d.ts

@@ -0,0 +1,13 @@
+import type { MessageBus } from "./MessageBus.js";
+/**
+ * A registry of well-known commands.
+ */
+export declare class CommandRegistry {
+    protected readonly _messages: MessageBus;
+    /**
+     * Creates a registry.
+     *
+     * @param messages The message bus to use.
+     */
+    constructor(messages: MessageBus);
+}

package/messaging/CommandRegistry.js

@@ -0,0 +1 @@
+export class CommandRegistry{constructor(s){this._messages=s}}

package/messaging/Event.d.ts

@@ -0,0 +1,25 @@
+import type { Message } from "./Message.js";
+/**
+ * A callback that will be invoked whenever the event is published.
+ */
+export declare type EventCallback<T> = (arg?: T) => void | Promise<void>;
+/**
+ * A named event.
+ */
+export interface Event<T = void> extends Message {
+    /**
+     * Publishes the event to all subscribers.
+     *
+     * @returns A promise that is fulfilled once all subscribers have been
+     * notified.
+     */
+    publish: (arg: T) => Promise<void>;
+    /**
+     * Subscribes to this event.
+     *
+     * @param callback A callback that will be invoked whenever the event is
+     * published.
+     * @returns A handle that can be used to unsubscribe.
+     */
+    subscribe: (callback: EventCallback<T>) => IHandle;
+}

package/messaging/Event.js

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

package/messaging/EventRegistry.d.ts

@@ -0,0 +1,13 @@
+import type { MessageBus } from "./MessageBus.js";
+/**
+ * A registry of well-known events.
+ */
+export declare class EventRegistry {
+    protected readonly _messages: MessageBus;
+    /**
+     * Creates a registry.
+     *
+     * @param messages The message bus to use.
+     */
+    constructor(messages: MessageBus);
+}

package/messaging/EventRegistry.js

@@ -0,0 +1 @@
+export class EventRegistry{constructor(s){this._messages=s}}

package/messaging/Message.d.ts

@@ -0,0 +1,23 @@
+import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+/**
+ * Represents a `command`, `event`, or `operation`.
+ */
+export interface Message {
+    /**
+     * The name of the command, operation, or event.
+     */
+    name: string;
+}
+/**
+ * Options that apply to the execution of a message.
+ */
+export interface MessageExecuteOptions {
+    /**
+     * Enables cancellation (see Cancellable).
+     */
+    cancelToken?: CancelToken;
+    /**
+     * Specify if the message was executed from a trusted source.
+     */
+    trusted?: boolean;
+}

package/messaging/Message.js

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

package/messaging/MessageBus.d.ts

@@ -0,0 +1,54 @@
+import type { Action, SimpleAction } from "@vertigis/arcgis-extensions/support/Action";
+import type { Command } from "./Command.js";
+import type { Event } from "./Event.js";
+import type { Operation } from "./Operation.js";
+/**
+ * Handles messaging between parts of an application.
+ */
+export interface MessageBus {
+    /**
+     * Retrieves a command.
+     *
+     * @param action The command specification. Either the name of a
+     * command, or a list of commands and/or operations to run in sequence.
+     */
+    command<T = void>(action: Action): Command<T>;
+    /**
+     * Retrieves an event.
+     *
+     * @param name Name of the event.
+     */
+    event<T = void>(name: string): Event<T>;
+    /**
+     * Retrieves an operation.
+     *
+     * @param name Name of the operation.
+     */
+    operation<T = void, TResult = undefined>(action: SimpleAction): Operation<T, TResult>;
+    /**
+     * Determines whether a command with the given name exists.
+     *
+     * @param name Name of the command.
+     */
+    hasCommand(name: string): boolean;
+    /**
+     * Determines whether an event with the given name exists.
+     *
+     * @param name Name of the event.
+     */
+    hasEvent(name: string): boolean;
+    /**
+     * Determines whether an operation with the given name exists.
+     *
+     * @param name Name of the operation.
+     */
+    hasOperation(name: string): boolean;
+    /**
+     * Returns all registered commands.
+     */
+    allCommands(): IterableIterator<Command>;
+    /**
+     * Returns all registered operations.
+     */
+    allOperations(): IterableIterator<Operation>;
+}

package/messaging/MessageBus.js

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

package/messaging/Operation.d.ts

@@ -0,0 +1,53 @@
+import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { Message, MessageExecuteOptions } from "./Message.js";
+/**
+ * A named operation. Operations compute a value, but don't generally alter the
+ * state of an application.
+ */
+export interface Operation<T = void, TResult = undefined> extends Message {
+    /**
+     * The name of the operation.
+     */
+    name: string;
+    /**
+     * Executes the operation and returns its result.
+     *
+     * @param argument The argument to the operation.
+     * @param options CancelToken or options to apply to the Operation execute
+     * behavior.
+     */
+    execute: (argument: T, options?: CancelToken | MessageExecuteOptions) => Promise<TResult>;
+}
+/**
+ * Context that will be passed in to each behavior for an operation.
+ */
+export interface OperationContext<T = void, TResult = undefined> {
+    /**
+     * The name of the operation that is currently executing.
+     */
+    readonly name: string;
+    /**
+     * The result of the previous behavior (undefined if the current behavior is
+     * the first one).
+     */
+    result?: TResult;
+    /**
+     * Enables cancelling the operation (see Cancellable).
+     */
+    cancelToken?: CancelToken;
+    /**
+     * Used to determine if the operation was executed from a trusted source.
+     */
+    trusted?: boolean;
+    /**
+     * Invokes the next behavior in the chain. If it isn't invoked explicitly,
+     * then the next behavior will run after the current one is finished.
+     */
+    next: (argument?: T, result?: TResult) => Promise<TResult>;
+    /**
+     * Indicates that no more behaviors should run after the current one is
+     * complete. The result from the current behavior will be the final result
+     * of the operation.
+     */
+    finish: () => void;
+}

package/messaging/Operation.js

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

package/messaging/OperationRegistry.d.ts

@@ -0,0 +1,13 @@
+import type { MessageBus } from "./MessageBus.js";
+/**
+ * A registry of well-known operations.
+ */
+export declare class OperationRegistry {
+    protected readonly _messages: MessageBus;
+    /**
+     * Creates a registry.
+     *
+     * @param messages The message bus to use.
+     */
+    constructor(messages: MessageBus);
+}

package/messaging/OperationRegistry.js

@@ -0,0 +1 @@
+export class OperationRegistry{constructor(s){this._messages=s}}

package/messaging/common.d.ts

@@ -0,0 +1,246 @@
+import type Graphic from "@arcgis/core/Graphic";
+import type Viewpoint from "@arcgis/core/Viewpoint";
+import type Geometry from "@arcgis/core/geometry/Geometry";
+import type Layer from "@arcgis/core/layers/Layer";
+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 EsriFeatureSet from "@arcgis/core/tasks/support/FeatureSet";
+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 { 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";
+import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
+import type { SublayerExtension } from "@vertigis/arcgis-extensions/mapping/SublayerExtension";
+import type { LayerExtension, LayerReference as LayerReferenceObject } from "@vertigis/arcgis-extensions/mapping/_LayerExtension";
+import type { Feature as GraphicJson } from "@vertigis/arcgis-extensions/portal/Feature";
+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 { Viewpoint as ViewpointJson } from "@vertigis/arcgis-extensions/portal/Viewpoint";
+import type { SublayerLike } from "@vertigis/arcgis-extensions/support/esri";
+/**
+ * A model belonging to a component.
+ */
+export interface Model extends Entity {
+}
+/**
+ * A reference to a model (using its ID or model instance).
+ */
+export declare type ModelRef = string | Model;
+/**
+ * Result of the "drawing.create-graphics" and "measurement.create-graphics"
+ * operations.
+ */
+export interface CreateGraphicsResult {
+    /**
+     * The resulting graphics.
+     */
+    graphics: Graphic[];
+    /**
+     * The map that the graphics were created on.
+     */
+    maps: MapsLike;
+}
+/**
+ * Represents one or more features.
+ */
+export declare type FeaturesLike = Feature | FeatureSet | FeatureList | FeatureStream | (Feature | FeatureProperties)[];
+/**
+ * Defines an object that has a `features` property.
+ */
+export interface HasFeatures {
+    /**
+     * Features to use for the command/operation.
+     */
+    features?: FeaturesLike;
+}
+/**
+ * Feature results from an operation.
+ */
+export interface Results extends HasFeatures, HasMaps {
+}
+/**
+ * One or more features, or an object that has features.
+ */
+export declare type Features = FeaturesLike | Results;
+/**
+ * One or map extensions.
+ */
+export declare type MapsLike = MapExtension | MapExtension[];
+/**
+ * Defines an object that has a `maps` property.
+ */
+export interface HasMaps {
+    /**
+     * Map(s) to use for the command/operation.
+     */
+    maps?: MapsLike;
+}
+/**
+ * One or more map extensions, or an object that has map extensions.
+ */
+export declare type Maps = MapsLike | HasMaps;
+/**
+ * A reference to an existing layer, which is the ID or title of the layer (or
+ * both).
+ */
+export declare type LayerReference = string | LayerReferenceObject;
+/**
+ * A (sub)layer extension, or an object that is convertible to one.
+ */
+export declare type LayerLike = Layer | LayerExtension | SublayerLike | SublayerExtension | LayerReference;
+/**
+ * One or more objects that are convertible to layer extensions.
+ */
+export declare type LayersLike = LayerLike | LayerLike[];
+/**
+ * An object that has one or more layer extensions.
+ */
+export interface HasLayers {
+    /**
+     * Layer(s) to use for the command/operation.
+     */
+    layers?: LayersLike;
+}
+/**
+ * One or more layer extensions, or an object that has one or more layer
+ * extensions.
+ */
+export declare type Layers = LayersLike | HasLayers;
+/**
+ * One or more basemap extensions.
+ */
+export declare type BasemapsLike = BasemapExtension | BasemapExtension[];
+/**
+ * An object that is convertible to basemap extension.
+ */
+export declare type Basemaps = BasemapsLike;
+/**
+ * An object that is convertible to Esri Graphic or set of graphics.
+ */
+export declare type GraphicsLike = Graphic | GraphicJson | (Graphic | GraphicJson)[] | CreateGraphicsResult | EsriFeatureSet;
+/**
+ * An object that has a `graphics` property.
+ */
+export interface HasGraphics {
+    /**
+     * Graphics to use for the command/operation.
+     */
+    graphics?: GraphicsLike;
+}
+/**
+ * An object that is convertible to Esri Graphic or set of graphics, or an
+ * object that has graphics.
+ */
+export declare type Graphics = GraphicsLike | HasGraphics;
+/**
+ * An object that is convertible to one or more geometries.
+ */
+export declare type GeometryLike = Geometry | Geometry[] | FeaturesLike | GraphicsLike;
+/**
+ * An object that has a `geometry` property.
+ */
+export interface HasGeometry {
+    /**
+     * The geometry to use for the command/operation.
+     */
+    geometry?: GeometryLike;
+}
+/**
+ * An object that is convertible to one or more geometries, or an object that
+ * has geometry.
+ */
+export declare type Geometries = GeometryLike | HasGeometry | HasFeatures;
+/**
+ * An object that is convertible to an Esri Viewpoint.
+ */
+export declare type ViewpointLike = Viewpoint | ViewpointJson | Bookmark | BookmarkProperties;
+/**
+ * An object that has a `viewpoint` property.
+ */
+export interface HasViewPoint {
+    /**
+     * The viewpoint to use for the command/operation.
+     */
+    viewpoint?: ViewpointLike;
+}
+/**
+ * Symbols supported for drawing.
+ */
+export declare type SymbolLike = SimpleMarkerSymbol | SimpleMarkerSymbolProperties | PictureMarkerSymbol | PictureMarkerSymbolProperties | SimpleLineSymbol | SimpleLineSymbolProperties | SimpleFillSymbol | SimpleFillSymbolProperties | PictureFillSymbol | PictureFillSymbolProperties | PointSymbol3D | PointSymbol3DProperties | LineSymbol3D | LineSymbol3DProperties | PolygonSymbol3D | PolygonSymbol3DProperties;
+/**
+ * An object that has a `symbol` property.
+ */
+export interface HasSymbol {
+    /**
+     * The symbol to use for the command/operation.
+     */
+    symbol?: SymbolLike;
+}
+/**
+ * An object that is convertible to an Esri Viewpoint, or that has a viewpoint
+ * property.
+ */
+export declare type ViewpointArg = ViewpointLike | HasViewPoint;
+/**
+ * Represents raw binary data. For more information, see
+ * https://developer.mozilla.org/en-US/docs/Web/API/Blob.
+ */
+export interface Blob {
+    /**
+     * The size of the blob, in bytes.
+     */
+    readonly size: number;
+    /**
+     * The MIME type of the file, e.g. "image/png".
+     */
+    readonly type: string;
+    /**
+     * Gets the contents of the blob as binary data contained in an ArrayBuffer.
+     */
+    arrayBuffer(): Promise<ArrayBuffer>;
+    /**
+     * Returns a new Blob object which contains data from a subset of the blob
+     * on which it's called.
+     *
+     * @param start An index into the Blob indicating the first byte to include
+     * in the new Blob.
+     * @param end An index into the Blob indicating the first byte that will
+     * *not* be included in the new Blob (i.e. the byte exactly at this index is
+     * not included).
+     * @param contentType The content type to assign to the new Blob; this will
+     * be the value of its type property. The default value is an empty string.
+     */
+    slice(start?: number, end?: number, contentType?: string): Blob;
+    /**
+     * Returns a ReadableStream object.
+     */
+    stream(): unknown;
+    /**
+     * Gets a string containing the contents of the blob, interpreted as UTF-8.
+     */
+    text(): Promise<string>;
+}
+/**
+ * A blob representing a file.
+ */
+export interface File extends Blob {
+    /**
+     * The name of the file.
+     */
+    readonly name: string;
+}