@vcmap/plugin-cli 2.0.10 → 2.0.12

package/src/serve.js

@@ -4,8 +4,6 @@ import { createVuePlugin } from 'vite-plugin-vue2';
 import express from 'express';
 import { logger } from '@vcsuite/cli-logger';
 import path from 'path';
-import { VuetifyResolver } from 'unplugin-vue-components/dist/resolvers.js';
-import Components from 'unplugin-vue-components/dist/vite.js';
 import { getContext } from './context.js';
 import {
   addConfigRoute,
@@ -17,10 +15,11 @@ import {
   resolveMapUi,
 } from './hostingHelpers.js';
 import { getPluginName } from './packageJsonHelpers.js';
+import { getVcmConfigJs } from './pluginCliHelper.js';
 
 /**
  * @typedef {HostingOptions} ServeOptions
- * @property {string} [mapConfig] - an filename or URL to a map config
+ * @property {string} [mapConfig] - a filename or URL to a map config
  */
 
 async function getProxy(protocol, port) {
@@ -50,6 +49,13 @@ async function getProxy(protocol, port) {
   if (hasThisPlugin) {
     delete proxy[hasThisPlugin];
   }
+
+  // exampleData is not part of the @vcmap/ui package and must be proxied therefore
+  proxy['^/exampleData'] = {
+    target: 'https://raw.githubusercontent.com/virtualcitySYSTEMS/map-ui/main',
+    changeOrigin: true,
+    secure: false,
+  };
   return proxy;
 }
 
@@ -62,13 +68,15 @@ export default async function serve(options) {
     logger.error('Can only serve in dev mode, if the map ui is a dependency of the current context');
     return;
   }
+  const { default: vcmConfigJs } = await getVcmConfigJs();
+  const mergedOptions = { ...vcmConfigJs, ...options };
   await printVcmapUiVersion();
   checkReservedDirectories();
   const app = express();
-  const port = options.port || 8008;
+  const port = mergedOptions.port || 8008;
 
   logger.info('Starting development server...');
-  const proxy = await getProxy(options.https ? 'https' : 'http', port);
+  const proxy = await getProxy(mergedOptions.https ? 'https' : 'http', port);
 
   const server = await createServer({
     root: getContext(),
@@ -90,18 +98,11 @@ export default async function serve(options) {
     plugins: [
       createVuePlugin(),
       createConfigJsonReloadPlugin(),
-      Components({
-        resolvers: [
-          VuetifyResolver(),
-        ],
-        include: [],
-        exclude: [],
-      }),
     ],
     server: {
-      middlewareMode: 'html',
-      https: options.https,
-      proxy,
+      middlewareMode: true,
+      https: mergedOptions.https,
+      proxy: { ...mergedOptions.proxy, ...proxy },
     },
     css: {
       preprocessorOptions: {
@@ -112,10 +113,10 @@ export default async function serve(options) {
     },
   });
 
-  addMapConfigRoute(app, options.mapConfig, options.auth, options.config);
+  addMapConfigRoute(app, mergedOptions.mapConfig, mergedOptions.auth, mergedOptions.config);
   addIndexRoute(app, server);
   addPluginAssets(app, 'src');
-  await addConfigRoute(app, options.auth, options.config);
+  await addConfigRoute(app, mergedOptions.auth, mergedOptions.config);
 
   app.use(server.middlewares);
 

package/src/update.js

@@ -0,0 +1,50 @@
+import { logger } from '@vcsuite/cli-logger';
+import { DepType, getPackageJson, installDeps } from './packageJsonHelpers.js';
+import { name, promiseExec } from './pluginCliHelper.js';
+
+/**
+ * Update peer dependencies of a provided packageJson with @vcmap/ui@latest peers
+ * @param {Object} pluginPeer - peerDependencies of a plugin
+ * @param {string} pluginPath
+ * @returns {Promise<void>}
+ */
+export async function updatePeerDependencies(pluginPeer, pluginPath) {
+  const { stdout, stderr } = await promiseExec('npm view @vcmap/ui --json');
+  logger.error(stderr);
+  const { name: mapName, peerDependencies: mapPeer } = JSON.parse(stdout);
+  const peerDeps = [`${mapName}@latest`]; // @vcmap/ui is a required peer dep and will be updated in any case
+  if (pluginPeer) {
+    const pluginPeerDeps = Object.keys(pluginPeer)
+      .filter(depName => !!mapPeer[depName] && pluginPeer[depName] !== mapPeer[depName])
+      .map(depName => `${depName}@${mapPeer[depName]}`);
+    peerDeps.push(pluginPeerDeps);
+  }
+  logger.spin('Updating peer dependencies');
+  await installDeps(peerDeps, DepType.PEER, pluginPath);
+  logger.stopSpinner();
+  logger.success('Updated peer dependencies');
+}
+
+/**
+ * Updates the @vcmap/plugin-cli
+ * @param {string} pluginPath
+ * @returns {Promise<void>}
+ */
+async function updateCli(pluginPath) {
+  logger.spin(`Updating ${name}`);
+  await installDeps([`${name}@latest`], DepType.DEV, pluginPath);
+  logger.stopSpinner();
+  logger.success(`Updated ${name}`);
+}
+
+/**
+ * Updating peer dependencies to @vmap/ui@latest
+ * Updating @vcmap/plugin-cli
+ * @returns {Promise<void>}
+ */
+export default async function update() {
+  const packageJson = await getPackageJson();
+  await updatePeerDependencies(packageJson.peerDependencies, process.cwd());
+  await updateCli(process.cwd());
+  logger.success(`Updated plugin ${packageJson.name}`);
+}

package/assets/helloWorld/build/staging/Dockerfile

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

package/assets/helloWorld/src/helloWorld.vue

@@ -1,54 +0,0 @@
-<template>
-  <v-sheet class="hello-world">
-    <v-card class="pa-2 ma-2">
-      <v-container>
-        <v-row class="justify-center mb-4">
-          <h1>{{ $t('helloWorld.helloWorld') }}</h1>
-        </v-row>
-        <v-row class="justify-center mb-4">
-          <v-img
-            :src="logoUrl"
-            alt="plugin-assets example"
-            max-width="200"
-          />
-        </v-row>
-        <v-row class="justify-center">
-          <VcsButton
-            icon="mdi-times"
-            @click="closeSelf"
-          >
-            {{ $t('helloWorld.close')}}
-          </VcsButton>
-        </v-row>
-      </v-container>
-    </v-card>
-  </v-sheet>
-</template>
-
-<style>
-.hello-world {
-  background-color: aqua;
-}
-</style>
-<script>
-  import { inject } from 'vue';
-  import { VcsButton, getPluginAssetUrl } from '@vcmap/ui';
-  import { name } from '../package.json';
-
-  export const windowId = 'hello_world_window_id_plugin-cli';
-
-  export default {
-    name: 'HelloWorld',
-    components: { VcsButton },
-    setup() {
-      const app = inject('vcsApp');
-
-      return {
-        closeSelf() {
-          app.windowManager.remove(windowId);
-        },
-        logoUrl: getPluginAssetUrl(app, name, 'plugin-assets/vcs_logo.png'),
-      };
-    },
-  };
-</script>

package/assets/helloWorld/src/index.js

@@ -1,72 +0,0 @@
-import { WindowSlot } from '@vcmap/ui';
-import { version, name } from '../package.json';
-import HelloWorld, { windowId } from './helloWorld.vue';
-
-/**
- * @param {T} config - the configuration of this plugin instance, passed in from the app.
- * @param {string} baseUrl - the absolute URL from which the plugin was loaded (without filename, ending on /)
- * @returns {import("@vcmap/ui/src/vcsUiApp").VcsPlugin<T>}
- * @template {Object} T
- * @template {Object} S
- */
-export default function(config, baseUrl) {
-  return {
-    get name() { return name; },
-    get version() { return version; },
-    /**
-     * @param {import("@vcmap/ui").VcsUiApp} vcsUiApp
-     * @param {S=} state
-     * @returns {Promise<void>}
-     */
-    initialize: async (vcsUiApp, state) => {
-      console.log('Called before loading the rest of the current context. Passed in the containing Vcs UI App ');
-    },
-    /**
-     * @param {import("@vcmap/ui").VcsUiApp} vcsUiApp
-     * @returns {Promise<void>}
-     */
-    onVcsAppMounted: async (vcsUiApp) => {
-      console.log('Called when the root UI component is mounted and managers are ready to accept components');
-      vcsUiApp.windowManager.add({
-        id: windowId,
-        component: HelloWorld,
-        WindowSlot: WindowSlot.DETACHED,
-        position: {
-          left: '40%',
-          right: '40%',
-        },
-      }, name);
-    },
-    /**
-     * @returns {Promise<S>}
-     */
-    getState: async () => {
-      console.log('Called when serializing this plugin instance');
-      return {};
-    },
-    /**
-     * @returns {Promise<T>}
-     */
-    toJSON: async () => {
-      console.log('Called when serializing this plugin instance');
-      return {};
-    },
-    i18n: {
-      en: {
-        helloWorld: {
-          helloWorld: '@vcmap/plugin-cli - Hello World',
-          close: 'Close',
-        },
-      },
-      de: {
-        helloWorld: {
-          helloWorld: '@vcmap/plugin-cli - Hallo Welt',
-          close: 'Schließen',
-        },
-      },
-    },
-    destroy() {
-      console.log('hook to cleanup');
-    },
-  };
-};