@everfur/sdk 0.3.0 → 0.5.0

package/dist/casesRepository-B-Eg8ZJ3.d.cts

@@ -0,0 +1,63 @@
+import { E as EverfurResult } from './EverfurResult-ZtH-YV1h.cjs';
+import { A as AuthContext } from './identity-C7uxGwfT.cjs';
+import { P as PetRef } from './ids-B2GAAifq.cjs';
+
+/** The owner's answer to a check-in, the wire values of the consumer `CheckinResponse` enum. */
+type CheckinAnswer = 'better' | 'same' | 'worse';
+/** The closed answer set, in the order the consumer surfaces offer it. */
+declare const CHECKIN_ANSWERS: readonly CheckinAnswer[];
+/**
+ * The member-safe view of one watch case (consumer `WatchCaseView`). Case STATE only: the concern itself
+ * never rides on this row. `status` is the server's vocabulary (`watching` while open, then `resolved`,
+ * `escalated` or `lapsed`), carried as a string so a status added later never breaks a frozen client.
+ */
+interface WatchCase {
+    readonly caseId: string;
+    readonly status: string;
+    /** The body-region copy hint (`ears`, `eyes`, ..., `general`), never a diagnosis. */
+    readonly bodyLocation: string | null;
+    /** The CASE's latest answer, not any one ask's: after a SAME the case is asked again (see `checkinAskCount`). */
+    readonly lastResponse: CheckinAnswer | null;
+    readonly checkInDueAt: string | null;
+    readonly openedAt: string | null;
+    readonly resolvedAt: string | null;
+    /** The server's own non-diagnostic post-answer line, stamped only on a BETTER resolve. */
+    readonly resolutionText: string | null;
+    /**
+     * How many check-ins the case has ASKED (`checkin_ask_count`, EFBackend V347), null when the read did not
+     * carry it. A 0 on a case older than V347 means "not counted", never "never asked". Optional because the
+     * shape was already in partner hands and test doubles before it: absent reads as unknown.
+     */
+    readonly checkinAskCount?: number | null;
+    /**
+     * How many of them the owner ANSWERED (`checkin_answer_count`, V347), null when absent. Compared with
+     * `checkinAskCount` only, to tell whether `lastResponse` answers the newest ask; never meant to be shown.
+     */
+    readonly checkinAnswerCount?: number | null;
+}
+/** The result of recording a check-in. `ctaDeepLink` is set only on a WORSE escalation (an `everfur://` pointer). */
+interface CheckinOutcome {
+    readonly case: WatchCase;
+    readonly ctaDeepLink: string | null;
+}
+interface CasesRepository {
+    /**
+     * `GET /widget/v1/pets/{pet_ref}/cases` - the pet's open (`watching`) cases. Settles `ok([])` when the pet
+     * has none, which the server makes indistinguishable from a non-member or the feature being off.
+     */
+    list(petRef: PetRef, opts?: {
+        signal?: AbortSignal;
+    }): Promise<EverfurResult<readonly WatchCase[]>>;
+    /**
+     * `POST /widget/v1/pets/{pet_ref}/cases/{case_id}/checkin` - record the owner's answer. Settles
+     * `ok(CheckinOutcome)` on 200; a case that is stale, closed, another member's or gated off is the ordinary
+     * not-found error. A malformed case id or an answer outside the closed set is refused before the wire.
+     */
+    checkin(petRef: PetRef, caseId: string, answer: CheckinAnswer, opts?: {
+        signal?: AbortSignal;
+    }): Promise<EverfurResult<CheckinOutcome>>;
+}
+/** Build the repository over a device AuthContext (personalized bearer XOR anonymous pk). */
+declare function createCasesRepository(auth: AuthContext): CasesRepository;
+
+export { type CheckinAnswer as C, type WatchCase as W, type CheckinOutcome as a, CHECKIN_ANSWERS as b, type CasesRepository as c, createCasesRepository as d };

package/dist/casesRepository-DHgIYKN9.d.ts

@@ -0,0 +1,63 @@
+import { E as EverfurResult } from './EverfurResult-SGvHKsCB.js';
+import { A as AuthContext } from './identity-CLAUq-K4.js';
+import { P as PetRef } from './ids-B2GAAifq.js';
+
+/** The owner's answer to a check-in, the wire values of the consumer `CheckinResponse` enum. */
+type CheckinAnswer = 'better' | 'same' | 'worse';
+/** The closed answer set, in the order the consumer surfaces offer it. */
+declare const CHECKIN_ANSWERS: readonly CheckinAnswer[];
+/**
+ * The member-safe view of one watch case (consumer `WatchCaseView`). Case STATE only: the concern itself
+ * never rides on this row. `status` is the server's vocabulary (`watching` while open, then `resolved`,
+ * `escalated` or `lapsed`), carried as a string so a status added later never breaks a frozen client.
+ */
+interface WatchCase {
+    readonly caseId: string;
+    readonly status: string;
+    /** The body-region copy hint (`ears`, `eyes`, ..., `general`), never a diagnosis. */
+    readonly bodyLocation: string | null;
+    /** The CASE's latest answer, not any one ask's: after a SAME the case is asked again (see `checkinAskCount`). */
+    readonly lastResponse: CheckinAnswer | null;
+    readonly checkInDueAt: string | null;
+    readonly openedAt: string | null;
+    readonly resolvedAt: string | null;
+    /** The server's own non-diagnostic post-answer line, stamped only on a BETTER resolve. */
+    readonly resolutionText: string | null;
+    /**
+     * How many check-ins the case has ASKED (`checkin_ask_count`, EFBackend V347), null when the read did not
+     * carry it. A 0 on a case older than V347 means "not counted", never "never asked". Optional because the
+     * shape was already in partner hands and test doubles before it: absent reads as unknown.
+     */
+    readonly checkinAskCount?: number | null;
+    /**
+     * How many of them the owner ANSWERED (`checkin_answer_count`, V347), null when absent. Compared with
+     * `checkinAskCount` only, to tell whether `lastResponse` answers the newest ask; never meant to be shown.
+     */
+    readonly checkinAnswerCount?: number | null;
+}
+/** The result of recording a check-in. `ctaDeepLink` is set only on a WORSE escalation (an `everfur://` pointer). */
+interface CheckinOutcome {
+    readonly case: WatchCase;
+    readonly ctaDeepLink: string | null;
+}
+interface CasesRepository {
+    /**
+     * `GET /widget/v1/pets/{pet_ref}/cases` - the pet's open (`watching`) cases. Settles `ok([])` when the pet
+     * has none, which the server makes indistinguishable from a non-member or the feature being off.
+     */
+    list(petRef: PetRef, opts?: {
+        signal?: AbortSignal;
+    }): Promise<EverfurResult<readonly WatchCase[]>>;
+    /**
+     * `POST /widget/v1/pets/{pet_ref}/cases/{case_id}/checkin` - record the owner's answer. Settles
+     * `ok(CheckinOutcome)` on 200; a case that is stale, closed, another member's or gated off is the ordinary
+     * not-found error. A malformed case id or an answer outside the closed set is refused before the wire.
+     */
+    checkin(petRef: PetRef, caseId: string, answer: CheckinAnswer, opts?: {
+        signal?: AbortSignal;
+    }): Promise<EverfurResult<CheckinOutcome>>;
+}
+/** Build the repository over a device AuthContext (personalized bearer XOR anonymous pk). */
+declare function createCasesRepository(auth: AuthContext): CasesRepository;
+
+export { type CheckinAnswer as C, type WatchCase as W, type CheckinOutcome as a, CHECKIN_ANSWERS as b, type CasesRepository as c, createCasesRepository as d };