@vertigis/viewer-spec 43.3.1 → 43.4.0

package/messaging/registry/ui.d.ts

@@ -94,6 +94,40 @@ export interface DisplayNotificationArgs {
      * and will supersede one another. Mobile only.
      */
     notificationGroup?: string;
+    /**
+     * The notification title - only shown for system notifications. Mobile
+     * only.
+     */
+    title?: string;
+    /**
+     * The type of notification - 'app', 'system', or 'auto'. Defaults to
+     * 'auto'. Mobile only.
+     */
+    type?: NotificationType;
+}
+/**
+ * The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'.
+ * Mobile only.
+ */
+export declare enum NotificationType {
+    /**
+     * Automatically choose whether to display an app notification or system
+     * notification. If the app is in the background, a system notification will
+     * be shown. If the app is in the foreground, an in-app notificaiton will be
+     * shown. If notifications are unauthorized at the OS level, an in-app
+     * notification will always be shown.
+     */
+    AUTO = "auto",
+    /**
+     * Display the notification in-app.
+     */
+    APP = "app",
+    /**
+     * Display the notification as a system notification using the device's
+     * operating system. If system notifications are turned off/disabled in the
+     * OS settings, then it will fall back to using an in-app notification.
+     */
+    SYSTEM = "system"
 }
 /**
  * Arguments for the "ui.set-visual-state" command.

package/messaging/registry/ui.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends CommandRegistry{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 OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get prompt(){return this._messages.operation("ui.prompt")}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")}}export class UIEvents extends EventRegistry{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")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}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 CommandRegistry{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 OperationRegistry{get confirm(){return this._messages.operation("ui.confirm")}get prompt(){return this._messages.operation("ui.prompt")}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")}}export class UIEvents extends EventRegistry{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")}}

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

@@ -693,6 +693,14 @@
                 "position": {
                     "$ref": "Position",
                     "description": "The position of the notification on the screen."
+                },
+                "title": {
+                    "description": "The notification title - only shown for system notifications. Mobile only.",
+                    "type": "string"
+                },
+                "type": {
+                    "$ref": "#/definitions/NotificationType",
+                    "description": "The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only."
                 }
             },
             "required": [
@@ -1289,6 +1297,15 @@
             ],
             "type": "string"
         },
+        "NotificationType": {
+            "description": "The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only.",
+            "enum": [
+                "app",
+                "auto",
+                "system"
+            ],
+            "type": "string"
+        },
         "Results": {
             "additionalProperties": false,
             "description": "Feature results from an operation.",

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

@@ -821,6 +821,14 @@
                 "position": {
                     "$ref": "Position",
                     "description": "The position of the notification on the screen."
+                },
+                "title": {
+                    "description": "The notification title - only shown for system notifications. Mobile only.",
+                    "type": "string"
+                },
+                "type": {
+                    "$ref": "#/definitions/NotificationType",
+                    "description": "The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only."
                 }
             },
             "required": [
@@ -1651,6 +1659,15 @@
             ],
             "type": "string"
         },
+        "NotificationType": {
+            "description": "The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only.",
+            "enum": [
+                "app",
+                "auto",
+                "system"
+            ],
+            "type": "string"
+        },
         "OfflineCommandArgs": {
             "additionalProperties": false,
             "description": "Arguments for various offline commands.",

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

@@ -1336,6 +1336,14 @@
                 "position": {
                     "$ref": "Position",
                     "description": "The position of the notification on the screen."
+                },
+                "title": {
+                    "description": "The notification title - only shown for system notifications. Mobile only.",
+                    "type": "string"
+                },
+                "type": {
+                    "$ref": "#/definitions/NotificationType",
+                    "description": "The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only."
                 }
             },
             "required": [
@@ -3230,6 +3238,15 @@
             ],
             "type": "string"
         },
+        "NotificationType": {
+            "description": "The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only.",
+            "enum": [
+                "app",
+                "auto",
+                "system"
+            ],
+            "type": "string"
+        },
         "Orientation": {
             "description": "An orientation for the layout.",
             "enum": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "43.3.1",
+  "version": "43.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 Geocortex Viewer Specification.
  */
-export declare const version = "43.3.1";
+export declare const version = "43.4.0";

package/version.js

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