@everfur/sdk 0.13.0 → 0.15.0

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

@@ -1,15 +1,15 @@
-import { E as EverfurRecordsSheet } from '../../sheetSeam.d-DCS3LW8g.cjs';
-export { a as EverfurRecordsSheetLabRenderArgs, b as EverfurRecordsSheetRenderArgs } from '../../sheetSeam.d-DCS3LW8g.cjs';
+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-BnLm3VAA.cjs';
+import '../../models.d-BSqvbTE1.cjs';
 import '../../EverfurError.d-8NHtlgzA.cjs';
-import '../../useRecords.d-Cb-36SF5.cjs';
+import '../../useRecords.d-BYNX01El.cjs';
 import '../../EverfurResult.d-BFH-3s6E.cjs';
 import '../../ports.d-BX4f4UsB.cjs';
-import '../../features.d-fNsGcg0R.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';
@@ -30,23 +30,28 @@ interface RecordsSheetFonts {
  */
 declare const RECORDS_SHEET_ROW_BUTTON_STYLE: CSSProperties;
 
-/** The pet drawn on grass (Raph's .efh-stage), supplied by the host: the SDK ships no pet art. */
+/**
+ * Your own art for the pet on grass (the web app's pet card stage and its no-records scene). Without it the sheet
+ * draws our app's: the SDK's grass and the pet's own breed drawing from Everfur (its monogram when it has none).
+ */
 interface RecordsSheetStage {
     /** The grass strip under the pet. */
     readonly grassSrc: string;
-    /** The pet itself, standing (Raph's virtual pet). */
+    /** The pet itself, standing (its drawing, 720 by 1119 in the web app). */
     readonly petSrc: string;
 }
-/** Options for `EverfurRecordsPage`'s Raph v3 records sheet. */
+/** Options for `EverfurRecordsPage`'s records sheet. */
 interface EverfurRecordsSheetOptions {
     /**
-     * How the sheet refers to the pet, over what it reads. 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.
+     * 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 Raph's neutrals and status colours and paints his brand green and
-     * accents in your theme's primary and accent (dark mode included); `'raph'` keeps all of his colours.
+     * 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. */
@@ -58,16 +63,20 @@ interface EverfurRecordsSheetOptions {
     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 over the vitals and the no-records scene. Without it the vitals are a plain row. */
+    /**
+     * Your art for the pet on grass in its card and on the no-records page. Without it the sheet draws our app's own:
+     * the SDK's grass and the pet's breed drawing from Everfur (`GET /widget/v1/pets/{pet_ref}/state`), or the pet's
+     * monogram when there is no drawing for it.
+     */
     readonly stage?: RecordsSheetStage;
-    /** Font stacks over Raph's (Azeret, Azeret Mono, Caveat). The faces are yours to load. */
+    /** 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 (Raph's sheet pulls into its host's 16px gutter; pass `margin` to change that). */
+    /** Style over the sheet's root. */
     readonly style?: CSSProperties;
 }
 
@@ -94,7 +103,7 @@ interface EverfurRecordsLabDetailProps {
 declare function EverfurRecordsLabDetail({ petRef, petName, markerId, fonts, palette, renderExtra, onAsk, renderAskButton }: EverfurRecordsLabDetailProps): ReactNode;
 
 /**
- * Raph's v3 records sheet for `EverfurRecordsPage`'s `sheet` prop. Build it once (module scope or `useMemo`): a new
+ * 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;

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

@@ -1,15 +1,15 @@
-import { E as EverfurRecordsSheet } from '../../sheetSeam.d-Cviqk89n.js';
-export { a as EverfurRecordsSheetLabRenderArgs, b as EverfurRecordsSheetRenderArgs } from '../../sheetSeam.d-Cviqk89n.js';
+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-BagXhafD.js';
+import '../../models.d-DOwnr8fi.js';
 import '../../EverfurError.d-8NHtlgzA.js';
-import '../../useRecords.d-aQTzQZoV.js';
+import '../../useRecords.d-DWk61a4c.js';
 import '../../EverfurResult.d-D_-254ZY.js';
 import '../../ports.d-BX4f4UsB.js';
-import '../../features.d-fNsGcg0R.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';
@@ -30,23 +30,28 @@ interface RecordsSheetFonts {
  */
 declare const RECORDS_SHEET_ROW_BUTTON_STYLE: CSSProperties;
 
-/** The pet drawn on grass (Raph's .efh-stage), supplied by the host: the SDK ships no pet art. */
+/**
+ * Your own art for the pet on grass (the web app's pet card stage and its no-records scene). Without it the sheet
+ * draws our app's: the SDK's grass and the pet's own breed drawing from Everfur (its monogram when it has none).
+ */
 interface RecordsSheetStage {
     /** The grass strip under the pet. */
     readonly grassSrc: string;
-    /** The pet itself, standing (Raph's virtual pet). */
+    /** The pet itself, standing (its drawing, 720 by 1119 in the web app). */
     readonly petSrc: string;
 }
-/** Options for `EverfurRecordsPage`'s Raph v3 records sheet. */
+/** Options for `EverfurRecordsPage`'s records sheet. */
 interface EverfurRecordsSheetOptions {
     /**
-     * How the sheet refers to the pet, over what it reads. 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.
+     * 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 Raph's neutrals and status colours and paints his brand green and
-     * accents in your theme's primary and accent (dark mode included); `'raph'` keeps all of his colours.
+     * 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. */
@@ -58,16 +63,20 @@ interface EverfurRecordsSheetOptions {
     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 over the vitals and the no-records scene. Without it the vitals are a plain row. */
+    /**
+     * Your art for the pet on grass in its card and on the no-records page. Without it the sheet draws our app's own:
+     * the SDK's grass and the pet's breed drawing from Everfur (`GET /widget/v1/pets/{pet_ref}/state`), or the pet's
+     * monogram when there is no drawing for it.
+     */
     readonly stage?: RecordsSheetStage;
-    /** Font stacks over Raph's (Azeret, Azeret Mono, Caveat). The faces are yours to load. */
+    /** 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 (Raph's sheet pulls into its host's 16px gutter; pass `margin` to change that). */
+    /** Style over the sheet's root. */
     readonly style?: CSSProperties;
 }
 
@@ -94,7 +103,7 @@ interface EverfurRecordsLabDetailProps {
 declare function EverfurRecordsLabDetail({ petRef, petName, markerId, fonts, palette, renderExtra, onAsk, renderAskButton }: EverfurRecordsLabDetailProps): ReactNode;
 
 /**
- * Raph's v3 records sheet for `EverfurRecordsPage`'s `sheet` prop. Build it once (module scope or `useMemo`): a new
+ * 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;