Improved: seperated partyname from util module by creating party module(#121)

src/services/PartyService.ts

@@ -0,0 +1,13 @@
+import { api } from '@/adapter';
+
+const fetchPartyInformation = async (query: any): Promise <any>  => {
+    return api({
+      url: "performFind",
+      method: "get",
+      params: query
+    });
+  }
+
+  export const partyService = {
+    fetchPartyInformation
+  }

src/services/UtilService.ts

@@ -280,14 +280,6 @@ const fetchCarrierPartyIds = async (query: any): Promise <any>  => {
   });
 }
 
-const fetchPartyInformation = async (query: any): Promise <any>  => {
-  return api({
-    url: "performFind",
-    method: "get",
-    params: query
-  });
-}
-
 const fetchShipmentMethodTypeDesc = async (query: any): Promise <any>  => {
   return api({
     url: "performFind",
@@ -349,7 +341,6 @@ export const UtilService = {
   fetchCarrierPartyIds,
   fetchDefaultShipmentBox,
   fetchFacilityTypeInformation,
-  fetchPartyInformation,
   fetchPicklistInformation,
   fetchRejectReasons,
   fetchShipmentBoxTypeDesc,

src/store/modules/party/actions.ts

@@ -0,0 +1,60 @@
+import { partyService } from "@/services/PartyService"
+import { ActionTree } from "vuex"
+import partyState from "./partyState"
+import RootState from "@/store/RootState"
+import * as types from './mutation-type'
+import { hasError } from '@/adapter'
+import logger from "@/logger"
+
+const actions: ActionTree<partyState, RootState> = {
+  async fetchPartyInformation({ commit, state }, partyIds) {
+    let partyInformation = JSON.parse(JSON.stringify(state.partyNames))
+    const cachedPartyIds = Object.keys(partyInformation);
+    const ids = partyIds.filter((partyId: string) => !cachedPartyIds.includes(partyId))
+
+    if(!ids.length) return partyInformation;
+
+    try {
+      const payload = {
+        "inputFields": {
+          "partyId": ids,
+          "partyId_op": "in"
+        },
+        "fieldList": ["firstName", "middleName", "lastName", "groupName", "partyId"],
+        "entityName": "PartyNameView",
+        "viewSize": ids.length
+      }
+
+      const resp = await partyService.fetchPartyInformation(payload);
+
+      if(!hasError(resp)) {
+        const partyResp = {} as any
+        resp.data.docs.map((partyInformation: any) => {
+
+          let partyName = ''
+          if(partyInformation.groupName) {
+            partyName = partyInformation.groupName
+          } else {
+            partyName = [partyInformation.firstName, partyInformation.lastName].join(' ')
+          }
+
+          partyResp[partyInformation.partyId] = partyName
+        })
+
+        partyInformation = {
+         ...partyInformation,
+         ...partyResp
+        }
+
+        commit(types.PRTY_PARTY_NAMES_UPDATED, partyInformation)
+        } else {
+          throw resp.data
+        }
+      } catch(err) {
+        logger.error('Error fetching party information', err)
+      }
+
+    return partyInformation;
+  },
+}
+export default actions;

src/store/modules/party/getters.ts

@@ -0,0 +1,10 @@
+import { GetterTree } from 'vuex'
+import partyState from './partyState'
+import RootState from '@/store/RootState';
+
+const getters: GetterTree <partyState, RootState> ={
+    getPartyName: (state) => (partyId: string) => {
+        return state.partyNames[partyId] ? state.partyNames[partyId] : ''
+      },
+}
+export default getters;

src/store/modules/party/index.ts

@@ -0,0 +1,17 @@
+import actions from './actions'
+import getters from './getters'
+import mutations from './mutations'
+import { Module } from 'vuex'
+import RootState from '@/store/RootState'
+import partyState from './partyState'
+
+const partyModule: Module<partyState, RootState> = {
+    namespaced: true,
+    state: {
+        partyNames: {},
+    },
+    getters,
+    actions,
+    mutations
+}
+export default partyModule

src/store/modules/party/mutation-type.ts

@@ -0,0 +1,2 @@
+export const SN_PRTY = 'party'
+export const PRTY_PARTY_NAMES_UPDATED = SN_PRTY + '/PARTY_NAMES_UPDATED'

src/store/modules/party/mutations.ts

@@ -0,0 +1,10 @@
+import { MutationTree } from 'vuex'
+import * as types from './mutation-type'
+import partyState from './partyState'
+
+const mutations: MutationTree <partyState> = {
+    [types.PRTY_PARTY_NAMES_UPDATED] (state, payload) {
+        state.partyNames = payload
+      },
+}
+export default mutations;

src/store/modules/party/partyState.ts

@@ -0,0 +1,3 @@
+export default interface partyState {
+    partyNames: any;
+}

src/store/modules/util/UtilState.ts

@@ -1,6 +1,5 @@
 export default interface UtilState {
   rejectReasons: [];
-  partyNames: any;
   shipmentMethodTypeDesc: any;
   shipmentBoxTypeDesc: any;
   facilityTypeDesc: any;

src/store/modules/util/actions.ts

@@ -34,56 +34,6 @@ const actions: ActionTree<UtilState, RootState> = {
     commit(types.UTIL_REJECT_REASONS_UPDATED, rejectReasons)
   },
 
-  async fetchPartyInformation({ commit, state }, partyIds) {
-    let partyInformation = JSON.parse(JSON.stringify(state.partyNames))
-    const cachedPartyIds = Object.keys(partyInformation);
-    const ids = partyIds.filter((partyId: string) => !cachedPartyIds.includes(partyId))
-
-    if(!ids.length) return partyInformation;
-
-    try {
-      const payload = {
-        "inputFields": {
-          "partyId": ids,
-          "partyId_op": "in"
-        },
-        "fieldList": ["firstName", "middleName", "lastName", "groupName", "partyId"],
-        "entityName": "PartyNameView",
-        "viewSize": ids.length
-      }
-
-      const resp = await UtilService.fetchPartyInformation(payload);
-
-      if(!hasError(resp)) {
-        const partyResp = {} as any
-        resp.data.docs.map((partyInformation: any) => {
-
-          let partyName = ''
-          if(partyInformation.groupName) {
-            partyName = partyInformation.groupName
-          } else {
-            partyName = [partyInformation.firstName, partyInformation.lastName].join(' ')
-          }
-
-          partyResp[partyInformation.partyId] = partyName
-        })
-
-        partyInformation = {
-          ...partyInformation,
-          ...partyResp
-        }
-
-        commit(types.UTIL_PARTY_NAMES_UPDATED, partyInformation)
-      } else {
-        throw resp.data
-      }
-    } catch(err) {
-      logger.error('Error fetching party information', err)
-    }
-
-    return partyInformation;
-  },
-
   async fetchShipmentMethodTypeDesc({ commit, state }, shipmentIds) {
     let shipmentMethodTypeDesc = JSON.parse(JSON.stringify(state.shipmentMethodTypeDesc))
     const cachedShipmentMethodIds = Object.keys(shipmentMethodTypeDesc);

src/store/modules/util/getters.ts

@@ -6,9 +6,6 @@ const getters: GetterTree <UtilState, RootState> = {
   getRejectReasons(state) {
     return state.rejectReasons ? state.rejectReasons : []
   },
-  getPartyName: (state) => (partyId: string) => {
-    return state.partyNames[partyId] ? state.partyNames[partyId] : ''
-  },
   getShipmentMethodDesc: (state) => (shipmentMethodId: string) => {
     return state.shipmentMethodTypeDesc[shipmentMethodId] ? state.shipmentMethodTypeDesc[shipmentMethodId] : shipmentMethodId
   },

src/store/modules/util/index.ts

@@ -9,7 +9,6 @@ const utilModule: Module<UtilState, RootState> = {
   namespaced: true,
   state: {
     rejectReasons: [],
-    partyNames: {},
     shipmentMethodTypeDesc: {},
     shipmentBoxTypeDesc: {},
     facilityTypeDesc: {},

src/store/modules/util/mutation-types.ts

@@ -1,6 +1,5 @@
 export const SN_UTIL = 'util'
 export const UTIL_REJECT_REASONS_UPDATED = SN_UTIL + '/REJECT_REASONS_UPDATED'
-export const UTIL_PARTY_NAMES_UPDATED = SN_UTIL + '/PARTY_NAMES_UPDATED'
 export const UTIL_SHIPMENT_METHODS_UPDATED = SN_UTIL + '/SHIPMENT_METHODS_UPDATED'
 export const UTIL_SHIPMENT_BOXES_UPDATED = SN_UTIL + '/SHIPMENT_BOXES_UPDATED'
 export const UTIL_FACILITY_TYPE_UPDATED = SN_UTIL + '/FACILITY_TYPE_UPDATED'

src/store/modules/util/mutations.ts

@@ -6,9 +6,6 @@ const mutations: MutationTree <UtilState> = {
   [types.UTIL_REJECT_REASONS_UPDATED] (state, payload) {
     state.rejectReasons = payload
   },
-  [types.UTIL_PARTY_NAMES_UPDATED] (state, payload) {
-    state.partyNames = payload
-  },
   [types.UTIL_SHIPMENT_METHODS_UPDATED] (state, payload) {
     state.shipmentMethodTypeDesc = payload
   },