@everfur/sdk 0.14.0 → 0.15.0

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

@@ -30,7 +30,10 @@ interface RecordsSheetFonts {
  */
 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. */
+/**
+ * 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;
@@ -60,7 +63,11 @@ 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 in its card and on the no-records page. Without it the vitals are a plain row and the page has no scene. */
+    /**
+     * 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 Everfur's (Azeret, Azeret Mono, Caveat). The faces are yours to load. */
     readonly fonts?: Partial<RecordsSheetFonts>;

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

@@ -30,7 +30,10 @@ interface RecordsSheetFonts {
  */
 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. */
+/**
+ * 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;
@@ -60,7 +63,11 @@ 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 in its card and on the no-records page. Without it the vitals are a plain row and the page has no scene. */
+    /**
+     * 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 Everfur's (Azeret, Azeret Mono, Caveat). The faces are yours to load. */
     readonly fonts?: Partial<RecordsSheetFonts>;