sqs-consumer 6.0.1 → 6.1.0

package/.github/CONTRIBUTING.md

@@ -34,6 +34,16 @@ Follow the setup instructions in the [README](../README.md).
 
 Ensure all your code is thoroughly tested and that this testing is detailed in the pull request.
 
+## Contributors Licence Agreement
+
+In order to accept contributions, we need all contributors grant Us a licence to the intellectual
+property rights in their Contributions. This Agreement (“Agreement”) is intended to protect your
+rights as a contributor, and to help ensure that the intellectual property contained
+within is available to the whole community, to use and build on.
+
+When you raise a pull request and you haven't previously signed a CLA, the bot will automatically
+ask you to do this. You must complete this step in order for your PR to be merged.
+
 ## Pull Request Process
 
 1. Make sure you have opened an issue and it was approved by a project maintainer before working on a PR

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,115 @@
+name: 'Bug report'
+title: "[Bug]: "
+labels: ["bug", "triage"]
+description: Report a reproducible bug or regression
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue!
+
+        This issue tracker is for reporting reproducible bugs or regression's found in this package, if you have a question or feature request, please report it within the [Discussions tab](https://github.com/bbc/sqs-consumer/discussions) instead.
+
+        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
+
+         - [Discussions](https://github.com/bbc/sqs-consumer/discussions)
+         - [Open Issues](https://github.com/bbc/sqs-consumer/issues?q=is%3Aopen+is%3Aissue)
+         - [Closed Issues](https://github.com/bbc/sqs-consumer/issues?q=is%3Aissue+is%3Aclosed)
+
+        The more information you fill in, the better the community can help you.
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: input
+    id: link
+    attributes:
+      label: Your minimal, reproducible example
+      description: |
+        Please add a link to a minimal reproduction.
+        Note:
+        - Please keep your example as simple and reproduceable as possible, try leaving out dependencies that are not required for reproduction.
+        - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
+        - Please make sure the example is complete and runnable - e.g. avoid localhost URLs.
+      placeholder: |
+        e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: Describe the steps we have to take to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: Provide a clear and concise description of what you expected to happen.
+      placeholder: |
+        As a user, I expected ___ behavior but i am seeing ___
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: How often does this bug happen?
+      description: |
+        Following the repro steps above, how easily are you able to reproduce this bug?
+      options:
+        - Every time
+        - Often
+        - Sometimes
+        - Only once
+  - type: textarea
+    id: screenshots_or_videos
+    attributes:
+      label: Screenshots or Videos
+      description: |
+        If applicable, add screenshots or a video to help explain your problem.
+        For more information on the supported file image/file types and the file size limits, please refer
+        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
+      placeholder: |
+        You can drag your video or image files inside of this editor ↓
+  - type: textarea
+    id: platform
+    attributes:
+      label: Platform
+      description: |
+        Please let us know which Operating System and Node version you were using when the issue occurred.
+      placeholder: |
+        - OS: [e.g. macOS, Windows, Linux, iOS, Android]
+        - Node Version: [e.g. 16.6.0]
+    validations:
+      required: true
+  - type: input
+    id: package-version
+    attributes:
+      label: Package version
+      description: |
+        Please let us know the exact version of the package you were using when the issue occurred. Please don't just put in "latest", as this is subject to change.
+      placeholder: |
+        e.g. v6.0.0
+    validations:
+      required: true
+  - type: input
+    id: ts-version
+    attributes:
+      label: AWS SDK version
+      description: |
+        Please include what version of the AWS SDK you are using
+      placeholder: |
+        e.g. v3.226.0
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Feature Requests & Questions
+    url: https://github.com/bbc/sqs-consumer/discussions
+    about: Please ask and answer questions here.

package/.github/workflows/cla.yml

@@ -0,0 +1,25 @@
+name: "CLA Check"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Check"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@v2.2.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        with:
+          path-to-signatures: 'sqs-consumer/v1/cla.json'
+          remote-organization-name: 'bbc'
+          remote-repository-name: 'cla-signatures'
+          path-to-document: 'https://bbc.github.io/cla-signatures/cla/v1/cla.html'
+          branch: 'main'
+          allowlist: bot*
+          custom-allsigned-prcomment: '**CLA CHECK** All Contributors have signed the CLA'

package/.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '43 21 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

package/README.md

@@ -48,6 +48,8 @@ app.start();
 - Throwing an error (or returning a rejected promise) from the handler function will cause the message to be left on the queue. An [SQS redrive policy](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html) can be used to move messages that cannot be processed to a dead letter queue.
 - By default messages are processed one at a time – a new message won't be received until the first one has been processed. To process messages in parallel, use the `batchSize` option [detailed below](#options).
 
+You can also find some examples of sqs-consumer implemented in various ways within the [examples directory](./examples/).
+
 ### Credentials
 
 By default the consumer will look for AWS credentials in the places [specified by the AWS SDK](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials). The simplest option is to export your credentials as environment variables:
@@ -92,6 +94,10 @@ app.on('timeout_error', (err) => {
 app.start();
 ```
 
+### AWS IAM Permissions
+
+Consumer will receive and delete messages from the SQS queue. Ensure `sqs:ReceiveMessage`, `sqs:DeleteMessage`, `sqs:DeleteMessageBatch`, `sqs:ChangeMessageVisibility` and `sqs:ChangeMessageVisibilityBatch` access is granted on the queue being consumed.
+
 ## API
 
 ### `Consumer.create(options)`
@@ -100,22 +106,24 @@ Creates a new SQS consumer.
 
 #### Options
 
-- `queueUrl` - _String_ - The SQS queue URL
-- `region` - _String_ - The AWS region (default `eu-west-1`)
-- `handleMessage` - _Function_ - An `async` function (or function that returns a `Promise`) to be called whenever a message is received. Receives an SQS message object as it's first argument.
-- `handleMessageBatch` - _Function_ - An `async` function (or function that returns a `Promise`) to be called whenever a batch of messages is received. Similar to `handleMessage` but will receive the list of messages, not each message individually. **If both are set, `handleMessageBatch` overrides `handleMessage`**.
-- `handleMessageTimeout` - _Number_ - Time in ms to wait for `handleMessage` to process a message before timing out. Emits `timeout_error` on timeout. By default, if `handleMessage` times out, the unprocessed message returns to the end of the queue.
-- `attributeNames` - _Array_ - List of queue attributes to retrieve (i.e. `['All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount']`).
-- `messageAttributeNames` - _Array_ - List of message attributes to retrieve (i.e. `['name', 'address']`).
-- `batchSize` - _Number_ - The number of messages to request from SQS when polling (default `1`). This cannot be higher than the AWS limit of 10.
-- `visibilityTimeout` - _Number_ - The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
-- `heartbeatInterval` - _Number_ - The interval (in seconds) between requests to extend the message visibility timeout. On each heartbeat the visibility is extended by adding `visibilityTimeout` to the number of seconds since the start of the handler function. This value must less than `visibilityTimeout`.
-- `terminateVisibilityTimeout` - _Boolean_ - If true, sets the message visibility timeout to 0 after a `processing_error` (defaults to `false`).
-- `waitTimeSeconds` - _Number_ - The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning (defaults to `20`).
-- `authenticationErrorTimeout` - _Number_ - The duration (in milliseconds) to wait before retrying after an authentication error (defaults to `10000`).
-- `pollingWaitTimeMs` - _Number_ - The duration (in milliseconds) to wait before repolling the queue (defaults to `0`).
-- `sqs` - _Object_ - An optional [SQS Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/classes/sqsclient.html) object to use if you need to configure the client manually
-- `shouldDeleteMessages` - _Boolean_ - Default to `true`, if you don't want the package to delete messages from sqs set this to `false`
+| Option                       | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                            |
+| ---------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `queueUrl`                   | String    | The SQS queue URL                                                                                                                                                                                                                                                                                                                                                                                      |
+| `region`                     | String    | The AWS region (default `eu-west-1`)                                                                                                                                                                                                                                                                                                                                                                   |
+| `handleMessage`              | Function  | An `async` function (or function that returns a `Promise`) to be called whenever a message is received. Receives an SQS message object as its first argument.                                                                                                                                                                                                                                          |
+| `handleMessageBatch`         | Function  | An `async` function (or function that returns a `Promise`) to be called whenever a batch of messages is received. Similar to `handleMessage` but will receive the list of messages, not each message individually. **If both are set, `handleMessageBatch` overrides `handleMessage`**. In the case that you need to ack only some of the messages, return an array with the successful messages only. |
+| `handleMessageTimeout`       | Number    | Time in ms to wait for `handleMessage` to process a message before timing out. Emits `timeout_error` on timeout. By default, if `handleMessage` times out, the unprocessed message returns to the end of the queue.                                                                                                                                                                                    |
+| `attributeNames`             | Array     | List of queue attributes to retrieve (i.e. `['All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount']`).                                                                                                                                                                                                                                                                                  |
+| `messageAttributeNames`      | Array     | List of message attributes to retrieve (i.e. `['name', 'address']`).                                                                                                                                                                                                                                                                                                                                   |
+| `batchSize`                  | Number    | The number of messages to request from SQS when polling (default `1`). This cannot be higher than the [AWS limit of 10](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html).                                                                                                                                                                              |
+| `visibilityTimeout`          | Number    | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.                                                                                                                                                                                                                                                   |
+| `heartbeatInterval`          | Number    | The interval (in seconds) between requests to extend the message visibility timeout. On each heartbeat the visibility is extended by adding `visibilityTimeout` to the number of seconds since the start of the handler function. This value must less than `visibilityTimeout`.                                                                                                                       |
+| `terminateVisibilityTimeout` | Boolean   | If true, sets the message visibility timeout to 0 after a `processing_error` (defaults to `false`).                                                                                                                                                                                                                                                                                                    |
+| `waitTimeSeconds`            | Number    | The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning (defaults to `20`).                                                                                                                                                                                                                                                                       |
+| `authenticationErrorTimeout` | Number    | The duration (in milliseconds) to wait before retrying after an authentication error (defaults to `10000`).                                                                                                                                                                                                                                                                                            |
+| `pollingWaitTimeMs`          | Number    | The duration (in milliseconds) to wait before repolling the queue (defaults to `0`).                                                                                                                                                                                                                                                                                                                   |
+| `sqs`                        | SQSClient | An optional [SQS Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/classes/sqsclient.html) object to use if you need to configure the client manually                                                                                                                                                                                                                  |
+| `shouldDeleteMessages`       | Boolean   | Default to `true`, if you don't want the package to delete messages from sqs set this to `false`                                                                                                                                                                                                                                                                                                       |
 
 ### `consumer.start()`
 
@@ -144,10 +152,6 @@ Each consumer is an [`EventEmitter`](http://nodejs.org/api/events.html) and emit
 | `stopped`            | None               | Fired when the consumer finally stops its work.                                                                                 |
 | `empty`              | None               | Fired when the queue is empty (All messages have been consumed).                                                                |
 
-### AWS IAM Permissions
-
-Consumer will receive and delete messages from the SQS queue. Ensure `sqs:ReceiveMessage`, `sqs:DeleteMessage`, `sqs:DeleteMessageBatch`, `sqs:ChangeMessageVisibility` and `sqs:ChangeMessageVisibilityBatch` access is granted on the queue being consumed.
-
 ### Contributing
 
 See contributing [guidelines](https://github.com/bbc/sqs-consumer/blob/main/.github/CONTRIBUTING.md).

package/dist/consumer.d.ts

@@ -1,35 +1,6 @@
 /// <reference types="node" />
-import { SQSClient, Message } from '@aws-sdk/client-sqs';
 import { EventEmitter } from 'events';
-export interface ConsumerOptions {
-    queueUrl?: string;
-    attributeNames?: string[];
-    messageAttributeNames?: string[];
-    stopped?: boolean;
-    batchSize?: number;
-    visibilityTimeout?: number;
-    waitTimeSeconds?: number;
-    authenticationErrorTimeout?: number;
-    pollingWaitTimeMs?: number;
-    terminateVisibilityTimeout?: boolean;
-    heartbeatInterval?: number;
-    sqs?: SQSClient;
-    region?: string;
-    handleMessageTimeout?: number;
-    shouldDeleteMessages?: boolean;
-    handleMessage?(message: Message): Promise<void>;
-    handleMessageBatch?(messages: Message[]): Promise<void>;
-}
-interface Events {
-    response_processed: [];
-    empty: [];
-    message_received: [Message];
-    message_processed: [Message];
-    error: [Error, void | Message | Message[]];
-    timeout_error: [Error, Message];
-    processing_error: [Error, Message];
-    stopped: [];
-}
+import { ConsumerOptions, Events } from './types';
 export declare class Consumer extends EventEmitter {
     private queueUrl;
     private handleMessage;
@@ -69,4 +40,3 @@ export declare class Consumer extends EventEmitter {
     private changeVisibilityTimeoutBatch;
     private startHeartbeat;
 }
-export {};

package/dist/consumer.js

@@ -40,7 +40,8 @@ function isConnectionError(err) {
     if (err instanceof errors_1.SQSError) {
         return (err.statusCode === 403 ||
             err.code === 'CredentialsError' ||
-            err.code === 'UnknownEndpoint');
+            err.code === 'UnknownEndpoint' ||
+            err.code === 'AWS.SimpleQueueService.NonExistentQueue');
     }
     return false;
 }
@@ -272,9 +273,11 @@ class Consumer extends events_1.EventEmitter {
                     return this.changeVisibilityTimeoutBatch(messages, this.visibilityTimeout);
                 });
             }
-            await this.executeBatchHandler(messages);
-            await this.deleteMessageBatch(messages);
-            messages.forEach((message) => {
+            const ackedMessages = await this.executeBatchHandler(messages);
+            if (ackedMessages.length > 0) {
+                await this.deleteMessageBatch(ackedMessages);
+            }
+            ackedMessages.forEach((message) => {
                 this.emit('message_processed', message);
             });
         }
@@ -310,7 +313,11 @@ class Consumer extends events_1.EventEmitter {
     }
     async executeBatchHandler(messages) {
         try {
-            await this.handleMessageBatch(messages);
+            const result = await this.handleMessageBatch(messages);
+            if (result instanceof Object) {
+                return result;
+            }
+            return messages;
         }
         catch (err) {
             err.message = `Unexpected message handler failure: ${err.message}`;

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { Consumer, ConsumerOptions } from './consumer';
+export { Consumer } from './consumer';
+export * from './types';

package/dist/index.js

@@ -1,5 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Consumer = void 0;
 var consumer_1 = require("./consumer");
 Object.defineProperty(exports, "Consumer", { enumerable: true, get: function () { return consumer_1.Consumer; } });
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -1,3 +1,33 @@
+import { SQSClient, Message } from '@aws-sdk/client-sqs';
+export interface ConsumerOptions {
+    queueUrl: string;
+    attributeNames?: string[];
+    messageAttributeNames?: string[];
+    stopped?: boolean;
+    batchSize?: number;
+    visibilityTimeout?: number;
+    waitTimeSeconds?: number;
+    authenticationErrorTimeout?: number;
+    pollingWaitTimeMs?: number;
+    terminateVisibilityTimeout?: boolean;
+    heartbeatInterval?: number;
+    sqs?: SQSClient;
+    region?: string;
+    handleMessageTimeout?: number;
+    shouldDeleteMessages?: boolean;
+    handleMessage?(message: Message): Promise<void>;
+    handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
+}
+export interface Events {
+    response_processed: [];
+    empty: [];
+    message_received: [Message];
+    message_processed: [Message];
+    error: [Error, void | Message | Message[]];
+    timeout_error: [Error, Message];
+    processing_error: [Error, Message];
+    stopped: [];
+}
 export type AWSError = {
     /**
      * Name, eg. ConditionalCheckFailedException

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,7 +8,7 @@
     "build": "npm run clean && tsc",
     "watch": "tsc --watch",
     "clean": "rm -fr dist/*",
-    "prepublish": "npm run build",
+    "prepublishOnly": "npm run build",
     "pretest": "npm run build",
     "test": "mocha --recursive --full-trace --exit",
     "coverage": "nyc mocha && nyc report --reporter=html && nyc report --reporter=json-summary",

package/src/consumer.ts

@@ -18,7 +18,7 @@ import {
 import Debug from 'debug';
 import { EventEmitter } from 'events';
 
-import { AWSError } from './types';
+import { AWSError, ConsumerOptions, Events } from './types';
 import { autoBind } from './bind';
 import { SQSError, TimeoutError } from './errors';
 
@@ -72,7 +72,8 @@ function isConnectionError(err: Error): boolean {
     return (
       err.statusCode === 403 ||
       err.code === 'CredentialsError' ||
-      err.code === 'UnknownEndpoint'
+      err.code === 'UnknownEndpoint' ||
+      err.code === 'AWS.SimpleQueueService.NonExistentQueue'
     );
   }
   return false;
@@ -94,41 +95,10 @@ function hasMessages(response: ReceiveMessageCommandOutput): boolean {
   return response.Messages && response.Messages.length > 0;
 }
 
-export interface ConsumerOptions {
-  queueUrl?: string;
-  attributeNames?: string[];
-  messageAttributeNames?: string[];
-  stopped?: boolean;
-  batchSize?: number;
-  visibilityTimeout?: number;
-  waitTimeSeconds?: number;
-  authenticationErrorTimeout?: number;
-  pollingWaitTimeMs?: number;
-  terminateVisibilityTimeout?: boolean;
-  heartbeatInterval?: number;
-  sqs?: SQSClient;
-  region?: string;
-  handleMessageTimeout?: number;
-  shouldDeleteMessages?: boolean;
-  handleMessage?(message: Message): Promise<void>;
-  handleMessageBatch?(messages: Message[]): Promise<void>;
-}
-
-interface Events {
-  response_processed: [];
-  empty: [];
-  message_received: [Message];
-  message_processed: [Message];
-  error: [Error, void | Message | Message[]];
-  timeout_error: [Error, Message];
-  processing_error: [Error, Message];
-  stopped: [];
-}
-
 export class Consumer extends EventEmitter {
   private queueUrl: string;
   private handleMessage: (message: Message) => Promise<void>;
-  private handleMessageBatch: (message: Message[]) => Promise<void>;
+  private handleMessageBatch: (message: Message[]) => Promise<Message[] | void>;
   private handleMessageTimeout: number;
   private attributeNames: string[];
   private messageAttributeNames: string[];
@@ -390,9 +360,13 @@ export class Consumer extends EventEmitter {
           );
         });
       }
-      await this.executeBatchHandler(messages);
-      await this.deleteMessageBatch(messages);
-      messages.forEach((message) => {
+      const ackedMessages = await this.executeBatchHandler(messages);
+
+      if (ackedMessages.length > 0) {
+        await this.deleteMessageBatch(ackedMessages);
+      }
+
+      ackedMessages.forEach((message) => {
         this.emit('message_processed', message);
       });
     } catch (err) {
@@ -433,9 +407,15 @@ export class Consumer extends EventEmitter {
     }
   }
 
-  private async executeBatchHandler(messages: Message[]): Promise<void> {
+  private async executeBatchHandler(messages: Message[]): Promise<Message[]> {
     try {
-      await this.handleMessageBatch(messages);
+      const result = await this.handleMessageBatch(messages);
+
+      if (result instanceof Object) {
+        return result;
+      }
+
+      return messages;
     } catch (err) {
       err.message = `Unexpected message handler failure: ${err.message}`;
       throw err;

package/src/index.ts

@@ -1 +1,2 @@
-export { Consumer, ConsumerOptions } from './consumer';
+export { Consumer } from './consumer';
+export * from './types';

package/src/types.ts

@@ -1,3 +1,36 @@
+import { SQSClient, Message } from '@aws-sdk/client-sqs';
+
+export interface ConsumerOptions {
+  queueUrl: string;
+  attributeNames?: string[];
+  messageAttributeNames?: string[];
+  stopped?: boolean;
+  batchSize?: number;
+  visibilityTimeout?: number;
+  waitTimeSeconds?: number;
+  authenticationErrorTimeout?: number;
+  pollingWaitTimeMs?: number;
+  terminateVisibilityTimeout?: boolean;
+  heartbeatInterval?: number;
+  sqs?: SQSClient;
+  region?: string;
+  handleMessageTimeout?: number;
+  shouldDeleteMessages?: boolean;
+  handleMessage?(message: Message): Promise<void>;
+  handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
+}
+
+export interface Events {
+  response_processed: [];
+  empty: [];
+  message_received: [Message];
+  message_processed: [Message];
+  error: [Error, void | Message | Message[]];
+  timeout_error: [Error, Message];
+  processing_error: [Error, Message];
+  stopped: [];
+}
+
 export type AWSError = {
   /**
    * Name, eg. ConditionalCheckFailedException

package/.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,27 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behaviour:
-
-1. Go to '...'
-2. Select '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behaviour**
-A clear and concise description of what you expected to happen.
-
-**screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here, such as specific device information.