# lucaseduardo76/sip architecture

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

- Interactive diagram: https://gitdiagram.com/lucaseduardo76/sip
- Repository: https://github.com/lucaseduardo76/sip

## Overview

SIP is a Spring API for managing found items, their return/recovery requests, user accounts and notifications. The central workflow is that a user submits an item, another user requests its recovery, and an administrator reviews the request; the service validates availability and records the result. Supporting capabilities include agenda-based pickup availability, image storage, authentication, email and real-time notifications. The README documents how to start the application, not its product behavior; relationships below are limited to sampled calls and SOURCE INDEX references.

Main entry points: [`src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java`](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java) (Item workflow), [`src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java`](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java) (Item notifications), [`src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java`](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java) (Authentication), [`src/main/java/com/ifba/sipapi/mail/infra/KafkaApplicationEmailProducer.java`](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/mail/infra/KafkaApplicationEmailProducer.java) (Email producer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity and access"]
  node_user["Users<br/>[User.java]"]
  node_auth["Authentication"]
  node_tokens["JWT tokens<br/>[TokenService.java]"]
end

subgraph group_items["Items and recovery"]
  node_itemservice["Item workflow"]
  node_item["Items<br/>[Item.java]"]
  node_recovery["Recovery requests<br/>[Recovery.java]"]
end

subgraph group_availability["Pickup availability"]
  node_agendaservice["Agenda service"]
  node_agenda["Available times<br/>[AvailableDay.java]"]
end

subgraph group_messaging["Notifications and email"]
  node_notifyitem["Item notifications"]
  node_notification["Notifications<br/>[Notification.java]"]
  node_notifyservice["Notification service"]
  node_notifyconsumer["Notification consumer"]
  node_emailproducer["Email producer"]
end

subgraph group_storage["Persistence and media"]
  node_userstore[("User store")]
  node_itemstore[("Item store")]
  node_recoverystore[("Recovery store")]
  node_agendastore[("Agenda store")]
  node_media["Image storage"]
  node_notifystore[("Notification store")]
end

node_requester(("User"))
node_kafka["Kafka"]

node_requester -.->|"authenticates"| node_auth
node_auth -->|"saves users"| node_userstore
node_auth -->|"generates tokens"| node_tokens
node_auth -->|"publishes email"| node_emailproducer
node_itemservice -->|"persists items"| node_itemstore
node_itemservice -->|"queries requests"| node_recoverystore
node_itemservice -->|"uploads images"| node_media
node_itemservice -->|"checks availability"| node_agendastore
node_itemservice -->|"emits events"| node_notifyitem
node_agendaservice -->|"loads availability"| node_agendastore
node_notifyitem -->|"saves notifications"| node_notifystore
node_notifyitem -->|"dispatches messages"| node_notifyconsumer
node_notifyitem -->|"loads item"| node_itemstore
node_notifyitem -->|"finds admins"| node_userstore
node_notifyservice -->|"reads notifications"| node_notifystore
node_emailproducer -.->|"publishes"| node_kafka

click node_user "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/user/domain/User.java"
click node_auth "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java"
click node_tokens "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/config/security/TokenService.java"
click node_userstore "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/user/infra/UserRepository.java"
click node_itemservice "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java"
click node_item "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/domain/item/Item.java"
click node_recovery "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/domain/recoveryRequest/Recovery.java"
click node_itemstore "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/infra/item/ItemRepository.java"
click node_recoverystore "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/infra/recovery/RecoveryRepository.java"
click node_agendaservice "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/agenda/api/service/AgendaApplicationService.java"
click node_agenda "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/agenda/domain/AvailableDay.java"
click node_agendastore "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/agenda/repository/AvailableDayRepository.java"
click node_media "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/minio/infra/MinioStorageClient.java"
click node_notifyitem "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java"
click node_notification "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/domain/Notification.java"
click node_notifyservice "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/api/service/NotificationApplicationService.java"
click node_notifystore "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/infra/NotificationRepository.java"
click node_notifyconsumer "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/application/NotificationConsumer.java"
click node_emailproducer "https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/mail/infra/KafkaApplicationEmailProducer.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_user,node_auth,node_tokens,node_requester toneBlue
class node_itemservice,node_item,node_recovery toneAmber
class node_agendaservice,node_agenda toneMint
class node_notifyitem,node_notification,node_notifyservice,node_notifyconsumer,node_emailproducer toneRose
class node_userstore,node_itemstore,node_recoverystore,node_agendastore,node_media,node_notifystore,node_kafka toneIndigo
```

## Components

### Identity and access

- [Users](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/user/domain/User.java): `src/main/java/com/ifba/sipapi/user/domain/User.java`
- [Authentication](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java): `src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java`
- [JWT tokens](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/config/security/TokenService.java): `src/main/java/com/ifba/sipapi/config/security/TokenService.java`

### Items and recovery

- [Item workflow](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java): `src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java`
- [Items](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/domain/item/Item.java): `src/main/java/com/ifba/sipapi/item/domain/item/Item.java`
- [Recovery requests](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/domain/recoveryRequest/Recovery.java): `src/main/java/com/ifba/sipapi/item/domain/recoveryRequest/Recovery.java`

### Pickup availability

- [Agenda service](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/agenda/api/service/AgendaApplicationService.java): `src/main/java/com/ifba/sipapi/agenda/api/service/AgendaApplicationService.java`
- [Available times](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/agenda/domain/AvailableDay.java): `src/main/java/com/ifba/sipapi/agenda/domain/AvailableDay.java`

### Notifications and email

- [Item notifications](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java): `src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java`
- [Notifications](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/domain/Notification.java): `src/main/java/com/ifba/sipapi/notification/domain/Notification.java`
- [Notification service](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/api/service/NotificationApplicationService.java): `src/main/java/com/ifba/sipapi/notification/api/service/NotificationApplicationService.java`
- [Notification consumer](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/application/NotificationConsumer.java): `src/main/java/com/ifba/sipapi/notification/application/NotificationConsumer.java`
- [Email producer](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/mail/infra/KafkaApplicationEmailProducer.java): `src/main/java/com/ifba/sipapi/mail/infra/KafkaApplicationEmailProducer.java`

### Persistence and media

- [User store](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/user/infra/UserRepository.java): `src/main/java/com/ifba/sipapi/user/infra/UserRepository.java`
- [Item store](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/infra/item/ItemRepository.java): `src/main/java/com/ifba/sipapi/item/infra/item/ItemRepository.java`
- [Recovery store](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/item/infra/recovery/RecoveryRepository.java): `src/main/java/com/ifba/sipapi/item/infra/recovery/RecoveryRepository.java`
- [Agenda store](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/agenda/repository/AvailableDayRepository.java): `src/main/java/com/ifba/sipapi/agenda/repository/AvailableDayRepository.java`
- [Image storage](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/minio/infra/MinioStorageClient.java): `src/main/java/com/ifba/sipapi/minio/infra/MinioStorageClient.java`
- [Notification store](https://github.com/lucaseduardo76/sip/blob/main/src/main/java/com/ifba/sipapi/notification/infra/NotificationRepository.java): `src/main/java/com/ifba/sipapi/notification/infra/NotificationRepository.java`

### Other components

- **User**
- **Kafka**

## Connections

- User → Authentication: authenticates
- Authentication → User store: saves users (evidence: `src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java`)
- Authentication → JWT tokens: generates tokens (evidence: `src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java`)
- Authentication → Email producer: publishes email (evidence: `src/main/java/com/ifba/sipapi/user/api/authentication/service/AuthenticationApplicationService.java`)
- Item workflow → Item store: persists items (evidence: `src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java`)
- Item workflow → Recovery store: queries requests (evidence: `src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java`)
- Item workflow → Image storage: uploads images (evidence: `src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java`)
- Item workflow → Agenda store: checks availability (evidence: `src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java`)
- Item workflow → Item notifications: emits events (evidence: `src/main/java/com/ifba/sipapi/item/api/service/ItemApplicationService.java`)
- Agenda service → Agenda store: loads availability (evidence: `src/main/java/com/ifba/sipapi/agenda/api/service/AgendaApplicationService.java`)
- Item notifications → Notification store: saves notifications (evidence: `src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java`)
- Item notifications → Notification consumer: dispatches messages (evidence: `src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java`)
- Item notifications → Item store: loads item (evidence: `src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java`)
- Item notifications → User store: finds admins (evidence: `src/main/java/com/ifba/sipapi/notification/application/NotificationToItemService.java`)
- Notification service → Notification store: reads notifications (evidence: `src/main/java/com/ifba/sipapi/notification/api/service/NotificationApplicationService.java`)
- Email producer → Kafka: publishes
