ORV2-2578 - FE: Staff Manage Queue List

frontend/src/common/authentication/LoginRedirect.tsx

@@ -18,15 +18,20 @@ import {
   useUserContext,
   useUserContextQuery,
 } from "../../features/manageProfile/apiManager/hooks";
+import { isStaffUser } from "../../features/queue/helpers/isStaffUser";
 
 const navigateBCeID = (
   userContextData: BCeIDUserContextType,
 ): string | undefined => {
   const { associatedCompanies, pendingCompanies, migratedClient, user } =
     userContextData;
 
-  const isAssociatedSuspended = associatedCompanies?.find((company) => company?.isSuspended);
-  const isPendingSuspended = pendingCompanies?.find((company) => company?.isSuspended);
+  const isAssociatedSuspended = associatedCompanies?.find(
+    (company) => company?.isSuspended,
+  );
+  const isPendingSuspended = pendingCompanies?.find(
+    (company) => company?.isSuspended,
+  );
 
   // If the user does not exist
   if (!user?.userGUID) {
@@ -109,7 +114,10 @@ export const LoginRedirect = () => {
       } else if (userFromToken?.profile?.identity_provider === IDPS.IDIR) {
         const userContextData: Optional<IDIRUserContextType> =
           queryClient.getQueryData<IDIRUserContextType>(["userContext"]);
-        if (userContextData?.user?.userGUID) {
+        // only IDIR users with PC, SA, CTPO or TRAIN should redirect to STAFF_HOME
+        if (isStaffUser(userContextData?.user?.userRole)) {
+          navigate(IDIR_ROUTES.STAFF_HOME);
+        } else if (userContextData?.user?.userGUID) {
           navigate(IDIR_ROUTES.WELCOME);
         } else {
           navigate(ERROR_ROUTES.UNAUTHORIZED);

frontend/src/common/authentication/PermissionMatrix.ts

@@ -312,7 +312,7 @@ const MANAGE_SETTINGS = {
   /**
    * View Credit Account tab - Non-Holder/user
    * Comment: Info box
-   * 
+   *
    * Todo: ORV2-2771 Implement info box.
    */
   VIEW_CREDIT_ACCOUNT_TAB_NON_HOLDER_OR_USER: {
@@ -410,8 +410,8 @@ const GLOBAL_SEARCH = {
  * Application review queue on staff home screen
  */
 const STAFF_HOME_SCREEN = {
-  VIEW_QUEUE: { allowedIDIRRoles: [PC, SA] },
-  MANAGE_QUEUE: { allowedIDIRRoles: [PC, SA] },
+  VIEW_QUEUE: { allowedIDIRRoles: [PC, SA, CTPO] },
+  MANAGE_QUEUE: { allowedIDIRRoles: [PC, SA, CTPO] },
 } as const;
 
 const MISCELLANEOUS = {

frontend/src/common/authentication/auth-walls/BCeIDAuthWall.tsx

@@ -111,6 +111,13 @@ export const BCeIDAuthWall = ({
   if (isAuthenticated && isEstablishedUser) {
     if (isIDIR(userIDP)) {
       if (companyId) {
+        /* TODO when attempting to access an application in queue as staff, we do not have a companyId and are redirected
+        would it be better to have staff automatically act as the company who started the application when accessing an application 
+        from the staff queue?
+
+        If we were to act as company here, we should not see the tabs bar (permits, vehicle inventory etc), 
+        and the breadcrumb should read: Home > Application #
+        */
         return <IDIRAuthWall permissionMatrixKeys={permissionMatrixKeys} />;
       } else {
         return (

frontend/src/common/components/naviconsidebar/NavIconHomeButton.tsx

@@ -5,6 +5,7 @@ import { IDIR_ROUTES } from "../../../routes/constants";
 import OnRouteBCContext from "../../authentication/OnRouteBCContext";
 import { NavButton } from "./NavButton";
 import { NAV_BUTTON_TYPES } from "./types/NavButtonType";
+import { isStaffUser } from "../../../features/queue/helpers/isStaffUser";
 
 /**
  * Displays the navigation icon for Home on the NavIconSideBar
@@ -13,14 +14,18 @@ export const NavIconHomeButton = () => {
   const navigate = useNavigate();
   const { pathname } = useLocation();
   const isActive = pathname === IDIR_ROUTES.WELCOME;
-  const { clearCompanyContext } = useContext(OnRouteBCContext);
+  const { clearCompanyContext, idirUserDetails } = useContext(OnRouteBCContext);
 
   return (
     <NavButton
       type={NAV_BUTTON_TYPES.HOME}
       onClick={() => {
         clearCompanyContext?.();
-        navigate(IDIR_ROUTES.WELCOME);
+        navigate(
+          isStaffUser(idirUserDetails?.userRole)
+            ? IDIR_ROUTES.STAFF_HOME
+            : IDIR_ROUTES.WELCOME,
+        );
       }}
       isActive={isActive}
     />

frontend/src/common/types/common.ts

@@ -49,7 +49,7 @@ export interface PaginationOptions {
    * Max. value is 25.
    */
   take: number;
-};
+}
 
 /**
  * The sort directions.
@@ -75,7 +75,7 @@ export interface SortingConfig {
    * If not given a value, defaulted to false.
    */
   descending?: boolean;
-};
+}
 
 /**
  * Additional data filters that could be used for
@@ -86,16 +86,22 @@ export interface DataFilterOptions {
    * The search value entered by the user.
    */
   searchString?: string;
+  /**
+   * The column to which the searchString will be applied.
+   */
+  searchColumn?: string;
   /**
    * The sorting configuration selected by the user.
    */
   orderBy?: Array<SortingConfig>;
-};
+}
 
 /**
  * The options for pagination and filtering data.
  */
-export interface PaginationAndFilters extends PaginationOptions, DataFilterOptions {};
+export interface PaginationAndFilters
+  extends PaginationOptions,
+    DataFilterOptions {}
 
 /**
  * The metadata containing info about a page in the paginated response.
@@ -117,7 +123,7 @@ export interface PageMetadataInResponse extends PaginationOptions {
    * Is there a next page?
    */
   hasNextPage: boolean;
-};
+}
 
 /**
  * A generic paginated response structure for all the paginated responses from APIs.
@@ -131,7 +137,7 @@ export interface PaginatedResponse<T> {
    * Metadata about a page.
    */
   meta: PageMetadataInResponse;
-};
+}
 
 export type Optional<T> = T | undefined;
 export type RequiredOrNull<T> = T | null;

frontend/src/features/idir/StaffDashboard.tsx

@@ -0,0 +1,14 @@
+import React from "react";
+import { ErrorBoundary } from "react-error-boundary";
+import { ApplicationQueueLists } from "../queue/components/ApplicationQueueLists";
+import { ErrorFallback } from "../../common/pages/ErrorFallback";
+
+export const StaffDashboard = React.memo(() => {
+  return (
+    <ErrorBoundary FallbackComponent={ErrorFallback}>
+      <ApplicationQueueLists />
+    </ErrorBoundary>
+  );
+});
+
+StaffDashboard.displayName = "StaffDashboard";

frontend/src/features/idir/search/components/IDIRPermitSearchRowActions.tsx

@@ -129,7 +129,11 @@ export const IDIRPermitSearchRowActions = ({
     if (selectedOption === PERMIT_ACTION_TYPES.RESEND) {
       setOpenResendDialog(() => true);
     } else if (selectedOption === PERMIT_ACTION_TYPES.VIEW_RECEIPT) {
-      viewReceiptPdf(permitId, () => navigate(routes.ERROR_ROUTES.DOCUMENT_UNAVAILABLE), companyId );
+      viewReceiptPdf(
+        permitId,
+        () => navigate(routes.ERROR_ROUTES.DOCUMENT_UNAVAILABLE),
+        companyId,
+      );
     } else if (selectedOption === PERMIT_ACTION_TYPES.VOID_REVOKE) {
       navigate(`${routes.PERMITS_ROUTES.VOID(companyId, permitId)}`);
     } else if (selectedOption === PERMIT_ACTION_TYPES.AMEND) {

frontend/src/features/permits/apiManager/endpoints/endpoints.ts

@@ -1,23 +1,26 @@
 import { VEHICLES_URL } from "../../../../common/apiManager/endpoints/endpoints";
 
-const APPLICATIONS_API_BASE = (companyId: string) =>
+export const APPLICATIONS_API_BASE = (companyId: string) =>
   `${VEHICLES_URL}/companies/${companyId}/applications`;
 
 const PERMITS_API_BASE = (companyId: string) =>
   `${VEHICLES_URL}/companies/${companyId}/permits`;
 
 const STAFF_PERMIT_API_BASE = `${VEHICLES_URL}/permits`;
 
+const STAFF_APPLICATIONS_API_BASE = `${VEHICLES_URL}/applications`;
+
 export const APPLICATIONS_API_ROUTES = {
   CREATE: (companyId: string) => APPLICATIONS_API_BASE(companyId),
   UPDATE: (companyId: string) => APPLICATIONS_API_BASE(companyId),
+  // the endpoint for fetching applications for use in the ApplicationsInReviewList component
   GET: (companyId: string) => APPLICATIONS_API_BASE(companyId),
   DELETE: (companyId: string) => APPLICATIONS_API_BASE(companyId),
 };
 
-export const APPLICATION_QUEUE_API_ROUTES = {
-  UPDATE_QUEUE_STATUS: (companyId: string, applicationId: string) =>
-    `${APPLICATIONS_API_BASE(companyId)}/${applicationId}/queue/status`,
+export const STAFF_APPLICATIONS_API_ROUTES = {
+  // the endpoint for fetching applications for use in the ApplicationsInQueueList component
+  GET: () => STAFF_APPLICATIONS_API_BASE,
 };
 
 export const PERMITS_API_ROUTES = {