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

package/plugins/@vcmap/project-selector/README.md

@@ -1,29 +1,25 @@
 # VC Map Plugin Project Selector
 
-This is a plugin to select and load `VCMapProjects` and `VCMapContexts`.
+This is a plugin to select and load `Projects` and `VcsModules`.
 
 ## configuration
 
-You can add projects or contexts and define the startup behavior of the plugin:
+You can add projects or modules and define the startup behavior of the plugin:
 
 ### ProjectSelectorConfig
-| Property         | Type                       | default       | Description                  |
-|------------------|----------------------------|---------------|------------------------------|
-| selected         | string                     | 'VC Map Base' | selected project on startup  |
-| selectedContexts | string[]                   | []            | selected contexts on startup |
-| projects         | Array<VCMapProjectOptions> | []            |                              |
-| contexts         | Array<VCMapContextOptions> | []            |                              |
 
-### VCMapProjectOptions
-| Property    | Type                       | Description                |
-|-------------|----------------------------|----------------------------|
-| name        | string                     | name of the project        |
-| description | string                     | description of the project |
-| contexts    | Array<VCMapContextOptions> |                            |
+| Property        | Type                  | default       | Description                 |
+| --------------- | --------------------- | ------------- | --------------------------- |
+| selected        | string                | 'VC Map Base' | selected project on startup |
+| selectedModules | string[]              | []            | selected modules on startup |
+| open            | boolean               | false         | open plugin on startup      |
+| projects        | Array<ProjectOptions> | []            |                             |
+| modules         | Array<string>         | []            | list of config urls         |
 
-### VCMapContextOptions
-| Property    | Type   | Description                |
-|-------------|--------|----------------------------|
-| name        | string | name of the context        |
-| description | string | description of the context |
-| configUrl   | string | url to config.json         |
+### ProjectOptions
+
+| Property    | Type          | Description                |
+| ----------- | ------------- | -------------------------- |
+| name        | string        | name of the project        |
+| description | string        | description of the project |
+| modules     | Array<string> | list of config urls        |

package/plugins/@vcmap/project-selector/config.json

@@ -1,15 +1,15 @@
 {
-    "name": "projectSelector",
-    "entry": "plugins/@vcmap/project-selector/index.js",
-    "selected": "VC Map Base",
-    "selectedContexts": [],
-    "open": false,
-    "projects": [
-        {
-            "name": "VC Map Base",
-            "description": "Base Layout with basic datasets",
-            "contexts": [ { "configUrl": "config/base.config.json" } ]
-        }
-    ],
-    "contexts": []
+  "name": "projectSelector",
+  "entry": "plugins/@vcmap/project-selector/index.js",
+  "selected": "VC Map Base",
+  "selectedModules": [],
+  "open": false,
+  "projects": [
+    {
+      "name": "VC Map Base",
+      "description": "Base Layout with basic datasets",
+      "modules": ["config/base.config.json"]
+    }
+  ],
+  "modules": []
 }

package/plugins/@vcmap/project-selector/de.json

@@ -1,7 +1,10 @@
 {
   "project-selector": {
-    "project" : {
+    "project": {
       "title": "Projekte"
+    },
+    "module": {
+      "title": "Module"
     }
   }
 }

package/plugins/@vcmap/project-selector/en.json

@@ -1,7 +1,10 @@
 {
   "project-selector": {
-    "project" : {
+    "project": {
       "title": "Projects"
+    },
+    "module": {
+      "title": "Modules"
     }
   }
 }

package/plugins/@vcmap/project-selector/index.js

@@ -1,50 +1,42 @@
-import { ref } from 'vue';
+import { reactive } from 'vue';
 import { ButtonLocation, createToggleAction } from '@vcmap/ui';
-import { Context } from '@vcmap/core';
+import { VcsModule } from '@vcmap/core';
 import { getLogger } from '@vcsuite/logger';
 import ProjectsComponent from './ProjectSelectorComponent.vue';
 import packageJSON from './package.json';
 import defaultConfig from './config.json';
 import de from './de.json';
 import en from './en.json';
-/**
- * @typedef {Object} VCMapContextOptions
- * @property {string} [name]
- * @property {string} [description]
- * @property {string} configUrl
- */
 
 /**
- * @typedef {Object} VCMapContext
+ * @typedef {Object} VcsModuleState
+ * @property {string} _id
  * @property {string} [name]
  * @property {string} [description]
  * @property {string} configUrl
- * @property {string} contextId
  * @property {boolean} active
  */
 
 /**
- * @typedef {Object} VCMapProjectOptions
+ * @typedef {Object} ProjectOptions
  * @property {string} name
  * @property {string} [description]
- * @property {Array<VCMapContextOptions>} contexts
+ * @property {Array<string>} modules - a list of config urls
  */
 
 /**
- * @typedef {Object} VCMapProject
- * @property {string} name
- * @property {string} [description]
- * @property {Array<VCMapContext>} contexts
+ * @typedef {ProjectOptions} Project
  * @property {boolean} active
+ * @property {Array<VcsModuleState>} modules
  */
 
 /**
  * @typedef {Object} ProjectSelectorConfig
  * @property {string} [selected='VC Map Base'] - selected project on startup
- * @property {string[]} [selectedContexts] - selected contexts on startup
+ * @property {string[]} [selectedModules] - selected modules on startup
  * @property {boolean} [open=false] - open plugin on startup
- * @property {Array<VCMapProjectOptions>} projects
- * @property {Array<VCMapContextOptions>} contexts
+ * @property {Array<Project>} projects
+ * @property {Array<string>} modules
  */
 
 /**
@@ -52,156 +44,172 @@ import en from './en.json';
  * @returns {VcsPlugin}
  */
 export default async function projectSelector(config) {
-  const { selected, selectedContexts, open, projects = [], contexts = [] } = config;
+  const {
+    selected,
+    selectedModules,
+    open,
+    projects = [],
+    modules = [],
+  } = config;
 
-  const pluginConfig = {
-    selected: ref(selected || defaultConfig.selected),
-    selectedContexts: ref(selectedContexts || defaultConfig.selectedContexts),
-    open: ref(open || defaultConfig.open),
-    projects: ref(/** @type {Array<VCMapProjectOptions>} */[...defaultConfig.projects, ...projects]),
-    contexts: ref(/** @type {Array<VCMapContextOptions>} */[...defaultConfig.contexts, ...contexts]),
-  };
+  const pluginConfig = reactive({
+    selected: selected || defaultConfig.selected,
+    selectedModules: selectedModules || defaultConfig.selectedModules,
+    open: open || defaultConfig.open,
+    projects: /** @type {Array<ProjectOptions>} */ [
+      ...defaultConfig.projects,
+      ...projects,
+    ],
+    modules: /** @type {Array<string>} */ [
+      ...defaultConfig.modules,
+      ...modules,
+    ],
+  });
 
-  const pluginState = {
-    projects: ref(/** @type {Array<VCMapProject>} */[]),
-    contexts: ref(/** @type {Array<VCMapContext>} */[]),
-  };
+  const pluginState = reactive({
+    projects: /** @type {Array<Project>} */ [],
+    modules: /** @type {Array<VcsModuleState>} */ [],
+  });
 
   /**
-   * @param {VCMapContextOptions} contextOptions
+   * @param {string} configUrl
    */
-  function addContextFromOptions(contextOptions) {
-    /**
-     * @type {VCMapContext}
-     */
-    const context = {
-      name: undefined,
-      description: undefined,
-      configUrl: undefined,
-      ...contextOptions,
-      contextId: undefined,
-      active: false,
-    };
-    pluginState.contexts.value.push(context);
+  function addModule(configUrl) {
+    pluginState.modules.push({ _id: undefined, configUrl, active: false });
   }
 
   /**
-   * @param {VCMapContext} context
+   * @param {string} moduleId
    */
-  function removeContext(context) {
-    const idx = pluginState.contexts.value.findIndex(c => c.configUrl === context.configUrl);
-    pluginState.contexts.value.splice(idx, 1);
+  function removeModule(moduleId) {
+    const idx = pluginState.modules.findIndex(({ _id }) => _id === moduleId);
+    pluginState.modules.splice(idx, 1);
   }
 
   /**
-   * @param {VCMapProjectOptions} projectOptions
+   * @param {ProjectOptions} projectOptions
    */
-  function addProjectFromOptions(projectOptions) {
-    const { name, description, contexts: contextsOptions = [] } = projectOptions;
-    /**
-     * @type {VCMapProject}
-     */
+  function addProject({ name, description, modules: configUrls }) {
     const project = {
       name,
       description,
-      contexts: contextsOptions.map(options => /** @type {VCMapContext} */({
-        name: undefined,
-        description: undefined,
-        configUrl: undefined,
-        ...options,
-        contextId: undefined,
+      modules: configUrls.map((configUrl) => ({
+        _id: undefined,
+        configUrl,
         active: false,
       })),
       active: false,
     };
-    pluginState.projects.value.push(project);
+    pluginState.projects.push(project);
   }
 
   /**
-   * @param {VCMapProject} project
+   * @param {Project} project
    */
   function removeProject(project) {
-    const projectIdx = pluginState.projects.findIndex(p => p.name === project.name);
-    pluginState.projects.value.splice(projectIdx, 1);
+    const projectIdx = pluginState.projects.findIndex(
+      (p) => p.name === project.name,
+    );
+    pluginState.projects.splice(projectIdx, 1);
   }
 
   /**
    * @param {VcsApp} app
-   * @param {VCMapContext} vcMapContext
+   * @param {VcsModuleState} moduleState
    * @returns {Promise<void>}
    */
-  async function loadContext(app, vcMapContext) {
+  async function loadModule(app, moduleState) {
     try {
-      const configJson = await fetch(vcMapContext.configUrl)
-        .then(response => response.json());
-      const context = new Context(configJson);
-      if (!app.getContextById(context.id)) {
-        await app.addContext(context);
+      const response = await fetch(moduleState.configUrl);
+      if (response.ok) {
+        const configJson = await response.json();
+        const module = new VcsModule(configJson);
+        if (!app.getModuleById(module._id)) {
+          await app.addModule(module);
+          moduleState._id = module._id;
+          moduleState.name = module.name;
+          moduleState.description = module.description;
+          moduleState.active = true;
+        }
       }
-      vcMapContext.contextId = context.id;
-      vcMapContext.active = true;
     } catch (err) {
-      getLogger().error(`Failed loading context from ${ vcMapContext.configUrl}`, err);
+      getLogger().error(
+        `Failed loading module from ${moduleState.configUrl}`,
+        err,
+      );
     }
   }
 
   /**
    * @param {VcsApp} app
-   * @param {VCMapContext} vcMapContext
+   * @param {VcsModuleState} moduleState
    * @returns {Promise<void>}
    */
-  async function unloadContext(app, vcMapContext) {
-    if (app.getContextById(vcMapContext.contextId)) {
-      await app.removeContext(vcMapContext.contextId);
+  async function unloadModule(app, moduleState) {
+    if (app.getModuleById(moduleState._id)) {
+      await app.removeModule(moduleState._id);
+      moduleState.active = false;
+      moduleState._id = undefined;
     }
-    vcMapContext.active = false;
   }
 
   /**
    * @param {VcsApp} app
-   * @param {VCMapProject} project
+   * @param {Project} project
    * @returns {Promise<void>}
    */
   async function deselectProject(app, project) {
     if (project.active) {
-      await Promise.all([...project.contexts].map((context) => {
-        return unloadContext(app, context);
-      }));
+      await Promise.all(
+        [...project.modules].map((moduleState) => {
+          return unloadModule(app, moduleState);
+        }),
+      );
       project.active = false;
     }
   }
 
   /**
    * @param {VcsApp} app
-   * @param {VCMapProject} project
+   * @param {Project} project
    * @returns {Promise<void>}
    */
   async function selectProject(app, project) {
     if (!project.active) {
-      await Promise.all([...pluginState.projects.value].map((p) => {
-        return deselectProject(app, p);
-      }));
-      await Promise.all([...project.contexts].map((context) => {
-        return loadContext(app, context);
-      }));
+      await Promise.all(
+        [...pluginState.projects].map((p) => {
+          return deselectProject(app, p);
+        }),
+      );
+      await Promise.all(
+        [...project.modules].map((moduleState) => {
+          return loadModule(app, moduleState);
+        }),
+      );
       project.active = true;
     }
   }
 
   return {
-    get name() { return packageJSON.name; },
-    get version() { return packageJSON.version; },
-    get vcMapVersion() { return packageJSON.vcMapVersion; },
+    get name() {
+      return packageJSON.name;
+    },
+    get version() {
+      return packageJSON.version;
+    },
+    get vcMapVersion() {
+      return packageJSON.vcMapVersion;
+    },
     config: pluginConfig,
     state: pluginState,
-    addContextFromOptions,
-    removeContext,
-    addProjectFromOptions,
+    addModule,
+    removeModule,
+    addProject,
     removeProject,
     selectProject,
     deselectProject,
-    loadContext,
-    unloadContext,
+    loadModule,
+    unloadModule,
     onVcsAppMounted(app) {
       const windowComponent = {
         id: 'project-selector',
@@ -232,15 +240,17 @@ export default async function projectSelector(config) {
       );
       this._destroyAction = destroy;
 
-      pluginConfig.contexts.value.forEach(c => addContextFromOptions(c));
-      pluginConfig.projects.value.forEach(p => addProjectFromOptions(p));
-      const projectToSelect = [...pluginState.projects.value]
-        .find(p => p.name === pluginConfig.selected.value) ||
-        pluginState.projects.value[0];
+      pluginConfig.modules.forEach((c) => addModule(c));
+      pluginConfig.projects.forEach((p) => addProject(p));
+      const projectToSelect =
+        [...pluginState.projects].find(
+          (p) => p.name === pluginConfig.selected,
+        ) || pluginState.projects[0];
       selectProject(app, projectToSelect);
-      const contextsToSelect = [...pluginState.contexts.value]
-        .filter(c => pluginConfig.selectedContexts.value.includes(c.name));
-      contextsToSelect.forEach(c => loadContext(app, c));
+      const modulesToSelect = [...pluginState.modules].filter((m) =>
+        pluginConfig.selectedModules.includes(m.configUrl),
+      );
+      modulesToSelect.forEach((m) => loadModule(app, m));
       if (pluginConfig.open) {
         app.windowManager.add(windowComponent, packageJSON.name);
       }

package/plugins/@vcmap/search-nominatim/LICENSE.md

@@ -1,14 +1,13 @@
-
 Copyright 2022 support@vc.systems
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO 
-THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 
-OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/plugins/@vcmap/search-nominatim/README.md

@@ -1,2 +1,3 @@
 # @vcmap/search-nominatim
-describe your plugin
+
+describe your plugin

package/plugins/@vcmap/search-nominatim/config.json

@@ -1,4 +1,3 @@
 {
-  "name": "@vcmap/search-nominatim",
-
+  "name": "@vcmap/search-nominatim"
 }

package/plugins/@vcmap/search-nominatim/index.js

@@ -1,19 +1,22 @@
 import { version, name } from './package.json';
 import Nominatim from './nominatim.js';
 
-
 /**
  * @param {NominatimSearchOptions} config - the configuration of this plugin instance, passed in from the app.
  * @returns {import("@vcmap/ui/src/vcsUiApp").VcsPlugin<T>}
  * @template {Object} T
  * @template {Object} S
  */
-export default function SearchNominatim(config) {
+export default function searchNominatim(config) {
   return {
     _instance: null,
     _app: null,
-    get name() { return name; },
-    get version() { return version; },
+    get name() {
+      return name;
+    },
+    get version() {
+      return version;
+    },
     /**
      * @param {import("@vcmap/ui").VcsUiApp} vcsUiApp
      */

package/plugins/@vcmap/search-nominatim/nominatim.js

@@ -1,5 +1,8 @@
 import { Extent, parseGeoJSON, wgs84Projection } from '@vcmap/core';
-import { AddressBalloonFeatureInfoView, featureInfoViewSymbol } from '@vcmap/ui';
+import {
+  AddressBalloonFeatureInfoView,
+  featureInfoViewSymbol,
+} from '@vcmap/ui';
 
 /**
  *
@@ -120,7 +123,9 @@ class Nominatim {
     }
 
     if (this.extent) {
-      params.viewbox = this.extent.getCoordinatesInProjection(wgs84Projection).join(',');
+      params.viewbox = this.extent
+        .getCoordinatesInProjection(wgs84Projection)
+        .join(',');
       params.bounded = 1;
     }
 

package/plugins/@vcmap/search-nominatim/package.json

@@ -2,42 +2,8 @@
   "name": "@vcmap/search-nominatim",
   "version": "1.0.0",
   "description": "A search plugin for OSM Nominatim",
-  "main": "index.js",
-  "scripts": {
-    "prepublishOnly": "vcmplugin build",
-    "build": "vcmplugin build",
-    "pack": "vcmplugin pack",
-    "start": "vcmplugin serve",
-    "preview": "vcmplugin preview",
-    "buildStagingApp": "vcmplugin buildStagingApp",
-    "lint": "eslint \"{src,tests}/**/*.{js,vue}\""
-  },
-  "author": "support@vc.systems",
-  "license": "MIT",
-  "dependencies": {},
   "peerDependencies": {
-    "@vcmap/core": "^5.0.0-rc.20"
-  },
-  "keywords": [
-    "vcmap",
-    "plugin"
-  ],
-  "files": [
-    "src/",
-    "dist/",
-    "plugin-assets/",
-    "LICENSE.md",
-    "README.md"
-  ],
-  "exports": {
-    ".": "./src/index.js",
-    "./dist": "./dist/index.js"
-  },
-  "eslintIgnore": [
-    "node_modules"
-  ],
-  "eslintConfig": {
-    "root": true,
-    "extends": "@vcsuite/eslint-config/vue"
+    "@vcmap/core": "^5.0.0-rc.30",
+    "@vcmap/ui": "^5.0.0-rc.23"
   }
 }

package/plugins/@vcmap/simple-graph/README.md

@@ -2,11 +2,10 @@
 
 This is a plugin adding a new Feature Info View using {@link https://vuetifyjs.com/en/api/v-sparkline/#props|vuetify v-sparkline }.
 
-| View class                              | VueComponent                                       | description                                              |
-|-----------------------------------------|----------------------------------------------------|----------------------------------------------------------|
+| View class                            | VueComponent                                     | description                                              |
+| ------------------------------------- | ------------------------------------------------ | -------------------------------------------------------- |
 | [SimpleGraphView](simpleGraphView.js) | [SimpleGraphComponent](SimpleGraphComponent.vue) | A simple graph view including trend lines and bar graph. |
 
-
 ## configuration
 
 See `{FeatureInfoViewOptions}` for general configuration of Feature Views.
@@ -15,7 +14,7 @@ Use `{WindowComponentOptions} window` to define the position and size of the gra
 The graph can be configured as follows:
 
 | Property | Type                     | default   | Description                                          |
-|----------|--------------------------|-----------|------------------------------------------------------|
+| -------- | ------------------------ | --------- | ---------------------------------------------------- |
 | labels   | string[] | number[] | []        | optional array of strings labeling all data points   |
 | graph    | string                   | 'trend'   | Choose between a trendline or bars                   |
 | color    | string                   | 'primary' | optional color of the sparkline of the graph         |
@@ -30,12 +29,33 @@ The graph can be configured as follows:
   "type": "SimpleGraphView",
   "name": "graphBar",
   "attributeKeys": [
-    "globalRadRoofsMonth_01", "globalRadRoofsMonth_02", "globalRadRoofsMonth_03",
-    "globalRadRoofsMonth_04", "globalRadRoofsMonth_05", "globalRadRoofsMonth_06",
-    "globalRadRoofsMonth_07", "globalRadRoofsMonth_08", "globalRadRoofsMonth_09",
-    "globalRadRoofsMonth_10", "globalRadRoofsMonth_11", "globalRadRoofsMonth_12"
+    "globalRadRoofsMonth_01",
+    "globalRadRoofsMonth_02",
+    "globalRadRoofsMonth_03",
+    "globalRadRoofsMonth_04",
+    "globalRadRoofsMonth_05",
+    "globalRadRoofsMonth_06",
+    "globalRadRoofsMonth_07",
+    "globalRadRoofsMonth_08",
+    "globalRadRoofsMonth_09",
+    "globalRadRoofsMonth_10",
+    "globalRadRoofsMonth_11",
+    "globalRadRoofsMonth_12"
+  ],
+  "labels": [
+    "Jan",
+    "Feb",
+    "Mar",
+    "Apr",
+    "May",
+    "Jun",
+    "Jul",
+    "Aug",
+    "Sep",
+    "Oct",
+    "Nov",
+    "Dec"
   ],
-  "labels": ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"],
   "color": "secondary",
   "graph": "bar",
   "gradient": ["red", "orange", "yellow"],

package/plugins/@vcmap/simple-graph/SimpleGraphComponent.vue

@@ -13,14 +13,11 @@
   />
 </template>
 <script>
-
   import { VSparkline } from 'vuetify/lib';
 
   export default {
     name: 'SimpleGraphComponent',
-    components: [
-      VSparkline,
-    ],
+    components: [VSparkline],
     props: {
       attributes: {
         type: Object,
@@ -59,6 +56,4 @@
   };
 </script>
 
-<style scoped>
-
-</style>
+<style scoped></style>