gologin-commonjs 1.0.0 → 1.0.2

package/dist/fonts.d.ts

@@ -0,0 +1,22 @@
+export const __esModule: boolean;
+export const fontsCollection: ({
+    name: string;
+    value: string;
+    fileNames: string[];
+    os: string[];
+} | {
+    name: string;
+    value: string;
+    fileNames?: undefined;
+    os?: undefined;
+} | {
+    name: string;
+    value: string;
+    fileNames: string[];
+    os?: undefined;
+} | {
+    name: string;
+    value: string;
+    os: string[];
+    fileNames?: undefined;
+})[];

package/dist/src/gologin-api.d.ts

@@ -0,0 +1,18 @@
+export const __esModule: boolean;
+export function GologinApi({ token }: {
+    token: any;
+}): {
+    launch(params?: {}): Promise<{
+        browser: any;
+    }>;
+    exit(status?: number): Promise<void>;
+    delay: (ms?: number) => any;
+};
+export function exitAll(): void;
+export function getDefaultParams(): {
+    token: any;
+    profile_id: any;
+    executablePath: any;
+    autoUpdateBrowser: boolean;
+};
+export function delay(ms?: number): any;

package/dist/src/gologin.d.ts

@@ -0,0 +1,142 @@
+export = GoLogin;
+declare class GoLogin {
+    constructor(options?: {});
+    browserLang: string;
+    is_remote: any;
+    access_token: any;
+    profile_id: any;
+    password: any;
+    extra_params: any;
+    executablePath: any;
+    vnc_port: any;
+    fontsMasking: boolean;
+    is_active: boolean;
+    is_stopping: boolean;
+    differentOs: boolean;
+    profileOs: string;
+    waitWebsocket: any;
+    isCloudHeadless: any;
+    isNewCloudBrowser: any;
+    tmpdir: any;
+    autoUpdateBrowser: boolean;
+    checkBrowserUpdate: any;
+    browserChecker: any;
+    uploadCookiesToServer: any;
+    writeCookiesFromServer: any;
+    remote_debugging_port: any;
+    timezone: any;
+    extensionPathsToInstall: any[];
+    customArgs: any;
+    restoreLastSession: any;
+    processSpawned: any;
+    processKillTimeout: number;
+    profile_zip_path: any;
+    bookmarksFilePath: any;
+    checkBrowser(): Promise<any>;
+    setProfileId(profile_id: any): Promise<void>;
+    cookiesFilePath: any;
+    getToken(username: any, password: any): Promise<void>;
+    getNewFingerPrint(os: any): Promise<any>;
+    profiles(): Promise<any>;
+    getProfile(profile_id: any): Promise<any>;
+    emptyProfile(): Promise<any>;
+    getProfileS3(s3path: any): Promise<any>;
+    postFile(fileName: any, fileBuff: any): Promise<void>;
+    emptyProfileFolder(): Promise<any>;
+    convertPreferences(preferences: any): any;
+    createBrowserExtension(): Promise<void>;
+    extractProfile(path: any, zipfile: any): any;
+    createStartup(local?: boolean): Promise<any>;
+    language: any;
+    resolution: {
+        width: number;
+        height: number;
+    } | {
+        width: number;
+        height: number;
+    };
+    proxy: any;
+    commitProfile(): Promise<void>;
+    profilePath(): any;
+    orbitaExtensionPath(): any;
+    getRandomInt(min: any, max: any): any;
+    checkPortAvailable(port: any): Promise<boolean>;
+    getRandomPort(): Promise<any>;
+    getTimeZone(proxy: any): Promise<any>;
+    _tz: any;
+    getTimezoneWithSocks(params: any): Promise<any>;
+    spawnArguments(): Promise<string[]>;
+    spawnBrowser(): Promise<any>;
+    port: any;
+    createStartupAndSpawnBrowser(): Promise<any>;
+    clearProfileFiles(): Promise<void>;
+    stopAndCommit(options: any, local?: boolean): Promise<boolean>;
+    stopBrowser(): Promise<void>;
+    killBrowser(): void;
+    killAndCommit(options: any, local?: boolean): Promise<void>;
+    sanitizeProfile(): Promise<void>;
+    getProfileDataToUpdate(): Promise<any>;
+    profileExists(): Promise<boolean>;
+    getRandomFingerprint(options: any): Promise<any>;
+    create(options: any): Promise<any>;
+    createCustom(options: any): Promise<any>;
+    quickCreateProfile(name?: string): Promise<any>;
+    delete(pid: any): Promise<void>;
+    update(options: any): Promise<any>;
+    setActive(is_active: any): void;
+    getGeolocationParams(profileGeolocationParams: any, tzGeolocationParams: any): {
+        mode: any;
+        latitude: any;
+        longitude: any;
+        accuracy: any;
+    };
+    getViewPort(): {
+        width: number;
+        height: number;
+    } | {
+        width: number;
+        height: number;
+    };
+    postCookies(profileId: any, cookies: any): Promise<any>;
+    getCookies(profileId: any): Promise<any>;
+    writeCookiesToFile(): Promise<void>;
+    uploadProfileCookiesToServer(): Promise<any>;
+    saveBookmarksToDb(): Promise<void>;
+    start(): Promise<{
+        status: string;
+        wsUrl: any;
+        message?: undefined;
+    } | {
+        status: string;
+        message: any;
+        wsUrl?: undefined;
+    }>;
+    startLocal(): Promise<{
+        status: string;
+        wsUrl: any;
+    }>;
+    stop(): Promise<any>;
+    stopLocal(options: any): Promise<void>;
+    waitDebuggingUrl(delay_ms: any, try_count: number, remoteOrbitaUrl: any): any;
+    startRemote(delay_ms?: number): Promise<{
+        status: string;
+        wsUrl: any;
+        message?: undefined;
+    } | {
+        status: string;
+        message: any;
+        wsUrl?: undefined;
+    }>;
+    stopRemote(): Promise<any>;
+    getAvailableFonts(): string[];
+    changeProfileResolution(resolution: any): Promise<any>;
+    changeProfileUserAgent(userAgent: any): Promise<any>;
+    changeProfileProxy(proxyData: any): Promise<any>;
+}
+declare namespace GoLogin {
+    export { __esModule, GologinApi, exitAll, GoLogin as default };
+}
+declare const __esModule: boolean;
+declare const GologinApi: typeof _gologinApi.GologinApi;
+declare const exitAll: typeof _gologinApi.exitAll;
+import _gologinApi = require("./gologin-api.js");

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "gologin-commonjs",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A CommonJS Transpiled GoLogin API",
-  "types": "./dist/index.d.ts",
+  "types": "./types/gologin.d.ts",
   "main": "./dist/src/gologin.js",
   "repository": {
     "type": "git",
@@ -36,7 +36,8 @@
     "@babel/plugin-transform-modules-commonjs": "^7.24.8",
     "babel-plugin-transform-import-meta": "^2.2.1",
     "eslint": "^8.21.0",
-    "eslint-plugin-simple-import-sort": "^8.0.0"
+    "eslint-plugin-simple-import-sort": "^8.0.0",
+    "typescript": "^5.5.4"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",

package/tes.js

@@ -1,8 +1,9 @@
-const GoLogin = require('./dist/src/gologin')
+const GoLogin = require("./dist/src/gologin");
+// you can use declaration below in your project
+// const GoLogin = require("gologin-commonjs");
 
-
-const token = 'your_token';
-const profile_id = 'your_profile_id';
+const token = "your_token";
+const profile_id = "your_profile_id";
 
 (async () => {
   const GL = new GoLogin({
@@ -10,26 +11,15 @@ const profile_id = 'your_profile_id';
     profile_id,
   });
 
-  const { status, wsUrl } = await GL.start().catch((e) => {
-    console.trace(e);
-
-    return { status: 'failure' };
-  });
-
-  if (status !== 'success') {
-    console.log('Invalid status');
-
-    return;
-  }
+  try {
+    const gologin = await GL.start();
 
-  const browser = await puppeteer.connect({
-    browserWSEndpoint: wsUrl.toString(),
-    ignoreHTTPSErrors: true,
-  });
+    const browser = await puppeteer.connect({
+      browserWSEndpoint: gologin.wsUrl.toString(),
+      ignoreHTTPSErrors: true,
+    });
 
-  const page = await browser.newPage();
-  await page.goto('https://youtube.com');
-  // console.log(await page.content());
-  // await browser.close();
-  // await GL.stop();
-})();
+    const page = await browser.newPage();
+    await page.goto("https://youtube.com");
+  } catch {}
+})();

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+    // Change this to match your project
+    "include": ["dist/**/*"],
+    "compilerOptions": {
+      // Tells TypeScript to read JS files, as
+      // normally they are ignored as source files
+      "allowJs": true,
+      // Generate d.ts files
+      "declaration": true,
+      // This compiler run should
+      // only output d.ts files
+      "emitDeclarationOnly": true,
+      // Types should go into this directory.
+      // Removing this would place the .d.ts files
+      // next to the .js files
+      "outDir": "dist",
+      // go to js file when using IDE functions like
+      // "Go to Definition" in VSCode
+      "declarationMap": true
+    }
+  }

package/types/bookmarks/utils.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export function getCurrentProfileBookmarks(pathToBookmarks: any): Promise<{}>;

package/types/browser/browser-api.d.ts

@@ -0,0 +1,10 @@
+export const __esModule: boolean;
+/**
+  * @param {string} profileId
+  * @param {string} ACCESS_TOKEN
+  * @param {string} resolution
+*/
+export function updateProfileResolution(profileId: string, ACCESS_TOKEN: string, resolution: string): any;
+export function updateProfileUserAgent(profileId: any, ACCESS_TOKEN: any, userAgent: any): any;
+export function updateProfileProxy(profileId: any, ACCESS_TOKEN: any, browserProxyData: any): any;
+export function updateProfileBookmarks(profileIds: any, ACCESS_TOKEN: any, bookmarks: any): Promise<any>;

package/types/browser/browser-checker.d.ts

@@ -0,0 +1,21 @@
+export const __esModule: boolean;
+export default BrowserChecker;
+export class BrowserChecker {
+    constructor(skipOrbitaHashChecking: any);
+    checkBrowser(autoUpdateBrowser?: boolean, checkBrowserUpdate?: boolean): Promise<any>;
+    downloadBrowser(latestVersion: any, browserDownloadUrl: any): Promise<void>;
+    addLatestVersion(latestVersion: any): any;
+    downloadBrowserArchive(link: any, pathStr: any): any;
+    checkBrowserArchive(pathStr: any): Promise<void>;
+    extractBrowser(): Promise<any>;
+    downloadHashFile(latestVersion: any): Promise<any>;
+    checkBrowserSum(latestVersion: any): Promise<any>;
+    replaceBrowser(): Promise<any>;
+    deleteOldArchives(deleteCurrentBrowser?: boolean): Promise<any>;
+    copyDir(src: any, dest: any): Promise<void>;
+    getCurrentVersion(): any;
+    getLatestBrowserVersion(): any;
+    get getOrbitaPath(): any;
+    deleteDir(path?: string): Promise<any>;
+    #private;
+}

package/types/browser/browser-user-data-manager.d.ts

@@ -0,0 +1,23 @@
+export const __esModule: boolean;
+export function downloadCookies({ profileId, ACCESS_TOKEN, API_BASE_URL }: {
+    profileId: any;
+    ACCESS_TOKEN: any;
+    API_BASE_URL: any;
+}): any;
+export function uploadCookies({ cookies, profileId, ACCESS_TOKEN, API_BASE_URL }: {
+    cookies?: any[];
+    profileId: any;
+    ACCESS_TOKEN: any;
+    API_BASE_URL: any;
+}): any;
+export function downloadFonts(fontsList: any[], profilePath: any): Promise<void>;
+export function composeFonts(fontsList: any[], profilePath: any, differentOs?: boolean): Promise<void>;
+export function copyFontsConfigFile(profilePath: any): Promise<void>;
+export function setExtPathsAndRemoveDeleted(settings?: {}, profileExtensionsCheckRes?: any[], profileId?: string): any;
+export function setOriginalExtPaths(settings?: {}, originalExtensionsFolder?: string): Promise<any>;
+export function recalculateId({ localExtObj, extensionId, extensionsSettings, currentExtSettings }: {
+    localExtObj: any;
+    extensionId: any;
+    extensionsSettings: any;
+    currentExtSettings: any;
+}): Promise<any>;

package/types/cookies/cookies-manager.d.ts

@@ -0,0 +1,23 @@
+export const __esModule: boolean;
+export function getDB(filePath: any, readOnly?: boolean): Promise<_sqlite.Database<import("sqlite3").Database, import("sqlite3").Statement>>;
+export function getChunckedInsertValues(cookiesArr: any): any[][];
+export function loadCookiesFromFile(filePath: any): Promise<{
+    url: string;
+    domain: any;
+    name: any;
+    value: any;
+    path: any;
+    sameSite: any;
+    secure: boolean;
+    httpOnly: boolean;
+    hostOnly: boolean;
+    session: boolean;
+    expirationDate: any;
+    creationDate: any;
+}[]>;
+export function unixToLDAP(unixtime: any): any;
+export function ldapToUnix(ldap: any): any;
+export function buildCookieURL(domain: any, secure: any, path: any): string;
+export function chunk(arr: any, chunkSize?: number, cache?: any[]): any[];
+export function getCookiesFilePath(profileId: any, tmpdir: any): Promise<any>;
+import _sqlite = require("sqlite");

package/types/extensions/extensions-extractor.d.ts

@@ -0,0 +1,3 @@
+export const __esModule: boolean;
+export function extractExtension(source: any, dest: any): any;
+export function deleteExtensionArchive(dest: any): any;

package/types/extensions/extensions-manager.d.ts

@@ -0,0 +1,21 @@
+export const __esModule: boolean;
+export default ExtensionsManager;
+declare const ExtensionsManager_base: any;
+export class ExtensionsManager extends ExtensionsManager_base {
+    [x: string]: any;
+    init(): Promise<any>;
+    existedUserExtensions: any;
+    get isInited(): boolean;
+    get useLocalExtStorage(): boolean;
+    get deleteProfileExtFolders(): boolean;
+    get useCookiesExt(): boolean;
+    get existedChromeExtensionsList(): any[];
+    checkChromeExtensions(profileExtensions?: any[]): Promise<any>;
+    downloadChromeExtensions(idsToDownload?: any[]): Promise<any>;
+    getExtensionsPolicies(): Promise<void>;
+    updateExtensions(): Promise<void>;
+    checkLocalExtensions(): Promise<void>;
+    insertExtensionsToDb(extensionsIds: any, pathToExtensions?: any): Promise<void>;
+    getExtensionsToInstall(extensionsFromPref: any, extensionsFromDB: any): any;
+    #private;
+}

package/types/extensions/user-extensions-manager.d.ts

@@ -0,0 +1,19 @@
+export const __esModule: boolean;
+export default UserExtensionsManager;
+export class UserExtensionsManager {
+    set userAgent(userAgent: string);
+    get userAgent(): string;
+    set accessToken(accessToken: string);
+    get accessToken(): string;
+    set twoFaKey(twoFaKey: string);
+    get twoFaKey(): string;
+    set apiUrl(apiUrl: any);
+    get apiBaseUrl(): string;
+    set existedUserExtensions(fileList: any[]);
+    get existedUserExtensions(): any[];
+    checkLocalUserChromeExtensions: (userChromeExtensions: any, profileId: any) => Promise<any[]>;
+    getExtensionsStrToIncludeAsOrbitaParam(profileExtensions?: any[], folderPath?: any): Promise<any[]>;
+    getExtensionsNameAndImage(extensionsIds: any, pathToExtensions: any): Promise<any>;
+    generateExtensionId(): string;
+    #private;
+}

package/types/gologin.d.ts

@@ -0,0 +1,142 @@
+export = GoLogin;
+declare class GoLogin {
+    constructor(options?: {});
+    browserLang: string;
+    is_remote: any;
+    access_token: any;
+    profile_id: any;
+    password: any;
+    extra_params: any;
+    executablePath: any;
+    vnc_port: any;
+    fontsMasking: boolean;
+    is_active: boolean;
+    is_stopping: boolean;
+    differentOs: boolean;
+    profileOs: string;
+    waitWebsocket: any;
+    isCloudHeadless: any;
+    isNewCloudBrowser: any;
+    tmpdir: any;
+    autoUpdateBrowser: boolean;
+    checkBrowserUpdate: any;
+    browserChecker: any;
+    uploadCookiesToServer: any;
+    writeCookiesFromServer: any;
+    remote_debugging_port: any;
+    timezone: any;
+    extensionPathsToInstall: any[];
+    customArgs: any;
+    restoreLastSession: any;
+    processSpawned: any;
+    processKillTimeout: number;
+    profile_zip_path: any;
+    bookmarksFilePath: any;
+    checkBrowser(): Promise<any>;
+    setProfileId(profile_id: any): Promise<void>;
+    cookiesFilePath: any;
+    getToken(username: any, password: any): Promise<void>;
+    getNewFingerPrint(os: any): Promise<any>;
+    profiles(): Promise<any>;
+    getProfile(profile_id: any): Promise<any>;
+    emptyProfile(): Promise<any>;
+    getProfileS3(s3path: any): Promise<any>;
+    postFile(fileName: any, fileBuff: any): Promise<void>;
+    emptyProfileFolder(): Promise<any>;
+    convertPreferences(preferences: any): any;
+    createBrowserExtension(): Promise<void>;
+    extractProfile(path: any, zipfile: any): any;
+    createStartup(local?: boolean): Promise<any>;
+    language: any;
+    resolution: {
+        width: number;
+        height: number;
+    } | {
+        width: number;
+        height: number;
+    };
+    proxy: any;
+    commitProfile(): Promise<void>;
+    profilePath(): any;
+    orbitaExtensionPath(): any;
+    getRandomInt(min: any, max: any): any;
+    checkPortAvailable(port: any): Promise<boolean>;
+    getRandomPort(): Promise<any>;
+    getTimeZone(proxy: any): Promise<any>;
+    _tz: any;
+    getTimezoneWithSocks(params: any): Promise<any>;
+    spawnArguments(): Promise<string[]>;
+    spawnBrowser(): Promise<any>;
+    port: any;
+    createStartupAndSpawnBrowser(): Promise<any>;
+    clearProfileFiles(): Promise<void>;
+    stopAndCommit(options: any, local?: boolean): Promise<boolean>;
+    stopBrowser(): Promise<void>;
+    killBrowser(): void;
+    killAndCommit(options: any, local?: boolean): Promise<void>;
+    sanitizeProfile(): Promise<void>;
+    getProfileDataToUpdate(): Promise<any>;
+    profileExists(): Promise<boolean>;
+    getRandomFingerprint(options: any): Promise<any>;
+    create(options: any): Promise<any>;
+    createCustom(options: any): Promise<any>;
+    quickCreateProfile(name?: string): Promise<any>;
+    delete(pid: any): Promise<void>;
+    update(options: any): Promise<any>;
+    setActive(is_active: any): void;
+    getGeolocationParams(profileGeolocationParams: any, tzGeolocationParams: any): {
+        mode: any;
+        latitude: any;
+        longitude: any;
+        accuracy: any;
+    };
+    getViewPort(): {
+        width: number;
+        height: number;
+    } | {
+        width: number;
+        height: number;
+    };
+    postCookies(profileId: any, cookies: any): Promise<any>;
+    getCookies(profileId: any): Promise<any>;
+    writeCookiesToFile(): Promise<void>;
+    uploadProfileCookiesToServer(): Promise<any>;
+    saveBookmarksToDb(): Promise<void>;
+    start(): Promise<{
+        status: string;
+        wsUrl: any;
+        message?: undefined;
+    } | {
+        status: string;
+        message: any;
+        wsUrl?: undefined;
+    }>;
+    startLocal(): Promise<{
+        status: string;
+        wsUrl: any;
+    }>;
+    stop(): Promise<any>;
+    stopLocal(options: any): Promise<void>;
+    waitDebuggingUrl(delay_ms: any, try_count: number, remoteOrbitaUrl: any): any;
+    startRemote(delay_ms?: number): Promise<{
+        status: string;
+        wsUrl: any;
+        message?: undefined;
+    } | {
+        status: string;
+        message: any;
+        wsUrl?: undefined;
+    }>;
+    stopRemote(): Promise<any>;
+    getAvailableFonts(): string[];
+    changeProfileResolution(resolution: any): Promise<any>;
+    changeProfileUserAgent(userAgent: any): Promise<any>;
+    changeProfileProxy(proxyData: any): Promise<any>;
+}
+declare namespace GoLogin {
+    export { __esModule, GologinApi, exitAll, GoLogin as default };
+}
+declare const __esModule: boolean;
+declare const GologinApi: typeof _gologinApi.GologinApi;
+declare const exitAll: typeof _gologinApi.exitAll;
+import _gologinApi = require("./gologin-api.js");

package/types/profile/profile-archiver.d.ts

@@ -0,0 +1,4 @@
+export const __esModule: boolean;
+export function archiveProfile(profileFolder?: string, tryAgain?: boolean): Promise<any>;
+export function decompressProfile(zipPath?: string, profileFolder?: string): Promise<void>;
+export function checkProfileArchiveIsValid(zipObject: any): boolean;

package/types/profile/profile-directories-to-remove.d.ts

@@ -0,0 +1,3 @@
+export const __esModule: boolean;
+export function getDirectoriesToDeleteForNode(routerSlash?: string): any[];
+export function getDirectoriesForArchiver(): any[];

package/types/utils/browser.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export function checkAutoLang(profileData: any, timezoneCheckResult: any): any;

package/types/utils/common.d.ts

@@ -0,0 +1,10 @@
+export const __esModule: boolean;
+export const API_URL: "https://api.gologin.com";
+export function composeExtractionPromises(filteredArchives: any, destPath?: any): any;
+export function getOS(): "win" | "macM1" | "mac" | "lin";
+export function getOsAdvanced(): Promise<{
+    os: string;
+    osSpec: any;
+}>;
+export const USER_EXTENSIONS_PATH: any;
+export const CHROME_EXTENSIONS_PATH: any;

package/types/utils/constants.d.ts

@@ -0,0 +1,2 @@
+export const __esModule: boolean;
+export const STORAGE_GATEWAY_BASE_URL: "https://files-gateway.gologin.com";

package/types/utils/utils.d.ts

@@ -0,0 +1,4 @@
+export const __esModule: boolean;
+export function get(value: any, path: any, defaultValue: any): any;
+export function isPortReachable(port: any): any;
+export function findLatestBrowserVersionDirectory(browserPath: any): any;