@vertigis/viewer-spec 50.4.0 → 50.5.0

package/analytics/MobileAction.d.ts

@@ -28,6 +28,14 @@ export declare type MobileAction = CommonAction
  * Generic action. Payload: [wkid, transformation name].
  */
  | "gnss-device-transformation-override"
+/**
+ * RunTimedAction OR EndTimedAction.
+ */
+ | "file-initial-download"
+/**
+ * RunTimedAction OR EndTimedAction.
+ */
+ | "file-update-download"
 /**
  * RunTimedAction OR EndTimedAction.
  */

package/messaging/registry/file.d.ts

@@ -1,3 +1,6 @@
+/// <reference types="dotnet-bcl" />
+import type PortalItem from "@arcgis/core/portal/PortalItem.js";
+import type Exception from "dotnet-bcl/System/Exception";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
@@ -41,6 +44,75 @@ export interface OpenFileArgs {
      */
     fileName: string;
 }
+/**
+ * Information about a file download.
+ */
+export interface FileDownloadInfo {
+    /**
+     * The portal item from which this file is being downloaded.
+     */
+    portalItem: PortalItem;
+    /**
+     * The full path of the file being downloaded.
+     */
+    filePath: string;
+    /**
+     * A value indicating whether this download is updating a file. If true, it
+     * means that the file already existed on disk and a new version is being downloaded.
+     */
+    isUpdating: boolean;
+}
+/**
+ * Arguments for the 'file.download-started' event.
+ */
+export interface FileDownloadStartedEventArgs {
+    /**
+     * The collection of FileDownloadInfos describing the file downloads that
+     * have started.
+     */
+    fileDownloadInfos: FileDownloadInfo[];
+}
+/**
+ * The status of a portal item download job.
+ */
+export declare type PortalItemDownloadJobStatus = 
+/**
+ * Job is not started; either newly created or previously cancelled.
+ */
+"NotStarted"
+/**
+ * Download is in progress.
+ */
+ | "InProgress"
+/**
+ * Download has been interrupted.
+ */
+ | "Interrupted"
+/**
+ * Download has completed successfully.
+ */
+ | "Completed"
+/**
+ * The job has failed.
+ */
+ | "Failed";
+/**
+ * Arguments for the "file.download-ended" event.
+ */
+export interface FileDownloadEndedEventArgs extends FileDownloadInfo {
+    /**
+     * The status of the file download.
+     */
+    status: PortalItemDownloadJobStatus;
+    /**
+     * The exception that occurred during the file download.
+     */
+    exception?: Exception;
+    /**
+     * The duration of the download, in milliseconds.
+     */
+    downloadDuration: number;
+}
 export declare class FileOperations extends OperationRegistry {
     /**
      * Prompt the user to select a file from the file system, and return the
@@ -65,4 +137,16 @@ export declare class FileEvents extends EventRegistry {
      * @mobileOnly
      */
     get opened(): Event<OpenFileArgs>;
+    /**
+     * Raised when a file download starts or resumes.
+     *
+     * @mobileOnly
+     */
+    get downloadStarted(): Event<FileDownloadStartedEventArgs>;
+    /**
+     * Raised when a file download ends.
+     *
+     * @mobileOnly
+     */
+    get downloadEnded(): Event<FileDownloadEndedEventArgs>;
 }

package/messaging/registry/file.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class FileOperations extends OperationRegistry{get pickFile(){return this._messages.operation("file.pick-file")}}export class FileCommands extends CommandRegistry{get openFile(){return this._messages.command("file.open-file")}}export class FileEvents extends EventRegistry{get opened(){return this._messages.event("file.opened")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class FileOperations extends OperationRegistry{get pickFile(){return this._messages.operation("file.pick-file")}}export class FileCommands extends CommandRegistry{get openFile(){return this._messages.command("file.open-file")}}export class FileEvents extends EventRegistry{get opened(){return this._messages.event("file.opened")}get downloadStarted(){return this._messages.event("file.download-started")}get downloadEnded(){return this._messages.event("file.download-ended")}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "50.4.0",
+  "version": "50.5.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export declare const version = "50.4.0";
+export declare const version = "50.5.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex Viewer Specification.
  */
-export const version = "50.4.0";
+export const version = "50.5.0";