@everfur/sdk 0.1.1 → 0.4.0

package/dist/web/televet/booking/index.d.ts

@@ -0,0 +1,349 @@
+import { ReactNode, CSSProperties } from 'react';
+import { P as PetRef } from '../../../ids-B2GAAifq.js';
+export { B as Brand, _ as __brand } from '../../../ids-B2GAAifq.js';
+import { T as TelevetConsult, a as TelevetBookingStep, b as TelevetBookingController, c as TelevetSlot } from '../../../bookingCopy-CqtDYvCR.js';
+export { C as CANCELLATION_POLICY_VERSION_MAX, d as CONSULT_KINDS, e as CONSULT_MINUTES, f as CONSULT_STATUSES, g as ConsultKind, h as ConsultStatus, M as MEDIA_REFS_MAX, R as REASON_TEXT_MAX, i as TELEVET_BOOKING_BASE, j as TELEVET_BOOKING_COPY, k as TELEVET_BOOKING_STEPS, l as TERMINAL_CONSULT_STATUSES, m as TelevetBookingAction, n as TelevetBookingBody, o as TelevetBookingContext, p as TelevetBookingControllerDeps, q as TelevetBookingCopy, r as TelevetBookingDraft, s as TelevetBookingEntitlement, t as TelevetBookingRefusal, u as TelevetBookingState, v as TelevetCancellationPolicy, w as TelevetClinician, x as TelevetRead, y as TelevetSlotHold, z as TelevetStatePolicy, A as TelevetWrite, B as attestation, D as canConfirm, E as createTelevetBookingController, F as currentStep, G as emptyTelevetDraft, H as formatVisitRange, I as formatWhen, J as formatWhenWithDay, K as hasPreviousStep, L as initialTelevetBookingState, N as isHoldExpired, O as isSkipped, P as isTelevetBookingCopyReady, Q as isWellFormedStateCode, S as televetBookingKey, U as televetBookingReducer, V as televetBookingRefusal, W as televetHoldCall, X as televetRescheduleCall, Y as useTelevetBookConsult, Z as useTelevetBookingAvailable, _ as useTelevetBookingController, $ as useTelevetBookingEntitlement, a0 as useTelevetCancellationPolicy, a1 as useTelevetClinicians, a2 as useTelevetHoldSlot, a3 as useTelevetNextSlot, a4 as useTelevetRescheduleConsult, a5 as useTelevetSlots, a6 as useTelevetStatePolicy, a7 as validateBookingBody } from '../../../bookingCopy-CqtDYvCR.js';
+export { E as EverfurError, a as EverfurErrorCategory, b as EverfurErrorCode, c as EverfurResult } from '../../../EverfurResult-DN9pL2Ab.js';
+export { W as WidgetPet } from '../../../petsRepository-Bk6GDwLs.js';
+import '../../../requestFunnel-DFMGcluw.js';
+import '../../../ErrorPolicyPort-CwbfmxzJ.js';
+import '../../../config-C7eb_IMD.js';
+import '../../../identity-CEi9GRFZ.js';
+import '../../../TelemetryPort-BDNr00hu.js';
+import '../../../profile-CSs1wlXT.js';
+
+/** The calendar entry a booked visit asks the host to write. */
+interface TelevetCalendarEvent {
+    /**
+     * A stable key for THIS consult's entry.
+     *
+     * Keyed on the CONSULT so a re-press updates the same entry rather than writing a second event for one
+     * visit, and so a later cancel or reschedule can address the SAME row. A host that ignores the key writes
+     * duplicates the owner has to clean up by hand.
+     */
+    readonly key: string;
+    readonly title: string;
+    readonly startDate: Date;
+    readonly endDate: Date;
+    /** The reminder offset in minutes, negative for "before". The platform queues its own at the same offset. */
+    readonly alarmOffsetMinutes: number;
+}
+/** Writes the entry. Resolves true when it landed; false when the host has no calendar to write to. */
+type TelevetCalendarWriter = (event: TelevetCalendarEvent) => Promise<boolean>;
+/** The calendar key for a consult. One definition, so a cancel and a reschedule address the booked row. */
+declare function televetConsultCalendarKey(consultId: string): string;
+interface TelevetBookedScreenProps {
+    readonly consult: TelevetConsult;
+    readonly petName: string | null;
+    readonly onDone: () => void;
+    /** Absent, there is no Add to calendar control. */
+    readonly onAddToCalendar?: TelevetCalendarWriter | undefined;
+    /**
+     * Has the host PROVEN it can host the call in place? Defaults to false.
+     *
+     * Fail closed: a host that has not said so is assumed not to have mounted the call surface, and the in-place
+     * join promise is withheld rather than printed on a hope.
+     */
+    readonly canJoinInApp?: boolean;
+}
+declare function TelevetBookedScreen({ consult, petName, onDone, onAddToCalendar, canJoinInApp, }: TelevetBookedScreenProps): ReactNode;
+
+/** The heading levels the DOM has elements for. */
+type EverfurHeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+
+/**
+ * The host's own discard confirmation.
+ *
+ * Receives the ported title, body and the two button labels, and resolves true to leave. A partner with its
+ * own dialog system passes this; absent, the SDK renders the in-page dialog below.
+ */
+type TelevetDiscardConfirm = (prompt: {
+    readonly title: string;
+    readonly body: string;
+    readonly confirmLabel: string;
+    readonly keepLabel: string;
+}) => Promise<boolean>;
+interface TelevetBookingChromeProps {
+    readonly step: TelevetBookingStep;
+    readonly furthestIndex: number;
+    /** The title on the bar. The reschedule flow passes its own, so the bar never says "Book a visit" there. */
+    readonly title?: string;
+    /** False on the first visible step, where Back would leave the flow entirely. */
+    readonly canGoBack: boolean;
+    /**
+     * Has the owner entered anything worth losing?
+     *
+     * Gates the discard confirm AND the `beforeunload` backstop. A confirm on an untouched flow is a pointless
+     * obstacle; NO confirm on a flow holding typed clinical text is the actual defect, because that text is
+     * volatile component state with no draft to restore it from.
+     */
+    readonly isDirty: boolean;
+    readonly onBack: () => void;
+    readonly onClose: () => void;
+    readonly onConfirmDiscard?: TelevetDiscardConfirm | undefined;
+    /**
+     * The heading level of the bar's title. Defaults to 2, the level an embedded surface may safely claim.
+     *
+     * Pass 1 only when the flow IS the page in your app. See `src/web/headingLevel.ts`.
+     */
+    readonly headingLevel?: EverfurHeadingLevel | undefined;
+}
+declare function TelevetBookingChrome({ step, furthestIndex, title, canGoBack, isDirty, onBack, onClose, onConfirmDiscard, headingLevel: level, }: TelevetBookingChromeProps): ReactNode;
+/**
+ * The back control's spoken label.
+ *
+ * "Back" is the platform word for the control and is not product copy, which is why it is a constant here and
+ * not a key in the ported deck. The web records port declares the same constant for the same reason.
+ */
+declare const BACK_LABEL = "Back";
+
+/** A picked-but-not-yet-uploaded attachment, in the host's own terms. */
+interface TelevetIntakeMediaItem {
+    readonly uri: string;
+    readonly filename: string;
+    readonly mimeType: string;
+    readonly fileSize: number;
+}
+/**
+ * The host's media picker.
+ *
+ * Resolves the picks, or null when the owner cancelled. The SDK takes no picker dependency and opens no file
+ * dialog of its own; a partner supplies whichever picker its site already has, typically an `<input
+ * type="file">` whose `File` objects it turns into object URLs.
+ *
+ * `limit` is the remaining headroom, so the host can cap its own selection rather than returning picks this
+ * row has to silently discard.
+ */
+type TelevetMediaPicker = (limit: number) => Promise<readonly TelevetIntakeMediaItem[] | null>;
+interface TelevetIntakeMediaProps {
+    readonly media: readonly TelevetIntakeMediaItem[];
+    readonly onChange: (next: readonly TelevetIntakeMediaItem[]) => void;
+    /** Absent, the row renders nothing at all. There is no disabled Add control. */
+    readonly onPickMedia?: TelevetMediaPicker | undefined;
+    /**
+     * The list's accessible name.
+     *
+     * Required, with no default string here: naming the group is what makes the tiles announce as a set, and
+     * the name is user-facing copy this SDK does not author. The intake step passes a ported key down.
+     */
+    readonly listLabel: string;
+}
+declare function TelevetIntakeMedia({ media, onChange, onPickMedia, listLabel }: TelevetIntakeMediaProps): ReactNode;
+
+/**
+ * Why a booking did not complete.
+ *
+ * `not_entitled` is separated from `failed` because the two need opposite affordances: a transient failure
+ * invites a retry, and a 402 must not. `unavailable` is separated from both because no retry can succeed.
+ */
+type TelevetBookingFailure = 'taken' | 'expired' | 'failed' | 'not_entitled'
+/** The remedy is a DIFFERENT VET, not a different time: re-picking a slot with the same clinician refuses again. */
+ | 'clinician_unavailable'
+/** Per-owner caps. The remedy is WAITING, so this must never render as an invitation to press again. */
+ | 'rate_limited'
+/** The partner booking surface is not served here. The remedy is the hosted visit, not a retry. */
+ | 'unavailable' | null;
+/** What the host can tell us about a location it could not resolve, so the right card renders. */
+type TelevetLocationStatus = 'unknown' | 'blocked' | 'unavailable';
+interface EverfurTelevetBookingProps {
+    /** The pet the visit is for. Seeds the draft; a one-pet roster skips the picker entirely. */
+    readonly petRef?: PetRef | null;
+    /** The owner's two-letter US state. The SDK never reads a browser location for it. */
+    readonly usState?: string | null;
+    /** Host/test seam: inject a booking controller instead of building one from the provider's session. */
+    readonly controller?: TelevetBookingController;
+    readonly onBooked?: (consult: TelevetConsult) => void;
+    /** Leaves the flow. The flow never navigates itself, so the same screens work in a modal, a tab or a route. */
+    readonly onExit?: () => void;
+    /** Leaves the flow to create a pet, then comes back. Absent, the empty roster has no action. */
+    readonly onAddPet?: () => void;
+    /** The host's media picker for the intake step. Absent, there is no attachment row. */
+    readonly onPickMedia?: TelevetMediaPicker;
+    /** The host's calendar writer for the confirmation. Absent, there is no Add to calendar control. */
+    readonly onAddToCalendar?: TelevetCalendarWriter;
+    /** The host's own discard dialog. Absent, the SDK renders its own `<dialog>`. */
+    readonly onConfirmDiscard?: TelevetDiscardConfirm;
+    /** Asks the host to resolve the owner's state again. Absent, the location cards render without an action. */
+    readonly onRequestLocation?: () => void;
+    /** Why the host has no state for us, so the right card renders. */
+    readonly locationStatus?: TelevetLocationStatus;
+    /**
+     * Has the host PROVEN it can host the call in place? Defaults to false.
+     *
+     * Fail closed: without the call surface mounted the confirmation must not promise an in-place join.
+     */
+    readonly canJoinInApp?: boolean;
+    /**
+     * What to render when the partner booking surface is not served for this tenant.
+     *
+     * THE FLOW WILL NOT DEAD-END. Absent this, an unserved surface renders the paused card, which is a state but
+     * not a way forward; the prebuilt flow passes the hosted-visit handoff here so the owner still reaches a vet.
+     */
+    readonly renderUnavailable?: () => ReactNode;
+    /**
+     * The heading level this flow's title claims. Defaults to 2.
+     *
+     * A DROP-IN WIDGET DOES NOT OWN YOUR PAGE'S `<h1>`, so the default is 2 and every heading inside the flow
+     * sits one level below it. Pass 1 when the flow IS the page in your app. See `src/web/headingLevel.ts` for
+     * the full reasoning and for why the default falls on the safe side rather than on the tidier one.
+     */
+    readonly headingLevel?: number;
+    readonly style?: CSSProperties;
+    readonly testID?: string;
+}
+declare function EverfurTelevetBooking(props: EverfurTelevetBookingProps): ReactNode;
+
+/** The screens of the televet stack. */
+type TelevetScreen = {
+    readonly name: 'booking';
+} | {
+    readonly name: 'reschedule';
+    readonly consult: TelevetConsult;
+};
+/** How the flow's own stack relates to the browser's history. */
+type TelevetHistoryMode = 'memory' | 'browser';
+interface EverfurTelevetProps {
+    /** The pet the visit is for. Seeds the draft; a one-pet roster skips the picker entirely. */
+    readonly petRef?: PetRef | null;
+    /** The owner's two-letter US state. The SDK never reads a browser location for it. */
+    readonly usState?: string | null;
+    /** Host/test seam: inject a booking controller instead of building one from the provider's session. */
+    readonly controller?: TelevetBookingController;
+    readonly onBooked?: (consult: TelevetConsult) => void;
+    /** The root screen's exit; absent, the root's Close does nothing and the host owns leaving. */
+    readonly onExit?: () => void;
+    readonly onAddPet?: () => void;
+    readonly onPickMedia?: TelevetMediaPicker;
+    readonly onAddToCalendar?: TelevetCalendarWriter;
+    readonly onConfirmDiscard?: TelevetDiscardConfirm;
+    readonly onRequestLocation?: () => void;
+    readonly locationStatus?: TelevetLocationStatus;
+    /**
+     * How the flow's stack relates to the browser's history. `memory` by default, which never touches
+     * `history`: a widget embedded in someone else's page must not take over their back button.
+     */
+    readonly historyMode?: TelevetHistoryMode;
+    /**
+     * Has the host mounted the call surface (`@everfur/sdk/web/televet/call`)? Defaults to FALSE.
+     *
+     * Fail closed. A partner that has not said so gets a confirmation that promises only what it can keep.
+     */
+    readonly canJoinInApp?: boolean;
+    /**
+     * Replace the hosted-visit fallback shown when the in-page booking surface is not served.
+     *
+     * The default is the published `VetVisitButton`, which mints the single-use handoff and opens the hosted
+     * Everfur visit. Passing `null` here is not a way to remove it: a flow with no fallback dead-ends, so an
+     * explicit render prop is the only way to change it.
+     */
+    readonly renderUnavailable?: () => ReactNode;
+    /** The screen the flow starts on; the booking flow when omitted. */
+    readonly initialScreen?: TelevetScreen;
+    /**
+     * The heading level this flow's title claims. Defaults to 2.
+     *
+     * A DROP-IN WIDGET DOES NOT OWN YOUR PAGE'S `<h1>`. Pass 1 only when the flow IS the page in your app; every
+     * heading inside the flow then follows one level below. See `src/web/headingLevel.ts`.
+     */
+    readonly headingLevel?: number;
+    readonly style?: CSSProperties;
+    /** Your own placeholder while the entitlement verdict is pending on a cold mount. */
+    readonly renderPending?: () => ReactNode;
+    /** A class the host may hang its own layout rules on; the SDK sets no classes of its own. */
+    readonly className?: string;
+}
+declare function EverfurTelevetFlow(props: EverfurTelevetProps): ReactNode;
+/** The public prebuilt televet surface: the flow, starting at booking. */
+declare const EverfurTelevet: typeof EverfurTelevetFlow;
+
+interface EverfurTelevetRescheduleProps {
+    /** The consult being moved. Null while the host is still loading it. */
+    readonly consult: TelevetConsult | null;
+    readonly onRescheduled?: (moved: TelevetConsult) => void;
+    /** Backing out. Never destructive: the original consult is left exactly as it was. */
+    readonly onCancel?: () => void;
+    /** Host/test seam: inject a booking controller instead of building one from the provider's session. */
+    readonly controller?: TelevetBookingController;
+    readonly style?: CSSProperties;
+    readonly testID?: string;
+}
+declare function EverfurTelevetReschedule(props: EverfurTelevetRescheduleProps): ReactNode;
+
+interface TelevetDay {
+    readonly key: string;
+    readonly iso: string;
+    readonly weekday: string;
+    readonly dayNumber: string;
+}
+interface TelevetDayStripProps {
+    readonly slots: readonly TelevetSlot[];
+    readonly selectedDayKey: string | null;
+    readonly onSelectDay: (day: TelevetDay) => void;
+    /**
+     * The group's accessible name.
+     *
+     * A PROP WITH NO DEFAULT STRING IN THIS FILE. Naming the group is required for the radiogroup to be
+     * announced usefully, and the name is user-facing copy, which this SDK does not author. The slot picker
+     * passes the ported deck's own heading down.
+     */
+    readonly groupLabel: string;
+}
+/** The day strip. Renders nothing when the window holds no readable day. */
+declare function TelevetDayStrip({ slots, selectedDayKey, onSelectDay, groupLabel }: TelevetDayStripProps): ReactNode;
+/**
+ * The distinct local days the slots cover, in server order.
+ *
+ * Exported for the picker, which needs the first day to seed the selection, and for the suite. Identical to
+ * the RN implementation: this is pure data and the port changes nothing about it.
+ */
+declare function televetDaysFromSlots(slots: readonly TelevetSlot[]): readonly TelevetDay[];
+
+interface TelevetSlotPickerProps {
+    /** The server's full window. Never truncated: the day filter is what bounds it. */
+    readonly slots: readonly TelevetSlot[];
+    /** The slot whose hold is in flight, or null. Disables the whole grid. */
+    readonly busySlotId: string | null;
+    readonly onPick: (slot: TelevetSlot) => void;
+    /** Rendered above the strip, for example a failure line from the container. */
+    readonly header?: ReactNode;
+    /**
+     * The accessible name for the day strip and the time grid.
+     *
+     * Required, with no default written here: it is user-facing copy and this SDK authors none. The containers
+     * pass the ported deck's own headings down.
+     */
+    readonly dayGroupLabel: string;
+    readonly timeGroupLabel: string;
+    readonly rowTestIdPrefix?: string;
+    readonly testID?: string;
+}
+declare function TelevetSlotPicker({ slots, busySlotId, onPick, header, dayGroupLabel, timeGroupLabel, rowTestIdPrefix, testID, }: TelevetSlotPickerProps): ReactNode;
+
+/** One "label ... value" row in the summary card, as a bound `<dt>` / `<dd>` pair. */
+declare function TelevetSummaryRow({ label, value, last, testID, }: {
+    readonly label: string;
+    readonly value: string;
+    /** The last row draws no divider, so the card does not end on a line. */
+    readonly last?: boolean;
+    readonly testID?: string;
+}): ReactNode;
+/**
+ * A consent tick.
+ *
+ * A REAL CHECKBOX. `accessibilityRole="checkbox"` with a `checked` state is what makes a screen reader announce
+ * it as an agreement rather than a button; in the DOM the element itself does that, and also brings focus,
+ * Space-to-toggle and the label-wraps-input behaviour for free.
+ */
+declare function TelevetConsentCheckbox({ label, checked, onToggle, testID, }: {
+    readonly label: string;
+    readonly checked: boolean;
+    readonly onToggle: (next: boolean) => void;
+    readonly testID?: string;
+}): ReactNode;
+/** The summary card's own frame, exported so the container does not re-declare it. */
+declare function TelevetSummaryCard({ children, testID }: {
+    readonly children: ReactNode;
+    readonly testID?: string;
+}): ReactNode;
+
+export { BACK_LABEL, type EverfurHeadingLevel, EverfurTelevet, EverfurTelevetBooking, type EverfurTelevetBookingProps, EverfurTelevetFlow, type EverfurTelevetProps, EverfurTelevetReschedule, type EverfurTelevetRescheduleProps, PetRef, TelevetBookedScreen, type TelevetBookedScreenProps, TelevetBookingChrome, type TelevetBookingChromeProps, TelevetBookingController, type TelevetBookingFailure, TelevetBookingStep, type TelevetCalendarEvent, type TelevetCalendarWriter, TelevetConsentCheckbox, TelevetConsult, type TelevetDay, TelevetDayStrip, type TelevetDayStripProps, type TelevetDiscardConfirm, type TelevetHistoryMode, TelevetIntakeMedia, type TelevetIntakeMediaItem, type TelevetIntakeMediaProps, type TelevetLocationStatus, type TelevetMediaPicker, type TelevetScreen, TelevetSlot, TelevetSlotPicker, type TelevetSlotPickerProps, TelevetSummaryCard, TelevetSummaryRow, televetConsultCalendarKey, televetDaysFromSlots };