@storecraft/payments-paypal 1.0.0 → 1.0.2

package/README.md

@@ -1,6 +1,11 @@
 # Paypal payment gateway for **StoreCraft**
 
-[paypal standard](https://developer.paypal.com/docs/checkout/standard/) integration
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
+[paypal](https://developer.paypal.com/docs/checkout/) integration
 
 ## Features
 - Create checkouts with `AUTHORIZE` or `CAPTURE` intents
@@ -9,12 +14,14 @@
 - Supports both `prod` and `test` endpoints
 
 ```bash
-npm i @storecraft/payments-paypal-standard
+npm i @storecraft/payments-paypal
 ```
 
 ## Howto
 
 ```js
+import { PayPal } from '@storecraft/payments-paypal';
+
 const config = {
   env: 'prod',
   client_id: '<get-from-your-paypal-dashboard>',
@@ -23,20 +30,49 @@ const config = {
   intent_on_checkout: 'AUTHORIZE'
 }
 
-new PaypalStandard(config);
+new Paypal(config);
+```
+
+## In Storecraft App
+
+```ts
+import { App } from '@storecraft/core';
+import { MongoDB } from '@storecraft/database-mongodb';
+import { NodePlatform } from '@storecraft/core/platform/node';
+import { GoogleStorage } from '@storecraft/storage-google';
+import { Paypal } from '@storecraft/payments-paypal'
+
+const app = new App(config)
+.withPlatform(new NodePlatform())
+.withDatabase(new MongoDB())
+.withStorage(new GoogleStorage())
+.withPaymentGateways(
+  {
+    'paypal_standard_prod': new Paypal(
+      { 
+        client_id: process.env.PAYPAL_CLIENT_ID, 
+        secret: process.env.PAYPAL_SECRET, 
+        env: 'prod' 
+      }
+    ),
+  }
+);
+
+await app.init();
+
 ```
 
 ## Developer info and test
 
 Integration examples
-- https://developer.paypal.com/studio/checkout/standard/integrate
+- [https://developer.paypal.com/](https://developer.paypal.com/)
 
 Credit Card Generator
-- https://developer.paypal.com/tools/sandbox/card-testing/#link-creditcardgenerator
+- [https://developer.paypal.com/tools/sandbox/card-testing/#link-creditcardgenerator](https://developer.paypal.com/tools/sandbox/card-testing/#link-creditcardgenerator)
 
 ## todo:
 - Add tests
-- Think about adding more dynamic config 
+- Add webhook support
 
 ```text
 Author: Tomer Shalev (tomer.shalev@gmail.com)

package/adapter.html.js

@@ -10,8 +10,8 @@
  * - Expiry date: 12/2027
  * - CVC code: 897
  * 
- * @param {import("./types.public.js").Config} config 
- * @param {Partial<import("@storecraft/core/v-api").OrderData>} order_data 
+ * @param {import("./types.public.d.ts").Config} config 
+ * @param {Partial<import("@storecraft/core/api").OrderData>} order_data 
  */
 export default function html_buy_ui(config, order_data) {
   const orderData = order_data?.payment_gateway?.on_checkout_create;

package/adapter.js

@@ -1,15 +1,17 @@
-import { CheckoutStatusEnum, PaymentOptionsEnum } from '@storecraft/core/v-api/types.api.enums.js';
+import { 
+  CheckoutStatusEnum, PaymentOptionsEnum 
+} from '@storecraft/core/api/types.api.enums.js';
 import { fetch_with_auth, throw_bad_response } from './adapter.utils.js';
-import { StorecraftError } from '@storecraft/core/v-api/utils.func.js';
+import { StorecraftError } from '@storecraft/core/api/utils.func.js';
 import html_buy_ui from './adapter.html.js';
 
 /**
- * @typedef {import('./types.private.js').paypal_order} CreateResult
- * @typedef {import('@storecraft/core/v-api').PaymentGatewayStatus} PaymentGatewayStatus
- * @typedef {import('@storecraft/core/v-api').CheckoutStatusEnum} CheckoutStatusOptions
- * @typedef {import('@storecraft/core/v-api').OrderData} OrderData
- * @typedef {import('./types.public.js').Config} Config
- * @typedef {import('@storecraft/core/v-payments').payment_gateway<Config, CreateResult>} payment_gateway
+ * @typedef {import('./types.private.d.ts').paypal_order} CreateResult
+ * @typedef {import('@storecraft/core/api').PaymentGatewayStatus} PaymentGatewayStatus
+ * @typedef {import('@storecraft/core/api').CheckoutStatusEnum} CheckoutStatusOptions
+ * @typedef {import('@storecraft/core/api').OrderData} OrderData
+ * @typedef {import('./types.public.d.ts').Config} Config
+ * @typedef {import('@storecraft/core/payments').payment_gateway<Config, CreateResult>} payment_gateway
  */
 
 /**

package/adapter.utils.js

@@ -5,7 +5,7 @@ export const endpoints = {
 }
 
 /**
- * @typedef {import("./types.public.js").Config} Config
+ * @typedef {import("./types.public.d.ts").Config} Config
  */
 
 /**

package/{tsconfig.json → jsconfig.json}

@@ -1,11 +1,6 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
-    "target": "ESNext",
-    "resolveJsonModule": true,
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/payments-paypal",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Official Paypal integration with Storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -8,7 +8,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/store-craft/storecraft.git",
-    "directory": "packages/payments-paypal"
+    "directory": "packages/payments/payments-paypal"
   },
   "keywords": [
     "commerce",
@@ -17,8 +17,8 @@
     "storecraft"
   ],
   "type": "module",
-  "main": "index.js",
-  "types": "./types.public.d.ts",
+  "main": "adapter.js",
+  "types": "types.public.d.ts",
   "scripts": {
     "payments-paypal:test": "uvu -c",
     "payments-paypal:publish": "npm publish --access public"

package/types.public.d.ts

@@ -1,4 +1,4 @@
-export * from './index.js';
+export { Paypal } from './adapter.js';
 
 /**
  * @description gateway config

package/index.js

@@ -1 +0,0 @@
-export * from './adapter.js'