@maptiler/sdk 3.9.0-rc.4 → 3.9.0-rc.5

package/dist/src/language.d.ts

@@ -0,0 +1,107 @@
+import { LanguageInfo } from '@maptiler/client';
+declare const Language: {
+    readonly ALBANIAN: LanguageInfo;
+    readonly AMHARIC: LanguageInfo;
+    readonly ARABIC: LanguageInfo;
+    readonly ARMENIAN: LanguageInfo;
+    readonly AZERBAIJANI: LanguageInfo;
+    readonly BASQUE: LanguageInfo;
+    readonly BELARUSIAN: LanguageInfo;
+    readonly BENGALI: LanguageInfo;
+    readonly BOSNIAN: LanguageInfo;
+    readonly BRETON: LanguageInfo;
+    readonly BULGARIAN: LanguageInfo;
+    readonly CATALAN: LanguageInfo;
+    readonly CHINESE: LanguageInfo;
+    readonly TRADITIONAL_CHINESE: LanguageInfo;
+    readonly SIMPLIFIED_CHINESE: LanguageInfo;
+    readonly CORSICAN: LanguageInfo;
+    readonly CROATIAN: LanguageInfo;
+    readonly CZECH: LanguageInfo;
+    readonly DANISH: LanguageInfo;
+    readonly DUTCH: LanguageInfo;
+    readonly GERMAN: LanguageInfo;
+    readonly GREEK: LanguageInfo;
+    readonly ENGLISH: LanguageInfo;
+    readonly ESPERANTO: LanguageInfo;
+    readonly ESTONIAN: LanguageInfo;
+    readonly FINNISH: LanguageInfo;
+    readonly FRENCH: LanguageInfo;
+    readonly FRISIAN: LanguageInfo;
+    readonly GEORGIAN: LanguageInfo;
+    readonly HEBREW: LanguageInfo;
+    readonly HINDI: LanguageInfo;
+    readonly HUNGARIAN: LanguageInfo;
+    readonly ICELANDIC: LanguageInfo;
+    readonly INDONESIAN: LanguageInfo;
+    readonly IRISH: LanguageInfo;
+    readonly ITALIAN: LanguageInfo;
+    readonly JAPANESE: LanguageInfo;
+    readonly JAPANESE_HIRAGANA: LanguageInfo;
+    readonly JAPANESE_2018: LanguageInfo;
+    readonly JAPANESE_KANA: LanguageInfo;
+    readonly JAPANESE_LATIN: LanguageInfo;
+    readonly KANNADA: LanguageInfo;
+    readonly KAZAKH: LanguageInfo;
+    readonly KOREAN: LanguageInfo;
+    readonly KOREAN_LATIN: LanguageInfo;
+    readonly KURDISH: LanguageInfo;
+    readonly CLASSICAL_LATIN: LanguageInfo;
+    readonly LATVIAN: LanguageInfo;
+    readonly LITHUANIAN: LanguageInfo;
+    readonly LUXEMBOURGISH: LanguageInfo;
+    readonly MACEDONIAN: LanguageInfo;
+    readonly MALAYALAM: LanguageInfo;
+    readonly MALTESE: LanguageInfo;
+    readonly NORWEGIAN: LanguageInfo;
+    readonly OCCITAN: LanguageInfo;
+    readonly PERSIAN: LanguageInfo;
+    readonly POLISH: LanguageInfo;
+    readonly PORTUGUESE: LanguageInfo;
+    readonly PUNJABI: LanguageInfo;
+    readonly WESTERN_PUNJABI: LanguageInfo;
+    readonly ROMANIAN: LanguageInfo;
+    readonly ROMANSH: LanguageInfo;
+    readonly RUSSIAN: LanguageInfo;
+    readonly SERBIAN_CYRILLIC: LanguageInfo;
+    readonly SERBIAN_LATIN: LanguageInfo;
+    readonly SCOTTISH_GAELIC: LanguageInfo;
+    readonly SLOVAK: LanguageInfo;
+    readonly SLOVENE: LanguageInfo;
+    readonly SPANISH: LanguageInfo;
+    readonly SWEDISH: LanguageInfo;
+    readonly TAMIL: LanguageInfo;
+    readonly TELUGU: LanguageInfo;
+    readonly THAI: LanguageInfo;
+    readonly TURKISH: LanguageInfo;
+    readonly UKRAINIAN: LanguageInfo;
+    readonly VIETNAMESE: LanguageInfo;
+    readonly WELSH: LanguageInfo;
+    readonly AUTO: LanguageInfo;
+    readonly LATIN: LanguageInfo;
+    readonly NON_LATIN: LanguageInfo;
+    readonly LOCAL: LanguageInfo;
+    /**
+     * Language mode to display labels in both the local language and the language of the visitor's device, concatenated.
+     * Note that if those two languages are the same, labels won't be duplicated.
+     */
+    readonly VISITOR: LanguageInfo;
+    /**
+     * Language mode to display labels in both the local language and English, concatenated.
+     * Note that if those two languages are the same, labels won't be duplicated.
+     */
+    readonly VISITOR_ENGLISH: LanguageInfo;
+    /**
+     * Language mode to display labels in a language enforced in the style.
+     */
+    readonly STYLE: LanguageInfo;
+    /**
+     * Language mode to display labels in a language enforced in the style. The language cannot be further modified.
+     */
+    readonly STYLE_LOCK: LanguageInfo;
+};
+/**
+ * Get the browser language
+ */
+export declare function getBrowserLanguage(): LanguageInfo;
+export { Language, type LanguageInfo };

package/dist/src/mapstyle.d.ts

@@ -0,0 +1,18 @@
+import { ReferenceMapStyle, MapStyleVariant } from '@maptiler/client';
+export declare function styleToStyle(style: string | ReferenceMapStyle | MapStyleVariant | maplibregl.StyleSpecification | null | undefined): {
+    style: string | maplibregl.StyleSpecification;
+    requiresUrlMonitoring: boolean;
+    isFallback: boolean;
+    isJSON?: boolean;
+};
+/**
+ * makes sure a URL is absolute
+ */
+export declare function urlToAbsoluteUrl(url: string): string;
+type StyleValidationReport = {
+    isValidJSON: boolean;
+    isValidStyle: boolean;
+    styleObject: maplibregl.StyleSpecification | null;
+};
+export declare function convertStringToStyleSpecification(str: string): StyleValidationReport;
+export {};

package/dist/src/tools.d.ts

@@ -0,0 +1,84 @@
+import { default as maplibregl, RequestParameters, ResourceType, RequestTransformFunction } from 'maplibre-gl';
+import { Map as MapSDK } from './Map';
+export declare function enableRTL(customPluginURL?: string): Promise<void>;
+export declare function bindAll(fns: Array<string>, context: any): void;
+/**
+ * This function is meant to be used as transformRequest by any Map instance created.
+ * It adds the session ID as well as the MapTiler Cloud key from the config to all the requests
+ * performed on MapTiler Cloud servers.
+ */
+export declare function maptilerCloudTransformRequest(url: string, resourceType?: ResourceType): RequestParameters;
+/**
+ * This combines a user-defined tranformRequest function (optionnal)
+ * with the MapTiler Cloud-specific one: maptilerCloudTransformRequest
+ */
+export declare function combineTransformRequest(userDefinedRTF?: RequestTransformFunction | null): RequestTransformFunction;
+/**
+ * Generate a random string. Handy to create random IDs
+ */
+export declare function generateRandomString(): string;
+/**
+ * Check if a given string is in a uuid format
+ */
+export declare function isUUID(s: string): boolean;
+/**
+ * Attempt a JSON parse of a string but does not throw if the string is not valid JSON, returns `null` instead.
+ */
+export declare function jsonParseNoThrow<T>(doc: string): T | null;
+/**
+ * Simple function to check if an object is a GeoJSON
+ */
+export declare function isValidGeoJSON<T>(obj: T & {
+    type: string;
+}): boolean;
+/**
+ * This function tests if WebGL2 is supported. Since it can be for a different reasons that WebGL2 is
+ * not supported but we do not have an action to take based on the reason, this function return null
+ * if there is no error (WebGL is supported), or returns a string with the error message if WebGL2 is
+ * not supported.
+ */
+export declare function getWebGLSupportError(): string | null;
+/**
+ * Display an error message in the Map div if WebGL2 is not supported
+ */
+export declare function displayNoWebGlWarning(container: HTMLElement | string): void;
+/**
+ * Display a warning message in the Map div if the WebGL context was lost
+ */
+export declare function displayWebGLContextLostWarning(map: MapSDK): void;
+/**
+ * In a text-field style property (as an object, not a string) the languages that are specified as
+ * ["get", "name:XX"] are replaced by the proved replacer (also an object).
+ * This replacement happened regardless of how deep in the object the flag is.
+ * Note that it does not replace the occurences of ["get", "name"] (local names)
+ */
+export declare function changeFirstLanguage(origExpr: maplibregl.ExpressionSpecification, replacer: maplibregl.ExpressionSpecification, localized: boolean): maplibregl.ExpressionSpecification;
+/**
+ * If `localized` is `true`, it checks for the pattern "{name:xx}" (with "xx" being a language iso string).
+ * If `localized` is `false`, it check for {name}.
+ * In a exact way or is a loose way (such as "foo {name:xx}" or "foo {name} bar")
+ */
+export declare function checkNamePattern(str: string, localized: boolean): {
+    contains: boolean;
+    exactMatch: boolean;
+};
+/**
+ * Replaces the occurences of {name:xx} in a string by a provided object-expression to return a concat object expression
+ */
+export declare function replaceLanguage(origLang: string, newLang: maplibregl.ExpressionSpecification, localized: boolean): maplibregl.ExpressionSpecification;
+/**
+ * Find languages used in string label definition.
+ * The returned array contains languages such as "en", "fr" but
+ * can also contain null that stand for the use of {name}
+ */
+export declare function findLanguageStr(str: string): Array<string | null>;
+/**
+ * Find languages used in object label definition.
+ * The returned array contains languages such as "en", "fr" but
+ * can also contain null that stand for the use of {name}
+ */
+export declare function findLanguageObj(origExpr: maplibregl.ExpressionSpecification): Array<string | null>;
+export declare function computeLabelsLocalizationMetrics(layers: maplibregl.LayerSpecification[], map: MapSDK): {
+    unlocalized: number;
+    localized: Record<string, number>;
+};

package/dist/src/types.d.ts

@@ -0,0 +1 @@
+export type Unit = "imperial" | "metric" | "nautical";

package/dist/src/utils/dom.d.ts

@@ -0,0 +1,2 @@
+export declare function DOMcreate<K extends keyof HTMLElementTagNameMap>(tagName: K, className?: string, container?: HTMLElement): HTMLElementTagNameMap[K];
+export declare function DOMremove(node: HTMLElement): void;

package/dist/src/utils/errors.d.ts

@@ -0,0 +1,5 @@
+export declare class FetchError extends Error {
+    status: number;
+    statusText: string;
+    constructor(response: Response, resource: string, module: string);
+}

package/dist/src/utils/geo-utils.d.ts

@@ -0,0 +1,6 @@
+import { LngLat } from 'maplibre-gl';
+declare function getAntipode(lngLat: LngLat): {
+    lat: number;
+    lng: number;
+};
+export { getAntipode };

package/dist/src/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './dom';

package/dist/src/utils/math-utils.d.ts

@@ -0,0 +1,8 @@
+import { Vec4 } from './webgl-utils';
+declare function minMax(value: number, min: number, max: number): number;
+declare function normalize(value: number, min: number, max: number): number;
+declare function diagonalOfSquare(side: number): number;
+type Lerpable = [number, number, number, number] | Vec4;
+declare function lerpVec4(a: Lerpable, b: Lerpable, t: number): Vec4;
+declare function lerp(a: number, b: number, t: number): number;
+export { minMax, normalize, diagonalOfSquare, lerpVec4, lerp };

package/dist/src/utils/object.d.ts

@@ -0,0 +1 @@
+export declare function orderObjectKeys<T extends Record<string, unknown>>(obj?: T): T;

package/dist/src/utils/webgl-utils.d.ts

@@ -0,0 +1,49 @@
+export type WebGLContext = WebGLRenderingContext | WebGL2RenderingContext;
+/**
+ * Load a shader from a source string
+ */
+export declare function loadShader({ gl, type, source }: {
+    gl: WebGLContext;
+    type: GLenum;
+    source: string;
+}): WebGLShader;
+/**
+ * Create a set of shaders (vertex and fragment) and link them into a program
+ *
+ * @param gl WebGL context
+ * @param vertexShaderSource Vertex shader source code
+ * @param fragmentShaderSource Fragment shader source code
+ *
+ * @returns WebGL program
+ */
+export declare function createShaderProgram({ gl, vertexShaderSource, fragmentShaderSource }: {
+    gl: WebGLContext;
+    vertexShaderSource: string;
+    fragmentShaderSource: string;
+}): WebGLProgram;
+/**
+ * null-free version of getUniformLocation
+ */
+export declare function getUniformLocation(gl: WebGLRenderingContext | WebGL2RenderingContext, program: WebGLProgram, name: string): WebGLUniformLocation;
+export type Object3D<Attribute extends string, Uniform extends string> = {
+    shaderProgram: WebGLProgram;
+    programInfo: {
+        attributesLocations: Record<Attribute, number>;
+        uniformsLocations: Record<Uniform, WebGLUniformLocation>;
+    };
+    positionBuffer: WebGLBuffer;
+    indexBuffer?: WebGLBuffer;
+    indexBufferLength?: number;
+};
+export declare function createObject3D<Attribute extends string, Uniform extends string>({ gl, vertexShaderSource, fragmentShaderSource, attributesKeys, uniformsKeys, vertices, indices, }: {
+    gl: WebGLContext;
+    vertexShaderSource: string;
+    fragmentShaderSource: string;
+    attributesKeys: readonly Attribute[];
+    uniformsKeys: readonly Uniform[];
+    vertices: Array<number>;
+    indices?: Array<number>;
+}): Object3D<Attribute, Uniform>;
+export type Vec4 = [number, number, number, number];
+export declare function parseColorStringToVec4(color?: string): Vec4;
+export declare function degreesToRadians(degrees: number): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "3.9.0-rc.4",
+  "version": "3.9.0-rc.5",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "author": "MapTiler",
   "module": "dist/maptiler-sdk.mjs",
@@ -86,7 +86,7 @@
     "vitest": "^3.0.9"
   },
   "dependencies": {
-    "@maplibre/maplibre-gl-style-spec": "~24.2.0",
+    "@maplibre/maplibre-gl-style-spec": "~23.3.0",
     "@maptiler/client": "2.6.0-rc.3",
     "events": "^3.3.0",
     "gl-matrix": "^3.4.3",