release 3.0.0 (#101)

Author: kiftio

CHANGELOG.md

@@ -1,8 +1,11 @@
 # Changelog
 
-## 3.0.0 May 10, 2024
+## 3.0.0 May 20, 2024
 
-- Improved error handling. Attempts to load checkout in a recovery WebView when certain errors are encountered. See [Error Handling](https://github.com/Shopify/checkout-sheet-kit-android#error-handling) for more information.
+- `ShopifyCheckoutSheet.present()` now returns an interface allowing clients to dismiss the sheet.
+- Error handling has been improved*. The kit also attempts to load checkout in a recovery WebView when certain errors are encountered. See [Error Handling](https://github.com/Shopify/checkout-sheet-kit-android#error-handling) for more information.
+
+*Please note the exception class hierarchy has been updated to be more comprehensive. Each exception class now returns an `isRecoverable: Boolean`, an `errorCode` and an `errorDescription`.
 
 ## 2.0.1 March 19, 2024
 

README.md

@@ -257,50 +257,6 @@ val processor = object : DefaultCheckoutEventProcessor(activity) {
 > [!Note]
 > The `DefaultCheckoutEventProcessor` provides default implementations for current and future callback functions (such as `onLinkClicked()`), which can be overridden by clients wanting to change default behavior.
 
-#### Exception Hierarchy
-
-```mermaid
----
-title: Checkout Sheet Kit Exception Hierarchy
----
-classDiagram
-    CheckoutException <|-- ConfigurationException
-    CheckoutException <|-- CheckoutExpiredException
-    CheckoutException <|-- AuthenticationException
-    CheckoutException <|-- CheckoutSheetKitException
-    CheckoutException <|-- CheckoutUnavailableException
-    CheckoutUnavailableException <|-- HttpException
-    CheckoutUnavailableException <|-- ClientException
-
-    <<Abstract>> CheckoutException
-    CheckoutException : +String errorDescription
-    CheckoutException : +String errorCode
-    CheckoutException : +bool isRecoverable
-
-    class ConfigurationException{
-        note: "Store or checkout configuration issues."
-    }
-    class CheckoutExpiredException{
-        note: "Expired or invalid carts/checkouts."
-    }
-    class AuthenticationException{
-        note: "Authentication issues."
-    }
-    class CheckoutUnavailableException{
-        note: "Unexpected errors."
-    }
-    class HttpException{
-        note: "Unexpected Http response"
-        +int statusCode
-    }
-    class ClientException{
-        note: "Unexpected client/web error"
-    }
-    class CheckoutSheetKitException{
-        note: "Error in Checkout Sheet Kit code"
-    }
-```
-
 #### Error handling
 
 In the event of a checkout error occurring, the Checkout Sheet Kit _may_ attempt to retry to recover from the error. Recovery will happen in the background by discarding the failed WebView and creating a new "recovery" instance. Recovery will be attempted in the following scenarios:
@@ -354,6 +310,46 @@ ShopifyCheckoutSheetKit.configure {
 | `ClientException`              | 'client_error'                 | An unhandled client error was encountered.                                    | Show checkout in a fallback WebView.                   |
 | `CheckoutUnavailableException` | 'unknown'                      | Checkout is unavailable for another reason, see error details for more info.  | Show checkout in a fallback WebView.                   |
 
+#### Exception Hierarchy
+
+```mermaid
+---
+title: Checkout Sheet Kit Exception Hierarchy
+---
+classDiagram
+    CheckoutException <|-- ConfigurationException
+    CheckoutException <|-- CheckoutExpiredException
+    CheckoutException <|-- CheckoutSheetKitException
+    CheckoutException <|-- CheckoutUnavailableException
+    CheckoutUnavailableException <|-- HttpException
+    CheckoutUnavailableException <|-- ClientException
+
+    <<Abstract>> CheckoutException
+    CheckoutException : +String errorDescription
+    CheckoutException : +String errorCode
+    CheckoutException : +bool isRecoverable
+
+    class ConfigurationException{
+        note: "Store or checkout configuration issues."
+    }
+    class CheckoutExpiredException{
+        note: "Expired or invalid carts/checkouts."
+    }
+    class CheckoutUnavailableException{
+        note: "Unexpected errors."
+    }
+    class HttpException{
+        note: "Unexpected Http response"
+        +int statusCode
+    }
+    class ClientException{
+        note: "Unexpected client/web error"
+    }
+    class CheckoutSheetKitException{
+        note: "Error in Checkout Sheet Kit code"
+    }
+```
+
 #### Integrating with Web Pixels, monitoring behavioral data
 
 App developers can use [lifecycle events](#monitoring-the-lifecycle-of-a-checkout-session) to

lib/build.gradle

@@ -14,7 +14,7 @@ def resolveEnvVarValue(name, defaultValue) {
     return rawValue ? rawValue : defaultValue
 }
 
-def versionName = resolveEnvVarValue("CHECKOUT_SHEET_KIT_VERSION", "3.0.0-beta.2")
+def versionName = resolveEnvVarValue("CHECKOUT_SHEET_KIT_VERSION", "3.0.0")
 
 ext {
     app_compat_version = '1.6.1'

lib/src/test/java/com/shopify/checkoutsheetkit/errors/CheckoutErrorDecoderTest.kt

@@ -100,7 +100,7 @@ class CheckoutErrorDecoderTest {
             name = "error",
             body = """[
                 |{
-                |   "group": "authentication",
+                |   "group": "unrecoverable",
                 |   "flowType": "regular",
                 |   "type": "invalid_
                 |}