Expose error values as string and improve readme

Author: janpieterz

README.md

@@ -1 +1,76 @@
-# sdk-swift-ui
+# Trinsic Swift UI Library
+
+[![Swift UI Version](https://img.shields.io/cocoapods/v/TrinsicUI.svg)](<[https://www.npmjs.org/package/@trinsic/react-native-ui](https://cocoapods.org/pods/TrinsicUI)>) [![Swift Build Status](https://github.com/trinsic-id/sdk/actions/workflows/ui-swift-release.yml/badge.svg)](https://github.com/trinsic-id/sdk/actions?query=branch%main)
+
+The Trinsic Swift UI Library provides ways to launch verification sessions directly in your Swift and Objective-C projects, requiring very little code.
+
+You can find a full example using this library in the [samples](https://github.com/trinsic-id/sdk/tree/main/ui-swift/samples) folder.
+
+## Documentation
+
+See the [Trinsic docs](https://docs.trinsic.id/docs/) for more detailed information on how to start integrating with our identity acceptance network.
+
+## Installation
+
+### Swift package manager
+
+Add the Trinsic repository `https://github.com/trinsic-id/sdk-swift-ui` as a dependency.
+
+### CocoaPods
+
+Add a reference to the `TrinsicUI` pod to your `Podfile` with the latest version (see the shield at the top of the readme) and run `pod install`
+
+```
+pod 'TrinsicUI', '~> [latest version]'
+```
+
+## Setup
+
+### Choose a Custom Scheme
+
+This library makes use of `ASWebAuthenticationSession` on iOS and macOS.
+
+Therefore, you must register a custom scheme against your app on both iOS and macOS in order for the library to be able to capture the results of a session.
+
+This custom scheme **should be globally unique to your organization and application**.
+
+An example of a good custom scheme might be `acme-corp-shopping-app-trinsic`.
+
+#### Add the scheme to your app's URLs
+
+Select your app's target and on the info tab in XCode add the scheme you selected.
+
+## Usage
+
+Import TrinsicUI into your view:
+
+```swift
+import TrinsicUI
+```
+
+Create an instance of TrinsicUI and launch a session.
+You can retrieve the launch url from a trusted backend that can reach out to the Trinsic servers. [See our backend language examples](https://github.com/trinsic-id/sdk/tree/main/api-typescript/samples).
+
+```swift
+let trinsicUI = TrinsicUI()
+let result = try await trinsicUI.launchSession(launchUrl: "[REPLACE_ME]", callbackURL: "[REPLACE_ME]")
+```
+
+## SDK Versioning
+
+var configuration = new Configuration { AccessToken = "your-access-token" };
+
+var attachments = new AttachmentsApi(configuration);
+var network = new NetworkApi(configuration);
+var sessions = new SessionsApi(configuration);
+
+## Support
+
+Any issues, inquiries, and feature requests can be sent to [[email protected]](mailto:[email protected]), or feel free to open a GitHub issue [here](https://github.com/trinsic-id/sdk/issues).
+
+## More Information
+
+- [API Reference](https://docs.trinsic.id/reference)
+- [Developer Guide](https://docs.trinsic.id/docs/developer-tools)
+- [Our Blog](https://trinsic.id/blog/)
+- [Schedule a demo](https://trinsic.id/contact/)

Sources/TrinsicUI/TrinsicError.swift

@@ -21,8 +21,39 @@ import Foundation
 @objc public class TrinsicError: NSObject {
     @objc public static func error(with code: TrinsicErrorCode, message: String? = nil) -> NSError {
         let domain = "id.trinsic.TrinsicError"
-        let errorDescription = "\(String(describing: code)): \(message ?? "")"
+        let errorDescription = "\(description(for: code)): \(message ?? "")"                
         let userInfo = [NSLocalizedDescriptionKey: errorDescription]
         return NSError(domain: domain, code: code.rawValue, userInfo: userInfo)
     }
+    
+    @objc private static func description(for code: TrinsicErrorCode) -> String {
+        switch code {
+        case .unknownError:
+            return "Unknown error occurred."
+        case .unparsableResultUrl:
+            return "The result URL could not be parsed."
+        case .couldNotAcquireRootViewController:
+            return "Could not acquire the root view controller."
+        case .unsupportedIosVersion:
+            return "Unsupported iOS version."
+        case .noRegisteredApplicationForLaunchUrl:
+            return "No registered application for the launch URL."
+        case .unparsableLaunchUrl:
+            return "The launch URL could not be parsed."
+        case .missingSessionId:
+            return "The session ID is missing."
+        case .noSupportForiOSBelow12:
+            return "This feature is not supported on iOS below version 12."
+        case .emptyLaunchUrl:
+            return "The launch URL is empty."
+        case .emptyRedirectUrl:
+            return "The redirect URL is empty."
+        case .cannotReconstructLaunchUrl:
+            return "Cannot reconstruct the launch URL."
+        case .unparsableCallbackUrl:
+            return "The callback URL could not be parsed."
+        case .unsupportedHttpsLinking:
+            return "HTTPS linking is not supported."
+        }
+    }
 }