@gusto/embedded-react-sdk 0.51.0 → 0.51.2

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-v-2026-02-01/models/components/location'\nimport { type EmployeeAddress } from '@gusto/embedded-api-v-2026-02-01/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;"}
+{"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\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/hooks/useCompanyPaymentSpeed.d.ts

@@ -1,4 +1,4 @@
-import { PaymentSpeed } from '@gusto/embedded-api-v-2026-02-01/models/components/paymentconfigs';
+import { PaymentSpeed } from '@gusto/embedded-api/models/components/paymentconfigs';
 /**
  * Extracts the leading day count from a {@link PaymentSpeed} value (e.g. `"2-day"` returns `2`).
  *

package/dist/hooks/useCompanyPaymentSpeed.js

@@ -1,4 +1,4 @@
-import { usePaymentConfigsGet as p } from "@gusto/embedded-api-v-2026-02-01/react-query/paymentConfigsGet";
+import { usePaymentConfigsGet as p } from "@gusto/embedded-api/react-query/paymentConfigsGet";
 const s = 2;
 function a(n) {
   if (!n) return s;

package/dist/hooks/useCompanyPaymentSpeed.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCompanyPaymentSpeed.js","sources":["../../src/hooks/useCompanyPaymentSpeed.ts"],"sourcesContent":["import { usePaymentConfigsGet } from '@gusto/embedded-api-v-2026-02-01/react-query/paymentConfigsGet'\nimport type { PaymentSpeed } from '@gusto/embedded-api-v-2026-02-01/models/components/paymentconfigs'\n\nconst DEFAULT_PAYMENT_SPEED_DAYS = 2\n\n/**\n * Extracts the leading day count from a {@link PaymentSpeed} value (e.g. `\"2-day\"` returns `2`).\n *\n * @remarks\n * Falls back to `2` when the value is missing or cannot be parsed as a positive finite number.\n *\n * @param paymentSpeed - The company's configured payment speed string.\n * @returns The number of payment days as an integer.\n * @internal\n */\nexport function parsePaymentSpeedDays(paymentSpeed?: PaymentSpeed): number {\n  if (!paymentSpeed) return DEFAULT_PAYMENT_SPEED_DAYS\n  const parsed = Number(paymentSpeed.split('-')[0])\n  return Number.isFinite(parsed) && parsed > 0 ? parsed : DEFAULT_PAYMENT_SPEED_DAYS\n}\n\n/**\n * Reads a company's configured payment speed and returns it alongside the parsed day count.\n *\n * @param companyUuid - The UUID of the company whose payment configuration to fetch.\n * @returns The raw `paymentSpeed` value from the API and `paymentSpeedDays` parsed via {@link parsePaymentSpeedDays}.\n * @internal\n */\nexport function useCompanyPaymentSpeed(companyUuid: string) {\n  const { data: paymentConfigsResponse } = usePaymentConfigsGet({ companyUuid })\n  const paymentSpeed = paymentConfigsResponse?.paymentConfigs?.paymentSpeed\n  const paymentSpeedDays = parsePaymentSpeedDays(paymentSpeed)\n\n  return {\n    paymentSpeed,\n    paymentSpeedDays,\n  }\n}\n"],"names":["DEFAULT_PAYMENT_SPEED_DAYS","parsePaymentSpeedDays","paymentSpeed","parsed","useCompanyPaymentSpeed","companyUuid","paymentConfigsResponse","usePaymentConfigsGet","paymentSpeedDays"],"mappings":";AAGA,MAAMA,IAA6B;AAY5B,SAASC,EAAsBC,GAAqC;AACzE,MAAI,CAACA,EAAc,QAAOF;AAC1B,QAAMG,IAAS,OAAOD,EAAa,MAAM,GAAG,EAAE,CAAC,CAAC;AAChD,SAAO,OAAO,SAASC,CAAM,KAAKA,IAAS,IAAIA,IAASH;AAC1D;AASO,SAASI,EAAuBC,GAAqB;AAC1D,QAAM,EAAE,MAAMC,EAAA,IAA2BC,EAAqB,EAAE,aAAAF,GAAa,GACvEH,IAAeI,GAAwB,gBAAgB,cACvDE,IAAmBP,EAAsBC,CAAY;AAE3D,SAAO;AAAA,IACL,cAAAA;AAAA,IACA,kBAAAM;AAAA,EAAA;AAEJ;"}
+{"version":3,"file":"useCompanyPaymentSpeed.js","sources":["../../src/hooks/useCompanyPaymentSpeed.ts"],"sourcesContent":["import { usePaymentConfigsGet } from '@gusto/embedded-api/react-query/paymentConfigsGet'\nimport type { PaymentSpeed } from '@gusto/embedded-api/models/components/paymentconfigs'\n\nconst DEFAULT_PAYMENT_SPEED_DAYS = 2\n\n/**\n * Extracts the leading day count from a {@link PaymentSpeed} value (e.g. `\"2-day\"` returns `2`).\n *\n * @remarks\n * Falls back to `2` when the value is missing or cannot be parsed as a positive finite number.\n *\n * @param paymentSpeed - The company's configured payment speed string.\n * @returns The number of payment days as an integer.\n * @internal\n */\nexport function parsePaymentSpeedDays(paymentSpeed?: PaymentSpeed): number {\n  if (!paymentSpeed) return DEFAULT_PAYMENT_SPEED_DAYS\n  const parsed = Number(paymentSpeed.split('-')[0])\n  return Number.isFinite(parsed) && parsed > 0 ? parsed : DEFAULT_PAYMENT_SPEED_DAYS\n}\n\n/**\n * Reads a company's configured payment speed and returns it alongside the parsed day count.\n *\n * @param companyUuid - The UUID of the company whose payment configuration to fetch.\n * @returns The raw `paymentSpeed` value from the API and `paymentSpeedDays` parsed via {@link parsePaymentSpeedDays}.\n * @internal\n */\nexport function useCompanyPaymentSpeed(companyUuid: string) {\n  const { data: paymentConfigsResponse } = usePaymentConfigsGet({ companyUuid })\n  const paymentSpeed = paymentConfigsResponse?.paymentConfigs?.paymentSpeed\n  const paymentSpeedDays = parsePaymentSpeedDays(paymentSpeed)\n\n  return {\n    paymentSpeed,\n    paymentSpeedDays,\n  }\n}\n"],"names":["DEFAULT_PAYMENT_SPEED_DAYS","parsePaymentSpeedDays","paymentSpeed","parsed","useCompanyPaymentSpeed","companyUuid","paymentConfigsResponse","usePaymentConfigsGet","paymentSpeedDays"],"mappings":";AAGA,MAAMA,IAA6B;AAY5B,SAASC,EAAsBC,GAAqC;AACzE,MAAI,CAACA,EAAc,QAAOF;AAC1B,QAAMG,IAAS,OAAOD,EAAa,MAAM,GAAG,EAAE,CAAC,CAAC;AAChD,SAAO,OAAO,SAASC,CAAM,KAAKA,IAAS,IAAIA,IAASH;AAC1D;AASO,SAASI,EAAuBC,GAAqB;AAC1D,QAAM,EAAE,MAAMC,EAAA,IAA2BC,EAAqB,EAAE,aAAAF,GAAa,GACvEH,IAAeI,GAAwB,gBAAgB,cACvDE,IAAmBP,EAAsBC,CAAY;AAE3D,SAAO;AAAA,IACL,cAAAA;AAAA,IACA,kBAAAM;AAAA,EAAA;AAEJ;"}

package/dist/i18n/en/Contractor.DocumentsList.json.js

@@ -1,28 +1,32 @@
-const t = "Documents", n = "Please review and sign your documents.", o = "Documents", e = "Name", s = "Status", c = "Sign document", u = "Not signed", a = "Complete", i = "No documents found", l = "Could not load your documents, try again later.", m = "Continue", d = {
+const t = "Documents", e = "Please review and sign your documents.", n = "Documents", o = "Name", s = "Status", c = "Sign document", a = "Not signed", u = "Complete", i = "W-9 isn't ready to sign yet", l = "The W-9 form hasn't been fully generated yet. Please check back later, or contact support if the problem continues.", d = "No documents found", r = "Could not load your documents, try again later.", m = "Continue", y = {
   title: t,
-  subtitle: n,
-  documentListLabel: o,
-  documentColumnLabel: e,
+  subtitle: e,
+  documentListLabel: n,
+  documentColumnLabel: o,
   statusColumnLabel: s,
   signDocumentCta: c,
-  notSigned: u,
-  signed: a,
-  emptyTitle: i,
-  errorTitle: l,
+  notSigned: a,
+  signed: u,
+  notReadyTitle: i,
+  notReadyBody: l,
+  emptyTitle: d,
+  errorTitle: r,
   continueCta: m
 };
 export {
   m as continueCta,
-  d as default,
-  e as documentColumnLabel,
-  o as documentListLabel,
-  i as emptyTitle,
-  l as errorTitle,
-  u as notSigned,
+  y as default,
+  o as documentColumnLabel,
+  n as documentListLabel,
+  d as emptyTitle,
+  r as errorTitle,
+  l as notReadyBody,
+  i as notReadyTitle,
+  a as notSigned,
   c as signDocumentCta,
-  a as signed,
+  u as signed,
   s as statusColumnLabel,
-  n as subtitle,
+  e as subtitle,
   t as title
 };
 //# sourceMappingURL=Contractor.DocumentsList.json.js.map

package/dist/i18n/en/Contractor.DocumentsList.json.js.map

@@ -1 +1 @@
-{"version":3,"file":"Contractor.DocumentsList.json.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
+{"version":3,"file":"Contractor.DocumentsList.json.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;"}

package/dist/i18n/types.d.ts

@@ -1783,6 +1783,10 @@ export namespace Translations {
     notSigned: string
     /** @defaultValue `"Complete"` */
     signed: string
+    /** @defaultValue `"W-9 isn't ready to sign yet"` */
+    notReadyTitle: string
+    /** @defaultValue `"The W-9 form hasn't been fully generated yet. Please check back later, or contact support if the problem continues."` */
+    notReadyBody: string
     /** @defaultValue `"No documents found"` */
     emptyTitle: string
     /** @defaultValue `"Could not load your documents, try again later."` */