furtrack-api 1.0.1 → 1.1.0

package/README.md

@@ -2,6 +2,8 @@
 
 An unofficial Node.js package for accessing the Furtrack API.
 
+> ⚠️ **Warning**: This package was built by **reverse engineering the FurTrack frontend**, and it is a **best-effort implementation**. FurTrack's internal API may change at any time, which can cause this package to break or behave unexpectedly.
+
 
 ## Features
 
@@ -75,6 +77,11 @@ api.getAlbum('username', 'albumid').then(album => {
 	console.log(album)
 })
 
+// Fetch all tags
+api.getTags().then(tags => {
+	console.log(tags);
+})
+
 ```
 
 Functions which return a list of arrays additional support a page argument, FurTrack generally paginates albums longer than 200 images, by default only the first page is retrieved.
@@ -94,4 +101,4 @@ const characters = FurtrackAPI.getTagsByType(tags, FurtrackAPI.TagTypes.Characte
 
 ---
 
-MIT License © 2025 blumlaut
+MIT License © 2025 blumlaut

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "furtrack-api",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "An inofficial package for accessing the Furtrack API.",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -29,6 +29,9 @@ const https = require('https');
  * @param {Object} [options] - Additional fetch options.
  * @returns {Promise<Object>} The parsed JSON response.
  * 
+ * @method getTags Fetches all tags from FurTrack.
+ * @returns {Promise<Object>} Tags data with success flag and tags array.
+ *
  * @method getTag Fetches information about a specific tag.
  * @param {string} tag - The tag to fetch.
  * @returns {Promise<Object>} Tag information.
@@ -116,7 +119,7 @@ class FurtrackAPI {
 		'2:': this.TagTypes.Maker,
 		'3:': this.TagTypes.Photographer,
 		'5:': this.TagTypes.Event,
-		'6': this.TagTypes.Species,
+		'6:': this.TagTypes.Species,
 
 	};
 
@@ -142,6 +145,10 @@ class FurtrackAPI {
 		return res.json();
 	}
 
+	getTags() {
+		return this.fetchJSON(`/get/tags/all`);
+	}
+
 	getTag(tag) {
 		return this.fetchJSON(`/get/index/${encodeURIComponent(tag)}`);
 	}
@@ -155,7 +162,7 @@ class FurtrackAPI {
 	}
 
 	async getPostsByTag(tag, page = 0) {
-		const response = await this.fetchJSON(`/get/tag/${encodeURIComponent(tag)}${page > 0 ? `/${page}` : ''}`);
+		const response = await this.fetchJSON(`/view/index/${encodeURIComponent(tag)}${page > 0 ? `/${page}` : ''}`);
 		return response.posts || [];
 	}
 
@@ -195,13 +202,78 @@ class FurtrackAPI {
 	}
 
 
-	static getTagsByType(tags, type) {
+ static getTagsByType(tags, type) {
 		return tags
 			.map(tag => this.parseTag(tag.tagName))
 			.filter(parsed => parsed.type === type)
 			.map(parsed => parsed.value);
 	}
 
+	/**
+	 * Fetches all character tags associated with a maker tag.
+	 * Returns the full character metadata including tag counts and followers.
+	 * 
+	 * @param {string} makerTag - The maker tag (e.g., "wild_dog_works" or "maker:wild_dog_works").
+	 * @returns {Promise<Array>} Array of character tag objects with metadata.
+	 * 
+	 * @example
+	 * const characters = await api.getCharactersByMaker('wild_dog_works');
+	 * // Returns: [{ tagName: '1:colby_(husky)', tagType: 1, tagTitle: 'Colby', ... }, ...]
+	 */
+	async getCharactersByMaker(makerTag) {
+		// Normalize tag format
+		if (!makerTag.startsWith('2:')) {
+			makerTag = `2:${makerTag}`;
+		}
+		const tagData = await this.getTag(makerTag.replace('2:', 'maker:'));
+		return tagData.tagmeta?.tagChildrenFull || [];
+	}
+
+	/**
+	 * Fetches all related tags for a character, including makers, species, and color tags.
+	 * 
+	 * @param {string} characterTag - The character tag (e.g., "colby_(husky)" or "character:colby_(husky)").
+	 * @returns {Promise<Object>} Object with categorized related tags.
+	 * @returns {Promise<Object>.makers} Array of maker tag values.
+	 * @returns {Promise<Object>.species} Array of species tag values.
+	 * @returns {Promise<Object>.colors} Array of color/general tag values.
+	 * @returns {Promise<Object>.all} Array of all related tag names.
+	 * 
+	 * @example
+	 * const related = await api.getRelatedTagsByCharacter('colby_(husky)');
+	 * // Returns: { makers: ['wild_dog_works', 'pyrope_costumes'], species: ['husky'], colors: ['black', 'blue', ...], all: [...] }
+	 */
+	async getRelatedTagsByCharacter(characterTag) {
+		// Normalize tag format
+		if (!characterTag.startsWith('1:')) {
+			characterTag = `1:${characterTag}`;
+		}
+		const tagData = await this.getTag(characterTag.replace('1:', 'character:'));
+		const tagAlso = tagData.tagmeta?.tagAlso || [];
+		
+		return {
+			makers: FurtrackAPI.getTagsByType(tagAlso.map(t => ({ tagName: t })), FurtrackAPI.TagTypes.Maker),
+			species: FurtrackAPI.getTagsByType(tagAlso.map(t => ({ tagName: t })), FurtrackAPI.TagTypes.Species),
+			colors: tagAlso.filter(t => !t.startsWith('1:') && !t.startsWith('2:') && !t.startsWith('3:') && !t.startsWith('5:') && !t.startsWith('6:')),
+			all: tagAlso
+		};
+	}
+
+	/**
+	 * Fetches all makers associated with a character tag.
+	 * 
+	 * @param {string} characterTag - The character tag (e.g., "colby_(husky)" or "character:colby_(husky)").
+	 * @returns {Promise<Array>} Array of maker tag values.
+	 * 
+	 * @example
+	 * const makers = await api.getMakersByCharacter('colby_(husky)');
+	 * // Returns: ['wild_dog_works', 'pyrope_costumes']
+	 */
+	async getMakersByCharacter(characterTag) {
+		const related = await this.getRelatedTagsByCharacter(characterTag);
+		return related.makers;
+	}
+
 }
 
 module.exports = FurtrackAPI;

package/src/index.test.js

@@ -50,7 +50,7 @@ describe('FurtrackAPI', () => {
 			expect(result).toEqual({ type: FurtrackAPI.TagTypes.Event, value: 'SomeEvent' });
 		});
 		test('parses species tag', () => {
-			const result = api.parseTag('6Wolf');
+			const result = api.parseTag('6:Wolf');
 			expect(result).toEqual({ type: FurtrackAPI.TagTypes.Species, value: 'Wolf' });
 		});
 		test('parses general tag', () => {