@zohodesk/testinglibrary 0.0.52-n20-experimental → 0.0.54-n20-experimental

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.0.52-n20-experimental",
+  "version": "0.0.54-n20-experimental",
   "main": "./build/index.js",
   "scripts": {
     "postinstall": "node bin/postinstall.js",
@@ -26,11 +26,13 @@
     "@playwright/test": "1.56.1",
     "@reportportal/agent-js-playwright": "5.2.2",
     "@testing-library/jest-dom": "6.9.1",
-    "babel-jest": "30.2.0",
+    "@zohodesk/unit-testing-framework": "0.0.30-experimental",
+    "babel-jest": "29.7.0",
     "babel-plugin-transform-dynamic-import": "2.1.0",
+    "commander": "14.0.2",
     "fast-glob": "3.3.3",
-    "jest": "30.2.0",
-    "jest-environment-jsdom": "30.2.0",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
     "jsonpath": "1.1.1",
     "msw": "2.11.6",
     "playwright": "1.56.1",
@@ -47,13 +49,15 @@
     "react-dom": "*"
   },
   "devDependencies": {
-    "@babel/cli": "7.28.3",
-    "@babel/core": "7.28.4",
-    "@babel/node": "7.28.0",
+    "@babel/cli": "7.28.6",
+    "@babel/core": "7.29.0",
+    "@babel/node": "7.29.0",
     "@babel/plugin-transform-runtime": "7.28.3",
-    "@babel/preset-env": "7.28.3",
-    "@babel/runtime": "7.28.4",
-    "commander": "14.0.2",
-    "jest-html-reporter": "4.3.0"
+    "@babel/preset-env": "7.29.0",
+    "@babel/preset-react": "7.26.3",
+    "@babel/runtime": "7.28.6",
+    "jest-html-reporter": "4.3.0",
+    "ts-jest": "29.3.2",
+    "@babel/preset-typescript": "7.26.0"
   }
 }

package/AUTO_CLEANUP_PLAN.md

@@ -1,171 +0,0 @@
-# Data Generator System — Design & Current State
-
-## Data Generator Overview
-
-### How It Works
-- BDD step: `Given generate a "{Type}" entity "{name}" with generator "{GeneratorName}"`
-- Framework builds a **global generator index** at first use — scans all `*.generators.json` files under `modules/`
-- Generator names must be **unique across the entire UAT suite**
-- `ZDTestingFramework validate` checks for duplicate generator names before test run
-- Data generated using **org-level OAuth credentials** (org-oauth) by default
-- When scenario runs under a non-admin profile (`@profile_agent`), data generation still uses org-level `data-generator` — falls back automatically if profile has no own credentials
-
-### Generator File Convention
-- **Pattern:** `*.generators.json` (configurable via `generatorFilePattern` in `uat.config.js`)
-- **Location:** anywhere under `modules/` — discovered globally via recursive scan
-- **Examples:** `ticket.generators.json`, `account.generators.json`, `webhook.generators.json`
-
-### Generator JSON Structure
-```json
-{
-    "generators": {
-        "GeneratorName": [
-            {
-                "type": "dynamic",
-                "name": "stepName",
-                "generatorOperationId": "support.Module.operationName",
-                "dataPath": "$.response.body:$",
-                "params": { "key": "$previousStep.value" }
-            }
-        ]
-    }
-}
-```
-
-### Discovery Mechanism
-- **Index-based** — built once, O(1) lookups
-- `#getModulesRoot()` uses `configConstants.TEST_SLICE_FOLDER + stage + 'modules'` (deterministic)
-- Scans recursively for files matching `generatorFilePattern` (default: `*.generators.json`)
-- First generator name match wins (no duplicates enforced by validator)
-
-### Profile Resolution for Data Generation
-- **Default (no `using` profile):** Uses org-level `data-generator` from edition JSON. If scenario profile (e.g., `@profile_agent`) has no `data-generator`, falls back to org-level via `getListOfActors()`.
-- **Explicit profile (`using "agent" profile`):** Resolves that profile's credentials via `getUserForSelectedEditionAndProfile()`.
-
-### Constraints
-| Constraint | Detail |
-|---|---|
-| **Unique generator names** | Generator names must be unique across all `*.generators.json` files |
-| **Global discovery** | Framework scans entire `modules/` tree — generators in any module are accessible from any feature file |
-| **File pattern** | Configurable via `generatorFilePattern` in `uat.config.js` (default: `*.generators.json`) |
-| **DG_API_NAME matching** | In Gherkin data tables, `DG_API_NAME` column matches generator step's `name` field to inject params |
-| **Chained steps** | Multi-step generators use `$previousStep.value` syntax to pass output between steps |
-| **dataPath extraction** | `dataPath` uses JSONPath to extract specific fields from DG service response |
-| **Cached response** | Generated data is cached via `cacheLayer.set(entityName, response.data)` for use in subsequent steps |
-| **Org-level auth fallback** | If profile has no `data-generator`, org-level config from edition JSON is used automatically |
-
----
-
-## Current Generators
-
-| Generator | File | Steps | Used By |
-|---|---|---|---|
-| `TicketWithDepartment` | `Ticket/data-generators/ticket.generators.json` | getDepartments → createProduct → createTicket | 452+ scenarios |
-| `TicketBasic` | `Ticket/data-generators/ticket.generators.json` | getDepartments → createTicket (no product) | Express/Free editions |
-| `CreateAccountRecord` | `Account/data-generators/account.generators.json` | createAccount | 37 scenarios |
-| `CreateContactRecord` | `Contact/data-generators/contact.generators.json` | createContact | 42 scenarios |
-| `CreateContractRecord` | `Contract/DV/Subtabs/*/data-generators/contract.generators.json` | getDepartments → createAccount → createContract | 4 scenarios |
-| `CreateWebhookRecord` | `Webhooks/List/data-generators/webhook.generators.json` | createWebhook (with default subscriptions) | Webhook scenarios |
-| `ProductWithDepartment` | `Search/products/data-generators/products.generators.json` | getDepartments → createProduct | Product/Search scenarios |
-
----
-
-## Auto-Cleanup — Design (Not Yet Implemented)
-
-### Status
-- **V1 implemented then removed** in `0.0.47` — CleanupTracker + DataCleanup were too tightly coupled
-- **V2 planned** — proper redesign needed
-
-### Why Cleanup Was Removed
-1. `cleanupTracker` fixture added complexity to all step definitions (extra parameter)
-2. Cleanup ran inside fixture teardown — failures were hard to debug
-3. REST API cleanup needed auth that wasn't available in the cleanup context
-4. No way to control cleanup order for cross-entity dependencies
-
-### V2 Design Principles
-1. **Cleanup config stays in generator JSON** — `cleanup` property on each step (same as V1)
-2. **Separate cleanup phase** — not in fixture teardown, but as explicit post-scenario hook
-3. **Auth-aware** — cleanup uses the same `actorInfo` that created the data
-4. **Configurable** — cleanup can be disabled per scenario or globally
-5. **Non-blocking** — cleanup failures never fail the test
-
-### Cleanup Types (unchanged from V1 design)
-
-#### Type 1: `oas` — DG service delete
-```json
-"cleanup": {
-    "type": "oas",
-    "operationId": "support.Contact.deleteContact",
-    "idPath": "$.id"
-}
-```
-
-#### Type 2: `api` — Direct REST API DELETE
-```json
-"cleanup": {
-    "type": "api",
-    "method": "DELETE",
-    "apiPath": "/api/v1/contracts/{id}",
-    "idPath": "$.id"
-}
-```
-
-#### Type 3: `api` — Disable via PATCH
-```json
-"cleanup": {
-    "type": "api",
-    "method": "PATCH",
-    "apiPath": "/api/v1/webhooks/{id}",
-    "idPath": "$.id",
-    "body": { "isActive": false }
-}
-```
-
-#### No cleanup — read-only operations
-Steps without `cleanup` property are skipped (e.g., `getDepartments`).
-
-### V2 Implementation Plan
-
-1. **CleanupManager** (replaces CleanupTracker + DataCleanup)
-   - Single class managing both tracking and execution
-   - Runs after scenario via `testSetup` hook (not fixture teardown)
-   - Uses `actorInfo` from the generation step for auth
-
-2. **Config flag** in `uat.config.js`:
-   ```javascript
-   autoCleanup: true,  // default: true
-   cleanupTimeout: 30000  // per-entity timeout
-   ```
-
-3. **Per-scenario opt-out** via tag:
-   ```gherkin
-   @skip_cleanup
-   Scenario: Test that needs data to persist
-   ```
-
-4. **Cleanup order**: reverse of creation (dependent entities first)
-
----
-
-## Seed Data System — Design (Planned)
-
-See `SEED_DATA_PLAN.md` in the consumer repo for the full design.
-
-### Summary
-- **Edition-scoped** — data maps to edition tiers, not portal names
-- **Profile-based** — support creating data as specific profiles (agent login)
-- **OAS + REST** — both API types supported
-- **Runs before scenarios** — in `page.js` fixture after login
-- **Idempotent** — skips existing data, creates only missing
-
----
-
-## Multi-DC Portability — Design (Planned)
-
-See `MULTI_DC_STRATEGY.md` in the consumer repo for the full design.
-
-### Summary
-- **`capability` field** on each portal for DC-agnostic resolution
-- **Department aliases** in portal config for cross-DC mapping
-- **Framework resolves** by `capability` first, `orgName` fallback
-- **Same feature files** work across all DCs

package/build/core/dataGenerator/validateGenerators.js

@@ -1,82 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.validateGenerators = validateGenerators;
-var _path = _interopRequireDefault(require("path"));
-var _fs = _interopRequireDefault(require("fs"));
-var _logger = require("../../utils/logger");
-var _readConfigFile = require("../playwright/readConfigFile");
-function matchesPattern(filename, pattern) {
-  const regex = new RegExp('^' + pattern.replace(/\./g, '\\.').replace(/\*/g, '.*') + '$');
-  return regex.test(filename);
-}
-function findGeneratorFiles(dir, pattern, results = []) {
-  const entries = _fs.default.readdirSync(dir, {
-    withFileTypes: true
-  });
-  for (const entry of entries) {
-    const fullPath = _path.default.join(dir, entry.name);
-    if (entry.isDirectory()) {
-      findGeneratorFiles(fullPath, pattern, results);
-    } else if (matchesPattern(entry.name, pattern)) {
-      results.push(fullPath);
-    }
-  }
-  return results;
-}
-function validateGenerators(modulesRoot) {
-  if (!_fs.default.existsSync(modulesRoot)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Modules directory not found: ${modulesRoot}. Skipping generator validation.`);
-    return {
-      valid: true,
-      duplicates: []
-    };
-  }
-  const {
-    generatorFilePattern: pattern = '*.generators.json'
-  } = (0, _readConfigFile.generateConfigFromFile)();
-  const generatorMap = {};
-  const generatorFiles = findGeneratorFiles(modulesRoot, pattern);
-  for (const filePath of generatorFiles) {
-    try {
-      const data = _fs.default.readFileSync(filePath, 'utf8');
-      const generatorObj = JSON.parse(data);
-      if (generatorObj.generators) {
-        for (const name of Object.keys(generatorObj.generators)) {
-          if (!generatorMap[name]) {
-            generatorMap[name] = [];
-          }
-          generatorMap[name].push(filePath);
-        }
-      }
-    } catch (err) {
-      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Failed to parse generator file: ${filePath} - ${err.message}`);
-    }
-  }
-  const duplicates = Object.entries(generatorMap).filter(([, files]) => files.length > 1).map(([name, files]) => ({
-    name,
-    files
-  }));
-  if (duplicates.length > 0) {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Duplicate generator names found:');
-    for (const dup of duplicates) {
-      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `  Generator "${dup.name}" defined in:`);
-      for (const file of dup.files) {
-        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `    - ${file}`);
-      }
-    }
-    return {
-      valid: false,
-      duplicates
-    };
-  }
-  const generatorCount = Object.keys(generatorMap).length;
-  _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, `Generator validation passed. ${generatorCount} unique generators found across ${generatorFiles.length} generator files.`);
-  return {
-    valid: true,
-    duplicates: []
-  };
-}

package/build/core/playwright/report-generator.js

@@ -1,42 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = generateReport;
-var _child_process = require("child_process");
-var _path = _interopRequireDefault(require("path"));
-var _logger = require("../../utils/logger");
-var _rootPath = require("../../utils/rootPath");
-var _readConfigFile = require("./readConfigFile");
-async function generateReport() {
-  // await preProcessReport()
-  const userArgs = process.argv.slice(3);
-  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
-  const command = playwrightPath;
-  const {
-    reportPath: htmlPath
-  } = (0, _readConfigFile.generateConfigFromFile)();
-  const args = ['show-report', htmlPath].concat(userArgs);
-  const childProcess = (0, _child_process.spawn)(command, args, {
-    stdio: 'inherit'
-  });
-  childProcess.on('error', error => {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
-  });
-  childProcess.on('exit', (code, signal) => {
-    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
-    process.exit();
-  });
-  process.on('exit', () => {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Terminating Playwright Process...');
-    childProcess.kill();
-    return;
-  });
-  process.on('SIGINT', () => {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Cleaning up...');
-    childProcess.kill();
-    process.exit();
-  });
-}