@wise-old-man/utils 2.0.0-beta.2 → 2.0.0-beta.3

package/dist/index.d.ts

@@ -527,11 +527,11 @@ declare const Boss: {
     readonly ZULRAH: "zulrah";
 };
 declare type Boss = typeof Boss[keyof typeof Boss];
-declare const Virtual: {
+declare const ComputedMetric: {
     readonly EHP: "ehp";
     readonly EHB: "ehb";
 };
-declare type Virtual = typeof Virtual[keyof typeof Virtual];
+declare type ComputedMetric = typeof ComputedMetric[keyof typeof ComputedMetric];
 declare const Metric: {
     readonly EHP: "ehp";
     readonly EHB: "ehb";
@@ -1205,8 +1205,8 @@ declare const CompetitionTypeProps: CompetitionTypePropsMap;
 declare const CompetitionStatusProps: CompetitionStatusPropsMap;
 declare const COMPETITION_TYPES: ("classic" | "team")[];
 declare const COMPETITION_STATUSES: CompetitionStatus[];
-declare function findCompetitionType(typeName: string): CompetitionType | null;
-declare function findCompetitionStatus(statusName: string): CompetitionStatus | null;
+declare function isCompetitionType(typeString: string): typeString is CompetitionType;
+declare function isCompetitionStatus(statusString: string): statusString is CompetitionStatus;
 
 interface CountryDetails {
     code: Country;
@@ -1217,6 +1217,7 @@ declare type CountryPropsMap = {
 };
 declare const CountryProps: CountryPropsMap;
 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 function isCountry(countryCodeString: string): countryCodeString is Country;
 declare function findCountry(countryIdentifier: string): CountryDetails | undefined;
 declare function findCountryByName(countryName: string): CountryDetails | undefined;
 declare function findCountryByCode(countryCode: string): CountryDetails | undefined;
@@ -1240,12 +1241,13 @@ declare type GroupRolePropsMap = {
 };
 declare const GroupRoleProps: GroupRolePropsMap;
 declare function findGroupRole(roleName: string): GroupRole | null;
+declare function isGroupRole(roleString: string): roleString is GroupRole;
 
 declare enum MetricType {
     SKILL = "skill",
     BOSS = "boss",
     ACTIVITY = "activity",
-    VIRTUAL = "virtual"
+    COMPUTED = "computed"
 }
 declare enum MetricMeasure {
     EXPERIENCE = "experience",
@@ -1267,14 +1269,14 @@ interface BossProperties {
     type: MetricType;
     measure: MetricMeasure;
 }
-interface VirtualProperties {
+interface ComputedMetricProperties {
     name: string;
     type: MetricType;
     measure: MetricMeasure;
 }
 declare const MetricProps: {
-    ehp: VirtualProperties;
-    ehb: VirtualProperties;
+    ehp: ComputedMetricProperties;
+    ehb: ComputedMetricProperties;
     abyssal_sire: BossProperties;
     alchemical_hydra: BossProperties;
     barrows_chests: BossProperties;
@@ -1354,22 +1356,23 @@ declare const METRICS: string[];
 declare const SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
 declare const BOSSES: ("abyssal_sire" | "alchemical_hydra" | "barrows_chests" | "bryophyta" | "callisto" | "cerberus" | "chambers_of_xeric" | "chambers_of_xeric_challenge_mode" | "chaos_elemental" | "chaos_fanatic" | "commander_zilyana" | "corporeal_beast" | "crazy_archaeologist" | "dagannoth_prime" | "dagannoth_rex" | "dagannoth_supreme" | "deranged_archaeologist" | "general_graardor" | "giant_mole" | "grotesque_guardians" | "hespori" | "kalphite_queen" | "king_black_dragon" | "kraken" | "kreearra" | "kril_tsutsaroth" | "mimic" | "nex" | "nightmare" | "phosanis_nightmare" | "obor" | "sarachnis" | "scorpia" | "skotizo" | "tempoross" | "the_gauntlet" | "the_corrupted_gauntlet" | "theatre_of_blood" | "theatre_of_blood_hard_mode" | "thermonuclear_smoke_devil" | "tombs_of_amascut" | "tombs_of_amascut_expert" | "tzkal_zuk" | "tztok_jad" | "venenatis" | "vetion" | "vorkath" | "wintertodt" | "zalcano" | "zulrah")[];
 declare const ACTIVITIES: string[];
-declare const VIRTUALS: ("ehp" | "ehb")[];
+declare const COMPUTED_METRICS: ("ehp" | "ehb")[];
 declare const REAL_SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
 declare const F2P_BOSSES: ("abyssal_sire" | "alchemical_hydra" | "barrows_chests" | "bryophyta" | "callisto" | "cerberus" | "chambers_of_xeric" | "chambers_of_xeric_challenge_mode" | "chaos_elemental" | "chaos_fanatic" | "commander_zilyana" | "corporeal_beast" | "crazy_archaeologist" | "dagannoth_prime" | "dagannoth_rex" | "dagannoth_supreme" | "deranged_archaeologist" | "general_graardor" | "giant_mole" | "grotesque_guardians" | "hespori" | "kalphite_queen" | "king_black_dragon" | "kraken" | "kreearra" | "kril_tsutsaroth" | "mimic" | "nex" | "nightmare" | "phosanis_nightmare" | "obor" | "sarachnis" | "scorpia" | "skotizo" | "tempoross" | "the_gauntlet" | "the_corrupted_gauntlet" | "theatre_of_blood" | "theatre_of_blood_hard_mode" | "thermonuclear_smoke_devil" | "tombs_of_amascut" | "tombs_of_amascut_expert" | "tzkal_zuk" | "tztok_jad" | "venenatis" | "vetion" | "vorkath" | "wintertodt" | "zalcano" | "zulrah")[];
 declare const MEMBER_SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
 declare const COMBAT_SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
 declare function findMetric(metricName: string): Metric | null;
-declare function isSkill(metric: Metric): boolean;
-declare function isActivity(metric: Metric): boolean;
-declare function isBoss(metric: Metric): boolean;
-declare function isVirtualMetric(metric: Metric): boolean;
+declare function isMetric(metricString: string): metricString is Metric;
+declare function isSkill(metric: Metric | string): metric is Skill;
+declare function isActivity(metric: Metric | string): metric is Activity;
+declare function isBoss(metric: Metric | string): metric is Boss;
+declare function isComputedMetric(metric: Metric | string): metric is ComputedMetric;
 declare function getMetricRankKey(metric: Metric): string;
 declare function getMetricValueKey(metric: Metric): string;
 declare function getMetricMeasure(metric: Metric): any;
 declare function getMetricName(metric: Metric): any;
 declare function getMinimumBossKc(metric: Metric): number;
-declare function getParentVirtualMetric(metric: Metric): "ehp" | "ehb";
+declare function getParentEfficiencyMetric(metric: Metric): "ehp" | "ehb";
 declare function parseMetricAbbreviation(abbreviation: string): string | null;
 
 declare type PeriodPropsMap = {
@@ -1381,6 +1384,7 @@ declare type PeriodPropsMap = {
 declare const PeriodProps: PeriodPropsMap;
 declare const PERIODS: ("five_min" | "day" | "week" | "month" | "year")[];
 declare function findPeriod(periodName: string): Period | null;
+declare function isPeriod(periodString: string): periodString is Period;
 declare function parsePeriodExpression(periodExpression: string): {
     expression: string;
     durationMs: number;
@@ -1400,6 +1404,8 @@ declare const PlayerTypeProps: PlayerTypePropsMap;
 declare const PlayerBuildProps: PlayerBuildPropsMap;
 declare const PLAYER_TYPES: ("unknown" | "regular" | "ironman" | "hardcore" | "ultimate")[];
 declare const PLAYER_BUILDS: ("main" | "f2p" | "lvl3" | "zerker" | "def1" | "hp10")[];
+declare function isPlayerType(typeString: string): typeString is PlayerType;
+declare function isPlayerBuild(buildString: string): buildString is PlayerBuild;
 declare function findPlayerType(typeName: string): PlayerType | null;
 declare function findPlayerBuild(buildName: string): PlayerBuild | null;
 
@@ -1467,8 +1473,8 @@ interface ActivityDelta {
     rank: MeasuredDeltaProgress;
     score: MeasuredDeltaProgress;
 }
-interface VirtualDelta {
-    metric: Virtual;
+interface ComputedMetricDelta {
+    metric: ComputedMetric;
     rank: MeasuredDeltaProgress;
     value: MeasuredDeltaProgress;
 }
@@ -1476,7 +1482,7 @@ interface PlayerDeltasArray {
     skills: Array<SkillDelta>;
     bosses: Array<BossDelta>;
     activities: Array<ActivityDelta>;
-    virtuals: Array<VirtualDelta>;
+    computed: Array<ComputedMetricDelta>;
 }
 interface PlayerDeltasMap {
     skills: {
@@ -1488,8 +1494,8 @@ interface PlayerDeltasMap {
     activities: {
         [activity in Activity]?: ActivityDelta;
     };
-    virtuals: {
-        [virtual in Virtual]?: VirtualDelta;
+    computed: {
+        [computedMetric in ComputedMetric]?: ComputedMetricDelta;
     };
 }
 interface DeltaLeaderboardEntry {
@@ -1523,8 +1529,8 @@ interface ActivityValue {
     rank: number;
     score: number;
 }
-interface VirtualValue {
-    metric: Virtual;
+interface ComputedMetricValue {
+    metric: ComputedMetric;
     rank: number;
     value: number;
 }
@@ -1543,8 +1549,8 @@ interface FormattedSnapshot {
         activities: {
             [activity in Activity]?: ActivityValue;
         };
-        virtuals: {
-            [virtual in Virtual]?: VirtualValue;
+        computed: {
+            [computed in ComputedMetric]?: ComputedMetric;
         };
     };
 }
@@ -1565,26 +1571,26 @@ interface MemberInput {
     username: string;
     role: string | GroupRole;
 }
-interface SkillHiscoresItem {
+interface GroupHiscoresSkillItem {
     rank: number;
     level: number;
     experience: number;
 }
-interface BossHiscoresItem {
+interface GroupHiscoresBossItem {
     rank: number;
     kills: number;
 }
-interface ActivityHiscoresItem {
+interface GroupHiscoresActivityItem {
     rank: number;
     score: number;
 }
-interface VirtualHiscoresItem {
+interface GroupHiscoresComputedMetricItem {
     rank: number;
     value: number;
 }
 interface GroupHiscoresEntry {
     player: Player;
-    data: SkillHiscoresItem | BossHiscoresItem | ActivityHiscoresItem | VirtualHiscoresItem;
+    data: GroupHiscoresSkillItem | GroupHiscoresBossItem | GroupHiscoresActivityItem | GroupHiscoresComputedMetricItem;
 }
 interface GroupStatistics {
     maxedCombatCount: number;
@@ -2028,7 +2034,7 @@ declare class RecordsClient {
 
 declare class EfficiencyClient {
     /**
-     * Fetches the current efficiency leaderboard for a specific virtual metric, playerType, playerBuild and country.
+     * Fetches the current efficiency leaderboard for a specific efficiency metric, playerType, playerBuild and country.
      * @returns A list of players.
      */
     getEfficiencyLeaderboards(filter: EfficiencyLeaderboardsFilter, pagination?: PaginationOptions): Promise<Player[]>;
@@ -2132,4 +2138,4 @@ declare class WOMClient {
     constructor();
 }
 
-export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, AlgorithmCache, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, CAPPED_MAX_TOTAL_XP, CMLGroupData, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COUNTRY_CODES, ChangeMemberRolePayload, CompetitionDetails, CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, CompetitionWithParticipations, CompetitionsSearchFilter, Country, CountryDetails, CountryProps, CreateCompetitionPayload, CreateCompetitionResponse, CreateGroupPayload, CreateGroupResponse, DeltaLeaderboardEntry, DeltaLeaderboardFilter, EditCompetitionPayload, EditGroupPayload, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyAlgorithmTypeUnion, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, F2P_BOSSES, FormattedSnapshot, GROUP_ROLES, GenericCountMessageResponse, GenericMessageResponse, GetGroupGainsFilter, GetPlayerGainsResponse, GroupHiscoresEntry, GroupListItem, GroupMemberFragment, GroupRecordsFilter, GroupRole, GroupRoleProps, GroupStatistics, GroupWithMemberships, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricMeasure, MetricProps, MetricType, MigrationDataSource, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerResolvable, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, SkillValue, Snapshot, SnapshotDataSource, SnapshotFragment, Team, TempleGroupData, TimeRangeFilter, Top5ProgressResult, VIRTUALS, Virtual, VirtualDelta, VirtualValue, WOMClient, findCompetitionStatus, findCompetitionType, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumBossKc, getParentVirtualMetric, isActivity, isBoss, isSkill, isVirtualMetric, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };
+export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, AlgorithmCache, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, 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, Country, CountryDetails, CountryProps, CreateCompetitionPayload, CreateCompetitionResponse, CreateGroupPayload, CreateGroupResponse, DeltaLeaderboardEntry, DeltaLeaderboardFilter, EditCompetitionPayload, EditGroupPayload, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyAlgorithmTypeUnion, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, F2P_BOSSES, FormattedSnapshot, GROUP_ROLES, GenericCountMessageResponse, GenericMessageResponse, GetGroupGainsFilter, GetPlayerGainsResponse, GroupHiscoresActivityItem, GroupHiscoresBossItem, GroupHiscoresComputedMetricItem, GroupHiscoresEntry, GroupHiscoresSkillItem, GroupListItem, GroupMemberFragment, GroupRecordsFilter, GroupRole, GroupRoleProps, GroupStatistics, GroupWithMemberships, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricMeasure, MetricProps, MetricType, MigrationDataSource, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerResolvable, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, SkillValue, Snapshot, SnapshotDataSource, SnapshotFragment, Team, TempleGroupData, TimeRangeFilter, Top5ProgressResult, WOMClient, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumBossKc, getParentEfficiencyMetric, isActivity, isBoss, isCompetitionStatus, isCompetitionType, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerType, isSkill, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };

package/dist/index.js

@@ -569,11 +569,11 @@ const Boss = {
     ZALCANO: 'zalcano',
     ZULRAH: 'zulrah'
 };
-const Virtual = {
+const ComputedMetric = {
     EHP: 'ehp',
     EHB: 'ehb'
 };
-const Metric = Object.assign(Object.assign(Object.assign(Object.assign({}, Skill), Activity), Boss), Virtual);
+const Metric = Object.assign(Object.assign(Object.assign(Object.assign({}, Skill), Activity), Boss), ComputedMetric);
 const NameChangeStatus = {
     PENDING: 'pending',
     DENIED: 'denied',
@@ -1145,19 +1145,11 @@ const CompetitionStatusProps = {
 };
 const COMPETITION_TYPES = Object.values(CompetitionType);
 const COMPETITION_STATUSES = Object.values(exports.CompetitionStatus);
-function findCompetitionType(typeName) {
-    for (const [key, value] of Object.entries(CompetitionTypeProps)) {
-        if (value.name === typeName)
-            return key;
-    }
-    return null;
+function isCompetitionType(typeString) {
+    return typeString in CompetitionTypeProps;
 }
-function findCompetitionStatus(statusName) {
-    for (const [key, value] of Object.entries(CompetitionStatusProps)) {
-        if (value.name === statusName)
-            return key;
-    }
-    return null;
+function isCompetitionStatus(statusString) {
+    return statusString in CompetitionStatusProps;
 }
 
 const CountryProps = {
@@ -1416,6 +1408,9 @@ const COMMON_ALIASES = [
     { commonIdentifier: 'UK', trueIdentifier: 'GB' },
     { commonIdentifier: 'USA', trueIdentifier: 'US' }
 ];
+function isCountry(countryCodeString) {
+    return countryCodeString in CountryProps;
+}
 function findCountry(countryIdentifier) {
     return findCountryByCode(countryIdentifier) || findCountryByName(countryIdentifier);
 }
@@ -1776,13 +1771,16 @@ function findGroupRole(roleName) {
     }
     return null;
 }
+function isGroupRole(roleString) {
+    return roleString in GroupRoleProps;
+}
 
 exports.MetricType = void 0;
 (function (MetricType) {
     MetricType["SKILL"] = "skill";
     MetricType["BOSS"] = "boss";
     MetricType["ACTIVITY"] = "activity";
-    MetricType["VIRTUAL"] = "virtual";
+    MetricType["COMPUTED"] = "computed";
 })(exports.MetricType || (exports.MetricType = {}));
 exports.MetricMeasure = void 0;
 (function (MetricMeasure) {
@@ -1889,16 +1887,16 @@ const ActivityProps = lodash.mapValues({
     [Activity.SOUL_WARS_ZEAL]: { name: 'Soul Wars Zeal' },
     [Activity.GUARDIANS_OF_THE_RIFT]: { name: 'Guardians of the Rift' }
 }, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.ACTIVITY, measure: exports.MetricMeasure.SCORE })));
-const VirtualProps = lodash.mapValues({
-    [Virtual.EHP]: { name: 'EHP' },
-    [Virtual.EHB]: { name: 'EHB' }
-}, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.VIRTUAL, measure: exports.MetricMeasure.VALUE })));
-const MetricProps = Object.assign(Object.assign(Object.assign(Object.assign({}, SkillProps), BossProps), ActivityProps), VirtualProps);
+const ComputedMetricProps = lodash.mapValues({
+    [ComputedMetric.EHP]: { name: 'EHP' },
+    [ComputedMetric.EHB]: { name: 'EHB' }
+}, 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 METRICS = Object.values(Metric);
 const SKILLS = Object.values(Skill);
 const BOSSES = Object.values(Boss);
 const ACTIVITIES = Object.values(Activity);
-const VIRTUALS = Object.values(Virtual);
+const COMPUTED_METRICS = Object.values(ComputedMetric);
 const REAL_SKILLS = SKILLS.filter(s => s !== Skill.OVERALL);
 const F2P_BOSSES = BOSSES.filter(b => !MetricProps[b].isMembers);
 const MEMBER_SKILLS = SKILLS.filter(s => MetricProps[s].isMembers);
@@ -1910,6 +1908,9 @@ function findMetric(metricName) {
     }
     return null;
 }
+function isMetric(metricString) {
+    return metricString in MetricProps;
+}
 function isSkill(metric) {
     return metric in SkillProps;
 }
@@ -1919,8 +1920,8 @@ function isActivity(metric) {
 function isBoss(metric) {
     return metric in BossProps;
 }
-function isVirtualMetric(metric) {
-    return metric in VirtualProps;
+function isComputedMetric(metric) {
+    return metric in ComputedMetricProps;
 }
 function getMetricRankKey(metric) {
     return `${metric}Rank`;
@@ -1937,7 +1938,7 @@ function getMetricName(metric) {
 function getMinimumBossKc(metric) {
     return isBoss(metric) ? MetricProps[metric].minimumKc : 0;
 }
-function getParentVirtualMetric(metric) {
+function getParentEfficiencyMetric(metric) {
     if (isBoss(metric))
         return Metric.EHB;
     if (isSkill(metric))
@@ -2200,9 +2201,12 @@ function findPeriod(periodName) {
     }
     return null;
 }
+function isPeriod(periodString) {
+    return periodString in PeriodProps;
+}
 function parsePeriodExpression(periodExpression) {
     const fixed = periodExpression.toLowerCase();
-    if (PERIODS.includes(fixed)) {
+    if (isPeriod(fixed)) {
         return {
             expression: fixed,
             durationMs: PeriodProps[fixed].milliseconds
@@ -2245,6 +2249,12 @@ const PlayerBuildProps = {
 };
 const PLAYER_TYPES = Object.values(PlayerType);
 const PLAYER_BUILDS = Object.values(PlayerBuild);
+function isPlayerType(typeString) {
+    return typeString in PlayerTypeProps;
+}
+function isPlayerBuild(buildString) {
+    return buildString in PlayerBuildProps;
+}
 function findPlayerType(typeName) {
     for (const [key, value] of Object.entries(PlayerTypeProps)) {
         if (value.name.toUpperCase() === typeName.toUpperCase())
@@ -2316,7 +2326,7 @@ exports.SnapshotDataSource = void 0;
 
 class EfficiencyClient {
     /**
-     * Fetches the current efficiency leaderboard for a specific virtual metric, playerType, playerBuild and country.
+     * Fetches the current efficiency leaderboard for a specific efficiency metric, playerType, playerBuild and country.
      * @returns A list of players.
      */
     getEfficiencyLeaderboards(filter, pagination) {
@@ -2479,10 +2489,12 @@ 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.Country = Country;
 exports.CountryProps = CountryProps;
 exports.F2P_BOSSES = F2P_BOSSES;
@@ -2511,11 +2523,7 @@ exports.REAL_SKILLS = REAL_SKILLS;
 exports.SKILLS = SKILLS;
 exports.SKILL_EXP_AT_99 = SKILL_EXP_AT_99;
 exports.Skill = Skill;
-exports.VIRTUALS = VIRTUALS;
-exports.Virtual = Virtual;
 exports.WOMClient = WOMClient;
-exports.findCompetitionStatus = findCompetitionStatus;
-exports.findCompetitionType = findCompetitionType;
 exports.findCountry = findCountry;
 exports.findCountryByCode = findCountryByCode;
 exports.findCountryByName = findCountryByName;
@@ -2533,11 +2541,19 @@ exports.getMetricName = getMetricName;
 exports.getMetricRankKey = getMetricRankKey;
 exports.getMetricValueKey = getMetricValueKey;
 exports.getMinimumBossKc = getMinimumBossKc;
-exports.getParentVirtualMetric = getParentVirtualMetric;
+exports.getParentEfficiencyMetric = getParentEfficiencyMetric;
 exports.isActivity = isActivity;
 exports.isBoss = isBoss;
+exports.isCompetitionStatus = isCompetitionStatus;
+exports.isCompetitionType = isCompetitionType;
+exports.isComputedMetric = isComputedMetric;
+exports.isCountry = isCountry;
+exports.isGroupRole = isGroupRole;
+exports.isMetric = isMetric;
+exports.isPeriod = isPeriod;
+exports.isPlayerBuild = isPlayerBuild;
+exports.isPlayerType = isPlayerType;
 exports.isSkill = isSkill;
-exports.isVirtualMetric = isVirtualMetric;
 exports.padNumber = padNumber;
 exports.parseMetricAbbreviation = parseMetricAbbreviation;
 exports.parsePeriodExpression = parsePeriodExpression;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise-old-man/utils",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",