npm package: @fivvy/react-native-contextual-profiler-legacy
Description: Contextual Profiler SDK for legacy version's of React Native. Recommended for 0.68.X
Author: Albano
Latest version: 1.0.2

# Getting started contextual-profiler-legacy

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.



See the full [API](#api) for more methods.

## Recommendations
- REACT NATIVE VERSION: >= 0.68.0 (For more recent version's dont use the legacy sdk)
- ANDROID API LEVEL: 21 to 33 (we recommend 24 to 33)
- MIN JAVA VERSION: jdk11
- GRADLE DISTRIBUTION: gradle-7.3.3

## Installation
_Please read this entire section._

### npm

```
npm install @fivvy/react-native-contextual-profiler-legacy
```

### yarn

```
yarn add @fivvy/react-native-contextual-profiler-legacy
```
## Android
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:1.1.1@aar'
```

#### Permissions

### AndroidManifest
Necesary to add this **xmlns:tools** insde the tag **manifest** on AndroidManifest insde *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" />
<uses-permission  android:name="android.permission.PACKAGE_USAGE_STATS"  tools:ignore="ProtectedPermissions" />

<queries>
    <!-- List of package's [Max 100] -->
    <package android:name="com.whatsapp"/> <!-- WhatsApp Messenger -->
    <package android:name="com.facebook.katana"/> <!-- Facebook -->
    <package android:name="com.mercadopago.android"/> <!-- Mercado Pago -->
    <!-- ... -->

  </queries>


```
## 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.

### 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-legacy';
 openUsageAccessSettings({
      appName: 'Fivvy', // string value with your app name
      imagePath: 'logo', // optional image name in png format without the extension - ex: logo -> logo.png this image should be in android/app/src/main/res/drawable/logo.png
      ln: "EN", // If selected, the default texts will be set on the modal for EN, ES, or PR.
      appDescription: 'Activate the permission', // optional description text. Recommended length: 3 or 4 words
      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.
    });
```
## 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();
```

## 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
      authApiUrl: AUTH_API_URL, // URL of the Fivvy's Auth API
      sendDataApiUrl: SEND_DATA_API_URL // URL of the Fivvy's Analytics Data API
    }
    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.	|
|   `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.	|
|   `getAppsInstalled`	|   **Empty**	|   `Promise<IInstalledApps[]>`	|   Returns  an **IInstalledApps Array** for all the queries in AndroidManifest that user had install in his phone.	|
|   `openUsageAccessSettings`	|   `UsageSettings` {ln: `string`, appDescription: `string`, appName: `string`, imagePath: `string`, modalText: `string`}	|   `Boolean`	|    Open settings view with a modal helper to grant app usage permission.	|
|    `openUsageAccessSettingsDirectly`	|   **Empty**	|   `Boolean`	|    Open settings view without pre-built modal to grant app usage permission.	|

## 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;
  }

  `getAppUsage return object interface`
  IAppUsage {
    appName: string;
    usage: number;
    packageName: string;
  }

  `getAppsInstalled return object interface`

  IInstalledApps {
    appName?: string;
    packageName: string;
    category?: string;
    icon?: 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", "icon": "iVBORw0KGgoAAAANSUhEUg", "installTime": "2023.02.15 20:07:35", "lastUpdateTime": "2023.08.16 14:52:12", "packageName": "com.whatsapp", "versionCode": "231676002", "versionName": "2.23.16.76"}]

```

### 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.

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