implement scoresaber score tracking (for previous scores)

projects/common/package.json

@@ -19,6 +19,7 @@
     "typescript": "^5"
   },
   "dependencies": {
+    "@typegoose/auto-increment": "^4.7.0",
     "@typegoose/typegoose": "^12.8.0",
     "ky": "^1.7.2",
     "ws": "^8.18.0"

projects/common/src/model/additional-score-data/additional-score-data.ts

@@ -4,7 +4,7 @@ import { HandAccuracy } from "./hand-accuracy";
 import { Misses } from "./misses";
 
 /**
- * The model for a BeatSaver map.
+ * The model for additional score data.
  */
 @modelOptions({
   options: { allowMixed: Severity.ALLOW },

projects/common/src/model/score/impl/scoresaber-score.ts

@@ -0,0 +1,123 @@
+import { getModelForClass, modelOptions, plugin, Prop, ReturnModelType, Severity } from "@typegoose/typegoose";
+import Score from "../score";
+import { Modifier } from "../../../score/modifier";
+import ScoreSaberScoreToken from "../../../types/token/scoresaber/score-saber-score-token";
+import ScoreSaberLeaderboardToken from "../../../types/token/scoresaber/score-saber-leaderboard-token";
+import ScoreSaberLeaderboard from "../../../leaderboard/impl/scoresaber-leaderboard";
+import { type ScoreSaberLeaderboardPlayerInfoToken } from "../../../types/token/scoresaber/score-saber-leaderboard-player-info-token";
+import { Document } from "mongoose";
+import { AutoIncrementID } from "@typegoose/auto-increment";
+
+@modelOptions({
+  options: { allowMixed: Severity.ALLOW },
+  schemaOptions: {
+    collection: "scoresaber-scores",
+    toObject: {
+      virtuals: true,
+      transform: function (_, ret) {
+        ret.id = ret._id;
+        delete ret._id;
+        delete ret.__v;
+        return ret;
+      },
+    },
+  },
+})
+@plugin(AutoIncrementID, {
+  field: "_id",
+  startAt: 1,
+  trackerModelName: "scores",
+  trackerCollection: "increments",
+  overwriteModelName: "scoresaber-scores",
+})
+export class ScoreSaberScoreInternal extends Score {
+  /**
+   * The score's id.
+   */
+  @Prop({ required: true, index: true })
+  public readonly scoreId!: string;
+
+  /**
+   * The leaderboard the score was set on.
+   */
+  @Prop({ required: true, index: true })
+  public readonly leaderboardId!: number;
+
+  /**
+   * The amount of pp for the score.
+   * @private
+   */
+  @Prop({ required: true })
+  public readonly pp!: number;
+
+  /**
+   * The weight of the score, or undefined if not ranked.
+   * @private
+   */
+  @Prop()
+  public readonly weight?: number;
+
+  /**
+   * The max combo of the score.
+   */
+  @Prop({ required: true })
+  public readonly maxCombo!: number;
+}
+
+class ScoreSaberScorePublic extends ScoreSaberScoreInternal {
+  /**
+   * The player who set the score.
+   */
+  public playerInfo!: ScoreSaberLeaderboardPlayerInfoToken;
+}
+
+export type ScoreSaberScore = InstanceType<typeof ScoreSaberScorePublic>;
+
+/**
+ * Gets a {@link ScoreSaberScore} from a {@link ScoreSaberScoreToken}.
+ *
+ * @param token the token to convert
+ * @param playerId the id of the player who set the score
+ * @param leaderboard the leaderboard the score was set on
+ */
+export function getScoreSaberScoreFromToken(
+  token: ScoreSaberScoreToken,
+  leaderboard: ScoreSaberLeaderboardToken | ScoreSaberLeaderboard,
+  playerId?: string
+): ScoreSaberScore {
+  const modifiers: Modifier[] =
+    token.modifiers == undefined || token.modifiers === ""
+      ? []
+      : token.modifiers.split(",").map(mod => {
+          mod = mod.toUpperCase();
+          const modifier = Modifier[mod as keyof typeof Modifier];
+          if (modifier === undefined) {
+            throw new Error(`Unknown modifier: ${mod}`);
+          }
+          return modifier;
+        });
+
+  return {
+    leaderboard: "scoresaber",
+    playerId: playerId || token.leaderboardPlayerInfo.id,
+    leaderboardId: leaderboard.id,
+    score: token.baseScore,
+    accuracy: (token.baseScore / leaderboard.maxScore) * 100,
+    rank: token.rank,
+    modifiers: modifiers,
+    misses: token.missedNotes + token.badCuts,
+    missedNotes: token.missedNotes,
+    badCuts: token.badCuts,
+    fullCombo: token.fullCombo,
+    timestamp: new Date(token.timeSet),
+    scoreId: token.id,
+    pp: token.pp,
+    weight: token.weight,
+    maxCombo: token.maxCombo,
+    playerInfo: token.leaderboardPlayerInfo,
+  };
+}
+
+export type ScoreSaberScoreDocument = ScoreSaberScore & Document;
+export const ScoreSaberScoreModel: ReturnModelType<typeof ScoreSaberScoreInternal> =
+  getModelForClass(ScoreSaberScoreInternal);

projects/common/src/model/score/score.ts

@@ -0,0 +1,96 @@
+import { Modifier } from "../../score/modifier";
+import { AdditionalScoreData } from "../additional-score-data/additional-score-data";
+import { type Leaderboards } from "../../leaderboard";
+import { prop } from "@typegoose/typegoose";
+
+/**
+ * The model for a score.
+ */
+export default class Score {
+  /**
+   * The internal score id.
+   */
+  @prop()
+  private _id?: number;
+
+  /**
+   * The leaderboard the score is from.
+   */
+  @prop({ required: true })
+  public readonly leaderboard!: Leaderboards;
+
+  /**
+   * The id of the player who set the score.
+   * @private
+   */
+  @prop({ required: true, index: true })
+  public readonly playerId!: string;
+
+  /**
+   * The base score for the score.
+   * @private
+   */
+  @prop({ required: true })
+  public readonly score!: number;
+
+  /**
+   * The accuracy of the score.
+   */
+  @prop({ required: true })
+  public readonly accuracy!: number;
+
+  /**
+   * The rank for the score.
+   * @private
+   */
+  @prop({ required: true })
+  public readonly rank!: number;
+
+  /**
+   * The modifiers used on the score.
+   * @private
+   */
+  @prop({ enum: () => Modifier, type: String, required: true })
+  public readonly modifiers!: Modifier[];
+
+  /**
+   * The total amount of misses.
+   * @private
+   */
+  @prop({ required: true })
+  public readonly misses!: number;
+
+  /**
+   * The amount of missed notes.
+   */
+  @prop({ required: true })
+  public readonly missedNotes!: number;
+
+  /**
+   * The amount of bad cuts.
+   * @private
+   */
+  @prop({ required: true })
+  public readonly badCuts!: number;
+
+  /**
+   * Whether every note was hit.
+   * @private
+   */
+  @prop({ required: true })
+  public readonly fullCombo!: boolean;
+
+  /**
+   * The additional data for the score.
+   */
+  public additionalData?: AdditionalScoreData;
+
+  /**
+   * The time the score was set.
+   * @private
+   */
+  @prop({ required: true })
+  public readonly timestamp!: Date;
+}
+
+export type ScoreType = InstanceType<typeof Score>;

projects/common/src/score/impl/scoresaber-score.ts

@@ -1,76 +0,0 @@
-import Score from "../score";
-import { Modifier } from "../modifier";
-import ScoreSaberScoreToken from "../../types/token/scoresaber/score-saber-score-token";
-import ScoreSaberLeaderboardPlayerInfoToken from "../../types/token/scoresaber/score-saber-leaderboard-player-info-token";
-import ScoreSaberLeaderboardToken from "../../types/token/scoresaber/score-saber-leaderboard-token";
-import ScoreSaberLeaderboard from "../../leaderboard/impl/scoresaber-leaderboard";
-
-export default interface ScoreSaberScore extends Score {
-  /**
-   * The score's id.
-   */
-  readonly id: string;
-
-  /**
-   * The amount of pp for the score.
-   * @private
-   */
-  readonly pp: number;
-
-  /**
-   * The weight of the score, or undefined if not ranked.s
-   * @private
-   */
-  readonly weight?: number;
-
-  /**
-   * The max combo of the score.
-   */
-  readonly maxCombo: number;
-
-  /**
-   * The player who set the score
-   */
-  readonly playerInfo: ScoreSaberLeaderboardPlayerInfoToken;
-}
-
-/**
- * Gets a {@link ScoreSaberScore} from a {@link ScoreSaberScoreToken}.
- *
- * @param token the token to convert
- * @param leaderboard the leaderboard the score was set on
- */
-export function getScoreSaberScoreFromToken(
-  token: ScoreSaberScoreToken,
-  leaderboard?: ScoreSaberLeaderboardToken | ScoreSaberLeaderboard
-): ScoreSaberScore {
-  const modifiers: Modifier[] =
-    token.modifiers == undefined || token.modifiers === ""
-      ? []
-      : token.modifiers.split(",").map(mod => {
-          mod = mod.toUpperCase();
-          const modifier = Modifier[mod as keyof typeof Modifier];
-          if (modifier === undefined) {
-            throw new Error(`Unknown modifier: ${mod}`);
-          }
-          return modifier;
-        });
-
-  return {
-    leaderboard: "scoresaber",
-    score: token.baseScore,
-    accuracy: leaderboard ? (token.baseScore / leaderboard.maxScore) * 100 : Infinity,
-    rank: token.rank,
-    modifiers: modifiers,
-    misses: token.missedNotes + token.badCuts,
-    missedNotes: token.missedNotes,
-    badCuts: token.badCuts,
-    fullCombo: token.fullCombo,
-    timestamp: new Date(token.timeSet),
-    id: token.id,
-    pp: token.pp,
-    weight: token.weight,
-    maxCombo: token.maxCombo,
-    playerInfo: token.leaderboardPlayerInfo,
-  };
-}

projects/common/src/score/score.ts

@@ -1,67 +0,0 @@
-import { Modifier } from "./modifier";
-import { Leaderboards } from "../leaderboard";
-import { AdditionalScoreData } from "../model/additional-score-data/additional-score-data";
-
-export default interface Score {
-  /**
-   * The leaderboard the score is from.
-   */
-  readonly leaderboard: Leaderboards;
-
-  /**
-   * The base score for the score.
-   * @private
-   */
-  readonly score: number;
-
-  /**
-   * The accuracy of the score.
-   */
-  readonly accuracy: number;
-
-  /**
-   * The rank for the score.
-   * @private
-   */
-  readonly rank: number;
-
-  /**
-   * The modifiers used on the score.
-   * @private
-   */
-  readonly modifiers: Modifier[];
-
-  /**
-   * The amount total amount of misses.
-   * @private
-   */
-  readonly misses: number;
-
-  /**
-   * The amount of missed notes.
-   */
-  readonly missedNotes: number;
-
-  /**
-   * The amount of bad cuts.
-   * @private
-   */
-  readonly badCuts: number;
-
-  /**
-   * Whether every note was hit.
-   * @private
-   */
-  readonly fullCombo: boolean;
-
-  /**
-   * The additional data for the score.
-   */
-  additionalData?: AdditionalScoreData;
-
-  /**
-   * The time the score was set.
-   * @private
-   */
-  readonly timestamp: Date;
-}

projects/common/src/types/token/scoresaber/score-saber-leaderboard-player-info-token.ts

@@ -1,8 +1,8 @@
-export default interface ScoreSaberLeaderboardPlayerInfoToken {
+export type ScoreSaberLeaderboardPlayerInfoToken = {
   id: string;
   name: string;
   profilePicture: string;
   country: string;
   permissions: number;
   role: string;
-}
+};

projects/common/src/types/token/scoresaber/score-saber-score-token.ts

@@ -1,5 +1,5 @@
 import ScoreSaberLeaderboardToken from "./score-saber-leaderboard-token";
-import ScoreSaberLeaderboardPlayerInfoToken from "./score-saber-leaderboard-player-info-token";
+import { ScoreSaberLeaderboardPlayerInfoToken } from "./score-saber-leaderboard-player-info-token";
 
 export default interface ScoreSaberScoreToken {
   id: string;

projects/common/src/utils/scoresaber.util.ts

@@ -1,6 +1,6 @@
 import ScoreSaberPlayerToken from "../types/token/scoresaber/score-saber-player-token";
-import ScoreSaberLeaderboardPlayerInfoToken from "../types/token/scoresaber/score-saber-leaderboard-player-info-token";
 import ScoreSaberPlayer from "../player/impl/scoresaber-player";
+import { ScoreSaberLeaderboardPlayerInfoToken } from "../types/token/scoresaber/score-saber-leaderboard-player-info-token";
 
 export type ScoreSaberRole = {
   /**