@versatiles/style 5.2.6 → 5.2.7

package/src/style_builder/style_builder.ts

@@ -0,0 +1,134 @@
+import { Color } from '../color/index.js';
+import { getShortbreadTemplate, getShortbreadLayers } from '../shortbread/index.js';
+import { decorate } from './decorator.js';
+import { CachedRecolor, getDefaultRecolorFlags } from './recolor.js';
+import { basename, deepClone, resolveUrl } from '../lib/utils.js';
+import type { MaplibreLayer, MaplibreLayerDefinition, StyleSpecification } from '../types/maplibre.js';
+import type { StyleBuilderColors, StyleBuilderColorsEnsured, StyleBuilderFonts, StyleBuilderOptions } from './types.js';
+import type { StyleRules, StyleRulesOptions } from './types.js';
+import { SpriteSpecification } from '@maplibre/maplibre-gl-style-spec';
+
+
+
+// StyleBuilder class definition
+export abstract class StyleBuilder {
+	readonly #sourceName = 'versatiles-shortbread';
+
+	public abstract readonly name: string;
+
+	public abstract readonly defaultColors: StyleBuilderColors;
+
+	public abstract readonly defaultFonts: StyleBuilderFonts;
+
+	public build(options?: StyleBuilderOptions): StyleSpecification {
+
+		options ??= {};
+
+
+		const baseUrl = options.baseUrl ?? globalThis?.document?.location?.origin ?? 'https://tiles.versatiles.org';
+		const glyphs = options.glyphs ?? '/assets/glyphs/{fontstack}/{range}.pbf';
+
+		const sprite: SpriteSpecification = options.sprite ?? [{ id: 'basics', url: '/assets/sprites/basics/sprites' }];
+		const tiles = options.tiles ?? ['/tiles/osm/{z}/{x}/{y}'];
+		const hideLabels = options.hideLabels ?? false;
+		const language = options.language ?? null;
+		const recolorOptions = options.recolor ?? getDefaultRecolorFlags();
+
+		const colors = this.getColors(this.defaultColors);
+		if (options.colors) {
+			let key: keyof StyleBuilderColorsEnsured;
+			for (key in options.colors) {
+				const value = options.colors[key];
+				if (value != null) colors[key] = Color.parse(value);
+			}
+		}
+
+		const fonts = deepClone(this.defaultFonts);
+		if (options.fonts) {
+			let key: keyof StyleBuilderFonts;
+			for (key in options.fonts) {
+				const fontName = options.fonts[key];
+				if (fontName != null) fonts[key] = fontName;
+			}
+		}
+
+		// get empty shortbread style
+		const style = getShortbreadTemplate();
+
+		const styleRuleOptions: StyleRulesOptions = {
+			colors,
+			fonts,
+			language,
+		};
+
+		// get layer style rules from child class
+		const layerStyleRules = this.getStyleRules(styleRuleOptions);
+
+		// get shortbread layers
+		const layerDefinitions: MaplibreLayerDefinition[] = getShortbreadLayers({ language });
+		let layers: MaplibreLayer[] = layerDefinitions.map(layer => {
+			switch (layer.type) {
+				case 'background':
+					return layer;
+				case 'fill':
+				case 'line':
+				case 'symbol':
+					return {
+						source: this.#sourceName,
+						...layer,
+					};
+			}
+			throw Error('unknown layer type');
+		});
+		// apply layer rules
+		layers = decorate(layers, layerStyleRules, new CachedRecolor(recolorOptions));
+
+		// hide labels, if wanted
+		if (hideLabels) layers = layers.filter(l => l.type !== 'symbol');
+
+		style.layers = layers;
+		style.name = 'versatiles-' + this.name.toLowerCase();
+		style.glyphs = resolveUrl(baseUrl, glyphs);
+
+		if (typeof sprite == 'string') {
+			style.sprite = [{ id: basename(sprite), url: resolveUrl(baseUrl, sprite) }];
+		} else {
+			style.sprite = sprite.map(({ id, url }) => ({ id, url: resolveUrl(baseUrl, url) }));
+		}
+
+		const source = style.sources[this.#sourceName];
+		if ('tiles' in source) source.tiles = tiles.map(url => resolveUrl(baseUrl, url));
+
+		return style;
+	}
+
+	public getColors(colors: StyleBuilderColors): StyleBuilderColorsEnsured {
+		const entriesString = Object.entries(colors) as [keyof StyleBuilderColors, string | Color][];
+		const result = Object.fromEntries(entriesString.map(([key, value]) => [key, Color.parse(value)])) as StyleBuilderColorsEnsured;
+		return result;
+	}
+
+	public getDefaultOptions(): StyleBuilderOptions {
+		return {
+			baseUrl: '',
+			glyphs: '',
+			sprite: '',
+			tiles: [],
+			hideLabels: false,
+			language: undefined,
+			colors: deepClone(this.defaultColors),
+			fonts: deepClone(this.defaultFonts),
+			recolor: getDefaultRecolorFlags(),
+		};
+	}
+
+	protected transformDefaultColors(callback: (color: Color) => Color): void {
+		const colors = this.getColors(this.defaultColors);
+		let key: keyof StyleBuilderColorsEnsured;
+		for (key in colors) {
+			this.defaultColors[key] = callback(colors[key]);
+		}
+	}
+
+	protected abstract getStyleRules(options: StyleRulesOptions): StyleRules;
+}

package/src/style_builder/types.ts

@@ -0,0 +1,141 @@
+import type { Color } from '../color/index.js';
+import type { RecolorOptions } from './recolor.js';
+import { SpriteSpecification } from '@maplibre/maplibre-gl-style-spec';
+
+/** Represents language suffixes used in map styles. */
+export type Language = 'de' | 'en' | null;
+
+/** Options for configuring a style builder. */
+export interface StyleBuilderOptions {
+	/**
+	 * The base URL for loading external resources like tiles, sprites, and fonts.
+	 * Default: document.location.origin (in the browser), or 'https://tiles.versatiles.org'
+	 */
+	baseUrl?: string;
+
+	/**
+	 * The URL template for loading font glyphs, formatted with '{fontstack}' and '{range}' placeholders.
+	 * Default: '/assets/glyphs/{fontstack}/{range}.pbf'
+	 */
+	glyphs?: string;
+
+	/**
+	 * The URL for loading sprite images and metadata.
+	 * Default: [{ id: 'basics', url: '/assets/sprites/basics/sprites' }]
+	 */
+	sprite?: SpriteSpecification;
+
+	/**
+	 * An array of URL templates for loading map tiles, using '{z}', '{x}', and '{y}' placeholders.
+	 * Default: ['/tiles/osm/{z}/{x}/{y}']
+	 */
+	tiles?: string[];
+
+	/**
+	 * If set to true, hides all map labels.
+	 * Default: false
+	 */
+	hideLabels?: boolean;
+
+	/**
+	 * Set the language ('en', 'de') of all map labels.
+	 * A null value means that the language of the country in which the label is drawn will be used.
+	 * Default: null
+	 */
+	language?: Language;
+
+	/**
+	 * An object specifying overrides for default color values, keyed by the color names.
+	 */
+	colors?: Partial<StyleBuilderColors>;
+
+	/**
+	 * An object specifying overrides for default font names, keyed by the font names.
+	 */
+	fonts?: Partial<StyleBuilderFonts>;
+
+	/**
+	 * Options for color adjustments and transformations applied to the entire style.
+	 */
+	recolor?: RecolorOptions;
+}
+
+/** Records string values for color properties in a style builder. */
+export interface StyleBuilderColors {
+	agriculture: Color | string;
+	boundary: Color | string;
+	building: Color | string;
+	buildingbg: Color | string;
+	burial: Color | string;
+	commercial: Color | string;
+	construction: Color | string;
+	cycle: Color | string;
+	danger: Color | string;
+	disputed: Color | string;
+	education: Color | string;
+	foot: Color | string;
+	glacier: Color | string;
+	grass: Color | string;
+	hospital: Color | string;
+	industrial: Color | string;
+	label: Color | string;
+	labelHalo: Color | string;
+	land: Color | string;
+	leisure: Color | string;
+	motorway: Color | string;
+	motorwaybg: Color | string;
+	park: Color | string;
+	parking: Color | string;
+	poi: Color | string;
+	prison: Color | string;
+	rail: Color | string;
+	residential: Color | string;
+	rock: Color | string;
+	sand: Color | string;
+	shield: Color | string;
+	street: Color | string;
+	streetbg: Color | string;
+	subway: Color | string;
+	symbol: Color | string;
+	trunk: Color | string;
+	trunkbg: Color | string;
+	waste: Color | string;
+	water: Color | string;
+	wetland: Color | string;
+	wood: Color | string;
+};
+
+export type StyleBuilderColorsEnsured = Record<keyof StyleBuilderColors, Color>;
+
+/** Records string values for font properties in a style builder. */
+export type StyleBuilderFonts = {
+	regular: string;
+	bold: string;
+};
+
+/** Defines options for style rules in a style builder. */
+export interface StyleRulesOptions {
+	/**
+	 * The set of colors used in the style builder.
+	 */
+	colors: StyleBuilderColorsEnsured;
+
+	/**
+	 * The set of fonts used in the style builder.
+	 */
+	fonts: StyleBuilderFonts;
+
+	/**
+	 * The language used for map labels.
+	 */
+	language: Language;
+}
+
+/** Defines the value type for a style rule. */
+export type StyleRuleValue = boolean | number | object | string;
+
+/** Defines the structure of a style rule, which is a record of properties to style values. */
+export type StyleRule = Record<string, StyleRuleValue | undefined>;
+
+/** Defines the structure of style rules, which is a record of selectors to style rules. */
+export type StyleRules = Record<string, StyleRule | undefined>;

package/src/styles/LICENSE.md

@@ -0,0 +1,41 @@
+# Creative Commons CC0 1.0 Universal
+
+CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER.
+
+## Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. __Copyright and Related Rights.__ A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
+
+    i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
+
+    ii. moral rights retained by the original author(s) and/or performer(s);
+
+    iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
+
+    iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
+
+    v. rights protecting the extraction, dissemination, use and reuse of data in a Work;
+
+    vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
+
+    vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
+
+2. __Waiver.__ To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. __Public License Fallback.__ Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
+
+4. __Limitations and Disclaimers.__
+
+    a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
+
+    b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
+
+    c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
+
+    d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.