Change to enums

Author: TurtlePaw

dist/src/Classes/Category.js

@@ -117,10 +117,10 @@ var Category = /** @class */ (function () {
      * @static
      */
     Category.isNameResolvable = function (arg) {
-        var _a, _b;
+        var _a;
         var completeNameList = __spreadArray(__spreadArray([], Object.keys(this.allPrettyNames), true), Object.keys(this.allNames), true).filter(function (str) { return isNaN(str); })
             .map(function (str) { return str.toLowerCase(); });
-        return completeNameList.includes((_b = (_a = arg) === null || _a === void 0 ? void 0 : _a.toLowerCase) === null || _b === void 0 ? void 0 : _b.call(_a));
+        return completeNameList.includes((_a = arg === null || arg === void 0 ? void 0 : arg.toLowerCase) === null || _a === void 0 ? void 0 : _a.call(arg));
     };
     /**
      * Converts a category's pretty name into it's strict version
@@ -150,7 +150,7 @@ var Category = /** @class */ (function () {
      * @static
      */
     Category.random = function (type) {
-        if (type === void 0) { type = "ID"; }
+        if (type === void 0) { type = enums_1.CategoryType.Id; }
         var names = Object.keys(this.allPrettyNames).filter(function (val) {
             return isNaN(+val);
         });

dist/src/Classes/Category.test.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var enums_1 = require("../Typings/enums");
 var Category_1 = require("./Category");
 function createInstance(arg) {
     return new Category_1.default(arg);
@@ -94,9 +95,9 @@ test("Test outputs of Category.strictToPrettyName()", function () {
     expect(Category_1.default.strictToPrettyName("text")).toBe(null);
     expect(Category_1.default.strictToPrettyName(true)).toBe(null);
     expect(Category_1.default.strictToPrettyName("General Knowledge")).toBe(null);
-    expect(Category_1.default.strictToPrettyName("GENERAL_KNOWLEDGE")).toBe("General Knowledge");
+    expect(Category_1.default.strictToPrettyName("GeneralKnowledge")).toBe("General Knowledge");
     expect(Category_1.default.strictToPrettyName("Entertainment: Cartoon and Animations")).toBe(null);
-    expect(Category_1.default.strictToPrettyName("ENTERTAINMENT_CARTOON_AND_ANIMATIONS")).toBe("Entertainment: Cartoon and Animations");
+    expect(Category_1.default.strictToPrettyName("EntertainmentCartoonAndAnimations")).toBe("Entertainment: Cartoon and Animations");
 });
 test("Tests outputs for Category.random()", function () {
     expect(Category_1.default.random(1)).toBeGreaterThanOrEqual(9);
@@ -105,9 +106,9 @@ test("Tests outputs for Category.random()", function () {
     expect(Category_1.default.random({})).toBeLessThanOrEqual(32);
     expect(Category_1.default.random(true)).toBeGreaterThanOrEqual(9);
     expect(Category_1.default.random(true)).toBeLessThanOrEqual(32);
-    expect(Category_1.default.random("ID")).toBeGreaterThanOrEqual(9);
-    expect(Category_1.default.random("ID")).toBeLessThanOrEqual(32);
-    expect(typeof Category_1.default.random("NAME")).toBe("string");
+    expect(Category_1.default.random(enums_1.CategoryType.Id)).toBeGreaterThanOrEqual(9);
+    expect(Category_1.default.random(enums_1.CategoryType.Id)).toBeLessThanOrEqual(32);
+    expect(typeof Category_1.default.random(enums_1.CategoryType.Name)).toBe("string");
 });
 test("Tests outputs for Category.resolve()", function () {
     expect(Category_1.default.resolve(8)).toBe(null);

dist/src/Classes/Validator.d.ts

@@ -1,13 +1,13 @@
+import { QuestionDifficulties, QuestionEncodings, QuestionTypes } from "../Typings/enums";
 import { QuestionOptions } from "../Typings/interfaces";
-import { QuestionDifficulty } from "../Typings/types";
 export default class Validator {
     private readonly options;
     constructor(options: QuestionOptions);
     checkAmount(): number | null;
     checkCategory(): number | null;
-    checkDifficulty(): QuestionDifficulty | null;
-    checkEncode(): "none" | "base64" | "url3986" | "urlLegacy" | null;
+    checkDifficulty(): QuestionDifficulties | null;
+    checkEncode(): QuestionEncodings | null;
     checkToken(): string | null;
-    checkType(): "boolean" | "multiple" | null;
+    checkType(): QuestionTypes | null;
     static _checkCategory(category: unknown): number | null;
 }

dist/src/Classes/Validator.js

@@ -83,7 +83,11 @@ var Validator = /** @class */ (function () {
         if (typeof difficulty != "string") {
             throw new CustomErrors_1.OpenTDBError("'difficulty' option for QuestionOptions must be of type string, received ".concat(typeof difficulty), CustomErrors_1.OpenTDBError.errors.headers.INVALID_OPT);
         }
-        var values = ["easy", "medium", "hard"];
+        var values = [
+            enums_1.QuestionDifficulties.Easy,
+            enums_1.QuestionDifficulties.Medium,
+            enums_1.QuestionDifficulties.Hard
+        ];
         if (!values.includes(difficulty)) {
             throw new CustomErrors_1.OpenTDBError("'difficulty' option (\"".concat(difficulty, "\") for QuestionOptions does not resolve into a question difficulty"), CustomErrors_1.OpenTDBError.errors.headers.INVALID_OPT);
         }
@@ -97,10 +101,10 @@ var Validator = /** @class */ (function () {
             throw new CustomErrors_1.OpenTDBError("'encode' option for QuestionOptions must be of type string, received ".concat(typeof encode), CustomErrors_1.OpenTDBError.errors.headers.INVALID_OPT);
         }
         var values = [
-            "base64",
-            "none",
-            "url3986",
-            "urlLegacy",
+            enums_1.QuestionEncodings.UrlLegacy,
+            enums_1.QuestionEncodings.Url3986,
+            enums_1.QuestionEncodings.Base64,
+            enums_1.QuestionEncodings.None
         ];
         if (!values.includes(encode)) {
             throw new CustomErrors_1.OpenTDBError("'encode' option (\"".concat(encode, "\") for QuestionOptions does not resolve into a question encode"), CustomErrors_1.OpenTDBError.errors.headers.INVALID_OPT);
@@ -126,7 +130,10 @@ var Validator = /** @class */ (function () {
         if (typeof type != "string") {
             throw new CustomErrors_1.OpenTDBError("'type' option for QuestionOptions must be of type string, received ".concat(typeof type), CustomErrors_1.OpenTDBError.errors.headers.INVALID_OPT);
         }
-        var values = ["boolean", "multiple"];
+        var values = [
+            enums_1.QuestionTypes.Boolean,
+            enums_1.QuestionTypes.Multiple
+        ];
         if (!values.includes(type)) {
             throw new CustomErrors_1.OpenTDBError("'type' option (\"".concat(type, "\") for QuestionOptions does not resolve into a question type"), CustomErrors_1.OpenTDBError.errors.headers.INVALID_OPT);
         }

dist/src/Classes/Validator.test.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//@ts-nocheck
+var enums_1 = require("../Typings/enums");
 var Validator_1 = require("./Validator");
 function createInstance(options) {
     return new Validator_1.default(options);
@@ -105,8 +107,8 @@ test("tests output of Validator.checkDifficulty()", function () {
     expect(function () {
         validator.checkDifficulty();
     }).toThrow(TypeError);
-    validator = createInstance({ difficulty: "easy" });
-    expect(validator.checkDifficulty()).toEqual("easy");
+    validator = createInstance({ difficulty: enums_1.QuestionDifficulties.Easy });
+    expect(validator.checkDifficulty()).toEqual(enums_1.QuestionDifficulties.Easy);
     validator = createInstance({ difficulty: undefined });
     expect(validator.checkDifficulty()).toEqual(null);
     validator = createInstance({ difficulty: null });
@@ -141,8 +143,8 @@ test("tests output of Validator.checkEncoding()", function () {
     expect(function () {
         validator.checkEncode();
     }).toThrow(TypeError);
-    validator = createInstance({ encode: "base64" });
-    expect(validator.checkEncode()).toEqual("base64");
+    validator = createInstance({ encode: enums_1.QuestionEncodings.Base64 });
+    expect(validator.checkEncode()).toEqual(enums_1.QuestionEncodings.Base64);
     validator = createInstance({ encode: undefined });
     expect(validator.checkEncode()).toEqual(null);
     validator = createInstance({ encode: null });
@@ -201,8 +203,8 @@ test("tests output of Validator.checkType()", function () {
     expect(function () {
         validator.checkType();
     }).toThrow(TypeError);
-    validator = createInstance({ type: "boolean" });
-    expect(validator.checkType()).toEqual("boolean");
+    validator = createInstance({ type: enums_1.QuestionTypes.Boolean });
+    expect(validator.checkType()).toEqual(enums_1.QuestionTypes.Boolean);
     validator = createInstance({ type: undefined });
     expect(validator.checkType()).toEqual(null);
     validator = createInstance({ type: null });

dist/src/Functions/getQuestions.js

@@ -66,7 +66,7 @@ function getQuestions(options) {
                     link = OpenTDBUtil_1.default.links.base.GET_QUESTIONS;
                     defaultOptions = {
                         amount: 10,
-                        encode: enums_1.QuestionEncodings.none,
+                        encode: enums_1.QuestionEncodings.None,
                     };
                     if ((options === null || options === void 0 ? void 0 : options.category) instanceof Category_1.default)
                         options.category = options.category.id;

dist/src/Typings/enums.d.ts

@@ -3,30 +3,30 @@
  * @enum
  */
 export declare enum CategoryNamesStrict {
-    GENERAL_KNOWLEDGE = 9,
-    ENTERTAINMENT_BOOKS = 10,
-    ENTERTAINMENT_FILM = 11,
-    ENTERTAINMENT_MUSIC = 12,
-    ENTERTAINMENT_MUSICALS_AND_THEATRES = 13,
-    ENTERTAINMENT_TELEVISION = 14,
-    ENTERTAINMENT_VIDEO_GAMES = 15,
-    ENTERTAINMENT_BOARD_GAMES = 16,
-    SCIENCE_AND_NATURE = 17,
-    SCIENCE_COMPUTERS = 18,
-    SCIENCE_MATHEMATICS = 19,
-    MYTHOLOGY = 20,
-    SPORTS = 21,
-    GEOGRAPHY = 22,
-    HISTORY = 23,
-    POLITICS = 24,
-    ART = 25,
-    CELEBRITIES = 26,
-    ANIMALS = 27,
-    VEHICLES = 28,
-    ENTERTAINMENT_COMICS = 29,
-    SCIENCE_GADGETS = 30,
-    ENTERTAINMENT_JAPANESE_ANIME_AND_MANGA = 31,
-    ENTERTAINMENT_CARTOON_AND_ANIMATIONS = 32
+    GeneralKnowledge = 9,
+    EntertainmentBooks = 10,
+    EntertainmentFilm = 11,
+    EntertainmentMusic = 12,
+    EntertainmentMusicalsAndTheatres = 13,
+    EntertainmentJapaneseAnimeAndManga = 14,
+    EntertainmentCartoonAndAnimations = 15,
+    EntertainmentTelevision = 16,
+    EntertainmentVideoGames = 17,
+    EntertainmentBoardGames = 18,
+    EntertainmentComics = 19,
+    ScienceAndNature = 20,
+    ScienceComputers = 21,
+    ScienceMathmatics = 22,
+    ScienceGadgets = 23,
+    Mythology = 24,
+    Sports = 25,
+    Geography = 26,
+    History = 27,
+    Politics = 28,
+    Art = 29,
+    Celebrities = 30,
+    Animals = 31,
+    Vehicles = 32
 }
 /**
  * All pretty category names mapped to their API id
@@ -79,27 +79,27 @@ export declare enum QuestionAmountRange {
  * @enum
  */
 export declare enum QuestionDifficulties {
-    easy = "easy",
-    medium = "medium",
-    hard = "hard"
+    Easy = "easy",
+    Medium = "medium",
+    Hard = "hard"
 }
 /**
  * The question types mapped to their API value
  * @enum
  */
 export declare enum QuestionTypes {
-    multiple = "multiple",
-    boolean = "boolean"
+    Multiple = "multiple",
+    Boolean = "boolean"
 }
 /**
  * The question encodings mapped to their API value
  * @enum
  */
 export declare enum QuestionEncodings {
-    base64 = "base64",
-    none = "none",
-    url3986 = "url3986",
-    urlLegacy = "urlLegacy"
+    Base64 = "base64",
+    None = "none",
+    Url3986 = "url3986",
+    UrlLegacy = "urlLegacy"
 }
 /**
  * The types of Category versions
@@ -109,3 +109,7 @@ export declare enum QuestionVersions {
     Raw = 0,
     Final = 1
 }
+export declare enum CategoryType {
+    Id = "ID",
+    Name = "NAME"
+}

dist/src/Typings/enums.js

@@ -1,36 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionVersions = exports.QuestionEncodings = exports.QuestionTypes = exports.QuestionDifficulties = exports.QuestionAmountRange = exports.CategoryNameVersions = exports.CategoryNamesPretty = exports.CategoryNamesStrict = void 0;
+exports.CategoryType = exports.QuestionVersions = exports.QuestionEncodings = exports.QuestionTypes = exports.QuestionDifficulties = exports.QuestionAmountRange = exports.CategoryNameVersions = exports.CategoryNamesPretty = exports.CategoryNamesStrict = void 0;
 /**
  * All strict category names mapped to their API id
  * @enum
  */
 var CategoryNamesStrict;
 (function (CategoryNamesStrict) {
-    CategoryNamesStrict[CategoryNamesStrict["GENERAL_KNOWLEDGE"] = 9] = "GENERAL_KNOWLEDGE";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_BOOKS"] = 10] = "ENTERTAINMENT_BOOKS";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_FILM"] = 11] = "ENTERTAINMENT_FILM";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_MUSIC"] = 12] = "ENTERTAINMENT_MUSIC";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_MUSICALS_AND_THEATRES"] = 13] = "ENTERTAINMENT_MUSICALS_AND_THEATRES";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_TELEVISION"] = 14] = "ENTERTAINMENT_TELEVISION";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_VIDEO_GAMES"] = 15] = "ENTERTAINMENT_VIDEO_GAMES";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_BOARD_GAMES"] = 16] = "ENTERTAINMENT_BOARD_GAMES";
-    CategoryNamesStrict[CategoryNamesStrict["SCIENCE_AND_NATURE"] = 17] = "SCIENCE_AND_NATURE";
-    CategoryNamesStrict[CategoryNamesStrict["SCIENCE_COMPUTERS"] = 18] = "SCIENCE_COMPUTERS";
-    CategoryNamesStrict[CategoryNamesStrict["SCIENCE_MATHEMATICS"] = 19] = "SCIENCE_MATHEMATICS";
-    CategoryNamesStrict[CategoryNamesStrict["MYTHOLOGY"] = 20] = "MYTHOLOGY";
-    CategoryNamesStrict[CategoryNamesStrict["SPORTS"] = 21] = "SPORTS";
-    CategoryNamesStrict[CategoryNamesStrict["GEOGRAPHY"] = 22] = "GEOGRAPHY";
-    CategoryNamesStrict[CategoryNamesStrict["HISTORY"] = 23] = "HISTORY";
-    CategoryNamesStrict[CategoryNamesStrict["POLITICS"] = 24] = "POLITICS";
-    CategoryNamesStrict[CategoryNamesStrict["ART"] = 25] = "ART";
-    CategoryNamesStrict[CategoryNamesStrict["CELEBRITIES"] = 26] = "CELEBRITIES";
-    CategoryNamesStrict[CategoryNamesStrict["ANIMALS"] = 27] = "ANIMALS";
-    CategoryNamesStrict[CategoryNamesStrict["VEHICLES"] = 28] = "VEHICLES";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_COMICS"] = 29] = "ENTERTAINMENT_COMICS";
-    CategoryNamesStrict[CategoryNamesStrict["SCIENCE_GADGETS"] = 30] = "SCIENCE_GADGETS";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_JAPANESE_ANIME_AND_MANGA"] = 31] = "ENTERTAINMENT_JAPANESE_ANIME_AND_MANGA";
-    CategoryNamesStrict[CategoryNamesStrict["ENTERTAINMENT_CARTOON_AND_ANIMATIONS"] = 32] = "ENTERTAINMENT_CARTOON_AND_ANIMATIONS";
+    CategoryNamesStrict[CategoryNamesStrict["GeneralKnowledge"] = 9] = "GeneralKnowledge";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentBooks"] = 10] = "EntertainmentBooks";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentFilm"] = 11] = "EntertainmentFilm";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentMusic"] = 12] = "EntertainmentMusic";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentMusicalsAndTheatres"] = 13] = "EntertainmentMusicalsAndTheatres";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentJapaneseAnimeAndManga"] = 14] = "EntertainmentJapaneseAnimeAndManga";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentCartoonAndAnimations"] = 15] = "EntertainmentCartoonAndAnimations";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentTelevision"] = 16] = "EntertainmentTelevision";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentVideoGames"] = 17] = "EntertainmentVideoGames";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentBoardGames"] = 18] = "EntertainmentBoardGames";
+    CategoryNamesStrict[CategoryNamesStrict["EntertainmentComics"] = 19] = "EntertainmentComics";
+    CategoryNamesStrict[CategoryNamesStrict["ScienceAndNature"] = 20] = "ScienceAndNature";
+    CategoryNamesStrict[CategoryNamesStrict["ScienceComputers"] = 21] = "ScienceComputers";
+    CategoryNamesStrict[CategoryNamesStrict["ScienceMathmatics"] = 22] = "ScienceMathmatics";
+    CategoryNamesStrict[CategoryNamesStrict["ScienceGadgets"] = 23] = "ScienceGadgets";
+    CategoryNamesStrict[CategoryNamesStrict["Mythology"] = 24] = "Mythology";
+    CategoryNamesStrict[CategoryNamesStrict["Sports"] = 25] = "Sports";
+    CategoryNamesStrict[CategoryNamesStrict["Geography"] = 26] = "Geography";
+    CategoryNamesStrict[CategoryNamesStrict["History"] = 27] = "History";
+    CategoryNamesStrict[CategoryNamesStrict["Politics"] = 28] = "Politics";
+    CategoryNamesStrict[CategoryNamesStrict["Art"] = 29] = "Art";
+    CategoryNamesStrict[CategoryNamesStrict["Celebrities"] = 30] = "Celebrities";
+    CategoryNamesStrict[CategoryNamesStrict["Animals"] = 31] = "Animals";
+    CategoryNamesStrict[CategoryNamesStrict["Vehicles"] = 32] = "Vehicles";
 })(CategoryNamesStrict = exports.CategoryNamesStrict || (exports.CategoryNamesStrict = {}));
 /**
  * All pretty category names mapped to their API id
@@ -87,29 +87,29 @@ var QuestionAmountRange;
  */
 var QuestionDifficulties;
 (function (QuestionDifficulties) {
-    QuestionDifficulties["easy"] = "easy";
-    QuestionDifficulties["medium"] = "medium";
-    QuestionDifficulties["hard"] = "hard";
+    QuestionDifficulties["Easy"] = "easy";
+    QuestionDifficulties["Medium"] = "medium";
+    QuestionDifficulties["Hard"] = "hard";
 })(QuestionDifficulties = exports.QuestionDifficulties || (exports.QuestionDifficulties = {}));
 /**
  * The question types mapped to their API value
  * @enum
  */
 var QuestionTypes;
 (function (QuestionTypes) {
-    QuestionTypes["multiple"] = "multiple";
-    QuestionTypes["boolean"] = "boolean";
+    QuestionTypes["Multiple"] = "multiple";
+    QuestionTypes["Boolean"] = "boolean";
 })(QuestionTypes = exports.QuestionTypes || (exports.QuestionTypes = {}));
 /**
  * The question encodings mapped to their API value
  * @enum
  */
 var QuestionEncodings;
 (function (QuestionEncodings) {
-    QuestionEncodings["base64"] = "base64";
-    QuestionEncodings["none"] = "none";
-    QuestionEncodings["url3986"] = "url3986";
-    QuestionEncodings["urlLegacy"] = "urlLegacy";
+    QuestionEncodings["Base64"] = "base64";
+    QuestionEncodings["None"] = "none";
+    QuestionEncodings["Url3986"] = "url3986";
+    QuestionEncodings["UrlLegacy"] = "urlLegacy";
 })(QuestionEncodings = exports.QuestionEncodings || (exports.QuestionEncodings = {}));
 /**
  * The types of Category versions
@@ -120,3 +120,9 @@ var QuestionVersions;
     QuestionVersions[QuestionVersions["Raw"] = 0] = "Raw";
     QuestionVersions[QuestionVersions["Final"] = 1] = "Final";
 })(QuestionVersions = exports.QuestionVersions || (exports.QuestionVersions = {}));
+var CategoryType;
+(function (CategoryType) {
+    CategoryType["Id"] = "ID";
+    CategoryType["Name"] = "NAME";
+})(CategoryType = exports.CategoryType || (exports.CategoryType = {}));
+;

dist/src/Typings/interfaces.d.ts

@@ -1,5 +1,6 @@
 import Session from "../Classes/Session";
-import { CategoryName, CategoryResolvable, NumberResolvable, QuestionDifficulty, QuestionEncoding, QuestionType } from "./types";
+import { QuestionDifficulties, QuestionEncodings, QuestionTypes } from "./enums";
+import { CategoryName, CategoryResolvable, NumberResolvable, QuestionDifficulty, QuestionType } from "./types";
 /**
  * A basic response from OpenTDB with `results` being an array of T
  * @interface
@@ -85,8 +86,8 @@ export interface Question extends QuestionBase {
 export interface QuestionOptions {
     amount?: NumberResolvable | null;
     category?: CategoryResolvable | null;
-    difficulty?: QuestionDifficulty | null;
-    type?: QuestionType | null;
-    encode?: QuestionEncoding | null;
+    difficulty?: QuestionDifficulties | null;
+    type?: QuestionTypes | null;
+    encode?: QuestionEncodings | null;
     session?: Session | string | null;
 }