Files
microdao-daarion/site/matrix/MATRIX_ROOMS_BRIDGE_SPEC/index.html

1279 lines
43 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://IvanTytar.github.io/microdao-daarion/matrix/MATRIX_ROOMS_BRIDGE_SPEC/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
<title>MATRIX ROOMS BRIDGE — DAARION.city - DAARION Documentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.66ac8b77.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#matrix-rooms-bridge-daarioncity" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="DAARION Documentation" class="md-header__button md-logo" aria-label="DAARION Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
DAARION Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
MATRIX ROOMS BRIDGE — DAARION.city
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="DAARION Documentation" class="md-nav__button md-logo" aria-label="DAARION Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
DAARION Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../public/" class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../public/getting-started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../public/architecture-overview/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../public/daiS_daos_overview/" class="md-nav__link">
<span class="md-ellipsis">
DAIS & DAOS
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
Internal
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Internal
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" >
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="0">
<span class="md-ellipsis">
Infra
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_1">
<span class="md-nav__icon md-icon"></span>
Infra
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../internal/infra/INFRA_AUTOMATION_PACK_V1/" class="md-nav__link">
<span class="md-ellipsis">
Infra Automation Pack v1
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/infra/monitoring_overview/" class="md-nav__link">
<span class="md-ellipsis">
Monitoring Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/infra/nodes_registry_v0/" class="md-nav__link">
<span class="md-ellipsis">
Nodes Registry v0
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
<label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
<span class="md-ellipsis">
Specs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_2">
<span class="md-nav__icon md-icon"></span>
Specs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../internal/specs/matrix_presence_aggregator/" class="md-nav__link">
<span class="md-ellipsis">
Matrix Presence Aggregator
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/specs/city_map_spec/" class="md-nav__link">
<span class="md-ellipsis">
City Map Spec
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../internal/specs/node_join_protocol_draft/" class="md-nav__link">
<span class="md-ellipsis">
Node Join Protocol (Draft)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#0-purpose" class="md-nav__link">
<span class="md-ellipsis">
0. PURPOSE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#1-architecture-overview" class="md-nav__link">
<span class="md-ellipsis">
1. ARCHITECTURE OVERVIEW
</span>
</a>
<nav class="md-nav" aria-label="1. ARCHITECTURE OVERVIEW">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#_1" class="md-nav__link">
<span class="md-ellipsis">
Сервіси
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_2" class="md-nav__link">
<span class="md-ellipsis">
Мапінг
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#2-data-model-changes-postgresql" class="md-nav__link">
<span class="md-ellipsis">
2. DATA MODEL CHANGES (PostgreSQL)
</span>
</a>
<nav class="md-nav" aria-label="2. DATA MODEL CHANGES (PostgreSQL)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#21-city_rooms" class="md-nav__link">
<span class="md-ellipsis">
2.1. Таблиця city_rooms
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#22-invariants" class="md-nav__link">
<span class="md-ellipsis">
2.2. Invariants
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#3-naming-convention" class="md-nav__link">
<span class="md-ellipsis">
3. NAMING CONVENTION
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-flows" class="md-nav__link">
<span class="md-ellipsis">
4. FLOWS
</span>
</a>
<nav class="md-nav" aria-label="4. FLOWS">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#41-city-room" class="md-nav__link">
<span class="md-ellipsis">
4.1. Створення нової City Room
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#42-backfill" class="md-nav__link">
<span class="md-ellipsis">
4.2. Синхронізація існуючих кімнат (backfill)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#43-room" class="md-nav__link">
<span class="md-ellipsis">
4.3. Архівація / деактивація Room
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#5-matrix-gateway-service" class="md-nav__link">
<span class="md-ellipsis">
5. MATRIX GATEWAY SERVICE
</span>
</a>
<nav class="md-nav" aria-label="5. MATRIX GATEWAY SERVICE">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#51" class="md-nav__link">
<span class="md-ellipsis">
5.1. Конфігурація
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#52-api-endpoints" class="md-nav__link">
<span class="md-ellipsis">
5.2. API Endpoints
</span>
</a>
<nav class="md-nav" aria-label="5.2. API Endpoints">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#post-internalmatrixroomscreate" class="md-nav__link">
<span class="md-ellipsis">
POST /internal/matrix/rooms/create
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-internalmatrixroomsfind-by-alias" class="md-nav__link">
<span class="md-ellipsis">
GET /internal/matrix/rooms/find-by-alias
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#get-healthz" class="md-nav__link">
<span class="md-ellipsis">
GET /healthz
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#6-city-service-api-changes" class="md-nav__link">
<span class="md-ellipsis">
6. CITY-SERVICE API CHANGES
</span>
</a>
<nav class="md-nav" aria-label="6. CITY-SERVICE API CHANGES">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#61-get-apicityrooms" class="md-nav__link">
<span class="md-ellipsis">
6.1. GET /api/city/rooms
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#62-get-apicityroomsslug" class="md-nav__link">
<span class="md-ellipsis">
6.2. GET /api/city/rooms/{slug}
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#63-post-apicityrooms" class="md-nav__link">
<span class="md-ellipsis">
6.3. POST /api/city/rooms
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#7-frontend-integration" class="md-nav__link">
<span class="md-ellipsis">
7. FRONTEND INTEGRATION
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#8-security" class="md-nav__link">
<span class="md-ellipsis">
8. SECURITY
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#9-deployment" class="md-nav__link">
<span class="md-ellipsis">
9. DEPLOYMENT
</span>
</a>
<nav class="md-nav" aria-label="9. DEPLOYMENT">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docker-compose-addition" class="md-nav__link">
<span class="md-ellipsis">
Docker Compose addition
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#nginx-routing" class="md-nav__link">
<span class="md-ellipsis">
Nginx routing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#10-roadmap-after-bridge" class="md-nav__link">
<span class="md-ellipsis">
10. ROADMAP AFTER BRIDGE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#11-acceptance-criteria" class="md-nav__link">
<span class="md-ellipsis">
11. ACCEPTANCE CRITERIA
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="matrix-rooms-bridge-daarioncity">MATRIX ROOMS BRIDGE — DAARION.city<a class="headerlink" href="#matrix-rooms-bridge-daarioncity" title="Permanent link">&para;</a></h1>
<p>Version: 1.0.0</p>
<h2 id="0-purpose">0. PURPOSE<a class="headerlink" href="#0-purpose" title="Permanent link">&para;</a></h2>
<p>Звʼязати City Rooms у DAARION з Matrix-кімнатами так, щоб:</p>
<ul>
<li>кожна <code>city_room</code> мала свій <code>matrix_room_id</code> / <code>matrix_room_alias</code>,</li>
<li>UI для <code>/city/[slug]</code> працював поверх справжньої Matrix-кімнати,</li>
<li>подальший presence/typing/реальний чат використовували Matrix як єдине джерело істини.</li>
</ul>
<p>Це база для:</p>
<ul>
<li>живих чатів у City,</li>
<li>спільної присутності,</li>
<li>інтеграції агентів як Matrix-botʼів.</li>
</ul>
<hr />
<h2 id="1-architecture-overview">1. ARCHITECTURE OVERVIEW<a class="headerlink" href="#1-architecture-overview" title="Permanent link">&para;</a></h2>
<h3 id="_1">Сервіси<a class="headerlink" href="#_1" title="Permanent link">&para;</a></h3>
<ul>
<li><strong>city-service</strong> (7001)</li>
<li>зберігає список кімнат (rooms)</li>
<li>
<p>розширюється полями для Matrix</p>
</li>
<li>
<p><strong>matrix-gateway</strong> (новий сервіс, 7025)</p>
</li>
<li>проксі до Synapse REST API</li>
<li>
<p>хендлить auth до Matrix від імені DAARION</p>
</li>
<li>
<p><strong>auth-service</strong> (7020)</p>
</li>
<li>
<p>вже створює Matrix акаунти для юзерів (auto-provisioning)</p>
</li>
<li>
<p><strong>synapse</strong> (8018)</p>
</li>
<li>Matrix homeserver</li>
</ul>
<h3 id="_2">Мапінг<a class="headerlink" href="#_2" title="Permanent link">&para;</a></h3>
<p>Кожна City Room має:</p>
<table>
<thead>
<tr>
<th>Поле</th>
<th>Опис</th>
<th>Приклад</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>room_id</code></td>
<td>внутрішній DAARION id</td>
<td><code>room_city_general</code></td>
</tr>
<tr>
<td><code>slug</code></td>
<td>URL/імена кімнати</td>
<td><code>general</code></td>
</tr>
<tr>
<td><code>matrix_room_id</code></td>
<td>Matrix ID</td>
<td><code>!abc123xyz:daarion.space</code></td>
</tr>
<tr>
<td><code>matrix_room_alias</code></td>
<td>Matrix alias</td>
<td><code>#city_general:daarion.space</code></td>
</tr>
</tbody>
</table>
<hr />
<h2 id="2-data-model-changes-postgresql">2. DATA MODEL CHANGES (PostgreSQL)<a class="headerlink" href="#2-data-model-changes-postgresql" title="Permanent link">&para;</a></h2>
<h3 id="21-city_rooms">2.1. Таблиця city_rooms<a class="headerlink" href="#21-city_rooms" title="Permanent link">&para;</a></h3>
<p>Додати поля:</p>
<div class="codehilite"><pre><span></span><code><span class="k">ALTER</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="n">city_rooms</span>
<span class="w"> </span><span class="k">ADD</span><span class="w"> </span><span class="k">COLUMN</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="n">matrix_room_id</span><span class="w"> </span><span class="nb">TEXT</span><span class="p">,</span>
<span class="w"> </span><span class="k">ADD</span><span class="w"> </span><span class="k">COLUMN</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="n">matrix_room_alias</span><span class="w"> </span><span class="nb">TEXT</span><span class="p">;</span>
<span class="k">CREATE</span><span class="w"> </span><span class="k">UNIQUE</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="n">city_rooms_matrix_room_id_uq</span>
<span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">city_rooms</span><span class="w"> </span><span class="p">(</span><span class="n">matrix_room_id</span><span class="p">)</span>
<span class="w"> </span><span class="k">WHERE</span><span class="w"> </span><span class="n">matrix_room_id</span><span class="w"> </span><span class="k">IS</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span><span class="p">;</span>
<span class="k">CREATE</span><span class="w"> </span><span class="k">UNIQUE</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="n">city_rooms_matrix_room_alias_uq</span>
<span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">city_rooms</span><span class="w"> </span><span class="p">(</span><span class="n">matrix_room_alias</span><span class="p">)</span>
<span class="w"> </span><span class="k">WHERE</span><span class="w"> </span><span class="n">matrix_room_alias</span><span class="w"> </span><span class="k">IS</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span><span class="p">;</span>
</code></pre></div>
<h3 id="22-invariants">2.2. Invariants<a class="headerlink" href="#22-invariants" title="Permanent link">&para;</a></h3>
<ul>
<li><code>matrix_room_id</code>або <code>NULL</code>, або валідний Matrix room id (<code>!....:domain</code>)</li>
<li><code>matrix_room_alias</code>або <code>NULL</code>, або вигляду <code>#city_&lt;slug&gt;:daarion.space</code></li>
<li>Один Matrix room = одна City room</li>
</ul>
<hr />
<h2 id="3-naming-convention">3. NAMING CONVENTION<a class="headerlink" href="#3-naming-convention" title="Permanent link">&para;</a></h2>
<p>Для Matrix-кімнат:</p>
<ul>
<li><strong>room alias</strong>:</li>
<li>формат: <code>#city_&lt;slug&gt;:daarion.space</code></li>
<li>
<p>приклад: <code>#city_general:daarion.space</code></p>
</li>
<li>
<p><strong>room name</strong>:</p>
</li>
<li><code>"DAARION City — &lt;Room Name&gt;"</code></li>
<li>приклад: <code>"DAARION City — General"</code></li>
</ul>
<p>Ці назви видно в Matrix-клієнтах (Element Web).</p>
<hr />
<h2 id="4-flows">4. FLOWS<a class="headerlink" href="#4-flows" title="Permanent link">&para;</a></h2>
<h3 id="41-city-room">4.1. Створення нової City Room<a class="headerlink" href="#41-city-room" title="Permanent link">&para;</a></h3>
<p>Коли в <code>city-service</code> створюється новий room:</p>
<ol>
<li>
<p>Генерується <code>slug</code> (як є зараз).</p>
</li>
<li>
<p>Викликається Matrix Gateway:
<code>POST /internal/matrix/rooms/create</code>:
<code>json
{
"slug": "energy",
"name": "Energy",
"visibility": "public"
}</code></p>
</li>
<li>
<p>Matrix Gateway:</p>
</li>
<li>викликає Synapse API <code>POST /_matrix/client/v3/createRoom</code></li>
<li>задає:<ul>
<li><code>name: "DAARION City — Energy"</code></li>
<li><code>room_alias_name: "city_energy"</code></li>
<li><code>preset: "public_chat"</code></li>
</ul>
</li>
<li>
<p>повертає:
<code>json
{
"matrix_room_id": "!abc123:daarion.space",
"matrix_room_alias": "#city_energy:daarion.space"
}</code></p>
</li>
<li>
<p><code>city-service</code> зберігає ці значення в <code>city_rooms</code>.</p>
</li>
</ol>
<p><strong>Якщо Matrix недоступний:</strong>
* MVP: fail створення кімнати цілком, щоб не було "неповних" кімнат.
* TODO: retry-механізм для production.</p>
<hr />
<h3 id="42-backfill">4.2. Синхронізація існуючих кімнат (backfill)<a class="headerlink" href="#42-backfill" title="Permanent link">&para;</a></h3>
<p>Для вже створених <code>city_rooms</code>:</p>
<ol>
<li>Endpoint: <code>POST /internal/city/matrix/backfill</code>:</li>
<li>бере всі кімнати, де <code>matrix_room_id IS NULL</code>.</li>
<li>для кожної:<ul>
<li>пробує знайти Matrix room по alias <code>#city_&lt;slug&gt;:daarion.space</code> через Matrix Gateway:</li>
<li>якщо знайдено → зберігає <code>matrix_room_id</code> / <code>matrix_room_alias</code>;</li>
<li>якщо не знайдено → створює нову Matrix room, як у п. 4.1.</li>
</ul>
</li>
</ol>
<hr />
<h3 id="43-room">4.3. Архівація / деактивація Room<a class="headerlink" href="#43-room" title="Permanent link">&para;</a></h3>
<p>Коли Room в DAARION позначається як "archived" / "inactive":</p>
<p>MVP:
* не видаляти Matrix room,
* показувати статус в DAARION UI як <code>archived</code>.</p>
<p>Future:
* змінити power levels,
* закрити можливість писати,
* додати <code>m.room.tombstone</code>.</p>
<hr />
<h2 id="5-matrix-gateway-service">5. MATRIX GATEWAY SERVICE<a class="headerlink" href="#5-matrix-gateway-service" title="Permanent link">&para;</a></h2>
<h3 id="51">5.1. Конфігурація<a class="headerlink" href="#51" title="Permanent link">&para;</a></h3>
<div class="codehilite"><pre><span></span><code>MATRIX_GATEWAY_PORT=7025
SYNAPSE_URL=http://daarion-synapse:8008
SYNAPSE_ADMIN_TOKEN=&lt;admin_access_token&gt;
MATRIX_SERVER_NAME=daarion.space
</code></pre></div>
<h3 id="52-api-endpoints">5.2. API Endpoints<a class="headerlink" href="#52-api-endpoints" title="Permanent link">&para;</a></h3>
<h4 id="post-internalmatrixroomscreate"><code>POST /internal/matrix/rooms/create</code><a class="headerlink" href="#post-internalmatrixroomscreate" title="Permanent link">&para;</a></h4>
<p>Викликається тільки з <code>city-service</code>.</p>
<p><strong>Request:</strong></p>
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;energy&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Energy&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;visibility&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;public&quot;</span>
<span class="p">}</span>
</code></pre></div>
<p><strong>Response (200):</strong></p>
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;matrix_room_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;!abc123:daarion.space&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;matrix_room_alias&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#city_energy:daarion.space&quot;</span>
<span class="p">}</span>
</code></pre></div>
<p><strong>Response (500):</strong></p>
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;error&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;matrix_unavailable&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Failed to create Matrix room&quot;</span>
<span class="p">}</span>
</code></pre></div>
<h4 id="get-internalmatrixroomsfind-by-alias"><code>GET /internal/matrix/rooms/find-by-alias</code><a class="headerlink" href="#get-internalmatrixroomsfind-by-alias" title="Permanent link">&para;</a></h4>
<p><strong>Request:</strong>
<code>GET /internal/matrix/rooms/find-by-alias?alias=%23city_energy%3Adaarion.space</code></p>
<p><strong>Response (200, exists):</strong></p>
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;matrix_room_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;!abc123:daarion.space&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;matrix_room_alias&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#city_energy:daarion.space&quot;</span>
<span class="p">}</span>
</code></pre></div>
<p><strong>Response (404, not found):</strong></p>
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;error&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;not_found&quot;</span>
<span class="p">}</span>
</code></pre></div>
<h4 id="get-healthz"><code>GET /healthz</code><a class="headerlink" href="#get-healthz" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ok&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;synapse&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;connected&quot;</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h2 id="6-city-service-api-changes">6. CITY-SERVICE API CHANGES<a class="headerlink" href="#6-city-service-api-changes" title="Permanent link">&para;</a></h2>
<h3 id="61-get-apicityrooms">6.1. <code>GET /api/city/rooms</code><a class="headerlink" href="#61-get-apicityrooms" title="Permanent link">&para;</a></h3>
<p>Додати у відповідь:</p>
<div class="codehilite"><pre><span></span><code><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;room_city_general&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;slug&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;general&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;General&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Головна кімната міста&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;is_default&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;members_online&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;last_event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025-11-26T20:00:00Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;matrix_room_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;!abc123:daarion.space&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;matrix_room_alias&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#city_general:daarion.space&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">]</span>
</code></pre></div>
<h3 id="62-get-apicityroomsslug">6.2. <code>GET /api/city/rooms/{slug}</code><a class="headerlink" href="#62-get-apicityroomsslug" title="Permanent link">&para;</a></h3>
<p>Також включити <code>matrix_room_id</code> / <code>matrix_room_alias</code>.</p>
<h3 id="63-post-apicityrooms">6.3. <code>POST /api/city/rooms</code><a class="headerlink" href="#63-post-apicityrooms" title="Permanent link">&para;</a></h3>
<p>При створенні кімнати автоматично створювати Matrix room.</p>
<hr />
<h2 id="7-frontend-integration">7. FRONTEND INTEGRATION<a class="headerlink" href="#7-frontend-integration" title="Permanent link">&para;</a></h2>
<p>На сторінці <code>/city/[slug]</code>:</p>
<ul>
<li>при завантаженні room:</li>
<li>отримати <code>matrix_room_id</code> / <code>matrix_room_alias</code>,</li>
<li>передати їх у чат-Layout.</li>
</ul>
<p>Чат-шар (<code>ChatRoom</code>) повинен:
* використовувати Matrix-клієнт для:
* приєднання до кімнати,
* отримання історії,
* відправки повідомлень.</p>
<hr />
<h2 id="8-security">8. SECURITY<a class="headerlink" href="#8-security" title="Permanent link">&para;</a></h2>
<ul>
<li><code>matrix-gateway</code> endpoint'и <code>/internal/matrix/*</code>:</li>
<li>тільки internal auth (service-to-service)</li>
<li>
<p>перевірка internal token або Docker network</p>
</li>
<li>
<p>Кінцеві користувачі не повинні напряму бачити Matrix admin-credentials.</p>
</li>
</ul>
<hr />
<h2 id="9-deployment">9. DEPLOYMENT<a class="headerlink" href="#9-deployment" title="Permanent link">&para;</a></h2>
<h3 id="docker-compose-addition">Docker Compose addition<a class="headerlink" href="#docker-compose-addition" title="Permanent link">&para;</a></h3>
<div class="codehilite"><pre><span></span><code><span class="nt">matrix-gateway</span><span class="p">:</span>
<span class="w"> </span><span class="nt">build</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./services/matrix-gateway</span>
<span class="w"> </span><span class="nt">container_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">daarion-matrix-gateway</span>
<span class="w"> </span><span class="nt">restart</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
<span class="w"> </span><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MATRIX_GATEWAY_PORT=7025</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SYNAPSE_URL=http://daarion-synapse:8008</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SYNAPSE_ADMIN_TOKEN=${SYNAPSE_ADMIN_TOKEN}</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MATRIX_SERVER_NAME=daarion.space</span>
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&quot;7025:7025&quot;</span>
<span class="w"> </span><span class="nt">networks</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dagi-network</span>
<span class="w"> </span><span class="nt">depends_on</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">synapse</span>
</code></pre></div>
<h3 id="nginx-routing">Nginx routing<a class="headerlink" href="#nginx-routing" title="Permanent link">&para;</a></h3>
<div class="codehilite"><pre><span></span><code><span class="k">location</span><span class="w"> </span><span class="s">/internal/matrix/</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1"># Internal only - block external access</span>
<span class="w"> </span><span class="kn">allow</span><span class="w"> </span><span class="mi">127</span><span class="s">.0.0.1</span><span class="p">;</span>
<span class="w"> </span><span class="kn">deny</span><span class="w"> </span><span class="s">all</span><span class="p">;</span>
<span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://127.0.0.1:7025/internal/matrix/</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h2 id="10-roadmap-after-bridge">10. ROADMAP AFTER BRIDGE<a class="headerlink" href="#10-roadmap-after-bridge" title="Permanent link">&para;</a></h2>
<p>Після реалізації цього SPEC:</p>
<ol>
<li><strong>Presence &amp; Typing:</strong></li>
<li>читати <code>m.presence</code>, <code>m.typing</code>, <code>m.receipt</code> з Matrix,</li>
<li>
<p>транслювати в фронт (через WebSocket).</p>
</li>
<li>
<p><strong>Agents як Matrix Bot:</strong></p>
</li>
<li>окремі Matrix accounts для агентів,</li>
<li>
<p>відповіді агентів у тій же кімнаті, що й користувачі.</p>
</li>
<li>
<p><strong>City Map:</strong></p>
</li>
<li>
<p>візуалізація активності кімнат на 2D/2.5D мапі.</p>
</li>
<li>
<p><strong>PWA/Mobile:</strong></p>
</li>
<li>manifest.json,</li>
<li>service worker,</li>
<li>offline кеш.</li>
</ol>
<hr />
<h2 id="11-acceptance-criteria">11. ACCEPTANCE CRITERIA<a class="headerlink" href="#11-acceptance-criteria" title="Permanent link">&para;</a></h2>
<ul>
<li>[ ] <code>city_rooms</code> має поля <code>matrix_room_id</code> / <code>matrix_room_alias</code></li>
<li>[ ] При створенні City Room автоматично створюється Matrix room</li>
<li>[ ] Backfill endpoint синхронізує існуючі кімнати</li>
<li>[ ] API <code>/api/city/rooms</code> повертає matrix поля</li>
<li>[ ] Matrix Gateway працює і відповідає на healthcheck</li>
<li>[ ] Element Web показує створені кімнати</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.instant", "content.code.copy"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.3220b9d7.min.js"></script>
</body>
</html>