@dmptool/utils 1.0.4 → 1.0.6

package/dist/maDMP.js

@@ -9,9 +9,6 @@ const types_1 = require("@dmptool/types");
 const maDMPTypes_1 = require("./maDMPTypes");
 const ROR_REGEX = /^https?:\/\/ror\.org\/[0-9a-zA-Z]+$/;
 const DOI_REGEX = /^(https?:\/\/)?(doi\.org\/)?(doi:)?(10\.\d{4,9}\/[-._;()/:\w]+)$/;
-const ORCID_BASE_URL = process.env.ENV && ['stg', 'prd'].includes(process.env.ENV)
-    ? 'https://orcid.org/'
-    : 'https://sandbox.orcid.org/';
 const ORCID_REGEX = /^(https?:\/\/)?(www\.|pub\.)?(sandbox\.)?(orcid\.org\/)?([0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{3}[0-9X])$/;
 class DMPValidationError extends Error {
     constructor(message) {
@@ -25,14 +22,17 @@ class DMPValidationError extends Error {
  * @param orcidIn the ORCID to check
  * @returns the ORCID in the correct format or null if it is not in the correct format
  */
-function formatORCID(orcidIn) {
+function formatORCID(env, orcidIn) {
     // If it is blank or already in the correct format, return it
     if (orcidIn && (orcidIn.match(ORCID_REGEX) && orcidIn.startsWith('http'))) {
         return (0, general_1.normaliseHttpProtocol)(orcidIn);
     }
+    const baseURL = env && ['stg', 'prd'].includes(env)
+        ? 'https://orcid.org/'
+        : 'https://sandbox.orcid.org/';
     // If it matches the ORCID format but didn't start with http then its just the id
     if (orcidIn && orcidIn.match(ORCID_REGEX)) {
-        return (0, general_1.normaliseHttpProtocol)(`${ORCID_BASE_URL}${orcidIn.split('/').pop()}`);
+        return (0, general_1.normaliseHttpProtocol)(`${baseURL}${orcidIn.split('/').pop()}`);
     }
     // Otherwise it's not an ORCID
     return null;
@@ -97,21 +97,24 @@ function convertFiveCharToThreeChar(language) {
 /**
  * Function to generate the base of an internal ID namespace
  *
+ * @param applicationName the name of the application/service
  * @param projectId the Project ID to use for the internal ID namespace
  * @param planId the Plan ID to use for the internal ID namespace
  * @returns the base of the internal ID namespace
  */
-function internalIdBase(projectId, planId) {
-    return `${process.env.APPLICATION_NAME}.projects.${projectId}.dmp.${planId}`;
+function internalIdBase(applicationName, projectId, planId) {
+    return `${applicationName}.projects.${projectId}.dmp.${planId}`;
 }
 /**
  * Fetch the default MemberRole from the MySQL database
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
  * @returns the default MemberRole as a string (or undefined if there is no default)
  */
-const loadDefaultMemberRole = async () => {
+const loadDefaultMemberRole = async (rdsConnectionParams) => {
     const sql = 'SELECT * FROM memberRoles WHERE isDefault = 1';
-    const resp = await (0, rds_1.queryTable)(sql, []);
+    rdsConnectionParams.logger.debug({ sql }, 'Fetching default role');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, []);
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
         return resp.results[0].id;
     }
@@ -121,11 +124,12 @@ const loadDefaultMemberRole = async () => {
  * Fetches the Plan information needed to construct the DMP Common Standard from
  * the MySQL database
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
  * @param planId the Plan ID to fetch the Plan information for
  * @returns the Plan information needed to construct the DMP Common Standard
  */
 // Fetch the Plan info needed from the MySQL database
-const loadPlanInfo = async (planId) => {
+const loadPlanInfo = async (rdsConnectionParams, planId) => {
     const sql = `
     SELECT id, dmpId, projectId, versionedTemplateId,
            createdById, created, modifiedById, modified, title,
@@ -134,7 +138,8 @@ const loadPlanInfo = async (planId) => {
     FROM plans
     WHERE id = ?
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [planId.toString()]);
+    rdsConnectionParams.logger.debug({ planId, sql }, 'Fetching plan information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [planId.toString()]);
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
         return resp.results[0];
     }
@@ -144,16 +149,18 @@ const loadPlanInfo = async (planId) => {
  * Fetches the Project information needed to construct the DMP Common Standard
  * from the MySQL database
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
  * @param projectId the Project ID to fetch the Project information for
  * @returns the Project information needed to construct the DMP Common Standard
  */
-const loadProjectInfo = async (projectId) => {
+const loadProjectInfo = async (rdsConnectionParams, projectId) => {
     const sql = `
     SELECT id, title, abstractText, startDate, endDate
     FROM projects
     WHERE id = ?
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [projectId.toString()]);
+    rdsConnectionParams.logger.debug({ projectId, sql }, 'Fetching project information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [projectId.toString()]);
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
         return resp.results[0];
     }
@@ -163,10 +170,11 @@ const loadProjectInfo = async (projectId) => {
  * Fetches the PlanFunding information needed to construct the DMP Common Standard
  * from the MySQL database
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
  * @param planId the Plan ID to fetch the PlanFunding information for
  * @returns the Funding information needed to construct the DMP Common Standard
  */
-const loadFundingInfo = async (planId) => {
+const loadFundingInfo = async (rdsConnectionParams, planId) => {
     const sql = `
     SELECT pf.id, a.uri, a.name, prf.status, prf.grantId,
            prf.funderProjectNumber, prf.funderOpportunityNumber
@@ -175,7 +183,8 @@ const loadFundingInfo = async (planId) => {
       LEFT JOIN affiliations a ON prf.affiliationId = a.uri
     WHERE pf.planId = ?
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [planId.toString()]);
+    rdsConnectionParams.logger.debug({ planId, sql }, 'Fetching plan funding information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [planId.toString()]);
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
         const fundings = resp.results.filter((row) => !(0, general_1.isNullOrUndefined)(row));
         fundings.forEach((funding) => funding.status = planFundingStatusToDMPFundingStatus(funding.status));
@@ -187,10 +196,11 @@ const loadFundingInfo = async (planId) => {
  * Fetches the Plan's owner information needed to construct the DMP Common Standard
  * from the MySQL database
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
  * @param ownerId the user id for the plan's owner
  * @returns the contact information needed to construct the DMP Common Standard
  */
-async function loadContactFromPlanOwner(ownerId) {
+async function loadContactFromPlanOwner(rdsConnectionParams, ownerId) {
     const sql = `
     SELECT u.id, u.givenName, u.surName, u.orcid, a.uri, a.name,
            (SELECT ue.email
@@ -200,7 +210,8 @@ async function loadContactFromPlanOwner(ownerId) {
       LEFT JOIN affiliations a ON u.affiliationId = a.id
     WHERE u.id = ?
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [ownerId.toString()]);
+    rdsConnectionParams.logger.debug({ ownerId, sql }, 'Fetching plan owner information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [ownerId.toString()]);
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
         return resp.results.filter((row) => !(0, general_1.isNullOrUndefined)(row))[0];
     }
@@ -210,10 +221,11 @@ async function loadContactFromPlanOwner(ownerId) {
  * Fetches the PlanMember information needed to construct the DMP Common Standard
  * from the MySQL database
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
  * @param planId the Plan ID to fetch the PlanMember information for
  * @returns the contributor information needed to construct the DMP Common Standard
  */
-const loadMemberInfo = async (planId) => {
+const loadMemberInfo = async (rdsConnectionParams, planId) => {
     const sql = `
     SELECT pc.id, a.uri, a.name, pctr.email, pctr.givenName, pctr.surName,
            pctr.orcid, pc.isPrimaryContact, GROUP_CONCAT(r.uri) as roles
@@ -226,7 +238,8 @@ const loadMemberInfo = async (planId) => {
     GROUP BY a.uri, a.name, pctr.email, pctr.givenName, pctr.surName,
       pctr.orcid, pc.isPrimaryContact;
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [planId.toString()]);
+    rdsConnectionParams.logger.debug({ planId, sql }, 'Fetching plan member information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [planId.toString()]);
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
         return resp.results.filter((row) => !(0, general_1.isNullOrUndefined)(row));
     }
@@ -236,14 +249,15 @@ const loadMemberInfo = async (planId) => {
  * Returns a default RDA Common Standard Dataset entry for the DMP.
  * This is used when the Plan has no Answers to a Research Outputs question.
  *
+ * @param applicationName the name of the application/service
  * @param projectId the Project ID to use for the Dataset entry
  * @param planId the Plan ID to use for the Dataset entry
  * @returns a generic default Dataset entry
  */
-const defaultDataset = (projectId, planId) => {
+const defaultDataset = (applicationName, projectId, planId) => {
     return {
         dataset_id: {
-            identifier: `${internalIdBase(projectId, planId)}.outputs.1`,
+            identifier: `${internalIdBase(applicationName, projectId, planId)}.outputs.1`,
             type: 'other'
         },
         personal_data: 'unknown',
@@ -257,12 +271,14 @@ const defaultDataset = (projectId, planId) => {
  * from the MySQL database this information is extracted from the Answers table
  * for Research Output Questions
  *
+ * @param rdssConnectionParams the connection parameters for the MySQL database
+ * @param applicationName the name of the application/service
  * @param projectId the Project ID to fetch the Dataset information for
  * @param planId the Plan ID to fetch the Dataset information for
  * @param language the language to use for the Dataset information
  * @returns the dataset information needed to construct the DMP Common Standard
  */
-const loadDatasetInfo = async (projectId, planId, language = 'eng') => {
+const loadDatasetInfo = async (rdsConnectionParams, applicationName, projectId, planId, language = 'eng') => {
     const datasets = [];
     const sql = `
     SELECT a.json
@@ -270,7 +286,8 @@ const loadDatasetInfo = async (projectId, planId, language = 'eng') => {
     WHERE a.planId = ?
       AND a.json LIKE '%"researchOutputsTable"%';
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [planId.toString()]);
+    rdsConnectionParams.logger.debug({ projectId, planId, sql }, 'Fetching research output information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [planId.toString()]);
     // There would typically only be one research outputs question per plan but
     // we need to allow for multiples just in case.
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
@@ -281,22 +298,24 @@ const loadDatasetInfo = async (projectId, planId, language = 'eng') => {
             // Loop through the rows and construct the RDA Common Standard Dataset object
             for (let idx = 0; idx < json.answer.length; idx++) {
                 const row = json.answer[idx];
-                datasets.push(buildDataset(idx, row, projectId, planId, lang));
+                datasets.push(buildDataset(applicationName, idx, row, projectId, planId, lang));
             }
         }
     }
     else {
-        return [defaultDataset(projectId, planId)];
+        rdsConnectionParams.logger.debug({ projectId, planId }, 'Using the default dataset');
+        return [defaultDataset(applicationName, projectId, planId)];
     }
     return datasets;
 };
 /**
  * Builds the RDA Common Standard Related Identifier entries for the DMP
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
  * @param projectId the Project ID to fetch the Related Works information for
  * @returns the RDA Common Standard Related Identifier entries for the DMP
  */
-const loadRelatedWorksInfo = async (projectId) => {
+const loadRelatedWorksInfo = async (rdsConnectionParams, projectId) => {
     const sql = `
     SELECT w.doi AS identifier, LOWER(wv.workType) AS workType,
     FROM relatedWorks rw
@@ -304,7 +323,8 @@ const loadRelatedWorksInfo = async (projectId) => {
         JOIN works w ON wv.workId = w.id
     WHERE rw.projectId = ?;
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [projectId.toString()]);
+    rdsConnectionParams.logger.debug({ projectId, sql }, 'Fetching related works information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [projectId.toString()]);
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
         const works = resp.results.filter((row) => !(0, general_1.isNullOrUndefined)(row));
         // Determine the identifier types
@@ -323,10 +343,11 @@ const loadRelatedWorksInfo = async (projectId) => {
 /**
  * Builds the DMP Tool Narrative extension for the DMP
  *
+ * @param rdssConnectionParams the connection parameters for the MySQL database
  * @param planId the Plan ID to fetch the narrative information for
  * @returns the DMP Tool Narrative extension for the DMP
  */
-const loadNarrativeTemplateInfo = async (planId) => {
+const loadNarrativeTemplateInfo = async (rdsConnectionParams, planId) => {
     // Fetch the template, sections, questions and answers all at once
     const sql = `
     SELECT t.id templateId, t.name templateTitle, t.description templateDescription,
@@ -342,7 +363,8 @@ const loadNarrativeTemplateInfo = async (planId) => {
     WHERE p.id = ?
     ORDER BY s.displayOrder, q.displayOrder;
   `;
-    const resp = await (0, rds_1.queryTable)(sql, [planId.toString()]);
+    rdsConnectionParams.logger.debug({ planId, sql }, 'Fetching narrative information');
+    const resp = await (0, rds_1.queryTable)(rdsConnectionParams, sql, [planId.toString()]);
     let results = [];
     // Filter out any null or undefined results
     if (resp && Array.isArray(resp.results) && resp.results.length > 0) {
@@ -388,12 +410,13 @@ const loadNarrativeTemplateInfo = async (planId) => {
 /**
  * Builds the RDA Common Standard Contact entry for the DMP
  *
+ * @param rdssConnectionParams the connection parameters for the MySQL database
  * @param plan the Plan information retrieve from the MySQL database
  * @param members the PlanMembers information retrieve from the MySQL database
  * @returns the RDA Common Standard Contact entry for the DMP
  * @throws DMPValidationError if no primary contact is found for the DMP
  */
-const buildContact = async (plan, members) => {
+const buildContact = async (rdsConnectionParams, env, plan, members) => {
     // Extract the primary contact from the members
     const memberContact = members.find((c) => {
         return c === null || c === void 0 ? void 0 : c.isPrimaryContact;
@@ -401,9 +424,9 @@ const buildContact = async (plan, members) => {
     // If no primary contact is available, use the plan owner
     const primary = memberContact && memberContact.email
         ? memberContact
-        : await loadContactFromPlanOwner(Number(plan.createdById));
+        : await loadContactFromPlanOwner(rdsConnectionParams, Number(plan.createdById));
     if (primary && primary.email) {
-        const orcid = primary.orcid ? formatORCID(primary.orcid) : null;
+        const orcid = primary.orcid ? formatORCID(env, primary.orcid) : null;
         // Build the contact entry for the DMP
         const contactEntry = {
             contact_id: [{
@@ -436,13 +459,14 @@ const buildContact = async (plan, members) => {
 /**
  * Builds the RDA Common Standard Contributor array for the DMP from the PlanMembers
  *
+ * @param applicationName the name of the application/service
  * @param planId the Plan ID
  * @param projectId the Project ID
  * @param members the PlanMembers information retrieve from the MySQL database
  * @param defaultRole the default role to use if the member doesn't have a role'
  * @returns the RDA Common Standard Contributor array for the DMP
  */
-const buildContributors = (planId, projectId, members, defaultRole) => {
+const buildContributors = (applicationName, env, planId, projectId, members, defaultRole) => {
     if (!Array.isArray(members) || members.length <= 0) {
         return [];
     }
@@ -458,7 +482,7 @@ const buildContributors = (planId, projectId, members, defaultRole) => {
             role: roles,
         };
         // Use the member's ORCID if it exists, otherwise generate a new one'
-        const formatted = member.orcid ? formatORCID(member.orcid) : null;
+        const formatted = member.orcid ? formatORCID(env, member.orcid) : null;
         if (formatted !== null) {
             contrib.contributor_id = [{
                     identifier: formatted,
@@ -468,7 +492,7 @@ const buildContributors = (planId, projectId, members, defaultRole) => {
         else {
             // RDA Common Standard requires an id so generate one
             contrib.contributor_id = [{
-                    identifier: `${internalIdBase(projectId, planId)}.members.${member.id}`,
+                    identifier: `${internalIdBase(applicationName, projectId, planId)}.members.${member.id}`,
                     type: 'other'
                 }];
         }
@@ -488,25 +512,28 @@ const buildContributors = (planId, projectId, members, defaultRole) => {
 /**
  * Builds the DMP Tool extensions to the RDA Common Standard
  *
+ * @param rdsConnectionParams the connection parameters for the MySQL database
+ * @param applicationName the name of the application/service
+ * @param domainName the domain name of the DMP Tool
  * @param plan the Plan information retrieve from the MySQL database
  * @param project the Project information retrieve from the MySQL database
  * @param funding the Funding information retrieve from the MySQL database
  * @returns the DMP metadata with extensions from the DMP Tool
  */
-const buildDMPToolExtensions = async (plan, project, funding) => {
+const buildDMPToolExtensions = async (rdsConnectionParams, applicationName, domainName, plan, project, funding) => {
     var _a, _b, _c, _d, _e, _f;
     const extensions = {
         rda_schema_version: types_1.RDA_COMMON_STANDARD_VERSION,
         // Ignoring the `!` assertion here because we know we check the env variable
         // when the entrypoint function is called.
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        provenance: process.env.APPLICATION_NAME,
+        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',
     };
     // Generate the DMP Narrative
-    const narrative = await loadNarrativeTemplateInfo(plan.id);
+    const narrative = await loadNarrativeTemplateInfo(rdsConnectionParams, plan.id);
     // Fetch the research domain if one was specified
     const research_domain = project.dmptool_research_domain
         ? { name: project.dmptool_research_domain }
@@ -515,12 +542,12 @@ const buildDMPToolExtensions = async (plan, project, funding) => {
     let funderOpportunity = undefined;
     if (funding) {
         const projectId = {
-            identifier: internalIdBase(project.id, plan.id),
+            identifier: internalIdBase(applicationName, project.id, plan.id),
             type: maDMPTypes_1.StandardIdentifierType.OTHER
         };
         const funderId = funding.uri === undefined
             ? {
-                identifier: `${internalIdBase(project.id, plan.id)}.fundings.${funding.id}`,
+                identifier: `${internalIdBase(applicationName, project.id, plan.id)}.fundings.${funding.id}`,
                 type: maDMPTypes_1.StandardIdentifierType.OTHER
             }
             : {
@@ -577,7 +604,7 @@ const buildDMPToolExtensions = async (plan, project, funding) => {
     }
     if (!(0, general_1.isNullOrUndefined)(narrative)) {
         extensions.narrative = {
-            download_url: `https://${process.env.DOMAIN_NAME}/dmps/${plan.dmpId}/narrative`,
+            download_url: `https://${domainName}/dmps/${plan.dmpId}/narrative`,
             template: narrative
         };
     }
@@ -586,12 +613,13 @@ const buildDMPToolExtensions = async (plan, project, funding) => {
 /**
  * Builds the Project and Funding info for the RDA Common Standard
  *
+ * @param applicationName the name of the application/service
  * @param planId the Plan ID
  * @param project the Project information retrieve from the MySQL database
  * @param funding the Funding information retrieve from the MySQL database
  * @returns the Project and Funding info for the RDA Common Standard
  */
-const buildProject = (planId, project, funding) => {
+const buildProject = (applicationName, planId, project, funding) => {
     var _a, _b, _c, _d, _e;
     if ((0, general_1.isNullOrUndefined)(project)) {
         return undefined;
@@ -611,7 +639,7 @@ const buildProject = (planId, project, funding) => {
                 type: ((_b = (funding).uri) === null || _b === void 0 ? void 0 : _b.match(ROR_REGEX)) ? 'ror' : 'url'
             }
             : {
-                identifier: `${internalIdBase(project.id, planId)}.fundings.${funding.id}`,
+                identifier: `${internalIdBase(applicationName, project.id, planId)}.fundings.${funding.id}`,
                 type: 'other'
             };
         // The RDA Common Standard requires the funder name and status to be present
@@ -633,7 +661,7 @@ const buildProject = (planId, project, funding) => {
         start: (_d = project.startDate) !== null && _d !== void 0 ? _d : undefined,
         end: (_e = project.endDate) !== null && _e !== void 0 ? _e : undefined,
         project_id: [{
-                identifier: internalIdBase(project.id, planId),
+                identifier: internalIdBase(applicationName, project.id, planId),
                 type: 'other'
             }],
         funding: fundingObject
@@ -677,6 +705,7 @@ const byteSizeToBytes = (size) => {
  * Convert a @dmptool/types researchOutputTable answer row into an RDA Common
  * Standard Dataset object.
  *
+ * @param applicationName the name of the application/service
  * @param rowIdx the index of the answer row
  * @param row the answer row
  * @param projectId the ID of the project that the dataset belongs to
@@ -684,7 +713,7 @@ const byteSizeToBytes = (size) => {
  * @param language the language of the dataset (defaults to 'eng')
  * @returns a RDA Common Standard Dataset object
  */
-const buildDataset = (rowIdx, row, projectId, planId, language = 'eng') => {
+const buildDataset = (applicationName, rowIdx, row, projectId, planId, language = 'eng') => {
     const title = findColumnById('title', row.columns);
     const desc = findColumnById('description', row.columns);
     const typ = findColumnById('type', row.columns);
@@ -761,7 +790,7 @@ const buildDataset = (rowIdx, row, projectId, planId, language = 'eng') => {
         type: (0, general_1.isNullOrUndefined)(typ) ? 'dataset' : typ.answer,
         description: (0, general_1.isNullOrUndefined)(desc) ? undefined : desc.answer,
         dataset_id: {
-            identifier: `${internalIdBase(projectId, planId)}.outputs.${rowIdx + 1}`,
+            identifier: `${internalIdBase(applicationName, projectId, planId)}.outputs.${rowIdx + 1}`,
             type: 'other'
         },
         personal_data: (0, general_1.isNullOrUndefined)(flags) ?
@@ -800,11 +829,13 @@ const buildDataset = (rowIdx, row, projectId, planId, language = 'eng') => {
  * Validate the specified DMP metadata record against the RDA Common Standard
  * and DMP Tool extensions schema
  *
+ * @param logger the logger to use for logging
  * @param dmp The DMP metadata record to validate
  * @returns the DMP metadata record if it is valid
  * @throws DMPValidationError if the record is invalid with the error message(s)
  */
-const validateRDACommonStandard = (dmp) => {
+const validateRDACommonStandard = (logger, dmp) => {
+    var _a, _b;
     const validationErrors = [];
     const validator = new jsonschema_1.Validator();
     // Validate against the RDA Common Standard schema
@@ -813,7 +844,9 @@ const validateRDACommonStandard = (dmp) => {
         validationErrors.push(...rdaResult.errors.map(e => `${e.path.join('.')} - ${e.message}`));
     }
     if (validationErrors.length > 0) {
-        throw new DMPValidationError(`Invalid RDA Common Standard: ${validationErrors.join('; ')}`);
+        const msg = `Invalid RDA Common Standard: ${validationErrors.join('; ')}`;
+        logger.warn({ dmpId: (_b = (_a = dmp === null || dmp === void 0 ? void 0 : dmp.dmp) === null || _a === void 0 ? void 0 : _a.dmp_id) === null || _b === void 0 ? void 0 : _b.identifier }, msg);
+        throw new DMPValidationError(msg);
     }
     return dmp;
 };
@@ -822,11 +855,12 @@ exports.validateRDACommonStandard = validateRDACommonStandard;
  * Validate the specified DMP metadata record against the RDA Common Standard
  * and DMP Tool extensions schema
  *
+ * @param logger the logger to use for logging
  * @param dmp The DMP metadata record to validate
  * @returns the DMP metadata record if it is valid
  * @throws DMPValidationError if the record is invalid with the error message(s)
  */
-const validateDMPToolExtensions = (dmp) => {
+const validateDMPToolExtensions = (logger, dmpId, dmp) => {
     var _a;
     const validationErrors = [];
     // Next validate against the DMP Tool extension schema
@@ -835,7 +869,9 @@ const validateDMPToolExtensions = (dmp) => {
         validationErrors.push(...extResult.error.issues.map(e => `${e.path.join('.')} - ${e.message}`));
     }
     if (validationErrors.length > 0) {
-        throw new DMPValidationError(`Invalid DMP Tool extensions: ${validationErrors.join('; ')}`);
+        const msg = `Invalid DMP Tool extensions: ${validationErrors.join('; ')}`;
+        logger.warn({ dmpId }, msg);
+        throw new DMPValidationError(msg);
     }
     return dmp;
 };
@@ -877,48 +913,51 @@ const cleanRDACommonStandard = (plan, dmp) => {
  *   - The `registered` indicates whether the DMP is published/registered with DataCite/EZID
  *   - The `tombstoned` indicates that it was published/registered but is now removed
  *
+ * @param rdsConnectionParams the connection parameters for the RDS instance
+ * @param applicationName the name of the application/service
+ * @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)
  * @returns a JSON representation of the DMP
  */
-async function planToDMPCommonStandard(planId) {
-    if ((0, general_1.isNullOrUndefined)(process.env.ENV)) {
-        throw new Error('ENV environment variable is not set');
-    }
-    if ((0, general_1.isNullOrUndefined)(process.env.DOMAIN_NAME)) {
-        throw new Error('DOMAIN_NAME environment variable is not set');
-    }
-    if ((0, general_1.isNullOrUndefined)(process.env.APPLICATION_NAME)) {
-        throw new Error('APPLICATION_NAME environment variable is not set');
+async function planToDMPCommonStandard(rdsConnectionParams, applicationName, domainName, env = general_1.EnvironmentEnum.DEV, planId) {
+    if (!rdsConnectionParams || !applicationName || !domainName || !planId) {
+        throw new Error('Invalid arguments provided to planToDMPCommonStandard');
     }
     // Fetch the Plan data
-    const plan = await loadPlanInfo(planId);
+    const plan = await loadPlanInfo(rdsConnectionParams, planId);
     if (plan === undefined) {
+        rdsConnectionParams.logger.error({ planId, applicationName, env }, 'Plan not found');
         throw new DMPValidationError(`Plan not found: ${planId}`);
     }
     if ((0, general_1.isNullOrUndefined)(plan.title)) {
+        rdsConnectionParams.logger.error({ planId, applicationName, env }, 'Plan title not found');
         throw new DMPValidationError(`Plan title not found for plan: ${planId}`);
     }
     if ((0, general_1.isNullOrUndefined)(plan.dmpId)) {
+        rdsConnectionParams.logger.error({ planId, applicationName, env }, 'Plan dmpId not found');
         throw new DMPValidationError(`DMP ID not found for plan: ${planId}`);
     }
     // Get the Project data
-    const project = await loadProjectInfo(plan.projectId);
+    const project = await loadProjectInfo(rdsConnectionParams, plan.projectId);
     if (project === undefined || !project.title) {
+        rdsConnectionParams.logger.error({ planId, applicationName, env }, 'Project not found');
         throw new DMPValidationError(`Project not found: ${plan.projectId}`);
     }
     // Get all the plan members and determine the primary contact
-    const members = plan.id ? await loadMemberInfo(plan.id) : [];
-    const contact = await buildContact(plan, members);
+    const members = plan.id ? await loadMemberInfo(rdsConnectionParams, plan.id) : [];
+    const contact = await buildContact(rdsConnectionParams, env, plan, members);
     if (!contact) {
+        rdsConnectionParams.logger.error({ planId, applicationName, env }, 'Could not build primary contact');
         throw new DMPValidationError(`Could not establish a primary contact for plan: ${planId}`);
     }
     // Get all the funding and narrative info
-    const datasets = await loadDatasetInfo(project.id, plan.id, plan.languageId);
+    const datasets = await loadDatasetInfo(rdsConnectionParams, applicationName, project.id, plan.id, plan.languageId);
     // We only allow one funding per plan at this time
-    const fundings = await loadFundingInfo(plan.id);
+    const fundings = await loadFundingInfo(rdsConnectionParams, plan.id);
     const funding = fundings.length > 0 ? fundings[0] : undefined;
-    const works = await loadRelatedWorksInfo(plan.projectId);
-    const defaultRole = await loadDefaultMemberRole();
+    const works = await loadRelatedWorksInfo(rdsConnectionParams, plan.projectId);
+    const defaultRole = await loadDefaultMemberRole(rdsConnectionParams);
     // If the plan is registered, use the DOI as the identifier, otherwise convert to a URL
     const dmpId = plan.registered
         ? {
@@ -926,7 +965,7 @@ async function planToDMPCommonStandard(planId) {
             type: 'doi'
         }
         : {
-            identifier: `https://${process.env.DOMAIN_NAME}/projects/${project.id}/dmp/${plan.id}`,
+            identifier: `https://${domainName}/projects/${project.id}/dmp/${plan.id}`,
             type: 'url'
         };
     // Examine the datasets to determine the status of ethical issues
@@ -958,8 +997,8 @@ async function planToDMPCommonStandard(planId) {
             dataset: datasets,
         },
     };
-    const dmpProject = buildProject(plan.id, project, funding);
-    const dmpContributor = buildContributors(plan.id, project.id, members, defaultRole !== null && defaultRole !== void 0 ? defaultRole : 'other');
+    const dmpProject = buildProject(applicationName, plan.id, project, funding);
+    const dmpContributor = buildContributors(applicationName, env, plan.id, project.id, members, defaultRole !== null && defaultRole !== void 0 ? defaultRole : 'other');
     // Add the contributor, project and related identifier properties if they have values
     if (!(0, general_1.isNullOrUndefined)(dmpProject)) {
         dmp.dmp.project = [(0, general_1.removeNullAndUndefinedFromObject)(dmpProject)];
@@ -974,9 +1013,10 @@ async function planToDMPCommonStandard(planId) {
     }
     const cleaned = cleanRDACommonStandard(plan, dmp);
     // Generate the DMP Tool extensions to the RDA Common Standard
-    const extensions = await buildDMPToolExtensions(plan, project, funding);
+    const extensions = await buildDMPToolExtensions(rdsConnectionParams, applicationName, domainName, plan, project, funding);
+    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)(cleaned).dmp), (0, exports.validateDMPToolExtensions)(extensions))
+        dmp: Object.assign(Object.assign({}, (0, exports.validateRDACommonStandard)(rdsConnectionParams.logger, cleaned).dmp), (0, exports.validateDMPToolExtensions)(rdsConnectionParams.logger, plan.dmpId, extensions))
     };
 }

package/dist/rds.d.ts

@@ -1,11 +1,21 @@
+import { Logger } from 'pino';
+export interface ConnectionParams {
+    logger: Logger;
+    host: string;
+    port: number;
+    user: string;
+    password: string;
+    database: string;
+}
 /**
  * Function to run a SQL query against the MySQL database.
  *
  * @param query the SQL query to run
+ * @param connectionParams the connection parameters to use for the connection
  * @param params the parameters to use in the query
  * @returns the results of the query
  */
-export declare const queryTable: (query: string, params?: any[]) => Promise<{
+export declare const queryTable: (connectionParams: ConnectionParams, query: string, params?: any[]) => Promise<{
     results: any[];
     fields: any[];
 }>;