@rnmapbox/maps 10.0.0-beta.28

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@rnmapbox/maps",
+  "description": "A Mapbox react native module for creating custom maps",
+  "version": "10.0.0-beta.28",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "React Native Mapbox Team",
+  "main": "./javascript/index.js",
+  "keywords": [
+    "gl",
+    "ios",
+    "android",
+    "mapbox",
+    "react-native"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rnmapbox/maps"
+  },
+  "scripts": {
+    "fetch:style:spec": ". ./scripts/download-style-spec.sh",
+    "generate": "node ./scripts/autogenerate",
+    "test": "npm run lint && npm run unittest",
+    "unittest": "jest",
+    "unittest:single": "jest --testNamePattern",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "type:check": "yarn tsc --noEmit",
+    "test:plugin": "expo-module test plugin",
+    "build:plugin": "tsc --build plugin",
+    "lint:plugin": "eslint plugin/src/*"
+  },
+  "peerDependencies": {
+    "prop-types": ">=15.5.8",
+    "react": ">=16.6.1",
+    "react-native": ">=0.59.9"
+  },
+  "dependencies": {
+    "@expo/config-plugins": "^4.0.3",
+    "@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.7",
+    "debounce": "^1.2.0",
+    "deprecated-react-native-prop-types": "^2.3.0"
+  },
+  "devDependencies": {
+    "@babel/core": "7.17.5",
+    "@babel/eslint-parser": "^7.17.0",
+    "@babel/plugin-proposal-class-properties": "7.16.7",
+    "@babel/runtime": "7.17.2",
+    "@react-native-community/eslint-config": "^3.0.1",
+    "@sinonjs/fake-timers": "^8.0.1",
+    "@testing-library/react-native": "^8.0.0",
+    "@types/react-native": ">=0.59.9",
+    "@typescript-eslint/eslint-plugin": "^5.20.0",
+    "@typescript-eslint/parser": "^5.20.0",
+    "babel-jest": "^27.5.1",
+    "documentation": "13.2.5",
+    "ejs": "^3.1.3",
+    "ejs-lint": "^1.1.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-flowtype": "^8.0.3",
+    "eslint-plugin-fp": "^2.3.0",
+    "eslint-plugin-import": "2.25.3",
+    "expo-module-scripts": "^2.0.0",
+    "husky": "^7.0.4",
+    "jest": "27.5.1",
+    "jest-cli": "27.5.1",
+    "lint-staged": "^12.1.2",
+    "metro-react-native-babel-preset": "0.71.1",
+    "node-dir": "0.1.17",
+    "prettier": "2.6.2",
+    "react": "17.0.2",
+    "react-docgen": "6.0.0-alpha.3",
+    "react-native": "0.67.0",
+    "react-test-renderer": "17.0.2",
+    "typescript": "^4.4.3"
+  },
+  "jest": {
+    "preset": "react-native",
+    "collectCoverageFrom": [
+      "javascript/**/*.js"
+    ],
+    "setupFiles": [
+      "./setup-jest.js",
+      "./__tests__/__mocks__/react-native.mock.js"
+    ],
+    "modulePathIgnorePatterns": [
+      "example",
+      "__tests__/__mocks__",
+      "fixtures"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged && npm run generate"
+    }
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": "eslint --fix"
+  }
+}

package/plugin/build/withMapbox.d.ts

@@ -0,0 +1,17 @@
+import { ConfigPlugin, XcodeProject } from '@expo/config-plugins';
+declare type InstallerBlockName = 'pre' | 'post';
+export declare type MapboxPlugProps = {
+    RNMapboxMapsImpl?: string;
+    RNMapboxMapsDownloadToken?: string;
+};
+export declare function applyCocoaPodsModifications(contents: string, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken }: MapboxPlugProps): string;
+export declare function addConstantBlock(src: string, RNMapboxMapsImpl?: string, RNMapboxMapsDownloadToken?: string): string;
+export declare function addInstallerBlock(src: string, blockName: InstallerBlockName): string;
+export declare function addMapboxInstallerBlock(src: string, blockName: InstallerBlockName): string;
+/**
+ * Exclude building for arm64 on simulator devices in the pbxproj project.
+ * Without this, production builds targeting simulators will fail.
+ */
+export declare function setExcludedArchitectures(project: XcodeProject): XcodeProject;
+declare const _default: ConfigPlugin<MapboxPlugProps>;
+export default _default;

package/plugin/build/withMapbox.js

@@ -0,0 +1,286 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setExcludedArchitectures = exports.addMapboxInstallerBlock = exports.addInstallerBlock = exports.addConstantBlock = exports.applyCocoaPodsModifications = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const config_plugins_1 = require("@expo/config-plugins");
+const generateCode_1 = require("@expo/config-plugins/build/utils/generateCode");
+let pkg = {
+    name: '@rnmapbox/maps',
+};
+try {
+    pkg = require('@rnmapbox/maps/package.json');
+}
+catch {
+    // empty catch block
+}
+/**
+ * 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/rnmapbox/maps/blob/main/ios/install.md#react-native--0600
+ * @param config
+ * @returns
+ */
+const withCocoaPodsInstallerBlocks = (c, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken }) => {
+    return (0, config_plugins_1.withDangerousMod)(c, [
+        'ios',
+        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, {
+                RNMapboxMapsImpl,
+                RNMapboxMapsDownloadToken,
+            }), 'utf-8');
+            return config;
+        },
+    ]);
+};
+// Only the preinstaller block is required, the post installer block is
+// used for spm (swift package manager) which Expo doesn't currently support.
+function applyCocoaPodsModifications(contents, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken }) {
+    // Ensure installer blocks exist
+    let src = addConstantBlock(contents, RNMapboxMapsImpl, RNMapboxMapsDownloadToken);
+    src = addInstallerBlock(src, 'pre');
+    src = addInstallerBlock(src, 'post');
+    src = addMapboxInstallerBlock(src, 'pre');
+    src = addMapboxInstallerBlock(src, 'post');
+    return src;
+}
+exports.applyCocoaPodsModifications = applyCocoaPodsModifications;
+function addConstantBlock(src, RNMapboxMapsImpl, RNMapboxMapsDownloadToken) {
+    const tag = `@rnmapbox/maps-rnmapboxmapsimpl`;
+    if (RNMapboxMapsImpl == null) {
+        const modified = (0, generateCode_1.removeGeneratedContents)(src, tag);
+        if (!modified) {
+            return src;
+        }
+        else {
+            return modified;
+        }
+    }
+    return (0, generateCode_1.mergeContents)({
+        tag,
+        src,
+        newSrc: [
+            `$RNMapboxMapsImpl = '${RNMapboxMapsImpl}'`,
+            `$RNMapboxMapsDownloadToken = '${RNMapboxMapsDownloadToken}'`,
+        ].join('\n'),
+        anchor: /target .+ do/,
+        // We can't go after the use_react_native block because it might have parameters, causing it to be multi-line (see react-native template).
+        offset: 0,
+        comment: '#',
+    }).contents;
+}
+exports.addConstantBlock = addConstantBlock;
+function addInstallerBlock(src, blockName) {
+    const matchBlock = new RegExp(`${blockName}_install do \\|installer\\|`);
+    const tag = `${blockName}_installer`;
+    for (const line of src.split('\n')) {
+        const contents = line.trim();
+        // Ignore comments
+        if (!contents.startsWith('#')) {
+            // Prevent adding the block if it exists outside of comments.
+            if (contents.match(matchBlock)) {
+                // This helps to still allow revisions, since we enabled the block previously.
+                // Only continue if the generated block exists...
+                const modified = (0, generateCode_1.removeGeneratedContents)(src, tag);
+                if (!modified) {
+                    return src;
+                }
+            }
+        }
+    }
+    return (0, generateCode_1.mergeContents)({
+        tag,
+        src,
+        newSrc: [`  ${blockName}_install do |installer|`, '  end'].join('\n'),
+        anchor: /use_react_native/,
+        // We can't go after the use_react_native block because it might have parameters, causing it to be multi-line (see react-native template).
+        offset: 0,
+        comment: '#',
+    }).contents;
+}
+exports.addInstallerBlock = addInstallerBlock;
+function addMapboxInstallerBlock(src, blockName) {
+    return (0, generateCode_1.mergeContents)({
+        tag: `@rnmapbox/maps-${blockName}_installer`,
+        src,
+        newSrc: `    $RNMapboxMaps.${blockName}_install(installer)`,
+        anchor: new RegExp(`^\\s*${blockName}_install do \\|installer\\|`),
+        offset: 1,
+        comment: '#',
+    }).contents;
+}
+exports.addMapboxInstallerBlock = addMapboxInstallerBlock;
+/**
+ * Exclude building for arm64 on simulator devices in the pbxproj project.
+ * Without this, production builds targeting simulators will fail.
+ */
+function setExcludedArchitectures(project) {
+    const configurations = project.pbxXCBuildConfigurationSection();
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    for (const { buildSettings } of Object.values(configurations || {})) {
+        // Guessing that this is the best way to emulate Xcode.
+        // Using `project.addToBuildSettings` modifies too many targets.
+        if (typeof (buildSettings === null || buildSettings === void 0 ? void 0 : buildSettings.PRODUCT_NAME) !== 'undefined') {
+            buildSettings['"EXCLUDED_ARCHS[sdk=iphonesimulator*]"'] = '"arm64"';
+        }
+    }
+    return project;
+}
+exports.setExcludedArchitectures = setExcludedArchitectures;
+const withExcludedSimulatorArchitectures = (c) => {
+    return (0, config_plugins_1.withXcodeProject)(c, (config) => {
+        config.modResults = setExcludedArchitectures(config.modResults);
+        return config;
+    });
+};
+const withAndroidPropertiesDownloadToken = (config, { RNMapboxMapsDownloadToken }) => {
+    const key = 'MAPBOX_DOWNLOADS_TOKEN';
+    if (RNMapboxMapsDownloadToken) {
+        return (0, config_plugins_1.withGradleProperties)(config, (config) => {
+            config.modResults = config.modResults.filter((item) => {
+                if (item.type === 'property' && item.key === key) {
+                    return false;
+                }
+                return true;
+            });
+            // eslint-disable-next-line fp/no-mutating-methods
+            config.modResults.push({
+                type: 'property',
+                key,
+                value: RNMapboxMapsDownloadToken,
+            });
+            return config;
+        });
+    }
+    else {
+        return config;
+    }
+};
+const withAndroidPropertiesImpl2 = (config, { RNMapboxMapsImpl }) => {
+    const key = 'expoRNMapboxMapsImpl';
+    if (RNMapboxMapsImpl) {
+        return (0, config_plugins_1.withGradleProperties)(config, (config) => {
+            config.modResults = config.modResults.filter((item) => {
+                if (item.type === 'property' && item.key === key) {
+                    return false;
+                }
+                return true;
+            });
+            // eslint-disable-next-line fp/no-mutating-methods
+            config.modResults.push({
+                type: 'property',
+                key: key,
+                value: RNMapboxMapsImpl,
+            });
+            return config;
+        });
+    }
+    else {
+        return config;
+    }
+};
+const withAndroidProperties = (config, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken }) => {
+    config = withAndroidPropertiesDownloadToken(config, {
+        RNMapboxMapsDownloadToken,
+    });
+    config = withAndroidPropertiesImpl2(config, { RNMapboxMapsImpl });
+    return config;
+};
+const addLibCppFilter = (appBuildGradle) => {
+    if (appBuildGradle.includes("pickFirst 'lib/x86/libc++_shared.so'"))
+        return appBuildGradle;
+    return (0, generateCode_1.mergeContents)({
+        tag: `@rnmapbox/maps-libcpp`,
+        src: appBuildGradle,
+        newSrc: `packagingOptions {
+        pickFirst 'lib/x86/libc++_shared.so'
+        pickFirst 'lib/x86_64/libc++_shared.so'
+        pickFirst 'lib/arm64-v8a/libc++_shared.so'
+        pickFirst 'lib/armeabi-v7a/libc++_shared.so'
+    }`,
+        anchor: new RegExp(`^\\s*android\\s*{`),
+        offset: 1,
+        comment: '//',
+    }).contents;
+};
+const addMapboxMavenRepo = (projectBuildGradle) => {
+    if (projectBuildGradle.includes('api.mapbox.com/downloads/v2/releases/maven'))
+        return projectBuildGradle;
+    /*
+    return projectBuildGradle.replace(
+      /repositories \s?{/,
+      `repositories {
+         maven {
+          url 'https://api.mapbox.com/downloads/v2/releases/maven'
+          authentication { basic(BasicAuthentication) }
+          credentials {
+            username = 'mapbox'
+            password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: ""
+          }
+         }
+    `,
+    );*/
+    return (0, generateCode_1.mergeContents)({
+        tag: `@rnmapbox/maps-v2-maven`,
+        src: projectBuildGradle,
+        newSrc: `maven {
+      url 'https://api.mapbox.com/downloads/v2/releases/maven'
+      authentication { basic(BasicAuthentication) }
+      credentials {
+        username = 'mapbox'
+        password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: ""
+      }
+    }`,
+        anchor: new RegExp(`^\\s*allprojects\\s*{`),
+        offset: 2,
+        comment: '//',
+    }).contents;
+};
+const withAndroidAppGradle = (config) => {
+    return (0, config_plugins_1.withAppBuildGradle)(config, ({ modResults, ...config }) => {
+        if (modResults.language !== 'groovy') {
+            config_plugins_1.WarningAggregator.addWarningAndroid('withMapbox', `Cannot automatically configure app build.gradle if it's not groovy`);
+            return { modResults, ...config };
+        }
+        modResults.contents = addLibCppFilter(modResults.contents);
+        return { modResults, ...config };
+    });
+};
+const withAndroidProjectGradle = (config) => {
+    return (0, config_plugins_1.withProjectBuildGradle)(config, ({ modResults, ...config }) => {
+        if (modResults.language !== 'groovy') {
+            config_plugins_1.WarningAggregator.addWarningAndroid('withMapbox', `Cannot automatically configure app build.gradle if it's not groovy`);
+            return { modResults, ...config };
+        }
+        modResults.contents = addMapboxMavenRepo(modResults.contents);
+        return { modResults, ...config };
+    });
+};
+const withMapboxAndroid = (config, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken }) => {
+    config = withAndroidProperties(config, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsDownloadToken,
+    });
+    config = withAndroidProjectGradle(config, { RNMapboxMapsImpl });
+    config = withAndroidAppGradle(config, { RNMapboxMapsImpl });
+    return config;
+};
+const withMapbox = (config, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken }) => {
+    config = withExcludedSimulatorArchitectures(config);
+    config = withMapboxAndroid(config, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsDownloadToken,
+    });
+    return withCocoaPodsInstallerBlocks(config, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsDownloadToken,
+    });
+};
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withMapbox, pkg.name, pkg.version);

package/plugin/install.md

@@ -0,0 +1,53 @@
+# Expo installation
+
+> This package cannot be used in the "Expo Go" app because [it requires custom native code](https://docs.expo.io/workflow/customizing/).
+
+First install the package with yarn, npm, or [`expo install rnmapbox/maps#main`](https://docs.expo.io/workflow/expo-cli/#expo-install).
+
+```sh
+expo install rnmapbox/maps#main
+```
+
+After installing this npm package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@rnmapbox/maps",
+        {
+          "RNMapboxMapsImpl": "maplibre"
+        }
+      ]
+    ]
+  }
+}
+```
+
+Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide.
+
+For `mapbox` or `mapbox-gl` you'll need to provide `RNMapboxMapsDownloadToken` as well.
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@rnmapbox/maps",
+        {
+          "RNMapboxMapsImpl": "maplibre",
+          "RNMapboxMapsDownloadToken": "sk.ey...qg"
+        }
+      ]
+    ]
+  }
+}
+```
+
+## Manual Setup
+
+For bare workflow projects, you can follow the manual setup guides:
+
+- [iOS](/ios/install.md)
+- [Android](/android/install.md)

package/react-native.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  dependency: {
+    platforms: {
+      ios: {
+        project: 'true',
+      },
+      android: {
+        sourceDir: './android/rctmgl',
+      },
+    },
+  },
+};