diff --git a/docs/openapi.json b/docs/openapi.json
index f6c04052..64691fd9 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -1 +1 @@
-{"openapi":"3.0.0","info":{"title":"Twake on Matrix APIs documentation","version":"0.0.1","description":"This is The documentation of all available APIs of this repository"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MatrixError":{"type":"object","properties":{"errcode":{"type":"string","description":"A Matrix error code"},"error":{"type":"string","description":"A human-readable error message"}},"required":["error"]},"MutualRooms":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","description":"the room id"},"name":{"type":"string","description":"the room name"},"topic":{"type":"string","description":"the room topic"},"room_type":{"type":"string","description":"the room type"}}}},"PrivateNote":{"type":"object","properties":{"id":{"type":"string","description":"The private note id"},"content":{"type":"string","description":"The private note content"},"authorId":{"type":"string","description":"The author user id"},"targetId":{"type":"string","description":"The target user id"}}},"CreatePrivateNote":{"type":"object","properties":{"content":{"type":"string","description":"The private note content"},"authorId":{"type":"string","description":"The author user id"},"targetId":{"type":"string","description":"The target user id"}}},"UpdatePrivateNote":{"type":"object","properties":{"id":{"type":"string","description":"The private note id"},"content":{"type":"string","description":"The private note content"}}},"RoomTags":{"type":"object","properties":{"tags":{"description":"the room tags list","type":"array","items":{"type":"string"}}}},"RoomTagCreation":{"type":"object","properties":{"content":{"type":"array","description":"the room tags strings","items":{"type":"string"}},"roomId":{"type":"string","description":"the room id"}}},"RoomTagsUpdate":{"type":"object","properties":{"content":{"type":"array","description":"the room tags strings","items":{"type":"string"}}}},"sms":{"type":"object","properties":{"to":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"text":{"type":"string"}}},"UserInfo":{"type":"object","properties":{"uid":{"type":"string","description":"the user id"},"givenName":{"type":"string","description":"the user given name"},"sn":{"type":"string","description":"the user surname"}}}},"responses":{"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The message describing the internal error"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_UNAUTHORIZED","error":"Unauthorized"}}}},"BadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_MISSING_PARAMS","error":"Properties are missing in the request body"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_FORBIDDEN","error":"Forbidden"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"error":"Conflict"}}}},"PermanentRedirect":{"description":"Permanent Redirect","headers":{"Location":{"schema":{"type":"string","description":"URL to use for recdirect"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_UNKNOWN","error":"This non-standard endpoint has been removed"}}}},"NotFound":{"description":"Private note not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_NOT_FOUND","error":"Not Found"}}}},"Unrecognized":{"description":"Unrecognized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_UNRECOGNIZED","error":"Unrecognized"}}}},"InternalError":{"description":"Internal error"},"Created":{"description":"Created"},"NoContent":{"description":"operation successful and no content returned"}},"parameters":{"target_userid":{"name":"target_userid","in":"path","required":true,"description":"the target user id","schema":{"type":"string"}},"user_id":{"name":"user_id","in":"query","description":"the author user id","required":true,"schema":{"type":"string"}},"target_user_id":{"name":"target_user_id","in":"query","description":"the target user id","required":true,"schema":{"type":"string"}},"private_note_id":{"name":"private_note_id","in":"path","description":"the private note id","required":true,"schema":{"type":"string"}},"roomId":{"in":"path","name":"roomId","description":"the room id","required":true,"schema":{"type":"string"}},"userId":{"in":"path","name":"userId","description":"the user id","required":true,"schema":{"type":"string"}}}},"security":[{"bearerAuth":[]}],"paths":{"/_matrix/identity/v2":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2"}},"/_matrix/identity/v2/hash_details":{"get":{"tags":["Federated identity service"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2hash_details"}},"/_matrix/identity/v2/lookup":{"post":{"tags":["Federated identity service"],"description":"Extends https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2lookup to display inactive users and 3PID users","requestBody":{"description":"Object containing hashes of mails/phones to search","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"string","description":"List of (hashed) addresses to lookup"}},"algorithm":{"type":"string","description":"Algorithm the client is using to encode the addresses"},"pepper":{"type":"string","description":"Pepper from '/hash_details'"}},"required":["addresses","algorithm","pepper"]},"example":{"addresses":["4kenr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","nlo35_T5fzSGZzJApqu8lgIudJvmOQtDaHtr-I4rU7I"],"algorithm":"sha256","pepper":"matrixrocks"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"object","additionalProperties":{"type":"string"},"description":"List of active accounts"},"inactive_mappings":{"type":"object","additionalProperties":{"type":"string"},"description":"List of inactive accounts"},"third_party_mappings":{"type":"object","description":"List of hashed addresses by identity server hostname","properties":{"hostname":{"type":"object","properties":{"actives":{"type":"array","items":{"type":"string","description":"List of (hashed) active accounts addresses matching request body addresses"}},"inactives":{"type":"array","items":{"type":"string","description":"List of (hashed) inactive accounts addresses matching request body addresses"}}}}}}}},"example":{"mappings":{"4kenr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc":"@dwho:company.com"},"inactive_mappings":{"nlo35_T5fzSGZzJApqu8lgIudJvmOQtDaHtr-I4rU7I":"@rtyler:company.com"},"third_party_mappings":{"identity1.example.com":{"actives":["78jnr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","gtr42_T5fzSGZzJAmlp5lgIudJvmOQtDaHtr-I4rU7I"],"inactives":["qfgt57N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","lnbc8_T5fzSGZzJAmlp5lgIudJvmOQtDaHtr-I4rU7I"]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/identity/v2/account":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2account"}},"/_matrix/identity/v2/account/register":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2accountregister"}},"/_matrix/identity/v2/account/logout":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2accountlogout"}},"/_matrix/identity/v2/terms":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2terms"}},"/_matrix/identity/v2/validate/email/requestToken":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2validateemailrequesttoken"}},"/_matrix/identity/v2/validate/email/submitToken":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2validateemailsubmittoken"}},"/_matrix/identity/versions":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityversions"}},"/_twake/identity/v1/lookup/match":{"post":{"tags":["Identity server"],"description":"Looks up the Organization User IDs which match value sent","requestBody":{"description":"Object containing detail for the search and the returned data","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"array","items":{"type":"string","description":"List of fields to search in (uid, mail,...)"}},"fields":{"type":"array","items":{"type":"string","description":"List of fields to return for matching users (uid, mail, mobile, displayName, givenName, cn, sn)"}},"val":{"type":"string","description":"Optional value to search"},"limit":{"type":"integer","description":"Optional max number of result to return (default 30)"},"offset":{"type":"integer","description":"Optional offset for pagination"}},"required":["scope","fields"]},"example":{"scope":["mail","uid"],"fields":["uid","displayName","sn","givenName","mobile"],"val":"rtyler","limit":3}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"matches":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Matrix address"},"uid":{"type":"string","description":"id of a matching user"},"mail":{"type":"string","description":"email address of a matching user"}}},"description":"List of users that match"}}},"example":{"matches":[{"uid":"dwho","mail":"dwho@badwolf.com"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/_twake/identity/v1/lookup/diff":{"post":{"tags":["Identity server"],"description":"Looks up the Organization User IDs updated since X","requestBody":{"description":"Object containing the timestamp","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"since":{"type":"integer","description":"timestamp"},"fields":{"type":"array","items":{"type":"string","description":"List of fields to return for matching users"}},"limit":{"type":"integer","description":"Optional max number of result to return (default 30)"},"offset":{"type":"integer","description":"Optional offset for pagination"}}},"example":{"since":1685074279,"fields":["uid","mail"],"limit":3}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"matches":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Matrix address"},"timestamp":{"type":"integer","description":"current server timestamp"},"uid":{"type":"string","description":"id of a matching user"},"mail":{"type":"string","description":"email address of a matching user"}}},"description":"List of users that match"}}},"example":{"matches":[{"uid":"dwho","mail":"dwho@badwolf.com"}]}}}}}}},"/_twake/recoveryWords":{"get":{"tags":["Vault API"],"description":"Allow for the connected user to retrieve its recovery words","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"words":{"type":"string","description":"Recovery words of the connected user"}}},"example":{"words":"This is the recovery sentence of rtyler"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Connected user has no recovery sentence"}}},"example":{"error":"User has no recovery sentence"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Connected user has multiple recovery sentence"}}},"example":{"error":"User has more than one recovery sentence"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["Vault API"],"description":"Store connected user recovery words in database","requestBody":{"description":"Object containing the recovery words of the connected user","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"words":{"type":"string","description":"The recovery words of the connected user"}},"required":["words"]},"example":{"words":"This is the recovery sentence of rtyler"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Message indicating that words have been successfully saved"}},"example":{"message":"Saved recovery words sucessfully"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["Vault API"],"description":"Delete the user recovery words in the database","responses":{"204":{"description":"Delete success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Connected user has no recovery sentence"}}},"example":{"error":"User has no recovery sentence"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/.well-knwon/matrix/client":{"get":{"tags":["Auto configuration"],"description":"Get server metadata for auto configuration","responses":{"200":{"description":"Give server metadata","content":{"application/json":{"schema":{"type":"object","properties":{"m.homeserver":{"type":"object","properties":{"base_url":{"type":"string","description":"Base URL of Matrix server"}}},"m.identity_server":{"type":"object","properties":{"base_url":{"type":"string","description":"Base URL of Identity server"}}},"m.federated_identity_services":{"type":"object","properties":{"base_urls":{"type":"array","items":{"type":"string","description":"Base URL of Federated identity service"},"description":"Available Federated identity services Base URL list"}}},"t.server":{"type":"object","properties":{"base_url":{"type":"string","description":"Base URL of Identity server"},"server_name":{"type":"string","description":"Domain handled by Matrix server"}}},"m.integrations":{"type":"object","properties":{"jitsi":{"type":"object","properties":{"preferredDomain":{"type":"string","description":"Jitsi's preffered domain"},"baseUrl":{"type":"string","description":"URL of Jitsi server"},"useJwt":{"type":"boolean","description":"True if Jitsi server requires a JWT"},"jwt":{"type":"object","properties":{"algorithm":{"type":"string","description":"algorithm used to generate JWT"},"secret":{"type":"string","description":"password of JWTs"},"issuer":{"type":"string","description":"issuer of JWTs"}}}}}}},"m.authentication":{"type":"object","properties":{"issuer":{"type":"string","description":"URL of OIDC issuer"}}}}},"example":{"m.homeserver":{"base_url":"matrix.example.com"},"m.identity_server":{"base_url":"global-id-server.twake.app"},"m.federated_identity_services":{"base_urls":["global-federated_identity_service.twake.app","other-federated-identity-service.twake.app"]},"m.integrations":{"jitsi":{"baseUrl":"https://jitsi.example.com/","preferredDomain":"jitsi.example.com","useJwt":false}},"m.authentication":{"issuer":"https://auth.example.com"},"t.server":{"base_url":"https://tom.example.com","server_name":"example.com"}}}}}}}},"/_matrix/identity/v2/lookups":{"post":{"tags":["Federated identity service"],"description":"Implements https://github.com/guimard/matrix-spec-proposals/blob/unified-identity-service/proposals/4004-unified-identity-service-view.md","requestBody":{"description":"Object containing hashes to store in federated identity service database","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"object","description":"List of hashed addresses by identity server hostname","properties":{"hostname":{"type":"array","items":{"type":"object","properties":{"hash":{"type":"string"},"active":{"type":"number"}}}}}},"algorithm":{"type":"string","description":"Algorithm the client is using to encode the addresses"},"pepper":{"type":"string","description":"Pepper from '/hash_details'"}},"required":["addresses","algorithm","pepper"]},"example":{"mappings":{"identity1.example.com":[{"hash":"4kenr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","active":1},{"hash":"nlo35_T5fzSGZzJApqu8lgIudJvmOQtDaHtr-I4rU7I","active":0}]},"algorithm":"sha256","pepper":"matrixrocks"}}}},"responses":{"201":{"description":"Success"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/app/v1/transactions/{txnId}":{"put":{"parameters":[{"in":"path","name":"txnId","required":true,"schema":{"type":"integer"},"description":"The transaction id"}],"tags":["Application server"],"description":"Implements https://spec.matrix.org/v1.6/application-service-api/#put_matrixappv1transactionstxnid","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"308":{"$ref":"#/components/responses/PermanentRedirect"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/app/v1/users/{userId}":{"get":{"parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer"},"description":"The user id"}],"tags":["Application server"],"description":"Implements https://spec.matrix.org/v1.6/application-service-api/#get_matrixappv1usersuserid","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/app/v1/rooms/{roomAlias}":{"get":{"parameters":[{"in":"path","name":"roomAlias","required":true,"schema":{"type":"integer"},"description":"The room alias"}],"tags":["Application server"],"description":"Implements https://spec.matrix.org/v1.6/application-service-api/#get_matrixappv1roomsroomalias","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/app/v1/rooms":{"post":{"tags":["Application server"],"description":"Implements https://www.notion.so/Automatic-channels-89ba6f97bc90474ca482a28cf3228d3e","requestBody":{"description":"Object containing room's details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ldapFilter":{"type":"object","additionalProperties":true,"description":"An object containing keys/values to build a ldap filter"},"aliasName":{"type":"string","description":"The desired room alias local part. If aliasName is equal to foo the complete room alias will be"},"name":{"type":"string","description":"The room name"},"topic":{"type":"string","description":"A short message detailing what is currently being discussed in the room."},"visibility":{"type":"string","enum":["public","private"],"description":"visibility values:\n * `public` - The room will be shown in the published room list\n * `private` - Hide the room from the published room list\n"}},"required":["ldapFilter","aliasName"]},"example":{"ldapFilter":{"mail":"example@test.com","cn":"example"},"aliasName":"exp","name":"Example","topic":"This is an example of a room topic","visibility":"public"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"errcode":{"type":"string"},"error":{"type":"string"}},"additionalProperties":{"type":"string"},"description":"List of users uid not added to the new room due to an error"},"example":[{"uid":"test1","errcode":"M_FORBIDDEN","error":"The user has been banned from the room"},{"uid":"test2","errcode":"M_UNKNOWN","error":"Internal server error"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"examples":{"example1":{"value":{"error":"Error field: Invalid value (property: name)"}},"example2":{"value":{"errcode":"M_NOT_JSON","error":"Not_json"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"examples":{"example1":{"value":{"error":"This room already exits in Twake database"}},"example2":{"value":{"errcode":"M_ROOM_IN_USE","error":"A room with alias foo already exists in Matrix database"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/mutual_rooms/{target_userid}":{"get":{"tags":["Mutual Rooms"],"description":"Get the list of mutual rooms between two users","parameters":[{"$ref":"#/components/parameters/target_userid"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MutualRooms"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Not found"},"500":{"description":"Internal error"}}}},"/_twake/private_note":{"get":{"tags":["Private Note"],"description":"Get the private note made by the user for a target user","parameters":[{"$ref":"#/components/parameters/user_id"},{"$ref":"#/components/parameters/target_user_id"}],"responses":{"200":{"description":"Private note found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateNote"}}}},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"404":{"description":"Private note not found"},"500":{"description":"Internal error"}}},"post":{"tags":["Private Note"],"description":"Create a private note for a target user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrivateNote"}}}},"responses":{"201":{"description":"Private note created"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}},"put":{"tags":["Private Note"],"description":"Update a private note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePrivateNote"}}}},"responses":{"204":{"description":"Private note created"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/private_note/{private_note_id}":{"delete":{"tags":["Private Note"],"description":"Delete a private note","parameters":[{"$ref":"#/components/parameters/private_note_id"}],"responses":{"204":{"description":"Private note deleted"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/v1/room_tags/{roomId}":{"get":{"tags":["Room tags"],"description":"Get room tags","parameters":[{"$ref":"#/components/parameters/roomId"}],"responses":{"200":{"description":"Room tags found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomTags"}}}},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}},"put":{"tags":["Room tags"],"description":"Update room tags","parameters":[{"$ref":"#/components/parameters/roomId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomTagsUpdate"}}}},"responses":{"204":{"description":"Room tags updated"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}},"delete":{"tags":["Room tags"],"description":"delete tags for a room","parameters":[{"$ref":"#/components/parameters/roomId"}],"responses":{"204":{"description":"Room tags deleted"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/v1/room_tags":{"post":{"tags":["Room tags"],"description":"Create room tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomTagCreation"}}}},"responses":{"201":{"description":"Room tags created"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/app/v1/search":{"post":{"tags":["Search Engine"],"description":"Search performs with OpenSearch on Tchat messages and rooms","requestBody":{"description":"Object containing search query details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"searchValue":{"type":"string","description":"Value used to perform the search on rooms and messages data"}},"required":["searchValue"]},"example":{"searchValue":"hello"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"rooms":{"type":"array","description":"List of rooms whose name contains the search value","items":{"type":"object","properties":{"room_id":{"type":"string"},"name":{"type":"string"},"avatar_url":{"type":"string","description":"Url of the room's avatar"}}}},"messages":{"type":"array","description":"List of messages whose content or/and sender display name contain the search value","items":{"type":"object","properties":{"room_id":{"type":"string"},"event_id":{"type":"string","description":"Id of the message"},"content":{"type":"string"},"display_name":{"type":"string","description":"Sender display name"},"avatar_url":{"type":"string","description":"Sender's avatar url if it is a direct chat, otherwise it is the room's avatar url"},"room_name":{"type":"string","description":"Room's name in case of the message is not part of a direct chat"}}}},"mails":{"type":"array","description":"List of mails from Tmail whose meta or content contain the search value","items":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"contentDisposition":{"type":"string"},"fileExtension":{"type":"string"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"subtype":{"type":"string"},"textContent":{"type":"string"}}}},"bcc":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"cc":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"date":{"type":"string"},"from":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"hasAttachment":{"type":"boolean"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"htmlBody":{"type":"string"},"isAnswered":{"type":"boolean"},"isDeleted":{"type":"boolean"},"isDraft":{"type":"boolean"},"isFlagged":{"type":"boolean"},"isRecent":{"type":"boolean"},"isUnread":{"type":"boolean"},"mailboxId":{"type":"string"},"mediaType":{"type":"string"},"messageId":{"type":"string"},"mimeMessageID":{"type":"string"},"modSeq":{"type":"number"},"saveDate":{"type":"string"},"sentDate":{"type":"string"},"size":{"type":"number"},"subject":{"type":"array","items":{"type":"string"}},"subtype":{"type":"string"},"textBody":{"type":"string"},"threadId":{"type":"string"},"to":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"uid":{"type":"number"},"userFlags":{"type":"array","items":{"type":"string"}}}}}}},"example":{"rooms":[{"room_id":"!dYqMpBXVQgKWETVAtJ:example.com","name":"Hello world room","avatar_url":"mxc://linagora.com/IBGFusHnOOzCNfePjaIVHpgR"},{"room_id":"!dugSgNYwppGGoeJwYB:example.com","name":"Worldwide room","avatar_url":null}],"messages":[{"room_id":"!dYqMpBXVQgKWETVAtJ:example.com","event_id":"$c0hW6db_GUjk0NRBUuO12IyMpi48LE_tQK6sH3dkd1U","content":"Hello world","display_name":"Anakin Skywalker","avatar_url":"mxc://linagora.com/IBGFusHnOOzCNfePjaIVHpgR","room_name":"Hello world room"},{"room_id":"!ftGqINYwppGGoeJwYB:example.com","event_id":"$IUzFofxHCvvoHJ-k2nfx7OlWOO8AuPvlHHqkeJLzxJ8","content":"Hello world my friends in direct chat","display_name":"Luke Skywalker","avatar_url":"mxc://matrix.org/wefh34uihSDRGhw34"}],"mails":[{"id":"message1","attachments":[{"contentDisposition":"attachment","fileExtension":"jpg","fileName":"image1.jpg","mediaType":"image/jpeg","textContent":"A beautiful galaxy far, far away."}],"bcc":[{"address":"okenobi@example.com","domain":"example.com","name":"Obi-Wan Kenobi"}],"cc":[{"address":"pamidala@example.com","domain":"example.com","name":"Padme Amidala"}],"date":"2024-02-24T10:15:00Z","from":[{"address":"dmaul@example.com","domain":"example.com","name":"Dark Maul"}],"hasAttachment":true,"headers":[{"name":"Header5","value":"Value5"},{"name":"Header6","value":"Value6"}],"htmlBody":"A beautiful galaxy far, far away.
","isAnswered":true,"isDeleted":false,"isDraft":false,"isFlagged":true,"isRecent":true,"isUnread":false,"mailboxId":"mailbox3","mediaType":"image/jpeg","messageId":"message3","mimeMessageID":"mimeMessageID3","modSeq":98765,"saveDate":"2024-02-24T10:15:00Z","sentDate":"2024-02-24T10:15:00Z","size":4096,"subject":["Star Wars Message 3"],"subtype":"subtype3","textBody":"A beautiful galaxy far, far away.","threadId":"thread3","to":[{"address":"kren@example.com","domain":"example.com","name":"Kylo Ren"}],"uid":987654,"userFlags":["Flag4","Flag5"]}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/app/v1/opensearch/restore":{"post":{"tags":["Search Engine"],"description":"Restore OpenSearch indexes using Matrix homeserver database","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/sms":{"post":{"requestBody":{"description":"SMS object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms"}}}},"tags":["SMS"],"description":"Send an SMS to a phone number","responses":{"200":{"description":"SMS sent successfully"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal server error"}}}},"/_twake/v1/user_info/{userId}":{"get":{"tags":["User Info"],"description":"Get user info","parameters":[{"$ref":"#/components/parameters/userId"}],"responses":{"200":{"description":"User info found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfo"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"User info not found"},"500":{"description":"Internal server error"}}}}},"tags":[]}
\ No newline at end of file
+{"openapi":"3.0.0","info":{"title":"Twake on Matrix APIs documentation","version":"0.0.1","description":"This is The documentation of all available APIs of this repository"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MatrixError":{"type":"object","properties":{"errcode":{"type":"string","description":"A Matrix error code"},"error":{"type":"string","description":"A human-readable error message"}},"required":["error"]},"ActiveContacts":{"type":"object","description":"the list of active contacts","properties":{"contacts":{"type":"string","description":"active contacts"}}},"MutualRooms":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","description":"the room id"},"name":{"type":"string","description":"the room name"},"topic":{"type":"string","description":"the room topic"},"room_type":{"type":"string","description":"the room type"}}}},"PrivateNote":{"type":"object","properties":{"id":{"type":"string","description":"The private note id"},"content":{"type":"string","description":"The private note content"},"authorId":{"type":"string","description":"The author user id"},"targetId":{"type":"string","description":"The target user id"}}},"CreatePrivateNote":{"type":"object","properties":{"content":{"type":"string","description":"The private note content"},"authorId":{"type":"string","description":"The author user id"},"targetId":{"type":"string","description":"The target user id"}}},"UpdatePrivateNote":{"type":"object","properties":{"id":{"type":"string","description":"The private note id"},"content":{"type":"string","description":"The private note content"}}},"RoomTags":{"type":"object","properties":{"tags":{"description":"the room tags list","type":"array","items":{"type":"string"}}}},"RoomTagCreation":{"type":"object","properties":{"content":{"type":"array","description":"the room tags strings","items":{"type":"string"}},"roomId":{"type":"string","description":"the room id"}}},"RoomTagsUpdate":{"type":"object","properties":{"content":{"type":"array","description":"the room tags strings","items":{"type":"string"}}}},"sms":{"type":"object","properties":{"to":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"text":{"type":"string"}}},"UserInfo":{"type":"object","properties":{"uid":{"type":"string","description":"the user id"},"givenName":{"type":"string","description":"the user given name"},"sn":{"type":"string","description":"the user surname"}}}},"responses":{"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The message describing the internal error"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_UNAUTHORIZED","error":"Unauthorized"}}}},"BadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_MISSING_PARAMS","error":"Properties are missing in the request body"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_FORBIDDEN","error":"Forbidden"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"error":"Conflict"}}}},"PermanentRedirect":{"description":"Permanent Redirect","headers":{"Location":{"schema":{"type":"string","description":"URL to use for recdirect"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_UNKNOWN","error":"This non-standard endpoint has been removed"}}}},"NotFound":{"description":"Private note not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_NOT_FOUND","error":"Not Found"}}}},"Unrecognized":{"description":"Unrecognized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"example":{"errcode":"M_UNRECOGNIZED","error":"Unrecognized"}}}},"Created":{"description":"Created"},"NoContent":{"description":"operation successful and no content returned"},"InternalError":{"description":"Internal error"}},"parameters":{"target_userid":{"name":"target_userid","in":"path","required":true,"description":"the target user id","schema":{"type":"string"}},"user_id":{"name":"user_id","in":"query","description":"the author user id","required":true,"schema":{"type":"string"}},"target_user_id":{"name":"target_user_id","in":"query","description":"the target user id","required":true,"schema":{"type":"string"}},"private_note_id":{"name":"private_note_id","in":"path","description":"the private note id","required":true,"schema":{"type":"string"}},"roomId":{"in":"path","name":"roomId","description":"the room id","required":true,"schema":{"type":"string"}},"userId":{"in":"path","name":"userId","description":"the user id","required":true,"schema":{"type":"string"}}}},"security":[{"bearerAuth":[]}],"paths":{"/_matrix/identity/v2":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2"}},"/_matrix/identity/v2/hash_details":{"get":{"tags":["Federated identity service"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2hash_details"}},"/_matrix/identity/v2/lookup":{"post":{"tags":["Federated identity service"],"description":"Extends https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2lookup to display inactive users and 3PID users","requestBody":{"description":"Object containing hashes of mails/phones to search","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"string","description":"List of (hashed) addresses to lookup"}},"algorithm":{"type":"string","description":"Algorithm the client is using to encode the addresses"},"pepper":{"type":"string","description":"Pepper from '/hash_details'"}},"required":["addresses","algorithm","pepper"]},"example":{"addresses":["4kenr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","nlo35_T5fzSGZzJApqu8lgIudJvmOQtDaHtr-I4rU7I"],"algorithm":"sha256","pepper":"matrixrocks"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"object","additionalProperties":{"type":"string"},"description":"List of active accounts"},"inactive_mappings":{"type":"object","additionalProperties":{"type":"string"},"description":"List of inactive accounts"},"third_party_mappings":{"type":"object","description":"List of hashed addresses by identity server hostname","properties":{"hostname":{"type":"object","properties":{"actives":{"type":"array","items":{"type":"string","description":"List of (hashed) active accounts addresses matching request body addresses"}},"inactives":{"type":"array","items":{"type":"string","description":"List of (hashed) inactive accounts addresses matching request body addresses"}}}}}}}},"example":{"mappings":{"4kenr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc":"@dwho:company.com"},"inactive_mappings":{"nlo35_T5fzSGZzJApqu8lgIudJvmOQtDaHtr-I4rU7I":"@rtyler:company.com"},"third_party_mappings":{"identity1.example.com":{"actives":["78jnr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","gtr42_T5fzSGZzJAmlp5lgIudJvmOQtDaHtr-I4rU7I"],"inactives":["qfgt57N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","lnbc8_T5fzSGZzJAmlp5lgIudJvmOQtDaHtr-I4rU7I"]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/identity/v2/account":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2account"}},"/_matrix/identity/v2/account/register":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2accountregister"}},"/_matrix/identity/v2/account/logout":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2accountlogout"}},"/_matrix/identity/v2/terms":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityv2terms"}},"/_matrix/identity/v2/validate/email/requestToken":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2validateemailrequesttoken"}},"/_matrix/identity/v2/validate/email/submitToken":{"post":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#post_matrixidentityv2validateemailsubmittoken"}},"/_matrix/identity/versions":{"get":{"tags":["Identity server"],"description":"Implements https://spec.matrix.org/v1.6/identity-service-api/#get_matrixidentityversions"}},"/_twake/identity/v1/lookup/match":{"post":{"tags":["Identity server"],"description":"Looks up the Organization User IDs which match value sent","requestBody":{"description":"Object containing detail for the search and the returned data","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"array","items":{"type":"string","description":"List of fields to search in (uid, mail,...)"}},"fields":{"type":"array","items":{"type":"string","description":"List of fields to return for matching users (uid, mail, mobile, displayName, givenName, cn, sn)"}},"val":{"type":"string","description":"Optional value to search"},"limit":{"type":"integer","description":"Optional max number of result to return (default 30)"},"offset":{"type":"integer","description":"Optional offset for pagination"}},"required":["scope","fields"]},"example":{"scope":["mail","uid"],"fields":["uid","displayName","sn","givenName","mobile"],"val":"rtyler","limit":3}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"matches":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Matrix address"},"uid":{"type":"string","description":"id of a matching user"},"mail":{"type":"string","description":"email address of a matching user"}}},"description":"List of users that match"}}},"example":{"matches":[{"uid":"dwho","mail":"dwho@badwolf.com"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/_twake/identity/v1/lookup/diff":{"post":{"tags":["Identity server"],"description":"Looks up the Organization User IDs updated since X","requestBody":{"description":"Object containing the timestamp","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"since":{"type":"integer","description":"timestamp"},"fields":{"type":"array","items":{"type":"string","description":"List of fields to return for matching users"}},"limit":{"type":"integer","description":"Optional max number of result to return (default 30)"},"offset":{"type":"integer","description":"Optional offset for pagination"}}},"example":{"since":1685074279,"fields":["uid","mail"],"limit":3}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"matches":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Matrix address"},"timestamp":{"type":"integer","description":"current server timestamp"},"uid":{"type":"string","description":"id of a matching user"},"mail":{"type":"string","description":"email address of a matching user"}}},"description":"List of users that match"}}},"example":{"matches":[{"uid":"dwho","mail":"dwho@badwolf.com"}]}}}}}}},"/_twake/recoveryWords":{"get":{"tags":["Vault API"],"description":"Allow for the connected user to retrieve its recovery words","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"words":{"type":"string","description":"Recovery words of the connected user"}}},"example":{"words":"This is the recovery sentence of rtyler"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Connected user has no recovery sentence"}}},"example":{"error":"User has no recovery sentence"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Connected user has multiple recovery sentence"}}},"example":{"error":"User has more than one recovery sentence"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["Vault API"],"description":"Store connected user recovery words in database","requestBody":{"description":"Object containing the recovery words of the connected user","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"words":{"type":"string","description":"The recovery words of the connected user"}},"required":["words"]},"example":{"words":"This is the recovery sentence of rtyler"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Message indicating that words have been successfully saved"}},"example":{"message":"Saved recovery words sucessfully"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["Vault API"],"description":"Delete the user recovery words in the database","responses":{"204":{"description":"Delete success"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Connected user has no recovery sentence"}}},"example":{"error":"User has no recovery sentence"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/.well-knwon/matrix/client":{"get":{"tags":["Auto configuration"],"description":"Get server metadata for auto configuration","responses":{"200":{"description":"Give server metadata","content":{"application/json":{"schema":{"type":"object","properties":{"m.homeserver":{"type":"object","properties":{"base_url":{"type":"string","description":"Base URL of Matrix server"}}},"m.identity_server":{"type":"object","properties":{"base_url":{"type":"string","description":"Base URL of Identity server"}}},"m.federated_identity_services":{"type":"object","properties":{"base_urls":{"type":"array","items":{"type":"string","description":"Base URL of Federated identity service"},"description":"Available Federated identity services Base URL list"}}},"t.server":{"type":"object","properties":{"base_url":{"type":"string","description":"Base URL of Identity server"},"server_name":{"type":"string","description":"Domain handled by Matrix server"}}},"m.integrations":{"type":"object","properties":{"jitsi":{"type":"object","properties":{"preferredDomain":{"type":"string","description":"Jitsi's preffered domain"},"baseUrl":{"type":"string","description":"URL of Jitsi server"},"useJwt":{"type":"boolean","description":"True if Jitsi server requires a JWT"},"jwt":{"type":"object","properties":{"algorithm":{"type":"string","description":"algorithm used to generate JWT"},"secret":{"type":"string","description":"password of JWTs"},"issuer":{"type":"string","description":"issuer of JWTs"}}}}}}},"m.authentication":{"type":"object","properties":{"issuer":{"type":"string","description":"URL of OIDC issuer"}}}}},"example":{"m.homeserver":{"base_url":"matrix.example.com"},"m.identity_server":{"base_url":"global-id-server.twake.app"},"m.federated_identity_services":{"base_urls":["global-federated_identity_service.twake.app","other-federated-identity-service.twake.app"]},"m.integrations":{"jitsi":{"baseUrl":"https://jitsi.example.com/","preferredDomain":"jitsi.example.com","useJwt":false}},"m.authentication":{"issuer":"https://auth.example.com"},"t.server":{"base_url":"https://tom.example.com","server_name":"example.com"}}}}}}}},"/_matrix/identity/v2/lookups":{"post":{"tags":["Federated identity service"],"description":"Implements https://github.com/guimard/matrix-spec-proposals/blob/unified-identity-service/proposals/4004-unified-identity-service-view.md","requestBody":{"description":"Object containing hashes to store in federated identity service database","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"object","description":"List of hashed addresses by identity server hostname","properties":{"hostname":{"type":"array","items":{"type":"object","properties":{"hash":{"type":"string"},"active":{"type":"number"}}}}}},"algorithm":{"type":"string","description":"Algorithm the client is using to encode the addresses"},"pepper":{"type":"string","description":"Pepper from '/hash_details'"}},"required":["addresses","algorithm","pepper"]},"example":{"mappings":{"identity1.example.com":[{"hash":"4kenr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc","active":1},{"hash":"nlo35_T5fzSGZzJApqu8lgIudJvmOQtDaHtr-I4rU7I","active":0}]},"algorithm":"sha256","pepper":"matrixrocks"}}}},"responses":{"201":{"description":"Success"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/app/v1/transactions/{txnId}":{"put":{"parameters":[{"in":"path","name":"txnId","required":true,"schema":{"type":"integer"},"description":"The transaction id"}],"tags":["Application server"],"description":"Implements https://spec.matrix.org/v1.6/application-service-api/#put_matrixappv1transactionstxnid","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"308":{"$ref":"#/components/responses/PermanentRedirect"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/app/v1/users/{userId}":{"get":{"parameters":[{"in":"path","name":"userId","required":true,"schema":{"type":"integer"},"description":"The user id"}],"tags":["Application server"],"description":"Implements https://spec.matrix.org/v1.6/application-service-api/#get_matrixappv1usersuserid","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_matrix/app/v1/rooms/{roomAlias}":{"get":{"parameters":[{"in":"path","name":"roomAlias","required":true,"schema":{"type":"integer"},"description":"The room alias"}],"tags":["Application server"],"description":"Implements https://spec.matrix.org/v1.6/application-service-api/#get_matrixappv1roomsroomalias","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/v1/activecontacts":{"get":{"tags":["Active contacts"],"description":"Get the list of active contacts","responses":{"200":{"description":"Active contacts found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveContacts"}}}},"401":{"description":"user is unauthorized"},"404":{"description":"Active contacts not found"},"500":{"description":"Internal error"}}},"post":{"tags":["Active contacts"],"description":"Create or update the list of active contacts","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveContacts"}}}},"responses":{"201":{"description":"Active contacts saved"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}},"delete":{"tags":["Active contacts"],"description":"Delete the list of active contacts","responses":{"200":{"description":"Active contacts deleted"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error/"}}}},"/_twake/app/v1/rooms":{"post":{"tags":["Application server"],"description":"Implements https://www.notion.so/Automatic-channels-89ba6f97bc90474ca482a28cf3228d3e","requestBody":{"description":"Object containing room's details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ldapFilter":{"type":"object","additionalProperties":true,"description":"An object containing keys/values to build a ldap filter"},"aliasName":{"type":"string","description":"The desired room alias local part. If aliasName is equal to foo the complete room alias will be"},"name":{"type":"string","description":"The room name"},"topic":{"type":"string","description":"A short message detailing what is currently being discussed in the room."},"visibility":{"type":"string","enum":["public","private"],"description":"visibility values:\n * `public` - The room will be shown in the published room list\n * `private` - Hide the room from the published room list\n"}},"required":["ldapFilter","aliasName"]},"example":{"ldapFilter":{"mail":"example@test.com","cn":"example"},"aliasName":"exp","name":"Example","topic":"This is an example of a room topic","visibility":"public"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"errcode":{"type":"string"},"error":{"type":"string"}},"additionalProperties":{"type":"string"},"description":"List of users uid not added to the new room due to an error"},"example":[{"uid":"test1","errcode":"M_FORBIDDEN","error":"The user has been banned from the room"},{"uid":"test2","errcode":"M_UNKNOWN","error":"Internal server error"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"examples":{"example1":{"value":{"error":"Error field: Invalid value (property: name)"}},"example2":{"value":{"errcode":"M_NOT_JSON","error":"Not_json"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatrixError"},"examples":{"example1":{"value":{"error":"This room already exits in Twake database"}},"example2":{"value":{"errcode":"M_ROOM_IN_USE","error":"A room with alias foo already exists in Matrix database"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/mutual_rooms/{target_userid}":{"get":{"tags":["Mutual Rooms"],"description":"Get the list of mutual rooms between two users","parameters":[{"$ref":"#/components/parameters/target_userid"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MutualRooms"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Not found"},"500":{"description":"Internal error"}}}},"/_twake/private_note":{"get":{"tags":["Private Note"],"description":"Get the private note made by the user for a target user","parameters":[{"$ref":"#/components/parameters/user_id"},{"$ref":"#/components/parameters/target_user_id"}],"responses":{"200":{"description":"Private note found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateNote"}}}},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"404":{"description":"Private note not found"},"500":{"description":"Internal error"}}},"post":{"tags":["Private Note"],"description":"Create a private note for a target user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrivateNote"}}}},"responses":{"201":{"description":"Private note created"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}},"put":{"tags":["Private Note"],"description":"Update a private note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePrivateNote"}}}},"responses":{"204":{"description":"Private note created"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/private_note/{private_note_id}":{"delete":{"tags":["Private Note"],"description":"Delete a private note","parameters":[{"$ref":"#/components/parameters/private_note_id"}],"responses":{"204":{"description":"Private note deleted"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/v1/room_tags/{roomId}":{"get":{"tags":["Room tags"],"description":"Get room tags","parameters":[{"$ref":"#/components/parameters/roomId"}],"responses":{"200":{"description":"Room tags found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomTags"}}}},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}},"put":{"tags":["Room tags"],"description":"Update room tags","parameters":[{"$ref":"#/components/parameters/roomId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomTagsUpdate"}}}},"responses":{"204":{"description":"Room tags updated"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}},"delete":{"tags":["Room tags"],"description":"delete tags for a room","parameters":[{"$ref":"#/components/parameters/roomId"}],"responses":{"204":{"description":"Room tags deleted"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/v1/room_tags":{"post":{"tags":["Room tags"],"description":"Create room tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomTagCreation"}}}},"responses":{"201":{"description":"Room tags created"},"400":{"description":"Bad request"},"401":{"description":"user is unauthorized"},"500":{"description":"Internal error"}}}},"/_twake/app/v1/search":{"post":{"tags":["Search Engine"],"description":"Search performs with OpenSearch on Tchat messages and rooms","requestBody":{"description":"Object containing search query details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"searchValue":{"type":"string","description":"Value used to perform the search on rooms and messages data"}},"required":["searchValue"]},"example":{"searchValue":"hello"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"rooms":{"type":"array","description":"List of rooms whose name contains the search value","items":{"type":"object","properties":{"room_id":{"type":"string"},"name":{"type":"string"},"avatar_url":{"type":"string","description":"Url of the room's avatar"}}}},"messages":{"type":"array","description":"List of messages whose content or/and sender display name contain the search value","items":{"type":"object","properties":{"room_id":{"type":"string"},"event_id":{"type":"string","description":"Id of the message"},"content":{"type":"string"},"display_name":{"type":"string","description":"Sender display name"},"avatar_url":{"type":"string","description":"Sender's avatar url if it is a direct chat, otherwise it is the room's avatar url"},"room_name":{"type":"string","description":"Room's name in case of the message is not part of a direct chat"}}}},"mails":{"type":"array","description":"List of mails from Tmail whose meta or content contain the search value","items":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"contentDisposition":{"type":"string"},"fileExtension":{"type":"string"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"subtype":{"type":"string"},"textContent":{"type":"string"}}}},"bcc":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"cc":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"date":{"type":"string"},"from":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"hasAttachment":{"type":"boolean"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"htmlBody":{"type":"string"},"isAnswered":{"type":"boolean"},"isDeleted":{"type":"boolean"},"isDraft":{"type":"boolean"},"isFlagged":{"type":"boolean"},"isRecent":{"type":"boolean"},"isUnread":{"type":"boolean"},"mailboxId":{"type":"string"},"mediaType":{"type":"string"},"messageId":{"type":"string"},"mimeMessageID":{"type":"string"},"modSeq":{"type":"number"},"saveDate":{"type":"string"},"sentDate":{"type":"string"},"size":{"type":"number"},"subject":{"type":"array","items":{"type":"string"}},"subtype":{"type":"string"},"textBody":{"type":"string"},"threadId":{"type":"string"},"to":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"domain":{"type":"string"},"name":{"type":"string"}}}},"uid":{"type":"number"},"userFlags":{"type":"array","items":{"type":"string"}}}}}}},"example":{"rooms":[{"room_id":"!dYqMpBXVQgKWETVAtJ:example.com","name":"Hello world room","avatar_url":"mxc://linagora.com/IBGFusHnOOzCNfePjaIVHpgR"},{"room_id":"!dugSgNYwppGGoeJwYB:example.com","name":"Worldwide room","avatar_url":null}],"messages":[{"room_id":"!dYqMpBXVQgKWETVAtJ:example.com","event_id":"$c0hW6db_GUjk0NRBUuO12IyMpi48LE_tQK6sH3dkd1U","content":"Hello world","display_name":"Anakin Skywalker","avatar_url":"mxc://linagora.com/IBGFusHnOOzCNfePjaIVHpgR","room_name":"Hello world room"},{"room_id":"!ftGqINYwppGGoeJwYB:example.com","event_id":"$IUzFofxHCvvoHJ-k2nfx7OlWOO8AuPvlHHqkeJLzxJ8","content":"Hello world my friends in direct chat","display_name":"Luke Skywalker","avatar_url":"mxc://matrix.org/wefh34uihSDRGhw34"}],"mails":[{"id":"message1","attachments":[{"contentDisposition":"attachment","fileExtension":"jpg","fileName":"image1.jpg","mediaType":"image/jpeg","textContent":"A beautiful galaxy far, far away."}],"bcc":[{"address":"okenobi@example.com","domain":"example.com","name":"Obi-Wan Kenobi"}],"cc":[{"address":"pamidala@example.com","domain":"example.com","name":"Padme Amidala"}],"date":"2024-02-24T10:15:00Z","from":[{"address":"dmaul@example.com","domain":"example.com","name":"Dark Maul"}],"hasAttachment":true,"headers":[{"name":"Header5","value":"Value5"},{"name":"Header6","value":"Value6"}],"htmlBody":"A beautiful galaxy far, far away.
","isAnswered":true,"isDeleted":false,"isDraft":false,"isFlagged":true,"isRecent":true,"isUnread":false,"mailboxId":"mailbox3","mediaType":"image/jpeg","messageId":"message3","mimeMessageID":"mimeMessageID3","modSeq":98765,"saveDate":"2024-02-24T10:15:00Z","sentDate":"2024-02-24T10:15:00Z","size":4096,"subject":["Star Wars Message 3"],"subtype":"subtype3","textBody":"A beautiful galaxy far, far away.","threadId":"thread3","to":[{"address":"kren@example.com","domain":"example.com","name":"Kylo Ren"}],"uid":987654,"userFlags":["Flag4","Flag5"]}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/app/v1/opensearch/restore":{"post":{"tags":["Search Engine"],"description":"Restore OpenSearch indexes using Matrix homeserver database","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"405":{"$ref":"#/components/responses/Unrecognized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/_twake/sms":{"post":{"requestBody":{"description":"SMS object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms"}}}},"tags":["SMS"],"description":"Send an SMS to a phone number","responses":{"200":{"description":"SMS sent successfully"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal server error"}}}},"/_twake/v1/user_info/{userId}":{"get":{"tags":["User Info"],"description":"Get user info","parameters":[{"$ref":"#/components/parameters/userId"}],"responses":{"200":{"description":"User info found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfo"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"User info not found"},"500":{"description":"Internal server error"}}}}},"tags":[]}
\ No newline at end of file
diff --git a/packages/matrix-identity-server/src/db/index.ts b/packages/matrix-identity-server/src/db/index.ts
index 2acd9efe..33d1e5ca 100644
--- a/packages/matrix-identity-server/src/db/index.ts
+++ b/packages/matrix-identity-server/src/db/index.ts
@@ -17,6 +17,7 @@ export type Collections =
| 'roomTags'
| 'userHistory'
| 'userQuotas'
+ | 'activeContacts'
const cleanByExpires: Collections[] = ['oneTimeTokens', 'attempts']
diff --git a/packages/matrix-identity-server/src/db/sql/sql.ts b/packages/matrix-identity-server/src/db/sql/sql.ts
index 0546c344..f493e3d0 100644
--- a/packages/matrix-identity-server/src/db/sql/sql.ts
+++ b/packages/matrix-identity-server/src/db/sql/sql.ts
@@ -25,7 +25,8 @@ const tables: Record = {
roomTags:
'id varchar(64) PRIMARY KEY, authorId varchar(64), content text, roomId varchar(64)',
userHistory: 'address text PRIMARY KEY, active integer, timestamp integer',
- userQuotas: 'user_id varchar(64) PRIMARY KEY, size int'
+ userQuotas: 'user_id varchar(64) PRIMARY KEY, size int',
+ activeContacts: 'userId text PRIMARY KEY, contacts text'
}
const indexes: Partial> = {
diff --git a/packages/tom-server/src/active-contacts-api/controllers/index.ts b/packages/tom-server/src/active-contacts-api/controllers/index.ts
new file mode 100644
index 00000000..70c13f66
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/controllers/index.ts
@@ -0,0 +1,138 @@
+/* eslint-disable no-useless-return */
+import type { Response, NextFunction } from 'express'
+import type { TwakeDB } from '../../db'
+import type {
+ IActiveContactsService,
+ IActiveContactsApiController
+} from '../types'
+import type { TwakeLogger } from '@twake/logger'
+import ActiveContactsService from '../services'
+import type { AuthRequest } from '../../types'
+
+export default class ActiveContactsApiController
+ implements IActiveContactsApiController
+{
+ ActiveContactsApiService: IActiveContactsService
+
+ /**
+ * the active contacts API controller constructor
+ *
+ * @param {TwakeDB} db - the twake database instance
+ * @param {TwakeLogger} logger - the twake logger instance
+ * @example
+ * const controller = new ActiveContactsApiController(db, logger);
+ */
+ constructor(
+ private readonly db: TwakeDB,
+ private readonly logger: TwakeLogger
+ ) {
+ this.ActiveContactsApiService = new ActiveContactsService(db, logger)
+ }
+
+ /**
+ * Save active contacts
+ *
+ * @param {AuthRequest} req - request object
+ * @param {Response} res - response object
+ * @param {NextFunction} next - next function
+ * @returns {Promise} - promise that resolves when the operation is complete
+ */
+ save = async (
+ req: AuthRequest,
+ res: Response,
+ next: NextFunction
+ ): Promise => {
+ try {
+ const { contacts } = req.body
+ const { userId } = req
+
+ if (userId === undefined || contacts === undefined) {
+ res.status(400).json({ message: 'Bad Request' })
+ return
+ }
+
+ await this.ActiveContactsApiService.save(userId, contacts)
+
+ res.status(201).send()
+ return
+ } catch (error) {
+ this.logger.error('An error occured while saving active contacts', {
+ error
+ })
+ next(error)
+ }
+ }
+
+ /**
+ * Retrieve active contacts
+ *
+ * @param {AuthRequest} req - request object
+ * @param {Response} res - response object
+ * @param {NextFunction} next - next function
+ * @returns {Promise} - promise that resolves when the operation is complete
+ */
+ get = async (
+ req: AuthRequest,
+ res: Response,
+ next: NextFunction
+ ): Promise => {
+ try {
+ const { userId } = req
+
+ if (userId === undefined) {
+ throw new Error('Missing data', {
+ cause: 'userId is missing'
+ })
+ }
+
+ const contacts = await this.ActiveContactsApiService.get(userId)
+
+ if (contacts === null) {
+ res.status(404).json({ message: 'No active contacts found' })
+ return
+ }
+
+ res.status(200).json({ contacts })
+ return
+ } catch (error) {
+ this.logger.error('An error occured while retrieving active contacts', {
+ error
+ })
+ next(error)
+ }
+ }
+
+ /**
+ * Delete saved active contacts
+ *
+ * @param {AuthRequest} req - request object
+ * @param {Response} res - response object
+ * @param {NextFunction} next - next function
+ * @returns {Promise} - promise that resolves when the operation is complete
+ */
+ delete = async (
+ req: AuthRequest,
+ res: Response,
+ next: NextFunction
+ ): Promise => {
+ try {
+ const { userId } = req
+
+ if (userId === undefined) {
+ throw new Error('Missing data', {
+ cause: 'userId is missing'
+ })
+ }
+
+ await this.ActiveContactsApiService.delete(userId)
+
+ res.status(200).send()
+ return
+ } catch (error) {
+ this.logger.error('An error occured while deleting active contacts', {
+ error
+ })
+ next(error)
+ }
+ }
+}
diff --git a/packages/tom-server/src/active-contacts-api/index.ts b/packages/tom-server/src/active-contacts-api/index.ts
new file mode 100644
index 00000000..eec21749
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/index.ts
@@ -0,0 +1 @@
+export { default } from './routes'
diff --git a/packages/tom-server/src/active-contacts-api/middlewares/index.ts b/packages/tom-server/src/active-contacts-api/middlewares/index.ts
new file mode 100644
index 00000000..e05b0c64
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/middlewares/index.ts
@@ -0,0 +1,37 @@
+import type { Response, NextFunction } from 'express'
+import type { AuthRequest } from '../../types'
+import type { IActiveContactsApiValidationMiddleware } from '../types'
+
+export default class ActiveContactsApiValidationMiddleWare
+ implements IActiveContactsApiValidationMiddleware
+{
+ /**
+ * Check the creation requirements of the active contacts API
+ *
+ * @param {AuthRequest} req - the request object
+ * @param {Response} res - the response object
+ * @param {NextFunction} next - the next function
+ * @returns {void}
+ * @example
+ * router.post('/', checkCreationRequirements, create)
+ */
+ checkCreationRequirements = (
+ req: AuthRequest,
+ res: Response,
+ next: NextFunction
+ ): void => {
+ try {
+ const { contacts } = req.body
+
+ if (contacts === undefined) {
+ throw new Error('Missing required fields', {
+ cause: 'userId or contacts is missing'
+ })
+ }
+
+ next()
+ } catch (error) {
+ res.status(400).json({ message: 'Bad Request' })
+ }
+ }
+}
diff --git a/packages/tom-server/src/active-contacts-api/routes/index.ts b/packages/tom-server/src/active-contacts-api/routes/index.ts
new file mode 100644
index 00000000..9c9a9b30
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/routes/index.ts
@@ -0,0 +1,127 @@
+/* eslint-disable @typescript-eslint/no-misused-promises */
+import {
+ getLogger,
+ type TwakeLogger,
+ type Config as LoggerConfig
+} from '@twake/logger'
+import type {
+ AuthenticationFunction,
+ Config,
+ IdentityServerDb
+} from '../../types'
+import { Router } from 'express'
+import authMiddleware from '../../utils/middlewares/auth.middleware'
+import ActiveContactsApiController from '../controllers'
+import ActiveContactsApiValidationMiddleWare from '../middlewares'
+
+export const PATH = '/_twake/v1/activecontacts'
+
+export default (
+ db: IdentityServerDb,
+ config: Config,
+ authenticator: AuthenticationFunction,
+ defaultLogger?: TwakeLogger
+): Router => {
+ const logger = defaultLogger ?? getLogger(config as unknown as LoggerConfig)
+ const activeContactsApiController = new ActiveContactsApiController(
+ db,
+ logger
+ )
+ const authenticate = authMiddleware(authenticator, logger)
+ const validationMiddleware = new ActiveContactsApiValidationMiddleWare()
+ const router = Router()
+
+ /**
+ * @openapi
+ * components:
+ * schemas:
+ * ActiveContacts:
+ * type: object
+ * description: the list of active contacts
+ * properties:
+ * contacts:
+ * type: string
+ * description: active contacts
+ * responses:
+ * NotFound:
+ * description: no active contacts found
+ * Unauthorized:
+ * description: the user is not authorized
+ * Created:
+ * description: active contacts saved
+ * NoContent:
+ * description: operation successful and no content returned
+ */
+
+ /**
+ * @openapi
+ * /_twake/v1/activecontacts:
+ * get:
+ * tags:
+ * - Active contacts
+ * description: Get the list of active contacts
+ * responses:
+ * 200:
+ * description: Active contacts found
+ * content:
+ * application/json:
+ * schema:
+ * $ref: '#/components/schemas/ActiveContacts'
+ * 404:
+ * description: Active contacts not found
+ * 401:
+ * description: user is unauthorized
+ * 500:
+ * description: Internal error
+ */
+ router.get(PATH, authenticate, activeContactsApiController.get)
+
+ /**
+ * @openapi
+ * /_twake/v1/activecontacts:
+ * post:
+ * tags:
+ * - Active contacts
+ * description: Create or update the list of active contacts
+ * requestBody:
+ * required: true
+ * content:
+ * application/json:
+ * schema:
+ * $ref: '#/components/schemas/ActiveContacts'
+ * responses:
+ * 201:
+ * description: Active contacts saved
+ * 401:
+ * description: user is unauthorized
+ * 400:
+ * description: Bad request
+ * 500:
+ * description: Internal error
+ */
+ router.post(
+ PATH,
+ authenticate,
+ validationMiddleware.checkCreationRequirements,
+ activeContactsApiController.save
+ )
+
+ /**
+ * @openapi
+ * /_twake/v1/activecontacts:
+ * delete:
+ * tags:
+ * - Active contacts
+ * description: Delete the list of active contacts
+ * responses:
+ * 200:
+ * description: Active contacts deleted
+ * 401:
+ * description: user is unauthorized
+ * 500:
+ * description: Internal error/
+ */
+ router.delete(PATH, authenticate, activeContactsApiController.delete)
+
+ return router
+}
diff --git a/packages/tom-server/src/active-contacts-api/services/index.ts b/packages/tom-server/src/active-contacts-api/services/index.ts
new file mode 100644
index 00000000..5b3dd48f
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/services/index.ts
@@ -0,0 +1,95 @@
+import type { TwakeLogger } from '@twake/logger'
+import type { TwakeDB } from '../../db'
+import type { Collections } from '../../types'
+import type { ActiveAcountsData, IActiveContactsService } from '../types'
+
+class ActiveContactsService implements IActiveContactsService {
+ /**
+ * The active contacts service constructor.
+ *
+ * @param {TwakeDB} db - The Twake database instance.
+ * @param {TwakeLogger} logger - The Twake logger instance.
+ * @example
+ * const service = new ActiveContactsService(db, logger);
+ */
+ constructor(
+ private readonly db: TwakeDB,
+ private readonly logger: TwakeLogger
+ ) {}
+
+ /**
+ * Fetches the active contacts for a given user ID.
+ *
+ * @param {string} userId - The ID of the user whose active contacts need to be fetched.
+ * @returns {Promise} - Active contacts or null if no active contacts found.
+ * @throws {Error} - If there is an error while fetching the active contacts.
+ */
+ public get = async (userId: string): Promise => {
+ try {
+ const ActiveContacts = (await this.db.get(
+ 'activeContacts' as Collections,
+ ['contacts'],
+ { userId }
+ )) as unknown as ActiveAcountsData[]
+
+ if (ActiveContacts.length === 0) {
+ this.logger.warn('No active contacts found')
+
+ return null
+ }
+
+ return ActiveContacts[0].contacts
+ } catch (error) {
+ this.logger.error('Failed to get active contacts', { error })
+ throw new Error('Failed to get active contacts', { cause: error })
+ }
+ }
+
+ /**
+ * Saves the active contacts for a given user ID and target ID.
+ *
+ * @param {string} userId - The ID of the user whose active contacts need to be saved.
+ * @param {string} contacts - The active contacts data to be saved.
+ * @returns {Promise}
+ * @throws {Error} - If there is an error while saving the active contacts.
+ */
+ save = async (userId: string, contacts: string): Promise => {
+ try {
+ await this.db.insert('activeContacts' as Collections, {
+ userId,
+ contacts
+ })
+
+ this.logger.info('active contacts saved successfully')
+ } catch (error) {
+ this.logger.error('Failed to save active contacts', { error })
+ throw new Error('Failed to save active contacts', { cause: error })
+ }
+ }
+
+ /**
+ * Deletes saved active contacts for a given user ID.
+ *
+ * @param {string} userId - The ID of the user whose saved active contacts need to be deleted.
+ * @returns {Promise}
+ * @throws {Error} - If there is an error while deleting the saved active contacts.
+ */
+ delete = async (userId: string): Promise => {
+ try {
+ await this.db.deleteEqual(
+ 'activeContacts' as Collections,
+ 'userId',
+ userId
+ )
+
+ this.logger.info('active contacts deleted successfully')
+ } catch (error) {
+ this.logger.error('Failed to delete saved active contacts', { error })
+ throw new Error('Failed to delete saved active contacts', {
+ cause: error
+ })
+ }
+ }
+}
+
+export default ActiveContactsService
diff --git a/packages/tom-server/src/active-contacts-api/tests/controllers.test.ts b/packages/tom-server/src/active-contacts-api/tests/controllers.test.ts
new file mode 100644
index 00000000..9dce895a
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/tests/controllers.test.ts
@@ -0,0 +1,138 @@
+/* eslint-disable @typescript-eslint/consistent-type-assertions */
+import bodyParser from 'body-parser'
+import express, { type NextFunction, type Response } from 'express'
+import supertest from 'supertest'
+import type { AuthRequest, Config, IdentityServerDb } from '../../types'
+import router, { PATH } from '../routes'
+import type { TwakeLogger } from '@twake/logger'
+
+const app = express()
+
+const dbMock = {
+ get: jest.fn(),
+ insert: jest.fn(),
+ update: jest.fn(),
+ deleteEqual: jest.fn(),
+ getCount: jest.fn()
+}
+
+const loggerMock = {
+ info: jest.fn(),
+ error: jest.fn(),
+ warn: jest.fn()
+}
+
+const authenticatorMock = jest
+ .fn()
+ .mockImplementation((_req, _res, callbackMethod) => {
+ callbackMethod('test', 'test')
+ })
+
+jest.mock('../middlewares/index.ts', () => {
+ const passiveMiddlewareMock = (
+ _req: AuthRequest,
+ _res: Response,
+ next: NextFunction
+ ): void => {
+ next()
+ }
+
+ return function () {
+ return {
+ checkCreationRequirements: passiveMiddlewareMock
+ }
+ }
+})
+
+app.use(bodyParser.json())
+app.use(bodyParser.urlencoded({ extended: true }))
+app.use(
+ router(
+ dbMock as unknown as IdentityServerDb,
+ {} as Config,
+ authenticatorMock,
+ loggerMock as unknown as TwakeLogger
+ )
+)
+
+describe('the active contacts API controller', () => {
+ describe('active contacts fetch', () => {
+ it('should try to fetch the saved active contacts', async () => {
+ dbMock.get.mockResolvedValue([
+ {
+ userId: 'test',
+ contacts: 'test'
+ }
+ ])
+
+ const response = await supertest(app).get(PATH).send()
+
+ expect(response.status).toBe(200)
+ expect(response.body).toEqual({ contacts: 'test' })
+ })
+
+ it('should return an error if no active contacts are found', async () => {
+ dbMock.get.mockResolvedValue([])
+
+ const response = await supertest(app).get(PATH).send()
+
+ expect(response.status).toBe(404)
+ expect(response.body).toEqual({ message: 'No active contacts found' })
+ })
+
+ it('should return an error if an error occurs while fetching active contacts', async () => {
+ dbMock.get.mockRejectedValue(new Error('test'))
+
+ const response = await supertest(app).get(PATH).send()
+
+ expect(response.status).toBe(500)
+ })
+ })
+
+ describe('active contacts save', () => {
+ it('should try to save active contacts', async () => {
+ dbMock.insert.mockResolvedValue([])
+
+ const response = await supertest(app)
+ .post(PATH)
+ .send({ contacts: 'test' })
+
+ expect(response.status).toBe(201)
+ })
+
+ it('should return an error if an error occurs while saving active contacts', async () => {
+ dbMock.insert.mockRejectedValue(new Error('test'))
+
+ const response = await supertest(app)
+ .post(PATH)
+ .send({ contacts: 'test' })
+
+ expect(response.status).toBe(500)
+ })
+
+ it('should return an error if the parameters are missing', async () => {
+ const response = await supertest(app).post(PATH).send({})
+
+ expect(response.status).toBe(400)
+ expect(response.body).toEqual({ message: 'Bad Request' })
+ })
+ })
+
+ describe('active contacts delete', () => {
+ it('should try to delete active contacts', async () => {
+ dbMock.deleteEqual.mockResolvedValue([])
+
+ const response = await supertest(app).delete(PATH).send()
+
+ expect(response.status).toBe(200)
+ })
+
+ it('should return an error if an error occurs while deleting active contacts', async () => {
+ dbMock.deleteEqual.mockRejectedValue(new Error('test'))
+
+ const response = await supertest(app).delete(PATH).send()
+
+ expect(response.status).toBe(500)
+ })
+ })
+})
diff --git a/packages/tom-server/src/active-contacts-api/tests/middlewares.test.ts b/packages/tom-server/src/active-contacts-api/tests/middlewares.test.ts
new file mode 100644
index 00000000..5cabfe17
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/tests/middlewares.test.ts
@@ -0,0 +1,52 @@
+import type { AuthRequest } from '../../types'
+import type { Response, NextFunction } from 'express'
+import ActiveContactsMiddleware from '../middlewares'
+
+describe('The active contacts API middleware', () => {
+ let mockRequest: Partial
+ let mockResponse: Partial
+ const nextFunction: NextFunction = jest.fn()
+
+ const activeContactsMiddleware = new ActiveContactsMiddleware()
+
+ beforeEach(() => {
+ mockRequest = {
+ body: {},
+ query: {},
+ userId: 'test'
+ }
+ mockResponse = {
+ json: jest.fn(),
+ status: jest.fn().mockReturnThis()
+ }
+ })
+
+ describe('the checkCreationRequirements middleware', () => {
+ it('should return a 400 error if data is missing', async () => {
+ mockRequest.body = {}
+
+ activeContactsMiddleware.checkCreationRequirements(
+ mockRequest as AuthRequest,
+ mockResponse as Response,
+ nextFunction
+ )
+
+ expect(mockResponse.status).toHaveBeenCalledWith(400)
+ expect(mockResponse.json).toHaveBeenCalledWith({
+ message: 'Bad Request'
+ })
+ })
+
+ it('should call the next handler if the requirements are met', async () => {
+ mockRequest.body = { contacts: 'test' }
+
+ activeContactsMiddleware.checkCreationRequirements(
+ mockRequest as AuthRequest,
+ mockResponse as Response,
+ nextFunction
+ )
+
+ expect(nextFunction).toHaveBeenCalledWith()
+ })
+ })
+})
diff --git a/packages/tom-server/src/active-contacts-api/tests/routes.test.ts b/packages/tom-server/src/active-contacts-api/tests/routes.test.ts
new file mode 100644
index 00000000..70d19dab
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/tests/routes.test.ts
@@ -0,0 +1,147 @@
+import express, { type Response, type NextFunction } from 'express'
+import bodyParser from 'body-parser'
+import type { AuthRequest, Config } from '../../types'
+import IdServer from '../../identity-server'
+import type { ConfigDescription } from '@twake/config-parser'
+import type { TwakeLogger } from '@twake/logger'
+import { IdentityServerDb, type MatrixDB } from '@twake/matrix-identity-server'
+import router, { PATH } from '../routes'
+import errorMiddleware from '../../utils/middlewares/error.middleware'
+import JEST_PROCESS_ROOT_PATH from '../../../jest.globals'
+import fs from 'fs'
+import path from 'path'
+import supertest from 'supertest'
+
+const mockLogger: Partial = {
+ debug: jest.fn(),
+ error: jest.fn(),
+ warn: jest.fn(),
+ close: jest.fn()
+}
+
+jest
+ .spyOn(IdentityServerDb.default.prototype, 'get')
+ .mockResolvedValue([{ data: '"test"' }])
+
+const idServer = new IdServer(
+ {
+ get: jest.fn()
+ } as unknown as MatrixDB,
+ {} as unknown as Config,
+ {
+ database_engine: 'sqlite',
+ database_host: 'test.db',
+ rate_limiting_window: 5000,
+ rate_limiting_nb_requests: 10,
+ template_dir: './templates',
+ userdb_host: './tokens.db'
+ } as unknown as ConfigDescription,
+ mockLogger as TwakeLogger
+)
+
+const app = express()
+const middlewareSpy = jest.fn().mockImplementation((_req, _res, next) => {
+ next()
+})
+
+jest.mock('../middlewares', () => {
+ return function () {
+ return {
+ checkCreationRequirements: middlewareSpy
+ }
+ }
+})
+
+jest.mock('../controllers', () => {
+ const passiveController = (
+ _req: AuthRequest,
+ res: Response,
+ _next: NextFunction
+ ): void => {
+ res.status(200).json({ message: 'test' })
+ }
+
+ return function () {
+ return {
+ get: passiveController,
+ save: passiveController,
+ delete: passiveController
+ }
+ }
+})
+
+app.use(bodyParser.json())
+app.use(bodyParser.urlencoded({ extended: true }))
+
+describe('The active contacts API router', () => {
+ beforeAll((done) => {
+ idServer.ready
+ .then(() => {
+ app.use(
+ router(
+ idServer.db,
+ idServer.conf,
+ idServer.authenticate,
+ idServer.logger
+ )
+ )
+
+ app.use(errorMiddleware(idServer.logger))
+ done()
+ })
+ .catch((e) => {
+ done(e)
+ })
+ })
+
+ afterAll(() => {
+ idServer.cleanJobs()
+
+ const pathFilesToDelete = [
+ path.join(JEST_PROCESS_ROOT_PATH, 'test.db'),
+ path.join(JEST_PROCESS_ROOT_PATH, 'tokens.db')
+ ]
+
+ pathFilesToDelete.forEach((path) => {
+ if (fs.existsSync(path)) fs.unlinkSync(path)
+ })
+ })
+
+ it('should reject if rate limit is exceeded', async () => {
+ let response
+
+ for (let i = 0; i < 11; i++) {
+ response = await supertest(app)
+ .get(PATH)
+ .set('Authorization', 'Bearer test')
+ }
+
+ expect((response as unknown as Response).status).toEqual(429)
+ await new Promise((resolve) => setTimeout(resolve, 6000))
+ })
+
+ it('should not call the validation middleware if the Bearer token is not set', async () => {
+ const response = await supertest(app).post(PATH).send({ contacts: 'test' })
+
+ expect(response.status).toEqual(401)
+ expect(middlewareSpy).not.toHaveBeenCalled()
+ })
+
+ it('should call the validation middleware if the Bearer token is set', async () => {
+ await supertest(app)
+ .post(PATH)
+ .set('Authorization', 'Bearer test')
+ .send({ contacts: 'test' })
+
+ expect(middlewareSpy).toHaveBeenCalled()
+ })
+
+ it('should call the validation middleware if the access_token is set in the query', async () => {
+ await supertest(app)
+ .post(PATH)
+ .query({ access_token: 'test' })
+ .send({ contact: 'test' })
+
+ expect(middlewareSpy).toHaveBeenCalled()
+ })
+})
diff --git a/packages/tom-server/src/active-contacts-api/tests/service.test.ts b/packages/tom-server/src/active-contacts-api/tests/service.test.ts
new file mode 100644
index 00000000..33741258
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/tests/service.test.ts
@@ -0,0 +1,96 @@
+import type { TwakeLogger } from '@twake/logger'
+import type { IdentityServerDb } from '../../types'
+import ActiveContactsService from '../services'
+
+describe('The active contacts service', () => {
+ const dbMock = {
+ get: jest.fn(),
+ insert: jest.fn(),
+ deleteEqual: jest.fn()
+ }
+
+ const loggerMock = {
+ info: jest.fn(),
+ error: jest.fn(),
+ warn: jest.fn()
+ }
+
+ const activeContactsService = new ActiveContactsService(
+ dbMock as unknown as IdentityServerDb,
+ loggerMock as unknown as TwakeLogger
+ )
+
+ it('should save active contacts for a user', async () => {
+ dbMock.insert.mockResolvedValue(undefined)
+
+ await expect(
+ activeContactsService.save('test', 'contact')
+ ).resolves.not.toThrow()
+
+ expect(dbMock.insert).toHaveBeenCalledWith('activeContacts', {
+ userId: 'test',
+ contacts: 'contact'
+ })
+ })
+
+ it('should fetch active contacts for a user', async () => {
+ dbMock.get.mockResolvedValue([{ userId: 'test', contacts: 'contact' }])
+
+ await expect(activeContactsService.get('test')).resolves.toEqual('contact')
+
+ expect(dbMock.get).toHaveBeenCalledWith('activeContacts', ['contacts'], {
+ userId: 'test'
+ })
+ })
+
+ it('should attempt to delete active contacts for a user', async () => {
+ dbMock.deleteEqual.mockResolvedValue(undefined)
+
+ await expect(activeContactsService.delete('test')).resolves.not.toThrow()
+
+ expect(dbMock.deleteEqual).toHaveBeenCalledWith(
+ 'activeContacts',
+ 'userId',
+ 'test'
+ )
+ })
+
+ it('should return null if no active contacts found for user', async () => {
+ dbMock.get.mockResolvedValue([])
+
+ await expect(activeContactsService.get('test')).resolves.toBeNull()
+ expect(loggerMock.warn).toHaveBeenCalledWith('No active contacts found')
+ })
+
+ it('should log and throw an error if there is an error fetching active contacts', async () => {
+ dbMock.get.mockRejectedValue(new Error('test'))
+
+ await expect(activeContactsService.get('test')).rejects.toThrow()
+ expect(loggerMock.error).toHaveBeenCalledWith(
+ 'Failed to get active contacts',
+ expect.anything()
+ )
+ })
+
+ it('should log and throw an error if something wrong happens while saving', async () => {
+ dbMock.insert.mockRejectedValue(new Error('test'))
+
+ await expect(
+ activeContactsService.save('test', 'contact')
+ ).rejects.toThrow()
+ expect(loggerMock.error).toHaveBeenCalledWith(
+ 'Failed to save active contacts',
+ expect.anything()
+ )
+ })
+
+ it('should log and throw an error if something wrong happens while deleting', async () => {
+ dbMock.deleteEqual.mockRejectedValue(new Error('test'))
+
+ await expect(activeContactsService.delete('test')).rejects.toThrow()
+ expect(loggerMock.error).toHaveBeenCalledWith(
+ 'Failed to delete saved active contacts',
+ expect.anything()
+ )
+ })
+})
diff --git a/packages/tom-server/src/active-contacts-api/types.ts b/packages/tom-server/src/active-contacts-api/types.ts
new file mode 100644
index 00000000..a7a19775
--- /dev/null
+++ b/packages/tom-server/src/active-contacts-api/types.ts
@@ -0,0 +1,26 @@
+import type { NextFunction, Response } from 'express'
+import type { AuthRequest } from '../types'
+
+export interface IActiveContactsApiController {
+ get: (req: AuthRequest, res: Response, next: NextFunction) => Promise
+ save: (req: AuthRequest, res: Response, next: NextFunction) => Promise
+ delete: (req: AuthRequest, res: Response, next: NextFunction) => Promise
+}
+
+export interface IActiveContactsApiValidationMiddleware {
+ checkCreationRequirements: (
+ req: AuthRequest,
+ res: Response,
+ next: NextFunction
+ ) => void
+}
+
+export interface IActiveContactsService {
+ get: (userId: string) => Promise
+ save: (userId: string, targetId: string) => Promise
+ delete: (userId: string) => Promise
+}
+
+export interface ActiveAcountsData {
+ contacts: string
+}
diff --git a/packages/tom-server/src/db/index.ts b/packages/tom-server/src/db/index.ts
index 6b29d4ca..44b60c8d 100644
--- a/packages/tom-server/src/db/index.ts
+++ b/packages/tom-server/src/db/index.ts
@@ -20,7 +20,8 @@ const initializeDb = (server: TwakeServer): Promise => {
roomTags:
'id varchar(64) PRIMARY KEY, authorId varchar(64), content text, roomId varchar(64)',
userQuotas: 'user_id varchar(64) PRIMARY KEY, size int',
- rooms: 'id varchar(64) PRIMARY KEY, filter varchar(64)'
+ rooms: 'id varchar(64) PRIMARY KEY, filter varchar(64)',
+ activeContacts: 'userId text PRIMARY KEY, contacts text'
},
{},
{},
diff --git a/packages/tom-server/src/index.ts b/packages/tom-server/src/index.ts
index e608d961..009bcd4a 100644
--- a/packages/tom-server/src/index.ts
+++ b/packages/tom-server/src/index.ts
@@ -21,6 +21,7 @@ import type { Config, ConfigurationFile, TwakeIdentityServer } from './types'
import userInfoAPIRouter from './user-info-api'
import VaultServer from './vault-api'
import WellKnown from './wellKnown'
+import ActiveContacts from './active-contacts-api'
export default class TwakeServer {
conf: Config
@@ -141,12 +142,20 @@ export default class TwakeServer {
this.logger
)
+ const activeContactsApi = ActiveContacts(
+ this.idServer.db,
+ this.conf,
+ this.idServer.authenticate,
+ this.logger
+ )
+
this.endpoints.use(privateNoteApi)
this.endpoints.use(mutualRoolsApi)
this.endpoints.use(vaultServer.endpoints)
this.endpoints.use(roomTagsApi)
this.endpoints.use(userInfoApi)
this.endpoints.use(smsApi)
+ this.endpoints.use(activeContactsApi)
if (
this.conf.opensearch_is_activated != null &&