@os1-platform/dispatch-mobile 2.0.8 → 2.1.0

package/src/models/DispatchModels.ts

@@ -0,0 +1,97 @@
+import {
+  IDispatch,
+  IDispatchExecutor,
+} from '@os1-platform/platform-coreos-execution-engine-sdk';
+
+export interface BaseETProps {
+  showProgress: (loading: boolean) => void;
+}
+
+export enum SdkSyncType {
+  EVENTS_SYNC,
+  DOCUMENT_SYNC,
+}
+
+export interface JobObjectiveType {
+  objectiveId: string;
+  jobId: string;
+  groupId?: string;
+  additionalData?: any;
+}
+
+export interface endEvent {
+  taskId: string;
+  nextTaskId: string;
+  timestamp: number;
+  // groupId?: string;
+  customData?: any;
+  etData: {
+    [key: string]: any;
+    /* [key: string]: {
+      workflowInstanceId: string;
+      additionalData?: any;
+      success?: boolean;
+      eventCode?: string;
+      reasonCode?: string;
+      [key: string]: any;
+    }; */
+  };
+  meta?: any;
+}
+
+export interface onScanEvent {
+  taskId: string;
+  timestamp: number;
+  customData?: any;
+  etData: {
+    eventCode: string;
+    reasonCode: string;
+    success: boolean;
+    endTime: number;
+    scannedData: {
+      jobId: string;
+      scanValue: string;
+      shipmentFlow: string; //displayinfo
+      groupId: string; //displayinfo
+    }[];
+  };
+  meta?: any;
+}
+
+export interface onScanRemoveEvent {
+  taskId: string;
+  timestamp: number;
+  customData?: any;
+  etData: {
+    scannedData: {
+      scanValue: string;
+    }[];
+  };
+  meta?: any;
+}
+
+export interface startEvent {
+  timestamp: number;
+  taskId: string;
+  // groupId?: string;
+  customData?: any;
+  etData: {
+    [key: string]: any;
+    // [key: string]: {
+    //   workflowInstanceId: string;
+    //   additionalData?: any;
+    //   [key: string]: any;
+    // };
+  };
+}
+
+export interface stateParams {
+  next_states: IDispatch.IExecutionTaskQueryResponse;
+  rootMetaData: {
+    meta: any;
+    customEventsData?: any;
+    statusFilter: IDispatchExecutor.ExecutionStatus[];
+    prefixedMergedObjectiveId: string;
+  };
+  has_multiple_ets?: boolean;
+}

package/src/models/ReasonCodes.ts

@@ -0,0 +1,12 @@
+export interface ReasonCodes {
+  description: string;
+  isEnabled: boolean;
+  reasonCode: string;
+  isSystemDefined: boolean;
+}
+
+export interface EventCodes {
+  description: string;
+  eventCode: string;
+  successEvent: boolean;
+}

package/src/models/auth.ts

@@ -0,0 +1,43 @@
+export interface Device {
+  identifier: string;
+  type: string;
+}
+
+export interface Credential {
+  password: string;
+}
+export interface LoginPayload {
+  appName: string;
+  appSecret: string;
+  authType: string;
+  tenant: string;
+  username: string;
+  device: Device;
+  credential: Credential;
+}
+export interface Cookie {
+  platform_access_cookie: string;
+  platform_refresh_cookie: string;
+}
+
+export interface AccessTokenPayload {
+  accessToken: string;
+}
+
+export interface RefreshTokenPayload {
+  tenant: string;
+  appName: string;
+  applicationSecret: string;
+}
+export type LoginType =
+  | 'mobilePassword'
+  | 'mobileOtp'
+  | 'mPin'
+  | 'usernamePassword'
+  | 'clientCredential';
+
+// export type mainCookie = Cookie | any;
+
+export interface Headers {
+  requestId: string;
+}

package/src/models/execTasks/ETBaseModels.ts

@@ -0,0 +1,113 @@
+import { ExecutionTaskID } from './ETConfig';
+
+export type BaseETResponse = {
+  id: ExecutionTaskID;
+  mergedObjectiveIds: Array<string>;
+  /**
+   * Success flag for the operation performed by user
+   */
+  entityCode: string;
+  success: boolean;
+  /**
+   * Event code
+   */
+  eventCode: string;
+  /**
+   * Reason code
+   */
+  reasonCode: string;
+  /**
+   * Meta data related to execution of task
+   */
+  meta?: {
+    /**
+     * Epoch timestamp for the start of task
+     */
+    // startTime?: number;
+    /**
+     * Epoch timestamp for the end of task
+     */
+    // endTime?: number;
+    /**
+     * Location at start of task
+     */
+    // location?: {
+    /**
+     * Latitude
+     */
+    // latitude?: string;
+    /**
+     * Longitude
+     */
+    // longitude?: string;
+    // };
+    /**
+     * Unique identifier of user performing the action
+     */
+    userDetails: UserData;
+    /**
+     * Check if ETs are executed in merged form
+     */
+    // isMerged?: boolean;
+  };
+};
+export interface UserData {
+  id: string;
+  name: string;
+}
+
+/**
+ * Title of instruction
+ */
+export type Title = string;
+/**
+ * Message of instruction
+ */
+export type Message = string;
+/**
+ * Can go back
+ */
+export type CanGoBack = boolean;
+
+export type BaseETRequest = {
+  title: Title;
+  message?: Message;
+  canGoBack?: CanGoBack;
+  applicableReasons?: ApplicableReasons | NewApplicableReasons;
+  taskMeta?: { [k: string]: any };
+  wfMeta?: { [k: string]: any };
+  navigation?: any;
+  route?: any;
+  taskName: string;
+  mergedObjectiveId: Array<string>;
+};
+
+export type ApplicableReasons = {
+  [k: string]: string[];
+};
+
+export type NewApplicableReasons = {
+  success: { [k: string]: string[] };
+  failure: { [k: string]: string[] };
+  goBack?: { [k: string]: string[] };
+};
+
+export interface ETSummary {
+  name: string;
+  eventCode: string;
+  reasonCode: string;
+  reasonCodeDesc: string | null | undefined;
+}
+
+export interface CompleteSummary {
+  jobId: string;
+  objectiveRef: string;
+  jobObjectiveSummary: ETSummary[];
+}
+
+export interface ObjectiveSummary {
+  entityCode: string;
+  eventCode: string;
+  reasonCode: string;
+  reasonCodeDesc?: string;
+}

package/src/models/execTasks/ETConfig.ts

@@ -0,0 +1,94 @@
+export enum ExecutionTaskID {
+  DELIVER = 'etask:dcac5d49-c54c-5c38-a780-ad2e9ba5e2e2',
+  DOODLE = 'etask:cea7c9a7-3ee7-52e9-ab3e-82849675d745',
+  COMPLETED_FAILURE = 'etask:e04ab83d-2a02-5970-ade9-e2a8a879b200',
+  COMPLETED_SUCCESS = 'etask:134e93b4-49a8-59b9-bc6c-7bd9045728ff',
+  CAPTURE_INPUT = 'etask:7b5637cc-570e-5c9d-b184-ecfbbd7c198d',
+  START_WORKFLOW = 'etask:952f3754-12e8-5ff2-93a8-aca383d18e56',
+  FORMS = 'etask:80446347-ede5-5cf9-8e56-b3d59fda4b5c',
+  IMAGE_CAPTURE = 'etask:9370d00a-8d84-5bf9-94bb-cd8cc73eeeec',
+  INIT_PAYMENT = 'etask:4eb8d36b-6762-5c53-aca6-95b1f4e3aa3f',
+  PROCESS_PAYMENT = 'etask:9a559375-02a5-50fe-9ce4-0a36df6f324e',
+  COMPLETE_PAYMENT = 'etask:0e6c7bd7-c9ab-5b82-85b2-a054249bc1f1',
+  PICKUP = 'etask:04d2414c-ddc1-552e-af02-78073dbb8ff7',
+  SCAN = 'etask:28cba55d-2aad-5568-863a-9e7e645f8c7b',
+  VERIFY_LOCATION = 'etask:7f3897da-3a1f-5736-b8e5-5d9f131b13cd',
+  DISPLAY = 'etask:574ff9b0-c49c-5eb5-b550-8548ae0cab44',
+  VERIFY_INPUT = 'etask:6fc10a60-a144-5798-97f3-1f12e77f56e2',
+  DELIVER_CASH = 'etask:2fffdf62-62b3-5e70-bd9e-d4d2644ee2fe',
+  HTTP_REQUEST_ET = 'etask:e148b862-8368-5586-b29d-1eda95ffc8c4',
+  VALIDATE_OTP_ET = 'etask:8d5b96f3-7342-5e25-a57f-30004f53de17',
+}
+
+export enum ExecutionTaskName {
+  DELIVER = 'Deliver',
+  DOODLE = 'Signature',
+  COMPLETED_FAILURE = 'Please wait...',
+  COMPLETED_SUCCESS = 'Please wait...',
+  CAPTURE_INPUT = 'Form',
+  START_WORKFLOW = 'Please wait...',
+  FORMS = 'Form',
+  IMAGE_CAPTURE = 'Capture Image',
+  INIT_PAYMENT = 'Payment',
+  PROCESS_PAYMENT = 'Processing Payment',
+  COMPLETE_PAYMENT = 'Completing Payment',
+  PICKUP = 'Pickup',
+  SCAN = 'Scan',
+  VERIFY_LOCATION = 'Verify Location',
+  DISPLAY = 'Display',
+  VERIFY_INPUT = 'Verifying Input',
+  DELIVER_CASH = 'Drop Cash',
+  HTTP_REQUEST_ET = 'Network Request',
+  VALIDATE_OTP_ET = 'Validate OTP',
+}
+
+export enum CustomScreens {
+  REMARK_SCREEN = 'REMARKS_SCREEN',
+}
+export enum EntityCode {
+  DELIVER = '0010',
+  DOODLE = '0014',
+  COMPLETED_FAILURE = '0008',
+  COMPLETED_SUCCESS = '0007',
+  CAPTURE_INPUT = '0012',
+  START_WORKFLOW = '0006',
+  FORMS = '0015',
+  IMAGE_CAPTURE = '0011',
+  INIT_PAYMENT = '0017',
+  PROCESS_PAYMENT = '0018',
+  COMPLETE_PAYMENT = '0019',
+  PICKUP = '0009',
+  SCAN = '0016',
+  VERIFY_LOCATION = '0021',
+  DISPLAY = '0013',
+  VERIFY_INPUT = '0020',
+  DELIVER_CASH = '0022',
+  HTTP_REQUEST_ET = '0023', //todo change Entity ID here
+  VALIDATE_OTP_ET = '0052',
+}
+
+export enum BaseEventCodes {
+  ENTITY_SUCCESS = 'E-010',
+  ENTITY_FAILURE = 'E-011',
+}
+
+export enum FinalETName {
+  DELIVER = 'Deliver',
+  DOODLE = 'Doodle',
+  COMPLETED_FAILURE = 'Completed-Failure',
+  COMPLETED_SUCCESS = 'Completed-Success',
+  CAPTURE_INPUT = 'etask:7b5637cc-570e-5c9d-b184-ecfbbd7c198d',
+  START_WORKFLOW = 'Start',
+  FORMS = 'Form',
+  IMAGE_CAPTURE = 'etask:9370d00a-8d84-5bf9-94bb-cd8cc73eeeec',
+  INIT_PAYMENT = 'etask:4eb8d36b-6762-5c53-aca6-95b1f4e3aa3f',
+  PROCESS_PAYMENT = 'etask:9a559375-02a5-50fe-9ce4-0a36df6f324e',
+  COMPLETE_PAYMENT = 'etask:0e6c7bd7-c9ab-5b82-85b2-a054249bc1f1',
+  PICKUP = 'Pickup',
+  SCAN = 'Scan',
+  VERIFY_LOCATION = 'etask:7f3897da-3a1f-5736-b8e5-5d9f131b13cd',
+  DISPLAY = 'etask:574ff9b0-c49c-5eb5-b550-8548ae0cab44',
+  VERIFY_INPUT = 'etask:6fc10a60-a144-5798-97f3-1f12e77f56e2',
+  DELIVER_CASH = 'etask:2fffdf62-62b3-5e70-bd9e-d4d2644ee2fe',
+  VALIDATE_OTP_ET = 'Validate OTP',
+}

package/src/models/execution.ts

@@ -0,0 +1,9 @@
+export interface DisplayProps {
+  message: string;
+  primaryButtonName: string;
+  primaryButtonAction?: () => void;
+  displayType: string;
+  uri?: string;
+  secondaryButtonName?: string;
+  secondaryButtonAction?: () => void;
+}

package/src/models/fcm.ts

@@ -0,0 +1,6 @@
+export interface messageReceived {
+  (message: object): void;
+}
+export interface tokenRefreshed {
+  (token: string): void;
+}

package/src/models/sdk.ts

@@ -0,0 +1,35 @@
+import type { EventCodes } from './ReasonCodes';
+
+export interface DispatchSDKConfig {
+  tenantID: string;
+  userID: string;
+  userName: string;
+  tenantBaseURL: string;
+  headers?: { [key: string]: any };
+  enableLogging?: boolean;
+  syncRetryCount?: number;
+  accessToken: string;
+  sentry?: {
+    env: ENVIRONMENT;
+    enabled: boolean;
+    dsn?: string;
+  };
+  notificationConfig?: {
+    title: string;
+    description: string;
+    interval: number;
+  };
+  eventMapping?: EventCodes[];
+  debugLevelLog?: Boolean;
+  callbacks?: {
+    fetchPhoneNumbersCallback?: (
+      sdsIds: string[]
+    ) => Promise<{ key: string; value: string[] }>;
+  };
+}
+
+export enum ENVIRONMENT {
+  DEV = 'dev',
+  PRE_PROD = 'preprod',
+  PROD = 'prod',
+}

package/src/native/signature/SignatureCapture.tsx

@@ -0,0 +1,110 @@
+import React from 'react';
+import {
+  DeviceEventEmitter,
+  findNodeHandle,
+  requireNativeComponent,
+  UIManager,
+  ViewProps,
+} from 'react-native';
+
+const RSSignatureView = requireNativeComponent('RSSignatureView');
+
+class SignatureCapture extends React.Component<SignatureProps, any> {
+  subscriptions: any[];
+  constructor(props: SignatureProps) {
+    super(props);
+    this.onChange = this.onChange.bind(this);
+    this.subscriptions = [];
+  }
+
+  onChange(event: any) {
+    if (event.nativeEvent.encoded) {
+      if (!this.props.onSaveEvent) {
+        return;
+      }
+      this.props.onSaveEvent({
+        encoded: event.nativeEvent.encoded,
+      });
+    }
+
+    if (event.nativeEvent.dragged) {
+      if (!this.props.onDragEvent) {
+        return;
+      }
+      this.props.onDragEvent({
+        dragged: event.nativeEvent.dragged,
+      });
+    }
+  }
+
+  componentDidMount() {
+    if (this.props.onSaveEvent) {
+      let sub = DeviceEventEmitter.addListener(
+        'onSaveEvent',
+        this.props.onSaveEvent
+      );
+      this.subscriptions.push(sub);
+    }
+
+    if (this.props.onDragEvent) {
+      let sub = DeviceEventEmitter.addListener(
+        'onDragEvent',
+        this.props.onDragEvent
+      );
+      this.subscriptions.push(sub);
+    }
+  }
+
+  componentWillUnmount() {
+    this.subscriptions.forEach((sub) => sub.remove());
+    this.subscriptions = [];
+  }
+
+  render() {
+    return (
+      <RSSignatureView
+        style={{ flex: 1 }}
+        {...this.props} // @ts-ignore
+        onChange={this.onChange}
+      />
+    );
+  }
+
+  saveImage() {
+    UIManager.dispatchViewManagerCommand(
+      findNodeHandle(this),
+      UIManager.getViewManagerConfig('RSSignatureView').Commands.saveImage,
+      []
+    );
+  }
+
+  resetImage() {
+    UIManager.dispatchViewManagerCommand(
+      findNodeHandle(this),
+      UIManager.getViewManagerConfig('RSSignatureView').Commands.resetImage,
+      []
+    );
+  }
+}
+
+export type SignatureProps = ViewProps & {
+  rotateClockwise: boolean;
+  square: boolean;
+  viewMode: string;
+  showBorder: boolean;
+  showNativeButtons: boolean;
+  showTitleLabel: boolean;
+  maxSize: number;
+  minStrokeWidth: number;
+  maxStrokeWidth: number;
+  strokeColor: string;
+  backgroundColor: string;
+  onSaveEvent: (result: SignatureResponse) => void;
+  onDragEvent: ({ dragged }: { dragged: boolean }) => void;
+};
+
+export interface SignatureResponse {
+  encoded: string;
+}
+
+export default SignatureCapture;

package/src/network/GraphQLClient.ts

@@ -0,0 +1,147 @@
+import { ApolloClient, ApolloLink, from, HttpLink, InMemoryCache } from '@apollo/client';
+import { onError } from '@apollo/client/link/error';
+import ErrorCodes from '../errors/ErrorCodes';
+import { BaseError } from '../errors/BaseError';
+import {
+  CREATE_FMS_FOLDER,
+  CUSTODY_IN,
+  CUSTODY_OUT,
+  FETCH_REASONS,
+  WORKFLOW_UPDATE,
+} from './Queries';
+import { getHeaders } from './NetworkUtils';
+import ApolloLinkTimeout from 'apollo-link-timeout';
+
+const timeOutLink = new ApolloLinkTimeout(
+  120000,
+  408,
+);
+
+const errorLink = onError(({ graphQLErrors, networkError }) => {
+  if (graphQLErrors)
+    graphQLErrors.forEach(({ message, locations, path }) =>
+      console.log('apiError', `Message: ${message}, Location: ${JSON.stringify(locations)}, Path: ${JSON.stringify(path)}`));
+
+  if (networkError)
+  console.log('apiError', `[Network error]: ${networkError}`);
+});
+
+const logLink = new ApolloLink((operation, forward) => {
+  console.log("logLink", JSON.stringify(operation.operationName));
+  console.log("logLink ", JSON.stringify(operation.variables));
+  return forward(operation);
+});
+export default class GraphQLClient {
+  private static instance: GraphQLClient;
+  private client: ApolloClient<any> | null = null;
+
+  private constructor(baseURL: string) {
+    // old 
+    // this.client = new ApolloClient({
+    //   uri: baseURL + '/graphql',
+    //   cache: new InMemoryCache(),
+    // });
+
+    // New
+    const httpLink = new HttpLink({
+      uri: baseURL + '/graphql',
+    });
+    this.client = new ApolloClient({
+      cache: new InMemoryCache({ resultCaching: false }),
+      defaultOptions: {
+        query: { fetchPolicy: 'no-cache' },
+        mutate: { fetchPolicy: 'no-cache' },
+      },      
+      link: from([timeOutLink, errorLink, logLink, httpLink]),
+    });
+  }
+
+  public static init(baseURL: string) {
+    if (!GraphQLClient.instance) {
+      GraphQLClient.instance = new GraphQLClient(baseURL);
+    }
+    return GraphQLClient.instance;
+  }
+  public static getInstance(): GraphQLClient {
+    if (!GraphQLClient.instance) {
+      throw new BaseError(
+        ErrorCodes.GRAPHQL_CLIENT_NOT_INITIALIZED,
+        'Client is not initialized'
+      );
+    }
+    return GraphQLClient.instance;
+  }
+
+  public async fetchReasonCodes() {
+    return this.client?.query({
+      query: FETCH_REASONS,
+      variables: {
+        offset: '1',
+        limit: '500',
+      },
+      fetchPolicy: 'network-only',
+      context: {
+        headers: await getHeaders(API_CONTENT_TYPES.APPLICATION_JSON),
+      },
+    });
+  }
+
+  public async createFmsFolder(folderName: string, desc: string) {
+    const gRequest = {
+      name: folderName,
+      description: desc,
+    };
+    return this.client?.mutate({
+      mutation: CREATE_FMS_FOLDER,
+      variables: {
+        input: gRequest,
+      },
+      context: {
+        headers: await getHeaders(API_CONTENT_TYPES.APPLICATION_JSON),
+      },
+    });
+  }
+
+  public async postCustodyIn(data: any[], dspID: string) {
+    for (const d of data) delete d.dispatchId;
+    return this.client?.mutate({
+      mutation: CUSTODY_IN,
+      variables: {
+        input: { dispatchId: dspID, data: data },
+      },
+      context: {
+        headers: await getHeaders(API_CONTENT_TYPES.APPLICATION_JSON),
+      },
+    });
+  }
+  public async postCustodyOut(data: any[], dspID: string) {
+    for (const d of data) delete d.dispatchId;
+    return this.client?.mutate({
+      mutation: CUSTODY_OUT,
+      variables: {
+        input: {
+          dispatchId: dspID,
+          data: data,
+        },
+      },
+      context: {
+        headers: await getHeaders(API_CONTENT_TYPES.APPLICATION_JSON),
+      },
+    });
+  }
+
+  public async postWorkflowUpdate(data: any, workflowId: string) {
+    return this.client?.mutate({
+      mutation: WORKFLOW_UPDATE,
+      variables: {
+        input: { workflow: data, workflowInstanceId: workflowId },
+      },
+      context: {
+        headers: await getHeaders(API_CONTENT_TYPES.APPLICATION_JSON),
+      },
+    });
+  }
+}
+export enum API_CONTENT_TYPES {
+  APPLICATION_JSON = 'application/json',
+}