@gusto/embedded-react-sdk 0.46.3 → 0.47.1

package/dist/helpers/formattedStrings.js.map

@@ -1 +1 @@
-{"version":3,"file":"formattedStrings.js","sources":["../../src/helpers/formattedStrings.ts"],"sourcesContent":["import DOMPurify from 'dompurify'\nimport { type Location } from '@gusto/embedded-api/models/components/location'\nimport { type EmployeeAddress } from '@gusto/embedded-api/models/components/employeeaddress'\nimport { type TFunction } from 'i18next'\nimport { useTranslation } from 'react-i18next'\nimport { useCallback } from 'react'\nimport { useLocale } from '@/contexts/LocaleProvider/useLocale'\n\nconst capitalize = (word: string) => word.charAt(0).toLocaleUpperCase() + word.slice(1)\n\nexport const firstLastName = ({\n  first_name,\n  last_name,\n}: {\n  first_name?: string | null\n  last_name?: string | null\n}) =>\n  `${first_name ? capitalize(first_name) : ''}${last_name ? maybeString(capitalize(last_name)) : ''}`\n\nconst maybeString = (str: string | null | undefined) => {\n  return str ? ` ${str}` : ''\n}\n\nexport const getStreet = (address: EmployeeAddress | Location) => {\n  const street1 = maybeString(address.street1)\n  const street2 = maybeString(address.street2)\n\n  return `${street1},${street2}`\n}\n\n/** Joins street lines with a comma for display (avoids getStreet’s leading-space/comma quirks). */\nexport const formatStreetForDisplay = (address: EmployeeAddress | Location) => {\n  const parts = [address.street1?.trim(), address.street2?.trim()].filter((part): part is string =>\n    Boolean(part),\n  )\n  return parts.join(', ')\n}\n\nexport const getCityStateZip = (address: EmployeeAddress | Location) =>\n  `${maybeString(address.city)}, ${maybeString(address.state)} ${maybeString(address.zip)}`\n\nexport const addressInline = (address: EmployeeAddress | Location) =>\n  `${getStreet(address)} ${getCityStateZip(address)}`\n\nexport const currentDateString = () => {\n  const d = new Date()\n  const dateString = `${String(d.getFullYear())}-${('0' + String(d.getMonth() + 1)).slice(-2)}-${('0' + String(d.getDate())).slice(-2)}`\n  return dateString\n}\n\nexport function isNumberKey({ which, keyCode }: KeyboardEvent) {\n  const charCode = which ? which : keyCode\n  if (charCode > 31 && charCode != 46 && (charCode < 48 || charCode > 57)) return false\n  return true\n}\n\nexport const booleanToString = (value: boolean) => (value ? 'true' : 'false')\n\nexport const amountStr = (amount: string, isPercentage: boolean) =>\n  isPercentage ? `${amount}%` : `$${amount}`\n\nexport const formatNumberAsCurrency = (amount: number, locale: string = 'en-US') => {\n  const formattedNumber = amount.toLocaleString(locale, {\n    minimumFractionDigits: 2,\n    maximumFractionDigits: 2,\n  })\n  return amountStr(formattedNumber, false)\n}\n\nexport const formatPayRate = ({\n  rate,\n  paymentUnit,\n  t,\n  locale = 'en-US',\n}: {\n  rate: number\n  paymentUnit: string\n  t: TFunction\n  locale?: string\n}) => {\n  const amount = formatNumberAsCurrency(rate, locale)\n\n  switch (paymentUnit) {\n    case 'Hour':\n      return t('payRateFormats.hourly', { amount, ns: 'common' })\n    case 'Week':\n      return t('payRateFormats.weekly', {\n        amount: formatNumberAsCurrency(rate * 52, locale),\n        ns: 'common',\n      })\n    case 'Month':\n      return t('payRateFormats.monthly', {\n        amount: formatNumberAsCurrency(rate * 12, locale),\n        ns: 'common',\n      })\n    case 'Year':\n      return t('payRateFormats.yearly', { amount, ns: 'common' })\n    case 'Paycheck':\n      return t('payRateFormats.paycheck', { amount, ns: 'common' })\n    default:\n      return amount\n  }\n}\n\nexport const useFormatPayRate = () => {\n  const { t } = useTranslation('common')\n  const { locale } = useLocale()\n\n  return useCallback(\n    (rate: number, paymentUnit: string) => {\n      return formatPayRate({ rate, paymentUnit, t, locale })\n    },\n    [t, locale],\n  )\n}\n\n/**\n * Formats a compensation rate as-is, without annualizing weekly or monthly\n * values. Use this for displaying compensation card data where the stored rate\n * should be shown directly (e.g. \"$950 per week\", \"$3,500 per month\").\n */\nexport const formatCompensationRate = ({\n  rate,\n  paymentUnit,\n  t,\n  locale = 'en-US',\n}: {\n  rate: number\n  paymentUnit: string\n  t: TFunction\n  locale?: string\n}) => {\n  const amount = formatNumberAsCurrency(rate, locale)\n\n  switch (paymentUnit) {\n    case 'Hour':\n      return t('compensationRateFormats.hourly', { amount, ns: 'common' })\n    case 'Week':\n      return t('compensationRateFormats.weekly', { amount, ns: 'common' })\n    case 'Month':\n      return t('compensationRateFormats.monthly', { amount, ns: 'common' })\n    case 'Year':\n      return t('compensationRateFormats.yearly', { amount, ns: 'common' })\n    case 'Paycheck':\n      return t('compensationRateFormats.paycheck', { amount, ns: 'common' })\n    default:\n      return amount\n  }\n}\n\nexport const useFormatCompensationRate = () => {\n  const { t } = useTranslation('common')\n  const { locale } = useLocale()\n\n  return useCallback(\n    (rate: number, paymentUnit: string) => {\n      return formatCompensationRate({ rate, paymentUnit, t, locale })\n    },\n    [t, locale],\n  )\n}\n\nconst dompurifyConfig = { ALLOWED_TAGS: ['a', 'b', 'strong'], ALLOWED_ATTR: ['href', 'target'] }\nexport function createMarkup(dirty: string) {\n  if (!dirty) return { __html: '' }\n  return { __html: DOMPurify.sanitize(dirty, dompurifyConfig) }\n}\n\nexport const removeNonDigits = (value: string): string => {\n  return value.replace(/\\D/g, '')\n}\n\nexport const normalizeErrorKeyForForm = (errorKey: string): string =>\n  errorKey.replace(/\\.value$/, '')\n\nexport const snakeCaseToCamelCase = (s: string) => {\n  return s.replace(/_([a-z])/g, (_: string, char: string) => char.toUpperCase())\n}\n\nexport const camelCaseToSnakeCase = (s: string) => {\n  return s\n    .replace(\n      /([a-z0-9])([A-Z])/g,\n      (_: string, group1: string, group2: string) => `${group1}_${group2.toLowerCase()}`,\n    )\n    .replace(\n      /([A-Z])([A-Z])(?=[a-z])/g,\n      (_: string, group1: string, group2: string) =>\n        `${group1.toLowerCase()}_${group2.toLowerCase()}`,\n    )\n    .toLowerCase()\n}\n\nexport const formatPhoneNumber = (phoneNumber: string | number | null | undefined): string => {\n  if (!phoneNumber) return ''\n\n  const digits = removeNonDigits(String(phoneNumber))\n\n  if (digits.length === 10) {\n    return `${digits.slice(0, 3)}-${digits.slice(3, 6)}-${digits.slice(6)}`\n  }\n\n  if (digits.length === 11 && digits.startsWith('1')) {\n    return `${digits.slice(1, 4)}-${digits.slice(4, 7)}-${digits.slice(7)}`\n  }\n\n  return digits || ''\n}\n"],"names":["capitalize","word","firstLastName","first_name","last_name","maybeString","str","getStreet","address","street1","street2","formatStreetForDisplay","part","getCityStateZip","addressInline","amountStr","amount","isPercentage","formatNumberAsCurrency","locale","formattedNumber","formatPayRate","rate","paymentUnit","t","formatCompensationRate","useFormatCompensationRate","useTranslation","useLocale","useCallback","dompurifyConfig","createMarkup","dirty","DOMPurify","removeNonDigits","value","normalizeErrorKeyForForm","errorKey","snakeCaseToCamelCase","s","_","char","formatPhoneNumber","phoneNumber","digits"],"mappings":";;;;AAQA,MAAMA,IAAa,CAACC,MAAiBA,EAAK,OAAO,CAAC,EAAE,sBAAsBA,EAAK,MAAM,CAAC,GAEzEC,IAAgB,CAAC;AAAA,EAC5B,YAAAC;AAAA,EACA,WAAAC;AACF,MAIE,GAAGD,IAAaH,EAAWG,CAAU,IAAI,EAAE,GAAGC,IAAYC,EAAYL,EAAWI,CAAS,CAAC,IAAI,EAAE,IAE7FC,IAAc,CAACC,MACZA,IAAM,IAAIA,CAAG,KAAK,IAGdC,IAAY,CAACC,MAAwC;AAChE,QAAMC,IAAUJ,EAAYG,EAAQ,OAAO,GACrCE,IAAUL,EAAYG,EAAQ,OAAO;AAE3C,SAAO,GAAGC,CAAO,IAAIC,CAAO;AAC9B,GAGaC,IAAyB,CAACH,MACvB,CAACA,EAAQ,SAAS,QAAQA,EAAQ,SAAS,KAAA,CAAM,EAAE;AAAA,EAAO,CAACI,MACvE,EAAQA;AAAI,EAED,KAAK,IAAI,GAGXC,IAAkB,CAACL,MAC9B,GAAGH,EAAYG,EAAQ,IAAI,CAAC,KAAKH,EAAYG,EAAQ,KAAK,CAAC,IAAIH,EAAYG,EAAQ,GAAG,CAAC,IAE5EM,IAAgB,CAACN,MAC5B,GAAGD,EAAUC,CAAO,CAAC,IAAIK,EAAgBL,CAAO,CAAC,IAgBtCO,IAAY,CAACC,GAAgBC,MACxCA,IAAe,GAAGD,CAAM,MAAM,IAAIA,CAAM,IAE7BE,IAAyB,CAACF,GAAgBG,IAAiB,YAAY;AAClF,QAAMC,IAAkBJ,EAAO,eAAeG,GAAQ;AAAA,IACpD,uBAAuB;AAAA,IACvB,uBAAuB;AAAA,EAAA,CACxB;AACD,SAAOJ,EAAUK,GAAiB,EAAK;AACzC,GAEaC,IAAgB,CAAC;AAAA,EAC5B,MAAAC;AAAA,EACA,aAAAC;AAAA,EACA,GAAAC;AAAA,EACA,QAAAL,IAAS;AACX,MAKM;AACJ,QAAMH,IAASE,EAAuBI,GAAMH,CAAM;AAElD,UAAQI,GAAA;AAAA,IACN,KAAK;AACH,aAAOC,EAAE,yBAAyB,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IAC5D,KAAK;AACH,aAAOQ,EAAE,yBAAyB;AAAA,QAChC,QAAQN,EAAuBI,IAAO,IAAIH,CAAM;AAAA,QAChD,IAAI;AAAA,MAAA,CACL;AAAA,IACH,KAAK;AACH,aAAOK,EAAE,0BAA0B;AAAA,QACjC,QAAQN,EAAuBI,IAAO,IAAIH,CAAM;AAAA,QAChD,IAAI;AAAA,MAAA,CACL;AAAA,IACH,KAAK;AACH,aAAOK,EAAE,yBAAyB,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IAC5D,KAAK;AACH,aAAOQ,EAAE,2BAA2B,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IAC9D;AACE,aAAOA;AAAA,EAAA;AAEb,GAmBaS,IAAyB,CAAC;AAAA,EACrC,MAAAH;AAAA,EACA,aAAAC;AAAA,EACA,GAAAC;AAAA,EACA,QAAAL,IAAS;AACX,MAKM;AACJ,QAAMH,IAASE,EAAuBI,GAAMH,CAAM;AAElD,UAAQI,GAAA;AAAA,IACN,KAAK;AACH,aAAOC,EAAE,kCAAkC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACrE,KAAK;AACH,aAAOQ,EAAE,kCAAkC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACrE,KAAK;AACH,aAAOQ,EAAE,mCAAmC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACtE,KAAK;AACH,aAAOQ,EAAE,kCAAkC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACrE,KAAK;AACH,aAAOQ,EAAE,oCAAoC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACvE;AACE,aAAOA;AAAA,EAAA;AAEb,GAEaU,IAA4B,MAAM;AAC7C,QAAM,EAAE,EAAA,IAAMC,EAAe,QAAQ,GAC/B,EAAE,QAAAR,EAAA,IAAWS,EAAA;AAEnB,SAAOC;AAAA,IACL,CAACP,GAAcC,MACNE,EAAuB,EAAE,MAAAH,GAAM,aAAAC,GAAa,GAAG,QAAAJ,GAAQ;AAAA,IAEhE,CAAC,GAAGA,CAAM;AAAA,EAAA;AAEd,GAEMW,IAAkB,EAAE,cAAc,CAAC,KAAK,KAAK,QAAQ,GAAG,cAAc,CAAC,QAAQ,QAAQ,EAAA;AACtF,SAASC,EAAaC,GAAe;AAC1C,SAAKA,IACE,EAAE,QAAQC,EAAU,SAASD,GAAOF,CAAe,EAAA,IADvC,EAAE,QAAQ,GAAA;AAE/B;AAEO,MAAMI,IAAkB,CAACC,MACvBA,EAAM,QAAQ,OAAO,EAAE,GAGnBC,IAA2B,CAACC,MACvCA,EAAS,QAAQ,YAAY,EAAE,GAEpBC,IAAuB,CAACC,MAC5BA,EAAE,QAAQ,aAAa,CAACC,GAAWC,MAAiBA,EAAK,aAAa,GAiBlEC,IAAoB,CAACC,MAA4D;AAC5F,MAAI,CAACA,EAAa,QAAO;AAEzB,QAAMC,IAASV,EAAgB,OAAOS,CAAW,CAAC;AAElD,SAAIC,EAAO,WAAW,KACb,GAAGA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,CAAC,CAAC,KAGnEA,EAAO,WAAW,MAAMA,EAAO,WAAW,GAAG,IACxC,GAAGA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,CAAC,CAAC,KAGhEA,KAAU;AACnB;"}
+{"version":3,"file":"formattedStrings.js","sources":["../../src/helpers/formattedStrings.ts"],"sourcesContent":["import DOMPurify from 'dompurify'\nimport { type Location } from '@gusto/embedded-api-v-2025-11-15/models/components/location'\nimport { type EmployeeAddress } from '@gusto/embedded-api-v-2025-11-15/models/components/employeeaddress'\nimport { type TFunction } from 'i18next'\nimport { useTranslation } from 'react-i18next'\nimport { useCallback } from 'react'\nimport { useLocale } from '@/contexts/LocaleProvider/useLocale'\n\nconst capitalize = (word: string) => word.charAt(0).toLocaleUpperCase() + word.slice(1)\n\n/**\n * Joins a first and last name into a single capitalized display string.\n *\n * @remarks Each name part is capitalized at its first character. A space is\n * inserted between the parts only when the last name is present. Missing\n * parts are treated as empty.\n *\n * @param name - Object with optional `first_name` and `last_name` fields.\n * @returns The combined name, e.g. `Jane Doe`, `Jane`, or `''`.\n * @internal\n */\nexport const firstLastName = ({\n  first_name,\n  last_name,\n}: {\n  first_name?: string | null\n  last_name?: string | null\n}) =>\n  `${first_name ? capitalize(first_name) : ''}${last_name ? maybeString(capitalize(last_name)) : ''}`\n\nconst maybeString = (str: string | null | undefined) => {\n  return str ? ` ${str}` : ''\n}\n\n/**\n * Combines an address's two street lines with a comma separator.\n *\n * @remarks Each line is prefixed with a leading space when present, producing\n * a string like ` 123 Main St, Apt 4`. Prefer {@link formatStreetForDisplay}\n * for new display code; this function is retained for legacy callers.\n *\n * @param address - Address whose `street1` and `street2` are joined.\n * @returns The joined street string.\n * @internal\n */\nexport const getStreet = (address: EmployeeAddress | Location) => {\n  const street1 = maybeString(address.street1)\n  const street2 = maybeString(address.street2)\n\n  return `${street1},${street2}`\n}\n\n/**\n * Joins an address's street lines with a comma for display.\n *\n * @remarks Trims each line and skips empty values, avoiding the leading-space\n * and trailing-comma artifacts of {@link getStreet}.\n *\n * @param address - Address whose `street1` and `street2` are joined.\n * @returns The display-formatted street string, e.g. `123 Main St, Apt 4`.\n * @internal\n */\nexport const formatStreetForDisplay = (address: EmployeeAddress | Location) => {\n  const parts = [address.street1?.trim(), address.street2?.trim()].filter((part): part is string =>\n    Boolean(part),\n  )\n  return parts.join(', ')\n}\n\n/**\n * Formats an address's city, state, and zip into a single display string.\n *\n * @param address - Address whose `city`, `state`, and `zip` are joined.\n * @returns A `City, State Zip` string. Empty fields are skipped.\n * @internal\n */\nexport const getCityStateZip = (address: EmployeeAddress | Location) =>\n  `${maybeString(address.city)}, ${maybeString(address.state)} ${maybeString(address.zip)}`\n\n/**\n * Formats a full address as a single inline string.\n *\n * @param address - The address to format.\n * @returns The combined street and city/state/zip string.\n * @internal\n */\nexport const addressInline = (address: EmployeeAddress | Location) =>\n  `${getStreet(address)} ${getCityStateZip(address)}`\n\n/**\n * Wraps an amount string with a currency or percent symbol.\n *\n * @param amount - Pre-formatted numeric string.\n * @param isPercentage - When `true`, appends `%`; otherwise prepends `$`.\n * @returns The amount with the appropriate symbol.\n * @internal\n */\nconst amountStr = (amount: string, isPercentage: boolean) =>\n  isPercentage ? `${amount}%` : `$${amount}`\n\n/**\n * Formats a number as a USD currency string with two decimal places.\n *\n * @param amount - The numeric value to format.\n * @param locale - Optional BCP 47 locale tag passed to `toLocaleString`.\n * Defaults to `en-US`.\n * @returns A `$1,234.56` style currency string.\n * @internal\n */\nexport const formatNumberAsCurrency = (amount: number, locale: string = 'en-US') => {\n  const formattedNumber = amount.toLocaleString(locale, {\n    minimumFractionDigits: 2,\n    maximumFractionDigits: 2,\n  })\n  return amountStr(formattedNumber, false)\n}\n\n/**\n * Formats a pay rate with its payment unit, annualizing weekly and monthly values.\n *\n * @remarks Hourly, yearly, and paycheck rates are displayed at the input\n * value. Weekly rates are multiplied by 52 and monthly rates by 12 to express\n * an annualized amount. Unknown payment units render as the currency value\n * alone.\n *\n * @param args - Formatting inputs: `rate` (numeric value), `paymentUnit`\n * (`Hour`, `Week`, `Month`, `Year`, or `Paycheck`), `t` (i18next translation\n * function), and optional `locale` (BCP 47 tag, default `en-US`).\n * @returns The translated, formatted pay rate string.\n * @internal\n */\nexport const formatPayRate = ({\n  rate,\n  paymentUnit,\n  t,\n  locale = 'en-US',\n}: {\n  rate: number\n  paymentUnit: string\n  t: TFunction\n  locale?: string\n}) => {\n  const amount = formatNumberAsCurrency(rate, locale)\n\n  switch (paymentUnit) {\n    case 'Hour':\n      return t('payRateFormats.hourly', { amount, ns: 'common' })\n    case 'Week':\n      return t('payRateFormats.weekly', {\n        amount: formatNumberAsCurrency(rate * 52, locale),\n        ns: 'common',\n      })\n    case 'Month':\n      return t('payRateFormats.monthly', {\n        amount: formatNumberAsCurrency(rate * 12, locale),\n        ns: 'common',\n      })\n    case 'Year':\n      return t('payRateFormats.yearly', { amount, ns: 'common' })\n    case 'Paycheck':\n      return t('payRateFormats.paycheck', { amount, ns: 'common' })\n    default:\n      return amount\n  }\n}\n\n/**\n * Formats a compensation rate as-is, without annualizing weekly or monthly values.\n *\n * @remarks Use for displaying compensation card data where the stored rate\n * should be shown directly (e.g. `$950 per week`, `$3,500 per month`).\n * Unknown payment units render as the currency value alone.\n *\n * @param args - Formatting inputs: `rate` (numeric value), `paymentUnit`\n * (`Hour`, `Week`, `Month`, `Year`, or `Paycheck`), `t` (i18next translation\n * function), and optional `locale` (BCP 47 tag, default `en-US`).\n * @returns The translated, formatted compensation rate string.\n * @internal\n */\nexport const formatCompensationRate = ({\n  rate,\n  paymentUnit,\n  t,\n  locale = 'en-US',\n}: {\n  rate: number\n  paymentUnit: string\n  t: TFunction\n  locale?: string\n}) => {\n  const amount = formatNumberAsCurrency(rate, locale)\n\n  switch (paymentUnit) {\n    case 'Hour':\n      return t('compensationRateFormats.hourly', { amount, ns: 'common' })\n    case 'Week':\n      return t('compensationRateFormats.weekly', { amount, ns: 'common' })\n    case 'Month':\n      return t('compensationRateFormats.monthly', { amount, ns: 'common' })\n    case 'Year':\n      return t('compensationRateFormats.yearly', { amount, ns: 'common' })\n    case 'Paycheck':\n      return t('compensationRateFormats.paycheck', { amount, ns: 'common' })\n    default:\n      return amount\n  }\n}\n\n/**\n * Hook that returns a memoized {@link formatCompensationRate} bound to the active locale.\n *\n * @returns A callback `(rate, paymentUnit) => string`.\n * @internal\n */\nexport const useFormatCompensationRate = () => {\n  const { t } = useTranslation('common')\n  const { locale } = useLocale()\n\n  return useCallback(\n    (rate: number, paymentUnit: string) => {\n      return formatCompensationRate({ rate, paymentUnit, t, locale })\n    },\n    [t, locale],\n  )\n}\n\nconst dompurifyConfig = { ALLOWED_TAGS: ['a', 'b', 'strong'], ALLOWED_ATTR: ['href', 'target'] }\n/**\n * Sanitizes an HTML string for use with React's `dangerouslySetInnerHTML`.\n *\n * @remarks Only `<a>`, `<b>`, and `<strong>` tags are allowed, and `<a>`\n * elements may retain only `href` and `target` attributes. All other markup\n * is stripped via DOMPurify.\n *\n * @param dirty - The raw HTML string to sanitize.\n * @returns An object shaped for `dangerouslySetInnerHTML`. The `__html`\n * field is `''` when the input is empty.\n * @internal\n */\nexport function createMarkup(dirty: string) {\n  if (!dirty) return { __html: '' }\n  return { __html: DOMPurify.sanitize(dirty, dompurifyConfig) }\n}\n\n/**\n * Removes all non-digit characters from a string.\n *\n * @param value - The string to filter.\n * @returns The input with only the digit characters `0`–`9` retained.\n * @internal\n */\nexport const removeNonDigits = (value: string): string => {\n  return value.replace(/\\D/g, '')\n}\n\n/**\n * Strips the trailing `.value` segment from an API error path.\n *\n * @remarks API validation errors target a `.value` field on the inner\n * object, but react-hook-form registers the field under its bare name.\n * Stripping `.value` aligns the error path with the form field name.\n *\n * @param errorKey - The dotted error path returned by the API.\n * @returns The error key without a trailing `.value`.\n * @internal\n */\nexport const normalizeErrorKeyForForm = (errorKey: string): string =>\n  errorKey.replace(/\\.value$/, '')\n\n/**\n * Converts a `snake_case` string to `camelCase`.\n *\n * @param s - The snake_case string to convert.\n * @returns The camelCase equivalent.\n * @internal\n */\nexport const snakeCaseToCamelCase = (s: string) => {\n  return s.replace(/_([a-z])/g, (_: string, char: string) => char.toUpperCase())\n}\n\n/**\n * Converts a `camelCase` or `PascalCase` string to `snake_case`.\n *\n * @remarks Handles consecutive uppercase letters by inserting a separator\n * before the final letter of a run that is followed by a lowercase letter\n * (e.g. `HTMLParser` becomes `html_parser`).\n *\n * @param s - The camelCase or PascalCase string to convert.\n * @returns The snake_case equivalent in lower case.\n * @internal\n */\nexport const camelCaseToSnakeCase = (s: string) => {\n  return s\n    .replace(\n      /([a-z0-9])([A-Z])/g,\n      (_: string, group1: string, group2: string) => `${group1}_${group2.toLowerCase()}`,\n    )\n    .replace(\n      /([A-Z])([A-Z])(?=[a-z])/g,\n      (_: string, group1: string, group2: string) =>\n        `${group1.toLowerCase()}_${group2.toLowerCase()}`,\n    )\n    .toLowerCase()\n}\n\n/**\n * Formats a US phone number as `NNN-NNN-NNNN` for display.\n *\n * @remarks Strips non-digit characters before formatting. A leading `1`\n * country code on 11-digit inputs is dropped. Inputs that are not 10 or 11\n * digits are returned as the raw digit string. Returns an empty string for\n * nullish input.\n *\n * @param phoneNumber - The phone number to format.\n * @returns The formatted phone number, the digit-only fallback, or `''`.\n * @internal\n */\nexport const formatPhoneNumber = (phoneNumber: string | number | null | undefined): string => {\n  if (!phoneNumber) return ''\n\n  const digits = removeNonDigits(String(phoneNumber))\n\n  if (digits.length === 10) {\n    return `${digits.slice(0, 3)}-${digits.slice(3, 6)}-${digits.slice(6)}`\n  }\n\n  if (digits.length === 11 && digits.startsWith('1')) {\n    return `${digits.slice(1, 4)}-${digits.slice(4, 7)}-${digits.slice(7)}`\n  }\n\n  return digits || ''\n}\n"],"names":["capitalize","word","firstLastName","first_name","last_name","maybeString","str","getStreet","address","street1","street2","formatStreetForDisplay","part","getCityStateZip","addressInline","amountStr","amount","isPercentage","formatNumberAsCurrency","locale","formattedNumber","formatPayRate","rate","paymentUnit","t","formatCompensationRate","useFormatCompensationRate","useTranslation","useLocale","useCallback","dompurifyConfig","createMarkup","dirty","DOMPurify","removeNonDigits","value","normalizeErrorKeyForForm","errorKey","snakeCaseToCamelCase","s","_","char","formatPhoneNumber","phoneNumber","digits"],"mappings":";;;;AAQA,MAAMA,IAAa,CAACC,MAAiBA,EAAK,OAAO,CAAC,EAAE,sBAAsBA,EAAK,MAAM,CAAC,GAazEC,IAAgB,CAAC;AAAA,EAC5B,YAAAC;AAAA,EACA,WAAAC;AACF,MAIE,GAAGD,IAAaH,EAAWG,CAAU,IAAI,EAAE,GAAGC,IAAYC,EAAYL,EAAWI,CAAS,CAAC,IAAI,EAAE,IAE7FC,IAAc,CAACC,MACZA,IAAM,IAAIA,CAAG,KAAK,IAcdC,IAAY,CAACC,MAAwC;AAChE,QAAMC,IAAUJ,EAAYG,EAAQ,OAAO,GACrCE,IAAUL,EAAYG,EAAQ,OAAO;AAE3C,SAAO,GAAGC,CAAO,IAAIC,CAAO;AAC9B,GAYaC,IAAyB,CAACH,MACvB,CAACA,EAAQ,SAAS,QAAQA,EAAQ,SAAS,KAAA,CAAM,EAAE;AAAA,EAAO,CAACI,MACvE,EAAQA;AAAI,EAED,KAAK,IAAI,GAUXC,IAAkB,CAACL,MAC9B,GAAGH,EAAYG,EAAQ,IAAI,CAAC,KAAKH,EAAYG,EAAQ,KAAK,CAAC,IAAIH,EAAYG,EAAQ,GAAG,CAAC,IAS5EM,IAAgB,CAACN,MAC5B,GAAGD,EAAUC,CAAO,CAAC,IAAIK,EAAgBL,CAAO,CAAC,IAU7CO,IAAY,CAACC,GAAgBC,MACjCA,IAAe,GAAGD,CAAM,MAAM,IAAIA,CAAM,IAW7BE,IAAyB,CAACF,GAAgBG,IAAiB,YAAY;AAClF,QAAMC,IAAkBJ,EAAO,eAAeG,GAAQ;AAAA,IACpD,uBAAuB;AAAA,IACvB,uBAAuB;AAAA,EAAA,CACxB;AACD,SAAOJ,EAAUK,GAAiB,EAAK;AACzC,GAgBaC,IAAgB,CAAC;AAAA,EAC5B,MAAAC;AAAA,EACA,aAAAC;AAAA,EACA,GAAAC;AAAA,EACA,QAAAL,IAAS;AACX,MAKM;AACJ,QAAMH,IAASE,EAAuBI,GAAMH,CAAM;AAElD,UAAQI,GAAA;AAAA,IACN,KAAK;AACH,aAAOC,EAAE,yBAAyB,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IAC5D,KAAK;AACH,aAAOQ,EAAE,yBAAyB;AAAA,QAChC,QAAQN,EAAuBI,IAAO,IAAIH,CAAM;AAAA,QAChD,IAAI;AAAA,MAAA,CACL;AAAA,IACH,KAAK;AACH,aAAOK,EAAE,0BAA0B;AAAA,QACjC,QAAQN,EAAuBI,IAAO,IAAIH,CAAM;AAAA,QAChD,IAAI;AAAA,MAAA,CACL;AAAA,IACH,KAAK;AACH,aAAOK,EAAE,yBAAyB,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IAC5D,KAAK;AACH,aAAOQ,EAAE,2BAA2B,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IAC9D;AACE,aAAOA;AAAA,EAAA;AAEb,GAeaS,IAAyB,CAAC;AAAA,EACrC,MAAAH;AAAA,EACA,aAAAC;AAAA,EACA,GAAAC;AAAA,EACA,QAAAL,IAAS;AACX,MAKM;AACJ,QAAMH,IAASE,EAAuBI,GAAMH,CAAM;AAElD,UAAQI,GAAA;AAAA,IACN,KAAK;AACH,aAAOC,EAAE,kCAAkC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACrE,KAAK;AACH,aAAOQ,EAAE,kCAAkC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACrE,KAAK;AACH,aAAOQ,EAAE,mCAAmC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACtE,KAAK;AACH,aAAOQ,EAAE,kCAAkC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACrE,KAAK;AACH,aAAOQ,EAAE,oCAAoC,EAAE,QAAAR,GAAQ,IAAI,UAAU;AAAA,IACvE;AACE,aAAOA;AAAA,EAAA;AAEb,GAQaU,IAA4B,MAAM;AAC7C,QAAM,EAAE,EAAA,IAAMC,EAAe,QAAQ,GAC/B,EAAE,QAAAR,EAAA,IAAWS,EAAA;AAEnB,SAAOC;AAAA,IACL,CAACP,GAAcC,MACNE,EAAuB,EAAE,MAAAH,GAAM,aAAAC,GAAa,GAAG,QAAAJ,GAAQ;AAAA,IAEhE,CAAC,GAAGA,CAAM;AAAA,EAAA;AAEd,GAEMW,IAAkB,EAAE,cAAc,CAAC,KAAK,KAAK,QAAQ,GAAG,cAAc,CAAC,QAAQ,QAAQ,EAAA;AAatF,SAASC,EAAaC,GAAe;AAC1C,SAAKA,IACE,EAAE,QAAQC,EAAU,SAASD,GAAOF,CAAe,EAAA,IADvC,EAAE,QAAQ,GAAA;AAE/B;AASO,MAAMI,IAAkB,CAACC,MACvBA,EAAM,QAAQ,OAAO,EAAE,GAcnBC,IAA2B,CAACC,MACvCA,EAAS,QAAQ,YAAY,EAAE,GASpBC,IAAuB,CAACC,MAC5BA,EAAE,QAAQ,aAAa,CAACC,GAAWC,MAAiBA,EAAK,aAAa,GAwClEC,IAAoB,CAACC,MAA4D;AAC5F,MAAI,CAACA,EAAa,QAAO;AAEzB,QAAMC,IAASV,EAAgB,OAAOS,CAAW,CAAC;AAElD,SAAIC,EAAO,WAAW,KACb,GAAGA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,CAAC,CAAC,KAGnEA,EAAO,WAAW,MAAMA,EAAO,WAAW,GAAG,IACxC,GAAGA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,GAAG,CAAC,CAAC,IAAIA,EAAO,MAAM,CAAC,CAAC,KAGhEA,KAAU;AACnB;"}

package/dist/helpers/getDataProps.d.ts

@@ -1,2 +1,13 @@
 import { DataAttributes } from '../types/Helpers';
+/**
+ * Extracts `data-*` attributes from a props object for forwarding to the DOM.
+ *
+ * @remarks Filters out any entry whose key does not begin with `data-` or
+ * whose value is not a string, number, or boolean — matching the runtime
+ * shape that React permits on host elements.
+ *
+ * @param props - The component props to filter.
+ * @returns An object containing only the `data-*` attributes from `props`.
+ * @internal
+ */
 export declare function getDataProps(props: Record<string, unknown>): DataAttributes;

package/dist/helpers/getDataProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"getDataProps.js","sources":["../../src/helpers/getDataProps.ts"],"sourcesContent":["import type { DataAttributes } from '@/types/Helpers'\n\ntype DataAttributeEntry = [key: keyof DataAttributes, value: DataAttributes[keyof DataAttributes]]\n\nconst isDataProp = (entry: [string, unknown]): entry is DataAttributeEntry => {\n  const [key, value] = entry\n  return (\n    key.startsWith('data-') &&\n    (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean')\n  )\n}\n\nexport function getDataProps(props: Record<string, unknown>): DataAttributes {\n  const result: DataAttributes = {}\n\n  Object.entries(props).forEach(entry => {\n    if (isDataProp(entry)) {\n      const [key, value] = entry\n      result[key] = value\n    }\n  })\n\n  return result\n}\n"],"names":["isDataProp","entry","key","value","getDataProps","props","result"],"mappings":"AAIA,MAAMA,IAAa,CAACC,MAA0D;AAC5E,QAAM,CAACC,GAAKC,CAAK,IAAIF;AACrB,SACEC,EAAI,WAAW,OAAO,MACrB,OAAOC,KAAU,YAAY,OAAOA,KAAU,YAAY,OAAOA,KAAU;AAEhF;AAEO,SAASC,EAAaC,GAAgD;AAC3E,QAAMC,IAAyB,CAAA;AAE/B,gBAAO,QAAQD,CAAK,EAAE,QAAQ,CAAAJ,MAAS;AACrC,QAAID,EAAWC,CAAK,GAAG;AACrB,YAAM,CAACC,GAAKC,CAAK,IAAIF;AACrB,MAAAK,EAAOJ,CAAG,IAAIC;AAAA,IAChB;AAAA,EACF,CAAC,GAEMG;AACT;"}
+{"version":3,"file":"getDataProps.js","sources":["../../src/helpers/getDataProps.ts"],"sourcesContent":["import type { DataAttributes } from '@/types/Helpers'\n\ntype DataAttributeEntry = [key: keyof DataAttributes, value: DataAttributes[keyof DataAttributes]]\n\nconst isDataProp = (entry: [string, unknown]): entry is DataAttributeEntry => {\n  const [key, value] = entry\n  return (\n    key.startsWith('data-') &&\n    (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean')\n  )\n}\n\n/**\n * Extracts `data-*` attributes from a props object for forwarding to the DOM.\n *\n * @remarks Filters out any entry whose key does not begin with `data-` or\n * whose value is not a string, number, or boolean — matching the runtime\n * shape that React permits on host elements.\n *\n * @param props - The component props to filter.\n * @returns An object containing only the `data-*` attributes from `props`.\n * @internal\n */\nexport function getDataProps(props: Record<string, unknown>): DataAttributes {\n  const result: DataAttributes = {}\n\n  Object.entries(props).forEach(entry => {\n    if (isDataProp(entry)) {\n      const [key, value] = entry\n      result[key] = value\n    }\n  })\n\n  return result\n}\n"],"names":["isDataProp","entry","key","value","getDataProps","props","result"],"mappings":"AAIA,MAAMA,IAAa,CAACC,MAA0D;AAC5E,QAAM,CAACC,GAAKC,CAAK,IAAIF;AACrB,SACEC,EAAI,WAAW,OAAO,MACrB,OAAOC,KAAU,YAAY,OAAOA,KAAU,YAAY,OAAOA,KAAU;AAEhF;AAaO,SAASC,EAAaC,GAAgD;AAC3E,QAAMC,IAAyB,CAAA;AAE/B,gBAAO,QAAQD,CAAK,EAAE,QAAQ,CAAAJ,MAAS;AACrC,QAAID,EAAWC,CAAK,GAAG;AACrB,YAAM,CAACC,GAAKC,CAAK,IAAIF;AACrB,MAAAK,EAAOJ,CAAG,IAAIC;AAAA,IAChB;AAAA,EACF,CAAC,GAEMG;AACT;"}

package/dist/helpers/mask.d.ts

@@ -2,26 +2,43 @@ import { Transform } from '../components/Common/Fields/hooks/useField';
 /**
  * Formats a string according to a specified mask pattern.
  *
+ * @remarks
+ * Strips non-alphanumeric characters from the input before applying the mask.
+ * Mask pattern characters:
+ * - `#` matches a digit (`\d`)
+ * - `@` matches a letter (`[a-zA-Z]`)
+ * - `^` matches an uppercase letter (`[A-Z]`)
+ * - `%` matches a digit or uppercase letter (`[0-9A-Z]`)
+ * - any other character is emitted as a literal
+ *
  * @param value - The input string to format
- * @param mask - The mask pattern where:
- *   `#` represents a digit (`\d`)
- *   `@` represents a letter (`[a-zA-Z]`)
- *   `^` represents an uppercase letter (`[A-Z]`)
- *   `%` represents a digit or uppercase letter (`[0-9A-Z]`)
- *   any other character represents the literal character
- * @returns The formatted string according to the mask
+ * @param mask - The mask pattern, or `null` to pass the value through unchanged
+ * @returns The formatted string according to the mask, or the original value when `value` or `mask` is empty
+ * @internal
  *
  * @example
  * ```ts
- * formatWithMask('123456789', '###-##-####') // returns '123-45-6789'
- * formatWithMask('ABC123', '@@@-###') // returns 'ABC-123'
- * formatWithMask('123456', '(###) ###-####') // returns '(123) 456'
- * formatWithMask('ABC123', '^^^-###') // returns 'ABC-123'
- * formatWithMask('A1B2C3', '%%%-%%%') // returns 'A1B-2C3'
+ * formatWithMask('123456789', '###-##-####') // '123-45-6789'
+ * formatWithMask('ABC123', '@@@-###')        // 'ABC-123'
+ * formatWithMask('123456', '(###) ###-####') // '(123) 456'
+ * formatWithMask('ABC123', '^^^-###')        // 'ABC-123'
+ * formatWithMask('A1B2C3', '%%%-%%%')        // 'A1B-2C3'
  * ```
  */
 export declare const formatWithMask: (value: string, mask: string | null) => string;
+/**
+ * Builds a Field transform that applies a mask pattern to the input value on each change.
+ *
+ * @param mask - The mask pattern accepted by {@link formatWithMask}, or `null` to pass the value through unchanged
+ * @returns A transform function suitable for passing to a Field component's `transform` prop
+ * @internal
+ */
 export declare const useMaskedTransform: (mask: string | null) => Transform<string>;
+/**
+ * Reusable mask patterns shared across Field components.
+ *
+ * @internal
+ */
 export declare const commonMasks: {
     phoneMask: string;
 };

package/dist/helpers/mask.js.map

@@ -1 +1 @@
-{"version":3,"file":"mask.js","sources":["../../src/helpers/mask.ts"],"sourcesContent":["import type { Transform } from '@/components/Common/Fields/hooks/useField'\n\n/**\n * Formats a string according to a specified mask pattern.\n *\n * @param value - The input string to format\n * @param mask - The mask pattern where:\n *   `#` represents a digit (`\\d`)\n *   `@` represents a letter (`[a-zA-Z]`)\n *   `^` represents an uppercase letter (`[A-Z]`)\n *   `%` represents a digit or uppercase letter (`[0-9A-Z]`)\n *   any other character represents the literal character\n * @returns The formatted string according to the mask\n *\n * @example\n * ```ts\n * formatWithMask('123456789', '###-##-####') // returns '123-45-6789'\n * formatWithMask('ABC123', '@@@-###') // returns 'ABC-123'\n * formatWithMask('123456', '(###) ###-####') // returns '(123) 456'\n * formatWithMask('ABC123', '^^^-###') // returns 'ABC-123'\n * formatWithMask('A1B2C3', '%%%-%%%') // returns 'A1B-2C3'\n * ```\n */\nexport const formatWithMask = (value: string, mask: string | null): string => {\n  if (!value || !mask) return value\n\n  // Remove all non-alphanumeric characters from the input\n  const sanitizedValue = value.replace(/[^a-zA-Z0-9]/g, '')\n  if (!sanitizedValue) return ''\n\n  let result = ''\n  let valueIndex = 0\n  let maskIndex = 0\n\n  while (maskIndex < mask.length) {\n    const maskChar = mask.charAt(maskIndex)\n    const valueChar = sanitizedValue.charAt(valueIndex)\n\n    // If we've processed all input characters, stop\n    if (valueIndex >= sanitizedValue.length) {\n      break\n    }\n\n    switch (maskChar) {\n      case '#':\n        if (/\\d/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      case '@':\n        if (/[a-zA-Z]/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      case '^':\n        if (/[A-Z]/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      case '%':\n        if (/[0-9A-Z]/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      default:\n        // Always add literal characters from the mask\n        result += maskChar\n        // Increment valueIndex only if the current input character matches the literal mask character.\n        if (maskChar === valueChar) {\n          valueIndex++\n        }\n    }\n    maskIndex++\n  }\n\n  return result.trim()\n}\n\nexport const useMaskedTransform = (mask: string | null): Transform<string> => {\n  return (value: string) => formatWithMask(value, mask)\n}\n\nexport const commonMasks = {\n  phoneMask: '(###) ###-####',\n}\n"],"names":["formatWithMask","value","mask","sanitizedValue","result","valueIndex","maskIndex","maskChar","valueChar","useMaskedTransform","commonMasks"],"mappings":"AAuBO,MAAMA,IAAiB,CAACC,GAAeC,MAAgC;AAC5E,MAAI,CAACD,KAAS,CAACC,EAAM,QAAOD;AAG5B,QAAME,IAAiBF,EAAM,QAAQ,iBAAiB,EAAE;AACxD,MAAI,CAACE,EAAgB,QAAO;AAE5B,MAAIC,IAAS,IACTC,IAAa,GACbC,IAAY;AAEhB,SAAOA,IAAYJ,EAAK,UAAQ;AAC9B,UAAMK,IAAWL,EAAK,OAAOI,CAAS,GAChCE,IAAYL,EAAe,OAAOE,CAAU;AAGlD,QAAIA,KAAcF,EAAe;AAC/B;AAGF,YAAQI,GAAA;AAAA,MACN,KAAK;AACH,QAAI,KAAK,KAAKC,CAAS,KACrBJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF,KAAK;AACH,QAAI,WAAW,KAAKE,CAAS,KAC3BJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF,KAAK;AACH,QAAI,QAAQ,KAAKE,CAAS,KACxBJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF,KAAK;AACH,QAAI,WAAW,KAAKE,CAAS,KAC3BJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF;AAEE,QAAAF,KAAUG,GAENA,MAAaC,KACfH;AAAA,IACF;AAEJ,IAAAC;AAAA,EACF;AAEA,SAAOF,EAAO,KAAA;AAChB,GAEaK,IAAqB,CAACP,MAC1B,CAACD,MAAkBD,EAAeC,GAAOC,CAAI,GAGzCQ,IAAc;AAAA,EACzB,WAAW;AACb;"}
+{"version":3,"file":"mask.js","sources":["../../src/helpers/mask.ts"],"sourcesContent":["import type { Transform } from '@/components/Common/Fields/hooks/useField'\n\n/**\n * Formats a string according to a specified mask pattern.\n *\n * @remarks\n * Strips non-alphanumeric characters from the input before applying the mask.\n * Mask pattern characters:\n * - `#` matches a digit (`\\d`)\n * - `@` matches a letter (`[a-zA-Z]`)\n * - `^` matches an uppercase letter (`[A-Z]`)\n * - `%` matches a digit or uppercase letter (`[0-9A-Z]`)\n * - any other character is emitted as a literal\n *\n * @param value - The input string to format\n * @param mask - The mask pattern, or `null` to pass the value through unchanged\n * @returns The formatted string according to the mask, or the original value when `value` or `mask` is empty\n * @internal\n *\n * @example\n * ```ts\n * formatWithMask('123456789', '###-##-####') // '123-45-6789'\n * formatWithMask('ABC123', '@@@-###')        // 'ABC-123'\n * formatWithMask('123456', '(###) ###-####') // '(123) 456'\n * formatWithMask('ABC123', '^^^-###')        // 'ABC-123'\n * formatWithMask('A1B2C3', '%%%-%%%')        // 'A1B-2C3'\n * ```\n */\nexport const formatWithMask = (value: string, mask: string | null): string => {\n  if (!value || !mask) return value\n\n  // Remove all non-alphanumeric characters from the input\n  const sanitizedValue = value.replace(/[^a-zA-Z0-9]/g, '')\n  if (!sanitizedValue) return ''\n\n  let result = ''\n  let valueIndex = 0\n  let maskIndex = 0\n\n  while (maskIndex < mask.length) {\n    const maskChar = mask.charAt(maskIndex)\n    const valueChar = sanitizedValue.charAt(valueIndex)\n\n    // If we've processed all input characters, stop\n    if (valueIndex >= sanitizedValue.length) {\n      break\n    }\n\n    switch (maskChar) {\n      case '#':\n        if (/\\d/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      case '@':\n        if (/[a-zA-Z]/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      case '^':\n        if (/[A-Z]/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      case '%':\n        if (/[0-9A-Z]/.test(valueChar)) {\n          result += valueChar\n          valueIndex++\n        } else {\n          valueIndex++\n          maskIndex--\n        }\n        break\n      default:\n        // Always add literal characters from the mask\n        result += maskChar\n        // Increment valueIndex only if the current input character matches the literal mask character.\n        if (maskChar === valueChar) {\n          valueIndex++\n        }\n    }\n    maskIndex++\n  }\n\n  return result.trim()\n}\n\n/**\n * Builds a Field transform that applies a mask pattern to the input value on each change.\n *\n * @param mask - The mask pattern accepted by {@link formatWithMask}, or `null` to pass the value through unchanged\n * @returns A transform function suitable for passing to a Field component's `transform` prop\n * @internal\n */\nexport const useMaskedTransform = (mask: string | null): Transform<string> => {\n  return (value: string) => formatWithMask(value, mask)\n}\n\n/**\n * Reusable mask patterns shared across Field components.\n *\n * @internal\n */\nexport const commonMasks = {\n  phoneMask: '(###) ###-####',\n}\n"],"names":["formatWithMask","value","mask","sanitizedValue","result","valueIndex","maskIndex","maskChar","valueChar","useMaskedTransform","commonMasks"],"mappings":"AA4BO,MAAMA,IAAiB,CAACC,GAAeC,MAAgC;AAC5E,MAAI,CAACD,KAAS,CAACC,EAAM,QAAOD;AAG5B,QAAME,IAAiBF,EAAM,QAAQ,iBAAiB,EAAE;AACxD,MAAI,CAACE,EAAgB,QAAO;AAE5B,MAAIC,IAAS,IACTC,IAAa,GACbC,IAAY;AAEhB,SAAOA,IAAYJ,EAAK,UAAQ;AAC9B,UAAMK,IAAWL,EAAK,OAAOI,CAAS,GAChCE,IAAYL,EAAe,OAAOE,CAAU;AAGlD,QAAIA,KAAcF,EAAe;AAC/B;AAGF,YAAQI,GAAA;AAAA,MACN,KAAK;AACH,QAAI,KAAK,KAAKC,CAAS,KACrBJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF,KAAK;AACH,QAAI,WAAW,KAAKE,CAAS,KAC3BJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF,KAAK;AACH,QAAI,QAAQ,KAAKE,CAAS,KACxBJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF,KAAK;AACH,QAAI,WAAW,KAAKE,CAAS,KAC3BJ,KAAUI,GACVH,QAEAA,KACAC;AAEF;AAAA,MACF;AAEE,QAAAF,KAAUG,GAENA,MAAaC,KACfH;AAAA,IACF;AAEJ,IAAAC;AAAA,EACF;AAEA,SAAOF,EAAO,KAAA;AAChB,GASaK,IAAqB,CAACP,MAC1B,CAACD,MAAkBD,EAAeC,GAAOC,CAAI,GAQzCQ,IAAc;AAAA,EACzB,WAAW;AACb;"}

package/dist/helpers/payRateCalculator.d.ts

@@ -1,2 +1,10 @@
-export declare const hourlyRate: (amount: number, paymentUnit: "Hour" | "Week" | "Month" | "Year" | "Paycheck") => number;
+/**
+ * Converts a pay rate expressed in the given unit into an equivalent annual rate.
+ *
+ * @param amount - The pay amount expressed in `paymentUnit`
+ * @param paymentUnit - The unit the `amount` is expressed in
+ * @returns The equivalent annual rate, or `0` when `paymentUnit` is `Paycheck`
+ * @internal
+ * @see {@link hourlyRate}
+ */
 export declare const yearlyRate: (amount: number, paymentUnit: "Hour" | "Week" | "Month" | "Year" | "Paycheck") => number;

package/dist/helpers/payRateCalculator.js

@@ -14,7 +14,6 @@ const P = (r, e) => {
   }
 }, c = (r, e) => P(r, e) * t;
 export {
-  P as hourlyRate,
   c as yearlyRate
 };
 //# sourceMappingURL=payRateCalculator.js.map

package/dist/helpers/payRateCalculator.js.map

@@ -1 +1 @@
-{"version":3,"file":"payRateCalculator.js","sources":["../../src/helpers/payRateCalculator.ts"],"sourcesContent":["import {\n  HOURS_PER_PAY_PERIOD_ANNUALLY,\n  HOURS_PER_PAY_PERIOD_MONTHLY,\n  HOURS_PER_PAY_PERIOD_WEEKLY,\n} from '@/shared/constants'\n\nexport const hourlyRate = (\n  amount: number,\n  paymentUnit: 'Hour' | 'Week' | 'Month' | 'Year' | 'Paycheck',\n) => {\n  switch (paymentUnit) {\n    case 'Hour':\n      return amount\n    case 'Week':\n      return amount / HOURS_PER_PAY_PERIOD_WEEKLY\n    case 'Month':\n      return amount / HOURS_PER_PAY_PERIOD_MONTHLY\n    case 'Year':\n      return amount / HOURS_PER_PAY_PERIOD_ANNUALLY\n    default:\n      return 0\n  }\n}\nexport const yearlyRate = (\n  amount: number,\n  paymentUnit: 'Hour' | 'Week' | 'Month' | 'Year' | 'Paycheck',\n) => {\n  return hourlyRate(amount, paymentUnit) * HOURS_PER_PAY_PERIOD_ANNUALLY\n}\n"],"names":["hourlyRate","amount","paymentUnit","HOURS_PER_PAY_PERIOD_WEEKLY","HOURS_PER_PAY_PERIOD_MONTHLY","HOURS_PER_PAY_PERIOD_ANNUALLY","yearlyRate"],"mappings":";AAMO,MAAMA,IAAa,CACxBC,GACAC,MACG;AACH,UAAQA,GAAA;AAAA,IACN,KAAK;AACH,aAAOD;AAAA,IACT,KAAK;AACH,aAAOA,IAASE;AAAA,IAClB,KAAK;AACH,aAAOF,IAASG;AAAA,IAClB,KAAK;AACH,aAAOH,IAASI;AAAA,IAClB;AACE,aAAO;AAAA,EAAA;AAEb,GACaC,IAAa,CACxBL,GACAC,MAEOF,EAAWC,GAAQC,CAAW,IAAIG;"}
+{"version":3,"file":"payRateCalculator.js","sources":["../../src/helpers/payRateCalculator.ts"],"sourcesContent":["import {\n  HOURS_PER_PAY_PERIOD_ANNUALLY,\n  HOURS_PER_PAY_PERIOD_MONTHLY,\n  HOURS_PER_PAY_PERIOD_WEEKLY,\n} from '@/shared/constants'\n\n/**\n * Converts a pay rate expressed in the given unit into an equivalent hourly rate.\n *\n * @remarks\n * Uses the standard hours-per-pay-period constants for weekly, monthly, and annual conversions.\n * Returns `0` for `Paycheck` since the hours-per-paycheck value is not fixed.\n *\n * @param amount - The pay amount expressed in `paymentUnit`\n * @param paymentUnit - The unit the `amount` is expressed in\n * @returns The equivalent hourly rate, or `0` when `paymentUnit` is `Paycheck`\n * @internal\n */\nconst hourlyRate = (\n  amount: number,\n  paymentUnit: 'Hour' | 'Week' | 'Month' | 'Year' | 'Paycheck',\n) => {\n  switch (paymentUnit) {\n    case 'Hour':\n      return amount\n    case 'Week':\n      return amount / HOURS_PER_PAY_PERIOD_WEEKLY\n    case 'Month':\n      return amount / HOURS_PER_PAY_PERIOD_MONTHLY\n    case 'Year':\n      return amount / HOURS_PER_PAY_PERIOD_ANNUALLY\n    default:\n      return 0\n  }\n}\n/**\n * Converts a pay rate expressed in the given unit into an equivalent annual rate.\n *\n * @param amount - The pay amount expressed in `paymentUnit`\n * @param paymentUnit - The unit the `amount` is expressed in\n * @returns The equivalent annual rate, or `0` when `paymentUnit` is `Paycheck`\n * @internal\n * @see {@link hourlyRate}\n */\nexport const yearlyRate = (\n  amount: number,\n  paymentUnit: 'Hour' | 'Week' | 'Month' | 'Year' | 'Paycheck',\n) => {\n  return hourlyRate(amount, paymentUnit) * HOURS_PER_PAY_PERIOD_ANNUALLY\n}\n"],"names":["hourlyRate","amount","paymentUnit","HOURS_PER_PAY_PERIOD_WEEKLY","HOURS_PER_PAY_PERIOD_MONTHLY","HOURS_PER_PAY_PERIOD_ANNUALLY","yearlyRate"],"mappings":";AAkBA,MAAMA,IAAa,CACjBC,GACAC,MACG;AACH,UAAQA,GAAA;AAAA,IACN,KAAK;AACH,aAAOD;AAAA,IACT,KAAK;AACH,aAAOA,IAASE;AAAA,IAClB,KAAK;AACH,aAAOF,IAASG;AAAA,IAClB,KAAK;AACH,aAAOH,IAASI;AAAA,IAClB;AACE,aAAO;AAAA,EAAA;AAEb,GAUaC,IAAa,CACxBL,GACAC,MAEOF,EAAWC,GAAQC,CAAW,IAAIG;"}

package/dist/helpers/percentageConversion.d.ts

@@ -1,3 +1,39 @@
+/**
+ * Converts a decimal value into its percentage equivalent.
+ *
+ * @remarks
+ * Multiplies by 100 and rounds to 12 significant digits to avoid floating-point artifacts.
+ * Returns `undefined` for `null`, `undefined`, empty strings, booleans, or values that cannot
+ * be parsed as numbers, making it safe to call on raw form input.
+ *
+ * @param value - The decimal value to convert; strings are parsed as floats
+ * @returns The percentage (e.g. `0.0625` becomes `6.25`), or `undefined` when the input is not a usable number
+ * @internal
+ */
 export declare function decimalToPercent(value: string | number | boolean | null | undefined): number | undefined;
+/**
+ * Converts a percentage value into its decimal equivalent serialized as a string.
+ *
+ * @remarks
+ * Divides by 100 and rounds to 12 significant digits to avoid floating-point artifacts.
+ * If `value` cannot be parsed as a number, it is returned as-is via `String(value)` so that
+ * partially-typed form input is preserved.
+ *
+ * @param value - The percentage value to convert; strings are parsed as floats
+ * @returns The decimal value as a string (e.g. `6.25` becomes `"0.0625"`)
+ * @internal
+ */
 export declare function percentToDecimal(value: number | string): string;
+/**
+ * Formats a decimal value as a localized percentage string with a trailing `%`.
+ *
+ * @remarks
+ * Uses `Intl.NumberFormat` with 1 to 4 fractional digits. If `decimalValue` cannot be converted
+ * to a percentage via {@link decimalToPercent}, the original string is returned unchanged.
+ *
+ * @param decimalValue - The decimal value to format, as a string
+ * @param locale - BCP 47 locale tag passed to `Intl.NumberFormat`. Defaults to `'en-US'`.
+ * @returns The localized percentage string, or `decimalValue` when it cannot be parsed
+ * @internal
+ */
 export declare function formatPercentLabel(decimalValue: string, locale?: string): string;

package/dist/helpers/percentageConversion.js.map

@@ -1 +1 @@
-{"version":3,"file":"percentageConversion.js","sources":["../../src/helpers/percentageConversion.ts"],"sourcesContent":["const PRECISION_DIGITS = 12\n\nfunction toCleanNumber(value: number): number {\n  return parseFloat(value.toPrecision(PRECISION_DIGITS))\n}\n\nexport function decimalToPercent(\n  value: string | number | boolean | null | undefined,\n): number | undefined {\n  if (value === null || value === undefined || value === '' || typeof value === 'boolean') {\n    return undefined\n  }\n\n  const numValue = typeof value === 'number' ? value : parseFloat(value)\n\n  if (isNaN(numValue)) {\n    return undefined\n  }\n\n  return toCleanNumber(numValue * 100)\n}\n\nexport function percentToDecimal(value: number | string): string {\n  const numValue = typeof value === 'number' ? value : parseFloat(value)\n\n  if (isNaN(numValue)) {\n    return String(value)\n  }\n\n  return String(toCleanNumber(numValue / 100))\n}\n\nexport function formatPercentLabel(decimalValue: string, locale = 'en-US'): string {\n  const percent = decimalToPercent(decimalValue)\n  if (percent === undefined) return decimalValue\n\n  const formatted = new Intl.NumberFormat(locale, {\n    minimumFractionDigits: 1,\n    maximumFractionDigits: 4,\n  }).format(percent)\n\n  return `${formatted}%`\n}\n"],"names":["toCleanNumber","value","decimalToPercent","numValue","percentToDecimal","formatPercentLabel","decimalValue","locale","percent"],"mappings":"AAEA,SAASA,EAAcC,GAAuB;AAC5C,SAAO,WAAWA,EAAM,YAAY,EAAgB,CAAC;AACvD;AAEO,SAASC,EACdD,GACoB;AACpB,MAAIA,KAAU,QAA+BA,MAAU,MAAM,OAAOA,KAAU;AAC5E;AAGF,QAAME,IAAW,OAAOF,KAAU,WAAWA,IAAQ,WAAWA,CAAK;AAErE,MAAI,OAAME,CAAQ;AAIlB,WAAOH,EAAcG,IAAW,GAAG;AACrC;AAEO,SAASC,EAAiBH,GAAgC;AAC/D,QAAME,IAAW,OAAOF,KAAU,WAAWA,IAAQ,WAAWA,CAAK;AAErE,SAAI,MAAME,CAAQ,IACT,OAAOF,CAAK,IAGd,OAAOD,EAAcG,IAAW,GAAG,CAAC;AAC7C;AAEO,SAASE,EAAmBC,GAAsBC,IAAS,SAAiB;AACjF,QAAMC,IAAUN,EAAiBI,CAAY;AAC7C,SAAIE,MAAY,SAAkBF,IAO3B,GALW,IAAI,KAAK,aAAaC,GAAQ;AAAA,IAC9C,uBAAuB;AAAA,IACvB,uBAAuB;AAAA,EAAA,CACxB,EAAE,OAAOC,CAAO,CAEE;AACrB;"}
+{"version":3,"file":"percentageConversion.js","sources":["../../src/helpers/percentageConversion.ts"],"sourcesContent":["const PRECISION_DIGITS = 12\n\nfunction toCleanNumber(value: number): number {\n  return parseFloat(value.toPrecision(PRECISION_DIGITS))\n}\n\n/**\n * Converts a decimal value into its percentage equivalent.\n *\n * @remarks\n * Multiplies by 100 and rounds to 12 significant digits to avoid floating-point artifacts.\n * Returns `undefined` for `null`, `undefined`, empty strings, booleans, or values that cannot\n * be parsed as numbers, making it safe to call on raw form input.\n *\n * @param value - The decimal value to convert; strings are parsed as floats\n * @returns The percentage (e.g. `0.0625` becomes `6.25`), or `undefined` when the input is not a usable number\n * @internal\n */\nexport function decimalToPercent(\n  value: string | number | boolean | null | undefined,\n): number | undefined {\n  if (value === null || value === undefined || value === '' || typeof value === 'boolean') {\n    return undefined\n  }\n\n  const numValue = typeof value === 'number' ? value : parseFloat(value)\n\n  if (isNaN(numValue)) {\n    return undefined\n  }\n\n  return toCleanNumber(numValue * 100)\n}\n\n/**\n * Converts a percentage value into its decimal equivalent serialized as a string.\n *\n * @remarks\n * Divides by 100 and rounds to 12 significant digits to avoid floating-point artifacts.\n * If `value` cannot be parsed as a number, it is returned as-is via `String(value)` so that\n * partially-typed form input is preserved.\n *\n * @param value - The percentage value to convert; strings are parsed as floats\n * @returns The decimal value as a string (e.g. `6.25` becomes `\"0.0625\"`)\n * @internal\n */\nexport function percentToDecimal(value: number | string): string {\n  const numValue = typeof value === 'number' ? value : parseFloat(value)\n\n  if (isNaN(numValue)) {\n    return String(value)\n  }\n\n  return String(toCleanNumber(numValue / 100))\n}\n\n/**\n * Formats a decimal value as a localized percentage string with a trailing `%`.\n *\n * @remarks\n * Uses `Intl.NumberFormat` with 1 to 4 fractional digits. If `decimalValue` cannot be converted\n * to a percentage via {@link decimalToPercent}, the original string is returned unchanged.\n *\n * @param decimalValue - The decimal value to format, as a string\n * @param locale - BCP 47 locale tag passed to `Intl.NumberFormat`. Defaults to `'en-US'`.\n * @returns The localized percentage string, or `decimalValue` when it cannot be parsed\n * @internal\n */\nexport function formatPercentLabel(decimalValue: string, locale = 'en-US'): string {\n  const percent = decimalToPercent(decimalValue)\n  if (percent === undefined) return decimalValue\n\n  const formatted = new Intl.NumberFormat(locale, {\n    minimumFractionDigits: 1,\n    maximumFractionDigits: 4,\n  }).format(percent)\n\n  return `${formatted}%`\n}\n"],"names":["toCleanNumber","value","decimalToPercent","numValue","percentToDecimal","formatPercentLabel","decimalValue","locale","percent"],"mappings":"AAEA,SAASA,EAAcC,GAAuB;AAC5C,SAAO,WAAWA,EAAM,YAAY,EAAgB,CAAC;AACvD;AAcO,SAASC,EACdD,GACoB;AACpB,MAAIA,KAAU,QAA+BA,MAAU,MAAM,OAAOA,KAAU;AAC5E;AAGF,QAAME,IAAW,OAAOF,KAAU,WAAWA,IAAQ,WAAWA,CAAK;AAErE,MAAI,OAAME,CAAQ;AAIlB,WAAOH,EAAcG,IAAW,GAAG;AACrC;AAcO,SAASC,EAAiBH,GAAgC;AAC/D,QAAME,IAAW,OAAOF,KAAU,WAAWA,IAAQ,WAAWA,CAAK;AAErE,SAAI,MAAME,CAAQ,IACT,OAAOF,CAAK,IAGd,OAAOD,EAAcG,IAAW,GAAG,CAAC;AAC7C;AAcO,SAASE,EAAmBC,GAAsBC,IAAS,SAAiB;AACjF,QAAMC,IAAUN,EAAiBI,CAAY;AAC7C,SAAIE,MAAY,SAAkBF,IAO3B,GALW,IAAI,KAAK,aAAaC,GAAQ;AAAA,IAC9C,uBAAuB;AAAA,IACvB,uBAAuB;AAAA,EAAA,CACxB,EAAE,OAAOC,CAAO,CAEE;AACrB;"}

package/dist/helpers/readableStreamToBlob.d.ts

@@ -1 +1,14 @@
+/**
+ * Drains a binary `ReadableStream` and packages the bytes into a `Blob`.
+ *
+ * @remarks
+ * Reads all chunks from the stream, concatenates them into a single `Uint8Array`, and wraps the
+ * result in a `Blob` tagged with `mimeType`. Used to materialize downloads returned by streaming
+ * API responses.
+ *
+ * @param stream - The byte stream to read to completion
+ * @param mimeType - The MIME type assigned to the resulting `Blob`
+ * @returns A `Blob` containing the full contents of the stream
+ * @internal
+ */
 export declare function readableStreamToBlob(stream: ReadableStream<Uint8Array>, mimeType: string): Promise<Blob>;

package/dist/helpers/readableStreamToBlob.js.map

@@ -1 +1 @@
-{"version":3,"file":"readableStreamToBlob.js","sources":["../../src/helpers/readableStreamToBlob.ts"],"sourcesContent":["export async function readableStreamToBlob(stream: ReadableStream<Uint8Array>, mimeType: string) {\n  const reader = stream.getReader()\n  const chunks: Uint8Array[] = []\n  let done = false\n  while (!done) {\n    const { value, done: readerDone } = await reader.read()\n    if (value) chunks.push(value)\n    done = readerDone\n  }\n  // Concatenate all chunks\n  const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0)\n  const merged = new Uint8Array(totalLength)\n  let offset = 0\n  for (const chunk of chunks) {\n    merged.set(chunk, offset)\n    offset += chunk.length\n  }\n  return new Blob([merged], { type: mimeType })\n}\n"],"names":["readableStreamToBlob","stream","mimeType","reader","chunks","done","value","readerDone","totalLength","acc","chunk","merged","offset"],"mappings":"AAAA,eAAsBA,EAAqBC,GAAoCC,GAAkB;AAC/F,QAAMC,IAASF,EAAO,UAAA,GAChBG,IAAuB,CAAA;AAC7B,MAAIC,IAAO;AACX,SAAO,CAACA,KAAM;AACZ,UAAM,EAAE,OAAAC,GAAO,MAAMC,MAAe,MAAMJ,EAAO,KAAA;AACjD,IAAIG,KAAOF,EAAO,KAAKE,CAAK,GAC5BD,IAAOE;AAAA,EACT;AAEA,QAAMC,IAAcJ,EAAO,OAAO,CAACK,GAAKC,MAAUD,IAAMC,EAAM,QAAQ,CAAC,GACjEC,IAAS,IAAI,WAAWH,CAAW;AACzC,MAAII,IAAS;AACb,aAAWF,KAASN;AAClB,IAAAO,EAAO,IAAID,GAAOE,CAAM,GACxBA,KAAUF,EAAM;AAElB,SAAO,IAAI,KAAK,CAACC,CAAM,GAAG,EAAE,MAAMT,GAAU;AAC9C;"}
+{"version":3,"file":"readableStreamToBlob.js","sources":["../../src/helpers/readableStreamToBlob.ts"],"sourcesContent":["/**\n * Drains a binary `ReadableStream` and packages the bytes into a `Blob`.\n *\n * @remarks\n * Reads all chunks from the stream, concatenates them into a single `Uint8Array`, and wraps the\n * result in a `Blob` tagged with `mimeType`. Used to materialize downloads returned by streaming\n * API responses.\n *\n * @param stream - The byte stream to read to completion\n * @param mimeType - The MIME type assigned to the resulting `Blob`\n * @returns A `Blob` containing the full contents of the stream\n * @internal\n */\nexport async function readableStreamToBlob(stream: ReadableStream<Uint8Array>, mimeType: string) {\n  const reader = stream.getReader()\n  const chunks: Uint8Array[] = []\n  let done = false\n  while (!done) {\n    const { value, done: readerDone } = await reader.read()\n    if (value) chunks.push(value)\n    done = readerDone\n  }\n  // Concatenate all chunks\n  const totalLength = chunks.reduce((acc, chunk) => acc + chunk.length, 0)\n  const merged = new Uint8Array(totalLength)\n  let offset = 0\n  for (const chunk of chunks) {\n    merged.set(chunk, offset)\n    offset += chunk.length\n  }\n  return new Blob([merged], { type: mimeType })\n}\n"],"names":["readableStreamToBlob","stream","mimeType","reader","chunks","done","value","readerDone","totalLength","acc","chunk","merged","offset"],"mappings":"AAaA,eAAsBA,EAAqBC,GAAoCC,GAAkB;AAC/F,QAAMC,IAASF,EAAO,UAAA,GAChBG,IAAuB,CAAA;AAC7B,MAAIC,IAAO;AACX,SAAO,CAACA,KAAM;AACZ,UAAM,EAAE,OAAAC,GAAO,MAAMC,MAAe,MAAMJ,EAAO,KAAA;AACjD,IAAIG,KAAOF,EAAO,KAAKE,CAAK,GAC5BD,IAAOE;AAAA,EACT;AAEA,QAAMC,IAAcJ,EAAO,OAAO,CAACK,GAAKC,MAAUD,IAAMC,EAAM,QAAQ,CAAC,GACjEC,IAAS,IAAI,WAAWH,CAAW;AACzC,MAAII,IAAS;AACb,aAAWF,KAASN;AAClB,IAAAO,EAAO,IAAID,GAAOE,CAAM,GACxBA,KAAUF,EAAM;AAElB,SAAO,IAAI,KAAK,CAACC,CAAM,GAAG,EAAE,MAAMT,GAAU;AAC9C;"}

package/dist/helpers/rem.d.ts

@@ -1,12 +1,33 @@
 /**
- * Detects font-size on the document root element with fallback to 16px which is the default browser setting.
- * The value is cached after the first call to avoid repeated expensive getComputedStyle() calls.
+ * Reads the font size of the document root element, falling back to `'16'` when running outside the browser or when the value cannot be parsed.
  *
- * @param options - Set `forceRefresh` to force a fresh detection instead of using the cached value
- * @returns The root font size in pixels as a string
+ * @remarks
+ * The first call resolves the value via `getComputedStyle(document.documentElement)` and caches it
+ * for subsequent calls, since `getComputedStyle` triggers layout. Pass `forceRefresh: true` to
+ * recompute, e.g. after a theme change that adjusts the root font size.
+ *
+ * @param options - Optional flags. Set `forceRefresh` to `true` to bypass the cache and recompute the value.
+ * @returns The root font size in pixels as a numeric string (no `px` suffix)
+ * @internal
  */
 export declare function getRootFontSize(options?: {
     forceRefresh?: boolean;
 }): string;
+/**
+ * Converts a pixel value into a `rem`-suffixed string relative to the document root font size.
+ *
+ * @param pxValue - The value in pixels
+ * @returns The equivalent value as a string ending in `rem` (e.g. `'1.5rem'`)
+ * @internal
+ * @see {@link getRootFontSize}
+ */
 export declare function toRem(pxValue: number): string;
+/**
+ * Converts a `rem` value into pixels relative to the document root font size.
+ *
+ * @param rem - The value in `rem`. Accepts either a number (interpreted as raw `rem`) or a string that may include the `rem` suffix (e.g. `'1.5rem'`).
+ * @returns The equivalent value in pixels as a number
+ * @internal
+ * @see {@link getRootFontSize}
+ */
 export declare const remToPx: (rem: string | number) => number;

package/dist/helpers/rem.js.map

@@ -1 +1 @@
-{"version":3,"file":"rem.js","sources":["../../src/helpers/rem.ts"],"sourcesContent":["let cachedRootFontSize: string | null = null\n\n/**\n * Detects font-size on the document root element with fallback to 16px which is the default browser setting.\n * The value is cached after the first call to avoid repeated expensive getComputedStyle() calls.\n *\n * @param options - Set `forceRefresh` to force a fresh detection instead of using the cached value\n * @returns The root font size in pixels as a string\n */\nexport function getRootFontSize(options?: { forceRefresh?: boolean }) {\n  if (cachedRootFontSize && !options?.forceRefresh) {\n    return cachedRootFontSize\n  }\n\n  const defaultFontSize = '16'\n\n  if (typeof window === 'undefined') {\n    cachedRootFontSize = defaultFontSize\n    return defaultFontSize\n  }\n\n  const match = window\n    .getComputedStyle(document.documentElement)\n    .getPropertyValue('font-size')\n    .match(/\\d+/)\n\n  cachedRootFontSize = match ? match[0] : defaultFontSize\n  return cachedRootFontSize\n}\n\nexport function toRem(pxValue: number) {\n  return String(pxValue / Number(getRootFontSize())) + 'rem'\n}\n\nexport const remToPx = (rem: string | number) =>\n  typeof rem === 'number'\n    ? Number(getRootFontSize()) * rem\n    : Number(getRootFontSize()) * Number(rem.replace('rem', ''))\n"],"names":["cachedRootFontSize","getRootFontSize","options","defaultFontSize","match","toRem","pxValue","remToPx","rem"],"mappings":"AAAA,IAAIA,IAAoC;AASjC,SAASC,EAAgBC,GAAsC;AACpE,MAAIF;AACF,WAAOA;AAGT,QAAMG,IAAkB;AAExB,MAAI,OAAO,SAAW;AACpB,WAAAH,IAAqBG,GACdA;AAGT,QAAMC,IAAQ,OACX,iBAAiB,SAAS,eAAe,EACzC,iBAAiB,WAAW,EAC5B,MAAM,KAAK;AAEd,SAAAJ,IAAqBI,IAAQA,EAAM,CAAC,IAAID,GACjCH;AACT;AAEO,SAASK,EAAMC,GAAiB;AACrC,SAAO,OAAOA,IAAU,OAAOL,EAAA,CAAiB,CAAC,IAAI;AACvD;AAEO,MAAMM,IAAU,CAACC,MACtB,OAAOA,KAAQ,WACX,OAAOP,GAAiB,IAAIO,IAC5B,OAAOP,EAAA,CAAiB,IAAI,OAAOO,EAAI,QAAQ,OAAO,EAAE,CAAC;"}
+{"version":3,"file":"rem.js","sources":["../../src/helpers/rem.ts"],"sourcesContent":["let cachedRootFontSize: string | null = null\n\n/**\n * Reads the font size of the document root element, falling back to `'16'` when running outside the browser or when the value cannot be parsed.\n *\n * @remarks\n * The first call resolves the value via `getComputedStyle(document.documentElement)` and caches it\n * for subsequent calls, since `getComputedStyle` triggers layout. Pass `forceRefresh: true` to\n * recompute, e.g. after a theme change that adjusts the root font size.\n *\n * @param options - Optional flags. Set `forceRefresh` to `true` to bypass the cache and recompute the value.\n * @returns The root font size in pixels as a numeric string (no `px` suffix)\n * @internal\n */\nexport function getRootFontSize(options?: { forceRefresh?: boolean }) {\n  if (cachedRootFontSize && !options?.forceRefresh) {\n    return cachedRootFontSize\n  }\n\n  const defaultFontSize = '16'\n\n  if (typeof window === 'undefined') {\n    cachedRootFontSize = defaultFontSize\n    return defaultFontSize\n  }\n\n  const match = window\n    .getComputedStyle(document.documentElement)\n    .getPropertyValue('font-size')\n    .match(/\\d+/)\n\n  cachedRootFontSize = match ? match[0] : defaultFontSize\n  return cachedRootFontSize\n}\n\n/**\n * Converts a pixel value into a `rem`-suffixed string relative to the document root font size.\n *\n * @param pxValue - The value in pixels\n * @returns The equivalent value as a string ending in `rem` (e.g. `'1.5rem'`)\n * @internal\n * @see {@link getRootFontSize}\n */\nexport function toRem(pxValue: number) {\n  return String(pxValue / Number(getRootFontSize())) + 'rem'\n}\n\n/**\n * Converts a `rem` value into pixels relative to the document root font size.\n *\n * @param rem - The value in `rem`. Accepts either a number (interpreted as raw `rem`) or a string that may include the `rem` suffix (e.g. `'1.5rem'`).\n * @returns The equivalent value in pixels as a number\n * @internal\n * @see {@link getRootFontSize}\n */\nexport const remToPx = (rem: string | number) =>\n  typeof rem === 'number'\n    ? Number(getRootFontSize()) * rem\n    : Number(getRootFontSize()) * Number(rem.replace('rem', ''))\n"],"names":["cachedRootFontSize","getRootFontSize","options","defaultFontSize","match","toRem","pxValue","remToPx","rem"],"mappings":"AAAA,IAAIA,IAAoC;AAcjC,SAASC,EAAgBC,GAAsC;AACpE,MAAIF;AACF,WAAOA;AAGT,QAAMG,IAAkB;AAExB,MAAI,OAAO,SAAW;AACpB,WAAAH,IAAqBG,GACdA;AAGT,QAAMC,IAAQ,OACX,iBAAiB,SAAS,eAAe,EACzC,iBAAiB,WAAW,EAC5B,MAAM,KAAK;AAEd,SAAAJ,IAAqBI,IAAQA,EAAM,CAAC,IAAID,GACjCH;AACT;AAUO,SAASK,EAAMC,GAAiB;AACrC,SAAO,OAAOA,IAAU,OAAOL,EAAA,CAAiB,CAAC,IAAI;AACvD;AAUO,MAAMM,IAAU,CAACC,MACtB,OAAOA,KAAQ,WACX,OAAOP,GAAiB,IAAIO,IAC5B,OAAOP,EAAA,CAAiB,IAAI,OAAOO,EAAI,QAAQ,OAAO,EAAE,CAAC;"}

package/dist/helpers/responsive.d.ts

@@ -1,12 +1,67 @@
 import { BREAKPOINTS } from '../shared/constants';
 type BreakpointKey = (typeof BREAKPOINTS)[keyof typeof BREAKPOINTS];
+/**
+ * A value that may be specified as a single value or as a partial map of breakpoints to values.
+ *
+ * @typeParam T - The underlying value type at each breakpoint.
+ * @internal
+ */
 export type Responsive<T> = T | Partial<{
     [K in BreakpointKey]: T;
 }>;
+/**
+ * Value accepted for a CSS custom property — either a string token or a numeric pixel value.
+ *
+ * @internal
+ */
 export type CustomPropertyValue = string | number;
+/**
+ * Returns true if the value is a breakpoint-keyed object rather than a single value.
+ *
+ * @param value - The value to inspect.
+ * @returns Whether the value is keyed by a known breakpoint.
+ * @internal
+ */
 export declare function isResponsiveValue(value: Responsive<CustomPropertyValue | CustomPropertyValue[]>): boolean;
+/**
+ * Applies a transform to every breakpoint entry in a responsive value.
+ *
+ * Non-responsive values are treated as if specified at the `base` breakpoint.
+ *
+ * @param value - The responsive value to transform.
+ * @param transformValue - Function applied to each per-breakpoint value.
+ * @returns A map of breakpoint key to the transformed string value.
+ * @internal
+ */
 export declare function transformResponsiveValue(value: Responsive<CustomPropertyValue | CustomPropertyValue[]>, transformValue: (value: CustomPropertyValue | CustomPropertyValue[]) => string): Record<string, string>;
+/**
+ * Converts numeric values to rem units and passes string values through unchanged.
+ *
+ * @param value - A pixel number or a pre-formatted CSS length string.
+ * @returns The value as a rem-unit string when numeric, otherwise the original string.
+ * @internal
+ */
 export declare const toRemIfNumeric: (value: string | number) => string;
+/**
+ * Builds a map of CSS custom properties for one property across breakpoints.
+ *
+ * Each entry is keyed `--g-<property>-<breakpoint>` and numeric values are converted to rem.
+ * Array values are joined with spaces (for shorthand properties like margin).
+ *
+ * @param property - The base property name used to build custom property keys.
+ * @param value - The responsive value, or undefined to produce no properties.
+ * @returns A map of custom property names to string values.
+ * @internal
+ */
 export declare function createResponsiveCustomProperties(property: string, value?: Responsive<CustomPropertyValue | CustomPropertyValue[]>): Record<string, string>;
+/**
+ * Builds a flat map of CSS custom properties for multiple properties at once.
+ *
+ * Combines the output of {@link createResponsiveCustomProperties} for every entry in the input.
+ *
+ * @param properties - A map of property name to its responsive value.
+ * @returns A flat map of custom property names to string values suitable for a `style` prop.
+ * @internal
+ */
 export declare function setResponsiveCustomProperties(properties?: Record<string, Responsive<CustomPropertyValue | CustomPropertyValue[]> | undefined>): Record<string, string>;
 export {};

package/dist/helpers/responsive.js.map

@@ -1 +1 @@
-{"version":3,"file":"responsive.js","sources":["../../src/helpers/responsive.ts"],"sourcesContent":["import { toRem } from '@/helpers/rem'\nimport { BREAKPOINTS } from '@/shared/constants'\n\ntype BreakpointKey = (typeof BREAKPOINTS)[keyof typeof BREAKPOINTS]\n\nexport type Responsive<T> =\n  | T\n  | Partial<{\n      [K in BreakpointKey]: T\n    }>\n\nexport type CustomPropertyValue = string | number\n\nexport function isResponsiveValue(value: Responsive<CustomPropertyValue | CustomPropertyValue[]>) {\n  return Object.values(BREAKPOINTS).some(\n    breakpoint => typeof value === 'object' && breakpoint in value,\n  )\n}\n\nexport function transformResponsiveValue(\n  value: Responsive<CustomPropertyValue | CustomPropertyValue[]>,\n  transformValue: (value: CustomPropertyValue | CustomPropertyValue[]) => string,\n) {\n  const responsiveValue = isResponsiveValue(value) ? value : { base: value }\n\n  const transformedResponsiveValue: Record<string, string> = {}\n\n  Object.entries(responsiveValue).forEach(([key, value]) => {\n    transformedResponsiveValue[key] = transformValue(value)\n  })\n\n  return transformedResponsiveValue\n}\n\nexport const toRemIfNumeric = (value: string | number) => {\n  return typeof value === 'number' ? toRem(value) : value\n}\n\nexport function createResponsiveCustomProperties(\n  property: string,\n  value?: Responsive<CustomPropertyValue | CustomPropertyValue[]>,\n) {\n  if (!value && value !== 0) return {}\n\n  const responsiveValues = isResponsiveValue(value) ? value : { base: value }\n  const properties: Record<string, string> = {}\n\n  Object.entries(responsiveValues).forEach(([key, customPropertyValue]) => {\n    const customPropertyValueResult = Array.isArray(customPropertyValue)\n      ? customPropertyValue.map(toRemIfNumeric).join(' ')\n      : toRemIfNumeric(customPropertyValue)\n\n    properties[`--g-${property}-${key}`] = customPropertyValueResult\n  })\n\n  return properties\n}\n\nexport function setResponsiveCustomProperties(\n  properties?: Record<string, Responsive<CustomPropertyValue | CustomPropertyValue[]> | undefined>,\n) {\n  const allProperties: Record<string, string> = {}\n\n  if (!properties) return allProperties\n\n  Object.entries(properties).forEach(([property, value]) => {\n    Object.assign(allProperties, createResponsiveCustomProperties(property, value))\n  })\n\n  return allProperties\n}\n"],"names":["isResponsiveValue","value","BREAKPOINTS","breakpoint","toRemIfNumeric","toRem","createResponsiveCustomProperties","property","responsiveValues","properties","key","customPropertyValue","customPropertyValueResult","setResponsiveCustomProperties","allProperties"],"mappings":";;AAaO,SAASA,EAAkBC,GAAgE;AAChG,SAAO,OAAO,OAAOC,CAAW,EAAE;AAAA,IAChC,CAAAC,MAAc,OAAOF,KAAU,YAAYE,KAAcF;AAAA,EAAA;AAE7D;AAiBO,MAAMG,IAAiB,CAACH,MACtB,OAAOA,KAAU,WAAWI,EAAMJ,CAAK,IAAIA;AAG7C,SAASK,EACdC,GACAN,GACA;AACA,MAAI,CAACA,KAASA,MAAU,UAAU,CAAA;AAElC,QAAMO,IAAmBR,EAAkBC,CAAK,IAAIA,IAAQ,EAAE,MAAMA,EAAA,GAC9DQ,IAAqC,CAAA;AAE3C,gBAAO,QAAQD,CAAgB,EAAE,QAAQ,CAAC,CAACE,GAAKC,CAAmB,MAAM;AACvE,UAAMC,IAA4B,MAAM,QAAQD,CAAmB,IAC/DA,EAAoB,IAAIP,CAAc,EAAE,KAAK,GAAG,IAChDA,EAAeO,CAAmB;AAEtC,IAAAF,EAAW,OAAOF,CAAQ,IAAIG,CAAG,EAAE,IAAIE;AAAA,EACzC,CAAC,GAEMH;AACT;AAEO,SAASI,EACdJ,GACA;AACA,QAAMK,IAAwC,CAAA;AAE9C,SAAKL,KAEL,OAAO,QAAQA,CAAU,EAAE,QAAQ,CAAC,CAACF,GAAUN,CAAK,MAAM;AACxD,WAAO,OAAOa,GAAeR,EAAiCC,GAAUN,CAAK,CAAC;AAAA,EAChF,CAAC,GAEMa;AACT;"}
+{"version":3,"file":"responsive.js","sources":["../../src/helpers/responsive.ts"],"sourcesContent":["import { toRem } from '@/helpers/rem'\nimport { BREAKPOINTS } from '@/shared/constants'\n\ntype BreakpointKey = (typeof BREAKPOINTS)[keyof typeof BREAKPOINTS]\n\n/**\n * A value that may be specified as a single value or as a partial map of breakpoints to values.\n *\n * @typeParam T - The underlying value type at each breakpoint.\n * @internal\n */\nexport type Responsive<T> =\n  | T\n  | Partial<{\n      [K in BreakpointKey]: T\n    }>\n\n/**\n * Value accepted for a CSS custom property — either a string token or a numeric pixel value.\n *\n * @internal\n */\nexport type CustomPropertyValue = string | number\n\n/**\n * Returns true if the value is a breakpoint-keyed object rather than a single value.\n *\n * @param value - The value to inspect.\n * @returns Whether the value is keyed by a known breakpoint.\n * @internal\n */\nexport function isResponsiveValue(value: Responsive<CustomPropertyValue | CustomPropertyValue[]>) {\n  return Object.values(BREAKPOINTS).some(\n    breakpoint => typeof value === 'object' && breakpoint in value,\n  )\n}\n\n/**\n * Applies a transform to every breakpoint entry in a responsive value.\n *\n * Non-responsive values are treated as if specified at the `base` breakpoint.\n *\n * @param value - The responsive value to transform.\n * @param transformValue - Function applied to each per-breakpoint value.\n * @returns A map of breakpoint key to the transformed string value.\n * @internal\n */\nexport function transformResponsiveValue(\n  value: Responsive<CustomPropertyValue | CustomPropertyValue[]>,\n  transformValue: (value: CustomPropertyValue | CustomPropertyValue[]) => string,\n) {\n  const responsiveValue = isResponsiveValue(value) ? value : { base: value }\n\n  const transformedResponsiveValue: Record<string, string> = {}\n\n  Object.entries(responsiveValue).forEach(([key, value]) => {\n    transformedResponsiveValue[key] = transformValue(value)\n  })\n\n  return transformedResponsiveValue\n}\n\n/**\n * Converts numeric values to rem units and passes string values through unchanged.\n *\n * @param value - A pixel number or a pre-formatted CSS length string.\n * @returns The value as a rem-unit string when numeric, otherwise the original string.\n * @internal\n */\nexport const toRemIfNumeric = (value: string | number) => {\n  return typeof value === 'number' ? toRem(value) : value\n}\n\n/**\n * Builds a map of CSS custom properties for one property across breakpoints.\n *\n * Each entry is keyed `--g-<property>-<breakpoint>` and numeric values are converted to rem.\n * Array values are joined with spaces (for shorthand properties like margin).\n *\n * @param property - The base property name used to build custom property keys.\n * @param value - The responsive value, or undefined to produce no properties.\n * @returns A map of custom property names to string values.\n * @internal\n */\nexport function createResponsiveCustomProperties(\n  property: string,\n  value?: Responsive<CustomPropertyValue | CustomPropertyValue[]>,\n) {\n  if (!value && value !== 0) return {}\n\n  const responsiveValues = isResponsiveValue(value) ? value : { base: value }\n  const properties: Record<string, string> = {}\n\n  Object.entries(responsiveValues).forEach(([key, customPropertyValue]) => {\n    const customPropertyValueResult = Array.isArray(customPropertyValue)\n      ? customPropertyValue.map(toRemIfNumeric).join(' ')\n      : toRemIfNumeric(customPropertyValue)\n\n    properties[`--g-${property}-${key}`] = customPropertyValueResult\n  })\n\n  return properties\n}\n\n/**\n * Builds a flat map of CSS custom properties for multiple properties at once.\n *\n * Combines the output of {@link createResponsiveCustomProperties} for every entry in the input.\n *\n * @param properties - A map of property name to its responsive value.\n * @returns A flat map of custom property names to string values suitable for a `style` prop.\n * @internal\n */\nexport function setResponsiveCustomProperties(\n  properties?: Record<string, Responsive<CustomPropertyValue | CustomPropertyValue[]> | undefined>,\n) {\n  const allProperties: Record<string, string> = {}\n\n  if (!properties) return allProperties\n\n  Object.entries(properties).forEach(([property, value]) => {\n    Object.assign(allProperties, createResponsiveCustomProperties(property, value))\n  })\n\n  return allProperties\n}\n"],"names":["isResponsiveValue","value","BREAKPOINTS","breakpoint","toRemIfNumeric","toRem","createResponsiveCustomProperties","property","responsiveValues","properties","key","customPropertyValue","customPropertyValueResult","setResponsiveCustomProperties","allProperties"],"mappings":";;AA+BO,SAASA,EAAkBC,GAAgE;AAChG,SAAO,OAAO,OAAOC,CAAW,EAAE;AAAA,IAChC,CAAAC,MAAc,OAAOF,KAAU,YAAYE,KAAcF;AAAA,EAAA;AAE7D;AAkCO,MAAMG,IAAiB,CAACH,MACtB,OAAOA,KAAU,WAAWI,EAAMJ,CAAK,IAAIA;AAc7C,SAASK,EACdC,GACAN,GACA;AACA,MAAI,CAACA,KAASA,MAAU,UAAU,CAAA;AAElC,QAAMO,IAAmBR,EAAkBC,CAAK,IAAIA,IAAQ,EAAE,MAAMA,EAAA,GAC9DQ,IAAqC,CAAA;AAE3C,gBAAO,QAAQD,CAAgB,EAAE,QAAQ,CAAC,CAACE,GAAKC,CAAmB,MAAM;AACvE,UAAMC,IAA4B,MAAM,QAAQD,CAAmB,IAC/DA,EAAoB,IAAIP,CAAc,EAAE,KAAK,GAAG,IAChDA,EAAeO,CAAmB;AAEtC,IAAAF,EAAW,OAAOF,CAAQ,IAAIG,CAAG,EAAE,IAAIE;AAAA,EACzC,CAAC,GAEMH;AACT;AAWO,SAASI,EACdJ,GACA;AACA,QAAMK,IAAwC,CAAA;AAE9C,SAAKL,KAEL,OAAO,QAAQA,CAAU,EAAE,QAAQ,CAAC,CAACF,GAAUN,CAAK,MAAM;AACxD,WAAO,OAAOa,GAAeR,EAAiCC,GAAUN,CAAK,CAAC;AAAA,EAChF,CAAC,GAEMa;AACT;"}

package/dist/helpers/retryAsync.d.ts

@@ -3,5 +3,19 @@ interface RetryAsyncOptions {
     delayMs: number;
     shouldRetry: (error: unknown) => boolean;
 }
+/**
+ * Retries an async function up to a maximum number of attempts, with a fixed delay between tries.
+ *
+ * The function is invoked at least once. After a failure, `shouldRetry` decides whether to retry;
+ * if it returns false the error is rethrown immediately. Errors from the final attempt are always
+ * rethrown.
+ *
+ * @typeParam T - The resolved value type of the async function.
+ * @param fn - The async function to invoke.
+ * @param options - Retry configuration: `maxAttempts`, `delayMs` between attempts, and a `shouldRetry` predicate.
+ * @returns The resolved value from the first successful call.
+ * @throws The error from the final attempt, or the first error for which `shouldRetry` returns false.
+ * @internal
+ */
 export declare function retryAsync<T>(fn: () => Promise<T>, { maxAttempts, delayMs, shouldRetry }: RetryAsyncOptions): Promise<T>;
 export {};

package/dist/helpers/retryAsync.js.map

@@ -1 +1 @@
-{"version":3,"file":"retryAsync.js","sources":["../../src/helpers/retryAsync.ts"],"sourcesContent":["interface RetryAsyncOptions {\n  maxAttempts: number\n  delayMs: number\n  shouldRetry: (error: unknown) => boolean\n}\n\nexport async function retryAsync<T>(\n  fn: () => Promise<T>,\n  { maxAttempts, delayMs, shouldRetry }: RetryAsyncOptions,\n): Promise<T> {\n  for (let attempt = 0; attempt < maxAttempts; attempt++) {\n    try {\n      return await fn()\n    } catch (error) {\n      const isLastAttempt = attempt === maxAttempts - 1\n      if (shouldRetry(error) && !isLastAttempt) {\n        await new Promise(resolve => setTimeout(resolve, delayMs))\n        continue\n      }\n      throw error\n    }\n  }\n\n  throw new Error('retryAsync: exhausted all attempts without resolving')\n}\n"],"names":["retryAsync","fn","maxAttempts","delayMs","shouldRetry","attempt","error","isLastAttempt","resolve"],"mappings":"AAMA,eAAsBA,EACpBC,GACA,EAAE,aAAAC,GAAa,SAAAC,GAAS,aAAAC,KACZ;AACZ,WAASC,IAAU,GAAGA,IAAUH,GAAaG;AAC3C,QAAI;AACF,aAAO,MAAMJ,EAAA;AAAA,IACf,SAASK,GAAO;AACd,YAAMC,IAAgBF,MAAYH,IAAc;AAChD,UAAIE,EAAYE,CAAK,KAAK,CAACC,GAAe;AACxC,cAAM,IAAI,QAAQ,CAAAC,MAAW,WAAWA,GAASL,CAAO,CAAC;AACzD;AAAA,MACF;AACA,YAAMG;AAAA,IACR;AAGF,QAAM,IAAI,MAAM,sDAAsD;AACxE;"}
+{"version":3,"file":"retryAsync.js","sources":["../../src/helpers/retryAsync.ts"],"sourcesContent":["interface RetryAsyncOptions {\n  maxAttempts: number\n  delayMs: number\n  shouldRetry: (error: unknown) => boolean\n}\n\n/**\n * Retries an async function up to a maximum number of attempts, with a fixed delay between tries.\n *\n * The function is invoked at least once. After a failure, `shouldRetry` decides whether to retry;\n * if it returns false the error is rethrown immediately. Errors from the final attempt are always\n * rethrown.\n *\n * @typeParam T - The resolved value type of the async function.\n * @param fn - The async function to invoke.\n * @param options - Retry configuration: `maxAttempts`, `delayMs` between attempts, and a `shouldRetry` predicate.\n * @returns The resolved value from the first successful call.\n * @throws The error from the final attempt, or the first error for which `shouldRetry` returns false.\n * @internal\n */\nexport async function retryAsync<T>(\n  fn: () => Promise<T>,\n  { maxAttempts, delayMs, shouldRetry }: RetryAsyncOptions,\n): Promise<T> {\n  for (let attempt = 0; attempt < maxAttempts; attempt++) {\n    try {\n      return await fn()\n    } catch (error) {\n      const isLastAttempt = attempt === maxAttempts - 1\n      if (shouldRetry(error) && !isLastAttempt) {\n        await new Promise(resolve => setTimeout(resolve, delayMs))\n        continue\n      }\n      throw error\n    }\n  }\n\n  throw new Error('retryAsync: exhausted all attempts without resolving')\n}\n"],"names":["retryAsync","fn","maxAttempts","delayMs","shouldRetry","attempt","error","isLastAttempt","resolve"],"mappings":"AAoBA,eAAsBA,EACpBC,GACA,EAAE,aAAAC,GAAa,SAAAC,GAAS,aAAAC,KACZ;AACZ,WAASC,IAAU,GAAGA,IAAUH,GAAaG;AAC3C,QAAI;AACF,aAAO,MAAMJ,EAAA;AAAA,IACf,SAASK,GAAO;AACd,YAAMC,IAAgBF,MAAYH,IAAc;AAChD,UAAIE,EAAYE,CAAK,KAAK,CAACC,GAAe;AACxC,cAAM,IAAI,QAAQ,CAAAC,MAAW,WAAWA,GAASL,CAAO,CAAC;AACzD;AAAA,MACF;AACA,YAAMG;AAAA,IACR;AAGF,QAAM,IAAI,MAAM,sDAAsD;AACxE;"}

package/dist/helpers/ssn.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Formats an SSN-like input string as `XXX-XX-XXXX`, stripping non-digit characters.
+ *
+ * Excess digits beyond nine are truncated.
+ *
+ * @param value - Raw user input that may contain digits, spaces, or punctuation.
+ * @returns The dash-formatted SSN, or an empty string if no digits are present.
+ * @internal
+ */
 export declare const normalizeSSN: (value: string) => string;
-export declare const createPlaceholderSSN: (hasSSN?: boolean, placeholderSSN?: string) => string | undefined;
+/**
+ * Hook that returns the localized SSN placeholder when an SSN is already on file.
+ *
+ * @param hasSSN - Whether the underlying record already has an SSN stored.
+ * @returns The translated placeholder string, or an empty string when no SSN exists.
+ * @internal
+ */
 export declare const usePlaceholderSSN: (hasSSN?: boolean) => string | undefined;

package/dist/helpers/ssn.js

@@ -4,7 +4,6 @@ const s = (o) => o.match(/\d*/g)?.join("").match(/(\d{0,3})(\d{0,2})(\d{0,4})/)?
   return n(o, e("inputs.ssn.placeholder"));
 };
 export {
-  n as createPlaceholderSSN,
   s as normalizeSSN,
   c as usePlaceholderSSN
 };

package/dist/helpers/ssn.js.map

@@ -1 +1 @@
-{"version":3,"file":"ssn.js","sources":["../../src/helpers/ssn.ts"],"sourcesContent":["import { useTranslation } from 'react-i18next'\n\nexport const normalizeSSN = (value: string) =>\n  value\n    .match(/\\d*/g)\n    ?.join('')\n    .match(/(\\d{0,3})(\\d{0,2})(\\d{0,4})/)\n    ?.slice(1)\n    .filter(match => match !== '')\n    .join('-')\n    .substring(0, 12) || ''\n\nexport const createPlaceholderSSN = (hasSSN?: boolean, placeholderSSN?: string) =>\n  hasSSN ? placeholderSSN : ''\n\nexport const usePlaceholderSSN = (hasSSN?: boolean) => {\n  const { t } = useTranslation('common')\n  return createPlaceholderSSN(hasSSN, t('inputs.ssn.placeholder'))\n}\n"],"names":["normalizeSSN","value","match","createPlaceholderSSN","hasSSN","placeholderSSN","usePlaceholderSSN","t","useTranslation"],"mappings":";AAEO,MAAMA,IAAe,CAACC,MAC3BA,EACG,MAAM,MAAM,GACX,KAAK,EAAE,EACR,MAAM,6BAA6B,GAClC,MAAM,CAAC,EACR,OAAO,CAAAC,MAASA,MAAU,EAAE,EAC5B,KAAK,GAAG,EACR,UAAU,GAAG,EAAE,KAAK,IAEZC,IAAuB,CAACC,GAAkBC,MACrDD,IAASC,IAAiB,IAEfC,IAAoB,CAACF,MAAqB;AACrD,QAAM,EAAE,GAAAG,EAAA,IAAMC,EAAe,QAAQ;AACrC,SAAOL,EAAqBC,GAAQG,EAAE,wBAAwB,CAAC;AACjE;"}
+{"version":3,"file":"ssn.js","sources":["../../src/helpers/ssn.ts"],"sourcesContent":["import { useTranslation } from 'react-i18next'\n\n/**\n * Formats an SSN-like input string as `XXX-XX-XXXX`, stripping non-digit characters.\n *\n * Excess digits beyond nine are truncated.\n *\n * @param value - Raw user input that may contain digits, spaces, or punctuation.\n * @returns The dash-formatted SSN, or an empty string if no digits are present.\n * @internal\n */\nexport const normalizeSSN = (value: string) =>\n  value\n    .match(/\\d*/g)\n    ?.join('')\n    .match(/(\\d{0,3})(\\d{0,2})(\\d{0,4})/)\n    ?.slice(1)\n    .filter(match => match !== '')\n    .join('-')\n    .substring(0, 12) || ''\n\n/**\n * Returns the masked placeholder string when an SSN is already on file, otherwise an empty string.\n *\n * @param hasSSN - Whether the underlying record already has an SSN stored.\n * @param placeholderSSN - The masked placeholder to display when an SSN exists.\n * @returns The placeholder when `hasSSN` is true, otherwise an empty string.\n * @internal\n */\nconst createPlaceholderSSN = (hasSSN?: boolean, placeholderSSN?: string) =>\n  hasSSN ? placeholderSSN : ''\n\n/**\n * Hook that returns the localized SSN placeholder when an SSN is already on file.\n *\n * @param hasSSN - Whether the underlying record already has an SSN stored.\n * @returns The translated placeholder string, or an empty string when no SSN exists.\n * @internal\n */\nexport const usePlaceholderSSN = (hasSSN?: boolean) => {\n  const { t } = useTranslation('common')\n  return createPlaceholderSSN(hasSSN, t('inputs.ssn.placeholder'))\n}\n"],"names":["normalizeSSN","value","match","createPlaceholderSSN","hasSSN","placeholderSSN","usePlaceholderSSN","t","useTranslation"],"mappings":";AAWO,MAAMA,IAAe,CAACC,MAC3BA,EACG,MAAM,MAAM,GACX,KAAK,EAAE,EACR,MAAM,6BAA6B,GAClC,MAAM,CAAC,EACR,OAAO,CAAAC,MAASA,MAAU,EAAE,EAC5B,KAAK,GAAG,EACR,UAAU,GAAG,EAAE,KAAK,IAUnBC,IAAuB,CAACC,GAAkBC,MAC9CD,IAASC,IAAiB,IASfC,IAAoB,CAACF,MAAqB;AACrD,QAAM,EAAE,GAAAG,EAAA,IAAMC,EAAe,QAAQ;AACrC,SAAOL,EAAqBC,GAAQG,EAAE,wBAAwB,CAAC;AACjE;"}

package/dist/helpers/validations.d.ts

@@ -1,8 +1,46 @@
 import { z } from 'zod';
+/**
+ * Regex matching personal names: one or two words composed of Latin or extended-Latin letters,
+ * with optional internal spaces, hyphens, or apostrophes, and an optional trailing period.
+ *
+ * @internal
+ */
 export declare const NAME_REGEX: RegExp;
+/**
+ * Zod schema validating a non-empty personal name against {@link NAME_REGEX}.
+ *
+ * @internal
+ */
 export declare const nameValidation: z.ZodString;
+/**
+ * Zod schema validating a US ZIP code in either 5-digit (`12345`) or ZIP+4 (`12345-6789`) form.
+ *
+ * @internal
+ */
 export declare const zipValidation: z.ZodString;
+/**
+ * Regex matching a valid US Social Security Number. Rejects reserved area numbers (000, 666, 9xx),
+ * a group number of 00, and a serial number of 0000.
+ *
+ * @internal
+ */
 export declare const SSN_REGEX: RegExp;
+/**
+ * Zod schema validating a US phone number. Formats the input with the phone mask and accepts it
+ * only when the digit-only form is exactly ten digits.
+ *
+ * @internal
+ */
 export declare const phoneValidation: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+/**
+ * Zod schema validating a bank routing number (exactly nine digits).
+ *
+ * @internal
+ */
 export declare const routingNumberValidation: z.ZodString;
+/**
+ * Zod schema validating a bank account number (one to seventeen digits).
+ *
+ * @internal
+ */
 export declare const accountNumberValidation: z.ZodString;

package/dist/helpers/validations.js.map

@@ -1 +1 @@
-{"version":3,"file":"validations.js","sources":["../../src/helpers/validations.ts"],"sourcesContent":["import { z } from 'zod'\nimport { commonMasks, formatWithMask } from './mask'\nimport { removeNonDigits } from '@/helpers/formattedStrings'\n\nexport const NAME_REGEX = /^([a-zA-Z\\xC0-\\uFFFF]+([ \\-']{0,1}[a-zA-Z\\xC0-\\uFFFF]+)*[.]{0,1}){1,2}$/\n\nexport const nameValidation = z.string().min(1).regex(NAME_REGEX)\n\nexport const zipValidation = z.string().refine(zip => /(^\\d{5}$)|(^\\d{5}-\\d{4}$)/.test(zip))\n\nexport const SSN_REGEX = /^(?!(000|666|9))\\d{3}(?!00)\\d{2}(?!0000)\\d{4}$/\n\nexport const phoneValidation = z\n  .string()\n  .transform(value => formatWithMask(value, commonMasks.phoneMask))\n  .refine(phone => {\n    const digits = removeNonDigits(phone)\n    return digits.length === 10\n  })\n\nexport const routingNumberValidation = z.string().regex(/^[0-9]{9}$/)\nexport const accountNumberValidation = z.string().regex(/^[0-9]{1,17}$/)\n"],"names":["NAME_REGEX","nameValidation","z","zipValidation","zip","SSN_REGEX","phoneValidation","value","formatWithMask","commonMasks","phone","removeNonDigits","routingNumberValidation","accountNumberValidation"],"mappings":";;;AAIO,MAAMA,IAAa,2EAEbC,IAAiBC,EAAE,OAAA,EAAS,IAAI,CAAC,EAAE,MAAMF,CAAU,GAEnDG,IAAgBD,EAAE,SAAS,OAAO,CAAAE,MAAO,4BAA4B,KAAKA,CAAG,CAAC,GAE9EC,IAAY,kDAEZC,IAAkBJ,EAC5B,OAAA,EACA,UAAU,CAAAK,MAASC,EAAeD,GAAOE,EAAY,SAAS,CAAC,EAC/D,OAAO,CAAAC,MACSC,EAAgBD,CAAK,EACtB,WAAW,EAC1B,GAEUE,IAA0BV,EAAE,OAAA,EAAS,MAAM,YAAY,GACvDW,IAA0BX,EAAE,OAAA,EAAS,MAAM,eAAe;"}
+{"version":3,"file":"validations.js","sources":["../../src/helpers/validations.ts"],"sourcesContent":["import { z } from 'zod'\nimport { commonMasks, formatWithMask } from './mask'\nimport { removeNonDigits } from '@/helpers/formattedStrings'\n\n/**\n * Regex matching personal names: one or two words composed of Latin or extended-Latin letters,\n * with optional internal spaces, hyphens, or apostrophes, and an optional trailing period.\n *\n * @internal\n */\nexport const NAME_REGEX = /^([a-zA-Z\\xC0-\\uFFFF]+([ \\-']{0,1}[a-zA-Z\\xC0-\\uFFFF]+)*[.]{0,1}){1,2}$/\n\n/**\n * Zod schema validating a non-empty personal name against {@link NAME_REGEX}.\n *\n * @internal\n */\nexport const nameValidation = z.string().min(1).regex(NAME_REGEX)\n\n/**\n * Zod schema validating a US ZIP code in either 5-digit (`12345`) or ZIP+4 (`12345-6789`) form.\n *\n * @internal\n */\nexport const zipValidation = z.string().refine(zip => /(^\\d{5}$)|(^\\d{5}-\\d{4}$)/.test(zip))\n\n/**\n * Regex matching a valid US Social Security Number. Rejects reserved area numbers (000, 666, 9xx),\n * a group number of 00, and a serial number of 0000.\n *\n * @internal\n */\nexport const SSN_REGEX = /^(?!(000|666|9))\\d{3}(?!00)\\d{2}(?!0000)\\d{4}$/\n\n/**\n * Zod schema validating a US phone number. Formats the input with the phone mask and accepts it\n * only when the digit-only form is exactly ten digits.\n *\n * @internal\n */\nexport const phoneValidation = z\n  .string()\n  .transform(value => formatWithMask(value, commonMasks.phoneMask))\n  .refine(phone => {\n    const digits = removeNonDigits(phone)\n    return digits.length === 10\n  })\n\n/**\n * Zod schema validating a bank routing number (exactly nine digits).\n *\n * @internal\n */\nexport const routingNumberValidation = z.string().regex(/^[0-9]{9}$/)\n/**\n * Zod schema validating a bank account number (one to seventeen digits).\n *\n * @internal\n */\nexport const accountNumberValidation = z.string().regex(/^[0-9]{1,17}$/)\n"],"names":["NAME_REGEX","nameValidation","z","zipValidation","zip","SSN_REGEX","phoneValidation","value","formatWithMask","commonMasks","phone","removeNonDigits","routingNumberValidation","accountNumberValidation"],"mappings":";;;AAUO,MAAMA,IAAa,2EAObC,IAAiBC,EAAE,OAAA,EAAS,IAAI,CAAC,EAAE,MAAMF,CAAU,GAOnDG,IAAgBD,EAAE,SAAS,OAAO,CAAAE,MAAO,4BAA4B,KAAKA,CAAG,CAAC,GAQ9EC,IAAY,kDAQZC,IAAkBJ,EAC5B,OAAA,EACA,UAAU,CAAAK,MAASC,EAAeD,GAAOE,EAAY,SAAS,CAAC,EAC/D,OAAO,CAAAC,MACSC,EAAgBD,CAAK,EACtB,WAAW,EAC1B,GAOUE,IAA0BV,EAAE,OAAA,EAAS,MAAM,YAAY,GAMvDW,IAA0BX,EAAE,OAAA,EAAS,MAAM,eAAe;"}

package/dist/hooks/useAsyncError.d.ts

@@ -1,6 +1,15 @@
 /**
- * Triggers re-render of a component to allow ErrorBoundary to catch a thrown error - that way we can handle all exceptions from asynchrounous functions in the same way and catch them in react boundary
+ * Surfaces an asynchronous error to the nearest React `ErrorBoundary`.
  *
- * @returns Function
+ * @remarks
+ * Errors thrown inside async callbacks (event handlers, effects, promises) are not caught by
+ * React's error boundary machinery. The returned callback schedules a state update that re-throws
+ * the supplied error during render, which causes the boundary to receive it like any sync error.
+ *
+ * Non-`Error` values are coerced — strings become the error message, anything else becomes
+ * `"Unknown error"`.
+ *
+ * @returns A callback that, when invoked with an error, triggers the surrounding error boundary.
+ * @internal
  */
 export declare const useAsyncError: () => (e: unknown) => void;

package/dist/hooks/useAsyncError.js.map

@@ -1 +1 @@
-{"version":3,"file":"useAsyncError.js","sources":["../../src/hooks/useAsyncError.tsx"],"sourcesContent":["import React from 'react'\n/**\n * Triggers re-render of a component to allow ErrorBoundary to catch a thrown error - that way we can handle all exceptions from asynchrounous functions in the same way and catch them in react boundary\n *\n * @returns Function\n */\nexport const useAsyncError = () => {\n  const [_, setError] = React.useState()\n  return React.useCallback(\n    (e: unknown) => {\n      const err = e instanceof Error ? e : new Error(typeof e === 'string' ? e : 'Unknown error')\n      setError(() => {\n        throw err\n      })\n    },\n    [setError],\n  )\n}\n"],"names":["useAsyncError","_","setError","React","e","err"],"mappings":";AAMO,MAAMA,IAAgB,MAAM;AACjC,QAAM,CAACC,GAAGC,CAAQ,IAAIC,EAAM,SAAA;AAC5B,SAAOA,EAAM;AAAA,IACX,CAACC,MAAe;AACd,YAAMC,IAAMD,aAAa,QAAQA,IAAI,IAAI,MAAM,OAAOA,KAAM,WAAWA,IAAI,eAAe;AAC1F,MAAAF,EAAS,MAAM;AACb,cAAMG;AAAA,MACR,CAAC;AAAA,IACH;AAAA,IACA,CAACH,CAAQ;AAAA,EAAA;AAEb;"}
+{"version":3,"file":"useAsyncError.js","sources":["../../src/hooks/useAsyncError.tsx"],"sourcesContent":["import React from 'react'\n/**\n * Surfaces an asynchronous error to the nearest React `ErrorBoundary`.\n *\n * @remarks\n * Errors thrown inside async callbacks (event handlers, effects, promises) are not caught by\n * React's error boundary machinery. The returned callback schedules a state update that re-throws\n * the supplied error during render, which causes the boundary to receive it like any sync error.\n *\n * Non-`Error` values are coerced — strings become the error message, anything else becomes\n * `\"Unknown error\"`.\n *\n * @returns A callback that, when invoked with an error, triggers the surrounding error boundary.\n * @internal\n */\nexport const useAsyncError = () => {\n  const [_, setError] = React.useState()\n  return React.useCallback(\n    (e: unknown) => {\n      const err = e instanceof Error ? e : new Error(typeof e === 'string' ? e : 'Unknown error')\n      setError(() => {\n        throw err\n      })\n    },\n    [setError],\n  )\n}\n"],"names":["useAsyncError","_","setError","React","e","err"],"mappings":";AAeO,MAAMA,IAAgB,MAAM;AACjC,QAAM,CAACC,GAAGC,CAAQ,IAAIC,EAAM,SAAA;AAC5B,SAAOA,EAAM;AAAA,IACX,CAACC,MAAe;AACd,YAAMC,IAAMD,aAAa,QAAQA,IAAI,IAAI,MAAM,OAAOA,KAAM,WAAWA,IAAI,eAAe;AAC1F,MAAAF,EAAS,MAAM;AACb,cAAMG;AAAA,MACR,CAAC;AAAA,IACH;AAAA,IACA,CAACH,CAAQ;AAAA,EAAA;AAEb;"}