@domino-sdk/relay 1.61.0 → 1.62.0

package/dist/{chunk-PPB7HALD.js → chunk-XJFYAXET.js}

@@ -1,6 +1,6 @@
 import {
   identifier
-} from "./chunk-ZDJLPN4L.js";
+} from "./chunk-MK425RXJ.js";
 
 // src/auth.ts
 import * as z from "zod";
@@ -42,22 +42,23 @@ var memberSummarySchema = z.object({
   avatarSeed: z.string().min(1).max(100),
   /**
    * The member's own email address for "signed in as": the first of `emails`, or null when they
-   * have none, such as after wallet-only sign-in. Only the member reads it. Absent from a Relay
-   * older than this field.
+   * have none, such as after wallet-only sign-in. Only the member reads it. Relay always sends
+   * it; the SDK reads one older than this field as null.
    */
-  email: z.string().min(1).nullable().optional(),
+  email: z.string().min(1).nullable().default(null),
   /**
    * The verified email addresses that sign the member in: each email-code sign-in address, then
    * the verified email of each Google or Apple account enabled for sign-in. Accounts connected
-   * only for activity are left out. Empty when there are none. Absent from a Relay older than
-   * this field.
+   * only for activity are left out. Empty when there are none, and read as empty from a Relay
+   * older than this field.
    */
-  emails: z.array(z.string().min(1)).optional(),
+  emails: z.array(z.string().min(1)).default([]),
   /**
    * The member's clock, which Relay judges their activity on. `now` is their current time in epoch
    * milliseconds and `offsetMs` how far it runs ahead of real time: a test member's clock moves
    * when the staging toolbar or `domino test-members advance` moves it, and every other member's
-   * offset is 0. `memberTime()` keeps it ticking. Absent from a Relay older than this field.
+   * offset is 0. `memberTime()` keeps it ticking. Absent from a Relay older than this field;
+   * `relay.me.get()` then answers real time.
    */
   clock: z.object({
     now: z.number().int().nonnegative(),

package/dist/{chunk-7A4J67ZL.js → chunk-XNKSSE32.js}

@@ -8,7 +8,7 @@ import {
   rewardBundleSchema,
   settingsValuesSchema,
   trackerTriggerContextSchema
-} from "./chunk-ZDJLPN4L.js";
+} from "./chunk-MK425RXJ.js";
 
 // src/server/attempt-captures.ts
 import * as z from "zod";

package/dist/{chunk-QEAS4ZGS.js → chunk-Y322OTCH.js}

@@ -2,7 +2,7 @@ import {
   RelayErrorCode,
   clientError,
   isRequestError
-} from "./chunk-ZDJLPN4L.js";
+} from "./chunk-K2KS3JLY.js";
 
 // src/action.ts
 function withActionId(value) {

package/dist/{client-C51w7fMb.d.ts → client-B-hbHX30.d.ts}

@@ -1,12 +1,14 @@
-import { m as QuizEvidence, A as Attempt, M as MemberProgress, a as AttemptStatus, o as TrackerSkipCode, i as PointHistoryQuery, g as PointEntryKind, ao as submitSchema, ap as contentPerformanceQuerySchema } from './schema-CZ6Rj0ZF.js';
-import { l as QuestView, m as ResponseSchema, c as PageQuery, e as QuestEnrollmentInput, Q as QuestClaimInput, i as QuestOutcomeQuery, q as questExperienceSchema, a as CreatorAccountProvider, n as RewardDeliveryQuery, o as RewardDeliveryAction, r as contentQualificationQuerySchema } from './pages-K7-KjSXw.js';
-import { M as MissingPrerequisite, V as ValueEvidence } from './submission-input-C54Q8yAD.js';
-import { a as RequestError, b as RequestErrorDetails, c as RequestErrorKind, e as createRelayAction, O as OptionalActionId } from './action-DBzILFx9.js';
-import { b as ParticipantSession, e as exchangeSchema, R as RelayEvent, P as ParticipantActivity } from './participant-activity-DHL8QYks.js';
+import { G as QuizEvidence, a as Attempt, s as MemberProgress, ak as referralAcceptSchema, q as LeaderboardQuery, b as AttemptStatus, V as AttemptCodeSource, f as CampaignEnrollmentInput, h as CampaignWithdrawalInput, J as SignInProvider, c as AuthProvider, I as SignInAccountStatus, x as PointHistoryQuery, v as PointEntryKind, n as LeaderboardHistoryQuery, al as submitSchema, am as engagementPageQuerySchema, an as contentPerformanceQuerySchema } from './accounts-CCqCKCVx.js';
+import { q as ResponseSchema, i as PageQuery, k as QuestEnrollmentInput, Q as QuestClaimInput, n as QuestOutcomeQuery, M as MemberConsent, a as ConsentInput, e as CreatorAccountProvider, r as RewardDeliveryQuery, s as RewardDeliveryAction, t as contentQualificationQuerySchema } from './pages-B8q8Y_dQ.js';
+import { M as MissingPrerequisite, V as ValueEvidence } from './submission-input-DHGKhXfp.js';
+import { R as RequestError, a as RequestErrorDetails, b as RequestErrorKind } from './request-error-D_dUPLwo.js';
+import { b as QuestView, q as questExperienceSchema } from './catalog--ZIlskAo.js';
+import { T as TrackerSkipCode } from './tracker-data-Hb1uQnk5.js';
+import { b as ParticipantSession, e as exchangeSchema, R as RelayEvent, P as ParticipantActivity, M as MemberSummary } from './participant-activity-D-Drp24G.js';
 import * as z from 'zod';
-import { a as AuthProvider } from './accounts-DoabriBX.js';
-import { p as referralAcceptSchema, i as LeaderboardQuery, b as CampaignEnrollmentInput, d as CampaignWithdrawalInput, f as LeaderboardHistoryQuery, q as engagementPageQuerySchema } from './groups-CqcA2Ycs.js';
-import { ag as profileUpdateSchema, d as ProfileCompletionQuery, ah as walletAddressInputSchema, ai as walletSignatureSchema, L as LinkedWallet, m as WalletSigner } from './wallet-CIqFoxdm.js';
+import { c as createRelayAction, O as OptionalActionId } from './action-9Xl0StBg.js';
+import { A as AuthProviders } from './sign-in-providers-BkjcDsFF.js';
+import { ag as profileUpdateSchema, d as ProfileCompletionQuery, ah as walletAddressInputSchema, ai as walletSignatureSchema, L as LinkedWallet, m as WalletSigner } from './wallet-DTO7SXj7.js';
 
 /** What happened, as in every Domino client error (see `RequestError`). */
 type RelayErrorKind = RequestErrorKind;
@@ -336,12 +338,12 @@ type RelayClientOptions = {
 };
 /**
  * What `auth.start` takes: the provider, and whether to sign in (or sign up) or link it to the
- * signed-in member.
+ * signed-in member. `provider` is any of `providers().signInProviders`, Telegram included.
  *
  * @compat input
  */
 type AuthStartInput = {
-    provider: AuthProvider;
+    provider: SignInProvider;
     mode: "sign-in" | "connect";
 };
 /**
@@ -1175,6 +1177,11 @@ declare function relayClient(options: RelayClientOptions): {
         }[]>;
     };
     badges: {
+        /**
+         * The project's active badge catalog, as an array.
+         *
+         * @deprecated Use `catalog`, which answers `{ items }` like `me.badges`. Removed in 2.0.0.
+         */
         list: (options?: RelayRequestOptions) => Promise<{
             name: string;
             description: string;
@@ -1182,6 +1189,19 @@ declare function relayClient(options: RelayClientOptions): {
             id: string;
             key: string | null;
         }[]>;
+        /**
+         * The project's active badge catalog, oldest definition first, in `items`. Archived badges
+         * are left out. Open to signed-out visitors.
+         */
+        catalog: (options?: RelayRequestOptions) => Promise<{
+            items: {
+                name: string;
+                description: string;
+                image: string;
+                id: string;
+                key: string | null;
+            }[];
+        }>;
     };
     pointLedgers: {
         /**
@@ -1237,6 +1257,7 @@ declare function relayClient(options: RelayClientOptions): {
             key?: string | undefined;
             group?: string | undefined;
             includeUnscored?: boolean | undefined;
+            ties?: "shared" | "earliest" | undefined;
             settle?: {
                 at: "window-end";
                 ties: "shared" | "earliest";
@@ -1739,6 +1760,7 @@ declare function relayClient(options: RelayClientOptions): {
                 kind: "once";
             } | {
                 kind: "keyed";
+                across?: "members" | undefined;
             };
             progress: {
                 current: number;
@@ -1860,6 +1882,7 @@ declare function relayClient(options: RelayClientOptions): {
                     };
                     release?: string | undefined;
                 } | undefined;
+                codeSource?: AttemptCodeSource | null | undefined;
             } | null;
             release: string;
             interaction: "url" | "text" | "staff" | "claim" | "automatic" | "quiz" | "photo";
@@ -2086,6 +2109,7 @@ declare function relayClient(options: RelayClientOptions): {
                 };
                 release?: string | undefined;
             } | undefined;
+            codeSource?: AttemptCodeSource | null | undefined;
         }>;
         experience: (requestOptions?: RelayRequestOptions) => Promise<{
             entitlements: ({
@@ -2427,6 +2451,7 @@ declare function relayClient(options: RelayClientOptions): {
                     kind: "once";
                 } | {
                     kind: "keyed";
+                    across?: "members" | undefined;
                 };
                 progress: {
                     current: number;
@@ -2548,6 +2573,7 @@ declare function relayClient(options: RelayClientOptions): {
                         };
                         release?: string | undefined;
                     } | undefined;
+                    codeSource?: AttemptCodeSource | null | undefined;
                 } | null;
                 release: string;
                 interaction: "url" | "text" | "staff" | "claim" | "automatic" | "quiz" | "photo";
@@ -2841,6 +2867,7 @@ declare function relayClient(options: RelayClientOptions): {
                         kind: "once";
                     } | {
                         kind: "keyed";
+                        across?: "members" | undefined;
                     };
                     progress: {
                         current: number;
@@ -2962,6 +2989,7 @@ declare function relayClient(options: RelayClientOptions): {
                             };
                             release?: string | undefined;
                         } | undefined;
+                        codeSource?: AttemptCodeSource | null | undefined;
                     } | null;
                     release: string;
                     interaction: "url" | "text" | "staff" | "claim" | "automatic" | "quiz" | "photo";
@@ -3261,6 +3289,7 @@ declare function relayClient(options: RelayClientOptions): {
                     kind: "once";
                 } | {
                     kind: "keyed";
+                    across?: "members" | undefined;
                 };
                 progress: {
                     current: number;
@@ -3382,6 +3411,7 @@ declare function relayClient(options: RelayClientOptions): {
                         };
                         release?: string | undefined;
                     } | undefined;
+                    codeSource?: AttemptCodeSource | null | undefined;
                 } | null;
                 release: string;
                 interaction: "url" | "text" | "staff" | "claim" | "automatic" | "quiz" | "photo";
@@ -3518,6 +3548,25 @@ declare function relayClient(options: RelayClientOptions): {
             withdrawalReason: string | null;
         }>;
     };
+    /**
+     * The signed-in member's marketing consent, per channel. The app shows the checkbox and sends
+     * the wording beside it; Relay records the choice with its own time, and only members who
+     * opted in reach the project's destinations.
+     *
+     * @experimental A minor release can change the consent API.
+     */
+    consent: {
+        /**
+         * The member's current consent on each channel they chose on. A channel missing from the
+         * list has no record, which is not the same as withdrawn.
+         */
+        get: (requestOptions?: RelayRequestOptions) => Promise<MemberConsent[]>;
+        /**
+         * Grants (`granted: true`, with the `wording` the member saw) or withdraws one channel.
+         * Repeating the current state and wording records nothing and answers the current state.
+         */
+        set: (value: OptionalActionId<ConsentInput>, requestOptions?: RelayRequestOptions) => Promise<MemberConsent>;
+    };
     /** The signed-in member's linked Solana, EVM and Cosmos wallets for this project. */
     wallets: {
         list: (requestOptions?: RelayRequestOptions) => Promise<{
@@ -3564,19 +3613,7 @@ declare function relayClient(options: RelayClientOptions): {
         }>;
     };
     auth: {
-        providers: (requestOptions?: RelayRequestOptions) => Promise<{
-            providers: {
-                provider: "discord" | "google" | "apple" | "x";
-                configured: boolean;
-            }[];
-            email: boolean;
-            wallets: ("solana" | "eip155" | "cosmos")[];
-            demo: boolean;
-            telegram?: {
-                login: boolean;
-                miniApp: boolean;
-            } | undefined;
-        }>;
+        providers: (requestOptions?: RelayRequestOptions) => Promise<AuthProviders>;
         start: {
             (start: AuthStartInput, requestOptions?: RelayRequestOptions): Promise<{
                 url: string;
@@ -3653,17 +3690,24 @@ declare function relayClient(options: RelayClientOptions): {
         };
         /**
          * Telegram sign-in and the member's Telegram account. Telegram is not an `AuthProvider` in
-         * SDK 1.x, so `accounts()`, `start()` and `disconnect()` leave it out and these take its place.
+         * SDK 1.x, so `accounts()` leaves it out; `signInAccounts()`, `start()` and `disconnect()`
+         * take it like any other sign-in provider. Mini App sign-in is Telegram's own.
          */
         telegram: {
             /**
              * Leaves for Telegram Login when the platform configured it (`providers().telegram.login`):
              * `"sign-in"` signs in, or signs up; `"connect"` links Telegram to the signed-in member.
+             *
+             * @deprecated Use `auth.start({ provider: "telegram", mode })`. Removed in 2.0.0.
              */
             start: (mode: "sign-in" | "connect", requestOptions?: RelayRequestOptions) => Promise<{
                 url: string;
             }>;
-            /** The member's Telegram account. */
+            /**
+             * The member's Telegram account.
+             *
+             * @deprecated Use the `"telegram"` entry of `auth.signInAccounts()`. Removed in 2.0.0.
+             */
             account: (requestOptions?: RelayRequestOptions) => Promise<{
                 configured: boolean;
                 status: "disconnected" | "connected" | "reconnect";
@@ -3671,7 +3715,11 @@ declare function relayClient(options: RelayClientOptions): {
                 revision: number;
                 provider: "telegram";
             }>;
-            /** Unlinks the member's Telegram account, as `disconnect()` does for the other providers. */
+            /**
+             * Unlinks the member's Telegram account, as `disconnect()` does for the other providers.
+             *
+             * @deprecated Use `auth.disconnect("telegram")`. Removed in 2.0.0.
+             */
             disconnect: (requestOptions?: RelayRequestOptions) => Promise<{
                 ok: boolean;
             }>;
@@ -3680,6 +3728,9 @@ declare function relayClient(options: RelayClientOptions): {
              * (`providers().telegram.miniApp`). Pass the Mini App's signed launch data,
              * `telegramMiniAppInitData()`. Relay checks Telegram's signature for the project's bot and
              * accepts launch data at most five minutes old, once.
+             *
+             * @deprecated Use `relay.telegram.miniApp` from `@domino-sdk/relay/telegram`
+             * (`withTelegram(relay)`). Removed in 2.0.0.
              */
             miniApp: {
                 /** Signs in, or signs up, as the Telegram user who opened the Mini App. */
@@ -3742,7 +3793,7 @@ declare function relayClient(options: RelayClientOptions): {
                 ok: boolean;
             }>;
         };
-        /** The member's connected sign-in accounts, one per provider. */
+        /** The member's connected sign-in accounts, one per `AuthProvider`. */
         accounts: (requestOptions?: RelayRequestOptions) => Promise<{
             provider: "discord" | "google" | "apple" | "x";
             configured: boolean;
@@ -3750,7 +3801,19 @@ declare function relayClient(options: RelayClientOptions): {
             subject: string | null;
             revision: number;
         }[]>;
-        disconnect: (provider: AuthProvider, requestOptions?: RelayRequestOptions) => Promise<{
+        /**
+         * The member's account on every sign-in provider the platform has, one entry each, Telegram
+         * included: `accounts()` with an open `provider`, as `providers().signInProviders` lists them.
+         */
+        signInAccounts: (requestOptions?: RelayRequestOptions) => Promise<{
+            provider: SignInProvider;
+            configured: boolean;
+            status: SignInAccountStatus;
+            subject: string | null;
+            revision: number;
+        }[]>;
+        /** Unlinks the member's account on `provider`, any of `signInAccounts()`'s. */
+        disconnect: (provider: SignInProvider, requestOptions?: RelayRequestOptions) => Promise<{
             ok: boolean;
         }>;
         session: (requestOptions?: RelayRequestOptions) => Promise<{
@@ -3775,7 +3838,13 @@ declare function relayClient(options: RelayClientOptions): {
         signOut: (requestOptions?: RelayRequestOptions) => Promise<{
             ok: boolean;
         }>;
-        /** Local development only. Existing hosted apps use createParticipantBackend from /portal-proxy. */
+        /**
+         * @deprecated `POST /v1/auth/exchange` refuses this body with 400: the route takes
+         * `{ subject, accounts?, previousToken? }` with an identity integration server key as the
+         * bearer, which a participant client does not hold. A server signs a user in with
+         * `exchangeParticipant` from `@domino-sdk/relay/portal-proxy`; a hosted app proxies with
+         * `createParticipantBackend` from the same entry. Removed in 2.0.0.
+         */
         exchange: (value: z.input<typeof exchangeSchema>, requestOptions?: RelayRequestOptions) => Promise<{
             token: string;
             session: {
@@ -3811,6 +3880,12 @@ declare function relayClient(options: RelayClientOptions): {
             }[];
         }>;
         activity: {
+            /**
+             * One page of the signed-in member's activity feed, oldest event first. A feed never
+             * ends: every page, even an empty one, answers a `nextCursor` to read from next, so a
+             * loop such as `paginate` never finishes on its own. Stop when a page comes back empty
+             * or after as many events as you need, or follow the feed with `observe`.
+             */
             list: (query?: {
                 cursor?: string;
                 start?: "latest";
@@ -3899,16 +3974,7 @@ declare function relayClient(options: RelayClientOptions): {
          * The signed-in member, the seed of their generated avatar (`defaultAvatar(avatarSeed)`), and
          * their own verified sign-in email addresses: `email` (or null) and `emails`.
          */
-        get: (requestOptions?: RelayRequestOptions) => Promise<{
-            member: string;
-            avatarSeed: string;
-            email?: string | null | undefined;
-            emails?: string[] | undefined;
-            clock?: {
-                now: number;
-                offsetMs: number;
-            } | undefined;
-        }>;
+        get: (requestOptions?: RelayRequestOptions) => Promise<MemberSummary>;
         observeProgress: (listener: (value: ProgressObservation) => void, observeOptions?: {
             intervalMs?: number;
             maxBackoffMs?: number;
@@ -4141,6 +4207,7 @@ declare function relayClient(options: RelayClientOptions): {
                     kind: "once";
                 } | {
                     kind: "keyed";
+                    across?: "members" | undefined;
                 };
                 progress: {
                     current: number;
@@ -4262,6 +4329,7 @@ declare function relayClient(options: RelayClientOptions): {
                         };
                         release?: string | undefined;
                     } | undefined;
+                    codeSource?: AttemptCodeSource | null | undefined;
                 } | null;
                 key?: string | undefined;
                 release?: string | undefined;
@@ -4534,7 +4602,7 @@ declare function relayClient(options: RelayClientOptions): {
                 revokedAt?: number | null | undefined;
                 reconciliation?: {
                     status: "pending" | "removed" | "failed" | "preserved" | "granted";
-                    ownership: "external" | "unclaimed" | "relay";
+                    ownership: "external" | "relay" | "unclaimed";
                     at: number;
                     reason: string | null;
                 } | null | undefined;
@@ -4661,6 +4729,7 @@ declare function relayClient(options: RelayClientOptions): {
                 };
                 release?: string | undefined;
             } | undefined;
+            codeSource?: AttemptCodeSource | null | undefined;
         }>;
         /** Uploads evidence with a generated key; reuse `actionId` and the same file to replay. */
         upload: (file: Blob, requestOptions?: RelayRequestOptions & {