diff sat/core/core_types.py @ 3911:8289ac1b34f4

plugin XEP-0384: Fully reworked to adjust to the reworked python-omemo: - support for both (modern) OMEMO under the `urn:xmpp:omemo:2` namespace and (legacy) OMEMO under the `eu.siacs.conversations.axolotl` namespace - maintains one identity across both versions of OMEMO - migrates data from the old plugin - includes more features for protocol stability - uses SCE for modern OMEMO - fully type-checked, linted and format-checked - added type hints to various pieces of backend code used by the plugin - added stubs for some Twisted APIs used by the plugin under stubs/ (use `export MYPYPATH=stubs/` before running mypy) - core (xmpp): enabled `send` trigger and made it an asyncPoint fix 375
author Syndace <me@syndace.dev>
date Tue, 23 Aug 2022 21:06:24 +0200
parents 722a38e78fd1
children 5a42c7842556
line wrap: on
line diff
--- a/sat/core/core_types.py	Thu Sep 22 12:03:12 2022 +0200
+++ b/sat/core/core_types.py	Tue Aug 23 21:06:24 2022 +0200
@@ -16,10 +16,47 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from collections import namedtuple
+from typing import Dict
+from typing_extensions import TypedDict
 from twisted.words.protocols.jabber import jid as t_jid
+from twisted.words.xish import domish
 
 
 class SatXMPPEntity:
 
     jid: t_jid.JID
     is_component: bool
+
+
+EncryptionPlugin = namedtuple("EncryptionPlugin", ("instance",
+                                                   "name",
+                                                   "namespace",
+                                                   "priority",
+                                                   "directed"))
+
+
+class EncryptionSession(TypedDict):
+    plugin: EncryptionPlugin
+
+
+# Incomplete types built through observation rather than code inspection.
+MessageDataExtra = TypedDict(
+    "MessageDataExtra",
+    { "encrypted": bool, "origin_id": str },
+    total=False
+)
+
+
+MessageData = TypedDict("MessageData", {
+    "from": t_jid.JID,
+    "to": t_jid.JID,
+    "uid": str,
+    "message": Dict[str, str],
+    "subject": Dict[str, str],
+    "type": str,
+    "timestamp": float,
+    "extra": MessageDataExtra,
+    "ENCRYPTION": EncryptionSession,
+    "xml": domish.Element
+}, total=False)