npm - react-native-background-geolocation - Versions diffs - 4.3.0 - Mend

react-native-background-geolocation 4.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (214) hide show

package/scripts/declare-module ADDED Viewed

@@ -0,0 +1,3 @@
+#!/bin/sh
+find ./src/declarations -type f -name "*.d.ts" -print0 | xargs -0 sed -i '' -e 's/declare module.*/declare module "react-native-background-geolocation" \{/g'

package/scripts/docs-index.html ADDED Viewed

@@ -0,0 +1,4 @@
+<html>
+  <meta http-equiv="refresh" content="0; URL=classes/backgroundgeolocation.backgroundgeolocation-1.html" />
+  <body></body>
+</html>

package/scripts/generate-docs ADDED Viewed

@@ -0,0 +1,23 @@
+#!/bin/sh
+echo "Analytics ID: $GA_ID"
+#typedoc --out docs --includeDeclarations --excludeExternals --listInvalidSymbolLinks --name "React Native Background Geolocation" --theme ./node_modules/typedoc-theme-transistor/src/default --mode file --gaID $GA_ID --gaSite "auto" ./src/declarations/
+typedoc --out docs \
+        --tsconfig ./scripts/tsconfig.json \
+	--excludeExternals \
+	--listInvalidSymbolLinks \
+        --readme none \
+	--name "React Native Background Geolocation" \
+	--theme node_modules/\@transistorsoft/typedoc-theme/bin/default \
+        --highlightTheme monokai \
+	--gaID $GA_ID \
+	--gaSite "auto" \
+	--plugin ./node_modules/\@transistorsoft/typedoc-theme/node_modules/\@transistorsoft/typedoc-plugin-mediaplayer \
+	--plugin ./node_modules/\@transistorsoft/typedoc-theme/node_modules/\@transistorsoft/typedoc-plugin-gitlink \
+        --plugin ./node_modules/\@transistorsoft/typedoc-theme/node_modules/typedoc-plugin-merge-modules \
+	./src/declarations/
+touch ./docs/.nojekyll

package/scripts/postlink.js ADDED Viewed

@@ -0,0 +1,146 @@
+#!/usr/bin/env node
+const path = require('path');
+const fs = require('fs');
+const xcode = require('xcode');
+const PbxFile = require('xcode/lib/pbxFile');
+const helpers = require('./xcode-helpers');
+const projectDirectory = process.cwd();
+const moduleDirectory = path.resolve(__dirname, '..');
+////
+// iOS
+//
+const sourceDirectory = path.join(projectDirectory, 'ios');
+const xcodeProjectDirectory = helpers.findProject(sourceDirectory);
+const projectConfig = {
+    sourceDir: sourceDirectory,
+    pbxprojPath: path.join(
+        projectDirectory,
+        'ios',
+        xcodeProjectDirectory,
+        'project.pbxproj'
+    ),
+};
+const pathToFramework = path.relative(
+    projectConfig.sourceDir,
+    path.join(
+        moduleDirectory,
+        'ios',
+        'RNBackgroundGeolocation',
+        'TSLocationManager.framework'
+    )
+);
+const project = xcode.project(projectConfig.pbxprojPath).parseSync();
+/**
+ * There is a method in node-xcode that offers similar functionality than what
+ * is implemented below `addFramework` (https://github.com/alunny/node-xcode/blob/ffb938b/lib/pbxProject.js#L300)
+ * but unfortunately it won't work for our use-case because there are two other
+ * methods in node-xcode that are being used by `addFramework` that don't work
+ * as expected:
+ * 1 `addToFrameworksPbxGroup` fails if no group with the name "Frameworks" exists
+ *  https://github.com/alunny/node-xcode/blob/ffb938b/lib/pbxProject.js#L641
+ *  - https://github.com/alunny/node-xcode/issues/43
+ *  - this issue could be worked around by just checking if the group exists and
+ *    creating it if it doesn't exist before executing `addFramework`
+ * 2 `addToFrameworkSearchPaths` doesn't work with react-native:
+ *  https://github.com/alunny/node-xcode/blob/ffb938b/lib/pbxProject.js#L1125
+ *  - https://github.com/alunny/node-xcode/issues/91
+ *  - https://github.com/alunny/node-xcode/pull/99
+ *  - the issue there is that https://github.com/alunny/node-xcode/blob/ffb938b/lib/pbxProject.js#L1133
+ *    in react-native projects the "PRODUCT_NAME" is "$(TARGET_NAME)", so it won't
+ *    be visited by this method.
+ *    And even if the name would be correct it still wouldn't work correctly for
+ *    react-native projects, because not all targets should get the library added
+ *    for example: react-native creates *tests and *tvOs and *tvOstests targets.
+ */
+const file = new PbxFile(pathToFramework);
+file.uuid = project.generateUuid();
+file.fileRef = project.generateUuid();
+file.path = pathToFramework;
+file.target = project.getFirstTarget().uuid;
+if (!project.hasFile(file.path)) {
+    project.addToPbxBuildFileSection(file);
+    project.addToPbxFileReferenceSection(file);
+    // addToFrameworksPbxGroup crashes when it can't find a group named "Frameworks"
+    if (!project.pbxGroupByName('Frameworks')) {
+        project.addPbxGroup([], 'Frameworks');
+    }
+    project.addToFrameworksPbxGroup(file);
+    project.addToPbxFrameworksBuildPhase(file);
+}
+// Is this a Cocoapods installation?
+const podFile = path.join(sourceDirectory, 'Podfile');
+const hasPodfile = fs.existsSync(podFile);
+if (!hasPodfile) {
+    // Only add FRAMEWORK_SEARCH_PATHS for non-Cocoapod installation
+    helpers.addToFrameworkSearchPaths(
+        project,
+        '$(PROJECT_DIR)/' +
+        path.relative(
+            projectConfig.sourceDir,
+            path.join(moduleDirectory, 'ios')
+        ),
+        true
+    );
+} else {
+    helpers.addToFrameworkSearchPaths(
+        project,
+        '$(inherited)',
+        false
+    );
+}
+// enable BackgroundModes in xcode project without overriding any previously
+// defined values in the project file.
+// That's why we deep clone all previously defined target attributes and extend
+// them with our target attributes.
+const targetAttributes = helpers.getTargetAttributes(project);
+const systemCapabilities = Object.assign({}, (targetAttributes.SystemCapabilities || {}), {
+    'com.apple.BackgroundModes': Object.assign(
+        {},
+        targetAttributes['com.apple.BackgroundModes'] || {},
+        { enabled: true }
+    ),
+});
+if (targetAttributes.SystemCapabilities) {
+    targetAttributes.SystemCapabilities = systemCapabilities;
+} else {
+    project.addTargetAttribute('SystemCapabilities', systemCapabilities);
+}
+// add "location" background mode to Info.plist file
+const plist = helpers.readPlist(projectConfig.sourceDir, project);
+const UIBackgroundModes = plist.UIBackgroundModes || [];
+if (UIBackgroundModes.indexOf('location') === -1) {
+    plist.UIBackgroundModes = UIBackgroundModes.concat('location');
+}
+// Add NSLocationAlwaysUsageDescription
+if (!plist.NSLocationAlwaysUsageDescription) {
+    plist.NSLocationAlwaysUsageDescription = "CHANGEME: Location Always Usage Description";
+}
+// Add NSLocationAlwaysAndWhenInUseUsageDescription
+if (!plist.NSLocationAlwaysAndWhenInUseUsageDescription) {
+    plist.NSLocationAlwaysAndWhenInUseUsageDescription = "CHANGEME: Location Always And When In Use Usage Description";
+}
+// Add NSMotionUsageDescription
+if (!plist.NSMotionUsageDescription) {
+    plist.NSMotionUsageDescription = "CHANGEME: Motion updates increase battery efficiency by intelligently toggling location-services when device is detected to be moving";
+}
+helpers.writePlist(projectConfig.sourceDir, project, plist);
+fs.writeFileSync(projectConfig.pbxprojPath, project.writeSync());

package/scripts/postunlink.js ADDED Viewed

@@ -0,0 +1,128 @@
+#!/usr/bin/env node
+const path = require('path');
+const fs = require('fs');
+const xcode = require('xcode');
+const PbxFile = require('xcode/lib/pbxFile');
+const helpers = require('./xcode-helpers');
+const projectDirectory = process.cwd();
+const moduleDirectory = path.resolve(__dirname, '..');
+const sourceDirectory = path.join(projectDirectory, 'ios');
+const xcodeProjectDirectory = helpers.findProject(sourceDirectory);
+const projectConfig = {
+    sourceDir: sourceDirectory,
+    pbxprojPath: path.join(
+        projectDirectory,
+        'ios',
+        xcodeProjectDirectory,
+        'project.pbxproj'
+    ),
+};
+const pathToFramework = path.relative(
+    projectConfig.sourceDir,
+    path.join(
+        moduleDirectory,
+        'ios',
+        'RNBackgroundGeolocation',
+        'TSLocationManager.framework'
+    )
+);
+const project = xcode.project(projectConfig.pbxprojPath).parseSync();
+const file = new PbxFile(pathToFramework);
+file.target = project.getFirstTarget().uuid;
+project.removeFromPbxBuildFileSection(file);
+project.removeFromPbxFileReferenceSection(file);
+if (project.pbxGroupByName('Frameworks')) {
+    project.removeFromFrameworksPbxGroup(file);
+}
+project.removeFromPbxFrameworksBuildPhase(file);
+// Is this a Cocoapods installation?
+const podFile = path.join(sourceDirectory, 'Podfile');
+const hasPodfile = fs.existsSync(podFile);
+if (!hasPodfile) {
+    helpers.removeFromFrameworkSearchPaths(
+        project,
+        '$(PROJECT_DIR)/' +
+        path.relative(
+            projectConfig.sourceDir,
+            path.join(moduleDirectory, 'ios')
+        )
+    );
+}
+// disable BackgroundModes and remove "fetch" mode from plist file
+const systemCapabilities = helpers.getTargetAttributes(project).SystemCapabilities;
+if (systemCapabilities && systemCapabilities['com.apple.BackgroundModes']) {
+    delete systemCapabilities['com.apple.BackgroundModes'].enabled;
+    if (Object.keys(systemCapabilities['com.apple.BackgroundModes']).length === 0) {
+        delete systemCapabilities['com.apple.BackgroundModes'];
+    }
+    if (Object.keys(systemCapabilities).length === 0) {
+        project.removeTargetAttribute('SystemCapabilities');
+    }
+}
+const plist = helpers.readPlist(projectConfig.sourceDir, project);
+if (Array.isArray(plist.UIBackgroundModes)) {
+    plist.UIBackgroundModes = plist.UIBackgroundModes.filter(
+        mode => mode !== 'location'
+    );
+    if (plist.UIBackgroundModes.length === 0) {
+        delete plist.UIBackgroundModes;
+    }
+}
+helpers.writePlist(projectConfig.sourceDir, project, plist);
+fs.writeFileSync(projectConfig.pbxprojPath, project.writeSync());
+////
+// Android
+// - Remove maven url
+//     maven {
+//         url "$rootDir/../node_modules/react-native-background-geolocation/android/libs"
+//     }
+//
+const androidSrcDir = path.join(projectDirectory, 'android');
+const gradleFile = path.join(androidSrcDir, 'build.gradle');
+const moduleName = (process.platform === 'win32') ? moduleDirectory.split('\\').pop() : moduleDirectory.split('/').pop();
+fs.readFile(gradleFile, 'utf8', function (err,data) {
+  if (err) {
+    return console.log(err);
+  }
+  var re = new RegExp("[\\t?\\s?]+maven\\s?\\{[\\n?\\s?\\t?]+url.*" + moduleName + "\\/.*[\\n?\\t?\\s?]+\\}", "gm");
+  if (data.match(re)) {
+      fs.writeFile(gradleFile, data.replace(re, ''), 'utf8', function (err) {
+         if (err) return console.log(err);
+      });
+  }
+});
+// Remove method-call purgeBackgroundGeolocationDebugResources(applicationVariants)
+const appGradleFile = path.join(androidSrcDir, 'app', 'build.gradle');
+const purgeMethodName = "purgeBackgroundGeolocationDebugResources";
+fs.readFile(appGradleFile, 'utf8', function(err, data) {
+    if (err) {
+        return console.log(err);
+    }
+    var purgeMethodRE = new RegExp("^[\\s\\t]+" + purgeMethodName + "\\(applicationVariants\\).*$[\\s\\n]+(.*)", "gm");
+    if (purgeMethodRE.test(data)) {
+        data = data.replace(purgeMethodRE, '\t$1');
+    }
+    fs.writeFile(appGradleFile, data, 'utf8', function (err) {
+        if (err) return console.log(err);
+    });
+});

package/scripts/tsconfig.json ADDED Viewed

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "baseUrl": "",
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "lib": [
+      "dom",
+      "es2015"
+    ],
+    "module": "es2015",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "target": "es5"
+  },
+  "include": [
+    "../src/declarations/*.d.ts",
+    "../src/declarations/interfaces/*d.ts"
+  ]
+}

package/scripts/xcode-helpers.js ADDED Viewed

@@ -0,0 +1,171 @@
+const path = require('path');
+const fs = require('fs');
+const glob = require('glob');
+// unfortunately we can't use the 'plist' module at the moment for parsing
+// because it has a few issues with empty strings and keys.
+// There are several issues and PRs on that repository open though and hopefully
+// we can revert back to only using one module once they're merged.
+const plistParser = require('fast-plist');
+const plistWriter = require('plist');
+// The getBuildProperty method of the 'xcode' project is a bit naive in that it
+// doesn't take a specific target but iterates over all of them and doesn't have
+// an exit condition if a property has been found.
+// Which in the case of react-native projects usually is the tvOS target because
+// it comes last.
+function getBuildProperty(project, property) {
+    const firstTarget = project.getFirstTarget().firstTarget;
+    const configurationList = project.pbxXCConfigurationList()[
+        firstTarget.buildConfigurationList
+    ];
+    const defaultBuildConfiguration = configurationList.buildConfigurations.reduce(
+        (acc, config) => {
+            const buildSection = project.pbxXCBuildConfigurationSection()[
+                config.value
+            ];
+            return buildSection.name ===
+                configurationList.defaultConfigurationName
+                ? buildSection
+                : acc;
+        },
+        configurationList.buildConfigurations[0]
+    );
+    return defaultBuildConfiguration.buildSettings[property];
+}
+function getPlistPath(sourceDir, project) {
+    const plistFile = getBuildProperty(project, 'INFOPLIST_FILE');
+    if (!plistFile) {
+        return null;
+    }
+    return path.join(
+        sourceDir,
+        plistFile.replace(/"/g, '').replace('$(SRCROOT)', '')
+    );
+}
+function readPlist(sourceDir, project) {
+    const plistPath = getPlistPath(sourceDir, project);
+    if (!plistPath || !fs.existsSync(plistPath)) {
+        return null;
+    }
+    return plistParser.parse(fs.readFileSync(plistPath, 'utf-8'));
+}
+function writePlist(sourceDir, project, plist) {
+    fs.writeFileSync(
+        getPlistPath(sourceDir, project),
+        plistWriter.build(plist)
+    );
+}
+// based on: https://github.com/facebook/react-native/blob/545072b/local-cli/link/ios/mapHeaderSearchPaths.js#L5
+function eachBuildConfiguration(project, predicate, callback) {
+    const config = project.pbxXCBuildConfigurationSection();
+    Object.keys(config)
+        .filter(ref => ref.indexOf('_comment') === -1)
+        .filter(ref => predicate(config[ref]))
+        .forEach(ref => callback(config[ref]));
+}
+// this is being used to determine whether the current target is a react-native
+// project: https://github.com/facebook/react-native/blob/545072b/local-cli/link/ios/mapHeaderSearchPaths.js#L31
+function hasLCPlusPlus(config) {
+    return (config.buildSettings.OTHER_LDFLAGS || []).indexOf('"-lc++"') >= 0;
+}
+// based on: https://github.com/facebook/react-native/blob/1490ab1/local-cli/core/ios/findProject.js
+function findProject(folder) {
+    const GLOB_PATTERN = '**/*.xcodeproj';
+    const TEST_PROJECTS = /test|example|sample/i;
+    const IOS_BASE = 'ios';
+    const GLOB_EXCLUDE_PATTERN = ['**/@(Pods|node_modules)/**'];
+    const projects = glob
+        .sync(GLOB_PATTERN, {
+            cwd: folder,
+            ignore: GLOB_EXCLUDE_PATTERN,
+        })
+        .filter(project => {
+            return path.dirname(project) === IOS_BASE || !TEST_PROJECTS.test(project);
+        })
+        .sort((projectA, projectB) => {
+            return path.dirname(projectA) === IOS_BASE ? -1 : 1;
+        });
+    if (projects.length === 0) {
+        return null;
+    }
+    return projects[0];
+};
+function addToFrameworkSearchPaths(project, path, recursive) {
+    eachBuildConfiguration(project, hasLCPlusPlus, config => {
+        if (!config.buildSettings.FRAMEWORK_SEARCH_PATHS) {
+            config.buildSettings.FRAMEWORK_SEARCH_PATHS = [];
+        } else if (typeof config.buildSettings.FRAMEWORK_SEARCH_PATHS === 'string') {
+            config.buildSettings.FRAMEWORK_SEARCH_PATHS = [config.buildSettings.FRAMEWORK_SEARCH_PATHS];
+        }
+        const fullPath = '"' + path + (recursive ? '/**' : '') + '"';
+        if (
+            config.buildSettings.FRAMEWORK_SEARCH_PATHS.indexOf(fullPath) === -1
+        ) {
+            config.buildSettings.FRAMEWORK_SEARCH_PATHS = config.buildSettings.FRAMEWORK_SEARCH_PATHS.concat(
+                fullPath
+            );
+        }
+    });
+}
+function removeFromFrameworkSearchPaths(project, path) {
+    eachBuildConfiguration(project, hasLCPlusPlus, config => {
+        if (!config.buildSettings.FRAMEWORK_SEARCH_PATHS) {
+            config.buildSettings.FRAMEWORK_SEARCH_PATHS = [];
+        } else if (typeof config.buildSettings.FRAMEWORK_SEARCH_PATHS === 'string') {
+            config.buildSettings.FRAMEWORK_SEARCH_PATHS = [config.buildSettings.FRAMEWORK_SEARCH_PATHS];
+        }
+        const fullPath = unquote(path) + '/**';
+        config.buildSettings.FRAMEWORK_SEARCH_PATHS = config.buildSettings.FRAMEWORK_SEARCH_PATHS.filter(
+            searchPath =>
+                unquote(searchPath) !== unquote(path) &&
+                unquote(searchPath) !== fullPath
+        );
+    });
+}
+// The node-xcode library doesn't offer a method to get all target attributes,
+// so we'll have to implement it ourselves.
+function getTargetAttributes(project, target) {
+    var attributes = project.getFirstProject()['firstProject']['attributes'];
+    target = target || project.getFirstTarget();
+    if (attributes['TargetAttributes'] === undefined) {
+        attributes['TargetAttributes'] = {};
+    }
+    if (attributes['TargetAttributes'][target.uuid] === undefined) {
+        attributes['TargetAttributes'][target.uuid] = {};
+    }
+    return attributes['TargetAttributes'][target.uuid];
+}
+function unquote(str) {
+    return (str || '').replace(/^"(.*)"$/, '$1');
+}
+module.exports = {
+    getBuildProperty: getBuildProperty,
+    getPlistPath: getPlistPath,
+    readPlist: readPlist,
+    writePlist: writePlist,
+    getTargetAttributes: getTargetAttributes,
+    addToFrameworkSearchPaths: addToFrameworkSearchPaths,
+    removeFromFrameworkSearchPaths: removeFromFrameworkSearchPaths,
+    findProject: findProject,
+};