Merge pull request #6 from kingstinct/add-config-plugins

added confing plugins to make it easier to the users

Author: RevanToma

.github/workflows/test.yml

@@ -28,3 +28,6 @@ jobs:
 
       - name: Run typecheck
         run: npm run typecheck
+      
+      - name: Run tests
+        run: npm test

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Kingstinct]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,6 @@
 # react-native-motion-activity-tracker
 
-[![Test Status](https://github.com/YourGithubUsername/react-native-motion-activity-tracker/actions/workflows/test.yml/badge.svg)](https://github.com/YourGithubUsername/react-native-motion-activity-tracker/actions/workflows/test.yml)
+[![Test Status](https://github.com/Kingstinct/react-native-motion-activity-tracker/actions/workflows/test.yml/badge.svg)](https://github.com/Kingstinct/react-native-motion-activity-tracker/actions/workflows/test.yml)
 [![Latest version on NPM](https://img.shields.io/npm/v/react-native-motion-activity-tracker)](https://www.npmjs.com/package/react-native-motion-activity-tracker)
 [![Discord](https://dcbadge.vercel.app/api/server/5wQGsRfS?style=flat)](https://discord.gg/5wQGsRfS)
 
@@ -32,14 +32,33 @@ A React Native library to access and track motion activity data using Apple's Co
 
 {
   "expo": {
-    "ios": {
-      "infoPlist": {
-        "NSMotionUsageDescription": "This app uses motion data to track your activity."
-      }
-    },
+    "plugins": [
+      "react-native-motion-activity-tracker"
+    ]
   }
 }
+
 ```
+3. If you want to customize the iOS permission description, you can configure it like this:
+ {
+  "expo": {
+    "plugins": [
+      [
+        "react-native-motion-activity-tracker",
+        {
+          "NSMotionUsageDescription": "This app uses motion data to enhance your experience."
+        }
+      ]
+    ]
+  }
+}
+
+4. After making these changes, rebuild your app to apply the native changes:
+  
+   ```bash
+   expo prebuild
+   ```
+
 
 
 # Examples
@@ -199,6 +218,10 @@ Checks the motion activity authorization status. Returns one of the following st
 - `DENIED`
 - `AUTHORIZED`
 
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
+
 ## Contributing
 
 Contributions are welcome!

app.plugin.js

@@ -0,0 +1,11 @@
+const { createRunOncePlugin } = require("expo/config-plugins");
+
+const withMotionActivityPermissions =
+  require("./config-plugin/withMotionActivityPermissions").default;
+const pkg = require("./package.json");
+
+module.exports = createRunOncePlugin(
+  withMotionActivityPermissions,
+  pkg.name,
+  pkg.version,
+);

config-plugin/withMotionActivityPermissions.ts

@@ -0,0 +1,42 @@
+import {
+  withInfoPlist,
+  withAndroidManifest,
+  ConfigPlugin,
+} from "@expo/config-plugins";
+
+const withMotionActivityPermissions: ConfigPlugin = (config) => {
+  // Add iOS motion activity permissions
+  config = withInfoPlist(config, (config) => {
+    config.modResults.NSMotionUsageDescription =
+      config.modResults.NSMotionUsageDescription ||
+      "This app uses motion activity tracking.";
+    return config;
+  });
+
+  // Add Android Activity Recognition permission
+  config = withAndroidManifest(config, (config) => {
+    const androidManifest = config.modResults;
+    const permissions = androidManifest.manifest["uses-permission"] || [];
+
+    // Check if the permission already exists
+    const hasActivityRecognitionPermission = permissions.some(
+      (permission) =>
+        permission.$["android:name"] ===
+        "android.permission.ACTIVITY_RECOGNITION",
+    );
+
+    // Add the permission only if it doesn't exist
+    if (!hasActivityRecognitionPermission) {
+      permissions.push({
+        $: { "android:name": "android.permission.ACTIVITY_RECOGNITION" },
+      });
+    }
+
+    androidManifest.manifest["uses-permission"] = permissions;
+    return config;
+  });
+
+  return config;
+};
+
+export default withMotionActivityPermissions;

jest.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    transform: {
+      '^.+\\.tsx?$': 'ts-jest',
+    },
+    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+    testMatch: ['**/tests/**/*.test.ts', '**/tests/**/*.test.tsx'],
+    transformIgnorePatterns: ['<rootDir>/node_modules/'],
+    globals: {
+      'ts-jest': {
+        tsconfig: 'tsconfig.json',
+      },
+    },
+  };
+  

package-lock.json

@@ -0,0 +1,43 @@
+const MotionActivityTracker = require('../src/MotionActivityTrackerModule');
+
+
+jest.mock('../src/MotionActivityTrackerModule.ts', () => ({
+  startTracking: jest.fn(() => Promise.resolve('tracking started')),
+  stopTracking: jest.fn(() => 'tracking stopped'),
+  getHistoricalDataIos: jest.fn((startDate, endDate) =>
+    Promise.resolve([
+      { walking: true, running: false, timestamp: 123456789, confidence: 'high' },
+    ]),
+  ),
+  addMotionStateChangeListener: jest.fn((callback) => {
+    callback({ state: 'walking' });
+    return { remove: jest.fn() };
+  }),
+}));
+
+describe('MotionActivityTracker', () => {
+  test('should start tracking', async () => {
+    const result = await MotionActivityTracker.startTracking();
+    expect(result).toBe('tracking started');
+  });
+
+  test('should stop tracking', () => {
+    const result = MotionActivityTracker.stopTracking();
+    expect(result).toBe('tracking stopped');
+  });
+
+  test('should fetch historical data', async () => {
+    const startDate = new Date(Date.now() - 1000 * 60 * 60); // 1 hour ago
+    const endDate = new Date();
+    const data = await MotionActivityTracker.getHistoricalDataIos(startDate, endDate);
+    expect(data).toHaveLength(1);
+    expect(data[0]).toHaveProperty('walking', true);
+  });
+
+  test('should call listener on state change', () => {
+    const mockListener = jest.fn();
+    const subscription = MotionActivityTracker.addMotionStateChangeListener(mockListener);
+    expect(mockListener).toHaveBeenCalledWith({ state: 'walking' });
+    subscription.remove();
+  });
+});

tests/MotionActivityTracker.test.ts

@@ -0,0 +1,123 @@
+import { withInfoPlist, withAndroidManifest } from "@expo/config-plugins";
+import type { ExpoConfig } from "@expo/config-types";
+
+import withMotionActivityPermissions from "../config-plugin/withMotionActivityPermissions";
+
+interface ExpoConfigWithModResults extends ExpoConfig {
+  modResults?: {
+    // For iOS
+    NSMotionUsageDescription?: string;
+    // For Android
+    manifest?: {
+      "uses-permission"?: { $: { "android:name": string } }[];
+    };
+  };
+}
+
+jest.mock("@expo/config-plugins", () => ({
+  withInfoPlist: jest.fn((config, callback) => {
+    const updatedConfig = {
+      ...config,
+      modResults: {
+        ...config.modResults,
+        NSMotionUsageDescription: undefined,
+      },
+    };
+    const modifiedConfig = callback(updatedConfig);
+    return {
+      ...config,
+      modResults: { ...updatedConfig.modResults, ...modifiedConfig.modResults },
+    };
+  }),
+  withAndroidManifest: jest.fn((config, callback) => {
+    const updatedConfig = {
+      ...config,
+      modResults: {
+        ...config.modResults,
+        manifest: {
+          ...config.modResults?.manifest,
+          "uses-permission": [],
+        },
+      },
+    };
+    const modifiedConfig = callback(updatedConfig);
+    return {
+      ...config,
+      modResults: { ...updatedConfig.modResults, ...modifiedConfig.modResults },
+    };
+  }),
+}));
+
+describe("withMotionActivityPermissions", () => {
+  it("should add iOS motion activity permissions", () => {
+    const config: ExpoConfigWithModResults = {
+      name: "mock-app",
+      slug: "mock-app",
+      modResults: {
+        NSMotionUsageDescription: undefined,
+      },
+    };
+
+    const updatedConfig: ExpoConfigWithModResults =
+      withMotionActivityPermissions(config);
+
+    expect(updatedConfig.modResults?.NSMotionUsageDescription).toBe(
+      "This app uses motion activity tracking.",
+    );
+
+    expect(withInfoPlist).toHaveBeenCalled();
+  });
+
+  it("should add Android motion activity recognition permission if it does not exist", () => {
+    const config: ExpoConfigWithModResults = {
+      name: "mock-app",
+      slug: "mock-app",
+      modResults: {
+        manifest: {
+          "uses-permission": [],
+        },
+      },
+    };
+
+    const updatedConfig: ExpoConfigWithModResults =
+      withMotionActivityPermissions(config);
+
+    const permissions = updatedConfig.modResults?.manifest?.["uses-permission"];
+    expect(permissions).toEqual(
+      expect.arrayContaining([
+        { $: { "android:name": "android.permission.ACTIVITY_RECOGNITION" } },
+      ]),
+    );
+
+    expect(withAndroidManifest).toHaveBeenCalled();
+  });
+
+  it("should not add duplicate Android motion activity recognition permission", () => {
+    const config: ExpoConfigWithModResults = {
+      name: "mock-app",
+      slug: "mock-app",
+      modResults: {
+        manifest: {
+          "uses-permission": [
+            {
+              $: { "android:name": "android.permission.ACTIVITY_RECOGNITION" },
+            },
+          ],
+        },
+      },
+    };
+
+    const updatedConfig: ExpoConfigWithModResults =
+      withMotionActivityPermissions(config);
+
+    const permissions = updatedConfig.modResults?.manifest?.["uses-permission"];
+    expect(permissions).toHaveLength(1); // Ensure no duplicates are added
+    expect(permissions).toEqual(
+      expect.arrayContaining([
+        { $: { "android:name": "android.permission.ACTIVITY_RECOGNITION" } },
+      ]),
+    );
+
+    expect(withAndroidManifest).toHaveBeenCalled();
+  });
+});

tests/withMotionActivityPermissions.test.ts

@@ -4,6 +4,6 @@
   "compilerOptions": {
     "outDir": "./build"
   },
-  "include": ["./src"],
+  "include": ["./src", "./tests"],
   "exclude": ["**/__mocks__/*", "**/__tests__/*"]
 }