fix(api): name unknown fields in leaderboard errors

apps/api/src/dtos/guild-leaderboard.dto.ts

@@ -9,20 +9,20 @@
 import { ApiProperty } from "@nestjs/swagger";
 import { Guild, getLeaderboardFields } from "@statsify/schemas";
 import {
-  IsEnum,
   IsInt,
   IsOptional,
   IsString,
   MaxLength,
   Min,
   MinLength,
 } from "class-validator";
+import { IsLeaderboardField } from "./leaderboard-field.decorator.js";
 import { Transform } from "class-transformer";
 
 const fields = getLeaderboardFields(Guild).map(([key]) => key);
 
 export class GuildLeaderboardDto {
-  @IsEnum(fields)
+  @IsLeaderboardField(fields)
   @ApiProperty({ enum: fields })
   public field: string;
 

apps/api/src/dtos/guild-rankings.dto.ts

@@ -8,13 +8,15 @@
 
 import { ApiProperty } from "@nestjs/swagger";
 import { Guild, getLeaderboardFields } from "@statsify/schemas";
-import { IsEnum, IsString, MaxLength, MinLength } from "class-validator";
+import { IsArray, IsString, MaxLength, MinLength } from "class-validator";
+import { IsLeaderboardField } from "./leaderboard-field.decorator.js";
 
 const fields = getLeaderboardFields(Guild).map(([key]) => key);
 
 export class GuildRankingDto {
   @ApiProperty({ enum: fields, type: [String] })
-  @IsEnum(fields, { each: true })
+  @IsArray()
+  @IsLeaderboardField(fields, { each: true })
   public fields: string[];
 
   @IsString()

apps/api/src/dtos/leaderboard-field.decorator.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) Statsify
+ *
+ * This source code is licensed under the GNU GPL v3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ * https://github.com/Statsify/statsify/blob/main/LICENSE
+ */
+
+import { ValidateBy, type ValidationOptions } from "class-validator";
+
+export const IsLeaderboardField = (fields: string[], options?: ValidationOptions) => {
+  const fieldSet = new Set(fields);
+
+  return ValidateBy(
+    {
+      name: "isLeaderboardField",
+      validator: {
+        validate: (value) => fieldSet.has(value),
+        defaultMessage: (args) => {
+          const value = args?.value;
+          if (value === undefined) return `${args?.property} is required`;
+
+          const values = options?.each && Array.isArray(value) ? value : [value];
+          const invalid = new Set(
+            values.filter((field) => !fieldSet.has(field)).map((field) => JSON.stringify(field))
+          );
+
+          return `unknown leaderboard field${invalid.size === 1 ? "" : "s"}: ${[...invalid].join(", ")}`;
+        },
+      },
+    },
+    options
+  );
+};

apps/api/src/dtos/player-leaderboard.dto.ts

@@ -7,15 +7,16 @@
  */
 
 import { ApiProperty, PartialType } from "@nestjs/swagger";
-import { IsEnum, IsInt, IsOptional, Min } from "class-validator";
+import { IsInt, IsOptional, Min } from "class-validator";
+import { IsLeaderboardField } from "./leaderboard-field.decorator.js";
 import { Player, getLeaderboardFields } from "@statsify/schemas";
 import { PlayerDto } from "./player.dto.js";
 import { Transform } from "class-transformer";
 
 const fields = getLeaderboardFields(Player).map(([key]) => key);
 
 export class PlayerLeaderboardDto extends PartialType(PlayerDto) {
-  @IsEnum(fields)
+  @IsLeaderboardField(fields)
   @ApiProperty({ enum: fields })
   public field: string;
 

apps/api/src/dtos/player-rankings.dto.ts

@@ -7,14 +7,16 @@
  */
 
 import { ApiProperty } from "@nestjs/swagger";
-import { IsEnum } from "class-validator";
+import { IsArray } from "class-validator";
+import { IsLeaderboardField } from "./leaderboard-field.decorator.js";
 import { Player, getLeaderboardFields } from "@statsify/schemas";
 import { UuidDto } from "./uuid.dto.js";
 
 const fields = getLeaderboardFields(Player).map(([key]) => key);
 
 export class PlayerRankingsDto extends UuidDto {
   @ApiProperty({ enum: fields, type: [String] })
-  @IsEnum(fields, { each: true })
+  @IsArray()
+  @IsLeaderboardField(fields, { each: true })
   public fields: string[];
 }