Merge pull request #5389 from 3drepo/ISSUE_5374

ISSUE #5374 - Tickets filters: initial filters

frontend/src/v5/ui/controls/chip/chip.types.tsx

@@ -176,7 +176,7 @@ export const STATUS_TYPE_MAP = {
 	},
 };
 
-enum TicketStatusDefaultValues {
+export enum TicketStatusDefaultValues {
 	OPEN = 'Open',
 	IN_PROGRESS = 'In Progress',
 	FOR_APPROVAL = 'For Approval',

frontend/src/v5/ui/routes/viewer/defaultTicketFiltersSetter/defaultTicketFiltersSetter.component.tsx

@@ -0,0 +1,109 @@
+/**
+ *  Copyright (C) 2025 3D Repo Ltd
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ *  published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Affero General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Affero General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { TicketsCardActionsDispatchers, ViewerGuiActionsDispatchers } from '@/v5/services/actionsDispatchers';
+import { TicketsHooksSelectors } from '@/v5/services/selectorsHooks';
+import { isEmpty, uniq } from 'lodash';
+import { useParams } from 'react-router-dom';
+import { useEffect } from 'react';
+import { ViewerParams } from '../../routes.constants';
+import { Transformers, useSearchParam } from '../../useSearchParam';
+import { VIEWER_PANELS } from '@/v4/constants/viewerGui';
+import { CardFilter } from '@components/viewer/cards/cardFilters/cardFilters.types';
+import { StatusValue } from '@/v5/store/tickets/tickets.types';
+import { TicketStatusDefaultValues, TicketStatusTypes, TreatmentStatuses } from '@controls/chip/chip.types';
+import { selectStatusConfigByTemplateId } from '@/v5/store/tickets/tickets.selectors';
+import { getState } from '@/v5/helpers/redux.helpers';
+
+const TICKET_CODE_REGEX = /^[a-zA-Z]{3}:\d+$/;
+export const DefaultTicketFiltersSetter = () => {
+	const { containerOrFederation } = useParams<ViewerParams>();
+	const [ticketSearchParam, setTicketSearchParam] = useSearchParam('ticketSearch', Transformers.STRING_ARRAY);
+
+	const tickets = TicketsHooksSelectors.selectTickets(containerOrFederation);
+	const templates = TicketsHooksSelectors.selectTemplates(containerOrFederation);
+	const hasTicketData = !isEmpty(tickets) && !isEmpty(templates);
+
+	const getTicketFiltersFromURL = (values): CardFilter[] => [{
+		module: '',
+		property: 'Ticket ID',
+		type: 'ticketId',
+		filter: {
+			operator: 'eq',
+			values,
+		},
+	}];
+
+	const getNonCompletedTicketFiltersByStatus = (): CardFilter => {
+		const isCompletedValue = ({ type }: StatusValue) => [TicketStatusTypes.DONE, TicketStatusTypes.VOID].includes(type);
+		const getValuesByTemplate = ({ _id }) => selectStatusConfigByTemplateId(getState(), containerOrFederation, _id).values;
+
+		const completedValueNames = templates
+			.flatMap(getValuesByTemplate)
+			.filter(isCompletedValue)
+			.map((v) => v.name);
+
+		const values = uniq([
+			TicketStatusDefaultValues.CLOSED,
+			TicketStatusDefaultValues.VOID,
+			...completedValueNames,
+		]);
+
+		return {
+			module: '',
+			property: 'Status',
+			type: 'oneOf',
+			filter: {
+				operator: 'neq',
+				values,
+			},
+		};
+	};
+	const getNonCompletedTicketFiltersBySafetibase = (): CardFilter => ({
+		module: 'safetibase',
+		property: 'Treatment Status',
+		type: 'oneOf',
+		filter: {
+			operator: 'neq',
+			values: [
+				TreatmentStatuses.REJECTED,
+				TreatmentStatuses.VOID,
+			],
+		},
+	});
+
+	const getNonCompletedTicketFilters = (): CardFilter[] => {
+		let filters = [getNonCompletedTicketFiltersByStatus()];
+		const hasSafetibase = templates.some((t) => t?.modules?.some((module) => module.type === 'safetibase'));
+		if (hasSafetibase) {
+			filters.push(getNonCompletedTicketFiltersBySafetibase());
+		}
+		return filters;
+	};
+
+	useEffect(() => {
+		if (hasTicketData) {
+			const ticketCodes = ticketSearchParam.filter((query) => TICKET_CODE_REGEX.test(query)).map((q) => q.toUpperCase());
+			const filters: CardFilter[] = ticketCodes.length ? getTicketFiltersFromURL(ticketCodes) : getNonCompletedTicketFilters();
+			filters.forEach(TicketsCardActionsDispatchers.upsertFilter);
+			ViewerGuiActionsDispatchers.setPanelVisibility(VIEWER_PANELS.TICKETS, true);
+			setTicketSearchParam();
+		}
+	}, [hasTicketData]); 
+
+	return <></>;
+};

frontend/src/v5/ui/routes/viewer/viewer.tsx

@@ -24,7 +24,7 @@ import { VIEWER_EVENTS } from '@/v4/constants/viewer';
 import { CheckLatestRevisionReadiness } from './checkLatestRevisionReadiness/checkLatestRevisionReadiness.container';
 import { ViewerParams } from '../routes.constants';
 import { InvalidContainerOverlay, InvalidFederationOverlay } from './invalidViewerOverlay';
-import { HandleTicketsCardSearchParams } from './handleTicketsCardSearchParams/handleTicketsCardSearchParams.component';
+import { DefaultTicketFiltersSetter } from './defaultTicketFiltersSetter/defaultTicketFiltersSetter.component';
 import { SpinnerLoader } from '@controls/spinnerLoader';
 import { CentredContainer } from '@controls/centredContainer';
 import { TicketsCardViews } from './tickets/tickets.constants';
@@ -111,7 +111,7 @@ export const Viewer = () => {
 
 	return (
 		<>
-			<HandleTicketsCardSearchParams />
+			<DefaultTicketFiltersSetter />
 			<OpenDrawingFromUrl />
 			<CheckLatestRevisionReadiness />
 			<ViewerCanvases />