@domino-sdk/relay 1.7.0 → 1.10.0

package/dist/react/index.d.ts

@@ -1,18 +1,20 @@
 import { b as ParticipantSession, R as RelayEvent, P as ParticipantActivity, M as MemberSummary } from '../participant-activity-DkL3nY5a.js';
-import { g as RelayError, R as RelayClient, S as SubmissionDraft } from '../client-pfml_XAa.js';
-import { P as Page, j as QuestView, g as QuestOutcomeQuery, e as QuestOutcome } from '../pages-CixTNnF4.js';
+import { g as RelayError, R as RelayClient, S as SubmissionDraft } from '../client-Yq11HA_f.js';
+import { P as Page, j as QuestView, g as QuestOutcomeQuery, e as QuestOutcome } from '../pages-D00JDZB-.js';
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { E as Entitlement, a as AttemptStatus, T as TieredRewardReference } from '../schema-CQydLqw4.js';
-import { a as AuthProvider, A as AccountConnection } from '../submission-input-CLefHTrj.js';
-import { c as SignInMethods, C as CosmosChains, d as SignInOption, f as SignInUnavailable, g as SignInWallet, D as DiscoveredWallet } from '../sign-in-options-CtXUFV7E.js';
-export { a as EmailSignInOption, O as OAuthSignInOption, b as SignInIcon, W as WalletSignInOption } from '../sign-in-options-CtXUFV7E.js';
-import { f as WalletSigner, d as WalletSignInNetwork, L as LinkedWallet } from '../wallet-YssWxGg8.js';
-import { f as LeaderboardPlacement, b5 as referralSummarySchema, e as LeaderboardPage, i as PointBalances, j as PointEntry, n as PointLedgerReference } from '../groups-BpWEqaPn.js';
-import { f as ProfileUpdate, e as ProfileSummary, a as ProfileCompletion, d as ProfileReferral } from '../profiles-D2aFcOxu.js';
+import { J as JSONType } from '../util.d-w9f9t3ua.js';
+import { E as Entitlement, a as AttemptStatus, T as TieredRewardReference } from '../schema-DEM8y8Fm.js';
+import { a as AuthProvider, A as AccountConnection } from '../submission-input-BbBJTVlT.js';
+import { c as SignInMethods, C as CosmosChains, d as SignInOption, f as SignInUnavailable, g as SignInWallet, D as DiscoveredWallet } from '../sign-in-options-Coim0G1u.js';
+export { a as EmailSignInOption, O as OAuthSignInOption, b as SignInIcon, W as WalletSignInOption } from '../sign-in-options-Coim0G1u.js';
+import { f as WalletSigner, d as WalletSignInNetwork, L as LinkedWallet } from '../wallet-CDyo-U4n.js';
+import { f as LeaderboardPlacement, b7 as referralSummarySchema, e as LeaderboardPage, i as PointBalances, j as PointEntry, n as PointLedgerReference } from '../groups-BK8ts2yK.js';
+import { f as ProfileUpdate, e as ProfileSummary, a as ProfileCompletion, d as ProfileReferral } from '../profiles-BHMVj0kM.js';
 import { z } from 'zod';
-import { O as Offer, c as Redemption } from '../offers-CYtal8jO.js';
+import { O as Offer } from '../offers-C2FANzrG.js';
 import '../request-error-D_dUPLwo.js';
+import '../action-9Xl0StBg.js';
 
 /**
  * A query's identity: plain JSON values, outermost group first, such as
@@ -143,6 +145,26 @@ declare function useActivity(options?: {
     intervalMs?: number;
 }): MemberQuery<ParticipantActivity>;
 
+type RelayActionResult<T> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+};
+/**
+ * One logical mutation at a time, with a key and exact callback retained across uncertain errors.
+ * `run` and `retry` never reject; their result distinguishes success from failure, including a
+ * successful null value. A failure appears in `error`. Pass a client or
+ * session as `scope` to isolate actions when the signed-in member or project changes.
+ */
+declare function useRelayAction<T = unknown>(scope?: unknown): {
+    run: (task?: (actionId: string) => Promise<T>) => Promise<RelayActionResult<T>>;
+    retry: () => Promise<RelayActionResult<T>>;
+    settle: () => boolean;
+    busy: boolean;
+    error: RelayError | null;
+};
+
 type Collection = {
     id: string;
     /** The collection's authoring key, when it has one. */
@@ -217,10 +239,6 @@ declare const relayKeys: {
     readonly offers: readonly ["offers"];
 };
 
-type JSONType = string | number | boolean | null | JSONType[] | {
-    [key: string]: JSONType;
-};
-
 /** Earned tiers and pickup/collection state, scoped to the current session. */
 declare function useEntitlements(options?: QueryOptions): MemberQuery<{
     items: ({
@@ -754,7 +772,7 @@ declare function useQuest(observed: QuestView): {
         };
         availability: {
             kind: "available";
-            input: "text" | "none" | "url" | "quiz" | "photo";
+            input: "url" | "text" | "none" | "quiz" | "photo";
         } | {
             kind: "completed";
         } | {
@@ -947,7 +965,7 @@ declare function useQuest(observed: QuestView): {
             } | undefined;
         } | null;
         release: string;
-        interaction: "text" | "staff" | "claim" | "automatic" | "url" | "quiz" | "photo";
+        interaction: "url" | "text" | "staff" | "claim" | "automatic" | "quiz" | "photo";
         lifecycle: "paused" | "active" | "archived";
         rewards: ({
             kind: "points";
@@ -1226,6 +1244,8 @@ declare function useAccounts(): {
     disconnect: (provider: AuthProvider) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     isConnected: (provider: AuthProvider) => boolean;
     status: "loading";
     data: undefined;
@@ -1236,6 +1256,8 @@ declare function useAccounts(): {
     disconnect: (provider: AuthProvider) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     isConnected: (provider: AuthProvider) => boolean;
     status: "error";
     data: undefined;
@@ -1246,6 +1268,8 @@ declare function useAccounts(): {
     disconnect: (provider: AuthProvider) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     isConnected: (provider: AuthProvider) => boolean;
     status: "signed-out";
     data: undefined;
@@ -1256,6 +1280,8 @@ declare function useAccounts(): {
     disconnect: (provider: AuthProvider) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     isConnected: (provider: AuthProvider) => boolean;
     status: "ready";
     data: {
@@ -1283,6 +1309,8 @@ declare function useWallets(): {
     unlink: (wallet: Pick<LinkedWallet, "chain" | "address">) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "loading";
     data: undefined;
     error: null;
@@ -1293,6 +1321,8 @@ declare function useWallets(): {
     unlink: (wallet: Pick<LinkedWallet, "chain" | "address">) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "error";
     data: undefined;
     error: RelayError;
@@ -1303,6 +1333,8 @@ declare function useWallets(): {
     unlink: (wallet: Pick<LinkedWallet, "chain" | "address">) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "signed-out";
     data: undefined;
     error: null;
@@ -1313,6 +1345,8 @@ declare function useWallets(): {
     unlink: (wallet: Pick<LinkedWallet, "chain" | "address">) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "ready";
     data: {
         chain: "solana" | "eip155" | "cosmos";
@@ -1367,6 +1401,8 @@ declare function useMyProfile(): {
     uploadAvatar: (file: Blob) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "loading";
     data: undefined;
     error: null;
@@ -1377,6 +1413,8 @@ declare function useMyProfile(): {
     uploadAvatar: (file: Blob) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "error";
     data: undefined;
     error: RelayError;
@@ -1387,6 +1425,8 @@ declare function useMyProfile(): {
     uploadAvatar: (file: Blob) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "signed-out";
     data: undefined;
     error: null;
@@ -1397,6 +1437,8 @@ declare function useMyProfile(): {
     uploadAvatar: (file: Blob) => Promise<boolean>;
     busy: boolean;
     actionError: RelayError | null;
+    retry: () => Promise<boolean>;
+    settle: () => boolean;
     status: "ready";
     data: {
         id: string;
@@ -1419,7 +1461,7 @@ declare function useMyProfile(): {
         avatarProvider: "discord" | "x" | "google" | null;
         hidden: boolean;
         locked: boolean;
-        visibility: "private" | "participants" | "public";
+        visibility: "public" | "private" | "participants";
         options: {
             provider: "discord" | "x" | "google";
             name: string | null;
@@ -1562,7 +1604,149 @@ declare function useQuestOutcomes(query?: Omit<QuestOutcomeQuery, "cursor">): Me
 declare function useOffers(): Query<Offer[]>;
 /** Redeem an offer, then refresh offers and point balances. */
 declare function useRedeemOffer(): {
-    redeem: (offer: string) => Promise<Redemption | null>;
+    redeem: (offer: string) => Promise<{
+        status: "fulfilled";
+        id: string;
+        offer: string;
+        member: string;
+        reservation: string;
+        price: {
+            kind: "points";
+            balance: string;
+            amount: number;
+        };
+        reward: {
+            kind: "tier";
+            reward: {
+                id: string;
+                title: string;
+                tiers: {
+                    id: string;
+                    title: string;
+                }[];
+                inventory: {
+                    kind: "untracked";
+                };
+                fulfillment: {
+                    kind: "staff-handover";
+                } | {
+                    kind: "automatic";
+                };
+            };
+            tier: string;
+        };
+        entitlement: string;
+        revision: number;
+        redeemedAt: number;
+    } | {
+        status: "canceled";
+        canceledAt: number;
+        reason: string;
+        id: string;
+        offer: string;
+        member: string;
+        reservation: string;
+        price: {
+            kind: "points";
+            balance: string;
+            amount: number;
+        };
+        reward: {
+            kind: "tier";
+            reward: {
+                id: string;
+                title: string;
+                tiers: {
+                    id: string;
+                    title: string;
+                }[];
+                inventory: {
+                    kind: "untracked";
+                };
+                fulfillment: {
+                    kind: "staff-handover";
+                } | {
+                    kind: "automatic";
+                };
+            };
+            tier: string;
+        };
+        entitlement: string;
+        revision: number;
+        redeemedAt: number;
+    } | null>;
+    retry: () => Promise<{
+        status: "fulfilled";
+        id: string;
+        offer: string;
+        member: string;
+        reservation: string;
+        price: {
+            kind: "points";
+            balance: string;
+            amount: number;
+        };
+        reward: {
+            kind: "tier";
+            reward: {
+                id: string;
+                title: string;
+                tiers: {
+                    id: string;
+                    title: string;
+                }[];
+                inventory: {
+                    kind: "untracked";
+                };
+                fulfillment: {
+                    kind: "staff-handover";
+                } | {
+                    kind: "automatic";
+                };
+            };
+            tier: string;
+        };
+        entitlement: string;
+        revision: number;
+        redeemedAt: number;
+    } | {
+        status: "canceled";
+        canceledAt: number;
+        reason: string;
+        id: string;
+        offer: string;
+        member: string;
+        reservation: string;
+        price: {
+            kind: "points";
+            balance: string;
+            amount: number;
+        };
+        reward: {
+            kind: "tier";
+            reward: {
+                id: string;
+                title: string;
+                tiers: {
+                    id: string;
+                    title: string;
+                }[];
+                inventory: {
+                    kind: "untracked";
+                };
+                fulfillment: {
+                    kind: "staff-handover";
+                } | {
+                    kind: "automatic";
+                };
+            };
+            tier: string;
+        };
+        entitlement: string;
+        revision: number;
+        redeemedAt: number;
+    } | null>;
+    settle: () => boolean;
     busy: boolean;
     error: RelayError | null;
 };
@@ -1584,4 +1768,4 @@ declare function usePointLedgers(): Query<PointLedgerReference[]>;
  */
 declare function useTieredRewards(): Query<TieredRewardReference[]>;
 
-export { type Collection, CosmosChains, DiscoveredWallet, type ExperienceData, type Invitation, type KnownQuestStatusCode, type KnownRoleDeliveryStatus, type MemberPagedQuery, type MemberQuery, type MemberSnapshot, type OAuthProvider, Page, type PageLoader, type PageRead, type PagedQuery, type Query, type QueryContext, type QueryKey, type QueryOptions, type QueryRead, type QuerySnapshot, type QuestInput, type QuestNotice, type QuestStatus, type QuestStatusCode, type QuestStatusText, type QuestTone, type ReferralSummary, RelayClient, RelayProvider, type RoleDelivery, type RoleDeliveryStatus, type SavedSubmission, SignInMethods, SignInOption, SignInUnavailable, SignInWallet, canRepeat, canSubmit, captureReferralCode, completionCountText, isAutomatic, isConnected, isFinished, progressOf, questGroups, questStatus, questStatusText, relayKeys, roleDeliveryLabel, roleDeliveryStatus, useAccounts, useActivity, useBalances, useDeliveries, useEntitlements, useExperience, useInvalidate, useInvitation, useLeaderboard, useLeaderboardPlacement, useMe, useMemberPages, useMemberQuery, useMyProfile, useOffers, usePointHistory, usePointLedgers, useProfile, useProfileCompletions, useProfileReferral, useQuest, useQuestOutcomes, useRedeemOffer, useReferralSummary, useRelay, useRelayPages, useRelayQuery, useSession, useSignIn, useSignInMethods, useSignInOptions, useSignInWallets, useSignOut, useTieredRewards, useWalletDiscovery, useWallets };
+export { type Collection, CosmosChains, DiscoveredWallet, type ExperienceData, type Invitation, type KnownQuestStatusCode, type KnownRoleDeliveryStatus, type MemberPagedQuery, type MemberQuery, type MemberSnapshot, type OAuthProvider, Page, type PageLoader, type PageRead, type PagedQuery, type Query, type QueryContext, type QueryKey, type QueryOptions, type QueryRead, type QuerySnapshot, type QuestInput, type QuestNotice, type QuestStatus, type QuestStatusCode, type QuestStatusText, type QuestTone, type ReferralSummary, type RelayActionResult, RelayClient, RelayProvider, type RoleDelivery, type RoleDeliveryStatus, type SavedSubmission, SignInMethods, SignInOption, SignInUnavailable, SignInWallet, canRepeat, canSubmit, captureReferralCode, completionCountText, isAutomatic, isConnected, isFinished, progressOf, questGroups, questStatus, questStatusText, relayKeys, roleDeliveryLabel, roleDeliveryStatus, useAccounts, useActivity, useBalances, useDeliveries, useEntitlements, useExperience, useInvalidate, useInvitation, useLeaderboard, useLeaderboardPlacement, useMe, useMemberPages, useMemberQuery, useMyProfile, useOffers, usePointHistory, usePointLedgers, useProfile, useProfileCompletions, useProfileReferral, useQuest, useQuestOutcomes, useRedeemOffer, useReferralSummary, useRelay, useRelayAction, useRelayPages, useRelayQuery, useSession, useSignIn, useSignInMethods, useSignInOptions, useSignInWallets, useSignOut, useTieredRewards, useWalletDiscovery, useWallets };