@gus-eip/loggers 3.8.8 → 3.9.0

package/dist/cloudwatch.logger.d.ts

@@ -21,5 +21,6 @@ export declare class CloudWatchLoggerService implements ILogger {
         source: string;
         destination: string;
     }>;
+    getUsecase(usecase: string): Promise<string>;
     logAlert(correlationId: string, timestamp: string, component: string, source: string, destination: string, event: string, usecase: string, sourcePayload: any, destinationPayload: any, logMessage: any, brand: any, secondaryKey: string, logStreamName: string, isAlertFormattingRequired?: boolean, type?: 'INFO' | 'Error', destinationObjectType?: string, destinationObjectId?: string, sourceObjectType?: string, sourceObjectId?: string, destinationResponse?: any): Promise<any>;
 }

package/dist/cloudwatch.logger.js

@@ -17,6 +17,7 @@ const axios_1 = require("axios");
 const source_destination_mapping_1 = require("./mappings/source-destination-mapping");
 const enum_1 = require("./enum");
 const ssm_utils_1 = require("./ssm-utils");
+const usecase_mapping_1 = require("./mappings/usecase-mapping");
 let CloudWatchLoggerService = class CloudWatchLoggerService {
     constructor(region, logGroupName, teamWebhookUrl, isAlertNeeded) {
         this.loggerEnum = new enum_1.LoggerEnum();
@@ -151,17 +152,28 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
             entityKey: fullLogObject.entityKey || '',
             event: fullLogObject.event || '',
             status,
+            message: fullLogObject.logMessage || '',
         };
         const sqsUrl = await ssm_utils_1.ssmUtils.getSqsUrl();
-        const results = await Promise.allSettled([
-            this.logToCloudWatch(type, fullLogObject, logStreamName),
-            this.sendToSQS(logEvent, sqsUrl),
-        ]);
-        results.forEach((result, index) => {
-            if (result.status === 'rejected') {
-                console.error(`Error in ${index === 0 ? 'logToCloudWatch' : 'sendToSQS'}:`, result.reason);
+        if (status === 'IN_PROGRESS' || !sqsUrl) {
+            try {
+                await this.logToCloudWatch(type, fullLogObject, logStreamName);
             }
-        });
+            catch (error) {
+                console.error('Error logging to CloudWatch:', error);
+            }
+        }
+        else {
+            const results = await Promise.allSettled([
+                this.logToCloudWatch(type, fullLogObject, logStreamName),
+                this.sendToSQS(logEvent, sqsUrl),
+            ]);
+            results.forEach((result, index) => {
+                if (result.status === 'rejected') {
+                    console.error(`Error in ${index === 0 ? 'logToCloudWatch' : 'sendToSQS'}:`, result.reason);
+                }
+            });
+        }
     }
     async sendNotificationtoTeams(title, summary, handler, logStreamName, isFormattingRequired = true, type) {
         console.log('Notification summary', summary);
@@ -255,7 +267,9 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
             sourceObjectId,
             destinationResponse,
         };
-        const status = event === this.loggerEnum.Event.OPERATION_COMPLETED ? 'COMPLETED' : 'IN_PROGRESS';
+        const status = event === this.loggerEnum.Event.OPERATION_COMPLETED
+            ? 'COMPLETED'
+            : 'IN_PROGRESS';
         await this.processLog('info', logStreamName, logObject, status);
     }
     async error(correlationId, timestamp, component, source, destination, event, usecase, sourcePayload, destinationPayload, errorMessage, brand, secondaryKey, logStreamName, entityKeyField, entityKey, destinationObjectType, destinationObjectId, sourceObjectType, sourceObjectId, destinationResponse) {
@@ -295,7 +309,6 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
         };
         try {
             await sqs.sendMessage(params).promise();
-            console.log('Log event successfully sent to SQS:', logEvent);
         }
         catch (error) {
             console.error('Failed to send log event to SQS:', error);
@@ -307,6 +320,9 @@ let CloudWatchLoggerService = class CloudWatchLoggerService {
             ? { source: mapping.source, destination: mapping.destination }
             : null;
     }
+    async getUsecase(usecase) {
+        return usecase_mapping_1.UsecaseMapping[usecase] || '';
+    }
     async logAlert(correlationId, timestamp, component, source, destination, event, usecase, sourcePayload, destinationPayload, logMessage, brand, secondaryKey, logStreamName, isAlertFormattingRequired, type, destinationObjectType, destinationObjectId, sourceObjectType, sourceObjectId, destinationResponse) {
         const logObject = {
             correlationId,

package/dist/interfaces/log-event.interface.d.ts

@@ -8,4 +8,5 @@ export interface LogEvent {
     entityKey: string;
     event: any;
     status: string;
+    message: string;
 }

package/dist/mappings/source-destination-mapping.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BRAND_USECASE_MAPPING = void 0;
 exports.BRAND_USECASE_MAPPING = [
     {
-        brands: ['LIM', 'HZU', 'IBAT', 'LSBFMYR'],
+        brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR'],
         usecase: 'SAVE_BASIC_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -27,13 +27,13 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'HZU', 'IBAT'],
+        brands: ['LIM College', 'HZU', 'IBAT'],
         usecase: 'SAVE_ADDITIONAL_INFORMATION',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'HZU'],
+        brands: ['LIM College', 'HZU'],
         usecase: 'SAVE_ACADEMIC_INFORMATION',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -45,7 +45,7 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'HZU', 'IBAT', 'LSBFMYR'],
+        brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR'],
         usecase: 'SAVE_PERSONAL_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -57,19 +57,19 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
+        brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
         usecase: 'SUBMIT_APPLICATION',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
+        brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
         usecase: 'UPLOAD_DOCUMENT',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
+        brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
         usecase: 'GUS_SALESFORCE_OPERATION',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -93,7 +93,7 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['UCW', 'LIM'],
+        brands: ['UCW', 'LIM College'],
         usecase: 'SAVE_EMPLOYMENT_HISTORY_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -111,7 +111,7 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
+        brands: ['LIM College', 'HZU', 'IBAT', 'LSBFMYR', 'UNFC'],
         usecase: 'SAVE_PROGRAMME_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -123,25 +123,25 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM'],
+        brands: ['LIM College'],
         usecase: 'SAVE_PRIVACY_PROTECTION_POLICY_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'IBAT', 'LSBFMYR'],
+        brands: ['LIM College', 'IBAT', 'LSBFMYR'],
         usecase: 'SAVE_DECLARATION_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM', 'LSBFMYR'],
+        brands: ['LIM College', 'LSBFMYR'],
         usecase: 'SAVE_TEST_INFORMATION',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['HZU', 'LIM'],
+        brands: ['HZU', 'LIM College'],
         usecase: 'SAVE_FINANCIAL_DOCUMENT',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -153,13 +153,13 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM'],
+        brands: ['LIM College'],
         usecase: 'SAVE_ADMISSION_RECOMMENDATION_LETTER_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM'],
+        brands: ['LIM College'],
         usecase: 'SAVE_REQUIRED_ESSAY_RESUME_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
@@ -171,13 +171,13 @@ exports.BRAND_USECASE_MAPPING = [
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM'],
+        brands: ['LIM College'],
         usecase: 'SAVE_HONESTY_STATEMENT_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',
     },
     {
-        brands: ['LIM'],
+        brands: ['LIM College'],
         usecase: 'SAVE_LEGAL_NOTICE_DETAILS',
         source: 'OAP',
         destination: 'GUS Salesforce',

package/dist/mappings/usecase-mapping.d.ts

@@ -0,0 +1,55 @@
+export declare enum UsecaseMapping {
+    SAVE_PROGRAMME_DETAILS = "Save Programme Details",
+    SAVE_APPLICANT_INFO = "Save Applicant Information",
+    SAVE_EMERGENCY_CONTACT_DETAILS = "Save Emergency Contact Details",
+    SAVE_BASIC_DETAILS = "Save Basic Details",
+    SAVE_ADDITIONAL_INFORMATION = "Save Additional Information",
+    SAVE_CONTACT_INFO = "Save Contact Information",
+    SAVE_ACADEMIC_INFORMATION = "Save Academic Information",
+    SAVE_PERSONAL_DETAILS = "Save Personal Details",
+    SAVE_TERMS_AND_CONDITIONS = "Save Terms and Conditions",
+    SUBMIT_APPLICATION = "Application Submitted",
+    UPLOAD_DOCUMENT = "Document Uploaded",
+    SAVE_COURSE_SELECTION_DETAILS = "Save Course Selection Details",
+    SAVE_EDUCATION_HISTORY_DETAILS = "Save Education History Details",
+    SAVE_STANDARDIZED_TESTS_DETAILS = "Save Standardized Test Details",
+    SAVE_EMPLOYMENT_HISTORY_DETAILS = "Save Employment History Details",
+    SAVE_ADDITIONAL_DOCUMENTS_DETAILS = "Save Additional Documents",
+    SAVE_TRANSFER_CREDITS_DETAILS = "Save Transfer Credits Details",
+    SAVE_AWARDS_DETAILS = "Save Awards Details",
+    SAVE_PRIVACY_PROTECTION_POLICY_DETAILS = "Save Privacy Policy Details",
+    SAVE_DECLARATION_DETAILS = "Save Declaration Details",
+    SAVE_TEST_INFORMATION = "Save Test Information",
+    SAVE_FINANCIAL_DOCUMENT = "Save Financial Document",
+    SAVE_ADDITIONAL_SERVICES_INFORMATION = "Save Additional Services Information",
+    SAVE_ADMISSION_RECOMMENDATION_LETTER_DETAILS = "Save Admission Recommendation Letter",
+    SAVE_REQUIRED_ESSAY_RESUME_DETAILS = "Save Required Essay or Resume",
+    SAVE_INTERNATIONAL_STUDENT_CONSENT_FORM_DETAILS = "Save International Student Consent Form",
+    SAVE_HONESTY_STATEMENT_DETAILS = "Save Honesty Statement",
+    SAVE_LEGAL_NOTICE_DETAILS = "Save Legal Notice",
+    GUS_NEW_APPLICATION = "Application sync",
+    DOCUMENT_CHECKLIST_CREATED = "Document checklist item creation",
+    GUS_DOCUMENT_UPDATE = "Document sync",
+    SYNC_GUS_TO_HZU = "Application sync",
+    OPPORTUNITY_VISA_APPROVED = "Application visa approval",
+    CONDITIONAL_OFFER = "Offer letter issued",
+    OPPORTUNITY_REVOKED_CLOSED_LOST = "Application reopened",
+    OPPORTUNITY_CLOSED_LOST = "Institutional withdrawal",
+    OPPORTUNITY_CLOSED_WON = "Application enrolment",
+    Payment = "Deposit payment",
+    REJECTED_DOCUMENT_TASK = "Document rejection",
+    I_20 = "I20 issued",
+    GUS_NEW_DOCUMENT = "Document sync",
+    GUS_CLARIFICATION_SUBMITTED = "Clarification submission",
+    UCW_OFFERED = "Offer letter issued",
+    UCW_DOCUMENT_ISSUED = "Admission document issued",
+    UCW_VISA_APPROVED = "Application visa approval",
+    UCW_ENROLLED = "Application enrolment",
+    UCW_FOLLOWUP_TASK = "Institutional comment",
+    UCW_REJECT_APPLICATION = "Institutional rejection",
+    UCW_WITHDRAW_OFFER = "Offer withdrawn",
+    UCW_WITHDRAW_APPLICATION = "Application withdrawn",
+    UCW_REJECT_APPLICATION_VS = "Application visa rejection",
+    UCW_REJECT_DOCUMENT = "Document rejection",
+    UCW_APPLICATION_DEFERRED = "Application deferred"
+}

package/dist/mappings/usecase-mapping.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsecaseMapping = void 0;
+var UsecaseMapping;
+(function (UsecaseMapping) {
+    UsecaseMapping["SAVE_PROGRAMME_DETAILS"] = "Save Programme Details";
+    UsecaseMapping["SAVE_APPLICANT_INFO"] = "Save Applicant Information";
+    UsecaseMapping["SAVE_EMERGENCY_CONTACT_DETAILS"] = "Save Emergency Contact Details";
+    UsecaseMapping["SAVE_BASIC_DETAILS"] = "Save Basic Details";
+    UsecaseMapping["SAVE_ADDITIONAL_INFORMATION"] = "Save Additional Information";
+    UsecaseMapping["SAVE_CONTACT_INFO"] = "Save Contact Information";
+    UsecaseMapping["SAVE_ACADEMIC_INFORMATION"] = "Save Academic Information";
+    UsecaseMapping["SAVE_PERSONAL_DETAILS"] = "Save Personal Details";
+    UsecaseMapping["SAVE_TERMS_AND_CONDITIONS"] = "Save Terms and Conditions";
+    UsecaseMapping["SUBMIT_APPLICATION"] = "Application Submitted";
+    UsecaseMapping["UPLOAD_DOCUMENT"] = "Document Uploaded";
+    UsecaseMapping["SAVE_COURSE_SELECTION_DETAILS"] = "Save Course Selection Details";
+    UsecaseMapping["SAVE_EDUCATION_HISTORY_DETAILS"] = "Save Education History Details";
+    UsecaseMapping["SAVE_STANDARDIZED_TESTS_DETAILS"] = "Save Standardized Test Details";
+    UsecaseMapping["SAVE_EMPLOYMENT_HISTORY_DETAILS"] = "Save Employment History Details";
+    UsecaseMapping["SAVE_ADDITIONAL_DOCUMENTS_DETAILS"] = "Save Additional Documents";
+    UsecaseMapping["SAVE_TRANSFER_CREDITS_DETAILS"] = "Save Transfer Credits Details";
+    UsecaseMapping["SAVE_AWARDS_DETAILS"] = "Save Awards Details";
+    UsecaseMapping["SAVE_PRIVACY_PROTECTION_POLICY_DETAILS"] = "Save Privacy Policy Details";
+    UsecaseMapping["SAVE_DECLARATION_DETAILS"] = "Save Declaration Details";
+    UsecaseMapping["SAVE_TEST_INFORMATION"] = "Save Test Information";
+    UsecaseMapping["SAVE_FINANCIAL_DOCUMENT"] = "Save Financial Document";
+    UsecaseMapping["SAVE_ADDITIONAL_SERVICES_INFORMATION"] = "Save Additional Services Information";
+    UsecaseMapping["SAVE_ADMISSION_RECOMMENDATION_LETTER_DETAILS"] = "Save Admission Recommendation Letter";
+    UsecaseMapping["SAVE_REQUIRED_ESSAY_RESUME_DETAILS"] = "Save Required Essay or Resume";
+    UsecaseMapping["SAVE_INTERNATIONAL_STUDENT_CONSENT_FORM_DETAILS"] = "Save International Student Consent Form";
+    UsecaseMapping["SAVE_HONESTY_STATEMENT_DETAILS"] = "Save Honesty Statement";
+    UsecaseMapping["SAVE_LEGAL_NOTICE_DETAILS"] = "Save Legal Notice";
+    UsecaseMapping["GUS_NEW_APPLICATION"] = "Application sync";
+    UsecaseMapping["DOCUMENT_CHECKLIST_CREATED"] = "Document checklist item creation";
+    UsecaseMapping["GUS_DOCUMENT_UPDATE"] = "Document sync";
+    UsecaseMapping["SYNC_GUS_TO_HZU"] = "Application sync";
+    UsecaseMapping["OPPORTUNITY_VISA_APPROVED"] = "Application visa approval";
+    UsecaseMapping["CONDITIONAL_OFFER"] = "Offer letter issued";
+    UsecaseMapping["OPPORTUNITY_REVOKED_CLOSED_LOST"] = "Application reopened";
+    UsecaseMapping["OPPORTUNITY_CLOSED_LOST"] = "Institutional withdrawal";
+    UsecaseMapping["OPPORTUNITY_CLOSED_WON"] = "Application enrolment";
+    UsecaseMapping["Payment"] = "Deposit payment";
+    UsecaseMapping["REJECTED_DOCUMENT_TASK"] = "Document rejection";
+    UsecaseMapping["I_20"] = "I20 issued";
+    UsecaseMapping["GUS_NEW_DOCUMENT"] = "Document sync";
+    UsecaseMapping["GUS_CLARIFICATION_SUBMITTED"] = "Clarification submission";
+    UsecaseMapping["UCW_OFFERED"] = "Offer letter issued";
+    UsecaseMapping["UCW_DOCUMENT_ISSUED"] = "Admission document issued";
+    UsecaseMapping["UCW_VISA_APPROVED"] = "Application visa approval";
+    UsecaseMapping["UCW_ENROLLED"] = "Application enrolment";
+    UsecaseMapping["UCW_FOLLOWUP_TASK"] = "Institutional comment";
+    UsecaseMapping["UCW_REJECT_APPLICATION"] = "Institutional rejection";
+    UsecaseMapping["UCW_WITHDRAW_OFFER"] = "Offer withdrawn";
+    UsecaseMapping["UCW_WITHDRAW_APPLICATION"] = "Application withdrawn";
+    UsecaseMapping["UCW_REJECT_APPLICATION_VS"] = "Application visa rejection";
+    UsecaseMapping["UCW_REJECT_DOCUMENT"] = "Document rejection";
+    UsecaseMapping["UCW_APPLICATION_DEFERRED"] = "Application deferred";
+})(UsecaseMapping || (exports.UsecaseMapping = UsecaseMapping = {}));

package/dist/ssm-utils.js

@@ -26,7 +26,6 @@ class SsmUtils {
             return this.cachedSqsUrl;
         }
         catch (error) {
-            console.error('Error fetching SQS URL from SSM:', error);
             return "";
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gus-eip/loggers",
-  "version": "3.8.8",
+  "version": "3.9.0",
   "description": "@gus-eip/loggers is a package designed to provide logging functionality for your Node.js applications.",
   "author": "gus",
   "readmeFilename": "README.md",