@dmptool/utils 1.0.29 → 1.0.31

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/maDMP.d.ts

@@ -45,6 +45,7 @@ export declare const validateDMPToolExtensions: (logger: Logger, dmpId: string,
  * @param domainName the domain name of the application/service website
  * @param planId the ID of the plan to generate the DMP for
  * @param env The environment from EnvironmentEnum (defaults to EnvironmentEnum.DEV)
+ * @param includeExtensions whether to include the DMP Tool extensions. Defaults to true.
  * @returns a JSON representation of the DMP
  */
-export declare function planToDMPCommonStandard(rdsConnectionParams: ConnectionParams, applicationName: string, domainName: string, env: EnvironmentEnum | undefined, planId: number): Promise<DMPToolDMPType | undefined>;
+export declare function planToDMPCommonStandard(rdsConnectionParams: ConnectionParams, applicationName: string, domainName: string, env: EnvironmentEnum | undefined, planId: number, includeExtensions: true): Promise<DMPToolDMPType | undefined>;

package/dist/maDMP.js

@@ -400,6 +400,11 @@ const loadNarrativeTemplateInfo = async (rdsConnectionParams, planId) => {
             }
             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;
+                }
                 // Every row in the results represents a single question/answer pair
                 curSection.question.push({
                     id: row.questionId,
@@ -930,9 +935,10 @@ const cleanRDACommonStandard = (plan, dmp) => {
  * @param domainName the domain name of the application/service website
  * @param planId the ID of the plan to generate the DMP for
  * @param env The environment from EnvironmentEnum (defaults to EnvironmentEnum.DEV)
+ * @param includeExtensions whether to include the DMP Tool extensions. Defaults to true.
  * @returns a JSON representation of the DMP
  */
-async function planToDMPCommonStandard(rdsConnectionParams, applicationName, domainName, env = general_1.EnvironmentEnum.DEV, planId) {
+async function planToDMPCommonStandard(rdsConnectionParams, applicationName, domainName, env = general_1.EnvironmentEnum.DEV, planId, includeExtensions) {
     if (!rdsConnectionParams || !applicationName || !domainName || !planId) {
         throw new Error('Invalid arguments provided to planToDMPCommonStandard');
     }
@@ -1025,10 +1031,14 @@ async function planToDMPCommonStandard(rdsConnectionParams, applicationName, dom
     }
     const cleaned = cleanRDACommonStandard(plan, dmp);
     // Generate the DMP Tool extensions to the RDA Common Standard
-    const extensions = await buildDMPToolExtensions(rdsConnectionParams, applicationName, domainName, plan, project, funding);
+    const extensions = includeExtensions
+        ? await buildDMPToolExtensions(rdsConnectionParams, applicationName, domainName, plan, project, funding)
+        : undefined;
     rdsConnectionParams.logger.debug({ applicationName, domainName, planId, env, dmpId: plan.dmpId }, 'Generated maDMP metadata record');
     // Return the combined DMP metadata record
-    return {
-        dmp: Object.assign(Object.assign({}, (0, exports.validateRDACommonStandard)(rdsConnectionParams.logger, cleaned).dmp), (0, exports.validateDMPToolExtensions)(rdsConnectionParams.logger, plan.dmpId, extensions))
-    };
+    return includeExtensions && extensions
+        ? {
+            dmp: Object.assign(Object.assign({}, (0, exports.validateRDACommonStandard)(rdsConnectionParams.logger, cleaned).dmp), (0, exports.validateDMPToolExtensions)(rdsConnectionParams.logger, plan.dmpId, extensions))
+        }
+        : (0, exports.validateRDACommonStandard)(rdsConnectionParams.logger, cleaned);
 }

package/package.json

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