@vcmap/ui 5.0.0-rc.22 → 5.0.0-rc.24

package/src/vcsUiApp.js

@@ -1,14 +1,15 @@
 import {
   VcsApp,
-  contextIdSymbol,
+  moduleIdSymbol,
   Collection,
   makeOverrideCollection,
   destroyCollection,
   OverrideClassRegistry,
-  defaultDynamicContextId,
+  defaultDynamicModuleId,
   ObliqueMap,
   Viewpoint,
-  volatileContextId, VcsEvent,
+  volatileModuleId,
+  VcsEvent,
 } from '@vcmap/core';
 import { getLogger as getLoggerByName } from '@vcsuite/logger';
 import {
@@ -17,7 +18,9 @@ import {
   serializePlugin,
   deserializePlugin,
 } from './pluginHelper.js';
-import ToolboxManager, { setupDefaultGroups } from './manager/toolbox/toolboxManager.js';
+import ToolboxManager, {
+  setupDefaultGroups,
+} from './manager/toolbox/toolboxManager.js';
 import WindowManager from './manager/window/windowManager.js';
 import NavbarManager from './manager/navbarManager.js';
 import { createContentTreeCollection } from './contentTree/contentTreeCollection.js';
@@ -34,9 +37,12 @@ import Search from './search/search.js';
 import Notifier from './notifier/notifier.js';
 
 /**
- * @typedef {import("@vcmap/core").VcsAppConfig} VcsUiAppConfig
+ * @typedef {import("@vcmap/core").VcsModuleConfig} VcsUiModuleConfig
  * @property {Array<Object>} [plugins]
  * @property {Array<ContentTreeItemOptions>} [contentTree]
+ * @property {Array<UiConfigurationItem>} [uiConfig]
+ * @property {Array<FeatureInfoViewOptions>} [featureInfo]
+ * @property {Array<Object>} [i18n]
  */
 
 /**
@@ -69,7 +75,6 @@ import Notifier from './notifier/notifier.js';
  * @api
  */
 
-
 /**
  * @interface VcsComponentManager
  * @template {Object} T - the component type
@@ -102,7 +107,9 @@ class VcsUiApp extends VcsApp {
    * Gets the version of the @vcmap/ui npm package
    * @returns {string}
    */
-  static getVersion() { return version; }
+  static getVersion() {
+    return version;
+  }
 
   constructor() {
     super();
@@ -117,7 +124,7 @@ class VcsUiApp extends VcsApp {
      */
     this._plugins = makeOverrideCollection(
       new Collection(),
-      () => this.dynamicContextId,
+      () => this.dynamicModuleId,
       serializePlugin,
       deserializePlugin,
     );
@@ -134,17 +141,26 @@ class VcsUiApp extends VcsApp {
         this._contextMenuManager.removeOwner(plugin.name);
         this._search.removeOwner(plugin.name);
         if (plugin.i18n) {
-          this.i18n.addPluginMessages(plugin.name, plugin[contextIdSymbol], plugin.i18n);
+          this.i18n.addPluginMessages(
+            plugin.name,
+            plugin[moduleIdSymbol],
+            plugin.i18n,
+          );
         }
         if (plugin.initialize) {
           let state;
-          if (this._cachedAppState.contextIds.includes(plugin[contextIdSymbol])) {
-            state = this._cachedAppState.plugins.find(s => s.name === plugin.name);
+          if (this._cachedAppState.moduleIds.includes(plugin[moduleIdSymbol])) {
+            state = this._cachedAppState.plugins.find(
+              (s) => s.name === plugin.name,
+            );
           }
           try {
             plugin.initialize(this, state?.state);
           } catch (e) {
-            getLogger().error(`Error in plugin ${plugin.name} initialize hook`, e);
+            getLogger().error(
+              `Error in plugin ${plugin.name} initialize hook`,
+              e,
+            );
           }
         }
       }),
@@ -155,7 +171,7 @@ class VcsUiApp extends VcsApp {
         this._categoryManager.removeOwner(plugin.name);
         this._contextMenuManager.removeOwner(plugin.name);
         this._search.removeOwner(plugin.name);
-        this.i18n.removePluginMessages(plugin.name, plugin[contextIdSymbol]);
+        this.i18n.removePluginMessages(plugin.name, plugin[moduleIdSymbol]);
       }),
     ];
 
@@ -163,7 +179,9 @@ class VcsUiApp extends VcsApp {
      * @type {OverrideClassRegistry<ContentTreeItem>}
      * @private
      */
-    this._contentTreeClassRegistry = new OverrideClassRegistry(contentTreeClassRegistry);
+    this._contentTreeClassRegistry = new OverrideClassRegistry(
+      contentTreeClassRegistry,
+    );
 
     /**
      * @type {OverrideContentTreeCollection}
@@ -192,7 +210,7 @@ class VcsUiApp extends VcsApp {
      * @type {UiConfig}
      * @private
      */
-    this._uiConfig = new UiConfig(() => this.dynamicContextId);
+    this._uiConfig = new UiConfig(() => this.dynamicModuleId);
     /**
      * @type {FeatureInfo}
      * @private
@@ -209,7 +227,7 @@ class VcsUiApp extends VcsApp {
      * @type {I18nCollection<Object>}
      * @private
      */
-    this._i18n = new I18nCollection(() => this.dynamicContextId);
+    this._i18n = new I18nCollection(() => this.dynamicModuleId);
 
     /**
      * @type {CategoryManager}
@@ -252,85 +270,113 @@ class VcsUiApp extends VcsApp {
    * @type {import("@vcmap/core").OverrideCollection<VcsPlugin>}
    * @readonly
    */
-  get plugins() { return this._plugins; }
+  get plugins() {
+    return this._plugins;
+  }
 
   /**
    * @type {OverrideContentTreeCollection}
    * @readonly
    */
-  get contentTree() { return this._contentTree; }
+  get contentTree() {
+    return this._contentTree;
+  }
 
   /**
    * @type {OverrideClassRegistry<ContentTreeItem>}
    * @readonly
    */
-  get contentTreeClassRegistry() { return this._contentTreeClassRegistry; }
+  get contentTreeClassRegistry() {
+    return this._contentTreeClassRegistry;
+  }
 
   /**
    * @returns {ToolboxManager}
    * @readonly
    */
-  get toolboxManager() { return this._toolboxManager; }
+  get toolboxManager() {
+    return this._toolboxManager;
+  }
 
   /**
    * @returns {WindowManager}
    * @readonly
    */
-  get windowManager() { return this._windowManager; }
+  get windowManager() {
+    return this._windowManager;
+  }
 
   /**
    * @returns {NavbarManager}
    * @readonly
    */
-  get navbarManager() { return this._navbarManager; }
+  get navbarManager() {
+    return this._navbarManager;
+  }
 
   /**
    * @returns {FeatureInfo}
    * @readonly
    */
-  get featureInfo() { return this._featureInfo; }
+  get featureInfo() {
+    return this._featureInfo;
+  }
 
   /**
    * @type {OverviewMap}
    * @readonly
    */
-  get overviewMap() { return this._overviewMap; }
+  get overviewMap() {
+    return this._overviewMap;
+  }
 
   /**
    * @type {I18nCollection}
    * @readonly
    */
-  get i18n() { return this._i18n; }
+  get i18n() {
+    return this._i18n;
+  }
 
   /**
    * @returns {CategoryManager}
    * @readonly
    */
-  get categoryManager() { return this._categoryManager; }
+  get categoryManager() {
+    return this._categoryManager;
+  }
 
   /**
    * @type {ContextMenuManager}
    * @readonly
    */
-  get contextMenuManager() { return this._contextMenuManager; }
+  get contextMenuManager() {
+    return this._contextMenuManager;
+  }
 
   /**
    * @type {Search}
    * @readonly
    */
-  get search() { return this._search; }
+  get search() {
+    return this._search;
+  }
 
   /**
    * @type {UiConfig}
    * @readonly
    */
-  get uiConfig() { return this._uiConfig; }
+  get uiConfig() {
+    return this._uiConfig;
+  }
 
   /**
    * @type {Notifier}
    * @readonly
    */
-  get notifier() { return this._notifier; }
+  get notifier() {
+    return this._notifier;
+  }
 
   /**
    * Get the state of the application. When passed the forUrl flag, only a minimal set of states shall be provided for a sharable link to the current state (to ensure
@@ -341,22 +387,27 @@ class VcsUiApp extends VcsApp {
    */
   async getState(forUrl) {
     const state = createEmptyState();
-    state.contextIds = this.contexts
-      .filter(({ id }) => id !== defaultDynamicContextId)
-      .map(({ id }) => id);
+    state.moduleIds = this.modules
+      .filter(({ _id }) => _id !== defaultDynamicModuleId)
+      .map(({ _id }) => _id);
 
     state.activeMap = this.maps.activeMap.name;
     const viewpoint = await this.maps.activeMap.getViewpoint();
-    state.activeViewpoint = viewpoint?.isValid?.() ? viewpoint.toJSON() : undefined;
+    state.activeViewpoint = viewpoint?.isValid?.()
+      ? viewpoint.toJSON()
+      : undefined;
     state.layers = [...this.layers]
-      .filter(l => l.isSupported(this.maps.activeMap) &&
-        l[contextIdSymbol] !== defaultDynamicContextId &&
-        l[contextIdSymbol] !== volatileContextId &&
-        (
-          ((l.active || l.loading) && !l.activeOnStartup) ||
-          (!l.active && l.activeOnStartup) ||
-          ((l.active || l.loading) && l.style !== l.defaultStyle && this.styles.has(l.style))
-        ))
+      .filter(
+        (l) =>
+          l.isSupported(this.maps.activeMap) &&
+          l[moduleIdSymbol] !== defaultDynamicModuleId &&
+          l[moduleIdSymbol] !== volatileModuleId &&
+          (((l.active || l.loading) && !l.activeOnStartup) ||
+            (!l.active && l.activeOnStartup) ||
+            ((l.active || l.loading) &&
+              l.style !== l.defaultStyle &&
+              this.styles.has(l.style))),
+      )
       .map((l) => {
         const layerState = {
           name: l.name,
@@ -366,19 +417,33 @@ class VcsUiApp extends VcsApp {
           l.style &&
           l.style.name !== l.defaultStyle.name &&
           this.styles.has(l.style) &&
-          l.style[contextIdSymbol] !== defaultDynamicContextId &&
-          l.style[contextIdSymbol] !== volatileContextId
+          l.style[moduleIdSymbol] !== defaultDynamicModuleId &&
+          l.style[moduleIdSymbol] !== volatileModuleId
         ) {
           layerState.styleName = l.style.name;
         }
         return layerState;
       });
 
-    state.plugins = await Promise.all([...this.plugins]
-      .filter(p => p[contextIdSymbol] !== defaultDynamicContextId &&
-        p[contextIdSymbol] !== volatileContextId &&
-        typeof p.getState === 'function')
-      .map(async p => ({ name: p.name, state: await p.getState(forUrl) })));
+    const plugins = await Promise.all(
+      [...this.plugins]
+        .filter(
+          (p) =>
+            p[moduleIdSymbol] !== defaultDynamicModuleId &&
+            p[moduleIdSymbol] !== volatileModuleId &&
+            typeof p.getState === 'function',
+        )
+        .map(async (p) => {
+          try {
+            return { name: p.name, state: await p.getState(forUrl) };
+          } catch (e) {
+            getLogger().error(e);
+            return null;
+          }
+        }),
+    );
+
+    state.plugins = plugins.filter((p) => p);
 
     if (this.maps.activeMap instanceof ObliqueMap) {
       state.activeObliqueCollection = this.maps.activeMap.collection.name;
@@ -387,46 +452,51 @@ class VcsUiApp extends VcsApp {
   }
 
   /**
-   * @param {import("@vcmap/core").Context} context
+   * @param {import("@vcmap/core").VcsModule} module
    * @returns {Promise<void>}
    * @protected
    */
-  async _parseContext(context) {
-    const { config } = context;
+  async _parseModule(module) {
+    const { config } = module;
     if (Array.isArray(config.plugins)) {
-      const plugins = await Promise.all(config.plugins.map(async (pluginConfig) => {
-        const plugin = await loadPlugin(pluginConfig.name, pluginConfig);
-        if (!plugin) {
-          return null;
-        }
-        if (!isValidPackageName(plugin.name)) {
-          getLogger().warning(`plugin ${plugin.name} has no valid package name!`);
-        }
-        plugin[contextIdSymbol] = context.id;
-        return plugin;
-      }));
+      const plugins = await Promise.all(
+        config.plugins.map(async (pluginConfig) => {
+          const plugin = await loadPlugin(pluginConfig.name, pluginConfig);
+          if (!plugin) {
+            return null;
+          }
+          if (!isValidPackageName(plugin.name)) {
+            getLogger().warning(
+              `plugin ${plugin.name} has no valid package name!`,
+            );
+          }
+          plugin[moduleIdSymbol] = module._id;
+          return plugin;
+        }),
+      );
 
-      plugins
-        .filter(p => p)
-        .map(p => this._plugins.override(p));
+      plugins.filter((p) => p).map((p) => this._plugins.override(p));
     }
     if (Array.isArray(config.i18n)) {
-      await this.i18n.parseItems(config.i18n, context.id);
+      await this.i18n.parseItems(config.i18n, module._id);
     }
-    await super._parseContext(context);
-    await this._contentTree.parseItems(config.contentTree, context.id);
-    await this._uiConfig.parseItems(config.uiConfig, context.id);
-    await this._featureInfo.collection.parseItems(config.featureInfo, context.id);
+    await super._parseModule(module);
+    await this._contentTree.parseItems(config.contentTree, module._id);
+    await this._uiConfig.parseItems(config.uiConfig, module._id);
+    await this._featureInfo.collection.parseItems(
+      config.featureInfo,
+      module._id,
+    );
   }
 
   /**
-   * @param {import("@vcmap/core").Context} context
+   * @param {import("@vcmap/core").VcsModule} module
    * @returns {Promise<void>}
    * @protected
    */
-  async _setContextState(context) {
-    await super._setContextState(context);
-    if (this._cachedAppState.contextIds.includes(context.id)) {
+  async _setModuleState(module) {
+    await super._setModuleState(module);
+    if (this._cachedAppState.moduleIds.includes(module._id)) {
       this._cachedAppState.layers.forEach((layerState) => {
         const layer = this.layers.getByKey(layerState.name);
         if (layer) {
@@ -436,43 +506,72 @@ class VcsUiApp extends VcsApp {
             layer.deactivate();
           }
 
-          if (layerState.styleName && this.styles.hasKey(layerState.styleName) && layer.setStyle) {
+          if (
+            layerState.styleName &&
+            this.styles.hasKey(layerState.styleName) &&
+            layer.setStyle
+          ) {
             layer.setStyle(this.styles.getByKey(layerState.styleName));
           }
         }
       });
-      if (this._cachedAppState.activeMap && this.maps.hasKey(this._cachedAppState.activeMap)) {
+      if (
+        this._cachedAppState.activeMap &&
+        this.maps.hasKey(this._cachedAppState.activeMap)
+      ) {
         await this.maps.setActiveMap(this._cachedAppState.activeMap);
       }
       if (
         this._cachedAppState.activeObliqueCollection &&
         this.maps.activeMap instanceof ObliqueMap &&
-        this.obliqueCollections.hasKey(this._cachedAppState.activeObliqueCollection)
+        this.obliqueCollections.hasKey(
+          this._cachedAppState.activeObliqueCollection,
+        )
       ) {
         await this.maps.activeMap.setCollection(
-          this.obliqueCollections.getByKey(this._cachedAppState.activeObliqueCollection),
-          this._cachedAppState.activeViewpoint,
+          this.obliqueCollections.getByKey(
+            this._cachedAppState.activeObliqueCollection,
+          ),
+          new Viewpoint(this._cachedAppState.activeViewpoint),
         );
       } else if (this._cachedAppState.activeViewpoint && this.maps.activeMap) {
-        await this.maps.activeMap.gotoViewpoint(new Viewpoint(this._cachedAppState.activeViewpoint));
+        await this.maps.activeMap.gotoViewpoint(
+          new Viewpoint(this._cachedAppState.activeViewpoint),
+        );
       }
-      this._cachedAppState.contextIds.splice(this._cachedAppState.contextIds.indexOf(context.id), 1);
+      this._cachedAppState.moduleIds.splice(
+        this._cachedAppState.moduleIds.indexOf(module._id),
+        1,
+      );
     }
   }
 
   /**
-   * @param {string} contextId
+   * @param {string} moduleId
+   * @returns {VcsUiModuleConfig}
+   */
+  serializeModule(moduleId) {
+    const config = super.serializeModule(moduleId);
+    config.uiConfig = this._uiConfig.serializeModule(moduleId);
+    config.featureInfo = this._featureInfo.collection.serializeModule(moduleId);
+    config.i18n = this._i18n.serializeModule(moduleId);
+    config.plugins = this._plugins.serializeModule(moduleId);
+    return config;
+  }
+
+  /**
+   * @param {string} moduleId
    * @returns {Promise<void>}
    * @protected
    */
-  async _removeContext(contextId) {
+  async _removeModule(moduleId) {
     await Promise.all([
-      super._removeContext(contextId),
-      this._plugins.removeContext(contextId),
-      this._i18n.removeContext(contextId),
-      this._contentTree.removeContext(contextId),
-      this._featureInfo.collection.removeContext(contextId),
-      this._uiConfig.removeContext(contextId),
+      super._removeModule(moduleId),
+      this._plugins.removeModule(moduleId),
+      this._i18n.removeModule(moduleId),
+      this._contentTree.removeModule(moduleId),
+      this._featureInfo.collection.removeModule(moduleId),
+      this._uiConfig.removeModule(moduleId),
     ]);
   }
 
@@ -486,7 +585,9 @@ class VcsUiApp extends VcsApp {
     this.categoryManager.destroy();
     this.contextMenuManager.destroy();
     this._overviewMap.destroy();
-    this._pluginListeners.forEach((cb) => { cb(); });
+    this._pluginListeners.forEach((cb) => {
+      cb();
+    });
     this._pluginListeners = [];
     destroyCollection(this._plugins);
     destroyCollection(this._contentTree);

package/src/vuePlugins/i18n.js

@@ -5,7 +5,6 @@ import { vcsAppSymbol } from '../pluginHelper.js';
 import de from '../i18n/de.js';
 import en from '../i18n/en.js';
 
-
 Vue.use(VueI18n);
 
 /**
@@ -21,6 +20,7 @@ export function createVueI18n() {
     messages: {
       en: {},
     },
+    postTranslation: (val, key) => (typeof val === 'string' ? val : key),
   });
   return i18n;
 }
@@ -45,7 +45,7 @@ function setI18n(messages, i18n) {
  * @returns {function():void} returns a destroy function
  */
 export function setupI18n(app, i18n) {
-  const defaultMessages = { en, de };
+  const defaultMessages = { name: 'default', en, de };
   defaultMessages[i18nPluginSymbol] = vcsAppSymbol;
   app.i18n.add(defaultMessages);
 
@@ -63,7 +63,8 @@ export function setupI18n(app, i18n) {
     }),
   ];
   return function tearDownI18nSetup() {
-    destroyFunctions.forEach((destroy) => { destroy(); });
+    destroyFunctions.forEach((destroy) => {
+      destroy();
+    });
   };
 }
-

package/src/vuePlugins/vuetify.js

@@ -19,6 +19,9 @@ export const defaultPrimaryColor = {
  * @returns {import("vuetify").default}
  */
 export function createVuetify() {
+  const dark =
+    window.matchMedia?.('(prefers-color-scheme: dark)')?.matches ?? false;
+
   return new Vuetify({
     treeShake: false,
     defaultAssets: {
@@ -27,6 +30,7 @@ export function createVuetify() {
       },
     },
     theme: {
+      dark,
       options: {
         customProperties: true,
       },

package/start.js

@@ -1,3 +1,9 @@
-import { initApp } from '@vcmap/ui';
+// to load a app.config.json containing a set of configs
+import { initAppFromAppConfig } from '@vcmap/ui';
 
-initApp('#app', 'map.config.json');
+initAppFromAppConfig('#app', 'app.config.json');
+
+// to load a single module (config)
+// import { initAppFromModule } from '@vcmap/ui';
+
+// initAppFromModule('#app', 'config/projects.config.json');