anilink-api-wrapper 1.17.4 → 1.17.6

package/README.md

@@ -1 +1,320 @@
 # AniLink
+
+For full documentation on methods and parameters, please refer to the [AniLink documentation](https://rlalpha49.github.io/AniLink/).
+
+AniLink is a TypeScript library for interacting with the AniList API. It provides methods for querying and mutating data, making it easier to integrate AniList's features into your own applications.
+
+## Installation
+
+To install AniLink, you can use npm:
+
+```bash
+npm install anilink-api-wrapper
+```
+
+## Initialization
+
+### AniList
+
+To start using AniLink, you need to import it and initialize it with an optional authentication token. You can get an authentication token by registering your application on the AniList website.
+
+#### Typescript
+
+```typescript
+import AniLink from 'anilink-api-wrapper';
+```
+
+#### Javascript
+
+```javascript
+const AniLink = require('anilink-api-wrapper');
+```
+
+#### Initialization
+
+```typescript
+const authToken = 'your-auth-token';
+const aniLink = new AniLink(authToken);
+```
+
+You can also initialize AniLink without an authentication token
+
+```typescript
+const aniLink = new AniLink();
+```
+
+## 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
+
+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.
+
+List of main query methods in `anilist.query`:
+
+- user
+- media
+- mediaTrend
+- airingSchedule
+- character
+- staff
+- mediaList
+- mediaListCollection
+- genreCollection
+- mediaTagCollection
+- viewer
+- notification
+- studio
+- review
+- activity
+- activityReply
+- following
+- follower
+- thread
+- threadComment
+- recommendation
+- markdown
+- aniChartUser
+- siteStatistics
+- externalLinkSourceCollection
+
+List of page query methods in `anilist.query.page`:
+
+- users
+- medias
+- characters
+- staffs
+- studios
+- mediaLists
+- airingSchedules
+- mediaTrends
+- notifications
+- followers
+- following
+- activities
+- activityReplies
+- threads
+- threadComments
+- reviews
+- recommendations
+- likes
+
+### Mutation Methods
+
+List of methods in `anilist.mutation`:
+
+- updateUser
+- saveMediaListEntry
+- updateMediaListEntries
+
+
+## Examples
+
+Here are examples of how to use AniLink to interact with the AniList API:
+
+### Querying user data
+
+```typescript
+// Querying user data
+aniLink.anilist.query.user({id: 542244, isHTML: true});
+
+// Querying media data
+aniLink.anilist.query.media({id: 1, type: 'ANIME'});
+
+// Querying media trend data
+aniLink.anilist.query.mediaTrend({mediaId: 1, type: 'ANIME'});
+
+// Querying airing schedule data
+aniLink.anilist.query.airingSchedule({mediaId: 130590});
+
+// Querying character data
+aniLink.anilist.query.character({
+  id: 1,
+  asHtml: true,
+  mediaSort: ['POPULARITY_DESC'],
+  mediaType: 'ANIME',
+  mediaOnList: true,
+  mediaPage: 1,
+  mediaPerPage: 10
+});
+
+// Querying staff data
+aniLink.anilist.query.staff({
+  id: 132186,
+  asHtml: true,
+  staffMediaSort: ['POPULARITY_DESC'],
+  staffMediaType: 'ANIME',
+  staffMediaOnList: true,
+  staffMediaPage: 1,
+  staffMediaPerPage: 10,
+  charactersSort: ['ID'],
+  charactersPage: 1,
+  charactersPerPage: 10,
+  characterMediaSort: ['POPULARITY_DESC'],
+  characterMediaOnList: true,
+  characterMediaPage: 1,
+  characterMediaPerPage: 10
+});
+
+// Querying media list data
+aniLink.anilist.query.mediaList({userId: 542244});
+
+// Querying media list collection data
+aniLink.anilist.query.mediaListCollection({
+  userId: 542244,
+  type: 'ANIME',
+  status: 'COMPLETED',
+  chunk: 1,
+  perChunk: 10000
+});
+
+// Querying genre collection data
+aniLink.anilist.query.genreCollection();
+
+// Querying media tag collection data
+aniLink.anilist.query.mediaTagCollection();
+
+// Querying viewer data
+aniLink.anilist.query.viewer({isHTML: true});
+
+// Querying notification data
+aniLink.anilist.query.notification({asHtml: true});
+
+// Querying studio data
+aniLink.anilist.query.studio({id: 561, asHtml: true});
+
+// Querying review data
+aniLink.anilist.query.review({id: 8008, asHtml: true});
+
+// Querying activity data
+aniLink.anilist.query.activity({id: 723235883, asHtml: true});
+
+// Querying activity reply data
+aniLink.anilist.query.activityReply({id: 12191046, asHtml: true});
+
+// Querying following data
+aniLink.anilist.query.following({userId: 542244, asHtml: true});
+
+// Querying follower data
+aniLink.anilist.query.follower({userId: 542244, asHtml: true});
+
+// Querying thread data
+aniLink.anilist.query.thread({id: 71881, asHtml: true});
+
+// Querying thread comment data
+aniLink.anilist.query.threadComment({id: 2555166, asHtml: true});
+
+// Querying recommendation data
+aniLink.anilist.query.recommendation({mediaId: 156822, asHtml: true});
+
+// Querying markdown data
+aniLink.anilist.query.markdown({markdown: 'Hello'});
+
+// Querying AniChartUser data
+aniLink.anilist.query.aniChartUser();
+
+// Querying site statistics data
+aniLink.anilist.query.siteStatistics();
+
+// Querying external link source collection data
+aniLink.anilist.query.externalLinkSourceCollection();
+
+// Querying users page data
+aniLink.anilist.query.page.users({id: 542244, isHTML: true});
+
+// Querying media page data
+aniLink.anilist.query.page.medias({id: 1, type: 'ANIME'});
+
+// Querying character page data
+aniLink.anilist.query.page.characters({id: 1, asHtml: true});
+
+// Querying staff page data
+aniLink.anilist.query.page.staffs({id: 132186, asHtml: true});
+
+// Querying studio page data
+aniLink.anilist.query.page.studios({id: 561, asHtml: true});
+
+// Querying media list page data
+aniLink.anilist.query.page.mediaLists({userId: 542244});
+
+// Querying airing schedule page data
+aniLink.anilist.query.page.airingSchedules({mediaId: 130590});
+
+// Querying media trend page data
+aniLink.anilist.query.page.mediaTrends({mediaId: 1, type: 'ANIME'});
+
+// Querying notification page data
+aniLink.anilist.query.page.notifications({asHtml: true});
+
+// Querying follower page data
+aniLink.anilist.query.page.followers({userId: 542244, asHtml: true});
+
+// Querying following page data
+aniLink.anilist.query.page.following({userId: 542244, asHtml: true});
+
+// Querying activity page data
+aniLink.anilist.query.page.activities({id: 723235883, asHtml: true});
+
+// Querying activity reply page data
+aniLink.anilist.query.page.activityReplies({id: 12191046, asHtml: true
+});
+
+// Querying thread page data
+aniLink.anilist.query.page.threads({id: 71881, asHtml: true});
+
+// Querying thread comment page data
+aniLink.anilist.query.page.threadComments({threadId: 71881, asHtml: true
+});
+
+// Querying review page data
+aniLink.anilist.query.page.reviews({id: 8008, asHtml: true});
+
+// Querying recommendation page data
+aniLink.anilist.query.page.recommendations({mediaId: 156822, asHtml: true
+});
+
+// Querying likes page data
+aniLink.anilist.query.page.likes({likeableId: 723422275, type: 'ACTIVITY', asHtml: true
+});
+```
+
+### Mutating user data
+
+```typescript
+// Updating a user
+aniLink.anilist.mutation.updateUser({
+  about: 'New about text',
+  titleLanguage: 'ENGLISH',
+  displayAdultContent: true,
+  airingNotifications: true,
+  scoreFormat: 'POINT_10',
+  rowOrder: 'title',
+  profileColor: 'blue',
+  donatorBadge: 'Supporter',
+  notificationOptions: [{type: 'AIRING', enabled: true}],
+  timezone: '-06:00',
+  activityMergeTime: 30,
+  animeListOptions: {sectionOrder: ['title'], customLists: [], advancedScoring: [], advancedScoringEnabled: false},
+  mangaListOptions: {sectionOrder: ['title'], customLists: [], advancedScoring: [], advancedScoringEnabled: false},
+  staffNameLanguage: 'ROMAJI',
+  restrictMessagesToFollowing: false,
+  disabledListActivity: [{type: 'CURRENT', disabled: false}]
+});
+
+// Saving media list entries
+aniLink.anilist.mutation.saveMediaListEntry({
+  mediaId: 1,
+  status: 'CURRENT',
+  score: 8.5,
+  progress: 3,
+});
+
+// Updating media list entries
+aniLink.anilist.mutation.updateMediaListEntries({
+  status: 'CURRENT',
+  score: 8.5,
+  progress: 3,
+  ids: [143271, 156822, 170890],
+});
+```

package/dist/AniLink.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AniLink = void 0;
 const Activity_1 = require("./apis/anilist/query/Activity");
 const ActivityReply_1 = require("./apis/anilist/query/ActivityReply");
 const ActivityReplies_1 = require("./apis/anilist/query/page/ActivityReplies");
@@ -46,7 +47,15 @@ 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");
+/**
+ * `AniLink` is a class for interacting with the APIs.
+ * It provides methods for querying and mutating data.
+ */
 class AniLink {
+    /**
+     * Creates a new AniLink instance.
+     * @param {string} authToken - The authentication token to use for API requests.
+     */
     constructor(authToken) {
         const userQueryInstance = new User_1.UserQuery(authToken);
         const mediaQueryInstance = new Media_1.MediaQuery(authToken);
@@ -150,4 +159,5 @@ class AniLink {
         };
     }
 }
+exports.AniLink = AniLink;
 module.exports = AniLink;

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

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActivityWithRepliesSchema = exports.ActivitySchema = void 0;
 const BasicUser_1 = require("./BasicUser");
 const ActivityReply_1 = require("./ActivityReply");
+/**
+ * `ActivitySchema` is a constant representing the GraphQL schema for an activity query.
+ * It includes the TextActivity, ListActivity, and MessageActivity each having their own properties.
+ */
 exports.ActivitySchema = `
   activity {
     ... on TextActivity {
@@ -58,6 +62,10 @@ exports.ActivitySchema = `
     }
   }
 `;
+/**
+ * `ActivityWithRepliesSchema` is a constant representing the GraphQL schema for an activity query with replies.
+ * It includes the TextActivity, ListActivity, and MessageActivity each having their own properties and replies.
+ */
 exports.ActivityWithRepliesSchema = `
   ... on TextActivity {
     id

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

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActivityNotificationSchema = void 0;
 const Activity_1 = require("./Activity");
 const BasicUser_1 = require("./BasicUser");
+/**
+ * `ActivityNotificationSchema` is a constant representing the GraphQL schema for an activity notification query.
+ * It includes the id of the notification, the user id, the type of the notification, the activity id, the context, the creation date, the activity details, and the user details.
+ */
 exports.ActivityNotificationSchema = `
   id
   userId

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

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActivityReplySchema = void 0;
 const BasicUser_1 = require("./BasicUser");
+/**
+ * `ActivityReplySchema` is a constant representing the GraphQL schema for an activity reply query.
+ * It includes the id of the reply, the user id, the activity id, the text of the reply, the like count, the like status, the creation date, the user details, and the likes details.
+ */
 exports.ActivityReplySchema = `
   id
   userId

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasicCommentSchema = void 0;
+/**
+ * `BasicCommentSchema` is a string representing the GraphQL schema for a basic comment.
+ * It includes the id, user id, and thread id.
+ */
 exports.BasicCommentSchema = `
   id
   userId

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasicThreadSchema = void 0;
+/**
+ * `BasicThreadSchema` is a string representing the GraphQL schema for a basic thread.
+ * It includes the id, title, body, and site url.
+ */
 exports.BasicThreadSchema = `
   id
   title

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasicUserSchema = void 0;
+/**
+ * `BasicUserSchema` is a string representing the GraphQL schema for a basic user.
+ * It includes the id, name, and avatar with a large size.
+ */
 exports.BasicUserSchema = `
   id
   name

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CoverImageSchema = void 0;
+/**
+ * `CoverImageSchema` is a string representing the GraphQL schema for a cover image.
+ * It includes the extra large, large, medium size images and color.
+ */
 exports.CoverImageSchema = `
   coverImage {
     extraLarge

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExternalLinkSchema = void 0;
+/**
+ * `ExternalLinkSchema` is a string representing the GraphQL schema for an external link.
+ * It includes the id, url, and site.
+ */
 exports.ExternalLinkSchema = `
   externalLinks {
     id

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FuzzyDateSchema = void 0;
+/**
+ * `FuzzyDateSchema` is a string representing the GraphQL schema for a fuzzy date.
+ * It includes the year, month, and day.
+ */
 exports.FuzzyDateSchema = `
   year
   month

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImageSchema = void 0;
+/**
+ * `ImageSchema` is a string representing the GraphQL schema for an image.
+ * It includes the large and medium size images.
+ */
 exports.ImageSchema = `
   image {
     large

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MediaListEntrySchema = void 0;
+/**
+ * `MediaListEntrySchema` is a string representing the GraphQL schema for a media list entry.
+ * It includes the id and status.
+ */
 exports.MediaListEntrySchema = `
   mediaListEntry {
     id

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NameSchema = void 0;
+/**
+ * `NameSchema` is a string representing the GraphQL schema for a name.
+ * It includes the first name, last name, full name, and native name.
+ */
 exports.NameSchema = `
   name {
     first

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NextAiringEpisodeSchema = void 0;
+/**
+ * `NextAiringEpisodeSchema` is a string representing the GraphQL schema for a next airing episode.
+ * It includes the airing time, time until airing, and the episode number.
+ */
 exports.NextAiringEpisodeSchema = `
   nextAiringEpisode {
     airingAt

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RankingSchema = void 0;
+/**
+ * `RankingSchema` is a string representing the GraphQL schema for a ranking.
+ * It includes the id, rank, type, format, year, season, all-time status, and context.
+ */
 exports.RankingSchema = `
   rankings {
     id

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScoreDistributionSchema = void 0;
+/**
+ * `ScoreDistributionSchema` is a string representing the GraphQL schema for a score distribution.
+ * It includes the score and the amount.
+ */
 exports.ScoreDistributionSchema = `
   scoreDistribution {
     score

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SiteTrendSchema = void 0;
+/**
+ * `SiteTrendSchema` is a string representing the GraphQL schema for a site trend.
+ * It includes the date, count, and change.
+ */
 exports.SiteTrendSchema = `
   date
   count

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

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SiteTrendConnectionSchema = void 0;
 const SiteTrend_1 = require("./SiteTrend");
+/**
+ * `SiteTrendConnectionSchema` is a string representing the GraphQL schema for a site trend connection.
+ * It includes the page information and the edges and nodes of the site trends.
+ */
 exports.SiteTrendConnectionSchema = `
   pageInfo {
     total

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatusDistributionSchema = void 0;
+/**
+ * `StatusDistributionSchema` is a string representing the GraphQL schema for a status distribution.
+ * It includes the status and amount.
+ */
 exports.StatusDistributionSchema = `
   statusDistribution {
     status

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamingEpisodeSchema = void 0;
+/**
+ * `StreamingEpisodeSchema` is a string representing the GraphQL schema for a streaming episode.
+ * It includes the title, thumbnail, url, and site.
+ */
 exports.StreamingEpisodeSchema = `
   streamingEpisodes {
     title

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TagSchema = void 0;
+/**
+ * `TagSchema` is a string representing the GraphQL schema for a tag.
+ * It includes the id, name, description, category, rank, isGeneralSpoiler, isMediaSpoiler, isAdult, and userId.
+ */
 exports.TagSchema = `
   id
   name

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

@@ -4,6 +4,10 @@ exports.ThreadNotificationSchema = void 0;
 const BasicThread_1 = require("./BasicThread");
 const BasicComment_1 = require("./BasicComment");
 const BasicUser_1 = require("./BasicUser");
+/**
+ * `ThreadNotificationSchema` is a string representing the GraphQL schema for a thread notification.
+ * It includes the id, userId, type, commentId, context, createdAt, thread, comment, and user.
+ */
 exports.ThreadNotificationSchema = `
   id
   userId

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TitleSchema = void 0;
+/**
+ * `TitleSchema` is a string representing the GraphQL schema for a title.
+ * It includes the romaji, english, native, and userPreferred.
+ */
 exports.TitleSchema = `
   title {
     romaji

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TrailerSchema = void 0;
+/**
+ * `TrailerSchema` is a string representing the GraphQL schema for a trailer.
+ * It includes the id, site, and thumbnail.
+ */
 exports.TrailerSchema = `
   trailer {
     id

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

@@ -1,12 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserMangaStatsSchema = exports.UserAnimeStatsSchema = void 0;
+/**
+ * `UserAnimeStatsSchema` is a string representing the GraphQL schema for a user's anime statistics.
+ * It includes the count, meanScore, minutesWatched, and mediaIds.
+ */
 exports.UserAnimeStatsSchema = `
   count
   meanScore
   minutesWatched
   mediaIds
 `;
+/**
+ * `UserMangaStatsSchema` is a string representing the GraphQL schema for a user's manga statistics.
+ * It includes the count, meanScore, chaptersRead, and mediaIds.
+ */
 exports.UserMangaStatsSchema = `
   count
   meanScore

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

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AiringScheduleSchema = void 0;
 const Media_1 = require("./Media");
+/**
+ * `AiringScheduleSchema` is a constant representing the GraphQL schema for an airing schedule query.
+ * It includes the id, airing time, time until airing, episode number, media id, and the media schema.
+ */
 exports.AiringScheduleSchema = `
   id
   airingAt

package/dist/apis/anilist/interfaces/responses/query/Character.js

@@ -5,6 +5,10 @@ const FuzzyDate_1 = require("../../FuzzyDate");
 const Name_1 = require("../../Name");
 const Image_1 = require("../../Image");
 const Title_1 = require("../../Title");
+/**
+ * `CharacterSchema` is a constant representing the GraphQL schema for a character query.
+ * It includes the character's id, name, image, description, gender, date of birth, age, blood type, favourite status, site URL, associated media, number of favourites, and moderator notes.
+ */
 exports.CharacterSchema = `
   id
   ${Name_1.NameSchema}