@vertigis/viewer-spec 58.10.2 → 58.12.0

package/messaging/registry/printing.d.ts

@@ -131,6 +131,16 @@ export interface PrintFinishedEventArgs extends PrintEventArgsBase {
  */
 export interface PrintProgressEventArgs extends PrintEventArgsBase {
 }
+/**
+ * Arguments for the printing.print-preparing event.
+ */
+export interface PrintPreparingEventArgs extends PrintEventArgsBase {
+}
+/**
+ * Arguments for the printing.print-prepared event.
+ */
+export interface PrintPreparedEventArgs extends PrintEventArgsBase {
+}
 /**
  * Arguments for the printing.print-started event.
  */
@@ -145,6 +155,18 @@ export declare class PrintCommands extends CommandRegistry {
 }
 export declare class PrintEvents extends EventRegistry {
     protected readonly _prefix = "printing";
+    /**
+     * Raised before a print gets prepared.
+     *
+     * @webOnly
+     */
+    get printPreparing(): Event<PrintPreparingEventArgs>;
+    /**
+     * Raised when a print was prepared, but not yet started printing.
+     *
+     * @webOnly
+     */
+    get printPrepared(): Event<PrintPreparedEventArgs>;
     /**
      * Raised when a print has started running.
      */

package/messaging/registry/printing.js

@@ -1 +1 @@
-import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export class PrintCommands extends r{_prefix="printing";get run(){return this._get("run")}}export class PrintEvents extends t{_prefix="printing";get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}
+import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export class PrintCommands extends r{_prefix="printing";get run(){return this._get("run")}}export class PrintEvents extends t{_prefix="printing";get printPreparing(){return this._get("print-preparing")}get printPrepared(){return this._get("print-prepared")}get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}

package/messaging/registry/ui.d.ts

@@ -292,13 +292,40 @@ export interface NarrateOptions extends TranslateOptions {
      */
     timeout?: number;
 }
+/**
+ * Arguments for the "ui.activate" and "ui.deactivate" commands.
+ *
+ * @webOnly
+ */
+export interface ActivationArgs {
+    /**
+     * The component to activate or deactivate. Can be identified by its ID or
+     * model.
+     */
+    component: ComponentId | Model;
+    /**
+     * Whether to validate the component's state before activation or
+     * deactivation. Defaults to `false` if not provided.
+     */
+    validateState?: boolean;
+}
+/**
+ * Arguments that can be passed to the "ui.activate" command. Supports a
+ * component's ID, its model, or detailed activation arguments.
+ */
+export type ActivateArgs = ActivationArgs | ComponentId | Model;
+/**
+ * Arguments that can be passed to the "ui.deactivate" command. Supports a
+ * component's ID, its model, or detailed deactivation arguments.
+ */
+export type DeactivateArgs = ActivationArgs | ComponentId | Model;
 export declare class UICommands extends CommandRegistry {
     protected readonly _prefix = "ui";
     /**
      * Activates a component with the given ID or model, causing it to become
      * visible. For VertiGIS Studio Mobile, only ID is supported.
      */
-    get activate(): Command<ComponentId | Model>;
+    get activate(): Command<ActivateArgs>;
     /**
      * Toggles the active state on a component with the given ID. Mobile only.
      *
@@ -321,7 +348,7 @@ export declare class UICommands extends CommandRegistry {
      * Deactivates a component with the given ID, causing it to disappear. For
      * VertiGIS Studio Mobile, only ID is supported.
      */
-    get deactivate(): Command<ComponentId | Model>;
+    get deactivate(): Command<DeactivateArgs>;
     /**
      * Displays a loading indicator and custom message to the user to indicate
      * that the UI is busy.

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

@@ -676,6 +676,45 @@
             ],
             "description": "A reference to a portal item."
         },
+        "ActivateArgs": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "$ref": "#/definitions/ActivationArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Arguments that can be passed to the \"ui.activate\" command. Supports a component's ID, its model, or detailed activation arguments."
+        },
+        "ActivationArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"ui.activate\" and \"ui.deactivate\" commands.",
+            "properties": {
+                "component": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "The component to activate or deactivate. Can be identified by its ID or model."
+                },
+                "validateState": {
+                    "description": "Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "component"
+            ],
+            "type": "object"
+        },
         "AddAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
@@ -1203,6 +1242,20 @@
             ],
             "type": "object"
         },
+        "DeactivateArgs": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "$ref": "#/definitions/ActivationArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Arguments that can be passed to the \"ui.deactivate\" command. Supports a component's ID, its model, or detailed deactivation arguments."
+        },
         "DeleteAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.delete-attachment\" command.",
@@ -14295,14 +14348,7 @@
             ]
         },
         "ui.activate:input": {
-            "anyOf": [
-                {
-                    "$ref": "#/definitions/Model"
-                },
-                {
-                    "type": "string"
-                }
-            ]
+            "$ref": "#/definitions/ActivateArgs"
         },
         "ui.alert": {
             "description": "Shows an alert to the user.",
@@ -14332,14 +14378,7 @@
             ]
         },
         "ui.deactivate:input": {
-            "anyOf": [
-                {
-                    "$ref": "#/definitions/Model"
-                },
-                {
-                    "type": "string"
-                }
-            ]
+            "$ref": "#/definitions/DeactivateArgs"
         },
         "ui.display-busy-state": {
             "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",

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

@@ -660,6 +660,45 @@
             ],
             "description": "A reference to a portal item."
         },
+        "ActivateArgs": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "$ref": "#/definitions/ActivationArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Arguments that can be passed to the \"ui.activate\" command. Supports a component's ID, its model, or detailed activation arguments."
+        },
+        "ActivationArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"ui.activate\" and \"ui.deactivate\" commands.",
+            "properties": {
+                "component": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "The component to activate or deactivate. Can be identified by its ID or model."
+                },
+                "validateState": {
+                    "description": "Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "component"
+            ],
+            "type": "object"
+        },
         "AddAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
@@ -1407,6 +1446,20 @@
             ],
             "type": "object"
         },
+        "DeactivateArgs": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "$ref": "#/definitions/ActivationArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Arguments that can be passed to the \"ui.deactivate\" command. Supports a component's ID, its model, or detailed deactivation arguments."
+        },
         "DeleteAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.delete-attachment\" command.",
@@ -16436,14 +16489,7 @@
             ]
         },
         "ui.activate:input": {
-            "anyOf": [
-                {
-                    "$ref": "#/definitions/Model"
-                },
-                {
-                    "type": "string"
-                }
-            ]
+            "$ref": "#/definitions/ActivateArgs"
         },
         "ui.active-toggle": {
             "description": "Toggles the active state on a component with the given ID. Mobile only.",
@@ -16491,14 +16537,7 @@
             ]
         },
         "ui.deactivate:input": {
-            "anyOf": [
-                {
-                    "$ref": "#/definitions/Model"
-                },
-                {
-                    "type": "string"
-                }
-            ]
+            "$ref": "#/definitions/DeactivateArgs"
         },
         "ui.display-busy-state": {
             "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",

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

@@ -835,6 +835,20 @@
             ],
             "description": "A reference to a portal item."
         },
+        "ActivateArgs": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "$ref": "#/definitions/ActivationArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Arguments that can be passed to the \"ui.activate\" command. Supports a component's ID, its model, or detailed activation arguments."
+        },
         "ActivateResultGroupArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"results.activate-group\" command.",
@@ -857,6 +871,31 @@
             },
             "type": "object"
         },
+        "ActivationArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"ui.activate\" and \"ui.deactivate\" commands.",
+            "properties": {
+                "component": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/Model"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "The component to activate or deactivate. Can be identified by its ID or model."
+                },
+                "validateState": {
+                    "description": "Whether to validate the component's state before activation or deactivation. Defaults to `false` if not provided.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "component"
+            ],
+            "type": "object"
+        },
         "AddAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.add-attachment\" command. Supported by both Web and Mobile.",
@@ -2011,6 +2050,20 @@
             ],
             "type": "object"
         },
+        "DeactivateArgs": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "$ref": "#/definitions/ActivationArgs"
+                },
+                {
+                    "type": "string"
+                }
+            ],
+            "description": "Arguments that can be passed to the \"ui.deactivate\" command. Supports a component's ID, its model, or detailed deactivation arguments."
+        },
         "DeleteAttachmentArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"edit.delete-attachment\" command.",
@@ -22655,14 +22708,7 @@
             ]
         },
         "ui.activate:input": {
-            "anyOf": [
-                {
-                    "$ref": "#/definitions/Model"
-                },
-                {
-                    "type": "string"
-                }
-            ]
+            "$ref": "#/definitions/ActivateArgs"
         },
         "ui.alert": {
             "description": "Shows an alert to the user.",
@@ -22692,14 +22738,7 @@
             ]
         },
         "ui.deactivate:input": {
-            "anyOf": [
-                {
-                    "$ref": "#/definitions/Model"
-                },
-                {
-                    "type": "string"
-                }
-            ]
+            "$ref": "#/definitions/DeactivateArgs"
         },
         "ui.display-busy-state": {
             "description": "Displays a loading indicator and custom message to the user to indicate that the UI is busy.",

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

@@ -1088,6 +1088,44 @@
             ],
             "type": "object"
         },
+        "PrintPreparedEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the printing.print-prepared event.",
+            "properties": {
+                "instanceId": {
+                    "description": "A unique ID to track the running of this print.",
+                    "type": "string"
+                },
+                "printTemplateId": {
+                    "description": "The ID of the print template being used.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "instanceId",
+                "printTemplateId"
+            ],
+            "type": "object"
+        },
+        "PrintPreparingEventArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the printing.print-preparing event.",
+            "properties": {
+                "instanceId": {
+                    "description": "A unique ID to track the running of this print.",
+                    "type": "string"
+                },
+                "printTemplateId": {
+                    "description": "The ID of the print template being used.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "instanceId",
+                "printTemplateId"
+            ],
+            "type": "object"
+        },
         "PrintProgressEventArgs": {
             "additionalProperties": false,
             "description": "Arguments for the printing.print-progress event.",
@@ -10899,6 +10937,24 @@
         "printing.print-finished:input": {
             "$ref": "#/definitions/PrintFinishedEventArgs"
         },
+        "printing.print-prepared": {
+            "description": "Raised when a print was prepared, but not yet started printing.",
+            "enum": [
+                "printing.print-prepared"
+            ]
+        },
+        "printing.print-prepared:input": {
+            "$ref": "#/definitions/PrintPreparedEventArgs"
+        },
+        "printing.print-preparing": {
+            "description": "Raised before a print gets prepared.",
+            "enum": [
+                "printing.print-preparing"
+            ]
+        },
+        "printing.print-preparing:input": {
+            "$ref": "#/definitions/PrintPreparingEventArgs"
+        },
         "printing.print-progress": {
             "description": "Raised while a print is running to provide updates on its status.",
             "enum": [
@@ -11204,6 +11260,12 @@
                 {
                     "$ref": "#/definitions/printing.print-finished"
                 },
+                {
+                    "$ref": "#/definitions/printing.print-prepared"
+                },
+                {
+                    "$ref": "#/definitions/printing.print-preparing"
+                },
                 {
                     "$ref": "#/definitions/printing.print-progress"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "58.10.2",
+  "version": "58.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 VertiGIS Studio Viewer Specification.
  */
-export declare const version = "58.10.2";
+export declare const version = "58.12.0";

package/version.js

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