@vertigis/viewer-spec 56.24.0 → 56.25.0

package/messaging/Command.d.ts

@@ -1,76 +1,76 @@
-import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
-import type { AnalyticsContext } from "../analytics/AnalyticsContext.js";
-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> extends AnalyticsContext {
-    /**
-     * 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;
-}
+import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { AnalyticsContext } from "../analytics/AnalyticsContext.js";
+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> extends AnalyticsContext {
+    /**
+     * 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/CommandRegistry.d.ts

@@ -1,25 +1,25 @@
-import type { Command } from "./Command.js";
-import type { MessageBus } from "./MessageBus.js";
-/**
- * A registry of well-known commands.
- */
-export declare abstract class CommandRegistry {
-    protected readonly _messages: MessageBus;
-    /**
-     * Command name prefix that will be added to all commands in this registry.
-     */
-    protected abstract readonly _prefix: string;
-    /**
-     * Creates a registry.
-     *
-     * @param messages The message bus to use.
-     */
-    constructor(messages: MessageBus);
-    /**
-     * Returns the command corresponding to the given unqualified name.
-     *
-     * @param name The name of the command without the common prefix associated
-     *   with this registry.
-     */
-    protected _get<T = void>(name: string): Command<T>;
-}
+import type { Command } from "./Command.js";
+import type { MessageBus } from "./MessageBus.js";
+/**
+ * A registry of well-known commands.
+ */
+export declare abstract class CommandRegistry {
+    protected readonly _messages: MessageBus;
+    /**
+     * Command name prefix that will be added to all commands in this registry.
+     */
+    protected abstract readonly _prefix: string;
+    /**
+     * Creates a registry.
+     *
+     * @param messages The message bus to use.
+     */
+    constructor(messages: MessageBus);
+    /**
+     * Returns the command corresponding to the given unqualified name.
+     *
+     * @param name The name of the command without the common prefix associated
+     *   with this registry.
+     */
+    protected _get<T = void>(name: string): Command<T>;
+}

package/messaging/CommandRegistry.js

@@ -1 +1 @@
-export class CommandRegistry{constructor(s){this._messages=s}_get(s){return this._messages.command(this._prefix?`${this._prefix}.${s}`:s)}}
+export class CommandRegistry{_messages;constructor(s){this._messages=s}_get(s){return this._messages.command(this._prefix?`${this._prefix}.${s}`:s)}}

package/messaging/DotNetTypes.d.ts

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

package/messaging/Event.d.ts

@@ -1,26 +1,26 @@
-import type { Message } from "./Message.js";
-import type { Model } from "./common.js";
-/**
- * A callback that will be invoked whenever the event is published.
- */
-export type EventCallback<T> = (arg?: T, publisher?: Model) => 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, publisher?: Model) => 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;
-}
+import type { Message } from "./Message.js";
+import type { Model } from "./common.js";
+/**
+ * A callback that will be invoked whenever the event is published.
+ */
+export type EventCallback<T> = (arg?: T, publisher?: Model) => 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, publisher?: Model) => 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/EventRegistry.d.ts

@@ -1,25 +1,25 @@
-import type { Event } from "./Event.js";
-import type { MessageBus } from "./MessageBus.js";
-/**
- * A registry of well-known events.
- */
-export declare abstract class EventRegistry {
-    protected readonly _messages: MessageBus;
-    /**
-     * Event name prefix that will be added to all events in this registry.
-     */
-    protected abstract readonly _prefix: string;
-    /**
-     * Creates a registry.
-     *
-     * @param messages The message bus to use.
-     */
-    constructor(messages: MessageBus);
-    /**
-     * Returns the event corresponding to the given unqualified name.
-     *
-     * @param name The name of the event without the common prefix associated
-     *   with this registry.
-     */
-    protected _get<T = void>(name: string): Event<T>;
-}
+import type { Event } from "./Event.js";
+import type { MessageBus } from "./MessageBus.js";
+/**
+ * A registry of well-known events.
+ */
+export declare abstract class EventRegistry {
+    protected readonly _messages: MessageBus;
+    /**
+     * Event name prefix that will be added to all events in this registry.
+     */
+    protected abstract readonly _prefix: string;
+    /**
+     * Creates a registry.
+     *
+     * @param messages The message bus to use.
+     */
+    constructor(messages: MessageBus);
+    /**
+     * Returns the event corresponding to the given unqualified name.
+     *
+     * @param name The name of the event without the common prefix associated
+     *   with this registry.
+     */
+    protected _get<T = void>(name: string): Event<T>;
+}

package/messaging/EventRegistry.js

@@ -1 +1 @@
-export class EventRegistry{constructor(s){this._messages=s}_get(s){return this._messages.event(this._prefix?`${this._prefix}.${s}`:s)}}
+export class EventRegistry{_messages;constructor(s){this._messages=s}_get(s){return this._messages.event(this._prefix?`${this._prefix}.${s}`:s)}}

package/messaging/Message.d.ts

@@ -1,50 +1,50 @@
-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;
-    /**
-     * The XML name of the layout component that initiated the action, if
-     * applicable. This will be available in the command context and can be used
-     * by message handlers for capturing analytics. Examples: "layer-list",
-     * "map", etc.
-     */
-    analyticsComponentType?: string;
-    /**
-     * The human-readable name of the layout component that initiated the
-     * action, if applicable. This will be available in the command context and
-     * can be used by message handlers for capturing analytics. Examples: "Layer
-     * List", "Basemap Picker", , "Left Panel", etc.
-     */
-    analyticsComponentName?: string;
-    /**
-     * Additional component-specific data indicating such things as the name of
-     * an item or area within a component that the user interacted with to
-     * trigger the command, if applicable. This will be available in the command
-     * context and can be used by message handlers for capturing analytics.
-     *
-     * Examples:
-     *
-     * - The name of a basemap selection.
-     * - The name of a button.
-     * - The name of a context menu item.
-     */
-    analyticsComponentData?: string | number | boolean | string[];
-}
+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;
+    /**
+     * The XML name of the layout component that initiated the action, if
+     * applicable. This will be available in the command context and can be used
+     * by message handlers for capturing analytics. Examples: "layer-list",
+     * "map", etc.
+     */
+    analyticsComponentType?: string;
+    /**
+     * The human-readable name of the layout component that initiated the
+     * action, if applicable. This will be available in the command context and
+     * can be used by message handlers for capturing analytics. Examples: "Layer
+     * List", "Basemap Picker", , "Left Panel", etc.
+     */
+    analyticsComponentName?: string;
+    /**
+     * Additional component-specific data indicating such things as the name of
+     * an item or area within a component that the user interacted with to
+     * trigger the command, if applicable. This will be available in the command
+     * context and can be used by message handlers for capturing analytics.
+     *
+     * Examples:
+     *
+     * - The name of a basemap selection.
+     * - The name of a button.
+     * - The name of a context menu item.
+     */
+    analyticsComponentData?: string | number | boolean | string[];
+}

package/messaging/MessageBus.d.ts

@@ -1,54 +1,54 @@
-import type { Action } 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: Action): 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>;
-}
+import type { Action } 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: Action): 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>;
+}