@domino-sdk/relay 0.28.0 → 0.29.0

package/dist/index.js

@@ -72,7 +72,7 @@ import {
   xPostSchema,
   xProfileSchema,
   xRequestSchema
-} from "./chunk-ZP43MHO3.js";
+} from "./chunk-5LLU7UUV.js";
 import {
   defineEngagementReward,
   defineLeaderboard,
@@ -100,6 +100,7 @@ import {
   leaderboardExclusionSchema,
   leaderboardGroupSchema,
   leaderboardPageSchema,
+  leaderboardPlacementSchema,
   leaderboardPreviewSchema,
   leaderboardQuerySchema,
   leaderboardRowSchema,
@@ -121,7 +122,7 @@ import {
   referralManagementSchema,
   referralRelationshipSchema,
   referralSummarySchema
-} from "./chunk-AKB266O5.js";
+} from "./chunk-YKS6P4IP.js";
 import {
   WALLETS_PER_CHAIN,
   authScopeSchema,
@@ -156,7 +157,7 @@ import {
   walletSignInNetworksSchema,
   walletSignatureSchema,
   walletUnlinkInputSchema
-} from "./chunk-AL5GXMKI.js";
+} from "./chunk-LAKQCIHX.js";
 import {
   AVATAR_UPLOAD_LIMIT,
   avatarProviderSchema,
@@ -167,15 +168,19 @@ import {
   managedProfileSchema,
   ownProfileSchema,
   profileAvatarSchema,
+  profileCompletionPageSchema,
+  profileCompletionQuerySchema,
+  profileCompletionSchema,
+  profileDefaultProviderSchema,
   profileDefaultsSchema,
   profileModerationSchema,
+  profileReferralSchema,
   profileSettingsInputSchema,
   profileSettingsSchema,
   profileSummarySchema,
   profileUpdateSchema,
-  profileVisibilitySchema,
-  publicProfileSchema
-} from "./chunk-D6BX627V.js";
+  profileVisibilitySchema
+} from "./chunk-MRKFRCCI.js";
 import {
   accountConnectionSchema,
   admittedContentSchema,
@@ -255,6 +260,7 @@ import {
   questAvailabilitySchema,
   questDescriptionSchema,
   questPresentationSchema,
+  questProfileSchema,
   questSettingsInputSchema,
   quizAnswersSchema,
   quizChoiceSchema,
@@ -333,7 +339,7 @@ import {
   xContentBodySchema,
   xPostId,
   xTweetSchema
-} from "./chunk-IXLY3A7B.js";
+} from "./chunk-BE5V6RFD.js";
 export {
   AVATAR_UPLOAD_LIMIT,
   QuestUpdatedError,
@@ -468,6 +474,7 @@ export {
   leaderboardExclusionSchema,
   leaderboardGroupSchema,
   leaderboardPageSchema,
+  leaderboardPlacementSchema,
   leaderboardPreviewSchema,
   leaderboardQuerySchema,
   leaderboardRowSchema,
@@ -510,8 +517,13 @@ export {
   prerequisiteSchema,
   principalSchema,
   profileAvatarSchema,
+  profileCompletionPageSchema,
+  profileCompletionQuerySchema,
+  profileCompletionSchema,
+  profileDefaultProviderSchema,
   profileDefaultsSchema,
   profileModerationSchema,
+  profileReferralSchema,
   profileSettingsInputSchema,
   profileSettingsSchema,
   profileSummarySchema,
@@ -520,7 +532,6 @@ export {
   projectCatalogArtifactSchema,
   projectDeploymentSchema,
   projectIntegrationSchema,
-  publicProfileSchema,
   publishDeploymentSchema,
   publishQuestDraftSchema,
   publishedImageSchema,
@@ -540,6 +551,7 @@ export {
   questInstanceSchema,
   questInteraction,
   questPresentationSchema,
+  questProfileSchema,
   questPublicationPreviewSchema,
   questRewardViewSchema,
   questSettingsInputSchema,

package/dist/portal-proxy.js

@@ -2,13 +2,13 @@ import {
   exchangeResultSchema,
   isWalletParticipantRoute,
   isWalletSignInRoute
-} from "./chunk-AL5GXMKI.js";
+} from "./chunk-LAKQCIHX.js";
 import {
   isProfileParticipantRoute
-} from "./chunk-D6BX627V.js";
+} from "./chunk-MRKFRCCI.js";
 import {
   isContentParticipantRoute
-} from "./chunk-IXLY3A7B.js";
+} from "./chunk-BE5V6RFD.js";
 
 // src/portal-proxy.ts
 async function proxyParticipant(request, upstream) {

package/dist/react/index.d.ts

@@ -2,9 +2,9 @@ import * as react from 'react';
 import { ReactNode } from 'react';
 import * as zod from 'zod';
 import { z } from 'zod';
-import { ProfileUpdate, QuestView, QuestController, ProgressObservation, questExperienceSchema, ProgressObserver, ExchangeInput, PhotoSubmission, QuizSubmission, ClaimSubmission, ValueSubmission, SubmissionDraft, PublicProfile, PointLedgerReference } from '../index.js';
+import { ProfileUpdate, ProfileCompletionQuery, QuestView, QuestController, ProgressObservation, questExperienceSchema, ProgressObserver, ExchangeInput, PhotoSubmission, QuizSubmission, ClaimSubmission, ValueSubmission, SubmissionDraft, ProfileCompletion, ProfileSummary, PointLedgerReference } from '../index.js';
 export { avatarSrc, defaultAvatar, walletAvatarSeed } from '../index.js';
-import { H as referralAcceptSchema, J as LeaderboardQuery, K as WalletAddressInput, M as walletSignatureSchema, L as LinkedWallet, N as WalletSigner, P as walletChallengeInputSchema, Q as walletProofSchema, R as AuthProvider, V as WalletSignature, Y as engagementPageQuerySchema, Z as contentQualificationQuerySchema, _ as contentAdmissionQuerySchema, $ as contentEnrollmentInputSchema, a0 as contentReleaseInputSchema, a1 as AccountConnection, a2 as WalletSignInNetwork, a3 as referralSummarySchema, a4 as LeaderboardPage } from '../submission-input-D3t8WKOk.js';
+import { H as referralAcceptSchema, J as LeaderboardQuery, K as WalletAddressInput, M as walletSignatureSchema, L as LinkedWallet, N as WalletSigner, P as walletChallengeInputSchema, Q as walletProofSchema, R as AuthProvider, V as WalletSignature, Y as engagementPageQuerySchema, Z as contentQualificationQuerySchema, _ as contentAdmissionQuerySchema, $ as contentEnrollmentInputSchema, a0 as contentReleaseInputSchema, a1 as AccountConnection, a2 as WalletSignInNetwork, a3 as referralSummarySchema, a4 as LeaderboardPage } from '../submission-input-C0cOmO4Q.js';
 import { SubmitInput, ReleaseInput, beginHandoverSchema, contentPerformanceQuerySchema, TieredRewardReference } from '../schema.js';
 import { createBrowserRelayClient, SignInMethods, CosmosChains, SignInOption, SignInUnavailable, SignInWallet, DiscoveredWallet } from '../browser.js';
 export { EmailSignInOption, OAuthSignInOption, SignInIcon, WalletSignInOption } from '../browser.js';
@@ -385,6 +385,15 @@ declare function useRelay(): {
             }[];
             nextCursor: string | null;
         }>;
+        placement: (board: string, profile: string) => Promise<{
+            leaderboard: string;
+            title: string;
+            profile: string;
+            rank: number | null;
+            score: number | null;
+            total: number;
+            key?: string | undefined;
+        }>;
     };
     profiles: {
         mine: () => Promise<{
@@ -404,7 +413,7 @@ declare function useRelay(): {
                 seed: string;
             };
             displayName: string | null;
-            avatarChoice: "default" | "account" | "generated" | "upload";
+            avatarChoice: "default" | "account" | "upload" | "generated";
             avatarProvider: "x" | "discord" | "google" | null;
             hidden: boolean;
             locked: boolean;
@@ -434,7 +443,7 @@ declare function useRelay(): {
                 seed: string;
             };
             displayName: string | null;
-            avatarChoice: "default" | "account" | "generated" | "upload";
+            avatarChoice: "default" | "account" | "upload" | "generated";
             avatarProvider: "x" | "discord" | "google" | null;
             hidden: boolean;
             locked: boolean;
@@ -465,7 +474,7 @@ declare function useRelay(): {
                 seed: string;
             };
             displayName: string | null;
-            avatarChoice: "default" | "account" | "generated" | "upload";
+            avatarChoice: "default" | "account" | "upload" | "generated";
             avatarProvider: "x" | "discord" | "google" | null;
             hidden: boolean;
             locked: boolean;
@@ -492,36 +501,28 @@ declare function useRelay(): {
                 source: "generated";
                 seed: string;
             };
-            self: boolean;
-            leaderboards: {
-                leaderboard: string;
-                title: string;
-                rank: number;
-                score: number;
-                total: number;
-                key?: string | undefined;
-            }[] | null;
-            quests: {
+        }>;
+        completions: (profile: string, options?: ProfileCompletionQuery) => Promise<{
+            items: {
                 quest: string;
                 title: string;
                 completions: number;
                 lastCompletedAt: number | null;
                 key?: string | undefined;
-            }[] | null;
-            referrals: {
-                attributed: number;
-                programs: {
-                    program: string;
-                    title: string;
-                    qualified: number;
-                    milestones: {
-                        id: string;
-                        count: number;
-                        reached: boolean;
-                    }[];
-                    key?: string | undefined;
-                }[];
-            } | null;
+            }[];
+            nextCursor: string | null;
+        }>;
+        referral: (profile: string, program: string) => Promise<{
+            program: string;
+            title: string;
+            invited: number;
+            qualified: number;
+            milestones: {
+                id: string;
+                count: number;
+                reached: boolean;
+            }[];
+            key?: string | undefined;
         }>;
     };
     quests: {
@@ -2337,6 +2338,9 @@ declare function useRelay(): {
                 metrics: ("likes" | "replies" | "reposts" | "quotes" | "views" | "bookmarks")[];
                 maxAgeMs: number;
             } | undefined;
+            profile?: {
+                visible: boolean;
+            } | undefined;
         };
     }[]>;
     template: () => Promise<{
@@ -2540,6 +2544,9 @@ declare function useRelay(): {
                 metrics: ("likes" | "replies" | "reposts" | "quotes" | "views" | "bookmarks")[];
                 maxAgeMs: number;
             } | undefined;
+            profile?: {
+                visible: boolean;
+            } | undefined;
         };
     }>;
     snapshot: () => Promise<{
@@ -2748,6 +2755,9 @@ declare function useRelay(): {
                 metrics: ("likes" | "replies" | "reposts" | "quotes" | "views" | "bookmarks")[];
                 maxAgeMs: number;
             } | undefined;
+            profile?: {
+                visible: boolean;
+            } | undefined;
             key?: string | undefined;
             origin?: {
                 typeVersion: string;
@@ -3131,6 +3141,9 @@ declare function useRelay(): {
             metrics: ("likes" | "replies" | "reposts" | "quotes" | "views" | "bookmarks")[];
             maxAgeMs: number;
         } | undefined;
+        profile?: {
+            visible: boolean;
+        } | undefined;
         key?: string | undefined;
         origin?: {
             typeVersion: string;
@@ -3362,6 +3375,9 @@ declare function useRelay(): {
             metrics: ("likes" | "replies" | "reposts" | "quotes" | "views" | "bookmarks")[];
             maxAgeMs: number;
         } | undefined;
+        profile?: {
+            visible: boolean;
+        } | undefined;
         key?: string | undefined;
         origin?: {
             typeVersion: string;
@@ -4581,8 +4597,8 @@ type OAuthProvider = AuthProvider;
 declare function useSignInMethods(): SignInMethods | null;
 /**
  * The signed-in member and the seed of their generated avatar, or null while signed out or
- * loading: `<img src={defaultAvatar(me.avatarSeed)} />`. The seed comes from the member's first
- * linked wallet without revealing it, so it is read again after a wallet is linked in this tab.
+ * loading: `<img src={defaultAvatar(me.avatarSeed)} />`. The seed is derived from the member and
+ * reveals nothing about them; linking wallets or accounts does not change it.
  */
 declare function useMe(): {
     member: string;
@@ -4744,7 +4760,7 @@ declare function useMyProfile(): {
             seed: string;
         };
         displayName: string | null;
-        avatarChoice: "default" | "account" | "generated" | "upload";
+        avatarChoice: "default" | "account" | "upload" | "generated";
         avatarProvider: "x" | "discord" | "google" | null;
         hidden: boolean;
         locked: boolean;
@@ -4763,6 +4779,22 @@ declare function useMyProfile(): {
     /** Uploads a JPEG, PNG or WebP of at most 5 MB as the avatar; resolves true once saved. */
     uploadAvatar: (file: Blob) => Promise<boolean>;
 };
+/**
+ * A read keyed by a profile. `missing` is the uniform 404: a profile (or board, or program) that
+ * is missing, hidden by its member, or not visible to this viewer, on purpose indistinguishable.
+ */
+type ProfileReadState<T> = {
+    status: "loading";
+} | {
+    status: "error";
+    message: string;
+} | {
+    status: "missing";
+} | {
+    status: "ready";
+    value: T;
+    stale: string | null;
+};
 type ProfileState = {
     status: "loading";
 } | {
@@ -4774,12 +4806,13 @@ type ProfileState = {
     status: "missing";
 } | {
     status: "ready";
-    profile: PublicProfile;
+    profile: ProfileSummary;
     stale: string | null;
 };
 /**
- * A profile page by its public ID, read again every `intervalMs` while the page is visible and
- * when the participant signs in or out.
+ * A profile's name and avatar by its public ID (`relay.profiles.get`), read again every
+ * `intervalMs` (default 60 seconds) while the page is visible and when the participant signs in
+ * or out.
  */
 declare function useProfile(id: string, options?: {
     intervalMs?: number;
@@ -4796,9 +4829,139 @@ declare function useProfile(id: string, options?: {
 } | {
     refresh: () => Promise<void>;
     status: "ready";
-    profile: PublicProfile;
+    profile: ProfileSummary;
     stale: string | null;
 };
+/**
+ * A profile's current rank and score on one board (`relay.leaderboards.placement`), read again
+ * every `intervalMs` (default 30 seconds) while the page is visible. Signed-out visitors get an
+ * error for boards without public access.
+ */
+declare function useLeaderboardPlacement(board: string, profile: string, options?: {
+    intervalMs?: number;
+}): {
+    refresh: () => Promise<void>;
+    status: "loading";
+} | {
+    refresh: () => Promise<void>;
+    status: "error";
+    message: string;
+} | {
+    refresh: () => Promise<void>;
+    status: "missing";
+} | {
+    refresh: () => Promise<void>;
+    status: "ready";
+    value: {
+        leaderboard: string;
+        title: string;
+        profile: string;
+        rank: number | null;
+        score: number | null;
+        total: number;
+        key?: string | undefined;
+    };
+    stale: string | null;
+};
+/**
+ * A profile's progress in one referral program (`relay.profiles.referral`), read again every
+ * `intervalMs` (default 60 seconds) while the page is visible. Needs a signed-in participant.
+ */
+declare function useProfileReferral(profile: string, program: string, options?: {
+    intervalMs?: number;
+}): {
+    refresh: () => Promise<void>;
+    status: "loading";
+} | {
+    refresh: () => Promise<void>;
+    status: "error";
+    message: string;
+} | {
+    refresh: () => Promise<void>;
+    status: "missing";
+} | {
+    refresh: () => Promise<void>;
+    status: "ready";
+    value: {
+        program: string;
+        title: string;
+        invited: number;
+        qualified: number;
+        milestones: {
+            id: string;
+            count: number;
+            reached: boolean;
+        }[];
+        key?: string | undefined;
+    };
+    stale: string | null;
+};
+type ProfileCompletionsState = {
+    status: "loading";
+} | {
+    status: "error";
+    message: string;
+} | {
+    status: "missing";
+} | {
+    status: "ready";
+    items: ProfileCompletion[];
+    /** More completions to load with `loadMore()`. */
+    more: boolean;
+    /** Loading the next page. */
+    loading: boolean;
+    /** Why the last `loadMore()` failed, until the next succeeds. */
+    error: string | null;
+};
+/**
+ * A profile's completions of quests that show on profiles (`relay.profiles.completions`), most
+ * recently completed first, `limit` quests at a time. `loadMore()` appends the next page;
+ * `refresh()` starts again from the first, as signing in or out and a profile change in this tab
+ * do.
+ */
+declare function useProfileCompletions(profile: string, options?: {
+    limit?: number;
+}): {
+    refresh: () => Promise<void>;
+    /**
+     * Appends the next page; does nothing while one loads, while the first page reloads, or when
+     * there is none.
+     */
+    loadMore: () => Promise<void>;
+    status: "loading";
+} | {
+    refresh: () => Promise<void>;
+    /**
+     * Appends the next page; does nothing while one loads, while the first page reloads, or when
+     * there is none.
+     */
+    loadMore: () => Promise<void>;
+    status: "error";
+    message: string;
+} | {
+    refresh: () => Promise<void>;
+    /**
+     * Appends the next page; does nothing while one loads, while the first page reloads, or when
+     * there is none.
+     */
+    loadMore: () => Promise<void>;
+    status: "missing";
+} | {
+    refresh: () => Promise<void>;
+    /**
+     * Appends the next page; does nothing while one loads, while the first page reloads, or when
+     * there is none.
+     */
+    loadMore: () => Promise<void>;
+    status: "ready";
+    items: ProfileCompletion[];
+    /** More completions to load with `loadMore()`. */
+    more: boolean;
+    /** Loading the next page. */
+    loading: boolean;
+    /** Why the last `loadMore()` failed, until the next succeeds. */
+    error: string | null;
+};
 
 type ReferralSummary = z.infer<typeof referralSummarySchema>;
 /**
@@ -5060,4 +5223,4 @@ declare function useTieredRewards(): {
     }[];
 };
 
-export { type Collection, CosmosChains, DiscoveredWallet, type Experience, type Invitation, type LeaderboardState, type OAuthProvider, PENDING_POLL_MS, PROFILE_CHANGED, type PointLedgersState, type ProfileState, type QuestInput, type QuestNotice, type QuestStatus, type QuestTone, RETRY_DELAYS_MS, type ReferencesState, type ReferralSummary, type RelayClient, RelayProvider, type RoleDelivery, type SavedSubmission, SignInMethods, SignInOption, SignInUnavailable, SignInWallet, type TieredRewardsState, canRepeat, canSubmit, captureReferralCode, completionCountLabel, completionMark, hasPending, isAutomatic, isConnected, isFinished, progressOf, questGroups, questStatus, roleDeliveryLabel, runsSilently, sanitizeDeliveries, useAccounts, useExperience, useInvitation, useLeaderboard, useMe, useMyProfile, usePointLedgers, useProfile, useQuest, useReferralSummary, useRelay, useSignIn, useSignInMethods, useSignInOptions, useSignInWallets, useSignOut, useTieredRewards, useWalletDiscovery, useWallets, visibleQuests, watchRoleDeliveries };
+export { type Collection, CosmosChains, DiscoveredWallet, type Experience, type Invitation, type LeaderboardState, type OAuthProvider, PENDING_POLL_MS, PROFILE_CHANGED, type PointLedgersState, type ProfileCompletionsState, type ProfileReadState, type ProfileState, type QuestInput, type QuestNotice, type QuestStatus, type QuestTone, RETRY_DELAYS_MS, type ReferencesState, type ReferralSummary, type RelayClient, RelayProvider, type RoleDelivery, type SavedSubmission, SignInMethods, SignInOption, SignInUnavailable, SignInWallet, type TieredRewardsState, canRepeat, canSubmit, captureReferralCode, completionCountLabel, completionMark, hasPending, isAutomatic, isConnected, isFinished, progressOf, questGroups, questStatus, roleDeliveryLabel, runsSilently, sanitizeDeliveries, useAccounts, useExperience, useInvitation, useLeaderboard, useLeaderboardPlacement, useMe, useMyProfile, usePointLedgers, useProfile, useProfileCompletions, useProfileReferral, useQuest, useReferralSummary, useRelay, useSignIn, useSignInMethods, useSignInOptions, useSignInWallets, useSignOut, useTieredRewards, useWalletDiscovery, useWallets, visibleQuests, watchRoleDeliveries };