anilink-api-wrapper 1.17.6 → 1.18.2

package/README.md

@@ -108,6 +108,83 @@ List of methods in `anilist.mutation`:
 - saveMediaListEntry
 - updateMediaListEntries
 
+## Error Handling
+
+AniLink will throw an error if the AniList API returns an error. You can catch these errors using a try-catch block.
+
+```typescript
+try {
+  const user = await aniLink.anilist.query.user({id: 542244});
+  console.log(user);
+} catch (error) {
+  console.error(error);
+}
+```
+
+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
+async function handleRateLimit(apiCall: () => Promise<any>, retryAfter = 60) {
+  try {
+    let response;
+    try {
+      response = await apiCall();
+    } catch (error) {
+      throw error;
+    }
+    console.log(response.data);
+    return response;
+  } catch (error: any) {
+    if (error.response && error.response.status === 429) {
+      console.log('Rate limit exceeded, waiting for 1 minute before retrying...');
+      await new Promise(resolve => setTimeout(resolve, retryAfter * 1000));
+      console.log('Retrying...');
+      return handleRateLimit(apiCall, retryAfter);
+    } else {
+      if (error.response && error.response.data) {
+        throw error.response.data;
+      } else {
+        throw error.response || error;
+      }
+    }
+  }
+}
+```
+
+### Javascript
+
+```javascript
+async function handleRateLimit(apiCall, retryAfter = 60) {
+    // Same as above
+}
+```
+
+The possible error codes returned by the AniList API are:
+- 400: Bad Request (e.g. missing variables, invalid variables, or invalid query)
+- 401: Unauthorized (e.g. invalid authentication token)
+- 404: Not Found (e.g. user not found)
+- 429: Too Many Requests (e.g. rate limit exceeded)
+- 500: Internal Server Error (e.g. AniList server error)
+
+### 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.
+```typescript
+try {
+  const user = await aniLink.anilist.query.user({id: '542244'});
+  console.log(user);
+} catch (error) {
+  console.error(error);
+}
+```
+
+Example Error Thrown:
+
+```typescript
+  Invalid id: 542244. Expected type: number
+```
 
 ## Examples
 

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

@@ -13,6 +13,9 @@ exports.SaveMediaListEntryMutation = void 0;
 const APIWrapper_1 = require("../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../base/RequestHandler");
 const FuzzyDate_1 = require("../interfaces/FuzzyDate");
+const MediaListStatus_1 = require("../types/MediaListStatus");
+const FuzzyDate_2 = require("../types/FuzzyDate");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
 /**
  * `SaveMediaListEntryMutation` is a class representing a mutation to save a media list entry.
  * It includes a method to save a media list entry.
@@ -30,11 +33,31 @@ class SaveMediaListEntryMutation extends APIWrapper_1.APIWrapper {
     /**
      * `saveMediaListEntry` is a method that sends a mutation request to save a media list entry.
      *
-     * @param variables - The variables for the mutation.
-     * @returns The response from the mutation request.
+     * @param variables - An object of type `SaveMediaListEntryVariables` representing the variables for the mutation.
+     * @returns A Promise that resolves to the response from the mutation request.
+     * @throws Will throw an error if the mutation request fails or if the provided variables do not pass the validation checks.
      */
     saveMediaListEntry(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            const variableTypeMappings = {
+                id: 'number',
+                mediaId: 'number',
+                status: MediaListStatus_1.MediaListStatusMappings,
+                score: 'number',
+                scoreRaw: 'number',
+                progress: 'number',
+                progressVolumes: 'number',
+                repeat: 'number',
+                priority: 'number',
+                private: 'boolean',
+                notes: 'string',
+                hiddenFromStatusLists: 'boolean',
+                customLists: 'string[]',
+                advancedScores: 'number[]',
+                startedAt: FuzzyDate_2.FuzzyDateMappings,
+                completedAt: FuzzyDate_2.FuzzyDateMappings
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
             const mutation = `
       mutation ($id: Int, $mediaId: Int, $status: MediaListStatus, $score: Float, $scoreRaw: Int, $progress: Int, $progressVolumes: Int, $repeat: Int, $priority: Int, $private: Boolean, $notes: String, $hiddenFromStatusLists: Boolean, $customLists: [String], $advancedScores: [Float], $startedAt: FuzzyDateInput, $completedAt: FuzzyDateInput) {
         SaveMediaListEntry(id: $id, mediaId: $mediaId, status: $status, score: $score, scoreRaw: $scoreRaw, progress: $progress, progressVolumes: $progressVolumes, repeat: $repeat, priority: $priority, private: $private, notes: $notes, hiddenFromStatusLists: $hiddenFromStatusLists, customLists: $customLists, advancedScores: $advancedScores, startedAt: $startedAt, completedAt: $completedAt) {

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

@@ -13,6 +13,9 @@ exports.UpdateMediaListEntriesMutation = void 0;
 const APIWrapper_1 = require("../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../base/RequestHandler");
 const FuzzyDate_1 = require("../interfaces/FuzzyDate");
+const MediaListStatus_1 = require("../types/MediaListStatus");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
+const FuzzyDate_2 = require("../types/FuzzyDate");
 /**
  * `UpdateMediaListEntriesMutation` is a class representing a mutation to update media list entries.
  * It includes a method to update media list entries.
@@ -30,11 +33,29 @@ class UpdateMediaListEntriesMutation extends APIWrapper_1.APIWrapper {
     /**
      * `updateMediaListEntries` is a method that sends a mutation request to update media list entries.
      *
-     * @param variables - The variables for the mutation.
-     * @returns The response from the mutation request.
-     */
+     * @param variables - An object of type `UpdateMediaListEntriesVariables` representing the variables for the mutation.
+     * @returns A Promise that resolves to the response from the mutation request.
+     * @throws Will throw an error if the mutation request fails or if the provided variables do not pass the validation checks.
+     *  */
     updateMediaListEntries(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            const variableTypeMappings = {
+                status: MediaListStatus_1.MediaListStatusMappings,
+                score: 'number',
+                scoreRaw: 'number',
+                progress: 'number',
+                progressVolumes: 'number',
+                repeat: 'number',
+                priority: 'number',
+                private: 'boolean',
+                notes: 'string',
+                hiddenFromStatusLists: 'boolean',
+                advancedScores: 'number[]',
+                startedAt: FuzzyDate_2.FuzzyDateMappings,
+                completedAt: FuzzyDate_2.FuzzyDateMappings,
+                ids: 'number[]'
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
             const mutation = `
       mutation ($status: MediaListStatus, $score: Float, $scoreRaw: Int, $progress: Int, $progressVolumes: Int, $repeat: Int, $priority: Int, $private: Boolean, $notes: String, $hiddenFromStatusLists: Boolean, $advancedScores: [Float], $startedAt: FuzzyDateInput, $completedAt: FuzzyDateInput, $ids: [Int]) {
         UpdateMediaListEntries(status: $status, score: $score, scoreRaw: $scoreRaw, progress: $progress, progressVolumes: $progressVolumes, repeat: $repeat, priority: $priority, private: $private, notes: $notes, hiddenFromStatusLists: $hiddenFromStatusLists, advancedScores: $advancedScores, startedAt: $startedAt, completedAt: $completedAt, ids: $ids) {

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

@@ -12,6 +12,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateUserMutation = void 0;
 const APIWrapper_1 = require("../../../base/APIWrapper");
 const RequestHandler_1 = require("../../../base/RequestHandler");
+const ScoreFormat_1 = require("../types/ScoreFormat");
+const UserStaffNameLanguage_1 = require("../types/UserStaffNameLanguage");
+const UserTitleLanguage_1 = require("../types/UserTitleLanguage");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
+const NotificationOptions_1 = require("../types/NotificationOptions");
+const MediaListOptions_1 = require("../types/MediaListOptions");
+const DisabledListActivity_1 = require("../types/DisabledListActivity");
 /**
  * `UpdateUserMutation` is a class representing a mutation to update a user.
  * It includes a method to update a user.
@@ -29,11 +36,31 @@ class UpdateUserMutation extends APIWrapper_1.APIWrapper {
     /**
      * `updateUser` is a method that sends a mutation request to update a user.
      *
-     * @param variables - The variables for the mutation.
-     * @returns The response from the mutation request.
+     * @param variables - An object of type `UpdateUserVariables` representing the variables for the mutation.
+     * @returns A Promise that resolves to an object of type `UpdateUserResponse`. This object includes the updated user details
+     * @throws Will throw an error if the mutation request fails or if the provided variables do not pass the validation checks.
      */
     updateUser(variables) {
         return __awaiter(this, void 0, void 0, function* () {
+            const variableTypeMappings = {
+                about: 'string',
+                titleLanguage: UserTitleLanguage_1.UserTitleLanguageMapping,
+                displayAdultContent: 'boolean',
+                airingNotifications: 'boolean',
+                scoreFormat: ScoreFormat_1.ScoreFormatMapping,
+                rowOrder: 'string',
+                profileColor: 'string',
+                donatorBadge: 'string',
+                notificationOptions: NotificationOptions_1.NotificationOptionsMapping,
+                timezone: 'string',
+                activityMergeTime: 'number',
+                animeListOptions: MediaListOptions_1.MediaListOptionsMapping,
+                mangaListOptions: MediaListOptions_1.MediaListOptionsMapping,
+                staffNameLanguage: UserStaffNameLanguage_1.UserStaffNameLanguageMapping,
+                restrictMessagesToFollowing: 'boolean',
+                disabledListActivity: DisabledListActivity_1.DisabledListActivityMapping
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
             const mutation = `
       mutation ($about: String, $titleLanguage: UserTitleLanguage, $displayAdultContent: Boolean, $airingNotifications: Boolean, $scoreFormat: ScoreFormat, $rowOrder: String, $profileColor: String, $donatorBadge: String, $notificationOptions: [NotificationOptionInput], $timezone: String, $activityMergeTime: Int, $animeListOptions: MediaListOptionsInput, $mangaListOptions: MediaListOptionsInput, $staffNameLanguage: UserStaffNameLanguage, $restrictMessagesToFollowing: Boolean, $disabledListActivity: [ListActivityOptionInput]) {
         UpdateUser(about: $about, titleLanguage: $titleLanguage, displayAdultContent: $displayAdultContent, airingNotifications: $airingNotifications, scoreFormat: $scoreFormat, rowOrder: $rowOrder, profileColor: $profileColor, donatorBadge: $donatorBadge, notificationOptions: $notificationOptions, timezone: $timezone, activityMergeTime: $activityMergeTime, animeListOptions: $animeListOptions, mangaListOptions: $mangaListOptions, staffNameLanguage: $staffNameLanguage, restrictMessagesToFollowing: $restrictMessagesToFollowing, disabledListActivity: $disabledListActivity) {

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DisabledListActivityMapping = void 0;
+/**
+ * `DisabledListActivityMapping` is a constant that maps the `DisabledListActivity` fields to their expected types.
+ * The `disabled` field is mapped to 'boolean', and the `type` field is mapped to an array of possible values.
+ */
+exports.DisabledListActivityMapping = {
+    disabled: 'boolean',
+    type: ['CURRENT', 'PLANNING', 'COMPLETED', 'DROPPED', 'PAUSED', 'REPEATING']
+};

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FuzzyDateMappings = void 0;
+/**
+ * `FuzzyDateMappings` is a constant that maps the `FuzzyDateInput` fields to their expected types.
+ * The `year`, `month`, and `day` fields are mapped to 'number'.
+ */
+exports.FuzzyDateMappings = {
+    year: 'number',
+    month: 'number',
+    day: 'number'
+};

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaListOptionsMapping = void 0;
+/**
+ * `MediaListOptionsMapping` is a constant that maps the `MediaListOptions` fields to their expected types.
+ * The `sectionOrder`, `customLists`, `advancedScoring`, and `theme` fields are mapped to 'string',
+ * and the `splitCompletedSectionByFormat` and `advancedScoringEnabled` fields are mapped to 'boolean'.
+ */
+exports.MediaListOptionsMapping = {
+    sectionOrder: 'string',
+    splitCompletedSectionByFormat: 'boolean',
+    customLists: 'string',
+    advancedScoring: 'string',
+    advancedScoringEnabled: 'boolean',
+    theme: 'string'
+};

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

@@ -1,2 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaListStatusMappings = void 0;
+/**
+ * `MediaListStatusMappings` is a constant that maps the `MediaListStatus` values to their expected types.
+ * The values are mapped to 'string'.
+ */
+exports.MediaListStatusMappings = [
+    'CURRENT',
+    'PLANNING',
+    'COMPLETED',
+    'DROPPED',
+    'PAUSED',
+    'REPEATING'
+];

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationOptionsMapping = void 0;
+/**
+ * `NotificationOptionsMapping` is a constant that maps the `NotificationOptions` fields to their expected types.
+ * The `type` field is mapped to an array of possible values, and the `enabled` field is mapped to 'boolean'.
+ */
+exports.NotificationOptionsMapping = {
+    type: [
+        'ACTIVITY_MESSAGE',
+        'ACTIVITY_REPLY',
+        'FOLLOWING',
+        'ACTIVITY_MENTION',
+        'THREAD_COMMENT_MENTION',
+        'THREAD_SUBSCRIBED',
+        'THREAD_COMMENT_REPLY',
+        'AIRING',
+        'ACTIVITY_LIKE',
+        'ACTIVITY_REPLY_LIKE',
+        'THREAD_LIKE',
+        'THREAD_COMMENT_LIKE',
+        'ACTIVITY_REPLY_SUBSCRIBED',
+        'RELATED_MEDIA_ADDITION',
+        'MEDIA_DATA_CHANGE',
+        'MEDIA_MERGE',
+        'MEDIA_DELETION'
+    ],
+    enabled: 'boolean'
+};

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

@@ -1,2 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScoreFormatMapping = void 0;
+/**
+ * `ScoreFormatMapping` is a mapping of `ScoreFormat` values to their string representations.
+ * It can be one of the following: 'POINT_100', 'POINT_10_DECIMAL', 'POINT_10', 'POINT_5', 'POINT_3'.
+ */
+exports.ScoreFormatMapping = [
+    'POINT_100',
+    'POINT_10_DECIMAL',
+    'POINT_10',
+    'POINT_5',
+    'POINT_3'
+];

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

@@ -1,2 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserStaffNameLanguageMapping = void 0;
+/**
+ * `UserStaffNameLanguageMapping` is a mapping of `UserStaffNameLanguage` enum values to their corresponding string values.
+ * It can be one of the following: 'ROMAJI', 'ENGLISH', 'NATIVE', 'ROMAJI_STYLISED', 'ENGLISH_STYLISED', 'NATIVE_STYLISED'.
+ */
+exports.UserStaffNameLanguageMapping = [
+    'ROMAJI',
+    'ENGLISH',
+    'NATIVE',
+    'ROMAJI_STYLISED',
+    'ENGLISH_STYLISED',
+    'NATIVE_STYLISED'
+];

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

@@ -1,2 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserTitleLanguageMapping = void 0;
+/**
+ * `UserTitleLanguageMapping` is an object that maps each `UserTitleLanguage` to its corresponding string value.
+ * It can be one of the following: 'ROMAJI', 'ENGLISH', 'NATIVE', 'ROMAJI_STYLISED', 'ENGLISH_STYLISED', 'NATIVE_STYLISED'.
+ */
+exports.UserTitleLanguageMapping = [
+    'ROMAJI',
+    'ENGLISH',
+    'NATIVE',
+    'ROMAJI_STYLISED',
+    'ENGLISH_STYLISED',
+    'NATIVE_STYLISED'
+];

package/dist/base/ValidateVariables.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateVariables = void 0;
+/**
+ * Validates the provided variables against the expected types.
+ *
+ * @param variables - The variables to validate. This is an object where each key is the name of a variable and the value is the value of the variable.
+ * @param variableTypeMappings - An object that maps variable names to their expected types. The expected type can be a string representing a primitive type, an array of possible values, or an object mapping property names to their expected types.
+ *
+ * @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) {
+    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(', ')}`);
+                        }
+                    }
+                }
+                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 === 'object') {
+                // If the expected type is an object, validate its properties
+                if (Array.isArray(value)) {
+                    // If the value is an array, validate each object in the array
+                    value.forEach((item, index) => {
+                        for (const [prop, propValue] of Object.entries(item)) {
+                            const expectedPropType = expectedType[prop];
+                            if (expectedPropType) {
+                                if (expectedPropType === 'boolean' && typeof propValue === 'boolean') {
+                                    // If the expected type is 'boolean' and the value is a boolean, the validation passes
+                                }
+                                else if (!expectedPropType.includes(propValue)) {
+                                    let expectedPropTypeString;
+                                    if (Array.isArray(expectedPropType)) {
+                                        expectedPropTypeString = expectedPropType.join(', ');
+                                    }
+                                    else {
+                                        expectedPropTypeString = expectedPropType.toString();
+                                    }
+                                    errors.push(`Invalid ${variable}[${index}].${prop}: ${propValue}. Expected one of: ${expectedPropTypeString}`);
+                                }
+                            }
+                        }
+                    });
+                }
+                else {
+                    // If the value is not an array, validate its properties
+                    for (const [prop, propValue] of Object.entries(value)) {
+                        const expectedPropType = expectedType[prop];
+                        if (expectedPropType) {
+                            if (Array.isArray(propValue) && propValue.length === 1) {
+                                // If the expected type is a string and the value is an array with a single string, treat it as a single string
+                                if (typeof propValue[0] === 'string' && expectedPropType.includes(propValue[0])) {
+                                    // If the expected type is a string and the value is a string, check if the string is in the array
+                                }
+                                else if (typeof propValue[0] !== expectedPropType) {
+                                    errors.push(`Invalid ${variable}.${prop}: ${propValue[0]}. Expected type: ${expectedPropType}`);
+                                }
+                            }
+                            else if (Array.isArray(propValue)) {
+                                // If the expected type is an array and the value is an array, check if all elements in the array are of the expected type
+                                if (!propValue.every(item => expectedPropType.includes(item))) {
+                                    let expectedPropTypeString;
+                                    if (Array.isArray(expectedPropType)) {
+                                        expectedPropTypeString = expectedPropType.join(', ');
+                                    }
+                                    else {
+                                        expectedPropTypeString = expectedPropType;
+                                    }
+                                    errors.push(`Invalid ${variable}.${prop}: ${propValue}. Expected type: ${expectedPropTypeString}`);
+                                }
+                            }
+                            else if (typeof propValue === 'string' && expectedPropType.includes(propValue)) {
+                                // If the expected type is an array and the value is a string, check if the string is in the array
+                            }
+                            else if (typeof propValue !== expectedPropType) {
+                                let expectedPropTypeString;
+                                if (Array.isArray(expectedPropType)) {
+                                    expectedPropTypeString = expectedPropType.join(', ');
+                                }
+                                else {
+                                    expectedPropTypeString = expectedPropType;
+                                }
+                                errors.push(`Invalid ${variable}.${prop}: ${propValue}. Expected type: ${expectedPropTypeString}`);
+                            }
+                        }
+                    }
+                }
+            }
+            else if (Array.isArray(value)) {
+                // If the value is an array, validate each item in the array
+                value.forEach((item, index) => {
+                    if (typeof item !== expectedType) {
+                        errors.push(`Invalid ${variable}[${index}]: ${item}. Expected type: ${expectedType}`);
+                    }
+                });
+            }
+            else if (typeof value !== expectedType) {
+                errors.push(`Invalid ${variable}: ${value}. Expected type: ${expectedType}`);
+            }
+        }
+    }
+    if (errors.length > 0) {
+        throw new Error(errors.join('\n'));
+    }
+}
+exports.validateVariables = validateVariables;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anilink-api-wrapper",
-  "version": "1.17.6",
+  "version": "1.18.2",
   "description": "Anilist API Wrapper",
   "main": "dist/AniLink.js",
   "scripts": {

package/typedoc.json

@@ -1,15 +0,0 @@
-{
-  "out": "./docs",
-  "entryPoints": ["./src"],
-  "entryPointStrategy": "expand",
-  "exclude": ["**/__tests__/**"],
-  "name": "AniLink",
-  "readme": "README.md",
-  "plugin": ["typedoc-theme-hierarchy"],
-  "theme": "hierarchy",
-  "tsconfig": "./tsconfig.json",
-  "excludePrivate": true,
-  "excludeProtected": true,
-  "excludeExternals": true,
-  "includeVersion": true
-}