anilink-api-wrapper 1.18.2 → 1.18.4

package/.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+    extends: 'standard-with-typescript',
+    parserOptions: {
+        project: './tsconfig.json'
+    },
+    rules: {
+        '@typescript-eslint/consistent-type-definitions': 'off'
+    },
+    ignorePatterns: ['**/*.js'],
+    overrides: [
+        {
+            extends: ['plugin:@typescript-eslint/disable-type-checked'],
+            files: ['./**/*.ts']
+        },
+    ],
+}

package/.gitattributes

@@ -0,0 +1 @@
+*.js linguist-vendored

package/README.md

@@ -110,6 +110,8 @@ List of methods in `anilist.mutation`:
 
 ## Error Handling
 
+### Anilist Errors
+
 AniLink will throw an error if the AniList API returns an error. You can catch these errors using a try-catch block.
 
 ```typescript
@@ -123,7 +125,7 @@ try {
 
 This includes status codes and error messages returned by the AniList API. Here is an example rate limit handler to catch the errors thrown by AniLink:
 
-### Typescript
+#### Typescript
 
 ```typescript
 async function handleRateLimit(apiCall: () => Promise<any>, retryAfter = 60) {
@@ -153,7 +155,7 @@ async function handleRateLimit(apiCall: () => Promise<any>, retryAfter = 60) {
 }
 ```
 
-### Javascript
+#### Javascript
 
 ```javascript
 async function handleRateLimit(apiCall, retryAfter = 60) {
@@ -170,7 +172,7 @@ The possible error codes returned by the AniList API are:
 
 ### Missing or Invalid Variables
 
-AniLink will also throw an error if any variables are missing or invalid. For example, if you try to query a user providing a string instead of ID, AniLink will throw an error. Most variables are optional however there a few that are required.
+AniLink will also throw an error if any variables are missing or invalid. For example, if you try to query a user providing a string instead of a number for ID, AniLink will throw an error. Most variables are optional however there a few that are required.
 ```typescript
 try {
   const user = await aniLink.anilist.query.user({id: '542244'});

package/dist/apis/anilist/mutation/SaveMediaListEntry.js

@@ -39,6 +39,9 @@ class SaveMediaListEntryMutation extends APIWrapper_1.APIWrapper {
      */
     saveMediaListEntry(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (variables.mediaId === undefined) {
+                throw new Error('mediaId is required for SaveMediaListEntryMutation');
+            }
             const variableTypeMappings = {
                 id: 'number',
                 mediaId: 'number',

package/dist/apis/anilist/mutation/UpdateMediaListEntries.js

@@ -39,6 +39,9 @@ class UpdateMediaListEntriesMutation extends APIWrapper_1.APIWrapper {
      *  */
     updateMediaListEntries(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (!variables.ids || variables.ids.length === 0) {
+                throw new Error('ids must be an array of at least one number');
+            }
             const variableTypeMappings = {
                 status: MediaListStatus_1.MediaListStatusMappings,
                 score: 'number',

package/dist/apis/anilist/query/Activity.js

@@ -13,6 +13,9 @@ exports.ActivityQuery = void 0;
 const APIWrapper_1 = require("../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../base/RequestHandler");
 const Activity_1 = require("../interfaces/Activity");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
+const Sort_1 = require("../types/Sort");
+const ActivityType_1 = require("../types/ActivityType");
 /**
  * `ActivityQuery` is a class representing a query for activities.
  * It includes a method to get activities.
@@ -35,6 +38,39 @@ class ActivityQuery extends APIWrapper_1.APIWrapper {
      */
     activity(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (variables.id === undefined) {
+                throw new Error('The id variable is required');
+            }
+            const variableTypeMappings = {
+                id: 'number',
+                userId: 'number',
+                messengerId: 'number',
+                mediaId: 'number',
+                type: ActivityType_1.ActivityTypeMappings,
+                isFollowing: 'boolean',
+                hasReplies: 'boolean',
+                hasRepliesOrTypeText: 'boolean',
+                createdAt: 'number',
+                id_not: 'number',
+                id_in: 'number[]',
+                id_not_in: 'number[]',
+                userId_not: 'number',
+                userId_in: 'number[]',
+                userId_not_in: 'number[]',
+                messengerId_not: 'number',
+                messengerId_in: 'number[]',
+                messengerId_not_in: 'number[]',
+                mediaId_not: 'number',
+                mediaId_in: 'number[]',
+                mediaId_not_in: 'number[]',
+                type_not: ActivityType_1.ActivityTypeMappings,
+                type_in: ActivityType_1.ActivityTypeMappings,
+                type_not_in: ActivityType_1.ActivityTypeMappings,
+                createdAt_greater: 'number',
+                sort: Sort_1.ActivitySortMappings,
+                asHtml: 'boolean'
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
             const query = `
       query ($id: Int, $userId: Int, $messengerId: Int, $mediaId: Int, $type: ActivityType, $isFollowing: Boolean, $hasReplies: Boolean, $hasRepliesOrTypeText: Boolean, $createdAt: Int, $id_not: Int, $id_in: [Int], $id_not_in: [Int], $userId_not: Int, $userId_in: [Int], $userId_not_in: [Int], $messengerId_not: Int, $messengerId_in: [Int], $messengerId_not_in: [Int], $mediaId_not: Int, $mediaId_in: [Int], $mediaId_not_in: [Int], $type_not: ActivityType, $type_in: [ActivityType], $type_not_in: [ActivityType], $createdAt_greater: Int, $sort: [ActivitySort], $asHtml: Boolean) {
         Activity (id: $id, userId: $userId, messengerId: $messengerId, mediaId: $mediaId, type: $type, isFollowing: $isFollowing, hasReplies: $hasReplies, hasRepliesOrTypeText: $hasRepliesOrTypeText, createdAt: $createdAt, id_not: $id_not, id_in: $id_in, id_not_in: $id_not_in, userId_not: $userId_not, userId_in: $userId_in, userId_not_in: $userId_not_in, messengerId_not: $messengerId_not, messengerId_in: $messengerId_in, messengerId_not_in: $messengerId_not_in, mediaId_not: $mediaId_not, mediaId_in: $mediaId_in, mediaId_not_in: $mediaId_not_in, type_not: $type_not, type_in: $type_in, type_not_in: $type_not_in, createdAt_greater: $createdAt_greater, sort: $sort) {

package/dist/apis/anilist/query/ActivityReply.js

@@ -13,6 +13,7 @@ exports.ActivityReplyQuery = void 0;
 const APIWrapper_1 = require("../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../base/RequestHandler");
 const ActivityReply_1 = require("../interfaces/ActivityReply");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
 /**
  * `ActivityReplyQuery` is a class representing a query for activity replies.
  * It includes a method to get activity replies.
@@ -35,6 +36,15 @@ class ActivityReplyQuery extends APIWrapper_1.APIWrapper {
      */
     activityReply(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (variables.id === undefined) {
+                throw new Error('The id is required');
+            }
+            const variableTypeMappings = {
+                id: 'number',
+                activityId: 'number',
+                asHtml: 'boolean'
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
             const query = `
       query ($id: Int, $activityId: Int, $asHtml: Boolean) {
         ActivityReply (id: $id, activityId: $activityId) {

package/dist/apis/anilist/query/AiringSchedule.js

@@ -13,6 +13,8 @@ exports.AiringScheduleQuery = void 0;
 const APIWrapper_1 = require("../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../base/RequestHandler");
 const AiringSchedule_1 = require("../interfaces/responses/query/AiringSchedule");
+const Sort_1 = require("../types/Sort");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
 /**
  * `AiringScheduleQuery` is a class representing a query for airing schedules.
  * It includes a method to get airing schedules.
@@ -35,6 +37,32 @@ class AiringScheduleQuery extends APIWrapper_1.APIWrapper {
      */
     airingSchedule(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (!variables.id || !variables.mediaId) {
+                throw new Error('The id or mediaId variables are required');
+            }
+            const variableTypeMappings = {
+                id: 'number',
+                mediaId: 'number',
+                episode: 'number',
+                airingAt: 'number',
+                notYetAired: 'boolean',
+                id_not: 'number',
+                id_in: 'number[]',
+                id_not_in: 'number[]',
+                mediaId_not: 'number',
+                mediaId_in: 'number[]',
+                mediaId_not_in: 'number[]',
+                episode_not: 'number',
+                episode_in: 'number[]',
+                episode_not_in: 'number[]',
+                episode_greater: 'number',
+                episode_lesser: 'number',
+                airingAt_greater: 'number',
+                airingAt_lesser: 'number',
+                sort: Sort_1.AiringSortMappings,
+                asHtml: 'boolean'
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
             const query = `
       query ($id: Int, $mediaId: Int, $episode: Int, $airingAt: Int, $notYetAired: Boolean, $id_not: Int, $id_in: [Int], $id_not_in: [Int], $mediaId_not: Int, $mediaId_in: [Int], $mediaId_not_in: [Int], $episode_not: Int, $episode_in: [Int], $episode_not_in: [Int], $episode_greater: Int, $episode_lesser: Int, $airingAt_greater: Int, $airingAt_lesser: Int, $sort: [AiringSort], $asHtml: Boolean) {
         AiringSchedule (id: $id, mediaId: $mediaId, episode: $episode, airingAt: $airingAt, notYetAired: $notYetAired, id_not: $id_not, id_in: $id_in, id_not_in: $id_not_in, mediaId_not: $mediaId_not, mediaId_in: $mediaId_in, mediaId_not_in: $mediaId_not_in, episode_not: $episode_not, episode_in: $episode_in, episode_not_in: $episode_not_in, episode_greater: $episode_greater, episode_lesser: $episode_lesser, airingAt_greater: $airingAt_greater, airingAt_lesser: $airingAt_lesser, sort: $sort) {

package/dist/apis/anilist/types/ActivityType.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityTypeMappings = void 0;
+/**
+ * `ActivityTypeMappings` is a mapping of `ActivityType` enum values to their corresponding string values.
+ * It can be one of the following: 'TEXT', 'ANIME_LIST', 'MANGA_LIST', 'MESSAGE', 'MEDIA_LIST'.
+ */
+exports.ActivityTypeMappings = [
+    'TEXT',
+    'ANIME_LIST',
+    'MANGA_LIST',
+    'MESSAGE',
+    'MEDIA_LIST'
+];

package/dist/apis/anilist/types/Sort.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiringSortMappings = exports.ActivitySortMappings = void 0;
+/**
+ * `ActivitySortMappings` is a mapping of `ActivitySort` enum values to their corresponding string values.
+ * It can be one of the following: 'ID', 'ID_DESC', 'PINNED'.
+ */
+exports.ActivitySortMappings = [
+    'ID',
+    'ID_DESC',
+    'PINNED'
+];
+/**
+ * `AiringSortMappings` is a mapping of `AiringSort` enum values to their corresponding string values.
+ * It can be one of the following: 'ID', 'ID_DESC', 'MEDIA_ID', 'MEDIA_ID_DESC', 'TIME', 'TIME_DESC', 'EPISODE', 'EPISODE_DESC'.
+ */
+exports.AiringSortMappings = [
+    'ID',
+    'ID_DESC',
+    'MEDIA_ID',
+    'MEDIA_ID_DESC',
+    'TIME',
+    'TIME_DESC',
+    'EPISODE',
+    'EPISODE_DESC'
+];

package/dist/base/RequestHandler.js

@@ -31,6 +31,7 @@ const sendRequest = (url, method, data, token) => __awaiter(void 0, void 0, void
     if (token !== null && token !== undefined && token !== '') {
         headers.Authorization = `Bearer ${token}`;
     }
+    /* eslint-disable no-useless-catch */
     try {
         const response = yield (0, axios_1.default)({
             url,

package/dist/base/ValidateVariables.js

@@ -10,32 +10,33 @@ exports.validateVariables = void 0;
  * @throws Will throw an error if any of the variables do not match their expected types. The error message will include the names of the invalid variables and their expected types.
  */
 function validateVariables(variables, variableTypeMappings) {
+    if (Object.keys(variables).length === 0) {
+        throw new Error('No variables were provided');
+    }
     const errors = [];
     for (const [variable, value] of Object.entries(variables)) {
         const expectedType = variableTypeMappings[variable];
         if (expectedType) {
-            if (typeof expectedType === 'string' && expectedType.endsWith('[]')) {
-                // If the expected type is an array, check if the actual value is an array and if its elements are of the correct type
-                const elementType = expectedType.slice(0, -2); // Remove the '[]' from the end
-                if (!Array.isArray(value) || !value.every((element) => typeof element === elementType)) {
-                    errors.push(`Invalid ${variable}: ${value}. Expected type: ${expectedType}`);
-                }
-            }
-            else if (Array.isArray(expectedType)) {
-                // If the value is an object, validate its properties
-                if (typeof value === 'object' && value !== null) {
-                    for (const [prop, propValue] of Object.entries(value)) {
-                        const expectedPropType = expectedType[prop];
-                        if (expectedPropType && !expectedPropType.includes(propValue)) {
-                            errors.push(`Invalid ${variable}.${prop}: ${propValue}. Expected one of: ${expectedPropType.join(', ')}`);
+            if (Array.isArray(expectedType)) {
+                // If the expected type is an array, check if the value or its elements are included in the array
+                if (Array.isArray(value)) {
+                    value.forEach((item, index) => {
+                        if (!expectedType.includes(item)) {
+                            errors.push(`Invalid ${variable}[${index}]: ${item}. Expected one of: ${expectedType.join(', ')}`);
                         }
-                    }
+                    });
                 }
                 else if (!expectedType.includes(value)) {
-                    // If the value is not an object, check if it is one of the array values
                     errors.push(`Invalid ${variable}: ${value}. Expected one of: ${expectedType.join(', ')}`);
                 }
             }
+            else if (typeof expectedType === 'string' && expectedType.endsWith('[]')) {
+                // If the expected type is an array type, check if the actual value is an array and if its elements are of the correct type
+                const elementType = expectedType.slice(0, -2); // Remove the '[]' from the end
+                if (!Array.isArray(value) || !value.every((element) => typeof element === elementType)) {
+                    errors.push(`Invalid ${variable}: ${value}. Expected type: ${expectedType}`);
+                }
+            }
             else if (typeof expectedType === 'object') {
                 // If the expected type is an object, validate its properties
                 if (Array.isArray(value)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anilink-api-wrapper",
-  "version": "1.18.2",
+  "version": "1.18.4",
   "description": "Anilist API Wrapper",
   "main": "dist/AniLink.js",
   "scripts": {
@@ -21,10 +21,14 @@
     "@types/jest": "^29.5.12",
     "babel-jest": "^29.7.0",
     "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-config-standard-with-typescript": "^43.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.7.0",
     "standard": "^17.1.0",
     "ts-jest": "^29.1.2",
-    "ts-standard": "^12.0.2",
     "typedoc": "^0.25.13",
     "typedoc-theme-hierarchy": "^4.1.2",
     "typescript": "^5.4.5"