Implementing a Hybrid TV App with TVMLKit
At a glance
| Item | Summary |
|---|---|
| Purpose | Display content options with document view controllers and fetch and populate content with TVMLKit JS. |
| App architecture | A JavaScript, Swift sample with the source-visible chain AppDelegate → HostController → DocumentLoader → TVMLKit APIs. |
| Main patterns | View-controller organization, Delegate or data-source callbacks |
| Project style | 2 scanned source file(s) across JavaScript, Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | No structured execution marker indexed; callback threading requires source review. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | TVMLKit, UIKit; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── Server/
│ └── js/
│ └── application.js
├── DocumentService/
│ ├── DocumentService/
│ │ ├── AppDelegate.swift
│ │ └── Info.plist
│ └── DocumentService.xcodeproj/
│ ├── .xcodesamplecode.plist
│ └── project.pbxproj
└── Configuration/
└── SampleCode.xcconfig
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: JavaScript, Swift.
- The verified tree contains 4 project/configuration file(s) and 3 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["HostController"]
N3["DocumentLoader"]
N4["TVMLKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
DocumentService/DocumentService/AppDelegate.swift:10 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
var appController: TVApplicationController?
static let TVBootURL = "http://localhost:9001/js/application.js"
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
window = UIWindow(frame: UIScreen.main.bounds)
let appControllerContext = TVApplicationControllerContext()
guard let javaScriptURL = URL(string: AppDelegate.TVBootURL) else { fatalError("unable to create URL") }
appControllerContext.javaScriptApplicationURL = javaScriptURL
appController = TVApplicationController(context: appControllerContext, window: window, delegate: self)
appController?.navigationController.delegate = self
return true
}
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into TVMLKit.
Ownership and state
classDiagram
DocumentLoader *-- XMLHttpRequest : xhr
AppDelegate o-- UIWindow : window
AppDelegate o-- TVApplicationController : appController
Ownership evidence
Server/js/application.js:29 — stored dependency or nearest verified ownership anchor
class DocumentLoader
{
// ...
let xhr = new XMLHttpRequest();
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
DocumentLoader |
XMLHttpRequest (xhr) |
creates and retains | Initialized by the owner; the binding is immutable |
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
AppDelegate |
TVApplicationController (appController) |
stores or receives | App/module collaborators |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
No source-visible execution, scheduling, or synchronization boundary was found in the indexed source.
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| Source import | TVMLKit |
The cited file imports this module; runtime use and architectural role are not inferred. | DocumentService/DocumentService/AppDelegate.swift:8 |
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | DocumentService/DocumentService/AppDelegate.swift:7 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
DocumentService/DocumentService/AppDelegate.swift:11 — representative type boundary
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
HostController |
View lifecycle, callbacks, and feature coordination | Concrete collaborators/imported frameworks |
DocumentLoader |
Loads and prepares feature data or resources | Concrete collaborators/imported frameworks |
No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
AppDelegate (DocumentService/DocumentService/AppDelegate.swift:11) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
Reference code
DocumentService/DocumentService/AppDelegate.swift:11 — representative boundary
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | HostController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
| Loads and prepares feature data or resources | DocumentLoader |
The source’s Loader suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | Server/js/application.js:10 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Delegate or data-source callbacks | DocumentService/DocumentService/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: HostController; Delegate: AppDelegate; Loader: DocumentLoader.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
application,appController,documentViewController,navigationController,browserViewController. - Files:
DocumentService/DocumentService/AppDelegate.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches TVMLKit, UIKit through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- The source does not justify labeling the design protocol-oriented.
Source map
| Source file | Relevant symbols |
|---|---|
DocumentService/DocumentService/AppDelegate.swift |
Cited implementation, AppDelegate, TVMLKit, UIKit |
Server/js/application.js |
Cited implementation, HostController, DocumentLoader |