@easygov/react-components 0.8.0 → 0.10.0

package/README.md

@@ -187,6 +187,34 @@ defines.
 the language now — read it with `useEasygovDisplayLanguage()`, set it with
 `setEasygovDisplayLanguage()`.
 
+### Publishing the business module's version
+
+A business module frontend embedding `EasygovHeader` can publish its own version number so it
+appears in the environment badge's tooltip alongside the library and backend versions:
+
+```ts
+import { setEasygovBusinessModuleVersion } from '@easygov/react-components';
+
+setEasygovBusinessModuleVersion('2.4.1');
+```
+
+Call it whenever your app knows its own version — at startup is typical. It can be called
+before or after any `EasygovHeader` has mounted, and calling it again later (e.g. after a
+version changes) simply updates the tooltip. Until it is called, the tooltip shows only the
+existing `UI-Version` and `Backend-Version` lines, exactly as it did before this API existed.
+
+Outside React — including `<eg-easygov-header>` — call the same setter on the web-components
+global instead:
+
+```js
+window.easygov.setBusinessModuleVersion('2.4.1');
+```
+
+**A page using `<eg-easygov-header>` must call `window.easygov.setBusinessModuleVersion`, not
+the npm function.** That bundle inlines its own copy of this library, so the npm function
+would write into a different store instance than the one the element reads from — the same
+caveat that already applies to `useEasygovDisplayLanguage` in that context (see above).
+
 ## License
 
 MIT

package/dist/easygov.d.mts

@@ -441,6 +441,32 @@ interface EasygovHeaderContext {
     claims: HeaderContextClaims | null;
 }
 
+interface EasygovVersionInfo {
+    /** This package's own version, from package.json — known synchronously, never null. */
+    libraryVersion: string;
+    /**
+     * The core-backend API version reported by GET /external/api/v1/version. Null until the
+     * first fetch resolves, and stays null forever on any failure (non-2xx, network error,
+     * unresolved origin, malformed body) — there is no retry.
+     */
+    backendVersion: string | null;
+    /**
+     * The embedding business module's own version, published via `setEasygovFunctionModuleVersion`.
+     * Null until a consumer calls the setter — EasygovHeader itself never sets this and has no
+     * way to discover it on its own, unlike backendVersion.
+     */
+    businessModuleVersion: string | null;
+}
+/**
+ * Publishes the embedding business module's own version into the store, so EasygovHeader's version
+ * tooltip can show it alongside the library and backend versions. Safe to call at any time —
+ * before or after any EasygovHeader mounts — and safe to call more than once; each call
+ * overwrites the previous value and notifies subscribers. There is no corresponding fetch:
+ * EasygovHeader has no way to discover a business module's version on its own, so this is the only
+ * way the field is ever set.
+ */
+declare function setEasygovBusinessModuleVersion(version: string): void;
+
 declare const dictionaries: {
     de: {
         readonly login: "Anmelden";
@@ -564,6 +590,14 @@ declare function useEasygovHeaderContext(): EasygovHeaderContext;
  * call, so a module can read it before any header has mounted.
  */
 declare function useEasygovDisplayLanguage(): Locale;
+/**
+ * The current version info: this package's own version (always known) and the core-backend
+ * API version (null until EasygovHeader's mount effect fetches it, or on fetch failure — see
+ * version-store.ts). Unlike useEasygovHeaderContext, no header needs to be mounted for
+ * `libraryVersion` to resolve; only `backendVersion` requires a mounted EasygovHeader to
+ * trigger the fetch.
+ */
+declare function useEasygovVersionInfo(): EasygovVersionInfo;
 interface EasygovHeaderProps {
     readonly onLanguageChange?: (locale: Locale) => void;
     readonly onNavigate?: (path: string) => void;
@@ -631,4 +665,4 @@ declare function getEasygovDisplayLanguage(): Locale;
 declare function setEasygovDisplayLanguage(locale: Locale): void;
 declare function subscribeEasygovDisplayLanguage(listener: () => void): () => void;
 
-export { type AuthStatus, BrandBase, BrandEasygov, BrandFacebook, BrandKdk, BrandLinkedin, type BrandProps, BrandSeg, BrandSgv, BrandSsv, BrandSwiss, BrandXing, BrandYoutube, Button, type ButtonProps, type DesktopSpan, Dropdown, DropdownChip, DropdownChipsOverflow, type DropdownChipsOverflowProps, DropdownChipsTrigger, type DropdownChipsTriggerProps, DropdownCollection, DropdownEmpty, DropdownGroup, DropdownGroupLabel, DropdownHelperText, type DropdownHelperTextProps, DropdownInput, DropdownItem, type DropdownItemProps, DropdownItemText, DropdownLabel, type DropdownLabelProps, DropdownList, DropdownPopup, type DropdownPopupProps, DropdownSeparator, DropdownToggle, DropdownTrigger, type DropdownTriggerProps, DropdownValue, EasygovFooter, EasygovHeader, type EasygovHeaderContext, type EasygovHeaderProps, type EasygovSession, ErrorDialog, type ErrorDialogProps, Grid, GridItem, type GridItemProps, type GridProps, type AccountVerificationStatus as HeaderContextAccountVerificationStatus, type HeaderContextClaims, type IndividualAccount as HeaderContextIndividualAccount, type ManagementRole as HeaderContextManagementRole, type ManagementRoleStatus as HeaderContextManagementRoleStatus, type ManagementRoleType as HeaderContextManagementRoleType, type OrganizationAccount as HeaderContextOrganizationAccount, type ProcessStatus as HeaderContextProcessStatus, type UserProfile as HeaderContextUserProfile, Heading, type HeadingProps, Input, type InputProps, type Locale, type MobileSpan, NavigationMenu, NavigationMenuAnchor, type NavigationMenuAnchorProps, NavigationMenuContent, type NavigationMenuContentProps, NavigationMenuItem, type NavigationMenuItemProps, NavigationMenuLink, type NavigationMenuLinkProps, NavigationMenuList, type NavigationMenuListProps, type NavigationMenuProps, NavigationMenuTrigger, type NavigationMenuTriggerProps, RequireCustomerAccount, type RequireCustomerAccountProps, RequireSession, type RequireSessionProps, Select, SelectContent, type SelectContentProps, SelectGroup, SelectGroupLabel, type SelectGroupLabelProps, SelectHelperText, type SelectHelperTextProps, SelectItem, type SelectItemProps, SelectLabel, type SelectLabelProps, SelectSeparator, type SelectSeparatorProps, SelectTrigger, type SelectTriggerProps, type SelectedCustomerAccount, type SelectedProcess, type SessionUser, type TabletSpan, Text, TextLink, type TextLinkProps, type TextProps, buttonVariants, getAuthStatus, getEasygovDisplayLanguage, headingVariants, requireSession, setEasygovDisplayLanguage, subscribeEasygovDisplayLanguage, textLinkVariants, textVariants, useEasygovAuthStatus, useEasygovDisplayLanguage, useEasygovHeaderContext, useEasygovSession, useRequireCustomerAccount };
+export { type AuthStatus, BrandBase, BrandEasygov, BrandFacebook, BrandKdk, BrandLinkedin, type BrandProps, BrandSeg, BrandSgv, BrandSsv, BrandSwiss, BrandXing, BrandYoutube, Button, type ButtonProps, type DesktopSpan, Dropdown, DropdownChip, DropdownChipsOverflow, type DropdownChipsOverflowProps, DropdownChipsTrigger, type DropdownChipsTriggerProps, DropdownCollection, DropdownEmpty, DropdownGroup, DropdownGroupLabel, DropdownHelperText, type DropdownHelperTextProps, DropdownInput, DropdownItem, type DropdownItemProps, DropdownItemText, DropdownLabel, type DropdownLabelProps, DropdownList, DropdownPopup, type DropdownPopupProps, DropdownSeparator, DropdownToggle, DropdownTrigger, type DropdownTriggerProps, DropdownValue, EasygovFooter, EasygovHeader, type EasygovHeaderContext, type EasygovHeaderProps, type EasygovSession, type EasygovVersionInfo, ErrorDialog, type ErrorDialogProps, Grid, GridItem, type GridItemProps, type GridProps, type AccountVerificationStatus as HeaderContextAccountVerificationStatus, type HeaderContextClaims, type IndividualAccount as HeaderContextIndividualAccount, type ManagementRole as HeaderContextManagementRole, type ManagementRoleStatus as HeaderContextManagementRoleStatus, type ManagementRoleType as HeaderContextManagementRoleType, type OrganizationAccount as HeaderContextOrganizationAccount, type ProcessStatus as HeaderContextProcessStatus, type UserProfile as HeaderContextUserProfile, Heading, type HeadingProps, Input, type InputProps, type Locale, type MobileSpan, NavigationMenu, NavigationMenuAnchor, type NavigationMenuAnchorProps, NavigationMenuContent, type NavigationMenuContentProps, NavigationMenuItem, type NavigationMenuItemProps, NavigationMenuLink, type NavigationMenuLinkProps, NavigationMenuList, type NavigationMenuListProps, type NavigationMenuProps, NavigationMenuTrigger, type NavigationMenuTriggerProps, RequireCustomerAccount, type RequireCustomerAccountProps, RequireSession, type RequireSessionProps, Select, SelectContent, type SelectContentProps, SelectGroup, SelectGroupLabel, type SelectGroupLabelProps, SelectHelperText, type SelectHelperTextProps, SelectItem, type SelectItemProps, SelectLabel, type SelectLabelProps, SelectSeparator, type SelectSeparatorProps, SelectTrigger, type SelectTriggerProps, type SelectedCustomerAccount, type SelectedProcess, type SessionUser, type TabletSpan, Text, TextLink, type TextLinkProps, type TextProps, buttonVariants, getAuthStatus, getEasygovDisplayLanguage, headingVariants, requireSession, setEasygovBusinessModuleVersion, setEasygovDisplayLanguage, subscribeEasygovDisplayLanguage, textLinkVariants, textVariants, useEasygovAuthStatus, useEasygovDisplayLanguage, useEasygovHeaderContext, useEasygovSession, useEasygovVersionInfo, useRequireCustomerAccount };