@mjtickets981/common 1.0.4 → 1.0.8

package/build/events/base-listener.d.ts

@@ -0,0 +1,18 @@
+import { Message, Stan } from "node-nats-streaming";
+import { Subjects } from "./subjects";
+interface Event {
+    subject: Subjects;
+    data: any;
+}
+export declare abstract class Listener<T extends Event> {
+    abstract subject: T["subject"];
+    abstract queueGroupName: string;
+    abstract onMessage(data: T["data"], msg: Message): void;
+    private client;
+    protected ackWait: number;
+    constructor(client: Stan);
+    subscriptionOptions(): import("node-nats-streaming").SubscriptionOptions;
+    listen(): void;
+    parseMessage(msg: Message): any;
+}
+export {};

package/build/events/base-listener.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Listener = void 0;
+class Listener {
+    constructor(client) {
+        this.ackWait = 5 * 1000; // Default ack wait time of 5 seconds
+        this.client = client;
+    }
+    subscriptionOptions() {
+        return this.client
+            .subscriptionOptions()
+            .setDeliverAllAvailable()
+            .setManualAckMode(true)
+            .setAckWait(this.ackWait)
+            .setDurableName(this.queueGroupName);
+    } // Enable manual acknowledgment mode
+    // Then the none-nats streaming library is no longer going to automatically acknowledge (or) tell the NATS Streaming Server that we have successfully
+    // processed the message as soon as we receive it. Instead, we are going to have to manually acknowledge it by calling a function on the message object itself.
+    // In other words we can say that the NATS streaming library is no longer going to automatically acknowledge (or) tell the
+    // NATS streaming library that we have received the event but instead it will be upto you and I to run some processing on
+    // this event, possibly save some information to the database and then after that entire process is complete then only we can
+    // acknowledge the message and say okay everything has been processed successfully. If we donot acknowledge the incoming event,
+    // then the NATS streaming server is going to wait some amount of time which is 30 seconds by default and then after 30 seconds
+    // of not getting the acknowledgement then it is automatically decide to take this event and send it to some other member of
+    // the same queue group. This is really useful because if our service crashes (or) goes down right after receiving an event
+    // but before processing it and acknowledging it, then the NATS streaming server is going to automatically resend this event
+    // to some other instance of our service which is listening on the same queue group. This way we can be sure that no events
+    // are lost even if our service goes down at any point of time.
+    listen() {
+        const subscription = this.client.subscribe(this.subject, this.queueGroupName, this.subscriptionOptions());
+        subscription.on("message", (msg) => {
+            console.log(`Message received: ${this.subject} /  ${this.queueGroupName}`);
+            const parsedData = this.parseMessage(msg);
+            this.onMessage(parsedData, msg);
+        });
+    }
+    parseMessage(msg) {
+        const data = msg.getData();
+        return typeof data === "string"
+            ? JSON.parse(data)
+            : JSON.parse(data.toString("utf8")); // If it is a buffer then will convert it to utf8 string and then parse it to json
+    }
+}
+exports.Listener = Listener;

package/build/events/base-publisher.d.ts

@@ -0,0 +1,13 @@
+import { Stan } from "node-nats-streaming";
+import { Subjects } from "./subjects";
+interface Event {
+    subject: Subjects;
+    data: any;
+}
+export declare abstract class Publisher<T extends Event> {
+    abstract subject: T["subject"];
+    private client;
+    constructor(client: Stan);
+    publish(data: T["data"]): Promise<void>;
+}
+export {};

package/build/events/base-publisher.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Publisher = void 0;
+class Publisher {
+    constructor(client) {
+        this.client = client;
+    }
+    publish(data) {
+        return new Promise((resolve, reject) => {
+            this.client.publish(this.subject, JSON.stringify(data), (err) => {
+                if (err) {
+                    return reject(err); // reject the promise if there is an error
+                }
+                console.log("Event published to subject", this.subject);
+                resolve(); // resolve the promise if the publish is successful
+            });
+        });
+    }
+}
+exports.Publisher = Publisher;

package/build/events/subjects.d.ts

@@ -0,0 +1,4 @@
+export declare enum Subjects {
+    TicketCreated = "ticket:created",
+    TicketUpdated = "ticket:updated"
+}

package/build/events/subjects.js

@@ -0,0 +1,12 @@
+"use strict";
+// Subject in the world of NATS-streaming server is nothing but a channel name
+// where messages are published to and subscribers listen to.
+// Here we define all the subjects that our application will use.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subjects = void 0;
+var Subjects;
+(function (Subjects) {
+    Subjects["TicketCreated"] = "ticket:created";
+    Subjects["TicketUpdated"] = "ticket:updated";
+})(Subjects || (exports.Subjects = Subjects = {}));
+const printSubject = (subject) => { };

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

@@ -0,0 +1,10 @@
+import { Subjects } from "./subjects";
+export interface TicketCreatedEvent {
+    subject: Subjects.TicketCreated;
+    data: {
+        id: string;
+        title: string;
+        price: number;
+        userId: string;
+    };
+}

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

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

package/build/events/ticket-updated-event.d.ts

@@ -0,0 +1,10 @@
+import { Subjects } from "./subjects";
+export interface TicketUpdatedEvent {
+    subject: Subjects.TicketUpdated;
+    data: {
+        id: string;
+        title: string;
+        price: number;
+        userId: string;
+    };
+}

package/build/events/ticket-updated-event.js

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

package/build/events/types/order-status.d.ts

@@ -0,0 +1,6 @@
+export declare enum OrderStatus {
+    Created = "created",// When an order is created but not yet reserved. The ticket is still available for purchase.
+    Cancelled = "cancelled",// When an order is cancelled. The ticket becomes available for purchase again.
+    AwaitingPayment = "awaiting:payment",// When an order has been reserved and is waiting for payment. The ticket is no longer available for purchase.
+    Complete = "complete"
+}

package/build/events/types/order-status.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderStatus = void 0;
+var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["Created"] = "created";
+    OrderStatus["Cancelled"] = "cancelled";
+    OrderStatus["AwaitingPayment"] = "awaiting:payment";
+    OrderStatus["Complete"] = "complete";
+})(OrderStatus || (exports.OrderStatus = OrderStatus = {}));

package/build/index.d.ts

@@ -8,3 +8,9 @@ export * from "./middlewares/error-handler";
 export * from "./middlewares/current-user";
 export * from "./middlewares/require-auth";
 export * from "./middlewares/validate-request";
+export * from "./events/base-listener";
+export * from "./events/base-publisher";
+export * from "./events/subjects";
+export * from "./events/ticket-created-event";
+export * from "./events/ticket-updated-event";
+export * from "./events/types/order-status";

package/build/index.js

@@ -24,3 +24,9 @@ __exportStar(require("./middlewares/error-handler"), exports);
 __exportStar(require("./middlewares/current-user"), exports);
 __exportStar(require("./middlewares/require-auth"), exports);
 __exportStar(require("./middlewares/validate-request"), exports);
+__exportStar(require("./events/base-listener"), exports);
+__exportStar(require("./events/base-publisher"), exports);
+__exportStar(require("./events/subjects"), exports);
+__exportStar(require("./events/ticket-created-event"), exports);
+__exportStar(require("./events/ticket-updated-event"), exports);
+__exportStar(require("./events/types/order-status"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mjtickets981/common",
-  "version": "1.0.4",
+  "version": "1.0.8",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -26,6 +26,7 @@
     "cookie-session": "^2.1.1",
     "express": "^5.1.0",
     "express-validator": "^7.2.1",
-    "jsonwebtoken": "^9.0.2"
+    "jsonwebtoken": "^9.0.2",
+    "node-nats-streaming": "^0.3.2"
   }
 }