@mappable-world/mappable-types 0.0.13 → 0.0.14

package/common/types/projection.d.ts

@@ -1,6 +1,11 @@
 import type { LngLat } from "./lng-lat";
 import type { WorldCoordinates } from "./coordinates";
 interface GenericProjection<TSource> {
+    /** Projection identity type. It may be:
+         * - EPSG-code (e.g. [EPSG:3857](https://epsg.io/3857))
+         * - any other string to identify (e.g. 'cartesian')
+         **/
+    readonly type?: string;
     toWorldCoordinates(point: TSource): WorldCoordinates;
     fromWorldCoordinates(coordinates: WorldCoordinates): TSource;
 }

package/imperative/MMap/projection.d.ts

@@ -1,2 +1,2 @@
-import { sphericalMercator } from "../utils/projections/spherical-mercator";
-export { sphericalMercator as projection };
+import { WebMercator } from "../utils/projections/web-mercator";
+export declare const projection: WebMercator;

package/imperative/MMapDefaultSchemeLayer/index.d.ts

@@ -79,8 +79,6 @@ declare class MMapDefaultSchemeLayer extends MMapComplexEntity<MMapDefaultScheme
     protected _onAttach(): void;
     protected _onDetach(): void;
     protected _onUpdate(propsDiff: Partial<MMapDefaultSchemeLayerProps>): void;
-    private _createTileUrl;
-    private _getProjectionQuery;
     private _getDataSourceDescription;
     private _updateTheme;
 }

package/imperative/index.d.ts

@@ -1,3 +1,4 @@
+import * as projections_ from "./utils/projections";
 export { MMap, MMapProps, MMapCenterLocation, MMapZoomLocation, MMapBoundsLocation, MMapCenterZoomLocation, MMapLocationRequest, MMapCameraRequest } from "./MMap";
 export { MMapThemeContext, ThemeContext, MMapTheme } from "./ThemeContext";
 export { MMapCopyrightsPosition } from "./MMapCopyrights";
@@ -24,7 +25,11 @@ export { geolocation } from "./geolocation";
 export { useDomContext, DomDetach } from "./DomContext";
 export { Config, getDefaultConfig } from "./config";
 export { fetchConfig, FetchConfigOptions } from "./fetchConfig";
-export * as projections from "./utils/projections";
+/** @deprecated Use mappable packages instead */
+export declare const projections: {
+    /** @deprecated Use [Web Mercator package](https://www.npmjs.com/package/@mappable-world/mappable-web-mercator-projection) instead. */
+    sphericalMercator: projections_.WebMercator;
+};
 /** Toggle this to enable/disable strict mode. */
 export declare let strictMode: boolean;
 export type { LngLat, ReadonlyLngLat, LngLatBounds, BehaviorType, MapMode, Margin, ZoomRange, ZoomStrategy, ZoomRounding, VectorCustomizationTypes, VectorCustomizationElements, VectorCustomizationItem, VectorCustomization, RasterTileDataSourceDescription, VectorTileDataSourceDescription, RasterLayerOptions, EasingFunctionDescription, EasingPresetName, EasingBezierPreset, EasingFunction, DrawingStyle, DrawingStyleIcon, VectorTileSize, VectorObjectsCollisionPriority, VectorDataSourcePriority } from "../common/types";

package/imperative/utils/allowed-custom-layer-implementations.d.ts

@@ -0,0 +1 @@
+import type { LayerImplementationClasses } from "../../common/types/layer-implementation";

package/imperative/utils/projections/index.d.ts

@@ -1 +1 @@
-export * from "./spherical-mercator";
+export * from "./web-mercator";

package/imperative/utils/projections/{spherical-mercator.d.ts → web-mercator.d.ts}

@@ -2,18 +2,18 @@ import type { Projection, LngLat, WorldCoordinates } from "../../../common/types
 /**
  * @class Mercator projection onto a sphere.
  * Used by many mapping services, in particular OpenStreetMap.
- * @name projection.sphericalMercator
+ * @name projection.webMercator
  * @augments Projection
  * @static
  * @example
  * ```js
- * // Create a map in the spherical Mercator projection
+ * // Create a map in the web Mercator projection
  * const map = new mappable.MMap(document.getElementById('MMapsID'), {
  *     location: {
  *         center: [37, 55],
  *         zoom: 6
  *     },
- *     projection: new mappable.SphericalMercator()
+ *     projection: new WebMercator()
  * });
  * const dataSourceProps = {
  *     raster: {
@@ -34,8 +34,9 @@ import type { Projection, LngLat, WorldCoordinates } from "../../../common/types
  * });
  * ```
  */
-declare class SphericalMercator implements Projection {
+export declare class WebMercator implements Projection {
     private _maxLatitudeRad;
+    type: string;
     toWorldCoordinates(coords: LngLat): WorldCoordinates;
     fromWorldCoordinates(world: WorldCoordinates): LngLat;
     private _worldXToLongitude;
@@ -43,5 +44,5 @@ declare class SphericalMercator implements Projection {
     private _latitudeToWorldY;
     private _worldYToLatitude;
 }
-declare const sphericalMercator: SphericalMercator;
-export { sphericalMercator };
+/** @deprecated Use WebMercator instead */
+export declare const SphericalMercator: typeof WebMercator;

package/modules/controls-extra/MMapScaleControl/distance-utils.d.ts

@@ -0,0 +1,14 @@
+import type { UnitType } from ".";
+/**
+ * Converts the distance in one set of units to another set of units
+ * @param distance - non-rounded distance in meters
+ * @param unit - unit of measurement to be converted to
+ * @returns converted distance value
+ */
+export declare function convertDistanceToUnit(distance: number, unit: UnitType): number;
+/**
+ * Rounds off the integer distance to the nearest round number
+ * @param rawDistance - unrounded distance
+ * @returns Rounded distance
+ */
+export declare function floorToNearestTenths(rawDistance: number): number;

package/modules/controls-extra/MMapScaleControl/index.d.ts

@@ -0,0 +1,34 @@
+import { MMapComplexEntity } from "../../../imperative";
+export type UnitType = 'imperial' | 'metric' | 'nautical';
+type MMapScaleControlProps = {
+    /** Maximum width of scale line in pixels */
+    maxWidth?: number;
+    /** Units of measurement for the scale line */
+    unit?: UnitType;
+};
+declare const defaultProps: Readonly<{
+    maxWidth: 85;
+    unit: "metric";
+}>;
+type DefaultProps = typeof defaultProps;
+declare class MMapScaleControl extends MMapComplexEntity<MMapScaleControlProps, DefaultProps> {
+    static defaultProps: Readonly<{
+        maxWidth: 85;
+        unit: "metric";
+    }>;
+    private _unwatchThemeContext?;
+    private _detachDom?;
+    private _element?;
+    private _labelElement?;
+    private _listener?;
+    constructor(props: MMapScaleControlProps);
+    protected _onAttach(): void;
+    protected _onDetach(): void;
+    private _createDom;
+    private _updateDom;
+    private _updateTheme;
+    private _onMapUpdate;
+    private _updateDistance;
+    private _formatDistance;
+}
+export { MMapScaleControl, MMapScaleControlProps };

package/package.json

@@ -1,25 +1,23 @@
 {
     "name": "@mappable-world/mappable-types",
-    "version": "0.0.13",
+    "version": "0.0.14",
     "description": "Types for mappable maps library",
     "main": "",
     "types": "index.d.ts",
-    "keywords": [
-        "mappable-world",
-        "api",
-        "map",
-        "mappable",
-        "types",
-        "js api"
-    ],
+    "keywords": ["mappable-world", "api", "map", "mappable", "types", "js api"],
     "publishConfig": {
         "registry": "https://registry.npmjs.org"
     },
     "homepage": "https://mappable.world",
     "license": "Apache-2.0",
-    "dependencies": {
-        "@types/react": "*",
-        "@types/react-dom": "*",
-        "@vue/runtime-core": "*"
+    "peerDependencies": {
+        "@types/react": "16-18",
+        "@types/react-dom": "16-18",
+        "@vue/runtime-core": "3"
+    },
+    "peerDependenciesMeta": {
+        "@types/react": {"optional": true},
+        "@types/react-dom": {"optional": true},
+        "@vue/runtime-core": {"optional": true}
     }
 }

package/packages/cartesian-projection/index.d.ts

@@ -37,6 +37,7 @@ export declare class Cartesian implements Projection {
     private _cycled;
     private _xRange;
     private _yRange;
+    readonly type = "cartesian";
     constructor(bounds: [
         LngLat,
         LngLat

package/packages/spherical-mercator-projection/index.d.ts

@@ -5,9 +5,10 @@ import type { Projection } from "../../common/types";
  * @name projection.sphericalMercator
  * @augments Projection
  * @static
+ * @deprecated Use [Web Mercator package](https://www.npmjs.com/package/@mappable-world/mappable-web-mercator-projection) instead.
  * @example
  * ```js
- * const { SphericalMercator } = await mappable.import('@mappable-world/mappable-spherical-mercator-projection@0.0.1');
+ * const {SphericalMercator} = await mappable.import('@mappable-world/mappable-spherical-mercator-projection@0.0.1');
  * // Create a map in the spherical Mercator projection
  * const map = new mappable.MMap(document.getElementById('MMapsID'), {
  *     location: {

package/reactify/reactify.d.ts

@@ -38,7 +38,7 @@ export interface ReactifyModule {
 }
 export type GetReactContext<TContext extends Context<unknown>> = (context?: TContext | undefined) => React.Context<unknown>;
 export type ReactifiedModule<TModule extends BaseModule> = {
-    [Property in keyof TModule]: TModule[Property] extends EntityConstructor<GenericEntity<unknown>> ? ReturnType<InternalReactifyEntity<TModule[Property]>> : TModule[Property] extends typeof Context ? ReturnType<GetReactContext<TModule[Property]>> : TModule[Property];
+    [Property in keyof TModule]: TModule[Property] extends EntityConstructor<GenericEntity<unknown>> ? ReturnType<InternalReactifyEntity<TModule[Property]>> : TModule[Property] extends Context<any> ? ReturnType<GetReactContext<TModule[Property]>> : TModule[Property];
 };
 export type BaseModule = Record<string | symbol, unknown>;
 export type Prettify<T> = {