@vcmap/plugin-cli 2.1.4 → 2.1.6

package/src/hostingHelpers.js

@@ -10,7 +10,7 @@ import { promiseExec, getDirname } from './pluginCliHelper.js';
 
 /**
  * @typedef {Object} HostingOptions
- * @property {string} [config] - an optional fileName to use for configuring the plugin
+ * @property {string|Object} [config] - an optional configObject or fileName to use for configuring the plugin
  * @property {string} [auth] - potential auth string to download assets (index.html, config) with
  * @property {number} [port]
  * @property {boolean} [https]
@@ -21,16 +21,23 @@ import { promiseExec, getDirname } from './pluginCliHelper.js';
  * @returns {string}
  */
 export function resolveMapUi(...pathSegments) {
-  return path.join(getContext(), 'node_modules', '@vcmap', 'ui', ...pathSegments);
+  return path.join(
+    getContext(),
+    'node_modules',
+    '@vcmap',
+    'ui',
+    ...pathSegments,
+  );
 }
 
 export function checkReservedDirectories() {
-  ['assets', 'plugins', 'config']
-    .forEach((dir) => {
-      if (fs.existsSync(path.join(getContext(), dir))) {
-        logger.warning(`found reserved directory ${dir}. serving my not work as exptected`);
-      }
-    });
+  ['assets', 'plugins', 'config'].forEach((dir) => {
+    if (fs.existsSync(path.join(getContext(), dir))) {
+      logger.warning(
+        `found reserved directory ${dir}. serving my not work as exptected`,
+      );
+    }
+  });
 }
 
 /**
@@ -47,7 +54,9 @@ export function httpGet(stringUrl, auth, handler) {
   };
 
   if (auth) {
-    options.headers = { Authorization: `Basic ${Buffer.from(auth).toString('base64')}` };
+    options.headers = {
+      Authorization: `Basic ${Buffer.from(auth).toString('base64')}`,
+    };
   }
   if (url.protocol === 'https:') {
     https.get(options, handler);
@@ -57,11 +66,11 @@ export function httpGet(stringUrl, auth, handler) {
 }
 
 /**
- * @param {string} fileName
+ * @param {string|undefined} fileName
  * @returns {Promise<Object>}
  */
 export async function readConfigJson(fileName) {
-  const configFileName = fileName || resolveContext('config.json');
+  const configFileName = fileName ?? resolveContext('config.json');
   let config = {};
   if (fs.existsSync(configFileName)) {
     const content = await fs.promises.readFile(configFileName);
@@ -71,6 +80,18 @@ export async function readConfigJson(fileName) {
   return config;
 }
 
+/**
+ * @param {string|undefined} pluginConfig
+ * @returns {Promise<Object>}
+ */
+export async function getPluginConfig(pluginConfig) {
+  const isObject = typeof pluginConfig === 'object' && pluginConfig !== null;
+  if (isObject) {
+    return pluginConfig;
+  }
+  return readConfigJson(pluginConfig);
+}
+
 const configMap = new Map();
 
 /**
@@ -79,7 +100,9 @@ const configMap = new Map();
 export async function printVcmapUiVersion() {
   const packageJsonPath = resolveMapUi('package.json');
   if (!fs.existsSync(packageJsonPath)) {
-    throw new Error(`Cannot find the @vcmap/ui package in ${getContext()}. Are you sure you installed it?`);
+    throw new Error(
+      `Cannot find the @vcmap/ui package in ${getContext()}. Are you sure you installed it?`,
+    );
   }
 
   const content = await fs.promises.readFile(packageJsonPath);
@@ -88,37 +111,51 @@ export async function printVcmapUiVersion() {
 }
 
 /**
- * @param {Object} config
+ * Deletes plugin from other inline configs and adds a temporary config containing the pluginConfig
+ * @param {Object} appConfig
  * @param {Object} pluginConfig
  * @param {boolean} production
  * @returns {Promise<void>}
  */
-export async function reWriteConfig(config, pluginConfig, production) {
-  config.plugins = config.plugins ?? []; // XXX check if we have plugins in this repos dependencies?
+export async function reWriteAppConfig(appConfig, pluginConfig, production) {
+  const name = await getPluginName();
+  pluginConfig.name = name;
   pluginConfig.entry = production ? 'dist/index.js' : await getPluginEntry();
-  pluginConfig.name = await getPluginName();
-  const idx = config.plugins.findIndex(p => p.name === pluginConfig.name);
-  if (idx > -1) {
-    config.plugins.splice(idx, 1, pluginConfig);
-  } else {
-    config.plugins.push(pluginConfig);
-  }
+  appConfig.modules = appConfig.modules ?? [];
+  appConfig.modules.forEach((config) => {
+    if (Array.isArray(config.plugins)) {
+      config.plugins = config.plugins.filter((p) => p.name !== name);
+    }
+  });
+  appConfig.modules.push({ plugins: [pluginConfig] });
 }
 
 /**
- * @param {string} [mapConfig] - fs or https to config. defaults to @vcmap/ui/map.config.json
+ * @param {string} [appConfig] - fs or https to config. defaults to @vcmap/ui/app.config.json
  * @param {string} [auth]
  * @param {boolean} [production]
  * @param {string} [configFile]
  * @returns {Promise<unknown>}
  */
-export function getConfigJson(mapConfig, auth, production, configFile) {
-  const usedConfig = mapConfig || resolveMapUi('map.config.json');
-  if (configMap.has('map.config.json')) {
-    return Promise.resolve(configMap.get('map.config.json'));
+export function getAppConfigJson(appConfig, auth, production, configFile) {
+  const usedConfig = appConfig || resolveMapUi('app.config.json');
+  if (configMap.has('app.config.json')) {
+    return Promise.resolve(configMap.get('app.config.json'));
   }
-  const isWebVcm = /^https?:\/\//.test(usedConfig);
+  const isObject = typeof appConfig === 'object' && appConfig !== null;
+  const isWebVcm = !isObject && /^https?:\/\//.test(usedConfig);
   return new Promise((resolve, reject) => {
+    async function handleAppConfig(data) {
+      try {
+        const appConfigJson = JSON.parse(data);
+        configMap.set('app.config.json', appConfigJson);
+        const pluginConfig = await getPluginConfig(configFile);
+        await reWriteAppConfig(appConfigJson, pluginConfig, production);
+        resolve(appConfigJson);
+      } catch (e) {
+        reject(e);
+      }
+    }
     function handleStream(stream) {
       let data = '';
       stream.on('data', (chunk) => {
@@ -126,18 +163,12 @@ export function getConfigJson(mapConfig, auth, production, configFile) {
       });
 
       stream.on('close', async () => {
-        try {
-          const configJson = JSON.parse(data);
-          configMap.set('map.config.json', configJson);
-          const pluginConfig = await readConfigJson(configFile);
-          await reWriteConfig(configJson, pluginConfig, production);
-          resolve(configJson);
-        } catch (e) {
-          reject(e);
-        }
+        await handleAppConfig(data);
       });
     }
-    if (isWebVcm) {
+    if (isObject) {
+      handleAppConfig(JSON.stringify(appConfig));
+    } else if (isWebVcm) {
       httpGet(usedConfig, auth, (res) => {
         if (res.statusCode < 400) {
           handleStream(res);
@@ -188,32 +219,35 @@ export function createConfigJsonReloadPlugin() {
 
 /**
  * @param {Express} app
- * @param {string} mapConfig
+ * @param {string} appConfig
  * @param {string} [auth]
  * @param {string} [configFile]
  * @param {boolean} [production]
  */
-export function addMapConfigRoute(app, mapConfig, auth, configFile, production) {
-  app.get('/map.config.json', (req, res) => {
-    getConfigJson(mapConfig, auth, production, configFile)
-      .then((config) => {
-        const stringConfig = JSON.stringify(config, null, 2);
-        res.setHeader('Content-Type', 'application/json');
-        res.write(stringConfig);
-        res.end();
-      });
+export function addAppConfigRoute(
+  app,
+  appConfig,
+  auth,
+  configFile,
+  production,
+) {
+  app.get('/app.config.json', (req, res) => {
+    getAppConfigJson(appConfig, auth, production, configFile).then((config) => {
+      const stringConfig = JSON.stringify(config, null, 2);
+      res.setHeader('Content-Type', 'application/json');
+      res.write(stringConfig);
+      res.end();
+    });
   });
 }
 
 /**
  * @param {Express} app
- * @param {string} [auth]
- * @param {string} [configFileName]
- * @param {boolean} [production]
  */
-export async function addConfigRoute(app, auth, configFileName, production) { // IDEA pass in available plugins and strip unavailable ones?
+export async function addConfigRoute(app) {
+  // IDEA pass in available plugins and strip unavailable ones?
   const mapUiDir = resolveMapUi();
-  const pluginConfig = await readConfigJson(configFileName);
+  const pluginName = await getPluginName();
 
   app.get('/config*', async (req, res) => {
     const { url } = req;
@@ -226,7 +260,9 @@ export async function addConfigRoute(app, auth, configFileName, production) { //
         const configContent = await fs.promises.readFile(fileName);
         const config = JSON.parse(configContent);
         configMap.set(url, config);
-        await reWriteConfig(config, pluginConfig, production);
+        if (Array.isArray(config.plugins)) {
+          config.plugins = config.plugins.filter((p) => p.name !== pluginName);
+        }
         response = JSON.stringify(config);
       } catch (e) {
         configMap.delete(url);
@@ -249,9 +285,9 @@ export async function addConfigRoute(app, auth, configFileName, production) { //
  * @returns {Promise<string>}
  */
 export async function getMapUiIndexHtml(production) {
-  const indexHtmlFileName = production ?
-    resolveMapUi('dist', 'index.html') :
-    path.join(getDirname(), '..', 'assets', 'index.html');
+  const indexHtmlFileName = production
+    ? resolveMapUi('dist', 'index.html')
+    : path.join(getDirname(), '..', 'assets', 'index.html');
   const buffer = await fs.promises.readFile(indexHtmlFileName);
   return buffer.toString();
 }
@@ -275,15 +311,16 @@ export function addPluginAssets(app, base) {
  */
 export function addIndexRoute(app, server, production, hostedVcm, auth) {
   app.get('/', async (req, res) => {
-    let originalIndex = hostedVcm ?
-      await getIndexHtml(`${hostedVcm}/`, auth) :
-      await getMapUiIndexHtml(production); // TODO change hosted vcm index via option?
+    let originalIndex = hostedVcm
+      ? await getIndexHtml(`${hostedVcm}/`, auth)
+      : await getMapUiIndexHtml(production); // TODO change hosted vcm index via option?
 
-    originalIndex = await server.transformIndexHtml('/index.html', originalIndex);
+    originalIndex = await server.transformIndexHtml(
+      '/index.html',
+      originalIndex,
+    );
 
-    res.status(200)
-      .set({ 'Content-Type': 'text/html' })
-      .end(originalIndex);
+    res.status(200).set({ 'Content-Type': 'text/html' }).end(originalIndex);
   });
 }
 

package/src/pack.js

@@ -5,7 +5,6 @@ import { getPluginName } from './packageJsonHelpers.js';
 import { resolveContext } from './context.js';
 import build from './build.js';
 
-
 /**
  * @returns {Promise<void>}
  */
@@ -29,7 +28,10 @@ async function ensureConfigJson() {
       }
     }
   }
-  await fs.promises.writeFile(resolveContext('dist', 'config.json'), JSON.stringify(config, null, 2));
+  await fs.promises.writeFile(
+    resolveContext('dist', 'config.json'),
+    JSON.stringify(config, null, 2),
+  );
 }
 
 /**
@@ -38,7 +40,9 @@ async function ensureConfigJson() {
  */
 function zip(name) {
   return new Promise((resolve, reject) => {
-    const zipStream = fs.createWriteStream(resolveContext('dist', `${name.replace(/\//, '-')}.zip`));
+    const zipStream = fs.createWriteStream(
+      resolveContext('dist', `${name.replace(/\//, '-')}.zip`),
+    );
     const archive = archiver('zip', { zlib: { level: 5 } });
 
     zipStream.on('close', () => {
@@ -67,7 +71,10 @@ function zip(name) {
     });
 
     if (fs.existsSync(resolveContext('plugin-assets'))) {
-      archive.directory(resolveContext('plugin-assets'), `${name}/plugin-assets`);
+      archive.directory(
+        resolveContext('plugin-assets'),
+        `${name}/plugin-assets`,
+      );
     }
 
     archive.finalize().then(() => {

package/src/pluginCliHelper.js

@@ -17,13 +17,23 @@ export function getDirname() {
  * @type {string} version
  * @type {string} name
  */
-export const { version, name } = JSON.parse(fs.readFileSync(path.join(getDirname(), '..', 'package.json')).toString());
+export const { version, name } = JSON.parse(
+  fs.readFileSync(path.join(getDirname(), '..', 'package.json')).toString(),
+);
 
 /**
  * @type {(arg1: string) => Promise<string>}
  */
 export const promiseExec = util.promisify(childProcess.exec);
 
+/**
+ * @typedef {ServeOptions} VcmConfigJs
+ * @property {Object} proxy - see https://vitejs.dev/config/server-options.html#server-proxy
+ */
+
+/**
+ * @returns {Promise<VcmConfigJs>}
+ */
 export async function getVcmConfigJs() {
   let vcmConfigJs = {};
   const vcmConfigJsPath = path.resolve(getContext(), 'vcm.config.js');

package/src/preview.js

@@ -6,14 +6,18 @@ import { logger } from '@vcsuite/cli-logger';
 import {
   addConfigRoute,
   addIndexRoute,
-  addMapConfigRoute,
+  addAppConfigRoute,
   addPluginAssets,
   checkReservedDirectories,
   createConfigJsonReloadPlugin,
   printVcmapUiVersion,
   resolveMapUi,
 } from './hostingHelpers.js';
-import build, { buildMapUI, getDefaultConfig, getLibraryPaths } from './build.js';
+import build, {
+  buildMapUI,
+  getDefaultConfig,
+  getLibraryPaths,
+} from './build.js';
 import { getContext } from './context.js';
 import setupMapUi from './setupMapUi.js';
 import { getVcmConfigJs } from './pluginCliHelper.js';
@@ -58,9 +62,7 @@ async function getServerOptions(hostedVcm, https) {
 
   return {
     publicDir: false,
-    plugins: [
-      createConfigJsonReloadPlugin(),
-    ],
+    plugins: [createConfigJsonReloadPlugin()],
     resolve: {
       alias,
     },
@@ -77,7 +79,7 @@ async function getServerOptions(hostedVcm, https) {
  * @returns {Promise<void>}
  */
 export default async function preview(options) {
-  const { default: vcmConfigJs } = await getVcmConfigJs();
+  const vcmConfigJs = await getVcmConfigJs();
   const mergedOptions = { ...vcmConfigJs, ...options };
   if (!mergedOptions.vcm) {
     await printVcmapUiVersion();
@@ -90,25 +92,52 @@ export default async function preview(options) {
   await build({ development: false, watch: true });
   const app = express();
   logger.info('Starting preview server...');
-  const server = await createServer(await getServerOptions(mergedOptions.vcm, mergedOptions.https));
+  const server = await createServer(
+    await getServerOptions(mergedOptions.vcm, mergedOptions.https),
+  );
 
-  addMapConfigRoute(app, mergedOptions.vcm ? `${mergedOptions.vcm}/map.config.json` : null, mergedOptions.auth, mergedOptions.config, true);
+  addAppConfigRoute(
+    app,
+    mergedOptions.vcm ? `${mergedOptions.vcm}/app.config.json` : null,
+    mergedOptions.auth,
+    mergedOptions.config,
+    true,
+  );
   addIndexRoute(app, server, true, mergedOptions.vcm, mergedOptions.auth);
   addPluginAssets(app, 'dist');
 
   if (!mergedOptions.vcm) {
     logger.spin('compiling preview');
     if (!fs.existsSync(resolveMapUi('plugins', 'node_modules'))) {
-      logger.info('Could not detect node_modules in map ui plugins. Assuming map UI not setup');
+      logger.info(
+        'Could not detect node_modules in map ui plugins. Assuming map UI not setup',
+      );
       await setupMapUi();
     }
-    const { buildPluginsForPreview } = await import('@vcmap/ui/build/buildHelpers.js');
+    const { buildPluginsForPreview } = await import(
+      '@vcmap/ui/build/buildHelpers.js'
+    );
     await buildPluginsForPreview(getDefaultConfig(), true);
     logger.stopSpinner();
     logger.info('@vcmap/ui built for preview');
-    app.use('/assets', express.static(path.join(getContext(), 'node_modules', '@vcmap', 'ui', 'dist', 'assets')));
-    app.use('/plugins', express.static(path.join(getContext(), 'dist', 'plugins')));
-    await addConfigRoute(app, mergedOptions.auth, mergedOptions.config, true);
+    app.use(
+      '/assets',
+      express.static(
+        path.join(
+          getContext(),
+          'node_modules',
+          '@vcmap',
+          'ui',
+          'dist',
+          'assets',
+        ),
+      ),
+    );
+    app.use(
+      '/plugins',
+      express.static(path.join(getContext(), 'dist', 'plugins')),
+    );
+    await addConfigRoute(app);
   }
 
   app.use(server.middlewares);

package/src/serve.js

@@ -8,24 +8,29 @@ import { getContext } from './context.js';
 import {
   addConfigRoute,
   addIndexRoute,
-  addMapConfigRoute, addPluginAssets,
+  addAppConfigRoute,
+  addPluginAssets,
   checkReservedDirectories,
   createConfigJsonReloadPlugin,
   printVcmapUiVersion,
   resolveMapUi,
 } from './hostingHelpers.js';
-import { getPluginName } from './packageJsonHelpers.js';
+import { getPackageJson, getPluginName } from './packageJsonHelpers.js';
 import { getVcmConfigJs } from './pluginCliHelper.js';
 import { buildMapUI } from './build.js';
 
 /**
  * @typedef {HostingOptions} ServeOptions
- * @property {string} [mapConfig] - a filename or URL to a map config
+ * @property {string|Object} [appConfig] - an optional configObject resp. fileName or URL to an app config
  */
 
 async function getProxy(protocol, port) {
-  const { default: getPluginProxies } = await import('@vcmap/ui/build/getPluginProxies.js');
-  const { determineHostIpFromInterfaces } = await import('@vcmap/ui/build/determineHost.js');
+  const { default: getPluginProxies } = await import(
+    '@vcmap/ui/build/getPluginProxies.js'
+  );
+  const { determineHostIpFromInterfaces } = await import(
+    '@vcmap/ui/build/determineHost.js'
+  );
   const { getInlinePlugins } = await import('@vcmap/ui/build/buildHelpers.js');
 
   const target = `${protocol}://${determineHostIpFromInterfaces()}:${port}`;
@@ -36,16 +41,25 @@ async function getProxy(protocol, port) {
     proxy[`^/plugins/${inlinePlugin}/.*`] = {
       target,
       rewrite: (route) => {
-        const rest = route.replace(new RegExp(`^/plugins/${inlinePlugin}/`), '');
+        const rest = route.replace(
+          new RegExp(`^/plugins/${inlinePlugin}/`),
+          '',
+        );
         const file = rest || 'index.js';
-        return path.posix.join(path.relative(getContext(), mapUiPlugins), inlinePlugin, file);
+        return path.posix.join(
+          path.relative(getContext(), mapUiPlugins),
+          inlinePlugin,
+          file,
+        );
       },
     };
   });
 
   const pluginRoutes = Object.keys(proxy);
   const name = await getPluginName();
-  const hasThisPlugin = pluginRoutes.find(p => p.startsWith(`^/plugins/${name}`));
+  const hasThisPlugin = pluginRoutes.find((p) =>
+    p.startsWith(`^/plugins/${name}`),
+  );
 
   if (hasThisPlugin) {
     delete proxy[hasThisPlugin];
@@ -60,7 +74,7 @@ async function getProxy(protocol, port) {
   // Cesium engine assets are not part of Build
   proxy['/node_modules/@vcmap-cesium/engine/Build/Assets'] = {
     target,
-    rewrite: p => p.replace(/Build/, 'Source'),
+    rewrite: (p) => p.replace(/Build/, 'Source'),
   };
   return proxy;
 }
@@ -71,10 +85,12 @@ async function getProxy(protocol, port) {
  */
 export default async function serve(options) {
   if (!fs.existsSync(path.join(getContext(), 'node_modules', '@vcmap', 'ui'))) {
-    logger.error('Can only serve in dev mode, if the map ui is a dependency of the current context');
+    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 vcmConfigJs = await getVcmConfigJs();
   const mergedOptions = { ...vcmConfigJs, ...options };
   await printVcmapUiVersion();
   // In case @vcmap/ui is linked via git+ssh, dist folder is not available and must be built first
@@ -87,6 +103,7 @@ export default async function serve(options) {
 
   logger.info('Starting development server...');
   const proxy = await getProxy(mergedOptions.https ? 'https' : 'http', port);
+  const { peerDependencies } = await getPackageJson();
 
   const server = await createServer({
     root: getContext(),
@@ -95,25 +112,13 @@ export default async function serve(options) {
       alias: {
         '@cesium/engine': '@vcmap-cesium/engine',
       },
+      dedupe: Object.keys(peerDependencies),
     },
     optimizeDeps: {
-      exclude: [
-        '@vcmap/ui',
-        '@vcmap/core',
-        'ol',
-        'proj4',
-      ],
-      include: [
-        'fast-deep-equal',
-        'rbush-knn',
-        'pbf',
-        '@vcmap-cesium/engine',
-      ],
+      exclude: ['@vcmap/ui', '@vcmap/core', 'ol', 'proj4'],
+      include: ['fast-deep-equal', 'rbush-knn', 'pbf', '@vcmap-cesium/engine'],
     },
-    plugins: [
-      createVuePlugin(),
-      createConfigJsonReloadPlugin(),
-    ],
+    plugins: [createVuePlugin(), createConfigJsonReloadPlugin()],
     server: {
       middlewareMode: true,
       https: mergedOptions.https,
@@ -122,16 +127,22 @@ export default async function serve(options) {
     css: {
       preprocessorOptions: {
         sass: {
-          additionalData: "\n@import './node_modules/@vcmap/ui/src/styles/variables.scss'\n",
+          additionalData:
+            "\n@import './node_modules/@vcmap/ui/src/styles/variables.scss'\n",
         },
       },
     },
   });
 
-  addMapConfigRoute(app, mergedOptions.mapConfig, mergedOptions.auth, mergedOptions.config);
+  addAppConfigRoute(
+    app,
+    mergedOptions.appConfig,
+    mergedOptions.auth,
+    mergedOptions.config,
+  );
   addIndexRoute(app, server);
   addPluginAssets(app, 'src');
-  await addConfigRoute(app, mergedOptions.auth, mergedOptions.config);
+  await addConfigRoute(app);
 
   app.use(server.middlewares);
 

package/src/update.js

@@ -15,8 +15,11 @@ export async function updatePeerDependencies(pluginPeer, pluginPath) {
   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]}`);
+      .filter(
+        (depName) =>
+          !!mapPeer[depName] && pluginPeer[depName] !== mapPeer[depName],
+      )
+      .map((depName) => `${depName}@${mapPeer[depName]}`);
     peerDeps.push(...pluginPeerDeps);
   }
   logger.spin('Updating peer dependencies');