@vcmap/ui 6.0.0-rc.3 → 6.0.0-rc.5

package/build/buildHelpers.js

@@ -1,4 +1,3 @@
-/* eslint import/no-extraneous-dependencies: ["error", { "devDependencies": false }] */
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { build } from 'vite'; // vite is also a plugin-cli dep
 import fs from 'fs';
@@ -279,7 +278,12 @@ const toCopy = [
   'README.md',
 ];
 
-async function buildInlinePlugin(plugin, baseConfig, minify) {
+async function buildInlinePlugin(
+  plugin,
+  baseConfig,
+  minify,
+  isDependend = false,
+) {
   // the relative path between plugins and libraries, is not known beforehand, so we calculate the distance.
   // posixRelativePath is the relative path between the index.js of the plugin and the specific library.
   const relativePluginPaths = {};
@@ -292,7 +296,15 @@ async function buildInlinePlugin(plugin, baseConfig, minify) {
       .join(path.posix.sep);
   });
 
-  const pluginDir = getProjectPath('plugins', plugin);
+  const pluginDir = isDependend
+    ? getProjectPath('plugins', 'node_modules', plugin)
+    : getProjectPath('plugins', plugin);
+
+  const isTs = fs.existsSync(path.join(pluginDir, 'src', 'index.ts'));
+  const entry = isTs
+    ? path.join(pluginDir, 'src', 'index.ts')
+    : path.join(pluginDir, 'src', 'index.js');
+
   const pluginConfig = {
     ...baseConfig,
     esbuild: {
@@ -303,13 +315,14 @@ async function buildInlinePlugin(plugin, baseConfig, minify) {
       emptyOutDir: false,
       outDir: `dist/plugins/${plugin}/`,
       lib: {
-        entry: path.join(pluginDir, 'src', 'index.js'),
+        entry,
         formats: ['es'],
         fileName: 'index',
       },
       rollupOptions: {
         external: Object.keys(libraries),
         output: {
+          manualChunks: () => 'index.js',
           paths: relativePluginPaths,
         },
       },
@@ -321,11 +334,11 @@ async function buildInlinePlugin(plugin, baseConfig, minify) {
   }
   await buildLibrary(pluginConfig, `plugins/${plugin}`, 'index', '', true);
   await Promise.all(
-    toCopy.map(async (entry) => {
-      if (fs.existsSync(path.join(pluginDir, entry))) {
+    toCopy.map(async (fileEntry) => {
+      if (fs.existsSync(path.join(pluginDir, fileEntry))) {
         await fs.promises.cp(
-          path.join(pluginDir, entry),
-          path.join(distPath, entry),
+          path.join(pluginDir, fileEntry),
+          path.join(distPath, fileEntry),
           { recursive: true, force: true },
         );
       }
@@ -333,6 +346,10 @@ async function buildInlinePlugin(plugin, baseConfig, minify) {
   );
 }
 
+/**
+ * Dependent Plugins which are installed from npm are already build and we just copy the relevant files
+ * @param {string} pluginName
+ */
 async function buildDependentPlugin(pluginName) {
   const pluginsDirectory = getPluginDirectory();
   let scope = '';
@@ -365,6 +382,19 @@ async function buildDependentPlugin(pluginName) {
   );
 }
 
+function filterDependentPlugins(dependentPlugins, pluginIsBuild = true) {
+  const pluginsDir = getPluginDirectory();
+  return dependentPlugins.filter((pluginName) => {
+    const pluginExists = fs.existsSync(
+      path.join(pluginsDir, 'node_modules', ...pluginName.split('/'), 'dist'),
+    );
+    if (pluginIsBuild) {
+      return pluginExists;
+    }
+    return !pluginExists;
+  });
+}
+
 /**
  * Will build a preview of all the current plugins & inline plugins
  * @param {import("vite").InlineConfig} [baseConfig={}] - the base config to use. build & esbuild will be completely overwritten
@@ -374,14 +404,25 @@ async function buildDependentPlugin(pluginName) {
 export async function buildPluginsForPreview(baseConfig = {}, minify = true) {
   const inlinePlugins = await getInlinePlugins();
   const dependentPlugins = await getPluginNames();
+  // only take already build plugins into account.
+  // Plugins loaded from a git repository do not have a dist folder.
+  // These plugins need to be build, same as the inline plugins
+  const buildDependentPlugins = filterDependentPlugins(dependentPlugins, true);
+  const notBuildDependentPlugins = filterDependentPlugins(
+    dependentPlugins,
+    false,
+  );
 
   const promises = inlinePlugins.map((plugin) =>
     buildInlinePlugin(plugin, baseConfig, minify),
   );
 
   promises.push(
-    ...dependentPlugins.map(async (pluginName) =>
-      buildDependentPlugin(pluginName, baseConfig, minify),
+    ...buildDependentPlugins.map(async (pluginName) =>
+      buildDependentPlugin(pluginName),
+    ),
+    ...notBuildDependentPlugins.map(async (pluginName) =>
+      buildInlinePlugin(pluginName, baseConfig, minify, true),
     ),
   );
   await Promise.all(promises);
@@ -390,14 +431,22 @@ export async function buildPluginsForPreview(baseConfig = {}, minify = true) {
 export async function buildPluginsForBundle(baseConfig = {}) {
   const inlinePlugins = await getInlinePlugins();
   const dependentPlugins = await getPluginNames(false);
+  const buildDependentPlugins = filterDependentPlugins(dependentPlugins, true);
+  const notBuildDependentPlugins = filterDependentPlugins(
+    dependentPlugins,
+    false,
+  );
   const promises = inlinePlugins
     .filter((plugin) => plugin.startsWith('@vcmap/'))
     .map((plugin) => buildInlinePlugin(plugin, baseConfig, true));
 
   promises.push(
-    ...dependentPlugins.map(async (pluginName) =>
+    ...buildDependentPlugins.map(async (pluginName) =>
       buildDependentPlugin(pluginName),
     ),
+    ...notBuildDependentPlugins.map(async (pluginName) =>
+      buildInlinePlugin(pluginName, baseConfig, true, true),
+    ),
   );
   await Promise.all(promises);
 }

package/build/bundle.js

@@ -1,6 +1,6 @@
 import vcsOl from '@vcmap/rollup-plugin-vcs-ol';
 import { join as joinPath } from 'path';
-import tar from 'tar';
+import * as tar from 'tar';
 import { cp, rm } from 'fs/promises';
 import { createGzip } from 'zlib';
 import { pipeline } from 'stream';

package/build/info/publish.js

@@ -20,37 +20,31 @@ exports.publish = function publish(data) {
 
   // get all doclets that have exports
   const classes = {};
-  const docs = data(
-    [
-      { define: { isObject: true } },
-      function someKindOfExportsTransformer() {
-        if (this?.meta?.code?.name) {
-          if (this.meta.code.name === 'module.exports') {
-            this.exports = 'default';
-          } else if (String(this.meta.code.name).startsWith('exports.')) {
-            this.exports = this.meta.code.name.replace(/exports./, '');
-          }
-        }
-        if (this.kind === 'class') {
-          if (
-            !('extends' in this) ||
-            typeof this.api === 'boolean' ||
-            this.exports
-          ) {
-            classes[this.longname] = this;
-            return true;
-          }
-        }
-        return (
-          typeof this.api === 'boolean' ||
-          this.exports ||
-          (this.meta && /[\\/]externs$/.test(this.meta.path))
-        );
-      },
-    ],
-    { kind: { '!is': 'file' } },
-    { kind: { '!is': 'event' } },
-  ).get();
+  const docs = data(function someKindOfExportsTransformer() {
+    if (this?.meta?.code?.name) {
+      if (this.meta.code.name === 'module.exports') {
+        this.exports = 'default';
+      } else if (String(this.meta.code.name).startsWith('exports.')) {
+        this.exports = this.meta.code.name.replace(/exports./, '');
+      }
+    }
+    if (this.kind === 'class') {
+      if (
+        !('extends' in this) ||
+        typeof this.api === 'boolean' ||
+        this.exports
+      ) {
+        classes[this.longname] = this;
+        return true;
+      }
+    }
+    return (
+      !['file', 'event', 'module'].includes(this.kind) &&
+      (typeof this.api === 'boolean' ||
+        this.exports ||
+        (this.meta && /[\\/]externs$/.test(this.meta.path)))
+    );
+  }).get();
 
   // get symbols data, filter out those that are members of private classes
   const symbols = [];

package/build/lintTypes.js

@@ -15,6 +15,11 @@ async function lintTypes() {
         // eslint-disable-next-line no-continue
         continue;
       }
+      if (path.endsWith('uiConfig.d.ts')) {
+        // we do not check the vcsUiApp.d.ts, because import("vue").DeepReadonly creates an any type
+        // eslint-disable-next-line no-continue
+        continue;
+      }
       // eslint-disable-next-line no-loop-func
       content.split(EOL).forEach((line, index) => {
         const matches = line.match(anyRegex);

package/config/base.config.json

@@ -571,7 +571,8 @@
       "name": "tableAllWithTemplateHeader",
       "keyMapping": {
         "roofType": "codeLists.keys.roofType",
-        "function": "codeLists.keys.function"
+        "function": "codeLists.keys.function",
+        "featureId": "Feature ID"
       },
       "valueMapping": {
         "roofType": "codeLists.values.roofType.${value}",

package/config/dev.config.json

@@ -512,7 +512,8 @@
       "name": "flight",
       "flightName": "FlightExampleBerlin",
       "type": "FlightContentTreeItem",
-      "title": "this flight has a very long name. You can find the rest in the tooltip"
+      "title": "this flight has a very long name. You can find the rest in the tooltip",
+      "icon": "mdi-airplane"
     },
     {
       "name": "flight2",
@@ -549,6 +550,7 @@
       "name": "building.myTest",
       "type": "ContentTreeItem",
       "title": "test SwitchMapCallback Test",
+      "icon": "mdi-toggle-switch",
       "onClick": [
         {
           "type": "ActivateLayersCallback",
@@ -656,6 +658,10 @@
       "name": "@vcmap-show-case/hello-world",
       "entry": "plugins/@vcmap-show-case/hello-world/index.js",
       "showComponent": false
+    },
+    {
+      "name": "@vcmap-show-case/search-example",
+      "entry": "plugins/@vcmap-show-case/search-example/index.js"
     }
   ],
   "plugins2": [

package/config/www.config.json

@@ -1827,6 +1827,30 @@
       "layerName": "festgesetzte Überschwemmungsgebiete"
     }
   ],
+  "plugins": [
+    {
+      "name": "@vcmap/print",
+      "entry": "plugins/@vcmap/print/index.js",
+      "contactDetails": {
+        "department": "Entwicklung",
+        "name": "Virtual City Systems",
+        "streetAddress": "Tauentzienstr. 7 b/c",
+        "zipAndCity": "10789 Berlin",
+        "country": "Germany",
+        "mail": "info@vc.systems",
+        "phone": "+49 (0) 30 . 8904 . 871 . 0",
+        "fax": "+49 (0) 30 . 8904 . 871 . 0"
+      }
+    },
+    {
+      "name": "@vcmap/multi-view",
+      "entry": "plugins/@vcmap/multi-view/index.js"
+    },
+    {
+      "name": "@vcmap/transparent-terrain",
+      "entry": "plugins/@vcmap/transparent-terrain/index.js"
+    }
+  ],
   "plugins2": [
     {
       "name": "@vcmap/link-button",
@@ -1854,20 +1878,6 @@
       "name": "@vcmap/create-link",
       "entry": "plugins/@vcmap/create-link/index.js"
     },
-    {
-      "name": "@vcmap/print",
-      "entry": "plugins/@vcmap/print/index.js",
-      "contactDetails": {
-        "department": "Entwicklung",
-        "name": "Virtual City Systems",
-        "streetAddress": "Tauentzienstr. 7 b/c",
-        "zipAndCity": "10789 Berlin",
-        "country": "Germany",
-        "mail": "info@vc.systems",
-        "phone": "+49 (0) 30 . 8904 . 871 . 0",
-        "fax": "+49 (0) 30 . 8904 . 871 . 0"
-      }
-    },
     {
       "name": "@vcmap/swipe-tool",
       "entry": "plugins/@vcmap/swipe-tool/index.js"
@@ -1884,10 +1894,6 @@
       "name": "@vcmap/search-nominatim",
       "entry": "plugins/@vcmap/search-nominatim/index.js"
     },
-    {
-      "name": "@vcmap/multi-view",
-      "entry": "plugins/@vcmap/multi-view/index.js"
-    },
     {
       "name": "@vcmap/cesium-filters",
       "entry": "plugins/@vcmap/cesium-filters/index.js"
@@ -1936,10 +1942,7 @@
       "projectId": "rBW58EJz5RwCz75Q3",
       "mapId": "csunCGqmQE8Py4KCe"
     },
-    {
-      "name": "@vcmap/transparent-terrain",
-      "entry": "plugins/@vcmap/transparent-terrain/index.js"
-    },
+
     {
       "name": "@vcmap/search-coordinate",
       "entry": "plugins/@vcmap/search-coordinate/index.js"