tileserver-gl-light 4.13.0 → 4.13.2

package/.dockerignore

@@ -5,3 +5,4 @@
 !package.json
 !package-lock.json
 !docker-entrypoint.sh
+**.gitignore

package/docs/config.rst

@@ -17,7 +17,8 @@ Example:
         "icons": "icons",
         "styles": "styles",
         "mbtiles": "data",
-        "pmtiles": "data"
+        "pmtiles": "data",
+        "files": "files"
       },
       "domains": [
         "localhost:8080",

package/docs/endpoints.rst

@@ -77,7 +77,7 @@ Static images
         * scales with ``scale`` parameter since image placement is relative to it's size
         * e.g. ``2,-4`` - Image will be moved 2 pixel to the right and 4 pixel in the upwards direction from the provided location
 
-    * e.g. ``5.9,45.8|marker-start.svg|scale:0.5|offset:2,-4``
+    * e.g. ``5.9,45.8|marker-icon.png|scale:0.5|offset:2,-4``
     * can be provided multiple times
 
   * ``padding`` - "percentage" padding for fitted endpoints (area-based and path autofit)
@@ -100,6 +100,18 @@ Source data
 
   * TileJSON at ``/data/{id}.json``
 
+Static files
+===========
+* Static files are served at ``/files/{filename}``
+
+  * The source folder can be configured (``options.paths.files``), default is ``public/files``
+
+  * This feature can be used to serve ``geojson`` files for styles and rendered tiles.
+
+    * Keep in mind, that each rendered tile loads the whole geojson file, if performance matters a conversion to a tiled format (e.g. with https://github.com/felt/tippecanoe)may be a better approch.
+
+    * Use ``file://{filename}`` to have matching paths for both endoints
+
 TileJSON arrays
 ===============
 Array of all TileJSONs is at ``[/{tileSize}]/index.json`` (``[/{tileSize}]/rendered.json``; ``/data.json``)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tileserver-gl-light",
-  "version": "4.13.0",
+  "version": "4.13.2",
   "description": "Map tile server for JSON GL styles - serving vector tiles",
   "main": "src/main.js",
   "bin": "src/main.js",
@@ -25,7 +25,7 @@
     "@maplibre/maplibre-gl-style-spec": "20.3.1",
     "@sindresorhus/fnv1a": "3.1.0",
     "advanced-pool": "0.3.3",
-    "axios": "^1.7.5",
+    "axios": "^1.7.6",
     "chokidar": "3.6.0",
     "clone": "2.1.2",
     "color": "4.2.3",

package/src/main.js

@@ -8,9 +8,11 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import axios from 'axios';
 import { server } from './server.js';
-import MBTiles from '@mapbox/mbtiles';
 import { isValidHttpUrl } from './utils.js';
 import { openPMtiles, getPMtilesInfo } from './pmtiles_adapter.js';
+import { program } from 'commander';
+import { existsP } from './promises.js';
+import { openMbTilesWrapper } from './mbtiles_wrapper.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -23,8 +25,6 @@ if (args.length >= 3 && args[2][0] !== '-') {
   args.splice(2, 0, '--mbtiles');
 }
 
-import { program } from 'commander';
-import { existsP } from './promises.js';
 program
   .description('tileserver-gl startup options')
   .usage('tileserver-gl [mbtiles] [options]')
@@ -184,62 +184,55 @@ const startWithInputFile = async (inputFile) => {
       );
       process.exit(1);
     }
-    const instance = new MBTiles(inputFile + '?mode=ro', (err) => {
-      if (err) {
-        console.log('ERROR: Unable to open MBTiles.');
-        console.log(`Make sure ${path.basename(inputFile)} is valid MBTiles.`);
-        process.exit(1);
-      }
-
-      instance.getInfo(async (err, info) => {
-        if (err || !info) {
-          console.log('ERROR: Metadata missing in the MBTiles.');
-          console.log(
-            `Make sure ${path.basename(inputFile)} is valid MBTiles.`,
-          );
-          process.exit(1);
-        }
-        const bounds = info.bounds;
+    let info;
+    try {
+      const mbw = await openMbTilesWrapper(inputFile);
+      info = await mbw.getInfo();
+      if (!info) throw new Error('Metadata missing in the MBTiles.');
+    } catch (err) {
+      console.log('ERROR: Unable to open MBTiles or read metadata:', err);
+      console.log(`Make sure ${path.basename(inputFile)} is valid MBTiles.`);
+      process.exit(1);
+    }
+    const bounds = info.bounds;
 
-        if (
-          info.format === 'pbf' &&
-          info.name.toLowerCase().indexOf('openmaptiles') > -1
-        ) {
-          config['data'][`v3`] = {
-            mbtiles: path.basename(inputFile),
-          };
+    if (
+      info.format === 'pbf' &&
+      info.name.toLowerCase().indexOf('openmaptiles') > -1
+    ) {
+      config['data'][`v3`] = {
+        mbtiles: path.basename(inputFile),
+      };
 
-          const styles = await fsp.readdir(path.resolve(styleDir, 'styles'));
-          for (const styleName of styles) {
-            const styleFileRel = styleName + '/style.json';
-            const styleFile = path.resolve(styleDir, 'styles', styleFileRel);
-            if (await existsP(styleFile)) {
-              config['styles'][styleName] = {
-                style: styleFileRel,
-                tilejson: {
-                  bounds,
-                },
-              };
-            }
-          }
-        } else {
-          console.log(
-            `WARN: MBTiles not in "openmaptiles" format. Serving raw data only...`,
-          );
-          config['data'][(info.id || 'mbtiles').replace(/[?/:]/g, '_')] = {
-            mbtiles: path.basename(inputFile),
+      const styles = await fsp.readdir(path.resolve(styleDir, 'styles'));
+      for (const styleName of styles) {
+        const styleFileRel = styleName + '/style.json';
+        const styleFile = path.resolve(styleDir, 'styles', styleFileRel);
+        if (await existsP(styleFile)) {
+          config['styles'][styleName] = {
+            style: styleFileRel,
+            tilejson: {
+              bounds,
+            },
           };
         }
+      }
+    } else {
+      console.log(
+        `WARN: MBTiles not in "openmaptiles" format. Serving raw data only...`,
+      );
+      config['data'][(info.id || 'mbtiles').replace(/[?/:]/g, '_')] = {
+        mbtiles: path.basename(inputFile),
+      };
+    }
 
-        if (opts.verbose) {
-          console.log(JSON.stringify(config, undefined, 2));
-        } else {
-          console.log('Run with --verbose to see the config file here.');
-        }
+    if (opts.verbose) {
+      console.log(JSON.stringify(config, undefined, 2));
+    } else {
+      console.log('Run with --verbose to see the config file here.');
+    }
 
-        return startServer(null, config);
-      });
-    });
+    return startServer(null, config);
   }
 };
 

package/src/mbtiles_wrapper.js

@@ -0,0 +1,46 @@
+import MBTiles from '@mapbox/mbtiles';
+import util from 'node:util';
+
+/**
+ * Promise-ful wrapper around the MBTiles class.
+ */
+class MBTilesWrapper {
+  constructor(mbtiles) {
+    this._mbtiles = mbtiles;
+    this._getInfoP = util.promisify(mbtiles.getInfo.bind(mbtiles));
+  }
+
+  /**
+   * Get the underlying MBTiles object.
+   * @returns {MBTiles}
+   */
+  getMbTiles() {
+    return this._mbtiles;
+  }
+
+  /**
+   * Get the MBTiles metadata object.
+   * @returns {Promise<object>}
+   */
+  getInfo() {
+    return this._getInfoP();
+  }
+}
+
+/**
+ * Open the given MBTiles file and return a promise that resolves with a
+ * MBTilesWrapper instance.
+ * @param inputFile Input file
+ * @returns {Promise<MBTilesWrapper>}
+ */
+export function openMbTilesWrapper(inputFile) {
+  return new Promise((resolve, reject) => {
+    const mbtiles = new MBTiles(inputFile + '?mode=ro', (err) => {
+      if (err) {
+        reject(err);
+        return;
+      }
+      resolve(new MBTilesWrapper(mbtiles));
+    });
+  });
+}

package/src/serve_data.js

@@ -5,7 +5,6 @@ import path from 'path';
 
 import clone from 'clone';
 import express from 'express';
-import MBTiles from '@mapbox/mbtiles';
 import Pbf from 'pbf';
 import { VectorTile } from '@mapbox/vector-tile';
 
@@ -16,6 +15,7 @@ import {
   openPMtiles,
 } from './pmtiles_adapter.js';
 import { gunzipP, gzipP } from './promises.js';
+import { openMbTilesWrapper } from './mbtiles_wrapper.js';
 
 export const serve_data = {
   init: (options, repo) => {
@@ -242,39 +242,25 @@ export const serve_data = {
       }
     } else if (inputType === 'mbtiles') {
       sourceType = 'mbtiles';
-      const sourceInfoPromise = new Promise((resolve, reject) => {
-        source = new MBTiles(inputFile + '?mode=ro', (err) => {
-          if (err) {
-            reject(err);
-            return;
-          }
-          source.getInfo((err, info) => {
-            if (err) {
-              reject(err);
-              return;
-            }
-            tileJSON['name'] = id;
-            tileJSON['format'] = 'pbf';
-
-            Object.assign(tileJSON, info);
+      const mbw = await openMbTilesWrapper(inputFile);
+      const info = await mbw.getInfo();
+      source = mbw.getMbTiles();
+      tileJSON['name'] = id;
+      tileJSON['format'] = 'pbf';
 
-            tileJSON['tilejson'] = '2.0.0';
-            delete tileJSON['filesize'];
-            delete tileJSON['mtime'];
-            delete tileJSON['scheme'];
+      Object.assign(tileJSON, info);
 
-            Object.assign(tileJSON, params.tilejson || {});
-            fixTileJSONCenter(tileJSON);
+      tileJSON['tilejson'] = '2.0.0';
+      delete tileJSON['filesize'];
+      delete tileJSON['mtime'];
+      delete tileJSON['scheme'];
 
-            if (options.dataDecoratorFunc) {
-              tileJSON = options.dataDecoratorFunc(id, 'tilejson', tileJSON);
-            }
-            resolve();
-          });
-        });
-      });
+      Object.assign(tileJSON, params.tilejson || {});
+      fixTileJSONCenter(tileJSON);
 
-      await sourceInfoPromise;
+      if (options.dataDecoratorFunc) {
+        tileJSON = options.dataDecoratorFunc(id, 'tilejson', tileJSON);
+      }
     }
 
     repo[id] = {

package/src/serve_rendered.js

@@ -24,7 +24,6 @@ import express from 'express';
 import sanitize from 'sanitize-filename';
 import SphericalMercator from '@mapbox/sphericalmercator';
 import mlgl from '@maplibre/maplibre-gl-native';
-import MBTiles from '@mapbox/mbtiles';
 import polyline from '@mapbox/polyline';
 import proj4 from 'proj4';
 import axios from 'axios';
@@ -42,7 +41,8 @@ import {
 } from './pmtiles_adapter.js';
 import { renderOverlay, renderWatermark, renderAttribution } from './render.js';
 import fsp from 'node:fs/promises';
-import { gunzipP } from './promises.js';
+import { existsP, gunzipP } from './promises.js';
+import { openMbTilesWrapper } from './mbtiles_wrapper.js';
 
 const FLOAT_PATTERN = '[+-]?(?:\\d+|\\d+.?\\d+)';
 const PATH_PATTERN =
@@ -893,13 +893,15 @@ export const serve_rendered = {
             // console.log('Handling request:', req);
             if (protocol === 'sprites') {
               const dir = options.paths[protocol];
-              const file = unescape(req.url).substring(protocol.length + 3);
+              const file = decodeURIComponent(req.url).substring(
+                protocol.length + 3,
+              );
               fs.readFile(path.join(dir, file), (err, data) => {
                 callback(err, { data: data });
               });
             } else if (protocol === 'fonts') {
               const parts = req.url.split('/');
-              const fontstack = unescape(parts[2]);
+              const fontstack = decodeURIComponent(parts[2]);
               const range = parts[3].split('.')[0];
 
               try {
@@ -1039,6 +1041,25 @@ export const serve_rendered = {
                 const format = extensionToFormat[extension] || '';
                 createEmptyResponse(format, '', callback);
               }
+            } else if (protocol === 'file') {
+              const name = decodeURI(req.url).substring(protocol.length + 3);
+              const file = path.join(options.paths['files'], name);
+              if (await existsP(file)) {
+                const inputFileStats = await fsp.stat(file);
+                if (!inputFileStats.isFile() || inputFileStats.size === 0) {
+                  throw Error(
+                    `File is not valid: "${req.url}" - resolved to "${file}"`,
+                  );
+                }
+
+                fs.readFile(file, (err, data) => {
+                  callback(err, { data: data });
+                });
+              } else {
+                throw Error(
+                  `File does not exist: "${req.url}" - resolved to "${file}"`,
+                );
+              }
             }
           },
         });
@@ -1131,7 +1152,6 @@ export const serve_rendered = {
     };
     repo[id] = repoobj;
 
-    const queue = [];
     for (const name of Object.keys(styleJSON.sources)) {
       let sourceType;
       let source = styleJSON.sources[name];
@@ -1205,69 +1225,52 @@ export const serve_rendered = {
             }
           }
         } else {
-          queue.push(
-            new Promise(async (resolve, reject) => {
-              inputFile = path.resolve(options.paths.mbtiles, inputFile);
-              const inputFileStats = await fsp.stat(inputFile);
-              if (!inputFileStats.isFile() || inputFileStats.size === 0) {
-                throw Error(`Not valid MBTiles file: "${inputFile}"`);
-              }
-              map.sources[name] = new MBTiles(inputFile + '?mode=ro', (err) => {
-                map.sources[name].getInfo((err, info) => {
-                  if (err) {
-                    console.error(err);
-                    return;
-                  }
-                  map.sourceTypes[name] = 'mbtiles';
-
-                  if (!repoobj.dataProjWGStoInternalWGS && info.proj4) {
-                    // how to do this for multiple sources with different proj4 defs?
-                    const to3857 = proj4('EPSG:3857');
-                    const toDataProj = proj4(info.proj4);
-                    repoobj.dataProjWGStoInternalWGS = (xy) =>
-                      to3857.inverse(toDataProj.forward(xy));
-                  }
+          const inputFileStats = await fsp.stat(inputFile);
+          if (!inputFileStats.isFile() || inputFileStats.size === 0) {
+            throw Error(`Not valid MBTiles file: "${inputFile}"`);
+          }
+          const mbw = await openMbTilesWrapper(inputFile);
+          const info = await mbw.getInfo();
+          map.sources[name] = mbw.getMbTiles();
+          map.sourceTypes[name] = 'mbtiles';
 
-                  const type = source.type;
-                  Object.assign(source, info);
-                  source.type = type;
-                  source.tiles = [
-                    // meta url which will be detected when requested
-                    `mbtiles://${name}/{z}/{x}/{y}.${info.format || 'pbf'}`,
-                  ];
-                  delete source.scheme;
-
-                  if (options.dataDecoratorFunc) {
-                    source = options.dataDecoratorFunc(
-                      name,
-                      'tilejson',
-                      source,
-                    );
-                  }
+          if (!repoobj.dataProjWGStoInternalWGS && info.proj4) {
+            // how to do this for multiple sources with different proj4 defs?
+            const to3857 = proj4('EPSG:3857');
+            const toDataProj = proj4(info.proj4);
+            repoobj.dataProjWGStoInternalWGS = (xy) =>
+              to3857.inverse(toDataProj.forward(xy));
+          }
 
-                  if (
-                    !attributionOverride &&
-                    source.attribution &&
-                    source.attribution.length > 0
-                  ) {
-                    if (!tileJSON.attribution.includes(source.attribution)) {
-                      if (tileJSON.attribution.length > 0) {
-                        tileJSON.attribution += ' | ';
-                      }
-                      tileJSON.attribution += source.attribution;
-                    }
-                  }
-                  resolve();
-                });
-              });
-            }),
-          );
+          const type = source.type;
+          Object.assign(source, info);
+          source.type = type;
+          source.tiles = [
+            // meta url which will be detected when requested
+            `mbtiles://${name}/{z}/{x}/{y}.${info.format || 'pbf'}`,
+          ];
+          delete source.scheme;
+
+          if (options.dataDecoratorFunc) {
+            source = options.dataDecoratorFunc(name, 'tilejson', source);
+          }
+
+          if (
+            !attributionOverride &&
+            source.attribution &&
+            source.attribution.length > 0
+          ) {
+            if (!tileJSON.attribution.includes(source.attribution)) {
+              if (tileJSON.attribution.length > 0) {
+                tileJSON.attribution += ' | ';
+              }
+              tileJSON.attribution += source.attribution;
+            }
+          }
         }
       }
     }
 
-    await Promise.all(queue);
-
     // standard and @2x tiles are much more usual -> default to larger pools
     const minPoolSizes = options.minRendererPoolSizes || [8, 4, 2];
     const maxPoolSizes = options.maxRendererPoolSizes || [16, 8, 4];

package/src/serve_style.js

@@ -26,6 +26,9 @@ export const serve_style = {
       for (const name of Object.keys(styleJSON_.sources)) {
         const source = styleJSON_.sources[name];
         source.url = fixUrl(req, source.url, item.publicUrl);
+        if (typeof source.data == 'string') {
+          source.data = fixUrl(req, source.data, item.publicUrl);
+        }
       }
       // mapbox-gl-js viewer cannot handle sprite urls with query
       if (styleJSON_.sprite) {
@@ -89,7 +92,7 @@ export const serve_style = {
     try {
       styleFileData = fs.readFileSync(styleFile); // TODO: could be made async if this function was
     } catch (e) {
-      console.log('Error reading style file');
+      console.log(`Error reading style file "${params.style}"`);
       return false;
     }
 
@@ -128,6 +131,16 @@ export const serve_style = {
         }
         source.url = `local://data/${identifier}.json`;
       }
+
+      let data = source.data;
+      if (data && typeof data == 'string' && data.startsWith('file://')) {
+        source.data =
+          'local://files' +
+          path.resolve(
+            '/',
+            data.replace('file://', '').replace(options.paths.files, ''),
+          );
+      }
     }
 
     for (const obj of styleJSON.layers) {

package/src/server.js

@@ -94,24 +94,23 @@ function start(opts) {
   paths.sprites = path.resolve(paths.root, paths.sprites || '');
   paths.mbtiles = path.resolve(paths.root, paths.mbtiles || '');
   paths.pmtiles = path.resolve(paths.root, paths.pmtiles || '');
-  paths.icons = path.resolve(paths.root, paths.icons || '');
+  paths.icons = paths.icons
+    ? path.resolve(paths.root, paths.icons)
+    : path.resolve(__dirname, '../public/resources/images');
+  paths.files = paths.files
+    ? path.resolve(paths.root, paths.files)
+    : path.resolve(__dirname, '../public/files');
 
   const startupPromises = [];
 
-  const checkPath = (type) => {
+  for (const type of Object.keys(paths)) {
     if (!fs.existsSync(paths[type])) {
       console.error(
         `The specified path for "${type}" does not exist (${paths[type]}).`,
       );
       process.exit(1);
     }
-  };
-  checkPath('styles');
-  checkPath('fonts');
-  checkPath('sprites');
-  checkPath('mbtiles');
-  checkPath('pmtiles');
-  checkPath('icons');
+  }
 
   /**
    * Recursively get all files within a directory.
@@ -161,6 +160,7 @@ function start(opts) {
   }
 
   app.use('/data/', serve_data.init(options, serving.data));
+  app.use('/files/', express.static(paths.files));
   app.use('/styles/', serve_style.init(options, serving.styles));
   if (!isLight) {
     startupPromises.push(