@storecraft/payments-paypal 1.0.10 → 1.0.12

package/README.md

@@ -19,13 +19,13 @@ npm i @storecraft/payments-paypal
 
 ## Howto
 
-```js
-import { PayPal } from '@storecraft/payments-paypal';
+```ts
+import { PayPal, Config } from '@storecraft/payments-paypal';
 
-const config = {
+const config: Config = {
   env: 'prod',
-  client_id: '<get-from-your-paypal-dashboard>',
-  secret: '<get-from-your-paypal-dashboard>',
+  client_id: process.env.PAYPAL_CLIENT_ID,
+  secret: env.process.PAYPAL_SECRET,
   currency_code: 'USD',
   intent_on_checkout: 'AUTHORIZE'
 }
@@ -48,13 +48,7 @@ const app = new App(config)
 .withStorage(new GoogleStorage())
 .withPaymentGateways(
   {
-    'paypal_standard_prod': new Paypal(
-      { 
-        client_id: process.env.PAYPAL_CLIENT_ID, 
-        secret: process.env.PAYPAL_SECRET, 
-        env: 'prod' 
-      }
-    ),
+    'paypal_standard_prod': new Paypal() // config can be inferred from env variables
   }
 );
 

package/adapter.js

@@ -1,5 +1,6 @@
 /**
  * @import { Config } from './types.public.js'
+ * @import { ENV } from '@storecraft/core';
  * @import { OrderData, PaymentGatewayStatus } from '@storecraft/core/api'
  * @import { payment_gateway } from '@storecraft/core/payments'
  * @import { paypal_order, paypal_order_request } from './types.private.js'
@@ -16,6 +17,7 @@ import html_buy_ui from './adapter.html.js';
  * @typedef {payment_gateway<Config, CreateResult>} Impl
  */
 
+
 /**
  * @description **Paypal Payment** gateway (https://developer.paypal.com/docs/checkout/)
  * 
@@ -23,29 +25,46 @@ import html_buy_ui from './adapter.html.js';
 */
 export class Paypal {
   
-  /** @type {Config} */ #_config;
+  /** @satisfies {ENV<Config>} */
+  static EnvConfigProd = /** @type{const} */ ({
+    client_id: `PAYPAL_CLIENT_ID_PROD`,
+    secret: 'PAYPAL_SECRET_PROD',
+  });
+
+  /** @satisfies {ENV<Config>} */
+  static EnvConfigTest = /** @type{const} */ ({
+    client_id: `PAYPAL_CLIENT_ID_TEST`,
+    secret: 'PAYPAL_SECRET_TEST',
+  });
 
-  /**
-   * 
-   * @param {Config} config 
-   */
-  constructor(config) {
-    this.#_config = this.#validate_and_resolve_config(config);
-  }
+  /** @type {Config} */ #_config;
 
   /**
    * 
    * @param {Config} config 
    */
-  #validate_and_resolve_config(config) {
-    config = {
+  constructor(config={}) {
+    // this.#_config = this.#validate_and_resolve_config(config);
+    this.#_config = {
       default_currency_code: 'USD',
       env: 'prod',
       intent_on_checkout: 'AUTHORIZE',
       ...config,
     }
+  }
 
-    const is_valid = config.client_id && config.secret;
+  /** @type {Impl["onInit"]} */
+  onInit = (app) => {
+    const is_prod = Boolean(this.config.env==='prod');
+    this.config.client_id ??= app.platform.env[
+      is_prod ? Paypal.EnvConfigProd.client_id : Paypal.EnvConfigTest.client_id
+    ] ?? 'PAYPAL_CLIENT_ID';
+
+    this.config.secret ??= app.platform.env[
+      is_prod ? Paypal.EnvConfigProd.secret : Paypal.EnvConfigTest.secret
+    ] ?? 'PAYPAL_SECRET';
+
+    const is_valid = this.config.client_id && this.config.secret;
 
     if(!is_valid) {
       throw new StorecraftError(
@@ -53,8 +72,6 @@ export class Paypal {
         Missing client_id or secret`
       )
     }
-
-    return config;
   }
 
   get info() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/payments-paypal",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Official Paypal integration with Storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/types.public.d.ts

@@ -6,26 +6,33 @@ export { Paypal } from './adapter.js';
 export type Config = {
   /**
    * @description default currency code
+   * @default 'USD'
    */
   default_currency_code?: string;
 
   /**
    * @description the environment
+   * @default 'prod'
    */
-  env: 'prod' | 'test';
+  env?: 'prod' | 'test';
 
   /**
-   * @description private client id
+   * @description private client id. If missing, 
+   * - if `env===prod` -> will be inferred from env variable `PAYPAL_CLIENT_ID_PROD` or `PAYPAL_CLIENT_ID`
+   * - if `env===test` -> will be inferred from env variable `PAYPAL_CLIENT_ID_TEST` or `PAYPAL_CLIENT_ID`
    */
-  client_id: string;
+  client_id?: string;
 
   /**
-   * @description private secret
+   * @description private secret. If missing, 
+   * - if `env===prod` -> will be inferred from env variable `PAYPAL_SECRET_PROD` or `PAYPAL_SECRET`
+   * - if `env===test` -> will be inferred from env variable `PAYPAL_SECRET_TEST` or `PAYPAL_SECRET`
    */
-  secret: string;
+  secret?: string;
   
   /**
    * @description default intent to `authorize` or `capture` on order creation
+   * @default 'AUTHORIZE'
    */
   intent_on_checkout?: 'AUTHORIZE' | 'CAPTURE';
 }