@unmap/themes 0.1.1 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maps & Apps Inc.
+
+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.

package/README.md

@@ -0,0 +1,59 @@
+# @unmap/themes
+
+The data model behind custom [unmap](https://unmap.dev) map themes: the `ThemeDoc` document,
+its compact `ut1.` code, the validator, and the composer the gateway uses to turn a theme into
+cartography. A theme is data only, colours, bounded numbers and one enum, so it is safe to carry
+on a public URL.
+
+Most applications never import this package. Design a theme at
+[unmap.dev/create](https://unmap.dev/create), copy the code, and pass it as `theme` to
+`@unmap/sdk`, `@unmap/maps`, or a style URL. Install this when you generate or validate theme
+codes yourself.
+
+```bash
+npm i @unmap/themes
+```
+
+```ts
+import { encodeTheme, decodeTheme, validateTheme, ThemeError } from '@unmap/themes'
+
+const code = await encodeTheme({
+  v: 1,
+  name: 'copper',
+  base: 'street',                                   // base | muted | relief | street | outdoor
+  light: { basemap: { water: '#9CCFD2' }, route: { color: '#B85C00', width: 4 } },
+  dark:  { basemap: { water: '#12303A' }, route: { color: '#FFA24D', width: 4 } },
+})
+// 'ut1.eJy…' — pass as `theme` to new Unmap({ ... }) or ?theme= on a style URL
+
+const doc = await decodeTheme(code)                 // validated ThemeDoc, or throws ThemeError
+```
+
+## What is in a theme
+
+- `base` picks the chassis: one of the five shipped styles. Each of `light` and `dark` carries
+  sparse overrides on that chassis, so a theme with no overrides renders exactly like its
+  `flavor=` twin.
+- `basemap` overrides are colours on the chassis recipe (land, water, vegetation, roads, labels,
+  points of interest, landcover). `marker` styles the geocoding pin (`color`, `scale` 0.5 to 2).
+  `route` styles the routing line (`color`, `width` 1 to 12, `opacity`, and a casing).
+- Colours are `#RRGGBB` or `#RRGGBBAA`. Unknown fields, URLs, and expressions are rejected: a
+  theme can never point a map at another host.
+
+## Exports
+
+- `encodeTheme(doc)` and `decodeTheme(code)`: async, validate on both sides, throw `ThemeError`
+  with a `detail` array naming each problem. Codes are at most 4096 characters.
+- `validateTheme(input)`: the synchronous validator, returns a typed `ThemeDoc`.
+- `resolveTheme(doc, mode)`: what the gateway calls. Returns the chassis flavor name, the
+  composed colour flavor, and the resolved `marker` and `route` styles with defaults filled in.
+- `PRESET_THEMES`: the five shipped styles as zero-override documents.
+- `generateTheme(base, seeds)` and `contrastWarnings(doc)`: the pieces the builder uses to
+  derive a coherent light and dark pair from a few seed colours, and to flag label contrast
+  below 4.5:1 and 3:1.
+- `RECIPES`, `makeFlavor`, `THEME_BASES`, `MODES`: the shipped cartography the gateway and the
+  themes are both built from.
+
+Runs in browsers, Cloudflare Workers, and Node 18 or later (it uses the web `CompressionStream`).
+Docs: [unmap.dev/docs/tiles-and-styles](https://unmap.dev/docs/tiles-and-styles) covers the
+`?theme=` parameter and the `invalid_theme` error.

package/dist/index.d.ts

@@ -224,7 +224,7 @@ declare const RECIPES: Record<ThemeBase, Record<ThemeMode, Recipe>>;
  * arrive on public query strings and are composed into style JSON the gateway signs its own
  * asset URLs into. `validateTheme` is the only door in.
  *
- * `base` names the structural chassis (one of the four shipped styles); each half carries only
+ * `base` names the structural chassis (one of the five shipped styles); each half carries only
  * sparse overrides on that chassis, so presets are near-empty documents and codes stay short.
  */
 type DeepPartial<T> = {

package/package.json

@@ -1,7 +1,25 @@
 {
   "name": "@unmap/themes",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "unmap theme documents: types, recipes, validation, codec (data-only map themes)",
+  "license": "MIT",
+  "keywords": [
+    "unmap",
+    "maps",
+    "canada",
+    "maplibre",
+    "theme",
+    "cartography"
+  ],
+  "homepage": "https://unmap.dev/create",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unmap-dev/unmap.git",
+    "directory": "packages/themes"
+  },
+  "bugs": {
+    "url": "https://github.com/unmap-dev/unmap/issues"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -27,6 +45,9 @@
     "typescript": "^5.6.0",
     "vitest": "^2.1.0"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "build": "tsup",
     "test": "vitest run",