@dmptool/utils 1.0.27 → 1.0.29

package/dist/dynamo.js

@@ -671,7 +671,6 @@ exports.deleteDMP = deleteDMP;
 // We're not currently using it, but did not want to remove it just in case
 // we need it in the future
 //
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
 const scanTable = async (dynamoConnectionParams, params) => {
     if (!dynamoConnectionParams || !params) {
         throw new DMPToolDynamoError('Missing Dynamo config or params');

package/dist/general.d.ts

@@ -20,6 +20,13 @@ export declare const toErrorMessage: (error: unknown) => string;
  * @returns a URL with the protocol converted to https
  */
 export declare const normaliseHttpProtocol: (input: string | null) => string | null;
+/**
+ * Function to determine if the string is a valid date / time
+ *
+ * @param dateString the date string to validate
+ * @returns true if the date string is valid, false otherwise
+ */
+export declare const isValidDate: (dateString: string) => boolean;
 /**
  *Function to return the current date.
  *

package/dist/general.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.areEqual = exports.removeNullAndUndefinedFromObject = exports.isNullOrUndefined = exports.randomHex = exports.convertMySQLDateTimeToRFC3339 = exports.currentDateAsString = exports.normaliseHttpProtocol = exports.toErrorMessage = exports.EnvironmentEnum = void 0;
+exports.areEqual = exports.removeNullAndUndefinedFromObject = exports.isNullOrUndefined = exports.randomHex = exports.convertMySQLDateTimeToRFC3339 = exports.currentDateAsString = exports.isValidDate = exports.normaliseHttpProtocol = exports.toErrorMessage = exports.EnvironmentEnum = void 0;
 /**
  * Possible environments for the application.
  */
@@ -35,6 +35,18 @@ const normaliseHttpProtocol = (input) => {
     return input.trim().replace(/^http:\/\//, 'https://');
 };
 exports.normaliseHttpProtocol = normaliseHttpProtocol;
+/**
+ * Function to determine if the string is a valid date / time
+ *
+ * @param dateString the date string to validate
+ * @returns true if the date string is valid, false otherwise
+ */
+const isValidDate = (dateString) => {
+    const date = Date.parse(dateString);
+    // A valid date will return a number, an invalid one will return NaN
+    return !Number.isNaN(date);
+};
+exports.isValidDate = isValidDate;
 /**
  *Function to return the current date.
  *

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 export * from './cloudFormation';
 export * from './dynamo';
-export * from './eventBridge';
 export * from './general';
 export * from './logger';
 export * from './maDMP';
 export * from './maDMPTypes';
 export * from './rds';
 export * from './s3';
+export * from './sqs';
 export * from './ssm';

package/dist/index.js

@@ -17,11 +17,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // Entrypoint for the package
 __exportStar(require("./cloudFormation"), exports);
 __exportStar(require("./dynamo"), exports);
-__exportStar(require("./eventBridge"), exports);
 __exportStar(require("./general"), exports);
 __exportStar(require("./logger"), exports);
 __exportStar(require("./maDMP"), exports);
 __exportStar(require("./maDMPTypes"), exports);
 __exportStar(require("./rds"), exports);
 __exportStar(require("./s3"), exports);
+__exportStar(require("./sqs"), exports);
 __exportStar(require("./ssm"), exports);

package/dist/maDMP.js

@@ -382,34 +382,38 @@ const loadNarrativeTemplateInfo = async (rdsConnectionParams, planId) => {
         section: [],
     };
     results.forEach((row) => {
-        // Sections may have several rows in the results, so we need to check if we
-        // already have the section defined.
-        let curSection = narrative.section.find((s) => {
-            return s.id === row.sectionId;
-        });
-        if (curSection === undefined || curSection === null) {
-            curSection = {
-                id: row.sectionId,
-                title: row.sectionTitle,
-                description: row.sectionDescription !== null ? row.sectionDescription : undefined,
-                order: row.sectionOrder !== null ? row.sectionOrder : 0,
-                question: [],
-            };
-            narrative.section.push(curSection);
+        if (row.sectionId !== null && row.sectionId !== undefined) {
+            // Sections may have several rows in the results, so we need to check if we
+            // already have the section defined.
+            let curSection = narrative.section.find((s) => {
+                return s.id === row.sectionId;
+            });
+            if (curSection === undefined || curSection === null) {
+                curSection = {
+                    id: row.sectionId,
+                    title: row.sectionTitle,
+                    description: row.sectionDescription !== null ? row.sectionDescription : undefined,
+                    order: row.sectionOrder !== null ? row.sectionOrder : 0,
+                    question: [],
+                };
+                narrative.section.push(curSection);
+            }
+            if (row.questionId !== null && row.questionId !== undefined) {
+                const hasAnswer = row.answerJSON !== undefined && row.answerJSON !== null;
+                // Every row in the results represents a single question/answer pair
+                curSection.question.push({
+                    id: row.questionId,
+                    text: row.questionText,
+                    order: row.questionOrder !== null ? row.questionOrder : 0,
+                    answer: hasAnswer
+                        ? {
+                            id: row.answerId,
+                            json: row.answerJSON
+                        }
+                        : undefined
+                });
+            }
         }
-        const hasAnswer = row.answerJSON !== undefined && row.answerJSON !== null;
-        // Every row in the results represents a single question/answer pair
-        curSection.question.push({
-            id: row.questionId,
-            text: row.questionText,
-            order: row.questionOrder !== null ? row.questionOrder : 0,
-            answer: hasAnswer
-                ? {
-                    id: row.answerId,
-                    json: row.answerJSON
-                }
-                : undefined
-        });
     });
     return narrative;
 };
@@ -525,7 +529,7 @@ const buildContributors = (applicationName, env, planId, projectId, members, def
  * @returns the DMP metadata with extensions from the DMP Tool
  */
 const buildDMPToolExtensions = async (rdsConnectionParams, applicationName, domainName, plan, project, funding) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d;
     const extensions = {
         rda_schema_version: types_1.RDA_COMMON_STANDARD_VERSION,
         // Ignoring the `!` assertion here because we know we check the env variable
@@ -533,8 +537,8 @@ const buildDMPToolExtensions = async (rdsConnectionParams, applicationName, doma
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         provenance: applicationName,
         featured: plan.featured ? 'yes' : 'no',
-        privacy: (_b = (_a = plan.visibility) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== null && _b !== void 0 ? _b : 'private',
-        status: (_d = (_c = plan.status) === null || _c === void 0 ? void 0 : _c.toLowerCase()) !== null && _d !== void 0 ? _d : 'draft',
+        privacy: plan.visibility === 'PUBLIC' ? 'public' : 'private',
+        status: (_b = (_a = plan.status) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== null && _b !== void 0 ? _b : 'draft',
     };
     // Generate the DMP Narrative
     const narrative = await loadNarrativeTemplateInfo(rdsConnectionParams, plan.id);
@@ -570,7 +574,7 @@ const buildDMPToolExtensions = async (rdsConnectionParams, applicationName, doma
                 funder_id: funderId,
                 project_identifier: {
                     identifier: funding.funderProjectNumber,
-                    type: ((_e = funding.funderProjectNumber) === null || _e === void 0 ? void 0 : _e.startsWith('http'))
+                    type: ((_c = funding.funderProjectNumber) === null || _c === void 0 ? void 0 : _c.startsWith('http'))
                         ? maDMPTypes_1.StandardIdentifierType.URL
                         : maDMPTypes_1.StandardIdentifierType.OTHER
                 }
@@ -585,7 +589,7 @@ const buildDMPToolExtensions = async (rdsConnectionParams, applicationName, doma
                 funder_id: funderId,
                 opportunity_identifier: {
                     identifier: funding.funderOpportunityNumber,
-                    type: ((_f = funding.funderOpportunityNumber) === null || _f === void 0 ? void 0 : _f.startsWith('http'))
+                    type: ((_d = funding.funderOpportunityNumber) === null || _d === void 0 ? void 0 : _d.startsWith('http'))
                         ? maDMPTypes_1.StandardIdentifierType.URL
                         : maDMPTypes_1.StandardIdentifierType.OTHER
                 }
@@ -608,8 +612,9 @@ const buildDMPToolExtensions = async (rdsConnectionParams, applicationName, doma
         extensions.funding_opportunity = [funderOpportunity];
     }
     if (!(0, general_1.isNullOrUndefined)(narrative)) {
+        const id = plan.dmpId.replace('https://doi.org/', '');
         extensions.narrative = {
-            download_url: `https://${domainName}/dmps/${plan.dmpId}/narrative`,
+            download_url: `https://${domainName}/dmps/${id}/narrative`,
             template: narrative
         };
     }
@@ -663,8 +668,8 @@ const buildProject = (applicationName, planId, project, funding) => {
     return {
         title: project.title,
         description: (_c = project.abstractText) !== null && _c !== void 0 ? _c : undefined,
-        start: (_d = project.startDate) !== null && _d !== void 0 ? _d : undefined,
-        end: (_e = project.endDate) !== null && _e !== void 0 ? _e : undefined,
+        start: (0, general_1.isValidDate)((_d = project.startDate) !== null && _d !== void 0 ? _d : '') ? project.startDate : undefined,
+        end: (0, general_1.isValidDate)((_e = project.endDate) !== null && _e !== void 0 ? _e : '') ? project.endDate : undefined,
         project_id: [{
                 identifier: internalIdBase(applicationName, project.id, planId),
                 type: 'other'

package/dist/sqs.d.ts

@@ -0,0 +1,19 @@
+import { Logger } from 'pino';
+export interface SendMessageResponse {
+    status: number;
+    message: string;
+    messageId?: string;
+}
+/**
+ * Send an SQS message to the specified queue.
+ *
+ * @param logger The logger to use for logging.
+ * @param queueURL The endpoint of the SQS queue to send the message to.
+ * @param source The name of the caller (e.g. the Lambda Function or Application Function)
+ * @param detailType The type of message
+ * @param detail The payload of the message (will be accessible to the invoked resource)
+ * @param region The region to publish the message in. Defaults to 'us-west-2'.
+ * @returns A SendMessageResponse object containing the status code and message info.
+ * @throws Error if there was an error sending the message
+ */
+export declare const sendMessage: (logger: Logger, queueURL: string, source: string, detailType: string, details: Record<string, unknown>, region?: string) => Promise<SendMessageResponse>;

package/dist/sqs.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendMessage = void 0;
+const client_sqs_1 = require("@aws-sdk/client-sqs");
+const general_1 = require("./general");
+/**
+ * Send an SQS message to the specified queue.
+ *
+ * @param logger The logger to use for logging.
+ * @param queueURL The endpoint of the SQS queue to send the message to.
+ * @param source The name of the caller (e.g. the Lambda Function or Application Function)
+ * @param detailType The type of message
+ * @param detail The payload of the message (will be accessible to the invoked resource)
+ * @param region The region to publish the message in. Defaults to 'us-west-2'.
+ * @returns A SendMessageResponse object containing the status code and message info.
+ * @throws Error if there was an error sending the message
+ */
+const sendMessage = async (logger, queueURL, source, detailType, details, region = 'us-west-2') => {
+    var _a, _b;
+    let errMsg = '';
+    if (logger && queueURL) {
+        // Create a new SQS client instance
+        const client = new client_sqs_1.SQSClient({ region });
+        logger.debug({ queueURL, source, detailType, details }, 'Sending message');
+        try {
+            // Send the message
+            const response = await client.send(new client_sqs_1.SendMessageCommand({
+                QueueUrl: queueURL,
+                MessageBody: JSON.stringify(Object.assign(Object.assign({}, details), { source })),
+                MessageAttributes: {
+                    "DetailType": {
+                        "DataType": "String",
+                        "StringValue": detailType
+                    }
+                }
+            }));
+            if (response) {
+                const statusCode = (_b = (_a = response.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode) !== null && _b !== void 0 ? _b : 500;
+                // We got a response, so return it.
+                return {
+                    status: statusCode,
+                    message: statusCode >= 200 && statusCode <= 300 ? "Ok" : "Failure",
+                    messageId: response.MessageId
+                };
+            }
+            else {
+                logger.error({ queueURL, source, detailType, details }, 'No response from SQS');
+                errMsg = 'No response from SQS';
+            }
+        }
+        catch (error) {
+            logger.fatal({ queueURL, source, detailType, details, error }, 'Error sending message');
+            errMsg = `Error sending message: ${(0, general_1.toErrorMessage)(error)}`;
+        }
+    }
+    else {
+        errMsg = 'Missing logger or queueURL args!';
+    }
+    // The SQS was not available or the response was undefined
+    return {
+        status: 500,
+        message: errMsg,
+        messageId: undefined
+    };
+};
+exports.sendMessage = sendMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmptool/utils",
-  "version": "1.0.27",
+  "version": "1.0.29",
   "description": "Helper/Utility functions for use in the DMP Tool services. Particularly AWS tooling and maDMP serialization",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -43,7 +43,7 @@
   "peerDependencies": {
     "@aws-sdk/client-cloudformation": "^3.966.0",
     "@aws-sdk/client-dynamodb": "^3.966.0",
-    "@aws-sdk/client-eventbridge": "^3.968.0",
+    "@aws-sdk/client-sqs": "^3.968.0",
     "@aws-sdk/client-s3": "^3.966.0",
     "@aws-sdk/client-sns": "^3.967.0",
     "@aws-sdk/client-ssm": "^3.966.0",

package/dist/eventBridge.d.ts

@@ -1,19 +0,0 @@
-import { Logger } from 'pino';
-export interface PutEventResponse {
-    status: number;
-    message: string;
-    eventId?: string;
-}
-/**
- * Publishes an event to EventBridge.
- *
- * @param logger The logger to use for logging.
- * @param busName The name of the EventBridge bus to publish the event to.
- * @param source The name of the caller (e.g. the Lambda Function or Application Function)
- * @param detailType The type of event (resources typically watch for specific types of events)
- * @param detail The payload of the event (will be accessible to the invoked resource)
- * @param region The region to publish the event in. Defaults to 'us-west-2'.
- * @returns A PutEventResponse object containing the status code and message of the response from EventBridge.
- * @throws Error if there was an error publishing the event.
- */
-export declare const putEvent: (logger: Logger, busName: string, source: string, detailType: string, details: Record<string, unknown>, region?: string) => Promise<PutEventResponse>;

package/dist/eventBridge.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.putEvent = void 0;
-const client_eventbridge_1 = require("@aws-sdk/client-eventbridge");
-const general_1 = require("./general");
-/**
- * Publishes an event to EventBridge.
- *
- * @param logger The logger to use for logging.
- * @param busName The name of the EventBridge bus to publish the event to.
- * @param source The name of the caller (e.g. the Lambda Function or Application Function)
- * @param detailType The type of event (resources typically watch for specific types of events)
- * @param detail The payload of the event (will be accessible to the invoked resource)
- * @param region The region to publish the event in. Defaults to 'us-west-2'.
- * @returns A PutEventResponse object containing the status code and message of the response from EventBridge.
- * @throws Error if there was an error publishing the event.
- */
-const putEvent = async (logger, busName, source, detailType, details, region = 'us-west-2') => {
-    var _a, _b, _c, _d;
-    let errMsg = '';
-    if (logger && busName) {
-        // Create a new EventBridge client instance
-        const client = new client_eventbridge_1.EventBridgeClient({ region });
-        logger.debug({ busName, source, detailType, details }, 'Publishing event');
-        try {
-            // Publish the event
-            const response = await client.send(new client_eventbridge_1.PutEventsCommand({
-                Entries: [
-                    {
-                        EventBusName: busName,
-                        Detail: details ? JSON.stringify(details) : undefined,
-                        DetailType: detailType,
-                        Source: source,
-                    },
-                ],
-            }));
-            if (response) {
-                const statusCode = (_b = (_a = response.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode) !== null && _b !== void 0 ? _b : 500;
-                // We got a response, so return it.
-                return {
-                    status: statusCode,
-                    message: statusCode >= 200 && statusCode <= 300 ? "Ok" : "Failure",
-                    eventId: (_d = (_c = response.Entries) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.EventId
-                };
-            }
-            else {
-                logger.error({ busName, source, detailType, details }, 'No response from EventBridge');
-                errMsg = 'No response from EventBridge';
-            }
-        }
-        catch (error) {
-            logger.fatal({ busName, source, detailType, details, error }, 'Error publishing event');
-            errMsg = `Error publishing event: ${(0, general_1.toErrorMessage)(error)}`;
-        }
-    }
-    else {
-        errMsg = 'Missing logger or busName args!';
-    }
-    // The busName was not available or the response was undefined
-    return {
-        status: 500,
-        message: errMsg,
-        eventId: undefined
-    };
-};
-exports.putEvent = putEvent;