@storecraft/payments-stripe 1.0.10 → 1.0.11

package/README.md

@@ -19,14 +19,15 @@ import { Stripe } from '@storecraft/payments-stripe';
 import { Stripe as StripeCls } from 'stripe';
 
 const config = {
-  //`stripe` publishable key
-  publishable_key: 'pk_....',
+  //`stripe` publishable key. if missing, it will be inferred from env variable
+  publishable_key: env.process.STRIPE_PUBLISHABLE_KEY // 'pk_....',
 
-  // `stripe` private secret
-  secret: 'sk_.....',
+  // `stripe` private secret. if missing, it will be inferred from env variable
+  secret: process.env.STRIPE_SECRET_KEY //'sk_.....',
 
-  // (Optional) `stripe` private `webhook` secret
-  webhook_endpoint_secret: 'whsec_.....',
+  // (Optional) `stripe` private `webhook` secret.
+  // if missing, it will be inferred from env variable
+  webhook_endpoint_secret: process.env.STRIPE_WEBHOOK_SECRET // 'whsec_.....',
   
   // config options for `stripe`
   stripe_config: {
@@ -49,6 +50,12 @@ const config = {
 }
 
 new Stripe(config);
+
+// or, env variables will be inferred by 
+// - `STRIPE_PUBLISHABLE_KEY`
+// - `STRIPE_SECRET_KEY`
+// - `STRIPE_WEBHOOK_SECRET`
+new Stripe();
 ```
 
 ## In Storecraft App
@@ -66,13 +73,7 @@ const app = new App(config)
 .withStorage(new GoogleStorage())
 .withPaymentGateways(
   {
-    'stripe': new Stripe(
-      { 
-        publishable_key: process.env.STRIPE_PUBLISHABLE_KEY, 
-        secret_key: process.env.STRIPE_SECRET_KEY, 
-        webhook_endpoint_secret: process.env.STRIPE_WEBHOOK_SECRET
-      }
-    ),
+    'stripe': new Stripe() // 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 { ApiRequest, ApiResponse } from '@storecraft/core/rest'
@@ -31,25 +32,22 @@ export const metadata_storecraft_order_id = 'storecraft_order_id'
  */
 export class Stripe {
   
-  /** @type {Config} */ #_config;
+  /** @satisfies {ENV<Config>} */
+  static EnvConfig = /** @type{const} */ ({
+    publishable_key: 'STRIPE_PUBLISHABLE_KEY',
+    secret_key: 'STRIPE_SECRET_KEY',
+    webhook_endpoint_secret: 'STRIPE_WEBHOOK_SECRET',
+  });
 
-  /**
-   * 
-   * @param {Config} config 
-   */
-  constructor(config) {
-    this.#_config = this.#validate_and_resolve_config(config);
-    this.stripe = new StripeCls(
-      this.#_config.secret_key, this.#_config.stripe_config ?? {}
-    );
-  }
+  /** @type {Config} */ #_config;
+  /** @type {StripeCls} */ #stripe;
 
   /**
    * 
    * @param {Config} config 
    */
-  #validate_and_resolve_config(config) {
-    config = {
+  constructor(config={}) {
+    this.#_config = {
       stripe_config: {
         httpClient: StripeCls.createFetchHttpClient()
       },
@@ -65,9 +63,21 @@ export class Stripe {
         },
       },
       ...config,
-    }
+    };
+  }
 
-    const is_valid = config.publishable_key && config.secret_key;
+  /** @type {Impl["onInit"]} */
+  onInit = (app) => {
+    this.config.publishable_key ??=
+        app.platform.env[Stripe.EnvConfig.publishable_key];
+    this.config.secret_key ??= 
+        app.platform.env[Stripe.EnvConfig.secret_key];
+    this.config.webhook_endpoint_secret ??= 
+        app.platform.env[Stripe.EnvConfig.webhook_endpoint_secret];
+  }
+
+  get stripe() {
+    const is_valid = this.config.publishable_key && this.config.secret_key;
 
     if(!is_valid) {
       throw new StorecraftError(
@@ -76,7 +86,11 @@ export class Stripe {
       )
     }
 
-    return config;
+    this.#stripe = this.#stripe ?? new StripeCls(
+      this.config.secret_key, this.config.stripe_config ?? {}
+    );
+
+    return this.#stripe;
   }
 
   get info() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/payments-stripe",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "Official Storecraft <-> Stripe integration",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/types.public.d.ts

@@ -7,19 +7,21 @@ import type { Stripe as StripeCls } from 'stripe'
 export type Config = {
 
   /**
-   * @description `stripe` publishable key
+   * @description `stripe` publishable key. If missing, will be inferred from env variable `STRIPE_PUBLISHABLE_KEY`
    */
-  publishable_key: string;
+  publishable_key?: string;
 
   /**
-   * @description `stripe` private secret
+   * @description `stripe` private secret. If missing, will be inferred from env variable `STRIPE_SECRET_KEY`
    */
-  secret_key: string;
+  secret_key?: string;
 
   /**
    * @description (Optional) `webhook` Endpoint private secret in case
    * you are configuring webhook for async payments 
-   * [https://docs.stripe.com/webhooks?verify=check-signatures-library](https://docs.stripe.com/webhooks?verify=check-signatures-library)
+   * [https://docs.stripe.com/webhooks?verify=check-signatures-library](https://docs.stripe.com/webhooks?verify=check-signatures-library).
+   * 
+   * If missing, will be inferred from env variable `STRIPE_WEBHOOK_SECRET`
    */
   webhook_endpoint_secret?: string;