@wise-old-man/utils 1.0.6 → 1.0.11

package/src/metrics.ts

@@ -1,283 +0,0 @@
-import { mapValues } from 'lodash';
-
-enum Skill {
-  OVERALL = 'overall',
-  ATTACK = 'attack',
-  DEFENCE = 'defence',
-  STRENGTH = 'strength',
-  HITPOINTS = 'hitpoints',
-  RANGED = 'ranged',
-  PRAYER = 'prayer',
-  MAGIC = 'magic',
-  COOKING = 'cooking',
-  WOODCUTTING = 'woodcutting',
-  FLETCHING = 'fletching',
-  FISHING = 'fishing',
-  FIREMAKING = 'firemaking',
-  CRAFTING = 'crafting',
-  SMITHING = 'smithing',
-  MINING = 'mining',
-  HERBLORE = 'herblore',
-  AGILITY = 'agility',
-  THIEVING = 'thieving',
-  SLAYER = 'slayer',
-  FARMING = 'farming',
-  RUNECRAFTING = 'runecrafting',
-  HUNTER = 'hunter',
-  CONSTRUCTION = 'construction'
-}
-
-enum Boss {
-  ABYSSAL_SIRE = 'abyssal_sire',
-  ALCHEMICAL_HYDRA = 'alchemical_hydra',
-  BARROWS_CHESTS = 'barrows_chests',
-  BRYOPHYTA = 'bryophyta',
-  CALLISTO = 'callisto',
-  CERBERUS = 'cerberus',
-  CHAMBERS_OF_XERIC = 'chambers_of_xeric',
-  CHAMBERS_OF_XERIC_CM = 'chambers_of_xeric_challenge_mode',
-  CHAOS_ELEMENTAL = 'chaos_elemental',
-  CHAOS_FANATIC = 'chaos_fanatic',
-  COMMANDER_ZILYANA = 'commander_zilyana',
-  CORPOREAL_BEAST = 'corporeal_beast',
-  CRAZY_ARCHAEOLOGIST = 'crazy_archaeologist',
-  DAGANNOTH_PRIME = 'dagannoth_prime',
-  DAGANNOTH_REX = 'dagannoth_rex',
-  DAGANNOTH_SUPREME = 'dagannoth_supreme',
-  DERANGED_ARCHAEOLOGIST = 'deranged_archaeologist',
-  GENERAL_GRAARDOR = 'general_graardor',
-  GIANT_MOLE = 'giant_mole',
-  GROTESQUE_GUARDIANS = 'grotesque_guardians',
-  HESPORI = 'hespori',
-  KALPHITE_QUEEN = 'kalphite_queen',
-  KING_BLACK_DRAGON = 'king_black_dragon',
-  KRAKEN = 'kraken',
-  KREEARRA = 'kreearra',
-  KRIL_TSUTSAROTH = 'kril_tsutsaroth',
-  MIMIC = 'mimic',
-  NIGHTMARE = 'nightmare',
-  PHOSANIS_NIGHTMARE = 'phosanis_nightmare',
-  OBOR = 'obor',
-  SARACHNIS = 'sarachnis',
-  SCORPIA = 'scorpia',
-  SKOTIZO = 'skotizo',
-  TEMPOROSS = 'tempoross',
-  THE_GAUNTLET = 'the_gauntlet',
-  THE_CORRUPTED_GAUNTLET = 'the_corrupted_gauntlet',
-  THEATRE_OF_BLOOD = 'theatre_of_blood',
-  THEATRE_OF_BLOOD_HARD_MODE = 'theatre_of_blood_hard_mode',
-  THERMONUCLEAR_SMOKE_DEVIL = 'thermonuclear_smoke_devil',
-  TZKAL_ZUK = 'tzkal_zuk',
-  TZTOK_JAD = 'tztok_jad',
-  VENENATIS = 'venenatis',
-  VETION = 'vetion',
-  VORKATH = 'vorkath',
-  WINTERTODT = 'wintertodt',
-  ZALCANO = 'zalcano',
-  ZULRAH = 'zulrah'
-}
-
-enum Activity {
-  LEAGUE_POINTS = 'league_points',
-  BOUNTY_HUNTER_HUNTER = 'bounty_hunter_hunter',
-  BOUNTY_HUNTER_ROGUE = 'bounty_hunter_rogue',
-  CLUE_SCROLLS_ALL = 'clue_scrolls_all',
-  CLUE_SCROLLS_BEGINNER = 'clue_scrolls_beginner',
-  CLUE_SCROLLS_EASY = 'clue_scrolls_easy',
-  CLUE_SCROLLS_MEDIUM = 'clue_scrolls_medium',
-  CLUE_SCROLLS_HARD = 'clue_scrolls_hard',
-  CLUE_SCROLLS_ELITE = 'clue_scrolls_elite',
-  CLUE_SCROLLS_MASTER = 'clue_scrolls_master',
-  LAST_MAN_STANDING = 'last_man_standing',
-  SOUL_WARS_ZEAL = 'soul_wars_zeal'
-}
-
-enum VirtualMetric {
-  EHP = 'ehp',
-  EHB = 'ehb'
-}
-
-enum MetricType {
-  SKILL = 'skill',
-  BOSS = 'boss',
-  ACTIVITY = 'activity',
-  VIRTUAL = 'virtual'
-}
-
-enum MetricMeasure {
-  EXPERIENCE = 'experience',
-  KILLS = 'kills',
-  SCORE = 'score',
-  VALUE = 'value'
-}
-
-const SkillProps = mapValues(
-  {
-    [Skill.OVERALL]: { name: 'Overall', isCombat: false, isMembers: false },
-    [Skill.ATTACK]: { name: 'Attack', isCombat: true, isMembers: false },
-    [Skill.DEFENCE]: { name: 'Defence', isCombat: true, isMembers: false },
-    [Skill.STRENGTH]: { name: 'Strength', isCombat: true, isMembers: false },
-    [Skill.HITPOINTS]: { name: 'Hitpoints', isCombat: true, isMembers: false },
-    [Skill.RANGED]: { name: 'Ranged', isCombat: true, isMembers: false },
-    [Skill.PRAYER]: { name: 'Prayer', isCombat: true, isMembers: false },
-    [Skill.MAGIC]: { name: 'Magic', isCombat: true, isMembers: false },
-    [Skill.COOKING]: { name: 'Cooking', isCombat: false, isMembers: false },
-    [Skill.WOODCUTTING]: { name: 'Woodcutting', isCombat: false, isMembers: false },
-    [Skill.FLETCHING]: { name: 'Fletching', isCombat: false, isMembers: true },
-    [Skill.FISHING]: { name: 'Fishing', isCombat: false, isMembers: false },
-    [Skill.FIREMAKING]: { name: 'Firemaking', isCombat: false, isMembers: false },
-    [Skill.CRAFTING]: { name: 'Crafting', isCombat: false, isMembers: false },
-    [Skill.SMITHING]: { name: 'Smithing', isCombat: false, isMembers: false },
-    [Skill.MINING]: { name: 'Mining', isCombat: false, isMembers: false },
-    [Skill.HERBLORE]: { name: 'Herblore', isCombat: false, isMembers: true },
-    [Skill.AGILITY]: { name: 'Agility', isCombat: false, isMembers: true },
-    [Skill.THIEVING]: { name: 'Thieving', isCombat: false, isMembers: true },
-    [Skill.SLAYER]: { name: 'Slayer', isCombat: false, isMembers: true },
-    [Skill.FARMING]: { name: 'Farming', isCombat: false, isMembers: true },
-    [Skill.RUNECRAFTING]: { name: 'Runecrafting', isCombat: false, isMembers: false },
-    [Skill.HUNTER]: { name: 'Hunter', isCombat: false, isMembers: true },
-    [Skill.CONSTRUCTION]: { name: 'Construction', isCombat: false, isMembers: false }
-  },
-  (props, key) => ({ ...props, key, type: MetricType.SKILL, measure: MetricMeasure.EXPERIENCE })
-);
-
-const BossProps = mapValues(
-  {
-    [Boss.ABYSSAL_SIRE]: { name: 'Abyssal Sire', minimumKc: 50, isMembers: true },
-    [Boss.ALCHEMICAL_HYDRA]: { name: 'Alchemical Hydra', minimumKc: 50, isMembers: true },
-    [Boss.BARROWS_CHESTS]: { name: 'Barrows Chests', minimumKc: 50, isMembers: true },
-    [Boss.BRYOPHYTA]: { name: 'Bryophyta', minimumKc: 10, isMembers: false },
-    [Boss.CALLISTO]: { name: 'Callisto', minimumKc: 50, isMembers: true },
-    [Boss.CERBERUS]: { name: 'Cerberus', minimumKc: 50, isMembers: true },
-    [Boss.CHAMBERS_OF_XERIC]: { name: 'Chambers Of Xeric', minimumKc: 50, isMembers: true },
-    [Boss.CHAMBERS_OF_XERIC_CM]: { name: 'Chambers Of Xeric (CM)', minimumKc: 10, isMembers: true },
-    [Boss.CHAOS_ELEMENTAL]: { name: 'Chaos Elemental', minimumKc: 50, isMembers: true },
-    [Boss.CHAOS_FANATIC]: { name: 'Chaos Fanatic', minimumKc: 50, isMembers: true },
-    [Boss.COMMANDER_ZILYANA]: { name: 'Commander Zilyana', minimumKc: 50, isMembers: true },
-    [Boss.CORPOREAL_BEAST]: { name: 'Corporeal Beast', minimumKc: 50, isMembers: true },
-    [Boss.CRAZY_ARCHAEOLOGIST]: { name: 'Crazy Archaeologist', minimumKc: 50, isMembers: true },
-    [Boss.DAGANNOTH_PRIME]: { name: 'Dagannoth Prime', minimumKc: 50, isMembers: true },
-    [Boss.DAGANNOTH_REX]: { name: 'Dagannoth Rex', minimumKc: 50, isMembers: true },
-    [Boss.DAGANNOTH_SUPREME]: { name: 'Dagannoth Supreme', minimumKc: 50, isMembers: true },
-    [Boss.DERANGED_ARCHAEOLOGIST]: { name: 'Deranged Archaeologist', minimumKc: 50, isMembers: true },
-    [Boss.GENERAL_GRAARDOR]: { name: 'General Graardor', minimumKc: 50, isMembers: true },
-    [Boss.GIANT_MOLE]: { name: 'Giant Mole', minimumKc: 50, isMembers: true },
-    [Boss.GROTESQUE_GUARDIANS]: { name: 'Grotesque Guardians', minimumKc: 50, isMembers: true },
-    [Boss.HESPORI]: { name: 'Hespori', minimumKc: 10, isMembers: true },
-    [Boss.KALPHITE_QUEEN]: { name: 'Kalphite Queen', minimumKc: 50, isMembers: true },
-    [Boss.KING_BLACK_DRAGON]: { name: 'King Black Dragon', minimumKc: 50, isMembers: true },
-    [Boss.KRAKEN]: { name: 'Kraken', minimumKc: 50, isMembers: true },
-    [Boss.KREEARRA]: { name: "Kree'Arra", minimumKc: 50, isMembers: true },
-    [Boss.KRIL_TSUTSAROTH]: { name: "K'ril Tsutsaroth", minimumKc: 50, isMembers: true },
-    [Boss.MIMIC]: { name: 'Mimic', minimumKc: 2, isMembers: true },
-    [Boss.NIGHTMARE]: { name: 'Nightmare', minimumKc: 50, isMembers: true },
-    [Boss.PHOSANIS_NIGHTMARE]: { name: "Phosani's Nightmare", minimumKc: 50, isMembers: true },
-    [Boss.OBOR]: { name: 'Obor', minimumKc: 10, isMembers: false },
-    [Boss.SARACHNIS]: { name: 'Sarachnis', minimumKc: 50, isMembers: true },
-    [Boss.SCORPIA]: { name: 'Scorpia', minimumKc: 50, isMembers: true },
-    [Boss.SKOTIZO]: { name: 'Skotizo', minimumKc: 10, isMembers: true },
-    [Boss.TEMPOROSS]: { name: 'Tempoross', minimumKc: 50, isMembers: true },
-    [Boss.THE_GAUNTLET]: { name: 'The Gauntlet', minimumKc: 50, isMembers: true },
-    [Boss.THE_CORRUPTED_GAUNTLET]: { name: 'The Corrupted Gauntlet', minimumKc: 10, isMembers: true },
-    [Boss.THEATRE_OF_BLOOD]: { name: 'Theatre Of Blood', minimumKc: 50, isMembers: true },
-    [Boss.THEATRE_OF_BLOOD_HARD_MODE]: { name: 'Theatre Of Blood (HM)', minimumKc: 50, isMembers: true },
-    [Boss.THERMONUCLEAR_SMOKE_DEVIL]: { name: 'Thermonuclear Smoke Devil', minimumKc: 50, isMembers: true },
-    [Boss.TZKAL_ZUK]: { name: 'TzKal-Zuk', minimumKc: 2, isMembers: true },
-    [Boss.TZTOK_JAD]: { name: 'TzTok-Jad', minimumKc: 10, isMembers: true },
-    [Boss.VENENATIS]: { name: 'Venenatis', minimumKc: 50, isMembers: true },
-    [Boss.VETION]: { name: "Vet'ion", minimumKc: 50, isMembers: true },
-    [Boss.VORKATH]: { name: 'Vorkath', minimumKc: 50, isMembers: true },
-    [Boss.WINTERTODT]: { name: 'Wintertodt', minimumKc: 50, isMembers: true },
-    [Boss.ZALCANO]: { name: 'Zalcano', minimumKc: 50, isMembers: true },
-    [Boss.ZULRAH]: { name: 'Zulrah', minimumKc: 50, isMembers: true }
-  },
-  (props, key) => ({ ...props, key, type: MetricType.BOSS, measure: MetricMeasure.KILLS })
-);
-
-const ActivityProps = mapValues(
-  {
-    [Activity.LEAGUE_POINTS]: { name: 'League Points' },
-    [Activity.BOUNTY_HUNTER_HUNTER]: { name: 'Bounty Hunter (Hunter)' },
-    [Activity.BOUNTY_HUNTER_ROGUE]: { name: 'Bounty Hunter (Rogue)' },
-    [Activity.CLUE_SCROLLS_ALL]: { name: 'Clue Scrolls (All)' },
-    [Activity.CLUE_SCROLLS_BEGINNER]: { name: 'Clue Scrolls (Beginner)' },
-    [Activity.CLUE_SCROLLS_EASY]: { name: 'Clue Scrolls (Easy)' },
-    [Activity.CLUE_SCROLLS_MEDIUM]: { name: 'Clue Scrolls (Medium)' },
-    [Activity.CLUE_SCROLLS_HARD]: { name: 'Clue Scrolls (Hard)' },
-    [Activity.CLUE_SCROLLS_ELITE]: { name: 'Clue Scrolls (Elite)' },
-    [Activity.CLUE_SCROLLS_MASTER]: { name: 'Clue Scrolls (Master)' },
-    [Activity.LAST_MAN_STANDING]: { name: 'Last Man Standing' },
-    [Activity.SOUL_WARS_ZEAL]: { name: 'Soul Wars Zeal' }
-  },
-  (props, key) => ({ ...props, key, type: MetricType.ACTIVITY, measure: MetricMeasure.SCORE })
-);
-
-const VirtualMetricProps = mapValues(
-  {
-    [VirtualMetric.EHP]: { name: 'EHP' },
-    [VirtualMetric.EHB]: { name: 'EHB' }
-  },
-  (props, key) => ({ ...props, key, type: MetricType.VIRTUAL, measure: MetricMeasure.VALUE })
-);
-
-const Metrics = {
-  ...Skill,
-  ...Boss,
-  ...Activity,
-  ...VirtualMetric
-};
-
-const MetricProps = {
-  ...SkillProps,
-  ...BossProps,
-  ...ActivityProps,
-  ...VirtualMetricProps
-};
-
-type Metric = Skill | Boss | Activity | VirtualMetric;
-
-const SKILLS = Object.values(Skill);
-const BOSSES = Object.values(Boss);
-const ACTIVITIES = Object.values(Activity);
-const VIRTUAL_METRICS = Object.values(VirtualMetric);
-const METRICS = [...SKILLS, ...BOSSES, ...ACTIVITIES, ...VIRTUAL_METRICS];
-
-function findMetric(metricName: string): Metric | null {
-  for (var [key, value] of Object.entries(MetricProps)) {
-    if (value.name === metricName) return key as Metric;
-  }
-
-  return null;
-}
-
-function getRankKey(metric: Metric) {
-  return `${metric}Rank`;
-}
-
-function getValueKey(metric: Metric) {
-  if (metric in Skill) return `${metric}Experience`;
-  if (metric in Boss) return `${metric}Kills`;
-  if (metric in Activity) return `${metric}Score`;
-
-  return `${metric}Value`;
-}
-
-export {
-  // Types
-  Metric,
-  // Enums
-  Metrics,
-  MetricProps,
-  MetricType,
-  MetricMeasure,
-  // Lists
-  SKILLS,
-  BOSSES,
-  ACTIVITIES,
-  VIRTUAL_METRICS,
-  METRICS,
-  // Functions
-  findMetric,
-  getRankKey,
-  getValueKey
-};

package/src/numbers.ts

@@ -1,5 +0,0 @@
-function round(num: number, cases: number) {
-  return Math.round(num * Math.pow(10, cases)) / Math.pow(10, cases);
-}
-
-export { round };

package/src/periods.ts

@@ -1,67 +0,0 @@
-const CUSTOM_PERIOD_REGEX = /(\d+y)?(\d+m)?(\d+w)?(\d+d)?(\d+h)?/;
-
-enum Period {
-  FIVE_MIN = '5min',
-  DAY = 'day',
-  WEEK = 'week',
-  MONTH = 'month',
-  YEAR = 'year'
-}
-
-const PeriodProps = {
-  [Period.FIVE_MIN]: { name: '5 Min', milliseconds: 300_000 },
-  [Period.DAY]: { name: 'Day', milliseconds: 86_400_000 },
-  [Period.WEEK]: { name: 'Week', milliseconds: 604_800_000 },
-  [Period.MONTH]: { name: 'Month', milliseconds: 2_678_400_000 },
-  [Period.YEAR]: { name: 'Year', milliseconds: 31_556_926_000 }
-};
-
-const PERIODS = Object.values(Period);
-
-function findPeriod(periodName: string): Period | null {
-  for (var [key, value] of Object.entries(PeriodProps)) {
-    if (value.name === periodName) return key as Period;
-  }
-
-  return null;
-}
-
-function isValidPeriod(period: string): boolean {
-  return PERIODS.includes(period as Period);
-}
-
-function parsePeriodExpression(periodExpression: string) {
-  const fixed = periodExpression.toLowerCase();
-
-  if (isValidPeriod(fixed)) {
-    return {
-      expression: fixed,
-      durationMs: PeriodProps[fixed as Period].milliseconds
-    };
-  }
-
-  const result = fixed.match(CUSTOM_PERIOD_REGEX);
-
-  if (!result || result.length === 0 || result[0] !== fixed) return null;
-
-  const years = result[1] ? parseInt(result[1].replace(/\D/g, '')) : 0;
-  const months = result[2] ? parseInt(result[2].replace(/\D/g, '')) : 0;
-  const weeks = result[3] ? parseInt(result[3].replace(/\D/g, '')) : 0;
-  const days = result[4] ? parseInt(result[4].replace(/\D/g, '')) : 0;
-  const hours = result[5] ? parseInt(result[5].replace(/\D/g, '')) : 0;
-
-  const yearsMs = years * PeriodProps[Period.YEAR].milliseconds;
-  const monthsMs = months * PeriodProps[Period.MONTH].milliseconds;
-  const weeksMs = weeks * PeriodProps[Period.WEEK].milliseconds;
-  const daysMs = days * PeriodProps[Period.DAY].milliseconds;
-  const hoursMs = hours * (PeriodProps[Period.DAY].milliseconds / 24);
-
-  const totalMs = yearsMs + monthsMs + weeksMs + daysMs + hoursMs;
-
-  return {
-    expression: result[0],
-    durationMs: totalMs
-  };
-}
-
-export { Period, PeriodProps, PERIODS, findPeriod, isValidPeriod, parsePeriodExpression };

package/src/players.ts

@@ -1,76 +0,0 @@
-enum PlayerType {
-  UNKNOWN = 'unknown',
-  REGULAR = 'regular',
-  IRONMAN = 'ironman',
-  HARDCORE = 'hardcore',
-  ULTIMATE = 'ultimate'
-}
-
-enum PlayerBuild {
-  MAIN = 'main',
-  F2P = 'f2p',
-  LVL3 = 'lvl3',
-  ZERKER = 'zerker',
-  DEF1 = '1def',
-  HP10 = '10hp'
-}
-
-const PlayerTypeProps = {
-  [PlayerType.UNKNOWN]: { name: 'Unknown' },
-  [PlayerType.REGULAR]: { name: 'Regular' },
-  [PlayerType.IRONMAN]: { name: 'Ironman' },
-  [PlayerType.HARDCORE]: { name: 'Hardcore' },
-  [PlayerType.ULTIMATE]: { name: 'Ultimate' }
-};
-
-const PlayerBuildProps = {
-  [PlayerBuild.MAIN]: { name: 'Main' },
-  [PlayerBuild.F2P]: { name: 'F2P' },
-  [PlayerBuild.LVL3]: { name: 'Level 3' },
-  [PlayerBuild.ZERKER]: { name: 'Zerker Pure' },
-  [PlayerBuild.DEF1]: { name: '1 Defence Pure' },
-  [PlayerBuild.HP10]: { name: '10 Hitpoints Pure' }
-};
-
-const PLAYER_TYPES = Object.values(PlayerType);
-const PLAYER_BUILDS = Object.values(PlayerBuild);
-
-function findPlayerType(typeName: string): PlayerType | null {
-  for (var [key, value] of Object.entries(PlayerTypeProps)) {
-    if (value.name === typeName) return key as PlayerType;
-  }
-
-  return null;
-}
-
-function findPlayerBuild(buildName: string): PlayerBuild | null {
-  for (var [key, value] of Object.entries(PlayerBuildProps)) {
-    if (value.name === buildName) return key as PlayerBuild;
-  }
-
-  return null;
-}
-
-function standardizeUsername(username) {
-  return sanitizeUsername(username).toLowerCase();
-}
-
-function sanitizeUsername(username) {
-  return username.replace(/[-_\s]/g, ' ').trim();
-}
-
-export {
-  // Enums
-  PlayerType,
-  PlayerBuild,
-  PlayerTypeProps,
-  PlayerBuildProps,
-  // Lists
-  PLAYER_TYPES,
-  PLAYER_BUILDS,
-  // Functions
-  findPlayerType,
-  findPlayerBuild,
-  sanitizeUsername,
-  standardizeUsername
-};

package/src/strings.ts

@@ -1,34 +0,0 @@
-export function capitalize(string: string | null): string | null {
-  if (!string) return null;
-  return string.charAt(0).toUpperCase() + string.slice(1);
-}
-
-export function formatNumber(num: number, withLetters = false) {
-  if (num === undefined || num === null) return -1;
-
-  // If number is float
-  if (num % 1 !== 0) {
-    return (Math.round(num * 100) / 100).toString().replace(/(\d)(?=(\d{3})+(?!\d))/g, '$1,');
-  }
-
-  if ((num < 10000 && num > -10000) || !withLetters) {
-    return num.toString().replace(/(\d)(?=(\d{3})+(?!\d))/g, '$1,');
-  }
-
-  // < 10 million
-  if (num < 10_000_000 && num > -10_000_000) {
-    return `${Math.floor(num / 1000)}k`;
-  }
-
-  // < 1 billion
-  if (num < 1_000_000_000 && num > -1_000_000_000) {
-    return `${Math.round((num / 1000000 + Number.EPSILON) * 100) / 100}m`;
-  }
-
-  return `${Math.round((num / 1000000000 + Number.EPSILON) * 100) / 100}b`;
-}
-
-export function padNumber(value: number): string {
-  if (!value) return '00';
-  return value < 10 ? `0${value}` : value.toString();
-}

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": ["es6", "dom", "es2017"],
-    "target": "es5",
-    "module": "commonjs",
-    "esModuleInterop": true,
-    "noImplicitAny": false,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "declaration": true
-  },
-  "exclude": ["node_modules", "dist"]
-}