Update documentation and version numbers for release (#54)

Author: kiftio

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.5.0 - January 26, 2024
+
+- **Breaking Changes** A new `onWebPixelEvent(PixelEvent)` function has been added to the `CheckoutEventProcessor` interface. This allows listening for [Web Pixel](https://shopify.dev/docs/apps/marketing/pixels) events that take place in checkout, so they can be emitted to your preferred analytics system. See `README.md` for more details.
+
+_Note_: If your processor extends `DefaultCheckoutEventProcessor`, a no-op implementation has been added, so no changes are required unless you'd like to respond to pixel events. If your processor does not extend `DefaultCheckoutEventProcessor`, you will need to implement this function.
+
+- Fix: Prevent loading checkout twice during preloads.
+- Fix: Match `CheckoutDialog`'s header padding with checkout's padding.
+- Fix: Ensure the WebView cache is cleared on error responses for preloaded requests.
+
 ## 0.4.0 - January 10, 2024
 
 - **Breaking Changes:** The library has been rebranded from Shopify Checkout Kit to Shopify Checkout Sheet Kit. Apologies for any inconvenience caused. Here are the steps to upgrade:

README.md

@@ -252,6 +252,11 @@ val processor = object : WebEventProcessor {
         // - web (http:)
         // and is being directed outside the application.
     }
+
+    override fun onWebPixelEvent(event: PixelEvent) {
+        // Called when a web pixel event is emitted in checkout.
+        // Use this to submit events to your analytics system, see below.
+    }
 }
 
 ```
@@ -261,6 +266,42 @@ val processor = object : WebEventProcessor {
 App developers can use [lifecycle events](#monitoring-the-lifecycle-of-a-checkout-session) to
 monitor and log the status of a checkout session.
 
+To safeguard user privacy, [Web Pixel](https://shopify.dev/docs/apps/marketing/pixels) events will not be dispatched from within the checkout webview. Instead, the events will be relayed back to your application through the `onWebPixelEvent` checkout event processor function.
+
+Implement this function to process the events you're interested in, augment them with customer and session identity, transform them into an appropriate schema and submit them to your preferred analytics system. For example:
+
+```kotlin
+fun onWebPixelEvent(event: PixelEvent) {
+    if (!hasPermissionToCaptureEvents()) {
+        return
+    }
+
+    when (event) {
+        is StandardPixelEvent -> processStandardEvent(event)
+        is CustomPixelEvent -> processCustomEvent(event)
+    }
+}
+
+fun processStandardEvent(event: StandardPixelEvent) {
+    const endpoint = "https://example.com/pixel?id=${accountID}&uid=${userId}";
+
+    val payload = AnalyticsPayload(
+        eventTime: event.timestamp,
+        action: event.name,
+        details: event.data.checkout
+    )
+
+    // Send events to third-party servers
+    httpClient.post(endpoint, payload)
+}
+
+// ... other functions, incl. processCustomEvent(event)
+```
+
+_Note: You will likely need to augment these events with customer/session information derived from app state._
+
+_Note: The `customData` attribute of CustomPixelEvent can take on any shape. As such, this attribute will be returned as a String. Client applications should define a custom data type and deserialize the `customData` string into that type._
+
 ### Integrating identity & customer accounts
 
 Buyer-aware checkout experience reduces friction and increases conversion. Depending on the context

lib/build.gradle

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

samples/MobileBuyIntegration/app/build.gradle

@@ -28,7 +28,7 @@ android {
         applicationId "com.shopify.checkout_sdk_mobile_buy_integration_sample"
         minSdk 23
         targetSdk 34
-        versionCode 20
+        versionCode 21
         versionName "0.0.${versionCode}"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"