@gov-cy/govcy-express-services 1.0.0-alpha.15 → 1.0.0-alpha.17

package/README.md

@@ -3,6 +3,7 @@
 ![License](https://img.shields.io/github/license/gov-cy/govcy-express-services)
 [![Unit test](https://github.com/gov-cy/govcy-express-services/actions/workflows/unit-test.yml/badge.svg)](https://github.com/gov-cy/govcy-express-services/actions/workflows/unit-test.yml)
 [![tag-and-publish-on-version-change](https://github.com/gov-cy/govcy-express-services/actions/workflows/tag-and-publish-on-version-change.yml/badge.svg)](https://github.com/gov-cy/govcy-express-services/actions/workflows/tag-and-publish-on-version-change.yml)
+![coverage](coverage-badges.svg)
 
 > ⚠️ **Warning:**  
 > This package is **under active development** and is not a finished product. It is intended for testing, acceptance, integration, and browser testing purposes only. 
@@ -29,15 +30,15 @@ The APIs used for submission, temporary save and file uploads are not part of th
 - [✅ Best Practices](#-best-practices)
 - [📦 Full installation guide](#-full-installation-guide)
 - [🛠️ Usage](#%EF%B8%8F-usage)
-  - [🧩 Dynamic services rendering](#-dynamic-services-rendering)
+  - [🧩 Dynamic services](#-dynamic-services)
   - [🛡️ Site eligibility checks](#%EF%B8%8F-site-eligibility-checks)
   - [📤 Site submissions](#-site-submissions)
   - [✅ Input validations](#-input-validations)
-  - [✅ Conditional logic](#-conditional-logic)
+  - [🔀 Conditional logic](#-conditional-logic)
   - [💾 Temporary save feature](#-temporary-save-feature)
   - [🗃️ Files uploads feature](#%EF%B8%8F-files-uploads-feature)
 - [🛣️ Routes](#%EF%B8%8F-routes)
-- [👨‍💻 Enviromental variables](#-enviromental-variables)
+- [👨‍💻 Environment variables](#-environment-variables)
 - [🔒 Security note](#-security-note)
 - [❓ Troubleshooting / FAQ](#-troubleshooting--faq)
 - [🙏 Credits](#-credits)
@@ -141,7 +142,7 @@ The CY Login tokens are used to also connect with the various APIs through [cyCo
 
 The CY Login settings are configured in the `secrets/.env` file.
 
-### 🧩 Dynamic Services Rendering
+### 🧩 Dynamic Services
 Services are rendered dynamically using JSON templates stored in the `/data` folder. All the service configuration, pages, routes, and logic is stored in the JSON files. The service will load `data/:siteId.json` to get the form data when a user visits `/:siteId/:pageUrl`. Checkout the [express-service-shema.json](express-service-shema.json) and the example JSON structure of the **[test.json](data/test.json)** file for more details.
 
 Here is an example JSON config:
@@ -1174,14 +1175,14 @@ Accept: text/plain
 Content-Type: application/json
 
 {
-  "submission_username": "username",
-  "submission_email": "email@example.com",
-  "submission_data": "{\"index\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}}",
-  "submission_data_version": "1",
-  "print_friendly_data": "[{\"pageUrl\":\"index\",\"pageTitle\":{\"el\":\"Επιλογή Εγγάφου\",\"en\":\"Document selection\",\"tr\":\"\"},\"fields\":[{\"id\":\"certificate_select\",\"name\":\"certificate_select\",\"label\":{\"el\":\"Τι έγγραφα επιθυμείτε να εκδώσετε;\",\"en\":\"What documents do you wish to issue?\"},\"value\":[\"birth\",\"permanent_residence\"],\"valueLabel\":[{\"el\":\"Πιστοποιητικό γέννησης​\",\"en\":\"Birth certificate\",\"tr\":\"\"},{\"el\":\"Βεβαίωση μόνιμης διαμονής​\",\"en\":\"Certificate of permanent residence\",\"tr\":\"\"}]}]}]",
-  "renderer_data": "{\"element\":\"summaryList\",\"params\":{\"items\":[{\"key\":{\"el\":\"Επιλογή Εγγάφου\",\"en\":\"Document selection\",\"tr\":\"\"},\"value\":[{\"element\":\"summaryList\",\"params\":{\"items\":[{\"key\":{\"el\":\"Τι έγγραφα επιθυμείτε να εκδώσετε;\",\"en\":\"What documents do you wish to issue?\"},\"value\":[{\"element\":\"textElement\",\"params\":{\"text\":{\"en\":\"Birth certificate, Certificate of permanent residence\",\"el\":\"Birth certificate, Certificate of permanent residence\",\"tr\":\"Birth certificate, Certificate of permanent residence\"},\"type\":\"span\"}}]}]}}]}]}}",
-  "renderer_version": "1.14.3",
-  "design_systems_version": "3.2.0",
+  "submissionUsername": "username",
+  "submissionEmail": "email@example.com",
+  "submissionData": "{\"index\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}}",
+  "submissionDataVersion": "1",
+  "printFriendlyData": "[{\"pageUrl\":\"index\",\"pageTitle\":{\"el\":\"Επιλογή Εγγάφου\",\"en\":\"Document selection\",\"tr\":\"\"},\"fields\":[{\"id\":\"certificate_select\",\"name\":\"certificate_select\",\"label\":{\"el\":\"Τι έγγραφα επιθυμείτε να εκδώσετε;\",\"en\":\"What documents do you wish to issue?\"},\"value\":[\"birth\",\"permanent_residence\"],\"valueLabel\":[{\"el\":\"Πιστοποιητικό γέννησης​\",\"en\":\"Birth certificate\",\"tr\":\"\"},{\"el\":\"Βεβαίωση μόνιμης διαμονής​\",\"en\":\"Certificate of permanent residence\",\"tr\":\"\"}]}]}]",
+  "rendererData": "{\"element\":\"summaryList\",\"params\":{\"items\":[{\"key\":{\"el\":\"Επιλογή Εγγάφου\",\"en\":\"Document selection\",\"tr\":\"\"},\"value\":[{\"element\":\"summaryList\",\"params\":{\"items\":[{\"key\":{\"el\":\"Τι έγγραφα επιθυμείτε να εκδώσετε;\",\"en\":\"What documents do you wish to issue?\"},\"value\":[{\"element\":\"textElement\",\"params\":{\"text\":{\"en\":\"Birth certificate, Certificate of permanent residence\",\"el\":\"Birth certificate, Certificate of permanent residence\",\"tr\":\"Birth certificate, Certificate of permanent residence\"},\"type\":\"span\"}}]}]}}]}]}}",
+  "rendererVersion": "1.14.3",
+  "designSystemsVersion": "3.2.0",
   "service": "{\"id\":\"test\",\"title\":{\"el\":\"Υπηρεσία τεστ\",\"en\":\"Test service\",\"tr\":\"\"}}"
 }
 ```
@@ -1232,15 +1233,15 @@ HTTP/1.1 200 OK
 The data is collected from the form elements and the data layer and are sent via the submission API in the following format:
 
 ```json
-"submissionData": {             // Site level successful submission data
-  "submission_username" : "",   // User's username
-  "submission_email" : "",      // User's email
-  "submission_data": "{}",      // Raw data as submitted by the user in each page
-  "submission_data_version": "",// The submission data version
-  "print_friendly_data": "[]",  // Print friendly data
-  "renderer_data" :"{}",        // Renderer data of the summary list
-  "renderer_version": "",       // The renderer version
-  "design_systems_version": "", // The design systems version
+{
+  "submissionUsername" : "",   // User's username
+  "submissionEmail" : "",      // User's email
+  "submissionData": "{}",      // Raw data as submitted by the user in each page
+  "submissionDataVersion": "",// The submission data version
+  "printFriendlyData": "[]",  // Print friendly data
+  "rendererData" :"{}",        // Renderer data of the summary list
+  "rendererVersion": "",       // The renderer version
+  "designSystemsVersion": "", // The design systems version
   "service": "{}"               // Service info
 }
 ```
@@ -1251,22 +1252,22 @@ The data is collected from the form elements and the data layer and are sent via
 
 > ℹ️ **Note:**  
 >
-> When sent to the API, the fields `submission_data`, `renderer_data`, `print_friendly_data`, and `service` are stringified using `JSON.stringify()`.  
+> When sent to the API, the fields `submissionData`, `rendererData`, `printFriendlyData`, and `service` are stringified using `JSON.stringify()`.  
 >
 > The sample below shows the structure **before** stringification for clarity.
 
 ```json
 {
-  "submission_username": "username",        // User's username
-  "submission_email": "email@example.com",  // User's email
-  "submission_data_version": "0.1",         // Submission data version
-  "submission_data": {                      // Submission raw data. Object, will be stringified
+  "submissionUsername": "username",        // User's username
+  "submissionEmail": "email@example.com",  // User's email
+  "submissionDataVersion": "0.1",         // Submission data version
+  "submissionData": {                      // Submission raw data. Object, will be stringified
     "index": {                              // Page level
       "id_select": ["id", "arc"],           // field level. Could be string or array
       "id_number": "654654",
       "arc_number": "",
       "aka": "232323",
-      "evidenceAttachments":                // File attachments contains an object with `fileId` and `sha256`
+      "evidenceAttachment":                // File attachments contains an object with `fileId` and `sha256`
       {
         "fileId": "1234567891234567890",
         "sha256": "123456789012345678901234567890123456789012345678901234567890123456"
@@ -1292,8 +1293,8 @@ The data is collected from the form elements and the data layer and are sent via
       "reason": "24324dssf"
     }
   },
-  "submission_data_version": "1",           // Submission data version
-  "renderer_data": {                        // Summary list renderer data ready for rendering . Object, will be stringified
+  "submissionDataVersion": "1",           // Submission data version
+  "rendererData": {                        // Summary list renderer data ready for rendering . Object, will be stringified
     "element": "summaryList",
     "params": {
       "items": [
@@ -1500,7 +1501,7 @@ The data is collected from the form elements and the data layer and are sent via
       ]
     }
   },
-  "print_friendly_data": [                  // Print friendly data. Object, will be stringified
+  "printFriendlyData": [                  // Print friendly data. Object, will be stringified
     {
       "pageUrl": "index",                     // Page URL
       "pageTitle": {                          // Page title
@@ -1663,8 +1664,8 @@ The data is collected from the form elements and the data layer and are sent via
       ]
     }
   ],
-  "renderer_version": "1.14.1",              // Renderer version
-  "design_systems_version": "3.1.0",          // Design systems version
+  "rendererVersion": "1.14.1",              // Renderer version
+  "designSystemsVersion": "3.1.0",          // Design systems version
   "service": {                                // Service metadata. Object, will be stringified
     "id": "takeover",
     "title": {
@@ -1744,7 +1745,7 @@ Example:
 ]
 ```
 
-### ✅ Conditional logic
+### 🔀 Conditional logic
 
 The project supports conditional logic on pages. Conditional logic is evaluated using a custom `govcyExpressions.mjs` module, which executes expressions in a safe and scoped context using `new Function`. Only safe data access through the `dataLayer` is allowed. The system uses expressions and session data from the service's [data layer](NOTES.md#data-layer) to decide if a page will be shown or not.
 
@@ -2014,7 +2015,7 @@ TEST_SUBMISSION_API_SERVICE_ID=123
   3. If not found, call the PUT endpoint to create a new temporary record.
 - **On every form POST**, after successful validation:
   - The `submissionPutAPIEndpoint` will fire-and-forget a `PUT` request to update the saved submission with the latest form data.
-  - The payload includes all required submission fields with `submission_data` JSON-stringified.
+  - The payload includes all required submission fields with `submissionData` JSON-stringified.
 
 #### `submissionGetAPIEndpoint` `GET` API Request and Response
 This API is used to retrieve the saved submission data.
@@ -2115,7 +2116,7 @@ Accept: text/plain
 Content-Type: application/json
 
 {
-  "submission_data" : "{\"index\":{\"formData\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}},\"data-entry-radios\":{\"formData\":{\"mobile_select\":\"other\",\"mobileTxt\":\"+35799484967\"}}}"
+  "submissionData" : "{\"index\":{\"formData\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}},\"data-entry-radios\":{\"formData\":{\"mobile_select\":\"other\",\"mobileTxt\":\"+35799484967\"}}}"
 }
 ```
 
@@ -2487,7 +2488,7 @@ The project uses express.js to serve the following routes:
 #### API routes:
 - **`/apis/:siteId/:pageUrl/upload`**: Uploads a file. Used from the client side JS.
 
-### 👨‍💻 Enviromental variables
+### 👨‍💻 Environment variables
 The environment variables are defined in:
  - **Secret environment variables**: These are secret variables and MUSR NOT be saved in version control. The are saved locally in the `secrets/.env` file and they control the server configuration, authentication, integrations, and development behavior. These variables vary depending on the environment and are defined through the deployment prosses for `staging` and `production`.
  - **Non secret environment variables**:  These are non secret enviromentat variables and can be saved in version control. These are stored in the root folder of the project:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gov-cy/govcy-express-services",
-  "version": "1.0.0-alpha.15",
+  "version": "1.0.0-alpha.17",
   "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",
@@ -45,12 +45,13 @@
     "test:package": "mocha --recursive tests/package/**/*.test.mjs",
     "test:functional": "mocha --timeout 30000 --recursive tests/functional/**/*.test.mjs",
     "test:watch": "mocha --watch --timeout 60000 tests/**/*.test.mjs",
-    "coverage": "c8 --reporter=html --reporter=text --reporter=lcov  --reporter=cobertura npm test",
-    "coverage:report": "c8 report"
+    "coverage": "c8 --reporter=html --reporter=text --reporter=lcov --reporter=json-summary npm test",
+    "coverage:report": "c8 report",
+    "coverage:badge": "coverage-badges --output ./coverage-badges.svg"
   },
   "dependencies": {
     "@gov-cy/dsf-email-templates": "^2.1.0",
-    "@gov-cy/govcy-frontend-renderer": "^1.22.0",
+    "@gov-cy/govcy-frontend-renderer": "^1.22.1",
     "axios": "^1.9.0",
     "cookie-parser": "^1.4.7",
     "dotenv": "^16.3.1",
@@ -65,6 +66,7 @@
     "c8": "^10.1.3",
     "chai": "^5.2.0",
     "chai-http": "^5.1.1",
+    "coverage-badges-cli": "^2.2.0",
     "mocha": "^11.1.0",
     "mochawesome": "^7.1.3",
     "nodemon": "^3.0.2",

package/src/auth/cyLoginAuth.mjs

@@ -2,7 +2,7 @@ import * as client from 'openid-client';
 import { getEnvVariable } from '../utils/govcyEnvVariables.mjs';
 import { logger } from "../utils/govcyLogger.mjs";
 
-
+/* c8 ignore start */
 // OpenID Configuration
 const issuerUrl = getEnvVariable('CYLOGIN_ISSUER_URL');
 const clientId = getEnvVariable('CYLOGIN_CLIENT_ID');
@@ -131,3 +131,4 @@ export function getLogoutUrl(id_token_hint = '') {
 
 // Export config if needed elsewhere
 export { config };
+/* c8 ignore end */

package/src/middleware/cyLoginAuth.mjs

@@ -10,6 +10,7 @@ import { handleMiddlewareError } from "../utils/govcyUtils.mjs";
 import { errorResponse } from "../utils/govcyApiResponse.mjs"; 
 import { isApiRequest } from '../utils/govcyApiDetection.mjs';
 
+/* c8 ignore start */
 /**
  * Middleware to check if the user is authenticated. If not, redirect to the login page.
  * 
@@ -136,4 +137,5 @@ export function handleLogout() {
             res.redirect(logoutUrl);
         });
     };
-}
+}
+/* c8 ignore end */

package/src/middleware/govcyPDFRender.mjs

@@ -6,6 +6,7 @@ import { logger } from "../utils/govcyLogger.mjs";
  * Middleware function to render PDFs using the GovCy Frontend Renderer.
  * This function takes the processed page data and template, and generates the final PDF response.
  */
+/* c8 ignore start */
 export function govcyPDFRender() {
     return async (req, res) => {
         try {
@@ -29,4 +30,5 @@ export function govcyPDFRender() {
             res.status(500).send('Unable to generate PDF at this time.');
         }
     };
-}
+}
+/* c8 ignore end */

package/src/middleware/govcyReviewPostHandler.mjs

@@ -118,7 +118,7 @@ export function govcyReviewPostHandler() {
                         
                     //-- Send email to user
                     // Generate the email body
-                    let emailBody = generateSubmitEmail(service, submissionData.print_friendly_data, referenceNo, req);
+                    let emailBody = generateSubmitEmail(service, submissionData.printFriendlyData, referenceNo, req);
                     logger.debug("Email generated:", emailBody);
                     // Send the email
                     sendEmail(service.site.title[service.site.lang],emailBody,[dataLayer.getUser(req.session).email], "eMail").catch(err => {

package/src/middleware/govcySuccessPageHandler.mjs

@@ -78,7 +78,7 @@ export function govcySuccessPageHandler(isPDF = false) {
                 }   
             }
 
-            let summaryList = submissionData.renderer_data;
+            let summaryList = submissionData.rendererData;
 
             let mainElements = [];
             // Add elements to the main section

package/src/public/js/govcyFiles.js

@@ -135,9 +135,9 @@ function _uploadFileEventHandler(event) {
       "tr": "The selected file must be a JPG, JPEG, PNG or PDF"
     },
     "uploadFailed409": {
-      "el": "Το επιλεγμένο αρχείο πρέπει να είναι μικρότερο από 5MB",
-      "en": "The selected file must be smaller than 5MB",
-      "tr": "The selected file must be smaller than 5MB"
+      "el": "Το επιλεγμένο αρχείο πρέπει να είναι μικρότερο από 4MB",
+      "en": "The selected file must be smaller than 4MB",
+      "tr": "The selected file must be smaller than 4MB"
     }
   };
 

package/src/utils/govcyConstants.mjs

@@ -4,5 +4,5 @@
 export const ALLOWED_FORM_ELEMENTS = ["textInput", "textArea", "select", "radios", "checkboxes", "datePicker", "dateInput","fileInput","fileView"];
 export const ALLOWED_FILE_MIME_TYPES = ['application/pdf', 'image/jpeg', 'image/png'];
 export const ALLOWED_FILE_EXTENSIONS = ['pdf', 'jpg', 'jpeg', 'png'];
-export const ALLOWED_FILE_SIZE_MB = 5; // Maximum file size in MB
+export const ALLOWED_FILE_SIZE_MB = 4; // Maximum file size in MB
 export const ALLOWED_MULTER_FILE_SIZE_MB = 10; // Maximum file size in MB

package/src/utils/govcySubmitData.mjs

@@ -32,7 +32,7 @@ export function prepareSubmissionData(req, siteId, service) {
     //     }
     // }
 
-    // ----- consistent data model for submission_data (CONFIG-BASED)
+    // ----- consistent data model for submissionData (CONFIG-BASED)
     const submissionData = {};
 
     // Loop through every page in the service definition
@@ -110,7 +110,7 @@ export function prepareSubmissionData(req, siteId, service) {
         }
     }
     logger.debug("Submission Data prepared:", submissionData);
-    // ----- END config-based stable submission_data block
+    // ----- END config-based stable submissionData block
 
     // Get the print-friendly data from the session store
     const printFriendlyData = preparePrintFriendlyData(req, siteId, service);
@@ -119,14 +119,14 @@ export function prepareSubmissionData(req, siteId, service) {
     const reviewSummaryList = generateReviewSummary(printFriendlyData, req, siteId, false);
     // Prepare the submission data object
     return {
-        submission_username: dataLayer.getUser(req.session).name,
-        submission_email: dataLayer.getUser(req.session).email,
-        submission_data: submissionData, // Raw data as submitted by the user in each page
-        submission_data_version: service.site?.submission_data_version || "", // The submission data version
-        print_friendly_data: printFriendlyData, // Print-friendly data
-        renderer_data: reviewSummaryList, // Renderer data of the summary list
-        renderer_version: service.site?.renderer_version || "", // The renderer version
-        design_systems_version: service.site?.design_systems_version || "", // The design systems version
+        submissionUsername: dataLayer.getUser(req.session).name,
+        submissionEmail: dataLayer.getUser(req.session).email,
+        submissionData: submissionData, // Raw data as submitted by the user in each page
+        submissionDataVersion: service.site?.submission_data_version || "", // The submission data version
+        printFriendlyData: printFriendlyData, // Print-friendly data
+        rendererData: reviewSummaryList, // Renderer data of the summary list
+        rendererVersion: service.site?.renderer_version || "", // The renderer version
+        designSystemsVersion: service.site?.design_systems_version || "", // The design systems version
         service: { // Service info
             id: service.site.id, // Service ID
             title: service.site.title // Service title multilingual object
@@ -145,14 +145,14 @@ export function prepareSubmissionData(req, siteId, service) {
 export function prepareSubmissionDataAPI(data) {
     
     return {
-        submission_username: String(data.submission_username ?? ""),
-        submission_email: String(data.submission_email ?? ""),
-        submission_data: JSON.stringify(data.submission_data ?? {}),
-        submission_data_version: String(data.submission_data_version ?? ""),
-        print_friendly_data: JSON.stringify(data.print_friendly_data ?? []),
-        renderer_data: JSON.stringify(data.renderer_data ?? {}),
-        renderer_version: String(data.renderer_version ?? ""),
-        design_systems_version: String(data.design_systems_version ?? ""),
+        submissionUsername: String(data.submissionUsername ?? ""),
+        submissionEmail: String(data.submissionEmail ?? ""),
+        submissionData: JSON.stringify(data.submissionData ?? {}),
+        submissionDataVersion: String(data.submissionDataVersion ?? ""),
+        printFriendlyData: JSON.stringify(data.printFriendlyData ?? []),
+        rendererData: JSON.stringify(data.rendererData ?? {}),
+        rendererVersion: String(data.rendererVersion ?? ""),
+        designSystemsVersion: String(data.designSystemsVersion ?? ""),
         service: JSON.stringify(data.service ?? {})
     };
 }