#418 - Implement export agreements list endpoint

Author: Brijesh

src/constants.js

@@ -142,3 +142,40 @@ export const AGREEMENT_EXEMPTION_STATUS = {
 };
 
 export const SYSTEM_USER_ID = 1115;
+
+export const AGREEMENT_EXPORT_COLUMNS = {
+  RAN: 'RAN',
+  LICENSE_TYPE: 'License Type',
+  RANGE_NAME: 'Range Name',
+  LICENSEE: 'Licensee',
+  AGREEMENT_HOLDER_1: 'Agreement Holder 1',
+  AGREEMENT_HOLDER_1_EMAIL: 'Agreement Holder 1 Email',
+  AGREEMENT_HOLDER_2: 'Agreement Holder 2',
+  AGREEMENT_HOLDER_2_EMAIL: 'Agreement Holder 2 Email',
+  AGREEMENT_HOLDER_3: 'Agreement Holder 3',
+  AGREEMENT_HOLDER_3_EMAIL: 'Agreement Holder 3 Email',
+  AGREEMENT_HOLDER_4: 'Agreement Holder 4',
+  AGREEMENT_HOLDER_4_EMAIL: 'Agreement Holder 4 Email',
+  AGREEMENT_HOLDER_5: 'Agreement Holder 5',
+  AGREEMENT_HOLDER_5_EMAIL: 'Agreement Holder 5 Email',
+  ZONE_AGROLOGIST: 'Zone Agrologist',
+  ZONE: 'Zone',
+  DISTRICT: 'District',
+  PLAN_STATUS: 'Plan Status',
+  PLAN_START_DATE: 'Plan Start Date',
+  PLAN_END_DATE: 'Plan End Date',
+  USAGE_STATUS: 'Usage Status',
+  PERCENTAGE_USE: 'Percentage Use',
+  HAS_CURRENT_SCHEDULE: 'Has Current Schedule',
+  EXEMPTION_STATUS: 'Exemption Status',
+};
+
+export const AGREEMENT_EXPORT = {
+  FILENAME: 'agreements.csv',
+  CONTENT_TYPE: 'text/csv',
+  NO_PLAN_DEFAULT: 'No Plan',
+  YES: 'Yes',
+  NO: 'No',
+  DATE_FORMAT: 'YYYY-MM-DD',
+  TEST_RAN_PREFIX: 'RAN0999',
+};

src/libs/db2/model/agreement.js

@@ -103,6 +103,16 @@ export default class Agreement extends Model {
     }
   }
 
+  static getLicenseTypeText(agreement) {
+    if (Agreement.isHayCuttingSchedule(agreement)) {
+      return 'Hay Cutting Licence';
+    }
+    if (Agreement.isGrazingSchedule(agreement)) {
+      return 'Grazing Licence';
+    }
+    return '';
+  }
+
   get usageStatusText() {
     return Agreement.getUsageStatusText(this.usage_status);
   }
@@ -491,6 +501,9 @@ export default class Agreement extends Model {
         clientTypeCode: client.clientType.code,
         startDate: client.licenseeStartDate,
         endDate: client.licenseeEndDate,
+        email: client.email,
+        userGivenName: client.userGivenName,
+        userFamilyName: client.userFamilyName,
       };
 
       return aClient;

src/libs/db2/model/client.js

@@ -38,6 +38,9 @@ export default class Client extends Model {
     super(obj, db);
 
     this.clientType = new ClientType(ClientType.extract(data), db);
+    this.email = data.user_email || '';
+    this.userGivenName = data.user_given_name || '';
+    this.userFamilyName = data.user_family_name || '';
   }
 
   // To match previous Agreement (sequelize) schema.
@@ -61,7 +64,13 @@ export default class Client extends Model {
       return [];
     }
 
-    const myFields = [...Client.fields, ...ClientType.fields.map((f) => `${f} AS ${f.replace('.', '_')}`)];
+    const myFields = [
+      ...Client.fields,
+      ...ClientType.fields.map((f) => `${f} AS ${f.replace('.', '_')}`),
+      'user_account.email AS user_email',
+      'user_account.given_name AS user_given_name',
+      'user_account.family_name AS user_family_name',
+    ];
 
     const results = await db
       .select(myFields)
@@ -72,6 +81,12 @@ export default class Client extends Model {
       .join('ref_client_type', {
         'client_agreement.client_type_id': 'ref_client_type.id',
       })
+      .leftJoin('user_client_link', {
+        'user_client_link.client_id': 'ref_client.client_number',
+      })
+      .leftJoin('user_account', {
+        'user_account.id': 'user_client_link.user_id',
+      })
       .where({ 'client_agreement.agreement_id': agreement.forestFileId });
 
     const clients = results.map((row) => new Client(row));

src/router/routes_v1/agreement.js

@@ -2,11 +2,15 @@
 
 import { asyncMiddleware, errorWithCode } from '@bcgov/nodejs-common-utils';
 import { Router } from 'express';
+import moment from 'moment';
+import csv from 'csv';
 import config from '../../config';
 import DataManager from '../../libs/db2';
 import UserDistricts from '../../libs/db2/model/userDistricts';
 import ExemptionController from '../controllers_v1/ExemptionController';
 import ExemptionStatusController from '../controllers_v1/ExemptionStatusController';
+import { AGREEMENT_EXPORT_COLUMNS, AGREEMENT_EXPORT } from '../../constants';
+
 const router = new Router();
 
 const dm2 = new DataManager(config);
@@ -38,57 +42,64 @@ const getAgreeementsForAH = async (user, filterSettings) => {
   });
 };
 
-// Search agreements by RAN, contact name, and client name. This is only used by Web
-router.get(
-  '/search',
-  asyncMiddleware(async (req, res) => {
-    const { user, query } = req;
-    const filterSettings = JSON.parse(query.filterSettings);
-    const page = Number(filterSettings.page || 0);
-    const limit = Number(filterSettings.limit || 10);
-    let agreements = [];
-    let totalItems = 0;
-    if (user.isAgreementHolder()) {
-      agreements = await getAgreeementsForAH(user, {
-        ...filterSettings,
-        limit: null,
-        page: null,
-      });
-    } else if (user.isAdministrator() || user.canReadAll() || user.isRangeOfficer()) {
-      if (!(filterSettings?.zoneInfo?.selectedZones?.length === 0)) {
-        agreements = await Agreement.findWithAllRelations(
-          db,
-          { 'ref_zone.id': filterSettings.zoneInfo?.selectedZones },
-          {
-            ...filterSettings,
-            limit: null,
-            page: null,
-          },
-          true,
-        );
-      }
-    } else if (user.isDecisionMaker() || user.canReadDistrict()) {
-      const districts = await UserDistricts.find(db, { user_id: user.id });
-      const zones = await Zone.find(db, {
-        district_id: districts.map((d) => d.id),
-      });
+const getAgreements = async (user, filterSettings) => {
+  let agreements = [];
+  if (user.isAgreementHolder()) {
+    agreements = await getAgreeementsForAH(user, {
+      ...filterSettings,
+      limit: null,
+      page: null,
+    });
+  } else if (user.isAdministrator() || user.canReadAll() || user.isRangeOfficer()) {
+    if (!(filterSettings?.zoneInfo?.selectedZones?.length === 0)) {
       agreements = await Agreement.findWithAllRelations(
         db,
-        { zone_id: zones.map((z) => z.id) },
+        { 'ref_zone.id': filterSettings.zoneInfo?.selectedZones },
         {
           ...filterSettings,
           limit: null,
           page: null,
         },
-        false,
+        true,
       );
-    } else {
-      throw errorWithCode('Unable to determine user role', 500);
     }
-    totalItems = agreements.length;
+  } else if (user.isDecisionMaker() || user.canReadDistrict()) {
+    const districts = await UserDistricts.find(db, { user_id: user.id });
+    const zones = await Zone.find(db, {
+      district_id: districts.map((d) => d.id),
+    });
+    agreements = await Agreement.findWithAllRelations(
+      db,
+      { zone_id: zones.map((z) => z.id) },
+      {
+        ...filterSettings,
+        limit: null,
+        page: null,
+      },
+      false,
+    );
+  } else {
+    throw errorWithCode('Unable to determine user role', 500);
+  }
+
+  return agreements;
+};
+
+// Search agreements by RAN, contact name, and client name. This is only used by Web
+router.get(
+  '/search',
+  asyncMiddleware(async (req, res) => {
+    const { user, query } = req;
+    const filterSettings = query.filterSettings ? JSON.parse(query.filterSettings) : {};
+    const page = Number(filterSettings.page || 0);
+    const limit = Number(filterSettings.limit || 10);
+
+    const agreementsAll = await getAgreements(user, filterSettings);
+    const totalItems = agreementsAll.length;
     const startIndex = (page - 1) * limit;
     const endIndex = startIndex + limit;
-    agreements = agreements.slice(startIndex, endIndex);
+    const agreements = agreementsAll.slice(startIndex, endIndex);
+
     agreements.map((agreement) => agreement.transformToV1());
     const totalPages = Math.ceil(totalItems / limit);
     const currentPage = page > totalPages ? totalPages : page;
@@ -103,6 +114,97 @@ router.get(
   }),
 );
 
+// Export agreements as CSV
+router.get(
+  '/export',
+  asyncMiddleware(async (req, res) => {
+    const { user, query } = req;
+
+    if (!user.isAdministrator() && !user.isRangeOfficer() && !user.isDecisionMaker() && !user.isReadOnly()) {
+      throw errorWithCode('Unauthorized', 403);
+    }
+
+    const filterSettings = query.filterSettings ? JSON.parse(query.filterSettings) : {};
+
+    let agreements = await getAgreements(user, filterSettings);
+    // Filter out test agreements
+    agreements = agreements.filter((agreement) => !agreement.forestFileId.startsWith(AGREEMENT_EXPORT.TEST_RAN_PREFIX));
+    agreements.map((agreement) => agreement.transformToV1());
+
+    const csvData = agreements.map((agreement) => {
+      // Sort clients: primary (A) first, then others
+      const sortedClients = agreement.clients.sort((a, b) => {
+        if (a.clientTypeCode === 'A') return -1;
+        if (b.clientTypeCode === 'A') return 1;
+        return 0;
+      });
+
+      const primaryClient = sortedClients[0];
+      const clientName = primaryClient?.name || '';
+
+      // Get up to 5 agreement holders (from user account names) and emails, fill remaining with empty strings
+      const holders = Array(5)
+        .fill('')
+        .map((_, index) => {
+          const client = sortedClients[index];
+          if (!client) return '';
+          // Use user name if available, otherwise blank
+          if (client.userGivenName || client.userFamilyName) {
+            return `${client.userGivenName} ${client.userFamilyName}`.trim();
+          }
+          return '';
+        });
+      const emails = Array(5)
+        .fill('')
+        .map((_, index) => sortedClients[index]?.email || '');
+
+      return {
+        [AGREEMENT_EXPORT_COLUMNS.RAN]: agreement.forestFileId,
+        [AGREEMENT_EXPORT_COLUMNS.LICENSE_TYPE]: Agreement.getLicenseTypeText(agreement),
+        [AGREEMENT_EXPORT_COLUMNS.RANGE_NAME]: agreement.plan?.rangeName || '',
+        [AGREEMENT_EXPORT_COLUMNS.LICENSEE]: clientName,
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_1]: holders[0],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_1_EMAIL]: emails[0],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_2]: holders[1],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_2_EMAIL]: emails[1],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_3]: holders[2],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_3_EMAIL]: emails[2],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_4]: holders[3],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_4_EMAIL]: emails[3],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_5]: holders[4],
+        [AGREEMENT_EXPORT_COLUMNS.AGREEMENT_HOLDER_5_EMAIL]: emails[4],
+        [AGREEMENT_EXPORT_COLUMNS.ZONE_AGROLOGIST]: agreement.zone?.user
+          ? `${agreement.zone.user.givenName} ${agreement.zone.user.familyName}`
+          : '',
+        [AGREEMENT_EXPORT_COLUMNS.ZONE]: agreement.zone?.code || '',
+        [AGREEMENT_EXPORT_COLUMNS.DISTRICT]: agreement.zone?.district?.code || '',
+        [AGREEMENT_EXPORT_COLUMNS.PLAN_STATUS]: agreement.plan?.status?.name || AGREEMENT_EXPORT.NO_PLAN_DEFAULT,
+        [AGREEMENT_EXPORT_COLUMNS.PLAN_START_DATE]: agreement.plan?.planStartDate
+          ? moment(agreement.plan.planStartDate).format(AGREEMENT_EXPORT.DATE_FORMAT)
+          : '',
+        [AGREEMENT_EXPORT_COLUMNS.PLAN_END_DATE]: agreement.plan?.planEndDate
+          ? moment(agreement.plan.planEndDate).format(AGREEMENT_EXPORT.DATE_FORMAT)
+          : '',
+        [AGREEMENT_EXPORT_COLUMNS.USAGE_STATUS]: Agreement.getUsageStatusText(agreement.usageStatus),
+        [AGREEMENT_EXPORT_COLUMNS.PERCENTAGE_USE]: agreement.percentageUse || 0,
+        [AGREEMENT_EXPORT_COLUMNS.HAS_CURRENT_SCHEDULE]: agreement.hasCurrentSchedule
+          ? AGREEMENT_EXPORT.YES
+          : AGREEMENT_EXPORT.NO,
+        [AGREEMENT_EXPORT_COLUMNS.EXEMPTION_STATUS]: Agreement.getExemptionStatusText(agreement.exemptionStatus),
+      };
+    });
+
+    csv.stringify(csvData, { header: true }, (err, output) => {
+      if (err) {
+        throw err;
+      }
+      res.setHeader('Content-Type', AGREEMENT_EXPORT.CONTENT_TYPE);
+      res.setHeader('Content-Disposition', `attachment; filename="${AGREEMENT_EXPORT.FILENAME}"`);
+      res.status(200).send(output);
+    });
+  }),
+);
+
 // Exemption routes nested under /agreement/:agreementId/exemption
 const exemptionBase = '/:agreementId/exemption';
 // Exemption history