@mappable-world/mappable-types 0.0.15 → 0.0.17

package/common/types/data-source-description.d.ts

@@ -41,10 +41,17 @@ interface RenderedHotspot {
     readonly geometry: GenericGeometry<PixelCoordinates>;
 }
 type Hotspot = WorldHotspot | RenderedHotspot;
-interface FetchedTile {
+interface FetchedCommonTile {
+    destroy?(): void;
+}
+interface FetchedRasterTile extends FetchedCommonTile {
     image: HTMLImageElement | HTMLCanvasElement | ImageBitmap;
 }
-type FetchTileFunction = (x: number, y: number, z: number, scale: number, signal: AbortSignal) => Promise<FetchedTile>;
+/**
+ * @deprecated Use FetchedRasterTile instead
+ */
+type FetchedTile = FetchedRasterTile;
+type FetchTileFunction = (x: number, y: number, z: number, scale: number, signal: AbortSignal) => Promise<FetchedCommonTile | FetchedRasterTile>;
 type ComposeTileUrlFunction = (x: number, y: number, z: number, scale: number, signal: AbortSignal) => string;
 /**
  * Provides hotspots for given tile coordinates and zoom.
@@ -127,6 +134,7 @@ interface VectorTileDataSourceDescription {
     tileCacheSize?: number;
     richModelCacheSize?: number;
     richModelEnabled?: boolean;
+    richPointEnabled?: boolean;
     allObjectsInteractive?: boolean;
     /** Forces tiles to wait for the icons, disables hiding icons by zoom diff */
     iconsOnlyTiles?: boolean;
@@ -136,4 +144,4 @@ interface VectorTileDataSourceDescription {
     /** Defines how hotspots of type should be treated: enabled/disabled or use custom hotspots instead. */
     hotspots?: Record<string, boolean | FetchHotspotsFunction | HotspotsOptions>;
 }
-export { VectorCustomizationTypes, VectorCustomizationElements, VectorCustomizationItem, VectorCustomization, RasterTileDataSourceDescription, FetchHotspotsFunction, VectorTileDataSourceDescription, VectorTileSize, VectorObjectsCollisionPriority, VectorDataSourcePriority, HotspotsOptions, FetchTileFunction, ComposeTileUrlFunction, Hotspot, WorldHotspot, RenderedHotspot, FetchedTile, MapTheme };
+export { VectorCustomizationTypes, VectorCustomizationElements, VectorCustomizationItem, VectorCustomization, RasterTileDataSourceDescription, FetchHotspotsFunction, VectorTileDataSourceDescription, VectorTileSize, VectorObjectsCollisionPriority, VectorDataSourcePriority, HotspotsOptions, FetchTileFunction, ComposeTileUrlFunction, Hotspot, WorldHotspot, RenderedHotspot, FetchedRasterTile, FetchedTile, FetchedCommonTile, MapTheme };

package/common/types/index.d.ts

@@ -20,3 +20,4 @@ export * from "./utils";
 export * from "./world-options";
 export * from "./data-source-description";
 export * from "./matrix";
+export * from "./tilt-range";

package/common/types/tilt-range.d.ts

@@ -0,0 +1,8 @@
+export interface TiltRange {
+    /** Minimum tilt in radians. */
+    readonly min: number;
+    /** Maximum tilt in radians. */
+    readonly max: number;
+    /** Behavior tilt expansion in radians. E.g. you can tilt map with fingers a little bit more than `max`. */
+    readonly expansion: number;
+}

package/imperative/Entities.d.ts

@@ -91,6 +91,18 @@ declare abstract class GenericEntity<Props, DefaultProps extends {} = {}, Root e
          * @returns Context value.
          */
     protected _consumeContext<T>(consumer: Context<T>): T | undefined;
+    /**
+         * Subscribes to changes in a context
+         * @param context - The context that provides access to the context value.
+         * @param watcher - Callback function that is called when the context value is changed.
+         * @param params - Params for watcher.
+         * @param params.immediate - Calls watcher immediately. For most handlers it allows to inline watcher function.
+         * @returns Function to unsubscribe from changes context.
+         * For most handlers it can be, because it is called automatically on detach.
+         */
+    protected _watchContext<T>(context: Context<T>, watcher: ContextWatcherFn, params?: {
+        immediate: boolean;
+    }): () => void;
 }
 interface ComplexOptions<Root extends GenericRootEntity<unknown> = GenericRootEntity<unknown>> {
     children?: GenericEntity<unknown, {}, Root>[];

package/imperative/MMap/index.d.ts

@@ -1,4 +1,4 @@
-import type { BehaviorType, LngLat, MapMode, Margin, PixelCoordinates, Projection, ReadonlyLngLat, LngLatBounds, ZoomRange, ZoomRounding, WorldOptions, ZoomStrategy, EasingFunctionDescription } from "../../common/types";
+import type { BehaviorType, LngLat, MapMode, Margin, PixelCoordinates, Projection, ReadonlyLngLat, LngLatBounds, ZoomRange, ZoomRounding, WorldOptions, ZoomStrategy, EasingFunctionDescription, TiltRange } from "../../common/types";
 import type { MMapEntity } from "../MMapEnities";
 import { GenericRootEntity } from "../Entities";
 import { MMapCopyrightsPosition } from "../MMapCopyrights";
@@ -233,6 +233,7 @@ declare class MMap extends GenericRootEntity<MMapProps, DefaultProps> {
          * getter for {@link MMapProps}.zoomRange prop
          */
     get zoomRange(): Readonly<ZoomRange>;
+    get tiltRange(): Readonly<TiltRange>;
     /**
          * getter for {@link MMapProps}.projection prop
          */

package/imperative/MMapControls/index.d.ts

@@ -1,11 +1,22 @@
+import { Context } from "../Entities";
 import { MMapEntity, MMapGroupEntity } from "../MMapEnities";
-type VerlicalPosition = "top" | "bottom";
+type VerticalPosition = "top" | "bottom";
+type ComputedVerticalPosition = "top" | "center" | "bottom";
 type HorizontalPosition = "left" | "right";
+type ComputedHorizontalPosition = "left" | "center" | "right";
 type Orientation = "horizontal" | "vertical";
+export type MMapControlContext = {
+    position: [
+        ComputedVerticalPosition,
+        ComputedHorizontalPosition,
+        Orientation
+    ];
+};
+export declare const ControlContext: Context<MMapControlContext>;
 /**
  * Describes controls position.
  */
-type Position = VerlicalPosition | HorizontalPosition | `${VerlicalPosition} ${HorizontalPosition}` | `${HorizontalPosition} ${VerlicalPosition}`;
+type Position = VerticalPosition | HorizontalPosition | `${VerticalPosition} ${HorizontalPosition}` | `${HorizontalPosition} ${VerticalPosition}`;
 /**
  * MMapControls props
  */

package/imperative/MMapFeature/index.d.ts

@@ -52,6 +52,7 @@ declare class MMapFeature extends MMapEntity<MMapFeatureProps, DefaultProps> {
     private _id;
     private _source;
     private _defaultPropsId?;
+    get id(): string;
     constructor(props: MMapFeatureProps);
     get properties(): Record<string, unknown> | undefined;
     get geometry(): GenericGeometry<LngLat>;

package/imperative/index.d.ts

@@ -13,7 +13,7 @@ export * from "./MMapHotspot";
 export * from "./wrappers";
 export { MMapMarker, MMapMarkerProps, MMapMarkerEventHandler } from "./MMapMarker";
 export { MMapTileDataSource, MMapTileDataSourceProps } from "./MMapTileDataSource";
-export { MMapControls, MMapControlsProps } from "./MMapControls";
+export * from "./MMapControls";
 export { MMapControl, MMapControlProps, MMapControlButton, MMapControlButtonProps, MMapControlCommonButton } from "./MMapControl";
 export { MMapCollection } from "./MMapCollection";
 export { MMapContainer, MMapContainerProps, MMapContainerPropsImpl, ComputedMMapContainerProps } from "./MMapContainer";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mappable-world/mappable-types",
-    "version": "0.0.15",
+    "version": "0.0.17",
     "description": "Types for mappable maps library",
     "main": "",
     "types": "index.d.ts",

package/packages/clusterer/MMapClusterer/MMapClusterer.d.ts

@@ -58,16 +58,16 @@ declare class MMapClusterer extends mappable.MMapComplexEntity<MMapClustererProp
     static [mappable.overrideKeyReactify]: import("../../../reactify/reactify").CustomReactify<MMapClusterer, import("react").ForwardRefExoticComponent<{
         features: Feature[];
         maxZoom?: number | undefined;
-        method: IClusterMethod;
         tickTimeout?: number | undefined;
+        method: IClusterMethod;
         onRender?: ((clusters: ClustererObject[]) => false | void) | undefined;
         marker: (feature: Feature) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
         cluster: (coordinates: LngLat, features: Feature[]) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
         ref?: import("react").Ref<MMapEntity<{
             features: Feature[];
             maxZoom?: number | undefined;
-            method: IClusterMethod;
             tickTimeout?: number | undefined;
+            method: IClusterMethod;
             onRender?: ((clusters: ClustererObject[]) => false | void) | undefined;
             marker: (feature: Feature) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
             cluster: (coordinates: LngLat, features: Feature[]) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
@@ -86,7 +86,8 @@ declare class MMapClusterer extends mappable.MMapComplexEntity<MMapClustererProp
     private _mapListener;
     constructor(props: MMapClustererProps);
     /**
-         * Compare feature coordinates with bounds
+         * Compare feature coordinates with bounds.
+         * Visible in x2 bounds.
          *
          * @param feature
          * @param bounds

package/packages/controls/MMapZoomControl/index.d.ts

@@ -1,7 +1,4 @@
 import type { EasingFunctionDescription } from "../../../common/types";
-import type { MMapControlCommonButton } from "../../../imperative/MMapControl";
-import type { MMapListener } from "../../../imperative/MMapListener";
-import type { DomDetach } from "../../../imperative";
 import type { CustomVuefyOptions } from "../../../modules/vuefy";
 /**
  * MMapZoomControl props
@@ -28,24 +25,15 @@ type DefaultProps = typeof defaultProps;
  * map.addChild(controls);
  * ```
  */
-declare class MMapZoomControl extends mappable.MMapGroupEntity<MMapZoomControlProps> {
+declare class MMapZoomControl extends mappable.MMapComplexEntity<MMapZoomControlProps> {
+    static [mappable.optionsKeyVuefy]: CustomVuefyOptions<MMapZoomControl>;
     static defaultProps: Readonly<{
         duration: 200;
     }>;
-    static [mappable.optionsKeyVuefy]: CustomVuefyOptions<MMapZoomControl>;
-    protected _zoomIn: MMapControlCommonButton;
-    protected _zoomOut: MMapControlCommonButton;
-    protected _listener: MMapListener;
-    private _currentZoom;
-    protected _detachDom?: DomDetach;
-    protected _element?: HTMLElement;
-    private _unwatchThemeContext?;
-    constructor(props: MMapZoomControlProps);
-    private _onMapUpdate;
-    private _changeZoom;
+    private _control;
+    private _zoom;
     protected _onAttach(): void;
+    protected _onUpdate(props: MMapZoomControlProps): void;
     protected _onDetach(): void;
-    protected _onUpdate(): void;
-    private _updateTheme;
 }
 export { MMapZoomControl, MMapZoomControlProps };