@vertigis/viewer-spec 49.1.0 → 49.3.1

package/app-config/common/BrandingColors.d.ts

@@ -57,6 +57,7 @@ export interface BrandingColors {
     buttonIcon: ColorConfig;
     buttonIconDisabled: ColorConfig;
     buttonIconHover: ColorConfig;
+    defaultMapBackground: ColorConfig;
     disabledIconFill: ColorConfig;
     emphasizedButtonBackground: ColorConfig;
     emphasizedButtonBackgroundDisabled: ColorConfig;

package/messaging/registry/app.d.ts

@@ -60,6 +60,18 @@ export declare class AppCommands extends CommandRegistry {
      * @mobileOnly
      */
     get refresh(): Command;
+    /**
+     * Stores data specified by the arguments (key and scope).
+     *
+     * @mobileOnly
+     */
+    get setPersistentData(): Command<SaveStorageDataArgs>;
+    /**
+     * Removes stored data, specified by the arguments (key and scope).
+     *
+     * @mobileOnly
+     */
+    get removePersistentData(): Command<StorageDataArgs>;
     /**
      * Adds the currently loaded app to the user's Favorites collection.
      *
@@ -188,4 +200,47 @@ export declare class AppOperations extends OperationRegistry {
      * @webOnly
      */
     get createProject(): Operation<void, AppConfig>;
+    /**
+     * Gets stored data, specified by the arguments (key and scope).
+     */
+    get getPersistentData(): Operation<StorageDataArgs, unknown>;
+}
+/**
+ * Arguments for the reading app.*-persistent-data operations. Only available in the
+ * Geocortex Mobile Viewer.
+ */
+export interface StorageDataArgs {
+    /**
+     * The key of the data to store.
+     */
+    key: string;
+    /**
+     * The scope the data is stored in. Defaults to @see StorageScope.APP.
+     */
+    scope?: StorageScope;
+}
+/**
+ * Arguments for the app.set-persistent-data operations. Only available in the
+ * Geocortex Mobile Viewer.
+ */
+export interface SaveStorageDataArgs extends StorageDataArgs {
+    /**
+     * The data to be stored.
+     */
+    data: unknown;
+}
+declare enum StorageScope {
+    /**
+     * Defines the global storage that is accessible from all apps.
+     */
+    GLOBAL = "global",
+    /**
+     * Defines the app specific storage that only is accessible from within the very app.
+     */
+    APP = "app",
+    /**
+     * Defines in memory storage, that doesn't get persisted on app shutdown.
+     */
+    MEMORY = "memory"
 }
+export {};

package/messaging/registry/app.js

@@ -1 +1 @@
-import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class AppCommands extends CommandRegistry{get goToAppSelector(){return this._messages.command("app.go-to-app-selector")}get refresh(){return this._messages.command("app.refresh")}get favorite(){return this._messages.command("app.favorite")}get unfavorite(){return this._messages.command("app.unfavorite")}get loadProject(){return this._messages.command("app.load-project")}}export class AppEvents extends EventRegistry{constructor(){super(...arguments),this.custom=new AppCustomEvents(this._messages),this.generic=new AppGenericEvents(this._messages)}get activated(){return this._messages.event("app.activated")}get backgrounded(){return this._messages.event("app.backgrounded")}get interrupted(){return this._messages.event("app.interrupted")}get customStarted(){return this._messages.event("app.custom.started")}get genericAppStarted(){return this._messages.event("app.generic.started")}get specificAppStarted(){return this._messages.event("app.generic.specific-app-started")}get goingToAppSelector(){return this._messages.event("app.navigating-to-app-selector")}get refreshed(){return this._messages.event("app.refreshed")}get refreshing(){return this._messages.event("app.refreshing")}get favorited(){return this._messages.event("app.favorited")}get unfavorited(){return this._messages.event("app.unfavorited")}}export class AppCustomEvents extends EventRegistry{get started(){return this._messages.event("app.custom.started")}}export class AppGenericEvents extends EventRegistry{get started(){return this._messages.event("app.generic.started")}get appsListed(){return this._messages.event("app.generic.apps-listed")}}export class AppOperations extends OperationRegistry{get getVersion(){return this._messages.operation("app.get-version")}get createProject(){return this._messages.operation("app.create-project")}}
+import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class AppCommands extends CommandRegistry{get goToAppSelector(){return this._messages.command("app.go-to-app-selector")}get refresh(){return this._messages.command("app.refresh")}get setPersistentData(){return this._messages.command("app.set-persistent-data")}get removePersistentData(){return this._messages.command("app.remove-persistent-data")}get favorite(){return this._messages.command("app.favorite")}get unfavorite(){return this._messages.command("app.unfavorite")}get loadProject(){return this._messages.command("app.load-project")}}export class AppEvents extends EventRegistry{constructor(){super(...arguments),this.custom=new AppCustomEvents(this._messages),this.generic=new AppGenericEvents(this._messages)}get activated(){return this._messages.event("app.activated")}get backgrounded(){return this._messages.event("app.backgrounded")}get interrupted(){return this._messages.event("app.interrupted")}get customStarted(){return this._messages.event("app.custom.started")}get genericAppStarted(){return this._messages.event("app.generic.started")}get specificAppStarted(){return this._messages.event("app.generic.specific-app-started")}get goingToAppSelector(){return this._messages.event("app.navigating-to-app-selector")}get refreshed(){return this._messages.event("app.refreshed")}get refreshing(){return this._messages.event("app.refreshing")}get favorited(){return this._messages.event("app.favorited")}get unfavorited(){return this._messages.event("app.unfavorited")}}export class AppCustomEvents extends EventRegistry{get started(){return this._messages.event("app.custom.started")}}export class AppGenericEvents extends EventRegistry{get started(){return this._messages.event("app.generic.started")}get appsListed(){return this._messages.event("app.generic.apps-listed")}}export class AppOperations extends OperationRegistry{get getVersion(){return this._messages.operation("app.get-version")}get createProject(){return this._messages.operation("app.create-project")}get getPersistentData(){return this._messages.operation("app.get-persistent-data")}}var StorageScope;!function(e){e.GLOBAL="global",e.APP="app",e.MEMORY="memory"}(StorageScope||(StorageScope={}));

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

@@ -2226,6 +2226,32 @@
             ],
             "type": "object"
         },
+        "StorageDataArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the reading app.*-persistent-data operations. Only available in the Geocortex Mobile Viewer.",
+            "properties": {
+                "key": {
+                    "description": "The key of the data to store.",
+                    "type": "string"
+                },
+                "scope": {
+                    "$ref": "#/definitions/StorageScope",
+                    "description": "The scope the data is stored in. Defaults to @see StorageScope.APP."
+                }
+            },
+            "required": [
+                "key"
+            ],
+            "type": "object"
+        },
+        "StorageScope": {
+            "enum": [
+                "app",
+                "global",
+                "memory"
+            ],
+            "type": "string"
+        },
         "SuggestArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"geocode.suggest\" operation.",
@@ -2499,6 +2525,15 @@
             ],
             "type": "object"
         },
+        "app.get-persistent-data": {
+            "description": "Gets stored data, specified by the arguments (key and scope).",
+            "enum": [
+                "app.get-persistent-data"
+            ]
+        },
+        "app.get-persistent-data:input": {
+            "$ref": "#/definitions/StorageDataArgs"
+        },
         "auth.get-current-user": {
             "description": "Gets the user that is currently signed into the application.",
             "enum": [
@@ -11985,6 +12020,22 @@
         },
         "viewer-spec.SingleCommand": {
             "anyOf": [
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/app.get-persistent-data:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/app.get-persistent-data"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -12849,6 +12900,9 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "$ref": "#/definitions/app.get-persistent-data"
+                },
                 {
                     "$ref": "#/definitions/auth.sign-in"
                 },

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

@@ -2719,6 +2719,28 @@
             ],
             "type": "object"
         },
+        "SaveStorageDataArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the app.set-persistent-data operations. Only available in the Geocortex Mobile Viewer.",
+            "properties": {
+                "data": {
+                    "description": "The data to be stored."
+                },
+                "key": {
+                    "description": "The key of the data to store.",
+                    "type": "string"
+                },
+                "scope": {
+                    "$ref": "#/definitions/StorageScope",
+                    "description": "The scope the data is stored in. Defaults to @see StorageScope.APP."
+                }
+            },
+            "required": [
+                "data",
+                "key"
+            ],
+            "type": "object"
+        },
         "SearchArgs": {
             "additionalProperties": false,
             "description": "Arguments for search operations.",
@@ -3060,6 +3082,32 @@
             ],
             "type": "object"
         },
+        "StorageDataArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the reading app.*-persistent-data operations. Only available in the Geocortex Mobile Viewer.",
+            "properties": {
+                "key": {
+                    "description": "The key of the data to store.",
+                    "type": "string"
+                },
+                "scope": {
+                    "$ref": "#/definitions/StorageScope",
+                    "description": "The scope the data is stored in. Defaults to @see StorageScope.APP."
+                }
+            },
+            "required": [
+                "key"
+            ],
+            "type": "object"
+        },
+        "StorageScope": {
+            "enum": [
+                "app",
+                "global",
+                "memory"
+            ],
+            "type": "string"
+        },
         "SuggestArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"geocode.suggest\" operation.",
@@ -3339,6 +3387,15 @@
                 "app.favorite"
             ]
         },
+        "app.get-persistent-data": {
+            "description": "Gets stored data, specified by the arguments (key and scope).",
+            "enum": [
+                "app.get-persistent-data"
+            ]
+        },
+        "app.get-persistent-data:input": {
+            "$ref": "#/definitions/StorageDataArgs"
+        },
         "app.go-to-app-selector": {
             "description": "Returns to the Geocortex Go view where the user can select a different app. Only enabled if the current app was launched through Geocortex Go.",
             "enum": [
@@ -3351,6 +3408,24 @@
                 "app.refresh"
             ]
         },
+        "app.remove-persistent-data": {
+            "description": "Removes stored data, specified by the arguments (key and scope).",
+            "enum": [
+                "app.remove-persistent-data"
+            ]
+        },
+        "app.remove-persistent-data:input": {
+            "$ref": "#/definitions/StorageDataArgs"
+        },
+        "app.set-persistent-data": {
+            "description": "Stores data specified by the arguments (key and scope).",
+            "enum": [
+                "app.set-persistent-data"
+            ]
+        },
+        "app.set-persistent-data:input": {
+            "$ref": "#/definitions/SaveStorageDataArgs"
+        },
         "app.unfavorite": {
             "description": "Removes the currently loaded app from the user's Favorites collection.",
             "enum": [
@@ -13906,6 +13981,54 @@
         },
         "viewer-spec.SingleCommand": {
             "anyOf": [
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/app.get-persistent-data:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/app.get-persistent-data"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/app.remove-persistent-data:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/app.remove-persistent-data"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/app.set-persistent-data:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/app.set-persistent-data"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -15685,12 +15808,21 @@
                 {
                     "$ref": "#/definitions/app.favorite"
                 },
+                {
+                    "$ref": "#/definitions/app.get-persistent-data"
+                },
                 {
                     "$ref": "#/definitions/app.go-to-app-selector"
                 },
                 {
                     "$ref": "#/definitions/app.refresh"
                 },
+                {
+                    "$ref": "#/definitions/app.remove-persistent-data"
+                },
+                {
+                    "$ref": "#/definitions/app.set-persistent-data"
+                },
                 {
                     "$ref": "#/definitions/app.unfavorite"
                 },

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

@@ -4671,6 +4671,32 @@
             ],
             "type": "object"
         },
+        "StorageDataArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the reading app.*-persistent-data operations. Only available in the Geocortex Mobile Viewer.",
+            "properties": {
+                "key": {
+                    "description": "The key of the data to store.",
+                    "type": "string"
+                },
+                "scope": {
+                    "$ref": "#/definitions/StorageScope",
+                    "description": "The scope the data is stored in. Defaults to @see StorageScope.APP."
+                }
+            },
+            "required": [
+                "key"
+            ],
+            "type": "object"
+        },
+        "StorageScope": {
+            "enum": [
+                "app",
+                "global",
+                "memory"
+            ],
+            "type": "string"
+        },
         "SuggestArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"geocode.suggest\" operation.",
@@ -5598,6 +5624,15 @@
         "app.create-project:output": {
             "$ref": "#/definitions/AppConfig"
         },
+        "app.get-persistent-data": {
+            "description": "Gets stored data, specified by the arguments (key and scope).",
+            "enum": [
+                "app.get-persistent-data"
+            ]
+        },
+        "app.get-persistent-data:input": {
+            "$ref": "#/definitions/StorageDataArgs"
+        },
         "app.get-version": {
             "description": "Gets the current version stamped in the application (i.e. the version of the viewer this application was created with).",
             "enum": [
@@ -17856,6 +17891,22 @@
         },
         "viewer-spec.SingleCommand": {
             "anyOf": [
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/app.get-persistent-data:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/app.get-persistent-data"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -20032,6 +20083,9 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "$ref": "#/definitions/app.get-persistent-data"
+                },
                 {
                     "$ref": "#/definitions/app.load-project"
                 },

package/package.json

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

package/version.js

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