client.py 75 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138
  1. # ⚠️ GENERATED by scripts/generate_sync.py from chattolib/client.py — do not edit.
  2. # Edit the async source and re-run the generator.
  3. """Main synchronous client for the Chatto Connect API.
  4. Chatto migrated from GraphQL to a protobuf-first Connect API in v0.4.x
  5. (see ADR-042). The client speaks Connect binary protobuf via the official
  6. ``connectrpc`` Python package and the generated service stubs under
  7. ``chattolib._pb`` for all request/response operations. Realtime events
  8. live in ``chattolib.realtime``.
  9. """
  10. # mypy: disable-error-code="no-any-return"
  11. # Rationale: attribute access on generated protobuf messages is Any-typed
  12. # from mypy's perspective (the generated modules skip type checking via
  13. # follow_imports=skip). The runtime types are exactly what the return-type
  14. # annotations claim.
  15. from __future__ import annotations
  16. import hashlib
  17. from datetime import datetime
  18. from pathlib import Path
  19. from typing import Any, TypeVar
  20. import httpx
  21. # ConnectError isn't re-exported publicly by connectrpc.__init__; import from
  22. # its submodule so the top-level import path stays clean for callers.
  23. from chattolib._pb.chatto.admin.v1 import (
  24. event_log_pb2,
  25. room_layout_pb2,
  26. )
  27. from chattolib._pb.chatto.admin.v1 import (
  28. members_pb2 as admin_members_pb2,
  29. )
  30. from chattolib._pb.chatto.admin.v1 import (
  31. permissions_pb2 as admin_permissions_pb2,
  32. )
  33. from chattolib._pb.chatto.admin.v1 import (
  34. roles_pb2 as admin_roles_pb2,
  35. )
  36. from chattolib._pb.chatto.admin.v1 import (
  37. server_pb2 as admin_server_pb2,
  38. )
  39. from chattolib._pb.chatto.api.v1 import (
  40. account_pb2,
  41. asset_uploads_pb2,
  42. attachments_pb2,
  43. common_pb2,
  44. external_identities_pb2,
  45. link_previews_pb2,
  46. member_directory_pb2,
  47. messages_pb2,
  48. notification_preferences_pb2,
  49. notifications_pb2,
  50. pagination_pb2,
  51. presence_pb2,
  52. push_notifications_pb2,
  53. reactions_pb2,
  54. read_state_pb2,
  55. roles_pb2,
  56. room_directory_pb2,
  57. room_timeline_pb2,
  58. rooms_pb2,
  59. server_state_pb2,
  60. threads_pb2,
  61. user_status_pb2,
  62. viewer_pb2,
  63. voice_calls_pb2,
  64. )
  65. from chattolib._pb.chatto.auth.v1 import external_identity_auth_pb2
  66. from chattolib._pb.chatto.discovery.v1 import server_pb2 as discovery_server_pb2
  67. from chattolib._transport import (
  68. ServiceClientsSync,
  69. build_service_clients_sync,
  70. pb_to_dict,
  71. )
  72. from chattolib.exceptions import ChattoAuthError, ChattoError
  73. from chattolib.types import (
  74. ActiveCall,
  75. AdminEventLogEntry,
  76. AdminEventLogPage,
  77. AdminMember,
  78. AdminMemberDetail,
  79. AdminRole,
  80. AdminRoleDetail,
  81. AdminRoomLayoutGroup,
  82. AdminRoomLayoutItemKind,
  83. AdminSystemInfoSnapshot,
  84. Asset,
  85. AssetUpload,
  86. CustomUserStatus,
  87. DirectoryMember,
  88. ExternalIdentityAccount,
  89. ExternalIdentityProvider,
  90. FollowedThread,
  91. FollowedThreadsPage,
  92. ImageTransformOptions,
  93. LinkedExternalIdentity,
  94. LinkPreview,
  95. Message,
  96. Notification,
  97. NotificationLevel,
  98. NotificationPreference,
  99. NotificationsPage,
  100. Page,
  101. PendingExternalIdentity,
  102. PresenceStatus,
  103. Role,
  104. RolePermissionDecisions,
  105. RolePermissionMatrix,
  106. Room,
  107. RoomBan,
  108. RoomDirectoryScope,
  109. RoomGroup,
  110. RoomWithViewerState,
  111. ServerConfig,
  112. ServerLogin,
  113. ServerProfile,
  114. ServerRuntimeConfig,
  115. SidebarLink,
  116. TimeFormat,
  117. TimelinePage,
  118. User,
  119. UserPermissionDecisions,
  120. UserPermissionMatrix,
  121. UserSettings,
  122. ViewerSnapshot,
  123. ViewerUser,
  124. format_datetime,
  125. parse_datetime,
  126. )
  127. RES = TypeVar("RES")
  128. def _page_pb(limit: int | None, offset: int | None) -> pagination_pb2.PageRequest | None:
  129. if limit is None and offset is None:
  130. return None
  131. return pagination_pb2.PageRequest(limit=limit or 0, offset=offset or 0)
  132. def _thumbnail_pb(
  133. opts: ImageTransformOptions | None,
  134. ) -> common_pb2.ImageTransformOptions | None:
  135. if opts is None:
  136. return None
  137. return common_pb2.ImageTransformOptions(
  138. width=opts.width, height=opts.height, fit=opts.fit.value
  139. )
  140. def _timestamp_pb(value: datetime | None) -> Any:
  141. from google.protobuf import timestamp_pb2
  142. if value is None:
  143. return None
  144. ts = timestamp_pb2.Timestamp()
  145. ts.FromJsonString(format_datetime(value))
  146. return ts
  147. class SyncChattoClient:
  148. """Synchronous client for the Chatto Connect API.
  149. Usage::
  150. with SyncChattoClient.login("user", "pass") as client:
  151. viewer = client.get_viewer()
  152. rooms = client.list_rooms()
  153. # Or with an existing token:
  154. with SyncChattoClient(token="cht_...") as client:
  155. ...
  156. """
  157. DEFAULT_BASE_URL = "https://chat.chatto.run"
  158. def __init__(
  159. self,
  160. token: str | None = None,
  161. *,
  162. base_url: str = DEFAULT_BASE_URL,
  163. session_cookie: str | None = None,
  164. service_clients: ServiceClientsSync | None = None,
  165. ) -> None:
  166. self._base_url = base_url.rstrip("/")
  167. self._token = token
  168. self._session_cookie = session_cookie
  169. self._svc = service_clients or build_service_clients_sync(self._base_url)
  170. self._owns_clients = service_clients is None
  171. @classmethod
  172. def login(
  173. cls,
  174. login: str,
  175. password: str,
  176. *,
  177. base_url: str = DEFAULT_BASE_URL,
  178. ) -> SyncChattoClient:
  179. """Authenticate with username and password, returning a connected client.
  180. Uses Chatto's ``/auth/login`` HTTP endpoint (which is still exposed
  181. alongside the Connect API) and captures both the returned bearer token
  182. and any ``chatto_session`` cookie.
  183. """
  184. base = base_url.rstrip("/")
  185. with httpx.Client() as http:
  186. resp = http.post(
  187. f"{base}/auth/login",
  188. json={"login": login, "password": password},
  189. )
  190. if resp.status_code == 401:
  191. raise ChattoAuthError("Invalid credentials")
  192. resp.raise_for_status()
  193. body = resp.json()
  194. token = body.get("token")
  195. session_cookie = None
  196. if "set-cookie" in resp.headers:
  197. for cookie_header in resp.headers.get_list("set-cookie"):
  198. if cookie_header.startswith("chatto_session="):
  199. session_cookie = cookie_header.split(";")[0].split("=", 1)[1]
  200. break
  201. return cls(token=token, base_url=base_url, session_cookie=session_cookie)
  202. def __enter__(self) -> SyncChattoClient:
  203. return self
  204. def __exit__(self, *exc: Any) -> None:
  205. self.close()
  206. def close(self) -> None:
  207. if self._owns_clients:
  208. self._svc.close()
  209. # --- Transport ------------------------------------------------------
  210. @property
  211. def base_url(self) -> str:
  212. return self._base_url
  213. @property
  214. def token(self) -> str | None:
  215. return self._token
  216. @property
  217. def session_cookie(self) -> str | None:
  218. return self._session_cookie
  219. @property
  220. def services(self) -> ServiceClientsSync:
  221. """Direct access to the underlying ConnectRPC service clients.
  222. Useful when a caller wants to reach an RPC that this class doesn't
  223. expose yet, or wants full protobuf messages instead of the
  224. dataclass views returned by the high-level helpers.
  225. """
  226. return self._svc
  227. def _headers(self) -> dict[str, str]:
  228. headers: dict[str, str] = {}
  229. if self._token:
  230. headers["Authorization"] = f"Bearer {self._token}"
  231. if self._session_cookie:
  232. headers["Cookie"] = f"chatto_session={self._session_cookie}"
  233. return headers
  234. def _rpc(self, result: RES) -> RES:
  235. """Return a ConnectRPC result unchanged.
  236. Error translation is performed by the sync transport interceptor
  237. (see :func:`chattolib._transport.build_service_clients_sync`), so on the
  238. sync path this is a passthrough.
  239. """
  240. return result
  241. # --- Server discovery ----------------------------------------------
  242. def get_server(self) -> tuple[ServerProfile, ServerLogin]:
  243. """Public server profile and login options. Does not require auth."""
  244. resp = self._rpc(
  245. self._svc.server_discovery.get_server(
  246. discovery_server_pb2.GetServerRequest(),
  247. headers=self._headers(),
  248. )
  249. )
  250. return (
  251. ServerProfile.parse(pb_to_dict(resp.profile)),
  252. ServerLogin.parse(pb_to_dict(resp.login)),
  253. )
  254. def get_motd(self) -> str | None:
  255. resp = self._rpc(
  256. self._svc.server.get_motd(server_state_pb2.GetMotdRequest(), headers=self._headers())
  257. )
  258. if not resp.HasField("motd"):
  259. return None
  260. return resp.motd
  261. def get_runtime_config(self) -> ServerRuntimeConfig:
  262. resp = self._rpc(
  263. self._svc.server.get_runtime_config(
  264. server_state_pb2.GetRuntimeConfigRequest(),
  265. headers=self._headers(),
  266. )
  267. )
  268. return ServerRuntimeConfig.parse(pb_to_dict(resp.runtime))
  269. # --- Viewer ---------------------------------------------------------
  270. def get_viewer(self) -> ViewerSnapshot:
  271. """Full authenticated viewer snapshot.
  272. Returns a :class:`~chattolib.types.ViewerSnapshot` containing the
  273. current user, capabilities, notification preferences, permission
  274. decisions, and viewer state. Callers that only need the current user's
  275. public profile should use :meth:`me` for a lightweight result.
  276. """
  277. resp = self._rpc(
  278. self._svc.viewer.get_viewer(viewer_pb2.GetViewerRequest(), headers=self._headers())
  279. )
  280. return ViewerSnapshot.parse(pb_to_dict(resp))
  281. def viewer_user(self) -> ViewerUser | None:
  282. snapshot = self.get_viewer()
  283. return snapshot.user
  284. def me(self) -> User:
  285. """Return the authenticated user's public profile."""
  286. viewer = self.viewer_user()
  287. if viewer is None or viewer.profile is None:
  288. raise ChattoAuthError("No authenticated viewer")
  289. return viewer.profile
  290. # --- MyAccount -----------------------------------------------------
  291. def update_profile(
  292. self,
  293. *,
  294. display_name: str | None = None,
  295. login: str | None = None,
  296. ) -> User:
  297. req = account_pb2.UpdateProfileRequest()
  298. if display_name is not None:
  299. req.display_name = display_name
  300. if login is not None:
  301. req.login = login
  302. resp = self._rpc(self._svc.account.update_profile(req, headers=self._headers()))
  303. user = User.parse(pb_to_dict(resp.user))
  304. assert user is not None
  305. return user
  306. def upload_avatar(
  307. self,
  308. file_path: str | Path,
  309. *,
  310. content_type: str = "image/png",
  311. ) -> User:
  312. p = Path(file_path)
  313. req = account_pb2.UploadAvatarRequest(
  314. image=common_pb2.ImageUpload(
  315. image=p.read_bytes(),
  316. filename=p.name,
  317. content_type=content_type,
  318. )
  319. )
  320. resp = self._rpc(self._svc.account.upload_avatar(req, headers=self._headers()))
  321. user = User.parse(pb_to_dict(resp.user))
  322. assert user is not None
  323. return user
  324. def delete_avatar(self) -> User:
  325. resp = self._rpc(
  326. self._svc.account.delete_avatar(
  327. account_pb2.DeleteAvatarRequest(), headers=self._headers()
  328. )
  329. )
  330. user = User.parse(pb_to_dict(resp.user))
  331. assert user is not None
  332. return user
  333. def update_password(self, new_password: str, current_password: str = "") -> User:
  334. resp = self._rpc(
  335. self._svc.account.update_password(
  336. account_pb2.UpdatePasswordRequest(
  337. password=new_password, current_password=current_password
  338. ),
  339. headers=self._headers(),
  340. )
  341. )
  342. user = User.parse(pb_to_dict(resp.user))
  343. assert user is not None
  344. return user
  345. def update_settings(
  346. self,
  347. *,
  348. timezone: str | None = None,
  349. time_format: TimeFormat | None = None,
  350. ) -> UserSettings:
  351. req = account_pb2.UpdateSettingsRequest()
  352. if timezone is not None:
  353. req.timezone = timezone
  354. if time_format is not None:
  355. req.time_format = time_format.value
  356. resp = self._rpc(self._svc.account.update_settings(req, headers=self._headers()))
  357. return UserSettings.parse(pb_to_dict(resp.settings))
  358. def update_presence(
  359. self,
  360. status: PresenceStatus,
  361. *,
  362. user_selected: bool = True,
  363. ) -> PresenceStatus:
  364. if status in (PresenceStatus.UNSPECIFIED, PresenceStatus.OFFLINE):
  365. raise ValueError(
  366. "UNSPECIFIED and OFFLINE cannot be set as presence status; "
  367. "stop refreshing to go offline"
  368. )
  369. req = presence_pb2.UpdatePresenceRequest(status=status.value, user_selected=user_selected)
  370. resp = self._rpc(self._svc.account.update_presence(req, headers=self._headers()))
  371. name = presence_pb2.PresenceStatus.Name(resp.status)
  372. return PresenceStatus(name)
  373. def update_custom_status(
  374. self,
  375. emoji: str,
  376. text: str,
  377. *,
  378. expires_at: datetime | None = None,
  379. ) -> CustomUserStatus | None:
  380. req = user_status_pb2.UpdateCustomStatusRequest(emoji=emoji, text=text)
  381. if expires_at is not None:
  382. req.expires_at.CopyFrom(_timestamp_pb(expires_at))
  383. resp = self._rpc(self._svc.account.update_custom_status(req, headers=self._headers()))
  384. return CustomUserStatus.parse(pb_to_dict(resp).get("status"))
  385. def delete_custom_status(self) -> CustomUserStatus | None:
  386. resp = self._rpc(
  387. self._svc.account.delete_custom_status(
  388. user_status_pb2.DeleteCustomStatusRequest(), headers=self._headers()
  389. )
  390. )
  391. return CustomUserStatus.parse(pb_to_dict(resp).get("status"))
  392. def request_account_deletion(self) -> str:
  393. resp = self._rpc(
  394. self._svc.account.request_account_deletion(
  395. account_pb2.RequestAccountDeletionRequest(),
  396. headers=self._headers(),
  397. )
  398. )
  399. return resp.confirmation_token
  400. def delete_my_account(self, confirmation_token: str) -> bool:
  401. resp = self._rpc(
  402. self._svc.account.delete_my_account(
  403. account_pb2.DeleteMyAccountRequest(confirmation_token=confirmation_token),
  404. headers=self._headers(),
  405. )
  406. )
  407. return resp.deleted
  408. # --- Users ----------------------------------------------------------
  409. def list_users(
  410. self,
  411. *,
  412. search: str = "",
  413. limit: int | None = None,
  414. offset: int | None = None,
  415. ) -> tuple[list[DirectoryMember], Page]:
  416. req = member_directory_pb2.ListUsersRequest(search=search)
  417. page = _page_pb(limit, offset)
  418. if page is not None:
  419. req.page.CopyFrom(page)
  420. resp = self._rpc(self._svc.users.list_users(req, headers=self._headers()))
  421. data = pb_to_dict(resp)
  422. users = [
  423. u
  424. for u in (DirectoryMember.parse(row) for row in data.get("users") or [])
  425. if u is not None
  426. ]
  427. return users, Page.parse(data.get("page"))
  428. def get_user(
  429. self, *, user_id: str | None = None, login: str | None = None
  430. ) -> DirectoryMember | None:
  431. if bool(user_id) == bool(login):
  432. raise ValueError("get_user requires exactly one of user_id or login")
  433. req = member_directory_pb2.GetUserRequest()
  434. if user_id:
  435. req.user_id = user_id
  436. else:
  437. assert login is not None
  438. req.login = login
  439. resp = self._rpc(self._svc.users.get_user(req, headers=self._headers()))
  440. return DirectoryMember.parse(pb_to_dict(resp.user))
  441. def batch_get_users(self, user_ids: list[str]) -> list[DirectoryMember]:
  442. resp = self._rpc(
  443. self._svc.users.batch_get_users(
  444. member_directory_pb2.BatchGetUsersRequest(user_ids=user_ids),
  445. headers=self._headers(),
  446. )
  447. )
  448. data = pb_to_dict(resp)
  449. return [
  450. u
  451. for u in (DirectoryMember.parse(row) for row in data.get("users") or [])
  452. if u is not None
  453. ]
  454. # --- Roles (public) -----------------------------------------------
  455. def list_roles(self) -> list[Role]:
  456. resp = self._rpc(
  457. self._svc.roles.list_roles(roles_pb2.ListRolesRequest(), headers=self._headers())
  458. )
  459. data = pb_to_dict(resp)
  460. return [r for r in (Role.parse(row) for row in data.get("roles") or []) if r is not None]
  461. def get_role(self, name: str) -> Role | None:
  462. resp = self._rpc(
  463. self._svc.roles.get_role(roles_pb2.GetRoleRequest(name=name), headers=self._headers())
  464. )
  465. return Role.parse(pb_to_dict(resp.role))
  466. def batch_get_roles(self, names: list[str]) -> list[Role]:
  467. resp = self._rpc(
  468. self._svc.roles.batch_get_roles(
  469. roles_pb2.BatchGetRolesRequest(names=names), headers=self._headers()
  470. )
  471. )
  472. data = pb_to_dict(resp)
  473. return [r for r in (Role.parse(row) for row in data.get("roles") or []) if r is not None]
  474. # --- Room directory ------------------------------------------------
  475. def list_rooms(
  476. self, scope: RoomDirectoryScope = RoomDirectoryScope.ALL
  477. ) -> list[RoomWithViewerState]:
  478. resp = self._rpc(
  479. self._svc.room_directory.list_rooms(
  480. room_directory_pb2.ListRoomsRequest(scope=scope.value),
  481. headers=self._headers(),
  482. )
  483. )
  484. data = pb_to_dict(resp)
  485. return [
  486. r
  487. for r in (RoomWithViewerState.parse(row) for row in data.get("rooms") or [])
  488. if r is not None
  489. ]
  490. def list_room_groups(self) -> list[RoomGroup]:
  491. resp = self._rpc(
  492. self._svc.room_directory.list_room_groups(
  493. room_directory_pb2.ListRoomGroupsRequest(),
  494. headers=self._headers(),
  495. )
  496. )
  497. data = pb_to_dict(resp)
  498. return [
  499. g for g in (RoomGroup.parse(row) for row in data.get("groups") or []) if g is not None
  500. ]
  501. def get_room_group(self, group_id: str) -> RoomGroup | None:
  502. resp = self._rpc(
  503. self._svc.room_directory.get_room_group(
  504. room_directory_pb2.GetRoomGroupRequest(group_id=group_id),
  505. headers=self._headers(),
  506. )
  507. )
  508. return RoomGroup.parse(pb_to_dict(resp.group))
  509. def batch_get_room_groups(self, group_ids: list[str]) -> list[RoomGroup]:
  510. resp = self._rpc(
  511. self._svc.room_directory.batch_get_room_groups(
  512. room_directory_pb2.BatchGetRoomGroupsRequest(group_ids=group_ids),
  513. headers=self._headers(),
  514. )
  515. )
  516. data = pb_to_dict(resp)
  517. return [
  518. g for g in (RoomGroup.parse(row) for row in data.get("groups") or []) if g is not None
  519. ]
  520. def get_room(self, room_id: str) -> RoomWithViewerState | None:
  521. resp = self._rpc(
  522. self._svc.room_directory.get_room(
  523. room_directory_pb2.GetRoomRequest(room_id=room_id),
  524. headers=self._headers(),
  525. )
  526. )
  527. return RoomWithViewerState.parse(pb_to_dict(resp.room))
  528. def batch_get_rooms(self, room_ids: list[str]) -> list[RoomWithViewerState]:
  529. resp = self._rpc(
  530. self._svc.room_directory.batch_get_rooms(
  531. room_directory_pb2.BatchGetRoomsRequest(room_ids=room_ids),
  532. headers=self._headers(),
  533. )
  534. )
  535. data = pb_to_dict(resp)
  536. return [
  537. r
  538. for r in (RoomWithViewerState.parse(row) for row in data.get("rooms") or [])
  539. if r is not None
  540. ]
  541. # --- Room lifecycle & membership -----------------------------------
  542. def create_room(
  543. self,
  544. name: str,
  545. group_id: str,
  546. *,
  547. description: str = "",
  548. universal: bool = False,
  549. ) -> Room:
  550. resp = self._rpc(
  551. self._svc.rooms.create_room(
  552. rooms_pb2.CreateRoomRequest(
  553. name=name,
  554. group_id=group_id,
  555. description=description,
  556. universal=universal,
  557. ),
  558. headers=self._headers(),
  559. )
  560. )
  561. room = Room.parse(pb_to_dict(resp.room))
  562. assert room is not None
  563. return room
  564. def update_room(
  565. self,
  566. room_id: str,
  567. *,
  568. name: str | None = None,
  569. description: str | None = None,
  570. universal: bool | None = None,
  571. ) -> Room:
  572. req = rooms_pb2.UpdateRoomRequest(room_id=room_id)
  573. if name is not None:
  574. req.name = name
  575. if description is not None:
  576. req.description = description
  577. if universal is not None:
  578. req.universal = universal
  579. resp = self._rpc(self._svc.rooms.update_room(req, headers=self._headers()))
  580. room = Room.parse(pb_to_dict(resp.room))
  581. assert room is not None
  582. return room
  583. def archive_room(self, room_id: str) -> Room:
  584. resp = self._rpc(
  585. self._svc.rooms.archive_room(
  586. rooms_pb2.ArchiveRoomRequest(room_id=room_id),
  587. headers=self._headers(),
  588. )
  589. )
  590. room = Room.parse(pb_to_dict(resp.room))
  591. assert room is not None
  592. return room
  593. def unarchive_room(self, room_id: str) -> Room:
  594. resp = self._rpc(
  595. self._svc.rooms.unarchive_room(
  596. rooms_pb2.UnarchiveRoomRequest(room_id=room_id),
  597. headers=self._headers(),
  598. )
  599. )
  600. room = Room.parse(pb_to_dict(resp.room))
  601. assert room is not None
  602. return room
  603. def join_room(self, room_id: str) -> Room:
  604. resp = self._rpc(
  605. self._svc.rooms.join_room(
  606. rooms_pb2.JoinRoomRequest(room_id=room_id),
  607. headers=self._headers(),
  608. )
  609. )
  610. room = Room.parse(pb_to_dict(resp.room))
  611. assert room is not None
  612. return room
  613. def join_room_group(self, group_id: str) -> list[str]:
  614. resp = self._rpc(
  615. self._svc.rooms.join_room_group(
  616. rooms_pb2.JoinRoomGroupRequest(group_id=group_id),
  617. headers=self._headers(),
  618. )
  619. )
  620. return list(resp.joined_room_ids)
  621. def start_dm(self, participant_ids: list[str]) -> Room:
  622. resp = self._rpc(
  623. self._svc.rooms.start_dm(
  624. rooms_pb2.StartDMRequest(participant_ids=participant_ids),
  625. headers=self._headers(),
  626. )
  627. )
  628. room = Room.parse(pb_to_dict(resp.room))
  629. assert room is not None
  630. return room
  631. def leave_room(self, room_id: str) -> bool:
  632. resp = self._rpc(
  633. self._svc.rooms.leave_room(
  634. rooms_pb2.LeaveRoomRequest(room_id=room_id),
  635. headers=self._headers(),
  636. )
  637. )
  638. return resp.left
  639. def add_member(self, room_id: str, user_id: str) -> DirectoryMember | None:
  640. resp = self._rpc(
  641. self._svc.rooms.add_member(
  642. rooms_pb2.AddMemberRequest(room_id=room_id, user_id=user_id),
  643. headers=self._headers(),
  644. )
  645. )
  646. return DirectoryMember.parse(pb_to_dict(resp.member))
  647. def remove_member(self, room_id: str, user_id: str) -> bool:
  648. resp = self._rpc(
  649. self._svc.rooms.remove_member(
  650. rooms_pb2.RemoveMemberRequest(room_id=room_id, user_id=user_id),
  651. headers=self._headers(),
  652. )
  653. )
  654. return resp.removed
  655. def list_room_members(
  656. self,
  657. room_id: str,
  658. *,
  659. search: str = "",
  660. limit: int | None = None,
  661. offset: int | None = None,
  662. ) -> tuple[list[DirectoryMember], Page]:
  663. req = member_directory_pb2.ListRoomMembersRequest(room_id=room_id, search=search)
  664. page = _page_pb(limit, offset)
  665. if page is not None:
  666. req.page.CopyFrom(page)
  667. resp = self._rpc(self._svc.rooms.list_members(req, headers=self._headers()))
  668. data = pb_to_dict(resp)
  669. members = [
  670. m
  671. for m in (DirectoryMember.parse(row) for row in data.get("members") or [])
  672. if m is not None
  673. ]
  674. return members, Page.parse(data.get("page"))
  675. def get_room_member(self, room_id: str, user_id: str) -> DirectoryMember | None:
  676. resp = self._rpc(
  677. self._svc.rooms.get_member(
  678. member_directory_pb2.GetRoomMemberRequest(room_id=room_id, user_id=user_id),
  679. headers=self._headers(),
  680. )
  681. )
  682. return DirectoryMember.parse(pb_to_dict(resp.member))
  683. def batch_get_room_members(self, room_id: str, user_ids: list[str]) -> list[DirectoryMember]:
  684. resp = self._rpc(
  685. self._svc.rooms.batch_get_members(
  686. member_directory_pb2.BatchGetRoomMembersRequest(room_id=room_id, user_ids=user_ids),
  687. headers=self._headers(),
  688. )
  689. )
  690. data = pb_to_dict(resp)
  691. return [
  692. m
  693. for m in (DirectoryMember.parse(row) for row in data.get("members") or [])
  694. if m is not None
  695. ]
  696. def ban_member(
  697. self,
  698. room_id: str,
  699. user_id: str,
  700. reason: str,
  701. *,
  702. expires_at: datetime | None = None,
  703. ) -> bool:
  704. req = rooms_pb2.BanMemberRequest(room_id=room_id, user_id=user_id, reason=reason)
  705. if expires_at is not None:
  706. req.expires_at.CopyFrom(_timestamp_pb(expires_at))
  707. resp = self._rpc(self._svc.rooms.ban_member(req, headers=self._headers()))
  708. return resp.banned
  709. def unban_member(self, room_id: str, user_id: str, reason: str) -> bool:
  710. resp = self._rpc(
  711. self._svc.rooms.unban_member(
  712. rooms_pb2.UnbanMemberRequest(room_id=room_id, user_id=user_id, reason=reason),
  713. headers=self._headers(),
  714. )
  715. )
  716. return resp.unbanned
  717. def list_bans(
  718. self,
  719. *,
  720. room_id: str = "",
  721. limit: int | None = None,
  722. offset: int | None = None,
  723. ) -> tuple[list[RoomBan], Page]:
  724. req = rooms_pb2.ListBansRequest(room_id=room_id)
  725. page = _page_pb(limit, offset)
  726. if page is not None:
  727. req.page.CopyFrom(page)
  728. resp = self._rpc(self._svc.rooms.list_bans(req, headers=self._headers()))
  729. data = pb_to_dict(resp)
  730. bans = [b for b in (RoomBan.parse(row) for row in data.get("bans") or []) if b is not None]
  731. return bans, Page.parse(data.get("page"))
  732. def update_typing_indicator(self, room_id: str, *, thread_root_event_id: str = "") -> bool:
  733. resp = self._rpc(
  734. self._svc.rooms.update_typing_indicator(
  735. rooms_pb2.UpdateTypingIndicatorRequest(
  736. room_id=room_id, thread_root_event_id=thread_root_event_id
  737. ),
  738. headers=self._headers(),
  739. )
  740. )
  741. return resp.updated
  742. # --- Room timeline / read state -----------------------------------
  743. def get_room_events(
  744. self,
  745. room_id: str,
  746. *,
  747. limit: int | None = None,
  748. before: str | None = None,
  749. after: str | None = None,
  750. ) -> TimelinePage:
  751. req = room_timeline_pb2.GetRoomEventsRequest(room_id=room_id)
  752. if limit is not None:
  753. req.limit = limit
  754. if before is not None:
  755. req.before = before
  756. elif after is not None:
  757. req.after = after
  758. resp = self._rpc(self._svc.rooms.get_room_events(req, headers=self._headers()))
  759. return TimelinePage.parse(pb_to_dict(resp.page))
  760. def get_room_events_around(
  761. self,
  762. room_id: str,
  763. event_id: str,
  764. *,
  765. limit: int | None = None,
  766. ) -> tuple[TimelinePage, int]:
  767. req = room_timeline_pb2.GetRoomEventsAroundRequest(room_id=room_id, event_id=event_id)
  768. if limit is not None:
  769. req.limit = limit
  770. resp = self._rpc(self._svc.rooms.get_room_events_around(req, headers=self._headers()))
  771. return TimelinePage.parse(pb_to_dict(resp.page)), resp.target_index
  772. def mark_room_as_read(
  773. self, room_id: str, up_to_event_id: str = ""
  774. ) -> tuple[datetime | None, datetime | None]:
  775. resp = self._rpc(
  776. self._svc.rooms.mark_room_as_read(
  777. read_state_pb2.MarkRoomAsReadRequest(
  778. room_id=room_id, up_to_event_id=up_to_event_id
  779. ),
  780. headers=self._headers(),
  781. )
  782. )
  783. d = pb_to_dict(resp)
  784. return (
  785. parse_datetime(d.get("lastReadAt")),
  786. parse_datetime(d.get("previousLastReadAt")),
  787. )
  788. def list_room_attachments(
  789. self,
  790. room_id: str,
  791. *,
  792. thumbnail: ImageTransformOptions | None = None,
  793. limit: int | None = None,
  794. offset: int | None = None,
  795. ) -> tuple[list[dict[str, Any]], Page]:
  796. req = rooms_pb2.ListRoomAttachmentsRequest(room_id=room_id)
  797. thumb = _thumbnail_pb(thumbnail)
  798. if thumb is not None:
  799. req.thumbnail.CopyFrom(thumb)
  800. page = _page_pb(limit, offset)
  801. if page is not None:
  802. req.page.CopyFrom(page)
  803. resp = self._rpc(self._svc.rooms.list_room_attachments(req, headers=self._headers()))
  804. data = pb_to_dict(resp)
  805. return list(data.get("attachments") or []), Page.parse(data.get("page"))
  806. # --- Messages -------------------------------------------------------
  807. def fetch_link_preview(self, url: str) -> tuple[LinkPreview | None, str]:
  808. resp = self._rpc(
  809. self._svc.messages.fetch_link_preview(
  810. link_previews_pb2.FetchLinkPreviewRequest(url=url),
  811. headers=self._headers(),
  812. )
  813. )
  814. return LinkPreview.parse(pb_to_dict(resp.preview)), resp.preview_token
  815. def post_message(
  816. self,
  817. room_id: str,
  818. body: str = "",
  819. *,
  820. attachment_asset_ids: list[str] | None = None,
  821. thread_root_event_id: str = "",
  822. in_reply_to: str = "",
  823. also_send_to_channel: bool = False,
  824. link_preview_token: str = "",
  825. ) -> Message:
  826. req = messages_pb2.CreateMessageRequest(
  827. room_id=room_id,
  828. body=body,
  829. thread_root_event_id=thread_root_event_id,
  830. in_reply_to=in_reply_to,
  831. also_send_to_channel=also_send_to_channel,
  832. link_preview_token=link_preview_token,
  833. )
  834. if attachment_asset_ids:
  835. req.attachment_asset_ids.extend(attachment_asset_ids)
  836. resp = self._rpc(self._svc.messages.create_message(req, headers=self._headers()))
  837. message = Message.parse(pb_to_dict(resp.message))
  838. assert message is not None
  839. return message
  840. def update_message(
  841. self,
  842. room_id: str,
  843. event_id: str,
  844. *,
  845. body: str | None = None,
  846. also_send_to_channel: bool | None = None,
  847. ) -> Message:
  848. req = messages_pb2.UpdateMessageRequest(room_id=room_id, event_id=event_id)
  849. if body is not None:
  850. req.body = body
  851. if also_send_to_channel is not None:
  852. req.also_send_to_channel = also_send_to_channel
  853. resp = self._rpc(self._svc.messages.update_message(req, headers=self._headers()))
  854. message = Message.parse(pb_to_dict(resp.message))
  855. assert message is not None
  856. return message
  857. def delete_message(self, room_id: str, event_id: str) -> bool:
  858. resp = self._rpc(
  859. self._svc.messages.delete_message(
  860. messages_pb2.DeleteMessageRequest(room_id=room_id, event_id=event_id),
  861. headers=self._headers(),
  862. )
  863. )
  864. return resp.deleted
  865. def delete_attachment(self, room_id: str, event_id: str, attachment_id: str) -> bool:
  866. resp = self._rpc(
  867. self._svc.messages.delete_attachment(
  868. messages_pb2.DeleteAttachmentRequest(
  869. room_id=room_id, event_id=event_id, attachment_id=attachment_id
  870. ),
  871. headers=self._headers(),
  872. )
  873. )
  874. return resp.deleted
  875. def delete_link_preview(self, room_id: str, event_id: str, url: str) -> bool:
  876. resp = self._rpc(
  877. self._svc.messages.delete_link_preview(
  878. messages_pb2.DeleteLinkPreviewRequest(room_id=room_id, event_id=event_id, url=url),
  879. headers=self._headers(),
  880. )
  881. )
  882. return resp.deleted
  883. def get_message(self, room_id: str, event_id: str) -> Message | None:
  884. resp = self._rpc(
  885. self._svc.messages.get_message(
  886. messages_pb2.GetMessageRequest(room_id=room_id, event_id=event_id),
  887. headers=self._headers(),
  888. )
  889. )
  890. return Message.parse(pb_to_dict(resp.message))
  891. def batch_get_messages(self, room_id: str, event_ids: list[str]) -> list[Message]:
  892. resp = self._rpc(
  893. self._svc.messages.batch_get_messages(
  894. messages_pb2.BatchGetMessagesRequest(room_id=room_id, event_ids=event_ids),
  895. headers=self._headers(),
  896. )
  897. )
  898. data = pb_to_dict(resp)
  899. return [
  900. m for m in (Message.parse(row) for row in data.get("messages") or []) if m is not None
  901. ]
  902. def add_reaction(self, room_id: str, message_event_id: str, emoji: str) -> bool:
  903. resp = self._rpc(
  904. self._svc.messages.add_reaction(
  905. reactions_pb2.AddReactionRequest(
  906. room_id=room_id, message_event_id=message_event_id, emoji=emoji
  907. ),
  908. headers=self._headers(),
  909. )
  910. )
  911. return resp.added
  912. def remove_reaction(self, room_id: str, message_event_id: str, emoji: str) -> bool:
  913. resp = self._rpc(
  914. self._svc.messages.remove_reaction(
  915. reactions_pb2.RemoveReactionRequest(
  916. room_id=room_id, message_event_id=message_event_id, emoji=emoji
  917. ),
  918. headers=self._headers(),
  919. )
  920. )
  921. return resp.removed
  922. # --- Threads --------------------------------------------------------
  923. def follow_thread(self, room_id: str, thread_root_event_id: str) -> bool:
  924. resp = self._rpc(
  925. self._svc.threads.follow_thread(
  926. threads_pb2.FollowThreadRequest(
  927. room_id=room_id, thread_root_event_id=thread_root_event_id
  928. ),
  929. headers=self._headers(),
  930. )
  931. )
  932. return resp.following
  933. def unfollow_thread(self, room_id: str, thread_root_event_id: str) -> bool:
  934. resp = self._rpc(
  935. self._svc.threads.unfollow_thread(
  936. threads_pb2.UnfollowThreadRequest(
  937. room_id=room_id, thread_root_event_id=thread_root_event_id
  938. ),
  939. headers=self._headers(),
  940. )
  941. )
  942. return resp.following
  943. def list_followed_threads(
  944. self, *, limit: int | None = None, offset: int | None = None
  945. ) -> FollowedThreadsPage:
  946. req = threads_pb2.ListFollowedThreadsRequest()
  947. page = _page_pb(limit, offset)
  948. if page is not None:
  949. req.page.CopyFrom(page)
  950. resp = self._rpc(self._svc.threads.list_followed_threads(req, headers=self._headers()))
  951. data = pb_to_dict(resp)
  952. threads = [FollowedThread.parse(t) for t in data.get("threads") or []]
  953. users: dict[str, User] = {}
  954. includes = data.get("includes") or {}
  955. for uid, user_data in (includes.get("users") or {}).items():
  956. parsed = User.parse(user_data)
  957. if parsed is not None:
  958. users[uid] = parsed
  959. return FollowedThreadsPage(
  960. threads=threads, page=Page.parse(data.get("page")), users_by_id=users
  961. )
  962. def get_thread_events(
  963. self,
  964. room_id: str,
  965. thread_root_event_id: str,
  966. *,
  967. limit: int | None = None,
  968. before: str | None = None,
  969. after: str | None = None,
  970. ) -> TimelinePage:
  971. req = room_timeline_pb2.GetThreadEventsRequest(
  972. room_id=room_id, thread_root_event_id=thread_root_event_id
  973. )
  974. if limit is not None:
  975. req.limit = limit
  976. if before is not None:
  977. req.before = before
  978. elif after is not None:
  979. req.after = after
  980. resp = self._rpc(self._svc.threads.get_thread_events(req, headers=self._headers()))
  981. return TimelinePage.parse(pb_to_dict(resp.page))
  982. def get_thread_events_around(
  983. self,
  984. room_id: str,
  985. thread_root_event_id: str,
  986. event_id: str,
  987. *,
  988. limit: int | None = None,
  989. ) -> tuple[TimelinePage, int]:
  990. req = room_timeline_pb2.GetThreadEventsAroundRequest(
  991. room_id=room_id,
  992. thread_root_event_id=thread_root_event_id,
  993. event_id=event_id,
  994. )
  995. if limit is not None:
  996. req.limit = limit
  997. resp = self._rpc(self._svc.threads.get_thread_events_around(req, headers=self._headers()))
  998. return TimelinePage.parse(pb_to_dict(resp.page)), resp.target_index
  999. def mark_thread_as_read(
  1000. self,
  1001. room_id: str,
  1002. thread_root_event_id: str,
  1003. up_to_event_id: str = "",
  1004. ) -> datetime | None:
  1005. resp = self._rpc(
  1006. self._svc.threads.mark_thread_as_read(
  1007. read_state_pb2.MarkThreadAsReadRequest(
  1008. room_id=room_id,
  1009. thread_root_event_id=thread_root_event_id,
  1010. up_to_event_id=up_to_event_id,
  1011. ),
  1012. headers=self._headers(),
  1013. )
  1014. )
  1015. d = pb_to_dict(resp)
  1016. return parse_datetime(d.get("previousReadAt"))
  1017. # --- Notifications --------------------------------------------------
  1018. def list_notifications(
  1019. self, *, limit: int | None = None, offset: int | None = None
  1020. ) -> NotificationsPage:
  1021. req = notifications_pb2.ListNotificationsRequest()
  1022. page = _page_pb(limit, offset)
  1023. if page is not None:
  1024. req.page.CopyFrom(page)
  1025. resp = self._rpc(self._svc.notifications.list_notifications(req, headers=self._headers()))
  1026. data = pb_to_dict(resp)
  1027. notifications = [Notification.parse(n) for n in data.get("notifications") or []]
  1028. return NotificationsPage(notifications=notifications, page=Page.parse(data.get("page")))
  1029. def has_notifications(self) -> bool:
  1030. resp = self._rpc(
  1031. self._svc.notifications.has_notifications(
  1032. notifications_pb2.HasNotificationsRequest(),
  1033. headers=self._headers(),
  1034. )
  1035. )
  1036. return resp.has_notifications
  1037. def get_notification(self, notification_id: str) -> Notification | None:
  1038. resp = self._rpc(
  1039. self._svc.notifications.get_notification(
  1040. notifications_pb2.GetNotificationRequest(notification_id=notification_id),
  1041. headers=self._headers(),
  1042. )
  1043. )
  1044. raw = pb_to_dict(resp).get("notification")
  1045. return Notification.parse(raw) if raw else None
  1046. def batch_get_notifications(self, notification_ids: list[str]) -> list[Notification]:
  1047. resp = self._rpc(
  1048. self._svc.notifications.batch_get_notifications(
  1049. notifications_pb2.BatchGetNotificationsRequest(notification_ids=notification_ids),
  1050. headers=self._headers(),
  1051. )
  1052. )
  1053. data = pb_to_dict(resp)
  1054. return [Notification.parse(n) for n in data.get("notifications") or []]
  1055. def list_room_notifications(
  1056. self,
  1057. room_id: str,
  1058. *,
  1059. limit: int | None = None,
  1060. offset: int | None = None,
  1061. ) -> NotificationsPage:
  1062. req = notifications_pb2.ListRoomNotificationsRequest(room_id=room_id)
  1063. page = _page_pb(limit, offset)
  1064. if page is not None:
  1065. req.page.CopyFrom(page)
  1066. resp = self._rpc(
  1067. self._svc.notifications.list_room_notifications(req, headers=self._headers())
  1068. )
  1069. data = pb_to_dict(resp)
  1070. return NotificationsPage(
  1071. notifications=[Notification.parse(n) for n in data.get("notifications") or []],
  1072. page=Page.parse(data.get("page")),
  1073. )
  1074. def list_room_notification_counts(self) -> dict[str, int]:
  1075. resp = self._rpc(
  1076. self._svc.notifications.list_room_notification_counts(
  1077. notifications_pb2.ListRoomNotificationCountsRequest(),
  1078. headers=self._headers(),
  1079. )
  1080. )
  1081. return {row.room_id: row.total_count for row in resp.room_counts}
  1082. def dismiss_notification(self, notification_id: str) -> bool:
  1083. resp = self._rpc(
  1084. self._svc.notifications.dismiss_notification(
  1085. notifications_pb2.DismissNotificationRequest(notification_id=notification_id),
  1086. headers=self._headers(),
  1087. )
  1088. )
  1089. return resp.dismissed
  1090. def dismiss_all_notifications(self) -> int:
  1091. resp = self._rpc(
  1092. self._svc.notifications.dismiss_all_notifications(
  1093. notifications_pb2.DismissAllNotificationsRequest(),
  1094. headers=self._headers(),
  1095. )
  1096. )
  1097. return resp.dismissed_count
  1098. # --- Notification preferences --------------------------------------
  1099. def get_server_notification_preference(self) -> NotificationPreference:
  1100. resp = self._rpc(
  1101. self._svc.notification_prefs.get_server_notification_preference(
  1102. notification_preferences_pb2.GetServerNotificationPreferenceRequest(),
  1103. headers=self._headers(),
  1104. )
  1105. )
  1106. return NotificationPreference.parse(pb_to_dict(resp.preference))
  1107. def update_server_notification_preference(
  1108. self, level: NotificationLevel
  1109. ) -> NotificationPreference:
  1110. resp = self._rpc(
  1111. self._svc.notification_prefs.update_server_notification_preference(
  1112. notification_preferences_pb2.UpdateServerNotificationPreferenceRequest(
  1113. level=level.value
  1114. ),
  1115. headers=self._headers(),
  1116. )
  1117. )
  1118. return NotificationPreference.parse(pb_to_dict(resp.preference))
  1119. def get_room_notification_preference(self, room_id: str) -> NotificationPreference:
  1120. resp = self._rpc(
  1121. self._svc.notification_prefs.get_room_notification_preference(
  1122. notification_preferences_pb2.GetRoomNotificationPreferenceRequest(room_id=room_id),
  1123. headers=self._headers(),
  1124. )
  1125. )
  1126. return NotificationPreference.parse(pb_to_dict(resp.preference))
  1127. def update_room_notification_preference(
  1128. self, room_id: str, level: NotificationLevel
  1129. ) -> NotificationPreference:
  1130. resp = self._rpc(
  1131. self._svc.notification_prefs.update_room_notification_preference(
  1132. notification_preferences_pb2.UpdateRoomNotificationPreferenceRequest(
  1133. room_id=room_id, level=level.value
  1134. ),
  1135. headers=self._headers(),
  1136. )
  1137. )
  1138. return NotificationPreference.parse(pb_to_dict(resp.preference))
  1139. # --- Push notifications --------------------------------------------
  1140. def subscribe_push(
  1141. self,
  1142. endpoint: str,
  1143. p256dh: str,
  1144. auth: str,
  1145. *,
  1146. user_agent: str | None = None,
  1147. ) -> bool:
  1148. req = push_notifications_pb2.SubscribePushRequest(
  1149. endpoint=endpoint, p256dh=p256dh, auth=auth
  1150. )
  1151. if user_agent is not None:
  1152. req.user_agent = user_agent
  1153. resp = self._rpc(self._svc.push.subscribe(req, headers=self._headers()))
  1154. return resp.subscribed
  1155. def unsubscribe_push(self, endpoint: str) -> bool:
  1156. resp = self._rpc(
  1157. self._svc.push.unsubscribe(
  1158. push_notifications_pb2.UnsubscribePushRequest(endpoint=endpoint),
  1159. headers=self._headers(),
  1160. )
  1161. )
  1162. return resp.unsubscribed
  1163. # --- Assets ---------------------------------------------------------
  1164. def get_asset(
  1165. self,
  1166. room_id: str,
  1167. asset_id: str,
  1168. *,
  1169. thumbnail: ImageTransformOptions | None = None,
  1170. ) -> Asset | None:
  1171. req = attachments_pb2.GetAssetRequest(room_id=room_id, asset_id=asset_id)
  1172. thumb = _thumbnail_pb(thumbnail)
  1173. if thumb is not None:
  1174. req.thumbnail.CopyFrom(thumb)
  1175. resp = self._rpc(self._svc.assets.get_asset(req, headers=self._headers()))
  1176. return Asset.parse(pb_to_dict(resp.asset))
  1177. def batch_get_assets(
  1178. self,
  1179. room_id: str,
  1180. asset_ids: list[str],
  1181. *,
  1182. thumbnail: ImageTransformOptions | None = None,
  1183. ) -> list[Asset]:
  1184. req = attachments_pb2.BatchGetAssetsRequest(room_id=room_id, asset_ids=asset_ids)
  1185. thumb = _thumbnail_pb(thumbnail)
  1186. if thumb is not None:
  1187. req.thumbnail.CopyFrom(thumb)
  1188. resp = self._rpc(self._svc.assets.batch_get_assets(req, headers=self._headers()))
  1189. data = pb_to_dict(resp)
  1190. return [a for a in (Asset.parse(row) for row in data.get("assets") or []) if a is not None]
  1191. # --- Asset uploads ------------------------------------------------
  1192. def create_upload(
  1193. self,
  1194. room_id: str,
  1195. filename: str,
  1196. size: int,
  1197. sha256: str,
  1198. *,
  1199. content_type: str = "",
  1200. ) -> AssetUpload:
  1201. resp = self._rpc(
  1202. self._svc.asset_uploads.create_upload(
  1203. asset_uploads_pb2.CreateUploadRequest(
  1204. room_id=room_id,
  1205. filename=filename,
  1206. content_type=content_type,
  1207. size=size,
  1208. sha256=sha256,
  1209. ),
  1210. headers=self._headers(),
  1211. )
  1212. )
  1213. upload = AssetUpload.parse(pb_to_dict(resp.upload))
  1214. assert upload is not None
  1215. return upload
  1216. def upload_chunk(
  1217. self, upload_id: str, offset: int, content: bytes, chunk_sha256: str
  1218. ) -> AssetUpload:
  1219. resp = self._rpc(
  1220. self._svc.asset_uploads.upload_chunk(
  1221. asset_uploads_pb2.UploadChunkRequest(
  1222. upload_id=upload_id,
  1223. offset=offset,
  1224. content=content,
  1225. chunk_sha256=chunk_sha256,
  1226. ),
  1227. headers=self._headers(),
  1228. )
  1229. )
  1230. upload = AssetUpload.parse(pb_to_dict(resp.upload))
  1231. assert upload is not None
  1232. return upload
  1233. def get_upload(self, upload_id: str) -> AssetUpload:
  1234. resp = self._rpc(
  1235. self._svc.asset_uploads.get_upload(
  1236. asset_uploads_pb2.GetUploadRequest(upload_id=upload_id),
  1237. headers=self._headers(),
  1238. )
  1239. )
  1240. upload = AssetUpload.parse(pb_to_dict(resp.upload))
  1241. assert upload is not None
  1242. return upload
  1243. def complete_upload(self, upload_id: str) -> tuple[AssetUpload, Asset | None]:
  1244. resp = self._rpc(
  1245. self._svc.asset_uploads.complete_upload(
  1246. asset_uploads_pb2.CompleteUploadRequest(upload_id=upload_id),
  1247. headers=self._headers(),
  1248. )
  1249. )
  1250. upload = AssetUpload.parse(pb_to_dict(resp.upload))
  1251. assert upload is not None
  1252. return upload, Asset.parse(pb_to_dict(resp.asset))
  1253. def cancel_upload(self, upload_id: str) -> AssetUpload:
  1254. resp = self._rpc(
  1255. self._svc.asset_uploads.cancel_upload(
  1256. asset_uploads_pb2.CancelUploadRequest(upload_id=upload_id),
  1257. headers=self._headers(),
  1258. )
  1259. )
  1260. upload = AssetUpload.parse(pb_to_dict(resp.upload))
  1261. assert upload is not None
  1262. return upload
  1263. def upload_attachment(
  1264. self,
  1265. room_id: str,
  1266. file_path: str | Path,
  1267. *,
  1268. content_type: str = "",
  1269. filename: str | None = None,
  1270. ) -> Asset:
  1271. """Upload a file as a room attachment and return the resulting Asset."""
  1272. path = Path(file_path)
  1273. data = path.read_bytes()
  1274. size = len(data)
  1275. sha = hashlib.sha256(data).hexdigest()
  1276. upload = self.create_upload(
  1277. room_id, filename or path.name, size, sha, content_type=content_type
  1278. )
  1279. chunk_size = upload.max_chunk_size or 512 * 1024
  1280. offset = upload.committed_offset
  1281. while offset < size:
  1282. end = min(offset + chunk_size, size)
  1283. chunk = data[offset:end]
  1284. chunk_sha = hashlib.sha256(chunk).hexdigest()
  1285. upload = self.upload_chunk(upload.upload_id, offset, chunk, chunk_sha)
  1286. if upload.committed_offset <= offset:
  1287. raise ChattoError(
  1288. f"upload stalled at offset {offset} (server reported "
  1289. f"committed_offset={upload.committed_offset})"
  1290. )
  1291. offset = upload.committed_offset
  1292. upload, asset = self.complete_upload(upload.upload_id)
  1293. if asset is None:
  1294. raise ChattoError("upload completed but server returned no asset")
  1295. return asset
  1296. # --- MyAccount external identities --------------------------------
  1297. def list_external_identities(
  1298. self,
  1299. ) -> tuple[list[ExternalIdentityProvider], list[LinkedExternalIdentity]]:
  1300. resp = self._rpc(
  1301. self._svc.account.list_external_identities(
  1302. external_identities_pb2.ListExternalIdentitiesRequest(),
  1303. headers=self._headers(),
  1304. )
  1305. )
  1306. data = pb_to_dict(resp)
  1307. providers = [ExternalIdentityProvider.parse(p) for p in data.get("providers") or []]
  1308. linked = [LinkedExternalIdentity.parse(li) for li in data.get("linkedIdentities") or []]
  1309. return providers, linked
  1310. def start_external_identity_link(
  1311. self,
  1312. provider_id: str,
  1313. *,
  1314. redirect_path: str = "",
  1315. current_password: str = "",
  1316. ) -> str:
  1317. resp = self._rpc(
  1318. self._svc.account.start_external_identity_link(
  1319. external_identities_pb2.StartExternalIdentityLinkRequest(
  1320. provider_id=provider_id,
  1321. redirect_path=redirect_path,
  1322. current_password=current_password,
  1323. ),
  1324. headers=self._headers(),
  1325. )
  1326. )
  1327. return resp.start_url
  1328. def disconnect_external_identity(
  1329. self, subject_hash: str, *, current_password: str = ""
  1330. ) -> bool:
  1331. resp = self._rpc(
  1332. self._svc.account.disconnect_external_identity(
  1333. external_identities_pb2.DisconnectExternalIdentityRequest(
  1334. subject_hash=subject_hash, current_password=current_password
  1335. ),
  1336. headers=self._headers(),
  1337. )
  1338. )
  1339. return resp.disconnected
  1340. # --- ExternalIdentityAuthService (public OAuth handoff) -----------
  1341. def get_pending_external_identity(self, token: str) -> PendingExternalIdentity | None:
  1342. resp = self._rpc(
  1343. self._svc.external_auth.get_pending_external_identity(
  1344. external_identity_auth_pb2.GetPendingExternalIdentityRequest(token=token),
  1345. headers=self._headers(),
  1346. )
  1347. )
  1348. return PendingExternalIdentity.parse(pb_to_dict(resp).get("pending"))
  1349. def create_external_identity_account(
  1350. self, token: str, login: str
  1351. ) -> ExternalIdentityAccount | None:
  1352. resp = self._rpc(
  1353. self._svc.external_auth.create_external_identity_account(
  1354. external_identity_auth_pb2.CreateExternalIdentityAccountRequest(
  1355. token=token, login=login
  1356. ),
  1357. headers=self._headers(),
  1358. )
  1359. )
  1360. return ExternalIdentityAccount.parse(pb_to_dict(resp))
  1361. def confirm_external_identity_link(self, token: str) -> LinkedExternalIdentity | None:
  1362. resp = self._rpc(
  1363. self._svc.external_auth.confirm_external_identity_link(
  1364. external_identity_auth_pb2.ConfirmExternalIdentityLinkRequest(token=token),
  1365. headers=self._headers(),
  1366. )
  1367. )
  1368. data = pb_to_dict(resp).get("linkedIdentity")
  1369. return LinkedExternalIdentity.parse(data) if data else None
  1370. def cancel_external_identity_flow(self, token: str) -> bool:
  1371. resp = self._rpc(
  1372. self._svc.external_auth.cancel_external_identity_flow(
  1373. external_identity_auth_pb2.CancelExternalIdentityFlowRequest(token=token),
  1374. headers=self._headers(),
  1375. )
  1376. )
  1377. return resp.cancelled
  1378. # --- Voice calls ----------------------------------------------------
  1379. def list_active_calls(self) -> list[ActiveCall]:
  1380. resp = self._rpc(
  1381. self._svc.voice_calls.list_active_calls(
  1382. voice_calls_pb2.ListActiveCallsRequest(), headers=self._headers()
  1383. )
  1384. )
  1385. data = pb_to_dict(resp)
  1386. return [ActiveCall.parse(c) for c in data.get("calls") or []]
  1387. def get_active_call(self, room_id: str) -> ActiveCall | None:
  1388. resp = self._rpc(
  1389. self._svc.voice_calls.get_active_call(
  1390. voice_calls_pb2.GetActiveCallRequest(room_id=room_id),
  1391. headers=self._headers(),
  1392. )
  1393. )
  1394. raw = pb_to_dict(resp).get("call")
  1395. return ActiveCall.parse(raw) if raw else None
  1396. def batch_get_active_calls(self, room_ids: list[str]) -> list[ActiveCall]:
  1397. resp = self._rpc(
  1398. self._svc.voice_calls.batch_get_active_calls(
  1399. voice_calls_pb2.BatchGetActiveCallsRequest(room_ids=room_ids),
  1400. headers=self._headers(),
  1401. )
  1402. )
  1403. data = pb_to_dict(resp)
  1404. return [ActiveCall.parse(c) for c in data.get("calls") or []]
  1405. def join_call(self, room_id: str) -> bool:
  1406. resp = self._rpc(
  1407. self._svc.voice_calls.join_call(
  1408. voice_calls_pb2.JoinCallRequest(room_id=room_id),
  1409. headers=self._headers(),
  1410. )
  1411. )
  1412. return resp.joined
  1413. def leave_call(self, room_id: str) -> bool:
  1414. resp = self._rpc(
  1415. self._svc.voice_calls.leave_call(
  1416. voice_calls_pb2.LeaveCallRequest(room_id=room_id),
  1417. headers=self._headers(),
  1418. )
  1419. )
  1420. return resp.left
  1421. def get_call_token(self, room_id: str) -> str:
  1422. resp = self._rpc(
  1423. self._svc.voice_calls.get_call_token(
  1424. voice_calls_pb2.GetCallTokenRequest(room_id=room_id),
  1425. headers=self._headers(),
  1426. )
  1427. )
  1428. return resp.token
  1429. # --- Admin: server --------------------------------------------------
  1430. def admin_get_server_config(self) -> tuple[ServerConfig, ServerProfile]:
  1431. resp = self._rpc(
  1432. self._svc.admin_server.get_server_config(
  1433. admin_server_pb2.GetServerConfigRequest(),
  1434. headers=self._headers(),
  1435. )
  1436. )
  1437. return (
  1438. ServerConfig.parse(pb_to_dict(resp.config)),
  1439. ServerProfile.parse(pb_to_dict(resp.public_profile)),
  1440. )
  1441. def admin_update_server_config(
  1442. self,
  1443. *,
  1444. server_name: str | None = None,
  1445. description: str | None = None,
  1446. motd: str | None = None,
  1447. welcome_message: str | None = None,
  1448. ) -> tuple[ServerConfig, ServerProfile]:
  1449. req = admin_server_pb2.UpdateServerConfigRequest()
  1450. if server_name is not None:
  1451. req.server_name = server_name
  1452. if description is not None:
  1453. req.description = description
  1454. if motd is not None:
  1455. req.motd = motd
  1456. if welcome_message is not None:
  1457. req.welcome_message = welcome_message
  1458. resp = self._rpc(self._svc.admin_server.update_server_config(req, headers=self._headers()))
  1459. return (
  1460. ServerConfig.parse(pb_to_dict(resp.config)),
  1461. ServerProfile.parse(pb_to_dict(resp.public_profile)),
  1462. )
  1463. def admin_upload_server_logo(
  1464. self,
  1465. file_path: str | Path,
  1466. *,
  1467. content_type: str = "image/png",
  1468. ) -> ServerProfile:
  1469. p = Path(file_path)
  1470. req = admin_server_pb2.UploadServerLogoRequest(
  1471. image=common_pb2.ImageUpload(
  1472. image=p.read_bytes(), filename=p.name, content_type=content_type
  1473. )
  1474. )
  1475. resp = self._rpc(self._svc.admin_server.upload_server_logo(req, headers=self._headers()))
  1476. return ServerProfile.parse(pb_to_dict(resp.public_profile))
  1477. def admin_delete_server_logo(self) -> ServerProfile:
  1478. resp = self._rpc(
  1479. self._svc.admin_server.delete_server_logo(
  1480. admin_server_pb2.DeleteServerLogoRequest(),
  1481. headers=self._headers(),
  1482. )
  1483. )
  1484. return ServerProfile.parse(pb_to_dict(resp.public_profile))
  1485. def admin_upload_server_banner(
  1486. self,
  1487. file_path: str | Path,
  1488. *,
  1489. content_type: str = "image/png",
  1490. ) -> ServerProfile:
  1491. p = Path(file_path)
  1492. req = admin_server_pb2.UploadServerBannerRequest(
  1493. image=common_pb2.ImageUpload(
  1494. image=p.read_bytes(), filename=p.name, content_type=content_type
  1495. )
  1496. )
  1497. resp = self._rpc(self._svc.admin_server.upload_server_banner(req, headers=self._headers()))
  1498. return ServerProfile.parse(pb_to_dict(resp.public_profile))
  1499. def admin_delete_server_banner(self) -> ServerProfile:
  1500. resp = self._rpc(
  1501. self._svc.admin_server.delete_server_banner(
  1502. admin_server_pb2.DeleteServerBannerRequest(),
  1503. headers=self._headers(),
  1504. )
  1505. )
  1506. return ServerProfile.parse(pb_to_dict(resp.public_profile))
  1507. def admin_get_server_security_config(self) -> list[str]:
  1508. resp = self._rpc(
  1509. self._svc.admin_server.get_server_security_config(
  1510. admin_server_pb2.GetServerSecurityConfigRequest(),
  1511. headers=self._headers(),
  1512. )
  1513. )
  1514. return list(resp.blocked_usernames)
  1515. def admin_update_blocked_usernames(self, usernames: list[str]) -> list[str]:
  1516. resp = self._rpc(
  1517. self._svc.admin_server.update_blocked_usernames(
  1518. admin_server_pb2.UpdateBlockedUsernamesRequest(blocked_usernames=usernames),
  1519. headers=self._headers(),
  1520. )
  1521. )
  1522. return list(resp.blocked_usernames)
  1523. # --- Admin: room layout & sidebar links ---------------------------
  1524. def admin_list_room_groups(self) -> list[AdminRoomLayoutGroup]:
  1525. resp = self._rpc(
  1526. self._svc.admin_room_layout.list_room_groups(
  1527. room_layout_pb2.ListRoomGroupsRequest(),
  1528. headers=self._headers(),
  1529. )
  1530. )
  1531. data = pb_to_dict(resp)
  1532. return [
  1533. g
  1534. for g in (AdminRoomLayoutGroup.parse(row) for row in data.get("groups") or [])
  1535. if g is not None
  1536. ]
  1537. def admin_create_room_group(self, name: str, description: str = "") -> AdminRoomLayoutGroup:
  1538. resp = self._rpc(
  1539. self._svc.admin_room_layout.create_room_group(
  1540. room_layout_pb2.CreateRoomGroupRequest(name=name, description=description),
  1541. headers=self._headers(),
  1542. )
  1543. )
  1544. group = AdminRoomLayoutGroup.parse(pb_to_dict(resp.group))
  1545. assert group is not None
  1546. return group
  1547. def admin_update_room_group(
  1548. self,
  1549. group_id: str,
  1550. *,
  1551. name: str | None = None,
  1552. description: str | None = None,
  1553. ) -> AdminRoomLayoutGroup:
  1554. req = room_layout_pb2.UpdateRoomGroupRequest(group_id=group_id)
  1555. if name is not None:
  1556. req.name = name
  1557. if description is not None:
  1558. req.description = description
  1559. resp = self._rpc(
  1560. self._svc.admin_room_layout.update_room_group(req, headers=self._headers())
  1561. )
  1562. group = AdminRoomLayoutGroup.parse(pb_to_dict(resp.group))
  1563. assert group is not None
  1564. return group
  1565. def admin_delete_room_group(self, group_id: str) -> bool:
  1566. resp = self._rpc(
  1567. self._svc.admin_room_layout.delete_room_group(
  1568. room_layout_pb2.DeleteRoomGroupRequest(group_id=group_id),
  1569. headers=self._headers(),
  1570. )
  1571. )
  1572. return resp.deleted
  1573. def admin_reorder_room_groups(self, ordered_group_ids: list[str]) -> list[AdminRoomLayoutGroup]:
  1574. resp = self._rpc(
  1575. self._svc.admin_room_layout.reorder_room_groups(
  1576. room_layout_pb2.ReorderRoomGroupsRequest(ordered_group_ids=ordered_group_ids),
  1577. headers=self._headers(),
  1578. )
  1579. )
  1580. data = pb_to_dict(resp)
  1581. return [
  1582. g
  1583. for g in (AdminRoomLayoutGroup.parse(row) for row in data.get("groups") or [])
  1584. if g is not None
  1585. ]
  1586. def admin_move_room_to_group(self, room_id: str, group_id: str) -> Room:
  1587. resp = self._rpc(
  1588. self._svc.admin_room_layout.move_room_to_group(
  1589. room_layout_pb2.MoveRoomToGroupRequest(room_id=room_id, group_id=group_id),
  1590. headers=self._headers(),
  1591. )
  1592. )
  1593. room = Room.parse(pb_to_dict(resp.room))
  1594. assert room is not None
  1595. return room
  1596. def admin_reorder_sidebar_items_in_group(
  1597. self,
  1598. group_id: str,
  1599. items: list[tuple[AdminRoomLayoutItemKind, str]],
  1600. ) -> AdminRoomLayoutGroup:
  1601. req = room_layout_pb2.ReorderSidebarItemsInGroupRequest(group_id=group_id)
  1602. for kind, item_id in items:
  1603. item = req.items.add()
  1604. item.kind = kind.value
  1605. item.id = item_id
  1606. resp = self._rpc(
  1607. self._svc.admin_room_layout.reorder_sidebar_items_in_group(req, headers=self._headers())
  1608. )
  1609. group = AdminRoomLayoutGroup.parse(pb_to_dict(resp.group))
  1610. assert group is not None
  1611. return group
  1612. def admin_create_sidebar_link(self, group_id: str, label: str, url: str) -> SidebarLink | None:
  1613. resp = self._rpc(
  1614. self._svc.admin_room_layout.create_sidebar_link(
  1615. room_layout_pb2.CreateSidebarLinkRequest(group_id=group_id, label=label, url=url),
  1616. headers=self._headers(),
  1617. )
  1618. )
  1619. return SidebarLink.parse(pb_to_dict(resp).get("sidebarLink"))
  1620. def admin_update_sidebar_link(
  1621. self,
  1622. link_id: str,
  1623. *,
  1624. label: str | None = None,
  1625. url: str | None = None,
  1626. ) -> SidebarLink | None:
  1627. req = room_layout_pb2.UpdateSidebarLinkRequest(link_id=link_id)
  1628. if label is not None:
  1629. req.label = label
  1630. if url is not None:
  1631. req.url = url
  1632. resp = self._rpc(
  1633. self._svc.admin_room_layout.update_sidebar_link(req, headers=self._headers())
  1634. )
  1635. return SidebarLink.parse(pb_to_dict(resp).get("sidebarLink"))
  1636. def admin_delete_sidebar_link(self, link_id: str) -> bool:
  1637. resp = self._rpc(
  1638. self._svc.admin_room_layout.delete_sidebar_link(
  1639. room_layout_pb2.DeleteSidebarLinkRequest(link_id=link_id),
  1640. headers=self._headers(),
  1641. )
  1642. )
  1643. return resp.deleted
  1644. def admin_move_sidebar_link_to_group(self, link_id: str, group_id: str) -> SidebarLink | None:
  1645. resp = self._rpc(
  1646. self._svc.admin_room_layout.move_sidebar_link_to_group(
  1647. room_layout_pb2.MoveSidebarLinkToGroupRequest(link_id=link_id, group_id=group_id),
  1648. headers=self._headers(),
  1649. )
  1650. )
  1651. return SidebarLink.parse(pb_to_dict(resp).get("sidebarLink"))
  1652. # --- Admin: users --------------------------------------------------
  1653. def admin_list_members(
  1654. self,
  1655. *,
  1656. search: str = "",
  1657. limit: int | None = None,
  1658. offset: int | None = None,
  1659. ) -> tuple[list[AdminMember], list[Role], Page]:
  1660. req = admin_members_pb2.ListMembersRequest(search=search)
  1661. page = _page_pb(limit, offset)
  1662. if page is not None:
  1663. req.page.CopyFrom(page)
  1664. resp = self._rpc(self._svc.admin_users.list_members(req, headers=self._headers()))
  1665. data = pb_to_dict(resp)
  1666. members = [
  1667. m
  1668. for m in (AdminMember.parse(row) for row in data.get("members") or [])
  1669. if m is not None
  1670. ]
  1671. roles = [r for r in (Role.parse(row) for row in data.get("roles") or []) if r is not None]
  1672. return members, roles, Page.parse(data.get("page"))
  1673. def admin_get_member(
  1674. self,
  1675. *,
  1676. user_id: str | None = None,
  1677. login: str | None = None,
  1678. ) -> AdminMemberDetail:
  1679. if bool(user_id) == bool(login):
  1680. raise ValueError("admin_get_member requires exactly one of user_id or login")
  1681. req = admin_members_pb2.GetMemberRequest()
  1682. if user_id:
  1683. req.user_id = user_id
  1684. else:
  1685. assert login is not None
  1686. req.login = login
  1687. resp = self._rpc(self._svc.admin_users.get_member(req, headers=self._headers()))
  1688. return AdminMemberDetail.parse(pb_to_dict(resp))
  1689. def admin_batch_get_members(self, user_ids: list[str]) -> list[AdminMember]:
  1690. resp = self._rpc(
  1691. self._svc.admin_users.batch_get_members(
  1692. admin_members_pb2.BatchGetMembersRequest(user_ids=user_ids),
  1693. headers=self._headers(),
  1694. )
  1695. )
  1696. data = pb_to_dict(resp)
  1697. return [
  1698. m
  1699. for m in (AdminMember.parse(row) for row in data.get("members") or [])
  1700. if m is not None
  1701. ]
  1702. def admin_assign_role(self, user_id: str, role_name: str) -> AdminMember | None:
  1703. resp = self._rpc(
  1704. self._svc.admin_users.assign_role(
  1705. admin_members_pb2.AssignRoleRequest(user_id=user_id, role_name=role_name),
  1706. headers=self._headers(),
  1707. )
  1708. )
  1709. return AdminMember.parse(pb_to_dict(resp.member))
  1710. def admin_revoke_role(self, user_id: str, role_name: str) -> AdminMember | None:
  1711. resp = self._rpc(
  1712. self._svc.admin_users.revoke_role(
  1713. admin_members_pb2.RevokeRoleRequest(user_id=user_id, role_name=role_name),
  1714. headers=self._headers(),
  1715. )
  1716. )
  1717. return AdminMember.parse(pb_to_dict(resp.member))
  1718. def admin_update_user(
  1719. self,
  1720. user_id: str,
  1721. *,
  1722. display_name: str | None = None,
  1723. login: str | None = None,
  1724. ) -> tuple[User | None, AdminMember | None]:
  1725. req = admin_members_pb2.UpdateUserRequest(user_id=user_id)
  1726. if display_name is not None:
  1727. req.display_name = display_name
  1728. if login is not None:
  1729. req.login = login
  1730. resp = self._rpc(self._svc.admin_users.update_user(req, headers=self._headers()))
  1731. return (
  1732. User.parse(pb_to_dict(resp.user)),
  1733. AdminMember.parse(pb_to_dict(resp.member)),
  1734. )
  1735. def admin_update_user_password(self, user_id: str, password: str) -> AdminMember | None:
  1736. resp = self._rpc(
  1737. self._svc.admin_users.update_user_password(
  1738. admin_members_pb2.UpdateUserPasswordRequest(user_id=user_id, password=password),
  1739. headers=self._headers(),
  1740. )
  1741. )
  1742. return AdminMember.parse(pb_to_dict(resp.member))
  1743. def admin_clear_username_cooldown(self, user_id: str) -> bool:
  1744. resp = self._rpc(
  1745. self._svc.admin_users.clear_username_cooldown(
  1746. admin_members_pb2.ClearUsernameCooldownRequest(user_id=user_id),
  1747. headers=self._headers(),
  1748. )
  1749. )
  1750. return resp.cleared
  1751. def admin_delete_user(self, user_id: str, *, current_password: str = "") -> bool:
  1752. resp = self._rpc(
  1753. self._svc.admin_users.delete_user(
  1754. admin_members_pb2.DeleteUserRequest(
  1755. user_id=user_id, current_password=current_password
  1756. ),
  1757. headers=self._headers(),
  1758. )
  1759. )
  1760. return resp.deleted
  1761. # --- Admin: roles --------------------------------------------------
  1762. def admin_list_roles(self) -> list[AdminRole]:
  1763. resp = self._rpc(
  1764. self._svc.admin_roles.list_roles(
  1765. admin_roles_pb2.ListRolesRequest(), headers=self._headers()
  1766. )
  1767. )
  1768. data = pb_to_dict(resp)
  1769. return [
  1770. r for r in (AdminRole.parse(row) for row in data.get("roles") or []) if r is not None
  1771. ]
  1772. def admin_get_role(self, name: str) -> AdminRoleDetail:
  1773. resp = self._rpc(
  1774. self._svc.admin_roles.get_role(
  1775. admin_roles_pb2.GetRoleRequest(name=name), headers=self._headers()
  1776. )
  1777. )
  1778. return AdminRoleDetail.parse(pb_to_dict(resp))
  1779. def admin_create_role(
  1780. self,
  1781. name: str,
  1782. *,
  1783. display_name: str = "",
  1784. description: str = "",
  1785. pingable: bool = False,
  1786. ) -> AdminRole | None:
  1787. resp = self._rpc(
  1788. self._svc.admin_roles.create_role(
  1789. admin_roles_pb2.CreateRoleRequest(
  1790. name=name,
  1791. display_name=display_name,
  1792. description=description,
  1793. pingable=pingable,
  1794. ),
  1795. headers=self._headers(),
  1796. )
  1797. )
  1798. return AdminRole.parse(pb_to_dict(resp.role))
  1799. def admin_update_role(
  1800. self,
  1801. name: str,
  1802. *,
  1803. display_name: str | None = None,
  1804. description: str | None = None,
  1805. pingable: bool | None = None,
  1806. ) -> AdminRole | None:
  1807. req = admin_roles_pb2.UpdateRoleRequest(name=name)
  1808. if display_name is not None:
  1809. req.display_name = display_name
  1810. if description is not None:
  1811. req.description = description
  1812. if pingable is not None:
  1813. req.pingable = pingable
  1814. resp = self._rpc(self._svc.admin_roles.update_role(req, headers=self._headers()))
  1815. return AdminRole.parse(pb_to_dict(resp.role))
  1816. def admin_delete_role(self, name: str) -> bool:
  1817. resp = self._rpc(
  1818. self._svc.admin_roles.delete_role(
  1819. admin_roles_pb2.DeleteRoleRequest(name=name),
  1820. headers=self._headers(),
  1821. )
  1822. )
  1823. return resp.deleted
  1824. def admin_reorder_roles(self, role_names: list[str]) -> list[AdminRole]:
  1825. resp = self._rpc(
  1826. self._svc.admin_roles.reorder_roles(
  1827. admin_roles_pb2.ReorderRolesRequest(role_names=role_names),
  1828. headers=self._headers(),
  1829. )
  1830. )
  1831. data = pb_to_dict(resp)
  1832. return [
  1833. r for r in (AdminRole.parse(row) for row in data.get("roles") or []) if r is not None
  1834. ]
  1835. # --- Admin: event log / diagnostics / permissions ----------------
  1836. def admin_list_events(
  1837. self,
  1838. *,
  1839. limit: int | None = None,
  1840. before: str | None = None,
  1841. event_type: str | None = None,
  1842. actor_id: str | None = None,
  1843. ) -> AdminEventLogPage:
  1844. """List durable EVT entries newest-first.
  1845. Args:
  1846. limit: Maximum entries to return (server clamps to its diagnostic
  1847. limit).
  1848. before: Exclusive sequence cursor; returned entries are older than
  1849. this sequence.
  1850. event_type: Filter by event payload type name (e.g.
  1851. ``"MessagePostedEvent"``).
  1852. actor_id: Filter by actor user ID.
  1853. """
  1854. req = event_log_pb2.ListEventsRequest()
  1855. if limit is not None:
  1856. req.limit = limit
  1857. if before is not None:
  1858. req.before = before
  1859. if event_type or actor_id:
  1860. fltr = event_log_pb2.AdminEventLogFilter()
  1861. if event_type:
  1862. fltr.event_type = event_type
  1863. if actor_id:
  1864. fltr.actor_id = actor_id
  1865. req.filter.CopyFrom(fltr)
  1866. resp = self._rpc(self._svc.admin_event_log.list_events(req, headers=self._headers()))
  1867. return AdminEventLogPage.parse(pb_to_dict(resp))
  1868. def admin_list_event_types(self) -> list[str]:
  1869. resp = self._rpc(
  1870. self._svc.admin_event_log.list_event_types(
  1871. event_log_pb2.ListEventTypesRequest(),
  1872. headers=self._headers(),
  1873. )
  1874. )
  1875. return list(resp.event_types)
  1876. def admin_get_event(self, sequence: str) -> AdminEventLogEntry | None:
  1877. """Read one durable EVT entry by its stream sequence.
  1878. Args:
  1879. sequence: EVT stream sequence string (e.g. ``"42"``).
  1880. Returns:
  1881. The matching ``AdminEventLogEntry``, or ``None`` when the proto
  1882. ``entry`` field is absent.
  1883. """
  1884. resp = self._rpc(
  1885. self._svc.admin_event_log.get_event(
  1886. event_log_pb2.GetEventRequest(sequence=sequence),
  1887. headers=self._headers(),
  1888. )
  1889. )
  1890. return AdminEventLogEntry.parse(pb_to_dict(resp).get("entry"))
  1891. def admin_get_system_info(self) -> AdminSystemInfoSnapshot:
  1892. from chattolib._pb.chatto.admin.v1 import diagnostics_pb2
  1893. resp = self._rpc(
  1894. self._svc.admin_diagnostics.get_system_info(
  1895. diagnostics_pb2.GetSystemInfoRequest(),
  1896. headers=self._headers(),
  1897. )
  1898. )
  1899. return AdminSystemInfoSnapshot.parse(pb_to_dict(resp))
  1900. def admin_get_role_permission_matrix(self, role_name: str) -> RolePermissionMatrix | None:
  1901. resp = self._rpc(
  1902. self._svc.admin_permissions.get_role_permission_matrix(
  1903. admin_permissions_pb2.GetRolePermissionMatrixRequest(role_name=role_name),
  1904. headers=self._headers(),
  1905. )
  1906. )
  1907. return RolePermissionMatrix.parse(pb_to_dict(resp).get("matrix"))
  1908. def admin_list_role_permission_decisions(self, role_name: str) -> RolePermissionDecisions:
  1909. resp = self._rpc(
  1910. self._svc.admin_permissions.list_role_permission_decisions(
  1911. admin_permissions_pb2.ListRolePermissionDecisionsRequest(role_name=role_name),
  1912. headers=self._headers(),
  1913. )
  1914. )
  1915. return RolePermissionDecisions.parse(pb_to_dict(resp))
  1916. def admin_get_user_permission_matrix(self, user_id: str) -> UserPermissionMatrix | None:
  1917. resp = self._rpc(
  1918. self._svc.admin_permissions.get_user_permission_matrix(
  1919. admin_permissions_pb2.GetUserPermissionMatrixRequest(user_id=user_id),
  1920. headers=self._headers(),
  1921. )
  1922. )
  1923. return UserPermissionMatrix.parse(pb_to_dict(resp).get("matrix"))
  1924. def admin_list_user_permission_decisions(self, user_id: str) -> UserPermissionDecisions:
  1925. resp = self._rpc(
  1926. self._svc.admin_permissions.list_user_permission_decisions(
  1927. admin_permissions_pb2.ListUserPermissionDecisionsRequest(user_id=user_id),
  1928. headers=self._headers(),
  1929. )
  1930. )
  1931. return UserPermissionDecisions.parse(pb_to_dict(resp))