@syngrisi/wdio-sdk 2.1.32-alpha.0

package/.eslintrc.cjs

@@ -0,0 +1,45 @@
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint', 'unicorn'],
+    extends: [
+        'eslint:recommended',
+        'plugin:import/errors',
+        'plugin:import/warnings'
+    ],
+    env: {
+        node: true,
+        es6: true,
+        jest: true
+    },
+    parserOptions: {
+        ecmaVersion: 2019,
+        sourceType: 'module'
+    },
+    rules: {
+        semi: ['error', 'never'],
+        quotes: ['error', 'single'],
+        indent: [2, 4],
+
+        'no-constant-condition': 0,
+        // see https://stackoverflow.com/questions/55280555/typescript-eslint-eslint-plugin-error-route-is-defined-but-never-used-no-un
+        'no-unused-vars': 'off',
+        '@typescript-eslint/no-unused-vars': 'error',
+
+        'import/no-unresolved': 0,
+        'import/named': 2,
+        'import/namespace': 2,
+        'import/default': 2,
+        'import/export': 2,
+
+        'unicorn/prefer-node-protocol': ['error']
+    },
+    overrides: [
+        {
+            files: ['*.ts'],
+            rules: {
+                'no-undef': 'off'
+            }
+        }
+    ]
+}

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Viktar Silakou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# Syngrisi WebdriverIO SDK
+
+The Syngrisi SDK for WebdriverIO, `@syngrisi/wdio-sdk` provides a simple and powerful way to integrate visual regression
+testing into your WebdriverIO tests. By using this SDK, you can send snapshots from your browser tests to the Syngrisi
+server for comparison against baseline images, and easily manage visual testing sessions.
+
+## Features
+
+- Start and stop test sessions seamlessly within your test flows.
+- Perform visual checks with automatic baseline comparison.
+- Fetch baseline and snapshot data programmatically.
+- Easily extendable to fit any WebdriverIO-based testing framework.
+
+## Installation
+
+To install the Syngrisi WebdriverIO SDK, run:
+
+```bash
+npm install @syngrisi/wdio-sdk
+```
+
+## Base Workflow Overview
+
+There is 3 basic step for particular test:
+
+<p align="center">
+<img src="./docs/flow.png" alt="workflow" width="40%">
+</p>
+
+## Usage
+
+The following is a standard workflow to use the SDK in your tests:
+
+### 1. Initialize the Driver
+
+Before starting your test session, initialize the driver with the necessary configuration.
+
+```js
+const { SyngrisiDriver } = require('@syngrisi/wdio-sdk');
+
+const config = {
+    apiKey: 'your-api-key',
+    serverUrl: 'your-singrisi-url'
+};
+
+const driver = new SyngrisiDriver(config);
+```
+
+### 2. Start a Test Session
+
+Start a test session with the desired parameters.
+
+```js
+const sessionParams = {
+    os: 'Windows',
+    viewport: '1920x1080',
+    browserName: 'chrome',
+    browserVersion: '89.0',
+    test: 'Homepage Test',
+    app: 'Your App',
+    run: 'Run 1',
+    branch: 'main',
+    runident: 'unique-run-identifier',
+    suite: 'My Test Suite',
+    tags: ['tag1', 'tag2']
+};
+
+await driver.startTestSession({ params: sessionParams });
+```
+
+### 3. Perform a visual Check
+
+Perform a visual check by providing the check name, image buffer, and any additional parameters.
+
+```js
+driver.check({
+    checkName: 'Header',
+    imageBuffer:  await $('#header').saveScreenshot(),
+    params: {
+        viewport: '1200x800',
+        browserName: 'chrome',
+        os: 'Windows',
+        app: 'MyProject',
+        branch: 'develop'
+    }
+});
+await driver.check({ 'About Page', await $('#header').saveScreenshot(), params: {/* other parameters */ } });
+```
+
+### 4. Stop the Test Session
+
+Once all checks are completed, stop the test session.
+
+```js
+await driver.stopTestSession();
+```
+
+## Environment variables
+Environment variables are used to modify the behavior of the Syngrisi WebdriverIO SDK without code changes.
+
+Example: To set the log level to debug, use the following command:
+
+Windows: `set SYNGRISI_LOG_LEVEL=debug`
+macOS/Linux: `export SYNGRISI_LOG_LEVEL=debug`
+
+`ENV_POSTFIX` - will add to platform property, you can use this to set some unique platform name for particular
+environment
+`SYNGRISI_LOG_LEVEL` - logging level (`"trace" | "debug" | "info" | "warn" | "error"`)
+
+## Documentation
+
+For detailed information about all available methods, parameters, and configurations, please refer to
+the [Syngrisi packages documentation](TODO ADD LINK TO ROOT docs folder published on github.io).
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).
+

package/README.md.bak

@@ -0,0 +1,109 @@
+## SDK for Syngrisi tool
+
+### Base Flow Overview
+
+There is 3 basic step for particular test:
+![syngrisi flow](./docs/flow.png)
+
+### Installation
+
+```shell script
+npm i @syngrisi/syngrisi-wdio-sdk --save-dev
+```
+
+### Usage Example
+
+```javascript
+const syngrisi = require('@syngrisi/syngrisi-wdio-sdk');
+const vrsHost = 'localhost';
+const vrsPort = 3000;
+const VRSConfig = { url: `http://${vrsHost}:${vrsPort}/` };
+const { remote } = require('webdriverio');
+
+;(async () => {
+    global.browser = await remote({
+        capabilities: { browserName: 'chrome' }
+    })
+    // 0. Add Syngrisi driver to browser object
+    browser.vDriver = new syngrisi.vDriver(VRSConfig);
+
+    // 1. Start Syngrisi test session
+    await browser.vDriver.startTestSession({
+        app: 'Test Application',
+        test: 'My first Syngrisi test',
+        suite: 'My first Syngrisi suite'
+    });
+
+    await browser.navigateTo('https://www.google.com/ncr')
+
+    // 2.1. perform visual check
+    const screenshot = new Buffer(await browser.takeScreenshot(), 'base64');
+
+    await browser.vDriver.checkSnapshot(
+        'My Check',
+        screenshot
+    );
+
+    const searchInput = await browser.$('[name=q]');
+    await searchInput.setValue('Σύγκριση');
+
+    const searchBtn = await browser.$('input[value="Google Search"]');
+    await (searchBtn.waitForClickable())
+    await searchBtn.click();
+
+    // 2.2 perform another visual check
+    const screenshot2 = new Buffer(await browser.takeScreenshot(), 'base64');
+
+    await browser.vDriver.checkSnapshot(
+        'My another Check',
+        screenshot2
+    );
+
+    // 2.3 stop test Session
+    await browser.vDriver.stopTestSession();
+
+})().catch((err) => {
+    log.error(err)
+    throw err
+}).finally(() => browser.deleteSession());
+```
+
+### Environment variables
+
+`RUN_NAME` - use such variable to set up specific run name, by default it will generate automatically
+`ENV_POSTFIX` - will add to platform property, you can use this to set some unique platform name for particular
+environment
+`SYNGRISI_LOG_LEVEL` - logging level (`"trace" | "debug" | "info" | "warn" | "error"`)
+
+### SDK API
+
+#### vDriver class
+
+- `vDriver(cfg)` (constructor) - initialize vDriver instance
+
+##### Parameters
+
+| Name  | Type     | Details                                |
+|-------|----------|----------------------------------------|
+| `cfg` | `object` | e.g.: `{url: 'http://localhost:3000'}` |
+
+- `startTestSession(params)` - starts of the test session
+
+##### Parameters
+
+| Name     | Type     | Details                                                               |
+|----------|----------|-----------------------------------------------------------------------|
+| `params` | `object` | e.g: {app: 'App Name', <br>test: 'Test Name',<br>suite: 'Suite Name'} |
+
+- `checkSnapshot(checkName, imageBuffer, domDump)` - create snapshot and send to Syngrisi API
+
+##### Parameters
+
+| Name          | Type     | Details                                                                       |
+|---------------|----------|-------------------------------------------------------------------------------|
+| `checkName`   | `String` | eg.: 'Check Name'                                                             |
+| `imageBuffer` | `Buffer` | File buffer                                                                   |
+| `domDump`     | `String` | Web Page DOM Dump JSON string, to get properly dump use `getDomDump()` method |
+
+- `stopTestSession()` - stop of the test session
+

package/dist/WDIODriver.js

@@ -0,0 +1,241 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WDIODriver = exports.getDomDump = void 0;
+const hasha_1 = __importDefault(require("hasha"));
+const logger_1 = __importDefault(require("@wdio/logger"));
+const getDomDump_1 = require("./lib/getDomDump");
+Object.defineProperty(exports, "getDomDump", { enumerable: true, get: function () { return getDomDump_1.getDomDump; } });
+const core_api_1 = require("@syngrisi/core-api");
+const WDIODriver_1 = require("./schemas/WDIODriver");
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const wdioHelpers_1 = require("./lib/wdioHelpers");
+const paramsGuard_1 = require("./lib/paramsGuard");
+const log = (0, logger_1.default)('syngrisi-wdio-sdk');
+// 0 | 4 | 2 | 1 | 3 | 5 | "trace" | "debug" | "info" | "warn" | "error" |
+if (process.env.SYNGRISI_LOG_LEVEL) {
+    log.setLevel(process.env.SYNGRISI_LOG_LEVEL);
+}
+/**
+ * The `WDIODriver` class is responsible for managing the interaction between WebdriverIO and the Syngrisi server.
+ * It provides methods to start and stop test sessions, retrieve baselines and snapshots, and perform visual checks.
+ */
+class WDIODriver {
+    /**
+     * Creates an instance of the WDIODriver.
+     * @param {Config} cfg - Configuration object for the Syngrisi API.
+     * @example
+     * const driver = new WDIODriver({
+     *   host: '<your-syngrisi-url>',
+     *   apiKey: 'your-api-key'
+     * });
+     */
+    constructor(cfg) {
+        this.api = new core_api_1.SyngrisiApi(cfg);
+        this.params = {
+            // @ts-ignore
+            test: {}
+        };
+    }
+    /**
+     * Starts a new test session with the provided parameters.
+     * @param {SessionParams} params - Parameters for the test session.
+     * @param {boolean} [suppressErrors=false] - Flag to suppress thrown errors.
+     * @returns {Promise<SessionResponse | ErrorObject>} The session response or an error object.
+     * @example
+     * driver.startTestSession({
+     *   params: {
+     *     os: 'Windows',
+     *     browserName: 'chrome',
+     *     test: 'Main Page Test',
+     *     app: 'MyProject',
+     *     run: 'run-123',
+     *     branch: 'master',
+     *     runident: 'run-identification-string',
+     *     tags: ['tag1', 'tag2']
+     *   },
+     *   suppressErrors: true
+     * });
+     */
+    async startTestSession({ params, suppressErrors = false }) {
+        try {
+            (0, paramsGuard_1.paramsGuard)(params, 'startTestSession, params', WDIODriver_1.SessionParamsSchema);
+            this.params.test = {
+                os: params.os || await (0, wdioHelpers_1.getOS)(),
+                viewport: params.viewport || await (0, wdioHelpers_1.getViewport)(),
+                browser: params.browserName || await (0, wdioHelpers_1.getBrowserName)(),
+                browserVersion: params.browserVersion || await (0, wdioHelpers_1.getBrowserVersion)(),
+                name: params.test,
+                app: params.app,
+                run: params.run,
+                branch: params.branch,
+                runident: params.runident,
+                suite: params.suite || 'Unknown',
+                tags: params.tags,
+                browserFullVersion: params.browserFullVersion || await (0, wdioHelpers_1.getBrowserFullVersion)()
+            };
+            // noinspection DuplicatedCode
+            const result = await this.api.startSession(this.params.test);
+            if (result.error && !suppressErrors) {
+                throw `❌ Start Test Session Error: ${JSON.stringify(result, null, '  ')}`;
+            }
+            if (!result) {
+                throw new Error(`response is empty, params: ${JSON.stringify(params, null, '\t')}`);
+            }
+            this.params.test.testId = result._id;
+            return result;
+        }
+        catch (e) {
+            const eMsg = `Cannot start session, error: '${e}' \n '${e.stack}'`;
+            log.error(eMsg);
+            throw new Error(eMsg);
+        }
+    }
+    /**
+     * Stops the currently running test session.
+     * @param {boolean} [suppressErrors=false] - Flag to suppress thrown errors.
+     * @returns {Promise<SessionResponse | ErrorObject>} The stop session response or an error object.
+     * @example
+     * driver.stopTestSession();
+     */
+    async stopTestSession({ suppressErrors = false } = {}) {
+        try {
+            const testId = this.params.test.testId;
+            if (!testId) {
+                throw `❌ Stop Test Session Error: testId id empty, driver params: '${JSON.stringify(this.params)}'`;
+            }
+            this.params.test.testId = undefined;
+            const result = await this.api.stopSession(testId);
+            if (result.error && !suppressErrors) {
+                throw `❌ Stop Test Session Error: ${JSON.stringify(result, null, '  ')}`;
+            }
+            log.debug(`Session with testId: '${result._id}' was stopped`);
+            return result;
+        }
+        catch (e) {
+            const eMsg = `Cannot stop session, error: '${e}' \n '${e.stack}'`;
+            log.error(eMsg);
+            throw e;
+        }
+    }
+    /**
+     * Fetches baselines matching the provided criteria.
+     * @param {BaselineParams} params - Baseline search parameters.
+     * @returns {Promise<BaselineResponse | ErrorObject>} The baseline response or an error object.
+     * @example
+     * driver.getBaselines({
+     *   params: {
+     *     name: 'Main Page',
+     *     viewport: '1200x800',
+     *     browserName: 'chrome',
+     *     os: 'Windows',
+     *     app: 'MyProject',
+     *     branch: 'master'
+     *   }
+     * });
+     */
+    async getBaselines({ params }) {
+        // ident:  ['name', 'viewport', 'browserName', 'os', 'app', 'branch'];
+        let opts = {
+            name: params.name,
+            viewport: params.viewport || await (0, wdioHelpers_1.getViewport)(),
+            browserName: params.browserName || this.params.test.browser || await (0, wdioHelpers_1.getBrowserVersion)(),
+            os: params.os || this.params.test.os || await (0, wdioHelpers_1.getOS)(),
+            app: params.app || this.params.test.app,
+            branch: params.branch || this.params.test.branch,
+        };
+        (0, paramsGuard_1.paramsGuard)(opts, 'getBaseline, opts', WDIODriver_1.BaselineParamsSchema);
+        const result = await this.api.getBaselines(opts);
+        if (result.error) {
+            throw `❌ Get baselines error: ${JSON.stringify(result, null, '  ')}`;
+        }
+        return result;
+    }
+    /**
+     * Retrieves snapshots based on the given search criteria.
+     * @param {Snapshot} params - Snapshot search parameters.
+     * @returns {Promise<SnapshotResponse | ErrorObject>} The snapshot response or an error object.
+     * @example
+     * driver.getSnapshots({
+     *   params: {
+     *     name: 'Checkout Page',
+     *     viewport: '1200x800',
+     *     browserName: 'firefox',
+     *     os: 'macOS',
+     *     app: 'E-commerce Platform',
+     *     branch: 'feature-xyz'
+     *   }
+     * });
+     */
+    async getSnapshots({ params }) {
+        const result = await this.api.getSnapshots(params);
+        if (result.error) {
+            throw `❌ Get snapshots error: ${JSON.stringify(result, null, '  ')}`;
+        }
+        return result;
+    }
+    /**
+     * Submits a check to Syngrisi with the provided image and associated test details.
+     * @param {string} checkName - Name of the check.
+     * @param {Buffer} imageBuffer - Buffer containing image data for the check.
+     * @param {CheckParams} params - Additional check parameters.
+     * @param {any} domDump - Serialized DOM dump associated with the image check.
+     * @param {boolean} [suppressErrors=false] - Flag to suppress thrown errors.
+     * @returns {Promise<CheckResponse | ErrorObject>} The check response or an error object.
+     * @example
+     * driver.check({
+     *   checkName: 'Main Navigation Bar',
+     *   imageBuffer: fs.readFileSync('navbar.png'),
+     *   params: {
+     *     viewport: '1200x800',
+     *     browserName: 'chrome',
+     *     os: 'Windows',
+     *     app: 'MyApp',
+     *     branch: 'develop'
+     *   },
+     *   suppressErrors: false
+     * });
+     */
+    async check({ checkName, imageBuffer, params, domDump, suppressErrors = false }) {
+        if (this.params.test.testId === undefined) {
+            throw new Error('The test id is empty, the session may not have started yet:'
+                + `check name: '${checkName}', driver: '${JSON.stringify(this, null, '\t')}'`);
+        }
+        if (!Buffer.isBuffer(imageBuffer))
+            throw new Error('check - wrong imageBuffer');
+        let opts = null;
+        try {
+            opts = {
+                // ident:  ['name', 'viewport', 'browserName', 'os', 'app', 'branch'];
+                name: checkName,
+                viewport: params?.viewport || await (0, wdioHelpers_1.getViewport)(),
+                browserName: this.params.test.browser,
+                os: this.params.test.os,
+                app: this.params.test.app,
+                branch: this.params.test.branch,
+                // ['name', 'viewport', 'browserName', 'os', 'app', 'branch', 'testId', 'suite', 'browserVersion', 'browserFullVersion' ];
+                testId: this.params.test.testId,
+                suite: this.params.test.suite,
+                browserVersion: this.params.test.browserVersion,
+                browserFullVersion: this.params.test.browserFullVersion,
+                hashCode: (0, hasha_1.default)(imageBuffer),
+                domDump: domDump,
+            };
+            (0, paramsGuard_1.paramsGuard)(opts, 'check, opts', core_api_1.CheckParamsSchema);
+            Object.assign(opts, params);
+            const result = await this.api.coreCheck(imageBuffer, opts);
+            if (result.error && !suppressErrors) {
+                throw `❌ Create Check error: ${JSON.stringify(result, null, '  ')}`;
+            }
+            return result;
+        }
+        catch (e) {
+            log.error(`cannot create check, params: '${JSON.stringify(params)}' opts: '${JSON.stringify(opts)}, error: '${e.stack || e.toString()}'`);
+            throw e;
+        }
+    }
+}
+exports.WDIODriver = WDIODriver;
+exports.SyngrisiDriver = WDIODriver;

package/dist/lib/api.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyngrisiApi = void 0;
+const form_data_1 = __importDefault(require("form-data"));
+const got_cjs_1 = __importDefault(require("got-cjs"));
+const hasha_1 = __importDefault(require("hasha"));
+const logger_1 = __importDefault(require("@wdio/logger"));
+const utils_1 = require("./utils");
+const log = (0, logger_1.default)('syngrisi-wdio-sdk');
+class SyngrisiApi {
+    constructor(cfg) {
+        this.config = cfg;
+    }
+    objectToSearch(obj) {
+        const str = [];
+        for (const p in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, p)) {
+                str.push(`${encodeURIComponent(p)}=${encodeURIComponent(obj[p])}`);
+            }
+        }
+        return str.join('&');
+    }
+    async startSession(params) {
+        const apiHash = (0, hasha_1.default)(this.config.apiKey);
+        const form = new form_data_1.default();
+        const required = ['run', 'suite', 'runident', 'name', 'viewport', 'browser', 'browserVersion', 'os', 'app'];
+        required.forEach(param => form.append(param, params[param]));
+        // optional
+        if (params.tags)
+            form.append('tags', JSON.stringify(params.tags));
+        if (params.branch)
+            form.append('branch', params.branch);
+        const response = await got_cjs_1.default.post(`${this.config.url}v1/client/startSession`, {
+            body: form,
+            headers: { apikey: apiHash },
+        }).json();
+        return response;
+    }
+    async stopSession(testId) {
+        try {
+            const apiHash = (0, hasha_1.default)(this.config.apiKey);
+            const form = new form_data_1.default();
+            const response = await got_cjs_1.default.post(`${this.config.url}v1/client/stopSession/${testId}`, {
+                body: form,
+                headers: { apikey: apiHash },
+            }).json();
+            return response;
+        }
+        catch (e) {
+            throw new Error(`Cannot stop the test session with id: '${testId}', error: '${e}'`);
+        }
+    }
+    addMessageIfCheckFailed(result) {
+        const patchedResult = result;
+        if (patchedResult.status.includes('failed')) {
+            const checkView = `'${this.config.url}?checkId=${patchedResult._id}&modalIsOpen=true'`;
+            patchedResult.message = `To evaluate the results of the check, follow the link: '${checkView}'`;
+            // basically the links is useless - backward compatibility
+            patchedResult.vrsGroupLink = checkView;
+            patchedResult.vrsDiffLink = checkView;
+        }
+        return patchedResult;
+    }
+    async coreCheck(imageBuffer, params) {
+        let resultWithHash = await this.createCheck(params, null, params.hashCode);
+        resultWithHash = this.addMessageIfCheckFailed(resultWithHash);
+        log.info(`Check result Phase #1: ${(0, utils_1.prettyCheckResult)(resultWithHash)}`);
+        if (resultWithHash.status === 'requiredFileData') {
+            let resultWithFile = await this.createCheck(params, imageBuffer, params.hashCode);
+            log.info(`Check result Phase #2: ${(0, utils_1.prettyCheckResult)(resultWithFile)}`);
+            resultWithFile = this.addMessageIfCheckFailed(resultWithFile);
+            return resultWithFile;
+        }
+        return resultWithHash;
+    }
+    async createCheck(params, imageBuffer, hashCode) {
+        const apiHash = (0, hasha_1.default)(this.config.apiKey);
+        const url = `${this.config.url}v1/client/createCheck`;
+        const form = new form_data_1.default();
+        const fieldsMapping = {
+            branch: 'branch',
+            app: 'appName',
+            suite: 'suitename',
+            domDump: 'domdump',
+            vShifting: 'vShifting',
+            testId: 'testid',
+            name: 'name',
+            viewport: 'viewport',
+            browserName: 'browserName',
+            browserVersion: 'browserVersion',
+            browserFullVersion: 'browserFullVersion',
+            os: 'os'
+        };
+        try {
+            Object.keys(fieldsMapping).forEach(key => {
+                if (params[key]) { // @ts-ignore
+                    form.append(fieldsMapping[key], params[key]);
+                }
+            });
+            if (hashCode)
+                form.append('hashcode', hashCode);
+            if (imageBuffer)
+                form.append('file', imageBuffer, 'file');
+            const result = await got_cjs_1.default.post(url, {
+                body: form,
+                headers: { apikey: apiHash },
+            }).json();
+            return result;
+        }
+        catch (e) {
+            log.error('❌ createCheck error create check vi API' + e.stack || e.toString());
+            log.error('👉 Params:', params);
+            if (e.response)
+                (0, utils_1.printErrorResponseBody)(e);
+            throw e;
+        }
+    }
+    async getIdent(apiKey) {
+        const url = `${this.config.url}v1/client/getIdent?apikey=${(0, hasha_1.default)(apiKey)}`;
+        const result = await got_cjs_1.default.get(url).json();
+        return result;
+    }
+    async checkIfBaselineExist(params) {
+        try {
+            const searchString = this.objectToSearch({
+                ...params, ...{ apikey: (0, hasha_1.default)(this.config.apiKey) },
+            });
+            const url = `${this.config.url}v1/client/checkIfScreenshotHasBaselines?${searchString}`;
+            // console.log({ url });
+            const result = got_cjs_1.default.get(url, { throwHttpErrors: false })
+                .json();
+            return result;
+        }
+        catch (e) {
+            throw new Error(e.toString() + e.stack);
+        }
+    }
+}
+exports.SyngrisiApi = SyngrisiApi;