@wise-old-man/utils 2.1.6 → 2.1.7

package/dist/index.d.ts

@@ -176,6 +176,7 @@ export type Prisma_Base_Player = {
   displayName: string
   type: PlayerType
   build: PlayerBuild
+  status: PlayerStatus
   country: Country | null
   flagged: boolean
   exp: bigint
@@ -191,6 +192,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
@@ -665,6 +674,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 +1526,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;
@@ -1738,10 +1771,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 +2214,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

@@ -596,6 +596,12 @@ const PlayerBuild = {
     DEF1: 'def1',
     HP10: 'hp10'
 };
+const PlayerStatus = {
+    ACTIVE: 'active',
+    UNRANKED: 'unranked',
+    FLAGGED: 'flagged',
+    ARCHIVED: 'archived'
+};
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
@@ -2261,14 +2267,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 +2564,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 +2608,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.7",
   "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",