@everfur/sdk 0.12.1 → 0.14.0

package/dist/web/records-sheet/index.d.cts

@@ -0,0 +1,104 @@
+import { E as EverfurRecordsSheet } from '../../sheetSeam.d-BBuEIVsa.cjs';
+export { a as EverfurRecordsSheetLabRenderArgs, b as EverfurRecordsSheetRenderArgs } from '../../sheetSeam.d-BBuEIVsa.cjs';
+import { CSSProperties, ReactNode } from 'react';
+import { R as RecordsSheetPronoun } from '../../sheetCopy.d-CAhLOxjc.cjs';
+import { P as PetRef } from '../../ids.d-B2GAAifq.cjs';
+import { a as RecordsAskHandler } from '../../recordsAsk.d-C5CGSi3j.cjs';
+import '../../models.d-BSqvbTE1.cjs';
+import '../../EverfurError.d-8NHtlgzA.cjs';
+import '../../useRecords.d-BYNX01El.cjs';
+import '../../EverfurResult.d-BFH-3s6E.cjs';
+import '../../ports.d-BX4f4UsB.cjs';
+import '../../features.d-DrQxTw3-.cjs';
+
+/** The unit the sheet shows a weight in first: lb (the default, as Raph draws it) or kg. */
+type SheetWeightUnit = 'lb' | 'kg';
+
+/** Whose colours the sheet paints: the theme's (Q4, the default) or Raph's own, whatever the theme. */
+type RecordsSheetPalette = 'theme' | 'raph';
+
+/** The four font stacks the sheet uses: body, mono (labels, dates), hand (the no-records line), sans (the DNA slot). */
+interface RecordsSheetFonts {
+    readonly font: string;
+    readonly mono: string;
+    readonly hand: string;
+    readonly sans: string;
+}
+/**
+ * Raph's row button (`.efh-btn .efh-btn--ink .efh-btn--row`, his "Speak to vet" on the overdue care row) with his
+ * fonts, for the host's own action in `renderUpcomingCareAction` (pass it as that control's `style`).
+ */
+declare const RECORDS_SHEET_ROW_BUTTON_STYLE: CSSProperties;
+
+/** The pet drawn on grass (the web app's pet card stage and its no-records scene), supplied by the host: the SDK ships no pet art. */
+interface RecordsSheetStage {
+    /** The grass strip under the pet. */
+    readonly grassSrc: string;
+    /** The pet itself, standing (its drawing, 720 by 1119 in the web app). */
+    readonly petSrc: string;
+}
+/** Options for `EverfurRecordsPage`'s records sheet. */
+interface EverfurRecordsSheetOptions {
+    /**
+     * How the SDK's own lines (the top risk line, the history key) refer to the pet. Without it the sheet takes the
+     * pet's sex from its Health Plan page or its profile ("her" for a female, "his" for a male) and otherwise the pet's
+     * name. The web app's own lines always name the pet.
+     */
+    readonly pronoun?: RecordsSheetPronoun;
+    /**
+     * Whose colours: `'theme'` (the default) keeps the Everfur web app's neutrals and status colours and paints its
+     * brand green and accents in your theme's primary and accent (dark mode included); `'raph'` keeps all of Everfur's
+     * colours.
+     */
+    readonly palette?: RecordsSheetPalette;
+    /** The unit a weight shows in first: `'lb'` (the default) or `'kg'`; the other unit follows it. */
+    readonly weightUnit?: SheetWeightUnit;
+    /**
+     * The top risk line over the records (the pet's Health Plan focus): on or off over the console's
+     * `records_top_risk_line`. It draws only with the Health Plan capability and a focus on the pet's plan page.
+     */
+    readonly topRiskLine?: boolean;
+    /** Opens the pet's Health Plan (your tab or screen): the top risk line's button. Without it the line has no button. */
+    readonly onOpenPlan?: () => void;
+    /** The pet on grass in its card and on the no-records page. Without it the vitals are a plain row and the page has no scene. */
+    readonly stage?: RecordsSheetStage;
+    /** Font stacks over Everfur's (Azeret, Azeret Mono, Caveat). The faces are yours to load. */
+    readonly fonts?: Partial<RecordsSheetFonts>;
+    /**
+     * A lab result tile or a flagged reading was opened. Route it to your own screen (render
+     * `EverfurRecordsLabDetail` there); without it the page opens the result in place.
+     */
+    readonly onOpenMarker?: (markerId: string) => void;
+    /** Style over the sheet's root. */
+    readonly style?: CSSProperties;
+}
+
+interface EverfurRecordsLabDetailProps {
+    readonly petRef: PetRef;
+    readonly petName?: string;
+    /** The lab value to show (a `markerId` from the records sheet's `onOpenMarker`). */
+    readonly markerId: string;
+    /** Font stacks over Raph's; match the page's `sheet.fonts`. */
+    readonly fonts?: Partial<RecordsSheetFonts>;
+    /** Whose colours, as the sheet's `palette`: the theme's (the default) or Raph's own. Match the page's sheet. */
+    readonly palette?: RecordsSheetPalette;
+    /** Your content after the latest reading (Raph's place for a partner's own result about this value). */
+    readonly renderExtra?: (markerId: string) => ReactNode;
+    /** Ask about this value in your chat; without it there is no Ask button. */
+    readonly onAsk?: RecordsAskHandler;
+    /**
+     * Draw the Ask control yourself (Raph's shell floats his ask-pill over the screen): call `ask` on its press, and
+     * label it with `label` ("Ask about this"). Without it the SDK draws the button at the end of the screen.
+     */
+    readonly renderAskButton?: (ask: () => void, label: string) => ReactNode;
+}
+/** Raph's lab screen for one value. Renders nothing until the markers read lands, and nothing for an unknown id. */
+declare function EverfurRecordsLabDetail({ petRef, petName, markerId, fonts, palette, renderExtra, onAsk, renderAskButton }: EverfurRecordsLabDetailProps): ReactNode;
+
+/**
+ * The records sheet (our web app's health tab) for `EverfurRecordsPage`'s `sheet` prop. Build it once (module scope or `useMemo`): a new
+ * object each render is a new sheet each render.
+ */
+declare function recordsSheet(options?: EverfurRecordsSheetOptions): EverfurRecordsSheet;
+
+export { EverfurRecordsLabDetail, type EverfurRecordsLabDetailProps, EverfurRecordsSheet, type EverfurRecordsSheetOptions, RECORDS_SHEET_ROW_BUTTON_STYLE, type RecordsSheetFonts, type RecordsSheetPalette, RecordsSheetPronoun, type RecordsSheetStage, type SheetWeightUnit as RecordsSheetWeightUnit, recordsSheet };

package/dist/web/records-sheet/index.d.ts

@@ -0,0 +1,104 @@
+import { E as EverfurRecordsSheet } from '../../sheetSeam.d-B09jf4YC.js';
+export { a as EverfurRecordsSheetLabRenderArgs, b as EverfurRecordsSheetRenderArgs } from '../../sheetSeam.d-B09jf4YC.js';
+import { CSSProperties, ReactNode } from 'react';
+import { R as RecordsSheetPronoun } from '../../sheetCopy.d-CAhLOxjc.js';
+import { P as PetRef } from '../../ids.d-B2GAAifq.js';
+import { a as RecordsAskHandler } from '../../recordsAsk.d-C5CGSi3j.js';
+import '../../models.d-DOwnr8fi.js';
+import '../../EverfurError.d-8NHtlgzA.js';
+import '../../useRecords.d-DWk61a4c.js';
+import '../../EverfurResult.d-D_-254ZY.js';
+import '../../ports.d-BX4f4UsB.js';
+import '../../features.d-DrQxTw3-.js';
+
+/** The unit the sheet shows a weight in first: lb (the default, as Raph draws it) or kg. */
+type SheetWeightUnit = 'lb' | 'kg';
+
+/** Whose colours the sheet paints: the theme's (Q4, the default) or Raph's own, whatever the theme. */
+type RecordsSheetPalette = 'theme' | 'raph';
+
+/** The four font stacks the sheet uses: body, mono (labels, dates), hand (the no-records line), sans (the DNA slot). */
+interface RecordsSheetFonts {
+    readonly font: string;
+    readonly mono: string;
+    readonly hand: string;
+    readonly sans: string;
+}
+/**
+ * Raph's row button (`.efh-btn .efh-btn--ink .efh-btn--row`, his "Speak to vet" on the overdue care row) with his
+ * fonts, for the host's own action in `renderUpcomingCareAction` (pass it as that control's `style`).
+ */
+declare const RECORDS_SHEET_ROW_BUTTON_STYLE: CSSProperties;
+
+/** The pet drawn on grass (the web app's pet card stage and its no-records scene), supplied by the host: the SDK ships no pet art. */
+interface RecordsSheetStage {
+    /** The grass strip under the pet. */
+    readonly grassSrc: string;
+    /** The pet itself, standing (its drawing, 720 by 1119 in the web app). */
+    readonly petSrc: string;
+}
+/** Options for `EverfurRecordsPage`'s records sheet. */
+interface EverfurRecordsSheetOptions {
+    /**
+     * How the SDK's own lines (the top risk line, the history key) refer to the pet. Without it the sheet takes the
+     * pet's sex from its Health Plan page or its profile ("her" for a female, "his" for a male) and otherwise the pet's
+     * name. The web app's own lines always name the pet.
+     */
+    readonly pronoun?: RecordsSheetPronoun;
+    /**
+     * Whose colours: `'theme'` (the default) keeps the Everfur web app's neutrals and status colours and paints its
+     * brand green and accents in your theme's primary and accent (dark mode included); `'raph'` keeps all of Everfur's
+     * colours.
+     */
+    readonly palette?: RecordsSheetPalette;
+    /** The unit a weight shows in first: `'lb'` (the default) or `'kg'`; the other unit follows it. */
+    readonly weightUnit?: SheetWeightUnit;
+    /**
+     * The top risk line over the records (the pet's Health Plan focus): on or off over the console's
+     * `records_top_risk_line`. It draws only with the Health Plan capability and a focus on the pet's plan page.
+     */
+    readonly topRiskLine?: boolean;
+    /** Opens the pet's Health Plan (your tab or screen): the top risk line's button. Without it the line has no button. */
+    readonly onOpenPlan?: () => void;
+    /** The pet on grass in its card and on the no-records page. Without it the vitals are a plain row and the page has no scene. */
+    readonly stage?: RecordsSheetStage;
+    /** Font stacks over Everfur's (Azeret, Azeret Mono, Caveat). The faces are yours to load. */
+    readonly fonts?: Partial<RecordsSheetFonts>;
+    /**
+     * A lab result tile or a flagged reading was opened. Route it to your own screen (render
+     * `EverfurRecordsLabDetail` there); without it the page opens the result in place.
+     */
+    readonly onOpenMarker?: (markerId: string) => void;
+    /** Style over the sheet's root. */
+    readonly style?: CSSProperties;
+}
+
+interface EverfurRecordsLabDetailProps {
+    readonly petRef: PetRef;
+    readonly petName?: string;
+    /** The lab value to show (a `markerId` from the records sheet's `onOpenMarker`). */
+    readonly markerId: string;
+    /** Font stacks over Raph's; match the page's `sheet.fonts`. */
+    readonly fonts?: Partial<RecordsSheetFonts>;
+    /** Whose colours, as the sheet's `palette`: the theme's (the default) or Raph's own. Match the page's sheet. */
+    readonly palette?: RecordsSheetPalette;
+    /** Your content after the latest reading (Raph's place for a partner's own result about this value). */
+    readonly renderExtra?: (markerId: string) => ReactNode;
+    /** Ask about this value in your chat; without it there is no Ask button. */
+    readonly onAsk?: RecordsAskHandler;
+    /**
+     * Draw the Ask control yourself (Raph's shell floats his ask-pill over the screen): call `ask` on its press, and
+     * label it with `label` ("Ask about this"). Without it the SDK draws the button at the end of the screen.
+     */
+    readonly renderAskButton?: (ask: () => void, label: string) => ReactNode;
+}
+/** Raph's lab screen for one value. Renders nothing until the markers read lands, and nothing for an unknown id. */
+declare function EverfurRecordsLabDetail({ petRef, petName, markerId, fonts, palette, renderExtra, onAsk, renderAskButton }: EverfurRecordsLabDetailProps): ReactNode;
+
+/**
+ * The records sheet (our web app's health tab) for `EverfurRecordsPage`'s `sheet` prop. Build it once (module scope or `useMemo`): a new
+ * object each render is a new sheet each render.
+ */
+declare function recordsSheet(options?: EverfurRecordsSheetOptions): EverfurRecordsSheet;
+
+export { EverfurRecordsLabDetail, type EverfurRecordsLabDetailProps, EverfurRecordsSheet, type EverfurRecordsSheetOptions, RECORDS_SHEET_ROW_BUTTON_STYLE, type RecordsSheetFonts, type RecordsSheetPalette, RecordsSheetPronoun, type RecordsSheetStage, type SheetWeightUnit as RecordsSheetWeightUnit, recordsSheet };