Sample CodemacOSReviewed 2026-07-21View on Apple Developer

Developing a Safari Web Extension

At a glance

Item Summary
Purpose Customize and enhance web pages by building a Safari web extension.
App architecture A JavaScript, Swift sample with the source-visible chain AppDelegateViewControllerSafariWebExtensionHandlerSafariServices 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.
Execution model Source-visible boundaries: DispatchQueue.main.async; none alone proves a background thread.
State/event model No structured observation or publisher-scheduling marker indexed.
Key frameworks/packages SafariServices, Cocoa; these are source dependencies, not architecture labels.

Project structure

Source bundle/
├── Sea Creator/
│   ├── AppDelegate.swift
│   ├── ViewController.swift
│   └── Base.lproj/
│       └── Main.storyboard
├── Sea Creator Extension/
│   ├── SafariWebExtensionHandler.swift
│   ├── Resources/
│   │   ├── background.js
│   │   ├── content.js
│   │   └── popup.js
│   ├── Info.plist
│   └── Sea_Creator_Extension.entitlements
├── Configuration/
│   └── SampleCode.xcconfig
└── Sea Creator.xcodeproj/
    ├── .xcodesamplecode.plist
    └── project.pbxproj

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 8 project/configuration file(s) and 3 source declaration(s).

Overall architecture

Reference code

Sea Creator/AppDelegate.swift:9 — architecture anchor

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {

    func applicationDidFinishLaunching(_ aNotification: Notification) {
        // Insert code here to initialize your application
    }

    func applicationWillTerminate(_ aNotification: Notification) {
        // Insert code here to tear down your application
    }

}

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

Ownership evidence

Sea Creator/ViewController.swift:16 — stored dependency or nearest verified ownership anchor

class ViewController: NSViewController {
    // ...
    @IBOutlet var appNameLabel: NSTextField!
    // ...
}
Owner Object or state Relationship Mutation authority
ViewController NSTextField (appNameLabel) stores or receives App/module collaborators
ViewController NSTextField (replacementCountLabel) stores or receives App/module collaborators
content RegExp (expressionForWordToReplace) creates and retains 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.

Concern Source mechanism Verified placement or handoff Evidence
Queue scheduling DispatchQueue.main.async The source addresses the main dispatch queue. Sea Creator/ViewController.swift:32

@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.

Reference code

Sea Creator/ViewController.swift:32 — representative execution boundary

                DispatchQueue.main.async {
                    let alert = NSAlert()
                    // ...
                }

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 SafariServices The cited file imports this module; runtime use and architectural role are not inferred. Sea Creator Extension/SafariWebExtensionHandler.swift:7
Source import Cocoa The cited file imports this module; runtime use and architectural role are not inferred. Sea Creator/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

Sea Creator/AppDelegate.swift:10 — representative type boundary

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
    // ...
}
Type Responsibility Depends on or conforms to
AppDelegate Receives callback-driven events NSObject, NSApplicationDelegate
SafariWebExtensionHandler Handles callbacks or feature events NSObject, NSExtensionRequestHandling
ViewController View lifecycle, callbacks, and feature coordination NSViewController

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 (Sea Creator/AppDelegate.swift:10) implicit internal No explicit modifier means the Swift declaration is internal to the module. Inference: app-target collaboration needs no exported library surface.
SafariWebExtensionHandler (Sea Creator Extension/SafariWebExtensionHandler.swift:9) implicit internal No explicit modifier means the Swift declaration is internal to the module. Inference: app-target collaboration needs no exported library surface.
ViewController (Sea Creator/ViewController.swift:14) 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

Sea Creator/AppDelegate.swift:10 — representative boundary

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {

    func applicationDidFinishLaunching(_ aNotification: Notification) {
        // Insert code here to initialize your application
    }

    func applicationWillTerminate(_ aNotification: Notification) {
        // Insert code here to tear down your application
    }

}

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 Sea Creator/AppDelegate.swift:10 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, applicationWillTerminate, beginRequest, viewDidLoad, openSafariExtensionPreferences, updateReplacementStats, replace, replaceTextInTextNode.
  • Files: Sea Creator/AppDelegate.swift, Sea Creator Extension/SafariWebExtensionHandler.swift, Sea Creator/ViewController.swift.

Architecture takeaways

  • AppDelegate is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches SafariServices, Cocoa 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
Sea Creator/AppDelegate.swift Cited implementation, AppDelegate, Cocoa
Sea Creator/ViewController.swift Cited implementation, ViewController, DispatchQueue.main.async
Sea Creator Extension/SafariWebExtensionHandler.swift SafariWebExtensionHandler, SafariServices
Sea Creator Extension/Resources/background.js Feature implementation
Sea Creator Extension/Resources/content.js Feature implementation
Sea Creator Extension/Resources/popup.js Feature implementation