vasu-playwright-utils 0.4.0 → 0.4.2

package/dist/vasu-playwright-lib/index.d.ts

@@ -1,7 +1,10 @@
 export * from './utils/action-utils';
+export * from './utils/assert-utils';
 export * from './utils/element-utils';
 export * from './utils/locator-utils';
 export * from './utils/page-utils';
 export * from './constants';
+export * from './setup';
 export * from './types';
+export { default as CustomLogger } from './setup/custom-logger';
 //# sourceMappingURL=index.d.ts.map

package/dist/vasu-playwright-lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vasu-playwright-lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vasu-playwright-lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/vasu-playwright-lib/index.js

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomLogger = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./utils/action-utils"), exports);
+tslib_1.__exportStar(require("./utils/assert-utils"), exports);
 tslib_1.__exportStar(require("./utils/element-utils"), exports);
 tslib_1.__exportStar(require("./utils/locator-utils"), exports);
 tslib_1.__exportStar(require("./utils/page-utils"), exports);
 tslib_1.__exportStar(require("./constants"), exports);
+tslib_1.__exportStar(require("./setup"), exports);
 tslib_1.__exportStar(require("./types"), exports);
+var custom_logger_1 = require("./setup/custom-logger");
+Object.defineProperty(exports, "CustomLogger", { enumerable: true, get: function () { return tslib_1.__importDefault(custom_logger_1).default; } });
 //# sourceMappingURL=index.js.map

package/dist/vasu-playwright-lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/vasu-playwright-lib/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,gEAAsC;AACtC,gEAAsC;AACtC,6DAAmC;AACnC,sDAA4B;AAC5B,kDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/vasu-playwright-lib/index.ts"],"names":[],"mappings":";;;;AAAA,+DAAqC;AACrC,+DAAqC;AACrC,gEAAsC;AACtC,gEAAsC;AACtC,6DAAmC;AACnC,sDAA4B;AAC5B,kDAAwB;AACxB,kDAAwB;AACxB,uDAAgE;AAAvD,sIAAA,OAAO,OAAgB"}

package/dist/vasu-playwright-lib/setup/custom-logger.d.ts

@@ -0,0 +1,33 @@
+/**
+ * custom-logger.ts: This module provides a custom logger for Playwright tests. It implements the Reporter interface from Playwright
+ * and uses the Winston logging library to provide detailed logs for test execution. The logger includes custom colors
+ * for different log levels and can be configured to log to the console or a file.
+ */
+import { Reporter, TestCase, TestError, TestResult } from '@playwright/test/reporter';
+import winston from 'winston';
+/**
+ * Logger configuration
+ */
+export declare const logger: winston.Logger;
+/**
+ * CustomLogger class that implements the Reporter interface from Playwright
+ */
+export default class CustomLogger implements Reporter {
+    /**
+     * Logs the start of a test case
+     * @param {TestCase} test - The test case that is starting
+     */
+    onTestBegin(test: TestCase): void;
+    /**
+     * Logs the end of a test case
+     * @param {TestCase} test - The test case that ended
+     * @param {TestResult} result - The result of the test case
+     */
+    onTestEnd(test: TestCase, result: TestResult): void;
+    /**
+     * Logs an error
+     * @param {TestError} error - The error
+     */
+    onError(error: TestError): void;
+}
+//# sourceMappingURL=custom-logger.d.ts.map

package/dist/vasu-playwright-lib/setup/custom-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-logger.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/setup/custom-logger.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACtF,OAAO,OAAO,MAAM,SAAS,CAAC;AAW9B;;GAEG;AACH,eAAO,MAAM,MAAM,gBAcjB,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,QAAQ;IACnD;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAIjC;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI;IAanD;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;CAGhC"}

package/dist/vasu-playwright-lib/setup/custom-logger.js

@@ -0,0 +1,72 @@
+"use strict";
+/**
+ * custom-logger.ts: This module provides a custom logger for Playwright tests. It implements the Reporter interface from Playwright
+ * and uses the Winston logging library to provide detailed logs for test execution. The logger includes custom colors
+ * for different log levels and can be configured to log to the console or a file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const tslib_1 = require("tslib");
+const winston_1 = tslib_1.__importDefault(require("winston"));
+/**
+ * Custom colors for the logger
+ */
+const customColors = {
+    info: 'blue',
+    error: 'red',
+};
+winston_1.default.addColors(customColors);
+/**
+ * Logger configuration
+ */
+exports.logger = winston_1.default.createLogger({
+    level: 'info',
+    format: winston_1.default.format.combine(winston_1.default.format.colorize({ all: true }), winston_1.default.format.timestamp(), winston_1.default.format.printf(({ timestamp, level, message }) => {
+        return `${timestamp} [${level}]: ${message}`;
+    })),
+    transports: [
+        new winston_1.default.transports.Console(),
+        // If you want to log to a file uncomment below line
+        // new winston.transports.File({ filename: 'logs/info.log', level: 'info' }),
+    ],
+});
+/**
+ * CustomLogger class that implements the Reporter interface from Playwright
+ */
+class CustomLogger {
+    /**
+     * Logs the start of a test case
+     * @param {TestCase} test - The test case that is starting
+     */
+    onTestBegin(test) {
+        exports.logger.info(`Test Case Started : ${test.title}`);
+    }
+    /**
+     * Logs the end of a test case
+     * @param {TestCase} test - The test case that ended
+     * @param {TestResult} result - The result of the test case
+     */
+    onTestEnd(test, result) {
+        if (result.status === 'passed') {
+            exports.logger.info(`\x1b[32mTest Case Passed : ${test.title}\x1b[0m`); // Green color
+        }
+        else if (result.status === 'skipped') {
+            exports.logger.info(`\x1b[33mTest Case Skipped : ${test.title}\x1b[0m`); // Yellow color
+        }
+        else if (result.status === 'failed' && result.error) {
+            // Playwright inbuild reporter logs the error
+            // logger.error(
+            //   `Test Case Failed: ${test.title} Error: ${result.error.message}`,
+            // );
+        }
+    }
+    /**
+     * Logs an error
+     * @param {TestError} error - The error
+     */
+    onError(error) {
+        exports.logger.error(error.message);
+    }
+}
+exports.default = CustomLogger;
+//# sourceMappingURL=custom-logger.js.map

package/dist/vasu-playwright-lib/setup/custom-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-logger.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/setup/custom-logger.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;AAGH,8DAA8B;AAE9B;;GAEG;AACH,MAAM,YAAY,GAAG;IACnB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,KAAK;CACb,CAAC;AACF,iBAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;AAEhC;;GAEG;AACU,QAAA,MAAM,GAAG,iBAAO,CAAC,YAAY,CAAC;IACzC,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,iBAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EACtC,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAC1B,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE;QACtD,OAAO,GAAG,SAAS,KAAK,KAAK,MAAM,OAAO,EAAE,CAAC;IAC/C,CAAC,CAAC,CACH;IACD,UAAU,EAAE;QACV,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE;QAChC,oDAAoD;QACpD,6EAA6E;KAC9E;CACF,CAAC,CAAC;AAEH;;GAEG;AACH,MAAqB,YAAY;IAC/B;;;OAGG;IACH,WAAW,CAAC,IAAc;QACxB,cAAM,CAAC,IAAI,CAAC,uBAAuB,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAc,EAAE,MAAkB;QAC1C,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE;YAC9B,cAAM,CAAC,IAAI,CAAC,8BAA8B,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc;SAC/E;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YACtC,cAAM,CAAC,IAAI,CAAC,+BAA+B,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe;SACjF;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,EAAE;YACrD,6CAA6C;YAC7C,gBAAgB;YAChB,sEAAsE;YACtE,KAAK;SACN;IACH,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAgB;QACtB,cAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF;AAlCD,+BAkCC"}

package/dist/vasu-playwright-lib/setup/index.d.ts

@@ -0,0 +1,3 @@
+export * from './custom-logger';
+export * from './page-setup';
+//# sourceMappingURL=index.d.ts.map

package/dist/vasu-playwright-lib/setup/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/setup/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/vasu-playwright-lib/setup/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./custom-logger"), exports);
+tslib_1.__exportStar(require("./page-setup"), exports);
+//# sourceMappingURL=index.js.map

package/dist/vasu-playwright-lib/setup/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/setup/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,uDAA6B"}

package/dist/vasu-playwright-lib/setup/page-setup.d.ts

@@ -0,0 +1,12 @@
+/**
+ * page-setup.ts: This module is responsible for setting up the initial state of a page before each test.
+ * It includes a hook that runs before each test, setting the page context. By centralizing these setup operations,
+ * it ensures a consistent starting point for each test, improving test reliability. It also exports a base test object
+ * with a beforeEach hook already set up. This can be used to define tests with the page context set up.
+ */
+/**
+ * The base test object with a beforeEach hook already set up.
+ * This can be used to define tests with the page context set up.
+ */
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+//# sourceMappingURL=page-setup.d.ts.map

package/dist/vasu-playwright-lib/setup/page-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-setup.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/setup/page-setup.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH;;;GAGG;AACH,eAAO,MAAM,IAAI,6OAAW,CAAC"}

package/dist/vasu-playwright-lib/setup/page-setup.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * page-setup.ts: This module is responsible for setting up the initial state of a page before each test.
+ * It includes a hook that runs before each test, setting the page context. By centralizing these setup operations,
+ * it ensures a consistent starting point for each test, improving test reliability. It also exports a base test object
+ * with a beforeEach hook already set up. This can be used to define tests with the page context set up.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.test = void 0;
+const test_1 = require("@playwright/test");
+const page_utils_1 = require("../utils/page-utils");
+/**
+ * A hook that runs before each test, setting the page context.
+ * @param {Page} page - The page context provided by Playwright.
+ */
+test_1.test.beforeEach(({ page }) => {
+    (0, page_utils_1.setPage)(page);
+});
+/**
+ * The base test object with a beforeEach hook already set up.
+ * This can be used to define tests with the page context set up.
+ */
+exports.test = test_1.test;
+//# sourceMappingURL=page-setup.js.map

package/dist/vasu-playwright-lib/setup/page-setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-setup.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/setup/page-setup.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2CAA0D;AAC1D,oDAA8C;AAE9C;;;GAGG;AACH,WAAQ,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAkB,EAAE,EAAE;IAC/C,IAAA,oBAAO,EAAC,IAAI,CAAC,CAAC;AAChB,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACU,QAAA,IAAI,GAAG,WAAQ,CAAC"}

package/dist/vasu-playwright-lib/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * from './action-utils';
+export * from './assert-utils';
 export * from './element-utils';
 export * from './locator-utils';
 export * from './page-utils';

package/dist/vasu-playwright-lib/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/index.ts"],"names":[],"mappings":"AAGA,cAAc,gBAAgB,CAAC;AAG/B,cAAc,iBAAiB,CAAC;AAGhC,cAAc,iBAAiB,CAAC;AAGhC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/vasu-playwright-lib/utils/index.js

@@ -1,13 +1,9 @@
 "use strict";
-// utils/index.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-// Export everything from ActionUtils.ts
 tslib_1.__exportStar(require("./action-utils"), exports);
-// Export everything from ElementUtils.ts
+tslib_1.__exportStar(require("./assert-utils"), exports);
 tslib_1.__exportStar(require("./element-utils"), exports);
-// Export everything from LocatorUtils.ts
 tslib_1.__exportStar(require("./locator-utils"), exports);
-// Export everything from PageUtils.ts
 tslib_1.__exportStar(require("./page-utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/vasu-playwright-lib/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/index.ts"],"names":[],"mappings":";AAAA,iBAAiB;;;AAEjB,wCAAwC;AACxC,yDAA+B;AAE/B,yCAAyC;AACzC,0DAAgC;AAEhC,yCAAyC;AACzC,0DAAgC;AAEhC,sCAAsC;AACtC,uDAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/vasu-playwright-lib/utils/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,yDAA+B;AAC/B,0DAAgC;AAChC,0DAAgC;AAChC,uDAA6B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vasu-playwright-utils",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Playwright Typescript Library with reusable utilities",
   "main": "./dist/vasu-playwright-lib/index.js",
   "types": "./dist/vasu-playwright-lib/index.d.ts",