@versatiles/style 5.8.3 → 5.9.0

package/README.md

@@ -18,6 +18,7 @@
 | **eclipse**   | <img width="384" src="https://versatiles.org/versatiles-style/eclipse.png" alt="eclipse style" />     |
 | **neutrino**  | <img width="384" src="https://versatiles.org/versatiles-style/neutrino.png" alt="neutrino style" />   |
 | **shadow**    | <img width="384" src="https://versatiles.org/versatiles-style/shadow.png" alt="shadow style" />       |
+| **satellite** | <img width="384" src="https://versatiles.org/versatiles-style/satellite.png" alt="satellite style" /> |
 
 ---
 
@@ -51,16 +52,16 @@ Integrate it into your HTML application:
 <script src="maplibre-gl.js"></script>
 <script src="versatiles-style.js"></script>
 <script>
-  const style = VersaTilesStyle.graybeard({
-    language: "de",
-    colors: { label: "#222" },
-    recolor: { gamma: 0.5 },
-  });
-
-  const map = new maplibregl.Map({
-    container: "map",
-    style,
-  });
+	const style = VersaTilesStyle.graybeard({
+		language: 'de',
+		colors: { label: '#222' },
+		recolor: { gamma: 0.5 },
+	});
+
+	const map = new maplibregl.Map({
+		container: 'map',
+		style,
+	});
 </script>
 ```
 
@@ -75,13 +76,13 @@ npm install @versatiles/style
 Generate styles programmatically:
 
 ```javascript
-import { colorful } from "@versatiles/style";
-import { writeFileSync } from "node:fs";
+import { colorful } from '@versatiles/style';
+import { writeFileSync } from 'node:fs';
 
 const style = colorful({
-  language: "en",
+	language: 'en',
 });
-writeFileSync("style.json", JSON.stringify(style));
+writeFileSync('style.json', JSON.stringify(style));
 ```
 
 ---
@@ -95,8 +96,10 @@ The library offers the following style generation methods:
 - `graybeard(options)` - [Documentation](https://versatiles.org/versatiles-style/functions/graybeard.html)
 - `neutrino(options)` - [Documentation](https://versatiles.org/versatiles-style/functions/neutrino.html)
 - `shadow(options)` - [Documentation](https://versatiles.org/versatiles-style/functions/shadow.html)
+- `satellite(options)` - [Documentation](https://versatiles.org/versatiles-style/functions/satellite.html)
 
 **`options`**: An optional object to customize the styles. [Learn more](https://versatiles.org/versatiles-style/interfaces/StyleBuilderOptions.html)
+`satellite` uses a different options type: [SatelliteStyleOptions](https://versatiles.org/versatiles-style/interfaces/SatelliteStyleOptions.html)
 
 ### Guess Style Method
 
@@ -159,7 +162,7 @@ subgraph 1["color"]
 end
 subgraph 9["guess_style"]
 A["guess_style.ts"]
-Z["index.ts"]
+10["index.ts"]
 end
 subgraph B["lib"]
 C["utils.ts"]
@@ -171,7 +174,8 @@ Q["eclipse.ts"]
 R["empty.ts"]
 S["graybeard.ts"]
 T["neutrino.ts"]
-U["shadow.ts"]
+U["satellite.ts"]
+V["shadow.ts"]
 end
 subgraph G["style_builder"]
 H["style_builder.ts"]
@@ -185,13 +189,13 @@ K["layers.ts"]
 L["template.ts"]
 N["properties.ts"]
 end
-subgraph V["types"]
-W["index.ts"]
-X["tilejson.ts"]
-Y["vector_layer.ts"]
-11["maplibre.ts"]
+subgraph W["types"]
+X["index.ts"]
+Y["tilejson.ts"]
+Z["vector_layer.ts"]
+12["maplibre.ts"]
 end
-10["index.ts"]
+11["index.ts"]
 end
 3-->2
 3-->4
@@ -215,8 +219,8 @@ end
 A-->5
 A-->C
 A-->E
-A-->W
 A-->X
+A-->Y
 C-->8
 E-->F
 E-->Q
@@ -224,6 +228,7 @@ E-->R
 E-->S
 E-->T
 E-->U
+E-->V
 F-->H
 H-->8
 H-->C
@@ -241,15 +246,16 @@ Q-->F
 R-->F
 S-->F
 T-->F
-U-->F
-W-->X
-W-->Y
-Z-->A
-10-->8
-10-->Z
-10-->E
-
-class 0,1,9,B,D,G,I,V subgraphs;
+U-->S
+V-->F
+X-->Y
+X-->Z
+10-->A
+11-->8
+11-->10
+11-->E
+
+class 0,1,9,B,D,G,I,W subgraphs;
 classDef subgraphs fill-opacity:0.1, fill:#888, color:#888, stroke:#888;
 ```
 

package/dist/index.d.ts

@@ -88,12 +88,6 @@ declare class RGB extends Color {
      * @returns The current RGB instance.
      */
     asRGB(): RGB;
-    /**
-     * Returns the RGB color.
-     *
-     * @returns The current RGB instance.
-     */
-    toRGB(): RGB;
     /**
      * Parses a string or Color instance into an RGB color.
      *
@@ -306,11 +300,6 @@ declare class HSL extends Color {
      * @returns The current HSL color.
      */
     asHSL(): HSL;
-    /**
-     * Returns the current HSL color.
-     * @returns The current HSL color.
-     */
-    toHSL(): HSL;
     /**
      * Converts the HSL color to an HSV color.
      * @returns A new HSV color representing the same color.
@@ -548,7 +537,7 @@ interface RecolorOptions {
     /**
      * If true, inverts all colors' brightness.
      * See also {@link HSL.invertLuminosity}
-    */
+     */
     invertBrightness?: boolean;
     /**
      * Rotate the hue of all colors in degrees (0-360).
@@ -667,7 +656,8 @@ interface StyleBuilderOptions {
      */
     recolor?: RecolorOptions;
 }
-type StyleBuilderColorKey = 'agriculture' | 'boundary' | 'building' | 'buildingbg' | 'burial' | 'commercial' | 'construction' | 'cycle' | 'danger' | 'disputed' | 'education' | 'foot' | 'glacier' | 'grass' | 'hospital' | 'industrial' | 'label' | 'labelHalo' | 'land' | 'leisure' | 'motorway' | 'motorwaybg' | 'park' | 'parking' | 'poi' | 'prison' | 'rail' | 'residential' | 'rock' | 'sand' | 'shield' | 'street' | 'streetbg' | 'subway' | 'symbol' | 'trunk' | 'trunkbg' | 'waste' | 'water' | 'wetland' | 'wood';
+declare const styleBuilderColorKeys: readonly ["agriculture", "boundary", "building", "buildingbg", "burial", "commercial", "construction", "cycle", "danger", "disputed", "education", "foot", "glacier", "grass", "hospital", "industrial", "label", "labelHalo", "land", "leisure", "motorway", "motorwaybg", "park", "parking", "poi", "prison", "rail", "residential", "rock", "sand", "shield", "street", "streetbg", "subway", "symbol", "trunk", "trunkbg", "waste", "water", "wetland", "wood"];
+type StyleBuilderColorKey = (typeof styleBuilderColorKeys)[number];
 /** Records string values for color properties in a style builder. */
 type StyleBuilderColors<T = Color | string> = Record<StyleBuilderColorKey, T>;
 /** Records string values for font properties in a style builder. */
@@ -676,6 +666,21 @@ type StyleBuilderFonts = {
     bold: string;
 };
 
+interface SatelliteStyleOptions {
+    baseUrl?: string;
+    rasterTiles?: string[];
+    overlayTiles?: string[];
+    overlay?: boolean;
+    language?: Language;
+    rasterOpacity?: number;
+    rasterHueRotate?: number;
+    rasterBrightnessMin?: number;
+    rasterBrightnessMax?: number;
+    rasterSaturation?: number;
+    rasterContrast?: number;
+}
+declare function buildSatelliteStyle(options?: SatelliteStyleOptions): StyleSpecification;
+
 interface StyleBuilderFunction {
     (options?: StyleBuilderOptions): StyleSpecification;
     getOptions(): StyleBuilderOptions;
@@ -757,7 +762,8 @@ declare const styles: {
     graybeard: StyleBuilderFunction;
     shadow: StyleBuilderFunction;
     neutrino: StyleBuilderFunction;
+    satellite: typeof buildSatelliteStyle;
 };
 
-export { Color, HSL, HSV, RGB, colorful, eclipse, graybeard, guessStyle, neutrino, shadow, styles };
-export type { GuessStyleOptions, Language, RandomColorOptions, RecolorOptions, StyleBuilderColorKey, StyleBuilderColors, StyleBuilderFonts, StyleBuilderFunction, StyleBuilderOptions, TileJSONSpecification, TileJSONSpecificationRaster, TileJSONSpecificationVector, VectorLayer };
+export { Color, HSL, HSV, RGB, colorful, eclipse, graybeard, guessStyle, neutrino, buildSatelliteStyle as satellite, shadow, styles };
+export type { GuessStyleOptions, Language, RandomColorOptions, RecolorOptions, SatelliteStyleOptions, StyleBuilderColorKey, StyleBuilderColors, StyleBuilderFonts, StyleBuilderFunction, StyleBuilderOptions, TileJSONSpecification, TileJSONSpecificationRaster, TileJSONSpecificationVector, VectorLayer };