npm package: @fivvy/contextual-profiler
Description: Contextual Profiler SDK for React Native. Recommended for 0.69.X or higher React Native versions.
Author: Fivvy
Latest version: 3.2.6

# Getting started Fivvy contextual-profiler

Contextual Profiler SDK offers a comprehensive and efficient solution for collecting valuable information about your users. With this powerful tool, you will be able to gather relevant data that will allow you to conduct in-depth analysis and gain a clear understanding of your users' behavior, preferences, and needs.

**⚠️ Important Notice: This library does not support iOS devices.**

Please be aware that this library is currently only available for Android. It will not work on iOS devices. Ensure that your project is intended for Android platforms before integrating this library.

## Recommendations
- REACT NATIVE VERSION: >= 0.69.0 (we recommend 0.72.X or above)
- ANDROID API LEVEL: 21 a 34 (We recommend 34)
- MIN JAVA VERSION: jdk11 (we recommend jdk17)

## Installation
_Please read this entire section._

### npm

```
npm install @fivvy/contextual-profiler
```

### yarn

```
yarn add @fivvy/contextual-profiler
```
# Android

## Proguard
If you have any obfucastion tool in your project, you'll need to exclude this package to work as intended in release builds.

Create a new file called *proguard-rules.pro* in **/android/app** with this content:

```
-keep class com.fivvy.profiler.** { *; }
-keep class * extends com.fivvy.profiler.** { *; }

-keepclassmembers class com.fivvy.profiler.** {
    *;
}

-keepattributes *Annotation*
```

Add the following settings in build.gradle within **/android/app**

```
    buildTypes {
        release {
            ...
            minifyEnabled true
            shrinkResources true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
```

## Gradle config
you MUST add this line to build.gradle (proyect)

```groovy

allprojects {
    repositories {
        google()
        mavenCentral()
          maven {
            url "https://gitlab.com/api/v4/projects/58175283/packages/maven"
        }
    }
}
```
and in build.gradle (app)
```groovy
    implementation 'com.fivvy:fivvy-lib:3.2.6@aar'
```
make sure you also have:
```groovy
    implementation 'androidx.security:security-crypto-ktx:1.1.0-alpha04'
    implementation 'com.scottyab:rootbeer-lib:0.1.1'
```
## Permissions

### AndroidManifest
Necesary to add this **xmlns:tools** insde the tag **manifest** on AndroidManifest inside *android/app/src/main* folder.
```xml
<manifest xmlns:tools="http://schemas.android.com/tools">
```

Need to add these permissions in the AndroidManifest inside *android/app/src/main* folder.

```xml
<uses-permission  android:name="android.permission.INTERNET" />
```

## Send data to Fivvy's analytics service
This function will allow your app to send the information of each user to the Fivvy Analytic's API. You must add on some view or loading component that can send the data at least 1 time a day.

Every time this useEffect run, the data will be send to the Fyvvy's API.
```js
  useEffect(() => {
    const contextualConfigObj = {
      customerId: customerId, // Represents an identifier of the current user
      apiKey: API_KEY, // ApiKey of Fivvy's API
      apiSecret: API_SECRET, // ApiSecrey of Fivvy's API
      appUsageDays: DAYS, // Integer that represents the last days to recollect the app usage information of the user. Recommended default value: 30
      authApiUrl: AUTH_API_URL, // URL of the Fivvy's Auth API: https://api.fivvyforbusiness.com/b2b-auth/auth/v1/users/login
      sendDataApiUrl: SEND_DATA_API_URL // URL of the Fivvy's Analytics Data API: https://api.fivvyforbusiness.com/b2b-intake/intake/v2/context
    }
    await initContextualDataCollection(contextualConfigObj);
},[])
```

# API
#### All the information about the package and how to use functions.
|   Methods	|  Params value 	|  Return value 	| Description  	|
|---	|---	|---	|---	|
|   `initContextualDataCollection`	|   `InitConfig` { customerId: `String`, apiKey: `String`, apiSecret: `String`, appUsageDays: `Int`, authApiUrl: `String`, sendDataApiUrl: `String`}	|   `ContextualData` 	|   Initiates data collection, sending it to the Fivvy's Analytics Data API.
|   `getDeviceInformation`	|   **Empty**	|   `Promise<IHardwareAttributes>`	|   Returns the device hardware information of the customer.	|
|   `getAppsInstalled`	|   **Empty**	|   `Promise<IInstalledApps[]>`	|   Returns  an **IInstalledApps Array** for all the queries in AndroidManifest that user had install in his phone.	|

## Interfaces
Here you can find the interaces that sdk uses
```js
`initContextualCollectionData param object interface`
 InitConfig {
    customerId: string,
    apiUsername: string,
    apiPassword: string,
    appUsageDays: number,
    authApiUrl: string,
    sendDataApiUrl: string
 }
`getDeviceInformation return interface`
IHardwareAttributes {
    api_level: string;
    device_id: string;
    device: string;
    hardware: string;
    brand: string;
    manufacturer: string;
    model: string;
    product: string;
    tags: string;
    type: string;
    base: string;
    id: string;
    host: string;
    fingerprint: string;
    incremental_version: string;
    release_version: string;
    base_os: string;
    display: string;
    battery_status: number;
  }
  `getAppsInstalled return object interface`
  IInstalledApps {
    appName?: string;
    packageName: string;
    category?: string;
    installTime?: string;
    lastUpdateTime?: string;
    versionCode?: string;
    versionName?: string;
  }
```

## Example
### Getting the installed apps
Recovery of applications installed on the user's device.
```js
getAppsInstalled().then(data =>  console.log('Installed apps:', data));
//  expected output
  Installed Apps: [{"appName": "WhatsApp", "category": "Social", "installTime": "2023.02.15 20:07:35", "lastUpdateTime": "2023.08.16 14:52:12", "packageName": "com.whatsapp", "versionCode": "231676002", "versionName": "2.23.16.76"}]

```

# Debug mode
### Debug Mode Configuration

To enable and properly use the debug mode, follow these steps:

#### Requirements for Debug Mode
1. The project must have the **`BuildConfig`** class generated, which is standard in React Native projects configured for Android. If your project does not generate **`BuildConfig`**, proceed to step 2.

2. **If `BuildConfig` is not automatically generated or does not include the required property:**
   - Open the `build.gradle` file located at **`/android/app`**.
   - Add the following configurations:
     ```groovy
     android {
         ...
         buildFeatures {
            buildConfig true
        }
     }
     ```

**⚠️ Important: The applicationId and namespace in your project must be identical. Debug mode will not work properly if these values are different.**

### General Information

**⚠️ Important Notice: iOS Compatibility**

This library is **not** compatible with iOS devices. It is specifically designed for Android platforms, and no support for iOS is provided. Please refrain from using this library in iOS-based projects, as it will not function as intended.


# Appendix: advanced features (optional)

## Android Permission Request

On Android, you must request permissions beforehand to check the app's usage. We recommend creating a logic with [AsyncStorage](https://github.com/react-native-async-storage/async-storage) to remember if the user doesn't want to give access to this permission.

## Permissions

Need to add these permissions in the AndroidManifest inside *android/app/src/main* folder.

```xml
<uses-permission  android:name="android.permission.PACKAGE_USAGE_STATS"  tools:ignore="ProtectedPermissions" />
```

### Get User Permission to Check App Usage

We have a pre-made modal with instructions that can be used for this purpose. Here is an example of how to implement it:

```js
import { getAppUsage, openUsageAccessSettings } from 'contextual-profiler';

 openUsageAccessSettings({
      ln: "EN", // If selected, the default texts will be set on the modal for EN, ES, or PR.
      // If using the ln value, it is recommended not to use the parameters below as the ln sets default texts in the right language.
      appDescription: 'Activate the permission', // optional description text. Recommended length: 3 or 4 words
      appName: 'Fivvy', // string value with your app name
      imagePath: 'logo',// this image should be in android/app/src/main/res/drawable/logo.png
      imageView: 1,// integer value, 0: no image; 1: default image, 2: app logo
      buttonRadius: 25.0,// float value, set button border radius
      modalRadius: 25.0,// float value, set modal border radius
      color: '#50C7FA',// hex color value, set color of dialog title, accept background color and cancel button text color
      modalText: 'Lorem ipsum text', // optional modal text. Recommended length: 3 or 4 words
      dialogTitle: "Dialog Title", // Title of the dialog displayed to the user before redirecting to the settings screen for permissions.
      dialogMessage1: "Dialog message 1", // Custom Message of the dialog displayed to the user before redirecting to the settings screen for permissions.
      dialogMessage2: "Dialog message 2", // Other custom Message of the dialog displayed to the user before redirecting to the settings screen for permissions.
      blacklist: null // (Optional) List of device manufacturers for which the usage settings should be avoided. On some devices, especially from certain manufacturers as Xiaomi, a system warning might be displayed when attempting to access the usage settings. To prevent this action on those devices, you can:

      //- Pass `null`: This will apply a default list of manufacturers known to have this issue.
      // - Provide a custom list of manufacturers as an array (`["manufacturer1", "manufacturer2"]`): This will prevent the settings from being accessed only on devices from those specific brands.
      //- Pass an empty array `[]`: This will allow the settings to be accessed on all devices without any restrictions.

    });
```

## Direct Access to Settings
If you prefer not to display any modal and want to go directly to the settings screen, you can use

```js
openUsageAccessSettingsDirectly(blacklist); // - blacklist (Optional) List of device manufacturers for which the usage settings should be avoided. On some devices, especially from certain manufacturers as Xiaomi, a system warning might be displayed when attempting to access the usage settings. To prevent this action on those devices, you can:

      //- Pass `null`: This will apply a default list of manufacturers known to have this issue.
      // - Provide a custom list of manufacturers as an array (`["manufacturer1", "manufacturer2"]`): This will prevent the settings from being accessed only on devices from those specific brands.
      //- Pass an empty array `[]`: This will allow the settings to be accessed on all devices without any restrictions.
```

## `blacklist` Parameter

The `blacklist` parameter is an array of strings containing the names of device manufacturers for which you want to disable a certain function. If the device is from a manufacturer listed in this array, the function will not perform any action.

### `blacklist` Behavior:

 - **Array with specific manufacturers**: If the array contains manufacturer names, the function will be disabled on devices from those brands. Example:
  ```js
  blacklist: ["xiaomi", "huawei"]
  ```

 - **Empty Array**: The feature will work on any manufacturer device. Example:
```js
  blacklist: []
  ```

 - **Null value**: The feature will use a default blacklist, here are the default blacklisted manufacturers: **["xiaomi", "huawei", "oppo", "vivo", "realme", "lenovo", "meizu", "oneplus", "zte", "nubia"]**
 ```js
  blacklist: null
  ```


Here's a full list of manufacturers names in Android: [Android manufacturer names](https://developers.google.com/zero-touch/resources/manufacturer-names)

## Device manufacturer
This fucntion will return the current device manufacturer, this could be useful if you need to implement more complex logic in your app regarding the device manufacturer.

```js
getDeviceManufacturer().then((data) => {
      console.log(data.manufacturer);
    })
```

# API
#### All the information about the package and how to use functions.
|   Methods	|  Params value 	|  Return value 	| Description  	|
|---	|---	|---	|---	|
|   `getAppUsage`	|   `Int` days. Represent the last **days** to get the usage of each app.	|   `Promise<IAppUsage[]>` | Returns an **IAppUsage Array** for all the queries in AndroidManifest that user had install in his phone or  **null** if user doesn’t bring usage access.	|   Returns  **null** if the user doesnt brings access to the App Usage or an **IAppUsage Array** for the all used aplications.	|
|   `openUsageAccessSettings`	|   `UsageSettings` {ln: `string`, appDescription: `string`, appName: `string`, imagePath: `string`, imageView: `number`, buttonRadius: `Float`, modalRadius: `Float`, color: `string`, modalText: `string`, dialogTitle: `string`, dialogMessage1: `string`, dialogMessage2: `string`, blacklist: `Array[]` | `null` }	|   `Boolean`	|    Open settings view with a modal helper to grant app usage permission.	|
|    `openUsageAccessSettingsDirectly`	|   blacklist: `Array[]` | `null`	|   Open settings view without pre-built modal to grant app usage permission.	|
|    `getManufacturer`	|   **Empty** | `Promise<{ manufacturer: string }`	|    Get the device manufacturer	|

## Interfaces
Here you can find the interaces that sdk uses
```js
  `getAppUsage return object interface`
  IAppUsage {
    appName: string;
    usage: number;
    packageName: string;
  }
  `openUsageAccessSettings params object`
  UsageSettings {
    ln: string,
    appDescription: string,
    appName: string,
    imagePath: string,
    imageView: number,
    buttonRadius: Float,
    modalRadius: Float,
    color: string,
    modalText: string,
    dialogTitle: string,
    dialogMessage1: string,
    dialogMessage2: string,
    blacklist: [] | null,
  }
```
# Changelog

## [3.2.6] - 15-05-2025
### Changed
- update manifest default

## Terms of use
All content here is the property of Fivvy, it should not be used without their permission.