@payloadcms/plugin-stripe 0.0.2 → 0.0.4

package/README.md

@@ -24,11 +24,11 @@ In the `plugins` array of your [Payload config](https://payloadcms.com/docs/conf
 
 ```js
 import { buildConfig } from 'payload/config';
-import stripe from '@payloadcms/plugin-stripe';
+import stripePlugin from '@payloadcms/plugin-stripe';
 
 const config = buildConfig({
   plugins: [
-    stripe({
+    stripePlugin({
       stripeSecretKey: process.env.STRIPE_SECRET_KEY,
     })
   ]
@@ -43,7 +43,7 @@ export default config;
 
   Required. Your Stripe secret key.
 
-- `stripeWebhookEndpointSecret`
+- `stripeWebhooksEndpointSecret`
 
   Optional. Your Stripe webhook endpoint secret. This is needed only if you wish to sync data from Stripe to Payload.
 
@@ -53,7 +53,7 @@ export default config;
 
 ### Endpoints
 
-One core functionality of this plugin is to enable a two-way communication channel between Stripe and Payload. To do this, the following custom endpoints are automatically opened for you:
+One core functionality of this plugin is to enable a two-way communication channel between Stripe and Payload. To do this, the following custom endpoints are automatically opened for you.
 
 >NOTE: the `/api` part of these routes may be different based on the settings defined in your Payload config.
 
@@ -84,20 +84,25 @@ One core functionality of this plugin is to enable a two-way communication chann
 
 ### Webhooks
 
-This plugin also allows for a two-way data sync from Stripe to Payload using [Stripe webhooks](https://stripe.com/docs/webhooks). Webhooks listen for events on your Stripe account so you can trigger reactions to them. To enable webhooks:
+[Stripe webhooks](https://stripe.com/docs/webhooks) are used to sync from Stripe to Payload. Webhooks listen for events on your Stripe account so you can trigger reactions to them. Follow the steps below to enable webhooks.
 
+Development:
+1. Login using Stripe cli `stripe login`
+1. Forward events to localhost `stripe listen --forward-to localhost:3000/api/stripe/webhooks`
+
+Production:
 1. Login and [create a new webhook](https://dashboard.stripe.com/test/webhooks/create) from the Stripe dashboard
-1. Paste `/api/stripe/webhooks` as the "Webhook Endpoint URL"
+1. Paste `YOUR_DOMAIN_NAME/api/stripe/webhooks` as the "Webhook Endpoint URL"
 1. Select which events to broadcast
 1. Then, handle these events using the `webhooks` portion of this plugin's config:
 
 ```js
 import { buildConfig } from 'payload/config';
-import stripe from '@payloadcms/plugin-stripe';
+import stripePlugin from '@payloadcms/plugin-stripe';
 
 const config = buildConfig({
   plugins: [
-    stripe({
+    stripePlugin({
       stripeSecretKey: process.env.STRIPE_SECRET_KEY,
       stripeWebhooksEndpointSecret: process.env.STRIPE_WEBHOOKS_ENDPOINT_SECRET,
       webhooks: {
@@ -114,7 +119,28 @@ For a full list of available webhooks, see [here](https://stripe.com/docs/cli/tr
 
 ### Node
 
-You can also proxy the Stripe API server-side using the `stripeProxy` function exported by the plugin. This is exactly what the `/api/stripe/rest` endpoint does behind-the-scenes. Here's an example:
+On the server you should interface with Stripe directly using the [stripe](https://www.npmjs.com/package/stripe) npm module. That might look something like this:
+
+```js
+import Stripe from 'stripe';
+
+const stripeSecretKey = process.env.STRIPE_SECRET_KEY;
+const stripe = new Stripe(stripeSecretKey, { apiVersion: '2022-08-01' });
+
+export const MyFunction = async () => {
+  try {
+    const customer = await stripe.customers.create({
+      email: data.email,
+    });
+
+    // DO SOMETHING
+  } catch (error) {
+    console.error(error.message);
+  }
+}
+```
+
+Alternatively, you can interface with the Stripe using the `stripeProxy`, which is exactly what the `/api/stripe/rest` endpoint does behind-the-scenes. Here's the same example as above, but piped through the proxy:
 
 ```js
 import { stripeProxy } from '@payloadcms/plugin-stripe';
@@ -156,7 +182,7 @@ import {
 
 ### Development
 
-This plugin can be developed locally using any Stripe account that you have access to. Then:
+For development purposes, there is a full working example of how this plugin might be used in the [demo](./demo) of this repo. This demo can be developed locally using any Stripe account, you just need a working API key. Then:
 
 ```bash
 git clone git@github.com:payloadcms/plugin-stripe.git \

package/dist/extendWebpackConfig.d.ts

@@ -0,0 +1,3 @@
+import type { Config } from 'payload/config';
+import type { Configuration as WebpackConfig } from 'webpack';
+export declare const extendWebpackConfig: (config: Config) => (webpackConfig: WebpackConfig) => WebpackConfig;

package/dist/extendWebpackConfig.js

@@ -0,0 +1,31 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extendWebpackConfig = void 0;
+var path_1 = __importDefault(require("path"));
+var mockModulePath = path_1.default.resolve(__dirname, 'mocks/serverModule.js');
+var extendWebpackConfig = function (config) {
+    return function (webpackConfig) {
+        var _a;
+        var _b, _c;
+        var existingWebpackConfig = typeof ((_b = config.admin) === null || _b === void 0 ? void 0 : _b.webpack) === 'function'
+            ? config.admin.webpack(webpackConfig)
+            : webpackConfig;
+        return __assign(__assign({}, existingWebpackConfig), { resolve: __assign(__assign({}, (existingWebpackConfig.resolve || {})), { alias: __assign(__assign({}, (((_c = existingWebpackConfig.resolve) === null || _c === void 0 ? void 0 : _c.alias) ? existingWebpackConfig.resolve.alias : {})), (_a = { "stripe": mockModulePath }, _a[path_1.default.resolve(__dirname, 'routes/rest')] = mockModulePath, _a[path_1.default.resolve(__dirname, 'routes/webhooks')] = mockModulePath, _a)) }) });
+    };
+};
+exports.extendWebpackConfig = extendWebpackConfig;
+//# sourceMappingURL=extendWebpackConfig.js.map

package/dist/extendWebpackConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extendWebpackConfig.js","sourceRoot":"","sources":["../src/extendWebpackConfig.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,8CAAuB;AAGvB,IAAM,cAAc,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC;AAEjE,IAAM,mBAAmB,GAAG,UAAC,MAAc;IAChD,OAAA,UAAA,aAAa;;;QACX,IAAM,qBAAqB,GACzB,OAAO,CAAA,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,CAAA,KAAK,UAAU;YACzC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YACrC,CAAC,CAAC,aAAa,CAAA;QAEnB,6BACK,qBAAqB,KACxB,OAAO,wBACF,CAAC,qBAAqB,CAAC,OAAO,IAAI,EAAE,CAAC,KACxC,KAAK,wBACA,CAAC,CAAA,MAAA,qBAAqB,CAAC,OAAO,0CAAE,KAAK,EAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,WACpF,QAAQ,EAAE,cAAc,OACvB,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,IAAG,cAAc,KACvD,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,IAAG,cAAc,aAGjE;IACH,CAAC;AAlBD,CAkBC,CAAA;AAnBU,QAAA,mBAAmB,uBAmB7B"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import { Config } from 'payload/config';
 import { StripeConfig } from './types';
-declare const stripe: (stripeConfig: StripeConfig) => (config: Config) => Config;
-export default stripe;
+declare const stripePlugin: (stripeConfig: StripeConfig) => (config: Config) => Config;
+export default stripePlugin;

package/dist/index.js

@@ -22,8 +22,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var rest_1 = require("./routes/rest");
 var webhooks_1 = require("./routes/webhooks");
-var stripe = function (stripeConfig) { return function (config) {
-    return (__assign(__assign({}, config), { endpoints: __spreadArray(__spreadArray([], (config === null || config === void 0 ? void 0 : config.endpoints) || [], true), [
+var extendWebpackConfig_1 = require("./extendWebpackConfig");
+var stripePlugin = function (stripeConfig) { return function (config) {
+    return (__assign(__assign({}, config), { admin: __assign(__assign({}, config.admin), { webpack: (0, extendWebpackConfig_1.extendWebpackConfig)(config) }), endpoints: __spreadArray(__spreadArray([], (config === null || config === void 0 ? void 0 : config.endpoints) || [], true), [
             {
                 path: '/stripe/webhooks',
                 method: 'post',
@@ -40,5 +41,5 @@ var stripe = function (stripeConfig) { return function (config) {
             },
         ], false) }));
 }; };
-exports.default = stripe;
+exports.default = stripePlugin;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AACA,sCAA2C;AAC3C,8CAAmD;AAGnD,IAAM,MAAM,GAAG,UAAC,YAA0B,IAAK,OAAA,UAAC,MAAc;IAC5D,OAAO,uBACF,MAAM,KACT,SAAS,kCACJ,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,KAAI,EAAE;YAC1B;gBACE,IAAI,EAAE,kBAAkB;gBACxB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,UAAC,GAAG,EAAE,GAAG,EAAE,IAAI;oBACtB,IAAA,yBAAc,EAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;gBAC9C,CAAC;aACF;YACD;gBACE,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,UAAC,GAAG,EAAE,GAAG,EAAE,IAAI;oBACtB,IAAA,iBAAU,EAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;gBAC1C,CAAC;aACF;qBAEH,CAAA;AACJ,CAAC,EArB8C,CAqB9C,CAAC;AAEF,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AACA,sCAA2C;AAC3C,8CAAmD;AAEnD,6DAA4D;AAE5D,IAAM,YAAY,GAAG,UAAC,YAA0B,IAAK,OAAA,UAAC,MAAc;IAClE,OAAO,uBACF,MAAM,KACT,KAAK,wBACA,MAAM,CAAC,KAAK,KACf,OAAO,EAAE,IAAA,yCAAmB,EAAC,MAAM,CAAC,KAEtC,SAAS,kCACJ,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,KAAI,EAAE;YAC1B;gBACE,IAAI,EAAE,kBAAkB;gBACxB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,UAAC,GAAG,EAAE,GAAG,EAAE,IAAI;oBACtB,IAAA,yBAAc,EAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;gBAC9C,CAAC;aACF;YACD;gBACE,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,UAAC,GAAG,EAAE,GAAG,EAAE,IAAI;oBACtB,IAAA,iBAAU,EAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;gBAC1C,CAAC;aACF;qBAEH,CAAA;AACJ,CAAC,EAzBoD,CAyBpD,CAAC;AAEF,kBAAe,YAAY,CAAC"}

package/dist/mocks/serverModule.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/mocks/serverModule.js

@@ -0,0 +1,3 @@
+"use strict";
+module.exports = {};
+//# sourceMappingURL=serverModule.js.map

package/dist/mocks/serverModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serverModule.js","sourceRoot":"","sources":["../../src/mocks/serverModule.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG,EAAE,CAAA"}

package/dist/routes/webhooks.js

@@ -6,14 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.stripeWebhooks = void 0;
 var stripe_1 = __importDefault(require("stripe"));
 var stripeWebhooks = function (req, res, next, stripeConfig) {
-    var stripeSecretKey = stripeConfig.stripeSecretKey, stripeWebhookEndpointSecret = stripeConfig.stripeWebhookEndpointSecret, webhooks = stripeConfig.webhooks;
-    if (webhooks && stripeWebhookEndpointSecret) {
+    var stripeSecretKey = stripeConfig.stripeSecretKey, stripeWebhooksEndpointSecret = stripeConfig.stripeWebhooksEndpointSecret, webhooks = stripeConfig.webhooks;
+    if (webhooks && stripeWebhooksEndpointSecret) {
         var stripe = new stripe_1.default(stripeSecretKey, { apiVersion: '2022-08-01' });
         var stripeSignature = req.headers['stripe-signature'];
         if (stripeSignature) {
             var event_1;
             try {
-                event_1 = stripe.webhooks.constructEvent(req.body, stripeSignature, stripeWebhookEndpointSecret);
+                event_1 = stripe.webhooks.constructEvent(req.body, stripeSignature, stripeWebhooksEndpointSecret);
             }
             catch (err) {
                 res.status(400).send("Webhook Error: ".concat(err.message));

package/dist/routes/webhooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/routes/webhooks.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA4B;AAKrB,IAAM,cAAc,GAAG,UAC5B,GAAmB,EACnB,GAAa,EACb,IAAS,EACT,YAA0B;IAGxB,IAAA,eAAe,GAGb,YAAY,gBAHC,EACf,2BAA2B,GAEzB,YAAY,4BAFa,EAC3B,QAAQ,GACN,YAAY,SADN,CACO;IAEjB,IAAI,QAAQ,IAAI,2BAA2B,EAAE;QAC3C,IAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,eAAe,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAEzE,IAAM,eAAe,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAExD,IAAI,eAAe,EAAE;YACnB,IAAI,OAA+B,CAAC;YAEpC,IAAI;gBACF,OAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;aAChG;YAAC,OAAO,GAAQ,EAAE;gBACjB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,yBAAkB,GAAG,CAAC,OAAO,CAAE,CAAC,CAAC;aACvD;YAED,IAAI,OAAK,EAAE;gBACT,IAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAK,CAAC,IAAI,CAAC,CAAC;gBACjD,IAAI,OAAO,mBAAmB,KAAK,UAAU,EAAE;oBAC7C,mBAAmB,CAAC,OAAK,EAAE,MAAM,EAAE,YAAY,CAAC,CAAA;iBACjD;gBAAA,CAAC;aACH;SACF;KACF;IAED,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC;AApCW,QAAA,cAAc,kBAoCzB"}
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/routes/webhooks.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA4B;AAKrB,IAAM,cAAc,GAAG,UAC5B,GAAmB,EACnB,GAAa,EACb,IAAS,EACT,YAA0B;IAGxB,IAAA,eAAe,GAGb,YAAY,gBAHC,EACf,4BAA4B,GAE1B,YAAY,6BAFc,EAC5B,QAAQ,GACN,YAAY,SADN,CACO;IAEjB,IAAI,QAAQ,IAAI,4BAA4B,EAAE;QAC5C,IAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,eAAe,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;QAEzE,IAAM,eAAe,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAExD,IAAI,eAAe,EAAE;YACnB,IAAI,OAA+B,CAAC;YAEpC,IAAI;gBACF,OAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,4BAA4B,CAAC,CAAC;aACjG;YAAC,OAAO,GAAQ,EAAE;gBACjB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,yBAAkB,GAAG,CAAC,OAAO,CAAE,CAAC,CAAC;aACvD;YAED,IAAI,OAAK,EAAE;gBACT,IAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAK,CAAC,IAAI,CAAC,CAAC;gBACjD,IAAI,OAAO,mBAAmB,KAAK,UAAU,EAAE;oBAC7C,mBAAmB,CAAC,OAAK,EAAE,MAAM,EAAE,YAAY,CAAC,CAAA;iBACjD;gBAAA,CAAC;aACH;SACF;KACF;IAED,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/B,CAAC,CAAC;AApCW,QAAA,cAAc,kBAoCzB"}

package/dist/types.d.ts

@@ -2,7 +2,7 @@ import Stripe from "stripe";
 export declare type StripeWebhookHandler = (event: any, stripe: Stripe, stripeConfig: StripeConfig) => void;
 export declare type StripeConfig = {
     stripeSecretKey: string;
-    stripeWebhookEndpointSecret?: string;
+    stripeWebhooksEndpointSecret?: string;
     webhooks?: {
         [webhookName: string]: StripeWebhookHandler;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/plugin-stripe",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "homepage:": "https://payloadcms.com",
   "repository": "git@github.com:payloadcms/plugin-stripe.git",
   "description": "Stripe plugin for Payload CMS",
@@ -16,7 +16,10 @@
     "cms",
     "plugin",
     "typescript",
-    "payments"
+    "payments",
+    "saas",
+    "subscriptions",
+    "licensing"
   ],
   "author": "dev@payloadcms.com",
   "license": "MIT",