@easygov/react-components 0.9.0 → 0.11.0

package/README.md

@@ -76,8 +76,8 @@ that runs it.
 
 ### Reading the header context
 
-The header resolves the signed-in user, the selected customer account, the running process and
-its ancestor chain (if the URL addresses a sub-process) from core-backend and publishes them to
+The header resolves the signed-in user, the selected customer account, and the running process
+or the parent process a sub-process is being created under, from core-backend and publishes them to
 consumers:
 
 ```tsx
@@ -86,7 +86,7 @@ import { useEasygovHeaderContext } from '@easygov/react-components';
 function ContactForm() {
   const { claims } = useEasygovHeaderContext();
   const account = claims?.customerAccount;
-  const parentProcess = claims?.parentProcesses?.[0];
+  const parentProcess = claims?.parentProcess;
 
   return (
     <form>
@@ -99,14 +99,13 @@ function ContactForm() {
 }
 ```
 
-`claims.parentProcesses` lists the ancestors of the addressed Behördengang, nearest first — index
-0 is the direct parent, ascending toward the root — and is absent (not `[]`) when there is none.
-If it is present while `claims.process` is absent, a sub-process is about to be created under
-`parentProcesses[0]`, which is then the addressed Process itself and not a selected Behördengang.
-Each `SelectedProcess` (in `claims.process` and `claims.parentProcesses`) also carries its own
-`parentProcessId` — the global identifier of its parent, absent for a top-level Behördengang —
-so a consumer can identify ancestry per node after flattening `parentProcesses` into a map,
-without relying solely on the array's ordering.
+`claims.process` and `claims.parentProcess` are mutually exclusive. `process` is the Behördengang
+the URL selects (`/process/{id}`). `parentProcess` is the Behördengang a sub-process is about to be
+created under (`/parentprocess/{id}`) — not a selected Behördengang. Neither is present when the
+URL addresses no process. Each `SelectedProcess` carries its own `parentProcessId`, the global
+identifier of its parent, absent for a top-level Behördengang. That reference is the only
+representation of a selected process's parent: the context carries no ancestor chain, because it
+is forwarded as an HTTP header where 4/8 KB size limits apply.
 
 `claims` is `null` until the first response lands and again after logout — render a fallback,
 don't assume it is present on first paint. The hook reflects the last context an `EasygovHeader`
@@ -187,6 +186,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

@@ -390,9 +390,9 @@ interface SelectedProcess {
         individualServicePermissionModel: boolean;
     };
     /**
-     * Global identifier of this process's own parent. Absent for a top-level Behördengang.
-     * Lets a client identify ancestry per node — e.g. after flattening `parentProcesses` into a
-     * map — without relying solely on that array's documented ordering.
+     * Global identifier of this process's own parent. Absent for a top-level Behördengang. This
+     * reference is the only representation of a selected process's parent: the context carries no
+     * ancestor chain.
      */
     parentProcessId?: string;
 }
@@ -419,16 +419,16 @@ interface UserProfile {
 interface HeaderContextClaims {
     currentUser: UserProfile;
     customerAccount?: SelectedCustomerAccount;
+    /**
+     * The Behördengang the URL selects (`/process/{id}`). Mutually exclusive with `parentProcess`.
+     */
     process?: SelectedProcess;
     /**
-     * Ancestors of the addressed Behördengang, nearest first: index 0 is the direct parent,
-     * ascending toward the root. Absent — not an empty array — when there is none.
-     *
-     * Present while `process` is absent means a sub-process is about to be created under
-     * `parentProcesses[0]`, which is then the addressed Process itself and NOT a selected
-     * Behördengang. That is the `/parentprocess/{id}` URL form.
+     * The Behördengang a sub-process is about to be created under (`/parentprocess/{id}`).
+     * Mutually exclusive with `process`, and NOT a selected Behördengang. A selected process's own
+     * parent is never included as an object — only as `process.parentProcessId`.
      */
-    parentProcesses?: SelectedProcess[];
+    parentProcess?: SelectedProcess;
 }
 
 interface EasygovHeaderContext {
@@ -450,7 +450,22 @@ interface EasygovVersionInfo {
      * 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: {
@@ -650,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, 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, setEasygovDisplayLanguage, subscribeEasygovDisplayLanguage, textLinkVariants, textVariants, useEasygovAuthStatus, useEasygovDisplayLanguage, useEasygovHeaderContext, useEasygovSession, useEasygovVersionInfo, 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 };