@everfur/sdk 0.12.0 → 0.13.0

package/dist/web/health-plan/index.d.cts

@@ -0,0 +1,335 @@
+import { ReactNode, CSSProperties } from 'react';
+import { C as CapabilityDecision } from '../../resolve.d-jI8FmBj3.cjs';
+import { E as EverfurError } from '../../EverfurError.d-8NHtlgzA.cjs';
+export { a as EverfurErrorCategory, b as EverfurErrorCode } from '../../EverfurError.d-8NHtlgzA.cjs';
+import { P as PetRef } from '../../ids.d-B2GAAifq.cjs';
+export { B as Brand, C as ConversationId, R as RecordsRequestId, U as UserRef, _ as __brand } from '../../ids.d-B2GAAifq.cjs';
+import { b as HealthPlanFocusDesign, H as HealthPlanFocusCopy, aL as HealthPlanFocusClassNames, a as HealthPlanFocusIcon, c as HealthPlanItem, d as HealthPlanSubscription, e as HealthPlanOneBoxOrder, f as HealthPlanSubscriptionRepository, g as HealthPlanPageRepository, h as HealthPlanShopOrder, i as HealthPlanCheckoutProvider, j as HealthPlanPriceFormat, k as HealthPlanLayoutProps, aM as HealthPlanEmptyCopy, l as HealthPlanCardOptions, m as HealthPlanImageVariant, n as HealthPlanReasonVariant, o as HealthPlanCart, ak as HealthPlanSubscriptionQuote, a8 as HealthPlanPagePet, a5 as HealthPlanPage } from '../../focus.d-az9cqUz3.cjs';
+export { E as EverfurHealthPlanOptions, p as EverfurHealthPlanState, q as EverfurHealthPlanStatus, r as HEALTH_PLAN_COPY, s as HEALTH_PLAN_COPY_PLACEHOLDERS, t as HEALTH_PLAN_FOCUS_COPY, u as HEALTH_PLAN_LAYOUT_DEFAULTS, v as HEALTH_PLAN_REASON_KINDS, w as HEALTH_PLAN_REASON_LABELS, x as HEALTH_PLAN_TEMPLATES, y as HealthPlan, z as HealthPlanAddButtonSize, A as HealthPlanAddedVariant, B as HealthPlanCardShadow, C as HealthPlanCartBarPlacement, D as HealthPlanCartBarVisibility, F as HealthPlanCartCheckoutRequest, G as HealthPlanCartDock, I as HealthPlanCartScope, J as HealthPlanCartScopeProps, K as HealthPlanCategoryVariant, L as HealthPlanCheckoutItem, M as HealthPlanCheckoutRefusal, N as HealthPlanCheckoutRequest, O as HealthPlanCheckoutSession, P as HealthPlanCheckoutState, Q as HealthPlanCheckoutStatus, R as HealthPlanController, S as HealthPlanFocusExtra, aN as HealthPlanFocusPart, T as HealthPlanFocusPrices, U as HealthPlanFocusReasonRow, V as HealthPlanFocusReview, W as HealthPlanFocusSign, X as HealthPlanFocusStep, Y as HealthPlanFocusWait, Z as HealthPlanFontWeight, _ as HealthPlanHeaderContext, $ as HealthPlanOneBoxOffer, a0 as HealthPlanOneBoxOrderPage, a1 as HealthPlanOneBoxOrderPageOptions, a2 as HealthPlanOrderStatus, a3 as HealthPlanOrderTracking, a4 as HealthPlanOrderTrackingStatus, a6 as HealthPlanPageContext, a7 as HealthPlanPageOptions, a9 as HealthPlanPagePhase, aa as HealthPlanPageState, aO as HealthPlanPetWords, ab as HealthPlanPhase, ac as HealthPlanPurchase, ad as HealthPlanReason, ae as HealthPlanReasonKind, af as HealthPlanRepository, ag as HealthPlanRepositoryDeps, ah as HealthPlanRuntime, ai as HealthPlanShadow, aj as HealthPlanSnapshot, al as HealthPlanSubscriptionRenewal, am as HealthPlanSubscriptionStatus, an as HealthPlanSubscriptionStep, ao as HealthPlanSubscriptionSupply, ap as HealthPlanTrackStep, aq as createHealthPlanPageRepository, ar as createHealthPlanPageRepositoryOver, as as createHealthPlanRepository, at as createHealthPlanRepositoryOver, aP as createHealthPlanSubscriptionRepository, aQ as createHealthPlanSubscriptionRepositoryOver, au as formatHealthPlanDay, av as formatHealthPlanPrice, aw as formatHealthPlanPriceWith, ax as healthPlanCart, ay as healthPlanCheckoutRefusal, az as healthPlanCheckoutSessionFromWire, aA as healthPlanCheckoutStateFromWire, aR as healthPlanFocusCopyFor, aB as healthPlanFocusDesignFromWire, aC as healthPlanFromWire, aS as healthPlanOneBoxOrderFromWire, aT as healthPlanOneBoxOrderPageFromWire, aU as healthPlanOrderTrackingFromWire, aD as healthPlanPageFromWire, aV as healthPlanPetWords, aW as healthPlanSubscriptionFromWire, aX as healthPlanSubscriptionQuoteFromWire, aE as isHealthPlanSessionRequired, aY as isHealthPlanSubscriptionUnavailable, aF as showHealthPlanCartBar, aG as useEverfurHealthPlan, aH as useEverfurHealthPlanRepository, aI as useHealthPlanCartDock, aJ as useHealthPlanPage, aK as useHealthPlanPageRepository } from '../../focus.d-az9cqUz3.cjs';
+import { L as LifecyclePort } from '../../LifecyclePort.d-Cr1p33a7.cjs';
+import { E as EverfurResult } from '../../EverfurResult.d-BFH-3s6E.cjs';
+import { i as EverfurPresentationInput } from '../../presentation.d-DMbdad7G.cjs';
+export { E as EverfurChatAnswerStyle, a as EverfurChatComposerPlaceholder, b as EverfurChatComposerStyle, c as EverfurChatHistoryBarSetting, d as EverfurChatHistoryStyle, e as EverfurChatSendButtonSetting, f as EverfurChatTopCardSetting, g as EverfurHealthPlanLayout, h as EverfurPresentation, j as EverfurSafetyDisclaimerPlacement } from '../../presentation.d-DMbdad7G.cjs';
+export { A as AuthContext, I as IdentityProvider, M as MintedToken, T as TokenProvider } from '../../identity.d-60LeJt_s.cjs';
+export { A as AcceptedFrame, a as AnalysisCompleteFrame, b as AnalysisStartedFrame, D as DeltaFrame, c as DoneFrame, E as ErrorFrame, d as EverfurRequest, e as EverfurRequestBase, F as Frame, f as FrameBase, g as FrameKind, H as HeartbeatFrame, h as HttpMethod, M as MultipartBody, T as TransportPort, U as UnknownFrame, i as UrgencyLevel } from '../../config.d-BR3DT9ho.cjs';
+export { E as ErrorPolicyPort } from '../../ErrorPolicyPort.d-DirW9hgO.cjs';
+export { u as useEverfurPresentation } from '../../usePresentation.d-D6qsFzBz.cjs';
+import { E as EverfurChatTopCard } from '../../threadOptions.d-B1pTMmDF.cjs';
+import '../../requestFunnel.d-DWQQpjFR.cjs';
+
+/** Which overlay the focus layout has open, for a host that dims its own chrome under it. */
+type HealthPlanFocusOverlay = 'checkout' | 'manage' | 'started' | 'cart' | 'cartCheckout' | 'placed' | 'orders' | 'order' | 'weight' | null;
+/** Which layer `overlayContainer` is asked for: the checkout and manage sheets, the started screen, the toast. */
+type HealthPlanFocusLayer = 'sheet' | 'started' | 'toast';
+/** Handed to `onOverlayChange`, so a host's own back control can close what is open. */
+interface HealthPlanFocusOverlayControls {
+    /** Closes everything the layout has open. */
+    readonly close: () => void;
+    /** Closes the top screen or sheet only (a header's back). Absent before the shop: `close`. */
+    readonly back?: () => void;
+    /** The title for the host's header over a pushed screen ("Cart", "Order placed"); absent over a sheet. */
+    readonly title?: string;
+    /** True for a full screen (no bottom tabs under it): the cart, the order placed, the started screen. */
+    readonly full?: boolean;
+}
+/** The focus layout's options. Passing them to `EverfurHealthPlan` (`focus={...}`) opts the page in. */
+interface HealthPlanFocusOptions {
+    /**
+     * Your content for the layout. Omit it and `EverfurHealthPlan` reads the pet's plan page from Everfur (built from
+     * vet-approved templates and the pet's own facts) and draws that, with the page's checkout setting.
+     */
+    readonly design?: HealthPlanFocusDesign;
+    /** Your words over the SDK's buying words, on top of `design.copy`. Works with the backend page too. */
+    readonly copy?: Partial<HealthPlanFocusCopy>;
+    readonly classNames?: HealthPlanFocusClassNames;
+    /** Draw an icon your way (an `<svg><use href="#i-check"/></svg>` from your sprite). */
+    readonly renderIcon?: (icon: HealthPlanFocusIcon, className?: string) => ReactNode;
+    /** False never reads the subscription quote: the buy button is the one-time handoff only. Default true. */
+    readonly subscriptions?: boolean;
+    /**
+     * Where the checkout sheet, the started screen and the toast mount, asked per layer (a sheet over your whole
+     * frame, the started screen under your own header). Null or absent: `document.body`.
+     */
+    readonly overlayContainer?: (layer: HealthPlanFocusLayer) => HTMLElement | null;
+    /** A one-time buy handed to your checkout (no quote, or no one-box offer). Omit it and `onCheckout([item])` is called instead. */
+    readonly onBuy?: (item: HealthPlanItem) => void;
+    /** The "Why this product?" link. Omit it and the link is not drawn. */
+    readonly onMore?: (item: HealthPlanItem) => void;
+    /** One of `design.extras` was added (or taken back). Local state; the host runs its own cart. Omit it and the extras are not drawn. */
+    readonly onExtra?: (key: string, added: boolean) => void;
+    /** The checkup questions were added to (or taken off) the next visit. Local state; the host persists it. */
+    readonly onAddToVisit?: (added: boolean, questions: readonly string[]) => void;
+    readonly onOverlayChange?: (overlay: HealthPlanFocusOverlay, controls: HealthPlanFocusOverlayControls) => void;
+    /** A subscription changed (started, skipped, interval, cancelled), with the server's new state. */
+    readonly onSubscriptionChange?: (subscription: HealthPlanSubscription) => void;
+    /** A one-box order was recorded, with the server's order. */
+    readonly onOneBoxOrder?: (order: HealthPlanOneBoxOrder) => void;
+    /** Number and date locale. Defaults to the platform's. */
+    readonly locale?: string;
+    /** A repository of your own (a stub backend, tests). */
+    readonly subscriptionRepository?: HealthPlanSubscriptionRepository;
+    /**
+     * How the member leaves for Everfur's Stripe Checkout (`checkout: everfur_stripe` only). Defaults to
+     * `window.location.assign(url)`; a page inside a frame passes its own (the top window's).
+     */
+    readonly navigate?: (url: string) => void;
+    /** The plan page and checkout repository of your own (a stub backend, tests). */
+    readonly pageRepository?: HealthPlanPageRepository;
+    /**
+     * True turns Buy into Add to cart and draws the cart, its checkout, the orders and an order. Default: on when the
+     * checkout is Everfur's (`everfur_stripe`), off for a partner's own checkout. `shop: false` turns it off with
+     * Everfur's checkout too: Buy and Subscribe then go straight to Stripe Checkout.
+     */
+    readonly shop?: boolean;
+    /**
+     * True when Everfur texts the member the tracking number once it ships: the "tracking comes by text" lines are drawn.
+     * `EverfurHealthPlan` sets it from the plan page (`tracking_texts_enabled`). Default false: never promised.
+     */
+    readonly trackingTexts?: boolean;
+    /**
+     * The pet's sex, for "her" / "his" in the buying words; absent or null uses the pet's name ("Georgia's"), else
+     * "your pet". `EverfurHealthPlan` sets it from the plan page; a host design passes its own.
+     */
+    readonly petSex?: 'female' | 'male' | null;
+    /** The unit the weight sheet takes: `lb` (the default) or `kg`. */
+    readonly weightUnit?: 'lb' | 'kg';
+    /** The partner's own orders for this pet (its kits, its tests), listed after Everfur's. The partner's data, drawn as given. */
+    readonly shopOrders?: readonly HealthPlanShopOrder[];
+    /** "Get help with this order". Omit it and the link is not drawn. */
+    readonly onOrderHelp?: (orderKey: string) => void;
+    /**
+     * False: the pet's weight is unknown, so the dose is replaced by a row that asks for it. `EverfurHealthPlan` sets it
+     * from the plan page; a host design passes its own. Absent: the dose is drawn.
+     */
+    readonly weightKnown?: boolean;
+    /** Save the weight your way (a demo pet). Omit it and the pet's profile is updated (`updatePet`, `weightKg`). */
+    readonly onSaveWeight?: (weightKg: number, pounds: number) => Promise<EverfurResult<unknown>>;
+    /** The weight was saved; `EverfurHealthPlan` re-reads the plan page with it. */
+    readonly onWeightSaved?: (weightKg: number) => void;
+    /**
+     * True with `onConnectRecords`: the row that asks for the pet's vet records is drawn under the checkup.
+     * `EverfurHealthPlan` derives it from the pet's records read when you pass `onConnectRecords` and leave this out.
+     */
+    readonly recordsMissing?: boolean;
+    readonly onConnectRecords?: () => void;
+    /** The waiting card's button (`design.wait.action`). */
+    readonly onWaitAction?: () => void;
+}
+interface HealthPlanFocusProps extends Omit<HealthPlanFocusOptions, 'design'> {
+    readonly design: HealthPlanFocusDesign;
+    /** Whose checkout Buy and Subscribe run. `partner` (the default) is the handoff; `everfur_stripe` redirects to Stripe. */
+    readonly checkout?: HealthPlanCheckoutProvider;
+    readonly item: HealthPlanItem;
+    /** The pet's other plan items, drawn under the pick in plan order, each with its own buy. `EverfurHealthPlan` passes the plan's items minus the pick. */
+    readonly others?: readonly HealthPlanItem[];
+    /** True to draw each other item's category (the backend `category`) above its name, as `showCategory` does on the list cards. Default false. */
+    readonly showCategory?: boolean;
+    /**
+     * The plan's re-read signals, so the subscription state (the subscribed line, Manage, Subscribe) is read again with
+     * it: a foreground past the stale window, quietly. `EverfurHealthPlan` passes its own. Absent, the quote is read
+     * once.
+     */
+    readonly lifecycle?: LifecyclePort | null;
+    /** Change it to re-read the subscription state now, quietly. `EverfurHealthPlan` passes its `refreshKey`. */
+    readonly refreshKey?: string | number;
+    readonly petRef: PetRef;
+    readonly petName: string | null;
+    readonly onCheckout?: (items: readonly HealthPlanItem[]) => void;
+    readonly priceFormat?: HealthPlanPriceFormat;
+    readonly style?: CSSProperties;
+    readonly className?: string;
+}
+/** The focus layout over one plan item. `EverfurHealthPlan` mounts it; a partner can mount it over the hook too. */
+declare function HealthPlanFocus(props: HealthPlanFocusProps): ReactNode;
+
+interface EverfurHealthPlanProps extends HealthPlanLayoutProps {
+    /** The pet whose plan to show. Omit it and the provider's active pet is used. */
+    readonly petRef?: PetRef | null;
+    /** Called with the cart's items when the member presses checkout. Omit it and no checkout control is drawn. */
+    readonly onCheckout?: (items: readonly HealthPlanItem[]) => void;
+    /** Your own wording for a refused read. The retry control stays the SDK's. */
+    readonly renderNotice?: (error: EverfurError) => ReactNode;
+    /** What to show when the `healthPlan` capability is off. Defaults to the gate's own off state. */
+    readonly renderDisabled?: (decision: CapabilityDecision) => ReactNode;
+    readonly style?: CSSProperties;
+    readonly className?: string;
+    /**
+     * The focus layout's content: one issue, the free tips first, one product sized for the pet (subscribe or one
+     * box), the pet's other plan items after it (each with its own one-box buy), the signs to watch with the checkup
+     * questions, and your other offers. The words come from `focus.design`.
+     * It is drawn while the layout setting `healthPlanLayout` resolves to `focus_plan` (your `presentation` prop, else
+     * your console's render_hints.branding.presentation `health_plan_layout`), with or without these options (none:
+     * Everfur's plan page with the SDK's defaults); otherwise the page keeps the product grid. Signed out, loading,
+     * refused and empty states draw exactly as without it.
+     *
+     * Without `focus.design` the content is Everfur's plan page for the pet (`GET .../plan/page`), read again on a pet
+     * change: loading while it reads, the empty state when the page is null, the retry notice when it is refused. The
+     * page also says whose checkout runs Buy and Subscribe (`everfur_stripe` redirects to Stripe Checkout; `partner`
+     * keeps the `onBuy` / `onCheckout` handoff).
+     */
+    readonly focus?: HealthPlanFocusOptions;
+    /**
+     * The layout setting, `healthPlanLayout` (`standard` or `focus_plan`). Your value wins over the console's unless the
+     * console locks it. Absent everywhere, `standard`.
+     */
+    readonly presentation?: Pick<EverfurPresentationInput, 'healthPlanLayout'>;
+    /**
+     * When the plan is read again on its own: coming back to the page after more than a minute re-reads it quietly
+     * (the plan stays on screen), so a change made in another tab shows: the plan, the page and, in the focus layout,
+     * the subscription state (a subscription started elsewhere). Absent, Everfur uses the browser's own
+     * signal (the page becoming visible again; see `createBrowserLifecycle`). Pass your own port, or `null` to turn
+     * the re-read off.
+     */
+    readonly lifecycle?: LifecyclePort | null;
+    /** Change it to re-read the plan (and, in the focus layout, the subscription state) now, quietly (for example after your checkout completed). */
+    readonly refreshKey?: string | number;
+    /**
+     * Whether this pet has a plan to show: true once the plan (or its page) draws, false when the pet has none and the
+     * empty state has no words to draw (Q1: the page then draws nothing; hide your Health Plan tab for that pet).
+     * Not called while loading or after a refused read.
+     */
+    readonly onAvailability?: (available: boolean, petRef: PetRef | null) => void;
+    /** The empty state's Ask button (drawn only when `emptyAsk` has words). */
+    readonly onAsk?: () => void;
+    /** Your words for the empty state, over the SDK's (empty until Raph writes them: then nothing is drawn). */
+    readonly emptyCopy?: Partial<HealthPlanEmptyCopy>;
+}
+/** One pet's Health Plan on a web page. Mount it under the `EverfurProvider` from "@everfur/sdk/web". */
+declare function EverfurHealthPlan(props: EverfurHealthPlanProps): ReactNode;
+
+interface HealthPlanItemCardProps extends HealthPlanCardOptions {
+    readonly item: HealthPlanItem;
+    /** Called with the answer the member asked for: `true` to add, `false` to remove. A throw is swallowed. */
+    readonly onToggle?: (inPlan: boolean) => void;
+    /** True while this item's add or remove is in flight. */
+    readonly pending?: boolean;
+    /** This item's last refused write, shown under the control. */
+    readonly error?: EverfurError | null;
+    /** `'wide'` (default): a full-width picture above the name. `'thumbnail'`: a square picture beside the name. */
+    readonly imageVariant?: HealthPlanImageVariant;
+    /** `'pills'` (default): filled reason chips. `'rows'`: a mono label column and the reason text, no fill. */
+    readonly reasonVariant?: HealthPlanReasonVariant;
+    /** How the price reads (locale, and whether a whole amount drops its zero cents). */
+    readonly priceFormat?: HealthPlanPriceFormat;
+    /** Your own node at the foot of the card, above the control (a study card, a repeat switch). A throw draws nothing. */
+    readonly renderFooter?: (item: HealthPlanItem) => ReactNode;
+    readonly style?: CSSProperties;
+    readonly className?: string;
+}
+/** One Health Plan product as a card, with its reasons and its add / remove control. */
+declare function HealthPlanItemCard(props: HealthPlanItemCardProps): ReactNode;
+
+interface HealthPlanCartBarProps {
+    readonly cart: HealthPlanCart;
+    /** Called with the items in the cart when the member presses checkout. A throw is swallowed. */
+    readonly onCheckout?: (items: readonly HealthPlanItem[]) => void;
+    /** True while any add or remove is in flight; checkout waits for the cart to settle. */
+    readonly busy?: boolean;
+    /** How the subtotal reads (locale, and whether a whole amount drops its zero cents). */
+    readonly priceFormat?: HealthPlanPriceFormat;
+    readonly style?: CSSProperties;
+    readonly className?: string;
+}
+/** The cart bar of a Health Plan. */
+declare function HealthPlanCartBar(props: HealthPlanCartBarProps): ReactNode;
+
+interface HealthPlanTopRiskProps {
+    /** The line over the sentence ("Her top risk"). */
+    readonly kicker: string;
+    /** The one sentence ("Georgia's top disease risk is IVDD, a back problem, so she should start a Health Plan for it."). */
+    readonly sentence: string;
+    /** The button's words ("Start her Health Plan"). */
+    readonly action: string;
+    readonly onOpenPlan: () => void;
+    /** A modifier for the dot (`risk` by default), read as `classNames['dot:<kind>']`. */
+    readonly kind?: string;
+    /** Classes per element (`card`, `kicker`, `dot`, `dot:<kind>`, `sentence`, `button`); a class drops that element's inline default. */
+    readonly classNames?: Readonly<Record<string, string | undefined>>;
+    readonly style?: CSSProperties;
+}
+/** The top-risk sentence with its way into the Health Plan. */
+declare function HealthPlanTopRisk(props: HealthPlanTopRiskProps): ReactNode;
+
+type HealthPlanSubscriptionPhase = 'idle' | 'loading' | 'unavailable' | 'failed' | 'ready';
+interface HealthPlanSubscriptionOptions {
+    readonly petRef: PetRef | null;
+    readonly productId: string | null;
+    /** False skips every read (a host that has not opted in). Defaults to true. */
+    readonly enabled?: boolean;
+    /** A repository of your own (tests, a stub backend). Defaults to the one over the provider's runtime. */
+    readonly repository?: HealthPlanSubscriptionRepository;
+    /** Coming back to the foreground re-reads a quote shown for more than a minute, quietly. Absent, it does not. */
+    readonly lifecycle?: LifecyclePort | null;
+    /** Change it to re-read the quote now, quietly (for example after your checkout completed). */
+    readonly refreshKey?: string | number;
+}
+interface HealthPlanSubscriptionState {
+    readonly phase: HealthPlanSubscriptionPhase;
+    readonly quote: HealthPlanSubscriptionQuote | null;
+    /** The member's row for this pet and product (active or cancelled), or null. */
+    readonly subscription: HealthPlanSubscription | null;
+    /** A write is in flight. */
+    readonly busy: boolean;
+    /** The last refused read or write, or null. */
+    readonly error: EverfurError | null;
+    /** Each write settles the server's new state, or the refusal (a write before the quote is ready is refused). */
+    subscribe(intervalDays: number): Promise<EverfurResult<HealthPlanSubscription>>;
+    changeInterval(intervalDays: number): Promise<EverfurResult<HealthPlanSubscription>>;
+    skip(): Promise<EverfurResult<HealthPlanSubscription>>;
+    cancel(): Promise<EverfurResult<HealthPlanSubscription>>;
+    restart(intervalDays?: number): Promise<EverfurResult<HealthPlanSubscription>>;
+    /** Buy one box (no renewal), then re-read the quote: a one-box order spends the first-box offer. */
+    buyOneBox(tapKey?: string): Promise<EverfurResult<HealthPlanOneBoxOrder>>;
+    refresh(): Promise<void>;
+}
+/** The subscription repository bound to the runtime under your provider. */
+declare function useHealthPlanSubscriptionRepository(): HealthPlanSubscriptionRepository;
+/** One product's subscription for one pet. `EverfurHealthPlan` with `layout="focus"` paints it. */
+declare function useHealthPlanSubscription(options: HealthPlanSubscriptionOptions): HealthPlanSubscriptionState;
+
+/** The page's focus, as the copy functions receive it. */
+type HealthPlanTopCardFocus = NonNullable<HealthPlanFocusDesign['focus']>;
+/** Who the card is about: the page's pet and the possessive its words use ("her", "his", "Georgia's"), or null. */
+interface HealthPlanTopCardPet {
+    readonly pet: HealthPlanPagePet;
+    readonly possessive: string | null;
+}
+/** The card's own words. Defaults: Raph's v3 design (`HEALTH_PLAN_TOP_CARD_COPY`). */
+interface HealthPlanTopCardCopy {
+    /** The plan button ("See her Health Plan"); null draws none. */
+    readonly action: (who: HealthPlanTopCardPet) => string | null;
+    /** The question link ("What does it mean?"). */
+    readonly ask: string;
+    /** What the link sends to the chat: the risk line's lead, then the link's words. */
+    readonly askPrompt: (focus: HealthPlanTopCardFocus, ask: string) => string;
+    /** The close control's accessible name ("Close her focus"); null or blank names it with the chat's plain "Close". */
+    readonly close: (who: HealthPlanTopCardPet) => string | null;
+}
+declare const HEALTH_PLAN_TOP_CARD_COPY: HealthPlanTopCardCopy;
+/**
+ * "her" for a female, "his" for a male, "Georgia's" for a named pet of unknown sex, else null. The sex is read
+ * leniently (any case, surrounding spaces), so a host-shaped page that says "Female" still reads as her.
+ */
+declare function healthPlanPossessive(pet: HealthPlanPagePet): string | null;
+interface HealthPlanTopCardOptions {
+    /** Opens the pet's Health Plan (your tab or screen). Absent, the card has no plan button (the chat's own card). */
+    readonly onOpenPlan?: (() => void) | undefined;
+    readonly copy?: Partial<HealthPlanTopCardCopy>;
+    readonly classNames?: EverfurChatTopCard['classNames'];
+    readonly renderIcon?: (icon: 'close') => ReactNode;
+}
+/** The top card for a page, or undefined when the page has no focus to show. Pure. */
+declare function healthPlanTopCard(page: HealthPlanPage | null, options: HealthPlanTopCardOptions): EverfurChatTopCard | undefined;
+interface UseHealthPlanTopCardOptions extends HealthPlanTopCardOptions {
+    readonly petRef: PetRef | null;
+    /** False skips the page read (and the card). Defaults to true. */
+    readonly enabled?: boolean;
+}
+/**
+ * The chat's top card for one pet, from its Health Plan page; undefined while the page loads, on a refused read, or
+ * when the page has no focus. Keep `onOpenPlan`, `copy`, `classNames` and `renderIcon` stable (module constants or
+ * memoised), so the card is rebuilt only when the page changes.
+ */
+declare function useHealthPlanTopCard(options: UseHealthPlanTopCardOptions): EverfurChatTopCard | undefined;
+
+export { EverfurChatTopCard, EverfurError, EverfurHealthPlan, type EverfurHealthPlanProps, EverfurPresentationInput, EverfurResult, HEALTH_PLAN_TOP_CARD_COPY, HealthPlanCardOptions, HealthPlanCart, HealthPlanCartBar, type HealthPlanCartBarProps, HealthPlanCheckoutProvider, HealthPlanEmptyCopy, HealthPlanFocus, HealthPlanFocusClassNames, HealthPlanFocusCopy, HealthPlanFocusDesign, HealthPlanFocusIcon, type HealthPlanFocusLayer, type HealthPlanFocusOptions, type HealthPlanFocusOverlay, type HealthPlanFocusOverlayControls, type HealthPlanFocusProps, HealthPlanImageVariant, HealthPlanItem, HealthPlanItemCard, type HealthPlanItemCardProps, HealthPlanLayoutProps, HealthPlanOneBoxOrder, HealthPlanPage, HealthPlanPagePet, HealthPlanPageRepository, HealthPlanPriceFormat, HealthPlanReasonVariant, HealthPlanShopOrder, HealthPlanSubscription, type HealthPlanSubscriptionOptions, type HealthPlanSubscriptionPhase, HealthPlanSubscriptionQuote, HealthPlanSubscriptionRepository, type HealthPlanSubscriptionState, type HealthPlanTopCardCopy, type HealthPlanTopCardFocus, type HealthPlanTopCardOptions, type HealthPlanTopCardPet, HealthPlanTopRisk, type HealthPlanTopRiskProps, LifecyclePort, PetRef, type UseHealthPlanTopCardOptions, healthPlanPossessive, healthPlanTopCard, useHealthPlanSubscription, useHealthPlanSubscriptionRepository, useHealthPlanTopCard };