# rgbittencourt/classauthor architecture

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

- Interactive diagram: https://gitdiagram.com/rgbittencourt/classauthor
- Repository: https://github.com/rgbittencourt/classauthor

## Overview

ClassAuthor transforma o briefing de um professor em um curso organizado por semanas/aulas, com geração assistida por IA, revisão e materiais de apoio. O fluxo principal começa na interface, passa pela geração incremental de semanas e termina no planejamento consolidado e em exportações. O README também destaca recuperação local, provedores OpenAI/Anthropic e recursos para integração com Moodle/ClassAtelier. Alguns recursos adicionais aparecem apenas no índice ou na documentação; suas ligações são mantidas em nível documentado, sem presumir chamadas internas não mostradas.

Main entry points: [`public/app.js`](https://github.com/rgbittencourt/classauthor/blob/main/public/app.js) (Interface ClassAuthor), [`api/regenerate-week.js`](https://github.com/rgbittencourt/classauthor/blob/main/api/regenerate-week.js) (Refação e despacho de ações), [`api/generate-week.js`](https://github.com/rgbittencourt/classauthor/blob/main/api/generate-week.js) (Geração semanal), [`src/ai.js`](https://github.com/rgbittencourt/classauthor/blob/main/src/ai.js) (Geração e redação IA)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_authoring["Planejamento do curso"]
  node_app["Interface ClassAuthor<br/>[app.js]"]
  node_draft[("Briefing e rascunho local<br/>[app.js]")]
  node_assist["Assistência ao briefing<br/>[assist-briefing.js]"]
end

subgraph group_generation["Geração e pedagogia"]
  node_genweek["Geração semanal<br/>[generate-week.js]"]
  node_regen["Refação e despacho de ações<br/>[regenerate-week.js]"]
  node_aiengine["Geração e redação IA<br/>[ai.js]"]
  node_schema["Normalização do curso<br/>[aula-schema.js]"]
  node_curriculum["Progressão curricular<br/>[curriculum.js]"]
  node_teacherplan["Guia docente e mediação<br/>[teacher-guide.js]"]
end

subgraph group_enrichment["Recursos e edição"]
  node_research["Pesquisa de recursos<br/>[research.js]"]
  node_bridge["Ponte entre semanas<br/>[bridge-handler.js]"]
  node_derivatives["Derivados da semana"]
  node_figures["Figuras e ilustração<br/>[figure-handler.js]"]
  node_slides["Slides<br/>[slides-handler.js]"]
end

subgraph group_outputs["Materiais e exportação"]
  node_exports["Pacotes de curso<br/>[zip.js]"]
  node_pdf["PDF de mediação<br/>[teacher-pdf.js]"]
  node_docx["Prática web DOCX"]
  node_alignment["Alinhamento pedagógico<br/>[alignment-map.js]"]
end

subgraph group_integration["Integrações e acesso"]
  node_provider["Cliente OpenAI / Anthropic<br/>[ai-client.js]"]
  node_keys["Chaves próprias e acesso<br/>[user-keys.js]"]
  node_integrations["Moodle e ClassAtelier<br/>[moodle-xml.js]"]
end

node_teacher(("Professor"))

node_teacher -->|"planeja no"| node_app
node_app -->|"salva localmente"| node_draft
node_app -.->|"pede assistência"| node_assist
node_app -.->|"solicita semana"| node_genweek
node_genweek -->|"normaliza entrada e saída"| node_schema
node_genweek -->|"monta progressão"| node_curriculum
node_genweek -->|"gera semana"| node_aiengine
node_genweek -->|"monta guia"| node_teacherplan
node_aiengine -->|"solicita geração"| node_provider
node_provider -->|"consulta credenciais"| node_keys
node_app -.->|"pede refação"| node_regen
node_regen -->|"regenera semana"| node_aiengine
node_regen -->|"normaliza semana"| node_schema
node_regen -->|"reconstrói guias"| node_teacherplan
node_regen -->|"despacha ações"| node_bridge
node_regen -->|"despacha ações"| node_derivatives
node_regen -->|"despacha figuras"| node_figures
node_regen -->|"despacha slides"| node_slides
node_genweek -.->|"devolve semana"| node_app
node_app -.->|"baixa pacote"| node_exports
node_app -.->|"solicita PDF"| node_pdf
node_app -.->|"solicita DOCX"| node_docx
node_app -->|"consulta alinhamento"| node_alignment
node_app -.->|"exporta Moodle"| node_integrations
node_aiengine -->|"incorpora pesquisa"| node_research

click node_app "https://github.com/rgbittencourt/classauthor/blob/main/public/app.js"
click node_draft "https://github.com/rgbittencourt/classauthor/blob/main/public/app.js"
click node_assist "https://github.com/rgbittencourt/classauthor/blob/main/api/assist-briefing.js"
click node_genweek "https://github.com/rgbittencourt/classauthor/blob/main/api/generate-week.js"
click node_regen "https://github.com/rgbittencourt/classauthor/blob/main/api/regenerate-week.js"
click node_aiengine "https://github.com/rgbittencourt/classauthor/blob/main/src/ai.js"
click node_schema "https://github.com/rgbittencourt/classauthor/blob/main/src/aula-schema.js"
click node_curriculum "https://github.com/rgbittencourt/classauthor/blob/main/src/curriculum.js"
click node_teacherplan "https://github.com/rgbittencourt/classauthor/blob/main/src/teacher-guide.js"
click node_provider "https://github.com/rgbittencourt/classauthor/blob/main/src/ai-client.js"
click node_keys "https://github.com/rgbittencourt/classauthor/blob/main/src/user-keys.js"
click node_research "https://github.com/rgbittencourt/classauthor/blob/main/src/research.js"
click node_bridge "https://github.com/rgbittencourt/classauthor/blob/main/src/bridge-handler.js"
click node_derivatives "https://github.com/rgbittencourt/classauthor/blob/main/src/derivatives-handler.js"
click node_figures "https://github.com/rgbittencourt/classauthor/blob/main/src/figure-handler.js"
click node_slides "https://github.com/rgbittencourt/classauthor/blob/main/src/slides-handler.js"
click node_exports "https://github.com/rgbittencourt/classauthor/blob/main/api/zip.js"
click node_pdf "https://github.com/rgbittencourt/classauthor/blob/main/api/teacher-pdf.js"
click node_docx "https://github.com/rgbittencourt/classauthor/blob/main/api/webpractice-docx.js"
click node_alignment "https://github.com/rgbittencourt/classauthor/blob/main/public/alignment-map.js"
click node_integrations "https://github.com/rgbittencourt/classauthor/blob/main/public/moodle-xml.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_app,node_draft,node_assist toneBlue
class node_genweek,node_regen,node_aiengine,node_schema,node_curriculum,node_teacherplan toneAmber
class node_research,node_bridge,node_derivatives,node_figures,node_slides toneMint
class node_exports,node_pdf,node_docx,node_alignment toneRose
class node_provider,node_keys,node_integrations,node_teacher toneIndigo
```

## Components

### Planejamento do curso

- [Interface ClassAuthor](https://github.com/rgbittencourt/classauthor/blob/main/public/app.js): `public/app.js`
- [Briefing e rascunho local](https://github.com/rgbittencourt/classauthor/blob/main/public/app.js): `public/app.js`
- [Assistência ao briefing](https://github.com/rgbittencourt/classauthor/blob/main/api/assist-briefing.js): `api/assist-briefing.js`

### Geração e pedagogia

- [Geração semanal](https://github.com/rgbittencourt/classauthor/blob/main/api/generate-week.js): `api/generate-week.js`
- [Refação e despacho de ações](https://github.com/rgbittencourt/classauthor/blob/main/api/regenerate-week.js): `api/regenerate-week.js`
- [Geração e redação IA](https://github.com/rgbittencourt/classauthor/blob/main/src/ai.js): `src/ai.js`
- [Normalização do curso](https://github.com/rgbittencourt/classauthor/blob/main/src/aula-schema.js): `src/aula-schema.js`
- [Progressão curricular](https://github.com/rgbittencourt/classauthor/blob/main/src/curriculum.js): `src/curriculum.js`
- [Guia docente e mediação](https://github.com/rgbittencourt/classauthor/blob/main/src/teacher-guide.js): `src/teacher-guide.js`

### Recursos e edição

- [Pesquisa de recursos](https://github.com/rgbittencourt/classauthor/blob/main/src/research.js): `src/research.js`
- [Ponte entre semanas](https://github.com/rgbittencourt/classauthor/blob/main/src/bridge-handler.js): `src/bridge-handler.js`
- [Derivados da semana](https://github.com/rgbittencourt/classauthor/blob/main/src/derivatives-handler.js): `src/derivatives-handler.js`
- [Figuras e ilustração](https://github.com/rgbittencourt/classauthor/blob/main/src/figure-handler.js): `src/figure-handler.js`
- [Slides](https://github.com/rgbittencourt/classauthor/blob/main/src/slides-handler.js): `src/slides-handler.js`

### Materiais e exportação

- [Pacotes de curso](https://github.com/rgbittencourt/classauthor/blob/main/api/zip.js): `api/zip.js`
- [PDF de mediação](https://github.com/rgbittencourt/classauthor/blob/main/api/teacher-pdf.js): `api/teacher-pdf.js`
- [Prática web DOCX](https://github.com/rgbittencourt/classauthor/blob/main/api/webpractice-docx.js): `api/webpractice-docx.js`
- [Alinhamento pedagógico](https://github.com/rgbittencourt/classauthor/blob/main/public/alignment-map.js): `public/alignment-map.js`

### Integrações e acesso

- [Cliente OpenAI / Anthropic](https://github.com/rgbittencourt/classauthor/blob/main/src/ai-client.js): `src/ai-client.js`
- [Chaves próprias e acesso](https://github.com/rgbittencourt/classauthor/blob/main/src/user-keys.js): `src/user-keys.js`
- [Moodle e ClassAtelier](https://github.com/rgbittencourt/classauthor/blob/main/public/moodle-xml.js): `public/moodle-xml.js`

### Other components

- **Professor**

## Connections

- Professor → Interface ClassAuthor: planeja no (evidence: `README.md`)
- Interface ClassAuthor → Briefing e rascunho local: salva localmente (evidence: `README.md`)
- Interface ClassAuthor → Assistência ao briefing: pede assistência (evidence: `README.md`)
- Interface ClassAuthor → Geração semanal: solicita semana (evidence: `README.md`)
- Geração semanal → Normalização do curso: normaliza entrada e saída (evidence: `api/generate-week.js`)
- Geração semanal → Progressão curricular: monta progressão (evidence: `api/generate-week.js`)
- Geração semanal → Geração e redação IA: gera semana (evidence: `api/generate-week.js`)
- Geração semanal → Guia docente e mediação: monta guia (evidence: `api/generate-week.js`)
- Geração e redação IA → Cliente OpenAI / Anthropic: solicita geração (evidence: `src/ai.js`)
- Cliente OpenAI / Anthropic → Chaves próprias e acesso: consulta credenciais (evidence: `src/ai-client.js`)
- Interface ClassAuthor → Refação e despacho de ações: pede refação (evidence: `README.md`)
- Refação e despacho de ações → Geração e redação IA: regenera semana (evidence: `api/regenerate-week.js`)
- Refação e despacho de ações → Normalização do curso: normaliza semana (evidence: `api/regenerate-week.js`)
- Refação e despacho de ações → Guia docente e mediação: reconstrói guias (evidence: `api/regenerate-week.js`)
- Refação e despacho de ações → Ponte entre semanas: despacha ações (evidence: `api/regenerate-week.js`)
- Refação e despacho de ações → Derivados da semana: despacha ações (evidence: `api/regenerate-week.js`)
- Refação e despacho de ações → Figuras e ilustração: despacha figuras (evidence: `api/regenerate-week.js`)
- Refação e despacho de ações → Slides: despacha slides (evidence: `api/regenerate-week.js`)
- Geração semanal → Interface ClassAuthor: devolve semana (evidence: `README.md`)
- Interface ClassAuthor → Pacotes de curso: baixa pacote (evidence: `README.md`)
- Interface ClassAuthor → PDF de mediação: solicita PDF (evidence: `README.md`)
- Interface ClassAuthor → Prática web DOCX: solicita DOCX (evidence: `README.md`)
- Interface ClassAuthor → Alinhamento pedagógico: consulta alinhamento (evidence: `public/app.js`)
- Interface ClassAuthor → Moodle e ClassAtelier: exporta Moodle (evidence: `README.md`)
- Geração e redação IA → Pesquisa de recursos: incorpora pesquisa (evidence: `src/ai.js`)
