firebase-ios-sdk/FirebaseCombineSwift/Sources/Firestore/CollectionReference+Combine.swift

// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import Combine
import FirebaseFirestore

@available(swift 5.0)
@available(iOS 13.0, macOS 10.15, macCatalyst 13.0, tvOS 13.0, watchOS 6.0, *)
public extension CollectionReference {
  // MARK: - Adding Documents

  /// Adds a new document to this collection with the specified data, assigning it a document ID
  /// automatically.
  ///
  /// - Parameter data: A `Dictionary` containing the data for the new document.
  /// - Returns: A publisher emitting a `DocumentReference` value once the document has been
  ///            successfully written to the server. This publisher will not emit while the
  ///            client is offline, though local changes will be visible immediately.
  func addDocument(data: [String: Any])
    -> Future<DocumentReference, Error> {
    var reference: DocumentReference?
    return Future { promise in
      reference = self.addDocument(data: data) { error in
        if let error {
          promise(.failure(error))
        } else if let reference {
          promise(.success(reference))
        }
      }
    }
  }

  /// Adds a new document to this collection with the specified data, assigning it a document ID
  /// automatically.
  ///
  /// - Parameters:
  ///   - value: An instance of `Encodable` to be encoded to a document.
  ///   - encoder: An encoder instance to use to run the encoding.
  /// - Returns: A publisher emitting a `DocumentReference` value once the document has been
  ///            successfully written to the server. This publisher will not emit while the
  ///            client is offline, though local changes will be visible immediately.
  func addDocument<T: Encodable>(from value: T,
                                 encoder: Firestore.Encoder = Firestore
                                   .Encoder()) -> Future<
    DocumentReference,
    Error
  > {
    var reference: DocumentReference?
    return Future { promise in
      do {
        try reference = self.addDocument(from: value, encoder: encoder) { error in
          if let error {
            promise(.failure(error))
          } else if let reference {
            promise(.success(reference))
          }
        }
      } catch {
        promise(.failure(error))
      }
    }
  }
}