@vertigis/viewer-spec 48.11.0 → 48.12.0

package/messaging/registry/Operations.d.ts

@@ -25,6 +25,7 @@ import { SystemOperations } from "./system.js";
 import { TasksOperations } from "./tasks.js";
 import { UIOperations } from "./ui.js";
 import { ViewerOperations } from "./viewer.js";
+import { WorkflowOperations } from "./workflow.js";
 export declare class Operations extends OperationRegistry {
     readonly arcade: ArcadeOperations;
     readonly auth: AuthOperations;
@@ -51,6 +52,7 @@ export declare class Operations extends OperationRegistry {
     readonly tasks: TasksOperations;
     readonly ui: UIOperations;
     readonly viewer: ViewerOperations;
+    readonly workflow: WorkflowOperations;
     /**
      * @deprecated
      */

package/messaging/registry/Operations.js

@@ -1 +1 @@
-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{EditOperations}from"./edit.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.edit=new EditOperations(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{EditOperations}from"./edit.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";import{WorkflowOperations}from"./workflow.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.edit=new EditOperations(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.workflow=new WorkflowOperations(this._messages),this.debugConsole=new DebugConsoleOperations(this._messages)}}

package/messaging/registry/workflow.d.ts

@@ -2,11 +2,10 @@ import type { Command } from "../Command.js";
 import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
 import type { MapsLike } from "../common.js";
-/**
- * Arguments for the workflow.run command.
- */
-export interface RunWorkflowArgs {
+interface ExecuteWorkflowArgs {
     /**
      * The ID of the workflow item in app config.
      */
@@ -46,6 +45,11 @@ export interface RunWorkflowArgs {
      * child of the targeted container, and removed when the workflow finishes running.
      */
     target?: string;
+}
+/**
+ * Arguments for the workflow.run command.
+ */
+export interface RunWorkflowArgs extends ExecuteWorkflowArgs {
     /**
      * Whether or not the workflow should be executed asynchronously. If this
      * property is true, the workflow will be executed but the command will not
@@ -55,6 +59,11 @@ export interface RunWorkflowArgs {
      */
     async?: boolean;
 }
+/**
+ * Arguments for the workflow.evaluate command.
+ */
+export interface EvaluateWorkflowArgs extends ExecuteWorkflowArgs {
+}
 interface WorkflowModel {
 }
 /**
@@ -95,7 +104,8 @@ export interface WorkflowFinishedEventArgs extends WorkflowEventBase {
 export declare type WorkflowEvent = unknown;
 export declare class WorkflowCommands extends CommandRegistry {
     /**
-     * Runs a workflow with the given arguments.
+     * Runs a workflow with the given arguments. See the `workflow.evaluate`
+     * operation if you want to run a workflow and expect output values to be returned.
      */
     get run(): Command<RunWorkflowArgs>;
     /**
@@ -111,6 +121,15 @@ export declare class WorkflowCommands extends CommandRegistry {
      */
     get cancel(): Command<string>;
 }
+export declare class WorkflowOperations extends OperationRegistry {
+    /**
+     * Runs a workflow with the given arguments and returns the workflow's
+     * output as the result of the operation. The output in the workflow is set
+     * using the "Set Workflow Output" activity. See the "workflow.run" command
+     * if you want to run a workflow without any output values.
+     */
+    get evaluate(): Operation<EvaluateWorkflowArgs, Record<string, unknown>>;
+}
 export declare class WorkflowEvents extends EventRegistry {
     /**
      * Raised when a workflow has started running.

package/messaging/registry/workflow.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";export class WorkflowCommands extends CommandRegistry{get run(){return this._messages.command("workflow.run")}get refresh(){return this._messages.command("workflow.refresh")}get cancel(){return this._messages.command("workflow.cancel")}}export class WorkflowEvents extends EventRegistry{get workflowStarted(){return this._messages.event("workflow.workflow-started")}get starting(){return this._messages.event("workflow.starting")}get workflowFinished(){return this._messages.event("workflow.workflow-finished")}get workflowError(){return this._messages.event("workflow.workflow-error")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class WorkflowCommands extends CommandRegistry{get run(){return this._messages.command("workflow.run")}get refresh(){return this._messages.command("workflow.refresh")}get cancel(){return this._messages.command("workflow.cancel")}}export class WorkflowOperations extends OperationRegistry{get evaluate(){return this._messages.operation("workflow.evaluate")}}export class WorkflowEvents extends EventRegistry{get workflowStarted(){return this._messages.event("workflow.workflow-started")}get starting(){return this._messages.event("workflow.starting")}get workflowFinished(){return this._messages.event("workflow.workflow-finished")}get workflowError(){return this._messages.event("workflow.workflow-error")}}

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

@@ -1185,6 +1185,48 @@
             ],
             "type": "string"
         },
+        "EvaluateWorkflowArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the workflow.evaluate command.",
+            "properties": {
+                "commandArgumentInput": {
+                    "description": "The workflow input that the command's context will map to.",
+                    "type": "string"
+                },
+                "icon": {
+                    "description": "An icon to display for the workflow.",
+                    "type": "string"
+                },
+                "id": {
+                    "description": "The ID of the workflow item in app config.",
+                    "type": "string"
+                },
+                "inputs": {
+                    "$ref": "__type",
+                    "description": "The inputs to be passed into the workflow."
+                },
+                "instanceId": {
+                    "description": "A unique Id to identify an instance of this workflow running.",
+                    "type": "string"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map to target, if omitted Web will attempt to choose the best map for you."
+                },
+                "target": {
+                    "description": "The layout ID of the workflow component to use for any workflow forms, or the ID of a container component like taskbar, panel, stack, etc. In the latter case, a new workflow component will be created dynamically as a child of the targeted container, and removed when the workflow finishes running.",
+                    "type": "string"
+                },
+                "title": {
+                    "description": "The title of the workflow.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "id"
+            ],
+            "type": "object"
+        },
         "Features": {
             "anyOf": [
                 {
@@ -12771,6 +12813,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/workflow.evaluate:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/workflow.evaluate"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -12955,6 +13013,9 @@
                 {
                     "$ref": "#/definitions/ui.set-theme"
                 },
+                {
+                    "$ref": "#/definitions/workflow.evaluate"
+                },
                 {
                     "$ref": "#/definitions/workflow.run"
                 }
@@ -13220,8 +13281,17 @@
                 }
             ]
         },
+        "workflow.evaluate": {
+            "description": "Runs a workflow with the given arguments and returns the workflow's output as the result of the operation. The output in the workflow is set using the \"Set Workflow Output\" activity. See the \"workflow.run\" command if you want to run a workflow without any output values.",
+            "enum": [
+                "workflow.evaluate"
+            ]
+        },
+        "workflow.evaluate:input": {
+            "$ref": "#/definitions/EvaluateWorkflowArgs"
+        },
         "workflow.run": {
-            "description": "Runs a workflow with the given arguments.",
+            "description": "Runs a workflow with the given arguments. See the `workflow.evaluate` operation if you want to run a workflow and expect output values to be returned.",
             "enum": [
                 "workflow.run"
             ]

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

@@ -1431,6 +1431,48 @@
             },
             "type": "object"
         },
+        "EvaluateWorkflowArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the workflow.evaluate command.",
+            "properties": {
+                "commandArgumentInput": {
+                    "description": "The workflow input that the command's context will map to.",
+                    "type": "string"
+                },
+                "icon": {
+                    "description": "An icon to display for the workflow.",
+                    "type": "string"
+                },
+                "id": {
+                    "description": "The ID of the workflow item in app config.",
+                    "type": "string"
+                },
+                "inputs": {
+                    "$ref": "__type",
+                    "description": "The inputs to be passed into the workflow."
+                },
+                "instanceId": {
+                    "description": "A unique Id to identify an instance of this workflow running.",
+                    "type": "string"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map to target, if omitted Web will attempt to choose the best map for you."
+                },
+                "target": {
+                    "description": "The layout ID of the workflow component to use for any workflow forms, or the ID of a container component like taskbar, panel, stack, etc. In the latter case, a new workflow component will be created dynamically as a child of the targeted container, and removed when the workflow finishes running.",
+                    "type": "string"
+                },
+                "title": {
+                    "description": "The title of the workflow.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "id"
+            ],
+            "type": "object"
+        },
         "ExportMapImageArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"map.export-image\" operation.",
@@ -15588,6 +15630,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/workflow.evaluate:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/workflow.evaluate"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -16004,6 +16062,9 @@
                 {
                     "$ref": "#/definitions/workflow.cancel"
                 },
+                {
+                    "$ref": "#/definitions/workflow.evaluate"
+                },
                 {
                     "$ref": "#/definitions/workflow.refresh"
                 },
@@ -16819,6 +16880,15 @@
         "workflow.cancel:input": {
             "type": "string"
         },
+        "workflow.evaluate": {
+            "description": "Runs a workflow with the given arguments and returns the workflow's output as the result of the operation. The output in the workflow is set using the \"Set Workflow Output\" activity. See the \"workflow.run\" command if you want to run a workflow without any output values.",
+            "enum": [
+                "workflow.evaluate"
+            ]
+        },
+        "workflow.evaluate:input": {
+            "$ref": "#/definitions/EvaluateWorkflowArgs"
+        },
         "workflow.refresh": {
             "description": "Refreshes a workflow with the given arguments.",
             "enum": [
@@ -16829,7 +16899,7 @@
             "$ref": "#/definitions/RunWorkflowArgs"
         },
         "workflow.run": {
-            "description": "Runs a workflow with the given arguments.",
+            "description": "Runs a workflow with the given arguments. See the `workflow.evaluate` operation if you want to run a workflow and expect output values to be returned.",
             "enum": [
                 "workflow.run"
             ]

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

@@ -1958,6 +1958,48 @@
             ],
             "type": "string"
         },
+        "EvaluateWorkflowArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the workflow.evaluate command.",
+            "properties": {
+                "commandArgumentInput": {
+                    "description": "The workflow input that the command's context will map to.",
+                    "type": "string"
+                },
+                "icon": {
+                    "description": "An icon to display for the workflow.",
+                    "type": "string"
+                },
+                "id": {
+                    "description": "The ID of the workflow item in app config.",
+                    "type": "string"
+                },
+                "inputs": {
+                    "$ref": "__type",
+                    "description": "The inputs to be passed into the workflow."
+                },
+                "instanceId": {
+                    "description": "A unique Id to identify an instance of this workflow running.",
+                    "type": "string"
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map to target, if omitted Web will attempt to choose the best map for you."
+                },
+                "target": {
+                    "description": "The layout ID of the workflow component to use for any workflow forms, or the ID of a container component like taskbar, panel, stack, etc. In the latter case, a new workflow component will be created dynamically as a child of the targeted container, and removed when the workflow finishes running.",
+                    "type": "string"
+                },
+                "title": {
+                    "description": "The title of the workflow.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "id"
+            ],
+            "type": "object"
+        },
         "Features": {
             "anyOf": [
                 {
@@ -19954,6 +19996,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/workflow.evaluate:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/workflow.evaluate"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -20402,6 +20460,9 @@
                 {
                     "$ref": "#/definitions/viewer.set-debug-mode"
                 },
+                {
+                    "$ref": "#/definitions/workflow.evaluate"
+                },
                 {
                     "$ref": "#/definitions/workflow.run"
                 }
@@ -21633,8 +21694,17 @@
         "viewer.set-debug-mode:input": {
             "type": "boolean"
         },
+        "workflow.evaluate": {
+            "description": "Runs a workflow with the given arguments and returns the workflow's output as the result of the operation. The output in the workflow is set using the \"Set Workflow Output\" activity. See the \"workflow.run\" command if you want to run a workflow without any output values.",
+            "enum": [
+                "workflow.evaluate"
+            ]
+        },
+        "workflow.evaluate:input": {
+            "$ref": "#/definitions/EvaluateWorkflowArgs"
+        },
         "workflow.run": {
-            "description": "Runs a workflow with the given arguments.",
+            "description": "Runs a workflow with the given arguments. See the `workflow.evaluate` operation if you want to run a workflow and expect output values to be returned.",
             "enum": [
                 "workflow.run"
             ]

package/package.json

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

package/version.js

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