@glomopay/react-native-sdk 2.0.2 → 3.1.0

package/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.1.0] - 2026-06-08
+
+### Added
+
+- **Subscriptions checkout support** - new `subscriptionId` prop on `GlomoCheckout`. When provided, the SDK bypasses order type detection and renders the subscriptions checkout flow directly. No API call is made - the inner checkout component mounts immediately. The `detecting_order_type` status is not emitted for subscription flows.
+- **Mutual exclusion validation** - `GlomoCheckout` validates that exactly one of `orderId` or `subscriptionId` is provided. If both or neither are set, `onSdkError` fires with a clear message and `start()` returns `false`.
+
+### Changed
+
+- **`orderId` is now optional** on `GlomoCheckoutProps` - required only when `subscriptionId` is absent.
+
+### Deprecated
+
+- **`useGlomoCheckout` hook** - use the `GlomoCheckout` component with a ref instead. The hook does not provide reactive state - `getStatus()` returns a point-in-time snapshot. Will be removed in a future major version.
+
+## [3.0.1] - 2026-06-02
+
+### Added
+
+- **`onPayViaBankBankConnectionSuccessful` callback** - fires when a bank connection is successfully established during the pay via bank flow. Provides `GlomoPayViaBankConnectionPayload` (`bankIdentifier`, `cooldownPeriodInMinutes`, `bankName`, `bankImageSrc`, `bankImageAlt`). This is informational only and does not change the checkout status.
+- **`GlomoPayViaBankConnectionPayload` type** - new exported type for the bank connection callback payload.
+
+### Fixed
+
+- Repeat `start()` calls with the same orderId no longer fail silently due to cached API responses.
+- Checkout dismissal now fully resets internal state, preventing stale UI on re-open.
+
+## [3.0.0] - 2026-06-01
+
+### Breaking Changes
+
+- **New unified component**: `GlomoLrsCheckout` has been replaced by `GlomoCheckout`. The new component automatically detects the order type (LRS or Standard) and renders the appropriate checkout flow.
+- **`start()` is now async**: Returns `Promise<boolean>` instead of `boolean`. Update call sites to `await`:
+  ```tsx
+  const started = await checkoutRef.current?.start();
+  ```
+- **Renamed exports**:
+  | v2                        | v3                       |
+  | ------------------------- | ------------------------ |
+  | `GlomoLrsCheckout`        | `GlomoCheckout`          |
+  | `GlomoLrsCheckoutRef`     | `GlomoCheckoutRef`       |
+  | `GlomoLrsCheckoutProps`   | `GlomoCheckoutProps`     |
+  | `GlomoLrsCheckoutPayload` | `GlomoCheckoutPayload`   |
+  | `GlomoLrsServer`          | `GlomoServer`            |
+  | `LrsCheckoutStatus`       | `CheckoutStatus`         |
+  | `useLrsCheckout`          | `useGlomoCheckout`       |
+- **Removed exports**: v2 LRS-specific names are no longer available.
+
+### Added
+
+- **Standard checkout support** - cards, bank transfers, pay via bank, and camera-based bank authentication flows, all through the same `GlomoCheckout` component. No integration changes needed - the order type is detected automatically.
+- **`onBankTransferSubmitted` callback** - fires when the user submits bank transfer details in a standard checkout flow. Provides `GlomoBankTransferPayload` (`orderId`, `senderAccountNumber`, `transactionReference`).
+- **`onPayViaBankCompleted` callback** - fires when the pay via bank journey completes. Provides `{ status: string }`.
+- **`onUserRefusedCameraPermissions` callback** - fires when the user denies camera access during bank authentication (Android only). The checkout is dismissed automatically.
+- **`detecting_order_type` checkout status** - returned by `getStatus()` while the SDK determines the order type.
+- **`bank_transfer_submitted` checkout status** - indicates a bank transfer has been submitted and is awaiting confirmation.
+- **`pay_via_bank_completed` checkout status** - indicates the pay via bank flow has completed.
+- **`GlomoBankTransferPayload` type** - new exported type for the bank transfer callback payload.
+- **`useGlomoCheckout` hook** - for advanced integration patterns needing direct access to order type detection state.
+
+### Platform Configuration (New)
+
+Checkout flows with camera-based bank authentication require native permissions:
+
+- **Android** (`AndroidManifest.xml`): `<uses-permission android:name="android.permission.CAMERA" />`
+- **iOS** (`Info.plist`): `NSCameraUsageDescription` key
+
+These are only required for flows that use camera-based bank authentication.
+
+## [2.0.2]
+
+Last v2 release.

package/MIGRATION.md

@@ -0,0 +1,50 @@
+# Migration Guide
+
+## v2 to v3
+
+v3 replaces the LRS-only `GlomoLrsCheckout` with a unified `GlomoCheckout` that auto-detects order type.
+
+### Renamed Exports
+
+| v2                         | v3                        |
+| -------------------------- | ------------------------- |
+| `GlomoLrsCheckout`         | `GlomoCheckout`           |
+| `GlomoLrsCheckoutRef`      | `GlomoCheckoutRef`        |
+| `GlomoLrsCheckoutProps`    | `GlomoCheckoutProps`      |
+| `GlomoLrsCheckoutPayload`  | `GlomoCheckoutPayload`    |
+| `GlomoLrsServer`           | `GlomoServer`             |
+
+### Breaking Changes
+
+- **`start()` is now async**: Returns `Promise<boolean>` instead of `boolean`. Update call sites to `await ref.current?.start()`.
+- **New statuses**: `bank_transfer_submitted` and `pay_via_bank_completed` are new additions to `CheckoutStatus`.
+- **New callbacks**: `onBankTransferSubmitted`, `onPayViaBankCompleted`, and `onUserRefusedCameraPermissions` are available.
+
+### Before / After
+
+**v2:**
+```tsx
+import { GlomoLrsCheckout, type GlomoLrsCheckoutRef } from "@glomopay/react-native-sdk";
+
+const ref = useRef<GlomoLrsCheckoutRef>(null);
+const started = ref.current?.start(); // boolean
+```
+
+**v3:**
+```tsx
+import { GlomoCheckout, type GlomoCheckoutRef } from "@glomopay/react-native-sdk";
+
+const ref = useRef<GlomoCheckoutRef>(null);
+const started = await ref.current?.start(); // Promise<boolean>
+```
+
+### Platform Configuration (New in v3)
+
+Checkout flows with camera-based bank authentication require native permissions:
+
+- **Android** (`AndroidManifest.xml`): `<uses-permission android:name="android.permission.CAMERA" />`
+- **iOS** (`Info.plist`): `NSCameraUsageDescription` key
+
+These are only required for flows that use camera-based bank authentication.
+
+For the full changelog, see CHANGELOG.md included in this package.