tileserver-gl 5.2.1 → 5.3.0-pre.0

package/public/templates/data.tmpl

@@ -126,6 +126,9 @@
       style: style
     });
 
+    //disabled at the moment; clarify/disable coordinates off the globe to re-enable
+    //map.addControl(new maplibregl.GlobeControl());
+
     map.addControl(new maplibregl.NavigationControl({
       visualizePitch: true,
       showZoom: true,

package/public/templates/viewer.tmpl

@@ -58,18 +58,39 @@
     var keyParam = keyMatch ? '?key=' + keyMatch[1] : '';    
 
     if (preference == 'vector') {
-      maplibregl.setRTLTextPlugin('{{public_url}}mapbox-gl-rtl-text.js' + keyParam);
+      maplibregl.setRTLTextPlugin('{{public_url}}mapbox-gl-rtl-text.js' + keyParam, true);
       var map = new maplibregl.Map({
         container: 'map',
         style: '{{public_url}}styles/{{id}}/style.json' + keyParam,
         hash: true,
         maxPitch: 85
       });
+      map.addControl(new maplibregl.GlobeControl());
       map.addControl(new maplibregl.NavigationControl({
          visualizePitch: true,
          showZoom: true,
          showCompass: true
       }));
+
+      //check if terrain is available, before enabling the control
+      map.on('style.load', function () {
+        var terrainId = null;
+        Object.entries(map.getStyle().sources).some(function (source) {
+          if (source[1].type == "raster-dem") {
+            terrainId = source[0];
+            return true;
+          }
+        });
+
+        if (terrainId) {
+          map.addControl(
+            new maplibregl.TerrainControl({
+              source: terrainId,
+            })
+          );
+        }
+      });
+
       map.addControl(new MaplibreInspect({
          showMapPopupOnHover: false,
          showInspectMapPopupOnHover: false,

package/src/render.js

@@ -1,8 +1,7 @@
 'use strict';
 
 import { createCanvas, Image } from 'canvas';
-
-import SphericalMercator from '@mapbox/sphericalmercator';
+import { SphericalMercator } from '@mapbox/sphericalmercator';
 
 const mercator = new SphericalMercator();
 

package/src/serve_data.js

@@ -7,7 +7,7 @@ import clone from 'clone';
 import express from 'express';
 import Pbf from 'pbf';
 import { VectorTile } from '@mapbox/vector-tile';
-import SphericalMercator from '@mapbox/sphericalmercator';
+import { SphericalMercator } from '@mapbox/sphericalmercator';
 
 import {
   fixTileJSONCenter,

package/src/serve_rendered.js

@@ -20,7 +20,7 @@ import clone from 'clone';
 import Color from 'color';
 import express from 'express';
 import sanitize from 'sanitize-filename';
-import SphericalMercator from '@mapbox/sphericalmercator';
+import { SphericalMercator } from '@mapbox/sphericalmercator';
 import mlgl from '@maplibre/maplibre-gl-native';
 import polyline from '@mapbox/polyline';
 import proj4 from 'proj4';

package/src/server.js

@@ -10,7 +10,7 @@ import cors from 'cors';
 import enableShutdown from 'http-shutdown';
 import express from 'express';
 import handlebars from 'handlebars';
-import SphericalMercator from '@mapbox/sphericalmercator';
+import { SphericalMercator } from '@mapbox/sphericalmercator';
 const mercator = new SphericalMercator();
 import morgan from 'morgan';
 import { serve_data } from './serve_data.js';

package/.dockerignore

@@ -1,8 +0,0 @@
-*
-!src
-!public
-!test
-!package.json
-!package-lock.json
-!docker-entrypoint.sh
-**.gitignore

package/.eslintignore

@@ -1 +0,0 @@
-public

package/.eslintrc.cjs

@@ -1,36 +0,0 @@
-module.exports = {
-  root: true,
-  env: {
-    browser: true,
-    node: true,
-    es6: true,
-  },
-  parserOptions: {
-    parser: '@typescript-eslint/parser',
-    ecmaVersion: 2020,
-    sourceType: 'module',
-    lib: ['es2020'],
-    ecmaFeatures: {
-      jsx: true,
-      tsx: true,
-    },
-  },
-  plugins: ['prettier', 'jsdoc', 'security'],
-  extends: [
-    'prettier',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:prettier/recommended',
-    'plugin:jsdoc/recommended',
-    'plugin:security/recommended',
-  ],
-  // add your custom rules here
-  rules: {
-    'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
-    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
-    '@typescript-eslint/no-unused-vars': [
-      'warn',
-      { argsIgnorePattern: 'next|err|info|reject' },
-    ],
-  },
-};

package/.gitattributes

@@ -1,11 +0,0 @@
-###############################################################################
-# Set default behavior to automatically normalize line endings.
-###############################################################################
-* text=auto
-
-###############################################################################
-# behavior for Unix scripts
-#
-# Unix scripts are treated as binary by default.
-###############################################################################
-*.sh   eol=lf

package/.github/dependabot.yml

@@ -1,19 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: npm
-    versioning-strategy: increase
-    directory: '/'
-    schedule:
-      interval: daily
-    commit-message:
-      prefix: fix
-      prefix-development: chore
-      include: scope
-  - package-ecosystem: github-actions
-    directory: '/'
-    schedule:
-      interval: weekly
-    commit-message:
-      prefix: fix
-      prefix-development: chore
-      include: scope

package/.github/workflows/automerger.yml

@@ -1,17 +0,0 @@
-name: 'Auto Merge PRs'
-
-on:
-  workflow_call:
-
-permissions:
-  pull-requests: write
-  contents: write
-
-jobs:
-  automerge:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: fastify/github-action-merge-dependabot@v3
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          target: minor

package/.github/workflows/ci.yml

@@ -1,56 +0,0 @@
-name: 'Continuous Integration'
-
-on:
-  workflow_call:
-
-permissions:
-  checks: write
-  contents: read
-
-jobs:
-  ci:
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Check out repository ✨ (non-dependabot)
-        if: ${{ github.actor != 'dependabot[bot]' }}
-        uses: actions/checkout@v4
-
-      - name: Check out repository 🎉 (dependabot)
-        if: ${{ github.actor == 'dependabot[bot]' }}
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - name: Install dependencies (Ubuntu) 🚀
-        run: >-
-          sudo apt-get install -qq libcairo2-dev libjpeg8-dev libpango1.0-dev
-          libgif-dev build-essential
-
-      - name: Setup node env 📦
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: 'package.json'
-          check-latest: true
-          cache: 'npm'
-
-      - name: Install dependencies 🚀
-        run: npm ci --prefer-offline --no-audit --omit=optional
-
-      - name: Run linter(s) 💅
-        uses: wearerequired/lint-action@v2
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          continue_on_error: false
-          git_name: github-actions[bot]
-          git_email: github-actions[bot]@users.noreply.github.com
-          auto_fix: false
-          eslint: true
-          eslint_extensions: js,cjs,mjs,ts
-          prettier: true
-          prettier_extensions: js,cjs,ts,json
-
-      - name: Run hadolint 🐳
-        uses: hadolint/hadolint-action@v3.1.0
-        with:
-          dockerfile: Dockerfile
-          ignore: DL3008,DL3015

package/.github/workflows/codeql.yml

@@ -1,37 +0,0 @@
-name: 'CodeQL'
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-  schedule:
-    - cron: '45 23 * * 2'
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [javascript]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
-        with:
-          languages: ${{ matrix.language }}
-          queries: +security-and-quality
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
-        with:
-          category: '/language:${{ matrix.language }}'

package/.github/workflows/ct.yml

@@ -1,86 +0,0 @@
-name: 'Continuous Testing'
-
-on:
-  workflow_call:
-
-permissions:
-  checks: write
-  contents: read
-
-jobs:
-  ct:
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Check out repository ✨ (non-dependabot)
-        if: ${{ github.actor != 'dependabot[bot]' }}
-        uses: actions/checkout@v4
-
-      - name: Check out repository 🎉 (dependabot)
-        if: ${{ github.actor == 'dependabot[bot]' }}
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - name: Update apt-get 🚀
-        run: sudo apt-get update -qq
-
-      - name: Install dependencies (Ubuntu) 🚀
-        run: >-
-          sudo apt-get install -qq libcairo2-dev libjpeg8-dev libpango1.0-dev
-          libgif-dev build-essential g++ xvfb libgles2-mesa-dev libgbm-dev
-          libxxf86vm-dev
-
-      - name: Setup node env 📦
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: 'package.json'
-          check-latest: true
-          cache: 'npm'
-
-      - name: Install dependencies 🚀
-        run: npm ci --prefer-offline --no-audit
-
-      - name: Pull test data 📦
-        run: >-
-          wget -O test_data.zip
-          https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/test_data.zip
-
-      - name: Prepare test data 📦
-        run: unzip -q test_data.zip -d test_data
-
-      - name: Run tests 🧪
-        run: xvfb-run --server-args="-screen 0 1024x768x24" npm test
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-        with:
-          platforms: 'arm64'
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Test Docker Build
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          push: false
-          platforms: linux/arm64,linux/amd64
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-
-      - name: Create Tileserver Light Directory
-        run: node publish.js --no-publish
-
-      - name: Install node dependencies
-        run: npm ci --prefer-offline --no-audit
-        working-directory: ./light
-
-      - name: Test Light Version to Docker Hub
-        uses: docker/build-push-action@v6
-        with:
-          context: ./light
-          file: ./light/Dockerfile
-          push: false
-          platforms: linux/arm64,linux/amd64
-          cache-from: type=gha
-          cache-to: type=gha,mode=max

package/.github/workflows/pipeline.yml

@@ -1,43 +0,0 @@
-name: 'The Pipeline'
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-
-concurrency:
-  group: ci-${{ github.ref }}-1
-  cancel-in-progress: true
-
-jobs:
-  extract-branch:
-    name: 'Fetch branch'
-    runs-on: ubuntu-latest
-    outputs:
-      current_branch: ${{ steps.get-branch.outputs.current_branch }}
-    steps:
-      - name: Extract branch name 🕊
-        id: get-branch
-        run: echo "current_branch=${GITHUB_REF##*/}" >> $GITHUB_OUTPUT
-  ci:
-    name: 'CI'
-    needs:
-      - extract-branch
-    uses: ./.github/workflows/ci.yml
-  ct:
-    name: 'CT'
-    needs:
-      - extract-branch
-    uses: ./.github/workflows/ct.yml
-  automerger:
-    name: 'Automerge Dependabot PRs'
-    needs:
-      - ci
-      - ct
-      - extract-branch
-    if: >
-      github.event_name == 'pull_request' && github.event.pull_request.user.login == 'dependabot[bot]'
-    uses: ./.github/workflows/automerger.yml

package/.github/workflows/release.yml

@@ -1,175 +0,0 @@
-name: 'Build, Test, Release'
-
-on:
-  workflow_dispatch:
-    inputs:
-      docker_user:
-        description: 'Docker Username'
-        required: true
-      docker_token:
-        description: 'Docker Token'
-        required: true
-      npm_token:
-        description: 'NPM Token'
-        required: true
-
-jobs:
-  release-check:
-    name: Check if version is published
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: 'package.json'
-          check-latest: true
-          cache: 'npm'
-
-      - name: Check if version is published
-        id: check
-        run: |
-          currentVersion="$( node -e "console.log(require('./package.json').version)" )"
-          isPublished="$( npm view tileserver-gl versions --json | jq -c --arg cv "$currentVersion" 'any(. == $cv)' )"
-          echo "version=$currentVersion" >> "$GITHUB_OUTPUT"
-          echo "published=$isPublished" >> "$GITHUB_OUTPUT"
-          echo "currentVersion: $currentVersion"
-          echo "isPublished: $isPublished"
-    outputs:
-      published: ${{ steps.check.outputs.published }}
-      version: ${{ steps.check.outputs.version }}
-
-  release:
-    needs: release-check
-    if: ${{ needs.release-check.outputs.published == 'false' }}
-    name: 'Build, Test, Publish'
-    runs-on: ubuntu-22.04
-    env:
-      PACKAGE_VERSION: ${{ needs.release-check.outputs.version }}
-    steps:
-      - name: Check out repository ✨
-        uses: actions/checkout@v4
-
-      - name: Update apt-get 🚀
-        run: sudo apt-get update -qq
-
-      - name: Install dependencies (Ubuntu) 🚀
-        run: >-
-          sudo apt-get install -qq libcairo2-dev libjpeg8-dev libpango1.0-dev
-          libgif-dev build-essential g++ xvfb libgles2-mesa-dev libgbm-dev
-          libxxf86vm-dev
-
-      - name: Setup node env 📦
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: 'package.json'
-          check-latest: true
-          cache: 'npm'
-
-      - name: Install dependencies 🚀
-        run: npm ci --prefer-offline --no-audit
-
-      - name: Pull test data 📦
-        run: >-
-          wget -O test_data.zip
-          https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/test_data.zip
-
-      - name: Prepare test data 📦
-        run: unzip -q test_data.zip -d test_data
-
-      - name: Run tests 🧪
-        run: xvfb-run --server-args="-screen 0 1024x768x24" npm test
-
-      - name: Remove Test Data
-        run: rm -R test_data*
-
-      - name: Get release type
-        id: prepare_release
-        run: |
-          RELEASE_TYPE="$(node -e "console.log(require('semver').prerelease('${{ needs.release-check.outputs.version }}') ? 'prerelease' : 'regular')")"
-          if [[ $RELEASE_TYPE == 'regular' ]]; then
-            echo "prerelease=false" >> "$GITHUB_OUTPUT"
-          else
-            echo "prerelease=true" >> "$GITHUB_OUTPUT"
-          fi
-
-      - name: Publish to NPM
-        run: |
-          npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
-          npm publish --access public --tag ${{ steps.prepare_release.outputs.prerelease == 'true' && 'next' || 'latest' }}
-        env:
-          NPM_TOKEN: ${{ github.event.inputs.npm_token }}
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-        with:
-          platforms: 'arm64'
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Login to DockerHub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ github.event.inputs.docker_user }}
-          password: ${{ github.event.inputs.docker_token }}
-
-      - name: Build and publish Full Version to Docker Hub
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          push: true
-          tags: |
-            maptiler/tileserver-gl:${{ steps.prepare_release.outputs.prerelease == 'true' && 'next' || 'latest' }},
-            maptiler/tileserver-gl:v${{ env.PACKAGE_VERSION }}
-          platforms: linux/arm64,linux/amd64
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-
-      - name: Extract changelog for version
-        run: |
-          awk '/^##/ { p = 0 }; p == 1 { print }; $0 == "## ${{ env.PACKAGE_VERSION }}" { p = 1 };' CHANGELOG.md > changelog_for_version.md
-          cat changelog_for_version.md
-
-      - name: Publish to Github
-        uses: ncipollo/release-action@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag: v${{ env.PACKAGE_VERSION }}
-          name: v${{ env.PACKAGE_VERSION }}
-          bodyFile: changelog_for_version.md
-          allowUpdates: true
-          draft: false
-          prerelease: ${{ steps.prepare_release.outputs.prerelease }}
-
-      - name: Create Tileserver Light Directory
-        run: node publish.js --no-publish
-
-      - name: Install node dependencies
-        run: npm ci --prefer-offline --no-audit
-        working-directory: ./light
-
-      - name: Publish to Light Version NPM
-        working-directory: ./light
-        run: |
-          npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
-          npm publish --access public --tag ${{ steps.prepare_release.outputs.prerelease == 'true' && 'next' || 'latest' }}
-        env:
-          NPM_TOKEN: ${{ github.event.inputs.npm_token }}
-
-      - name: Build and publish Light Version to Docker Hub
-        uses: docker/build-push-action@v6
-        with:
-          context: ./light
-          file: ./light/Dockerfile
-          push: true
-          tags: |
-            maptiler/tileserver-gl-light:${{ steps.prepare_release.outputs.prerelease == 'true' && 'next' || 'latest' }},
-            maptiler/tileserver-gl-light:v${{ env.PACKAGE_VERSION }}
-          platforms: linux/arm64,linux/amd64
-          cache-from: type=gha
-          cache-to: type=gha,mode=max

package/.hadolint.yml

@@ -1,3 +0,0 @@
-ignored:
-  - DL3008
-  - DL3015

package/.nvmrc

@@ -1 +0,0 @@
-18

package/.prettierignore

@@ -1 +0,0 @@
-public

package/.readthedocs.yaml

@@ -1,18 +0,0 @@
-# Read the Docs configuration file for Sphinx projects
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the version of Python and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
-
-# Build documentation in the doc/help/ directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-
-formats:
-    - pdf