javier
13b9c74a38
CI / Build and test (push) Canceled after 0s
Documentation / Build documentation (push) Canceled after 0s
Documentation / Deploy to GitHub Pages (push) Canceled after 0s
This PR contains the work done to fix a cancellation-mapping bug in `AmiiboLiveClient`, bring the client under offline test coverage, add the conformances SwiftUI and persistence need, and moves CI and documentation publishing to GitHub Actions. All public API changes are additive.
### Fix
- `AmiiboLiveClient` reported an early task cancellation as `.unknown("CancellationError()")`. The OpenAPI runtime wraps every error in `ClientError`, so the `CancellationError` check never matched; it now also checks the wrapped error and throws `.cancelled`.
### Tests
- `ThrowingTransport` and `StubTransport` test doubles let the live client run offline. New tests cover error mapping, HTTP status → error mapping, `oneOf` object-vs-list decoding, `"amiibo": null`, sorting, filter → query encoding, `Platform`/`Release` mapping, and the date transcoder.
- Models gained `package` memberwise initializers so tests can build real fixtures without `@testable`. These are not public API.
- The test target now depends on `OpenAPIRuntime` and `HTTPTypes` (both already in the dependency graph).
### API
- Models are `Codable` and `Identifiable` (`Amiibo.id` is its `identifier`; the key/name models use `key`).
- Filters are `Hashable`.
### Documentation
- Doc comments trimmed library-wide; one repeated `- Throws:` sentence appeared 24 times. `Library.md` and the README tightened to match.
### CI and docs publishing
- `ci.yml`: build and offline tests on PRs and pushes to `main`.
- `live-tests.yml`: weekly and on-demand run against the live API.
- `docs.yml`: builds DocC on PRs, deploys to GitHub Pages on `main`. Pinned to Xcode 26 because swift-docc-plugin 1.5.0 fails to launch its tools under Xcode 27.
- The generated `docs/` folder (327 files) is removed from the repository and ignored.
Reviewed-on: #31
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
119 lines
3.5 KiB
Swift
119 lines
3.5 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the Amiibo Service open source project
|
|
//
|
|
// Copyright (c) 2026 Röck+Cöde VoF. and the Amiibo Service project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of Amiibo Service project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
import Foundation
|
|
|
|
/// A model that represents an amiibo.
|
|
public struct Amiibo: Sendable, Hashable, Codable, Identifiable {
|
|
|
|
// MARK: Properties
|
|
|
|
/// The name of the game character associated with this amiibo.
|
|
public let gameCharacter: String
|
|
|
|
/// The name of the game series associated with this amiibo.
|
|
public let gameSeries: String
|
|
|
|
/// The first 8 hexadecimal characters of the amiibo identifier.
|
|
public let head: String
|
|
|
|
/// A URL string pointing to the image of this amiibo.
|
|
public let image: String
|
|
|
|
/// The name of this amiibo.
|
|
public let name: String
|
|
|
|
/// The related games of this amiibo, grouped by platform.
|
|
///
|
|
/// `nil` unless the request sets ``AmiiboFilter/showGames`` or ``AmiiboFilter/showUsage``, or when there are no related games.
|
|
public let platform: Platform?
|
|
|
|
/// The release dates of this amiibo across different regions.
|
|
public let release: Release
|
|
|
|
/// The name of the amiibo series this amiibo belongs to.
|
|
public let series: String
|
|
|
|
/// The last 8 hexadecimal characters of the amiibo identifier.
|
|
public let tail: String
|
|
|
|
/// The type of this amiibo (e.g., Figure, Card, Yarn, Band).
|
|
public let type: String
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Initializes this model.
|
|
package init(
|
|
head: String,
|
|
tail: String,
|
|
name: String,
|
|
type: String,
|
|
series: String,
|
|
gameCharacter: String,
|
|
gameSeries: String,
|
|
image: String,
|
|
release: Release = .init(),
|
|
platform: Platform? = nil
|
|
) {
|
|
self.gameCharacter = gameCharacter
|
|
self.gameSeries = gameSeries
|
|
self.head = head
|
|
self.image = image
|
|
self.name = name
|
|
self.platform = platform
|
|
self.release = release
|
|
self.series = series
|
|
self.tail = tail
|
|
self.type = type
|
|
}
|
|
|
|
/// Initializes this model from a given payload.
|
|
/// - Parameter payload: A payload that contains the values for the model.
|
|
init(_ payload: Components.Schemas.Amiibo) {
|
|
self.gameCharacter = payload.character
|
|
self.gameSeries = payload.gameSeries
|
|
self.head = payload.head
|
|
self.image = payload.image
|
|
self.name = payload.name
|
|
self.platform = .init(
|
|
payload.gamesSwitch,
|
|
payload.gamesSwitch2,
|
|
payload.games3DS,
|
|
payload.gamesWiiU
|
|
)
|
|
self.release = .init(payload.release)
|
|
self.series = payload.amiiboSeries
|
|
self.tail = payload.tail
|
|
self.type = payload._type
|
|
}
|
|
|
|
// MARK: Computed
|
|
|
|
/// The ``identifier`` of this amiibo.
|
|
public var id: String {
|
|
identifier
|
|
}
|
|
|
|
/// The full 16-character hexadecimal identifier, composed of the ``head`` and ``tail``.
|
|
public var identifier: String {
|
|
head + tail
|
|
}
|
|
|
|
/// A URL constructed from the ``image`` string, if valid.
|
|
public var imageURL: URL? {
|
|
.init(string: image)
|
|
}
|
|
|
|
}
|