@versatiles/style 3.8.0 → 3.8.2

package/README.MD

@@ -35,12 +35,18 @@ Use it in:
 <script src="maplibre-gl.js"></script>
 <script src="versatiles-style.js"></script>
 <script>
-	const styleBuilder = new VersaTilesStyle.Colorful();
-  styleBuilder.tilesUrl = ['tiles/{z}/{x}/{y}'];
+  const style = VersaTilesStyle.graybeard({
+    tiles: ['https://???.org/tiles/osm/{z}/{x}/{y}'],
+    sprite: 'https://???.org/assets/styles/swr-bright/sprite',
+    glyphs: 'https://???.org/assets/fonts/{fontstack}/{range}.pbf',
+    languageSuffix: '_de',
+    colors: { label: '#222' },
+    recolor: { gamma: 0.5 }
+  });
 
 	const map = new maplibregl.Map({
 		container: 'map',
-		style: styleBuilder.build()
+		style
 	});
 <script>
 ```
@@ -125,7 +131,7 @@ interface {
 
 ### Method: `colorful(options)`
 
-<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/326466c/src/index.ts#L4">\[src]</a></sup>
+<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/be6dcfe/src/index.ts#L4">\[src]</a></sup>
 
 **Parameters:**
 
@@ -135,7 +141,7 @@ interface {
 
 ### Method: `graybeard(options)`
 
-<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/326466c/src/index.ts#L9">\[src]</a></sup>
+<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/be6dcfe/src/index.ts#L9">\[src]</a></sup>
 
 **Parameters:**
 
@@ -145,7 +151,7 @@ interface {
 
 ### Method: `guessStyle(opt)`
 
-<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/326466c/src/lib/style_guesser.ts#L12">\[src]</a></sup>
+<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/be6dcfe/src/lib/style_guesser.ts#L13">\[src]</a></sup>
 
 **Parameters:**
 
@@ -155,7 +161,7 @@ interface {
 
 ### Method: `neutrino(options)`
 
-<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/326466c/src/index.ts#L14">\[src]</a></sup>
+<sup><a href="https://github.com/versatiles-org/versatiles-style/blob/be6dcfe/src/index.ts#L14">\[src]</a></sup>
 
 **Parameters:**
 

package/dist/lib/decorator.js

@@ -98,7 +98,7 @@ function processColor(value) {
     if (typeof value === 'string')
         value = Color(value);
     if (value instanceof Color) {
-        value = (value.alpha() === 1) ? value.hex() : value.hexa();
+        value = (value.alpha() === 1) ? value.hex() : value.string();
         return value.toLowerCase();
     }
     throw new Error(`unknown color type "${typeof value}"`);

package/dist/lib/decorator.test.js

@@ -27,7 +27,7 @@ describe('decorate function', () => {
                 expect(layer.layout).toHaveProperty('visibility', 'none');
             }
             if (layer.id === 'layer2') {
-                expect(layer.paint).toHaveProperty('line-color', '#00ff0080');
+                expect(layer.paint).toHaveProperty('line-color', 'rgba(0, 255, 0, 0.5)');
                 expect(layer.layout).toHaveProperty('visibility', 'visible');
             }
         });

package/dist/lib/style_builder.js

@@ -3,7 +3,7 @@ import getShortbreadTemplate from './shortbread/template.js';
 import getShortbreadLayers from './shortbread/layers.js';
 import { decorate } from './decorator.js';
 import { getDefaultRecolorFlags, recolor } from './recolor.js';
-import { deepClone } from './utils.js';
+import { deepClone, resolveUrl } from './utils.js';
 // Stylemaker class definition
 export default class StyleBuilder {
     #sourceName = 'versatiles-shortbread';
@@ -70,14 +70,6 @@ export default class StyleBuilder {
         if ('tiles' in source)
             source.tiles = tiles.map(url => resolveUrl(baseUrl, url));
         return style;
-        function resolveUrl(base, url) {
-            if (!Boolean(base))
-                return url;
-            url = new URL(url, base).href;
-            url = url.replace(/%7B/gi, '{');
-            url = url.replace(/%7D/gi, '}');
-            return url;
-        }
     }
     getColors(colors) {
         const entriesString = Object.entries(colors);

package/dist/lib/style_guesser.js

@@ -3,6 +3,7 @@
 import { isTileJSONSpecification } from './types.js';
 import randomColorGenerator from './random_color.js';
 import Colorful from '../style/colorful.js';
+import { resolveUrl } from './utils.js';
 export default function guess(opt) {
     const { format } = opt;
     const tilejsonBasic = {
@@ -21,6 +22,10 @@ export default function guess(opt) {
         name: opt.name,
         template: opt.template,
     };
+    const { baseUrl } = opt;
+    if (typeof baseUrl === 'string') {
+        tilejsonBasic.tiles = tilejsonBasic.tiles.map(url => resolveUrl(baseUrl, url));
+    }
     let k;
     for (k in tilejsonBasic) {
         // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
@@ -52,7 +57,7 @@ export default function guess(opt) {
             break;
         case 'vector':
             if (isShortbread(tilejson)) {
-                style = getShortbreadStyle(tilejson, { baseUrl: opt.baseUrl, glyphs: opt.glyphs, sprite: opt.sprite });
+                style = getShortbreadStyle(tilejson, opt);
             }
             else {
                 style = getInspectorStyle(tilejson);

package/dist/lib/style_guesser.test.js

@@ -121,4 +121,22 @@ describe('guessStyle', () => {
             });
         });
     });
+    describe('absolute tile urls override baseUrl', () => {
+        cases.forEach(({ type, options }) => {
+            it(type, () => {
+                const style = guessStyle({ ...options, tiles: ['https://example1.org/tiles/{z}/{x}/{y}'], baseUrl: 'https://example2.org/' });
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                expect(Object.values(style.sources)[0].tiles).toEqual(['https://example1.org/tiles/{z}/{x}/{y}']);
+            });
+        });
+    });
+    describe('relative tile urls are resolved with baseUrl', () => {
+        cases.forEach(({ type, options }) => {
+            it(type, () => {
+                const style = guessStyle({ ...options, tiles: ['./{z}/{x}/{y}'], baseUrl: 'https://example2.org/tiles/' });
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                expect(Object.values(style.sources)[0].tiles).toEqual(['https://example2.org/tiles/{z}/{x}/{y}']);
+            });
+        });
+    });
 });

package/dist/lib/utils.d.ts

@@ -2,3 +2,4 @@ export declare function deepClone<T>(obj: T): T;
 export declare function isSimpleObject(item: unknown): boolean;
 export declare function isBasicType(item: unknown): boolean;
 export declare function deepMerge<T extends object>(source0: T, ...sources: T[]): T;
+export declare function resolveUrl(base: string, url: string): string;

package/dist/lib/utils.js

@@ -104,3 +104,11 @@ export function deepMerge(source0, ...sources) {
     }
     return target;
 }
+export function resolveUrl(base, url) {
+    if (!Boolean(base))
+        return url;
+    url = new URL(url, base).href;
+    url = url.replace(/%7B/gi, '{');
+    url = url.replace(/%7D/gi, '}');
+    return url;
+}

package/dist/lib/utils.test.js

@@ -1,97 +1,115 @@
-import { deepClone, isSimpleObject, isBasicType, deepMerge } from './utils.js';
+import { deepClone, isSimpleObject, isBasicType, deepMerge, resolveUrl } from './utils.js';
 import Color from 'color';
-describe('Utilities tests', () => {
-    describe('deepClone', () => {
-        it('clones primitive types correctly', () => {
-            expect(deepClone(10)).toBe(10);
-            expect(deepClone(true)).toBe(true);
-            expect(deepClone('string')).toBe('string');
-        });
-        it('clones an array correctly', () => {
-            const array = [1, 2, { a: 'b' }];
-            const clonedArray = deepClone(array);
-            expect(clonedArray).toEqual(array);
-            expect(clonedArray).not.toBe(array);
-        });
-        it('clones a simple object correctly', () => {
-            const obj = { a: 'b', c: 1, d: true };
-            const clonedObj = deepClone(obj);
-            expect(clonedObj).toEqual(obj);
-            expect(clonedObj).not.toBe(obj);
-        });
-        it('clones a Color instance correctly', () => {
-            const color = new Color('#FF5733');
-            const clonedColor = deepClone(color);
-            expect(clonedColor.hex()).toBe(color.hex());
-        });
-        it('throws an error for non-implemented types', () => {
-            const func = () => true;
-            expect(() => deepClone(func)).toThrow('Not implemented yet: "function" case');
-        });
-    });
-    describe('isSimpleObject', () => {
-        it('identifies simple objects correctly', () => {
-            expect(isSimpleObject({ a: 1 })).toBe(true);
-        });
-        it('rejects non-objects', () => {
-            expect(isSimpleObject(1)).toBe(false);
-            expect(isSimpleObject('a')).toBe(false);
-            expect(isSimpleObject(true)).toBe(false);
-        });
-        it('rejects arrays', () => {
-            expect(isSimpleObject([1, 2, 3])).toBe(false);
-        });
-        it('rejects objects with prototype properties', () => {
-            class MyClass {
-                #property = true;
-            }
-            expect(isSimpleObject(new MyClass())).toBe(false);
-        });
-    });
-    describe('isBasicType', () => {
-        it('returns true for basic types', () => {
-            expect(isBasicType(1)).toBe(true);
-            expect(isBasicType('string')).toBe(true);
-            expect(isBasicType(true)).toBe(true);
-            expect(isBasicType(undefined)).toBe(true);
-        });
-        it('returns false for objects', () => {
-            expect(isBasicType({})).toBe(false);
-            expect(isBasicType([])).toBe(false);
-        });
-        it('throws error for functions', () => {
-            expect(() => isBasicType(() => true)).toThrow();
-        });
-    });
-    describe('deepMerge', () => {
-        it('merges simple objects correctly', () => {
-            const target = { a: 1, b: 2 };
-            const source = { b: 3, c: 4 };
-            const result = deepMerge(target, source);
-            expect(result).toEqual({ a: 1, b: 3, c: 4 });
-        });
-        it('merges nested objects correctly', () => {
-            const target = { a: { d: 4 }, b: 2 };
-            const source = { a: { e: 5 }, b: 3 };
-            const result = deepMerge(target, source);
-            expect(result).toEqual({ a: { d: 4, e: 5 }, b: 3 });
-        });
-        it('overrides primitives with object types', () => {
-            const target = { a: 1, b: 2 };
-            const source = { a: { d: 4 }, b: { e: 5 } };
-            const result = deepMerge(target, source);
-            expect(result).toEqual({ a: { d: 4 }, b: { e: 5 } });
-        });
-        it('merges Color instances correctly', () => {
-            const target = { color: new Color('#FF5733') };
-            const source = { color: new Color('#33FF57') };
-            const result = deepMerge(target, source);
-            expect(result.color.hex()).toBe(source.color.hex());
-        });
-        it('throws error for unpredicted cases', () => {
-            const target = { a: () => false };
-            const source = { a: { b: 1 } };
-            expect(() => deepMerge(target, source)).toThrow('Not implemented yet: "function" case');
-        });
+describe('deepClone', () => {
+    it('clones primitive types correctly', () => {
+        expect(deepClone(10)).toBe(10);
+        expect(deepClone(true)).toBe(true);
+        expect(deepClone('string')).toBe('string');
+    });
+    it('clones an array correctly', () => {
+        const array = [1, 2, { a: 'b' }];
+        const clonedArray = deepClone(array);
+        expect(clonedArray).toEqual(array);
+        expect(clonedArray).not.toBe(array);
+    });
+    it('clones a simple object correctly', () => {
+        const obj = { a: 'b', c: 1, d: true };
+        const clonedObj = deepClone(obj);
+        expect(clonedObj).toEqual(obj);
+        expect(clonedObj).not.toBe(obj);
+    });
+    it('clones a Color instance correctly', () => {
+        const color = new Color('#FF5733');
+        const clonedColor = deepClone(color);
+        expect(clonedColor.hex()).toBe(color.hex());
+    });
+    it('throws an error for non-implemented types', () => {
+        const func = () => true;
+        expect(() => deepClone(func)).toThrow('Not implemented yet: "function" case');
+    });
+});
+describe('isSimpleObject', () => {
+    it('identifies simple objects correctly', () => {
+        expect(isSimpleObject({ a: 1 })).toBe(true);
+    });
+    it('rejects non-objects', () => {
+        expect(isSimpleObject(1)).toBe(false);
+        expect(isSimpleObject('a')).toBe(false);
+        expect(isSimpleObject(true)).toBe(false);
+    });
+    it('rejects arrays', () => {
+        expect(isSimpleObject([1, 2, 3])).toBe(false);
+    });
+    it('rejects objects with prototype properties', () => {
+        class MyClass {
+            #property = true;
+        }
+        expect(isSimpleObject(new MyClass())).toBe(false);
+    });
+});
+describe('isBasicType', () => {
+    it('returns true for basic types', () => {
+        expect(isBasicType(1)).toBe(true);
+        expect(isBasicType('string')).toBe(true);
+        expect(isBasicType(true)).toBe(true);
+        expect(isBasicType(undefined)).toBe(true);
+    });
+    it('returns false for objects', () => {
+        expect(isBasicType({})).toBe(false);
+        expect(isBasicType([])).toBe(false);
+    });
+    it('throws error for functions', () => {
+        expect(() => isBasicType(() => true)).toThrow();
+    });
+});
+describe('deepMerge', () => {
+    it('merges simple objects correctly', () => {
+        const target = { a: 1, b: 2 };
+        const source = { b: 3, c: 4 };
+        const result = deepMerge(target, source);
+        expect(result).toEqual({ a: 1, b: 3, c: 4 });
+    });
+    it('merges nested objects correctly', () => {
+        const target = { a: { d: 4 }, b: 2 };
+        const source = { a: { e: 5 }, b: 3 };
+        const result = deepMerge(target, source);
+        expect(result).toEqual({ a: { d: 4, e: 5 }, b: 3 });
+    });
+    it('overrides primitives with object types', () => {
+        const target = { a: 1, b: 2 };
+        const source = { a: { d: 4 }, b: { e: 5 } };
+        const result = deepMerge(target, source);
+        expect(result).toEqual({ a: { d: 4 }, b: { e: 5 } });
+    });
+    it('merges Color instances correctly', () => {
+        const target = { color: new Color('#FF5733') };
+        const source = { color: new Color('#33FF57') };
+        const result = deepMerge(target, source);
+        expect(result.color.hex()).toBe(source.color.hex());
+    });
+    it('throws error for unpredicted cases', () => {
+        const target = { a: () => false };
+        const source = { a: { b: 1 } };
+        expect(() => deepMerge(target, source)).toThrow('Not implemented yet: "function" case');
+    });
+});
+describe('resolveUrl', () => {
+    test('should correctly resolve a relative URL with a base URL', () => {
+        expect(resolveUrl('http://example.com/', 'path/page')).toBe('http://example.com/path/page');
+    });
+    test('should return the same URL if base URL is empty', () => {
+        expect(resolveUrl('', 'http://example.com/path/page')).toBe('http://example.com/path/page');
+    });
+    test('should return the correct URL if absolute URL is used', () => {
+        expect(resolveUrl('http://example1.com', 'http://example.com/path/page')).toBe('http://example.com/path/page');
+    });
+    test('should handle URLs with special characters', () => {
+        expect(resolveUrl('http://example.com/', 'path/{param}')).toBe('http://example.com/path/{param}');
+    });
+    test('should handle URLs already containing encoded special characters', () => {
+        expect(resolveUrl('http://example.com/', 'path/%7Bparam%7D')).toBe('http://example.com/path/{param}');
+    });
+    test('should throw error for invalid base URL', () => {
+        expect(() => resolveUrl('invalid-base', 'path/page')).toThrow('Invalid URL');
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/style",
-  "version": "3.8.0",
+  "version": "3.8.2",
   "description": "Generate StyleJSON for MapLibre",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,7 @@
     "build-styles": "tsx scripts/build-styles.ts",
     "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",
+    "release": "npx vrt release-npm",
     "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",
@@ -37,29 +37,29 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "@maplibre/maplibre-gl-style-spec": "^19.3.3",
+    "@maplibre/maplibre-gl-style-spec": "^20.1.1",
     "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.5",
+    "@rollup/plugin-typescript": "^11.1.6",
     "@types/brace-expansion": "^1.1.2",
     "@types/inquirer": "^9.0.7",
-    "@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",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.17",
+    "@typescript-eslint/eslint-plugin": "^7.0.1",
+    "@typescript-eslint/parser": "^7.0.1",
+    "@versatiles/release-tool": "^1.2.1",
+    "eslint": "^8.56.0",
+    "inquirer": "^9.2.14",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-ts-webcompat-resolver": "^1.0.0",
-    "npm-check-updates": "^16.14.11",
-    "rollup": "^4.6.0",
+    "npm-check-updates": "^16.14.15",
+    "rollup": "^4.10.0",
     "rollup-plugin-dts": "^6.1.0",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "tsx": "^4.5.0",
-    "typescript": "^5.3.2"
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.3"
   }
 }