@vertigis/viewer-spec 58.4.0 → 58.6.0

package/messaging/Event.d.ts

@@ -3,7 +3,7 @@ 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>;
+export type EventCallback<T> = (arg?: T, publisher?: Model, eventName?: string) => void | Promise<void>;
 /**
  * A named event.
  */

package/messaging/registry/system.d.ts

@@ -1,4 +1,5 @@
 import type Point from "@arcgis/core/geometry/Point.js";
+import type { Action } from "@vertigis/arcgis-extensions/support/Action.js";
 import type { ItemRef } from "app-config/common/ItemRef.js";
 import type { CoordinateOptionProperties } from "app-config/web/CoordinateModelProperties.js";
 import type { Command } from "../Command.js";
@@ -36,6 +37,21 @@ export interface DownloadArgs {
      */
     fileNameExtension?: string;
 }
+/**
+ * Arguments for the system.repeat-action command.
+ */
+export interface RepeatActionArgs {
+    /**
+     * The actions to be repeatedly executed.
+     */
+    action?: Action;
+    /**
+     * The number of times actions will be executed. If omitted or given a value
+     * of less than 1, actions will continue to be executed until manual
+     * termination.
+     */
+    repetitions?: number;
+}
 /**
  * Arguments for the system.read-file operation.
  */
@@ -168,6 +184,13 @@ export declare class SystemCommands extends CommandRegistry {
      * @webOnly
      */
     get displaySharingLink(): Command<string>;
+    /**
+     * Executes Actions repeatedly until manually terminated or until given
+     * number of repetitions are fulfilled. Web only.
+     *
+     * @webOnly
+     */
+    get repeatAction(): Command<RepeatActionArgs | Action>;
     /**
      * Initiates a file download of the specified Blob to the user. Web only.
      *

package/messaging/registry/system.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class SystemCommands extends e{_prefix="system";get displaySharingLink(){return this._get("display-sharing-link")}get downloadFile(){return this._get("download-file")}get openUrl(){return this._get("open-url")}get keepScreenOn(){return this._get("keep-screen-on")}get enableBackgroundLocationUpdates(){return this._get("enable-background-location-updates")}get disableBackgroundLocationUpdates(){return this._get("disable-background-location-updates")}get haptics(){return this._get("haptics")}}export class SystemOperations extends r{_prefix="system";get readUrl(){return this._get("read-url")}get readFile(){return this._get("read-file")}get readFiles(){return this._get("read-files")}get getSharingLink(){return this._get("get-sharing-link")}}export class SystemEvents extends t{_prefix="system";get backgroundLocationUpdatesEnabled(){return this._get("background-location-updates-enabled")}get backgroundLocationUpdatesDisabled(){return this._get("background-location-updates-disabled")}get urlOpened(){return this._get("url-opened")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class SystemCommands extends e{_prefix="system";get displaySharingLink(){return this._get("display-sharing-link")}get repeatAction(){return this._get("repeat-action")}get downloadFile(){return this._get("download-file")}get openUrl(){return this._get("open-url")}get keepScreenOn(){return this._get("keep-screen-on")}get enableBackgroundLocationUpdates(){return this._get("enable-background-location-updates")}get disableBackgroundLocationUpdates(){return this._get("disable-background-location-updates")}get haptics(){return this._get("haptics")}}export class SystemOperations extends r{_prefix="system";get readUrl(){return this._get("read-url")}get readFile(){return this._get("read-file")}get readFiles(){return this._get("read-files")}get getSharingLink(){return this._get("get-sharing-link")}}export class SystemEvents extends t{_prefix="system";get backgroundLocationUpdatesEnabled(){return this._get("background-location-updates-enabled")}get backgroundLocationUpdatesDisabled(){return this._get("background-location-updates-disabled")}get urlOpened(){return this._get("url-opened")}}

package/messaging/registry/ui.d.ts

@@ -120,6 +120,11 @@ export interface DisplayNotificationArgs {
      * Defaults to true. Mobile only.
      */
     autoClose?: boolean;
+    /**
+     * Callback function that is triggered when a notification is closed. Web
+     * only.
+     */
+    onClose?: () => void;
 }
 /**
  * The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'.

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

@@ -1478,6 +1478,10 @@
                     "description": "Notifications in the same notification group are mutually exclusive, and will supersede one another. Mobile only.",
                     "type": "string"
                 },
+                "onClose": {
+                    "$ref": "__type",
+                    "description": "Callback function that is triggered when a notification is closed. Web only."
+                },
                 "position": {
                     "$ref": "Position",
                     "description": "The position of the notification on the screen. Web only."

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

@@ -1706,6 +1706,10 @@
                     "description": "Notifications in the same notification group are mutually exclusive, and will supersede one another. Mobile only.",
                     "type": "string"
                 },
+                "onClose": {
+                    "$ref": "__type",
+                    "description": "Callback function that is triggered when a notification is closed. Web only."
+                },
                 "position": {
                     "$ref": "Position",
                     "description": "The position of the notification on the screen. Web only."

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

@@ -606,6 +606,31 @@
         "@vertigis.arcgis-extensions.support.Action.Action": {
             "$ref": "#/definitions/viewer-spec.Action"
         },
+        "@vertigis.arcgis-extensions.support.Action.BoundAction": {
+            "additionalProperties": false,
+            "description": "An action that is bound to arguments.",
+            "properties": {
+                "arguments": {
+                    "description": "Arguments for the action. Can either be a primitive value (string, number, boolean), or a plain JSON object containing named arguments."
+                },
+                "name": {
+                    "description": "Determines which action to perform. It is up to the calling application how it transforms an action name into actual executable code.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "arguments",
+                "name"
+            ],
+            "type": "object"
+        },
+        "@vertigis.arcgis-extensions.support.Action.CompositeAction": {
+            "description": "A composite action that is made up of a sequence of one or more actions. The intent is that the application should execute these in the given order. If any of the actions produces an output, that should be used as the input arguments for all subsequent actions.",
+            "items": {
+                "$ref": "#/definitions/SimpleAction"
+            },
+            "type": "array"
+        },
         "@vertigis.arcgis-extensions.support.FormatSettings.FormatSettingsProperties": {
             "additionalProperties": false,
             "description": "Properties that can be passed into the constructor for {@link FormatSettings}.",
@@ -2312,6 +2337,10 @@
                     "description": "Notifications in the same notification group are mutually exclusive, and will supersede one another. Mobile only.",
                     "type": "string"
                 },
+                "onClose": {
+                    "$ref": "__type",
+                    "description": "Callback function that is triggered when a notification is closed. Web only."
+                },
                 "position": {
                     "$ref": "Position",
                     "description": "The position of the notification on the screen. Web only."
@@ -5696,6 +5725,21 @@
             },
             "type": "object"
         },
+        "RepeatActionArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the system.repeat-action command.",
+            "properties": {
+                "action": {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.support.Action.Action",
+                    "description": "The actions to be repeatedly executed."
+                },
+                "repetitions": {
+                    "description": "The number of times actions will be executed. If omitted or given a value of less than 1, actions will continue to be executed until manual termination.",
+                    "type": "number"
+                }
+            },
+            "type": "object"
+        },
         "ReportDataSource": {
             "additionalProperties": false,
             "description": "Represents a data source for VertiGIS Studio Reporting. A data source created at report design time will be replaced by this data source at runtime.",
@@ -6913,6 +6957,17 @@
             },
             "type": "object"
         },
+        "SimpleAction": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.support.Action.BoundAction"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Defines a single action to perform."
+        },
         "SketchTool": {
             "description": "The type of tool used for sketching.",
             "enum": [
@@ -22366,6 +22421,29 @@
             },
             "type": "array"
         },
+        "system.repeat-action": {
+            "description": "Executes Actions repeatedly until manually terminated or until given number of repetitions are fulfilled. Web only.",
+            "enum": [
+                "system.repeat-action"
+            ]
+        },
+        "system.repeat-action:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.support.Action.BoundAction"
+                },
+                {
+                    "$ref": "#/definitions/@vertigis.arcgis-extensions.support.Action.CompositeAction",
+                    "description": "A composite action that is made up of a sequence of one or more actions. The intent is that the application should execute these in the given order. If any of the actions produces an output, that should be used as the input arguments for all subsequent actions."
+                },
+                {
+                    "$ref": "#/definitions/RepeatActionArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
         "tasks.filter-results.by-geometry-type": {
             "description": "Returns FeatureSources that have a geometry type that matches the supplied type. Web only.",
             "enum": [
@@ -25074,6 +25152,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/system.repeat-action:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/system.repeat-action"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -25826,6 +25920,9 @@
                 {
                     "$ref": "#/definitions/system.open-url"
                 },
+                {
+                    "$ref": "#/definitions/system.repeat-action"
+                },
                 {
                     "$ref": "#/definitions/ui.activate"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "58.4.0",
+  "version": "58.6.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 VertiGIS Studio Viewer Specification.
  */
-export declare const version = "58.4.0";
+export declare const version = "58.6.0";

package/version.js

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