tideway 0.7.17

A batteries-included Rust web framework built on Axum for building SaaS applications quickly
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

//! Membership storage trait.

use crate::error::Result;
use async_trait::async_trait;

/// Trait for membership storage operations.
///
/// The `Membership` and `Role` associated types are YOUR types.
/// This allows complete flexibility in how you structure memberships
/// and define roles/permissions.
///
/// # Example
///
/// ```rust,ignore
/// use tideway::organizations::MembershipStore;
/// use async_trait::async_trait;
///
/// struct MyStore { db: DatabaseConnection }
///
/// #[derive(Clone)]
/// struct MyMembership {
///     org_id: String,
///     user_id: String,
///     role: MyRole,
///     title: Option<String>,  // Custom field
///     joined_at: u64,
/// }
///
/// #[derive(Clone, PartialEq)]
/// enum MyRole {
///     Owner,
///     Admin,
///     Developer,
///     Viewer,
/// }
///
/// #[async_trait]
/// impl MembershipStore for MyStore {
///     type Membership = MyMembership;
///     type Role = MyRole;
///
///     async fn add_member(&self, membership: &Self::Membership) -> Result<()> {
///         self.db.insert_membership(membership).await?;
///         Ok(())
///     }
///
///     fn membership_role(&self, m: &Self::Membership) -> Self::Role {
///         m.role.clone()
///     }
///
///     // Define your permission hierarchy
///     fn can_manage_members(&self, role: &Self::Role) -> bool {
///         matches!(role, MyRole::Owner | MyRole::Admin)
///     }
///
///     // ... implement other methods
/// }
/// ```
#[async_trait]
pub trait MembershipStore: Send + Sync {
    /// Your membership type (user-org-role association).
    type Membership: Send + Sync + Clone;

    /// Your role type (enum or string-based).
    type Role: Send + Sync + Clone + PartialEq;

    // === Required storage methods ===

    /// Add a new member to an organization.
    async fn add_member(&self, membership: &Self::Membership) -> Result<()>;

    /// Remove a member from an organization.
    async fn remove_member(&self, org_id: &str, user_id: &str) -> Result<()>;

    /// Get a specific membership.
    async fn get_membership(&self, org_id: &str, user_id: &str)
    -> Result<Option<Self::Membership>>;

    /// List all members of an organization.
    async fn list_members(&self, org_id: &str) -> Result<Vec<Self::Membership>>;

    /// Update an existing membership.
    async fn update_membership(&self, membership: &Self::Membership) -> Result<()>;

    // === Required accessor methods ===

    /// Get the user ID from a membership.
    fn membership_user_id(&self, m: &Self::Membership) -> String;

    /// Get the organization ID from a membership.
    fn membership_org_id(&self, m: &Self::Membership) -> String;

    /// Get the role from a membership.
    fn membership_role(&self, m: &Self::Membership) -> Self::Role;

    // === Required role permission methods (users define their hierarchy) ===

    /// Check if role can manage members (invite, remove, change roles).
    fn can_manage_members(&self, role: &Self::Role) -> bool;

    /// Check if role can manage organization settings.
    fn can_manage_settings(&self, role: &Self::Role) -> bool;

    /// Check if role can delete the organization.
    fn can_delete_org(&self, role: &Self::Role) -> bool;

    /// Check if role can transfer ownership.
    fn can_transfer_ownership(&self, role: &Self::Role) -> bool;

    /// Check if this role is the owner role.
    fn is_owner(&self, role: &Self::Role) -> bool;

    // === Required query methods ===

    /// List all memberships for a user across all organizations.
    ///
    /// Returns all organizations the user is a member of.
    async fn list_user_memberships(&self, user_id: &str) -> Result<Vec<Self::Membership>>;

    // === Optional methods with defaults ===

    /// Count members in an organization.
    async fn count_members(&self, org_id: &str) -> Result<u32> {
        Ok(self.list_members(org_id).await?.len() as u32)
    }

    /// Check if a user is a member of an organization.
    async fn is_member(&self, org_id: &str, user_id: &str) -> Result<bool> {
        Ok(self.get_membership(org_id, user_id).await?.is_some())
    }

    /// Update multiple memberships atomically.
    ///
    /// Used for operations like ownership transfer where multiple membership
    /// updates must succeed or fail together.
    ///
    /// # Default Implementation
    ///
    /// The default implementation updates memberships sequentially and is
    /// **not atomic**. Database implementations should override this to use
    /// transactions.
    ///
    /// # Example Override (SeaORM)
    ///
    /// ```rust,ignore
    /// async fn update_memberships_atomic(&self, memberships: &[Self::Membership]) -> Result<()> {
    ///     let txn = self.db.begin().await?;
    ///     for m in memberships {
    ///         // update using txn...
    ///     }
    ///     txn.commit().await?;
    ///     Ok(())
    /// }
    /// ```
    async fn update_memberships_atomic(&self, memberships: &[Self::Membership]) -> Result<()> {
        for m in memberships {
            self.update_membership(m).await?;
        }
        Ok(())
    }
}