feat: add currency related utility functions and update docs

Orfium · Oct 23, 2023 · f423dc3 · f423dc3
1 parent 137c071
commit f423dc3
Show file tree

Hide file tree

Showing 58 changed files with 259 additions and 50 deletions.
diff --git a/...i/components/LinkWithStatePassthrough.mdx → ...1-Components/LinkWithStatePassthrough.mdx b/...i/components/LinkWithStatePassthrough.mdx → ...1-Components/LinkWithStatePassthrough.mdx
diff --git a/...omponents/NavLinkWithStatePassthrough.mdx → ...omponents/NavLinkWithStatePassthrough.mdx b/...omponents/NavLinkWithStatePassthrough.mdx → ...omponents/NavLinkWithStatePassthrough.mdx
diff --git a/...tation/docs/api/components/Navigation.mdx → ...ion/docs/api/01-Components/Navigation.mdx b/...tation/docs/api/components/Navigation.mdx → ...ion/docs/api/01-Components/Navigation.mdx
diff --git a/...mponents/RedirectWithStatePassthrough.mdx → ...mponents/RedirectWithStatePassthrough.mdx b/...mponents/RedirectWithStatePassthrough.mdx → ...mponents/RedirectWithStatePassthrough.mdx
diff --git a/...mentation/docs/api/components/Toolbox.mdx → ...tation/docs/api/01-Components/Toolbox.mdx b/...mentation/docs/api/components/Toolbox.mdx → ...tation/docs/api/01-Components/Toolbox.mdx
diff --git a/documentation/docs/api/components/TopBar.mdx → ...ntation/docs/api/01-Components/TopBar.mdx b/documentation/docs/api/components/TopBar.mdx → ...ntation/docs/api/01-Components/TopBar.mdx
diff --git a/...tion/docs/api/hooks/useAuthentication.mdx → ...n/docs/api/02-Hooks/useAuthentication.mdx b/...tion/docs/api/hooks/useAuthentication.mdx → ...n/docs/api/02-Hooks/useAuthentication.mdx
diff --git a/documentation/docs/api/hooks/useData.md → documentation/docs/api/02-Hooks/useData.md b/documentation/docs/api/hooks/useData.md → documentation/docs/api/02-Hooks/useData.md
diff --git a/...ation/docs/api/hooks/useDataPagination.md → ...on/docs/api/02-Hooks/useDataPagination.md b/...ation/docs/api/hooks/useDataPagination.md → ...on/docs/api/02-Hooks/useDataPagination.md
diff --git a/...tation/docs/api/hooks/useDeferredValue.md → ...ion/docs/api/02-Hooks/useDeferredValue.md b/...tation/docs/api/hooks/useDeferredValue.md → ...ion/docs/api/02-Hooks/useDeferredValue.md
diff --git a/...tion/docs/api/hooks/useOrfiumProducts.mdx → ...n/docs/api/02-Hooks/useOrfiumProducts.mdx b/...tion/docs/api/hooks/useOrfiumProducts.mdx → ...n/docs/api/02-Hooks/useOrfiumProducts.mdx
diff --git a/...ation/docs/api/hooks/useOrganizations.mdx → ...on/docs/api/02-Hooks/useOrganizations.mdx b/...ation/docs/api/hooks/useOrganizations.mdx → ...on/docs/api/02-Hooks/useOrganizations.mdx
diff --git a/...entation/docs/api/hooks/useSafeContext.md → ...ation/docs/api/02-Hooks/useSafeContext.md b/...entation/docs/api/hooks/useSafeContext.md → ...ation/docs/api/02-Hooks/useSafeContext.md
diff --git a/...ntation/docs/api/hooks/useSafeDispatch.md → ...tion/docs/api/02-Hooks/useSafeDispatch.md b/...ntation/docs/api/hooks/useSafeDispatch.md → ...tion/docs/api/02-Hooks/useSafeDispatch.md
diff --git a/...ocs/api/hooks/useTopBarUtilitySection.mdx → .../api/02-Hooks/useTopBarUtilitySection.mdx b/...ocs/api/hooks/useTopBarUtilitySection.mdx → .../api/02-Hooks/useTopBarUtilitySection.mdx
diff --git a/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToAUD.mdx b/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToAUD.mdx
@@ -0,0 +1,22 @@
+---
+id: 'formatToAUD'
+title: 'formatToAUD'
+sidebar_label: 'formatToAUD'
+sidebar_position: 0
+custom_edit_url: null
+---
+
+`import { formatToAUD } from '@orfium/toolbox';`
+
+### Description
+
+A function for formatting a number or number-formatted string specifically to AUD.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToCAD.mdx b/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToCAD.mdx
@@ -0,0 +1,22 @@
+---
+id: 'formatToCAD'
+title: 'formatToCAD'
+sidebar_label: 'formatToCAD'
+sidebar_position: 0
+custom_edit_url: null
+---
+
+`import { formatToCAD } from '@orfium/toolbox';`
+
+### Description
+
+A function for formatting a number or number-formatted string specifically to CAD.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToCNY.mdx b/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToCNY.mdx
@@ -0,0 +1,22 @@
+---
+id: 'formatToCNY'
+title: 'formatToCNY'
+sidebar_label: 'formatToCNY'
+sidebar_position: 0
+custom_edit_url: null
+---
+
+`import { formatToCNY } from '@orfium/toolbox';`
+
+### Description
+
+A function for formatting a number or number-formatted string specifically to CNY.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/...mentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToCurrency.mdx b/...mentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToCurrency.mdx
@@ -0,0 +1,23 @@
+---
+id: 'formatToCurrency'
+title: 'formatToCurrency'
+sidebar_label: 'formatToCurrency'
+sidebar_position: -1
+custom_edit_url: null
+---
+
+`import { formatToCurrency } from '@orfium/toolbox';`
+
+### Description
+
+A generic function for formatting a number or number-formatted string to any valid currency.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `currency: string` - Must be a valid ISO 4217 currency code as specified [here](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes)
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToEUR.mdx b/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToEUR.mdx
@@ -0,0 +1,22 @@
+---
+id: 'formatToEUR'
+title: 'formatToEUR'
+sidebar_label: 'formatToEUR'
+sidebar_position: 0
+custom_edit_url: null
+---
+
+`import { formatToEUR } from '@orfium/toolbox';`
+
+### Description
+
+A function for formatting a number or number-formatted string specifically to EUR.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToGBP.mdx b/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToGBP.mdx
@@ -0,0 +1,22 @@
+---
+id: 'formatToGBP'
+title: 'formatToGBP'
+sidebar_label: 'formatToGBP'
+sidebar_position: 0
+custom_edit_url: null
+---
+
+`import { formatToGBP } from '@orfium/toolbox';`
+
+### Description
+
+A function for formatting a number or number-formatted string specifically to GBP.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToJPY.mdx b/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToJPY.mdx
@@ -0,0 +1,22 @@
+---
+id: 'formatToJPY'
+title: 'formatToJPY'
+sidebar_label: 'formatToJPY'
+sidebar_position: 0
+custom_edit_url: null
+---
+
+`import { formatToJPY } from '@orfium/toolbox';`
+
+### Description
+
+A function for formatting a number or number-formatted string specifically to JPY.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToUSD.mdx b/documentation/docs/api/03-Utilities/01-Functions/00-Currencies/formatToUSD.mdx
@@ -0,0 +1,22 @@
+---
+id: 'formatToUSD'
+title: 'formatToUSD'
+sidebar_label: 'formatToUSD'
+sidebar_position: 0
+custom_edit_url: null
+---
+
+`import { formatToUSD } from '@orfium/toolbox';`
+
+### Description
+
+A function for formatting a number or number-formatted string specifically to USD.
+
+### Parameters
+
+- `value: string | number` - If it's a string it must be expressing a number, otherwise you will get a runtime error
+- `options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>` - An [`options`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) compliant object, excluding the properties `currency` and `style`
+
+### Return value
+
+Ƭ `string`
diff --git a/...utilities/01-Functions/generateRoutes.mdx → ...Utilities/01-Functions/generateRoutes.mdx b/...utilities/01-Functions/generateRoutes.mdx → ...Utilities/01-Functions/generateRoutes.mdx
diff --git a/.../docs/api/utilities/02-Types/Optional.mdx → ...cs/api/03-Utilities/02-Types/Optional.mdx b/.../docs/api/utilities/02-Types/Optional.mdx → ...cs/api/03-Utilities/02-Types/Optional.mdx
@@ -5,7 +5,7 @@ sidebar_label: 'Optional'
 sidebar_position: 1
 custom_edit_url: null
 ---
-import Optional from '../../Types/Optional.mdx';
+import Optional from '../../04-Types/Optional.mdx';
 
 <Optional />
 

diff --git a/...ies/03-Singletons/orfiumIdBaseInstance.md → ...ies/03-Singletons/orfiumIdBaseInstance.md b/...ies/03-Singletons/orfiumIdBaseInstance.md → ...ies/03-Singletons/orfiumIdBaseInstance.md
diff --git a/...ies/04-Constants/DEFAULT_NAVBAR_HEIGHT.md → ...ies/04-Constants/DEFAULT_NAVBAR_HEIGHT.md b/...ies/04-Constants/DEFAULT_NAVBAR_HEIGHT.md → ...ies/04-Constants/DEFAULT_NAVBAR_HEIGHT.md
diff --git a/.../api/Types/AuthenticationContextValue.mdx → ...i/04-Types/AuthenticationContextValue.mdx b/.../api/Types/AuthenticationContextValue.mdx → ...i/04-Types/AuthenticationContextValue.mdx
diff --git a/...entation/docs/api/Types/Authorization.mdx → ...ation/docs/api/04-Types/Authorization.mdx b/...entation/docs/api/Types/Authorization.mdx → ...ation/docs/api/04-Types/Authorization.mdx
diff --git a/...n/docs/api/Types/DecodedTokenResponse.mdx → ...ocs/api/04-Types/DecodedTokenResponse.mdx b/...n/docs/api/Types/DecodedTokenResponse.mdx → ...ocs/api/04-Types/DecodedTokenResponse.mdx
diff --git a/...mentation/docs/api/Types/FallbackPath.mdx → ...tation/docs/api/04-Types/FallbackPath.mdx b/...mentation/docs/api/Types/FallbackPath.mdx → ...tation/docs/api/04-Types/FallbackPath.mdx
diff --git a/documentation/docs/api/Types/MenuItem.mdx → documentation/docs/api/04-Types/MenuItem.mdx b/documentation/docs/api/Types/MenuItem.mdx → documentation/docs/api/04-Types/MenuItem.mdx
diff --git a/...tation/docs/api/Types/NavigationProps.mdx → ...ion/docs/api/04-Types/NavigationProps.mdx b/...tation/docs/api/Types/NavigationProps.mdx → ...ion/docs/api/04-Types/NavigationProps.mdx
diff --git a/documentation/docs/api/Types/Optional.mdx → documentation/docs/api/04-Types/Optional.mdx b/documentation/docs/api/Types/Optional.mdx → documentation/docs/api/04-Types/Optional.mdx
diff --git a/.../api/Types/OrfiumProductsContextValue.mdx → ...i/04-Types/OrfiumProductsContextValue.mdx b/.../api/Types/OrfiumProductsContextValue.mdx → ...i/04-Types/OrfiumProductsContextValue.mdx
diff --git a/...mentation/docs/api/Types/Organization.mdx → ...tation/docs/api/04-Types/Organization.mdx b/...mentation/docs/api/Types/Organization.mdx → ...tation/docs/api/04-Types/Organization.mdx
diff --git a/...s/api/Types/OrganizationsContextValue.mdx → ...pi/04-Types/OrganizationsContextValue.mdx b/...s/api/Types/OrganizationsContextValue.mdx → ...pi/04-Types/OrganizationsContextValue.mdx
diff --git a/documentation/docs/api/Types/Product.mdx → documentation/docs/api/04-Types/Product.mdx b/documentation/docs/api/Types/Product.mdx → documentation/docs/api/04-Types/Product.mdx
diff --git a/...on/docs/api/Types/RouteComponentProps.mdx → ...docs/api/04-Types/RouteComponentProps.mdx b/...on/docs/api/Types/RouteComponentProps.mdx → ...docs/api/04-Types/RouteComponentProps.mdx
diff --git a/documentation/docs/api/Types/RouteItem.mdx → ...mentation/docs/api/04-Types/RouteItem.mdx b/documentation/docs/api/Types/RouteItem.mdx → ...mentation/docs/api/04-Types/RouteItem.mdx
diff --git a/...ation/docs/api/Types/RoutingStructure.mdx → ...on/docs/api/04-Types/RoutingStructure.mdx b/...ation/docs/api/Types/RoutingStructure.mdx → ...on/docs/api/04-Types/RoutingStructure.mdx
diff --git a/...mentation/docs/api/Types/ToolboxProps.mdx → ...tation/docs/api/04-Types/ToolboxProps.mdx b/...mentation/docs/api/Types/ToolboxProps.mdx → ...tation/docs/api/04-Types/ToolboxProps.mdx
diff --git a/documentation/docs/api/Types/TopBarProps.mdx → ...ntation/docs/api/04-Types/TopBarProps.mdx b/documentation/docs/api/Types/TopBarProps.mdx → ...ntation/docs/api/04-Types/TopBarProps.mdx
diff --git a/...ypes/TopBarUtilitySectionContextValue.mdx → ...ypes/TopBarUtilitySectionContextValue.mdx b/...ypes/TopBarUtilitySectionContextValue.mdx → ...ypes/TopBarUtilitySectionContextValue.mdx
diff --git a/documentation/docs/api/Types/User.mdx → documentation/docs/api/04-Types/User.mdx b/documentation/docs/api/Types/User.mdx → documentation/docs/api/04-Types/User.mdx
diff --git a/documentation/docs/api/_type-definitions/AuthenticationContextValue.md b/documentation/docs/api/_type-definitions/AuthenticationContextValue.md
@@ -2,7 +2,7 @@
 | :----------------------- |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `isAuthenticated`        | `boolean`                                                                                                                                                                                                  |
 | `isLoading`              | `boolean`                                                                                                                                                                                                  |
-| `user`                   | <code>[User](../Types/User) &#124; undefined</code>                                                                                                                                                        |
-| `getAccessTokenSilently` | <pre>(opts?: GetTokenSilentlyOptions) => Promise<<br/> void &#124; <br/> { <br/> decodedToken: [DecodedTokenResponse](../Types/DecodedTokenResponse) &#124; Record<string, never\> ; <br/> token: string; <br/> }<br/>\></pre> |
+| `user`                   | <code>[User](../04-Types/User) &#124; undefined</code>                                                                                                                                                        |
+| `getAccessTokenSilently` | <pre>(opts?: GetTokenSilentlyOptions) => Promise<<br/> void &#124; <br/> { <br/> decodedToken: [DecodedTokenResponse](../04-Types/DecodedTokenResponse) &#124; Record<string, never\> ; <br/> token: string; <br/> }<br/>\></pre> |
 | `loginWithRedirect`      | <code>(o?: RedirectLoginOptions<any\>) => Promise<void\></code>                                                                                                                                            |
 | `logout`                 | `() => void`                                                                                                                                                                                               |
diff --git a/documentation/docs/api/_type-definitions/MenuItem.md b/documentation/docs/api/_type-definitions/MenuItem.md
@@ -3,4 +3,4 @@
 | `text`      | `string`                                                                                           |
 | `url`       | `string`                                                                                           |
 | `iconName`  | `AcceptedIconNames`                                                                                |
-| `children?` | <code>[Optional](../utilities/Types/Optional)<[MenuItem](../Types/MenuItem), 'iconName'\>[]</code> |
+| `children?` | <code>[Optional](../03-Utilities/Types/Optional)<[MenuItem](../04-Types/MenuItem), 'iconName'\>[]</code> |
diff --git a/documentation/docs/api/_type-definitions/NavigationProps.md b/documentation/docs/api/_type-definitions/NavigationProps.md
@@ -1,11 +1,11 @@
 | Name                         | Type                                                                                                                                                                               |
 | :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `regularNavigation`          | <code>[MenuItem](../Types/MenuItem)[]</code>                                                                                                                                       |
+| `regularNavigation`          | <code>[MenuItem](../04-Types/MenuItem)[]</code>                                                                                                                                       |
 | `navigationHeader`           | `string`                                                                                                                                                                           |
 | `userIsAdmin?`               | `boolean` _(default: `false`)_                                                                                                                                                     |
 | `hideOrgSwitcher?`           | `boolean` _(default: `false`)_                                                                                                                                                     |
-| `adminNavigation?`           | <code>[MenuItem](../Types/MenuItem)[]</code>                                                                                                                                       |
+| `adminNavigation?`           | <code>[MenuItem](../04-Types/MenuItem)[]</code>                                                                                                                                       |
 | `adminNavigationHeader?`     | `string`                                                                                                                                                                           |
 | `adminNavigationURLSegment?` | `string`                                                                                                                                                                           |
 | `adminButtonTooltipText?`    | `string`                                                                                                                                                                           |
-| `extras?`                    | <code>{ title: string; menuItems: ([Omit](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)<[MenuItem](../Types/MenuItem), 'children'\>)[] }[]</code> |
+| `extras?`                    | <code>{ title: string; menuItems: ([Omit](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)<[MenuItem](../04-Types/MenuItem), 'children'\>)[] }[]</code> |
diff --git a/documentation/docs/api/_type-definitions/OrfiumProductsContextValue.md b/documentation/docs/api/_type-definitions/OrfiumProductsContextValue.md
@@ -1 +1 @@
-[`Product`](../Types/Product)`[] | null`
+[`Product`](../04-Types/Product)`[] | null`
diff --git a/documentation/docs/api/_type-definitions/OrganizationsContextValue.md b/documentation/docs/api/_type-definitions/OrganizationsContextValue.md
@@ -1,5 +1,5 @@
 | Name                   | Type                                                             |
 | :--------------------- | :--------------------------------------------------------------- |
-| `organizations`        | <code>[Organization](../Types/Organization)[]</code>             |
-| `selectedOrganization` | <code>[Organization](../Types/Organization)[] &#124; null</code> |
+| `organizations`        | <code>[Organization](../04-Types/Organization)[]</code>             |
+| `selectedOrganization` | <code>[Organization](../04-Types/Organization)[] &#124; null</code> |
 | `switchOrganization`   | `(organisation: string) => void`                                 |
diff --git a/documentation/docs/api/_type-definitions/RouteItem.md b/documentation/docs/api/_type-definitions/RouteItem.md
@@ -1,6 +1,6 @@
 | Name             | Type                                                                                       |
 | :--------------- | :----------------------------------------------------------------------------------------- |
 | `path`           | <code>string &#124; string[]</code>                                                        |
-| `authorization?` | [`Authorization`](../Types/Authorization)                                                  |
+| `authorization?` | [`Authorization`](../04-Types/Authorization)                                                  |
 | `extraProps?`    | `unknown`                                                                                  |
-| `component?`     | <code>React.FunctionComponent<[RouteComponentProps](../Types/RouteComponentProps)\></code> |
+| `component?`     | <code>React.FunctionComponent<[RouteComponentProps](../04-Types/RouteComponentProps)\></code> |
diff --git a/documentation/docs/api/_type-definitions/RoutingStructure.md b/documentation/docs/api/_type-definitions/RoutingStructure.md
@@ -1,4 +1,4 @@
 | Name            | Type                                                                          |
 | :-------------- | :---------------------------------------------------------------------------- |
-| `fallbackPaths` | <code>Partial<Record<[FallbackPath](../Types/FallbackPath), string\>\></code> |
-| `routes`        | <code>[RouteItem](../Types/RouteItem)[]</code>                                |
+| `fallbackPaths` | <code>Partial<Record<[FallbackPath](../04-Types/FallbackPath), string\>\></code> |
+| `routes`        | <code>[RouteItem](../04-Types/RouteItem)[]</code>                                |
diff --git a/documentation/docs/api/components/index.md b/documentation/docs/api/components/index.md
diff --git a/documentation/docs/api/hooks/index.md b/documentation/docs/api/hooks/index.md
diff --git a/documentation/docs/api/utilities/index.md b/documentation/docs/api/utilities/index.md
diff --git a/src/index.ts b/src/index.ts
@@ -4,6 +4,13 @@ export * from './routing';
 export type { Organization } from './store/organizations';
 export * from './ui';
 export {
+  formatToAUD,
+  formatToCAD,
+  formatToCurrency,
+  formatToEUR,
+  formatToGBP,
+  formatToJPY,
+  formatToUSD,
   LinkWithStatePassthrough,
   NavLinkWithStatePassthrough,
   RedirectWithStatePassthrough,

diff --git a/src/utils/currencies.ts b/src/utils/currencies.ts
@@ -0,0 +1,60 @@
+export function formatToCurrency(
+  value: number | string,
+  currency = 'USD',
+  options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>
+) {
+  if (typeof value === 'string' && isNaN(Number(value))) {
+    throw 'A string value must be expressing a proper numeric value';
+  }
+
+  return new Intl.NumberFormat('en-US', {
+    ...options,
+    style: 'currency',
+    currency: currency,
+    // Per spec, Intl.NumberFormat.prototype.format can accept a string value, however TS is not allowing it.
+    // Read this issue thread for more information: https://github.com/microsoft/TypeScript/issues/52124
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+  }).format(value);
+}
+export function formatToUSD(
+  value: number | string,
+  options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>
+) {
+  return formatToCurrency(value, 'USD', options);
+}
+
+export function formatToEUR(
+  value: number | string,
+  options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>
+) {
+  return formatToCurrency(value, 'EUR', options);
+}
+
+export function formatToGBP(
+  value: number | string,
+  options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>
+) {
+  return formatToCurrency(value, 'GBP', options);
+}
+
+export function formatToAUD(
+  value: number | string,
+  options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>
+) {
+  return formatToCurrency(value, 'AUD', options);
+}
+
+export function formatToCAD(
+  value: number | string,
+  options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>
+) {
+  return formatToCurrency(value, 'CAD', options);
+}
+
+export function formatToJPY(
+  value: number | string,
+  options?: Omit<Intl.NumberFormatOptions, 'currency' | 'style'>
+) {
+  return formatToCurrency(value, 'JPY', options);
+}
diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -1,3 +1,4 @@
+export * from './currencies';
 export * from './LinkWithStatePassthrough';
 export * from './NavLinkWithStatePassthrough';
 export * from './reactQuery';