feat(stripe): new stripe package

docker-compose.yml

@@ -1,14 +1,14 @@
-version: '3.5'
+version: "3.5"
 
 services:
   rabbit:
-    image: 'rabbitmq:management'
+    image: "rabbitmq:management"
     environment:
-      RABBITMQ_ERLANG_COOKIE: 'SWQOKODSQALRPCLNMEQG'
-      RABBITMQ_DEFAULT_USER: 'rabbitmq'
-      RABBITMQ_DEFAULT_PASS: 'rabbitmq'
-      RABBITMQ_DEFAULT_VHOST: '/'
+      RABBITMQ_ERLANG_COOKIE: "SWQOKODSQALRPCLNMEQG"
+      RABBITMQ_DEFAULT_USER: "rabbitmq"
+      RABBITMQ_DEFAULT_PASS: "rabbitmq"
+      RABBITMQ_DEFAULT_VHOST: "/"
     ports:
-      - '15672:15672'
-      - '5672:5672'
+      - "15672:15672"
+      - "5672:5672"
     tty: true

package.json

@@ -11,7 +11,8 @@
     "@nestjs/platform-express": "^7.0.6",
     "lodash": "^4.17.11",
     "reflect-metadata": "^0.1.13",
-    "rxjs": "^6.4.0"
+    "rxjs": "^6.4.0",
+    "stripe": "^8.39.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^7.5.2",
@@ -34,7 +35,7 @@
     "husky": "^1.3.1",
     "jest": "^24.5.0",
     "jest-junit": "^9.0.0",
-    "lerna": "^3.13.1",
+    "lerna": "^3.20.2",
     "lint-staged": "^8.1.4",
     "prettier": "^2.0.2",
     "rimraf": "^2.6.3",

packages/hasura/README.md

@@ -1,21 +1,22 @@
 # @golevelup/nestjs-hasura
 
+Leverage NestJS to make incorporating business logic and event processing easier with Hasura. 🚀
+
 <p align="center">
 <a href="https://www.npmjs.com/package/@golevelup/nestjs-hasura"><img src="https://img.shields.io/npm/v/@golevelup/nestjs-hasura.svg?style=flat" alt="version" /></a>
 <a href="https://www.npmjs.com/package/@golevelup/nestjs-hasura"><img alt="downloads" src="https://img.shields.io/npm/dt/@golevelup/nestjs-hasura.svg?style=flat"></a>
 <img alt="license" src="https://img.shields.io/npm/l/@golevelup/nestjs-hasura.svg">
 </p>
 
-## Motivation
+## Features
+
+- 🎉 Exposes an API endpoint from your NestJS application at to be used for event processing from Hasura. Defaults to `/hasura/events/` but can be easily configured
 
-Leverage NestJS to make incorporating business logic and event processing easier with Hasura. 🚀
+- 🔒 Automatically validates that the event payload was actually sent from Hasura using configurable secrets
 
-## Features
+- 🕵️ Discovers providers from your application decorated with `HasuraEventHandler` and routes incoming events to them
 
-- ✅ 🎉 Exposes an API endpoint from your NestJS application at to be used for event processing from Hasura. Defaults to `/hasura/events/` but can be easily configured
-- ✅ 🔒 Automatically validates that the event payload was actually sent from Hasura using configurable secrets
-- ✅ 🕵️ Discovers providers from your application decorated with `HasuraEventHandler` and routes incoming events to them
-- ✅ 🧭 Leverage the table and schema name of the event to route to the appropriate handler
+- 🧭 Leverage the table and schema name of the event to route to the appropriate handler
 
 ## Usage
 
@@ -50,7 +51,7 @@ export class AppModule {
 
 ### Configuration
 
-The Hasura Module supports both the `forRoot` and `forRootAsync` patterns for configuration, so you can easily retrieve the the necessary config values from a `ConfigService` or other provider.
+The Hasura Module supports both the `forRoot` and `forRootAsync` patterns for configuration, so you can easily retrieve the necessary config values from a `ConfigService` or other provider.
 
 ### Registering Event Handlers
 

packages/hasura/src/tests/hasura.module.spec.ts

@@ -46,8 +46,6 @@ describe.each([undefined, 'customEndpoint'])(
       ? `/${controllerPrefix}/events`
       : defaultHasuraEndpoint;
 
-    console.log(`HASURA ENDPOINT: ${hasuraEndpoint}`);
-
     beforeEach(async () => {
       const moduleFixture: TestingModule = await Test.createTestingModule({
         imports: [

packages/stripe/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

packages/stripe/README.md

@@ -0,0 +1,113 @@
+# @golevelup/nestjs-stripe
+
+Interacting with the Stripe API or consuming Stripe webhooks in your NestJS applications is now easy as pie 🥧
+
+<p align="center">
+<a href="https://www.npmjs.com/package/@golevelup/nestjs-stripe"><img src="https://img.shields.io/npm/v/@golevelup/nestjs-stripe.svg?style=flat" alt="version" /></a>
+<a href="https://www.npmjs.com/package/@golevelup/nestjs-stripe"><img alt="downloads" src="https://img.shields.io/npm/dt/@golevelup/nestjs-stripe.svg?style=flat"></a>
+<img alt="license" src="https://img.shields.io/npm/l/@golevelup/nestjs-stripe.svg">
+</p>
+
+## Features
+
+- 💉 Injectable Stripe client for interacting with the Stripe API in Controllers and Providers
+
+- 🎉 Optionally exposes an API endpoint from your NestJS application at to be used for webhook event processing from Stripe. Defaults to `/stripe/webhook/` but can be easily configured
+
+- 🔒 Automatically validates that the event payload was actually sent from Stripe using the configured webhook signing secret
+
+- 🕵️ Discovers providers from your application decorated with `StripeWebhookHandler` and routes incoming events to them
+
+- 🧭 Route events to logical services easily simply by providing the Stripe webhook event type
+
+## Getting Started
+
+### Install
+
+`npm install ---save @golevelup/nestjs-stripe`
+
+or
+
+`yarn add @golevelup/nestjs-stripe`
+
+Also include the stripe peer dependency
+
+`npm install ---save stripe`
+
+or
+
+`yarn add stripe`
+
+### Import
+
+Import and add `StripeModule` to the `imports` section of the consuming module (most likely `AppModule`). Your Stripe API key is required, and you can optionally include a webhook configuration if you plan on consuming Stripe webhook events inside your app.
+
+```typescript
+import { StripeModule } from '@golevelup/nestjs-stripe';
+
+@Module({
+  imports: [
+    StripeModule.forRoot(StripeModule, {
+      apiKey: '123',
+      webhookConfig: {
+        stripeWebhookSecret: 'abc',
+      },
+    }),
+  ],
+})
+export class AppModule {
+  // ...
+}
+```
+
+### Configuration
+
+The Stripe Module supports both the `forRoot` and `forRootAsync` patterns for configuration, so you can easily retrieve the necessary config values from a `ConfigService` or other provider.
+
+### Injectable Providers
+
+The module exposes two injectable providers with accompanying decorators for your convenience. These can be provided to the constructors of controllers and other providers:
+
+```typescript
+ // injects the instantiated Stripe client which can be used to make API calls
+@InjectStripeClient() stripeClient: Stripe
+```
+
+```typescript
+// injects the module configuration
+@InjectStripeModuleConfig() config: StripeModuleConfig
+```
+
+## Consuming Webhooks
+
+### Included API Endpoint
+
+This module will automatically add a new API endpoint to your NestJS application for processing webhooks. By default, the route for this endpoint will be `stripe/webhook` but you can modify this to use a different prefix using the `controllerPrefix` property of the `webhookConfig` when importing the module.
+
+### ⚠️ Configure Raw Request Body Handling
+
+If you would like your NestJS application to be able to process incoming webhooks, it is essential that Stripe has access to the raw request payload.
+
+By default, NestJS is configured to use JSON body parsing middleware which will transform the request before it can be validated by the Stripe library. The easiest solution is to also include the `@golevelup/nestjs-webhooks` package and [follow the steps for setting up simple body parsing](https://github.com/golevelup/nestjs/tree/master/packages/webhooks#simple-raw-body-parsing). Simply provide either `stripe/webhook` or the API route you chose when configuring the module
+
+Failure to give Stripe access to the raw body will result in nasty runtime errors when events are sent to your endpoint
+
+### Decorate Methods For Processing Webhook Events
+
+Exposing provider/service methods to be used for processing Stripe events is easy! Simply use the provided decorator and indiciate the event type that the handler should receive.
+
+[Review the Stripe documentation](https://stripe.com/docs/api/events/types) for more information about the types of events available.
+
+```typescript
+@Injectable()
+class PaymentCreatedService {
+  @StripeWebhookHandler('payment_intent.created')
+  handlePaymentIntentCreated(evt: StripeEvent) {
+    // execute your custom business logic
+  }
+}
+```
+
+### Configure Webhooks in the Stripe Dashboard
+
+Follow the instructions from the [Stripe Documentation](https://stripe.com/docs/webhooks) for remaining integration steps such as testing your integration with the CLI before you go live and properly configuring the endpoint from the Stripe dashboard so that the correct events are sent to your NestJS app.