feat: fix leap year rules, add year and month to the delay string

Author: rubyowo

backend/src/humanizeDuration.ts

@@ -0,0 +1,34 @@
+import humanizeduration from "humanize-duration";
+
+export const delayStringMultipliers = {
+  y: 1000 * 60 * 60 * 24 * (365 + 1 / 4 - 1 / 100 + 1 / 400), // 365 + 1/4 - 1/100 + 1/400 (leap year rules) = 365.2425 days
+  mo: 1000 * 60 * 60 * 24 * (365 + 1 / 4 - 1 / 100 + 1 / 400) / 12, // 365.2425 / 12 = 30.436875 days
+  w: 1000 * 60 * 60 * 24 * 7,
+  d: 1000 * 60 * 60 * 24,
+  h: 1000 * 60 * 60,
+  m: 1000 * 60,
+  s: 1000,
+  ms: 1,
+};
+
+export const humanizeDurationShort = humanizeduration.humanizer({
+  language: "shortEn",
+  languages: {
+    shortEn: {
+      y: () => "y",
+      mo: () => "mo",
+      w: () => "w",
+      d: () => "d",
+      h: () => "h",
+      m: () => "m",
+      s: () => "s",
+      ms: () => "ms",
+    },
+  },
+  spacer: "",
+  unitMeasures: delayStringMultipliers,
+});
+
+export const humanizeDuration = humanizeduration.humanizer({
+  unitMeasures: delayStringMultipliers
+})

backend/src/humanizeDurationShort.ts

@@ -1,6 +1,6 @@
 import z from "zod";
 import { SavedMessage } from "../../../data/entities/SavedMessage.js";
-import { humanizeDurationShort } from "../../../humanizeDurationShort.js";
+import { humanizeDurationShort } from "../../../humanizeDuration.js";
 import { getBaseUrl } from "../../../pluginUtils.js";
 import { convertDelayStringToMS, sorter, zDelayString } from "../../../utils.js";
 import { RecentActionType } from "../constants.js";

backend/src/plugins/Automod/functions/createMessageSpamTrigger.ts

@@ -1,5 +1,5 @@
 import { ContextMenuCommandInteraction } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import { ERRORS, RecoverablePluginError } from "../../../RecoverablePluginError.js";
 import { canActOn } from "../../../pluginUtils.js";

backend/src/plugins/ContextMenus/actions/mute.ts

@@ -1,4 +1,4 @@
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import moment from "moment-timezone";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { registerExpiringVCAlert } from "../../../data/loops/expiringVCAlertsLoop.js";

backend/src/plugins/LocateUser/commands/FollowCmd.ts

@@ -1,5 +1,5 @@
 import { GuildMember } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import {humanizeDuration} from "humanize-duration";
 import { GuildPluginData } from "knub";
 import moment from "moment-timezone";
 import { LogType } from "../../../data/LogType.js";

backend/src/plugins/Logs/logFunctions/logMemberJoin.ts

@@ -1,4 +1,4 @@
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { getMemberLevel } from "knub/helpers";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { CaseTypes } from "../../../data/CaseTypes.js";

backend/src/plugins/ModActions/commands/BanCmd.ts

@@ -4,7 +4,7 @@ import { performance } from "perf_hooks";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { CaseTypes } from "../../../data/CaseTypes.js";
 import { LogType } from "../../../data/LogType.js";
-import { humanizeDurationShort } from "../../../humanizeDurationShort.js";
+import { humanizeDurationShort } from "../../../humanizeDuration.js";
 import { canActOn, sendErrorMessage, sendSuccessMessage } from "../../../pluginUtils.js";
 import { CasesPlugin } from "../../../plugins/Cases/CasesPlugin.js";
 import { DAYS, MINUTES, SECONDS, noop } from "../../../utils.js";

backend/src/plugins/ModActions/commands/MassBanCmd.ts

@@ -1,5 +1,5 @@
 import { GuildMember, GuildTextBasedChannel, Message, User } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import { ERRORS, RecoverablePluginError } from "../../../RecoverablePluginError.js";
 import { logger } from "../../../logger.js";

backend/src/plugins/ModActions/functions/actualMuteUserCmd.ts

@@ -1,5 +1,5 @@
 import { GuildMember, Message, User } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import { hasPermission, sendErrorMessage, sendSuccessMessage } from "../../../pluginUtils.js";
 import { MutesPlugin } from "../../../plugins/Mutes/MutesPlugin.js";

backend/src/plugins/ModActions/functions/actualUnmuteUserCmd.ts

@@ -1,5 +1,5 @@
 import { DiscordAPIError, Snowflake } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../data/CaseTypes.js";
 import { LogType } from "../../../data/LogType.js";

backend/src/plugins/ModActions/functions/banUserId.ts

@@ -1,5 +1,5 @@
 import { Snowflake } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import moment from "moment-timezone";
 import { CaseTypes } from "../../../data/CaseTypes.js";

backend/src/plugins/ModActions/functions/clearTempban.ts

@@ -8,7 +8,7 @@ import {
 } from "discord.js";
 import moment from "moment-timezone";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
-import { humanizeDurationShort } from "../../../humanizeDurationShort.js";
+import { humanizeDurationShort } from "../../../humanizeDuration.js";
 import { getBaseUrl } from "../../../pluginUtils.js";
 import { DBDateFormat, MINUTES, renderUsername, resolveMember } from "../../../utils.js";
 import { IMuteWithDetails, mutesCmd } from "../types.js";

backend/src/plugins/Mutes/commands/MutesCmd.ts

@@ -1,5 +1,5 @@
 import { Snowflake } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import { ERRORS, RecoverablePluginError } from "../../../RecoverablePluginError.js";
 import { CaseTypes } from "../../../data/CaseTypes.js";

backend/src/plugins/Mutes/functions/muteUser.ts

@@ -1,5 +1,5 @@
 import { Snowflake } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../data/CaseTypes.js";
 import { AddMuteParams } from "../../../data/GuildMutes.js";

backend/src/plugins/Mutes/functions/unmuteUser.ts

@@ -1,5 +1,5 @@
 import { escapeCodeBlock } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import moment from "moment-timezone";
 import { createChunkedMessage, DBDateFormat, deactivateMentions, sorter, trimLines } from "../../../utils.js";
 import { TimeAndDatePlugin } from "../../TimeAndDate/TimeAndDatePlugin.js";

backend/src/plugins/Post/commands/ScheduledPostsListCmd.ts

@@ -1,5 +1,5 @@
 import { GuildTextBasedChannel, Message } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import moment from "moment-timezone";
 import { registerUpcomingScheduledPost } from "../../../data/loops/upcomingScheduledPostsLoop.js";

backend/src/plugins/Post/util/actualPostCmd.ts

@@ -1,4 +1,4 @@
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import moment from "moment-timezone";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { registerUpcomingReminder } from "../../../data/loops/upcomingRemindersLoop.js";

backend/src/plugins/Reminders/commands/RemindCmd.ts

@@ -1,4 +1,4 @@
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import moment from "moment-timezone";
 import { sendErrorMessage } from "../../../pluginUtils.js";
 import { createChunkedMessage, DBDateFormat, sorter } from "../../../utils.js";

backend/src/plugins/Reminders/commands/RemindersCmd.ts

@@ -1,4 +1,4 @@
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { slowmodeCmd } from "../types.js";
 

backend/src/plugins/Slowmode/commands/SlowmodeGetCmd.ts

@@ -1,5 +1,5 @@
 import { GuildChannel, TextChannel } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { createChunkedMessage } from "knub/helpers";
 import { errorMessage } from "../../../utils.js";
 import { slowmodeCmd } from "../types.js";

backend/src/plugins/Slowmode/commands/SlowmodeListCmd.ts

@@ -1,5 +1,5 @@
 import { escapeInlineCode, PermissionsBitField } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { sendErrorMessage, sendSuccessMessage } from "../../../pluginUtils.js";
 import { asSingleLine, DAYS, HOURS, MINUTES } from "../../../utils.js";

backend/src/plugins/Slowmode/commands/SlowmodeSetCmd.ts

@@ -1,5 +1,5 @@
 import { Snowflake } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../humanizeDuration.js";
 import { PluginOptions, guildPlugin } from "knub";
 import moment from "moment-timezone";
 import { GuildArchives } from "../../data/GuildArchives.js";

backend/src/plugins/Tags/TagsPlugin.ts

@@ -1,5 +1,5 @@
 import { APIEmbed, GuildChannel } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import LCL from "last-commit-log";
 import shuffle from "lodash/shuffle.js";
 import moment from "moment-timezone";

backend/src/plugins/Utility/commands/AboutCmd.ts

@@ -4,7 +4,7 @@ import { allowTimeout } from "../../../RegExpRunner.js";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { LogType } from "../../../data/LogType.js";
 import { SavedMessage } from "../../../data/entities/SavedMessage.js";
-import { humanizeDurationShort } from "../../../humanizeDurationShort.js";
+import { humanizeDurationShort } from "../../../humanizeDuration.js";
 import { getBaseUrl, sendErrorMessage, sendSuccessMessage } from "../../../pluginUtils.js";
 import { ModActionsPlugin } from "../../../plugins/ModActions/ModActionsPlugin.js";
 import { DAYS, SECONDS, chunkArray, getInviteCodesInString, noop } from "../../../utils.js";

backend/src/plugins/Utility/commands/CleanCmd.ts

@@ -1,5 +1,5 @@
 import { APIEmbed, ChannelType, Snowflake, StageChannel, VoiceChannel } from "discord.js";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { GuildPluginData } from "knub";
 import { EmbedWith, MINUTES, formatNumber, preEmbedPadding, trimLines, verboseUserMention } from "../../../utils.js";
 import { UtilityPluginType } from "../types.js";

backend/src/plugins/Utility/functions/getChannelInfoEmbed.ts

@@ -28,7 +28,7 @@ import {
 import emojiRegex from "emoji-regex";
 import fs from "fs";
 import https from "https";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration, delayStringMultipliers } from "./humanizeDuration.js"
 import isEqual from "lodash/isEqual.js";
 import { performance } from "perf_hooks";
 import tlds from "tlds" assert { type: "json" };
@@ -44,21 +44,14 @@ import { waitForButtonConfirm } from "./utils/waitForInteraction.js";
 
 const fsp = fs.promises;
 
-const delayStringMultipliers = {
-  w: 1000 * 60 * 60 * 24 * 7,
-  d: 1000 * 60 * 60 * 24,
-  h: 1000 * 60 * 60,
-  m: 1000 * 60,
-  s: 1000,
-  x: 1,
-};
-
 export const MS = 1;
 export const SECONDS = 1000 * MS;
 export const MINUTES = 60 * SECONDS;
 export const HOURS = 60 * MINUTES;
 export const DAYS = 24 * HOURS;
-export const WEEKS = 7 * 24 * HOURS;
+export const WEEKS = 7 * DAYS;
+export const YEARS = (365 + 1/4 - 1/100 + 1/400) * DAYS;
+export const MONTHS = YEARS / 12;
 
 export const EMPTY_CHAR = "\u200b";
 
@@ -407,7 +400,7 @@ const MAX_DELAY_STRING_AMOUNT = 100 * 365 * DAYS;
  * Turns a "delay string" such as "1h30m" to milliseconds
  */
 export function convertDelayStringToMS(str, defaultUnit = "m"): number | null {
-  const regex = /^([0-9]+)\s*([wdhms])?[a-z]*\s*/;
+  const regex = /^([0-9]+)\s*((?:mo?)|[ywdhs])?[a-z]*\s*/;
   let match;
   let ms = 0;
 

backend/src/utils.ts

@@ -108,7 +108,7 @@ import {
   GuildState,
   RootState
 } from "../../store/types";
-import humanizeDuration from "humanize-duration";
+import { humanizeDuration } from "humanize-duration";
 import moment from "moment";
 
 export default {