@os1-platform/dispatch-mobile 1.0.8 → 2.0.0

package/README.md

@@ -18,20 +18,79 @@ This sdk can be used to render execution task screens on ui, maintain their stat
   - `Complete-Failure`
   - `Pickup`
   - `Doodle`
-  - `Forms`
+  - `Form`
   - `Display`
   - `Verify Location`
-  - `Verify OTP`
-  - `Verify String`
-  - `Scan QR/Barcode`
+  - `Verify Input`
+  - `Scan`
   - `Image Capture`
   - `Init Payment`
   - `Process Payment`
   - `Complete Payment`
+  - `Validate OTP`
 - `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)
+- `Async Events`: Support for async events triggered on start and end of every execution task except end-state tasks, as for them a summary is generated at the end of completion of workflow.
+
+  - Format of events:
+    ```js
+    const eventName =
+      `onTaskStart:{ET_Name}` |
+      `onTaskEnd:{ET_name}` |
+      `onTaskBack:{ET_name}` |
+      `onScan:{ET_name}` |
+      `onScanRemove:{ET_name}`;
+    ```
+  - Usage:
+    ```js
+    import { eventListener } from '@os1-platform/dispatch-mobile';
+    eventListener.on('{eventName}', (eventData) => {
+      console.log(eventData);
+    });
+    eventListener.remove('{eventName}');
+    ```
+  - Event data Payload:
+    `onTaskStart event`:
+
+    ```js
+      `onTaskStart:{ETCustomName}` = {
+        "timestamp":"number",
+        "taskId":"string",
+        "etData":{
+          "jobId1":{
+              ...ET inputs
+          },
+          "jobId2":{
+              ...ET inputs
+          }
+        }
+      }
+    ```
+
+    `onTaskEnd event` | `onTaskBack event`:
+
+    ```js
+      `onTaskEnd:{ETCustomName}` = {
+        "timestamp": "string",
+        "taskId": "string",
+        "etData":{
+          "jobId1":{
+              "success":"boolean",
+              "eventCode":"string",
+              "reasonCode":"string",
+              ...ET output
+          },
+          "jobId2":{
+              "success":"boolean",
+              "eventCode":"string",
+              "reasonCode":"string",
+              ...ET output
+          }
+        },
+        "meta"?:{},
+    }
+    ```
 
 ## Dispatch SDK Installation
 
@@ -44,50 +103,51 @@ npx install-expo-modules
 ### Install Dispatch SDK Package
 
 ```sh
-
+#using npm
 npm install @os1-platform/dispatch-mobile
-
 ```
 
-### Install these peer dependencies
+### Install these dependencies
 
 ```json
 {
-  "@apollo/client": "^3.5.6",
-  "@expo-google-fonts/ibm-plex-sans": "*",
-  "@os1-platform/mts-mobile": "^1.0.1",
-  "@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.7",
-  "@react-native-firebase/analytics": "^14.2.2",
-  "@react-native-firebase/app": "^14.2.2",
-  "@react-native-firebase/crashlytics": "^14.2.2",
-  "@react-native-firebase/messaging": "^14.2.2",
-  "@react-native-firebase/remote-config": "^14.2.2",
-  "@react-navigation/native": "^6.0.6",
-  "@react-navigation/native-stack": "^6.2.5",
-  "@sentry/react-native": "^3.2.13",
-  "axios": "^0.24.0",
-  "expo": "~43.0.4",
-  "expo-barcode-scanner": "~11.2.1",
-  "expo-blur": "~11.0.0",
-  "expo-camera": "~12.1.2",
-  "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",
-  "graphql": "^16.2.0",
-  "react": "^17.0.2",
-  "react-native": "^0.66.0",
-  "react-native-dropdown-picker": "^5.4.0",
-  "react-native-get-random-values": "^1.8.0",
-  "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"
+  "dependencies": {
+    "@apollo/client": "^3.5.6",
+    "@expo-google-fonts/ibm-plex-sans": "*",
+    "@foxtrotplatform/platform-coreos-mts-sdk": "^0.5.10",
+    "@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.7",
+    "@react-native-firebase/analytics": "^14.2.2",
+    "@react-native-firebase/app": "^14.2.2",
+    "@react-native-firebase/crashlytics": "^14.2.2",
+    "@react-native-firebase/messaging": "^14.2.2",
+    "@react-native-firebase/remote-config": "^14.2.2",
+    "@react-navigation/native": "^6.0.6",
+    "@react-navigation/native-stack": "^6.2.5",
+    "@sentry/react-native": "^3.2.13",
+    "axios": "^0.24.0",
+    "expo": "~47.0.13",
+    "expo-barcode-scanner": "~11.4.0",
+    "expo-blur": "~11.0.0",
+    "expo-camera": "~13.1.0",
+    "expo-file-system": "~15.1.1",
+    "expo-font": "~11.0.1",
+    "expo-image-manipulator": "~11.0.0",
+    "expo-image-picker": "~14.1.0",
+    "expo-location": "~15.0.1",
+    "expo-sqlite": "~11.0.0",
+    "graphql": "^16.2.0",
+    "react": "^18.0.0",
+    "react-native": "^0.69.5",
+    "react-native-dropdown-picker": "^5.4.0",
+    "react-native-get-random-values": "^1.8.0",
+    "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"
+  }
 }
 ```
 
@@ -102,6 +162,16 @@ android:allowBackup="false"
 tools:replace="android:allowBackup"
 ```
 
+```xml
+<activity
+      android:name=".MainActivity"
+      android:configChanges="keyboard|keyboardHidden|orientation|screenSize|uiMode"
+      android:label="@string/app_name"
+      android:launchMode="singleTask"
+      android:windowSoftInputMode="adjustResize"
+      android:exported="true">
+```
+
 ### Add jcenter() if not added already added in the Project-level build.gradle (<project>/build.gradle): (Android only)
 
 ```txt
@@ -143,20 +213,92 @@ exports.resolver = {
 ### Init Dispatch SDK
 
 ```tsx
+interface EventMapping {
+  eventCode: string;
+  successEvent: boolean;
+  description: string;
+}
+
+interface DispatchSDKConfig {
+  ...previous configs
+  debugLevelLog?: Boolean;
+  callbacks?: {
+    fetchPhoneNumbersCallback?: (sdsIds: string[]) => Promise<{ key: string; value: string[]}>;
+  };
+}
+
+
+const fetchPhoneNumbersCallback = (ids: string[]) => {
+  console.log('sds ids: ', ids);
+  return {
+    key: 'phoneNumber', //This key is same, what was being sent in meta as key
+    value: ['8888888888'],
+  };
+};
+
 import { DispatchSDKManager } from '@os1-platform/dispatch-mobile';
 
 await DispatchSDKManager.getInstance().initDispatchSDK({
   userName: 'testuser',
   userID: 'testID',
-  tenantID: 'TENANTID',
+  tenantID: tenantId,
   tenantBaseURL: 'baseURL',
   accessToken: 'accessToken',
+  headers: {
+    'x-user-id': 'testID',
+    'x-coreos-tid': tenantId,
+    'x-coreos-access': accessToken,
+    'Content-Type': 'application/json',
+    'x-coreos-request-id': new Date().getTime(),
+    'x-coreos-userinfo': JSON.stringify({ id: 'testID' }),
+  },
+  // Used for Scan ET dropdown list => eventMapping: EventMapping[]
+  eventMapping: [
+    {
+      eventCode: 'E-010',
+      successEvent: true,
+      description: 'Success',
+    },
+    {
+      eventCode: 'E-011',
+      successEvent: false,
+      description: 'Failure',
+    },
+  ],
+  callbacks: { fetchPhoneNumbersCallback }, // Callback to fetch mobile number based on the sds-ids passed
 });
 ```
 
 ### Init Execution engine
 
 ```ts
+interface Job {
+    id: string;
+    jobRef: string;
+    jobWorkflowId: string;
+    status: string;
+    subStatus?: string | null;
+    containers: Array<Container>;
+    customData: any;
+    displayInfo: any;
+    start: string;
+    objectives: Array<Objective>;
+}
+
+interface Workflow {
+    name: string;
+    id: string;
+    tag: IWfTag[];
+    description: string;
+    flows: Array<ExecutionTask>;
+    expire?: boolean;
+    meta?: string;
+}
+
+interface Workflows {
+  [workflowId:string]: Workflow;
+}
+
 import { DispatchStateContainer } from '@os1-platform/dispatch-mobile';
 
 /**
@@ -168,26 +310,10 @@ import { DispatchStateContainer } from '@os1-platform/dispatch-mobile';
  */
 
 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'
+  dispatchID: string,
+  dispatchJobs: Job[],
+  dispatchWorkflows: Workflows,
+  maxTaskReattempt?: number
 );
 ```
 
@@ -207,13 +333,121 @@ React.useEffect(() => {
 }, [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
+success: true,
+initRoute: 'TaskDetail',
+mergedWI: {
+  mwId: route.params.moId,
+  customEventsData: {},
+  statusFilter: ExecutionStatus[]
+},
+successRoute: 'SuccessScreen',
+failureRoute: 'FailureScreen',
+meta: META,
 });
+
+```
+
+### Objective Summary Route Params
+
+```ts
+
+export interface ObjectiveSummary {
+entityCode: string;
+eventCode: string;
+reasonCode: string;
+reasonCodeDesc?: string;
+}
+
+// When navigating to success or failure route, following are the route params:
+{
+summary: {
+ success?: ObjectiveSummary[];
+ failure?: ObjectiveSummary[];
+},
+objSuccess: boolean,
+}
+```
+
+### New functions
+
+```ts
+// getObjectiveTaskList
+public async getMergedObjectiveList getObjectiveTaskList(
+    status: ExecutionStatus[]
+  ): Promise<IObjectiveTask[]> {
+    return [];
+  }
+
+// getObjectiveTaskDetails
+public async getMergedObjectiveDetails getObjectiveTaskDetails(
+    mwId: string,
+    status: ExecutionStatus[]
+  ):  Promise< (IObjectiveTask & { workflowData: StoredWorkflowInstance[] | [] }) | {} >
+  {
+    return [];
+  }
+
+// Inventory Data
+public async getRiderInventory(): Promise<IDispatch.ItemsInRiderCustody> {
+	return {}
+}
+```
+
+### Interfaces
+
+```ts
+export interface IObjectiveTask {
+  id: string;
+  status: ExecutionStatus;
+  tags: IWfTag[];
+  inputs: any;
+  instanceCount: number;
+  location: Location;
+  contact: string[];
+}
+
+export interface StoredWorkflowInstance {
+  id: string;
+  mergedObjectiveId: string;
+  jobId: string;
+  scannableId: string;
+  initialMergedObjectiveId: string;
+  status: ExecutionStatus;
+  jobWorkflowId: string;
+  workflowId: string;
+  displayInfo: any;
+  cashAmount: number;
+}
+
+enum ExecutionStatus {
+  READY = 'READY',
+  IN_PROGRESS = 'IN_PROGRESS',
+  NOT_READY = 'NOT_READY',
+  COMPLETED_SUCCESS = 'COMPLETED-SUCCESS',
+  COMPLETED_FAILURE = 'COMPLETED-FAILURE',
+}
+
+interface IWfTag {
+  name: string;
+  value: string;
+}
+
+export interface Location {
+  locationId: string;
+  address?: any;
+  geolocation?: any;
+}
+export interface ItemsInRiderCustody {
+  shipments: {
+    totalCount: number;
+    deliveredCount: number;
+    pickedCount: number;
+  };
+  cash: {
+    expectedAmount: number;
+    collectedAmount: number;
+  };
+}
 ```
 
 ## FCM
@@ -253,7 +487,9 @@ buildscript {
     // ...
 
     // Add the following line:
-    classpath 'com.google.gms:google-services:4.3.10'  // Google Services plugin
+    classpath("com.android.tools.build:gradle:7.1.1")
+    classpath("com.google.gms:google-services:4.3.10")  // Google Services plugin
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   }
 }
 
@@ -365,7 +601,7 @@ let granted = await MtsLib.requestPermissionsForMTS();
 ### Init MTS
 
 ```ts
-import type { MTSInitRequest } from '@os1-platform/mts-mobile';
+import type { MTSInitRequest } from '@foxtrotplatform/platform-coreos-mts-sdk';
 
 let mtsDefaults = new MtsLib.MTSDefaults();
 mtsDefaults.speedLimit = 5000;
@@ -381,9 +617,9 @@ let mtsInitReq: MTSInitRequest = {
   appVersion: '1',
   mtsDeviceID: 'deviceId', // use FCM ID here
   configData: mtsDefaults,
-  baseURL: 'https://{tenantId}.example.io/{mtsEndpoint}',
+  baseURL: 'https://delhivery.aws.preprod.fxtrt.io/app/dispatch/v1/api/mts/',
   accessToken: 'token',
-  tenantID: 'TENANTID',
+  tenantID: tenantId,
 };
 await MtsLib.initMTS(mtsInitReq);
 //See Error Codes for Possible error types

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -0,0 +1,2 @@
+#Mon Jul 31 14:50:42 IST 2023
+gradle.version=7.2

package/android/.idea/compiler.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CompilerConfiguration">
+    <bytecodeTargetLevel target="17" />
+  </component>
+</project>

package/android/.idea/gradle.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GradleMigrationSettings" migrationVersion="1" />
+  <component name="GradleSettings">
+    <option name="linkedExternalProjectsSettings">
+      <GradleProjectSettings>
+        <option name="testRunner" value="GRADLE" />
+        <option name="distributionType" value="DEFAULT_WRAPPED" />
+        <option name="externalProjectPath" value="$PROJECT_DIR$" />
+        <option name="modules">
+          <set>
+            <option value="$PROJECT_DIR$" />
+          </set>
+        </option>
+      </GradleProjectSettings>
+    </option>
+  </component>
+</project>

package/android/.idea/jarRepositories.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="RemoteRepositoriesConfiguration">
+    <remote-repository>
+      <option name="id" value="central" />
+      <option name="name" value="Maven Central repository" />
+      <option name="url" value="https://repo1.maven.org/maven2" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="jboss.community" />
+      <option name="name" value="JBoss Community repository" />
+      <option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="React Native sources" />
+      <option name="name" value="React Native sources" />
+      <option name="url" value="file:$PROJECT_DIR$/../node_modules/react-native/android/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="MavenRepo" />
+      <option name="name" value="MavenRepo" />
+      <option name="url" value="https://repo.maven.apache.org/maven2/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="BintrayJCenter" />
+      <option name="name" value="BintrayJCenter" />
+      <option name="url" value="https://jcenter.bintray.com/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="Google" />
+      <option name="name" value="Google" />
+      <option name="url" value="https://dl.google.com/dl/android/maven2/" />
+    </remote-repository>
+  </component>
+</project>

package/android/.idea/kotlinc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="KotlinJpsPluginSettings">
+    <option name="version" value="1.7.10" />
+  </component>
+</project>

package/android/.idea/misc.xml

@@ -0,0 +1,9 @@
+<project version="4">
+  <component name="ExternalStorageConfigurationManager" enabled="true" />
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="jbr-17" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/build/classes" />
+  </component>
+  <component name="ProjectType">
+    <option name="id" value="Android" />
+  </component>
+</project>

package/android/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
+  </component>
+</project>

package/android/gradle.properties

@@ -1,4 +1,4 @@
-DispatchSdk_kotlinVersion=1.3.50
+DispatchSdk_kotlinVersion=1.7.10
 DispatchSdk_compileSdkVersion=30
 DispatchSdk_buildToolsVersion=29.0.2
 DispatchSdk_targetSdkVersion=30

package/android/local.properties

@@ -0,0 +1,8 @@
+## This file must *NOT* be checked into Version Control Systems,
+# as it contains information specific to your local configuration.
+#
+# Location of the SDK. This is only used by Gradle.
+# For customization when using a Version Control System, please read the
+# header note.
+#Mon Jul 31 14:48:47 IST 2023
+sdk.dir=/Users/delhivery/Library/Android/sdk

package/android/src/main/AndroidManifest.xml

@@ -7,7 +7,6 @@
   <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" />
 
 
 

package/android/src/main/java/com/dispatchsdk/DispatchSdkPackage.kt

@@ -1,5 +1,6 @@
 package com.dispatchsdk
 
+import com.dispatchsdk.sharedPref.SharedPreferenceModule
 import com.dispatchsdk.signaturePad.RSSignatureCaptureViewManager
 import com.dispatchsdk.sync.SyncModule
 import com.dispatchsdk.utils.DispatchSdkUtils
@@ -13,7 +14,8 @@ class DispatchSdkPackage : ReactPackage {
   override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
     return listOf(
       SyncModule(reactContext),
-      DispatchSdkUtils(reactContext)
+      DispatchSdkUtils(reactContext),
+      SharedPreferenceModule(reactContext)
     )
   }