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>
10 lines
3.2 KiB
JavaScript
10 lines
3.2 KiB
JavaScript
/*!
|
|
* This source file is part of the Swift.org open source project
|
|
*
|
|
* Copyright (c) 2021 Apple Inc. and the Swift project authors
|
|
* Licensed under Apache License v2.0 with Runtime Library Exception
|
|
*
|
|
* See https://swift.org/LICENSE.txt for license information
|
|
* See https://swift.org/CONTRIBUTORS.txt for Swift project authors
|
|
*/
|
|
"use strict";(self["webpackChunkswift_docc_render"]=self["webpackChunkswift_docc_render"]||[]).push([[507],{3509:function(e,n,a){function s(e){return e?"string"===typeof e?e:e.source:null}function t(...e){return e.map(e=>s(e)).join("")}function c(e){const n={keyword:["abstract","amends","as","case","class","const","delete","else","extends","external","fixed","for","function","hidden","if","import","import*","in","is","let","local","module","new","open","out","outer","override","protected","read","read*","read?","record","super","switch","this","throw","trace","typealias","unknown","vararg","when"],literal:["true","false","null","nothing"]},a="[a-zA-Z_][a-zA-Z0-9_]*",s=/`[^`]+`/,c={className:"title",begin:a},i={className:"title",begin:s},r={className:"title",variants:[c,i]},o="([0-9]_*)+",l="([0-9a-fA-F]_*)+",d={className:"number",relevance:0,variants:[{match:`\\b(${o})(\\.(${o}))?([eE][+-]?(${o}))?\\b`},{match:`\\b0x(${l})(\\.(${l}))?([pP][+-]?(${o}))?\\b`},{match:/\b0o([0-7]_*)+\b/},{match:/\b0b([01]_*)+\b/}]},m=(e="")=>({className:"subst",variants:[{match:t(/\\/,e,/[0\\tnr"']/)},{match:t(/\\/,e,/u\{[0-9a-fA-F]{1,8}}/)}]}),b=(e="")=>({className:"subst",label:"interpol",begin:t(/\\/,e,/\(/),end:/\)/}),u=(e="")=>({begin:t(e,/"""/),end:t(/"""/,e),contains:[m(e),b(e)]}),p=(e="")=>({begin:t(e,/"/),end:t(/"/,e),contains:[m(e),b(e)]}),_=(e="")=>({begin:t(e,/"/),end:t(/"/,e),contains:[m(e)]}),N={className:"string",variants:[u(),u("#"),u("##"),u("###"),p(),p("#"),p("##"),p("###")]},g={className:"string",variants:[_(),_("#"),_("##"),_("##")]},f=e.COMMENT("///","$",{className:"doctag",relevance:10}),M={className:"meta",begin:/@[a-zA-Z_][a-zA-Z0-9_]*/,relevance:5},h={className:"function",beginKeywords:"function",end:/[={]/,excludeEnd:!0,contains:[r,{className:"params",begin:/\(/,end:/\)/,contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,r]}]},y={className:"class",beginKeywords:"class",end:/[{]|$/,excludeEnd:!0,contains:[r,{beginKeywords:"extends"},{begin:/</,end:/>/,contains:["self"]}]},E={className:"type",beginKeywords:"typealias",end:/$/,contains:[r,{begin:/=\s*/,returnBegin:!0,contains:[]}]},w={className:"meta",variants:[{begin:/^\s*(module|amends|extends)\s+/,end:/$/,contains:[{className:"keyword",begin:/(module|amends|extends)/},g]}]},C={className:"meta",begin:/\b(import|import\*)\s+/,end:/$/,keywords:{keyword:["import","import*","as"]},contains:[g]},O={className:"type",begin:/:\s*/,end:/(?=[=,)\]}]|$)/,excludeBegin:!0,contains:[{className:"type",begin:a},e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},v={variants:[{match:[/\.|\?\./,/\s*/,s],scope:{3:"property"}},{match:[/\.|\?\./,/\s*/,a],scope:{3:"property"}}]},k={variants:[{match:[s,/\s*/,/(?=[=:{])/],scope:{1:"property"}},{match:[a,/\s*/,/(?=[=:{])/],scope:{1:"property"}}]};return{name:"Pkl",aliases:["pkl"],keywords:n,contains:[f,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,w,C,M,y,h,E,v,O,k,N,d]}}a.r(n),a.d(n,{default:function(){return i}});var i=c}}]); |