@easypayment/medusa-paypal 0.6.1 → 0.6.2

package/README.md

@@ -1,53 +1,41 @@
-# EasyPayment PayPal for Medusa
+<div align="center">
 
-PayPal Wallet and Advanced Card Payments integration for Medusa v2.
+<h1>🅿 medusa-paypal-backend</h1>
 
----
-
-## Features
-
-- PayPal Wallet (Smart Buttons)
-- PayPal Advanced Card Payments
-- Admin configuration UI for PayPal settings
-- Store API support for storefront integrations
-- Configurable checkout behavior
+<p><strong>Production-ready PayPal payment plugin for Medusa v2</strong></p>
 
----
+<p>
+  <a href="https://www.npmjs.com/package/@easypayment/medusa-paypal-backend"><img src="https://img.shields.io/npm/v/@easypayment/medusa-paypal-backend?color=blue&label=npm" alt="npm version" /></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License: MIT" /></a>
+  <a href="https://medusajs.com"><img src="https://img.shields.io/badge/Medusa-v2-9b59b6" alt="Medusa v2" /></a>
+  <a href="https://developer.paypal.com"><img src="https://img.shields.io/badge/PayPal-PPCP-003087" alt="PayPal PPCP" /></a>
+</p>
 
-## Compatibility
+<p>Smart Buttons · Advanced Card Fields · Webhooks · Reconciliation · Credential Encryption</p>
 
-| Component | Version |
-|-----------|---------|
-| Medusa    | `^2.12.0` |
-| Node.js   | `>=20` |
+</div>
 
 ---
 
-## Installation
+## Requirements
 
-Install the package in your Medusa backend:
+- Medusa v2
+- Node.js 18+
+- PostgreSQL
 
-```bash
-npm install @easypayment/medusa-paypal
-```
-
-Or with pnpm:
-
-```bash
-pnpm add @easypayment/medusa-paypal
-```
+---
 
-Or with yarn:
+## Step 1 — Install
 
 ```bash
-yarn add @easypayment/medusa-paypal
+npm install @easypayment/medusa-paypal-backend
 ```
 
 ---
 
-## Medusa Configuration
+## Step 2 — Configure medusa-config.ts
 
-Register the plugin and both payment providers in `medusa-config.ts`:
+Add the plugin and both payment providers to your existing `medusa-config.ts`:
 
 ```ts
 import { loadEnv, defineConfig } from "@medusajs/framework/utils"
@@ -79,13 +67,17 @@ export default defineConfig({
       options: {
         providers: [
           {
+            // PayPal Smart Buttons (wallet checkout)
             resolve: "@easypayment/medusa-paypal/providers/paypal",
             id: "paypal",
+            options: {},
             dependencies: ["paypal_onboarding"],
           },
           {
+            // Advanced Card Fields (hosted card inputs)
             resolve: "@easypayment/medusa-paypal/providers/paypal_card",
             id: "paypal_card",
+            options: {},
             dependencies: ["paypal_onboarding"],
           },
         ],
@@ -97,146 +89,72 @@ export default defineConfig({
 
 ---
 
-## Environment Variables
+## Step 3 — Set environment variables
 
-Add the required variables to your backend `.env` file:
+Add these to your Medusa server `.env`:
 
 ```env
-STORE_CORS=http://localhost:8000,https://docs.medusajs.com
-ADMIN_CORS=http://localhost:5173,http://localhost:9000,https://docs.medusajs.com
-AUTH_CORS=http://localhost:5173,http://localhost:9000,http://localhost:8000,https://docs.medusajs.com
-
-REDIS_URL=redis://localhost:6379
-JWT_SECRET=supersecret
-COOKIE_SECRET=supersecret
-DATABASE_URL=postgres://postgres:root@localhost/medusa-medusa-backend
-
-MEDUSA_ADMIN_ONBOARDING_TYPE=nextjs
-MEDUSA_ADMIN_ONBOARDING_NEXTJS_DIRECTORY=medusa-backend-storefront
+# Required
+MEDUSA_BACKEND_URL=https://your-medusa-server.com
+STOREFRONT_URL=https://your-storefront.com
 
+# Recommended for production
+PAYPAL_CREDENTIALS_ENCRYPTION_KEY=your-64-char-hex-key
 PAYPAL_CURRENCY=EUR
 ```
 
----
+> Generate an encryption key with: `openssl rand -hex 32`
 
-## Start the Backend
+---
 
-Run your Medusa backend:
+## Step 4 — Run database migrations
 
 ```bash
-npm run dev
+npx medusa db:migrate
 ```
 
-Then open Medusa Admin.
-
 ---
 
-## Admin Setup
-
-After installation, configure PayPal from the Medusa Admin PayPal settings pages.
-
-### PayPal Wallet
-
-Available settings include:
-
-- `enabled`
-- `title`
-- `disableButtons`
-- `buttonColor`
-- `buttonShape`
-- `buttonWidth`
-- `buttonHeight`
-- `buttonLabel`
-
-### Advanced Card Payments
-
-Available settings include:
+## Step 5 — Connect your PayPal account
 
-- `enabled`
-- `title`
-- `threeDS`
+1. Start your Medusa server
+2. Open Medusa Admin → **Settings → PayPal → PayPal Connection**
+3. Choose **Sandbox** (testing) or **Live** (production)
+4. Click **Connect to PayPal** and complete the PayPal onboarding flow
 
-### Additional Checkout Settings
-
-Available settings include:
-
-- `paymentAction` (`capture` or `authorize`)
-- `brandName`
-- `landingPage`
-- `requireInstantPayment`
-- `sendItemDetails`
-- `invoicePrefix`
-- `creditCardStatementName`
+Credentials are saved automatically. To connect manually instead, click **Insert credentials manually** and paste your Client ID and Secret from [developer.paypal.com](https://developer.paypal.com).
 
 ---
 
-## Provider IDs
-
-With the default configuration shown above, the generated Medusa provider IDs are:
+## Step 6 — Enable providers in your region
 
-```txt
-pp_paypal_paypal
-pp_paypal_card_paypal_card
-```
-
-Use these exact provider IDs in your storefront unless you change the provider `id` values in `medusa-config.ts`.
+1. Medusa Admin → **Settings → Regions → [your region]**
+2. Under **Payment Providers**, enable:
+   - `pp_paypal_paypal` — PayPal Smart Buttons
+   - `pp_paypal_card_paypal_card` — Advanced Card Fields
 
 ---
 
-## Storefront Usage
-
-When creating a payment session, use one of the generated provider IDs.
+## Step 7 — Configure settings (optional)
 
-Example for PayPal Wallet:
-
-```json
-{
-  "provider_id": "pp_paypal_paypal"
-}
-```
-
-Example for PayPal Card:
-
-```json
-{
-  "provider_id": "pp_paypal_card_paypal_card"
-}
-```
+All settings are in Medusa Admin → **Settings → PayPal** and take effect immediately with no server restart.
 
-Typical flow:
-
-1. Create cart
-2. Create payment collection
-3. Create payment session with the selected provider ID
-
-Example endpoint:
-
-```http
-POST /store/payment-collections/{id}/payment-sessions
-```
-
-Example body:
-
-```json
-{
-  "provider_id": "pp_paypal_paypal"
-}
-```
+| Tab | What you can configure |
+|---|---|
+| **PayPal Settings** | Enable/disable, button color, shape, label |
+| **Advanced Card Payments** | Enable/disable, 3D Secure mode |
+| **Additional Settings** | Payment action (capture / authorize), brand name, invoice prefix |
 
 ---
 
-## Quick Setup Checklist
+## Step 8 — Connect the frontend package
 
-- Install `@easypayment/medusa-paypal`
-- Register the plugin in `medusa-config.ts`
-- Register both payment providers
-- Add required environment variables
-- Start the Medusa backend
-- Configure PayPal in Admin
-- Use the correct provider IDs in the storefront
+Install the storefront UI package to render PayPal at checkout:
 
----
+```bash
+npm install @easypayment/medusa-paypal-ui
+```
 
-## License
+See the [medusa-paypal-frontend README](../medusa-paypal-frontend/README.md) for integration steps.
 
-MIT
+---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easypayment/medusa-paypal",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "Industry-standard PayPal integration for Medusa v2",
   "license": "MIT",
   "main": "./.medusa/server/src/index.js",