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

package/README.md

@@ -1,4 +1,5 @@
 # VC Map
+
 VC Map is an Open-Source JavaScript framework and API for building dynamic and interactive maps on the web. It can display
 2D data, oblique imagery and massive 3D data including terrain data, vector data, mesh models, and point clouds making it
 easy for users to explore and interact with the data in an integrated and high-performance map application. VC Map apps can
@@ -13,31 +14,38 @@ to integrate VC Maps into any web page and to extend its functionalities with ow
 is structured into the following four main architectural layers:
 
 #### [VC Map Core](https://github.com/virtualcitySYSTEMS/map-core)
+
 The VC Map Core is a thin abstraction layer and wrapper around OpenLayers and Cesium. It provides a common data and feature
 management API and automatically synchronizes data and user actions between the 2D, oblique and 3D views. Map functions and
 tools can be developed against this Core API to make them available in 2D, 3D and the oblique view rather than having to
 develop them redundantly and based on different technologies.
 
 #### Configuration Management
+
 The VC Map framework offers a flexible and fully customizable map configuration management. All contents of a VC Map application
 such as available layers, views, tools, and plugins are managed in a JSON-based configuration file that is loaded when starting
 the application. Every VC Map application can thus be easily configured according to the end-user needs. Map configurations can
 be dynamically changed, extended, and serialized at runtime through a corresponding API.
 
 #### Modern User Interface
+
 VC Map comes with a modern UI interface for VC Map applications that provides UI components for all map tools and widgets
 implemented based on Vue.js and HTML5. In addition, the VC Map framework provides pre-built, low-level UI elements that can
 be used by developers to easily build more complex user dialogs from and include them in a map application.
 
 #### [Plugin API](https://github.com/virtualcitySYSTEMS/map-plugin-cli)
+
 VC Map is easy to customize and extend through a well-defined Plugin API. Plugins allow for adding new functionalities,
 tools, and user dialogs to a VC Map application. Plugins can be added to a VC Map through the configuration file or loaded
 dynamically to an existing map application using the Plugin API. Plugin developers can use the entire VC Map stack
 (VC Map Core, configuration management, UI components) for building their own extensions.
 
 # Components
+
 ### [@vcmap/core](https://github.com/virtualcitySYSTEMS/map-core)
+
 Provides an abstraction layer around 2D, 3D and oblique Maps. Provides the following components:
+
 - map abstraction for Cesium, Openlayers and Oblique Images
 - layers
 - interactions
@@ -45,36 +53,45 @@ Provides an abstraction layer around 2D, 3D and oblique Maps. Provides the follo
 - application and module/config handling
 
 ### [@vcmap/ui](https://github.com/virtualcitySYSTEMS/map-ui)
+
 This Project, provides
+
 - a configurable and extendable ui
 - extends the @vcmap/core application handling with a plugin Concept, see [@vcmap/plugin-cli](https://github.com/virtualcitySYSTEMS/map-plugin-cli)
-- extends the @vcmap/core application with a windowManager 
+- extends the @vcmap/core application with a windowManager
 
 ### [@vcmap/plugin-cli](https://github.com/virtualcitySYSTEMS/map-plugin-cli)
+
 Provides a tool to create, develop and build Plugins for the @vcmap/ui.
-Plugin Concept documentation can also be found there. 
+Plugin Concept documentation can also be found there.
 
 ### [@vcmap/ui webpack5 integration template](https://github.com/virtualcitySYSTEMS/map-ui-webpack5-example)
+
 Example Template to show how to integrate the @vcmap/ui in a webpack5 project.
 
 ### [@vcmap/core demo](https://github.com/virtualcitySYSTEMS/map-core-demo)
+
 Example demo Application based on the @vcmap/core, shows how to implement a different UI on top of the @vcmap/core
 
 ## Component Diagram
+
 ![A schema on component interactions](./documentation/VC_Map_Diagram.png)
 
 # Project and Component Status
-The Project is currently in Alpha status. Different components have different states. For development check here 
+
+The Project is currently in Alpha status. Different components have different states. For development check here
 how safe it is to start developing with these components.
 
 #### States:
+
 - TODO: not yet usable
 - ALPHA: 1. version, style and API will probably change
 - BETA: Style and API may change, we will provide a changelog from here on.
 - RC: Styles and API are most likely stable for the release / Featurecomplete.
-- STABLE: conforms to SemVer concept. 
+- STABLE: conforms to SemVer concept.
 
 ### @vcmap/core
+
 - Module Concept RC
 - Categories Concept BETA
 - Layers/Maps RC
@@ -86,6 +103,7 @@ how safe it is to start developing with these components.
 - Editor BETA
 
 ### @vcmap/ui
+
 - contentTree API BETA [CONTENT_TREE](documentation/CONTENT_TREE.md) // TODO doc
 - windowManager API BETA [WINDOWS](documentation/WINDOWS.md) // TODO doc
 - Navbar/ButtonManager/ToolboxManager ALPHA [BUTTONS](documentation/BUTTONS.md)/[TOOLBOX](documentation/TOOLBOX.md)
@@ -95,13 +113,14 @@ how safe it is to start developing with these components.
 - SEARCH API BETA [SEARCH](documentation/SEARCH.md)
 - I18n API RC [INTERNATIONALIZATION](documentation/INTERNATIONALIZATION.md).
 - CATEGORIES API RC [CATEGORIES](documentation/CATEGORIES.md).
-- Context Menu API RC [CONTEXT_MENU](documentation/CONTEXT_MENU.md) 
+- Context Menu API RC [CONTEXT_MENU](documentation/CONTEXT_MENU.md)
 - FeatureInfo RC [FEATURE_INFO](documentation/FEATURE_INFO.md)
 - [State & Application Link](documentation/STATE.md) RC
 - [Help Concept](documentation/HELP.md) RC
 - Copyright RC [ATTRIBUTIONS](documentation/ATTRIBUTIONS.md)
 
 ##### components
+
 - VcsTextField BETA
 - VcsCheckbox BETA
 - VcsSelect BETA
@@ -122,35 +141,39 @@ how safe it is to start developing with these components.
 - VcsDatePicker TODO
 
 # Roadmap / Future Development
+
 - Phase 1 Currently worked on
 - Phase 2 Beta Version stable feature complete Plugin API
 - Phase 3 Integration in VC Publisher for next major release
 - Phase 4 Feature Complete with v4.x with all Plugins...
 
 ### Core
+
 - Editor (WIP) Prio 1
 - Clustering Prio 4
 - Style Refactoring Prio 4
 
 ### Ui
+
 - Responsive View / mobile view DONE
 - Toolbar DONE
 - Search API + UI DONE
-- Overlay API Support  Prio 3
+- Overlay API Support Prio 3
 - i18n DONE.
 - FeatureInfo Concept/API (Balloon) DONE
   - Context API DONE
   - Hierachy B3dm
 - Legend Concept/API DONE
-- Copyright/Attributions Concept / API  DONE
-- Ui Configuration (title/themes, usw, projectInfo/Impressum/usw. ) / API  DONE
-- Help Concept / Beispielhaft implementieren  DONE
+- Copyright/Attributions Concept / API DONE
+- Ui Configuration (title/themes, usw, projectInfo/Impressum/usw. ) / API DONE
+- Help Concept / Beispielhaft implementieren DONE
 - Components Concept/Categories / API DONE.
 - Notification Concept DONE
 
 ### Plugins
+
 |            Plugin            | Dev Prio | Proj Prio |
-|:----------------------------:|:--------:|:---------:|
+| :--------------------------: | :------: | :-------: |
 |        Drawing (WIP)         |    1     |     1     |
 |         Measurement          |    1     |     1     |
 |      PDF Export (DONE)       |    1     |     1     |
@@ -176,19 +199,14 @@ how safe it is to start developing with these components.
 |         Search esri          |    4     |     4     |
 |          Search WFS          |    4     |     4     |
 
-
 # Getting started
-For a first start, clone the repo and call `npm i` `npm run start` This will start a development server. The 
+
+For a first start, clone the repo and call `npm i` `npm run start` This will start a development server. The
 app can be opened with http://localhost:8080.
 
 Further Information see [GET_STARTED](documentation/GET_STARTED.md) and [Plugin-cli](https://github.com/virtualcitySYSTEMS/map-plugin-cli).
 
 ## Included Dataset
+
 The included datasets for Berlin and Osnabrück in the app configurations in the project can only be used for Development.
 For further usage of the datasets please contact [Virtual City Systems](https://vc.systems).
-
-
-
-
-
-

package/app.config.json

@@ -1,5 +1,3 @@
 {
-  "modules": [
-    "config/projects.config.json"
-  ]
-}
+  "modules": ["config/projects.config.json"]
+}

package/build/.eslintrc

@@ -1,5 +1,8 @@
 {
   "extends": ["@vcsuite/eslint-config/node"],
+  "env": {
+    "node": true
+  },
   "rules": {
     "import/no-extraneous-dependencies": "off"
   }

package/build/build.js

@@ -1,174 +1,184 @@
-import path from 'path';
-import fs from 'fs';
-import { build } from 'vite';
-import { v4 as uuid } from 'uuid';
-import rollupPluginStripPragma from 'rollup-plugin-strip-pragma';
-import vcsOl from '@vcmap/rollup-plugin-vcs-ol';
-import generateOLLib from './generateOLLib.js';
-import buildCesium from './buildCesium.js';
-import { buildLibrary, libraries } from './buildHelpers.js';
-
-/**
- * @typedef {Object} LibraryBuildOption
- * @property {string} lib
- * @property {string} entry
- * @property {string} [libraryEntry]
- * @property {import("rollup").RollupOptions} [rollupOptions]
- */
-
-/**
- * @returns {{ libraryBuildOptions: Object<string, LibraryBuildOption>, libraryPaths: Object<string, string> }}
- */
-function hashLibraries() {
-  /** @type {Object<string, LibraryBuildOption>} */
-  const libraryBuildOptions = {
-    vue: {
-      entry: path.join('lib', 'vue.js'),
-    },
-    '@vcmap-cesium/engine': {
-      entry: path.join('lib', 'cesium.js'),
-      rollupOptions: {
-        plugins: [rollupPluginStripPragma({
-          pragmas: ['debug'],
-        })],
-      },
-    },
-    ol: {
-      entry: path.join('lib', 'olLib.js'),
-      libraryEntry: path.join('lib', 'ol.js'), // openlayers special case, the entry to compile is the olLib, but the public entry must be ol.js
-      rollupOptions: {
-        output: {
-          manualChunks: () => 'ol.js', // this is needed, otherwise vitejs will create multiple chunks for openlayers.
-        },
-      },
-    },
-    '@vcmap/core': {
-      entry: path.join('lib', 'core.js'),
-      rollupOptions: {
-        plugins: [vcsOl()],
-      },
-    },
-    '@vcmap/ui': {
-      rollupOptions: {
-        plugins: [
-          vcsOl(),
-          {
-            transform(source, sid) {
-              if (/src(\/|\\)setup.js/.test(sid)) {
-                return source.replace('/node_modules/@vcmap-cesium/engine/Build/', './assets/cesium/');
-              }
-              return source;
-            },
-          },
-        ],
-      },
-      entry: path.join('lib', 'ui.js'),
-    },
-    'vuetify/lib': {
-      entry: path.join('lib', 'vuetify.js'),
-    },
-  };
-
-  const libraryPaths = {};
-  Object.entries(libraryBuildOptions)
-    .forEach(([key, value]) => {
-      if (!libraries[key]) {
-        throw new Error(`Trying to build unexported library ${key}`);
-      }
-      value.lib = libraries[key];
-      value.hash = `${uuid().substring(0, 6)}`;
-      libraryPaths[key] = `./${value.lib}.${value.hash}.js`;
-      value.rollupOptions = value.rollupOptions ? value.rollupOptions : {};
-    });
-
-  return { libraryBuildOptions, libraryPaths };
-}
-
-const { libraryBuildOptions, libraryPaths } = hashLibraries();
-console.log('Building ol dump file');
-await generateOLLib();
-
-console.log('Building app');
-await build({
-  configFile: './build/commonViteConfig.js',
-  base: './',
-  define: {
-    'process.env.NODE_ENV': '"production"',
-  },
-  build: {
-    minify: true,
-    emptyOutDir: true,
-    rollupOptions: {
-      external: Object.keys(libraries),
-      output: {
-        paths: libraryPaths,
-      },
-    },
-  },
-});
-
-console.log('Building Libraries');
-await Promise.all(Object.entries(libraryBuildOptions).map(async ([key, value]) => {
-  console.log('Building Library: ', key);
-  const external = Object.keys(libraryBuildOptions).filter((library) => { return key !== library; });
-  const output = {
-    ...value.rollupOptions?.output,
-    paths: libraryPaths,
-  };
-  const libraryConfig = {
-    configFile: './build/commonViteConfig.js',
-    esbuild: {
-      minify: true,
-    },
-    define: {
-      'process.env.NODE_ENV': '"production"',
-    },
-    build: {
-      write: false,
-      emptyOutDir: false,
-      lib: {
-        entry: path.resolve(process.cwd(), value.entry),
-        formats: ['es'],
-        fileName: `assets/${value.lib}.${value.hash}`,
-      },
-      rollupOptions: {
-        ...value.rollupOptions,
-        output,
-        external,
-      },
-    },
-  };
-  await buildLibrary(libraryConfig, 'assets', value.lib, value.hash);
-  console.log('Building Library Entry: ', key);
-
-  const libraryEntryConfig = {
-    configFile: false,
-    define: {
-      'process.env.NODE_ENV': '"production"',
-    },
-    build: {
-      emptyOutDir: false,
-      lib: {
-        entry: path.resolve(process.cwd(), value.libraryEntry || value.entry),
-        formats: ['es'],
-        fileName: () => { return `assets/${value.lib}.js`; },
-      },
-      rollupOptions: {
-        ...value.rollupOptions,
-        external: [key],
-        output: {
-          paths: libraryPaths,
-        },
-      },
-    },
-  };
-  await build(libraryEntryConfig);
-  await fs.promises.cp(
-    path.join('src', 'assets', 'font'),
-    path.join('dist', 'assets', 'font'),
-    { recursive: true },
-  );
-}));
-
-await buildCesium();
-console.log('Finished Building vcMap');
+import path from 'path';
+import fs from 'fs';
+import { build } from 'vite';
+import { v4 as uuid } from 'uuid';
+import rollupPluginStripPragma from 'rollup-plugin-strip-pragma';
+import vcsOl from '@vcmap/rollup-plugin-vcs-ol';
+import generateOLLib from './generateOLLib.js';
+import buildCesium from './buildCesium.js';
+import { buildLibrary, libraries } from './buildHelpers.js';
+
+/**
+ * @typedef {Object} LibraryBuildOption
+ * @property {string} lib
+ * @property {string} entry
+ * @property {string} [libraryEntry]
+ * @property {import("rollup").RollupOptions} [rollupOptions]
+ */
+
+/**
+ * @returns {{ libraryBuildOptions: Object<string, LibraryBuildOption>, libraryPaths: Object<string, string> }}
+ */
+function hashLibraries() {
+  /** @type {Object<string, LibraryBuildOption>} */
+  const libraryBuildOptions = {
+    vue: {
+      entry: path.join('lib', 'vue.js'),
+    },
+    '@vcmap-cesium/engine': {
+      entry: path.join('lib', 'cesium.js'),
+      rollupOptions: {
+        plugins: [
+          rollupPluginStripPragma({
+            pragmas: ['debug'],
+          }),
+        ],
+      },
+    },
+    ol: {
+      entry: path.join('lib', 'olLib.js'),
+      libraryEntry: path.join('lib', 'ol.js'), // openlayers special case, the entry to compile is the olLib, but the public entry must be ol.js
+      rollupOptions: {
+        output: {
+          manualChunks: () => 'ol.js', // this is needed, otherwise vitejs will create multiple chunks for openlayers.
+        },
+      },
+    },
+    '@vcmap/core': {
+      entry: path.join('lib', 'core.js'),
+      rollupOptions: {
+        plugins: [vcsOl()],
+      },
+    },
+    '@vcmap/ui': {
+      rollupOptions: {
+        plugins: [
+          vcsOl(),
+          {
+            transform(source, sid) {
+              if (/src(\/|\\)setup.js/.test(sid)) {
+                return source.replace(
+                  '/node_modules/@vcmap-cesium/engine/Build/',
+                  './assets/cesium/',
+                );
+              }
+              return source;
+            },
+          },
+        ],
+      },
+      entry: path.join('lib', 'ui.js'),
+    },
+    'vuetify/lib': {
+      entry: path.join('lib', 'vuetify.js'),
+    },
+  };
+
+  const libraryPaths = {};
+  Object.entries(libraryBuildOptions).forEach(([key, value]) => {
+    if (!libraries[key]) {
+      throw new Error(`Trying to build unexported library ${key}`);
+    }
+    value.lib = libraries[key];
+    value.hash = `${uuid().substring(0, 6)}`;
+    libraryPaths[key] = `./${value.lib}.${value.hash}.js`;
+    value.rollupOptions = value.rollupOptions ? value.rollupOptions : {};
+  });
+
+  return { libraryBuildOptions, libraryPaths };
+}
+
+const { libraryBuildOptions, libraryPaths } = hashLibraries();
+console.log('Building ol dump file');
+await generateOLLib();
+
+console.log('Building app');
+await build({
+  configFile: './build/commonViteConfig.js',
+  base: './',
+  define: {
+    'process.env.NODE_ENV': '"production"',
+  },
+  build: {
+    minify: true,
+    emptyOutDir: true,
+    rollupOptions: {
+      external: Object.keys(libraries),
+      output: {
+        paths: libraryPaths,
+      },
+    },
+  },
+});
+
+console.log('Building Libraries');
+await Promise.all(
+  Object.entries(libraryBuildOptions).map(async ([key, value]) => {
+    console.log('Building Library: ', key);
+    const external = Object.keys(libraryBuildOptions).filter((library) => {
+      return key !== library;
+    });
+    const output = {
+      ...value.rollupOptions?.output,
+      paths: libraryPaths,
+    };
+    const libraryConfig = {
+      configFile: './build/commonViteConfig.js',
+      esbuild: {
+        minify: true,
+      },
+      define: {
+        'process.env.NODE_ENV': '"production"',
+      },
+      build: {
+        write: false,
+        emptyOutDir: false,
+        lib: {
+          entry: path.resolve(process.cwd(), value.entry),
+          formats: ['es'],
+          fileName: `assets/${value.lib}.${value.hash}`,
+        },
+        rollupOptions: {
+          ...value.rollupOptions,
+          output,
+          external,
+        },
+      },
+    };
+    await buildLibrary(libraryConfig, 'assets', value.lib, value.hash);
+    console.log('Building Library Entry: ', key);
+
+    const libraryEntryConfig = {
+      configFile: false,
+      define: {
+        'process.env.NODE_ENV': '"production"',
+      },
+      build: {
+        emptyOutDir: false,
+        lib: {
+          entry: path.resolve(process.cwd(), value.libraryEntry || value.entry),
+          formats: ['es'],
+          fileName: () => {
+            return `assets/${value.lib}.js`;
+          },
+        },
+        rollupOptions: {
+          ...value.rollupOptions,
+          external: [key],
+          output: {
+            paths: libraryPaths,
+          },
+        },
+      },
+    };
+    await build(libraryEntryConfig);
+    await fs.promises.cp(
+      path.join('src', 'assets', 'font'),
+      path.join('dist', 'assets', 'font'),
+      { recursive: true },
+    );
+  }),
+);
+
+await buildCesium();
+console.log('Finished Building vcMap');

package/build/buildCesium.js

@@ -1,19 +1,32 @@
-import fs from 'fs';
-import path from 'path';
-
-/**
- * copies Cesium Assets and Workers to dist folder
- * @returns {Promise<void>}
- */
-export default async function buildCesium() {
-  const cesiumPath = path.join(process.cwd(), 'node_modules', '@vcmap-cesium', 'engine');
-  const buildPath = path.join(process.cwd(), 'dist', 'assets', 'cesium');
-  return Promise.all([
-    fs.promises.cp(path.join(cesiumPath, 'Source', 'Assets'), path.join(buildPath, 'Assets'), {
-      recursive: true,
-    }),
-    fs.promises.cp(path.join(cesiumPath, 'Build', 'Workers'), path.join(buildPath, 'Workers'), {
-      recursive: true,
-    }),
-  ]);
-}
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * copies Cesium Assets and Workers to dist folder
+ * @returns {Promise<void>}
+ */
+export default async function buildCesium() {
+  const cesiumPath = path.join(
+    process.cwd(),
+    'node_modules',
+    '@vcmap-cesium',
+    'engine',
+  );
+  const buildPath = path.join(process.cwd(), 'dist', 'assets', 'cesium');
+  return Promise.all([
+    fs.promises.cp(
+      path.join(cesiumPath, 'Source', 'Assets'),
+      path.join(buildPath, 'Assets'),
+      {
+        recursive: true,
+      },
+    ),
+    fs.promises.cp(
+      path.join(cesiumPath, 'Build', 'Workers'),
+      path.join(buildPath, 'Workers'),
+      {
+        recursive: true,
+      },
+    ),
+  ]);
+}