@rinnebr/js 0.1.0-alpha.1 → 0.1.0-alpha.9

package/README.md

@@ -1,29 +1,19 @@
 # Rinne JS
 
-A modern, type-safe browser library for integrating Apple Pay and Google Pay payment elements into your web applications. Built on Rinne's secure payment infrastructure with encryption powered by Evervault.
-
-## Overview
-
-Rinne JS provides a simple, declarative API for rendering wallet payment buttons in the browser. The library handles:
-
-- Secure payment token encryption and transmission
-- Wallet button rendering and styling
-- Payment flow orchestration
-- Error handling and user cancellation
-- Transaction management
+A modern, type-safe browser library for integrating Apple Pay and Google Pay payment elements into your web applications. Built on Rinne's secure payment infrastructure. Rinne JS provides a simple, declarative API for rendering wallet payment buttons in the browser with secure payment token encryption and transmission.
 
 ## Installation
 
 ```bash
-npm install rinne-js
+npm install @rinnebr/js
 # or
-yarn add rinne-js
+yarn add @rinnebr/js
 ```
 
 ## Quick Start
 
 ```typescript
-import { Rinne } from 'rinne-js'
+import { Rinne } from '@rinnebr/js'
 
 // 1. Initialize Rinne with your merchant ID
 const rinne = new Rinne({
@@ -71,7 +61,7 @@ await applePay.mount('#payment-button')
 
 ### Initialization
 
-The `Rinne` class is the main entry point. It handles SDK initialization, merchant configuration fetching, and Evervault setup.
+The `Rinne` class is the main entry point. It handles SDK initialization and merchant configuration fetching.
 
 ```typescript
 const rinne = new Rinne({
@@ -81,7 +71,7 @@ const rinne = new Rinne({
 })
 ```
 
-**Lazy Initialization**: The SDK initializes asynchronously when you first create a transaction or payment element. This includes fetching merchant configuration and loading the Evervault SDK.
+**Lazy Initialization**: The SDK initializes asynchronously when you first create a transaction or payment element, including fetching your merchant configuration.
 
 ### Transactions
 
@@ -132,7 +122,7 @@ new Rinne(options: Options)
 
 ### `rinne.transaction`
 
-#### `create(params: TransactionCreateParams): Promise<EvTransaction>`
+#### `create(params: TransactionCreateParams): Promise<Transaction>`
 
 Creates a new transaction for a payment.
 
@@ -159,7 +149,7 @@ const transaction = await rinne.transaction.create({
 
 ### `rinne.elements`
 
-#### `applePay(transaction: EvTransaction, options: ApplePayMountOptions): Promise<ApplePayElement>`
+#### `applePay(transaction: Transaction, options: ApplePayMountOptions): Promise<ApplePayElement>`
 
 Creates an Apple Pay payment element.
 
@@ -169,7 +159,7 @@ Creates an Apple Pay payment element.
 
 **Returns:** Apple Pay element with `mount()` method
 
-#### `googlePay(transaction: EvTransaction, options: GooglePayMountOptions): Promise<GooglePayElement>`
+#### `googlePay(transaction: Transaction, options: GooglePayMountOptions): Promise<GooglePayElement>`
 
 Creates a Google Pay payment element.
 
@@ -303,7 +293,7 @@ onCapture: (payload: WalletSuccessPayload, fail: (error) => void) => void
    ```typescript
    {
      card_data: CardData      // Encrypted payment token and card details
-     transaction: EvTransaction  // Original transaction object
+     transaction: Transaction // Original transaction object
    }
    ```
 
@@ -413,7 +403,7 @@ onCancel: () => {
 ## Complete Example
 
 ```typescript
-import { Rinne } from 'rinne-js'
+import { Rinne } from '@rinnebr/js'
 
 const rinne = new Rinne({
   merchantId: 'merchant_abc123',
@@ -522,28 +512,82 @@ import type {
   ApplePayElement,
   GooglePayElement,
   MountedElement
-} from 'rinne-js'
+} from '@rinnebr/js'
 ```
 
 ## Error Handling Best Practices
 
 1. **Always handle `onCapture` failures**: Call `fail()` with a useful message if backend processing fails
-2. **Implement `onError`**: Handle what to do in the rare event that the wallet buttons fail to load
+2. **Implement `onError`**: Handle what to do when wallet buttons fail to load or encounter issues
 3. **Handle `onCancel`**: Clean up UI state when user cancels
-4. **Network errors**: Wrap backend calls in try-catch
+4. **Network errors**: Wrap backend calls in try-catch blocks
 5. **Validation**: Validate transaction parameters before calling `transaction.create()`
 
 ## Security
 
-- All payment tokens are encrypted using Evervault before transmission
-- No sensitive card data is stored in browser memory
-- Source maps are disabled to protect payment flow logic
-- Strict Content Security Policy recommended
+- **Encryption**: All payment tokens are encrypted before transmission to your backend
+- **No data storage**: No sensitive card data is stored in browser memory
+- **Code protection**: Minified and obfuscated code to protect payment flow logic
+- **HTTPS only**: Both Apple Pay and Google Pay require secure HTTPS connections
+- **CSP compliance**: See [Requirements](#requirements) section for necessary Content Security Policy directives
+
+## Requirements
+
+Before integrating Rinne JS, ensure your application meets these requirements:
+
+### HTTPS Required
+
+**Both Apple Pay and Google Pay require your website to be served over HTTPS.** The payment buttons will not function on insecure HTTP connections.
+
+### Apple Pay Domain Verification
+
+To accept Apple Pay payments, you must verify your domain with Rinne.
+
+### Content Security Policy (CSP)
+
+If your website uses Content Security Policy headers, add these directives to allow Rinne JS to function:
+
+```
+script-src https://js.evervault.com;
+connect-src https://keys.evervault.com https://api.evervault.com https://api.rinne.com.br https://api-sandbox.rinne.com.br;
+frame-src https://ui-components.evervault.com;
+```
+
+**Note**: Rinne uses secure encryption infrastructure that requires loading scripts from trusted CDNs. These domains cannot be self-hosted due to PCI compliance requirements.
+
+### User Requirements
+
+For payments to work, users must:
+- Have at least one card added to their Apple Wallet (Apple Pay) or Google Pay
+- Use a supported browser and device
+- Be located outside Mainland China (Apple Pay restriction)
+
+## Browser and Device Support
+
+### Apple Pay
+
+**Supported Browsers:**
+- Safari (iOS 10+ and macOS 10.12+)
+- Chrome
+- Edge
+
+**Requirements:**
+- Safari users must enable Apple Pay: **Settings > Safari > Advanced > Allow websites to check for Apple Pay**
+- On laptops using Safari, Touch ID must be accessible
+- HTTPS required
+
+### Google Pay
 
-## Development
+**Supported Browsers:**
+- Chrome
+- Firefox
+- Edge
+- Safari (on supported devices)
 
-See [CLAUDE.md](./CLAUDE.md) for development setup and tooling information.
+**Requirements:**
+- HTTPS required
+- Users must have at least one card added to Google Pay
 
-## License
+## Support
 
-MIT
+For issues, questions, or feature requests, please contact Rinne support or visit our documentation at [https://rinne.com.br](https://rinne.com.br).

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { EvTransaction } from './evervault-types';
+import { loadEvervault } from '@evervault/js';
 
 export declare interface ApplePayElement {
     mount(target: string | HTMLElement): Promise<MountedElement>;
@@ -37,7 +37,9 @@ export declare interface ElementsNamespace {
 
 export declare type Environment = 'sandbox' | 'production';
 
-export { EvTransaction }
+declare type EvervaultInstance = Awaited<ReturnType<typeof loadEvervault>>;
+
+export declare type EvTransaction = ReturnType<EvervaultInstance['transactions']['create']>;
 
 export declare interface GooglePayElement {
     mount(target: string | HTMLElement): Promise<MountedElement>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rinnebr/js",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.9",
   "description": "Modern payment elements library for Apple Pay, Google Pay, and other payment methods",
   "type": "module",
   "packageManager": "yarn@4.9.1",
@@ -48,7 +48,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/rinnebr/rinne-js.git"
+    "url": "git+https://github.com/rinnebr/rinne-js.git"
   },
   "bugs": {
     "url": "https://github.com/rinnebr/rinne-js/issues"