Add GuidanceViewKind to VisualInstruction.Component. (#778)

Cherry-picked from bb9fe98.
mapbox · Jan 3, 2023 · 94244ec · 94244ec
1 parent cb4ce5c
commit 94244ec
Show file tree

Hide file tree

Showing 6 changed files with 1,510 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,5 @@
 # Changes to Mapbox Directions for Swift
 
-## v2.9.0
-
-* Added the `RestStop.amenities` property that describes useful and important facilities such as gas stations, restaurants, and ATMs. ([#780](https://github.com/mapbox/mapbox-directions-swift/pull/780))
-
 ## v2.8.0
 
 ### Packaging

diff --git a/MapboxDirections.xcodeproj/project.pbxproj b/MapboxDirections.xcodeproj/project.pbxproj
@@ -180,6 +180,9 @@
 		43F89F942350F952007B591E /* MapMatchingResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 43F89F922350F952007B591E /* MapMatchingResponse.swift */; };
 		43F89F952350F952007B591E /* MapMatchingResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 43F89F922350F952007B591E /* MapMatchingResponse.swift */; };
 		43F89F962350F952007B591E /* MapMatchingResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 43F89F922350F952007B591E /* MapMatchingResponse.swift */; };
+		8A2CD31E294CFA54006C0AF6 /* instructionComponentsWithSubType.json in Resources */ = {isa = PBXBuildFile; fileRef = 8A2CD31D294CFA54006C0AF6 /* instructionComponentsWithSubType.json */; };
+		8A2CD31F294CFA54006C0AF6 /* instructionComponentsWithSubType.json in Resources */ = {isa = PBXBuildFile; fileRef = 8A2CD31D294CFA54006C0AF6 /* instructionComponentsWithSubType.json */; };
+		8A2CD320294CFA54006C0AF6 /* instructionComponentsWithSubType.json in Resources */ = {isa = PBXBuildFile; fileRef = 8A2CD31D294CFA54006C0AF6 /* instructionComponentsWithSubType.json */; };
 		8A3B4C9B24EB55F60085DA64 /* RouteResponseTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A3B4C9A24EB55F60085DA64 /* RouteResponseTests.swift */; };
 		8A47418F2947D1E100F231F9 /* AmenityTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8A47418E2947D1E100F231F9 /* AmenityTests.swift */; };
 		8A4741912947D22900F231F9 /* amenities.json in Resources */ = {isa = PBXBuildFile; fileRef = 8A4741902947D22900F231F9 /* amenities.json */; };
@@ -570,6 +573,7 @@
 		4392557523440EC2006EEE88 /* DirectionsError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DirectionsError.swift; sourceTree = "<group>"; };
 		43D992FB2437B8D2008A2D74 /* CredentialsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CredentialsTests.swift; sourceTree = "<group>"; };
 		43F89F922350F952007B591E /* MapMatchingResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MapMatchingResponse.swift; sourceTree = "<group>"; };
+		8A2CD31D294CFA54006C0AF6 /* instructionComponentsWithSubType.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = instructionComponentsWithSubType.json; sourceTree = "<group>"; };
 		8A3B4C9A24EB55F60085DA64 /* RouteResponseTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RouteResponseTests.swift; sourceTree = "<group>"; };
 		8A41B0FC24F5C2390021FFDC /* CHANGELOG.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CHANGELOG.md; sourceTree = "<group>"; };
 		8A47418E2947D1E100F231F9 /* AmenityTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AmenityTests.swift; sourceTree = "<group>"; };
@@ -836,6 +840,7 @@
 				C5D1D7EF1F6AF91700A1C4F1 /* instructions.json */,
 				AEAB390C20D7F4F4008F4E54 /* subLaneInstructions.json */,
 				AEAB391020D94699008F4E54 /* subVisualInstructions.json */,
+				8A2CD31D294CFA54006C0AF6 /* instructionComponentsWithSubType.json */,
 			);
 			name = Instructions;
 			sourceTree = "<group>";
@@ -1331,6 +1336,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DA737EE51D05F91E005BDA16 /* v5_driving_dc_geojson.json in Resources */,
+				8A2CD31F294CFA54006C0AF6 /* instructionComponentsWithSubType.json in Resources */,
 				2BA2E747257A667500D7AFC6 /* incidents.json in Resources */,
 				DA1A10CF1D00F975009F82FA /* v5_driving_dc_polyline.json in Resources */,
 				2B54080A245B23BE006C820B /* incorrectRouteRefreshResponse.json in Resources */,
@@ -1368,6 +1374,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DA737EE61D05F91E005BDA16 /* v5_driving_dc_geojson.json in Resources */,
+				8A2CD320294CFA54006C0AF6 /* instructionComponentsWithSubType.json in Resources */,
 				2BA2E748257A667500D7AFC6 /* incidents.json in Resources */,
 				DA1A10F31D010251009F82FA /* v5_driving_dc_polyline.json in Resources */,
 				2B54080B245B23BE006C820B /* incorrectRouteRefreshResponse.json in Resources */,
@@ -1412,6 +1419,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				DA737EE41D05F91E005BDA16 /* v5_driving_dc_geojson.json in Resources */,
+				8A2CD31E294CFA54006C0AF6 /* instructionComponentsWithSubType.json in Resources */,
 				2BA2E746257A667500D7AFC6 /* incidents.json in Resources */,
 				DAC05F1C1CFC1E5300FA0071 /* v5_driving_dc_polyline.json in Resources */,
 				2B540809245B23BE006C820B /* incorrectRouteRefreshResponse.json in Resources */,

diff --git a/Sources/MapboxDirections/VisualInstructionComponent.swift b/Sources/MapboxDirections/VisualInstructionComponent.swift
@@ -51,7 +51,7 @@ public extension VisualInstruction {
         /**
          The component is an image of a zoomed junction, with a fallback text representation.
          */
-        case guidanceView(image: GuidanceViewImageRepresentation, alternativeText: TextRepresentation)
+        case guidanceView(image: GuidanceViewImageRepresentation, alternativeText: TextRepresentation, kind: GuidanceViewKind? = nil)
 
         /**
          The component contains the localized word for “Exit”.
@@ -254,6 +254,7 @@ public struct GuidanceViewImageRepresentation: Equatable {
 extension VisualInstruction.Component: Codable {
     private enum CodingKeys: String, CodingKey {
         case kind = "type"
+        case guidanceViewKind = "subType"
         case text
         case abbreviatedText = "abbr"
         case abbreviatedTextPriority = "abbr_priority"
@@ -275,6 +276,75 @@ extension VisualInstruction.Component: Codable {
         case lane
     }
 
+    /**
+     :nodoc:
+     Kind of the guidance view that provides more context about the component guidance view that may help in visual
+     markup and display choices.
+     */
+    public enum GuidanceViewKind: String, Codable, CaseIterable {
+
+        /**
+         Junction view. Bird’s-eye artist’s rendition view of the overhead signage and
+         preferred road lane arrow on motorways where the road bifurcates into 2 or
+         more motorway trunk roads.
+         */
+        case fork = "jct"
+
+        /**
+         Advanced 2D signboard (vendor enhanced detailed signboard).
+         */
+        case signboard = "signboard"
+
+        /**
+         Service area/parking area guide map. Vertical artist’s rendition guide map of an SAPA rest area
+         showing various facilities icons such as restaurants, restrooms and parking areas.
+         The scale is approximately 1 to 5K.
+         */
+        case serviceAreaGuideMap = "sapaguidemap"
+
+        /**
+         Service area/parking area. Bird’s-eye artist’s rendition view of the overhead
+         signage and preferred road lane arrow at a rest area ramp where the route
+         leaves the main road.
+         */
+        case serviceArea = "sapa"
+
+        /**
+         Sign image after a toll gate. Used immediately after exiting a toll gate containing just the
+         overhead signboard. The preferred road (not the lane) arrow is highlighted on the signboard.
+         */
+        case afterToll = "aftertoll"
+
+        /**
+         3D city real. Bird’s-eye artist’s rendition view of a general road intersection
+         and preferred road lane arrow. There is no overhead signage.
+         */
+        case realisticUrbanIntersection = "cityreal"
+
+        /**
+         Motorway entrance. Bird’s-eye artist’s rendition view of the overhead signage and
+         preferred road lane arrow at an entrance ramp onto a motorway.
+         */
+        case motorwayEntrance = "entrance"
+
+        /**
+         Motorway exit. Bird’s-eye artist’s rendition view of the overhead signage and
+         preferred road lane arrow at an exit ramp from a motorway.
+         */
+        case motorwayExit = "exit"
+
+        /**
+         Branched image after a toll gate. Bird’s-eye artist’s rendition view of the overhead
+         signage and preferred road lane arrow immediately after exiting a toll gate.
+         */
+        case tollBranch = "tollbranch"
+
+        /**
+         Direction signboard guidance view.
+         */
+        case directionBoard = "directionboard"
+    }
+
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let kind = (try? container.decode(Kind.self, forKey: .kind)) ?? .text
@@ -317,7 +387,8 @@ extension VisualInstruction.Component: Codable {
                 imageURL = URL(string: imageURLString)
             }
             let guidanceViewImageRepresentation = GuidanceViewImageRepresentation(imageURL: imageURL)
-            self = .guidanceView(image: guidanceViewImageRepresentation, alternativeText: textRepresentation)
+            let guidanceViewKind = try container.decodeIfPresent(GuidanceViewKind.self, forKey: .guidanceViewKind)
+            self = .guidanceView(image: guidanceViewImageRepresentation, alternativeText: textRepresentation, kind: guidanceViewKind)
         }
     }
 
@@ -349,10 +420,11 @@ extension VisualInstruction.Component: Codable {
             try container.encode(indications, forKey: .directions)
             try container.encode(isUsable, forKey: .isActive)
             try container.encodeIfPresent(preferredDirection, forKey: .activeDirection)
-        case .guidanceView(let image, let alternativeText):
+        case .guidanceView(let image, let alternativeText, let kind):
             try container.encode(Kind.guidanceView, forKey: .kind)
             textRepresentation = alternativeText
             try container.encodeIfPresent(image.imageURL?.absoluteString, forKey: .imageURL)
+            try container.encodeIfPresent(kind, forKey: .guidanceViewKind)
         }
 
         if let textRepresentation = textRepresentation {
@@ -375,10 +447,11 @@ extension VisualInstruction.Component: Equatable {
               let .image(rhsURL, rhsAlternativeText)):
             return lhsURL == rhsURL
                 && lhsAlternativeText == rhsAlternativeText
-        case (let .guidanceView(lhsURL, lhsAlternativeText),
-              let .guidanceView(rhsURL, rhsAlternativeText)):
+        case (let .guidanceView(lhsURL, lhsAlternativeText, lhsKind),
+              let .guidanceView(rhsURL, rhsAlternativeText, rhsKind)):
             return lhsURL == rhsURL
                 && lhsAlternativeText == rhsAlternativeText
+                && lhsKind == rhsKind
         case (let .lane(lhsIndications, lhsIsUsable, lhsPreferredDirection),
               let .lane(rhsIndications, rhsIsUsable, rhsPreferredDirection)):
             return lhsIndications == rhsIndications