@wise-old-man/utils 3.1.9 → 3.1.11

package/dist/index.d.ts

@@ -19,6 +19,15 @@ export type MemberActivity = {
   createdAt: Date;
 };
 
+export type PlayerArchive = {
+  playerId: number;
+  previousUsername: string;
+  archiveUsername: string;
+  restoredUsername: string | null;
+  createdAt: Date;
+  restoredAt: Date | null;
+};
+
 type Prisma_Base_GroupSocialLinks = {
   id: number;
   groupId: number;
@@ -1533,6 +1542,9 @@ interface FlaggedPlayerReviewContext {
         rejectedRank: number;
     };
 }
+declare type PlayerArchiveWithPlayer = PlayerArchive & {
+    player: Player;
+};
 
 declare type RecordLeaderboardEntry = Record & {
     player: Player;
@@ -1547,6 +1559,11 @@ declare enum CompetitionStatus {
     ONGOING = "ongoing",
     FINISHED = "finished"
 }
+declare enum CompetitionCSVTableType {
+    TEAM = "team",
+    TEAMS = "teams",
+    PARTICIPANTS = "participants"
+}
 declare const CompetitionTypeProps: MapOf<CompetitionType, {
     name: string;
 }>;
@@ -1734,6 +1751,7 @@ declare const REAL_SKILLS: Skill[];
 declare const F2P_BOSSES: Boss[];
 declare const MEMBER_SKILLS: Skill[];
 declare const COMBAT_SKILLS: Skill[];
+declare const REAL_METRICS: (Skill | Activity | Boss)[];
 declare function findMetric(metricName: string): Metric | null;
 declare function isMetric(metric: Metric | string): metric is Metric;
 declare function isSkill(metric: Metric | string): metric is Skill;
@@ -1842,6 +1860,11 @@ interface CompetitionsSearchFilter {
     type?: CompetitionType;
     status?: CompetitionStatus;
 }
+declare type CompetitionDetailsCSVParams = {
+    previewMetric?: Metric;
+    teamName?: string;
+    table?: CompetitionCSVTableType;
+};
 declare type CreateCompetitionPayload = {
     title: string;
     metric: Metric;
@@ -1922,11 +1945,14 @@ declare class BaseAPIClient {
     private baseUrl;
     constructor(headers: object, baseUrl: string);
     private buildParams;
+    private fetch;
     private request;
+    private requestText;
     postRequest<T>(path: string, body?: unknown): Promise<T>;
     putRequest<T>(path: string, body?: unknown): Promise<T>;
     deleteRequest<T>(path: string, body?: unknown): Promise<T>;
     getRequest<T>(path: string, params?: unknown): Promise<T>;
+    getText(path: string, params?: unknown): Promise<string>;
 }
 
 declare class DeltasClient extends BaseAPIClient {
@@ -2024,6 +2050,11 @@ declare class GroupsClient extends BaseAPIClient {
      * @returns A list of a group's (join, leave and role changed) activity.
      */
     getGroupActivity(id: number, pagination?: PaginationOptions): Promise<MemberActivityWithPlayer[]>;
+    /**
+     * Fetches the groups's member list in CSV format.
+     * @returns A string containing the CSV content.
+     */
+    getMembersCSV(id: number): Promise<string>;
 }
 
 declare class PlayersClient extends BaseAPIClient {
@@ -2111,6 +2142,11 @@ declare class PlayersClient extends BaseAPIClient {
      * @returns A list of name changes.
      */
     getPlayerNames(username: string): Promise<NameChange[]>;
+    /**
+     * Fetches all of archived players that previously held this username.
+     * @returns A list of player archives.
+     */
+    getPlayerArchives(username: string): Promise<PlayerArchiveWithPlayer[]>;
 }
 
 declare class RecordsClient extends BaseAPIClient {
@@ -2163,6 +2199,11 @@ declare class CompetitionsClient extends BaseAPIClient {
      * @returns A competition with a list of participants.
      */
     getCompetitionDetails(id: number, previewMetric?: Metric): Promise<CompetitionDetails>;
+    /**
+     * Fetches the competition's participant list in CSV format.
+     * @returns A string containing the CSV content.
+     */
+    getCompetitionDetailsCSV(id: number, params?: CompetitionDetailsCSVParams): Promise<string>;
     /**
      * Fetches all the values (exp, kc, etc) in chronological order within the bounds
      * of the competition, for the top 5 participants.
@@ -2227,4 +2268,4 @@ declare class WOMClient extends BaseAPIClient {
     constructor(options?: WOMClientOptions);
 }
 
-export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityType, ActivityValue, ActivityValueWithPlayer, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, BossValueWithPlayer, 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, ComputedMetricValueWithPlayer, Country, CountryDetails, CountryProps, CreateCompetitionPayload, CreateCompetitionResponse, CreateGroupPayload, CreateGroupResponse, DeltaGroupLeaderboardEntry, DeltaLeaderboardEntry, DeltaLeaderboardFilter, DenyContext, EditCompetitionPayload, EditGroupPayload, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyAlgorithmTypeUnion, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, ExtendedAchievementWithPlayer, F2P_BOSSES, FlaggedPlayerReviewContext, 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, MemberActivityWithPlayer, MemberInput, MemberJoinedEvent, MemberLeftEvent, MemberRoleChangeEvent, MembershipWithGroup, MembershipWithPlayer, Metric, MetricLeaders, MetricMeasure, MetricProps, MetricType, MetricValueKey, MigrationDataSource, NameChange, NameChangeDetails, NameChangeStatus, NameChangeWithPlayer, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerCompetitionStandingsFilter, PlayerCompetitionsFilter, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, SkillMetaMethod, SkillValue, SkillValueWithPlayer, SkipContext, 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, isPlayerStatus, isPlayerType, isSkill, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };
+export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityType, ActivityValue, ActivityValueWithPlayer, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, BossValueWithPlayer, CAPPED_MAX_TOTAL_XP, CMLGroupData, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, ChangeMemberRolePayload, CompetitionCSVTableType, CompetitionDetails, CompetitionDetailsCSVParams, CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, CompetitionWithParticipations, CompetitionsSearchFilter, ComputedMetric, ComputedMetricDelta, ComputedMetricValue, ComputedMetricValueWithPlayer, Country, CountryDetails, CountryProps, CreateCompetitionPayload, CreateCompetitionResponse, CreateGroupPayload, CreateGroupResponse, DeltaGroupLeaderboardEntry, DeltaLeaderboardEntry, DeltaLeaderboardFilter, DenyContext, EditCompetitionPayload, EditGroupPayload, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyAlgorithmTypeUnion, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, ExtendedAchievementWithPlayer, F2P_BOSSES, FlaggedPlayerReviewContext, 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, MemberActivityWithPlayer, MemberInput, MemberJoinedEvent, MemberLeftEvent, MemberRoleChangeEvent, MembershipWithGroup, MembershipWithPlayer, Metric, MetricLeaders, MetricMeasure, MetricProps, MetricType, MetricValueKey, MigrationDataSource, NameChange, NameChangeDetails, NameChangeStatus, NameChangeWithPlayer, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithCompetitionAndStandings, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerArchiveWithPlayer, PlayerBuild, PlayerBuildProps, PlayerCompetitionStandingsFilter, PlayerCompetitionsFilter, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, SkillMetaMethod, SkillValue, SkillValueWithPlayer, SkipContext, 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, isPlayerStatus, isPlayerType, isSkill, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };

package/dist/index.js

@@ -147,7 +147,7 @@ class BaseAPIClient {
         const query = builder.toString();
         return query ? `?${query}` : '';
     }
-    request({ method, path, body, params }) {
+    fetch({ method, path, body, params }) {
         return __awaiter(this, void 0, void 0, function* () {
             const req = { method, body: undefined, headers: this.headers };
             let query = '';
@@ -157,7 +157,12 @@ class BaseAPIClient {
             if (params) {
                 query = this.buildParams(params);
             }
-            const res = yield fetch(this.baseUrl + path + query, req);
+            return yield fetch(this.baseUrl + path + query, req);
+        });
+    }
+    request({ method, path, body, params }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.fetch({ method, path, body, params });
             const data = yield res.json();
             if (res.ok) {
                 return transformDates(data);
@@ -165,6 +170,16 @@ class BaseAPIClient {
             handleError(res.status, path, data);
         });
     }
+    requestText({ method, path, body, params }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.fetch({ method, path, body, params });
+            const text = yield res.text();
+            if (res.ok) {
+                return text;
+            }
+            handleError(res.status, path, JSON.parse(text));
+        });
+    }
     postRequest(path, body) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.request({ method: 'POST', path, body: body || {} });
@@ -185,6 +200,11 @@ class BaseAPIClient {
             return yield this.request({ method: 'GET', path, params });
         });
     }
+    getText(path, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.requestText({ method: 'GET', path, params });
+        });
+    }
 }
 
 class DeltasClient extends BaseAPIClient {
@@ -321,6 +341,13 @@ class GroupsClient extends BaseAPIClient {
     getGroupActivity(id, pagination) {
         return this.getRequest(`/groups/${id}/activity`, Object.assign({}, pagination));
     }
+    /**
+     * Fetches the groups's member list in CSV format.
+     * @returns A string containing the CSV content.
+     */
+    getMembersCSV(id) {
+        return this.getText(`/groups/${id}/csv`);
+    }
 }
 
 class PlayersClient extends BaseAPIClient {
@@ -436,6 +463,13 @@ class PlayersClient extends BaseAPIClient {
     getPlayerNames(username) {
         return this.getRequest(`/players/${username}/names`);
     }
+    /**
+     * Fetches all of archived players that previously held this username.
+     * @returns A list of player archives.
+     */
+    getPlayerArchives(username) {
+        return this.getRequest(`/players/${username}/archives`);
+    }
 }
 
 class RecordsClient extends BaseAPIClient {
@@ -1169,6 +1203,12 @@ exports.CompetitionStatus = void 0;
     CompetitionStatus["ONGOING"] = "ongoing";
     CompetitionStatus["FINISHED"] = "finished";
 })(exports.CompetitionStatus || (exports.CompetitionStatus = {}));
+exports.CompetitionCSVTableType = void 0;
+(function (CompetitionCSVTableType) {
+    CompetitionCSVTableType["TEAM"] = "team";
+    CompetitionCSVTableType["TEAMS"] = "teams";
+    CompetitionCSVTableType["PARTICIPANTS"] = "participants";
+})(exports.CompetitionCSVTableType || (exports.CompetitionCSVTableType = {}));
 const CompetitionTypeProps = {
     [CompetitionType.CLASSIC]: { name: 'Classic' },
     [CompetitionType.TEAM]: { name: 'Team' }
@@ -1530,10 +1570,10 @@ function mapValues(obj, callback) {
 const GROUP_ROLES = Object.values(GroupRole);
 const PRIVELEGED_GROUP_ROLES = [
     GroupRole.ADMINISTRATOR,
-    GroupRole.DEPUTY_OWNER,
+    GroupRole.OWNER,
     GroupRole.LEADER,
-    GroupRole.MODERATOR,
-    GroupRole.OWNER
+    GroupRole.DEPUTY_OWNER,
+    GroupRole.MODERATOR
 ];
 const GroupRoleProps = mapValues({
     [GroupRole.ACHIEVER]: { name: 'Achiever' },
@@ -1919,7 +1959,7 @@ const BossProps = mapValues({
     [Boss.ZULRAH]: { name: 'Zulrah' }
 }, props => (Object.assign(Object.assign({}, props), { type: exports.MetricType.BOSS, measure: exports.MetricMeasure.KILLS, isMembers: 'isMembers' in props ? props.isMembers : true, minimumValue: 'minimumValue' in props ? props.minimumValue : 5 })));
 const ActivityProps = mapValues({
-    [Activity.LEAGUE_POINTS]: { name: 'League Points' },
+    [Activity.LEAGUE_POINTS]: { name: 'League Points', minimumValue: 100 },
     [Activity.BOUNTY_HUNTER_HUNTER]: { name: 'Bounty Hunter (Hunter)', minimumValue: 2 },
     [Activity.BOUNTY_HUNTER_ROGUE]: { name: 'Bounty Hunter (Rogue)', minimumValue: 2 },
     [Activity.CLUE_SCROLLS_ALL]: { name: 'Clue Scrolls (All)' },
@@ -1948,6 +1988,7 @@ 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);
 const COMBAT_SKILLS = SKILLS.filter(s => MetricProps[s].isCombat);
+const REAL_METRICS = [...SKILLS, ...BOSSES, ...ACTIVITIES];
 function findMetric(metricName) {
     for (const [key, value] of Object.entries(MetricProps)) {
         if (value.name.toUpperCase() === metricName.toUpperCase())
@@ -2483,6 +2524,13 @@ class CompetitionsClient extends BaseAPIClient {
     getCompetitionDetails(id, previewMetric) {
         return this.getRequest(`/competitions/${id}`, { metric: previewMetric });
     }
+    /**
+     * Fetches the competition's participant list in CSV format.
+     * @returns A string containing the CSV content.
+     */
+    getCompetitionDetailsCSV(id, params) {
+        return this.getText(`/competitions/${id}/csv`, Object.assign({ metric: params.previewMetric }, params));
+    }
     /**
      * Fetches all the values (exp, kc, etc) in chronological order within the bounds
      * of the competition, for the top 5 participants.
@@ -2627,6 +2675,7 @@ exports.PlayerStatus = PlayerStatus;
 exports.PlayerStatusProps = PlayerStatusProps;
 exports.PlayerType = PlayerType;
 exports.PlayerTypeProps = PlayerTypeProps;
+exports.REAL_METRICS = REAL_METRICS;
 exports.REAL_SKILLS = REAL_SKILLS;
 exports.SKILLS = SKILLS;
 exports.SKILL_EXP_AT_99 = SKILL_EXP_AT_99;

package/package.json

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