Use prefixed UUIDs for Users and Places

Author: RemiBardon

Package.resolved

@@ -6,8 +6,17 @@
         "repositoryURL": "https://github.com/MonkiProjects/monki-projects-model-swift",
         "state": {
           "branch": null,
-          "revision": "b6557a9e8d4bf6ed6dadc239759d567985a75370",
-          "version": "0.4.0"
+          "revision": "63e0b3c912886d8c7555efd15f9f72d1860e696d",
+          "version": "0.5.0"
+        }
+      },
+      {
+        "package": "swift-prefixed-uuid",
+        "repositoryURL": "https://github.com/RemiBardon/swift-prefixed-uuid",
+        "state": {
+          "branch": null,
+          "revision": "93e21694b11da9d9ff691f1cda7ac7d4c4bc361a",
+          "version": "1.0.2"
         }
       }
     ]

Package.swift

@@ -19,7 +19,7 @@ let package = Package(
 		.package(
 			name: "monki-projects-model",
 			url: "https://github.com/MonkiProjects/monki-projects-model-swift",
-			.upToNextMajor(from: "0.4.0")
+			.upToNextMinor(from: "0.5.0")
 		),
 	],
 	targets: [

Sources/MonkiProjectsAPIClient/MPAPIUserRepository.swift

@@ -36,15 +36,15 @@ public final class MPAPIUserRepository: WebAPI, WebUserRepository {
 		return self.authenticatedRequest(endpoints.createUser(), body: create)
 	}
 
-	public func getUser(_ userId: UUID) -> AnyPublisher<User.Public.Full, Error> {
+	public func getUser(_ userId: User.ID) -> AnyPublisher<User.Public.Full, Error> {
 		return self.authenticatedRequest(endpoints.getUser(userId))
 	}
 
-	public func updateUser(_ userId: UUID, with update: User.Update) -> AnyPublisher<User.Public.Full, Error> {
+	public func updateUser(_ userId: User.ID, with update: User.Update) -> AnyPublisher<User.Public.Full, Error> {
 		return self.authenticatedRequest(endpoints.updateUser(userId), body: update)
 	}
 
-	public func deleteUser(_ userId: UUID) -> AnyPublisher<Void, Error> {
+	public func deleteUser(_ userId: User.ID) -> AnyPublisher<Void, Error> {
 		return self.authenticatedRequest(endpoints.deleteUser(userId))
 	}
 
@@ -61,17 +61,17 @@ public final class MPAPIUserRepository: WebAPI, WebUserRepository {
 	}
 
 	@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
-	public func getUser(_ userId: UUID) async throws -> User.Public.Full {
+	public func getUser(_ userId: User.ID) async throws -> User.Public.Full {
 		return try await self.authenticatedRequest(endpoints.getUser(userId))
 	}
 
 	@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
-	public func updateUser(_ userId: UUID, with update: User.Update) async throws -> User.Public.Full {
+	public func updateUser(_ userId: User.ID, with update: User.Update) async throws -> User.Public.Full {
 		return try await self.authenticatedRequest(endpoints.updateUser(userId), body: update)
 	}
 
 	@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
-	public func deleteUser(_ userId: UUID) async throws {
+	public func deleteUser(_ userId: User.ID) async throws {
 		return try await self.authenticatedRequest(endpoints.deleteUser(userId))
 	}
 
@@ -91,15 +91,15 @@ extension MPAPIUserRepository {
 			return self.post("/users/v1")
 		}
 
-		func getUser(_ userId: UUID) -> Endpoint {
+		func getUser(_ userId: User.ID) -> Endpoint {
 			return self.get("/users/v1/\(userId)")
 		}
 
-		func updateUser(_ userId: UUID) -> Endpoint {
+		func updateUser(_ userId: User.ID) -> Endpoint {
 			return self.patch("/users/v1/\(userId)")
 		}
 
-		func deleteUser(_ userId: UUID) -> Endpoint {
+		func deleteUser(_ userId: User.ID) -> Endpoint {
 			return self.delete("/users/v1/\(userId)")
 		}
 

Sources/MonkiProjectsAPIClient/Protocols/WebUserRepository.swift

@@ -19,11 +19,11 @@ public protocol WebUserRepository: AnyObject, WebAPI {
 
 	func createUser(_ create: User.Create) -> AnyPublisher<User.Private, Error>
 
-	func getUser(_ userId: UUID) -> AnyPublisher<User.Public.Full, Error>
+	func getUser(_ userId: User.ID) -> AnyPublisher<User.Public.Full, Error>
 
-	func updateUser(_ userId: UUID, with update: User.Update) -> AnyPublisher<User.Public.Full, Error>
+	func updateUser(_ userId: User.ID, with update: User.Update) -> AnyPublisher<User.Public.Full, Error>
 
-	func deleteUser(_ userId: UUID) -> AnyPublisher<Void, Error>
+	func deleteUser(_ userId: User.ID) -> AnyPublisher<Void, Error>
 
 	// MARK: - Swift async/await
 
@@ -34,13 +34,13 @@ public protocol WebUserRepository: AnyObject, WebAPI {
 	func createUser(_ create: User.Create) async throws -> User.Private
 
 	@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
-	func getUser(_ userId: UUID) async throws -> User.Public.Full
+	func getUser(_ userId: User.ID) async throws -> User.Public.Full
 
 	@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
-	func updateUser(_ userId: UUID, with update: User.Update) async throws -> User.Public.Full
+	func updateUser(_ userId: User.ID, with update: User.Update) async throws -> User.Public.Full
 
 	@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
-	func deleteUser(_ userId: UUID) async throws
+	func deleteUser(_ userId: User.ID) async throws
 
 }
 

Tests/MonkiProjectsAPIClientTests/Helpers/XCTestCase+Cleaning.swift

@@ -9,12 +9,13 @@
 import MonkiProjectsAPIClient
 import XCTest
 import Networking
+import MonkiProjectsModel
 
 extension XCTestCase {
 
 	/// Delete created user
 	internal func deletePossiblyCreatedUserAfterTestFinishes(
-		_ userId: UUID,
+		_ userId: User.ID,
 		_ username: String,
 		_ password: String
 	) {