Add then component

MapboxDirections/MBVisualInstruction.swift

@@ -58,8 +58,20 @@ open class VisualInstruction: NSObject, NSSecureCoding {
         let text = json["text"] as? String
         let maneuverType = ManeuverType(description: json["type"] as! String) ?? .none
         let maneuverDirection = ManeuverDirection(description: json["modifier"] as! String)  ?? .none
-        let textComponents = (json["components"] as! [JSONDictionary]).map {
-            VisualInstructionComponent(json: $0)
+        let textComponents: [VisualInstructionComponent] = (json["components"] as! [JSONDictionary]).map { record in
+            let type = VisualInstructionComponentType(description: record["type"] as! String) ?? .none
+            var directions = LaneIndication()
+            if let laneDirections = record["directions"] as? [String],
+                let laneIndication = LaneIndication(descriptions: laneDirections) {
+                directions = laneIndication
+            }
+            return VisualInstructionComponent(type: type,
+                                              text: record["text"] as? String,
+                                          imageURL: URL(string: (record["imageBaseURL"] as? String) ?? ""),
+                                      abbreviation: record["abbr"] as? String,
+                              abbreviationPriority: record["abbr_priority"] as? Int ?? NSNotFound,
+                                        directions: directions,
+                                      isLaneActive: record["active"] as? Bool ?? false)
         }
 
         let degrees = json["degrees"] as? CLLocationDegrees ?? 180
@@ -97,6 +109,6 @@ open class VisualInstruction: NSObject, NSSecureCoding {
         coder.encode(maneuverType, forKey: "maneuverType")
         coder.encode(maneuverDirection, forKey: "maneuverDirection")
         coder.encode(finalHeading, forKey: "degrees")
+        coder.encode(textComponents, forKey: "textComponents")
     }
 }
-

MapboxDirections/MBVisualInstructionBanner.swift

@@ -21,6 +21,11 @@ open class VisualInstructionBanner: NSObject, NSSecureCoding {
      */
     @objc public let secondaryInstruction: VisualInstruction?
 
+    /**
+     The information about the next maneuver (the one after the upcoming maneuver). This detail gives the driver heads up when the current step is short.
+     */
+    @objc public let subInstruction: VisualInstruction?
+
     /**
      Which side of a bidirectional road the driver should drive on, also known as the rule of the road.
      */
@@ -38,14 +43,20 @@ open class VisualInstructionBanner: NSObject, NSSecureCoding {
 
         let primary = json["primary"] as! JSONDictionary
         let secondary = json["secondary"] as? JSONDictionary
+        let sub = json["sub"] as? JSONDictionary
 
         let primaryInstruction = VisualInstruction(json: primary)
         var secondaryInstruction: VisualInstruction? = nil
         if let secondary = secondary {
             secondaryInstruction = VisualInstruction(json: secondary)
         }
 
-        self.init(distanceAlongStep: distanceAlongStep, primaryInstruction: primaryInstruction, secondaryInstruction: secondaryInstruction, drivingSide: drivingSide)
+        var subInstruction: VisualInstruction? = nil
+        if let sub = sub {
+            subInstruction = VisualInstruction(json: sub)
+        }
+
+        self.init(distanceAlongStep: distanceAlongStep, primaryInstruction: primaryInstruction, secondaryInstruction: secondaryInstruction, subInstruction: subInstruction, drivingSide: drivingSide)
     }
 
     /**
@@ -56,10 +67,11 @@ open class VisualInstructionBanner: NSObject, NSSecureCoding {
      - parameter secondaryInstruction: Less important details about the `RouteStep`.
      - parameter drivingSide: Which side of a bidirectional road the driver should drive on.
      */
-    @objc public init(distanceAlongStep: CLLocationDistance, primaryInstruction: VisualInstruction, secondaryInstruction: VisualInstruction?, drivingSide: DrivingSide) {
+    @objc public init(distanceAlongStep: CLLocationDistance, primaryInstruction: VisualInstruction, secondaryInstruction: VisualInstruction?, subInstruction: VisualInstruction?, drivingSide: DrivingSide) {
         self.distanceAlongStep = distanceAlongStep
         self.primaryInstruction = primaryInstruction
         self.secondaryInstruction = secondaryInstruction
+        self.subInstruction = subInstruction
         self.drivingSide = drivingSide
     }
 
@@ -77,6 +89,7 @@ open class VisualInstructionBanner: NSObject, NSSecureCoding {
         }
         self.primaryInstruction = primaryInstruction
         self.secondaryInstruction = decoder.decodeObject(of: VisualInstruction.self, forKey: "secondary")
+        self.subInstruction = decoder.decodeObject(of: VisualInstruction.self, forKey: "sub")
     }
 
     open static var supportsSecureCoding = true
@@ -85,6 +98,7 @@ open class VisualInstructionBanner: NSObject, NSSecureCoding {
         coder.encode(distanceAlongStep, forKey: "distanceAlongStep")
         coder.encode(primaryInstruction, forKey: "primary")
         coder.encode(secondaryInstruction, forKey: "secondary")
+        coder.encode(subInstruction, forKey: "sub")
         coder.encode(drivingSide, forKey: "drivingSide")
     }
 }

MapboxDirections/MBVisualInstructionComponent.swift

@@ -45,6 +45,20 @@ open class VisualInstructionComponent: NSObject, NSSecureCoding {
      */
     @objc public var abbreviationPriority: Int = NSNotFound
 
+    /**
+     An array indicating which directions you can go from a lane (left, right, or straight).
+
+     If the value is `[.left", .straight]`, the driver can go straight or left from that lane. This is only set when the `component` is a lane.
+     */
+    @objc public var directions: LaneIndication
+
+    /**
+     The boolean that indicates whether the component is a lane and can be used to complete the upcoming maneuver.
+
+     If multiple lanes are active, then they can all be used to complete the upcoming maneuver. This value is set to `false` by default.
+     */
+    @objc public var isLaneActive: Bool = false
+
     /**
      Initializes a new visual instruction component object based on the given JSON dictionary representation.
 
@@ -71,7 +85,18 @@ open class VisualInstructionComponent: NSObject, NSSecureCoding {
             imageURL = URL(string: "\(baseURL)@\(Int(scale))x.png")
         }
 
-        self.init(type: type, text: text, imageURL: imageURL, abbreviation: abbreviation, abbreviationPriority: abbreviationPriority)
+        var isLaneActive = false
+        if let active = json["active"] as? Bool {
+            isLaneActive = active
+        }
+
+        var directions = LaneIndication()
+        if let laneDirections = json["directions"] as? [String],
+            let laneIndication = LaneIndication(descriptions: laneDirections) {
+            directions = laneIndication
+        }
+
+        self.init(type: type, text: text, imageURL: imageURL, abbreviation: abbreviation, abbreviationPriority: abbreviationPriority, directions: directions, isLaneActive: isLaneActive)
     }
 
     /**
@@ -82,13 +107,17 @@ open class VisualInstructionComponent: NSObject, NSSecureCoding {
      - parameter imageURL: The URL to an image representation of this component.
      - parameter abbreviation: An abbreviated representation of `text`.
      - parameter abbreviationPriority: The priority for which the component should be abbreviated.
+     - parameter directions: The possibile directions to go from a lane component.
+     - parameter isLaneActive: The flag to indicate that the upcoming maneuver can be completed with a lane component.
      */
-    @objc public init(type: VisualInstructionComponentType, text: String?, imageURL: URL?, abbreviation: String?, abbreviationPriority: Int) {
+    @objc public init(type: VisualInstructionComponentType, text: String?, imageURL: URL?, abbreviation: String?, abbreviationPriority: Int, directions: LaneIndication = LaneIndication(), isLaneActive: Bool = false) {
         self.text = text
         self.imageURL = imageURL
         self.type = type
         self.abbreviation = abbreviation
         self.abbreviationPriority = abbreviationPriority
+        self.directions = directions
+        self.isLaneActive = isLaneActive
     }
 
     @objc public required init?(coder decoder: NSCoder) {
@@ -111,6 +140,14 @@ open class VisualInstructionComponent: NSObject, NSSecureCoding {
         self.abbreviation = abbreviation
 
         abbreviationPriority = decoder.decodeInteger(forKey: "abbreviationPriority")
+
+        guard let directions = decoder.decodeObject(of: [NSArray.self, NSString.self], forKey: "directions") as? [String] else {
+            return nil
+        }
+
+        self.directions = LaneIndication(descriptions: directions) ?? LaneIndication()
+
+        self.isLaneActive = decoder.decodeObject(forKey: "active") as? Bool ?? false
     }
 
     open static var supportsSecureCoding = true
@@ -120,6 +157,8 @@ open class VisualInstructionComponent: NSObject, NSSecureCoding {
         coder.encode(type, forKey: "type")
         coder.encode(abbreviation, forKey: "abbreviation")
         coder.encode(abbreviationPriority, forKey: "abbreviationPriority")
+        coder.encode(directions, forKey: "directions")
+        coder.encode(isLaneActive, forKey: "active")
     }
 }
 

MapboxDirections/MBVisualInstructionType.swift

@@ -6,6 +6,11 @@ import Foundation
 @objc(MBVisualInstructionComponentType)
 public enum VisualInstructionComponentType: Int, CustomStringConvertible {
 
+    /**
+     The step does not have a particular visual instruction component type associated with it.
+     */
+    case none
+
     /**
      The component separates two other destination components.
 
@@ -30,6 +35,11 @@ public enum VisualInstructionComponentType: Int, CustomStringConvertible {
      */
     case exit
 
+    /**
+     The component contains information about which lanes can be used to complete the maneuver.
+     */
+    case lane
+
     /**
      A component contains an exit number.
      */
@@ -48,14 +58,18 @@ public enum VisualInstructionComponentType: Int, CustomStringConvertible {
             type = .exit
         case "exit-number":
             type = .exitCode
+        case "lane":
+            type = .lane
         default:
-            return nil
+            type = .none
         }
         self.init(rawValue: type.rawValue)
     }
 
     public var description: String {
         switch self {
+        case .none:
+            return "none"
         case .delimiter:
             return "delimiter"
         case .image:
@@ -66,6 +80,8 @@ public enum VisualInstructionComponentType: Int, CustomStringConvertible {
             return "exit"
         case .exitCode:
             return "exit-number"
+        case .lane:
+            return "lane"
         }
     }
 }