@vcmap/plugin-cli 2.1.16 → 2.1.18

package/README.md

@@ -173,15 +173,18 @@ export default {
 
 The following parameters are valid:
 
-| parameter | type               | description                                                                                   |
-| --------- | ------------------ | --------------------------------------------------------------------------------------------- |
-| config    | string|Object | an optional configObject or fileName to use for configuring the plugin                        |
-| auth      | string             | potential auth string to download assets (index.html, config) with                            |
-| port      | number             | optional alternative port (default 8008)                                                      |
-| https     | boolean            | whether to use http (default) or https                                                        |
-| appConfig | string|Object | an optional configObject resp. fileName or URL to an app config (for `serve` command)         |
-| vcm       | string             | a filename or URL to a map (for `preview` command)                                            |
-| proxy     | Object             | a server proxy (see [vitejs.dev](https://vitejs.dev/config/server-options.html#server-proxy)) |
+| parameter | type               | description                                                                                                               |
+| --------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------- |
+| config    | string|Object | An optional configObject or fileName to use for configuring the plugin                                                    |
+| auth      | string             | Potential auth string to download assets (index.html, config) with                                                        |
+| port      | number             | Optional alternative port (default 8008)                                                                                  |
+| appConfig | string|Object | An optional configObject resp. fileName or URL to an app config                                                           |
+| vcm       | string             | A filename or URL to a VC Map application. Only works for `preview` command! Takes precedence over `appConfig` parameter. |
+| proxy     | Object             | A server proxy (see [vitejs.dev](https://vitejs.dev/config/server-options.html#server-proxy))                             |
+
+> The `vcm` parameter uses a hosted map application to preview the plugin. The plugin is bundled and added to the application. This parameter is only working for `preview` mode.
+
+> For the `appConfig` option, map and plugin are bundled to create a preview environment. Here only the configuration is loaded from the provided url or object. This parameter is working for both `preview` and `serve` mode.
 
 ## About Peer Dependencies
 
@@ -229,6 +232,24 @@ should be rewritten to:
 import { Cartesian3 } from '@vcmap-cesium/engine';
 ```
 
+### Overwriting Peer Dependencies
+
+If you want to work with a release candidate or a specific branch of @vcmap/core or @vcmap/ui you need to define [overrides](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides) within your plugin's `package.json`.
+This will replace the package(s) in your dependency tree with the corresponding version.
+
+```json
+{
+  "peerDependencies": {
+    "@vcmap/core": "5.1.0-rc.3",
+    "@vcmap/ui": "5.1.0-rc.3"
+  },
+  "overrides": {
+    "@vcmap/core": "5.1.0-rc.3",
+    "@vcmap/ui": "5.1.0-rc.3"
+  }
+}
+```
+
 ### What about openlayers?
 
 openlayers provides a special case, since its modules do not provide a _flat_ namespace.

package/cli.js

@@ -26,7 +26,7 @@ program
   .summary('start preview server')
   .defaultOptions()
   .defaultServeOptions()
-  .option('--vcm [url]', 'URL to a virtualcityMAP application', (val) =>
+  .option('--vcm [url]', 'URL to a VC MAP application', (val) =>
     val.replace(/\/$/, ''),
   )
   .safeAction(preview);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/plugin-cli",
-  "version": "2.1.16",
+  "version": "2.1.18",
   "description": "A CLI to help develop and build plugins for the VC Map",
   "main": "index.js",
   "type": "module",

package/src/defaultCommand.js

@@ -24,8 +24,7 @@ Command.prototype.defaultServeOptions = function defaultServeOptions() {
     .option(
       '-c, --config <config>',
       'a config override to not use the default plugin config',
-    )
-    .option('--https', 'use https for serving');
+    );
 
   return this;
 };

package/src/hostingHelpers.js

@@ -13,7 +13,6 @@ import { promiseExec, getDirname } from './pluginCliHelper.js';
  * @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]
  */
 
 /**
@@ -127,7 +126,7 @@ export async function reWriteAppConfig(appConfig, pluginConfig, production) {
       config.plugins = config.plugins.filter((p) => p.name !== name);
     }
   });
-  appConfig.modules.push({ plugins: [pluginConfig] });
+  appConfig.modules.push({ _id: 'plugin-cli-module', plugins: [pluginConfig] });
 }
 
 /**
@@ -143,7 +142,8 @@ export function getAppConfigJson(appConfig, auth, production, configFile) {
     return Promise.resolve(configMap.get('app.config.json'));
   }
   const isObject = typeof appConfig === 'object' && appConfig !== null;
-  const isWebVcm = !isObject && /^https?:\/\//.test(usedConfig);
+  const isURL = (url) => /^https?:\/\//.test(url);
+  const isWebVcm = !isObject && isURL(usedConfig);
   return new Promise((resolve, reject) => {
     async function handleAppConfig(data) {
       try {
@@ -151,6 +151,15 @@ export function getAppConfigJson(appConfig, auth, production, configFile) {
         configMap.set('app.config.json', appConfigJson);
         const pluginConfig = await getPluginConfig(configFile);
         await reWriteAppConfig(appConfigJson, pluginConfig, production);
+        if (isWebVcm) {
+          // replace relative URLs by absolute ones
+          appConfigJson.modules = appConfigJson.modules.map((m) => {
+            if (typeof m === 'string' && !isURL(m)) {
+              return new URL(m, usedConfig).toString();
+            }
+            return m;
+          });
+        }
         resolve(appConfigJson);
       } catch (e) {
         reject(e);

package/src/pluginCliHelper.js

@@ -27,7 +27,7 @@ export const { version, name } = JSON.parse(
 export const promiseExec = util.promisify(childProcess.exec);
 
 /**
- * @typedef {ServeOptions} VcmConfigJs
+ * @typedef {PreviewOptions} VcmConfigJs
  * @property {Object} proxy - see https://vitejs.dev/config/server-options.html#server-proxy
  */
 

package/src/preview.js

@@ -23,8 +23,8 @@ import setupMapUi from './setupMapUi.js';
 import { getVcmConfigJs } from './pluginCliHelper.js';
 
 /**
- * @typedef {HostingOptions} PreviewOptions
- * @property {string} [vcm]
+ * @typedef {ServeOptions} PreviewOptions
+ * @property {string} [vcm] - an optional URL to a VC Map application
  */
 
 /**
@@ -38,12 +38,11 @@ function setAliases(alias, libraryPaths) {
 }
 
 /**
- * @param {string} [hostedVcm]
- * @param {boolean} [https]
+ * @param {VcmConfigJs} options
  * @returns {Promise<import("vite").InlineConfig>}
  */
-async function getServerOptions(hostedVcm, https) {
-  let proxy;
+async function getServerOptions(options) {
+  let proxy = options.proxy || {};
   const normalLibraries = await getLibraryPaths('normal');
   const scopedLibraries = await getLibraryPaths('@scoped/plugin');
   const alias = {
@@ -52,11 +51,24 @@ async function getServerOptions(hostedVcm, https) {
   setAliases(alias, normalLibraries);
   setAliases(alias, scopedLibraries);
 
-  if (hostedVcm) {
+  if (options.vcm) {
+    const proxyOptions = {
+      target: options.vcm,
+      changeOrigin: true,
+      secure: false,
+      configure(httpProxy) {
+        httpProxy.on('proxyRes', (proxyRes) => {
+          delete proxyRes.headers['Content-Security-Policy'];
+          delete proxyRes.headers['content-security-policy'];
+        });
+      },
+    };
+
     proxy = {
-      '^/style.css': hostedVcm,
-      '^/assets': hostedVcm,
-      '^/plugins': hostedVcm,
+      ...proxy,
+      '^/style.css': proxyOptions,
+      '^/assets': proxyOptions,
+      '^/plugins': proxyOptions,
     };
   }
 
@@ -69,7 +81,6 @@ async function getServerOptions(hostedVcm, https) {
     server: {
       middlewareMode: true,
       proxy,
-      https,
     },
   };
 }
@@ -87,18 +98,21 @@ export default async function preview(options) {
     if (!fs.existsSync(resolveMapUi('dist'))) {
       await buildMapUI();
     }
+  } else {
+    logger.info(`Using hosted VC Map application ${mergedOptions.vcm}`);
   }
   checkReservedDirectories();
   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 inlineConfig = await getServerOptions(mergedOptions);
+  const server = await createServer(inlineConfig);
 
   addAppConfigRoute(
     app,
-    mergedOptions.vcm ? `${mergedOptions.vcm}/app.config.json` : null,
+    mergedOptions.vcm
+      ? `${mergedOptions.vcm}/app.config.json`
+      : mergedOptions.appConfig,
     mergedOptions.auth,
     mergedOptions.config,
     true,

package/src/serve.js

@@ -1,4 +1,5 @@
 import fs from 'fs';
+import { readFile } from 'fs/promises';
 import { createServer } from 'vite';
 import vue2 from '@vitejs/plugin-vue2';
 import express from 'express';
@@ -91,6 +92,7 @@ export default async function serve(options) {
   }
   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
@@ -104,7 +106,7 @@ export default async function serve(options) {
   const port = mergedOptions.port || 8008;
 
   logger.info('Starting development server...');
-  const proxy = await getProxy(mergedOptions.https ? 'https' : 'http', port);
+  const proxy = await getProxy('http', port);
   const { peerDependencies } = await getPackageJson();
 
   const optimizationIncludes = [
@@ -119,7 +121,10 @@ export default async function serve(options) {
 
   // We exclude ui dependencies from optimization, to allow plugins to use another version of the same plugin.
   // vitejs seems to have a problem with optimized deps in different versions.
-  const { dependencies } = await getPackageJson(resolveMapUi());
+  const uiPackageJsonPath = path.join(resolveMapUi(), 'package.json');
+  const { dependencies } = JSON.parse(
+    (await readFile(uiPackageJsonPath)).toString(),
+  );
 
   const excludedOptimizations = Object.keys(dependencies).filter(
     (name) => !optimizationIncludes.includes(name),
@@ -148,7 +153,6 @@ export default async function serve(options) {
     plugins: [vue2(), createConfigJsonReloadPlugin()],
     server: {
       middlewareMode: true,
-      https: mergedOptions.https,
       proxy: { ...mergedOptions.proxy, ...proxy },
     },
     css: {