@syngrisi/playwright-sdk 1.0.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/README.md

@@ -0,0 +1,129 @@
+
+# Syngrisi Playwright SDK
+
+Syngrisi Playwright SDK, `@syngrisi/playwright-sdk` provides a simple and powerful way to integrate visual regression
+testing into your Playwright 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 Playwright-based testing framework.
+
+## Installation
+
+To install the Syngrisi Playwright SDK, run:
+
+```bash
+npm install @syngrisi/playwright-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
+import { PlaywrightDriver } from '@syngrisi/playwright-sdk';
+
+const config = {
+    apiKey: 'your-api-key',
+    serverUrl: 'your-singrisi-url'
+};
+
+const driver = new PlaywrightDriver(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
+const fullPageSreenshot = await page.screenshot({fullPage: true});
+const headerScreenshot = page.locator('#header').screenshot();
+// first check
+driver.check({
+    checkName: 'Main Page',
+    imageBuffer: fullPageSreenshot,
+    params: {
+        viewport: '1200x800',
+        browserName: 'chrome',
+        os: 'Windows',
+        app: 'MyProject',
+        branch: 'develop'
+    }
+});
+
+// second check
+driver.check({
+    checkName: 'Header',
+    imageBuffer: headerScreenshot,
+    params: {/* other parameters */ }
+});
+
+await driver.check({ 'About Page', imageBuffer_02, 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 Playwright 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`
+
+`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/dist/PlaywrightDriver.d.ts

@@ -0,0 +1,83 @@
+/// <reference types="node" />
+import { SyngrisiApi, SessionResponse, ErrorObject, SnapshotResponse, Snapshot } from '@syngrisi/core-api';
+import { Browser, Page } from '@playwright/test';
+import { ViewportSize } from 'playwright-core';
+import { BaselineParams } from './schemas/Baseline.schema';
+import { BrowserName, CheckParams, Config, Params } from '../types';
+import { SessionParams } from './schemas/SessionParams.schema';
+export declare class PlaywrightDriver {
+    api: SyngrisiApi;
+    page: Page;
+    browser: Browser;
+    browserName: BrowserName;
+    viewport: ViewportSize;
+    params: Params;
+    constructor({ page, url, apiKey }: Config);
+    startTestSession({ params, suppressErrors }: {
+        params: SessionParams;
+        suppressErrors?: boolean;
+    }): Promise<SessionResponse | ErrorObject>;
+    stopTestSession({ suppressErrors }?: {
+        suppressErrors?: boolean;
+    }): Promise<Test>;
+    getBaselines({ params }: {
+        params: BaselineParams;
+    }): Promise<ErrorObject | {
+        results: {
+            [x: string]: any;
+        }[];
+        page: number;
+        limit: number;
+        totalPages: number;
+        totalResults: number;
+        timestamp: bigint;
+    }>;
+    getSnapshots({ params }: {
+        params: Snapshot;
+    }): Promise<SnapshotResponse | ErrorObject>;
+    check({ checkName, imageBuffer, params, domDump, suppressErrors }: {
+        checkName: string;
+        imageBuffer: Buffer;
+        params: CheckParams;
+        domDump?: any;
+        suppressErrors?: boolean;
+    }): Promise<ErrorObject | {
+        _id: string;
+        name: string;
+        createdDate: string;
+        status: (string | string[]) & (string | string[] | undefined);
+        viewport: string;
+        browserName: string;
+        os: string;
+        app: string;
+        branch: string;
+        test: string;
+        suite: string;
+        baselineId: string;
+        actualSnapshotId: string;
+        updatedDate: string;
+        browserVersion: string | number;
+        browserFullVersion: string;
+        result: string;
+        run: string;
+        creatorId: string;
+        creatorUsername: string;
+        failReasons: any[];
+        currentSnapshot: {
+            _id?: string | undefined;
+            name?: string | undefined;
+            filename?: string | undefined;
+            imghash?: string | undefined;
+            createdDate?: Date | undefined;
+        };
+        expectedSnapshot: {
+            _id?: string | undefined;
+            name?: string | undefined;
+            filename?: string | undefined;
+            imghash?: string | undefined;
+            createdDate?: Date | undefined;
+        };
+        lastSuccess: string;
+    }>;
+}
+//# sourceMappingURL=PlaywrightDriver.d.ts.map

package/dist/PlaywrightDriver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightDriver.d.ts","sourceRoot":"","sources":["../src/PlaywrightDriver.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC1G,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAG9C,OAAO,EACH,cAAc,EAEjB,MAAM,2BAA2B,CAAA;AAElC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACnE,OAAO,EAAE,aAAa,EAAuB,MAAM,gCAAgC,CAAA;AAanF,qBAAa,gBAAgB;IACzB,GAAG,EAAE,WAAW,CAAA;IAChB,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,YAAY,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;gBAEF,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,MAAM;IAanC,gBAAgB,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE;QAC/C,MAAM,EAAE,aAAa,CAAC;QACtB,cAAc,CAAC,EAAE,OAAO,CAAA;KAC3B,GAAG,OAAO,CAAC,eAAe,GAAG,WAAW,CAAC;IA4CpC,eAAe,CAAC,EAAE,cAAsB,EAAE,GAAE;QAC9C,cAAc,CAAC,EAAE,OAAO,CAAA;KACtB;IAkBA,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE;QAC3B,MAAM,EAAE,cAAc,CAAA;KACzB;;;;;;;;;;IAmBK,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE;QAC3B,MAAM,EAAE,QAAQ,CAAA;KACnB,GAAG,OAAO,CAAC,gBAAgB,GAAG,WAAW,CAAC;IAUrC,KAAK,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,cAAsB,EAAE,EAAE;QAC7E,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,WAAW,CAAC;QACpB,OAAO,CAAC,EAAE,GAAG,CAAC;QACd,cAAc,CAAC,EAAE,OAAO,CAAA;KAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwDJ"}

package/dist/PlaywrightDriver.js

@@ -0,0 +1,166 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightDriver = void 0;
+const hasha_1 = __importDefault(require("hasha"));
+const core_api_1 = require("@syngrisi/core-api");
+const Baseline_schema_1 = require("./schemas/Baseline.schema");
+const Check_schema_1 = require("./schemas/Check.schema");
+const SessionParams_schema_1 = require("./schemas/SessionParams.schema");
+const pwHelpers_1 = require("./lib/pwHelpers");
+const paramsGuard_1 = require("./schemas/paramsGuard");
+const logger_1 = __importDefault(require("@wdio/logger"));
+const PlaywrightEntities_1 = require("./PlaywrightEntities");
+const log = (0, logger_1.default)('syngrisi-playwright-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);
+}
+// noinspection JSUnusedGlobalSymbols
+class PlaywrightDriver {
+    constructor({ page, url, apiKey }) {
+        const pw = new PlaywrightEntities_1.PlaywrightEntities(page);
+        this.page = pw.page;
+        this.browser = pw.browser;
+        this.browserName = pw.browserName;
+        this.viewport = pw.viewport;
+        this.api = new core_api_1.SyngrisiApi({ url, apiKey });
+        this.params = {
+            test: {}
+        };
+    }
+    async startTestSession({ params, suppressErrors }) {
+        try {
+            (0, paramsGuard_1.paramsGuard)(params, 'startTestSession, params', SessionParams_schema_1.SessionParamsSchema);
+            if (params.suite) {
+                this.params.suite = params.suite || 'Unknown';
+            }
+            this.params.test = {
+                os: params.os || await (0, pwHelpers_1.getOS)(this.page),
+                viewport: params.viewport || await (0, pwHelpers_1.getViewport)(this.viewport),
+                browser: params.browserName || await (0, pwHelpers_1.getBrowserName)(this.browserName),
+                browserVersion: params.browserVersion || (0, pwHelpers_1.getBrowserVersion)(this.browser.version()),
+                name: params.test,
+                app: params.app,
+                run: params.run,
+                branch: params.branch,
+                runident: params.runident,
+                suite: params.suite,
+                tags: params.tags,
+                browserFullVersion: params.browserFullVersion || (0, pwHelpers_1.getBrowserFullVersion)(this.browser.version())
+            };
+            // console.log('💥', this.params.test)
+            // @ts-ignore
+            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);
+        }
+    }
+    async stopTestSession({ suppressErrors = false } = {}) {
+        try {
+            const testId = this.params.test.testId;
+            this.params.test.testId = undefined;
+            // @ts-ignore
+            const result = await this.api.stopSession(testId);
+            if (result.error && !suppressErrors) {
+                throw `❌ Start 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;
+        }
+    }
+    async getBaselines({ params }) {
+        let opts = {
+            name: params.name,
+            viewport: params.viewport || await (0, pwHelpers_1.getViewport)(this.viewport),
+            browserName: params.browserName || this.params.test.browser || (0, pwHelpers_1.getBrowserVersion)(this.browser.version()),
+            os: params.os || this.params.test.os || await (0, pwHelpers_1.getOS)(this.page),
+            app: params.app || this.params.test.app,
+            branch: params.branch || this.params.test.branch,
+        };
+        (0, paramsGuard_1.paramsGuard)(opts, 'getBaseline, opts', Baseline_schema_1.BaselineParamsSchema);
+        const result = await this.api.getBaselines(opts);
+        if (result.error) {
+            throw `❌ Get baselines error: ${JSON.stringify(result, null, '  ')}`;
+        }
+        return result;
+    }
+    async getSnapshots({ params }) {
+        const result = await this.api.getSnapshots(params);
+        if (result.error) {
+            throw `❌ Get snapshots error: ${JSON.stringify(result, null, '  ')}`;
+        }
+        return result;
+    }
+    async check({ checkName, imageBuffer, params, domDump, suppressErrors = false }) {
+        // console.log(params)
+        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;
+        const hash = (0, hasha_1.default)(imageBuffer);
+        try {
+            opts = {
+                // ident:  ['name', 'viewport', 'browserName', 'os', 'app', 'branch'];
+                name: checkName,
+                // viewport: params?.viewport || await getViewport(this.viewport),
+                viewport: await (0, pwHelpers_1.getViewport)(this.viewport),
+                // @ts-ignore
+                browserName: this.params.test.browser,
+                // @ts-ignore
+                os: this.params.test.os,
+                // @ts-ignore
+                app: this.params.test.app,
+                // @ts-ignore
+                branch: this.params.test.branch,
+                // ['name', 'viewport', 'browserName', 'os', 'app', 'branch', 'testId', 'suite', 'browserVersion', 'browserFullVersion' ];
+                testId: this.params.test.testId,
+                // @ts-ignore
+                suite: this.params.test.suite,
+                // @ts-ignore
+                browserVersion: this.params.test.browserVersion,
+                // @ts-ignore
+                browserFullVersion: this.params.test.browserFullVersion,
+                hashCode: hash || '',
+                domDump: domDump,
+            };
+            (0, paramsGuard_1.paramsGuard)(opts, 'check, opts', Check_schema_1.CheckOptionsSchema);
+            Object.assign(
+            // @ts-ignore
+            opts, params);
+            // @ts-ignore
+            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.PlaywrightDriver = PlaywrightDriver;
+//# sourceMappingURL=PlaywrightDriver.js.map

package/dist/PlaywrightDriver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightDriver.js","sourceRoot":"","sources":["../src/PlaywrightDriver.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyB;AACzB,iDAA0G;AAK1G,+DAGkC;AAClC,yDAAyE;AAEzE,yEAAmF;AACnF,+CAA8G;AAC9G,uDAAmD;AACnD,0DAAgD;AAChD,6DAAyD;AAEzD,MAAM,GAAG,GAAG,IAAA,gBAAM,EAAC,yBAAyB,CAAC,CAAA;AAC7C,0EAA0E;AAC1E,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE;IAChC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkC,CAAC,CAAA;CAC/D;AAED,qCAAqC;AACrC,MAAa,gBAAgB;IAQzB,YAAY,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAU;QACrC,MAAM,EAAE,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,CAAA;QACvC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAAA;QACnB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,OAAO,CAAA;QACzB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAA;QACjC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,QAAQ,CAAA;QAE3B,IAAI,CAAC,GAAG,GAAG,IAAI,sBAAW,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAA;QAC3C,IAAI,CAAC,MAAM,GAAG;YACV,IAAI,EAAE,EAAE;SACX,CAAA;IACL,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,cAAc,EAG9C;QACG,IAAI;YACA,IAAA,yBAAW,EAAC,MAAM,EAAE,0BAA0B,EAAE,0CAAmB,CAAC,CAAA;YAEpE,IAAI,MAAM,CAAC,KAAK,EAAE;gBACd,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,SAAS,CAAA;aAChD;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG;gBACf,EAAE,EAAE,MAAM,CAAC,EAAE,IAAI,MAAM,IAAA,iBAAK,EAAC,IAAI,CAAC,IAAI,CAAC;gBACvC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,MAAM,IAAA,uBAAW,EAAC,IAAI,CAAC,QAAQ,CAAC;gBAC7D,OAAO,EAAE,MAAM,CAAC,WAAW,IAAI,MAAM,IAAA,0BAAc,EAAC,IAAI,CAAC,WAAW,CAAC;gBACrE,cAAc,EAAE,MAAM,CAAC,cAAc,IAAI,IAAA,6BAAiB,EAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClF,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB,IAAI,IAAA,iCAAqB,EAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;aACjG,CAAA;YACD,sCAAsC;YAEtC,aAAa;YACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC5D,IAAK,MAAsB,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;gBAClD,MAAM,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAA;aAC5E;YAED,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;aACtF;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAI,MAA0B,CAAC,GAAG,CAAA;YACzD,OAAO,MAAM,CAAA;SAChB;QAAC,OAAO,CAAM,EAAE;YACb,MAAM,IAAI,GAAG,iCAAiC,CAAC,SAAS,CAAC,CAAC,KAAK,GAAG,CAAA;YAClE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACf,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,CAAA;SACxB;IACL,CAAC;IAGD,KAAK,CAAC,eAAe,CAAC,EAAE,cAAc,GAAG,KAAK,KAE1C,EAAE;QACF,IAAI;YACA,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAA;YACtC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;YACnC,aAAa;YACb,MAAM,MAAM,GAAS,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;YACvD,IAAK,MAAsB,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;gBAClD,MAAM,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAA;aAC5E;YACD,GAAG,CAAC,KAAK,CAAC,yBAAyB,MAAM,CAAC,GAAG,eAAe,CAAC,CAAA;YAC7D,OAAO,MAAM,CAAA;SAChB;QAAC,OAAO,CAAM,EAAE;YACb,MAAM,IAAI,GAAG,gCAAgC,CAAC,SAAS,CAAC,CAAC,KAAK,GAAG,CAAA;YACjE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACf,MAAM,CAAC,CAAA;SACV;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,EAAE,MAAM,EAE1B;QACG,IAAI,IAAI,GAAmB;YACvB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,MAAM,IAAA,uBAAW,EAAC,IAAI,CAAC,QAAQ,CAAC;YAC7D,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,IAAA,6BAAiB,EAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACxG,EAAE,EAAE,MAAM,CAAC,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,IAAA,iBAAK,EAAC,IAAI,CAAC,IAAI,CAAC;YAC9D,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAI;YACxC,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAO;SACpD,CAAA;QACD,IAAA,yBAAW,EAAC,IAAI,EAAE,mBAAmB,EAAE,sCAAoB,CAAC,CAAA;QAE5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAEhD,IAAK,MAAsB,CAAC,KAAK,EAAE;YAC/B,MAAM,0BAA0B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAA;SACvE;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,EAAE,MAAM,EAE1B;QAEG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAElD,IAAK,MAAsB,CAAC,KAAK,EAAE;YAC/B,MAAM,0BAA0B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAA;SACvE;QACD,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,KAAK,EAM5E;QACG,sBAAsB;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC,6DAA6D;kBACvE,gBAAgB,SAAS,eAAe,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;SACrF;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAC/E,IAAI,IAAI,GAAwB,IAAI,CAAA;QACpC,MAAM,IAAI,GAAG,IAAA,eAAK,EAAC,WAAW,CAAC,CAAA;QAC/B,IAAI;YACA,IAAI,GAAG;gBACH,sEAAsE;gBACtE,IAAI,EAAE,SAAS;gBACf,kEAAkE;gBAClE,QAAQ,EAAE,MAAM,IAAA,uBAAW,EAAC,IAAI,CAAC,QAAQ,CAAC;gBAC1C,aAAa;gBACb,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO;gBACrC,aAAa;gBACb,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACvB,aAAa;gBACb,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;gBACzB,aAAa;gBACb,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM;gBAE/B,0HAA0H;gBAC1H,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM;gBAC/B,aAAa;gBACb,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK;gBAC7B,aAAa;gBACb,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc;gBAC/C,aAAa;gBACb,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB;gBAEvD,QAAQ,EAAE,IAAI,IAAI,EAAE;gBACpB,OAAO,EAAE,OAAO;aACnB,CAAA;YACD,IAAA,yBAAW,EAAC,IAAI,EAAE,aAAa,EAAE,iCAAkB,CAAC,CAAA;YAEpD,MAAM,CAAC,MAAM;YACT,aAAa;YACb,IAAI,EACJ,MAAM,CACT,CAAA;YAED,aAAa;YACb,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;YAE1D,IAAK,MAAsB,CAAC,KAAK,IAAI,CAAC,cAAc,EAAE;gBAClD,MAAM,yBAAyB,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAA;aACtE;YACD,OAAO,MAAM,CAAA;SAChB;QAAC,OAAO,CAAM,EAAE;YACb,GAAG,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;YACzI,MAAM,CAAC,CAAA;SACV;IACL,CAAC;CACJ;AAvLD,4CAuLC"}

package/dist/PlaywrightEntities.d.ts

@@ -0,0 +1,14 @@
+import { Browser, Page } from '@playwright/test';
+import { BrowserName } from '../types';
+import { ViewportSize } from 'playwright-core';
+/**
+ * instances of the class contains playwright entities which need to perform checks
+ */
+export declare class PlaywrightEntities {
+    page: Page;
+    browser: Browser;
+    browserName: BrowserName;
+    viewport: ViewportSize;
+    constructor(page: Page);
+}
+//# sourceMappingURL=PlaywrightEntities.d.ts.map

package/dist/PlaywrightEntities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightEntities.d.ts","sourceRoot":"","sources":["../src/PlaywrightEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;GAEG;AACH,qBAAa,kBAAkB;IAC3B,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,YAAY,CAAA;gBAEV,IAAI,EAAE,IAAI;CAMzB"}

package/dist/PlaywrightEntities.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightEntities = void 0;
+/**
+ * instances of the class contains playwright entities which need to perform checks
+ */
+class PlaywrightEntities {
+    constructor(page) {
+        this.page = page;
+        this.browser = page.context().browser();
+        this.browserName = page.context()?.browser()?.browserType()?.name();
+        this.viewport = page.viewportSize();
+    }
+}
+exports.PlaywrightEntities = PlaywrightEntities;
+//# sourceMappingURL=PlaywrightEntities.js.map

package/dist/PlaywrightEntities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightEntities.js","sourceRoot":"","sources":["../src/PlaywrightEntities.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,MAAa,kBAAkB;IAM3B,YAAY,IAAU;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAG,CAAA;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAiB,CAAA;QAClF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,EAAG,CAAA;IACxC,CAAC;CACJ;AAZD,gDAYC"}

package/dist/lib/getDomDump.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDomDump = void 0;
+function isVisible(el) {
+    while (el) {
+        // @ts-ignore
+        if (el === document) {
+            return true;
+        }
+        const style = window.getComputedStyle(el, null);
+        if (!el || !style) {
+            return false;
+        }
+        if (style.display === 'none' || style.visibility === 'hidden' || +style.opacity === 0) {
+            return false;
+        }
+        if ((style.display === 'block' || style.display === 'inline-block') &&
+            style.height === '0px' && style.overflow === 'hidden') {
+            return false;
+        }
+        return style.position === 'fixed' || isVisible(el.parentNode);
+    }
+    return false;
+}
+function getDomPath(el) {
+    const stack = [];
+    while (el.parentNode !== null) {
+        let sibCount = 0;
+        let sibIndex = 0;
+        for (let i = 0; i < el.parentNode.childNodes.length; i++) {
+            const sib = el.parentNode.childNodes[i];
+            if (sib.nodeName === el.nodeName) {
+                if (sib === el) {
+                    sibIndex = sibCount;
+                }
+                sibCount++;
+            }
+        }
+        if (el.hasAttribute('id') && el.id !== '') {
+            stack.unshift(`${el.nodeName.toLowerCase()}#${el.id}`);
+        }
+        else if (sibCount > 1) {
+            stack.unshift(`${el.nodeName.toLowerCase()}:eq(${sibIndex})`);
+        }
+        else {
+            stack.unshift(el.nodeName.toLowerCase());
+        }
+        el = el.parentNode;
+    }
+    return stack.slice(1);
+}
+function dumpElement(el) {
+    const rect = el.getBoundingClientRect();
+    return {
+        tag: el.tagName,
+        id: el.id,
+        top: rect.top,
+        right: rect.right,
+        bottom: rect.bottom,
+        left: rect.left,
+        width: rect.width,
+        height: rect.height,
+        domPath: getDomPath(el),
+    };
+}
+function getDomDump(done) {
+    const elements = Array.from(document.body.getElementsByTagName('*')).filter((x) => isVisible(x));
+    const dumpElements = [];
+    for (const el of elements) {
+        dumpElements.push(dumpElement(el));
+    }
+    const result = JSON.stringify(dumpElements, null, '\t');
+    done(result);
+    return result;
+}
+exports.getDomDump = getDomDump;

package/dist/lib/pwHelpers.d.ts

@@ -0,0 +1,9 @@
+import { Page } from '@playwright/test';
+import { BrowserName } from '../../types';
+import { ViewportSize } from 'playwright-core';
+export declare const getViewport: (viewport: ViewportSize) => Promise<string>;
+export declare const getBrowserName: (browserName: BrowserName) => Promise<string>;
+export declare const getOS: (page: Page) => Promise<string>;
+export declare const getBrowserFullVersion: (fullVersion: string) => string;
+export declare const getBrowserVersion: (fullVersion: string) => string;
+//# sourceMappingURL=pwHelpers.d.ts.map

package/dist/lib/pwHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pwHelpers.d.ts","sourceRoot":"","sources":["../../src/lib/pwHelpers.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAEvC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAI9C,eAAO,MAAM,WAAW,aAAoB,YAAY,KAAG,QAAQ,MAAM,CAExE,CAAA;AAED,eAAO,MAAM,cAAc,gBAAuB,WAAW,KAAG,QAAQ,MAAM,CAE7E,CAAA;AAED,eAAO,MAAM,KAAK,SAAgB,IAAI,KAAG,QAAQ,MAAM,CAQtD,CAAA;AAED,eAAO,MAAM,qBAAqB,gBAAiB,MAAM,WAAgB,CAAA;AAEzE,eAAO,MAAM,iBAAiB,gBAAiB,MAAM,WAEpD,CAAA"}

package/dist/lib/pwHelpers.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBrowserVersion = exports.getBrowserFullVersion = exports.getOS = exports.getBrowserName = exports.getViewport = void 0;
+const ua_parser_js_1 = require("ua-parser-js");
+const utils_1 = require("./utils");
+const core_api_1 = require("@syngrisi/core-api");
+const getViewport = async (viewport) => {
+    return viewport ? `${viewport.width}x${viewport.height}` : '0x0';
+};
+exports.getViewport = getViewport;
+const getBrowserName = async (browserName) => {
+    return browserName;
+};
+exports.getBrowserName = getBrowserName;
+const getOS = async (page) => {
+    const osName = await (0, utils_1.waitUntil)(async () => {
+        const ua = await page.evaluate(() => navigator.userAgent);
+        const userAgentInfo = (0, ua_parser_js_1.UAParser)(ua);
+        return userAgentInfo.os.name || null;
+    });
+    return (0, core_api_1.transformOs)(osName || 'UNKNOWN');
+};
+exports.getOS = getOS;
+const getBrowserFullVersion = (fullVersion) => fullVersion;
+exports.getBrowserFullVersion = getBrowserFullVersion;
+const getBrowserVersion = (fullVersion) => {
+    return fullVersion.split('.')[0];
+};
+exports.getBrowserVersion = getBrowserVersion;
+//# sourceMappingURL=pwHelpers.js.map

package/dist/lib/pwHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pwHelpers.js","sourceRoot":"","sources":["../../src/lib/pwHelpers.ts"],"names":[],"mappings":";;;AAAA,+CAAuC;AAEvC,mCAAmC;AAInC,iDAAgD;AAEzC,MAAM,WAAW,GAAG,KAAK,EAAE,QAAsB,EAAmB,EAAE;IACzE,OAAO,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;AACpE,CAAC,CAAA;AAFY,QAAA,WAAW,eAEvB;AAEM,MAAM,cAAc,GAAG,KAAK,EAAE,WAAwB,EAAmB,EAAE;IAC9E,OAAO,WAAW,CAAA;AACtB,CAAC,CAAA;AAFY,QAAA,cAAc,kBAE1B;AAEM,MAAM,KAAK,GAAG,KAAK,EAAE,IAAU,EAAmB,EAAE;IACvD,MAAM,MAAM,GAAG,MAAM,IAAA,iBAAS,EAAC,KAAK,IAAI,EAAE;QACtC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;QACzD,MAAM,aAAa,GAAG,IAAA,uBAAQ,EAAC,EAAE,CAAC,CAAA;QAClC,OAAO,aAAa,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,CAAA;IACxC,CAAC,CAAC,CAAA;IAEF,OAAO,IAAA,sBAAW,EAAC,MAAM,IAAI,SAAS,CAAC,CAAA;AAC3C,CAAC,CAAA;AARY,QAAA,KAAK,SAQjB;AAEM,MAAM,qBAAqB,GAAG,CAAC,WAAmB,EAAE,EAAE,CAAC,WAAW,CAAA;AAA5D,QAAA,qBAAqB,yBAAuC;AAElE,MAAM,iBAAiB,GAAG,CAAC,WAAmB,EAAE,EAAE;IACrD,OAAO,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;AACpC,CAAC,CAAA;AAFY,QAAA,iBAAiB,qBAE7B"}

package/dist/lib/utils.d.ts

@@ -0,0 +1,14 @@
+import { TestInfo } from '@playwright/test';
+export declare const log: import("loglevel").Logger;
+interface WaitOptions {
+    attempts?: number;
+    interval?: number;
+    timeout?: number;
+}
+export declare const waitUntil: <T>(callback: (attempt?: number) => Promise<T>, options?: WaitOptions) => Promise<T | null>;
+export declare const generateRunName: () => string;
+export declare const generateRunIdent: () => string;
+export declare const getSuiteTitle: (testInfo: TestInfo) => string | null;
+export declare const getTestTitle: (testInfo: TestInfo) => string;
+export {};
+//# sourceMappingURL=utils.d.ts.map

package/dist/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE3C,eAAO,MAAM,GAAG,2BAAoC,CAAA;AAEpD,UAAU,WAAW;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,eAAO,MAAM,SAAS,2BACG,MAAM,2BAClB,WAAW,sBA8BvB,CAAA;AAED,eAAO,MAAM,eAAe,cACP,CAAA;AAErB,eAAO,MAAM,gBAAgB,cAA4B,CAAA;AAEzD,eAAO,MAAM,aAAa,aAAc,QAAQ,kBAM/C,CAAA;AAED,eAAO,MAAM,YAAY,aAAc,QAAQ,WAE9C,CAAA"}