ayb 0.1.12

ayb makes it easy to create, host, and share embedded databases like SQLite and DuckDB
Documentation
use crate::error::AybError;
use crate::{from_str, try_from_i16};
use clap::ValueEnum;
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use sqlx::FromRow;
use std::str::FromStr;

#[derive(
    Serialize_repr, Deserialize_repr, Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum,
)]
#[repr(i16)]
pub enum DBType {
    Sqlite = 0,
    Duckdb = 1,
}

from_str!(DBType, {
    "sqlite" => DBType::Sqlite,
    "duckdb" => DBType::Duckdb
});

try_from_i16!(DBType, {
    0 => DBType::Sqlite,
    1 => DBType::Duckdb
});

impl DBType {
    pub fn to_str(&self) -> &str {
        match self {
            DBType::Sqlite => "sqlite",
            DBType::Duckdb => "duckdb",
        }
    }
}

#[derive(
    Serialize_repr, Deserialize_repr, Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum,
)]
#[repr(i16)]
pub enum EntityType {
    User = 0,
    Organization = 1,
}

from_str!(EntityType, {
    "user" => EntityType::User,
    "organization" => EntityType::Organization
});

try_from_i16!(EntityType, {
    0 => EntityType::User,
    1 => EntityType::Organization
});

impl EntityType {
    pub fn to_str(&self) -> &str {
        match self {
            EntityType::User => "user",
            EntityType::Organization => "organization",
        }
    }
}

#[derive(
    Serialize_repr, Deserialize_repr, Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum,
)]
#[repr(i16)]
pub enum AuthenticationMethodType {
    Email = 0,
}

from_str!(AuthenticationMethodType, {
    "email" => AuthenticationMethodType::Email
});

try_from_i16!(AuthenticationMethodType, {
    0 => AuthenticationMethodType::Email
});

impl AuthenticationMethodType {
    pub fn to_str(&self) -> &str {
        match self {
            AuthenticationMethodType::Email => "email",
        }
    }
}

#[derive(
    Serialize_repr, Deserialize_repr, Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum,
)]
#[repr(i16)]
pub enum AuthenticationMethodStatus {
    Verified = 0,
    Revoked = 1,
}

from_str!(AuthenticationMethodStatus, {
    "verified" => AuthenticationMethodStatus::Verified,
    "revoked" => AuthenticationMethodStatus::Revoked
});

try_from_i16!(AuthenticationMethodStatus, {
    0 => AuthenticationMethodStatus::Verified,
    1 => AuthenticationMethodStatus::Revoked
});

impl AuthenticationMethodStatus {
    pub fn to_str(&self) -> &str {
        match self {
            AuthenticationMethodStatus::Verified => "verified",
            AuthenticationMethodStatus::Revoked => "revoked",
        }
    }
}

#[derive(
    Serialize_repr, Deserialize_repr, Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum,
)]
#[repr(i16)]
pub enum PublicSharingLevel {
    NoAccess = 0,
    Fork = 1,
    ReadOnly = 2,
}

from_str!(PublicSharingLevel, {
    "no-access" => PublicSharingLevel::NoAccess,
    "fork" => PublicSharingLevel::Fork,
    "read-only" => PublicSharingLevel::ReadOnly
});

try_from_i16!(PublicSharingLevel, {
    0 => PublicSharingLevel::NoAccess,
    1 => PublicSharingLevel::Fork,
    2 => PublicSharingLevel::ReadOnly
});

impl PublicSharingLevel {
    pub fn to_str(&self) -> &str {
        match self {
            PublicSharingLevel::NoAccess => "no-access",
            PublicSharingLevel::Fork => "fork",
            PublicSharingLevel::ReadOnly => "read-only",
        }
    }
}

#[derive(Debug, Serialize, Deserialize)]
pub struct Database {
    pub entity_id: i32,
    pub slug: String,
    pub db_type: i16,
    pub public_sharing_level: i16,
}

#[derive(Debug, FromRow, Serialize, Deserialize)]
pub struct InstantiatedDatabase {
    pub id: i32,
    pub entity_id: i32,
    pub slug: String,
    pub db_type: i16,
    pub public_sharing_level: i16,
}

/// Represents properties of a database that can be updated.
#[derive(Debug, PartialEq, Default)]
pub struct PartialDatabase {
    pub public_sharing_level: Option<i16>,
}

impl PartialDatabase {
    // By default, all fields on PartialDatabase are `None`. If at
    // least one is `Some`, the database is eligible for an update.
    pub fn has_updates(&self) -> bool {
        *self != Self::default()
    }
}

#[derive(Debug, Serialize, Deserialize)]
pub struct Entity {
    pub slug: String,
    pub entity_type: i16,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub organization: Option<String>,
    pub location: Option<String>,
    pub links: Option<Vec<Link>>,
}

/// The fields of this struct mean the following:
/// * `None` means that nothing should be changed
/// * `Some(None)` means that the value should be set to `NULL`
/// * `Some(Some(v))` means that the value should be set to `v`
#[derive(Debug, PartialEq)]
pub struct PartialEntity {
    pub display_name: Option<Option<String>>,
    pub description: Option<Option<String>>,
    pub organization: Option<Option<String>>,
    pub location: Option<Option<String>>,
    pub links: Option<Option<Vec<Link>>>,
}

impl Default for PartialEntity {
    fn default() -> Self {
        Self::new()
    }
}

impl PartialEntity {
    pub fn new() -> Self {
        Self {
            display_name: None,
            description: None,
            organization: None,
            location: None,
            links: None,
        }
    }

    pub fn has_updates(&self) -> bool {
        // By default, all fields on PartialEntity are `None`. If at
        // least one is `Some`, the entity is eligible for an update.
        *self != Self::default()
    }
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
pub struct Link {
    pub url: String,
    pub verified: bool,
}

#[derive(Clone, Debug, FromRow, Serialize, Deserialize)]
pub struct InstantiatedEntity {
    pub id: i32,
    pub slug: String,
    pub entity_type: i16,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub organization: Option<String>,
    pub location: Option<String>,
    pub links: Option<sqlx::types::Json<Vec<Link>>>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct AuthenticationMethod {
    pub entity_id: i32,
    pub method_type: i16,
    pub status: i16,
    pub email_address: String,
}

#[derive(Debug, FromRow, Serialize, Deserialize)]
pub struct InstantiatedAuthenticationMethod {
    pub id: i32,
    pub entity_id: i32,
    pub method_type: i16,
    pub status: i16,
    pub email_address: String,
}

/// Full API token row from database, including sensitive fields (hash).
/// Used for token creation and validation where the hash is needed.
#[derive(Debug, FromRow, Serialize, Deserialize, Clone)]
pub struct APIToken {
    pub entity_id: i32,
    pub short_token: String,
    pub hash: String,
    // Scoped token fields
    pub database_id: Option<i32>,
    pub query_permission_level: Option<i16>,
    pub app_name: Option<String>,
    pub created_at: Option<chrono::NaiveDateTime>,
    pub expires_at: Option<chrono::NaiveDateTime>,
    pub revoked_at: Option<chrono::NaiveDateTime>,
}

/// Query result for listing tokens with JOINed database/entity slugs.
/// Used for list_api_tokens where we need human-readable names but not the hash.
#[derive(Debug, FromRow, Serialize, Deserialize)]
pub struct APITokenWithDatabase {
    pub short_token: String,
    pub database_id: Option<i32>,
    pub database_slug: Option<String>,
    pub entity_slug: Option<String>,
    pub query_permission_level: Option<i16>,
    pub app_name: Option<String>,
    pub created_at: Option<chrono::NaiveDateTime>,
    pub expires_at: Option<chrono::NaiveDateTime>,
    pub revoked_at: Option<chrono::NaiveDateTime>,
}

#[derive(
    Serialize_repr, Deserialize_repr, Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, ValueEnum,
)]
#[repr(i16)]
pub enum EntityDatabaseSharingLevel {
    NoAccess = 0,
    ReadOnly = 1,
    ReadWrite = 2,
    Manager = 3,
}

from_str!(EntityDatabaseSharingLevel, {
    "no-access" => EntityDatabaseSharingLevel::NoAccess,
    "read-only" => EntityDatabaseSharingLevel::ReadOnly,
    "read-write" => EntityDatabaseSharingLevel::ReadWrite,
    "manager" => EntityDatabaseSharingLevel::Manager
});

try_from_i16!(EntityDatabaseSharingLevel, {
    0 => EntityDatabaseSharingLevel::NoAccess,
    1 => EntityDatabaseSharingLevel::ReadOnly,
    2 => EntityDatabaseSharingLevel::ReadWrite,
    3 => EntityDatabaseSharingLevel::Manager
});

impl EntityDatabaseSharingLevel {
    pub fn to_str(&self) -> &str {
        match self {
            EntityDatabaseSharingLevel::NoAccess => "no-access",
            EntityDatabaseSharingLevel::ReadOnly => "read-only",
            EntityDatabaseSharingLevel::ReadWrite => "read-write",
            EntityDatabaseSharingLevel::Manager => "manager",
        }
    }
}

#[derive(Debug, FromRow, Serialize, Deserialize)]
pub struct EntityDatabasePermission {
    pub entity_id: i32,
    pub database_id: i32,
    pub sharing_level: i16,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct DatabasePermission {
    pub entity_slug: String,
    pub sharing_level: String,
}

/// OAuth authorization request for pending authorization codes.
/// Used in the OAuth-like flow for third-party apps to get scoped tokens.
#[derive(Debug, FromRow, Serialize, Deserialize)]
pub struct OAuthAuthorizationRequest {
    pub code: String,
    pub entity_id: i32,
    pub code_challenge: String,
    pub redirect_uri: String,
    pub app_name: String,
    pub requested_query_permission_level: i16,
    pub state: Option<String>,
    pub database_id: i32,
    pub query_permission_level: i16,
    pub created_at: chrono::NaiveDateTime,
    pub expires_at: chrono::NaiveDateTime,
    pub used_at: Option<chrono::NaiveDateTime>,
}

/// OAuth authorization request enriched with JOINed database and entity slugs.
#[derive(Debug, FromRow, Serialize, Deserialize)]
pub struct OAuthAuthorizationRequestWithDatabase {
    pub code: String,
    pub entity_id: i32,
    pub code_challenge: String,
    pub redirect_uri: String,
    pub app_name: String,
    pub requested_query_permission_level: i16,
    pub state: Option<String>,
    pub database_id: i32,
    pub query_permission_level: i16,
    pub created_at: chrono::NaiveDateTime,
    pub expires_at: chrono::NaiveDateTime,
    pub used_at: Option<chrono::NaiveDateTime>,
    pub database_slug: String,
    pub entity_slug: String,
}

/// Input struct for creating a new OAuth authorization request.
#[derive(Debug, Serialize, Deserialize)]
pub struct NewOAuthAuthorizationRequest {
    pub code: String,
    pub entity_id: i32,
    pub code_challenge: String,
    pub redirect_uri: String,
    pub app_name: String,
    pub requested_query_permission_level: i16,
    pub state: Option<String>,
    pub database_id: i32,
    pub query_permission_level: i16,
    pub expires_at: chrono::NaiveDateTime,
}