tileserver-gl-light 4.0.0 → 4.1.1

package/PUBLISHING.md

@@ -3,4 +3,11 @@
 - Update version in `package.json`
 - `git tag vx.x.x`
 - `git push --tags`
-- `node publish.js` (publishes packages to npm)
+- `docker buildx build --platform linux/amd64 -t maptiler/tileserver-gl:latest -t maptiler/tileserver-gl:[version] .`
+- `docker push maptiler/tileserver-gl --all-tags`
+- `npm publish --access public` or `node publish.js` 
+- `node publish.js --no-publish`
+- `cd light`
+- `docker buildx build --platform linux/amd64 -t maptiler/tileserver-gl-light:latest -t maptiler/tileserver-gl-light:[version] .`
+- `docker push maptiler/tileserver-gl-light --all-tags`
+- `npm publish --access public`

package/docs/deployment.rst

@@ -2,7 +2,7 @@
 Deployment
 ==========
 
-Typically - you should use nginx/lighttpd/apache on the frontend - and the tileserver-gl server is hidden behind it in production deployment.
+Typically, you should use nginx, lighttpd or apache on the frontend. The tileserver-gl server is hidden behind it in production deployment.
 
 Caching
 =======
@@ -17,4 +17,4 @@ Nginx can be used to add protection via https, password, referrer, IP address re
 Running behind a proxy or a load-balancer
 =========================================
 
-If you need to run TileServer GL behind a proxy, make sure the proxy sends ``X-Forwarded-*`` headers to the server (most importantly ``X-Forwarded-Host`` and ``X-Forwarded-Proto``) to ensures the URLs generated inside TileJSON etc. are using the desired domain and protocol.
+If you need to run TileServer GL behind a proxy, make sure the proxy sends ``X-Forwarded-*`` headers to the server (most importantly ``X-Forwarded-Host`` and ``X-Forwarded-Proto``) to ensure the URLs generated inside TileJSON, etc. are using the desired domain and protocol.

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "tileserver-gl-light",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "Map tile server for JSON GL styles - serving vector tiles",
   "main": "src/main.js",
   "bin": "src/main.js",
+  "type": "module",
   "repository": {
     "type": "git",
-    "url": "https://github.com/maptiler/tileserver-gl.git"
+    "url": "git+https://github.com/maptiler/tileserver-gl.git"
   },
   "license": "BSD-2-Clause",
   "engines": {
-    "node": ">= 10"
+    "node": ">= 14.15.0"
   },
   "scripts": {
     "test": "mocha test/**.js --timeout 10000",
@@ -18,17 +19,16 @@
   },
   "dependencies": {
     "@mapbox/glyph-pbf-composite": "0.0.3",
-    "@maplibre/maplibre-gl-style-spec": "17.0.1",
     "@mapbox/mbtiles": "0.12.1",
     "@mapbox/sphericalmercator": "1.2.0",
     "@mapbox/vector-tile": "1.3.1",
+    "@maplibre/maplibre-gl-style-spec": "17.0.1",
     "advanced-pool": "0.3.3",
     "chokidar": "3.5.3",
     "clone": "2.1.2",
     "color": "4.2.3",
     "commander": "9.4.0",
     "cors": "2.8.5",
-    "esm": "3.2.25",
     "express": "4.18.1",
     "handlebars": "4.7.7",
     "http-shutdown": "1.2.2",

package/public/resources/maplibre-gl-inspect.css

@@ -22,12 +22,13 @@
 
 .maplibregl-inspect_property-value {
   display: table-cell;
-
+  word-break: break-all;
 }
 
 .maplibregl-inspect_property-name {
   display: table-cell;
   padding-right: 10px;
+  word-break: break-all;
 }
 
 .maplibregl-ctrl-inspect {

package/public/templates/index.tmpl

@@ -41,7 +41,7 @@
                 {{#if serving_data}}| {{/if}}<a href="{{public_url}}styles/{{@key}}.json{{&../key_query}}">TileJSON</a>
               {{/if}}
               {{#if serving_rendered}}
-                | <a href="/styles/{{@key}}/wmts.xml{{&../key_query}}">WMTS</a>
+                | <a href="{{public_url}}styles/{{@key}}/wmts.xml{{&../key_query}}">WMTS</a>
               {{/if}}
               {{#if xyz_link}}
                 | <a href="#" onclick="return toggle_xyz('xyz_style_{{@key}}');">XYZ</a>

package/publish.js

@@ -11,13 +11,19 @@
 /* CREATE tileserver-gl-light */
 
 // SYNC THE `light` FOLDER
-require('child_process').execSync('rsync -av --exclude="light" --exclude=".git" --exclude="node_modules" --delete . light', {
+
+import child_process from 'child_process'
+child_process.execSync('rsync -av --exclude="light" --exclude=".git" --exclude="node_modules" --delete . light', {
   stdio: 'inherit'
 });
 
 // PATCH `package.json`
-var fs = require('fs');
-var packageJson = require('./package');
+import fs from 'fs';
+import path from 'path';
+import {fileURLToPath} from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageJson = JSON.parse(fs.readFileSync(__dirname + '/package.json', 'utf8'))
 
 packageJson.name += '-light';
 packageJson.description = 'Map tile server for JSON GL styles - serving vector tiles';
@@ -28,27 +34,27 @@ delete packageJson.dependencies['sharp'];
 delete packageJson.optionalDependencies;
 delete packageJson.devDependencies;
 
-packageJson.engines.node = '>= 10';
+packageJson.engines.node = '>= 14.15.0';
 
-var str = JSON.stringify(packageJson, undefined, 2);
+const str = JSON.stringify(packageJson, undefined, 2);
 fs.writeFileSync('light/package.json', str);
 fs.renameSync('light/README_light.md', 'light/README.md');
 fs.renameSync('light/Dockerfile_light', 'light/Dockerfile');
 fs.renameSync('light/docker-entrypoint_light.sh', 'light/docker-entrypoint.sh');
 
 // for Build tileserver-gl-light docker image, don't publish
-if (process.argv.length > 2 && process.argv[2] == "--no-publish") {
-  process.exit(0)
+if (process.argv.length > 2 && process.argv[2] == '--no-publish') {
+  process.exit(0);
 }
 
 /* PUBLISH */
 
 // tileserver-gl
-require('child_process').execSync('npm publish .', {
+child_process.execSync('npm publish . --access public', {
   stdio: 'inherit'
 });
 
 // tileserver-gl-light
-require('child_process').execSync('npm publish light', {
+child_process.execSync('npm publish ./light --access public', {
   stdio: 'inherit'
 });

package/src/main.js

@@ -2,22 +2,24 @@
 
 'use strict';
 
-require = require('esm')(module);
+import fs from 'node:fs';
+import path from 'path';
+import {fileURLToPath} from 'url';
+import request from 'request';
+import {server} from './server.js';
 
-const fs = require('fs');
-const path = require('path');
-const request = require('request');
+import MBTiles from '@mapbox/mbtiles';
 
-const MBTiles = require('@mapbox/mbtiles');
-
-const packageJson = require('../package');
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const packageJson = JSON.parse(fs.readFileSync(__dirname + '/../package.json', 'utf8'));
 
 const args = process.argv;
 if (args.length >= 3 && args[2][0] !== '-') {
   args.splice(2, 0, '--mbtiles');
 }
 
-const { program } = require('commander');
+import {program} from 'commander';
 program
   .description('tileserver-gl startup options')
   .usage('tileserver-gl [mbtiles] [options]')
@@ -79,7 +81,7 @@ const startServer = (configPath, config) => {
   if (publicUrl && publicUrl.lastIndexOf('/') !== publicUrl.length - 1) {
     publicUrl += '/';
   }
-  return require('./server')({
+  return server({
     configPath: configPath,
     config: config,
     bind: opts.bind,
@@ -105,7 +107,7 @@ const startWithMBTiles = (mbtilesFile) => {
     console.log(`ERROR: Not valid MBTiles file: ${mbtilesFile}`);
     process.exit(1);
   }
-  const instance = new MBTiles(mbtilesFile, (err) => {
+  const instance = new MBTiles(mbtilesFile + '?mode=ro', (err) => {
     if (err) {
       console.log('ERROR: Unable to open MBTiles.');
       console.log(`       Make sure ${path.basename(mbtilesFile)} is valid MBTiles.`);
@@ -120,38 +122,37 @@ const startWithMBTiles = (mbtilesFile) => {
       }
       const bounds = info.bounds;
 
-      const styleDir = path.resolve(__dirname, "../node_modules/tileserver-gl-styles/");
+      const styleDir = path.resolve(__dirname, '../node_modules/tileserver-gl-styles/');
 
       const config = {
-        "options": {
-          "paths": {
-            "root": styleDir,
-            "fonts": "fonts",
-            "styles": "styles",
-            "mbtiles": path.dirname(mbtilesFile)
+        'options': {
+          'paths': {
+            'root': styleDir,
+            'fonts': 'fonts',
+            'styles': 'styles',
+            'mbtiles': path.dirname(mbtilesFile)
           }
         },
-        "styles": {},
-        "data": {}
+        'styles': {},
+        'data': {}
       };
 
       if (info.format === 'pbf' &&
         info.name.toLowerCase().indexOf('openmaptiles') > -1) {
-
         config['data'][`v3`] = {
-          "mbtiles": path.basename(mbtilesFile)
+          'mbtiles': path.basename(mbtilesFile)
         };
 
 
         const styles = fs.readdirSync(path.resolve(styleDir, 'styles'));
-        for (let styleName of styles) {
+        for (const styleName of styles) {
           const styleFileRel = styleName + '/style.json';
           const styleFile = path.resolve(styleDir, 'styles', styleFileRel);
           if (fs.existsSync(styleFile)) {
             config['styles'][styleName] = {
-              "style": styleFileRel,
-              "tilejson": {
-                "bounds": bounds
+              'style': styleFileRel,
+              'tilejson': {
+                'bounds': bounds
               }
             };
           }
@@ -159,10 +160,10 @@ const startWithMBTiles = (mbtilesFile) => {
       } else {
         console.log(`WARN: MBTiles not in "openmaptiles" format. Serving raw data only...`);
         config['data'][(info.id || 'mbtiles')
-                           .replace(/\//g, '_')
-                           .replace(/:/g, '_')
-                           .replace(/\?/g, '_')] = {
-          "mbtiles": path.basename(mbtilesFile)
+            .replace(/\//g, '_')
+            .replace(/:/g, '_')
+            .replace(/\?/g, '_')] = {
+          'mbtiles': path.basename(mbtilesFile)
         };
       }
 
@@ -183,7 +184,7 @@ fs.stat(path.resolve(opts.config), (err, stats) => {
     if (!mbtiles) {
       // try to find in the cwd
       const files = fs.readdirSync(process.cwd());
-      for (let filename of files) {
+      for (const filename of files) {
         if (filename.endsWith('.mbtiles')) {
           const mbTilesStats = fs.statSync(filename);
           if (mbTilesStats.isFile() && mbTilesStats.size > 0) {

package/src/serve_data.js

@@ -1,18 +1,18 @@
 'use strict';
 
-const fs = require('fs');
-const path = require('path');
-const zlib = require('zlib');
+import fs from 'node:fs';
+import path from 'path';
+import zlib from 'zlib';
 
-const clone = require('clone');
-const express = require('express');
-const MBTiles = require('@mapbox/mbtiles');
-const Pbf = require('pbf');
-const VectorTile = require('@mapbox/vector-tile').VectorTile;
+import clone from 'clone';
+import express from 'express';
+import MBTiles from '@mapbox/mbtiles';
+import Pbf from 'pbf';
+import VectorTile from '@mapbox/vector-tile';
 
-const utils = require('./utils');
+import {getTileUrls, fixTileJSONCenter} from './utils.js';
 
-module.exports = {
+export const serve_data = {
   init: (options, repo) => {
     const app = express().disable('x-powered-by');
 
@@ -21,7 +21,7 @@ module.exports = {
       if (!item) {
         return res.sendStatus(404);
       }
-      let tileJSONFormat = item.tileJSON.format;
+      const tileJSONFormat = item.tileJSON.format;
       const z = req.params.z | 0;
       const x = req.params.x | 0;
       const y = req.params.y | 0;
@@ -52,7 +52,7 @@ module.exports = {
           } else {
             if (tileJSONFormat === 'pbf') {
               isGzipped = data.slice(0, 2).indexOf(
-                Buffer.from([0x1f, 0x8b])) === 0;
+                  Buffer.from([0x1f, 0x8b])) === 0;
               if (options.dataDecoratorFunc) {
                 if (isGzipped) {
                   data = zlib.unzipSync(data);
@@ -73,10 +73,10 @@ module.exports = {
 
               const tile = new VectorTile(new Pbf(data));
               const geojson = {
-                "type": "FeatureCollection",
-                "features": []
+                'type': 'FeatureCollection',
+                'features': []
               };
-              for (let layerName in tile.layers) {
+              for (const layerName in tile.layers) {
                 const layer = tile.layers[layerName];
                 for (let i = 0; i < layer.length; i++) {
                   const feature = layer.feature(i);
@@ -108,10 +108,10 @@ module.exports = {
         return res.sendStatus(404);
       }
       const info = clone(item.tileJSON);
-      info.tiles = utils.getTileUrls(req, info.tiles,
-                                     `data/${req.params.id}`, info.format, item.publicUrl, {
-                                       'pbf': options.pbfAlias
-                                     });
+      info.tiles = getTileUrls(req, info.tiles,
+          `data/${req.params.id}`, info.format, item.publicUrl, {
+            'pbf': options.pbfAlias
+          });
       return res.send(info);
     });
 
@@ -129,7 +129,7 @@ module.exports = {
     }
     let source;
     const sourceInfoPromise = new Promise((resolve, reject) => {
-      source = new MBTiles(mbtilesFile, err => {
+      source = new MBTiles(mbtilesFile + '?mode=ro', err => {
         if (err) {
           reject(err);
           return;
@@ -150,7 +150,7 @@ module.exports = {
           delete tileJSON['scheme'];
 
           Object.assign(tileJSON, params.tilejson || {});
-          utils.fixTileJSONCenter(tileJSON);
+          fixTileJSONCenter(tileJSON);
 
           if (options.dataDecoratorFunc) {
             tileJSON = options.dataDecoratorFunc(id, 'tilejson', tileJSON);
@@ -165,7 +165,7 @@ module.exports = {
         tileJSON,
         publicUrl,
         source
-      }
+      };
     });
   }
 };

package/src/serve_font.js

@@ -1,12 +1,12 @@
 'use strict';
 
-const express = require('express');
-const fs = require('fs');
-const path = require('path');
+import express from 'express';
+import fs from 'node:fs';
+import path from 'path';
 
-const utils = require('./utils');
+import {getFontsPbf} from './utils.js';
 
-module.exports = (options, allowedFonts) => {
+export const serve_font = (options, allowedFonts) => {
   const app = express().disable('x-powered-by');
 
   const lastModified = new Date().toUTCString();
@@ -40,19 +40,19 @@ module.exports = (options, allowedFonts) => {
     const fontstack = decodeURI(req.params.fontstack);
     const range = req.params.range;
 
-    utils.getFontsPbf(options.serveAllFonts ? null : allowedFonts,
-      fontPath, fontstack, range, existingFonts).then(concated => {
-        res.header('Content-type', 'application/x-protobuf');
-        res.header('Last-Modified', lastModified);
-        return res.send(concated);
-      }, err => res.status(400).send(err)
+    getFontsPbf(options.serveAllFonts ? null : allowedFonts,
+        fontPath, fontstack, range, existingFonts).then((concated) => {
+      res.header('Content-type', 'application/x-protobuf');
+      res.header('Last-Modified', lastModified);
+      return res.send(concated);
+    }, (err) => res.status(400).send(err)
     );
   });
 
   app.get('/fonts.json', (req, res, next) => {
     res.header('Content-type', 'application/json');
     return res.send(
-      Object.keys(options.serveAllFonts ? existingFonts : allowedFonts).sort()
+        Object.keys(options.serveAllFonts ? existingFonts : allowedFonts).sort()
     );
   });
 

package/src/serve_light.js

@@ -0,0 +1,10 @@
+'use strict';
+
+export const serve_rendered = {
+  init: (options, repo) => {
+  },
+  add: (options, repo, params, id, publicUrl, dataResolver) => {
+  },
+  remove: (repo, id) => {
+  }
+};