add configuration for benefits payment period boundaries (#232)

* add configuration for benefits payment period boundaries

Author: jonathan-lewis-esdc

frontend/.env.example

@@ -142,6 +142,12 @@ OTEL_USE_CONSOLE_TRACE_EXPORTER=
 # Estimator configuration
 #################################################
 
+# Benefits payments period start date shown on index page (YYYY-MM-DD) 
+ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_START=
+
+# Benefits payments period end date shown on index page (YYYY-MM-DD) 
+ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_END=
+
 # Canada Disability Benefit english contact URL
 ESTIMATOR_CDB_CONTACT_URL_EN=
 

frontend/app/.server/environment/estimator.ts

@@ -1,11 +1,14 @@
 import * as v from 'valibot';
 
 import { stringToBooleanSchema } from '../validation/string-to-boolean-schema';
+import { stringToIsoDateSchema } from '../validation/string-to-iso-date-schema';
 import { stringToNumberSchema } from '../validation/string-to-number-schema';
 import { stringToUrlSchema } from '../validation/string-to-url-schema';
 
 // Default estimator configuration object
 export const defaults = {
+  ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_START: '2025-07-01',
+  ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_END: '2026-06-01',
   ESTIMATOR_CDB_CONTACT_URL_EN: undefined,
   ESTIMATOR_CDB_CONTACT_URL_FR: undefined,
   ESTIMATOR_CDB_URL_EN: 'https://www.canada.ca/en/services/benefits/disability/canada-disability-benefit.html',
@@ -30,6 +33,20 @@ export const defaults = {
 
 // Define schema for the environment variable
 export const estimator = v.object({
+  /**
+   * Benefits payments period start date shown on index page (YYYY-MM-DD)
+   */
+  ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_START: v.optional(
+    stringToIsoDateSchema(),
+    defaults.ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_START,
+  ),
+  /**
+   * Benefits payments period end date shown on index page (YYYY-MM-DD)
+   */
+  ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_END: v.optional(
+    stringToIsoDateSchema(),
+    defaults.ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_END,
+  ),
   /**
    * Canada Disability Benefit english contact URL
    */

frontend/app/.server/locales/estimator-en.json

@@ -117,6 +117,7 @@
       "result-disclaimer": "<strong>This tool provides an estimate only. It doesn't guarantee that you'll be eligible or that you'll receive the amount estimated.</strong>",
       "results": {
         "contact": " For a more accurate assessment of your estimated benefits amount, please <cdbContactLink>contact us</cdbContactLink>.",
+        "description": "This estimator provides estimated benefit amounts for payments made between {{paymentPeriodStart}} and {{paymentPeriodEnd}}. Future benefit amounts may be higher. The results are not financial advice and are subject to change.",
         "description": "This estimator provides estimated benefit amounts for payments made between July 2025 and June 2026. Future benefit amounts may be higher. The results are not financial advice and are subject to change.",
         "header": "About the results"
       }

frontend/app/.server/locales/estimator-fr.json

@@ -117,7 +117,7 @@
       "result-disclaimer": "<strong>Cet outil fournit une estimation seulement. Il ne garantit pas que vous serez admissible ou que vous recevrez le montant estimé.</strong>",
       "results": {
         "contact": " Pour une évaluation plus précise de votre montant de prestations estimé, veuillez <cdbContactLink>communiquer avec nous</cdbContactLink>.",
-        "description": "Cet estimateur fournit des montants estimés de prestation pour les paiements effectués entre juillet 2025 et juin 2026. Les montants des prestations futures pourraient être plus élevés en raison de l'inflation. Les résultats ne sont pas des conseils financiers et peuvent changer.",
+        "description": "Cet estimateur fournit des montants estimés de prestation pour les paiements effectués entre {{paymentPeriodStart}} et {{paymentPeriodEnd}}. Les montants des prestations futures pourraient être plus élevés en raison de l'inflation. Les résultats ne sont pas des conseils financiers et peuvent changer.",
         "header": "À propos des résultats"
       }
     },

frontend/app/.server/validation/string-to-iso-date-schema.ts

@@ -0,0 +1,5 @@
+import * as v from 'valibot';
+
+export function stringToIsoDateSchema(): v.GenericSchema<string, string> {
+  return v.pipe(v.string(), v.isoDate());
+}

frontend/app/routes/index.tsx

@@ -32,9 +32,21 @@ export async function loader({ request }: Route.LoaderArgs) {
   };
 }
 
+function formatBenefitPaymentsPeriodDate(date: Date, lang: 'fr' | 'en' | undefined) {
+  const options: Intl.DateTimeFormatOptions = {
+    year: 'numeric',
+    month: 'long',
+    timeZone: 'UTC',
+  };
+
+  return date.toLocaleDateString(lang === 'fr' ? 'fr-CA' : 'en-CA', options);
+}
+
 export default function Home({ loaderData }: Route.ComponentProps) {
   const { t, i18n } = useTranslation(handle.i18nNamespace);
   const {
+    ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_START,
+    ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_END,
     ESTIMATOR_CDB_CONTACT_URL_EN,
     ESTIMATOR_CDB_CONTACT_URL_FR,
     ESTIMATOR_CDB_ELIGIBILITY_URL_EN,
@@ -106,7 +118,16 @@ export default function Home({ loaderData }: Route.ComponentProps) {
         <section className="space-y-4">
           <h2 className="font-lato text-lg font-bold">{t('estimator:index.content.results.header')}</h2>
           <p>
-            <Trans ns={handle.i18nNamespace} i18nKey="estimator:index.content.results.description" />
+            {t('estimator:index.content.results.description', {
+              paymentPeriodStart: formatBenefitPaymentsPeriodDate(
+                new Date(ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_START),
+                i18n.language,
+              ),
+              paymentPeriodEnd: formatBenefitPaymentsPeriodDate(
+                new Date(ESTIMATOR_CDB_BENEFIT_PAYMENT_PERIOD_END),
+                i18n.language,
+              ),
+            })}
 
             {i18n.language === 'fr' && ESTIMATOR_CDB_CONTACT_URL_FR && (
               <Trans