@domino-sdk/relay 1.24.0 → 1.29.0

package/dist/{client-HG0uMG0Q.d.ts → client-D4WMWeWC.d.ts}

@@ -1,13 +1,13 @@
-import { aZ as referralAcceptSchema, g as LeaderboardQuery, b as CampaignEnrollmentInput, d as CampaignWithdrawalInput, m as PointHistoryQuery, k as PointEntryKind, a6 as engagementPageQuerySchema } from './groups-CfyRewkJ.js';
-import { j as QuestView, k as ResponseSchema, a as PageQuery, c as QuestEnrollmentInput, Q as QuestClaimInput, g as QuestOutcomeQuery, _ as questExperienceSchema, l as RewardDeliveryAction, F as contentQualificationQuerySchema } from './pages-D1xrbGJl.js';
-import { M as MissingPrerequisite, V as ValueEvidence } from './submission-input-DjXg0o-r.js';
+import { b0 as referralAcceptSchema, g as LeaderboardQuery, b as CampaignEnrollmentInput, d as CampaignWithdrawalInput, m as PointHistoryQuery, k as PointEntryKind, a7 as engagementPageQuerySchema } from './groups-BNUhmxYY.js';
+import { j as QuestView, k as ResponseSchema, a as PageQuery, c as QuestEnrollmentInput, Q as QuestClaimInput, g as QuestOutcomeQuery, $ as questExperienceSchema, l as RewardDeliveryAction, G as contentQualificationQuerySchema } from './pages-BUmWkUu2.js';
+import { M as MissingPrerequisite, V as ValueEvidence } from './submission-input-DdvTz7ac.js';
 import { a as RequestError, b as RequestErrorDetails, c as RequestErrorKind, e as createRelayAction, O as OptionalActionId } from './action-DBzILFx9.js';
-import { f as QuizEvidence, A as Attempt, M as MemberProgress, a as AttemptStatus, h as TrackerSkipCode, cg as submitSchema, be as contentPerformanceQuerySchema } from './schema-D57mhL2q.js';
-import { b as ParticipantSession, d as exchangeSchema, R as RelayEvent, P as ParticipantActivity } from './participant-activity-DYdUUhw2.js';
-import { z } from 'zod';
-import { a as AuthProvider } from './accounts-B31dWEYD.js';
-import { F as profileUpdateSchema, c as ProfileCompletionQuery } from './profiles-D29SS12z.js';
-import { y as walletAddressInputSchema, I as walletSignatureSchema, L as LinkedWallet, f as WalletSigner } from './wallet-CDyo-U4n.js';
+import { f as QuizEvidence, A as Attempt, M as MemberProgress, a as AttemptStatus, h as TrackerSkipCode, co as submitSchema, bj as contentPerformanceQuerySchema } from './schema-lmOnv5C5.js';
+import { b as ParticipantSession, d as exchangeSchema, R as RelayEvent, P as ParticipantActivity } from './participant-activity-BPZiW7m7.js';
+import * as z from 'zod';
+import { a as AuthProvider } from './accounts-DRPENuZe.js';
+import { F as profileUpdateSchema, c as ProfileCompletionQuery } from './profiles-BHuQdzsW.js';
+import { y as walletAddressInputSchema, I as walletSignatureSchema, L as LinkedWallet, f as WalletSigner } from './wallet-t7uNDg9p.js';
 
 /** What happened, as in every Domino client error (see `RequestError`). */
 type RelayErrorKind = RequestErrorKind;
@@ -45,6 +45,11 @@ declare const RelayErrorCode: {
     readonly SubmissionStorageQuota: "submission-storage-quota";
     /** The saved submission is in a state that does not allow this action. */
     readonly SubmissionConflict: "submission-conflict";
+    /**
+     * The saved submission's operation belongs to a retired contract and cannot continue. Show the
+     * current quest and let the member `discard()` it before submitting again.
+     */
+    readonly OperationRetired: "operation-retired";
     /** The quest changed since the member saw it; review it before submitting again. */
     readonly QuestUpdated: "quest-updated";
     /** Wait for the deferred attempt before submitting another action. */
@@ -75,6 +80,8 @@ declare const RelayErrorCode: {
     readonly OfferOutOfStock: "offer-out-of-stock";
     /** The participant's available point balance is below the offer price. */
     readonly InsufficientPoints: "insufficient-points";
+    /** The client's `getToken` failed before anything was sent; `cause` is its own error. */
+    readonly Credential: "credential";
     /** A wallet signer failed or the member refused to sign; `cause` is the wallet's own error. */
     readonly WalletSigner: "wallet-signer";
     /** The member has not met the quest's prerequisites; `missing` lists them. */
@@ -135,27 +142,50 @@ type SubmissionStatus = {
     kind: "submitted";
     attempt: string;
 };
+/**
+ * Cancellation and a deadline for one submission call, which may read the session, upload, claim
+ * and retry. A cancelled or timed-out call keeps its saved progress: `resume()` continues it, and
+ * a write already sent stays `uncertain`, as with any call.
+ *
+ * @compat input
+ */
+type SubmissionCallOptions = {
+    /** Cancels the call, which rejects with a `RelayError` of kind `aborted`. */
+    signal?: AbortSignal;
+    /**
+     * The whole call's deadline in milliseconds, covering every request it sends. Without it each
+     * request has the client's `timeout`.
+     */
+    timeout?: number;
+};
 type Handle = {
-    status(): Promise<SubmissionStatus>;
-    resume(): Promise<Attempt>;
-    discard(): Promise<void>;
+    status(options?: SubmissionCallOptions): Promise<SubmissionStatus>;
+    resume(options?: SubmissionCallOptions): Promise<Attempt>;
+    discard(options?: SubmissionCallOptions): Promise<void>;
 };
+/** @compat sealed */
 type PhotoSubmission = Handle & {
-    submit(file: File): Promise<Attempt>;
+    submit(file: File, options?: SubmissionCallOptions): Promise<Attempt>;
 };
+/** @compat sealed */
 type QuizSubmission = Handle & {
     submit(answers: QuizEvidence["answers"], options?: {
-        release: string;
-    }): Promise<Attempt>;
+        release?: string;
+    } & SubmissionCallOptions): Promise<Attempt>;
 };
+/** @compat sealed */
 type ValueSubmission = Handle & {
-    submit(value: string): Promise<Attempt>;
+    submit(value: string, options?: SubmissionCallOptions): Promise<Attempt>;
 };
+/** @compat sealed */
 type ClaimSubmission = Handle & {
-    submit(): Promise<Attempt>;
+    submit(options?: SubmissionCallOptions): Promise<Attempt>;
 };
-/** Stores structured-clone values. Writes must finish durably before resolving.
- * exclusive must serialize all writers to a key, including across browser tabs. */
+/**
+ * Stores structured-clone values. Writes must finish durably before resolving. exclusive must
+ * serialize all writers to a key, including across browser tabs. Since Relay keeps submissions,
+ * the SDK only reads it to finish a submission an older SDK version saved.
+ */
 interface SubmissionStore {
     read(key: string): Promise<unknown>;
     write(key: string, value: unknown): Promise<void>;
@@ -190,26 +220,27 @@ type QuestActionResult = {
     originalDraft: SubmissionDraft | null;
     draft: SubmissionDraft | null;
 };
+/** Each method takes `signal` and `timeout` for the whole call, as a submission handle does. */
 type ActiveController = {
     view: QuestView;
-    status(): Promise<SubmissionStatus>;
-    resume(): Promise<QuestActionResult>;
-    discard(): Promise<void>;
+    status(options?: SubmissionCallOptions): Promise<SubmissionStatus>;
+    resume(options?: SubmissionCallOptions): Promise<QuestActionResult>;
+    discard(options?: SubmissionCallOptions): Promise<void>;
 };
 type QuestController = (ActiveController & {
     kind: "text" | "url";
-    submit(value: string): Promise<QuestActionResult>;
+    submit(value: string, options?: SubmissionCallOptions): Promise<QuestActionResult>;
 }) | (ActiveController & {
     kind: "status";
 }) | (ActiveController & {
     kind: "photo";
-    submit(file: File): Promise<QuestActionResult>;
+    submit(file: File, options?: SubmissionCallOptions): Promise<QuestActionResult>;
 }) | (ActiveController & {
     kind: "quiz";
-    submit(answers: Record<string, string>): Promise<QuestActionResult>;
+    submit(answers: Record<string, string>, options?: SubmissionCallOptions): Promise<QuestActionResult>;
 }) | (ActiveController & {
     kind: "claim";
-    submit(): Promise<QuestActionResult>;
+    submit(options?: SubmissionCallOptions): Promise<QuestActionResult>;
 });
 
 type ProgressObservation<T = MemberProgress> = {
@@ -256,7 +287,24 @@ type RelayRequestOptions = {
 /** @compat input */
 type RelayClientOptions = {
     baseUrl: string;
+    /** A bearer token sent with every call. Use `getToken` instead for one that changes. */
     token?: string;
+    /**
+     * Reads the bearer token before each attempt, within the call's deadline and signal; `null`
+     * sends none. A failure rejects the call with a `client` `RelayError` (kind `network` for a
+     * `TypeError`) whose code is `credential`, before anything is sent. Not with `token`.
+     */
+    getToken?: () => Promise<string | null>;
+    /**
+     * The `fetch` every call sends with, such as a test double, a proxy's or an edge runtime's own.
+     * Defaults to the global `fetch`.
+     */
+    fetch?: typeof fetch;
+    /**
+     * Headers sent with every call. The client's own headers (authorization, scope, session, CSRF
+     * and content type) replace one of the same name.
+     */
+    headers?: Record<string, string>;
     submissionStore?: SubmissionStore;
     organization?: string;
     project?: string;
@@ -267,6 +315,25 @@ type RelayClientOptions = {
      */
     timeout?: number;
 };
+/**
+ * What `auth.start` takes: the provider, and whether to sign in (or sign up) or link it to the
+ * signed-in member.
+ *
+ * @compat input
+ */
+type AuthStartInput = {
+    provider: AuthProvider;
+    mode: "sign-in" | "connect";
+};
+/**
+ * What `auth.emailVerify` takes: `emailStart`'s challenge and the code the member typed.
+ *
+ * @compat input
+ */
+type EmailVerification = {
+    challenge: string;
+    code: string;
+};
 /** @compat input */
 type RelayResponseOptions = RelayRequestOptions & {
     method?: "GET" | "POST";
@@ -338,7 +405,7 @@ declare function relayClient(options: RelayClientOptions): {
             key?: string | undefined;
         }[]>;
         /** Redeems one offer. Persist `actionId` to retry after an uncertain result. */
-        redeem: (offer: string, input?: {
+        redeem: (offer: string, value?: {
             actionId?: string;
         }, requestOptions?: RelayRequestOptions) => Promise<{
             status: "fulfilled";
@@ -3397,31 +3464,21 @@ declare function relayClient(options: RelayClientOptions): {
                 miniApp: boolean;
             } | undefined;
         }>;
-        start: (provider: AuthProvider, mode: "sign-in" | "connect", requestOptions?: RelayRequestOptions) => Promise<{
-            url: string;
-        }>;
+        start: {
+            (start: AuthStartInput, requestOptions?: RelayRequestOptions): Promise<{
+                url: string;
+            }>;
+            (provider: AuthProvider, mode: "sign-in" | "connect", requestOptions?: RelayRequestOptions): Promise<{
+                url: string;
+            }>;
+        };
         emailStart: (email: string, requestOptions?: RelayRequestOptions) => Promise<{
             challenge: string;
         }>;
-        emailVerify: (challenge: string, code: string, requestOptions?: RelayRequestOptions) => Promise<{
-            id: string;
-            principal: {
-                kind: "member";
-                member: string;
-            } | {
-                kind: "staff";
-                subject: string;
-            } | {
-                kind: "operator";
-                subject: string;
-            } | {
-                kind: string;
-            };
-            expiresAt: number;
-            organization: string;
-            project: string;
-            environment: "test" | "live";
-        }>;
+        emailVerify: {
+            (verification: EmailVerification, requestOptions?: RelayRequestOptions): Promise<ParticipantSession>;
+            (challenge: string, code: string, requestOptions?: RelayRequestOptions): Promise<ParticipantSession>;
+        };
         /**
          * Sign in, or sign up, with a Solana, EVM or Cosmos wallet where the project enabled it
          * (`providers().wallets`). A wallet the member linked while signed in cannot sign in.
@@ -3703,29 +3760,37 @@ declare function relayClient(options: RelayClientOptions): {
             retryMs?: number;
         }) => ProgressObserver;
         submission: {
-            (quest: string, options?: {
-                input: "photo";
+            (quest: string, options?: Omit<{
+                input: "photo" | "quiz" | "none" | "text" | "url";
                 release?: string;
                 recoverPrevious?: boolean;
                 repeatable?: boolean;
+            }, "input"> & {
+                input: "photo";
             }): Promise<PhotoSubmission>;
-            (quest: string, options: {
-                input: "quiz";
+            (quest: string, options: Omit<{
+                input: "photo" | "quiz" | "none" | "text" | "url";
                 release?: string;
                 recoverPrevious?: boolean;
                 repeatable?: boolean;
+            }, "input"> & {
+                input: "quiz";
             }): Promise<QuizSubmission>;
-            (quest: string, options: {
-                input: "none";
+            (quest: string, options: Omit<{
+                input: "photo" | "quiz" | "none" | "text" | "url";
                 release?: string;
                 recoverPrevious?: boolean;
                 repeatable?: boolean;
+            }, "input"> & {
+                input: "none";
             }): Promise<ClaimSubmission>;
-            (quest: string, options: {
-                input: "text" | "url";
+            (quest: string, options: Omit<{
+                input: "photo" | "quiz" | "none" | "text" | "url";
                 release?: string;
                 recoverPrevious?: boolean;
                 repeatable?: boolean;
+            }, "input"> & {
+                input: "text" | "url";
             }): Promise<ValueSubmission>;
         };
         collectionPass: (entitlement: string, requestOptions?: RelayRequestOptions) => Promise<{
@@ -4586,4 +4651,4 @@ declare function relayClient(options: RelayClientOptions): {
 interface RelayClient extends ReturnType<typeof relayClient> {
 }
 
-export { type ClaimSubmission as C, type KnownRelayErrorCode as K, type PhotoSubmission as P, type QuestActionResult as Q, type RelayClient as R, type SubmissionDraft as S, type ValueSubmission as V, type ProgressObservation as a, type ProgressObserver as b, type QuestController as c, QuestUpdatedError as d, type QuizSubmission as e, type RelayClientOptions as f, RelayError as g, RelayErrorCode as h, type RelayErrorDetails as i, type RelayErrorKind as j, type RelayRequestOptions as k, type RelayResponseOptions as l, type SubmissionStatus as m, type SubmissionStore as n, createRelayClient as o, isRelayError as p };
+export { type AuthStartInput as A, type ClaimSubmission as C, type EmailVerification as E, type KnownRelayErrorCode as K, type PhotoSubmission as P, type QuestActionResult as Q, type RelayClient as R, type SubmissionCallOptions as S, type ValueSubmission as V, type ProgressObservation as a, type ProgressObserver as b, type QuestController as c, QuestUpdatedError as d, type QuizSubmission as e, type RelayClientOptions as f, RelayError as g, RelayErrorCode as h, type RelayErrorDetails as i, type RelayErrorKind as j, type RelayRequestOptions as k, type RelayResponseOptions as l, type SubmissionDraft as m, type SubmissionStatus as n, type SubmissionStore as o, createRelayClient as p, isRelayError as q };