Merge branch 'develop' into documentation

Author: mickael-menu

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,85 @@
+name: Bug report
+description: File a bug report to help improve the Readium toolkit
+title: "[Bug] "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filing a bug report! Please [search for existing issues](https://github.com/readium/swift-toolkit/issues?q=is:issue) before submitting.
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: Also, please let us know what your expectations were.
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: bug-steps
+    attributes:
+      label: How to reproduce?
+      description: |
+        Step by step explanation to reproduce the issue in the Test App.
+
+        If you can, drag and drop:
+        - the publication used to reproduce the problem, after zipping it.
+        - screenshots or a screencast showing the issue
+
+      placeholder: |
+        1. Open book X
+        2. Go to chapter Y
+        3. Swipe left twice
+        4. See error
+        ...
+    validations:
+      required: true
+  - type: input
+    id: bug-readium-version
+    attributes:
+      label: Readium version
+      description: What version of the Readium toolkit are you running?
+    validations:
+      required: true
+  - type: input
+    id: bug-os-version
+    attributes:
+      label: OS version
+      description: On which OS version(s) did you reproduce the problem?
+      placeholder: iOS 17.0.1
+    validations:
+      required: true
+  - type: input
+    id: bug-device
+    attributes:
+      label: Testing device
+      description: On which Apple device did you reproduce the problem?
+      placeholder: iPhone 15 Pro Max (emulator)
+    validations:
+      required: true
+  - type: textarea
+    id: bug-environment
+    attributes:
+      label: Environment
+      description: |
+        Run the following shell commands and paste the result here:
+        ```shell
+        echo "macOS: `sw_vers -productVersion`"
+        echo "platform: `uname -m`"
+        echo "carthage: `carthage version`"
+        xcodebuild -version
+        ```
+      placeholder: |
+        macOS: 14.1.2
+        platform: arm64
+        carthage: 0.39.1
+        Xcode 15.1
+        Build version 15C65
+      render: bash
+  - type: textarea
+    id: bug-additional
+    attributes:
+      label: Additional context
+      description: |
+        Share additional code showing how you use Readium, if relevant. Output logs are useful as well.
+        If you already went through the codebase to find the bug, you can explain your findings here.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/config.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install dependencies
         run: |
           brew update
@@ -33,10 +33,12 @@ jobs:
           git diff --exit-code Support/Carthage/Readium.xcodeproj
       - name: Build
         run: |
-          xcodebuild build-for-testing -scheme "$scheme" -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build-for-testing -scheme "$scheme" -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
       - name: Test
         run: |
-          xcodebuild test-without-building -scheme "$scheme" -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild test-without-building -scheme "$scheme" -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   lint:
     name: Lint
@@ -47,13 +49,24 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          package_json_file: Sources/Navigator/EPUB/Scripts/package.json
+          run_install: false
+      - name: Setup cache
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'pnpm'
+          cache-dependency-path: Sources/Navigator/EPUB/Scripts/pnpm-lock.yaml
       - name: Install dependencies
-        run: yarn --cwd "$scripts" install --frozen-lockfile
-      - name: Lint JavaScript
-        run: yarn --cwd "$scripts" run lint
-      - name: Check JavaScript formatting
-        run: yarn --cwd "$scripts" run checkformat
+        run: pnpm --dir "$scripts" install --frozen-lockfile
+      - name: Lint
+        run: pnpm --dir "$scripts" run lint
+      - name: Check formatting
+        run: pnpm --dir "$scripts" run checkformat
       - name: Check if bundled scripts are up-to-date
         run: |
             make scripts
@@ -71,7 +84,7 @@ jobs:
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install dependencies
         run: |
           brew update
@@ -80,7 +93,8 @@ jobs:
         run: make dev lcp=${{ secrets.LCP_URL_SPM }}
       - name: Build
         run: |
-          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   int-spm:
     name: Integration (Swift Package Manager)
@@ -92,7 +106,7 @@ jobs:
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       # We can't use the current github.sha with pull_request event, because they will
       # reference the merge commit which cannot be fetched with SPM.
       - name: Set commit SHA
@@ -107,7 +121,8 @@ jobs:
         run: make spm lcp=${{ secrets.LCP_URL_SPM }} commit=$commit_sha
       - name: Build
         run: |
-          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   int-carthage:
     name: Integration (Carthage)
@@ -119,7 +134,7 @@ jobs:
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       # We can't use the current github.sha with pull_request event, because they will
       # reference the merge commit which cannot be fetched with Carthage.
       - name: Set commit SHA
@@ -134,7 +149,8 @@ jobs:
         run: make carthage lcp=${{ secrets.LCP_URL_CARTHAGE }} commit=$commit_sha
       - name: Build
         run: |
-          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
   # Warning: This job cannot actually test the state of the current commit,
   # but will check that the latest branch/tag set in the Podspecs are valid.
@@ -148,7 +164,7 @@ jobs:
     environment: LCP
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Install dependencies
         run: |
           brew update
@@ -157,4 +173,5 @@ jobs:
         run: make cocoapods lcp=${{ secrets.LCP_URL_COCOAPODS }} commit=$commit_sha
       - name: Build
         run: |
-          xcodebuild build -workspace TestApp.xcworkspace -scheme TestApp -destination "platform=$platform,name=$device"
+          set -eo pipefail
+          xcodebuild build -workspace TestApp.xcworkspace -scheme TestApp -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi

.github/workflows/checks.yml

@@ -1,5 +1,5 @@
 //
-//  Copyright 2023 Readium Foundation. All rights reserved.
+//  Copyright 2024 Readium Foundation. All rights reserved.
 //  Use of this source code is governed by the BSD-style license
 //  available in the top-level LICENSE file of the project.
 //

BuildTools/Empty.swift

@@ -4,15 +4,35 @@ All notable changes to this project will be documented in this file. Take a look
 
 **Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [2.7.0]
+
+### Added
+
+#### Shared
+
+* You can now use `DefaultHTTPClientDelegate.httpClient(_:request:didReceive:completion:)` to handle authentication challenges (e.g. Basic) with `DefaultHTTPClient`.
+
+#### Navigator
+
+* The `AudioNavigator` API has been promoted to stable and ships with a new Preferences API.
+* The new `NavigatorDelegate.didFailToLoadResourceAt(_:didFailToLoadResourceAt:withError:)` delegate API notifies when an error occurs while loading a publication resource (contributed by [@ettore](https://github.com/readium/swift-toolkit/pull/400)).
 
 ### Fixed
 
+* [#390](https://github.com/readium/swift-toolkit/issues/390) Fixed logger not logging above the minimum severity level (contributed by [@ettore](https://github.com/readium/swift-toolkit/pull/391)).
+
 #### Navigator
 
 * From iOS 13 to 15, PDF text selection is disabled on protected publications disabling the **Copy** editing action.
 * The **Share** editing action is disabled for any protected publication.
 * Fixed starting the TTS from the current EPUB position.
+* [#396](https://github.com/readium/swift-toolkit/issues/396) Ensure we stop the activity indicator when an EPUB resource fails to load correctly (contributed by [@ettore](https://github.com/readium/swift-toolkit/pull/397)).
+
+#### Streamer
+
+* [#399](https://github.com/readium/swift-toolkit/discussions/399) Zipped Audio Books and standalone audio files are now recognized.
 
 
 ## [2.6.1]
@@ -643,3 +663,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
 [2.5.1]: https://github.com/readium/swift-toolkit/compare/2.5.0...2.5.1
 [2.6.0]: https://github.com/readium/swift-toolkit/compare/2.5.1...2.6.0
 [2.6.1]: https://github.com/readium/swift-toolkit/compare/2.6.0...2.6.1
+[2.7.0]: https://github.com/readium/swift-toolkit/compare/2.6.1...2.7.0

CHANGELOG.md

@@ -2,7 +2,7 @@ github "cezheng/Fuzi" ~> 3.1.3
 github "dexman/Minizip" ~> 1.4.0
 github "krzyzanowskim/CryptoSwift" == 1.5.1 # From 1.6.0, the build fails in GitHub actions
 github "ra1028/DifferenceKit" ~> 1.3.0
-github "readium/GCDWebServer" ~> 3.7.4
+github "readium/GCDWebServer" ~> 4.0.0
 github "scinfu/SwiftSoup" == 2.5.3 # 2.6.0 requires Xcode 14
 github "stephencelis/SQLite.swift" == 0.13.3 # 0.14 introduces a breaking change
 github "weichsel/ZIPFoundation" == 0.9.11 # 0.9.12 requires iOS 12+

Cartfile

@@ -2,6 +2,29 @@
 
 All migration steps necessary in reading apps to upgrade to major versions of the Swift Readium toolkit will be documented in this file.
 
+## 2.7.0
+
+### `AudioNavigator` is now stable
+
+`AudioNavigator` is now stable. Follow the deprecation errors to automatically rename the types.
+
+All the setting properties (e.g. `navigator.rate`) are now in `navigator.settings`.
+
+### GCDWebServer was renamed
+
+To avoid [name collision with GCDWebServer](https://github.com/readium/swift-toolkit/issues/402), we renamed [our fork](https://github.com/readium/gcdwebserver) to `ReadiumGCDWebServer`. You will need to update your project to replace the old dependency:
+
+* Swift Package Manager: There's nothing to do.
+* Carthage:
+    * Update the Carthage dependencies and make sure the new `ReadiumGCDWebServer.xcframework` was built.
+    * Replace `GCDWebServer.xcframework` with `ReadiumGCDWebServer.xcframework` in your project.
+* CocoaPods:
+    * Replace the `pod 'GCDWebServer'` statement in your `Podfile` with the following, before running `pod install`.
+        ```
+        pod 'ReadiumGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/4.0.0/GCDWebServer.podspec'
+        ```
+
+
 ## 2.5.0
 
 In the following migration steps, only the `ReadiumInternal` one is mandatory with 2.5.0.