@wise-old-man/utils 4.0.0 → 4.0.2

package/dist/cjs/index.cjs

@@ -320,13 +320,13 @@ exports.CompetitionStatus = void 0;
     CompetitionStatus["ONGOING"] = "ongoing";
     CompetitionStatus["FINISHED"] = "finished";
 })(exports.CompetitionStatus || (exports.CompetitionStatus = {}));
-Object.values(exports.CompetitionStatus);
+const COMPETITION_STATUSES = Object.values(exports.CompetitionStatus);
 
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
 };
-Object.values(CompetitionType);
+const COMPETITION_TYPES = Object.values(CompetitionType);
 
 const Country = {
     AD: 'AD',
@@ -582,7 +582,7 @@ const Country = {
     ZM: 'ZM',
     ZW: 'ZW'
 };
-Object.values(Country);
+const COUNTRY_CODES = Object.values(Country);
 
 exports.EfficiencyAlgorithmType = void 0;
 (function (EfficiencyAlgorithmType) {
@@ -868,23 +868,29 @@ const GroupRole = {
     ZEALOT: 'zealot',
     ZENYTE: 'zenyte'
 };
-Object.values(GroupRole);
+const GROUP_ROLES = Object.values(GroupRole);
 
-var MetricMeasure;
+const MemberActivityType = {
+    JOINED: 'joined',
+    LEFT: 'left',
+    CHANGED_ROLE: 'changed_role'
+};
+
+exports.MetricMeasure = void 0;
 (function (MetricMeasure) {
     MetricMeasure["EXPERIENCE"] = "experience";
     MetricMeasure["KILLS"] = "kills";
     MetricMeasure["SCORE"] = "score";
     MetricMeasure["VALUE"] = "value";
-})(MetricMeasure || (MetricMeasure = {}));
+})(exports.MetricMeasure || (exports.MetricMeasure = {}));
 
-var MetricType;
+exports.MetricType = void 0;
 (function (MetricType) {
     MetricType["SKILL"] = "skill";
     MetricType["BOSS"] = "boss";
     MetricType["ACTIVITY"] = "activity";
     MetricType["COMPUTED"] = "computed";
-})(MetricType || (MetricType = {}));
+})(exports.MetricType || (exports.MetricType = {}));
 
 const Skill = {
     OVERALL: 'overall',
@@ -1004,11 +1010,11 @@ const ComputedMetric = {
     EHB: 'ehb'
 };
 const Metric = Object.assign(Object.assign(Object.assign(Object.assign({}, Skill), Activity), Boss), ComputedMetric);
-Object.values(Metric);
+const METRICS = Object.values(Metric);
 const SKILLS = Object.values(Skill);
 const BOSSES = Object.values(Boss);
 const ACTIVITIES = Object.values(Activity);
-Object.values(ComputedMetric);
+const COMPUTED_METRICS = Object.values(ComputedMetric);
 
 const NameChangeStatus = {
     PENDING: 'pending',
@@ -1023,7 +1029,15 @@ const Period = {
     MONTH: 'month',
     YEAR: 'year'
 };
-Object.values(Period);
+const PERIODS = Object.values(Period);
+
+const PlayerAnnotationType = {
+    OPT_OUT: 'opt_out',
+    OPT_OUT_GROUPS: 'opt_out_groups',
+    OPT_OUT_COMPETITIONS: 'opt_out_competitions',
+    BLOCKED: 'blocked',
+    FAKE_F2P: 'fake_f2p'
+};
 
 const PlayerBuild = {
     MAIN: 'main',
@@ -1034,7 +1048,7 @@ const PlayerBuild = {
     DEF1: 'def1',
     HP10: 'hp10'
 };
-Object.values(PlayerBuild);
+const PLAYER_BUILDS = Object.values(PlayerBuild);
 
 const PlayerStatus = {
     ACTIVE: 'active',
@@ -1043,6 +1057,7 @@ const PlayerStatus = {
     ARCHIVED: 'archived',
     BANNED: 'banned'
 };
+const PLAYER_STATUSES = Object.values(PlayerStatus);
 
 const PlayerType = {
     UNKNOWN: 'unknown',
@@ -1051,7 +1066,7 @@ const PlayerType = {
     HARDCORE: 'hardcore',
     ULTIMATE: 'ultimate'
 };
-Object.values(PlayerType);
+const PLAYER_TYPES = Object.values(PlayerType);
 
 class EfficiencyClient extends BaseAPIClient {
     /**
@@ -2044,7 +2059,7 @@ const SkillProps = mapValues({
     [Skill.RUNECRAFTING]: { name: 'Runecrafting' },
     [Skill.HUNTER]: { name: 'Hunter', isMembers: true },
     [Skill.CONSTRUCTION]: { name: 'Construction', isMembers: true }
-}, props => (Object.assign(Object.assign({}, props), { type: MetricType.SKILL, measure: MetricMeasure.EXPERIENCE, isCombat: 'isCombat' in props ? props.isCombat : false, isMembers: 'isMembers' in props ? props.isMembers : false })));
+}, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.SKILL, measure: exports.MetricMeasure.EXPERIENCE, isCombat: 'isCombat' in props ? props.isCombat : false, isMembers: 'isMembers' in props ? props.isMembers : false })));
 const BossProps = mapValues({
     [Boss.ABYSSAL_SIRE]: { name: 'Abyssal Sire' },
     [Boss.ALCHEMICAL_HYDRA]: { name: 'Alchemical Hydra' },
@@ -2113,7 +2128,7 @@ const BossProps = mapValues({
     [Boss.YAMA]: { name: 'Yama' },
     [Boss.ZALCANO]: { name: 'Zalcano' },
     [Boss.ZULRAH]: { name: 'Zulrah' }
-}, props => (Object.assign(Object.assign({}, props), { type: MetricType.BOSS, measure: MetricMeasure.KILLS, isMembers: 'isMembers' in props ? props.isMembers : true, minimumValue: 'minimumValue' in props ? props.minimumValue : 5 })));
+}, 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 = mapValues({
     [Activity.LEAGUE_POINTS]: { name: 'League Points', minimumValue: 100 },
     [Activity.BOUNTY_HUNTER_HUNTER]: { name: 'Bounty Hunter (Hunter)', minimumValue: 2 },
@@ -2131,11 +2146,11 @@ const ActivityProps = mapValues({
     [Activity.GUARDIANS_OF_THE_RIFT]: { name: 'Guardians of the Rift', minimumValue: 2 },
     [Activity.COLOSSEUM_GLORY]: { name: 'Colosseum Glory', minimumValue: 300 },
     [Activity.COLLECTIONS_LOGGED]: { name: 'Collection Logs', minimumValue: 500 }
-}, props => (Object.assign(Object.assign({}, props), { type: MetricType.ACTIVITY, measure: MetricMeasure.SCORE, minimumValue: 'minimumValue' in props ? props.minimumValue : 1 })));
+}, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.ACTIVITY, measure: exports.MetricMeasure.SCORE, minimumValue: 'minimumValue' in props ? props.minimumValue : 1 })));
 const ComputedMetricProps = mapValues({
     [ComputedMetric.EHP]: { name: 'EHP' },
     [ComputedMetric.EHB]: { name: 'EHB' }
-}, props => (Object.assign(Object.assign({}, props), { type: MetricType.COMPUTED, measure: MetricMeasure.VALUE })));
+}, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.COMPUTED, measure: exports.MetricMeasure.VALUE })));
 const MetricProps = Object.assign(Object.assign(Object.assign(Object.assign({}, SkillProps), BossProps), ActivityProps), ComputedMetricProps);
 const REAL_SKILLS = SKILLS.filter(s => s !== Skill.OVERALL);
 const F2P_BOSSES = BOSSES.filter(b => !MetricProps[b].isMembers);
@@ -2214,37 +2229,57 @@ function isPlayerType(typeString) {
     return typeString in PlayerTypeProps;
 }
 
+exports.ACTIVITIES = ACTIVITIES;
+exports.Activity = Activity;
 exports.ActivityProps = ActivityProps;
+exports.BOSSES = BOSSES;
+exports.Boss = Boss;
 exports.BossProps = BossProps;
 exports.CAPPED_MAX_TOTAL_XP = CAPPED_MAX_TOTAL_XP;
 exports.COMBAT_SKILLS = COMBAT_SKILLS;
+exports.COMPETITION_STATUSES = COMPETITION_STATUSES;
+exports.COMPETITION_TYPES = COMPETITION_TYPES;
+exports.COMPUTED_METRICS = COMPUTED_METRICS;
+exports.COUNTRY_CODES = COUNTRY_CODES;
 exports.CompetitionStatusProps = CompetitionStatusProps;
 exports.CompetitionType = CompetitionType;
 exports.CompetitionTypeProps = CompetitionTypeProps;
+exports.ComputedMetric = ComputedMetric;
 exports.ComputedMetricProps = ComputedMetricProps;
 exports.Country = Country;
 exports.CountryProps = CountryProps;
 exports.F2P_BOSSES = F2P_BOSSES;
+exports.GROUP_ROLES = GROUP_ROLES;
 exports.GroupRole = GroupRole;
 exports.GroupRoleProps = GroupRoleProps;
 exports.MAX_LEVEL = MAX_LEVEL;
 exports.MAX_SKILL_EXP = MAX_SKILL_EXP;
 exports.MAX_VIRTUAL_LEVEL = MAX_VIRTUAL_LEVEL;
 exports.MEMBER_SKILLS = MEMBER_SKILLS;
+exports.METRICS = METRICS;
+exports.MemberActivityType = MemberActivityType;
 exports.Metric = Metric;
 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.PRIVILEGED_GROUP_ROLES = PRIVILEGED_GROUP_ROLES;
 exports.Period = Period;
 exports.PeriodProps = PeriodProps;
+exports.PlayerAnnotationType = PlayerAnnotationType;
 exports.PlayerBuild = PlayerBuild;
 exports.PlayerBuildProps = PlayerBuildProps;
+exports.PlayerStatus = PlayerStatus;
 exports.PlayerStatusProps = PlayerStatusProps;
 exports.PlayerType = PlayerType;
 exports.PlayerTypeProps = PlayerTypeProps;
 exports.REAL_METRICS = REAL_METRICS;
 exports.REAL_SKILLS = REAL_SKILLS;
+exports.SKILLS = SKILLS;
 exports.SKILL_EXP_AT_99 = SKILL_EXP_AT_99;
+exports.Skill = Skill;
 exports.SkillProps = SkillProps;
 exports.WOMClient = WOMClient;
 exports.findCountry = findCountry;

package/dist/es/index.js

@@ -318,13 +318,13 @@ var CompetitionStatus;
     CompetitionStatus["ONGOING"] = "ongoing";
     CompetitionStatus["FINISHED"] = "finished";
 })(CompetitionStatus || (CompetitionStatus = {}));
-Object.values(CompetitionStatus);
+const COMPETITION_STATUSES = Object.values(CompetitionStatus);
 
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
 };
-Object.values(CompetitionType);
+const COMPETITION_TYPES = Object.values(CompetitionType);
 
 const Country = {
     AD: 'AD',
@@ -580,7 +580,7 @@ const Country = {
     ZM: 'ZM',
     ZW: 'ZW'
 };
-Object.values(Country);
+const COUNTRY_CODES = Object.values(Country);
 
 var EfficiencyAlgorithmType;
 (function (EfficiencyAlgorithmType) {
@@ -866,7 +866,13 @@ const GroupRole = {
     ZEALOT: 'zealot',
     ZENYTE: 'zenyte'
 };
-Object.values(GroupRole);
+const GROUP_ROLES = Object.values(GroupRole);
+
+const MemberActivityType = {
+    JOINED: 'joined',
+    LEFT: 'left',
+    CHANGED_ROLE: 'changed_role'
+};
 
 var MetricMeasure;
 (function (MetricMeasure) {
@@ -1002,11 +1008,11 @@ const ComputedMetric = {
     EHB: 'ehb'
 };
 const Metric = Object.assign(Object.assign(Object.assign(Object.assign({}, Skill), Activity), Boss), ComputedMetric);
-Object.values(Metric);
+const METRICS = Object.values(Metric);
 const SKILLS = Object.values(Skill);
 const BOSSES = Object.values(Boss);
 const ACTIVITIES = Object.values(Activity);
-Object.values(ComputedMetric);
+const COMPUTED_METRICS = Object.values(ComputedMetric);
 
 const NameChangeStatus = {
     PENDING: 'pending',
@@ -1021,7 +1027,15 @@ const Period = {
     MONTH: 'month',
     YEAR: 'year'
 };
-Object.values(Period);
+const PERIODS = Object.values(Period);
+
+const PlayerAnnotationType = {
+    OPT_OUT: 'opt_out',
+    OPT_OUT_GROUPS: 'opt_out_groups',
+    OPT_OUT_COMPETITIONS: 'opt_out_competitions',
+    BLOCKED: 'blocked',
+    FAKE_F2P: 'fake_f2p'
+};
 
 const PlayerBuild = {
     MAIN: 'main',
@@ -1032,7 +1046,7 @@ const PlayerBuild = {
     DEF1: 'def1',
     HP10: 'hp10'
 };
-Object.values(PlayerBuild);
+const PLAYER_BUILDS = Object.values(PlayerBuild);
 
 const PlayerStatus = {
     ACTIVE: 'active',
@@ -1041,6 +1055,7 @@ const PlayerStatus = {
     ARCHIVED: 'archived',
     BANNED: 'banned'
 };
+const PLAYER_STATUSES = Object.values(PlayerStatus);
 
 const PlayerType = {
     UNKNOWN: 'unknown',
@@ -1049,7 +1064,7 @@ const PlayerType = {
     HARDCORE: 'hardcore',
     ULTIMATE: 'ultimate'
 };
-Object.values(PlayerType);
+const PLAYER_TYPES = Object.values(PlayerType);
 
 class EfficiencyClient extends BaseAPIClient {
     /**
@@ -2212,4 +2227,4 @@ function isPlayerType(typeString) {
     return typeString in PlayerTypeProps;
 }
 
-export { ActivityProps, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, Metric, MetricProps, NameChangeStatus, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerBuild, PlayerBuildProps, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILL_EXP_AT_99, SkillProps, WOMClient, findCountry, findCountryByCode, findCountryByName, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill };
+export { ACTIVITIES, Activity, ActivityProps, BOSSES, Boss, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MemberActivityType, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerAnnotationType, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, SkillProps, WOMClient, findCountry, findCountryByCode, findCountryByName, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill };

package/dist/es/index.mjs

@@ -318,13 +318,13 @@ var CompetitionStatus;
     CompetitionStatus["ONGOING"] = "ongoing";
     CompetitionStatus["FINISHED"] = "finished";
 })(CompetitionStatus || (CompetitionStatus = {}));
-Object.values(CompetitionStatus);
+const COMPETITION_STATUSES = Object.values(CompetitionStatus);
 
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
 };
-Object.values(CompetitionType);
+const COMPETITION_TYPES = Object.values(CompetitionType);
 
 const Country = {
     AD: 'AD',
@@ -580,7 +580,7 @@ const Country = {
     ZM: 'ZM',
     ZW: 'ZW'
 };
-Object.values(Country);
+const COUNTRY_CODES = Object.values(Country);
 
 var EfficiencyAlgorithmType;
 (function (EfficiencyAlgorithmType) {
@@ -866,7 +866,13 @@ const GroupRole = {
     ZEALOT: 'zealot',
     ZENYTE: 'zenyte'
 };
-Object.values(GroupRole);
+const GROUP_ROLES = Object.values(GroupRole);
+
+const MemberActivityType = {
+    JOINED: 'joined',
+    LEFT: 'left',
+    CHANGED_ROLE: 'changed_role'
+};
 
 var MetricMeasure;
 (function (MetricMeasure) {
@@ -1002,11 +1008,11 @@ const ComputedMetric = {
     EHB: 'ehb'
 };
 const Metric = Object.assign(Object.assign(Object.assign(Object.assign({}, Skill), Activity), Boss), ComputedMetric);
-Object.values(Metric);
+const METRICS = Object.values(Metric);
 const SKILLS = Object.values(Skill);
 const BOSSES = Object.values(Boss);
 const ACTIVITIES = Object.values(Activity);
-Object.values(ComputedMetric);
+const COMPUTED_METRICS = Object.values(ComputedMetric);
 
 const NameChangeStatus = {
     PENDING: 'pending',
@@ -1021,7 +1027,15 @@ const Period = {
     MONTH: 'month',
     YEAR: 'year'
 };
-Object.values(Period);
+const PERIODS = Object.values(Period);
+
+const PlayerAnnotationType = {
+    OPT_OUT: 'opt_out',
+    OPT_OUT_GROUPS: 'opt_out_groups',
+    OPT_OUT_COMPETITIONS: 'opt_out_competitions',
+    BLOCKED: 'blocked',
+    FAKE_F2P: 'fake_f2p'
+};
 
 const PlayerBuild = {
     MAIN: 'main',
@@ -1032,7 +1046,7 @@ const PlayerBuild = {
     DEF1: 'def1',
     HP10: 'hp10'
 };
-Object.values(PlayerBuild);
+const PLAYER_BUILDS = Object.values(PlayerBuild);
 
 const PlayerStatus = {
     ACTIVE: 'active',
@@ -1041,6 +1055,7 @@ const PlayerStatus = {
     ARCHIVED: 'archived',
     BANNED: 'banned'
 };
+const PLAYER_STATUSES = Object.values(PlayerStatus);
 
 const PlayerType = {
     UNKNOWN: 'unknown',
@@ -1049,7 +1064,7 @@ const PlayerType = {
     HARDCORE: 'hardcore',
     ULTIMATE: 'ultimate'
 };
-Object.values(PlayerType);
+const PLAYER_TYPES = Object.values(PlayerType);
 
 class EfficiencyClient extends BaseAPIClient {
     /**
@@ -2212,4 +2227,4 @@ function isPlayerType(typeString) {
     return typeString in PlayerTypeProps;
 }
 
-export { ActivityProps, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, Metric, MetricProps, NameChangeStatus, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerBuild, PlayerBuildProps, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILL_EXP_AT_99, SkillProps, WOMClient, findCountry, findCountryByCode, findCountryByName, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill };
+export { ACTIVITIES, Activity, ActivityProps, BOSSES, Boss, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MemberActivityType, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerAnnotationType, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, SkillProps, WOMClient, findCountry, findCountryByCode, findCountryByName, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill };

package/dist/index.d.ts

@@ -246,6 +246,245 @@ declare const Metric: {
     readonly CONSTRUCTION: "construction";
 };
 type Metric = (typeof Metric)[keyof typeof Metric];
+declare const METRICS: Metric[];
+declare const SKILLS: Skill[];
+declare const BOSSES: Boss[];
+declare const ACTIVITIES: Activity[];
+declare const COMPUTED_METRICS: ComputedMetric[];
+
+interface Snapshot {
+    id: number;
+    playerId: number;
+    importedAt: Date | null;
+    createdAt: Date;
+    overallRank: number;
+    overallExperience: number;
+    attackRank: number;
+    attackExperience: number;
+    defenceRank: number;
+    defenceExperience: number;
+    strengthRank: number;
+    strengthExperience: number;
+    hitpointsRank: number;
+    hitpointsExperience: number;
+    rangedRank: number;
+    rangedExperience: number;
+    prayerRank: number;
+    prayerExperience: number;
+    magicRank: number;
+    magicExperience: number;
+    cookingRank: number;
+    cookingExperience: number;
+    woodcuttingRank: number;
+    woodcuttingExperience: number;
+    fletchingRank: number;
+    fletchingExperience: number;
+    fishingRank: number;
+    fishingExperience: number;
+    firemakingRank: number;
+    firemakingExperience: number;
+    craftingRank: number;
+    craftingExperience: number;
+    smithingRank: number;
+    smithingExperience: number;
+    miningRank: number;
+    miningExperience: number;
+    herbloreRank: number;
+    herbloreExperience: number;
+    agilityRank: number;
+    agilityExperience: number;
+    thievingRank: number;
+    thievingExperience: number;
+    slayerRank: number;
+    slayerExperience: number;
+    farmingRank: number;
+    farmingExperience: number;
+    runecraftingRank: number;
+    runecraftingExperience: number;
+    hunterRank: number;
+    hunterExperience: number;
+    constructionRank: number;
+    constructionExperience: number;
+    league_pointsRank: number;
+    league_pointsScore: number;
+    bounty_hunter_hunterRank: number;
+    bounty_hunter_hunterScore: number;
+    bounty_hunter_rogueRank: number;
+    bounty_hunter_rogueScore: number;
+    clue_scrolls_allRank: number;
+    clue_scrolls_allScore: number;
+    clue_scrolls_beginnerRank: number;
+    clue_scrolls_beginnerScore: number;
+    clue_scrolls_easyRank: number;
+    clue_scrolls_easyScore: number;
+    clue_scrolls_mediumRank: number;
+    clue_scrolls_mediumScore: number;
+    clue_scrolls_hardRank: number;
+    clue_scrolls_hardScore: number;
+    clue_scrolls_eliteRank: number;
+    clue_scrolls_eliteScore: number;
+    clue_scrolls_masterRank: number;
+    clue_scrolls_masterScore: number;
+    last_man_standingRank: number;
+    last_man_standingScore: number;
+    pvp_arenaRank: number;
+    pvp_arenaScore: number;
+    soul_wars_zealRank: number;
+    soul_wars_zealScore: number;
+    guardians_of_the_riftRank: number;
+    guardians_of_the_riftScore: number;
+    colosseum_gloryRank: number;
+    colosseum_gloryScore: number;
+    collections_loggedRank: number;
+    collections_loggedScore: number;
+    abyssal_sireRank: number;
+    abyssal_sireKills: number;
+    alchemical_hydraRank: number;
+    alchemical_hydraKills: number;
+    amoxliatlRank: number;
+    amoxliatlKills: number;
+    araxxorRank: number;
+    araxxorKills: number;
+    artioRank: number;
+    artioKills: number;
+    barrows_chestsRank: number;
+    barrows_chestsKills: number;
+    bryophytaRank: number;
+    bryophytaKills: number;
+    cerberusRank: number;
+    cerberusKills: number;
+    callistoRank: number;
+    callistoKills: number;
+    calvarionRank: number;
+    calvarionKills: number;
+    chambers_of_xericRank: number;
+    chambers_of_xericKills: number;
+    chambers_of_xeric_challenge_modeRank: number;
+    chambers_of_xeric_challenge_modeKills: number;
+    chaos_elementalRank: number;
+    chaos_elementalKills: number;
+    chaos_fanaticRank: number;
+    chaos_fanaticKills: number;
+    commander_zilyanaRank: number;
+    commander_zilyanaKills: number;
+    corporeal_beastRank: number;
+    corporeal_beastKills: number;
+    crazy_archaeologistRank: number;
+    crazy_archaeologistKills: number;
+    dagannoth_primeRank: number;
+    dagannoth_primeKills: number;
+    dagannoth_rexRank: number;
+    dagannoth_rexKills: number;
+    dagannoth_supremeRank: number;
+    dagannoth_supremeKills: number;
+    deranged_archaeologistRank: number;
+    deranged_archaeologistKills: number;
+    doom_of_mokhaiotlRank: number;
+    doom_of_mokhaiotlKills: number;
+    duke_sucellusRank: number;
+    duke_sucellusKills: number;
+    general_graardorRank: number;
+    general_graardorKills: number;
+    giant_moleRank: number;
+    giant_moleKills: number;
+    grotesque_guardiansRank: number;
+    grotesque_guardiansKills: number;
+    hesporiRank: number;
+    hesporiKills: number;
+    kalphite_queenRank: number;
+    kalphite_queenKills: number;
+    king_black_dragonRank: number;
+    king_black_dragonKills: number;
+    krakenRank: number;
+    krakenKills: number;
+    kreearraRank: number;
+    kreearraKills: number;
+    kril_tsutsarothRank: number;
+    kril_tsutsarothKills: number;
+    lunar_chestsRank: number;
+    lunar_chestsKills: number;
+    mimicRank: number;
+    mimicKills: number;
+    nexRank: number;
+    nexKills: number;
+    nightmareRank: number;
+    nightmareKills: number;
+    phosanis_nightmareRank: number;
+    phosanis_nightmareKills: number;
+    oborRank: number;
+    oborKills: number;
+    phantom_muspahRank: number;
+    phantom_muspahKills: number;
+    sarachnisRank: number;
+    sarachnisKills: number;
+    scorpiaRank: number;
+    scorpiaKills: number;
+    scurriusRank: number;
+    scurriusKills: number;
+    skotizoRank: number;
+    skotizoKills: number;
+    sol_hereditRank: number;
+    sol_hereditKills: number;
+    spindelRank: number;
+    spindelKills: number;
+    temporossRank: number;
+    temporossKills: number;
+    the_gauntletRank: number;
+    the_gauntletKills: number;
+    the_corrupted_gauntletRank: number;
+    the_corrupted_gauntletKills: number;
+    the_hueycoatlRank: number;
+    the_hueycoatlKills: number;
+    the_leviathanRank: number;
+    the_leviathanKills: number;
+    the_royal_titansRank: number;
+    the_royal_titansKills: number;
+    the_whispererRank: number;
+    the_whispererKills: number;
+    theatre_of_bloodRank: number;
+    theatre_of_bloodKills: number;
+    theatre_of_blood_hard_modeRank: number;
+    theatre_of_blood_hard_modeKills: number;
+    thermonuclear_smoke_devilRank: number;
+    thermonuclear_smoke_devilKills: number;
+    tombs_of_amascutRank: number;
+    tombs_of_amascutKills: number;
+    tombs_of_amascut_expertRank: number;
+    tombs_of_amascut_expertKills: number;
+    tzkal_zukRank: number;
+    tzkal_zukKills: number;
+    tztok_jadRank: number;
+    tztok_jadKills: number;
+    vardorvisRank: number;
+    vardorvisKills: number;
+    venenatisRank: number;
+    venenatisKills: number;
+    vetionRank: number;
+    vetionKills: number;
+    vorkathRank: number;
+    vorkathKills: number;
+    wintertodtRank: number;
+    wintertodtKills: number;
+    yamaRank: number;
+    yamaKills: number;
+    zalcanoRank: number;
+    zalcanoKills: number;
+    zulrahRank: number;
+    zulrahKills: number;
+    ehpRank: number;
+    ehpValue: number;
+    ehbRank: number;
+    ehbValue: number;
+}
+
+interface AchievementDefinition {
+    name: string;
+    metric: Metric;
+    measure: string;
+    threshold: number;
+    validate: (snapshot: Snapshot) => boolean;
+    getCurrentValue: (snapshot: Snapshot) => number;
+}
 
 declare enum MetricMeasure {
     EXPERIENCE = "experience",
@@ -281,6 +520,7 @@ declare enum CompetitionStatus {
     ONGOING = "ongoing",
     FINISHED = "finished"
 }
+declare const COMPETITION_STATUSES: CompetitionStatus[];
 
 interface CompetitionTeam {
     name: string;
@@ -292,6 +532,7 @@ declare const CompetitionType: {
     readonly TEAM: "team";
 };
 type CompetitionType = (typeof CompetitionType)[keyof typeof CompetitionType];
+declare const COMPETITION_TYPES: CompetitionType[];
 
 interface Competition {
     id: number;
@@ -564,6 +805,7 @@ declare const Country: {
     readonly ZW: "ZW";
 };
 type Country = (typeof Country)[keyof typeof Country];
+declare const COUNTRY_CODES: Country[];
 
 declare const Period: {
     readonly FIVE_MIN: "five_min";
@@ -573,6 +815,124 @@ declare const Period: {
     readonly YEAR: "year";
 };
 type Period = (typeof Period)[keyof typeof Period];
+declare const PERIODS: ("five_min" | "day" | "week" | "month" | "year")[];
+
+interface Delta {
+    playerId: number;
+    period: Period;
+    startedAt: Date;
+    endedAt: Date;
+    updatedAt: Date | null;
+    overall: number;
+    attack: number;
+    defence: number;
+    strength: number;
+    hitpoints: number;
+    ranged: number;
+    prayer: number;
+    magic: number;
+    cooking: number;
+    woodcutting: number;
+    fletching: number;
+    fishing: number;
+    firemaking: number;
+    crafting: number;
+    smithing: number;
+    mining: number;
+    herblore: number;
+    agility: number;
+    thieving: number;
+    slayer: number;
+    farming: number;
+    runecrafting: number;
+    hunter: number;
+    construction: number;
+    abyssal_sire: number;
+    alchemical_hydra: number;
+    amoxliatl: number;
+    araxxor: number;
+    artio: number;
+    barrows_chests: number;
+    bryophyta: number;
+    callisto: number;
+    calvarion: number;
+    cerberus: number;
+    chambers_of_xeric: number;
+    chambers_of_xeric_challenge_mode: number;
+    chaos_elemental: number;
+    chaos_fanatic: number;
+    commander_zilyana: number;
+    corporeal_beast: number;
+    crazy_archaeologist: number;
+    dagannoth_prime: number;
+    dagannoth_rex: number;
+    dagannoth_supreme: number;
+    deranged_archaeologist: number;
+    doom_of_mokhaiotl: number;
+    duke_sucellus: number;
+    general_graardor: number;
+    giant_mole: number;
+    grotesque_guardians: number;
+    hespori: number;
+    kalphite_queen: number;
+    king_black_dragon: number;
+    kraken: number;
+    kreearra: number;
+    kril_tsutsaroth: number;
+    lunar_chests: number;
+    mimic: number;
+    nex: number;
+    nightmare: number;
+    phosanis_nightmare: number;
+    obor: number;
+    phantom_muspah: number;
+    sarachnis: number;
+    scorpia: number;
+    scurrius: number;
+    skotizo: number;
+    sol_heredit: number;
+    spindel: number;
+    tempoross: number;
+    the_gauntlet: number;
+    the_corrupted_gauntlet: number;
+    the_hueycoatl: number;
+    the_leviathan: number;
+    the_royal_titans: number;
+    the_whisperer: number;
+    theatre_of_blood: number;
+    theatre_of_blood_hard_mode: number;
+    thermonuclear_smoke_devil: number;
+    tombs_of_amascut: number;
+    tombs_of_amascut_expert: number;
+    tzkal_zuk: number;
+    tztok_jad: number;
+    vardorvis: number;
+    venenatis: number;
+    vetion: number;
+    vorkath: number;
+    wintertodt: number;
+    yama: number;
+    zalcano: number;
+    zulrah: number;
+    league_points: number;
+    bounty_hunter_hunter: number;
+    bounty_hunter_rogue: number;
+    clue_scrolls_all: number;
+    clue_scrolls_beginner: number;
+    clue_scrolls_easy: number;
+    clue_scrolls_medium: number;
+    clue_scrolls_hard: number;
+    clue_scrolls_elite: number;
+    clue_scrolls_master: number;
+    last_man_standing: number;
+    pvp_arena: number;
+    soul_wars_zeal: number;
+    guardians_of_the_rift: number;
+    colosseum_glory: number;
+    collections_logged: number;
+    ehp: number;
+    ehb: number;
+}
 
 declare enum EfficiencyAlgorithmType {
     MAIN = "main",
@@ -858,6 +1218,7 @@ declare const GroupRole: {
     readonly ZENYTE: "zenyte";
 };
 type GroupRole = (typeof GroupRole)[keyof typeof GroupRole];
+declare const GROUP_ROLES: GroupRole[];
 
 interface GroupRoleOrder {
     groupId: number;
@@ -987,6 +1348,17 @@ interface Participation {
     updatedAt: Date;
 }
 
+interface Patron {
+    id: string;
+    name: string;
+    email: string;
+    discordId: string | null;
+    groupId: number | null;
+    playerId: number | null;
+    tier: number;
+    createdAt: Date;
+}
+
 declare const PlayerAnnotationType: {
     readonly OPT_OUT: "opt_out";
     readonly OPT_OUT_GROUPS: "opt_out_groups";
@@ -1021,6 +1393,7 @@ declare const PlayerBuild: {
     readonly HP10: "hp10";
 };
 type PlayerBuild = (typeof PlayerBuild)[keyof typeof PlayerBuild];
+declare const PLAYER_BUILDS: PlayerBuild[];
 
 declare const PlayerStatus: {
     readonly ACTIVE: "active";
@@ -1030,6 +1403,7 @@ declare const PlayerStatus: {
     readonly BANNED: "banned";
 };
 type PlayerStatus = (typeof PlayerStatus)[keyof typeof PlayerStatus];
+declare const PLAYER_STATUSES: PlayerStatus[];
 
 declare const PlayerType: {
     readonly UNKNOWN: "unknown";
@@ -1039,6 +1413,7 @@ declare const PlayerType: {
     readonly ULTIMATE: "ultimate";
 };
 type PlayerType = (typeof PlayerType)[keyof typeof PlayerType];
+declare const PLAYER_TYPES: PlayerType[];
 
 interface Player {
     id: number;
@@ -1725,9 +2100,9 @@ declare class GroupsClient extends BaseAPIClient {
      * Fetches a group members' latest name changes.
      * @returns A list of name change (approved) requests.
      */
-    getGroupNameChanges(id: number, pagination?: PaginationOptions): Promise<NameChange & {
+    getGroupNameChanges(id: number, pagination?: PaginationOptions): Promise<(NameChange & {
         player: PlayerResponse;
-    }>;
+    })[]>;
     /**
      * Fetches a group's general statistics.
      * @returns An object with a few statistic values and an average stats snapshot.
@@ -1823,7 +2198,7 @@ declare class PlayersClient extends BaseAPIClient {
      * @returns A list of memberships, with the respective group included.
      */
     getPlayerGroups(username: string, pagination?: PaginationOptions): Promise<(Membership & {
-        player: PlayerResponse;
+        group: GroupResponse;
     })[]>;
     /**
      * Fetches a player's gains, for a specific period or time range, as a [metric: data] map.
@@ -3553,4 +3928,4 @@ declare const PlayerTypeProps: Record<PlayerType, {
 }>;
 declare function isPlayerType(typeString: string): typeString is PlayerType;
 
-export { type AchievementProgressResponse, type AchievementResponse, ActivityProps, type BossMetaConfig, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, CompetitionCSVTableType, type CompetitionDetailsResponse, type CompetitionResponse, CompetitionStatus, CompetitionStatusProps, type CompetitionTeam, CompetitionType, CompetitionTypeProps, ComputedMetricProps, Country, CountryProps, type CreateCompetitionPayload, type CreateGroupPayload, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, F2P_BOSSES, type GenericCountMessageResponse, type GenericMessageResponse, type GroupDetailsResponse, type GroupHiscoresEntryResponse, type GroupResponse, GroupRole, GroupRoleProps, type GroupStatisticsResponse, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, type MemberActivityResponse, type MembershipResponse, Metric, type MetricDelta, MetricProps, type NameChangeResponse, NameChangeStatus, PRIVILEGED_GROUP_ROLES, type ParticipantHistoryResponse, type ParticipationResponse, Period, PeriodProps, type PlayerArchiveResponse, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingResponse, type PlayerDeltasMapResponse, type PlayerDetailsResponse, type PlayerResponse, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type RecordResponse, SKILL_EXP_AT_99, type SkillMetaConfig, SkillProps, type SnapshotResponse, type TimeRangeFilter, WOMClient, findCountry, findCountryByCode, findCountryByName, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill };
+export { ACTIVITIES, type Achievement, type AchievementDefinition, type AchievementMeasure, type AchievementProgressResponse, type AchievementResponse, Activity, ActivityProps, BOSSES, Boss, type BossMetaConfig, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, type Competition, CompetitionCSVTableType, type CompetitionDetailsResponse, type CompetitionResponse, CompetitionStatus, CompetitionStatusProps, type CompetitionTeam, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, type CreateCompetitionPayload, type CreateGroupPayload, type Delta, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, type GenericCountMessageResponse, type GenericMessageResponse, type Group, type GroupDetailsResponse, type GroupHiscoresEntryResponse, type GroupResponse, GroupRole, type GroupRoleOrder, GroupRoleProps, type GroupSocialLinks, type GroupStatisticsResponse, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, type MemberActivity, type MemberActivityResponse, MemberActivityType, type Membership, type MembershipResponse, Metric, type MetricDelta, MetricMeasure, MetricProps, MetricType, type NameChange, type NameChangeDenyContext, type NameChangeResponse, type NameChangeReviewContext, type NameChangeSkipContext, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, type ParticipantHistoryResponse, type Participation, type ParticipationResponse, type Patron, Period, PeriodProps, type Player, type PlayerAnnotation, PlayerAnnotationType, type PlayerArchive, type PlayerArchiveResponse, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingResponse, type PlayerDeltasMapResponse, type PlayerDetailsResponse, type PlayerResponse, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type Record$1 as Record, type RecordResponse, SKILLS, SKILL_EXP_AT_99, Skill, type SkillMetaBonus, type SkillMetaConfig, type SkillMetaMethod, SkillProps, type Snapshot, type SnapshotResponse, type TimeRangeFilter, WOMClient, findCountry, findCountryByCode, findCountryByName, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill };

package/package.json

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