yapi-types 0.4.0

Serde types for pi's JSON formats: messages, events, session entries, settings, models and extension payloads.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! `auth.json`: stored credentials keyed by provider id.
//!
//! Mirrors `packages/ai/src/auth/types.ts` in pi `v1.0.0`.
#![allow(
    missing_docs,
    reason = "fields mirror pi's TypeScript types; contracts are noted where they differ from the name"
)]

use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};

/// The whole file: provider id to credential.
pub type AuthFile = IndexMap<String, Credential>;

/// A stored credential, tagged by `type`.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum Credential {
    #[serde(rename = "api_key")]
    ApiKey(ApiKeyCredential),
    #[serde(rename = "oauth")]
    OAuth(OAuthCredential),
}

/// Values may be literals, `$VAR` templates or `!command`s. See pi's
/// `resolve-config-value.ts`.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
pub struct ApiKeyCredential {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Extra environment for the provider, such as a region.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub env: Option<IndexMap<String, String>>,
}

/// OAuth tokens. Providers store additional fields, such as `accountId` or
/// `enterpriseUrl`, which are kept in `extra`.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct OAuthCredential {
    pub access: String,
    pub refresh: String,
    /// Expiry as Unix time in milliseconds: any finite number, as in pi.
    #[serde(serialize_with = "js_number")]
    pub expires: f64,
    #[serde(flatten)]
    pub extra: Map<String, Value>,
}

/// Serializes a number as [`crate::json::number`] does, so it equals the same
/// number parsed from a pi file.
fn js_number<S: serde::Serializer>(value: &f64, serializer: S) -> Result<S::Ok, S::Error> {
    crate::json::number(*value).serialize(serializer)
}

/// Request credentials a provider derives, as an extension's provider
/// returns them.
#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ModelAuth {
    #[serde(default)]
    pub api_key: Option<String>,
    /// `None` removes a header.
    #[serde(default)]
    pub headers: IndexMap<String, Option<String>>,
    #[serde(default)]
    pub base_url: Option<String>,
}

/// A provider's resolved API-key credentials, as an extension's provider
/// returns them.
#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
pub struct AuthResult {
    pub auth: ModelAuth,
    #[serde(default)]
    pub env: Option<IndexMap<String, String>>,
    #[serde(default)]
    pub source: Option<String>,
}