@unvt/charites 2.1.4 → 2.1.9

package/.dockerignore

@@ -0,0 +1,92 @@
+.envrc
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+src/referers.json
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+test-results/
+
+
+.github/
+.devcontainer/
+docs/
+test/
+.gitignore
+.mocharc.json
+.prettierrc.cjs
+eslint.config.mjs
+mocha-register.cjs
+playwright.config.ts
+README.md
+.all-contributorsrc

package/.github/workflows/build.yml

@@ -12,6 +12,10 @@ on:
     branches:
       - main
 
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
 jobs:
   build:
     strategy:
@@ -60,16 +64,15 @@ jobs:
     needs: build
     if: startsWith(github.ref, 'refs/tags/v')
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           tag_name: 'v%s'
           node-version: '22.x'
           registry-url: 'https://registry.npmjs.org'
           scope: '@unvt'
+      - run: npm install -g npm@latest
       - run: npm install
       - run: npm run build
       - run: npm publish --access=public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/Dockerfile

@@ -0,0 +1,9 @@
+FROM node:24-slim
+
+WORKDIR /app
+COPY package*.json .
+RUN npm install
+COPY . .
+RUN npm run build
+RUN chmod +x /app/docker-entrypoint.sh
+ENTRYPOINT [ "/app/docker-entrypoint.sh" ]

package/README.md

@@ -33,6 +33,25 @@ MIT
 
 - Node.js v20 or later
 
+## Docker
+
+Build the Docker image:
+
+```bash
+docker build -t charites:latest .
+```
+
+Run charites commands in Docker:
+
+```bash
+docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) charites:latest init /data/my-style.yml
+docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) charites:latest convert /data/style.json /data/style.yml
+docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) charites:latest build /data/style.yml /data/style.json
+docker run --init -it --rm -p 8080:8080 -v $(pwd):/data charites:latest serve /data/style.yml
+```
+
+Note: `charites serve` requires running as root user because it needs to rebuild vite server inside the container.
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

package/dist/cli/serve.js

@@ -35,6 +35,7 @@ async function startProviderDevServer(options) {
     const config = {
         root: path.resolve(__dirname, '../../provider'),
         server: {
+            host: '0.0.0.0',
             port: parseInt(options.vitePort ?? '5137'),
         },
     };

package/dist/commands/serve.js

@@ -67,7 +67,28 @@ export async function serve(source, options) {
                 try {
                     style = parser(sourcePath);
                     if (typeof spriteOut !== 'undefined') {
-                        style.sprite = `http://${req.headers.host || `localhost:${port}`}/sprite`;
+                        const spriteUrl = `http://${req.headers.host || `localhost:${port}`}/sprite`;
+                        if (typeof style.sprite === 'string') {
+                            // update a single sprite URL
+                            style.sprite = spriteUrl;
+                        }
+                        else if (Array.isArray(style.sprite)) {
+                            // if sprite is an array, update default sprite URL.
+                            // if default sprite is not found, add default url.
+                            if (style.sprite.find((s) => s.id === 'default')) {
+                                for (const s of style.sprite) {
+                                    if (s.id === 'default') {
+                                        s.url = spriteUrl;
+                                    }
+                                }
+                            }
+                            else {
+                                style.sprite.push({
+                                    id: 'default',
+                                    url: spriteUrl,
+                                });
+                            }
+                        }
                     }
                     validateStyle(style);
                 }
@@ -148,7 +169,7 @@ export async function serve(source, options) {
             sockets.delete(ws);
         });
     });
-    process.on('SIGINT', () => {
+    const cleanUpAndExit = () => {
         console.log('Cleaning up...');
         server.close();
         watcher.close();
@@ -157,6 +178,8 @@ export async function serve(source, options) {
             spriteOut = undefined;
         }
         process.exit(0);
-    });
+    };
+    process.on('SIGINT', cleanUpAndExit);
+    process.on('SIGTERM', cleanUpAndExit);
     return server;
 }

package/docker-entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+set -e
+
+# Run the application
+exec npm run command -- "$@"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unvt/charites",
-  "version": "2.1.4",
+  "version": "2.1.9",
   "description": "",
   "bin": {
     "charites": "dist/cli.js"
@@ -17,53 +17,56 @@
   "workspaces": [
     "provider"
   ],
+  "repository": {
+    "url": "https://github.com/unvt/charites"
+  },
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@maplibre/maplibre-gl-inspect": "^1.7.1",
-    "@maplibre/maplibre-gl-style-spec": "^23.3.0",
+    "@maplibre/maplibre-gl-inspect": "^1.8.1",
+    "@maplibre/maplibre-gl-style-spec": "^24.3.1",
     "@unvt/sprite-one": "^0.1.1",
     "@watergis/maplibre-gl-legend": "^2.0.5",
-    "commander": "^14.0.0",
-    "glob": "^11.0.2",
+    "commander": "^14.0.2",
+    "glob": "^13.0.0",
     "jsonminify": "^0.4.2",
-    "maplibre-gl": "^5.5.0",
+    "maplibre-gl": "^5.14.0",
     "node-watch": "^0.7.4",
-    "open": "^10.1.2",
+    "open": "^11.0.0",
     "pmtiles": "^4.3.0",
-    "vite": "^6.3.5",
-    "ws": "^8.18.2",
-    "yaml": "^2.8.0"
+    "vite": "^7.2.7",
+    "ws": "^8.18.3",
+    "yaml": "^2.8.2"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.27.0",
-    "@playwright/test": "^1.52.0",
-    "@types/chai": "^5.2.2",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.1",
+    "@playwright/test": "^1.57.0",
+    "@types/chai": "^5.2.3",
     "@types/chai-as-promised": "^8.0.2",
     "@types/fs-extra": "^11.0.4",
     "@types/geojson": "^7946.0.16",
     "@types/jsonminify": "^0.4.3",
     "@types/mapbox__point-geometry": "^0.1.4",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.15.19",
+    "@types/node": "^24.10.1",
     "@types/ws": "^8.18.1",
-    "@typescript-eslint/eslint-plugin": "^8.32.1",
-    "@typescript-eslint/parser": "^8.32.1",
-    "chai": "^5.2.0",
-    "chai-as-promised": "^8.0.1",
-    "eslint": "^9.27.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-prettier": "^5.4.0",
-    "fs-extra": "^11.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.48.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "chai": "^6.2.1",
+    "chai-as-promised": "^8.0.2",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "fs-extra": "^11.3.2",
     "kill-port-process": "^3.2.1",
-    "mocha": "^11.4.0",
+    "mocha": "^11.7.5",
     "node-abort-controller": "^3.1.1",
-    "prettier": "^3.5.3",
+    "prettier": "^3.7.4",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
-    "tsx": "^4.19.4",
-    "typescript": "^5.8.3"
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
   },
   "type": "module"
 }

package/provider/src/main.ts

@@ -5,6 +5,7 @@ import {
   NavigationControl,
   addProtocol,
   IControl,
+  GlobeControl,
 } from 'maplibre-gl'
 import 'maplibre-gl/dist/maplibre-gl.css'
 import '@maplibre/maplibre-gl-inspect/dist/maplibre-gl-inspect.css'
@@ -131,6 +132,7 @@ const init = async () => {
     }),
   )
   map.addControl(new NavigationControl(), 'top-right')
+  map.addControl(new GlobeControl(), 'top-right')
   map.addControl(
     new MaplibreLegendControl(
       {},

package/src/cli/serve.ts

@@ -39,6 +39,7 @@ async function startProviderDevServer(options: serveOptions) {
   const config: InlineConfig = {
     root: path.resolve(__dirname, '../../provider'),
     server: {
+      host: '0.0.0.0',
       port: parseInt(options.vitePort ?? '5137'),
     },
   }

package/src/commands/serve.ts

@@ -87,9 +87,29 @@ export async function serve(source: string, options: serveOptions) {
         try {
           style = parser(sourcePath)
           if (typeof spriteOut !== 'undefined') {
-            style.sprite = `http://${
+            const spriteUrl = `http://${
               req.headers.host || `localhost:${port}`
             }/sprite`
+
+            if (typeof style.sprite === 'string') {
+              // update a single sprite URL
+              style.sprite = spriteUrl
+            } else if (Array.isArray(style.sprite)) {
+              // if sprite is an array, update default sprite URL.
+              // if default sprite is not found, add default url.
+              if (style.sprite.find((s) => s.id === 'default')) {
+                for (const s of style.sprite) {
+                  if (s.id === 'default') {
+                    s.url = spriteUrl
+                  }
+                }
+              } else {
+                style.sprite.push({
+                  id: 'default',
+                  url: spriteUrl,
+                })
+              }
+            }
           }
           validateStyle(style)
         } catch (error) {
@@ -181,7 +201,7 @@ export async function serve(source: string, options: serveOptions) {
     })
   })
 
-  process.on('SIGINT', () => {
+  const cleanUpAndExit = () => {
     console.log('Cleaning up...')
     server.close()
     watcher.close()
@@ -190,7 +210,10 @@ export async function serve(source: string, options: serveOptions) {
       spriteOut = undefined
     }
     process.exit(0)
-  })
+  }
+
+  process.on('SIGINT', cleanUpAndExit)
+  process.on('SIGTERM', cleanUpAndExit)
 
   return server
 }