@pear-protocol/types 2.12.1 → 2.13.0

package/dist/auth/payloads.js

@@ -25,8 +25,8 @@ 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 SetXVisibilityRequest = z.object({
-  xHidden: z.boolean().describe("True to withhold the linked X account from the leaderboard, false to publish it. The wanted state rather than a flip, so a retry lands on the same result and two tabs cannot disagree. Named to match `xHidden` on the user profile - one name for one value.")
-}).describe("Leaderboard visibility of the X account");
+  xHidden: z.boolean().describe("True to withhold the linked X account from the leaderboard and public trader profiles, false to publish it. The wanted state rather than a flip, so a retry lands on the same result and two tabs cannot disagree. Named to match `xHidden` on the user profile - one name for one value.")
+}).describe("Visibility of the X account on the leaderboard and public trader profiles");
 const PkceValue = z.string().regex(/^[A-Za-z0-9_-]{43}$/, "Must be 43 base64url characters");
 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. Any fragment is dropped - the flow returns its ticket there."),

package/dist/auth/response.js

@@ -38,8 +38,8 @@ 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 SetXVisibilityResponse = z.object({
-  xHidden: z.boolean().describe("The stored state, read back from the write: true when the leaderboard withholds the X account. A confirmation of what was asked for, not a value the caller could not otherwise know.")
-}).describe("Leaderboard visibility of the X account after the write");
+  xHidden: z.boolean().describe("The stored state, read back from the write: true when the leaderboard and public trader profiles withhold the X account. A confirmation of what was asked for, not a value the caller could not otherwise know.")
+}).describe("Visibility of the X account on the leaderboard and public trader profiles after the write");
 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.")

package/dist/statistics/entities.d.ts

@@ -10,6 +10,7 @@ export declare const LeaderboardRow: z.ZodObject<{
         lighter: "lighter";
         lighter_rhc: "lighter_rhc";
     }>;
+    copyingEnabled: z.ZodBoolean;
     followers: z.ZodArray<z.ZodObject<{
         tradeAccountId: z.ZodUUID;
         status: z.ZodLiteral<"ACTIVE">;

package/dist/statistics/entities.js

@@ -10,8 +10,12 @@ const LeaderboardRow = z.object({
   // address beside a real name and a PnL deanonymizes a trader for good, and an address is
   // not reversible once scraped. Neither id here is a credential — every route that takes
   // one checks ownership or role, never knowledge of the id.
+  // This guarantee applies to private routes. Shared public profiles are addressable by
+  // tradeAccountId and omit the exchange identifier, including when the owner shows X identity.
   userId: z.string(),
   connector: Connector,
+  // Current owner consent; venue support and admission availability also apply.
+  copyingEnabled: z.boolean().describe("Whether the owner allows new copy subscriptions; venue support and admission availability also apply"),
   // Followers when this board was cached, independent of the performance date range.
   followers: z.array(CopyFollower),
   followerCount: z.number().int().nonnegative(),

package/dist/statistics/responses.d.ts

@@ -11,6 +11,7 @@ export declare const LeaderboardResponse: z.ZodObject<{
             lighter: "lighter";
             lighter_rhc: "lighter_rhc";
         }>;
+        copyingEnabled: z.ZodBoolean;
         followers: z.ZodArray<z.ZodObject<{
             tradeAccountId: z.ZodUUID;
             status: z.ZodLiteral<"ACTIVE">;

package/dist/traders/public.d.ts

@@ -2571,7 +2571,11 @@ export declare const PublicTraderResponse: z.ZodObject<{
         lighter: "lighter";
         lighter_rhc: "lighter_rhc";
     }>;
-    exchangeIdentifier: z.ZodString;
+    copyingEnabled: z.ZodBoolean;
+    xHandle: z.ZodOptional<z.ZodString>;
+    xName: z.ZodOptional<z.ZodString>;
+    xAvatarUrl: z.ZodOptional<z.ZodString>;
+    xUserId: z.ZodOptional<z.ZodString>;
     followers: z.ZodArray<z.ZodObject<{
         tradeAccountId: z.ZodUUID;
         status: z.ZodLiteral<"ACTIVE">;

package/dist/traders/public.js

@@ -148,7 +148,12 @@ const PublicLadder = Ladder.pick({
 });
 const PublicTraderResponse = z.object({
   connector: Connector.describe("Exchange connector type"),
-  exchangeIdentifier: z.string().describe("User identifier on the exchange"),
+  copyingEnabled: z.boolean().describe("Whether the owner allows new copy subscriptions; venue support and admission availability also apply"),
+  // Omit X identity when the owner hides it or has not linked an account.
+  xHandle: z.string().optional().describe("Public X handle at the last authorization; absent when hidden or unlinked"),
+  xName: z.string().optional().describe("Public X display name; absent when hidden or unlinked"),
+  xAvatarUrl: z.string().optional().describe("Public X avatar URL; absent when hidden or unlinked"),
+  xUserId: z.string().optional().describe("Immutable X numeric user ID; absent when hidden or unlinked"),
   // Followers are complete; the latest-20 limit applies only to trading records.
   followers: z.array(CopyFollower),
   followerCount: z.number().int().nonnegative(),

package/dist/users/entities.js

@@ -24,7 +24,7 @@ const UserProfile = z.object({
   // A plain boolean rather than nullable, matching `emailVerified` above: this is the
   // owner's own setting, which is known whether or not an X account is linked. With none
   // linked it describes what would happen once one is.
-  xHidden: z.boolean().describe("Whether the leaderboard withholds the linked X account")
+  xHidden: z.boolean().describe("Whether the leaderboard and public trader profiles withhold the linked X account")
 }).describe("User profile of the authenticated user");
 const BoundReferralReferee = z.object({
   status: z.literal("BOUND").describe("The referee resolves to a V3 user with a permanent binding"),

package/package.json

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