@sbc-connect/nuxt-forms 0.1.32 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @sbc-connect/nuxt-forms
 
+## 0.2.0
+
+### Minor Changes
+
+- [#105](https://github.com/bcgov/connect-nuxt/pull/105) [`78195c7`](https://github.com/bcgov/connect-nuxt/commit/78195c765aa337be53fbb4ecf60e45bea44b36ff) Thanks [@deetz99](https://github.com/deetz99)! - Add strict Postal and Zip code validation for CA or US addresses.
+
+### Patch Changes
+
+- Updated dependencies [[`d714785`](https://github.com/bcgov/connect-nuxt/commit/d71478573f1fe11be34d5d588d68fb75eb5fd159), [`5f1b383`](https://github.com/bcgov/connect-nuxt/commit/5f1b3839ed993654a7f20fe161047ba38ab86274)]:
+  - @sbc-connect/nuxt-base@0.3.0
+
+## 0.1.33
+
+### Patch Changes
+
+- Updated dependencies [[`09323e1`](https://github.com/bcgov/connect-nuxt/commit/09323e1fcaff9a2738528c8161288c1d4bcd0677), [`033f6c6`](https://github.com/bcgov/connect-nuxt/commit/033f6c624fbf953f1d7cf491c876cc9b58619b22)]:
+  - @sbc-connect/nuxt-base@0.2.0
+
 ## 0.1.32
 
 ### Patch Changes

package/app/utils/zod-schemas/addresses.ts

@@ -1,5 +1,17 @@
 import { z } from 'zod'
 
+/**
+ * Canadian postal code regex (eg, accepts A1A 1A1 or A1A1A1).
+ * Ref: https://en.wikipedia.org/wiki/Postal_codes_in_Canada
+ */
+const CanadaPostalCodeRegex = /^[ABCEGHJ-NPRSTVXY][0-9][ABCEGHJ-NPRSTV-Z][ ]?[0-9][ABCEGHJ-NPRSTV-Z][0-9]$/i
+
+/**
+ * US ZIP code regex (eg, accepts 12345 or 12345-6789).
+ * Ref: https://faq.usps.com/s/article/ZIP-Code-The-Basics
+*/
+const USZipCodeRegex = /^\d{5}(?:-\d{4})?$/
+
 export function getRequiredAddressSchema() {
   const t = useNuxtApp().$i18n.t
 
@@ -21,8 +33,8 @@ export function getRequiredAddressSchema() {
       .optional(),
     postalCode: z
       .string()
-      .min(1, t('connect.validation.fieldRequired'))
-      .max(15, t('connect.validation.maxChars', { count: 15 })),
+      .max(15, t('connect.validation.maxChars', { count: 15 }))
+      .optional(),
     country: z
       .string()
       .min(1, t('connect.validation.fieldRequired')),
@@ -31,11 +43,7 @@ export function getRequiredAddressSchema() {
       .max(80, t('connect.validation.maxChars', { count: 80 }))
       .optional()
   }).superRefine((data, ctx) => {
-    // validate region based on country
-    // required if country is US or CA
-    // optional and max 2 characters if not US or CA
-    const country = data.country
-    const region = data.region
+    const { country, region, postalCode } = data
 
     if (region && region.length > 2) {
       ctx.addIssue({
@@ -45,12 +53,46 @@ export function getRequiredAddressSchema() {
       })
     }
 
-    if ((country === 'US' || country === 'CA') && region?.length === 0) {
-      ctx.addIssue({
-        code: 'custom',
-        message: t('connect.validation.fieldRequired'),
-        path: ['region']
-      })
+    const isRequiredRegion = country === 'US' || country === 'CA'
+
+    if (isRequiredRegion) {
+      if (!region) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t('connect.validation.fieldRequired'),
+          path: ['region']
+        })
+      }
+
+      if (!postalCode) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t('connect.validation.fieldRequired'),
+          path: ['postalCode']
+        })
+      }
+    }
+
+    if (!postalCode) {
+      return
+    }
+
+    if (country === 'CA') {
+      if (!CanadaPostalCodeRegex.test(postalCode)) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t('connect.validation.invalidPostalCodeFormat'),
+          path: ['postalCode']
+        })
+      }
+    } else if (country === 'US') {
+      if (!USZipCodeRegex.test(postalCode)) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t('connect.validation.invalidZipCodeFormat'),
+          path: ['postalCode']
+        })
+      }
     }
   })
 }
@@ -80,10 +122,8 @@ export function getNonRequiredAddressSchema() {
       .optional(),
     postalCode: z
       .string()
-      .min(1, t('connect.validation.fieldRequired'))
       .max(15, t('connect.validation.maxChars', { count: 15 }))
-      .optional()
-      .or(z.literal('')),
+      .optional(),
     country: z
       .string()
       .min(1, t('connect.validation.fieldRequired'))

package/i18n/locales/en-CA.ts

@@ -38,7 +38,9 @@ export default {
       fieldRequired: 'This field is required',
       maxChars: 'Maximum 0 characters | Maximum 1 character | Maximum {count} characters', // 0/1 most likely will never be used but required for pluralization
       minChars: 'Minimum 0 characters | Minimum 1 character | Minimum {count} characters', // 0/1 most likely will never be used but required for pluralization
-      required: 'Required'
+      required: 'Required',
+      invalidPostalCodeFormat: 'Invalid Postal Code format (e.g., 1X1 X1X)',
+      invalidZipCodeFormat: 'Invalid ZIP Code format (e.g., 12345 or 12345-6789)'
     }
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sbc-connect/nuxt-forms",
   "type": "module",
-  "version": "0.1.32",
+  "version": "0.2.0",
   "repository": "github:bcgov/connect-nuxt",
   "license": "BSD-3-Clause",
   "main": "./nuxt.config.ts",
@@ -17,7 +17,7 @@
     "@sbc-connect/vitest-config": "0.0.6"
   },
   "dependencies": {
-    "@sbc-connect/nuxt-base": "0.1.29"
+    "@sbc-connect/nuxt-base": "0.3.0"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",