# suraj4127/we-campaign-extension architecture

> Architecture diagram of the GitHub repository suraj4127/we-campaign-extension, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/suraj4127/we-campaign-extension
- Repository: https://github.com/suraj4127/we-campaign-extension

## Overview

We Campaign is a Chrome side-panel extension for creating Push and Email campaigns in WebEngage. Users choose a channel, import and map CSV data, review and validate staged campaign rows, then confirm a run and see progress and results. Shared core modules provide account binding, segment/event data, CSV handling, editing widgets, and run UI; channel-specific modules validate fields and submit campaign requests. The README documents the dynamic channel lifecycle and capabilities; some internal wiring is supported by the source index rather than full excerpts.

Main entry points: [`channels/email/email.controller.js`](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.controller.js) (Email campaign workflow), [`channels/push/push.controller.js`](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.controller.js) (Push campaign workflow), [`app.js`](https://github.com/suraj4127/we-campaign-extension/blob/main/app.js) (Side-panel bootstrap), [`core/app-state.js`](https://github.com/suraj4127/we-campaign-extension/blob/main/core/app-state.js) (Account and auth state)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_shell["Extension shell"]
  node_shell["Side-panel bootstrap<br/>[app.js]"]
  node_menu["Channel menu<br/>[menu.js]"]
  node_registry["Channel registry"]
  node_bridge["Dashboard fetch bridge<br/>[background.js]"]
end

subgraph group_shared["Shared campaign tools"]
  node_state["Account and auth state<br/>[app-state.js]"]
  node_segments["Segments and events<br/>[segments.js]"]
  node_csv["CSV mapping and parsing<br/>[csv.js]"]
  node_dropdowns["Selection widgets<br/>[dropdowns.js]"]
  node_cards["Staged row cards<br/>[campaign-card.js]"]
  node_pagination["List pagination<br/>[pagination.js]"]
  node_runui["Run progress and results<br/>[job-runner-ui.js]"]
end

subgraph group_push["Push campaigns"]
  node_pushcontroller["Push campaign workflow<br/>[push.controller.js]"]
  node_pushfields["Push field schema<br/>[push.fields.js]"]
  node_pushvalidate["Push validation<br/>[push.validate.js]"]
  node_pushapi["Push campaign API<br/>[push.api.js]"]
end

subgraph group_email["Email campaigns"]
  node_emailcontroller["Email campaign workflow"]
  node_emailfields["Email field schema<br/>[email.fields.js]"]
  node_emailvalidate["Email validation<br/>[email.validate.js]"]
  node_emailapi["Email campaign API<br/>[email.api.js]"]
end

node_user(("Campaign user"))
node_dashboard["WebEngage dashboard"]
node_webengage["WebEngage campaign services"]

node_user -->|"opens panel"| node_shell
node_shell -->|"initializes"| node_state
node_shell -->|"renders menu"| node_menu
node_shell -->|"looks up channels"| node_registry
node_menu -->|"lists channels"| node_registry
node_user -->|"chooses channel"| node_menu
node_shell -->|"loads selected channel"| node_pushcontroller
node_shell -->|"loads selected channel"| node_emailcontroller
node_dashboard -->|"provides account context"| node_state
node_state -->|"triggers account data fetch"| node_segments
node_segments -->|"fetches segments and events"| node_webengage
node_pushcontroller -->|"parses upload"| node_csv
node_emailcontroller -->|"maps and parses upload"| node_csv
node_pushcontroller -->|"uses schema"| node_pushfields
node_emailcontroller -->|"uses schema"| node_emailfields
node_pushcontroller -->|"validates rows"| node_pushvalidate
node_emailcontroller -->|"validates rows"| node_emailvalidate
node_pushcontroller -->|"reads segment data"| node_segments
node_emailcontroller -->|"reads segment and event data"| node_segments
node_pushcontroller -->|"renders selectors"| node_dropdowns
node_emailcontroller -->|"renders selectors"| node_dropdowns
node_pushcontroller -->|"renders staged rows"| node_cards
node_emailcontroller -->|"renders staged rows"| node_cards
node_pushcontroller -->|"renders page controls"| node_pagination
node_emailcontroller -->|"renders page controls"| node_pagination
node_emailcontroller -->|"updates run status"| node_runui
node_pushcontroller -->|"runs campaign creation"| node_pushapi
node_emailcontroller -->|"runs campaign creation"| node_emailapi
node_pushapi -->|"uses dashboard fetch"| node_state
node_emailapi -->|"uses dashboard fetch"| node_state
node_pushapi -->|"creates campaigns"| node_webengage
node_emailapi -->|"creates campaigns"| node_webengage

click node_shell "https://github.com/suraj4127/we-campaign-extension/blob/main/app.js"
click node_menu "https://github.com/suraj4127/we-campaign-extension/blob/main/core/menu.js"
click node_registry "https://github.com/suraj4127/we-campaign-extension/blob/main/core/channel-registry.js"
click node_bridge "https://github.com/suraj4127/we-campaign-extension/blob/main/background.js"
click node_state "https://github.com/suraj4127/we-campaign-extension/blob/main/core/app-state.js"
click node_segments "https://github.com/suraj4127/we-campaign-extension/blob/main/core/segments.js"
click node_csv "https://github.com/suraj4127/we-campaign-extension/blob/main/core/csv.js"
click node_dropdowns "https://github.com/suraj4127/we-campaign-extension/blob/main/core/dropdowns.js"
click node_cards "https://github.com/suraj4127/we-campaign-extension/blob/main/core/campaign-card.js"
click node_pagination "https://github.com/suraj4127/we-campaign-extension/blob/main/core/pagination.js"
click node_runui "https://github.com/suraj4127/we-campaign-extension/blob/main/core/job-runner-ui.js"
click node_pushcontroller "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.controller.js"
click node_pushfields "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.fields.js"
click node_pushvalidate "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.validate.js"
click node_pushapi "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.api.js"
click node_emailcontroller "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.controller.js"
click node_emailfields "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.fields.js"
click node_emailvalidate "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.validate.js"
click node_emailapi "https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.api.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_shell,node_menu,node_registry,node_bridge,node_user toneBlue
class node_state,node_segments,node_csv,node_dropdowns,node_cards,node_pagination,node_runui toneAmber
class node_pushcontroller,node_pushfields,node_pushvalidate,node_pushapi toneMint
class node_emailcontroller,node_emailfields,node_emailvalidate,node_emailapi toneRose
class node_dashboard,node_webengage toneIndigo
```

## Components

### Extension shell

- [Side-panel bootstrap](https://github.com/suraj4127/we-campaign-extension/blob/main/app.js): `app.js`
- [Channel menu](https://github.com/suraj4127/we-campaign-extension/blob/main/core/menu.js): `core/menu.js`
- [Channel registry](https://github.com/suraj4127/we-campaign-extension/blob/main/core/channel-registry.js): `core/channel-registry.js`
- [Dashboard fetch bridge](https://github.com/suraj4127/we-campaign-extension/blob/main/background.js): `background.js`

### Shared campaign tools

- [Account and auth state](https://github.com/suraj4127/we-campaign-extension/blob/main/core/app-state.js): `core/app-state.js`
- [Segments and events](https://github.com/suraj4127/we-campaign-extension/blob/main/core/segments.js): `core/segments.js`
- [CSV mapping and parsing](https://github.com/suraj4127/we-campaign-extension/blob/main/core/csv.js): `core/csv.js`
- [Selection widgets](https://github.com/suraj4127/we-campaign-extension/blob/main/core/dropdowns.js): `core/dropdowns.js`
- [Staged row cards](https://github.com/suraj4127/we-campaign-extension/blob/main/core/campaign-card.js): `core/campaign-card.js`
- [List pagination](https://github.com/suraj4127/we-campaign-extension/blob/main/core/pagination.js): `core/pagination.js`
- [Run progress and results](https://github.com/suraj4127/we-campaign-extension/blob/main/core/job-runner-ui.js): `core/job-runner-ui.js`

### Push campaigns

- [Push campaign workflow](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.controller.js): `channels/push/push.controller.js`
- [Push field schema](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.fields.js): `channels/push/push.fields.js`
- [Push validation](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.validate.js): `channels/push/push.validate.js`
- [Push campaign API](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/push/push.api.js): `channels/push/push.api.js`

### Email campaigns

- [Email campaign workflow](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.controller.js): `channels/email/email.controller.js`
- [Email field schema](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.fields.js): `channels/email/email.fields.js`
- [Email validation](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.validate.js): `channels/email/email.validate.js`
- [Email campaign API](https://github.com/suraj4127/we-campaign-extension/blob/main/channels/email/email.api.js): `channels/email/email.api.js`

### Other components

- **Campaign user**
- **WebEngage dashboard**
- **WebEngage campaign services**

## Connections

- Campaign user → Side-panel bootstrap: opens panel (evidence: `README.md`)
- Side-panel bootstrap → Account and auth state: initializes (evidence: `app.js`)
- Side-panel bootstrap → Channel menu: renders menu (evidence: `app.js`)
- Side-panel bootstrap → Channel registry: looks up channels (evidence: `app.js`)
- Channel menu → Channel registry: lists channels (evidence: `core/menu.js`)
- Campaign user → Channel menu: chooses channel (evidence: `README.md`)
- Side-panel bootstrap → Push campaign workflow: loads selected channel (evidence: `README.md`)
- Side-panel bootstrap → Email campaign workflow: loads selected channel (evidence: `README.md`)
- WebEngage dashboard → Account and auth state: provides account context (evidence: `README.md`)
- Account and auth state → Segments and events: triggers account data fetch (evidence: `core/segments.js`)
- Segments and events → WebEngage campaign services: fetches segments and events (evidence: `core/segments.js`)
- Push campaign workflow → CSV mapping and parsing: parses upload (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → CSV mapping and parsing: maps and parses upload (evidence: `channels/email/email.controller.js`)
- Push campaign workflow → Push field schema: uses schema (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → Email field schema: uses schema (evidence: `channels/email/email.controller.js`)
- Push campaign workflow → Push validation: validates rows (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → Email validation: validates rows (evidence: `channels/email/email.controller.js`)
- Push campaign workflow → Segments and events: reads segment data (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → Segments and events: reads segment and event data (evidence: `channels/email/email.controller.js`)
- Push campaign workflow → Selection widgets: renders selectors (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → Selection widgets: renders selectors (evidence: `channels/email/email.controller.js`)
- Push campaign workflow → Staged row cards: renders staged rows (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → Staged row cards: renders staged rows (evidence: `channels/email/email.controller.js`)
- Push campaign workflow → List pagination: renders page controls (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → List pagination: renders page controls (evidence: `channels/email/email.controller.js`)
- Email campaign workflow → Run progress and results: updates run status (evidence: `channels/email/email.controller.js`)
- Push campaign workflow → Push campaign API: runs campaign creation (evidence: `channels/push/push.controller.js`)
- Email campaign workflow → Email campaign API: runs campaign creation (evidence: `channels/email/email.controller.js`)
- Push campaign API → Account and auth state: uses dashboard fetch (evidence: `channels/push/push.api.js`)
- Email campaign API → Account and auth state: uses dashboard fetch (evidence: `channels/email/email.api.js`)
- Push campaign API → WebEngage campaign services: creates campaigns (evidence: `channels/push/push.api.js`)
- Email campaign API → WebEngage campaign services: creates campaigns (evidence: `channels/email/email.api.js`)
