@maptiler/sdk 4.2.0 → 5.0.0-beta.m-r.1

package/dist/routing.d.ts

@@ -0,0 +1,18 @@
+import * as client from "@maptiler/client";
+export type ExtraRoutingOptions = {
+    /**
+     * Specifies whether the routing request runs with a session logic.
+     * A "session" is started at the initialization of the SDK and finished when the browser
+     * page is being closed or refreshed.
+     * When this option is enabled, extra URL param `mtsid` is added to queries
+     * to the MapTiler Cloud API. This allows MapTiler to enable "session based billing".
+     *
+     * Default: value of this option in global config (which is `true` by default).
+     */
+    session?: boolean;
+};
+export type RoutingOptions = client.RoutingOptions & ExtraRoutingOptions;
+export declare const routing: {
+    directionsPost: (body: client.RoutingRequest, options?: RoutingOptions) => Promise<client.RoutingResponse>;
+    directionsGet: (req: client.RoutingGetRequest, options?: RoutingOptions) => Promise<client.RoutingResponse>;
+};

package/dist/tools.d.ts

@@ -1,6 +1,5 @@
-import { default as maplibregl, RequestParameters, ResourceType, RequestTransformFunction } from 'maplibre-gl';
+import { ExpressionSpecification, LayerSpecification, 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.
@@ -52,7 +51,7 @@ export declare function displayWebGLContextLostWarning(map: MapSDK): void;
  * 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;
+export declare function changeFirstLanguage(origExpr: ExpressionSpecification, replacer: ExpressionSpecification, localized: boolean): 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}.
@@ -65,8 +64,8 @@ export declare function checkNamePattern(str: string, localized: 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;
-export declare function addFormatElevationExpressionFromString(expression: maplibregl.ExpressionSpecification | string): maplibregl.ExpressionSpecification | string;
+export declare function replaceLanguage(origLang: string, newLang: ExpressionSpecification, localized: boolean): ExpressionSpecification;
+export declare function addFormatElevationExpressionFromString(expression: ExpressionSpecification | string): ExpressionSpecification | string;
 /**
  * Find languages used in string label definition.
  * The returned array contains languages such as "en", "fr" but
@@ -78,8 +77,8 @@ export declare function findLanguageStr(str: string): Array<string | null>;
  * 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): {
+export declare function findLanguageObj(origExpr: ExpressionSpecification): Array<string | null>;
+export declare function computeLabelsLocalizationMetrics(layers: LayerSpecification[], map: MapSDK): {
     unlocalized: number;
     localized: Record<string, number>;
 };

package/dist/utils/defaultWorkerUrl.d.ts

@@ -0,0 +1,17 @@
+/**
+ * URL of the MapLibre worker published on the MapTiler CDN alongside the UMD bundle of this SDK version.
+ */
+export declare function getCdnWorkerUrl(): string;
+/**
+ * Since MapLibre v6, the worker is loaded from a separate file that bundlers generally don't emit,
+ * so in the ES build (npm) the SDK falls back to the worker hosted on the MapTiler CDN.
+ * A URL set beforehand, with `setWorkerUrl` or one of the bundler helpers
+ * (e.g. `@maptiler/sdk/vite-worker`), always takes precedence.
+ * The UMD build keeps MapLibre's default, which finds the worker next to the UMD bundle.
+ */
+export declare function setDefaultWorkerUrl(): void;
+/**
+ * Same as MapLibre's `prewarm`, but sets the default worker URL first,
+ * as the workers it starts are the ones later used by the maps.
+ */
+export declare function prewarm(): void;

package/dist/utils/object.d.ts

@@ -1 +1,2 @@
 export declare function orderObjectKeys<T extends Record<string, unknown>>(obj?: T): T;
+export declare function omit<T extends object, K extends keyof T>(obj: T, keys: readonly K[]): Omit<T, K>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maptiler/sdk",
-  "version": "4.2.0",
+  "version": "5.0.0-beta.m-r.1",
   "description": "The Javascript & TypeScript map SDK tailored for MapTiler Cloud",
   "author": "MapTiler",
   "module": "dist/maptiler-sdk.mjs",
@@ -13,6 +13,23 @@
       "import": "./dist/maptiler-sdk.mjs",
       "types": "./dist/maptiler-sdk.d.ts"
     },
+    "./vite-worker": {
+      "types": "./dist/bundler/side-effect.d.ts",
+      "import": "./dist/bundler/vite-worker.mjs"
+    },
+    "./webpack-worker": {
+      "types": "./dist/bundler/side-effect.d.ts",
+      "import": "./dist/bundler/webpack-worker.mjs"
+    },
+    "./next-worker": {
+      "types": "./dist/bundler/side-effect.d.ts",
+      "import": "./dist/bundler/next-worker.mjs"
+    },
+    "./next": {
+      "types": "./dist/bundler/next.d.ts",
+      "import": "./dist/bundler/next.mjs",
+      "require": "./dist/bundler/next.cjs"
+    },
     "./dist/maptiler-sdk.css": {
       "import": "./dist/maptiler-sdk.css"
     },
@@ -44,6 +61,7 @@
   },
   "scripts": {
     "prepare": "husky",
+    "prepack": "npm run build",
     "doc": "rm -rf docs/* && typedoc --out docs && cp -r images docs/",
     "ncu": "npx npm-check-updates",
     "lint": "tsc --noEmit && eslint src",
@@ -80,7 +98,7 @@
     "@types/stats.js": "^0.17.4",
     "@types/uuid": "^10.0.0",
     "@types/xmldom": "^0.1.31",
-    "@vitest/web-worker": "^3.0.9",
+    "@vitest/web-worker": "^5.0.4",
     "@xmldom/xmldom": "^0.8.10",
     "concurrently": "^9.1.2",
     "eslint": "^9.21.0",
@@ -89,24 +107,24 @@
     "happy-dom": "^20.8.9",
     "husky": "^8.0.0",
     "jiti": "^2.4.2",
-    "lint-staged": "^15.4.3",
+    "lint-staged": "^17.6.0",
     "prettier": "3.5.2",
     "stats.js": "^0.17.0",
     "typedoc": "^0.27.6",
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.25.0",
     "vite": "^6.0.7",
-    "vite-plugin-dts": "^4.5.0",
-    "vitest": "^3.0.9"
+    "vite-plugin-dts": "^5.1.2",
+    "vitest": "^5.0.4"
   },
   "dependencies": {
-    "@maplibre/maplibre-gl-style-spec": "^24.7.0",
-    "@maptiler/client": "^3.1.0",
+    "@maplibre/maplibre-gl-style-spec": "^26.4.4",
+    "@maptiler/client": "3.2.0-rc.1",
     "eslint-plugin-compat": "^6.1.0",
     "events": "^3.3.0",
     "gl-matrix": "^3.4.4",
     "js-base64": "^3.7.7",
-    "maplibre-gl": "5.24",
+    "maplibre-gl": "6.11.2",
     "uuid": "^14.0.0"
   }
 }

package/dist/MLAdapters/AttributionControl.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class AttributionControl extends maplibregl.AttributionControl {
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-}

package/dist/MLAdapters/BoxZoomHandler.d.ts

@@ -1,7 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class BoxZoomHandler extends maplibregl.BoxZoomHandler {
-    constructor(map: SDKMap | MapMLGL, options: {
-        clickTolerance: number;
-    });
-}

package/dist/MLAdapters/CanvasSource.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class CanvasSource extends maplibregl.CanvasSource {
-    onAdd(map: SDKMap | MapMLGL): void;
-}

package/dist/MLAdapters/CooperativeGesturesHandler.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, GestureOptions, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class CooperativeGesturesHandler extends maplibregl.CooperativeGesturesHandler {
-    constructor(map: SDKMap | MapMLGL, options: GestureOptions);
-}

package/dist/MLAdapters/FullscreenControl.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class FullscreenControl extends maplibregl.FullscreenControl {
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-}

package/dist/MLAdapters/GeoJSONSource.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class GeoJSONSource extends maplibregl.GeoJSONSource {
-    onAdd(map: SDKMap | MapMLGL): void;
-}

package/dist/MLAdapters/GeolocateControl.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class GeolocateControl extends maplibregl.GeolocateControl {
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-}

package/dist/MLAdapters/ImageSource.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class ImageSource extends maplibregl.ImageSource {
-    onAdd(map: SDKMap | MapMLGL): void;
-}

package/dist/MLAdapters/KeyboardHandler.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class KeyboardHandler extends maplibregl.KeyboardHandler {
-    constructor(map: SDKMap | MapMLGL);
-}

package/dist/MLAdapters/LogoControl.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class LogoControl extends maplibregl.LogoControl {
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-}

package/dist/MLAdapters/MapMouseEvent.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class MapMouseEvent extends maplibregl.MapMouseEvent {
-    constructor(type: string, map: SDKMap | MapMLGL, originalEvent: MouseEvent, data?: Record<string, unknown>);
-}

package/dist/MLAdapters/MapTouchEvent.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class MapTouchEvent extends maplibregl.MapTouchEvent {
-    constructor(type: string, map: SDKMap | MapMLGL, originalEvent: TouchEvent);
-}

package/dist/MLAdapters/MapWheelEvent.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class MapWheelEvent extends maplibregl.MapWheelEvent {
-    constructor(type: string, map: SDKMap | MapMLGL, originalEvent: WheelEvent);
-}

package/dist/MLAdapters/Marker.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class Marker extends maplibregl.Marker {
-    addTo(map: SDKMap | MapMLGL): this;
-}

package/dist/MLAdapters/NavigationControl.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class NavigationControl extends maplibregl.NavigationControl {
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-}

package/dist/MLAdapters/Popup.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class Popup extends maplibregl.Popup {
-    addTo(map: SDKMap | MapMLGL): this;
-}

package/dist/MLAdapters/RasterDEMTileSource.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class RasterDEMTileSource extends maplibregl.RasterDEMTileSource {
-    onAdd(map: SDKMap | MapMLGL): void;
-}

package/dist/MLAdapters/RasterTileSource.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class RasterTileSource extends maplibregl.RasterTileSource {
-    onAdd(map: SDKMap | MapMLGL): void;
-}

package/dist/MLAdapters/ScaleControl.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class ScaleControl extends maplibregl.ScaleControl {
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-}

package/dist/MLAdapters/ScrollZoomHandler.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class ScrollZoomHandler extends maplibregl.ScrollZoomHandler {
-    constructor(map: SDKMap | MapMLGL, triggerRenderFrame: () => void);
-}

package/dist/MLAdapters/Style.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, StyleOptions } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class Style extends maplibregl.Style {
-    constructor(map: SDKMap, options?: StyleOptions);
-}

package/dist/MLAdapters/TerrainControl.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class TerrainControl extends maplibregl.TerrainControl {
-    onAdd(map: SDKMap | MapMLGL): HTMLElement;
-}

package/dist/MLAdapters/TwoFingersTouchPitchHandler.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class TwoFingersTouchPitchHandler extends maplibregl.TwoFingersTouchPitchHandler {
-    constructor(map: SDKMap | MapMLGL);
-}

package/dist/MLAdapters/VectorTileSource.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class VectorTileSource extends maplibregl.VectorTileSource {
-    onAdd(map: SDKMap | MapMLGL): void;
-}

package/dist/MLAdapters/VideoSource.d.ts

@@ -1,5 +0,0 @@
-import { default as maplibregl, Map as MapMLGL } from 'maplibre-gl';
-import { Map as SDKMap } from '../Map';
-export declare class VideoSource extends maplibregl.VideoSource {
-    onAdd(map: SDKMap | MapMLGL): void;
-}