Skip to content

Clean up deprecated APIs #594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 15, 2025
Merged

Clean up deprecated APIs #594

merged 2 commits into from
May 15, 2025

Conversation

mickael-menu
Copy link
Member

No description provided.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes a variety of deprecated APIs throughout the codebase to streamline the interface and enforce the new async and migration patterns. Key changes include:

  • Removal of deprecated properties, functions, and typealiases from Publication, Navigator, and LCP-related modules.
  • Complete removal of unused files such as PublicationAsset.swift, FileAsset.swift, UserSettings.swift, and LCPAcquisition.swift.
  • Replacement of synchronous APIs with asynchronous variants and updated usage patterns.

Reviewed Changes

Copilot reviewed 53 out of 53 changed files in this pull request and generated no comments.

Show a summary per file
File Description
Sources/Shared/Publication/Link.swift Removed deprecated property and copy methods to enforce the new API usage.
Sources/Shared/Publication/Asset/PublicationAsset.swift Removed the deprecated PublicationAsset protocol and its dependencies.
Sources/Shared/Publication/Asset/FileAsset.swift Removed the legacy file-based asset representation.
Sources/Shared/Logger/Logger.swift Removed the deprecated logging function in favor of the updated log initializer.
Sources/Navigator/VisualNavigator.swift Removed deprecated extensions and alias methods, promoting the async variants.
Sources/Navigator/TTS/TTSEngine.swift Removed the synchronous speak API in favor of its async variant.
Sources/Navigator/TTS/AVTTSEngine.swift Removed the legacy init with audio session configuration.
Sources/Navigator/PDF/PDFNavigatorViewController.swift Removed deprecated PDF view customization method.
Sources/Navigator/Navigator.swift Removed synchronous navigation methods to standardize async navigation.
Sources/Navigator/EditingAction.swift Removed deprecated alias for defining actions.
Sources/Navigator/EPUB/UserSettings.swift Removed the legacy user settings API to support the new Preferences API.
Sources/Navigator/EPUB/EPUBNavigatorViewModel.swift Removed the deprecated convenience initializer in favor of the designated initializer.
Sources/Navigator/EPUB/EPUBNavigatorViewController.swift Removed deprecated properties and functions related to user settings and evaluation APIs.
Sources/Navigator/CBZ/CBZNavigatorViewController.swift Removed deprecated initializers and property aliases for CBZ publications.
Sources/Navigator/Audiobook/AudioNavigator.swift Removed deprecated typealiases for audio navigation.
Sources/LCP/License/Model/Components/Link.swift Removed deprecated URL expansion API, now using url() instead.
Sources/LCP/LCPService.swift Removed an outdated initializer and related functions that conflict with the new migration guide.
Sources/LCP/LCPLicense.swift Removed deprecated loan renewal and return APIs in favor of async variants.
Sources/LCP/LCPAcquisition.swift Removed the entire legacy acquisition API file.
Sources/Adapters/GCDWebServer/GCDHTTPServer.swift Removed the deprecated shared instance, encouraging users to create their own instances.

@mickael-menu mickael-menu merged commit 163a235 into develop May 15, 2025
5 checks passed
@mickael-menu mickael-menu deleted the remove-deprecated branch May 15, 2025 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant