libervia-backend/libervia/backend/models/core.py
Goffi 93ce4112f8 plugin identity: Use Pydantic models:
Use Pydantic models for data used with bridge.
Also update `backend.models.core.DiscoIdentity` to have `None` as possible and default
value for `name`.
2026-08-14 14:53:46 +02:00

90 lines
2.4 KiB
Python

#!/usr/bin/env python3
# Libervia common models
# Copyright (C) 2009-2026 Jérôme Poisson (goffi@goffi.org)
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
# 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 pydantic import BaseModel, Field, RootModel
from .types import JIDType
class MessageData(dict):
pass
class HistoryLastOptions(BaseModel):
types: list[str] | None = None
since: float | None = None
limit: int | None = None
class HistoryPeerInfo(BaseModel):
timestamp: float
last_uid: str = ""
last_message: str = ""
class HistoryLastResult(BaseModel):
peers: dict[str, HistoryPeerInfo]
class MessageUpdateData(BaseModel):
type: str
def __init__(self, **kwargs):
if "type" not in kwargs:
kwargs["type"] = "reactions"
super().__init__(**kwargs)
class MessageReactionData(MessageUpdateData):
reactions: dict[str, list[str]] = Field(
description="Reaction to reacting entities mapping"
)
class MessageEdition(BaseModel):
"""Data used to send a message edition"""
message: dict[str, str]
subject: dict[str, str] = Field(default_factory=dict)
extra: dict[str, str] = Field(default_factory=dict)
class MessageDisplayState(BaseModel):
"""Display state for a single peer."""
count: int = Field(description="Unread message count")
last_uid: str | None = Field(description="Internal UID of the last displayed message")
class MessageDisplayStatesResult(RootModel[dict[JIDType, MessageDisplayState]]):
"""Mapping of peer bare JID to display state."""
root: dict[JIDType, MessageDisplayState] = Field(
description="Mapping of peer bare JID to display state"
)
class DiscoIdentity(BaseModel):
"""A single disco identity
Note that an XMPP entity may have several disco identities.
"""
name: str | None = None
category: str
type: str