Update bot wom types (#295)

Author: psikoi

hack.d.ts

@@ -47,7 +47,7 @@
     "@sapphire/discord.js-utilities": "^7.1.6",
     "@sentry/node": "^7.28.0",
     "@sentry/tracing": "^7.28.0",
-    "@wise-old-man/utils": "^3.3.15",
+    "@wise-old-man/utils": "^4.0.4",
     "axios": "^1.9.0",
     "canvas": "^2.6.1",
     "cors": "^2.8.5",

package-lock.json

@@ -1,4 +1,4 @@
-import { CountryProps, getMetricName, METRICS, PeriodProps, PERIODS } from '@wise-old-man/utils';
+import { CountryProps, MetricProps, METRICS, PeriodProps, PERIODS } from '@wise-old-man/utils';
 import { CUSTOM_COMMANDS } from './custom';
 
 interface AutoCompleteOption {
@@ -30,7 +30,7 @@ export function getPeriodOptions(currentValue: string): AutoCompleteOption[] {
 export function getMetricOptions(currentValue: string): AutoCompleteOption[] {
   return METRICS.filter(metric => (!currentValue ? true : matches(currentValue, metric))).map(
     metric => ({
-      name: getMetricName(metric),
+      name: MetricProps[metric].name,
       value: metric
     })
   );

package.json

@@ -1,15 +1,15 @@
-import { GroupDetails } from '@wise-old-man/utils';
+import { GroupDetailsResponse } from '@wise-old-man/utils';
 import { ApplicationCommandOptionType, ChatInputCommandInteraction, EmbedBuilder } from 'discord.js';
-import config from '../../../config';
 import { CUSTOM_COMMANDS } from '../../../commands/custom';
+import config from '../../../config';
 import prisma, { getServer } from '../../../services/prisma';
 import womClient from '../../../services/wiseoldman';
 import {
   Command,
   CommandConfig,
+  CommandError,
   NotificationName,
-  NotificationType,
-  CommandError
+  NotificationType
 } from '../../../utils';
 
 const BOT_URL = 'https://bot.wiseoldman.net';
@@ -72,7 +72,7 @@ class HelpCommand extends Command {
       return;
     }
 
-    let group: GroupDetails | null = null;
+    let group: GroupDetailsResponse | null = null;
 
     if (groupId && groupId > -1) {
       try {

src/commands/autocomplete.ts

@@ -1,11 +1,10 @@
 import {
-  CompetitionDetails,
+  CompetitionDetailsResponse,
   CompetitionStatus,
   CompetitionStatusProps,
   CompetitionType,
   CompetitionTypeProps,
   formatNumber,
-  isCompetitionStatus,
   MetricProps
 } from '@wise-old-man/utils';
 import { ApplicationCommandOptionType, ChatInputCommandInteraction, EmbedBuilder } from 'discord.js';
@@ -59,8 +58,11 @@ class GroupCompetitionCommand extends Command {
 
     // Extract the "status" param, or fallback to "ongoing"
     const statusParam = interaction.options.getString('status');
+
     const status =
-      statusParam !== null && isCompetitionStatus(statusParam) ? statusParam : CompetitionStatus.ONGOING;
+      statusParam !== null && statusParam in CompetitionStatusProps
+        ? (statusParam as CompetitionStatus)
+        : CompetitionStatus.ONGOING;
 
     // Extract the "competition_id" param, or fallback to the default competition
     const competitionIdParam = interaction.options.getInteger('competition_id');
@@ -82,21 +84,21 @@ class GroupCompetitionCommand extends Command {
   }
 }
 
-function getFooterDate(competition: CompetitionDetails) {
+function getFooterDate(competition: CompetitionDetailsResponse) {
   return getCompetitionStatus(competition) === CompetitionStatus.UPCOMING
     ? new Date(competition.startsAt)
     : new Date(competition.endsAt);
 }
 
-function getFooterLabel(competition: CompetitionDetails) {
+function getFooterLabel(competition: CompetitionDetailsResponse) {
   const status = getCompetitionStatus(competition);
 
   if (status === CompetitionStatus.UPCOMING) return 'Starts at';
   if (status === CompetitionStatus.ONGOING) return 'Ends at';
   return 'Ended at';
 }
 
-function buildContent(competition: CompetitionDetails) {
+function buildContent(competition: CompetitionDetailsResponse) {
   const { metric, type, participations, participantCount } = competition;
   const timeLeft = getCompetitionTimeLeft(competition).split(' ');
 
@@ -135,7 +137,7 @@ function buildContent(competition: CompetitionDetails) {
   return lines.join('\n');
 }
 
-function aggregateTeamData(competition: CompetitionDetails) {
+function aggregateTeamData(competition: CompetitionDetailsResponse) {
   const participants = competition.participations;
 
   if (!participants || participants.length === 0) return [];

src/commands/instances/general/HelpCommand.ts

@@ -1,12 +1,12 @@
 import {
-  CompetitionListItem,
+  CompetitionResponse,
   CompetitionStatus,
   CompetitionTypeProps,
-  GroupDetails
+  GroupDetailsResponse
 } from '@wise-old-man/utils';
 import { ChatInputCommandInteraction, EmbedBuilder } from 'discord.js';
-import womClient, { getCompetitionStatus, getCompetitionTimeLeft } from '../../../services/wiseoldman';
 import config from '../../../config';
+import womClient, { getCompetitionStatus, getCompetitionTimeLeft } from '../../../services/wiseoldman';
 import { Command, CommandConfig, CommandError, getEmoji, getLinkedGroupId } from '../../../utils';
 import { createPaginatedEmbed } from '../../pagination';
 
@@ -71,7 +71,7 @@ class GroupCompetitionsCommand extends Command {
   }
 }
 
-function buildCompetitionsList(competitions: CompetitionListItem[]) {
+function buildCompetitionsList(competitions: CompetitionResponse[]) {
   return competitions
     .map(c => ({ ...c, status: getCompetitionStatus(c) }))
     .sort(
@@ -95,7 +95,7 @@ function buildCompetitionsList(competitions: CompetitionListItem[]) {
     });
 }
 
-function buildPages(group: GroupDetails, competitions: CompetitionListItem[]) {
+function buildPages(group: GroupDetailsResponse, competitions: CompetitionResponse[]) {
   const competitionsList = buildCompetitionsList(competitions);
   const pageCount = Math.ceil(competitionsList.length / COMPETITIONS_PER_PAGE);
 

src/commands/instances/group/GroupCompetitionCommand.ts

@@ -1,15 +1,15 @@
 import {
   formatNumber,
-  getMetricName,
   isMetric,
   Metric,
+  MetricProps,
   parsePeriodExpression,
   PeriodProps
 } from '@wise-old-man/utils';
 import { ApplicationCommandOptionType, ChatInputCommandInteraction, EmbedBuilder } from 'discord.js';
-import womClient, { parseMetricAbbreviation } from '../../../services/wiseoldman';
 import config from '../../../config';
-import { Command, CommandConfig, CommandError, getEmoji, getLinkedGroupId, bold } from '../../../utils';
+import womClient, { parseMetricAbbreviation } from '../../../services/wiseoldman';
+import { bold, Command, CommandConfig, CommandError, getEmoji, getLinkedGroupId } from '../../../utils';
 
 const CONFIG: CommandConfig = {
   name: 'gained',
@@ -61,12 +61,12 @@ class GroupGainedCommand extends Command {
       period in PeriodProps
         ? `period=${period}`
         : `startDate=${new Date(
-            Date.now() - parsePeriodExpression(period).durationMs
+            Date.now() - parsePeriodExpression(period)!.durationMs
           ).toISOString()}&endDate=${new Date().toISOString()}`;
 
     const response = new EmbedBuilder()
       .setColor(config.visuals.blue)
-      .setTitle(`${getEmoji(metric)} ${group.name} ${getMetricName(metric)} gains (${period})`)
+      .setTitle(`${getEmoji(metric)} ${group.name} ${MetricProps[metric].name} gains (${period})`)
       .setURL(`https://wiseoldman.net/groups/${groupId}/gained?${urlPeriod}&metric=${metric}`)
       .setFooter({ text: `Tip: Try /group gained metric: zulrah period: day` })
       .setDescription(gainedList);

src/commands/instances/group/GroupCompetitionsCommand.ts

@@ -1,7 +1,7 @@
-import { formatNumber, getMetricName, GroupHiscoresEntry, Metric } from '@wise-old-man/utils';
+import { formatNumber, GroupHiscoresEntryResponse, Metric, MetricProps } from '@wise-old-man/utils';
 import { ApplicationCommandOptionType, ChatInputCommandInteraction, EmbedBuilder } from 'discord.js';
-import womClient, { parseMetricAbbreviation } from '../../../services/wiseoldman';
 import config from '../../../config';
+import womClient, { parseMetricAbbreviation } from '../../../services/wiseoldman';
 import { bold, Command, CommandConfig, CommandError, getEmoji, getLinkedGroupId } from '../../../utils';
 
 const CONFIG: CommandConfig = {
@@ -41,7 +41,7 @@ class GroupHiscoresCommand extends Command {
 
     const response = new EmbedBuilder()
       .setColor(config.visuals.blue)
-      .setTitle(`${getEmoji(metric)} ${group.name} ${getMetricName(metric)} hiscores`)
+      .setTitle(`${getEmoji(metric)} ${group.name} ${MetricProps[metric].name} hiscores`)
       .setDescription(hiscoresList)
       .setURL(`https://wiseoldman.net/groups/${groupId}/hiscores?metric=${metric}`)
       .setFooter({ text: `Tip: Try /group hiscores metric: zulrah` });
@@ -50,7 +50,7 @@ class GroupHiscoresCommand extends Command {
   }
 }
 
-function getValue(result: GroupHiscoresEntry): string {
+function getValue(result: GroupHiscoresEntryResponse): string {
   if ('level' in result.data) {
     return `${result.data.level} (${formatNumber(result.data.experience || 0, true)})`;
   }

src/commands/instances/group/GroupGainedCommand.ts

@@ -1,16 +1,16 @@
 import {
   formatNumber,
-  getMetricName,
   isMetric,
   isPeriod,
   Metric,
+  MetricProps,
   Period,
   PeriodProps,
   PERIODS
 } from '@wise-old-man/utils';
 import { ApplicationCommandOptionType, ChatInputCommandInteraction, EmbedBuilder } from 'discord.js';
-import womClient, { parseMetricAbbreviation } from '../../../services/wiseoldman';
 import config from '../../../config';
+import womClient, { parseMetricAbbreviation } from '../../../services/wiseoldman';
 import { bold, Command, CommandConfig, CommandError, getEmoji, getLinkedGroupId } from '../../../utils';
 
 const CONFIG: CommandConfig = {
@@ -60,7 +60,7 @@ class GroupRecordsCommand extends Command {
 
     const response = new EmbedBuilder()
       .setColor(config.visuals.blue)
-      .setTitle(`${getEmoji(metric)} ${group.name} ${getMetricName(metric)} records (${period})`)
+      .setTitle(`${getEmoji(metric)} ${group.name} ${MetricProps[metric].name} records (${period})`)
       .setDescription(recordsList)
       .setURL(`https://wiseoldman.net/groups/${groupId}/records?period=${period}&metric=${metric}`)
       .setFooter({ text: `Tip: Try /group records metric: zulrah period: day` });