# @undp-data/style

This repository is to manage the style.json for base map of geohub

## Usage

Show the usage of all commands with the below help command

```shell
make help
```

### Maplibre style.json

Check the latest version of `@undp-data/style` package at [npmjs](https://www.npmjs.com/package/@undp-data/style?activeTab=versions), and replace the version of `0.0.1` to the latest one. Or, you may use `latest` to fetch style.json from CDN. But we strongly recommend to specify the version to prevent any breaking change error on style.json.

- Voyager style

```
https://unpkg.com/@undp-data/style@latest/dist/style.json
```

- Bing aerial style

```
https://unpkg.com/@undp-data/style@latest/dist/aerialstyle.json
```

- Dark style

```
https://unpkg.com/@undp-data/style@latest/dist/dark.json
```

- Positron style

```
https://unpkg.com/@undp-data/style@latest/dist/positron.json
```

### Sprite

- SDF

```
https://unpkg.com/@undp-data/style@latest/dist/sprite/sprite
```

Note. Don't upgrade spritezero to v6.2.1 since it has a bug when we specify --ratio=2.

- Non SDF

```
https://unpkg.com/@undp-data/style@latest/dist/sprite-non-sdf/sprite
```


## Install

```shell
pnpm i
```

### M1 Mac

If you are using M1 Mac, sprite-zero cannot be installed in normal nodejs, so please install nodejs by using NVM as following commands.

```shell
$nvm uninstall 18
$arch -x86_64 zsh
$nvm install 18
$nvm alias default 18
```

## Build all style and sprite

```shell
make build
```

## Build style.json

```shell
make style
```

## Build sprite

```shell
make sprite
```

## Develop style.json

- launch preview for OSM style

```shell
make voyager
```

- launch preview for Bing aerial style

```shell
make aerial
```

- launch preview for Dark style

```shell
make dark
```

- launch preview for Positron style

```shell
make positron
```

## Release map style

The procedure for releasing map style to NPM is as follows.

- create release note by the following command `pnpm changeset`.
- create new PR to merge to main branch.
- changeset will create new PR to release packages.
- changeset will release packages once the PR is merged to main.

## License

The license of style belong to CARTO. See [License](./LICENSE).

The license of source code is MIT license.