npm - tileserver-gl-light - Versions diffs - 4.12.0 → 4.13.0 - Mend

tileserver-gl-light 4.12.0 → 4.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/docs/config.rst +22 -5
package/package.json +8 -8
package/public/resources/index.css +21 -4
package/public/resources/maplibre-gl.js +4 -4
package/public/resources/maplibre-gl.js.map +1 -1
package/public/templates/index.tmpl +24 -2
package/src/main.js +10 -8
package/src/promises.js +14 -0
package/src/serve_data.js +10 -10
package/src/serve_rendered.js +30 -11
package/src/serve_style.js +1 -1
package/src/utils.js +3 -2

package/public/templates/index.tmpl CHANGED Viewed

@@ -13,17 +13,39 @@
       el.setSelectionRange(0, el.value.length);
       return false;
     }
+    function filter() {
+      var filter = document.getElementById('filter').value.toLowerCase();
+      var items = document.getElementsByClassName('item');
+      for (var i = 0; i < items.length; i++) {
+          var item = items[i];
+          var dataName = item.getAttribute('data-name')?.toLowerCase() ?? '';
+          var dataIdentifier = item.getAttribute('data-id')?.toLowerCase() ?? '';
+          item.hidden = !(dataName.indexOf(filter) > -1 || dataIdentifier.indexOf(filter) > -1);
+      }
+    }
   </script>
 </head>
 <body>
   <section>
     <h1 class="title {{#if is_light}}light{{/if}}"><img src="{{public_url}}images/logo.png{{&key_query}}" alt="TileServer GL" /></h1>
     <h2 class="subtitle">Vector {{#if is_light}}<s>and raster</s>{{else}}and raster{{/if}} maps with GL styles</h2>
+    <h2 class="box-header">Filter</h2>
+    <!-- filter box -->
+    <div class="box">
+      <div class="filter-item">
+        <div class="filter-details">
+          <h3>Filter styles and data by name or identifier</h3>
+          <!-- filter input , needs to call filter() when content changes...-->
+          <input id="filter" type="text" oninput="filter()" placeholder="Start typing name or identifier" />
+        </div>
+      </div>
+    </div>
     {{#if styles}}
       <h2 class="box-header">Styles</h2>
       <div class="box">
       {{#each styles}}
-        <div class="item">
+        <div class="item" data-id="{{@key}}" data-name="{{name}}">
           {{#if thumbnail}}
             <img src="{{public_url}}styles/{{@key}}/{{thumbnail}}{{&../key_query}}" alt="{{name}} preview" />
           {{else}}
@@ -70,7 +92,7 @@
       <h2 class="box-header">Data</h2>
       <div class="box">
       {{#each data}}
-        <div class="item">
+        <div class="item" data-id="{{@key}}" data-name="{{tileJSON.name}}">
           {{#if thumbnail}}
             <img src="{{public_url}}data/{{@key}}/{{thumbnail}}{{&../key_query}}" alt="{{name}} preview" />
           {{else}}

package/src/main.js CHANGED Viewed

@@ -3,6 +3,7 @@
 'use strict';
 import fs from 'node:fs';
+import fsp from 'node:fs/promises';
 import path from 'path';
 import { fileURLToPath } from 'url';
 import axios from 'axios';
@@ -23,6 +24,7 @@ if (args.length >= 3 && args[2][0] !== '-') {
 }
 import { program } from 'commander';
+import { existsP } from './promises.js';
 program
   .description('tileserver-gl startup options')
   .usage('tileserver-gl [mbtiles] [options]')
@@ -95,7 +97,7 @@ const startWithInputFile = async (inputFile) => {
     inputFile = path.resolve(process.cwd(), inputFile);
     inputFilePath = path.dirname(inputFile);
-    const inputFileStats = fs.statSync(inputFile);
+    const inputFileStats = await fsp.stat(inputFile);
     if (!inputFileStats.isFile() || inputFileStats.size === 0) {
       console.log(`ERROR: Not a valid input file: `);
       process.exit(1);
@@ -140,11 +142,11 @@ const startWithInputFile = async (inputFile) => {
         };
       }
-      const styles = fs.readdirSync(path.resolve(styleDir, 'styles'));
+      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 (fs.existsSync(styleFile)) {
+        if (await existsP(styleFile)) {
           config['styles'][styleName] = {
             style: styleFileRel,
             tilejson: {
@@ -189,7 +191,7 @@ const startWithInputFile = async (inputFile) => {
         process.exit(1);
       }
-      instance.getInfo((err, info) => {
+      instance.getInfo(async (err, info) => {
         if (err || !info) {
           console.log('ERROR: Metadata missing in the MBTiles.');
           console.log(
@@ -207,11 +209,11 @@ const startWithInputFile = async (inputFile) => {
             mbtiles: path.basename(inputFile),
           };
-          const styles = fs.readdirSync(path.resolve(styleDir, 'styles'));
+          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 (fs.existsSync(styleFile)) {
+            if (await existsP(styleFile)) {
               config['styles'][styleName] = {
                 style: styleFileRel,
                 tilejson: {
@@ -254,10 +256,10 @@ fs.stat(path.resolve(opts.config), async (err, stats) => {
       return startWithInputFile(inputFile);
     } else {
       // try to find in the cwd
-      const files = fs.readdirSync(process.cwd());
+      const files = await fsp.readdir(process.cwd());
       for (const filename of files) {
         if (filename.endsWith('.mbtiles') || filename.endsWith('.pmtiles')) {
-          const inputFilesStats = fs.statSync(filename);
+          const inputFilesStats = await fsp.stat(filename);
           if (inputFilesStats.isFile() && inputFilesStats.size > 0) {
             inputFile = filename;
             break;

package/src/promises.js ADDED Viewed

@@ -0,0 +1,14 @@
+import util from 'node:util';
+import fsp from 'node:fs/promises';
+import zlib from 'zlib';
+export const gzipP = util.promisify(zlib.gzip);
+export const gunzipP = util.promisify(zlib.gunzip);
+export const existsP = async (path) => {
+  try {
+    await fsp.access(path); // Defaults to F_OK: indicating that the file is visible to the calling process
+    return true;
+  } catch (err) {
+    return false;
+  }
+};

package/src/serve_data.js CHANGED Viewed

@@ -1,8 +1,7 @@
 'use strict';
-import fs from 'node:fs';
+import fsp from 'node:fs/promises';
 import path from 'path';
-import zlib from 'zlib';
 import clone from 'clone';
 import express from 'express';
@@ -10,12 +9,13 @@ import MBTiles from '@mapbox/mbtiles';
 import Pbf from 'pbf';
 import { VectorTile } from '@mapbox/vector-tile';
-import { getTileUrls, isValidHttpUrl, fixTileJSONCenter } from './utils.js';
+import { fixTileJSONCenter, getTileUrls, isValidHttpUrl } from './utils.js';
 import {
-  openPMtiles,
   getPMtilesInfo,
   getPMtilesTile,
+  openPMtiles,
 } from './pmtiles_adapter.js';
+import { gunzipP, gzipP } from './promises.js';
 export const serve_data = {
   init: (options, repo) => {
@@ -89,12 +89,12 @@ export const serve_data = {
             headers['Content-Encoding'] = 'gzip';
             res.set(headers);
-            data = zlib.gzipSync(data);
+            data = await gzipP(data);
             return res.status(200).send(data);
           }
         } else if (item.sourceType === 'mbtiles') {
-          item.source.getTile(z, x, y, (err, data, headers) => {
+          item.source.getTile(z, x, y, async (err, data, headers) => {
             let isGzipped;
             if (err) {
               if (/does not exist/.test(err.message)) {
@@ -114,7 +114,7 @@ export const serve_data = {
                     data.slice(0, 2).indexOf(Buffer.from([0x1f, 0x8b])) === 0;
                   if (options.dataDecoratorFunc) {
                     if (isGzipped) {
-                      data = zlib.unzipSync(data);
+                      data = await gunzipP(data);
                       isGzipped = false;
                     }
                     data = options.dataDecoratorFunc(id, 'data', data, z, x, y);
@@ -126,7 +126,7 @@ export const serve_data = {
                   headers['Content-Type'] = 'application/json';
                   if (isGzipped) {
-                    data = zlib.unzipSync(data);
+                    data = await gunzipP(data);
                     isGzipped = false;
                   }
@@ -151,7 +151,7 @@ export const serve_data = {
                 res.set(headers);
                 if (!isGzipped) {
-                  data = zlib.gzipSync(data);
+                  data = await gzipP(data);
                 }
                 return res.status(200).send(data);
@@ -212,7 +212,7 @@ export const serve_data = {
     };
     if (!isValidHttpUrl(inputFile)) {
-      const inputFileStats = fs.statSync(inputFile);
+      const inputFileStats = await fsp.stat(inputFile);
       if (!inputFileStats.isFile() || inputFileStats.size === 0) {
         throw Error(`Not valid input file: "${inputFile}"`);
       }

package/src/serve_rendered.js CHANGED Viewed

@@ -17,7 +17,6 @@ import fs from 'node:fs';
 import path from 'path';
 import url from 'url';
 import util from 'util';
-import zlib from 'zlib';
 import sharp from 'sharp';
 import clone from 'clone';
 import Color from 'color';
@@ -42,6 +41,8 @@ import {
   getPMtilesTile,
 } from './pmtiles_adapter.js';
 import { renderOverlay, renderWatermark, renderAttribution } from './render.js';
+import fsp from 'node:fs/promises';
+import { gunzipP } from './promises.js';
 const FLOAT_PATTERN = '[+-]?(?:\\d+|\\d+.?\\d+)';
 const PATH_PATTERN =
@@ -503,14 +504,32 @@ const respondImage = (
         image.composite(composites);
       }
-      const formatQuality = (options.formatQuality || {})[format];
+      // Legacy formatQuality is deprecated but still works
+      const formatQualities = options.formatQuality || {};
+      if (Object.keys(formatQualities).length !== 0) {
+        console.log(
+          'WARNING: The formatQuality option is deprecated and has been replaced with formatOptions. Please see the documentation. The values from formatQuality will be used if a quality setting is not provided via formatOptions.',
+        );
+      }
+      const formatQuality = formatQualities[format];
+      const formatOptions = (options.formatOptions || {})[format] || {};
       if (format === 'png') {
-        image.png({ adaptiveFiltering: false });
+        image.png({
+          progressive: formatOptions.progressive,
+          compressionLevel: formatOptions.compressionLevel,
+          adaptiveFiltering: formatOptions.adaptiveFiltering,
+          palette: formatOptions.palette,
+          quality: formatOptions.quality,
+          effort: formatOptions.effort,
+          colors: formatOptions.colors,
+          dither: formatOptions.dither,
+        });
       } else if (format === 'jpeg') {
-        image.jpeg({ quality: formatQuality || 80 });
+        image.jpeg({ quality: formatOptions.quality || formatQuality || 80 });
       } else if (format === 'webp') {
-        image.webp({ quality: formatQuality || 90 });
+        image.webp({ quality: formatOptions.quality || formatQuality || 90 });
       }
       image.toBuffer((err, buffer, info) => {
         if (!buffer) {
@@ -943,7 +962,7 @@ export const serve_rendered = {
                   callback(null, response);
                 }
               } else if (sourceType === 'mbtiles') {
-                source.getTile(z, x, y, (err, data, headers) => {
+                source.getTile(z, x, y, async (err, data, headers) => {
                   if (err) {
                     if (options.verbose)
                       console.log('MBTiles error, serving empty', err);
@@ -962,7 +981,7 @@ export const serve_rendered = {
                   if (format === 'pbf') {
                     try {
-                      response.data = zlib.unzipSync(data);
+                      response.data = await gunzipP(data);
                     } catch (err) {
                       console.log(
                         'Skipping incorrect header for tile mbtiles://%s/%s/%s/%s.pbf',
@@ -1039,7 +1058,7 @@ export const serve_rendered = {
     const styleFile = params.style;
     const styleJSONPath = path.resolve(options.paths.styles, styleFile);
     try {
-      styleJSON = JSON.parse(fs.readFileSync(styleJSONPath));
+      styleJSON = JSON.parse(await fsp.readFile(styleJSONPath));
     } catch (e) {
       console.log('Error parsing style file');
       return false;
@@ -1145,7 +1164,7 @@ export const serve_rendered = {
         }
         if (!isValidHttpUrl(inputFile)) {
-          const inputFileStats = fs.statSync(inputFile);
+          const inputFileStats = await fsp.stat(inputFile);
           if (!inputFileStats.isFile() || inputFileStats.size === 0) {
             throw Error(`Not valid PMTiles file: "${inputFile}"`);
           }
@@ -1187,9 +1206,9 @@ export const serve_rendered = {
           }
         } else {
           queue.push(
-            new Promise((resolve, reject) => {
+            new Promise(async (resolve, reject) => {
               inputFile = path.resolve(options.paths.mbtiles, inputFile);
-              const inputFileStats = fs.statSync(inputFile);
+              const inputFileStats = await fsp.stat(inputFile);
               if (!inputFileStats.isFile() || inputFileStats.size === 0) {
                 throw Error(`Not valid MBTiles file: "${inputFile}"`);
               }

package/src/serve_style.js CHANGED Viewed

@@ -87,7 +87,7 @@ export const serve_style = {
     let styleFileData;
     try {
-      styleFileData = fs.readFileSync(styleFile);
+      styleFileData = fs.readFileSync(styleFile); // TODO: could be made async if this function was
     } catch (e) {
       console.log('Error reading style file');
       return false;

package/src/utils.js CHANGED Viewed

@@ -2,9 +2,10 @@
 import path from 'path';
 import fsPromises from 'fs/promises';
-import fs, { existsSync } from 'node:fs';
+import fs from 'node:fs';
 import clone from 'clone';
 import { combine } from '@jsse/pbfont';
+import { existsP } from './promises.js';
 /**
  * Restrict user input to an allowed set of options.
@@ -225,7 +226,7 @@ export const listFonts = async (fontPath) => {
     const stats = await fsPromises.stat(path.join(fontPath, file));
     if (
       stats.isDirectory() &&
-      existsSync(path.join(fontPath, file, '0-255.pbf'))
+      (await existsP(path.join(fontPath, file, '0-255.pbf')))
     ) {
       existingFonts[path.basename(file)] = true;
     }