@wise-old-man/utils 2.1.15 → 2.1.17

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type Prisma_Base_Achievement = {
+type Prisma_Base_Achievement = {
   playerId: number
   name: string
   metric: Metric
@@ -23,7 +23,7 @@ export type Competition = {
 }
 
 
-export type Prisma_Base_Delta = {
+type Prisma_Base_Delta = {
   id: number
   playerId: number
   period: Period
@@ -150,12 +150,13 @@ export type Membership = {
 }
 
 
-export type NameChange = {
+type Prisma_Base_NameChange = {
   id: number
   playerId: number
   oldName: string
   newName: string
   status: NameChangeStatus
+  reviewContext: unknown | null
   resolvedAt: Date | null
   updatedAt: Date
   createdAt: Date
@@ -173,7 +174,7 @@ export type Participation = {
 }
 
 
-export type Prisma_Base_Player = {
+type Prisma_Base_Player = {
   id: number
   username: string
   displayName: string
@@ -202,7 +203,7 @@ export type PlayerArchive = {
 }
 
 
-export type Prisma_Base_Record = {
+type Prisma_Base_Record = {
   id: number
   playerId: number
   period: Period
@@ -212,7 +213,7 @@ export type Prisma_Base_Record = {
 }
 
 
-export type Prisma_Base_Snapshot = {
+type Prisma_Base_Snapshot = {
   id: number
   playerId: number
   importedAt: Date | null
@@ -1237,6 +1238,9 @@ declare type Snapshot = Omit<Prisma_Base_Snapshot, 'overallExperience'> & {
 declare type Player = Omit<Prisma_Base_Player, 'exp' | 'latestSnapshotId'> & {
     exp: number;
 };
+declare type NameChange = Omit<Prisma_Base_NameChange, 'reviewContext'> & {
+    reviewContext: SkipContext | DenyContext | null;
+};
 
 interface AchievementTemplate {
     name: string;
@@ -1519,6 +1523,30 @@ interface EfficiencyAlgorithm {
 }
 declare type AlgorithmCache = MapOf<EfficiencyAlgorithmType, EfficiencyAlgorithm>;
 
+declare type DenyContext = {
+    reason: 'manual_review';
+} | {
+    reason: 'old_stats_cannot_be_found';
+} | {
+    reason: 'new_name_not_on_the_hiscores';
+} | {
+    reason: 'negative_gains';
+    negativeGains: MapOf<Metric, number>;
+};
+declare type SkipContext = {
+    reason: 'transition_period_too_long';
+    maxHoursDiff: number;
+    hoursDiff: number;
+} | {
+    reason: 'excessive_gains';
+    ehpDiff: number;
+    ehbDiff: number;
+    hoursDiff: number;
+} | {
+    reason: 'total_level_too_low';
+    minTotalLevel: number;
+    totalLevel: number;
+};
 declare type NameChangeDetails = {
     nameChange: NameChange;
     data?: {
@@ -1526,6 +1554,7 @@ declare type NameChangeDetails = {
         isOldOnHiscores: boolean;
         isNewTracked: boolean;
         hasNegativeGains: boolean;
+        negativeGains: MapOf<Metric, number> | null;
         timeDiff: number;
         hoursDiff: number;
         ehpDiff: number;
@@ -2148,11 +2177,6 @@ declare class NameChangesClient extends BaseAPIClient {
      * @returns A pending name change request, to be reviewed and resolved at a later date.
      */
     submitNameChange(oldName: string, newName: string): Promise<NameChange>;
-    /**
-     * Gets details on a specific name change request.
-     * @returns The name change request's details, which includes all data required to review.
-     */
-    getNameChangeDetails(id: number): Promise<NameChangeDetails>;
 }
 
 declare class CompetitionsClient extends BaseAPIClient {
@@ -2230,4 +2254,4 @@ declare class WOMClient {
     constructor(options?: WOMClientOptions);
 }
 
-export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, ActivityValueWithPlayer, AlgorithmCache, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, BossValueWithPlayer, CAPPED_MAX_TOTAL_XP, CMLGroupData, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, ChangeMemberRolePayload, CompetitionDetails, CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, CompetitionWithParticipations, CompetitionsSearchFilter, ComputedMetric, ComputedMetricDelta, ComputedMetricValue, ComputedMetricValueWithPlayer, Country, CountryDetails, CountryProps, CreateCompetitionPayload, CreateCompetitionResponse, CreateGroupPayload, CreateGroupResponse, DeltaLeaderboardEntry, DeltaLeaderboardFilter, EditCompetitionPayload, EditGroupPayload, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyAlgorithmTypeUnion, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, ExtendedAchievementWithPlayer, F2P_BOSSES, FlaggedPlayerReviewContext, FormattedSnapshot, GROUP_ROLES, GenericCountMessageResponse, GenericMessageResponse, GetGroupGainsFilter, GetPlayerGainsResponse, GroupDetails, GroupHiscoresActivityItem, GroupHiscoresBossItem, GroupHiscoresComputedMetricItem, GroupHiscoresEntry, GroupHiscoresSkillItem, GroupListItem, GroupMemberFragment, GroupRecordsFilter, GroupRole, GroupRoleProps, GroupStatistics, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MapOf, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricLeaders, MetricMeasure, MetricProps, MetricType, MetricValueKey, MigrationDataSource, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerCompetitionStandingsFilter, PlayerCompetitionsFilter, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, SkillMetaMethod, SkillValue, SkillValueWithPlayer, Snapshot, SnapshotDataSource, SnapshotFragment, Team, TempleGroupData, TimeRangeFilter, Top5ProgressResult, WOMClient, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isCompetitionStatus, isCompetitionType, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };
+export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, ActivityValueWithPlayer, AlgorithmCache, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, BossValueWithPlayer, CAPPED_MAX_TOTAL_XP, CMLGroupData, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, ChangeMemberRolePayload, CompetitionDetails, CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, CompetitionWithParticipations, CompetitionsSearchFilter, ComputedMetric, ComputedMetricDelta, ComputedMetricValue, ComputedMetricValueWithPlayer, Country, CountryDetails, CountryProps, CreateCompetitionPayload, CreateCompetitionResponse, CreateGroupPayload, CreateGroupResponse, DeltaLeaderboardEntry, DeltaLeaderboardFilter, DenyContext, EditCompetitionPayload, EditGroupPayload, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyAlgorithmTypeUnion, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, ExtendedAchievementWithPlayer, F2P_BOSSES, FlaggedPlayerReviewContext, FormattedSnapshot, GROUP_ROLES, GenericCountMessageResponse, GenericMessageResponse, GetGroupGainsFilter, GetPlayerGainsResponse, GroupDetails, GroupHiscoresActivityItem, GroupHiscoresBossItem, GroupHiscoresComputedMetricItem, GroupHiscoresEntry, GroupHiscoresSkillItem, GroupListItem, GroupMemberFragment, GroupRecordsFilter, GroupRole, GroupRoleProps, GroupStatistics, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MapOf, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricLeaders, MetricMeasure, MetricProps, MetricType, MetricValueKey, MigrationDataSource, NameChange, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerCompetitionStandingsFilter, PlayerCompetitionsFilter, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, SkillMetaMethod, SkillValue, SkillValueWithPlayer, SkipContext, Snapshot, SnapshotDataSource, SnapshotFragment, Team, TempleGroupData, TimeRangeFilter, Top5ProgressResult, WOMClient, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isCompetitionStatus, isCompetitionType, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };

package/dist/index.js

@@ -1823,12 +1823,12 @@ const BossProps = lodash.mapValues({
     [Boss.ALCHEMICAL_HYDRA]: { name: 'Alchemical Hydra' },
     [Boss.ARTIO]: { name: 'Artio' },
     [Boss.BARROWS_CHESTS]: { name: 'Barrows Chests' },
-    [Boss.BRYOPHYTA]: { name: 'Bryophyta', minimumValue: 5, isMembers: false },
+    [Boss.BRYOPHYTA]: { name: 'Bryophyta', isMembers: false },
     [Boss.CALLISTO]: { name: 'Callisto' },
     [Boss.CALVARION]: { name: "Calvar'ion" },
     [Boss.CERBERUS]: { name: 'Cerberus' },
     [Boss.CHAMBERS_OF_XERIC]: { name: 'Chambers Of Xeric' },
-    [Boss.CHAMBERS_OF_XERIC_CM]: { name: 'Chambers Of Xeric (CM)', minimumValue: 5 },
+    [Boss.CHAMBERS_OF_XERIC_CM]: { name: 'Chambers Of Xeric (CM)' },
     [Boss.CHAOS_ELEMENTAL]: { name: 'Chaos Elemental' },
     [Boss.CHAOS_FANATIC]: { name: 'Chaos Fanatic' },
     [Boss.COMMANDER_ZILYANA]: { name: 'Commander Zilyana' },
@@ -1841,7 +1841,7 @@ const BossProps = lodash.mapValues({
     [Boss.GENERAL_GRAARDOR]: { name: 'General Graardor' },
     [Boss.GIANT_MOLE]: { name: 'Giant Mole' },
     [Boss.GROTESQUE_GUARDIANS]: { name: 'Grotesque Guardians' },
-    [Boss.HESPORI]: { name: 'Hespori', minimumValue: 5 },
+    [Boss.HESPORI]: { name: 'Hespori' },
     [Boss.KALPHITE_QUEEN]: { name: 'Kalphite Queen' },
     [Boss.KING_BLACK_DRAGON]: { name: 'King Black Dragon' },
     [Boss.KRAKEN]: { name: 'Kraken' },
@@ -1851,29 +1851,29 @@ const BossProps = lodash.mapValues({
     [Boss.NEX]: { name: 'Nex' },
     [Boss.NIGHTMARE]: { name: 'Nightmare' },
     [Boss.PHOSANIS_NIGHTMARE]: { name: "Phosani's Nightmare" },
-    [Boss.OBOR]: { name: 'Obor', minimumValue: 5, isMembers: false },
+    [Boss.OBOR]: { name: 'Obor', isMembers: false },
     [Boss.PHANTOM_MUSPAH]: { name: 'Phantom Muspah' },
     [Boss.SARACHNIS]: { name: 'Sarachnis' },
     [Boss.SCORPIA]: { name: 'Scorpia' },
-    [Boss.SKOTIZO]: { name: 'Skotizo', minimumValue: 5 },
+    [Boss.SKOTIZO]: { name: 'Skotizo' },
     [Boss.SPINDEL]: { name: 'Spindel' },
     [Boss.TEMPOROSS]: { name: 'Tempoross' },
     [Boss.THE_GAUNTLET]: { name: 'The Gauntlet' },
-    [Boss.THE_CORRUPTED_GAUNTLET]: { name: 'The Corrupted Gauntlet', minimumValue: 5 },
+    [Boss.THE_CORRUPTED_GAUNTLET]: { name: 'The Corrupted Gauntlet' },
     [Boss.THEATRE_OF_BLOOD]: { name: 'Theatre Of Blood' },
     [Boss.THEATRE_OF_BLOOD_HARD_MODE]: { name: 'Theatre Of Blood (HM)' },
     [Boss.THERMONUCLEAR_SMOKE_DEVIL]: { name: 'Thermonuclear Smoke Devil' },
     [Boss.TOMBS_OF_AMASCUT]: { name: 'Tombs of Amascut' },
     [Boss.TOMBS_OF_AMASCUT_EXPERT]: { name: 'Tombs of Amascut (Expert Mode)' },
     [Boss.TZKAL_ZUK]: { name: 'TzKal-Zuk', minimumValue: 1 },
-    [Boss.TZTOK_JAD]: { name: 'TzTok-Jad', minimumValue: 5 },
+    [Boss.TZTOK_JAD]: { name: 'TzTok-Jad' },
     [Boss.VENENATIS]: { name: 'Venenatis' },
     [Boss.VETION]: { name: "Vet'ion" },
     [Boss.VORKATH]: { name: 'Vorkath' },
     [Boss.WINTERTODT]: { name: 'Wintertodt' },
     [Boss.ZALCANO]: { name: 'Zalcano' },
     [Boss.ZULRAH]: { name: 'Zulrah' }
-}, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.BOSS, measure: exports.MetricMeasure.KILLS, isMembers: 'isMembers' in props ? props.isMembers : true, minimumValue: 'minimumValue' in props ? props.minimumValue : 10 })));
+}, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.BOSS, measure: exports.MetricMeasure.KILLS, isMembers: 'isMembers' in props ? props.isMembers : true, minimumValue: 'minimumValue' in props ? props.minimumValue : 5 })));
 const ActivityProps = lodash.mapValues({
     [Activity.LEAGUE_POINTS]: { name: 'League Points' },
     [Activity.BOUNTY_HUNTER_HUNTER]: { name: 'Bounty Hunter (Hunter)' },
@@ -2413,13 +2413,6 @@ class NameChangesClient extends BaseAPIClient {
     submitNameChange(oldName, newName) {
         return this.postRequest('/names', { oldName, newName });
     }
-    /**
-     * Gets details on a specific name change request.
-     * @returns The name change request's details, which includes all data required to review.
-     */
-    getNameChangeDetails(id) {
-        return this.getRequest(`/names/${id}`);
-    }
 }
 
 class CompetitionsClient extends BaseAPIClient {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise-old-man/utils",
-  "version": "2.1.15",
+  "version": "2.1.17",
   "description": "A JavaScript/TypeScript client that interfaces and consumes the Wise Old Man API, an API that tracks and measures players' progress in Old School Runescape.",
   "keywords": [
     "wiseoldman",