@pristine-ts/stripe 0.0.188 → 0.0.192

package/dist/lib/cjs/clients/stripe.client.js

@@ -30,7 +30,17 @@ const common_1 = require("@pristine-ts/common");
 const stripe_authentication_error_1 = require("../errors/stripe-authentication.error");
 const stripe_module_keyname_1 = require("../stripe.module.keyname");
 const stripe_1 = __importDefault(require("stripe"));
+/**
+ * The client to use to interact with Stripe. It is a wrapper around the Stripe library.
+ * It is tagged so it can be injected using StripeClientInterface.
+ */
 let StripeClient = class StripeClient {
+    /**
+     * The client to use to interact with Stripe. It is a wrapper around the Stripe library.
+     * It is tagged so it can be injected using StripeClientInterface.
+     * @param logHandler The log handler to output logs.
+     * @param stripeApiKey The api key to use when contacting Stripe.
+     */
     constructor(logHandler, stripeApiKey) {
         this.logHandler = logHandler;
         this.stripeApiKey = stripeApiKey;

package/dist/lib/cjs/clients/stripe.client.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe.client.js","sourceRoot":"","sources":["../../../../src/clients/stripe.client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAA4C;AAE5C,gDAAwC;AAExC,uFAAgF;AAChF,oEAA6D;AAC7D,oDAA4B;AAK5B,IAAa,YAAY,GAAzB,MAAa,YAAY;IAIrB,YACoD,UAA+B,EACb,YAAoB;QADtC,eAAU,GAAV,UAAU,CAAqB;QACb,iBAAY,GAAZ,YAAY,CAAQ;IAE1F,CAAC;IAED;;OAEG;IACH,eAAe;;QACX,OAAO,IAAI,CAAC,MAAM,GAAG,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,gBAAM,CAAC,IAAI,CAAC,YAAY,EAAE;YAC9D,UAAU,EAAE,YAAY;SAC3B,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACG,eAAe,CAAC,OAAgB,EAAE,2BAAmC;;YACvE,IAAG,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;gBACzD,MAAM,IAAI,uDAAyB,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC;aACpF;YAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAE5D,IAAI;gBACA,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;aACxH;YAAC,OAAO,GAAG,EAAE;gBACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAC,EAAE,2CAAmB,CAAC,CAAC;gBACjG,MAAM,IAAI,uDAAyB,CAAC,GAAG,EAAE,0CAA0C,CAAC,CAAC;aACxF;QACL,CAAC;KAAA;CACJ,CAAA;AAtCY,YAAY;IAFxB,YAAG,CAAC,uBAAuB,CAAC;IAC5B,qBAAU,EAAE;IAMJ,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;IAC7B,WAAA,iBAAM,CAAC,IAAI,2CAAmB,gBAAgB,CAAC,CAAA;;GAN3C,YAAY,CAsCxB;AAtCY,oCAAY"}
+{"version":3,"file":"stripe.client.js","sourceRoot":"","sources":["../../../../src/clients/stripe.client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAA4C;AAE5C,gDAAwC;AAExC,uFAAgF;AAChF,oEAA6D;AAC7D,oDAA4B;AAG5B;;;GAGG;AAGH,IAAa,YAAY,GAAzB,MAAa,YAAY;IAQrB;;;;;OAKG;IACH,YACoD,UAA+B,EACb,YAAoB;QADtC,eAAU,GAAV,UAAU,CAAqB;QACb,iBAAY,GAAZ,YAAY,CAAQ;IAE1F,CAAC;IAED;;OAEG;IACH,eAAe;;QACX,OAAO,IAAI,CAAC,MAAM,GAAG,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,gBAAM,CAAC,IAAI,CAAC,YAAY,EAAE;YAC9D,UAAU,EAAE,YAAY;SAC3B,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACG,eAAe,CAAC,OAAgB,EAAE,2BAAmC;;YACvE,IAAG,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;gBACzD,MAAM,IAAI,uDAAyB,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC;aACpF;YAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAE5D,IAAI;gBACA,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;aACxH;YAAC,OAAO,GAAG,EAAE;gBACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAC,EAAE,2CAAmB,CAAC,CAAC;gBACjG,MAAM,IAAI,uDAAyB,CAAC,GAAG,EAAE,0CAA0C,CAAC,CAAC;aACxF;QACL,CAAC;KAAA;CACJ,CAAA;AAhDY,YAAY;IAFxB,YAAG,CAAC,uBAAuB,CAAC;IAC5B,qBAAU,EAAE;IAgBJ,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;IAC7B,WAAA,iBAAM,CAAC,IAAI,2CAAmB,gBAAgB,CAAC,CAAA;;GAhB3C,YAAY,CAgDxB;AAhDY,oCAAY"}

package/dist/lib/cjs/enums/stripe-event-type.enum.js

@@ -1,10 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StripeEventTypeEnum = void 0;
+/**
+ * The event types that we handle from Stripe.
+ */
 var StripeEventTypeEnum;
 (function (StripeEventTypeEnum) {
+    /**
+     * When a subscription was created.
+     */
     StripeEventTypeEnum["StripeSubscriptionCreated"] = "STRIPE_SUBSCRIPTION_CREATED";
+    /**
+     * When a subscription was updated.
+     */
     StripeEventTypeEnum["StripeSubscriptionUpdated"] = "STRIPE_SUBSCRIPTION_UPDATED";
+    /**
+     * When a subscription was deleted.
+     */
     StripeEventTypeEnum["StripeSubscriptionDeleted"] = "STRIPE_SUBSCRIPTION_DELETED";
 })(StripeEventTypeEnum = exports.StripeEventTypeEnum || (exports.StripeEventTypeEnum = {}));
 //# sourceMappingURL=stripe-event-type.enum.js.map

package/dist/lib/cjs/enums/stripe-event-type.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe-event-type.enum.js","sourceRoot":"","sources":["../../../../src/enums/stripe-event-type.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC3B,gFAAyD,CAAA;IACzD,gFAAyD,CAAA;IACzD,gFAAyD,CAAA;AAC7D,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B"}
+{"version":3,"file":"stripe-event-type.enum.js","sourceRoot":"","sources":["../../../../src/enums/stripe-event-type.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,mBAeX;AAfD,WAAY,mBAAmB;IAC3B;;OAEG;IACH,gFAAyD,CAAA;IAEzD;;OAEG;IACH,gFAAyD,CAAA;IAEzD;;OAEG;IACH,gFAAyD,CAAA;AAC7D,CAAC,EAfW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAe9B"}

package/dist/lib/cjs/errors/stripe-authentication.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StripeAuthenticationError = void 0;
 const networking_1 = require("@pristine-ts/networking");
+/**
+ * This Error represents an error when authenticating with Stripe.
+ */
 class StripeAuthenticationError extends networking_1.HttpError {
     constructor(httpStatus, message, errors) {
         super(httpStatus, message, errors);

package/dist/lib/cjs/errors/stripe-authentication.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe-authentication.error.js","sourceRoot":"","sources":["../../../../src/errors/stripe-authentication.error.ts"],"names":[],"mappings":";;;AAAA,wDAAkD;AAElD,MAAa,yBAA0B,SAAQ,sBAAS;IACpD,YAA4B,UAAkB,EAAW,OAAe,EAAW,MAA0B;QACzG,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QADX,eAAU,GAAV,UAAU,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAQ;QAAW,WAAM,GAAN,MAAM,CAAoB;QAGzG,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;CACJ;AATD,8DASC"}
+{"version":3,"file":"stripe-authentication.error.js","sourceRoot":"","sources":["../../../../src/errors/stripe-authentication.error.ts"],"names":[],"mappings":";;;AAAA,wDAAkD;AAElD;;GAEG;AACH,MAAa,yBAA0B,SAAQ,sBAAS;IACpD,YAA4B,UAAkB,EAAW,OAAe,EAAW,MAA0B;QACzG,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QADX,eAAU,GAAV,UAAU,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAQ;QAAW,WAAM,GAAN,MAAM,CAAoB;QAGzG,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;CACJ;AATD,8DASC"}

package/dist/lib/cjs/managers/stripe-webhooks.manager.js

@@ -28,7 +28,16 @@ const core_1 = require("@pristine-ts/core");
 const stripe_event_type_enum_1 = require("../enums/stripe-event-type.enum");
 const stripe_client_1 = require("../clients/stripe.client");
 const stripe_module_keyname_1 = require("../stripe.module.keyname");
+/**
+ * The StripeWebhooksManager handles webhooks calls from Stripe and transforms those into Pristine Events.
+ */
 let StripeWebhooksManager = StripeWebhooksManager_1 = class StripeWebhooksManager {
+    /**
+     * The StripeWebhooksManager handles webhooks calls from Stripe and transforms those into Pristine Events.
+     * @param eventDispatcher The event dispatcher to dispatch Pristine Events once webhook calls from Stripe are parsed.
+     * @param stripeClient The Stripe client.
+     * @param logHandler The log handler to output logs.
+     */
     constructor(eventDispatcher, stripeClient, logHandler) {
         this.eventDispatcher = eventDispatcher;
         this.stripeClient = stripeClient;
@@ -36,18 +45,21 @@ let StripeWebhooksManager = StripeWebhooksManager_1 = class StripeWebhooksManage
     }
     /**
      * Verifies the signature and dispatches an event based on the webhook request received from Stripe.
-     * @param request
-     * @param stripeSigningEndpointSecret
+     * @param request The webhook request received from Stripe
+     * @param stripeSigningEndpointSecret The Stripe signing endpoint secret with which the webhook request is signed.
      */
     emitSubscriptionEvent(request, stripeSigningEndpointSecret) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Verify the signature of the stripe webhook request.
             const event = yield this.stripeClient.verifySignature(request, stripeSigningEndpointSecret);
+            // For the moment we only handle subscription events.
             if (!event.type.startsWith('customer.subscription')) {
                 this.logHandler.error("Stripe event is not a subscription", { event, className: StripeWebhooksManager_1.name }, stripe_module_keyname_1.StripeModuleKeyname);
                 throw new Error("Event is not a subscription");
             }
             const stripeSubscription = event.data.object;
             let type;
+            // Create the appropriate event type
             switch (event.type) {
                 case "customer.subscription.created":
                     type = stripe_event_type_enum_1.StripeEventTypeEnum.StripeSubscriptionCreated;
@@ -63,6 +75,7 @@ let StripeWebhooksManager = StripeWebhooksManager_1 = class StripeWebhooksManage
                     return Promise.resolve();
             }
             const parsedEvent = new core_1.Event(type, stripeSubscription);
+            // Dispatch the event.
             yield this.eventDispatcher.dispatch(parsedEvent);
         });
     }

package/dist/lib/cjs/managers/stripe-webhooks.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe-webhooks.manager.js","sourceRoot":"","sources":["../../../../src/managers/stripe-webhooks.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAA4C;AAG5C,4CAAyD;AACzD,4EAAoE;AACpE,4DAAsD;AACtD,oEAA6D;AAI7D,IAAa,qBAAqB,6BAAlC,MAAa,qBAAqB;IAC9B,YACqB,eAAgC,EAChC,YAA0B,EACK,UAA+B;QAF9D,oBAAe,GAAf,eAAe,CAAiB;QAChC,iBAAY,GAAZ,YAAY,CAAc;QACK,eAAU,GAAV,UAAU,CAAqB;IAChF,CAAC;IAEJ;;;;OAIG;IACG,qBAAqB,CAAC,OAAgB,EAAE,2BAAmC;;YAC7E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;YAE5F,IAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE;gBAChD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,oCAAoC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,2CAAmB,CAAC,CAAC;gBACjI,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAClD;YAED,MAAM,kBAAkB,GAAwB,KAAK,CAAC,IAAI,CAAC,MAA6B,CAAC;YAEzF,IAAI,IAA0B,CAAC;YAE/B,QAAQ,KAAK,CAAC,IAAI,EAAE;gBAChB,KAAK,+BAA+B;oBAChC,IAAI,GAAG,4CAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,4CAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,4CAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV;oBACI,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,2CAAmB,CAAC,CAAC;oBACrI,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;aAChC;YAED,MAAM,WAAW,GAAG,IAAI,YAAK,CAAC,IAAK,EAAE,kBAAkB,CAAC,CAAA;YAExD,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACpD,CAAC;KAAA;CACJ,CAAA;AA3CY,qBAAqB;IADjC,qBAAU,EAAE;IAKJ,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;qCAFI,sBAAe;QAClB,4BAAY;GAHtC,qBAAqB,CA2CjC;AA3CY,sDAAqB"}
+{"version":3,"file":"stripe-webhooks.manager.js","sourceRoot":"","sources":["../../../../src/managers/stripe-webhooks.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAA4C;AAG5C,4CAAyD;AACzD,4EAAoE;AACpE,4DAAsD;AACtD,oEAA6D;AAG7D;;GAEG;AAEH,IAAa,qBAAqB,6BAAlC,MAAa,qBAAqB;IAE9B;;;;;OAKG;IACH,YACqB,eAAgC,EAChC,YAA0B,EACK,UAA+B;QAF9D,oBAAe,GAAf,eAAe,CAAiB;QAChC,iBAAY,GAAZ,YAAY,CAAc;QACK,eAAU,GAAV,UAAU,CAAqB;IAChF,CAAC;IAEJ;;;;OAIG;IACG,qBAAqB,CAAC,OAAgB,EAAE,2BAAmC;;YAC7E,sDAAsD;YACtD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;YAE5F,qDAAqD;YACrD,IAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE;gBAChD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,oCAAoC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,2CAAmB,CAAC,CAAC;gBACjI,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAClD;YAED,MAAM,kBAAkB,GAAwB,KAAK,CAAC,IAAI,CAAC,MAA6B,CAAC;YAEzF,IAAI,IAA0B,CAAC;YAE/B,oCAAoC;YACpC,QAAQ,KAAK,CAAC,IAAI,EAAE;gBAChB,KAAK,+BAA+B;oBAChC,IAAI,GAAG,4CAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,4CAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,4CAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV;oBACI,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,2CAAmB,CAAC,CAAC;oBACrI,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;aAChC;YAED,MAAM,WAAW,GAAG,IAAI,YAAK,CAAC,IAAK,EAAE,kBAAkB,CAAC,CAAA;YAExD,sBAAsB;YACtB,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACpD,CAAC;KAAA;CACJ,CAAA;AAtDY,qBAAqB;IADjC,qBAAU,EAAE;IAYJ,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;qCAFI,sBAAe;QAClB,4BAAY;GAVtC,qBAAqB,CAsDjC;AAtDY,sDAAqB"}

package/dist/lib/cjs/stripe.module.js

@@ -22,6 +22,9 @@ __exportStar(require("./stripe.module.keyname"), exports);
 exports.StripeModule = {
     keyname: stripe_module_keyname_1.StripeModuleKeyname,
     configurationDefinitions: [
+        /**
+         * The api key to use when contacting Stripe.
+         */
         {
             parameterName: stripe_module_keyname_1.StripeModuleKeyname + ".stripeApiKey",
             isRequired: true,

package/dist/lib/cjs/stripe.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe.module.js","sourceRoot":"","sources":["../../../src/stripe.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,mEAA4D;AAC5D,wDAAyD;AAEzD,oDAAkC;AAClC,gDAA8B;AAC9B,kDAAgC;AAChC,0DAAwC;AACxC,sDAAoC;AACpC,0DAAwC;AAE3B,QAAA,YAAY,GAAoB;IACzC,OAAO,EAAE,2CAAmB;IAC5B,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,2CAAmB,GAAG,eAAe;YACpD,UAAU,EAAE,IAAI;SACnB;KACJ;IACD,aAAa,EAAE;QACX,6BAAgB;KACnB;CACJ,CAAA"}
+{"version":3,"file":"stripe.module.js","sourceRoot":"","sources":["../../../src/stripe.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,mEAA4D;AAC5D,wDAAyD;AAEzD,oDAAkC;AAClC,gDAA8B;AAC9B,kDAAgC;AAChC,0DAAwC;AACxC,sDAAoC;AACpC,0DAAwC;AAE3B,QAAA,YAAY,GAAoB;IACzC,OAAO,EAAE,2CAAmB;IAC5B,wBAAwB,EAAE;QACtB;;WAEG;QACH;YACI,aAAa,EAAE,2CAAmB,GAAG,eAAe;YACpD,UAAU,EAAE,IAAI;SACnB;KACJ;IACD,aAAa,EAAE;QACX,6BAAgB;KACnB;CACJ,CAAA"}

package/dist/lib/esm/clients/stripe.client.js

@@ -24,7 +24,17 @@ import { tag } from "@pristine-ts/common";
 import { StripeAuthenticationError } from "../errors/stripe-authentication.error";
 import { StripeModuleKeyname } from "../stripe.module.keyname";
 import Stripe from "stripe";
+/**
+ * The client to use to interact with Stripe. It is a wrapper around the Stripe library.
+ * It is tagged so it can be injected using StripeClientInterface.
+ */
 let StripeClient = class StripeClient {
+    /**
+     * The client to use to interact with Stripe. It is a wrapper around the Stripe library.
+     * It is tagged so it can be injected using StripeClientInterface.
+     * @param logHandler The log handler to output logs.
+     * @param stripeApiKey The api key to use when contacting Stripe.
+     */
     constructor(logHandler, stripeApiKey) {
         this.logHandler = logHandler;
         this.stripeApiKey = stripeApiKey;

package/dist/lib/esm/clients/stripe.client.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe.client.js","sourceRoot":"","sources":["../../../../src/clients/stripe.client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAE5C,OAAO,EAAC,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAExC,OAAO,EAAC,yBAAyB,EAAC,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAC,mBAAmB,EAAC,MAAM,0BAA0B,CAAC;AAC7D,OAAO,MAAM,MAAM,QAAQ,CAAC;AAK5B,IAAa,YAAY,GAAzB,MAAa,YAAY;IAIrB,YACoD,UAA+B,EACb,YAAoB;QADtC,eAAU,GAAV,UAAU,CAAqB;QACb,iBAAY,GAAZ,YAAY,CAAQ;IAE1F,CAAC;IAED;;OAEG;IACH,eAAe;;QACX,OAAO,IAAI,CAAC,MAAM,GAAG,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE;YAC9D,UAAU,EAAE,YAAY;SAC3B,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACG,eAAe,CAAC,OAAgB,EAAE,2BAAmC;;YACvE,IAAG,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;gBACzD,MAAM,IAAI,yBAAyB,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC;aACpF;YAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAE5D,IAAI;gBACA,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;aACxH;YAAC,OAAO,GAAG,EAAE;gBACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAC,EAAE,mBAAmB,CAAC,CAAC;gBACjG,MAAM,IAAI,yBAAyB,CAAC,GAAG,EAAE,0CAA0C,CAAC,CAAC;aACxF;QACL,CAAC;KAAA;CACJ,CAAA;AAtCY,YAAY;IAFxB,GAAG,CAAC,uBAAuB,CAAC;IAC5B,UAAU,EAAE;IAMJ,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;IAC7B,WAAA,MAAM,CAAC,IAAI,mBAAmB,gBAAgB,CAAC,CAAA;;GAN3C,YAAY,CAsCxB;SAtCY,YAAY"}
+{"version":3,"file":"stripe.client.js","sourceRoot":"","sources":["../../../../src/clients/stripe.client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAE5C,OAAO,EAAC,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAExC,OAAO,EAAC,yBAAyB,EAAC,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAC,mBAAmB,EAAC,MAAM,0BAA0B,CAAC;AAC7D,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B;;;GAGG;AAGH,IAAa,YAAY,GAAzB,MAAa,YAAY;IAQrB;;;;;OAKG;IACH,YACoD,UAA+B,EACb,YAAoB;QADtC,eAAU,GAAV,UAAU,CAAqB;QACb,iBAAY,GAAZ,YAAY,CAAQ;IAE1F,CAAC;IAED;;OAEG;IACH,eAAe;;QACX,OAAO,IAAI,CAAC,MAAM,GAAG,MAAA,IAAI,CAAC,MAAM,mCAAI,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE;YAC9D,UAAU,EAAE,YAAY;SAC3B,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACG,eAAe,CAAC,OAAgB,EAAE,2BAAmC;;YACvE,IAAG,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;gBACzD,MAAM,IAAI,yBAAyB,CAAC,GAAG,EAAE,sCAAsC,CAAC,CAAC;aACpF;YAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAE5D,IAAI;gBACA,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,2BAA2B,CAAC,CAAC;aACxH;YAAC,OAAO,GAAG,EAAE;gBACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAC,EAAE,mBAAmB,CAAC,CAAC;gBACjG,MAAM,IAAI,yBAAyB,CAAC,GAAG,EAAE,0CAA0C,CAAC,CAAC;aACxF;QACL,CAAC;KAAA;CACJ,CAAA;AAhDY,YAAY;IAFxB,GAAG,CAAC,uBAAuB,CAAC;IAC5B,UAAU,EAAE;IAgBJ,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;IAC7B,WAAA,MAAM,CAAC,IAAI,mBAAmB,gBAAgB,CAAC,CAAA;;GAhB3C,YAAY,CAgDxB;SAhDY,YAAY"}

package/dist/lib/esm/enums/stripe-event-type.enum.js

@@ -1,7 +1,19 @@
+/**
+ * The event types that we handle from Stripe.
+ */
 export var StripeEventTypeEnum;
 (function (StripeEventTypeEnum) {
+    /**
+     * When a subscription was created.
+     */
     StripeEventTypeEnum["StripeSubscriptionCreated"] = "STRIPE_SUBSCRIPTION_CREATED";
+    /**
+     * When a subscription was updated.
+     */
     StripeEventTypeEnum["StripeSubscriptionUpdated"] = "STRIPE_SUBSCRIPTION_UPDATED";
+    /**
+     * When a subscription was deleted.
+     */
     StripeEventTypeEnum["StripeSubscriptionDeleted"] = "STRIPE_SUBSCRIPTION_DELETED";
 })(StripeEventTypeEnum || (StripeEventTypeEnum = {}));
 //# sourceMappingURL=stripe-event-type.enum.js.map

package/dist/lib/esm/enums/stripe-event-type.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe-event-type.enum.js","sourceRoot":"","sources":["../../../../src/enums/stripe-event-type.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC3B,gFAAyD,CAAA;IACzD,gFAAyD,CAAA;IACzD,gFAAyD,CAAA;AAC7D,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B"}
+{"version":3,"file":"stripe-event-type.enum.js","sourceRoot":"","sources":["../../../../src/enums/stripe-event-type.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,mBAeX;AAfD,WAAY,mBAAmB;IAC3B;;OAEG;IACH,gFAAyD,CAAA;IAEzD;;OAEG;IACH,gFAAyD,CAAA;IAEzD;;OAEG;IACH,gFAAyD,CAAA;AAC7D,CAAC,EAfW,mBAAmB,KAAnB,mBAAmB,QAe9B"}

package/dist/lib/esm/errors/stripe-authentication.error.js

@@ -1,4 +1,7 @@
 import { HttpError } from "@pristine-ts/networking";
+/**
+ * This Error represents an error when authenticating with Stripe.
+ */
 export class StripeAuthenticationError extends HttpError {
     constructor(httpStatus, message, errors) {
         super(httpStatus, message, errors);

package/dist/lib/esm/errors/stripe-authentication.error.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe-authentication.error.js","sourceRoot":"","sources":["../../../../src/errors/stripe-authentication.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAElD,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IACpD,YAA4B,UAAkB,EAAW,OAAe,EAAW,MAA0B;QACzG,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QADX,eAAU,GAAV,UAAU,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAQ;QAAW,WAAM,GAAN,MAAM,CAAoB;QAGzG,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;CACJ"}
+{"version":3,"file":"stripe-authentication.error.js","sourceRoot":"","sources":["../../../../src/errors/stripe-authentication.error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,SAAS;IACpD,YAA4B,UAAkB,EAAW,OAAe,EAAW,MAA0B;QACzG,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QADX,eAAU,GAAV,UAAU,CAAQ;QAAW,YAAO,GAAP,OAAO,CAAQ;QAAW,WAAM,GAAN,MAAM,CAAoB;QAGzG,gCAAgC;QAChC,kDAAkD;QAClD,gIAAgI;QAChI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;CACJ"}

package/dist/lib/esm/managers/stripe-webhooks.manager.js

@@ -25,7 +25,16 @@ import { Event, EventDispatcher } from "@pristine-ts/core";
 import { StripeEventTypeEnum } from "../enums/stripe-event-type.enum";
 import { StripeClient } from "../clients/stripe.client";
 import { StripeModuleKeyname } from "../stripe.module.keyname";
+/**
+ * The StripeWebhooksManager handles webhooks calls from Stripe and transforms those into Pristine Events.
+ */
 let StripeWebhooksManager = StripeWebhooksManager_1 = class StripeWebhooksManager {
+    /**
+     * The StripeWebhooksManager handles webhooks calls from Stripe and transforms those into Pristine Events.
+     * @param eventDispatcher The event dispatcher to dispatch Pristine Events once webhook calls from Stripe are parsed.
+     * @param stripeClient The Stripe client.
+     * @param logHandler The log handler to output logs.
+     */
     constructor(eventDispatcher, stripeClient, logHandler) {
         this.eventDispatcher = eventDispatcher;
         this.stripeClient = stripeClient;
@@ -33,18 +42,21 @@ let StripeWebhooksManager = StripeWebhooksManager_1 = class StripeWebhooksManage
     }
     /**
      * Verifies the signature and dispatches an event based on the webhook request received from Stripe.
-     * @param request
-     * @param stripeSigningEndpointSecret
+     * @param request The webhook request received from Stripe
+     * @param stripeSigningEndpointSecret The Stripe signing endpoint secret with which the webhook request is signed.
      */
     emitSubscriptionEvent(request, stripeSigningEndpointSecret) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Verify the signature of the stripe webhook request.
             const event = yield this.stripeClient.verifySignature(request, stripeSigningEndpointSecret);
+            // For the moment we only handle subscription events.
             if (!event.type.startsWith('customer.subscription')) {
                 this.logHandler.error("Stripe event is not a subscription", { event, className: StripeWebhooksManager_1.name }, StripeModuleKeyname);
                 throw new Error("Event is not a subscription");
             }
             const stripeSubscription = event.data.object;
             let type;
+            // Create the appropriate event type
             switch (event.type) {
                 case "customer.subscription.created":
                     type = StripeEventTypeEnum.StripeSubscriptionCreated;
@@ -60,6 +72,7 @@ let StripeWebhooksManager = StripeWebhooksManager_1 = class StripeWebhooksManage
                     return Promise.resolve();
             }
             const parsedEvent = new Event(type, stripeSubscription);
+            // Dispatch the event.
             yield this.eventDispatcher.dispatch(parsedEvent);
         });
     }

package/dist/lib/esm/managers/stripe-webhooks.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe-webhooks.manager.js","sourceRoot":"","sources":["../../../../src/managers/stripe-webhooks.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAG5C,OAAO,EAAC,KAAK,EAAE,eAAe,EAAC,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAC,mBAAmB,EAAC,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAC,mBAAmB,EAAC,MAAM,0BAA0B,CAAC;AAI7D,IAAa,qBAAqB,6BAAlC,MAAa,qBAAqB;IAC9B,YACqB,eAAgC,EAChC,YAA0B,EACK,UAA+B;QAF9D,oBAAe,GAAf,eAAe,CAAiB;QAChC,iBAAY,GAAZ,YAAY,CAAc;QACK,eAAU,GAAV,UAAU,CAAqB;IAChF,CAAC;IAEJ;;;;OAIG;IACG,qBAAqB,CAAC,OAAgB,EAAE,2BAAmC;;YAC7E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;YAE5F,IAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE;gBAChD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,oCAAoC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,mBAAmB,CAAC,CAAC;gBACjI,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAClD;YAED,MAAM,kBAAkB,GAAwB,KAAK,CAAC,IAAI,CAAC,MAA6B,CAAC;YAEzF,IAAI,IAA0B,CAAC;YAE/B,QAAQ,KAAK,CAAC,IAAI,EAAE;gBAChB,KAAK,+BAA+B;oBAChC,IAAI,GAAG,mBAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,mBAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,mBAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV;oBACI,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,mBAAmB,CAAC,CAAC;oBACrI,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;aAChC;YAED,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,IAAK,EAAE,kBAAkB,CAAC,CAAA;YAExD,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACpD,CAAC;KAAA;CACJ,CAAA;AA3CY,qBAAqB;IADjC,UAAU,EAAE;IAKJ,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;qCAFI,eAAe;QAClB,YAAY;GAHtC,qBAAqB,CA2CjC;SA3CY,qBAAqB"}
+{"version":3,"file":"stripe-webhooks.manager.js","sourceRoot":"","sources":["../../../../src/managers/stripe-webhooks.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,MAAM,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAG5C,OAAO,EAAC,KAAK,EAAE,eAAe,EAAC,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAC,mBAAmB,EAAC,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAC,mBAAmB,EAAC,MAAM,0BAA0B,CAAC;AAG7D;;GAEG;AAEH,IAAa,qBAAqB,6BAAlC,MAAa,qBAAqB;IAE9B;;;;;OAKG;IACH,YACqB,eAAgC,EAChC,YAA0B,EACK,UAA+B;QAF9D,oBAAe,GAAf,eAAe,CAAiB;QAChC,iBAAY,GAAZ,YAAY,CAAc;QACK,eAAU,GAAV,UAAU,CAAqB;IAChF,CAAC;IAEJ;;;;OAIG;IACG,qBAAqB,CAAC,OAAgB,EAAE,2BAAmC;;YAC7E,sDAAsD;YACtD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;YAE5F,qDAAqD;YACrD,IAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE;gBAChD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,oCAAoC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,mBAAmB,CAAC,CAAC;gBACjI,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAClD;YAED,MAAM,kBAAkB,GAAwB,KAAK,CAAC,IAAI,CAAC,MAA6B,CAAC;YAEzF,IAAI,IAA0B,CAAC;YAE/B,oCAAoC;YACpC,QAAQ,KAAK,CAAC,IAAI,EAAE;gBAChB,KAAK,+BAA+B;oBAChC,IAAI,GAAG,mBAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,mBAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV,KAAK,+BAA+B;oBAChC,IAAI,GAAG,mBAAmB,CAAC,yBAAyB,CAAA;oBACpD,MAAM;gBACV;oBACI,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAC,KAAK,EAAE,SAAS,EAAE,uBAAqB,CAAC,IAAI,EAAC,EAAE,mBAAmB,CAAC,CAAC;oBACrI,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;aAChC;YAED,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,IAAK,EAAE,kBAAkB,CAAC,CAAA;YAExD,sBAAsB;YACtB,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACpD,CAAC;KAAA;CACJ,CAAA;AAtDY,qBAAqB;IADjC,UAAU,EAAE;IAYJ,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;qCAFI,eAAe;QAClB,YAAY;GAVtC,qBAAqB,CAsDjC;SAtDY,qBAAqB"}

package/dist/lib/esm/stripe.module.js

@@ -9,6 +9,9 @@ export * from "./stripe.module.keyname";
 export const StripeModule = {
     keyname: StripeModuleKeyname,
     configurationDefinitions: [
+        /**
+         * The api key to use when contacting Stripe.
+         */
         {
             parameterName: StripeModuleKeyname + ".stripeApiKey",
             isRequired: true,

package/dist/lib/esm/stripe.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"stripe.module.js","sourceRoot":"","sources":["../../../src/stripe.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,mBAAmB,EAAC,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,yBAAyB,CAAC;AAEzD,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AAExC,MAAM,CAAC,MAAM,YAAY,GAAoB;IACzC,OAAO,EAAE,mBAAmB;IAC5B,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,mBAAmB,GAAG,eAAe;YACpD,UAAU,EAAE,IAAI;SACnB;KACJ;IACD,aAAa,EAAE;QACX,gBAAgB;KACnB;CACJ,CAAA"}
+{"version":3,"file":"stripe.module.js","sourceRoot":"","sources":["../../../src/stripe.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,mBAAmB,EAAC,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAC,gBAAgB,EAAC,MAAM,yBAAyB,CAAC;AAEzD,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AAExC,MAAM,CAAC,MAAM,YAAY,GAAoB;IACzC,OAAO,EAAE,mBAAmB;IAC5B,wBAAwB,EAAE;QACtB;;WAEG;QACH;YACI,aAAa,EAAE,mBAAmB,GAAG,eAAe;YACpD,UAAU,EAAE,IAAI;SACnB;KACJ;IACD,aAAa,EAAE;QACX,gBAAgB;KACnB;CACJ,CAAA"}

package/dist/types/clients/stripe.client.d.ts

@@ -2,10 +2,24 @@ import { LogHandlerInterface } from "@pristine-ts/logging";
 import { StripeClientInterface } from "../interfaces/stripe-client.interface";
 import Stripe from "stripe";
 import { Request } from "@pristine-ts/common";
+/**
+ * The client to use to interact with Stripe. It is a wrapper around the Stripe library.
+ * It is tagged so it can be injected using StripeClientInterface.
+ */
 export declare class StripeClient implements StripeClientInterface {
     private readonly logHandler;
     private readonly stripeApiKey;
+    /**
+     * The client from the Stripe library.
+     * @private
+     */
     private client?;
+    /**
+     * The client to use to interact with Stripe. It is a wrapper around the Stripe library.
+     * It is tagged so it can be injected using StripeClientInterface.
+     * @param logHandler The log handler to output logs.
+     * @param stripeApiKey The api key to use when contacting Stripe.
+     */
     constructor(logHandler: LogHandlerInterface, stripeApiKey: string);
     /**
      * Returns the Stripe client of the Stripe library with the api version '2020-08-27'

package/dist/types/enums/stripe-event-type.enum.d.ts

@@ -1,5 +1,17 @@
+/**
+ * The event types that we handle from Stripe.
+ */
 export declare enum StripeEventTypeEnum {
+    /**
+     * When a subscription was created.
+     */
     StripeSubscriptionCreated = "STRIPE_SUBSCRIPTION_CREATED",
+    /**
+     * When a subscription was updated.
+     */
     StripeSubscriptionUpdated = "STRIPE_SUBSCRIPTION_UPDATED",
+    /**
+     * When a subscription was deleted.
+     */
     StripeSubscriptionDeleted = "STRIPE_SUBSCRIPTION_DELETED"
 }

package/dist/types/errors/stripe-authentication.error.d.ts

@@ -1,4 +1,7 @@
 import { HttpError } from "@pristine-ts/networking";
+/**
+ * This Error represents an error when authenticating with Stripe.
+ */
 export declare class StripeAuthenticationError extends HttpError {
     readonly httpStatus: number;
     readonly message: string;

package/dist/types/interfaces/stripe-client.interface.d.ts

@@ -1,5 +1,8 @@
 import Stripe from "stripe";
 import { Request } from "@pristine-ts/common";
+/**
+ * This interface represents the Stripe client and can be used to inject it. It facilitates mocking and testing.
+ */
 export interface StripeClientInterface {
     /**
      * Returns the Stripe client of the Stripe library with the api version '2020-08-27'

package/dist/types/managers/stripe-webhooks.manager.d.ts

@@ -2,15 +2,24 @@ import { LogHandlerInterface } from "@pristine-ts/logging";
 import { EventDispatcher } from "@pristine-ts/core";
 import { StripeClient } from "../clients/stripe.client";
 import { Request } from "@pristine-ts/common";
+/**
+ * The StripeWebhooksManager handles webhooks calls from Stripe and transforms those into Pristine Events.
+ */
 export declare class StripeWebhooksManager {
     private readonly eventDispatcher;
     private readonly stripeClient;
     private readonly logHandler;
+    /**
+     * The StripeWebhooksManager handles webhooks calls from Stripe and transforms those into Pristine Events.
+     * @param eventDispatcher The event dispatcher to dispatch Pristine Events once webhook calls from Stripe are parsed.
+     * @param stripeClient The Stripe client.
+     * @param logHandler The log handler to output logs.
+     */
     constructor(eventDispatcher: EventDispatcher, stripeClient: StripeClient, logHandler: LogHandlerInterface);
     /**
      * Verifies the signature and dispatches an event based on the webhook request received from Stripe.
-     * @param request
-     * @param stripeSigningEndpointSecret
+     * @param request The webhook request received from Stripe
+     * @param stripeSigningEndpointSecret The Stripe signing endpoint secret with which the webhook request is signed.
      */
     emitSubscriptionEvent(request: Request, stripeSigningEndpointSecret: string): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pristine-ts/stripe",
-  "version": "0.0.188",
+  "version": "0.0.192",
   "description": "",
   "module": "dist/lib/esm/stripe.module.js",
   "main": "dist/lib/cjs/stripe.module.js",
@@ -8,13 +8,14 @@
   "scripts": {
     "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
     "prepublish": "npm run build",
-    "test": "jest"
+    "test": "jest",
+    "test:cov": "jest --coverage"
   },
   "dependencies": {
-    "@pristine-ts/common": "^0.0.188",
-    "@pristine-ts/core": "^0.0.188",
-    "@pristine-ts/logging": "^0.0.188",
-    "@pristine-ts/networking": "^0.0.188",
+    "@pristine-ts/common": "^0.0.192",
+    "@pristine-ts/core": "^0.0.192",
+    "@pristine-ts/logging": "^0.0.192",
+    "@pristine-ts/networking": "^0.0.192",
     "stripe": "^8.161.0"
   },
   "files": [
@@ -59,5 +60,5 @@
       "src/*.{js,ts}"
     ]
   },
-  "gitHead": "d9eeadc798c023e887715ed55151f3a439eec442"
+  "gitHead": "3f78bc1ae1441441fb9b57fd98b9fd6667a4d28a"
 }