@vcmap/ui 5.0.0-rc.28 → 5.0.0-rc.30

package/src/vcsUiApp.js

@@ -1,24 +1,19 @@
 import {
-  VcsApp,
-  moduleIdSymbol,
   Collection,
-  makeOverrideCollection,
-  destroyCollection,
-  OverrideClassRegistry,
   defaultDynamicModuleId,
+  destroyCollection,
+  getObjectFromClassRegistry,
+  makeOverrideCollection,
+  moduleIdSymbol,
   ObliqueMap,
+  OverrideClassRegistry,
+  VcsApp,
+  VcsEvent,
   Viewpoint,
   volatileModuleId,
-  VcsEvent,
-  getObjectFromClassRegistry,
 } from '@vcmap/core';
 import { getLogger as getLoggerByName } from '@vcsuite/logger';
-import {
-  isValidPackageName,
-  loadPlugin,
-  serializePlugin,
-  deserializePlugin,
-} from './pluginHelper.js';
+import { deserializePlugin, serializePlugin } from './pluginHelper.js';
 import ToolboxManager, {
   setupDefaultGroups,
 } from './manager/toolbox/toolboxManager.js';
@@ -54,8 +49,15 @@ import { callbackClassRegistry } from './callback/vcsCallback.js';
 /**
  * @typedef {Object} PluginConfig
  * @property {string} name
- * @property {string|undefined} entry
- * @property {string|undefined} version
+ * @property {string|undefined} entry - path to the plugin's index.js
+ * @property {string|undefined} version - version or version range
+ */
+
+/**
+ * @typedef {Object} PluginConfigEditor
+ * @property {import("vue").Component} component - A editor component to configure a plugin or item
+ * @property {string} [collectionName='plugins'] - The collection the item belongs to. Default is plugins collection.
+ * @property {string} [itemName] - The item the editor can be used for. Can be a name or className. Default is the plugin's name.
  */
 
 /**
@@ -67,6 +69,8 @@ import { callbackClassRegistry } from './callback/vcsCallback.js';
  */
 
 /**
+ * Interface for VcsPlugins.
+ * The function implementing the interface should not throw!
  * @interface VcsPlugin
  * @template {Object} P
  * @template {Object} S
@@ -75,9 +79,11 @@ import { callbackClassRegistry } from './callback/vcsCallback.js';
  * @property {Object<string, *>} [i18n] - the i18n messages of this plugin
  * @property {function(VcsUiApp, S=)} initialize - called on plugin added. Is passed the VcsUiApp and optionally, the state for the plugin
  * @property {function(VcsUiApp)} onVcsAppMounted - called on mounted of VcsApp.vue
- * @property {function():P} [toJSON] - serialization
+ * @property {function():P} [toJSON] - should return the plugin's serialization excluding all default values
+ * @property {function():P} [getDefaultOptions] - should return the plugin's default options
+ * @property {function(boolean=):S|Promise<S>} [getState] - should return the plugin's state or a promise for said state. is passed a "for url" flag. If true, only the state relevant for sharing a URL should be passed and short keys shall be used
+ * @property {Array<PluginConfigEditor>} [getConfigEditors] - should return components for configuring the plugin or custom items defined by the plugin
  * @property {function():Promise<void>} destroy
- * @property {function(boolean=):S|Promise<S>} [getState] - should return the plugins state or a promise for said state. is passed a "for url" flag. If true, only the state relevant for sharing a URL should be passed and short keys shall be used
  * @api
  */
 
@@ -443,6 +449,27 @@ class VcsUiApp extends VcsApp {
     return this._notifier;
   }
 
+  /**
+   * Returns a callback function providing a URL to help page.
+   * The default helpBaseUrl can be changed by adding an 'helpBaseUrl' item to the UiConfig Collection.
+   * The callback derives the url from the VC Map mayor and minor version, the current app locale and a provided path pointing to a specific help section.
+   * This function can be used for the WindowState infoUrlCallback property.
+   * @param {string} [path] - the path to a help section
+   * @param {string} [subpage='vc-map'] - path to a subpage. Default is 'vc-map'.
+   * @returns {function():string}
+   */
+  getHelpUrlCallback(path = '', subpage = 'vc-map') {
+    const mayorMinorVersion = /\d+\.\d+/.exec(VcsUiApp.getVersion())[0];
+    return () => {
+      const base =
+        this.uiConfig.config.value.helpBaseUrl || 'https://help.vc.systems/';
+      const url = `${subpage}-${this.locale}/v${mayorMinorVersion}/${path}`;
+      // const url = `${this.locale}/${subpage}/v${mayorMinorVersion}/${path}`;
+      const { href } = new URL(url, base);
+      return href.replace(/\/+/g, '/');
+    };
+  }
+
   /**
    * 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
    * the maximum URL length is not exceeded). This includes: layer active state & styling, active map, active viewpoint,
@@ -524,23 +551,7 @@ class VcsUiApp extends VcsApp {
   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[moduleIdSymbol] = module._id;
-          return plugin;
-        }),
-      );
-
-      plugins.filter((p) => p).map((p) => this._plugins.override(p));
+      await this._plugins.parseItems(config.plugins, module._id);
     }
     if (Array.isArray(config.i18n)) {
       await this.i18n.parseItems(config.i18n, module._id);

package/dist/assets/index-1b09f88d.js

@@ -1 +0,0 @@
-import{initAppFromAppConfig as p}from"./ui.bd7a9a.js";p("#app","app.config.json");