@pear-protocol/types 1.22.0 → 1.24.0

package/dist/auth/entities.d.ts

@@ -3,6 +3,7 @@ export declare const LoginMethod: z.ZodEnum<{
     email: "email";
     evm_wallet: "evm_wallet";
     oauth: "oauth";
+    x: "x";
 }>;
 export declare const AuthenticatedUser: z.ZodObject<{
     id: z.ZodUUID;
@@ -15,7 +16,26 @@ export declare const AuthenticatedUser: z.ZodObject<{
         email: "email";
         evm_wallet: "evm_wallet";
         oauth: "oauth";
+        x: "x";
     }>;
 }, z.core.$strip>;
+/**
+ * One provider identity connected to the account.
+ *
+ * Identity only: every entry reports the immutable id the provider knows the account by.
+ * Mutable display data - the X handle, name and avatar - is published by the profile
+ * endpoints that own it, so it never goes stale in two places at once.
+ */
+export declare const ConnectedIdentity: z.ZodObject<{
+    provider: z.ZodEnum<{
+        email: "email";
+        evm_wallet: "evm_wallet";
+        oauth: "oauth";
+        x: "x";
+    }>;
+    externalId: z.ZodString;
+    connectedAt: z.ZodString;
+}, z.core.$strip>;
 export type LoginMethod = z.infer<typeof LoginMethod>;
 export type AuthenticatedUser = z.infer<typeof AuthenticatedUser>;
+export type ConnectedIdentity = z.infer<typeof ConnectedIdentity>;

package/dist/auth/entities.js

@@ -1,11 +1,16 @@
 import { z } from 'zod';
 
-const LoginMethod = z.enum(["email", "evm_wallet", "oauth"]).describe("Authentication provider used for the current session");
+const LoginMethod = z.enum(["email", "evm_wallet", "oauth", "x"]).describe("Authentication provider used for the current session");
 const AuthenticatedUser = z.object({
   id: z.uuid().describe("User UUID"),
   role: z.enum(["basic", "pro"]).describe("User role"),
   providerId: z.string().nullable().describe("Provider identifier (wallet address or email)"),
   loginMethod: LoginMethod.describe("Authentication provider used for the current session")
 }).describe("Current authenticated user info");
+const ConnectedIdentity = z.object({
+  provider: LoginMethod.describe("Provider that owns this identity"),
+  externalId: z.string().describe("Immutable id the provider knows the account by: wallet address, email, or X numeric id"),
+  connectedAt: z.string().describe("ISO-8601 timestamp of when the identity was connected")
+}).describe("One provider identity connected to the account");
 
-export { AuthenticatedUser, LoginMethod };
+export { AuthenticatedUser, ConnectedIdentity, LoginMethod };

package/dist/auth/payloads.d.ts

@@ -15,6 +15,12 @@ export declare const LinkWalletRequest: z.ZodObject<{
     signature: z.ZodString;
     nonce: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+export declare const StartXLinkRequest: z.ZodObject<{
+    returnTo: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const StartXLoginRequest: z.ZodObject<{
+    returnTo: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
 export declare const WalletLoginRequest: z.ZodObject<{
     method: z.ZodLiteral<"wallet">;
     address: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
@@ -70,6 +76,8 @@ export type WalletLoginRequest = z.infer<typeof WalletLoginRequest>;
 export type EmailRegisterRequest = z.infer<typeof EmailRegisterRequest>;
 export type LinkEmailRequest = z.infer<typeof LinkEmailRequest>;
 export type LinkWalletRequest = z.infer<typeof LinkWalletRequest>;
+export type StartXLinkRequest = z.infer<typeof StartXLinkRequest>;
+export type StartXLoginRequest = z.infer<typeof StartXLoginRequest>;
 export type EmailLoginRequest = z.infer<typeof EmailLoginRequest>;
 export type LoginRequest = z.infer<typeof LoginRequest>;
 export type RefreshTokenRequest = z.infer<typeof RefreshTokenRequest>;

package/dist/auth/payloads.js

@@ -21,6 +21,16 @@ const LinkWalletRequest = z.object({
   signature: z.string().min(1, "Signature is required").describe("Signature of the nonce message"),
   nonce: SignedNonce
 }).describe("Link wallet credentials to the authenticated account");
+const StartXLinkRequest = z.object({
+  returnTo: z.string().optional().describe(
+    "Page to send the browser back to once the link finishes, normally the page the user is on. Must be on the calling origin; defaults to that origin."
+  )
+}).describe("Start of the X account link flow");
+const StartXLoginRequest = z.object({
+  returnTo: z.string().optional().describe(
+    "Page to send the browser back to once the sign-in finishes, normally the page the user is on. Must be on the calling origin; defaults to that origin."
+  )
+}).describe("Start of the X sign-in flow");
 const WalletLoginRequest = z.object({
   method: z.literal("wallet").describe('Must be "wallet" for wallet authentication'),
   address: EthereumAddress,
@@ -64,4 +74,4 @@ const OauthInteractionConfirmRequest = z.object({
   )
 }).describe("Consent confirmation body \u2014 the granted scope set");
 
-export { ChangePasswordRequest, EmailLoginRequest, EmailRegisterRequest, ForgotPasswordRequest, LinkEmailRequest, LinkWalletRequest, LoginRequest, LogoutRequest, OauthInteractionConfirmRequest, RefreshTokenRequest, RequestNonceRequest, ResendVerificationForRegisterRequest, ResetPasswordRequest, VerifyEmailRequest, WalletLoginRequest };
+export { ChangePasswordRequest, EmailLoginRequest, EmailRegisterRequest, ForgotPasswordRequest, LinkEmailRequest, LinkWalletRequest, LoginRequest, LogoutRequest, OauthInteractionConfirmRequest, RefreshTokenRequest, RequestNonceRequest, ResendVerificationForRegisterRequest, ResetPasswordRequest, StartXLinkRequest, StartXLoginRequest, VerifyEmailRequest, WalletLoginRequest };

package/dist/auth/response.d.ts

@@ -13,6 +13,7 @@ export declare const LoginResponse: z.ZodObject<{
             email: "email";
             evm_wallet: "evm_wallet";
             oauth: "oauth";
+            x: "x";
         }>;
     }, z.core.$strip>;
 }, z.core.$strip>;
@@ -50,11 +51,24 @@ export declare const VerifyEmailResponse: z.ZodObject<{
 }, z.core.$strip>;
 export declare const LinkEmailResponse: z.ZodVoid;
 export declare const LinkWalletResponse: z.ZodVoid;
+export declare const StartXLinkResponse: z.ZodObject<{
+    authorizeUrl: z.ZodString;
+}, z.core.$strip>;
+export declare const DisconnectXResponse: z.ZodVoid;
+export declare const StartXLoginResponse: z.ZodObject<{
+    authorizeUrl: z.ZodString;
+}, z.core.$strip>;
 export declare const RequestNonceResponse: z.ZodObject<{
     nonce: z.ZodString;
     message: z.ZodString;
     expiresAt: z.ZodNumber;
 }, z.core.$strip>;
+/**
+ * The session endpoint answers for the whole account, not just the credential in play:
+ * `providerId`/`loginMethod` describe the current session, `identities` lists every login
+ * the account can be reached by - which is what a client needs to offer "connect" and
+ * "disconnect" for the rest.
+ */
 export declare const MeResponse: z.ZodObject<{
     id: z.ZodUUID;
     role: z.ZodEnum<{
@@ -66,7 +80,18 @@ export declare const MeResponse: z.ZodObject<{
         email: "email";
         evm_wallet: "evm_wallet";
         oauth: "oauth";
+        x: "x";
     }>;
+    identities: z.ZodArray<z.ZodObject<{
+        provider: z.ZodEnum<{
+            email: "email";
+            evm_wallet: "evm_wallet";
+            oauth: "oauth";
+            x: "x";
+        }>;
+        externalId: z.ZodString;
+        connectedAt: z.ZodString;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const OauthGrant: z.ZodObject<{
     id: z.ZodString;
@@ -111,6 +136,9 @@ export type LogoutResponse = z.infer<typeof LogoutResponse>;
 export type RegisterEmailResponse = z.infer<typeof RegisterEmailResponse>;
 export type LinkEmailResponse = z.infer<typeof LinkEmailResponse>;
 export type LinkWalletResponse = z.infer<typeof LinkWalletResponse>;
+export type StartXLinkResponse = z.infer<typeof StartXLinkResponse>;
+export type DisconnectXResponse = z.infer<typeof DisconnectXResponse>;
+export type StartXLoginResponse = z.infer<typeof StartXLoginResponse>;
 export type MeResponse = z.infer<typeof MeResponse>;
 export type OauthGrant = z.infer<typeof OauthGrant>;
 export type OauthGrantsResponse = z.infer<typeof OauthGrantsResponse>;

package/dist/auth/response.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { AuthenticatedUser } from './entities';
+import { AuthenticatedUser, ConnectedIdentity } from './entities';
 
 const LoginResponse = z.object({
   accessToken: z.string().describe("New JWT access token"),
@@ -31,12 +31,21 @@ const VerifyEmailResponse = z.object({
 }).describe("Successful email verification response");
 const LinkEmailResponse = z.void().describe("Successful email verification response");
 const LinkWalletResponse = z.void().describe("Successful wallet link response");
+const StartXLinkResponse = z.object({
+  authorizeUrl: z.string().describe("X authorization URL to send the browser to. Expires with the flow's state.")
+}).describe("Start of the X account link flow");
+const DisconnectXResponse = z.void().describe("Successful X account disconnect response");
+const StartXLoginResponse = z.object({
+  authorizeUrl: z.string().describe("X authorization URL to send the browser to. Expires with the flow's state.")
+}).describe("Start of the X sign-in flow");
 const RequestNonceResponse = z.object({
   nonce: z.string().describe("Nonce to sign with wallet"),
   message: z.string().describe("Domain-bound wallet sign-in message"),
   expiresAt: z.number().int().positive().describe("Unix timestamp when nonce expires")
 }).describe("Nonce response for wallet authentication");
-const MeResponse = AuthenticatedUser.describe("Current authenticated user info");
+const MeResponse = AuthenticatedUser.extend({
+  identities: z.array(ConnectedIdentity).describe("Every provider identity connected to this account, oldest first")
+}).describe("Current authenticated user info");
 const OauthGrant = z.object({
   id: z.string().describe("OAuth grant id \u2014 used to revoke this grant"),
   name: z.string().describe("Human-readable client name, falling back to the client id when unnamed"),
@@ -64,4 +73,4 @@ const OauthInteractionRedirectResponse = z.object({
   returnTo: z.string().describe("Provider URL to redirect the browser back to")
 }).describe("OAuth interaction redirect target after login/confirm/abort");
 
-export { ChangePasswordResponse, ForgotPasswordResponse, LinkEmailResponse, LinkWalletResponse, LoginResponse, LogoutResponse, MeResponse, OauthGrant, OauthGrantsResponse, OauthInteractionClient, OauthInteractionDetailsResponse, OauthInteractionRedirectResponse, RefreshSessionResponse, RefreshTokenResponse, RegisterEmailResponse, RequestNonceResponse, ResendVerificationResponse, ResetPasswordResponse, VerifyEmailResponse };
+export { ChangePasswordResponse, DisconnectXResponse, ForgotPasswordResponse, LinkEmailResponse, LinkWalletResponse, LoginResponse, LogoutResponse, MeResponse, OauthGrant, OauthGrantsResponse, OauthInteractionClient, OauthInteractionDetailsResponse, OauthInteractionRedirectResponse, RefreshSessionResponse, RefreshTokenResponse, RegisterEmailResponse, RequestNonceResponse, ResendVerificationResponse, ResetPasswordResponse, StartXLinkResponse, StartXLoginResponse, VerifyEmailResponse };

package/dist/statistics/entities.d.ts

@@ -17,6 +17,10 @@ export declare const LeaderboardRow: z.ZodObject<{
     pearFee: z.ZodString;
     tradeFee: z.ZodString;
     totalTrades: z.ZodNumber;
+    xHandle: z.ZodOptional<z.ZodString>;
+    xName: z.ZodOptional<z.ZodString>;
+    xAvatarUrl: z.ZodOptional<z.ZodString>;
+    xUserId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type LeaderboardRow = z.output<typeof LeaderboardRow>;
 export declare const VolumeStatistics: z.ZodObject<{

package/dist/statistics/entities.js

@@ -20,7 +20,21 @@ const LeaderboardRow = z.object({
   // V2 calls this builderFee; V3 names it for the column it comes from.
   pearFee: z.string(),
   tradeFee: z.string(),
-  totalTrades: z.number()
+  totalTrades: z.number(),
+  // The trader's linked X account. Absent for an account whose owner has connected no X
+  // account, and absent for an anonymous caller: the board itself is public, but pairing a
+  // real name with a wallet address and a PnL for the open internet is a wider promise than
+  // the one the user accepted when connecting X. Never null-with-a-key: absence is the
+  // signal.
+  //
+  // Whatever X reported at the owner's last authorization. Nothing re-reads X in between,
+  // so a trader who renamed and has not signed in since is named by their old handle.
+  xHandle: z.string().optional(),
+  xName: z.string().optional(),
+  xAvatarUrl: z.string().optional(),
+  // Immutable X numeric id. Link by this, never by the handle: X frees a renamed handle
+  // for anyone to claim immediately, so a cached handle can point at a stranger.
+  xUserId: z.string().optional()
 });
 const VolumeStatistics = z.object({
   timestamp: z.number(),

package/dist/statistics/responses.d.ts

@@ -18,6 +18,10 @@ export declare const LeaderboardResponse: z.ZodObject<{
         pearFee: z.ZodString;
         tradeFee: z.ZodString;
         totalTrades: z.ZodNumber;
+        xHandle: z.ZodOptional<z.ZodString>;
+        xName: z.ZodOptional<z.ZodString>;
+        xAvatarUrl: z.ZodOptional<z.ZodString>;
+        xUserId: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type LeaderboardResponse = z.output<typeof LeaderboardResponse>;

package/dist/users/entities.d.ts

@@ -12,6 +12,9 @@ export declare const UserProfile: z.ZodObject<{
     address: z.ZodNullable<z.ZodString>;
     email: z.ZodNullable<z.ZodString>;
     emailVerified: z.ZodBoolean;
+    xHandle: z.ZodNullable<z.ZodString>;
+    xName: z.ZodNullable<z.ZodString>;
+    xAvatarUrl: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 export type UserPreferences = z.infer<typeof UserPreferences>;
 export type UserProfile = z.infer<typeof UserProfile>;

package/dist/users/entities.js

@@ -10,7 +10,12 @@ const UserProfile = z.object({
   role: z.enum(["basic", "pro"]).describe("User role"),
   address: z.string().nullable().describe("Linked wallet address (for evm_wallet provider)"),
   email: z.string().nullable().describe("Linked email address (for email provider)"),
-  emailVerified: z.boolean().describe("Whether the email is verified")
+  emailVerified: z.boolean().describe("Whether the email is verified"),
+  // Nullable rather than optional to match `address` and `email` above. Splitting
+  // conventions inside one object costs more than following its neighbours.
+  xHandle: z.string().nullable().describe('Linked X handle, without the leading "@" (for x provider)'),
+  xName: z.string().nullable().describe("Linked X display name"),
+  xAvatarUrl: z.string().nullable().describe("Linked X avatar URL")
 }).describe("User profile of the authenticated user");
 const ReferralReferee = z.object({
   address: EthereumAddress.optional().describe("Linked EVM wallet address when the referee has one"),

package/dist/users/response.d.ts

@@ -10,6 +10,9 @@ export declare const ProfileResponse: z.ZodObject<{
         address: z.ZodNullable<z.ZodString>;
         email: z.ZodNullable<z.ZodString>;
         emailVerified: z.ZodBoolean;
+        xHandle: z.ZodNullable<z.ZodString>;
+        xName: z.ZodNullable<z.ZodString>;
+        xAvatarUrl: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>;
     preferences: z.ZodObject<{
         slippageToleranceBps: z.ZodInt;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/types",
-  "version": "1.22.0",
+  "version": "1.24.0",
   "description": "Pear Protocol Types definitions",
   "private": false,
   "type": "module",