add user's tagged posts' scraping

Author: ScriptSmith

src/api/api.ts

@@ -92,7 +92,14 @@ export class Post extends Instagram<TSinglePost> {
         // But usage with fullAPI option brings an extra post, because of scrapeDefaultPosts
         // So we force it to be disabled
         options.fullAPI = false;
-        super("https://instagram.com/p/", ids[0], "", "", options, SinglePost);
+        super(
+            "https://instagram.com/p/[id]",
+            ids[0],
+            "",
+            "",
+            options,
+            SinglePost,
+        );
         this.ids = ids;
     }
 
@@ -122,18 +129,18 @@ export function createApi(
 ): Search;
 export function createApi(type: "post", id: string[], options?: IOptions): Post;
 export function createApi(
-    type: "hashtag" | "user",
+    type: "hashtag" | "user" | "tagged",
     id: string,
     options?: IOptionsRegular | IOptionsRegularPlugins<InstagramPostClass>,
 ): InstagramPostClass;
 export function createApi(
-    type: "hashtag" | "user",
+    type: "hashtag" | "user" | "tagged",
     id: string,
     options?: IOptionsFullApi | IOptionsFullApiPlugins<InstagramFullPostClass>,
 ): InstagramFullPostClass;
 
 export function createApi(
-    type: "hashtag" | "user" | "post" | "search",
+    type: "hashtag" | "user" | "tagged" | "post" | "search",
     id: string | string[],
     options?: IOptions,
 ): Post | InstagramPostClass | InstagramFullPostClass | Search {
@@ -149,6 +156,9 @@ export function createApi(
         case "user":
             ClassConstructor = User;
             break;
+        case "tagged":
+            ClassConstructor = Tagged;
+            break;
     }
     if (options.fullAPI) {
         return new ClassConstructor<TFullApiPost>(id as string, options);
@@ -161,7 +171,7 @@ export function createApi(
  */
 export class Hashtag<T> extends Instagram<T> {
     constructor(id: string, options: IOptions = {}) {
-        const endpoint = "https://instagram.com/explore/tags/";
+        const endpoint = "https://instagram.com/explore/tags/[id]";
         const pageQuery = "data.hashtag.edge_hashtag_to_media.page_info";
         const edgeQuery = "data.hashtag.edge_hashtag_to_media.edges";
         super(
@@ -180,7 +190,7 @@ export class Hashtag<T> extends Instagram<T> {
  */
 export class User<T> extends Instagram<T> {
     constructor(id: string, options: IOptions = {}) {
-        const endpoint = "https://instagram.com/";
+        const endpoint = "https://instagram.com/[id]";
         const pageQuery = "data.user.edge_owner_to_timeline_media.page_info";
         const edgeQuery = "data.user.edge_owner_to_timeline_media.edges";
         super(
@@ -193,3 +203,22 @@ export class User<T> extends Instagram<T> {
         );
     }
 }
+
+/**
+ * An Instagram user's tagged posts API wrapper
+ */
+export class Tagged<T> extends Instagram<T> {
+    constructor(id: string, options: IOptions = {}) {
+        const endpoint = "https://instagram.com/[id]/tagged";
+        const pageQuery = "data.user.edge_user_to_photos_of_you.page_info";
+        const edgeQuery = "data.user.edge_user_to_photos_of_you.edges";
+        super(
+            endpoint,
+            id,
+            pageQuery,
+            edgeQuery,
+            options,
+            getPageValidator(options),
+        );
+    }
+}

src/api/instagram.ts

@@ -173,7 +173,7 @@ export class Instagram<PostType> extends EventEmitter {
         super();
         this.id = id;
         this.postIds = new PostIdSet();
-        this.url = endpoint + id;
+        this.url = endpoint.replace("[id]", id);
 
         options = Instagram.defaultOptions(options);
         this.total = options.total;

src/cli.ts

@@ -66,10 +66,24 @@ function buildParser(args, callback) {
             await spawn(handleArgs);
             callback();
         })
-        .command("user [id]", "Scrape a user", {}, async (handleArgs) => {
-            await spawn(handleArgs);
-            callback();
-        })
+        .command(
+            "user [id]",
+            "Scrape a users posts",
+            {},
+            async (handleArgs) => {
+                await spawn(handleArgs);
+                callback();
+            },
+        )
+        .command(
+            "tagged [id]",
+            "Scrape a user's tagged posts",
+            {},
+            async (handleArgs) => {
+                await spawn(handleArgs);
+                callback();
+            },
+        )
         .command(
             "post [ids]",
             "Scrape a comma-separated list of posts",

tests/test.spec.ts

@@ -3,7 +3,7 @@ import {Overrides, Request} from "puppeteer";
 import * as winston from "winston";
 import {createApi, IPlugin} from "..";
 import {plugins} from "..";
-import {IPluginContext} from "../plugins/plugin";
+import {IPluginContext} from "../plugins";
 import {IOptions, IOptionsFullApi} from "../src/api/api";
 import {FakePage, IFakePageOptions} from "./__fixtures__/FakePage";
 import {QuickGraft} from "./__fixtures__/QuickGraft";
@@ -70,6 +70,7 @@ describe("Library Classes", () => {
     const objects = {
         hashtag: createApi("hashtag", hashtags[0], libraryTestOptions),
         post: createApi("post", posts, libraryTestOptions),
+        tagged: createApi("tagged", users[0], libraryTestOptions),
         user: createApi("user", users[0], libraryTestOptions),
     };
 
@@ -94,6 +95,7 @@ describe("Library Functions", () => {
             libraryTestOptions,
         ).generator(),
         post: createApi("post", posts, libraryTestOptions).generator(),
+        tagged: createApi("tagged", users[0], libraryTestOptions).generator(),
         user: createApi("user", users[0], libraryTestOptions).generator(),
     };
 
@@ -118,6 +120,7 @@ describe("Full API", () => {
     const generators = {
         hashtag: createApi("hashtag", hashtags[0], fullApiOption).generator(),
         post: createApi("post", posts, fullApiOption).generator(),
+        tagged: createApi("tagged", users[0], fullApiOption).generator(),
         user: createApi("user", users[0], fullApiOption).generator(),
     };
 
@@ -134,11 +137,15 @@ describe("Full API", () => {
 });
 
 class ApiTestConditions {
-    public api: "hashtag" | "user";
+    public api: "hashtag" | "user" | "tagged";
     public ids: string[];
     public sizes: number[];
 
-    constructor(api: "hashtag" | "user", ids: string[], sizes: number[]) {
+    constructor(
+        api: "hashtag" | "user" | "tagged",
+        ids: string[],
+        sizes: number[],
+    ) {
         this.api = api;
         this.ids = ids;
         this.sizes = sizes;
@@ -152,6 +159,7 @@ const endpoints: ApiTestConditions[] = [
         smallSize,
     ]),
     new ApiTestConditions("user", users, [mediumSize, smallSize]),
+    new ApiTestConditions("tagged", users, [mediumSize, smallSize]),
 ];
 
 test("Instagram API limits", async () => {