Merge pull request #87 from orlandos-nl/jo/expose-type-identifier

Expose the Type Identifer APIs and conversion from Dictionary to Document

Author: Joannis

Sources/BSON/Codable/Decoding/Fast/FastBSONDecoder.swift

@@ -237,7 +237,7 @@ struct _FastKeyedContainer<Key: CodingKey>: KeyedDecodingContainerProtocol {
     }
 
     func decodeNil(forKey key: Key) throws -> Bool {
-        guard let type = document.typeIdentifier(of: key.stringValue) else {
+        guard let type = document.typeIdentifier(forKey: key.stringValue) else {
             return true
         }
 

Sources/BSON/Document/Document+Dictionary.swift

@@ -243,11 +243,48 @@ extension Document: ExpressibleByDictionaryLiteral {
 }
 
 extension Dictionary: BSONPrimitiveRepresentable, Primitive where Key == String, Value: Primitive {
+    public var document: Document {
+        var document = Document(isArray: false)
+        for (key, value) in self {
+            document[key] = value
+        }
+        return document
+    }
+    
     public var primitive: Primitive {
+        return document
+    }
+}
+
+extension Dictionary where Key == String, Value == Primitive {
+    public var document: Document {
         var document = Document(isArray: false)
         for (key, value) in self {
             document[key] = value
         }
         return document
     }
 }
+
+extension Document {
+    public init(dictionary: [String: Primitive]) {
+        self.init(isArray: false)
+        for (key, value) in dictionary {
+            self.appendValue(value, forKey: key)
+        }
+    }
+
+    public init<Value>(dictionary: [String: Value]) throws where Value: Primitive {
+        self.init(isArray: false)
+        for (key, value) in dictionary {
+            self.appendValue(try value.encodePrimitive(), forKey: key)
+        }
+    }
+
+    public init<Value>(dictionary: [String: Value]) throws where Value: PrimitiveEncodable {
+        self.init(isArray: false)
+        for (key, value) in dictionary {
+            self.appendValue(try value.encodePrimitive(), forKey: key)
+        }
+    }
+}

Sources/BSON/Document/Document+Helpers.swift

@@ -1,5 +1,5 @@
 extension Document {
-    internal func typeIdentifier(of key: String) -> TypeIdentifier? {
+    public func typeIdentifier(forKey key: String) -> TypeIdentifier? {
         var index = 4
 
         while index < storage.readableBytes {
@@ -27,7 +27,7 @@ extension Document {
         return nil
     }
 
-    internal func typeIdentifier(at index: Int) -> TypeIdentifier? {
+    public func typeIdentifier(at index: Int) -> TypeIdentifier? {
         var offset = 4
 
         for _ in 0..<index {

Sources/BSON/Types/TypeIdentifier.swift

@@ -1,18 +1,28 @@
-internal enum TypeIdentifier: UInt8 {
+/// - **Warning:** This enum is not exhaustive and may grow in the future. Always combine this with a `default` case in switch statements.
+public enum TypeIdentifier: UInt8 {
     case double = 0x01
     case string = 0x02
     case document = 0x03
     case array = 0x04
     case binary = 0x05
+
+    // Deprecated case undefined = 0x06
+
     case objectId = 0x07
     case boolean = 0x08
     case datetime = 0x09
     case null = 0x0a
     case regex = 0x0b
-//    case dbPointer = 0x0c
+
+    // Deprecated: case dbPointer = 0x0c
+
     case javascript = 0x0d
-//    case something = 0x0e
+
+    // Deprecated case symbol = 0x0e
+
+    /// Deprecated
     case javascriptWithScope = 0x0f
+
     case int32 = 0x10
     case timestamp = 0x11
     case int64 = 0x12