@vertigis/viewer-spec 52.1.0 → 53.1.0

package/messaging/registry/results.d.ts

@@ -6,8 +6,9 @@ import type { Attachment } from "@vertigis/arcgis-extensions/data/Attachment";
 import type { Feature } from "@vertigis/arcgis-extensions/data/Feature";
 import type { FeatureSettingsProperties } from "@vertigis/arcgis-extensions/data/FeatureSettings";
 import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
+import type { FeatureStream } from "@vertigis/arcgis-extensions/data/FeatureStream.js";
 import type { SchemaProperties } from "@vertigis/arcgis-extensions/data/Schema";
-import type { FromCsvOptions, FromShapefileOptions, FromXLSXOptions, ToCsvOptions, ToShapefileOptions, ToXLSXOptions } from "@vertigis/arcgis-extensions/data/convert";
+import type { FromCsvOptions, FromShapefileOptions, FromXLSXOptions, ToCsvOptions, ToShapefileOptions, ToXLSXOptions, UploadDataOptions } from "@vertigis/arcgis-extensions/data/convert";
 import type { QueryOptions } from "@vertigis/arcgis-extensions/tasks/query/QueryOptions";
 import type { CardSize, ViewMode } from "../../app-config/web/ResultsModelProperties.js";
 import type { Command } from "../Command.js";
@@ -16,7 +17,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 { Blob, Features, FeaturesLike, File, GraphicsLike, HasFeatures, MapsLike, ModelRef } from "../common.js";
+import type { Blob, Features, FeaturesLike, File, GraphicsLike, HasFeatures, HasFiles, MapsLike, ModelRef } from "../common.js";
 import type { VisualElement } from "../mobile.js";
 /**
  * Well known Results Set Ids.
@@ -63,13 +64,18 @@ export interface ToCsvConversionArgs extends ToCsvOptions {
     features: Features;
 }
 /**
- * Arguments for the "results.from-csv" operation.
+ * Arguements for the "results.upload-data-args-to-feature" operation.
  */
-export interface FromCsvConversionArgs extends FromCsvOptions {
+export interface UploadDataArgs extends UploadDataOptions {
     /**
-     * The blob(s) that contains the csv file.
+     * A title for this dataset.
      */
-    blobs: Blob[];
+    title?: string;
+}
+/**
+ * Arguments for the "results.from-csv" operation.
+ */
+export interface FromCsvConversionArgs extends FromCsvOptions, HasFiles {
 }
 /**
  * Arguments for the "results.convert-to-xlsx" operation.
@@ -83,11 +89,7 @@ export interface ToXLSXConversionArgs extends ToXLSXOptions {
 /**
  * Arguments for the "results.from-xlsx" operation.
  */
-export interface FromXLSXConversionArgs extends FromXLSXOptions {
-    /**
-     * The blob(s) that contains the xlsx file.
-     */
-    blobs: Blob[];
+export interface FromXLSXConversionArgs extends FromXLSXOptions, HasFiles {
 }
 /**
  * Arguments for the "results.convert-to-shapefile" operation.
@@ -101,11 +103,7 @@ export interface ToShapefileConversionArgs extends ToShapefileOptions {
 /**
  * Arguments for the "results.from-shapefile" operation.
  */
-export interface FromShapefileConversionArgs extends FromShapefileOptions {
-    /**
-     * The blob(s) that contains the Shapefile file.
-     */
-    blobs: Blob[];
+export interface FromShapefileConversionArgs extends FromShapefileOptions, HasFiles {
 }
 /**
  * Arguments for the "results.convert-to-layers" operation.
@@ -477,6 +475,13 @@ export declare class ResultsEvents extends EventRegistry {
     get relatedDetailsShown(): Event<FeatureDetailsEvent>;
 }
 export declare class ResultsOperations extends OperationRegistry {
+    /**
+     * Display a dialog to configure the arguements for the upload layer
+     * operation.
+     *
+     * @webOnly
+     */
+    get configureUploadData(): Operation<UploadDataArgs[], UploadDataArgs[]>;
     /**
      * Check if features are contained in the specified results.
      *
@@ -523,7 +528,18 @@ export declare class ResultsOperations extends OperationRegistry {
      *
      * @webOnly
      */
-    get fromFiles(): Operation<File[] | FromConverterArgs, Features>;
+    get fromFiles(): Operation<FromConverterArgs | File[], Features>;
+    /**
+     * Convert the specified csv, xlsx or shapefile files to args that can be
+     * used to create Features.
+     *
+     * @webOnly
+     */
+    get uploadDataFromFiles(): Operation<FromConverterArgs | File[], UploadDataArgs[]>;
+    /**
+     * Convert the supplied upload data args to features.
+     */
+    get uploadDataToFeatures(): Operation<UploadDataArgs[], FeatureStream[]>;
     /**
      * Convert the specified Shapefile blob to Features.
      *

package/messaging/registry/results.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends e{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends s{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends t{get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromFiles(){return this._messages.operation("results.from-files")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends e{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends s{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends t{get configureUploadData(){return this._messages.operation("results.configure-upload-data")}get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromFiles(){return this._messages.operation("results.from-files")}get uploadDataFromFiles(){return this._messages.operation("results.upload-data-from-files")}get uploadDataToFeatures(){return this._messages.operation("results.upload-data-to-features")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}

package/messaging/registry/system.d.ts

@@ -5,7 +5,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 { Blob, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget } from "../common.js";
+import type { Blob, File, HasFeatures, HasFiles, HasGeometry, HasLayers, HasMaps, HasUITarget } from "../common.js";
 /**
  * Arguments for the system.download-file operation.
  */
@@ -13,11 +13,26 @@ export interface DownloadArgs {
     /**
      * The blob to download.
      */
-    result: Blob | Record<string, unknown> | string;
+    result?: Blob | Record<string, unknown> | string;
     /**
      * A filename for the download.
      */
-    name: string;
+    name?: string;
+    /**
+     * Optionally specify the record attribute to be used as the result content.
+     * Defaults to 'result'.
+     */
+    resultAttribute?: string;
+    /**
+     * Optionally specify the record attribute to be used as the file name.
+     * Defaults to 'name'.
+     */
+    fileNameAttribute?: string;
+    /**
+     * Optionally specify the file name extension to be used if the file name
+     * does not end with one. Defaults to '.json'.
+     */
+    fileNameExtension?: string;
 }
 /**
  * Arguments for the system.read-file operation.
@@ -219,6 +234,13 @@ export declare class SystemOperations extends OperationRegistry {
      * @webOnly
      */
     get readFile(): Operation<ReadFileArgs, File[]>;
+    /**
+     * A synonym for `system.read-file` that attaches the output to an args
+     * object for use in command chains.
+     *
+     * @webOnly
+     */
+    get readFiles(): Operation<ReadFileArgs, HasFiles>;
     /**
      * Creates a link to share the shallow state of the application, including
      * map position and scale, layer visibility and current basemap.

package/messaging/registry/system.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var HapticStyle;!function(e){e.LIGHT="light",e.MEDIUM="medium",e.HEAVY="heavy",e.SUCCESS="success",e.WARNING="warning",e.ERROR="error"}(HapticStyle||(HapticStyle={}));export class SystemCommands extends e{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")}get enableBackgroundLocationUpdates(){return this._messages.command("system.enable-background-location-updates")}get disableBackgroundLocationUpdates(){return this._messages.command("system.disable-background-location-updates")}get haptics(){return this._messages.command("system.haptics")}}export class SystemOperations extends t{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")}}export class SystemEvents extends s{get backgroundLocationUpdatesEnabled(){return this._messages.event("system.background-location-updates-enabled")}get backgroundLocationUpdatesDisabled(){return this._messages.event("system.background-location-updates-disabled")}get urlOpened(){return this._messages.event("system.url-opened")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export var HapticStyle;!function(e){e.LIGHT="light",e.MEDIUM="medium",e.HEAVY="heavy",e.SUCCESS="success",e.WARNING="warning",e.ERROR="error"}(HapticStyle||(HapticStyle={}));export class SystemCommands extends e{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")}get enableBackgroundLocationUpdates(){return this._messages.command("system.enable-background-location-updates")}get disableBackgroundLocationUpdates(){return this._messages.command("system.disable-background-location-updates")}get haptics(){return this._messages.command("system.haptics")}}export class SystemOperations extends t{get readUrl(){return this._messages.operation("system.read-url")}get readFile(){return this._messages.operation("system.read-file")}get readFiles(){return this._messages.operation("system.read-files")}get getSharingLink(){return this._messages.operation("system.get-sharing-link")}}export class SystemEvents extends s{get backgroundLocationUpdatesEnabled(){return this._messages.event("system.background-location-updates-enabled")}get backgroundLocationUpdatesDisabled(){return this._messages.event("system.background-location-updates-disabled")}get urlOpened(){return this._messages.event("system.url-opened")}}

package/messaging/registry/ui.d.ts

@@ -1,3 +1,4 @@
+import type { ItemRef } from "app-config/common/ItemRef.js";
 import type { UIDensity } from "../../app-config/common/BrandingModelProperties.js";
 import type { TranslatableText, TranslateOptions } from "../../app-config/common/TranslatableText.js";
 import type { Command } from "../Command.js";
@@ -363,6 +364,14 @@ export declare class UIOperations extends OperationRegistry {
      * Gets user confirmation by way of a popup box.
      */
     get confirm(): Operation<ConfirmOperationArgs, boolean>;
+    /**
+     * Get the IDs of components in the current layout that are backed by the
+     * given model. Most models are used by a single component, but in some
+     * cases multiple components can share a model.
+     *
+     * @webOnly
+     */
+    get getComponentIds(): Operation<ItemRef, string>;
     /**
      * Gets the current locale code for the application. (example: "en", "fr" or
      * "de-AT").

package/messaging/registry/ui.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends e{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get makeAvailable(){return this._messages.command("ui.make-available")}get makeUnavailable(){return this._messages.command("ui.make-unavailable")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends s{get confirm(){return this._messages.operation("ui.confirm")}get getLocale(){return this._messages.operation("ui.get-locale")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}get prompt(){return this._messages.operation("ui.prompt")}}export class UIEvents extends t{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends e{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get makeAvailable(){return this._messages.command("ui.make-available")}get makeUnavailable(){return this._messages.command("ui.make-unavailable")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends s{get confirm(){return this._messages.operation("ui.confirm")}get getComponentIds(){return this._messages.operation("ui.get-component-ids")}get getLocale(){return this._messages.operation("ui.get-locale")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}get prompt(){return this._messages.operation("ui.prompt")}}export class UIEvents extends t{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}