pupgram 0.2.0 → 0.3.0

package/README.md

@@ -47,7 +47,7 @@ async function main() {
         caption: "Hello from Pupgram! 🚀",
     })
 
-    console.log(`Post created! URL: https://www.instagram.com/p/${postData.code}`)
+    console.log(`Post created! URL: ${postData.url}`)
     console.log(postData)
 
     // 4. Close the instance
@@ -80,11 +80,11 @@ async function main() {
 
     // 3. Create a Reel
     const reelData = await instagram.createReel({
-        filePaths: ["./path/to/video.mp4"],
+        filePath: "./path/to/video.mp4",
         caption: "My awesome Reel! 🎥",
     })
 
-    console.log(`Reel created! URL: https://www.instagram.com/reel/${reelData.code}`)
+    console.log(`Reel created! URL: ${reelData.url}`)
 
     // 4. Close the instance
     await instagram.close()
@@ -123,6 +123,20 @@ Automate reel publishing with support for:
 
 Pupgram is designed to be flexible. You can provide custom configurations for different locales or UI variations using the `config` option in `Instagram.create`.
 
+#### 🌍 Forcing Language
+
+You can force Instagram to load in a specific language using the `languageParam` option. This is useful to ensure the UI matches the selectors provided in your config.
+
+```ts
+import { Instagram, enConfig, Language } from "pupgram"
+
+const instagram = await Instagram.create({
+    // ... other options
+    config: enConfig,
+    languageParam: Language.EN_US // Forces ?hl=en-us
+})
+```
+
 #### 🐞 Debugging
 
 When things go wrong, Pupgram helps you diagnose the issue. If `screenshotOnError` or `htmlContentOnError` are enabled (default: `true`), Pupgram creates an `errors` directory in your project root.

package/dist/actions/create-post/put-post-caption.action.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.putPostCaptionAction = void 0;
-const delay_util_1 = require("../../utils/delay.util");
 const error_1 = require("../../error");
+const utils_1 = require("../../utils");
 const putPostCaptionAction = (caption) => {
     return async ({ page, config, logger, defaultTimeout }) => {
         logger.info("Starting to put post caption");
@@ -17,7 +17,7 @@ const putPostCaptionAction = (caption) => {
         await captionElement.focus();
         await page.keyboard.type(caption);
         await page.keyboard.press("Tab");
-        await (0, delay_util_1.delay)(300);
+        await (0, utils_1.delay)(300);
         logger.info("Post caption successfully entered");
     };
 };

package/dist/actions/delay.action.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.delayAction = void 0;
-const delay_util_1 = require("../utils/delay.util");
+const utils_1 = require("../utils");
 const delayAction = (delayTime) => {
     return async ({ logger }) => {
         logger.info("Delaying");
-        await (0, delay_util_1.delay)(delayTime);
+        await (0, utils_1.delay)(delayTime);
         logger.debug("Delaying");
     };
 };

package/dist/enums/index.d.ts

@@ -0,0 +1 @@
+export * from "./language.enum";

package/dist/enums/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./language.enum"), exports);

package/dist/enums/language.enum.d.ts

@@ -0,0 +1,10 @@
+export declare enum Language {
+    EN_US = "en-us",
+    EN_UK = "en-uk",
+    EN = "en",
+    PT_BR = "pt-br",
+    PT = "pt",
+    PT_PT = "pt-pt",
+    ES = "es",
+    ES_MX = "es-mx"
+}

package/dist/enums/language.enum.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Language = void 0;
+var Language;
+(function (Language) {
+    Language["EN_US"] = "en-us";
+    Language["EN_UK"] = "en-uk";
+    Language["EN"] = "en";
+    Language["PT_BR"] = "pt-br";
+    Language["PT"] = "pt";
+    Language["PT_PT"] = "pt-pt";
+    Language["ES"] = "es";
+    Language["ES_MX"] = "es-mx";
+})(Language || (exports.Language = Language = {}));

package/dist/instagram.d.ts

@@ -1,6 +1,7 @@
 import { Browser } from "puppeteer";
 import { PostData } from "./interfaces/post-data.interface";
 import { Config } from "./interfaces";
+import { Language } from "./enums";
 export declare const defaultTimeout = 10000;
 export type CreateInstagramOptions = {
     puppeteer: {
@@ -14,6 +15,7 @@ export type CreateInstagramOptions = {
     htmlContentOnError?: boolean;
     config: Config;
     defaultTimeout?: number;
+    languageParam?: Language;
 };
 export type InstagramOptions = {
     browser: Browser;
@@ -22,6 +24,7 @@ export type InstagramOptions = {
     htmlContentOnError: boolean;
     config: Config;
     defaultTimeout?: number;
+    languageParam?: Language;
 };
 export type LogInOptions = {
     username: string;
@@ -31,6 +34,13 @@ export type CreatePostOptions = {
     filePaths: string[];
     caption: string;
 };
+export type CreateReelOptions = {
+    filePath: string;
+    caption: string;
+};
+export type CreatePostResult = PostData & {
+    url: string;
+};
 export declare class Instagram {
     readonly baseUrl = "https://www.instagram.com";
     private readonly browser;
@@ -40,7 +50,8 @@ export declare class Instagram {
     private readonly htmlContentOnError;
     readonly config: Config;
     readonly defaultTimeout: number;
-    constructor({ browser, logLevel, screenshotOnError, htmlContentOnError, config, defaultTimeout: optionsDefaultTimeout, }: InstagramOptions);
+    readonly languageParam?: Language;
+    constructor({ browser, logLevel, screenshotOnError, htmlContentOnError, config, defaultTimeout: optionsDefaultTimeout, languageParam, }: InstagramOptions);
     static create(options: CreateInstagramOptions): Promise<Instagram>;
     close(): Promise<void>;
     private initalizePage;
@@ -48,6 +59,6 @@ export declare class Instagram {
     needsLogin(): Promise<boolean>;
     logIn({ username, password }: LogInOptions): Promise<void>;
     ensureLoggedIn({ username, password }: LogInOptions): Promise<void>;
-    createPost({ caption, filePaths }: CreatePostOptions): Promise<PostData>;
-    createReel({ caption, filePaths }: CreatePostOptions): Promise<PostData>;
+    createPost({ caption, filePaths }: CreatePostOptions): Promise<CreatePostResult>;
+    createReel({ caption, filePath }: CreateReelOptions): Promise<CreatePostResult>;
 }

package/dist/instagram.js

@@ -5,19 +5,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Instagram = exports.defaultTimeout = void 0;
 const puppeteer_extra_plugin_stealth_1 = __importDefault(require("puppeteer-extra-plugin-stealth"));
-const puppeteer_extra_1 = __importDefault(require("puppeteer-extra"));
+const puppeteer_extra_1 = require("puppeteer-extra");
 const node_path_1 = __importDefault(require("node:path"));
 const node_fs_1 = __importDefault(require("node:fs"));
 const create_post_1 = require("./actions/create-post");
 const login_1 = require("./actions/login");
 const create_reel_1 = require("./actions/create-reel");
+const utils_1 = require("./utils");
 const needs_login_action_1 = require("./actions/needs-login.action");
 const logger_helper_1 = require("./helpers/logger.helper");
 const delay_action_1 = require("./actions/delay.action");
-puppeteer_extra_1.default.use((0, puppeteer_extra_plugin_stealth_1.default)());
 exports.defaultTimeout = 10000;
 class Instagram {
-    constructor({ browser, logLevel, screenshotOnError, htmlContentOnError, config, defaultTimeout: optionsDefaultTimeout, }) {
+    constructor({ browser, logLevel, screenshotOnError, htmlContentOnError, config, defaultTimeout: optionsDefaultTimeout, languageParam, }) {
         this.baseUrl = "https://www.instagram.com";
         this.browser = browser;
         this.logLevel = logLevel;
@@ -26,10 +26,13 @@ class Instagram {
         this.htmlContentOnError = htmlContentOnError;
         this.config = config;
         this.defaultTimeout = optionsDefaultTimeout !== null && optionsDefaultTimeout !== void 0 ? optionsDefaultTimeout : exports.defaultTimeout;
+        this.languageParam = languageParam;
     }
     static async create(options) {
         var _a, _b, _c, _d;
-        const browser = await puppeteer_extra_1.default.launch({
+        const puppeteer = new puppeteer_extra_1.PuppeteerExtra(...(0, utils_1.requireVanillaPuppeteer)());
+        puppeteer.use((0, puppeteer_extra_plugin_stealth_1.default)());
+        const browser = await puppeteer.launch({
             headless: options.puppeteer.headless,
             executablePath: options.puppeteer.executablePath,
             userDataDir: options.puppeteer.userDataDir,
@@ -51,6 +54,7 @@ class Instagram {
             htmlContentOnError: (_d = options.htmlContentOnError) !== null && _d !== void 0 ? _d : true,
             config: options.config,
             defaultTimeout: options.defaultTimeout,
+            languageParam: options.languageParam,
         });
     }
     async close() {
@@ -65,7 +69,9 @@ class Instagram {
             width: 1920,
             height: 919,
         });
-        await page.goto(this.baseUrl, { waitUntil: "domcontentloaded" });
+        await page.goto(`${this.baseUrl}${this.languageParam ? `?hl=${this.languageParam}` : ""}`, {
+            waitUntil: "domcontentloaded",
+        });
         this.logger.debug("Page initalized");
         return page;
     }
@@ -154,15 +160,18 @@ class Instagram {
             create_post_1.waitForPostConfigureAction,
         ]);
         this.logger.debug("Post created");
-        return result;
+        return {
+            ...result,
+            url: (0, utils_1.createPostUrl)(result.code),
+        };
     }
-    async createReel({ caption, filePaths }) {
+    async createReel({ caption, filePath }) {
         this.logger.info("Creating reel");
         const result = await this.executeWithDiagnostics([
             (0, delay_action_1.delayAction)(1500),
             create_post_1.clickOnCreateButtonAction,
             create_post_1.clickOnPostButtonAction,
-            (0, create_post_1.selectFilesAction)(filePaths),
+            (0, create_post_1.selectFilesAction)([filePath]),
             create_reel_1.tryCloseReelInfoAction,
             create_reel_1.selectRatioAction,
             create_post_1.clickOnNextButtonAction,
@@ -172,7 +181,10 @@ class Instagram {
             create_reel_1.waitForReelConfigureAction,
         ]);
         this.logger.debug("Reel created");
-        return result;
+        return {
+            ...result,
+            url: (0, utils_1.createReelUrl)(result.code),
+        };
     }
 }
 exports.Instagram = Instagram;

package/dist/utils/create-post-url.util.d.ts

@@ -0,0 +1 @@
+export declare function createPostUrl(code: string): string;

package/dist/utils/create-post-url.util.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPostUrl = createPostUrl;
+function createPostUrl(code) {
+    return `https://www.instagram.com/p/${code}`;
+}

package/dist/utils/create-reel-url.util.d.ts

@@ -0,0 +1 @@
+export declare function createReelUrl(code: string): string;

package/dist/utils/create-reel-url.util.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReelUrl = createReelUrl;
+function createReelUrl(code) {
+    return `https://www.instagram.com/reel/${code}`;
+}

package/dist/utils/index.d.ts

@@ -1 +1,5 @@
 export * from "./evaluated-click.util";
+export * from "./create-post-url.util";
+export * from "./create-reel-url.util";
+export * from "./delay.util";
+export * from "./require-vanilla-puppeteer";

package/dist/utils/index.js

@@ -15,3 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./evaluated-click.util"), exports);
+__exportStar(require("./create-post-url.util"), exports);
+__exportStar(require("./create-reel-url.util"), exports);
+__exportStar(require("./delay.util"), exports);
+__exportStar(require("./require-vanilla-puppeteer"), exports);

package/dist/utils/require-vanilla-puppeteer.d.ts

@@ -0,0 +1 @@
+export declare function requireVanillaPuppeteer(): any[];

package/dist/utils/require-vanilla-puppeteer.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireVanillaPuppeteer = requireVanillaPuppeteer;
+function requireVanillaPuppeteer() {
+    try {
+        return [require("puppeteer"), undefined];
+    }
+    catch (_) { }
+    try {
+        return [require("puppeteer-core"), undefined];
+    }
+    catch (err) {
+        return [undefined, err];
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pupgram",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "commonjs",
   "main": "./dist/index.js",
   "module": "./dist/index.js",