@vcmap/ui 5.3.2 → 6.0.0-rc.1

package/build/build.js

@@ -77,8 +77,17 @@ function hashLibraries() {
       },
       entry: path.join('lib', 'ui.js'),
     },
-    'vuetify/lib': {
-      entry: path.join('lib', 'vuetify.js'),
+    vuetify: {
+      entry: path.join('lib', 'vuetifyLib.js'),
+      // vuetify special case, the entry to compile is the vuetifyLib, but the public entry must be vuetify.js
+      // vuetifyLib will reexport the nested vuetify namespace as a flat namespace, so we can easily point all
+      // nested namespaces to the vuetify entry file.
+      libraryEntry: path.join('lib', 'vuetify.js'),
+      rollupOptions: {
+        output: {
+          manualChunks: () => 'vuetify.js', // this is needed, otherwise vitejs will create multiple chunks.
+        },
+      },
     },
   };
 
@@ -93,6 +102,18 @@ function hashLibraries() {
     value.rollupOptions = value.rollupOptions ? value.rollupOptions : {};
   });
 
+  // Handle extended Vuetify libraries
+  Object.keys(libraries).forEach((key) => {
+    if (!libraryPaths[key]) {
+      if (key.startsWith('vuetify')) {
+        libraryPaths[key] = libraryPaths.vuetify;
+      }
+      if (key.startsWith('@cesium')) {
+        libraryPaths[key] = libraryPaths['@vcmap-cesium/engine'];
+      }
+    }
+  });
+
   return { libraryBuildOptions, libraryPaths };
 }
 
@@ -231,9 +252,10 @@ 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 external = Object.keys(libraries).filter((library) => {
+      return key !== library && !library.startsWith(key);
     });
+
     const output = {
       ...value.rollupOptions?.output,
       paths: libraryPaths,

package/build/buildHelpers.js

@@ -268,7 +268,12 @@ export const libraries = {
   ol: 'ol',
   '@vcmap/core': 'core',
   '@vcmap/ui': 'ui',
-  'vuetify/lib': 'vuetify',
+  vuetify: 'vuetify',
+  'vuetify/components': 'vuetify',
+  'vuetify/styles': 'vuetify',
+  'vuetify/directives': 'vuetify',
+  'vuetify/blueprints': 'vuetify',
+  'vuetify/labs/components': 'vuetify',
 };
 
 const toCopy = [

package/build/buildTypes.js

@@ -109,6 +109,22 @@ async function fixTemplateFunctions() {
   );
 }
 
+async function vueAugmentations() {
+  let content = await readFile('./index.d.ts', 'utf-8');
+  content = `${content}
+declare module 'vue' {
+  type ReplaceFirstParam<TParams extends readonly any[], TReplace> = {
+    [K in keyof TParams]: K extends "0" ? TReplace : TParams[K]
+  }
+
+  interface ComponentCustomProperties {
+    $st: (...params: ReplaceFirstParam<Parameters<import("vue-i18n").ComposerTranslation>, string | null | undefined>) => ReturnType<import("vue-i18n").ComposerTranslation>
+  }
+}
+`;
+  await writeFile('./index.d.ts', content);
+}
+
 function printTypeErrors(stdout) {
   let withinNodeModule = false;
   const lines = stdout.split(EOL).filter((line) => {
@@ -156,6 +172,8 @@ async function run() {
   await fixTemplateFunctions();
   console.log('exporting types');
   await addTypeExports();
+  console.log('augmenting vue');
+  await vueAugmentations();
   if (process.argv.includes('--skipValidation')) {
     return;
   }

package/build/commonViteConfig.js

@@ -1,7 +1,8 @@
 /* eslint-disable import/extensions */
 import path from 'path';
 import { defineConfig } from 'vite';
-import vue2 from '@vitejs/plugin-vue2';
+import vue3 from '@vitejs/plugin-vue';
+import { transformAssetUrls } from 'vite-plugin-vuetify';
 import { libraries } from './buildHelpers.js';
 
 const configMain = defineConfig({
@@ -9,7 +10,6 @@ const configMain = defineConfig({
     alias: {
       '@vcmap/ui': `${path.resolve(process.cwd(), 'index.js')}`,
       '@cesium/engine': '@vcmap-cesium/engine',
-      vue: 'vue/dist/vue.esm.js',
       tinyqueue: 'tinyqueue/tinyqueue.js',
     },
     dedupe: Object.keys(libraries),
@@ -17,14 +17,11 @@ const configMain = defineConfig({
   define: {
     'process.env.NODE_ENV': '"development"',
   },
-  plugins: [vue2()],
-  css: {
-    preprocessorOptions: {
-      sass: {
-        additionalData: "\n@import './src/styles/variables.scss'\n",
-      },
-    },
-  },
+  plugins: [
+    vue3({
+      template: { transformAssetUrls },
+    }),
+  ],
 });
 
 export default configMain;

package/build/generateOLLib.js

@@ -67,7 +67,11 @@ function spawnJSDoc() {
   return new Promise((resolve, reject) => {
     let output = '';
     let errors = '';
-    const child = spawn(getBinaryPath('jsdoc'), ['-c', jsdocConfig, sourceDir]);
+    const child = spawn(
+      getBinaryPath('jsdoc'),
+      ['-c', jsdocConfig, sourceDir],
+      { shell: true },
+    );
 
     child.stdout.on('data', (data) => {
       output += String(data);

package/build/info/publish.js

@@ -154,8 +154,8 @@ exports.publish = function publish(data) {
         const target = isExterns
           ? externs
           : doc.api || doc.exports
-          ? symbols
-          : base;
+            ? symbols
+            : base;
         const existingSymbol = symbolsByName[symbol.name];
         if (existingSymbol) {
           const idx = target.indexOf(existingSymbol);

package/build/lintTypes.js

@@ -10,6 +10,11 @@ async function lintTypes() {
   for await (const path of getFilesInDirectory('./src')) {
     if (path.endsWith('.d.ts') && !path.endsWith('vue.d.ts')) {
       const content = await readFile(path, 'utf8');
+      if (path.endsWith('vcsUiApp.d.ts')) {
+        // we do not check the vcsUiApp.d.ts, because the vuetify return Type has several occurances of any
+        // 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/build/staging/Dockerfile

@@ -1,2 +1,2 @@
 FROM httpd:2-buster
-COPY * /usr/local/apache2/htdocs/
+COPY . /usr/local/apache2/htdocs/

package/config/base.config.json

@@ -666,7 +666,7 @@
       "activeOnStartup": false,
       "allowPicking": false,
       "properties": {
-        "title": "WFS Layer (next to Groningen)",
+        "title": "WFS Layer (next to Groningen in the Netherlands)",
         "featureInfo": "tableAll"
       }
     },
@@ -938,6 +938,7 @@
       "name": "building.texturedBuildings",
       "layerName": "buildings",
       "type": "LayerContentTreeItem",
+      "tooltip": "Textured buildings",
       "onActivate": [
         {
           "type": "DeactivateLayersCallback",
@@ -1114,7 +1115,9 @@
     {
       "name": "@vcmap-show-case/theme-changer",
       "entry": "plugins/@vcmap-show-case/theme-changer/index.js"
-    },
+    }
+  ],
+  "plugins2": [
     {
       "name": "@vcmap/create-link",
       "entry": "plugins/@vcmap/create-link/index.js"

package/config/dev.config.json

@@ -511,12 +511,14 @@
     {
       "name": "flight",
       "flightName": "FlightExampleBerlin",
-      "type": "FlightContentTreeItem"
+      "type": "FlightContentTreeItem",
+      "title": "this flight has a very long name. You can find the rest in the tooltip"
     },
     {
       "name": "flight2",
       "flightName": "FlightExampleBerlin2",
-      "type": "FlightContentTreeItem"
+      "type": "FlightContentTreeItem",
+      "tooltip": "This is a flight. Its flight 2, actually."
     },
     {
       "name": "geojson",
@@ -642,14 +644,6 @@
       "name": "vector-properties-example",
       "entry": "plugins/@vcmap-show-case/vector-properties-example/index.js"
     },
-    {
-      "name": "@vcmap/print",
-      "entry": "plugins/@vcmap/print/index.js"
-    },
-    {
-      "name": "@vcmap/search-nominatim",
-      "entry": "plugins/@vcmap/search-nominatim/index.js"
-    },
     {
       "name": "switch-map-callback-example",
       "entry": "plugins/@vcmap-show-case/switch-map-callback-example/index.js"
@@ -664,6 +658,16 @@
       "showComponent": false
     }
   ],
+  "plugins2": [
+    {
+      "name": "@vcmap/print",
+      "entry": "plugins/@vcmap/print/index.js"
+    },
+    {
+      "name": "@vcmap/search-nominatim",
+      "entry": "plugins/@vcmap/search-nominatim/index.js"
+    }
+  ],
   "uiConfig": [
     {
       "name": "appTitle",

package/config/www.config.json

@@ -1827,7 +1827,7 @@
       "layerName": "festgesetzte Überschwemmungsgebiete"
     }
   ],
-  "plugins": [
+  "plugins2": [
     {
       "name": "@vcmap/link-button",
       "entry": "plugins/@vcmap/link-button/index.js",