@fgiova/sqs-consumer 2.1.4 → 2.2.1

package/dist/cjs/hooks.d.ts

@@ -1,7 +1,7 @@
 /** biome-ignore-all lint/complexity/noBannedTypes: Function required as generic */
 import type { Message } from "@fgiova/mini-sqs-client";
 import type { Logger } from "./logger";
-export type HookName = "onPoll" | "onMessage" | "onHandlerSuccess" | "onHandlerTimeout" | "onHandlerError" | "onSuccess" | "onError" | "onSQSError";
+export type HookName = "onStart" | "onStop" | "onPoll" | "onMessage" | "onHandlerSuccess" | "onHandlerTimeout" | "onHandlerError" | "onSuccess" | "onError" | "onSQSError";
 export declare class Hooks {
     private readonly hookSymbols;
     private readonly hooks;

package/dist/cjs/hooks.js

@@ -4,6 +4,16 @@ exports.Hooks = void 0;
 class Hooks {
     constructor(logger = console) {
         this.hookSymbols = {
+            onStart: {
+                S: Symbol("start"),
+                throwable: false,
+                type: "void",
+            },
+            onStop: {
+                S: Symbol("stop"),
+                throwable: false,
+                type: "void",
+            },
             onPoll: {
                 S: Symbol("poll"),
                 throwable: true,
@@ -47,6 +57,8 @@ class Hooks {
         };
         this.logger = logger;
         this.hooks = {
+            [this.hookSymbols.onStart.S]: [],
+            [this.hookSymbols.onStop.S]: [],
             [this.hookSymbols.onPoll.S]: [],
             [this.hookSymbols.onMessage.S]: [],
             [this.hookSymbols.onHandlerSuccess.S]: [],

package/dist/cjs/index.d.ts

@@ -38,7 +38,7 @@ export type HooksOptions = {
 };
 export type SQSConsumerOptions = {
     queueARN: string;
-    handler: (message: Message) => Promise<any>;
+    handler: (message: Message) => Promise<unknown>;
     logger?: Logger;
     autostart?: boolean;
     handlerOptions?: HandlerOptions;
@@ -68,6 +68,8 @@ export declare class SQSConsumer {
     start(): Promise<void>;
     stop(destroy?: boolean): Promise<void>;
     get isRunning(): boolean;
+    addHook(hookName: "onStart", value: (sqsConsumer: SQSConsumerOptions) => void): this;
+    addHook(hookName: "onStop", value: (sqsConsumer: SQSConsumerOptions) => void): this;
     addHook(hookName: "onPoll", value: (messages: Message[]) => Promise<Message[]>): this;
     addHook(hookName: "onMessage", value: (message: Message) => Promise<Message>): this;
     addHook(hookName: "onHandlerSuccess", value: (message: Message) => Promise<Message>): this;

package/dist/cjs/index.js

@@ -80,7 +80,7 @@ class SQSConsumer {
         try {
             let handlerResult;
             if (this.handlerOptions.executionTimeout) {
-                const response = await unpromise_1.Unpromise.race([
+                handlerResult = await unpromise_1.Unpromise.race([
                     handler(message),
                     new Promise((_resolve, reject) => {
                         setTimeout(() => {
@@ -88,7 +88,6 @@ class SQSConsumer {
                         }, this.handlerOptions.executionTimeout);
                     }),
                 ]);
-                handlerResult = response;
             }
             else {
                 handlerResult = await handler(message);
@@ -194,25 +193,34 @@ class SQSConsumer {
         this.polling = false;
         await this.pollMessages();
     }
-    // eslint-disable-next-line @typescript-eslint/require-await
     async start() {
-        if (this.running)
-            throw new Error("Consumer is already running");
-        if (this.destroyed)
-            throw new Error("Consumer is destroyed");
-        this.running = true;
-        void this.pollMessages();
+        try {
+            if (this.running)
+                throw new Error("Consumer is already running");
+            if (this.destroyed)
+                throw new Error("Consumer is destroyed");
+            this.running = true;
+            void this.pollMessages();
+        }
+        finally {
+            await this.hooks.runHook("onStart", this);
+        }
     }
     async stop(destroy = false) {
-        if (!this.running)
-            throw new Error("Consumer is not running");
-        this.running = false;
-        while (this.messagesOnFly > 0 || this.polling) {
-            await (0, promises_1.setTimeout)(500);
+        try {
+            if (!this.running)
+                throw new Error("Consumer is not running");
+            this.running = false;
+            while (this.messagesOnFly > 0 || this.polling) {
+                await (0, promises_1.setTimeout)(500);
+            }
+            if (destroy) {
+                await this.sqsClient.destroy(this.clientOptions.destroySigner);
+                this.destroyed = true;
+            }
         }
-        if (destroy) {
-            await this.sqsClient.destroy(this.clientOptions.destroySigner);
-            this.destroyed = true;
+        finally {
+            await this.hooks.runHook("onStop", this);
         }
     }
     /* c8 ignore next 3 */

package/dist/esm/hooks.d.mts

@@ -1,7 +1,7 @@
 /** biome-ignore-all lint/complexity/noBannedTypes: Function required as generic */
 import type { Message } from "@fgiova/mini-sqs-client";
 import type { Logger } from "./logger.mjs";
-export type HookName = "onPoll" | "onMessage" | "onHandlerSuccess" | "onHandlerTimeout" | "onHandlerError" | "onSuccess" | "onError" | "onSQSError";
+export type HookName = "onStart" | "onStop" | "onPoll" | "onMessage" | "onHandlerSuccess" | "onHandlerTimeout" | "onHandlerError" | "onSuccess" | "onError" | "onSQSError";
 export declare class Hooks {
     private readonly hookSymbols;
     private readonly hooks;

package/dist/esm/hooks.mjs

@@ -1,6 +1,16 @@
 export class Hooks {
     constructor(logger = console) {
         this.hookSymbols = {
+            onStart: {
+                S: Symbol("start"),
+                throwable: false,
+                type: "void",
+            },
+            onStop: {
+                S: Symbol("stop"),
+                throwable: false,
+                type: "void",
+            },
             onPoll: {
                 S: Symbol("poll"),
                 throwable: true,
@@ -44,6 +54,8 @@ export class Hooks {
         };
         this.logger = logger;
         this.hooks = {
+            [this.hookSymbols.onStart.S]: [],
+            [this.hookSymbols.onStop.S]: [],
             [this.hookSymbols.onPoll.S]: [],
             [this.hookSymbols.onMessage.S]: [],
             [this.hookSymbols.onHandlerSuccess.S]: [],

package/dist/esm/index.d.mts

@@ -38,7 +38,7 @@ export type HooksOptions = {
 };
 export type SQSConsumerOptions = {
     queueARN: string;
-    handler: (message: Message) => Promise<any>;
+    handler: (message: Message) => Promise<unknown>;
     logger?: Logger;
     autostart?: boolean;
     handlerOptions?: HandlerOptions;
@@ -68,6 +68,8 @@ export declare class SQSConsumer {
     start(): Promise<void>;
     stop(destroy?: boolean): Promise<void>;
     get isRunning(): boolean;
+    addHook(hookName: "onStart", value: (sqsConsumer: SQSConsumerOptions) => void): this;
+    addHook(hookName: "onStop", value: (sqsConsumer: SQSConsumerOptions) => void): this;
     addHook(hookName: "onPoll", value: (messages: Message[]) => Promise<Message[]>): this;
     addHook(hookName: "onMessage", value: (message: Message) => Promise<Message>): this;
     addHook(hookName: "onHandlerSuccess", value: (message: Message) => Promise<Message>): this;

package/dist/esm/index.mjs

@@ -74,7 +74,7 @@ export class SQSConsumer {
         try {
             let handlerResult;
             if (this.handlerOptions.executionTimeout) {
-                const response = await Unpromise.race([
+                handlerResult = await Unpromise.race([
                     handler(message),
                     new Promise((_resolve, reject) => {
                         setTimeout(() => {
@@ -82,7 +82,6 @@ export class SQSConsumer {
                         }, this.handlerOptions.executionTimeout);
                     }),
                 ]);
-                handlerResult = response;
             }
             else {
                 handlerResult = await handler(message);
@@ -188,25 +187,34 @@ export class SQSConsumer {
         this.polling = false;
         await this.pollMessages();
     }
-    // eslint-disable-next-line @typescript-eslint/require-await
     async start() {
-        if (this.running)
-            throw new Error("Consumer is already running");
-        if (this.destroyed)
-            throw new Error("Consumer is destroyed");
-        this.running = true;
-        void this.pollMessages();
+        try {
+            if (this.running)
+                throw new Error("Consumer is already running");
+            if (this.destroyed)
+                throw new Error("Consumer is destroyed");
+            this.running = true;
+            void this.pollMessages();
+        }
+        finally {
+            await this.hooks.runHook("onStart", this);
+        }
     }
     async stop(destroy = false) {
-        if (!this.running)
-            throw new Error("Consumer is not running");
-        this.running = false;
-        while (this.messagesOnFly > 0 || this.polling) {
-            await setTimeoutAsync(500);
+        try {
+            if (!this.running)
+                throw new Error("Consumer is not running");
+            this.running = false;
+            while (this.messagesOnFly > 0 || this.polling) {
+                await setTimeoutAsync(500);
+            }
+            if (destroy) {
+                await this.sqsClient.destroy(this.clientOptions.destroySigner);
+                this.destroyed = true;
+            }
         }
-        if (destroy) {
-            await this.sqsClient.destroy(this.clientOptions.destroySigner);
-            this.destroyed = true;
+        finally {
+            await this.hooks.runHook("onStop", this);
         }
     }
     /* c8 ignore next 3 */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@fgiova/sqs-consumer",
-	"version": "2.1.4",
+	"version": "2.2.1",
 	"main": "./dist/cjs/index.js",
 	"types": "./dist/cjs/index.d.ts",
 	"exports": {
@@ -56,12 +56,12 @@
 		]
 	},
 	"dependencies": {
-		"@fgiova/mini-sqs-client": "^3.2.2",
+		"@fgiova/mini-sqs-client": "^3.4.0",
 		"@watchable/unpromise": "^1.0.2",
 		"p-map": "^7.0.3"
 	},
 	"peerDependencies": {
-		"@fgiova/aws-signature": "^3.1.2"
+		"@fgiova/aws-signature": "^3.2.0"
 	},
 	"devDependencies": {
 		"@aws-sdk/client-sqs": "^3.758.0",