@easypayment/medusa-paypal 0.5.0 → 0.5.2

package/README.md

@@ -1,39 +1,71 @@
-# @easypayment/medusa-paypal
+# EasyPayment PayPal for Medusa
 
-Production-ready PayPal integration for **Medusa v2** with:
+PayPal Wallet and Advanced Card Payments integration for Medusa v2.
 
-- PayPal Wallet provider
-- PayPal Advanced Card provider
-- Admin settings pages (connection, wallet settings, advanced card settings, additional checkout behavior)
-- Store API routes used by storefront integrations
+---
+
+## Features
+
+- PayPal Wallet (Smart Buttons)
+- PayPal Advanced Card Payments
+- Admin configuration UI for PayPal settings
+- Store API support for storefront integrations
+- Configurable checkout behavior
 
 ---
 
 ## Compatibility
 
-- Medusa: `^2.12.0`
-- Node.js: `>=20`
+| Component | Version |
+|-----------|---------|
+| Medusa    | `^2.12.0` |
+| Node.js   | `>=20` |
 
 ---
 
-## Step-by-step setup (GitHub style)
+## Installation
 
-### 1) Install the package
+Install the package in your Medusa backend:
 
 ```bash
 npm install @easypayment/medusa-paypal
-# or
+```
+
+Or with pnpm:
+
+```bash
 pnpm add @easypayment/medusa-paypal
-# or
+```
+
+Or with yarn:
+
+```bash
 yarn add @easypayment/medusa-paypal
 ```
 
-### 2) Register plugin + providers in `medusa-config.ts`
+---
+
+## Medusa Configuration
 
-Add the plugin and both payment providers:
+Register the plugin and both payment providers in `medusa-config.ts`:
 
 ```ts
-module.exports = defineConfig({
+import { loadEnv, defineConfig } from "@medusajs/framework/utils"
+
+loadEnv(process.env.NODE_ENV || "development", process.cwd())
+
+export default defineConfig({
+  projectConfig: {
+    databaseUrl: process.env.DATABASE_URL,
+    http: {
+      storeCors: process.env.STORE_CORS!,
+      adminCors: process.env.ADMIN_CORS!,
+      authCors: process.env.AUTH_CORS!,
+      jwtSecret: process.env.JWT_SECRET || "supersecret",
+      cookieSecret: process.env.COOKIE_SECRET || "supersecret",
+    },
+  },
+
   plugins: [
     {
       resolve: "@easypayment/medusa-paypal",
@@ -49,10 +81,12 @@ module.exports = defineConfig({
           {
             resolve: "@easypayment/medusa-paypal/providers/paypal",
             id: "paypal",
+            dependencies: ["paypal_onboarding"],
           },
           {
             resolve: "@easypayment/medusa-paypal/providers/paypal_card",
             id: "paypal_card",
+            dependencies: ["paypal_onboarding"],
           },
         ],
       },
@@ -61,80 +95,146 @@ module.exports = defineConfig({
 })
 ```
 
-### 3) Add backend environment variables
+---
 
-Set these in your backend `.env`:
+## Environment Variables
+
+Add the required variables to your backend `.env` file:
+
+```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
 
-```bash
-# required for API + onboarding defaults
-PAYPAL_ENV=sandbox
 PAYPAL_CURRENCY=EUR
+```
+
+---
+
+## Start the Backend
+
+Run your Medusa backend:
 
-# optional but recommended
-STOREFRONT_URL=https://your-storefront.example.com
-PAYPAL_CREDENTIALS_ENCRYPTION_KEY=your-32-byte-or-strong-secret
+```bash
+npm run dev
 ```
 
-> Tip: PayPal API credentials are managed from the Medusa Admin PayPal settings UI.
+Then open Medusa Admin.
+
+---
+
+## Admin Setup
 
-### 4) Start backend and open Admin
+After installation, configure PayPal from the Medusa Admin PayPal settings pages.
 
-- Run your Medusa backend.
-- Open Medusa Admin.
-- Go to the PayPal settings pages.
+### PayPal Wallet
 
-### 5) Connect PayPal and configure checkout behavior
+Available settings include:
 
-Use the Admin UI to set credentials and runtime behavior.
+- `enabled`
+- `title`
+- `disableButtons`
+- `buttonColor`
+- `buttonShape`
+- `buttonWidth`
+- `buttonHeight`
+- `buttonLabel`
 
-Runtime-relevant settings include:
+### Advanced Card Payments
 
-- **PayPal Settings**
-  - `enabled`
-  - `title`
-  - `disableButtons`
-  - `buttonColor`, `buttonShape`, `buttonWidth`, `buttonHeight`, `buttonLabel`
-- **Advanced Card Payments**
-  - `enabled`
-  - `title`
-  - `threeDS`
-- **Additional Settings**
-  - `paymentAction` (`capture` or `authorize`)
-  - `brandName`
-  - `landingPage`
-  - `requireInstantPayment`
-  - `sendItemDetails`
-  - `invoicePrefix`
-  - `creditCardStatementName`
+Available settings include:
 
-### 6) Use the generated provider IDs in your storefront
+- `enabled`
+- `title`
+- `threeDS`
 
-With the sample config above, Medusa provider IDs are:
+### Additional Checkout Settings
 
-- `pp_paypal_paypal`
-- `pp_paypal_card_paypal_card`
+Available settings include:
 
-Your storefront package should use these exact IDs unless you customize provider IDs.
+- `paymentAction` (`capture` or `authorize`)
+- `brandName`
+- `landingPage`
+- `requireInstantPayment`
+- `sendItemDetails`
+- `invoicePrefix`
+- `creditCardStatementName`
 
 ---
 
-## Quick checklist
+## Provider IDs
+
+With the default configuration shown above, the generated Medusa provider IDs are:
+
+```txt
+pp_paypal_paypal
+pp_paypal_card_paypal_card
+```
 
-- [ ] Package installed
-- [ ] `medusa-config.ts` updated (plugin + both providers)
-- [ ] Required env vars set
-- [ ] PayPal credentials configured in Admin
-- [ ] Storefront uses correct provider IDs
+Use these exact provider IDs in your storefront unless you change the provider `id` values in `medusa-config.ts`.
 
 ---
 
-## Build and publish
+## Storefront Usage
 
-```bash
-npm run build
-npm publish --access public
+When creating a payment session, use one of the generated provider IDs.
+
+Example for PayPal Wallet:
+
+```json
+{
+  "provider_id": "pp_paypal_paypal"
+}
+```
+
+Example for PayPal Card:
+
+```json
+{
+  "provider_id": "pp_paypal_card_paypal_card"
+}
 ```
 
+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"
+}
+```
+
+---
+
+## Quick Setup Checklist
+
+- 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
+
 ---
 
 ## License

package/package.json

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

package/src/modules/paypal/migrations/20270102090000_add_paypal_seller_email.ts

@@ -0,0 +1,11 @@
+import { Migration } from "@mikro-orm/migrations"
+
+export class Migration20270102090000 extends Migration {
+  override async up(): Promise<void> {
+    this.addSql(`alter table if exists "paypal_connection" add column if not exists "seller_email" text null;`)
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`alter table if exists "paypal_connection" drop column if exists "seller_email";`)
+  }
+}

package/src/modules/paypal/models/paypal_connection.ts

@@ -1,21 +1,22 @@
-import { model } from "@medusajs/framework/utils"
-
-const PayPalConnection = model.define("paypal_connection", {
-  id: model.id().primaryKey(),
-
-  environment: model.text(), // sandbox|live
-  status: model.text(),      // disconnected|pending|pending_credentials|connected|revoked
-
-  shared_id: model.text().nullable(),
-  auth_code: model.text().nullable(),
-
-  seller_client_id: model.text().nullable(),
-  seller_client_secret: model.text().nullable(),
-
-  app_access_token: model.text().nullable(),
-  app_access_token_expires_at: model.dateTime().nullable(),
-
-  metadata: model.json().nullable(),
-})
-
-export default PayPalConnection
+import { model } from "@medusajs/framework/utils"
+
+const PayPalConnection = model.define("paypal_connection", {
+  id: model.id().primaryKey(),
+
+  environment: model.text(), // sandbox|live
+  status: model.text(),      // disconnected|pending|pending_credentials|connected|revoked
+
+  shared_id: model.text().nullable(),
+  auth_code: model.text().nullable(),
+
+  seller_client_id: model.text().nullable(),
+  seller_client_secret: model.text().nullable(),
+  seller_email: model.text().nullable(),
+
+  app_access_token: model.text().nullable(),
+  app_access_token_expires_at: model.dateTime().nullable(),
+
+  metadata: model.json().nullable(),
+})
+
+export default PayPalConnection