Merge pull request #14 from revolut-engineering/export-widget-locale

docs(locale): expose type and relevant check

src/checks.ts

@@ -1,4 +1,6 @@
-import { ValidationError, RevolutCheckoutError } from './types'
+import { ValidationError, RevolutCheckoutError, Locale } from './types'
+
+import { LOCALES } from './constants'
 
 export function isValidationError(error?: Error): error is ValidationError {
   return error != null && error.name === 'Validation'
@@ -9,3 +11,7 @@ export function isRevolutCheckoutError(
 ): error is RevolutCheckoutError {
   return error != null && error.name === 'RevolutCheckout'
 }
+
+export function isValidLocale(locale: unknown): locale is Locale {
+  return locale && LOCALES.some((value) => value === locale)
+}

src/constants.ts

@@ -1,3 +1,16 @@
+export const LOCALES = [
+  'en',
+  'nl',
+  'fr',
+  'de',
+  'it',
+  'lt',
+  'pl',
+  'pt',
+  'es',
+  'cs',
+] as const
+
 export const MODE = {
   PRODUCTION: 'prod',
   DEVELOPMENT: 'dev',

src/index.ts

@@ -1,5 +1,9 @@
 export { RevolutCheckoutLoader as default } from './loader'
-export { isRevolutCheckoutError, isValidationError } from './checks'
+export {
+  isRevolutCheckoutError,
+  isValidationError,
+  isValidLocale,
+} from './checks'
 export {
   ValidationErrorType,
   ValidationError,
@@ -8,6 +12,7 @@ export {
   FieldStatus,
   FieldClasses,
   FieldStyles,
+  Locale,
   RevolutCheckoutCardField,
   RevolutCheckoutInstance,
 } from './types'

src/types.ts

@@ -1,4 +1,4 @@
-import { MODE } from './constants'
+import { MODE, LOCALES } from './constants'
 
 export type Mode = MODE[keyof MODE]
 
@@ -254,16 +254,7 @@ export type CountryCode =
   | 'QA'
   | 'MZ'
 
-export type Locale =
-  | 'en'
-  | 'nl'
-  | 'fr'
-  | 'de'
-  | 'it'
-  | 'lt'
-  | 'pl'
-  | 'pt'
-  | 'es'
+export type Locale = typeof LOCALES[number]
 
 export type ValidationErrorType =
   | 'validation.card.number.incomplete'