@storecraft/payments-stripe 1.0.9 → 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.html.js

@@ -1,3 +1,8 @@
+/**
+ * @import { Config } from './types.public.js'
+ * @import { OrderData } from '@storecraft/core/api'
+ */
+
 /**
  * 
  * @description Official `Stripe` UI integration with `storecraft`.
@@ -11,8 +16,8 @@
  * - Expiry date: 12/2027
  * - CVC code: 897
  * 
- * @param {import("./types.public.d.ts").Config} config 
- * @param {Partial<import("@storecraft/core/api").OrderData>} order_data 
+ * @param {Config} config 
+ * @param {Partial<OrderData>} order_data 
  */
 export default function html_buy_ui(config, order_data) {
 

package/adapter.js

@@ -1,3 +1,12 @@
+/**
+ * @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'
+ * @import { } from './types.private.js'
+ */
+
 import { 
   CheckoutStatusEnum, PaymentOptionsEnum 
 } from '@storecraft/core/api/types.api.enums.js';
@@ -7,11 +16,7 @@ import { Stripe as StripeCls } from 'stripe'
 
 /**
  * @typedef {StripeCls.Response<StripeCls.PaymentIntent>} CheckoutCreateResult
- * @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, CheckoutCreateResult>} payment_gateway
+ * @typedef {payment_gateway<Config, CheckoutCreateResult>} Impl
  */
 
 /**
@@ -21,31 +26,28 @@ import { Stripe as StripeCls } from 'stripe'
 export const metadata_storecraft_order_id = 'storecraft_order_id'
 
 /**
- * @implements {payment_gateway}
+ * @implements {Impl}
  * 
  * @description **Stripe** gateway (https://docs.stripe.com/payments/place-a-hold-on-a-payment-method)
  */
 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()
       },
@@ -61,9 +63,21 @@ export class Stripe {
         },
       },
       ...config,
-    }
+    };
+  }
+
+  /** @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];
+  }
 
-    const is_valid = config.publishable_key && config.secret_key;
+  get stripe() {
+    const is_valid = this.config.publishable_key && this.config.secret_key;
 
     if(!is_valid) {
       throw new StorecraftError(
@@ -72,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() {
@@ -110,7 +128,7 @@ export class Stripe {
 
   /**
    * 
-   * @type {payment_gateway["invokeAction"]}
+   * @type {Impl["invokeAction"]}
    */
   invokeAction(action_handle) {
     switch (action_handle) {
@@ -129,9 +147,7 @@ export class Stripe {
   /**
    * @description (Optional) buy link ui
    * 
-   * @param {Partial<OrderData>} order 
-   * 
-   * @return {Promise<string>} html 
+   * @type {Impl["onBuyLinkHtml"]}
    */
   async onBuyLinkHtml(order) {
 
@@ -143,9 +159,7 @@ export class Stripe {
   /**
    * @description on checkout create `hook`
    * 
-   * @param {OrderData} order 
-   * 
-   * @return {Promise<CheckoutCreateResult>}
+   * @type {Impl["onCheckoutCreate"]}
    */
   async onCheckoutCreate(order) {
 
@@ -169,12 +183,10 @@ export class Stripe {
    * client side into their servers, and then you are notified via a
    * webhook.
    * 
-   * @param {CheckoutCreateResult} create_result 
-   * 
-   * @return {ReturnType<payment_gateway["onCheckoutComplete"]>}  
+   * @type {Impl["onCheckoutComplete"]}  
    */
   async onCheckoutComplete(create_result) {
-
+    
     const intent = await this.stripe.paymentIntents.confirm(
       create_result.id
     );
@@ -215,11 +227,7 @@ export class Stripe {
   /**
    * @description Fetch the order and analyze it's status
    * 
-   * 
-   * @param {CheckoutCreateResult} create_result 
-   * 
-   * 
-   * @returns {Promise<PaymentGatewayStatus>}
+   * @type {Impl["status"]}
    */
   async status(create_result) {
     const o = await this.retrieve_order(create_result);
@@ -268,10 +276,8 @@ export class Stripe {
 
   /**
    * @description [https://docs.stripe.com/webhooks](https://docs.stripe.com/webhooks)
-   * @param {import('@storecraft/core/rest').ApiRequest} request 
-   * @param {import('@storecraft/core/rest').ApiResponse} response 
    * 
-   * @type {payment_gateway["webhook"]}
+   * @type {Impl["webhook"]}
    */
   async webhook(request, response) {
     const sig = request.headers.get('Stripe-Signature');
@@ -295,6 +301,7 @@ export class Stripe {
     /** @type {StripeCls.PaymentIntent} */
     let payment_intent;
 
+    /** @type {PaymentOptionsEnum[keyof PaymentOptionsEnum]} */
     let payment_status = PaymentOptionsEnum.unpaid;
     
     // Handle the event
@@ -323,8 +330,10 @@ export class Stripe {
       case 'charge.refund.updated':
         payment_status = PaymentOptionsEnum.refunded;
 
-      default:
+      default: {
         console.log(`Unhandled event type ${event.type}`);
+        return undefined;
+      }
     }
   
     // Return a response to acknowledge receipt of the event

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/payments-stripe",
-  "version": "1.0.9",
+  "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;