@wise-old-man/utils 3.0.2 → 3.1.0

package/dist/index.d.ts

@@ -11,6 +11,14 @@ type Prisma_Base_Achievement = {
   createdAt: Date;
 };
 
+export type MemberActivity = {
+  groupId: number;
+  playerId: number;
+  type: ActivityType;
+  role?: GroupRole;
+  createdAt: Date;
+};
+
 export type Membership = {
   playerId: number;
   groupId: number;
@@ -1114,6 +1122,12 @@ declare const Country: {
     readonly ZW: "ZW";
 };
 declare type Country = typeof Country[keyof typeof Country];
+declare const ActivityType: {
+    readonly JOINED: "joined";
+    readonly LEFT: "left";
+    readonly CHANGED_ROLE: "changed_role";
+};
+declare type ActivityType = typeof ActivityType[keyof typeof ActivityType];
 
 declare type Achievement = Omit<Prisma_Base_Achievement, 'threshold' | 'accuracy'> & {
     threshold: number;
@@ -1333,6 +1347,14 @@ interface TempleGroupData {
     members: string[];
     leaders: string[];
 }
+declare type MemberRoleChangeEvent = Omit<MemberActivity, 'createdAt'> & {
+    previousRole: GroupRole;
+};
+declare type MemberJoinedEvent = Omit<MemberActivity, 'createdAt'>;
+declare type MemberLeftEvent = Omit<MemberActivity, 'createdAt' | 'role'>;
+declare type MemberActivityWithPlayer = MemberActivity & {
+    player: Player;
+};
 
 declare type CleanCompetition = Omit<Competition, 'verificationHash'>;
 declare type CleanParticipation = Omit<Participation, 'startSnapshotId' | 'endSnapshotId'>;
@@ -1385,7 +1407,8 @@ declare enum EfficiencyAlgorithmType {
     LVL3 = "lvl3",
     F2P = "f2p",
     F2P_LVL3 = "f2p_lvl3",
-    F2P_IRONMAN = "f2p_ironman"
+    F2P_IRONMAN = "f2p_ironman",
+    F2P_LVL3_IRONMAN = "f2p_lvl3_ironman"
 }
 interface SkillMetaMethod {
     rate: number;
@@ -1412,6 +1435,7 @@ interface Bonus {
     ratio: number;
 }
 interface EfficiencyAlgorithm {
+    type: EfficiencyAlgorithmType;
     skillMetas: SkillMetaConfig[];
     bossMetas: BossMetaConfig[];
     maximumEHP: number;
@@ -1423,7 +1447,6 @@ interface EfficiencyAlgorithm {
     calculateSkillEHP(skill: Skill, experienceMap: ExperienceMap): number;
     calculateBossEHB(boss: Boss, killcountMap: KillcountMap): number;
 }
-declare type AlgorithmCache = MapOf<EfficiencyAlgorithmType, EfficiencyAlgorithm>;
 
 declare type DenyContext = {
     reason: 'manual_review';
@@ -1969,6 +1992,11 @@ declare class GroupsClient extends BaseAPIClient {
      * @returns An object with a few statistic values and an average stats snapshot.
      */
     getGroupStatistics(id: number): Promise<GroupStatistics>;
+    /**
+     * Fetches a group's activity.
+     * @returns A list of a group's (join, leave and role changed) activity.
+     */
+    getGroupActivity(id: number, pagination?: PaginationOptions): Promise<MemberActivityWithPlayer>;
 }
 
 declare class PlayersClient extends BaseAPIClient {
@@ -2171,4 +2199,4 @@ declare class WOMClient extends BaseAPIClient {
     constructor(options?: WOMClientOptions);
 }
 
-export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, ActivityValueWithPlayer, AlgorithmCache, 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, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricLeaders, MetricMeasure, MetricProps, MetricType, MetricValueKey, MigrationDataSource, NameChange, NameChangeDetails, NameChangeStatus, 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, 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, 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 };

package/dist/index.js

@@ -314,6 +314,13 @@ class GroupsClient extends BaseAPIClient {
     getGroupStatistics(id) {
         return this.getRequest(`/groups/${id}/statistics`);
     }
+    /**
+     * Fetches a group's activity.
+     * @returns A list of a group's (join, leave and role changed) activity.
+     */
+    getGroupActivity(id, pagination) {
+        return this.getRequest(`/groups/${id}/activity`, Object.assign({}, pagination));
+    }
 }
 
 class PlayersClient extends BaseAPIClient {
@@ -1150,6 +1157,11 @@ const Country = {
     ZM: 'ZM',
     ZW: 'ZW'
 };
+const ActivityType = {
+    JOINED: 'joined',
+    LEFT: 'left',
+    CHANGED_ROLE: 'changed_role'
+};
 
 exports.CompetitionStatus = void 0;
 (function (CompetitionStatus) {
@@ -2394,6 +2406,7 @@ exports.EfficiencyAlgorithmType = void 0;
     EfficiencyAlgorithmType["F2P"] = "f2p";
     EfficiencyAlgorithmType["F2P_LVL3"] = "f2p_lvl3";
     EfficiencyAlgorithmType["F2P_IRONMAN"] = "f2p_ironman";
+    EfficiencyAlgorithmType["F2P_LVL3_IRONMAN"] = "f2p_lvl3_ironman";
 })(exports.EfficiencyAlgorithmType || (exports.EfficiencyAlgorithmType = {}));
 
 exports.MigrationDataSource = void 0;
@@ -2574,6 +2587,7 @@ class WOMClient extends BaseAPIClient {
 
 exports.ACTIVITIES = ACTIVITIES;
 exports.Activity = Activity;
+exports.ActivityType = ActivityType;
 exports.BOSSES = BOSSES;
 exports.Boss = Boss;
 exports.CAPPED_MAX_TOTAL_XP = CAPPED_MAX_TOTAL_XP;

package/package.json

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