@everfur/sdk 0.1.1 → 0.4.0

package/dist/typeStyle-DmoyacDG.d.ts

@@ -0,0 +1,111 @@
+import { C as ClientBranding, E as EverfurThemeInput, a as EverfurTheme, b as EverfurFontWeight, c as EverfurFontFaceKey } from './branding-CsRdeNwK.js';
+
+/**
+ * Overlay `b` onto `base`, field by field: a non-null branding field WINS; a null field KEEPS the base. A
+ * valid brightness re-selects the matching compiled palette (light/dark); an invalid/absent brightness leaves
+ * the base palette untouched. Slots merge per slot, per key. Returns a NEW deeply-frozen theme; `base` and `b`
+ * are never mutated.
+ *
+ * The name is historical (the server was once the only overlay); `resolveTheme` applies it twice, server then
+ * client, which is how the client wins per field. NOTE: foreground legibility (onPrimary/onAccent, the slot
+ * guard) and URL hardening are applied by `resolveTheme`, the total entry point. Call this directly only when
+ * you will finalize the result yourself.
+ */
+declare function withServerBranding(base: EverfurTheme, b: ClientBranding | null): EverfurTheme;
+/**
+ * Inputs to the total theme resolve. All optional; `resolveTheme(undefined)` yields the compiled Everfur
+ * default. Merge order: compiled default <- server branding (render_hints) <- client theme prop, per field, with
+ * the tenant's locked fields and the attribution kept from the server (see `resolveTheme`).
+ */
+interface ResolveThemeInput {
+    /** Server-driven branding from the live entitlements render_hints (the tenant's console branding). */
+    readonly branding?: ClientBranding | null;
+    /**
+     * The clamped client `theme` prop. It WINS per cosmetic field over the server branding, except the fields the
+     * server lists in `locked_fields`. Its hidePoweredBy is IGNORED: whether the Everfur attribution shows is
+     * decided by server branding alone.
+     */
+    readonly clientOverride?: ClientBranding | null;
+    /**
+     * The device color scheme (useColorScheme / `prefers-color-scheme`). Read ONLY when the settled brightness is
+     * `auto` (an explicit opt-in); with no brightness set anywhere the theme is light, as Everfur's own apps are.
+     */
+    readonly colorScheme?: 'light' | 'dark' | null;
+    /** AccessibilityInfo reduced-motion / `prefers-reduced-motion`: collapses the motion tokens. */
+    readonly reducedMotion?: boolean;
+    /**
+     * The user's text scale as the host reads it (React Native: `PixelRatio.getFontScale()`; the browser: the
+     * browser's default font size over 16px). Floored at `TEXT_SCALE_FLOOR`; absent or junk reads as 1. Flowing
+     * content follows it uncapped; each chrome tier follows it up to that tier's cap (`type.scaleCaps`).
+     */
+    readonly textScale?: number;
+    /**
+     * Multiply the type sizes by the effective scale, per tier (`type.size` for content, `type.tierSizes` for every
+     * tier). A browser host passes true (CSS px do not follow the user's setting on their own); a React Native host
+     * leaves it false and lets the platform scale every Text natively, capped per tier by `maxFontSizeMultiplier`.
+     */
+    readonly scaleTypeSizes?: boolean;
+    /** The user asked for more contrast (`prefers-contrast: more`): the palette is derived by `deriveHighContrast`. */
+    readonly highContrast?: boolean;
+    /**
+     * The family the platform's generic mono keyword (`SYSTEM_MONO_FAMILY`) maps to on this host. React Native on iOS
+     * has no family named `monospace` (a Text asking for it renders proportional, and the legacy architecture
+     * red-boxes in development), so the React Native host passes `Menlo` there. Applied to the compiled default mono
+     * only: a partner's own mono face is never touched. Absent or blank, the keyword stands (the web maps it to its
+     * mono stack in CSS).
+     */
+    readonly platformMonoFamily?: string;
+    /**
+     * Whether a family name is registered with the platform, when the host can tell: true or false, else null. A
+     * NAMED face (one per-weight name, rendered without a weight) that the host reports unregistered falls back to
+     * the platform font of its group WITH its numeric weight, so medium and bold survive instead of every weight
+     * collapsing to the platform's regular. Only named faces are asked about; a throw reads as null.
+     */
+    readonly isFontRegistered?: (family: string) => boolean | null;
+}
+/** The smallest effective text scale the resolver will report (a device may ask for less; the surfaces stop here). */
+declare const TEXT_SCALE_FLOOR = 0.5;
+/**
+ * Resolve the final, legible, deeply-frozen theme. Never throws, never returns null/transparent.
+ *
+ * PRECEDENCE (per field, owner decision of 18 September 2026; the same rule EFBackend render_hint_fold states):
+ * a field in `locked_fields` (plus `hide_powered_by` always) is server-wins; every other cosmetic field is
+ * client-wins.
+ *   - A server branding with an unknown `schema_version` is dropped whole (default plus client theme).
+ *   - `hide_powered_by`, and every name the server lists in `locked_fields`, are SERVER-WINS: the client's value
+ *     for such a field is discarded before the merge, so the server's value or the compiled default stands.
+ *     `slots` in the list locks every slot; `slots.<name>` locks one.
+ *   - Every other cosmetic field is CLIENT-WINS: the client `theme` prop overrides the console value, and the
+ *     console fills the fields the prop leaves unset. Brightness is settled the same way; set nowhere, it is
+ *     LIGHT (owner decision OD28: Everfur's own apps are light-only), and `auto` follows the device scheme.
+ *   - Slots overlay slot by slot (a named slot replaces the one below it whole) in the same order, after the
+ *     field precedence.
+ * Then the total-resolve guarantees: onPrimary/onAccent via WCAG, the slot contrast guard, https-only logo/font
+ * URLs, a non-empty displayName, the text scale (floored; tiered caps on the chrome), motion collapsed under reduced
+ * motion, and the high-contrast derivation when the user asked for it.
+ */
+declare function resolveTheme(input?: ResolveThemeInput): EverfurTheme;
+/**
+ * The console's preview helper: resolve a draft branding exactly as the device would, from the raw shapes (the
+ * partner's `theme` prop and the server-shaped branding object the console is about to publish), with the device
+ * inputs of the preview. Pure and total: any shape is tolerated, nothing throws.
+ */
+declare function previewTheme(input: EverfurThemeInput | null, hints: unknown, options?: Omit<ResolveThemeInput, 'branding' | 'clientOverride'>): EverfurTheme;
+
+/**
+ * The text style a surface spreads for one face. `fontWeight` is present ONLY for a base family (the platform
+ * font, the legacy `font_family`, or a `fonts` name repeated across weights); a named face carries its weight
+ * itself. The regular mono face carries no weight (code renders in the regular mono face); its medium and bold
+ * twins (`monoMedium`, `monoBold`) take theirs when the mono family is a base family.
+ */
+interface EverfurFaceStyle {
+    readonly fontFamily: string;
+    readonly fontWeight?: EverfurFontWeight;
+}
+/**
+ * The family (and, for a base family, the numeric weight) of one face of the theme. Spread it into a style:
+ * `{ ...face(theme, 'bold'), fontSize: theme.type.size.body }`. Pure and total over any resolved theme.
+ */
+declare function face(theme: EverfurTheme, weight: EverfurFontFaceKey): EverfurFaceStyle;
+
+export { type EverfurFaceStyle as E, type ResolveThemeInput as R, TEXT_SCALE_FLOOR as T, face as f, previewTheme as p, resolveTheme as r, withServerBranding as w };

package/dist/uploadTransport-D0M0T4hN.d.ts

@@ -0,0 +1,38 @@
+import { F as FileHandle, U as UploadTransport } from './ports-BN6RHF9W.js';
+
+/** The subset of `fetch` this adapter calls. */
+type RnRecordsUploadFetch = (url: string, init: {
+    readonly method: 'POST';
+    readonly body: FormData;
+    readonly credentials: 'omit';
+    readonly signal?: AbortSignal;
+}) => Promise<{
+    readonly ok: boolean;
+}>;
+interface RnRecordsUploadTransportOptions {
+    /** Test seam: the fetch to use. Defaults to the global `fetch`. A host has no reason to set it. */
+    readonly fetch?: RnRecordsUploadFetch;
+}
+/**
+ * A host-supplied document picker for React Native records upload. Open your own picker (for example
+ * `expo-document-picker`, which the SDK does not depend on) limited to PDF, and resolve:
+ *
+ * - `null` when the user cancels,
+ * - one `FileHandle`, or SEVERAL (a multi-select pick): each with the local `uri`, `mimeType: 'application/pdf'`
+ *   and `sizeBytes`. A batch uploads one file at a time with a live row per file; a non-PDF or oversize file in
+ *   it is skipped with a reason before any request is made (the single-file path refuses it the same way).
+ *   `name` is optional, rendered in the rows locally, and never sent.
+ */
+type RecordsDocumentPicker = () => Promise<FileHandle | readonly FileHandle[] | null>;
+/**
+ * Create the React Native records upload transport. Pass it as `uploadTransport` on the `EverfurConfig`, or
+ * to `<EverfurRecords uploadTransport={...} />`:
+ *
+ * ```tsx
+ * const uploadTransport = createRnRecordsUploadTransport();
+ * <EverfurProvider config={{ publishableKey, apiBaseUrl, uploadTransport }} ...>
+ * ```
+ */
+declare function createRnRecordsUploadTransport(options?: RnRecordsUploadTransportOptions): UploadTransport;
+
+export { type RecordsDocumentPicker as R, type RnRecordsUploadFetch as a, type RnRecordsUploadTransportOptions as b, createRnRecordsUploadTransport as c };

package/dist/uploadTransport-DKJHs3Yj.d.cts

@@ -0,0 +1,38 @@
+import { F as FileHandle, U as UploadTransport } from './ports-BN6RHF9W.cjs';
+
+/** The subset of `fetch` this adapter calls. */
+type RnRecordsUploadFetch = (url: string, init: {
+    readonly method: 'POST';
+    readonly body: FormData;
+    readonly credentials: 'omit';
+    readonly signal?: AbortSignal;
+}) => Promise<{
+    readonly ok: boolean;
+}>;
+interface RnRecordsUploadTransportOptions {
+    /** Test seam: the fetch to use. Defaults to the global `fetch`. A host has no reason to set it. */
+    readonly fetch?: RnRecordsUploadFetch;
+}
+/**
+ * A host-supplied document picker for React Native records upload. Open your own picker (for example
+ * `expo-document-picker`, which the SDK does not depend on) limited to PDF, and resolve:
+ *
+ * - `null` when the user cancels,
+ * - one `FileHandle`, or SEVERAL (a multi-select pick): each with the local `uri`, `mimeType: 'application/pdf'`
+ *   and `sizeBytes`. A batch uploads one file at a time with a live row per file; a non-PDF or oversize file in
+ *   it is skipped with a reason before any request is made (the single-file path refuses it the same way).
+ *   `name` is optional, rendered in the rows locally, and never sent.
+ */
+type RecordsDocumentPicker = () => Promise<FileHandle | readonly FileHandle[] | null>;
+/**
+ * Create the React Native records upload transport. Pass it as `uploadTransport` on the `EverfurConfig`, or
+ * to `<EverfurRecords uploadTransport={...} />`:
+ *
+ * ```tsx
+ * const uploadTransport = createRnRecordsUploadTransport();
+ * <EverfurProvider config={{ publishableKey, apiBaseUrl, uploadTransport }} ...>
+ * ```
+ */
+declare function createRnRecordsUploadTransport(options?: RnRecordsUploadTransportOptions): UploadTransport;
+
+export { type RecordsDocumentPicker as R, type RnRecordsUploadFetch as a, type RnRecordsUploadTransportOptions as b, createRnRecordsUploadTransport as c };

package/dist/useRecordsDepth-C6rjEaLn.d.cts

@@ -0,0 +1,237 @@
+import { R as RecordsRequestId, P as PetRef } from './ids-B2GAAifq.cjs';
+import { a6 as RecordsClinicSearchInput, a7 as RecordsClinicSearchPage, a8 as RecordsRecentClinicsInput, a9 as RecordsAuthorizationCopy, aa as CreateClinicRequestInput, ab as RecordsSignatureUploadPolicy, l as RecordsClinic, P as RecordsClinicBatch, Q as RecordsClinicBatchClient, m as RecordsDepthClient } from './depth-D5HwcvKC.cjs';
+import { c as EverfurResult, E as EverfurError } from './EverfurResult-DN9pL2Ab.cjs';
+import { f as RecordsRequestGroupView, d as RecordsRequestView } from './models-D2EUxPZY.cjs';
+
+interface RecordsClinicController {
+    searchClinics(input?: RecordsClinicSearchInput): Promise<EverfurResult<RecordsClinicSearchPage>>;
+    /** The clinics this member requested from before, most recent first: the picker's "recent" section. */
+    recentClinics(input?: RecordsRecentClinicsInput): Promise<EverfurResult<RecordsClinicSearchPage>>;
+    /** A multi-clinic batch's rollup and members. Not found until Everfur switches the multi-clinic flag on. */
+    getRequestGroup(requestGroupId: string): Promise<EverfurResult<RecordsRequestGroupView>>;
+    getAuthorizationCopy(): Promise<EverfurResult<RecordsAuthorizationCopy>>;
+    createClinicRequest(input: CreateClinicRequestInput): Promise<EverfurResult<RecordsRequestView>>;
+    retryRequest(id: RecordsRequestId): Promise<EverfurResult<RecordsRequestView>>;
+    revokeRequest(id: RecordsRequestId): Promise<EverfurResult<RecordsRequestView>>;
+    updateClinicEmail(id: RecordsRequestId, clinicEmail: string): Promise<EverfurResult<RecordsRequestView>>;
+    convertToUpload(id: RecordsRequestId): Promise<EverfurResult<RecordsRequestView>>;
+    /** Bytes are uploaded by the host directly to the returned multipart policy; never through the API. */
+    initiateSignatureUpload(fileSize: number): Promise<EverfurResult<RecordsSignatureUploadPolicy>>;
+    completeSignatureUpload(uploadId: string): Promise<EverfurResult<string>>;
+}
+
+/** The exact owner-visible scope at the moment the owner chooses to sign. */
+interface RecordsSignatureContext {
+    readonly petRef: PetRef;
+    readonly petName: string;
+    readonly ownerName: string;
+    readonly clinicName: string;
+    readonly authorizationVersion: string;
+    readonly scopeText: string;
+    /** Cancel native capture/upload when the signed-in user or active pet changes. */
+    readonly signal: AbortSignal;
+}
+/**
+ * A captured signature: a registered signature id (the PNG uploaded through the initiate/complete APIs, the
+ * consumer's own path, which keeps the bytes off the JSON body), or a small inline PNG (the built-in React
+ * Native pad's one-bit image, a few hundred bytes, under the platform's non-upload body cap).
+ */
+type CapturedRecordsSignature = {
+    readonly signatureId: string;
+    readonly signaturePngBase64?: never;
+} | {
+    readonly signatureId?: never;
+    readonly signaturePngBase64: string;
+};
+/**
+ * Capture explicitly at the moment the owner presses Send, after seeing the scope, and return the signature.
+ * null means the owner cancelled. Prefer the registered id for anything but a tiny PNG.
+ */
+type CaptureRecordsSignature = (context: RecordsSignatureContext) => Promise<CapturedRecordsSignature | null>;
+interface ClinicRequestBaseProps {
+    readonly petRef: PetRef;
+    /** Display name for this exact registered petRef; the server owns the final PDF identity. */
+    readonly petName: string;
+    /** Initial value only; the owner can visibly confirm or correct it before signing. */
+    readonly ownerName: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    readonly onCreated?: (request: RecordsRequestView) => void;
+    readonly onClose?: () => void;
+    /** Host/test seam over the same signed-user controller contract. */
+    readonly controller?: RecordsClinicController;
+}
+
+/** One composed clinic of the batch (the consumer `ClinicRequestDraft`). */
+interface ClinicDraft {
+    /** Stable local key for list rows and removal. */
+    readonly key: string;
+    /** The directory clinic, or null for an owner-typed clinic name. */
+    readonly clinic: RecordsClinic | null;
+    /** The owner-typed clinic name when `clinic` is null. */
+    readonly freeText: string | null;
+    /** The owner-supplied address, when the clinic needs one. */
+    readonly email: string;
+    /** Minted when the draft is added; a whole-batch retry replays it. */
+    readonly idempotencyKey: string;
+}
+interface ClinicBatchBaseProps {
+    readonly petRef: PetRef;
+    /** Display name for this exact registered petRef; the server owns the final PDF identity. */
+    readonly petName: string;
+    /** Initial value only; the owner can visibly confirm or correct it before signing. */
+    readonly ownerName: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    /** Called once with the batch outcome (created and failed clinics alike). */
+    readonly onCreated?: (batch: RecordsClinicBatch) => void;
+    readonly onClose?: () => void;
+    /** Host/test seams over the same signed-user contracts. */
+    readonly controller?: RecordsClinicController;
+    readonly batchClient?: RecordsClinicBatchClient;
+}
+/**
+ * Turn the pad's inline PNG into a registered signature id, so the batch carries one small id per clinic rather
+ * than one PNG per clinic (the platform caps the inline bytes of a batch at one signature's worth, and the WAF
+ * caps the JSON body). The host supplies the byte transport; the RN and web hosts each have one.
+ */
+type RegisterSignaturePng = (signaturePngBase64: string, signal: AbortSignal) => Promise<{
+    readonly signatureId: string;
+}>;
+
+type RecordsScreen = {
+    readonly name: 'dashboard';
+} | {
+    readonly name: 'request';
+    readonly requestId: RecordsRequestId;
+} | {
+    readonly name: 'timeline';
+} | {
+    readonly name: 'record';
+} | {
+    readonly name: 'document';
+} | {
+    readonly name: 'contributions';
+    readonly docId: string;
+} | {
+    readonly name: 'clinicPicker';
+}
+/**
+ * The multi-clinic composer (`EverfurClinicRequestBatch`). The consumer opens it as a SHEET from the full
+ * record screen's header (RequestFromClinicsAction.tsx); the SDK flow has no sheet layer of its own, so it is
+ * a screen of the same stack, pushed from the same control and popped by the same back.
+ */
+ | {
+    readonly name: 'clinicBatch';
+} | {
+    readonly name: 'consent';
+    readonly clinic: ClinicDraft;
+} | {
+    readonly name: 'upload';
+};
+interface RecordsNavState {
+    readonly stack: readonly RecordsScreen[];
+}
+type RecordsNavAction = {
+    readonly type: 'push';
+    readonly screen: RecordsScreen;
+} | {
+    readonly type: 'pop';
+} | {
+    readonly type: 'replace';
+    readonly screen: RecordsScreen;
+} | {
+    readonly type: 'reset';
+    readonly screen: RecordsScreen;
+}
+/** The screen-declared edge: applies the consumer's push / replace / reset rule for the (from, to) pair. */
+ | {
+    readonly type: 'navigate';
+    readonly screen: RecordsScreen;
+};
+/** A one-screen stack at `initial` (the dashboard when omitted). */
+declare function initialRecordsNav(initial?: RecordsScreen): RecordsNavState;
+/** The screen on top of the stack (a stack is never empty). */
+declare function currentRecordsScreen(state: RecordsNavState): RecordsScreen;
+declare function pushRecordsNav(state: RecordsNavState, screen: RecordsScreen): RecordsNavState;
+declare function replaceRecordsNav(state: RecordsNavState, screen: RecordsScreen): RecordsNavState;
+declare function resetRecordsNav(screen: RecordsScreen): RecordsNavState;
+/**
+ * Pop the top screen. On a one-screen stack the state is returned UNCHANGED with `handled:false`, so the RN
+ * flow's back handler can return `false` and let the host navigator handle the press.
+ */
+declare function popRecordsNav(state: RecordsNavState): {
+    readonly state: RecordsNavState;
+    readonly handled: boolean;
+};
+/**
+ * The consumer's own transition rule for a screen-declared edge:
+ *   - `dashboard` is the root: reaching it resets the stack (consent success `router.replace`s the dashboard,
+ *     a published request pushes it; both end on one dashboard with nothing to pop back into);
+ *   - `upload -> request` replaces (the upload screen's "Done" is a `router.replace`);
+ *   - everything else pushes.
+ */
+declare function transitionRecordsNav(state: RecordsNavState, to: RecordsScreen): RecordsNavState;
+declare function recordsNavReducer(state: RecordsNavState, action: RecordsNavAction): RecordsNavState;
+
+/** The entity a pill refers to: a BE-recognized `type` and `id`, plus compact display facts the host may pass on. */
+interface RecordsAskEntityRef {
+    readonly type: string;
+    readonly id: string;
+    readonly payload?: Readonly<Record<string, string | number | boolean>>;
+}
+interface RecordsAsk {
+    readonly prompt: string;
+    readonly entityRef: RecordsAskEntityRef;
+}
+/** The host seam every Ask pill calls; pills render only when a host supplies it. */
+type RecordsAskHandler = (prompt: string, entityRef: RecordsAskEntityRef) => void;
+
+type ClinicLocation = NonNullable<RecordsClinicSearchInput['location']>;
+
+type RecordsUrlKind = 'share_link' | 'record_pdf';
+interface RecordsHostSeams {
+    /** Open a share link or the record PDF. Default: `Linking.openURL` on React Native, `window.open` on the web. */
+    readonly onOpenUrl?: (url: string, kind: RecordsUrlKind) => void | Promise<void>;
+    /** Copy a share link. Web default: `navigator.clipboard.writeText`; React Native has no default (see above). */
+    readonly onCopy?: (text: string) => Promise<void>;
+    /** The Ask pills' seed prompt and entity, for a host chat. Absent: no Ask pill renders. */
+    readonly onAsk?: RecordsAskHandler;
+    /** Biases the clinic search (the same input the clinic controller takes). */
+    readonly location?: ClinicLocation;
+}
+interface RecordsScreenBaseProps extends RecordsHostSeams {
+    readonly petRef: PetRef;
+    /** The pet's display name for headers and lead copy; absent, the consumer's own `your pet` forms. */
+    readonly petName?: string;
+    /** Called with the exact screen an edge leads to (see `navigation.ts`). Absent, a control that only navigates is hidden, never inert. */
+    readonly onNavigate?: (to: RecordsScreen) => void;
+    /** The header's back control; absent, no back control renders. */
+    readonly onBack?: () => void;
+}
+
+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 { transitionRecordsNav as A, type ClinicDraft as C, type RecordsAskEntityRef as R, type UseRecordsDepthState as U, type ClinicLocation as a, type RecordsAskHandler as b, type RecordsDepthStatus as c, type RecordsHostSeams as d, type RecordsScreen as e, type RecordsScreenBaseProps as f, type RecordsUrlKind as g, useRecordsDepthRead as h, type RecordsClinicController as i, type CaptureRecordsSignature as j, type ClinicRequestBaseProps as k, type ClinicBatchBaseProps as l, type CapturedRecordsSignature as m, type RecordsAsk as n, type RecordsNavAction as o, type RecordsNavState as p, type RecordsSignatureContext as q, type RegisterSignaturePng as r, currentRecordsScreen as s, initialRecordsNav as t, useEverfurRecordsDepthClient as u, popRecordsNav as v, pushRecordsNav as w, recordsNavReducer as x, replaceRecordsNav as y, resetRecordsNav as z };

package/dist/useRecordsDepth-crhBllQK.d.ts

@@ -0,0 +1,237 @@
+import { R as RecordsRequestId, P as PetRef } from './ids-B2GAAifq.js';
+import { a6 as RecordsClinicSearchInput, a7 as RecordsClinicSearchPage, a8 as RecordsRecentClinicsInput, a9 as RecordsAuthorizationCopy, aa as CreateClinicRequestInput, ab as RecordsSignatureUploadPolicy, l as RecordsClinic, P as RecordsClinicBatch, Q as RecordsClinicBatchClient, m as RecordsDepthClient } from './depth-DvPwPuT_.js';
+import { c as EverfurResult, E as EverfurError } from './EverfurResult-DN9pL2Ab.js';
+import { f as RecordsRequestGroupView, d as RecordsRequestView } from './models-B-Uh2LTf.js';
+
+interface RecordsClinicController {
+    searchClinics(input?: RecordsClinicSearchInput): Promise<EverfurResult<RecordsClinicSearchPage>>;
+    /** The clinics this member requested from before, most recent first: the picker's "recent" section. */
+    recentClinics(input?: RecordsRecentClinicsInput): Promise<EverfurResult<RecordsClinicSearchPage>>;
+    /** A multi-clinic batch's rollup and members. Not found until Everfur switches the multi-clinic flag on. */
+    getRequestGroup(requestGroupId: string): Promise<EverfurResult<RecordsRequestGroupView>>;
+    getAuthorizationCopy(): Promise<EverfurResult<RecordsAuthorizationCopy>>;
+    createClinicRequest(input: CreateClinicRequestInput): Promise<EverfurResult<RecordsRequestView>>;
+    retryRequest(id: RecordsRequestId): Promise<EverfurResult<RecordsRequestView>>;
+    revokeRequest(id: RecordsRequestId): Promise<EverfurResult<RecordsRequestView>>;
+    updateClinicEmail(id: RecordsRequestId, clinicEmail: string): Promise<EverfurResult<RecordsRequestView>>;
+    convertToUpload(id: RecordsRequestId): Promise<EverfurResult<RecordsRequestView>>;
+    /** Bytes are uploaded by the host directly to the returned multipart policy; never through the API. */
+    initiateSignatureUpload(fileSize: number): Promise<EverfurResult<RecordsSignatureUploadPolicy>>;
+    completeSignatureUpload(uploadId: string): Promise<EverfurResult<string>>;
+}
+
+/** The exact owner-visible scope at the moment the owner chooses to sign. */
+interface RecordsSignatureContext {
+    readonly petRef: PetRef;
+    readonly petName: string;
+    readonly ownerName: string;
+    readonly clinicName: string;
+    readonly authorizationVersion: string;
+    readonly scopeText: string;
+    /** Cancel native capture/upload when the signed-in user or active pet changes. */
+    readonly signal: AbortSignal;
+}
+/**
+ * A captured signature: a registered signature id (the PNG uploaded through the initiate/complete APIs, the
+ * consumer's own path, which keeps the bytes off the JSON body), or a small inline PNG (the built-in React
+ * Native pad's one-bit image, a few hundred bytes, under the platform's non-upload body cap).
+ */
+type CapturedRecordsSignature = {
+    readonly signatureId: string;
+    readonly signaturePngBase64?: never;
+} | {
+    readonly signatureId?: never;
+    readonly signaturePngBase64: string;
+};
+/**
+ * Capture explicitly at the moment the owner presses Send, after seeing the scope, and return the signature.
+ * null means the owner cancelled. Prefer the registered id for anything but a tiny PNG.
+ */
+type CaptureRecordsSignature = (context: RecordsSignatureContext) => Promise<CapturedRecordsSignature | null>;
+interface ClinicRequestBaseProps {
+    readonly petRef: PetRef;
+    /** Display name for this exact registered petRef; the server owns the final PDF identity. */
+    readonly petName: string;
+    /** Initial value only; the owner can visibly confirm or correct it before signing. */
+    readonly ownerName: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    readonly onCreated?: (request: RecordsRequestView) => void;
+    readonly onClose?: () => void;
+    /** Host/test seam over the same signed-user controller contract. */
+    readonly controller?: RecordsClinicController;
+}
+
+/** One composed clinic of the batch (the consumer `ClinicRequestDraft`). */
+interface ClinicDraft {
+    /** Stable local key for list rows and removal. */
+    readonly key: string;
+    /** The directory clinic, or null for an owner-typed clinic name. */
+    readonly clinic: RecordsClinic | null;
+    /** The owner-typed clinic name when `clinic` is null. */
+    readonly freeText: string | null;
+    /** The owner-supplied address, when the clinic needs one. */
+    readonly email: string;
+    /** Minted when the draft is added; a whole-batch retry replays it. */
+    readonly idempotencyKey: string;
+}
+interface ClinicBatchBaseProps {
+    readonly petRef: PetRef;
+    /** Display name for this exact registered petRef; the server owns the final PDF identity. */
+    readonly petName: string;
+    /** Initial value only; the owner can visibly confirm or correct it before signing. */
+    readonly ownerName: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    /** Called once with the batch outcome (created and failed clinics alike). */
+    readonly onCreated?: (batch: RecordsClinicBatch) => void;
+    readonly onClose?: () => void;
+    /** Host/test seams over the same signed-user contracts. */
+    readonly controller?: RecordsClinicController;
+    readonly batchClient?: RecordsClinicBatchClient;
+}
+/**
+ * Turn the pad's inline PNG into a registered signature id, so the batch carries one small id per clinic rather
+ * than one PNG per clinic (the platform caps the inline bytes of a batch at one signature's worth, and the WAF
+ * caps the JSON body). The host supplies the byte transport; the RN and web hosts each have one.
+ */
+type RegisterSignaturePng = (signaturePngBase64: string, signal: AbortSignal) => Promise<{
+    readonly signatureId: string;
+}>;
+
+type RecordsScreen = {
+    readonly name: 'dashboard';
+} | {
+    readonly name: 'request';
+    readonly requestId: RecordsRequestId;
+} | {
+    readonly name: 'timeline';
+} | {
+    readonly name: 'record';
+} | {
+    readonly name: 'document';
+} | {
+    readonly name: 'contributions';
+    readonly docId: string;
+} | {
+    readonly name: 'clinicPicker';
+}
+/**
+ * The multi-clinic composer (`EverfurClinicRequestBatch`). The consumer opens it as a SHEET from the full
+ * record screen's header (RequestFromClinicsAction.tsx); the SDK flow has no sheet layer of its own, so it is
+ * a screen of the same stack, pushed from the same control and popped by the same back.
+ */
+ | {
+    readonly name: 'clinicBatch';
+} | {
+    readonly name: 'consent';
+    readonly clinic: ClinicDraft;
+} | {
+    readonly name: 'upload';
+};
+interface RecordsNavState {
+    readonly stack: readonly RecordsScreen[];
+}
+type RecordsNavAction = {
+    readonly type: 'push';
+    readonly screen: RecordsScreen;
+} | {
+    readonly type: 'pop';
+} | {
+    readonly type: 'replace';
+    readonly screen: RecordsScreen;
+} | {
+    readonly type: 'reset';
+    readonly screen: RecordsScreen;
+}
+/** The screen-declared edge: applies the consumer's push / replace / reset rule for the (from, to) pair. */
+ | {
+    readonly type: 'navigate';
+    readonly screen: RecordsScreen;
+};
+/** A one-screen stack at `initial` (the dashboard when omitted). */
+declare function initialRecordsNav(initial?: RecordsScreen): RecordsNavState;
+/** The screen on top of the stack (a stack is never empty). */
+declare function currentRecordsScreen(state: RecordsNavState): RecordsScreen;
+declare function pushRecordsNav(state: RecordsNavState, screen: RecordsScreen): RecordsNavState;
+declare function replaceRecordsNav(state: RecordsNavState, screen: RecordsScreen): RecordsNavState;
+declare function resetRecordsNav(screen: RecordsScreen): RecordsNavState;
+/**
+ * Pop the top screen. On a one-screen stack the state is returned UNCHANGED with `handled:false`, so the RN
+ * flow's back handler can return `false` and let the host navigator handle the press.
+ */
+declare function popRecordsNav(state: RecordsNavState): {
+    readonly state: RecordsNavState;
+    readonly handled: boolean;
+};
+/**
+ * The consumer's own transition rule for a screen-declared edge:
+ *   - `dashboard` is the root: reaching it resets the stack (consent success `router.replace`s the dashboard,
+ *     a published request pushes it; both end on one dashboard with nothing to pop back into);
+ *   - `upload -> request` replaces (the upload screen's "Done" is a `router.replace`);
+ *   - everything else pushes.
+ */
+declare function transitionRecordsNav(state: RecordsNavState, to: RecordsScreen): RecordsNavState;
+declare function recordsNavReducer(state: RecordsNavState, action: RecordsNavAction): RecordsNavState;
+
+/** The entity a pill refers to: a BE-recognized `type` and `id`, plus compact display facts the host may pass on. */
+interface RecordsAskEntityRef {
+    readonly type: string;
+    readonly id: string;
+    readonly payload?: Readonly<Record<string, string | number | boolean>>;
+}
+interface RecordsAsk {
+    readonly prompt: string;
+    readonly entityRef: RecordsAskEntityRef;
+}
+/** The host seam every Ask pill calls; pills render only when a host supplies it. */
+type RecordsAskHandler = (prompt: string, entityRef: RecordsAskEntityRef) => void;
+
+type ClinicLocation = NonNullable<RecordsClinicSearchInput['location']>;
+
+type RecordsUrlKind = 'share_link' | 'record_pdf';
+interface RecordsHostSeams {
+    /** Open a share link or the record PDF. Default: `Linking.openURL` on React Native, `window.open` on the web. */
+    readonly onOpenUrl?: (url: string, kind: RecordsUrlKind) => void | Promise<void>;
+    /** Copy a share link. Web default: `navigator.clipboard.writeText`; React Native has no default (see above). */
+    readonly onCopy?: (text: string) => Promise<void>;
+    /** The Ask pills' seed prompt and entity, for a host chat. Absent: no Ask pill renders. */
+    readonly onAsk?: RecordsAskHandler;
+    /** Biases the clinic search (the same input the clinic controller takes). */
+    readonly location?: ClinicLocation;
+}
+interface RecordsScreenBaseProps extends RecordsHostSeams {
+    readonly petRef: PetRef;
+    /** The pet's display name for headers and lead copy; absent, the consumer's own `your pet` forms. */
+    readonly petName?: string;
+    /** Called with the exact screen an edge leads to (see `navigation.ts`). Absent, a control that only navigates is hidden, never inert. */
+    readonly onNavigate?: (to: RecordsScreen) => void;
+    /** The header's back control; absent, no back control renders. */
+    readonly onBack?: () => void;
+}
+
+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 { transitionRecordsNav as A, type ClinicDraft as C, type RecordsAskEntityRef as R, type UseRecordsDepthState as U, type ClinicLocation as a, type RecordsAskHandler as b, type RecordsDepthStatus as c, type RecordsHostSeams as d, type RecordsScreen as e, type RecordsScreenBaseProps as f, type RecordsUrlKind as g, useRecordsDepthRead as h, type RecordsClinicController as i, type CaptureRecordsSignature as j, type ClinicRequestBaseProps as k, type ClinicBatchBaseProps as l, type CapturedRecordsSignature as m, type RecordsAsk as n, type RecordsNavAction as o, type RecordsNavState as p, type RecordsSignatureContext as q, type RegisterSignaturePng as r, currentRecordsScreen as s, initialRecordsNav as t, useEverfurRecordsDepthClient as u, popRecordsNav as v, pushRecordsNav as w, recordsNavReducer as x, replaceRecordsNav as y, resetRecordsNav as z };