@os1-platform/dispatch-mobile 1.3.11 → 2.0.0

package/README.md

@@ -36,11 +36,15 @@ This sdk can be used to render execution task screens on ui, maintain their stat
   - Format of events:
     ```js
     const eventName =
-      `onTaskStart:{ET_Name}` | `onTaskEnd:{ET_name}` | `onTaskBack:{ET_name}`;
+      `onTaskStart:{ET_Name}` |
+      `onTaskEnd:{ET_name}` |
+      `onTaskBack:{ET_name}` |
+      `onScan:{ET_name}` |
+      `onScanRemove:{ET_name}`;
     ```
   - Usage:
     ```js
-    import { eventListener } from '@dispatch-sdk';
+    import { eventListener } from '@os1-platform/dispatch-mobile';
     eventListener.on('{eventName}', (eventData) => {
       console.log(eventData);
     });
@@ -209,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: 'delhivery',
+  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';
 
 /**
@@ -234,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
 );
 ```
 
@@ -273,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
@@ -451,7 +619,7 @@ let mtsInitReq: MTSInitRequest = {
   configData: mtsDefaults,
   baseURL: 'https://delhivery.aws.preprod.fxtrt.io/app/dispatch/v1/api/mts/',
   accessToken: 'token',
-  tenantID: 'delhivery',
+  tenantID: tenantId,
 };
 await MtsLib.initMTS(mtsInitReq);
 //See Error Codes for Possible error types

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

@@ -1,2 +1,2 @@
-#Wed Jun 28 12:43:39 IST 2023
-gradle.version=6.8
+#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

@@ -1,12 +1,17 @@
 <?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="gradleJvm" value="11 (2)" />
+        <option name="modules">
+          <set>
+            <option value="$PROJECT_DIR$" />
+          </set>
+        </option>
       </GradleProjectSettings>
     </option>
   </component>

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

@@ -1,4 +1,9 @@
-<?xml version="1.0" encoding="UTF-8"?>
 <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/local.properties

@@ -4,5 +4,5 @@
 # Location of the SDK. This is only used by Gradle.
 # For customization when using a Version Control System, please read the
 # header note.
-#Sun Apr 02 13:55:41 IST 2023
+#Mon Jul 31 14:48:47 IST 2023
 sdk.dir=/Users/delhivery/Library/Android/sdk

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)
     )
   }
 

package/android/src/main/java/com/dispatchsdk/sharedPref/SharedPreferenceModule.kt

@@ -0,0 +1,166 @@
+package com.dispatchsdk.sharedPref
+
+import android.content.Context
+import android.content.SharedPreferences
+import com.dispatchsdk.utils.Tracer
+import com.facebook.react.bridge.*
+import javax.annotation.Nonnull
+import org.json.JSONArray
+
+class SharedPreferenceModule(private val reactContext: ReactApplicationContext) :
+    ReactContextBaseJavaModule(reactContext) {
+
+  companion object {
+    private var sharedPreference: SharedPreferences? = null
+    const val MODULE_NAME = "SharedPreferencesModule"
+    private var sharedName = "dispatch_shared_preferences"
+  }
+
+  fun getInstance(): SharedPreferences {
+    if (sharedPreference == null) {
+      sharedPreference = reactContext.getSharedPreferences(sharedName, Context.MODE_PRIVATE)
+    }
+    return sharedPreference!!
+  }
+
+  @Nonnull
+  override fun getName(): String {
+    return MODULE_NAME
+  }
+
+  @ReactMethod
+  fun setItem(key: String, value: String): Boolean {
+    val _sharedPreference = getInstance()
+    var editor = _sharedPreference.edit()
+    var result = editor.putString(key, value).commit()
+    return result
+  }
+
+  @ReactMethod
+  fun setItems(keyValue: String): Boolean {
+    var _keyValue = JSONArray(keyValue)
+    val _sharedPreference = getInstance()
+    var editor = _sharedPreference.edit()
+    for (i in 0 until _keyValue.length()) {
+      val item = _keyValue.getJSONObject(i)
+      var key = item.get("key")
+      var value = item.get("value")
+      editor.putString(key as String?, value as String?)
+    }
+    return editor.commit()
+  }
+
+  @ReactMethod
+  fun getItem(key: String, promise: Promise) {
+    try {
+      val _sharedPreference = getInstance()
+      var result = _sharedPreference.getString(key, null)
+      promise.resolve(result)
+    } catch (e: Throwable) {
+      promise.reject("getItem sharedPreferences Error: ", e)
+    }
+  }
+
+  @ReactMethod
+  fun getItems(keys: ReadableArray, promise: Promise) {
+    try {
+      val _sharedPreference = getInstance()
+
+      val keysArray = arrayOfNulls<String>(keys.size())
+      for (i in 0 until keys.size()) {
+        keysArray[i] = keys.getString(i)
+      }
+
+      val results = Array(keysArray.size) { arrayOfNulls<String>(2) }
+      for (i in keysArray.indices) {
+        results[i][0] = keysArray[i]
+        results[i][1] = _sharedPreference.getString(keysArray[i], null)
+      }
+
+      val data = WritableNativeArray()
+      for (i in 0 until keys.size()) {
+        val arr: WritableArray = WritableNativeArray()
+        arr.pushString(results[i][0])
+        arr.pushString(results[i][1])
+        data.pushArray(arr)
+      }
+
+      promise.resolve(data)
+    } catch (e: Throwable) {
+      promise.reject("getItems sharedPreferences Error: ", e)
+    }
+  }
+
+  @ReactMethod
+  fun getAll(promise: Promise) {
+    try {
+      val _sharedPreference = getInstance()
+
+      val keyValues: Map<String, *> = _sharedPreference.all
+      val keys: List<String> = ArrayList(keyValues.keys)
+      val results = Array(keys.size) { arrayOfNulls<String>(2) }
+      for (i in keys.indices) {
+        results[i][0] = keys[i]
+        results[i][1] = keyValues[keys[i]].toString()
+      }
+
+      val data = WritableNativeArray()
+      for (i in results.indices) {
+        val arr: WritableArray = WritableNativeArray()
+        arr.pushString(results[i][0])
+        arr.pushString(results[i][1])
+        data.pushArray(arr)
+      }
+
+      promise.resolve(data)
+    } catch (e: Throwable) {
+      promise.reject("getAll sharedPreferences Error: ", e)
+    }
+  }
+
+  @ReactMethod
+  fun getAllKeys(promise: Promise) {
+    try {
+      val _sharedPreference = getInstance()
+
+      val keyValues = _sharedPreference.all
+
+      val keys: List<String> = ArrayList(keyValues.keys)
+      val results = arrayOfNulls<String>(keys.size)
+      for (i in keys.indices) {
+        results[i] = keys[i]
+      }
+
+      val data = WritableNativeArray()
+      for (i in results.indices) {
+        data.pushString(results[i])
+      }
+      promise.resolve(data)
+    } catch (e: Throwable) {
+      promise.reject("getAllKeys sharedPreferences Error: ", e)
+    }
+  }
+
+  @ReactMethod
+  fun clear(): Boolean {
+    val _sharedPreference = getInstance()
+    return _sharedPreference.edit().clear().commit()
+  }
+
+  @ReactMethod
+  fun removeItem(key: String): Boolean {
+    val _sharedPreference = getInstance()
+    var editor = _sharedPreference.edit()
+    return editor.remove(key).commit()
+  }
+
+  @ReactMethod
+  fun removeItems(keys: ReadableArray): Boolean {
+    val _sharedPreference = getInstance()
+    var editor = _sharedPreference.edit()
+    for (i in 0 until keys.size()) {
+      editor.remove(keys.getString(i))
+    }
+    return editor.commit()
+  }
+}

package/lib/commonjs/@types/assets/index.d.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=index.d.js.map

package/lib/commonjs/@types/assets/index.d.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.d.ts"],"sourcesContent":["declare module '*.svg' {\n  import React from 'react';\n  import {SvgProps} from 'react-native-svg';\n  const content: React.FC<SvgProps>;\n  export default content;\n}\n"],"mappings":""}

package/lib/commonjs/components/dispatch/DispatchExecNavigator.js

@@ -237,16 +237,16 @@ const DispatchExecNavigator = _ref => {
 };
 function getMode(route) {
   try {
-    var _route$params$RoutePa, _route$params$RoutePa2, _route$params$RoutePa3, _route$params$RoutePa4;
-    return route === null || route === void 0 ? void 0 : (_route$params$RoutePa = route.params[_RouteParams.RouteParams.NEXT_STATES][0]) === null || _route$params$RoutePa === void 0 ? void 0 : (_route$params$RoutePa2 = _route$params$RoutePa.nextState) === null || _route$params$RoutePa2 === void 0 ? void 0 : (_route$params$RoutePa3 = _route$params$RoutePa2.data) === null || _route$params$RoutePa3 === void 0 ? void 0 : (_route$params$RoutePa4 = _route$params$RoutePa3.input) === null || _route$params$RoutePa4 === void 0 ? void 0 : _route$params$RoutePa4.paymentMode;
+    var _route$params$RoutePa;
+    return route === null || route === void 0 || (_route$params$RoutePa = route.params[_RouteParams.RouteParams.NEXT_STATES].input) === null || _route$params$RoutePa === void 0 ? void 0 : _route$params$RoutePa.paymentMode;
   } catch (error) {
     return '';
   }
 }
 function getTaskTitle(route) {
   try {
-    var _route$params$RoutePa5, _route$params$RoutePa6, _route$params$RoutePa7, _route$params$RoutePa8;
-    return route === null || route === void 0 ? void 0 : (_route$params$RoutePa5 = route.params[_RouteParams.RouteParams.NEXT_STATES][0]) === null || _route$params$RoutePa5 === void 0 ? void 0 : (_route$params$RoutePa6 = _route$params$RoutePa5.nextState) === null || _route$params$RoutePa6 === void 0 ? void 0 : (_route$params$RoutePa7 = _route$params$RoutePa6.data) === null || _route$params$RoutePa7 === void 0 ? void 0 : (_route$params$RoutePa8 = _route$params$RoutePa7.input) === null || _route$params$RoutePa8 === void 0 ? void 0 : _route$params$RoutePa8.title;
+    var _route$params$RoutePa2;
+    return route === null || route === void 0 || (_route$params$RoutePa2 = route.params[_RouteParams.RouteParams.NEXT_STATES].input) === null || _route$params$RoutePa2 === void 0 ? void 0 : _route$params$RoutePa2.title;
   } catch (error) {
     return '';
   }