@os1-platform/dispatch-mobile 1.0.8 → 1.3.11

package/README.md

@@ -18,20 +18,75 @@ 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}`;
+    ```
+  - Usage:
+    ```js
+    import { eventListener } from '@dispatch-sdk';
+    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 +99,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 +158,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
@@ -148,7 +214,7 @@ import { DispatchSDKManager } from '@os1-platform/dispatch-mobile';
 await DispatchSDKManager.getInstance().initDispatchSDK({
   userName: 'testuser',
   userID: 'testID',
-  tenantID: 'TENANTID',
+  tenantID: 'delhivery',
   tenantBaseURL: 'baseURL',
   accessToken: 'accessToken',
 });
@@ -253,7 +319,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 +433,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 +449,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: 'delhivery',
 };
 await MtsLib.initMTS(mtsInitReq);
 //See Error Codes for Possible error types

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

@@ -0,0 +1,2 @@
+#Wed Jun 28 12:43:39 IST 2023
+gradle.version=6.8

package/android/.idea/gradle.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <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)" />
+      </GradleProjectSettings>
+    </option>
+  </component>
+</project>

package/android/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ExternalStorageConfigurationManager" enabled="true" />
+</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/.idea/workspace.xml

@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AndroidLayouts">
+    <shared>
+      <config />
+    </shared>
+  </component>
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="NONE" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="9e0b05bf-ee06-4169-bdda-4954b118eea2" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/src/main/java/com/dispatchsdk/sharedPref/SharedPreferenceModule.kt" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/dispatchsdk/sharedPref/SharedPreferenceModule.kt" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/../example/env.json" beforeDir="false" afterPath="$PROJECT_DIR$/../example/env.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/../example/src/TaskDetail.tsx" beforeDir="false" afterPath="$PROJECT_DIR$/../example/src/TaskDetail.tsx" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/../src/manager/dispatch/DispatchStateContainer.tsx" beforeDir="false" afterPath="$PROJECT_DIR$/../src/manager/dispatch/DispatchStateContainer.tsx" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/../src/manager/sdk/DispatchSDKManager.ts" beforeDir="false" afterPath="$PROJECT_DIR$/../src/manager/sdk/DispatchSDKManager.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/../src/models/sdk.ts" beforeDir="false" afterPath="$PROJECT_DIR$/../src/models/sdk.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/../src/utils/storage.ts" beforeDir="false" afterPath="$PROJECT_DIR$/../src/utils/storage.ts" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="ExternalProjectsData">
+    <projectState path="$PROJECT_DIR$">
+      <ProjectState />
+    </projectState>
+  </component>
+  <component name="ExternalProjectsManager">
+    <system id="GRADLE">
+      <state>
+        <task path="$PROJECT_DIR$">
+          <activation />
+        </task>
+        <projects_view>
+          <tree_state>
+            <expand>
+              <path>
+                <item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
+                <item name="android" type="f1a62948:ProjectNode" />
+              </path>
+              <path>
+                <item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
+                <item name="android" type="f1a62948:ProjectNode" />
+                <item name="Tasks" type="e4a08cd1:TasksNode" />
+              </path>
+              <path>
+                <item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
+                <item name="android" type="f1a62948:ProjectNode" />
+                <item name="Tasks" type="e4a08cd1:TasksNode" />
+                <item name="other" type="c8890929:TasksNode$1" />
+              </path>
+            </expand>
+            <select />
+          </tree_state>
+        </projects_view>
+      </state>
+    </system>
+  </component>
+  <component name="FileTemplateManagerImpl">
+    <option name="RECENT_TEMPLATES">
+      <list>
+        <option value="Class" />
+        <option value="Kotlin Class" />
+      </list>
+    </option>
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$/.." />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectId" id="2RbHAcMjtvDnyVAejISeOEfpT5m" />
+  <component name="ProjectLevelVcsManager" settingsEditedManually="true">
+    <ConfirmationsSetting value="1" id="Add" />
+  </component>
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.cidr.known.project.marker&quot;: &quot;true&quot;,
+    &quot;cidr.known.project.marker&quot;: &quot;true&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/Users/delhivery/Documents/coreos_projects/platform-coreos-dispatch-sdk/android&quot;
+  }
+}</component>
+  <component name="RecentsManager">
+    <key name="android.template.656734805">
+      <recent name="com.dispatchsdk" />
+    </key>
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="9e0b05bf-ee06-4169-bdda-4954b118eea2" name="Changes" comment="" />
+      <created>1687511723592</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1687511723592</updated>
+    </task>
+    <servers />
+  </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State />
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+  <component name="XDebuggerManager">
+    <breakpoint-manager>
+      <breakpoints>
+        <line-breakpoint enabled="true" type="kotlin-line">
+          <url>file://$PROJECT_DIR$/src/main/java/com/dispatchsdk/utils/DispatchSdkUtils.kt</url>
+          <line>74</line>
+          <option name="timeStamp" value="1" />
+        </line-breakpoint>
+      </breakpoints>
+    </breakpoint-manager>
+  </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.
+#Sun Apr 02 13:55:41 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" />