(chore): Add SCIDUserHelper and expand user types

Author: N3v1

ScribbleLab.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -0,0 +1,87 @@
+//
+//  SCIDUserHelper.swift
+//  ScribbleLab
+//
+//  Copyright (c) 2024 ScribbleLabApp LLC. - All rights reserved.
+//
+//  Redistribution and use in source and binary forms, with or without
+//  modification, are permitted provided that the following conditions are met:
+//
+//  1. Redistributions of source code must retain the above copyright notice, this
+//     list of conditions and the following disclaimer.
+//
+//  2. Redistributions in binary form must reproduce the above copyright notice,
+//     this list of conditions and the following disclaimer in the documentation
+//     and/or other materials provided with the distribution.
+//
+//  3. Neither the name of the copyright holder nor the names of its
+//     contributors may be used to endorse or promote products derived from
+//     this software without specific prior written permission.
+//
+//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+//  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+//  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+//  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+//  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+//  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import Foundation
+import ScribbleFoundation
+
+internal class SCIDUserHelper {
+    
+    /// Calculates the age based on the birth date.
+    ///
+    /// - Parameter birthDate: The birth date of the user.
+    /// - Returns: The age of the user in years, or `nil` if the birth date is not valid.
+    static func calculateAge(birthDate: Date?) -> Int? {
+        guard let birthDate = birthDate else { return nil }
+        
+        let calendar = Calendar.current
+        let components = calendar.dateComponents([.year], from: birthDate, to: Date())
+        
+        return components.year
+    }
+    
+    /// Calculates the remaining duration until the trial period ends.
+    ///
+    /// - Parameter trialEndDate: The end date of the trial period.
+    /// - Returns: A string representing the remaining duration (e.g., "2 days", "1 month"), or
+    ///            `nil` if the trial end date is not valid.
+    static func trialDurationUntilEnd(trialEndDate: Date?) -> String? {
+        guard let trialEndDate = trialEndDate else { return nil }
+        
+        let calendar = Calendar.current
+        let currentDate = Date()
+        
+        if trialEndDate < currentDate {
+            return "Trial period has ended"
+        }
+        
+        let components = calendar.dateComponents(
+            [.day, .hour, .minute],
+            from: currentDate,
+            to: trialEndDate
+        )
+        
+        var durationStr = ""
+        
+        if let days = components.day, days > 0 {
+            durationStr += "\(days) day\(days > 1 ? "s" : "")"
+        }
+        
+        if let hours = components.hour, hours > 0 {
+            durationStr += (durationStr.isEmpty ? "" : ", ") + "\(hours) hour\(hours > 1 ? "s" : "")"
+        }
+        
+        if let minutes = components.minute, minutes > 0 {
+            durationStr += (durationStr.isEmpty ? "" : ", ") + "\(minutes) minute\(minutes > 1 ? "s" : "")"
+        }
+        
+        return durationStr.isEmpty ? "Trial Period ends soon" : durationStr
+    }
+}

ScribbleLab/Misc/SCIDUserHelper.swift

@@ -65,7 +65,27 @@ struct SLUser: Identifiable, Hashable, Codable {
     /// The user’s email address.
     ///
     /// This is a unique, immutable property for each user, used for authentication and notifications.
-    let email: String
+    var email: String
+    
+    /// The user’s birthdate, if provided.
+    ///
+    /// This may be used for age-restricted content or features in the application.
+    var birthDate: Date?
+    
+    /// The user’s role within the application.
+    ///
+    /// This defines access levels or permissions and can be extended as necessary.
+    var usrRole: SCIDUserRole
+    
+    /// The date when the user’s trial period ends, if applicable.
+    ///
+    /// - Note: If the user has a premium subscription, this value may be `nil`.
+    var trialPeriodEndDate: Date?
+    
+    /// A Boolean indicating whether the user has a premium subscription.
+    ///
+    /// Premium users may have access to additional features within the application.
+    var hasPremium: Bool
 
     /// A computed property that indicates whether this `SLUser` instance represents the current authenticated user.
     ///
@@ -77,3 +97,14 @@ struct SLUser: Identifiable, Hashable, Codable {
         return currentUid == id
     }
 }
+
+/// Enumeration of user roles in the application.
+///
+/// - intern: A user with intern-level access.
+/// - developer: A user with developer-level access.
+/// - none: A default role with basic access.
+enum SCIDUserRole: String, Codable {
+    case intern
+    case developer
+    case none
+}

ScribbleLab/Misc/User.swift

@@ -169,19 +169,28 @@ class SCIDAuthService: Authenticatable {
     ///   - uid: The unique identifier for the user.
     ///   - username: The username associated with the user.
     ///   - email: The email address associated with the user.
+    ///   - usrRole: The role of the user (intern, developer, etc.).
+    ///   - hasPremium: A Boolean indicating whether the user has a premium account.
     ///
     /// - Note: This function sets the current user with the provided details and uploads it to Firestore.
     ///         It is a private function and should be called from within the `SLAuthService`.
     ///
     /// > WARNING
-    /// > This function is called internally by the `SLAuthService` and should not typically be accessed directly.
-    ///
+    /// > This function is called internally by the `SCIDAuthService` and should not typically be accessed directly.
     func uploadUserData(
         uid: String,
         username: String,
-        email: String
+        email: String,
+        usrRole: SCIDUserRole = .none,
+        hasPremium: Bool = false
     ) async {
-        let user = SLUser(id: uid, username: username, email: email)
+        let user = SLUser(
+            id: uid,
+            username: username,
+            email: email,
+            usrRole: usrRole,
+            hasPremium: hasPremium
+        )
         self.currentUser = user
 
         do {

ScribbleLab/Services/SCIDAuthentication/SCIDAuthService.swift

@@ -50,34 +50,59 @@ struct SCIDUserService {
 
         let profileImageUrl = data["profileImageUrl"] as? String
         let fullname = data["fullname"] as? String
+        let birthDate = (data["birthDate"] as? Timestamp)?.dateValue()
+        let usrRoleString = data["usrRole"] as? String
+        let usrRole = SCIDUserRole(rawValue: usrRoleString ?? "") ?? .none
+        let trialPeriodEndDate = (data["trialPeriodEndDate"] as? Timestamp)?.dateValue()
+        let hasPremium = data["hasPremium"] as? Bool ?? false
 
         return SLUser(
             id: id,
             username: username,
             profileImageUrl: profileImageUrl,
             fullname: fullname,
-            email: email
+            email: email,
+            birthDate: birthDate,
+            usrRole: usrRole,
+            trialPeriodEndDate: trialPeriodEndDate,
+            hasPremium: hasPremium
         )
     }
 
     static func fetchAllUsers() async throws -> [SLUser] {
         let snapshot = try await Firestore.firestore().collection("users").getDocuments()
 
-        return snapshot.documents.compactMap { document in
+        return try snapshot.documents.compactMap { document in
             let data = document.data()
             guard let id = data["id"] as? String,
                   let username = data["username"] as? String,
-                  let email = data["email"] as? String else { return nil }
+                  let email = data["email"] as? String else {
+               
+                throw NSError(
+                    domain: "SCIDUserService",
+                    code: -202,
+                    userInfo: [NSLocalizedDescriptionKey: "Missing required user fields - SLUSR-E202"]
+                )
+            }
 
             let profileImageUrl = data["profileImageUrl"] as? String
             let fullname = data["fullname"] as? String
+            let birthDate = (data["birthDate"] as? Timestamp)?.dateValue()
+            let usrRoleString = data["usrRole"] as? String
+            let usrRole = SCIDUserRole(rawValue: usrRoleString ?? "") ?? .none
+            let trialPeriodEndDate = (data["trialPeriodEndDate"] as? Timestamp)?.dateValue()
+            let hasPremium = data["hasPremium"] as? Bool ?? false
 
             return SLUser(
                 id: id,
                 username: username,
                 profileImageUrl: profileImageUrl,
                 fullname: fullname,
-                email: email
+                email: email,
+                birthDate: birthDate,
+                usrRole: usrRole,
+                trialPeriodEndDate: trialPeriodEndDate,
+                hasPremium: hasPremium
             )
         }
     }