@everfur/sdk 0.13.0 → 0.15.0

package/dist/usePresentation.d-BsR08Wxt.d.ts

@@ -0,0 +1,285 @@
+import { ReactNode } from 'react';
+import { E as EverfurError } from './EverfurError.d-8NHtlgzA.js';
+import { P as PetRef } from './ids.d-B2GAAifq.js';
+import { f as HealthPlanItem, m as HealthPlan, n as HealthPlanRepository, o as HealthPlanReasonKind } from './focus.d-CtotIyEt.js';
+import { L as LifecyclePort } from './LifecyclePort.d-Cr1p33a7.js';
+import { d as RecordsRequestView, f as RecordsView } from './models.d-DOwnr8fi.js';
+import { i as EverfurPresentationInput, h as EverfurPresentation } from './presentation.d-vy8kTGfR.js';
+
+type EverfurHealthPlanStatus = 'signedOut' | 'noPet' | 'loading' | 'failed' | 'empty' | 'ready';
+/** The member's cart: the items in the plan, and their total when one can honestly be given. */
+interface HealthPlanCart {
+    readonly items: readonly HealthPlanItem[];
+    readonly count: number;
+    /**
+     * The sum of the priced items, or null when any item has no price or the items do not share one currency
+     * (a total across currencies is a number nobody can pay).
+     */
+    readonly subtotal: number | null;
+    /** The shared currency of `subtotal`, or null. */
+    readonly currency: string | null;
+}
+interface EverfurHealthPlanOptions {
+    /** The pet whose plan to show. Omit it and the provider's active pet is used. */
+    readonly petRef?: PetRef | null;
+    /**
+     * The host's lifecycle signals: coming back to the foreground re-reads a plan shown for more than a minute, quietly
+     * (the plan stays on screen). Absent, only `refreshKey` and `refresh()` re-read.
+     */
+    readonly lifecycle?: LifecyclePort | null;
+    /** Change it to re-read the plan now, quietly (for example after your checkout completed). */
+    readonly refreshKey?: string | number;
+}
+interface EverfurHealthPlanState {
+    readonly status: EverfurHealthPlanStatus;
+    readonly petRef: PetRef | null;
+    readonly plan: HealthPlan | null;
+    readonly cart: HealthPlanCart;
+    /** Product ids whose add or remove is in flight. */
+    readonly pending: readonly string[];
+    /** The last refused write per product id. */
+    readonly itemErrors: Readonly<Record<string, EverfurError>>;
+    /** The refused read, or null. */
+    readonly error: EverfurError | null;
+    /** Put an item in the plan (`true`) or take it out (`false`). Optimistic; rolls back on a refusal. */
+    setInPlan(productId: string, inPlan: boolean): Promise<boolean>;
+    refresh(): Promise<void>;
+}
+/** The cart a plan makes. Pure, so a partner's own cart UI reads the same totals. */
+declare function healthPlanCart(plan: HealthPlan | null): HealthPlanCart;
+/**
+ * A price as the member reads it: the platform's own currency format (`$19.99`), or `USD 19.99` where the runtime
+ * has no formatter for that currency. Null for an item with no price; the surface shows none rather than `$0`.
+ * `locale` picks the number format (omit it for the platform default). With `format.dropZeroCents` a whole amount
+ * reads without minor units (`$39`); a non-whole one keeps them (`$29.99`).
+ */
+declare function formatHealthPlanPrice(amount: number | null, currency: string | null, locale?: string, format?: Pick<HealthPlanPriceFormat, 'dropZeroCents'>): string | null;
+/** `formatHealthPlanPrice` with a page's `priceFormat` option. */
+declare function formatHealthPlanPriceWith(amount: number | null, currency: string | null, format?: HealthPlanPriceFormat): string | null;
+/** The Health Plan repository bound to the runtime under your provider, for a partner's own UI. */
+declare function useEverfurHealthPlanRepository(): HealthPlanRepository;
+/** One pet's Health Plan and the member's cart. `EverfurHealthPlan` renders it on either host. */
+declare function useEverfurHealthPlan(options?: EverfurHealthPlanOptions): EverfurHealthPlanState;
+
+/** Where a product's picture sits on its card. */
+type HealthPlanImageVariant = 'wide' | 'thumbnail';
+/** How a product's reasons are drawn. */
+type HealthPlanReasonVariant = 'pills' | 'rows';
+/** When the page draws the cart bar. */
+type HealthPlanCartBarVisibility = 'whenItems' | 'always';
+/** Where the cart bar lives: stuck to the foot of the page, or nowhere on the page (the host docks its own). */
+type HealthPlanCartBarPlacement = 'sticky' | 'none';
+/** The size of a product card's add control: a named size, or the pill's height in px. */
+type HealthPlanAddButtonSize = 'full' | 'compact' | number;
+/** How a product in the cart shows: "Added" with a Remove link, or the add pill held pressed. */
+type HealthPlanAddedVariant = 'link' | 'pressed';
+/** How a product's category reads: body text, or the reason-row label face (mono, uppercase). */
+type HealthPlanCategoryVariant = 'text' | 'label';
+/** A shadow of the partner's own, painted the same way on both hosts. Lengths are px. */
+interface HealthPlanShadow {
+    /** Any colour the theme parser reads (`#RRGGBB`, `rgba(...)`). */
+    readonly color: string;
+    readonly offsetX?: number;
+    readonly offsetY: number;
+    readonly blur: number;
+    /** 0..1, multiplied into the colour's own alpha. Default 1. */
+    readonly opacity?: number;
+}
+/** A card shadow: `true` for the SDK's soft one, a CSS shadow string, or a `HealthPlanShadow`. */
+type HealthPlanCardShadow = boolean | string | HealthPlanShadow;
+/** A font weight a card text accepts. */
+type HealthPlanFontWeight = 400 | 500 | 600 | 700 | 800 | 900;
+/** How a price reads. Prices always go through `Intl.NumberFormat` with the item's own currency. */
+interface HealthPlanPriceFormat {
+    /** A BCP 47 locale for the number format. Omit it and the platform's default locale is used. */
+    readonly locale?: string;
+    /** True to drop zero minor units on a whole amount (`$39` instead of `$39.00`). A non-whole amount keeps them. */
+    readonly dropZeroCents?: boolean;
+}
+declare const HEALTH_PLAN_LAYOUT_DEFAULTS: Readonly<{
+    imageVariant: HealthPlanImageVariant;
+    reasonVariant: HealthPlanReasonVariant;
+    cartBarVisibility: HealthPlanCartBarVisibility;
+    cartBarPlacement: HealthPlanCartBarPlacement;
+    addButtonSize: HealthPlanAddButtonSize;
+    addedVariant: HealthPlanAddedVariant;
+    categoryVariant: HealthPlanCategoryVariant;
+    showCategory: false;
+    cardShadow: false;
+    cardBorder: true;
+}>;
+/** True when the page should draw the cart bar for a cart of `count` items. */
+declare function showHealthPlanCartBar(visibility: HealthPlanCartBarVisibility | undefined, count: number): boolean;
+/**
+ * What a partner's header and footer nodes are handed: the pet, its plan and the member's cart, as the page draws
+ * them. `cart.items` are the products in the plan, `cart.count` how many, `cart.subtotal` their sum (null when the
+ * currencies differ or a price is missing).
+ */
+interface HealthPlanHeaderContext {
+    readonly petRef: PetRef | null;
+    readonly plan: HealthPlan | null;
+    readonly cart: HealthPlanCart;
+    /**
+     * Put a product in the plan (`true`) or take it out (`false`), through the same optimistic write the cards use:
+     * the card flips at once and a refusal puts it back. Resolves true when the server accepted it.
+     */
+    readonly setInPlan: (productId: string, inPlan: boolean) => Promise<boolean>;
+    /** Put every product not yet in the plan into it. Resolves true when every write was accepted. */
+    readonly addAll: () => Promise<boolean>;
+}
+/** The same context, named for the page footer. */
+type HealthPlanPageContext = HealthPlanHeaderContext;
+/** The card options `HealthPlanItemCard` takes, on both hosts. */
+interface HealthPlanCardOptions {
+    /** True to draw the product's category above its name. Default false. */
+    readonly showCategory?: boolean;
+    /**
+     * A shadow under the card: `true` for the SDK's soft one (the theme's shadow colour at 8%), a CSS shadow string
+     * (`0 1px 3px rgba(38,37,35,.06)`; React Native reads the first shadow's offset, blur and colour), or a
+     * `HealthPlanShadow`. Default none.
+     */
+    readonly cardShadow?: HealthPlanCardShadow;
+    /** False to drop the card's hairline edge. Default true. */
+    readonly cardBorder?: boolean;
+    /** `'full'` (default, 44 high), `'compact'` (32 high), or the pill's height in px. The tap area stays 44. */
+    readonly addButtonSize?: HealthPlanAddButtonSize;
+    /** The add control's font size in px. Default: body for a pill 40 or taller, else caption. */
+    readonly addButtonFontSize?: number;
+    /** `'link'` (default): "Added" and a Remove link. `'pressed'`: the pill stays, pressed; a tap removes it. */
+    readonly addedVariant?: HealthPlanAddedVariant;
+    /** `'text'` (default) or `'label'` (the reason-row label face). Only read with `showCategory`. */
+    readonly categoryVariant?: HealthPlanCategoryVariant;
+    /** The card's inner padding in px. Default the theme's `space.lg`. */
+    readonly cardPadding?: number;
+    /** The product name's size (px) and weight. Default body size, bold. */
+    readonly itemTitleSize?: number;
+    readonly itemTitleWeight?: HealthPlanFontWeight;
+    /** The price's size (px) and weight. Default body size, bold. */
+    readonly priceSize?: number;
+    readonly priceWeight?: HealthPlanFontWeight;
+    /** The reason text's size (px). Default caption size. */
+    readonly reasonTextSize?: number;
+    /** The label column of `'rows'` reasons in px. Default sized to the longest label (web) or 72 (React Native). */
+    readonly reasonLabelWidth?: number;
+    /** The space between a reason row's label and its text in px. Default the theme's `space.lg`. */
+    readonly reasonGap?: number;
+}
+/** The layout props `EverfurHealthPlan` takes on both hosts. Paint stays the theme's. */
+interface HealthPlanLayoutProps extends HealthPlanCardOptions {
+    /** Where each product's picture sits. Default `'wide'`. */
+    readonly imageVariant?: HealthPlanImageVariant;
+    /** How each product's reasons are drawn. Default `'pills'`. */
+    readonly reasonVariant?: HealthPlanReasonVariant;
+    /** When the cart bar is drawn. Default `'whenItems'`. */
+    readonly cartBarVisibility?: HealthPlanCartBarVisibility;
+    /** How prices and the subtotal read. */
+    readonly priceFormat?: HealthPlanPriceFormat;
+    /**
+     * Your own node between the plan title and the products (a summary or risk card of yours). Drawn on the plan and
+     * on the empty plan. A throw while rendering it draws nothing in its place.
+     */
+    readonly renderHeader?: (context: HealthPlanHeaderContext) => ReactNode;
+    /** Your own node at the foot of each product card, above its control. A throw draws nothing in its place. */
+    readonly renderItemFooter?: (item: HealthPlanItem) => ReactNode;
+    /**
+     * Your own node after the products, before the cart bar (totals, an upsell row, fine print). Drawn on the plan only.
+     * A throw draws nothing in its place.
+     */
+    readonly renderFooter?: (context: HealthPlanPageContext) => ReactNode;
+    /** The plan title's font size in px. Default the theme's heading size. */
+    readonly titleSize?: number;
+    /** The space under the plan title in px. Default the section gap. */
+    readonly titleGap?: number;
+    /** The space between the page's blocks in px. Default the theme's `space.lg`. */
+    readonly sectionGap?: number;
+    /** Where the cart bar lives. Default `'sticky'`. With `'none'`, wrap the page and your bar in `HealthPlanCartScope`. */
+    readonly cartBarPlacement?: HealthPlanCartBarPlacement;
+    /** The plan title's line height as a ratio of its size (1.15 reads tight). Default the theme's snug ratio. */
+    readonly titleLineHeight?: number;
+    /**
+     * Your own node between two products (a group label such as a list heading), drawn before the product at `index`
+     * (1 and up; never before the first). Return null for no node. A throw draws nothing in its place.
+     */
+    readonly renderBetweenItems?: (index: number, item: HealthPlanItem) => ReactNode;
+}
+/**
+ * True for a refusal because the session is not a SIGNED member session: the plan routes answer a publishable-key or
+ * unsigned caller 403 `session_required` (EFBackend partner_shop_widget_router.py). A retry cannot help, so the
+ * surface shows the sign-in line and no retry.
+ */
+declare function isHealthPlanSessionRequired(error: EverfurError | null): boolean;
+
+/** Where her clinic request stands, for the three blanks. */
+type HealthPlanBlanksPhase = 'wait' | 'filled';
+interface HealthPlanBlanksFacts {
+    readonly phase: HealthPlanBlanksPhase;
+    /** The request's id: the plan flashes the filled blanks once per request. */
+    readonly requestId: string;
+    /** The clinic the request went to, as the member chose it; null when the request does not name one. */
+    readonly clinicName: string | null;
+    /** Her latest weight in her vet records, in kilograms; null when they hold none (or before they land). */
+    readonly weightKg: number | null;
+    /** When her next vaccine is due (ms, a UTC day), the earliest one due from today on; null when none is. */
+    readonly nextShotsAt: number | null;
+}
+/**
+ * Her latest weight from her vet records: the record's weight series and weight facts, newest first. A reading the
+ * owner typed (`owner_reported`) is not her vet records' and is skipped.
+ */
+declare function healthPlanRecordsWeightKg(record: RecordsView | null): number | null;
+/** The earliest vaccine her record says is due from `today` (ms, the start of a UTC day) on. */
+declare function healthPlanNextShotsAt(record: RecordsView | null, today: number): number | null;
+/**
+ * The three blanks from her records read: the latest clinic request and the record. `now` is a clock reading (ms).
+ * Null when there is no card to draw.
+ */
+declare function healthPlanBlanksFacts(input: {
+    readonly requests: readonly RecordsRequestView[];
+    readonly record: RecordsView | null;
+}, now: number): HealthPlanBlanksFacts | null;
+
+declare const HEALTH_PLAN_COPY: Readonly<{
+    loading: "Loading";
+    retry: "Try again";
+    signedOut: "Sign in required";
+    addToCart: "Add to cart";
+    added: "Added";
+    remove: "Remove";
+    checkout: "Checkout";
+    subtotal: "Subtotal";
+    sample: "Sample";
+    cartEmpty: "Your cart is empty.";
+    choosePet: "Choose a pet";
+    emptyTitle: "";
+    emptyBody: "";
+    emptyAsk: "";
+}>;
+/** The Health Plan's empty state words (Q1). Each is '' by default: an empty title and body draw nothing. */
+interface HealthPlanEmptyCopy {
+    readonly emptyTitle: string;
+    readonly emptyBody: string;
+    /** The empty state's Ask button. */
+    readonly emptyAsk: string;
+}
+/**
+ * The reason labels, one per kind. An empty label is not drawn (the reason's text still is). `profile` (a pet profile
+ * fact) has no source yet; `dna` names one partner's product, so the SDK leaves it to that partner (Q3).
+ */
+declare const HEALTH_PLAN_REASON_LABELS: Readonly<Record<HealthPlanReasonKind, string>>;
+/** ADAPTED from Raph. Listed for approval. */
+declare const HEALTH_PLAN_TEMPLATES: Readonly<{
+    /** Raph: "Georgia's care plan". Used only when the plan carries no `headline` of the tenant's own. */
+    planTitle: (petName: string) => string;
+    /** Raph: "<brand> cart" (his demo named the partner). */
+    cartLabel: (brand: string) => string;
+}>;
+/** Every key still waiting on Raph's words (empty, so not drawn), so the list a reviewer approves cannot drift from the file. */
+declare const HEALTH_PLAN_COPY_PLACEHOLDERS: readonly string[];
+
+/**
+ * The tenant's presentation settings resolved against `client` (the explicit props; leave a field undefined to
+ * take the console value). Total: always every field.
+ */
+declare function useEverfurPresentation(client?: EverfurPresentationInput | null): EverfurPresentation;
+
+export { formatHealthPlanPriceWith as A, healthPlanBlanksFacts as B, healthPlanCart as C, healthPlanNextShotsAt as D, type EverfurHealthPlanOptions as E, healthPlanRecordsWeightKg as F, isHealthPlanSessionRequired as G, type HealthPlanBlanksFacts as H, showHealthPlanCartBar as I, useEverfurHealthPlan as J, useEverfurHealthPlanRepository as K, useEverfurPresentation as L, type HealthPlanPriceFormat as a, type HealthPlanLayoutProps as b, type HealthPlanEmptyCopy as c, type HealthPlanCart as d, type HealthPlanCardOptions as e, type HealthPlanImageVariant as f, type HealthPlanReasonVariant as g, type EverfurHealthPlanState as h, type EverfurHealthPlanStatus as i, HEALTH_PLAN_COPY as j, HEALTH_PLAN_COPY_PLACEHOLDERS as k, HEALTH_PLAN_LAYOUT_DEFAULTS as l, HEALTH_PLAN_REASON_LABELS as m, HEALTH_PLAN_TEMPLATES as n, type HealthPlanAddButtonSize as o, type HealthPlanAddedVariant as p, type HealthPlanBlanksPhase as q, type HealthPlanCardShadow as r, type HealthPlanCartBarPlacement as s, type HealthPlanCartBarVisibility as t, type HealthPlanCategoryVariant as u, type HealthPlanFontWeight as v, type HealthPlanHeaderContext as w, type HealthPlanPageContext as x, type HealthPlanShadow as y, formatHealthPlanPrice as z };

package/dist/usePresentation.d-CZS0qlLI.d.cts

@@ -0,0 +1,285 @@
+import { ReactNode } from 'react';
+import { E as EverfurError } from './EverfurError.d-8NHtlgzA.cjs';
+import { P as PetRef } from './ids.d-B2GAAifq.cjs';
+import { f as HealthPlanItem, m as HealthPlan, n as HealthPlanRepository, o as HealthPlanReasonKind } from './focus.d-Dsm39DjO.cjs';
+import { L as LifecyclePort } from './LifecyclePort.d-Cr1p33a7.cjs';
+import { d as RecordsRequestView, f as RecordsView } from './models.d-BSqvbTE1.cjs';
+import { i as EverfurPresentationInput, h as EverfurPresentation } from './presentation.d-vy8kTGfR.cjs';
+
+type EverfurHealthPlanStatus = 'signedOut' | 'noPet' | 'loading' | 'failed' | 'empty' | 'ready';
+/** The member's cart: the items in the plan, and their total when one can honestly be given. */
+interface HealthPlanCart {
+    readonly items: readonly HealthPlanItem[];
+    readonly count: number;
+    /**
+     * The sum of the priced items, or null when any item has no price or the items do not share one currency
+     * (a total across currencies is a number nobody can pay).
+     */
+    readonly subtotal: number | null;
+    /** The shared currency of `subtotal`, or null. */
+    readonly currency: string | null;
+}
+interface EverfurHealthPlanOptions {
+    /** The pet whose plan to show. Omit it and the provider's active pet is used. */
+    readonly petRef?: PetRef | null;
+    /**
+     * The host's lifecycle signals: coming back to the foreground re-reads a plan shown for more than a minute, quietly
+     * (the plan stays on screen). Absent, only `refreshKey` and `refresh()` re-read.
+     */
+    readonly lifecycle?: LifecyclePort | null;
+    /** Change it to re-read the plan now, quietly (for example after your checkout completed). */
+    readonly refreshKey?: string | number;
+}
+interface EverfurHealthPlanState {
+    readonly status: EverfurHealthPlanStatus;
+    readonly petRef: PetRef | null;
+    readonly plan: HealthPlan | null;
+    readonly cart: HealthPlanCart;
+    /** Product ids whose add or remove is in flight. */
+    readonly pending: readonly string[];
+    /** The last refused write per product id. */
+    readonly itemErrors: Readonly<Record<string, EverfurError>>;
+    /** The refused read, or null. */
+    readonly error: EverfurError | null;
+    /** Put an item in the plan (`true`) or take it out (`false`). Optimistic; rolls back on a refusal. */
+    setInPlan(productId: string, inPlan: boolean): Promise<boolean>;
+    refresh(): Promise<void>;
+}
+/** The cart a plan makes. Pure, so a partner's own cart UI reads the same totals. */
+declare function healthPlanCart(plan: HealthPlan | null): HealthPlanCart;
+/**
+ * A price as the member reads it: the platform's own currency format (`$19.99`), or `USD 19.99` where the runtime
+ * has no formatter for that currency. Null for an item with no price; the surface shows none rather than `$0`.
+ * `locale` picks the number format (omit it for the platform default). With `format.dropZeroCents` a whole amount
+ * reads without minor units (`$39`); a non-whole one keeps them (`$29.99`).
+ */
+declare function formatHealthPlanPrice(amount: number | null, currency: string | null, locale?: string, format?: Pick<HealthPlanPriceFormat, 'dropZeroCents'>): string | null;
+/** `formatHealthPlanPrice` with a page's `priceFormat` option. */
+declare function formatHealthPlanPriceWith(amount: number | null, currency: string | null, format?: HealthPlanPriceFormat): string | null;
+/** The Health Plan repository bound to the runtime under your provider, for a partner's own UI. */
+declare function useEverfurHealthPlanRepository(): HealthPlanRepository;
+/** One pet's Health Plan and the member's cart. `EverfurHealthPlan` renders it on either host. */
+declare function useEverfurHealthPlan(options?: EverfurHealthPlanOptions): EverfurHealthPlanState;
+
+/** Where a product's picture sits on its card. */
+type HealthPlanImageVariant = 'wide' | 'thumbnail';
+/** How a product's reasons are drawn. */
+type HealthPlanReasonVariant = 'pills' | 'rows';
+/** When the page draws the cart bar. */
+type HealthPlanCartBarVisibility = 'whenItems' | 'always';
+/** Where the cart bar lives: stuck to the foot of the page, or nowhere on the page (the host docks its own). */
+type HealthPlanCartBarPlacement = 'sticky' | 'none';
+/** The size of a product card's add control: a named size, or the pill's height in px. */
+type HealthPlanAddButtonSize = 'full' | 'compact' | number;
+/** How a product in the cart shows: "Added" with a Remove link, or the add pill held pressed. */
+type HealthPlanAddedVariant = 'link' | 'pressed';
+/** How a product's category reads: body text, or the reason-row label face (mono, uppercase). */
+type HealthPlanCategoryVariant = 'text' | 'label';
+/** A shadow of the partner's own, painted the same way on both hosts. Lengths are px. */
+interface HealthPlanShadow {
+    /** Any colour the theme parser reads (`#RRGGBB`, `rgba(...)`). */
+    readonly color: string;
+    readonly offsetX?: number;
+    readonly offsetY: number;
+    readonly blur: number;
+    /** 0..1, multiplied into the colour's own alpha. Default 1. */
+    readonly opacity?: number;
+}
+/** A card shadow: `true` for the SDK's soft one, a CSS shadow string, or a `HealthPlanShadow`. */
+type HealthPlanCardShadow = boolean | string | HealthPlanShadow;
+/** A font weight a card text accepts. */
+type HealthPlanFontWeight = 400 | 500 | 600 | 700 | 800 | 900;
+/** How a price reads. Prices always go through `Intl.NumberFormat` with the item's own currency. */
+interface HealthPlanPriceFormat {
+    /** A BCP 47 locale for the number format. Omit it and the platform's default locale is used. */
+    readonly locale?: string;
+    /** True to drop zero minor units on a whole amount (`$39` instead of `$39.00`). A non-whole amount keeps them. */
+    readonly dropZeroCents?: boolean;
+}
+declare const HEALTH_PLAN_LAYOUT_DEFAULTS: Readonly<{
+    imageVariant: HealthPlanImageVariant;
+    reasonVariant: HealthPlanReasonVariant;
+    cartBarVisibility: HealthPlanCartBarVisibility;
+    cartBarPlacement: HealthPlanCartBarPlacement;
+    addButtonSize: HealthPlanAddButtonSize;
+    addedVariant: HealthPlanAddedVariant;
+    categoryVariant: HealthPlanCategoryVariant;
+    showCategory: false;
+    cardShadow: false;
+    cardBorder: true;
+}>;
+/** True when the page should draw the cart bar for a cart of `count` items. */
+declare function showHealthPlanCartBar(visibility: HealthPlanCartBarVisibility | undefined, count: number): boolean;
+/**
+ * What a partner's header and footer nodes are handed: the pet, its plan and the member's cart, as the page draws
+ * them. `cart.items` are the products in the plan, `cart.count` how many, `cart.subtotal` their sum (null when the
+ * currencies differ or a price is missing).
+ */
+interface HealthPlanHeaderContext {
+    readonly petRef: PetRef | null;
+    readonly plan: HealthPlan | null;
+    readonly cart: HealthPlanCart;
+    /**
+     * Put a product in the plan (`true`) or take it out (`false`), through the same optimistic write the cards use:
+     * the card flips at once and a refusal puts it back. Resolves true when the server accepted it.
+     */
+    readonly setInPlan: (productId: string, inPlan: boolean) => Promise<boolean>;
+    /** Put every product not yet in the plan into it. Resolves true when every write was accepted. */
+    readonly addAll: () => Promise<boolean>;
+}
+/** The same context, named for the page footer. */
+type HealthPlanPageContext = HealthPlanHeaderContext;
+/** The card options `HealthPlanItemCard` takes, on both hosts. */
+interface HealthPlanCardOptions {
+    /** True to draw the product's category above its name. Default false. */
+    readonly showCategory?: boolean;
+    /**
+     * A shadow under the card: `true` for the SDK's soft one (the theme's shadow colour at 8%), a CSS shadow string
+     * (`0 1px 3px rgba(38,37,35,.06)`; React Native reads the first shadow's offset, blur and colour), or a
+     * `HealthPlanShadow`. Default none.
+     */
+    readonly cardShadow?: HealthPlanCardShadow;
+    /** False to drop the card's hairline edge. Default true. */
+    readonly cardBorder?: boolean;
+    /** `'full'` (default, 44 high), `'compact'` (32 high), or the pill's height in px. The tap area stays 44. */
+    readonly addButtonSize?: HealthPlanAddButtonSize;
+    /** The add control's font size in px. Default: body for a pill 40 or taller, else caption. */
+    readonly addButtonFontSize?: number;
+    /** `'link'` (default): "Added" and a Remove link. `'pressed'`: the pill stays, pressed; a tap removes it. */
+    readonly addedVariant?: HealthPlanAddedVariant;
+    /** `'text'` (default) or `'label'` (the reason-row label face). Only read with `showCategory`. */
+    readonly categoryVariant?: HealthPlanCategoryVariant;
+    /** The card's inner padding in px. Default the theme's `space.lg`. */
+    readonly cardPadding?: number;
+    /** The product name's size (px) and weight. Default body size, bold. */
+    readonly itemTitleSize?: number;
+    readonly itemTitleWeight?: HealthPlanFontWeight;
+    /** The price's size (px) and weight. Default body size, bold. */
+    readonly priceSize?: number;
+    readonly priceWeight?: HealthPlanFontWeight;
+    /** The reason text's size (px). Default caption size. */
+    readonly reasonTextSize?: number;
+    /** The label column of `'rows'` reasons in px. Default sized to the longest label (web) or 72 (React Native). */
+    readonly reasonLabelWidth?: number;
+    /** The space between a reason row's label and its text in px. Default the theme's `space.lg`. */
+    readonly reasonGap?: number;
+}
+/** The layout props `EverfurHealthPlan` takes on both hosts. Paint stays the theme's. */
+interface HealthPlanLayoutProps extends HealthPlanCardOptions {
+    /** Where each product's picture sits. Default `'wide'`. */
+    readonly imageVariant?: HealthPlanImageVariant;
+    /** How each product's reasons are drawn. Default `'pills'`. */
+    readonly reasonVariant?: HealthPlanReasonVariant;
+    /** When the cart bar is drawn. Default `'whenItems'`. */
+    readonly cartBarVisibility?: HealthPlanCartBarVisibility;
+    /** How prices and the subtotal read. */
+    readonly priceFormat?: HealthPlanPriceFormat;
+    /**
+     * Your own node between the plan title and the products (a summary or risk card of yours). Drawn on the plan and
+     * on the empty plan. A throw while rendering it draws nothing in its place.
+     */
+    readonly renderHeader?: (context: HealthPlanHeaderContext) => ReactNode;
+    /** Your own node at the foot of each product card, above its control. A throw draws nothing in its place. */
+    readonly renderItemFooter?: (item: HealthPlanItem) => ReactNode;
+    /**
+     * Your own node after the products, before the cart bar (totals, an upsell row, fine print). Drawn on the plan only.
+     * A throw draws nothing in its place.
+     */
+    readonly renderFooter?: (context: HealthPlanPageContext) => ReactNode;
+    /** The plan title's font size in px. Default the theme's heading size. */
+    readonly titleSize?: number;
+    /** The space under the plan title in px. Default the section gap. */
+    readonly titleGap?: number;
+    /** The space between the page's blocks in px. Default the theme's `space.lg`. */
+    readonly sectionGap?: number;
+    /** Where the cart bar lives. Default `'sticky'`. With `'none'`, wrap the page and your bar in `HealthPlanCartScope`. */
+    readonly cartBarPlacement?: HealthPlanCartBarPlacement;
+    /** The plan title's line height as a ratio of its size (1.15 reads tight). Default the theme's snug ratio. */
+    readonly titleLineHeight?: number;
+    /**
+     * Your own node between two products (a group label such as a list heading), drawn before the product at `index`
+     * (1 and up; never before the first). Return null for no node. A throw draws nothing in its place.
+     */
+    readonly renderBetweenItems?: (index: number, item: HealthPlanItem) => ReactNode;
+}
+/**
+ * True for a refusal because the session is not a SIGNED member session: the plan routes answer a publishable-key or
+ * unsigned caller 403 `session_required` (EFBackend partner_shop_widget_router.py). A retry cannot help, so the
+ * surface shows the sign-in line and no retry.
+ */
+declare function isHealthPlanSessionRequired(error: EverfurError | null): boolean;
+
+/** Where her clinic request stands, for the three blanks. */
+type HealthPlanBlanksPhase = 'wait' | 'filled';
+interface HealthPlanBlanksFacts {
+    readonly phase: HealthPlanBlanksPhase;
+    /** The request's id: the plan flashes the filled blanks once per request. */
+    readonly requestId: string;
+    /** The clinic the request went to, as the member chose it; null when the request does not name one. */
+    readonly clinicName: string | null;
+    /** Her latest weight in her vet records, in kilograms; null when they hold none (or before they land). */
+    readonly weightKg: number | null;
+    /** When her next vaccine is due (ms, a UTC day), the earliest one due from today on; null when none is. */
+    readonly nextShotsAt: number | null;
+}
+/**
+ * Her latest weight from her vet records: the record's weight series and weight facts, newest first. A reading the
+ * owner typed (`owner_reported`) is not her vet records' and is skipped.
+ */
+declare function healthPlanRecordsWeightKg(record: RecordsView | null): number | null;
+/** The earliest vaccine her record says is due from `today` (ms, the start of a UTC day) on. */
+declare function healthPlanNextShotsAt(record: RecordsView | null, today: number): number | null;
+/**
+ * The three blanks from her records read: the latest clinic request and the record. `now` is a clock reading (ms).
+ * Null when there is no card to draw.
+ */
+declare function healthPlanBlanksFacts(input: {
+    readonly requests: readonly RecordsRequestView[];
+    readonly record: RecordsView | null;
+}, now: number): HealthPlanBlanksFacts | null;
+
+declare const HEALTH_PLAN_COPY: Readonly<{
+    loading: "Loading";
+    retry: "Try again";
+    signedOut: "Sign in required";
+    addToCart: "Add to cart";
+    added: "Added";
+    remove: "Remove";
+    checkout: "Checkout";
+    subtotal: "Subtotal";
+    sample: "Sample";
+    cartEmpty: "Your cart is empty.";
+    choosePet: "Choose a pet";
+    emptyTitle: "";
+    emptyBody: "";
+    emptyAsk: "";
+}>;
+/** The Health Plan's empty state words (Q1). Each is '' by default: an empty title and body draw nothing. */
+interface HealthPlanEmptyCopy {
+    readonly emptyTitle: string;
+    readonly emptyBody: string;
+    /** The empty state's Ask button. */
+    readonly emptyAsk: string;
+}
+/**
+ * The reason labels, one per kind. An empty label is not drawn (the reason's text still is). `profile` (a pet profile
+ * fact) has no source yet; `dna` names one partner's product, so the SDK leaves it to that partner (Q3).
+ */
+declare const HEALTH_PLAN_REASON_LABELS: Readonly<Record<HealthPlanReasonKind, string>>;
+/** ADAPTED from Raph. Listed for approval. */
+declare const HEALTH_PLAN_TEMPLATES: Readonly<{
+    /** Raph: "Georgia's care plan". Used only when the plan carries no `headline` of the tenant's own. */
+    planTitle: (petName: string) => string;
+    /** Raph: "<brand> cart" (his demo named the partner). */
+    cartLabel: (brand: string) => string;
+}>;
+/** Every key still waiting on Raph's words (empty, so not drawn), so the list a reviewer approves cannot drift from the file. */
+declare const HEALTH_PLAN_COPY_PLACEHOLDERS: readonly string[];
+
+/**
+ * The tenant's presentation settings resolved against `client` (the explicit props; leave a field undefined to
+ * take the console value). Total: always every field.
+ */
+declare function useEverfurPresentation(client?: EverfurPresentationInput | null): EverfurPresentation;
+
+export { formatHealthPlanPriceWith as A, healthPlanBlanksFacts as B, healthPlanCart as C, healthPlanNextShotsAt as D, type EverfurHealthPlanOptions as E, healthPlanRecordsWeightKg as F, isHealthPlanSessionRequired as G, type HealthPlanBlanksFacts as H, showHealthPlanCartBar as I, useEverfurHealthPlan as J, useEverfurHealthPlanRepository as K, useEverfurPresentation as L, type HealthPlanPriceFormat as a, type HealthPlanLayoutProps as b, type HealthPlanEmptyCopy as c, type HealthPlanCart as d, type HealthPlanCardOptions as e, type HealthPlanImageVariant as f, type HealthPlanReasonVariant as g, type EverfurHealthPlanState as h, type EverfurHealthPlanStatus as i, HEALTH_PLAN_COPY as j, HEALTH_PLAN_COPY_PLACEHOLDERS as k, HEALTH_PLAN_LAYOUT_DEFAULTS as l, HEALTH_PLAN_REASON_LABELS as m, HEALTH_PLAN_TEMPLATES as n, type HealthPlanAddButtonSize as o, type HealthPlanAddedVariant as p, type HealthPlanBlanksPhase as q, type HealthPlanCardShadow as r, type HealthPlanCartBarPlacement as s, type HealthPlanCartBarVisibility as t, type HealthPlanCategoryVariant as u, type HealthPlanFontWeight as v, type HealthPlanHeaderContext as w, type HealthPlanPageContext as x, type HealthPlanShadow as y, formatHealthPlanPrice as z };

package/dist/{useRecords.d-Cb-36SF5.d.cts → useRecords.d-BYNX01El.d.cts}

@@ -2,8 +2,8 @@ import { E as EverfurError } from './EverfurError.d-8NHtlgzA.cjs';
 import { E as EverfurResult } from './EverfurResult.d-BFH-3s6E.cjs';
 import { R as RecordsRequestId, P as PetRef } from './ids.d-B2GAAifq.cjs';
 import { F as FileHandle, U as UploadTransport } from './ports.d-BX4f4UsB.cjs';
-import { a as RecordsFeatures, b as RecordsUploadContentType } from './features.d-fNsGcg0R.cjs';
-import { C as CreateUploadRequestInput, d as RecordsRequestView, U as UploadedDocument, e as RecordsView, f as ConsentState, G as GrantConsentInput, g as RecordsDenialReason } from './models.d-BnLm3VAA.cjs';
+import { a as RecordsFeatures, b as RecordsUploadContentType } from './features.d-DrQxTw3-.cjs';
+import { C as CreateUploadRequestInput, d as RecordsRequestView, U as UploadedDocument, f as RecordsView, g as ConsentState, G as GrantConsentInput, h as RecordsDenialReason } from './models.d-BSqvbTE1.cjs';
 
 interface UploadDocumentInput {
     readonly requestId: RecordsRequestId;

package/dist/{useRecords.d-aQTzQZoV.d.ts → useRecords.d-DWk61a4c.d.ts}

@@ -2,8 +2,8 @@ import { E as EverfurError } from './EverfurError.d-8NHtlgzA.js';
 import { E as EverfurResult } from './EverfurResult.d-D_-254ZY.js';
 import { R as RecordsRequestId, P as PetRef } from './ids.d-B2GAAifq.js';
 import { F as FileHandle, U as UploadTransport } from './ports.d-BX4f4UsB.js';
-import { a as RecordsFeatures, b as RecordsUploadContentType } from './features.d-fNsGcg0R.js';
-import { C as CreateUploadRequestInput, d as RecordsRequestView, U as UploadedDocument, e as RecordsView, f as ConsentState, G as GrantConsentInput, g as RecordsDenialReason } from './models.d-BagXhafD.js';
+import { a as RecordsFeatures, b as RecordsUploadContentType } from './features.d-DrQxTw3-.js';
+import { C as CreateUploadRequestInput, d as RecordsRequestView, U as UploadedDocument, f as RecordsView, g as ConsentState, G as GrantConsentInput, h as RecordsDenialReason } from './models.d-DOwnr8fi.js';
 
 interface UploadDocumentInput {
     readonly requestId: RecordsRequestId;

package/dist/useRecordsDepth.d-DTAxFf5s.d.ts

@@ -0,0 +1,32 @@
+import { E as EverfurError } from './EverfurError.d-8NHtlgzA.js';
+import { E as EverfurResult } from './EverfurResult.d-D_-254ZY.js';
+import { P as PetRef } from './ids.d-B2GAAifq.js';
+import { l as RecordsDepthClient } from './depth.d-BEedifOR.js';
+
+type RecordsDepthStatus = 'loading' | 'empty' | 'error' | 'populated';
+/** One depth read as a render state. `withheld` (no consent, or a fail-closed parse) renders nothing. */
+interface UseRecordsDepthState<T> {
+    readonly status: RecordsDepthStatus;
+    readonly value: T | null;
+    readonly error: EverfurError | null;
+    /**
+     * False once a read got the router's dark 404, which is how a tenant without `partner.records_full_depth_enabled`
+     * answers EVERY depth route. The state is then `empty` with no error, so the surface draws its own nothing
+     * instead of the generic failure leaf and its unusable `Try again`. True otherwise, including for a failure
+     * that never reached the server, which proves nothing about the tenant.
+     */
+    readonly available: boolean;
+    readonly refresh: () => void;
+}
+/** The signed member's depth client over the provider's auth; a surface with no user settles to accessDenied. */
+declare function useEverfurRecordsDepthClient(): RecordsDepthClient;
+/**
+ * Run one depth read for the scoped pet on mount, and again on `refresh`. `isEmpty` decides between `empty`
+ * and `populated`; a withheld answer is `populated` with `withheld:true`, which every depth surface renders as
+ * nothing (never a partial record).
+ */
+declare function useRecordsDepthRead<T extends {
+    readonly withheld: boolean;
+}>(petRef: PetRef, read: (client: RecordsDepthClient, petRef: PetRef) => Promise<EverfurResult<T>>, isEmpty: (value: T) => boolean, extraKey?: string): UseRecordsDepthState<T>;
+
+export { type RecordsDepthStatus as R, type UseRecordsDepthState as U, useRecordsDepthRead as a, useEverfurRecordsDepthClient as u };