@maptiler/sdk 5.0.0-rc.3 → 5.0.0-rc.4

package/dist/ImageViewer/ImageViewer.d.ts

@@ -1,5 +1,6 @@
 import { EaseToOptions, DoubleClickZoomHandler, DragPanHandler, TwoFingersTouchZoomRotateHandler, FlyToOptions, MapOptions, JumpToOptions, ScrollZoomHandler, BoxZoomHandler, KeyboardHandler, CooperativeGesturesHandler, LngLat, PointLike } from '..';
 import { Map } from '../Map';
+import { ImageViewerEventType } from './events';
 import { Evented } from 'maplibre-gl';
 import { ImageViewerFitImageToBoundsControl } from '../controls/ImageViewerFitImageToBoundsControl';
 import { lngLatToPxInternalSymbolKey, pxToLngLatInternalSymbolKey } from './symbols';
@@ -49,7 +50,7 @@ export type ImageMetadata = {
     maxzoom: number;
     tileSize: number;
 };
-export default class ImageViewer extends Evented {
+export default class ImageViewer extends Evented<ImageViewerEventType> {
     /**
      * The UUID of the image.
      *

package/dist/ImageViewer/events.d.ts

@@ -1,16 +1,24 @@
 import { Map } from '../Map';
 import { default as ImageViewer } from './ImageViewer';
-import { LngLat } from 'maplibre-gl';
-export declare class ImageViewerEvent {
-    readonly type: string;
-    readonly target: ImageViewer;
-    readonly originalEvent: MouseEvent | TouchEvent | WheelEvent | WebGLContextEvent | null;
+import { Event as EventML, LngLat } from 'maplibre-gl';
+type ImageViewerOriginalEvent = MouseEvent | TouchEvent | WheelEvent | WebGLContextEvent | null;
+export declare class ImageViewerEvent extends EventML<ImageViewerEventTypes> {
+    target: ImageViewer;
+    originalEvent: ImageViewerOriginalEvent;
     [key: string]: any;
     imageX: number;
     imageY: number;
     isOutOfBounds: boolean;
-    constructor(type: string, viewer: ImageViewer, originalEvent?: MouseEvent | TouchEvent | WheelEvent | WebGLContextEvent | null, data?: Record<string, any>);
+    constructor(type: ImageViewerEventTypes, viewer: ImageViewer, originalEvent?: ImageViewerOriginalEvent, data?: Record<string, any>);
 }
+/** Fired when the viewer fails to load its image. */
+export type ImageViewerInitErrorEvent = EventML<"imagevieweriniterror"> & {
+    error: Error;
+};
+/** Event payloads keyed by event type — every event is an {@link ImageViewerEvent}, apart from the init error. */
+export type ImageViewerEventType = Record<Exclude<ImageViewerEventTypes, "imagevieweriniterror">, ImageViewerEvent> & {
+    imagevieweriniterror: ImageViewerInitErrorEvent;
+};
 declare const BASE_MAP_EVENT_TYPES: readonly ["idle", "render", "load", "remove", "idle"];
 declare const ERROR_EVENTS: readonly ["error"];
 declare const RESIZE_EVENTS: readonly ["resize"];

package/dist/ImageViewer/index.d.ts

@@ -1,5 +1,5 @@
 export { default as ImageViewer } from './ImageViewer';
 export { ImageViewerMarker, ImageViewerMarkerEvent, type ImageViewerMarkerOptions } from './ImageViewerMarker';
-export type { ImageViewerEventTypes } from './events';
+export type { ImageViewerEventTypes, ImageViewerEventType, ImageViewerInitErrorEvent } from './events';
 export type { ImageViewerConstructorOptions, ImageViewerFlyToOptions, ImageViewerJumpToOptions, ImageMetadata } from './ImageViewer';
 export { ImageViewerEvent } from './events';

package/dist/Map.d.ts

@@ -56,6 +56,25 @@ export type MaptilerMapEventType = {
  * so the SDK `Map` overrides them to accept its own events as well.
  */
 export type MapEventTypeSDK = MapEventType & MaptilerMapEventType;
+/**
+ * An event as an SDK `Map` listener receives it. MapLibre types its events' target as its
+ * own `Map`, which lacks the SDK members, but the target is always the SDK `Map` that fired it.
+ *
+ * The target is intersected in, rather than remapped over every event, so the SDK `Map`'s
+ * `on`/`once`/`off` stay assignable to MapLibre's — the SDK `Map` is passed to MapLibre controls and layers.
+ * @example
+ * ```ts
+ * const onClick = (e: MapEventSDK<"click">) => console.log(e.lngLat, e.target.getSpace());
+ * map.on("click", onClick);
+ * ```
+ */
+export type MapEventSDK<T extends keyof MapEventTypeSDK> = MapEventTypeSDK[T] & object & {
+    target: Map;
+};
+/** A layer event as an SDK `Map` listener receives it — see {@link MapEventSDK}. */
+export type MapLayerEventSDK<T extends keyof MapLayerEventType> = MapLayerEventType[T] & object & {
+    target: Map;
+};
 export declare const GeolocationType: {
     POINT: "POINT";
     COUNTRY: "COUNTRY";
@@ -268,24 +287,24 @@ export declare class Map extends MapMLGL {
      * Adds a listener for events of a specified type, optionally limited to features in one or more layers.
      * Accepts the MapLibre events as well as the SDK events (see {@link MaptilerMapEventType}).
      */
-    on<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[], listener: (ev: MapLayerEventType[T] & object) => void): Subscription;
-    on<T extends keyof MapEventTypeSDK>(type: T, listener: (ev: MapEventTypeSDK[T] & object) => void): Subscription;
+    on<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[], listener: (ev: MapLayerEventSDK<T>) => void): Subscription;
+    on<T extends keyof MapEventTypeSDK>(type: T, listener: (ev: MapEventSDK<T>) => void): Subscription;
     on(type: keyof MapEventTypeSDK, listener: Listener): Subscription;
     /**
      * Adds a listener that will be called only once to a specified event type, optionally limited to features in one or more layers.
      * Accepts the MapLibre events as well as the SDK events (see {@link MaptilerMapEventType}).
      */
-    once<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[], listener: (ev: MapLayerEventType[T] & object) => void): this;
-    once<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[]): Promise<MapLayerEventType[T] & object>;
-    once<T extends keyof MapEventTypeSDK>(type: T, listener: (ev: MapEventTypeSDK[T] & object) => void): this;
-    once<T extends keyof MapEventTypeSDK>(type: T): Promise<MapEventTypeSDK[T] & object>;
+    once<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[], listener: (ev: MapLayerEventSDK<T>) => void): this;
+    once<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[]): Promise<MapLayerEventSDK<T>>;
+    once<T extends keyof MapEventTypeSDK>(type: T, listener: (ev: MapEventSDK<T>) => void): this;
+    once<T extends keyof MapEventTypeSDK>(type: T): Promise<MapEventSDK<T>>;
     once(type: keyof MapEventTypeSDK, listener?: Listener): this | Promise<any>;
     /**
      * Removes an event listener previously added with {@link Map.on} or {@link Map.once}.
      * Accepts the MapLibre events as well as the SDK events (see {@link MaptilerMapEventType}).
      */
-    off<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[], listener: (ev: MapLayerEventType[T] & object) => void): this;
-    off<T extends keyof MapEventTypeSDK>(type: T, listener: (ev: MapEventTypeSDK[T] & object) => void): this;
+    off<T extends keyof MapLayerEventType>(type: T, layerIds: string | string[], listener: (ev: MapLayerEventSDK<T>) => void): this;
+    off<T extends keyof MapEventTypeSDK>(type: T, listener: (ev: MapEventSDK<T>) => void): this;
     off(type: keyof MapEventTypeSDK, listener: Listener): this;
     /**
      * Fires an event. Accepts the MapLibre events as well as the SDK events (see {@link MaptilerMapEventType}).

package/dist/index.d.ts

@@ -10,7 +10,7 @@ export { getVersion as getMapLibreVersion, Map as MapMLGL, Marker as MarkerMLGL,
 export * from './Marker';
 export { Marker } from './Marker';
 export { Popup, Style, CanvasSource, GeoJSONSource, ImageSource, RasterTileSource, RasterDEMTileSource, VectorTileSource, VideoSource, NavigationControl, GeolocateControl, AttributionControl, LogoControl, ScaleControl, FullscreenControl, TerrainControl, BoxZoomHandler, ScrollZoomHandler, CooperativeGesturesHandler, KeyboardHandler, TwoFingersTouchPitchHandler, MapWheelEvent, MapTouchEvent, MapMouseEvent, } from 'maplibre-gl';
-export { Map, GeolocationType, type AttributionControlOptions, type MapOptions, type LoadWithTerrainEvent, type MaptilerMapEventType, type MapEventTypeSDK } from './Map';
+export { Map, GeolocationType, type AttributionControlOptions, type MapOptions, type LoadWithTerrainEvent, type MaptilerMapEventType, type MapEventTypeSDK, type MapEventSDK, type MapLayerEventSDK, } from './Map';
 export type { CameraPosition, TilePreloadOptions, WithTilePreload, PreloadTilesForBoundsOptions, PreloadTilesForCameraPositionsOptions, PreloadTilesOptions, TilePreloadErrorCallback, TilePreloadProgressCallback, } from './tile-preloading';
 export { type BaseGeocodingOptions, type ByIdGeocodingOptions, type CommonForwardAndReverseGeocodingOptions, type GeocodingOptions, type LanguageGeocodingOptions, type ReverseGeocodingOptions, geocoding, } from './geocoding';
 export * from './controls';