@platform-modules/foreign-ministry 1.3.322 → 1.3.326

package/src/helpers/services-notification-config.helper.ts

@@ -0,0 +1,255 @@
+import type { EntityManager } from 'typeorm';
+import { Notification, NotificationType } from '../models/NotificationModel';
+import {
+  ServicesNotificationConfigs,
+  ServicesNotificationTriggerType,
+} from '../models/ServicesNotificationConfigsModel';
+import { UserRole } from '../models/userRolesModel';
+
+export type FmServicesNotificationConfigRecipient = {
+  user_id: number;
+  department_id: number | null;
+  section_id: number | null;
+  role_id: number | null;
+};
+
+export type CollectFmServicesNotificationConfigRecipientsParams = {
+  serviceId: number | null | undefined;
+  subServiceId: number | null | undefined;
+  /** When 0, FINAL_APPROVAL configs apply; EVERY_APPROVAL always applies on approval. */
+  pendingCount: number;
+  logPrefix?: string;
+};
+
+export type SendFmServicesNotificationConfigNotificationsParams = {
+  serviceId: number | null | undefined;
+  subServiceId: number | null | undefined;
+  pendingCount: number;
+  requestId: number;
+  status: string;
+  approvalLevel: number;
+  shortProductName: string;
+  requestTypeKey: string;
+  routePath: string;
+  createdBy: string | number;
+  logPrefix?: string;
+};
+
+/**
+ * Resolves users from active `services_notification_configs` for service/sub-service.
+ * FINAL_APPROVAL only when pendingCount === 0; EVERY_APPROVAL on each approval step.
+ */
+export async function collectFmServicesNotificationConfigRecipients(
+  manager: EntityManager,
+  params: CollectFmServicesNotificationConfigRecipientsParams
+): Promise<FmServicesNotificationConfigRecipient[]> {
+  const { serviceId, subServiceId, pendingCount, logPrefix = '[FM notification config]' } = params;
+  if (!serviceId || !subServiceId) return [];
+
+  const notificationConfigs = await manager
+    .getRepository(ServicesNotificationConfigs)
+    .createQueryBuilder('SNC')
+    .where('SNC.service_id = :service_id', { service_id: serviceId })
+    .andWhere('SNC.sub_service_id = :sub_service_id', { sub_service_id: subServiceId })
+    .andWhere('SNC.is_deleted = :is_deleted', { is_deleted: false })
+    .andWhere('SNC.is_active = :is_active', { is_active: true })
+    .getMany();
+
+  if (!notificationConfigs?.length) {
+    console.warn(
+      `${logPrefix} No notification configurations found for service ${serviceId} and sub_service ${subServiceId}`
+    );
+    return [];
+  }
+
+  const seen = new Map<number, FmServicesNotificationConfigRecipient>();
+
+  for (const notificationConfig of notificationConfigs) {
+    if (notificationConfig.trigger === ServicesNotificationTriggerType.FINAL_APPROVAL) {
+      if (pendingCount !== 0) continue;
+    } else if (notificationConfig.trigger === ServicesNotificationTriggerType.EVERY_APPROVAL) {
+      // include on every approval step
+    } else {
+      continue;
+    }
+
+    let usersQuery = manager
+      .getRepository(UserRole)
+      .createQueryBuilder('user_role')
+      .where('user_role.department_id = :department_id', {
+        department_id: notificationConfig.department_id,
+      })
+      .andWhere('user_role.section_id = :section_id', { section_id: notificationConfig.section_id })
+      .andWhere('user_role.is_deleted = :is_deleted', { is_deleted: false });
+
+    if (notificationConfig.role_id != null && notificationConfig.role_id !== undefined) {
+      usersQuery = usersQuery.andWhere('user_role.role_id = :role_id', {
+        role_id: notificationConfig.role_id,
+      });
+    }
+    const userRoles = await usersQuery.getMany();
+
+    if (!userRoles?.length) {
+      console.warn(
+        `${logPrefix} No users found for config (dept ${notificationConfig.department_id}${notificationConfig.section_id != null ? `, section ${notificationConfig.section_id}` : ''})`
+      );
+      continue;
+    }
+
+    for (const ur of userRoles) {
+      const uid = ur.user_id;
+      if (seen.has(uid)) continue;
+
+      const userRole = await manager
+        .getRepository(UserRole)
+        .createQueryBuilder('user_role')
+        .where('user_role.user_id = :userId', { userId: uid })
+        .andWhere('user_role.is_deleted = :is_deleted', { is_deleted: false })
+        .orderBy('user_role.created_at', 'ASC')
+        .getOne();
+
+      seen.set(uid, {
+        user_id: uid,
+        department_id: notificationConfig.department_id ?? null,
+        section_id: notificationConfig.section_id ?? null,
+        role_id: userRole?.role_id ?? null,
+      });
+    }
+  }
+
+  return Array.from(seen.values());
+}
+
+/**
+ * Inserts portal notifications for users resolved from `services_notification_configs`.
+ */
+export async function sendFmServicesNotificationConfigNotifications(
+  manager: EntityManager,
+  params: SendFmServicesNotificationConfigNotificationsParams
+): Promise<{ sentCount: number }> {
+  const {
+    serviceId,
+    subServiceId,
+    pendingCount,
+    requestId,
+    status,
+    approvalLevel,
+    shortProductName,
+    requestTypeKey,
+    routePath,
+    createdBy,
+    logPrefix = '[FM notification config]',
+  } = params;
+
+  if (!serviceId || !subServiceId) return { sentCount: 0 };
+
+  const notificationConfigs = await manager
+    .getRepository(ServicesNotificationConfigs)
+    .createQueryBuilder('SNC')
+    .where('SNC.service_id = :service_id', { service_id: serviceId })
+    .andWhere('SNC.sub_service_id = :sub_service_id', { sub_service_id: subServiceId })
+    .andWhere('SNC.is_deleted = :is_deleted', { is_deleted: false })
+    .andWhere('SNC.is_active = :is_active', { is_active: true })
+    .getMany();
+
+  if (!notificationConfigs?.length) {
+    console.warn(
+      `${logPrefix} No notification configurations found for service ${serviceId} and sub_service ${subServiceId}`
+    );
+    return { sentCount: 0 };
+  }
+
+  let sentCount = 0;
+  const createdByStr = String(createdBy ?? 'system');
+
+  for (const notificationConfig of notificationConfigs) {
+    if (notificationConfig.trigger === ServicesNotificationTriggerType.FINAL_APPROVAL) {
+      if (pendingCount !== 0) continue;
+    } else if (notificationConfig.trigger === ServicesNotificationTriggerType.EVERY_APPROVAL) {
+      // include on every approval step
+    } else {
+      continue;
+    }
+
+    let usersQuery = manager
+      .getRepository(UserRole)
+      .createQueryBuilder('user_role')
+      .where('user_role.department_id = :department_id', {
+        department_id: notificationConfig.department_id,
+      })
+      .andWhere('user_role.section_id = :section_id', { section_id: notificationConfig.section_id })
+      .andWhere('user_role.is_deleted = :is_deleted', { is_deleted: false });
+
+    if (notificationConfig.role_id != null && notificationConfig.role_id !== undefined) {
+      usersQuery = usersQuery.andWhere('user_role.role_id = :role_id', {
+        role_id: notificationConfig.role_id,
+      });
+    }
+    const userRoles = await usersQuery.getMany();
+
+    if (!userRoles?.length) {
+      console.warn(
+        `${logPrefix} No users found for ${notificationConfig.trigger} config (dept ${notificationConfig.department_id}${notificationConfig.section_id != null ? `, section ${notificationConfig.section_id}` : ''})`
+      );
+      continue;
+    }
+
+    const isEveryApproval = notificationConfig.trigger === ServicesNotificationTriggerType.EVERY_APPROVAL;
+    const notificationTitle = isEveryApproval
+      ? `${shortProductName} Request ${status} at Level ${approvalLevel}`
+      : `${shortProductName} Request ${status}`;
+    const notificationData = `${shortProductName} request #${requestId} has been ${status}.`;
+
+    for (const ur of userRoles) {
+      const targetUserId = ur.user_id;
+      try {
+        const primaryUserRole = await manager
+          .getRepository(UserRole)
+          .createQueryBuilder('user_role')
+          .where('user_role.user_id = :userId', { userId: targetUserId })
+          .andWhere('user_role.is_deleted = :is_deleted', { is_deleted: false })
+          .orderBy('user_role.created_at', 'ASC')
+          .getOne();
+
+        await manager
+          .createQueryBuilder()
+          .insert()
+          .into(Notification)
+          .values({
+            type: NotificationType.REQUEST_RAISED,
+            user_id: targetUserId,
+            role_id: primaryUserRole?.role_id ?? null,
+            department_id: notificationConfig.department_id ?? null,
+            section_id: notificationConfig.section_id ?? null,
+            request_id: requestId,
+            service_id: serviceId ?? null,
+            sub_service_id: subServiceId ?? null,
+            content: {
+              title: notificationTitle,
+              data: notificationData,
+              requestId,
+              requestType: requestTypeKey,
+              status,
+              level: approvalLevel,
+              timestamp: new Date().toISOString(),
+            },
+            is_read: false,
+            route_path: routePath,
+            created_by: createdByStr,
+          } as never)
+          .execute();
+        sentCount += 1;
+      } catch (userNotificationError: unknown) {
+        const message =
+          userNotificationError instanceof Error ? userNotificationError.message : String(userNotificationError);
+        console.warn(`${logPrefix} Failed to send config notification to user ${targetUserId}:`, message);
+      }
+    }
+
+    console.info(
+      `${logPrefix} Sent ${notificationConfig.trigger} config notifications to ${userRoles.length} user(s) in department ${notificationConfig.department_id}${notificationConfig.section_id != null ? `, section ${notificationConfig.section_id}` : ''}`
+    );
+  }
+
+  return { sentCount };
+}

package/src/index.ts

@@ -98,8 +98,6 @@ export * from './models/UpdateAttendanceWorkflowModel';
 export * from './models/SlaRequestModel';
 export * from './models/ServiceSlaApprovalModel';
 export * from './models/SlaConfigModel';
-export * from './models/SlaMyRequestsViewModel';
-export * from './models/SlaApprovalsViewModel';
 export * from './models/GeneralServiceRequestsModel';
 export * from './models/GeneralServiceApprovalsModel';
 export * from './models/GeneralServiceWorkFlowModel';
@@ -427,6 +425,20 @@ export * from './models/EmployeeMilestoneDetailsModel';
 export * from './models/MissionTravelPassportExpiryNotificationConfigModel';
 export * from './models/ServicesNotificationConfigsModel';
 export { ServicesNotificationTriggerType } from './models/ServicesNotificationConfigsModel';
+export {
+  collectFmServicesNotificationConfigRecipients,
+  sendFmServicesNotificationConfigNotifications,
+} from './helpers/services-notification-config.helper';
+export {
+  parsePortalUserIdFromRequest,
+  userHasPortalAdminRole,
+  isPortalAdminFromRequest,
+} from './helpers/admin-auth.helper';
+export type {
+  FmServicesNotificationConfigRecipient,
+  CollectFmServicesNotificationConfigRecipientsParams,
+  SendFmServicesNotificationConfigNotificationsParams,
+} from './helpers/services-notification-config.helper';
 // Moodle Users Model
 export * from './models/MoodleUsersModel';
 // Evaluation

package/src/models/SlaApprovalsViewModel.ts

@@ -1,135 +1,135 @@
-import { ViewColumn, ViewEntity } from "typeorm";
-
-const VW_SLA_APPROVALS_SQL = `
-SELECT
-    sa.id AS sla_approval_id,
-    sa.source_approval_id,
-    sa.request_id,
-    sa.service_id AS service_id,
-    sa.sub_service_id AS sub_service_id,
-    TRIM(COALESCE(svc.name, ''))::TEXT AS service_name,
-    TRIM(COALESCE(subsvc.sub_service_name, ''))::TEXT AS sub_service_name,
-    sa.approver_role_id AS approval_role_id,
-    TRIM(COALESCE(ar.name, ''))::TEXT AS approval_role_name,
-    sa.department_id AS approval_department_id,
-    TRIM(COALESCE(adpt.department_name, ''))::TEXT AS approval_department_name,
-    sa.section_id AS approval_section_id,
-    TRIM(COALESCE(asec.section_name, ''))::TEXT AS approval_section_name,
-    sa.approval_status::TEXT AS approval_status,
-    sr.status::TEXT AS request_status,
-    sa.level AS level,
-    sa.approver_user_id AS approver_user_id,
-    TRIM(COALESCE(au.employee_name, ''))::TEXT AS approver_user_name,
-    sa.delegate_user_id AS delegate_user_id,
-    TRIM(COALESCE(du.employee_name, ''))::TEXT AS delegate_user_name,
-    sa.approved_by AS approved_by,
-    TRIM(COALESCE(ab.employee_name, ''))::TEXT AS approved_by_name,
-    sa.comment::TEXT AS comment,
-    sa.created_at AS created_at,
-    sa.updated_at AS updated_at
-FROM sla_approval sa
-INNER JOIN sla_requests sr
-    ON sr.request_id = sa.request_id AND COALESCE(sr.is_deleted, false) = false
-LEFT JOIN fm_services svc
-    ON svc.id = sa.service_id AND COALESCE(svc.is_deleted, false) = false
-LEFT JOIN fm_sub_services subsvc
-    ON subsvc.id = sa.sub_service_id AND COALESCE(subsvc.is_deleted, false) = false
-LEFT JOIN departments adpt
-    ON adpt.id = sa.department_id AND COALESCE(adpt.is_deleted, false) = false
-LEFT JOIN sections asec
-    ON asec.id = sa.section_id AND COALESCE(asec.is_deleted, false) = false
-LEFT JOIN role ar
-    ON ar.id = sa.approver_role_id AND COALESCE(ar.is_deleted, false) = false
-LEFT JOIN users au
-    ON au.id = sa.approver_user_id AND COALESCE(au.is_deleted, false) = false
-LEFT JOIN users du
-    ON du.id = sa.delegate_user_id AND COALESCE(du.is_deleted, false) = false
-LEFT JOIN users ab
-    ON ab.id = sa.approved_by AND COALESCE(ab.is_deleted, false) = false
-WHERE COALESCE(sa.is_deleted, false) = false
-`;
-
-/**
- * Read-only view for SLA approvals listings (TypeORM).
- * Approver matching (`sla_approval_matches_user` semantics) is applied in Reports_Service queries.
- */
-@ViewEntity({
-    name: "vw_sla_approvals",
-    expression: VW_SLA_APPROVALS_SQL,
-})
-export class SlaApprovalsView {
-    @ViewColumn()
-    sla_approval_id: number;
-
-    @ViewColumn()
-    source_approval_id: number;
-
-    @ViewColumn()
-    request_id: number;
-
-    @ViewColumn()
-    service_id: number;
-
-    @ViewColumn()
-    sub_service_id: number;
-
-    @ViewColumn()
-    service_name: string;
-
-    @ViewColumn()
-    sub_service_name: string;
-
-    @ViewColumn()
-    approval_role_id: number;
-
-    @ViewColumn()
-    approval_role_name: string;
-
-    @ViewColumn()
-    approval_department_id: number;
-
-    @ViewColumn()
-    approval_department_name: string;
-
-    @ViewColumn()
-    approval_section_id: number;
-
-    @ViewColumn()
-    approval_section_name: string;
-
-    @ViewColumn()
-    approval_status: string;
-
-    @ViewColumn()
-    request_status: string;
-
-    @ViewColumn()
-    level: number;
-
-    @ViewColumn()
-    approver_user_id: number;
-
-    @ViewColumn()
-    approver_user_name: string;
-
-    @ViewColumn()
-    delegate_user_id: number;
-
-    @ViewColumn()
-    delegate_user_name: string;
-
-    @ViewColumn()
-    approved_by: number;
-
-    @ViewColumn()
-    approved_by_name: string;
-
-    @ViewColumn()
-    comment: string;
-
-    @ViewColumn()
-    created_at: Date;
-
-    @ViewColumn()
-    updated_at: Date;
-}
+import { ViewColumn, ViewEntity } from "typeorm";
+
+const VW_SLA_APPROVALS_SQL = `
+SELECT
+    sa.id AS sla_approval_id,
+    sa.source_approval_id,
+    sa.request_id,
+    sa.service_id AS service_id,
+    sa.sub_service_id AS sub_service_id,
+    TRIM(COALESCE(svc.name, ''))::TEXT AS service_name,
+    TRIM(COALESCE(subsvc.sub_service_name, ''))::TEXT AS sub_service_name,
+    sa.approver_role_id AS approval_role_id,
+    TRIM(COALESCE(ar.name, ''))::TEXT AS approval_role_name,
+    sa.department_id AS approval_department_id,
+    TRIM(COALESCE(adpt.department_name, ''))::TEXT AS approval_department_name,
+    sa.section_id AS approval_section_id,
+    TRIM(COALESCE(asec.section_name, ''))::TEXT AS approval_section_name,
+    sa.approval_status::TEXT AS approval_status,
+    sr.status::TEXT AS request_status,
+    sa.level AS level,
+    sa.approver_user_id AS approver_user_id,
+    TRIM(COALESCE(au.employee_name, ''))::TEXT AS approver_user_name,
+    sa.delegate_user_id AS delegate_user_id,
+    TRIM(COALESCE(du.employee_name, ''))::TEXT AS delegate_user_name,
+    sa.approved_by AS approved_by,
+    TRIM(COALESCE(ab.employee_name, ''))::TEXT AS approved_by_name,
+    sa.comment::TEXT AS comment,
+    sa.created_at AS created_at,
+    sa.updated_at AS updated_at
+FROM sla_approval sa
+INNER JOIN sla_requests sr
+    ON sr.request_id = sa.request_id AND COALESCE(sr.is_deleted, false) = false
+LEFT JOIN fm_services svc
+    ON svc.id = sa.service_id AND COALESCE(svc.is_deleted, false) = false
+LEFT JOIN fm_sub_services subsvc
+    ON subsvc.id = sa.sub_service_id AND COALESCE(subsvc.is_deleted, false) = false
+LEFT JOIN departments adpt
+    ON adpt.id = sa.department_id AND COALESCE(adpt.is_deleted, false) = false
+LEFT JOIN sections asec
+    ON asec.id = sa.section_id AND COALESCE(asec.is_deleted, false) = false
+LEFT JOIN role ar
+    ON ar.id = sa.approver_role_id AND COALESCE(ar.is_deleted, false) = false
+LEFT JOIN users au
+    ON au.id = sa.approver_user_id AND COALESCE(au.is_deleted, false) = false
+LEFT JOIN users du
+    ON du.id = sa.delegate_user_id AND COALESCE(du.is_deleted, false) = false
+LEFT JOIN users ab
+    ON ab.id = sa.approved_by AND COALESCE(ab.is_deleted, false) = false
+WHERE COALESCE(sa.is_deleted, false) = false
+`;
+
+/**
+ * Read-only view for SLA approvals listings (TypeORM).
+ * Approver matching (`sla_approval_matches_user` semantics) is applied in Reports_Service queries.
+ */
+@ViewEntity({
+    name: "vw_sla_approvals",
+    expression: VW_SLA_APPROVALS_SQL,
+})
+export class SlaApprovalsView {
+    @ViewColumn()
+    sla_approval_id: number;
+
+    @ViewColumn()
+    source_approval_id: number;
+
+    @ViewColumn()
+    request_id: number;
+
+    @ViewColumn()
+    service_id: number;
+
+    @ViewColumn()
+    sub_service_id: number;
+
+    @ViewColumn()
+    service_name: string;
+
+    @ViewColumn()
+    sub_service_name: string;
+
+    @ViewColumn()
+    approval_role_id: number;
+
+    @ViewColumn()
+    approval_role_name: string;
+
+    @ViewColumn()
+    approval_department_id: number;
+
+    @ViewColumn()
+    approval_department_name: string;
+
+    @ViewColumn()
+    approval_section_id: number;
+
+    @ViewColumn()
+    approval_section_name: string;
+
+    @ViewColumn()
+    approval_status: string;
+
+    @ViewColumn()
+    request_status: string;
+
+    @ViewColumn()
+    level: number;
+
+    @ViewColumn()
+    approver_user_id: number;
+
+    @ViewColumn()
+    approver_user_name: string;
+
+    @ViewColumn()
+    delegate_user_id: number;
+
+    @ViewColumn()
+    delegate_user_name: string;
+
+    @ViewColumn()
+    approved_by: number;
+
+    @ViewColumn()
+    approved_by_name: string;
+
+    @ViewColumn()
+    comment: string;
+
+    @ViewColumn()
+    created_at: Date;
+
+    @ViewColumn()
+    updated_at: Date;
+}