@wise-old-man/utils 2.1.6 → 2.1.8

package/dist/index.d.ts

@@ -56,9 +56,11 @@ export type Prisma_Base_Delta = {
   construction: number
   abyssal_sire: number
   alchemical_hydra: number
+  artio: number
   barrows_chests: number
   bryophyta: number
   callisto: number
+  calvarion: number
   cerberus: number
   chambers_of_xeric: number
   chambers_of_xeric_challenge_mode: number
@@ -89,6 +91,7 @@ export type Prisma_Base_Delta = {
   sarachnis: number
   scorpia: number
   skotizo: number
+  spindel: number
   tempoross: number
   the_gauntlet: number
   the_corrupted_gauntlet: number
@@ -176,6 +179,7 @@ export type Prisma_Base_Player = {
   displayName: string
   type: PlayerType
   build: PlayerBuild
+  status: PlayerStatus
   country: Country | null
   flagged: boolean
   exp: bigint
@@ -191,6 +195,14 @@ export type Prisma_Base_Player = {
 }
 
 
+export type PlayerArchive = {
+  playerId: number
+  previousUsername: string
+  archiveUsername: string
+  createdAt: Date
+}
+
+
 export type Prisma_Base_Record = {
   id: number
   playerId: number
@@ -282,6 +294,8 @@ export type Prisma_Base_Snapshot = {
   abyssal_sireKills: number
   alchemical_hydraRank: number
   alchemical_hydraKills: number
+  artioRank: number
+  artioKills: number
   barrows_chestsRank: number
   barrows_chestsKills: number
   bryophytaKills: number
@@ -291,6 +305,8 @@ export type Prisma_Base_Snapshot = {
   cerberusRank: number
   callistoRank: number
   callistoKills: number
+  calvarionRank: number
+  calvarionKills: number
   chambers_of_xericKills: number
   chambers_of_xeric_challenge_modeRank: number
   chambers_of_xeric_challenge_modeKills: number
@@ -344,6 +360,8 @@ export type Prisma_Base_Snapshot = {
   scorpiaKills: number
   skotizoRank: number
   skotizoKills: number
+  spindelRank: number
+  spindelKills: number
   the_gauntletRank: number
   the_gauntletKills: number
   the_corrupted_gauntletKills: number
@@ -483,9 +501,11 @@ declare type Activity = typeof Activity[keyof typeof Activity];
 declare const Boss: {
     readonly ABYSSAL_SIRE: "abyssal_sire";
     readonly ALCHEMICAL_HYDRA: "alchemical_hydra";
+    readonly ARTIO: "artio";
     readonly BARROWS_CHESTS: "barrows_chests";
     readonly BRYOPHYTA: "bryophyta";
     readonly CALLISTO: "callisto";
+    readonly CALVARION: "calvarion";
     readonly CERBERUS: "cerberus";
     readonly CHAMBERS_OF_XERIC: "chambers_of_xeric";
     readonly CHAMBERS_OF_XERIC_CM: "chambers_of_xeric_challenge_mode";
@@ -516,6 +536,7 @@ declare const Boss: {
     readonly SARACHNIS: "sarachnis";
     readonly SCORPIA: "scorpia";
     readonly SKOTIZO: "skotizo";
+    readonly SPINDEL: "spindel";
     readonly TEMPOROSS: "tempoross";
     readonly THE_GAUNTLET: "the_gauntlet";
     readonly THE_CORRUPTED_GAUNTLET: "the_corrupted_gauntlet";
@@ -544,9 +565,11 @@ declare const Metric: {
     readonly EHB: "ehb";
     readonly ABYSSAL_SIRE: "abyssal_sire";
     readonly ALCHEMICAL_HYDRA: "alchemical_hydra";
+    readonly ARTIO: "artio";
     readonly BARROWS_CHESTS: "barrows_chests";
     readonly BRYOPHYTA: "bryophyta";
     readonly CALLISTO: "callisto";
+    readonly CALVARION: "calvarion";
     readonly CERBERUS: "cerberus";
     readonly CHAMBERS_OF_XERIC: "chambers_of_xeric";
     readonly CHAMBERS_OF_XERIC_CM: "chambers_of_xeric_challenge_mode";
@@ -577,6 +600,7 @@ declare const Metric: {
     readonly SARACHNIS: "sarachnis";
     readonly SCORPIA: "scorpia";
     readonly SKOTIZO: "skotizo";
+    readonly SPINDEL: "spindel";
     readonly TEMPOROSS: "tempoross";
     readonly THE_GAUNTLET: "the_gauntlet";
     readonly THE_CORRUPTED_GAUNTLET: "the_corrupted_gauntlet";
@@ -665,6 +689,13 @@ declare const PlayerBuild: {
     readonly HP10: "hp10";
 };
 declare type PlayerBuild = typeof PlayerBuild[keyof typeof PlayerBuild];
+declare const PlayerStatus: {
+    readonly ACTIVE: "active";
+    readonly UNRANKED: "unranked";
+    readonly FLAGGED: "flagged";
+    readonly ARCHIVED: "archived";
+};
+declare type PlayerStatus = typeof PlayerStatus[keyof typeof PlayerStatus];
 declare const CompetitionType: {
     readonly CLASSIC: "classic";
     readonly TEAM: "team";
@@ -1510,6 +1541,23 @@ interface PlayerDetails extends Player {
     combatLevel: number;
     latestSnapshot: FormattedSnapshot;
 }
+interface FlaggedPlayerReviewContext {
+    previous: FormattedSnapshot;
+    rejected: FormattedSnapshot;
+    negativeGains: boolean;
+    excessiveGains: boolean;
+    possibleRollback: boolean;
+    excessiveGainsReversed: boolean;
+    data: {
+        stackableGainedRatio: number;
+        previousEHP: number;
+        previousEHB: number;
+        previousRank: number;
+        rejectedEHP: number;
+        rejectedEHB: number;
+        rejectedRank: number;
+    };
+}
 
 declare type RecordLeaderboardEntry = Record & {
     player: Player;
@@ -1621,9 +1669,11 @@ declare const MetricProps: {
     readonly guardians_of_the_rift: ActivityProperties;
     readonly abyssal_sire: BossProperties;
     readonly alchemical_hydra: BossProperties;
+    readonly artio: BossProperties;
     readonly barrows_chests: BossProperties;
     readonly bryophyta: BossProperties;
     readonly callisto: BossProperties;
+    readonly calvarion: BossProperties;
     readonly cerberus: BossProperties;
     readonly chambers_of_xeric: BossProperties;
     readonly chambers_of_xeric_challenge_mode: BossProperties;
@@ -1654,6 +1704,7 @@ declare const MetricProps: {
     readonly sarachnis: BossProperties;
     readonly scorpia: BossProperties;
     readonly skotizo: BossProperties;
+    readonly spindel: BossProperties;
     readonly tempoross: BossProperties;
     readonly the_gauntlet: BossProperties;
     readonly the_corrupted_gauntlet: BossProperties;
@@ -1738,10 +1789,15 @@ declare const PlayerTypeProps: MapOf<PlayerType, {
 declare const PlayerBuildProps: MapOf<PlayerBuild, {
     name: string;
 }>;
+declare const PlayerStatusProps: MapOf<PlayerStatus, {
+    name: string;
+}>;
 declare const PLAYER_TYPES: ("unknown" | "regular" | "ironman" | "hardcore" | "ultimate" | "fresh_start")[];
 declare const PLAYER_BUILDS: ("main" | "f2p" | "lvl3" | "zerker" | "def1" | "hp10")[];
+declare const PLAYER_STATUSES: ("active" | "unranked" | "flagged" | "archived")[];
 declare function isPlayerType(typeString: string): typeString is PlayerType;
 declare function isPlayerBuild(buildString: string): buildString is PlayerBuild;
+declare function isPlayerStatus(statusString: string): statusString is PlayerStatus;
 declare function findPlayerType(typeName: string): PlayerType | null;
 declare function findPlayerBuild(buildName: string): PlayerBuild | null;
 
@@ -2176,4 +2232,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, 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_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerCompetitionStandingsFilter, PlayerCompetitionsFilter, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, 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, 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, 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 };

package/dist/index.js

@@ -513,9 +513,11 @@ const Activity = {
 const Boss = {
     ABYSSAL_SIRE: 'abyssal_sire',
     ALCHEMICAL_HYDRA: 'alchemical_hydra',
+    ARTIO: 'artio',
     BARROWS_CHESTS: 'barrows_chests',
     BRYOPHYTA: 'bryophyta',
     CALLISTO: 'callisto',
+    CALVARION: 'calvarion',
     CERBERUS: 'cerberus',
     CHAMBERS_OF_XERIC: 'chambers_of_xeric',
     CHAMBERS_OF_XERIC_CM: 'chambers_of_xeric_challenge_mode',
@@ -546,6 +548,7 @@ const Boss = {
     SARACHNIS: 'sarachnis',
     SCORPIA: 'scorpia',
     SKOTIZO: 'skotizo',
+    SPINDEL: 'spindel',
     TEMPOROSS: 'tempoross',
     THE_GAUNTLET: 'the_gauntlet',
     THE_CORRUPTED_GAUNTLET: 'the_corrupted_gauntlet',
@@ -596,6 +599,12 @@ const PlayerBuild = {
     DEF1: 'def1',
     HP10: 'hp10'
 };
+const PlayerStatus = {
+    ACTIVE: 'active',
+    UNRANKED: 'unranked',
+    FLAGGED: 'flagged',
+    ARCHIVED: 'archived'
+};
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
@@ -1813,9 +1822,11 @@ const SkillProps = lodash.mapValues({
 const BossProps = lodash.mapValues({
     [Boss.ABYSSAL_SIRE]: { name: 'Abyssal Sire' },
     [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.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 },
@@ -1844,8 +1855,9 @@ const BossProps = lodash.mapValues({
     [Boss.OBOR]: { name: 'Obor', minimumValue: 5, isMembers: false },
     [Boss.PHANTOM_MUSPAH]: { name: 'Phantom Muspah' },
     [Boss.SARACHNIS]: { name: 'Sarachnis' },
-    [Boss.SKOTIZO]: { name: 'Skotizo', minimumValue: 5 },
     [Boss.SCORPIA]: { name: 'Scorpia' },
+    [Boss.SKOTIZO]: { name: 'Skotizo', minimumValue: 5 },
+    [Boss.SPINDEL]: { name: 'Spindel' },
     [Boss.TEMPOROSS]: { name: 'Tempoross' },
     [Boss.THE_GAUNTLET]: { name: 'The Gauntlet' },
     [Boss.THE_CORRUPTED_GAUNTLET]: { name: 'The Corrupted Gauntlet', minimumValue: 5 },
@@ -2261,14 +2273,24 @@ const PlayerBuildProps = {
     [PlayerBuild.DEF1]: { name: '1 Defence Pure' },
     [PlayerBuild.HP10]: { name: '10 Hitpoints Pure' }
 };
+const PlayerStatusProps = {
+    [PlayerStatus.ACTIVE]: { name: 'Active' },
+    [PlayerStatus.UNRANKED]: { name: 'Unranked' },
+    [PlayerStatus.FLAGGED]: { name: 'Flagged' },
+    [PlayerStatus.ARCHIVED]: { name: 'Archived' }
+};
 const PLAYER_TYPES = Object.values(PlayerType);
 const PLAYER_BUILDS = Object.values(PlayerBuild);
+const PLAYER_STATUSES = Object.values(PlayerStatus);
 function isPlayerType(typeString) {
     return typeString in PlayerTypeProps;
 }
 function isPlayerBuild(buildString) {
     return buildString in PlayerBuildProps;
 }
+function isPlayerStatus(statusString) {
+    return statusString in PlayerStatusProps;
+}
 function findPlayerType(typeName) {
     for (const [key, value] of Object.entries(PlayerTypeProps)) {
         if (value.name.toUpperCase() === typeName.toUpperCase())
@@ -2548,12 +2570,15 @@ exports.MetricProps = MetricProps;
 exports.NameChangeStatus = NameChangeStatus;
 exports.PERIODS = PERIODS;
 exports.PLAYER_BUILDS = PLAYER_BUILDS;
+exports.PLAYER_STATUSES = PLAYER_STATUSES;
 exports.PLAYER_TYPES = PLAYER_TYPES;
 exports.PRIVELEGED_GROUP_ROLES = PRIVELEGED_GROUP_ROLES;
 exports.Period = Period;
 exports.PeriodProps = PeriodProps;
 exports.PlayerBuild = PlayerBuild;
 exports.PlayerBuildProps = PlayerBuildProps;
+exports.PlayerStatus = PlayerStatus;
+exports.PlayerStatusProps = PlayerStatusProps;
 exports.PlayerType = PlayerType;
 exports.PlayerTypeProps = PlayerTypeProps;
 exports.REAL_SKILLS = REAL_SKILLS;
@@ -2589,6 +2614,7 @@ exports.isGroupRole = isGroupRole;
 exports.isMetric = isMetric;
 exports.isPeriod = isPeriod;
 exports.isPlayerBuild = isPlayerBuild;
+exports.isPlayerStatus = isPlayerStatus;
 exports.isPlayerType = isPlayerType;
 exports.isSkill = isSkill;
 exports.padNumber = padNumber;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise-old-man/utils",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "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",