keeperboard 2.0.2 → 2.1.0

package/dist/index.d.mts

@@ -93,6 +93,7 @@ interface HealthResult {
     version: string;
     timestamp: string;
 }
+type ErrorCode = 'PROFANITY_DETECTED' | 'RATE_LIMITED' | 'INVALID_REQUEST' | 'NOT_FOUND' | 'INTERNAL_ERROR';
 interface SessionConfig {
     /** API key from the KeeperBoard dashboard */
     apiKey: string;
@@ -120,6 +121,14 @@ type SessionScoreResult = {
 } | {
     success: false;
     error: string;
+    errorCode?: ErrorCode;
+};
+type UpdateNameResult = {
+    success: true;
+} | {
+    success: false;
+    error: string;
+    errorCode?: ErrorCode;
 };
 interface SnapshotEntry {
     rank: number;
@@ -139,8 +148,6 @@ interface NameValidationOptions {
     minLength?: number;
     /** Maximum length — input is truncated to this (default 12). */
     maxLength?: number;
-    /** Convert to uppercase (default true). */
-    uppercase?: boolean;
     /** Regex of allowed characters applied after case conversion (default /[^A-Z0-9_]/g removes non-matching). */
     allowedPattern?: RegExp;
 }
@@ -336,9 +343,9 @@ declare class KeeperBoardSession {
     }): Promise<SnapshotResult>;
     /**
      * Update the player's name on the server and locally.
-     * Returns true on success, false on failure.
+     * Returns `{ success: true }` on success, or `{ success: false, error, errorCode }` on failure.
      */
-    updatePlayerName(newName: string): Promise<boolean>;
+    updatePlayerName(newName: string): Promise<UpdateNameResult>;
     /**
      * Retry submitting a pending score (from a previous failed submission).
      * Call this on app startup.
@@ -424,14 +431,13 @@ declare class PlayerIdentity {
  * Validate and sanitize a player name.
  *
  * 1. Trims whitespace
- * 2. Optionally converts to uppercase (default: yes)
- * 3. Strips characters not matching `allowedPattern`
- * 4. Truncates to `maxLength`
- * 5. Returns `null` if result is shorter than `minLength`
+ * 2. Strips characters not matching `allowedPattern`
+ * 3. Truncates to `maxLength`
+ * 4. Returns `null` if result is shorter than `minLength`
  *
  * @example
- * validateName('  Ace Pilot! ')  // 'ACE_PILOT' → wait, no spaces allowed → 'ACEPILOT'
- * validateName('ab')             // 'AB'
+ * validateName('  Ace Pilot! ')  // 'AcePilot'
+ * validateName('ab')             // 'ab'
  * validateName('x')              // null (too short)
  */
 declare function validateName(input: string, options?: NameValidationOptions): string | null;
@@ -513,4 +519,4 @@ declare class RetryQueue {
     clear(): void;
 }
 
-export { Cache, type ClaimResponse, type ClaimResult, type ClaimScoreOptions, type GetLeaderboardOptions, type GetPlayerRankOptions, type HealthResponse, type HealthResult, KeeperBoardClient, type KeeperBoardConfig, KeeperBoardError, KeeperBoardSession, type LeaderboardEntry, type LeaderboardResponse, type LeaderboardResult, type NameValidationOptions, PlayerIdentity, type PlayerIdentityConfig, type PlayerResponse, type PlayerResult, type ResetSchedule, RetryQueue, type ScoreResponse, type ScoreResult, type ScoreSubmission, type SessionConfig, type SessionScoreResult, type SnapshotEntry, type SnapshotResult, type SubmitScoreOptions, type UpdatePlayerNameOptions, generatePlayerName, validateName };
+export { Cache, type ClaimResponse, type ClaimResult, type ClaimScoreOptions, type ErrorCode, type GetLeaderboardOptions, type GetPlayerRankOptions, type HealthResponse, type HealthResult, KeeperBoardClient, type KeeperBoardConfig, KeeperBoardError, KeeperBoardSession, type LeaderboardEntry, type LeaderboardResponse, type LeaderboardResult, type NameValidationOptions, PlayerIdentity, type PlayerIdentityConfig, type PlayerResponse, type PlayerResult, type ResetSchedule, RetryQueue, type ScoreResponse, type ScoreResult, type ScoreSubmission, type SessionConfig, type SessionScoreResult, type SnapshotEntry, type SnapshotResult, type SubmitScoreOptions, type UpdateNameResult, type UpdatePlayerNameOptions, generatePlayerName, validateName };

package/dist/index.d.ts

@@ -93,6 +93,7 @@ interface HealthResult {
     version: string;
     timestamp: string;
 }
+type ErrorCode = 'PROFANITY_DETECTED' | 'RATE_LIMITED' | 'INVALID_REQUEST' | 'NOT_FOUND' | 'INTERNAL_ERROR';
 interface SessionConfig {
     /** API key from the KeeperBoard dashboard */
     apiKey: string;
@@ -120,6 +121,14 @@ type SessionScoreResult = {
 } | {
     success: false;
     error: string;
+    errorCode?: ErrorCode;
+};
+type UpdateNameResult = {
+    success: true;
+} | {
+    success: false;
+    error: string;
+    errorCode?: ErrorCode;
 };
 interface SnapshotEntry {
     rank: number;
@@ -139,8 +148,6 @@ interface NameValidationOptions {
     minLength?: number;
     /** Maximum length — input is truncated to this (default 12). */
     maxLength?: number;
-    /** Convert to uppercase (default true). */
-    uppercase?: boolean;
     /** Regex of allowed characters applied after case conversion (default /[^A-Z0-9_]/g removes non-matching). */
     allowedPattern?: RegExp;
 }
@@ -336,9 +343,9 @@ declare class KeeperBoardSession {
     }): Promise<SnapshotResult>;
     /**
      * Update the player's name on the server and locally.
-     * Returns true on success, false on failure.
+     * Returns `{ success: true }` on success, or `{ success: false, error, errorCode }` on failure.
      */
-    updatePlayerName(newName: string): Promise<boolean>;
+    updatePlayerName(newName: string): Promise<UpdateNameResult>;
     /**
      * Retry submitting a pending score (from a previous failed submission).
      * Call this on app startup.
@@ -424,14 +431,13 @@ declare class PlayerIdentity {
  * Validate and sanitize a player name.
  *
  * 1. Trims whitespace
- * 2. Optionally converts to uppercase (default: yes)
- * 3. Strips characters not matching `allowedPattern`
- * 4. Truncates to `maxLength`
- * 5. Returns `null` if result is shorter than `minLength`
+ * 2. Strips characters not matching `allowedPattern`
+ * 3. Truncates to `maxLength`
+ * 4. Returns `null` if result is shorter than `minLength`
  *
  * @example
- * validateName('  Ace Pilot! ')  // 'ACE_PILOT' → wait, no spaces allowed → 'ACEPILOT'
- * validateName('ab')             // 'AB'
+ * validateName('  Ace Pilot! ')  // 'AcePilot'
+ * validateName('ab')             // 'ab'
  * validateName('x')              // null (too short)
  */
 declare function validateName(input: string, options?: NameValidationOptions): string | null;
@@ -513,4 +519,4 @@ declare class RetryQueue {
     clear(): void;
 }
 
-export { Cache, type ClaimResponse, type ClaimResult, type ClaimScoreOptions, type GetLeaderboardOptions, type GetPlayerRankOptions, type HealthResponse, type HealthResult, KeeperBoardClient, type KeeperBoardConfig, KeeperBoardError, KeeperBoardSession, type LeaderboardEntry, type LeaderboardResponse, type LeaderboardResult, type NameValidationOptions, PlayerIdentity, type PlayerIdentityConfig, type PlayerResponse, type PlayerResult, type ResetSchedule, RetryQueue, type ScoreResponse, type ScoreResult, type ScoreSubmission, type SessionConfig, type SessionScoreResult, type SnapshotEntry, type SnapshotResult, type SubmitScoreOptions, type UpdatePlayerNameOptions, generatePlayerName, validateName };
+export { Cache, type ClaimResponse, type ClaimResult, type ClaimScoreOptions, type ErrorCode, type GetLeaderboardOptions, type GetPlayerRankOptions, type HealthResponse, type HealthResult, KeeperBoardClient, type KeeperBoardConfig, KeeperBoardError, KeeperBoardSession, type LeaderboardEntry, type LeaderboardResponse, type LeaderboardResult, type NameValidationOptions, PlayerIdentity, type PlayerIdentityConfig, type PlayerResponse, type PlayerResult, type ResetSchedule, RetryQueue, type ScoreResponse, type ScoreResult, type ScoreSubmission, type SessionConfig, type SessionScoreResult, type SnapshotEntry, type SnapshotResult, type SubmitScoreOptions, type UpdateNameResult, type UpdatePlayerNameOptions, generatePlayerName, validateName };

package/dist/index.js

@@ -720,16 +720,12 @@ var RetryQueue = class {
 var DEFAULTS = {
   minLength: 2,
   maxLength: 12,
-  uppercase: true,
-  allowedPattern: /[^A-Z0-9_]/g
+  allowedPattern: /[^A-Za-z0-9_]/g
 };
 function validateName(input, options) {
   const opts = { ...DEFAULTS, ...options };
   let name = input.trim();
-  if (opts.uppercase) {
-    name = name.toUpperCase();
-  }
-  const pattern = options?.allowedPattern ?? (opts.uppercase ? /[^A-Z0-9_]/g : /[^A-Za-z0-9_]/g);
+  const pattern = options?.allowedPattern ?? /[^A-Za-z0-9_]/g;
   name = name.replace(pattern, "");
   name = name.substring(0, opts.maxLength);
   if (name.length < opts.minLength) {
@@ -814,10 +810,14 @@ var KeeperBoardSession = class {
         isNewHighScore: result.isNewHighScore
       };
     } catch (error) {
-      this.retryQueue?.save(score, metadata);
+      const errorCode = error instanceof KeeperBoardError ? error.code : void 0;
+      if (errorCode !== "PROFANITY_DETECTED") {
+        this.retryQueue?.save(score, metadata);
+      }
       return {
         success: false,
-        error: error instanceof Error ? error.message : "Unknown error"
+        error: error instanceof Error ? error.message : "Unknown error",
+        errorCode
       };
     } finally {
       this.isSubmitting = false;
@@ -844,7 +844,7 @@ var KeeperBoardSession = class {
   }
   /**
    * Update the player's name on the server and locally.
-   * Returns true on success, false on failure.
+   * Returns `{ success: true }` on success, or `{ success: false, error, errorCode }` on failure.
    */
   async updatePlayerName(newName) {
     try {
@@ -857,9 +857,14 @@ var KeeperBoardSession = class {
         this.cache.invalidate();
         this.cachedLimit = 0;
       }
-      return true;
-    } catch {
-      return false;
+      return { success: true };
+    } catch (error) {
+      const errorCode = error instanceof KeeperBoardError ? error.code : void 0;
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error",
+        errorCode
+      };
     }
   }
   /**

package/dist/index.mjs

@@ -687,16 +687,12 @@ var RetryQueue = class {
 var DEFAULTS = {
   minLength: 2,
   maxLength: 12,
-  uppercase: true,
-  allowedPattern: /[^A-Z0-9_]/g
+  allowedPattern: /[^A-Za-z0-9_]/g
 };
 function validateName(input, options) {
   const opts = { ...DEFAULTS, ...options };
   let name = input.trim();
-  if (opts.uppercase) {
-    name = name.toUpperCase();
-  }
-  const pattern = options?.allowedPattern ?? (opts.uppercase ? /[^A-Z0-9_]/g : /[^A-Za-z0-9_]/g);
+  const pattern = options?.allowedPattern ?? /[^A-Za-z0-9_]/g;
   name = name.replace(pattern, "");
   name = name.substring(0, opts.maxLength);
   if (name.length < opts.minLength) {
@@ -781,10 +777,14 @@ var KeeperBoardSession = class {
         isNewHighScore: result.isNewHighScore
       };
     } catch (error) {
-      this.retryQueue?.save(score, metadata);
+      const errorCode = error instanceof KeeperBoardError ? error.code : void 0;
+      if (errorCode !== "PROFANITY_DETECTED") {
+        this.retryQueue?.save(score, metadata);
+      }
       return {
         success: false,
-        error: error instanceof Error ? error.message : "Unknown error"
+        error: error instanceof Error ? error.message : "Unknown error",
+        errorCode
       };
     } finally {
       this.isSubmitting = false;
@@ -811,7 +811,7 @@ var KeeperBoardSession = class {
   }
   /**
    * Update the player's name on the server and locally.
-   * Returns true on success, false on failure.
+   * Returns `{ success: true }` on success, or `{ success: false, error, errorCode }` on failure.
    */
   async updatePlayerName(newName) {
     try {
@@ -824,9 +824,14 @@ var KeeperBoardSession = class {
         this.cache.invalidate();
         this.cachedLimit = 0;
       }
-      return true;
-    } catch {
-      return false;
+      return { success: true };
+    } catch (error) {
+      const errorCode = error instanceof KeeperBoardError ? error.code : void 0;
+      return {
+        success: false,
+        error: error instanceof Error ? error.message : "Unknown error",
+        errorCode
+      };
     }
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keeperboard",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "TypeScript client SDK for KeeperBoard leaderboard-as-a-service",
   "main": "dist/index.js",
   "module": "dist/index.mjs",