@vertigis/viewer-spec 53.3.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/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."

package/package.json

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