anilink-api-wrapper 1.18.1 → 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/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/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/base/ValidateVariables.js

@@ -14,7 +14,14 @@ function validateVariables(variables, variableTypeMappings) {
     for (const [variable, value] of Object.entries(variables)) {
         const expectedType = variableTypeMappings[variable];
         if (expectedType) {
-            if (Array.isArray(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)) {

package/package.json

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