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

package/dist/index.d.ts

@@ -388,6 +388,7 @@ export type Prisma_Base_Snapshot = {
 
 
 
+import { AxiosInstance } from 'axios';
 
 /**
  * Prisma currently seems to ignore the @map() in enum declarations.
@@ -1558,7 +1559,7 @@ interface FormattedSnapshot {
 interface GroupListItem extends Omit<Group, 'verificationHash'> {
     memberCount: number;
 }
-interface GroupWithMemberships extends GroupListItem {
+interface GroupDetails extends GroupListItem {
     memberships: MembershipWithPlayer[];
 }
 interface MembershipWithGroup extends Membership {
@@ -1762,7 +1763,7 @@ interface CreateGroupPayload {
 }
 declare type EditGroupPayload = Partial<CreateGroupPayload>;
 interface CreateGroupResponse {
-    group: GroupWithMemberships;
+    group: GroupDetails;
     verificationCode: string;
 }
 interface ChangeMemberRolePayload {
@@ -1854,7 +1855,16 @@ interface DeltaLeaderboardFilter extends BasePlayerFilter {
     period: Period | string;
 }
 
-declare class DeltasClient {
+declare class BaseAPIClient {
+    private axiosInstance;
+    constructor(axiosInstance: AxiosInstance);
+    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>;
+}
+
+declare class DeltasClient extends BaseAPIClient {
     /**
      * Fetches the current top leaderboard for a specific metric, period, playerType, playerBuild and country.
      * @returns A list of deltas, with their respective players, values and dates included.
@@ -1862,27 +1872,22 @@ declare class DeltasClient {
     getDeltaLeaderboard(filter: DeltaLeaderboardFilter): Promise<DeltaLeaderboardEntry[]>;
 }
 
-declare type PaginationOptions = Partial<{
-    limit: number;
-    offset: number;
-}>;
+interface PaginationOptions {
+    limit?: number;
+    offset?: number;
+}
 
-declare class GroupsClient {
+declare class GroupsClient extends BaseAPIClient {
     /**
      * Searches for groups that match a partial name.
      * @returns A list of groups.
      */
     searchGroups(name: string, pagination?: PaginationOptions): Promise<GroupListItem[]>;
     /**
-     * Fetches a group's details.
+     * Fetches a group's details, including a list of membership objects.
      * @returns A group details object.
      */
-    getGroupDetails(id: number): Promise<GroupListItem>;
-    /**
-     * Fetches a group's entire members list.
-     * @returns A list of memberships, with players included.
-     */
-    getGroupMembers(id: number): Promise<MembershipWithPlayer[]>;
+    getGroupDetails(id: number): Promise<GroupDetails>;
     /**
      * Creates a new group.
      * @returns The newly created group, and the verification code that authorizes future changes to it.
@@ -1892,7 +1897,7 @@ declare class GroupsClient {
      * Edits an existing group.
      * @returns The updated group.
      */
-    editGroup(id: number, payload: EditGroupPayload, verificationCode: string): Promise<GroupWithMemberships>;
+    editGroup(id: number, payload: EditGroupPayload, verificationCode: string): Promise<GroupDetails>;
     /**
      * Deletes an existing group.
      * @returns A confirmation message.
@@ -1951,7 +1956,7 @@ declare class GroupsClient {
     getGroupStatistics(id: number): Promise<GroupStatistics>;
 }
 
-declare class PlayersClient {
+declare class PlayersClient extends BaseAPIClient {
     /**
      * Searches players by partial username.
      * @returns A list of players.
@@ -2024,7 +2029,7 @@ declare class PlayersClient {
     getPlayerNames(player: PlayerResolvable): Promise<NameChange[]>;
 }
 
-declare class RecordsClient {
+declare class RecordsClient extends BaseAPIClient {
     /**
      * Fetches the current records leaderboard for a specific metric, period, playerType, playerBuild and country.
      * @returns A list of records, with their respective players, dates and values included.
@@ -2032,7 +2037,7 @@ declare class RecordsClient {
     getRecordLeaderboard(filter: RecordLeaderboardFilter): Promise<RecordLeaderboardEntry[]>;
 }
 
-declare class EfficiencyClient {
+declare class EfficiencyClient extends BaseAPIClient {
     /**
      * Fetches the current efficiency leaderboard for a specific efficiency metric, playerType, playerBuild and country.
      * @returns A list of players.
@@ -2050,7 +2055,7 @@ declare class EfficiencyClient {
     getEHBRates(algorithmType: EfficiencyAlgorithmTypeUnion): Promise<BossMetaConfig[]>;
 }
 
-declare class NameChangesClient {
+declare class NameChangesClient extends BaseAPIClient {
     /**
      * Searches for name changes that match a name and/or status filter.
      * @returns A list of name changes.
@@ -2068,7 +2073,7 @@ declare class NameChangesClient {
     getNameChangeDetails(id: number): Promise<NameChangeDetails>;
 }
 
-declare class CompetitionsClient {
+declare class CompetitionsClient extends BaseAPIClient {
     /**
      * Searches for competitions that match a title, type, metric and status filter.
      * @returns A list of competitions.
@@ -2127,6 +2132,11 @@ declare class CompetitionsClient {
     updateAll(id: number, verificationCode: string): Promise<GenericCountMessageResponse>;
 }
 
+interface WOMClientOptions {
+    apiKey?: string;
+    userAgent?: string;
+    baseAPIUrl?: string;
+}
 declare class WOMClient {
     deltas: DeltasClient;
     groups: GroupsClient;
@@ -2135,7 +2145,7 @@ declare class WOMClient {
     efficiency: EfficiencyClient;
     nameChanges: NameChangesClient;
     competitions: CompetitionsClient;
-    constructor();
+    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, 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 };
+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, 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

@@ -4,14 +4,19 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var axios = require('axios');
 var dayjs = require('dayjs');
-var customParseFormaPlugin = require('dayjs/plugin/customParseFormat');
+var customParseFormatPlugin = require('dayjs/plugin/customParseFormat');
 var lodash = require('lodash');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 var dayjs__default = /*#__PURE__*/_interopDefaultLegacy(dayjs);
-var customParseFormaPlugin__default = /*#__PURE__*/_interopDefaultLegacy(customParseFormaPlugin);
+var customParseFormatPlugin__default = /*#__PURE__*/_interopDefaultLegacy(customParseFormatPlugin);
+
+var config = {
+    defaultUserAgent: `WiseOldMan JS Client v${process.env.npm_package_version}`,
+    baseAPIUrl: 'https://api.wiseoldman.net/v2'
+};
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -38,12 +43,7 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
-var config = {
-    // apiBaseUrl: 'http://localhost:5001'
-    apiBaseUrl: 'https://api.wiseoldman.net/v2'
-};
-
-dayjs__default["default"].extend(customParseFormaPlugin__default["default"]);
+dayjs__default["default"].extend(customParseFormatPlugin__default["default"]);
 function traverseTransform(input, transformation) {
     if (Array.isArray(input)) {
         return input.map(item => traverseTransform(item, transformation));
@@ -84,58 +84,6 @@ function handleError(requestURL, e) {
         throw new InternalServerError(requestURL, data.message);
     }
 }
-function sendPostRequest(path, body) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const requestURL = `${config.apiBaseUrl}${path}`;
-        return axios__default["default"]
-            .post(requestURL, body || {})
-            .then(response => transformDates(response.data))
-            .catch(e => {
-            if (axios__default["default"].isAxiosError(e))
-                handleError(requestURL, e);
-            throw e;
-        });
-    });
-}
-function sendPutRequest(path, body) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const requestURL = `${config.apiBaseUrl}${path}`;
-        return axios__default["default"]
-            .put(requestURL, body || {})
-            .then(response => transformDates(response.data))
-            .catch(e => {
-            if (axios__default["default"].isAxiosError(e))
-                handleError(requestURL, e);
-            throw e;
-        });
-    });
-}
-function sendDeleteRequest(path, body) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const requestURL = `${config.apiBaseUrl}${path}`;
-        return axios__default["default"]
-            .delete(requestURL, { data: body })
-            .then(response => transformDates(response.data))
-            .catch(e => {
-            if (axios__default["default"].isAxiosError(e))
-                handleError(requestURL, e);
-            throw e;
-        });
-    });
-}
-function sendGetRequest(path, params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const requestURL = `${config.apiBaseUrl}${path}`;
-        return axios__default["default"]
-            .get(requestURL, { params })
-            .then(response => transformDates(response.data))
-            .catch(e => {
-            if (axios__default["default"].isAxiosError(e))
-                handleError(requestURL, e);
-            throw e;
-        });
-    });
-}
 class BadRequestError extends Error {
     constructor(resource, message, data) {
         super(message);
@@ -178,65 +126,112 @@ class InternalServerError extends Error {
     }
 }
 
-class DeltasClient {
+class BaseAPIClient {
+    constructor(axiosInstance) {
+        this.axiosInstance = axiosInstance;
+    }
+    postRequest(path, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.axiosInstance
+                .post(path, body || {})
+                .then(response => transformDates(response.data))
+                .catch(e => {
+                if (axios__default["default"].isAxiosError(e))
+                    handleError(path, e);
+                throw e;
+            });
+        });
+    }
+    putRequest(path, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.axiosInstance
+                .put(path, body || {})
+                .then(response => transformDates(response.data))
+                .catch(e => {
+                if (axios__default["default"].isAxiosError(e))
+                    handleError(path, e);
+                throw e;
+            });
+        });
+    }
+    deleteRequest(path, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.axiosInstance
+                .delete(path, { data: body })
+                .then(response => transformDates(response.data))
+                .catch(e => {
+                if (axios__default["default"].isAxiosError(e))
+                    handleError(path, e);
+                throw e;
+            });
+        });
+    }
+    getRequest(path, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.axiosInstance
+                .get(path, { params })
+                .then(response => transformDates(response.data))
+                .catch(e => {
+                if (axios__default["default"].isAxiosError(e))
+                    handleError(path, e);
+                throw e;
+            });
+        });
+    }
+}
+
+class DeltasClient extends BaseAPIClient {
     /**
      * Fetches the current top leaderboard for a specific metric, period, playerType, playerBuild and country.
      * @returns A list of deltas, with their respective players, values and dates included.
      */
     getDeltaLeaderboard(filter) {
-        return sendGetRequest('/deltas/leaderboard', filter);
+        return this.getRequest('/deltas/leaderboard', filter);
     }
 }
 
-class GroupsClient {
+class GroupsClient extends BaseAPIClient {
     /**
      * Searches for groups that match a partial name.
      * @returns A list of groups.
      */
     searchGroups(name, pagination) {
-        return sendGetRequest('/groups', Object.assign({ name }, pagination));
+        return this.getRequest('/groups', Object.assign({ name }, pagination));
     }
     /**
-     * Fetches a group's details.
+     * Fetches a group's details, including a list of membership objects.
      * @returns A group details object.
      */
     getGroupDetails(id) {
-        return sendGetRequest(`/groups/${id}`);
-    }
-    /**
-     * Fetches a group's entire members list.
-     * @returns A list of memberships, with players included.
-     */
-    getGroupMembers(id) {
-        return sendGetRequest(`/groups/${id}/members`);
+        return this.getRequest(`/groups/${id}`);
     }
     /**
      * Creates a new group.
      * @returns The newly created group, and the verification code that authorizes future changes to it.
      */
     createGroup(payload) {
-        return sendPostRequest('/groups', payload);
+        return this.postRequest('/groups', payload);
     }
     /**
      * Edits an existing group.
      * @returns The updated group.
      */
     editGroup(id, payload, verificationCode) {
-        return sendPutRequest(`/groups/${id}`, Object.assign(Object.assign({}, payload), { verificationCode }));
+        return this.putRequest(`/groups/${id}`, Object.assign(Object.assign({}, payload), { verificationCode }));
     }
     /**
      * Deletes an existing group.
      * @returns A confirmation message.
      */
     deleteGroup(id, verificationCode) {
-        return sendDeleteRequest(`/groups/${id}`, { verificationCode });
+        return this.deleteRequest(`/groups/${id}`, { verificationCode });
     }
     /**
      * Adds all (valid) given usernames (and roles) to a group, ignoring duplicates.
      * @returns The number of members added and a confirmation message.
      */
     addMembers(id, members, verificationCode) {
-        return sendPostRequest(`/groups/${id}/members`, {
+        return this.postRequest(`/groups/${id}/members`, {
             verificationCode,
             members
         });
@@ -246,7 +241,7 @@ class GroupsClient {
      * @returns The number of members removed and a confirmation message.
      */
     removeMembers(id, usernames, verificationCode) {
-        return sendDeleteRequest(`/groups/${id}/members`, {
+        return this.deleteRequest(`/groups/${id}/members`, {
             verificationCode,
             members: usernames
         });
@@ -256,14 +251,14 @@ class GroupsClient {
      * @returns The updated membership, with player included.
      */
     changeRole(id, payload, verificationCode) {
-        return sendPutRequest(`/groups/${id}/role`, Object.assign(Object.assign({}, payload), { verificationCode }));
+        return this.putRequest(`/groups/${id}/role`, Object.assign(Object.assign({}, payload), { verificationCode }));
     }
     /**
      * Adds an "update" request to the queue, for each outdated group member.
      * @returns The number of players to be updated and a confirmation message.
      */
     updateAll(id, verificationCode) {
-        return sendPostRequest(`/groups/${id}/update-all`, {
+        return this.postRequest(`/groups/${id}/update-all`, {
             verificationCode
         });
     }
@@ -272,146 +267,146 @@ class GroupsClient {
      * @returns A list of competitions.
      */
     getGroupCompetitions(id, pagination) {
-        return sendGetRequest(`/groups/${id}/competitions`, Object.assign({}, pagination));
+        return this.getRequest(`/groups/${id}/competitions`, Object.assign({}, pagination));
     }
     getGroupGains(id, filter, pagination) {
-        return sendGetRequest(`/groups/${id}/gained`, Object.assign(Object.assign({}, pagination), filter));
+        return this.getRequest(`/groups/${id}/gained`, Object.assign(Object.assign({}, pagination), filter));
     }
     /**
      * Fetches a group members' latest achievements.
      * @returns A list of achievements.
      */
     getGroupAchievements(id, pagination) {
-        return sendGetRequest(`/groups/${id}/achievements`, Object.assign({}, pagination));
+        return this.getRequest(`/groups/${id}/achievements`, Object.assign({}, pagination));
     }
     /**
      * Fetches a group's record leaderboard for a specific metric and period.
      * @returns A list of records, including their respective players.
      */
     getGroupRecords(id, filter, pagination) {
-        return sendGetRequest(`/groups/${id}/records`, Object.assign(Object.assign({}, pagination), filter));
+        return this.getRequest(`/groups/${id}/records`, Object.assign(Object.assign({}, pagination), filter));
     }
     /**
      * Fetches a group's hiscores for a specific metric.
      * @returns A list of hiscores entries (value, rank), including their respective players.
      */
     getGroupHiscores(id, metric, pagination) {
-        return sendGetRequest(`/groups/${id}/hiscores`, Object.assign(Object.assign({}, pagination), { metric }));
+        return this.getRequest(`/groups/${id}/hiscores`, Object.assign(Object.assign({}, pagination), { metric }));
     }
     /**
      * Fetches a group members' latest name changes.
      * @returns A list of name change (approved) requests.
      */
     getGroupNameChanges(id, pagination) {
-        return sendGetRequest(`/groups/${id}/name-changes`, Object.assign({}, pagination));
+        return this.getRequest(`/groups/${id}/name-changes`, Object.assign({}, pagination));
     }
     /**
      * Fetches a group's general statistics.
      * @returns An object with a few statistic values and an average stats snapshot.
      */
     getGroupStatistics(id) {
-        return sendGetRequest(`/groups/${id}/statistics`);
+        return this.getRequest(`/groups/${id}/statistics`);
     }
 }
 
-class PlayersClient {
+class PlayersClient extends BaseAPIClient {
     /**
      * Searches players by partial username.
      * @returns A list of players.
      */
     searchPlayers(partialUsername, pagination) {
-        return sendGetRequest('/players/search', Object.assign({ username: partialUsername }, pagination));
+        return this.getRequest('/players/search', Object.assign({ username: partialUsername }, pagination));
     }
     /**
      * Updates/tracks a player.
      * @returns The player's new details, including the latest snapshot.
      */
     updatePlayer(player) {
-        return sendPostRequest(getPlayerURL(player));
+        return this.postRequest(getPlayerURL(player));
     }
     /**
      * 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 sendPostRequest(`${getPlayerURL(player)}/assert-type`);
+        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 sendPostRequest(`${getPlayerURL(player)}/import-history`);
+        return this.postRequest(`${getPlayerURL(player)}/import-history`);
     }
     /**
      * Fetches a player's details.
      * @returns The player's details, including the latest snapshot.
      */
     getPlayerDetails(player) {
-        return sendGetRequest(getPlayerURL(player));
+        return this.getRequest(getPlayerURL(player));
     }
     /**
      * Fetches a player's current achievements.
      * @returns A list of achievements.
      */
     getPlayerAchievements(player) {
-        return sendGetRequest(`${getPlayerURL(player)}/achievements`);
+        return this.getRequest(`${getPlayerURL(player)}/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 sendGetRequest(`${getPlayerURL(player)}/achievements/progress`);
+        return this.getRequest(`${getPlayerURL(player)}/achievements/progress`);
     }
     /**
      * Fetches all of the player's competition participations.
      * @returns A list of participations, with the respective competition included.
      */
     getPlayerCompetitions(player, pagination) {
-        return sendGetRequest(`${getPlayerURL(player)}/competitions`, pagination);
+        return this.getRequest(`${getPlayerURL(player)}/competitions`, pagination);
     }
     /**
      * Fetches all of the player's group memberships.
      * @returns A list of memberships, with the respective group included.
      */
     getPlayerGroups(player, pagination) {
-        return sendGetRequest(`${getPlayerURL(player)}/groups`, pagination);
+        return this.getRequest(`${getPlayerURL(player)}/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 sendGetRequest(`${getPlayerURL(player)}/gained`, options);
+        return this.getRequest(`${getPlayerURL(player)}/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 sendGetRequest(`${getPlayerURL(player)}/gained`, Object.assign(Object.assign({}, options), { formatting: 'array' }));
+        return this.getRequest(`${getPlayerURL(player)}/gained`, Object.assign(Object.assign({}, options), { formatting: 'array' }));
     }
     /**
      * Fetches all of the player's records.
      * @returns A list of records.
      */
     getPlayerRecords(player, options) {
-        return sendGetRequest(`${getPlayerURL(player)}/records`, options);
+        return this.getRequest(`${getPlayerURL(player)}/records`, options);
     }
     /**
      * Fetches all of the player's past snapshots.
      * @returns A list of snapshots.
      */
     getPlayerSnapshots(player, options) {
-        return sendGetRequest(`${getPlayerURL(player)}/snapshots`, options);
+        return this.getRequest(`${getPlayerURL(player)}/snapshots`, options);
     }
     /**
      * Fetches all of the player's approved name changes.
      * @returns A list of name changes.
      */
     getPlayerNames(player) {
-        return sendGetRequest(`${getPlayerURL(player)}/names`);
+        return this.getRequest(`${getPlayerURL(player)}/names`);
     }
 }
 function getPlayerURL(player) {
@@ -424,13 +419,13 @@ function getPlayerURL(player) {
     return `/players/${player.username}`;
 }
 
-class RecordsClient {
+class RecordsClient extends BaseAPIClient {
     /**
      * Fetches the current records leaderboard for a specific metric, period, playerType, playerBuild and country.
      * @returns A list of records, with their respective players, dates and values included.
      */
     getRecordLeaderboard(filter) {
-        return sendGetRequest('/records/leaderboard', filter);
+        return this.getRequest('/records/leaderboard', filter);
     }
 }
 
@@ -2324,68 +2319,71 @@ exports.SnapshotDataSource = void 0;
     SnapshotDataSource[SnapshotDataSource["CRYSTAL_MATH_LABS"] = 1] = "CRYSTAL_MATH_LABS";
 })(exports.SnapshotDataSource || (exports.SnapshotDataSource = {}));
 
-class EfficiencyClient {
+class EfficiencyClient extends BaseAPIClient {
     /**
      * Fetches the current efficiency leaderboard for a specific efficiency metric, playerType, playerBuild and country.
      * @returns A list of players.
      */
     getEfficiencyLeaderboards(filter, pagination) {
-        return sendGetRequest('/efficiency/leaderboard', Object.assign(Object.assign({}, filter), pagination));
+        return this.getRequest('/efficiency/leaderboard', Object.assign(Object.assign({}, filter), pagination));
     }
     /**
      * Fetches the top EHP (Efficient Hours Played) rates.
      * @returns A list of skilling methods and their bonus exp ratios.
      */
     getEHPRates(algorithmType) {
-        return sendGetRequest('/efficiency/rates', { metric: Metric.EHP, type: algorithmType });
+        return this.getRequest('/efficiency/rates', { metric: Metric.EHP, type: algorithmType });
     }
     /**
      * Fetches the top EHB (Efficient Hours Bossed) rates.
      * @returns A list of bosses and their respective "per-hour" kill rates.
      */
     getEHBRates(algorithmType) {
-        return sendGetRequest('/efficiency/rates', { metric: Metric.EHB, type: algorithmType });
+        return this.getRequest('/efficiency/rates', {
+            metric: Metric.EHB,
+            type: algorithmType
+        });
     }
 }
 
-class NameChangesClient {
+class NameChangesClient extends BaseAPIClient {
     /**
      * Searches for name changes that match a name and/or status filter.
      * @returns A list of name changes.
      */
     searchNameChanges(filter, pagination) {
-        return sendGetRequest('/names', Object.assign(Object.assign({}, filter), pagination));
+        return this.getRequest('/names', Object.assign(Object.assign({}, filter), pagination));
     }
     /**
      * Submits a name change request between two usernames (old and new).
      * @returns A pending name change request, to be reviewed and resolved at a later date.
      */
     submitNameChange(oldName, newName) {
-        return sendPostRequest('/names', { oldName, newName });
+        return this.postRequest('/names', { oldName, newName });
     }
     /**
      * Gets details on a specific name change request.
      * @returns The name change request's details, which includes all data required to review.
      */
     getNameChangeDetails(id) {
-        return sendGetRequest(`/names/${id}`);
+        return this.getRequest(`/names/${id}`);
     }
 }
 
-class CompetitionsClient {
+class CompetitionsClient extends BaseAPIClient {
     /**
      * Searches for competitions that match a title, type, metric and status filter.
      * @returns A list of competitions.
      */
     searchCompetitions(filter, pagination) {
-        return sendGetRequest('/competitions', Object.assign(Object.assign({}, filter), pagination));
+        return this.getRequest('/competitions', Object.assign(Object.assign({}, filter), pagination));
     }
     /**
      * Fetches the competition's full details, including all the participants and their progress.
      * @returns A competition with a list of participants.
      */
     getCompetitionDetails(id, previewMetric) {
-        return sendGetRequest(`/competitions/${id}`, { metric: previewMetric });
+        return this.getRequest(`/competitions/${id}`, { metric: previewMetric });
     }
     /**
      * Fetches all the values (exp, kc, etc) in chronological order within the bounds
@@ -2393,7 +2391,7 @@ class CompetitionsClient {
      * @returns A list of competition progress objects, including the player and their value history over time.
      */
     getCompetitionTopHistory(id, previewMetric) {
-        return sendGetRequest(`/competitions/${id}/top-history`, {
+        return this.getRequest(`/competitions/${id}/top-history`, {
             metric: previewMetric
         });
     }
@@ -2402,28 +2400,28 @@ class CompetitionsClient {
      * @returns The newly created competition, and the verification code that authorizes future changes to it.
      */
     createCompetition(payload) {
-        return sendPostRequest('/competitions', payload);
+        return this.postRequest('/competitions', payload);
     }
     /**
      * Edits an existing competition.
      * @returns The updated competition.
      */
     editCompetition(id, payload, verificationCode) {
-        return sendPutRequest(`/competitions/${id}`, Object.assign(Object.assign({}, payload), { verificationCode }));
+        return this.putRequest(`/competitions/${id}`, Object.assign(Object.assign({}, payload), { verificationCode }));
     }
     /**
      * Deletes an existing competition.
      * @returns A confirmation message.
      */
     deleteCompetition(id, verificationCode) {
-        return sendDeleteRequest(`/competitions/${id}`, { verificationCode });
+        return this.deleteRequest(`/competitions/${id}`, { verificationCode });
     }
     /**
      * Adds all (valid) given participants to a competition, ignoring duplicates.
      * @returns The number of participants added and a confirmation message.
      */
     addParticipants(id, participants, verificationCode) {
-        return sendPostRequest(`/competitions/${id}/participants`, {
+        return this.postRequest(`/competitions/${id}/participants`, {
             verificationCode,
             participants
         });
@@ -2433,7 +2431,7 @@ class CompetitionsClient {
      * @returns The number of participants removed and a confirmation message.
      */
     removeParticipants(id, participants, verificationCode) {
-        return sendDeleteRequest(`/competitions/${id}/participants`, {
+        return this.deleteRequest(`/competitions/${id}/participants`, {
             verificationCode,
             participants
         });
@@ -2443,7 +2441,7 @@ class CompetitionsClient {
      * @returns The number of participants added and a confirmation message.
      */
     addTeams(id, teams, verificationCode) {
-        return sendPostRequest(`/competitions/${id}/teams`, {
+        return this.postRequest(`/competitions/${id}/teams`, {
             verificationCode,
             teams
         });
@@ -2453,7 +2451,7 @@ class CompetitionsClient {
      * @returns The number of participants removed and a confirmation message.
      */
     removeTeams(id, teamNames, verificationCode) {
-        return sendDeleteRequest(`/competitions/${id}/teams`, {
+        return this.deleteRequest(`/competitions/${id}/teams`, {
             verificationCode,
             teamNames
         });
@@ -2463,21 +2461,28 @@ class CompetitionsClient {
      * @returns The number of players to be updated and a confirmation message.
      */
     updateAll(id, verificationCode) {
-        return sendPostRequest(`/competitions/${id}/update-all`, {
+        return this.postRequest(`/competitions/${id}/update-all`, {
             verificationCode
         });
     }
 }
 
 class WOMClient {
-    constructor() {
-        this.deltas = new DeltasClient();
-        this.groups = new GroupsClient();
-        this.players = new PlayersClient();
-        this.records = new RecordsClient();
-        this.efficiency = new EfficiencyClient();
-        this.nameChanges = new NameChangesClient();
-        this.competitions = new CompetitionsClient();
+    constructor(options) {
+        const axiosInstance = axios__default["default"].create({
+            baseURL: (options === null || options === void 0 ? void 0 : options.baseAPIUrl) || config.baseAPIUrl,
+            headers: {
+                'x-api-key': (options === null || options === void 0 ? void 0 : options.apiKey) || null,
+                'x-user-agent': (options === null || options === void 0 ? void 0 : options.userAgent) || config.defaultUserAgent
+            }
+        });
+        this.deltas = new DeltasClient(axiosInstance);
+        this.groups = new GroupsClient(axiosInstance);
+        this.players = new PlayersClient(axiosInstance);
+        this.records = new RecordsClient(axiosInstance);
+        this.efficiency = new EfficiencyClient(axiosInstance);
+        this.nameChanges = new NameChangesClient(axiosInstance);
+        this.competitions = new CompetitionsClient(axiosInstance);
     }
 }
 

package/package.json

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