scorezilla 0.3.1 → 0.5.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { S as ScorezillaConfig, A as ApiSuccess, a as SubmitScoreResponse, L as LeaderboardResponse, P as PlayerRankResponse, W as WindowAroundResponse } from './errors-CWTmormh.js';
-export { b as ApiError, c as ApiResponse, B as BaseConfig, O as OutOfBoundsReason, d as PublicKeyConfig, R as RankedEntry, e as ScorezillaError, f as ScorezillaErrorCode, g as SecretKeyConfig } from './errors-CWTmormh.js';
+import { a as ScorezillaConfig, b as ApiSuccess, c as SubmitScoreResponse, L as LeaderboardResponse, d as PlayerRankResponse, W as WindowAroundResponse } from './types-C6VO4OWP.js';
+export { A as ApiError, e as ApiResponse, f as BaseConfig, O as OutOfBoundsReason, P as PublicKeyConfig, R as RankedEntry, S as ScorezillaErrorCode, g as SecretKeyConfig } from './types-C6VO4OWP.js';
+export { S as ScorezillaError } from './errors-maldlTY-.js';
 
 /**
  * `Scorezilla` — the public-key client for v0.1.0.
@@ -54,6 +55,15 @@ interface SubmitScoreInput extends CancellableInput {
      *  locally before send: no functions, no symbols, no circular refs;
      *  ≤ 4 KB UTF-8 bytes when JSON-stringified. */
     metadata?: Record<string, unknown> | undefined;
+    /** Optional public display name shown on the leaderboard. The API binds it to
+     *  this `playerId` and rejects (`name_taken`) a name held by a different
+     *  player on the board. 1-32 printable ASCII after trimming. */
+    name?: string | undefined;
+    /** Optional Cloudflare Turnstile token. Required only when the board has
+     *  Turnstile gating on AND this is a cross-origin submit. Obtained by the host
+     *  (e.g. via a hidden broker iframe on a trusted origin); the SDK just
+     *  forwards it. */
+    turnstileToken?: string | undefined;
 }
 /** Input for {@link Scorezilla.getLeaderboard}. */
 interface GetLeaderboardInput extends CancellableInput {
@@ -146,22 +156,19 @@ declare class Scorezilla {
     /**
      * Fetch a single player's rank on a board.
      *
-     * Maps to `GET /v1/boards/:boardId/players/:playerId/rank`. Returns 404
-     * (`not_found`) if the player has no entry yet.
+     * Maps to `GET /v1/boards/:boardId/players/:playerId/rank`. "No entry yet"
+     * is a normal result, NOT an error: the response is `{ ranked: false }`
+     * (narrow on `ranked` before reading `rank`). A `not_found` is thrown only
+     * when the board itself doesn't exist.
      *
      * @example
      * ```ts
-     * try {
-     *   const { rank, score } = await sz.getPlayerRank({ boardId, playerId: 'alice' });
-     *   console.log(`Alice is rank ${rank} with score ${score}`);
-     * } catch (e) {
-     *   if (e instanceof ScorezillaError && e.isNotFound()) {
-     *     console.log('Alice has no submission on this board yet.');
-     *   } else throw e;
-     * }
+     * const r = await sz.getPlayerRank({ boardId, playerId: 'alice' });
+     * if (r.ranked) console.log(`Alice is rank ${r.rank} with score ${r.score}`);
+     * else console.log('Alice has no submission on this board yet.');
      * ```
      *
-     * @throws {ScorezillaError} `not_found` (player has no submission),
+     * @throws {ScorezillaError} `not_found` (board does not exist),
      *   `network_error`, `timeout`.
      * @since 0.1.0
      * @stability stable

package/dist/index.js

@@ -654,7 +654,7 @@ function validateMetadata(metadata) {
 }
 var Scorezilla = class _Scorezilla {
   /** The package version, injected at build time from `package.json`. */
-  static version = "0.3.1";
+  static version = "0.5.0";
   #config;
   #userAgent;
   #authHeader;
@@ -709,6 +709,12 @@ var Scorezilla = class _Scorezilla {
     if (input.metadata !== void 0) {
       body.metadata = input.metadata;
     }
+    if (input.name !== void 0) {
+      body.name = input.name;
+    }
+    if (input.turnstileToken !== void 0) {
+      body.turnstileToken = input.turnstileToken;
+    }
     return this.#request({
       path: submitScorePath(input.boardId),
       method: "POST",
@@ -744,22 +750,19 @@ var Scorezilla = class _Scorezilla {
   /**
    * Fetch a single player's rank on a board.
    *
-   * Maps to `GET /v1/boards/:boardId/players/:playerId/rank`. Returns 404
-   * (`not_found`) if the player has no entry yet.
+   * Maps to `GET /v1/boards/:boardId/players/:playerId/rank`. "No entry yet"
+   * is a normal result, NOT an error: the response is `{ ranked: false }`
+   * (narrow on `ranked` before reading `rank`). A `not_found` is thrown only
+   * when the board itself doesn't exist.
    *
    * @example
    * ```ts
-   * try {
-   *   const { rank, score } = await sz.getPlayerRank({ boardId, playerId: 'alice' });
-   *   console.log(`Alice is rank ${rank} with score ${score}`);
-   * } catch (e) {
-   *   if (e instanceof ScorezillaError && e.isNotFound()) {
-   *     console.log('Alice has no submission on this board yet.');
-   *   } else throw e;
-   * }
+   * const r = await sz.getPlayerRank({ boardId, playerId: 'alice' });
+   * if (r.ranked) console.log(`Alice is rank ${r.rank} with score ${r.score}`);
+   * else console.log('Alice has no submission on this board yet.');
    * ```
    *
-   * @throws {ScorezillaError} `not_found` (player has no submission),
+   * @throws {ScorezillaError} `not_found` (board does not exist),
    *   `network_error`, `timeout`.
    * @since 0.1.0
    * @stability stable
@@ -839,7 +842,7 @@ function createClient(config) {
 }
 
 // src/index.ts
-var SDK_VERSION = "0.3.1";
+var SDK_VERSION = "0.5.0";
 
 export { SDK_VERSION, Scorezilla, ScorezillaError, createClient, detectRuntime };
 //# sourceMappingURL=index.js.map