2b01ec14bf
This PR contains the work done to update the live tests to the latest data plus lots of QoL improvements to the library, including: * added test cases to test the ``AmiiboService` locally; * conformed the models to the `Hashable` protocol; * documented the use of caching with the `AmiiboService` service; * updated the reference to the new AmiiboAPI url; * updated the year on the copyrights and header files; * updated the overall documentation of the source code and the package. Reviewed-on: #22 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
48 lines
1.5 KiB
Swift
48 lines
1.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
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
extension Amiibo {
|
|
/// A model that represents a game related to an amiibo.
|
|
public struct Game: Sendable, Hashable {
|
|
|
|
// MARK: Properties
|
|
|
|
/// A list of game identifiers associated with this game.
|
|
public let identifiers: [String]
|
|
|
|
/// The name of this game.
|
|
public let name: String
|
|
|
|
/// A list of amiibo usages within this game, if available.
|
|
public let usages: [Usage]?
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Initializes this model from a given payload.
|
|
/// - Parameter payload: A payload that contains the values for the model.
|
|
init(_ payload: Components.Schemas.AmiiboGame) {
|
|
self.identifiers = payload.gameID
|
|
self.name = payload.gameName
|
|
self.usages = {
|
|
guard let usages = payload.amiiboUsage else {
|
|
return nil
|
|
}
|
|
|
|
return usages.map { .init($0) }
|
|
}()
|
|
}
|
|
|
|
}
|
|
}
|