@fallencodes/seyfert-utils 1.4.2 → 1.5.0

package/build/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,OAAO,UAAU,eAAe,SAkBtC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,UAAU,eAAe,SAkBtC"}

package/build/logger.js

@@ -1,6 +1,7 @@
 import dayjs from 'dayjs';
 import { Logger } from 'seyfert';
 import { red, LogLevels, cyan, dim, yellow, bgRed, gray, bold } from 'seyfert/lib/common/index.js';
+/* My custom logger with more compact information. */
 export default function customizeLogger() {
     Logger.customize((_, level, args) => {
         let color = red;

package/build/options.d.ts

@@ -1,4 +1,4 @@
-import { OKFunction, GuildRole, StopFunction, AllGuildChannels, CommandContext, User } from 'seyfert';
+import { OKFunction, GuildRole, StopFunction, AllGuildChannels, CommandContext, User, OnOptionsReturnObject } from 'seyfert';
 interface StringOption {
     value: string;
     context: CommandContext;
@@ -10,5 +10,6 @@ export declare function relativeTimeOptionValue({ value }: StringOption, ok: OKF
 export declare function rolesOptionValue({ value: values, context }: StringOption, ok: OKFunction<[GuildRole, ...GuildRole[]]>, fail: StopFunction): Promise<void>;
 export declare function channelsOptionValue({ value: values, context }: StringOption, ok: OKFunction<[AllGuildChannels, ...AllGuildChannels[]]>, fail: StopFunction): Promise<void>;
 export declare function usersOptionValue({ value: values, context }: StringOption, ok: OKFunction<[User, ...User[]]>, fail: StopFunction): Promise<void>;
+export declare function validateOptions(metadata: OnOptionsReturnObject): Promise<string[]>;
 export {};
 //# sourceMappingURL=options.d.ts.map

package/build/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAOtG,UAAU,YAAY;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,cAAc,CAAC;CAC3B;AAGD,eAAO,MAAM,oBAAoB,GAAI,WAAW,YAAY,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,YAAY,SAGvG,CAAC;AAGF,eAAO,MAAM,mBAAmB,GAAI,WAAW,YAAY,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,YAAY,SAStG,CAAC;AAGF,wBAAgB,eAAe,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,QAIhG;AAGD,wBAAgB,uBAAuB,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,QAI1G;AAGD,wBAAsB,gBAAgB,CAClC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,YAAY,EACxC,EAAE,EAAE,UAAU,CAAC,CAAC,SAAS,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,EAC3C,IAAI,EAAE,YAAY,iBA4BrB;AAGD,wBAAsB,mBAAmB,CACrC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,YAAY,EACxC,EAAE,EAAE,UAAU,CAAC,CAAC,gBAAgB,EAAE,GAAG,gBAAgB,EAAE,CAAC,CAAC,EACzD,IAAI,EAAE,YAAY,iBA8BrB;AAED,wBAAsB,gBAAgB,CAClC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,YAAY,EACxC,EAAE,EAAE,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,EACjC,IAAI,EAAE,YAAY,iBAkBrB"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAS7H,UAAU,YAAY;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,cAAc,CAAC;CAC3B;AAGD,eAAO,MAAM,oBAAoB,GAAI,WAAW,YAAY,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,YAAY,SAGvG,CAAC;AAGF,eAAO,MAAM,mBAAmB,GAAI,WAAW,YAAY,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,YAAY,SAStG,CAAC;AAGF,wBAAgB,eAAe,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,YAAY,QAIhG;AAGD,wBAAgB,uBAAuB,CAAC,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,QAI1G;AAGD,wBAAsB,gBAAgB,CAClC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,YAAY,EACxC,EAAE,EAAE,UAAU,CAAC,CAAC,SAAS,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,EAC3C,IAAI,EAAE,YAAY,iBA4BrB;AAGD,wBAAsB,mBAAmB,CACrC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,YAAY,EACxC,EAAE,EAAE,UAAU,CAAC,CAAC,gBAAgB,EAAE,GAAG,gBAAgB,EAAE,CAAC,CAAC,EACzD,IAAI,EAAE,YAAY,iBA8BrB;AAGD,wBAAsB,gBAAgB,CAClC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,YAAY,EACxC,EAAE,EAAE,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,EACjC,IAAI,EAAE,YAAY,iBAkBrB;AAGD,wBAAsB,eAAe,CAAC,QAAQ,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAmDxF"}

package/build/options.js

@@ -3,6 +3,8 @@ import dayjs from 'dayjs';
 import ms from 'ms';
 import fuzzy from 'fuzzysort';
 import { channelMentionRegex, hexRegex, roleMentionRegex, userMentionRegex } from './variables.js';
+import { ChannelType } from 'seyfert/lib/types/index.js';
+import { noCase } from 'change-case';
 /* Returns a valid string snowflake value. */
 export const snowflakeOptionValue = ({ value }, ok, fail) => {
     if (isValidSnowflake(value))
@@ -106,6 +108,7 @@ export async function channelsOptionValue({ value: values, context }, ok, fail)
     ok(resolvedChannels);
 }
 ;
+/* Returns an array of users from the provided string value. */
 export async function usersOptionValue({ value: values, context }, ok, fail) {
     const resolvedUsers = [];
     for await (const value of values.split(',').map((value) => value.trim())) {
@@ -127,3 +130,71 @@ export async function usersOptionValue({ value: values, context }, ok, fail) {
     ok(resolvedUsers);
 }
 ;
+/* Checks the provided options for validation errors and returns user friendly error messages. */
+export async function validateOptions(metadata) {
+    const errorMessages = [];
+    for (const [option, error] of Object.entries(metadata)) {
+        if (!error.failed)
+            continue;
+        let errorMessage;
+        if (error.value.includes('is required but returned no value')) {
+            errorMessage = "is required but wasn't provided";
+        }
+        ;
+        if (error.value.includes('Unknown Role 10011'))
+            errorMessage = "isn't a valid role mention or ID";
+        if (error.value.includes('Unknown User 10013'))
+            errorMessage = "isn't a valid user mention or ID";
+        if (error.value.includes('Unknown Channel 10003'))
+            errorMessage = "isn't a valid channel mention or ID";
+        const parseError = error.parseError?.[0];
+        const parseErrorValue = error.parseError?.[1];
+        switch (parseError) {
+            case 'NUMBER_NAN':
+                errorMessage = `isn't a valid number.`;
+                break;
+            case 'NUMBER_MAX_VALUE':
+                errorMessage = `must be less than or equal to ${parseErrorValue}`;
+                break;
+            case 'NUMBER_MIN_VALUE':
+                errorMessage = `must be greater than or equal to ${parseErrorValue}`;
+                break;
+            case 'STRING_MAX_LENGTH':
+                errorMessage = `must be less than or equal to ${parseErrorValue} characters long`;
+                break;
+            case 'STRING_MIN_LENGTH':
+                errorMessage = `must be greater than or equal to ${parseErrorValue} characters long`;
+                break;
+            case 'NUMBER_INVALID_CHOICE':
+            case 'STRING_INVALID_CHOICE':
+                errorMessage = `must be equal to ${listFormat(parseErrorValue)}`;
+                break;
+            case 'CHANNEL_TYPES':
+                errorMessage = `must be a ${channelTypeFormat(parseErrorValue)} channel mention or ID`;
+                break;
+            case 'UNKNOWN':
+            case 'OPTION_REQUIRED':
+                errorMessage = `was provided but isn't valid`;
+                break;
+        }
+        ;
+        if (!errorMessage)
+            errorMessage = error.value.replace(`${option} `, '');
+        errorMessages.push(`The option "${option}" ${errorMessage}.`);
+    }
+    ;
+    return errorMessages;
+}
+;
+function listFormat(options) {
+    const formatter = new Intl.ListFormat('en', { style: 'long', type: 'disjunction' });
+    const mappedOptions = options.map((option) => {
+        return typeof option === 'string' ? option.toLowerCase() : option.value.toString().toLowerCase();
+    });
+    return formatter.format(mappedOptions);
+}
+;
+function channelTypeFormat(types) {
+    return listFormat(types.map((type) => noCase(ChannelType[type] ?? '').replace('guild ', '')));
+}
+;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fallencodes/seyfert-utils",
   "type": "module",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "license": "MIT",
   "description": "A collection of various utility/helper code I use in my Seyfert projects.",
   "main": "build/index.js",
@@ -34,12 +34,13 @@
   },
   "dependencies": {
     "@sapphire/snowflake": "^3.5.5",
+    "change-case": "^5.4.4",
     "dayjs": "^1.11.19",
     "fuzzysort": "^3.1.0",
     "ms": "^2.1.3",
     "multibyte": "^1.0.5",
     "nanoid": "^5.1.6",
-    "seyfert": "4.1.0"
+    "seyfert": "4.2.1"
   },
   "devDependencies": {
     "@types/ms": "^2.1.0",