@payloadcms/plugin-stripe 0.0.1 → 0.0.2

package/README.md

@@ -2,12 +2,13 @@
 
 [![NPM](https://img.shields.io/npm/v/@payloadcms/plugin-stripe)](https://www.npmjs.com/package/@payloadcms/plugin-stripe)
 
-A plugin for [Payload CMS](https://github.com/payloadcms/payload) to manage a [Stripe](https://stripe.com/) account through Payload.
+A plugin for [Payload CMS](https://github.com/payloadcms/payload) to manage [Stripe](https://stripe.com) through Payload.
 
 Core features:
-  - Layers your Stripe account with Payload access control
-  - Opens custom routes to interface with the Stripe REST API
-  - Handles Stripe webhooks to allow for a two-way data sync
+  - Layers your Stripe account behind [Payload access control](https://payloadcms.com/docs/access-control/overview)
+  - Enables a two-way communication channel between Stripe and Payload
+    - Proxies the [Stripe REST API](https://stripe.com/docs/api)
+    - Proxies [Stripe webhooks](https://stripe.com/docs/webhooks)
 
 ## Installation
 
@@ -50,21 +51,27 @@ export default config;
 
   Optional. An object of Stripe webhook handlers, keyed to the name of the event. See [webhooks](#webhooks) for more details or for a list of all available webhooks, see [here](https://stripe.com/docs/cli/trigger#trigger-event).
 
-### Routes
+### Endpoints
 
-The following routes are automatically opened to allow you to interact with the Stripe API behind Payload access control. This allows you to read and make updates to your account.
+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.
 
 - `POST /api/stripe/rest`
 
-  Calls the given [Stripe REST API](https://stripe.com/docs/api) method and returns the result.
+  Proxies the [Stripe REST API](https://stripe.com/docs/api) behind [Payload access control](https://payloadcms.com/docs/access-control/overview) and returns the result. If you need to proxy the API server-side, use the [stripeProxy](#node) function.
 
-  ```
+  ```js
     const res = await fetch(`/api/stripe/rest`, {
+      method: 'POST',
+      credentials: 'include',
+      headers: {
+        ContentType: 'application/json',
+        // Authorization: `JWT ${token}` // NOTE: do this if not in a browser (i.e. curl or Postman)
+      },
       body: JSON.stringify({
         stripeMethod: "stripe.subscriptions.list",
-        stripeMethodArgs: {
+        stripeArgs: {
           customer: "abc"
         }
       })
@@ -105,6 +112,36 @@ export default config;
 
 For a full list of available webhooks, see [here](https://stripe.com/docs/cli/trigger#trigger-event).
 
+### 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:
+
+```js
+import { stripeProxy } from '@payloadcms/plugin-stripe';
+
+export const MyFunction = async () => {
+  try {
+    const customer = await stripeProxy({
+      stripeSecretKey: process.env.STRIPE_SECRET_KEY,
+      stripeMethod: 'customers.create',
+      stripeArgs: {
+        email: data.email,
+      }
+    });
+
+    if (customer.status === 200) {
+      // DO SOMETHING
+    }
+
+    if (customer.status >= 400) {
+      throw new Error(customer.message);
+    }
+  } catch (error) {
+    console.error(error.message);
+  }
+}
+```
+
 ## TypeScript
 
 All types can be directly imported:
@@ -112,7 +149,8 @@ All types can be directly imported:
 ```js
 import {
   StripeConfig,
-  WebhookHandler
+  StripeWebhookHandler.
+  StripeProxy
 } from '@payloadcms/plugin-stripe/dist/types';
 ```
 

package/dist/routes/rest.d.ts

@@ -1,4 +1,4 @@
 import { PayloadRequest } from 'payload/types';
 import { StripeConfig } from '../types';
 import { Response } from 'express';
-export declare const stripeREST: (req: PayloadRequest, res: Response, next: any, stripeConfig: StripeConfig) => Promise<any>;
+export declare const stripeREST: (req: PayloadRequest, res: Response, next: any, stripeConfig: StripeConfig) => Promise<Response<any, Record<string, any>> | undefined>;

package/dist/routes/rest.js

@@ -35,53 +35,42 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stripeREST = void 0;
 var errors_1 = require("payload/errors");
-var stripe_1 = __importDefault(require("stripe"));
-var lodash_get_1 = __importDefault(require("lodash.get"));
+var stripeProxy_1 = require("../utilities/stripeProxy");
 var stripeREST = function (req, res, next, stripeConfig) { return __awaiter(void 0, void 0, void 0, function () {
-    var stripeSecretKey, stripe, _a, stripeMethod, stripeArgs // 'cus_MGgt3Tuj3D66f2'
-    , user, topLevelMethod, contextToBind, foundMethod, stripeResponse, err_1;
+    var payload, user, _a, stripeMethod, stripeArgs // example: 'cus_MGgt3Tuj3D66f2'
+    , stripeSecretKey, pluginRes, status_1, error_1, message;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
+                payload = req.payload, user = req.user, _a = req.body, stripeMethod = _a.stripeMethod, stripeArgs = _a.stripeArgs;
                 stripeSecretKey = stripeConfig.stripeSecretKey;
-                stripe = new stripe_1.default(stripeSecretKey, { apiVersion: '2022-08-01' });
                 _b.label = 1;
             case 1:
-                _b.trys.push([1, 7, , 8]);
-                _a = req.body, stripeMethod = _a.stripeMethod, stripeArgs = _a.stripeArgs, user = req.user;
+                _b.trys.push([1, 3, , 4]);
                 if (!user) { // TODO: make this customizable from the config
                     throw new errors_1.Forbidden();
                 }
-                if (!(typeof stripeMethod === 'string')) return [3 /*break*/, 5];
-                topLevelMethod = stripeMethod.split('.')[0];
-                contextToBind = stripe[topLevelMethod];
-                foundMethod = (0, lodash_get_1.default)(stripe, stripeMethod).bind(contextToBind);
-                if (!(typeof foundMethod === 'function')) return [3 /*break*/, 3];
-                return [4 /*yield*/, foundMethod(stripeArgs)];
+                return [4 /*yield*/, (0, stripeProxy_1.stripeProxy)({
+                        stripeSecretKey: stripeSecretKey,
+                        stripeMethod: stripeMethod,
+                        stripeArgs: stripeArgs // example: 'cus_MGgt3Tuj3D66f2'
+                    })];
             case 2:
-                stripeResponse = _b.sent();
-                if (!(stripeResponse === null || stripeResponse === void 0 ? void 0 : stripeResponse.data)) {
-                    return [2 /*return*/, res.status(404)];
-                }
-                return [2 /*return*/, res.json(stripeResponse)];
+                pluginRes = _b.sent();
+                status_1 = pluginRes.status;
+                res.status(status_1).json(pluginRes);
+                return [3 /*break*/, 4];
             case 3:
-                console.warn("The provide Stripe method of '".concat(stripeMethod, "' is not a part of the Stripe API."));
-                return [2 /*return*/, next()];
-            case 4: return [3 /*break*/, 6];
-            case 5:
-                console.warn('You must provide a Stripe method to call.');
-                return [2 /*return*/, next()];
-            case 6: return [3 /*break*/, 8];
-            case 7:
-                err_1 = _b.sent();
-                return [2 /*return*/, next(err_1)];
-            case 8: return [2 /*return*/];
+                error_1 = _b.sent();
+                message = "An error has occurred in the Stripe plugin REST handler: '".concat(error_1, "'");
+                payload.logger.error(message);
+                return [2 /*return*/, res.status(500).json({
+                        message: message
+                    })];
+            case 4: return [2 /*return*/];
         }
     });
 }); };

package/dist/routes/rest.js.map

@@ -1 +1 @@
-{"version":3,"file":"rest.js","sourceRoot":"","sources":["../../src/routes/rest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,yCAA2C;AAC3C,kDAA4B;AAE5B,0DAAmC;AAG5B,IAAM,UAAU,GAAG,UACxB,GAAmB,EACnB,GAAa,EACb,IAAS,EACT,YAA0B;;;;;;gBAElB,eAAe,GAAK,YAAY,gBAAjB,CAAkB;gBAEnC,MAAM,GAAG,IAAI,gBAAM,CAAC,eAAe,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;;;;gBAIrE,KAKE,GAAG,KAFJ,EAFC,YAAY,kBAAA,EACZ,UAAU,gBAAA,EAEZ,IAAI,GACF,GAAG,KADD,CACE;gBAER,IAAI,CAAC,IAAI,EAAE,EAAE,+CAA+C;oBAC1D,MAAM,IAAI,kBAAS,EAAE,CAAC;iBACvB;qBAEG,CAAA,OAAO,YAAY,KAAK,QAAQ,CAAA,EAAhC,wBAAgC;gBAC5B,cAAc,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAiB,CAAC;gBAC5D,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;gBACvC,WAAW,GAAG,IAAA,oBAAS,EAAC,MAAM,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;qBAEpE,CAAA,OAAO,WAAW,KAAK,UAAU,CAAA,EAAjC,wBAAiC;gBACZ,qBAAM,WAAW,CAAC,UAAU,CAAC,EAAA;;gBAA9C,cAAc,GAAG,SAA6B;gBAEpD,IAAI,CAAC,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,IAAI,CAAA,EAAE;oBACzB,sBAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAC;iBACxB;gBAED,sBAAO,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,EAAC;;gBAEhC,OAAO,CAAC,IAAI,CAAC,wCAAiC,YAAY,uCAAoC,CAAC,CAAC;gBAChG,sBAAO,IAAI,EAAE,EAAC;;;gBAGhB,OAAO,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;gBAC1D,sBAAO,IAAI,EAAE,EAAC;;;;gBAIhB,sBAAO,IAAI,CAAC,KAAG,CAAC,EAAC;;;;KAEpB,CAAC;AAhDW,QAAA,UAAU,cAgDrB"}
+{"version":3,"file":"rest.js","sourceRoot":"","sources":["../../src/routes/rest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,yCAA2C;AAG3C,wDAAuD;AAEhD,IAAM,UAAU,GAAG,UACxB,GAAmB,EACnB,GAAa,EACb,IAAS,EACT,YAA0B;;;;;;gBAGxB,OAAO,GAML,GAAG,QANE,EACP,IAAI,GAKF,GAAG,KALD,EACJ,KAIE,GAAG,KADJ,EAFC,YAAY,kBAAA,EACZ,UAAU,gBAAA,CAEN;gBAEA,eAAe,GAAK,YAAY,gBAAjB,CAAkB;;;;gBAGvC,IAAI,CAAC,IAAI,EAAE,EAAE,+CAA+C;oBAC1D,MAAM,IAAI,kBAAS,EAAE,CAAC;iBACvB;gBAEiB,qBAAM,IAAA,yBAAW,EAAC;wBAClC,eAAe,iBAAA;wBACf,YAAY,cAAA;wBACZ,UAAU,YAAA,CAAC,gCAAgC;qBAC5C,CAAC,EAAA;;gBAJI,SAAS,GAAG,SAIhB;gBAGA,WACE,SAAS,OADL,CACM;gBAEd,GAAG,CAAC,MAAM,CAAC,QAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;;;;gBAG7B,OAAO,GAAG,oEAA6D,OAAK,MAAG,CAAC;gBACtF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC9B,sBAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBAC1B,OAAO,SAAA;qBACR,CAAC,EAAC;;;;KAEN,CAAC;AAzCW,QAAA,UAAU,cAyCrB"}

package/dist/types.d.ts

@@ -1,9 +1,18 @@
 import Stripe from "stripe";
-export declare type WebhookHandler = (event: any, stripe: Stripe, stripeConfig: StripeConfig) => void;
+export declare type StripeWebhookHandler = (event: any, stripe: Stripe, stripeConfig: StripeConfig) => void;
 export declare type StripeConfig = {
     stripeSecretKey: string;
     stripeWebhookEndpointSecret?: string;
     webhooks?: {
-        [webhookName: string]: WebhookHandler;
+        [webhookName: string]: StripeWebhookHandler;
     };
 };
+export declare type StripeProxy = (args: {
+    stripeSecretKey: string;
+    stripeMethod: string;
+    stripeArgs: any[];
+}) => Promise<{
+    status: number;
+    message?: string;
+    data?: any;
+}>;

package/dist/utilities/stripeProxy.d.ts

@@ -0,0 +1,2 @@
+import { StripeProxy } from '../types';
+export declare const stripeProxy: StripeProxy;

package/dist/utilities/stripeProxy.js

@@ -0,0 +1,84 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripeProxy = void 0;
+var lodash_get_1 = __importDefault(require("lodash.get"));
+var stripe_1 = __importDefault(require("stripe"));
+var stripeProxy = function (_a) {
+    var stripeSecretKey = _a.stripeSecretKey, stripeMethod = _a.stripeMethod, stripeArgs = _a.stripeArgs;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var stripe, topLevelMethod, contextToBind, foundMethod, stripeResponse, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    stripe = new stripe_1.default(stripeSecretKey, { apiVersion: '2022-08-01' });
+                    if (!(typeof stripeMethod === 'string')) return [3 /*break*/, 7];
+                    topLevelMethod = stripeMethod.split('.')[0];
+                    contextToBind = stripe[topLevelMethod];
+                    foundMethod = (0, lodash_get_1.default)(stripe, stripeMethod).bind(contextToBind);
+                    if (!(typeof foundMethod === 'function')) return [3 /*break*/, 5];
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, foundMethod.apply(void 0, stripeArgs)];
+                case 2:
+                    stripeResponse = _b.sent();
+                    return [2 /*return*/, {
+                            status: 200,
+                            data: stripeResponse
+                        }];
+                case 3:
+                    error_1 = _b.sent();
+                    return [2 /*return*/, {
+                            status: 404,
+                            message: "A Stripe API error has occurred: ".concat(error_1)
+                        }];
+                case 4: return [3 /*break*/, 6];
+                case 5: throw Error("The provided Stripe method of '".concat(stripeMethod, "' is not a part of the Stripe API."));
+                case 6: return [3 /*break*/, 8];
+                case 7: throw Error('You must provide a Stripe method to call.');
+                case 8: return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.stripeProxy = stripeProxy;
+//# sourceMappingURL=stripeProxy.js.map

package/dist/utilities/stripeProxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripeProxy.js","sourceRoot":"","sources":["../../src/utilities/stripeProxy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAmC;AACnC,kDAA4B;AAGrB,IAAM,WAAW,GAAgB,UAAO,EAI9C;QAHC,eAAe,qBAAA,EACf,YAAY,kBAAA,EACZ,UAAU,gBAAA;;;;;;oBAEJ,MAAM,GAAG,IAAI,gBAAM,CAAC,eAAe,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;yBAErE,CAAA,OAAO,YAAY,KAAK,QAAQ,CAAA,EAAhC,wBAAgC;oBAC5B,cAAc,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAiB,CAAC;oBAC5D,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;oBAGvC,WAAW,GAAG,IAAA,oBAAS,EAAC,MAAM,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;yBAEpE,CAAA,OAAO,WAAW,KAAK,UAAU,CAAA,EAAjC,wBAAiC;;;;oBAEV,qBAAM,WAAW,eAAI,UAAU,GAAC;;oBAAjD,cAAc,GAAG,SAAgC;oBACvD,sBAAO;4BACL,MAAM,EAAE,GAAG;4BACX,IAAI,EAAE,cAAc;yBACrB,EAAC;;;oBAEF,sBAAO;4BACL,MAAM,EAAE,GAAG;4BACX,OAAO,EAAE,2CAAoC,OAAK,CAAE;yBACrD,EAAC;;wBAGJ,MAAM,KAAK,CAAC,yCAAkC,YAAY,uCAAoC,CAAC,CAAA;;wBAGjG,MAAM,KAAK,CAAC,2CAA2C,CAAC,CAAA;;;;;CAE3D,CAAA;AAjCY,QAAA,WAAW,eAiCvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/plugin-stripe",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "homepage:": "https://payloadcms.com",
   "repository": "git@github.com:payloadcms/plugin-stripe.git",
   "description": "Stripe plugin for Payload CMS",