# nilavan09/playwright-ui-api-framework architecture

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

- Interactive diagram: https://gitdiagram.com/nilavan09/playwright-ui-api-framework
- Repository: https://github.com/nilavan09/playwright-ui-api-framework

## Overview

This repository is a Playwright/TypeScript UI automation framework for exercising ClickUp, not the ClickUp application itself. Its documented workflows cover login, board and task operations, and workspace navigation; page objects encapsulate browser interactions, while reusable controls and centralized data support task creation and editing. Authentication setup logs in and saves browser state for later use. The excerpts establish the authentication and page-object dependencies shown below; test-spec wiring, custom fixture behavior, and several documented coverage areas were not sampled, so their connections are omitted.

Main entry points: [`auth/auth.setup.ts`](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/auth/auth.setup.ts) (Login Setup), [`pages/task/AddTaskPage.ts`](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/task/AddTaskPage.ts) (Task Creation), [`pages/task/TaskDetailsPage.ts`](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/task/TaskDetailsPage.ts) (Task Details), [`test-data/taskData.ts`](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/test-data/taskData.ts) (Task Data)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_authentication["Authentication"]
  node_auth_setup["Login Setup<br/>[auth.setup.ts]"]
  node_login_page["Login Page<br/>[LoginPage.ts]"]
  node_login_data["Login Data<br/>[loginData.ts]"]
  node_session_state[("Session State<br/>[auth.setup.ts]")]
end

subgraph group_task_workflows["Task Workflows"]
  node_board_page["Project Board"]
  node_add_task["Task Creation<br/>[AddTaskPage.ts]"]
  node_task_details["Task Details<br/>[TaskDetailsPage.ts]"]
end

subgraph group_navigation["Workspace Navigation"]
  node_workspace_page["Workspace Menu<br/>[WorkspacePage.ts]"]
  node_lists_page["Lists Page<br/>[ListPage.ts]"]
  node_spaces_page["Spaces Page<br/>[SpacePage.ts]"]
end

subgraph group_shared["Shared Automation"]
  node_priority_control["Priority Control"]
  node_due_date_control["Due Date Control<br/>[DueDatePicker.ts]"]
  node_task_data["Task Data<br/>[taskData.ts]"]
  node_fixtures["Playwright Fixtures"]
end

node_test_user(("Test User"))
node_clickup["ClickUp"]

node_test_user -->|"starts login"| node_auth_setup
node_auth_setup -->|"uses page object"| node_login_page
node_auth_setup -->|"reads credentials"| node_login_data
node_auth_setup -->|"opens login"| node_clickup
node_auth_setup -->|"saves session"| node_session_state
node_add_task -->|"reads task values"| node_task_data
node_add_task -->|"selects priority"| node_priority_control
node_add_task -->|"selects due date"| node_due_date_control
node_task_details -->|"reads task values"| node_task_data
node_task_details -->|"configures control"| node_priority_control
node_task_details -->|"configures control"| node_due_date_control
node_board_page -->|"reads task name"| node_task_data

click node_auth_setup "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/auth/auth.setup.ts"
click node_login_page "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/authentication/LoginPage.ts"
click node_login_data "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/test-data/loginData.ts"
click node_session_state "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/auth/auth.setup.ts"
click node_board_page "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/project/ProjectBoardPage.ts"
click node_add_task "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/task/AddTaskPage.ts"
click node_task_details "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/task/TaskDetailsPage.ts"
click node_priority_control "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/components/PriorityDropdown.ts"
click node_due_date_control "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/components/DueDatePicker.ts"
click node_task_data "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/test-data/taskData.ts"
click node_workspace_page "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/workspace/WorkspacePage.ts"
click node_lists_page "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/lists/ListPage.ts"
click node_spaces_page "https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/spaces/SpacePage.ts"
click node_fixtures "https://github.com/nilavan09/playwright-ui-api-framework/tree/main/fixtures"

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_auth_setup,node_login_page,node_login_data,node_session_state,node_test_user toneBlue
class node_board_page,node_add_task,node_task_details toneAmber
class node_workspace_page,node_lists_page,node_spaces_page toneMint
class node_priority_control,node_due_date_control,node_task_data,node_fixtures toneRose
class node_clickup toneIndigo
```

## Components

### Authentication

- [Login Setup](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/auth/auth.setup.ts): `auth/auth.setup.ts`
- [Login Page](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/authentication/LoginPage.ts): `pages/authentication/LoginPage.ts`
- [Login Data](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/test-data/loginData.ts): `test-data/loginData.ts`
- [Session State](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/auth/auth.setup.ts): `auth/auth.setup.ts`

### Task Workflows

- [Project Board](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/project/ProjectBoardPage.ts): `pages/project/ProjectBoardPage.ts`
- [Task Creation](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/task/AddTaskPage.ts): `pages/task/AddTaskPage.ts`
- [Task Details](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/task/TaskDetailsPage.ts): `pages/task/TaskDetailsPage.ts`

### Workspace Navigation

- [Workspace Menu](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/workspace/WorkspacePage.ts): `pages/workspace/WorkspacePage.ts`
- [Lists Page](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/lists/ListPage.ts): `pages/lists/ListPage.ts`
- [Spaces Page](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/pages/spaces/SpacePage.ts): `pages/spaces/SpacePage.ts`

### Shared Automation

- [Priority Control](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/components/PriorityDropdown.ts): `components/PriorityDropdown.ts`
- [Due Date Control](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/components/DueDatePicker.ts): `components/DueDatePicker.ts`
- [Task Data](https://github.com/nilavan09/playwright-ui-api-framework/blob/main/test-data/taskData.ts): `test-data/taskData.ts`
- [Playwright Fixtures](https://github.com/nilavan09/playwright-ui-api-framework/tree/main/fixtures): `fixtures`

### Other components

- **Test User**
- **ClickUp**

## Connections

- Test User → Login Setup: starts login (evidence: `auth/auth.setup.ts`)
- Login Setup → Login Page: uses page object (evidence: `auth/auth.setup.ts`)
- Login Setup → Login Data: reads credentials (evidence: `auth/auth.setup.ts`)
- Login Setup → ClickUp: opens login (evidence: `auth/auth.setup.ts`)
- Login Setup → Session State: saves session (evidence: `auth/auth.setup.ts`)
- Task Creation → Task Data: reads task values (evidence: `pages/task/AddTaskPage.ts`)
- Task Creation → Priority Control: selects priority (evidence: `pages/task/AddTaskPage.ts`)
- Task Creation → Due Date Control: selects due date (evidence: `pages/task/AddTaskPage.ts`)
- Task Details → Task Data: reads task values (evidence: `pages/task/TaskDetailsPage.ts`)
- Task Details → Priority Control: configures control (evidence: `pages/task/TaskDetailsPage.ts`)
- Task Details → Due Date Control: configures control (evidence: `pages/task/TaskDetailsPage.ts`)
- Project Board → Task Data: reads task name (evidence: `pages/project/ProjectBoardPage.ts`)
