@dmptool/utils 1.0.32 → 1.0.34

package/dist/dynamo.d.ts

@@ -8,9 +8,8 @@ export interface DynamoConnectionParams {
     tableName: string;
     maxAttempts: number;
 }
-interface DMPVersionType {
-    PK: string;
-    SK: string;
+export interface DMPVersionType {
+    dmpId: string;
     modified: string;
 }
 /**
@@ -133,4 +132,3 @@ export declare const tombstoneDMP: (dynamoConnectionParams: DynamoConnectionPara
  * @throws DMPToolDynamoError if the record could not be deleted
  */
 export declare const deleteDMP: (dynamoConnectionParams: DynamoConnectionParams, domainName: string, dmpId: string, includeExtensions?: boolean) => Promise<DMPToolDMPType>;
-export {};

package/dist/dynamo.js

@@ -156,13 +156,14 @@ const getDMPVersions = async (dynamoConnectionParams, dmpId) => {
                 const unmarshalled = (0, util_dynamodb_1.unmarshall)(item);
                 if (unmarshalled.PK && unmarshalled.SK && unmarshalled.modified) {
                     versions.push({
-                        PK: unmarshalled.PK,
-                        SK: unmarshalled.SK,
+                        dmpId: unmarshalled.PK.replace(`${DMP_PK_PREFIX}#`, 'https://'),
                         modified: unmarshalled.modified
                     });
                 }
             }
-            return versions;
+            return versions.sort((a, b) => {
+                return b.modified.localeCompare(a.modified);
+            });
         }
         return [];
     }
@@ -310,10 +311,9 @@ const getDMPExtensions = async (dynamoConnectionParams, domainName, dmpId, versi
             if (Array.isArray(versions) && versions.length > 0) {
                 // Return the versions sorted descending
                 extension.version = versions
-                    .sort((a, b) => b.modified.localeCompare(a.modified))
-                    .map((v) => {
+                    .map((v, idx) => {
                     // The latest version doesn't have a query param appended to the URL
-                    const queryParam = v.SK.endsWith(exports.DMP_LATEST_VERSION)
+                    const queryParam = idx === 0
                         ? ''
                         : `?version=${v.modified}`;
                     const dmpIdWithoutProtocol = dmpId.replace(/^https?:\/\//, '');

package/dist/general.d.ts

@@ -61,6 +61,13 @@ export declare const isNullOrUndefined: (val: unknown) => boolean;
  * @returns The object with null and undefined values removed.
  */
 export declare const removeNullAndUndefinedFromObject: (obj: any) => any;
+/**
+ * Function to check if a string is a valid JSON string.
+ *
+ * @param str The string to check.
+ * @returns True if the string is a valid JSON string, false otherwise.
+ */
+export declare const isJSON: (str: string) => boolean;
 /**
  * Function to test for equality between two objects, arrays or primitives
  *

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.isValidDate = exports.normaliseHttpProtocol = exports.toErrorMessage = exports.EnvironmentEnum = void 0;
+exports.areEqual = exports.isJSON = 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.
  */
@@ -122,6 +122,22 @@ const removeNullAndUndefinedFromObject = (obj) => {
     return obj;
 };
 exports.removeNullAndUndefinedFromObject = removeNullAndUndefinedFromObject;
+/**
+ * Function to check if a string is a valid JSON string.
+ *
+ * @param str The string to check.
+ * @returns True if the string is a valid JSON string, false otherwise.
+ */
+const isJSON = (str) => {
+    try {
+        JSON.parse(str);
+    }
+    catch (e) {
+        return false;
+    }
+    return true;
+};
+exports.isJSON = isJSON;
 /**
  * Function to test for equality between two objects, arrays or primitives
  *

package/dist/maDMP.js

@@ -355,7 +355,8 @@ const loadNarrativeTemplateInfo = async (rdsConnectionParams, planId) => {
            t.version templateVersion,
            s.id sectionId, s.name sectionTitle, s.introduction sectionDescription,
            s.displayOrder sectionOrder, q.id questionId, q.questionText questionText,
-           q.displayOrder questionOrder, a.id answerId, a.json answerJSON
+           q.json questionJSON, q.displayOrder questionOrder,
+           a.id answerId, a.json answerJSON
     FROM plans p
       INNER JOIN versionedTemplates t ON p.versionedTemplateId = t.id
         LEFT JOIN versionedSections s ON s.versionedTemplateId = t.id
@@ -382,6 +383,7 @@ const loadNarrativeTemplateInfo = async (rdsConnectionParams, planId) => {
         section: [],
     };
     results.forEach((row) => {
+        var _a;
         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.
@@ -399,18 +401,14 @@ const loadNarrativeTemplateInfo = async (rdsConnectionParams, planId) => {
                 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;
-                }
+                const questionType = ((_a = row.questionJSON) === null || _a === void 0 ? void 0 : _a.type) || 'textArea';
+                const defaultAnswer = types_1.AnswerDefaultMap[questionType] || types_1.DefaultTextAreaAnswer;
                 // 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
+                    answer: row.answerJSON !== null && row.answerJSON !== undefined
                         ? {
                             id: row.answerId,
                             json: row.answerJSON
@@ -888,6 +886,7 @@ const validateDMPToolExtensions = (logger, dmpId, dmp) => {
         const msg = `Invalid DMP Tool extensions: ${validationErrors.join('; ')}`;
         logger.warn({ dmpId }, msg);
         logger.warn({ dmp }, 'Full DMP Tool extensions');
+        console.log(validationErrors);
         throw new DMPValidationError(msg);
     }
     return dmp;

package/dist/sqs.d.ts

@@ -13,7 +13,9 @@ export interface SendMessageResponse {
  * @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'.
+ * @param useTLS Whether to use TLS when sending the message. Defaults to true.
+ * Should be false when running in a local development environment.
  * @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>;
+export declare const sendMessage: (logger: Logger, queueURL: string, source: string, detailType: string, details: Record<string, unknown>, region?: string, useTLS?: boolean) => Promise<SendMessageResponse>;

package/dist/sqs.js

@@ -12,15 +12,23 @@ const general_1 = require("./general");
  * @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'.
+ * @param useTLS Whether to use TLS when sending the message. Defaults to true.
+ * Should be false when running in a local development environment.
  * @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') => {
+const sendMessage = async (logger, queueURL, source, detailType, details, region = 'us-west-2', useTLS = true // Should be false when running in a local dev environment
+) => {
     var _a, _b;
     let errMsg = '';
     if (logger && queueURL) {
         // Create a new SQS client instance
-        const client = new client_sqs_1.SQSClient({ region });
+        const client = new client_sqs_1.SQSClient({
+            region,
+            // These should be false when running in a local dev environment
+            useQueueUrlAsEndpoint: useTLS || true,
+            tls: useTLS || true,
+        });
         logger.debug({ queueURL, source, detailType, details }, 'Sending message');
         try {
             // Send the message

package/package.json

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