@rnmapbox/maps 10.1.33 → 10.1.36

package/lib/commonjs/plugin/build/generateCode.js

@@ -0,0 +1,107 @@
+"use strict";
+/**
+ * Taken from @expo/config-plugins
+ *
+ * Sourcecode: https://github.com/expo/expo/blob/59ece3cb1d5a7aaea42f4c7fe9d1f4f825b338f8/packages/@expo/config-plugins/src/utils/generateCode.ts
+ * LICENSE: https://github.com/expo/expo/blob/59ece3cb1d5a7aaea42f4c7fe9d1f4f825b338f8/packages/@expo/config-plugins/LICENSE
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHash = exports.createGeneratedHeaderComment = exports.removeGeneratedContents = exports.removeContents = exports.mergeContents = void 0;
+/**
+ * Get line indexes for the generated section of a file.
+ *
+ * @param src
+ */
+const crypto_1 = __importDefault(require("crypto"));
+function getGeneratedSectionIndexes(src, tag) {
+    const contents = src.split('\n');
+    const start = contents.findIndex((line) => line.includes(`@generated begin ${tag}`));
+    const end = contents.findIndex((line) => line.includes(`@generated end ${tag}`));
+    return { contents, start, end };
+}
+/**
+ * Merge the contents of two files together and add a generated header.
+ *
+ * @param src contents of the original file
+ * @param newSrc new contents to merge into the original file
+ * @param identifier used to update and remove merges
+ * @param anchor regex to where the merge should begin
+ * @param offset line offset to start merging at (<1 for behind the anchor)
+ * @param comment comment style `//` or `#`
+ */
+function mergeContents({ src, newSrc, tag, anchor, offset, comment, }) {
+    const header = createGeneratedHeaderComment(newSrc, tag, comment);
+    if (!src.includes(header)) {
+        // Ensure the old generated contents are removed.
+        const sanitizedTarget = removeGeneratedContents(src, tag);
+        return {
+            contents: addLines(sanitizedTarget ?? src, anchor, offset, [
+                header,
+                ...newSrc.split('\n'),
+                `${comment} @generated end ${tag}`,
+            ]),
+            didMerge: true,
+            didClear: !!sanitizedTarget,
+        };
+    }
+    return { contents: src, didClear: false, didMerge: false };
+}
+exports.mergeContents = mergeContents;
+function removeContents({ src, tag, }) {
+    // Ensure the old generated contents are removed.
+    const sanitizedTarget = removeGeneratedContents(src, tag);
+    return {
+        contents: sanitizedTarget ?? src,
+        didMerge: false,
+        didClear: !!sanitizedTarget,
+    };
+}
+exports.removeContents = removeContents;
+function addLines(content, find, offset, toAdd) {
+    const lines = content.split('\n');
+    let lineIndex = lines.findIndex((line) => line.match(find));
+    if (lineIndex < 0) {
+        const error = new Error(`Failed to match "${find}" in contents:\n${content}`);
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        error.code = 'ERR_NO_MATCH';
+        throw error;
+    }
+    for (const newLine of toAdd) {
+        lines.splice(lineIndex + offset, 0, newLine);
+        lineIndex++;
+    }
+    return lines.join('\n');
+}
+/**
+ * Removes the generated section from a file, returns null when nothing can be removed.
+ * This sways heavily towards not removing lines unless it's certain that modifications were not made manually.
+ *
+ * @param src
+ */
+function removeGeneratedContents(src, tag) {
+    const { contents, start, end } = getGeneratedSectionIndexes(src, tag);
+    if (start > -1 && end > -1 && start < end) {
+        contents.splice(start, end - start + 1);
+        // TODO: We could in theory check that the contents we're removing match the hash used in the header,
+        // this would ensure that we don't accidentally remove lines that someone added or removed from the generated section.
+        return contents.join('\n');
+    }
+    return null;
+}
+exports.removeGeneratedContents = removeGeneratedContents;
+function createGeneratedHeaderComment(contents, tag, comment) {
+    const hashKey = createHash(contents);
+    // Everything after the `${tag} ` is unversioned and can be freely modified without breaking changes.
+    return `${comment} @generated begin ${tag} - expo prebuild (DO NOT MODIFY) ${hashKey}`;
+}
+exports.createGeneratedHeaderComment = createGeneratedHeaderComment;
+function createHash(src) {
+    // this doesn't need to be secure, the shorter the better.
+    const hash = crypto_1.default.createHash('sha1').update(src).digest('hex');
+    return `sync-${hash}`;
+}
+exports.createHash = createHash;

package/lib/commonjs/plugin/build/withMapbox.d.ts

@@ -0,0 +1,19 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+type InstallerBlockName = 'pre' | 'post';
+export type MapboxPlugProps = {
+    /**
+     * @deprecated
+     */
+    RNMapboxMapsImpl?: 'mapbox';
+    RNMapboxMapsVersion?: string;
+    RNMapboxMapsDownloadToken?: string;
+    RNMapboxMapsUseV11?: boolean;
+};
+export declare const addInstallerBlock: (src: string, blockName: InstallerBlockName) => string;
+export declare const addConstantBlock: (src: string, { RNMapboxMapsImpl, RNMapboxMapsVersion, RNMapboxMapsDownloadToken, RNMapboxMapsUseV11, }: MapboxPlugProps) => string;
+export declare const applyCocoaPodsModifications: (contents: string, { RNMapboxMapsImpl, RNMapboxMapsVersion, RNMapboxMapsDownloadToken, RNMapboxMapsUseV11, }: MapboxPlugProps) => string;
+export declare const addMapboxInstallerBlock: (src: string, blockName: InstallerBlockName) => string;
+export declare const addMapboxMavenRepo: (src: string) => string;
+declare const _default: ConfigPlugin<MapboxPlugProps>;
+export default _default;
+export { addMapboxMavenRepo as _addMapboxMavenRepo, };

package/lib/commonjs/plugin/build/withMapbox.js

@@ -0,0 +1,291 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._addMapboxMavenRepo = exports.addMapboxMavenRepo = exports.addMapboxInstallerBlock = exports.applyCocoaPodsModifications = exports.addConstantBlock = exports.addInstallerBlock = 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("./generateCode");
+let pkg = {
+    name: '@rnmapbox/maps',
+};
+try {
+    pkg = require('@rnmapbox/maps/package.json');
+}
+catch {
+    // empty catch block
+}
+const 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;
+const addConstantBlock = (src, { RNMapboxMapsImpl, RNMapboxMapsVersion, RNMapboxMapsDownloadToken, RNMapboxMapsUseV11, }) => {
+    const tag = `@rnmapbox/maps-rnmapboxmapsimpl`;
+    if (RNMapboxMapsVersion == null &&
+        RNMapboxMapsDownloadToken == null &&
+        RNMapboxMapsUseV11 == null) {
+        const modified = (0, generateCode_1.removeGeneratedContents)(src, tag);
+        if (!modified) {
+            return src;
+        }
+        else {
+            return modified;
+        }
+    }
+    const newSrc = [];
+    if (RNMapboxMapsDownloadToken) {
+        newSrc.push(`$RNMapboxMapsDownloadToken = '${RNMapboxMapsDownloadToken}'`);
+    }
+    if (RNMapboxMapsImpl) {
+        newSrc.push(`$RNMapboxMapsImpl = '${RNMapboxMapsImpl}'`);
+    }
+    if (RNMapboxMapsVersion) {
+        newSrc.push(`$RNMapboxMapsVersion = '${RNMapboxMapsVersion}'`);
+    }
+    if (RNMapboxMapsUseV11) {
+        newSrc.push(`$RNMapboxMapsUseV11 = true`);
+    }
+    return (0, generateCode_1.mergeContents)({
+        tag,
+        src,
+        newSrc: newSrc.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;
+// Only the preinstaller block is required, the post installer block is
+// used for spm (swift package manager) which Expo doesn't currently support.
+const applyCocoaPodsModifications = (contents, { RNMapboxMapsImpl, RNMapboxMapsVersion, RNMapboxMapsDownloadToken, RNMapboxMapsUseV11, }) => {
+    // Ensure installer blocks exist
+    let src = (0, exports.addConstantBlock)(contents, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsVersion,
+        RNMapboxMapsDownloadToken,
+        RNMapboxMapsUseV11,
+    });
+    src = (0, exports.addInstallerBlock)(src, 'pre');
+    src = (0, exports.addInstallerBlock)(src, 'post');
+    src = (0, exports.addMapboxInstallerBlock)(src, 'pre');
+    src = (0, exports.addMapboxInstallerBlock)(src, 'post');
+    return src;
+};
+exports.applyCocoaPodsModifications = applyCocoaPodsModifications;
+const addMapboxInstallerBlock = (src, blockName) => (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;
+/**
+ * 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
+ */
+const withCocoaPodsInstallerBlocks = (config, { RNMapboxMapsImpl, RNMapboxMapsVersion, RNMapboxMapsDownloadToken, RNMapboxMapsUseV11, }) => (0, config_plugins_1.withDangerousMod)(config, [
+    'ios',
+    async (exportedConfig) => {
+        const file = path_1.default.join(exportedConfig.modRequest.platformProjectRoot, 'Podfile');
+        const contents = await fs_1.promises.readFile(file, 'utf8');
+        await fs_1.promises.writeFile(file, (0, exports.applyCocoaPodsModifications)(contents, {
+            RNMapboxMapsImpl,
+            RNMapboxMapsVersion,
+            RNMapboxMapsDownloadToken,
+            RNMapboxMapsUseV11,
+        }), 'utf-8');
+        return exportedConfig;
+    },
+]);
+const withAndroidPropertiesDownloadToken = (config, { RNMapboxMapsDownloadToken }) => {
+    const key = 'MAPBOX_DOWNLOADS_TOKEN';
+    if (RNMapboxMapsDownloadToken) {
+        return (0, config_plugins_1.withGradleProperties)(config, (exportedConfig) => {
+            exportedConfig.modResults = exportedConfig.modResults.filter((item) => !(item.type === 'property' && item.key === key));
+            exportedConfig.modResults.push({
+                type: 'property',
+                key,
+                value: RNMapboxMapsDownloadToken,
+            });
+            return exportedConfig;
+        });
+    }
+    return config;
+};
+const withAndroidPropertiesImpl2 = (config, { RNMapboxMapsImpl, RNMapboxMapsVersion, RNMapboxMapsUseV11 }) => {
+    const keyValues = {
+        expoRNMapboxMapsImpl: RNMapboxMapsImpl,
+        expoRNMapboxMapsVersion: RNMapboxMapsVersion,
+        expoRNMapboxMapsUseV11: RNMapboxMapsUseV11,
+    };
+    const keys = Object.keys(keyValues);
+    const values = Object.values(keyValues);
+    if (values.filter((v) => v).length > 0) {
+        return (0, config_plugins_1.withGradleProperties)(config, (exportedConfig) => {
+            exportedConfig.modResults = exportedConfig.modResults.filter((item) => !(item.type === 'property' && keys.includes(item.key)));
+            keys.forEach((key) => {
+                const value = keyValues[key];
+                if (value != null) {
+                    exportedConfig.modResults.push({
+                        type: 'property',
+                        key: key,
+                        value: value.toString(),
+                    });
+                }
+            });
+            return exportedConfig;
+        });
+    }
+    return config;
+};
+const withAndroidProperties = (config, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken, RNMapboxMapsVersion, RNMapboxMapsUseV11, }) => {
+    config = withAndroidPropertiesDownloadToken(config, {
+        RNMapboxMapsDownloadToken,
+    });
+    config = withAndroidPropertiesImpl2(config, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsVersion,
+        RNMapboxMapsUseV11,
+    });
+    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;
+};
+// Because we need the package to be added AFTER the React and Google maven packages, we create a new allprojects.
+// It's ok to have multiple allprojects.repositories, so we create a new one since it's cheaper than tokenizing
+// the existing block to find the correct place to insert our mapbox maven.
+const gradleMaven = `
+allprojects {
+  repositories {
+    maven {
+      url 'https://api.mapbox.com/downloads/v2/releases/maven'
+      authentication { basic(BasicAuthentication) }
+      credentials {
+        username = 'mapbox'
+        password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: ""
+      }
+    }
+  }
+}
+`;
+// Fork of config-plugins mergeContents, but appends the contents to the end of the file.
+const appendContents = ({ src, newSrc, tag, comment, }) => {
+    const header = (0, generateCode_1.createGeneratedHeaderComment)(newSrc, tag, comment);
+    if (!src.includes(header)) {
+        // Ensure the old generated contents are removed.
+        const sanitizedTarget = (0, generateCode_1.removeGeneratedContents)(src, tag);
+        const contentsToAdd = [
+            // @something
+            header,
+            // contents
+            newSrc,
+            // @end
+            `${comment} @generated end ${tag}`,
+        ].join('\n');
+        return {
+            contents: sanitizedTarget ?? src + contentsToAdd,
+            didMerge: true,
+            didClear: !!sanitizedTarget,
+        };
+    }
+    return { contents: src, didClear: false, didMerge: false };
+};
+const addMapboxMavenRepo = (src) => appendContents({
+    tag: '@rnmapbox/maps-v2-maven',
+    src,
+    newSrc: gradleMaven,
+    comment: '//',
+}).contents;
+exports.addMapboxMavenRepo = addMapboxMavenRepo;
+exports._addMapboxMavenRepo = exports.addMapboxMavenRepo;
+const withAndroidAppGradle = (config) => (0, config_plugins_1.withAppBuildGradle)(config, ({ modResults, ...exportedConfig }) => {
+    if (modResults.language !== 'groovy') {
+        config_plugins_1.WarningAggregator.addWarningAndroid('withMapbox', `Cannot automatically configure app build.gradle if it's not groovy`);
+        return { modResults, ...exportedConfig };
+    }
+    modResults.contents = addLibCppFilter(modResults.contents);
+    return { modResults, ...exportedConfig };
+});
+const withAndroidProjectGradle = (config) => (0, config_plugins_1.withProjectBuildGradle)(config, ({ modResults, ...exportedConfig }) => {
+    if (modResults.language !== 'groovy') {
+        config_plugins_1.WarningAggregator.addWarningAndroid('withMapbox', `Cannot automatically configure app build.gradle if it's not groovy`);
+        return { modResults, ...exportedConfig };
+    }
+    modResults.contents = (0, exports.addMapboxMavenRepo)(modResults.contents);
+    return { modResults, ...exportedConfig };
+});
+const withMapboxAndroid = (config, { RNMapboxMapsImpl, RNMapboxMapsDownloadToken, RNMapboxMapsVersion, RNMapboxMapsUseV11, }) => {
+    config = withAndroidProperties(config, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsDownloadToken,
+        RNMapboxMapsVersion,
+        RNMapboxMapsUseV11,
+    });
+    config = withAndroidProjectGradle(config, { RNMapboxMapsImpl });
+    config = withAndroidAppGradle(config, { RNMapboxMapsImpl });
+    return config;
+};
+const withMapbox = (config, { RNMapboxMapsImpl, RNMapboxMapsVersion, RNMapboxMapsDownloadToken, RNMapboxMapsUseV11, }) => {
+    config = withMapboxAndroid(config, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsVersion,
+        RNMapboxMapsUseV11,
+        RNMapboxMapsDownloadToken,
+    });
+    config = withCocoaPodsInstallerBlocks(config, {
+        RNMapboxMapsImpl,
+        RNMapboxMapsVersion,
+        RNMapboxMapsDownloadToken,
+        RNMapboxMapsUseV11,
+    });
+    return config;
+};
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withMapbox, pkg.name, pkg.version);

package/lib/commonjs/plugin/copy-plugin.ts

@@ -0,0 +1,56 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+const rootDir = path.resolve(__dirname, '..');
+const destDir = path.resolve(rootDir, 'lib/commonjs');
+const pluginDir = path.resolve(rootDir, 'plugin');
+const appPluginFile = path.resolve(rootDir, 'app.plugin.js');
+
+function copyFileSync(source: string, target: string) {
+  let targetFile = target;
+
+  // If target is a directory, a new file with the same name will be created
+  if (fs.existsSync(target)) {
+    if (fs.lstatSync(target).isDirectory()) {
+      targetFile = path.join(target, path.basename(source));
+    }
+  }
+
+  fs.writeFileSync(targetFile, fs.readFileSync(source));
+}
+
+function copyFolderRecursiveSync(source: string, target: string) {
+  let files = [];
+
+  // Check if folder needs to be created or integrated
+  const targetFolder = path.join(target, path.basename(source));
+  if (!fs.existsSync(targetFolder)) {
+    fs.mkdirSync(targetFolder);
+  }
+
+  // Copy
+  if (fs.lstatSync(source).isDirectory()) {
+    files = fs.readdirSync(source);
+    files.forEach((file) => {
+      const curSource = path.join(source, file);
+      if (fs.lstatSync(curSource).isDirectory()) {
+        copyFolderRecursiveSync(curSource, targetFolder);
+      } else {
+        copyFileSync(curSource, targetFolder);
+      }
+    });
+  }
+}
+
+// Ensure destination directory exists
+if (!fs.existsSync(destDir)) {
+  fs.mkdirSync(destDir, { recursive: true });
+}
+
+// Copy app.plugin.js
+copyFileSync(appPluginFile, destDir);
+
+// Copy plugin folder
+copyFolderRecursiveSync(pluginDir, destDir);
+
+console.log('Files copied successfully.');

package/lib/commonjs/plugin/install.md

@@ -0,0 +1,110 @@
+# Expo Installation
+
+> :warning: 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 [`expo`](https://docs.expo.io/workflow/expo-cli/#expo-install), [`yarn`or `npm`](../README.md#step-1---install-package).
+
+Install the latest release:
+```sh
+expo install @rnmapbox/maps
+```
+
+## Plugin Configuration
+
+After installing this 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,config.js,config.ts}`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@rnmapbox/maps",
+        {
+          "RNMapboxMapsVersion": "11.8.0"
+        }
+      ]
+    ]
+  }
+}
+```
+
+You'll need to provide `RNMapboxMapsDownloadToken` as well. This secret token requires the `DOWNLOADS:READ` scope. You can refer to the [iOS guide](https://docs.mapbox.com/ios/maps/guides/install/#configure-credentials), which explains how to configure this token under the section `Configure your secret token`.
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@rnmapbox/maps",
+        {
+          "RNMapboxMapsDownloadToken": "sk.ey...qg"
+        }
+      ]
+    ]
+  }
+}
+```
+
+If you want to show the user's current location on the map with the [UserLocation](../docs/UserLocation.md) component, you can use the [expo-location](https://docs.expo.dev/versions/latest/sdk/location/) plugin to configure the required `NSLocationWhenInUseUsageDescription` property. Install the plugin with `npx expo install expo-location` and add its config plugin to the plugins array of your `app.{json,config.js,config.ts}`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "expo-location",
+        {
+          "locationWhenInUsePermission": "Show current location on map."
+        }
+      ]
+    ]
+  }
+}
+```
+
+Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide.
+
+### Advanced Configuration
+
+It's possible to overwrite the native SDK version with `RNMapboxMapsVersion`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@rnmapbox/maps",
+        {
+          "RNMapboxMapsVersion": "10.16.2",
+          "RNMapboxMapsDownloadToken": "sk.ey...qg"
+        }
+      ]
+    ]
+  }
+}
+```
+
+To use V11 just set the version to a 11 version, see [the ios guide](/ios/install.md):
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "@rnmapbox/maps",
+        {
+          "RNMapboxMapsVersion": "11.8.0",
+          "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/lib/commonjs/plugin/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('expo-module-scripts/jest-preset-plugin');