@vertigis/viewer-spec 52.0.0 → 52.1.0

package/layout/schema/layout-common.xsd

@@ -222,6 +222,17 @@
                 </documentation>
             </annotation>
         </attribute>
+        <attribute name="available" type="boolean">
+            <annotation>
+                <documentation xml:lang="en">
+                    This property marks a component as being available. The
+                    interpretation of what effect this has is up to the component.
+                    Currently the only component that will react to this property
+                    is the task-bar, which will have the effect of showing/hiding
+                    the tab/button for that component. Defaults to true. Mobile only.
+                </documentation>
+            </annotation>
+        </attribute>
     </complexType>
 
     <!-- Basic Components -->

package/messaging/registry/ui.d.ts

@@ -306,6 +306,26 @@ export declare class UICommands extends CommandRegistry {
      * Hides a notification previously shown to the user.
      */
     get hideNotification(): Command;
+    /**
+     * Marks a component as being available. The interpretation of what effect
+     * this has is up to the component. Currently the only component that will
+     * react to this is the task-bar, which will have the effect of showing the
+     * tab/button for that component. The argument can be an id of the
+     * component, or the model for the component.
+     *
+     * @mobileOnly
+     */
+    get makeAvailable(): Command<ComponentId | Model>;
+    /**
+     * Marks a component as being unavailable. The interpretation of what effect
+     * this has is up to the component. Currently the only component that will
+     * react to this is the task-bar, which will have the effect of hiding the
+     * tab/button for that component, and deactivating the component. The
+     * argument can be an id of the component, or the model for the component.
+     *
+     * @mobileOnly
+     */
+    get makeUnavailable(): Command<ComponentId | Model>;
     /**
      * Forces assistive technology (screen readers) to narrate a translatable
      * message to the end user.

package/messaging/registry/ui.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 var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends e{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends s{get confirm(){return this._messages.operation("ui.confirm")}get getLocale(){return this._messages.operation("ui.get-locale")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}get prompt(){return this._messages.operation("ui.prompt")}}export class UIEvents extends t{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends e{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get makeAvailable(){return this._messages.command("ui.make-available")}get makeUnavailable(){return this._messages.command("ui.make-unavailable")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends s{get confirm(){return this._messages.operation("ui.confirm")}get getLocale(){return this._messages.operation("ui.get-locale")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}get prompt(){return this._messages.operation("ui.prompt")}}export class UIEvents extends t{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}

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

@@ -15373,6 +15373,38 @@
                 "ui.hide-notification"
             ]
         },
+        "ui.make-available": {
+            "description": "Marks a component as being available. The interpretation of what effect this has is up to the component. Currently the only component that will react to this is the task-bar, which will have the effect of showing the tab/button for that component. The argument can be an id of the component, or the model for the component.",
+            "enum": [
+                "ui.make-available"
+            ]
+        },
+        "ui.make-available:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
+        "ui.make-unavailable": {
+            "description": "Marks a component as being unavailable. The interpretation of what effect this has is up to the component. Currently the only component that will react to this is the task-bar, which will have the effect of hiding the tab/button for that component, and deactivating the component. The argument can be an id of the component, or the model for the component.",
+            "enum": [
+                "ui.make-unavailable"
+            ]
+        },
+        "ui.make-unavailable:input": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/Model"
+                },
+                {
+                    "type": "string"
+                }
+            ]
+        },
         "ui.pause-notifications": {
             "description": "Pauses display of notifications until resumed.",
             "enum": [
@@ -17179,6 +17211,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.make-available:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.make-available"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/ui.make-unavailable:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/ui.make-unavailable"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -17659,6 +17723,12 @@
                 {
                     "$ref": "#/definitions/ui.hide-notification"
                 },
+                {
+                    "$ref": "#/definitions/ui.make-available"
+                },
+                {
+                    "$ref": "#/definitions/ui.make-unavailable"
+                },
                 {
                     "$ref": "#/definitions/ui.pause-notifications"
                 },

package/package.json

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

package/version.js

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