activity.js

  1. const { TextActivityQuery, MessageActivityQuery, ListActivityQuery } = require("./consts");
  3. /**
  4.  * Access activities on AniList
  5.  * @since 1.7.0
  6.  * @memberof AniList
  7.  */
  8. class Activity {
  9. 	/**
  10. 	 * @description This constructor is meant for internal use and is apart of initializing. You cannot access this
  11. 	 * through the AniList class and are not expect to.
  12. 	 * @param { Utilities } utilities - The AniList Utilities class.
  13. 	 * @hideconstructor
  14. 	 */
  15. 	constructor(utilities) {
  16. 		this.util = utilities;
  17. 	}
  19. 	/**
  20. 	 * Get a specific AniList activity by its ID.
  21. 	 * @param {Number} activityID The AniList activity ID
  22. 	 * @returns { ListActivity | TextActivity | MessageActivity } Returns the activity information. Activity will either appear as:
  23. 	 * {@link ListActivity}, {@link TextActivity}, {@link MessageActivity}. All of which are identifiable by the type key.
  24. 	 * @since 1.7.0
  25. 	 */
  26. 	get(activityID) {
  27. 		const queryVars = this.util.generateQueryHeaders("Activity", activityID);
  29. 		return this.util
  30. 			.send(
  31. 				queryVars[1] +
  32. 					`... on ListActivity {
  33.                 ${ListActivityQuery}
  34.             }
  35.             ... on TextActivity {
  36.                 ${TextActivityQuery}
  37.             }
  38.             ... on MessageActivity {
  39.                 ${MessageActivityQuery}
  40.             }}}`,
  41. 				queryVars[0]
  42. 			)
  43. 			.then((data) => {
  44. 				return data.Activity;
  45. 			});
  46. 	}
  48. 	/**
  49. 	 * Fetch activities from a user.
  50. 	 * @param {Number} user - Required. Needs to be the user's AniList ID.
  51. 	 * @param {Number} page - The page number to display
  52. 	 * @param {Number} perPage - How many entries to display on one page. (Max is 25 per AniList limit)
  53. 	 * @returns { Object[] } Returns a list of user activities based on the page & perPage values Contains any number of
  54. 	 * {@link ListActivity}, {@link TextActivity}, {@link MessageActivity}. All of which are identifiable by the type key.
  55. 	 *
  56. 	 * @since 1.7.0
  57. 	 */
  58. 	getUserActivity(user, page = 1, perPage = 25) {
  59. 		if (typeof user !== "number" || typeof page !== "number" || typeof perPage !== "number") {
  60. 			throw new Error("Term does not match the required type!");
  61. 		}
  63. 		return this.util
  64. 			.send(
  65. 				`query ($page: Int, $perPage: Int, $user: Int) {
  66.             Page (page: $page, perPage: $perPage) { pageInfo { total currentPage lastPage hasNextPage perPage } 
  67.             activities(userId: $user, sort:ID_DESC) {
  68.                 ... on ListActivity { ${ListActivityQuery} }
  69.                 ... on TextActivity { ${TextActivityQuery} }
  70.                 ... on MessageActivity { ${MessageActivityQuery} }
  71.             } } }`,
  72. 				{ user: user, page: page, perPage: perPage }
  73. 			)
  74. 			.then((data) => {
  75. 				return data;
  76. 			});
  77. 	}
  79. 	/**
  80. 	 * [Require Login] Post a new text activity or update the activity with its ID
  81. 	 * @param {String} text - The content of the activity.
  82. 	 * @param {Number?} id - The AniList activity ID. Null to create, number for update
  83. 	 *
  84. 	 * @returns {TextActivity}
  85. 	 * @since 1.11.0
  86. 	 */
  87. 	async postText(text, id) {
  88. 		if (typeof text !== "string") {
  89. 			throw new Error("Text is not a string type.");
  90. 		}
  91. 		if (id && typeof id !== "number") {
  92. 			throw new Error("Provided ID is not a number type.");
  93. 		}
  95. 		const data = await this.util.send(
  96. 			`mutation ($id: Int, $text: String) {
  97. 				SaveTextActivity(id: $id, text: $text) {
  98. 				${TextActivityQuery}
  99. 			} }`,
  100. 			{ id: id, text: text }
  101. 		);
  102. 		return data.SaveTextActivity;
  103. 	}
  105. 	/**
  106. 	 * [Require Login] Post a new message activity or update the activity with its ID
  107. 	 * @param {String} text - The activity message text
  108. 	 * @param {Number} recipientId - The target user to send the message to
  109. 	 * @param {Boolean} isPrivate - Set to true if it is a private message
  110. 	 * @param {Number?} id - AniList Activity ID. Null to create, number to update.
  111. 	 *
  112. 	 * @returns {MessageActivity}
  113. 	 * @since 1.11.0
  114. 	 */
  115. 	async postMessage(text, recipientId, isPrivate = false, id) {
  116. 		if (typeof text !== "string") {
  117. 			throw new Error("Text is not a string type.");
  118. 		}
  119. 		if (typeof recipientId !== "number") {
  120. 			throw new Error("Recipient ID is not a number type.");
  121. 		}
  122. 		if (id && typeof id !== "number") {
  123. 			throw new Error("Provided ID is not a number type.");
  124. 		}
  126. 		const data = await this.util.send(
  127. 			`mutation ($id: Int, $text: String, $recipientId: Int, $private: Boolean) {
  128. 			SaveMessageActivity(message: $text, id: $id, recipientId: $recipientId, private: $private) {
  129. 			  ${MessageActivityQuery}
  130. 			} }`,
  131. 			{ id: id, text: text, recipientId: recipientId, private: isPrivate }
  132. 		);
  134. 		return data.SaveMessageActivity;
  135. 	}
  137. 	/**
  138. 	 * [Require Login] Delete the current authorized user's activity post
  139. 	 * @param {Number} id - The AniList activity ID to delete
  140. 	 *
  141. 	 * @returns {Boolean} Returns true if successful
  142. 	 * @since 1.11.0
  143. 	 */
  144. 	async delete(id) {
  145. 		if (typeof id !== "number") {
  146. 			throw new Error("ID is not a number type.");
  147. 		}
  149. 		const data = await this.util.send(`mutation ($id: Int) { DeleteActivity(id: $id) { deleted } }`, { id: id });
  151. 		return data.DeleteActivity.deleted;
  152. 	}
  153. }
  155. module.exports = Activity;