# kirakira-douga/kirakira-rosales architecture

> Architecture diagram of the GitHub repository kirakira-douga/kirakira-rosales, 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/kirakira-douga/kirakira-rosales
- Repository: https://github.com/kirakira-douga/kirakira-rosales

## Overview

KIRAKIRA-Rosales is a Koa REST API backend. Its principal workflow is an HTTP request routed to a controller, handled by a domain service, and persisted or queried through MongoDB; some video functions also use Elasticsearch, while account and feed features can integrate with Cloudflare and email. The graph groups API routing, domain capabilities, persistence/search, and shared integrations. Relationships among unsampled controllers and services are limited to router declarations and SOURCE INDEX references; no unshown call details are assumed.

Main entry points: [`src/route/router.ts`](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/route/router.ts) (REST Router), [`src/dbPool/DbClusterPool.ts`](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/dbPool/DbClusterPool.ts) (MongoDB Access), [`src/service/RbacService.ts`](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/RbacService.ts) (Access Control), [`src/service/UserService.ts`](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/UserService.ts) (User Accounts)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["HTTP API"]
  node_app["Koa Application<br/>[app.ts]"]
  node_router["REST Router<br/>[router.ts]"]
  node_user_api["User API<br/>[UserController.ts]"]
  node_video_api["Video API<br/>[VideoController.ts]"]
  node_feed_api["Feed API<br/>[FeedController.ts]"]
  node_rbac_api["RBAC API<br/>[RbacController.ts]"]
  node_comment_api["Comment API"]
  node_other_apis["Other Domain APIs"]
end

subgraph group_domain["Domain Services"]
  node_user_service["User Accounts<br/>[UserService.ts]"]
  node_video_service["Video Catalog<br/>[VideoService.ts]"]
  node_feed_service["Feed Management<br/>[FeedService.ts]"]
  node_rbac_service["Access Control<br/>[RbacService.ts]"]
  node_comment_service["Video Comments"]
  node_other_services["Other Domain Services"]
end

subgraph group_data["Persistence And Search"]
  node_mongo[("MongoDB Access<br/>[DbClusterPool.ts]")]
  node_schemas["Domain Schemas"]
  node_search[("Elasticsearch")]
  node_search_middleware["Search Middleware"]
end

subgraph group_integrations["Shared Integrations"]
  node_cloudflare["Cloudflare Uploads<br/>[index.ts]"]
  node_email["Email Utilities<br/>[EmailTool.ts]"]
  node_validation["Input Validation<br/>[ValidTool.ts]"]
  node_logging["Logging<br/>[loggingService.ts]"]
  node_sequence["Sequence Values"]
end

node_client(("API Client"))

node_client -->|"sends requests"| node_app
node_app -->|"mounts routes"| node_router
node_app -->|"configures"| node_search_middleware
node_router -->|"routes to"| node_user_api
node_router -->|"routes to"| node_video_api
node_router -->|"routes to"| node_feed_api
node_router -->|"routes to"| node_rbac_api
node_router -->|"routes to"| node_comment_api
node_router -->|"routes to"| node_other_apis
node_user_api -->|"calls"| node_user_service
node_user_api -->|"checks access"| node_rbac_service
node_video_api -->|"calls"| node_video_service
node_video_api -->|"checks access"| node_rbac_service
node_feed_api -->|"calls"| node_feed_service
node_feed_api -->|"checks access"| node_rbac_service
node_rbac_api -->|"calls"| node_rbac_service
node_comment_api -->|"calls"| node_comment_service
node_comment_api -->|"checks access"| node_rbac_service
node_user_service -->|"reads and writes"| node_mongo
node_video_service -->|"reads and writes"| node_mongo
node_feed_service -->|"reads and writes"| node_mongo
node_rbac_service -->|"reads and writes"| node_mongo
node_comment_service -->|"reads and writes"| node_mongo
node_mongo -->|"uses schemas"| node_schemas
node_video_service -->|"queries index"| node_search
node_search_middleware -->|"initializes"| node_search
node_feed_service -->|"requests uploads"| node_cloudflare
node_user_service -->|"requests uploads"| node_cloudflare
node_user_service -->|"sends email"| node_email
node_user_service -->|"gets sequence values"| node_sequence
node_user_api -->|"validates input"| node_validation
node_feed_api -->|"validates input"| node_validation
node_rbac_api -->|"validates input"| node_validation
node_comment_api -->|"validates input"| node_validation
node_mongo -->|"reports errors"| node_logging

click node_app "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/app.ts"
click node_router "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/route/router.ts"
click node_user_api "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/UserController.ts"
click node_video_api "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/VideoController.ts"
click node_feed_api "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/FeedController.ts"
click node_rbac_api "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/RbacController.ts"
click node_comment_api "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/VideoCommentController.ts"
click node_other_apis "https://github.com/kirakira-douga/kirakira-rosales/tree/develop/src/controller"
click node_user_service "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/UserService.ts"
click node_video_service "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/VideoService.ts"
click node_feed_service "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/FeedService.ts"
click node_rbac_service "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/RbacService.ts"
click node_comment_service "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/VideoCommentService.ts"
click node_other_services "https://github.com/kirakira-douga/kirakira-rosales/tree/develop/src/service"
click node_mongo "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/dbPool/DbClusterPool.ts"
click node_schemas "https://github.com/kirakira-douga/kirakira-rosales/tree/develop/src/dbPool/schema"
click node_search "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/elasticsearchPool/ElasticsearchClusterPool.ts"
click node_search_middleware "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/middleware/elasticsearchMiddleware.ts"
click node_cloudflare "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/cloudflare/index.ts"
click node_email "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/common/EmailTool.ts"
click node_validation "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/common/ValidTool.ts"
click node_logging "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/loggingService.ts"
click node_sequence "https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/SequenceValueService.ts"

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_router,node_user_api,node_video_api,node_feed_api,node_rbac_api,node_comment_api,node_other_apis,node_client toneBlue
class node_user_service,node_video_service,node_feed_service,node_rbac_service,node_comment_service,node_other_services toneAmber
class node_mongo,node_schemas,node_search,node_search_middleware toneMint
class node_cloudflare,node_email,node_validation,node_logging,node_sequence toneRose
```

## Components

### HTTP API

- [Koa Application](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/app.ts): `src/app.ts`
- [REST Router](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/route/router.ts): `src/route/router.ts`
- [User API](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/UserController.ts): `src/controller/UserController.ts`
- [Video API](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/VideoController.ts): `src/controller/VideoController.ts`
- [Feed API](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/FeedController.ts): `src/controller/FeedController.ts`
- [RBAC API](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/RbacController.ts): `src/controller/RbacController.ts`
- [Comment API](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/controller/VideoCommentController.ts): `src/controller/VideoCommentController.ts`
- [Other Domain APIs](https://github.com/kirakira-douga/kirakira-rosales/tree/develop/src/controller): `src/controller`

### Domain Services

- [User Accounts](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/UserService.ts): `src/service/UserService.ts`
- [Video Catalog](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/VideoService.ts): `src/service/VideoService.ts`
- [Feed Management](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/FeedService.ts): `src/service/FeedService.ts`
- [Access Control](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/RbacService.ts): `src/service/RbacService.ts`
- [Video Comments](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/VideoCommentService.ts): `src/service/VideoCommentService.ts`
- [Other Domain Services](https://github.com/kirakira-douga/kirakira-rosales/tree/develop/src/service): `src/service`

### Persistence And Search

- [MongoDB Access](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/dbPool/DbClusterPool.ts): `src/dbPool/DbClusterPool.ts`
- [Domain Schemas](https://github.com/kirakira-douga/kirakira-rosales/tree/develop/src/dbPool/schema): `src/dbPool/schema`
- [Elasticsearch](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/elasticsearchPool/ElasticsearchClusterPool.ts): `src/elasticsearchPool/ElasticsearchClusterPool.ts`
- [Search Middleware](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/middleware/elasticsearchMiddleware.ts): `src/middleware/elasticsearchMiddleware.ts`

### Shared Integrations

- [Cloudflare Uploads](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/cloudflare/index.ts): `src/cloudflare/index.ts`
- [Email Utilities](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/common/EmailTool.ts): `src/common/EmailTool.ts`
- [Input Validation](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/common/ValidTool.ts): `src/common/ValidTool.ts`
- [Logging](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/loggingService.ts): `src/service/loggingService.ts`
- [Sequence Values](https://github.com/kirakira-douga/kirakira-rosales/blob/develop/src/service/SequenceValueService.ts): `src/service/SequenceValueService.ts`

### Other components

- **API Client**

## Connections

- API Client → Koa Application: sends requests
- Koa Application → REST Router: mounts routes (evidence: `src/app.ts`)
- Koa Application → Search Middleware: configures (evidence: `src/app.ts`)
- REST Router → User API: routes to (evidence: `src/route/router.ts`)
- REST Router → Video API: routes to (evidence: `src/route/router.ts`)
- REST Router → Feed API: routes to (evidence: `src/route/router.ts`)
- REST Router → RBAC API: routes to (evidence: `src/route/router.ts`)
- REST Router → Comment API: routes to (evidence: `src/route/router.ts`)
- REST Router → Other Domain APIs: routes to (evidence: `src/route/router.ts`)
- User API → User Accounts: calls (evidence: `src/controller/UserController.ts`)
- User API → Access Control: checks access (evidence: `src/controller/UserController.ts`)
- Video API → Video Catalog: calls (evidence: `src/controller/VideoController.ts`)
- Video API → Access Control: checks access (evidence: `src/controller/VideoController.ts`)
- Feed API → Feed Management: calls (evidence: `src/controller/FeedController.ts`)
- Feed API → Access Control: checks access (evidence: `src/controller/FeedController.ts`)
- RBAC API → Access Control: calls (evidence: `src/controller/RbacController.ts`)
- Comment API → Video Comments: calls (evidence: `src/controller/VideoCommentController.ts`)
- Comment API → Access Control: checks access (evidence: `src/controller/VideoCommentController.ts`)
- User Accounts → MongoDB Access: reads and writes (evidence: `src/service/UserService.ts`)
- Video Catalog → MongoDB Access: reads and writes (evidence: `src/service/VideoService.ts`)
- Feed Management → MongoDB Access: reads and writes (evidence: `src/service/FeedService.ts`)
- Access Control → MongoDB Access: reads and writes (evidence: `src/service/RbacService.ts`)
- Video Comments → MongoDB Access: reads and writes (evidence: `src/service/VideoCommentService.ts`)
- MongoDB Access → Domain Schemas: uses schemas (evidence: `src/dbPool/DbClusterPool.ts`)
- Video Catalog → Elasticsearch: queries index (evidence: `src/service/VideoService.ts`)
- Search Middleware → Elasticsearch: initializes (evidence: `src/middleware/elasticsearchMiddleware.ts`)
- Feed Management → Cloudflare Uploads: requests uploads (evidence: `src/service/FeedService.ts`)
- User Accounts → Cloudflare Uploads: requests uploads (evidence: `src/service/UserService.ts`)
- User Accounts → Email Utilities: sends email (evidence: `src/service/UserService.ts`)
- User Accounts → Sequence Values: gets sequence values (evidence: `src/service/UserService.ts`)
- User API → Input Validation: validates input (evidence: `src/controller/UserController.ts`)
- Feed API → Input Validation: validates input (evidence: `src/controller/FeedController.ts`)
- RBAC API → Input Validation: validates input (evidence: `src/controller/RbacController.ts`)
- Comment API → Input Validation: validates input (evidence: `src/controller/VideoCommentController.ts`)
- MongoDB Access → Logging: reports errors (evidence: `src/dbPool/DbClusterPool.ts`)
