-
Notifications
You must be signed in to change notification settings - Fork 25
/
Contracts.swift
1468 lines (1301 loc) · 47.5 KB
/
Contracts.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright IBM Corporation 2017
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
**/
import Foundation
// MARK
/**
An error representing a failed request.
This definition is intended to be used by both the client side (e.g. KituraKit)
and server side (e.g. Kitura) of the request (typically a HTTP REST request).
### Usage Example: ###
In this example, the `RequestError` is used in a Kitura server Codable route handler to
indicate the request has failed because the requested record was not found.
````swift
router.get("/users") { (id: Int, respondWith: (User?, RequestError?) -> Void) in
...
respondWith(nil, RequestError.notFound)
...
}
````
*/
public struct RequestError: RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible {
/**
A typealias representing the type of error that has occurred.
The range of error codes from 100 up to 599 are reserved for HTTP status codes.
Custom error codes may be used and must not conflict with this range.
*/
public typealias RawValue = Int
/**
Representation of the error body.
May be a type-erased Codable object or a Data (in a particular format).
*/
public enum ErrorBody {
/// Codable object.
case codable(Codable)
/// Data object.
case data(Data, BodyFormat)
}
// MARK: Creating a RequestError from a numeric code
/**
Creates an error representing the given error code.
- parameter rawValue: An Int indicating an error code representing the type of error that has occurred.
*/
public init(rawValue: Int) {
self.rawValue = rawValue
self.reason = "error_\(rawValue)"
}
/**
Creates an error representing the given error code and reason string.
- parameter rawValue: An Int indicating an error code representing the type of error that has occurred.
- parameter reason: A human-readable description of the error code.
*/
public init(rawValue: Int, reason: String) {
self.rawValue = rawValue
self.reason = reason
}
/**
Creates an error representing the given base error, with a custom
response body given as a Codable.
- parameter base: A `RequestError` object.
- parameter body: A representation of the error body - an object representing further details of the failure.
*/
public init<Body: Codable>(_ base: RequestError, body: Body) {
self.rawValue = base.rawValue
self.reason = base.reason
self.body = .codable(body)
self.bodyDataEncoder = { format in
switch format {
case .json: return try JSONEncoder().encode(body)
default: throw UnsupportedBodyFormatError(format)
}
}
}
/**
Creates an error respresenting the given base error, with a custom
response body given as Data and a BodyFormat.
- parameter base: A `RequestError` object.
- parameter bodyData: A `Data` object.
- parameter format: A `BodyFormat` object used to check whether it is legal JSON.
- throws: An `UnsupportedBodyFormatError` if the provided `BodyFormat`
is not supported.
*/
public init(_ base: RequestError, bodyData: Data, format: BodyFormat) throws {
self.rawValue = base.rawValue
self.reason = base.reason
self.body = .data(bodyData, format)
switch format {
case .json: break
default: throw UnsupportedBodyFormatError(format)
}
}
// MARK: Accessing information about the error
/**
An error code representing the type of error that has occurred.
The range of error codes from 100 up to 599 are reserved for HTTP status codes.
Custom error codes may be used and must not conflict with this range.
*/
public let rawValue: Int
/**
A human-readable description of the error code.
*/
public let reason: String
/**
Representation of the error body - an object representing further
details of the failure.
The value may be:
- `nil` if there is no body
- a (type-erased) Codable object if the error was initialized with `init(_:body:)`
- bytes of data and a signifier of the format in which they are stored (eg: JSON)
if the error was initialized with `init(_:bodyData:format:)`
### Usage example: ###
````swift
if let errorBody = error.body {
switch error.body {
case let .codable(body): ... // body is Codable
case let .data(bytes, format): ... // bytes is Data, format is BodyFormat
}
}
````
- Note: If you need a Codable representation and the body is data, you
can call the `bodyAs(_:)` function to get the converted value.
*/
public private(set) var body: ErrorBody? = nil
// A closure used to hide the generic type of the Codable body
// for later encoding to Data.
private var bodyDataEncoder: ((BodyFormat) throws -> Data)? = nil
/**
Returns the Codable error body encoded into bytes in a given format (eg: JSON).
This function should be used if the RequestError was created using
`init(_:body:)`, otherwise it will return `nil`.
- Note: This function is primarily intended for use by the Kitura Router so
that it can encode and send a custom error body returned from
a codable route.
### Usage Example: ###
````swift
do {
if let errorBodyData = try error.encodeBody(.json) {
...
}
} catch {
// Handle the failure to encode
}
````
- parameter format: Describes the format that should be used
(for example: `BodyFormat.json`).
- returns: The `Data` object or `nil` if there is no body, or if the
error was not initialized with `init(_:body:)`.
- throws: An `EncodingError` if the encoding fails.
- throws: An `UnsupportedBodyFormatError` if the provided `BodyFormat`
is not supported.
*/
public func encodeBody(_ format: BodyFormat) throws -> Data? {
guard case .codable? = body else { return nil }
return try bodyDataEncoder?(format)
}
/**
Returns the Data error body as the requested `Codable` type.
This function should be used if the RequestError was created using
`init(_:bodyData:format:)`, otherwise it will return `nil`.
This function throws; you can use `bodyAs(_:)` instead if you want
to ignore DecodingErrors.
- Note: This function is primarily intended for use by users of KituraKit
or similar client-side code that needs to convert a custom error
response from `Data` to a `Codable` type.
### Usage Example: ###
````swift
do {
if let errorBody = try error.decodeBody(MyCodableType.self) {
...
}
} catch {
// Handle failure to decode
}
````
- parameter type: The type of the value to decode from the body data
(for example: `MyCodableType.self`).
- returns: The `Codable` object or `nil` if there is no body or if the
error was not initialized with `init(_:bodyData:format:)`.
- throws: A `DecodingError` if decoding fails.
*/
public func decodeBody<Body: Codable>(_ type: Body.Type) throws -> Body? {
guard case let .data(bodyData, format)? = body else { return nil }
switch format {
case .json: return try JSONDecoder().decode(type, from: bodyData)
default: throw UnsupportedBodyFormatError(format)
}
}
/**
Returns the Data error body as the requested `Codable` type.
This function should be used if the RequestError was created using
`init(_:bodyData:format:)`, otherwise it will return `nil`.
This function ignores DecodingErrors, and returns `nil` if decoding
fails. If you want DecodingErrors to be thrown, use `decodeBody(_:)`
instead.
- Note: This function is primarily intended for use by users of KituraKit
or similar client-side code that needs to convert a custom error
response from `Data` to a `Codable` type.
### Usage Example: ###
````swift
if let errorBody = error.bodyAs(MyCodableType.self) {
...
}
````
- parameter type: The type of the value to decode from the body data
(for example: `MyCodableType.self`).
- returns: The `Codable` object or `nil` if there is no body, or if the
error was not initialized with `init(_:bodyData:format:)`, or
if decoding fails.
*/
public func bodyAs<Body: Codable>(_ type: Body.Type) -> Body? {
return (try? decodeBody(type)) ?? nil
}
// MARK: Comparing RequestErrors
/**
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
*/
public static func < (lhs: RequestError, rhs: RequestError) -> Bool {
return lhs.rawValue < rhs.rawValue
}
/**
Indicates whether two URLs are the same.
*/
public static func == (lhs: RequestError, rhs: RequestError) -> Bool {
return (lhs.rawValue == rhs.rawValue && lhs.reason == rhs.reason)
}
// MARK: Describing a RequestError
/**
A textual description of the RequestError instance containing the error code and reason.
*/
public var description: String {
return "\(rawValue) : \(reason)"
}
/**
The computed hash value for the RequestError instance.
*/
public var hashValue: Int {
let str = reason + String(rawValue)
return str.hashValue
}
}
/**
Extends `RequestError` to provide HTTP specific error code and reason values.
*/
extension RequestError {
/**
The HTTP status code for the error.
This value should be a valid HTTP status code if inside the range 100 to 599,
however, it may take a value outside that range when representing other types
of error.
*/
public var httpCode: Int {
return rawValue
}
/**
Creates an error representing a HTTP status code.
- Parameter httpCode: A standard HTTP status code.
*/
public init(httpCode: Int) {
self.rawValue = httpCode
self.reason = RequestError.reason(forHTTPCode: httpCode)
}
// MARK: Accessing constants representing HTTP status codes
/// HTTP code 100 - Continue
public static let `continue` = RequestError(httpCode: 100)
/// HTTP code 101 - Switching Protocols
public static let switchingProtocols = RequestError(httpCode: 101)
/// HTTP code 200 - OK
public static let ok = RequestError(httpCode: 200)
/// HTTP code 201 - Created
public static let created = RequestError(httpCode: 201)
/// HTTP code 202 - Accepted
public static let accepted = RequestError(httpCode: 202)
/// HTTP code 203 - Non Authoritative Information
public static let nonAuthoritativeInformation = RequestError(httpCode: 203)
/// HTTP code 204 - No Content
public static let noContent = RequestError(httpCode: 204)
/// HTTP code 205 - Reset Content
public static let resetContent = RequestError(httpCode: 205)
/// HTTP code 206 - Partial Content
public static let partialContent = RequestError(httpCode: 206)
/// HTTP code 207 - Multi Status
public static let multiStatus = RequestError(httpCode: 207)
/// HTTP code 208 - Already Reported
public static let alreadyReported = RequestError(httpCode: 208)
/// HTTP code 226 - IM Used
public static let imUsed = RequestError(httpCode: 226)
/// HTTP code 300 - Multiple Choices
public static let multipleChoices = RequestError(httpCode: 300)
/// HTTP code 301 - Moved Permanently
public static let movedPermanently = RequestError(httpCode: 301)
/// HTTP code 302 - Found
public static let found = RequestError(httpCode: 302)
/// HTTP code 303 - See Other
public static let seeOther = RequestError(httpCode: 303)
/// HTTP code 304 - Not Modified
public static let notModified = RequestError(httpCode: 304)
/// HTTP code 305 - Use Proxy
public static let useProxy = RequestError(httpCode: 305)
/// HTTP code 307 - Temporary Redirect
public static let temporaryRedirect = RequestError(httpCode: 307)
/// HTTP code 308 - Permanent Redirect
public static let permanentRedirect = RequestError(httpCode: 308)
/// HTTP code 400 - Bad Request
public static let badRequest = RequestError(httpCode: 400)
/// HTTP code 401 - Unauthorized
public static let unauthorized = RequestError(httpCode: 401)
/// HTTP code 402 - Payment Required
public static let paymentRequired = RequestError(httpCode: 402)
/// HTTP code 403 - Forbidden
public static let forbidden = RequestError(httpCode: 403)
/// HTTP code 404 - Not Found
public static let notFound = RequestError(httpCode: 404)
/// HTTP code 405 - Method Not Allowed
public static let methodNotAllowed = RequestError(httpCode: 405)
/// HTTP code 406 - Not Acceptable
public static let notAcceptable = RequestError(httpCode: 406)
/// HTTP code 407 - Proxy Authentication Required
public static let proxyAuthenticationRequired = RequestError(httpCode: 407)
/// HTTP code 408 - Request Timeout
public static let requestTimeout = RequestError(httpCode: 408)
/// HTTP code 409 - Conflict
public static let conflict = RequestError(httpCode: 409)
/// HTTP code 410 - Gone
public static let gone = RequestError(httpCode: 410)
/// HTTP code 411 - Length Required
public static let lengthRequired = RequestError(httpCode: 411)
/// HTTP code 412 - Precondition Failed
public static let preconditionFailed = RequestError(httpCode: 412)
/// HTTP code 413 - Payload Too Large
public static let payloadTooLarge = RequestError(httpCode: 413)
/// HTTP code 414 - URI Too Long
public static let uriTooLong = RequestError(httpCode: 414)
/// HTTP code 415 - Unsupported Media Type
public static let unsupportedMediaType = RequestError(httpCode: 415)
/// HTTP code 416 - Range Not Satisfiable
public static let rangeNotSatisfiable = RequestError(httpCode: 416)
/// HTTP code 417 - Expectation Failed
public static let expectationFailed = RequestError(httpCode: 417)
/// HTTP code 421 - Misdirected Request
public static let misdirectedRequest = RequestError(httpCode: 421)
/// HTTP code 422 - Unprocessable Entity
public static let unprocessableEntity = RequestError(httpCode: 422)
/// HTTP code 423 - Locked
public static let locked = RequestError(httpCode: 423)
/// HTTP code 424 - Failed Dependency
public static let failedDependency = RequestError(httpCode: 424)
/// HTTP code 426 - Upgrade Required
public static let upgradeRequired = RequestError(httpCode: 426)
/// HTTP code 428 - Precondition Required
public static let preconditionRequired = RequestError(httpCode: 428)
/// HTTP code 429 - Too Many Requests
public static let tooManyRequests = RequestError(httpCode: 429)
/// HTTP code 431 - Request Header Fields Too Large
public static let requestHeaderFieldsTooLarge = RequestError(httpCode: 431)
/// HTTP code 451 - Unavailable For Legal Reasons
public static let unavailableForLegalReasons = RequestError(httpCode: 451)
/// HTTP code 500 - Internal Server Error
public static let internalServerError = RequestError(httpCode: 500)
/// HTTP code 501 - Not Implemented
public static let notImplemented = RequestError(httpCode: 501)
/// HTTP code 502 - Bad Gateway
public static let badGateway = RequestError(httpCode: 502)
/// HTTP code 503 - Service Unavailable
public static let serviceUnavailable = RequestError(httpCode: 503)
/// HTTP code 504 - Gateway Timeout
public static let gatewayTimeout = RequestError(httpCode: 504)
/// HTTP code 505 - HTTP Version Not Supported
public static let httpVersionNotSupported = RequestError(httpCode: 505)
/// HTTP code 506 - Variant Also Negotiates
public static let variantAlsoNegotiates = RequestError(httpCode: 506)
/// HTTP code 507 - Insufficient Storage
public static let insufficientStorage = RequestError(httpCode: 507)
/// HTTP code 508 - Loop Detected
public static let loopDetected = RequestError(httpCode: 508)
/// HTTP code 510 - Not Extended
public static let notExtended = RequestError(httpCode: 510)
/// HTTP code 511 - Network Authentication Required
public static let networkAuthenticationRequired = RequestError(httpCode: 511)
private static func reason(forHTTPCode code: Int) -> String {
switch code {
case 100: return "Continue"
case 101: return "Switching Protocols"
case 200: return "OK"
case 201: return "Created"
case 202: return "Accepted"
case 203: return "Non-Authoritative Information"
case 204: return "No Content"
case 205: return "Reset Content"
case 206: return "Partial Content"
case 207: return "Multi-Status"
case 208: return "Already Reported"
case 226: return "IM Used"
case 300: return "Multiple Choices"
case 301: return "Moved Permanently"
case 302: return "Found"
case 303: return "See Other"
case 304: return "Not Modified"
case 305: return "Use Proxy"
case 307: return "Temporary Redirect"
case 308: return "Permanent Redirect"
case 400: return "Bad Request"
case 401: return "Unauthorized"
case 402: return "Payment Required"
case 403: return "Forbidden"
case 404: return "Not Found"
case 405: return "Method Not Allowed"
case 406: return "Not Acceptable"
case 407: return "Proxy Authentication Required"
case 408: return "Request Timeout"
case 409: return "Conflict"
case 410: return "Gone"
case 411: return "Length Required"
case 412: return "Precondition Failed"
case 413: return "Payload Too Large"
case 414: return "URI Too Long"
case 415: return "Unsupported Media Type"
case 416: return "Range Not Satisfiable"
case 417: return "Expectation Failed"
case 421: return "Misdirected Request"
case 422: return "Unprocessable Entity"
case 423: return "Locked"
case 424: return "Failed Dependency"
case 426: return "Upgrade Required"
case 428: return "Precondition Required"
case 429: return "Too Many Requests"
case 431: return "Request Header Fields Too Large"
case 451: return "Unavailable For Legal Reasons"
case 500: return "Internal Server Error"
case 501: return "Not Implemented"
case 502: return "Bad Gateway"
case 503: return "Service Unavailable"
case 504: return "Gateway Timeout"
case 505: return "HTTP Version Not Supported"
case 506: return "Variant Also Negotiates"
case 507: return "Insufficient Storage"
case 508: return "Loop Detected"
case 510: return "Not Extended"
case 511: return "Network Authentication Required"
default: return "http_\(code)"
}
}
}
/**
An object that conforms to QueryParams is identified as being decodable from URLEncoded data.
This can be applied to a Codable route to define the names and types of the expected query parameters, and provide type-safe access to their values. The `QueryDecoder` is used to decode the URL encoded parameters into an instance of the conforming type.
### Usage Example: ###
```swift
struct Query: QueryParams {
let id: Int
}
router.get("/user") { (query: Query, respondWith: (User?, RequestError?) -> Void) in
guard let user: User = userArray[query.id] else {
return respondWith(nil, .notFound)
}
respondWith(user, nil)
}
```
### Decoding Empty Values:
When an HTML form is sent with an empty or unchecked field, the corresponding key/value pair is sent with an empty value (i.e. `&key1=&key2=`).
The corresponding mapping to Swift types performed by `QueryDecoder` is as follows:
- Any Optional type (including `String?`) defaults to `nil`
- Non-optional `String` successfully decodes to `""`
- Non-optional `Bool` decodes to `false`
- All other non-optional types throw a decoding error
*/
public protocol QueryParams: Codable {
}
/**
An error representing a failure to create an `Identifier`.
### Usage Example: ###
An `QueryParamsError.invalidValue` may be thrown if the given type cannot be constructed from the given string.
````swift
throw QueryParamsError.invalidValue
````
*/
public enum QueryParamsError: Error {
/// Represents a failure to create a given filtering type from a given `String` representation.
case invalidValue
}
/**
An error representing a failure to create an `Identifier`.
### Usage Example: ###
An `IdentifierError.invalidValue` may be thrown if the given string cannot be converted to an integer when using an `Identifier`.
````swift
throw IdentifierError.invalidValue
````
*/
public enum IdentifierError: Error {
/// Represents a failure to create an `Identifier` from a given `String` representation.
case invalidValue
}
/**
An identifier for an entity with a string representation.
### Usage Example: ###
````swift
// Used in the Id field.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
public protocol Identifier: Codable {
/// Creates an identifier from a given string value.
/// - Throws: An IdentifierError.invalidValue if the given string is not a valid representation.
init(value: String) throws
/// The string representation of the identifier.
var value: String { get }
}
/**
Extends `String` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be a `String`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension String: Identifier {
/// Creates a string identifier from a given string value.
public init(value: String) {
self.init(value)
}
/// The string representation of the identifier.
public var value: String {
return self
}
}
/**
Extends `Int` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `Int`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension Int: Identifier {
/// Creates an integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an integer.
public init(value: String) throws {
if let id = Int(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `Int8` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `Int8`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension Int8: Identifier {
/// Creates an integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an integer.
public init(value: String) throws {
if let id = Int8(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `Int16` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `Int16`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension Int16: Identifier {
/// Creates an integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an integer.
public init(value: String) throws {
if let id = Int16(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `Int32` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `Int32`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension Int32: Identifier {
/// Creates an integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an integer.
public init(value: String) throws {
if let id = Int32(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `Int64` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `Int64`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension Int64: Identifier {
/// Creates an integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an integer.
public init(value: String) throws {
if let id = Int64(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `UInt` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `UInt`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension UInt: Identifier {
/// Creates an unsigned integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an unsigned integer.
public init(value: String) throws {
if let id = UInt(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `UInt8` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `UInt8`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension UInt8: Identifier {
/// Creates an unsigned integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an unsigned integer.
public init(value: String) throws {
if let id = UInt8(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `UInt16` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `UInt16`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension UInt16: Identifier {
/// Creates an unsigned integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an unsigned integer.
public init(value: String) throws {
if let id = UInt16(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `UInt32` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `UInt32`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension UInt32: Identifier {
/// Creates an unsigned integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an unsigned integer.
public init(value: String) throws {
if let id = UInt32(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
Extends `UInt64` to comply to the `Identifier` protocol.
### Usage Example: ###
````swift
// The Identifier used in the Id field could be an `UInt64`.
public typealias IdentifierCodableClosure<Id: Identifier, I: Codable, O: Codable> = (Id, I, @escaping CodableResultClosure<O>) -> Void
````
*/
extension UInt64: Identifier {
/// Creates an unsigned integer identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to an unsigned integer.
public init(value: String) throws {
if let id = UInt64(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
extension Double: Identifier {
/// Creates a double identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to a Double.
public init(value: String) throws {
if let id = Double(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
extension Float: Identifier {
/// Creates a float identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to a Float.
public init(value: String) throws {
if let id = Float(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
extension Bool: Identifier {
/// Creates a bool identifier from a given string representation.
/// - Throws: An `IdentifierError.invalidValue` if the given string cannot be converted to a Bool.
public init(value: String) throws {
if let id = Bool(value) {
self = id
} else {
throw IdentifierError.invalidValue
}
}
/// The string representation of the identifier.
public var value: String {
return String(describing: self)
}
}
/**
An enum containing the ordering information
### Usage Example: ###
To order ascending by name, we would write:
```swift
Order.asc("name")
```
*/
public enum Order: Codable {
/// Represents an ascending order with an associated String value
case asc(String)
/// Represents a descending order with an associated String value
case desc(String)
// Coding Keys for encoding and decoding
enum CodingKeys: CodingKey {
case asc
case desc
}
// Function to encode enum case
public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
switch self {
case .asc(let value):
try container.encode(value, forKey: .asc)
case .desc(let value):
try container.encode(value, forKey: .desc)
}
}
// Function to decode enum case
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
do {
let ascValue = try container.decode(String.self, forKey: .asc)
self = .asc(ascValue)
} catch {
let descValue = try container.decode(String.self, forKey: .desc)
self = .desc(descValue)
}
}
/// Description of the enum case
public var description: String {
switch self {
case let .asc(value):
return "asc(\(value))"
case let .desc(value):
return "desc(\(value))"
}
}
/// Associated value of the enum case
public var value: String {
switch self {
case let .asc(value):
return value
case let .desc(value):
return value
}
}
}
/**
A codable struct containing the ordering information
### Usage Example: ###
To order ascending by name and descending by age, we would write:
```swift
Ordering(by: .asc("name"), .desc("age"))
```
*/
public struct Ordering: Codable {
/// Array of Orders
var order: [Order]!
/// Creates an Ordering instance from one or more Orders
public init(by order: Order...) {
self.order = order
}
/// Creates an Ordering instance from a given array of Orders.
public init(by order: [Order]) {
self.order = order
}
/// Creates an Ordering instance from a given string value.
internal init(string value: String) throws {
if !value.contains(",") {
let extractedValue = try extractValue(value)