SwiftNEW Framework

SwiftNEW tracks which versions have already been shown to the user using @AppStorage. This prevents the same release notes from appearing repeatedly. It uses the following namespaced keys:

Comparison is string-safe, supporting non-numeric values like 1.0-beta.

CarPlay is a managed capability.

• Approval Required: Apple must approve the host app for an eligible CarPlay category before this integration can run on a device or be submitted to the App Store.
• Content Eligibility: The content shown must belong to the approved category and be useful while driving. A general product changelog or developer-tools app is not eligible simply because the host app has a CarPlay entitlement.
• Entitlement Scope: Do not attempt to use unrelated audio or navigation entitlements to bypass these requirements.

When you set checkForUpdates: true and provide a remote data URL, SwiftNEW performs a version check:

1. It compares the highest subVersion (or version) found in the remote JSON against the currently installed app version.
2. If the remote version is newer, SwiftNEW displays an Update Screen instead of the standard release notes.
3. The update screen uses Apple's iTunes Lookup API to find the App Store destination using your app's bundle identifier.
4. The primary action button defaults to a localized 'Download Now' text, but you can customize this using updateButtonTitle.
5. To force users to update, set allowsSkippingUpdate: false.

SwiftNEW can automatically check for updates by providing a remote data URL and setting checkForUpdates: true.

If the highest subVersion (or version) in the remote JSON is newer than the installed app version, SwiftNEW will display an Update Screen instead of the standard 'What's New' screen. It uses the App Store's iTunes Lookup API to find the target app using your bundle identifier.

Key behaviors:

• Default Button: Displays a localized "Download Now" button.
• Custom Button: Use updateButtonTitle to provide custom text.
• Enforced Updates: Set allowsSkippingUpdate: false if you want to prevent users from skipping the update screen.

You can enable a remote update flow by passing a remote data URL and setting checkForUpdates: true.

Behavior:

• If the highest subVersion (or version) in the remote JSON is greater than the current installed app version, SwiftNEW will display an Update Screen instead of the standard 'What's New' screen.
• The update screen uses the app's bundle identifier to automatically fetch the App Store destination via the Apple iTunes Lookup API.
• The primary action button defaults to a localized 'Download Now' (or equivalent). You can customize this text using updateButtonTitle.
• To force users to update, set allowsSkippingUpdate: false to prevent them from dismissing the update screen.

If you provide a remote data URL and set checkForUpdates: true, SwiftNEWKit will automatically check for updates.

If the highest subVersion (or version if subVersion is missing) in the remote JSON is higher than the installed app version, SwiftNEWKit will display an update screen instead of the standard

You can configure SwiftNEW to check for remote updates by setting checkForUpdates: true and providing a remote data URL.

How it works:

1. SwiftNEW compares the highest subVersion (or version) in the remote JSON with the currently installed app version.
2. If the remote version is newer, it displays an update screen instead of the standard release notes.
3. It automatically fetches the App Store destination using Apple's iTunes Lookup API via your app's bundle identifier.

Customization:

• Use updateButtonTitle to change the text of the primary action (defaults to a localized "Download Now").
• Set allowsSkippingUpdate: false to force users to update before they can proceed.

SwiftNEW supports two ways to animate icons within a release note entry:

1. Replace Transition: Use icon and toIcon to define a single transition from one symbol to another.
2. Symbol Loop: Use the icons array to loop through a sequence of symbols.

If icons is provided, it takes precedence over icon and toIcon.

// Replace Transition
{
  "icon": "checkmark.shield",
  "toIcon": "shield.checkered",
  "title": "Compatibility",
  "subtitle": "Fixes",
  "body": "Improved platform support."
}

// Symbol Loop
{
  "icons": ["checkmark.shield", "shield.checkered", "sparkles"],
  "title": "Compatibility",
  "subtitle": "Fixes",
  "body": "Improved platform support."
}

On watchOS, SwiftNEW automatically uses compact layouts for the current version, history, and update screens.

Key behaviors:

• Space Saving: Release-note descriptions and Search controls are hidden by default. To enable them, pass showDescription: true or search: true.
• Visuals: watchOS 8–9 use solid fallbacks for Material backgrounds. watchOS 10 adds Material backgrounds, and watchOS 11 adds native MeshGradient. Older versions use a layered gradient fallback.
• Performance: Animation particle counts and liquid-mesh refresh rates are automatically reduced for Apple Watch.

Companion App Setup:

• SwiftNEW automatically uses WKCompanionAppBundleIdentifier if present.
• Use appStoreBundleIdentifier only if you need to explicitly override the App Store listing identifier.
• Important: Local data.json files must be included in the Watch target itself.