@domino-sdk/relay 1.60.0 → 1.62.0

package/dist/{chunk-VVRQQRMQ.js → chunk-GKIFABGN.js}

@@ -1,47 +1,57 @@
 import {
   createRelayAction,
   withActionId
-} from "./chunk-4OFH4BNX.js";
+} from "./chunk-Y322OTCH.js";
 import {
+  setPluginTransport
+} from "./chunk-6WCIWXUV.js";
+import {
+  authProvidersSchema,
   collectionPassSchema,
+  consentInputSchema,
   creatorAccountProviderSchema,
   creatorAccountsSchema,
-  participantActivityQuerySchema,
-  participantActivitySchema,
+  memberConsentListSchema,
+  memberConsentSchema,
   participantDeliveriesSchema,
   participantEntitlementsSchema,
   questClaimInputSchema,
   questEnrollmentInputSchema,
   questEnrollmentSchema,
-  questExperienceSchema,
   questOutcomePageSchema,
   questOutcomeQuerySchema,
   questOutcomeSchema,
   rewardDeliveriesSchema,
   rewardDeliveryQuerySchema
-} from "./chunk-XQKUJL7H.js";
+} from "./chunk-CICDIBOF.js";
+import {
+  participantActivityQuerySchema,
+  participantActivitySchema,
+  questExperienceSchema
+} from "./chunk-D26YNACF.js";
 import {
-  badgeSchema,
   engagementBoundaryPageSchema,
   engagementPageQuerySchema,
   engagementPageSchema,
-  leaderboardDefinitionResponseSchema,
-  leaderboardHistoryPageSchema,
-  leaderboardHistoryQuerySchema,
-  leaderboardPageSchema,
-  leaderboardPlacementSchema,
-  leaderboardQuerySchema,
-  memberBadgesSchema,
   offerSchema,
   redemptionSchema,
   referralAcceptSchema,
   referralDefinitionSchema,
   referralHistorySchema,
   referralSummarySchema
-} from "./chunk-MJEJQH5A.js";
+} from "./chunk-GTDW453U.js";
 import {
   AVATAR_UPLOAD_LIMIT,
   avatarUploadTypes,
+  badgeCatalogSchema,
+  badgeSchema,
+  leaderboardDefinitionResponseSchema,
+  leaderboardHistoryPageSchema,
+  leaderboardHistoryQuerySchema,
+  leaderboardPageSchema,
+  leaderboardPlacementSchema,
+  leaderboardQuerySchema,
+  memberBadgesSchema,
   ownProfileSchema,
   pointBalancesSchema,
   pointHistoryPageSchema,
@@ -52,66 +62,65 @@ import {
   profileReferralSchema,
   profileSummarySchema,
   profileUpdateSchema
-} from "./chunk-YNW2ZUUP.js";
+} from "./chunk-WSBYWVTZ.js";
 import {
   PARTICIPANT_TIMEOUT,
+  clientIdentity,
   lifetime,
   retryAfter,
   retrying,
   validTimeout
-} from "./chunk-6ZG7WNYX.js";
-import {
-  clientIdentity
-} from "./chunk-N7YOS4ZU.js";
+} from "./chunk-3PYYGFSB.js";
 import {
   exchangeResultSchema,
   exchangeSchema,
   memberSummarySchema,
   participantSessionSchema,
   sessionMember
-} from "./chunk-422J3QRW.js";
+} from "./chunk-XJFYAXET.js";
 import {
-  RelayError,
-  RelayErrorCode,
   accountConnectionSchema,
   attemptSchema,
-  authProviderSchema,
   campaignEnrollmentInputSchema,
   campaignEnrollmentSchema,
   campaignWithdrawalInputSchema,
-  clientError,
   contentPerformancePageSchema,
   contentPerformanceQuerySchema,
   contentQualificationPageSchema,
   contentQualificationQuerySchema,
   evidenceSchema,
   identifier,
-  isRelayError,
-  isRequestError,
   knownResponse,
   linkedWalletSchema,
   memberProgressSchema,
   missingPrerequisiteSchema,
   pageQuerySchema,
-  parseInput,
   questSubmissionResultSchema,
   questSubmissionSchema,
   quizEvidenceSchema,
+  signInAccountSchema,
+  signInProviderInputSchema,
   submissionEvidenceSchema,
   submitSchema,
   telegramAccountConnectionSchema,
   telegramMiniAppSignInSchema,
-  telegramSignInMethodsSchema,
   tieredRewardReferenceSchema,
   validateSubmissionValue,
   valueEvidenceSchema,
   walletAddressInput,
   walletAddressInputSchema,
   walletMessageChallengeSchema,
-  walletSignInNetworksSchema,
   walletSignatureSchema,
   walletUnlinkInputSchema
-} from "./chunk-GBSDAD3N.js";
+} from "./chunk-MK425RXJ.js";
+import {
+  RelayError,
+  RelayErrorCode,
+  clientError,
+  isRelayError,
+  isRequestError,
+  parseInput
+} from "./chunk-K2KS3JLY.js";
 
 // src/legacy-submissions.ts
 import * as z from "zod";
@@ -1113,7 +1122,7 @@ function questActions(submission, latest) {
 
 // src/client.ts
 var authStartSchema = z2.strictObject({
-  provider: authProviderSchema,
+  provider: signInProviderInputSchema,
   mode: z2.enum(["sign-in", "connect"])
 });
 var emailVerificationSchema = z2.strictObject({
@@ -1593,7 +1602,26 @@ function relayClient(options) {
   }
   const ok = z2.object({ ok: z2.literal(true) });
   const acknowledged = z2.object({ ok: z2.boolean() });
-  return {
+  const pluginProofSchema = z2.string().min(1, "Pass the vendor's signed proof").max(8192);
+  const signInMethod = (path, field) => {
+    const body2 = (proof, mode) => ({
+      [field]: parseInput(pluginProofSchema, proof),
+      mode
+    });
+    return {
+      signIn: (proof, requestOptions) => changeSession(
+        () => request(path, participantSessionSchema, {
+          json: body2(proof, "sign-in"),
+          options: requestOptions
+        })
+      ),
+      connect: async (proof, requestOptions) => request(path, acknowledged, {
+        json: body2(proof, "connect"),
+        options: requestOptions
+      })
+    };
+  };
+  const client = {
     /** Owns one action key across uncertain writes. Reuse the helper until a definite answer. */
     action: createRelayAction,
     /** A JSON call using an explicit tolerant response schema from `@domino-sdk/relay/schema`. */
@@ -1682,7 +1710,17 @@ function relayClient(options) {
       })
     },
     badges: {
-      list: (options2) => request("/v1/badges", z2.array(badgeSchema), { options: options2 })
+      /**
+       * The project's active badge catalog, as an array.
+       *
+       * @deprecated Use `catalog`, which answers `{ items }` like `me.badges`. Removed in 2.0.0.
+       */
+      list: (options2) => request("/v1/badges", z2.array(badgeSchema), { options: options2 }),
+      /**
+       * The project's active badge catalog, oldest definition first, in `items`. Archived badges
+       * are left out. Open to signed-out visitors.
+       */
+      catalog: (options2) => request("/v1/badges/catalog", badgeCatalogSchema, { options: options2 })
     },
     pointLedgers: {
       /**
@@ -1925,6 +1963,34 @@ function relayClient(options) {
         );
       }
     },
+    /**
+     * 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) => request("/v1/me/consent", memberConsentListSchema, {
+        options: requestOptions
+      }),
+      /**
+       * 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: async (value, requestOptions) => {
+        const body2 = parseInput(consentInputSchema, withActionId(value));
+        return request("/v1/me/consent", memberConsentSchema, {
+          json: body2,
+          options: requestOptions,
+          operationId: body2.actionId
+        });
+      }
+    },
     /** The signed-in member's linked Solana, EVM and Cosmos wallets for this project. */
     wallets: {
       list: (requestOptions) => request(
@@ -1979,27 +2045,9 @@ function relayClient(options) {
       }
     },
     auth: {
-      providers: (requestOptions) => request(
-        "/v1/auth/providers",
-        z2.object({
-          providers: z2.array(
-            z2.object({
-              provider: authProviderSchema,
-              configured: z2.boolean()
-            })
-          ),
-          email: z2.boolean(),
-          /** The wallet sign-in this project enabled. */
-          wallets: walletSignInNetworksSchema,
-          demo: z2.boolean(),
-          /**
-           * Telegram's sign-in, which is not one of `providers` in SDK 1.x. Absent from Relay
-           * versions without Telegram.
-           */
-          telegram: telegramSignInMethodsSchema.optional()
-        }),
-        { options: requestOptions }
-      ),
+      providers: (requestOptions) => request("/v1/auth/providers", authProvidersSchema, {
+        options: requestOptions
+      }),
       start: authStart,
       emailStart: async (email2, requestOptions) => request("/v1/auth/email/start", z2.object({ challenge: z2.string() }), {
         json: {
@@ -2064,12 +2112,15 @@ function relayClient(options) {
       },
       /**
        * 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: async (mode, requestOptions) => request("/v1/auth/start", z2.object({ url: z2.string() }), {
           json: {
@@ -2078,13 +2129,21 @@ function relayClient(options) {
           },
           options: requestOptions
         }),
-        /** 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) => request(
           "/v1/auth/accounts/telegram",
           telegramAccountConnectionSchema,
           { options: requestOptions }
         ),
-        /** 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: async (requestOptions) => request("/v1/auth/accounts/disconnect", acknowledged, {
           json: { provider: "telegram" },
           options: requestOptions
@@ -2094,6 +2153,9 @@ function relayClient(options) {
          * (`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. */
@@ -2144,12 +2206,20 @@ function relayClient(options) {
           options: requestOptions
         })
       },
-      /** The member's connected sign-in accounts, one per provider. */
+      /** The member's connected sign-in accounts, one per `AuthProvider`. */
       accounts: (requestOptions) => request("/v1/auth/accounts", z2.array(accountConnectionSchema), {
         options: requestOptions
       }),
+      /**
+       * 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) => request("/v1/auth/sign-in-accounts", z2.array(signInAccountSchema), {
+        options: requestOptions
+      }),
+      /** Unlinks the member's account on `provider`, any of `signInAccounts()`'s. */
       disconnect: async (provider, requestOptions) => request("/v1/auth/accounts/disconnect", acknowledged, {
-        json: { provider: parseInput(authProviderSchema, provider) },
+        json: { provider: parseInput(signInProviderInputSchema, provider) },
         options: requestOptions
       }),
       session: (requestOptions) => readSession(requestOptions),
@@ -2159,7 +2229,13 @@ function relayClient(options) {
           options: requestOptions
         })
       ),
-      /** 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: async (value, requestOptions) => request("/v1/auth/exchange", exchangeResultSchema, {
         json: parseInput(exchangeSchema, value),
         options: requestOptions
@@ -2168,6 +2244,12 @@ function relayClient(options) {
     me: {
       badges: (options2) => request("/v1/me/badges", memberBadgesSchema, { options: options2 }),
       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: async (query = {}, options2) => {
           const parsed = parseInput(participantActivityQuerySchema, query);
           return request(
@@ -2229,7 +2311,12 @@ function relayClient(options) {
        * 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: async (requestOptions) => request("/v1/me", memberSummarySchema, { options: requestOptions }),
+      get: async (requestOptions) => {
+        const me = await request("/v1/me", memberSummarySchema, {
+          options: requestOptions
+        });
+        return { ...me, clock: me.clock ?? { now: Date.now(), offsetMs: 0 } };
+      },
       observeProgress: (listener, observeOptions) => {
         const observer = observeProgress(
           {
@@ -2396,6 +2483,8 @@ function relayClient(options) {
       )
     }
   };
+  setPluginTransport(client, { signInMethod });
+  return client;
 }
 
 export {