@gov-cy/govcy-express-services 1.0.0-alpha.2 → 1.0.0-alpha.5

package/README.md

@@ -494,7 +494,9 @@ Content-Type: application/json
 The API is expected to return a JSON response with the following structure (see [govcyApiRequest.mjs](src/utils/govcyApiRequest.mjs) for normalization):
 
 **On Success:**
-```json
+```http
+HTTP/1.1 200 OK
+
 {
   "Succeeded": true,
   "ErrorCode": 0,
@@ -503,7 +505,9 @@ The API is expected to return a JSON response with the following structure (see
 ```
 
 **On Failure:**
-```json
+```http
+HTTP/1.1 200 OK
+
 {
   "Succeeded": false,
   "ErrorCode": 102,
@@ -637,7 +641,9 @@ Content-Type: application/json
 The API is expected to return a JSON response with the following structure (see [govcyApiRequest.mjs](src/utils/govcyApiRequest.mjs) for normalization):
 
 **On Success:**
-```json
+```http
+HTTP/1.1 200 OK
+
 {
   "Succeeded": true,
   "ErrorCode": 0,
@@ -649,7 +655,9 @@ The API is expected to return a JSON response with the following structure (see
 ```
 
 **On Failure:**
-```json
+```http
+HTTP/1.1 200 OK
+
 {
   "Succeeded": false,
   "ErrorCode": 102,
@@ -1492,7 +1500,9 @@ The API is expected to return a JSON response with the following structure:
 
 **When temporary submission data are found:**
 
-```json
+```http
+HTTP/1.1 200 OK
+
 {
     "Succeeded": true,
     "ErrorCode": 0,
@@ -1505,7 +1515,9 @@ The API is expected to return a JSON response with the following structure:
 
 **When temporary submission data are NOT found:**
 
-```json
+```http
+HTTP/1.1 404 Not Found
+
 {
     "Succeeded": true,
     "ErrorCode": 0,
@@ -1516,7 +1528,9 @@ The API is expected to return a JSON response with the following structure:
 
 **When temporary submission retreival fails:**
 
-```json
+```http
+HTTP/1.1 200 OK
+
 {
     "Succeeded": false,
     "ErrorCode": 401,
@@ -1561,7 +1575,9 @@ The API is expected to return a JSON response with the following structure:
 
 **On success:**
 
-```json
+```http
+HTTP/1.1 200 OK
+
 {
     "Succeeded": true,
     "ErrorCode": 0,
@@ -1574,7 +1590,9 @@ The API is expected to return a JSON response with the following structure:
 
 **On failure:**
 
-```json
+```http
+HTTP/1.1 401 Unauthorized
+
 {
     "Succeeded": false,
     "ErrorCode": 401,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gov-cy/govcy-express-services",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.5",
   "description": "An Express-based system that dynamically renders services using @gov-cy/govcy-frontend-renderer and posts data to a submission API.",
   "author": "DMRID - DSF Team",
   "license": "MIT",

package/src/utils/govcyApiRequest.mjs

@@ -11,6 +11,7 @@ import { logger } from "./govcyLogger.mjs";
  * @param {object} headers - Custom headers (optional)
  * @param {number} retries - Number of retry attempts (default: 3)
  * @param {boolean} allowSelfSignedCerts - Whether to allow self-signed certificates (default: false)
+ * @param {array} allowedHTTPStatusCodes - Array of allowed HTTP status codes (default: [200])
  * @returns {Promise<object>} - API response
  */
 export async function govcyApiRequest(
@@ -21,7 +22,8 @@ export async function govcyApiRequest(
     user = null, 
     headers = {}, 
     retries = 3,
-    allowSelfSignedCerts = false
+    allowSelfSignedCerts = false,
+    allowedHTTPStatusCodes = [200]
 ) {
     let attempt = 0;
 
@@ -48,6 +50,8 @@ export async function govcyApiRequest(
                 [method?.toLowerCase() === 'get' ? 'params' : 'data']: inputData,
                 headers: requestHeaders,
                 timeout: 10000, // 10 seconds timeout
+                // ✅ Treat only these statuses as "resolved" (no throw)
+                validateStatus: (status) => allowedHTTPStatusCodes.includes(status),
             };
 
             // Add httpsAgent if NOT production to allow self-signed certificates
@@ -60,9 +64,13 @@ export async function govcyApiRequest(
 
             logger.debug(`📥 Received API response`, { status: response.status, data: response.data });
 
-            if (response.status !== 200) {
+            // Validate HTTP status
+            if (!allowedHTTPStatusCodes.includes(response.status)) {
                 throw new Error(`Unexpected HTTP status: ${response.status}`);
             }
+            // if (response.status !== 200) {
+            //     throw new Error(`Unexpected HTTP status: ${response.status}`);
+            // }
             
             // const { Succeeded, ErrorCode, ErrorMessage } = response.data;
             // Normalize to PascalCase regardless of input case
@@ -77,7 +85,7 @@ export async function govcyApiRequest(
                 ErrorMessage,
                 Data,
                 InformationMessage
-            } = response.data;
+            } = response.data ?? {};
 
             const normalized = {
                 Succeeded: Succeeded !== undefined ? Succeeded : succeeded,

package/src/utils/govcyLoadSubmissionDataAPIs.mjs

@@ -73,7 +73,8 @@ export async function govcyLoadSubmissionDataAPIs(store, service, siteId, next)
                     ...(getCfgDsfGtwApiKey !== '' && { "dsfgtw-api-key": getCfgDsfGtwApiKey }) // Use the DSF API GTW secret from environment variables
                 },
                 3,
-                allowSelfSignedCerts
+                allowSelfSignedCerts,
+                [200, 404] // Allowed HTTP status codes
             );
 
             // If not succeeded, handle error
@@ -88,7 +89,9 @@ export async function govcyLoadSubmissionDataAPIs(store, service, siteId, next)
                 dataLayer.storeSiteLoadData(store, siteId, getResponse.Data);
 
                 try {
-                    const parsed = JSON.parse(getResponse.Data.submissionData || "{}");
+                    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}`);
@@ -99,11 +102,15 @@ export async function govcyLoadSubmissionDataAPIs(store, service, siteId, next)
 
             // 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,
-                    putCfgParams,
+                    tempPutPayload,
                     true, // use access token auth
                     user,
                     { 

package/src/utils/govcyTempSave.mjs

@@ -27,7 +27,8 @@ export async function tempSaveIfConfigured(store, service, siteId) {
   const inputData = dataLayer.getSiteInputData(store, siteId) || {};
   const tempPayload = {
     // mirror final submission format: send stringified JSON
-    submission_data: JSON.stringify(inputData)
+    // submission_data: JSON.stringify(inputData),
+    submissionData: JSON.stringify(inputData)
   };
 
   if (!url || !clientKey) {