@gov-cy/govcy-express-services 0.1.4 → 0.1.6

package/README.md

@@ -14,6 +14,8 @@
 ## 📝 Description
 This project is an Express-based project that dynamically renders online service forms using `@gov-cy/govcy-frontend-renderer`. It is designed for developers building government services in Cyprus, enabling them to manage user authentication, form submissions, and OpenID authentication workflows in a timely manner.
 
+The project is designed to support the [Linear structure](https://gov-cy.github.io/govcy-design-system-docs/patterns/service_structure/#variant-1---linear-structure) as described in the [Unified Design System](https://gov-cy.github.io/govcy-design-system-docs/). 
+
 ![govcy-express-services](express-services.png)
 
 ## Table of contents
@@ -22,6 +24,7 @@ This project is an Express-based project that dynamically renders online service
 - [✨ Features](#-features)
 - [📋 Prerequisites](#-prerequisites)
 - [🚀 Quick start](#-quick-start)
+- [✅ Best Practices](#-best-practices)
 - [📦 Full installation guide](#-full-installation-guide)
 - [🛠️ Usage](#%EF%B8%8F-usage)
   - [🧩 Dynamic services rendering](#-dynamic-services-rendering)
@@ -97,6 +100,15 @@ For more details on configuration, environment variables, and advanced features,
 ## 📦 Full installation guide
 The project acts as an npm package and you need to install it as a dependency in your npm project. Check out the [install notes](INSTALL-NOTES.md) a detailed installation guide.
 
+## ✅ Best Practices
+
+Before starting your service, please review the [Best Practices guide](BEST-PRACTICES.md) for guidance on:
+
+- Repository structure
+- Environment separation (`dev` / `staging` / `prod`)
+- Secure CY Login client registration
+- Mandatory footer pages (privacy, cookies, accessibility)
+
 ## 🛠️ Usage
 ### Starting the Server
 Add in your `package.json`:
@@ -128,7 +140,13 @@ Here are some details explaining the JSON structure:
   - `submission_data_version` : The submission data version,
   - `renderer_version` : The govcy-frontend-renderer version,
   - `design_systems_version` : The govcy-design-system version,
-  - `homeRedirectPage`: The page to redirect when user visits the route page. Usually this will redirect to gov.cy page. If not provided will show a list of available sites.
+  - `homeRedirectPage`: An object mapping language codes to URLs. When a user visits the root route (e.g., `https://whatever-your-service-is.service.gov.cy/`), the system redirects to the URL for the user's language. If the user's language is not found, it falls back to `"el"` or the first available URL. If not provided, a list of available sites is shown. Example:
+  ```json 
+  "homeRedirectPage": {
+    "el": "https://www.gov.cy/service/aitisi-gia-taftotita/",
+    "en": "https://www.gov.cy/en/service/issue-an-id-card/"
+  }
+  ```
   - `matomo `: The Matomo web analytics configuration details.
   - `eligibilityAPIEndpoints` : An array of API endpoints, to be used for service eligibility. See more on the [Eligibility API Endoints](#%EF%B8%8F-site-eligibility-checks) section below.
   - `submissionAPIEndpoint`: The submission API endpoint, to be used for submitting the form. See more on the [Submission API Endoint](#-site-submissions) section below.
@@ -281,6 +299,14 @@ Lets break down the JSON config for this page:
   - Not perform the eligibility checks
   - Display the static content
 
+When designing form pages, refer to the Unified Design System's [question pages pattern](https://gov-cy.github.io/govcy-design-system-docs/patterns/question_pages/).
+
+**Error pages**
+Pages that can be used to display messages when eligibility or submission fail are simply static content pages. That is pages that do not include a `form` element.
+
+**Start page**
+The [start page](https://gov-cy.github.io/govcy-design-system-docs/patterns/service_structure/#start-page) should be created in the gov.cy portal and should be defined in the `site.homeRedirectPage` property in the site config JSON file. All pages within a service are private by default and can only be accessed by authenticated users, so the start page cannot be created in the JSON file.
+
 **Notes**:
 - Check out the [govcy-frontend-renderer's design elements](https://github.com/gov-cy/govcy-frontend-renderer/blob/main/DESIGN_ELEMENTS.md) for more details on the supported elements and their parameters.
 - Check out the [input validations section](#-input-validations) for more details on how to add validations to the JSON file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gov-cy/govcy-express-services",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "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/govcyRoutePageHandler.mjs

@@ -14,6 +14,18 @@ export function govcyRoutePageHandler(req, res, next) {
         const siteId  = req.cookies.cs;
         const serviceData = getServiceConfigData(siteId, req.globalLang);
         if (serviceData.site && serviceData.site.homeRedirectPage) {
+            const homeRedirectPage = serviceData.site.homeRedirectPage;
+            const lang = req.globalLang || 'el'; // fallback to 'en' if not set
+
+            let redirectUrl = null;
+
+            if (homeRedirectPage && typeof homeRedirectPage === 'object') {
+                redirectUrl = homeRedirectPage[lang] || homeRedirectPage['el'] || Object.values(homeRedirectPage)[0];
+            }
+
+            if (redirectUrl) {
+                return res.redirect(redirectUrl);
+            }
             // redirect to the homeRedirectPage cookie
             return res.redirect(serviceData.site.homeRedirectPage);
         }