1172 lines
64 KiB
HTML
1172 lines
64 KiB
HTML
|
||
<!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_PRESENCE_TYPING_SPEC/">
|
||
|
||
|
||
|
||
|
||
<link rel="icon" href="../../assets/images/favicon.png">
|
||
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
|
||
|
||
|
||
|
||
<title>MATRIX PRESENCE & TYPING — 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-presence-typing-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 PRESENCE & TYPING — 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-matrix-events" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
1. MATRIX EVENTS
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="1. MATRIX EVENTS">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#11-presence-events-mpresence" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
1.1. Presence events (m.presence)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#12-typing-events-mtyping" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
1.2. Typing events (m.typing)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#2-frontend-architecture" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
2. FRONTEND ARCHITECTURE
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="2. FRONTEND ARCHITECTURE">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#existing-components" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Existing Components:
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#new-additions" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
New Additions:
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#3-matrix-client-sync-loop" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
3. MATRIX CLIENT: SYNC LOOP
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="3. MATRIX CLIENT: SYNC LOOP">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#31-sync-filter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
3.1. Sync Filter
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#32-matrixrestclient-extensions" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
3.2. MatrixRestClient Extensions
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#4-matrixchatroom-integration" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
4. MATRIXCHATROOM INTEGRATION
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="4. MATRIXCHATROOM INTEGRATION">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#41-state" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
4.1. State
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#42-callbacks" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
4.2. Callbacks
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#43-send-typing-notification" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
4.3. Send Typing Notification
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#5-ui-display" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
5. UI DISPLAY
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="5. UI DISPLAY">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#51-header-room-info" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
5.1. Header (Room Info)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#52-typing-indicator" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
5.2. Typing Indicator
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#6-limitations-mvp" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
6. LIMITATIONS / MVP
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#7-api-summary" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
7. API SUMMARY
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="7. API SUMMARY">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#matrix-client-server-api" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
Matrix Client-Server API
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#8-roadmap" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
8. ROADMAP (далі)
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#9-acceptance-criteria" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
9. 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-presence-typing-daarioncity">MATRIX PRESENCE & TYPING — DAARION.city<a class="headerlink" href="#matrix-presence-typing-daarioncity" title="Permanent link">¶</a></h1>
|
||
<p>Version: 1.0.0</p>
|
||
<h2 id="0-purpose">0. PURPOSE<a class="headerlink" href="#0-purpose" title="Permanent link">¶</a></h2>
|
||
<p>Додати у Matrix-чат DAARION (сторінка <code>/city/[slug]</code>) базові реальні індикатори:</p>
|
||
<ul>
|
||
<li>хто <strong>онлайн</strong> у кімнаті,</li>
|
||
<li>хто <strong>друкує</strong> зараз (typing).</li>
|
||
</ul>
|
||
<p>Це робиться поверх уже працюючого Matrix Chat Client.</p>
|
||
<hr />
|
||
<h2 id="1-matrix-events">1. MATRIX EVENTS<a class="headerlink" href="#1-matrix-events" title="Permanent link">¶</a></h2>
|
||
<p>Матриця дає 2 типи відповідних подій (через <code>/sync</code>):</p>
|
||
<h3 id="11-presence-events-mpresence">1.1. Presence events (<code>m.presence</code>)<a class="headerlink" href="#11-presence-events-mpresence" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"m.presence"</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="nt">"sender"</span><span class="p">:</span><span class="w"> </span><span class="s2">"@user:daarion.space"</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"presence"</span><span class="p">:</span><span class="w"> </span><span class="s2">"online"</span><span class="p">,</span><span class="w"> </span><span class="c1">// "online" | "offline" | "unavailable"</span>
|
||
<span class="w"> </span><span class="nt">"last_active_ago"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="nt">"currently_active"</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">"status_msg"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Working..."</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div>
|
||
|
||
<h3 id="12-typing-events-mtyping">1.2. Typing events (<code>m.typing</code>)<a class="headerlink" href="#12-typing-events-mtyping" title="Permanent link">¶</a></h3>
|
||
<p>В <code>rooms.join[roomId].ephemeral.events</code>:</p>
|
||
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"m.typing"</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="nt">"content"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"user_ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"@user1:daarion.space"</span><span class="p">,</span><span class="w"> </span><span class="s2">"@user2:daarion.space"</span><span class="p">]</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div>
|
||
|
||
<hr />
|
||
<h2 id="2-frontend-architecture">2. FRONTEND ARCHITECTURE<a class="headerlink" href="#2-frontend-architecture" title="Permanent link">¶</a></h2>
|
||
<h3 id="existing-components">Existing Components:<a class="headerlink" href="#existing-components" title="Permanent link">¶</a></h3>
|
||
<ul>
|
||
<li><code>lib/matrix-client.ts</code> — <code>MatrixRestClient</code></li>
|
||
<li><code>MatrixChatRoom</code> — працює з повідомленнями та статусом підключення</li>
|
||
</ul>
|
||
<h3 id="new-additions">New Additions:<a class="headerlink" href="#new-additions" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="err">┌─────────────────────────────────────────────────────────────────┐</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="n">MatrixChatRoom</span><span class="w"> </span><span class="n">Component</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">┌─────────────────────────────────────────────────────────┐</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="n">Header</span><span class="o">:</span><span class="w"> </span><span class="s">"General · 5 online"</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">└─────────────────────────────────────────────────────────┘</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">┌─────────────────────────────────────────────────────────┐</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="n">Messages</span><span class="w"> </span><span class="n">Area</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="p">[</span><span class="n">message</span><span class="w"> </span><span class="mi">1</span><span class="p">]</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="p">[</span><span class="n">message</span><span class="w"> </span><span class="mi">2</span><span class="p">]</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">└─────────────────────────────────────────────────────────┘</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">┌─────────────────────────────────────────────────────────┐</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="n">Typing</span><span class="o">:</span><span class="w"> </span><span class="s">"User abc друкує..."</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="p">[</span><span class="n">Input</span><span class="w"> </span><span class="n">field</span><span class="p">]</span><span class="w"> </span><span class="err">│</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">│</span><span class="w"> </span><span class="err">└─────────────────────────────────────────────────────────┘</span><span class="w"> </span><span class="err">│</span>
|
||
<span class="err">└─────────────────────────────────────────────────────────────────┘</span>
|
||
</code></pre></div>
|
||
|
||
<hr />
|
||
<h2 id="3-matrix-client-sync-loop">3. MATRIX CLIENT: SYNC LOOP<a class="headerlink" href="#3-matrix-client-sync-loop" title="Permanent link">¶</a></h2>
|
||
<h3 id="31-sync-filter">3.1. Sync Filter<a class="headerlink" href="#31-sync-filter" title="Permanent link">¶</a></h3>
|
||
<p>При виклику <code>/sync</code> використовуємо filter:</p>
|
||
<div class="codehilite"><pre><span></span><code><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"presence"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"types"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"m.presence"</span><span class="p">]</span>
|
||
<span class="w"> </span><span class="p">},</span>
|
||
<span class="w"> </span><span class="nt">"room"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"timeline"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"limit"</span><span class="p">:</span><span class="w"> </span><span class="mi">50</span>
|
||
<span class="w"> </span><span class="p">},</span>
|
||
<span class="w"> </span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"lazy_load_members"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
|
||
<span class="w"> </span><span class="p">},</span>
|
||
<span class="w"> </span><span class="nt">"ephemeral"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nt">"types"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"m.typing"</span><span class="p">,</span><span class="w"> </span><span class="s2">"m.receipt"</span><span class="p">]</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div>
|
||
|
||
<h3 id="32-matrixrestclient-extensions">3.2. MatrixRestClient Extensions<a class="headerlink" href="#32-matrixrestclient-extensions" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="kd">interface</span><span class="w"> </span><span class="nx">PresenceEvent</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s1">'m.presence'</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">sender</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">content</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nx">presence</span><span class="o">:</span><span class="w"> </span><span class="s1">'online'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="s1">'offline'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="s1">'unavailable'</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">last_active_ago?</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">currently_active?</span><span class="o">:</span><span class="w"> </span><span class="kt">boolean</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">status_msg?</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="p">};</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="kd">interface</span><span class="w"> </span><span class="nx">TypingEvent</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s1">'m.typing'</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">content</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nx">user_ids</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">[];</span>
|
||
<span class="w"> </span><span class="p">};</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="kd">class</span><span class="w"> </span><span class="nx">MatrixRestClient</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="c1">// Callbacks</span>
|
||
<span class="w"> </span><span class="nx">onPresence</span><span class="o">?:</span><span class="w"> </span><span class="p">(</span><span class="nx">event</span><span class="o">:</span><span class="w"> </span><span class="kt">PresenceEvent</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="ow">void</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">onTyping</span><span class="o">?:</span><span class="w"> </span><span class="p">(</span><span class="nx">roomId</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="nx">userIds</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">[])</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="ow">void</span><span class="p">;</span>
|
||
|
||
<span class="w"> </span><span class="c1">// Enhanced sync loop</span>
|
||
<span class="w"> </span><span class="k">private</span><span class="w"> </span><span class="k">async</span><span class="w"> </span><span class="nx">syncLoop</span><span class="p">()</span><span class="o">:</span><span class="w"> </span><span class="nb">Promise</span><span class="o"><</span><span class="ow">void</span><span class="o">></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">isSyncing</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="k">this</span><span class="p">.</span><span class="nx">sync</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">syncToken</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="k">this</span><span class="p">.</span><span class="nx">syncToken</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">res</span><span class="p">.</span><span class="nx">next_batch</span><span class="p">;</span>
|
||
|
||
<span class="w"> </span><span class="c1">// Process presence events</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">res</span><span class="p">.</span><span class="nx">presence</span><span class="o">?</span><span class="p">.</span><span class="nx">events</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="kd">const</span><span class="w"> </span><span class="nx">event</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="nx">res</span><span class="p">.</span><span class="nx">presence</span><span class="p">.</span><span class="nx">events</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">event</span><span class="p">.</span><span class="kr">type</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="s1">'m.presence'</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">this</span><span class="p">.</span><span class="nx">onPresence</span><span class="o">?</span><span class="p">.(</span><span class="nx">event</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
|
||
<span class="w"> </span><span class="c1">// Process typing events</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">res</span><span class="p">.</span><span class="nx">rooms</span><span class="o">?</span><span class="p">.</span><span class="nx">join</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="k">this</span><span class="p">.</span><span class="nx">roomId</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">roomData</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">res</span><span class="p">.</span><span class="nx">rooms</span><span class="p">.</span><span class="nx">join</span><span class="p">[</span><span class="k">this</span><span class="p">.</span><span class="nx">roomId</span><span class="p">];</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">roomData</span><span class="o">?</span><span class="p">.</span><span class="nx">ephemeral</span><span class="o">?</span><span class="p">.</span><span class="nx">events</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="kd">const</span><span class="w"> </span><span class="nx">event</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="nx">roomData</span><span class="p">.</span><span class="nx">ephemeral</span><span class="p">.</span><span class="nx">events</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">event</span><span class="p">.</span><span class="kr">type</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="s1">'m.typing'</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">this</span><span class="p">.</span><span class="nx">onTyping</span><span class="o">?</span><span class="p">.(</span><span class="k">this</span><span class="p">.</span><span class="nx">roomId</span><span class="p">,</span><span class="w"> </span><span class="nx">event</span><span class="p">.</span><span class="nx">content</span><span class="p">.</span><span class="nx">user_ids</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
|
||
<span class="w"> </span><span class="c1">// Send typing notification</span>
|
||
<span class="w"> </span><span class="k">async</span><span class="w"> </span><span class="nx">sendTyping</span><span class="p">(</span><span class="nx">roomId</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="nx">typing</span><span class="o">:</span><span class="w"> </span><span class="kt">boolean</span><span class="p">,</span><span class="w"> </span><span class="nx">timeout?</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">)</span><span class="o">:</span><span class="w"> </span><span class="nb">Promise</span><span class="o"><</span><span class="ow">void</span><span class="o">></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">fetch</span><span class="p">(</span>
|
||
<span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="k">this</span><span class="p">.</span><span class="nx">baseUrl</span><span class="si">}</span><span class="sb">/_matrix/client/v3/rooms/</span><span class="si">${</span><span class="nb">encodeURIComponent</span><span class="p">(</span><span class="nx">roomId</span><span class="p">)</span><span class="si">}</span><span class="sb">/typing/</span><span class="si">${</span><span class="nb">encodeURIComponent</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">userId</span><span class="p">)</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nx">method</span><span class="o">:</span><span class="w"> </span><span class="s1">'PUT'</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="kt">this.authHeaders</span><span class="p">(),</span>
|
||
<span class="w"> </span><span class="nx">body</span><span class="o">:</span><span class="w"> </span><span class="kt">JSON.stringify</span><span class="p">({</span>
|
||
<span class="w"> </span><span class="nx">typing</span><span class="p">,</span>
|
||
<span class="w"> </span><span class="nx">timeout</span><span class="o">:</span><span class="w"> </span><span class="kt">timeout</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="mf">30000</span>
|
||
<span class="w"> </span><span class="p">})</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">);</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div>
|
||
|
||
<hr />
|
||
<h2 id="4-matrixchatroom-integration">4. MATRIXCHATROOM INTEGRATION<a class="headerlink" href="#4-matrixchatroom-integration" title="Permanent link">¶</a></h2>
|
||
<h3 id="41-state">4.1. State<a class="headerlink" href="#41-state" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="c1">// Online users in room</span>
|
||
<span class="kd">const</span><span class="w"> </span><span class="p">[</span><span class="nx">onlineUsers</span><span class="p">,</span><span class="w"> </span><span class="nx">setOnlineUsers</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">useState</span><span class="o"><</span><span class="nb">Map</span><span class="o"><</span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="s1">'online'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="s1">'offline'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="s1">'unavailable'</span><span class="o">>></span><span class="p">(</span><span class="ow">new</span><span class="w"> </span><span class="nb">Map</span><span class="p">());</span>
|
||
|
||
<span class="c1">// Users currently typing</span>
|
||
<span class="kd">const</span><span class="w"> </span><span class="p">[</span><span class="nx">typingUsers</span><span class="p">,</span><span class="w"> </span><span class="nx">setTypingUsers</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">useState</span><span class="o"><</span><span class="nb">Set</span><span class="o"><</span><span class="kt">string</span><span class="o">>></span><span class="p">(</span><span class="ow">new</span><span class="w"> </span><span class="nb">Set</span><span class="p">());</span>
|
||
</code></pre></div>
|
||
|
||
<h3 id="42-callbacks">4.2. Callbacks<a class="headerlink" href="#42-callbacks" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="nx">useEffect</span><span class="p">(()</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">)</span><span class="w"> </span><span class="k">return</span><span class="p">;</span>
|
||
|
||
<span class="w"> </span><span class="c1">// Presence handler</span>
|
||
<span class="w"> </span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">.</span><span class="nx">onPresence</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="nx">event</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">event</span><span class="p">.</span><span class="nx">sender</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="o">!</span><span class="nx">event</span><span class="p">.</span><span class="nx">content</span><span class="o">?</span><span class="p">.</span><span class="nx">presence</span><span class="p">)</span><span class="w"> </span><span class="k">return</span><span class="p">;</span>
|
||
|
||
<span class="w"> </span><span class="nx">setOnlineUsers</span><span class="p">(</span><span class="nx">prev</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nb">Map</span><span class="p">(</span><span class="nx">prev</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="nx">next</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="nx">event</span><span class="p">.</span><span class="nx">sender</span><span class="p">,</span><span class="w"> </span><span class="nx">event</span><span class="p">.</span><span class="nx">content</span><span class="p">.</span><span class="nx">presence</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">next</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="p">});</span>
|
||
<span class="w"> </span><span class="p">};</span>
|
||
|
||
<span class="w"> </span><span class="c1">// Typing handler</span>
|
||
<span class="w"> </span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">.</span><span class="nx">onTyping</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="nx">roomId</span><span class="p">,</span><span class="w"> </span><span class="nx">userIds</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">roomId</span><span class="w"> </span><span class="o">!==</span><span class="w"> </span><span class="nx">bootstrap</span><span class="o">?</span><span class="p">.</span><span class="nx">matrix_room_id</span><span class="p">)</span><span class="w"> </span><span class="k">return</span><span class="p">;</span>
|
||
|
||
<span class="w"> </span><span class="c1">// Filter out current user</span>
|
||
<span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">others</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">userIds</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="nx">id</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="nx">id</span><span class="w"> </span><span class="o">!==</span><span class="w"> </span><span class="nx">bootstrap</span><span class="o">?</span><span class="p">.</span><span class="nx">matrix_user_id</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="nx">setTypingUsers</span><span class="p">(</span><span class="ow">new</span><span class="w"> </span><span class="nb">Set</span><span class="p">(</span><span class="nx">others</span><span class="p">));</span>
|
||
<span class="w"> </span><span class="p">};</span>
|
||
|
||
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">.</span><span class="nx">onPresence</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">undefined</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">.</span><span class="nx">onTyping</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">undefined</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">};</span>
|
||
<span class="p">},</span><span class="w"> </span><span class="p">[</span><span class="nx">bootstrap</span><span class="p">]);</span>
|
||
</code></pre></div>
|
||
|
||
<h3 id="43-send-typing-notification">4.3. Send Typing Notification<a class="headerlink" href="#43-send-typing-notification" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="c1">// When user starts typing</span>
|
||
<span class="kd">const</span><span class="w"> </span><span class="nx">handleInputChange</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">useCallback</span><span class="p">(()</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nx">bootstrap</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">.</span><span class="nx">sendTyping</span><span class="p">(</span><span class="nx">bootstrap</span><span class="p">.</span><span class="nx">matrix_room_id</span><span class="p">,</span><span class="w"> </span><span class="kc">true</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="p">},</span><span class="w"> </span><span class="p">[</span><span class="nx">bootstrap</span><span class="p">]);</span>
|
||
|
||
<span class="c1">// When user stops typing (debounced)</span>
|
||
<span class="kd">const</span><span class="w"> </span><span class="nx">handleInputBlur</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">useCallback</span><span class="p">(()</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nx">bootstrap</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nx">matrixClient</span><span class="p">.</span><span class="nx">current</span><span class="p">.</span><span class="nx">sendTyping</span><span class="p">(</span><span class="nx">bootstrap</span><span class="p">.</span><span class="nx">matrix_room_id</span><span class="p">,</span><span class="w"> </span><span class="kc">false</span><span class="p">);</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="p">},</span><span class="w"> </span><span class="p">[</span><span class="nx">bootstrap</span><span class="p">]);</span>
|
||
</code></pre></div>
|
||
|
||
<hr />
|
||
<h2 id="5-ui-display">5. UI DISPLAY<a class="headerlink" href="#5-ui-display" title="Permanent link">¶</a></h2>
|
||
<h3 id="51-header-room-info">5.1. Header (Room Info)<a class="headerlink" href="#51-header-room-info" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="p"><</span><span class="nt">div</span><span class="w"> </span><span class="na">className</span><span class="o">=</span><span class="s">"flex items-center gap-2"</span><span class="p">></span>
|
||
<span class="w"> </span><span class="p"><</span><span class="nt">span</span><span class="w"> </span><span class="na">className</span><span class="o">=</span><span class="s">"text-white font-medium"</span><span class="p">>{</span><span class="nx">room</span><span class="p">.</span><span class="nx">name</span><span class="p">}</</span><span class="nt">span</span><span class="p">></span>
|
||
<span class="w"> </span><span class="p"><</span><span class="nt">span</span><span class="w"> </span><span class="na">className</span><span class="o">=</span><span class="s">"text-slate-400"</span><span class="p">></span><span class="err">·</span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
<span class="w"> </span><span class="p"><</span><span class="nt">span</span><span class="w"> </span><span class="na">className</span><span class="o">=</span><span class="s">"text-emerald-400 text-sm"</span><span class="p">></span>
|
||
<span class="w"> </span><span class="p">{</span><span class="nx">onlineCount</span><span class="p">}</span><span class="w"> </span><span class="nx">online</span>
|
||
<span class="w"> </span><span class="p"></</span><span class="nt">span</span><span class="p">></span>
|
||
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
</code></pre></div>
|
||
|
||
<p>Where <code>onlineCount</code>:</p>
|
||
<div class="codehilite"><pre><span></span><code><span class="kd">const</span><span class="w"> </span><span class="nx">onlineCount</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">useMemo</span><span class="p">(()</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="nx">count</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">0</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="nx">onlineUsers</span><span class="p">.</span><span class="nx">forEach</span><span class="p">((</span><span class="nx">status</span><span class="p">,</span><span class="w"> </span><span class="nx">userId</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">status</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="s1">'online'</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="nx">status</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="s1">'unavailable'</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="c1">// Optionally exclude current user</span>
|
||
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">userId</span><span class="w"> </span><span class="o">!==</span><span class="w"> </span><span class="nx">bootstrap</span><span class="o">?</span><span class="p">.</span><span class="nx">matrix_user_id</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="nx">count</span><span class="o">++</span><span class="p">;</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p">});</span>
|
||
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">count</span><span class="p">;</span>
|
||
<span class="p">},</span><span class="w"> </span><span class="p">[</span><span class="nx">onlineUsers</span><span class="p">,</span><span class="w"> </span><span class="nx">bootstrap</span><span class="p">]);</span>
|
||
</code></pre></div>
|
||
|
||
<h3 id="52-typing-indicator">5.2. Typing Indicator<a class="headerlink" href="#52-typing-indicator" title="Permanent link">¶</a></h3>
|
||
<div class="codehilite"><pre><span></span><code><span class="p">{</span><span class="nx">typingUsers</span><span class="p">.</span><span class="nx">size</span><span class="w"> </span><span class="o">></span><span class="w"> </span><span class="mf">0</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="p">(</span>
|
||
<span class="w"> </span><span class="p"><</span><span class="nt">div</span><span class="w"> </span><span class="na">className</span><span class="o">=</span><span class="s">"px-4 py-1 text-sm text-slate-400 animate-pulse"</span><span class="p">></span>
|
||
<span class="w"> </span><span class="p">{</span><span class="nx">typingUsers</span><span class="p">.</span><span class="nx">size</span><span class="w"> </span><span class="o">===</span><span class="w"> </span><span class="mf">1</span><span class="w"> </span>
|
||
<span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="nx">formatUserName</span><span class="p">(</span><span class="nb">Array</span><span class="p">.</span><span class="kr">from</span><span class="p">(</span><span class="nx">typingUsers</span><span class="p">)[</span><span class="mf">0</span><span class="p">])</span><span class="si">}</span><span class="sb"> друкує...`</span>
|
||
<span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s1">'Декілька учасників друкують...'</span><span class="p">}</span>
|
||
<span class="w"> </span><span class="p"></</span><span class="nt">div</span><span class="p">></span>
|
||
<span class="p">)}</span>
|
||
</code></pre></div>
|
||
|
||
<p>Helper function:</p>
|
||
<div class="codehilite"><pre><span></span><code><span class="kd">function</span><span class="w"> </span><span class="nx">formatUserName</span><span class="p">(</span><span class="nx">userId</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">)</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="w"> </span><span class="p">{</span>
|
||
<span class="w"> </span><span class="c1">// @daarion_abc123:daarion.space -> User abc123</span>
|
||
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">userId</span>
|
||
<span class="w"> </span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s1">':'</span><span class="p">)[</span><span class="mf">0</span><span class="p">]</span>
|
||
<span class="w"> </span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="s1">'@daarion_'</span><span class="p">,</span><span class="w"> </span><span class="s1">'User '</span><span class="p">)</span>
|
||
<span class="w"> </span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="s1">'@'</span><span class="p">,</span><span class="w"> </span><span class="s1">''</span><span class="p">);</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div>
|
||
|
||
<hr />
|
||
<h2 id="6-limitations-mvp">6. LIMITATIONS / MVP<a class="headerlink" href="#6-limitations-mvp" title="Permanent link">¶</a></h2>
|
||
<ul>
|
||
<li>✅ Presence/typing працює тільки в <strong>активній кімнаті</strong> (<code>/city/[slug]</code>)</li>
|
||
<li>❌ Не кешуємо статуси між сесіями</li>
|
||
<li>❌ Не показуємо, хто саме онлайн у списку кімнат</li>
|
||
<li>❌ Не показуємо read receipts / last seen</li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="7-api-summary">7. API SUMMARY<a class="headerlink" href="#7-api-summary" title="Permanent link">¶</a></h2>
|
||
<h3 id="matrix-client-server-api">Matrix Client-Server API<a class="headerlink" href="#matrix-client-server-api" title="Permanent link">¶</a></h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Endpoint</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/_matrix/client/v3/sync</code></td>
|
||
<td>Get presence + typing events</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PUT</td>
|
||
<td><code>/_matrix/client/v3/rooms/{roomId}/typing/{userId}</code></td>
|
||
<td>Send typing notification</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr />
|
||
<h2 id="8-roadmap">8. ROADMAP (далі)<a class="headerlink" href="#8-roadmap" title="Permanent link">¶</a></h2>
|
||
<p>Після цієї фази:</p>
|
||
<ol>
|
||
<li><strong>Room-level activity:</strong></li>
|
||
<li>
|
||
<p>агрегація онлайн/активності на рівні <code>/city</code> списку.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Read receipts / last read marker.</strong></p>
|
||
</li>
|
||
<li>
|
||
<p><strong>PWA/Mobile presence:</strong></p>
|
||
</li>
|
||
<li>збереження останнього статусу офлайн,</li>
|
||
<li>push при нових повідомленнях у кімнатах.</li>
|
||
</ol>
|
||
<hr />
|
||
<h2 id="9-acceptance-criteria">9. ACCEPTANCE CRITERIA<a class="headerlink" href="#9-acceptance-criteria" title="Permanent link">¶</a></h2>
|
||
<ul>
|
||
<li>[ ] Sync loop обробляє <code>m.presence</code> та <code>m.typing</code> події</li>
|
||
<li>[ ] Header показує кількість online користувачів</li>
|
||
<li>[ ] Typing indicator показує хто друкує</li>
|
||
<li>[ ] Користувач може надсилати typing notification</li>
|
||
<li>[ ] При виході з кімнати callbacks очищуються</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> |