@koshmoney/countries 1.0.1-beta.1 → 1.0.1-beta.2

package/dist/index.d.cts

@@ -1,9 +1,29 @@
-export { C as Country, c as CountryCodeFormat, e as CountryData, d as CountryRecord, b as CountryWithSubdivisions, S as Subdivision, f as SubdivisionData, a as SubdivisionInfo } from './types-hSi1rgb5.cjs';
-import { whereAlpha2, whereAlpha3, whereNumeric, whereName, all, withSubdivisions, alpha2ToAlpha3, alpha3ToAlpha2, alpha2ToNumeric, alpha3ToNumeric, numericToAlpha2, numericToAlpha3, toName, convert, isAlpha2, isAlpha3, isNumeric, isCountryName, isValid, detectFormat } from './country/index.cjs';
+import { P as PostalCodeInfo } from './types-BK2zT8WM.cjs';
+export { C as Country, c as CountryCodeFormat, e as CountryData, d as CountryRecord, b as CountryWithSubdivisions, a as Subdivision, f as SubdivisionData, S as SubdivisionInfo } from './types-BK2zT8WM.cjs';
+import { whereAlpha2, whereAlpha3, whereNumeric, whereName, all, withSubdivisions, alpha2ToAlpha3, alpha3ToAlpha2, alpha2ToNumeric, alpha3ToNumeric, numericToAlpha2, numericToAlpha3, toName, convert, isAlpha2, isAlpha3, isNumeric, isCountryName, isValid, detectFormat, isValidPostalCode as isValid$1, hasPostalCode, getPostalCodePattern as getPattern, getPostalCodeFormat as getFormat, getPostalCodeName as getName, getPostalCodeInfo as getInfo } from './country/index.cjs';
 export { alpha3Index, countries, nameIndex, numericIndex, resolveAlpha2 } from './country/index.cjs';
 import { whereCode, where, whereName as whereName$1, forCountry, all as all$1, hasSubdivisions, toRegionCode, toFullCode, toName as toName$1, toNameFrom, toCountryCode, isValidCode, isValidRegion, isValidName } from './subdivision/index.cjs';
 export { getAllSubdivisions, getRegisteredCountries, getSubdivisions } from './subdivision/index.cjs';
 
+/**
+ * Postal code data for 200+ countries
+ *
+ * Data sources:
+ * - postcode-validator (MIT license): https://github.com/melwynfurtado/postcode-validator
+ * - Google libaddressinput: https://github.com/google/libaddressinput
+ * - Universal Postal Union (UPU): https://www.upu.int
+ */
+
+/**
+ * Postal code patterns, formats, and local names by country (alpha-2 code)
+ */
+declare const postalCodes: Record<string, PostalCodeInfo>;
+/**
+ * Countries that do not use postal codes
+ * Source: Universal Postal Union (UPU)
+ */
+declare const countriesWithoutPostalCodes: Set<string>;
+
 /**
  * iso-3166
  *
@@ -52,6 +72,12 @@ declare const country: {
     isCountryName: typeof isCountryName;
     isValid: typeof isValid;
     detectFormat: typeof detectFormat;
+    isValidPostalCode: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPostalCodePattern: typeof getPattern;
+    getPostalCodeFormat: typeof getFormat;
+    getPostalCodeName: typeof getName;
+    getPostalCodeInfo: typeof getInfo;
 };
 /**
  * Subdivision functions (ISO 3166-2)
@@ -72,10 +98,58 @@ declare const subdivision: {
     isValidRegion: typeof isValidRegion;
     isValidName: typeof isValidName;
 };
+/**
+ * Postal code functions
+ * Validates and looks up postal codes, ZIP codes, PIN codes worldwide
+ */
+declare const postalCode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
+/**
+ * Alias for postalCode (US terminology)
+ * @example zipCode.isValid('US', '90210')
+ */
+declare const zipCode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
+/**
+ * Alias for postalCode (India terminology)
+ * @example pinCode.isValid('IN', '110001')
+ */
+declare const pinCode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
+/**
+ * Alias for postalCode (UK/AU/NZ terminology)
+ * @example postcode.isValid('GB', 'SW1A 1AA')
+ */
+declare const postcode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
 
 /**
- * Default export for legacy compatibility
- * Provides both country and subdivision namespaces
+ * Default export for compatibility
+ * Provides country, subdivision, and postal code namespaces
  */
 declare const _default: {
     country: {
@@ -99,6 +173,12 @@ declare const _default: {
         isCountryName: typeof isCountryName;
         isValid: typeof isValid;
         detectFormat: typeof detectFormat;
+        isValidPostalCode: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPostalCodePattern: typeof getPattern;
+        getPostalCodeFormat: typeof getFormat;
+        getPostalCodeName: typeof getName;
+        getPostalCodeInfo: typeof getInfo;
     };
     subdivision: {
         whereCode: typeof whereCode;
@@ -116,6 +196,38 @@ declare const _default: {
         isValidRegion: typeof isValidRegion;
         isValidName: typeof isValidName;
     };
+    postalCode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
+    zipCode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
+    pinCode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
+    postcode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
 };
 
-export { all as allCountries, all$1 as allSubdivisions, alpha2ToAlpha3, alpha2ToNumeric, alpha3ToAlpha2, alpha3ToNumeric, convert as convertCountryCode, country, toName as countryToName, _default as default, detectFormat as detectCountryFormat, hasSubdivisions, isAlpha2, isAlpha3, isCountryName, isNumeric, isValid as isValidCountry, isValidRegion, isValidCode as isValidSubdivisionCode, isValidName as isValidSubdivisionName, numericToAlpha2, numericToAlpha3, subdivision, toCountryCode as subdivisionToCountryCode, toName$1 as subdivisionToName, toNameFrom as subdivisionToNameFrom, forCountry as subdivisionsForCountry, toFullCode, toRegionCode, whereAlpha2, whereAlpha3, whereName as whereCountry, whereNumeric, whereCode as whereSubdivision, whereName$1 as whereSubdivisionByName, where as whereSubdivisionByRegion, withSubdivisions };
+export { PostalCodeInfo, all as allCountries, all$1 as allSubdivisions, alpha2ToAlpha3, alpha2ToNumeric, alpha3ToAlpha2, alpha3ToNumeric, convert as convertCountryCode, countriesWithoutPostalCodes, country, toName as countryToName, _default as default, detectFormat as detectCountryFormat, getFormat as getPostalCodeFormat, getInfo as getPostalCodeInfo, getName as getPostalCodeName, getPattern as getPostalCodePattern, hasPostalCode, hasSubdivisions, isAlpha2, isAlpha3, isCountryName, isNumeric, isValid as isValidCountry, isValid$1 as isValidPostalCode, isValidRegion, isValidCode as isValidSubdivisionCode, isValidName as isValidSubdivisionName, numericToAlpha2, numericToAlpha3, pinCode, postalCode, postalCodes, postcode, subdivision, toCountryCode as subdivisionToCountryCode, toName$1 as subdivisionToName, toNameFrom as subdivisionToNameFrom, forCountry as subdivisionsForCountry, toFullCode, toRegionCode, whereAlpha2, whereAlpha3, whereName as whereCountry, whereNumeric, whereCode as whereSubdivision, whereName$1 as whereSubdivisionByName, where as whereSubdivisionByRegion, withSubdivisions, zipCode };

package/dist/index.d.ts

@@ -1,9 +1,29 @@
-export { C as Country, c as CountryCodeFormat, e as CountryData, d as CountryRecord, b as CountryWithSubdivisions, S as Subdivision, f as SubdivisionData, a as SubdivisionInfo } from './types-hSi1rgb5.js';
-import { whereAlpha2, whereAlpha3, whereNumeric, whereName, all, withSubdivisions, alpha2ToAlpha3, alpha3ToAlpha2, alpha2ToNumeric, alpha3ToNumeric, numericToAlpha2, numericToAlpha3, toName, convert, isAlpha2, isAlpha3, isNumeric, isCountryName, isValid, detectFormat } from './country/index.js';
+import { P as PostalCodeInfo } from './types-BK2zT8WM.js';
+export { C as Country, c as CountryCodeFormat, e as CountryData, d as CountryRecord, b as CountryWithSubdivisions, a as Subdivision, f as SubdivisionData, S as SubdivisionInfo } from './types-BK2zT8WM.js';
+import { whereAlpha2, whereAlpha3, whereNumeric, whereName, all, withSubdivisions, alpha2ToAlpha3, alpha3ToAlpha2, alpha2ToNumeric, alpha3ToNumeric, numericToAlpha2, numericToAlpha3, toName, convert, isAlpha2, isAlpha3, isNumeric, isCountryName, isValid, detectFormat, isValidPostalCode as isValid$1, hasPostalCode, getPostalCodePattern as getPattern, getPostalCodeFormat as getFormat, getPostalCodeName as getName, getPostalCodeInfo as getInfo } from './country/index.js';
 export { alpha3Index, countries, nameIndex, numericIndex, resolveAlpha2 } from './country/index.js';
 import { whereCode, where, whereName as whereName$1, forCountry, all as all$1, hasSubdivisions, toRegionCode, toFullCode, toName as toName$1, toNameFrom, toCountryCode, isValidCode, isValidRegion, isValidName } from './subdivision/index.js';
 export { getAllSubdivisions, getRegisteredCountries, getSubdivisions } from './subdivision/index.js';
 
+/**
+ * Postal code data for 200+ countries
+ *
+ * Data sources:
+ * - postcode-validator (MIT license): https://github.com/melwynfurtado/postcode-validator
+ * - Google libaddressinput: https://github.com/google/libaddressinput
+ * - Universal Postal Union (UPU): https://www.upu.int
+ */
+
+/**
+ * Postal code patterns, formats, and local names by country (alpha-2 code)
+ */
+declare const postalCodes: Record<string, PostalCodeInfo>;
+/**
+ * Countries that do not use postal codes
+ * Source: Universal Postal Union (UPU)
+ */
+declare const countriesWithoutPostalCodes: Set<string>;
+
 /**
  * iso-3166
  *
@@ -52,6 +72,12 @@ declare const country: {
     isCountryName: typeof isCountryName;
     isValid: typeof isValid;
     detectFormat: typeof detectFormat;
+    isValidPostalCode: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPostalCodePattern: typeof getPattern;
+    getPostalCodeFormat: typeof getFormat;
+    getPostalCodeName: typeof getName;
+    getPostalCodeInfo: typeof getInfo;
 };
 /**
  * Subdivision functions (ISO 3166-2)
@@ -72,10 +98,58 @@ declare const subdivision: {
     isValidRegion: typeof isValidRegion;
     isValidName: typeof isValidName;
 };
+/**
+ * Postal code functions
+ * Validates and looks up postal codes, ZIP codes, PIN codes worldwide
+ */
+declare const postalCode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
+/**
+ * Alias for postalCode (US terminology)
+ * @example zipCode.isValid('US', '90210')
+ */
+declare const zipCode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
+/**
+ * Alias for postalCode (India terminology)
+ * @example pinCode.isValid('IN', '110001')
+ */
+declare const pinCode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
+/**
+ * Alias for postalCode (UK/AU/NZ terminology)
+ * @example postcode.isValid('GB', 'SW1A 1AA')
+ */
+declare const postcode: {
+    isValid: typeof isValid$1;
+    hasPostalCode: typeof hasPostalCode;
+    getPattern: typeof getPattern;
+    getFormat: typeof getFormat;
+    getName: typeof getName;
+    getInfo: typeof getInfo;
+};
 
 /**
- * Default export for legacy compatibility
- * Provides both country and subdivision namespaces
+ * Default export for compatibility
+ * Provides country, subdivision, and postal code namespaces
  */
 declare const _default: {
     country: {
@@ -99,6 +173,12 @@ declare const _default: {
         isCountryName: typeof isCountryName;
         isValid: typeof isValid;
         detectFormat: typeof detectFormat;
+        isValidPostalCode: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPostalCodePattern: typeof getPattern;
+        getPostalCodeFormat: typeof getFormat;
+        getPostalCodeName: typeof getName;
+        getPostalCodeInfo: typeof getInfo;
     };
     subdivision: {
         whereCode: typeof whereCode;
@@ -116,6 +196,38 @@ declare const _default: {
         isValidRegion: typeof isValidRegion;
         isValidName: typeof isValidName;
     };
+    postalCode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
+    zipCode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
+    pinCode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
+    postcode: {
+        isValid: typeof isValid$1;
+        hasPostalCode: typeof hasPostalCode;
+        getPattern: typeof getPattern;
+        getFormat: typeof getFormat;
+        getName: typeof getName;
+        getInfo: typeof getInfo;
+    };
 };
 
-export { all as allCountries, all$1 as allSubdivisions, alpha2ToAlpha3, alpha2ToNumeric, alpha3ToAlpha2, alpha3ToNumeric, convert as convertCountryCode, country, toName as countryToName, _default as default, detectFormat as detectCountryFormat, hasSubdivisions, isAlpha2, isAlpha3, isCountryName, isNumeric, isValid as isValidCountry, isValidRegion, isValidCode as isValidSubdivisionCode, isValidName as isValidSubdivisionName, numericToAlpha2, numericToAlpha3, subdivision, toCountryCode as subdivisionToCountryCode, toName$1 as subdivisionToName, toNameFrom as subdivisionToNameFrom, forCountry as subdivisionsForCountry, toFullCode, toRegionCode, whereAlpha2, whereAlpha3, whereName as whereCountry, whereNumeric, whereCode as whereSubdivision, whereName$1 as whereSubdivisionByName, where as whereSubdivisionByRegion, withSubdivisions };
+export { PostalCodeInfo, all as allCountries, all$1 as allSubdivisions, alpha2ToAlpha3, alpha2ToNumeric, alpha3ToAlpha2, alpha3ToNumeric, convert as convertCountryCode, countriesWithoutPostalCodes, country, toName as countryToName, _default as default, detectFormat as detectCountryFormat, getFormat as getPostalCodeFormat, getInfo as getPostalCodeInfo, getName as getPostalCodeName, getPattern as getPostalCodePattern, hasPostalCode, hasSubdivisions, isAlpha2, isAlpha3, isCountryName, isNumeric, isValid as isValidCountry, isValid$1 as isValidPostalCode, isValidRegion, isValidCode as isValidSubdivisionCode, isValidName as isValidSubdivisionName, numericToAlpha2, numericToAlpha3, pinCode, postalCode, postalCodes, postcode, subdivision, toCountryCode as subdivisionToCountryCode, toName$1 as subdivisionToName, toNameFrom as subdivisionToNameFrom, forCountry as subdivisionsForCountry, toFullCode, toRegionCode, whereAlpha2, whereAlpha3, whereName as whereCountry, whereNumeric, whereCode as whereSubdivision, whereName$1 as whereSubdivisionByName, where as whereSubdivisionByRegion, withSubdivisions, zipCode };