@versatiles/style 3.5.1 → 3.6.0

package/dist/lib/types.d.ts

@@ -0,0 +1,86 @@
+import type { BackgroundLayerSpecification, FillLayerSpecification, FilterSpecification, LineLayerSpecification, StyleSpecification, SymbolLayerSpecification } from '@maplibre/maplibre-gl-style-spec';
+import type Color from 'color';
+import type StyleBuilder from './style_builder.ts';
+export type TileFormat = 'avif' | 'bin' | 'geojson' | 'jpg' | 'json' | 'pbf' | 'png' | 'svg' | 'topojson' | 'webp';
+export type MaplibreLayer = BackgroundLayerSpecification | FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification;
+export type MaplibreLayerDefinition = BackgroundLayerSpecification | Omit<FillLayerSpecification, 'source'> | Omit<LineLayerSpecification, 'source'> | Omit<SymbolLayerSpecification, 'source'>;
+export type MaplibreFilter = FilterSpecification;
+export interface VectorLayer {
+    id: string;
+    fields: Record<string, 'Boolean' | 'Number' | 'String'>;
+    description?: string;
+    minzoom?: number;
+    maxzoom?: number;
+}
+export interface TileJSONSpecificationRaster {
+    tilejson?: '3.0.0';
+    type: 'raster';
+    attribution?: string;
+    tiles: string[];
+    scheme?: 'tms' | 'xyz';
+    bounds?: [number, number, number, number];
+    center?: [number, number];
+    description?: string;
+    fillzoom?: number;
+    grids?: string[];
+    legend?: string;
+    minzoom?: number;
+    maxzoom?: number;
+    name?: string;
+    template?: string;
+    format: 'avif' | 'jpg' | 'png' | 'webp';
+}
+export interface TileJSONSpecificationVector extends Omit<TileJSONSpecificationRaster, 'format' | 'type'> {
+    vector_layers: VectorLayer[];
+    format: 'pbf';
+    type: 'vector';
+}
+export type TileJSONSpecification = TileJSONSpecificationRaster | TileJSONSpecificationVector;
+export type MaplibreStyleRaster = Omit<StyleSpecification, 'sources'> & {
+    'sources': {
+        [_: string]: TileJSONSpecificationRaster;
+    };
+};
+export type MaplibreStyleVector = Omit<StyleSpecification, 'sources'> & {
+    'sources': {
+        [_: string]: TileJSONSpecificationVector;
+    };
+};
+export type MaplibreStyle = MaplibreStyleRaster | MaplibreStyleVector;
+export type StyleRuleValue = boolean | number | object | string;
+export type StyleRule = Record<string, StyleRuleValue | undefined>;
+export type StyleRules = Record<string, StyleRule | undefined>;
+export type LanguageSuffix = '_de' | '_en' | '';
+export type StylemakerColorKeys<T extends StyleBuilder<T>> = keyof T['defaultColors'];
+export type StylemakerFontKeys<T extends StyleBuilder<T>> = keyof T['defaultFonts'];
+export type StylemakerColorStrings<T extends StyleBuilder<T>> = Record<StylemakerColorKeys<T>, string>;
+export type StylemakerFontStrings<T extends StyleBuilder<T>> = Record<StylemakerFontKeys<T>, string>;
+export type StylemakerColors<T extends StyleBuilder<T>> = Record<StylemakerColorKeys<T>, Color>;
+export type StylemakerFonts<T extends StyleBuilder<T>> = Record<StylemakerFontKeys<T>, string>;
+export interface StyleRulesOptions<T extends StyleBuilder<T>> {
+    colors: StylemakerColors<T>;
+    fonts: StylemakerFontStrings<T>;
+    languageSuffix: string;
+}
+export interface RecolorOptions {
+    invert?: boolean;
+    rotate?: number;
+    saturate?: number;
+    gamma?: number;
+    contrast?: number;
+    brightness?: number;
+    tint?: number;
+    tintColor?: string;
+}
+export interface StylemakerOptions<T extends StyleBuilder<T>> {
+    baseUrl?: string;
+    glyphsUrl?: string;
+    spriteUrl?: string;
+    tilesUrls?: string[];
+    hideLabels?: boolean;
+    languageSuffix?: LanguageSuffix;
+    colors?: Partial<StylemakerColorStrings<T>>;
+    fonts?: Partial<StylemakerFontStrings<T>>;
+    recolor?: RecolorOptions;
+}
+export declare function isTileJSONSpecification(obj: unknown): obj is TileJSONSpecification;

package/dist/lib/types.js

@@ -0,0 +1,89 @@
+/* eslint-disable @typescript-eslint/no-unnecessary-condition */
+export function isTileJSONSpecification(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        throw Error('spec must be an object');
+    }
+    const spec = obj;
+    // Common property validation
+    if (typeof spec.tilejson !== 'undefined' && spec.tilejson !== '3.0.0') {
+        throw Error('spec.tilejson must be "3.0.0" if present');
+    }
+    if (typeof spec.attribution !== 'undefined' && typeof spec.attribution !== 'string') {
+        throw Error('spec.attribution must be a string if present');
+    }
+    if (typeof spec.scheme !== 'undefined' && !['tms', 'xyz'].includes(spec.scheme)) {
+        throw Error('spec.scheme must be "tms" or "xyz" if present');
+    }
+    if (typeof spec.bounds !== 'undefined' && (!Array.isArray(spec.bounds) || spec.bounds.length !== 4 || spec.bounds.some(num => typeof num !== 'number'))) {
+        throw Error('spec.bounds must be an array of four numbers if present');
+    }
+    if (typeof spec.center !== 'undefined' && (!Array.isArray(spec.center) || spec.center.length !== 2 || spec.center.some(num => typeof num !== 'number'))) {
+        throw Error('spec.center must be an array of two numbers if present');
+    }
+    if (typeof spec.description !== 'undefined' && typeof spec.description !== 'string') {
+        throw Error('spec.description must be a string if present');
+    }
+    if (typeof spec.fillzoom !== 'undefined' && typeof spec.fillzoom !== 'number') {
+        throw Error('spec.fillzoom must be a number if present');
+    }
+    if (typeof spec.grids !== 'undefined' && (!Array.isArray(spec.grids) || spec.grids.some(url => typeof url !== 'string'))) {
+        throw Error('spec.grids must be an array of strings if present');
+    }
+    if (typeof spec.legend !== 'undefined' && typeof spec.legend !== 'string') {
+        throw Error('spec.legend must be a string if present');
+    }
+    if (typeof spec.minzoom !== 'undefined' && typeof spec.minzoom !== 'number') {
+        throw Error('spec.minzoom must be a number if present');
+    }
+    if (typeof spec.maxzoom !== 'undefined' && typeof spec.maxzoom !== 'number') {
+        throw Error('spec.maxzoom must be a number if present');
+    }
+    if (typeof spec.name !== 'undefined' && typeof spec.name !== 'string') {
+        throw Error('spec.name must be a string if present');
+    }
+    if (typeof spec.template !== 'undefined' && typeof spec.template !== 'string') {
+        throw Error('spec.template must be a string if present');
+    }
+    if (spec.type === 'raster') {
+        if (!['avif', 'jpg', 'png', 'webp'].includes(spec.format)) {
+            throw Error('spec.format must be "avif", "jpg", "png", or "webp"');
+        }
+        if (!Array.isArray(spec.tiles) || spec.tiles.some(url => typeof url !== 'string')) {
+            throw Error('spec.tiles must be an array of strings');
+        }
+    }
+    else if (spec.type === 'vector') {
+        if (spec.format !== 'pbf') {
+            throw Error('spec.format must be "pbf"');
+        }
+        if (!Array.isArray(spec.vector_layers) || spec.vector_layers.some(layer => !validateVectorLayer(layer))) {
+            throw Error('spec.vector_layers must be an array of VectorLayer');
+        }
+    }
+    else {
+        throw Error('spec.type must be "raster" or "vector"');
+    }
+    return true;
+}
+function validateVectorLayer(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        throw Error('layer must be an object');
+    }
+    const layer = obj;
+    if (typeof layer.id !== 'string') {
+        throw Error('layer.id must be a string');
+    }
+    if (typeof layer.fields !== 'object' || layer.fields === null || Object.values(layer.fields).some(type => !['Boolean', 'Number', 'String'].includes(type))) {
+        throw Error('layer.fields must be an object with values "Boolean", "Number", or "String"');
+    }
+    if (typeof layer.description !== 'undefined' && typeof layer.description !== 'string') {
+        throw Error('layer.description must be a string if present');
+    }
+    if (typeof layer.minzoom !== 'undefined' && (typeof layer.minzoom !== 'number' || layer.minzoom < 0)) {
+        throw Error('layer.minzoom must be a non-negative number if present');
+    }
+    if (typeof layer.maxzoom !== 'undefined' && (typeof layer.maxzoom !== 'number' || layer.maxzoom < 0)) {
+        throw Error('layer.maxzoom must be a non-negative number if present');
+    }
+    return true;
+}

package/dist/style/colorful.d.ts

@@ -1,12 +1,12 @@
 import StyleBuilder from '../lib/style_builder.js';
-import type { StyleRules, StyleRulesOptions } from '../lib/style_builder.js';
-export default class Colorful extends StyleBuilder {
+import type { StyleRules, StyleRulesOptions } from '../lib/types.js';
+export default class Colorful extends StyleBuilder<Colorful> {
     readonly name: string;
-    fonts: {
+    defaultFonts: {
         regular: string;
         bold: string;
     };
-    colors: {
+    defaultColors: {
         land: string;
         water: string;
         glacier: string;
@@ -49,5 +49,5 @@ export default class Colorful extends StyleBuilder {
         hospital: string;
         poi: string;
     };
-    protected getStyleRules(options: StyleRulesOptions): StyleRules;
+    protected getStyleRules(options: StyleRulesOptions<Colorful>): StyleRules;
 }

package/dist/style/colorful.js

@@ -1,12 +1,12 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import StyleBuilder from '../lib/style_builder.js';
 export default class Colorful extends StyleBuilder {
-    name = 'colorful';
-    fonts = {
+    name = 'Colorful';
+    defaultFonts = {
         regular: 'noto_sans_regular',
         bold: 'noto_sans_bold',
     };
-    colors = {
+    defaultColors = {
         land: '#F9F4EE',
         water: '#BEDDF3',
         glacier: '#FFFFFF',

package/dist/style/graybeard.js

@@ -1,8 +1,8 @@
 import Colorful from './colorful.js';
 export default class Graybeard extends Colorful {
-    name = 'graybeard';
+    name = 'Graybeard';
     constructor() {
         super();
-        this.resetColors(color => color.desaturate(1));
+        this.transformDefaultColors(color => color.desaturate(1));
     }
 }

package/dist/style/neutrino.d.ts

@@ -1,12 +1,12 @@
 import StyleBuilder from '../lib/style_builder.js';
-import type { StyleRules, StyleRulesOptions } from '../lib/style_builder.js';
-export default class Neutrino extends StyleBuilder {
+import type { StyleRules, StyleRulesOptions } from '../lib/types.js';
+export default class Neutrino extends StyleBuilder<Neutrino> {
     readonly name: string;
-    fonts: {
+    defaultFonts: {
         regular: string;
         bold: string;
     };
-    colors: {
+    defaultColors: {
         land: string;
         water: string;
         grass: string;
@@ -20,5 +20,5 @@ export default class Neutrino extends StyleBuilder {
         rail: string;
         label: string;
     };
-    protected getStyleRules(options: StyleRulesOptions): StyleRules;
+    protected getStyleRules(options: StyleRulesOptions<Neutrino>): StyleRules;
 }

package/dist/style/neutrino.js

@@ -1,12 +1,12 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import StyleBuilder from '../lib/style_builder.js';
 export default class Neutrino extends StyleBuilder {
-    name = 'neutrino';
-    fonts = {
+    name = 'Neutrino';
+    defaultFonts = {
         regular: 'noto_sans_regular',
         bold: 'noto_sans_bold',
     };
-    colors = {
+    defaultColors = {
         land: '#f6f0f6',
         water: '#cbd2df',
         grass: '#e7e9e5',

package/package.json

@@ -1,21 +1,23 @@
 {
   "name": "@versatiles/style",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "Generate StyleJSON for MapLibre",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "check": "npm run lint && npm run build && npm run test",
+    "check": "npm run build && npm run lint && npm run test",
     "build": "npm run build-browser && npm run build-node && npm run build-styles",
     "build-browser": "rollup -c=rollup.config.js",
-    "build-node": "rm -rf dist && tsc -p tsconfig.node.json",
+    "build-node": "rm -rf dist && tsc -p tsconfig.node.json && chmod +x dist/index.js",
     "build-styles": "tsx scripts/build-styles.ts",
-    "lint": "eslint .",
+    "doc": "vrt ts2md src/index.ts tsconfig.node.json | vrt insertmd README.md '# API'",
+    "lint": "npm run build-browser && eslint --color .",
     "release": "tsx scripts/release.ts",
-    "test": "npm run test-node && npm run test-coverage && npm run test-browser",
-    "test-browser": "npm run build-browser && echo 'add browser test'",
+    "test": "npm run test-typescript && npm run test-node && npm run test-browser",
+    "test-browser": "npm run build-browser && jest -c=jest.config.browser.ts",
     "test-coverage": "NODE_OPTIONS=--experimental-vm-modules jest -c=jest.config.coverage.ts",
     "test-node": "npm run build-node && NODE_OPTIONS=--experimental-vm-modules jest -c=jest.config.node.ts",
+    "test-typescript": "NODE_OPTIONS=--experimental-vm-modules jest -c=jest.config.typescript.ts",
     "upgrade": "npm-check-updates -u && rm -f package-lock.json && rm -rf node_modules; npm i"
   },
   "repository": {
@@ -27,7 +29,6 @@
   "type": "module",
   "dependencies": {
     "@types/color": "^3.0.6",
-    "@types/mapbox-gl": "^2.7.18",
     "brace-expansion": "^3.0.0",
     "color": "^4.2.3"
   },
@@ -43,20 +44,22 @@
     "@rollup/plugin-typescript": "^11.1.5",
     "@types/brace-expansion": "^1.1.2",
     "@types/inquirer": "^9.0.7",
-    "@types/jest": "^29.5.8",
-    "@types/node": "^20.9.0",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
-    "eslint": "^8.53.0",
+    "@types/jest": "^29.5.10",
+    "@types/node": "^20.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.0",
+    "@typescript-eslint/parser": "^6.13.0",
+    "@versatiles/release-tool": "^1.0.3",
+    "eslint": "^8.54.0",
     "inquirer": "^9.2.12",
     "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "jest-ts-webcompat-resolver": "^1.0.0",
-    "npm-check-updates": "^16.14.6",
-    "rollup": "^4.3.1",
+    "npm-check-updates": "^16.14.11",
+    "rollup": "^4.6.0",
     "rollup-plugin-dts": "^6.1.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "tsx": "^4.1.1",
-    "typescript": "^5.2.2"
+    "tsx": "^4.5.0",
+    "typescript": "^5.3.2"
   }
 }