@wise-old-man/utils 2.0.2 → 2.0.5

package/dist/index.d.ts

@@ -1677,8 +1677,9 @@ 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 getMetricRankKey<T extends Metric>(metric: T): `${T}Rank`;
+declare type MetricValueKey = `${Skill}Experience` | `${Boss}Kills` | `${Activity}Score` | `${ComputedMetric}Value`;
+declare function getMetricValueKey(metric: Metric): MetricValueKey;
 declare function getMetricMeasure(metric: Metric): MetricMeasure;
 declare function getMetricName(metric: Metric): string;
 declare function getMinimumValue(metric: Metric): number;
@@ -1752,10 +1753,7 @@ interface CreateGroupResponse {
     group: GroupDetails;
     verificationCode: string;
 }
-interface ChangeMemberRolePayload {
-    username: string;
-    role: GroupRole;
-}
+declare type ChangeMemberRolePayload = Required<GroupMemberFragment>;
 declare type GetGroupGainsFilter = {
     metric: Metric;
 } & TimeRangeFilter;
@@ -1808,11 +1806,17 @@ declare type NameChangesSearchFilter = {
  */
 interface RecordLeaderboardFilter extends BasePlayerFilter {
     metric: Metric;
-    period: Period | string;
+    period: Period;
 }
 /**
  * Player Client Types
  */
+interface PlayerCompetitionsFilter {
+    status?: CompetitionStatus;
+}
+interface PlayerCompetitionStandingsFilter {
+    status: Exclude<CompetitionStatus, CompetitionStatus.UPCOMING>;
+}
 interface PlayerRecordsFilter {
     period: Period | string;
     metric: Metric;
@@ -1982,12 +1986,12 @@ declare class PlayersClient extends BaseAPIClient {
      * Fetches all of the player's competition participations.
      * @returns A list of participations, with the respective competition included.
      */
-    getPlayerCompetitions(player: PlayerResolvable, pagination?: PaginationOptions): Promise<ParticipationWithCompetition[]>;
+    getPlayerCompetitions(player: PlayerResolvable, 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): Promise<ParticipationWithCompetitionAndStandings[]>;
+    getPlayerCompetitionStandings(player: PlayerResolvable, filter: PlayerCompetitionsFilter): Promise<ParticipationWithCompetitionAndStandings[]>;
     /**
      * Fetches all of the player's group memberships.
      * @returns A list of memberships, with the respective group included.
@@ -2012,7 +2016,7 @@ declare class PlayersClient extends BaseAPIClient {
      * Fetches all of the player's past snapshots.
      * @returns A list of snapshots.
      */
-    getPlayerSnapshots(player: PlayerResolvable, options?: TimeRangeFilter): Promise<FormattedSnapshot[]>;
+    getPlayerSnapshots(player: PlayerResolvable, options?: TimeRangeFilter, pagination?: PaginationOptions): Promise<FormattedSnapshot[]>;
     /**
      * Fetches all of the player's approved name changes.
      * @returns A list of name changes.
@@ -2139,4 +2143,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, MigrationDataSource, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, 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, 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, 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 };

package/dist/index.js

@@ -363,15 +363,15 @@ class PlayersClient extends BaseAPIClient {
      * Fetches all of the player's competition participations.
      * @returns A list of participations, with the respective competition included.
      */
-    getPlayerCompetitions(player, pagination) {
-        return this.getRequest(`${getPlayerURL(player)}/competitions`, pagination);
+    getPlayerCompetitions(player, filter, pagination) {
+        return this.getRequest(`${getPlayerURL(player)}/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) {
-        return this.getRequest(`${getPlayerURL(player)}/competitions/standings`);
+    getPlayerCompetitionStandings(player, filter) {
+        return this.getRequest(`${getPlayerURL(player)}/competitions/standings`, filter);
     }
     /**
      * Fetches all of the player's group memberships.
@@ -405,8 +405,8 @@ class PlayersClient extends BaseAPIClient {
      * Fetches all of the player's past snapshots.
      * @returns A list of snapshots.
      */
-    getPlayerSnapshots(player, options) {
-        return this.getRequest(`${getPlayerURL(player)}/snapshots`, options);
+    getPlayerSnapshots(player, options, pagination) {
+        return this.getRequest(`${getPlayerURL(player)}/snapshots`, Object.assign(Object.assign({}, options), pagination));
     }
     /**
      * Fetches all of the player's approved name changes.
@@ -1925,8 +1925,18 @@ function isComputedMetric(metric) {
 function getMetricRankKey(metric) {
     return `${metric}Rank`;
 }
+// Maybe someday I'll be good enough with TS to restrict the return type to the input metric type
 function getMetricValueKey(metric) {
-    return `${metric}${lodash.capitalize(MetricProps[metric].measure)}`;
+    if (isSkill(metric)) {
+        return `${metric}Experience`;
+    }
+    if (isBoss(metric)) {
+        return `${metric}Kills`;
+    }
+    if (isActivity(metric)) {
+        return `${metric}Score`;
+    }
+    return `${metric}Value`;
 }
 function getMetricMeasure(metric) {
     return MetricProps[metric].measure;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise-old-man/utils",
-  "version": "2.0.2",
+  "version": "2.0.5",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,6 +8,7 @@
     "dist"
   ],
   "scripts": {
+    "lint": "eslint . --ext .ts",
     "prepublish": "npm run build",
     "prebuild": "cd ../server && npm run prisma:generate",
     "build": "rm -rf ./dist && npx rollup -c && node prisma-transform.js && tsc dist/index.d.ts"
@@ -17,9 +18,12 @@
   "license": "ISC",
   "devDependencies": {
     "@rollup/plugin-typescript": "^8.3.4",
-    "@typescript-eslint/eslint-plugin": "^5.34.0",
-    "@typescript-eslint/parser": "^5.34.0",
-    "eslint": "^8.22.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/parser": "^5.40.1",
+    "eslint": "^8.26.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.7.1",
     "rollup": "^2.78.0",
     "rollup-plugin-dts": "^4.2.2",
     "tslib": "^2.4.0",