feat: Allow users to create dashboard apps to give agents more context (#4761)

app/javascript/dashboard/store/index.js

@@ -3,7 +3,9 @@ import Vuex from 'vuex';
 
 import accounts from './modules/accounts';
 import agents from './modules/agents';
+import attributes from './modules/attributes';
 import auth from './modules/auth';
+import automations from './modules/automations';
 import campaigns from './modules/campaigns';
 import cannedResponse from './modules/cannedResponse';
 import contactConversations from './modules/contactConversations';
@@ -18,6 +20,8 @@ import conversationSearch from './modules/conversationSearch';
 import conversationStats from './modules/conversationStats';
 import conversationTypingStatus from './modules/conversationTypingStatus';
 import csat from './modules/csat';
+import customViews from './modules/customViews';
+import dashboardApps from './modules/dashboardApps';
 import globalConfig from 'shared/store/globalConfig';
 import inboxAssignableAgents from './modules/inboxAssignableAgents';
 import inboxes from './modules/inboxes';
@@ -30,16 +34,15 @@ import teamMembers from './modules/teamMembers';
 import teams from './modules/teams';
 import userNotificationSettings from './modules/userNotificationSettings';
 import webhooks from './modules/webhooks';
-import attributes from './modules/attributes';
-import automations from './modules/automations';
-import customViews from './modules/customViews';
 
 Vue.use(Vuex);
 export default new Vuex.Store({
   modules: {
     accounts,
     agents,
+    attributes,
     auth,
+    automations,
     campaigns,
     cannedResponse,
     contactConversations,
@@ -54,6 +57,8 @@ export default new Vuex.Store({
     conversationStats,
     conversationTypingStatus,
     csat,
+    customViews,
+    dashboardApps,
     globalConfig,
     inboxAssignableAgents,
     inboxes,
@@ -66,8 +71,5 @@ export default new Vuex.Store({
     teams,
     userNotificationSettings,
     webhooks,
-    attributes,
-    automations,
-    customViews,
   },
 });

app/javascript/dashboard/store/modules/dashboardApps.js

@@ -0,0 +1,54 @@
+import * as MutationHelpers from 'shared/helpers/vuex/mutationHelpers';
+import types from '../mutation-types';
+import DashboardAppsAPI from '../../api/dashboardApps';
+
+export const state = {
+  records: [],
+  uiFlags: {
+    isFetching: false,
+    isCreating: false,
+    isDeleting: false,
+  },
+};
+
+export const getters = {
+  getUIFlags(_state) {
+    return _state.uiFlags;
+  },
+  getRecords(_state) {
+    return _state.records;
+  },
+};
+
+export const actions = {
+  get: async function getDashboardApps({ commit }) {
+    commit(types.SET_DASHBOARD_APPS_UI_FLAG, { isFetching: true });
+    try {
+      const response = await DashboardAppsAPI.get();
+      commit(types.SET_DASHBOARD_APPS, response.data);
+    } catch (error) {
+      // Ignore error
+    } finally {
+      commit(types.SET_DASHBOARD_APPS_UI_FLAG, { isFetching: false });
+    }
+  },
+};
+
+export const mutations = {
+  [types.SET_DASHBOARD_APPS_UI_FLAG](_state, data) {
+    _state.uiFlags = {
+      ..._state.uiFlags,
+      ...data,
+    };
+  },
+
+  [types.SET_DASHBOARD_APPS]: MutationHelpers.set,
+};
+
+export default {
+  namespaced: true,
+  actions,
+  state,
+  getters,
+  mutations,
+};

app/javascript/dashboard/store/modules/specs/dashboardApps/actions.spec.js

@@ -0,0 +1,21 @@
+import axios from 'axios';
+import { actions } from '../../dashboardApps';
+import types from '../../../mutation-types';
+
+const commit = jest.fn();
+global.axios = axios;
+jest.mock('axios');
+
+describe('#actions', () => {
+  describe('#get', () => {
+    it('sends correct actions if API is success', async () => {
+      axios.get.mockResolvedValue({ data: [{ title: 'Title 1' }] });
+      await actions.get({ commit });
+      expect(commit.mock.calls).toEqual([
+        [types.SET_DASHBOARD_APPS_UI_FLAG, { isFetching: true }],
+        [types.SET_DASHBOARD_APPS, [{ title: 'Title 1' }]],
+        [types.SET_DASHBOARD_APPS_UI_FLAG, { isFetching: false }],
+      ]);
+    });
+  });
+});

app/javascript/dashboard/store/modules/specs/dashboardApps/getters.spec.js

@@ -0,0 +1,29 @@
+import { getters } from '../../dashboardApps';
+
+describe('#getters', () => {
+  it('getRecords', () => {
+    const state = {
+      records: [
+        {
+          title: '1',
+          content: [{ link: 'https://google.com', type: 'frame' }],
+        },
+      ],
+    };
+    expect(getters.getRecords(state)).toEqual(state.records);
+  });
+  it('getUIFlags', () => {
+    const state = {
+      uiFlags: {
+        isFetching: true,
+        isCreating: false,
+        isDeleting: false,
+      },
+    };
+    expect(getters.getUIFlags(state)).toEqual({
+      isFetching: true,
+      isCreating: false,
+      isDeleting: false,
+    });
+  });
+});

app/javascript/dashboard/store/modules/specs/dashboardApps/mutations.spec.js

@@ -0,0 +1,20 @@
+import types from '../../../mutation-types';
+import { mutations } from '../../dashboardApps';
+
+describe('#mutations', () => {
+  describe('#SET_DASHBOARD_APPS_UI_FLAG', () => {
+    it('set dashboard app ui flags', () => {
+      const state = { uiFlags: { isCreating: false, isUpdating: false } };
+      mutations[types.SET_DASHBOARD_APPS_UI_FLAG](state, { isUpdating: true });
+      expect(state.uiFlags).toEqual({ isCreating: false, isUpdating: true });
+    });
+  });
+
+  describe('#SET_DASHBOARD_APPS', () => {
+    it('set dashboard records', () => {
+      const state = { records: [{ title: 'Title 0' }] };
+      mutations[types.SET_DASHBOARD_APPS](state, [{ title: 'Title 1' }]);
+      expect(state.records).toEqual([{ title: 'Title 1' }]);
+    });
+  });
+});

app/javascript/dashboard/store/mutation-types.js

@@ -210,4 +210,8 @@ export default {
   SET_CUSTOM_VIEW: 'SET_CUSTOM_VIEW',
   ADD_CUSTOM_VIEW: 'ADD_CUSTOM_VIEW',
   DELETE_CUSTOM_VIEW: 'DELETE_CUSTOM_VIEW',
+
+  // Dashboard Apps
+  SET_DASHBOARD_APPS_UI_FLAG: 'SET_DASHBOARD_APPS_UI_FLAG',
+  SET_DASHBOARD_APPS: 'SET_DASHBOARD_APPS',
 };