feat(api): Self Service Portal APIs

packages/search/src/features/search/utils.ts

@@ -14,7 +14,10 @@ import {
   SUPPORTED_PATIENT_IDENTIFIER_CODES,
   CERTIFIED_STATUS,
   REGISTERED_STATUS,
-  ISSUED_STATUS
+  ISSUED_STATUS,
+  DECLARED_STATUS,
+  REJECTED_STATUS,
+  VALIDATED_STATUS
 } from '@opencrvs/commons/types'
 import { IAdvancedSearchParam } from '@search/features/search/types'
 import { transformDeprecatedParamsToSupported } from './deprecation-support'
@@ -76,7 +79,7 @@ export async function advancedQueryBuilder(
       query_string: {
         default_field: 'type',
         query: isExternalSearch
-          ? `(${REGISTERED_STATUS}) OR (${CERTIFIED_STATUS}) OR (${ISSUED_STATUS})`
+          ? `(${REGISTERED_STATUS}) OR (${CERTIFIED_STATUS}) OR (${ISSUED_STATUS}) OR (${DECLARED_STATUS}) OR (${REJECTED_STATUS}) OR (${VALIDATED_STATUS})`
           : `(${params.registrationStatuses!.join(') OR (')})`
       }
     })

packages/webhooks/src/config/routes.ts

@@ -17,6 +17,7 @@ import {
   deleteWebhookByClientIdHandler
 } from '@webhooks/features/manage/handler'
 import {
+  approveRejectHandler,
   birthRegisteredHandler,
   deathRegisteredHandler,
   marriageRegisteredHandler
@@ -105,6 +106,15 @@ export const getRoutes = () => {
         tags: ['api'],
         description: 'Dispatches a webhook for the marriage registration event'
       }
+    },
+    {
+      method: 'POST',
+      path: '/events/{eventType}/status/{statusType}',
+      handler: approveRejectHandler,
+      config: {
+        tags: ['api'],
+        description: 'Dispatches a webhook for the event'
+      }
     }
   ]
   return routes

packages/webhooks/src/features/event/handler.ts

@@ -21,7 +21,7 @@ import Webhook, { IWebhookModel, TRIGGERS } from '@webhooks/model/webhook'
 import { getQueue } from '@webhooks/queue'
 import { Queue } from 'bullmq'
 import fetch from 'node-fetch'
-import * as ShortUIDGen from 'short-uid'
+import ShortUIDGen from 'short-uid'
 import { RegisteredRecord } from '@opencrvs/commons/types'
 
 export interface IAuthHeader {
@@ -230,6 +230,101 @@ export async function marriageRegisteredHandler(
   return h.response().code(200)
 }
 
+export async function approveRejectHandler(
+  request: Hapi.Request,
+  h: Hapi.ResponseToolkit
+) {
+  const { eventType, statusType } = request.params
+  const bundle = request.payload as { trackingId: string }
+
+  let currentTrigger: TRIGGERS
+
+  if (eventType === 'BIRTH' && statusType === 'approved') {
+    currentTrigger = TRIGGERS.BIRTH_APPROVED
+  } else if (eventType === 'BIRTH' && statusType === 'rejected') {
+    currentTrigger = TRIGGERS.BIRTH_REJECTED
+  } else if (eventType === 'DEATH' && statusType === 'approved') {
+    currentTrigger = TRIGGERS.DEATH_APPROVED
+  } else if (eventType === 'DEATH' && statusType === 'rejected') {
+    currentTrigger = TRIGGERS.DEATH_REJECTED
+  } else {
+    throw new Error('Invalid eventType or statusType')
+  }
+
+  let webhookQueue: Queue
+
+  try {
+    webhookQueue = getQueue()
+  } catch (error) {
+    logger.error(`Can't get webhook queue: ${error}`)
+    return internal(error)
+  }
+
+  try {
+    const webhooks: IWebhookModel[] | null = await Webhook.find()
+    if (!webhooks) {
+      throw internal('Failed to find webhooks')
+    }
+    logger.info(`Subscribed webhooks: ${JSON.stringify(webhooks)}`)
+    if (webhooks) {
+      for (const webhookToNotify of webhooks) {
+        logger.info(
+          `Queueing webhook ${webhookToNotify.trigger} ${TRIGGERS[currentTrigger]}`
+        )
+        if (webhookToNotify.trigger === TRIGGERS[currentTrigger]) {
+          const payload = {
+            timestamp: new Date().toISOString(),
+            id: webhookToNotify.webhookId,
+            event: {
+              hub: {
+                topic: TRIGGERS[currentTrigger]
+              },
+              context: {
+                trackingId: bundle?.trackingId,
+                status: statusType
+              }
+            }
+          }
+          logger.info(
+            `Dispatching webhook: ${JSON.stringify({
+              timestamp: payload.timestamp,
+              id: payload.id,
+              event: { hub: { topic: payload.event.hub.topic } },
+              context: ['<<redacted>>']
+            })}`
+          )
+          const hmac = createRequestSignature(
+            'sha256',
+            webhookToNotify.sha_secret,
+            JSON.stringify(payload)
+          )
+          webhookQueue.add(
+            `${webhookToNotify.webhookId}_${TRIGGERS[currentTrigger]}`,
+            {
+              payload,
+              url: webhookToNotify.address,
+              hmac
+            },
+            {
+              jobId: `WEBHOOK_${new ShortUIDGen().randomUUID().toUpperCase()}_${
+                webhookToNotify.webhookId
+              }`,
+              attempts: 3
+            }
+          )
+        }
+      }
+    } else {
+      logger.info(`No webhooks subscribed to approve & reject trigger`)
+    }
+  } catch (error) {
+    logger.error(`Webhooks/approveRejectHandler: error: ${error}`)
+    return internal(error)
+  }
+
+  return h.response().code(200)
+}
+
 const fetchSystemPermissions = async (
   { createdBy: { client_id, type } }: IWebhookModel,
   authHeader: IAuthHeader,

packages/webhooks/src/model/webhook.ts

@@ -16,7 +16,11 @@ export enum TRIGGERS {
   BIRTH_CERTIFIED,
   DEATH_CERTIFIED,
   BIRTH_CORRECTED,
-  DEATH_CORRECTED
+  DEATH_CORRECTED,
+  BIRTH_APPROVED,
+  DEATH_APPROVED,
+  BIRTH_REJECTED,
+  DEATH_REJECTED
 }
 export interface IClient {
   client_id: string

packages/workflow/src/records/handler/correction/approve.ts

@@ -36,6 +36,7 @@ import { createRoute } from '@workflow/states'
 import { getToken } from '@workflow/utils/auth-utils'
 import { validateRequest } from '@workflow/utils/index'
 import { findActiveCorrectionRequest, sendNotification } from './utils'
+import { invokeWebhooks } from '@workflow/records/webhooks'
 
 export const approveCorrectionRoute = createRoute({
   method: 'POST',
@@ -148,6 +149,14 @@ export const approveCorrectionRoute = createRoute({
       }
     )
 
+    await invokeWebhooks({
+      bundle: record,
+      token,
+      event: getEventType(record),
+      isNotRegistred: true,
+      statusType: 'approved'
+    })
+
     return recordWithUpdatedValues
   }
 })

packages/workflow/src/records/handler/correction/reject.ts

@@ -35,6 +35,7 @@ import { getToken } from '@workflow/utils/auth-utils'
 import { validateRequest } from '@workflow/utils/index'
 import { findActiveCorrectionRequest, sendNotification } from './utils'
 import { getEventType } from '@workflow/features/registration/utils'
+import { invokeWebhooks } from '@workflow/records/webhooks'
 
 export const rejectCorrectionRoute = createRoute({
   method: 'POST',
@@ -124,6 +125,14 @@ export const rejectCorrectionRoute = createRoute({
       }
     )
 
+    await invokeWebhooks({
+      bundle: record,
+      token: getToken(request),
+      event: getEventType(record),
+      isNotRegistred: true,
+      statusType: 'rejected'
+    })
+
     return recordWithCorrectionRejectedTask
   }
 })

packages/workflow/src/records/handler/reject.ts

@@ -17,6 +17,8 @@ import { toRejected } from '@workflow/records/state-transitions'
 import { indexBundle } from '@workflow/records/search'
 import { auditEvent } from '@workflow/records/audit'
 import { sendNotification } from '@workflow/records/notification'
+import { getEventType } from '@workflow/features/registration/utils'
+import { invokeWebhooks } from '@workflow/records/webhooks'
 
 const requestSchema = z.object({
   comment: z.string(),
@@ -48,6 +50,14 @@ export const rejectRoute = createRoute({
     await auditEvent('sent-for-updates', rejectedRecord, token)
     await sendNotification('sent-for-updates', rejectedRecord, token)
 
+    await invokeWebhooks({
+      bundle: record,
+      token,
+      event: getEventType(record),
+      isNotRegistred: true,
+      statusType: 'rejected'
+    })
+
     return rejectedRecord
   }
 })

packages/workflow/src/records/webhooks.ts

@@ -9,7 +9,15 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 import fetch from 'node-fetch'
-import { EVENT_TYPE, RegisteredRecord } from '@opencrvs/commons/types'
+import {
+  CorrectionRequestedRecord,
+  EVENT_TYPE,
+  getTrackingId,
+  InProgressRecord,
+  ReadyForReviewRecord,
+  RegisteredRecord,
+  ValidatedRecord
+} from '@opencrvs/commons/types'
 import { WEBHOOKS_URL } from '@workflow/constants'
 
 const WEBHOOK_URLS = {
@@ -24,15 +32,33 @@ const WEBHOOK_URLS = {
 export const invokeWebhooks = async ({
   bundle,
   token,
-  event
+  event,
+  isNotRegistred,
+  statusType
 }: {
-  bundle: RegisteredRecord
+  bundle:
+    | RegisteredRecord
+    | CorrectionRequestedRecord
+    | InProgressRecord
+    | ReadyForReviewRecord
+    | ValidatedRecord
   token: string
   event: EVENT_TYPE
+  isNotRegistred?: boolean
+  statusType?: 'rejected' | 'approved'
 }) => {
-  const request = await fetch(WEBHOOK_URLS[event], {
+  const trackingId = getTrackingId(bundle)
+
+  const url = isNotRegistred
+    ? new URL(`/events/${event}/status/${statusType}`, WEBHOOKS_URL)
+    : WEBHOOK_URLS[event]
+  const body = isNotRegistred
+    ? `{"trackingId": "${trackingId}"}`
+    : JSON.stringify(bundle)
+
+  const request = await fetch(url, {
     method: 'POST',
-    body: JSON.stringify(bundle),
+    body: body,
     headers: {
       'Content-Type': 'application/json',
       Authorization: `Bearer ${token}`