@payloadcms/plugin-stripe 0.0.8 → 0.0.10

package/README.md

@@ -5,12 +5,13 @@
 A plugin for [Payload CMS](https://github.com/payloadcms/payload) to connect [Stripe](https://stripe.com) and Payload.
 
 Core features:
-  - Hides your Stripe credentials when shipping SaaS applications
-  - Allows restricted keys through [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)
-  - Automatically syncs data between the two platforms
+
+- Hides your Stripe credentials when shipping SaaS applications
+- Allows restricted keys through [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)
+- Automatically syncs data between the two platforms
 
 ## Installation
 
@@ -25,15 +26,15 @@ Core features:
 In the `plugins` array of your [Payload config](https://payloadcms.com/docs/configuration/overview), call the plugin with [options](#options):
 
 ```js
-import { buildConfig } from 'payload/config';
-import stripePlugin from '@payloadcms/plugin-stripe';
+import { buildConfig } from "payload/config";
+import stripePlugin from "@payloadcms/plugin-stripe";
 
 const config = buildConfig({
   plugins: [
     stripePlugin({
       stripeSecretKey: process.env.STRIPE_SECRET_KEY,
-    })
-  ]
+    }),
+  ],
 });
 
 export default config;
@@ -70,8 +71,8 @@ This option will setup a basic sync between Payload collections and Stripe resou
 > NOTE: Due to limitations in the Stripe API, this currently only works with top-level fields. This is because every Stripe object is a separate entity, making it difficult to abstract into a simple reusable library. In the future, we may find a pattern around this. But for now, cases like that will need to be hard-coded. See the [demo](./demo) for an example of this.
 
 ```js
-import { buildConfig } from 'payload/config';
-import stripePlugin from '@payloadcms/plugin-stripe';
+import { buildConfig } from "payload/config";
+import stripePlugin from "@payloadcms/plugin-stripe";
 
 const config = buildConfig({
   plugins: [
@@ -80,19 +81,19 @@ const config = buildConfig({
       stripeWebhooksEndpointSecret: process.env.STRIPE_WEBHOOKS_ENDPOINT_SECRET,
       sync: [
         {
-          collection: 'customers',
-          stripeResourceType: 'customers',
-          stripeResourceTypeSingular: 'customer',
+          collection: "customers",
+          stripeResourceType: "customers",
+          stripeResourceTypeSingular: "customer",
           fields: [
             {
-              fieldPath: 'name', // this is a field on your own Payload config
-              stripeProperty: 'name' // use dot notation, if applicable
-            }
-          ]
-        }
-      ]
-    })
-  ]
+              fieldPath: "name", // this is a field on your own Payload config
+              stripeProperty: "name", // use dot notation, if applicable
+            },
+          ],
+        },
+      ],
+    }),
+  ],
 });
 
 export default config;
@@ -116,27 +117,29 @@ Using `sync` will do the following:
 
 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.
+> NOTE: the `/api` part of these routes may be different based on the settings defined in your Payload config.
 
 - #### `POST /api/stripe/rest`
 
   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",
-        stripeArgs: {
-          customer: "abc"
-        }
-      })
-    })
+  const res = await fetch(`/api/stripe/rest`, {
+    method: "POST",
+    credentials: "include",
+    headers: {
+      "Content-Type": "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",
+      stripeArgs: [
+        {
+          customer: "abc",
+        },
+      ],
+    }),
+  });
   ```
 
 - #### `POST /stripe/webhooks`
@@ -148,11 +151,13 @@ The following custom endpoints are automatically opened for you:
 [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/stripe/webhooks`
 1. Paste the given secret into your `.env` file as `STRIPE_WEBHOOKS_ENDPOINT_SECRET`
 
 Production:
+
 1. Login and [create a new webhook](https://dashboard.stripe.com/test/webhooks/create) from the Stripe dashboard
 1. Paste `YOUR_DOMAIN_NAME/api/stripe/webhooks` as the "Webhook Endpoint URL"
 1. Select which events to broadcast
@@ -160,8 +165,8 @@ Production:
 1. Then, handle these events using the `webhooks` portion of this plugin's config:
 
 ```js
-import { buildConfig } from 'payload/config';
-import stripePlugin from '@payloadcms/plugin-stripe';
+import { buildConfig } from "payload/config";
+import stripePlugin from "@payloadcms/plugin-stripe";
 
 const config = buildConfig({
   plugins: [
@@ -169,10 +174,10 @@ const config = buildConfig({
       stripeSecretKey: process.env.STRIPE_SECRET_KEY,
       stripeWebhooksEndpointSecret: process.env.STRIPE_WEBHOOKS_ENDPOINT_SECRET,
       webhooks: {
-        'customer.subscription.updated': ({ event, stripe, stripeConfig }) => {
+        "customer.subscription.updated": ({ event, stripe, stripeConfig }) => {
           // DO SOMETHING
-        }
-      }
+        },
+      },
       // NOTE: you can also catch all Stripe webhook events and handle the event types yourself
       // webhooks: (event, stripe, stripeConfig) => {
       //   switch (event.type): {
@@ -185,8 +190,8 @@ const config = buildConfig({
       //     }
       //   }
       // }
-    })
-  ]
+    }),
+  ],
 });
 
 export default config;
@@ -199,10 +204,10 @@ For a full list of available webhooks, see [here](https://stripe.com/docs/cli/tr
 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';
+import Stripe from "stripe";
 
 const stripeSecretKey = process.env.STRIPE_SECRET_KEY;
-const stripe = new Stripe(stripeSecretKey, { apiVersion: '2022-08-01' });
+const stripe = new Stripe(stripeSecretKey, { apiVersion: "2022-08-01" });
 
 export const MyFunction = async () => {
   try {
@@ -214,22 +219,24 @@ export const MyFunction = async () => {
   } 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';
+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,
-      }
+      stripeMethod: "customers.create",
+      stripeArgs: [
+        {
+          email: data.email,
+        },
+      ],
     });
 
     if (customer.status === 200) {
@@ -242,7 +249,7 @@ export const MyFunction = async () => {
   } catch (error) {
     console.error(error.message);
   }
-}
+};
 ```
 
 ## TypeScript

package/dist/routes/rest.js

@@ -40,7 +40,7 @@ exports.stripeREST = void 0;
 var errors_1 = require("payload/errors");
 var stripeProxy_1 = require("../utilities/stripeProxy");
 var stripeREST = function (args) { return __awaiter(void 0, void 0, void 0, function () {
-    var req, res, next, stripeConfig, payload, user, _a, stripeMethod, stripeArgs // example: 'cus_MGgt3Tuj3D66f2'
+    var req, res, next, stripeConfig, payload, user, _a, stripeMethod, stripeArgs // example: ['cus_MGgt3Tuj3D66f2'] or [{ limit: 100 }, { stripeAccount: 'acct_1J9Z4pKZ4Z4Z4Z4Z' }]
     , stripeSecretKey, pluginRes, status_1, error_1, message;
     return __generator(this, function (_b) {
         switch (_b.label) {
@@ -57,7 +57,7 @@ var stripeREST = function (args) { return __awaiter(void 0, void 0, void 0, func
                 return [4 /*yield*/, (0, stripeProxy_1.stripeProxy)({
                         stripeSecretKey: stripeSecretKey,
                         stripeMethod: stripeMethod,
-                        stripeArgs: stripeArgs // example: 'cus_MGgt3Tuj3D66f2'
+                        stripeArgs: stripeArgs
                     })];
             case 2:
                 pluginRes = _b.sent();

package/dist/routes/rest.js.map

@@ -1 +1 @@
-{"version":3,"file":"rest.js","sourceRoot":"","sources":["../../src/routes/rest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,yCAA2C;AAG3C,wDAAuD;AAEhD,IAAM,UAAU,GAAG,UAAO,IAKhC;;;;;;gBAEG,GAAG,GAID,IAAI,IAJH,EACH,GAAG,GAGD,IAAI,IAHH,EACH,IAAI,GAEF,IAAI,KAFF,EACJ,YAAY,GACV,IAAI,aADM,CACL;gBAGP,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;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,UAAO,IAKhC;;;;;;gBAEG,GAAG,GAID,IAAI,IAJH,EACH,GAAG,GAGD,IAAI,IAHH,EACH,IAAI,GAEF,IAAI,KAFF,EACJ,YAAY,GACV,IAAI,aADM,CACL;gBAGP,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;qBACX,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;AAhDW,QAAA,UAAU,cAgDrB"}

package/dist/utilities/stripeProxy.js

@@ -56,11 +56,12 @@ var stripeProxy = function (_a) {
                             url: 'https://payloadcms.com',
                         }
                     });
-                    if (!(typeof stripeMethod === 'string')) return [3 /*break*/, 7];
+                    if (!(typeof stripeMethod === 'string')) return [3 /*break*/, 9];
                     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];
+                    if (!(typeof foundMethod === 'function')) return [3 /*break*/, 7];
+                    if (!Array.isArray(stripeArgs)) return [3 /*break*/, 5];
                     _b.label = 1;
                 case 1:
                     _b.trys.push([1, 3, , 4]);
@@ -78,10 +79,12 @@ var stripeProxy = function (_a) {
                             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 5: throw new Error("Argument 'stripeArgs' must be an array.");
                 case 6: return [3 /*break*/, 8];
-                case 7: throw Error('You must provide a Stripe method to call.');
-                case 8: return [2 /*return*/];
+                case 7: throw Error("The provided Stripe method of '".concat(stripeMethod, "' is not a part of the Stripe API."));
+                case 8: return [3 /*break*/, 10];
+                case 9: throw Error('You must provide a Stripe method to call.');
+                case 10: return [2 /*return*/];
             }
         });
     });

package/dist/utilities/stripeProxy.js.map

@@ -1 +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;wBACzC,UAAU,EAAE,YAAY;wBACxB,OAAO,EAAE;4BACP,IAAI,EAAE,uBAAuB;4BAC7B,GAAG,EAAE,wBAAwB;yBAC9B;qBACF,CAAC,CAAC;yBAEC,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;AAvCY,QAAA,WAAW,eAuCvB"}
+{"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;wBACzC,UAAU,EAAE,YAAY;wBACxB,OAAO,EAAE;4BACP,IAAI,EAAE,uBAAuB;4BAC7B,GAAG,EAAE,wBAAwB;yBAC9B;qBACF,CAAC,CAAC;yBAEC,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;yBAC/B,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAzB,wBAAyB;;;;oBAEF,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,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;;wBAG7D,MAAM,KAAK,CAAC,yCAAkC,YAAY,uCAAoC,CAAC,CAAA;;wBAGjG,MAAM,KAAK,CAAC,2CAA2C,CAAC,CAAA;;;;;CAE3D,CAAA;AA3CY,QAAA,WAAW,eA2CvB"}

package/package.json

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