refactor(business-reports): update terminology and structures for monitoring

- Rename monitoring functions and types to reflect website context
- Adjust API endpoints and payload structures for clarity
- Update schema definitions and client-side usages to align with changes

Author: tomer-shvadron

apps/backoffice-v2/src/domains/business-reports/fetchers.ts

@@ -28,7 +28,7 @@ export const BusinessReportSchema = ReportSchema.transform(data => {
   return {
     ...data,
     status: data.status in statusOverrides ? statusOverrides[data.status] : data.status,
-    website: data.website.url,
+    website: data.website,
     riskLevel: isReportReady ? data.riskLevel : null,
     data: isReportReady ? data?.data : null,
     isExample: data.metadata?.isExample ?? false,

apps/backoffice-v2/src/pages/IdentityVerification/components/IdentityVerificationChecksStatus/IdentityVerificationChecksStatus.tsx

@@ -40,7 +40,7 @@ import { toast } from 'sonner';
 import { t } from 'i18next';
 import { getNoteContentForUnsubscribe } from './helpers/get-note-content-for-unsubscribe';
 import { getBaseNoteContent } from './helpers/get-base-note-content';
-import { useToggleMonitoringMutation } from '@/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation';
+import { useUpdateOngoingMonitoringStatusMutation } from '@/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation';
 import { IdentityVerificationChecksButton } from './IdentityVerificationChecksButton';
 import { useIdentityVerificationDialog } from './hooks/useIdentityVerificationDialog/useIdentityVerificationDialog';
 import { IdentityVerificationChecksBadge } from './IdentityVerificationChecksBadge';
@@ -70,8 +70,8 @@ export const IdentityVerificationChecksStatus = ({
   const { mutate: mutateUpdateReportStatus, isLoading: isUpdatingReportStatus } =
     useUpdateReportStatusMutation();
   const { mutateAsync: turnOffMonitoringMutation, isLoading: isTurningOffMonitoring } =
-    useToggleMonitoringMutation({
-      state: 'off',
+    useUpdateOngoingMonitoringStatusMutation({
+      status: 'inactive',
       onSuccess: () => {
         form.reset();
         toast.success(t(`toast:business_monitoring_off.success`));

apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringReportStatus/MerchantMonitoringReportStatus.tsx

@@ -42,7 +42,7 @@ import { toast } from 'sonner';
 import { t } from 'i18next';
 import { getNoteContentForUnsubscribe } from './helpers/get-note-content-for-unsubscribe';
 import { getBaseNoteContent } from './helpers/get-base-note-content';
-import { useToggleMonitoringMutation } from '@/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation';
+import { useUpdateOngoingMonitoringStatusMutation } from '@/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation';
 
 /* TODO: Remove this filtering once completed status is removed */
 const UPDATEABLE_REPORT_STATUSES = _UPDATEABLE_REPORT_STATUSES.filter(
@@ -57,20 +57,20 @@ export const MerchantMonitoringReportStatus = ({
   status,
   reportId,
   className,
-  businessId,
+  websiteId,
 }: {
   reportId?: string;
   className?: string;
-  businessId?: string;
+  websiteId?: string;
   status?: keyof typeof statusToData;
 }) => {
   const { mutateAsync: mutateCreateNote } = useCreateNoteMutation({ disableToast: true });
 
   const { mutate: mutateUpdateReportStatus, isLoading: isUpdatingReportStatus } =
     useUpdateReportStatusMutation();
   const { mutateAsync: turnOffMonitoringMutation, isLoading: isTurningOffMonitoring } =
-    useToggleMonitoringMutation({
-      state: 'off',
+    useUpdateOngoingMonitoringStatusMutation({
+      status: 'inactive',
       onSuccess: () => {
         form.reset();
         toast.success(t(`toast:business_monitoring_off.success`));
@@ -119,14 +119,14 @@ export const MerchantMonitoringReportStatus = ({
       : getBaseNoteContent(statusReadableText, text);
 
     if (isShouldUnsubscribe) {
-      await turnOffMonitoringMutation(businessId ?? '');
+      await turnOffMonitoringMutation(websiteId ?? '');
     }
 
     mutateUpdateReportStatus({ reportId, status: dialogState.status, text });
 
     void mutateCreateNote({
       content: noteContent,
-      entityId: businessId ?? '',
+      entityId: websiteId ?? '',
       entityType: 'Business',
       noteableId: reportId ?? '',
       noteableType: 'Report',

apps/backoffice-v2/src/pages/MerchantMonitoring/components/MerchantMonitoringTable/columns.tsx

@@ -194,7 +194,7 @@ export const useColumns = ({ isDemoAccount = false }) => {
           return (
             <ContentTooltip
               description={
-                <p>This merchant is {!value && 'not '}subscribed to recurring ongoing monitoring</p>
+                <p>This website is {!value && 'not '}subscribed to recurring ongoing monitoring</p>
               }
               props={{
                 tooltipTrigger: { className: 'flex w-full justify-start' },
@@ -225,7 +225,7 @@ export const useColumns = ({ isDemoAccount = false }) => {
         },
         header: () => (
           <ContentTooltip
-            description={<p>Indicates whether the merchant is subscribed to ongoing monitoring</p>}
+            description={<p>Indicates whether the website is subscribed to ongoing monitoring</p>}
             props={{
               tooltipTrigger: { className: 'mx-auto' },
               tooltipContent: { align: 'center', side: 'top' },

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/BusinessReportOptionsDropdown.tsx

@@ -221,7 +221,7 @@ export const BusinessReportOptionsDropdown: FunctionComponent<
                   throw new Error('Business ID is missing');
                 }
 
-                turnOngoingMonitoringOn(businessReport.business.id, {
+                turnOngoingMonitoringOn(businessReport.website.id, {
                   onSuccess: () => {
                     setIsDeboardModalOpen(false);
                     setIsDropdownOpen(false);

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/MerchantMonitoringBusinessReport.page.tsx

@@ -183,7 +183,7 @@ export const MerchantMonitoringBusinessReport: FunctionComponent = () => {
             <MerchantMonitoringReportStatus
               reportId={businessReport?.id}
               status={businessReport?.status}
-              businessId={businessReport?.business.id}
+              websiteId={businessReport?.website.id}
             />
           </div>
           <div className={`text-sm`}>

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/fetchers.ts

@@ -4,28 +4,26 @@ import { Method } from '@/common/enums';
 import { apiClient } from '@/common/api-client/api-client';
 import { handleZodError } from '@/common/utils/handle-zod-error/handle-zod-error';
 
-export type TurnOngoingMonitoringBody = z.infer<typeof TurnOngoingMonitoringBodySchema>;
-export const TurnOngoingMonitoringBodySchema = z.object({
-  state: z.string(),
+export const UpdateOngoingMonitoringStatusBodySchema = z.object({
+  status: z.enum(['active', 'inactive']),
 });
 
-export type TurnOngoingMonitoringResponse = z.infer<typeof TurnOngoingMonitoringResponseSchema>;
-export const TurnOngoingMonitoringResponseSchema = z.object({
-  state: z.string(),
-});
+export type UpdateOngoingMonitoringStatusBody = z.infer<
+  typeof UpdateOngoingMonitoringStatusBodySchema
+>;
 
-export const turnOngoingMonitoring = async ({
-  merchantId,
+export const updateOngoingMonitoringStatus = async ({
+  websiteId,
   body,
 }: {
-  merchantId: string;
-  body: TurnOngoingMonitoringBody;
+  websiteId: string;
+  body: UpdateOngoingMonitoringStatusBody;
 }) => {
   const [data, error] = await apiClient({
-    endpoint: `../external/businesses/${merchantId}/monitoring`,
+    endpoint: `../external/business-reports/websites/${websiteId}/monitoring`,
     method: Method.PATCH,
     body,
-    schema: TurnOngoingMonitoringResponseSchema,
+    schema: z.undefined(),
     timeout: 300_000,
   });
 

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useMerchantMonitoringBusinessReportLogic/useMerchantMonitoringBusinessReportLogic.tsx

@@ -20,7 +20,7 @@ import { useCustomerQuery } from '@/domains/customer/hooks/queries/useCustomerQu
 import { useNotesByNoteable } from '@/domains/notes/hooks/queries/useNotesByNoteable/useNotesByNoteable';
 import { useCreateNoteMutation } from '@/domains/notes/hooks/mutations/useCreateNoteMutation/useCreateNoteMutation';
 import { useBusinessReportByIdQuery } from '@/domains/business-reports/hooks/queries/useBusinessReportByIdQuery/useBusinessReportByIdQuery';
-import { useToggleMonitoringMutation } from '@/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation';
+import { useUpdateOngoingMonitoringStatusMutation } from '@/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation';
 
 const ZodDeboardingSchema = z
   .object({
@@ -85,12 +85,12 @@ export const useMerchantMonitoringBusinessReportLogic = () => {
       throw new Error('Business ID is missing');
     }
 
-    return turnOffMonitoringMutation.mutate(businessReport.business.id);
+    return turnOffMonitoringMutation.mutate(businessReport.website.id);
   };
 
   const { mutateAsync: mutateCreateNote } = useCreateNoteMutation({ disableToast: true });
-  const turnOnMonitoringMutation = useToggleMonitoringMutation({
-    state: 'on',
+  const turnOnMonitoringMutation = useUpdateOngoingMonitoringStatusMutation({
+    status: 'active',
     onSuccess: () => {
       void mutateCreateNote({
         content: 'Monitoring turned on',
@@ -111,8 +111,8 @@ export const useMerchantMonitoringBusinessReportLogic = () => {
     },
   });
 
-  const turnOffMonitoringMutation = useToggleMonitoringMutation({
-    state: 'off',
+  const turnOffMonitoringMutation = useUpdateOngoingMonitoringStatusMutation({
+    status: 'inactive',
     onSuccess: () => {
       const { reason, userReason } = form.getValues();
       const content = [

apps/backoffice-v2/src/pages/MerchantMonitoringBusinessReport/hooks/useToggleMonitoringMutation/useToggleMonitoringMutation.tsx

@@ -2,22 +2,22 @@ import { useMutation, useQueryClient } from '@tanstack/react-query';
 import { toast } from 'sonner';
 
 import { HttpError } from '@/common/errors/http-error';
-import { turnOngoingMonitoring } from '@/pages/MerchantMonitoringBusinessReport/fetchers';
+import { updateOngoingMonitoringStatus } from '@/pages/MerchantMonitoringBusinessReport/fetchers';
 
-export const useToggleMonitoringMutation = ({
-  state,
+export const useUpdateOngoingMonitoringStatusMutation = ({
+  status,
   onSuccess,
   onError,
 }: {
-  state: 'on' | 'off';
+  status: 'active' | 'inactive';
   onSuccess?: (data: unknown) => void;
   onError?: (error: unknown) => void;
 }) => {
   const queryClient = useQueryClient();
 
   return useMutation({
-    mutationFn: async (merchantId: string) =>
-      turnOngoingMonitoring({ merchantId, body: { state } }),
+    mutationFn: async (websiteId: string) =>
+      updateOngoingMonitoringStatus({ websiteId, body: { status } }),
     onSuccess: data => {
       void queryClient.invalidateQueries();
 

packages/common/src/schemas/report-schema.ts

@@ -81,7 +81,9 @@ export const ReportSchema = z
     status: z.enum([MERCHANT_REPORT_STATUSES[0]!, ...MERCHANT_REPORT_STATUSES.slice(1)]),
     monitoringStatus: z.boolean().nullish(),
     website: z.object({
+      id: z.string(),
       url: z.string().url(),
+      unsubscribedMonitoringAt: z.string().datetime().nullable(),
     }),
     customer: z.object({
       id: z.string(),
@@ -91,7 +93,6 @@ export const ReportSchema = z
     business: z.object({
       id: z.string(),
       correlationId: z.string().nullish(),
-      unsubscribedMonitoringAt: z.string().datetime().nullable(),
     }),
     metadata: z.record(z.string(), z.unknown()).nullish(),
     companyName: z.string().nullish(),