@flopay/shared 1.3.0 → 1.3.1

package/README.md

@@ -175,3 +175,28 @@ throw validationError('Email is required', 'email');
 | `getCurrencyByCountry(countryCode)` | Returns `CurrencyInfo` for a country code, falls back to USD |
 | `isValidPublishableKey(key)` | Returns `true` if the key matches `pk_(test|live)_...` |
 | `isValidSecretKey(key)` | Returns `true` if the key matches `sk_(test|live)_...` |
+
+### Postal Code Helpers
+
+Country-aware postcode format validation, backed by the [`validator`](https://www.npmjs.com/package/validator) package's `isPostalCode` (the same library the billing API uses, so client and server rules agree). `@flopay/react`'s AVS block uses these to block a malformed postcode before the card is captured and to show the expected format inline.
+
+| Export | Description |
+|--------|-------------|
+| `getPostalCodeLabel(countryCode)` | Country-appropriate field label (`'ZIP Code'`, `'Postcode'`, `'Eircode'`, …); defaults to `'Postal Code'` |
+| `isPostalCodeSupported(country)` | `true` when `validator` has a postcode pattern for the (ISO 3166-1 alpha-2, case-insensitive; `UK`→`GB`) country. Unsupported / no-postcode countries return `false` |
+| `isValidPostalCode(country, postalCode)` | `true` when the (trimmed) postcode matches the country's format. **Fails open** — unsupported / no-postcode countries always return `true`, so callers never block them. A supported country with an empty value returns `false`; check emptiness first to distinguish "required" from "malformed" |
+| `getPostalCodeExample(country)` | A curated example postcode for the field hint (US `12345 or 12345-6789`, GB `SW1A 1AA`, CA `A1A 1A1`, …), or `undefined` when there is no curated example |
+| `getStateFromPostalCode(country, postalCode)` | Derives a US state / CA province code from a postcode for AVS enrichment; `null` for other countries or a malformed code |
+
+```ts
+import { isPostalCodeSupported, isValidPostalCode, getPostalCodeExample } from '@flopay/shared';
+
+isPostalCodeSupported('US');            // true
+isPostalCodeSupported('AE');            // false — UAE has no postcodes
+isValidPostalCode('GB', 'SW1A 1AA');    // true
+isValidPostalCode('GB', '12345');       // false — US shape in GB
+isValidPostalCode('AE', '');            // true — fail open, never blocks
+getPostalCodeExample('CA');             // 'A1A 1A1'
+```
+
+> **Runtime dependency.** Unlike the rest of `@flopay/shared`, these helpers pull in `validator` (imported via the `validator/lib/isPostalCode.js` submodule so bundlers only include the one check). It installs transitively when you depend on `@flopay/shared`.

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,7 +17,15 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __toESM = (mod2, isNodeMode, target) => (target = mod2 != null ? __create(__getProtoOf(mod2)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod2 || !mod2.__esModule ? __defProp(target, "default", { value: mod2, enumerable: true }) : target,
+  mod2
+));
+var __toCommonJS = (mod2) => __copyProps(__defProp({}, "__esModule", { value: true }), mod2);
 
 // src/index.ts
 var index_exports = {};
@@ -75,6 +85,7 @@ __export(index_exports, {
   getCountryByCode: () => getCountryByCode,
   getCurrencyByCountry: () => getCurrencyByCountry,
   getFloPayEnvironment: () => getFloPayEnvironment,
+  getPostalCodeExample: () => getPostalCodeExample,
   getPostalCodeLabel: () => getPostalCodeLabel,
   getStateFromPostalCode: () => getStateFromPostalCode,
   getStateLabel: () => getStateLabel,
@@ -83,7 +94,9 @@ __export(index_exports, {
   hasVendoredStripeMethodLogo: () => hasVendoredStripeMethodLogo,
   isAVSEnabled: () => isAVSEnabled,
   isAVSFieldVisible: () => isAVSFieldVisible,
+  isPostalCodeSupported: () => isPostalCodeSupported,
   isSetupIntentClientSecret: () => isSetupIntentClientSecret,
+  isValidPostalCode: () => isValidPostalCode,
   isValidPublishableKey: () => isValidPublishableKey,
   isValidSecretKey: () => isValidSecretKey,
   needsStripeMethodExplicitConfirm: () => needsStripeMethodExplicitConfirm,
@@ -183,7 +196,7 @@ var PAYMENT_METHOD_LOGOS = {
 };
 
 // src/constants.ts
-var SDK_VERSION = "1.3.0";
+var SDK_VERSION = "1.3.1";
 var FLO_SDK_VERSION_HEADER = "x-flo-sdk-version";
 var BILLING_API_URL_STAGING = "https://api.stage.flopay.com";
 var BILLING_API_URL_PRODUCTION = "https://api.flopay.com";
@@ -1960,6 +1973,67 @@ function getStateFromPostalCode(country, postalCode) {
   }
 }
 
+// src/postal-code-validation.ts
+var isPostalCodeModule = __toESM(require("validator/lib/isPostalCode.js"), 1);
+var mod = isPostalCodeModule;
+var isPostalCode = typeof mod.default === "function" ? mod.default : mod.default?.default;
+if (typeof isPostalCode !== "function") {
+  throw new Error(
+    "validator/lib/isPostalCode.js interop failed: unexpected module shape. This likely means the bundler's CJS/ESM interop changed."
+  );
+}
+var SUPPORTED_LOCALES = new Set(
+  mod.locales.map((code) => code.toUpperCase())
+);
+var LOCALE_ALIASES = {
+  UK: "GB"
+};
+function normalizeCountry(country) {
+  const upper = country.trim().toUpperCase();
+  return LOCALE_ALIASES[upper] ?? upper;
+}
+var POSTAL_CODE_EXAMPLES = {
+  US: "12345 or 12345-6789",
+  GB: "SW1A 1AA",
+  CA: "A1A 1A1",
+  AU: "2000",
+  NZ: "6011",
+  IE: "D02 AF30",
+  DE: "10115",
+  FR: "75008",
+  NL: "1011 AB",
+  ES: "28001",
+  IT: "00100",
+  IN: "110001",
+  JP: "100-0001",
+  BR: "01310-100",
+  MX: "01000",
+  SE: "114 55",
+  CH: "8001",
+  PL: "00-001",
+  PT: "1000-001",
+  SG: "570150",
+  ZA: "0001",
+  NO: "0001",
+  DK: "1050",
+  FI: "00100",
+  AT: "1010",
+  BE: "1000",
+  CZ: "100 00"
+};
+function isPostalCodeSupported(country) {
+  if (!country) return false;
+  return SUPPORTED_LOCALES.has(normalizeCountry(country));
+}
+function isValidPostalCode(country, postalCode) {
+  if (!isPostalCodeSupported(country)) return true;
+  return isPostalCode(postalCode.trim(), normalizeCountry(country));
+}
+function getPostalCodeExample(country) {
+  if (!country) return void 0;
+  return POSTAL_CODE_EXAMPLES[normalizeCountry(country)];
+}
+
 // src/checkout-payload.ts
 function nonBlank(value) {
   if (typeof value !== "string") return void 0;
@@ -2217,6 +2291,7 @@ function isSetupIntentClientSecret(clientSecret) {
   getCountryByCode,
   getCurrencyByCountry,
   getFloPayEnvironment,
+  getPostalCodeExample,
   getPostalCodeLabel,
   getStateFromPostalCode,
   getStateLabel,
@@ -2225,7 +2300,9 @@ function isSetupIntentClientSecret(clientSecret) {
   hasVendoredStripeMethodLogo,
   isAVSEnabled,
   isAVSFieldVisible,
+  isPostalCodeSupported,
   isSetupIntentClientSecret,
+  isValidPostalCode,
   isValidPublishableKey,
   isValidSecretKey,
   needsStripeMethodExplicitConfirm,