openfga-client 0.6.0

Type-safe client SDK for OpenFGA with optional Authorization Model management and Authentication (Bearer or Client Credentials).
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

use std::sync::Arc;

use tonic::codegen::StdError;

use crate::generated::ReadRequestTupleKey;

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Debug, thiserror::Error, Clone)]
pub enum Error {
    #[error("Multiple stores with the name `{0}` found")]
    AmbiguousStoreName(String),
    #[error("Request to OpenFGA failed with status: {0}")]
    RequestFailed(Box<tonic::Status>),
    #[error(
        "Too many pages returned for read request tuple key {}. Max pages: {max_pages}",
        tuple.as_ref().map_or_else(|| "<No tuple key provided>".to_string(), |t| format!("{t}"))
    )]
    TooManyPages {
        max_pages: u32,
        tuple: Option<ReadRequestTupleKey>,
    },
    #[error("Invalid Endpoint: `{0}`")]
    InvalidEndpoint(String),
    #[error("Invalid Token: {reason}")]
    InvalidToken { reason: String },
    #[cfg(feature = "auth-middle")]
    #[error("Failed to fetch or refresh Client Credentials: {0}")]
    CredentialRefreshError(#[source] middle::Error),
    #[error(
        "Invalid OpenFGA Model Version: `{0}`. Model Versions must have the format `major.minor`"
    )]
    InvalidModelVersion(String),
    #[error("Migration Hook for model version {version} failed: {error}")]
    MigrationHookFailed {
        version: String,
        error: Arc<StdError>,
    },
    #[error("Missing authorization model id for model prefix `{model_prefix}` version `{version}`")]
    MissingAuthorizationModelId {
        model_prefix: String,
        version: String,
    },
    #[error("Store with Name `{0}` not found")]
    StoreNotFound(String),
    #[error(
        "Multiple authorization models with model prefix `{model_prefix}` for version `{version}` found."
    )]
    AmbiguousModelVersion {
        model_prefix: String,
        version: String,
    },
    #[error(
        "Too many writes and deletes in single OpenFGA transaction (actual) {actual} > {max} (max)"
    )]
    TooManyWrites { actual: i32, max: i32 },
    /// Protobuf `oneof` fields are always wrapped in an `Option` by `prost` ([ref]).
    /// `ExpectedOneof` is raised if OpenFGA is expected to return one of the variants
    /// (i.e. `Some(T)`) but instead `None` was received.
    ///
    /// [ref]: https://github.com/tokio-rs/prost?tab=readme-ov-file#oneof-fields
    #[error("Expected Oneof variant but got None")]
    ExpectedOneof,
    #[error("TLS configuration failed for endpoint `{endpoint}`: {reason}")]
    TlsConfigurationFailed { endpoint: String, reason: String },
}

impl Error {
    // pub fn internal(
    //     reason: impl Into<String>,
    //     error: impl Into<Box<dyn std::error::Error + Send + Sync>>,
    // ) -> Self {
    //     Self::InternalError {
    //         reason: reason.into(),
    //         source: error.into(),
    //     }
    // }
}