3.8.0 (#744)

mickael-menu · mickael-menu · commit f7d10d2bf587 · 2026-03-10T17:06:11.000+01:00
diff --git a/BuildTools/Sources/GeneratePodspecs/main.swift b/BuildTools/Sources/GeneratePodspecs/main.swift
@@ -83,6 +83,11 @@ func render(_ m: ModuleSpec) -> String {
         lines.append("  s.xcconfig      = { \(pairs) }")
     }
 
+    // Required for Swift `package` access level, which needs a -package-name compiler flag.
+    // SPM sets this automatically from Package.swift `name`; CocoaPods does not.
+    // All Readium modules share the same package name so that `package` access works across them.
+    lines.append("  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name \(packageName)' }")
+
     if !m.dependencies.isEmpty {
         lines.append("")
         for dep in m.dependencies {
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,9 @@
 
 All notable changes to this project will be documented in this file. Take a look at [the migration guide](docs/Migration%20Guide.md) to upgrade between two major versions.
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [3.8.0]
 
 ### Added
 
@@ -1151,3 +1153,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
 [3.5.0]: https://github.com/readium/swift-toolkit/compare/3.4.0...3.5.0
 [3.6.0]: https://github.com/readium/swift-toolkit/compare/3.5.0...3.6.0
 [3.7.0]: https://github.com/readium/swift-toolkit/compare/3.6.0...3.7.0
+[3.8.0]: https://github.com/readium/swift-toolkit/compare/3.7.0...3.8.0
diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ Guides are available to help you make the most of the toolkit.
 | Readium   | iOS  | Swift compiler | Xcode |
 |-----------|------|----------------|-------|
 | `develop` | 15.0 | 6.0            | 16.4  |
-| 3.7.0     | 15.0 | 6.0            | 16.4  |
+| 3.8.0     | 15.0 | 6.0            | 16.4  |
 | 3.0.0     | 13.4 | 5.10           | 15.4  |
 | 2.5.1     | 11.0 | 5.6.1          | 13.4  |
 | 2.5.0     | 10.0 | 5.6.1          | 13.4  |
@@ -129,7 +129,7 @@ If you're stuck, find more information at [developer.apple.com](https://develope
 Add the following to your `Cartfile`:
 
 ```
-github "readium/swift-toolkit" ~> 3.7.0
+github "readium/swift-toolkit" ~> 3.8.0
 ```
 
 Then, [follow the usual Carthage steps](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application) to add the Readium libraries to your project.
@@ -159,11 +159,11 @@ Add the following `pod` statements to your `Podfile` for the Readium libraries y
 source 'https://github.com/readium/podspecs'
 source 'https://cdn.cocoapods.org/'
 
-pod 'ReadiumShared', '~> 3.7.0'
-pod 'ReadiumStreamer', '~> 3.7.0'
-pod 'ReadiumNavigator', '~> 3.7.0'
-pod 'ReadiumOPDS', '~> 3.7.0'
-pod 'ReadiumLCP', '~> 3.7.0'
+pod 'ReadiumShared', '~> 3.8.0'
+pod 'ReadiumStreamer', '~> 3.8.0'
+pod 'ReadiumNavigator', '~> 3.8.0'
+pod 'ReadiumOPDS', '~> 3.8.0'
+pod 'ReadiumLCP', '~> 3.8.0'
 ```
 
 Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.
diff --git a/Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec b/Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumAdapterGCDWebServer"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Adapter to use GCDWebServer as an HTTP server in Readium"
   s.homepage      = "http://readium.github.io"
@@ -16,9 +16,10 @@ Pod::Spec.new do |s|
   s.platform      = :ios
   s.ios.deployment_target = "15.0"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
-  s.dependency 'ReadiumInternal', '~> 3.7.0'
-  s.dependency 'ReadiumShared', '~> 3.7.0'
+  s.dependency 'ReadiumInternal', '~> 3.8.0'
+  s.dependency 'ReadiumShared', '~> 3.8.0'
   s.dependency 'ReadiumGCDWebServer', '~> 4.0.0'
 
 end
diff --git a/Support/CocoaPods/ReadiumAdapterLCPSQLite.podspec b/Support/CocoaPods/ReadiumAdapterLCPSQLite.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumAdapterLCPSQLite"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Adapter to use SQLite.swift for the Readium LCP repositories"
   s.homepage      = "http://readium.github.io"
@@ -16,10 +16,11 @@ Pod::Spec.new do |s|
   s.platform      = :ios
   s.ios.deployment_target = "15.0"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
-  s.dependency 'ReadiumInternal', '~> 3.7.0'
-  s.dependency 'ReadiumShared', '~> 3.7.0'
-  s.dependency 'ReadiumLCP', '~> 3.7.0'
+  s.dependency 'ReadiumInternal', '~> 3.8.0'
+  s.dependency 'ReadiumShared', '~> 3.8.0'
+  s.dependency 'ReadiumLCP', '~> 3.8.0'
   s.dependency 'SQLite.swift', '~> 0.15.0'
 
 end
diff --git a/Support/CocoaPods/ReadiumInternal.podspec b/Support/CocoaPods/ReadiumInternal.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumInternal"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Private utilities used by the Readium modules"
   s.homepage      = "http://readium.github.io"
@@ -16,5 +16,6 @@ Pod::Spec.new do |s|
   s.platform      = :ios
   s.ios.deployment_target = "15.0"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
 end
diff --git a/Support/CocoaPods/ReadiumLCP.podspec b/Support/CocoaPods/ReadiumLCP.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumLCP"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium LCP"
   s.homepage      = "http://readium.github.io"
@@ -22,9 +22,10 @@ Pod::Spec.new do |s|
   s.platform      = :ios
   s.ios.deployment_target = "15.0"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
-  s.dependency 'ReadiumInternal', '~> 3.7.0'
-  s.dependency 'ReadiumShared', '~> 3.7.0'
+  s.dependency 'ReadiumInternal', '~> 3.8.0'
+  s.dependency 'ReadiumShared', '~> 3.8.0'
   s.dependency 'ReadiumZIPFoundation', '~> 3.0.1'
   s.dependency 'CryptoSwift', '~> 1.8.0'
 
diff --git a/Support/CocoaPods/ReadiumNavigator.podspec b/Support/CocoaPods/ReadiumNavigator.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumNavigator"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium Navigator"
   s.homepage      = "http://readium.github.io"
@@ -21,10 +21,11 @@ Pod::Spec.new do |s|
   s.swift_version = '5.10'
   s.platform      = :ios
   s.ios.deployment_target = "15.0"
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
-  s.dependency 'ReadiumInternal', '~> 3.7.0'
-  s.dependency 'ReadiumShared', '~> 3.7.0'
+  s.dependency 'ReadiumInternal', '~> 3.8.0'
+  s.dependency 'ReadiumShared', '~> 3.8.0'
   s.dependency 'DifferenceKit', '~> 1.0'
-  s.dependency 'SwiftSoup', '~> 2.7.0'
+  s.dependency 'SwiftSoup', '~> 2.11.0'
 
 end
diff --git a/Support/CocoaPods/ReadiumOPDS.podspec b/Support/CocoaPods/ReadiumOPDS.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumOPDS"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium OPDS"
   s.homepage      = "http://readium.github.io"
@@ -16,9 +16,10 @@ Pod::Spec.new do |s|
   s.platform      = :ios
   s.ios.deployment_target = "15.0"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
-  s.dependency 'ReadiumInternal', '~> 3.7.0'
-  s.dependency 'ReadiumShared', '~> 3.7.0'
+  s.dependency 'ReadiumInternal', '~> 3.8.0'
+  s.dependency 'ReadiumShared', '~> 3.8.0'
   s.dependency 'ReadiumFuzi', '~> 4.0.0'
 
 end
diff --git a/Support/CocoaPods/ReadiumShared.podspec b/Support/CocoaPods/ReadiumShared.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumShared"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium Shared"
   s.homepage      = "http://readium.github.io"
@@ -21,10 +21,11 @@ Pod::Spec.new do |s|
   s.frameworks    = "CoreServices"
   s.libraries     = 'xml2'
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
-  s.dependency 'ReadiumInternal', '~> 3.7.0'
+  s.dependency 'ReadiumInternal', '~> 3.8.0'
   s.dependency 'Minizip', '~> 1.0.0'
-  s.dependency 'SwiftSoup', '~> 2.13.0'
+  s.dependency 'SwiftSoup', '~> 2.11.0'
   s.dependency 'ReadiumFuzi', '~> 4.0.0'
   s.dependency 'ReadiumZIPFoundation', '~> 3.0.1'
 
diff --git a/Support/CocoaPods/ReadiumStreamer.podspec b/Support/CocoaPods/ReadiumStreamer.podspec
@@ -4,7 +4,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumStreamer"
-  s.version       = "3.7.0"
+  s.version       = "3.8.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium Streamer"
   s.homepage      = "http://readium.github.io"
@@ -23,9 +23,10 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = "15.0"
   s.libraries     = 'z', 'xml2'
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
+  s.pod_target_xcconfig = { 'OTHER_SWIFT_FLAGS' => '-package-name Readium' }
 
-  s.dependency 'ReadiumInternal', '~> 3.7.0'
-  s.dependency 'ReadiumShared', '~> 3.7.0'
+  s.dependency 'ReadiumInternal', '~> 3.8.0'
+  s.dependency 'ReadiumShared', '~> 3.8.0'
   s.dependency 'ReadiumFuzi', '~> 4.0.0'
   s.dependency 'CryptoSwift', '~> 1.8.0'
 
diff --git a/Support/CocoaPods/Specs.swift b/Support/CocoaPods/Specs.swift
@@ -5,14 +5,18 @@
 //
 
 /// Readium toolkit version — bump this when releasing a new version, then run `make podspecs`.
-let version = "3.7.0"
+let version = "3.8.0"
 
 /// Minimum iOS deployment target shared by all modules.
 let iosTarget = "15.0"
 
 /// Swift version requirement shared by all modules.
 let swiftVersion = "5.10"
 
+/// Swift package name (from Package.swift). All modules share this so that `package` access
+/// level works across module boundaries, matching the SPM build behaviour.
+let packageName = "Readium"
+
 // MARK: - Data model
 
 struct ModuleSpec {
@@ -55,7 +59,7 @@ let modules: [ModuleSpec] = [
         dependencies: [
             .readium("ReadiumInternal"),
             .pod("Minizip", "~> 1.0.0"),
-            .pod("SwiftSoup", "~> 2.13.0"),
+            .pod("SwiftSoup", "~> 2.11.0"),
             .pod("ReadiumFuzi", "~> 4.0.0"),
             .pod("ReadiumZIPFoundation", "~> 3.0.1"),
         ]
@@ -89,7 +93,7 @@ let modules: [ModuleSpec] = [
             .readium("ReadiumInternal"),
             .readium("ReadiumShared"),
             .pod("DifferenceKit", "~> 1.0"),
-            .pod("SwiftSoup", "~> 2.7.0"),
+            .pod("SwiftSoup", "~> 2.11.0"),
         ]
     ),
     ModuleSpec(
diff --git a/TestApp/Sources/Info.plist b/TestApp/Sources/Info.plist
@@ -252,9 +252,9 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>3.7.0</string>
+	<string>3.8.0</string>
 	<key>CFBundleVersion</key>
-	<string>3.7.0</string>
+	<string>3.8.0</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>LSSupportsOpeningDocumentsInPlace</key>
diff --git a/docs/Migration Guide.md b/docs/Migration Guide.md
@@ -2,7 +2,9 @@
 
 All migration steps necessary in reading apps to upgrade to major versions of the Swift Readium toolkit will be documented in this file.
 
-## Unreleased
+<!-- ## Unreleased -->
+
+## 3.8.0
 
 ### Removing the HTTP Server from the EPUB Navigator
 
diff --git a/docs/NavigatorOverview.md b/docs/NavigatorOverview.md
@@ -14,4 +14,6 @@ Learn about the architecture, configuration, and usage of the Readium Navigator.
 - <doc:Preferences>
 - <doc:SwiftUI>
 - <doc:Input>
+- <doc:Highlights>
+- <doc:Decorations>
 - <doc:EPUB-Fonts>
