transit-core-taf 1.0.4 → 1.0.5

package/dist/transit-core-taf/global-setup.js

@@ -0,0 +1,103 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const dotenv = __importStar(require("dotenv"));
+const path_1 = __importDefault(require("path"));
+const fs = __importStar(require("fs"));
+// Function to find the project root
+const findProjectRoot = (startPath) => {
+    let currentPath = startPath;
+    while (currentPath !== path_1.default.parse(currentPath).root) {
+        if (fs.existsSync(path_1.default.join(currentPath, 'package.json'))) {
+            return currentPath;
+        }
+        currentPath = path_1.default.dirname(currentPath);
+    }
+    return startPath; // Fallback to the original directory if not found
+};
+async function globalSetup() {
+    const env = process.env.ENV || 'stage';
+    const projectRoot = path_1.default.resolve(__dirname, '..');
+    const envPath = path_1.default.join(projectRoot, `.env.${env}`);
+    // Load env file
+    if (fs.existsSync(envPath)) {
+        dotenv.config({ path: envPath, override: true });
+        console.log(`✅ Loaded ${envPath} from project root ${projectRoot} ✅`);
+    }
+    else {
+        throw new Error(`❌ Environment file .env.${env} not found in project root ${projectRoot} ❌`);
+    }
+    const argv = process.argv;
+    // Find all arguments related to project selection
+    const projectArgs = argv.map((arg, i) => {
+        if (arg === '--project' && i + 1 < argv.length) {
+            return argv[i + 1];
+        }
+        if (arg.startsWith('--project=')) {
+            return arg.split('=')[1];
+        }
+        return null;
+    }).filter(p => p !== null);
+    let runAuth = false;
+    if (projectArgs.length > 0) {
+        // --project flag is used. Only run if 'api-tests' is specified.
+        if (projectArgs.includes('api-tests')) {
+            runAuth = true;
+        }
+    }
+    else {
+        // No --project flag. Check for test path arguments.
+        const testCommandIndex = argv.indexOf('test');
+        const argsAfterTest = testCommandIndex !== -1 ? argv.slice(testCommandIndex + 1) : [];
+        const pathArgs = argsAfterTest.filter(arg => !arg.startsWith('-'));
+        if (pathArgs.length === 0) {
+            // No path arguments, so it's a full run.
+            runAuth = true;
+        }
+        else {
+            // Path arguments are present. Check if any are in the api-tests directory.
+            if (pathArgs.some(p => p.startsWith('tests/api-tests'))) {
+                runAuth = true;
+            }
+        }
+    }
+    if (runAuth) {
+        console.log('Global setup for api-tests is running...');
+    }
+}
+exports.default = globalSetup;

package/dist/transit-core-taf/index.d.ts

@@ -0,0 +1,11 @@
+export * from './baseui/basepagevalidations';
+export * from './baseui/basepageactions';
+export * from './baseui/basepagewaits';
+export * from './baseui/commonpageactions';
+export * from './baseui/commonpagevalidations';
+export * from './baseui/commonpagewaits';
+export * from './baseui/logger';
+export * from './utils/Utils';
+export * from './baseapi/baseapihelpers';
+export * from './baseapi/apiutils';
+export * from './constants/test-tags';

package/dist/transit-core-taf/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./baseui/basepagevalidations"), exports);
+__exportStar(require("./baseui/basepageactions"), exports);
+__exportStar(require("./baseui/basepagewaits"), exports);
+__exportStar(require("./baseui/commonpageactions"), exports);
+__exportStar(require("./baseui/commonpagevalidations"), exports);
+__exportStar(require("./baseui/commonpagewaits"), exports);
+__exportStar(require("./baseui/logger"), exports);
+__exportStar(require("./utils/Utils"), exports);
+__exportStar(require("./baseapi/baseapihelpers"), exports);
+__exportStar(require("./baseapi/apiutils"), exports);
+__exportStar(require("./constants/test-tags"), exports);

package/dist/transit-core-taf/utils/Utils.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Generates a random alphanumeric string of specified length.
+ * @param {number} length - The number of characters in the generated string.
+ * @returns {string} - Randomly generated string.
+ */
+export declare function generateRandomString(length: number): string;
+/**
+ * Generates a random first name.
+ * @returns A random first name.
+ */
+export declare function generateFirstName(): string;
+/**
+ * Generates a random last name.
+ * @returns A random last name.
+ */
+export declare function generateLastName(): string;
+/**
+ * Generates a random household name.
+ * @returns A random household name, typically in the format "[LastName] Household".
+ */
+export declare function generateHouseholdName(): string;
+/**
+ * Generates a dynamic US address.
+ * @returns An object containing a full US address.
+ */
+export declare function generateUSAddress(): {
+    streetAddressLine1: string;
+    streetAddressLine2: string;
+    city: string;
+    state: string;
+    zipCode: string;
+    country: string;
+};
+/**
+ * Generates a random phone number for a given country.
+ * @param country - The country for which to generate the phone number.
+ * @returns A random phone number.
+ */
+export declare function generatePhoneNumber(country: string): string;
+/**
+ * Generates a random email address with the yopmail.com domain.
+ * @returns A random email address.
+ */
+export declare function generateYopmailEmail(): string;
+/**
+ * Returns the current timestamp.
+ * @returns The current timestamp in milliseconds.
+ */
+export declare function getTimestamp(): number;
+/**
+ * Calculates the time difference between two timestamps and returns a formatted string.
+ * @param startTime - The starting timestamp in milliseconds.
+ * @param endTime - The ending timestamp in milliseconds.
+ * @returns A formatted string like "5 sec 34 ms".
+ */
+export declare function getTimeDifference(startTime: number, endTime: number): string;
+export declare function readAccountApiResponse(accountId: string): any;
+/**
+ * Generates a random integer between 0 (inclusive) and the given length (exclusive).
+ * @param {number} length - The upper bound (non-inclusive) for the random number.
+ *                          If less than or equal to 0, the function returns 0.
+ * @returns {number} A random integer between 0 and length - 1, or 0 if length <= 0.
+ */
+export declare function getRandomNumber(length: number): number;
+/**
+ * Generates a random future date.
+ * @returns An object containing the day, month, and year of a random future date.
+ */
+export declare function generateRandomFutureDate(): {
+    day: number;
+    month: number;
+    year: number;
+};
+/**
+ * @description
+ * This function provides flexible date formatting similar to moment.js.
+ * It supports both padded (e.g., 03) and unpadded (e.g., 3) date/time tokens.
+ * Ideal for logs, filenames, UI display, or readable timestamps.
+ *
+ * 🧩 Supported format tokens:
+ *  ┌────────┬────────────────────────────┐
+ *  │ Token  │ Description                │
+ *  ├────────┼────────────────────────────┤
+ *  │ YYYY   │ 4-digit year (e.g. 2025)  │
+ *  │ M      │ Month (1–12)               │
+ *  │ MM     │ Month (01–12)              │
+ *  │ D      │ Day of month (1–31)        │
+ *  │ DD     │ Day of month (01–31)       │
+ *  │ h      │ Hour (0–23)                │
+ *  │ hh     │ Hour (00–23)               │
+ *  │ m      │ Minute (0–59)              │
+ *  │ mm     │ Minute (00–59)             │
+ *  │ s      │ Second (0–59)              │
+ *  │ ss     │ Second (00–59)             │
+ *  └────────┴────────────────────────────┘
+ *
+ * @examples
+ *  getDate("YYYY-MM-DD hh:mm:ss") → "2025-11-03 04:05:09"
+ *  getDate("YYYY-M-D h:m:s")     → "2025-11-3 4:5:9"
+ *  getDate("D/M/YYYY")           → "3/11/2025"
+ *
+ * @param format - (Optional) The desired date format string. Defaults to "YYYY-MM-DD".
+ * @returns A formatted date/time string.
+ */
+export declare function getDate(format?: string): string;
+/**
+ * Normalizes a date input to a timestamp (ms since epoch).
+ * - If input is a string, it will be parsed with Date.parse().
+ * - If input is a number (timestamp), it will be used directly.
+ *
+ * @param input Date as a timestamp (ms) or string
+ * @returns timestamp in milliseconds
+ */
+export declare function getParsedDate(input: number | string | null | undefined): number;

package/dist/transit-core-taf/utils/Utils.js

@@ -0,0 +1,219 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateRandomString = generateRandomString;
+exports.generateFirstName = generateFirstName;
+exports.generateLastName = generateLastName;
+exports.generateHouseholdName = generateHouseholdName;
+exports.generateUSAddress = generateUSAddress;
+exports.generatePhoneNumber = generatePhoneNumber;
+exports.generateYopmailEmail = generateYopmailEmail;
+exports.getTimestamp = getTimestamp;
+exports.getTimeDifference = getTimeDifference;
+exports.readAccountApiResponse = readAccountApiResponse;
+exports.getRandomNumber = getRandomNumber;
+exports.generateRandomFutureDate = generateRandomFutureDate;
+exports.getDate = getDate;
+exports.getParsedDate = getParsedDate;
+const faker_1 = require("@faker-js/faker");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Generates a random alphanumeric string of specified length.
+ * @param {number} length - The number of characters in the generated string.
+ * @returns {string} - Randomly generated string.
+ */
+function generateRandomString(length) {
+    // Define the characters to choose from: uppercase, lowercase, and digits
+    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    let result = ''; // Initialize the result string
+    const charsLength = chars.length; // Total number of characters available
+    // Loop 'length' times to build the result string
+    for (let i = 0; i < length; i++) {
+        // Pick a random index and append the corresponding character to the result
+        result += chars.charAt(Math.floor(Math.random() * charsLength));
+    }
+    return result; // Return the generated string
+}
+/**
+ * Generates a random first name.
+ * @returns A random first name.
+ */
+function generateFirstName() {
+    const firstName = faker_1.faker.person.firstName();
+    return firstName;
+}
+/**
+ * Generates a random last name.
+ * @returns A random last name.
+ */
+function generateLastName() {
+    const lastName = faker_1.faker.person.lastName();
+    return lastName;
+}
+/**
+ * Generates a random household name.
+ * @returns A random household name, typically in the format "[LastName] Household".
+ */
+function generateHouseholdName() {
+    const householdName = `${faker_1.faker.person.lastName()} Household`;
+    console.log(`Generated household name: ${householdName}`);
+    return householdName;
+}
+/**
+ * Generates a dynamic US address.
+ * @returns An object containing a full US address.
+ */
+function generateUSAddress() {
+    const state = faker_1.faker.location.state({ abbreviated: true });
+    const city = faker_1.faker.location.city();
+    const zipCode = faker_1.faker.location.zipCode();
+    const streetAddress = faker_1.faker.location.streetAddress();
+    const secondaryAddress = faker_1.faker.location.secondaryAddress();
+    console.log(`Generated US address: ${streetAddress}, ${secondaryAddress}, ${city}, ${state} ${zipCode}`);
+    return {
+        streetAddressLine1: streetAddress,
+        streetAddressLine2: secondaryAddress,
+        city,
+        state,
+        zipCode,
+        country: 'United States',
+    };
+}
+/**
+ * Generates a random phone number for a given country.
+ * @param country - The country for which to generate the phone number.
+ * @returns A random phone number.
+ */
+function generatePhoneNumber(country) {
+    // Note: Faker's phone number generation is not strictly country-specific for all locales.
+    // It generates a number in a format common to the locale.
+    return faker_1.faker.phone.number();
+}
+/**
+ * Generates a random email address with the yopmail.com domain.
+ * @returns A random email address.
+ */
+function generateYopmailEmail() {
+    return `${faker_1.faker.internet.userName()}@yopmail.com`;
+}
+/**
+ * Returns the current timestamp.
+ * @returns The current timestamp in milliseconds.
+ */
+function getTimestamp() {
+    return Date.now();
+}
+/**
+ * Calculates the time difference between two timestamps and returns a formatted string.
+ * @param startTime - The starting timestamp in milliseconds.
+ * @param endTime - The ending timestamp in milliseconds.
+ * @returns A formatted string like "5 sec 34 ms".
+ */
+function getTimeDifference(startTime, endTime) {
+    const diff = endTime - startTime;
+    const seconds = Math.floor(diff / 1000);
+    const milliseconds = diff % 1000;
+    return `${seconds} sec ${milliseconds}ms`;
+}
+function readAccountApiResponse(accountId) {
+    try {
+        const filePath = path_1.default.join(__dirname, `../resources/apiresponses/accounts/${process.env.ENV}/${accountId}.json`);
+        const fileContent = fs_1.default.readFileSync(filePath, 'utf-8');
+        return JSON.parse(fileContent);
+    }
+    catch (error) {
+        console.error(`Error loading account API response for accountId: ${accountId}`, error);
+        throw new Error(`Could not find or load API response for accountId: ${accountId}`);
+    }
+}
+/**
+ * Generates a random integer between 0 (inclusive) and the given length (exclusive).
+ * @param {number} length - The upper bound (non-inclusive) for the random number.
+ *                          If less than or equal to 0, the function returns 0.
+ * @returns {number} A random integer between 0 and length - 1, or 0 if length <= 0.
+ */
+function getRandomNumber(length) {
+    if (length <= 0)
+        return 0;
+    return Math.floor(Math.random() * length);
+}
+/**
+ * Generates a random future date.
+ * @returns An object containing the day, month, and year of a random future date.
+ */
+function generateRandomFutureDate() {
+    const today = new Date();
+    const futureDate = new Date(today);
+    futureDate.setDate(today.getDate() + Math.floor(Math.random() * 365) + 1);
+    return {
+        day: futureDate.getDate(),
+        month: futureDate.getMonth() + 1,
+        year: futureDate.getFullYear(),
+    };
+}
+/**
+ * @description
+ * This function provides flexible date formatting similar to moment.js.
+ * It supports both padded (e.g., 03) and unpadded (e.g., 3) date/time tokens.
+ * Ideal for logs, filenames, UI display, or readable timestamps.
+ *
+ * 🧩 Supported format tokens:
+ *  ┌────────┬────────────────────────────┐
+ *  │ Token  │ Description                │
+ *  ├────────┼────────────────────────────┤
+ *  │ YYYY   │ 4-digit year (e.g. 2025)  │
+ *  │ M      │ Month (1–12)               │
+ *  │ MM     │ Month (01–12)              │
+ *  │ D      │ Day of month (1–31)        │
+ *  │ DD     │ Day of month (01–31)       │
+ *  │ h      │ Hour (0–23)                │
+ *  │ hh     │ Hour (00–23)               │
+ *  │ m      │ Minute (0–59)              │
+ *  │ mm     │ Minute (00–59)             │
+ *  │ s      │ Second (0–59)              │
+ *  │ ss     │ Second (00–59)             │
+ *  └────────┴────────────────────────────┘
+ *
+ * @examples
+ *  getDate("YYYY-MM-DD hh:mm:ss") → "2025-11-03 04:05:09"
+ *  getDate("YYYY-M-D h:m:s")     → "2025-11-3 4:5:9"
+ *  getDate("D/M/YYYY")           → "3/11/2025"
+ *
+ * @param format - (Optional) The desired date format string. Defaults to "YYYY-MM-DD".
+ * @returns A formatted date/time string.
+ */
+function getDate(format = "YYYY-MM-DD") {
+    const date = new Date();
+    const parts = {
+        YYYY: date.getFullYear().toString(),
+        M: (date.getMonth() + 1).toString(),
+        MM: String(date.getMonth() + 1).padStart(2, "0"),
+        D: date.getDate().toString(),
+        DD: String(date.getDate()).padStart(2, "0"),
+        h: date.getHours().toString(),
+        hh: String(date.getHours()).padStart(2, "0"),
+        m: date.getMinutes().toString(),
+        mm: String(date.getMinutes()).padStart(2, "0"),
+        s: date.getSeconds().toString(),
+        ss: String(date.getSeconds()).padStart(2, "0"),
+    };
+    return format.replace(/(YYYY|MM|M|DD|D|hh|h|mm|m|ss|s)/g, (token) => parts[token]);
+}
+/**
+ * Normalizes a date input to a timestamp (ms since epoch).
+ * - If input is a string, it will be parsed with Date.parse().
+ * - If input is a number (timestamp), it will be used directly.
+ *
+ * @param input Date as a timestamp (ms) or string
+ * @returns timestamp in milliseconds
+ */
+function getParsedDate(input) {
+    if (input == null)
+        return NaN;
+    if (typeof input === "number")
+        return input;
+    return Date.parse(input);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transit-core-taf",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Transit Core Automation Framework",
   "main": "dist/transit-core-taf/index.js",
   "types": "dist/transit-core-taf/index.d.ts",
@@ -8,6 +8,7 @@
     "dist/transit-core-taf"
   ],
   "devDependencies": {
+    "@cucumber/cucumber": "^11.3.0",
     "@faker-js/faker": "^9.9.0",
     "@playwright/test": "^1.54.1",
     "@types/node": "^24.3.1",
@@ -15,6 +16,7 @@
     "@types/pngjs": "^6.0.5",
     "dotenv": "^16.6.1",
     "npm-run-all": "^4.1.5",
+    "ts-node": "^10.9.2",
     "typescript": "^5.0.0",
     "xlsx": "^0.18.5"
   },
@@ -22,8 +24,9 @@
     "playwright": "^1.54.1"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test:cucumber": "cucumber-js"
   },
-  "author": "Aurora Core",
+  "author": "Transit Core",
   "license": "ISC"
-}
+}