@skyhelperbot/utils 2.0.0

package/dist/classes/UpdateTs.js

@@ -0,0 +1,62 @@
+/**
+ * @class
+ * @classdesc A class to update traveling spirit details in the client constructor
+ * @method update updates the ts details
+ * @returns {Object}
+ */
+export class UpdateTS {
+    data;
+    constructor(data) {
+        this.data = data;
+    }
+    /**
+     * Sets the name of the TS
+     * @param name Name of the returning TS
+     */
+    setName(name) {
+        if (!name || typeof name !== "string") {
+            throw new TypeError("Name must be a non-empty string.");
+        }
+        this.data.name = name;
+        return this;
+    }
+    /**
+     * Sets the visit date of the ts
+     * @param date Returnig date. Format: DD-MM-YYYY
+     */
+    setVisit(date) {
+        if (!date || typeof date !== "string") {
+            throw new TypeError("Date must be a non-empty string.");
+        }
+        this.data.visitDate = date;
+        return this;
+    }
+    /**
+     * Sets the value of the t spirit
+     * @param value The value of the spirit in the spiritsData
+     */
+    setValue(value) {
+        if (!value || typeof value !== "string") {
+            throw new TypeError("Value must be a non-empty string.");
+        }
+        this.data.value = value;
+        return this;
+    }
+    /**
+     * Sets the index of the returning ts
+     * @param index The returning index of the TS
+     */
+    setIndex(index) {
+        if (!index || typeof index !== "number") {
+            throw new TypeError("Index must be a number.");
+        }
+        this.data.index = index;
+        return this;
+    }
+    /**
+     * returns the updated ts details
+     */
+    async update() {
+        return await this.data.save();
+    }
+}

package/dist/classes/WinnerCard.d.ts

@@ -0,0 +1,13 @@
+import { User, GuildMember, Client } from "discord.js";
+export declare class GameWinnerCard {
+    private name;
+    private client;
+    private thumbnail;
+    private points;
+    private total;
+    constructor(winner: User | GuildMember, wins: number, total: number, client: Client);
+    private path;
+    private roundRect;
+    private changeFontSize;
+    build(): Promise<Buffer>;
+}

package/dist/classes/WinnerCard.js

@@ -0,0 +1,118 @@
+import { createCanvas, loadImage } from "@napi-rs/canvas";
+import { User, GuildMember, Client } from "discord.js";
+import { colors, fancyCount } from "./utils.js";
+import { join } from "path";
+const size = 100;
+// TODO: Integrate it with other game types
+export class GameWinnerCard {
+    name;
+    client;
+    thumbnail;
+    points;
+    total;
+    constructor(winner, wins, total, client) {
+        if (winner instanceof User) {
+            this.name = winner?.displayName || winner?.globalName || winner?.username;
+            this.thumbnail = winner?.displayAvatarURL({ forceStatic: true, extension: "jpg" });
+        }
+        if (winner instanceof GuildMember) {
+            this.name = winner.user?.globalName || winner?.displayName || winner.user.username;
+            this.thumbnail = winner.user?.displayAvatarURL({ forceStatic: true, extension: "jpg" });
+        }
+        this.client = client;
+        this.points = wins;
+        this.total = total;
+    }
+    path(strs) {
+        return join(__dirname, strs);
+    }
+    roundRect(ctx, x, y, w, h, r) {
+        if (w < 2 * r)
+            r = w / 2;
+        if (h < 2 * r)
+            r = h / 2;
+        ctx.beginPath();
+        ctx.moveTo(x + r, y);
+        ctx.arcTo(x + w, y, x + w, y + h, r);
+        ctx.arcTo(x + w, y + h, x, y + h, r);
+        ctx.arcTo(x, y + h, x, y, r);
+        ctx.arcTo(x, y, x + w, y, r);
+        ctx.closePath();
+        return ctx;
+    }
+    changeFontSize(ctx, _size) {
+        const fontArgs = ctx.font.split(" ");
+        ctx.font = `${_size} ${fontArgs.slice(1).join(" ")}`; // / using the last part
+        return ctx;
+    }
+    async build() {
+        const canvas = createCanvas(16 * size, 5 * size);
+        const ctx = canvas.getContext("2d");
+        const { width: w, height: h } = canvas;
+        ctx.font = "85px SegoeUI, SegoeUIEmoji";
+        ctx.fillStyle = colors.darkgrey;
+        this.roundRect(ctx, 0, 0, w, h, size * 0.75).clip();
+        ctx.fill();
+        // box-shadow: 0px 4px 4px rgba(0, 0, 0, 0.25);
+        // ctx.shadowOffsetY = 40;
+        // ctx.shadowColor = 'rgba(0, 0, 0, 0.25)';
+        // ctx.shadowOffsetX = 40;
+        // Avatar
+        //
+        ctx.save();
+        ctx.lineWidth = 6;
+        ctx.beginPath();
+        ctx.arc(h / 2, h / 2, h * 0.3, 0, Math.PI * 2, true);
+        ctx.closePath();
+        ctx.clip();
+        ctx.fillStyle = colors.grey;
+        ctx.fillRect(h * 0.2, h * 0.2, h * 0.6, h * 0.6);
+        ctx.drawImage(await loadImage(this.thumbnail), h * 0.2, h * 0.2, h * 0.6, h * 0.6);
+        ctx.restore();
+        // Status
+        ctx.save();
+        ctx.translate(size * 3.55, size * 3.55);
+        ctx.fillStyle = colors.darkgrey;
+        ctx.beginPath();
+        ctx.arc(0, 0, size * 0.4, 0, Math.PI * 2, true);
+        ctx.closePath();
+        ctx.fill();
+        ctx.drawImage(await loadImage(this.path("../../shared/assets/Win.png")), -size * 0.3, -size * 0.3, size * 0.6, size * 0.6);
+        ctx.restore();
+        // User Text
+        //
+        ctx.fillStyle = colors.blue;
+        this.changeFontSize(ctx, h * 0.17 + "px");
+        ctx.fillText(this.name, w * 0.3, h * 0.45, w * 0.425);
+        ctx.fillStyle = colors.idle;
+        ctx.fillText("#", w * 0.3 + w * 0.4375, h * 0.45);
+        ctx.fillStyle = colors.online;
+        ctx.fillText("1", w * 0.3 + w * 0.425 + w * 0.05, h * 0.45, w * 0.15625);
+        // Botlist URL
+        //
+        // ctx.textBaseline = 'middle';
+        ctx.textAlign = "center";
+        ctx.fillStyle = colors.blue;
+        this.roundRect(ctx, w * 0.5, -(w * 0.0625), w * 0.5, h * 0.4, w * 0.0625);
+        ctx.fill();
+        ctx.fillRect(w * 0.625, 0, w * 0.5, w * 0.0625);
+        ctx.fillStyle = colors.darkgrey;
+        this.changeFontSize(ctx, h * 0.15 + "px");
+        ctx.fillText("Sky CoTL Quiz Game", w * 0.55 + h * 0.65, h * 0.15, w * 0.421875);
+        // Counters
+        //
+        ctx.textAlign = "left";
+        ctx.fillStyle = colors.lightgrey;
+        ctx.drawImage(await loadImage(this.path("../../shared/assets/Point.png")), w * 0.3, h * 0.65, w * 0.0625, w * 0.0625);
+        this.changeFontSize(ctx, h * 0.15 + "px");
+        ctx.fillText(`${fancyCount(this.points)}/${fancyCount(this.total)} points`, w * 0.25 + h * 0.45, h * 0.65 + h * 0.15, h * 10);
+        // ctx.drawImage(await loadImage(this.path('../../shared/assets/vote.svg')), w * 0.6, h * 0.65, w * 0.0625, w * 0.0625);
+        //   ctx.fillText(fancyCount(this.total), w * 0.55 + h * 0.45, h * 0.65 + h * 0.15, h * 0.45);
+        // Library
+        ctx.fillStyle = colors.grey;
+        this.roundRect(ctx, w * 0.875, h * 0.6, h * 0.4, h * 0.4, h * 0.15).clip();
+        ctx.fill();
+        ctx.drawImage(await loadImage(this.client.user.displayAvatarURL({ forceStatic: true, extension: "jpg" })), w * 0.875, h * 0.6, h * 0.4, h * 0.4);
+        return canvas.toBuffer("image/png");
+    }
+}

package/dist/classes/index.d.ts

@@ -0,0 +1,7 @@
+export { LeaderboardCard } from "./LeaderBoardCard.js";
+export { GameWinnerCard } from "./WinnerCard.js";
+export { UpdateTS } from "./UpdateTs.js";
+export { UpdateEvent } from "./UpdateEvent.js";
+export { ShardsUtil } from "./shardsUtil.js";
+export { SkytimesUtils } from "./SkytimesUtils.js";
+export * from "./SkytimesUtils.js";

package/dist/classes/index.js

@@ -0,0 +1,7 @@
+export { LeaderboardCard } from "./LeaderBoardCard.js";
+export { GameWinnerCard } from "./WinnerCard.js";
+export { UpdateTS } from "./UpdateTs.js";
+export { UpdateEvent } from "./UpdateEvent.js";
+export { ShardsUtil } from "./shardsUtil.js";
+export { SkytimesUtils } from "./SkytimesUtils.js";
+export * from "./SkytimesUtils.js";

package/dist/classes/shardsUtil.d.ts

@@ -0,0 +1,41 @@
+import moment from "moment-timezone";
+import "moment-duration-format";
+import type { ShardsCountdown } from "../typings.js";
+/**
+ * Sequence of Shards pattern
+ */
+declare const shardSequence: readonly ["C", "b", "A", "a", "B", "b", "C", "a", "A", "b", "B", "a"];
+/**
+ * Sequence of realms pattern of shard
+ */
+declare const realmSequence: readonly ["prairie", "forest", "valley", "wasteland", "vault"];
+/**
+ * @class shardsUtil
+ * @classdesc A class to handle shards and realms indexing.
+ */
+export declare class ShardsUtil {
+    /**
+     * @method getDate - get provided date in moment
+     * @param  date - date to get in moment
+     */
+    static getDate(date?: string | undefined | null): moment.Moment | string;
+    /**
+     * Returns shards index for a given date
+     * @param date
+     */
+    static shardsIndex(date: moment.Moment): {
+        currentShard: (typeof shardSequence)[number];
+        currentRealm: (typeof realmSequence)[number];
+    };
+    /**
+     * Returns suffix for a given number
+     * @param number The number to get the suffix for
+     */
+    static getSuffix(number: number): string;
+    /**
+     * Get all three shards status for a given date relative to the current time
+     * @param date The date for which to get the status for
+     */
+    static getStatus(date: moment.Moment): ShardsCountdown[] | "No Shard";
+}
+export {};

package/dist/classes/shardsUtil.js

@@ -0,0 +1,122 @@
+import moment from "moment-timezone";
+import "moment-duration-format";
+import { shardsTimeline, shardConfig } from "../constants/index.js";
+/**
+ * Sequence of Shards pattern
+ */
+const shardSequence = ["C", "b", "A", "a", "B", "b", "C", "a", "A", "b", "B", "a"];
+/**
+ * Sequence of realms pattern of shard
+ */
+const realmSequence = ["prairie", "forest", "valley", "wasteland", "vault"];
+/**
+ * @class shardsUtil
+ * @classdesc A class to handle shards and realms indexing.
+ */
+export class ShardsUtil {
+    /**
+     * @method getDate - get provided date in moment
+     * @param  date - date to get in moment
+     */
+    static getDate(date) {
+        const timezone = "America/Los_Angeles";
+        let currentDate;
+        try {
+            if (date) {
+                currentDate = moment.tz(date, "Y-MM-DD", timezone).startOf("day");
+            }
+            else {
+                currentDate = moment().tz(timezone);
+            }
+            if (!currentDate.isValid()) {
+                return "invalid";
+            }
+            else {
+                return currentDate;
+            }
+        }
+        catch (error) {
+            throw new Error(error);
+        }
+    }
+    /**
+     * Returns shards index for a given date
+     * @param date
+     */
+    static shardsIndex(date) {
+        const dayOfMonth = date.date();
+        const shardIndex = (dayOfMonth - 1) % shardSequence.length;
+        const currentShard = shardSequence[shardIndex];
+        const realmIndex = (dayOfMonth - 1) % realmSequence.length;
+        const currentRealm = realmSequence[realmIndex];
+        return { currentShard, currentRealm };
+    }
+    /**
+     * Returns suffix for a given number
+     * @param number The number to get the suffix for
+     */
+    static getSuffix(number) {
+        const suffixes = ["th", "st", "nd", "rd"];
+        const remainder10 = number % 10;
+        const remainder100 = number % 100;
+        // Suffix for shards index
+        return suffixes[remainder10 === 1 && remainder100 !== 11
+            ? 1
+            : remainder10 === 2 && remainder100 !== 12
+                ? 2
+                : remainder10 === 3 && remainder100 !== 13
+                    ? 3
+                    : 0];
+    }
+    /**
+     * Get all three shards status for a given date relative to the current time
+     * @param date The date for which to get the status for
+     */
+    static getStatus(date) {
+        const timezone = "America/Los_Angeles";
+        const { currentShard } = this.shardsIndex(date);
+        const timings = shardsTimeline(date)[currentShard];
+        const present = moment().tz(timezone);
+        const isNoShard = shardConfig[currentShard].weekdays.includes(date.day());
+        if (isNoShard)
+            return "No Shard";
+        const toReturn = [];
+        for (let i = 0; i < timings.length; i++) {
+            const eventTiming = timings[i];
+            // Active
+            if (present.isBetween(eventTiming.start, eventTiming.end)) {
+                toReturn.push({
+                    index: i + 1,
+                    active: true,
+                    start: eventTiming.start,
+                    end: eventTiming.end,
+                    duration: moment.duration(eventTiming.end.diff(present)).format("d[d] h[h] m[m] s[s]"),
+                });
+                continue;
+                // Yet to fall
+            }
+            else if (present.isBefore(eventTiming.start)) {
+                toReturn.push({
+                    index: i + 1,
+                    active: false,
+                    start: eventTiming.start,
+                    end: eventTiming.end,
+                    duration: moment.duration(eventTiming.start.diff(present)).format("d[d] h[h] m[m] s[s]"),
+                });
+                continue;
+                // All ended
+            }
+            else if (present.isAfter(eventTiming.end)) {
+                toReturn.push({
+                    index: i + 1,
+                    ended: true,
+                    start: eventTiming.start,
+                    end: eventTiming.end,
+                    duration: moment.duration(present.diff(eventTiming.end)).format("d[d] h[h] m[m] s[s]"),
+                });
+                continue;
+            }
+        }
+        return toReturn;
+    }
+}

package/dist/classes/utils.d.ts

@@ -0,0 +1,13 @@
+export declare const colors: {
+    blue: string;
+    white: string;
+    lightgrey: string;
+    grey: string;
+    darkgrey: string;
+    black: string;
+    online: string;
+    offline: string;
+    dnd: string;
+    idle: string;
+};
+export declare function fancyCount(n: number): string;

package/dist/classes/utils.js

@@ -0,0 +1,22 @@
+export const colors = {
+    blue: "#7289DA",
+    white: "#FFFFFF",
+    lightgrey: "#99AAB5",
+    grey: "#2C2F33",
+    darkgrey: "#23272A",
+    black: "#000000",
+    online: "#2db85b",
+    offline: "#666",
+    dnd: "#cc3737",
+    idle: "#dab026",
+};
+export function fancyCount(n) {
+    if (n > 1000000)
+        return Math.floor(n / 1000000) + "M";
+    if (n > 1000) {
+        if (n < 10000)
+            return (n / 1000).toFixed(1) + "k";
+        return Math.floor(n / 1000) + "k";
+    }
+    return Math.floor(n) + "";
+}

package/dist/constants/eventDatas.d.ts

@@ -0,0 +1,31 @@
+export interface EventData {
+    [key: string]: {
+        /** Name of the event */
+        name: string;
+        /** The index of the event to appear on the embed */
+        index: number;
+        /** The Offset of the event (in minutes) */
+        offset: number;
+        /** Approximate duration of the event during which its active after it starts (in minutes) */
+        duration?: number;
+        /** The interval at which the event occurs (in minutes) */
+        interval?: number;
+        /** Whether to display all their occurrence times in the embed */
+        displayAllTimes?: boolean;
+        /** The days on which the event occurs */
+        occursOn?: {
+            /** Weekdays on which the event occurs */
+            weekDays?: number[];
+            /** The day on which the event occurs */
+            dayOfTheMonth?: number;
+        };
+        /** Infographic related to the event, if any (Discord link)*/
+        infographic?: {
+            /** Credit */
+            by: string;
+            /** The guide */
+            image: string;
+        };
+    };
+}
+export declare const eventData: EventData;

package/dist/constants/eventDatas.js

@@ -0,0 +1,105 @@
+const getMinutes = (hours) => hours * 60;
+export const eventData = {
+    geyser: {
+        name: "Geyser",
+        index: 0,
+        duration: 15,
+        offset: 0,
+        infographic: {
+            by: "Clement",
+            image: "https://media.discordapp.net/attachments/867638574571323424/1252998364941914243/Visit_Geyser_Clement.png?ex=66744129&is=6672efa9&hm=8d76d1767aca362d23547b1e3beb2b610f58e4fbec24b12af56fdc745f7074e8&",
+        },
+        displayAllTimes: true,
+        interval: getMinutes(2),
+    },
+    grandma: {
+        name: "Grandma",
+        index: 1,
+        duration: 15,
+        offset: 30,
+        infographic: {
+            by: "Clement",
+            image: "https://media.discordapp.net/attachments/867638574571323424/1252998366288416849/Visit_Grandma_Clement.png?ex=6674412a&is=6672efaa&hm=7228b695ec7008204fede2f3d6b4864a06a7cfa25a14ab4d7572957ee940044c&",
+        },
+        displayAllTimes: true,
+        interval: getMinutes(2),
+    },
+    turtle: {
+        name: "Turtle",
+        index: 2,
+        duration: 10,
+        offset: 50,
+        infographic: {
+            by: "Velvet",
+            image: "https://media.discordapp.net/attachments/867638574571323424/1252998363205472316/Visit_Turtle_Velvet.jpg?ex=66744129&is=6672efa9&hm=8c189ff8501fc88810606b832addbea8a9a81eb7a7a6b17019ff1ced593e1ae8&",
+        },
+        displayAllTimes: true,
+        interval: getMinutes(2),
+    },
+    "daily-reset": {
+        name: "Daily Reset",
+        index: 3,
+        offset: 0,
+        interval: getMinutes(24),
+    },
+    eden: {
+        name: "Eden/Weekly Reset",
+        index: 4,
+        offset: 0,
+        interval: getMinutes(24 * 7),
+        occursOn: { weekDays: [7] },
+    },
+    aurora: {
+        name: "Aurora's concert",
+        index: 5,
+        offset: 0,
+        duration: 50,
+        displayAllTimes: true,
+        interval: getMinutes(2),
+    },
+    "dream-skater": {
+        name: "Dream Skater",
+        index: 6,
+        duration: 15,
+        displayAllTimes: true,
+        occursOn: { weekDays: [5, 6, 7] },
+        offset: getMinutes(1),
+        interval: getMinutes(2),
+    },
+    "passage-quests": {
+        name: "Passage Quests",
+        index: 7,
+        offset: 0,
+        displayAllTimes: true,
+        interval: 15,
+    },
+    "nest-sunset": {
+        name: "Nest Sunset",
+        index: 8,
+        offset: 40,
+        displayAllTimes: true,
+        interval: getMinutes(1),
+    },
+    "fireworks-festival": {
+        name: "Fireworks Festival",
+        index: 9,
+        offset: 0,
+        displayAllTimes: true,
+        interval: getMinutes(4),
+        occursOn: { dayOfTheMonth: 1 },
+    },
+    "fairy-ring": {
+        name: "Fairy Ring",
+        index: 11,
+        offset: 50,
+        displayAllTimes: true,
+        interval: 60,
+    },
+    "brook-rainbow": {
+        name: "Forest Brook Rainbow",
+        index: 12,
+        displayAllTimes: true,
+        offset: getMinutes(5),
+        interval: getMinutes(12),
+    },
+};

package/dist/constants/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./shardsTimeline.js";
+export * from "./shardsInfo.js";
+export * from "./shardsInfo.js";
+export * from "./shardsTimeline.js";
+export * from "./eventDatas.js";

package/dist/constants/index.js

@@ -0,0 +1,5 @@
+export * from "./shardsTimeline.js";
+export * from "./shardsInfo.js";
+export * from "./shardsInfo.js";
+export * from "./shardsTimeline.js";
+export * from "./eventDatas.js";

package/dist/constants/shardsInfo.d.ts

@@ -0,0 +1,50 @@
+export declare const shardConfig: {
+    a: {
+        type: string;
+        colors: string;
+        weekdays: number[];
+    };
+    A: {
+        type: string;
+        colors: string;
+        weekdays: number[];
+    };
+    b: {
+        type: string;
+        colors: string;
+        weekdays: number[];
+    };
+    B: {
+        type: string;
+        colors: string;
+        weekdays: number[];
+    };
+    C: {
+        type: string;
+        colors: string;
+        weekdays: number[];
+    };
+};
+export interface ShardInfo {
+    area: string;
+    rewards: string;
+    image: string;
+    type: string;
+    colors: string;
+    weekdays: number[];
+    locations: {
+        description: string;
+        image: string;
+    }[];
+}
+export interface ShardsInfo {
+    [key: string]: {
+        [key: string]: ShardInfo;
+    };
+}
+/**
+ * Returns the shard information for each area
+ * @example
+ * const info = shardsInfo[currentRealm][currentShard]
+ */
+export declare const shardsInfo: ShardsInfo;