@domino-sdk/relay 1.54.0 → 1.55.0

package/dist/react/index.d.ts

@@ -1,20 +1,20 @@
-import { B as Badge, b as MemberBadges, O as Offer, e as Redemption } from '../offers-CH1RZekg.js';
+import { B as Badge, b as MemberBadges, O as Offer, e as Redemption } from '../offers-BMDNcvwB.js';
 import { b as ParticipantSession, R as RelayEvent, P as ParticipantActivity, M as MemberSummary } from '../participant-activity-iciCEs_8.js';
-import { g as RelayError, R as RelayClient, m as SubmissionDraft } from '../client-CzNtl8UO.js';
-import { P as Page, D as collectionViewSchema, j as QuestView, g as QuestOutcomeQuery, e as QuestOutcome } from '../pages-BTlOg8sl.js';
+import { g as RelayError, R as RelayClient, m as SubmissionDraft } from '../client-C4zUZKpj.js';
+import { P as Page, D as collectionViewSchema, j as QuestView, g as QuestOutcomeQuery, e as QuestOutcome } from '../pages-BFloMpyQ.js';
 import * as react from 'react';
 import { ReactNode } from 'react';
 import { J as JSONType } from '../util.d-w9f9t3ua.js';
 import { z } from 'zod';
-import { E as Entitlement, a as AttemptStatus, T as TieredRewardReference } from '../schema-BJ9bOgpN.js';
+import { E as Entitlement, a as AttemptStatus, f as PointEntry, e as PointBalances, j as PointLedgerReference, T as TieredRewardReference } from '../schema-C4m9RhCR.js';
 import { a as AuthProvider, A as AccountConnection } from '../accounts-DRPENuZe.js';
 export { T as TelegramAccountConnection, b as TelegramSignInMethods } from '../accounts-DRPENuZe.js';
-import { c as SignInMethods, C as CosmosChains, d as SignInOption, f as SignInUnavailable, T as TelegramSignInOption, g as SignInWallet, D as DiscoveredWallet } from '../telegram-browser-C36j_6v-.js';
-export { a as EmailSignInOption, O as OAuthSignInOption, b as SignInIcon, W as WalletSignInOption, t as telegramMiniAppInitData } from '../telegram-browser-C36j_6v-.js';
+import { c as SignInMethods, C as CosmosChains, d as SignInOption, f as SignInUnavailable, T as TelegramSignInOption, g as SignInWallet, D as DiscoveredWallet } from '../telegram-browser-CwaxROAZ.js';
+export { a as EmailSignInOption, O as OAuthSignInOption, b as SignInIcon, W as WalletSignInOption, t as telegramMiniAppInitData } from '../telegram-browser-CwaxROAZ.js';
 import { f as WalletSigner, d as WalletSignInNetwork, L as LinkedWallet } from '../wallet-Ac7OFpOr.js';
-import { h as LeaderboardPlacement, be as referralSummarySchema, g as LeaderboardPage, l as PointEntry, k as PointBalances, p as PointLedgerReference } from '../groups-B5R1RCsl.js';
-import { f as ProfileUpdate, e as ProfileSummary, a as ProfileCompletion, d as ProfileReferral } from '../profiles-Cdv4BSd_.js';
-import '../submission-input-BNah53go.js';
+import { h as LeaderboardPlacement, b0 as referralSummarySchema, g as LeaderboardPage } from '../groups-O6onGPmC.js';
+import { f as ProfileUpdate, e as ProfileSummary, a as ProfileCompletion, d as ProfileReferral } from '../profiles-BoOK03cR.js';
+import '../submission-input-BbdawqVy.js';
 import '../action-DBzILFx9.js';
 
 /**
@@ -1241,6 +1241,451 @@ declare function useQuest(observed: QuestView): {
             } | null;
         } | null | undefined;
         retryAt?: number | undefined;
+        nextAvailableAt?: number | undefined;
+    };
+    /** Input recovered after the quest changed. Prefill the form with it. */
+    draft: SubmissionDraft | null;
+    notice: QuestNotice;
+    error: RelayError | null;
+    /** True while `submit`, `resume`, `retry` or `restart` runs. */
+    isPending: boolean;
+    /** @deprecated Use `isPending`. Removed in 2.0.0. */
+    busy: boolean;
+    saved: SavedSubmission;
+    /** Review and explicitly restart this terminally retired saved submission. */
+    retired: boolean;
+    /** The attempt the last "received" notice is about. */
+    receipt: string | null;
+    startingFresh: boolean;
+};
+/**
+ * `useQuest()` plus its `questActionState()`: `open`, `counted` and `automatic` next to the
+ * submission state and actions.
+ */
+declare function useQuestAction(observed: QuestView): {
+    open: boolean;
+    counted: boolean;
+    automatic: boolean;
+    restart: () => Promise<void>;
+    submit: (input: QuestInput) => Promise<void>;
+    /** Finish an interrupted submission, or reopen an outdated draft. */
+    resume: () => Promise<void>;
+    /**
+     * Re-run verification that failed to run. Never creates a new attempt.
+     * Domino refuses this for automatic quests, so never offer it for them.
+     */
+    retry: () => Promise<void>;
+    /** The newest known version of the quest. Render this, not the prop. */
+    view: {
+        quest: string;
+        title: string;
+        presentation: {
+            steps?: {
+                title: string;
+                description?: string | undefined;
+                action?: {
+                    kind: "link";
+                    url: string;
+                    label: string;
+                } | undefined;
+            }[] | undefined;
+            image?: string | undefined;
+            imageAlt?: string | undefined;
+            requirements?: ({
+                kind: "account";
+                provider: "discord" | "x" | "google" | "apple";
+            } | {
+                kind: "wallet";
+                chain?: "solana" | "eip155" | "cosmos" | undefined;
+            })[] | undefined;
+            quiz?: {
+                id: string;
+                prompt: string;
+                choices: {
+                    id: string;
+                    label: string;
+                }[];
+            }[] | undefined;
+            instructions?: string | undefined;
+            video?: {
+                url: string;
+                poster?: string | undefined;
+                captions?: {
+                    url: string;
+                    language: string;
+                    label: string;
+                } | undefined;
+            } | undefined;
+        };
+        connections: ("discord" | "x" | "google" | "apple")[];
+        trigger: {
+            kind: "manual";
+            input: "text";
+            constraints: {
+                required: boolean;
+                minLength: number;
+                maxLength: number;
+            };
+            actor?: "member" | "staff" | undefined;
+        } | {
+            kind: "manual";
+            input: "url";
+            constraints: {
+                required: boolean;
+                allowedHosts?: string[] | undefined;
+            };
+            actor?: "member" | "staff" | undefined;
+        } | {
+            kind: "manual";
+            input: "none" | "quiz" | "photo";
+            actor?: "member" | "staff" | undefined;
+        } | {
+            kind: "automatic";
+            tracker?: {
+                tracker: string;
+                source: string;
+                on: "new-record" | "new-observation" | "data-changed";
+                beneficiary: string;
+                where?: {
+                    path: string;
+                    gt?: number | {
+                        setting: string;
+                    } | undefined;
+                    gte?: number | {
+                        setting: string;
+                    } | undefined;
+                    lt?: number | {
+                        setting: string;
+                    } | undefined;
+                    lte?: number | {
+                        setting: string;
+                    } | undefined;
+                } | {
+                    path: string;
+                    equals: string | number | boolean;
+                } | ({
+                    path: string;
+                    gt?: number | {
+                        setting: string;
+                    } | undefined;
+                    gte?: number | {
+                        setting: string;
+                    } | undefined;
+                    lt?: number | {
+                        setting: string;
+                    } | undefined;
+                    lte?: number | {
+                        setting: string;
+                    } | undefined;
+                } | {
+                    path: string;
+                    equals: string | number | boolean;
+                })[] | undefined;
+                enrollment?: "none" | "required" | undefined;
+                since?: "activation" | "window" | "enrollment" | undefined;
+                historical?: "staff" | "claim" | "automatic" | undefined;
+                content?: true | undefined;
+            } | undefined;
+        };
+        availability: {
+            kind: "available";
+            input: "url" | "text" | "none" | "quiz" | "photo";
+        } | {
+            kind: "completed";
+        } | {
+            kind: "locked";
+            missing: ({
+                kind: "completion";
+                quest: string;
+                title: string;
+                scope: "ever";
+            } | {
+                kind: "completion";
+                quest: string;
+                title: string;
+                scope: "period";
+                period: "day" | "week" | "month";
+                resetsAt: number;
+            } | {
+                kind: "balance";
+                balance: string;
+                title: string;
+                minimum: number;
+                current: number;
+            } | {
+                kind: "group";
+                group: string;
+                title: string;
+            })[];
+        } | {
+            kind: "blocked";
+            reason: "paused" | "outside-window" | "budget-exhausted" | "enrollment-required" | "connection-required" | "wallet-required";
+            window?: "quest" | "tracker" | undefined;
+            resetsAt?: number | undefined;
+        } | {
+            kind: "staff-required";
+        } | {
+            kind: "automatic";
+        } | {
+            kind: "checking";
+            attempt: string;
+        } | {
+            kind: "needs-review";
+            attempt: string;
+        } | {
+            kind: "retryable";
+            attempt: string;
+        };
+        completed: boolean;
+        completion: {
+            kind: "progress";
+            goal: {
+                kind: "count";
+                count: number;
+            };
+            window: {
+                kind: "lifetime";
+            } | {
+                kind: "calendar";
+                period: "day" | "week" | "month";
+                latenessMs: number;
+            } | {
+                kind: "rolling";
+                durationMs: number;
+            };
+            repeat: "repeat" | "once";
+        } | {
+            kind: "streak";
+            days: number;
+        } | {
+            kind: "once";
+        } | {
+            kind: "keyed";
+        };
+        progress: {
+            current: number;
+            target: number;
+            reason: string;
+        } | null;
+        completionCount: number;
+        visibility: "visible" | "hidden";
+        missing: ({
+            kind: "completion";
+            quest: string;
+            title: string;
+            scope: "ever";
+        } | {
+            kind: "completion";
+            quest: string;
+            title: string;
+            scope: "period";
+            period: "day" | "week" | "month";
+            resetsAt: number;
+        } | {
+            kind: "balance";
+            balance: string;
+            title: string;
+            minimum: number;
+            current: number;
+        } | {
+            kind: "group";
+            group: string;
+            title: string;
+        })[];
+        campaign: {
+            key: string;
+            title: string;
+            enrollment: "none" | "required";
+            enrolledAt: number | null;
+            withdrawnAt: number | null;
+            withdrawalReason: string | null;
+            window?: {
+                from: number;
+                until: number;
+            } | undefined;
+        } | null;
+        window: {
+            from: number;
+            until: number;
+        } | null;
+        budgets: {
+            id: string;
+            scope: "member" | "project";
+            period: "lifetime" | "day" | "week" | "month";
+            remaining: number;
+            resetsAt: number | null;
+        }[];
+        attempt: {
+            id: string;
+            release: string;
+            quest: string;
+            member: string;
+            evidence: string | null;
+            status: AttemptStatus;
+            reason: string | null;
+            retries: number;
+            generation: number;
+            completion: string | null;
+            reviewRewards: ({
+                kind: "tier";
+                reward: {
+                    id: string;
+                    title: string;
+                    tiers: {
+                        id: string;
+                        title: string;
+                    }[];
+                    inventory: {
+                        kind: "untracked";
+                    };
+                    fulfillment: {
+                        kind: "staff-handover";
+                    } | {
+                        kind: "automatic";
+                    };
+                    badge?: string | undefined;
+                    group?: string | undefined;
+                };
+                tier: string;
+            } | {
+                kind: "integration";
+                provider: "discord";
+                action: "grant-role";
+                roleId: string;
+            } | {
+                kind: "points";
+                balance: string;
+                amount: number;
+            })[] | null;
+            evaluationRun: number;
+            deferCount: number;
+            deferUntil: number | null;
+            nextEvaluationAt: number | null;
+            code: string | null;
+            progress: {
+                current: number;
+                target: number;
+                reason: string;
+            } | null;
+            requestedReview: boolean;
+            createdAt: number;
+            input?: {
+                kind: "text";
+                value: string;
+            } | {
+                kind: "url";
+                value: string;
+            } | {
+                kind: "quiz";
+                answers: {
+                    [k: string]: string;
+                };
+                release?: string | undefined;
+            } | undefined;
+        } | null;
+        release: string;
+        interaction: "url" | "text" | "staff" | "claim" | "automatic" | "quiz" | "photo";
+        lifecycle: "paused" | "active" | "archived";
+        rewards: ({
+            kind: "points";
+            label: string;
+            amount: number;
+            ledger: {
+                id: string;
+                key: string | null;
+                name: string;
+            };
+        } | {
+            kind: "tier";
+            label: string;
+            reward: {
+                id: string;
+                key: string | null;
+                title: string;
+                badge?: {
+                    name: string;
+                    description: string;
+                    image: string;
+                    id: string;
+                    key: string | null;
+                } | undefined;
+                group?: {
+                    key: string;
+                    title: string;
+                } | undefined;
+            };
+            tier: string;
+        } | {
+            kind: "integration";
+            label: string;
+        })[];
+        key?: string | undefined;
+        streak?: {
+            goal: number;
+            current: number;
+            best: number;
+            today: string;
+            todayQualified: boolean;
+            timeZone: string;
+            nextBoundary: number;
+            pendingTimeZone: {
+                timeZone: string;
+                effectiveAt: number;
+            } | null;
+            days: {
+                day: number;
+                date: string;
+                timeZone: string;
+                occurredAt: number;
+            }[];
+            milestone: {
+                status: "pending";
+            } | {
+                status: "awarded";
+                completion: string;
+                achievedAt: number;
+            } | {
+                status: "budget-exhausted";
+                budget: string;
+                achievedAt: number;
+            };
+        } | null | undefined;
+        counter?: {
+            goal: number;
+            current: number;
+            window: {
+                key: string;
+                start: number | null;
+                end: number | null;
+            };
+            repeat: "repeat" | "once";
+            settled: number;
+            latest: {
+                id: string;
+                ordinal: number;
+                achievedAt: number;
+                window: string;
+                status: "revoked";
+                completion: string;
+                revokedAt: number;
+            } | {
+                id: string;
+                ordinal: number;
+                achievedAt: number;
+                window: string;
+                status: "awarded";
+                completion: string;
+            } | {
+                id: string;
+                ordinal: number;
+                achievedAt: number;
+                window: string;
+                status: "budget-exhausted";
+                budget: string;
+            } | null;
+        } | null | undefined;
+        retryAt?: number | undefined;
+        nextAvailableAt?: number | undefined;
     };
     /** Input recovered after the quest changed. Prefill the form with it. */
     draft: SubmissionDraft | null;
@@ -1278,11 +1723,13 @@ type QuestTone = "open" | "done" | "waiting" | "attention" | "locked" | "off";
  * - `rejected`: the last submission was not accepted; the participant can try again.
  * - `retry-cooldown`: the last submission was not accepted, and the quest's retry cooldown runs
  *   until `retryAt`.
+ * - `completion-cooldown`: the last completion was accepted, and the quest's completion cooldown
+ *   runs until `retryAt`.
  * - `ready`: the participant can act now.
  *
  * @compat open
  */
-type KnownQuestStatusCode = "completed" | "paused" | "closed" | "counter" | "counter-budget-exhausted" | "counter-revoked" | "streak" | "streak-budget-exhausted" | "automatic" | "in-progress" | "locked" | "budget-exhausted" | "connection-required" | "wallet-required" | "outside-window" | "enrollment-required" | "checking" | "evaluator-deferred" | "evaluator-progress" | "in-review" | "retryable" | "staff-required" | "rejected" | "retry-cooldown" | "ready";
+type KnownQuestStatusCode = "completed" | "paused" | "closed" | "counter" | "counter-budget-exhausted" | "counter-revoked" | "streak" | "streak-budget-exhausted" | "automatic" | "in-progress" | "locked" | "budget-exhausted" | "connection-required" | "wallet-required" | "outside-window" | "enrollment-required" | "checking" | "evaluator-deferred" | "evaluator-progress" | "in-review" | "retryable" | "staff-required" | "rejected" | "retry-cooldown" | "completion-cooldown" | "ready";
 /** A known code, or one a newer SDK adds: render unknown codes with a neutral fallback. */
 type QuestStatusCode = KnownQuestStatusCode | (string & {});
 type QuestStatus = {
@@ -1295,7 +1742,10 @@ type QuestStatus = {
      * string when it gave none.
      */
     reason?: string;
-    /** Unix milliseconds when the participant may submit again, when `code` is `retry-cooldown`. */
+    /**
+     * Unix milliseconds when the participant may submit again, when `code` is `retry-cooldown` or
+     * `completion-cooldown`.
+     */
     retryAt?: number;
 };
 /** `QuestStatus` in English: a short `label`, and a sentence of `detail` when there is more. */
@@ -1342,9 +1792,33 @@ declare function isCoolingDown(view: QuestView, now?: number): boolean;
 declare function questStatusText(view: QuestView, now?: number): QuestStatusText;
 /**
  * True when the participant can submit something right now (`now`, Unix milliseconds, the current
- * time by default): not while a retry cooldown runs.
+ * time by default): not while a retry or completion cooldown runs.
  */
 declare function canSubmit(view: QuestView, now?: number): boolean;
+/** What a quest page shows for one quest; see `questActionState`. */
+type QuestActionState = {
+    /**
+     * True when the page shows the quest's input: the participant can submit now, or has just
+     * discarded a failed attempt on an active quest and starts a new submission.
+     */
+    open: boolean;
+    /**
+     * True once the submission just sent was accepted on a repeatable quest. Show "accepted" rather
+     * than "received", and clear the form for the next round.
+     */
+    counted: boolean;
+    /** The server owns every automatic run: offer no input, resume, retry, or restart. */
+    automatic: boolean;
+};
+/**
+ * What a quest page shows for a `useQuest()` result (`now`, Unix milliseconds, the current time by
+ * default). The same rules every starter's quest component follows.
+ */
+declare function questActionState(quest: {
+    view: QuestView;
+    startingFresh: boolean;
+    receipt: string | null;
+}, now?: number): QuestActionState;
 /**
  * "x of y completed" for a list of quests: `total` counts every quest that is not archived or
  * repeatable, including locked and paused ones, because they are still part of what the
@@ -1800,6 +2274,7 @@ declare function useMyProfile(): {
         options: {
             provider: "discord" | "x" | "google";
             name: string | null;
+            givenName: string | null;
             imageUrl: string | null;
         }[];
     };
@@ -1976,4 +2451,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 MemberQueryOptions, type MemberSnapshot, type Mutation, type MutationContext, type MutationOptions, type MutationStatus, 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, type RelayPolling, RelayProvider, type RelayQueryOptions, type RoleDelivery, type RoleDeliveryStatus, type SavedSubmission, SignInMethods, SignInOption, SignInUnavailable, SignInWallet, TelegramSignInOption, canRepeat, canSubmit, captureReferralCode, completionCountText, isAutomatic, isConnected, isCoolingDown, isFinished, progressOf, questGroups, questStatus, questStatusText, relayKeys, roleDeliveryLabel, roleDeliveryStatus, useAccounts, useActivity, useBadgeCatalog, useBadges, useBalances, useDeliveries, useEntitlements, useExperience, useInvalidate, useInvitation, useLeaderboard, useLeaderboardHistory, useLeaderboardPlacement, useMe, useMemberPages, useMemberQuery, useMyProfile, useOffers, usePointHistory, usePointLedgers, useProfile, useProfileBadges, useProfileCompletions, useProfileReferral, useQuest, useQuestOutcomes, useRedeemOffer, useReferralSummary, useRelay, useRelayAction, useRelayMutation, useRelayPages, useRelayQuery, useSession, useSetQueryData, useSignIn, useSignInMethods, useSignInOptions, useSignInWallets, useSignOut, useTelegramAccount, useTieredRewards, useWalletDiscovery, useWallets };
+export { type Collection, CosmosChains, DiscoveredWallet, type ExperienceData, type Invitation, type KnownQuestStatusCode, type KnownRoleDeliveryStatus, type MemberPagedQuery, type MemberQuery, type MemberQueryOptions, type MemberSnapshot, type Mutation, type MutationContext, type MutationOptions, type MutationStatus, type OAuthProvider, Page, type PageLoader, type PageRead, type PagedQuery, type Query, type QueryContext, type QueryKey, type QueryOptions, type QueryRead, type QuerySnapshot, type QuestActionState, type QuestInput, type QuestNotice, type QuestStatus, type QuestStatusCode, type QuestStatusText, type QuestTone, type ReferralSummary, type RelayActionResult, RelayClient, type RelayPolling, RelayProvider, type RelayQueryOptions, type RoleDelivery, type RoleDeliveryStatus, type SavedSubmission, SignInMethods, SignInOption, SignInUnavailable, SignInWallet, TelegramSignInOption, canRepeat, canSubmit, captureReferralCode, completionCountText, isAutomatic, isConnected, isCoolingDown, isFinished, progressOf, questActionState, questGroups, questStatus, questStatusText, relayKeys, roleDeliveryLabel, roleDeliveryStatus, useAccounts, useActivity, useBadgeCatalog, useBadges, useBalances, useDeliveries, useEntitlements, useExperience, useInvalidate, useInvitation, useLeaderboard, useLeaderboardHistory, useLeaderboardPlacement, useMe, useMemberPages, useMemberQuery, useMyProfile, useOffers, usePointHistory, usePointLedgers, useProfile, useProfileBadges, useProfileCompletions, useProfileReferral, useQuest, useQuestAction, useQuestOutcomes, useRedeemOffer, useReferralSummary, useRelay, useRelayAction, useRelayMutation, useRelayPages, useRelayQuery, useSession, useSetQueryData, useSignIn, useSignInMethods, useSignInOptions, useSignInWallets, useSignOut, useTelegramAccount, useTieredRewards, useWalletDiscovery, useWallets };