Compare commits

..

3 Commits

Author SHA1 Message Date
shelly_goldblit 1fc4e7bfd1 remove coverage from git 2023-12-25 11:07:47 +02:00
shelly_goldblit 0811c0d911 add coverage output to git ignore 2023-12-25 07:14:15 +02:00
shelly_goldblit 9f8d1fd0eb add code coverage 2023-12-25 06:44:31 +02:00
208 changed files with 13270 additions and 8128 deletions
+4
View File
@@ -0,0 +1,4 @@
{
"packages": [],
"sandboxes": ["/"]
}
-46
View File
@@ -1,46 +0,0 @@
{
"root": true,
"env": {
"browser": true,
"es2020": true
},
"extends": [
"eslint:recommended",
"plugin:react/recommended",
"plugin:react/jsx-runtime",
"plugin:react-hooks/recommended",
],
"ignorePatterns": [
"dist"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module"
},
"settings": {
"react": { "version": "16.4" }
},
"plugins": [
"@typescript-eslint",
"react-refresh"],
"rules": {
"react-refresh/only-export-components": [
"warn",
{ "allowConstantExport": true }
],
"@typescript-eslint/no-unused-vars": [
"warn",
{ "argsIgnorePattern": "^_" }
],
"no-unused-vars": "off",
"react/prop-types": ["off"],
// Disable no-undef. It's covered by @typescript-eslint
"no-undef": "off",
"indent": ["error", 2],
"no-var": ["error"]
},
"globals": {
"global": "readonly"
}
}
+20
View File
@@ -0,0 +1,20 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
'plugin:react/recommended',
'plugin:react/jsx-runtime',
'plugin:react-hooks/recommended',
],
ignorePatterns: ['dist', '.eslintrc.cjs'],
parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
settings: { react: { version: '18.2' } },
plugins: ['react-refresh'],
rules: {
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
}
+1 -2
View File
@@ -1,2 +1 @@
github: [maplibre] custom: "https://maputnik.github.io/donate"
open_collective: maplibre
-11
View File
@@ -1,11 +0,0 @@
## Launch Checklist
<!-- Thanks for the PR! Feel free to add or remove items from the checklist. -->
- [ ] Briefly describe the changes in this PR.
- [ ] Link to related issues.
- [ ] Include before/after visuals or gifs if this PR includes visual changes.
- [ ] Write tests for all new functionality.
- [ ] Add an entry to `CHANGELOG.md` under the `## main` section.
+61 -34
View File
@@ -8,18 +8,23 @@ on:
jobs: jobs:
build-docker: build-docker:
name: build docker name: build/docker
runs-on: ubuntu-latest runs-on: ${{ matrix.os }}
if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }} if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- run: docker build -t test-docker-image-build . - run: docker build -t docker.pkg.github.com/maputnik/editor/editor:main .
# build the editor # build the editor
build-node: build-node:
name: "build on ${{ matrix.os }}" name: "build/node@${{ matrix.node-version }} (${{ matrix.os }})"
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }} if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}
@@ -28,68 +33,95 @@ jobs:
fail-fast: false fail-fast: false
matrix: matrix:
os: [ubuntu-latest, windows-latest, macos-latest] os: [ubuntu-latest, windows-latest, macos-latest]
node-version: [18.x]
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions/setup-node@v4 - uses: actions/setup-node@v1
with: with:
node-version-file: '.nvmrc' node-version: ${{ matrix.node-version }}
- uses: actions/cache@v1
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- run: npm ci - run: npm ci
- run: npm run build - run: npm run build
- run: npm run lint
- run: npm run lint-css
build-artifacts: build-artifacts:
name: "build artifacts" name: "build/artifacts (${{ matrix.os }})"
runs-on: ubuntu-latest runs-on: ${{ matrix.os }}
if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }} if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
node-version: [18.x]
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions/setup-node@v4 - uses: actions/setup-node@v1
with: with:
node-version-file: '.nvmrc' node-version: ${{ matrix.node-version }}
- uses: actions/cache@v1
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- run: npm ci - run: npm ci
- run: npm run build - run: npm run build
- name: artifacts/maputnik - run: npm run build-storybook
uses: actions/upload-artifact@v4 - name: artifacts/editor
uses: actions/upload-artifact@v1
with: with:
name: maputnik name: editor
path: dist path: dist
- name: artifacts/storybook
uses: actions/upload-artifact@v1
with:
name: storybook
path: build/storybook
# Build and upload desktop CLI artifacts # Build and upload desktop CLI artifacts
- name: Set up Go - name: Set up Go
uses: actions/setup-go@v5 uses: actions/setup-go@v3
with: with:
go-version: ^1.23.x go-version: ^1.19.x
cache-dependency-path: desktop/go.sum
id: go id: go
- name: Build desktop artifacts - name: Check out code into the Go module directory
run: npm run build-desktop uses: actions/checkout@v4
with:
repository: maputnik/desktop
ref: master
path: ./src/github.com/maputnik/desktop/
- name: Make
run: cd src/github.com/maputnik/desktop/ && make
- name: Artifacts/linux - name: Artifacts/linux
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v1
with: with:
name: maputnik-linux name: maputnik-linux
path: ./desktop/bin/linux/ path: ./src/github.com/maputnik/desktop/bin/linux/
- name: Artifacts/darwin - name: Artifacts/darwin
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v1
with: with:
name: maputnik-darwin name: maputnik-darwin
path: ./desktop/bin/darwin/ path: ./src/github.com/maputnik/desktop/bin/darwin/
- name: Artifacts/windows - name: Artifacts/windows
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v1
with: with:
name: maputnik-windows name: maputnik-windows
path: ./desktop/bin/windows/ path: ./src/github.com/maputnik/desktop/bin/windows/
e2e-tests: cypress-run:
name: "E2E tests using ${{ matrix.browser }}"
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@@ -106,8 +138,3 @@ jobs:
build: npm run build build: npm run build
start: npm run start start: npm run start
browser: ${{ matrix.browser }} browser: ${{ matrix.browser }}
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v3
with:
files: ${{ github.workspace }}/.nyc_output/out.json
verbose: true
@@ -1,39 +0,0 @@
name: Create bump version PR
on:
workflow_dispatch:
inputs:
version:
description: Version to change to.
required: true
type: string
jobs:
bump-version-pr:
name: Bump version PR
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
ref: main
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
- name: Bump version
run: |
npm version --commit-hooks false --git-tag-version false ${{ inputs.version }}
./build/bump-version-changelog.js ${{ inputs.version }}
- name: Create Pull Request
uses: peter-evans/create-pull-request@v6
with:
commit-message: Bump version to ${{ inputs.version }}
branch: bump-version-to-${{ inputs.version }}
title: Bump version to ${{ inputs.version }}
+8 -33
View File
@@ -3,49 +3,24 @@ name: deploy
on: on:
push: push:
branches: [ main ] branches: [ main ]
tags:
- 'v*'
jobs: jobs:
deploy-pages:
name: deploy/pages
runs-on: ubuntu-latest
if: ${{ github.event_name == 'push' }}
steps:
- uses: actions/checkout@v4
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'
- name: Install
run: npm ci
- name: Build
run: npm run build
- name: Upload to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: dist
# publish docker to GitHub registry # publish docker to GitHub registry
deploy-docker: deploy-docker:
name: deploy/docker name: deploy/docker
runs-on: ubuntu-latest runs-on: ${{ matrix.os }}
if: ${{ github.event_name == 'push' }} if: ${{ github.event_name == 'push' }}
strategy: strategy:
fail-fast: false fail-fast: false
matrix:
os: [ubuntu-latest]
steps: steps:
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- run: docker build -t ghcr.io/maplibre/maputnik:main . - run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login docker.pkg.github.com -u orangemug --password-stdin
- run: docker push ghcr.io/maplibre/maputnik:main - run: docker build -t docker.pkg.github.com/maputnik/editor/editor:main .
- run: docker push docker.pkg.github.com/maputnik/editor/editor:main
-104
View File
@@ -1,104 +0,0 @@
name: Release
on:
push:
branches: [main]
workflow_dispatch:
jobs:
release-check:
name: Check if version changed
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
ref: main
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
- name: Check if version has been updated
id: check
uses: EndBug/version-check@v2
outputs:
publish: ${{ steps.check.outputs.changed }}
release:
name: Release
needs: release-check
if: ${{ needs.release-check.outputs.publish == 'true' }}
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
ref: main
- name: Use Node.js from nvmrc
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
registry-url: "https://registry.npmjs.org"
- name: Set up Go for desktop build
uses: actions/setup-go@v5
with:
go-version: ^1.23.x
cache-dependency-path: desktop/go.sum
id: go
- name: Get version
id: package-version
uses: martinbeentjes/npm-get-version-action@v1.3.1
- name: Install
run: npm ci
- name: Build
run: |
npm run build
npm run build-desktop
- name: Tag commit and push
id: tag_version
uses: mathieudutour/github-tag-action@v6.2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
custom_tag: ${{ steps.package-version.outputs.current-version }}
- name: Create Archives
run: |
zip -r dist dist
zip -r desktop desktop/bin/
- name: Build Release Notes
id: release_notes
run: |
RELEASE_NOTES_PATH="${PWD}/release_notes.txt"
./build/release-notes.js > ${RELEASE_NOTES_PATH}
echo "release_notes=${RELEASE_NOTES_PATH}" >> $GITHUB_OUTPUT
- name: Create GitHub Release
id: create_regular_release
uses: ncipollo/release-action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag: ${{ steps.tag_version.outputs.new_tag }}
name: ${{ steps.tag_version.outputs.new_tag }}
bodyFile: ${{ steps.release_notes.outputs.release_notes }}
artifacts: "dist.zip,desktop.zip"
allowUpdates: true
draft: false
prerelease: false
+2 -2
View File
@@ -14,7 +14,7 @@ lib-cov
# Coverage directory used by tools like istanbul # Coverage directory used by tools like istanbul
coverage coverage
.nyc_output .nycoutput
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt .grunt
@@ -33,6 +33,6 @@ node_modules
public public
/errorShots /errorShots
/old /old
/build
/cypress/screenshots /cypress/screenshots
/dist/ /dist/
/desktop/version.go
-1
View File
@@ -1 +0,0 @@
legacy-peer-deps = true
-1
View File
@@ -1 +0,0 @@
18.19
+9
View File
@@ -11,6 +11,15 @@
"./coverage/**", "./coverage/**",
"./cypress/**", "./cypress/**",
"./dist/**", "./dist/**",
"**/*.cy.ts",
"./lighthouse/**",
"./e2e-coverage/**",
"./unit-coverage/**",
"./src/environments/**",
"**/*@globalwebindex/**",
"./config/jest/**",
"./public/vendor/**",
"./scripts/**",
"node_modules" "node_modules"
], ],
"report-dir": "coverage", "report-dir": "coverage",
+9
View File
@@ -0,0 +1,9 @@
const config = {
stories: ['../stories/**/*.stories.jsx'],
addons: ['@storybook/addon-actions', '@storybook/addon-links', '@storybook/addon-a11y/register', '@storybook/addon-storysource'],
framework: {
name: '@storybook/react-vite',
options: {}
}
};
export default config;
+7
View File
@@ -0,0 +1,7 @@
import { addons } from '@storybook/addons';
import { themes } from '@storybook/theming';
import theme from './maputnik.theme';
addons.setConfig({
theme: theme,
});
+8
View File
@@ -0,0 +1,8 @@
import { create } from '@storybook/theming/create';
export default create({
base: 'light',
brandTitle: 'Maputnik',
brandUrl: 'https://github.com/maputnik/editor',
});
-24
View File
@@ -1,24 +0,0 @@
## main
### ✨ Features and improvements
- _...Add new stuff here..._
### 🐞 Bug fixes
- _...Add new stuff here..._
## 2.1.0
### ✨ Features and improvements
- Add GitHub workflows for releasing new versions
- Update desktop build to pull from this repo (#922)
## 2.0.0
- Update MapLibre to version 4 (#872)
- Start continuous deployment of maputnik website
## 1.7.0
- See release notes at https://maputnik.github.io/blog/2020/04/23/release-v1.7.0
-2
View File
@@ -1,2 +0,0 @@
# Contributor Covenant
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/maplibre/maplibre/blob/main/CODE_OF_CONDUCT.md)
+12 -6
View File
@@ -2,15 +2,21 @@ FROM node:18 as builder
WORKDIR /maputnik WORKDIR /maputnik
# Only copy package.json to prevent npm install from running on every build # Only copy package.json to prevent npm install from running on every build
COPY package.json package-lock.json .npmrc ./ COPY package.json package-lock.json ./
RUN npm ci RUN npm install
# Build maputnik # Build maputnik
# TODO: we should also do a npm run test here (needs more dependencies)
COPY . . COPY . .
RUN npx vite build RUN npm run build
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Create a clean nginx-alpine slim image with just the build results
FROM nginx:alpine-slim
COPY --from=builder /maputnik/dist /usr/share/nginx/html/ # Create a clean python-based image with just the build results
FROM python:3-slim
WORKDIR /maputnik
COPY --from=builder /maputnik/dist .
EXPOSE 8888
CMD python -m http.server 8888
-1
View File
@@ -1,7 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2015 Lukas Martinelli Copyright (c) 2015 Lukas Martinelli
Copyright (c) 2024 MapLibre contributors
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
+69 -24
View File
@@ -1,10 +1,10 @@
<img width="200" alt="Maputnik logo" src="https://cdn.jsdelivr.net/gh/maputnik/design/logos/logo-color.png" /> <img width="200" alt="Maputnik logo" src="https://cdn.jsdelivr.net/gh/maputnik/design/logos/logo-color.png" />
# Maputnik # Maputnik
[![GitHub CI status](https://github.com/maplibre/maputnik/workflows/ci/badge.svg)][github-action-ci] [![GitHub CI status](https://github.com/maputnik/editor/workflows/ci/badge.svg)][github-action-ci]
[![License](https://img.shields.io/badge/license-MIT-blue.svg)][license] [![License](https://img.shields.io/badge/license-MIT-blue.svg)][license]
[github-action-ci]: https://github.com/maplibre/maputnik/actions?query=workflow%3Aci [github-action-ci]: https://github.com/maputnik/editor/actions?query=workflow%3Aci
[license]: https://tldrlegal.com/license/mit-license [license]: https://tldrlegal.com/license/mit-license
A free and open visual editor for the [MapLibre GL styles](https://maplibre.org/maplibre-style-spec/) A free and open visual editor for the [MapLibre GL styles](https://maplibre.org/maplibre-style-spec/)
@@ -13,32 +13,33 @@ targeted at developers and map designers.
## Usage ## Usage
- :link: Design your maps online at **<https://www.maplibre.org/maputnik/>** (all in local storage) - :link: Design your maps online at **<https://maputnik.github.io/editor/>** (all in local storage)
- :link: Use the [Maputnik CLI](https://github.com/maplibre/maputnik/wiki/Maputnik-CLI) for local style development - :link: Use the [Maputnik CLI](https://github.com/maputnik/editor/wiki/Maputnik-CLI) for local style development
- In a Docker, run this command and browse to http://localhost:8888, Ctrl+C to stop the server. - In a Docker, run this command and browse to http://localhost:8888, Ctrl+C to stop the server.
```bash ```bash
docker run -it --rm -p 8888:80 ghcr.io/maplibre/maputnik:main docker run -it --rm -p 8888:8888 maputnik/editor
``` ```
## Donations
Mapbox has built one of the best and most amazing OSS ecosystems. A key component to ensure its longevity and independence is an OSS map designer.
If you or your organisation has seen value from Maputnik, please consider donating at <https://maputnik.github.io/donate>
## Documentation ## Documentation
The documentation can be found in the [Wiki](https://github.com/maplibre/maputnik/wiki). You are welcome to collaborate! The documentation can be found in the [Wiki](https://github.com/maputnik/editor/wiki). You are welcome to collaborate!
- :link: **Study the [Maputnik Wiki](https://github.com/maplibre/maputnik/wiki)** - :link: **Study the [Maputnik Wiki](https://github.com/maputnik/editor/wiki)**
- :video_camera: Design a map from Scratch https://youtu.be/XoDh0gEnBQo - :video_camera: Design a map from Scratch https://youtu.be/XoDh0gEnBQo
[![Design Map from Scratch](https://j.gifs.com/g5XMgl.gif)](https://youtu.be/XoDh0gEnBQo) [![Design Map from Scratch](https://j.gifs.com/g5XMgl.gif)](https://youtu.be/XoDh0gEnBQo)
## Develop ## Develop
Maputnik is written in typescript and is using [React](https://github.com/facebook/react) and [MapLibre GL JS](https://maplibre.org/projects/maplibre-gl-js/). Maputnik is written in ES6 and is using [React](https://github.com/facebook/react) and [MapLibre GL JS](https://maplibre.org/projects/maplibre-gl-js/).
We ensure building and developing Maputnik works with the [current active LTS Node.js version and above](https://github.com/nodejs/Release#release-schedule). We ensure building and developing Maputnik works with the [current active LTS Node.js version and above](https://github.com/nodejs/Release#release-schedule).
### Getting Involved
Join the #maplibre or #maputnik slack channel at OSMUS: get an invite at https://slack.openstreetmap.us/ Read the the below guide in order to get familiar with how we do things around here.
Install the deps, start the dev server and open the web browser on `http://localhost:8888/`. Install the deps, start the dev server and open the web browser on `http://localhost:8888/`.
```bash ```bash
@@ -66,8 +67,7 @@ Lint the JavaScript code.
``` ```
# run linter # run linter
npm run lint npm run lint
npm run lint-css npm run lint-styles
npm run sort-styles
``` ```
@@ -94,23 +94,68 @@ You can also see the tests as they run or select which suites to run by executin
npm run cy:open npm run cy:open
``` ```
## Release process
1. Review [`CHANGELOG.md`](/CHANGELOG.md) ## Related Projects
- Double-check that all changes included in the release are appropriately documented.
- To-be-released changes should be under the "main" header.
- Commit any final changes to the changelog.
2. Run [Create bump version PR](https://github.com/maplibre/maputnik/actions/workflows/create-bump-version-pr.yml) by manual workflow dispatch and set the version number in the input. This will create a PR that changes the changelog and `package.json` file to review and merge.
3. Once merged, an automatic process will kick in and creates a GitHub release and uploads release assets.
- [maputnik-dev-server](https://github.com/nycplanning/labs-maputnik-dev-server) - An express.js server that allows for quickly loading the style from any mapboxGL map into mapuntnik.
## Sponsors ## Sponsors
Thanks to the supporters of the **[Kickstarter campaign](https://www.kickstarter.com/projects/174808720/maputnik-visual-map-editor-for-mapbox-gl)**. This project would not be possible without these commercial and individual sponsors. Thanks to the supporters of the **[Kickstarter campaign](https://www.kickstarter.com/projects/174808720/maputnik-visual-map-editor-for-mapbox-gl)**. This project would not be possible without these commercial and individual sponsors.
You can see this file's history for previous sponsors of the original Maputnik repo.
Read more about the MapLibre Sponsorship Program at https://maplibre.org/sponsors/. ### Gold
- [Wemap](https://getwemap.com/)
- [Orbicon Informatik](https://www.orbiconinformatik.dk/)
- [Terranodo](http://terranodo.io/)
<a href="https://getwemap.com/">
<img width="33%" alt="Wemap" style="display:inline" src="https://cdn.jsdelivr.net/gh/maputnik/editor@1.5.0/media/sponsors/wemap.jpg" />
</a>
<a href="http://terranodo.io/">
<img width="33%" alt="Terranodo" style="display:inline" src="https://cdn.jsdelivr.net/gh/maputnik/editor@1.5.0/media/sponsors/terranodo.png" />
</a>
<a href="https://www.orbiconinformatik.dk/">
<img width="32%" alt="Terranodo" style="display:inline" src="https://cdn.jsdelivr.net/gh/maputnik/editor@1.5.0/media/sponsors/orbicon_informatik.png" />
</a>
<br/>
### Silver
- [Klokan Technologies](https://www.klokantech.com/)
- [Geofabrik](http://www.geofabrik.de/)
- [Dreipol](https://www.dreipol.ch/)
<a href="https://www.klokantech.com/">
<img width="18%" alt="Klokan Technologies" style="display:inline-block" src="https://cdn.jsdelivr.net/gh/maputnik/editor@1.5.0/media/sponsors/klokantech.png" />
</a>
<a href="http://www.geofabrik.de/">
<img width="18%" alt="Geofabrik" style="display:inline-block" src="https://cdn.jsdelivr.net/gh/maputnik/editor@1.5.0/media/sponsors/geofabrik.png" />
</a>
<a href="https://www.dreipol.ch/">
<img width="18%" alt="Dreipol" style="display:inline-block" src="https://cdn.jsdelivr.net/gh/maputnik/editor@1.5.0/media/sponsors/dreipol.png" />
</a>
<br/>
### Individuals
**Influential Stakeholder**
Alan McConchie, Odi, Mats Norén, Uli [geOps](http://geops.ch/), Helge Fahrnberger ([Toursprung](http://www.toursprung.com/)), Kirusanth Poopalasingam
**Stakeholder**
Brian Flood, Vasile Coțovanu, Andreas Kalkbrenner, Christian Mäder, Gregor Wassmann, Lee Armstrong, Rafel, Jon Burgess, Lukas Lehmann, Joachim Ungar, Alois Ackermann, Zsolt Ero, Jordan Meek
**Supporter**
Sina Martinelli, Nicholas Doiron, Neil Cawse, Urs42, Benedikt Groß, Manuel Roth, Janko Mihelić, Moritz Stefaner, Sebastian Ahoi, Juerg Uhlmann, Tom Wider, Nadia Panchaud, Oliver Snowden, Stephan Heuel, Tobin Bradley, Adrian Herzog, Antti Lehto, Pascal Mages, Marc Gehling, Imre Samu, Lauri K., Visahavel Parthasarathy, Christophe Waterlot-Buisine, Max Galka, ubahnverleih, Wouter van Dam, Jakob Lobensteiner, Samuel Kurath, Brian Bancroft
## License ## License
Maputnik is [licensed under MIT](LICENSE) and is Copyright (c) Lukas Martinelli and Maplibre contributors. Maputnik is [licensed under MIT](LICENSE) and is Copyright (c) Lukas Martinelli and contributors.
As contributor please take extra care of not violating any Mapbox trademarks. Do not get inspired by other map studios and make your own decisions for a good style editor.
**Disclaimer** This is an independent style editor.
As contributor please take extra care of not violating any Mapbox trademarks. Do not get inspired by Mapbox Studio and make your own decisions for a good style editor.
-2
View File
@@ -1,2 +0,0 @@
For an up-to-date policy refer to
https://github.com/maplibre/maplibre/blob/main/SECURITY_POLICY.txt
-11
View File
@@ -1,11 +0,0 @@
# Build Scripts
This folder holds common build scripts used by some of the Github workflows.
The scripts are borrowed from [maplibre/maplibre-gl-js](https://github.com/maplibre/maplibre-gl-js/tree/bc70bc559cea5c987fa1b79fd44766cef68bbe28/build).
## Generate Release Notes
`bump-version-changelog.js` Used to update the changelog with the current notes, and set up a space for new notes
`release-notes.js` Used to generate release notes when releasing a new version
-29
View File
@@ -1,29 +0,0 @@
#!/usr/bin/env node
/**
* This script updates the changelog.md file with the version given in the arguments
* It replaces ## main with ## <version>
* Removes _...Add new stuff here..._
* And adds on top a ## main with add stuff here.
*
* Copied from maplibre/maplibre-gl-js
* https://github.com/maplibre/maplibre-gl-js/blob/bc70bc559cea5c987fa1b79fd44766cef68bbe28/build/release-notes.js
*/
import * as fs from 'fs';
const changelogPath = 'CHANGELOG.md';
let changelog = fs.readFileSync(changelogPath, 'utf8');
changelog = changelog.replace('## main', `## ${process.argv[2]}`);
changelog = changelog.replaceAll('- _...Add new stuff here..._\n', '');
changelog = `## main
### ✨ Features and improvements
- _...Add new stuff here..._
### 🐞 Bug fixes
- _...Add new stuff here..._
` + changelog;
fs.writeFileSync(changelogPath, changelog, 'utf8');
-48
View File
@@ -1,48 +0,0 @@
#!/usr/bin/env node
// Copied from maplibre/maplibre-gl-js
// https://github.com/maplibre/maplibre-gl-js/blob/bc70bc559cea5c987fa1b79fd44766cef68bbe28/build/release-notes.js
import * as fs from 'fs';
const changelogPath = 'CHANGELOG.md';
const changelog = fs.readFileSync(changelogPath, 'utf8');
/*
Parse the raw changelog text and split it into individual releases.
This regular expression:
- Matches lines starting with "## x.x.x".
- Groups the version number.
- Skips the (optional) release date.
- Groups the changelog content.
- Ends when another "## x.x.x" is found.
*/
const regex = /^## (\d+\.\d+\.\d+.*?)\n(.+?)(?=\n^## \d+\.\d+\.\d+.*?\n)/gms;
let releaseNotes = [];
let match;
// eslint-disable-next-line no-cond-assign
while (match = regex.exec(changelog)) {
releaseNotes.push({
'version': match[1],
'changelog': match[2].trim(),
});
}
const latest = releaseNotes[0];
const previous = releaseNotes[1];
// Print the release notes template.
let header = 'Changes since previous version'
if (previous) {
header = `https://github.com/maplibre/maputnik
[Changes](https://github.com/maplibre/maputnik/compare/v${previous.version}...v${latest.version}) since [Maputnik v${previous.version}](https://github.com/maplibre/maputnik/releases/tag/v${previous.version})`
}
const templatedReleaseNotes = `${header}
${latest.changelog}
// eslint-disable-next-line eol-last
process.stdout.write(templatedReleaseNotes.trimEnd());
-3
View File
@@ -1,6 +1,4 @@
import { defineConfig } from "cypress"; import { defineConfig } from "cypress";
import { createRequire } from "module";
const require = createRequire(import.meta.url);
export default defineConfig({ export default defineConfig({
env: { env: {
@@ -14,7 +12,6 @@ export default defineConfig({
require("@cypress/code-coverage/task")(on, config); require("@cypress/code-coverage/task")(on, config);
return config; return config;
}, },
baseUrl: "http://localhost:8888",
retries: { retries: {
runMode: 2, runMode: 2,
openMode: 0, openMode: 0,
+11 -11
View File
@@ -1,7 +1,7 @@
import { MaputnikDriver } from "./maputnik-driver"; import MaputnikDriver from "./driver";
describe("accessibility", () => { describe("accessibility", () => {
let { beforeAndAfter, get, when, then } = new MaputnikDriver(); let { beforeAndAfter, given, when, get, should } = new MaputnikDriver();
beforeAndAfter(); beforeAndAfter();
describe("skip links", () => { describe("skip links", () => {
@@ -11,30 +11,30 @@ describe("accessibility", () => {
it("skip link to layer list", () => { it("skip link to layer list", () => {
const selector = "root:skip:layer-list"; const selector = "root:skip:layer-list";
then(get.elementByTestId(selector)).shouldExist(); should.exist(selector);
when.tab(); when.tab();
then(get.elementByTestId(selector)).shouldBeFocused(); should.beFocused(selector);
when.click(selector); when.click(selector);
then(get.skipTargetLayerList()).shouldBeFocused(); should.beFocused("skip-target-layer-list");
}); });
// This fails for some reason only in Chrome, but passes in firefox. Adding a skip here to allow merge and later on we'll decide if we want to fix this or not. // This fails for some reason only in Chrome, but passes in firefox. Adding a skip here to allow merge and later on we'll decide if we want to fix this or not.
it.skip("skip link to layer editor", () => { it.skip("skip link to layer editor", () => {
const selector = "root:skip:layer-editor"; const selector = "root:skip:layer-editor";
then(get.elementByTestId(selector)).shouldExist(); should.exist(selector);
when.tab().tab(); when.tab().tab();
then(get.elementByTestId(selector)).shouldBeFocused(); should.beFocused(selector);
when.click(selector); when.click(selector);
then(get.skipTargetLayerEditor()).shouldBeFocused(); should.beFocused("skip-target-layer-editor");
}); });
it("skip link to map view", () => { it("skip link to map view", () => {
const selector = "root:skip:map-view"; const selector = "root:skip:map-view";
then(get.elementByTestId(selector)).shouldExist(); should.exist(selector);
when.tab().tab().tab(); when.tab().tab().tab();
then(get.elementByTestId(selector)).shouldBeFocused(); should.beFocused(selector);
when.click(selector); when.click(selector);
then(get.canvas()).shouldBeFocused(); should.canvasBeFocused();
}); });
}); });
}); });
+210
View File
@@ -0,0 +1,210 @@
import { CypressHelper } from "@shellygo/cypress-test-utils";
import { v1 as uuid } from "uuid";
export default class MaputnikDriver {
private helper = new CypressHelper({ defaultDataAttribute: "data-wd-key" });
public beforeAndAfter = () => {
beforeEach(() => {
this.given.setupInterception();
this.when.setStyle("both");
});
};
public given = {
setupInterception: () => {
cy.intercept("GET", "http://localhost:8888/example-style.json", {
fixture: "example-style.json",
}).as("example-style.json");
cy.intercept("GET", "http://localhost:8888/example-layer-style.json", {
fixture: "example-layer-style.json",
});
cy.intercept("GET", "http://localhost:8888/geojson-style.json", {
fixture: "geojson-style.json",
});
cy.intercept("GET", "http://localhost:8888/raster-style.json", {
fixture: "raster-style.json",
});
cy.intercept("GET", "http://localhost:8888/geojson-raster-style.json", {
fixture: "geojson-raster-style.json",
});
cy.intercept({ method: "GET", url: "*example.local/*" }, []);
cy.intercept({ method: "GET", url: "*example.com/*" }, []);
},
};
public when = {
within: (selector: string, fn: () => void) => {
this.helper.when.within(fn, selector);
},
tab: () => cy.get("body").tab(),
waitForExampleFileRequset: () => {
this.helper.when.waitForResponse("example-style.json");
},
chooseExampleFile: () => {
cy.get("input[type='file']").selectFile(
"cypress/fixtures/example-style.json",
{ force: true }
);
},
setStyle: (
styleProperties: "geojson" | "raster" | "both" | "layer" | "",
zoom?: number
) => {
let url = "?debug";
switch (styleProperties) {
case "geojson":
url += "&style=http://localhost:8888/geojson-style.json";
break;
case "raster":
url += "&style=http://localhost:8888/raster-style.json";
break;
case "both":
url += "&style=http://localhost:8888/geojson-raster-style.json";
break;
case "layer":
url += "&style=http://localhost:8888/example-layer-style.json";
break;
}
if (zoom) {
url += "#" + zoom + "/41.3805/2.1635";
}
cy.visit("http://localhost:8888/" + url);
if (styleProperties) {
cy.on("window:confirm", () => true);
}
cy.get(".maputnik-toolbar-link").should("be.visible");
},
fillLayersModal: (opts: {type: string, layer?: string, id?: string}) => {
var type = opts.type;
var layer = opts.layer;
var id;
if (opts.id) {
id = opts.id;
} else {
id = `${type}:${uuid()}`;
}
cy.get(
this.get.dataAttribute("add-layer.layer-type", "select")
).select(type);
cy.get(this.get.dataAttribute("add-layer.layer-id", "input")).type(id);
if (layer) {
cy.get(
this.get.dataAttribute("add-layer.layer-source-block", "input")
).type(layer);
}
this.when.click("add-layer");
return id;
},
typeKeys: (keys: string) => {
cy.get("body").type(keys);
},
click: (selector: string) => {
this.helper.when.click(selector);
},
clickZoomin: () => {
cy.get(".maplibregl-ctrl-zoom-in").click();
},
selectWithin: (selector: string, value: string) => {
this.when.within(selector, () => {
cy.get("select").select(value);
});
},
select: (selector: string, value: string) => {
this.helper.get.element(selector).select(value);
},
focus: (selector: string) => {
this.helper.when.focus(selector);
},
setValue: (selector: string, text: string) => {
cy.get(selector).clear().type(text, { parseSpecialCharSequences: false });
},
closeModal: (key: string) => {
this.helper.when.waitUntil(() => this.helper.get.element(key));
this.when.click(key + ".close-modal");
},
openLayersModal: () => {
this.helper.when.click("layer-list:add-layer");
cy.get(this.get.dataAttribute("modal:add-layer")).should("exist");
cy.get(this.get.dataAttribute("modal:add-layer")).should("be.visible");
},
};
public get = {
isMac: () => {
return Cypress.platform === "darwin";
},
styleFromWindow: (win: Window) => {
const styleId = win.localStorage.getItem("maputnik:latest_style");
const styleItem = win.localStorage.getItem(`maputnik:style:${styleId}`);
const obj = JSON.parse(styleItem || "");
return obj;
},
exampleFileUrl: () => {
return "http://localhost:8888/example-style.json";
},
dataAttribute: (key: string, selector?: string): string => {
return `*[data-wd-key='${key}'] ${selector || ""}`;
},
};
public should = {
canvasBeFocused: () => {
this.when.within("maplibre:map", () => {
cy.get("canvas").should("be.focused");
});
},
notExist: (selector: string) => {
cy.get(selector).should("not.exist");
},
beFocused: (selector: string) => {
this.helper.get.element(selector).should("have.focus");
},
notBeFocused: (selector: string) => {
this.helper.get.element(selector).should("not.have.focus");
},
beVisible: (selector: string) => {
this.helper.get.element(selector).should("be.visible");
},
notBeVisible: (selector: string) => {
this.helper.get.element(selector).should("not.be.visible");
},
equalStyleStore: (getter: (obj: any) => any, styleObj: any) => {
cy.window().then((win: any) => {
const obj = this.get.styleFromWindow(win);
assert.deepEqual(getter(obj), styleObj);
});
},
styleStoreEqualToExampleFileData: () => {
cy.window().then((win: any) => {
const obj = this.get.styleFromWindow(win);
cy.fixture("example-style.json").should("deep.equal", obj);
});
},
exist: (selector: string) => {
this.helper.get.element(selector).should("exist");
},
beSelected: (selector: string, value: string) => {
this.helper.get.element(selector).find(`option[value="${value}"]`).should("be.selected");
},
containText: (selector: string, text: string) => {
this.helper.get.element(selector).should("contain.text", text);
}
};
}
+35 -63
View File
@@ -1,7 +1,7 @@
import { MaputnikDriver } from "./maputnik-driver"; import MaputnikDriver from "./driver";
describe("history", () => { describe("history", () => {
let { beforeAndAfter, when, get, then } = new MaputnikDriver(); let { beforeAndAfter, given, when, get, should } = new MaputnikDriver();
beforeAndAfter(); beforeAndAfter();
let undoKeyCombo: string; let undoKeyCombo: string;
@@ -15,30 +15,34 @@ describe("history", () => {
it("undo/redo", () => { it("undo/redo", () => {
when.setStyle("geojson"); when.setStyle("geojson");
when.modal.open(); when.openLayersModal();
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ layers: [] });
when.modal.fillLayers({ should.equalStyleStore((a: any) => a.layers, []);
when.fillLayersModal({
id: "step 1", id: "step 1",
type: "background", type: "background",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [ should.equalStyleStore(
(a: any) => a.layers,
[
{ {
id: "step 1", id: "step 1",
type: "background", type: "background",
}, },
], ]
}); );
when.modal.open(); when.openLayersModal();
when.modal.fillLayers({ when.fillLayersModal({
id: "step 2", id: "step 2",
type: "background", type: "background",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: "step 1", id: "step 1",
type: "background", type: "background",
@@ -47,35 +51,38 @@ describe("history", () => {
id: "step 2", id: "step 2",
type: "background", type: "background",
}, },
], ]
}); );
when.typeKeys(undoKeyCombo); when.typeKeys(undoKeyCombo);
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: "step 1", id: "step 1",
type: "background", type: "background",
}, },
], ]
}); );
when.typeKeys(undoKeyCombo); when.typeKeys(undoKeyCombo);
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ layers: [] }); should.equalStyleStore((a: any) => a.layers, []);
when.typeKeys(redoKeyCombo); when.typeKeys(redoKeyCombo);
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: "step 1", id: "step 1",
type: "background", type: "background",
}, },
], ]
}); );
when.typeKeys(redoKeyCombo); when.typeKeys(redoKeyCombo);
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: "step 1", id: "step 1",
type: "background", type: "background",
@@ -84,42 +91,7 @@ describe("history", () => {
id: "step 2", id: "step 2",
type: "background", type: "background",
}, },
], ]
}); );
});
it("should not redo after undo and value change", () => {
when.setStyle("geojson");
when.modal.open();
when.modal.fillLayers({
id: "step 1",
type: "background",
});
when.modal.open();
when.modal.fillLayers({
id: "step 2",
type: "background",
});
when.typeKeys(undoKeyCombo);
when.typeKeys(undoKeyCombo);
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ layers: [] });
when.modal.open();
when.modal.fillLayers({
id: "step 3",
type: "background",
});
when.typeKeys(redoKeyCombo);
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [
{
id: "step 3",
type: "background",
},
],
});
}); });
}); });
-35
View File
@@ -1,35 +0,0 @@
import { MaputnikDriver } from "./maputnik-driver";
describe("i18n", () => {
let { beforeAndAfter, get, when, then } = new MaputnikDriver();
beforeAndAfter();
describe("language detector", () => {
it("English", () => {
const url = "?lng=en";
when.visit(url);
then(get.elementByTestId("maputnik-lang-select")).shouldHaveValue("en");
});
it("Japanese", () => {
const url = "?lng=ja";
when.visit(url);
then(get.elementByTestId("maputnik-lang-select")).shouldHaveValue("ja");
});
});
describe("language switcher", () => {
beforeEach(() => {
when.setStyle("layer");
});
it("the language switcher switches to Japanese", () => {
const selector = "maputnik-lang-select";
then(get.elementByTestId(selector)).shouldExist();
when.select(selector, "ja");
then(get.elementByTestId(selector)).shouldHaveValue("ja");
then(get.elementByTestId("nav:settings")).shouldHaveText("スタイル設定");
});
});
});
+14 -13
View File
@@ -1,60 +1,61 @@
import { MaputnikDriver } from "./maputnik-driver"; import MaputnikDriver from "./driver";
describe("keyboard", () => { describe("keyboard", () => {
let { beforeAndAfter, given, when, get, then } = new MaputnikDriver(); let { beforeAndAfter, given, when, get, should } = new MaputnikDriver();
beforeAndAfter(); beforeAndAfter();
describe("shortcuts", () => { describe("shortcuts", () => {
beforeEach(() => { beforeEach(() => {
given.setupMockBackedResponses(); given.setupInterception();
when.setStyle(""); when.setStyle("");
}); });
it("ESC should unfocus", () => { it("ESC should unfocus", () => {
const targetSelector = "maputnik-select"; const targetSelector = "maputnik-select";
when.focus(targetSelector); when.focus(targetSelector);
then(get.elementByTestId(targetSelector)).shouldBeFocused(); should.beFocused(targetSelector);
when.typeKeys("{esc}"); when.typeKeys("{esc}");
then(get.elementByTestId(targetSelector)).shouldNotBeFocused(); expect(should.notBeFocused(targetSelector));
}); });
it("'?' should show shortcuts modal", () => { it("'?' should show shortcuts modal", () => {
when.typeKeys("?"); when.typeKeys("?");
then(get.elementByTestId("modal:shortcuts")).shouldBeVisible(); should.beVisible("modal:shortcuts");
}); });
it("'o' should show open modal", () => { it("'o' should show open modal", () => {
when.typeKeys("o"); when.typeKeys("o");
then(get.elementByTestId("modal:open")).shouldBeVisible(); should.beVisible("modal:open");
}); });
it("'e' should show export modal", () => { it("'e' should show export modal", () => {
when.typeKeys("e"); when.typeKeys("e");
then(get.elementByTestId("modal:export")).shouldBeVisible(); should.beVisible("modal:export");
}); });
it("'d' should show sources modal", () => { it("'d' should show sources modal", () => {
when.typeKeys("d"); when.typeKeys("d");
then(get.elementByTestId("modal:sources")).shouldBeVisible(); should.beVisible("modal:sources");
}); });
it("'s' should show settings modal", () => { it("'s' should show settings modal", () => {
when.typeKeys("s"); when.typeKeys("s");
then(get.elementByTestId("modal:settings")).shouldBeVisible(); should.beVisible("modal:settings");
}); });
it("'i' should change map to inspect mode", () => { it("'i' should change map to inspect mode", () => {
when.typeKeys("i"); when.typeKeys("i");
then(get.inputValue("maputnik-select")).shouldEqual("inspect"); should.beSelected("nav:inspect", "inspect");
}); });
it("'m' should focus map", () => { it("'m' should focus map", () => {
when.typeKeys("m"); when.typeKeys("m");
then(get.canvas()).shouldBeFocused(); should.canvasBeFocused();
}); });
it("'!' should show debug modal", () => { it("'!' should show debug modal", () => {
when.typeKeys("!"); when.typeKeys("!");
then(get.elementByTestId("modal:debug")).shouldBeVisible(); should.beVisible("modal:debug");
}); });
}); });
}); });
+270 -276
View File
@@ -1,137 +1,155 @@
import { v1 as uuid } from "uuid"; import { v1 as uuid } from "uuid";
import { MaputnikDriver } from "./maputnik-driver"; import MaputnikDriver from "./driver";
describe("layers", () => { describe("layers", () => {
let { beforeAndAfter, get, when, then } = new MaputnikDriver(); let { beforeAndAfter, given, when, get, should } = new MaputnikDriver();
beforeAndAfter(); beforeAndAfter();
beforeEach(() => { beforeEach(() => {
when.setStyle("both"); when.setStyle("both");
when.modal.open(); when.openLayersModal();
}); });
describe("ops", () => { describe("ops", () => {
let id: string; it("delete", () => {
beforeEach(() => { var id = when.fillLayersModal({
id = when.modal.fillLayers({
type: "background", type: "background",
}); });
});
it("should update layers in local storage", () => { should.equalStyleStore(
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ (a: any) => a.layers,
layers: [ [
{ {
id: id, id: id,
type: "background", type: "background",
}, },
], ]
}); );
when.click("layer-list-item:" + id + ":delete");
should.equalStyleStore((a: any) => a.layers, []);
}); });
describe("when clicking delete", () => { it("duplicate", () => {
beforeEach(() => { var styleObj;
when.click("layer-list-item:" + id + ":delete"); var id = when.fillLayersModal({
}); type: "background",
it("should empty layers in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [],
});
}); });
should.equalStyleStore(
(a: any) => a.layers,
[
{
id: id,
type: "background",
},
]
);
when.click("layer-list-item:" + id + ":copy");
should.equalStyleStore(
(a: any) => a.layers,
[
{
id: id + "-copy",
type: "background",
},
{
id: id,
type: "background",
},
]
);
}); });
describe("when clicking duplicate", () => { it("hide", () => {
beforeEach(() => { var styleObj;
when.click("layer-list-item:" + id + ":copy"); var id = when.fillLayersModal({
type: "background",
}); });
it("should add copy layer in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
{ [
id: id + "-copy", {
type: "background", id: id,
type: "background",
},
]
);
when.click("layer-list-item:" + id + ":toggle-visibility");
should.equalStyleStore(
(a: any) => a.layers,
[
{
id: id,
type: "background",
layout: {
visibility: "none",
}, },
{ },
id: id, ]
type: "background", );
when.click("layer-list-item:" + id + ":toggle-visibility");
should.equalStyleStore(
(a: any) => a.layers,
[
{
id: id,
type: "background",
layout: {
visibility: "visible",
}, },
], },
}); ]
}); );
});
describe("when clicking hide", () => {
beforeEach(() => {
when.click("layer-list-item:" + id + ":toggle-visibility");
});
it("should update visibility to none in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [
{
id: id,
type: "background",
layout: {
visibility: "none",
},
},
],
});
});
describe("when clicking show", () => {
beforeEach(() => {
when.click("layer-list-item:" + id + ":toggle-visibility");
});
it("should update visibility to visible in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [
{
id: id,
type: "background",
layout: {
visibility: "visible",
},
},
],
});
});
});
}); });
}); });
describe("background", () => { describe("background", () => {
it("add", () => { it("add", () => {
let id = when.modal.fillLayers({ var id = when.fillLayersModal({
type: "background", type: "background",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [ should.equalStyleStore(
(a: any) => a.layers,
[
{ {
id: id, id: id,
type: "background", type: "background",
}, },
], ]
}); );
}); });
describe("modify", () => { describe("modify", () => {
function createBackground() { function createBackground() {
// Setup // Setup
let id = uuid(); var id = uuid();
when.selectWithin("add-layer.layer-type", "background"); when.selectWithin("add-layer.layer-type", "background");
when.setValue("add-layer.layer-id.input", "background:" + id); when.setValue(
get.dataAttribute("add-layer.layer-id", "input"),
"background:" + id
);
when.click("add-layer"); when.click("add-layer");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: "background:" + id, id: "background:" + id,
type: "background", type: "background",
}, },
], ]
}); );
return id; return id;
} }
@@ -139,166 +157,137 @@ describe("layers", () => {
describe("layer", () => { describe("layer", () => {
it("expand/collapse"); it("expand/collapse");
it("id", () => { it("id", () => {
let bgId = createBackground(); var bgId = createBackground();
when.click("layer-list-item:background:" + bgId); when.click("layer-list-item:background:" + bgId);
let id = uuid(); var id = uuid();
when.setValue("layer-editor.layer-id.input", "foobar:" + id); when.setValue(
get.dataAttribute("layer-editor.layer-id", "input"),
"foobar:" + id
);
when.click("min-zoom"); when.click("min-zoom");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: "foobar:" + id, id: "foobar:" + id,
type: "background", type: "background",
}, },
], ]
}); );
}); });
describe("min-zoom", () => { it("min-zoom", () => {
let bgId: string; var bgId = createBackground();
beforeEach(() => { when.click("layer-list-item:background:" + bgId);
bgId = createBackground(); when.setValue(
when.click("layer-list-item:background:" + bgId); get.dataAttribute("min-zoom", 'input[type="text"]'),
when.setValue("min-zoom.input-text", "1"); "1"
when.click("layer-editor.layer-id"); );
});
it("should update min-zoom in local storage", () => { when.click("layer-editor.layer-id");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [ should.equalStyleStore(
{ (a: any) => a.layers,
id: "background:" + bgId, [
type: "background", {
minzoom: 1, id: "background:" + bgId,
type: "background",
minzoom: 1,
},
]
);
// AND RESET!
// driver.setValue(driver.get.dataAttribute("min-zoom", "input"), "")
// driver.click(driver.get.dataAttribute("max-zoom", "input"));
// driver.isStyleStoreEqual((a: any) => a.layers, [
// {
// "id": 'background:'+bgId,
// "type": 'background'
// }
// ]);
});
it("max-zoom", () => {
var bgId = createBackground();
when.click("layer-list-item:background:" + bgId);
when.setValue(
get.dataAttribute("max-zoom", 'input[type="text"]'),
"1"
);
when.click("layer-editor.layer-id");
should.equalStyleStore(
(a: any) => a.layers,
[
{
id: "background:" + bgId,
type: "background",
maxzoom: 1,
},
]
);
});
it("comments", () => {
var bgId = createBackground();
var id = uuid();
when.click("layer-list-item:background:" + bgId);
when.setValue(get.dataAttribute("layer-comment", "textarea"), id);
when.click("layer-editor.layer-id");
should.equalStyleStore(
(a: any) => a.layers,
[
{
id: "background:" + bgId,
type: "background",
metadata: {
"maputnik:comment": id,
}, },
], },
}); ]
}); );
it("when clicking next layer should update style on local storage", () => { // Unset it again.
when.type("min-zoom.input-text", "{backspace}"); // TODO: This fails
when.click("max-zoom.input-text"); // driver.setValue(driver.getDataAttribute("layer-comment", "textarea"), "");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ // driver.click(driver.getDataAttribute("min-zoom", "input"));
layers: [
{ // driver.isStyleStoreEqual((a: any) => a.layers, [
id: "background:" + bgId, // {
type: "background", // "id": 'background:'+bgId,
minzoom: 1, // "type": 'background'
}, // }
], // ]);
});
});
}); });
describe("max-zoom", () => { it("color", () => {
let bgId: string; var bgId = createBackground();
beforeEach(() => { when.click("layer-list-item:background:" + bgId);
bgId = createBackground();
when.click("layer-list-item:background:" + bgId);
when.setValue("max-zoom.input-text", "1");
when.click("layer-editor.layer-id");
});
it("should update style in local storage", () => { when.click("spec-field:background-color");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [ should.equalStyleStore(
{ (a: any) => a.layers,
id: "background:" + bgId, [
type: "background", {
maxzoom: 1, id: "background:" + bgId,
}, type: "background",
], },
}); ]
}); );
}); });
describe("comments", () => {
let bgId: string;
let comment = "42";
beforeEach(() => {
bgId = createBackground();
when.click("layer-list-item:background:" + bgId);
when.setValue("layer-comment.input", comment);
when.click("layer-editor.layer-id");
});
it("should update style in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [
{
id: "background:" + bgId,
type: "background",
metadata: {
"maputnik:comment": comment,
},
},
],
});
});
describe("when unsetting", () => {
beforeEach(() => {
when.clear("layer-comment.input");
when.click("min-zoom.input-text");
});
it("should update style in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [
{
id: "background:" + bgId,
type: "background",
},
],
});
});
});
});
describe("color", () => {
let bgId: string;
beforeEach(() => {
bgId = createBackground();
when.click("layer-list-item:background:" + bgId);
when.click("spec-field:background-color");
});
it("should update style in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
layers: [
{
id: "background:" + bgId,
type: "background",
},
],
});
});
});
describe("opacity", () => {
let bgId: string;
beforeEach(() => {
bgId = createBackground();
when.click("layer-list-item:background:" + bgId);
when.type("spec-field-input:background-opacity", "0.");
});
it("should keep '.' in the input field", () => {
then(get.elementByTestId("spec-field-input:background-opacity")).shouldHaveValue("0.");
});
it("should revert to a valid value when focus out", () => {
when.click("layer-list-item:background:" + bgId);
then(get.elementByTestId("spec-field-input:background-opacity")).shouldHaveValue('0');
});
});
}); });
describe("filter", () => { describe("filter", () => {
@@ -320,18 +309,18 @@ describe("layers", () => {
// TODO // TODO
it.skip("parse error", () => { it.skip("parse error", () => {
let bgId = createBackground(); var bgId = createBackground();
when.click("layer-list-item:background:" + bgId); when.click("layer-list-item:background:" + bgId);
let errorSelector = ".CodeMirror-lint-marker-error"; var errorSelector = ".CodeMirror-lint-marker-error";
then(get.elementByTestId(errorSelector)).shouldNotExist(); should.notExist(errorSelector);
when.click(".CodeMirror"); when.click(".CodeMirror");
when.typeKeys( when.typeKeys(
"\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013 {" "\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013\uE013 {"
); );
then(get.elementByTestId(errorSelector)).shouldExist(); should.exist(errorSelector);
}); });
}); });
}); });
@@ -339,20 +328,21 @@ describe("layers", () => {
describe("fill", () => { describe("fill", () => {
it("add", () => { it("add", () => {
let id = when.modal.fillLayers({ var id = when.fillLayersModal({
type: "fill", type: "fill",
layer: "example", layer: "example",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: id, id: id,
type: "fill", type: "fill",
source: "example", source: "example",
}, },
], ]
}); );
}); });
// TODO: Change source // TODO: Change source
@@ -361,20 +351,21 @@ describe("layers", () => {
describe("line", () => { describe("line", () => {
it("add", () => { it("add", () => {
let id = when.modal.fillLayers({ var id = when.fillLayersModal({
type: "line", type: "line",
layer: "example", layer: "example",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: id, id: id,
type: "line", type: "line",
source: "example", source: "example",
}, },
], ]
}); );
}); });
it("groups", () => { it("groups", () => {
@@ -385,77 +376,81 @@ describe("layers", () => {
describe("symbol", () => { describe("symbol", () => {
it("add", () => { it("add", () => {
let id = when.modal.fillLayers({ var id = when.fillLayersModal({
type: "symbol", type: "symbol",
layer: "example", layer: "example",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: id, id: id,
type: "symbol", type: "symbol",
source: "example", source: "example",
}, },
], ]
}); );
}); });
}); });
describe("raster", () => { describe("raster", () => {
it("add", () => { it("add", () => {
let id = when.modal.fillLayers({ var id = when.fillLayersModal({
type: "raster", type: "raster",
layer: "raster", layer: "raster",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: id, id: id,
type: "raster", type: "raster",
source: "raster", source: "raster",
}, },
], ]
}); );
}); });
}); });
describe("circle", () => { describe("circle", () => {
it("add", () => { it("add", () => {
let id = when.modal.fillLayers({ var id = when.fillLayersModal({
type: "circle", type: "circle",
layer: "example", layer: "example",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: id, id: id,
type: "circle", type: "circle",
source: "example", source: "example",
}, },
], ]
}); );
}); });
}); });
describe("fill extrusion", () => { describe("fill extrusion", () => {
it("add", () => { it("add", () => {
let id = when.modal.fillLayers({ var id = when.fillLayersModal({
type: "fill-extrusion", type: "fill-extrusion",
layer: "example", layer: "example",
}); });
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({ should.equalStyleStore(
layers: [ (a: any) => a.layers,
[
{ {
id: id, id: id,
type: "fill-extrusion", type: "fill-extrusion",
source: "example", source: "example",
}, },
], ]
}); );
}); });
}); });
@@ -463,35 +458,34 @@ describe("layers", () => {
it("simple", () => { it("simple", () => {
when.setStyle("geojson"); when.setStyle("geojson");
when.modal.open(); when.openLayersModal();
when.modal.fillLayers({ when.fillLayersModal({
id: "foo", id: "foo",
type: "background", type: "background",
}); });
when.modal.open(); when.openLayersModal();
when.modal.fillLayers({ when.fillLayersModal({
id: "foo_bar", id: "foo_bar",
type: "background", type: "background",
}); });
when.modal.open(); when.openLayersModal();
when.modal.fillLayers({ when.fillLayersModal({
id: "foo_bar_baz", id: "foo_bar_baz",
type: "background", type: "background",
}); });
then(get.elementByTestId("layer-list-item:foo")).shouldBeVisible(); should.beVisible("layer-list-item:foo");
then(get.elementByTestId("layer-list-item:foo_bar")).shouldNotBeVisible();
then( should.notBeVisible("layer-list-item:foo_bar");
get.elementByTestId("layer-list-item:foo_bar_baz") should.notBeVisible("layer-list-item:foo_bar_baz");
).shouldNotBeVisible();
when.click("layer-list-group:foo-0"); when.click("layer-list-group:foo-0");
then(get.elementByTestId("layer-list-item:foo")).shouldBeVisible();
then(get.elementByTestId("layer-list-item:foo_bar")).shouldBeVisible(); should.beVisible("layer-list-item:foo");
then( should.beVisible("layer-list-item:foo_bar");
get.elementByTestId("layer-list-item:foo_bar_baz") should.beVisible("layer-list-item:foo_bar_baz");
).shouldBeVisible();
}); });
}); });
}); });
+10 -19
View File
@@ -1,32 +1,23 @@
import { MaputnikDriver } from "./maputnik-driver"; import MaputnikDriver from "./driver";
describe("map", () => { describe("map", () => {
let { beforeAndAfter, get, when, then } = new MaputnikDriver(); let { beforeAndAfter, given, when, get, should } = new MaputnikDriver();
beforeAndAfter(); beforeAndAfter();
describe("zoom level", () => { describe("zoom level", () => {
it("via url", () => { it("via url", () => {
let zoomLevel = 12.37; var zoomLevel = 12.37;
when.setStyle("geojson", zoomLevel); when.setStyle("geojson", zoomLevel);
then(get.elementByTestId("maplibre:ctrl-zoom")).shouldBeVisible(); should.beVisible("maplibre:ctrl-zoom");
then(get.elementByTestId("maplibre:ctrl-zoom")).shouldContainText( should.containText("maplibre:ctrl-zoom", "Zoom: " + zoomLevel);
"Zoom: " + zoomLevel
);
}); });
it("via map controls", () => { it("via map controls", () => {
let zoomLevel = 12.37; var zoomLevel = 12.37;
when.setStyle("geojson", zoomLevel); when.setStyle("geojson", zoomLevel);
then(get.elementByTestId("maplibre:ctrl-zoom")).shouldBeVisible();
when.clickZoomIn(); should.beVisible("maplibre:ctrl-zoom");
then(get.elementByTestId("maplibre:ctrl-zoom")).shouldContainText( when.clickZoomin();
"Zoom: " + (zoomLevel + 1) should.containText("maplibre:ctrl-zoom", "Zoom: "+(zoomLevel + 1));
);
});
});
describe("search", () => {
it('should exist', () => {
then(get.searchControl()).shouldBeVisible();
}); });
}); });
}); });
-19
View File
@@ -1,19 +0,0 @@
import { CypressHelper } from "@shellygo/cypress-test-utils";
export default class MaputnikCypressHelper {
private helper = new CypressHelper({ defaultDataAttribute: "data-wd-key" });
public given = {
...this.helper.given,
};
public get = {
...this.helper.get,
};
public when = {
...this.helper.when,
};
public beforeAndAfter = this.helper.beforeAndAfter;
}
-186
View File
@@ -1,186 +0,0 @@
/// <reference types="cypress-plugin-tab" />
import { CypressHelper } from "@shellygo/cypress-test-utils";
import { Assertable, then } from "@shellygo/cypress-test-utils/assertable";
import MaputnikCypressHelper from "./maputnik-cypress-helper";
import ModalDriver from "./modal-driver";
const baseUrl = "http://localhost:8888/";
const styleFromWindow = (win: Window) => {
const styleId = win.localStorage.getItem("maputnik:latest_style");
const styleItem = win.localStorage.getItem(`maputnik:style:${styleId}`);
const obj = JSON.parse(styleItem || "");
return obj;
};
export class MaputnikAssertable<T> extends Assertable<T> {
shouldEqualToStoredStyle = () =>
then(
new CypressHelper().get.window().then((win: Window) => {
const style = styleFromWindow(win);
then(this.chainable).shouldDeepNestedInclude(style);
})
);
}
export class MaputnikDriver {
private helper = new MaputnikCypressHelper();
private modalDriver = new ModalDriver();
public beforeAndAfter = () => {
beforeEach(() => {
this.given.setupMockBackedResponses();
this.when.setStyle("both");
});
};
public then = (chainable: Cypress.Chainable<any>) =>
new MaputnikAssertable(chainable);
public given = {
...this.helper.given,
setupMockBackedResponses: () => {
this.helper.given.interceptAndMockResponse({
method: "GET",
url: baseUrl + "example-style.json",
response: {
fixture: "example-style.json",
},
alias: "example-style.json",
});
this.helper.given.interceptAndMockResponse({
method: "GET",
url: baseUrl + "example-layer-style.json",
response: {
fixture: "example-layer-style.json",
},
});
this.helper.given.interceptAndMockResponse({
method: "GET",
url: baseUrl + "geojson-style.json",
response: {
fixture: "geojson-style.json",
},
});
this.helper.given.interceptAndMockResponse({
method: "GET",
url: baseUrl + "raster-style.json",
response: {
fixture: "raster-style.json",
},
});
this.helper.given.interceptAndMockResponse({
method: "GET",
url: baseUrl + "geojson-raster-style.json",
response: {
fixture: "geojson-raster-style.json",
},
});
this.helper.given.interceptAndMockResponse({
method: "GET",
url: "*example.local/*",
response: [],
});
this.helper.given.interceptAndMockResponse({
method: "GET",
url: "*example.com/*",
response: [],
});
},
};
public when = {
...this.helper.when,
modal: this.modalDriver.when,
within: (selector: string, fn: () => void) => {
this.helper.when.within(fn, selector);
},
tab: () => this.helper.get.element("body").tab(),
waitForExampleFileResponse: () => {
this.helper.when.waitForResponse("example-style.json");
},
chooseExampleFile: () => {
this.helper.get
.bySelector("type", "file")
.selectFile("cypress/fixtures/example-style.json", { force: true });
},
setStyle: (
styleProperties: "geojson" | "raster" | "both" | "layer" | "",
zoom?: number
) => {
let url = "?debug";
switch (styleProperties) {
case "geojson":
url += `&style=${baseUrl}geojson-style.json`;
break;
case "raster":
url += `&style=${baseUrl}raster-style.json`;
break;
case "both":
url += `&style=${baseUrl}geojson-raster-style.json`;
break;
case "layer":
url += `&style=${baseUrl}/example-layer-style.json`;
break;
}
if (zoom) {
url += `#${zoom}/41.3805/2.1635`;
}
this.helper.when.visit(baseUrl + url);
if (styleProperties) {
this.helper.when.acceptConfirm();
}
// when methods should not include assertions
const toolbarLink = this.helper.get.elementByTestId("toolbar:link")
toolbarLink.scrollIntoView();
toolbarLink.should("be.visible");
},
typeKeys: (keys: string) => this.helper.get.element("body").type(keys),
clickZoomIn: () => {
this.helper.get.element(".maplibregl-ctrl-zoom-in").click();
},
selectWithin: (selector: string, value: string) => {
this.when.within(selector, () => {
this.helper.get.element("select").select(value);
});
},
select: (selector: string, value: string) => {
this.helper.get.elementByTestId(selector).select(value);
},
focus: (selector: string) => {
this.helper.when.focus(selector);
},
setValue: (selector: string, text: string) => {
this.helper.get
.elementByTestId(selector)
.clear()
.type(text, { parseSpecialCharSequences: false });
},
};
public get = {
...this.helper.get,
isMac: () => {
return Cypress.platform === "darwin";
},
styleFromLocalStorage: () =>
this.helper.get.window().then((win) => styleFromWindow(win)),
exampleFileUrl: () => {
return baseUrl + "example-style.json";
},
skipTargetLayerList: () =>
this.helper.get.elementByTestId("skip-target-layer-list"),
skipTargetLayerEditor: () =>
this.helper.get.elementByTestId("skip-target-layer-editor"),
canvas: () => this.helper.get.element("canvas"),
searchControl: () => this.helper.get.element('.maplibregl-ctrl-geocoder')
};
}
-40
View File
@@ -1,40 +0,0 @@
import { v1 as uuid } from "uuid";
import MaputnikCypressHelper from "./maputnik-cypress-helper";
export default class ModalDriver {
private helper = new MaputnikCypressHelper();
public when = {
fillLayers: (opts: { type: string; layer?: string; id?: string }) => {
// Having logic in test code is an anti pattern.
// This should be splitted to multiple single responsibility functions
let type = opts.type;
let layer = opts.layer;
let id;
if (opts.id) {
id = opts.id;
} else {
id = `${type}:${uuid()}`;
}
this.helper.when.selectOption("add-layer.layer-type.select", type);
this.helper.when.type("add-layer.layer-id.input", id);
if (layer) {
this.helper.when.within(() => {
this.helper.get.element("input").type(layer!);
}, "add-layer.layer-source-block");
}
this.helper.when.click("add-layer");
return id;
},
open: () => {
this.helper.when.click("layer-list:add-layer");
},
close: (key: string) => {
this.helper.when.click(key + ".close-modal");
},
};
}
+64 -83
View File
@@ -1,9 +1,8 @@
import { MaputnikDriver } from "./maputnik-driver"; import MaputnikDriver from "./driver";
describe("modals", () => { describe("modals", () => {
let { beforeAndAfter, when, get, then } = new MaputnikDriver(); let { beforeAndAfter, given, when, get, should } = new MaputnikDriver();
beforeAndAfter(); beforeAndAfter();
beforeEach(() => { beforeEach(() => {
when.setStyle(""); when.setStyle("");
}); });
@@ -13,27 +12,25 @@ describe("modals", () => {
}); });
it("close", () => { it("close", () => {
when.modal.close("modal:open"); when.closeModal("modal:open");
then(get.elementByTestId("modal:open")).shouldNotExist(); should.notExist("modal:open");
}); });
it.skip("upload", () => { it.skip("upload", () => {
// HM: I was not able to make the following choose file actually to select a file and close the modal... // HM: I was not able to make the following choose file actually to select a file and close the modal...
when.chooseExampleFile(); when.chooseExampleFile();
then(get.responseBody("example-style.json")).shouldEqualToStoredStyle();
should.styleStoreEqualToExampleFileData();
}); });
describe("when click open url", () => { it("load from url", () => {
beforeEach(() => { var styleFileUrl = get.exampleFileUrl();
let styleFileUrl = get.exampleFileUrl();
when.setValue("modal:open.url.input", styleFileUrl); when.setValue(get.dataAttribute("modal:open.url.input"), styleFileUrl);
when.click("modal:open.url.button"); when.click("modal:open.url.button");
when.wait(200); when.waitForExampleFileRequset();
});
it("load from url", () => { should.styleStoreEqualToExampleFileData();
then(get.responseBody("example-style.json")).shouldEqualToStoredStyle();
});
}); });
}); });
@@ -41,8 +38,8 @@ describe("modals", () => {
it("open/close", () => { it("open/close", () => {
when.setStyle(""); when.setStyle("");
when.typeKeys("?"); when.typeKeys("?");
when.modal.close("modal:shortcuts"); when.closeModal("modal:shortcuts");
then(get.elementByTestId("modal:shortcuts")).shouldNotExist(); should.notExist("modal:shortcuts");
}); });
}); });
@@ -52,8 +49,8 @@ describe("modals", () => {
}); });
it("close", () => { it("close", () => {
when.modal.close("modal:export"); when.closeModal("modal:export");
then(get.elementByTestId("modal:export")).shouldNotExist(); should.notExist("modal:export");
}); });
// TODO: Work out how to download a file and check the contents // TODO: Work out how to download a file and check the contents
@@ -68,9 +65,9 @@ describe("modals", () => {
describe("inspect", () => { describe("inspect", () => {
it("toggle", () => { it("toggle", () => {
// There is no assertion in this test
when.setStyle("geojson"); when.setStyle("geojson");
when.select("maputnik-select", "inspect");
when.selectWithin("nav:inspect", "inspect");
}); });
}); });
@@ -79,98 +76,82 @@ describe("modals", () => {
when.click("nav:settings"); when.click("nav:settings");
}); });
describe("when click name filed spec information", () => { it("name", () => {
beforeEach(() => { when.click("field-doc-button-Name");
when.click("field-doc-button-Name");
});
it("should show the spec information", () => { should.containText("spec-field-doc", "name for the style");
then(get.elementsText("spec-field-doc")).shouldInclude(
"name for the style"
);
});
}); });
describe("when set name and click owner", () => { it("show name specifications", () => {
beforeEach(() => { when.setValue(get.dataAttribute("modal:settings.name"), "foobar");
when.setValue("modal:settings.name", "foobar"); when.click("modal:settings.owner");
when.click("modal:settings.owner");
when.wait(200);
});
it("show name specifications", () => { should.equalStyleStore((obj) => obj.name, "foobar");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
name: "foobar",
});
});
}); });
describe("when set owner and click name", () => { it("owner", () => {
beforeEach(() => { when.setValue(get.dataAttribute("modal:settings.owner"), "foobar");
when.setValue("modal:settings.owner", "foobar");
when.click("modal:settings.name");
when.wait(200);
});
it("should update owner in local storage", () => {
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
owner: "foobar",
});
});
});
it("sprite url", () => {
when.setValue("modal:settings.sprite", "http://example.com");
when.click("modal:settings.name"); when.click("modal:settings.name");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
sprite: "http://example.com", should.equalStyleStore((obj) => obj.owner, "foobar");
}); });
it("sprite url", () => {
when.setValue(
get.dataAttribute("modal:settings.sprite"),
"http://example.com"
);
when.click("modal:settings.name");
should.equalStyleStore((obj) => obj.sprite, "http://example.com");
}); });
it("glyphs url", () => { it("glyphs url", () => {
let glyphsUrl = "http://example.com/{fontstack}/{range}.pbf"; var glyphsUrl = "http://example.com/{fontstack}/{range}.pbf";
when.setValue("modal:settings.glyphs", glyphsUrl); when.setValue(get.dataAttribute("modal:settings.glyphs"), glyphsUrl);
when.click("modal:settings.name"); when.click("modal:settings.name");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
glyphs: glyphsUrl, should.equalStyleStore((obj) => obj.glyphs, glyphsUrl);
});
}); });
it("maptiler access token", () => { it("maptiler access token", () => {
let apiKey = "testing123"; var apiKey = "testing123";
when.setValue( when.setValue(
"modal:settings.maputnik:openmaptiles_access_token", get.dataAttribute(
"modal:settings.maputnik:openmaptiles_access_token"
),
apiKey apiKey
); );
when.click("modal:settings.name"); when.click("modal:settings.name");
then(
get.styleFromLocalStorage().then((style) => style.metadata) should.equalStyleStore(
).shouldInclude({ (obj) => obj.metadata["maputnik:openmaptiles_access_token"],
"maputnik:openmaptiles_access_token": apiKey, apiKey
}); );
}); });
it("thunderforest access token", () => { it("thunderforest access token", () => {
let apiKey = "testing123"; var apiKey = "testing123";
when.setValue( when.setValue(
"modal:settings.maputnik:thunderforest_access_token", get.dataAttribute(
"modal:settings.maputnik:thunderforest_access_token"
),
apiKey apiKey
); );
when.click("modal:settings.name"); when.click("modal:settings.name");
then(
get.styleFromLocalStorage().then((style) => style.metadata) should.equalStyleStore(
).shouldInclude({ "maputnik:thunderforest_access_token": apiKey }); (obj) => obj.metadata["maputnik:thunderforest_access_token"],
apiKey
);
}); });
it("style renderer", () => { it("style renderer", () => {
cy.on("uncaught:exception", () => false); // this is due to the fact that this is an invalid style for openlayers cy.on("uncaught:exception", () => false); // this is due to the fact that this is an invalid style for openlayers
when.select("modal:settings.maputnik:renderer", "ol"); when.select("modal:settings.maputnik:renderer", "ol");
then(get.inputValue("modal:settings.maputnik:renderer")).shouldEqual( should.beSelected("modal:settings.maputnik:renderer", "ol");
"ol"
);
when.click("modal:settings.name"); when.click("modal:settings.name");
then(get.styleFromLocalStorage()).shouldDeepNestedInclude({
metadata: { "maputnik:renderer": "ol" }, should.equalStyleStore((obj) => obj.metadata["maputnik:renderer"], "ol");
});
}); });
}); });
-31
View File
@@ -1,31 +0,0 @@
# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.o
*.a
*.so
# Folders
_obj
_test
editor
# Architecture specific extensions/prefixes
*.[568vq]
[568vq].out
*.cgo1.go
*.cgo2.c
_cgo_defun.c
_cgo_gotypes.go
_cgo_export.*
_testmain.go
*.exe
*.test
*.prof
# Binary version of pubilic/editor
rice-box.go
# Built binary
maputnik
-21
View File
@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2016 Maputnik
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-39
View File
@@ -1,39 +0,0 @@
SOURCEDIR=.
SOURCES := $(shell find $(SOURCEDIR) -name '*.go')
BINARY=maputnik
DESKTOP_VERSION := 1.1.1
EDITOR_VERSION := $(shell node -p "require('../package.json').version")
GOPATH := $(if $(GOPATH),$(GOPATH),$(HOME)/go)
GOBIN := $(if $(GOBIN),$(GOBIN),$(HOME)/go/bin)
all: $(BINARY)
$(BINARY): $(GOBIN)/gox $(SOURCES) version.go rice-box.go
$(GOBIN)/gox -osarch "windows/amd64 linux/amd64 darwin/amd64" -output "bin/{{.OS}}/${BINARY}"
# Copy the current release into ./editor/maputnik so it can be
# embedded in the binary
editor/pull_release:
mkdir -p editor
cp -r ../dist/* editor
$(GOBIN)/gox:
go install github.com/mitchellh/gox@v1.0.1
$(GOBIN)/rice:
go install github.com/GeertJohan/go.rice/rice@v1.0.3
# Embed the current version numbers in the executable by writing version.go
.PHONY: version.go
version.go:
@echo "// DO NOT EDIT: Autogenerated by Makefile\n" > version.go
@echo "package main\n" >> version.go
@echo "const DesktopVersion = \"$(DESKTOP_VERSION)\"" >> version.go
@echo "const EditorVersion = \"$(EDITOR_VERSION)\"" >> version.go
rice-box.go: $(GOBIN)/rice editor/pull_release
$(GOBIN)/rice embed-go
.PHONY: clean
clean:
rm -rf editor && rm -f rice-box.go && rm -rf bin
-72
View File
@@ -1,72 +0,0 @@
# Maputnik Desktop [![GitHub CI status](https://github.com/maplibre/maputnik/workflows/ci/badge.svg)][github-action-ci]
---
A Golang based cross platform executable for integrating Maputnik locally.
This binary packages up the JavaScript and CSS bundle produced by maputnik
and embeds it in the program for easy distribution. It also allows
exposing a local style file and work on it both in Maputnik and with your favorite
editor.
Report issues on [maplibre/maputnik](https://github.com/maplibre/maputnik).
## Install
You can download a single binary for Linux, OSX or Windows from [the latest releases of **maplibre/maputnik**](https://github.com/maplibre/maputnik/editor/releases/latest).
### Usage
Simply start up a web server and access the Maputnik editor GUI at `localhost:8000`.
```bash
maputnik
```
Expose a local style file to Maputnik allowing the web based editor
to save to the local filesystem.
```bash
maputnik --file basic-v9.json
```
Watch the local style for changes and inform the editor via web socket.
This makes it possible to edit the style with a local text editor and still
use Maputnik.
```bash
maputnik --watch --file basic-v9.json
```
Choose a local port to listen on, instead of using the default port 8000.
```bash
maputnik --port 8001
```
Specify a path to a directory which, if it exists, will be served under http://localhost:8000/static/ .
Could be used to serve sprites and glyphs.
```bash
maputnik --static ./localFolder
```
### API
`maputnik` exposes the configured styles via a HTTP API.
| Method | Description
|---------------------------------|---------------------------------------
| `GET /styles` | List the ID of all configured style files
| `GET /styles/{filename}` | Get contents of a single style file
| `PUT /styles/{filename}` | Update contents of a style file
| `WEBSOCKET /ws` | Listen to change events for the configured style files
### Build
From the root of the [maplibre/maputnik](https://github.com/maplibre/maputnik) project, install the deps and run the desktop-build command.
```
npm install
npm run build-desktop
```
You should now find the `maputnik` binary in your `bin` directory.
-81
View File
@@ -1,81 +0,0 @@
package main
import (
"bytes"
"encoding/json"
"fmt"
"io/ioutil"
"log"
"net/http"
"github.com/gorilla/mux"
)
func StyleFileAccessor(filename string) styleFileAccessor {
return styleFileAccessor{filename, styleId(filename)}
}
func styleId(filename string) string {
raw, err := ioutil.ReadFile(filename)
if err != nil {
log.Panicln(err)
}
var spec styleSpec
err = json.Unmarshal(raw, &spec)
if err != nil {
log.Panicln(err)
}
if spec.Id == "" {
fmt.Println("No id in style")
}
return spec.Id
}
type styleSpec struct {
Id string `json:"id"`
}
// Allows access to a single style file
type styleFileAccessor struct {
filename string
id string
}
func (fa styleFileAccessor) ListFiles(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
encoder := json.NewEncoder(w)
encoder.Encode([]string{fa.id})
}
func (fa styleFileAccessor) ReadFile(w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
_ = vars["styleId"]
//TODO: Choose right file
// right now we just return the single file we know of
w.Header().Set("Content-Type", "application/json")
raw, err := ioutil.ReadFile(fa.filename)
if err != nil {
log.Panicln(err)
}
w.Write(raw)
}
func (fa styleFileAccessor) SaveFile(w http.ResponseWriter, r *http.Request) {
vars := mux.Vars(r)
_ = vars["styleId"]
//TODO: Save to right file
w.Header().Set("Content-Type", "application/json")
body, _ := ioutil.ReadAll(r.Body)
var out bytes.Buffer
json.Indent(&out, body, "", " ")
if err := ioutil.WriteFile(fa.filename, out.Bytes(), 0666); err != nil {
log.Fatalf("Can not copy from request to file: %s", err.Error())
}
}
-69
View File
@@ -1,69 +0,0 @@
package filewatch
import (
"io/ioutil"
"log"
"net/http"
"github.com/fsnotify/fsnotify"
"github.com/gorilla/websocket"
)
var upgrader = websocket.Upgrader{
ReadBufferSize: 1024,
WriteBufferSize: 1024,
CheckOrigin: func(r *http.Request) bool { return true },
}
func writer(ws *websocket.Conn, filename string) {
watcher, err := fsnotify.NewWatcher()
if err != nil {
log.Fatal(err)
}
defer watcher.Close()
done := make(chan bool)
go func() {
for {
select {
case event := <-watcher.Events:
if event.Op&fsnotify.Write == fsnotify.Write {
log.Println("Modified file:", event.Name)
var p []byte
var err error
p, err = ioutil.ReadFile(filename)
if err != nil {
log.Fatal(err)
}
if p != nil {
if err := ws.WriteMessage(websocket.TextMessage, p); err != nil {
return
}
}
}
case err := <-watcher.Errors:
log.Println("Watch error:", err)
}
}
}()
if err = watcher.Add(filename); err != nil {
log.Fatal(err)
}
<-done
}
func ServeWebsocketFileWatcher(filename string, w http.ResponseWriter, r *http.Request) {
ws, err := upgrader.Upgrade(w, r, nil)
if err != nil {
if _, ok := err.(websocket.HandshakeError); !ok {
log.Println(err)
}
return
}
writer(ws, filename)
defer ws.Close()
}
-27
View File
@@ -1,27 +0,0 @@
module maputnik/desktop
go 1.19
require (
github.com/GeertJohan/go.rice v1.0.3
github.com/fsnotify/fsnotify v1.6.0
github.com/gorilla/handlers v1.5.1
github.com/gorilla/mux v1.8.0
github.com/gorilla/websocket v1.5.0
github.com/maputnik/desktop v1.0.7
github.com/urfave/cli v1.22.12
)
require (
github.com/GeertJohan/go.incremental v1.0.0 // indirect
github.com/akavel/rsrc v0.8.0 // indirect
github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
github.com/daaku/go.zipexe v1.0.2 // indirect
github.com/felixge/httpsnoop v1.0.1 // indirect
github.com/jessevdk/go-flags v1.4.0 // indirect
github.com/nkovacs/streamquote v1.0.0 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/valyala/bytebufferpool v1.0.0 // indirect
github.com/valyala/fasttemplate v1.0.1 // indirect
golang.org/x/sys v0.0.0-20220908164124-27713097b956 // indirect
)
-54
View File
@@ -1,54 +0,0 @@
github.com/BurntSushi/toml v1.2.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
github.com/GeertJohan/go.incremental v1.0.0 h1:7AH+pY1XUgQE4Y1HcXYaMqAI0m9yrFqo/jt0CW30vsg=
github.com/GeertJohan/go.incremental v1.0.0/go.mod h1:6fAjUhbVuX1KcMD3c8TEgVUqmo4seqhv0i0kdATSkM0=
github.com/GeertJohan/go.rice v1.0.3 h1:k5viR+xGtIhF61125vCE1cmJ5957RQGXG6dmbaWZSmI=
github.com/GeertJohan/go.rice v1.0.3/go.mod h1:XVdrU4pW00M4ikZed5q56tPf1v2KwnIKeIdc9CBYNt4=
github.com/akavel/rsrc v0.8.0 h1:zjWn7ukO9Kc5Q62DOJCcxGpXC18RawVtYAGdz2aLlfw=
github.com/akavel/rsrc v0.8.0/go.mod h1:uLoCtb9J+EyAqh+26kdrTgmzRBFPGOolLWKpdxkKq+c=
github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/daaku/go.zipexe v1.0.2 h1:Zg55YLYTr7M9wjKn8SY/WcpuuEi+kR2u4E8RhvpyXmk=
github.com/daaku/go.zipexe v1.0.2/go.mod h1:5xWogtqlYnfBXkSB1o9xysukNP9GTvaNkqzUZbt3Bw8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/felixge/httpsnoop v1.0.1 h1:lvB5Jl89CsZtGIWuTcDM1E/vkVs49/Ml7JJe07l8SPQ=
github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
github.com/fsnotify/fsnotify v1.6.0 h1:n+5WquG0fcWoWp6xPWfHdbskMCQaFnG6PfBrh1Ky4HY=
github.com/fsnotify/fsnotify v1.6.0/go.mod h1:sl3t1tCWJFWoRz9R8WJCbQihKKwmorjAbSClcnxKAGw=
github.com/gorilla/handlers v1.5.1 h1:9lRY6j8DEeeBT10CvO9hGW0gmky0BprnvDI5vfhUHH4=
github.com/gorilla/handlers v1.5.1/go.mod h1:t8XrUpc4KVXb7HGyJ4/cEnwQiaxrX/hz1Zv/4g96P1Q=
github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/jessevdk/go-flags v1.4.0 h1:4IU2WS7AumrZ/40jfhf4QVDMsQwqA7VEHozFRrGARJA=
github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
github.com/maputnik/desktop v1.0.7 h1:rdFg7emIJOT3YsZpwqSChmWtMOvu+T4h6WwVQAZP9n4=
github.com/maputnik/desktop v1.0.7/go.mod h1:wmDjHUztx9jOBz0I22589yWguAGdV/sEM57YANpN8oQ=
github.com/nkovacs/streamquote v1.0.0 h1:PmVIV08Zlx2lZK5fFZlMZ04eHcDTIFJCv/5/0twVUow=
github.com/nkovacs/streamquote v1.0.0/go.mod h1:BN+NaZ2CmdKqUuTUXUEm9j95B2TRbpOWpxbJYzzgUsc=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/urfave/cli v1.22.12 h1:igJgVw1JdKH+trcLWLeLwZjU9fEfPesQ+9/e4MQ44S8=
github.com/urfave/cli v1.22.12/go.mod h1:sSBEIC79qR6OvcmsD4U3KABeOTxDqQtdDnaFuUN30b8=
github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
github.com/valyala/fasttemplate v1.0.1 h1:tY9CJiPnMXf1ERmG2EyK7gNUd+c6RKGD0IfU8WdUSz8=
github.com/valyala/fasttemplate v1.0.1/go.mod h1:UQGH1tvbgY+Nz5t2n7tXsz52dQxojPUpymEIMZ47gx8=
golang.org/x/sys v0.0.0-20220908164124-27713097b956 h1:XeJjHH1KiLpKGb6lvMiksZ9l0fVUh+AmGcm0nOMEBOY=
golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-80
View File
@@ -1,80 +0,0 @@
package main
import (
"fmt"
"net/http"
"os"
"path/filepath"
"github.com/GeertJohan/go.rice"
"github.com/gorilla/handlers"
"github.com/gorilla/mux"
"github.com/maputnik/desktop/filewatch"
"github.com/urfave/cli"
)
func main() {
app := cli.NewApp()
app.Name = "maputnik"
app.Usage = "Server for integrating Maputnik locally"
app.Version = "Editor: " + EditorVersion + "; Desktop: " + DesktopVersion
app.Flags = []cli.Flag{
&cli.StringFlag{
Name: "file, f",
Usage: "Allow access to JSON style from web client",
},
&cli.BoolFlag{
Name: "watch",
Usage: "Notify web client about JSON style file changes",
},
&cli.IntFlag{
Name: "port",
Value: 8000,
Usage: "TCP port to listen on",
},
&cli.StringFlag{
Name: "static",
Usage: "Serve directory under /static/",
},
}
app.Action = func(c *cli.Context) error {
gui := http.FileServer(rice.MustFindBox("editor").HTTPBox())
router := mux.NewRouter().StrictSlash(true)
filename := c.String("file")
if filename != "" {
fmt.Printf("%s is accessible via Maputnik\n", filename)
// Allow access to reading and writing file on the local system
path, _ := filepath.Abs(filename)
accessor := StyleFileAccessor(path)
router.Path("/styles").Methods("GET").HandlerFunc(accessor.ListFiles)
router.Path("/styles/{styleId}").Methods("GET").HandlerFunc(accessor.ReadFile)
router.Path("/styles/{styleId}").Methods("PUT").HandlerFunc(accessor.SaveFile)
// Register websocket to notify we clients about file changes
if c.Bool("watch") {
router.Path("/ws").HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
filewatch.ServeWebsocketFileWatcher(filename, w, r)
})
}
}
staticDir := c.String("static")
if staticDir != "" {
h := http.StripPrefix("/static/", http.FileServer(http.Dir(staticDir)))
router.PathPrefix("/static/").Handler(h)
}
router.PathPrefix("/").Handler(http.StripPrefix("/", gui))
loggedRouter := handlers.LoggingHandler(os.Stdout, router)
corsRouter := handlers.CORS(handlers.AllowedHeaders([]string{"Content-Type"}), handlers.AllowedMethods([]string{"GET", "PUT"}), handlers.AllowedOrigins([]string{"*"}), handlers.AllowCredentials())(loggedRouter)
fmt.Printf("Exposing Maputnik on http://localhost:%d\n", c.Int("port"))
return http.ListenAndServe(fmt.Sprintf(":%d", c.Int("port")), corsRouter)
}
app.Run(os.Args)
}
-17
View File
@@ -1,17 +0,0 @@
export default {
output: 'src/locales/$LOCALE/$NAMESPACE.json',
locales: [ 'ja', 'he','zh' ],
// Because some keys are dynamically generated, i18next-parser can't detect them.
// We add these keys manually, so we don't want to remove them.
keepRemoved: true,
// We use plain English keys, so we disable key and namespace separators.
keySeparator: false,
namespaceSeparator: false,
defaultValue: (locale, ns, key) => {
// The default value is a string that indicates that the string is not translated.
return '__STRING_NOT_TRANSLATED__';
}
}
Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

+8280 -3450
View File
File diff suppressed because it is too large Load Diff
+57 -67
View File
@@ -1,49 +1,38 @@
{ {
"name": "maputnik", "name": "maputnik",
"version": "2.1.0", "version": "2.0.0-pre.2",
"description": "A MapLibre GL visual style editor", "description": "A MapLibre GL visual style editor",
"type": "module",
"main": "''", "main": "''",
"scripts": { "scripts": {
"start": "vite", "start": "vite",
"build": "tsc && vite build --base=/maputnik/", "build": "tsc && vite build",
"build-desktop": "tsc && vite build --base=/ && cd desktop && make", "lint": "eslint ./src --ext ts,tsx,js,jsx --report-unused-disable-directives --max-warnings 0 && npm run lint-css",
"i18n:refresh": "i18next 'src/**/*.{ts,tsx,js,jsx}'",
"lint": "eslint ./src ./cypress --ext ts,tsx,js,jsx --report-unused-disable-directives --max-warnings 0",
"test": "cypress run", "test": "cypress run",
"cy:open": "cypress open", "cy:open": "cypress open",
"lint-css": "stylelint \"src/styles/*.scss\"", "lint-css": "stylelint \"src/styles/*.scss\"",
"sort-styles": "jq 'sort_by(.id)' src/config/styles.json > tmp.json && mv tmp.json src/config/styles.json" "storybook": "storybook dev -h 0.0.0.0 -p 6006",
"build-storybook": "storybook build -o build/storybook"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/maplibre/maputnik" "url": "https://github.com/maputnik/editor"
}, },
"author": "Lukas Martinelli", "author": "Lukas Martinelli",
"license": "MIT", "license": "MIT",
"homepage": "https://github.com/maplibre/maputnik#readme", "homepage": "https://github.com/maputnik/editor#readme",
"dependencies": { "dependencies": {
"@mapbox/mapbox-gl-rtl-text": "^0.2.3", "@mapbox/mapbox-gl-rtl-text": "^0.2.3",
"@maplibre/maplibre-gl-geocoder": "^1.6.0", "@maplibre/maplibre-gl-style-spec": "^17.0.1",
"@maplibre/maplibre-gl-inspect": "^1.6.3", "@mdi/js": "^6.6.96",
"@maplibre/maplibre-gl-style-spec": "^20.1.1", "@mdi/react": "^1.5.0",
"@mdi/js": "^7.4.47",
"@mdi/react": "^1.6.1",
"@typescript-eslint/eslint-plugin": "^7.3.1",
"@typescript-eslint/parser": "^7.3.1",
"array-move": "^4.0.0", "array-move": "^4.0.0",
"buffer": "^6.0.3", "buffer": "^6.0.3",
"classnames": "^2.5.1", "classnames": "^2.3.1",
"codemirror": "^5.65.2", "codemirror": "^5.65.2",
"color": "^4.2.3", "color": "^4.2.3",
"cypress-plugin-tab": "^1.0.5",
"detect-browser": "^5.3.0", "detect-browser": "^5.3.0",
"events": "^3.3.0",
"file-saver": "^2.0.5", "file-saver": "^2.0.5",
"i18next": "^23.12.2", "json-stringify-pretty-compact": "^3.0.0",
"i18next-browser-languagedetector": "^8.0.0",
"i18next-resources-to-backend": "^1.2.1",
"json-stringify-pretty-compact": "^4.0.0",
"json-to-ast": "^2.1.0", "json-to-ast": "^2.1.0",
"jsonlint": "github:josdejong/jsonlint#85a19d7", "jsonlint": "github:josdejong/jsonlint#85a19d7",
"lodash": "^4.17.21", "lodash": "^4.17.21",
@@ -53,30 +42,30 @@
"lodash.get": "^4.4.2", "lodash.get": "^4.4.2",
"lodash.isequal": "^4.5.0", "lodash.isequal": "^4.5.0",
"lodash.throttle": "^4.1.1", "lodash.throttle": "^4.1.1",
"maplibre-gl": "^4.1.2", "mapbox-gl-inspect": "^1.3.1",
"maplibre-gl": "^2.4.0",
"maputnik-design": "github:maputnik/design#172b06c", "maputnik-design": "github:maputnik/design#172b06c",
"ol": "^6.14.1", "ol": "^6.14.1",
"ol-mapbox-style": "^7.1.1", "ol-mapbox-style": "^7.1.1",
"prop-types": "^15.8.1", "prop-types": "^15.8.1",
"react": "^18.2.0", "react": "^16.0.0",
"react-accessible-accordion": "^5.0.0", "react-accessible-accordion": "^4.0.0",
"react-aria-menubutton": "^7.0.3", "react-aria-menubutton": "^7.0.3",
"react-aria-modal": "^5.0.2", "react-aria-modal": "^4.0.1",
"react-autobind": "^1.0.6", "react-autobind": "^1.0.6",
"react-autocomplete": "^1.8.1", "react-autocomplete": "^1.8.1",
"react-collapse": "^5.1.1", "react-collapse": "^5.1.1",
"react-color": "^2.19.3", "react-color": "^2.19.3",
"react-dom": "^18.2.0", "react-dom": "^16.0.0",
"react-file-reader-input": "^2.0.0", "react-file-reader-input": "^2.0.0",
"react-i18next": "^15.0.1",
"react-icon-base": "^2.1.2", "react-icon-base": "^2.1.2",
"react-icons": "^5.0.1", "react-icons": "^4.3.1",
"react-sortable-hoc": "^2.0.0", "react-sortable-hoc": "^2.0.0",
"reconnecting-websocket": "^4.4.0", "reconnecting-websocket": "^4.4.0",
"sass": "^1.72.0", "sass": "^1.50.0",
"slugify": "^1.6.6", "slugify": "^1.6.5",
"string-hash": "^1.1.3", "string-hash": "^1.1.3",
"url": "^0.11.3" "url": "^0.11.0"
}, },
"jshintConfig": { "jshintConfig": {
"esversion": 6 "esversion": 6
@@ -96,54 +85,55 @@
} }
}, },
"devDependencies": { "devDependencies": {
"@cypress/code-coverage": "^3.12.30", "@cypress/code-coverage": "^3.12.15",
"@istanbuljs/nyc-config-typescript": "^1.0.2", "@istanbuljs/nyc-config-typescript": "^1.0.2",
"@rollup/plugin-replace": "^5.0.5", "@rollup/plugin-replace": "^5.0.5",
"@shellygo/cypress-test-utils": "^2.1.9", "@shellygo/cypress-test-utils": "^2.0.9",
"@storybook/addon-a11y": "^7.6.5",
"@storybook/addon-actions": "^7.6.5",
"@storybook/addon-links": "^7.6.5",
"@storybook/addon-storysource": "^7.6.5",
"@storybook/addons": "^7.6.5",
"@storybook/builder-vite": "^7.6.5",
"@storybook/react": "^7.6.5",
"@storybook/react-vite": "^7.6.5",
"@storybook/theming": "^7.6.5",
"@types/codemirror": "^5.60.15", "@types/codemirror": "^5.60.15",
"@types/color": "^3.0.6", "@types/color": "^3.0.6",
"@types/cors": "^2.8.17", "@types/cors": "^2.8.17",
"@types/file-saver": "^2.0.7", "@types/file-saver": "^2.0.7",
"@types/geojson": "^7946.0.14",
"@types/json-to-ast": "^2.1.4",
"@types/lodash.capitalize": "^4.2.9", "@types/lodash.capitalize": "^4.2.9",
"@types/lodash.clamp": "^4.0.9",
"@types/lodash.clonedeep": "^4.5.9",
"@types/lodash.get": "^4.4.9",
"@types/lodash.isequal": "^4.5.8", "@types/lodash.isequal": "^4.5.8",
"@types/lodash.throttle": "^4.1.9", "@types/lodash.throttle": "^4.1.9",
"@types/mocha": "^10.0.6", "@types/react": "^16.14.52",
"@types/randomcolor": "^0.5.9", "@types/react-aria-modal": "^4.0.9",
"@types/react": "^18.2.67", "@types/react-autocomplete": "^1.8.9",
"@types/react-aria-menubutton": "^6.2.14",
"@types/react-aria-modal": "^4.0.10",
"@types/react-autocomplete": "^1.8.10",
"@types/react-collapse": "^5.0.4", "@types/react-collapse": "^5.0.4",
"@types/react-color": "^3.0.12", "@types/react-color": "^3.0.10",
"@types/react-dom": "^18.2.22", "@types/react-dom": "^16.9.24",
"@types/react-file-reader-input": "^2.0.4", "@types/react-file-reader-input": "^2.0.4",
"@types/react-icon-base": "^2.1.6", "@types/react-icon-base": "^2.1.6",
"@types/string-hash": "^1.1.3", "@types/uuid": "^9.0.7",
"@types/uuid": "^9.0.8", "@vitejs/plugin-react": "^4.2.0",
"@vitejs/plugin-react": "^4.2.1",
"cors": "^2.8.5", "cors": "^2.8.5",
"cypress": "^13.13.0", "cypress": "^13.6.1",
"eslint": "^8.57.0", "eslint": "^8.53.0",
"eslint-plugin-react": "^7.34.1", "eslint-plugin-react": "^7.33.2",
"eslint-plugin-react-hooks": "^4.6.0", "eslint-plugin-react-hooks": "^4.6.0",
"eslint-plugin-react-refresh": "^0.4.6", "eslint-plugin-react-refresh": "^0.4.4",
"i18next-parser": "^9.0.1", "express": "^4.17.3",
"istanbul": "^0.4.5", "istanbul": "^0.4.5",
"istanbul-lib-coverage": "^3.2.2", "istanbul-lib-coverage": "^3.2.0",
"mocha": "^10.3.0", "mocha": "^9.2.2",
"postcss": "^8.4.38", "postcss": "^8.4.12",
"react-hot-loader": "^4.13.1", "react-hot-loader": "^4.13.0",
"stylelint": "^16.2.1", "storybook": "^7.6.5",
"stylelint-config-recommended-scss": "^14.0.0", "stylelint": "^14.6.1",
"stylelint-scss": "^6.2.1", "stylelint-config-recommended-scss": "^6.0.0",
"typescript": "^5.4.3", "stylelint-scss": "^4.2.0",
"uuid": "^9.0.1", "typescript": "^5.3.3",
"vite": "^5.2.6", "uuid": "^8.3.2",
"vite-plugin-istanbul": "^6.0.0" "vite": "^5.0.0",
"vite-plugin-istanbul": "^5.0.0"
} }
} }
+114 -163
View File
@@ -1,4 +1,3 @@
// @ts-ignore - this can be easily replaced with arrow functions
import autoBind from 'react-autobind'; import autoBind from 'react-autobind';
import React from 'react' import React from 'react'
import cloneDeep from 'lodash.clonedeep' import cloneDeep from 'lodash.clonedeep'
@@ -7,15 +6,14 @@ import buffer from 'buffer'
import get from 'lodash.get' import get from 'lodash.get'
import {unset} from 'lodash' import {unset} from 'lodash'
import {arrayMoveMutable} from 'array-move' import {arrayMoveMutable} from 'array-move'
import url from 'url'
import hash from "string-hash"; import hash from "string-hash";
import {Map, LayerSpecification, StyleSpecification, ValidationError, SourceSpecification} from 'maplibre-gl'
import {latest, validateStyleMin} from '@maplibre/maplibre-gl-style-spec'
import MapMaplibreGl from './MapMaplibreGl' import MapMaplibreGl from './MapMaplibreGl'
import MapOpenLayers from './MapOpenLayers' import MapOpenLayers from './MapOpenLayers'
import LayerList from './LayerList' import LayerList from './LayerList'
import LayerEditor from './LayerEditor' import LayerEditor from './LayerEditor'
import AppToolbar, { MapState } from './AppToolbar' import AppToolbar from './AppToolbar'
import AppLayout from './AppLayout' import AppLayout from './AppLayout'
import MessagePanel from './AppMessagePanel' import MessagePanel from './AppMessagePanel'
@@ -24,9 +22,11 @@ import ModalExport from './ModalExport'
import ModalSources from './ModalSources' import ModalSources from './ModalSources'
import ModalOpen from './ModalOpen' import ModalOpen from './ModalOpen'
import ModalShortcuts from './ModalShortcuts' import ModalShortcuts from './ModalShortcuts'
import ModalSurvey from './ModalSurvey'
import ModalDebug from './ModalDebug' import ModalDebug from './ModalDebug'
import {downloadGlyphsMetadata, downloadSpriteMetadata} from '../libs/metadata' import { downloadGlyphsMetadata, downloadSpriteMetadata } from '../libs/metadata'
import {latest, validate} from '@maplibre/maplibre-gl-style-spec'
import style from '../libs/style' import style from '../libs/style'
import { initialStyleUrl, loadStyleUrl, removeStyleQuerystring } from '../libs/urlopen' import { initialStyleUrl, loadStyleUrl, removeStyleQuerystring } from '../libs/urlopen'
import { undoMessages, redoMessages } from '../libs/diffmessage' import { undoMessages, redoMessages } from '../libs/diffmessage'
@@ -37,13 +37,12 @@ import LayerWatcher from '../libs/layerwatcher'
import tokens from '../config/tokens.json' import tokens from '../config/tokens.json'
import isEqual from 'lodash.isequal' import isEqual from 'lodash.isequal'
import Debug from '../libs/debug' import Debug from '../libs/debug'
import { SortEnd } from 'react-sortable-hoc'; import {formatLayerId} from '../util/format';
import { MapOptions } from 'maplibre-gl';
// Buffer must be defined globally for @maplibre/maplibre-gl-style-spec validate() function to succeed. // Buffer must be defined globally for @maplibre/maplibre-gl-style-spec validate() function to succeed.
window.Buffer = buffer.Buffer; window.Buffer = buffer.Buffer;
function setFetchAccessToken(url: string, mapStyle: StyleSpecification) { function setFetchAccessToken(url, mapStyle) {
const matchesTilehosting = url.match(/\.tilehosting\.com/); const matchesTilehosting = url.match(/\.tilehosting\.com/);
const matchesMaptiler = url.match(/\.maptiler\.com/); const matchesMaptiler = url.match(/\.maptiler\.com/);
const matchesThunderforest = url.match(/\.thunderforest\.com/); const matchesThunderforest = url.match(/\.thunderforest\.com/);
@@ -64,7 +63,7 @@ function setFetchAccessToken(url: string, mapStyle: StyleSpecification) {
} }
} }
function updateRootSpec(spec: any, fieldName: string, newValues: any) { function updateRootSpec(spec, fieldName, newValues) {
return { return {
...spec, ...spec,
$root: { $root: {
@@ -77,73 +76,15 @@ function updateRootSpec(spec: any, fieldName: string, newValues: any) {
} }
} }
type OnStyleChangedOpts = { export default class App extends React.Component {
save?: boolean constructor(props) {
addRevision?: boolean
initialLoad?: boolean
}
type MappedErrors = {
message: string
parsed?: {
type: string
data: {
index: number
key: string
message: string
}
}
}
type AppState = {
errors: MappedErrors[],
infos: string[],
mapStyle: StyleSpecification & {id: string},
dirtyMapStyle?: StyleSpecification,
selectedLayerIndex: number,
selectedLayerOriginalId?: string,
sources: {[key: string]: SourceSpecification},
vectorLayers: {},
spec: any,
mapView: {
zoom: number,
center: {
lng: number,
lat: number,
},
},
maplibreGlDebugOptions: Partial<MapOptions> & {
showTileBoundaries: boolean,
showCollisionBoxes: boolean,
showOverdrawInspector: boolean,
},
openlayersDebugOptions: {
debugToolbox: boolean,
},
mapState: MapState
isOpen: {
settings: boolean
sources: boolean
open: boolean
shortcuts: boolean
export: boolean
debug: boolean
}
}
export default class App extends React.Component<any, AppState> {
revisionStore: RevisionStore;
styleStore: StyleStore | ApiStyleStore;
layerWatcher: LayerWatcher;
constructor(props: any) {
super(props) super(props)
autoBind(this); autoBind(this);
this.revisionStore = new RevisionStore() this.revisionStore = new RevisionStore()
const params = new URLSearchParams(window.location.search.substring(1)) const params = new URLSearchParams(window.location.search.substring(1))
let port = params.get("localport") let port = params.get("localport")
if (port == null && (window.location.port !== "80" && window.location.port !== "443")) { if (port == null && (window.location.port != 80 && window.location.port != 443)) {
port = window.location.port port = window.location.port
} }
this.styleStore = new ApiStyleStore({ this.styleStore = new ApiStyleStore({
@@ -195,7 +136,7 @@ export default class App extends React.Component<any, AppState> {
{ {
key: "m", key: "m",
handler: () => { handler: () => {
(document.querySelector(".maplibregl-canvas") as HTMLCanvasElement).focus(); document.querySelector(".maplibregl-canvas").focus();
} }
}, },
{ {
@@ -208,7 +149,7 @@ export default class App extends React.Component<any, AppState> {
document.body.addEventListener("keyup", (e) => { document.body.addEventListener("keyup", (e) => {
if(e.key === "Escape") { if(e.key === "Escape") {
(e.target as HTMLElement).blur(); e.target.blur();
document.body.focus(); document.body.focus();
} }
else if(this.state.isOpen.shortcuts || document.activeElement === document.body) { else if(this.state.isOpen.shortcuts || document.activeElement === document.body) {
@@ -218,7 +159,7 @@ export default class App extends React.Component<any, AppState> {
if(shortcut) { if(shortcut) {
this.setModal("shortcuts", false); this.setModal("shortcuts", false);
shortcut.handler(); shortcut.handler(e);
} }
} }
}) })
@@ -251,6 +192,8 @@ export default class App extends React.Component<any, AppState> {
Debug.set("maputnik", "styleStore", this.styleStore); Debug.set("maputnik", "styleStore", this.styleStore);
} }
const queryObj = url.parse(window.location.href, true).query;
this.state = { this.state = {
errors: [], errors: [],
infos: [], infos: [],
@@ -274,6 +217,7 @@ export default class App extends React.Component<any, AppState> {
shortcuts: false, shortcuts: false,
export: false, export: false,
// TODO: Disabled for now, this should be opened on the Nth visit to the editor // TODO: Disabled for now, this should be opened on the Nth visit to the editor
survey: false,
debug: false, debug: false,
}, },
maplibreGlDebugOptions: { maplibreGlDebugOptions: {
@@ -291,25 +235,25 @@ export default class App extends React.Component<any, AppState> {
}) })
} }
handleKeyPress = (e: KeyboardEvent) => { handleKeyPress = (e) => {
if(navigator.platform.toUpperCase().indexOf('MAC') >= 0) { if(navigator.platform.toUpperCase().indexOf('MAC') >= 0) {
if(e.metaKey && e.shiftKey && e.keyCode === 90) { if(e.metaKey && e.shiftKey && e.keyCode === 90) {
e.preventDefault(); e.preventDefault();
this.onRedo(); this.onRedo(e);
} }
else if(e.metaKey && e.keyCode === 90) { else if(e.metaKey && e.keyCode === 90) {
e.preventDefault(); e.preventDefault();
this.onUndo(); this.onUndo(e);
} }
} }
else { else {
if(e.ctrlKey && e.keyCode === 90) { if(e.ctrlKey && e.keyCode === 90) {
e.preventDefault(); e.preventDefault();
this.onUndo(); this.onUndo(e);
} }
else if(e.ctrlKey && e.keyCode === 89) { else if(e.ctrlKey && e.keyCode === 89) {
e.preventDefault(); e.preventDefault();
this.onRedo(); this.onRedo(e);
} }
} }
} }
@@ -322,27 +266,27 @@ export default class App extends React.Component<any, AppState> {
window.removeEventListener("keydown", this.handleKeyPress); window.removeEventListener("keydown", this.handleKeyPress);
} }
saveStyle(snapshotStyle: StyleSpecification & {id: string}) { saveStyle(snapshotStyle) {
this.styleStore.save(snapshotStyle) this.styleStore.save(snapshotStyle)
} }
updateFonts(urlTemplate: string) { updateFonts(urlTemplate) {
const metadata: {[key: string]: string} = this.state.mapStyle.metadata || {} as any const metadata = this.state.mapStyle.metadata || {}
const accessToken = metadata['maputnik:openmaptiles_access_token'] || tokens.openmaptiles const accessToken = metadata['maputnik:openmaptiles_access_token'] || tokens.openmaptiles
const glyphUrl = (typeof urlTemplate === 'string')? urlTemplate.replace('{key}', accessToken): urlTemplate; let glyphUrl = (typeof urlTemplate === 'string')? urlTemplate.replace('{key}', accessToken): urlTemplate;
downloadGlyphsMetadata(glyphUrl, fonts => { downloadGlyphsMetadata(glyphUrl, fonts => {
this.setState({ spec: updateRootSpec(this.state.spec, 'glyphs', fonts)}) this.setState({ spec: updateRootSpec(this.state.spec, 'glyphs', fonts)})
}) })
} }
updateIcons(baseUrl: string) { updateIcons(baseUrl) {
downloadSpriteMetadata(baseUrl, icons => { downloadSpriteMetadata(baseUrl, icons => {
this.setState({ spec: updateRootSpec(this.state.spec, 'sprite', icons)}) this.setState({ spec: updateRootSpec(this.state.spec, 'sprite', icons)})
}) })
} }
onChangeMetadataProperty = (property: string, value: any) => { onChangeMetadataProperty = (property, value) => {
// If we're changing renderer reset the map state. // If we're changing renderer reset the map state.
if ( if (
property === 'maputnik:renderer' && property === 'maputnik:renderer' &&
@@ -356,14 +300,14 @@ export default class App extends React.Component<any, AppState> {
const changedStyle = { const changedStyle = {
...this.state.mapStyle, ...this.state.mapStyle,
metadata: { metadata: {
...(this.state.mapStyle as any).metadata, ...this.state.mapStyle.metadata,
[property]: value [property]: value
} }
} }
this.onStyleChanged(changedStyle) this.onStyleChanged(changedStyle)
} }
onStyleChanged = (newStyle: StyleSpecification & {id: string}, opts: OnStyleChangedOpts={}) => { onStyleChanged = (newStyle, opts={}) => {
opts = { opts = {
save: true, save: true,
addRevision: true, addRevision: true,
@@ -375,15 +319,16 @@ export default class App extends React.Component<any, AppState> {
this.getInitialStateFromUrl(newStyle); this.getInitialStateFromUrl(newStyle);
} }
const errors: ValidationError[] = validateStyleMin(newStyle) || []; const errors = validate(newStyle, latest) || [];
// The validate function doesn't give us errors for duplicate error with // The validate function doesn't give us errors for duplicate error with
// empty string for layer.id, manually deal with that here. // empty string for layer.id, manually deal with that here.
const layerErrors: (Error | ValidationError)[] = []; const layerErrors = [];
if (newStyle && newStyle.layers) { if (newStyle && newStyle.layers) {
const foundLayers = new global.Map(); const foundLayers = new Map();
newStyle.layers.forEach((layer, index) => { newStyle.layers.forEach((layer, index) => {
if (layer.id === "" && foundLayers.has(layer.id)) { if (layer.id === "" && foundLayers.has(layer.id)) {
const message = `Duplicate layer: ${formatLayerId(layer.id)}`;
const error = new Error( const error = new Error(
`layers[${index}]: duplicate layer id [empty_string], previously used` `layers[${index}]: duplicate layer id [empty_string], previously used`
); );
@@ -397,7 +342,7 @@ export default class App extends React.Component<any, AppState> {
// Special case: Duplicate layer id // Special case: Duplicate layer id
const dupMatch = error.message.match(/layers\[(\d+)\]: (duplicate layer id "?(.*)"?, previously used)/); const dupMatch = error.message.match(/layers\[(\d+)\]: (duplicate layer id "?(.*)"?, previously used)/);
if (dupMatch) { if (dupMatch) {
const [, index, message] = dupMatch; const [matchStr, index, message] = dupMatch;
return { return {
message: error.message, message: error.message,
parsed: { parsed: {
@@ -414,7 +359,7 @@ export default class App extends React.Component<any, AppState> {
// Special case: Invalid source // Special case: Invalid source
const invalidSourceMatch = error.message.match(/layers\[(\d+)\]: (source "(?:.*)" not found)/); const invalidSourceMatch = error.message.match(/layers\[(\d+)\]: (source "(?:.*)" not found)/);
if (invalidSourceMatch) { if (invalidSourceMatch) {
const [, index, message] = invalidSourceMatch; const [matchStr, index, message] = invalidSourceMatch;
return { return {
message: error.message, message: error.message,
parsed: { parsed: {
@@ -430,7 +375,7 @@ export default class App extends React.Component<any, AppState> {
const layerMatch = error.message.match(/layers\[(\d+)\]\.(?:(\S+)\.)?(\S+): (.*)/); const layerMatch = error.message.match(/layers\[(\d+)\]\.(?:(\S+)\.)?(\S+): (.*)/);
if (layerMatch) { if (layerMatch) {
const [, index, group, property, message] = layerMatch; const [matchStr, index, group, property, message] = layerMatch;
const key = (group && property) ? [group, property].join(".") : property; const key = (group && property) ? [group, property].join(".") : property;
return { return {
message: error.message, message: error.message,
@@ -451,7 +396,7 @@ export default class App extends React.Component<any, AppState> {
} }
}); });
let dirtyMapStyle: StyleSpecification | undefined = undefined; let dirtyMapStyle = undefined;
if (errors.length > 0) { if (errors.length > 0) {
dirtyMapStyle = cloneDeep(newStyle); dirtyMapStyle = cloneDeep(newStyle);
@@ -461,7 +406,7 @@ export default class App extends React.Component<any, AppState> {
try { try {
const objPath = message.split(":")[0]; const objPath = message.split(":")[0];
// Errors can be deply nested for example 'layers[0].filter[1][1][0]' we only care upto the property 'layers[0].filter' // Errors can be deply nested for example 'layers[0].filter[1][1][0]' we only care upto the property 'layers[0].filter'
const unsetPath = objPath.match(/^\S+?\[\d+\]\.[^[]+/)![0]; const unsetPath = objPath.match(/^\S+?\[\d+\]\.[^\[]+/)[0];
unset(dirtyMapStyle, unsetPath); unset(dirtyMapStyle, unsetPath);
} }
catch (err) { catch (err) {
@@ -472,17 +417,17 @@ export default class App extends React.Component<any, AppState> {
} }
if(newStyle.glyphs !== this.state.mapStyle.glyphs) { if(newStyle.glyphs !== this.state.mapStyle.glyphs) {
this.updateFonts(newStyle.glyphs as string) this.updateFonts(newStyle.glyphs)
} }
if(newStyle.sprite !== this.state.mapStyle.sprite) { if(newStyle.sprite !== this.state.mapStyle.sprite) {
this.updateIcons(newStyle.sprite as string) this.updateIcons(newStyle.sprite)
} }
if (opts.addRevision) { if (opts.addRevision) {
this.revisionStore.addRevision(newStyle); this.revisionStore.addRevision(newStyle);
} }
if (opts.save) { if (opts.save) {
this.saveStyle(newStyle as StyleSpecification & {id: string}); this.saveStyle(newStyle);
} }
this.setState({ this.setState({
@@ -515,7 +460,7 @@ export default class App extends React.Component<any, AppState> {
}) })
} }
onMoveLayer = (move: SortEnd) => { onMoveLayer = (move) => {
let { oldIndex, newIndex } = move; let { oldIndex, newIndex } = move;
let layers = this.state.mapStyle.layers; let layers = this.state.mapStyle.layers;
oldIndex = clamp(oldIndex, 0, layers.length-1); oldIndex = clamp(oldIndex, 0, layers.length-1);
@@ -533,7 +478,7 @@ export default class App extends React.Component<any, AppState> {
this.onLayersChange(layers); this.onLayersChange(layers);
} }
onLayersChange = (changedLayers: LayerSpecification[]) => { onLayersChange = (changedLayers) => {
const changedStyle = { const changedStyle = {
...this.state.mapStyle, ...this.state.mapStyle,
layers: changedLayers layers: changedLayers
@@ -541,15 +486,15 @@ export default class App extends React.Component<any, AppState> {
this.onStyleChanged(changedStyle) this.onStyleChanged(changedStyle)
} }
onLayerDestroy = (index: number) => { onLayerDestroy = (index) => {
const layers = this.state.mapStyle.layers; let layers = this.state.mapStyle.layers;
const remainingLayers = layers.slice(0); const remainingLayers = layers.slice(0);
remainingLayers.splice(index, 1); remainingLayers.splice(index, 1);
this.onLayersChange(remainingLayers); this.onLayersChange(remainingLayers);
} }
onLayerCopy = (index: number) => { onLayerCopy = (index) => {
const layers = this.state.mapStyle.layers; let layers = this.state.mapStyle.layers;
const changedLayers = layers.slice(0) const changedLayers = layers.slice(0)
const clonedLayer = cloneDeep(changedLayers[index]) const clonedLayer = cloneDeep(changedLayers[index])
@@ -558,8 +503,8 @@ export default class App extends React.Component<any, AppState> {
this.onLayersChange(changedLayers) this.onLayersChange(changedLayers)
} }
onLayerVisibilityToggle = (index: number) => { onLayerVisibilityToggle = (index) => {
const layers = this.state.mapStyle.layers; let layers = this.state.mapStyle.layers;
const changedLayers = layers.slice(0) const changedLayers = layers.slice(0)
const layer = { ...changedLayers[index] } const layer = { ...changedLayers[index] }
@@ -572,7 +517,7 @@ export default class App extends React.Component<any, AppState> {
} }
onLayerIdChange = (index: number, _oldId: string, newId: string) => { onLayerIdChange = (index, oldId, newId) => {
const changedLayers = this.state.mapStyle.layers.slice(0) const changedLayers = this.state.mapStyle.layers.slice(0)
changedLayers[index] = { changedLayers[index] = {
...changedLayers[index], ...changedLayers[index],
@@ -582,26 +527,26 @@ export default class App extends React.Component<any, AppState> {
this.onLayersChange(changedLayers) this.onLayersChange(changedLayers)
} }
onLayerChanged = (index: number, layer: LayerSpecification) => { onLayerChanged = (index, layer) => {
const changedLayers = this.state.mapStyle.layers.slice(0) const changedLayers = this.state.mapStyle.layers.slice(0)
changedLayers[index] = layer changedLayers[index] = layer
this.onLayersChange(changedLayers) this.onLayersChange(changedLayers)
} }
setMapState = (newState: MapState) => { setMapState = (newState) => {
this.setState({ this.setState({
mapState: newState mapState: newState
}, this.setStateInUrl); }, this.setStateInUrl);
} }
setDefaultValues = (styleObj: StyleSpecification & {id: string}) => { setDefaultValues = (styleObj) => {
const metadata: {[key: string]: string} = styleObj.metadata || {} as any const metadata = styleObj.metadata || {}
if(metadata['maputnik:renderer'] === undefined) { if(metadata['maputnik:renderer'] === undefined) {
const changedStyle = { const changedStyle = {
...styleObj, ...styleObj,
metadata: { metadata: {
...styleObj.metadata as any, ...styleObj.metadata,
'maputnik:renderer': 'mlgljs' 'maputnik:renderer': 'mlgljs'
} }
} }
@@ -611,19 +556,19 @@ export default class App extends React.Component<any, AppState> {
} }
} }
openStyle = (styleObj: StyleSpecification & {id: string}) => { openStyle = (styleObj) => {
styleObj = this.setDefaultValues(styleObj) styleObj = this.setDefaultValues(styleObj)
this.onStyleChanged(styleObj) this.onStyleChanged(styleObj)
} }
fetchSources() { fetchSources() {
const sourceList: {[key: string]: any} = {}; const sourceList = {};
for(const [key, val] of Object.entries(this.state.mapStyle.sources)) { for(let [key, val] of Object.entries(this.state.mapStyle.sources)) {
if( if(
!Object.prototype.hasOwnProperty.call(this.state.sources, key) && !this.state.sources.hasOwnProperty(key) &&
val.type === "vector" && val.type === "vector" &&
Object.prototype.hasOwnProperty.call(val, "url") val.hasOwnProperty("url")
) { ) {
sourceList[key] = { sourceList[key] = {
type: val.type, type: val.type,
@@ -633,38 +578,38 @@ export default class App extends React.Component<any, AppState> {
let url = val.url; let url = val.url;
try { try {
url = setFetchAccessToken(url!, this.state.mapStyle) url = setFetchAccessToken(url, this.state.mapStyle)
} catch(err) { } catch(err) {
console.warn("Failed to setFetchAccessToken: ", err); console.warn("Failed to setFetchAccessToken: ", err);
} }
fetch(url!, { fetch(url, {
mode: 'cors', mode: 'cors',
}) })
.then(response => response.json()) .then(response => response.json())
.then(json => { .then(json => {
if(!Object.prototype.hasOwnProperty.call(json, "vector_layers")) { if(!json.hasOwnProperty("vector_layers")) {
return; return;
} }
// Create new objects before setState // Create new objects before setState
const sources = Object.assign({}, { const sources = Object.assign({}, {
[key]: this.state.sources[key], [key]: this.state.sources[key],
});
for(const layer of json.vector_layers) {
(sources[key] as any).layers.push(layer.id)
}
console.debug("Updating source: "+key);
this.setState({
sources: sources
});
})
.catch(err => {
console.error("Failed to process sources for '%s'", url, err);
}); });
for(let layer of json.vector_layers) {
sources[key].layers.push(layer.id)
}
console.debug("Updating source: "+key);
this.setState({
sources: sources
});
})
.catch(err => {
console.error("Failed to process sources for '%s'", url, err);
});
} }
else { else {
sourceList[key] = this.state.sources[key] || this.state.mapStyle.sources[key]; sourceList[key] = this.state.sources[key] || this.state.mapStyle.sources[key];
@@ -680,17 +625,11 @@ export default class App extends React.Component<any, AppState> {
} }
_getRenderer () { _getRenderer () {
const metadata: {[key:string]: string} = this.state.mapStyle.metadata || {} as any; const metadata = this.state.mapStyle.metadata || {};
return metadata['maputnik:renderer'] || 'mlgljs'; return metadata['maputnik:renderer'] || 'mlgljs';
} }
onMapChange = (mapView: { onMapChange = (mapView) => {
zoom: number,
center: {
lng: number,
lat: number,
},
}) => {
this.setState({ this.setState({
mapView, mapView,
}); });
@@ -698,15 +637,16 @@ export default class App extends React.Component<any, AppState> {
mapRenderer() { mapRenderer() {
const {mapStyle, dirtyMapStyle} = this.state; const {mapStyle, dirtyMapStyle} = this.state;
const metadata = this.state.mapStyle.metadata || {};
const mapProps = { const mapProps = {
mapStyle: (dirtyMapStyle || mapStyle), mapStyle: (dirtyMapStyle || mapStyle),
replaceAccessTokens: (mapStyle: StyleSpecification) => { replaceAccessTokens: (mapStyle) => {
return style.replaceAccessTokens(mapStyle, { return style.replaceAccessTokens(mapStyle, {
allowFallback: true allowFallback: true
}); });
}, },
onDataChange: (e: {map: Map}) => { onDataChange: (e) => {
this.layerWatcher.analyzeMap(e.map) this.layerWatcher.analyzeMap(e.map)
this.fetchSources(); this.fetchSources();
}, },
@@ -737,7 +677,7 @@ export default class App extends React.Component<any, AppState> {
if(this.state.mapState.match(/^filter-/)) { if(this.state.mapState.match(/^filter-/)) {
filterName = this.state.mapState.replace(/^filter-/, ""); filterName = this.state.mapState.replace(/^filter-/, "");
} }
const elementStyle: {filter?: string} = {}; const elementStyle = {};
if (filterName) { if (filterName) {
elementStyle.filter = `url('#${filterName}')`; elementStyle.filter = `url('#${filterName}')`;
} }
@@ -755,8 +695,8 @@ export default class App extends React.Component<any, AppState> {
url.searchParams.set("layer", `${hashVal}~${selectedLayerIndex}`); url.searchParams.set("layer", `${hashVal}~${selectedLayerIndex}`);
const openModals = Object.entries(isOpen) const openModals = Object.entries(isOpen)
.map(([key, val]) => (val === true ? key : null)) .map(([key, val]) => (val === true ? key : null))
.filter(val => val !== null); .filter(val => val !== null);
if (openModals.length > 0) { if (openModals.length > 0) {
url.searchParams.set("modal", openModals.join(",")); url.searchParams.set("modal", openModals.join(","));
@@ -775,12 +715,12 @@ export default class App extends React.Component<any, AppState> {
history.replaceState({selectedLayerIndex}, "Maputnik", url.href); history.replaceState({selectedLayerIndex}, "Maputnik", url.href);
} }
getInitialStateFromUrl = (mapStyle: StyleSpecification) => { getInitialStateFromUrl = (mapStyle) => {
const url = new URL(location.href); const url = new URL(location.href);
const modalParam = url.searchParams.get("modal"); const modalParam = url.searchParams.get("modal");
if (modalParam && modalParam !== "") { if (modalParam && modalParam !== "") {
const modals = modalParam.split(","); const modals = modalParam.split(",");
const modalObj: {[key: string]: boolean} = {}; const modalObj = {};
modals.forEach(modalName => { modals.forEach(modalName => {
modalObj[modalName] = true; modalObj[modalName] = true;
}); });
@@ -795,7 +735,7 @@ export default class App extends React.Component<any, AppState> {
const view = url.searchParams.get("view"); const view = url.searchParams.get("view");
if (view && view !== "") { if (view && view !== "") {
this.setMapState(view as MapState); this.setMapState(view);
} }
const path = url.searchParams.get("layer"); const path = url.searchParams.get("layer");
@@ -827,14 +767,18 @@ export default class App extends React.Component<any, AppState> {
} }
} }
onLayerSelect = (index: number) => { onLayerSelect = (index) => {
this.setState({ this.setState({
selectedLayerIndex: index, selectedLayerIndex: index,
selectedLayerOriginalId: this.state.mapStyle.layers[index].id, selectedLayerOriginalId: this.state.mapStyle.layers[index].id,
}, this.setStateInUrl); }, this.setStateInUrl);
} }
setModal(modalName: keyof AppState["isOpen"], value: boolean) { setModal(modalName, value) {
if(modalName === 'survey' && value === false) {
localStorage.setItem('survey', '');
}
this.setState({ this.setState({
isOpen: { isOpen: {
...this.state.isOpen, ...this.state.isOpen,
@@ -843,11 +787,11 @@ export default class App extends React.Component<any, AppState> {
}, this.setStateInUrl) }, this.setStateInUrl)
} }
toggleModal(modalName: keyof AppState["isOpen"]) { toggleModal(modalName) {
this.setModal(modalName, !this.state.isOpen[modalName]); this.setModal(modalName, !this.state.isOpen[modalName]);
} }
onChangeOpenlayersDebug = (key: keyof AppState["openlayersDebugOptions"], value: boolean) => { onChangeOpenlayersDebug = (key, value) => {
this.setState({ this.setState({
openlayersDebugOptions: { openlayersDebugOptions: {
...this.state.openlayersDebugOptions, ...this.state.openlayersDebugOptions,
@@ -856,7 +800,7 @@ export default class App extends React.Component<any, AppState> {
}); });
} }
onChangeMaplibreGlDebug = (key: keyof AppState["maplibreGlDebugOptions"], value: any) => { onChangeMaplibreGlDebug = (key, value) => {
this.setState({ this.setState({
maplibreGlDebugOptions: { maplibreGlDebugOptions: {
...this.state.maplibreGlDebugOptions, ...this.state.maplibreGlDebugOptions,
@@ -867,7 +811,8 @@ export default class App extends React.Component<any, AppState> {
render() { render() {
const layers = this.state.mapStyle.layers || [] const layers = this.state.mapStyle.layers || []
const selectedLayer = layers.length > 0 ? layers[this.state.selectedLayerIndex] : undefined const selectedLayer = layers.length > 0 ? layers[this.state.selectedLayerIndex] : null
const metadata = this.state.mapStyle.metadata || {}
const toolbar = <AppToolbar const toolbar = <AppToolbar
renderer={this._getRenderer()} renderer={this._getRenderer()}
@@ -910,7 +855,7 @@ export default class App extends React.Component<any, AppState> {
onLayerVisibilityToggle={this.onLayerVisibilityToggle} onLayerVisibilityToggle={this.onLayerVisibilityToggle}
onLayerIdChange={this.onLayerIdChange} onLayerIdChange={this.onLayerIdChange}
errors={this.state.errors} errors={this.state.errors}
/> : undefined /> : null
const bottomPanel = (this.state.errors.length + this.state.infos.length) > 0 ? <MessagePanel const bottomPanel = (this.state.errors.length + this.state.infos.length) > 0 ? <MessagePanel
currentLayer={selectedLayer} currentLayer={selectedLayer}
@@ -919,7 +864,7 @@ export default class App extends React.Component<any, AppState> {
mapStyle={this.state.mapStyle} mapStyle={this.state.mapStyle}
errors={this.state.errors} errors={this.state.errors}
infos={this.state.infos} infos={this.state.infos}
/> : undefined /> : null
const modals = <div> const modals = <div>
@@ -934,6 +879,7 @@ export default class App extends React.Component<any, AppState> {
mapView={this.state.mapView} mapView={this.state.mapView}
/> />
<ModalShortcuts <ModalShortcuts
ref={(el) => this.shortcutEl = el}
isOpen={this.state.isOpen.shortcuts} isOpen={this.state.isOpen.shortcuts}
onOpenToggle={this.toggleModal.bind(this, 'shortcuts')} onOpenToggle={this.toggleModal.bind(this, 'shortcuts')}
/> />
@@ -943,6 +889,7 @@ export default class App extends React.Component<any, AppState> {
onChangeMetadataProperty={this.onChangeMetadataProperty} onChangeMetadataProperty={this.onChangeMetadataProperty}
isOpen={this.state.isOpen.settings} isOpen={this.state.isOpen.settings}
onOpenToggle={this.toggleModal.bind(this, 'settings')} onOpenToggle={this.toggleModal.bind(this, 'settings')}
openlayersDebugOptions={this.state.openlayersDebugOptions}
/> />
<ModalExport <ModalExport
mapStyle={this.state.mapStyle} mapStyle={this.state.mapStyle}
@@ -961,6 +908,10 @@ export default class App extends React.Component<any, AppState> {
isOpen={this.state.isOpen.sources} isOpen={this.state.isOpen.sources}
onOpenToggle={this.toggleModal.bind(this, 'sources')} onOpenToggle={this.toggleModal.bind(this, 'sources')}
/> />
<ModalSurvey
isOpen={this.state.isOpen.survey}
onOpenToggle={this.toggleModal.bind(this, 'survey')}
/>
</div> </div>
return <AppLayout return <AppLayout
+14 -20
View File
@@ -1,18 +1,17 @@
import React from 'react' import React from 'react'
import PropTypes from 'prop-types' import PropTypes from 'prop-types'
import ScrollContainer from './ScrollContainer' import ScrollContainer from './ScrollContainer'
import { WithTranslation, withTranslation } from 'react-i18next';
type AppLayoutInternalProps = { type AppLayoutProps = {
toolbar: React.ReactElement toolbar: React.ReactElement
layerList: React.ReactElement layerList: React.ReactElement
layerEditor?: React.ReactElement layerEditor?: React.ReactElement
map: React.ReactElement map: React.ReactElement
bottom?: React.ReactElement bottom?: React.ReactElement
modals?: React.ReactNode modals?: React.ReactNode
} & WithTranslation; };
class AppLayoutInternal extends React.Component<AppLayoutInternalProps> { class AppLayout extends React.Component<AppLayoutProps> {
static childContextTypes = { static childContextTypes = {
reactIconBase: PropTypes.object reactIconBase: PropTypes.object
} }
@@ -24,29 +23,24 @@ class AppLayoutInternal extends React.Component<AppLayoutInternalProps> {
} }
render() { render() {
document.body.dir = this.props.i18n.dir();
return <div className="maputnik-layout"> return <div className="maputnik-layout">
{this.props.toolbar} {this.props.toolbar}
<div className="maputnik-layout-main"> <div className="maputnik-layout-list">
<div className="maputnik-layout-list"> {this.props.layerList}
{this.props.layerList}
</div>
<div className="maputnik-layout-drawer">
<ScrollContainer>
{this.props.layerEditor}
</ScrollContainer>
</div>
{this.props.map}
</div> </div>
<div className="maputnik-layout-drawer">
<ScrollContainer>
{this.props.layerEditor}
</ScrollContainer>
</div>
{this.props.map}
{this.props.bottom && <div className="maputnik-layout-bottom"> {this.props.bottom && <div className="maputnik-layout-bottom">
{this.props.bottom} {this.props.bottom}
</div> </div>
} }
{this.props.modals} {this.props.modals}
</div> </div>
} }
} }
const AppLayout = withTranslation()(AppLayoutInternal); export default AppLayout
export default AppLayout;
+10 -15
View File
@@ -1,24 +1,23 @@
import React from 'react' import React from 'react'
import {formatLayerId} from '../libs/format'; import {formatLayerId} from '../util/format';
import {LayerSpecification, StyleSpecification} from 'maplibre-gl'; import { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';
import { Trans, WithTranslation, withTranslation } from 'react-i18next';
type AppMessagePanelInternalProps = { type AppMessagePanelProps = {
errors?: unknown[] errors?: unknown[]
infos?: string[] infos?: unknown[]
mapStyle?: StyleSpecification mapStyle?: StyleSpecification
onLayerSelect?(...args: unknown[]): unknown onLayerSelect?(...args: unknown[]): unknown
currentLayer?: LayerSpecification currentLayer?: object
selectedLayerIndex?: number selectedLayerIndex?: number
} & WithTranslation; };
class AppMessagePanelInternal extends React.Component<AppMessagePanelInternalProps> { export default class AppMessagePanel extends React.Component<AppMessagePanelProps> {
static defaultProps = { static defaultProps = {
onLayerSelect: () => {}, onLayerSelect: () => {},
} }
render() { render() {
const {t, selectedLayerIndex} = this.props; const {selectedLayerIndex} = this.props;
const errors = this.props.errors?.map((error: any, idx) => { const errors = this.props.errors?.map((error: any, idx) => {
let content; let content;
if (error.parsed && error.parsed.type === "layer") { if (error.parsed && error.parsed.type === "layer") {
@@ -26,9 +25,7 @@ class AppMessagePanelInternal extends React.Component<AppMessagePanelInternalPro
const layerId = this.props.mapStyle?.layers[parsed.data.index].id; const layerId = this.props.mapStyle?.layers[parsed.data.index].id;
content = ( content = (
<> <>
<Trans t={t}> Layer <span>{formatLayerId(layerId)}</span>: {parsed.data.message}
Layer <span>{formatLayerId(layerId)}</span>: {parsed.data.message}
</Trans>
{selectedLayerIndex !== parsed.data.index && {selectedLayerIndex !== parsed.data.index &&
<> <>
&nbsp;&mdash;&nbsp; &nbsp;&mdash;&nbsp;
@@ -36,7 +33,7 @@ class AppMessagePanelInternal extends React.Component<AppMessagePanelInternalPro
className="maputnik-message-panel__switch-button" className="maputnik-message-panel__switch-button"
onClick={() => this.props.onLayerSelect!(parsed.data.index)} onClick={() => this.props.onLayerSelect!(parsed.data.index)}
> >
{t("switch to layer")} switch to layer
</button> </button>
</> </>
} }
@@ -62,5 +59,3 @@ class AppMessagePanelInternal extends React.Component<AppMessagePanelInternalPro
} }
} }
const AppMessagePanel = withTranslation()(AppMessagePanelInternal);
export default AppMessagePanel;
+54 -62
View File
@@ -2,12 +2,9 @@ import React from 'react'
import classnames from 'classnames' import classnames from 'classnames'
import {detect} from 'detect-browser'; import {detect} from 'detect-browser';
import {MdFileDownload, MdOpenInBrowser, MdSettings, MdLayers, MdHelpOutline, MdFindInPage, MdLanguage} from 'react-icons/md' import {MdFileDownload, MdOpenInBrowser, MdSettings, MdLayers, MdHelpOutline, MdFindInPage, MdAssignmentTurnedIn} from 'react-icons/md'
import pkgJson from '../../package.json' import pkgJson from '../../package.json'
//@ts-ignore
import maputnikLogo from 'maputnik-design/logos/logo-color.svg?inline'
import { withTranslation, WithTranslation } from 'react-i18next';
import { supportedLanguages } from '../i18n';
// This is required because of <https://stackoverflow.com/a/49846426>, there isn't another way to detect support that I'm aware of. // This is required because of <https://stackoverflow.com/a/49846426>, there isn't another way to detect support that I'm aware of.
const browser = detect(); const browser = detect();
@@ -39,13 +36,34 @@ class ToolbarLink extends React.Component<ToolbarLinkProps> {
href={this.props.href} href={this.props.href}
rel="noopener noreferrer" rel="noopener noreferrer"
target="_blank" target="_blank"
data-wd-key="toolbar:link"
> >
{this.props.children} {this.props.children}
</a> </a>
} }
} }
type ToolbarLinkHighlightedProps = {
className?: string
children?: React.ReactNode
href?: string
onToggleModal?(...args: unknown[]): unknown
};
class ToolbarLinkHighlighted extends React.Component<ToolbarLinkHighlightedProps> {
render() {
return <a
className={classnames('maputnik-toolbar-link', "maputnik-toolbar-link--highlighted", this.props.className)}
href={this.props.href}
rel="noopener noreferrer"
target="_blank"
>
<span className="maputnik-toolbar-link-wrapper">
{this.props.children}
</span>
</a>
}
}
type ToolbarSelectProps = { type ToolbarSelectProps = {
children?: React.ReactNode children?: React.ReactNode
wdKey?: string wdKey?: string
@@ -80,9 +98,7 @@ class ToolbarAction extends React.Component<ToolbarActionProps> {
} }
} }
export type MapState = "map" | "inspect" | "filter-achromatopsia" | "filter-deuteranopia" | "filter-protanopia" | "filter-tritanopia"; type AppToolbarProps = {
type AppToolbarInternalProps = {
mapStyle: object mapStyle: object
inspectModeEnabled: boolean inspectModeEnabled: boolean
onStyleChanged(...args: unknown[]): unknown onStyleChanged(...args: unknown[]): unknown
@@ -92,12 +108,12 @@ type AppToolbarInternalProps = {
sources: object sources: object
children?: React.ReactNode children?: React.ReactNode
onToggleModal(...args: unknown[]): unknown onToggleModal(...args: unknown[]): unknown
onSetMapState(mapState: MapState): unknown onSetMapState(...args: unknown[]): unknown
mapState?: MapState mapState?: string
renderer?: string renderer?: string
} & WithTranslation; };
class AppToolbarInternal extends React.Component<AppToolbarInternalProps> { export default class AppToolbar extends React.Component<AppToolbarProps> {
state = { state = {
isOpen: { isOpen: {
settings: false, settings: false,
@@ -108,14 +124,10 @@ class AppToolbarInternal extends React.Component<AppToolbarInternalProps> {
} }
} }
handleSelection(val: MapState) { handleSelection(val: string | undefined) {
this.props.onSetMapState(val); this.props.onSetMapState(val);
} }
handleLanguageChange(val: string) {
this.props.i18n.changeLanguage(val);
}
onSkip = (target: string) => { onSkip = (target: string) => {
if (target === "map") { if (target === "map") {
(document.querySelector(".maplibregl-canvas") as HTMLCanvasElement).focus(); (document.querySelector(".maplibregl-canvas") as HTMLCanvasElement).focus();
@@ -127,41 +139,40 @@ class AppToolbarInternal extends React.Component<AppToolbarInternalProps> {
} }
render() { render() {
const t = this.props.t;
const views = [ const views = [
{ {
id: "map", id: "map",
group: "general", group: "general",
title: t("Map"), title: "Map",
}, },
{ {
id: "inspect", id: "inspect",
group: "general", group: "general",
title: t("Inspect"), title: "Inspect",
disabled: this.props.renderer === 'ol', disabled: this.props.renderer === 'ol',
}, },
{ {
id: "filter-deuteranopia", id: "filter-deuteranopia",
group: "color-accessibility", group: "color-accessibility",
title: t("Deuteranopia filter"), title: "Deuteranopia filter",
disabled: !colorAccessibilityFiltersEnabled, disabled: !colorAccessibilityFiltersEnabled,
}, },
{ {
id: "filter-protanopia", id: "filter-protanopia",
group: "color-accessibility", group: "color-accessibility",
title: t("Protanopia filter"), title: "Protanopia filter",
disabled: !colorAccessibilityFiltersEnabled, disabled: !colorAccessibilityFiltersEnabled,
}, },
{ {
id: "filter-tritanopia", id: "filter-tritanopia",
group: "color-accessibility", group: "color-accessibility",
title: t("Tritanopia filter"), title: "Tritanopia filter",
disabled: !colorAccessibilityFiltersEnabled, disabled: !colorAccessibilityFiltersEnabled,
}, },
{ {
id: "filter-achromatopsia", id: "filter-achromatopsia",
group: "color-accessibility", group: "color-accessibility",
title: t("Achromatopsia filter"), title: "Achromatopsia filter",
disabled: !colorAccessibilityFiltersEnabled, disabled: !colorAccessibilityFiltersEnabled,
}, },
]; ];
@@ -181,29 +192,29 @@ class AppToolbarInternal extends React.Component<AppToolbarInternalProps> {
className="maputnik-toolbar-skip" className="maputnik-toolbar-skip"
onClick={_e => this.onSkip("layer-list")} onClick={_e => this.onSkip("layer-list")}
> >
{t("Layers list")} Layers list
</button> </button>
<button <button
data-wd-key="root:skip:layer-editor" data-wd-key="root:skip:layer-editor"
className="maputnik-toolbar-skip" className="maputnik-toolbar-skip"
onClick={_e => this.onSkip("layer-editor")} onClick={_e => this.onSkip("layer-editor")}
> >
{t("Layer editor")} Layer editor
</button> </button>
<button <button
data-wd-key="root:skip:map-view" data-wd-key="root:skip:map-view"
className="maputnik-toolbar-skip" className="maputnik-toolbar-skip"
onClick={_e => this.onSkip("map")} onClick={_e => this.onSkip("map")}
> >
{t("Map view")} Map view
</button> </button>
<a <a
className="maputnik-toolbar-logo" className="maputnik-toolbar-logo"
target="blank" target="blank"
rel="noreferrer noopener" rel="noreferrer noopener"
href="https://github.com/maplibre/maputnik" href="https://github.com/maputnik/editor"
> >
<img src={maputnikLogo} alt={t("Maputnik on GitHub")} /> <img src="node_modules/maputnik-design/logos/logo-color.svg" />
<h1> <h1>
<span className="maputnik-toolbar-name">{pkgJson.name}</span> <span className="maputnik-toolbar-name">{pkgJson.name}</span>
<span className="maputnik-toolbar-version">v{pkgJson.version}</span> <span className="maputnik-toolbar-version">v{pkgJson.version}</span>
@@ -213,28 +224,28 @@ class AppToolbarInternal extends React.Component<AppToolbarInternalProps> {
<div className="maputnik-toolbar__actions" role="navigation" aria-label="Toolbar"> <div className="maputnik-toolbar__actions" role="navigation" aria-label="Toolbar">
<ToolbarAction wdKey="nav:open" onClick={this.props.onToggleModal.bind(this, 'open')}> <ToolbarAction wdKey="nav:open" onClick={this.props.onToggleModal.bind(this, 'open')}>
<MdOpenInBrowser /> <MdOpenInBrowser />
<IconText>{t("Open")}</IconText> <IconText>Open</IconText>
</ToolbarAction> </ToolbarAction>
<ToolbarAction wdKey="nav:export" onClick={this.props.onToggleModal.bind(this, 'export')}> <ToolbarAction wdKey="nav:export" onClick={this.props.onToggleModal.bind(this, 'export')}>
<MdFileDownload /> <MdFileDownload />
<IconText>{t("Export")}</IconText> <IconText>Export</IconText>
</ToolbarAction> </ToolbarAction>
<ToolbarAction wdKey="nav:sources" onClick={this.props.onToggleModal.bind(this, 'sources')}> <ToolbarAction wdKey="nav:sources" onClick={this.props.onToggleModal.bind(this, 'sources')}>
<MdLayers /> <MdLayers />
<IconText>{t("Data Sources")}</IconText> <IconText>Data Sources</IconText>
</ToolbarAction> </ToolbarAction>
<ToolbarAction wdKey="nav:settings" onClick={this.props.onToggleModal.bind(this, 'settings')}> <ToolbarAction wdKey="nav:settings" onClick={this.props.onToggleModal.bind(this, 'settings')}>
<MdSettings /> <MdSettings />
<IconText>{t("Style Settings")}</IconText> <IconText>Style Settings</IconText>
</ToolbarAction> </ToolbarAction>
<ToolbarSelect wdKey="nav:inspect"> <ToolbarSelect wdKey="nav:inspect">
<MdFindInPage /> <MdFindInPage />
<label>{t("View")} <label>View
<select <select
className="maputnik-select" className="maputnik-select"
data-wd-key="maputnik-select" data-wd-key="maputnik-select"
onChange={(e) => this.handleSelection(e.target.value as MapState)} onChange={(e) => this.handleSelection(e.target.value)}
value={currentView?.id} value={currentView?.id}
> >
{views.filter(v => v.group === "general").map((item) => { {views.filter(v => v.group === "general").map((item) => {
@@ -244,7 +255,7 @@ class AppToolbarInternal extends React.Component<AppToolbarInternalProps> {
</option> </option>
); );
})} })}
<optgroup label={t("Color accessibility")}> <optgroup label="Color accessibility">
{views.filter(v => v.group === "color-accessibility").map((item) => { {views.filter(v => v.group === "color-accessibility").map((item) => {
return ( return (
<option key={item.id} value={item.id} disabled={item.disabled}> <option key={item.id} value={item.id} disabled={item.disabled}>
@@ -257,35 +268,16 @@ class AppToolbarInternal extends React.Component<AppToolbarInternalProps> {
</label> </label>
</ToolbarSelect> </ToolbarSelect>
<ToolbarSelect wdKey="nav:language"> <ToolbarLink href={"https://github.com/maputnik/editor/wiki"}>
<MdLanguage />
<label>{t("Language")}
<select
className="maputnik-select"
data-wd-key="maputnik-lang-select"
onChange={(e) => this.handleLanguageChange(e.target.value)}
value={this.props.i18n.language}
>
{Object.entries(supportedLanguages).map(([code, name]) => {
return (
<option key={code} value={code}>
{name}
</option>
);
})}
</select>
</label>
</ToolbarSelect>
<ToolbarLink href={"https://github.com/maplibre/maputnik/wiki"}>
<MdHelpOutline /> <MdHelpOutline />
<IconText>{t("Help")}</IconText> <IconText>Help</IconText>
</ToolbarLink> </ToolbarLink>
<ToolbarLinkHighlighted href={"https://gregorywolanski.typeform.com/to/cPgaSY"}>
<MdAssignmentTurnedIn />
<IconText>Take the Maputnik Survey</IconText>
</ToolbarLinkHighlighted>
</div> </div>
</div> </div>
</nav> </nav>
} }
} }
const AppToolbar = withTranslation()(AppToolbarInternal);
export default AppToolbar;
+4 -4
View File
@@ -1,10 +1,10 @@
import React, {PropsWithChildren, SyntheticEvent} from 'react' import React, {SyntheticEvent} from 'react'
import classnames from 'classnames' import classnames from 'classnames'
import FieldDocLabel from './FieldDocLabel' import FieldDocLabel from './FieldDocLabel'
import Doc from './Doc' import Doc from './Doc'
type BlockProps = PropsWithChildren & { type BlockProps = {
"data-wd-key"?: string "data-wd-key"?: string
label?: string label?: string
action?: React.ReactElement action?: React.ReactElement
@@ -12,7 +12,7 @@ type BlockProps = PropsWithChildren & {
onChange?(...args: unknown[]): unknown onChange?(...args: unknown[]): unknown
fieldSpec?: object fieldSpec?: object
wideMode?: boolean wideMode?: boolean
error?: {message: string} error?: unknown[]
}; };
type BlockState = { type BlockState = {
@@ -56,7 +56,7 @@ export default class Block extends React.Component<BlockProps, BlockState> {
if (event.nativeEvent.target.nodeName !== "INPUT" && !contains) { if (event.nativeEvent.target.nodeName !== "INPUT" && !contains) {
event.stopPropagation(); event.stopPropagation();
} }
event.preventDefault(); event.preventDefault();
} }
render() { render() {
+2 -2
View File
@@ -31,7 +31,7 @@ export default class Doc extends React.Component<DocProps> {
const renderValues = ( const renderValues = (
!!values && !!values &&
// HACK: Currently we merge additional values into the style spec, so this is required // HACK: Currently we merge additional values into the style spec, so this is required
// See <https://github.com/maplibre/maputnik/blob/main/src/components/PropertyGroup.jsx#L16> // See <https://github.com/maputnik/editor/blob/main/src/components/PropertyGroup.jsx#L16>
!Array.isArray(values) !Array.isArray(values)
); );
@@ -71,7 +71,7 @@ export default class Doc extends React.Component<DocProps> {
<tr key={key}> <tr key={key}>
<td>{key}</td> <td>{key}</td>
{Object.keys(headers).map((k) => { {Object.keys(headers).map((k) => {
if (Object.prototype.hasOwnProperty.call(supportObj, k)) { if (supportObj.hasOwnProperty(k)) {
return <td key={k}>{supportObj[k as keyof typeof headers]}</td>; return <td key={k}>{supportObj[k as keyof typeof headers]}</td>;
} }
else { else {
+7 -15
View File
@@ -2,37 +2,29 @@ import React from 'react'
import Block from './Block' import Block from './Block'
import InputString from './InputString' import InputString from './InputString'
import { WithTranslation, withTranslation } from 'react-i18next';
type FieldCommentInternalProps = { type FieldCommentProps = {
value?: string value?: string
onChange(value: string | undefined): unknown onChange(...args: unknown[]): unknown
error: {message: string} };
} & WithTranslation;
class FieldCommentInternal extends React.Component<FieldCommentInternalProps> { export default class FieldComment extends React.Component<FieldCommentProps> {
render() { render() {
const t = this.props.t;
const fieldSpec = { const fieldSpec = {
doc: t("Comments for the current layer. This is non-standard and not in the spec."), doc: "Comments for the current layer. This is non-standard and not in the spec."
}; };
return <Block return <Block
label={t("Comments")} label={"Comments"}
fieldSpec={fieldSpec} fieldSpec={fieldSpec}
data-wd-key="layer-comment" data-wd-key="layer-comment"
error={this.props.error}
> >
<InputString <InputString
multi={true} multi={true}
value={this.props.value} value={this.props.value}
onChange={this.props.onChange} onChange={this.props.onChange}
default={t("Comment...")} default="Comment..."
data-wd-key="layer-comment.input"
/> />
</Block> </Block>
} }
} }
const FieldComment = withTranslation()(FieldCommentInternal);
export default FieldComment;
+1 -1
View File
@@ -2,7 +2,7 @@ import React from 'react'
import {MdInfoOutline, MdHighlightOff} from 'react-icons/md' import {MdInfoOutline, MdHighlightOff} from 'react-icons/md'
type FieldDocLabelProps = { type FieldDocLabelProps = {
label: JSX.Element | string | undefined label: object | string | undefined
fieldSpec?: { fieldSpec?: {
doc?: string doc?: string
} }
+5 -5
View File
@@ -5,7 +5,7 @@ import DataProperty, { Stop } from './_DataProperty'
import ZoomProperty from './_ZoomProperty' import ZoomProperty from './_ZoomProperty'
import ExpressionProperty from './_ExpressionProperty' import ExpressionProperty from './_ExpressionProperty'
import {function as styleFunction} from '@maplibre/maplibre-gl-style-spec'; import {function as styleFunction} from '@maplibre/maplibre-gl-style-spec';
import {findDefaultFromSpec} from '../libs/spec-helper'; import {findDefaultFromSpec} from '../util/spec-helper';
function isLiteralExpression(value: any) { function isLiteralExpression(value: any) {
@@ -40,7 +40,7 @@ function isIdentityProperty(value: any) {
return ( return (
typeof(value) === 'object' && typeof(value) === 'object' &&
value.type === "identity" && value.type === "identity" &&
Object.prototype.hasOwnProperty.call(value, "property") value.hasOwnProperty("property")
); );
} }
@@ -107,7 +107,7 @@ type FieldFunctionProps = {
fieldName: string fieldName: string
fieldType: string fieldType: string
fieldSpec: any fieldSpec: any
errors?: {[key: string]: {message: string}} errors?: unknown[]
value?: any value?: any
}; };
@@ -128,7 +128,7 @@ export default class FieldFunction extends React.Component<FieldFunctionProps, F
} }
} }
static getDerivedStateFromProps(props: Readonly<FieldFunctionProps>, state: FieldFunctionState) { static getDerivedStateFromProps(props: FieldFunctionProps, state: FieldFunctionState) {
// Because otherwise when editing values we end up accidentally changing field type. // Because otherwise when editing values we end up accidentally changing field type.
if (state.isEditing) { if (state.isEditing) {
return {}; return {};
@@ -399,7 +399,7 @@ export default class FieldFunction extends React.Component<FieldFunctionProps, F
/> />
) )
} }
return <div className={propClass} data-wd-key={"spec-field-container:"+this.props.fieldName}> return <div className={propClass} data-wd-key={"spec-field:"+this.props.fieldName}>
{specField} {specField}
</div> </div>
} }
+4 -6
View File
@@ -1,27 +1,25 @@
import React from 'react' import React from 'react'
import latest from '@maplibre/maplibre-gl-style-spec/dist/latest.json' import {latest} from '@maplibre/maplibre-gl-style-spec'
import Block from './Block' import Block from './Block'
import InputString from './InputString' import InputString from './InputString'
type FieldIdProps = { type FieldIdProps = {
value: string value: string
wdKey: string wdKey: string
onChange(value: string | undefined): unknown onChange(...args: unknown[]): unknown
error?: {message: string} error?: unknown[]
}; };
export default class FieldId extends React.Component<FieldIdProps> { export default class FieldId extends React.Component<FieldIdProps> {
render() { render() {
return <Block label="ID" fieldSpec={latest.layer.id} return <Block label={"ID"} fieldSpec={latest.layer.id}
data-wd-key={this.props.wdKey} data-wd-key={this.props.wdKey}
error={this.props.error} error={this.props.error}
> >
<InputString <InputString
value={this.props.value} value={this.props.value}
onInput={this.props.onChange} onInput={this.props.onChange}
data-wd-key={this.props.wdKey + ".input"}
/> />
</Block> </Block>
} }
+7 -13
View File
@@ -1,20 +1,18 @@
import React from 'react' import React from 'react'
import latest from '@maplibre/maplibre-gl-style-spec/dist/latest.json' import {latest} from '@maplibre/maplibre-gl-style-spec'
import Block from './Block' import Block from './Block'
import InputNumber from './InputNumber' import InputNumber from './InputNumber'
import { WithTranslation, withTranslation } from 'react-i18next';
type FieldMaxZoomInternalProps = { type FieldMaxZoomProps = {
value?: number value?: number
onChange(value: number | undefined): unknown onChange(...args: unknown[]): unknown
error?: {message: string} error?: unknown[]
} & WithTranslation; };
class FieldMaxZoomInternal extends React.Component<FieldMaxZoomInternalProps> { export default class FieldMaxZoom extends React.Component<FieldMaxZoomProps> {
render() { render() {
const t = this.props.t; return <Block label={"Max Zoom"} fieldSpec={latest.layer.maxzoom}
return <Block label={t("Max Zoom")} fieldSpec={latest.layer.maxzoom}
error={this.props.error} error={this.props.error}
data-wd-key="max-zoom" data-wd-key="max-zoom"
> >
@@ -25,11 +23,7 @@ class FieldMaxZoomInternal extends React.Component<FieldMaxZoomInternalProps> {
min={latest.layer.maxzoom.minimum} min={latest.layer.maxzoom.minimum}
max={latest.layer.maxzoom.maximum} max={latest.layer.maxzoom.maximum}
default={latest.layer.maxzoom.maximum} default={latest.layer.maxzoom.maximum}
data-wd-key="max-zoom.input"
/> />
</Block> </Block>
} }
} }
const FieldMaxZoom = withTranslation()(FieldMaxZoomInternal);
export default FieldMaxZoom;
+6 -12
View File
@@ -1,20 +1,18 @@
import React from 'react' import React from 'react'
import latest from '@maplibre/maplibre-gl-style-spec/dist/latest.json' import {latest} from '@maplibre/maplibre-gl-style-spec'
import Block from './Block' import Block from './Block'
import InputNumber from './InputNumber' import InputNumber from './InputNumber'
import { WithTranslation, withTranslation } from 'react-i18next';
type FieldMinZoomInternalProps = { type FieldMinZoomProps = {
value?: number value?: number
onChange(...args: unknown[]): unknown onChange(...args: unknown[]): unknown
error?: {message: string} error?: unknown[]
} & WithTranslation; };
class FieldMinZoomInternal extends React.Component<FieldMinZoomInternalProps> { export default class FieldMinZoom extends React.Component<FieldMinZoomProps> {
render() { render() {
const t = this.props.t; return <Block label={"Min Zoom"} fieldSpec={latest.layer.minzoom}
return <Block label={t("Min Zoom")} fieldSpec={latest.layer.minzoom}
error={this.props.error} error={this.props.error}
data-wd-key="min-zoom" data-wd-key="min-zoom"
> >
@@ -25,11 +23,7 @@ class FieldMinZoomInternal extends React.Component<FieldMinZoomInternalProps> {
min={latest.layer.minzoom.minimum} min={latest.layer.minzoom.minimum}
max={latest.layer.minzoom.maximum} max={latest.layer.minzoom.maximum}
default={latest.layer.minzoom.minimum} default={latest.layer.minzoom.minimum}
data-wd-key='min-zoom.input'
/> />
</Block> </Block>
} }
} }
const FieldMinZoom = withTranslation()(FieldMinZoomInternal);
export default FieldMinZoom;
+7 -12
View File
@@ -1,28 +1,26 @@
import React from 'react' import React from 'react'
import latest from '@maplibre/maplibre-gl-style-spec/dist/latest.json' import {latest} from '@maplibre/maplibre-gl-style-spec'
import Block from './Block' import Block from './Block'
import InputAutocomplete from './InputAutocomplete' import InputAutocomplete from './InputAutocomplete'
import { WithTranslation, withTranslation } from 'react-i18next';
type FieldSourceInternalProps = { type FieldSourceProps = {
value?: string value?: string
wdKey?: string wdKey?: string
onChange?(value: string| undefined): unknown onChange?(...args: unknown[]): unknown
sourceIds?: unknown[] sourceIds?: unknown[]
error?: {message: string} error?: unknown[]
} & WithTranslation; };
class FieldSourceInternal extends React.Component<FieldSourceInternalProps> { export default class FieldSource extends React.Component<FieldSourceProps> {
static defaultProps = { static defaultProps = {
onChange: () => {}, onChange: () => {},
sourceIds: [], sourceIds: [],
} }
render() { render() {
const t = this.props.t;
return <Block return <Block
label={t("Source")} label={"Source"}
fieldSpec={latest.layer.source} fieldSpec={latest.layer.source}
error={this.props.error} error={this.props.error}
data-wd-key={this.props.wdKey} data-wd-key={this.props.wdKey}
@@ -35,6 +33,3 @@ class FieldSourceInternal extends React.Component<FieldSourceInternalProps> {
</Block> </Block>
} }
} }
const FieldSource = withTranslation()(FieldSourceInternal);
export default FieldSource;
+4 -13
View File
@@ -3,17 +3,15 @@ import React from 'react'
import {latest} from '@maplibre/maplibre-gl-style-spec' import {latest} from '@maplibre/maplibre-gl-style-spec'
import Block from './Block' import Block from './Block'
import InputAutocomplete from './InputAutocomplete' import InputAutocomplete from './InputAutocomplete'
import { WithTranslation, withTranslation } from 'react-i18next';
type FieldSourceLayerInternalProps = { type FieldSourceLayerProps = {
value?: string value?: string
onChange?(...args: unknown[]): unknown onChange?(...args: unknown[]): unknown
sourceLayerIds?: unknown[] sourceLayerIds?: unknown[]
isFixed?: boolean isFixed?: boolean
error?: {message: string} };
} & WithTranslation;
class FieldSourceLayerInternal extends React.Component<FieldSourceLayerInternalProps> { export default class FieldSourceLayer extends React.Component<FieldSourceLayerProps> {
static defaultProps = { static defaultProps = {
onChange: () => {}, onChange: () => {},
sourceLayerIds: [], sourceLayerIds: [],
@@ -21,12 +19,8 @@ class FieldSourceLayerInternal extends React.Component<FieldSourceLayerInternalP
} }
render() { render() {
const t = this.props.t; return <Block label={"Source Layer"} fieldSpec={latest.layer['source-layer']}
return <Block
label={t("Source Layer")}
fieldSpec={latest.layer['source-layer']}
data-wd-key="layer-source-layer" data-wd-key="layer-source-layer"
error={this.props.error}
> >
<InputAutocomplete <InputAutocomplete
keepMenuWithinWindowBounds={!!this.props.isFixed} keepMenuWithinWindowBounds={!!this.props.isFixed}
@@ -37,6 +31,3 @@ class FieldSourceLayerInternal extends React.Component<FieldSourceLayerInternalP
</Block> </Block>
} }
} }
const FieldSourceLayer = withTranslation()(FieldSourceLayerInternal);
export default FieldSourceLayer;
+7 -13
View File
@@ -1,27 +1,25 @@
import React from 'react' import React from 'react'
import latest from '@maplibre/maplibre-gl-style-spec/dist/latest.json' import {latest} from '@maplibre/maplibre-gl-style-spec'
import Block from './Block' import Block from './Block'
import InputSelect from './InputSelect' import InputSelect from './InputSelect'
import InputString from './InputString' import InputString from './InputString'
import { WithTranslation, withTranslation } from 'react-i18next';
type FieldTypeInternalProps = { type FieldTypeProps = {
value: string value: string
wdKey?: string wdKey?: string
onChange(value: string): unknown onChange(...args: unknown[]): unknown
error?: {message: string} error?: unknown[] | undefined
disabled?: boolean disabled?: boolean
} & WithTranslation; };
class FieldTypeInternal extends React.Component<FieldTypeInternalProps> { export default class FieldType extends React.Component<FieldTypeProps> {
static defaultProps = { static defaultProps = {
disabled: false, disabled: false,
} }
render() { render() {
const t = this.props.t; return <Block label={"Type"} fieldSpec={latest.layer.type}
return <Block label={t("Type")} fieldSpec={latest.layer.type}
data-wd-key={this.props.wdKey} data-wd-key={this.props.wdKey}
error={this.props.error} error={this.props.error}
> >
@@ -46,12 +44,8 @@ class FieldTypeInternal extends React.Component<FieldTypeInternalProps> {
]} ]}
onChange={this.props.onChange} onChange={this.props.onChange}
value={this.props.value} value={this.props.value}
data-wd-key={this.props.wdKey + ".select"}
/> />
} }
</Block> </Block>
} }
} }
const FieldType = withTranslation()(FieldTypeInternal);
export default FieldType;
+5 -4
View File
@@ -1,9 +1,8 @@
import React, { PropsWithChildren, ReactElement } from 'react' import React, { ReactElement } from 'react'
import FieldDocLabel from './FieldDocLabel' import FieldDocLabel from './FieldDocLabel'
import Doc from './Doc' import Doc from './Doc'
import generateUniqueId from '../libs/document-uid';
type FieldsetProps = PropsWithChildren & { type FieldsetProps = {
label?: string, label?: string,
fieldSpec?: { doc?: string }, fieldSpec?: { doc?: string },
action?: ReactElement, action?: ReactElement,
@@ -13,12 +12,14 @@ type FieldsetState = {
showDoc: boolean showDoc: boolean
}; };
let IDX = 0;
export default class Fieldset extends React.Component<FieldsetProps, FieldsetState> { export default class Fieldset extends React.Component<FieldsetProps, FieldsetState> {
_labelId: string; _labelId: string;
constructor (props: FieldsetProps) { constructor (props: FieldsetProps) {
super(props); super(props);
this._labelId = generateUniqueId(`fieldset_label_`); this._labelId = `fieldset_label_${(IDX++)}`;
this.state = { this.state = {
showDoc: false, showDoc: false,
} }
@@ -1,11 +1,10 @@
import React from 'react' import React from 'react'
import PropTypes from 'prop-types'
import {combiningFilterOps} from '../libs/filterops'
import {mdiTableRowPlusAfter} from '@mdi/js'; import {mdiTableRowPlusAfter} from '@mdi/js';
import {isEqual} from 'lodash'; import {isEqual} from 'lodash';
import {ExpressionSpecification, LegacyFilterSpecification, StyleSpecification} from 'maplibre-gl'
import {latest, migrate, convertFilter} from '@maplibre/maplibre-gl-style-spec'
import {mdiFunctionVariant} from '@mdi/js';
import {combiningFilterOps} from '../libs/filterops' import {latest, migrate, convertFilter} from '@maplibre/maplibre-gl-style-spec'
import InputSelect from './InputSelect' import InputSelect from './InputSelect'
import Block from './Block' import Block from './Block'
import SingleFilterEditor from './SingleFilterEditor' import SingleFilterEditor from './SingleFilterEditor'
@@ -13,11 +12,11 @@ import FilterEditorBlock from './FilterEditorBlock'
import InputButton from './InputButton' import InputButton from './InputButton'
import Doc from './Doc' import Doc from './Doc'
import ExpressionProperty from './_ExpressionProperty'; import ExpressionProperty from './_ExpressionProperty';
import { WithTranslation, withTranslation } from 'react-i18next'; import {mdiFunctionVariant} from '@mdi/js';
function combiningFilter(props: FilterEditorInternalProps): LegacyFilterSpecification | ExpressionSpecification { function combiningFilter (props) {
const filter = props.filter || ['all']; let filter = props.filter || ['all'];
if (!Array.isArray(filter)) { if (!Array.isArray(filter)) {
return filter; return filter;
@@ -31,15 +30,14 @@ function combiningFilter(props: FilterEditorInternalProps): LegacyFilterSpecific
filters = [filter.slice(0)]; filters = [filter.slice(0)];
} }
return [combiningOp, ...filters] as LegacyFilterSpecification | ExpressionSpecification; return [combiningOp, ...filters];
} }
function migrateFilter(filter: LegacyFilterSpecification | ExpressionSpecification) { function migrateFilter (filter) {
// This "any" can be removed in latest version of maplibre where maplibre re-exported types from style-spec return migrate(createStyleFromFilter(filter)).layers[0].filter;
return (migrate(createStyleFromFilter(filter) as any).layers[0] as any).filter;
} }
function createStyleFromFilter(filter: LegacyFilterSpecification | ExpressionSpecification): StyleSpecification & {id: string} { function createStyleFromFilter (filter) {
return { return {
"id": "tmp", "id": "tmp",
"version": 8, "version": 8,
@@ -48,7 +46,7 @@ function createStyleFromFilter(filter: LegacyFilterSpecification | ExpressionSpe
"sources": { "sources": {
"tmp": { "tmp": {
"type": "geojson", "type": "geojson",
"data": '' "data": {}
} }
}, },
"sprite": "", "sprite": "",
@@ -71,7 +69,7 @@ const FILTER_OPS = [
]; ];
// If we convert a filter that is an expression to an expression it'll remain the same in value // If we convert a filter that is an expression to an expression it'll remain the same in value
function checkIfSimpleFilter (filter: LegacyFilterSpecification | ExpressionSpecification) { function checkIfSimpleFilter (filter) {
if (filter.length === 1 && FILTER_OPS.includes(filter[0])) { if (filter.length === 1 && FILTER_OPS.includes(filter[0])) {
return true; return true;
} }
@@ -79,38 +77,33 @@ function checkIfSimpleFilter (filter: LegacyFilterSpecification | ExpressionSpec
return !isEqual(expression, filter); return !isEqual(expression, filter);
} }
function hasCombiningFilter(filter: LegacyFilterSpecification | ExpressionSpecification) { function hasCombiningFilter(filter) {
return combiningFilterOps.indexOf(filter[0]) >= 0 return combiningFilterOps.indexOf(filter[0]) >= 0
} }
function hasNestedCombiningFilter(filter: LegacyFilterSpecification | ExpressionSpecification) { function hasNestedCombiningFilter(filter) {
if(hasCombiningFilter(filter)) { if(hasCombiningFilter(filter)) {
return filter.slice(1).map(f => hasCombiningFilter(f as any)).filter(f => f == true).length > 0 const combinedFilters = filter.slice(1)
return filter.slice(1).map(f => hasCombiningFilter(f)).filter(f => f == true).length > 0
} }
return false return false
} }
type FilterEditorInternalProps = { export default class FilterEditor extends React.Component {
/** Properties of the vector layer and the available fields */ static propTypes = {
properties?: {[key:string]: any} /** Properties of the vector layer and the available fields */
filter?: any[] properties: PropTypes.object,
errors?: {[key:string]: any} filter: PropTypes.array,
onChange(value: LegacyFilterSpecification | ExpressionSpecification): unknown errors: PropTypes.object,
} & WithTranslation; onChange: PropTypes.func.isRequired,
}
type FilterEditorState = {
showDoc: boolean
displaySimpleFilter: boolean
valueIsSimpleFilter?: boolean
};
class FilterEditorInternal extends React.Component<FilterEditorInternalProps, FilterEditorState> {
static defaultProps = { static defaultProps = {
filter: ["all"], filter: ["all"],
} }
constructor (props: FilterEditorInternalProps) { constructor (props) {
super(props); super();
this.state = { this.state = {
showDoc: false, showDoc: false,
displaySimpleFilter: checkIfSimpleFilter(combiningFilter(props)), displaySimpleFilter: checkIfSimpleFilter(combiningFilter(props)),
@@ -118,25 +111,25 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
} }
// Convert filter to combining filter // Convert filter to combining filter
onFilterPartChanged(filterIdx: number, newPart: any[]) { onFilterPartChanged(filterIdx, newPart) {
const newFilter = combiningFilter(this.props).slice(0) as LegacyFilterSpecification | ExpressionSpecification const newFilter = combiningFilter(this.props).slice(0)
newFilter[filterIdx] = newPart newFilter[filterIdx] = newPart
this.props.onChange(newFilter) this.props.onChange(newFilter)
} }
deleteFilterItem(filterIdx: number) { deleteFilterItem(filterIdx) {
const newFilter = combiningFilter(this.props).slice(0) as LegacyFilterSpecification | ExpressionSpecification const newFilter = combiningFilter(this.props).slice(0)
newFilter.splice(filterIdx + 1, 1) newFilter.splice(filterIdx + 1, 1)
this.props.onChange(newFilter) this.props.onChange(newFilter)
} }
addFilterItem = () => { addFilterItem = () => {
const newFilterItem = combiningFilter(this.props).slice(0) as LegacyFilterSpecification | ExpressionSpecification const newFilterItem = combiningFilter(this.props).slice(0)
(newFilterItem as any[]).push(['==', 'name', '']) newFilterItem.push(['==', 'name', ''])
this.props.onChange(newFilterItem) this.props.onChange(newFilterItem)
} }
onToggleDoc = (val: boolean) => { onToggleDoc = (val) => {
this.setState({ this.setState({
showDoc: val showDoc: val
}); });
@@ -149,24 +142,25 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
} }
makeExpression = () => { makeExpression = () => {
const filter = combiningFilter(this.props); let filter = combiningFilter(this.props);
this.props.onChange(migrateFilter(filter)); this.props.onChange(migrateFilter(filter));
this.setState({ this.setState({
displaySimpleFilter: false, displaySimpleFilter: false,
}) })
} }
static getDerivedStateFromProps(props: Readonly<FilterEditorInternalProps>, state: FilterEditorState) { static getDerivedStateFromProps (props, currentState) {
const {filter} = props;
const displaySimpleFilter = checkIfSimpleFilter(combiningFilter(props)); const displaySimpleFilter = checkIfSimpleFilter(combiningFilter(props));
// Upgrade but never downgrade // Upgrade but never downgrade
if (!displaySimpleFilter && state.displaySimpleFilter === true) { if (!displaySimpleFilter && currentState.displaySimpleFilter === true) {
return { return {
displaySimpleFilter: false, displaySimpleFilter: false,
valueIsSimpleFilter: false, valueIsSimpleFilter: false,
}; };
} }
else if (displaySimpleFilter && state.displaySimpleFilter === false) { else if (displaySimpleFilter && currentState.displaySimpleFilter === false) {
return { return {
valueIsSimpleFilter: true, valueIsSimpleFilter: true,
} }
@@ -179,41 +173,41 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
} }
render() { render() {
const {errors, t} = this.props; const {errors} = this.props;
const {displaySimpleFilter} = this.state; const {displaySimpleFilter} = this.state;
const fieldSpec={ const fieldSpec={
doc: latest.layer.filter.doc + " Combine multiple filters together by using a compound filter." doc: latest.layer.filter.doc + " Combine multiple filters together by using a compound filter."
}; };
const defaultFilter = ["all"] as LegacyFilterSpecification | ExpressionSpecification; const defaultFilter = ["all"];
const isNestedCombiningFilter = displaySimpleFilter && hasNestedCombiningFilter(combiningFilter(this.props)); const isNestedCombiningFilter = displaySimpleFilter && hasNestedCombiningFilter(combiningFilter(this.props));
if (isNestedCombiningFilter) { if (isNestedCombiningFilter) {
return <div className="maputnik-filter-editor-unsupported"> return <div className="maputnik-filter-editor-unsupported">
<p> <p>
{t("Nested filters are not supported.")} Nested filters are not supported.
</p> </p>
<InputButton <InputButton
onClick={this.makeExpression} onClick={this.makeExpression}
title={t("Convert to expression")} title="Convert to expression"
> >
<svg style={{marginRight: "0.2em", width:"14px", height:"14px", verticalAlign: "middle"}} viewBox="0 0 24 24"> <svg style={{marginRight: "0.2em", width:"14px", height:"14px", verticalAlign: "middle"}} viewBox="0 0 24 24">
<path fill="currentColor" d={mdiFunctionVariant} /> <path fill="currentColor" d={mdiFunctionVariant} />
</svg> </svg>
{t("Upgrade to expression")} Upgrade to expression
</InputButton> </InputButton>
</div> </div>
} }
else if (displaySimpleFilter) { else if (displaySimpleFilter) {
const filter = combiningFilter(this.props); const filter = combiningFilter(this.props);
const combiningOp = filter[0]; let combiningOp = filter[0];
const filters = filter.slice(1) as (LegacyFilterSpecification | ExpressionSpecification)[]; let filters = filter.slice(1)
const actions = ( const actions = (
<div> <div>
<InputButton <InputButton
onClick={this.makeExpression} onClick={this.makeExpression}
title={t("Convert to expression")} title="Convert to expression"
className="maputnik-make-zoom-function" className="maputnik-make-zoom-function"
> >
<svg style={{width:"14px", height:"14px", verticalAlign: "middle"}} viewBox="0 0 24 24"> <svg style={{width:"14px", height:"14px", verticalAlign: "middle"}} viewBox="0 0 24 24">
@@ -224,7 +218,7 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
); );
const editorBlocks = filters.map((f, idx) => { const editorBlocks = filters.map((f, idx) => {
const error = errors![`filter[${idx+1}]`]; const error = errors[`filter[${idx+1}]`];
return ( return (
<div key={`block-${idx}`}> <div key={`block-${idx}`}>
@@ -248,17 +242,13 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
<Block <Block
key="top" key="top"
fieldSpec={fieldSpec} fieldSpec={fieldSpec}
label={t("Filter")} label={"Filter"}
action={actions} action={actions}
> >
<InputSelect <InputSelect
value={combiningOp} value={combiningOp}
onChange={(v: [string, any]) => this.onFilterPartChanged(0, v)} onChange={this.onFilterPartChanged.bind(this, 0)}
options={[ options={[["all", "every filter matches"], ["none", "no filter matches"], ["any", "any filter matches"]]}
["all", t("every filter matches")],
["none", t("no filter matches")],
["any", t("any filter matches")]
]}
/> />
</Block> </Block>
{editorBlocks} {editorBlocks}
@@ -273,7 +263,7 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
> >
<svg style={{width:"14px", height:"14px", verticalAlign: "text-bottom"}} viewBox="0 0 24 24"> <svg style={{width:"14px", height:"14px", verticalAlign: "text-bottom"}} viewBox="0 0 24 24">
<path fill="currentColor" d={mdiTableRowPlusAfter} /> <path fill="currentColor" d={mdiTableRowPlusAfter} />
</svg> {t("Add filter")} </svg> Add filter
</InputButton> </InputButton>
</div> </div>
<div <div
@@ -287,7 +277,7 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
); );
} }
else { else {
const {filter} = this.props; let {filter} = this.props;
return ( return (
<> <>
@@ -304,13 +294,12 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
/> />
{this.state.valueIsSimpleFilter && {this.state.valueIsSimpleFilter &&
<div className="maputnik-expr-infobox"> <div className="maputnik-expr-infobox">
{t("You've entered an old style filter.")} You&apos;ve entered a old style filter,{' '}
{' '}
<button <button
onClick={this.makeFilter} onClick={this.makeFilter}
className="maputnik-expr-infobox__button" className="maputnik-expr-infobox__button"
> >
{t("Switch to filter editor.")} switch to filter editor
</button> </button>
</div> </div>
} }
@@ -319,6 +308,3 @@ class FilterEditorInternal extends React.Component<FilterEditorInternalProps, Fi
} }
} }
} }
const FilterEditor = withTranslation()(FilterEditorInternal);
export default FilterEditor;
+5 -9
View File
@@ -1,21 +1,19 @@
import React, { PropsWithChildren } from 'react' import React from 'react'
import InputButton from './InputButton' import InputButton from './InputButton'
import {MdDelete} from 'react-icons/md' import {MdDelete} from 'react-icons/md'
import { WithTranslation, withTranslation } from 'react-i18next';
type FilterEditorBlockInternalProps = PropsWithChildren & { type FilterEditorBlockProps = {
onDelete(...args: unknown[]): unknown onDelete(...args: unknown[]): unknown
} & WithTranslation; };
class FilterEditorBlockInternal extends React.Component<FilterEditorBlockInternalProps> { export default class FilterEditorBlock extends React.Component<FilterEditorBlockProps> {
render() { render() {
const t = this.props.t;
return <div className="maputnik-filter-editor-block"> return <div className="maputnik-filter-editor-block">
<div className="maputnik-filter-editor-block-action"> <div className="maputnik-filter-editor-block-action">
<InputButton <InputButton
className="maputnik-delete-filter" className="maputnik-delete-filter"
onClick={this.props.onDelete} onClick={this.props.onDelete}
title={t("Delete filter block")} title="Delete filter block"
> >
<MdDelete /> <MdDelete />
</InputButton> </InputButton>
@@ -27,5 +25,3 @@ class FilterEditorBlockInternal extends React.Component<FilterEditorBlockInterna
} }
} }
const FilterEditorBlock = withTranslation()(FilterEditorBlockInternal);
export default FilterEditorBlock;
+10 -11
View File
@@ -10,23 +10,22 @@ import IconMissing from './IconMissing'
type IconLayerProps = { type IconLayerProps = {
type: string type: string
style?: object style?: object
className?: string
}; };
export default class IconLayer extends React.Component<IconLayerProps> { export default class IconLayer extends React.Component<IconLayerProps> {
render() { render() {
const iconProps = { style: this.props.style } const iconProps = { style: this.props.style }
switch(this.props.type) { switch(this.props.type) {
case 'fill-extrusion': return <IconBackground {...iconProps} /> case 'fill-extrusion': return <IconBackground {...iconProps} />
case 'raster': return <IconFill {...iconProps} /> case 'raster': return <IconFill {...iconProps} />
case 'hillshade': return <IconFill {...iconProps} /> case 'hillshade': return <IconFill {...iconProps} />
case 'heatmap': return <IconFill {...iconProps} /> case 'heatmap': return <IconFill {...iconProps} />
case 'fill': return <IconFill {...iconProps} /> case 'fill': return <IconFill {...iconProps} />
case 'background': return <IconBackground {...iconProps} /> case 'background': return <IconBackground {...iconProps} />
case 'line': return <IconLine {...iconProps} /> case 'line': return <IconLine {...iconProps} />
case 'symbol': return <IconSymbol {...iconProps} /> case 'symbol': return <IconSymbol {...iconProps} />
case 'circle': return <IconCircle {...iconProps} /> case 'circle': return <IconCircle {...iconProps} />
default: return <IconMissing {...iconProps} /> default: return <IconMissing {...iconProps} />
} }
} }
} }
+1 -1
View File
@@ -32,7 +32,7 @@ export default class FieldArray extends React.Component<FieldArrayProps, FieldAr
}; };
} }
static getDerivedStateFromProps(props: Readonly<FieldArrayProps>, state: FieldArrayState) { static getDerivedStateFromProps(props: FieldArrayProps, state: FieldArrayState) {
const value: any[] = []; const value: any[] = [];
const initialPropsValue = state.initialPropsValue.slice(0); const initialPropsValue = state.initialPropsValue.slice(0);
+2 -2
View File
@@ -8,7 +8,7 @@ const MAX_HEIGHT = 140;
export type InputAutocompleteProps = { export type InputAutocompleteProps = {
value?: string value?: string
options: any[] options: any[]
onChange(value: string | undefined): unknown onChange(...args: unknown[]): unknown
keepMenuWithinWindowBounds?: boolean keepMenuWithinWindowBounds?: boolean
'aria-label'?: string 'aria-label'?: string
}; };
@@ -91,7 +91,7 @@ export default class InputAutocomplete extends React.Component<InputAutocomplete
"maputnik-autocomplete-menu-item-selected": isHighlighted, "maputnik-autocomplete-menu-item-selected": isHighlighted,
})} })}
> >
{item[1]} {item[1]}
</div> </div>
)} )}
/> />
+2 -2
View File
@@ -27,8 +27,8 @@ export default class InputCheckbox extends React.Component<InputCheckboxProps> {
/> />
<div className="maputnik-checkbox-box"> <div className="maputnik-checkbox-box">
<svg style={{ <svg style={{
display: this.props.value ? 'inline' : 'none' display: this.props.value ? 'inline' : 'none'
}} className="maputnik-checkbox-icon" viewBox='0 0 32 32'> }} className="maputnik-checkbox-icon" viewBox='0 0 32 32'>
<path d='M1 14 L5 10 L13 18 L27 4 L31 8 L13 26 z' /> <path d='M1 14 L5 10 L13 18 L27 4 L31 8 L13 26 z' />
</svg> </svg>
</div> </div>
+3 -3
View File
@@ -87,8 +87,8 @@ export default class InputColor extends React.Component<InputColorProps> {
const picker = <div const picker = <div
className="maputnik-color-picker-offset" className="maputnik-color-picker-offset"
style={{ style={{
position: 'fixed', position: 'fixed',
zIndex: 1, zIndex: 1,
left: offset.left, left: offset.left,
top: offset.top, top: offset.top,
}}> }}>
@@ -110,7 +110,7 @@ export default class InputColor extends React.Component<InputColorProps> {
/> />
</div> </div>
const swatchStyle = { var swatchStyle = {
backgroundColor: this.props.value backgroundColor: this.props.value
}; };
+8 -18
View File
@@ -1,7 +1,6 @@
import React from 'react' import React from 'react'
import capitalize from 'lodash.capitalize' import capitalize from 'lodash.capitalize'
import {MdDelete} from 'react-icons/md' import {MdDelete} from 'react-icons/md'
import { WithTranslation, withTranslation } from 'react-i18next';
import InputString from './InputString' import InputString from './InputString'
import InputNumber from './InputNumber' import InputNumber from './InputNumber'
@@ -22,11 +21,10 @@ export type FieldDynamicArrayProps = {
} }
'aria-label'?: string 'aria-label'?: string
label: string label: string
} };
type FieldDynamicArrayInternalProps = FieldDynamicArrayProps & WithTranslation;
class FieldDynamicArrayInternal extends React.Component<FieldDynamicArrayInternalProps> { export default class FieldDynamicArray extends React.Component<FieldDynamicArrayProps> {
changeValue(idx: number, newValue: string | number | undefined) { changeValue(idx: number, newValue: string | number | undefined) {
const values = this.values.slice(0) const values = this.values.slice(0)
values[idx] = newValue values[idx] = newValue
@@ -64,13 +62,8 @@ class FieldDynamicArrayInternal extends React.Component<FieldDynamicArrayInterna
} }
render() { render() {
const t = this.props.t;
const i18nProps = { t, i18n: this.props.i18n, tReady: this.props.tReady };
const inputs = this.values.map((v, i) => { const inputs = this.values.map((v, i) => {
const deleteValueBtn= <DeleteValueInputButton const deleteValueBtn= <DeleteValueInputButton onClick={this.deleteValue.bind(this, i)} />
onClick={this.deleteValue.bind(this, i)}
{...i18nProps}
/>;
let input; let input;
if(this.props.type === 'url') { if(this.props.type === 'url') {
input = <InputUrl input = <InputUrl
@@ -107,7 +100,7 @@ class FieldDynamicArrayInternal extends React.Component<FieldDynamicArrayInterna
style={this.props.style} style={this.props.style}
key={i} key={i}
className="maputnik-array-block" className="maputnik-array-block"
> >
<div className="maputnik-array-block-action"> <div className="maputnik-array-block-action">
{deleteValueBtn} {deleteValueBtn}
</div> </div>
@@ -124,30 +117,27 @@ class FieldDynamicArrayInternal extends React.Component<FieldDynamicArrayInterna
className="maputnik-array-add-value" className="maputnik-array-add-value"
onClick={this.addValue} onClick={this.addValue}
> >
{t("Add value")} Add value
</InputButton> </InputButton>
</div> </div>
); );
} }
} }
const FieldDynamicArray = withTranslation()(FieldDynamicArrayInternal);
export default FieldDynamicArray;
type DeleteValueInputButtonProps = { type DeleteValueInputButtonProps = {
onClick?(...args: unknown[]): unknown onClick?(...args: unknown[]): unknown
} & WithTranslation; };
class DeleteValueInputButton extends React.Component<DeleteValueInputButtonProps> { class DeleteValueInputButton extends React.Component<DeleteValueInputButtonProps> {
render() { render() {
const t = this.props.t;
return <InputButton return <InputButton
className="maputnik-delete-stop" className="maputnik-delete-stop"
onClick={this.props.onClick} onClick={this.props.onClick}
title={t("Remove array item")} title="Remove array item"
> >
<FieldDocLabel <FieldDocLabel
label={<MdDelete />} label={<MdDelete />}
fieldSpec={{doc:" Remove array item."}}
/> />
</InputButton> </InputButton>
} }
+4 -12
View File
@@ -1,7 +1,6 @@
import React from 'react' import React from 'react'
import classnames from 'classnames'; import classnames from 'classnames';
import CodeMirror, { ModeSpec } from 'codemirror'; import CodeMirror, { ModeSpec } from 'codemirror';
import { Trans, WithTranslation, withTranslation } from 'react-i18next';
import 'codemirror/mode/javascript/javascript' import 'codemirror/mode/javascript/javascript'
import 'codemirror/addon/lint/lint' import 'codemirror/addon/lint/lint'
@@ -9,7 +8,7 @@ import 'codemirror/addon/edit/matchbrackets'
import 'codemirror/lib/codemirror.css' import 'codemirror/lib/codemirror.css'
import 'codemirror/addon/lint/lint.css' import 'codemirror/addon/lint/lint.css'
import stringifyPretty from 'json-stringify-pretty-compact' import stringifyPretty from 'json-stringify-pretty-compact'
import '../libs/codemirror-mgl'; import '../util/codemirror-mgl';
export type InputJsonProps = { export type InputJsonProps = {
@@ -28,7 +27,6 @@ export type InputJsonProps = {
mode?: ModeSpec<any> mode?: ModeSpec<any>
lint?: boolean | object lint?: boolean | object
}; };
type InputJsonInternalProps = InputJsonProps & WithTranslation;
type InputJsonState = { type InputJsonState = {
isEditing: boolean isEditing: boolean
@@ -36,7 +34,7 @@ type InputJsonState = {
prevValue: string prevValue: string
}; };
class InputJsonInternal extends React.Component<InputJsonInternalProps, InputJsonState> { export default class InputJson extends React.Component<InputJsonProps, InputJsonState> {
static defaultProps = { static defaultProps = {
lineNumbers: true, lineNumbers: true,
lineWrapping: false, lineWrapping: false,
@@ -54,7 +52,7 @@ class InputJsonInternal extends React.Component<InputJsonInternalProps, InputJso
_el: HTMLDivElement | null = null; _el: HTMLDivElement | null = null;
_cancelNextChange: boolean = false; _cancelNextChange: boolean = false;
constructor(props: InputJsonInternalProps) { constructor(props: InputJsonProps) {
super(props); super(props);
this._keyEvent = "keyboard"; this._keyEvent = "keyboard";
this.state = { this.state = {
@@ -158,7 +156,6 @@ class InputJsonInternal extends React.Component<InputJsonInternalProps, InputJso
} }
render() { render() {
const t = this.props.t;
const {showMessage} = this.state; const {showMessage} = this.state;
const style = {} as {maxHeight?: number}; const style = {} as {maxHeight?: number};
if (this.props.maxHeight) { if (this.props.maxHeight) {
@@ -167,9 +164,7 @@ class InputJsonInternal extends React.Component<InputJsonInternalProps, InputJso
return <div className="JSONEditor" onPointerDown={this.onPointerDown} aria-hidden="true"> return <div className="JSONEditor" onPointerDown={this.onPointerDown} aria-hidden="true">
<div className={classnames("JSONEditor__message", {"JSONEditor__message--on": showMessage})}> <div className={classnames("JSONEditor__message", {"JSONEditor__message--on": showMessage})}>
<Trans t={t}> Press <kbd>ESC</kbd> to lose focus
Press <kbd>ESC</kbd> to lose focus
</Trans>
</div> </div>
<div <div
className={classnames("codemirror-container", this.props.className)} className={classnames("codemirror-container", this.props.className)}
@@ -179,6 +174,3 @@ class InputJsonInternal extends React.Component<InputJsonInternalProps, InputJso
</div> </div>
} }
} }
const InputJson = withTranslation()(InputJsonInternal);
export default InputJson;
+10 -17
View File
@@ -1,5 +1,6 @@
import React, { BaseSyntheticEvent } from 'react' import React, { BaseSyntheticEvent } from 'react'
import generateUniqueId from '../libs/document-uid';
let IDX = 0;
export type InputNumberProps = { export type InputNumberProps = {
value?: number value?: number
@@ -9,7 +10,7 @@ export type InputNumberProps = {
onChange?(value: number | undefined): unknown onChange?(value: number | undefined): unknown
allowRange?: boolean allowRange?: boolean
rangeStep?: number rangeStep?: number
"data-wd-key"?: string wdKey?: string
required?: boolean required?: boolean
"aria-label"?: string "aria-label"?: string
}; };
@@ -19,10 +20,7 @@ type InputNumberState = {
editing: boolean editing: boolean
editingRange?: boolean editingRange?: boolean
value?: number value?: number
/** dirtyValue?: number
* This is the value that is currently being edited. It can be an invalid value.
*/
dirtyValue?: number | string | undefined
} }
export default class InputNumber extends React.Component<InputNumberProps, InputNumberState> { export default class InputNumber extends React.Component<InputNumberProps, InputNumberState> {
@@ -34,14 +32,14 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
constructor(props: InputNumberProps) { constructor(props: InputNumberProps) {
super(props) super(props)
this.state = { this.state = {
uuid: +generateUniqueId(), uuid: IDX++,
editing: false, editing: false,
value: props.value, value: props.value,
dirtyValue: props.value, dirtyValue: props.value,
} }
} }
static getDerivedStateFromProps(props: Readonly<InputNumberProps>, state: InputNumberState) { static getDerivedStateFromProps(props: InputNumberProps, state: InputNumberState) {
if (!state.editing && props.value !== state.value) { if (!state.editing && props.value !== state.value) {
return { return {
value: props.value, value: props.value,
@@ -69,7 +67,7 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
} }
this.setState({ this.setState({
dirtyValue: newValue === "" ? undefined : newValue, dirtyValue: newValue === "" ? undefined : value,
}) })
} }
@@ -128,7 +126,7 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
// for example we might go from 13 to 13.23, however because we know // for example we might go from 13 to 13.23, however because we know
// that came from a keyboard event we always want to increase by a // that came from a keyboard event we always want to increase by a
// single step value. // single step value.
if (value < +this.state.dirtyValue!) { if (value < this.state.dirtyValue!) {
value = this.state.value! - step; value = this.state.value! - step;
} }
else { else {
@@ -142,7 +140,7 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
} }
else { else {
value = value + (step - snap); value = value + (step - snap);
} };
} }
} }
@@ -157,8 +155,7 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
render() { render() {
if( if(
Object.prototype.hasOwnProperty.call(this.props, "min") && this.props.hasOwnProperty("min") && this.props.hasOwnProperty("max") &&
Object.prototype.hasOwnProperty.call(this.props, "max") &&
this.props.min !== undefined && this.props.max !== undefined && this.props.min !== undefined && this.props.max !== undefined &&
this.props.allowRange this.props.allowRange
) { ) {
@@ -200,7 +197,6 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
dirtyValue: this.state.value, dirtyValue: this.state.value,
}); });
}} }}
data-wd-key={this.props["data-wd-key"] + "-range"}
/> />
<input <input
key="text" key="text"
@@ -219,8 +215,6 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
this.setState({editing: false}); this.setState({editing: false});
this.resetValue() this.resetValue()
}} }}
data-wd-key={this.props["data-wd-key"] + "-text"}
/> />
</div> </div>
} }
@@ -239,7 +233,6 @@ export default class InputNumber extends React.Component<InputNumberProps, Input
}} }}
onBlur={this.resetValue} onBlur={this.resetValue}
required={this.props.required} required={this.props.required}
data-wd-key={this.props["data-wd-key"]}
/> />
} }
} }
+1 -1
View File
@@ -5,7 +5,7 @@ export type InputSelectProps = {
"data-wd-key"?: string "data-wd-key"?: string
options: [string, any][] | string[] options: [string, any][] | string[]
style?: object style?: object
onChange(value: string | [string, any]): unknown onChange(value: string): unknown
title?: string title?: string
'aria-label'?: string 'aria-label'?: string
}; };
+54 -56
View File
@@ -49,72 +49,70 @@ export default class SpecField extends React.Component<SpecFieldProps> {
value: this.props.value, value: this.props.value,
default: this.props.fieldSpec?.default, default: this.props.fieldSpec?.default,
name: this.props.fieldName, name: this.props.fieldName,
"data-wd-key": "spec-field-input:" + this.props.fieldName,
onChange: (newValue: number | undefined | (string | number | undefined)[]) => this.props.onChange!(this.props.fieldName, newValue), onChange: (newValue: number | undefined | (string | number | undefined)[]) => this.props.onChange!(this.props.fieldName, newValue),
'aria-label': this.props['aria-label'], 'aria-label': this.props['aria-label'],
} }
switch(this.props.fieldSpec?.type) { switch(this.props.fieldSpec?.type) {
case 'number': return ( case 'number': return (
<InputNumber <InputNumber
{...commonProps as InputNumberProps} {...commonProps as InputNumberProps}
min={this.props.fieldSpec.minimum} min={this.props.fieldSpec.minimum}
max={this.props.fieldSpec.maximum} max={this.props.fieldSpec.maximum}
/> />
) )
case 'enum': { case 'enum':
const options = Object.keys(this.props.fieldSpec.values || []).map(v => [v, capitalize(v)]) const options = Object.keys(this.props.fieldSpec.values || []).map(v => [v, capitalize(v)])
return <InputEnum return <InputEnum
{...commonProps as Omit<InputEnumProps, "options">} {...commonProps as Omit<InputEnumProps, "options">}
options={options} options={options}
/>
}
case 'resolvedImage':
case 'formatted':
case 'string':
if (iconProperties.indexOf(this.props.fieldName!) >= 0) {
const options = this.props.fieldSpec.values || [];
return <InputAutocomplete
{...commonProps as Omit<InputAutocompleteProps, "options">}
options={options.map(f => [f, f])}
/> />
} else { case 'resolvedImage':
return <InputString case 'formatted':
{...commonProps as InputStringProps} case 'string':
/> if (iconProperties.indexOf(this.props.fieldName!) >= 0) {
} const options = this.props.fieldSpec.values || [];
case 'color': return ( return <InputAutocomplete
<InputColor {...commonProps as Omit<InputAutocompleteProps, "options">}
{...commonProps as InputColorProps} options={options.map(f => [f, f])}
/>
)
case 'boolean': return (
<InputCheckbox
{...commonProps as InputCheckboxProps}
/>
)
case 'array':
if(this.props.fieldName === 'text-font') {
return <InputFont
{...commonProps as FieldFontProps}
fonts={this.props.fieldSpec.values}
/>
} else {
if (this.props.fieldSpec.length) {
return <InputArray
{...commonProps as FieldArrayProps}
type={this.props.fieldSpec.value}
length={this.props.fieldSpec.length}
/> />
} else { } else {
return <InputDynamicArray return <InputString
{...commonProps as FieldDynamicArrayProps} {...commonProps as InputStringProps}
fieldSpec={this.props.fieldSpec}
type={this.props.fieldSpec.value as FieldDynamicArrayProps['type']}
/> />
} }
} case 'color': return (
default: return null <InputColor
{...commonProps as InputColorProps}
/>
)
case 'boolean': return (
<InputCheckbox
{...commonProps as InputCheckboxProps}
/>
)
case 'array':
if(this.props.fieldName === 'text-font') {
return <InputFont
{...commonProps as FieldFontProps}
fonts={this.props.fieldSpec.values}
/>
} else {
if (this.props.fieldSpec.length) {
return <InputArray
{...commonProps as FieldArrayProps}
type={this.props.fieldSpec.value}
length={this.props.fieldSpec.length}
/>
} else {
return <InputDynamicArray
{...commonProps as FieldDynamicArrayProps}
fieldSpec={this.props.fieldSpec}
type={this.props.fieldSpec.value as FieldDynamicArrayProps['type']}
/>
}
}
default: return null
} }
} }
+4 -4
View File
@@ -33,7 +33,7 @@ export default class InputString extends React.Component<InputStringProps, Input
} }
} }
static getDerivedStateFromProps(props: Readonly<InputStringProps>, state: InputStringState) { static getDerivedStateFromProps(props: InputStringProps, state: InputStringState) {
if (!state.editing) { if (!state.editing) {
return { return {
value: props.value value: props.value
@@ -46,7 +46,7 @@ export default class InputString extends React.Component<InputStringProps, Input
let tag; let tag;
let classes; let classes;
if(this.props.multi) { if(!!this.props.multi) {
tag = "textarea" tag = "textarea"
classes = [ classes = [
"maputnik-string", "maputnik-string",
@@ -60,14 +60,14 @@ export default class InputString extends React.Component<InputStringProps, Input
] ]
} }
if(this.props.disabled) { if(!!this.props.disabled) {
classes.push("maputnik-string--disabled"); classes.push("maputnik-string--disabled");
} }
return React.createElement(tag, { return React.createElement(tag, {
"aria-label": this.props["aria-label"], "aria-label": this.props["aria-label"],
"data-wd-key": this.props["data-wd-key"], "data-wd-key": this.props["data-wd-key"],
spellCheck: Object.prototype.hasOwnProperty.call(this.props, "spellCheck") ? this.props.spellCheck : !(tag === "input"), spellCheck: this.props.hasOwnProperty("spellCheck") ? this.props.spellCheck : !(tag === "input"),
disabled: this.props.disabled, disabled: this.props.disabled,
className: classes.join(" "), className: classes.join(" "),
style: this.props.style, style: this.props.style,
+17 -28
View File
@@ -1,10 +1,9 @@
import React from 'react' import React from 'react'
import InputString from './InputString' import InputString from './InputString'
import SmallError from './SmallError' import SmallError from './SmallError'
import { Trans, WithTranslation, withTranslation } from 'react-i18next';
import { TFunction } from 'i18next';
function validate(url: string, t: TFunction): JSX.Element | undefined {
function validate(url: string) {
if (url === "") { if (url === "") {
return; return;
} }
@@ -23,19 +22,15 @@ function validate(url: string, t: TFunction): JSX.Element | undefined {
const isSsl = window.location.protocol === "https:"; const isSsl = window.location.protocol === "https:";
if (!protocol) { if (!protocol) {
if (isSsl) { error = (
error = ( <SmallError>
<SmallError> Must provide protocol {
<Trans t={t}>Must provide protocol: <code>https://</code></Trans> isSsl
</SmallError> ? <code>https://</code>
); : <><code>http://</code> or <code>https://</code></>
} else { }
error = ( </SmallError>
<SmallError> );
<Trans t={t}>Must provide protocol: <code>http://</code> or <code>https://</code></Trans>
</SmallError>
);
}
} }
else if ( else if (
protocol && protocol &&
@@ -44,9 +39,7 @@ function validate(url: string, t: TFunction): JSX.Element | undefined {
) { ) {
error = ( error = (
<SmallError> <SmallError>
<Trans t={t}> CORS policy won&apos;t allow fetching resources served over http from https, use a <code>https://</code> domain
CORS policy won&apos;t allow fetching resources served over http from https, use a <code>https://</code> domain
</Trans>
</SmallError> </SmallError>
); );
} }
@@ -68,34 +61,32 @@ export type FieldUrlProps = {
className?: string className?: string
}; };
type FieldUrlInternalProps = FieldUrlProps & WithTranslation;
type FieldUrlState = { type FieldUrlState = {
error?: React.ReactNode error?: React.ReactNode
} }
class FieldUrlInternal extends React.Component<FieldUrlInternalProps, FieldUrlState> { export default class FieldUrl extends React.Component<FieldUrlProps, FieldUrlState> {
static defaultProps = { static defaultProps = {
onInput: () => {}, onInput: () => {},
} }
constructor (props: FieldUrlInternalProps) { constructor (props: FieldUrlProps) {
super(props); super(props);
this.state = { this.state = {
error: validate(props.value, props.t), error: validate(props.value)
}; };
} }
onInput = (url: string) => { onInput = (url: string) => {
this.setState({ this.setState({
error: validate(url, this.props.t), error: validate(url)
}); });
if (this.props.onInput) this.props.onInput(url); if (this.props.onInput) this.props.onInput(url);
} }
onChange = (url: string) => { onChange = (url: string) => {
this.setState({ this.setState({
error: validate(url, this.props.t), error: validate(url)
}); });
this.props.onChange(url); this.props.onChange(url);
} }
@@ -115,5 +106,3 @@ class FieldUrlInternal extends React.Component<FieldUrlInternalProps, FieldUrlSt
} }
} }
const FieldUrl = withTranslation()(FieldUrlInternal);
export default FieldUrl;
+337
View File
@@ -0,0 +1,337 @@
import React from 'react'
import PropTypes from 'prop-types'
import { Wrapper, Button, Menu, MenuItem } from 'react-aria-menubutton'
import FieldJson from './FieldJson'
import FilterEditor from './FilterEditor'
import PropertyGroup from './PropertyGroup'
import LayerEditorGroup from './LayerEditorGroup'
import FieldType from './FieldType'
import FieldId from './FieldId'
import FieldMinZoom from './FieldMinZoom'
import FieldMaxZoom from './FieldMaxZoom'
import FieldComment from './FieldComment'
import FieldSource from './FieldSource'
import FieldSourceLayer from './FieldSourceLayer'
import {Accordion} from 'react-accessible-accordion';
import {MdMoreVert} from 'react-icons/md'
import { changeType, changeProperty } from '../libs/layer'
import layout from '../config/layout.json'
import {formatLayerId} from '../util/format';
function getLayoutForType (type) {
return layout[type] ? layout[type] : layout.invalid;
}
function layoutGroups(layerType) {
const layerGroup = {
title: 'Layer',
type: 'layer'
}
const filterGroup = {
title: 'Filter',
type: 'filter'
}
const editorGroup = {
title: 'JSON Editor',
type: 'jsoneditor'
}
return [layerGroup, filterGroup]
.concat(getLayoutForType(layerType).groups)
.concat([editorGroup])
}
/** Layer editor supporting multiple types of layers. */
export default class LayerEditor extends React.Component {
static propTypes = {
layer: PropTypes.object.isRequired,
sources: PropTypes.object,
vectorLayers: PropTypes.object,
spec: PropTypes.object.isRequired,
onLayerChanged: PropTypes.func,
onLayerIdChange: PropTypes.func,
onMoveLayer: PropTypes.func,
onLayerDestroy: PropTypes.func,
onLayerCopy: PropTypes.func,
onLayerVisibilityToggle: PropTypes.func,
isFirstLayer: PropTypes.bool,
isLastLayer: PropTypes.bool,
layerIndex: PropTypes.number,
errors: PropTypes.array,
}
static defaultProps = {
onLayerChanged: () => {},
onLayerIdChange: () => {},
onLayerDestroyed: () => {},
}
static childContextTypes = {
reactIconBase: PropTypes.object
}
constructor(props) {
super(props)
//TODO: Clean this up and refactor into function
const editorGroups = {}
layoutGroups(this.props.layer.type).forEach(group => {
editorGroups[group.title] = true
})
this.state = { editorGroups }
}
static getDerivedStateFromProps(props, state) {
const additionalGroups = { ...state.editorGroups }
getLayoutForType(props.layer.type).groups.forEach(group => {
if(!(group.title in additionalGroups)) {
additionalGroups[group.title] = true
}
})
return {
editorGroups: additionalGroups
};
}
getChildContext () {
return {
reactIconBase: {
size: 14,
color: '#8e8e8e',
}
}
}
changeProperty(group, property, newValue) {
this.props.onLayerChanged(
this.props.layerIndex,
changeProperty(this.props.layer, group, property, newValue)
)
}
onGroupToggle(groupTitle, active) {
const changedActiveGroups = {
...this.state.editorGroups,
[groupTitle]: active,
}
this.setState({
editorGroups: changedActiveGroups
})
}
renderGroupType(type, fields) {
let comment = ""
if(this.props.layer.metadata) {
comment = this.props.layer.metadata['maputnik:comment']
}
const {errors, layerIndex} = this.props;
const errorData = {};
errors.forEach(error => {
if (
error.parsed &&
error.parsed.type === "layer" &&
error.parsed.data.index == layerIndex
) {
errorData[error.parsed.data.key] = {
message: error.parsed.data.message
};
}
})
let sourceLayerIds;
if(this.props.sources.hasOwnProperty(this.props.layer.source)) {
sourceLayerIds = this.props.sources[this.props.layer.source].layers;
}
switch(type) {
case 'layer': return <div>
<FieldId
value={this.props.layer.id}
wdKey="layer-editor.layer-id"
error={errorData.id}
onChange={newId => this.props.onLayerIdChange(this.props.layerIndex, this.props.layer.id, newId)}
/>
<FieldType
disabled={true}
error={errorData.type}
value={this.props.layer.type}
onChange={newType => this.props.onLayerChanged(
this.props.layerIndex,
changeType(this.props.layer, newType)
)}
/>
{this.props.layer.type !== 'background' && <FieldSource
error={errorData.source}
sourceIds={Object.keys(this.props.sources)}
value={this.props.layer.source}
onChange={v => this.changeProperty(null, 'source', v)}
/>
}
{['background', 'raster', 'hillshade', 'heatmap'].indexOf(this.props.layer.type) < 0 &&
<FieldSourceLayer
error={errorData['source-layer']}
sourceLayerIds={sourceLayerIds}
value={this.props.layer['source-layer']}
onChange={v => this.changeProperty(null, 'source-layer', v)}
/>
}
<FieldMinZoom
error={errorData.minzoom}
value={this.props.layer.minzoom}
onChange={v => this.changeProperty(null, 'minzoom', v)}
/>
<FieldMaxZoom
error={errorData.maxzoom}
value={this.props.layer.maxzoom}
onChange={v => this.changeProperty(null, 'maxzoom', v)}
/>
<FieldComment
error={errorData.comment}
value={comment}
onChange={v => this.changeProperty('metadata', 'maputnik:comment', v == "" ? undefined : v)}
/>
</div>
case 'filter': return <div>
<div className="maputnik-filter-editor-wrapper">
<FilterEditor
errors={errorData}
filter={this.props.layer.filter}
properties={this.props.vectorLayers[this.props.layer['source-layer']]}
onChange={f => this.changeProperty(null, 'filter', f)}
/>
</div>
</div>
case 'properties':
return <PropertyGroup
errors={errorData}
layer={this.props.layer}
groupFields={fields}
spec={this.props.spec}
onChange={this.changeProperty.bind(this)}
/>
case 'jsoneditor':
return <FieldJson
layer={this.props.layer}
onChange={(layer) => {
this.props.onLayerChanged(
this.props.layerIndex,
layer
);
}}
/>
}
}
moveLayer(offset) {
this.props.onMoveLayer({
oldIndex: this.props.layerIndex,
newIndex: this.props.layerIndex+offset
})
}
render() {
const groupIds = [];
const layerType = this.props.layer.type
const groups = layoutGroups(layerType).filter(group => {
return !(layerType === 'background' && group.type === 'source')
}).map(group => {
const groupId = group.title.replace(/ /g, "_");
groupIds.push(groupId);
return <LayerEditorGroup
data-wd-key={group.title}
id={groupId}
key={group.title}
title={group.title}
isActive={this.state.editorGroups[group.title]}
onActiveToggle={this.onGroupToggle.bind(this, group.title)}
>
{this.renderGroupType(group.type, group.fields)}
</LayerEditorGroup>
})
const layout = this.props.layer.layout || {}
const items = {
delete: {
text: "Delete",
handler: () => this.props.onLayerDestroy(this.props.layerIndex)
},
duplicate: {
text: "Duplicate",
handler: () => this.props.onLayerCopy(this.props.layerIndex)
},
hide: {
text: (layout.visibility === "none") ? "Show" : "Hide",
handler: () => this.props.onLayerVisibilityToggle(this.props.layerIndex)
},
moveLayerUp: {
text: "Move layer up",
// Not actually used...
disabled: this.props.isFirstLayer,
handler: () => this.moveLayer(-1)
},
moveLayerDown: {
text: "Move layer down",
// Not actually used...
disabled: this.props.isLastLayer,
handler: () => this.moveLayer(+1)
}
}
function handleSelection(id, event) {
event.stopPropagation;
items[id].handler();
}
return <section className="maputnik-layer-editor"
role="main"
aria-label="Layer editor"
>
<header>
<div className="layer-header">
<h2 className="layer-header__title">
Layer: {formatLayerId(this.props.layer.id)}
</h2>
<div className="layer-header__info">
<Wrapper
className='more-menu'
onSelection={handleSelection}
closeOnSelection={false}
>
<Button id="skip-target-layer-editor" data-wd-key="skip-target-layer-editor" className='more-menu__button' title="Layer options">
<MdMoreVert className="more-menu__button__svg" />
</Button>
<Menu>
<ul className="more-menu__menu">
{Object.keys(items).map((id, idx) => {
const item = items[id];
return <li key={id}>
<MenuItem value={id} className='more-menu__menu__item'>
{item.text}
</MenuItem>
</li>
})}
</ul>
</Menu>
</Wrapper>
</div>
</div>
</header>
<Accordion
allowMultipleExpanded={true}
allowZeroExpanded={true}
preExpanded={groupIds}
>
{groups}
</Accordion>
</section>
}
}
-365
View File
@@ -1,365 +0,0 @@
import React, {type JSX} from 'react'
import PropTypes from 'prop-types'
import { Wrapper, Button, Menu, MenuItem } from 'react-aria-menubutton'
import {Accordion} from 'react-accessible-accordion';
import {MdMoreVert} from 'react-icons/md'
import {BackgroundLayerSpecification, LayerSpecification, SourceSpecification} from 'maplibre-gl';
import FieldJson from './FieldJson'
import FilterEditor from './FilterEditor'
import PropertyGroup from './PropertyGroup'
import LayerEditorGroup from './LayerEditorGroup'
import FieldType from './FieldType'
import FieldId from './FieldId'
import FieldMinZoom from './FieldMinZoom'
import FieldMaxZoom from './FieldMaxZoom'
import FieldComment from './FieldComment'
import FieldSource from './FieldSource'
import FieldSourceLayer from './FieldSourceLayer'
import { changeType, changeProperty } from '../libs/layer'
import layout from '../config/layout.json'
import {formatLayerId} from '../libs/format';
import { WithTranslation, withTranslation } from 'react-i18next';
import { TFunction } from 'i18next';
function getLayoutForType(type: LayerSpecification["type"], t: TFunction) {
return layout[type] ? {
...layout[type],
groups: layout[type].groups.map(group => {
return {
...group,
id: group.title.replace(/ /g, "_"),
title: t(group.title)
};
}),
} : layout.invalid;
}
function layoutGroups(layerType: LayerSpecification["type"], t: TFunction): {id: string, title: string, type: string, fields?: string[]}[] {
const layerGroup = {
id: 'layer',
title: t('Layer'),
type: 'layer'
}
const filterGroup = {
id: 'filter',
title: t('Filter'),
type: 'filter'
}
const editorGroup = {
id: 'jsoneditor',
title: t('JSON Editor'),
type: 'jsoneditor'
}
return [layerGroup, filterGroup]
.concat(getLayoutForType(layerType, t).groups)
.concat([editorGroup])
}
type LayerEditorInternalProps = {
layer: LayerSpecification
sources: {[key: string]: SourceSpecification}
vectorLayers: {[key: string]: any}
spec: object
onLayerChanged(...args: unknown[]): unknown
onLayerIdChange(...args: unknown[]): unknown
onMoveLayer(...args: unknown[]): unknown
onLayerDestroy(...args: unknown[]): unknown
onLayerCopy(...args: unknown[]): unknown
onLayerVisibilityToggle(...args: unknown[]): unknown
isFirstLayer?: boolean
isLastLayer?: boolean
layerIndex: number
errors?: any[]
} & WithTranslation;
type LayerEditorState = {
editorGroups: {[keys:string]: boolean}
};
/** Layer editor supporting multiple types of layers. */
class LayerEditorInternal extends React.Component<LayerEditorInternalProps, LayerEditorState> {
static defaultProps = {
onLayerChanged: () => {},
onLayerIdChange: () => {},
onLayerDestroyed: () => {},
}
static childContextTypes = {
reactIconBase: PropTypes.object
}
constructor(props: LayerEditorInternalProps) {
super(props)
//TODO: Clean this up and refactor into function
const editorGroups: {[keys:string]: boolean} = {}
layoutGroups(this.props.layer.type, props.t).forEach(group => {
editorGroups[group.title] = true
})
this.state = { editorGroups }
}
static getDerivedStateFromProps(props: Readonly<LayerEditorInternalProps>, state: LayerEditorState) {
const additionalGroups = { ...state.editorGroups }
getLayoutForType(props.layer.type, props.t).groups.forEach(group => {
if(!(group.title in additionalGroups)) {
additionalGroups[group.title] = true
}
})
return {
editorGroups: additionalGroups
};
}
getChildContext () {
return {
reactIconBase: {
size: 14,
color: '#8e8e8e',
}
}
}
changeProperty(group: keyof LayerSpecification | null, property: string, newValue: any) {
this.props.onLayerChanged(
this.props.layerIndex,
changeProperty(this.props.layer, group, property, newValue)
)
}
onGroupToggle(groupTitle: string, active: boolean) {
const changedActiveGroups = {
...this.state.editorGroups,
[groupTitle]: active,
}
this.setState({
editorGroups: changedActiveGroups
})
}
renderGroupType(type: string, fields?: string[]): JSX.Element {
let comment = ""
if(this.props.layer.metadata) {
comment = (this.props.layer.metadata as any)['maputnik:comment']
}
const {errors, layerIndex} = this.props;
const errorData: {[key in LayerSpecification as string]: {message: string}} = {};
errors!.forEach(error => {
if (
error.parsed &&
error.parsed.type === "layer" &&
error.parsed.data.index == layerIndex
) {
errorData[error.parsed.data.key] = {
message: error.parsed.data.message
};
}
})
let sourceLayerIds;
const layer = this.props.layer as Exclude<LayerSpecification, BackgroundLayerSpecification>;
if(Object.prototype.hasOwnProperty.call(this.props.sources, layer.source)) {
sourceLayerIds = (this.props.sources[layer.source] as any).layers;
}
switch(type) {
case 'layer': return <div>
<FieldId
value={this.props.layer.id}
wdKey="layer-editor.layer-id"
error={errorData.id}
onChange={newId => this.props.onLayerIdChange(this.props.layerIndex, this.props.layer.id, newId)}
/>
<FieldType
disabled={true}
error={errorData.type}
value={this.props.layer.type}
onChange={newType => this.props.onLayerChanged(
this.props.layerIndex,
changeType(this.props.layer, newType)
)}
/>
{this.props.layer.type !== 'background' && <FieldSource
error={errorData.source}
sourceIds={Object.keys(this.props.sources!)}
value={this.props.layer.source}
onChange={v => this.changeProperty(null, 'source', v)}
/>
}
{['background', 'raster', 'hillshade', 'heatmap'].indexOf(this.props.layer.type) < 0 &&
<FieldSourceLayer
error={errorData['source-layer']}
sourceLayerIds={sourceLayerIds}
value={(this.props.layer as any)['source-layer']}
onChange={v => this.changeProperty(null, 'source-layer', v)}
/>
}
<FieldMinZoom
error={errorData.minzoom}
value={this.props.layer.minzoom}
onChange={v => this.changeProperty(null, 'minzoom', v)}
/>
<FieldMaxZoom
error={errorData.maxzoom}
value={this.props.layer.maxzoom}
onChange={v => this.changeProperty(null, 'maxzoom', v)}
/>
<FieldComment
error={errorData.comment}
value={comment}
onChange={v => this.changeProperty('metadata', 'maputnik:comment', v == "" ? undefined : v)}
/>
</div>
case 'filter': return <div>
<div className="maputnik-filter-editor-wrapper">
<FilterEditor
errors={errorData}
filter={(this.props.layer as any).filter}
properties={this.props.vectorLayers[(this.props.layer as any)['source-layer']]}
onChange={f => this.changeProperty(null, 'filter', f)}
/>
</div>
</div>
case 'properties':
return <PropertyGroup
errors={errorData}
layer={this.props.layer}
groupFields={fields!}
spec={this.props.spec}
onChange={this.changeProperty.bind(this)}
/>
case 'jsoneditor':
return <FieldJson
layer={this.props.layer}
onChange={(layer) => {
this.props.onLayerChanged(
this.props.layerIndex,
layer
);
}}
/>
default: return <></>
}
}
moveLayer(offset: number) {
this.props.onMoveLayer({
oldIndex: this.props.layerIndex,
newIndex: this.props.layerIndex+offset
})
}
render() {
const t = this.props.t;
const groupIds: string[] = [];
const layerType = this.props.layer.type
const groups = layoutGroups(layerType, t).filter(group => {
return !(layerType === 'background' && group.type === 'source')
}).map(group => {
const groupId = group.id;
groupIds.push(groupId);
return <LayerEditorGroup
data-wd-key={group.title}
id={groupId}
key={groupId}
title={group.title}
isActive={this.state.editorGroups[group.title]}
onActiveToggle={this.onGroupToggle.bind(this, group.title)}
>
{this.renderGroupType(group.type, group.fields)}
</LayerEditorGroup>
})
const layout = this.props.layer.layout || {}
const items: {[key: string]: {text: string, handler: () => void, disabled?: boolean}} = {
delete: {
text: t("Delete"),
handler: () => this.props.onLayerDestroy(this.props.layerIndex)
},
duplicate: {
text: t("Duplicate"),
handler: () => this.props.onLayerCopy(this.props.layerIndex)
},
hide: {
text: (layout.visibility === "none") ? t("Show") : t("Hide"),
handler: () => this.props.onLayerVisibilityToggle(this.props.layerIndex)
},
moveLayerUp: {
text: t("Move layer up"),
// Not actually used...
disabled: this.props.isFirstLayer,
handler: () => this.moveLayer(-1)
},
moveLayerDown: {
text: t("Move layer down"),
// Not actually used...
disabled: this.props.isLastLayer,
handler: () => this.moveLayer(+1)
}
}
function handleSelection(id: string, event: React.SyntheticEvent) {
event.stopPropagation();
items[id].handler();
}
return <section className="maputnik-layer-editor"
role="main"
aria-label={t("Layer editor")}
>
<header>
<div className="layer-header">
<h2 className="layer-header__title">
{t("Layer: {{layerId}}", { layerId: formatLayerId(this.props.layer.id) })}
</h2>
<div className="layer-header__info">
<Wrapper
className='more-menu'
onSelection={handleSelection}
closeOnSelection={false}
>
<Button
id="skip-target-layer-editor"
data-wd-key="skip-target-layer-editor"
className='more-menu__button'
title={"Layer options"}>
<MdMoreVert className="more-menu__button__svg" />
</Button>
<Menu>
<ul className="more-menu__menu">
{Object.keys(items).map((id) => {
const item = items[id];
return <li key={id}>
<MenuItem value={id} className='more-menu__menu__item'>
{item.text}
</MenuItem>
</li>
})}
</ul>
</Menu>
</Wrapper>
</div>
</div>
</header>
<Accordion
allowMultipleExpanded={true}
allowZeroExpanded={true}
preExpanded={groupIds}
>
{groups}
</Accordion>
</section>
}
}
const LayerEditor = withTranslation()(LayerEditorInternal);
export default LayerEditor;
+5 -5
View File
@@ -5,10 +5,10 @@ import {
mdiMenuUp mdiMenuUp
} from '@mdi/js'; } from '@mdi/js';
import { import {
AccordionItem, AccordionItem,
AccordionItemHeading, AccordionItemHeading,
AccordionItemButton, AccordionItemButton,
AccordionItemPanel, AccordionItemPanel,
} from 'react-accessible-accordion'; } from 'react-accessible-accordion';
@@ -18,7 +18,7 @@ type LayerEditorGroupProps = {
title: string title: string
isActive: boolean isActive: boolean
children: React.ReactElement children: React.ReactElement
onActiveToggle(active: boolean): unknown onActiveToggle(...args: unknown[]): unknown
}; };
@@ -1,4 +1,5 @@
import React, {type JSX} from 'react' import React from 'react'
import PropTypes from 'prop-types'
import classnames from 'classnames' import classnames from 'classnames'
import lodash from 'lodash'; import lodash from 'lodash';
@@ -6,41 +7,44 @@ import LayerListGroup from './LayerListGroup'
import LayerListItem from './LayerListItem' import LayerListItem from './LayerListItem'
import ModalAdd from './ModalAdd' import ModalAdd from './ModalAdd'
import {SortEndHandler, SortableContainer} from 'react-sortable-hoc'; import {SortableContainer} from 'react-sortable-hoc';
import type {LayerSpecification} from 'maplibre-gl';
import generateUniqueId from '../libs/document-uid';
import { findClosestCommonPrefix, layerPrefix } from '../libs/layer';
import { WithTranslation, withTranslation } from 'react-i18next';
type LayerListContainerProps = { const layerListPropTypes = {
layers: LayerSpecification[] layers: PropTypes.array.isRequired,
selectedLayerIndex: number selectedLayerIndex: PropTypes.number.isRequired,
onLayersChange(layers: LayerSpecification[]): unknown onLayersChange: PropTypes.func.isRequired,
onLayerSelect(...args: unknown[]): unknown onLayerSelect: PropTypes.func,
onLayerDestroy?(...args: unknown[]): unknown sources: PropTypes.object.isRequired,
onLayerCopy(...args: unknown[]): unknown }
onLayerVisibilityToggle(...args: unknown[]): unknown
sources: object
errors: any[]
};
type LayerListContainerInternalProps = LayerListContainerProps & WithTranslation;
type LayerListContainerState = { function layerPrefix(name) {
collapsedGroups: {[ket: string]: boolean} return name.replace(' ', '-').replace('_', '-').split('-')[0]
areAllGroupsExpanded: boolean }
keys: {[key: string]: number}
isOpen: {[key: string]: boolean} function findClosestCommonPrefix(layers, idx) {
}; const currentLayerPrefix = layerPrefix(layers[idx].id)
let closestIdx = idx
for (let i = idx; i > 0; i--) {
const previousLayerPrefix = layerPrefix(layers[i-1].id)
if(previousLayerPrefix === currentLayerPrefix) {
closestIdx = i - 1
} else {
return closestIdx
}
}
return closestIdx
}
let UID = 0;
// List of collapsible layer editors // List of collapsible layer editors
class LayerListContainerInternal extends React.Component<LayerListContainerInternalProps, LayerListContainerState> { class LayerListContainer extends React.Component {
static propTypes = {...layerListPropTypes}
static defaultProps = { static defaultProps = {
onLayerSelect: () => {}, onLayerSelect: () => {},
} }
selectedItemRef: React.RefObject<any>;
scrollContainerRef: React.RefObject<HTMLElement>;
constructor(props: LayerListContainerInternalProps) { constructor(props) {
super(props); super(props);
this.selectedItemRef = React.createRef(); this.selectedItemRef = React.createRef();
this.scrollContainerRef = React.createRef(); this.scrollContainerRef = React.createRef();
@@ -48,7 +52,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
collapsedGroups: {}, collapsedGroups: {},
areAllGroupsExpanded: false, areAllGroupsExpanded: false,
keys: { keys: {
add: +generateUniqueId(), add: UID++,
}, },
isOpen: { isOpen: {
add: false, add: false,
@@ -56,11 +60,11 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
} }
} }
toggleModal(modalName: string) { toggleModal(modalName) {
this.setState({ this.setState({
keys: { keys: {
...this.state.keys, ...this.state.keys,
[modalName]: +generateUniqueId(), [modalName]: UID++,
}, },
isOpen: { isOpen: {
...this.state.isOpen, ...this.state.isOpen,
@@ -70,9 +74,9 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
} }
toggleLayers = () => { toggleLayers = () => {
let idx = 0 let idx=0
const newGroups: {[key:string]: boolean} = {} let newGroups=[]
this.groupedLayers().forEach(layers => { this.groupedLayers().forEach(layers => {
const groupPrefix = layerPrefix(layers[0].id) const groupPrefix = layerPrefix(layers[0].id)
@@ -83,7 +87,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
newGroups[lookupKey] = this.state.areAllGroupsExpanded newGroups[lookupKey] = this.state.areAllGroupsExpanded
} }
layers.forEach((_layer) => { layers.forEach((layer) => {
idx += 1 idx += 1
}) })
}); });
@@ -94,7 +98,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
}) })
} }
groupedLayers(): (LayerSpecification & {key: string})[][] { groupedLayers() {
const groups = [] const groups = []
const layerIdCount = new Map(); const layerIdCount = new Map();
@@ -118,7 +122,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
return groups return groups
} }
toggleLayerGroup(groupPrefix: string, idx: number) { toggleLayerGroup(groupPrefix, idx) {
const lookupKey = [groupPrefix, idx].join('-') const lookupKey = [groupPrefix, idx].join('-')
const newGroups = { ...this.state.collapsedGroups } const newGroups = { ...this.state.collapsedGroups }
if(lookupKey in this.state.collapsedGroups) { if(lookupKey in this.state.collapsedGroups) {
@@ -131,12 +135,12 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
}) })
} }
isCollapsed(groupPrefix: string, idx: number) { isCollapsed(groupPrefix, idx) {
const collapsed = this.state.collapsedGroups[[groupPrefix, idx].join('-')] const collapsed = this.state.collapsedGroups[[groupPrefix, idx].join('-')]
return collapsed === undefined ? true : collapsed return collapsed === undefined ? true : collapsed
} }
shouldComponentUpdate (nextProps: LayerListContainerProps, nextState: LayerListContainerState) { shouldComponentUpdate (nextProps, nextState) {
// Always update on state change // Always update on state change
if (this.state !== nextState) { if (this.state !== nextState) {
return true; return true;
@@ -144,8 +148,8 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
// This component tree only requires id and visibility from the layers // This component tree only requires id and visibility from the layers
// objects // objects
function getRequiredProps(layer: LayerSpecification) { function getRequiredProps (layer) {
const out: {id: string, layout?: { visibility: any}} = { const out = {
id: layer.id, id: layer.id,
}; };
@@ -161,10 +165,10 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
this.props.layers.map(getRequiredProps), this.props.layers.map(getRequiredProps),
); );
function withoutLayers(props: LayerListContainerProps) { function withoutLayers (props) {
const out = { const out = {
...props ...props
} as LayerListContainerProps & { layers?: any }; };
delete out['layers']; delete out['layers'];
return out; return out;
} }
@@ -180,7 +184,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
return propsChanged; return propsChanged;
} }
componentDidUpdate (prevProps: LayerListContainerProps) { componentDidUpdate (prevProps) {
if (prevProps.selectedLayerIndex !== this.props.selectedLayerIndex) { if (prevProps.selectedLayerIndex !== this.props.selectedLayerIndex) {
const selectedItemNode = this.selectedItemRef.current; const selectedItemNode = this.selectedItemRef.current;
if (selectedItemNode && selectedItemNode.node) { if (selectedItemNode && selectedItemNode.node) {
@@ -203,7 +207,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
render() { render() {
const listItems: JSX.Element[] = [] const listItems = []
let idx = 0 let idx = 0
const layersByGroup = this.groupedLayers(); const layersByGroup = this.groupedLayers();
layersByGroup.forEach(layers => { layersByGroup.forEach(layers => {
@@ -231,7 +235,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
); );
}); });
const additionalProps: {ref?: React.RefObject<any>} = {}; const additionalProps = {};
if (idx === this.props.selectedLayerIndex) { if (idx === this.props.selectedLayerIndex) {
additionalProps.ref = this.selectedItemRef; additionalProps.ref = this.selectedItemRef;
} }
@@ -251,7 +255,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
visibility={(layer.layout || {}).visibility} visibility={(layer.layout || {}).visibility}
isSelected={idx === this.props.selectedLayerIndex} isSelected={idx === this.props.selectedLayerIndex}
onLayerSelect={this.props.onLayerSelect} onLayerSelect={this.props.onLayerSelect}
onLayerDestroy={this.props.onLayerDestroy?.bind(this)} onLayerDestroy={this.props.onLayerDestroy.bind(this)}
onLayerCopy={this.props.onLayerCopy.bind(this)} onLayerCopy={this.props.onLayerCopy.bind(this)}
onLayerVisibilityToggle={this.props.onLayerVisibilityToggle.bind(this)} onLayerVisibilityToggle={this.props.onLayerVisibilityToggle.bind(this)}
{...additionalProps} {...additionalProps}
@@ -261,24 +265,22 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
}) })
}) })
const t = this.props.t;
return <section return <section
className="maputnik-layer-list" className="maputnik-layer-list"
role="complementary" role="complementary"
aria-label={t("Layers list")} aria-label="Layers list"
ref={this.scrollContainerRef} ref={this.scrollContainerRef}
> >
<ModalAdd <ModalAdd
key={this.state.keys.add} key={this.state.keys.add}
layers={this.props.layers} layers={this.props.layers}
sources={this.props.sources} sources={this.props.sources}
isOpen={this.state.isOpen.add} isOpen={this.state.isOpen.add}
onOpenToggle={this.toggleModal.bind(this, 'add')} onOpenToggle={this.toggleModal.bind(this, 'add')}
onLayersChange={this.props.onLayersChange} onLayersChange={this.props.onLayersChange}
/> />
<header className="maputnik-layer-list-header"> <header className="maputnik-layer-list-header">
<span className="maputnik-layer-list-header-title">{t("Layers")}</span> <span className="maputnik-layer-list-header-title">Layers</span>
<span className="maputnik-space" /> <span className="maputnik-space" />
<div className="maputnik-default-property"> <div className="maputnik-default-property">
<div className="maputnik-multibutton"> <div className="maputnik-multibutton">
@@ -287,11 +289,7 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
data-wd-key="skip-target-layer-list" data-wd-key="skip-target-layer-list"
onClick={this.toggleLayers} onClick={this.toggleLayers}
className="maputnik-button"> className="maputnik-button">
{this.state.areAllGroupsExpanded === true ? {this.state.areAllGroupsExpanded === true ? "Collapse" : "Expand"}
t("Collapse")
:
t("Expand")
}
</button> </button>
</div> </div>
</div> </div>
@@ -301,14 +299,14 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
onClick={this.toggleModal.bind(this, 'add')} onClick={this.toggleModal.bind(this, 'add')}
data-wd-key="layer-list:add-layer" data-wd-key="layer-list:add-layer"
className="maputnik-button maputnik-button-selected"> className="maputnik-button maputnik-button-selected">
{t("Add Layer")} Add Layer
</button> </button>
</div> </div>
</div> </div>
</header> </header>
<div <div
role="navigation" role="navigation"
aria-label={t("Layers list")} aria-label="Layers list"
> >
<ul className="maputnik-layer-list-container"> <ul className="maputnik-layer-list-container">
{listItems} {listItems}
@@ -318,21 +316,11 @@ class LayerListContainerInternal extends React.Component<LayerListContainerInter
} }
} }
// The next two lines have react-refresh/only-export-components disabled because they are const LayerListContainerSortable = SortableContainer((props) => <LayerListContainer {...props} />)
// internal components that are not intended to be used outside of this file.
// For some reason, the linter is not recognizing these components correctly.
// When these components are migrated to functional components, the HOCs will no longer be needed
// and the comments can be removed.
// eslint-disable-next-line react-refresh/only-export-components
const LayerListContainer = withTranslation()(LayerListContainerInternal);
// eslint-disable-next-line react-refresh/only-export-components
const LayerListContainerSortable = SortableContainer((props: LayerListContainerProps) => <LayerListContainer {...props} />)
type LayerListProps = LayerListContainerProps & { export default class LayerList extends React.Component {
onMoveLayer: SortEndHandler static propTypes = {...layerListPropTypes}
};
export default class LayerList extends React.Component<LayerListProps> {
render() { render() {
return <LayerListContainerSortable return <LayerListContainerSortable
{...this.props} {...this.props}
@@ -8,12 +8,7 @@ import IconLayer from './IconLayer'
import {SortableElement, SortableHandle} from 'react-sortable-hoc' import {SortableElement, SortableHandle} from 'react-sortable-hoc'
type DraggableLabelProps = { const DraggableLabel = SortableHandle((props) => {
layerId: string
layerType: string
};
const DraggableLabel = SortableHandle((props: DraggableLabelProps) => {
return <div className="maputnik-layer-list-item-handle"> return <div className="maputnik-layer-list-item-handle">
<IconLayer <IconLayer
className="layer-handle__icon" className="layer-handle__icon"
@@ -25,21 +20,21 @@ const DraggableLabel = SortableHandle((props: DraggableLabelProps) => {
</div> </div>
}); });
type IconActionProps = { class IconAction extends React.Component {
action: string static propTypes = {
onClick(...args: unknown[]): unknown action: PropTypes.string.isRequired,
wdKey?: string onClick: PropTypes.func.isRequired,
classBlockName?: string wdKey: PropTypes.string,
classBlockModifier?: string classBlockName: PropTypes.string,
}; classBlockModifier: PropTypes.string,
}
class IconAction extends React.Component<IconActionProps> {
renderIcon() { renderIcon() {
switch(this.props.action) { switch(this.props.action) {
case 'duplicate': return <MdContentCopy /> case 'duplicate': return <MdContentCopy />
case 'show': return <MdVisibility /> case 'show': return <MdVisibility />
case 'hide': return <MdVisibilityOff /> case 'hide': return <MdVisibilityOff />
case 'delete': return <MdDelete /> case 'delete': return <MdDelete />
} }
} }
@@ -56,7 +51,7 @@ class IconAction extends React.Component<IconActionProps> {
} }
return <button return <button
tabIndex={-1} tabIndex="-1"
title={this.props.action} title={this.props.action}
className={`maputnik-layer-list-icon-action ${classAdditions}`} className={`maputnik-layer-list-icon-action ${classAdditions}`}
data-wd-key={this.props.wdKey} data-wd-key={this.props.wdKey}
@@ -68,21 +63,21 @@ class IconAction extends React.Component<IconActionProps> {
} }
} }
type LayerListItemProps = { class LayerListItem extends React.Component {
id?: string static propTypes = {
layerIndex: number layerIndex: PropTypes.number.isRequired,
layerId: string layerId: PropTypes.string.isRequired,
layerType: string layerType: PropTypes.string.isRequired,
isSelected?: boolean isSelected: PropTypes.bool,
visibility?: string visibility: PropTypes.string,
className?: string className: PropTypes.string,
onLayerSelect(...args: unknown[]): unknown
onLayerCopy?(...args: unknown[]): unknown onLayerSelect: PropTypes.func.isRequired,
onLayerDestroy?(...args: unknown[]): unknown onLayerCopy: PropTypes.func,
onLayerVisibilityToggle?(...args: unknown[]): unknown onLayerDestroy: PropTypes.func,
}; onLayerVisibilityToggle: PropTypes.func,
}
class LayerListItem extends React.Component<LayerListItemProps> {
static defaultProps = { static defaultProps = {
isSelected: false, isSelected: false,
visibility: 'visible', visibility: 'visible',
@@ -107,38 +102,38 @@ class LayerListItem extends React.Component<LayerListItemProps> {
return <li return <li
id={this.props.id} id={this.props.id}
key={this.props.layerId} key={this.props.layerId}
onClick={_e => this.props.onLayerSelect(this.props.layerIndex)} onClick={e => this.props.onLayerSelect(this.props.layerIndex)}
data-wd-key={"layer-list-item:"+this.props.layerId} data-wd-key={"layer-list-item:"+this.props.layerId}
className={classnames({ className={classnames({
"maputnik-layer-list-item": true, "maputnik-layer-list-item": true,
"maputnik-layer-list-item-selected": this.props.isSelected, "maputnik-layer-list-item-selected": this.props.isSelected,
[this.props.className!]: true, [this.props.className]: true,
})}> })}>
<DraggableLabel {...this.props} /> <DraggableLabel {...this.props} />
<span style={{flexGrow: 1}} /> <span style={{flexGrow: 1}} />
<IconAction <IconAction
wdKey={"layer-list-item:"+this.props.layerId+":delete"} wdKey={"layer-list-item:"+this.props.layerId+":delete"}
action={'delete'} action={'delete'}
classBlockName="delete" classBlockName="delete"
onClick={_e => this.props.onLayerDestroy!(this.props.layerIndex)} onClick={e => this.props.onLayerDestroy(this.props.layerIndex)}
/> />
<IconAction <IconAction
wdKey={"layer-list-item:"+this.props.layerId+":copy"} wdKey={"layer-list-item:"+this.props.layerId+":copy"}
action={'duplicate'} action={'duplicate'}
classBlockName="duplicate" classBlockName="duplicate"
onClick={_e => this.props.onLayerCopy!(this.props.layerIndex)} onClick={e => this.props.onLayerCopy(this.props.layerIndex)}
/> />
<IconAction <IconAction
wdKey={"layer-list-item:"+this.props.layerId+":toggle-visibility"} wdKey={"layer-list-item:"+this.props.layerId+":toggle-visibility"}
action={visibilityAction} action={visibilityAction}
classBlockName="visibility" classBlockName="visibility"
classBlockModifier={visibilityAction} classBlockModifier={visibilityAction}
onClick={_e => this.props.onLayerVisibilityToggle!(this.props.layerIndex)} onClick={e => this.props.onLayerVisibilityToggle(this.props.layerIndex)}
/> />
</li> </li>
} }
} }
const LayerListItemSortable = SortableElement<LayerListItemProps>((props: LayerListItemProps) => <LayerListItem {...props} />); const LayerListItemSortable = SortableElement((props) => <LayerListItem {...props} />);
export default LayerListItemSortable; export default LayerListItemSortable;
+247
View File
@@ -0,0 +1,247 @@
import React from 'react'
import PropTypes from 'prop-types'
import ReactDOM from 'react-dom'
import MapLibreGl from 'maplibre-gl'
import MapboxInspect from 'mapbox-gl-inspect'
import MapMaplibreGlLayerPopup from './MapMaplibreGlLayerPopup'
import MapMaplibreGlFeaturePropertyPopup from './MapMaplibreGlFeaturePropertyPopup'
import tokens from '../config/tokens.json'
import colors from 'mapbox-gl-inspect/lib/colors'
import Color from 'color'
import ZoomControl from '../libs/zoomcontrol'
import { colorHighlightedLayer } from '../libs/highlight'
import 'maplibre-gl/dist/maplibre-gl.css'
import '../maplibregl.css'
import '../libs/maplibre-rtl'
const IS_SUPPORTED = MapLibreGl.supported();
function renderPopup(popup, mountNode) {
ReactDOM.render(popup, mountNode);
return mountNode;
}
function buildInspectStyle(originalMapStyle, coloredLayers, highlightedLayer) {
const backgroundLayer = {
"id": "background",
"type": "background",
"paint": {
"background-color": '#1c1f24',
}
}
const layer = colorHighlightedLayer(highlightedLayer)
if(layer) {
coloredLayers.push(layer)
}
const sources = {}
Object.keys(originalMapStyle.sources).forEach(sourceId => {
const source = originalMapStyle.sources[sourceId]
if(source.type !== 'raster' && source.type !== 'raster-dem') {
sources[sourceId] = source
}
})
const inspectStyle = {
...originalMapStyle,
sources: sources,
layers: [backgroundLayer].concat(coloredLayers)
}
return inspectStyle
}
export default class MapMaplibreGl extends React.Component {
static propTypes = {
onDataChange: PropTypes.func,
onLayerSelect: PropTypes.func.isRequired,
mapStyle: PropTypes.object.isRequired,
inspectModeEnabled: PropTypes.bool.isRequired,
highlightedLayer: PropTypes.object,
options: PropTypes.object,
replaceAccessTokens: PropTypes.func.isRequired,
onChange: PropTypes.func.isRequired,
}
static defaultProps = {
onMapLoaded: () => {},
onDataChange: () => {},
onLayerSelect: () => {},
onChange: () => {},
options: {},
}
constructor(props) {
super(props)
this.state = {
map: null,
inspect: null,
}
}
updateMapFromProps(props) {
if(!IS_SUPPORTED) return;
if(!this.state.map) return
//Maplibre GL now does diffing natively so we don't need to calculate
//the necessary operations ourselves!
this.state.map.setStyle(
this.props.replaceAccessTokens(props.mapStyle),
{diff: true}
)
}
shouldComponentUpdate(nextProps, nextState) {
let should = false;
try {
should = JSON.stringify(this.props) !== JSON.stringify(nextProps) || JSON.stringify(this.state) !== JSON.stringify(nextState);
} catch(e) {
// no biggie, carry on
}
return should;
}
componentDidUpdate(prevProps, prevState, snapshot) {
if(!IS_SUPPORTED) return;
const map = this.state.map;
this.updateMapFromProps(this.props);
if(this.state.inspect && this.props.inspectModeEnabled !== this.state.inspect._showInspectMap) {
// HACK: Fix for <https://github.com/maputnik/editor/issues/576>, while we wait for a proper fix.
// eslint-disable-next-line
this.state.inspect._popupBlocked = false;
this.state.inspect.toggleInspector()
}
if (map) {
if (this.props.inspectModeEnabled) {
// HACK: We need to work out why we need to do this and what's causing
// this error. I'm assuming an issue with maplibre-gl update and
// mapbox-gl-inspect.
try {
this.state.inspect.render();
} catch(err) {
console.error("FIXME: Caught error", err);
}
}
map.showTileBoundaries = this.props.options.showTileBoundaries;
map.showCollisionBoxes = this.props.options.showCollisionBoxes;
map.showOverdrawInspector = this.props.options.showOverdrawInspector;
}
}
componentDidMount() {
if(!IS_SUPPORTED) return;
const mapOpts = {
...this.props.options,
container: this.container,
style: this.props.mapStyle,
hash: true,
maxZoom: 24
}
const map = new MapLibreGl.Map(mapOpts);
const mapViewChange = () => {
const center = map.getCenter();
const zoom = map.getZoom();
this.props.onChange({center, zoom});
}
mapViewChange();
map.showTileBoundaries = mapOpts.showTileBoundaries;
map.showCollisionBoxes = mapOpts.showCollisionBoxes;
map.showOverdrawInspector = mapOpts.showOverdrawInspector;
const zoomControl = new ZoomControl;
map.addControl(zoomControl, 'top-right');
const nav = new MapLibreGl.NavigationControl({visualizePitch:true});
map.addControl(nav, 'top-right');
const tmpNode = document.createElement('div');
const inspect = new MapboxInspect({
popup: new MapLibreGl.Popup({
closeOnClick: false
}),
showMapPopup: true,
showMapPopupOnHover: false,
showInspectMapPopupOnHover: true,
showInspectButton: false,
blockHoverPopupOnClick: true,
assignLayerColor: (layerId, alpha) => {
return Color(colors.brightColor(layerId, alpha)).desaturate(0.5).string()
},
buildInspectStyle: (originalMapStyle, coloredLayers) => buildInspectStyle(originalMapStyle, coloredLayers, this.props.highlightedLayer),
renderPopup: features => {
if(this.props.inspectModeEnabled) {
return renderPopup(<MapMaplibreGlFeaturePropertyPopup features={features} />, tmpNode);
} else {
return renderPopup(<MapMaplibreGlLayerPopup features={features} onLayerSelect={this.onLayerSelectById} zoom={this.state.zoom} />, tmpNode);
}
}
})
map.addControl(inspect)
map.on("style.load", () => {
this.setState({
map,
inspect,
zoom: map.getZoom()
});
})
map.on("data", e => {
if(e.dataType !== 'tile') return
this.props.onDataChange({
map: this.state.map
})
})
map.on("error", e => {
console.log("ERROR", e);
})
map.on("zoom", e => {
this.setState({
zoom: map.getZoom()
});
});
map.on("dragend", mapViewChange);
map.on("zoomend", mapViewChange);
}
onLayerSelectById = (id) => {
const index = this.props.mapStyle.layers.findIndex(layer => layer.id === id);
this.props.onLayerSelect(index);
}
render() {
if(IS_SUPPORTED) {
return <div
className="maputnik-map__map"
role="region"
aria-label="Map view"
ref={x => this.container = x}
data-wd-key="maplibre:map"
></div>
}
else {
return <div
className="maputnik-map maputnik-map--error"
>
<div className="maputnik-map__error-message">
Error: Cannot load MaplibreGL, WebGL is either unsupported or disabled
</div>
</div>
}
}
}
-279
View File
@@ -1,279 +0,0 @@
import React, {type JSX} from 'react'
import ReactDOM from 'react-dom'
import MapLibreGl, {LayerSpecification, LngLat, Map, MapOptions, SourceSpecification, StyleSpecification} from 'maplibre-gl'
import MaplibreInspect from '@maplibre/maplibre-gl-inspect'
import colors from '@maplibre/maplibre-gl-inspect/lib/colors'
import MapMaplibreGlLayerPopup from './MapMaplibreGlLayerPopup'
import MapMaplibreGlFeaturePropertyPopup, { InspectFeature } from './MapMaplibreGlFeaturePropertyPopup'
import Color from 'color'
import ZoomControl from '../libs/zoomcontrol'
import { HighlightedLayer, colorHighlightedLayer } from '../libs/highlight'
import 'maplibre-gl/dist/maplibre-gl.css'
import '../maplibregl.css'
import '../libs/maplibre-rtl'
import MaplibreGeocoder, { MaplibreGeocoderApi, MaplibreGeocoderApiConfig } from '@maplibre/maplibre-gl-geocoder';
import '@maplibre/maplibre-gl-geocoder/dist/maplibre-gl-geocoder.css';
import { withTranslation, WithTranslation } from 'react-i18next'
function renderPopup(popup: JSX.Element, mountNode: ReactDOM.Container): HTMLElement {
ReactDOM.render(popup, mountNode);
return mountNode as HTMLElement;
}
function buildInspectStyle(originalMapStyle: StyleSpecification, coloredLayers: HighlightedLayer[], highlightedLayer?: HighlightedLayer) {
const backgroundLayer = {
"id": "background",
"type": "background",
"paint": {
"background-color": '#1c1f24',
}
} as LayerSpecification
const layer = colorHighlightedLayer(highlightedLayer)
if(layer) {
coloredLayers.push(layer)
}
const sources: {[key:string]: SourceSpecification} = {}
Object.keys(originalMapStyle.sources).forEach(sourceId => {
const source = originalMapStyle.sources[sourceId]
if(source.type !== 'raster' && source.type !== 'raster-dem') {
sources[sourceId] = source
}
})
const inspectStyle = {
...originalMapStyle,
sources: sources,
layers: [backgroundLayer].concat(coloredLayers as LayerSpecification[])
}
return inspectStyle
}
type MapMaplibreGlInternalProps = {
onDataChange?(event: {map: Map | null}): unknown
onLayerSelect(...args: unknown[]): unknown
mapStyle: StyleSpecification
inspectModeEnabled: boolean
highlightedLayer?: HighlightedLayer
options?: Partial<MapOptions> & {
showTileBoundaries?: boolean
showCollisionBoxes?: boolean
showOverdrawInspector?: boolean
}
replaceAccessTokens(mapStyle: StyleSpecification): StyleSpecification
onChange(value: {center: LngLat, zoom: number}): unknown
} & WithTranslation;
type MapMaplibreGlState = {
map: Map | null
inspect: MaplibreInspect | null
zoom?: number
};
class MapMaplibreGlInternal extends React.Component<MapMaplibreGlInternalProps, MapMaplibreGlState> {
static defaultProps = {
onMapLoaded: () => {},
onDataChange: () => {},
onLayerSelect: () => {},
onChange: () => {},
options: {} as MapOptions,
}
container: HTMLDivElement | null = null
constructor(props: MapMaplibreGlInternalProps) {
super(props)
this.state = {
map: null,
inspect: null,
}
}
shouldComponentUpdate(nextProps: MapMaplibreGlInternalProps, nextState: MapMaplibreGlState) {
let should = false;
try {
should = JSON.stringify(this.props) !== JSON.stringify(nextProps) || JSON.stringify(this.state) !== JSON.stringify(nextState);
} catch(e) {
// no biggie, carry on
}
return should;
}
componentDidUpdate() {
const map = this.state.map;
const styleWithTokens = this.props.replaceAccessTokens(this.props.mapStyle);
if (map) {
// Maplibre GL now does diffing natively so we don't need to calculate
// the necessary operations ourselves!
// We also need to update the style for inspect to work properly
map.setStyle(styleWithTokens, {diff: true});
map.showTileBoundaries = this.props.options?.showTileBoundaries!;
map.showCollisionBoxes = this.props.options?.showCollisionBoxes!;
map.showOverdrawInspector = this.props.options?.showOverdrawInspector!;
}
if(this.state.inspect && this.props.inspectModeEnabled !== this.state.inspect._showInspectMap) {
this.state.inspect.toggleInspector()
}
if (this.state.inspect && this.props.inspectModeEnabled) {
this.state.inspect.setOriginalStyle(styleWithTokens);
// In case the sources are the same, there's a need to refresh the style
setTimeout(() => {
this.state.inspect!.render();
}, 500);
}
}
componentDidMount() {
const mapOpts = {
...this.props.options,
container: this.container!,
style: this.props.mapStyle,
hash: true,
maxZoom: 24,
// setting to always load glyphs of CJK fonts from server
// https://maplibre.org/maplibre-gl-js/docs/examples/local-ideographs/
localIdeographFontFamily: false
} satisfies MapOptions;
const map = new MapLibreGl.Map(mapOpts);
const mapViewChange = () => {
const center = map.getCenter();
const zoom = map.getZoom();
this.props.onChange({center, zoom});
}
mapViewChange();
map.showTileBoundaries = mapOpts.showTileBoundaries!;
map.showCollisionBoxes = mapOpts.showCollisionBoxes!;
map.showOverdrawInspector = mapOpts.showOverdrawInspector!;
this.initGeocoder(map);
const zoomControl = new ZoomControl(this.props.t("Zoom:"));
map.addControl(zoomControl, 'top-right');
const nav = new MapLibreGl.NavigationControl({visualizePitch:true});
map.addControl(nav, 'top-right');
const tmpNode = document.createElement('div');
const inspect = new MaplibreInspect({
popup: new MapLibreGl.Popup({
closeOnClick: false
}),
showMapPopup: true,
showMapPopupOnHover: false,
showInspectMapPopupOnHover: true,
showInspectButton: false,
blockHoverPopupOnClick: true,
assignLayerColor: (layerId: string, alpha: number) => {
return Color(colors.brightColor(layerId, alpha)).desaturate(0.5).string()
},
buildInspectStyle: (originalMapStyle: StyleSpecification, coloredLayers: HighlightedLayer[]) => buildInspectStyle(originalMapStyle, coloredLayers, this.props.highlightedLayer),
renderPopup: (features: InspectFeature[]) => {
if(this.props.inspectModeEnabled) {
return renderPopup(<MapMaplibreGlFeaturePropertyPopup features={features} />, tmpNode);
} else {
return renderPopup(<MapMaplibreGlLayerPopup features={features} onLayerSelect={this.onLayerSelectById} zoom={this.state.zoom} />, tmpNode);
}
}
})
map.addControl(inspect)
map.on("style.load", () => {
this.setState({
map,
inspect,
zoom: map.getZoom()
});
})
map.on("data", e => {
if(e.dataType !== 'tile') return
this.props.onDataChange!({
map: this.state.map
})
})
map.on("error", e => {
console.log("ERROR", e);
})
map.on("zoom", _e => {
this.setState({
zoom: map.getZoom()
});
});
map.on("dragend", mapViewChange);
map.on("zoomend", mapViewChange);
}
onLayerSelectById = (id: string) => {
const index = this.props.mapStyle.layers.findIndex(layer => layer.id === id);
this.props.onLayerSelect(index);
}
initGeocoder(map: Map) {
const geocoderConfig = {
forwardGeocode: async (config: MaplibreGeocoderApiConfig) => {
const features = [];
try {
const request = `https://nominatim.openstreetmap.org/search?q=${config.query}&format=geojson&polygon_geojson=1&addressdetails=1`;
const response = await fetch(request);
const geojson = await response.json();
for (const feature of geojson.features) {
const center = [
feature.bbox[0] +
(feature.bbox[2] - feature.bbox[0]) / 2,
feature.bbox[1] +
(feature.bbox[3] - feature.bbox[1]) / 2
];
const point = {
type: 'Feature',
geometry: {
type: 'Point',
coordinates: center
},
place_name: feature.properties.display_name,
properties: feature.properties,
text: feature.properties.display_name,
place_type: ['place'],
center
};
features.push(point);
}
} catch (e) {
console.error(`Failed to forwardGeocode with error: ${e}`);
}
return {
features
};
},
} as unknown as MaplibreGeocoderApi;
const geocoder = new MaplibreGeocoder(geocoderConfig, {
placeholder: this.props.t("Search"),
maplibregl: MapLibreGl,
});
map.addControl(geocoder, 'top-left');
}
render() {
const t = this.props.t;
return <div
className="maputnik-map__map"
role="region"
aria-label={t("Map view")}
ref={x => this.container = x}
data-wd-key="maplibre:map"
></div>
}
}
const MapMaplibreGl = withTranslation()(MapMaplibreGlInternal);
export default MapMaplibreGl;
@@ -0,0 +1,78 @@
import React from 'react'
import PropTypes from 'prop-types'
import Block from './Block'
import FieldString from './FieldString'
function displayValue(value) {
if (typeof value === 'undefined' || value === null) return value;
if (value instanceof Date) return value.toLocaleString();
if (typeof value === 'object' ||
typeof value === 'number' ||
typeof value === 'string') return value.toString();
return value;
}
function renderProperties(feature) {
return Object.keys(feature.properties).map(propertyName => {
const property = feature.properties[propertyName]
return <Block key={propertyName} label={propertyName}>
<FieldString value={displayValue(property)} style={{backgroundColor: 'transparent'}}/>
</Block>
})
}
function renderFeatureId(feature) {
return <Block key={"feature-id"} label={"feature_id"}>
<FieldString value={displayValue(feature.id)} style={{backgroundColor: 'transparent'}} />
</Block>
}
function renderFeature(feature, idx) {
return <div key={`${feature.sourceLayer}-${idx}`}>
<div className="maputnik-popup-layer-id">{feature.layer['source']}: {feature.layer['source-layer']}{feature.inspectModeCounter && <span> × {feature.inspectModeCounter}</span>}</div>
<Block key={"property-type"} label={"$type"}>
<FieldString value={feature.geometry.type} style={{backgroundColor: 'transparent'}} />
</Block>
{renderFeatureId(feature)}
{renderProperties(feature)}
</div>
}
function removeDuplicatedFeatures(features) {
let uniqueFeatures = [];
features.forEach(feature => {
const featureIndex = uniqueFeatures.findIndex(feature2 => {
return feature.layer['source-layer'] === feature2.layer['source-layer']
&& JSON.stringify(feature.properties) === JSON.stringify(feature2.properties)
})
if(featureIndex === -1) {
uniqueFeatures.push(feature)
} else {
if(uniqueFeatures[featureIndex].hasOwnProperty('inspectModeCounter')) {
uniqueFeatures[featureIndex].inspectModeCounter++
} else {
uniqueFeatures[featureIndex].inspectModeCounter = 2
}
}
})
return uniqueFeatures
}
class FeaturePropertyPopup extends React.Component {
static propTypes = {
features: PropTypes.array
}
render() {
const features = removeDuplicatedFeatures(this.props.features)
return <div className="maputnik-feature-property-popup">
{features.map(renderFeature)}
</div>
}
}
export default FeaturePropertyPopup
@@ -1,80 +0,0 @@
import React from 'react'
import type { GeoJSONFeatureWithSourceLayer } from '@maplibre/maplibre-gl-inspect'
export type InspectFeature = GeoJSONFeatureWithSourceLayer & {
inspectModeCounter?: number
counter?: number
}
function displayValue(value: string | number | Date | object | undefined) {
if (typeof value === 'undefined' || value === null) return value;
if (value instanceof Date) return value.toLocaleString();
if (typeof value === 'object' ||
typeof value === 'number' ||
typeof value === 'string') return value.toString();
return value;
}
function renderKeyValueTableRow(key: string, value: string | undefined) {
return <tr key={key}>
<td className="maputnik-popup-table-cell">{key}</td>
<td className="maputnik-popup-table-cell">{value}</td>
</tr>
}
function renderFeature(feature: InspectFeature, idx: number) {
return <React.Fragment key={idx}>
<tr>
<td colSpan={2} className="maputnik-popup-layer-id">{feature.layer['source']}: {feature.layer['source-layer']}{feature.inspectModeCounter && <span> × {feature.inspectModeCounter}</span>}</td>
</tr>
{renderKeyValueTableRow("$type", feature.geometry.type)}
{renderKeyValueTableRow("$id", displayValue(feature.id))}
{Object.keys(feature.properties).map(propertyName => {
const property = feature.properties[propertyName];
return renderKeyValueTableRow(propertyName, displayValue(property))
})}
</React.Fragment>
}
function removeDuplicatedFeatures(features: InspectFeature[]) {
const uniqueFeatures: InspectFeature[] = [];
features.forEach(feature => {
const featureIndex = uniqueFeatures.findIndex(feature2 => {
return feature.layer['source-layer'] === feature2.layer['source-layer']
&& JSON.stringify(feature.properties) === JSON.stringify(feature2.properties)
})
if(featureIndex === -1) {
uniqueFeatures.push(feature)
} else {
if('inspectModeCounter' in uniqueFeatures[featureIndex]) {
uniqueFeatures[featureIndex].inspectModeCounter!++
} else {
uniqueFeatures[featureIndex].inspectModeCounter = 2
}
}
})
return uniqueFeatures
}
type FeaturePropertyPopupProps = {
features: InspectFeature[]
};
class FeaturePropertyPopup extends React.Component<FeaturePropertyPopupProps> {
render() {
const features = removeDuplicatedFeatures(this.props.features)
return <div className="maputnik-feature-property-popup">
<table className="maputnik-popup-table">
<tbody>
{features.map(renderFeature)}
</tbody>
</table>
</div>
}
}
export default FeaturePropertyPopup
+32 -26
View File
@@ -1,23 +1,21 @@
import React from 'react' import React from 'react'
import IconLayer from './IconLayer' import IconLayer from './IconLayer'
import type {InspectFeature} from './MapMaplibreGlFeaturePropertyPopup';
function groupFeaturesBySourceLayer(features: InspectFeature[]) { function groupFeaturesBySourceLayer(features: any[]) {
const sources: {[key: string]: InspectFeature[]} = {} const sources = {} as any
const returnedFeatures: {[key: string]: number} = {} let returnedFeatures = {} as any;
features.forEach(feature => { features.forEach(feature => {
const sourceKey = feature.layer['source-layer'] as string; if(returnedFeatures.hasOwnProperty(feature.layer.id)) {
if(Object.prototype.hasOwnProperty.call(returnedFeatures, feature.layer.id)) {
returnedFeatures[feature.layer.id]++ returnedFeatures[feature.layer.id]++
const featureObject = sources[sourceKey].find((f: InspectFeature) => f.layer.id === feature.layer.id) const featureObject = sources[feature.layer['source-layer']].find((f: any) => f.layer.id === feature.layer.id)
featureObject!.counter = returnedFeatures[feature.layer.id] featureObject.counter = returnedFeatures[feature.layer.id]
} else { } else {
sources[sourceKey] = sources[sourceKey] || [] sources[feature.layer['source-layer']] = sources[feature.layer['source-layer']] || []
sources[sourceKey].push(feature) sources[feature.layer['source-layer']].push(feature)
returnedFeatures[feature.layer.id] = 1 returnedFeatures[feature.layer.id] = 1
} }
@@ -27,13 +25,13 @@ function groupFeaturesBySourceLayer(features: InspectFeature[]) {
} }
type FeatureLayerPopupProps = { type FeatureLayerPopupProps = {
onLayerSelect(layerId: string): unknown onLayerSelect(...args: unknown[]): unknown
features: InspectFeature[] features: any[]
zoom?: number zoom?: number
}; };
class FeatureLayerPopup extends React.Component<FeatureLayerPopupProps> { class FeatureLayerPopup extends React.Component<FeatureLayerPopupProps> {
_getFeatureColor(feature: InspectFeature, _zoom?: number) { _getFeatureColor(feature: any, _zoom?: number) {
// Guard because openlayers won't have this // Guard because openlayers won't have this
if (!feature.layer.paint) { if (!feature.layer.paint) {
return; return;
@@ -41,21 +39,29 @@ class FeatureLayerPopup extends React.Component<FeatureLayerPopupProps> {
try { try {
const paintProps = feature.layer.paint; const paintProps = feature.layer.paint;
let propName;
if("text-color" in paintProps && paintProps["text-color"]) { if(paintProps.hasOwnProperty("text-color") && paintProps["text-color"]) {
return String(paintProps["text-color"]); propName = "text-color";
} }
if ("fill-color" in paintProps && paintProps["fill-color"]) { else if (paintProps.hasOwnProperty("fill-color") && paintProps["fill-color"]) {
return String(paintProps["fill-color"]); propName = "fill-color";
} }
if ("line-color" in paintProps && paintProps["line-color"]) { else if (paintProps.hasOwnProperty("line-color") && paintProps["line-color"]) {
return String(paintProps["line-color"]); propName = "line-color";
} }
if ("fill-extrusion-color" in paintProps && paintProps["fill-extrusion-color"]) { else if (paintProps.hasOwnProperty("fill-extrusion-color") && paintProps["fill-extrusion-color"]) {
return String(paintProps["fill-extrusion-color"]); propName = "fill-extrusion-color";
}
if(propName) {
let color = feature.layer.paint[propName];
return String(color);
}
else {
// Default color
return "black";
} }
// Default color
return "black";
} }
// This is quite complex, just incase there's an edgecase we're missing // This is quite complex, just incase there's an edgecase we're missing
// always return black if we get an unexpected error. // always return black if we get an unexpected error.
@@ -69,12 +75,12 @@ class FeatureLayerPopup extends React.Component<FeatureLayerPopupProps> {
const sources = groupFeaturesBySourceLayer(this.props.features) const sources = groupFeaturesBySourceLayer(this.props.features)
const items = Object.keys(sources).map(vectorLayerId => { const items = Object.keys(sources).map(vectorLayerId => {
const layers = sources[vectorLayerId].map((feature: InspectFeature, idx: number) => { const layers = sources[vectorLayerId].map((feature: any, idx: number) => {
const featureColor = this._getFeatureColor(feature, this.props.zoom); const featureColor = this._getFeatureColor(feature, this.props.zoom);
return <div return <div
key={idx} key={idx}
className="maputnik-popup-layer" className="maputnik-popup-layer"
> >
<div <div
className="maputnik-popup-layer__swatch" className="maputnik-popup-layer__swatch"
+13 -18
View File
@@ -1,16 +1,14 @@
import React from 'react' import React from 'react'
import {throttle} from 'lodash'; import {throttle} from 'lodash';
import { WithTranslation, withTranslation } from 'react-i18next';
import MapMaplibreGlLayerPopup from './MapMaplibreGlLayerPopup'; import MapMaplibreGlLayerPopup from './MapMaplibreGlLayerPopup';
import 'ol/ol.css' import 'ol/ol.css'
//@ts-ignore
import {apply} from 'ol-mapbox-style'; import {apply} from 'ol-mapbox-style';
import {Map, View, Overlay} from 'ol'; import {Map, View, Overlay} from 'ol';
import {toLonLat} from 'ol/proj'; import {toLonLat} from 'ol/proj';
import type {StyleSpecification} from 'maplibre-gl'; import { StyleSpecification } from '@maplibre/maplibre-gl-style-spec';
function renderCoords (coords: string[]) { function renderCoords (coords: string[]) {
@@ -24,7 +22,7 @@ function renderCoords (coords: string[]) {
} }
} }
type MapOpenLayersInternalProps = { type MapOpenLayersProps = {
onDataChange?(...args: unknown[]): unknown onDataChange?(...args: unknown[]): unknown
mapStyle: object mapStyle: object
accessToken?: string accessToken?: string
@@ -33,7 +31,7 @@ type MapOpenLayersInternalProps = {
debugToolbox: boolean debugToolbox: boolean
replaceAccessTokens(...args: unknown[]): unknown replaceAccessTokens(...args: unknown[]): unknown
onChange(...args: unknown[]): unknown onChange(...args: unknown[]): unknown
} & WithTranslation; };
type MapOpenLayersState = { type MapOpenLayersState = {
zoom: string zoom: string
@@ -43,7 +41,7 @@ type MapOpenLayersState = {
selectedFeatures?: any[] selectedFeatures?: any[]
}; };
class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps, MapOpenLayersState> { export default class MapOpenLayers extends React.Component<MapOpenLayersProps, MapOpenLayersState> {
static defaultProps = { static defaultProps = {
onMapLoaded: () => {}, onMapLoaded: () => {},
onDataChange: () => {}, onDataChange: () => {},
@@ -55,7 +53,7 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
overlay: Overlay | undefined; overlay: Overlay | undefined;
popupContainer: HTMLElement | null = null; popupContainer: HTMLElement | null = null;
constructor(props: MapOpenLayersInternalProps) { constructor(props: MapOpenLayersProps) {
super(props); super(props);
this.state = { this.state = {
zoom: "0", zoom: "0",
@@ -74,7 +72,7 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
apply(this.map, newMapStyle); apply(this.map, newMapStyle);
} }
componentDidUpdate(prevProps: MapOpenLayersInternalProps) { componentDidUpdate(prevProps: MapOpenLayersProps) {
if (this.props.mapStyle !== prevProps.mapStyle) { if (this.props.mapStyle !== prevProps.mapStyle) {
this.updateStyle( this.updateStyle(
this.props.replaceAccessTokens(this.props.mapStyle) this.props.replaceAccessTokens(this.props.mapStyle)
@@ -101,7 +99,7 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
}); });
map.on('pointermove', (evt) => { map.on('pointermove', (evt) => {
const coords = toLonLat(evt.coordinate); var coords = toLonLat(evt.coordinate);
this.setState({ this.setState({
cursor: [ cursor: [
coords[0].toFixed(2), coords[0].toFixed(2),
@@ -152,7 +150,6 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
} }
render() { render() {
const t = this.props.t;
return <div className="maputnik-ol-container"> return <div className="maputnik-ol-container">
<div <div
ref={x => this.popupContainer = x} ref={x => this.popupContainer = x}
@@ -162,7 +159,7 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
<button <button
className="maplibregl-popup-close-button" className="maplibregl-popup-close-button"
onClick={this.closeOverlay} onClick={this.closeOverlay}
aria-label={t("Close popup")} aria-label="Close popup"
> >
× ×
</button> </button>
@@ -172,20 +169,20 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
/> />
</div> </div>
<div className="maputnik-ol-zoom"> <div className="maputnik-ol-zoom">
{t("Zoom:")} {this.state.zoom} Zoom: {this.state.zoom}
</div> </div>
{this.props.debugToolbox && {this.props.debugToolbox &&
<div className="maputnik-ol-debug"> <div className="maputnik-ol-debug">
<div> <div>
<label>{t("cursor:")} </label> <label>cursor: </label>
<span>{renderCoords(this.state.cursor)}</span> <span>{renderCoords(this.state.cursor)}</span>
</div> </div>
<div> <div>
<label>{t("center:")} </label> <label>center: </label>
<span>{renderCoords(this.state.center)}</span> <span>{renderCoords(this.state.center)}</span>
</div> </div>
<div> <div>
<label>{t("rotation:")} </label> <label>rotation: </label>
<span>{this.state.rotation}</span> <span>{this.state.rotation}</span>
</div> </div>
</div> </div>
@@ -194,7 +191,7 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
className="maputnik-ol" className="maputnik-ol"
ref={x => this.container = x} ref={x => this.container = x}
role="region" role="region"
aria-label={t("Map view")} aria-label="Map view"
style={{ style={{
...this.props.style, ...this.props.style,
}}> }}>
@@ -203,5 +200,3 @@ class MapOpenLayersInternal extends React.Component<MapOpenLayersInternalProps,
} }
} }
const MapOpenLayers = withTranslation()(MapOpenLayersInternal);
export default MapOpenLayers;
+8 -11
View File
@@ -1,26 +1,26 @@
import React, { PropsWithChildren } from 'react' import React from 'react'
import {MdClose} from 'react-icons/md' import {MdClose} from 'react-icons/md'
import AriaModal from 'react-aria-modal' import AriaModal from 'react-aria-modal'
import classnames from 'classnames'; import classnames from 'classnames';
import { WithTranslation, withTranslation } from 'react-i18next';
type ModalInternalProps = PropsWithChildren & {
type ModalProps = {
"data-wd-key"?: string "data-wd-key"?: string
isOpen: boolean isOpen: boolean
title: string title: string
onOpenToggle(value: boolean): unknown onOpenToggle(...args: unknown[]): unknown
underlayClickExits?: boolean underlayClickExits?: boolean
underlayProps?: any underlayProps?: any
className?: string className?: string
} & WithTranslation; };
class ModalInternal extends React.Component<ModalInternalProps> { export default class Modal extends React.Component<ModalProps> {
static defaultProps = { static defaultProps = {
underlayClickExits: true underlayClickExits: true
} }
// See <https://github.com/maplibre/maputnik/issues/416> // See <https://github.com/maputnik/editor/issues/416>
onClose = () => { onClose = () => {
if (document.activeElement) { if (document.activeElement) {
(document.activeElement as HTMLElement).blur(); (document.activeElement as HTMLElement).blur();
@@ -32,7 +32,6 @@ class ModalInternal extends React.Component<ModalInternalProps> {
} }
render() { render() {
const t = this.props.t;
if(this.props.isOpen) { if(this.props.isOpen) {
return <AriaModal return <AriaModal
titleText={this.props.title} titleText={this.props.title}
@@ -50,7 +49,7 @@ class ModalInternal extends React.Component<ModalInternalProps> {
<h1 className="maputnik-modal-header-title">{this.props.title}</h1> <h1 className="maputnik-modal-header-title">{this.props.title}</h1>
<span className="maputnik-modal-header-space"></span> <span className="maputnik-modal-header-space"></span>
<button className="maputnik-modal-header-toggle" <button className="maputnik-modal-header-toggle"
title={t("Close modal")} title="Close modal"
onClick={this.onClose} onClick={this.onClose}
data-wd-key={this.props["data-wd-key"]+".close-modal"} data-wd-key={this.props["data-wd-key"]+".close-modal"}
> >
@@ -69,5 +68,3 @@ class ModalInternal extends React.Component<ModalInternalProps> {
} }
} }
const Modal = withTranslation()(ModalInternal);
export default Modal;
+37 -42
View File
@@ -6,26 +6,24 @@ import FieldType from './FieldType'
import FieldId from './FieldId' import FieldId from './FieldId'
import FieldSource from './FieldSource' import FieldSource from './FieldSource'
import FieldSourceLayer from './FieldSourceLayer' import FieldSourceLayer from './FieldSourceLayer'
import type {LayerSpecification} from 'maplibre-gl'
import { WithTranslation, withTranslation } from 'react-i18next';
type ModalAddInternalProps = { type ModalAddProps = {
layers: LayerSpecification[] layers: unknown[]
onLayersChange(layers: LayerSpecification[]): unknown onLayersChange(...args: unknown[]): unknown
isOpen: boolean isOpen: boolean
onOpenToggle(open: boolean): unknown onOpenToggle(...args: unknown[]): unknown
// A dict of source id's and the available source layers // A dict of source id's and the available source layers
sources: any sources: any
} & WithTranslation; };
type ModalAddState = { type ModalAddState = {
type: LayerSpecification["type"] type: string
id: string id: string
source?: string source?: string
'source-layer'?: string 'source-layer'?: string
}; };
class ModalAddInternal extends React.Component<ModalAddInternalProps, ModalAddState> { export default class ModalAdd extends React.Component<ModalAddProps, ModalAddState> {
addLayer = () => { addLayer = () => {
const changedLayers = this.props.layers.slice(0) const changedLayers = this.props.layers.slice(0)
const layer: ModalAddState = { const layer: ModalAddState = {
@@ -40,13 +38,13 @@ class ModalAddInternal extends React.Component<ModalAddInternalProps, ModalAddSt
} }
} }
changedLayers.push(layer as LayerSpecification) changedLayers.push(layer)
this.props.onLayersChange(changedLayers) this.props.onLayersChange(changedLayers)
this.props.onOpenToggle(false) this.props.onOpenToggle(false)
} }
constructor(props: ModalAddInternalProps) { constructor(props: ModalAddProps) {
super(props) super(props)
const state: ModalAddState = { const state: ModalAddState = {
type: 'fill', type: 'fill',
@@ -55,12 +53,12 @@ class ModalAddInternal extends React.Component<ModalAddInternalProps, ModalAddSt
if(props.sources.length > 0) { if(props.sources.length > 0) {
state.source = Object.keys(this.props.sources)[0]; state.source = Object.keys(this.props.sources)[0];
state['source-layer'] = this.props.sources[state.source as keyof ModalAddInternalProps["sources"]][0] state['source-layer'] = this.props.sources[state.source as keyof ModalAddProps["sources"]][0]
} }
this.state = state; this.state = state;
} }
componentDidUpdate(_prevProps: ModalAddInternalProps, prevState: ModalAddState) { componentDidUpdate(_prevProps: ModalAddProps, prevState: ModalAddState) {
// Check if source is valid for new type // Check if source is valid for new type
const oldType = prevState.type; const oldType = prevState.type;
const newType = this.state.type; const newType = this.state.type;
@@ -69,7 +67,7 @@ class ModalAddInternal extends React.Component<ModalAddInternalProps, ModalAddSt
const availableSourcesNew = this.getSources(newType); const availableSourcesNew = this.getSources(newType);
if( if(
// Type has changed // Type has changed
oldType !== newType oldType !== newType
&& prevState.source !== "" && prevState.source !== ""
// Was a valid source previously // Was a valid source previously
@@ -114,7 +112,7 @@ class ModalAddInternal extends React.Component<ModalAddInternalProps, ModalAddSt
] ]
} }
for(const [key, val] of Object.entries(this.props.sources) as any) { for(let [key, val] of Object.entries(this.props.sources) as any) {
const valType = val.type as keyof typeof types; const valType = val.type as keyof typeof types;
if(types[valType] && types[valType].indexOf(type) > -1) { if(types[valType] && types[valType].indexOf(type) > -1) {
sources.push(key); sources.push(key);
@@ -126,57 +124,54 @@ class ModalAddInternal extends React.Component<ModalAddInternalProps, ModalAddSt
render() { render() {
const t = this.props.t;
const sources = this.getSources(this.state.type); const sources = this.getSources(this.state.type);
const layers = this.getLayersForSource(this.state.source!); const layers = this.getLayersForSource(this.state.source!);
return <Modal return <Modal
isOpen={this.props.isOpen} isOpen={this.props.isOpen}
onOpenToggle={this.props.onOpenToggle} onOpenToggle={this.props.onOpenToggle}
title={t('Add Layer')} title={'Add Layer'}
data-wd-key="modal:add-layer" data-wd-key="modal:add-layer"
className="maputnik-add-modal" className="maputnik-add-modal"
> >
<div className="maputnik-add-layer"> <div className="maputnik-add-layer">
<FieldId <FieldId
value={this.state.id} value={this.state.id}
wdKey="add-layer.layer-id" wdKey="add-layer.layer-id"
onChange={(v: string) => { onChange={(v: string) => {
this.setState({ id: v }) this.setState({ id: v })
}} }}
/> />
<FieldType <FieldType
value={this.state.type} value={this.state.type}
wdKey="add-layer.layer-type" wdKey="add-layer.layer-type"
onChange={(v: LayerSpecification["type"]) => this.setState({ type: v })} onChange={(v: string) => this.setState({ type: v })}
/> />
{this.state.type !== 'background' && {this.state.type !== 'background' &&
<FieldSource <FieldSource
sourceIds={sources} sourceIds={sources}
wdKey="add-layer.layer-source-block" wdKey="add-layer.layer-source-block"
value={this.state.source} value={this.state.source}
onChange={(v: string) => this.setState({ source: v })} onChange={(v: string) => this.setState({ source: v })}
/> />
} }
{['background', 'raster', 'hillshade', 'heatmap'].indexOf(this.state.type) < 0 && {['background', 'raster', 'hillshade', 'heatmap'].indexOf(this.state.type) < 0 &&
<FieldSourceLayer <FieldSourceLayer
isFixed={true} isFixed={true}
sourceLayerIds={layers} sourceLayerIds={layers}
value={this.state['source-layer']} value={this.state['source-layer']}
onChange={(v: string) => this.setState({ 'source-layer': v })} onChange={(v: string) => this.setState({ 'source-layer': v })}
/> />
} }
<InputButton <InputButton
className="maputnik-add-layer-button" className="maputnik-add-layer-button"
onClick={this.addLayer} onClick={this.addLayer}
data-wd-key="add-layer" data-wd-key="add-layer"
> >
{t("Add Layer")} Add Layer
</InputButton> </InputButton>
</div> </div>
</Modal> </Modal>
} }
} }
const ModalAdd = withTranslation()(ModalAddInternal);
export default ModalAdd;
+21 -26
View File
@@ -1,49 +1,48 @@
import React from 'react' import React from 'react'
import { Trans, WithTranslation, withTranslation } from 'react-i18next';
import Modal from './Modal' import Modal from './Modal'
type ModalDebugInternalProps = { type ModalDebugProps = {
isOpen: boolean isOpen: boolean
renderer: string renderer: string
onChangeMaplibreGlDebug(key: string, checked: boolean): unknown onChangeMaboxGlDebug(...args: unknown[]): unknown
onChangeOpenlayersDebug(key: string, checked: boolean): unknown onChangeOpenlayersDebug(...args: unknown[]): unknown
onOpenToggle(value: boolean): unknown onOpenToggle(...args: unknown[]): unknown
maplibreGlDebugOptions?: object maplibreGlDebugOptions?: object
openlayersDebugOptions?: object openlayersDebugOptions?: object
mapView: { mapView: {
zoom: number zoom: number
center: { center: {
lng: number lng: string
lat: number lat: string
} }
} }
} & WithTranslation; };
class ModalDebugInternal extends React.Component<ModalDebugInternalProps> { export default class ModalDebug extends React.Component<ModalDebugProps> {
render() { render() {
const {t, mapView} = this.props; const {mapView} = this.props;
const osmZoom = Math.round(mapView.zoom)+1; const osmZoom = Math.round(mapView.zoom)+1;
const osmLon = +(mapView.center.lng).toFixed(5); const osmLon = Number.parseFloat(mapView.center.lng).toFixed(5);
const osmLat = +(mapView.center.lat).toFixed(5); const osmLat = Number.parseFloat(mapView.center.lat).toFixed(5);
return <Modal return <Modal
data-wd-key="modal:debug" data-wd-key="modal:debug"
isOpen={this.props.isOpen} isOpen={this.props.isOpen}
onOpenToggle={this.props.onOpenToggle} onOpenToggle={this.props.onOpenToggle}
title={t('Debug')} title={'Debug'}
> >
<section className="maputnik-modal-section maputnik-modal-shortcuts"> <section className="maputnik-modal-section maputnik-modal-shortcuts">
<h1>{t("Options")}</h1> <h1>Options</h1>
{this.props.renderer === 'mlgljs' && {this.props.renderer === 'mlgljs' &&
<ul> <ul>
{Object.entries(this.props.maplibreGlDebugOptions!).map(([key, val]) => { {Object.entries(this.props.maplibreGlDebugOptions!).map(([key, val]) => {
return <li key={key}> return <li key={key}>
<label> <label>
<input type="checkbox" checked={val} onChange={(e) => this.props.onChangeMaplibreGlDebug(key, e.target.checked)} /> {key} <input type="checkbox" checked={val} onChange={(e) => this.props.onChangeMaboxGlDebug(key, e.target.checked)} /> {key}
</label> </label>
</li> </li>
})} })}
@@ -64,20 +63,16 @@ class ModalDebugInternal extends React.Component<ModalDebugInternalProps> {
<section className="maputnik-modal-section"> <section className="maputnik-modal-section">
<h1>Links</h1> <h1>Links</h1>
<p> <p>
<Trans t={t}> <a
<a target="_blank"
target="_blank" rel="noopener noreferrer"
rel="noopener noreferrer" href={`https://www.openstreetmap.org/#map=${osmZoom}/${osmLat}/${osmLon}`}
href={`https://www.openstreetmap.org/#map=${osmZoom}/${osmLat}/${osmLon}`} >
> Open in OSM
Open in OSM </a> &mdash; Opens the current view on openstreetmap.org
</a> &mdash; Opens the current view on openstreetmap.org
</Trans>
</p> </p>
</section> </section>
</Modal> </Modal>
} }
} }
const ModalDebug = withTranslation()(ModalDebugInternal);
export default ModalDebug;
+14 -20
View File
@@ -2,10 +2,8 @@ import React from 'react'
import Slugify from 'slugify' import Slugify from 'slugify'
import {saveAs} from 'file-saver' import {saveAs} from 'file-saver'
import {version} from 'maplibre-gl/package.json' import {version} from 'maplibre-gl/package.json'
import {format} from '@maplibre/maplibre-gl-style-spec' import {StyleSpecification, format} from '@maplibre/maplibre-gl-style-spec'
import type {StyleSpecification} from 'maplibre-gl'
import {MdFileDownload} from 'react-icons/md' import {MdFileDownload} from 'react-icons/md'
import { WithTranslation, withTranslation } from 'react-i18next';
import FieldString from './FieldString' import FieldString from './FieldString'
import InputButton from './InputButton' import InputButton from './InputButton'
@@ -17,15 +15,15 @@ import fieldSpecAdditional from '../libs/field-spec-additional'
const MAPLIBRE_GL_VERSION = version; const MAPLIBRE_GL_VERSION = version;
type ModalExportInternalProps = { type ModalExportProps = {
mapStyle: StyleSpecification & { id: string } mapStyle: StyleSpecification & { id: string }
onStyleChanged(...args: unknown[]): unknown onStyleChanged(...args: unknown[]): unknown
isOpen: boolean isOpen: boolean
onOpenToggle(...args: unknown[]): unknown onOpenToggle(...args: unknown[]): unknown
} & WithTranslation; };
class ModalExportInternal extends React.Component<ModalExportInternalProps> { export default class ModalExport extends React.Component<ModalExportProps> {
tokenizedStyle () { tokenizedStyle () {
return format( return format(
@@ -49,7 +47,7 @@ class ModalExportInternal extends React.Component<ModalExportInternalProps> {
downloadHtml() { downloadHtml() {
const tokenStyle = this.tokenizedStyle(); const tokenStyle = this.tokenizedStyle();
const htmlTitle = this.props.mapStyle.name || this.props.t("Map"); const htmlTitle = this.props.mapStyle.name || "Map";
const html = `<!DOCTYPE html> const html = `<!DOCTYPE html>
<html> <html>
<head> <head>
@@ -101,32 +99,30 @@ class ModalExportInternal extends React.Component<ModalExportInternalProps> {
render() { render() {
const t = this.props.t;
const fsa = fieldSpecAdditional(t);
return <Modal return <Modal
data-wd-key="modal:export" data-wd-key="modal:export"
isOpen={this.props.isOpen} isOpen={this.props.isOpen}
onOpenToggle={this.props.onOpenToggle} onOpenToggle={this.props.onOpenToggle}
title={t('Export Style')} title={'Export Style'}
className="maputnik-export-modal" className="maputnik-export-modal"
> >
<section className="maputnik-modal-section"> <section className="maputnik-modal-section">
<h1>{t("Download Style")}</h1> <h1>Download Style</h1>
<p> <p>
{t("Download a JSON style to your computer.")} Download a JSON style to your computer.
</p> </p>
<div> <div>
<FieldString <FieldString
label={fsa.maputnik.maptiler_access_token.label} label={fieldSpecAdditional.maputnik.maptiler_access_token.label}
fieldSpec={fsa.maputnik.maptiler_access_token} fieldSpec={fieldSpecAdditional.maputnik.maptiler_access_token}
value={(this.props.mapStyle.metadata || {} as any)['maputnik:openmaptiles_access_token']} value={(this.props.mapStyle.metadata || {} as any)['maputnik:openmaptiles_access_token']}
onChange={this.changeMetadataProperty.bind(this, "maputnik:openmaptiles_access_token")} onChange={this.changeMetadataProperty.bind(this, "maputnik:openmaptiles_access_token")}
/> />
<FieldString <FieldString
label={fsa.maputnik.thunderforest_access_token.label} label={fieldSpecAdditional.maputnik.thunderforest_access_token.label}
fieldSpec={fsa.maputnik.thunderforest_access_token} fieldSpec={fieldSpecAdditional.maputnik.thunderforest_access_token}
value={(this.props.mapStyle.metadata || {} as any)['maputnik:thunderforest_access_token']} value={(this.props.mapStyle.metadata || {} as any)['maputnik:thunderforest_access_token']}
onChange={this.changeMetadataProperty.bind(this, "maputnik:thunderforest_access_token")} onChange={this.changeMetadataProperty.bind(this, "maputnik:thunderforest_access_token")}
/> />
@@ -137,14 +133,14 @@ class ModalExportInternal extends React.Component<ModalExportInternalProps> {
onClick={this.downloadStyle.bind(this)} onClick={this.downloadStyle.bind(this)}
> >
<MdFileDownload /> <MdFileDownload />
{t("Download Style")} Download Style
</InputButton> </InputButton>
<InputButton <InputButton
onClick={this.downloadHtml.bind(this)} onClick={this.downloadHtml.bind(this)}
> >
<MdFileDownload /> <MdFileDownload />
{t("Download HTML")} Download HTML
</InputButton> </InputButton>
</div> </div>
</section> </section>
@@ -153,5 +149,3 @@ class ModalExportInternal extends React.Component<ModalExportInternalProps> {
} }
} }
const ModalExport = withTranslation()(ModalExportInternal);
export default ModalExport;

Some files were not shown because too many files have changed in this diff Show More