Update to Ignite 1.13.5, refactored CustomModules code

Author: jbackertm

README.md

@@ -16,14 +16,6 @@ This is an example integration of the Ticketmaster Ignite SDK, Retail, Tickets,
 * Retail SDK: https://ignite.ticketmaster.com/docs/ios-retail-change-log
 * Authentication SDK: https://ignite.ticketmaster.com/docs/ios-authentication-change-log
 
-## Demo App Screenshots
-
-<img src="Screenshots/MainMenu.jpg" alt="Main Menu" /> <img src="Screenshots/DiscoveryAPI.jpg" alt="DiscoveryAPI" /> 
-<img src="Screenshots/Homepage.jpg" alt="Homepage" /> <img src="Screenshots/AttractionEvents.jpg" alt="Attraction Details Page" /> <img src="Screenshots/VenueEvents.jpg" alt="Venue Details Page" />
- <img src="Screenshots/Purchase.jpg" alt="Event Details Page" />
- <img src="Screenshots/PurchasedEvents.jpg" alt="Purchased Events Listing Page" /> <img src="Screenshots/Tickets.jpg" alt="Purchased Tickets Listing Page" />
-
-
 ## Getting Started
 
 1. Open **TMSDKDemoIntegration.xcodeproj** using Swift 5.9+ (Xcode 15.0.1+ or Xcode 16.0+)
@@ -33,3 +25,17 @@ This is an example integration of the Ticketmaster Ignite SDK, Retail, Tickets,
 4. Build and Run **TMSDKDemoIntegration** target
 
  <img src="Screenshots/Project.jpg" alt="Project Contents" />
+
+## Demo App Screenshots
+
+### Main Menu
+<img src="Screenshots/MainMenu.jpg" alt="Main Menu" /> <img src="Screenshots/DiscoveryAPI.jpg" alt="DiscoveryAPI" />
+
+### Retail SDK 
+<img src="Screenshots/Homepage.jpg" alt="Homepage" /> <img src="Screenshots/AttractionEvents.jpg" alt="Attraction Details Page" /> <img src="Screenshots/VenueEvents.jpg" alt="Venue Details Page" /> <img src="Screenshots/Purchase.jpg" alt="Event Details Page" />
+
+### Tickets SDK
+<img src="Screenshots/PurchasedEvents.jpg" alt="Purchased Events Listing Page" /> <img src="Screenshots/Tickets.jpg" alt="Purchased Tickets Listing Page" />
+
+### Tickets SDK: Custom Modules
+<img src="Screenshots/CustomModules.jpg" alt="Custom Modules" /> 

Screenshots/CustomModules.jpg

@@ -240,6 +240,7 @@
 		79E8C0852A5656BF0054B340 /* DictionaryExplorerTextView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DictionaryExplorerTextView.swift; sourceTree = "<group>"; };
 		79E8C0862A5656BF0054B340 /* DiscoveryVC+BuildMenu.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "DiscoveryVC+BuildMenu.swift"; sourceTree = "<group>"; };
 		79E8C08F2A56584C0054B340 /* DiscoveryHelper+APICalls.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "DiscoveryHelper+APICalls.swift"; sourceTree = "<group>"; };
+		79FE1DF32D6E54BF0070652F /* Screenshots */ = {isa = PBXFileReference; lastKnownFileType = text; path = Screenshots; sourceTree = SOURCE_ROOT; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -327,6 +328,7 @@
 		79E8BFF92A5626160054B340 /* Documentation */ = {
 			isa = PBXGroup;
 			children = (
+				79FE1DF32D6E54BF0070652F /* Screenshots */,
 				795D32F22A56781C001D0466 /* README.md */,
 			);
 			path = Documentation;
@@ -997,7 +999,7 @@
 			repositoryURL = "https://github.com/ticketmaster/iOS-TicketmasterSDK.git";
 			requirement = {
 				kind = exactVersion;
-				version = 1.13.4;
+				version = 1.13.5;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

TMSDKDemoIntegration.xcodeproj/project.pbxproj

@@ -12,7 +12,8 @@ import TicketmasterDiscoveryAPI // for DiscoveryEventSearchCriteria
 
 extension TicketsHelper {
 
-    func addCustomModules(event: TMPurchasedEvent) -> [TMTicketsModule] {
+    /// see Documentation/Screenshots/CustomModules for examples
+    func buildCustomModules(event: TMPurchasedEvent, completion: @escaping (_ customModules: [TMTicketsModule]) -> Void) {
         print(" - Adding Custom Modules")
         var output: [TMTicketsModule] = []
 
@@ -51,18 +52,16 @@ extension TicketsHelper {
             output.append(module)
         }
 
-        return output
-    }
-    
-    func addCustomAsyncModules(event: TMPurchasedEvent, completion: @escaping (_ modules: [TMTicketsModule]) -> Void) {
-        print(" - Adding Custom Modules (async)")
-        var output: [TMTicketsModule] = []
-        
+        // build upcoming home games module (see Documentation/Screenshots/CustomModules for example)
+        // this module uses a network call to Discovery API to find home games
         nextHomeGameModule(event: event) { nextEventModule in
+            // this returns on the networking thread
             if let nextEventModule = nextEventModule {
                 output.append(nextEventModule)
             }
 
+            // use an async completion in case any of these custom modules need to make a network request
+            // like nextHomeGameModule
             completion(output)
         }
     }
@@ -398,7 +397,4 @@ extension TicketsHelper {
                                headerDisplay: headerDisplay,
                                actionButtons: [gamesActionButton]) // you can show 0 to 3 buttons
     }
-    
-    
-    
 }

TMSDKDemoIntegration/Logic/Tickets/TicketsHelper+CustomModules.swift

@@ -21,17 +21,17 @@ extension TicketsHelper: TMTicketsModuleDelegate {
         print("Add Modules...")
         var modules: [TMTicketsModule] = []
 
-        // add prebuilt modules (optional)
-        modules.append(contentsOf: addPreBuiltModules(event: event))
-        
-        // add custom modules (optional)
-        modules.append(contentsOf: addCustomModules(event: event))
-        
-        addCustomAsyncModules(event: event) { asyncModules in
-            modules.append(contentsOf: asyncModules)
+        buildPreBuiltModules(event: event) { prebuiltModules in
+            // add prebuilt modules (optional)
+            modules.append(contentsOf: prebuiltModules)
 
-            // return list of modules (in the order you want them displayed)
-            completion(modules)
+            self.buildCustomModules(event: event) { customModules in
+                // add custom modules (optional)
+                modules.append(contentsOf: customModules)
+                
+                // return list of modules (in the order you want them displayed)
+                completion(modules)
+            }
         }
     }
 

TMSDKDemoIntegration/Logic/Tickets/TicketsHelper+ModuleDelegate.swift

@@ -10,7 +10,7 @@ import TicketmasterTickets // for TMPurchasedEvent, TMTicketsModule and TMTicket
 
 extension TicketsHelper {
 
-    func addPreBuiltModules(event: TMPurchasedEvent) -> [TMTicketsModule] {
+    func buildPreBuiltModules(event: TMPurchasedEvent, completion: @escaping (_ prebuiltModules: [TMTicketsModule]) -> Void) {
         print(" - Adding Prebuilt Modules")
         var output: [TMTicketsModule] = []
 
@@ -64,6 +64,7 @@ extension TicketsHelper {
         }
         #endif
 
-        return output
+        // use an async completion in case any of these prebuilt modules need to make a network request
+        completion(output)
     }
 }