Creating Safari Web Inspector extensions
At a glance
| Item | Summary |
|---|---|
| Purpose | Learn how to make custom Safari Web Inspector extensions. |
| App architecture | A JavaScript, Swift sample with the source-visible chain AppDelegate → ViewController → SafariWebExtensionHandler → SafariServices APIs. |
| Main patterns | Delegate or data-source callbacks |
| Project style | 6 scanned source file(s) across JavaScript, Swift, organized around ranked entry, type, and file boundaries. |
Project structure
Source bundle/
├── Open Graph/
│ ├── macOS (App)/
│ │ ├── AppDelegate.swift
│ │ ├── Base.lproj/
│ │ │ └── Main.storyboard
│ │ └── Open Graph.entitlements
│ ├── Shared (App)/
│ │ ├── ViewController.swift
│ │ └── Resources/
│ │ └── Script.js
│ ├── Shared (Extension)/
│ │ ├── SafariWebExtensionHandler.swift
│ │ └── Resources/
│ │ ├── devtools_background.js
│ │ └── devtools_tab.js
│ ├── Open Graph.xcodeproj/
│ │ ├── .xcodesamplecode.plist
│ │ └── project.pbxproj
│ └── macOS (Extension)/
│ └── Info.plist
└── 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 7 project/configuration file(s) and 3 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["ViewController"]
N3["SafariWebExtensionHandler"]
N4["SafariServices APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
Open Graph/macOS (App)/AppDelegate.swift:10 — architecture anchor
@main
class AppDelegate: NSObject, NSApplicationDelegate {
// ...
}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 Safari Services.
Ownership and state
classDiagram
ViewController o-- WKWebView : webView
Ownership evidence
Open Graph/Shared (App)/ViewController.swift:18 — stored dependency or nearest verified ownership anchor
class ViewController: PlatformViewController, WKNavigationDelegate, WKScriptMessageHandler {
// ...
@IBOutlet var webView: WKWebView!
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
ViewController |
WKWebView (webView) |
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.
Class and protocol design
Open Graph/macOS (App)/AppDelegate.swift:11 — representative type boundary
class AppDelegate: NSObject, NSApplicationDelegate {
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | NSObject, NSApplicationDelegate |
ViewController |
View lifecycle, callbacks, and feature coordination | PlatformViewController, WKNavigationDelegate, WKScriptMessageHandler |
SafariWebExtensionHandler |
Handles callbacks or feature events | NSObject, NSExtensionRequestHandling |
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 (Open Graph/macOS (App)/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. |
ViewController (Open Graph/Shared (App)/ViewController.swift:16) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
SafariWebExtensionHandler (Open Graph/Shared (Extension)/SafariWebExtensionHandler.swift:13) |
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
Open Graph/macOS (App)/AppDelegate.swift:11 — representative boundary
class AppDelegate: NSObject, NSApplicationDelegate {
// ...
}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 | ViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
| Handles callbacks or feature events | SafariWebExtensionHandler |
The source’s Handler suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Delegate or data-source callbacks | Open Graph/Shared (App)/ViewController.swift:16 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: ViewController; Delegate: AppDelegate; Handler: SafariWebExtensionHandler.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
applicationDidFinishLaunching,applicationShouldTerminateAfterLastWindowClosed,viewDidLoad,webView,userContentController,beginRequest,show,openPreferences. - Files:
Open Graph/macOS (App)/AppDelegate.swift,Open Graph/Shared (App)/ViewController.swift,Open Graph/Shared (Extension)/SafariWebExtensionHandler.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches Cocoa, SafariServices, WebKit 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 |
|---|---|
Open Graph/macOS (App)/AppDelegate.swift |
AppDelegate |
Open Graph/Shared (App)/ViewController.swift |
ViewController |
Open Graph/Shared (Extension)/SafariWebExtensionHandler.swift |
SafariWebExtensionHandler |
Open Graph/Shared (App)/Resources/Script.js |
Feature implementation |
Open Graph/Shared (Extension)/Resources/devtools_background.js |
Feature implementation |
Open Graph/Shared (Extension)/Resources/devtools_tab.js |
Feature implementation |