@vertigis/viewer-spec 51.3.0 → 51.4.0

package/messaging/registry/arcade.d.ts

@@ -1,11 +1,11 @@
 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";
+import type { HasFeatures, HasLayers, HasMaps, Model } from "../common.js";
 /**
  * The arguments for the arcade.run operation.
  */
-export interface RunArcadeArgs {
+export interface RunArcadeArgs extends HasMaps, HasLayers, HasFeatures {
     /**
      * The stringified Arcade script to run. If this property is included, the
      * operation will return the result of the script.
@@ -15,14 +15,18 @@ export interface RunArcadeArgs {
      * 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
+     * input arguments; otherwise, if the canExecuteScript 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.
+     * canExecuteScript. Note that context variables will be passed in if
+     * available under the well known arcade variable names: $feature,
+     * $features, $map, and $layer and $featuremap a constructed arcade
+     * dictionary that exposes a feature mapping dictionary keyed via feature
+     * source ID with the following values: id, title and features.
      *
      * NOTE: All variable keys must consist of only lowercase letters;
      * camel-cased context variables will break the script when they are
@@ -53,7 +57,7 @@ export interface ItemPropertyPath {
 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
+     * argument, it is interpreted as an executeScript. If an executeScript 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,

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

@@ -4249,16 +4249,28 @@
             "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."
+                    "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. Note that context variables will be passed in if available under the well known arcade variable names: $feature, $features, $map, and $layer and $featuremap a constructed arcade dictionary that exposes a feature mapping dictionary keyed via feature source ID with the following values: id, title and features. 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{@linkCancellation}.",
+                    "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 canExecuteScript returns a falsey value, it will throw a{@linkCancellation}.",
                     "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"
                 },
+                "features": {
+                    "$ref": "#/definitions/FeaturesLike",
+                    "description": "Features to use for the command/operation."
+                },
+                "layers": {
+                    "$ref": "#/definitions/LayersLike",
+                    "description": "Layer(s) to use for the command/operation."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "Map(s) to use for the command/operation."
+                },
                 "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": {
@@ -6026,7 +6038,7 @@
             ]
         },
         "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 }.",
+            "description": "Runs a stringified Arcade script. If only a string is passed in as an argument, it is interpreted as an executeScript. If an executeScript 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"
             ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "51.3.0",
+  "version": "51.4.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 = "51.3.0";
+export declare const version = "51.4.0";

package/version.js

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