@os1-platform/dispatch-mobile 2.1.2 → 2.1.3

package/src/components/executiontasks/scan/ScanSchema.ts

@@ -0,0 +1,121 @@
+import type { PathParams, QueryParams } from '../../../utils/ApiUtils';
+import type {
+  BaseETRequest,
+  BaseETResponse,
+} from '../../../models/execTasks/ETBaseModels';
+import type {
+  Headers,
+  HTTPMethod,
+  HTTPRequestBody,
+} from '../httpRequest/HttpRequestETSchema';
+import { BaseETProps } from '../../../models/DispatchModels';
+
+export type ScanType = Array<ScannerType>; // Type of scan to support barcode scanner types
+
+export type ScannerType =
+  | 'QRCODE'
+  | 'aztec'
+  | 'codabar'
+  | 'code39'
+  | 'code93'
+  | 'code128'
+  | 'datamatrix'
+  | 'ean13'
+  | 'ean8'
+  | 'itf14'
+  | 'pdf417'
+  | 'upc_e';
+
+export type ScanMode = 'SINGLE' | 'MULTI'; // Mode of scanning
+
+export type MaxScanCount = number; // Max limit of items to be scanned in multi-scan mode
+
+export type Scans = Array<string>; // Scans input from the payload
+
+export type ValidationRegex = string; // Regex to validate scanned strings
+
+export interface API {
+  uri: string;
+  timeout?: number;
+  httpMethod: HTTPMethod;
+  headers?: Headers[];
+  requestBody?: HTTPRequestBody;
+  queryParams?: QueryParams[];
+  pathParams?: PathParams[];
+  responseJsonLogic: object;
+  errorJsonLogic: object;
+}
+
+export interface Validation {
+  selectedIndex: number;
+  logic: Scans | ValidationRegex | API;
+}
+
+export type MultiAdditionalConfig = 'ALL_OR_NONE' | 'SUBSET_OF_LIST';
+
+export interface AdditionalMultiConfig {
+  validationType: MultiAdditionalConfig;
+}
+
+export interface ERCode {
+  eventCode: string;
+  reasonCode?: string[];
+}
+
+export interface DefaultERC {
+  eventCode: string;
+  reasonCode?: string;
+}
+
+export interface ScannedInput {
+  scanType: ScanType;
+}
+
+export type ScannerInput = BaseETRequest &
+  AdditionData & {
+    scannedInput: ScannedInput;
+    scanMode: ScanMode;
+    scanCountLimit?: MaxScanCount;
+    validation: Validation;
+    additionalMultiConfig?: AdditionalMultiConfig;
+    defaultERC: DefaultERC;
+    ercSelector?: ERCode[];
+    exitOnError?: boolean;
+    scanToMerge?: boolean;
+    meta?: { [k: string]: any };
+    persistData: boolean;
+    onSubmitET: (scanETOutput: ScannerOutput) => void;
+  } & BaseETProps;
+
+export interface ScanData {
+  value: string; // Value of scanned item
+  validated?: boolean; // Boolean to denote if scan was validate successfully
+  timestamp: number; // Epoch timestamp for the scan
+}
+
+export interface ScannerOutput {
+  // Key can be 'default' also when default erc needs to be applied for rest of the workflowInstance
+  [mergedObjectiveId: string]: { output: BaseETResponse; count: number };
+}
+
+export interface AdditionData {
+  wfMeta: any;
+  mergedObjectiveId: string;
+}
+
+export interface IWIMappingUpdate {
+  data: {
+    scanned: number;
+    total: number;
+    mwId: string;
+    jobId: string;
+    displayInfo: any;
+    previousMWID: string;
+  };
+}
+
+export enum DeliverState {
+  CANCELLED = 'CANCELLED',
+  DELIVERE_LATER = 'DELIVER_LATER',
+  DELIVER_NOW = 'DELIVER_NOW',
+}

package/src/components/executiontasks/scan/constants.ts

@@ -0,0 +1,6 @@
+export const MAX_SHIPMENT_REACHED = `Max count of allowed shipments reached`;
+export const EMPTY_AWB = `Empty Shipment ID`;
+export const SHIPMENT_ALREADY_ADDED = `Shipment #<shipment_id> already added`;
+export const ADD_SHIPMENT = `Shipment #<shipment_id> scanned successfully`;
+export const INVALID_SHIPMENT = `Scanned Shipment is not a part of this order`;
+export const ER_MISSING = `Select Event code from drodown to scan shipment #<shipment_id>`;

package/src/components/executiontasks/scan/interfaces.ts

@@ -0,0 +1,109 @@
+import { SnackBarType } from 'src/components/widgets/SnackBarCustom';
+import { ScannerOutput } from './ScanSchema';
+import { IDispatchExecutor } from '@os1-platform/platform-coreos-execution-engine-sdk';
+
+export enum ExpoBarcodeTypes {
+  QRCODE = 'QRCODE',
+  aztec = 'aztec',
+  codabar = 'codabar',
+  code39 = 'code39',
+  code93 = 'code93',
+  code128 = 'code128',
+  datamatrix = 'datamatrix',
+  ean13 = 'ean13',
+  ean8 = 'ean8',
+  itf14 = 'itf14',
+  pdf417 = 'pdf417',
+  upc_e = 'upc_e',
+}
+
+export enum SCAN_STATUS {
+  SCANNED,
+  FAILED,
+}
+
+export interface ScannedItemData {
+  value: string; // Value of scanned item
+  validated?: boolean; // Boolean to denote if scan was validate successfully
+  timestamp?: number; // Epoch timestamp for the scan
+  reasonCode?: string;
+  reasonText?: string;
+  success?: boolean;
+  scanStatus: SCAN_STATUS;
+}
+
+export interface MergedScan {
+  value: string;
+  mergedObjectiveId?: string;
+  validated?: boolean;
+  timestamp?: number;
+  scanStatus?: SCAN_STATUS;
+  eventCode?: string;
+  reasonCode?: string;
+  success?: boolean;
+}
+
+export interface BlindScan {
+  maxCount: number;
+  scannedCount: number;
+}
+
+export enum PROCEED_STATUS {
+  DELIVER_NOW = 'DELIVER_NOW',
+  DELIVER_LATER = 'DELIVER_LATER',
+}
+
+export enum SummaryPageTabs {
+  ALL = 'All',
+  PENDING = 'Pending',
+  DELIVERED = 'Delivered',
+  UNDELIVERED = 'Undelivered',
+}
+
+export interface DisplaySummary {
+  scanId: string;
+  eventCode: string;
+  reasonCode: string;
+  clientName?: string;
+  orderId?: string;
+  prefixedMergedObjectiveId: string;
+  lastStatus: IDispatchExecutor.ExecutionStatus;
+}
+
+export type ListItem = DisplaySummary & {
+  index: number;
+};
+
+export interface SummaryDisplayData {
+  data: DisplaySummary[];
+  totalCount: number;
+}
+
+export interface ADD_SCAN {
+  status: boolean;
+  message: string;
+  type: SnackBarType;
+  exit?: boolean;
+  data?: any;
+}
+
+export interface SCAN_MERGED_OBJ_ID_INTEFACE {
+  [prefixedMergedObjectiveId: string]: SCANNED_RECORD;
+}
+
+export interface SCANNED_RECORD {
+  success: string[]; // Array merged objective ids which are of success type
+  failure: string[]; // Array merged objective ids which are of failure type
+  pending: string[]; // Array merged objective ids which are of pending type
+}
+
+export interface SHARED_PREF_SCAN_OUTPUT_INTERFACE {
+  [prefixedMergedObjectiveId: string]: ScannerOutput;
+}
+
+export interface TabRecord {
+  [SummaryPageTabs.ALL]: number;
+  [SummaryPageTabs.PENDING]: number;
+  [SummaryPageTabs.DELIVERED]: number;
+  [SummaryPageTabs.UNDELIVERED]: number;
+}

package/src/components/executiontasks/scan/modalConstant.ts

@@ -0,0 +1,120 @@
+import { ModalHookProps } from '../../../utils/hooks/useModal';
+
+interface UndeliveredShipmentModalInput {
+  pendingCount: number;
+  primaryButtonPress: () => any;
+  secondaryButtonPress: () => any;
+  primaryButtonStyles: any;
+  secondaryButtonStyles: any;
+  renderAdditionalButton: () => JSX.Element;
+}
+
+export const undeliveredShipmentModal = (
+  input: UndeliveredShipmentModalInput
+): ModalHookProps => {
+  return {
+    title: { label: 'Pending Shipments!' },
+    subTitle: {
+      label: `You still have ${input.pendingCount} unscanned shipment!`,
+      styles: { textAlign: 'center' },
+    },
+    primaryButton: {
+      label: 'Deliver at different location',
+      onPress: input.primaryButtonPress,
+      styles: input.primaryButtonStyles,
+    },
+    secondaryButton: {
+      label: 'Mark as Undelivered',
+      onPress: input.secondaryButtonPress,
+      styles: input.secondaryButtonStyles,
+    },
+    renderAdditionalButtons: input.renderAdditionalButton,
+  };
+};
+
+interface ERCModalInput {
+  renderChildren: () => JSX.Element;
+  primaryButtonPress: () => any;
+  secondaryButtonPress: () => any;
+  primaryButtonStyles: any;
+  secondaryButtonStyles: any;
+}
+
+export const ercModal = (input: ERCModalInput): ModalHookProps => {
+  return {
+    contentContainerStyle: { marginStart: 40, marginEnd: 40 },
+    title: { label: 'Mark as Undelivered' },
+    subTitle: {
+      label: `The shipments shall be updated with the following status:`,
+    },
+    renderChildren: input.renderChildren,
+    primaryButton: {
+      label: 'Proceed',
+      onPress: input.primaryButtonPress,
+      styles: input.primaryButtonStyles,
+    },
+    secondaryButton: {
+      label: 'Cancel',
+      onPress: input.secondaryButtonPress,
+      styles: input.secondaryButtonStyles,
+    },
+  };
+};
+
+interface RemoveShipmentModalInput {
+  primaryButtonPress: () => any;
+  secondaryButtonPress: () => any;
+  subTitleStyle: any;
+  primaryButtonStyles: any;
+  secondaryButtonStyles: any;
+}
+
+export const removeShipmentModal = (
+  input: RemoveShipmentModalInput
+): ModalHookProps => {
+  return {
+    title: { label: 'Remove Shipment' },
+    subTitle: {
+      label: `Are you sure you want to remove this shipment?`,
+      styles: input.subTitleStyle,
+    },
+    primaryButton: {
+      label: 'Proceed to Remove',
+      onPress: input.primaryButtonPress,
+      styles: input.primaryButtonStyles,
+    },
+    secondaryButton: {
+      label: 'Cancel',
+      onPress: input.secondaryButtonPress,
+      styles: input.secondaryButtonStyles,
+    },
+  };
+};
+
+interface EditERCModalInput {
+  renderChildren: () => JSX.Element;
+  buttonStyles: any;
+  primaryButtonPress: () => any;
+  secondaryButtonPress: () => any;
+  primaryButtonStyles: any;
+  secondaryButtonStyles: any;
+}
+
+export const editERCModal = (input: EditERCModalInput): ModalHookProps => {
+  return {
+    title: { label: 'Update' },
+    contentContainerStyle: { marginStart: 40, marginEnd: 40 },
+    renderChildren: input.renderChildren,
+    buttonStyle: input.buttonStyles,
+    primaryButton: {
+      label: 'Update',
+      onPress: input.primaryButtonPress,
+      styles: input.primaryButtonStyles,
+    },
+    secondaryButton: {
+      label: 'Cancel',
+      onPress: input.secondaryButtonPress,
+      styles: input.secondaryButtonStyles,
+    },
+  };
+};

package/src/components/executiontasks/scan/sub_components/CScanner.tsx

@@ -0,0 +1,107 @@
+import React, { memo, useEffect, useState } from 'react';
+import { Platform, StyleSheet, Text, View } from 'react-native';
+import { BarCodeScanningResult, Camera } from 'expo-camera';
+import { isEmptyOrBlank } from '../../../../utils/utils';
+import { checkCameraPermissionUtil } from '../../imageCapture/CaptureUtils';
+import { Title } from 'react-native-paper';
+import { BlurView } from 'expo-blur';
+import { useSafeAreaInsets } from 'react-native-safe-area-context';
+import { Fonts } from '../../../../styles/executionTasks/CommonStyles';
+
+function Hint({ children }: { children: string }) {
+  return (
+    <BlurView style={styles.hint} intensity={50} tint="dark">
+      <Text style={styles.headerText}>{children}</Text>
+    </BlurView>
+  );
+}
+const CScanner = (props: CScannerProps) => {
+  const [isVisible, setVisible] = useState(true);
+  const [hasPermission, setHasPermission] = useState<boolean | null>(null);
+  const { top } = useSafeAreaInsets();
+
+  useEffect(() => {
+    (async () => {
+      let response = await checkCameraPermissionUtil();
+      setHasPermission(response);
+    })();
+  }, []);
+
+  const _handleBarCodeScanned = (scan: BarCodeScanningResult) => {
+    if (!isEmptyOrBlank(scan.data)) {
+      setVisible(false);
+      props.onScanned(scan.data);
+    }
+  };
+
+  if (!hasPermission) {
+    return (
+      <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
+        <Title>
+          {
+            'No Permissions for Camera. Please provide camera permissions from app\
+            settings.'
+          }
+        </Title>
+      </View>
+    );
+  }
+  return (
+    <>
+      {isVisible ? (
+        <Camera
+          barCodeScannerSettings={{
+            barCodeTypes: props.barCodeTypes,
+          }}
+          onBarCodeScanned={_handleBarCodeScanned}
+          style={StyleSheet.absoluteFill}
+        />
+      ) : null}
+      <View style={[styles.header, { top: 16 + top }]}>
+        <Hint>{'or \nScan Shipment ID'}</Hint>
+      </View>
+    </>
+  );
+};
+
+// exporting Scanner as Pure Component
+export default memo(CScanner);
+
+export interface CScannerProps {
+  barCodeTypes: any[];
+  onScanned: (value: string) => void;
+}
+
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+    backgroundColor: '#000',
+    justifyContent: 'center',
+    alignItems: 'center',
+  },
+  hint: {
+    paddingHorizontal: 16,
+    paddingVertical: 20,
+    overflow: 'hidden',
+    justifyContent: 'center',
+    alignItems: 'center',
+  },
+
+  headerText: {
+    color: '#fff',
+    backgroundColor: 'transparent',
+    textAlign: 'center',
+    fontSize: 16,
+    fontWeight: '500',
+  },
+  header: {
+    position: 'absolute',
+    left: 0,
+    right: 0,
+    alignItems: 'center',
+    fontFamily:
+      Platform.OS === 'android'
+        ? Fonts.IBMPlexSans_600SemiBold
+        : 'IBMPlexSans-SemiBold',
+  },
+});

package/src/components/executiontasks/scan/sub_components/DropDownUtils.ts

@@ -0,0 +1,119 @@
+import type { ercItem } from './ERDropDown';
+import ReasonCodeContainer from '../../../../manager/dispatchCodes/ReasonCodeContainer';
+import type { DefaultERC, ERCode } from '../ScanSchema';
+import EventCodeContainer from '../../../../manager/dispatchCodes/EventCodeContainer';
+import EventCodeRepo from '../../../../manager/dispatchCodes/EventCodeRepo';
+import ReasonCodeRepo from '../../../../manager/dispatchCodes/ReasonCodeRepo';
+import { ReasonsRow } from '../../../../manager/syncmanager/DBConfig';
+
+export async function getErcDropDownItems(
+  type: 'EVENT' | 'REASON',
+  list: ERCode[],
+  eventCode?: string
+): Promise<ercItem[] | []> {
+  if (!list) return [];
+  let erc: ercItem[] = [];
+  if (type === 'EVENT') {
+    const eventCodesList = list.map((erc) => erc.eventCode);
+    const eventCodes = await EventCodeRepo.getInstance().getEventsByCode(
+      eventCodesList
+    );
+    erc = eventCodes
+      .map((eventCode) => ({
+        text: eventCode.description ?? `NO DESCRIPTION FOUND for ${eventCode}`,
+        code: eventCode.eventCode,
+        success: eventCode.successEvent,
+      }))
+      .sort((a, b) => {
+        // Sort by success (true first, false second)
+        if (a.success !== b.success) {
+          return b.success ? 1 : -1;
+        }
+
+        // Sort by text in alphabetical order
+        return a.text.localeCompare(b.text);
+      });
+    // OLD CODE
+    // for (const e of list) {
+    //   let eventByCode = await EventCodeContainer.getInstance().getEventByCode(
+    //     e.eventCode
+    //   );
+    //   if (eventByCode) {
+    //     erc.push({
+    //       text:
+    //         eventByCode?.description ??
+    //         `NO DESCRIPTION FOUND for ${e.eventCode}`,
+    //       code: e.eventCode,
+    //       success: eventByCode.successEvent,
+    //     });
+    //   }
+    //   erc.sort((a, b) => {
+    //     // Sort by success (true first, false second)
+    //     if (a.success !== b.success) {
+    //       return b.success ? 1 : -1;
+    //     }
+
+    //     // Sort by text in alphabetical order
+    //     return a.text.localeCompare(b.text);
+    //   });
+    // }
+  } else if (type === 'REASON' && eventCode) {
+    const item = list.find((erc) => erc.eventCode === eventCode);
+    const reasonCodesList = item?.reasonCode || [];
+    const reasonCodes = await ReasonCodeRepo.getInstance().getReasonsByCode(
+      reasonCodesList
+    );
+    erc = reasonCodes.map((code: ReasonsRow) => ({
+      text: code?.description ?? `NO DESCRIPTION FOUND for ${code}`,
+      code: code.reasonCode,
+      success: false,
+    }));
+
+    // OLD CODE
+    // for (const ev of list) {
+    //   if (ev.eventCode === eventCode) {
+    //     if (ev.reasonCode)
+    //       for (const r of ev.reasonCode) {
+    //         let reasonByCode =
+    //           await ReasonCodeContainer.getInstance().getReasonByCode(r);
+    //         if (reasonByCode) {
+    //           erc.push({
+    //             text:
+    //               reasonByCode?.description ?? `NO DESCRIPTION FOUND for ${r}`,
+    //             code: r,
+    //             success: false,
+    //           });
+    //         }
+
+    //         // TODO: NEEDS TO CHANGE WHEN PROPER SOLUTION WITH ORDER IS GIVEN, AS ALPHABETICAL ORDER DOESN'T SUFFICE, REF: https://dev.azure.com/DelhiveryPlatform/Solutions/_workitems/edit/15003
+    //         // erc.sort((a, b) => {
+    //         //   // Sort by text in alphabetical order
+    //         //   return a.text.localeCompare(b.text);
+    //         // });
+    //       }
+    //     break;
+    //   }
+    // }
+  }
+  return erc;
+}
+
+export async function getDefaultERCLabel(defaultERC: DefaultERC) {
+  let eventCode = defaultERC.eventCode;
+  let reasonCode = defaultERC.reasonCode || '';
+  let eventByCode = await EventCodeContainer.getInstance().getEventByCode(
+    defaultERC.eventCode
+  );
+  if (eventByCode && eventByCode.description)
+    eventCode = eventByCode.description;
+
+  if (defaultERC.reasonCode) {
+    let reasonByCode = await ReasonCodeContainer.getInstance().getReasonByCode(
+      defaultERC.reasonCode
+    );
+    if (reasonByCode && reasonByCode.description)
+      reasonCode = reasonByCode?.description;
+  }
+
+  return { eventCode, reasonCode };
+}