@nativescript-community/ui-mapbox 6.2.23 → 6.2.27

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.2.27](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.26...v6.2.27) (2023-12-18)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
+## [6.2.26](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.25...v6.2.26) (2023-12-18)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
+## [6.2.25](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.24...v6.2.25) (2023-12-07)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
+## [6.2.24](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.23...v6.2.24) (2023-12-07)
+
+**Note:** Version bump only for package @nativescript-community/ui-mapbox
+
 ## [6.2.23](https://github.com/nativescript-community/ui-mapbox/compare/v6.2.22...v6.2.23) (2023-11-29)
 
 ### Bug Fixes

package/common.d.ts

@@ -314,6 +314,12 @@ export interface ListOfflineRegionsOptions {
      */
     accessToken?: string;
 }
+export declare enum ControlPosition {
+    TOP_LEFT = 0,
+    TOP_RIGHT = 1,
+    BOTTOM_LEFT = 2,
+    BOTTOM_RIGHT = 3
+}
 /**
  * The options object passed into the show function.
  */
@@ -322,9 +328,9 @@ export interface ShowOptions {
     /**
      * default 'streets'
      */
-    style?: MapStyle;
+    style?: string | MapStyle;
     margins?: ShowOptionsMargins;
-    center?: LatLng;
+    center?: Partial<LatLng>;
     /**
      * default 0 (which is almost the entire planet)
      */
@@ -337,14 +343,26 @@ export interface ShowOptions {
      * default false (required for the 'starter' plan)
      */
     hideLogo?: boolean;
+    /**
+     * default BOTTOM_LEFT
+     */
+    logoPosition?: ControlPosition;
     /**
      * default true
      */
     hideAttribution?: boolean;
+    /**
+     * default BOTTOM_LEFT
+     */
+    attributionPosition?: ControlPosition;
     /**
      * default false
      */
     hideCompass?: boolean;
+    /**
+     * default TOP_RIGHT
+     */
+    compassPosition?: ControlPosition;
     /**
      * default false
      */
@@ -397,6 +415,14 @@ export interface ShowOptions {
      * Android parent View
      */
     parentView?: any;
+    /**
+     * On Android by default there is a 200ms delay before showing the map to work around a race condition.
+     */
+    delay?: number;
+    /**
+     * See https://docs.mapbox.com/archive/android/maps/api/9.0.0/com/mapbox/mapboxsdk/location/LocationComponentOptions.html
+     */
+    locationComponentOptions: any;
 }
 export interface ShowResult {
     ios: any;
@@ -496,7 +522,7 @@ export interface MapboxApi {
     getLayer(name: string, nativeMap?: any): Promise<LayerCommon>;
     getLayers(nativeMap?: any): Promise<LayerCommon[]>;
     getImage(imageId: string, nativeMap?: any): Promise<ImageSource>;
-    addImage(imageId: string, image: string, nativeMap?: any): Promise<void>;
+    addImage(imageId: string, imagePath: string, nativeMap?: any): Promise<void>;
     removeImage(imageId: string, nativeMap?: any): Promise<void>;
     project(data: LatLng): {
         x: number;
@@ -510,30 +536,11 @@ export interface MapboxApi {
 export declare abstract class MapboxCommon implements MapboxCommonApi {
     view?: MapboxViewCommonBase;
     constructor(view?: MapboxViewCommonBase);
-    static defaults: {
-        style: string;
-        mapStyle: string;
-        margins: {
-            left: number;
-            right: number;
-            top: number;
-            bottom: number;
-        };
-        zoomLevel: number;
-        showUserLocation: boolean;
-        locationComponentOptions: {};
-        hideLogo: boolean;
-        hideAttribution: boolean;
-        hideCompass: boolean;
-        disableRotation: boolean;
-        disableScroll: boolean;
-        disableZoom: boolean;
-        disableTilt: boolean;
-        delay: number;
-    };
+    static defaults: Partial<ShowOptions>;
     static merge(obj1: {}, obj2: {}): any;
     requestFineLocationPermission(): Promise<any>;
     hasFineLocationPermission(): Promise<boolean>;
+    protected fetchImageSource(imagePath: string): Promise<ImageSource>;
 }
 /**
  * Interface definition for a View of a mapbox map.
@@ -583,7 +590,7 @@ export interface MapboxViewApi {
     getLayer(name: string, nativeMap?: any): Promise<LayerCommon>;
     getLayers(nativeMap?: any): Promise<LayerCommon[]>;
     getImage(imageId: string, nativeMap?: any): Promise<ImageSource>;
-    addImage(imageId: string, image: string, nativeMap?: any): Promise<void>;
+    addImage(imageId: string, imagePath: string, nativeMap?: any): Promise<void>;
     removeImage(imageId: string, nativeMap?: any): Promise<void>;
     destroy(): Promise<any>;
     onStart(): Promise<any>;
@@ -664,7 +671,7 @@ export declare abstract class MapboxViewCommonBase extends ContentView implement
     getLayer(name: string, nativeMap?: any): Promise<LayerCommon>;
     getLayers(nativeMap?: any): Promise<LayerCommon[]>;
     getImage(imageId: string): Promise<ImageSource>;
-    addImage(imageId: string, image: string): Promise<void>;
+    addImage(imageId: string, imagePath: string): Promise<void>;
     removeImage(imageId: string): Promise<void>;
     destroy(): Promise<any>;
     onStart(): Promise<any>;
@@ -696,9 +703,12 @@ export declare const longitudeProperty: Property<MapboxViewCommonBase, number>;
 export declare const showUserLocationProperty: Property<MapboxViewCommonBase, boolean>;
 export declare const locationComponentOptionsProperty: Property<MapboxViewCommonBase, object>;
 export declare const hideLogoProperty: Property<MapboxViewCommonBase, boolean>;
+export declare const logoPositionProperty: Property<MapboxViewCommonBase, ControlPosition>;
 export declare const hideAttributionProperty: Property<MapboxViewCommonBase, boolean>;
+export declare const attributionPositionProperty: Property<MapboxViewCommonBase, ControlPosition>;
 export declare const telemetryProperty: Property<MapboxViewCommonBase, boolean>;
 export declare const hideCompassProperty: Property<MapboxViewCommonBase, boolean>;
+export declare const compassPositionProperty: Property<MapboxViewCommonBase, ControlPosition>;
 export declare const disableZoomProperty: Property<MapboxViewCommonBase, boolean>;
 export declare const disableRotationProperty: Property<MapboxViewCommonBase, boolean>;
 export declare const disableScrollProperty: Property<MapboxViewCommonBase, boolean>;
@@ -721,5 +731,5 @@ export declare abstract class MapboxViewBase extends MapboxViewCommonBase {
     static moveEndEvent: string;
     static locationPermissionGrantedEvent: string;
     static locationPermissionDeniedEvent: string;
-    protected config: any;
+    protected config: Partial<ShowOptions>;
 }

package/common.js

@@ -1,4 +1,4 @@
-import { Color, ContentView, ImageSource, Property, Trace, booleanConverter } from '@nativescript/core';
+import { Color, ContentView, ImageSource, Property, Trace, Utils, booleanConverter } from '@nativescript/core';
 export * from './geo.utils';
 export * from './expression/expression-parser';
 export * from './layers/layer-factory';
@@ -27,6 +27,14 @@ export var MapStyle;
     MapStyle["TRAFFIC_NIGHT"] = "traffic_night";
 })(MapStyle || (MapStyle = {}));
 // ------------------------------------------------------------
+export var ControlPosition;
+(function (ControlPosition) {
+    ControlPosition[ControlPosition["TOP_LEFT"] = 0] = "TOP_LEFT";
+    ControlPosition[ControlPosition["TOP_RIGHT"] = 1] = "TOP_RIGHT";
+    ControlPosition[ControlPosition["BOTTOM_LEFT"] = 2] = "BOTTOM_LEFT";
+    ControlPosition[ControlPosition["BOTTOM_RIGHT"] = 3] = "BOTTOM_RIGHT";
+})(ControlPosition || (ControlPosition = {}));
+// ------------------------------------------------------------
 export class MapboxCommon {
     constructor(view) {
         this.view = view;
@@ -57,10 +65,19 @@ export class MapboxCommon {
     async hasFineLocationPermission() {
         return true;
     }
+    async fetchImageSource(imagePath) {
+        if (Utils.isDataURI(imagePath)) {
+            const [, base64] = imagePath.split(';base64,');
+            return ImageSource.fromBase64Sync(base64);
+        }
+        if (Utils.isFileOrResourcePath(imagePath)) {
+            return ImageSource.fromFileOrResourceSync(imagePath);
+        }
+        return ImageSource.fromUrl(imagePath);
+    }
 }
 MapboxCommon.defaults = {
     style: MapStyle.STREETS.toString(),
-    mapStyle: MapStyle.STREETS.toString(),
     margins: {
         left: 0,
         right: 0,
@@ -71,8 +88,11 @@ MapboxCommon.defaults = {
     showUserLocation: false,
     locationComponentOptions: {},
     hideLogo: false,
+    logoPosition: ControlPosition.BOTTOM_LEFT,
     hideAttribution: true,
+    attributionPosition: ControlPosition.BOTTOM_LEFT,
     hideCompass: false,
+    compassPosition: ControlPosition.TOP_RIGHT,
     disableRotation: false,
     disableScroll: false,
     disableZoom: false,
@@ -230,8 +250,8 @@ export class MapboxViewCommonBase extends ContentView {
     getImage(imageId) {
         return this.mapbox.getImage(imageId, this.getNativeMapView());
     }
-    addImage(imageId, image) {
-        return this.mapbox.addImage(imageId, image, this.getNativeMapView());
+    addImage(imageId, imagePath) {
+        return this.mapbox.addImage(imageId, imagePath, this.getNativeMapView());
     }
     removeImage(imageId) {
         return this.mapbox.removeImage(imageId, this.getNativeMapView());
@@ -299,12 +319,22 @@ export const hideLogoProperty = new Property({
     valueConverter: booleanConverter
 });
 hideLogoProperty.register(MapboxViewCommonBase);
+export const logoPositionProperty = new Property({
+    name: 'logoPosition',
+    defaultValue: MapboxCommon.defaults.logoPosition
+});
+logoPositionProperty.register(MapboxViewCommonBase);
 export const hideAttributionProperty = new Property({
     name: 'hideAttribution',
     defaultValue: MapboxCommon.defaults.hideAttribution,
     valueConverter: booleanConverter
 });
 hideAttributionProperty.register(MapboxViewCommonBase);
+export const attributionPositionProperty = new Property({
+    name: 'attributionPosition',
+    defaultValue: MapboxCommon.defaults.attributionPosition
+});
+attributionPositionProperty.register(MapboxViewCommonBase);
 export const telemetryProperty = new Property({
     name: 'telemetry',
     defaultValue: false,
@@ -317,6 +347,11 @@ export const hideCompassProperty = new Property({
     valueConverter: booleanConverter
 });
 hideCompassProperty.register(MapboxViewCommonBase);
+export const compassPositionProperty = new Property({
+    name: 'compassPosition',
+    defaultValue: MapboxCommon.defaults.compassPosition
+});
+compassPositionProperty.register(MapboxViewCommonBase);
 export const disableZoomProperty = new Property({
     name: 'disableZoom',
     defaultValue: MapboxCommon.defaults.disableZoom,
@@ -366,7 +401,6 @@ export class MapboxViewBase extends MapboxViewCommonBase {
     }
     [mapStyleProperty.setNative](value) {
         this.config.style = value;
-        this.config.mapStyle = value;
     }
     [accessTokenProperty.setNative](value) {
         this.config.accessToken = value;
@@ -391,12 +425,21 @@ export class MapboxViewBase extends MapboxViewCommonBase {
     [hideLogoProperty.setNative](value) {
         this.config.hideLogo = value;
     }
+    [logoPositionProperty.setNative](value) {
+        this.config.logoPosition = value;
+    }
     [hideAttributionProperty.setNative](value) {
         this.config.hideAttribution = value;
     }
+    [attributionPositionProperty.setNative](value) {
+        this.config.attributionPosition = value;
+    }
     [hideCompassProperty.setNative](value) {
         this.config.hideCompass = value;
     }
+    [compassPositionProperty.setNative](value) {
+        this.config.compassPosition = value;
+    }
     [disableZoomProperty.setNative](value) {
         this.config.disableZoom = value;
     }

package/index.android.d.ts

@@ -30,7 +30,7 @@ export declare class MapboxView extends MapboxViewBase {
     /**
      * programmatically include settings
      */
-    setConfig(settings: any): void;
+    setConfig(settings: ShowOptions): void;
     getNativeMapView(): any;
     /**
      * Return the Mapbox() API Shim instance
@@ -40,7 +40,7 @@ export declare class MapboxView extends MapboxViewBase {
      *
      * @see Mapbox
      */
-    getMapboxApi(): any;
+    getMapboxApi(): MapboxApi;
     /**
      * Creates the native view.
      *
@@ -249,7 +249,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      */
     setMapStyle(style: string | MapStyle, nativeMapViewInstance?: any): Promise<void>;
     getImage(imageId: string, nativeMap?: any): Promise<ImageSource>;
-    addImage(imageId: string, image: string, nativeMap?: any): Promise<void>;
+    addImage(imageId: string, imagePath: string, nativeMap?: any): Promise<void>;
     removeImage(imageId: string, nativeMap?: any): Promise<void>;
     addMarkers(markers: MapboxMarker[], nativeMap?: any): Promise<void>;
     removeMarkers(ids?: any, nativeMap?: any): Promise<void>;
@@ -394,7 +394,8 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      * @link https://github.com/mapbox/mapbox-gl-native/blob/master/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMapOptions.java
      * @link https://docs.mapbox.com/android/api/map-sdk/7.1.2/com/mapbox/mapboxsdk/maps/MapboxMapOptions.html
      */
-    _getMapboxMapOptions(settings: any): com.mapbox.mapboxsdk.maps.MapboxMapOptions;
+    _getMapboxMapOptions(settings: ShowOptions): com.mapbox.mapboxsdk.maps.MapboxMapOptions;
+    private static mapPositionToGravity;
     /**
      * convert string to camera mode constant.
      *

package/index.android.js

@@ -4,10 +4,10 @@
  * @todo FIXME: The gcFix() implementation currently assumes only one map visible at a time.
  */
 import { request } from '@nativescript-community/perms';
-import { AndroidApplication, Application, Color, File, Http, Image, ImageSource, Trace, Utils, knownFolders, path } from '@nativescript/core';
+import { AndroidApplication, Application, Color, File, Http, ImageSource, Trace, Utils, knownFolders, path } from '@nativescript/core';
 import { ExpressionParser } from './expression/expression-parser';
 import { Layer, LayerFactory } from './layers/layer-factory';
-import { CLog, CLogTypes, MapStyle, MapboxCommon, MapboxTraceCategory, MapboxViewBase, telemetryProperty } from './common';
+import { CLog, CLogTypes, ControlPosition, MapStyle, MapboxCommon, MapboxViewBase, telemetryProperty } from './common';
 // Export the enums for devs not using TS
 export * from './common';
 let libraryLoadedOverloaded = false;
@@ -987,19 +987,16 @@ export class Mapbox extends MapboxCommon {
             }
         });
     }
-    async addImage(imageId, image, nativeMap) {
-        return new Promise((resolve, reject) => {
+    async addImage(imageId, imagePath, nativeMap) {
+        return new Promise(async (resolve, reject) => {
             const theMap = nativeMap || this._mapboxMapInstance;
             if (!theMap) {
                 reject('No map has been loaded');
                 return;
             }
-            if (!image.startsWith('res://')) {
-                image = path.join(knownFolders.currentApp().path, image.replace('~/', ''));
-            }
-            const img = ImageSource.fromFileOrResourceSync(image);
             try {
-                theMap.getStyle().addImage(imageId, img.android);
+                const imageSource = await this.fetchImageSource(imagePath);
+                theMap.getStyle().addImage(imageId, imageSource.android);
                 resolve();
             }
             catch (ex) {
@@ -2521,12 +2518,15 @@ export class Mapbox extends MapboxCommon {
     _getMapboxMapOptions(settings) {
         const mapboxMapOptions = new com.mapbox.mapboxsdk.maps.MapboxMapOptions()
             .compassEnabled(!settings.hideCompass)
+            .compassGravity(Mapbox.mapPositionToGravity(settings.compassPosition))
             .rotateGesturesEnabled(!settings.disableRotation)
             .scrollGesturesEnabled(!settings.disableScroll)
             .tiltGesturesEnabled(!settings.disableTilt)
             .zoomGesturesEnabled(!settings.disableZoom)
             .attributionEnabled(!settings.hideAttribution)
-            .logoEnabled(!settings.hideLogo);
+            .attributionGravity(Mapbox.mapPositionToGravity(settings.attributionPosition))
+            .logoEnabled(!settings.hideLogo)
+            .logoGravity(Mapbox.mapPositionToGravity(settings.logoPosition));
         // zoomlevel is not applied unless center is set
         if (settings.zoomLevel && !settings.center) {
             // Eiffel tower, Paris
@@ -2543,6 +2543,18 @@ export class Mapbox extends MapboxCommon {
         }
         return mapboxMapOptions;
     }
+    static mapPositionToGravity(position) {
+        switch (position) {
+            case ControlPosition.TOP_LEFT:
+                return android.view.Gravity.TOP | android.view.Gravity.START;
+            case ControlPosition.TOP_RIGHT:
+                return android.view.Gravity.TOP | android.view.Gravity.END;
+            case ControlPosition.BOTTOM_LEFT:
+                return android.view.Gravity.BOTTOM | android.view.Gravity.START;
+            case ControlPosition.BOTTOM_RIGHT:
+                return android.view.Gravity.BOTTOM | android.view.Gravity.END;
+        }
+    }
     /**
      * convert string to camera mode constant.
      *

package/index.d.ts

@@ -43,7 +43,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
     onDestroy(nativeMap?: any): Promise<void>;
     setMapStyle(style: string | MapStyle, nativeMap?: any): Promise<void>;
     getImage(imageId: string, nativeMap?: any): Promise<ImageSource>;
-    addImage(imageId: string, image: string, nativeMap?: any): Promise<void>;
+    addImage(imageId: string, imagePath: string, nativeMap?: any): Promise<void>;
     removeImage(imageId: string, nativeMap?: any): Promise<void>;
     addMarkers(markers: MapboxMarker[], nativeMap?: any): Promise<void>;
     removeMarkers(ids?: any, nativeMap?: any): Promise<void>;

package/index.ios.d.ts

@@ -111,7 +111,7 @@ export declare class Mapbox extends MapboxCommon implements MapboxApi {
      */
     setMapStyle(style: string | MapStyle, nativeMap?: any): Promise<void>;
     getImage(imageId: string, nativeMap?: any): Promise<ImageSource>;
-    addImage(imageId: string, image: string, nativeMap?: any): Promise<void>;
+    addImage(imageId: string, imagePath: string, nativeMap?: any): Promise<void>;
     removeImage(imageId: string, nativeMap?: any): Promise<void>;
     addMarkers(markers: MapboxMarker[], nativeMap?: any): Promise<void>;
     removeMarkers(ids?: any, nativeMap?: any): Promise<void>;

package/index.ios.js

@@ -1,5 +1,5 @@
 import { Color, File, Http, ImageSource, Trace, Utils, knownFolders, path } from '@nativescript/core';
-import { CLog, CLogTypes, MapStyle, MapboxCommon, MapboxTraceCategory, MapboxViewBase, telemetryProperty } from './common';
+import { CLog, CLogTypes, ControlPosition, MapStyle, MapboxCommon, MapboxViewBase, telemetryProperty } from './common';
 import { Layer, LayerFactory } from './layers/layer-factory';
 import { ExpressionParser } from './expression/expression-parser';
 var MGLMapViewDelegateImpl = /** @class */ (function (_super) {
@@ -403,8 +403,11 @@ let _markers = [];
 const _markerIconDownloadCache = [];
 const _setMapboxMapOptions = (mapView, settings) => {
     mapView.logoView.hidden = settings.hideLogo;
+    mapView.logoViewPosition = _mapControlPositionToOrnamentPosition(settings.logoPosition);
     mapView.attributionButton.hidden = settings.hideAttribution;
+    mapView.attributionButtonPosition = _mapControlPositionToOrnamentPosition(settings.attributionPosition);
     mapView.compassView.hidden = settings.hideCompass;
+    mapView.compassViewPosition = _mapControlPositionToOrnamentPosition(settings.compassPosition);
     mapView.rotateEnabled = !settings.disableRotation;
     mapView.scrollEnabled = !settings.disableScroll;
     mapView.zoomEnabled = !settings.disableZoom;
@@ -419,6 +422,18 @@ const _setMapboxMapOptions = (mapView, settings) => {
     mapView.showsUserLocation = settings.showUserLocation;
     mapView.autoresizingMask = 2 /* UIViewAutoresizing.FlexibleWidth */ | 16 /* UIViewAutoresizing.FlexibleHeight */;
 };
+const _mapControlPositionToOrnamentPosition = (position) => {
+    switch (position) {
+        case ControlPosition.TOP_LEFT:
+            return 0 /* MGLOrnamentPosition.TopLeft */;
+        case ControlPosition.TOP_RIGHT:
+            return 1 /* MGLOrnamentPosition.TopRight */;
+        case ControlPosition.BOTTOM_LEFT:
+            return 2 /* MGLOrnamentPosition.BottomLeft */;
+        case ControlPosition.BOTTOM_RIGHT:
+            return 3 /* MGLOrnamentPosition.BottomRight */;
+    }
+};
 const _getMapStyle = (input) => {
     if (input.startsWith('mapbox://styles') || input.startsWith('http://') || input.startsWith('https://')) {
         return NSURL.URLWithString(input);
@@ -998,20 +1013,16 @@ export class Mapbox extends MapboxCommon {
             }
         });
     }
-    async addImage(imageId, image, nativeMap) {
-        return new Promise((resolve, reject) => {
+    async addImage(imageId, imagePath, nativeMap) {
+        return new Promise(async (resolve, reject) => {
             const theMap = nativeMap || this._mapboxViewInstance;
             if (!theMap) {
                 reject('No map has been loaded');
                 return;
             }
-            if (!image.startsWith('res://')) {
-                const appPath = knownFolders.currentApp().path;
-                image = appPath + '/' + image.replace('~/', '');
-            }
-            const img = ImageSource.fromFileOrResourceSync(image);
             try {
-                theMap.style.setImageForName(img.ios, imageId);
+                const imageSource = await this.fetchImageSource(imagePath);
+                theMap.style.setImageForName(imageSource.ios, imageId);
                 resolve();
             }
             catch (ex) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nativescript-community/ui-mapbox",
-    "version": "6.2.23",
+    "version": "6.2.27",
     "description": "Interactive, thoroughly customizable maps powered by vector tiles and OpenGL.",
     "main": "index",
     "typings": "index.d.ts",
@@ -54,5 +54,5 @@
     "dependencies": {
         "@nativescript-community/perms": "^2.3.0"
     },
-    "gitHead": "48aa53e1c2ab793bc664069245b6418399c11aa4"
+    "gitHead": "fa5f56e40f5345d2a09fd7518db482b5559f94af"
 }