@everfur/sdk 0.13.0 → 0.15.0

package/dist/tabs/index.d.cts

@@ -0,0 +1,175 @@
+import { EverfurChatProps } from '@everfur/sdk/chat';
+import { EverfurHealthPlanProps } from '@everfur/sdk/health-plan';
+import { EverfurRecordsProps } from '@everfur/sdk/records';
+import { ReactNode } from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+import { P as PetRef } from '../ids.d-B2GAAifq.cjs';
+import { E as EverfurStarterPrompt } from '../quickPrompts.d-NM_81Jc1.cjs';
+import { E as EverfurIntroCopy, a as EverfurIntroBlank, b as EverfurRecordsRequested, d as EverfurRecordsLanded, I as IntroText } from '../introEvents.d-fAZitxMA.cjs';
+export { c as EVERFUR_INTRO_COPY, e as IntroFacts, f as IntroPetWords, g as IntroTextInput, h as defaultIntroBlanks, i as introFacts, j as introPetWords, k as introText, n as numberWord } from '../introEvents.d-fAZitxMA.cjs';
+import { C as CaptureRecordsSignature } from '../clinicRequestProps.d-1dCtouGA.cjs';
+import { T as TabsOpenedLike, E as EverfurTabsCopy, a as EverfurTabId } from '../tabsModel.d-BfIQg6yS.cjs';
+export { b as EVERFUR_TABS_COPY } from '../tabsModel.d-BfIQg6yS.cjs';
+import { H as HealthPlanPage } from '../focus.d-Dsm39DjO.cjs';
+import { E as EverfurIntroMode, a as EverfurIntroFrame, b as EverfurIntroClose, c as EverfurIntroTabLabels } from '../useIntroSeen.d-CTWFUthO.cjs';
+export { d as EverfurIntroExit, e as EverfurIntroSeen, i as isIntroSwipeOut, u as useEverfurIntroSeen } from '../useIntroSeen.d-CTWFUthO.cjs';
+import '../EverfurResult.d-BFH-3s6E.cjs';
+import '../EverfurError.d-8NHtlgzA.cjs';
+import '../clinicModels.d-BXgKZqDb.cjs';
+import '../models.d-BSqvbTE1.cjs';
+import '../requestFunnel.d-CR4akGCY.cjs';
+import '../ErrorPolicyPort.d-DirW9hgO.cjs';
+import '../config.d-C0WgjutL.cjs';
+import '../identity.d-CioQhZrq.cjs';
+
+/**
+ * How the member got here, said by the host (explicit, owner decision (a)): a plain open from your app's own tab bar,
+ * or a deep link (a push, a text, a "See her plan" button) that names a tab and maybe a question for the chat. Change
+ * `key` for each new open, so the same link twice is two opens.
+ */
+type EverfurTabsOpened = TabsOpenedLike;
+/** EverfurChat's own props, passed through; the shell sets the pet, the question a link carries and the plan door. */
+type EverfurTabsChatProps = Omit<EverfurChatProps, 'petRef' | 'initialAsk' | 'initialAskKey' | 'onOpenHealthPlan'>;
+/** EverfurHealthPlan's own props, passed through; the shell sets the pet and remounts it on a changed plan. */
+type EverfurTabsPlanProps = Omit<EverfurHealthPlanProps, 'petRef'>;
+/** EverfurRecords' own props, passed through; the shell sets the pet, its name, Ask and the plan door. */
+type EverfurTabsRecordsProps = Omit<EverfurRecordsProps, 'petRef' | 'petName'>;
+/** The intro's options (`EverfurTabs intro=`). Every one is optional; `intro={false}` never plays it. */
+interface EverfurTabsIntro {
+    /** Your own words in the intro (each defaults to empty, and an empty line is not drawn). */
+    readonly copy?: Partial<EverfurIntroCopy>;
+    /** The plan's blanks the records ask shows. Absent: the pet's weight and next shots. */
+    readonly blanks?: readonly EverfurIntroBlank[];
+    /** Sent's "Turn on notifications": your app's permission ask; resolve true once on. Absent: Everfur's preferences. */
+    readonly onEnableNotifications?: () => boolean | Promise<boolean>;
+    /** The clinic frame's "Upload a PDF or a photo instead", run once the intro closes. Absent: the Records tab opens. */
+    readonly onUpload?: () => void;
+    /** The consent step's owner name, and your own signature capture. */
+    readonly ownerName?: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    /** The records-landed banner's app tile (your app's mark). */
+    readonly bannerIcon?: ReactNode;
+    /** The intro plays only while the window is narrower than this (Raph's intro is the phone's). Default 600. */
+    readonly maxWidth?: number;
+}
+interface EverfurTabsProps {
+    /** The pet the three tabs are about. Null: no pet yet (the chat starts unscoped, the plan and records wait). */
+    readonly petRef: PetRef | null;
+    /** The pet's name, for Records and the intro until the plan page names it. */
+    readonly petName?: string | null;
+    /**
+     * How the member got here (explicit): `{ via: 'plain' }` from your app's own tab bar, `{ via: 'link', tab }` from a
+     * push, a text or a "See her plan" button. A new `key` is a new open. A plain open lands on Health Plan and may play
+     * the intro; a link opens where it points, and the intro waits for the next plain open.
+     */
+    readonly opened: EverfurTabsOpened;
+    /** Whether the shell is on screen (your app's own tab is this one). Default true. */
+    readonly visible?: boolean;
+    readonly copy?: Partial<EverfurTabsCopy>;
+    readonly chat?: EverfurTabsChatProps;
+    readonly plan?: EverfurTabsPlanProps;
+    readonly records?: EverfurTabsRecordsProps;
+    /** Your content around the records screen (your own top section over it). Absent: the screen alone. */
+    readonly renderRecords?: (page: ReactNode) => ReactNode;
+    /** Your content under a pane (a composer), drawn inside the pane after the SDK's surface. */
+    readonly paneFooter?: Partial<Record<EverfurTabId, ReactNode>>;
+    /**
+     * The pet's results are not back yet: Ask draws no focus card and no pill and offers `pendingStarterPrompts`, and
+     * the intro uses its waiting lines. Absent: read from the pet's Health Plan page (its waiting card, `wait`); set it
+     * to override that.
+     */
+    readonly resultsPending?: boolean;
+    /** Ask's starters while the results are not back (your words). */
+    readonly pendingStarterPrompts?: readonly EverfurStarterPrompt[];
+    /** The first-open intro. Default on (it plays once per member); false never plays it. */
+    readonly intro?: EverfurTabsIntro | false;
+    readonly onTabChange?: (tab: EverfurTabId) => void;
+    readonly onRecordsRequested?: (event: EverfurRecordsRequested) => void;
+    readonly onRecordsLanded?: (event: EverfurRecordsLanded) => void;
+    /** Your own toast. Absent: Raph's, drawn over the tab bar. */
+    readonly onToast?: (message: string) => void;
+    /**
+     * A ref the shell fills with its handle (open a tab, ask, request records), for your callbacks that live outside its
+     * content. Content inside the shell reads it with useEverfurTabs().
+     */
+    readonly tabsRef?: {
+        current: EverfurTabsHandle | null;
+    };
+    readonly style?: StyleProp<ViewStyle>;
+    readonly testID?: string;
+}
+/** What the content inside the shell can do: open a tab, ask in the chat, open the records request sheet. */
+interface EverfurTabsHandle {
+    readonly tab: EverfurTabId;
+    open(tab: EverfurTabId): void;
+    /** Opens Ask with a question in a fresh chat. An empty question only opens Ask. */
+    ask(prompt: string): void;
+    /** Raph's records request sheet (his 2a and 2b): her clinic, the consent, Sent. Backing out stays where you are. */
+    requestRecords(): void;
+}
+/** The shell around you, inside EverfurTabs (a pane footer, your records section); null outside it. */
+declare function useEverfurTabs(): EverfurTabsHandle | null;
+declare function EverfurTabs(props: EverfurTabsProps): ReactNode;
+
+/** Where the tab bar sits in the window (`measureInWindow`), so frame 1's dims leave it clear. */
+interface EverfurIntroTabBar {
+    readonly top: number;
+    readonly height: number;
+}
+interface EverfurIntroProps {
+    readonly petRef: PetRef;
+    /** Defaults to 'intro'. */
+    readonly mode?: EverfurIntroMode;
+    /**
+     * The pet's Health Plan page: the pet's name and sex (her pronoun), the plan's title (the blanks card's header),
+     * its tips, and its vet byline. Null or absent: `petName` and the lines that need the page are not drawn.
+     */
+    readonly page?: HealthPlanPage | null;
+    readonly petName?: string | null;
+    /** The pet's vet records are already in: frame 1 only, and its button reads "See her plan". */
+    readonly recordsConnected?: boolean;
+    /** The pet's results are not back yet: frame 1's waiting lines. */
+    readonly resultsPending?: boolean;
+    /** Your own words (each defaults to empty, and an empty line is not drawn). */
+    readonly copy?: Partial<EverfurIntroCopy>;
+    /** The plan's blanks, in order. Absent: the pet's weight and next shots. */
+    readonly blanks?: readonly EverfurIntroBlank[];
+    /** The tab bar frame 1 lights, in window coordinates. Absent: his own (140 from the top, 46 tall). */
+    readonly tabBar?: EverfurIntroTabBar | null;
+    /** The frame shown, and null once closed: frame 1 lights the tab bar ('tabs'). */
+    readonly onFrame?: (frame: EverfurIntroFrame | null) => void;
+    /** The member closed it (the sheet is still going down). */
+    readonly onClose: (close: EverfurIntroClose) => void;
+    /** The sheet is down: unmount it. */
+    readonly onClosed?: () => void;
+    readonly onRequested?: (event: EverfurRecordsRequested) => void;
+    /**
+     * Sent's "Turn on notifications": resolve true once they are on (your app's own permission ask and device
+     * registration). Absent: Everfur's preferences for the member, push and email on (`setPreferences`).
+     */
+    readonly onEnableNotifications?: () => boolean | Promise<boolean>;
+    /** The clinic frame's "Upload a PDF or a photo instead", run once the intro closes. Absent: the link is not drawn. */
+    readonly onUpload?: () => void;
+    /** The consent step's owner name, and your own signature capture. */
+    readonly ownerName?: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    /** The tab labels frame 1's rows carry. Defaults to Raph's: Ask, Health Plan, Records. */
+    readonly tabLabels?: EverfurIntroTabLabels;
+    readonly testID?: string;
+}
+declare function EverfurIntro(props: EverfurIntroProps): ReactNode;
+
+/** How long his banner stays before the records land (S.bannerT, 6000ms). */
+declare const RECORDS_BANNER_MS = 6000;
+interface EverfurRecordsLandedBannerProps {
+    /** The banner's lines (`introText(...).banner`). */
+    readonly text: IntroText['banner'];
+    /** The partner's app tile (its own mark). Absent: the tile is drawn plain, in the accent colour. */
+    readonly icon?: ReactNode;
+    /** Tapped, or its six seconds ran out: land the records (open the Health Plan, say they are in). */
+    readonly onLand: () => void;
+    readonly testID?: string;
+}
+declare function EverfurRecordsLandedBanner({ text, icon, onLand, testID }: EverfurRecordsLandedBannerProps): ReactNode;
+
+export { EverfurIntro, EverfurIntroBlank, EverfurIntroClose, EverfurIntroCopy, EverfurIntroFrame, EverfurIntroMode, type EverfurIntroProps, type EverfurIntroTabBar, EverfurIntroTabLabels, EverfurRecordsLanded, EverfurRecordsLandedBanner, type EverfurRecordsLandedBannerProps, EverfurRecordsRequested, EverfurTabId, EverfurTabs, type EverfurTabsChatProps, EverfurTabsCopy, type EverfurTabsHandle, type EverfurTabsIntro, type EverfurTabsOpened, type EverfurTabsPlanProps, type EverfurTabsProps, type EverfurTabsRecordsProps, IntroText, RECORDS_BANNER_MS, useEverfurTabs };

package/dist/tabs/index.d.ts

@@ -0,0 +1,175 @@
+import { EverfurChatProps } from '@everfur/sdk/chat';
+import { EverfurHealthPlanProps } from '@everfur/sdk/health-plan';
+import { EverfurRecordsProps } from '@everfur/sdk/records';
+import { ReactNode } from 'react';
+import { StyleProp, ViewStyle } from 'react-native';
+import { P as PetRef } from '../ids.d-B2GAAifq.js';
+import { E as EverfurStarterPrompt } from '../quickPrompts.d-NM_81Jc1.js';
+import { E as EverfurIntroCopy, a as EverfurIntroBlank, b as EverfurRecordsRequested, d as EverfurRecordsLanded, I as IntroText } from '../introEvents.d-tOi4o3F4.js';
+export { c as EVERFUR_INTRO_COPY, e as IntroFacts, f as IntroPetWords, g as IntroTextInput, h as defaultIntroBlanks, i as introFacts, j as introPetWords, k as introText, n as numberWord } from '../introEvents.d-tOi4o3F4.js';
+import { C as CaptureRecordsSignature } from '../clinicRequestProps.d-CjsMg_OD.js';
+import { T as TabsOpenedLike, E as EverfurTabsCopy, a as EverfurTabId } from '../tabsModel.d-BfIQg6yS.js';
+export { b as EVERFUR_TABS_COPY } from '../tabsModel.d-BfIQg6yS.js';
+import { H as HealthPlanPage } from '../focus.d-CtotIyEt.js';
+import { E as EverfurIntroMode, a as EverfurIntroFrame, b as EverfurIntroClose, c as EverfurIntroTabLabels } from '../useIntroSeen.d-CTWFUthO.js';
+export { d as EverfurIntroExit, e as EverfurIntroSeen, i as isIntroSwipeOut, u as useEverfurIntroSeen } from '../useIntroSeen.d-CTWFUthO.js';
+import '../EverfurResult.d-D_-254ZY.js';
+import '../EverfurError.d-8NHtlgzA.js';
+import '../clinicModels.d-CaS64-P-.js';
+import '../models.d-DOwnr8fi.js';
+import '../requestFunnel.d-DFf9C__p.js';
+import '../ErrorPolicyPort.d-68yrE3BE.js';
+import '../config.d-zd2eTb2L.js';
+import '../identity.d-BksOEa6m.js';
+
+/**
+ * How the member got here, said by the host (explicit, owner decision (a)): a plain open from your app's own tab bar,
+ * or a deep link (a push, a text, a "See her plan" button) that names a tab and maybe a question for the chat. Change
+ * `key` for each new open, so the same link twice is two opens.
+ */
+type EverfurTabsOpened = TabsOpenedLike;
+/** EverfurChat's own props, passed through; the shell sets the pet, the question a link carries and the plan door. */
+type EverfurTabsChatProps = Omit<EverfurChatProps, 'petRef' | 'initialAsk' | 'initialAskKey' | 'onOpenHealthPlan'>;
+/** EverfurHealthPlan's own props, passed through; the shell sets the pet and remounts it on a changed plan. */
+type EverfurTabsPlanProps = Omit<EverfurHealthPlanProps, 'petRef'>;
+/** EverfurRecords' own props, passed through; the shell sets the pet, its name, Ask and the plan door. */
+type EverfurTabsRecordsProps = Omit<EverfurRecordsProps, 'petRef' | 'petName'>;
+/** The intro's options (`EverfurTabs intro=`). Every one is optional; `intro={false}` never plays it. */
+interface EverfurTabsIntro {
+    /** Your own words in the intro (each defaults to empty, and an empty line is not drawn). */
+    readonly copy?: Partial<EverfurIntroCopy>;
+    /** The plan's blanks the records ask shows. Absent: the pet's weight and next shots. */
+    readonly blanks?: readonly EverfurIntroBlank[];
+    /** Sent's "Turn on notifications": your app's permission ask; resolve true once on. Absent: Everfur's preferences. */
+    readonly onEnableNotifications?: () => boolean | Promise<boolean>;
+    /** The clinic frame's "Upload a PDF or a photo instead", run once the intro closes. Absent: the Records tab opens. */
+    readonly onUpload?: () => void;
+    /** The consent step's owner name, and your own signature capture. */
+    readonly ownerName?: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    /** The records-landed banner's app tile (your app's mark). */
+    readonly bannerIcon?: ReactNode;
+    /** The intro plays only while the window is narrower than this (Raph's intro is the phone's). Default 600. */
+    readonly maxWidth?: number;
+}
+interface EverfurTabsProps {
+    /** The pet the three tabs are about. Null: no pet yet (the chat starts unscoped, the plan and records wait). */
+    readonly petRef: PetRef | null;
+    /** The pet's name, for Records and the intro until the plan page names it. */
+    readonly petName?: string | null;
+    /**
+     * How the member got here (explicit): `{ via: 'plain' }` from your app's own tab bar, `{ via: 'link', tab }` from a
+     * push, a text or a "See her plan" button. A new `key` is a new open. A plain open lands on Health Plan and may play
+     * the intro; a link opens where it points, and the intro waits for the next plain open.
+     */
+    readonly opened: EverfurTabsOpened;
+    /** Whether the shell is on screen (your app's own tab is this one). Default true. */
+    readonly visible?: boolean;
+    readonly copy?: Partial<EverfurTabsCopy>;
+    readonly chat?: EverfurTabsChatProps;
+    readonly plan?: EverfurTabsPlanProps;
+    readonly records?: EverfurTabsRecordsProps;
+    /** Your content around the records screen (your own top section over it). Absent: the screen alone. */
+    readonly renderRecords?: (page: ReactNode) => ReactNode;
+    /** Your content under a pane (a composer), drawn inside the pane after the SDK's surface. */
+    readonly paneFooter?: Partial<Record<EverfurTabId, ReactNode>>;
+    /**
+     * The pet's results are not back yet: Ask draws no focus card and no pill and offers `pendingStarterPrompts`, and
+     * the intro uses its waiting lines. Absent: read from the pet's Health Plan page (its waiting card, `wait`); set it
+     * to override that.
+     */
+    readonly resultsPending?: boolean;
+    /** Ask's starters while the results are not back (your words). */
+    readonly pendingStarterPrompts?: readonly EverfurStarterPrompt[];
+    /** The first-open intro. Default on (it plays once per member); false never plays it. */
+    readonly intro?: EverfurTabsIntro | false;
+    readonly onTabChange?: (tab: EverfurTabId) => void;
+    readonly onRecordsRequested?: (event: EverfurRecordsRequested) => void;
+    readonly onRecordsLanded?: (event: EverfurRecordsLanded) => void;
+    /** Your own toast. Absent: Raph's, drawn over the tab bar. */
+    readonly onToast?: (message: string) => void;
+    /**
+     * A ref the shell fills with its handle (open a tab, ask, request records), for your callbacks that live outside its
+     * content. Content inside the shell reads it with useEverfurTabs().
+     */
+    readonly tabsRef?: {
+        current: EverfurTabsHandle | null;
+    };
+    readonly style?: StyleProp<ViewStyle>;
+    readonly testID?: string;
+}
+/** What the content inside the shell can do: open a tab, ask in the chat, open the records request sheet. */
+interface EverfurTabsHandle {
+    readonly tab: EverfurTabId;
+    open(tab: EverfurTabId): void;
+    /** Opens Ask with a question in a fresh chat. An empty question only opens Ask. */
+    ask(prompt: string): void;
+    /** Raph's records request sheet (his 2a and 2b): her clinic, the consent, Sent. Backing out stays where you are. */
+    requestRecords(): void;
+}
+/** The shell around you, inside EverfurTabs (a pane footer, your records section); null outside it. */
+declare function useEverfurTabs(): EverfurTabsHandle | null;
+declare function EverfurTabs(props: EverfurTabsProps): ReactNode;
+
+/** Where the tab bar sits in the window (`measureInWindow`), so frame 1's dims leave it clear. */
+interface EverfurIntroTabBar {
+    readonly top: number;
+    readonly height: number;
+}
+interface EverfurIntroProps {
+    readonly petRef: PetRef;
+    /** Defaults to 'intro'. */
+    readonly mode?: EverfurIntroMode;
+    /**
+     * The pet's Health Plan page: the pet's name and sex (her pronoun), the plan's title (the blanks card's header),
+     * its tips, and its vet byline. Null or absent: `petName` and the lines that need the page are not drawn.
+     */
+    readonly page?: HealthPlanPage | null;
+    readonly petName?: string | null;
+    /** The pet's vet records are already in: frame 1 only, and its button reads "See her plan". */
+    readonly recordsConnected?: boolean;
+    /** The pet's results are not back yet: frame 1's waiting lines. */
+    readonly resultsPending?: boolean;
+    /** Your own words (each defaults to empty, and an empty line is not drawn). */
+    readonly copy?: Partial<EverfurIntroCopy>;
+    /** The plan's blanks, in order. Absent: the pet's weight and next shots. */
+    readonly blanks?: readonly EverfurIntroBlank[];
+    /** The tab bar frame 1 lights, in window coordinates. Absent: his own (140 from the top, 46 tall). */
+    readonly tabBar?: EverfurIntroTabBar | null;
+    /** The frame shown, and null once closed: frame 1 lights the tab bar ('tabs'). */
+    readonly onFrame?: (frame: EverfurIntroFrame | null) => void;
+    /** The member closed it (the sheet is still going down). */
+    readonly onClose: (close: EverfurIntroClose) => void;
+    /** The sheet is down: unmount it. */
+    readonly onClosed?: () => void;
+    readonly onRequested?: (event: EverfurRecordsRequested) => void;
+    /**
+     * Sent's "Turn on notifications": resolve true once they are on (your app's own permission ask and device
+     * registration). Absent: Everfur's preferences for the member, push and email on (`setPreferences`).
+     */
+    readonly onEnableNotifications?: () => boolean | Promise<boolean>;
+    /** The clinic frame's "Upload a PDF or a photo instead", run once the intro closes. Absent: the link is not drawn. */
+    readonly onUpload?: () => void;
+    /** The consent step's owner name, and your own signature capture. */
+    readonly ownerName?: string;
+    readonly onCaptureSignature?: CaptureRecordsSignature;
+    /** The tab labels frame 1's rows carry. Defaults to Raph's: Ask, Health Plan, Records. */
+    readonly tabLabels?: EverfurIntroTabLabels;
+    readonly testID?: string;
+}
+declare function EverfurIntro(props: EverfurIntroProps): ReactNode;
+
+/** How long his banner stays before the records land (S.bannerT, 6000ms). */
+declare const RECORDS_BANNER_MS = 6000;
+interface EverfurRecordsLandedBannerProps {
+    /** The banner's lines (`introText(...).banner`). */
+    readonly text: IntroText['banner'];
+    /** The partner's app tile (its own mark). Absent: the tile is drawn plain, in the accent colour. */
+    readonly icon?: ReactNode;
+    /** Tapped, or its six seconds ran out: land the records (open the Health Plan, say they are in). */
+    readonly onLand: () => void;
+    readonly testID?: string;
+}
+declare function EverfurRecordsLandedBanner({ text, icon, onLand, testID }: EverfurRecordsLandedBannerProps): ReactNode;
+
+export { EverfurIntro, EverfurIntroBlank, EverfurIntroClose, EverfurIntroCopy, EverfurIntroFrame, EverfurIntroMode, type EverfurIntroProps, type EverfurIntroTabBar, EverfurIntroTabLabels, EverfurRecordsLanded, EverfurRecordsLandedBanner, type EverfurRecordsLandedBannerProps, EverfurRecordsRequested, EverfurTabId, EverfurTabs, type EverfurTabsChatProps, EverfurTabsCopy, type EverfurTabsHandle, type EverfurTabsIntro, type EverfurTabsOpened, type EverfurTabsPlanProps, type EverfurTabsProps, type EverfurTabsRecordsProps, IntroText, RECORDS_BANNER_MS, useEverfurTabs };