@the-portland-company/shell 0.82.0 → 0.84.0

package/dist/{index-C3PFq1hl.d.cts → index--q40spnY.d.cts}

@@ -28,6 +28,41 @@ declare function FormColumn({ children, className }: FormColumnProps): react_jsx
  */
 type TopBarIconSlot = 'comms-fuel' | 'apps' | 'notifications' | 'alerts' | 'support' | 'dark-mode';
 
+type CreditHealthState = "good" | "low" | "out" | "not_in_use";
+/** What the icon shows: the worst state among the types in use, or unknown. */
+type CreditsIconState = "good" | "low" | "out" | "unknown";
+type CreditTypeKey = "signal" | "broadcast" | "ai" | "enhancement";
+declare const CREDIT_TYPE_ORDER: readonly CreditTypeKey[];
+declare const CREDIT_TYPE_LABELS: Record<CreditTypeKey, string>;
+/** The slice of a channel the health reads. Older payloads carry none of it. */
+type CreditHealthFields = {
+    remainingUnits: number;
+    state?: CreditHealthState | null;
+    fullMarkUnits?: number | null;
+    daysOfUseLeft?: number | null;
+};
+/**
+ * The icon's colour is the worst state among the credit types in use: green
+ * when every one is Good, yellow when at least one is Low, red when at least
+ * one is Out. Not in use never changes it; a type with no state is unknown.
+ * With nothing in use, or nothing known, the icon is neutral.
+ */
+declare function creditsIconState(channels: ReadonlyArray<CreditHealthFields | null | undefined>): CreditsIconState;
+/**
+ * Gauge level against the full mark (0..1), never more than full. Null when
+ * there is nothing to draw: not in use, unknown, or no full mark.
+ */
+declare function creditGaugeRatio(channel: CreditHealthFields | null | undefined): number | null;
+declare function creditStateWord(state: CreditHealthState | null | undefined): string;
+/**
+ * One tooltip line per type: "Signal Credits: 38 left, about 1 day at your
+ * recent pace". A type not in use says so; a type without a state says only
+ * what is left.
+ */
+declare function creditTooltipLine(type: CreditTypeKey, channel: CreditHealthFields | null | undefined): string;
+/** The icon's accessible name carries the state, so colour is never the only signal. */
+declare function creditsAriaLabel(channels: Partial<Record<CreditTypeKey, CreditHealthFields | null | undefined>>): string;
+
 type CommsNotificationKind = 'notification' | 'alert';
 /** One row of the bell feed, as the shell reads it (camelCased). */
 type CommsNotification = {
@@ -98,7 +133,8 @@ declare const SPECS_ORIGIN = "https://specs.politogyvrm.com";
  * Absolute URLs (http/https/data/blob) pass through untouched.
  */
 declare function resolveOrgLogoUrl(url: string | null | undefined): string | undefined;
-declare function topBarIconButtonClass(tone?: 'default' | 'warning' | 'danger'): string;
+type TopBarIconTone = 'default' | 'ok' | 'low' | 'warning' | 'danger';
+declare function topBarIconButtonClass(tone?: TopBarIconTone): string;
 declare function TopBarCountBadge({ count }: {
     count: number;
 }): react_jsx_runtime.JSX.Element | null;
@@ -209,13 +245,29 @@ type FuelChannelStatus = {
     remainingUnits: number;
     rawBalanceUnits: number;
     usedUnits: number;
+    /** Superseded by `state` (UI-Platform "Credit health in the payload"); ignored. */
     lowFuel: boolean;
     lowFuelThreshold: number;
+    /**
+     * Credit health (Pricing & Metering §7.5), published by the credits
+     * service. Null or absent means unknown: the shell draws neutral and never
+     * derives a state from the balance.
+     */
+    state?: CreditHealthState | null;
+    fullMarkUnits?: number | null;
+    daysOfUseLeft?: number | null;
+    /** The two pools; only the Admin Credit Ledger knows them. */
+    includedUnits?: number;
+    purchasedUnits?: number;
+    nextGrantAt?: string | null;
 };
 type CommunicationsFuelStatus = {
     organizationId: string;
     signal: FuelChannelStatus;
     broadcast: FuelChannelStatus;
+    /** Absent when the balance comes from VRM Core, which never held these. */
+    ai?: FuelChannelStatus;
+    enhancement?: FuelChannelStatus;
     combinedAvailableCredits: number;
 };
 type ChromeNotificationAlert = {
@@ -302,13 +354,19 @@ declare function useChromeOrgs({ enabled }?: {
  * dropping capability (shell-nav-handoff §4; UI-Platform forbids migrating an
  * app to a rendering that loses an element it already ships).
  */
-declare function TopBarPopover({ label, description, slot, fallbackIcon, badge, tone, onOpen, openToken, onOpenChange, hideTooltip, children, panelClassName, }: {
+declare function TopBarPopover({ label, ariaLabel, description, tooltip, slot, fallbackIcon, icon, badge, tone, onOpen, openToken, onOpenChange, hideTooltip, children, panelClassName, }: {
     label: string;
+    /** The trigger's accessible name when it must say more than the label (e.g. a state). */
+    ariaLabel?: string;
     description?: string;
+    /** Replaces the tooltip's description line with richer content. */
+    tooltip?: ReactNode;
     slot?: TopBarIconSlot;
     fallbackIcon: NavIconLike;
+    /** A glyph that wins over the slot's Brand token (a state-drawn icon). */
+    icon?: NavIconLike;
     badge?: number;
-    tone?: 'default' | 'warning' | 'danger';
+    tone?: TopBarIconTone;
     onOpen?: () => void;
     /**
      * Imperative "open" signal: whenever this number CHANGES the panel opens
@@ -338,6 +396,8 @@ declare function TopBarPopover({ label, description, slot, fallbackIcon, badge,
 declare function FuelAction({ orgId }: {
     orgId: string | null;
 }): react_jsx_runtime.JSX.Element;
+/** The Credits icon under its spec name; `FuelAction` stays for existing imports. */
+declare const CreditsAction: typeof FuelAction;
 declare function NotificationsAction({ orgId }: {
     orgId: string | null;
 }): react_jsx_runtime.JSX.Element;
@@ -993,4 +1053,4 @@ type NavAppShellProps = {
 };
 declare function NavAppShell({ sidebar, topBar, betaBanner, contentWrapper, accountMenuPlacement, modeId, children, }: NavAppShellProps): react_jsx_runtime.JSX.Element;
 
-export { NavThemeControl as $, type ChromeNotificationsPayload as A, BETA_BANNER_DISMISS_KEY as B, type CommsNotification as C, type ChromeOrgSummary as D, type CommunicationsFuelStatus as E, FormColumn as F, FuelAction as G, type FuelChannelStatus as H, NavAppShell as I, type NavAppShellProps as J, NavBetaBanner as K, type NavBetaBannerProps as L, type NavBrand as M, type NavItem as N, NavChromeProvider as O, NavDisplayAction as P, type NavLinkProps as Q, type NavLinkedAccount as R, type StandardNavIconKey as S, type NavModeOption as T, type NavOrg as U, type NavRoleBadge as V, NavSidebar as W, type NavSidebarProps as X, type NavTab as Y, NavTabStrip as Z, type NavTabStripProps as _, type CommsNotificationKind as a, NavTopBar as a0, type NavTopBarAction as a1, type NavTopBarProps as a2, type NavUser as a3, NotificationsAction as a4, SPECS_ORIGIN as a5, SpecOverlayAction as a6, type StandardNavOptions as a7, SupportAction as a8, type ThemePreference as a9, TopBarCountBadge as aa, TopBarPanelArrow as ab, TopBarPopover as ac, TopBarTooltip as ad, TopBarWidgetSlot as ae, clearBetaBannerDismissal as af, envChipClasses as ag, isNavItemActive as ah, modeIdFromLabel as ai, resolveOrgLogoUrl as aj, shortEnvLabel as ak, shortUserName as al, standardPolitogyNav as am, topBarIconButtonClass as an, useChromeMe as ao, useChromeOrgs as ap, useNavChromeDedupedFetch as aq, useNavChromeFetcher as ar, useThemePreference as as, type NotificationsAdapter as b, type NotificationsFeed as c, createCommsNotificationsAdapter as d, emptyNotificationsFeed as e, type NavIcon as f, type NavBreadcrumb as g, type StandardNavMode as h, type NavLinkComponent as i, type NavChromeFetcher as j, type NavMode as k, type NavUserMenu as l, type NavOrgOption as m, normalizeNotificationsFeed as n, type NavFooterLink as o, type NavFooter as p, type NavDisplayMode as q, CAMPAIGN_FEATURE_AVAILABILITY as r, CORE_APP_ORIGIN as s, CORE_BILLING_PATH as t, type CampaignFeatureAvailability as u, type ChromeMe as v, type ChromeNotificationAlert as w, type ChromeNotificationImport as x, type ChromeNotificationQuarantine as y, type ChromeNotificationReply as z };
+export { type NavRoleBadge as $, type ChromeNotificationQuarantine as A, BETA_BANNER_DISMISS_KEY as B, type CommsNotification as C, type ChromeNotificationReply as D, type ChromeNotificationsPayload as E, FormColumn as F, type ChromeOrgSummary as G, type CommunicationsFuelStatus as H, type CreditHealthState as I, type CreditTypeKey as J, CreditsAction as K, type CreditsIconState as L, FuelAction as M, type NavItem as N, type FuelChannelStatus as O, NavAppShell as P, type NavAppShellProps as Q, NavBetaBanner as R, type StandardNavIconKey as S, type NavBetaBannerProps as T, type NavBrand as U, NavChromeProvider as V, NavDisplayAction as W, type NavLinkProps as X, type NavLinkedAccount as Y, type NavModeOption as Z, type NavOrg as _, type CommsNotificationKind as a, NavSidebar as a0, type NavSidebarProps as a1, type NavTab as a2, NavTabStrip as a3, type NavTabStripProps as a4, NavThemeControl as a5, NavTopBar as a6, type NavTopBarAction as a7, type NavTopBarProps as a8, type NavUser as a9, useChromeMe as aA, useChromeOrgs as aB, useNavChromeDedupedFetch as aC, useNavChromeFetcher as aD, useThemePreference as aE, NotificationsAction as aa, SPECS_ORIGIN as ab, SpecOverlayAction as ac, type StandardNavOptions as ad, SupportAction as ae, type ThemePreference as af, TopBarCountBadge as ag, type TopBarIconTone as ah, TopBarPanelArrow as ai, TopBarPopover as aj, TopBarTooltip as ak, TopBarWidgetSlot as al, clearBetaBannerDismissal as am, creditGaugeRatio as an, creditStateWord as ao, creditTooltipLine as ap, creditsAriaLabel as aq, creditsIconState as ar, envChipClasses as as, isNavItemActive as at, modeIdFromLabel as au, resolveOrgLogoUrl as av, shortEnvLabel as aw, shortUserName as ax, standardPolitogyNav as ay, topBarIconButtonClass as az, type NotificationsAdapter as b, type NotificationsFeed as c, createCommsNotificationsAdapter as d, emptyNotificationsFeed as e, type NavIcon as f, type NavBreadcrumb as g, type StandardNavMode as h, type NavLinkComponent as i, type NavChromeFetcher as j, type NavMode as k, type NavUserMenu as l, type NavOrgOption as m, normalizeNotificationsFeed as n, type NavFooterLink as o, type NavFooter as p, type NavDisplayMode as q, CAMPAIGN_FEATURE_AVAILABILITY as r, CORE_APP_ORIGIN as s, CORE_BILLING_PATH as t, CREDIT_TYPE_LABELS as u, CREDIT_TYPE_ORDER as v, type CampaignFeatureAvailability as w, type ChromeMe as x, type ChromeNotificationAlert as y, type ChromeNotificationImport as z };

package/dist/{index-CwTnsR9R.d.ts → index-C4ob05Pc.d.ts}

@@ -28,6 +28,41 @@ declare function FormColumn({ children, className }: FormColumnProps): react_jsx
  */
 type TopBarIconSlot = 'comms-fuel' | 'apps' | 'notifications' | 'alerts' | 'support' | 'dark-mode';
 
+type CreditHealthState = "good" | "low" | "out" | "not_in_use";
+/** What the icon shows: the worst state among the types in use, or unknown. */
+type CreditsIconState = "good" | "low" | "out" | "unknown";
+type CreditTypeKey = "signal" | "broadcast" | "ai" | "enhancement";
+declare const CREDIT_TYPE_ORDER: readonly CreditTypeKey[];
+declare const CREDIT_TYPE_LABELS: Record<CreditTypeKey, string>;
+/** The slice of a channel the health reads. Older payloads carry none of it. */
+type CreditHealthFields = {
+    remainingUnits: number;
+    state?: CreditHealthState | null;
+    fullMarkUnits?: number | null;
+    daysOfUseLeft?: number | null;
+};
+/**
+ * The icon's colour is the worst state among the credit types in use: green
+ * when every one is Good, yellow when at least one is Low, red when at least
+ * one is Out. Not in use never changes it; a type with no state is unknown.
+ * With nothing in use, or nothing known, the icon is neutral.
+ */
+declare function creditsIconState(channels: ReadonlyArray<CreditHealthFields | null | undefined>): CreditsIconState;
+/**
+ * Gauge level against the full mark (0..1), never more than full. Null when
+ * there is nothing to draw: not in use, unknown, or no full mark.
+ */
+declare function creditGaugeRatio(channel: CreditHealthFields | null | undefined): number | null;
+declare function creditStateWord(state: CreditHealthState | null | undefined): string;
+/**
+ * One tooltip line per type: "Signal Credits: 38 left, about 1 day at your
+ * recent pace". A type not in use says so; a type without a state says only
+ * what is left.
+ */
+declare function creditTooltipLine(type: CreditTypeKey, channel: CreditHealthFields | null | undefined): string;
+/** The icon's accessible name carries the state, so colour is never the only signal. */
+declare function creditsAriaLabel(channels: Partial<Record<CreditTypeKey, CreditHealthFields | null | undefined>>): string;
+
 type CommsNotificationKind = 'notification' | 'alert';
 /** One row of the bell feed, as the shell reads it (camelCased). */
 type CommsNotification = {
@@ -98,7 +133,8 @@ declare const SPECS_ORIGIN = "https://specs.politogyvrm.com";
  * Absolute URLs (http/https/data/blob) pass through untouched.
  */
 declare function resolveOrgLogoUrl(url: string | null | undefined): string | undefined;
-declare function topBarIconButtonClass(tone?: 'default' | 'warning' | 'danger'): string;
+type TopBarIconTone = 'default' | 'ok' | 'low' | 'warning' | 'danger';
+declare function topBarIconButtonClass(tone?: TopBarIconTone): string;
 declare function TopBarCountBadge({ count }: {
     count: number;
 }): react_jsx_runtime.JSX.Element | null;
@@ -209,13 +245,29 @@ type FuelChannelStatus = {
     remainingUnits: number;
     rawBalanceUnits: number;
     usedUnits: number;
+    /** Superseded by `state` (UI-Platform "Credit health in the payload"); ignored. */
     lowFuel: boolean;
     lowFuelThreshold: number;
+    /**
+     * Credit health (Pricing & Metering §7.5), published by the credits
+     * service. Null or absent means unknown: the shell draws neutral and never
+     * derives a state from the balance.
+     */
+    state?: CreditHealthState | null;
+    fullMarkUnits?: number | null;
+    daysOfUseLeft?: number | null;
+    /** The two pools; only the Admin Credit Ledger knows them. */
+    includedUnits?: number;
+    purchasedUnits?: number;
+    nextGrantAt?: string | null;
 };
 type CommunicationsFuelStatus = {
     organizationId: string;
     signal: FuelChannelStatus;
     broadcast: FuelChannelStatus;
+    /** Absent when the balance comes from VRM Core, which never held these. */
+    ai?: FuelChannelStatus;
+    enhancement?: FuelChannelStatus;
     combinedAvailableCredits: number;
 };
 type ChromeNotificationAlert = {
@@ -302,13 +354,19 @@ declare function useChromeOrgs({ enabled }?: {
  * dropping capability (shell-nav-handoff §4; UI-Platform forbids migrating an
  * app to a rendering that loses an element it already ships).
  */
-declare function TopBarPopover({ label, description, slot, fallbackIcon, badge, tone, onOpen, openToken, onOpenChange, hideTooltip, children, panelClassName, }: {
+declare function TopBarPopover({ label, ariaLabel, description, tooltip, slot, fallbackIcon, icon, badge, tone, onOpen, openToken, onOpenChange, hideTooltip, children, panelClassName, }: {
     label: string;
+    /** The trigger's accessible name when it must say more than the label (e.g. a state). */
+    ariaLabel?: string;
     description?: string;
+    /** Replaces the tooltip's description line with richer content. */
+    tooltip?: ReactNode;
     slot?: TopBarIconSlot;
     fallbackIcon: NavIconLike;
+    /** A glyph that wins over the slot's Brand token (a state-drawn icon). */
+    icon?: NavIconLike;
     badge?: number;
-    tone?: 'default' | 'warning' | 'danger';
+    tone?: TopBarIconTone;
     onOpen?: () => void;
     /**
      * Imperative "open" signal: whenever this number CHANGES the panel opens
@@ -338,6 +396,8 @@ declare function TopBarPopover({ label, description, slot, fallbackIcon, badge,
 declare function FuelAction({ orgId }: {
     orgId: string | null;
 }): react_jsx_runtime.JSX.Element;
+/** The Credits icon under its spec name; `FuelAction` stays for existing imports. */
+declare const CreditsAction: typeof FuelAction;
 declare function NotificationsAction({ orgId }: {
     orgId: string | null;
 }): react_jsx_runtime.JSX.Element;
@@ -993,4 +1053,4 @@ type NavAppShellProps = {
 };
 declare function NavAppShell({ sidebar, topBar, betaBanner, contentWrapper, accountMenuPlacement, modeId, children, }: NavAppShellProps): react_jsx_runtime.JSX.Element;
 
-export { NavThemeControl as $, type ChromeNotificationsPayload as A, BETA_BANNER_DISMISS_KEY as B, type CommsNotification as C, type ChromeOrgSummary as D, type CommunicationsFuelStatus as E, FormColumn as F, FuelAction as G, type FuelChannelStatus as H, NavAppShell as I, type NavAppShellProps as J, NavBetaBanner as K, type NavBetaBannerProps as L, type NavBrand as M, type NavItem as N, NavChromeProvider as O, NavDisplayAction as P, type NavLinkProps as Q, type NavLinkedAccount as R, type StandardNavIconKey as S, type NavModeOption as T, type NavOrg as U, type NavRoleBadge as V, NavSidebar as W, type NavSidebarProps as X, type NavTab as Y, NavTabStrip as Z, type NavTabStripProps as _, type CommsNotificationKind as a, NavTopBar as a0, type NavTopBarAction as a1, type NavTopBarProps as a2, type NavUser as a3, NotificationsAction as a4, SPECS_ORIGIN as a5, SpecOverlayAction as a6, type StandardNavOptions as a7, SupportAction as a8, type ThemePreference as a9, TopBarCountBadge as aa, TopBarPanelArrow as ab, TopBarPopover as ac, TopBarTooltip as ad, TopBarWidgetSlot as ae, clearBetaBannerDismissal as af, envChipClasses as ag, isNavItemActive as ah, modeIdFromLabel as ai, resolveOrgLogoUrl as aj, shortEnvLabel as ak, shortUserName as al, standardPolitogyNav as am, topBarIconButtonClass as an, useChromeMe as ao, useChromeOrgs as ap, useNavChromeDedupedFetch as aq, useNavChromeFetcher as ar, useThemePreference as as, type NotificationsAdapter as b, type NotificationsFeed as c, createCommsNotificationsAdapter as d, emptyNotificationsFeed as e, type NavIcon as f, type NavBreadcrumb as g, type StandardNavMode as h, type NavLinkComponent as i, type NavChromeFetcher as j, type NavMode as k, type NavUserMenu as l, type NavOrgOption as m, normalizeNotificationsFeed as n, type NavFooterLink as o, type NavFooter as p, type NavDisplayMode as q, CAMPAIGN_FEATURE_AVAILABILITY as r, CORE_APP_ORIGIN as s, CORE_BILLING_PATH as t, type CampaignFeatureAvailability as u, type ChromeMe as v, type ChromeNotificationAlert as w, type ChromeNotificationImport as x, type ChromeNotificationQuarantine as y, type ChromeNotificationReply as z };
+export { type NavRoleBadge as $, type ChromeNotificationQuarantine as A, BETA_BANNER_DISMISS_KEY as B, type CommsNotification as C, type ChromeNotificationReply as D, type ChromeNotificationsPayload as E, FormColumn as F, type ChromeOrgSummary as G, type CommunicationsFuelStatus as H, type CreditHealthState as I, type CreditTypeKey as J, CreditsAction as K, type CreditsIconState as L, FuelAction as M, type NavItem as N, type FuelChannelStatus as O, NavAppShell as P, type NavAppShellProps as Q, NavBetaBanner as R, type StandardNavIconKey as S, type NavBetaBannerProps as T, type NavBrand as U, NavChromeProvider as V, NavDisplayAction as W, type NavLinkProps as X, type NavLinkedAccount as Y, type NavModeOption as Z, type NavOrg as _, type CommsNotificationKind as a, NavSidebar as a0, type NavSidebarProps as a1, type NavTab as a2, NavTabStrip as a3, type NavTabStripProps as a4, NavThemeControl as a5, NavTopBar as a6, type NavTopBarAction as a7, type NavTopBarProps as a8, type NavUser as a9, useChromeMe as aA, useChromeOrgs as aB, useNavChromeDedupedFetch as aC, useNavChromeFetcher as aD, useThemePreference as aE, NotificationsAction as aa, SPECS_ORIGIN as ab, SpecOverlayAction as ac, type StandardNavOptions as ad, SupportAction as ae, type ThemePreference as af, TopBarCountBadge as ag, type TopBarIconTone as ah, TopBarPanelArrow as ai, TopBarPopover as aj, TopBarTooltip as ak, TopBarWidgetSlot as al, clearBetaBannerDismissal as am, creditGaugeRatio as an, creditStateWord as ao, creditTooltipLine as ap, creditsAriaLabel as aq, creditsIconState as ar, envChipClasses as as, isNavItemActive as at, modeIdFromLabel as au, resolveOrgLogoUrl as av, shortEnvLabel as aw, shortUserName as ax, standardPolitogyNav as ay, topBarIconButtonClass as az, type NotificationsAdapter as b, type NotificationsFeed as c, createCommsNotificationsAdapter as d, emptyNotificationsFeed as e, type NavIcon as f, type NavBreadcrumb as g, type StandardNavMode as h, type NavLinkComponent as i, type NavChromeFetcher as j, type NavMode as k, type NavUserMenu as l, type NavOrgOption as m, normalizeNotificationsFeed as n, type NavFooterLink as o, type NavFooter as p, type NavDisplayMode as q, CAMPAIGN_FEATURE_AVAILABILITY as r, CORE_APP_ORIGIN as s, CORE_BILLING_PATH as t, CREDIT_TYPE_LABELS as u, CREDIT_TYPE_ORDER as v, type CampaignFeatureAvailability as w, type ChromeMe as x, type ChromeNotificationAlert as y, type ChromeNotificationImport as z };