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

package/dist/src/ImageViewer/ImageViewer.d.ts

@@ -0,0 +1,408 @@
+import { default as MaplibreGL } from 'maplibre-gl';
+import { EaseToOptions, DoubleClickZoomHandler, DragPanHandler, TwoFingersTouchZoomRotateHandler, FlyToOptions, MapOptions, JumpToOptions, ScrollZoomHandler, BoxZoomHandler, KeyboardHandler, CooperativeGesturesHandler, LngLat, MapDataEvent, PointLike } from '..';
+import { Map } from '../Map';
+import { ImageViewerFitImageToBoundsControl } from '../controls/ImageViewerFitImageToBoundsControl';
+import { lngLatToPxInternalSymbolKey, pxToLngLatInternalSymbolKey } from './symbols';
+declare const Evented: typeof MaplibreGL.Evented;
+export type AllowedConstrcutorOptions = "container" | "apiKey" | "maxZoom" | "minZoom" | "zoom" | "bearing";
+export type ImageViewerFlyToOptions = Omit<FlyToOptions, "pitch"> & {
+    center: [number, number];
+};
+export type ImageViewerJumpToOptions = Omit<JumpToOptions, "pitch"> & {
+    center: [number, number];
+};
+export type ImageViewerEaseToOptions = Omit<EaseToOptions, "pitch"> & {
+    center: [number, number];
+};
+export type ImageViewerConstructorOptions = Pick<MapOptions, AllowedConstrcutorOptions> & {
+    /**
+     * The UUID of the image.
+     */
+    imageUUID: string;
+    /**
+     * Whether to show debug information.
+     */
+    debug?: boolean;
+    /**
+     * The center of the image.
+     */
+    center?: [number, number];
+    /**
+     * Whether to show a control to fit the image to the viewport.
+     */
+    fitToBoundsControl?: boolean;
+    /**
+     * Whether to show a navigation control.
+     */
+    navigationControl?: boolean;
+};
+/**
+ * The metadata of the image. This is the shape of the response from the API.
+ * And used to convert px to lnglat and vice versa.
+ */
+export type ImageMetadata = {
+    id: string;
+    description: string;
+    attribution: string;
+    width: number;
+    height: number;
+    minzoom: number;
+    maxzoom: number;
+    tileSize: number;
+};
+export default class ImageViewer extends Evented {
+    /**
+     * The UUID of the image.
+     *
+     * @internal
+     */
+    private imageUUID;
+    /**
+     * Whether to enable debug mode.
+     *
+     * @internal
+     */
+    private debug;
+    /**
+     * The metadata of the image.
+     *
+     */
+    private imageMetadata?;
+    /**
+     * Why not extend the Map class?
+     * Because ImageViewer technically operates in screen space and not in map space.
+     * We wrap map and perform calculations in screen space.
+     * We do not want to have to extend the Map class and give access to
+     * methods and properties that operate in LngLat space.   *
+     */
+    private sdk;
+    /**
+     * The options for the ImageViewer.
+     *
+     * @internal
+     */
+    private options;
+    /**
+     * The size of the image.
+     *
+     * @internal
+     */
+    private imageSize?;
+    /**
+     * The padded size max.
+     *
+     * @internal
+     */
+    private paddedSizeMax?;
+    /**
+     * The version of the ImageViewer / SDK.
+     */
+    get version(): string;
+    /**
+     * The control to fit the image to the viewport.
+     */
+    fitToBoundsControlInstance: ImageViewerFitImageToBoundsControl;
+    /**
+     * The constructor for the ImageViewer.
+     *
+     * @param {Partial<ImageViewerConstructorOptions>} imageViewerConstructorOptions - The options for the ImageViewer.
+     * @example
+     * ```ts
+     * import "@maptiler/sdk/dist/maptiler-sdk.css"; // import css
+     * import { ImageViewer } from "@maptiler/sdk"; // import the sdk
+     *
+     * const imageViewer = new ImageViewer({
+     *   container: document.getElementById("map"),
+     *   imageUUID: "01986025-ceb9-7487-9ea6-7a8637dcc1a1",
+     *   debug: true, // show tile boundaries, padding, collision boxes etc
+     *   fitToBoundsControl: true, // show a control to fit the image to the viewport
+     *   navigationControl: true, // show a navigation control
+     *   center: [0, 0], // center in pixels
+     *   zoom: 1, // zoom level
+     *   bearing: 0, // bearing
+     * });
+     * ```
+     */
+    constructor(imageViewerConstructorOptions: Partial<ImageViewerConstructorOptions>);
+    /**
+     * Waits for the ImageViewer to be ready.
+     *
+     * @returns {Promise<void>}
+     */
+    onReadyAsync(): Promise<void>;
+    shouldFitImageToViewport: boolean;
+    /**
+     * Initializes the ImageViewer
+     *  - fetches the image metadata
+     *  - adds the image source to the sdk instance
+     *  - sets the center to the middle of the image (if center is not provided)
+     *  - monkeypatches the maplibre-gl sdk transform method to allow for overpanning and underzooming.
+     *  - sets up global event forwarding / intercepting from the map instance
+     *  - sets the center to the middle of the image (if center is not provided)
+     *
+     * @internal
+     * @returns {Promise<void>}
+     */
+    private init;
+    /**
+     * Fits the image to the viewport.
+     *
+     * @param {Object} options - The options for the fit image to viewport.
+     * @param {boolean} options.ease - Whether to ease to the viewport bounds.
+     */
+    fitImageToViewport({ ease }?: {
+        ease?: boolean;
+    }): void;
+    /**
+     * Fetches the image metadata from the API.
+     *
+     * @internal
+     * @returns {Promise<void>}
+     */
+    private fetchImageMetadata;
+    /**
+     * Adds the image source to the sdk instance.
+     *
+     * @internal
+     * @returns {void}
+     */
+    private addImageSource;
+    /**
+     * Triggers a repaint of the ImageViewer. Same as map.triggerRepaint().
+     *
+     * @internal
+     * @returns {void}
+     */
+    triggerRepaint(): void;
+    /**
+     * The scroll zoom handler.
+     *
+     * @internal
+     * @returns {ScrollZoomHandler}
+     */
+    get scrollZoom(): ScrollZoomHandler;
+    /**
+     * The scroll zoom handler.
+     *
+     * @internal
+     * @param {ScrollZoomHandler} value - The scroll zoom handler.
+     */
+    set scrollZoom(value: ScrollZoomHandler);
+    /**
+     * The box zoom handler.
+     *
+     * @internal
+     * @returns {BoxZoomHandler}
+     */
+    get boxZoom(): BoxZoomHandler;
+    /**
+     * The box zoom handler.
+     *
+     * @internal
+     * @param {BoxZoomHandler} value - The box zoom handler.
+     */
+    set boxZoom(value: BoxZoomHandler);
+    /**
+     * The drag pan handler.
+     *
+     * @internal
+     * @returns {DragPanHandler}
+     */
+    get dragPan(): DragPanHandler;
+    /**
+     * The drag pan handler.
+     *
+     * @internal
+     * @param {DragPanHandler} value - The drag pan handler.
+     */
+    set dragPan(value: DragPanHandler);
+    /**
+     * The keyboard handler.
+     *
+     * @internal
+     * @returns {KeyboardHandler}
+     */
+    get keyboard(): KeyboardHandler;
+    /**
+     * The keyboard handler.
+     *
+     * @internal
+     * @param {KeyboardHandler} value - The keyboard handler.
+     */
+    set keyboard(value: KeyboardHandler);
+    /**
+     * The double click zoom handler.
+     *
+     * @internal
+     * @returns {DoubleClickZoomHandler}
+     */
+    get doubleClickZoom(): DoubleClickZoomHandler;
+    /**
+     * The double click zoom handler.
+     *
+     * @internal
+     * @param {DoubleClickZoomHandler} value - The double click zoom handler.
+     */
+    set doubleClickZoom(value: DoubleClickZoomHandler);
+    /**
+     * The touch zoom rotate handler.
+     *
+     * @internal
+     * @returns {TwoFingersTouchZoomRotateHandler}
+     */
+    get touchZoomRotate(): TwoFingersTouchZoomRotateHandler;
+    /**
+     * The touch zoom rotate handler.
+     *
+     * @internal
+     * @param {TwoFingersTouchZoomRotateHandler} value - The touch zoom rotate handler.
+     */
+    set touchZoomRotate(value: TwoFingersTouchZoomRotateHandler);
+    /**
+     * The cooperative gestures handler.
+     *
+     * @internal
+     * @returns {CooperativeGesturesHandler}
+     */
+    get cooperativeGestures(): CooperativeGesturesHandler;
+    /**
+     * The cooperative gestures handler.
+     *
+     * @internal
+     * @param {CooperativeGesturesHandler} value - The cooperative gestures handler.
+     */
+    set cooperativeGestures(value: CooperativeGesturesHandler);
+    /**
+     * Converts a LngLat to a px coordinate, based on the image metadata.
+     *
+     * @internal
+     * @param {LngLat} lngLat - The LngLat to convert.
+     * @returns {[number, number]} The px coordinate.
+     */
+    private lngLatToPx;
+    /**
+     * Converts a px coordinate to a LngLat, based on the image metadata.
+     *
+     * @internal
+     * @param {LngLat} lngLat - The LngLat to convert.
+     * @returns {[number, number]} The px coordinate.
+     */
+    private pxToLngLat;
+    /**
+     * Get the internal SDK instance.
+     *
+     * @returns {Map} The internal SDK instance.
+     * @internal
+     */
+    getSDKInternal(): Map;
+    /**
+     * Get the canvas of the internal SDK instance.
+     *
+     * @returns {HTMLCanvasElement} The canvas of the internal SDK instance.
+     */
+    getCanvas(): HTMLCanvasElement;
+    /**
+     * Fly to a given center.
+     *
+     * @param {ImageViewerFlyToOptions} options - The options for the fly to.
+     * @param {MapDataEvent} eventData - The event data.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    flyTo(options: ImageViewerFlyToOptions, eventData?: MapDataEvent): this;
+    /**
+     * Jump to a given center.
+     *
+     * @param {ImageViewerJumpToOptions} options - The options for the jump to.
+     * @param {MapDataEvent} eventData - The event data.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    jumpTo(options: ImageViewerJumpToOptions, eventData?: MapDataEvent): this;
+    /**
+     * Set the zoom level.
+     *
+     * @param {number} zoom - The zoom level.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    setZoom(zoom: number): this;
+    /**
+     * Get the zoom level.
+     *
+     * @returns {number} The zoom level.
+     */
+    getZoom(): number;
+    /**
+     * Get the center of the ImageViewer in pixels.
+     *
+     * @internal
+     * @returns {[number, number]} The center of the ImageViewer.
+     */
+    getCenter(): [number, number];
+    /**
+     * Set the center of the ImageViewer in pixels.
+     *
+     * @param {number} center - The center of the ImageViewer.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    setCenter(center: [number, number]): this;
+    /**
+     * Set the bearing of the ImageViewer in degrees.
+     *
+     * @param {number} bearing - The bearing of the ImageViewer.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    setBearing(bearing: number): this;
+    /**
+     * Get the bearing of the ImageViewer in degrees.
+     *
+     * @returns {number} The bearing of the ImageViewer.
+     */
+    getBearing(): number;
+    /**
+     * Pan by a given delta in pixels.
+     *
+     * @param {PointLike} delta - The delta to pan by.
+     * @param {ImageViewerEaseToOptions} options - The options for the pan.
+     * @param {any} eventData - The event data.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    panBy(delta: PointLike, options?: ImageViewerEaseToOptions, eventData?: any): this;
+    /**
+     * Pan to a given center in pixels.
+     *
+     * @param {number} center - The center to pan to.
+     * @param {ImageViewerEaseToOptions} options - The options for the pan.
+     * @param {any} eventData - The event data.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    panTo(center: [number, number], options?: ImageViewerEaseToOptions, eventData?: any): this;
+    /**
+     * Get the image metadata.
+     *
+     * @returns {ImageMetadata} The image metadata.
+     */
+    getImageMetadata(): ImageMetadata | undefined;
+    /**
+     * Get the visible bounds of the image in the viewport in imagePixels.
+     * [topLeft, bottomRight]
+     *
+     * @returns {[[number, number], [number, number]]} The visible bounds of the image.
+     */
+    getImageBounds(): number[][];
+    /**
+     * Set the bounds of the image.
+     *
+     * @param {[[number, number], [number, number]]} bounds - The bounds of the image.
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    fitImageBounds([tl, br]: [[number, number], [number, number]]): this;
+    /**
+     * Destroys the ImageViewer, removes the map instance and all event listeners. Useful for cleanup.
+     *
+     * @returns {ImageViewer} The ImageViewer instance.
+     */
+    remove(): void;
+    pointIsWithinImageBounds(px: [number, number]): boolean;
+    [lngLatToPxInternalSymbolKey]: (lngLat: LngLat) => [number, number];
+    [pxToLngLatInternalSymbolKey]: (px: [number, number]) => LngLat;
+}
+export {};

package/dist/src/ImageViewer/ImageViewerMarker.d.ts

@@ -0,0 +1,236 @@
+import { Alignment, Subscription, MarkerOptions, PointLike, Popup } from '../index';
+import { default as MapLibreGL } from 'maplibre-gl';
+import { default as ImageViewer } from './ImageViewer';
+declare const Evented: typeof MapLibreGL.Evented;
+export type ImageViewerMarkerOptions = MarkerOptions & {};
+export interface ImageViewerMarkerInterface {
+    on(event: MarkerEventTypes, listener: (e: ImageViewerMarkerEvent) => void): Subscription;
+    off(event: MarkerEventTypes, listener: (e: ImageViewerMarkerEvent) => void): void;
+    fire(event: ImageViewerMarkerEvent): void;
+    getPosition(): [number, number];
+    getOffset(): PointLike;
+    getPitchAlignment(): Alignment;
+    getPopup(): Popup;
+    getRotation(): number;
+    getRotationAlignment(): Alignment;
+    isDraggable(): boolean;
+    remove(): void;
+    removeClassName(className: string): void;
+    setDraggable(draggable: boolean): void;
+    setPosition(px: [number, number]): void;
+    setOffset(offset: PointLike): void;
+    setOpacity(opacity?: string, opacityWhenCovered?: string): void;
+    setPitchAlignment(pitchAlignment: Alignment): void;
+    setPopup(popup: Popup): void;
+    setRotation(rotation: number): void;
+    setRotationAlignment(rotationAlignment: Alignment): void;
+    setSubpixelPositioning(subpixelPositioning: boolean): void;
+    toggleClassName(className: string): void;
+    togglePopup(): void;
+}
+export declare class ImageViewerMarker extends Evented {
+    private viewer;
+    private readonly marker;
+    private readonly position;
+    constructor({ ...markerOptions }: ImageViewerMarkerOptions);
+    /**
+     * Adds the ImageViewerMarker to an instance of ImageViewer.
+     *
+     * @param {ImageViewer} viewer - The instance of ImageViewer to add the ImageViewerMarker to.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    addTo(viewer: ImageViewer): this;
+    /**
+     * Adds a class name to the ImageViewerMarker.
+     *
+     * @param {string} className - The class name to add to the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    addClassName(className: string): this;
+    /**
+     * Gets the element of the ImageViewerMarker.
+     *
+     * @returns {HTMLElement} The element of the ImageViewerMarker.
+     */
+    getElement(): HTMLElement;
+    /**
+     * Gets the position of the ImageViewerMarker.
+     *
+     * @returns {PointLike} The position of the ImageViewerMarker.
+     * @see  [PointLike](https://docs.maptiler.com/sdk-js/api/geography/#pointlike)
+     *
+     */
+    getPosition(): [number, number];
+    /**
+     * Gets the offset of the ImageViewerMarker.
+     *
+     * @returns {PointLike} The offset of the ImageViewerMarker.
+     * @see  [PointLike](https://docs.maptiler.com/sdk-js/api/geography/#pointlike)
+     */
+    getOffset(): MapLibreGL.Point;
+    /**
+     * Gets the pitch alignment of the ImageViewerMarker.
+     *
+     * @returns {Alignment} The pitch alignment of the ImageViewerMarker.
+     * @see  [MapLibreGL.Alignment](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/Alignment/)
+     */
+    getPitchAlignment(): Alignment;
+    /**
+     * Gets the popup of the ImageViewerMarker.
+     *
+     * @returns {Popup} The popup of the ImageViewerMarker.
+     * @see [Popup](https://docs.maptiler.com/sdk-js/api/markers/#popup)
+     */
+    getPopup(): MapLibreGL.Popup;
+    /**
+     * Gets the rotation of the ImageViewerMarker.
+     *
+     * @returns {number} The rotation of the ImageViewerMarker.
+     */
+    getRotation(): number;
+    /**
+     * Gets the rotation alignment of the ImageViewerMarker.
+     *
+     * @returns {Alignment} The rotation alignment of the ImageViewerMarker.
+     * @see  [MapLibreGL.Alignment](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/Alignment/)
+     */
+    getRotationAlignment(): Alignment;
+    /**
+     * Checks if the ImageViewerMarker is draggable.
+     *
+     * @returns {boolean} True if the ImageViewerMarker is draggable, false otherwise.
+     */
+    isDraggable(): boolean;
+    /**
+     * Fires an event on the ImageViewerMarker.
+     *
+     * @param {MarkerEventTypes | Event} event - The event to fire.
+     * @param {Record<string, any>} data - The data to fire the event with.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    fire(event: MarkerEventTypes | Event, data?: Record<string, any>): this;
+    /**
+     * Removes an event listener from the ImageViewerMarker.
+     *
+     * @param {MarkerEventTypes} event - The event to remove the listener from.
+     * @param {ImageViewerMarkerEvent} listener - The listener to remove.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    off(event: MarkerEventTypes, listener: (e: ImageViewerMarkerEvent) => void): this;
+    /**
+     * Adds an event listener to the ImageViewerMarker.
+     *
+     * @param {MarkerEventTypes} event - The event to add the listener to.
+     * @param {ImageViewerMarkerEvent} listener - The listener to add.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    on(event: MarkerEventTypes, listener: (e: ImageViewerMarkerEvent) => void): Subscription;
+    /**
+     * Checks if the ImageViewerMarker is within the image bounds.
+     *
+     * @returns {boolean} True if the ImageViewerMarker is within the image bounds, false otherwise.
+     */
+    isWithinImageBounds(): boolean;
+    /**
+     * Removes the ImageViewerMarker from the ImageViewer and cleans up the event listeners.
+     *
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    remove(): this;
+    /**
+     * Removes a class name from the ImageViewerMarker dom element.
+     *
+     * @param {string} className - The class name to remove from the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    removeClassName(className: string): this;
+    /**
+     * Sets the draggable state of the ImageViewerMarker.
+     *
+     * @param {boolean} draggable - The draggable state of the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    setDraggable(draggable: boolean): this;
+    /**
+     * Sets the position of the ImageViewerMarker.
+     *
+     * @param {[number, number]} px - The position of the ImageViewerMarker in image pixels.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    setPosition(px: [number, number]): this;
+    /**
+     * Sets the offset of the ImageViewerMarker.
+     *
+     * @param {PointLike} offset - The offset of the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    setOffset(offset: PointLike): this;
+    /**
+     * Sets the opacity of the ImageViewerMarker.
+     *
+     * @param {string} opacity - The opacity of the ImageViewerMarker.
+     * @param {string} opacityWhenCovered - The opacity of the ImageViewerMarker when covered.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    setOpacity(opacity?: string, opacityWhenCovered?: string): this;
+    /**
+     * Sets the pitch alignment of the ImageViewerMarker.
+     *
+     * @param {Alignment} pitchAlignment - The pitch alignment of the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     * @see  [MapLibreGL.Alignment](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/Alignment/)
+     */
+    setPitchAlignment(pitchAlignment: Alignment): this;
+    /**
+     * Sets the popup of the ImageViewerMarker.
+     *
+     * @param {Popup} popup - The popup of the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     * @see [Popup](https://docs.maptiler.com/sdk-js/api/markers/#popup)
+     */
+    setPopup(popup: Popup): this;
+    /**
+     * Sets the rotation of the ImageViewerMarker.
+     *
+     * @param {number} rotation - The rotation of the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    setRotation(rotation: number): this;
+    /**
+     * Sets the rotation alignment of the ImageViewerMarker.
+     *
+     * @param {Alignment} rotationAlignment - The rotation alignment of the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     * @see  [MapLibreGL.Alignment](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/Alignment/)
+     */
+    setRotationAlignment(rotationAlignment: Alignment): this;
+    /**
+     * Sets if subpixel positioning is enabled for the ImageViewerMarker.
+     *
+     * @param {boolean} subpixelPositioning - The subpixel positioning of the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    setSubpixelPositioning(subpixelPositioning: boolean): this;
+    /**
+     * Toggles a class name on the ImageViewerMarker dom element.
+     *
+     * @param {string} className - The class name to toggle on the ImageViewerMarker.
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    toggleClassName(className: string): this;
+    /**
+     * Toggles the popup of the ImageViewerMarker.
+     *
+     * @returns {ImageViewerMarker} The ImageViewerMarker instance.
+     */
+    togglePopup(): this;
+}
+declare const MARKER_EVENT_TYPES: readonly ["dragstart", "drag", "dragend"];
+type MarkerEventTypes = (typeof MARKER_EVENT_TYPES)[number];
+export declare class ImageViewerMarkerEvent {
+    readonly type: string;
+    readonly target: ImageViewerMarker;
+    [key: string]: any;
+    constructor(type: MarkerEventTypes, marker: ImageViewerMarker, data: Record<string, any>);
+}
+export {};

package/dist/src/ImageViewer/events.d.ts

@@ -0,0 +1,47 @@
+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;
+    [key: string]: any;
+    imageX: number;
+    imageY: number;
+    isOutOfBounds: boolean;
+    constructor(type: string, viewer: ImageViewer, originalEvent?: MouseEvent | TouchEvent | WheelEvent | WebGLContextEvent | null, data?: Record<string, any>);
+}
+declare const BASE_MAP_EVENT_TYPES: readonly ["idle", "render", "load", "remove", "idle"];
+declare const ERROR_EVENTS: readonly ["error"];
+declare const RESIZE_EVENTS: readonly ["resize"];
+declare const WEBGL_CONTEXT_EVENTS: readonly ["webglcontextlost", "webglcontextrestored"];
+declare const CAMERA_EVENTS: readonly ["moveend", "movestart", "move", "zoomend", "zoomstart", "zoom", "rotatestart", "rotateend", "rotate", "dragstart", "dragend", "drag", "boxzoomcancel", "boxzoomend", "boxzoomstart"];
+declare const UI_EVENTS: readonly ["click", "dblclick", "mousedown", "mouseup", "mousemove", "mouseout", "mouseover", "contextmenu", "touchstart", "touchend", "touchmove", "touchcancel"];
+declare const COOPERATIVE_GESTURE_EVENTS: readonly ["cooperativegestureprevented"];
+declare const DATA_EVENTS: readonly ["data", "dataloading", "sourcedata", "sourcedataloading", "dataabort", "sourcedataabort"];
+export declare const IMAGE_VIEWER_EVENT_TYPES: ("error" | "load" | "idle" | "remove" | "render" | "resize" | "webglcontextlost" | "webglcontextrestored" | "dataloading" | "data" | "sourcedataloading" | "sourcedata" | "dataabort" | "sourcedataabort" | "boxzoomcancel" | "boxzoomstart" | "boxzoomend" | "touchcancel" | "touchmove" | "touchend" | "touchstart" | "click" | "contextmenu" | "dblclick" | "mousemove" | "mouseup" | "mousedown" | "mouseout" | "mouseover" | "movestart" | "move" | "moveend" | "zoomstart" | "zoom" | "zoomend" | "rotatestart" | "rotate" | "rotateend" | "dragstart" | "drag" | "dragend" | "cooperativegestureprevented")[];
+type BaseMapEventKeys = (typeof BASE_MAP_EVENT_TYPES)[number];
+type UiEventKeys = (typeof UI_EVENTS)[number];
+type CameraEventKeys = (typeof CAMERA_EVENTS)[number];
+type ErrorEventKeys = (typeof ERROR_EVENTS)[number];
+type ResizeEventKeys = (typeof RESIZE_EVENTS)[number];
+type WebglContextEventKeys = (typeof WEBGL_CONTEXT_EVENTS)[number];
+type DataEventKeys = (typeof DATA_EVENTS)[number];
+type CooperativeGestureEventKeys = (typeof COOPERATIVE_GESTURE_EVENTS)[number];
+export type ImageViewerEventTypes = BaseMapEventKeys | UiEventKeys | CameraEventKeys | ErrorEventKeys | ResizeEventKeys | WebglContextEventKeys | DataEventKeys | CooperativeGestureEventKeys | "imageviewerready" | "imagevieweriniterror" | "beforeremove";
+type LngLatToPixel = (lngLat: LngLat) => [number, number];
+interface SetupGlobalMapEventForwarderOptions {
+    map: Map;
+    viewer: ImageViewer;
+    lngLatToPx: LngLatToPixel;
+}
+/**
+ * Sets up event forwarding from Map to ImageViewer with proper categorization
+ * @param {SetupGlobalMapEventForwarderOptions} options - The options for setting up the event forwarder.
+ * @param {Map} options.map - The map to forward events from.
+ * @param {ImageViewer} options.viewer - The viewer to forward events to.
+ * @param {LngLatToPixel} options.lngLatToPx - A function to convert LngLat to pixel coordinates.
+ * @returns {void}
+ */
+export declare function setupGlobalMapEventForwarder({ map, viewer, lngLatToPx }: SetupGlobalMapEventForwarderOptions): void;
+export {};

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

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