gologin 2.2.8 → 3.0.0

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 Combined changelog for GoLogin node.js SDK
 
+## [3.0.0] 2026-06-24
+
+### Features
+
+* Impoved package initialization speed and profile start speed
+* Replaced request npm package with native fetch
+
+
+## [2.2.9] 2026-06-08
+
+### Fixes
+
+* Disabled fonts downloading which was throwing errors
+* Type fixes
+* Added Proxy Error message to socks5 proxies check fails
+* Added (Gologin) prefix where gologin proxies failed
+* Profile start timing optimization
+
 ## [2.2.7] 2026-02-06
 
 ### Fixes

package/api.d.ts

@@ -0,0 +1,105 @@
+import { Browser } from 'puppeteer-core/lib/Browser';
+
+import { CreateCustomBrowserValidation, BrowserProxyCreateValidation } from './types/profile-params';
+
+export declare const OPERATING_SYSTEMS: {
+  readonly win: 'win';
+  readonly lin: 'lin';
+  readonly mac: 'mac';
+  readonly android: 'android';
+};
+export type OsType = (typeof OPERATING_SYSTEMS)[keyof typeof OPERATING_SYSTEMS];
+
+type CloudLaunchParams = {
+  cloud: true;
+  geolocation?: string;
+};
+type LocalLaunchParams = {
+  cloud: false;
+  headless: boolean;
+};
+
+type ExistingProfileLaunchParams = {
+  profileId: string;
+};
+type NewProfileLaunchParams = {
+  proxyGeolocation: string;
+};
+
+type LaunchParams =
+  | CloudLaunchParams
+  | LocalLaunchParams
+  | ExistingProfileLaunchParams
+  | NewProfileLaunchParams
+  | {
+    defaultDelay: number;
+    os: OsType;
+  };
+
+type Cookie = {
+  name: string;
+  value: string;
+  domain: string;
+  path: string;
+  expirationDate?: number;
+  creationDate?: number;
+  hostOnly?: boolean;
+  httpOnly?: boolean;
+  sameSite?: 'no_restriction' | 'lax' | 'strict';
+  secure?: boolean;
+  session?: boolean;
+  url?: string;
+};
+
+type TrafficData = {
+  trafficUsedBytes: number;
+  trafficLimitBytes: number;
+};
+
+type AvailableTrafficData = {
+  mobileTrafficData: TrafficData;
+  residentialTrafficData: TrafficData;
+  dataCenterTrafficData: TrafficData;
+};
+
+type ProxyType = 'mobile' | 'resident' | 'dataCenter';
+
+type ProxyResponse = {
+  trafficLimitBytes: number;
+  trafficUsedBytes: number;
+};
+
+type ProfileResponse = {
+  id: string;
+};
+
+type GologinApiType = {
+  launch: (params?: LaunchParams) => Promise<{ browser: Browser }>;
+  createProfileWithCustomParams: (options: CreateCustomBrowserValidation) => Promise<string>;
+  refreshProfilesFingerprint: (profileIds: string[]) => Promise<Record<string, unknown>>;
+  createProfileRandomFingerprint: (name?: string) => Promise<ProfileResponse>;
+  updateUserAgentToLatestBrowser: (profileIds: string[], workspaceId?: string) => Promise<Record<string, unknown>>;
+  changeProfileProxy: (profileId: string, proxyData: BrowserProxyCreateValidation) => Promise<number>;
+  getAvailableType: (availableTrafficData: AvailableTrafficData) => ProxyType | 'none';
+  addGologinProxyToProfile: (profileId: string, countryCode: string, proxyType?: ProxyType | '') => Promise<ProxyResponse>;
+  addCookiesToProfile: (profileId: string, cookies: Cookie[]) => Promise<number>;
+  deleteProfile: (profileId: string) => Promise<number>;
+  exit: () => Promise<void>;
+  createCustom: (params: CreateCustomBrowserValidation) => Promise<string>;
+  updateProfileFingerprint: (profileId: string[]) => Promise<void>;
+  updateProfileProxy: (profileId: string, proxyData: BrowserProxyCreateValidation) => Promise<void>;
+};
+
+type GologinApiParams = {
+  token: string;
+};
+
+export declare function getDefaultParams(): {
+  token: string | undefined;
+  profile_id: string | undefined;
+  executablePath: string | undefined;
+};
+
+export declare function GologinApi(params: GologinApiParams): GologinApiType;
+
+export declare function exitAll(): Promise<void>;

package/examples/puppeter/cloud-browser.js

@@ -1,17 +1,31 @@
-// Gologin provides a cloud browser that can be used to run puppeteer aytomation.
-// It will handle the browser start and close management - you just need to control the browser with pupputter
-import { GologinApi } from 'gologin';
+// Gologin provides a cloud browser that can be used to run puppeteer automation.
+// It will handle the browser start and close management - you just need to control the browser with puppeteer
+import puppeteer from 'puppeteer-core';
 
 const token = process.env.GL_API_TOKEN || 'your dev token here';
-const gologin = GologinApi({
-  token,
-});
+const profileId = 'profile ID';
+
+const CLOUD_BROWSER_URL = `https://cloudbrowser.gologin.com/connect?token=${token}&profile=${profileId}`;
+const STOP_PROFILE_URL = `https://api.gologin.com/browser/${profileId}/web`;
+
+async function stopProfile() {
+  await fetch(STOP_PROFILE_URL, {
+    method: 'DELETE',
+    headers: { Authorization: `Bearer ${token}` },
+  });
+}
 
 async function main() {
-  const { browser } = await gologin.launch({
-    cloud: true,
-    // pass profileId parameter if you want to run particular profile
-    // profileId: 'your profileId here',
+  const response = await fetch(CLOUD_BROWSER_URL);
+
+  if (!response.ok) {
+    const errorReason = response.headers.get('X-Error-Reason');
+    throw new Error(`Failed to start cloud browser: ${errorReason ?? response.statusText}`);
+  }
+
+  const browser = await puppeteer.connect({
+    browserWSEndpoint: CLOUD_BROWSER_URL,
+    ignoreHTTPSErrors: true,
   });
 
   const page = await browser.newPage();
@@ -21,10 +35,7 @@ async function main() {
     (elt) => elt?.innerText?.trim(),
   );
 
-  console.log('status', status);
-
   return status;
 }
 
-main().catch(console.error)
-  .finally(gologin.exit);
+main().catch(console.error).finally(stopProfile);

package/index.d.ts

@@ -1,105 +1,46 @@
-import { Browser } from 'puppeteer-core/lib/Browser';
-
-import { CreateCustomBrowserValidation, BrowserProxyCreateValidation } from './types/profile-params';
-
-export const OPERATING_SYSTEMS = {
-  win: 'win',
-  lin: 'lin',
-  mac: 'mac',
-  android: 'android',
-} as const;
-export type OsType = (typeof OPERATING_SYSTEMS)[keyof typeof OPERATING_SYSTEMS];
-
-type CloudLaunchParams = {
-  cloud: true;
-  geolocation?: string;
-};
-type LocalLaunchParams = {
-  cloud: false;
-  headless: boolean;
-};
-
-type ExistingProfileLaunchParams = {
-  profileId: string;
-};
-type NewProfileLaunchParams = {
-  proxyGeolocation: string;
-};
-
-type LaunchParams =
-  | CloudLaunchParams
-  | LocalLaunchParams
-  | ExistingProfileLaunchParams
-  | NewProfileLaunchParams
-  | {
-    defaultDelay: number;
-    os: OsType;
-  };
-
-type Cookie = {
-  name: string;
-  value: string;
-  domain: string;
-  path: string;
-  expirationDate?: number;
-  creationDate?: number;
-  hostOnly?: boolean;
-  httpOnly?: boolean;
-  sameSite?: 'no_restriction' | 'lax' | 'strict';
-  secure?: boolean;
-  session?: boolean;
-  url?: string;
-};
-
-type TrafficData = {
-  trafficUsedBytes: number;
-  trafficLimitBytes: number;
-};
-
-type AvailableTrafficData = {
-  mobileTrafficData: TrafficData;
-  residentialTrafficData: TrafficData;
-  dataCenterTrafficData: TrafficData;
-};
-
-type ProxyType = 'mobile' | 'resident' | 'dataCenter';
-
-type ProxyResponse = {
-  trafficLimitBytes: number;
-  trafficUsedBytes: number;
-};
-
-type ProfileResponse = {
-  id: string;
-};
-
-type GologinApiType = {
-  launch: (params?: LaunchParams) => Promise<{ browser: Browser }>;
-  createProfileWithCustomParams: (options: CreateCustomBrowserValidation) => Promise<string>;
-  refreshProfilesFingerprint: (profileIds: string[]) => Promise<any>;
-  createProfileRandomFingerprint: (name?: string) => Promise<ProfileResponse>;
-  updateUserAgentToLatestBrowser: (profileIds: string[], workspaceId?: string) => Promise<any>;
-  changeProfileProxy: (profileId: string, proxyData: BrowserProxyCreateValidation) => Promise<number>;
-  getAvailableType: (availableTrafficData: AvailableTrafficData) => ProxyType | 'none';
-  addGologinProxyToProfile: (profileId: string, countryCode: string, proxyType?: ProxyType | '') => Promise<ProxyResponse>;
-  addCookiesToProfile: (profileId: string, cookies: Cookie[]) => Promise<number>;
-  deleteProfile: (profileId: string) => Promise<number>;
-  exit: () => Promise<void>;
-  createCustom: (params: CreateCustomBrowserValidation) => Promise<string>;
-  updateProfileFingerprint: (profileId: string[]) => Promise<void>;
-  updateProfileProxy: (profileId: string, proxyData: BrowserProxyCreateValidation) => Promise<void>;
-};
-
-type GologinApiParams = {
-  token: string;
-};
-
-export declare function getDefaultParams(): {
-  token: string | undefined;
-  profile_id: string | undefined;
-  executablePath: string | undefined;
-};
-
-export declare function GologinApi(params: GologinApiParams): GologinApiType;
-
-export declare function exitAll(): Promise<void>;
+export type GoLoginOptions = {
+  token?: string;
+  profile_id?: string;
+  password?: string;
+  extra_params?: string[];
+  executablePath?: string;
+  vncPort?: number;
+  tmpdir?: string;
+  waitWebsocket?: boolean;
+  isCloudHeadless?: boolean;
+  skipOrbitaHashChecking?: boolean;
+  uploadCookiesToServer?: boolean;
+  writeCookiesFromServer?: boolean;
+  remote_debugging_port?: number;
+  timezone?: { timezone: string; country?: string; city?: string; ip?: string; ll?: [number, number]; accuracy?: number, stateProv?: string, languages?: string };
+  args?: string[];
+  restoreLastSession?: boolean;
+  browserMajorVersion?: number;
+  proxyCheckTimeout?: number;
+  proxyCheckAttempts?: number;
+  autoUpdateBrowser?: boolean;
+  checkBrowserUpdate?: boolean;
+};
+
+export type GoLoginStartResult = {
+  status: 'success';
+  wsUrl: string;
+  resolution?: { width: number; height: number };
+};
+
+export { GologinApi, getDefaultParams, exitAll } from './api.d.ts';
+
+export declare class GoLogin {
+  constructor(options?: GoLoginOptions);
+  start(): Promise<GoLoginStartResult>;
+  stop(): Promise<void>;
+  startLocal(): Promise<{ status: string, wsUrl: string }>;
+  stopLocal(options?: { posting?: boolean }): Promise<void>;
+  setProfileId(profile_id: string): Promise<void>;
+  getProfile(profile_id?: string): Promise<Record<string, unknown>>;
+  quickCreateProfile(name?: string): Promise<{ id: string }>;
+  profilePath(): string;
+  commitProfile(): Promise<void>;
+}
+
+export default GoLogin;

package/package.json

@@ -1,9 +1,19 @@
 {
   "name": "gologin",
-  "version": "2.2.8",
+  "version": "3.0.0",
   "description": "A high-level API to control Orbita browser over GoLogin API",
   "types": "./index.d.ts",
-  "main": "./src/gologin.js",
+  "main": "./src/index.js",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./src/index.js"
+    },
+    "./api": {
+      "types": "./api.d.ts",
+      "import": "./src/gologin-api.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gologinapp/gologin.git"
@@ -14,6 +24,9 @@
   "type": "module",
   "author": "The GoLogin Authors",
   "license": "GPL-3.0",
+  "overrides": {
+    "https-proxy-agent": "$https-proxy-agent"
+  },
   "dependencies": {
     "@sentry/node": "^9.24.0",
     "adm-zip": "^0.5.1",
@@ -22,10 +35,9 @@
     "decompress": "^4.2.1",
     "decompress-unzip": "^4.0.1",
     "form-data": "^3.0.0",
+    "https-proxy-agent": "^7.0.6",
     "progress": "^2.0.3",
     "puppeteer-core": "^2.1.1",
-    "request": "^2.88.2",
-    "requestretry": "^4.1.0",
     "rimraf": "^3.0.2",
     "socks-proxy-agent": "^8.0.3",
     "sqlite": "^4.0.23",

package/src/browser/browser-checker.js

@@ -1,6 +1,4 @@
 import { exec as execNonPromise } from 'child_process';
-import decompress from 'decompress';
-import decompressUnzip from 'decompress-unzip';
 import { createWriteStream, promises as _promises } from 'fs';
 import { get } from 'https';
 import { homedir } from 'os';
@@ -10,6 +8,7 @@ import util from 'util';
 
 import { API_URL, getOS } from '../utils/common.js';
 import { makeRequest } from '../utils/http.js';
+import { loadDecompress } from '../utils/lazy-deps.js';
 import BrowserDownloadLockManager from './browser-download-manager.js';
 
 const exec = util.promisify(execNonPromise);
@@ -202,6 +201,8 @@ export class BrowserChecker {
     console.log('Extracting Orbita');
     await mkdir(join(this.browserPath, EXTRACTED_FOLDER), { recursive: true });
     if (PLATFORM === 'win32') {
+      const { decompress, decompressUnzip } = await loadDecompress();
+
       return decompress(join(this.browserPath, BROWSER_ARCHIVE_NAME), join(this.browserPath, EXTRACTED_FOLDER),
         {
           plugins: [decompressUnzip()],

package/src/browser/browser-user-data-manager.js

@@ -1,24 +1,13 @@
 import { createHash } from 'crypto';
-import { createWriteStream, promises as _promises, rmdirSync } from 'fs';
-import { homedir, tmpdir } from 'os';
-import { dirname, join, resolve, sep } from 'path';
-import { fileURLToPath } from 'url';
+import { promises as _promises } from 'fs';
+import { tmpdir } from 'os';
+import { join, sep } from 'path';
 
-import { fontsCollection } from '../../fonts.js';
 import { FALLBACK_API_URL } from '../utils/common.js';
 import { makeRequest } from '../utils/http.js';
 
-const { access, readFile, writeFile, mkdir, readdir, copyFile, rename } = _promises;
+const { readFile, readdir, rename } = _promises;
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-const FONTS_URL = 'https://fonts.gologin.com/';
-const FONTS_DIR_NAME = 'fonts';
-
-const HOMEDIR = homedir();
-const BROWSER_PATH = join(HOMEDIR, '.gologin', 'browser');
-const OS_PLATFORM = process.platform;
 const DEFAULT_ORBITA_EXTENSIONS_NAMES = ['Google Hangouts', 'Chromium PDF Viewer', 'CryptoTokenExtension', 'Web Store'];
 const GOLOGIN_BASE_FOLDER_NAME = '.gologin';
 const GOLOGIN_TEST_FOLDER_NAME = '.gologin_test';
@@ -56,80 +45,6 @@ export const uploadCookies = ({ cookies = [], profileId, ACCESS_TOKEN, API_BASE_
     return e;
   });
 
-export const downloadFonts = async (fontsList = [], profilePath) => {
-  if (!fontsList.length) {
-    return;
-  }
-
-  const browserFontsPath = join(BROWSER_PATH, FONTS_DIR_NAME);
-  await mkdir(browserFontsPath, { recursive: true });
-
-  const files = await readdir(browserFontsPath);
-  const fontsToDownload = fontsList.filter(font => !files.includes(font));
-
-  let promises = fontsToDownload.map(async font => {
-    const body = await makeRequest(FONTS_URL + font, {
-      maxAttempts: 5,
-      retryDelay: 2000,
-      timeout: 30 * 1000,
-    });
-
-    await writeFile(join(browserFontsPath, font), body);
-  });
-
-  if (promises.length) {
-    await Promise.all(promises);
-  }
-
-  promises = fontsList.map((font) =>
-    copyFile(join(browserFontsPath, font), join(profilePath, FONTS_DIR_NAME, font)));
-
-  await Promise.all(promises);
-};
-
-export const composeFonts = async (fontsList = [], profilePath, differentOs = false) => {
-  if (!(fontsList.length && profilePath)) {
-    return;
-  }
-
-  const fontsToDownload = fontsCollection
-    .filter(elem => fontsList.includes(elem.value))
-    .reduce((res, elem) => res.concat(elem.fileNames || []), []);
-
-  if (differentOs && !fontsToDownload.length) {
-    throw new Error('No fonts to download found. Use getAvailableFonts() method and set some fonts from this list');
-  }
-
-  fontsToDownload.push('LICENSE.txt');
-  fontsToDownload.push('OFL.txt');
-
-  const pathToFontsDir = join(profilePath, FONTS_DIR_NAME);
-  const fontsDirExists = await access(pathToFontsDir).then(() => true, () => false);
-  if (fontsDirExists) {
-    rmdirSync(pathToFontsDir, { recursive: true });
-  }
-
-  await mkdir(pathToFontsDir, { recursive: true });
-  await downloadFonts(fontsToDownload, profilePath);
-
-  if (OS_PLATFORM === 'linux') {
-    await copyFontsConfigFile(profilePath);
-  }
-};
-
-export const copyFontsConfigFile = async (profilePath) => {
-  if (!profilePath) {
-    return;
-  }
-
-  const fileContent = await readFile(resolve(__dirname, '..', '..', 'fonts_config'), 'utf-8');
-  const result = fileContent.replace(/\$\$GOLOGIN_FONTS\$\$/g, join(profilePath, FONTS_DIR_NAME));
-
-  const defaultFolderPath = join(profilePath, 'Default');
-  await mkdir(defaultFolderPath, { recursive: true });
-  await writeFile(join(defaultFolderPath, 'fonts_config'), result);
-};
-
 export const setExtPathsAndRemoveDeleted = (settings = {}, profileExtensionsCheckRes = [], profileId = '') => {
   const formattedLocalExtArray = profileExtensionsCheckRes.map((el) => {
     const [extFolderName = ''] = el.split(sep).reverse();

package/src/cookies/cookies-manager.js

@@ -1,12 +1,9 @@
 import { promises as fsPromises } from 'fs';
 import { join } from 'path';
-import { open } from 'sqlite';
-import sqlite3 from 'sqlite3';
 
 import { ensureDirectoryExists } from '../utils/common.js';
 
 const { access } = fsPromises;
-const { Database, OPEN_READONLY } = sqlite3;
 
 const MAX_SQLITE_VARIABLES = 76;
 
@@ -17,7 +14,27 @@ const SAME_SITE = {
   2: 'strict',
 };
 
-export const getDB = (filePath, readOnly = true) => {
+let sqliteModulePromise = null;
+
+const loadSqlite = () => {
+  sqliteModulePromise ||= Promise.all([
+    import('sqlite'),
+    import('sqlite3'),
+  ]).then(([sqliteModule, sqlite3Module]) => {
+    const sqlite3 = sqlite3Module.default ?? sqlite3Module;
+
+    return {
+      open: sqliteModule.open,
+      Database: sqlite3.Database,
+      OPEN_READONLY: sqlite3.OPEN_READONLY,
+    };
+  });
+
+  return sqliteModulePromise;
+};
+
+export const getDB = async (filePath, readOnly = true) => {
+  const { open, Database, OPEN_READONLY } = await loadSqlite();
   const connectionOpts = {
     filename: filePath,
     driver: Database,
@@ -35,11 +52,12 @@ export const createDBFile = async ({
   cookiesFileSecondPath,
   createCookiesTableQuery,
 }) => {
+  const { open, Database } = await loadSqlite();
   await fsPromises.writeFile(cookiesFilePath, '', { mode: 0o666 });
 
   const connectionOpts = {
     filename: cookiesFilePath,
-    driver: sqlite3.Database,
+    driver: Database,
   };
 
   const db = await open(connectionOpts);
@@ -77,7 +95,6 @@ export const getChunckedInsertValues = (cookiesArr) => {
 
       const sourceScheme = isSecure === 1 ? 2 : 1;
       const sourcePort = isSecure === 1 ? 443 : 80;
-      // eslint-disable-next-line no-undefined
       let isPersistent = [undefined, null].includes(cookie.session)
         ? Number(expirationDate !== 0)
         : Number(!cookie.session);
@@ -90,23 +107,23 @@ export const getChunckedInsertValues = (cookiesArr) => {
       return [
         creationDate,
         cookie.domain,
-        '', // top_frame_site_key
+        '',
         cookie.name,
-        '', // value
+        '',
         encryptedValue,
         cookie.path,
         expirationDate,
         isSecure,
         Number(cookie.httpOnly),
-        0, // last_access_utc
-        expirationDate === 0 ? 0 : 1, // has_expires
+        0,
+        expirationDate === 0 ? 0 : 1,
         isPersistent,
-        1, // default priority value (https://github.com/chromium/chromium/blob/main/net/cookies/cookie_constants.h)
+        1,
         samesite,
         sourceScheme,
         sourcePort,
-        0, // is_same_party
-        0, // last_update_utc
+        0,
+        0,
       ];
     });
 
@@ -128,8 +145,6 @@ export const loadCookiesFromFile = async (filePath, isSecondTry = false, profile
     console.log('error in loadCookiesFromFile', error.message);
   }
 
-  console.log(1);
-
   try {
     db = await getDB(filePath);
     const cookiesRows = await db.all('select * from cookies');

package/src/extensions/extensions-extractor.js

@@ -1,14 +1,16 @@
-import decompress from 'decompress';
-import decompressUnzip from 'decompress-unzip';
 import { promises } from 'fs';
 
+import { loadDecompress } from '../utils/lazy-deps.js';
+
 const { access, unlink } = promises;
 
-export const extractExtension = (source, dest) => {
+export const extractExtension = async (source, dest) => {
   if (!(source && dest)) {
     throw new Error('Missing parameter');
   }
 
+  const { decompress, decompressUnzip } = await loadDecompress();
+
   return access(source)
     .then(() =>
       withRetry({
@@ -20,7 +22,7 @@ export const extractExtension = (source, dest) => {
         },
       }),
     );
-}
+};
 
 export const deleteExtensionArchive = (dest) => {
   if (!dest) {
@@ -32,7 +34,7 @@ export const deleteExtensionArchive = (dest) => {
       () => unlink(dest),
       () => Promise.resolve(),
     );
-}
+};
 
 const withRetry = optionsOrUndefined => {
   const opts = optionsOrUndefined || {};