@skyhelperbot/utils 2.0.2 → 2.1.1

package/dist/typings.d.ts

@@ -1,5 +1,29 @@
-import { Client, Collection } from "discord.js";
-import moment from "moment-timezone";
+/// <reference types="mongoose/types/aggregate.js" />
+/// <reference types="mongoose/types/callback.js" />
+/// <reference types="mongoose/types/collection.js" />
+/// <reference types="mongoose/types/connection.js" />
+/// <reference types="mongoose/types/cursor.js" />
+/// <reference types="mongoose/types/document.js" />
+/// <reference types="mongoose/types/error.js" />
+/// <reference types="mongoose/types/expressions.js" />
+/// <reference types="mongoose/types/helpers.js" />
+/// <reference types="mongoose/types/middlewares.js" />
+/// <reference types="mongoose/types/indexes.js" />
+/// <reference types="mongoose/types/models.js" />
+/// <reference types="mongoose/types/mongooseoptions.js" />
+/// <reference types="mongoose/types/pipelinestage.js" />
+/// <reference types="mongoose/types/populate.js" />
+/// <reference types="mongoose/types/query.js" />
+/// <reference types="mongoose/types/schemaoptions.js" />
+/// <reference types="mongoose/types/schematypes.js" />
+/// <reference types="mongoose/types/session.js" />
+/// <reference types="mongoose/types/types.js" />
+/// <reference types="mongoose/types/utility.js" />
+/// <reference types="mongoose/types/validation.js" />
+/// <reference types="mongoose/types/virtuals.js" />
+/// <reference types="mongoose/types/inferschematype.js" />
+/// <reference types="mongoose/types/inferrawdoctype.js" />
+import type { DateTime } from "luxon";
 import { Document } from "mongoose";
 /** Data of users provided for making a game leaderboard card */
 export interface userData {
@@ -34,13 +58,10 @@ export interface Background {
 export interface SkyEvent {
     eventActive: Boolean;
     eventName: string;
-    eventStarts: moment.Moment;
-    eventEnds: moment.Moment;
+    eventStarts: DateTime;
+    eventEnds: DateTime;
     eventDuration: string;
 }
-export interface SkyHelper extends Client {
-    skyEvents: Collection<string, SkyEvent>;
-}
 export interface TSData extends Document {
     name: string;
     visitDate: string;
@@ -56,7 +77,7 @@ export interface ShardsCountdown {
     index: number;
     active?: boolean;
     ended?: boolean;
-    start: moment.Moment;
-    end: moment.Moment;
+    start: DateTime;
+    end: DateTime;
     duration: string;
 }

package/dist/typings.js

@@ -1,3 +1 @@
-import { Client, Collection } from "discord.js";
-import moment from "moment-timezone";
 import { Document } from "mongoose";

package/dist/utils/index.d.ts

@@ -1,5 +1,5 @@
-export { buildTimesHTML, type Field } from "./buildTimesHTML.js";
-export { postToHaste } from "./postToBin.js";
-export { parsePerms, type Permission } from "./parsePerms.js";
-export { recursiveReadDir } from "./recursiveReadDir.js";
-export { parseDateFormat } from "./parseDateFormat.js";
+export * from "./postToBin.js";
+export * from "./parsePerms.js";
+export * from "./recursiveReadDir.js";
+export * from "./parseDateFormat.js";
+export * from "./resolveColors.js";

package/dist/utils/index.js

@@ -1,5 +1,5 @@
-export { buildTimesHTML } from "./buildTimesHTML.js";
-export { postToHaste } from "./postToBin.js";
-export { parsePerms } from "./parsePerms.js";
-export { recursiveReadDir } from "./recursiveReadDir.js";
-export { parseDateFormat } from "./parseDateFormat.js";
+export * from "./postToBin.js";
+export * from "./parsePerms.js";
+export * from "./recursiveReadDir.js";
+export * from "./parseDateFormat.js";
+export * from "./resolveColors.js";

package/dist/utils/resolveColors.d.ts

@@ -0,0 +1,79 @@
+/** Original code credit to discord.js */
+/**
+ * Can be a number, hex string, an RGB array like:
+ * ```js
+ * [255, 0, 255] // purple
+ * ```
+ * or one of the following strings:
+ * - `Default`
+ * - `White`
+ * - `Aqua`
+ * - `Green`
+ * - `Blue`
+ * - `Yellow`
+ * - `Purple`
+ * - `LuminousVividPink`
+ * - `Fuchsia`
+ * - `Gold`
+ * - `Orange`
+ * - `Red`
+ * - `Grey`
+ * - `Navy`
+ * - `DarkAqua`
+ * - `DarkGreen`
+ * - `DarkBlue`
+ * - `DarkPurple`
+ * - `DarkVividPink`
+ * - `DarkGold`
+ * - `DarkOrange`
+ * - `DarkRed`
+ * - `DarkGrey`
+ * - `DarkerGrey`
+ * - `LightGrey`
+ * - `DarkNavy`
+ * - `Blurple`
+ * - `Greyple`
+ * - `DarkButNotBlack`
+ * - `NotQuiteBlack`
+ * - `Random`
+ */
+export type ColorResolvable = keyof typeof Colors | "Random" | "Default" | `#${string}` | number | number[];
+/**
+ * Resolves a ColorResolvable into a color number.
+ * @param  color Color to resolve
+ * @returns  A color
+ */
+export declare function resolveColor(color: ColorResolvable): number;
+declare const Colors: {
+    Default: number;
+    White: number;
+    Aqua: number;
+    Green: number;
+    Blue: number;
+    Yellow: number;
+    Purple: number;
+    LuminousVividPink: number;
+    Fuchsia: number;
+    Gold: number;
+    Orange: number;
+    Red: number;
+    Grey: number;
+    Navy: number;
+    DarkAqua: number;
+    DarkGreen: number;
+    DarkBlue: number;
+    DarkPurple: number;
+    DarkVividPink: number;
+    DarkGold: number;
+    DarkOrange: number;
+    DarkRed: number;
+    DarkGrey: number;
+    DarkerGrey: number;
+    LightGrey: number;
+    DarkNavy: number;
+    Blurple: number;
+    Greyple: number;
+    DarkButNotBlack: number;
+    NotQuiteBlack: number;
+};
+export {};

package/dist/utils/resolveColors.js

@@ -0,0 +1,63 @@
+/** Original code credit to discord.js */
+/**
+ * Resolves a ColorResolvable into a color number.
+ * @param  color Color to resolve
+ * @returns  A color
+ */
+export function resolveColor(color) {
+    let resolvedColor;
+    if (typeof color === "string") {
+        if (color === "Random")
+            return Math.floor(Math.random() * (0xffffff + 1));
+        if (color === "Default")
+            return 0;
+        if (/^#?[\da-f]{6}$/i.test(color))
+            return parseInt(color.replace("#", ""), 16);
+        resolvedColor = Colors[color];
+    }
+    else if (Array.isArray(color)) {
+        resolvedColor = (color[0] << 16) + (color[1] << 8) + color[2];
+    }
+    else {
+        resolvedColor = color;
+    }
+    if (!Number.isInteger(resolvedColor)) {
+        throw new Error("Not a number");
+    }
+    if (resolvedColor < 0 || resolvedColor > 0xffffff) {
+        throw new Error("Not in color range");
+    }
+    return resolvedColor;
+}
+const Colors = {
+    Default: 0x000000,
+    White: 0xffffff,
+    Aqua: 0x1abc9c,
+    Green: 0x57f287,
+    Blue: 0x3498db,
+    Yellow: 0xfee75c,
+    Purple: 0x9b59b6,
+    LuminousVividPink: 0xe91e63,
+    Fuchsia: 0xeb459e,
+    Gold: 0xf1c40f,
+    Orange: 0xe67e22,
+    Red: 0xed4245,
+    Grey: 0x95a5a6,
+    Navy: 0x34495e,
+    DarkAqua: 0x11806a,
+    DarkGreen: 0x1f8b4c,
+    DarkBlue: 0x206694,
+    DarkPurple: 0x71368a,
+    DarkVividPink: 0xad1457,
+    DarkGold: 0xc27c0e,
+    DarkOrange: 0xa84300,
+    DarkRed: 0x992d22,
+    DarkGrey: 0x979c9f,
+    DarkerGrey: 0x7f8c8d,
+    LightGrey: 0xbcc0c0,
+    DarkNavy: 0x2c3e50,
+    Blurple: 0x5865f2,
+    Greyple: 0x99aab5,
+    DarkButNotBlack: 0x2c2f33,
+    NotQuiteBlack: 0x23272a,
+};

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@skyhelperbot/utils",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "description": "Utilities for SkyHelper bot",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/imnaiyar/skyhelper/packages/utils"
+    "url": "https://github.com/imnaiyar/skyhelper.git",
+    "directory": "packages/utils"
   },
   "keywords": [
     "SkyHelperUtils",
@@ -24,21 +25,24 @@
   "bugs": {
     "url": "https://github.com/imnaiyar/skyhelper/issues"
   },
-  "homepage": "https://github.com/imnaiyar/skyhelper/packages/utils#readme",
+  "homepage": "https://github.com/imnaiyar/skyhelper/tree/main/packages/utils",
   "dependencies": {
     "@napi-rs/canvas": "^0.1.51",
-    "discord.js": "14.16.2",
-    "moment-duration-format": "^2.3.2",
-    "moment-timezone": "^0.5.45",
-    "typescript": "^5.4.3",
-    "undici": "^6.13.0"
+    "discord-api-types": "^0.37.93",
+    "undici": "^7.2.3"
   },
   "devDependencies": {
-    "@types/moment-duration-format": "^2.2.6",
-    "mongoose": "^8.3.2"
+    "@types/luxon": "^3.4.2",
+    "luxon": "^3.5.0",
+    "mongoose": "^8.3.2",
+    "typescript": "^5.4.3"
+  },
+  "peerDependencies": {
+    "luxon": "^3.5.0"
   },
   "scripts": {
     "build": "tsc && echo 'Files compiled'",
-    "build:docs": "typedoc"
+    "build:docs": "typedoc",
+    "lint": "eslint --fix src"
   }
 }

package/dist/classes/UpdateEvent.d.ts

@@ -1,30 +0,0 @@
-import type { SpecialEventData } from "../typings.js";
-/**
- * @class
- * @classdesc A class to update Events details in the client constructor
- * @method update Updates the event details
- */
-export declare class UpdateEvent {
-    readonly data: SpecialEventData;
-    constructor(data: SpecialEventData);
-    /**
-     * @param name Name of the event
-     */
-    setName(name: string): this;
-    /**
-     * @param date Start date of the Event. Format DD-MM-YYYY
-     * @example
-     * new UpdateEvent().setDate('22-09-2023')
-     */
-    setStart(date: string): this;
-    /**
-     * @param date End date of the Event. Format DD-MM-YYYY
-     * @example
-     * new UpdateEvent().setDate('22-09-2023')
-     */
-    setEnd(date: string): this;
-    /**
-     * @returns The updated event
-     */
-    update(): Promise<SpecialEventData>;
-}

package/dist/classes/UpdateEvent.js

@@ -1,52 +0,0 @@
-import moment from "moment-timezone";
-/**
- * @class
- * @classdesc A class to update Events details in the client constructor
- * @method update Updates the event details
- */
-export class UpdateEvent {
-    data;
-    constructor(data) {
-        this.data = data;
-    }
-    /**
-     * @param name Name of the event
-     */
-    setName(name) {
-        if (!name || typeof name !== "string") {
-            throw new TypeError("Name must be a non-empty string.");
-        }
-        this.data.name = name;
-        return this;
-    }
-    /**
-     * @param date Start date of the Event. Format DD-MM-YYYY
-     * @example
-     * new UpdateEvent().setDate('22-09-2023')
-     */
-    setStart(date) {
-        if (!date || typeof date !== "string") {
-            throw new TypeError("Date must be a non-empty string.");
-        }
-        this.data.startDate = date;
-        return this;
-    }
-    /**
-     * @param date End date of the Event. Format DD-MM-YYYY
-     * @example
-     * new UpdateEvent().setDate('22-09-2023')
-     */
-    setEnd(date) {
-        if (!date || typeof date !== "string") {
-            throw new TypeError("Date must be a non-empty string.");
-        }
-        this.data.endDate = date;
-        return this;
-    }
-    /**
-     * @returns The updated event
-     */
-    async update() {
-        return await this.data.save();
-    }
-}

package/dist/classes/UpdateTs.d.ts

@@ -1,35 +0,0 @@
-import type { TSData } from "../typings.js";
-/**
- * @class
- * @classdesc A class to update traveling spirit details in the client constructor
- * @method update updates the ts details
- * @returns {Object}
- */
-export declare class UpdateTS {
-    readonly data: TSData;
-    constructor(data: TSData);
-    /**
-     * Sets the name of the TS
-     * @param name Name of the returning TS
-     */
-    setName(name: string): this;
-    /**
-     * Sets the visit date of the ts
-     * @param date Returnig date. Format: DD-MM-YYYY
-     */
-    setVisit(date: string): this;
-    /**
-     * Sets the value of the t spirit
-     * @param value The value of the spirit in the spiritsData
-     */
-    setValue(value: string): this;
-    /**
-     * Sets the index of the returning ts
-     * @param index The returning index of the TS
-     */
-    setIndex(index: number): this;
-    /**
-     * returns the updated ts details
-     */
-    update(): Promise<TSData>;
-}

package/dist/classes/UpdateTs.js

@@ -1,62 +0,0 @@
-/**
- * @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/utils/buildTimesHTML.d.ts

@@ -1,14 +0,0 @@
-import { type ChatInputCommandInteraction } from "discord.js";
-export interface Field {
-    name: string;
-    example: string;
-    value: string;
-}
-/**
- * Dynamically builds a timestamp sweb page html with the given data
- * @param interaction The interaction that intiated this
- * @param  fieldsData The data about times
- * @param  offset Offset of the timezone
- * @param  providedTime
- */
-export declare const buildTimesHTML: (interaction: ChatInputCommandInteraction, fieldsData: Field[], offset: string, providedTime: string) => string;