@metamask-previews/social-controllers 2.8.0-preview-4f4c98e → 2.8.0-preview-eb263b0ee

package/dist/SocialService-method-action-types.d.mts

@@ -0,0 +1,194 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { SocialService } from "./SocialService.mjs";
+/**
+ * Fetches the leaderboard of top traders.
+ *
+ * Calls `GET ${baseUrl}/leaderboard`.
+ *
+ * @param options - Optional query parameters for sorting, chain filtering, and limit.
+ * @returns The leaderboard response with ranked traders.
+ */
+export type SocialServiceFetchLeaderboardAction = {
+    type: `SocialService:fetchLeaderboard`;
+    handler: SocialService['fetchLeaderboard'];
+};
+/**
+ * Fetches a trader's profile by address or profile ID.
+ *
+ * Calls `GET ${baseUrl}/traders/${addressOrId}/profile`.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrId - Wallet address or Clicker profile ID.
+ * @returns The trader profile response.
+ */
+export type SocialServiceFetchTraderProfileAction = {
+    type: `SocialService:fetchTraderProfile`;
+    handler: SocialService['fetchTraderProfile'];
+};
+/**
+ * Fetches a trader's open positions.
+ *
+ * Calls `GET ${baseUrl}/traders/${addressOrId}/positions/open`.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrId - Wallet address or Clicker profile ID.
+ * @param options.chain - Filter by chain.
+ * @param options.sort - Sort by 'value' or 'latest'.
+ * @param options.limit - Number of results per page.
+ * @param options.page - Page number (1-based).
+ * @returns The positions response.
+ */
+export type SocialServiceFetchOpenPositionsAction = {
+    type: `SocialService:fetchOpenPositions`;
+    handler: SocialService['fetchOpenPositions'];
+};
+/**
+ * Fetches a trader's closed positions.
+ *
+ * Calls `GET ${baseUrl}/traders/${addressOrId}/positions/closed`.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrId - Wallet address or Clicker profile ID.
+ * @param options.chain - Filter by chain.
+ * @param options.sort - Sort by 'value' or 'latest'.
+ * @param options.limit - Number of results per page.
+ * @param options.page - Page number (1-based).
+ * @returns The positions response.
+ */
+export type SocialServiceFetchClosedPositionsAction = {
+    type: `SocialService:fetchClosedPositions`;
+    handler: SocialService['fetchClosedPositions'];
+};
+/**
+ * Fetches a trader's MetaMask followers.
+ *
+ * Calls `GET ${baseUrl}/traders/${addressOrId}/followers`.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrId - Wallet address or Clicker profile ID.
+ * @returns The followers response.
+ */
+export type SocialServiceFetchFollowersAction = {
+    type: `SocialService:fetchFollowers`;
+    handler: SocialService['fetchFollowers'];
+};
+/**
+ * Fetches a single position by its unique ID.
+ *
+ * Calls `GET ${baseUrl}/traders/position/${positionId}`.
+ *
+ * @param options - Options bag.
+ * @param options.positionId - Unique position ID (UUID).
+ * @returns The position.
+ */
+export type SocialServiceFetchPositionByIdAction = {
+    type: `SocialService:fetchPositionById`;
+    handler: SocialService['fetchPositionById'];
+};
+/**
+ * Fetches a page of the trader-activity feed.
+ *
+ * Calls `GET ${baseUrl}/feed`. For the `following` scope the current user is
+ * identified server-side from the JWT sub claim carried in the Authorization
+ * header; the `leaderboard` scope is generic and shared by all users.
+ *
+ * Cursor pagination supports infinite scroll: pass `pagination.olderCursor`
+ * from a prior response back as `olderThan` to load older items, and
+ * `pagination.newerCursor` as `newerThan` to fetch newer items.
+ *
+ * @param options - Options bag.
+ * @param options.scope - `following` (default) or `leaderboard`.
+ * @param options.chains - Filter by one or more chains.
+ * @param options.limit - Number of results per page.
+ * @param options.olderThan - Cursor for older items (scroll down).
+ * @param options.newerThan - Cursor for newer items (refresh).
+ * @returns The feed response with items and pagination cursors.
+ */
+export type SocialServiceFetchFeedAction = {
+    type: `SocialService:fetchFeed`;
+    handler: SocialService['fetchFeed'];
+};
+/**
+ * Fetches the list of traders the current user is following.
+ *
+ * Calls `GET ${baseUrl}/users/me/following`. The caller is identified
+ * server-side from the JWT sub claim carried in the Authorization header.
+ *
+ * @returns The following response.
+ */
+export type SocialServiceFetchFollowingAction = {
+    type: `SocialService:fetchFollowing`;
+    handler: SocialService['fetchFollowing'];
+};
+/**
+ * Follows one or more traders on behalf of the current user.
+ *
+ * Calls `PUT ${baseUrl}/users/me/follows`. The caller is identified
+ * server-side from the JWT sub claim carried in the Authorization header.
+ *
+ * @param options - Options bag.
+ * @param options.targets - Array of wallet addresses or profile IDs to follow.
+ * @returns The follow response with confirmed follows.
+ */
+export type SocialServiceFollowAction = {
+    type: `SocialService:follow`;
+    handler: SocialService['follow'];
+};
+/**
+ * Unfollows one or more traders on behalf of the current user.
+ *
+ * Calls `DELETE ${baseUrl}/users/me/follows?targets=...`. Targets are sent
+ * as query params because Fastify does not parse request bodies on DELETE
+ * requests per RFC 9110. The caller is identified server-side from the JWT
+ * sub claim carried in the Authorization header.
+ *
+ * @param options - Options bag.
+ * @param options.targets - Array of wallet addresses or profile IDs to unfollow.
+ * @returns The unfollow response with confirmed unfollows.
+ */
+export type SocialServiceUnfollowAction = {
+    type: `SocialService:unfollow`;
+    handler: SocialService['unfollow'];
+};
+/**
+ * Opts the current user out of the PnL leaderboard.
+ */
+export type SocialServiceOptOutOfLeaderboardAction = {
+    type: `SocialService:optOutOfLeaderboard`;
+    handler: SocialService['optOutOfLeaderboard'];
+};
+/**
+ * Opts the current user back into the PnL leaderboard.
+ */
+export type SocialServiceOptInToLeaderboardAction = {
+    type: `SocialService:optInToLeaderboard`;
+    handler: SocialService['optInToLeaderboard'];
+};
+/**
+ * Asks the social-api to refresh its cached copy of the current user's
+ * notification preferences.
+ *
+ * Calls `POST ${baseUrl}/notifications/preferences/cache-refresh`. The caller
+ * is identified server-side from the JWT sub claim carried in the
+ * Authorization header, so it can only ever refresh its own entry.
+ *
+ * The client calls this immediately after writing a preference change to
+ * Authenticated User Storage (AUS), which is the source of truth. The social
+ * api re-reads from AUS and repopulates its cache so the change is honoured
+ * near-instantly rather than after the cache TTL lapses. It is a pure
+ * optimisation on top of that bounded TTL: the write has already succeeded by
+ * the time this runs, so callers should treat it as best-effort and must not
+ * roll back the AUS write if it fails.
+ */
+export type SocialServiceRefreshNotificationPreferencesCacheAction = {
+    type: `SocialService:refreshNotificationPreferencesCache`;
+    handler: SocialService['refreshNotificationPreferencesCache'];
+};
+/**
+ * Union of all SocialService action types.
+ */
+export type SocialServiceMethodActions = SocialServiceFetchLeaderboardAction | SocialServiceFetchTraderProfileAction | SocialServiceFetchOpenPositionsAction | SocialServiceFetchClosedPositionsAction | SocialServiceFetchFollowersAction | SocialServiceFetchPositionByIdAction | SocialServiceFetchFeedAction | SocialServiceFetchFollowingAction | SocialServiceFollowAction | SocialServiceUnfollowAction | SocialServiceOptOutOfLeaderboardAction | SocialServiceOptInToLeaderboardAction | SocialServiceRefreshNotificationPreferencesCacheAction;
+//# sourceMappingURL=SocialService-method-action-types.d.mts.map

package/dist/SocialService-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialService-method-action-types.d.mts","sourceRoot":"","sources":["../src/SocialService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,4BAA2B;AAExD;;;;;;;GAOG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,aAAa,CAAC,sBAAsB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,yBAAyB,CAAC;IAChC,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;CAClC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,aAAa,CAAC,qBAAqB,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,aAAa,CAAC,qCAAqC,CAAC,CAAC;CAC/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,mCAAmC,GACnC,qCAAqC,GACrC,qCAAqC,GACrC,uCAAuC,GACvC,iCAAiC,GACjC,oCAAoC,GACpC,4BAA4B,GAC5B,iCAAiC,GACjC,yBAAyB,GACzB,2BAA2B,GAC3B,sCAAsC,GACtC,qCAAqC,GACrC,sDAAsD,CAAC"}

package/dist/{SocialService-method-action-types.js → SocialService-method-action-types.mjs}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=SocialService-method-action-types.js.map
+//# sourceMappingURL=SocialService-method-action-types.mjs.map

package/dist/SocialService-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialService-method-action-types.mjs","sourceRoot":"","sources":["../src/SocialService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SocialService } from './SocialService.js';\n\n/**\n * Fetches the leaderboard of top traders.\n *\n * Calls `GET ${baseUrl}/leaderboard`.\n *\n * @param options - Optional query parameters for sorting, chain filtering, and limit.\n * @returns The leaderboard response with ranked traders.\n */\nexport type SocialServiceFetchLeaderboardAction = {\n  type: `SocialService:fetchLeaderboard`;\n  handler: SocialService['fetchLeaderboard'];\n};\n\n/**\n * Fetches a trader's profile by address or profile ID.\n *\n * Calls `GET ${baseUrl}/traders/${addressOrId}/profile`.\n *\n * @param options - Options bag.\n * @param options.addressOrId - Wallet address or Clicker profile ID.\n * @returns The trader profile response.\n */\nexport type SocialServiceFetchTraderProfileAction = {\n  type: `SocialService:fetchTraderProfile`;\n  handler: SocialService['fetchTraderProfile'];\n};\n\n/**\n * Fetches a trader's open positions.\n *\n * Calls `GET ${baseUrl}/traders/${addressOrId}/positions/open`.\n *\n * @param options - Options bag.\n * @param options.addressOrId - Wallet address or Clicker profile ID.\n * @param options.chain - Filter by chain.\n * @param options.sort - Sort by 'value' or 'latest'.\n * @param options.limit - Number of results per page.\n * @param options.page - Page number (1-based).\n * @returns The positions response.\n */\nexport type SocialServiceFetchOpenPositionsAction = {\n  type: `SocialService:fetchOpenPositions`;\n  handler: SocialService['fetchOpenPositions'];\n};\n\n/**\n * Fetches a trader's closed positions.\n *\n * Calls `GET ${baseUrl}/traders/${addressOrId}/positions/closed`.\n *\n * @param options - Options bag.\n * @param options.addressOrId - Wallet address or Clicker profile ID.\n * @param options.chain - Filter by chain.\n * @param options.sort - Sort by 'value' or 'latest'.\n * @param options.limit - Number of results per page.\n * @param options.page - Page number (1-based).\n * @returns The positions response.\n */\nexport type SocialServiceFetchClosedPositionsAction = {\n  type: `SocialService:fetchClosedPositions`;\n  handler: SocialService['fetchClosedPositions'];\n};\n\n/**\n * Fetches a trader's MetaMask followers.\n *\n * Calls `GET ${baseUrl}/traders/${addressOrId}/followers`.\n *\n * @param options - Options bag.\n * @param options.addressOrId - Wallet address or Clicker profile ID.\n * @returns The followers response.\n */\nexport type SocialServiceFetchFollowersAction = {\n  type: `SocialService:fetchFollowers`;\n  handler: SocialService['fetchFollowers'];\n};\n\n/**\n * Fetches a single position by its unique ID.\n *\n * Calls `GET ${baseUrl}/traders/position/${positionId}`.\n *\n * @param options - Options bag.\n * @param options.positionId - Unique position ID (UUID).\n * @returns The position.\n */\nexport type SocialServiceFetchPositionByIdAction = {\n  type: `SocialService:fetchPositionById`;\n  handler: SocialService['fetchPositionById'];\n};\n\n/**\n * Fetches a page of the trader-activity feed.\n *\n * Calls `GET ${baseUrl}/feed`. For the `following` scope the current user is\n * identified server-side from the JWT sub claim carried in the Authorization\n * header; the `leaderboard` scope is generic and shared by all users.\n *\n * Cursor pagination supports infinite scroll: pass `pagination.olderCursor`\n * from a prior response back as `olderThan` to load older items, and\n * `pagination.newerCursor` as `newerThan` to fetch newer items.\n *\n * @param options - Options bag.\n * @param options.scope - `following` (default) or `leaderboard`.\n * @param options.chains - Filter by one or more chains.\n * @param options.limit - Number of results per page.\n * @param options.olderThan - Cursor for older items (scroll down).\n * @param options.newerThan - Cursor for newer items (refresh).\n * @returns The feed response with items and pagination cursors.\n */\nexport type SocialServiceFetchFeedAction = {\n  type: `SocialService:fetchFeed`;\n  handler: SocialService['fetchFeed'];\n};\n\n/**\n * Fetches the list of traders the current user is following.\n *\n * Calls `GET ${baseUrl}/users/me/following`. The caller is identified\n * server-side from the JWT sub claim carried in the Authorization header.\n *\n * @returns The following response.\n */\nexport type SocialServiceFetchFollowingAction = {\n  type: `SocialService:fetchFollowing`;\n  handler: SocialService['fetchFollowing'];\n};\n\n/**\n * Follows one or more traders on behalf of the current user.\n *\n * Calls `PUT ${baseUrl}/users/me/follows`. The caller is identified\n * server-side from the JWT sub claim carried in the Authorization header.\n *\n * @param options - Options bag.\n * @param options.targets - Array of wallet addresses or profile IDs to follow.\n * @returns The follow response with confirmed follows.\n */\nexport type SocialServiceFollowAction = {\n  type: `SocialService:follow`;\n  handler: SocialService['follow'];\n};\n\n/**\n * Unfollows one or more traders on behalf of the current user.\n *\n * Calls `DELETE ${baseUrl}/users/me/follows?targets=...`. Targets are sent\n * as query params because Fastify does not parse request bodies on DELETE\n * requests per RFC 9110. The caller is identified server-side from the JWT\n * sub claim carried in the Authorization header.\n *\n * @param options - Options bag.\n * @param options.targets - Array of wallet addresses or profile IDs to unfollow.\n * @returns The unfollow response with confirmed unfollows.\n */\nexport type SocialServiceUnfollowAction = {\n  type: `SocialService:unfollow`;\n  handler: SocialService['unfollow'];\n};\n\n/**\n * Opts the current user out of the PnL leaderboard.\n */\nexport type SocialServiceOptOutOfLeaderboardAction = {\n  type: `SocialService:optOutOfLeaderboard`;\n  handler: SocialService['optOutOfLeaderboard'];\n};\n\n/**\n * Opts the current user back into the PnL leaderboard.\n */\nexport type SocialServiceOptInToLeaderboardAction = {\n  type: `SocialService:optInToLeaderboard`;\n  handler: SocialService['optInToLeaderboard'];\n};\n\n/**\n * Asks the social-api to refresh its cached copy of the current user's\n * notification preferences.\n *\n * Calls `POST ${baseUrl}/notifications/preferences/cache-refresh`. The caller\n * is identified server-side from the JWT sub claim carried in the\n * Authorization header, so it can only ever refresh its own entry.\n *\n * The client calls this immediately after writing a preference change to\n * Authenticated User Storage (AUS), which is the source of truth. The social\n * api re-reads from AUS and repopulates its cache so the change is honoured\n * near-instantly rather than after the cache TTL lapses. It is a pure\n * optimisation on top of that bounded TTL: the write has already succeeded by\n * the time this runs, so callers should treat it as best-effort and must not\n * roll back the AUS write if it fails.\n */\nexport type SocialServiceRefreshNotificationPreferencesCacheAction = {\n  type: `SocialService:refreshNotificationPreferencesCache`;\n  handler: SocialService['refreshNotificationPreferencesCache'];\n};\n\n/**\n * Union of all SocialService action types.\n */\nexport type SocialServiceMethodActions =\n  | SocialServiceFetchLeaderboardAction\n  | SocialServiceFetchTraderProfileAction\n  | SocialServiceFetchOpenPositionsAction\n  | SocialServiceFetchClosedPositionsAction\n  | SocialServiceFetchFollowersAction\n  | SocialServiceFetchPositionByIdAction\n  | SocialServiceFetchFeedAction\n  | SocialServiceFetchFollowingAction\n  | SocialServiceFollowAction\n  | SocialServiceUnfollowAction\n  | SocialServiceOptOutOfLeaderboardAction\n  | SocialServiceOptInToLeaderboardAction\n  | SocialServiceRefreshNotificationPreferencesCacheAction;\n"]}