[Style] Change func naming from isFieldDuplicated to isDocumentExists

Author: SHcommit

Sources/SHFirestoreService/FirestoreDocumentSupportable.swift

@@ -8,6 +8,32 @@
 import Combine
 import Foundation
 
+#if os(iOS) && canImport(FirebaseFirestore)
+import FirebaseFirestore
 public protocol FirestoreDocumentSupportable {
-  func isDocumentExists(endpoint: any FirestoreEndopintable) -> AnyPublisher<Bool, FirestoreServiceError>
+  
+  /// When implementing the endpoint's document instance to be returned from the request Type, it is returned whether the document exists.
+  func isDocumentExists(
+    endpoint: any FirestoreEndopintable
+  ) -> AnyPublisher<Bool, FirestoreServiceError>
+  
+  /// Checks if a document is duplicated or not from the endpoint requestType is a collectionRef using firestore's query.
+  ///
+  /// Notes:
+  /// 1. This method executes a Firestore query to check if the specified field in the document is duplicated from a collection reference.
+  /// 2. endpoint's a documentRef computed property of requestType property  should return nil.
+  /// 3. The query is executed using the provided endpoint and query handler.
+  /// 4. The requestType of endpoint is not used.
+  ///
+  /// - Parameters:
+  ///   - endpoint: The Firestore endpoint to query, which must conform to `FirestoreEndopintable`.
+  ///   - query: The Firestore query handler used to execute the query.
+  ///            The query should be designed to check for field duplication.
+  /// - Returns: A publisher that emits a `Bool` indicating whether the field is duplicated (`true`) or not (`false`).
+  /// - Throws: `FirestoreServiceError` if the query execution fails.
+  func isDocumentExists(
+    endpoint: any FirestoreEndopintable,
+    makeQuery: @escaping FirestoreQueryable.FirestoreQueryHandler
+  ) -> AnyPublisher<Bool, FirestoreServiceError>
 }
+#endif

Sources/SHFirestoreService/FirestoreQueryable.swift

@@ -32,24 +32,5 @@ public protocol FirestoreQueryable {
   where D: Decodable,
         E: FirestoreEndopintable,
         D == E.ResponseDTO
-  
-  /// Checks if a document is duplicated or not from the endpoint requestType is a collectionRef using firestore's query.
-  ///
-  /// Notes:
-  /// 1. This method executes a Firestore query to check if the specified field in the document is duplicated from a collection reference.
-  /// 2. endpoint's a documentRef computed property of requestType property  should return nil.
-  /// 3. The query is executed using the provided endpoint and query handler.
-  /// 4. The requestType of endpoint is not used.
-  ///
-  /// - Parameters:
-  ///   - endpoint: The Firestore endpoint to query, which must conform to `FirestoreEndopintable`.
-  ///   - query: The Firestore query handler used to execute the query.
-  ///            The query should be designed to check for field duplication.
-  /// - Returns: A publisher that emits a `Bool` indicating whether the field is duplicated (`true`) or not (`false`).
-  /// - Throws: `FirestoreServiceError` if the query execution fails.
-  func isFieldDuplicated(
-    endpoint: any FirestoreEndopintable,
-    makeQuery: @escaping FirestoreQueryHandler
-  ) -> AnyPublisher<Bool, FirestoreServiceError>
 }
 #endif

Sources/SHFirestoreService/FirestoreService.swift

@@ -371,6 +371,44 @@ extension FirestoreService: FirestoreQueryable {
         }
     }.eraseToAnyPublisher()
   }
+}
+
+// MARK: - FirestoreTransactional
+extension FirestoreService: FirestoreTransactional {
+  /// Notes:
+  /// 1. Executes a transaction and emits FiresotreServiceError if execution fails.
+  public func performTransaction(
+    _ updateBlock: @escaping (Transaction) throws -> Any?
+  ) -> AnyPublisher<Any?, any Error> {
+    return Firestore.firestore()
+      .runTransaction(updateBlock)
+      .subscribeAndReceive(on: backgroundQueue)
+      .mapError { error in
+        return FirestoreServiceError.failedTransaction(error)
+      }.eraseToAnyPublisher()
+  }
+}
+
+// MARK: - FirestoreDocumentSupportable
+extension FirestoreService: FirestoreDocumentSupportable {
+  /// Determine whether a document exists
+  ///
+  /// Notes:
+  /// 1. Do not need to specify FirestoreMethod's specific type when using this function.
+  /// 2. Set up requestType of FirestoreAccessible in endpoint to access firestore's a specific document before call this function.
+  /// 3. When a document path is provided from requestType, this function determines whether the document exists by querying the snapshot.
+  public func isDocumentExists(
+    endpoint: any FirestoreEndopintable
+  ) -> AnyPublisher<Bool, FirestoreServiceError> {
+    guard let documentRef = endpoint.reference.asDocumentRef else {
+      return Fail(error: FirestoreServiceError.documentNotFound).eraseToAnyPublisher()
+    }
+    return documentRef
+      .getDocument()
+      .convertFirestoreServiceError()
+      .map { snapshot -> Bool in return snapshot.exists }.eraseToAnyPublisher()
+      .eraseToAnyPublisher()
+  }
 
   /// Checks if a document is duplicated or not from the endpoint requestType is a collectionRef using firestore's query.
   ///
@@ -400,7 +438,7 @@ extension FirestoreService: FirestoreQueryable {
   ///   // TODO: - You can check whether the query has any matching documents in this downstream
   /// }
   /// ```
-  public func isFieldDuplicated(
+  public func isDocumentExists(
     endpoint: any FirestoreEndopintable,
     makeQuery: @escaping FirestoreQueryHandler
   ) -> AnyPublisher<Bool, FirestoreServiceError> {
@@ -428,39 +466,4 @@ extension FirestoreService: FirestoreQueryable {
     }.eraseToAnyPublisher()
   }
 }
-
-// MARK: - FirestoreTransactional
-extension FirestoreService: FirestoreTransactional {
-  /// Notes:
-  /// 1. Executes a transaction and emits FiresotreServiceError if execution fails.
-  public func performTransaction(
-    _ updateBlock: @escaping (Transaction) throws -> Any?
-  ) -> AnyPublisher<Any?, any Error> {
-    return Firestore.firestore()
-      .runTransaction(updateBlock)
-      .subscribeAndReceive(on: backgroundQueue)
-      .mapError { error in
-        return FirestoreServiceError.failedTransaction(error)
-      }.eraseToAnyPublisher()
-  }
-}
-
-// MARK: - FirestoreDocumentSupportable
-extension FirestoreService: FirestoreDocumentSupportable {
-  /// Determine whether a document exists
-  ///
-  /// Notes:
-  /// 1. Do not need to specify FirestoreMethod's specific type when using this function.
-  /// 2. Set up requestType of FirestoreAccessible in endpoint to access firestore's a specific document before call this function.
-  public func isDocumentExists(endpoint: any FirestoreEndopintable) -> AnyPublisher<Bool, FirestoreServiceError> {
-    guard let documentRef = endpoint.reference.asDocumentRef else {
-      return Fail(error: FirestoreServiceError.documentNotFound).eraseToAnyPublisher()
-    }
-    return documentRef
-      .getDocument()
-      .convertFirestoreServiceError()
-      .map { snapshot -> Bool in return snapshot.exists }.eraseToAnyPublisher()
-      .eraseToAnyPublisher()
-  }
-}
 #endif