@mjtickets981/common 1.0.13 → 1.0.15

package/build/events/payment-created-event.d.ts

@@ -0,0 +1,9 @@
+import { Subjects } from "./subjects";
+export interface PaymentCreatedEvent {
+    subject: Subjects.PaymentCreated;
+    data: {
+        id: string;
+        orderId: string;
+        stripeId: string;
+    };
+}

package/build/events/payment-created-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/subjects.d.ts

@@ -3,5 +3,6 @@ export declare enum Subjects {
     TicketUpdated = "ticket:updated",
     OrderCreated = "order:created",
     OrderCancelled = "order:cancelled",
-    ExpirationComplete = "expiration:complete"
+    ExpirationComplete = "expiration:complete",
+    PaymentCreated = "payment:created"
 }

package/build/events/subjects.js

@@ -4,6 +4,16 @@
 // Here we define all the subjects that our application will use.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Subjects = void 0;
+// What is the use of enum in TypeScript?
+// An enum (short for "enumeration") is a special data type in TypeScript that allows you to define a set of named constants.
+// Enums are useful for representing a fixed number of related values, such as days of the week, directions, or in our case, event subjects.
+//  They provide a way to give more meaningful names to these values, making the code easier to read and maintain.
+// But why can't we write just export Subjects = { TicketCreated: "ticket:created", TicketUpdated: "ticket:updated", ... } instead of using enum?
+// We could technically use a plain object to define our subjects, but using an enum provides several benefits:
+// 1. Type Safety: Enums provide type safety, ensuring that only valid values can be assigned to variables of the enum type. With a plain object, you could accidentally assign an invalid string value.
+// 2. Auto-completion: When using enums in an IDE, you get auto-completion for the enum values, which can help prevent typos and improve developer productivity.
+// 3. Readability: Enums can make the code more readable by providing a clear and concise way to define a set of related constants. It also makes it clear that these values are meant to be used as a group of related options.
+// 4. Reverse Mapping: Enums in TypeScript support reverse mapping, allowing you to get the name of an enum member from its value. This can be useful for debugging or logging purposes.
 var Subjects;
 (function (Subjects) {
     Subjects["TicketCreated"] = "ticket:created";
@@ -11,5 +21,6 @@ var Subjects;
     Subjects["OrderCreated"] = "order:created";
     Subjects["OrderCancelled"] = "order:cancelled";
     Subjects["ExpirationComplete"] = "expiration:complete";
+    Subjects["PaymentCreated"] = "payment:created";
 })(Subjects || (exports.Subjects = Subjects = {}));
 const printSubject = (subject) => { };

package/build/index.d.ts

@@ -17,3 +17,4 @@ export * from "./events/types/order-status";
 export * from "./events/order-created-event";
 export * from "./events/order-cancelled-event";
 export * from "./events/expiration-complete-event";
+export * from "./events/payment-created-event";

package/build/index.js

@@ -33,3 +33,4 @@ __exportStar(require("./events/types/order-status"), exports);
 __exportStar(require("./events/order-created-event"), exports);
 __exportStar(require("./events/order-cancelled-event"), exports);
 __exportStar(require("./events/expiration-complete-event"), exports);
+__exportStar(require("./events/payment-created-event"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mjtickets981/common",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",