@wise-old-man/utils 3.3.0 → 3.3.2

package/dist/cjs/index.cjs

@@ -423,13 +423,6 @@ class PlayersClient extends BaseAPIClient {
     getPlayerGains(username, options) {
         return this.getRequest(`/players/${username}/gained`, options);
     }
-    /**
-     * Fetches a player's gains, for a specific period or time range, as an array.
-     * @returns An array of each metric's gained data.
-     */
-    getPlayerGainsAsArray(username, options) {
-        return this.getRequest(`/players/${username}/gained`, Object.assign(Object.assign({}, options), { formatting: 'array' }));
-    }
     /**
      * Fetches all of the player's records.
      * @returns A list of records.
@@ -1017,6 +1010,9 @@ const Country = {
     FR: 'FR',
     GA: 'GA',
     GB: 'GB',
+    GB_NIR: 'GB_NIR',
+    GB_SCT: 'GB_SCT',
+    GB_WLS: 'GB_WLS',
     GD: 'GD',
     GE: 'GE',
     GF: 'GF',
@@ -1304,6 +1300,9 @@ const CountryProps = {
     [Country.FR]: { code: 'FR', name: 'France' },
     [Country.GA]: { code: 'GA', name: 'Gabon' },
     [Country.GB]: { code: 'GB', name: 'United Kingdom' },
+    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northen Ireland' },
+    [Country.GB_SCT]: { code: 'GB_SCT', name: 'Scotland' },
+    [Country.GB_WLS]: { code: 'GB_WLS', name: 'Wales' },
     [Country.GD]: { code: 'GD', name: 'Grenada' },
     [Country.GE]: { code: 'GE', name: 'Georgia' },
     [Country.GF]: { code: 'GF', name: 'French Guiana' },
@@ -2047,256 +2046,6 @@ function getParentEfficiencyMetric(metric) {
         return Metric.EHP;
     return null;
 }
-function parseMetricAbbreviation(abbreviation) {
-    if (!abbreviation || abbreviation.length === 0) {
-        return null;
-    }
-    const fixedAbbreviation = abbreviation.toLowerCase();
-    if (isMetric(fixedAbbreviation)) {
-        return fixedAbbreviation;
-    }
-    switch (fixedAbbreviation) {
-        // Bosses
-        case 'sire':
-            return Metric.ABYSSAL_SIRE;
-        case 'hydra':
-            return Metric.ALCHEMICAL_HYDRA;
-        case 'barrows':
-            return Metric.BARROWS_CHESTS;
-        case 'bryo':
-            return Metric.BRYOPHYTA;
-        case 'cerb':
-            return Metric.CERBERUS;
-        case 'cox':
-        case 'xeric':
-        case 'chambers':
-        case 'olm':
-        case 'raids':
-            return Metric.CHAMBERS_OF_XERIC;
-        case 'cox-cm':
-        case 'xeric-cm':
-        case 'chambers-cm':
-        case 'olm-cm':
-        case 'raids-cm':
-            return Metric.CHAMBERS_OF_XERIC_CM;
-        case 'chaos-ele':
-            return Metric.CHAOS_ELEMENTAL;
-        case 'fanatic':
-            return Metric.CHAOS_FANATIC;
-        case 'sara':
-        case 'saradomin':
-        case 'zilyana':
-        case 'zily':
-            return Metric.COMMANDER_ZILYANA;
-        case 'corp':
-            return Metric.CORPOREAL_BEAST;
-        case 'crazy-arch':
-            return Metric.CRAZY_ARCHAEOLOGIST;
-        case 'prime':
-            return Metric.DAGANNOTH_PRIME;
-        case 'rex':
-            return Metric.DAGANNOTH_REX;
-        case 'supreme':
-            return Metric.DAGANNOTH_SUPREME;
-        case 'deranged-arch':
-            return Metric.DERANGED_ARCHAEOLOGIST;
-        case 'bandos':
-        case 'graardor':
-            return Metric.GENERAL_GRAARDOR;
-        case 'mole':
-            return Metric.GIANT_MOLE;
-        case 'dusk':
-        case 'dawn':
-        case 'gargs':
-        case 'guardians':
-        case 'ggs':
-            return Metric.GROTESQUE_GUARDIANS;
-        case 'phantom':
-        case 'muspah':
-            return Metric.PHANTOM_MUSPAH;
-        case 'kq':
-            return Metric.KALPHITE_QUEEN;
-        case 'kbd':
-            return Metric.KING_BLACK_DRAGON;
-        case 'kree':
-        case 'kreearra':
-        case 'armadyl':
-        case 'arma':
-            return Metric.KREEARRA;
-        case 'zammy':
-        case 'zamorak':
-        case 'kril':
-        case 'kril-tsutsaroth':
-            return Metric.KRIL_TSUTSAROTH;
-        case 'gaunt':
-        case 'gauntlet':
-        case 'the-gauntlet':
-            return Metric.THE_GAUNTLET;
-        case 'cgaunt':
-        case 'cgauntlet':
-        case 'corrupted':
-        case 'corrupted-gauntlet':
-        case 'the-corrupted-gauntlet':
-            return Metric.THE_CORRUPTED_GAUNTLET;
-        case 'tob':
-        case 'theatre':
-        case 'verzik':
-        case 'tob-normal':
-            return Metric.THEATRE_OF_BLOOD;
-        case 'tob-hm':
-        case 'tob-cm':
-        case 'tob-hard-mode':
-        case 'tob-hard':
-            return Metric.THEATRE_OF_BLOOD_HARD_MODE;
-        case 'toa':
-        case 'tombs':
-        case 'amascut':
-            return Metric.TOMBS_OF_AMASCUT;
-        case 'toa-expert':
-        case 'toa-hm':
-        case 'tombs-expert':
-        case 'tombs-hm':
-        case 'amascut-expert':
-        case 'amascut-hm':
-            return Metric.TOMBS_OF_AMASCUT_EXPERT;
-        case 'nm':
-        case 'tnm':
-        case 'nmare':
-        case 'the-nightmare':
-            return Metric.NIGHTMARE;
-        case 'pnm':
-        case 'phosani':
-        case 'phosanis':
-        case 'phosani-nm':
-        case 'phosani-nightmare':
-        case 'phosanis nightmare':
-            return Metric.PHOSANIS_NIGHTMARE;
-        case 'thermy':
-        case 'smoke-devil':
-            return Metric.THERMONUCLEAR_SMOKE_DEVIL;
-        case 'zuk':
-        case 'inferno':
-            return Metric.TZKAL_ZUK;
-        case 'jad':
-        case 'fight-caves':
-        case 'fc':
-            return Metric.TZTOK_JAD;
-        case 'vork':
-        case 'vorky':
-            return Metric.VORKATH;
-        case 'wt':
-            return Metric.WINTERTODT;
-        case 'snek':
-        case 'zul':
-            return Metric.ZULRAH;
-        // Minigames and others
-        case 'all-clues':
-        case 'clues':
-            return Metric.CLUE_SCROLLS_ALL;
-        case 'beginner':
-        case 'beginner-clues':
-        case 'beg-clues':
-        case 'beginners':
-            return Metric.CLUE_SCROLLS_BEGINNER;
-        case 'easy':
-        case 'easy-clues':
-        case 'easies':
-            return Metric.CLUE_SCROLLS_EASY;
-        case 'medium':
-        case 'med':
-        case 'meds':
-        case 'medium-clues':
-        case 'med-clues':
-        case 'mediums':
-            return Metric.CLUE_SCROLLS_MEDIUM;
-        case 'hard':
-        case 'hard-clues':
-        case 'hards':
-            return Metric.CLUE_SCROLLS_HARD;
-        case 'elite':
-        case 'elite-clues':
-        case 'elites':
-            return Metric.CLUE_SCROLLS_ELITE;
-        case 'master':
-        case 'master-clues':
-        case 'masters':
-            return Metric.CLUE_SCROLLS_MASTER;
-        case 'lms':
-            return Metric.LAST_MAN_STANDING;
-        case 'league':
-        case 'lp':
-        case 'lps':
-            return Metric.LEAGUE_POINTS;
-        case 'sw':
-        case 'zeal':
-        case 'soul-wars':
-            return Metric.SOUL_WARS_ZEAL;
-        case 'rifts-closed':
-        case 'gotr':
-        case 'rifts':
-            return Metric.GUARDIANS_OF_THE_RIFT;
-        // Skills
-        case 'runecraft':
-        case 'rc':
-            return Metric.RUNECRAFTING;
-        case 'att':
-        case 'atk':
-        case 'attk':
-            return Metric.ATTACK;
-        case 'def':
-        case 'defense':
-            return Metric.DEFENCE;
-        case 'str':
-            return Metric.STRENGTH;
-        case 'hp':
-            return Metric.HITPOINTS;
-        case 'range':
-            return Metric.RANGED;
-        case 'pray':
-            return Metric.PRAYER;
-        case 'mage':
-            return Metric.MAGIC;
-        case 'cook':
-            return Metric.COOKING;
-        case 'wc':
-            return Metric.WOODCUTTING;
-        case 'fletch':
-            return Metric.FLETCHING;
-        case 'fish':
-            return Metric.FISHING;
-        case 'fm':
-        case 'burning':
-            return Metric.FIREMAKING;
-        case 'craft':
-            return Metric.CRAFTING;
-        case 'sm':
-        case 'smith':
-            return Metric.SMITHING;
-        case 'mine':
-        case 'smash':
-            return Metric.MINING;
-        case 'herb':
-            return Metric.HERBLORE;
-        case 'agi':
-        case 'agil':
-            return Metric.AGILITY;
-        case 'thief':
-            return Metric.THIEVING;
-        case 'slay':
-            return Metric.SLAYER;
-        case 'farm':
-            return Metric.FARMING;
-        case 'hunt':
-        case 'hunting':
-            return Metric.HUNTER;
-        case 'con':
-        case 'cons':
-        case 'const':
-            return Metric.CONSTRUCTION;
-        default:
-            return null;
-    }
-}
 
 const CUSTOM_PERIOD_REGEX = /(\d+y)?(\d+m)?(\d+w)?(\d+d)?(\d+h)?/;
 const PeriodProps = {
@@ -2449,12 +2198,6 @@ exports.EfficiencyAlgorithmType = void 0;
     EfficiencyAlgorithmType["F2P_LVL3_IRONMAN"] = "f2p_lvl3_ironman";
 })(exports.EfficiencyAlgorithmType || (exports.EfficiencyAlgorithmType = {}));
 
-exports.MigrationDataSource = void 0;
-(function (MigrationDataSource) {
-    MigrationDataSource[MigrationDataSource["TEMPLE_OSRS"] = 0] = "TEMPLE_OSRS";
-    MigrationDataSource[MigrationDataSource["CRYSTAL_MATH_LABS"] = 1] = "CRYSTAL_MATH_LABS";
-})(exports.MigrationDataSource || (exports.MigrationDataSource = {}));
-
 class EfficiencyClient extends BaseAPIClient {
     /**
      * Fetches the current efficiency leaderboard for a specific efficiency metric, playerType, playerBuild and country.
@@ -2706,6 +2449,5 @@ exports.isPlayerStatus = isPlayerStatus;
 exports.isPlayerType = isPlayerType;
 exports.isSkill = isSkill;
 exports.padNumber = padNumber;
-exports.parseMetricAbbreviation = parseMetricAbbreviation;
 exports.parsePeriodExpression = parsePeriodExpression;
 exports.round = round;

package/dist/es/index.js

@@ -421,13 +421,6 @@ class PlayersClient extends BaseAPIClient {
     getPlayerGains(username, options) {
         return this.getRequest(`/players/${username}/gained`, options);
     }
-    /**
-     * Fetches a player's gains, for a specific period or time range, as an array.
-     * @returns An array of each metric's gained data.
-     */
-    getPlayerGainsAsArray(username, options) {
-        return this.getRequest(`/players/${username}/gained`, Object.assign(Object.assign({}, options), { formatting: 'array' }));
-    }
     /**
      * Fetches all of the player's records.
      * @returns A list of records.
@@ -1015,6 +1008,9 @@ const Country = {
     FR: 'FR',
     GA: 'GA',
     GB: 'GB',
+    GB_NIR: 'GB_NIR',
+    GB_SCT: 'GB_SCT',
+    GB_WLS: 'GB_WLS',
     GD: 'GD',
     GE: 'GE',
     GF: 'GF',
@@ -1302,6 +1298,9 @@ const CountryProps = {
     [Country.FR]: { code: 'FR', name: 'France' },
     [Country.GA]: { code: 'GA', name: 'Gabon' },
     [Country.GB]: { code: 'GB', name: 'United Kingdom' },
+    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northen Ireland' },
+    [Country.GB_SCT]: { code: 'GB_SCT', name: 'Scotland' },
+    [Country.GB_WLS]: { code: 'GB_WLS', name: 'Wales' },
     [Country.GD]: { code: 'GD', name: 'Grenada' },
     [Country.GE]: { code: 'GE', name: 'Georgia' },
     [Country.GF]: { code: 'GF', name: 'French Guiana' },
@@ -2045,256 +2044,6 @@ function getParentEfficiencyMetric(metric) {
         return Metric.EHP;
     return null;
 }
-function parseMetricAbbreviation(abbreviation) {
-    if (!abbreviation || abbreviation.length === 0) {
-        return null;
-    }
-    const fixedAbbreviation = abbreviation.toLowerCase();
-    if (isMetric(fixedAbbreviation)) {
-        return fixedAbbreviation;
-    }
-    switch (fixedAbbreviation) {
-        // Bosses
-        case 'sire':
-            return Metric.ABYSSAL_SIRE;
-        case 'hydra':
-            return Metric.ALCHEMICAL_HYDRA;
-        case 'barrows':
-            return Metric.BARROWS_CHESTS;
-        case 'bryo':
-            return Metric.BRYOPHYTA;
-        case 'cerb':
-            return Metric.CERBERUS;
-        case 'cox':
-        case 'xeric':
-        case 'chambers':
-        case 'olm':
-        case 'raids':
-            return Metric.CHAMBERS_OF_XERIC;
-        case 'cox-cm':
-        case 'xeric-cm':
-        case 'chambers-cm':
-        case 'olm-cm':
-        case 'raids-cm':
-            return Metric.CHAMBERS_OF_XERIC_CM;
-        case 'chaos-ele':
-            return Metric.CHAOS_ELEMENTAL;
-        case 'fanatic':
-            return Metric.CHAOS_FANATIC;
-        case 'sara':
-        case 'saradomin':
-        case 'zilyana':
-        case 'zily':
-            return Metric.COMMANDER_ZILYANA;
-        case 'corp':
-            return Metric.CORPOREAL_BEAST;
-        case 'crazy-arch':
-            return Metric.CRAZY_ARCHAEOLOGIST;
-        case 'prime':
-            return Metric.DAGANNOTH_PRIME;
-        case 'rex':
-            return Metric.DAGANNOTH_REX;
-        case 'supreme':
-            return Metric.DAGANNOTH_SUPREME;
-        case 'deranged-arch':
-            return Metric.DERANGED_ARCHAEOLOGIST;
-        case 'bandos':
-        case 'graardor':
-            return Metric.GENERAL_GRAARDOR;
-        case 'mole':
-            return Metric.GIANT_MOLE;
-        case 'dusk':
-        case 'dawn':
-        case 'gargs':
-        case 'guardians':
-        case 'ggs':
-            return Metric.GROTESQUE_GUARDIANS;
-        case 'phantom':
-        case 'muspah':
-            return Metric.PHANTOM_MUSPAH;
-        case 'kq':
-            return Metric.KALPHITE_QUEEN;
-        case 'kbd':
-            return Metric.KING_BLACK_DRAGON;
-        case 'kree':
-        case 'kreearra':
-        case 'armadyl':
-        case 'arma':
-            return Metric.KREEARRA;
-        case 'zammy':
-        case 'zamorak':
-        case 'kril':
-        case 'kril-tsutsaroth':
-            return Metric.KRIL_TSUTSAROTH;
-        case 'gaunt':
-        case 'gauntlet':
-        case 'the-gauntlet':
-            return Metric.THE_GAUNTLET;
-        case 'cgaunt':
-        case 'cgauntlet':
-        case 'corrupted':
-        case 'corrupted-gauntlet':
-        case 'the-corrupted-gauntlet':
-            return Metric.THE_CORRUPTED_GAUNTLET;
-        case 'tob':
-        case 'theatre':
-        case 'verzik':
-        case 'tob-normal':
-            return Metric.THEATRE_OF_BLOOD;
-        case 'tob-hm':
-        case 'tob-cm':
-        case 'tob-hard-mode':
-        case 'tob-hard':
-            return Metric.THEATRE_OF_BLOOD_HARD_MODE;
-        case 'toa':
-        case 'tombs':
-        case 'amascut':
-            return Metric.TOMBS_OF_AMASCUT;
-        case 'toa-expert':
-        case 'toa-hm':
-        case 'tombs-expert':
-        case 'tombs-hm':
-        case 'amascut-expert':
-        case 'amascut-hm':
-            return Metric.TOMBS_OF_AMASCUT_EXPERT;
-        case 'nm':
-        case 'tnm':
-        case 'nmare':
-        case 'the-nightmare':
-            return Metric.NIGHTMARE;
-        case 'pnm':
-        case 'phosani':
-        case 'phosanis':
-        case 'phosani-nm':
-        case 'phosani-nightmare':
-        case 'phosanis nightmare':
-            return Metric.PHOSANIS_NIGHTMARE;
-        case 'thermy':
-        case 'smoke-devil':
-            return Metric.THERMONUCLEAR_SMOKE_DEVIL;
-        case 'zuk':
-        case 'inferno':
-            return Metric.TZKAL_ZUK;
-        case 'jad':
-        case 'fight-caves':
-        case 'fc':
-            return Metric.TZTOK_JAD;
-        case 'vork':
-        case 'vorky':
-            return Metric.VORKATH;
-        case 'wt':
-            return Metric.WINTERTODT;
-        case 'snek':
-        case 'zul':
-            return Metric.ZULRAH;
-        // Minigames and others
-        case 'all-clues':
-        case 'clues':
-            return Metric.CLUE_SCROLLS_ALL;
-        case 'beginner':
-        case 'beginner-clues':
-        case 'beg-clues':
-        case 'beginners':
-            return Metric.CLUE_SCROLLS_BEGINNER;
-        case 'easy':
-        case 'easy-clues':
-        case 'easies':
-            return Metric.CLUE_SCROLLS_EASY;
-        case 'medium':
-        case 'med':
-        case 'meds':
-        case 'medium-clues':
-        case 'med-clues':
-        case 'mediums':
-            return Metric.CLUE_SCROLLS_MEDIUM;
-        case 'hard':
-        case 'hard-clues':
-        case 'hards':
-            return Metric.CLUE_SCROLLS_HARD;
-        case 'elite':
-        case 'elite-clues':
-        case 'elites':
-            return Metric.CLUE_SCROLLS_ELITE;
-        case 'master':
-        case 'master-clues':
-        case 'masters':
-            return Metric.CLUE_SCROLLS_MASTER;
-        case 'lms':
-            return Metric.LAST_MAN_STANDING;
-        case 'league':
-        case 'lp':
-        case 'lps':
-            return Metric.LEAGUE_POINTS;
-        case 'sw':
-        case 'zeal':
-        case 'soul-wars':
-            return Metric.SOUL_WARS_ZEAL;
-        case 'rifts-closed':
-        case 'gotr':
-        case 'rifts':
-            return Metric.GUARDIANS_OF_THE_RIFT;
-        // Skills
-        case 'runecraft':
-        case 'rc':
-            return Metric.RUNECRAFTING;
-        case 'att':
-        case 'atk':
-        case 'attk':
-            return Metric.ATTACK;
-        case 'def':
-        case 'defense':
-            return Metric.DEFENCE;
-        case 'str':
-            return Metric.STRENGTH;
-        case 'hp':
-            return Metric.HITPOINTS;
-        case 'range':
-            return Metric.RANGED;
-        case 'pray':
-            return Metric.PRAYER;
-        case 'mage':
-            return Metric.MAGIC;
-        case 'cook':
-            return Metric.COOKING;
-        case 'wc':
-            return Metric.WOODCUTTING;
-        case 'fletch':
-            return Metric.FLETCHING;
-        case 'fish':
-            return Metric.FISHING;
-        case 'fm':
-        case 'burning':
-            return Metric.FIREMAKING;
-        case 'craft':
-            return Metric.CRAFTING;
-        case 'sm':
-        case 'smith':
-            return Metric.SMITHING;
-        case 'mine':
-        case 'smash':
-            return Metric.MINING;
-        case 'herb':
-            return Metric.HERBLORE;
-        case 'agi':
-        case 'agil':
-            return Metric.AGILITY;
-        case 'thief':
-            return Metric.THIEVING;
-        case 'slay':
-            return Metric.SLAYER;
-        case 'farm':
-            return Metric.FARMING;
-        case 'hunt':
-        case 'hunting':
-            return Metric.HUNTER;
-        case 'con':
-        case 'cons':
-        case 'const':
-            return Metric.CONSTRUCTION;
-        default:
-            return null;
-    }
-}
 
 const CUSTOM_PERIOD_REGEX = /(\d+y)?(\d+m)?(\d+w)?(\d+d)?(\d+h)?/;
 const PeriodProps = {
@@ -2447,12 +2196,6 @@ var EfficiencyAlgorithmType;
     EfficiencyAlgorithmType["F2P_LVL3_IRONMAN"] = "f2p_lvl3_ironman";
 })(EfficiencyAlgorithmType || (EfficiencyAlgorithmType = {}));
 
-var MigrationDataSource;
-(function (MigrationDataSource) {
-    MigrationDataSource[MigrationDataSource["TEMPLE_OSRS"] = 0] = "TEMPLE_OSRS";
-    MigrationDataSource[MigrationDataSource["CRYSTAL_MATH_LABS"] = 1] = "CRYSTAL_MATH_LABS";
-})(MigrationDataSource || (MigrationDataSource = {}));
-
 class EfficiencyClient extends BaseAPIClient {
     /**
      * Fetches the current efficiency leaderboard for a specific efficiency metric, playerType, playerBuild and country.
@@ -2624,4 +2367,4 @@ class WOMClient extends BaseAPIClient {
     }
 }
 
-export { ACTIVITIES, Activity, ActivityType, BOSSES, Boss, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, Metric, MetricMeasure, MetricProps, MetricType, MigrationDataSource, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, Period, PeriodProps, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, 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, Activity, ActivityType, BOSSES, Boss, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, Period, PeriodProps, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, 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, parsePeriodExpression, round };

package/dist/es/index.mjs

@@ -421,13 +421,6 @@ class PlayersClient extends BaseAPIClient {
     getPlayerGains(username, options) {
         return this.getRequest(`/players/${username}/gained`, options);
     }
-    /**
-     * Fetches a player's gains, for a specific period or time range, as an array.
-     * @returns An array of each metric's gained data.
-     */
-    getPlayerGainsAsArray(username, options) {
-        return this.getRequest(`/players/${username}/gained`, Object.assign(Object.assign({}, options), { formatting: 'array' }));
-    }
     /**
      * Fetches all of the player's records.
      * @returns A list of records.
@@ -1015,6 +1008,9 @@ const Country = {
     FR: 'FR',
     GA: 'GA',
     GB: 'GB',
+    GB_NIR: 'GB_NIR',
+    GB_SCT: 'GB_SCT',
+    GB_WLS: 'GB_WLS',
     GD: 'GD',
     GE: 'GE',
     GF: 'GF',
@@ -1302,6 +1298,9 @@ const CountryProps = {
     [Country.FR]: { code: 'FR', name: 'France' },
     [Country.GA]: { code: 'GA', name: 'Gabon' },
     [Country.GB]: { code: 'GB', name: 'United Kingdom' },
+    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northen Ireland' },
+    [Country.GB_SCT]: { code: 'GB_SCT', name: 'Scotland' },
+    [Country.GB_WLS]: { code: 'GB_WLS', name: 'Wales' },
     [Country.GD]: { code: 'GD', name: 'Grenada' },
     [Country.GE]: { code: 'GE', name: 'Georgia' },
     [Country.GF]: { code: 'GF', name: 'French Guiana' },
@@ -2045,256 +2044,6 @@ function getParentEfficiencyMetric(metric) {
         return Metric.EHP;
     return null;
 }
-function parseMetricAbbreviation(abbreviation) {
-    if (!abbreviation || abbreviation.length === 0) {
-        return null;
-    }
-    const fixedAbbreviation = abbreviation.toLowerCase();
-    if (isMetric(fixedAbbreviation)) {
-        return fixedAbbreviation;
-    }
-    switch (fixedAbbreviation) {
-        // Bosses
-        case 'sire':
-            return Metric.ABYSSAL_SIRE;
-        case 'hydra':
-            return Metric.ALCHEMICAL_HYDRA;
-        case 'barrows':
-            return Metric.BARROWS_CHESTS;
-        case 'bryo':
-            return Metric.BRYOPHYTA;
-        case 'cerb':
-            return Metric.CERBERUS;
-        case 'cox':
-        case 'xeric':
-        case 'chambers':
-        case 'olm':
-        case 'raids':
-            return Metric.CHAMBERS_OF_XERIC;
-        case 'cox-cm':
-        case 'xeric-cm':
-        case 'chambers-cm':
-        case 'olm-cm':
-        case 'raids-cm':
-            return Metric.CHAMBERS_OF_XERIC_CM;
-        case 'chaos-ele':
-            return Metric.CHAOS_ELEMENTAL;
-        case 'fanatic':
-            return Metric.CHAOS_FANATIC;
-        case 'sara':
-        case 'saradomin':
-        case 'zilyana':
-        case 'zily':
-            return Metric.COMMANDER_ZILYANA;
-        case 'corp':
-            return Metric.CORPOREAL_BEAST;
-        case 'crazy-arch':
-            return Metric.CRAZY_ARCHAEOLOGIST;
-        case 'prime':
-            return Metric.DAGANNOTH_PRIME;
-        case 'rex':
-            return Metric.DAGANNOTH_REX;
-        case 'supreme':
-            return Metric.DAGANNOTH_SUPREME;
-        case 'deranged-arch':
-            return Metric.DERANGED_ARCHAEOLOGIST;
-        case 'bandos':
-        case 'graardor':
-            return Metric.GENERAL_GRAARDOR;
-        case 'mole':
-            return Metric.GIANT_MOLE;
-        case 'dusk':
-        case 'dawn':
-        case 'gargs':
-        case 'guardians':
-        case 'ggs':
-            return Metric.GROTESQUE_GUARDIANS;
-        case 'phantom':
-        case 'muspah':
-            return Metric.PHANTOM_MUSPAH;
-        case 'kq':
-            return Metric.KALPHITE_QUEEN;
-        case 'kbd':
-            return Metric.KING_BLACK_DRAGON;
-        case 'kree':
-        case 'kreearra':
-        case 'armadyl':
-        case 'arma':
-            return Metric.KREEARRA;
-        case 'zammy':
-        case 'zamorak':
-        case 'kril':
-        case 'kril-tsutsaroth':
-            return Metric.KRIL_TSUTSAROTH;
-        case 'gaunt':
-        case 'gauntlet':
-        case 'the-gauntlet':
-            return Metric.THE_GAUNTLET;
-        case 'cgaunt':
-        case 'cgauntlet':
-        case 'corrupted':
-        case 'corrupted-gauntlet':
-        case 'the-corrupted-gauntlet':
-            return Metric.THE_CORRUPTED_GAUNTLET;
-        case 'tob':
-        case 'theatre':
-        case 'verzik':
-        case 'tob-normal':
-            return Metric.THEATRE_OF_BLOOD;
-        case 'tob-hm':
-        case 'tob-cm':
-        case 'tob-hard-mode':
-        case 'tob-hard':
-            return Metric.THEATRE_OF_BLOOD_HARD_MODE;
-        case 'toa':
-        case 'tombs':
-        case 'amascut':
-            return Metric.TOMBS_OF_AMASCUT;
-        case 'toa-expert':
-        case 'toa-hm':
-        case 'tombs-expert':
-        case 'tombs-hm':
-        case 'amascut-expert':
-        case 'amascut-hm':
-            return Metric.TOMBS_OF_AMASCUT_EXPERT;
-        case 'nm':
-        case 'tnm':
-        case 'nmare':
-        case 'the-nightmare':
-            return Metric.NIGHTMARE;
-        case 'pnm':
-        case 'phosani':
-        case 'phosanis':
-        case 'phosani-nm':
-        case 'phosani-nightmare':
-        case 'phosanis nightmare':
-            return Metric.PHOSANIS_NIGHTMARE;
-        case 'thermy':
-        case 'smoke-devil':
-            return Metric.THERMONUCLEAR_SMOKE_DEVIL;
-        case 'zuk':
-        case 'inferno':
-            return Metric.TZKAL_ZUK;
-        case 'jad':
-        case 'fight-caves':
-        case 'fc':
-            return Metric.TZTOK_JAD;
-        case 'vork':
-        case 'vorky':
-            return Metric.VORKATH;
-        case 'wt':
-            return Metric.WINTERTODT;
-        case 'snek':
-        case 'zul':
-            return Metric.ZULRAH;
-        // Minigames and others
-        case 'all-clues':
-        case 'clues':
-            return Metric.CLUE_SCROLLS_ALL;
-        case 'beginner':
-        case 'beginner-clues':
-        case 'beg-clues':
-        case 'beginners':
-            return Metric.CLUE_SCROLLS_BEGINNER;
-        case 'easy':
-        case 'easy-clues':
-        case 'easies':
-            return Metric.CLUE_SCROLLS_EASY;
-        case 'medium':
-        case 'med':
-        case 'meds':
-        case 'medium-clues':
-        case 'med-clues':
-        case 'mediums':
-            return Metric.CLUE_SCROLLS_MEDIUM;
-        case 'hard':
-        case 'hard-clues':
-        case 'hards':
-            return Metric.CLUE_SCROLLS_HARD;
-        case 'elite':
-        case 'elite-clues':
-        case 'elites':
-            return Metric.CLUE_SCROLLS_ELITE;
-        case 'master':
-        case 'master-clues':
-        case 'masters':
-            return Metric.CLUE_SCROLLS_MASTER;
-        case 'lms':
-            return Metric.LAST_MAN_STANDING;
-        case 'league':
-        case 'lp':
-        case 'lps':
-            return Metric.LEAGUE_POINTS;
-        case 'sw':
-        case 'zeal':
-        case 'soul-wars':
-            return Metric.SOUL_WARS_ZEAL;
-        case 'rifts-closed':
-        case 'gotr':
-        case 'rifts':
-            return Metric.GUARDIANS_OF_THE_RIFT;
-        // Skills
-        case 'runecraft':
-        case 'rc':
-            return Metric.RUNECRAFTING;
-        case 'att':
-        case 'atk':
-        case 'attk':
-            return Metric.ATTACK;
-        case 'def':
-        case 'defense':
-            return Metric.DEFENCE;
-        case 'str':
-            return Metric.STRENGTH;
-        case 'hp':
-            return Metric.HITPOINTS;
-        case 'range':
-            return Metric.RANGED;
-        case 'pray':
-            return Metric.PRAYER;
-        case 'mage':
-            return Metric.MAGIC;
-        case 'cook':
-            return Metric.COOKING;
-        case 'wc':
-            return Metric.WOODCUTTING;
-        case 'fletch':
-            return Metric.FLETCHING;
-        case 'fish':
-            return Metric.FISHING;
-        case 'fm':
-        case 'burning':
-            return Metric.FIREMAKING;
-        case 'craft':
-            return Metric.CRAFTING;
-        case 'sm':
-        case 'smith':
-            return Metric.SMITHING;
-        case 'mine':
-        case 'smash':
-            return Metric.MINING;
-        case 'herb':
-            return Metric.HERBLORE;
-        case 'agi':
-        case 'agil':
-            return Metric.AGILITY;
-        case 'thief':
-            return Metric.THIEVING;
-        case 'slay':
-            return Metric.SLAYER;
-        case 'farm':
-            return Metric.FARMING;
-        case 'hunt':
-        case 'hunting':
-            return Metric.HUNTER;
-        case 'con':
-        case 'cons':
-        case 'const':
-            return Metric.CONSTRUCTION;
-        default:
-            return null;
-    }
-}
 
 const CUSTOM_PERIOD_REGEX = /(\d+y)?(\d+m)?(\d+w)?(\d+d)?(\d+h)?/;
 const PeriodProps = {
@@ -2447,12 +2196,6 @@ var EfficiencyAlgorithmType;
     EfficiencyAlgorithmType["F2P_LVL3_IRONMAN"] = "f2p_lvl3_ironman";
 })(EfficiencyAlgorithmType || (EfficiencyAlgorithmType = {}));
 
-var MigrationDataSource;
-(function (MigrationDataSource) {
-    MigrationDataSource[MigrationDataSource["TEMPLE_OSRS"] = 0] = "TEMPLE_OSRS";
-    MigrationDataSource[MigrationDataSource["CRYSTAL_MATH_LABS"] = 1] = "CRYSTAL_MATH_LABS";
-})(MigrationDataSource || (MigrationDataSource = {}));
-
 class EfficiencyClient extends BaseAPIClient {
     /**
      * Fetches the current efficiency leaderboard for a specific efficiency metric, playerType, playerBuild and country.
@@ -2624,4 +2367,4 @@ class WOMClient extends BaseAPIClient {
     }
 }
 
-export { ACTIVITIES, Activity, ActivityType, BOSSES, Boss, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, Metric, MetricMeasure, MetricProps, MetricType, MigrationDataSource, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, Period, PeriodProps, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, 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, Activity, ActivityType, BOSSES, Boss, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, Period, PeriodProps, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, 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, parsePeriodExpression, round };

package/dist/index.d.ts

@@ -987,6 +987,9 @@ declare const Country: {
     readonly FR: "FR";
     readonly GA: "GA";
     readonly GB: "GB";
+    readonly GB_NIR: "GB_NIR";
+    readonly GB_SCT: "GB_SCT";
+    readonly GB_WLS: "GB_WLS";
     readonly GD: "GD";
     readonly GE: "GE";
     readonly GF: "GF";
@@ -1242,12 +1245,6 @@ interface ComputedMetricDelta {
     rank: MeasuredDeltaProgress;
     value: MeasuredDeltaProgress;
 }
-interface PlayerDeltasArray {
-    skills: Array<SkillDelta>;
-    bosses: Array<BossDelta>;
-    activities: Array<ActivityDelta>;
-    computed: Array<ComputedMetricDelta>;
-}
 interface PlayerDeltasMap {
     skills: MapOf<Skill, SkillDelta>;
     bosses: MapOf<Boss, BossDelta>;
@@ -1373,19 +1370,6 @@ interface GroupStatistics {
     averageStats: FormattedSnapshot;
     metricLeaders: MetricLeaders;
 }
-declare enum MigrationDataSource {
-    TEMPLE_OSRS = 0,
-    CRYSTAL_MATH_LABS = 1
-}
-interface CMLGroupData {
-    name: string;
-    members: string[];
-}
-interface TempleGroupData {
-    name: string;
-    members: string[];
-    leaders: string[];
-}
 type MemberRoleChangeEvent = Omit<MemberActivity, 'createdAt'>;
 type MemberJoinedEvent = Omit<MemberActivity, 'createdAt' | 'previousRole'>;
 type MemberLeftEvent = Omit<MemberActivity, 'createdAt' | 'previousRole'>;
@@ -1571,7 +1555,7 @@ interface CountryDetails {
     name: string;
 }
 declare const CountryProps: MapOf<Country, CountryDetails>;
-declare const COUNTRY_CODES: ("AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW")[];
+declare const COUNTRY_CODES: ("AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GB_NIR" | "GB_SCT" | "GB_WLS" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW")[];
 declare function isCountry(countryCodeString: string): countryCodeString is Country;
 declare function findCountry(countryIdentifier: string): CountryDetails | undefined;
 declare function findCountryByName(countryName: string): CountryDetails | undefined;
@@ -1760,7 +1744,6 @@ declare function getMetricMeasure(metric: Metric): MetricMeasure;
 declare function getMetricName(metric: Metric): string;
 declare function getMinimumValue(metric: Metric): number;
 declare function getParentEfficiencyMetric(metric: Metric): "ehp" | "ehb";
-declare function parseMetricAbbreviation(abbreviation: string): Metric | null;
 
 type PeriodPropsMap = MapOf<Period, {
     name: string;
@@ -1916,11 +1899,11 @@ interface AssertPlayerTypeResponse {
     player: Player;
     changed: boolean;
 }
-type GetPlayerGainsResponse<T extends PlayerDeltasArray | PlayerDeltasMap> = {
+interface GetPlayerGainsResponse {
     startsAt: Date;
     endsAt: Date;
-    data: T;
-};
+    data: PlayerDeltasMap;
+}
 /**
  * Efficiency Client Types
  */
@@ -2108,12 +2091,7 @@ declare class PlayersClient extends BaseAPIClient {
      * Fetches a player's gains, for a specific period or time range, as a [metric: data] map.
      * @returns A map of each metric's gained data.
      */
-    getPlayerGains(username: string, options: TimeRangeFilter): Promise<GetPlayerGainsResponse<PlayerDeltasMap>>;
-    /**
-     * Fetches a player's gains, for a specific period or time range, as an array.
-     * @returns An array of each metric's gained data.
-     */
-    getPlayerGainsAsArray(username: string, options: TimeRangeFilter): Promise<GetPlayerGainsResponse<PlayerDeltasArray>>;
+    getPlayerGains(username: string, options: TimeRangeFilter): Promise<GetPlayerGainsResponse>;
     /**
      * Fetches all of the player's records.
      * @returns A list of records.
@@ -2264,4 +2242,4 @@ declare class WOMClient extends BaseAPIClient {
     constructor(options?: WOMClientOptions);
 }
 
-export { ACTIVITIES, type Achievement, type AchievementDefinition, type AchievementProgress, type AchievementTemplate, Activity, type ActivityDelta, ActivityType, type ActivityValue, type AssertPlayerTypeResponse, BOSSES, type Bonus, Boss, type BossDelta, type BossMetaConfig, type BossValue, CAPPED_MAX_TOTAL_XP, type CMLGroupData, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, type ChangeMemberRolePayload, CompetitionCSVTableType, type CompetitionDetails, type CompetitionDetailsCSVParams, type CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, type CompetitionWithParticipations, type CompetitionsSearchFilter, ComputedMetric, type ComputedMetricDelta, type ComputedMetricValue, Country, type CountryDetails, CountryProps, type CreateCompetitionPayload, type CreateCompetitionResponse, type CreateGroupPayload, type CreateGroupResponse, type DeltaGroupLeaderboardEntry, type DeltaLeaderboardEntry, type DeltaLeaderboardFilter, type DenyContext, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, type EfficiencyAlgorithmTypeUnion, type EfficiencyLeaderboardsFilter, type ExtendedAchievement, type ExtendedAchievementWithPlayer, F2P_BOSSES, type FlaggedPlayerReviewContext, type FormattedSnapshot, GROUP_ROLES, type GenericCountMessageResponse, type GenericMessageResponse, type GetGroupGainsFilter, type GetPlayerGainsResponse, type GroupDetails, type GroupHiscoresActivityItem, type GroupHiscoresBossItem, type GroupHiscoresComputedMetricItem, type GroupHiscoresEntry, type GroupHiscoresSkillItem, type GroupListItem, type GroupMemberFragment, type GroupRecordsFilter, GroupRole, GroupRoleProps, type GroupStatistics, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, type MapOf, type MeasuredDeltaProgress, type MemberActivityWithPlayer, type MemberInput, type MemberJoinedEvent, type MemberLeftEvent, type MemberRoleChangeEvent, type MembershipWithGroup, type MembershipWithPlayer, Metric, type MetricLeaders, MetricMeasure, MetricProps, MetricType, type MetricValueKey, MigrationDataSource, type NameChange, type NameChangeDetails, NameChangeStatus, type NameChangeWithPlayer, type NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, type ParticipationWithCompetition, type ParticipationWithCompetitionAndStandings, type ParticipationWithPlayer, type ParticipationWithPlayerAndProgress, Period, PeriodProps, type Player, type PlayerArchiveWithPlayer, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingsFilter, type PlayerCompetitionsFilter, type PlayerDeltasArray, type PlayerDeltasMap, type PlayerDetails, type PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type Record, type RecordLeaderboardEntry, type RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, type SkillDelta, type SkillMetaConfig, type SkillMetaMethod, type SkillValue, type SkipContext, type Snapshot, type SnapshotFragment, type Team, type TempleGroupData, type TimeRangeFilter, type 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, type Achievement, type AchievementDefinition, type AchievementProgress, type AchievementTemplate, Activity, type ActivityDelta, ActivityType, type ActivityValue, type AssertPlayerTypeResponse, BOSSES, type Bonus, Boss, type BossDelta, type BossMetaConfig, type BossValue, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, type ChangeMemberRolePayload, CompetitionCSVTableType, type CompetitionDetails, type CompetitionDetailsCSVParams, type CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, type CompetitionWithParticipations, type CompetitionsSearchFilter, ComputedMetric, type ComputedMetricDelta, type ComputedMetricValue, Country, type CountryDetails, CountryProps, type CreateCompetitionPayload, type CreateCompetitionResponse, type CreateGroupPayload, type CreateGroupResponse, type DeltaGroupLeaderboardEntry, type DeltaLeaderboardEntry, type DeltaLeaderboardFilter, type DenyContext, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, type EfficiencyAlgorithmTypeUnion, type EfficiencyLeaderboardsFilter, type ExtendedAchievement, type ExtendedAchievementWithPlayer, F2P_BOSSES, type FlaggedPlayerReviewContext, type FormattedSnapshot, GROUP_ROLES, type GenericCountMessageResponse, type GenericMessageResponse, type GetGroupGainsFilter, type GetPlayerGainsResponse, type GroupDetails, type GroupHiscoresActivityItem, type GroupHiscoresBossItem, type GroupHiscoresComputedMetricItem, type GroupHiscoresEntry, type GroupHiscoresSkillItem, type GroupListItem, type GroupMemberFragment, type GroupRecordsFilter, GroupRole, GroupRoleProps, type GroupStatistics, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, type MapOf, type MeasuredDeltaProgress, type MemberActivityWithPlayer, type MemberInput, type MemberJoinedEvent, type MemberLeftEvent, type MemberRoleChangeEvent, type MembershipWithGroup, type MembershipWithPlayer, Metric, type MetricLeaders, MetricMeasure, MetricProps, MetricType, type MetricValueKey, type NameChange, type NameChangeDetails, NameChangeStatus, type NameChangeWithPlayer, type NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, type ParticipationWithCompetition, type ParticipationWithCompetitionAndStandings, type ParticipationWithPlayer, type ParticipationWithPlayerAndProgress, Period, PeriodProps, type Player, type PlayerArchiveWithPlayer, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingsFilter, type PlayerCompetitionsFilter, type PlayerDeltasMap, type PlayerDetails, type PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type Record, type RecordLeaderboardEntry, type RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, type SkillDelta, type SkillMetaConfig, type SkillMetaMethod, type SkillValue, type SkipContext, type Snapshot, type SnapshotFragment, type Team, type TimeRangeFilter, type 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, parsePeriodExpression, round };

package/package.json

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