@maplibre/maplibre-react-native 10.0.0-alpha.9 → 10.0.0-beta.2

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@maplibre/maplibre-react-native",
-  "description": "A MapLibre GL Native plugin for creating maps in React Native",
-  "version": "10.0.0-alpha.9",
+  "description": "React Native library for creating maps with MapLibre Native for Android & iOS",
+  "version": "10.0.0-beta.2",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "author": "MapLibre",
-  "main": "./javascript/index.ts",
   "keywords": [
     "maps",
     "ios",
@@ -16,126 +16,157 @@
     "mapbox"
   ],
   "license": "MIT",
+  "homepage": "https://github.com/maplibre/maplibre-react-native#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/maplibre/maplibre-react-native"
+    "url": "git+https://github.com/maplibre/maplibre-react-native.git"
+  },
+  "bugs": {
+    "url": "https://github.com/maplibre/maplibre-react-native/issues"
   },
   "scripts": {
-    "fetch:style:spec": "./scripts/download-style-spec.sh",
-    "generate": "yarn node ./scripts/autogenerate",
-    "test": "npm run lint && npm run unittest",
-    "unittest": "jest",
-    "unittest:single": "jest --testNamePattern",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "lint:single": "eslint",
-    "prepack": "pinst --disable && yarn build:plugin",
-    "test:plugin": "jest plugin",
-    "build:plugin": "tsc --build plugin",
-    "lint:plugin": "eslint plugin/src/*",
-    "postpack": "pinst --enable",
-    "typescript:check": "tsc -p ./tsconfig.json --noEmit"
+    "codegen": "tsx scripts/codegen.ts",
+    "test": "jest",
+    "lint": "yarn lint:tsc && yarn lint:eslint",
+    "lint:tsc": "tsc --project ./ && tsc --project ./packages/examples",
+    "lint:eslint": "eslint ./ --max-warnings 0",
+    "lint:eslint:fix": "yarn lint:eslint --fix",
+    "plugin:build": "tsc --build ./plugin",
+    "plugin:lint": "yarn plugin:lint:tsc && yarn plugin:lint:eslint",
+    "plugin:lint:tsc": "tsc --noEmit --project ./plugin",
+    "plugin:lint:eslint": "eslint ./plugin/src/* --max-warnings 0",
+    "plugin:test": "jest ./plugin",
+    "prepack": "bob build && yarn plugin:build"
   },
-  "peerDependenciesMeta": {
-    "@expo/config-plugins": {
-      "optional": true
+  "workspaces": [
+    "packages/*"
+  ],
+  "packageManager": "yarn@4.1.0",
+  "main": "./lib/commonjs/index.js",
+  "source": "./src/index.ts",
+  "module": "./lib/module/index.js",
+  "types": "./lib/typescript/commonjs/src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/typescript/module/src/index.d.ts",
+        "default": "./lib/module/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/src/index.d.ts",
+        "default": "./lib/commonjs/index.js"
+      }
+    },
+    "./app.plugin.js": {
+      "require": {
+        "default": "./app.plugin.js"
+      }
+    },
+    "./plugin": {
+      "require": {
+        "types": "./plugin/build/witMapLibre.d.ts",
+        "default": "./plugin/build/withMapLibre.js"
+      }
     }
   },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.json",
+    "app.plugin.js",
+    "plugin/build/**",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "esm": true,
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
   "peerDependencies": {
     "@expo/config-plugins": ">=7",
+    "@types/geojson": "^7946.0.0",
+    "@types/react": ">=16.6.1",
     "react": ">=16.6.1",
     "react-native": ">=0.59.9"
   },
+  "peerDependenciesMeta": {
+    "@expo/config-plugins": {
+      "optional": true
+    },
+    "@types/geojson": {
+      "optional": true
+    },
+    "@types/react": {
+      "optional": true
+    }
+  },
   "dependencies": {
-    "@mapbox/geo-viewport": ">= 0.4.0",
-    "@turf/along": "6.5.0",
-    "@turf/distance": "6.5.0",
-    "@turf/helpers": "6.5.0",
-    "@turf/length": "6.5.0",
-    "@turf/nearest-point-on-line": "6.5.0",
-    "@types/geojson": "^7946.0.10",
-    "@types/react-native": "0.67.8",
-    "debounce": "^2.0.0"
+    "@turf/distance": "^7.1.0",
+    "@turf/helpers": "^7.1.0",
+    "@turf/length": "^7.1.0",
+    "@turf/nearest-point-on-line": "^7.1.0",
+    "debounce": "^2.2.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.5",
-    "@babel/eslint-parser": "^7.22.9",
-    "@babel/plugin-proposal-class-properties": "7.18.6",
-    "@babel/runtime": "7.17.2",
-    "@expo/config-plugins": "^7.2.5",
-    "@react-native/eslint-config": "^0.73.2",
-    "@react-native/eslint-plugin": "^0.74.0",
-    "@react-native/metro-config": "^0.72.7",
-    "@sinonjs/fake-timers": "^11.2.2",
-    "@testing-library/react-native": "^12.4.3",
-    "@tsconfig/node14": "^14.1.0",
-    "@types/debounce": "^1.2.1",
-    "@types/jest": "^29.5.12",
-    "@types/mapbox__geo-viewport": "^0.4.1",
-    "@types/node": "^18.11.18",
-    "@types/react": "^18.2.15",
-    "@typescript-eslint/eslint-plugin": "^7.16.0",
-    "@typescript-eslint/parser": "^7.16.0",
-    "babel-jest": "^29.6.0",
+    "@babel/core": "^7.26.0",
+    "@expo/config-plugins": "^9.0.11",
+    "@maplibre/maplibre-gl-style-spec": "22.0.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@sinonjs/fake-timers": "^13.0.5",
+    "@testing-library/react-native": "^12.9.0",
+    "@types/ejs": "^3.1.5",
+    "@types/geojson": "^7946.0.14",
+    "@types/node": "^22.10.1",
+    "@types/react": "^18.3.13",
     "documentation": "^14.0.0",
-    "ejs": "^3.1.3",
-    "ejs-lint": "^2.0.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-universe": "13.0.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-prettier": "^5.1.3",
-    "expo-module-scripts": "^3.1.0",
-    "husky": "^9.0.10",
+    "ejs": "^3.1.10",
+    "eslint": "^8.57.1",
+    "eslint-config-universe": "14.0.0",
+    "expo-module-scripts": "^4.0.2",
     "jest": "^29.7.0",
-    "jest-cli": "^29.7.0",
-    "lint-staged": "^15.2.2",
-    "metro-react-native-babel-preset": "^0.76.7",
-    "node-dir": "0.1.17",
-    "pinst": "^3.0.0",
-    "prettier": "^3.3.3",
-    "react": "^18.2.0",
-    "react-docgen": "rnmapbox/react-docgen#rnmapbox-dist",
-    "react-native": "0.72.1",
-    "react-test-renderer": "^18.2.0",
-    "typescript": "^5.3.3"
-  },
-  "jest": {
-    "preset": "react-native",
-    "collectCoverageFrom": [
-      "javascript/**/*.js"
-    ],
-    "setupFiles": [
-      "./setup-jest.js",
-      "./__tests__/__mocks__/react-native.mock.js"
-    ],
-    "modulePathIgnorePatterns": [
-      "example",
-      "__tests__/__mocks__",
-      "fixtures"
-    ]
-  },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx}": "yarn lint"
-  },
-  "eslintConfig": {
-    "root": true,
-    "extends": [
-      "prettier",
-      "universe/native"
-    ],
-    "ignorePatterns": [
-      "node_modules/*",
-      "*.js",
-      "**/dist/*.js",
-      "/plugin/build"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": "error"
-    }
-  },
-  "packageManager": "yarn@4.1.0"
-}
+    "prettier": "3.4.2",
+    "react": "18.3.1",
+    "react-docgen": "^7.1.0",
+    "react-native": "0.75.4",
+    "react-native-builder-bob": "^0.34.0",
+    "react-test-renderer": "18.3.1",
+    "semantic-release": "^24.2.0",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
+  }
+}

package/plugin/build/withMapLibre.d.ts

@@ -1,4 +1,4 @@
-import { ConfigPlugin, XcodeProject } from "@expo/config-plugins";
+import { type ConfigPlugin, type XcodeProject } from "@expo/config-plugins";
 type InstallerBlockName = "pre" | "post";
 export declare function applyCocoaPodsModifications(contents: string): string;
 export declare function addInstallerBlock(src: string, blockName: InstallerBlockName): string;

package/plugin/build/withMapLibre.js

@@ -3,11 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setExcludedArchitectures = exports.addMapLibreInstallerBlock = exports.addInstallerBlock = exports.applyCocoaPodsModifications = void 0;
+exports.applyCocoaPodsModifications = applyCocoaPodsModifications;
+exports.addInstallerBlock = addInstallerBlock;
+exports.addMapLibreInstallerBlock = addMapLibreInstallerBlock;
+exports.setExcludedArchitectures = setExcludedArchitectures;
 const config_plugins_1 = require("@expo/config-plugins");
 const generateCode_1 = require("@expo/config-plugins/build/utils/generateCode");
-const fs_1 = require("fs");
-const path_1 = __importDefault(require("path"));
+const node_fs_1 = require("node:fs");
+const node_path_1 = __importDefault(require("node:path"));
 let pkg = {
     name: "@maplibre/maplibre-react-native",
 };
@@ -21,7 +24,7 @@ catch {
  * Dangerously adds the custom installer hooks to the Podfile.
  * In the future this should be removed in favor of some custom hooks provided by Expo autolinking.
  *
- * https://github.com/maplibre/maplibre-react-native/blob/main/ios/install.md
+ * https://github.com/maplibre/maplibre-react-native/blob/main/docs/guides/setup/iOS.md
  * @param config
  * @returns
  */
@@ -30,9 +33,9 @@ const withCocoaPodsInstallerBlocks = (c) => {
         "ios",
         // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
         async (config) => {
-            const file = path_1.default.join(config.modRequest.platformProjectRoot, "Podfile");
-            const contents = await fs_1.promises.readFile(file, "utf8");
-            await fs_1.promises.writeFile(file, applyCocoaPodsModifications(contents), "utf-8");
+            const file = node_path_1.default.join(config.modRequest.platformProjectRoot, "Podfile");
+            const contents = await node_fs_1.promises.readFile(file, "utf8");
+            await node_fs_1.promises.writeFile(file, applyCocoaPodsModifications(contents), "utf-8");
             return config;
         },
     ]);
@@ -47,7 +50,6 @@ function applyCocoaPodsModifications(contents) {
     src = addMapLibreInstallerBlock(src, "post");
     return src;
 }
-exports.applyCocoaPodsModifications = applyCocoaPodsModifications;
 function addInstallerBlock(src, blockName) {
     const matchBlock = new RegExp(`${blockName}_install do \\|installer\\|`);
     const tag = `${blockName}_installer`;
@@ -76,18 +78,16 @@ function addInstallerBlock(src, blockName) {
         comment: "#",
     }).contents;
 }
-exports.addInstallerBlock = addInstallerBlock;
 function addMapLibreInstallerBlock(src, blockName) {
     return (0, generateCode_1.mergeContents)({
         tag: `@maplibre/maplibre-react-native-${blockName}_installer`,
         src,
-        newSrc: `    $RCTMLN.${blockName}_install(installer)`,
+        newSrc: `    $MLRN.${blockName}_install(installer)`,
         anchor: new RegExp(`${blockName}_install do \\|installer\\|`),
         offset: 1,
         comment: "#",
     }).contents;
 }
-exports.addMapLibreInstallerBlock = addMapLibreInstallerBlock;
 /**
  * Exclude building for arm64 on simulator devices in the pbxproj project.
  * Without this, production builds targeting simulators will fail.
@@ -106,21 +106,35 @@ function setExcludedArchitectures(project) {
     }
     return project;
 }
-exports.setExcludedArchitectures = setExcludedArchitectures;
 const withoutSignatures = (config) => {
-    const shellScript = `if [ "$XCODE_VERSION_MAJOR" = "1500" ]; then
-    echo "Remove signature files (Xcode 15 workaround)";
+    const shellScript = `
+    echo "Remove signature files (Xcode workaround)";
     rm -rf "$CONFIGURATION_BUILD_DIR/MapLibre.xcframework-ios.signature";
-  fi`;
+  `;
     return (0, config_plugins_1.withXcodeProject)(config, async (config) => {
         const xcodeProject = config.modResults;
-        xcodeProject.addBuildPhase([], "PBXShellScriptBuildPhase", "Remove signature files (Xcode 15 workaround)", null, {
+        xcodeProject.addBuildPhase([], "PBXShellScriptBuildPhase", "Remove signature files (Xcode workaround)", null, {
             shellPath: "/bin/sh",
             shellScript,
         });
         return config;
     });
 };
+/**
+ *  Set the Debug Information Format to DWARF with dSYM File during EAS Build for Managed App
+ *  https://github.com/expo/eas-cli/issues/968
+ *  // Set artifactPath in eas.json
+ *  "ios": {
+ *    "artifactPath": "ios/build/*"
+ *  }
+ */
+const withDwarfDsym = (config) => {
+    return (0, config_plugins_1.withXcodeProject)(config, async (config) => {
+        const xcodeProject = config.modResults;
+        xcodeProject.debugInformationFormat = "dwarf-with-dsym";
+        return config;
+    });
+};
 const withExcludedSimulatorArchitectures = (c) => {
     return (0, config_plugins_1.withXcodeProject)(c, (config) => {
         config.modResults = setExcludedArchitectures(config.modResults);
@@ -128,7 +142,7 @@ const withExcludedSimulatorArchitectures = (c) => {
     });
 };
 const withMapLibre = (config) => {
-    config = withoutSignatures(withExcludedSimulatorArchitectures(config));
+    config = withoutSignatures(withDwarfDsym(withExcludedSimulatorArchitectures(config)));
     return withCocoaPodsInstallerBlocks(config);
 };
 exports.default = (0, config_plugins_1.createRunOncePlugin)(withMapLibre, pkg.name, pkg.version);

package/src/MLRNModule.ts

@@ -0,0 +1,46 @@
+import { NativeModules } from "react-native";
+
+import { CameraMode } from "./types/CameraMode";
+
+interface IMLRNModule {
+  CameraModes: {
+    Flight: CameraMode.Flight;
+    Ease: CameraMode.Ease;
+    Linear: CameraMode.Linear;
+    None: CameraMode.None;
+  };
+  StyleURL: {
+    Default: URL;
+  };
+  OfflinePackDownloadState: {
+    Inactive: string | number;
+    Active: string | number;
+    Complete: string | number;
+    Unknown?: string | number;
+  };
+  LineJoin: {
+    Bevel: string | number;
+    Round: string | number;
+    Miter: string | number;
+  };
+  StyleSource: {
+    DefaultSourceID: string;
+  };
+
+  setAccessToken(accessToken: string | null): Promise<string | null>;
+  getAccessToken(): Promise<string>;
+  setConnected(connected: boolean): void;
+}
+
+const MLRNModule: IMLRNModule = Object.create(NativeModules.MLRNModule);
+
+export const {
+  CameraModes,
+  StyleURL,
+  OfflinePackDownloadState,
+  LineJoin,
+  StyleSource,
+  setAccessToken,
+  getAccessToken,
+  setConnected,
+} = MLRNModule;

package/src/MapLibreRN.ts

@@ -0,0 +1,70 @@
+import { UserTrackingMode } from "./components/Camera";
+
+export * from "./MLRNModule";
+export {
+  default as Camera,
+  UserTrackingMode,
+  type CameraPadding,
+  type CameraAnimationMode,
+  type CameraBounds,
+  type CameraRef,
+} from "./components/Camera";
+export { default as MapView, type MapViewRef } from "./components/MapView";
+export { default as Light } from "./components/Light";
+export { default as PointAnnotation } from "./components/PointAnnotation";
+export type { PointAnnotationRef } from "./components/PointAnnotation";
+export { default as Annotation } from "./components/Annotation";
+export { default as Callout } from "./components/Callout";
+export { requestAndroidLocationPermissions } from "./requestAndroidLocationPermissions";
+export {
+  default as UserLocation,
+  UserLocationRenderMode,
+} from "./components/UserLocation";
+export type { UserLocationRef } from "./components/UserLocation";
+export { default as VectorSource } from "./components/VectorSource";
+export { default as ShapeSource } from "./components/ShapeSource";
+export type { ShapeSourceRef } from "./components/ShapeSource";
+export { default as RasterSource } from "./components/RasterSource";
+export { default as ImageSource } from "./components/ImageSource";
+export { default as Images } from "./components/Images";
+export { default as FillLayer } from "./components/FillLayer";
+export { default as FillExtrusionLayer } from "./components/FillExtrusionLayer";
+export { default as HeatmapLayer } from "./components/HeatmapLayer";
+export { default as LineLayer } from "./components/LineLayer";
+export { default as CircleLayer } from "./components/CircleLayer";
+export { default as SymbolLayer } from "./components/SymbolLayer";
+export { default as RasterLayer } from "./components/RasterLayer";
+export { default as BackgroundLayer } from "./components/BackgroundLayer";
+export {
+  default as locationManager,
+  type Location,
+} from "./modules/location/locationManager";
+export { default as offlineManager } from "./modules/offline/offlineManager";
+export type {
+  OfflineProgressStatus,
+  OfflinePackError,
+} from "./modules/offline/offlineManager";
+export type { OfflinePackStatus } from "./modules/offline/OfflinePack";
+export { default as OfflinePack } from "./modules/offline/OfflinePack";
+export { default as OfflineCreatePackOptions } from "./modules/offline/OfflineCreatePackOptions";
+export { default as snapshotManager } from "./modules/snapshot/snapshotManager";
+export type { SnapshotInputOptions } from "./modules/snapshot/SnapshotOptions";
+export { default as MarkerView } from "./components/MarkerView";
+export { default as Animated } from "./utils/animated/Animated";
+export { default as Style } from "./components/Style";
+export { default as Logger, type LogLevel } from "./utils/Logger";
+export type {
+  FillLayerStyleProps as FillLayerStyle,
+  LineLayerStyleProps as LineLayerStyle,
+  SymbolLayerStyleProps as SymbolLayerStyle,
+  CircleLayerStyleProps as CircleLayerStyle,
+  HeatmapLayerStyleProps as HeatmapLayerStyle,
+  FillExtrusionLayerStyleProps as FillExtrusionLayerStyle,
+  RasterLayerStyleProps as RasterLayerStyle,
+  HillshadeLayerStyleProps as HillshadeLayerStyle,
+  BackgroundLayerStyleProps as BackgroundLayerStyle,
+  LightLayerStyleProps as LightLayerStyle,
+} from "./utils/MapLibreRNStyles";
+
+/** @deprecated UserTrackingModes is deprecated use UserTrackingMode */
+export const UserTrackingModes = UserTrackingMode;