@gov-cy/govcy-express-services 0.1.1 → 0.1.3

package/README.md

@@ -1,10 +1,14 @@
 # govcy Express Services
-![License](https://img.shields.io/github/license/gov-cy/govcy-epxress-services)
+[![npm (scoped)](https://img.shields.io/npm/v/@gov-cy/govcy-express-services)](https://www.npmjs.com/package/@gov-cy/govcy-express-services)
+![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)
 
 > ⚠️ **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.  
+> This package is **under active development** and is not a finished product. It is intended for testing, acceptance, integration, and browser testing purposes only. 
+> 
 > **No guarantees are provided regarding stability, security, or compliance. Using this package does not imply your product or service will automatically pass any required assessments, audits, or certifications by the Cyprus government or any other authority.**  
+>
 > You are responsible for ensuring your own compliance, security, and quality assurance processes.
 
 ## 📝 Description
@@ -248,6 +252,10 @@ Here's an example of a page defined in the JSON file:
 }
 ```
 
+The above `page` JSON generates a page that looks like the following screenshot:
+
+![Screenshot of sample page](express-page.png)
+
 The JSON structure is based on the [govcy-frontend-renderer's JSON template](https://github.com/gov-cy/govcy-frontend-renderer/blob/main/README.md#json-template-example).
 
 Lets break down the JSON config for this page:
@@ -285,6 +293,10 @@ The `review` page is automatically generated by the project and includes the fol
 - **Change links**: A list of links to each page in the service.
 - **Submit button**: A button to submit the form.
 
+Here's an example screenshot of review page
+
+![Screenshot of review page](express-review.png)
+
 When the user clicks a change link, the user is redirected to the corresponding page in the service. After the user clicks on `continue` button the user is redirected back to the `review` page.
 
 When the user clicks the `Submit` button, all the data gathered from the site's forms within this session are validated based on the validation definition in the JSON file, and if they pass they are submitted to the configured API endpoint.
@@ -297,6 +309,10 @@ The `success` page is automatically generated by the project, is accessible only
 - **PDF Download link**: A link to download the PDF of the submission's data in a human-readable format.
 - **Summary**: A summary of the data from all the pages in the service.
 
+Here's an example screenshot of success page
+
+![Screenshot of success page](express-success.png)
+
 ### 🛡️ Site eligibility checks
 
 The project uses an array of API endpoints to check the eligibility of a service/site. To use this feature, you need to configure the following in your JSON file under the `site` object:
@@ -383,7 +399,7 @@ For each eligibility API endpoint, the project sends a request to the API endpoi
 
 **Example GET Request:**
 
-```
+```http
 GET /check-eligibility?checkFor=isCitizen,isAdult HTTP/1.1
 Host: localhost:3002
 Authorization: Bearer eyJhbGciOi...
@@ -394,7 +410,7 @@ Accept: text/plain
 
 **Example POST Request**:
 
-```
+```http
 POST /check-eligibility HTTP/1.1
 Host: localhost:3002
 Authorization: Bearer eyJhbGciOi...
@@ -507,7 +523,7 @@ With the above config, when a user submits the `review` page, the service sends
 
 **Example Request:**
 
-```
+```http
 POST /submission-endpoint HTTP/1.1
 Host: localhost:3002
 Authorization: Bearer eyJhbGciOi...
@@ -517,12 +533,15 @@ Accept: text/plain
 Content-Type: application/json
 
 {
-  "AccountName": "John Doe",
-  "Iban": "CY12002001230000000123456789",
-  "Swift": "BANKCY2NXXX",
-  "Objection": "Accept",
-  "ReceiveSettlement": "no",
-  ...
+  "submission_username": "username",
+  "submission_email": "email@example.com",
+  "submission_data": "{\"index\":{\"formData\":{\"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",
+  "service": "{\"id\":\"test\",\"title\":{\"el\":\"Υπηρεσία τεστ\",\"en\":\"Test service\",\"tr\":\"\"}}"
 }
 ```
 
@@ -537,7 +556,7 @@ The API is expected to return a JSON response with the following structure (see
   "ErrorCode": 0,
   "ErrorMessage": null,
   "Data": {
-    "submission_id": "12345678-x"
+    "referenceValue": "12345678"
   }
 }
 ```
@@ -586,7 +605,9 @@ The data is collected from the form elements and the data layer and are sent via
   <summary>Here's a sample submission data JSON (as an object, before stringification)</summary>
 
 > ℹ️ **Note:**  
+>
 > When sent to the API, the fields `submission_data`, `renderer_data`, `print_friendly_data`, and `service` are stringified using `JSON.stringify()`.  
+>
 > The sample below shows the structure **before** stringification for clarity.
 
 ```json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gov-cy/govcy-express-services",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "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/middleware/govcyReviewPostHandler.mjs

@@ -90,7 +90,7 @@ export function govcyReviewPostHandler() {
                 
                 // Check if the response is successful
                 if (response.Succeeded) {
-                    let referenceNo = response?.Data?.submission_id || "";
+                    let referenceNo = response?.Data?.referenceValue || "";
                     // Add the reference number to the submission data
                     submissionData.referenceNumber = referenceNo; 
                     logger.info("✅ Data submitted", siteId, referenceNo);