@vertigis/viewer-spec 53.2.0 → 53.4.0

package/messaging/registry/reports.d.ts

@@ -4,6 +4,22 @@ import { CommandRegistry } from "../CommandRegistry.js";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { FeaturesLike } from "../common.js";
+/**
+ * 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.
+ */
+export interface ReportDataSource {
+    /**
+     * The name is the name of the data source whose data you want to replace.
+     * The name must match the name of the data source in the report.
+     */
+    name: string;
+    /**
+     * The value is an object that defines the data to use in the report. The
+     * value is defined using the same schema as the data source in the report.
+     */
+    value: unknown;
+}
 /**
  * The arguments required by the reports.run command.
  */
@@ -28,6 +44,10 @@ export interface RunReportArgs {
      * The features passed to the report.
      */
     features?: FeaturesLike;
+    /**
+     * Replace the data from one or more data sources at run time.
+     */
+    dataSources?: ReportDataSource | ReportDataSource[];
 }
 /**
  * Base for the Report Event Args interfaces.

package/messaging/registry/viewer.d.ts

@@ -15,7 +15,7 @@ export declare class ViewerCommands extends CommandRegistry {
      */
     get loadLayout(): Command<string | Model>;
     /**
-     * Post a message to the parent iframe of the viewer.
+     * Post a message to the parent frame of the viewer.
      *
      * @webOnly
      */
@@ -75,6 +75,12 @@ export declare class ViewerOperations extends OperationRegistry {
      * @webOnly
      */
     get getVersion(): Operation<void, string>;
+    /**
+     * Post a message to the parent frame of the viewer and await the reply.
+     *
+     * @webOnly
+     */
+    get postMessageAwaitReply(): Operation<unknown, unknown>;
 }
 /**
  * Arguments for the 'viewer.publish-event' command.

package/messaging/registry/viewer.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class ViewerCommands extends e{get loadLayout(){return this._messages.command("viewer.load-layout")}get postMessage(){return this._messages.command("viewer.post-message")}get publishEvent(){return this._messages.command("viewer.publish-event")}get setDebugMode(){return this._messages.command("viewer.set-debug-mode")}}export class ViewerEvents extends t{get layoutChanged(){return this._messages.event("viewer.layout-changed")}}export class ViewerOperations extends s{get getAllLayouts(){return this._messages.operation("viewer.get-all-layouts")}get getCurrentLayout(){return this._messages.operation("viewer.get-current-layout")}get getCapabilities(){return this._messages.operation("viewer.get-capabilities")}get getInDebugMode(){return this._messages.operation("viewer.get-in-debug-mode")}get getVersion(){return this._messages.operation("viewer.get-version")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class ViewerCommands extends e{get loadLayout(){return this._messages.command("viewer.load-layout")}get postMessage(){return this._messages.command("viewer.post-message")}get publishEvent(){return this._messages.command("viewer.publish-event")}get setDebugMode(){return this._messages.command("viewer.set-debug-mode")}}export class ViewerEvents extends t{get layoutChanged(){return this._messages.event("viewer.layout-changed")}}export class ViewerOperations extends s{get getAllLayouts(){return this._messages.operation("viewer.get-all-layouts")}get getCurrentLayout(){return this._messages.operation("viewer.get-current-layout")}get getCapabilities(){return this._messages.operation("viewer.get-capabilities")}get getInDebugMode(){return this._messages.operation("viewer.get-in-debug-mode")}get getVersion(){return this._messages.operation("viewer.get-version")}get postMessageAwaitReply(){return this._messages.operation("viewer.post-message-await-reply")}}

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

@@ -5043,6 +5043,24 @@
             },
             "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.",
+            "properties": {
+                "name": {
+                    "description": "The name is the name of the data source whose data you want to replace. The name must match the name of the data source in the report.",
+                    "type": "string"
+                },
+                "value": {
+                    "description": "The value is an object that defines the data to use in the report. The value is defined using the same schema as the data source in the report."
+                }
+            },
+            "required": [
+                "name",
+                "value"
+            ],
+            "type": "object"
+        },
         "Results": {
             "additionalProperties": false,
             "description": "Feature results from an operation.",
@@ -5240,6 +5258,20 @@
             "additionalProperties": false,
             "description": "The arguments required by the reports.run command.",
             "properties": {
+                "dataSources": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/ReportDataSource"
+                        },
+                        {
+                            "items": {
+                                "$ref": "#/definitions/ReportDataSource"
+                            },
+                            "type": "array"
+                        }
+                    ],
+                    "description": "Replace the data from one or more data sources at run time."
+                },
                 "features": {
                     "$ref": "#/definitions/FeaturesLike",
                     "description": "The features passed to the report."
@@ -23745,6 +23777,9 @@
                 {
                     "$ref": "#/definitions/viewer.post-message"
                 },
+                {
+                    "$ref": "#/definitions/viewer.post-message-await-reply"
+                },
                 {
                     "$ref": "#/definitions/viewer.set-debug-mode"
                 },
@@ -25319,11 +25354,17 @@
             ]
         },
         "viewer.post-message": {
-            "description": "Post a message to the parent iframe of the viewer.",
+            "description": "Post a message to the parent frame of the viewer.",
             "enum": [
                 "viewer.post-message"
             ]
         },
+        "viewer.post-message-await-reply": {
+            "description": "Post a message to the parent frame of the viewer and await the reply.",
+            "enum": [
+                "viewer.post-message-await-reply"
+            ]
+        },
         "viewer.set-debug-mode": {
             "description": "Turn the debug mode of the viewer on or off. This can also be done using the debug=true URL parameter.",
             "enum": [

package/package.json

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

package/version.js

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