# k2workflow/control-dojo architecture

> Architecture diagram of the GitHub repository k2workflow/control-dojo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/k2workflow/control-dojo
- Repository: https://github.com/k2workflow/control-dojo

## Overview

Control Dojo is a browser-based Nintex K2 custom-control workbench. Users can inspect existing controls in design-time and runtime previews, adjust properties and events, and export controls; alternatively, the wizard gathers control configuration and generates a starter package. The app also provides a home screen and rendered documentation. The README documents backend file, ZIP, control-list, and documentation APIs. Source excerpts confirm several component calls, but do not show all frontend-to-API wiring, so those relationships are omitted or marked unverified.

Main entry points: [`src/components/Inspector.vue`](https://github.com/k2workflow/control-dojo/blob/main/src/components/Inspector.vue) (Control Inspector), [`src/App.vue`](https://github.com/k2workflow/control-dojo/blob/main/src/App.vue) (Tab Shell), [`server.js`](https://github.com/k2workflow/control-dojo/blob/main/server.js) (Express API), [`src/components/Wizard.vue`](https://github.com/k2workflow/control-dojo/blob/main/src/components/Wizard.vue) (Starter Wizard)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Workbench UI"]
  node_entry["Vue App Entry<br/>[main.js]"]
  node_shell["Tab Shell<br/>[App.vue]"]
  node_home["Home Overview<br/>[Home.vue]"]
  node_inspector["Control Inspector<br/>[Inspector.vue]"]
  node_validation["Error Popup"]
  node_documents["Documentation Viewer<br/>[Documents.vue]"]
end

subgraph group_create["Control Creation"]
  node_wizard["Starter Wizard<br/>[Wizard.vue]"]
  node_generator["File Generator<br/>[file-generator.js]"]
end

subgraph group_backend["File And Docs APIs"]
  node_server["Express API<br/>[server.js]"]
  node_controlindex[("Control Catalog<br/>[index.json]")]
  node_docsfiles["Guides"]
end

subgraph group_examples["Example Controls"]
  node_arabic["Arabic Calendar<br/>[runtime_logic.js]"]
  node_buttonlist["Button List<br/>[runtime_logic.js]"]
  node_captcha["CAPTCHA Box<br/>[runtime_logic.js]"]
  node_dragdrop["Drag And Drop<br/>[runtime_logic.js]"]
end

subgraph group_runtime["K2 Runtime Layer"]
  node_k2base["Base Control API<br/>[k2-base-control.js]"]
  node_k2api["K2 Controls API<br/>[K2ControlsAPI.js]"]
end

node_user(("Control Developer"))

node_user -->|"opens workbench"| node_entry
node_entry -->|"mounts"| node_shell
node_shell -->|"renders tab"| node_home
node_shell -->|"renders tab"| node_inspector
node_shell -->|"renders tab"| node_wizard
node_shell -->|"renders tab"| node_documents
node_inspector -->|"uses popup"| node_validation
node_wizard -->|"imports generator"| node_generator
node_generator -->|"posts generated files"| node_server
node_server -->|"reads catalog"| node_controlindex
node_server -->|"serves guides"| node_docsfiles
node_user -->|"debugs controls"| node_inspector
node_user -->|"builds control"| node_wizard
node_inspector -.->|"previews controls"| node_arabic
node_inspector -.->|"previews controls"| node_buttonlist
node_inspector -.->|"previews controls"| node_captcha
node_inspector -.->|"previews controls"| node_dragdrop

click node_entry "https://github.com/k2workflow/control-dojo/blob/main/src/main.js"
click node_shell "https://github.com/k2workflow/control-dojo/blob/main/src/App.vue"
click node_home "https://github.com/k2workflow/control-dojo/blob/main/src/components/Home.vue"
click node_inspector "https://github.com/k2workflow/control-dojo/blob/main/src/components/Inspector.vue"
click node_validation "https://github.com/k2workflow/control-dojo/blob/main/src/components/ValidationErrorPopup.vue"
click node_wizard "https://github.com/k2workflow/control-dojo/blob/main/src/components/Wizard.vue"
click node_generator "https://github.com/k2workflow/control-dojo/blob/main/src/utils/file-generator.js"
click node_documents "https://github.com/k2workflow/control-dojo/blob/main/src/components/Documents.vue"
click node_server "https://github.com/k2workflow/control-dojo/blob/main/server.js"
click node_controlindex "https://github.com/k2workflow/control-dojo/blob/main/Controls/index.json"
click node_docsfiles "https://github.com/k2workflow/control-dojo/tree/main/docs"
click node_arabic "https://github.com/k2workflow/control-dojo/blob/main/Controls/Arabic%20Calendar/runtime_logic.js"
click node_buttonlist "https://github.com/k2workflow/control-dojo/blob/main/Controls/Button%20List/runtime_logic.js"
click node_captcha "https://github.com/k2workflow/control-dojo/blob/main/Controls/CAPTCHA%20Box/runtime_logic.js"
click node_dragdrop "https://github.com/k2workflow/control-dojo/blob/main/Controls/Drag%20and%20Drop/runtime_logic.js"
click node_k2base "https://github.com/k2workflow/control-dojo/blob/main/loaders/Script/k2-base-control.js"
click node_k2api "https://github.com/k2workflow/control-dojo/blob/main/loaders/Script/K2ControlsAPI.js"

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_entry,node_shell,node_home,node_inspector,node_validation,node_documents toneBlue
class node_wizard,node_generator toneAmber
class node_server,node_controlindex,node_docsfiles toneMint
class node_arabic,node_buttonlist,node_captcha,node_dragdrop toneRose
class node_k2base,node_k2api,node_user toneIndigo
```

## Components

### Workbench UI

- [Vue App Entry](https://github.com/k2workflow/control-dojo/blob/main/src/main.js): `src/main.js`
- [Tab Shell](https://github.com/k2workflow/control-dojo/blob/main/src/App.vue): `src/App.vue`
- [Home Overview](https://github.com/k2workflow/control-dojo/blob/main/src/components/Home.vue): `src/components/Home.vue`
- [Control Inspector](https://github.com/k2workflow/control-dojo/blob/main/src/components/Inspector.vue): `src/components/Inspector.vue`
- [Error Popup](https://github.com/k2workflow/control-dojo/blob/main/src/components/ValidationErrorPopup.vue): `src/components/ValidationErrorPopup.vue`
- [Documentation Viewer](https://github.com/k2workflow/control-dojo/blob/main/src/components/Documents.vue): `src/components/Documents.vue`

### Control Creation

- [Starter Wizard](https://github.com/k2workflow/control-dojo/blob/main/src/components/Wizard.vue): `src/components/Wizard.vue`
- [File Generator](https://github.com/k2workflow/control-dojo/blob/main/src/utils/file-generator.js): `src/utils/file-generator.js`

### File And Docs APIs

- [Express API](https://github.com/k2workflow/control-dojo/blob/main/server.js): `server.js`
- [Control Catalog](https://github.com/k2workflow/control-dojo/blob/main/Controls/index.json): `Controls/index.json`
- [Guides](https://github.com/k2workflow/control-dojo/tree/main/docs): `docs`

### Example Controls

- [Arabic Calendar](https://github.com/k2workflow/control-dojo/blob/main/Controls/Arabic%20Calendar/runtime_logic.js): `Controls/Arabic Calendar/runtime_logic.js`
- [Button List](https://github.com/k2workflow/control-dojo/blob/main/Controls/Button%20List/runtime_logic.js): `Controls/Button List/runtime_logic.js`
- [CAPTCHA Box](https://github.com/k2workflow/control-dojo/blob/main/Controls/CAPTCHA%20Box/runtime_logic.js): `Controls/CAPTCHA Box/runtime_logic.js`
- [Drag And Drop](https://github.com/k2workflow/control-dojo/blob/main/Controls/Drag%20and%20Drop/runtime_logic.js): `Controls/Drag and Drop/runtime_logic.js`

### K2 Runtime Layer

- [Base Control API](https://github.com/k2workflow/control-dojo/blob/main/loaders/Script/k2-base-control.js): `loaders/Script/k2-base-control.js`
- [K2 Controls API](https://github.com/k2workflow/control-dojo/blob/main/loaders/Script/K2ControlsAPI.js): `loaders/Script/K2ControlsAPI.js`

### Other components

- **Control Developer**

## Connections

- Control Developer → Vue App Entry: opens workbench (evidence: `README.md`)
- Vue App Entry → Tab Shell: mounts (evidence: `src/main.js`)
- Tab Shell → Home Overview: renders tab (evidence: `src/App.vue`)
- Tab Shell → Control Inspector: renders tab (evidence: `src/App.vue`)
- Tab Shell → Starter Wizard: renders tab (evidence: `src/App.vue`)
- Tab Shell → Documentation Viewer: renders tab (evidence: `src/App.vue`)
- Control Inspector → Error Popup: uses popup (evidence: `src/components/Inspector.vue`)
- Starter Wizard → File Generator: imports generator (evidence: `src/components/Wizard.vue`)
- File Generator → Express API: posts generated files (evidence: `src/utils/file-generator.js`)
- Express API → Control Catalog: reads catalog (evidence: `server.js`)
- Express API → Guides: serves guides (evidence: `server.js`)
- Control Developer → Control Inspector: debugs controls (evidence: `README.md`)
- Control Developer → Starter Wizard: builds control (evidence: `README.md`)
- Control Inspector → Arabic Calendar: previews controls
- Control Inspector → Button List: previews controls
- Control Inspector → CAPTCHA Box: previews controls
- Control Inspector → Drag And Drop: previews controls
