@wise-old-man/utils 4.0.4 → 4.0.5

package/dist/index.d.ts

@@ -259,6 +259,7 @@ interface Snapshot {
     createdAt: Date;
     overallRank: number;
     overallExperience: number;
+    overallLevel: number;
     attackRank: number;
     attackExperience: number;
     defenceRank: number;
@@ -509,12 +510,39 @@ interface BossMetaConfig {
     rate: number;
 }
 
+declare const Period: {
+    readonly FIVE_MIN: "five_min";
+    readonly DAY: "day";
+    readonly WEEK: "week";
+    readonly MONTH: "month";
+    readonly YEAR: "year";
+};
+type Period = (typeof Period)[keyof typeof Period];
+declare const PERIODS: ("five_min" | "day" | "week" | "month" | "year")[];
+
+interface CachedDelta {
+    playerId: number;
+    period: Period;
+    metric: Metric;
+    value: number;
+    startedAt: Date;
+    endedAt: Date;
+    updatedAt: Date;
+}
+
 declare enum CompetitionCSVTableType {
     TEAM = "team",
     TEAMS = "teams",
     PARTICIPANTS = "participants"
 }
 
+interface CompetitionMetric {
+    competitionId: number;
+    metric: Metric;
+    createdAt: Date;
+    deletedAt: Date | null;
+}
+
 declare enum CompetitionStatus {
     UPCOMING = "upcoming",
     ONGOING = "ongoing",
@@ -537,7 +565,6 @@ declare const COMPETITION_TYPES: CompetitionType[];
 interface Competition {
     id: number;
     title: string;
-    metric: Metric;
     type: CompetitionType;
     startsAt: Date;
     endsAt: Date;
@@ -807,16 +834,6 @@ declare const Country: {
 type Country = (typeof Country)[keyof typeof Country];
 declare const COUNTRY_CODES: Country[];
 
-declare const Period: {
-    readonly FIVE_MIN: "five_min";
-    readonly DAY: "day";
-    readonly WEEK: "week";
-    readonly MONTH: "month";
-    readonly YEAR: "year";
-};
-type Period = (typeof Period)[keyof typeof Period];
-declare const PERIODS: ("five_min" | "day" | "week" | "month" | "year")[];
-
 interface Delta {
     playerId: number;
     period: Period;
@@ -1511,6 +1528,8 @@ interface GroupResponse extends Omit<Group, 'verificationHash' | 'creatorIpHash'
  */
 
 interface CompetitionResponse extends Omit<Competition, 'verificationHash' | 'creatorIpHash'> {
+    metric: Metric;
+    metrics: Metric[];
     participantCount: number;
     group?: GroupResponse;
 }
@@ -3963,4 +3982,4 @@ declare function isPlayerType(typeString: string): typeString is PlayerType;
 
 declare function roundNumber(num: number, cases: number): number;
 
-export { ACTIVITIES, type Achievement, type AchievementDefinition, type AchievementMeasure, type AchievementProgressResponse, type AchievementResponse, Activity, ActivityProps, BOSSES, Boss, type BossMetaConfig, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, type Competition, CompetitionCSVTableType, type CompetitionDetailsResponse, type CompetitionResponse, CompetitionStatus, CompetitionStatusProps, type CompetitionTeam, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, type CreateCompetitionPayload, type CreateGroupPayload, type Delta, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, type GenericCountMessageResponse, type GenericMessageResponse, type Group, type GroupDetailsResponse, type GroupHiscoresEntryResponse, type GroupResponse, GroupRole, type GroupRoleOrder, GroupRoleProps, type GroupSocialLinks, type GroupStatisticsResponse, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, type MemberActivity, type MemberActivityResponse, MemberActivityType, type Membership, type MembershipResponse, Metric, type MetricDelta, MetricMeasure, MetricProps, MetricType, type NameChange, type NameChangeDenyContext, type NameChangeDetailsResponse, type NameChangeResponse, type NameChangeReviewContext, type NameChangeSkipContext, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, type ParticipantHistoryResponse, type Participation, type ParticipationResponse, type Patron, Period, PeriodProps, type Player, type PlayerAnnotation, PlayerAnnotationType, type PlayerArchive, type PlayerArchiveResponse, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingResponse, type PlayerDeltasMapResponse, type PlayerDetailsResponse, type PlayerResponse, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type Record$1 as Record, type RecordResponse, SKILLS, SKILL_EXP_AT_99, Skill, type SkillMetaBonus, type SkillMetaConfig, type SkillMetaMethod, SkillProps, type Snapshot, type SnapshotResponse, type TimeRangeFilter, WOMClient, findCountry, findCountryByCode, findCountryByName, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill, padNumber, parsePeriodExpression, roundNumber };
+export { ACTIVITIES, type Achievement, type AchievementDefinition, type AchievementMeasure, type AchievementProgressResponse, type AchievementResponse, Activity, ActivityProps, BOSSES, Boss, type BossMetaConfig, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, type CachedDelta, type Competition, CompetitionCSVTableType, type CompetitionDetailsResponse, type CompetitionMetric, type CompetitionResponse, CompetitionStatus, CompetitionStatusProps, type CompetitionTeam, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, type CreateCompetitionPayload, type CreateGroupPayload, type Delta, type EditCompetitionPayload, type EditGroupPayload, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, type GenericCountMessageResponse, type GenericMessageResponse, type Group, type GroupDetailsResponse, type GroupHiscoresEntryResponse, type GroupResponse, GroupRole, type GroupRoleOrder, GroupRoleProps, type GroupSocialLinks, type GroupStatisticsResponse, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, type MemberActivity, type MemberActivityResponse, MemberActivityType, type Membership, type MembershipResponse, Metric, type MetricDelta, MetricMeasure, MetricProps, MetricType, type NameChange, type NameChangeDenyContext, type NameChangeDetailsResponse, type NameChangeResponse, type NameChangeReviewContext, type NameChangeSkipContext, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, type ParticipantHistoryResponse, type Participation, type ParticipationResponse, type Patron, Period, PeriodProps, type Player, type PlayerAnnotation, PlayerAnnotationType, type PlayerArchive, type PlayerArchiveResponse, PlayerBuild, PlayerBuildProps, type PlayerCompetitionStandingResponse, type PlayerDeltasMapResponse, type PlayerDetailsResponse, type PlayerResponse, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, type Record$1 as Record, type RecordResponse, SKILLS, SKILL_EXP_AT_99, Skill, type SkillMetaBonus, type SkillMetaConfig, type SkillMetaMethod, SkillProps, type Snapshot, type SnapshotResponse, type TimeRangeFilter, WOMClient, findCountry, findCountryByCode, findCountryByName, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMinimumValue, getParentEfficiencyMetric, isActivity, isBoss, isComputedMetric, isCountry, isGroupRole, isMetric, isPeriod, isPlayerBuild, isPlayerStatus, isPlayerType, isSkill, padNumber, parsePeriodExpression, roundNumber };

package/package.json

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