# bcgov/nr-spar architecture

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

- Interactive diagram: https://gitdiagram.com/bcgov/nr-spar
- Repository: https://github.com/bcgov/nr-spar

## Overview

SPAR is a natural-resources application with a React client, a PostgreSQL REST backend, and a separate Oracle REST API. The principal workflow is a signed-in user working in the client with seedlot information, which the backend manages; the repository also contains orchard/parent-tree and seedlot-reporting capabilities, plus Oracle-backed parent-tree and CONSEP testing services. The sampled excerpts confirm selected service-to-repository and UI-to-API calls; other runtime connections are shown as unverified rather than asserted.

Main entry points: [`backend/src/main/java/ca/bc/gov/backendstartapi/service/SeedlotService.java`](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/SeedlotService.java) (Seedlot management), [`frontend/src/views/Seedlot`](https://github.com/bcgov/nr-spar/tree/main/frontend/src/views/Seedlot) (Seedlot workflows), [`backend/src/main/java/ca/bc/gov/backendstartapi/service/SearchCriteriaService.java`](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/SearchCriteriaService.java) (Search criteria), [`frontend/src/App.tsx`](https://github.com/bcgov/nr-spar/blob/main/frontend/src/App.tsx) (React application)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["SPAR Client"]
  node_webapp["React application<br/>[App.tsx]"]
  node_seedlotui["Seedlot workflows"]
  node_forestclientui["Forest client lookup"]
end

subgraph group_postgres["PostgreSQL Backend"]
  node_seedlotapi["Seedlot management"]
  node_seedlothttp["Seedlot REST endpoints"]
  node_seedlotstore[("Seedlot records")]
  node_searchprefs["Search criteria"]
  node_searchstore[("Saved criteria")]
  node_orchard["Orchard services"]
  node_reports["Seedlot reports"]
  node_reportresources["Report templates"]
end

subgraph group_oracle["Oracle API"]
  node_parentendpoint["Parent-tree REST"]
  node_parentrepo[("Parent-tree data")]
  node_activitysearch["CONSEP activity search"]
  node_activityrepo[("Activity search data")]
  node_testresults["CONSEP test results"]
end

subgraph group_shared["Supporting Services"]
  node_identity["User identity"]
  node_correlation["Request correlation<br/>[SparLog.java]"]
end

node_user(("SPAR user"))

node_user -.->|"uses"| node_webapp
node_webapp -->|"routes to"| node_seedlotui
node_seedlotui -.->|"uses API"| node_seedlotapi
node_seedlotui -->|"looks up client"| node_forestclientui
node_seedlotapi -.->|"persists"| node_seedlotstore
node_seedlothttp -.->|"dispatches"| node_seedlotapi
node_searchprefs -->|"gets user ID"| node_identity
node_searchprefs -->|"saves criteria"| node_searchstore
node_seedlotapi -.->|"uses orchard data"| node_orchard
node_parentendpoint -->|"queries"| node_parentrepo
node_activitysearch -->|"searches"| node_activityrepo
node_reports -.->|"uses templates"| node_reportresources

click node_webapp "https://github.com/bcgov/nr-spar/blob/main/frontend/src/App.tsx"
click node_seedlotui "https://github.com/bcgov/nr-spar/tree/main/frontend/src/views/Seedlot"
click node_forestclientui "https://github.com/bcgov/nr-spar/blob/main/frontend/src/api-service/forestClientsAPI.ts"
click node_seedlotapi "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/SeedlotService.java"
click node_seedlothttp "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/endpoint/SeedlotEndpoint.java"
click node_seedlotstore "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/repository/SeedlotRepository.java"
click node_searchprefs "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/SearchCriteriaService.java"
click node_searchstore "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/repository/SearchCriteriaRepository.java"
click node_identity "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/security/LoggedUserService.java"
click node_orchard "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/OrchardService.java"
click node_parentendpoint "https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/service/ParentTreeService.java"
click node_parentrepo "https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/repository/ParentTreeRepository.java"
click node_activitysearch "https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/service/consep/ActivitySearchService.java"
click node_activityrepo "https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/repository/consep/ActivitySearchRepository.java"
click node_testresults "https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/service/consep/TestResultService.java"
click node_reports "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/report/SeedlotRegistrationReportService.java"
click node_reportresources "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/report/ReportResourceService.java"
click node_correlation "https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/config/SparLog.java"

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_webapp,node_seedlotui,node_forestclientui,node_user toneBlue
class node_seedlotapi,node_seedlothttp,node_seedlotstore,node_searchprefs,node_searchstore,node_orchard,node_reports,node_reportresources toneAmber
class node_parentendpoint,node_parentrepo,node_activitysearch,node_activityrepo,node_testresults toneMint
class node_identity,node_correlation toneRose
```

## Components

### SPAR Client

- [React application](https://github.com/bcgov/nr-spar/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Seedlot workflows](https://github.com/bcgov/nr-spar/tree/main/frontend/src/views/Seedlot): `frontend/src/views/Seedlot`
- [Forest client lookup](https://github.com/bcgov/nr-spar/blob/main/frontend/src/api-service/forestClientsAPI.ts): `frontend/src/api-service/forestClientsAPI.ts`

### PostgreSQL Backend

- [Seedlot management](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/SeedlotService.java): `backend/src/main/java/ca/bc/gov/backendstartapi/service/SeedlotService.java`
- [Seedlot REST endpoints](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/endpoint/SeedlotEndpoint.java): `backend/src/main/java/ca/bc/gov/backendstartapi/endpoint/SeedlotEndpoint.java`
- [Seedlot records](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/repository/SeedlotRepository.java): `backend/src/main/java/ca/bc/gov/backendstartapi/repository/SeedlotRepository.java`
- [Search criteria](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/SearchCriteriaService.java): `backend/src/main/java/ca/bc/gov/backendstartapi/service/SearchCriteriaService.java`
- [Saved criteria](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/repository/SearchCriteriaRepository.java): `backend/src/main/java/ca/bc/gov/backendstartapi/repository/SearchCriteriaRepository.java`
- [Orchard services](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/service/OrchardService.java): `backend/src/main/java/ca/bc/gov/backendstartapi/service/OrchardService.java`
- [Seedlot reports](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/report/SeedlotRegistrationReportService.java): `backend/src/main/java/ca/bc/gov/backendstartapi/report/SeedlotRegistrationReportService.java`
- [Report templates](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/report/ReportResourceService.java): `backend/src/main/java/ca/bc/gov/backendstartapi/report/ReportResourceService.java`

### Oracle API

- [Parent-tree REST](https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/service/ParentTreeService.java): `oracle-api/src/main/java/ca/bc/gov/oracleapi/service/ParentTreeService.java`
- [Parent-tree data](https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/repository/ParentTreeRepository.java): `oracle-api/src/main/java/ca/bc/gov/oracleapi/repository/ParentTreeRepository.java`
- [CONSEP activity search](https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/service/consep/ActivitySearchService.java): `oracle-api/src/main/java/ca/bc/gov/oracleapi/service/consep/ActivitySearchService.java`
- [Activity search data](https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/repository/consep/ActivitySearchRepository.java): `oracle-api/src/main/java/ca/bc/gov/oracleapi/repository/consep/ActivitySearchRepository.java`
- [CONSEP test results](https://github.com/bcgov/nr-spar/blob/main/oracle-api/src/main/java/ca/bc/gov/oracleapi/service/consep/TestResultService.java): `oracle-api/src/main/java/ca/bc/gov/oracleapi/service/consep/TestResultService.java`

### Supporting Services

- [User identity](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/security/LoggedUserService.java): `backend/src/main/java/ca/bc/gov/backendstartapi/security/LoggedUserService.java`
- [Request correlation](https://github.com/bcgov/nr-spar/blob/main/backend/src/main/java/ca/bc/gov/backendstartapi/config/SparLog.java): `backend/src/main/java/ca/bc/gov/backendstartapi/config/SparLog.java`

### Other components

- **SPAR user**

## Connections

- SPAR user → React application: uses
- React application → Seedlot workflows: routes to (evidence: `frontend/src/App.tsx`)
- Seedlot workflows → Seedlot management: uses API
- Seedlot workflows → Forest client lookup: looks up client (evidence: `frontend/src/views/Seedlot/SeedlotReviewClassB/read/ExtractionStorageRead.tsx`)
- Seedlot management → Seedlot records: persists
- Seedlot REST endpoints → Seedlot management: dispatches
- Search criteria → User identity: gets user ID (evidence: `backend/src/main/java/ca/bc/gov/backendstartapi/service/SearchCriteriaService.java`)
- Search criteria → Saved criteria: saves criteria (evidence: `backend/src/main/java/ca/bc/gov/backendstartapi/service/SearchCriteriaService.java`)
- Seedlot management → Orchard services: uses orchard data
- Parent-tree REST → Parent-tree data: queries (evidence: `oracle-api/src/main/java/ca/bc/gov/oracleapi/service/ParentTreeService.java`)
- CONSEP activity search → Activity search data: searches (evidence: `oracle-api/src/main/java/ca/bc/gov/oracleapi/service/consep/ActivitySearchService.java`)
- Seedlot reports → Report templates: uses templates (evidence: `backend/src/main/java/ca/bc/gov/backendstartapi/report/SeedlotRegistrationReportService.java`)
