@wise-old-man/utils 4.0.8 → 4.0.9

package/dist/cjs/index.cjs

@@ -322,6 +322,20 @@ exports.CompetitionStatus = void 0;
 })(exports.CompetitionStatus || (exports.CompetitionStatus = {}));
 const COMPETITION_STATUSES = Object.values(exports.CompetitionStatus);
 
+const CompetitionTimeEventStatus = {
+    WAITING: 'waiting',
+    EXECUTING: 'executing',
+    COMPLETED: 'completed',
+    FAILED: 'failed',
+    CANCELED: 'canceled'
+};
+
+const CompetitionTimeEventType = {
+    BEFORE_START: 'before_start',
+    BEFORE_END: 'before_end',
+    DURING: 'during'
+};
+
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
@@ -406,6 +420,7 @@ const Country = {
     FR: 'FR',
     GA: 'GA',
     GB: 'GB',
+    GB_ENG: 'GB_ENG',
     GB_NIR: 'GB_NIR',
     GB_SCT: 'GB_SCT',
     GB_WLS: 'GB_WLS',
@@ -1489,7 +1504,8 @@ const CountryProps = {
     [Country.FR]: { code: 'FR', name: 'France' },
     [Country.GA]: { code: 'GA', name: 'Gabon' },
     [Country.GB]: { code: 'GB', name: 'United Kingdom' },
-    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northen Ireland' },
+    [Country.GB_ENG]: { code: 'GB_ENG', name: 'England' },
+    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northern Ireland' },
     [Country.GB_SCT]: { code: 'GB_SCT', name: 'Scotland' },
     [Country.GB_WLS]: { code: 'GB_WLS', name: 'Wales' },
     [Country.GD]: { code: 'GD', name: 'Grenada' },
@@ -2319,6 +2335,8 @@ exports.COMPETITION_TYPES = COMPETITION_TYPES;
 exports.COMPUTED_METRICS = COMPUTED_METRICS;
 exports.COUNTRY_CODES = COUNTRY_CODES;
 exports.CompetitionStatusProps = CompetitionStatusProps;
+exports.CompetitionTimeEventStatus = CompetitionTimeEventStatus;
+exports.CompetitionTimeEventType = CompetitionTimeEventType;
 exports.CompetitionType = CompetitionType;
 exports.CompetitionTypeProps = CompetitionTypeProps;
 exports.ComputedMetric = ComputedMetric;

package/dist/es/index.js

@@ -320,6 +320,20 @@ var CompetitionStatus;
 })(CompetitionStatus || (CompetitionStatus = {}));
 const COMPETITION_STATUSES = Object.values(CompetitionStatus);
 
+const CompetitionTimeEventStatus = {
+    WAITING: 'waiting',
+    EXECUTING: 'executing',
+    COMPLETED: 'completed',
+    FAILED: 'failed',
+    CANCELED: 'canceled'
+};
+
+const CompetitionTimeEventType = {
+    BEFORE_START: 'before_start',
+    BEFORE_END: 'before_end',
+    DURING: 'during'
+};
+
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
@@ -404,6 +418,7 @@ const Country = {
     FR: 'FR',
     GA: 'GA',
     GB: 'GB',
+    GB_ENG: 'GB_ENG',
     GB_NIR: 'GB_NIR',
     GB_SCT: 'GB_SCT',
     GB_WLS: 'GB_WLS',
@@ -1487,7 +1502,8 @@ const CountryProps = {
     [Country.FR]: { code: 'FR', name: 'France' },
     [Country.GA]: { code: 'GA', name: 'Gabon' },
     [Country.GB]: { code: 'GB', name: 'United Kingdom' },
-    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northen Ireland' },
+    [Country.GB_ENG]: { code: 'GB_ENG', name: 'England' },
+    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northern Ireland' },
     [Country.GB_SCT]: { code: 'GB_SCT', name: 'Scotland' },
     [Country.GB_WLS]: { code: 'GB_WLS', name: 'Wales' },
     [Country.GD]: { code: 'GD', name: 'Grenada' },
@@ -2304,4 +2320,4 @@ function roundNumber(num, cases) {
     return Math.round(num * Math.pow(10, cases)) / Math.pow(10, cases);
 }
 
-export { ACTIVITIES, Activity, ActivityProps, BOSSES, Boss, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MemberActivityType, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerAnnotationType, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, SkillProps, 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, Activity, ActivityProps, BOSSES, Boss, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionTimeEventStatus, CompetitionTimeEventType, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MemberActivityType, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerAnnotationType, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, SkillProps, 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/dist/es/index.mjs

@@ -320,6 +320,20 @@ var CompetitionStatus;
 })(CompetitionStatus || (CompetitionStatus = {}));
 const COMPETITION_STATUSES = Object.values(CompetitionStatus);
 
+const CompetitionTimeEventStatus = {
+    WAITING: 'waiting',
+    EXECUTING: 'executing',
+    COMPLETED: 'completed',
+    FAILED: 'failed',
+    CANCELED: 'canceled'
+};
+
+const CompetitionTimeEventType = {
+    BEFORE_START: 'before_start',
+    BEFORE_END: 'before_end',
+    DURING: 'during'
+};
+
 const CompetitionType = {
     CLASSIC: 'classic',
     TEAM: 'team'
@@ -404,6 +418,7 @@ const Country = {
     FR: 'FR',
     GA: 'GA',
     GB: 'GB',
+    GB_ENG: 'GB_ENG',
     GB_NIR: 'GB_NIR',
     GB_SCT: 'GB_SCT',
     GB_WLS: 'GB_WLS',
@@ -1487,7 +1502,8 @@ const CountryProps = {
     [Country.FR]: { code: 'FR', name: 'France' },
     [Country.GA]: { code: 'GA', name: 'Gabon' },
     [Country.GB]: { code: 'GB', name: 'United Kingdom' },
-    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northen Ireland' },
+    [Country.GB_ENG]: { code: 'GB_ENG', name: 'England' },
+    [Country.GB_NIR]: { code: 'GB_NIR', name: 'Northern Ireland' },
     [Country.GB_SCT]: { code: 'GB_SCT', name: 'Scotland' },
     [Country.GB_WLS]: { code: 'GB_WLS', name: 'Wales' },
     [Country.GD]: { code: 'GD', name: 'Grenada' },
@@ -2304,4 +2320,4 @@ function roundNumber(num, cases) {
     return Math.round(num * Math.pow(10, cases)) / Math.pow(10, cases);
 }
 
-export { ACTIVITIES, Activity, ActivityProps, BOSSES, Boss, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MemberActivityType, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerAnnotationType, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, SkillProps, 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, Activity, ActivityProps, BOSSES, Boss, BossProps, CAPPED_MAX_TOTAL_XP, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COMPUTED_METRICS, COUNTRY_CODES, CompetitionCSVTableType, CompetitionStatus, CompetitionStatusProps, CompetitionTimeEventStatus, CompetitionTimeEventType, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, EfficiencyAlgorithmType, F2P_BOSSES, GROUP_ROLES, GroupRole, GroupRoleProps, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MemberActivityType, Metric, MetricMeasure, MetricProps, MetricType, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_STATUSES, PLAYER_TYPES, PRIVILEGED_GROUP_ROLES, Period, PeriodProps, PlayerAnnotationType, PlayerBuild, PlayerBuildProps, PlayerStatus, PlayerStatusProps, PlayerType, PlayerTypeProps, REAL_METRICS, REAL_SKILLS, SKILLS, SKILL_EXP_AT_99, Skill, SkillProps, 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/dist/index.d.ts

@@ -563,6 +563,37 @@ interface CompetitionTeam {
     participants: string[];
 }
 
+declare const CompetitionTimeEventStatus: {
+    readonly WAITING: "waiting";
+    readonly EXECUTING: "executing";
+    readonly COMPLETED: "completed";
+    readonly FAILED: "failed";
+    readonly CANCELED: "canceled";
+};
+type CompetitionTimeEventStatus = (typeof CompetitionTimeEventStatus)[keyof typeof CompetitionTimeEventStatus];
+
+declare const CompetitionTimeEventType: {
+    readonly BEFORE_START: "before_start";
+    readonly BEFORE_END: "before_end";
+    readonly DURING: "during";
+};
+type CompetitionTimeEventType = (typeof CompetitionTimeEventType)[keyof typeof CompetitionTimeEventType];
+
+interface CompetitionTimeEvent {
+    id: number;
+    competitionId: number;
+    type: CompetitionTimeEventType;
+    offsetMinutes: number;
+    executeAt: Date;
+    status: CompetitionTimeEventStatus;
+    attempts: number;
+    executingAt: Date | null;
+    completedAt: Date | null;
+    failedAt: Date | null;
+    canceledAt: Date | null;
+    createdAt: Date;
+}
+
 declare const CompetitionType: {
     readonly CLASSIC: "classic";
     readonly TEAM: "team";
@@ -663,6 +694,7 @@ declare const Country: {
     readonly FR: "FR";
     readonly GA: "GA";
     readonly GB: "GB";
+    readonly GB_ENG: "GB_ENG";
     readonly GB_NIR: "GB_NIR";
     readonly GB_SCT: "GB_SCT";
     readonly GB_WLS: "GB_WLS";
@@ -3899,4 +3931,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 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 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, type TrendDatapoint, 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, type CompetitionTimeEvent, CompetitionTimeEventStatus, CompetitionTimeEventType, CompetitionType, CompetitionTypeProps, ComputedMetric, ComputedMetricProps, Country, CountryProps, type CreateCompetitionPayload, type CreateGroupPayload, 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, type TrendDatapoint, 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.8",
+  "version": "4.0.9",
   "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",