@stokr/components-library 3.0.53-alpha.1 → 3.0.54

package/README.md

@@ -1,166 +1,166 @@
-# @stokr/components-library
-
-React UI library for STOKR apps: modals, forms, navigation, tables, auth context, styles.
-
-## Contents
-
-- [Quick start](#quick-start) — install, router, `AuthProvider`, styles
-- [Configuration reference](#runtime-config) — `config` keys & helpers
-- [AuthProvider & AuthContext](#authprovider-optional-props)
-- [Troubleshooting](#troubleshooting)
-- [Development](#development--publishing)
-
----
-
-## Quick start
-
-**Install**
-
-```bash
-npm install @stokr/components-library
-npm install react react-dom styled-components react-router-dom
-```
-
-Peers: React 18+/19+, styled-components 6.x, react-router-dom 6.x when you use routing-driven components (`HeaderHo`, `MainMenu`, …).
-
-**1. Router** — Navigation helpers need a React Router:
-
-```jsx
-import { BrowserRouter } from 'react-router-dom'
-import { RouterWrapper } from '@stokr/components-library'
-
-// Normal app
-root.render(
-  <BrowserRouter>
-    <App />
-  </BrowserRouter>,
-)
-
-// Outside a Router: RouterWrapper wraps children in BrowserRouter once.
-// Inside an existing Router: it renders children only (no nested BrowserRouter).
-root.render(
-  <RouterWrapper>
-    <App />
-  </RouterWrapper>,
-)
-```
-
-**2. Auth & runtime config (required when consuming via npm)** — Vite freezes `import.meta.env` inside pre-built deps, so push your `.env` at runtime via `config`:
-
-```jsx
-import { AuthProvider } from '@stokr/components-library'
-
-export default function App() {
-  return (
-    <AuthProvider
-      config={{
-        apiUrl: import.meta.env.VITE_API_URL,
-        baseUrlPublic: import.meta.env.VITE_BASE_URL_PUBLIC,
-        cookieDomain: import.meta.env.VITE_COOKIE_DOMAIN,
-        websiteDomain: import.meta.env.VITE_WEBSITE_DOMAIN,
-        photoApiUrl: import.meta.env.VITE_PHOTO_API_URL,
-        onboardingUrl: import.meta.env.VITE_ONBOARDING_URL,
-        dashboardUrl: import.meta.env.VITE_DASHBOARD_URL,
-        adminUrl: import.meta.env.VITE_ADMIN_URL,
-        registerUrl: import.meta.env.VITE_REGISTER_URL,
-        firebase: {
-          apiKey: import.meta.env.VITE_FIREBASE_API_KEY,
-          authDomain: import.meta.env.VITE_FIREBASE_AUTH_DOMAIN,
-          projectId: import.meta.env.VITE_FIREBASE_PROJECT_ID,
-          storageBucket: import.meta.env.VITE_FIREBASE_STORAGE_BUCKET,
-          messagingSenderId: import.meta.env.VITE_FIREBASE_MESSAGING_SENDER_ID,
-          appId: import.meta.env.VITE_FIREBASE_APP_ID,
-          measurementId: import.meta.env.VITE_FIREBASE_MEASUREMENT_ID,
-        },
-      }}>
-      {/* app */}
-    </AuthProvider>
-  )
-}
-```
-
-**3. Earlier config** (e.g. analytics before mount): `import { configure } from '@stokr/components-library'` with the same shape as `config`.
-
-**4. Icons / fonts** — Optional: `<IoniconsStyles />` at root, or rely on lazy injection when a component uses icons; for Layout / Open Sans: `import '@stokr/components-library/styles.css'`.
-
-**5. Imports** — `import { ConfirmModal, Button, … } from '@stokr/components-library'`.
-
-Full URL env example:
-
-```bash
-VITE_WEBSITE_DOMAIN=example.com
-VITE_ONBOARDING_URL=https://signup.example.com
-VITE_DASHBOARD_URL=https://dashboard.example.com
-VITE_ADMIN_URL=https://admin.example.com
-VITE_REGISTER_URL=https://example.com/signup
-```
-
----
-
-## Configuration reference {#runtime-config}
-
-| `config` key      | Typical `VITE_*`           | Role                                      |
-| ----------------- | -------------------------- | ----------------------------------------- |
-| `apiUrl`          | `VITE_API_URL`             | Authenticated REST base                   |
-| `baseUrlPublic`   | `VITE_BASE_URL_PUBLIC`     | Public API base                           |
-| `cookieDomain`    | `VITE_COOKIE_DOMAIN`       | Auth cookie `domain` attribute            |
-| `websiteDomain`   | `VITE_WEBSITE_DOMAIN`      | Bare host → links / `getPlatformURL()`    |
-| `photoApiUrl`     | `VITE_PHOTO_API_URL`       | Avatars / media                           |
-| `onboardingUrl`   | `VITE_ONBOARDING_URL`      | Full signup/sign-in app URL               |
-| `dashboardUrl`    | `VITE_DASHBOARD_URL`       | Investor dashboard URL                    |
-| `adminUrl`        | `VITE_ADMIN_URL`           | Venture / admin dashboard URL             |
-| `registerUrl`     | `VITE_REGISTER_URL`        | Public registration entry                 |
-| `firebase`        | `VITE_FIREBASE_*`          | Firebase client config                    |
-
-**Helpers:** `getConfig('…')` for any key above; `getPlatformURL()` → `https://{websiteDomain}`; `getAnalyticsIngestUrl()`, `getBackofficeAppUrl(path)`; **`getFooterGroups()`** replaces static footer URL lists.
-
-**Auth-only HTTP:** `authenticationApi.post(segment, body)` for `auth/*`; default axios stays the main API client after login.
-
-Missing overrides may trigger a **one-time** warning listing unresolved `VITE_*` expectations.
-
----
-
-## AuthProvider & AuthContext {#authprovider-optional-props}
-
-`AuthProvider` is wrapped with **`withRouter`** — mount it inside a **`Router`** so redirects work.
-
-### Optional provider props
-
-- **`inactivityTimeMs`** — Idle timeout before auto-logout + session modal (default 5 min).
-- **`accessTokenExpiryMs`** — Cookie TTL when **`Auth.setAccessToken`** runs (default **`DEFAULT_TOKEN_EXPIRY_MS`** = 1 h); not extended by **`getUser`** alone.
-- **`hideInactivityModal`** — Suppress built-in session modal.
-- **`customValidateGetUser(user)`** — Hook after **`user/get`** succeeds (see `src/context/AuthContext.js`).
-
-### AuthContext consumer {#authcontext-usecontext}
-
-`import { AuthContext } from '…'` then `useContext(AuthContext)`.
-
-- **Invalid Firebase guard:** value is **`{ user: null, isFetchingUser: false }`** only (no methods).
-- **State (grouped):** `user` / `firebaseUser`, `isFetchingUser`, `avatar`; MFA (`waitingFor2fa`, `userMfaEnrollment`, `firebaseError`); verify-email (`verifyEmailError`, `isVerifyingEmail`); session UX (`loggedOutDueToInactivity`, `loggedOutDueToCookieExpiry`, `sessionExpiryPendingReason`).
-- **Actions (grouped):** `userRef`, `loginUser`, `logoutUser`, `getUser`, `setUser`, `updateUser`, `refreshIdToken`; `checkUserIsValid`, `checkTokenIsValid`; `uploadPhoto`, `deletePhoto`, `checkUserPhoto`; MFA enroll / verify / unenroll + `reset2faFlow`; subscription/onboarding helpers; password & email (`handleResetPassword`, `handleVerifyEmail`, `requestUpdateEmail`, …); wallets / PoA (`uploaProofOfAddress` keeps the source spelling); **`dismissSessionExpiryModal`**.
-
-Use **`AuthConsumer`** for the render-prop pattern.
-
----
-
-## Troubleshooting {#troubleshooting}
-
-**`useNavigate` / Router**
-
-Add `BrowserRouter` (or **`RouterWrapper`** from this package where the shell has no router). Install `react-router-dom`.
-
-**Invalid hook call / duplicated React**
-
-Dedupe peers in Vite: `resolve: { dedupe: ['react', 'react-dom', 'styled-components'] }`.
-
----
-
-## Development {#development--publishing}
-
-| Command              | Meaning                          |
-| -------------------- | -------------------------------- |
-| `npm run storybook`  | Local docs / stories             |
-| `npm run build:dist` | Library build + static copy      |
-| `npm run pub`        | Build then publish (`npm login`) |
-
-Release: changelog entry → `npm version` → `npm run pub`. Details: [CHANGELOG.md](CHANGELOG.md).
+# @stokr/components-library
+
+React UI library for STOKR apps: modals, forms, navigation, tables, auth context, styles.
+
+## Contents
+
+- [Quick start](#quick-start) — install, router, `AuthProvider`, styles
+- [Configuration reference](#runtime-config) — `config` keys & helpers
+- [AuthProvider & AuthContext](#authprovider-optional-props)
+- [Troubleshooting](#troubleshooting)
+- [Development](#development--publishing)
+
+---
+
+## Quick start
+
+**Install**
+
+```bash
+npm install @stokr/components-library
+npm install react react-dom styled-components react-router-dom
+```
+
+Peers: React 18+/19+, styled-components 6.x, react-router-dom 6.x when you use routing-driven components (`HeaderHo`, `MainMenu`, …).
+
+**1. Router** — Navigation helpers need a React Router:
+
+```jsx
+import { BrowserRouter } from 'react-router-dom'
+import { RouterWrapper } from '@stokr/components-library'
+
+// Normal app
+root.render(
+  <BrowserRouter>
+    <App />
+  </BrowserRouter>,
+)
+
+// Outside a Router: RouterWrapper wraps children in BrowserRouter once.
+// Inside an existing Router: it renders children only (no nested BrowserRouter).
+root.render(
+  <RouterWrapper>
+    <App />
+  </RouterWrapper>,
+)
+```
+
+**2. Auth & runtime config (required when consuming via npm)** — Vite freezes `import.meta.env` inside pre-built deps, so push your `.env` at runtime via `config`:
+
+```jsx
+import { AuthProvider } from '@stokr/components-library'
+
+export default function App() {
+  return (
+    <AuthProvider
+      config={{
+        apiUrl: import.meta.env.VITE_API_URL,
+        baseUrlPublic: import.meta.env.VITE_BASE_URL_PUBLIC,
+        cookieDomain: import.meta.env.VITE_COOKIE_DOMAIN,
+        websiteDomain: import.meta.env.VITE_WEBSITE_DOMAIN,
+        photoApiUrl: import.meta.env.VITE_PHOTO_API_URL,
+        onboardingUrl: import.meta.env.VITE_ONBOARDING_URL,
+        dashboardUrl: import.meta.env.VITE_DASHBOARD_URL,
+        adminUrl: import.meta.env.VITE_ADMIN_URL,
+        registerUrl: import.meta.env.VITE_REGISTER_URL,
+        firebase: {
+          apiKey: import.meta.env.VITE_FIREBASE_API_KEY,
+          authDomain: import.meta.env.VITE_FIREBASE_AUTH_DOMAIN,
+          projectId: import.meta.env.VITE_FIREBASE_PROJECT_ID,
+          storageBucket: import.meta.env.VITE_FIREBASE_STORAGE_BUCKET,
+          messagingSenderId: import.meta.env.VITE_FIREBASE_MESSAGING_SENDER_ID,
+          appId: import.meta.env.VITE_FIREBASE_APP_ID,
+          measurementId: import.meta.env.VITE_FIREBASE_MEASUREMENT_ID,
+        },
+      }}>
+      {/* app */}
+    </AuthProvider>
+  )
+}
+```
+
+**3. Earlier config** (e.g. analytics before mount): `import { configure } from '@stokr/components-library'` with the same shape as `config`.
+
+**4. Icons / fonts** — Optional: `<IoniconsStyles />` at root, or rely on lazy injection when a component uses icons; for Layout / Open Sans: `import '@stokr/components-library/styles.css'`.
+
+**5. Imports** — `import { ConfirmModal, Button, … } from '@stokr/components-library'`.
+
+Full URL env example:
+
+```bash
+VITE_WEBSITE_DOMAIN=example.com
+VITE_ONBOARDING_URL=https://signup.example.com
+VITE_DASHBOARD_URL=https://dashboard.example.com
+VITE_ADMIN_URL=https://admin.example.com
+VITE_REGISTER_URL=https://example.com/signup
+```
+
+---
+
+## Configuration reference {#runtime-config}
+
+| `config` key      | Typical `VITE_*`           | Role                                      |
+| ----------------- | -------------------------- | ----------------------------------------- |
+| `apiUrl`          | `VITE_API_URL`             | Authenticated REST base                   |
+| `baseUrlPublic`   | `VITE_BASE_URL_PUBLIC`     | Public API base                           |
+| `cookieDomain`    | `VITE_COOKIE_DOMAIN`       | Auth cookie `domain` attribute            |
+| `websiteDomain`   | `VITE_WEBSITE_DOMAIN`      | Bare host → links / `getPlatformURL()`    |
+| `photoApiUrl`     | `VITE_PHOTO_API_URL`       | Avatars / media                           |
+| `onboardingUrl`   | `VITE_ONBOARDING_URL`      | Full signup/sign-in app URL               |
+| `dashboardUrl`    | `VITE_DASHBOARD_URL`       | Investor dashboard URL                    |
+| `adminUrl`        | `VITE_ADMIN_URL`           | Venture / admin dashboard URL             |
+| `registerUrl`     | `VITE_REGISTER_URL`        | Public registration entry                 |
+| `firebase`        | `VITE_FIREBASE_*`          | Firebase client config                    |
+
+**Helpers:** `getConfig('…')` for any key above; `getPlatformURL()` → `https://{websiteDomain}`; `getAnalyticsIngestUrl()`, `getBackofficeAppUrl(path)`; **`getFooterGroups()`** replaces static footer URL lists.
+
+**Auth-only HTTP:** `authenticationApi.post(segment, body)` for `auth/*`; default axios stays the main API client after login.
+
+Missing overrides may trigger a **one-time** warning listing unresolved `VITE_*` expectations.
+
+---
+
+## AuthProvider & AuthContext {#authprovider-optional-props}
+
+`AuthProvider` is wrapped with **`withRouter`** — mount it inside a **`Router`** so redirects work.
+
+### Optional provider props
+
+- **`inactivityTimeMs`** — Idle timeout before auto-logout + session modal (default 5 min).
+- **`accessTokenExpiryMs`** — Cookie TTL when **`Auth.setAccessToken`** runs (default **`DEFAULT_TOKEN_EXPIRY_MS`** = 1 h); not extended by **`getUser`** alone.
+- **`hideInactivityModal`** — Suppress built-in session modal.
+- **`customValidateGetUser(user)`** — Hook after **`user/get`** succeeds (see `src/context/AuthContext.js`).
+
+### AuthContext consumer {#authcontext-usecontext}
+
+`import { AuthContext } from '…'` then `useContext(AuthContext)`.
+
+- **Invalid Firebase guard:** value is **`{ user: null, isFetchingUser: false }`** only (no methods).
+- **State (grouped):** `user` / `firebaseUser`, `isFetchingUser`, `avatar`; MFA (`waitingFor2fa`, `userMfaEnrollment`, `firebaseError`); verify-email (`verifyEmailError`, `isVerifyingEmail`); session UX (`loggedOutDueToInactivity`, `loggedOutDueToCookieExpiry`, `sessionExpiryPendingReason`).
+- **Actions (grouped):** `userRef`, `loginUser`, `logoutUser`, `getUser`, `setUser`, `updateUser`, `refreshIdToken`; `checkUserIsValid`, `checkTokenIsValid`; `uploadPhoto`, `deletePhoto`, `checkUserPhoto`; MFA enroll / verify / unenroll + `reset2faFlow`; subscription/onboarding helpers; password & email (`handleResetPassword`, `handleVerifyEmail`, `requestUpdateEmail`, …); wallets / PoA (`uploaProofOfAddress` keeps the source spelling); **`dismissSessionExpiryModal`**.
+
+Use **`AuthConsumer`** for the render-prop pattern.
+
+---
+
+## Troubleshooting {#troubleshooting}
+
+**`useNavigate` / Router**
+
+Add `BrowserRouter` (or **`RouterWrapper`** from this package where the shell has no router). Install `react-router-dom`.
+
+**Invalid hook call / duplicated React**
+
+Dedupe peers in Vite: `resolve: { dedupe: ['react', 'react-dom', 'styled-components'] }`.
+
+---
+
+## Development {#development--publishing}
+
+| Command              | Meaning                          |
+| -------------------- | -------------------------------- |
+| `npm run storybook`  | Local docs / stories             |
+| `npm run build:dist` | Library build + static copy      |
+| `npm run pub`        | Build then publish (`npm login`) |
+
+Release: changelog entry → `npm version` → `npm run pub`. Details: [CHANGELOG.md](CHANGELOG.md).

package/dist/components/Footer/FooterLayout.js

@@ -69,9 +69,9 @@ function getFooterGroups() {
         {
           name: "Cookie policy",
           url: `${platformURL}/cookie-policy`
-        }
-        // { name: 'Complaints', url: `${platformURL}/complaints` },
-        // { name: 'Conflicts of Interest', url: `${platformURL}/conflicts-of-interest` },
+        },
+        { name: "Complaints", url: `${platformURL}/complaints` },
+        { name: "Conflicts of Interest", url: `${platformURL}/conflicts-of-interest` }
       ]
     },
     {

package/dist/index.js

@@ -130,7 +130,7 @@ import { generateCoreChecklistTasks, getVerifyIdentityChecklist } from "./utils/
 import { CopyToClipBoardTooltip, copyTextToClipboard, useCopyToClipboard, withCopyToClipboard } from "./utils/copyToClipboard.js";
 import { cooldownHOC, useComponentVisible, useContainerSize, useCooldown, useMobileView, usePrevious } from "./utils/customHooks.js";
 import { fixDecimals } from "./utils/fix-decimals.js";
-import { formatCurrencyValue, getCurrencyIcon, getCurrencySymbol, getLiquidAssetIcon, getProjectCurrencySign } from "./utils/formatCurrencyValue.js";
+import { CURRENCY_CONFIG, formatCurrencyValue, getCurrencyConfig, getCurrencyIcon, getCurrencySymbol, getLiquidAssetIcon, getProjectCurrencySign } from "./utils/formatCurrencyValue.js";
 import { isUSInvestor, usCountries } from "./utils/isUSInvestor.js";
 import { km_ify } from "./utils/km_ify.js";
 import { momentUtils } from "./utils/moment.js";
@@ -144,6 +144,8 @@ import { navigateToHref, pathnameIfSameOrigin } from "./routing/navigate-app.js"
 import { RouterWrapper } from "./routing/RouterWrapper.js";
 import { isAlreadyOnOnboardingFlow } from "./utils/app-urls.js";
 import { authenticationApi } from "./api/authenticationApi.js";
+import { Auth, DEFAULT_TOKEN_EXPIRY_MS } from "./context/Auth.js";
+import { AuthConsumer, AuthContext, AuthProvider } from "./context/AuthContext.js";
 import { colors } from "./styles/colors.js";
 import { default as default2 } from "./styles/fonts.js";
 import { GlobalStyle } from "./styles/global.js";
@@ -159,8 +161,6 @@ import { LoanActivityTypes, ProfessionalInvestorStatuses, ProjectStates, Project
 import { default as default9 } from "./components/SvgIcons/AdminBadgeSvg.js";
 import { Arrow } from "./components/icons/Arrow.js";
 import { ArrowSimple } from "./components/icons/ArrowSimple.js";
-import { Auth, DEFAULT_TOKEN_EXPIRY_MS } from "./context/Auth.js";
-import { AuthConsumer, AuthContext, AuthProvider } from "./context/AuthContext.js";
 import { BackButtonIcon, StyledBackButton, StyledBackButtonExternal, StyledWindowBackButton } from "./components/BackButton/BackButton.styles.js";
 import { Breakdown } from "./components/breakdown/Breakdown.js";
 import { default as default10 } from "./components/SvgIcons/CameraSvg.js";
@@ -276,6 +276,7 @@ export {
   ButtonGridContainer,
   CAPITAL_ANIMATION_LENGTH,
   COLUMN,
+  CURRENCY_CONFIG,
   default10 as CameraSvg,
   default11 as CapsLockSvg,
   CaptialRaisedSummary,
@@ -613,6 +614,7 @@ export {
   getAnalyticsIngestUrl,
   getBackofficeAppUrl,
   getConfig,
+  getCurrencyConfig,
   getCurrencyIcon,
   getCurrencySymbol,
   getFooterGroups,

package/dist/manifest.json

@@ -1,25 +1,25 @@
-{
-  "short_name": "Vite React App",
-  "name": "Vite React App",
-  "icons": [
-    {
-      "src": "favicon.ico",
-      "sizes": "64x64 32x32 24x24 16x16",
-      "type": "image/x-icon"
-    },
-    {
-      "src": "logo192.png",
-      "type": "image/png",
-      "sizes": "192x192"
-    },
-    {
-      "src": "logo512.png",
-      "type": "image/png",
-      "sizes": "512x512"
-    }
-  ],
-  "start_url": ".",
-  "display": "standalone",
-  "theme_color": "#000000",
-  "background_color": "#ffffff"
-}
+{
+  "short_name": "Vite React App",
+  "name": "Vite React App",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

package/dist/robots.txt

@@ -1,3 +1,3 @@
-# https://www.robotstxt.org/robotstxt.html
-User-agent: *
-Disallow:
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

package/dist/runtime-config.js

@@ -1,4 +1,4 @@
-const __vite_import_meta_env__ = { "BASE_URL": "/", "DEV": false, "MODE": "production", "PROD": true, "SSR": false, "VITE_ADMIN_URL": "https://admin.stokr.info", "VITE_API_URL": "https://platform-api.stokr.info/api/v1", "VITE_BASE_URL_PUBLIC": "https://platform-api-no-auth.stokr.info/api/v1", "VITE_COOKIE_DOMAIN": "localhost", "VITE_DASHBOARD_URL": "https://dashboard.stokr.info", "VITE_FIREBASE_API_KEY": "AIzaSyBBp_3Romnfv--YpUuV0mJgDymvSp3oq0c", "VITE_FIREBASE_APP_ID": "1:568229412804:web:2391857e3e2a0b02346e91", "VITE_FIREBASE_AUTH_DOMAIN": "stokr-development-env.firebaseapp.com", "VITE_FIREBASE_MEASUREMENT_ID": "G-CP53SZVSMN", "VITE_FIREBASE_MESSAGING_SENDER_ID": "568229412804", "VITE_FIREBASE_PROJECT_ID": "stokr-development-env", "VITE_FIREBASE_STORAGE_BUCKET": "stokr-development-env.appspot.com", "VITE_MIXPANEL_TOKEN": "a7bb1e881f9b2600762fded84d8ce0ea", "VITE_ONBOARDING_URL": "https://signup.stokr.info", "VITE_PHOTO_API_URL": "https://platform-api.stokr.info/api/v1", "VITE_REGISTER_URL": "https://stokr.info/signup", "VITE_WEBSITE_DOMAIN": "stokr.info" };
+const __vite_import_meta_env__ = { "BASE_URL": "/", "DEV": false, "MODE": "production", "PROD": true, "SSR": false };
 const _overrides = {};
 const ENV_KEY_BY_CONFIG = {
   apiUrl: "VITE_API_URL",