node-steamcommunity/components/sharedfiles.js

const StdLib = require('@doctormckay/stdlib');
const SteamID = require('steamid');

const SteamCommunity = require('../index.js');


/**
 * Deletes a comment from a sharedfile's comment section
 * @param {SteamID | String} userID - ID of the user associated to this sharedfile
 * @param {String} sharedFileId - ID of the sharedfile
 * @param {String} cid - ID of the comment to delete
 * @param {function} [callback] - Takes only an Error object/null as the first argument
 * @return Promise<void>
 */
SteamCommunity.prototype.deleteSharedFileComment = function(userID, sharedFileId, cid, callback) {
	if (typeof userID == 'string') {
		userID = new SteamID(userID);
	}

	return StdLib.Promises.callbackPromise(null, callback, true, async (resolve, reject) => {
		await this.httpRequest({
			method: 'POST',
			url: `https://steamcommunity.com/comment/PublishedFile_Public/delete/${userID.toString()}/${sharedFileId}/`,
			form: {
				gidcomment: cid,
				count: 10,
				sessionid: this.getSessionID()
			},
			source: 'steamcommunity'
		});

		resolve();
	});
};

/**
 * Favorites a sharedfile
 * @param {String} sharedFileId - ID of the sharedfile
 * @param {String} appid - ID of the app associated to this sharedfile
 * @param {function} [callback] - Takes only an Error object/null as the first argument
 * @return Promise<void>
 */
SteamCommunity.prototype.favoriteSharedFile = function(sharedFileId, appid, callback) {
	return StdLib.Promises.callbackPromise(null, callback, true, async (resolve, reject) => {
		await this.httpRequest({
			method: 'POST',
			url: 'https://steamcommunity.com/sharedfiles/favorite',
			form: {
				id: sharedFileId,
				appid,
				sessionid: this.getSessionID()
			},
			source: 'steamcommunity'
		});

		resolve();
	});
};

/**
 * Posts a comment to a sharedfile
 * @param {SteamID | String} userID - ID of the user associated to this sharedfile
 * @param {String} sharedFileId - ID of the sharedfile
 * @param {String} message - Content of the comment to post
 * @param {function} [callback] - Takes only an Error object/null as the first argument
 * @return Promise<void>
 */
SteamCommunity.prototype.postSharedFileComment = function(userID, sharedFileId, message, callback) {
	if (typeof userID == 'string') {
		userID = new SteamID(userID);
	}

	return StdLib.Promises.callbackPromise(null, callback, true, async (resolve, reject) => {
		await this.httpRequest({
			method: 'POST',
			url: `https://steamcommunity.com/comment/PublishedFile_Public/post/${userID.toString()}/${sharedFileId}/`,
			form: {
				comment: message,
				count: 10,
				sessionid: this.getSessionID()
			},
			source: 'steamcommunity'
		});

		resolve();
	});
};

/**
 * Subscribes to a sharedfile's comment section. Note: Checkbox on webpage does not update
 * @param {SteamID | String} userID ID of the user associated to this sharedfile
 * @param {String} sharedFileId ID of the sharedfile
 * @param {function} [callback] - Takes only an Error object/null as the first argument
 * @return Promise<void>
 */
SteamCommunity.prototype.subscribeSharedFileComments = function(userID, sharedFileId, callback) {
	if (typeof userID == 'string') {
		userID = new SteamID(userID);
	}

	return StdLib.Promises.callbackPromise(null, callback, true, async (resolve, reject) => {
		await this.httpRequest({
			method: 'POST',
			url: `https://steamcommunity.com/comment/PublishedFile_Public/subscribe/${userID.toString()}/${sharedFileId}/`,
			form: {
				count: 10,
				sessionid: this.getSessionID()
			},
			source: 'steamcommunity'
		});

		resolve();
	});
};

/**
 * Unfavorites a sharedfile
 * @param {String} sharedFileId - ID of the sharedfile
 * @param {String} appid - ID of the app associated to this sharedfile
 * @param {function} [callback] - Takes only an Error object/null as the first argument
 * @return Promise<void>
 */
SteamCommunity.prototype.unfavoriteSharedFile = function(sharedFileId, appid, callback) {
	return StdLib.Promises.callbackPromise(null, callback, true, async (resolve, reject) => {
		await this.httpRequest({
			method: 'POST',
			url: 'https://steamcommunity.com/sharedfiles/unfavorite',
			form: {
				id: sharedFileId,
				appid,
				sessionid: this.getSessionID()
			},
			source: 'steamcommunity'
		});

		resolve();
	});
};

/**
 * Unsubscribes from a sharedfile's comment section. Note: Checkbox on webpage does not update
 * @param {SteamID | String} userID - ID of the user associated to this sharedfile
 * @param {String} sharedFileId - ID of the sharedfile
 * @param {function} callback - Takes only an Error object/null as the first argument
 */
SteamCommunity.prototype.unsubscribeSharedFileComments = function(userID, sharedFileId, callback) {
	if (typeof userID === 'string') {
		userID = new SteamID(userID);
	}

	return StdLib.Promises.callbackPromise(null, callback, true, async (resolve, reject) => {
		await this.httpRequest({
			method: 'POST',
			url: `https://steamcommunity.com/comment/PublishedFile_Public/unsubscribe/${userID.toString()}/${sharedFileId}/`,
			form: {
				count: 10,
				sessionid: this.getSessionID()
			}
		});

		resolve();
	});
};