anilink-api-wrapper 1.19.0 → 1.20.0

package/README.md

@@ -49,11 +49,13 @@ You can also initialize AniLink without an authentication token
 const aniLink = new AniLink();
 ```
 
-## Structure
+## AniList API
+
+### Structure
 
 AniLink for AniList is divided into two main sections: `anilist.query` and `anilist.mutation`. The `anilist.query` section contains methods for querying data from the AniList API, while the `anilist.mutation` section contains methods for mutating data.
 
-### Query Methods
+#### Query Methods
 
 The `anilist.query` section is further divided into main query methods and page query methods. The main query methods return a single piece of data, while the page query methods return pages of data.
 
@@ -106,17 +108,18 @@ List of page query methods in `anilist.query.page`:
 - recommendations
 - likes
 
-### Mutation Methods
+#### Mutation Methods
 
 List of methods in `anilist.mutation`:
 
 - updateUser
 - saveMediaListEntry
 - updateMediaListEntries
+- deleteMediaListEntries
+- deleteCustomLists
+- saveTextActivity
 
-## Error Handling
-
-### Anilist Errors
+### Error Handling
 
 AniLink will throw an error if the AniList API returns an error. You can catch these errors using a try-catch block.
 
@@ -131,7 +134,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) {
@@ -161,7 +164,7 @@ async function handleRateLimit(apiCall: () => Promise<any>, retryAfter = 60) {
 }
 ```
 
-#### Javascript
+##### Javascript
 
 ```javascript
 async function handleRateLimit(apiCall, retryAfter = 60) {
@@ -176,7 +179,7 @@ The possible error codes returned by the AniList API are:
 - 429: Too Many Requests (e.g. rate limit exceeded)
 - 500: Internal Server Error (e.g. AniList server error)
 
-### Missing or Invalid Variables
+#### 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 a number for ID, AniLink will throw an error. Most variables are optional however there a few that are required.
 ```typescript
@@ -194,11 +197,11 @@ Example Error Thrown:
   Invalid id: 542244. Expected type: number
 ```
 
-## Examples
+### Examples
 
 Here are examples of how to use AniLink to interact with the AniList API:
 
-### Querying user data
+#### Querying user data
 
 ```typescript
 // Querying user data
@@ -364,7 +367,7 @@ aniLink.anilist.query.page.likes({likeableId: 723422275, type: 'ACTIVITY', asHtm
 });
 ```
 
-### Mutating user data
+#### Mutating user data
 
 ```typescript
 // Updating a user
@@ -380,8 +383,8 @@ aniLink.anilist.mutation.updateUser({
   notificationOptions: [{type: 'AIRING', enabled: true}],
   timezone: '-06:00',
   activityMergeTime: 30,
-  animeListOptions: {sectionOrder: ['title'], customLists: [], advancedScoring: [], advancedScoringEnabled: false},
-  mangaListOptions: {sectionOrder: ['title'], customLists: [], advancedScoring: [], advancedScoringEnabled: false},
+  animeListOptions: {sectionOrder: ['title'], customLists: ['test'], advancedScoring: [], advancedScoringEnabled: false},
+  mangaListOptions: {sectionOrder: ['title'], customLists: ['test'], advancedScoring: [], advancedScoringEnabled: false},
   staffNameLanguage: 'ROMAJI',
   restrictMessagesToFollowing: false,
   disabledListActivity: [{type: 'CURRENT', disabled: false}]
@@ -389,7 +392,7 @@ aniLink.anilist.mutation.updateUser({
 
 // Saving media list entries
 aniLink.anilist.mutation.saveMediaListEntry({
-  mediaId: 1,
+  mediaId: 143271,
   status: 'CURRENT',
   score: 8.5,
   progress: 3,
@@ -402,4 +405,27 @@ aniLink.anilist.mutation.updateMediaListEntries({
   progress: 3,
   ids: [143271, 156822, 170890],
 });
-```
+
+// Deleting custom list
+aniLink.anilist.mutation.deleteCustomLists({customList: 'test'});
+
+// Deleting media list entry
+const entryId = (
+  await handleRateLimit(() => aniLink.anilist.query.mediaList(
+    {
+      userId: 6503722,
+      mediaId: 143271
+    }
+  ))).data.MediaList.id;
+aniLink.anilist.mutation.deleteMediaListEntry({id: entryId});
+
+// Create text activity
+aniLink.anilist.mutation.saveTextActivity({text: 'test'})
+
+// Update text activity
+aniLink.anilist.mutation.saveTextActivity({id: 725254160, text: 'Updated Text'})
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/dist/AniLink.js

@@ -47,6 +47,9 @@ const UpdateUser_1 = require("./apis/anilist/mutation/UpdateUser");
 const User_1 = require("./apis/anilist/query/User");
 const Users_1 = require("./apis/anilist/query/page/Users");
 const Viewer_1 = require("./apis/anilist/query/Viewer");
+const DeleteMediaListEntry_1 = require("./apis/anilist/mutation/DeleteMediaListEntry");
+const DeleteCustomList_1 = require("./apis/anilist/mutation/DeleteCustomList");
+const SaveTextActivity_1 = require("./apis/anilist/mutation/SaveTextActivity");
 /**
  * `AniLink` is a class for interacting with the APIs.
  * It provides methods for querying and mutating data.
@@ -103,6 +106,9 @@ class AniLink {
         const updateUserMutationInstance = new UpdateUser_1.UpdateUserMutation(authToken);
         const saveMediaListEntryMutationInstance = new SaveMediaListEntry_1.SaveMediaListEntryMutation(authToken);
         const updateMediaListEntriesMutationInstance = new UpdateMediaListEntries_1.UpdateMediaListEntriesMutation(authToken);
+        const deleteMediaListEntryMutationInstance = new DeleteMediaListEntry_1.DeleteMediaListEntryMutation(authToken);
+        const deleteCustomListMutationInstance = new DeleteCustomList_1.DeleteCustomListMutation(authToken);
+        const saveTextActivityMutationInstance = new SaveTextActivity_1.SaveTextActivityMutation(authToken);
         this.anilist = {
             query: {
                 user: userQueryInstance.user.bind(userQueryInstance),
@@ -154,7 +160,10 @@ class AniLink {
             mutation: {
                 updateUser: updateUserMutationInstance.updateUser.bind(updateUserMutationInstance),
                 saveMediaListEntry: saveMediaListEntryMutationInstance.saveMediaListEntry.bind(saveMediaListEntryMutationInstance),
-                updateMediaListEntries: updateMediaListEntriesMutationInstance.updateMediaListEntries.bind(updateMediaListEntriesMutationInstance)
+                updateMediaListEntries: updateMediaListEntriesMutationInstance.updateMediaListEntries.bind(updateMediaListEntriesMutationInstance),
+                deleteMediaListEntry: deleteMediaListEntryMutationInstance.deleteMediaListEntry.bind(deleteMediaListEntryMutationInstance),
+                deleteCustomList: deleteCustomListMutationInstance.deleteCustomList.bind(deleteCustomListMutationInstance),
+                saveTextActivity: saveTextActivityMutationInstance.saveTextActivity.bind(saveTextActivityMutationInstance)
             }
         };
     }

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActivityWithRepliesSchema = exports.ActivitySchema = void 0;
+exports.TextActivitySchema = exports.ActivityWithRepliesSchema = exports.ActivitySchema = void 0;
 const BasicUser_1 = require("./BasicUser");
 const ActivityReply_1 = require("./ActivityReply");
 /**
@@ -149,3 +149,30 @@ exports.ActivityWithRepliesSchema = `
     }
   }
 `;
+/**
+ * `TextActivity` is an object representing a text activity.
+ * It includes the id, user id, type, reply count, text, site url, lock status, subscription status, like count, like status, pin status, creation date, user details, replies, and likes.
+ */
+exports.TextActivitySchema = `
+  id
+  userId
+  type
+  replyCount
+  text (asHtml: $asHtml)
+  siteUrl
+  isLocked
+  isSubscribed
+  likeCount
+  isLiked
+  isPinned
+  createdAt
+  user {
+    ${BasicUser_1.BasicUserSchema}
+  }
+  replies {
+    ${ActivityReply_1.ActivityReplySchema}
+  }
+  likes {
+    ${BasicUser_1.BasicUserSchema}
+  }
+`;

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

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteCustomListMutation = void 0;
+const APIWrapper_1 = require("../../../base/APIWrapper");
+const RequestHandler_1 = require("../../../base/RequestHandler");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
+const Type_1 = require("../types/Type");
+/**
+ * `DeleteCustomListMutation` is a class representing a mutation to delete a custom list.
+ * It includes a method to delete a custom list
+ */
+class DeleteCustomListMutation extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `DeleteCustomListMutation` instance.
+     *
+     * @param authToken - The authentication token.
+     */
+    constructor(authToken) {
+        super('https://graphql.anilist.co');
+        this.authToken = authToken;
+    }
+    /**
+     * `deleteMediaListEntry` is a method that sends a mutation request to delete a custom list.
+     *
+     * @param variables - An object of type `DeleteCustomListVariables` 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.
+     *  */
+    deleteCustomList(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!variables.customList || !variables.type) {
+                throw new Error('customList & type variables are required');
+            }
+            const variableTypeMappings = {
+                customList: 'string',
+                type: Type_1.MediaTypeMappings
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
+            const mutation = `
+      mutation ($customList: String, $type: MediaType) {
+        DeleteCustomList(customList: $customList, type: $type) {
+          deleted
+        }
+      }
+    `;
+            const data = { query: mutation, variables };
+            return yield (0, RequestHandler_1.sendRequest)(this.baseURL, 'POST', data, this.authToken);
+        });
+    }
+}
+exports.DeleteCustomListMutation = DeleteCustomListMutation;

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

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteMediaListEntryMutation = void 0;
+const APIWrapper_1 = require("../../../base/APIWrapper");
+const RequestHandler_1 = require("../../../base/RequestHandler");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
+/**
+ * `DeleteMediaListEntryMutation` is a class representing a mutation to delete a media list entry.
+ * It includes a method to delete a media list entry.
+ */
+class DeleteMediaListEntryMutation extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `DeleteMediaListEntryMutation` instance.
+     *
+     * @param authToken - The authentication token.
+     */
+    constructor(authToken) {
+        super('https://graphql.anilist.co');
+        this.authToken = authToken;
+    }
+    /**
+     * `deleteMediaListEntry` is a method that sends a mutation request to delete a media list entry.
+     *
+     * @param variables - An object of type `DeleteMediaListEntryVariables` 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.
+     *  */
+    deleteMediaListEntry(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!variables.id) {
+                throw new Error('id variable is required');
+            }
+            const variableTypeMappings = {
+                id: 'number'
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
+            const mutation = `
+      mutation ($id: Int) {
+        DeleteMediaListEntry(id: $id) {
+          deleted
+        }
+      }
+    `;
+            const data = { query: mutation, variables };
+            return yield (0, RequestHandler_1.sendRequest)(this.baseURL, 'POST', data, this.authToken);
+        });
+    }
+}
+exports.DeleteMediaListEntryMutation = DeleteMediaListEntryMutation;

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

@@ -0,0 +1,62 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaveTextActivityMutation = void 0;
+const APIWrapper_1 = require("../../../base/APIWrapper");
+const RequestHandler_1 = require("../../../base/RequestHandler");
+const ValidateVariables_1 = require("../../../base/ValidateVariables");
+const Activity_1 = require("../interfaces/Activity");
+/**
+ * `SaveTextActivityMutation` is a class representing a mutation to save a text activity.
+ * It includes a method to save a text activity
+ */
+class SaveTextActivityMutation extends APIWrapper_1.APIWrapper {
+    /**
+     * Constructs a new `SaveTextActivityMutation` instance.
+     *
+     * @param authToken - The authentication token.
+     */
+    constructor(authToken) {
+        super('https://graphql.anilist.co');
+        this.authToken = authToken;
+    }
+    /**
+     * `saveTextActivity` is a method that sends a mutation request to save a text activity.
+     *
+     * @param variables - An object of type `SaveTextActivityVariables` 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.
+     *  */
+    saveTextActivity(variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!variables.id && !variables.text) {
+                throw new Error('id or text variable is required');
+            }
+            const variableTypeMappings = {
+                id: 'number',
+                text: 'string',
+                locked: 'boolean',
+                asHtml: 'boolean'
+            };
+            (0, ValidateVariables_1.validateVariables)(variables, variableTypeMappings);
+            const mutation = `
+      mutation ($id: Int, $text: String, $locked: Boolean, $asHtml: Boolean) {
+        SaveTextActivity(id: $id, text: $text, locked:$locked) {
+          ${Activity_1.TextActivitySchema}
+        }
+      }
+    `;
+            const data = { query: mutation, variables };
+            return yield (0, RequestHandler_1.sendRequest)(this.baseURL, 'POST', data, this.authToken);
+        });
+    }
+}
+exports.SaveTextActivityMutation = SaveTextActivityMutation;

package/package.json

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