@os1-platform/dispatch-mobile 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 jadwanigaurav
+
+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.

package/README.md

@@ -0,0 +1,551 @@
+# React Native Dispatch SDK
+
+## Introduction
+
+Dispatch SDK is an expo based SDK that is written in Typescript and some Modules in Java/Kotlin.
+This sdk can be used to render execution task screens on ui, maintain their states, manage mts.
+
+`Currently supports SDK>=21 (Android)`
+
+### Dispatch SDK provides the following features:
+
+- `Sync Manager`: Provides Sync Manager for syncing events & Docs in background with retry functionality.
+- `Execution Tasks`: Provides a list of Execution Tasks inbuilt UIs which are as follows.
+  - `Deliver`
+  - `Capture Input`
+  - `Deliver Cash`
+  - `Complete-Success`
+  - `Complete-Failure`
+  - `Pickup`
+  - `Doodle`
+  - `Forms`
+  - `Display`
+  - `Verify Location`
+  - `Verify OTP`
+  - `Verify String`
+  - `Scan QR/Barcode`
+  - `Image Capture`
+  - `Init Payment`
+  - `Process Payment`
+  - `Complete Payment`
+- `Execution Engine`: Provides methods for Executing a given workflow/Job in a dispatch`
+- `Firebase Cloud Messaging`:Provides method for receiving Firebase Cloud Messaging
+- `Async storage`:Provides Async storage for storing key value pairs
+- `Higher Order ETs`:Provides a way to customize Execution Task UI (Dev in Progress)
+
+## Dispatch SDK Installation
+
+### Setup Expo (For non-expo projects only)
+
+```sh
+npx install-expo-modules
+```
+
+### Install Dispatch SDK Package
+
+```sh
+#using npm
+npm install @os1-platform/dispatch-mobile@latest_version
+
+#or using Yarn
+yarn add @os1-platform/dispatch-mobile@latest_version
+```
+
+### Install these dependencies
+
+```json
+{
+  "dependencies": {
+    "@apollo/client": "^3.5.6",
+    "graphql": "^16.2.0",
+    "@expo-google-fonts/ibm-plex-sans": "*",
+    "@os1-platform/mts-mobile": "^1.0.0",
+    "@react-native-async-storage/async-storage": "^1.15.5",
+    "@react-native-community/datetimepicker": "^3.5.2",
+    "@react-native-community/netinfo": "^6.0.2",
+    "@react-native-community/slider": "^4.1.8",
+    "@react-native-firebase/analytics": "^14.1.0",
+    "@react-native-firebase/app": "^14.1.0",
+    "@react-native-firebase/messaging": "^14.1.0",
+    "@react-native-firebase/remote-config": "^14.1.0",
+    "@react-navigation/native": "^6.0.6",
+    "@react-navigation/native-stack": "^6.2.5",
+    "axios": "^0.24.0",
+    "expo": "^43.0.4",
+    "expo-barcode-scanner": "^11.2.1",
+    "expo-file-system": "~13.0.3",
+    "expo-font": "~10.0.3",
+    "expo-image-manipulator": "^10.1.2",
+    "expo-image-picker": "^11.0.3",
+    "expo-location": "^13.0.4",
+    "expo-sqlite": "^10.0.3",
+    "react": "17.0.2",
+    "react-native": "0.66.1",
+    "react-native-paper": "^4.9.2",
+    "react-native-safe-area-context": "^3.3.2",
+    "react-native-screens": "^3.9.0",
+    "react-native-vector-icons": "^9.0.0"
+  }
+}
+```
+
+### Async Storage Size Increase
+
+- `Add this line in gradle.properties file for increasing storage (AsyncStorage_db_size_in_MB=10)`
+
+### Changes in Android Manifest File (Android only)
+
+```txt
+android:allowBackup="false"
+tools:replace="android:allowBackup"
+```
+
+### Add jcenter() if not added already added in the Project-level build.gradle (<project>/build.gradle): (Android only)
+
+```txt
+buildscript {
+
+    repositories {
+        ...
+        jcenter()
+    }
+}
+
+allprojects {
+    repositories {
+        ...
+        jcenter()
+        ...
+    }
+}
+
+```
+
+### Fix for Apollo GraphQL Client (metro.config.js)
+
+### Add the following changes in metro.config.js file
+
+#### Issue Link https://github.com/apollographql/apollo-client/releases/tag/v3.5.4
+
+```js
+const { getDefaultConfig } = require('metro-config');
+const { resolver: defaultResolver } = getDefaultConfig.getDefaultValues();
+exports.resolver = {
+  ...defaultResolver,
+  sourceExts: [...defaultResolver.sourceExts, 'cjs'],
+};
+```
+
+## Dispatch SDK Usage
+
+### Init Dispatch SDK
+
+```tsx
+import { DispatchSDKManager } from '@os1-platform/dispatch-mobile';
+
+await DispatchSDKManager.getInstance().initDispatchSDK({
+  userName: 'testuser',
+  userID: 'testID',
+  tenantID: 'TENANTID',
+  tenantBaseURL: 'baseURL',
+  accessToken: 'accessToken',
+});
+```
+
+### Init Execution engine
+
+```ts
+import { DispatchStateContainer } from '@os1-platform/dispatch-mobile';
+
+/**
+ * Call this function when dispatch data is fetched successfully
+ * @param dispatchID
+ * @param jobs
+ * @param logging
+ * @param maxTaskReattempt
+ */
+
+await DispatchStateContainer.getInstance().initDispatchExecutor(
+  dispatchID,
+  dispatch.data.dispatch.jobs.data as Job[],
+  false
+);
+```
+
+### Query Objective status
+
+```ts
+import { DispatchStateContainer } from '@os1-platform/dispatch-mobile';
+
+/**
+ *
+ * @param objRef
+ * @param jobID
+ */
+
+DispatchStateContainer.getInstance().fetchObjectiveState(
+  'objective_ref',
+  'job_id'
+);
+```
+
+### Start Objective Execution
+
+```tsx
+interface sdkError {
+  code: string;
+  message: string;
+}
+// Error Handling from the calling Screen
+React.useEffect(() => {
+  if (route.params?.sdkError) {
+    console.log(JSON.stringify(route.params.sdkError));
+    Alert.alert('Error', JSON.stringify(route.params.sdkError));
+  }
+}, [route.params?.sdkError]);
+
+navigation.navigate('DispatchExec', {
+  success: true,
+  objectives: [], // Pass objective List
+  successRoute: 'SuccessScreen',
+  failureRoute: 'FailureScreen',
+  initRoute: 'TaskDetail',
+  // Calling Screen name (optional parameter). Used to throw errors back to calling screen
+});
+```
+
+## FCM
+
+#### Setup (android only)
+
+##### Add the Firebase Android configuration file to your app:
+
+- Create a firebase project (Check Firebase instructions for creating app).
+- Click Download google-services.json to obtain your Firebase Android config file (google-services.json).
+- Move your config file into the module (app-level) directory of your app.
+- To enable Firebase products in your app, add the google-services plugin to your Gradle files.
+
+###### In your module (app-level) Gradle file (usually app/build.gradle), apply the Google Services Gradle plugin:
+
+```text
+apply plugin: 'com.android.application'
+// Add the following line:
+apply plugin: 'com.google.gms.google-services'  // Google Services plugin
+
+android {
+  // ...
+}
+```
+
+#### In your root-level (project-level) Gradle file (build.gradle), add rules to include the Google Services Gradle plugin. Check that you have Google's Maven repository, as well
+
+```text
+buildscript {
+
+  repositories {
+    // Check that you have the following line (if not, add it):
+    google()  // Google's Maven repository
+  }
+
+  dependencies {
+    // ...
+
+    // Add the following line:
+    classpath 'com.google.gms:google-services:4.3.10'  // Google Services plugin
+  }
+}
+
+allprojects {
+  // ...
+
+  repositories {
+    // Check that you have the following line (if not, add it):
+    google()  // Google's Maven repository
+    // ...
+  }
+}
+
+```
+
+### Get FCM Token
+
+```ts
+import {
+  getFCMToken,
+  requestFirebasePermissions,
+} from '@os1-platform/dispatch-mobile';
+//Get FCM Token
+let token = await getFCMToken();
+
+//Request Notifications permissions (ios)
+// It will ask for user permissions for showing alert/notifications
+let enabled = await requestFirebasePermissions();
+```
+
+### Background FCM Messages
+
+##### Register callback for receiving FCM Messages in background
+
+Note : Call this function in the root component i.e in index.js file of the app
+
+```ts
+import { registerBackgroundHandler } from '@os1-platform/dispatch-mobile';
+
+registerBackgroundHandler((message: object) => {
+  // Handle FCM Message here
+});
+```
+
+#### Foreground FCM Messages
+
+###### useFcmMessage() custom hook in functional components to receive FCM Messages in Foregound
+
+```ts
+import { useFCMMessage } from '@os1-platform/dispatch-mobile';
+
+const fcmMessage = useFCMMessage();
+if (fcmMessage != null) {
+  // update UI here to show the message
+}
+```
+
+OR
+
+###### extend FCM Base class in case of class components
+
+```ts
+import { FCM } from '@os1-platform/dispatch-mobile';
+
+class ClassComponent extends FCM {
+  //implement these methods
+  handleFcmMessage(remoteMessage: object): void {}
+
+  //implement these methods
+  handleNotification(remoteMessage: object): void {}
+}
+```
+
+## MTS
+
+### MTS Default Config
+
+```ts
+export class MTSDefaults {
+  locationFrequency: number = 10000; // in milli seconds (no. of seconds after which location updates will happen)
+  distanceAccuracyLimit: number = 250; // in metres
+  speedLimit: number = 28; // in m/s
+  mode: MTSMode = MTSMode.HYBRID;
+  environment: MTSEnv = MTSEnv.DEV;
+  batchSize: number = 25;
+  isMqttCleanSession: boolean = true;
+  mqttKeepAliveInterval: number = 15 * 60; //in seconds
+  maxLocationAge: number = 15000; // in milliseconds
+  maxTraceSession: number = 24 * 3600 * 100; //in milliseconds
+  isOdometerEnabled: boolean = true;
+  retriesBeforeFallback: number = 1;
+  httpFailureLimit: number = 5;
+  dataSendDelay: number = 30000; // in milli seconds
+  alarmTime: number = 60000; // in milli seconds
+  missingSeqCheckDuration: number = 5 * 60 * 1000; // in milli seconds
+  odometerPushFrequency: number = 5 * 60 * 1000; // in milli seconds
+  qosLevel: number = 1; // values can be 0 ,1
+}
+```
+
+### Check For Mandatory MTS Permissions
+
+```ts
+let granted = await MtsLib.requestPermissionsForMTS();
+// if granted = true : all permissions granted
+// granted = false : one or more permissions denied
+```
+
+### Init MTS
+
+```ts
+import type { MTSInitRequest } from '@os1-platform/mts-mobile';
+
+let mtsDefaults = new MtsLib.MTSDefaults();
+mtsDefaults.speedLimit = 5000;
+mtsDefaults.locationFrequency = 10000;
+mtsDefaults.environment = MtsLib.MTSEnv.PRE_PROD;
+mtsDefaults.isOdometerEnabled = false;
+
+//Change MTS default values as per your use case
+
+// ...Use this for Initiating MTS
+let mtsInitReq: MTSInitRequest = {
+  appName: 'app_name',
+  appVersion: '1',
+  mtsDeviceID: 'deviceId', // use FCM ID here
+  configData: mtsDefaults,
+  baseURL: 'https://{tenantId}.example.io/{mtsEndpoint}',
+  accessToken: 'token',
+  tenantID: 'TENANTID',
+};
+await MtsLib.initMTS(mtsInitReq);
+//See Error Codes for Possible error types
+```
+
+### Start MTS
+
+```ts
+let startReq: MTSStartRequest = {
+  accessToken: 'token', // update access token
+  resetSequence: false,
+  dispatchID: '12345', // pass dispatch ID here
+  expiryTime: Date.now() + 24 * 2600 * 1000, // expiry time after which MTS will stop automatically
+};
+await MtsLib.startMTS(startReq);
+```
+
+### Publish Event
+
+```ts
+await MtsLib.publishEvent('TESTEVENT', { battery: 56, network: 100 });
+```
+
+### Stop MTS
+
+```ts
+// To stop mts
+await MtsLib.stopMTS();
+```
+
+### Error Codes
+
+```ts
+PERMISSIONS_ERROR[2500] = 'Mandatory Android Permissions not provided';
+MTS_INIT_ERROR[2501] = 'MTS INIT Not called! MTS Device ID is Empty';
+PARAM_MISSING[2502] = 'Mandatory Paramater is missing in request';
+```
+
+## Sync Manager
+
+```ts
+import { AppSyncManager, SdkSyncType } from '@os1-platform/dispatch-mobile';
+
+// Start Events sync
+await AppSyncManager.getInstance().startSyncing(
+  false, // pass true for force sync
+  SdkSyncType.EVENTS_SYNC
+);
+
+//Start Documents sync
+await AppSyncManager.getInstance().startSyncing(
+  false, // pass true for force sync
+  SdkSyncType.DOCUMENT_SYNC
+);
+
+//Get All Events By Dispatch ID
+await AppSyncManager.getInstance().getAllEvents('dsp_id');
+
+//Get all documents By Dispatch ID
+await AppSyncManager.getInstance().getAllDocuments('dsp_id');
+```
+
+## Start Sync Manager as a Foreground Service in android
+
+```ts
+import { NativeSyncManager } from '@os1-platform/dispatch-mobile';
+
+NativeSyncManager.startSyncManager(
+  interval,
+  notificationTitle,
+  notificationText
+);
+// interval will be in seconds
+NativeSyncManager.startSyncManager(
+  2000,
+  'Dispatch Service',
+  'Syncing events...'
+);
+
+//To stop the foreground android service
+NativeSyncManager.stopSyncManager();
+```
+
+## SDK Utility methods
+
+### Download Firebase Config
+
+```ts
+import { SdkUtils } from '@os1-platform/dispatch-mobile';
+
+await SdkUtils.getRemoteConfig(3000);
+// 3000 is the number of seconds to cache the config
+```
+
+### Download APK from Public URL
+
+```ts
+/**
+ * Function to download apk file from a public URL
+ * @param apkURL - URL where apk is hosted
+ * @param version - expected version of apk (used for naming the file)
+ * @param callback - callback for getting progress of download
+ */
+await SdkUtils.downloadAPK('https://apk_url.com', '1', (progress) =>
+  console.log(progress.totalBytesWritten)
+);
+```
+
+### Open & Install an APK File
+
+```ts
+/**
+ * Opens & Install an APK file
+ * @param uri - source of apk file
+ */
+
+await SdkUtils.openAPKFile(result.uri);
+```
+
+### Send events to Firebase analytics
+
+```ts
+/**
+ *
+ * @param eventName-> string
+ * @param tag -> string
+ * @param message -> string
+ */
+await Logger.getInstance().sendToFirebaseAnalytics('ev_name', 'tag', 'message');
+```
+
+### Log events to console
+
+```ts
+/**
+ *
+ * @param TAG
+ * @param message
+ * @param logType
+ */
+Logger.getInstance().logEvent('tag', 'message', LOG_TYPE.SDK_ERROR);
+```
+
+### Error Codes
+
+```ts
+const enum BaseErrorCodes {
+  InvalidArgumentError = '100100',
+  InvalidBaseURL = '100101',
+  SyncManagerNotInitialized = '100102',
+  MissingOrInvalidProps = '100103',
+  SQLiteDBIssue = '100104',
+  AppSyncNotInitialized = '100105',
+  FMS_FOLDER_CREATION_ERROR = '100106',
+  REASON_CODE_API_ERROR = '100107',
+  MERGING_ERROR = '100108',
+  LOCATION_PERMISSION_DENIED = '100109',
+  CAMERA_PERMISSION_DENIED = '100110',
+  STORAGE_PERMISSION_DENIED = '100111',
+  GRAPHQL_CLIENT_NOT_INITIALIZED = '100112',
+  FMS_GRAPHQL_API_ERROR = '100113',
+  INTERNET_NOT_ENABLED = '100114',
+  LOCATION_OR_GPS_NOT_ENABLED = '100115',
+  EXECUTION_ENGINE_ERROR = '100116',
+  UNEXPECTED_ERROR = '100117',
+}
+```

package/android/build/.transforms/22228dd0a4a527a24ec811806cb09b83.bin

@@ -0,0 +1 @@
+o/classes

package/android/build/.transforms/94a07ea3e1b6cf7284a0d41cd59f08ef.bin

@@ -0,0 +1 @@
+o/classes

package/android/build/generated/source/buildConfig/debug/com/dispatchsdk/BuildConfig.java

@@ -0,0 +1,12 @@
+/**
+ * Automatically generated file. DO NOT MODIFY
+ */
+package com.dispatchsdk;
+
+public final class BuildConfig {
+  public static final boolean DEBUG = Boolean.parseBoolean("true");
+  public static final String LIBRARY_PACKAGE_NAME = "com.dispatchsdk";
+  public static final String BUILD_TYPE = "debug";
+  public static final int VERSION_CODE = -1;
+  public static final String VERSION_NAME = "";
+}

package/android/build/intermediates/aapt_friendly_merged_manifests/debug/aapt/AndroidManifest.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.dispatchsdk" >
+
+    <uses-sdk
+        android:minSdkVersion="21"
+        android:targetSdkVersion="30" />
+
+    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.CAMERA" />
+    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
+
+    <application>
+        <provider
+            android:name="androidx.core.content.FileProvider"
+            android:authorities="dollar_openBracket_applicationId_closeBracket.provider"
+            android:exported="false"
+            android:grantUriPermissions="true" >
+            <meta-data
+                android:name="android.support.FILE_PROVIDER_PATHS"
+                android:resource="@xml/file_paths" />
+        </provider>
+
+        <service
+            android:name="com.dispatchsdk.sync.SyncManagerService"
+            android:enabled="true"
+            android:exported="false" />
+        <service android:name="com.dispatchsdk.sync.SyncEventService" />
+    </application>
+
+</manifest>

package/android/build/intermediates/aapt_friendly_merged_manifests/debug/aapt/output.json

@@ -0,0 +1,26 @@
+{
+  "version": 1,
+  "applicationId": "com.dispatchsdk",
+  "variantType": "LIBRARY",
+  "elements": [
+    {
+      "outputType": {
+        "type": "AAPT_FRIENDLY_MERGED_MANIFESTS"
+      },
+      "apkData": {
+        "type": "MAIN",
+        "splits": [],
+        "versionCode": -1,
+        "outputFile": "dispatchsdk-debug.aar",
+        "fullName": "debug",
+        "baseName": "debug",
+        "dirName": ""
+      },
+      "path": "AndroidManifest.xml",
+      "properties": {
+        "packageId": "com.dispatchsdk",
+        "split": ""
+      }
+    }
+  ]
+}

package/android/build/intermediates/annotation_processor_list/debug/annotationProcessors.json

@@ -0,0 +1 @@
+{}