matrix-sdk 0.16.0

// Copyright 2023 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::marker::PhantomData;

use ruma::{
    events::{AnyStateEvent, AnyTimelineEvent, AnyToDeviceEvent},
    serde::Raw,
};
use serde::{Deserialize, Serialize, de::DeserializeOwned};
use serde_json::value::RawValue as RawJsonValue;
use tracing::error;

use super::{Action, ToWidgetRequestMeta, WidgetMachine, openid::OpenIdResponse};
use crate::widget::Capabilities;

/// A handle to a pending `toWidget` request.
pub(crate) struct ToWidgetRequestHandle<'m, T> {
    request_meta: &'m mut ToWidgetRequestMeta,
    _phantom: PhantomData<fn() -> T>,
}

impl<'m, T> ToWidgetRequestHandle<'m, T>
where
    T: DeserializeOwned,
{
    pub(crate) fn new(request_meta: &'m mut ToWidgetRequestMeta) -> Self {
        Self { request_meta, _phantom: PhantomData }
    }

    pub(crate) fn add_response_handler(
        self,
        response_handler: impl FnOnce(T, &mut WidgetMachine) -> Vec<Action> + Send + 'static,
    ) {
        self.request_meta.response_fn = Some(Box::new(move |raw_response_data, machine| {
            match serde_json::from_str(raw_response_data.get()) {
                Ok(response_data) => response_handler(response_data, machine),
                Err(e) => {
                    error!("Failed to deserialize toWidget response: {e}");
                    Vec::new()
                }
            }
        }));
    }
}

#[derive(Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub(super) struct ToWidgetResponse {
    /// The action from the original request.
    pub(super) action: String,

    /// The data from the original request.
    #[allow(dead_code)]
    #[serde(rename = "data")]
    pub(super) request_data: Box<RawJsonValue>,

    /// The response data.
    #[serde(rename = "response")]
    pub(super) response_data: Box<RawJsonValue>,
}

/// A request that the driver can send to the widget.
///
/// In postmessage interface terms: an `"api": "toWidget"` message.
pub(crate) trait ToWidgetRequest: Serialize {
    const ACTION: &'static str;
    type ResponseData: DeserializeOwned;
}

/// Request the widget to send the list of capabilities that it wants to have.
#[derive(Serialize)]
pub(super) struct RequestCapabilities {}

impl ToWidgetRequest for RequestCapabilities {
    const ACTION: &'static str = "capabilities";
    type ResponseData = RequestCapabilitiesResponse;
}

#[derive(Deserialize)]
pub(super) struct RequestCapabilitiesResponse {
    pub(super) capabilities: Capabilities,
}

/// Notify the widget that the list of the granted capabilities has changed.
#[derive(Serialize)]
pub(super) struct NotifyCapabilitiesChanged {
    pub(super) requested: Capabilities,
    pub(super) approved: Capabilities,
}

impl ToWidgetRequest for NotifyCapabilitiesChanged {
    const ACTION: &'static str = "notify_capabilities";
    type ResponseData = Empty;
}

/// Notify the widget that the OpenID credentials changed.
#[derive(Serialize)]
pub(crate) struct NotifyOpenIdChanged(pub(crate) OpenIdResponse);

impl ToWidgetRequest for NotifyOpenIdChanged {
    const ACTION: &'static str = "openid_credentials";
    type ResponseData = OpenIdResponse;
}

/// Notify the widget that we received a new Matrix event.
/// This is a "response" to the widget subscribing to the events in the room.
#[derive(Serialize)]
#[serde(transparent)]
pub(crate) struct NotifyNewMatrixEvent(pub(crate) Raw<AnyTimelineEvent>);

impl ToWidgetRequest for NotifyNewMatrixEvent {
    const ACTION: &'static str = "send_event";
    type ResponseData = Empty;
}

/// Notify the widget that room state has changed.
/// This is a "response" to the widget subscribing to the events in the room.
#[derive(Serialize)]
pub(crate) struct NotifyStateUpdate {
    pub(super) state: Vec<Raw<AnyStateEvent>>,
}

impl ToWidgetRequest for NotifyStateUpdate {
    const ACTION: &'static str = "update_state";
    type ResponseData = Empty;
}

#[derive(Deserialize)]
pub(crate) struct Empty {}

/// Notify the widget that we received a new Matrix to-device message.
/// This is a "response" to the widget subscribing to the to-device messages.
#[derive(Serialize)]
#[serde(transparent)]
pub(crate) struct NotifyNewToDeviceMessage(pub(crate) Raw<AnyToDeviceEvent>);

impl ToWidgetRequest for NotifyNewToDeviceMessage {
    const ACTION: &'static str = "send_to_device";
    type ResponseData = Empty;
}