@vertigis/viewer-spec 43.6.0 → 44.0.0

package/messaging/Operation.d.ts

@@ -1,4 +1,5 @@
 import type { CancelToken } from "@vertigis/arcgis-extensions/support/Cancellable";
+import type { Event } from "./Event.js";
 import type { Message, MessageExecuteOptions } from "./Message.js";
 /**
  * A named operation. Operations compute a value, but don't generally alter the
@@ -9,6 +10,15 @@ export interface Operation<T = void, TResult = undefined> extends Message {
      * The name of the operation.
      */
     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 operation has been initialized.
+     */
+    readonly isInitialized: boolean;
     /**
      * Executes the operation and returns its result.
      *
@@ -17,6 +27,18 @@ export interface Operation<T = void, TResult = undefined> extends Message {
      * behavior.
      */
     execute: (argument: T, options?: CancelToken | MessageExecuteOptions) => Promise<TResult>;
+    /**
+     * Determines whether the operation can execute with the given arguments.
+     *
+     * @param argument The operation arguments.
+     */
+    canExecute(argument?: T): boolean;
+    /**
+     * Initializes the operation if it is not already initialized. Attempting to
+     * execute an operation will automatically initialize it, however calling
+     * canExecute() will always return false until the operation is initialized.
+     */
+    initialize(): Promise<void>;
 }
 /**
  * Context that will be passed in to each behavior for an operation.

package/messaging/registry/Operations.d.ts

@@ -1,5 +1,6 @@
 import { OperationRegistry } from "../OperationRegistry.js";
 import { AppOperations } from "./app.js";
+import { ArcadeOperations } from "./arcade.js";
 import { AuthOperations } from "./auth.js";
 import { BasemapOperations } from "./basemap.js";
 import { ChartOperations } from "./charts.js";
@@ -24,6 +25,7 @@ import { TasksOperations } from "./tasks.js";
 import { UIOperations } from "./ui.js";
 import { ViewerOperations } from "./viewer.js";
 export declare class Operations extends OperationRegistry {
+    readonly arcade: ArcadeOperations;
     readonly auth: AuthOperations;
     readonly app: AppOperations;
     readonly basemap: BasemapOperations;

package/messaging/registry/Operations.js

@@ -1 +1 @@
-import{OperationRegistry}from"../OperationRegistry.js";import{AppOperations}from"./app.js";import{AuthOperations}from"./auth.js";import{BasemapOperations}from"./basemap.js";import{ChartOperations}from"./charts.js";import{DebugConsoleOperations}from"./debugConsole.js";import{DrawingOperations}from"./drawing.js";import{FileOperations}from"./file.js";import{GeocodeOperations}from"./geocode.js";import{GeolocationOperations}from"./geolocation.js";import{GeometryOperations}from"./geometry.js";import{HighlightsOperations}from"./highlights.js";import{KpiOperations}from"./kpi.js";import{LogViewerOperations}from"./logViewer.js";import{MapOperations}from"./map.js";import{MeasurementOperations}from"./measurement.js";import{MessagingOperations}from"./messaging.js";import{NetworkOperations}from"./network.js";import{OfflineOperations}from"./offline.js";import{ResultsOperations}from"./results.js";import{SketchingOperations}from"./sketching.js";import{SystemOperations}from"./system.js";import{TasksOperations}from"./tasks.js";import{UIOperations}from"./ui.js";import{ViewerOperations}from"./viewer.js";export class Operations extends OperationRegistry{constructor(){super(...arguments),this.auth=new AuthOperations(this._messages),this.app=new AppOperations(this._messages),this.basemap=new BasemapOperations(this._messages),this.charts=new ChartOperations(this._messages),this.drawing=new DrawingOperations(this._messages),this.file=new FileOperations(this._messages),this.geocode=new GeocodeOperations(this._messages),this.geolocation=new GeolocationOperations(this._messages),this.geometry=new GeometryOperations(this._messages),this.highlights=new HighlightsOperations(this._messages),this.kpi=new KpiOperations(this._messages),this.logViewer=new LogViewerOperations(this._messages),this.map=new MapOperations(this._messages),this.measurement=new MeasurementOperations(this._messages),this.messaging=new MessagingOperations(this._messages),this.network=new NetworkOperations(this._messages),this.offline=new OfflineOperations(this._messages),this.sketching=new SketchingOperations(this._messages),this.system=new SystemOperations(this._messages),this.results=new ResultsOperations(this._messages),this.tasks=new TasksOperations(this._messages),this.ui=new UIOperations(this._messages),this.viewer=new ViewerOperations(this._messages),this.debugConsole=new DebugConsoleOperations(this._messages)}}
+import{OperationRegistry}from"../OperationRegistry.js";import{AppOperations}from"./app.js";import{ArcadeOperations}from"./arcade.js";import{AuthOperations}from"./auth.js";import{BasemapOperations}from"./basemap.js";import{ChartOperations}from"./charts.js";import{DebugConsoleOperations}from"./debugConsole.js";import{DrawingOperations}from"./drawing.js";import{FileOperations}from"./file.js";import{GeocodeOperations}from"./geocode.js";import{GeolocationOperations}from"./geolocation.js";import{GeometryOperations}from"./geometry.js";import{HighlightsOperations}from"./highlights.js";import{KpiOperations}from"./kpi.js";import{LogViewerOperations}from"./logViewer.js";import{MapOperations}from"./map.js";import{MeasurementOperations}from"./measurement.js";import{MessagingOperations}from"./messaging.js";import{NetworkOperations}from"./network.js";import{OfflineOperations}from"./offline.js";import{ResultsOperations}from"./results.js";import{SketchingOperations}from"./sketching.js";import{SystemOperations}from"./system.js";import{TasksOperations}from"./tasks.js";import{UIOperations}from"./ui.js";import{ViewerOperations}from"./viewer.js";export class Operations extends OperationRegistry{constructor(){super(...arguments),this.arcade=new ArcadeOperations(this._messages),this.auth=new AuthOperations(this._messages),this.app=new AppOperations(this._messages),this.basemap=new BasemapOperations(this._messages),this.charts=new ChartOperations(this._messages),this.drawing=new DrawingOperations(this._messages),this.file=new FileOperations(this._messages),this.geocode=new GeocodeOperations(this._messages),this.geolocation=new GeolocationOperations(this._messages),this.geometry=new GeometryOperations(this._messages),this.highlights=new HighlightsOperations(this._messages),this.kpi=new KpiOperations(this._messages),this.logViewer=new LogViewerOperations(this._messages),this.map=new MapOperations(this._messages),this.measurement=new MeasurementOperations(this._messages),this.messaging=new MessagingOperations(this._messages),this.network=new NetworkOperations(this._messages),this.offline=new OfflineOperations(this._messages),this.sketching=new SketchingOperations(this._messages),this.system=new SystemOperations(this._messages),this.results=new ResultsOperations(this._messages),this.tasks=new TasksOperations(this._messages),this.ui=new UIOperations(this._messages),this.viewer=new ViewerOperations(this._messages),this.debugConsole=new DebugConsoleOperations(this._messages)}}

package/messaging/registry/arcade.d.ts

@@ -0,0 +1,100 @@
+import type { ItemRef } from "app-config/common/ItemRef.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Model } from "../common.js";
+/**
+ * The arguments for the arcade.run operation.
+ */
+export interface RunArcadeArgs {
+    /**
+     * The stringified Arcade script to run. If this property is included, the
+     * operation will return the result of the script.
+     */
+    executeScript?: string;
+    /**
+     * The stringified Arcade script used to determine whether or not the
+     * executeScript can/should be run. If no executeScript is provided and the
+     * canExecuteScript returns a truthy value, the operation will return its
+     * input arguments; otherwise, if the canEecuteScript returns a falsey
+     * value, it will throw a {@link Cancellation}.
+     */
+    canExecuteScript?: string;
+    /**
+     * An arguments object that provides named variables and associated values,
+     * which can be referenced from within the executeScript and
+     * canExecuteScript.
+     *
+     * NOTE: All variable keys must consist of only lowercase letters;
+     * camel-cased context variables will break the script when they are
+     * referenced at runtime.
+     */
+    arguments?: Record<string, unknown | ItemPropertyPath>;
+    /**
+     * Properties used to set a series of watch handles and/or event listeners
+     * on an item that will trigger the canExecuteChanged event for the
+     * 'arcade.run' operation.
+     */
+    watchHandles?: WatchEventHandleProperties[];
+}
+/**
+ * An object containing a propertyPath that used to retrieve a property value
+ * from the given item.
+ */
+export interface ItemPropertyPath {
+    /**
+     * The item from which to access a property value.
+     */
+    item: ItemRef | Model;
+    /**
+     * The path to a property on an item.
+     */
+    propertyPath: string;
+}
+export declare class ArcadeOperations extends OperationRegistry {
+    /**
+     * Runs a stringified Arcade script. If only a string is passed in as an
+     * argument, it is interpreted as an executeScript. If an executeSript is
+     * provided, the operation will return its result. If only a canExecute
+     * script is provided and it returns a truthy result, the operation will
+     * return its input arguments. If a canExecuteScript returns a falsey value,
+     * the operation will throw a {@link Cancellation}.
+     *
+     * @webOnly
+     *
+     */
+    get run(): Operation<RunArcadeArgs | string, unknown>;
+}
+/**
+ * Properties used to set a series of watch handles and/or event listeners on
+ * an item.
+ */
+export interface WatchEventHandleProperties {
+    /**
+     * The item whose properties will be watched for changes and/or events.
+     */
+    item: ItemRef | Model;
+    /**
+     * One or more properties on the item that will be watched for changes
+     * and/or events. Any strings will be used as propertyPaths that will be
+     * watched for changes; for this to work, the item and all properties
+     * referenced within the path (except for the last) must implement
+     * {@link Observable}.
+     */
+    watch: string | WatchEventProperty | (string | WatchEventProperty)[];
+}
+/**
+ * Properties on an item to watch, with an optional event name to listen for.
+ */
+export interface WatchEventProperty {
+    /**
+     * The path used to target a property on an item that will be watched for
+     * events. The watched property must implement {@link Evented}; this will
+     * effectively do `item[propertyPath].on(eventName)`.
+     */
+    propertyPath?: string;
+    /**
+     * The name of the event to listen for. If no propertyPath is included, the
+     * listener will go directly on the watched item.
+     */
+    eventName: string;
+}

package/messaging/registry/arcade.js

@@ -0,0 +1 @@
+import{OperationRegistry}from"../OperationRegistry.js";export class ArcadeOperations extends OperationRegistry{get run(){return this._messages.operation("arcade.run")}}

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

@@ -3480,6 +3480,31 @@
             ],
             "type": "object"
         },
+        "RunArcadeArgs": {
+            "additionalProperties": false,
+            "description": "The arguments for the arcade.run operation.",
+            "properties": {
+                "arguments": {
+                    "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. NOTE: All variable keys must consist of only lowercase letters; camel-cased context variables will break the script when they are referenced at runtime."
+                },
+                "canExecuteScript": {
+                    "description": "The stringified Arcade script used to determine whether or not the executeScript can/should be run. If no executeScript is provided and the canExecuteScript returns a truthy value, the operation will return its input arguments; otherwise, if the canEecuteScript returns a falsey value, it will throw a {@link Cancellation}.",
+                    "type": "string"
+                },
+                "executeScript": {
+                    "description": "The stringified Arcade script to run. If this property is included, the operation will return the result of the script.",
+                    "type": "string"
+                },
+                "watchHandles": {
+                    "description": "Properties used to set a series of watch handles and/or event listeners on an item that will trigger the canExecuteChanged event for the 'arcade.run' operation.",
+                    "items": {
+                        "$ref": "#/definitions/WatchEventHandleProperties"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "RunPrintArgs": {
             "additionalProperties": false,
             "description": "The arguments required by the printing.run command.",
@@ -4770,6 +4795,70 @@
             "description": "A component's visual state. The values will vary based on the component type.",
             "type": "string"
         },
+        "WatchEventHandleProperties": {
+            "additionalProperties": false,
+            "description": "Properties used to set a series of watch handles and/or event listeners on an item.",
+            "properties": {
+                "item": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "The item whose properties will be watched for changes and/or events."
+                },
+                "watch": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/WatchEventProperty"
+                        },
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/WatchEventProperty"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "One or more properties on the item that will be watched for changes and/or events. Any strings will be used as propertyPaths that will be watched for changes; for this to work, the item and all properties referenced within the path (except for the last) must implement {@link Observable}."
+                }
+            },
+            "required": [
+                "item",
+                "watch"
+            ],
+            "type": "object"
+        },
+        "WatchEventProperty": {
+            "additionalProperties": false,
+            "description": "Properties on an item to watch, with an optional event name to listen for.",
+            "properties": {
+                "eventName": {
+                    "description": "The name of the event to listen for. If no propertyPath is included, the listener will go directly on the watched item.",
+                    "type": "string"
+                },
+                "propertyPath": {
+                    "description": "The path used to target a property on an item that will be watched for events. The watched property must implement {@link Evented}; this will effectively do `item[propertyPath].on(eventName)`.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "eventName"
+            ],
+            "type": "object"
+        },
         "ZoomToLayerArgs": {
             "additionalProperties": false,
             "description": "Arguments for the map.zoom-to-layer-extent and map.zoom-to-layer-visible-scale commands.",
@@ -4880,6 +4969,22 @@
                 }
             ]
         },
+        "arcade.run": {
+            "description": "Runs a stringified Arcade script. If only a string is passed in as an argument, it is interpreted as an executeScript. If an executeSript is provided, the operation will return its result. If only a canExecute script is provided and it returns a truthy result, the operation will return its input arguments. If a canExecuteScript returns a falsey value, the operation will throw a {@link Cancellation}.",
+            "enum": [
+                "arcade.run"
+            ]
+        },
+        "arcade.run:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/RunArcadeArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
         "auth.get-current-user": {
             "description": "Gets the user that is currently signed into the application.",
             "enum": [
@@ -17075,6 +17180,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/arcade.run:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/arcade.run"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -18902,6 +19023,9 @@
                 {
                     "$ref": "#/definitions/app.load-project"
                 },
+                {
+                    "$ref": "#/definitions/arcade.run"
+                },
                 {
                     "$ref": "#/definitions/auth.sign-in"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "43.6.0",
+  "version": "44.0.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -34,11 +34,11 @@
   },
   "author": "VertiGIS Ltd.",
   "peerDependencies": {
-    "@vertigis/arcgis-extensions": ">= 33.5.4  < 34.0.0"
+    "@vertigis/arcgis-extensions": ">= 34.1.0  < 35.0.0"
   },
   "devDependencies": {
     "@arcgis/core": "4.21.2",
-    "@vertigis/arcgis-extensions": "33.5.4 ",
+    "@vertigis/arcgis-extensions": "34.1.0 ",
     "@types/glob": "7.1.4",
     "@types/json-stable-stringify": "1.0.33",
     "@types/node": "14.14.41",

package/version.d.ts

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

package/version.js

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