@metamask/social-controllers 0.2.0 → 2.0.0

package/dist/social-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"social-types.mjs","sourceRoot":"","sources":["../src/social-types.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,EACN,IAAI,IAAI,UAAU,EACnB,8BAA8B;AA8B/B,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;IACpC,SAAS,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5B,WAAW,EAAE,MAAM,EAAE;IACrB,OAAO,EAAE,MAAM,EAAE;IACjB,SAAS,EAAE,MAAM,EAAE;IACnB,eAAe,EAAE,MAAM,EAAE;CAC1B,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  enums,\n  number,\n  optional,\n  string,\n  type as structType,\n} from '@metamask/superstruct';\n\n// ---------------------------------------------------------------------------\n// Shared sub-types\n// ---------------------------------------------------------------------------\n\n/**\n * Minimal profile summary used across follow/follower responses.\n */\nexport type ProfileSummary = {\n  /** Clicker profile ID (UUID). */\n  profileId: string;\n  /** Primary wallet address. */\n  address: string;\n  /** Display name or truncated address. */\n  name: string;\n  /** Profile avatar URL. */\n  imageUrl?: string | null;\n};\n\n/**\n * Social media handles attached to a trader profile.\n */\nexport type SocialHandles = {\n  twitter?: string | null;\n  farcaster?: string | null;\n  ens?: string | null;\n  lens?: string | null;\n};\n\nexport const TradeStruct = structType({\n  direction: enums(['buy', 'sell']),\n  intent: enums(['enter', 'exit']),\n  category: optional(string()),\n  tokenAmount: number(),\n  usdCost: number(),\n  timestamp: number(),\n  transactionHash: string(),\n});\n\nexport type Trade = Infer<typeof TradeStruct>;\n\n// ---------------------------------------------------------------------------\n// Leaderboard\n// ---------------------------------------------------------------------------\n\n/**\n * A single entry in the leaderboard response.\n */\nexport type LeaderboardEntry = {\n  rank: number;\n  addresses: string[];\n  profileId: string;\n  name: string;\n  imageUrl?: string | null;\n  pnl30d: number;\n  winRate30d?: number | null;\n  /** Renamed from roi30d. */\n  roiPercent30d?: number | null;\n  /** Renamed from tradeCount. */\n  tradeCount30d?: number | null;\n  pnl7d?: number | null;\n  winRate7d?: number | null;\n  roiPercent7d?: number | null;\n  tradeCount7d?: number | null;\n  pnlPerChain: Record<string, number>;\n  followerCount: number;\n  socialHandles: SocialHandles;\n};\n\n/**\n * Response from `GET /v1/leaderboard`.\n */\nexport type LeaderboardResponse = {\n  traders: LeaderboardEntry[];\n};\n\n// ---------------------------------------------------------------------------\n// Trader profile\n// ---------------------------------------------------------------------------\n\nexport type TraderProfile = {\n  profileId: string;\n  address: string;\n  allAddresses: string[];\n  name: string;\n  imageUrl?: string | null;\n};\n\nexport type TraderStats = {\n  pnl30d?: number | null;\n  winRate30d?: number | null;\n  /** Renamed from roi30d. */\n  roiPercent30d?: number | null;\n  /** Renamed from tradeCount. */\n  tradeCount30d?: number | null;\n  pnl7d?: number | null;\n  winRate7d?: number | null;\n  roiPercent7d?: number | null;\n  tradeCount7d?: number | null;\n  /** Median holding time in minutes. */\n  medianHoldMinutes?: number | null;\n};\n\nexport type PerChainBreakdown = {\n  perChainPnl: Record<string, number>;\n  /** ROI can be null for chains with no trading activity (zero cost-basis). */\n  perChainRoi: Record<string, number | null>;\n  perChainVolume: Record<string, number>;\n};\n\n/**\n * Response from `GET /v1/traders/:addressOrId/profile`.\n */\nexport type TraderProfileResponse = {\n  profile: TraderProfile;\n  stats: TraderStats;\n  perChainBreakdown: PerChainBreakdown;\n  socialHandles: SocialHandles;\n  followerCount: number;\n  followingCount: number;\n};\n\n// ---------------------------------------------------------------------------\n// Positions\n// ---------------------------------------------------------------------------\n\nexport type Position = {\n  tokenSymbol: string;\n  tokenName: string;\n  tokenAddress: string;\n  chain: string;\n  positionAmount: number;\n  boughtUsd: number;\n  soldUsd: number;\n  realizedPnl: number;\n  costBasis: number;\n  trades: Trade[];\n  lastTradeAt: number;\n  /** Daylight-hosted token image URL. */\n  tokenImageUrl?: string | null;\n  /** Current USD value of the remaining position (open positions only). */\n  currentValueUSD?: number | null;\n  /** Unrealized + realized PnL in USD. */\n  pnlValueUsd?: number | null;\n  /** PnL as a percentage of cost basis. */\n  pnlPercent?: number | null;\n};\n\nexport type Pagination = {\n  hasMore: boolean;\n  nextPage?: number;\n};\n\n/**\n * Response from `GET /v1/traders/:addressOrId/positions/open`\n * and `GET /v1/traders/:addressOrId/positions/closed`.\n */\nexport type PositionsResponse = {\n  positions: Position[];\n  pagination: Pagination;\n  /** ISO 8601 timestamp indicating when the response was computed server-side. */\n  computedAt?: string | null;\n};\n\n// ---------------------------------------------------------------------------\n// Followers\n// ---------------------------------------------------------------------------\n\n/**\n * Response from `GET /v1/traders/:addressOrId/followers`.\n */\nexport type FollowersResponse = {\n  followers: ProfileSummary[];\n  count: number;\n};\n\n// ---------------------------------------------------------------------------\n// Following\n// ---------------------------------------------------------------------------\n\n/**\n * Response from `GET /v1/users/:addressOrUid/following`.\n */\nexport type FollowingResponse = {\n  following: ProfileSummary[];\n  count: number;\n};\n\n// ---------------------------------------------------------------------------\n// Follow / Unfollow\n// ---------------------------------------------------------------------------\n\n/**\n * Response from `PUT /v1/users/:addressOrUid/follows`.\n */\nexport type FollowResponse = {\n  followed: ProfileSummary[];\n};\n\n/**\n * Response from `DELETE /v1/users/:addressOrUid/follows`.\n */\nexport type UnfollowResponse = {\n  unfollowed: ProfileSummary[];\n};\n\n// ---------------------------------------------------------------------------\n// Fetch options\n// ---------------------------------------------------------------------------\n\nexport type FetchLeaderboardOptions = {\n  sort?: 'pnl' | 'winRate' | 'roi';\n  chains?: string[];\n  limit?: number;\n};\n\nexport type FetchTraderProfileOptions = {\n  /** Wallet address or Clicker profile ID. */\n  addressOrId: string;\n};\n\nexport type FetchPositionsOptions = {\n  /** Wallet address or Clicker profile ID. */\n  addressOrId: string;\n  chain?: string;\n  sort?: 'value' | 'latest';\n  limit?: number;\n  page?: number;\n};\n\nexport type FetchFollowersOptions = {\n  /** Wallet address or Clicker profile ID. */\n  addressOrId: string;\n};\n\nexport type FetchFollowingOptions = {\n  /** Wallet address or Clicker profile ID. */\n  addressOrUid: string;\n};\n\nexport type FollowOptions = {\n  /** Wallet address or Clicker profile ID of the user. */\n  addressOrUid: string;\n  /** Array of wallet addresses or profile IDs to follow. */\n  targets: string[];\n};\n\nexport type UnfollowOptions = {\n  /** Wallet address or Clicker profile ID of the user. */\n  addressOrUid: string;\n  /** Array of wallet addresses or profile IDs to unfollow. */\n  targets: string[];\n};\n\n// ---------------------------------------------------------------------------\n// Controller state\n// ---------------------------------------------------------------------------\n\n/**\n * State managed by the SocialController.\n *\n * The controller acts as a simple store — no TTL or eviction logic.\n * The UI decides when to re-fetch; the social-api's own cache layer\n * handles upstream rate-limiting.\n */\nexport type SocialControllerState = {\n  /** Cached ranked trader list from the last `updateLeaderboard` call. */\n  leaderboardEntries: LeaderboardEntry[];\n  /** Wallet addresses the current user follows. */\n  followingAddresses: string[];\n  /** Clicker profile IDs the current user follows — used by mobile UI. */\n  followingProfileIds: string[];\n};\n"]}
+{"version":3,"file":"social-types.mjs","sourceRoot":"","sources":["../src/social-types.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,EACN,IAAI,IAAI,UAAU,EACnB,8BAA8B;AA8B/B,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;IACpC,SAAS,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5B,WAAW,EAAE,MAAM,EAAE;IACrB,OAAO,EAAE,MAAM,EAAE;IACjB,SAAS,EAAE,MAAM,EAAE;IACnB,eAAe,EAAE,MAAM,EAAE;CAC1B,CAAC,CAAC","sourcesContent":["import type { Infer } from '@metamask/superstruct';\nimport {\n  enums,\n  number,\n  optional,\n  string,\n  type as structType,\n} from '@metamask/superstruct';\n\n// ---------------------------------------------------------------------------\n// Shared sub-types\n// ---------------------------------------------------------------------------\n\n/**\n * Minimal profile summary used across follow/follower responses.\n */\nexport type ProfileSummary = {\n  /** Clicker profile ID (UUID). */\n  profileId: string;\n  /** Primary wallet address. */\n  address: string;\n  /** Display name or truncated address. */\n  name: string;\n  /** Profile avatar URL. */\n  imageUrl?: string | null;\n};\n\n/**\n * Social media handles attached to a trader profile.\n */\nexport type SocialHandles = {\n  twitter?: string | null;\n  farcaster?: string | null;\n  ens?: string | null;\n  lens?: string | null;\n};\n\nexport const TradeStruct = structType({\n  direction: enums(['buy', 'sell']),\n  intent: enums(['enter', 'exit']),\n  category: optional(string()),\n  tokenAmount: number(),\n  usdCost: number(),\n  timestamp: number(),\n  transactionHash: string(),\n});\n\nexport type Trade = Infer<typeof TradeStruct>;\n\n// ---------------------------------------------------------------------------\n// Leaderboard\n// ---------------------------------------------------------------------------\n\n/**\n * A single entry in the leaderboard response.\n */\nexport type LeaderboardEntry = {\n  rank: number;\n  addresses: string[];\n  profileId: string;\n  name: string;\n  imageUrl?: string | null;\n  pnl30d: number;\n  winRate30d?: number | null;\n  /** Renamed from roi30d. */\n  roiPercent30d?: number | null;\n  /** Renamed from tradeCount. */\n  tradeCount30d?: number | null;\n  pnl7d?: number | null;\n  winRate7d?: number | null;\n  roiPercent7d?: number | null;\n  tradeCount7d?: number | null;\n  pnlPerChain: Record<string, number>;\n  followerCount: number;\n  socialHandles: SocialHandles;\n};\n\n/**\n * Response from `GET /v1/leaderboard`.\n */\nexport type LeaderboardResponse = {\n  traders: LeaderboardEntry[];\n};\n\n// ---------------------------------------------------------------------------\n// Trader profile\n// ---------------------------------------------------------------------------\n\nexport type TraderProfile = {\n  profileId: string;\n  address: string;\n  allAddresses: string[];\n  name: string;\n  imageUrl?: string | null;\n};\n\nexport type TraderStats = {\n  pnl30d?: number | null;\n  winRate30d?: number | null;\n  /** Renamed from roi30d. */\n  roiPercent30d?: number | null;\n  /** Renamed from tradeCount. */\n  tradeCount30d?: number | null;\n  pnl7d?: number | null;\n  winRate7d?: number | null;\n  roiPercent7d?: number | null;\n  tradeCount7d?: number | null;\n  /** Median holding time in minutes. */\n  medianHoldMinutes?: number | null;\n};\n\nexport type PerChainBreakdown = {\n  perChainPnl: Record<string, number>;\n  /** ROI can be null for chains with no trading activity (zero cost-basis). */\n  perChainRoi: Record<string, number | null>;\n  perChainVolume: Record<string, number>;\n};\n\n/**\n * Response from `GET /v1/traders/:addressOrId/profile`.\n */\nexport type TraderProfileResponse = {\n  profile: TraderProfile;\n  stats: TraderStats;\n  perChainBreakdown: PerChainBreakdown;\n  socialHandles: SocialHandles;\n  followerCount: number;\n  followingCount: number;\n};\n\n// ---------------------------------------------------------------------------\n// Positions\n// ---------------------------------------------------------------------------\n\nexport type Position = {\n  tokenSymbol: string;\n  tokenName: string;\n  tokenAddress: string;\n  chain: string;\n  positionAmount: number;\n  boughtUsd: number;\n  soldUsd: number;\n  realizedPnl: number;\n  costBasis: number;\n  trades: Trade[];\n  lastTradeAt: number;\n  /** Daylight-hosted token image URL. */\n  tokenImageUrl?: string | null;\n  /** Current USD value of the remaining position (open positions only). */\n  currentValueUSD?: number | null;\n  /** Unrealized + realized PnL in USD. */\n  pnlValueUsd?: number | null;\n  /** PnL as a percentage of cost basis. */\n  pnlPercent?: number | null;\n};\n\nexport type Pagination = {\n  hasMore: boolean;\n  nextPage?: number;\n};\n\n/**\n * Response from `GET /v1/traders/:addressOrId/positions/open`\n * and `GET /v1/traders/:addressOrId/positions/closed`.\n */\nexport type PositionsResponse = {\n  positions: Position[];\n  pagination: Pagination;\n  /** ISO 8601 timestamp indicating when the response was computed server-side. */\n  computedAt?: string | null;\n};\n\n// ---------------------------------------------------------------------------\n// Followers\n// ---------------------------------------------------------------------------\n\n/**\n * Response from `GET /v1/traders/:addressOrId/followers`.\n */\nexport type FollowersResponse = {\n  followers: ProfileSummary[];\n  count: number;\n};\n\n// ---------------------------------------------------------------------------\n// Following\n// ---------------------------------------------------------------------------\n\n/**\n * Response from `GET /v1/users/me/following`.\n */\nexport type FollowingResponse = {\n  following: ProfileSummary[];\n  count: number;\n};\n\n// ---------------------------------------------------------------------------\n// Follow / Unfollow\n// ---------------------------------------------------------------------------\n\n/**\n * Response from `PUT /v1/users/me/follows`.\n */\nexport type FollowResponse = {\n  followed: ProfileSummary[];\n};\n\n/**\n * Response from `DELETE /v1/users/me/follows`.\n */\nexport type UnfollowResponse = {\n  unfollowed: ProfileSummary[];\n};\n\n// ---------------------------------------------------------------------------\n// Fetch options\n// ---------------------------------------------------------------------------\n\nexport type FetchLeaderboardOptions = {\n  sort?: 'pnl' | 'winRate' | 'roi';\n  chains?: string[];\n  limit?: number;\n};\n\nexport type FetchTraderProfileOptions = {\n  /** Wallet address or Clicker profile ID. */\n  addressOrId: string;\n};\n\nexport type FetchPositionsOptions = {\n  /** Wallet address or Clicker profile ID. */\n  addressOrId: string;\n  chain?: string;\n  sort?: 'value' | 'latest';\n  limit?: number;\n  page?: number;\n};\n\nexport type FetchFollowersOptions = {\n  /** Wallet address or Clicker profile ID. */\n  addressOrId: string;\n};\n\nexport type FollowOptions = {\n  /** Array of wallet addresses or profile IDs to follow. */\n  targets: string[];\n};\n\nexport type UnfollowOptions = {\n  /** Array of wallet addresses or profile IDs to unfollow. */\n  targets: string[];\n};\n\n// ---------------------------------------------------------------------------\n// Controller state\n// ---------------------------------------------------------------------------\n\n/**\n * State managed by the SocialController.\n *\n * The controller acts as a simple store — no TTL or eviction logic.\n * The UI decides when to re-fetch; the social-api's own cache layer\n * handles upstream rate-limiting.\n */\nexport type SocialControllerState = {\n  /** Cached ranked trader list from the last `updateLeaderboard` call. */\n  leaderboardEntries: LeaderboardEntry[];\n  /** Wallet addresses the current user follows. */\n  followingAddresses: string[];\n  /** Clicker profile IDs the current user follows — used by mobile UI. */\n  followingProfileIds: string[];\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/social-controllers",
-  "version": "0.2.0",
+  "version": "2.0.0",
   "description": "A collection of social related controllers",
   "keywords": [
     "Ethereum",
@@ -44,8 +44,8 @@
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/social-controllers",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/social-controllers",
-    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --check",
-    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --generate",
+    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
+    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
     "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
@@ -57,10 +57,11 @@
     "@metamask/base-data-service": "^0.1.1",
     "@metamask/controller-utils": "^11.20.0",
     "@metamask/messenger": "^1.1.1",
+    "@metamask/profile-sync-controller": "^28.0.2",
     "@metamask/superstruct": "^3.1.0"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^6.0.0",
+    "@metamask/auto-changelog": "^6.1.0",
     "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^29.5.14",
     "deepmerge": "^4.2.2",