@dmptool/utils 1.0.28 → 1.0.30

package/README.md

@@ -15,7 +15,7 @@ See below for usage examples of each utility.
 - [AWS CloudFormation Stack Output Access](#cloudformation-support)
 - [AWS DynamoDB Table Access](#dynamodb-support)
 - [General Helper Functions](#general-helper-functions)
-- [EventBridge Event Publication](#eventbridge-support)
+- [SQS Message Publication](#sqs-support)
 - [Logger Support (Pino with ECS formatting)](#logger-support-pino-with-ecs-formatting)
 - [maDMP Support (serialization and deserialization)](#madmp-support-serialization-and-deserialization)
 - [AWS RDS MySQL Database Access](#rds-mysql-support)
@@ -209,40 +209,40 @@ if (exists) {
   }
 }
 ```
-## EventBridge Support
+## SQS Support
 
-This code can be used to publish events to the EventBridge.
+This code can be used to send messages to an SQS Queue.
 
 ### Example usage
 ```typescript
-import { initializeLogger, LogLevelEnum, publishMessage } from '@dmptool/utils';
+import { initializeLogger, sendMessage, SendMessageResponse } from '@dmptool/utils';
 
 const region = 'us-west-2';
 
 // Initialize a logger
 const logger: Logger = initializeLogger('exampleSSM', LogLevelEnum.DEBUG);
 
-const busName = 'arn:aws:sns:us-east-1:123456789012:my-topic';
+const queueURL = 'https://sqs.us-west-2.amazonaws.com/12345/my-example-function';
 
 // See the documentation for the AWS Lambda you are trying to invoke to determine what the
 // `detail-type` and `detail` payload should look like.
-const source = 'my-application';
-const detailType = 'my-event';  
+const source = 'my-application'; 
+const detailType = 'my-message';  
 const detail = { property1: 'value1', property2: 'value2' }
 
-const response = await publishMessage(
+const sent: SendMessageResponse = await sendMessage(
   logger,
-  busName,
+  queueURL,
   source,
   detailType,
   detail,
-  region
+  region,
 );
 
-if (response.statusCode === 200) {
-  console.log('Message published successfully', response.body);
+if (sent && sent.status >= 200 && sent.status < 300) {
+  console.log('Message successfully sent', sent.status);
 } else {
-  console.log('Error publishing message', response.body);
+  console.log('Error sending message', sent.status, sent.messageId);
 }
 ```
 
@@ -304,6 +304,7 @@ Environment variable requirements:
 ### Example usage
 ```typescript
 import { Logger } from 'pino';
+import { Context, SQSEvent, SQSHandler, SQSBatchResponse } from 'aws-lambda';
 import { initializeLogger, LogLevel } from '@dmptool/utils';
 
 process.env.AWS_REGION = 'us-west-2';
@@ -316,14 +317,20 @@ const logger: Logger = initializeLogger('GenerateMaDMPRecordLambda', LogLevel[LO
 // Setup the LambdaRequestTracker for the logger
 const withRequest = lambdaRequestTracker();
 
-export const handler: Handler = async (event: EventBridgeEvent<string, EventBridgeDetails>, context: Context) => {
+export const handler: SQSHandler = async (event: SQSEvent, context: Context): Promise<SQSBatchResponse> => {
   // Log the incoming event and context
   logger.debug({ event, context }, 'Received event');
   
   // Initialize the logger by setting up automatic request tracing.
   withRequest(event, context);
 
-  logger.info({ log_level: LOG_LEVEL, foo: "bar" }, 'Hello World!');
+  // Loop through the records in the event
+  for (const record of event.Records) {
+    logger.info({
+      log_level: LOG_LEVEL,
+      record_body: record.body
+    }, 'Processing record');
+  }
 }
 ```
 

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/maDMP.js

@@ -382,34 +382,43 @@ 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);
-        }
-        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
+        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;
+                if (hasAnswer) {
+                    // parse the nested answer value which is stored as a JSON string
+                    const answerVal = hasAnswer ? JSON.parse(row.answerJSON.answer) : undefined;
+                    row.answerJSON.answer = answerVal;
                 }
-                : undefined
-        });
+                // 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 +534,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 +542,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 +579,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 +594,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 +617,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 +673,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmptool/utils",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "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",