@taphubhq/sdk-core 0.20.1 → 0.21.0

package/dist/index.cjs

@@ -633,8 +633,14 @@ function normaliseRankBoard(wire) {
     sort: wire.sort,
     sortDir: wire.sortDir,
     total: wire.total,
-    entries: Array.isArray(wire.entries) ? wire.entries.map(normaliseRankEntry) : [],
-    me: wire.me ? normaliseRankEntry(wire.me) : null
+    entries: Array.isArray(wire.entries) ? wire.entries.map(normaliseRankEntry) : []
+  };
+}
+function normaliseRankMe(wire) {
+  return {
+    rank: wire.rank,
+    total: wire.total,
+    entry: wire.entry ? normaliseRankEntry(wire.entry) : null
   };
 }
 
@@ -652,7 +658,13 @@ var RANK_LEADERBOARD_V2_QUERY = `query RankLeaderboardV2($input: RankBoardInput!
     sortDir
     total
     entries { userId loginBy username rank pnl vol payout wins bids }
-    me { userId loginBy username rank pnl vol payout wins bids }
+  }
+}`;
+var RANK_ME_QUERY = `query RankMe($input: RankMeInput!) {
+  rank_me(input: $input) {
+    rank
+    total
+    entry { userId loginBy username rank pnl vol payout wins bids }
   }
 }`;
 
@@ -676,19 +688,17 @@ var LeaderboardModule = class {
     return normaliseLeaderboard(body.leaderboard);
   }
   /**
-   * Fetch the duration-scoped rank board (`rank_leaderboardV2`).
+   * Fetch the public duration-scoped rank board (`rank_leaderboardV2`).
    *
    * Supports the fixed period presets plus `custom` (which requires an
    * hour-aligned `range`), `pnl`/`vol` sort with an explicit direction, offset
-   * pagination, a `total` count for "#X of N" UI, and `me` — the caller's own
-   * row+rank even when outside the requested page.
-   *
-   * Optional args are omitted from the wire `input` when undefined so the
-   * server defaults apply (`sort = pnl`, `sortDir = desc`, `limit = 50`,
-   * `offset = 0`).
+   * pagination, and a `total` count for "#X of N" UI. Optional args are omitted
+   * from the wire `input` when undefined so the server defaults apply
+   * (`sort = pnl`, `sortDir = desc`, `limit = 50`, `offset = 0`).
    *
-   * `me` is `null` for anonymous callers (the backend populates it only from an
-   * authenticated session).
+   * bid-260606-leaderboard-split-my-rank: the board is **public and identical for
+   * every caller** — it carries no per-user data. For the signed-in caller's own
+   * row+rank, use {@link LeaderboardModule.myRank}.
    */
   async rankBoard(args) {
     const input = { period: args.period };
@@ -698,13 +708,34 @@ var LeaderboardModule = class {
     if (args.limit != null || args.offset != null) {
       input.p = { limit: args.limit, offset: args.offset };
     }
-    const body = await this.#graphql.request(
+    const body = await this.#graphql.publicRequest(
       RANK_LEADERBOARD_V2_QUERY,
       { input },
       args.signal ? { signal: args.signal } : void 0
     );
     return normaliseRankBoard(body.rank_leaderboardV2);
   }
+  /**
+   * Fetch the signed-in caller's own row + rank for the same window (`rank_me`) —
+   * the per-user companion to {@link LeaderboardModule.rankBoard}.
+   *
+   * Unlike the board, this attaches the user JWT (`request`, not `publicRequest`)
+   * so the backend resolves the caller. Returns `null` when no user is signed in
+   * (the backend returns `rank_me: null`). `MyRank.entry` is `null` when the
+   * caller has no activity in the window.
+   */
+  async myRank(args) {
+    const input = { period: args.period };
+    if (args.range) input.range = { from: args.range.from, to: args.range.to };
+    if (args.sort) input.sort = args.sort;
+    if (args.sortDir) input.sortDir = args.sortDir;
+    const body = await this.#graphql.request(
+      RANK_ME_QUERY,
+      { input },
+      args.signal ? { signal: args.signal } : void 0
+    );
+    return body.rank_me ? normaliseRankMe(body.rank_me) : null;
+  }
 };
 
 // src/modules/locale/normalise.ts

package/dist/index.d.mts

@@ -312,8 +312,16 @@ interface RankBoard {
     /** All active users in the window → "#X of N". */
     total: number;
     entries: RankEntry[];
-    /** Caller's own row+rank even if outside the page; `null` when anon. */
-    me: RankEntry | null;
+}
+/**
+ * The signed-in caller's own row + rank (`rank_me`), split out of {@link RankBoard} so the
+ * board stays a pure public/cacheable read. `entry` is `null` when the caller has no activity
+ * in the window (`rank` is then 0); `total` is the ranked-pool size for "#rank of total".
+ */
+interface MyRank {
+    rank: number;
+    entry: RankEntry | null;
+    total: number;
 }
 
 interface LeaderboardModuleDeps {
@@ -333,19 +341,17 @@ declare class LeaderboardModule {
         signal?: AbortSignal;
     }): Promise<LeaderboardEntry[]>;
     /**
-     * Fetch the duration-scoped rank board (`rank_leaderboardV2`).
+     * Fetch the public duration-scoped rank board (`rank_leaderboardV2`).
      *
      * Supports the fixed period presets plus `custom` (which requires an
      * hour-aligned `range`), `pnl`/`vol` sort with an explicit direction, offset
-     * pagination, a `total` count for "#X of N" UI, and `me` — the caller's own
-     * row+rank even when outside the requested page.
+     * pagination, and a `total` count for "#X of N" UI. Optional args are omitted
+     * from the wire `input` when undefined so the server defaults apply
+     * (`sort = pnl`, `sortDir = desc`, `limit = 50`, `offset = 0`).
      *
-     * Optional args are omitted from the wire `input` when undefined so the
-     * server defaults apply (`sort = pnl`, `sortDir = desc`, `limit = 50`,
-     * `offset = 0`).
-     *
-     * `me` is `null` for anonymous callers (the backend populates it only from an
-     * authenticated session).
+     * bid-260606-leaderboard-split-my-rank: the board is **public and identical for
+     * every caller** — it carries no per-user data. For the signed-in caller's own
+     * row+rank, use {@link LeaderboardModule.myRank}.
      */
     rankBoard(args: {
         period: RankPeriod;
@@ -360,6 +366,26 @@ declare class LeaderboardModule {
         offset?: number;
         signal?: AbortSignal;
     }): Promise<RankBoard>;
+    /**
+     * Fetch the signed-in caller's own row + rank for the same window (`rank_me`) —
+     * the per-user companion to {@link LeaderboardModule.rankBoard}.
+     *
+     * Unlike the board, this attaches the user JWT (`request`, not `publicRequest`)
+     * so the backend resolves the caller. Returns `null` when no user is signed in
+     * (the backend returns `rank_me: null`). `MyRank.entry` is `null` when the
+     * caller has no activity in the window.
+     */
+    myRank(args: {
+        period: RankPeriod;
+        /** ISO 8601 UTC, hour-aligned. Required iff `period === 'custom'`. */
+        range?: {
+            from: string;
+            to: string;
+        };
+        sort?: RankSort;
+        sortDir?: SortDir;
+        signal?: AbortSignal;
+    }): Promise<MyRank | null>;
 }
 
 /**
@@ -1098,4 +1124,4 @@ declare function adaptiveSimpson(f: (x: number) => number, a: number, b: number,
 declare function calculateProbWin(time1: number, time2: number, _price1: number, price2: number, creationTime: number, currentPrice: number, volatility: number): number;
 declare function calculateProbWin_v2(time1: number, time2: number, _price1: number, price2: number, creationTime: number, currentPrice: number, volatility: number): number;
 
-export { type AgencyPairFilter, AgencyPairModule, type AgencyPairStats, type AgencyPairStatus, AuthModule, type BackendHealth, type Bid, BidModule, type BidStatus, type CancelBidResult, type Candle, type Constraints, type Currency, GameChannel, type GameConfig, type GridConfig, type LeaderboardEntry, LeaderboardModule, type LeaderboardPeriod, type LeaderboardSortBy, LocaleModule, type LocaleRefreshResult, type LocaleResponse, type LocaleTranslations, type LoginResult, type Me, type MqttAcceptedBid, type MqttAgencyPairStatsEvent, type MqttBalanceEvent, type MqttBidAcceptedEvent, type MqttBidLostEvent, type MqttBidWonEvent, type MqttCandleEvent, type MqttConfigEvent, type MqttIdealConfigEvent, type MqttWalletBalanceEvent, type NetworkLevel, type NetworkQuality, NetworkQualityMonitor, type Pair, type PairInfo, PairModule, type PlaceBidInput, type RankBoard, type RankEntry, type RankPeriod, type RankSort, RealtimeModule, type Sample, type SampleReason, type SignalSource, type SortDir, TaphubAuthError, TaphubClient, type TaphubClientConfig, TaphubError, TaphubEventBus, type TaphubEventMap, TaphubNetworkError, TaphubServerError, TaphubSlippageError, TaphubStorage, type TaphubStorageAdapter, TaphubValidationError, type User, UserModule, type UserPnL, type UserPnLPeriod, type Wallet as UserWallet, type Wallet$1 as Wallet, type WalletBalanceReason, WalletChannel, adaptiveSimpson, autoDetectStorage, calculateProbWin, calculateProbWin_v2, errorFunction, isCancelled, isLoss, isPending, isTerminal, isWin, normalCDF, normalPDF };
+export { type AgencyPairFilter, AgencyPairModule, type AgencyPairStats, type AgencyPairStatus, AuthModule, type BackendHealth, type Bid, BidModule, type BidStatus, type CancelBidResult, type Candle, type Constraints, type Currency, GameChannel, type GameConfig, type GridConfig, type LeaderboardEntry, LeaderboardModule, type LeaderboardPeriod, type LeaderboardSortBy, LocaleModule, type LocaleRefreshResult, type LocaleResponse, type LocaleTranslations, type LoginResult, type Me, type MqttAcceptedBid, type MqttAgencyPairStatsEvent, type MqttBalanceEvent, type MqttBidAcceptedEvent, type MqttBidLostEvent, type MqttBidWonEvent, type MqttCandleEvent, type MqttConfigEvent, type MqttIdealConfigEvent, type MqttWalletBalanceEvent, type MyRank, type NetworkLevel, type NetworkQuality, NetworkQualityMonitor, type Pair, type PairInfo, PairModule, type PlaceBidInput, type RankBoard, type RankEntry, type RankPeriod, type RankSort, RealtimeModule, type Sample, type SampleReason, type SignalSource, type SortDir, TaphubAuthError, TaphubClient, type TaphubClientConfig, TaphubError, TaphubEventBus, type TaphubEventMap, TaphubNetworkError, TaphubServerError, TaphubSlippageError, TaphubStorage, type TaphubStorageAdapter, TaphubValidationError, type User, UserModule, type UserPnL, type UserPnLPeriod, type Wallet as UserWallet, type Wallet$1 as Wallet, type WalletBalanceReason, WalletChannel, adaptiveSimpson, autoDetectStorage, calculateProbWin, calculateProbWin_v2, errorFunction, isCancelled, isLoss, isPending, isTerminal, isWin, normalCDF, normalPDF };

package/dist/index.d.ts

@@ -312,8 +312,16 @@ interface RankBoard {
     /** All active users in the window → "#X of N". */
     total: number;
     entries: RankEntry[];
-    /** Caller's own row+rank even if outside the page; `null` when anon. */
-    me: RankEntry | null;
+}
+/**
+ * The signed-in caller's own row + rank (`rank_me`), split out of {@link RankBoard} so the
+ * board stays a pure public/cacheable read. `entry` is `null` when the caller has no activity
+ * in the window (`rank` is then 0); `total` is the ranked-pool size for "#rank of total".
+ */
+interface MyRank {
+    rank: number;
+    entry: RankEntry | null;
+    total: number;
 }
 
 interface LeaderboardModuleDeps {
@@ -333,19 +341,17 @@ declare class LeaderboardModule {
         signal?: AbortSignal;
     }): Promise<LeaderboardEntry[]>;
     /**
-     * Fetch the duration-scoped rank board (`rank_leaderboardV2`).
+     * Fetch the public duration-scoped rank board (`rank_leaderboardV2`).
      *
      * Supports the fixed period presets plus `custom` (which requires an
      * hour-aligned `range`), `pnl`/`vol` sort with an explicit direction, offset
-     * pagination, a `total` count for "#X of N" UI, and `me` — the caller's own
-     * row+rank even when outside the requested page.
+     * pagination, and a `total` count for "#X of N" UI. Optional args are omitted
+     * from the wire `input` when undefined so the server defaults apply
+     * (`sort = pnl`, `sortDir = desc`, `limit = 50`, `offset = 0`).
      *
-     * Optional args are omitted from the wire `input` when undefined so the
-     * server defaults apply (`sort = pnl`, `sortDir = desc`, `limit = 50`,
-     * `offset = 0`).
-     *
-     * `me` is `null` for anonymous callers (the backend populates it only from an
-     * authenticated session).
+     * bid-260606-leaderboard-split-my-rank: the board is **public and identical for
+     * every caller** — it carries no per-user data. For the signed-in caller's own
+     * row+rank, use {@link LeaderboardModule.myRank}.
      */
     rankBoard(args: {
         period: RankPeriod;
@@ -360,6 +366,26 @@ declare class LeaderboardModule {
         offset?: number;
         signal?: AbortSignal;
     }): Promise<RankBoard>;
+    /**
+     * Fetch the signed-in caller's own row + rank for the same window (`rank_me`) —
+     * the per-user companion to {@link LeaderboardModule.rankBoard}.
+     *
+     * Unlike the board, this attaches the user JWT (`request`, not `publicRequest`)
+     * so the backend resolves the caller. Returns `null` when no user is signed in
+     * (the backend returns `rank_me: null`). `MyRank.entry` is `null` when the
+     * caller has no activity in the window.
+     */
+    myRank(args: {
+        period: RankPeriod;
+        /** ISO 8601 UTC, hour-aligned. Required iff `period === 'custom'`. */
+        range?: {
+            from: string;
+            to: string;
+        };
+        sort?: RankSort;
+        sortDir?: SortDir;
+        signal?: AbortSignal;
+    }): Promise<MyRank | null>;
 }
 
 /**
@@ -1098,4 +1124,4 @@ declare function adaptiveSimpson(f: (x: number) => number, a: number, b: number,
 declare function calculateProbWin(time1: number, time2: number, _price1: number, price2: number, creationTime: number, currentPrice: number, volatility: number): number;
 declare function calculateProbWin_v2(time1: number, time2: number, _price1: number, price2: number, creationTime: number, currentPrice: number, volatility: number): number;
 
-export { type AgencyPairFilter, AgencyPairModule, type AgencyPairStats, type AgencyPairStatus, AuthModule, type BackendHealth, type Bid, BidModule, type BidStatus, type CancelBidResult, type Candle, type Constraints, type Currency, GameChannel, type GameConfig, type GridConfig, type LeaderboardEntry, LeaderboardModule, type LeaderboardPeriod, type LeaderboardSortBy, LocaleModule, type LocaleRefreshResult, type LocaleResponse, type LocaleTranslations, type LoginResult, type Me, type MqttAcceptedBid, type MqttAgencyPairStatsEvent, type MqttBalanceEvent, type MqttBidAcceptedEvent, type MqttBidLostEvent, type MqttBidWonEvent, type MqttCandleEvent, type MqttConfigEvent, type MqttIdealConfigEvent, type MqttWalletBalanceEvent, type NetworkLevel, type NetworkQuality, NetworkQualityMonitor, type Pair, type PairInfo, PairModule, type PlaceBidInput, type RankBoard, type RankEntry, type RankPeriod, type RankSort, RealtimeModule, type Sample, type SampleReason, type SignalSource, type SortDir, TaphubAuthError, TaphubClient, type TaphubClientConfig, TaphubError, TaphubEventBus, type TaphubEventMap, TaphubNetworkError, TaphubServerError, TaphubSlippageError, TaphubStorage, type TaphubStorageAdapter, TaphubValidationError, type User, UserModule, type UserPnL, type UserPnLPeriod, type Wallet as UserWallet, type Wallet$1 as Wallet, type WalletBalanceReason, WalletChannel, adaptiveSimpson, autoDetectStorage, calculateProbWin, calculateProbWin_v2, errorFunction, isCancelled, isLoss, isPending, isTerminal, isWin, normalCDF, normalPDF };
+export { type AgencyPairFilter, AgencyPairModule, type AgencyPairStats, type AgencyPairStatus, AuthModule, type BackendHealth, type Bid, BidModule, type BidStatus, type CancelBidResult, type Candle, type Constraints, type Currency, GameChannel, type GameConfig, type GridConfig, type LeaderboardEntry, LeaderboardModule, type LeaderboardPeriod, type LeaderboardSortBy, LocaleModule, type LocaleRefreshResult, type LocaleResponse, type LocaleTranslations, type LoginResult, type Me, type MqttAcceptedBid, type MqttAgencyPairStatsEvent, type MqttBalanceEvent, type MqttBidAcceptedEvent, type MqttBidLostEvent, type MqttBidWonEvent, type MqttCandleEvent, type MqttConfigEvent, type MqttIdealConfigEvent, type MqttWalletBalanceEvent, type MyRank, type NetworkLevel, type NetworkQuality, NetworkQualityMonitor, type Pair, type PairInfo, PairModule, type PlaceBidInput, type RankBoard, type RankEntry, type RankPeriod, type RankSort, RealtimeModule, type Sample, type SampleReason, type SignalSource, type SortDir, TaphubAuthError, TaphubClient, type TaphubClientConfig, TaphubError, TaphubEventBus, type TaphubEventMap, TaphubNetworkError, TaphubServerError, TaphubSlippageError, TaphubStorage, type TaphubStorageAdapter, TaphubValidationError, type User, UserModule, type UserPnL, type UserPnLPeriod, type Wallet as UserWallet, type Wallet$1 as Wallet, type WalletBalanceReason, WalletChannel, adaptiveSimpson, autoDetectStorage, calculateProbWin, calculateProbWin_v2, errorFunction, isCancelled, isLoss, isPending, isTerminal, isWin, normalCDF, normalPDF };

package/dist/index.js

@@ -568,8 +568,14 @@ function normaliseRankBoard(wire) {
     sort: wire.sort,
     sortDir: wire.sortDir,
     total: wire.total,
-    entries: Array.isArray(wire.entries) ? wire.entries.map(normaliseRankEntry) : [],
-    me: wire.me ? normaliseRankEntry(wire.me) : null
+    entries: Array.isArray(wire.entries) ? wire.entries.map(normaliseRankEntry) : []
+  };
+}
+function normaliseRankMe(wire) {
+  return {
+    rank: wire.rank,
+    total: wire.total,
+    entry: wire.entry ? normaliseRankEntry(wire.entry) : null
   };
 }
 
@@ -587,7 +593,13 @@ var RANK_LEADERBOARD_V2_QUERY = `query RankLeaderboardV2($input: RankBoardInput!
     sortDir
     total
     entries { userId loginBy username rank pnl vol payout wins bids }
-    me { userId loginBy username rank pnl vol payout wins bids }
+  }
+}`;
+var RANK_ME_QUERY = `query RankMe($input: RankMeInput!) {
+  rank_me(input: $input) {
+    rank
+    total
+    entry { userId loginBy username rank pnl vol payout wins bids }
   }
 }`;
 
@@ -611,19 +623,17 @@ var LeaderboardModule = class {
     return normaliseLeaderboard(body.leaderboard);
   }
   /**
-   * Fetch the duration-scoped rank board (`rank_leaderboardV2`).
+   * Fetch the public duration-scoped rank board (`rank_leaderboardV2`).
    *
    * Supports the fixed period presets plus `custom` (which requires an
    * hour-aligned `range`), `pnl`/`vol` sort with an explicit direction, offset
-   * pagination, a `total` count for "#X of N" UI, and `me` — the caller's own
-   * row+rank even when outside the requested page.
-   *
-   * Optional args are omitted from the wire `input` when undefined so the
-   * server defaults apply (`sort = pnl`, `sortDir = desc`, `limit = 50`,
-   * `offset = 0`).
+   * pagination, and a `total` count for "#X of N" UI. Optional args are omitted
+   * from the wire `input` when undefined so the server defaults apply
+   * (`sort = pnl`, `sortDir = desc`, `limit = 50`, `offset = 0`).
    *
-   * `me` is `null` for anonymous callers (the backend populates it only from an
-   * authenticated session).
+   * bid-260606-leaderboard-split-my-rank: the board is **public and identical for
+   * every caller** — it carries no per-user data. For the signed-in caller's own
+   * row+rank, use {@link LeaderboardModule.myRank}.
    */
   async rankBoard(args) {
     const input = { period: args.period };
@@ -633,13 +643,34 @@ var LeaderboardModule = class {
     if (args.limit != null || args.offset != null) {
       input.p = { limit: args.limit, offset: args.offset };
     }
-    const body = await this.#graphql.request(
+    const body = await this.#graphql.publicRequest(
       RANK_LEADERBOARD_V2_QUERY,
       { input },
       args.signal ? { signal: args.signal } : void 0
     );
     return normaliseRankBoard(body.rank_leaderboardV2);
   }
+  /**
+   * Fetch the signed-in caller's own row + rank for the same window (`rank_me`) —
+   * the per-user companion to {@link LeaderboardModule.rankBoard}.
+   *
+   * Unlike the board, this attaches the user JWT (`request`, not `publicRequest`)
+   * so the backend resolves the caller. Returns `null` when no user is signed in
+   * (the backend returns `rank_me: null`). `MyRank.entry` is `null` when the
+   * caller has no activity in the window.
+   */
+  async myRank(args) {
+    const input = { period: args.period };
+    if (args.range) input.range = { from: args.range.from, to: args.range.to };
+    if (args.sort) input.sort = args.sort;
+    if (args.sortDir) input.sortDir = args.sortDir;
+    const body = await this.#graphql.request(
+      RANK_ME_QUERY,
+      { input },
+      args.signal ? { signal: args.signal } : void 0
+    );
+    return body.rank_me ? normaliseRankMe(body.rank_me) : null;
+  }
 };
 
 // src/modules/locale/normalise.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taphubhq/sdk-core",
-  "version": "0.20.1",
+  "version": "0.21.0",
   "description": "Core SDK for building on the TabHub platform",
   "license": "MIT",
   "main": "./dist/index.cjs",