gologin-commonjs 2.1.1

package/babel.config.json

@@ -0,0 +1,17 @@
+{
+  "plugins": [
+    [
+      "@babel/plugin-transform-modules-commonjs",
+      {
+        "importInterop": "babel"
+      }
+    ],
+    [
+      "babel-plugin-transform-import-meta"
+    ]
+  ],
+  "ignore": [
+    "node_modules",
+    "dist"
+  ]
+}

package/dist/README.md

@@ -0,0 +1,163 @@
+# class GoLogin - class for working with <a href="https://gologin.com" target="_blank">gologin.com</a> API
+# Official Package
+
+## Getting Started
+
+GoLogin supports Linux, MacOS and Windows platforms.
+
+### Installation
+
+`npm i gologin`
+
+for running example.js install puppeteer-core
+
+`npm i puppeteer-core`
+
+### Usage
+
+Where is token? API token is <a href="https://app.gologin.com/#/personalArea/TokenApi" target="_blank">here</a>.
+To have an access to the page below you need <a href="https://app.gologin.com/#/createUser" target="_blank">register</a> GoLogin account.
+
+![Token API in Settings](https://user-images.githubusercontent.com/12957968/146891933-c3b60b4d-c850-47a5-8adf-bc8c37372664.gif)
+
+### Example
+
+```js
+import puppeteer from 'puppeteer-core';
+
+import GoLogin from '../src/gologin.js';
+
+const { connect } = puppeteer;
+
+(async () => {
+  const GL = new GoLogin({
+    token: 'yU0token',
+    profile_id: 'yU0Pr0f1leiD',
+  });
+
+  const { status, wsUrl } = await GL.start().catch((e) => {
+    console.trace(e);
+
+    return { status: 'failure' };
+  });
+
+  if (status !== 'success') {
+    console.log('Invalid status');
+
+    return;
+  }
+
+  const browser = await connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true,
+  });
+
+  const page = await browser.newPage();
+  await page.goto('https://myip.link/mini');
+  console.log(await page.content());
+  await browser.close();
+  await GL.stop();
+})();
+```
+
+### Running example:
+
+`DEBUG=gologin* node example.js`
+
+###
+### Methods
+#### constructor
+
+- `options` <[Object]> Options for profile
+    - `autoUpdateBrowser` <[boolean]> do not ask whether download new browser version (default false)
+    - `token` <[string]> your API <a href="https://gologin.com/#/personalArea/TokenApi" target="_blank">token</a>
+    - `profile_id` <[string]> profile ID
+    - `executablePath` <[string]> path to executable Orbita file. Orbita will be downloaded automatically if not specified.
+    - `remote_debugging_port` <[int]> port for remote debugging
+    - `vncPort` <[integer]> port of VNC server if you using it
+    - `tmpdir` <[string]> path to temporary directore for saving profiles
+    - `extra_params` arrayof <[string]> extra params for browser orbita (ex. extentions etc.)
+    - `uploadCookiesToServer` <[boolean]> upload cookies to server after profile stopping (default false)
+    - `writeCookesFromServer` <[boolean]> download cookies from server and write to profile cookies file (default true)
+    - `skipOrbitaHashChecking` <[boolean]> skip hash checking for Orbita after downloading process (default false)
+
+```js
+import GoLogin from '../src/gologin.js';
+const GL = new GoLogin({
+    token: 'yU0token',
+    profile_id: 'yU0Pr0f1leiD',
+});
+```
+
+#### start()  
+
+- returns: <[object]> { status, wsUrl } 
+
+start browser with profile id, returning WebSocket url for puppeteer
+
+#### stop()  
+
+stop browser with profile id
+
+### DEBUG
+
+For debugging use `DEBUG=* node example.js` command
+
+### Selenium
+
+To use GoLogin with Selenium see  `selenium/example.js`
+
+## Full GoLogin API
+**Swagger:** <a href="https://api.gologin.com/docs" target="_blank">link here</a>
+
+**Postman:** <a href="https://documenter.getpostman.com/view/21126834/Uz5GnvaL" target="_blank">link here</a>
+
+
+## For local profiles
+
+#### startLocal()  
+
+- returns: string 
+
+start browser with profile id, return WebSocket url for puppeteer. Extracted profile folder should be in specified temp directory.
+
+#### stopLocal()  
+
+stop current browser without removing archived profile 
+
+### example-local-profile.js
+
+```js
+import puppeteer from 'puppeteer-core';
+
+import GoLogin from '../src/gologin.js';
+
+const { connect } = puppeteer;
+
+(async () => {
+  const GL = new GoLogin({
+    token: 'yU0token',
+    profile_id: 'yU0Pr0f1leiD',
+    executablePath: '/usr/bin/orbita-browser/chrome',
+    tmpdir: '/my/tmp/dir',
+  });
+
+  const wsUrl = await GL.startLocal();
+  const browser = await connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true,
+  });
+
+  const page = await browser.newPage();
+  await page.goto('https://myip.link');
+  console.log(await page.content());
+  await browser.close();
+  await GL.stopLocal({ posting: false });
+})();
+```
+
+## Python support
+
+<a href="https://github.com/pyppeteer/pyppeteer" target="_blank">pyppeteer</a> (recommend) and <a href="https://www.selenium.dev" target="_blank">Selenium</a> supported (see file gologin.py)
+
+for Selenium may need download <a href="https://chromedriver.chromium.org/downloads" target="_blank">webdriver</a>

package/dist/example.js

@@ -0,0 +1,35 @@
+"use strict";
+
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+var _gologin = _interopRequireDefault(require("./src/gologin.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const token = 'yU0token';
+const profile_id = 'yU0Pr0f1leiD';
+(async () => {
+  const GL = new _gologin.default({
+    token,
+    profile_id
+  });
+  const {
+    status,
+    wsUrl
+  } = await GL.start().catch(e => {
+    console.trace(e);
+    return {
+      status: 'failure'
+    };
+  });
+  if (status !== 'success') {
+    console.log('Invalid status');
+    return;
+  }
+  const browser = await _puppeteerCore.default.connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  await page.goto('https://myip.link/mini');
+  console.log(await page.content());
+  await browser.close();
+  await GL.stop();
+})();

package/dist/examples/example-amazon-cloud-browser.js

@@ -0,0 +1,52 @@
+"use strict";
+
+var _gologin = _interopRequireDefault(require("gologin"));
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Usage example: in the terminal enter
+// node example-amazon-cloud-browser.js yU0token yU0Pr0f1leiD
+
+// your token api (located in the settings, api)
+// https://github.com/gologinapp/gologin#usage
+
+const [_execPath, _filePath, GOLOGIN_API_TOKEN, GOLOGIN_PROFILE_ID] = process.argv;
+(async () => {
+  const GL = new _gologin.default({
+    token: GOLOGIN_API_TOKEN,
+    profile_id: GOLOGIN_PROFILE_ID
+  });
+  const {
+    _status,
+    wsUrl
+  } = await GL.startRemote();
+  const browser = await _puppeteerCore.default.connect({
+    browserWSEndpoint: wsUrl,
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  const viewPort = GL.getViewPort();
+  await page.setViewport({
+    width: Math.round(viewPort.width * 0.994),
+    height: Math.round(viewPort.height * 0.92)
+  });
+  const session = await page.target().createCDPSession();
+  const {
+    windowId
+  } = await session.send('Browser.getWindowForTarget');
+  await session.send('Browser.setWindowBounds', {
+    windowId,
+    bounds: viewPort
+  });
+  await session.detach();
+  await page.goto('https://www.amazon.com/-/dp/B0771V1JZX');
+  const content = await page.content();
+  const matchData = content.match(/'initial': (.*)}/);
+  if (matchData === null || matchData.length === 0) {
+    console.log('no images found');
+  } else {
+    const data = JSON.parse(matchData[1]);
+    const images = data.map(e => e.hiRes);
+    console.log('images=', images);
+  }
+  await GL.stopRemote();
+})();

package/dist/examples/example-amazon-headless.js

@@ -0,0 +1,56 @@
+"use strict";
+
+var _gologin = _interopRequireDefault(require("gologin"));
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Usage example: in the terminal enter
+// node example-amazon-headless.js yU0token yU0Pr0f1leiD
+
+// your token api (located in the settings, api)
+// https://github.com/gologinapp/gologin#usage
+
+const [_execPath, _filePath, GOLOGIN_API_TOKEN, GOLOGIN_PROFILE_ID] = process.argv;
+const delay = time => new Promise(resolve => setTimeout(resolve, time));
+(async () => {
+  const GL = new _gologin.default({
+    token: GOLOGIN_API_TOKEN,
+    profile_id: GOLOGIN_PROFILE_ID,
+    extra_params: ['--headless', '--no-sandbox']
+  });
+  const {
+    _status,
+    wsUrl
+  } = await GL.start();
+  const browser = await _puppeteerCore.default.connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  await delay(300);
+  const viewPort = GL.getViewPort();
+  await page.setViewport({
+    width: Math.round(viewPort.width * 0.994),
+    height: Math.round(viewPort.height * 0.92)
+  });
+  const session = await page.target().createCDPSession();
+  const {
+    windowId
+  } = await session.send('Browser.getWindowForTarget');
+  await session.send('Browser.setWindowBounds', {
+    windowId,
+    bounds: viewPort
+  });
+  await session.detach();
+  await page.goto('https://www.amazon.com/-/dp/B0771V1JZX');
+  const content = await page.content();
+  const matchData = content.match(/'initial': (.*)}/);
+  if (matchData === null || matchData.length === 0) {
+    console.log('no images found');
+  } else {
+    const data = JSON.parse(matchData[1]);
+    const images = data.map(e => e.hiRes);
+    console.log('images=', images);
+  }
+  await browser.close();
+  await GL.stop();
+})();

package/dist/examples/example-amazon.js

@@ -0,0 +1,53 @@
+"use strict";
+
+var _gologin = _interopRequireDefault(require("gologin"));
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Usage example: in the terminal enter
+// node example-amazon.js yU0token yU0Pr0f1leiD
+
+// your token api (located in the settings, api)
+// https://github.com/gologinapp/gologin#usage
+
+const [_execPath, _filePath, GOLOGIN_API_TOKEN, GOLOGIN_PROFILE_ID] = process.argv;
+(async () => {
+  const GL = new _gologin.default({
+    token: GOLOGIN_API_TOKEN,
+    profile_id: GOLOGIN_PROFILE_ID
+  });
+  const {
+    _status,
+    wsUrl
+  } = await GL.start();
+  const browser = await _puppeteerCore.default.connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  const viewPort = GL.getViewPort();
+  await page.setViewport({
+    width: Math.round(viewPort.width * 0.994),
+    height: Math.round(viewPort.height * 0.92)
+  });
+  const session = await page.target().createCDPSession();
+  const {
+    windowId
+  } = await session.send('Browser.getWindowForTarget');
+  await session.send('Browser.setWindowBounds', {
+    windowId,
+    bounds: viewPort
+  });
+  await session.detach();
+  await page.goto('https://www.amazon.com/-/dp/B0771V1JZX');
+  const content = await page.content();
+  const matchData = content.match(/'initial': (.*)}/);
+  if (matchData == null || matchData.length == 0) {
+    console.log('no images found');
+  } else {
+    const data = JSON.parse(matchData[1]);
+    const images = data.map(e => e.hiRes);
+    console.log('images=', images);
+  }
+  await browser.close();
+  await GL.stop();
+})();

package/dist/examples/example-create-custom-profile.js

@@ -0,0 +1,42 @@
+"use strict";
+
+var _gologin = _interopRequireDefault(require("gologin"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Usage example: in the terminal enter
+// node example-create-custom-profile.js yU0token
+
+// your token api (located in the settings, api)
+// https://github.com/gologinapp/gologin#usage
+
+const [_execPath, _filePath, GOLOGIN_API_TOKEN] = process.argv;
+(async () => {
+  const GL = new _gologin.default({
+    token: GOLOGIN_API_TOKEN
+  });
+  const profileId = await GL.createCustom({
+    os: 'win',
+    // required param ('lin', 'mac', 'win', 'android'), for macM1 write (os: 'mac') and add property 'isM1'
+    // isM1: true,
+    name: 'testName',
+    fingerprint: {
+      autoLang: true,
+      resolution: '800x400',
+      language: 'de',
+      dns: 'testDNS',
+      hardwareConcurrency: 8,
+      deviceMemory: 4,
+      // 0.5, 1, 2, 4, 6, 8
+      startUrl: 'https://testurl.com',
+      googleServicesEnabled: true,
+      lockEnabled: true
+      // proxy: {  // uncomment and check input if you need to use proxy
+      //   mode: 'http', // 'socks4', 'socks5'
+      //   host: '123.12.123.12',
+      //   port: 1234,
+      //   username: 'user',
+      //   password: 'password',
+      // },
+    }
+  });
+  console.log('profile id=', profileId);
+})();

package/dist/examples/example-create-profile.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _gologin = _interopRequireDefault(require("gologin"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Usage example: in the terminal enter
+// node example-create-profile.js yU0token
+
+// your token api (located in the settings, api)
+// https://github.com/gologinapp/gologin#usage
+
+const [_execPath, _filePath, GOLOGIN_API_TOKEN] = process.argv;
+(async () => {
+  const GL = new _gologin.default({
+    token: GOLOGIN_API_TOKEN
+  });
+
+  // the following parameters are required for profile creation
+  const profile_id = await GL.create({
+    name: 'profile_mac',
+    os: 'mac',
+    // 'win', 'lin', 'android'
+    // isM1: true, // for Mac M1
+    navigator: {
+      language: 'en-US,en;q=0.9',
+      userAgent: 'random',
+      // get random user agent for selected os
+      resolution: '1024x768'
+    },
+    proxyEnabled: false,
+    proxy: {
+      mode: 'none'
+    }
+  });
+  console.log('profile id=', profile_id);
+  await GL.update({
+    id: profile_id,
+    name: 'profile_mac2'
+  });
+  const profile = await GL.getProfile(profile_id);
+  console.log('new profile name=', profile.name);
+
+  // await GL.delete(profile_id);
+})();

package/dist/examples/example-custom-args.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+var _gologin = _interopRequireDefault(require("../src/gologin.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+(async () => {
+  const GL = new _gologin.default({
+    profile_id: 'yU0Pr0f1leiD',
+    token: 'yU0token',
+    args: ['--disable-background-timer-throttling', '--disable-backgrounding-occluded-windows', '--disable-renderer-backgrounding']
+  });
+  const {
+    status,
+    wsUrl
+  } = await GL.start().catch(e => {
+    console.trace(e);
+    return {
+      status: 'failure'
+    };
+  });
+  if (status !== 'success') {
+    console.log('Invalid status');
+    return;
+  }
+  const browser = await _puppeteerCore.default.connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  await page.goto('https://myip.link/mini');
+  console.log(await page.content());
+  await browser.close();
+  await GL.stop();
+})();

package/dist/examples/example-fast-profile-settings.js

@@ -0,0 +1,59 @@
+"use strict";
+
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+var _browserApi = require("../src/browser/browser-api.js");
+var _gologin = _interopRequireDefault(require("../src/gologin.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const token = 'yU0token';
+const profile_id = 'yU0Pr0f1leiD';
+(async () => {
+  const GL = new _gologin.default({
+    token,
+    profile_id
+  });
+  const {
+    status,
+    wsUrl
+  } = await GL.start().catch(e => {
+    console.trace(e);
+    return {
+      status: 'failure'
+    };
+  });
+  if (status !== 'success') {
+    console.log('Invalid status');
+    return;
+  }
+  const browser = await _puppeteerCore.default.connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  await page.goto('https://myip.link/mini');
+  console.log(await page.content());
+
+  /**
+   * @see updateProfileProxy
+   */
+  const proxyData = {
+    mode: 'none'
+  };
+  await GL.changeProfileProxy(proxyData);
+  await GL.changeProfileResolution('1920x1080');
+  const userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.5359.71 Safari/537.36';
+  await GL.changeProfileUserAgent(userAgent);
+  await browser.close();
+  await GL.stop();
+})();
+(async () => {
+  /**
+   * @see updateProfileProxy
+   */
+  const proxyData = {
+    mode: 'none'
+  };
+  await (0, _browserApi.updateProfileProxy)(profile_id, token, proxyData);
+  await (0, _browserApi.updateProfileResolution)(profile_id, token, '1920x1080');
+  const userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.5359.71 Safari/537.36';
+  await (0, _browserApi.updateProfileUserAgent)(profile_id, token, userAgent);
+})();

package/dist/examples/example-gmail.js

@@ -0,0 +1,82 @@
+"use strict";
+
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+var _gologin = _interopRequireDefault(require("../src/gologin.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const {
+  connect
+} = _puppeteerCore.default;
+const delay = ms => new Promise(res => setTimeout(res, ms));
+(async () => {
+  const GL = new _gologin.default({
+    token: 'yU0token'
+  });
+  const profile_id = await GL.create({
+    name: 'profile_gmail',
+    os: 'lin',
+    navigator: {
+      userAgent: 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.85 Safari/537.36',
+      resolution: '1280x720',
+      language: 'en-GB,en-US;q=0.9,en;q=0.8',
+      platform: 'Linux x86_64',
+      hardwareConcurrency: 8,
+      deviceMemory: 8,
+      maxTouchPoints: 5
+    },
+    proxy: {
+      mode: 'http',
+      host: 'proxy_host',
+      port: 'proxy_port',
+      username: 'proxy_username',
+      password: 'proxy_password'
+    }
+  });
+  console.log('profile id=', profile_id);
+  GL.setProfileId(profile_id);
+  const {
+    status,
+    wsUrl
+  } = await GL.start();
+  const browser = await connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  const viewPort = GL.getViewPort();
+  await page.setViewport({
+    width: Math.round(viewPort.width * 0.994),
+    height: Math.round(viewPort.height * 0.92)
+  });
+  const session = await page.target().createCDPSession();
+  const {
+    windowId
+  } = await session.send('Browser.getWindowForTarget');
+  await session.send('Browser.setWindowBounds', {
+    windowId,
+    bounds: viewPort
+  });
+  await session.detach();
+  await page.goto('https://gmail.com');
+  await delay(1000);
+  await page.goto('https://accounts.google.com/signup/v2?service=mail&continue=https%3A%2F%2Fmail.google.com%2Fmail%2F&flowName=GlifWebSignIn&flowEntry=SignUp');
+  await delay(3000);
+  await page.type('#firstName', 'first_name', {
+    delay: 100
+  });
+  await page.type('#lastName', 'last_name', {
+    delay: 100
+  });
+  await page.type('#username', 'username', {
+    delay: 100
+  });
+  await page.type('[name=Passwd]', 'pa$$w0rd', {
+    delay: 100
+  });
+  await page.type('[name=ConfirmPasswd]', 'pa$$w0rd', {
+    delay: 100
+  });
+  await page.click('#accountDetailsNext > div > button');
+  await delay(60000);
+  await browser.close();
+  await GL.stop();
+})();

package/dist/examples/example-iphey.js

@@ -0,0 +1,19 @@
+"use strict";
+
+var _gologinApi = require("../src/gologin-api.js");
+const token = process.env.GOLOGIN_API_TOKEN; // get token https://app.gologin.com/personalArea/TokenApi
+const gologin = (0, _gologinApi.GologinApi)({
+  token
+});
+async function main() {
+  const {
+    browser
+  } = await gologin.launch();
+  const page = await browser.newPage();
+  await page.goto('https://iphey.com/', {
+    waitUntil: 'networkidle2'
+  });
+  const status = await page.$eval('.trustworthy-status:not(.hide)', elt => elt?.innerText?.trim());
+  return status; // Expecting 'Trustworthy'
+}
+main().catch(console.error).then(console.info).finally(_gologinApi.exitAll);

package/dist/examples/example-local-profile.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _puppeteerCore = _interopRequireDefault(require("puppeteer-core"));
+var _gologin = _interopRequireDefault(require("../src/gologin.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const {
+  connect
+} = _puppeteerCore.default;
+(async () => {
+  const GL = new _gologin.default({
+    token: 'yU0token',
+    profile_id: 'yU0Pr0f1leiD',
+    executablePath: '/usr/bin/orbita-browser/chrome',
+    tmpdir: '/my/tmp/dir'
+  });
+  const wsUrl = await GL.startLocal();
+  const browser = await connect({
+    browserWSEndpoint: wsUrl.toString(),
+    ignoreHTTPSErrors: true
+  });
+  const page = await browser.newPage();
+  await page.goto('https://myip.link');
+  console.log(await page.content());
+  await browser.close();
+  await GL.stopLocal({
+    posting: false
+  });
+})();