# suryan-code/frameworkupgrade architecture

> Architecture diagram of the GitHub repository suryan-code/frameworkupgrade, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/suryan-code/frameworkupgrade
- Repository: https://github.com/suryan-code/frameworkupgrade

## Overview

This is a TypeScript/Playwright/Cucumber BDD framework for insurance-platform automation. The primary flow is scenario steps requesting platform/module navigation, isolated browser sessions and authentication, then platform page objects performing business interactions and assertions. It also supports API-driven Guidewire workflows, reusable test data, smart locator resolution, form validation, and result reporting. Several platform/page and reporting links are documented but their implementation was not sampled; those links are shown only where README or indexed references support them.

Main entry points: [`src/core/smartlocator/SmartLocatorEngine.ts`](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/SmartLocatorEngine.ts) (Smart locator), [`src/stepDefinitions`](https://github.com/suryan-code/frameworkupgrade/tree/main/src/stepDefinitions) (Step definitions), [`src/navigation/NavigationManager.ts`](https://github.com/suryan-code/frameworkupgrade/blob/main/src/navigation/NavigationManager.ts) (Navigation manager), [`src/navigation/GenericPlatformNavigator.ts`](https://github.com/suryan-code/frameworkupgrade/blob/main/src/navigation/GenericPlatformNavigator.ts) (Platform navigator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Scenario workflow"]
  node_scenario["BDD scenarios"]
  node_steps["Step definitions"]
  node_support["Cucumber support"]
end

subgraph group_platforms["Platform automation"]
  node_navigation["Navigation manager"]
  node_navigator["Platform navigator"]
  node_registry["Platform registry"]
  node_pages["Platform page objects"]
  node_elements["Page element helpers"]
end

subgraph group_engine["Core engine"]
  node_browser["Browser sessions<br/>[BrowserManager.ts]"]
  node_config["Platform configuration"]
  node_playwright["Playwright engine"]
  node_logger["Logging<br/>[Logger.ts]"]
end

subgraph group_capabilities["Test capabilities"]
  node_datamodel["Insurance data models"]
  node_api["Insurance API workflows"]
  node_smartlocator["Smart locator"]
  node_locatorstrategies["Locator strategies"]
  node_profiles["Locator profiles"]
  node_locatorcache["Locator cache<br/>[LocatorCache.ts]"]
  node_locatorreport["Locator reporting<br/>[LocatorReporter.ts]"]
  node_validation["Form validation"]
  node_reporting["Test result reporting"]
end

node_platforms_external(("Insurance platforms"))

node_scenario -->|"binds steps"| node_steps
node_steps -->|"requests navigation"| node_navigation
node_support -->|"wires lifecycle"| node_browser
node_navigation -->|"gets sessions"| node_browser
node_navigation -->|"loads platform config"| node_config
node_navigation -->|"dispatches navigation"| node_navigator
node_navigator -->|"authenticates and navigates"| node_platforms_external
node_navigator -.->|"selects page implementation"| node_registry
node_registry -.->|"resolves page objects"| node_pages
node_pages -->|"uses interaction helpers"| node_elements
node_pages -.->|"uses test data"| node_datamodel
node_steps -->|"runs API steps"| node_api
node_api -.->|"calls platform APIs"| node_platforms_external
node_smartlocator -->|"loads profile"| node_profiles
node_smartlocator -->|"resolves strategy"| node_locatorstrategies
node_smartlocator -->|"reads and writes cache"| node_locatorcache
node_smartlocator -->|"records resolutions"| node_locatorreport
node_locatorstrategies -->|"queries page controls"| node_platforms_external
node_steps -->|"runs validation steps"| node_validation
node_support -.->|"publishes test results"| node_reporting
node_playwright -->|"logs page events"| node_logger

click node_steps "https://github.com/suryan-code/frameworkupgrade/tree/main/src/stepDefinitions"
click node_support "https://github.com/suryan-code/frameworkupgrade/tree/main/src/support"
click node_navigation "https://github.com/suryan-code/frameworkupgrade/blob/main/src/navigation/NavigationManager.ts"
click node_navigator "https://github.com/suryan-code/frameworkupgrade/blob/main/src/navigation/GenericPlatformNavigator.ts"
click node_registry "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/platform/PlatformRegistry.ts"
click node_pages "https://github.com/suryan-code/frameworkupgrade/tree/main/src/pages"
click node_elements "https://github.com/suryan-code/frameworkupgrade/tree/main/src/pageElements"
click node_browser "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/browser/BrowserManager.ts"
click node_config "https://github.com/suryan-code/frameworkupgrade/tree/main/src/core/config"
click node_playwright "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/engine/playwrightEngine.ts"
click node_logger "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/logger/Logger.ts"
click node_datamodel "https://github.com/suryan-code/frameworkupgrade/tree/main/src/datamodel/guidewire"
click node_api "https://github.com/suryan-code/frameworkupgrade/tree/main/src/stepDefinitions/guidewire"
click node_smartlocator "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/SmartLocatorEngine.ts"
click node_locatorstrategies "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/LocatorStrategyEngine.ts"
click node_profiles "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/ApplicationProfileManager.ts"
click node_locatorcache "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/LocatorCache.ts"
click node_locatorreport "https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/LocatorReporter.ts"
click node_validation "https://github.com/suryan-code/frameworkupgrade/blob/main/src/stepDefinitions/formsValidation/FormValidationSteps.ts"
click node_reporting "https://github.com/suryan-code/frameworkupgrade/tree/main/src/core/reporting"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_scenario,node_steps,node_support toneBlue
class node_navigation,node_navigator,node_registry,node_pages,node_elements toneAmber
class node_browser,node_config,node_playwright,node_logger toneMint
class node_datamodel,node_api,node_smartlocator,node_locatorstrategies,node_profiles,node_locatorcache,node_locatorreport,node_validation,node_reporting toneRose
class node_platforms_external toneIndigo
```

## Components

### Scenario workflow

- **BDD scenarios**
- [Step definitions](https://github.com/suryan-code/frameworkupgrade/tree/main/src/stepDefinitions): `src/stepDefinitions`
- [Cucumber support](https://github.com/suryan-code/frameworkupgrade/tree/main/src/support): `src/support`

### Platform automation

- [Navigation manager](https://github.com/suryan-code/frameworkupgrade/blob/main/src/navigation/NavigationManager.ts): `src/navigation/NavigationManager.ts`
- [Platform navigator](https://github.com/suryan-code/frameworkupgrade/blob/main/src/navigation/GenericPlatformNavigator.ts): `src/navigation/GenericPlatformNavigator.ts`
- [Platform registry](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/platform/PlatformRegistry.ts): `src/core/platform/PlatformRegistry.ts`
- [Platform page objects](https://github.com/suryan-code/frameworkupgrade/tree/main/src/pages): `src/pages`
- [Page element helpers](https://github.com/suryan-code/frameworkupgrade/tree/main/src/pageElements): `src/pageElements`

### Core engine

- [Browser sessions](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/browser/BrowserManager.ts): `src/core/browser/BrowserManager.ts`
- [Platform configuration](https://github.com/suryan-code/frameworkupgrade/tree/main/src/core/config): `src/core/config`
- [Playwright engine](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/engine/playwrightEngine.ts): `src/core/engine/playwrightEngine.ts`
- [Logging](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/logger/Logger.ts): `src/core/logger/Logger.ts`

### Test capabilities

- [Insurance data models](https://github.com/suryan-code/frameworkupgrade/tree/main/src/datamodel/guidewire): `src/datamodel/guidewire`
- [Insurance API workflows](https://github.com/suryan-code/frameworkupgrade/tree/main/src/stepDefinitions/guidewire): `src/stepDefinitions/guidewire`
- [Smart locator](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/SmartLocatorEngine.ts): `src/core/smartlocator/SmartLocatorEngine.ts`
- [Locator strategies](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/LocatorStrategyEngine.ts): `src/core/smartlocator/LocatorStrategyEngine.ts`
- [Locator profiles](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/ApplicationProfileManager.ts): `src/core/smartlocator/ApplicationProfileManager.ts`
- [Locator cache](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/LocatorCache.ts): `src/core/smartlocator/LocatorCache.ts`
- [Locator reporting](https://github.com/suryan-code/frameworkupgrade/blob/main/src/core/smartlocator/LocatorReporter.ts): `src/core/smartlocator/LocatorReporter.ts`
- [Form validation](https://github.com/suryan-code/frameworkupgrade/blob/main/src/stepDefinitions/formsValidation/FormValidationSteps.ts): `src/stepDefinitions/formsValidation/FormValidationSteps.ts`
- [Test result reporting](https://github.com/suryan-code/frameworkupgrade/tree/main/src/core/reporting): `src/core/reporting`

### Other components

- **Insurance platforms**

## Connections

- BDD scenarios → Step definitions: binds steps (evidence: `README.md`)
- Step definitions → Navigation manager: requests navigation (evidence: `README.md`)
- Cucumber support → Browser sessions: wires lifecycle (evidence: `README.md`)
- Navigation manager → Browser sessions: gets sessions (evidence: `src/navigation/NavigationManager.ts`)
- Navigation manager → Platform configuration: loads platform config (evidence: `src/navigation/NavigationManager.ts`)
- Navigation manager → Platform navigator: dispatches navigation (evidence: `src/navigation/NavigationManager.ts`)
- Platform navigator → Insurance platforms: authenticates and navigates (evidence: `README.md`)
- Platform navigator → Platform registry: selects page implementation (evidence: `README.md`)
- Platform registry → Platform page objects: resolves page objects (evidence: `README.md`)
- Platform page objects → Page element helpers: uses interaction helpers (evidence: `src/pages/guidewire/basePage.ts`)
- Platform page objects → Insurance data models: uses test data
- Step definitions → Insurance API workflows: runs API steps (evidence: `README.md`)
- Insurance API workflows → Insurance platforms: calls platform APIs (evidence: `README.md`)
- Smart locator → Locator profiles: loads profile (evidence: `src/core/smartlocator/SmartLocatorEngine.ts`)
- Smart locator → Locator strategies: resolves strategy (evidence: `src/core/smartlocator/SmartLocatorEngine.ts`)
- Smart locator → Locator cache: reads and writes cache (evidence: `src/core/smartlocator/SmartLocatorEngine.ts`)
- Smart locator → Locator reporting: records resolutions (evidence: `src/core/smartlocator/SmartLocatorEngine.ts`)
- Locator strategies → Insurance platforms: queries page controls (evidence: `src/core/smartlocator/LocatorStrategyEngine.ts`)
- Step definitions → Form validation: runs validation steps (evidence: `src/stepDefinitions/formsValidation/FormValidationSteps.ts`)
- Cucumber support → Test result reporting: publishes test results (evidence: `README.md`)
- Playwright engine → Logging: logs page events (evidence: `src/core/engine/playwrightEngine.ts`)
