@wise-old-man/utils 2.0.5 → 2.0.6

package/dist/index.d.ts

@@ -1473,7 +1473,6 @@ declare type NameChangeDetails = {
     };
 };
 
-declare type PlayerResolvable = Partial<Pick<Player, 'id' | 'username'>>;
 interface PlayerDetails extends Player {
     combatLevel: number;
     latestSnapshot: FormattedSnapshot;
@@ -1956,72 +1955,67 @@ declare class PlayersClient extends BaseAPIClient {
      * Updates/tracks a player.
      * @returns The player's new details, including the latest snapshot.
      */
-    updatePlayer(player: PlayerResolvable): Promise<PlayerDetails>;
+    updatePlayer(username: string): Promise<PlayerDetails>;
     /**
      * Asserts (and attempts to fix, if necessary) a player's game-mode type.
      * @returns The updated player, and an indication of whether the type was changed.
      */
-    assertPlayerType(player: PlayerResolvable): Promise<AssertPlayerTypeResponse>;
-    /**
-     * Attempts to import a player's snapshot history from CrystalMathLabs.
-     * @returns The number of snapshots that were imported.
-     */
-    importPlayer(player: PlayerResolvable): Promise<GenericCountMessageResponse>;
+    assertPlayerType(username: string): Promise<AssertPlayerTypeResponse>;
     /**
      * Fetches a player's details.
      * @returns The player's details, including the latest snapshot.
      */
-    getPlayerDetails(player: PlayerResolvable): Promise<PlayerDetails>;
+    getPlayerDetails(username: string): Promise<PlayerDetails>;
     /**
      * Fetches a player's current achievements.
      * @returns A list of achievements.
      */
-    getPlayerAchievements(player: PlayerResolvable): Promise<ExtendedAchievement[]>;
+    getPlayerAchievements(username: string): Promise<ExtendedAchievement[]>;
     /**
      * Fetches a player's current achievement progress.
      * @returns A list of achievements (completed or otherwise), with their respective relative/absolute progress percentage.
      */
-    getPlayerAchievementProgress(player: PlayerResolvable): Promise<AchievementProgress[]>;
+    getPlayerAchievementProgress(username: string): Promise<AchievementProgress[]>;
     /**
      * Fetches all of the player's competition participations.
      * @returns A list of participations, with the respective competition included.
      */
-    getPlayerCompetitions(player: PlayerResolvable, filter?: PlayerCompetitionsFilter, pagination?: PaginationOptions): Promise<ParticipationWithCompetition[]>;
+    getPlayerCompetitions(username: string, filter?: PlayerCompetitionsFilter, pagination?: PaginationOptions): Promise<ParticipationWithCompetition[]>;
     /**
      * Fetches all of the player's competition participations' standings.
      * @returns A list of participations, with the respective competition, rank and progress included.
      */
-    getPlayerCompetitionStandings(player: PlayerResolvable, filter: PlayerCompetitionsFilter): Promise<ParticipationWithCompetitionAndStandings[]>;
+    getPlayerCompetitionStandings(username: string, filter: PlayerCompetitionsFilter): Promise<ParticipationWithCompetitionAndStandings[]>;
     /**
      * Fetches all of the player's group memberships.
      * @returns A list of memberships, with the respective group included.
      */
-    getPlayerGroups(player: PlayerResolvable, pagination?: PaginationOptions): Promise<MembershipWithGroup[]>;
+    getPlayerGroups(username: string, pagination?: PaginationOptions): Promise<MembershipWithGroup[]>;
     /**
      * 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(player: PlayerResolvable, options: TimeRangeFilter): Promise<GetPlayerGainsResponse<PlayerDeltasMap>>;
+    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(player: PlayerResolvable, options: TimeRangeFilter): Promise<GetPlayerGainsResponse<PlayerDeltasArray>>;
+    getPlayerGainsAsArray(username: string, options: TimeRangeFilter): Promise<GetPlayerGainsResponse<PlayerDeltasArray>>;
     /**
      * Fetches all of the player's records.
      * @returns A list of records.
      */
-    getPlayerRecords(player: PlayerResolvable, options?: PlayerRecordsFilter): Promise<Record[]>;
+    getPlayerRecords(username: string, options?: PlayerRecordsFilter): Promise<Record[]>;
     /**
      * Fetches all of the player's past snapshots.
      * @returns A list of snapshots.
      */
-    getPlayerSnapshots(player: PlayerResolvable, options?: TimeRangeFilter, pagination?: PaginationOptions): Promise<FormattedSnapshot[]>;
+    getPlayerSnapshots(username: string, options?: TimeRangeFilter, pagination?: PaginationOptions): Promise<FormattedSnapshot[]>;
     /**
      * Fetches all of the player's approved name changes.
      * @returns A list of name changes.
      */
-    getPlayerNames(player: PlayerResolvable): Promise<NameChange[]>;
+    getPlayerNames(username: string): Promise<NameChange[]>;
 }
 
 declare class RecordsClient extends BaseAPIClient {
@@ -2143,4 +2137,4 @@ declare class WOMClient {
     constructor(options?: WOMClientOptions);
 }
 
-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, GroupDetails, GroupHiscoresActivityItem, GroupHiscoresBossItem, GroupHiscoresComputedMetricItem, GroupHiscoresEntry, GroupHiscoresSkillItem, GroupListItem, GroupMemberFragment, GroupRecordsFilter, GroupRole, GroupRoleProps, GroupStatistics, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MapOf, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricMeasure, MetricProps, MetricType, MetricValueKey, MigrationDataSource, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerCompetitionStandingsFilter, PlayerCompetitionsFilter, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, 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, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isCompetitionStatus, isCompetitionType, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerType, isSkill, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };
+export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, 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, GroupDetails, GroupHiscoresActivityItem, GroupHiscoresBossItem, GroupHiscoresComputedMetricItem, GroupHiscoresEntry, GroupHiscoresSkillItem, GroupListItem, GroupMemberFragment, GroupRecordsFilter, GroupRole, GroupRoleProps, GroupStatistics, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MapOf, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricMeasure, MetricProps, MetricType, MetricValueKey, MigrationDataSource, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerCompetitionStandingsFilter, PlayerCompetitionsFilter, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, 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, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isCompetitionStatus, isCompetitionType, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerType, isSkill, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };

package/dist/index.js

@@ -321,109 +321,93 @@ class PlayersClient extends BaseAPIClient {
      * Updates/tracks a player.
      * @returns The player's new details, including the latest snapshot.
      */
-    updatePlayer(player) {
-        return this.postRequest(getPlayerURL(player));
+    updatePlayer(username) {
+        return this.postRequest(`/players/${username}`);
     }
     /**
      * Asserts (and attempts to fix, if necessary) a player's game-mode type.
      * @returns The updated player, and an indication of whether the type was changed.
      */
-    assertPlayerType(player) {
-        return this.postRequest(`${getPlayerURL(player)}/assert-type`);
-    }
-    /**
-     * Attempts to import a player's snapshot history from CrystalMathLabs.
-     * @returns The number of snapshots that were imported.
-     */
-    importPlayer(player) {
-        return this.postRequest(`${getPlayerURL(player)}/import-history`);
+    assertPlayerType(username) {
+        return this.postRequest(`/players/${username}/assert-type`);
     }
     /**
      * Fetches a player's details.
      * @returns The player's details, including the latest snapshot.
      */
-    getPlayerDetails(player) {
-        return this.getRequest(getPlayerURL(player));
+    getPlayerDetails(username) {
+        return this.getRequest(`/players/${username}`);
     }
     /**
      * Fetches a player's current achievements.
      * @returns A list of achievements.
      */
-    getPlayerAchievements(player) {
-        return this.getRequest(`${getPlayerURL(player)}/achievements`);
+    getPlayerAchievements(username) {
+        return this.getRequest(`/players/${username}/achievements`);
     }
     /**
      * Fetches a player's current achievement progress.
      * @returns A list of achievements (completed or otherwise), with their respective relative/absolute progress percentage.
      */
-    getPlayerAchievementProgress(player) {
-        return this.getRequest(`${getPlayerURL(player)}/achievements/progress`);
+    getPlayerAchievementProgress(username) {
+        return this.getRequest(`/players/${username}/achievements/progress`);
     }
     /**
      * Fetches all of the player's competition participations.
      * @returns A list of participations, with the respective competition included.
      */
-    getPlayerCompetitions(player, filter, pagination) {
-        return this.getRequest(`${getPlayerURL(player)}/competitions`, Object.assign(Object.assign({}, filter), pagination));
+    getPlayerCompetitions(username, filter, pagination) {
+        return this.getRequest(`/players/${username}/competitions`, Object.assign(Object.assign({}, filter), pagination));
     }
     /**
      * Fetches all of the player's competition participations' standings.
      * @returns A list of participations, with the respective competition, rank and progress included.
      */
-    getPlayerCompetitionStandings(player, filter) {
-        return this.getRequest(`${getPlayerURL(player)}/competitions/standings`, filter);
+    getPlayerCompetitionStandings(username, filter) {
+        return this.getRequest(`/players/${username}/competitions/standings`, filter);
     }
     /**
      * Fetches all of the player's group memberships.
      * @returns A list of memberships, with the respective group included.
      */
-    getPlayerGroups(player, pagination) {
-        return this.getRequest(`${getPlayerURL(player)}/groups`, pagination);
+    getPlayerGroups(username, pagination) {
+        return this.getRequest(`/players/${username}/groups`, pagination);
     }
     /**
      * 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(player, options) {
-        return this.getRequest(`${getPlayerURL(player)}/gained`, options);
+    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(player, options) {
-        return this.getRequest(`${getPlayerURL(player)}/gained`, Object.assign(Object.assign({}, options), { formatting: 'array' }));
+    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.
      */
-    getPlayerRecords(player, options) {
-        return this.getRequest(`${getPlayerURL(player)}/records`, options);
+    getPlayerRecords(username, options) {
+        return this.getRequest(`/players/${username}/records`, options);
     }
     /**
      * Fetches all of the player's past snapshots.
      * @returns A list of snapshots.
      */
-    getPlayerSnapshots(player, options, pagination) {
-        return this.getRequest(`${getPlayerURL(player)}/snapshots`, Object.assign(Object.assign({}, options), pagination));
+    getPlayerSnapshots(username, options, pagination) {
+        return this.getRequest(`/players/${username}/snapshots`, Object.assign(Object.assign({}, options), pagination));
     }
     /**
      * Fetches all of the player's approved name changes.
      * @returns A list of name changes.
      */
-    getPlayerNames(player) {
-        return this.getRequest(`${getPlayerURL(player)}/names`);
-    }
-}
-function getPlayerURL(player) {
-    if (typeof player === 'string') {
-        return `/players/${player}`;
-    }
-    if (player.id) {
-        return `/players/id/${player.id}`;
+    getPlayerNames(username) {
+        return this.getRequest(`/players/${username}/names`);
     }
-    return `/players/${player.username}`;
 }
 
 class RecordsClient extends BaseAPIClient {

package/package.json

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