@gov-cy/govcy-express-services 0.2.16 → 1.0.0-alpha.10

package/src/utils/govcyLoadSubmissionDataAPIs.mjs

@@ -0,0 +1,142 @@
+import { govcyApiRequest } from "./govcyApiRequest.mjs";
+import { logger } from "./govcyLogger.mjs";
+import { getEnvVariable, getEnvVariableBool } from "./govcyEnvVariables.mjs";
+import { handleMiddlewareError } from "./govcyUtils.mjs";
+import * as dataLayer from "./govcyDataLayer.mjs";
+
+/**
+ * Load submission data from configured APIs and store it in the session.
+ * @param {object} store The session store
+ * @param {object} service The service configuration
+ * @param {string} siteId The site id
+ * @param {function} next The next middleware function
+ */
+export async function govcyLoadSubmissionDataAPIs(store, service, siteId, next) {
+    try {
+
+        // Get the API endpoints 
+        const getCfg = service?.site?.submissionGetAPIEndpoint;
+        const putCfg = service?.site?.submissionPutAPIEndpoint;
+
+        //If siteLoadData already exists, skip the API call
+        const siteLoadData = dataLayer.getSiteLoadData(store, siteId);
+        if (siteLoadData && Object.keys(siteLoadData).length > 0) {
+            // Data exists, skip API call
+            logger.debug("Load data already exists for site:", siteId);
+            return next();
+        }
+        
+        // Only continue if both endpoints and required fields are defined
+        if (
+            getCfg && putCfg &&
+            getCfg.clientKey && getCfg.serviceId &&
+            putCfg.clientKey && putCfg.serviceId 
+        ){
+            const user = dataLayer.getUser(store); // Get the user from the session;
+
+            // get the API endpoint URL, clientKey, serviceId from the environment variable (handle edge cases)
+            const getCfgUrl = getEnvVariable(getCfg?.url || "", false);
+            const getCfgClientKey = getEnvVariable(getCfg?.clientKey || "", false);
+            const getCfgServiceId = getEnvVariable(getCfg?.serviceId || "", false);
+            const getCfgDsfGtwApiKey = getEnvVariable(getCfg?.dsfgtwApiKey || "", "");
+            const getCfgParams = getCfg?.params || {};
+            const getCfgMethod = (getCfg?.method || "GET").toLowerCase();
+            const putCfgUrl = getEnvVariable(putCfg?.url || "", false);
+            const putCfgClientKey = getEnvVariable(putCfg?.clientKey || "", false);
+            const putCfgServiceId = getEnvVariable(putCfg?.serviceId || "", false);
+            const putCfgDsfGtwApiKey = getEnvVariable(putCfg?.dsfgtwApiKey || "", "");
+            const putCfgParams = putCfg?.params || {};
+            const putCfgMethod = (putCfg?.method || "PUT").toLowerCase();
+
+            const allowSelfSignedCerts = getEnvVariableBool("ALLOW_SELF_SIGNED_CERTIFICATES",false) ; // Default to false if not set
+            
+            // check necessary values exist
+            if (!getCfgUrl || !getCfgClientKey 
+                || !putCfgUrl || !putCfgClientKey ) {
+                
+                return handleMiddlewareError(`🚨 Get submission environment variable missing: 
+                        getURl : ${getCfgUrl}, getClientKey : ${getCfgClientKey}
+                        putURl : ${putCfgUrl}, putClientKey : ${putCfgClientKey}`
+                    , 500, next)
+            }
+            // get response form GET submission API
+            const getResponse = await govcyApiRequest(
+                getCfgMethod,
+                getCfgUrl,
+                getCfgParams,
+                true, // use access token auth
+                user,
+                { 
+                    accept: "text/plain",       // Set Accept header to text/plain
+                    "client-key": getCfgClientKey,    // Set the client key header
+                    "service-id": getCfgServiceId,    // Set the service ID header
+                    ...(getCfgDsfGtwApiKey !== '' && { "dsfgtw-api-key": getCfgDsfGtwApiKey }) // Use the DSF API GTW secret from environment variables
+                },
+                3,
+                allowSelfSignedCerts,
+                [200, 404] // Allowed HTTP status codes
+            );
+
+            // If not succeeded, handle error
+            if (!getResponse.Succeeded) {
+                logger.debug("govcyLoadSubmissionData returned succeeded false",getResponse)
+                return handleMiddlewareError(`🚨 govcyLoadSubmissionData returned succeeded false`, 500, next)
+            }
+            
+            //  check if getResponse.Data is defined
+            if (getResponse.Data) {
+                // Store the response in the request for later use
+                dataLayer.storeSiteLoadData(store, siteId, getResponse.Data);
+
+                try {
+                    const parsed = JSON.parse(getResponse.Data.submissionData
+                        || getResponse.Data.submission_data 
+                        || "{}");
+                    if (parsed && typeof parsed === "object") {
+                        dataLayer.storeSiteInputData(store, siteId, parsed);
+                        logger.debug(`💾 Input data restored from saved submission for siteId: ${siteId}`);
+                    }
+                } catch (err) {
+                    logger.warn(`⚠️ Failed to parse saved submissionData for siteId: ${siteId}`, err);
+                }
+
+            // if not call the PUT submission API
+            } else {
+                const tempPutPayload = {
+                    // submission_data: JSON.stringify({}),
+                    submissionData: JSON.stringify({})
+                };
+                // If no data, call the PUT submission API to create it
+                const putResponse = await govcyApiRequest(
+                    putCfgMethod,
+                    putCfgUrl,
+                    tempPutPayload,
+                    true, // use access token auth
+                    user,
+                    { 
+                        accept: "text/plain",       // Set Accept header to text/plain
+                        "client-key": putCfgClientKey,    // Set the client key header
+                        "service-id": putCfgServiceId,    // Set the service ID header
+                        ...(putCfgDsfGtwApiKey !== '' && { "dsfgtw-api-key": putCfgDsfGtwApiKey }) // Use the DSF API GTW secret from environment variables
+                    },
+                    3,
+                    allowSelfSignedCerts
+                );
+                // If not succeeded, handle error
+                if (!putResponse.Succeeded) {
+                    logger.debug("govcyLoadSubmissionData returned succeeded false",putResponse)
+                    return handleMiddlewareError(`🚨 govcyLoadSubmissionData returned succeeded false`, 500, next)
+                }
+                // Store the response in the request for later use
+                dataLayer.storeSiteLoadData(store, siteId, putResponse.Data);
+
+            }
+            
+        }
+        
+    next();
+    } catch (error) {
+        logger.error("Error in govcyLoadSubmissionData middleware:", error.message);
+        return next(error); // Pass the error to the next middleware
+    }
+}

package/src/utils/govcySubmitData.mjs

@@ -66,6 +66,12 @@ export function prepareSubmissionData(req, siteId, service) {
             // Store in submissionData
             submissionData[pageUrl].formData[elId] = value;
 
+            // handle fileInput
+            if (elType === "fileInput") {
+                // change the name of the key to include "Attachment" at the end but not have the original key
+                submissionData[pageUrl].formData[elId + "Attachment"] = value;
+                delete submissionData[pageUrl].formData[elId];
+            }
 
             // 🔄 If radios with conditionalElements, walk ALL options
             if (elType === "radios" && Array.isArray(element.params?.items)) {
@@ -85,6 +91,12 @@ export function prepareSubmissionData(req, siteId, service) {
 
                         // Store even if the field was not visible to user
                         submissionData[pageUrl].formData[condId] = condValue;
+                        // handle fileInput
+                        if (condType === "fileInput") {
+                            // change the name of the key to include "Attachment" at the end but not have the original key
+                            submissionData[pageUrl].formData[condId + "Attachment"] = condValue;
+                            delete submissionData[pageUrl].formData[condId];
+                        }
                     }
                 }
             }
@@ -291,6 +303,10 @@ function getValue(formElement, pageUrl, req, siteId) {
     let value = ""
     if (formElement.element === "dateInput") {
         value = getDateInputISO(pageUrl, formElement.params.name, req, siteId);
+    } else if (formElement.element === "fileInput") {
+        // unneeded handle of `Attachment` at the end
+        // value = dataLayer.getFormDataValue(req.session, siteId, pageUrl, formElement.params.name + "Attachment");
+        value = dataLayer.getFormDataValue(req.session, siteId, pageUrl, formElement.params.name);
     } else {
         value = dataLayer.getFormDataValue(req.session, siteId, pageUrl, formElement.params.name);
     }
@@ -340,6 +356,17 @@ function getValueLabel(formElement, value, pageUrl, req, siteId, service) {
         return govcyResources.getSameMultilingualObject(service.site.languages, formattedDate);
     }
 
+    // handle fileInput
+    if (formElement.element === "fileInput") {
+        // TODO: Ask Andreas how to handle empty file inputs 
+        if (value) {
+            return govcyResources.staticResources.text.fileUploaded;
+        } else {
+            return govcyResources.getSameMultilingualObject(service.site.languages, "");
+            // return govcyResources.staticResources.text.fileNotUploaded;
+        }
+    }
+
     // textInput, textArea, etc.
     return govcyResources.getSameMultilingualObject(service.site.languages, value);
 }
@@ -410,6 +437,33 @@ export function generateReviewSummary(submissionData, req, siteId, showChangeLin
         };
     }
 
+    /**
+     * Helper function to create a summary list item for file links.
+     * @param {object} key the key of multilingual object
+     * @param {string} value the value
+     * @param {string} siteId the site id
+     * @param {string} pageUrl the page url
+     * @param {string} elementName the element name
+     * @returns {object} the summary list item with file link
+    */
+    function createSummaryListItemFileLink(key, value, siteId, pageUrl, elementName) {
+        return {
+            "key": key,
+            "value": [
+                {
+                    "element": "htmlElement",
+                    "params": {
+                        "text": { 
+                            "en": `<a href="/${siteId}/${pageUrl}/view-file/${elementName}" target="_blank">${govcyResources.staticResources.text.viewFile.en}<span class="govcy-visually-hidden"> ${key?.en || ""}</span></a>`, 
+                            "el": `<a href="/${siteId}/${pageUrl}/view-file/${elementName}" target="_blank">${govcyResources.staticResources.text.viewFile.el}<span class="govcy-visually-hidden"> ${key?.el || ""}</span></a>`, 
+                            "tr": `<a href="/${siteId}/${pageUrl}/view-file/${elementName}" target="_blank">${govcyResources.staticResources.text.viewFile.tr}<span class="govcy-visually-hidden"> ${key?.tr || ""}</span></a>` 
+                        }
+                    }
+                }
+            ]
+        };
+    }
+
     
 
 
@@ -425,8 +479,14 @@ export function generateReviewSummary(submissionData, req, siteId, showChangeLin
         for (const field of fields) {
             const label = field.label;
             const valueLabel = getSubmissionValueLabelString(field.valueLabel, req.globalLang);
-            // add the field to the summary entry
-            summaryListInner.params.items.push(createSummaryListItem(label, valueLabel));
+            // --- HACK --- to see if this is a file element
+            // check if field.value is an object with `sha256` and `fileId` properties
+            if (typeof field.value === "object" && field.value.hasOwnProperty("sha256") && field.value.hasOwnProperty("fileId") && showChangeLinks) {
+                summaryListInner.params.items.push(createSummaryListItemFileLink(label, valueLabel, siteId, pageUrl, field.name));
+            } else {
+                // add the field to the summary entry
+                summaryListInner.params.items.push(createSummaryListItem(label, valueLabel));
+            }
         }
 
         // Add inner summary list to the main summary list

package/src/utils/govcyTempSave.mjs

@@ -0,0 +1,71 @@
+// utils/govcyTempSave.mjs
+import { govcyApiRequest } from "./govcyApiRequest.mjs";
+import { getEnvVariable, getEnvVariableBool } from "./govcyEnvVariables.mjs";
+import * as dataLayer from "./govcyDataLayer.mjs";
+import { logger } from "./govcyLogger.mjs";
+/**
+ * Temporary save of in-progress form data via configured API endpoints.
+ * @param {object} store The session store
+ * @param {object} service The service object
+ * @param {string} siteId The site id
+ */
+export async function tempSaveIfConfigured(store, service, siteId) {
+    // Check if temp save is configured for this service with a PUT endpoint
+  const putCfg = service?.site?.submissionPutAPIEndpoint;
+  if (!putCfg?.url || !putCfg?.clientKey || !putCfg?.serviceId) return;
+
+  //Get environment variables
+  const allowSelfSignedCerts = getEnvVariableBool("ALLOW_SELF_SIGNED_CERTIFICATES", false);
+  const url = getEnvVariable(putCfg.url || "", false);
+  const clientKey = getEnvVariable(putCfg.clientKey || "", false);
+  const serviceId = getEnvVariable(putCfg.serviceId || "", false);
+  const dsfGtwKey = getEnvVariable(putCfg?.dsfgtwApiKey || "", "");
+  const method = (putCfg?.method || "PUT").toLowerCase();
+  const user = dataLayer.getUser(store);
+
+  // Prepare minimal temp payload (send whole inputData snapshot)
+  const inputData = dataLayer.getSiteInputData(store, siteId) || {};
+  const tempPayload = {
+    // mirror final submission format: send stringified JSON
+    // submission_data: JSON.stringify(inputData),
+    submissionData: JSON.stringify(inputData)
+  };
+
+  if (!url || !clientKey) {
+    logger.error("🚨 Temp save API configuration is incomplete:", { url, clientKey })
+    return; // don't break UX
+  } 
+
+  try {
+    // Call the API to save temp data
+    const resp = await govcyApiRequest(
+      method,
+      url,
+      tempPayload,
+      true, // auth with user access token
+      user,
+      {
+        accept: "text/plain",
+        "client-key": clientKey,
+        "service-id": serviceId,
+        ...(dsfGtwKey !== "" && { "dsfgtw-api-key": dsfGtwKey }),
+        "content-type": "application/json"
+      },
+      3,
+      allowSelfSignedCerts
+    );
+
+    if (!resp?.Succeeded) {
+      logger.warn("Temp save returned Succeeded=false", resp);
+      return; // don’t break UX
+    }
+
+    logger.info("✅ Temp save successful for site:", siteId, "Response:", resp);
+    // Optional: reflect any server state locally (e.g., keep referenceValue in loadData)
+    if (resp?.Data) {
+      dataLayer.storeSiteLoadData(store, siteId,resp.Data );
+    }
+  } catch (e) {
+    logger.error("Temp save failed (non-blocking):", e?.message);
+  }
+}

package/src/utils/govcyValidator.mjs

@@ -263,6 +263,9 @@ export function validateFormElements(elements, formData, pageUrl) {
         formData[`${field.params.name}_day`]]
           .filter(Boolean) // Remove empty values
           .join("-") // Join remaining parts
+        // unneeded handle of `Attachment` at the end
+        // : (field.element === "fileInput") // Handle fileInput
+        //   ? formData[`${field.params.name}Attachment`] || ""
         : formData[field.params.name] || ""; // Get submitted value
 
       //Autocheck: check for "checkboxes", "radios", "select" if `fieldValue` is one of the `field.params.items
@@ -310,6 +313,10 @@ export function validateFormElements(elements, formData, pageUrl) {
                   formData[`${conditionalElement.params.name}_day`]]
                     .filter(Boolean) // Remove empty values
                     .join("-") // Join remaining parts
+                  : (conditionalElement.element === "fileInput") // Handle fileInput
+                      // unneeded handle of `Attachment` at the end
+                      // ? formData[`${conditionalElement.params.name}Attachment`] || ""
+                      ? formData[`${conditionalElement.params.name}`] || ""
                   : formData[conditionalElement.params.name] || ""; // Get submitted value
 
                 //Autocheck: check for "checkboxes", "radios", "select" if `fieldValue` is one of the `field.params.items`