@everfur/sdk 0.1.1 → 0.3.0

package/dist/server/index.d.cts

@@ -1,5 +1,75 @@
-import { E as EverfurResult } from '../EverfurResult-D92-uL82.cjs';
-import { a as FetchLike } from '../config-BSjBdxrZ.cjs';
+import { c as EverfurResult } from '../EverfurResult-DN9pL2Ab.cjs';
+import { j as FetchLike } from '../config-CzTZGlfF.cjs';
+import { P as PartnerServerClient } from '../pets-aB8q0JyX.cjs';
+export { a as PartnerPet, b as PartnerPetProfile, c as PartnerPetTarget, d as PartnerPetWithProfile, e as deletePartnerPet, g as getPartnerPet, u as updatePartnerPet, f as upsertPartnerPet } from '../pets-aB8q0JyX.cjs';
+export { b as PetActivityLevel, c as PetAllergy, d as PetAllergySeverity, e as PetBirthDatePrecision, f as PetCondition, a as PetHealthProfile, P as PetHealthProfileInput, g as PetIndoorOutdoor, h as PetMedication, i as PetSex } from '../profile-CSs1wlXT.cjs';
+export { C as CanonicalPetSpecies, c as canonicalPetSpecies } from '../species-BXAIMh7I.cjs';
+
+/**
+ * Validate a partner user_ref at the SDK boundary (server re-validates). SPEC-21 section 1.1.
+ *
+ * Three checks here mirror server behaviour that is easy to miss, and each one previously let a value
+ * through that the server then rejected or silently reinterpreted:
+ *
+ *  - The server does `value = (raw or "").strip()` BEFORE validating, so `"   "` reaches it as empty and
+ *    fails REQUIRED even though it is three characters here.
+ *  - That same strip means `" alice"`, `"alice "` and `"alice"` all resolve to ONE identity. Silently
+ *    trimming would hide that; rejecting it tells the partner their two ids are about to collapse into one
+ *    user's data.
+ *  - The server uses Python's `str.isprintable()`, which is Unicode-aware. A NBSP, zero-width space or BOM
+ *    is printable by an ASCII test and NOT printable by that one, so it passed here and 400'd there.
+ */
+declare function assertValidUserRef(raw: string): string;
+
+/** The consent you collected for this address. `partner_attested` is the one method in this version. */
+interface PartnerMemberEmailConsent {
+    /** When the member agreed: an ISO 8601 instant, or a Date. Not in the future (the route allows five minutes of skew). */
+    readonly givenAt: string | Date;
+    readonly method: 'partner_attested';
+    /** The version of your consent text the member agreed to (1 to 64 characters). Never minted by Everfur. */
+    readonly version: string;
+}
+interface SetPartnerMemberNotificationProfileInput {
+    /** Your stable member id; the session mint's user_ref rule (1 to 128 characters, no '@', printable). */
+    readonly userRef: string;
+    /** The member's address. Everfur normalises it (trimmed, lowercased) and stores it with its hash; it is never echoed. */
+    readonly email: string;
+    readonly consent: PartnerMemberEmailConsent;
+}
+/** The consent stamp as Everfur stored it. */
+interface PartnerMemberEmailConsentRecord {
+    /** ISO 8601. */
+    readonly givenAt: string;
+    readonly method: string;
+    readonly version: string;
+}
+/** A member's notification profile, MASKED: the address never comes back. */
+interface PartnerMemberNotificationProfile {
+    readonly userRef: string;
+    /** The stored address in its masked form (`o***@example.com`), or null when none is on file. */
+    readonly emailMasked: string | null;
+    readonly consent: PartnerMemberEmailConsentRecord | null;
+    /** ISO 8601, or null: set by a later verification flow, never by this route. */
+    readonly emailVerifiedAt: string | null;
+    /** The member's own switches (`PUT /widget/v1/me/notification-preferences` from the SDK). */
+    readonly pushEnabled: boolean;
+    readonly emailEnabled: boolean;
+    /** ISO 8601, or null: set by the one-click unsubscribe link in Everfur's mail, cleared by a new stamp. */
+    readonly unsubscribedAt: string | null;
+    /** How many of this member's devices are registered for push. */
+    readonly activeDevices: number;
+    /** ISO 8601. */
+    readonly updatedAt: string;
+}
+/**
+ * Supply (or replace) a member's email with its consent stamp. Creates the member on first use.
+ *
+ * Settles to an `EverfurResult` for HTTP and network failures (`validationFailed` with `reasonCode` `consent_required`,
+ * `email_invalid` or `consent_invalid`; the not-found error while the routes are dark; `accessDenied` for a restricted
+ * key without `pets.profile.update`; `rateLimited`; `serviceUnavailable` mid-erasure). Throws `EverfurConfigError` for
+ * a request that can never be accepted: a malformed key, `userRef`, address or consent.
+ */
+declare function setPartnerMemberNotificationProfile(client: PartnerServerClient, input: SetPartnerMemberNotificationProfileInput): Promise<EverfurResult<PartnerMemberNotificationProfile>>;
 
 interface MintSessionParams {
     /** env-derived base URL (resolveApiBaseUrl output), no trailing slash. */
@@ -29,20 +99,5 @@ interface SessionMint {
  * partner backend's helper for a TokenProvider implementation; it is not called on a device.
  */
 declare function mintPartnerSession(params: MintSessionParams): Promise<EverfurResult<SessionMint>>;
-/**
- * Validate a partner user_ref at the SDK boundary (server re-validates). SPEC-21 section 1.1.
- *
- * Three checks here mirror server behaviour that is easy to miss, and each one previously let a value
- * through that the server then rejected or silently reinterpreted:
- *
- *  - The server does `value = (raw or "").strip()` BEFORE validating, so `"   "` reaches it as empty and
- *    fails REQUIRED even though it is three characters here.
- *  - That same strip means `" alice"`, `"alice "` and `"alice"` all resolve to ONE identity. Silently
- *    trimming would hide that; rejecting it tells the partner their two ids are about to collapse into one
- *    user's data.
- *  - The server uses Python's `str.isprintable()`, which is Unicode-aware. A NBSP, zero-width space or BOM
- *    is printable by an ASCII test and NOT printable by that one, so it passed here and 400'd there.
- */
-declare function assertValidUserRef(raw: string): string;
 
-export { type MintSessionParams, type SessionMint, assertValidUserRef, mintPartnerSession };
+export { type MintSessionParams, type PartnerMemberEmailConsent, type PartnerMemberEmailConsentRecord, type PartnerMemberNotificationProfile, PartnerServerClient, type SessionMint, type SetPartnerMemberNotificationProfileInput, assertValidUserRef, mintPartnerSession, setPartnerMemberNotificationProfile };

package/dist/server/index.d.ts

@@ -1,5 +1,75 @@
-import { E as EverfurResult } from '../EverfurResult-D92-uL82.js';
-import { a as FetchLike } from '../config-CiJ0PVBB.js';
+import { c as EverfurResult } from '../EverfurResult-DN9pL2Ab.js';
+import { j as FetchLike } from '../config-DW60uRb9.js';
+import { P as PartnerServerClient } from '../pets-CtQdRpWo.js';
+export { a as PartnerPet, b as PartnerPetProfile, c as PartnerPetTarget, d as PartnerPetWithProfile, e as deletePartnerPet, g as getPartnerPet, u as updatePartnerPet, f as upsertPartnerPet } from '../pets-CtQdRpWo.js';
+export { b as PetActivityLevel, c as PetAllergy, d as PetAllergySeverity, e as PetBirthDatePrecision, f as PetCondition, a as PetHealthProfile, P as PetHealthProfileInput, g as PetIndoorOutdoor, h as PetMedication, i as PetSex } from '../profile-CSs1wlXT.js';
+export { C as CanonicalPetSpecies, c as canonicalPetSpecies } from '../species-BXAIMh7I.js';
+
+/**
+ * Validate a partner user_ref at the SDK boundary (server re-validates). SPEC-21 section 1.1.
+ *
+ * Three checks here mirror server behaviour that is easy to miss, and each one previously let a value
+ * through that the server then rejected or silently reinterpreted:
+ *
+ *  - The server does `value = (raw or "").strip()` BEFORE validating, so `"   "` reaches it as empty and
+ *    fails REQUIRED even though it is three characters here.
+ *  - That same strip means `" alice"`, `"alice "` and `"alice"` all resolve to ONE identity. Silently
+ *    trimming would hide that; rejecting it tells the partner their two ids are about to collapse into one
+ *    user's data.
+ *  - The server uses Python's `str.isprintable()`, which is Unicode-aware. A NBSP, zero-width space or BOM
+ *    is printable by an ASCII test and NOT printable by that one, so it passed here and 400'd there.
+ */
+declare function assertValidUserRef(raw: string): string;
+
+/** The consent you collected for this address. `partner_attested` is the one method in this version. */
+interface PartnerMemberEmailConsent {
+    /** When the member agreed: an ISO 8601 instant, or a Date. Not in the future (the route allows five minutes of skew). */
+    readonly givenAt: string | Date;
+    readonly method: 'partner_attested';
+    /** The version of your consent text the member agreed to (1 to 64 characters). Never minted by Everfur. */
+    readonly version: string;
+}
+interface SetPartnerMemberNotificationProfileInput {
+    /** Your stable member id; the session mint's user_ref rule (1 to 128 characters, no '@', printable). */
+    readonly userRef: string;
+    /** The member's address. Everfur normalises it (trimmed, lowercased) and stores it with its hash; it is never echoed. */
+    readonly email: string;
+    readonly consent: PartnerMemberEmailConsent;
+}
+/** The consent stamp as Everfur stored it. */
+interface PartnerMemberEmailConsentRecord {
+    /** ISO 8601. */
+    readonly givenAt: string;
+    readonly method: string;
+    readonly version: string;
+}
+/** A member's notification profile, MASKED: the address never comes back. */
+interface PartnerMemberNotificationProfile {
+    readonly userRef: string;
+    /** The stored address in its masked form (`o***@example.com`), or null when none is on file. */
+    readonly emailMasked: string | null;
+    readonly consent: PartnerMemberEmailConsentRecord | null;
+    /** ISO 8601, or null: set by a later verification flow, never by this route. */
+    readonly emailVerifiedAt: string | null;
+    /** The member's own switches (`PUT /widget/v1/me/notification-preferences` from the SDK). */
+    readonly pushEnabled: boolean;
+    readonly emailEnabled: boolean;
+    /** ISO 8601, or null: set by the one-click unsubscribe link in Everfur's mail, cleared by a new stamp. */
+    readonly unsubscribedAt: string | null;
+    /** How many of this member's devices are registered for push. */
+    readonly activeDevices: number;
+    /** ISO 8601. */
+    readonly updatedAt: string;
+}
+/**
+ * Supply (or replace) a member's email with its consent stamp. Creates the member on first use.
+ *
+ * Settles to an `EverfurResult` for HTTP and network failures (`validationFailed` with `reasonCode` `consent_required`,
+ * `email_invalid` or `consent_invalid`; the not-found error while the routes are dark; `accessDenied` for a restricted
+ * key without `pets.profile.update`; `rateLimited`; `serviceUnavailable` mid-erasure). Throws `EverfurConfigError` for
+ * a request that can never be accepted: a malformed key, `userRef`, address or consent.
+ */
+declare function setPartnerMemberNotificationProfile(client: PartnerServerClient, input: SetPartnerMemberNotificationProfileInput): Promise<EverfurResult<PartnerMemberNotificationProfile>>;
 
 interface MintSessionParams {
     /** env-derived base URL (resolveApiBaseUrl output), no trailing slash. */
@@ -29,20 +99,5 @@ interface SessionMint {
  * partner backend's helper for a TokenProvider implementation; it is not called on a device.
  */
 declare function mintPartnerSession(params: MintSessionParams): Promise<EverfurResult<SessionMint>>;
-/**
- * Validate a partner user_ref at the SDK boundary (server re-validates). SPEC-21 section 1.1.
- *
- * Three checks here mirror server behaviour that is easy to miss, and each one previously let a value
- * through that the server then rejected or silently reinterpreted:
- *
- *  - The server does `value = (raw or "").strip()` BEFORE validating, so `"   "` reaches it as empty and
- *    fails REQUIRED even though it is three characters here.
- *  - That same strip means `" alice"`, `"alice "` and `"alice"` all resolve to ONE identity. Silently
- *    trimming would hide that; rejecting it tells the partner their two ids are about to collapse into one
- *    user's data.
- *  - The server uses Python's `str.isprintable()`, which is Unicode-aware. A NBSP, zero-width space or BOM
- *    is printable by an ASCII test and NOT printable by that one, so it passed here and 400'd there.
- */
-declare function assertValidUserRef(raw: string): string;
 
-export { type MintSessionParams, type SessionMint, assertValidUserRef, mintPartnerSession };
+export { type MintSessionParams, type PartnerMemberEmailConsent, type PartnerMemberEmailConsentRecord, type PartnerMemberNotificationProfile, PartnerServerClient, type SessionMint, type SetPartnerMemberNotificationProfileInput, assertValidUserRef, mintPartnerSession, setPartnerMemberNotificationProfile };