@vertigis/viewer-spec 59.28.0 → 59.29.0

package/messaging/DotNetTypes.d.ts

@@ -2,3 +2,8 @@ export interface TimeSpan {
 }
 export interface ConsoleKeyInfo {
 }
+/**
+ * {https://learn.microsoft.com/en-us/dotnet/api/system.datetime}.
+ */
+export interface DateTime {
+}

package/messaging/registry/messaging.d.ts

@@ -6,7 +6,7 @@ export declare class MessagingOperations extends OperationRegistry {
      * Attempts to merge an array of values into a single value that can be used
      * as an argument for a command or operation. For example:
      *
-     *     [features, { chart: "average-household-income" }];
+     * [features, { chart: "average-household-income" }];
      *
      * This would mix `features` obtained from some other source into arguments
      * intended for the "charts.display" command.

package/messaging/registry/offline.d.ts

@@ -10,6 +10,7 @@ import type FeatureTable from "esri-runtime-sdk/FeatureTable";
 import type OfflineMapSyncLayerResult from "esri-runtime-sdk/OfflineMapSyncLayerResult";
 import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
+import type { DateTime } from "../DotNetTypes.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
@@ -32,6 +33,21 @@ export interface CreateOfflineAreaArgs {
      */
     areaDetails: CustomOfflineAreaDetails;
 }
+/**
+ * Arguments for the "offline.get-areas" operation.
+ */
+export interface GetOfflineAreasArgs {
+    /**
+     * The map to look for areas from.
+     */
+    mapExtension?: MapExtension;
+    /**
+     * Whether the operation should retrieve cached data (true), or fetch data
+     * over the network (false). Defaults to false (fetch data over the
+     * network).
+     */
+    getCached?: boolean;
+}
 /**
  * Arguments for various offline commands.
  */
@@ -112,12 +128,123 @@ export interface AreaEditsSubmitStartedEventArgs {
  * the VertiGIS.Mobile SDK.
  */
 export interface OfflineAreaBase {
+    /**
+     * The Portal item ID of the online map this map area belongs to.
+     */
+    onlineMapId: string;
+    /**
+     * The time this map area was last updated.
+     */
+    updatedOn: DateTime;
+    /**
+     * The last time that this map area was activated.
+     */
+    lastActivated: DateTime;
+    /**
+     * A text string to display to the user describing this map area's current
+     * status.
+     */
+    statusText: string;
+    /**
+     * The title of this map area.
+     */
+    title: string;
+    /**
+     * A value indicating whether this map area can be removed from the list of
+     * available areas. Returns true for custom map areas; false for preplanned
+     * areas.
+     */
+    removable: boolean;
+    /**
+     * The file size of the map area, in bytes.
+     */
+    fileSizeInBytes: number;
+    /**
+     * The path to the mobile map package on the device.
+     */
+    path: string;
+    /**
+     * The name of a sideloaded TPK to use as a basemap. May be null.
+     */
+    sideloadedTilePackageName: string;
+    /**
+     * Whether the download of this area includes a basemap.
+     */
+    includesBasemap: boolean;
+    /**
+     * The current OfflineAreaState of this map area.
+     */
+    currentState: OfflineAreaStates;
+    /**
+     * The number of features which have been added to this map area and are
+     * pending sync.
+     */
+    numberOfAddedFeatures: number;
+    /**
+     * The number of features which have been removed from this map area and are
+     * pending sync.
+     */
+    numberOfDeletedFeatures: number;
+    /**
+     * The number of features which have been updated in this map area and are
+     * pending sync.
+     */
+    numberOfUpdatedFeatures: number;
+    /**
+     * The total number of edits pending sync; the sum of numberOfAddedFeatures,
+     * numberOfDeletedFeatures and numberOfUpdatedFeatures.
+     */
+    numberOfEditedFeatures: number;
+    /**
+     * A value indicating whether there are any edits pending sync in this map
+     * area; i.e. true if numberOfEditedFeatures is greater than 0.
+     */
+    hasEdits: boolean;
+    /**
+     * The progress of a download or sync operation in this map area. Value
+     * ranges from 0 to 1.
+     */
+    progress: number;
+    /**
+     * Whether this map area is currently active.
+     */
+    isActive: boolean;
+    /**
+     * Whether this map area is currently updating or submitting edits.
+     */
+    isSyncing: boolean;
+    /**
+     * The map that this map area belongs to.
+     */
+    map: MapExtension;
+    /**
+     * The geometry defining this map area.
+     */
+    areaOfInterest: GeometryUnion;
+    /**
+     * The collection of layers that failed being taken offline.
+     */
+    failedLayers: string[];
+    /**
+     * The collection of tables that failed being taken offline.
+     */
+    failedTables: string[];
+    /**
+     * The list of sources (layers and tables) that failed being taken offline;
+     * i.e. a union of failedLayers and failedTables.
+     */
+    failedSources: string[];
+    /**
+     * A value indicating whether there are any of the data sources failed being
+     * taken offline; i.e. true if failedSources count is greater than 0.
+     */
+    hasFailedSources: boolean;
 }
 /**
  * Corresponds to `VertiGIS.Mobile.Infrastructure.Offline.CustomOfflineArea` in
  * the VertiGIS.Mobile SDK.
  */
-export interface CustomOfflineArea {
+export interface CustomOfflineArea extends OfflineAreaBase {
 }
 /**
  * Defines the details for the creation of a custom offline map area.
@@ -156,6 +283,62 @@ export interface CustomOfflineAreaDetails {
  */
 export interface OfflineAreaStatus {
 }
+/**
+ * Corresponds to `VertiGIS.Mobile.Infrastructure.Offline.OfflineAreaStates` in
+ * the VertiGIS.Mobile SDK. This is a [flags
+ * enum](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/enum#enumeration-types-as-bit-flags).
+ */
+export declare enum OfflineAreaStates {
+    /**
+     * Not downloaded.
+     */
+    AVAILABLE_TO_DOWNLOAD = 0,
+    /**
+     * Downloading.
+     */
+    DOWNLOADING = 1,
+    /**
+     * Downloaded but not active.
+     */
+    DOWNLOADED = 2,
+    /**
+     * Active.
+     */
+    ACTIVE = 4,
+    /**
+     * Currently updating.
+     */
+    UPDATING = 8,
+    /**
+     * Edits are being submitted.
+     */
+    SUBMITTING_EDITS = 16,
+    /**
+     * Deletion will begin shortly, for example after the user has confirmed a
+     * prompt.
+     */
+    DELETION_PENDING = 32,
+    /**
+     * Deletion is in progress.
+     */
+    DELETION_IN_PROGRESS = 64,
+    /**
+     * Download has been triggered but has not yet started.
+     */
+    DOWNLOAD_STARTING = 128,
+    /**
+     * Activating.
+     */
+    ACTIVATING = 256,
+    /**
+     * Deactivating.
+     */
+    DEACTIVATING = 512,
+    /**
+     * Processing.
+     */
+    PROCESSING = 1024
+}
 /**
  * Corresponds to `VertiGIS.Mobile.Infrastructure.Offline.LayerEdits` in the
  * VertiGIS.Mobile SDK.
@@ -450,7 +633,14 @@ export declare class OfflineOperations extends OperationRegistry {
      *
      * @mobileOnly
      */
-    get getAreas(): Operation<MapExtension, OfflineAreaBase[]>;
+    get getAreas(): Operation<GetOfflineAreasArgs, OfflineAreaBase[]>;
+    /**
+     * Gets a list of available custom offline areas for the web map. Mobile
+     * only.
+     *
+     * @mobileOnly
+     */
+    get getCustomAreas(): Operation<MapExtension, OfflineAreaBase[]>;
     /**
      * Gets a list of layer edits for a given map area. Mobile only.
      *

package/messaging/registry/offline.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as a}from"../OperationRegistry.js";export class OfflineCommands extends e{_prefix="offline";get cancelCreateArea(){return this._get("cancel-create-area")}get cancelDownload(){return this._get("cancel-download")}get deleteArea(){return this._get("delete-area")}get displayCreateArea(){return this._get("display-create-area")}}export class OfflineEvents extends t{_prefix="offline";get areaActivated(){return this._get("area-activated")}get areaActivating(){return this._get("area-activating")}get areaDeleted(){return this._get("area-deleted")}get areaDownloadStarted(){return this._get("area-download-started")}get areaDownloadCanceled(){return this._get("area-download-canceled")}get areaDownloadFailed(){return this._get("area-download-failed")}get areaDownloaded(){return this._get("area-downloaded")}get areaUpdateStarted(){return this._get("area-update-started")}get areaUpdated(){return this._get("area-updated")}get areaUpdateFailed(){return this._get("area-update-failed")}get areaEditsSubmitStarted(){return this._get("area-edits-submit-started")}get areaEditsSubmitted(){return this._get("area-edits-submitted")}get areaEditsSubmitFailed(){return this._get("area-edits-submit-failed")}get customAreaCreated(){return this._get("custom-area-created")}get customAreaDeleted(){return this._get("custom-area-deleted")}get userWentOnline(){return this._get("user-went-online")}}export class OfflineOperations extends a{_prefix="offline";get createArea(){return this._get("create-area")}get getAreas(){return this._get("get-areas")}get getEdits(){return this._get("get-edits")}get activateArea(){return this._get("activate-area")}get downloadArea(){return this._get("download-area")}get goOnline(){return this._get("go-online")}get checkForActiveArea(){return this._get("check-for-active-area")}get submitEdits(){return this._get("submit-edits")}get updateArea(){return this._get("update-area")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as a}from"../OperationRegistry.js";export var OfflineAreaStates;!function(e){e[e.AVAILABLE_TO_DOWNLOAD=0]="AVAILABLE_TO_DOWNLOAD",e[e.DOWNLOADING=1]="DOWNLOADING",e[e.DOWNLOADED=2]="DOWNLOADED",e[e.ACTIVE=4]="ACTIVE",e[e.UPDATING=8]="UPDATING",e[e.SUBMITTING_EDITS=16]="SUBMITTING_EDITS",e[e.DELETION_PENDING=32]="DELETION_PENDING",e[e.DELETION_IN_PROGRESS=64]="DELETION_IN_PROGRESS",e[e.DOWNLOAD_STARTING=128]="DOWNLOAD_STARTING",e[e.ACTIVATING=256]="ACTIVATING",e[e.DEACTIVATING=512]="DEACTIVATING",e[e.PROCESSING=1024]="PROCESSING"}(OfflineAreaStates||(OfflineAreaStates={}));export class OfflineCommands extends e{_prefix="offline";get cancelCreateArea(){return this._get("cancel-create-area")}get cancelDownload(){return this._get("cancel-download")}get deleteArea(){return this._get("delete-area")}get displayCreateArea(){return this._get("display-create-area")}}export class OfflineEvents extends t{_prefix="offline";get areaActivated(){return this._get("area-activated")}get areaActivating(){return this._get("area-activating")}get areaDeleted(){return this._get("area-deleted")}get areaDownloadStarted(){return this._get("area-download-started")}get areaDownloadCanceled(){return this._get("area-download-canceled")}get areaDownloadFailed(){return this._get("area-download-failed")}get areaDownloaded(){return this._get("area-downloaded")}get areaUpdateStarted(){return this._get("area-update-started")}get areaUpdated(){return this._get("area-updated")}get areaUpdateFailed(){return this._get("area-update-failed")}get areaEditsSubmitStarted(){return this._get("area-edits-submit-started")}get areaEditsSubmitted(){return this._get("area-edits-submitted")}get areaEditsSubmitFailed(){return this._get("area-edits-submit-failed")}get customAreaCreated(){return this._get("custom-area-created")}get customAreaDeleted(){return this._get("custom-area-deleted")}get userWentOnline(){return this._get("user-went-online")}}export class OfflineOperations extends a{_prefix="offline";get createArea(){return this._get("create-area")}get getAreas(){return this._get("get-areas")}get getCustomAreas(){return this._get("get-custom-areas")}get getEdits(){return this._get("get-edits")}get activateArea(){return this._get("activate-area")}get downloadArea(){return this._get("download-area")}get goOnline(){return this._get("go-online")}get checkForActiveArea(){return this._get("check-for-active-area")}get submitEdits(){return this._get("submit-edits")}get updateArea(){return this._get("update-area")}}

package/messaging/schema/mobile-action.schema.json

@@ -2955,6 +2955,21 @@
             ],
             "type": "object"
         },
+        "GetOfflineAreasArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"offline.get-areas\" operation.",
+            "properties": {
+                "getCached": {
+                    "description": "Whether the operation should retrieve cached data (true), or fetch data over the network (false). Defaults to false (fetch data over the network).",
+                    "type": "boolean"
+                },
+                "mapExtension": {
+                    "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
+                    "description": "The map to look for areas from."
+                }
+            },
+            "type": "object"
+        },
         "GetTransformationArgs": {
             "additionalProperties": false,
             "description": "Arguments for getting a list of geographic transformations.",
@@ -16988,7 +17003,7 @@
             ]
         },
         "offline.get-areas:input": {
-            "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
+            "$ref": "#/definitions/GetOfflineAreasArgs"
         },
         "offline.get-areas:output": {
             "items": {
@@ -16996,6 +17011,21 @@
             },
             "type": "array"
         },
+        "offline.get-custom-areas": {
+            "description": "Gets a list of available custom offline areas for the web map. Mobile only.",
+            "enum": [
+                "offline.get-custom-areas"
+            ]
+        },
+        "offline.get-custom-areas:input": {
+            "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
+        },
+        "offline.get-custom-areas:output": {
+            "items": {
+                "$ref": "OfflineAreaBase"
+            },
+            "type": "array"
+        },
         "offline.get-edits": {
             "description": "Gets a list of layer edits for a given map area. Mobile only.",
             "enum": [
@@ -20853,6 +20883,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/offline.get-custom-areas:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/offline.get-custom-areas"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -21302,6 +21348,9 @@
                 {
                     "$ref": "#/definitions/offline.get-areas"
                 },
+                {
+                    "$ref": "#/definitions/offline.get-custom-areas"
+                },
                 {
                     "$ref": "#/definitions/offline.get-edits"
                 },

package/messaging/schema/web-action.schema.json

@@ -24126,7 +24126,7 @@
             ]
         },
         "messaging.mix-in-args": {
-            "description": "Attempts to merge an array of values into a single value that can be used as an argument for a command or operation. For example:\n\n    [features, { chart: \"average-household-income\" }];\n\nThis would mix `features` obtained from some other source into arguments intended for the \"charts.display\" command.\n\nIf the values cannot be merged, then the leftmost value is returned.\n\nNote that argument merging already occurs automatically in command chains; this explicit operation exists for advanced scenarios like VertiGIS Studio Workflow or custom code written using the SDK. Web only.",
+            "description": "Attempts to merge an array of values into a single value that can be used as an argument for a command or operation. For example:\n\n[features, { chart: \"average-household-income\" }];\n\nThis would mix `features` obtained from some other source into arguments intended for the \"charts.display\" command.\n\nIf the values cannot be merged, then the leftmost value is returned.\n\nNote that argument merging already occurs automatically in command chains; this explicit operation exists for advanced scenarios like VertiGIS Studio Workflow or custom code written using the SDK. Web only.",
             "enum": [
                 "messaging.mix-in-args"
             ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "59.28.0",
+  "version": "59.29.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -59,7 +59,7 @@
     "eslint-plugin-jsdoc": "48.2.1",
     "eslint-plugin-no-autofix": "1.2.3",
     "eslint-plugin-only-warn": "1.1.0",
-    "glob": "11.0.1",
+    "glob": "11.1.0",
     "lint-staged": "15.5.2",
     "path-equal": "1.2.5",
     "prettier": "3.2.5",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "59.28.0";
+export declare const version = "59.29.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "59.28.0";
+export const version = "59.29.0";