javierandjavier
0c41e5d4ce
This PR contains the work done to cleans up the library after the Swift 6.2 migration: drops the legacy conditional-compilation paths, hardens the OpenAPI specification, removes boilerplate from the live client, and makes the live test suite resilient to changes in the upstream service data.
* Swift 6.2 baseline
* Adopted swift-tools-version: 6.2, which allowed removing every #if swift(>=6.0) / #if swift(>=6.2) branch and natural-language test names are now the only code paths.
* `AmiiboClient` client now refines `Sendable`, and both `AmiiboLiveClient` and `AmiiboService` conform to it, so instances can be shared across concurrency domains.
* Live client
* Extracted a generic `perform(_:)` helper that wraps every generated API call and funnels transport errors through the existing error mapper — replaces six repeated do/catch blocks and lets the private fetch* methods use typed throws end-to-end.
* Added the internal `KeyNamePayload` protocol and a generic makeModels(from:), collapsing the four near-identical mapping/sorting blocks for amiibo series, types, game characters and game series into one.
* The server URL is now resolved once into a static let constant instead of on every initialization.
* Improved error mapping: URLError.cancelled → .cancelled, .cannotParseResponse → .decoding, and .dataNotAllowed, .internationalRoamingOff, .secureConnectionFailed now map to .notAvailable.
* Simplified the Amiibo.Platform initializer ([Amiibo+Platform.swift](vscode-webview://1m6rk4uhpaukb4hrbp3j54p77iq693fq2ql7o9oup2pca1omf7f6/Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Platform.swift)) using optional chaining and ?? [] instead of nested guards and immediately-invoked closures.
* Set the en_US_POSIX locale on both fixed-format date formatters so the user's locale or 12/24-hour setting can no longer break parsing.
* OpenAPI specification
* Replaced the shared Tuple schema with explicit per-type schemas (AmiiboSeries, AmiiboType, GameCharacter, GameSeries), so the generated code exposes real properties instead of allOf wrappers with .value1 accessors.
* Extracted named list schemas (AmiiboList, AmiiboSeriesList, …) for the wrapper payloads, which turns the generated .case2 enum cases into readable .AmiiboSeriesList cases.
* Added validation patterns and length bounds to the id, head, tail and key query parameters, and collapsed the redundant pattern/minLength/maxLength triplets on head/tail into ^[0-9a-fA-F]{8}$.
* Extracted the shared InternalServerError response, replacing the five inline 500 descriptions.
* Documented the two non-standard date/time decoding behaviours (date-only strings for release dates, offset-less timestamps for lastUpdated) and why the optional amiibo wrapper property must stay optional.
* Corrected the info.version value from v1.0.0 to 1.0.0.
* ⚠️ Breaking changes
* Minimum Swift version raised from 5.10 to 6.2.
* `AmiiboServiceError.unknown` now carries a String description of the underlying error.
* `AmiiboClient` requires Sendable conformance, so existing custom mock clients must be Sendable.
Reviewed-on: #28
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
15 KiB
JSON
1 line
15 KiB
JSON
{"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"externalID":"s:13AmiiboService0A10LiveClientV","symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"AmiiboLiveClient"}],"modules":[{"name":"AmiiboService"}],"roleHeading":"Structure","title":"AmiiboLiveClient","role":"symbol"},"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","doc:\/\/AmiiboService\/s8CopyableP","doc:\/\/AmiiboService\/s9EscapableP","doc:\/\/AmiiboService\/s8SendableP","doc:\/\/AmiiboService\/s16SendableMetatypeP"],"type":"conformsTo"}],"seeAlsoSections":[{"title":"Clients","generated":true,"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"],"anchor":"Clients"}],"abstract":[{"text":"A type that implements a live client to the ","type":"text"},{"isActive":true,"identifier":"https:\/\/www.amiiboapi.org","type":"reference"},{"text":" online service.","type":"text"}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)"],"anchor":"Initializers"},{"title":"Amiibo endpoints","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)"],"anchor":"Amiibo-endpoints"},{"title":"Game endpoints","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)"],"anchor":"Game-endpoints"},{"title":"System endpoints","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()"],"anchor":"System-endpoints"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/AmiiboClient-Implementations"],"anchor":"Default-Implementations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}]}]},{"content":[{"anchor":"overview","level":2,"text":"Overview","type":"heading"},{"inlineContent":[{"type":"text","text":"This client maps any transport error or unsuccessful HTTP response to an "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","isActive":true},{"type":"text","text":" error, and sorts the items of the list responses in ascending order by identifier or key."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboliveclient"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/init(transport:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"transport"},{"kind":"text","text":": "},{"kind":"keyword","text":"any"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","text":"ClientTransport"},{"kind":"text","text":")"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient\/init(transport:)","type":"topic","abstract":[{"text":"Initializes this client with a transport for performing HTTP operations.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init(transport:)","kind":"symbol","title":"init(transport:)","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient","role":"symbol","type":"topic","title":"AmiiboLiveClient","abstract":[{"type":"text","text":"A type that implements a live client to the "},{"isActive":true,"type":"reference","identifier":"https:\/\/www.amiiboapi.org"},{"type":"text","text":" online service."}],"kind":"symbol","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboclient","role":"symbol","type":"topic","title":"AmiiboClient","abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"kind":"symbol","navigatorTitle":[{"text":"AmiiboClient","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getGameSeries(by:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","kind":"typeIdentifier","text":"GameSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","kind":"typeIdentifier","text":"GameSeries"},{"kind":"text","text":"]"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgameseries(by:)","type":"topic","abstract":[{"type":"text","text":"Gets a list of game series based on a given filter."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)","kind":"symbol","title":"getGameSeries(by:)","role":"symbol"},"doc://AmiiboService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s8SendableP","title":"Swift.Sendable"},"doc://AmiiboService/documentation/AmiiboService":{"abstract":[{"type":"text","text":"A library that provides everything the developer needs to interact with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","url":"\/documentation\/amiiboservice","kind":"symbol","title":"AmiiboService","role":"collection"},"doc://AmiiboService/s8CopyableP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s8CopyableP","title":"Swift.Copyable"},"doc://AmiiboService/s9EscapableP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s9EscapableP","title":"Swift.Escapable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getGameCharacters(by:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameCharacters"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"GameCharacterFilter","preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"GameCharacter","preciseIdentifier":"s:13AmiiboService13GameCharacterV"},{"kind":"text","text":"]"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgamecharacters(by:)","type":"topic","abstract":[{"text":"Gets a list of game characters based on a given filter.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","kind":"symbol","title":"getGameCharacters(by:)","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboTypes(by:)":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibotypes(by:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)","abstract":[{"text":"Gets a list of amiibo types based on a given filter.","type":"text"}],"type":"topic","title":"getAmiiboTypes(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A10TypeFilterV","kind":"typeIdentifier","text":"AmiiboTypeFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService0A4TypeV","kind":"typeIdentifier","text":"AmiiboType"},{"kind":"text","text":"]"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/AmiiboClient-Implementations":{"url":"\/documentation\/amiiboservice\/amiiboliveclient\/amiiboclient-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/AmiiboClient-Implementations","kind":"article","title":"AmiiboClient Implementations","role":"collectionGroup"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"type":"topic","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"title":"AmiiboService","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboService","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","url":"\/documentation\/amiiboservice\/amiiboservice","role":"symbol","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getLastUpdated()":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLastUpdated","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"AmiiboServiceError","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getlastupdated()","type":"topic","abstract":[{"text":"Gets the date when the data was last updated.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()","kind":"symbol","title":"getLastUpdated()","role":"symbol"},"doc://AmiiboService/s16SendableMetatypeP":{"identifier":"doc:\/\/AmiiboService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror","role":"symbol","type":"topic","title":"AmiiboServiceError","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service could throw."}],"kind":"symbol","navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiibos(by:)":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibos(by:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","abstract":[{"type":"text","text":"Gets a list of amiibo items based on a given filter."}],"type":"topic","title":"getAmiibos(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A6FilterV","kind":"typeIdentifier","text":"AmiiboFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService0A0V","kind":"typeIdentifier","text":"Amiibo"},{"kind":"text","text":"]"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboSeries(by:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries"},{"kind":"text","text":"]"}],"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiiboseries(by:)","type":"topic","abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","kind":"symbol","title":"getAmiiboSeries(by:)","role":"symbol"},"https://www.amiiboapi.org":{"identifier":"https:\/\/www.amiiboapi.org","title":"Amiibo API","url":"https:\/\/www.amiiboapi.org","titleInlineContent":[{"text":"Amiibo API","type":"text"}],"type":"link"}}} |