Merge pull request #2 from Turtlepaw/main

Change to enums

Author: Elitezen

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: Build
+on: [push, pull_request]
+jobs:
+  test:
+    name: Build Source
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install node.js v16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: 'yarn'
+          cache-dependency-path: yarn.lock
+
+      - name: Install dependencies
+        run: yarn --immutable
+
+      - name: Tests
+        run: yarn build

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install node.js v16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: 'yarn'
+          cache-dependency-path: yarn.lock
+
+      - name: Install dependencies
+        run: yarn --immutable
+
+      - name: Tests
+        run: yarn dev

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"
+}